Class VerificationTemplateService

Reads the AiPrise verification templates in effect for a customer. Each type resolves to the customer's override when it has one, else the platform default.

Reads through the verification-template-search cache it shares with VerificationTemplateCache's admin surface, whose writes bust it.

Hierarchy

VerificationTemplateCache
- VerificationTemplateService

Index

Constructors

constructor

new VerificationTemplateService(
    __namedParameters: {
        db: B2bDatabase;
        valkeyClient: ValkeyClient | null;
    },
): VerificationTemplateService
Parameters
- __namedParameters: { db: B2bDatabase; valkeyClient: ValkeyClient | null }
Returns VerificationTemplateService
Overrides VerificationTemplateCache.constructor
- Defined in packages/customer-services/src/VerificationTemplateService.ts:55

Properties

`Protected` `Readonly`cache

cache: ServiceCache<CachedSearchPage<VerificationTemplate>>

`Static`instance

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

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

Methods

`Protected`consumerSearchTags

consumerSearchTags(customerId: string | null): string[]
Tags for a consumer page: its customer, if any, plus the defaults it resolves through.
Parameters
- customerId: string | null
Returns string[]
Inherited from VerificationTemplateCache.consumerSearchTags
- Defined in packages/customer-services/src/VerificationTemplateCache.ts:74

get

get(
    __namedParameters: {
        customerId: string;
        type:
            | "ORGANIZATION_KYB"
            | "ORGANIZATION_DOCUMENT"
            | "IDENTITY_AML"
            | "IDENTITY_DOCUMENT"
            | "RELATED_PERSON_DOCUMENT"
            | "PAYMENT_INSTRUMENT_PERSON"
            | "PAYMENT_INSTRUMENT_BUSINESS";
    },
): Promise<VerificationTemplate>
The effective template of type for this customer.
Parameters
- __namedParameters: {
      customerId: string;
      type:
          | "ORGANIZATION_KYB"
          | "ORGANIZATION_DOCUMENT"
          | "IDENTITY_AML"
          | "IDENTITY_DOCUMENT"
          | "RELATED_PERSON_DOCUMENT"
          | "PAYMENT_INSTRUMENT_PERSON"
          | "PAYMENT_INSTRUMENT_BUSINESS";
  }
Returns Promise<VerificationTemplate>

Throws
when type has no default row — every type needs one, so this is a deploy defect.
- Defined in packages/customer-services/src/VerificationTemplateService.ts:123

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

`Protected`invalidateTemplate

invalidateTemplate(
__namedParameters: Pick<VerificationTemplate, "id" | "customerId">,
): Promise<void>
Bust every page a write to template could have changed. An override reaches its customer's pages; a default reaches every consumer page. Both clear the collection tag and the folded admin get key.
Parameters
- __namedParameters: Pick<VerificationTemplate, "id" | "customerId">
Returns Promise<void>
Inherited from VerificationTemplateCache.invalidateTemplate
- Defined in packages/customer-services/src/VerificationTemplateCache.ts:109

`Protected`readThrough

readThrough(
    key: CacheKey,
    tags: string[],
    read: () => Promise<Page<VerificationTemplate>>,
): Promise<Page<VerificationTemplate>>
Read-through: the cached page for key, else read() stored under tags plus the record tag of each customer whose name an override row copies.
Parameters
- key: CacheKey
- tags: string[]
- read: () => Promise<Page<VerificationTemplate>>
Returns Promise<Page<VerificationTemplate>>
Inherited from VerificationTemplateCache.readThrough
- Defined in packages/customer-services/src/VerificationTemplateCache.ts:87

search

search(
    __namedParameters: { customerId: string | null } & VerificationTemplateFilters,
): Promise<
    {
        ok: true;
        value: { hasNext: boolean; items: VerificationTemplate[]; total: number };
    },
>
The effective template per type for this customer: its live override, else the live default (customerId: null). An unknown customerId gets the defaults, and customerId: null (no customer yet) gets only the defaults.
Parameters
- __namedParameters: { customerId: string | null } & VerificationTemplateFilters
Returns Promise<
    {
        ok: true;
        value: { hasNext: boolean; items: VerificationTemplate[]; total: number };
    },
>
- Defined in packages/customer-services/src/VerificationTemplateService.ts:71

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

`Static`adminGetCacheKey

adminGetCacheKey(__namedParameters: { id: string }): Record<string, unknown>
The exact key VerificationTemplateAdminService.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 VerificationTemplateCache.adminGetCacheKey
- Defined in packages/customer-services/src/VerificationTemplateCache.ts:65

Class VerificationTemplateService

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns VerificationTemplateService

Properties

Protected Readonlycache

Staticinstance

Methods

ProtectedconsumerSearchTags

Parameters

Returns string[]

get

Parameters

Returns Promise<VerificationTemplate>

Throws

invalidateCache

Parameters

Returns Promise<void>

ProtectedinvalidateTemplate

Parameters

Returns Promise<void>

ProtectedreadThrough

Parameters

Returns Promise<Page<VerificationTemplate>>

search

Parameters

Returns Promise< { ok: true; value: { hasNext: boolean; items: VerificationTemplate[]; total: number }; },>

ProtectedsearchTags

Parameters

Returns string[]

StaticadminGetCacheKey

Parameters

Returns Record<string, unknown>

Settings

On This Page

`Protected` `Readonly`cache

`Static`instance

`Protected`consumerSearchTags

`Protected`invalidateTemplate

`Protected`readThrough

Returns Promise<
{
ok: true;
value: { hasNext: boolean; items: VerificationTemplate[]; total: number };
},
>

`Protected`searchTags

`Static`adminGetCacheKey