`@withpotter/loyalty` — module reference

A support module — it mounts no HTTP routes of its own but contributes the internal building blocks below. See the package internal architecture for how the layers fit together.

Internals

Entities

Sequelize models owned by this module.

`LoyaltyProgram` — table `loyalty_programs`

Field	Type
`id`	`string`
`tenantId`	`string`
`tenant`	`Tenant`
`name`	`string`
`pointsName`	`string`
`pointsPerCurrency`	`number`
`currencyPerPoint`	`number`
`minRedeemPoints`	`number`
`pointsExpiryDays`	`number \| null`
`isActive`	`boolean`
`settings`	`LoyaltyProgramSettings \| null`
`createdAt`	`Date`
`updatedAt`	`Date`
`tiers`	`LoyaltyTier[]`
`earnRules`	`LoyaltyEarnRule[]`
`balances`	`LoyaltyBalance[]`
`id`	`string`
`programId`	`string`
`program`	`LoyaltyProgram`
`name`	`string`
`minLifetimePoints`	`number`
`earnMultiplier`	`number`
`perks`	`LoyaltyTierPerks \| null`
`badgeColor`	`string \| null`
`position`	`number`
`createdAt`	`Date`
`updatedAt`	`Date`
`id`	`string`
`programId`	`string`
`program`	`LoyaltyProgram`
`trigger`	`LoyaltyEarnTrigger`
`pointsAmount`	`number \| null`
`pointsPerCurrencyOverride`	`number \| null`
`description`	`string \| null`
`isActive`	`boolean`
`conditions`	`Record<string, unknown> \| null`
`createdAt`	`Date`
`updatedAt`	`Date`
`id`	`string`
`programId`	`string`
`program`	`LoyaltyProgram`
`memberId`	`string`
`member`	`Member`
`tenantId`	`string`
`tenant`	`Tenant`
`currentPoints`	`number`
`lifetimePoints`	`number`
`redeemedPoints`	`number`
`tierId`	`string \| null`
`tier`	`LoyaltyTier`
`lastEarnedAt`	`Date \| null`
`lastRedeemedAt`	`Date \| null`
`createdAt`	`Date`
`updatedAt`	`Date`
`transactions`	`LoyaltyTransaction[]`
`id`	`string`
`balanceId`	`string`
`balance`	`LoyaltyBalance`
`tenantId`	`string`
`type`	`LoyaltyTransactionType`
`points`	`number`
`description`	`string \| null`
`trigger`	`LoyaltyEarnTrigger \| null`
`orderId`	`string \| null`
`bookingId`	`string \| null`
`metadata`	`Record<string, unknown> \| null`
`createdAt`	`Date`

Repositories

Data-access classes wrapping the entities.

`LoyaltyRepository`

findProgramByTenant · findAllProgramsByTenant · countProgramsByTenant · findProgramById · createProgram · updateProgram · deleteProgram · findTiersByProgram · createTier · updateTier · deleteTier · findTierForPoints · findEarnRulesByProgram · findActiveEarnRule · createEarnRule · updateEarnRule · deleteEarnRule · findBalance · findBalanceByTenantAndMember · findOrCreateBalance · listBalances · earnPoints · redeemPoints · updateBalanceTier · listTransactions · getProgramStats

Generated from the module’s source. Routes are relative to the engine root (default http://localhost:3001). For full request/response schemas use the live OpenAPI document.

location media

@withpotter/loyalty — module reference