Class VerificationTemplateAdminService

Cross-customer management of verification templates: the platform defaults and each customer's overrides. Reads project the external customerId and its customerName.

The table's only writer: every write busts the verification-template-search namespace this reads through and VerificationTemplateService shares.

Hierarchy

VerificationTemplateCache
- VerificationTemplateAdminService

Index

Constructors

constructor

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

Properties

`Protected` `Readonly`cache

cache: ServiceCache<CachedSearchPage<VerificationTemplate>>

`Static`instance

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

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

create

create(
    input: {
        aipriseTemplateId: string;
        customerId: string | null;
        type:
            | "ORGANIZATION_KYB"
            | "ORGANIZATION_DOCUMENT"
            | "IDENTITY_AML"
            | "IDENTITY_DOCUMENT"
            | "RELATED_PERSON_DOCUMENT"
            | "PAYMENT_INSTRUMENT_PERSON"
            | "PAYMENT_INSTRUMENT_BUSINESS";
    },
): Promise<
    | { ok: true; value: VerificationTemplate }
    | { error: ServiceError; ok: false },
>
A default for type when customerId is null, else that customer's override. One live row per (type, customer): replace one with update.
Parameters
- input: {
      aipriseTemplateId: string;
      customerId: string | null;
      type:
          | "ORGANIZATION_KYB"
          | "ORGANIZATION_DOCUMENT"
          | "IDENTITY_AML"
          | "IDENTITY_DOCUMENT"
          | "RELATED_PERSON_DOCUMENT"
          | "PAYMENT_INSTRUMENT_PERSON"
          | "PAYMENT_INSTRUMENT_BUSINESS";
  }
Returns Promise<
| { ok: true; value: VerificationTemplate }
| { error: ServiceError; ok: false },
>
- Defined in packages/customer-services/src/VerificationTemplateAdminService.ts:154

delete

delete(
    __namedParameters: { id: string },
): Promise<
    { ok: true; value: undefined }
    | { error: ServiceError; ok: false },
>
Soft-deletes a customer override, so the type falls back to the default. A default cannot be deleted: VerificationTemplateService.get needs one per type.
Parameters
- __namedParameters: { id: string }
Returns Promise<{ ok: true; value: undefined } | { error: ServiceError; ok: false }>
- Defined in packages/customer-services/src/VerificationTemplateAdminService.ts:269

get

get(__namedParameters: { id: string }): Promise<VerificationTemplate | null>
Parameters
- __namedParameters: { id: string }
Returns Promise<VerificationTemplate | null>
- Defined in packages/customer-services/src/VerificationTemplateAdminService.ts:141

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?: SearchFilters,
): Promise<
    {
        ok: true;
        value: { hasNext: boolean; items: VerificationTemplate[]; total: number };
    },
>
Stored rows, defaults and overrides alike; see VerificationTemplateService.search for the effective ones.
Parameters
- __namedParameters: SearchFilters = {}
Returns Promise<
    {
        ok: true;
        value: { hasNext: boolean; items: VerificationTemplate[]; total: number };
    },
>
- Defined in packages/customer-services/src/VerificationTemplateAdminService.ts:104

`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

update

update(
    input: { aipriseTemplateId: string; id: string },
): Promise<
    | { ok: true; value: VerificationTemplate }
    | { error: ServiceError; ok: false },
>
Repoints a live template at another AiPrise template; type and customer are fixed.
Parameters
- input: { aipriseTemplateId: string; id: string }
Returns Promise<
| { ok: true; value: VerificationTemplate }
| { error: ServiceError; ok: false },
>
- Defined in packages/customer-services/src/VerificationTemplateAdminService.ts:225

`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 VerificationTemplateAdminService

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns VerificationTemplateAdminService

Properties

Protected Readonlycache

Staticinstance

Methods

ProtectedconsumerSearchTags

Parameters

Returns string[]

create

Parameters

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

delete

Parameters

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

get

Parameters

Returns Promise<VerificationTemplate | null>

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[]

update

Parameters

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

StaticadminGetCacheKey

Parameters

Returns Record<string, unknown>

Settings

On This Page

`Protected` `Readonly`cache

`Static`instance

`Protected`consumerSearchTags

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

`Protected`invalidateTemplate

`Protected`readThrough

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

`Protected`searchTags

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

`Static`adminGetCacheKey