Class WireFileService

The wire-file writer. Extends the reader, so its writes bust the very cache instance its own get / search read through.

Hierarchy (View Summary)

WireFileQueryService
- WireFileService

Index

Constructors

constructor

new WireFileService(
    args: {
        db: B2bDatabase;
        internalEventPublisher: InternalEventPublisher;
        metcapWireBatchAdminService: MetcapWireBatchAdminService;
        valkeyClient: ValkeyClient | null;
        wireFileGeneratorService: MetcapWireFileGeneratorService;
        wireFileS3Service: WireFileS3Service;
    },
): WireFileService
Parameters
- args: {
      db: B2bDatabase;
      internalEventPublisher: InternalEventPublisher;
      metcapWireBatchAdminService: MetcapWireBatchAdminService;
      valkeyClient: ValkeyClient | null;
      wireFileGeneratorService: MetcapWireFileGeneratorService;
      wireFileS3Service: WireFileS3Service;
  }
Returns WireFileService
Overrides WireFileQueryService.constructor
- Defined in packages/withdrawal-services/src/metcap/MetcapWireFileService.ts:65

Properties

`Protected` `Readonly`cache

cache: ServiceCache<CachedSearchPage<WireFile>>

`Protected` `Readonly`db

db: B2bDatabase

`Static`instance

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

The process default: built from each dependency's own instance().

Methods

create

create(
    args: {
        tx?: PgAsyncTransaction<NodePgQueryResultHKT, EmptyRelations>;
        type: "FEDWIRE" | "SWIFT";
        wireBatchIds: string[];
    },
): Promise<
    { ok: true; value: WireFile }
    | { error: ServiceError; ok: false },
>
Parameters
- args: {
      tx?: PgAsyncTransaction<NodePgQueryResultHKT, EmptyRelations>;
      type: "FEDWIRE" | "SWIFT";
      wireBatchIds: string[];
  }
Returns Promise<{ ok: true; value: WireFile } | { error: ServiceError; ok: false }>
- Defined in packages/withdrawal-services/src/metcap/MetcapWireFileService.ts:121

get

get(
    args: {
        id: string;
        tx?: PgAsyncTransaction<NodePgQueryResultHKT, EmptyRelations>;
    },
): Promise<{ ok: true; value: WireFile | null }>
Parameters
- args: { id: string; tx?: PgAsyncTransaction<NodePgQueryResultHKT, EmptyRelations> }
Returns Promise<{ ok: true; value: WireFile | null }>
Inherited from WireFileQueryService.get
- Defined in packages/withdrawal-services/src/metcap/WireFileQueryService.ts:78

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 WireFileQueryService.invalidateCache
- Defined in packages/db/src/valkey/service-cache.ts:543

search

search(
__namedParameters: WireFileSearchArgs,
): Promise<{ ok: true; value: WireFileSearchPage }>
Reads through the cache, except under a caller's tx.
Parameters
- __namedParameters: WireFileSearchArgs
Returns Promise<{ ok: true; value: WireFileSearchPage }>
Inherited from WireFileQueryService.search
- Defined in packages/withdrawal-services/src/metcap/WireFileQueryService.ts:91

`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 WireFileQueryService.searchTags
- Defined in packages/db/src/valkey/service-cache.ts:519

stat

stat(
args?: { status?: "CREATED" | "SUBMITTED" | "ARCHIVED" },
): Promise<{ ok: true; value: { count: number } }>
Parameters
- args: { status?: "CREATED" | "SUBMITTED" | "ARCHIVED" } = {}
Returns Promise<{ ok: true; value: { count: number } }>
Inherited from WireFileQueryService.stat
- Defined in packages/withdrawal-services/src/metcap/WireFileQueryService.ts:170

submit

submit(
    args: {
        ids: string[];
        tx?: PgAsyncTransaction<NodePgQueryResultHKT, EmptyRelations>;
    },
): Promise<
    { error: ServiceError; ok: false }
    | { ok: true; value: WireFile[] },
>
Parameters
- args: { ids: string[]; tx?: PgAsyncTransaction<NodePgQueryResultHKT, EmptyRelations> }
Returns Promise<{ error: ServiceError; ok: false } | { ok: true; value: WireFile[] }>
- Defined in packages/withdrawal-services/src/metcap/MetcapWireFileService.ts:352

`Static`getCacheKey

getCacheKey(__namedParameters: { id: string }): CacheKey
The key WireFileQueryService.get reads through.
Parameters
- __namedParameters: { id: string }
Returns CacheKey
Inherited from WireFileQueryService.getCacheKey
- Defined in packages/withdrawal-services/src/metcap/WireFileCache.ts:34

Class WireFileService

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns WireFileService

Properties

Protected Readonlycache

Protected Readonlydb

Staticinstance

Methods

archive

Parameters

Returns Promise< | { ok: true; value: { affectedBatchIds: string[] } } | { error: ServiceError; ok: false },>

create

Parameters

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

get

Parameters

Returns Promise<{ ok: true; value: WireFile | null }>

invalidateCache

Parameters

Returns Promise<void>

search

Parameters

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

ProtectedsearchTags

Parameters

Returns string[]

stat

Parameters

Returns Promise<{ ok: true; value: { count: number } }>

submit

Parameters

Returns Promise<{ error: ServiceError; ok: false } | { ok: true; value: WireFile[] }>

StaticgetCacheKey

Parameters

Returns CacheKey

Settings

On This Page

`Protected` `Readonly`cache

`Protected` `Readonly`db

`Static`instance

Returns Promise<
| { ok: true; value: { affectedBatchIds: string[] } }
| { error: ServiceError; ok: false },
>

`Protected`searchTags

`Static`getCacheKey