Class ProductActivationRuleAdminService

Admin-tier CRUD over product_activation_rule: any tier on a route, and ADMIN DENY-only cross-route rules. The scope is fixed at create; see docs/PRODUCT_SERVICES.md § Cross-route activation rules.

Hierarchy

ProductConfigSearchCache<AdminProductActivationRule>
- ProductActivationRuleAdminService

Index

Constructors

constructor

new ProductActivationRuleAdminService(
    __namedParameters: {
        db: B2bDatabase;
        internalEventPublisher: InternalEventPublisher | null;
        valkeyClient: ValkeyClient | null;
    },
): ProductActivationRuleAdminService
Parameters
- __namedParameters: {
      db: B2bDatabase;
      internalEventPublisher: InternalEventPublisher | null;
      valkeyClient: ValkeyClient | null;
  }
  - db: B2bDatabase
  - internalEventPublisher: InternalEventPublisher | null
    
    Publishes product.activationRule.*; null publishes nothing (scripts, tests).
  - valkeyClient: ValkeyClient | null
Returns ProductActivationRuleAdminService
Overrides ProductConfigSearchCache<AdminProductActivationRule>.constructor
- Defined in packages/product-services/src/ProductActivationRuleAdminService.ts:217

Properties

`Protected` `Readonly`cache

cache: ServiceCache<CachedSearchPage<AdminProductActivationRule>>

`Protected` `Readonly`db

db: B2bDatabase

`Static`instance

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

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

Methods

`Protected`bustSearchCache

bustSearchCache(...keys: CacheKey[]): Promise<void>
After a committed write: the folded-get keys (a tag bust no-ops without Valkey), then every page through the collection tag.
Parameters
- ...keys: CacheKey[]
Returns Promise<void>
Inherited from ProductConfigSearchCache.bustSearchCache
- Defined in packages/product-services/src/internal/configSearchCache.ts:106

`Protected`cachedSearch

cachedSearch(
input: Record<string, unknown>,
query: () => Promise<CachedSearchPage<AdminProductActivationRule>>,
): Promise<CachedSearchPage<AdminProductActivationRule>>
Serves input's page from the cache, else runs query and caches it.
Parameters
- input: Record<string, unknown>
- query: () => Promise<CachedSearchPage<AdminProductActivationRule>>
Returns Promise<CachedSearchPage<AdminProductActivationRule>>
Inherited from ProductConfigSearchCache.cachedSearch
- Defined in packages/product-services/src/internal/configSearchCache.ts:85

create

create(
    input: {
        customerId?: string;
        description?: string;
        effectiveFrom?: Instant;
        label?: string;
        matcher?: Matcher | undefined;
        priority: number;
        type?: "CUSTOMER" | "ADMIN";
        value: "APPROVE" | "DENY";
    } & ActivationRuleScopeInput,
): Promise<
    | { ok: true; value: AdminProductActivationRule }
    | { error: CreateError; ok: false },
>
Parameters
- input: {
      customerId?: string;
      description?: string;
      effectiveFrom?: Instant;
      label?: string;
      matcher?: Matcher | undefined;
      priority: number;
      type?: "CUSTOMER" | "ADMIN";
      value: "APPROVE" | "DENY";
  } & ActivationRuleScopeInput
  - OptionalcustomerId?: string
    
    External id; required when type='CUSTOMER'. On a cross-route rule it is a scope column: the rule applies to this customer only.
  - Optionaldescription?: string
  - OptionaleffectiveFrom?: Instant
    
    When this version becomes effective. Defaults to now() at the DB layer when omitted. Pass a future Temporal.Instant to schedule a change (e.g. Reg E 30-day notice).
  - Optionallabel?: string
  - Optionalmatcher?: Matcher | undefined
  - priority: number
  - Optionaltype?: "CUSTOMER" | "ADMIN"
  - value: "APPROVE" | "DENY"
Returns Promise<
| { ok: true; value: AdminProductActivationRule }
| { error: CreateError; ok: false },
>
- Defined in packages/product-services/src/ProductActivationRuleAdminService.ts:237

delete

delete(
input: { id: string },
): Promise<{ ok: true; value: void } | { error: ServiceError; ok: false }>
Parameters
- input: { id: string }
Returns Promise<{ ok: true; value: void } | { error: ServiceError; ok: false }>
- Defined in packages/product-services/src/ProductActivationRuleAdminService.ts:596

get

get(input: { id: string }): Promise<AdminProductActivationRule | null>
Parameters
- input: { id: string }
Returns Promise<AdminProductActivationRule | null>
- Defined in packages/product-services/src/ProductActivationRuleAdminService.ts:662

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

search

search(
    input: {
        createdAt?: DbTimestampCriteria<Instant>;
        customerIds?: string[];
        ids?: string[];
        orderBy?: RuleOrderByCriterion[];
        page?: number;
        pageSize?: number;
        productCategories?: ProductCategory[];
        productIds?: string[];
        routeIds?: string[];
        scopes?: ("ROUTE" | "CROSS_ROUTE")[];
        statuses?: ("ACTIVE" | "DISABLED")[];
        types?: ("CUSTOMER" | "ADMIN")[];
        updatedAt?: DbTimestampCriteria<Instant>;
        vendorIds?: Vendor[];
    },
): Promise<
    {
        ok: true;
        value: {
            hasNext: boolean;
            items: AdminProductActivationRule[];
            total: number;
        };
    },
>
Parameters
- input: {
      createdAt?: DbTimestampCriteria<Instant>;
      customerIds?: string[];
      ids?: string[];
      orderBy?: RuleOrderByCriterion[];
      page?: number;
      pageSize?: number;
      productCategories?: ProductCategory[];
      productIds?: string[];
      routeIds?: string[];
      scopes?: ("ROUTE" | "CROSS_ROUTE")[];
      statuses?: ("ACTIVE" | "DISABLED")[];
      types?: ("CUSTOMER" | "ADMIN")[];
      updatedAt?: DbTimestampCriteria<Instant>;
      vendorIds?: Vendor[];
  }
  - OptionalcreatedAt?: DbTimestampCriteria<Instant>
  - OptionalcustomerIds?: string[]
  - Optionalids?: string[]
  - OptionalorderBy?: RuleOrderByCriterion[]
  - Optionalpage?: number
  - OptionalpageSize?: number
  - OptionalproductCategories?: ProductCategory[]
    
    Matches cross-route rules scoped to these categories.
  - OptionalproductIds?: string[]
    
    A route rule's route product, or a cross-route rule's scope product.
  - OptionalrouteIds?: string[]
    
    Matches route rules only.
  - Optionalscopes?: ("ROUTE" | "CROSS_ROUTE")[]
    
    ROUTE rules have a route; CROSS_ROUTE rules do not.
  - Optionalstatuses?: ("ACTIVE" | "DISABLED")[]
  - Optionaltypes?: ("CUSTOMER" | "ADMIN")[]
  - OptionalupdatedAt?: DbTimestampCriteria<Instant>
  - OptionalvendorIds?: Vendor[]
    
    A route rule's route vendor, or a cross-route rule's scope vendor.
Returns Promise<
    {
        ok: true;
        value: {
            hasNext: boolean;
            items: AdminProductActivationRule[];
            total: number;
        };
    },
>
- Defined in packages/product-services/src/ProductActivationRuleAdminService.ts:632

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

update

update(
    input: {
        data: {
            description?: string | null;
            effectiveFrom?: Instant;
            label?: string | null;
            matcher?: Matcher;
            priority?: number;
            status?: "ACTIVE" | "DISABLED";
            value?: "APPROVE" | "DENY";
        };
        id: string;
    },
): Promise<
    | { ok: true; value: AdminProductActivationRule }
    | { error: ServiceError; ok: false },
>
The rule's scope (route, or category / vendor / product / customer) is fixed at create; a cross-route rule stays DENY.
Parameters
- input: {
      data: {
          description?: string | null;
          effectiveFrom?: Instant;
          label?: string | null;
          matcher?: Matcher;
          priority?: number;
          status?: "ACTIVE" | "DISABLED";
          value?: "APPROVE" | "DENY";
      };
      id: string;
  }
Returns Promise<
| { ok: true; value: AdminProductActivationRule }
| { error: ServiceError; ok: false },
>
- Defined in packages/product-services/src/ProductActivationRuleAdminService.ts:457

Class ProductActivationRuleAdminService

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

db: B2bDatabase

internalEventPublisher: InternalEventPublisher | null

valkeyClient: ValkeyClient | null

Returns ProductActivationRuleAdminService

Properties

Protected Readonlycache

Protected Readonlydb

Staticinstance

Methods

ProtectedbustSearchCache

Parameters

Returns Promise<void>

ProtectedcachedSearch

Parameters

Returns Promise<CachedSearchPage<AdminProductActivationRule>>

create

Parameters

OptionalcustomerId?: string

Optionaldescription?: string

OptionaleffectiveFrom?: Instant

Optionallabel?: string

Optionalmatcher?: Matcher | undefined

priority: number

Optionaltype?: "CUSTOMER" | "ADMIN"

value: "APPROVE" | "DENY"

Returns Promise< | { ok: true; value: AdminProductActivationRule } | { error: CreateError; ok: false },>

delete

Parameters

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

get

Parameters

Returns Promise<AdminProductActivationRule | null>

invalidateCache

Parameters

Returns Promise<void>

search

Parameters

OptionalcreatedAt?: DbTimestampCriteria<Instant>

OptionalcustomerIds?: string[]

Optionalids?: string[]

OptionalorderBy?: RuleOrderByCriterion[]

Optionalpage?: number

OptionalpageSize?: number

OptionalproductCategories?: ProductCategory[]

OptionalproductIds?: string[]

OptionalrouteIds?: string[]

Optionalscopes?: ("ROUTE" | "CROSS_ROUTE")[]

Optionalstatuses?: ("ACTIVE" | "DISABLED")[]

Optionaltypes?: ("CUSTOMER" | "ADMIN")[]

OptionalupdatedAt?: DbTimestampCriteria<Instant>

OptionalvendorIds?: Vendor[]

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

ProtectedsearchTags

Parameters

Returns string[]

update

Parameters

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

Settings

On This Page

`Protected` `Readonly`cache

`Protected` `Readonly`db

`Static`instance

`Protected`bustSearchCache

`Protected`cachedSearch

`Optional`customerId?: string

`Optional`description?: string

`Optional`effectiveFrom?: Instant

`Optional`label?: string

`Optional`matcher?: Matcher | undefined

`Optional`type?: "CUSTOMER" | "ADMIN"

Returns Promise<
| { ok: true; value: AdminProductActivationRule }
| { error: CreateError; ok: false },
>

`Optional`createdAt?: DbTimestampCriteria<Instant>

`Optional`customerIds?: string[]

`Optional`ids?: string[]

`Optional`orderBy?: RuleOrderByCriterion[]

`Optional`page?: number

`Optional`pageSize?: number

`Optional`productCategories?: ProductCategory[]

`Optional`productIds?: string[]

`Optional`routeIds?: string[]

`Optional`scopes?: ("ROUTE" | "CROSS_ROUTE")[]

`Optional`statuses?: ("ACTIVE" | "DISABLED")[]

`Optional`types?: ("CUSTOMER" | "ADMIN")[]

`Optional`updatedAt?: DbTimestampCriteria<Instant>

`Optional`vendorIds?: Vendor[]

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

`Protected`searchTags

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