Class RewardEventConfigService

Rules that are configured per customer to trigger rewards on certain events

Hierarchy (View Summary)

RewardEventConfigQueryService
- RewardEventConfigService

Index

Constructors

constructor

new RewardEventConfigService(
    __namedParameters: {
        db: B2bDatabase;
        valkeyClient: ValkeyClient | null;
    },
): RewardEventConfigService
Parameters
- __namedParameters: { db: B2bDatabase; valkeyClient: ValkeyClient | null }
Returns RewardEventConfigService
Overrides RewardEventConfigQueryService.constructor
- Defined in packages/reward-services/src/RewardEventConfigService.ts:241

Properties

`Protected` `Readonly`db

db: B2bDatabase

`Protected` `Readonly`rewardEventNamesCache

rewardEventNamesCache: ServiceCache<string[]>

`Static`instance

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

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

Methods

delete

delete(__namedParameters: { customerId: string; event: string }): Promise<void>
Parameters
- __namedParameters: { customerId: string; event: string }
Returns Promise<void>
- Defined in packages/reward-services/src/RewardEventConfigService.ts:311

get

get(
__namedParameters: { customerId: string; event: string },
): Promise<RewardEventConfig | null>
Parameters
- __namedParameters: { customerId: string; event: string }
Returns Promise<RewardEventConfig | null>
Inherited from RewardEventConfigQueryService.get
- Defined in packages/reward-services/src/RewardEventConfigService.ts:96

getConfiguredEvents

getConfiguredEvents(): Promise<Set<string>>
Returns Promise<Set<string>>
Inherited from RewardEventConfigQueryService.getConfiguredEvents
- Defined in packages/reward-services/src/RewardEventConfigService.ts:202

getReward

getReward(
__namedParameters: { customerId: string; data: object; event: string },
): Promise<RewardAmount | null>
Match event and event data to the rules defined for the given customer

If multiple rules match, the first one is returned
Parameters
- __namedParameters: { customerId: string; data: object; event: string }
  - customerId: string
  - data: object
    
    Data associated with the event, compared against rule matchers
  - event: string
Returns Promise<RewardAmount | null>
Reward amount that this event qualifies for. null if no active rules match.
Inherited from RewardEventConfigQueryService.getReward
- Defined in packages/reward-services/src/RewardEventConfigService.ts:162

hasActiveRewardProgram

hasActiveRewardProgram(
__namedParameters: { customerId: string },
): Promise<boolean>
Display only: whether the customer has a reward_program row, cached with negatives. Credits and config writes call rewardProgramGate.ts fresh.
Parameters
- __namedParameters: { customerId: string }
Returns Promise<boolean>
Inherited from RewardEventConfigQueryService.hasActiveRewardProgram
- Defined in packages/reward-services/src/RewardEventConfigService.ts:74

invalidateRewardProgramGate

invalidateRewardProgramGate(
__namedParameters: { customerId: string },
): Promise<void>
Exact-key bust for RewardProgramService.create, after its insert commits.
Parameters
- __namedParameters: { customerId: string }
Returns Promise<void>
Inherited from RewardEventConfigQueryService.invalidateRewardProgramGate
- Defined in packages/reward-services/src/RewardEventConfigService.ts:88

search

search(
    __namedParameters: {
        customerId: string;
        events?: string[];
        page?: number;
        pageSize?: number;
        statuses?: ("ACTIVE" | "DISABLED")[];
    },
): Promise<
    {
        ok: true;
        value: { hasNext: boolean; items: RewardEventConfig[]; total: number };
    },
>
Parameters
- __namedParameters: {
      customerId: string;
      events?: string[];
      page?: number;
      pageSize?: number;
      statuses?: ("ACTIVE" | "DISABLED")[];
  }
Returns Promise<
    {
        ok: true;
        value: { hasNext: boolean; items: RewardEventConfig[]; total: number };
    },
>
Inherited from RewardEventConfigQueryService.search
- Defined in packages/reward-services/src/RewardEventConfigService.ts:111

upsert

upsert(
    __namedParameters: Omit<
        RewardEventConfig,
        "createdAt"
        | "updatedAt"
        | "eventDescription"
        | "statusDescription",
    > & { customerId: string },
): Promise<
    | { ok: true; value: RewardEventConfig }
    | { error: ServiceError; ok: false },
>
Creates or updates the reward event config for the given customer + event (INSERT ... ON CONFLICT DO UPDATE, keyed on the (customer, event) unique index). In case of update, rules replace the previous values (rather than merge).
Parameters
- __namedParameters: Omit<
      RewardEventConfig,
      "createdAt"
      | "updatedAt"
      | "eventDescription"
      | "statusDescription",
  > & { customerId: string }
Returns Promise<
| { ok: true; value: RewardEventConfig }
| { error: ServiceError; ok: false },
>
- Defined in packages/reward-services/src/RewardEventConfigService.ts:260

Class RewardEventConfigService

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns RewardEventConfigService

Properties

Protected Readonlydb

Protected ReadonlyrewardEventNamesCache

Staticinstance

Methods

delete

Parameters

Returns Promise<void>

get

Parameters

Returns Promise<RewardEventConfig | null>

getConfiguredEvents

Returns Promise<Set<string>>

getReward

Parameters

customerId: string

data: object

event: string

Returns Promise<RewardAmount | null>

hasActiveRewardProgram

Parameters

Returns Promise<boolean>

invalidateRewardProgramGate

Parameters

Returns Promise<void>

search

Parameters

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

upsert

Parameters

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

Settings

On This Page

`Protected` `Readonly`db

`Protected` `Readonly`rewardEventNamesCache

`Static`instance

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

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