Class InternalSlackChannelAdminService

The channel each internal Slack feed posts to, and the DEFAULT channel the rest fall back to. Every caller is CFX's own: the posting apps read through getForFeed, the admin dashboard edits the rows.

Hierarchy

InternalSlackChannelCache
- InternalSlackChannelAdminService

Index

Constructors

constructor

new InternalSlackChannelAdminService(
    __namedParameters: {
        db: B2bDatabase;
        internalEventPublisher: InternalEventPublisher | null;
        valkeyClient: ValkeyClient | null;
    },
): InternalSlackChannelAdminService
Parameters
- __namedParameters: {
      db: B2bDatabase;
      internalEventPublisher: InternalEventPublisher | null;
      valkeyClient: ValkeyClient | null;
  }
  - db: B2bDatabase
  - internalEventPublisher: InternalEventPublisher | null
    
    Publishes slack.internalSlackChannel.*; null where nothing writes.
  - valkeyClient: ValkeyClient | null
Returns InternalSlackChannelAdminService
Overrides InternalSlackChannelCache.constructor
- Defined in slack-services/src/InternalSlackChannelAdminService.ts:113

Properties

`Protected` `Readonly`cache

cache: ServiceCache<CachedSearchPage<InternalSlackChannel>>

`Static`instance

instance: (...args: []) => InternalSlackChannelAdminService = ...

The process service: the shared database, Valkey and the internal bus.

Methods

create

create(
    input: {
        channelId: string;
        feed:
            | "DEFAULT"
            | "ACH_BATCH"
            | "ACH_FILE"
            | "WIRE_BATCH"
            | "WIRE_FILE"
            | "BANK_TRANSACTION"
            | "BANK_INTERNAL_TRANSFER"
            | "WIRE_EMAIL"
            | "REDEMPTION"
            | "LEDGER_ACCOUNT_WITHDRAWAL"
            | "MANUAL_MINT"
            | "FEE_TRANSFER"
            | "AIPRISE_PROFILE"
            | "UTILA_TRANSACTION"
            | "EMAIL_SENT"
            | "CUSTOMER_EVENTS"
            | "CUSTOMER_DEPOSIT"
            | "CUSTOMER_WITHDRAWAL"
            | "CUSTOMER_LEDGER_TRANSFER"
            | "CUSTOMER_SWAP"
            | "CUSTOMER_ESCROW_TRANSFER"
            | "CUSTOMER_CARD_TRANSACTION"
            | "CUSTOMER_IDENTITY"
            | "CUSTOMER_ORGANIZATION"
            | "CUSTOMER_PAYMENT_INSTRUMENT"
            | "CUSTOMER_REWARD"
            | "CUSTOMER_TERMS"
            | "CUSTOMER_VIRTUAL_ACCOUNT"
            | "TEMPLATE_TEST";
    },
): Promise<
    | { ok: true; value: InternalSlackChannel }
    | { error: ServiceError; ok: false },
>
Gives feed its own channel. One live row per feed: replace one with update.
Parameters
- input: {
      channelId: string;
      feed:
          | "DEFAULT"
          | "ACH_BATCH"
          | "ACH_FILE"
          | "WIRE_BATCH"
          | "WIRE_FILE"
          | "BANK_TRANSACTION"
          | "BANK_INTERNAL_TRANSFER"
          | "WIRE_EMAIL"
          | "REDEMPTION"
          | "LEDGER_ACCOUNT_WITHDRAWAL"
          | "MANUAL_MINT"
          | "FEE_TRANSFER"
          | "AIPRISE_PROFILE"
          | "UTILA_TRANSACTION"
          | "EMAIL_SENT"
          | "CUSTOMER_EVENTS"
          | "CUSTOMER_DEPOSIT"
          | "CUSTOMER_WITHDRAWAL"
          | "CUSTOMER_LEDGER_TRANSFER"
          | "CUSTOMER_SWAP"
          | "CUSTOMER_ESCROW_TRANSFER"
          | "CUSTOMER_CARD_TRANSACTION"
          | "CUSTOMER_IDENTITY"
          | "CUSTOMER_ORGANIZATION"
          | "CUSTOMER_PAYMENT_INSTRUMENT"
          | "CUSTOMER_REWARD"
          | "CUSTOMER_TERMS"
          | "CUSTOMER_VIRTUAL_ACCOUNT"
          | "TEMPLATE_TEST";
  }
Returns Promise<
| { ok: true; value: InternalSlackChannel }
| { error: ServiceError; ok: false },
>
- Defined in slack-services/src/InternalSlackChannelAdminService.ts:223

delete

delete(
    __namedParameters: { id: string },
): Promise<
    { ok: true; value: undefined }
    | { error: ServiceError; ok: false },
>
Soft-deletes a feed's row, so the feed falls back to the DEFAULT channel. The DEFAULT row cannot be deleted: every feed without a row resolves to it.
Parameters
- __namedParameters: { id: string }
Returns Promise<{ ok: true; value: undefined } | { error: ServiceError; ok: false }>
- Defined in slack-services/src/InternalSlackChannelAdminService.ts:324

get

get(__namedParameters: { id: string }): Promise<InternalSlackChannel | null>
Parameters
- __namedParameters: { id: string }
Returns Promise<InternalSlackChannel | null>
- Defined in slack-services/src/InternalSlackChannelAdminService.ts:145

getForFeed

getForFeed(
    __namedParameters: {
        feed:
            | "DEFAULT"
            | "ACH_BATCH"
            | "ACH_FILE"
            | "WIRE_BATCH"
            | "WIRE_FILE"
            | "BANK_TRANSACTION"
            | "BANK_INTERNAL_TRANSFER"
            | "WIRE_EMAIL"
            | "REDEMPTION"
            | "LEDGER_ACCOUNT_WITHDRAWAL"
            | "MANUAL_MINT"
            | "FEE_TRANSFER"
            | "AIPRISE_PROFILE"
            | "UTILA_TRANSACTION"
            | "EMAIL_SENT"
            | "CUSTOMER_EVENTS"
            | "CUSTOMER_DEPOSIT"
            | "CUSTOMER_WITHDRAWAL"
            | "CUSTOMER_LEDGER_TRANSFER"
            | "CUSTOMER_SWAP"
            | "CUSTOMER_ESCROW_TRANSFER"
            | "CUSTOMER_CARD_TRANSACTION"
            | "CUSTOMER_IDENTITY"
            | "CUSTOMER_ORGANIZATION"
            | "CUSTOMER_PAYMENT_INSTRUMENT"
            | "CUSTOMER_REWARD"
            | "CUSTOMER_TERMS"
            | "CUSTOMER_VIRTUAL_ACCOUNT"
            | "TEMPLATE_TEST";
    },
): Promise<InternalSlackChannel | null>
The channel feed posts to: its own live row, else its fallback feed's live row (CUSTOMER_EVENTS for a CUSTOMER_* feed, DEFAULT for the rest), whose feed then reads the fallback. Null when neither exists.
Parameters
- __namedParameters: {
      feed:
          | "DEFAULT"
          | "ACH_BATCH"
          | "ACH_FILE"
          | "WIRE_BATCH"
          | "WIRE_FILE"
          | "BANK_TRANSACTION"
          | "BANK_INTERNAL_TRANSFER"
          | "WIRE_EMAIL"
          | "REDEMPTION"
          | "LEDGER_ACCOUNT_WITHDRAWAL"
          | "MANUAL_MINT"
          | "FEE_TRANSFER"
          | "AIPRISE_PROFILE"
          | "UTILA_TRANSACTION"
          | "EMAIL_SENT"
          | "CUSTOMER_EVENTS"
          | "CUSTOMER_DEPOSIT"
          | "CUSTOMER_WITHDRAWAL"
          | "CUSTOMER_LEDGER_TRANSFER"
          | "CUSTOMER_SWAP"
          | "CUSTOMER_ESCROW_TRANSFER"
          | "CUSTOMER_CARD_TRANSACTION"
          | "CUSTOMER_IDENTITY"
          | "CUSTOMER_ORGANIZATION"
          | "CUSTOMER_PAYMENT_INSTRUMENT"
          | "CUSTOMER_REWARD"
          | "CUSTOMER_TERMS"
          | "CUSTOMER_VIRTUAL_ACCOUNT"
          | "TEMPLATE_TEST";
  }
Returns Promise<InternalSlackChannel | null>
- Defined in slack-services/src/InternalSlackChannelAdminService.ts:159

getForFeeds

getForFeeds(
    __namedParameters?: {
        feeds?: readonly (
            | "DEFAULT"
            | "ACH_BATCH"
            | "ACH_FILE"
            | "WIRE_BATCH"
            | "WIRE_FILE"
            | "BANK_TRANSACTION"
            | "BANK_INTERNAL_TRANSFER"
            | "WIRE_EMAIL"
            | "REDEMPTION"
            | "LEDGER_ACCOUNT_WITHDRAWAL"
            | "MANUAL_MINT"
            | "FEE_TRANSFER"
            | "AIPRISE_PROFILE"
            | "UTILA_TRANSACTION"
            | "EMAIL_SENT"
            | "CUSTOMER_EVENTS"
            | "CUSTOMER_DEPOSIT"
            | "CUSTOMER_WITHDRAWAL"
            | "CUSTOMER_LEDGER_TRANSFER"
            | "CUSTOMER_SWAP"
            | "CUSTOMER_ESCROW_TRANSFER"
            | "CUSTOMER_CARD_TRANSACTION"
            | "CUSTOMER_IDENTITY"
            | "CUSTOMER_ORGANIZATION"
            | "CUSTOMER_PAYMENT_INSTRUMENT"
            | "CUSTOMER_REWARD"
            | "CUSTOMER_TERMS"
            | "CUSTOMER_VIRTUAL_ACCOUNT"
            | "TEMPLATE_TEST"
        )[];
    },
): Promise<
    {
        fallback: InternalSlackChannel
        | null;
        routes: {
            channel: InternalSlackChannel | null;
            fallbackFeed:
                | "DEFAULT"
                | "ACH_BATCH"
                | "ACH_FILE"
                | "WIRE_BATCH"
                | "WIRE_FILE"
                | "BANK_TRANSACTION"
                | "BANK_INTERNAL_TRANSFER"
                | "WIRE_EMAIL"
                | "REDEMPTION"
                | "LEDGER_ACCOUNT_WITHDRAWAL"
                | "MANUAL_MINT"
                | "FEE_TRANSFER"
                | "AIPRISE_PROFILE"
                | "UTILA_TRANSACTION"
                | "EMAIL_SENT"
                | "CUSTOMER_EVENTS"
                | "CUSTOMER_DEPOSIT"
                | "CUSTOMER_WITHDRAWAL"
                | "CUSTOMER_LEDGER_TRANSFER"
                | "CUSTOMER_SWAP"
                | "CUSTOMER_ESCROW_TRANSFER"
                | "CUSTOMER_CARD_TRANSACTION"
                | "CUSTOMER_IDENTITY"
                | "CUSTOMER_ORGANIZATION"
                | "CUSTOMER_PAYMENT_INSTRUMENT"
                | "CUSTOMER_REWARD"
                | "CUSTOMER_TERMS"
                | "CUSTOMER_VIRTUAL_ACCOUNT"
                | "TEMPLATE_TEST"
                | null;
            feed: | "DEFAULT"
            | "ACH_BATCH"
            | "ACH_FILE"
            | "WIRE_BATCH"
            | "WIRE_FILE"
            | "BANK_TRANSACTION"
            | "BANK_INTERNAL_TRANSFER"
            | "WIRE_EMAIL"
            | "REDEMPTION"
            | "LEDGER_ACCOUNT_WITHDRAWAL"
            | "MANUAL_MINT"
            | "FEE_TRANSFER"
            | "AIPRISE_PROFILE"
            | "UTILA_TRANSACTION"
            | "EMAIL_SENT"
            | "CUSTOMER_EVENTS"
            | "CUSTOMER_DEPOSIT"
            | "CUSTOMER_WITHDRAWAL"
            | "CUSTOMER_LEDGER_TRANSFER"
            | "CUSTOMER_SWAP"
            | "CUSTOMER_ESCROW_TRANSFER"
            | "CUSTOMER_CARD_TRANSACTION"
            | "CUSTOMER_IDENTITY"
            | "CUSTOMER_ORGANIZATION"
            | "CUSTOMER_PAYMENT_INSTRUMENT"
            | "CUSTOMER_REWARD"
            | "CUSTOMER_TERMS"
            | "CUSTOMER_VIRTUAL_ACCOUNT"
            | "TEMPLATE_TEST";
            inherited: boolean;
            sameAsDefault: boolean;
        }[];
    },
>
getForFeed for each of feeds, in order, in one cached read, beside the live DEFAULT row (fallback). A CUSTOMER_* feed inherits the CUSTOMER_EVENTS row instead, never DEFAULT.
Parameters
- __namedParameters: {
      feeds?: readonly (
          | "DEFAULT"
          | "ACH_BATCH"
          | "ACH_FILE"
          | "WIRE_BATCH"
          | "WIRE_FILE"
          | "BANK_TRANSACTION"
          | "BANK_INTERNAL_TRANSFER"
          | "WIRE_EMAIL"
          | "REDEMPTION"
          | "LEDGER_ACCOUNT_WITHDRAWAL"
          | "MANUAL_MINT"
          | "FEE_TRANSFER"
          | "AIPRISE_PROFILE"
          | "UTILA_TRANSACTION"
          | "EMAIL_SENT"
          | "CUSTOMER_EVENTS"
          | "CUSTOMER_DEPOSIT"
          | "CUSTOMER_WITHDRAWAL"
          | "CUSTOMER_LEDGER_TRANSFER"
          | "CUSTOMER_SWAP"
          | "CUSTOMER_ESCROW_TRANSFER"
          | "CUSTOMER_CARD_TRANSACTION"
          | "CUSTOMER_IDENTITY"
          | "CUSTOMER_ORGANIZATION"
          | "CUSTOMER_PAYMENT_INSTRUMENT"
          | "CUSTOMER_REWARD"
          | "CUSTOMER_TERMS"
          | "CUSTOMER_VIRTUAL_ACCOUNT"
          | "TEMPLATE_TEST"
      )[];
  } = {}
  - Optionalfeeds?: readonly (
        | "DEFAULT"
        | "ACH_BATCH"
        | "ACH_FILE"
        | "WIRE_BATCH"
        | "WIRE_FILE"
        | "BANK_TRANSACTION"
        | "BANK_INTERNAL_TRANSFER"
        | "WIRE_EMAIL"
        | "REDEMPTION"
        | "LEDGER_ACCOUNT_WITHDRAWAL"
        | "MANUAL_MINT"
        | "FEE_TRANSFER"
        | "AIPRISE_PROFILE"
        | "UTILA_TRANSACTION"
        | "EMAIL_SENT"
        | "CUSTOMER_EVENTS"
        | "CUSTOMER_DEPOSIT"
        | "CUSTOMER_WITHDRAWAL"
        | "CUSTOMER_LEDGER_TRANSFER"
        | "CUSTOMER_SWAP"
        | "CUSTOMER_ESCROW_TRANSFER"
        | "CUSTOMER_CARD_TRANSACTION"
        | "CUSTOMER_IDENTITY"
        | "CUSTOMER_ORGANIZATION"
        | "CUSTOMER_PAYMENT_INSTRUMENT"
        | "CUSTOMER_REWARD"
        | "CUSTOMER_TERMS"
        | "CUSTOMER_VIRTUAL_ACCOUNT"
        | "TEMPLATE_TEST"
    )[]
    
    Defaults to every feed, the fallback first.
Returns Promise<
    {
        fallback: InternalSlackChannel
        | null;
        routes: {
            channel: InternalSlackChannel | null;
            fallbackFeed:
                | "DEFAULT"
                | "ACH_BATCH"
                | "ACH_FILE"
                | "WIRE_BATCH"
                | "WIRE_FILE"
                | "BANK_TRANSACTION"
                | "BANK_INTERNAL_TRANSFER"
                | "WIRE_EMAIL"
                | "REDEMPTION"
                | "LEDGER_ACCOUNT_WITHDRAWAL"
                | "MANUAL_MINT"
                | "FEE_TRANSFER"
                | "AIPRISE_PROFILE"
                | "UTILA_TRANSACTION"
                | "EMAIL_SENT"
                | "CUSTOMER_EVENTS"
                | "CUSTOMER_DEPOSIT"
                | "CUSTOMER_WITHDRAWAL"
                | "CUSTOMER_LEDGER_TRANSFER"
                | "CUSTOMER_SWAP"
                | "CUSTOMER_ESCROW_TRANSFER"
                | "CUSTOMER_CARD_TRANSACTION"
                | "CUSTOMER_IDENTITY"
                | "CUSTOMER_ORGANIZATION"
                | "CUSTOMER_PAYMENT_INSTRUMENT"
                | "CUSTOMER_REWARD"
                | "CUSTOMER_TERMS"
                | "CUSTOMER_VIRTUAL_ACCOUNT"
                | "TEMPLATE_TEST"
                | null;
            feed: | "DEFAULT"
            | "ACH_BATCH"
            | "ACH_FILE"
            | "WIRE_BATCH"
            | "WIRE_FILE"
            | "BANK_TRANSACTION"
            | "BANK_INTERNAL_TRANSFER"
            | "WIRE_EMAIL"
            | "REDEMPTION"
            | "LEDGER_ACCOUNT_WITHDRAWAL"
            | "MANUAL_MINT"
            | "FEE_TRANSFER"
            | "AIPRISE_PROFILE"
            | "UTILA_TRANSACTION"
            | "EMAIL_SENT"
            | "CUSTOMER_EVENTS"
            | "CUSTOMER_DEPOSIT"
            | "CUSTOMER_WITHDRAWAL"
            | "CUSTOMER_LEDGER_TRANSFER"
            | "CUSTOMER_SWAP"
            | "CUSTOMER_ESCROW_TRANSFER"
            | "CUSTOMER_CARD_TRANSACTION"
            | "CUSTOMER_IDENTITY"
            | "CUSTOMER_ORGANIZATION"
            | "CUSTOMER_PAYMENT_INSTRUMENT"
            | "CUSTOMER_REWARD"
            | "CUSTOMER_TERMS"
            | "CUSTOMER_VIRTUAL_ACCOUNT"
            | "TEMPLATE_TEST";
            inherited: boolean;
            sameAsDefault: boolean;
        }[];
    },
>
- Defined in slack-services/src/InternalSlackChannelAdminService.ts:175

invalidateCache

invalidateCache(
    __namedParameters: {
        customerIds: readonly string[];
        keys?: readonly CacheKey[];
        records?: readonly string[];
    },
): Promise<void>
Clear each customer's membership tag and each record tag wherever cached, and always this namespace's collection tag. keys are exact deletes in this instance's key space: the only bust a null client honours.
Parameters
- __namedParameters: {
      customerIds: readonly string[];
      keys?: readonly CacheKey[];
      records?: readonly string[];
  }
Returns Promise<void>
Inherited from InternalSlackChannelCache.invalidateCache
- Defined in db/src/valkey/service-cache.ts:543

`Protected`invalidateChannel

invalidateChannel(
__namedParameters: Pick<InternalSlackChannel, "id">,
): Promise<void>
Bust every page a write to channel could have changed: the collection tag reaches every cached page, and the folded get key covers memory mode.
Parameters
- __namedParameters: Pick<InternalSlackChannel, "id">
Returns Promise<void>
Inherited from InternalSlackChannelCache.invalidateChannel
- Defined in slack-services/src/InternalSlackChannelCache.ts:88

`Protected`readThrough

readThrough(
key: CacheKey,
read: () => Promise<Page<InternalSlackChannel>>,
): Promise<Page<InternalSlackChannel>>
Read-through: the cached page for key, else read() stored under the collection tag.
Parameters
- key: CacheKey
- read: () => Promise<Page<InternalSlackChannel>>
Returns Promise<Page<InternalSlackChannel>>
Inherited from InternalSlackChannelCache.readThrough
- Defined in slack-services/src/InternalSlackChannelCache.ts:60

search

search(
__namedParameters?: Filters & { includeDeleted?: boolean },
): Promise<{ ok: true; value: Page }>
Stored rows only; getForFeeds applies the DEFAULT fallback.
Parameters
- __namedParameters: Filters & { includeDeleted?: boolean } = {}
Returns Promise<{ ok: true; value: Page }>
- Defined in slack-services/src/InternalSlackChannelAdminService.ts:129

`Protected`searchTags

searchTags(
    __namedParameters: {
        customerIds: readonly string[] | undefined;
        fields?: readonly string[];
        records?: readonly string[];
    },
): string[]
Tags for a page: the scope its query searched (each customer's membership tag, else the collection tag), so an empty page is bustable too, plus the records it projects and the fields that chose or ordered its rows.
Parameters
- __namedParameters: {
      customerIds: readonly string[] | undefined;
      fields?: readonly string[];
      records?: readonly string[];
  }
Returns string[]
Inherited from InternalSlackChannelCache.searchTags
- Defined in db/src/valkey/service-cache.ts:519

update

update(
    input: { channelId: string; id: string },
): Promise<
    | { ok: true; value: InternalSlackChannel }
    | { error: ServiceError; ok: false },
>
Repoints a live row at another Slack channel; its feed is fixed.
Parameters
- input: { channelId: string; id: string }
Returns Promise<
| { ok: true; value: InternalSlackChannel }
| { error: ServiceError; ok: false },
>
- Defined in slack-services/src/InternalSlackChannelAdminService.ts:268

`Static`adminGetCacheKey

adminGetCacheKey(__namedParameters: { id: string }): Record<string, unknown>
The exact key InternalSlackChannelAdminService.get reads through: the args it passes plus search's defaults. JCS drops the undefined filters. Writers delete it so read-after-write holds in memory mode.
Parameters
- __namedParameters: { id: string }
Returns Record<string, unknown>
Inherited from InternalSlackChannelCache.adminGetCacheKey
- Defined in slack-services/src/InternalSlackChannelCache.ts:51

Class InternalSlackChannelAdminService

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

db: B2bDatabase

internalEventPublisher: InternalEventPublisher | null

valkeyClient: ValkeyClient | null

Returns InternalSlackChannelAdminService

Properties

Protected Readonlycache

Staticinstance

Methods

create

Parameters

Returns Promise< | { ok: true; value: InternalSlackChannel } | { error: ServiceError; ok: false },>

delete

Parameters

Returns Promise<{ ok: true; value: undefined } | { error: ServiceError; ok: false }>

get

Parameters

Returns Promise<InternalSlackChannel | null>

getForFeed

Parameters

Returns Promise<InternalSlackChannel | null>

getForFeeds

Parameters

invalidateCache

Parameters

Returns Promise<void>

ProtectedinvalidateChannel

Parameters

Returns Promise<void>

ProtectedreadThrough

Parameters

Returns Promise<Page<InternalSlackChannel>>

search

Parameters

Returns Promise<{ ok: true; value: Page }>

ProtectedsearchTags

Parameters

Returns string[]

update

Parameters

Returns Promise< | { ok: true; value: InternalSlackChannel } | { error: ServiceError; ok: false },>

StaticadminGetCacheKey

Parameters

Returns Record<string, unknown>

Settings

On This Page

`Protected` `Readonly`cache

`Static`instance

Returns Promise<
| { ok: true; value: InternalSlackChannel }
| { error: ServiceError; ok: false },
>

`Protected`invalidateChannel

`Protected`readThrough

`Protected`searchTags

Returns Promise<
| { ok: true; value: InternalSlackChannel }
| { error: ServiceError; ok: false },
>

`Static`adminGetCacheKey