Class ProductFeeRuleAdminService

Admin-tier CRUD over product_fee_rule. Accepts any rule type (admin-global, admin-for-customer, or customer).

Identity / version split: product_fee_rule holds scope columns (routeId, customerId, type) plus a currentVersionId pointer; every mutable field (matcher, status, priority, fee values, label, description) lives on product_fee_rule_version and is append-only. Editing means inserting a new version row, merged onto the version in effect now, and re-pointing currentVersionId in one transaction.

Duplicate-matcher detection is enforced by the partial unique index product_fee_rule_unique_tuple — see ProductActivationRuleAdminService for the rationale. matcherHash is denormalized onto the identity row; service code maintains identity.matcherHash = currentVersion.matcherHash on every version bump and translates the unique-violation back into DUPLICATE_MATCHER.

Hierarchy

ProductConfigSearchCache<AdminProductFeeRule>
- ProductFeeRuleAdminService

Index

Constructors

constructor

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

Properties

`Protected` `Readonly`cache

cache: ServiceCache<CachedSearchPage<AdminProductFeeRule>>

`Protected` `Readonly`db

db: B2bDatabase

`Static`instance

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

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

create

create(
    input: {
        customerId?: string;
        description?: string;
        effectiveFrom?: Instant;
        fixedFeeAmount?: BigNumber;
        label?: string;
        matcher?: Matcher;
        priority: number;
        routeId: string;
        type?: "CUSTOMER" | "ADMIN";
        variableFeeBps?: BigNumber;
    },
): Promise<
    | { ok: true; value: AdminProductFeeRule }
    | { error: ServiceError; ok: false },
>
Parameters
- input: {
      customerId?: string;
      description?: string;
      effectiveFrom?: Instant;
      fixedFeeAmount?: BigNumber;
      label?: string;
      matcher?: Matcher;
      priority: number;
      routeId: string;
      type?: "CUSTOMER" | "ADMIN";
      variableFeeBps?: BigNumber;
  }
  - OptionalcustomerId?: string
  - 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).
  - OptionalfixedFeeAmount?: BigNumber
  - Optionallabel?: string
  - Optionalmatcher?: Matcher
  - priority: number
  - routeId: string
  - Optionaltype?: "CUSTOMER" | "ADMIN"
  - OptionalvariableFeeBps?: BigNumber
Returns Promise<
| { ok: true; value: AdminProductFeeRule }
| { error: ServiceError; ok: false },
>
- Defined in packages/product-services/src/ProductFeeRuleAdminService.ts:154

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/ProductFeeRuleAdminService.ts:394

get

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

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;
        routeIds?: string[];
        statuses?: ("ACTIVE" | "DISABLED")[];
        types?: ("CUSTOMER" | "ADMIN")[];
        updatedAt?: DbTimestampCriteria<Instant>;
    },
): Promise<
    {
        ok: true;
        value: { hasNext: boolean; items: AdminProductFeeRule[]; total: number };
    },
>
Parameters
- input: {
      createdAt?: DbTimestampCriteria<Instant>;
      customerIds?: string[];
      ids?: string[];
      orderBy?: RuleOrderByCriterion[];
      page?: number;
      pageSize?: number;
      routeIds?: string[];
      statuses?: ("ACTIVE" | "DISABLED")[];
      types?: ("CUSTOMER" | "ADMIN")[];
      updatedAt?: DbTimestampCriteria<Instant>;
  }
Returns Promise<
    {
        ok: true;
        value: { hasNext: boolean; items: AdminProductFeeRule[]; total: number };
    },
>
- Defined in packages/product-services/src/ProductFeeRuleAdminService.ts:430

`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;
            fixedFeeAmount?: BigNumber | null;
            label?: string | null;
            matcher?: Matcher;
            priority?: number;
            status?: "ACTIVE" | "DISABLED";
            variableFeeBps?: BigNumber | null;
        };
        id: string;
    },
): Promise<
    | { ok: true; value: AdminProductFeeRule }
    | { error: ServiceError; ok: false },
>
Parameters
- input: {
      data: {
          description?: string | null;
          effectiveFrom?: Instant;
          fixedFeeAmount?: BigNumber | null;
          label?: string | null;
          matcher?: Matcher;
          priority?: number;
          status?: "ACTIVE" | "DISABLED";
          variableFeeBps?: BigNumber | null;
      };
      id: string;
  }
Returns Promise<
| { ok: true; value: AdminProductFeeRule }
| { error: ServiceError; ok: false },
>
- Defined in packages/product-services/src/ProductFeeRuleAdminService.ts:268

Class ProductFeeRuleAdminService

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

db: B2bDatabase

internalEventPublisher: InternalEventPublisher | null

valkeyClient: ValkeyClient | null

Returns ProductFeeRuleAdminService

Properties

Protected Readonlycache

Protected Readonlydb

Staticinstance

Methods

ProtectedbustSearchCache

Parameters

Returns Promise<void>

ProtectedcachedSearch

Parameters

Returns Promise<CachedSearchPage<AdminProductFeeRule>>

create

Parameters

OptionalcustomerId?: string

Optionaldescription?: string

OptionaleffectiveFrom?: Instant

OptionalfixedFeeAmount?: BigNumber

Optionallabel?: string

Optionalmatcher?: Matcher

priority: number

routeId: string

Optionaltype?: "CUSTOMER" | "ADMIN"

OptionalvariableFeeBps?: BigNumber

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

delete

Parameters

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

get

Parameters

Returns Promise<AdminProductFeeRule | null>

invalidateCache

Parameters

Returns Promise<void>

search

Parameters

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

ProtectedsearchTags

Parameters

Returns string[]

update

Parameters

Returns Promise< | { ok: true; value: AdminProductFeeRule } | { 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`fixedFeeAmount?: BigNumber

`Optional`label?: string

`Optional`matcher?: Matcher

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

`Optional`variableFeeBps?: BigNumber

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

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

`Protected`searchTags

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