@classytic/loyalty 0.6.0 → 0.10.0

package/dist/index-Cp_sXNpG.d.mts

@@ -1,349 +0,0 @@
-import { a as RuleStatus, n as MemberStatus, o as RuleType, s as TransactionType } from "./index-D_Oe3aDk.mjs";
-import "./config-CtkGj3xZ.mjs";
-import { OperationContext } from "@classytic/primitives/context";
-import { ApprovalChain } from "@classytic/primitives/approval";
-//#region src/domain/entities/earning-rule.d.ts
-interface EarningConditions {
-  /**
-   * Minimum order total for the rule to apply — **integer minor units** of the
-   * host's ambient currency (paisa for BDT). `10000` = ৳100. Compared against
-   * `evaluateOrder`'s `orderTotal` (also minor units).
-   */
-  minOrderAmount?: number;
-  categories?: string[];
-  tiers?: string[];
-  actions?: string[];
-  /**
-   * Days the rule applies, JS `getDay()` convention: 0=Sun … 6=Sat. Empty /
-   * omitted = every day. Evaluated against the wall-clock weekday in the
-   * engine's configured `timezone` (UTC when unset), never the server's local
-   * clock. See `LoyaltyShape.timezone`.
-   */
-  dayOfWeek?: number[];
-  dateRange?: {
-    start?: Date;
-    end?: Date;
-  };
-}
-interface EarningReward {
-  /**
-   * Points awarded per `rateBasis` minor units of spend:
-   * `points = pointsPerAmount × (orderTotalMinor / rateBasis)` (rounded once
-   * per `roundingMode`). REQUIRES `rateBasis` — there is no implicit
-   * "per 1 major unit" basis anymore (that ambiguity was the bug).
-   * "5 points per ৳100" = `{ pointsPerAmount: 5, rateBasis: 10000 }`.
-   */
-  pointsPerAmount?: number;
-  /**
-   * RATE: the explicit integer minor-unit basis `pointsPerAmount` is quoted
-   * against (≥ 1). Required whenever `pointsPerAmount` is set.
-   */
-  rateBasis?: number;
-  /**
-   * RATE: integer minor units of spend per single point (≥ 1).
-   * `points = orderTotalMinor / amountPerPoint` (rounded per `roundingMode`).
-   * "1 point per ৳100" = `amountPerPoint: 10000`.
-   */
-  amountPerPoint?: number;
-  fixedPoints?: number;
-  multiplier?: number;
-  roundingMode?: 'floor' | 'round' | 'ceil';
-  maxPointsPerTransaction?: number;
-}
-interface EarningRule {
-  _id: string;
-  programId: string;
-  name: string;
-  description?: string;
-  type: RuleType;
-  status: RuleStatus;
-  priority: number;
-  conditions: EarningConditions;
-  reward: EarningReward;
-  startsAt?: Date;
-  endsAt?: Date;
-  metadata?: Record<string, unknown>;
-  createdAt: Date;
-  updatedAt: Date;
-}
-//#endregion
-//#region src/domain/entities/tier-definition.d.ts
-interface TierQualification {
-  minLifetimePoints?: number;
-  /**
-   * Minimum lifetime spend — **integer minor units** (paisa for BDT).
-   * Declared for host-side qualification logic only: the in-package tier
-   * evaluation checks lifetime POINTS exclusively and never reads this field.
-   */
-  minLifetimeSpend?: number;
-  evaluationPeriodDays?: number;
-}
-interface TierBenefits {
-  pointsMultiplier?: number;
-  discountPercent?: number;
-  freeShipping?: boolean;
-  customBenefits?: Record<string, unknown>;
-}
-interface TierDowngrade {
-  enabled: boolean;
-  gracePeriodDays: number;
-}
-interface TierDefinition {
-  _id: string;
-  programId: string;
-  name: string;
-  rank: number;
-  qualificationCriteria: TierQualification;
-  benefits: TierBenefits;
-  downgrade: TierDowngrade;
-  color?: string;
-  metadata?: Record<string, unknown>;
-  createdAt: Date;
-  updatedAt: Date;
-}
-//#endregion
-//#region src/domain/entities/member.d.ts
-interface MemberBalance {
-  current: number;
-  lifetime: number;
-  redeemed: number;
-  expired: number;
-}
-interface Member {
-  _id: string;
-  programId: string;
-  externalId: string;
-  externalType: string;
-  status: MemberStatus;
-  /** Public loyalty card identifier (e.g., MBR-DHK-00004821-8). Set by the integration layer. */
-  cardId?: string;
-  /** Referral code for the referral system (separate from cardId). Auto-generated on enrollment. */
-  referralCode: string;
-  tier: string | null;
-  tierOverride: string | null;
-  tierOverrideReason?: string;
-  /**
-   * Optional TTL on a manual tier override. When set, `evaluateMember`
-   * treats the override as already cleared once `tierOverrideExpiresAt <=
-   * now`, and a host-scheduled `sweepExpiredOverrides` cron clears the
-   * field + emits a `TIER_OVERRIDE_EXPIRED` audit event.
-   */
-  tierOverrideExpiresAt?: Date;
-  /** Optional upstream referrer for multi-tier referral chains. */
-  referredBy?: string;
-  tierQualifiedAt?: Date;
-  tierExpiresAt?: Date;
-  balance: MemberBalance;
-  enrolledAt: Date;
-  deactivatedAt?: Date;
-  metadata?: Record<string, unknown>;
-  createdAt: Date;
-  updatedAt: Date;
-}
-//#endregion
-//#region src/domain/entities/point-transaction.d.ts
-interface PointTransaction {
-  _id: string;
-  memberId: string;
-  programId: string;
-  type: TransactionType;
-  points: number;
-  balanceAfter: number;
-  description: string;
-  referenceType?: string;
-  referenceId?: string;
-  idempotencyKey?: string;
-  earningRuleId?: string;
-  expiresAt?: Date;
-  expiredAt?: Date;
-  metadata?: Record<string, unknown>;
-  actorId: string;
-  /**
-   * Optional multi-step approval chain (P7 canonical — same shape as
-   * `@classytic/purchase` / `@classytic/order`). Manual `adjustment` /
-   * `bonus` transactions above a host-defined threshold gate on
-   * `isApproved(approvals)` before the journal entry is committed.
-   * Automatic transactions (earn from purchase, expiry sweeps) skip the
-   * chain entirely — single-tier flows leave this null.
-   */
-  approvals?: ApprovalChain | null;
-  /** Snapshot of the matrix policy id that produced this chain (host-managed). */
-  approvalPolicyId?: string | null;
-  /** Version of the matrix policy at submit time — frozen for audit. */
-  approvalPolicyVersion?: number | null;
-  createdAt: Date;
-}
-//#endregion
-//#region src/types/results.d.ts
-interface BalanceSummary extends MemberBalance {
-  tier: string | null;
-  tierOverride: string | null;
-}
-interface EarningBreakdown {
-  ruleId: string;
-  ruleName: string;
-  points: number;
-}
-interface EarningResult {
-  totalPoints: number;
-  breakdown: EarningBreakdown[];
-  transactions: PointTransaction[];
-}
-interface TierEvaluation {
-  memberId: string;
-  previousTier: string | null;
-  newTier: string | null;
-  action: 'upgraded' | 'downgraded' | 'grace_period' | 'unchanged';
-  graceExpiresAt?: Date;
-}
-interface TierEvaluationBatch {
-  upgraded: number;
-  downgraded: number;
-  unchanged: number;
-}
-interface RedemptionValidation {
-  valid: boolean;
-  error?: string;
-  pointsToRedeem: number;
-  /**
-   * Discount in **integer minor units** (paisa for BDT) — always exactly
-   * `pointsToRedeem × pointValueMinor`.
-   */
-  discountAmount: number;
-  maxAllowedPoints: number;
-}
-interface ExpirationResult {
-  membersAffected: number;
-  pointsExpired: number;
-  transactionCount: number;
-}
-interface PaginatedResult<T> {
-  docs: T[];
-  total: number;
-  page: number;
-  pages: number;
-  hasNext: boolean;
-  hasPrev: boolean;
-}
-interface ListQuery {
-  page?: number;
-  limit?: number;
-  sort?: Record<string, 1 | -1>;
-}
-//#endregion
-//#region src/types/index.d.ts
-/**
- * Context passed to every loyalty operation.
- *
- * The tenant key is dynamic — if you configured `tenant: { field: 'companyId', contextKey: 'companyId' }`,
- * pass `{ companyId: '...' }` in the context. The `[key: string]: unknown` index allows this.
- *
- * For the default config (`tenant: true` or `tenant: undefined`), pass `organizationId`.
- * For `tenant: false`, the tenant key is ignored.
- */
-/**
- * Extends `@classytic/primitives`' {@link OperationContext} with loyalty-
- * specific fields. `actorId` is narrowed to a required `string` since every
- * loyalty mutation is attributed; other primitives fields (`correlationId`,
- * `traceId`, `requestId`, `session`, `metadata`) flow through unchanged.
- */
-interface LoyaltyContext extends OperationContext {
-  /** Required for loyalty: who is performing this operation. Narrowed to string. */
-  actorId: string;
-  /** Narrowed from primitives' `IdLike` to string. */
-  organizationId?: string;
-  /** Override program ID for multi-program setups. */
-  programId?: string;
-  /**
-   * Cooperative cancellation for long-running cron loops (point expiry,
-   * reservation cleanup, tier evaluation, override sweeps, campaign award).
-   * Checked at each loop boundary via `throwIfAborted` — aborting between
-   * iterations never rolls back an already-committed transaction, and each
-   * per-item write is its own unit of work. Threaded to mongokit round-trips
-   * by hosts that pass it; mongokit (3.16+) honours it at every op boundary.
-   */
-  signal?: AbortSignal | undefined;
-  /** Dynamic tenant key support — e.g. `{ companyId: '...' }` — when a host
-   *  configured a custom `contextKey`. */
-  [key: string]: unknown;
-}
-interface EnrollInput {
-  externalId: string;
-  externalType: string;
-  programId?: string;
-  tier?: string;
-  cardId?: string;
-  metadata?: Record<string, unknown>;
-}
-interface EarnPointsInput {
-  memberId: string;
-  points: number;
-  description: string;
-  referenceType?: string;
-  referenceId?: string;
-  earningRuleId?: string;
-  expiresAt?: Date;
-  idempotencyKey?: string;
-  metadata?: Record<string, unknown>;
-}
-interface AdjustPointsInput {
-  memberId: string;
-  points: number;
-  description: string;
-  reason: string;
-  referenceType?: string;
-  referenceId?: string;
-  idempotencyKey?: string;
-  metadata?: Record<string, unknown>;
-}
-interface CreateEarningRuleInput {
-  name: string;
-  type: 'order' | 'action' | 'category' | 'tier_bonus';
-  priority?: number;
-  description?: string;
-  conditions?: EarningConditions;
-  reward: EarningReward;
-  startsAt?: Date | string;
-  endsAt?: Date | string;
-  /**
-   * Loyalty program this rule belongs to.
-   *
-   * Optional for repository-created rules: `EarningRuleRepository.create(...)`
-   * and `createMany(...)` fill this from `LoyaltyShape.program.id`, matching
-   * the default used by `MemberRepository.enroll(...)`. Pass explicitly only
-   * when creating a rule for a different program.
-   */
-  programId?: string;
-  metadata?: Record<string, unknown>;
-}
-interface UpdateEarningRuleInput {
-  name?: string;
-  priority?: number;
-  description?: string;
-  conditions?: EarningConditions;
-  reward?: EarningReward;
-  startsAt?: Date | string;
-  endsAt?: Date | string;
-  metadata?: Record<string, unknown>;
-}
-interface CreateTierInput {
-  name: string;
-  rank: number;
-  qualificationCriteria?: TierQualification;
-  benefits?: TierBenefits;
-  downgrade?: TierDowngrade;
-  color?: string;
-  programId?: string;
-  metadata?: Record<string, unknown>;
-}
-interface UpdateTierInput {
-  name?: string;
-  rank?: number;
-  qualificationCriteria?: TierQualification;
-  benefits?: TierBenefits;
-  downgrade?: TierDowngrade;
-  color?: string;
-  metadata?: Record<string, unknown>;
-}
-//#endregion
-export { EarningRule as S, TierEvaluationBatch as _, EnrollInput as a, MemberBalance as b, UpdateTierInput as c, EarningResult as d, ExpirationResult as f, TierEvaluation as g, RedemptionValidation as h, EarnPointsInput as i, BalanceSummary as l, PaginatedResult as m, CreateEarningRuleInput as n, LoyaltyContext as o, ListQuery as p, CreateTierInput as r, UpdateEarningRuleInput as s, AdjustPointsInput as t, EarningBreakdown as u, PointTransaction as v, TierDefinition as x, Member as y };

package/dist/index-D_Oe3aDk.d.mts

@@ -1,19 +0,0 @@
-//#region src/constants.d.ts
-declare const TRANSACTION_TYPES: readonly ["earn", "redeem", "adjust", "expire", "transfer", "referral_bonus"];
-declare const MEMBER_STATUSES: readonly ["active", "inactive", "suspended"];
-declare const RULE_TYPES: readonly ["order", "action", "category", "tier_bonus"];
-declare const RULE_STATUSES: readonly ["active", "paused", "expired"];
-declare const REFERRAL_STATUSES: readonly ["pending", "approved", "rejected", "expired"];
-declare const REDEMPTION_STATUSES: readonly ["reserved", "confirmed", "released", "expired", "reversed"];
-declare const EARNING_ACTIONS: readonly ["signup", "referral", "birthday", "review", "profile_complete"];
-//#endregion
-//#region src/domain/enums/index.d.ts
-type TransactionType = (typeof TRANSACTION_TYPES)[number];
-type MemberStatus = (typeof MEMBER_STATUSES)[number];
-type RuleType = (typeof RULE_TYPES)[number];
-type RuleStatus = (typeof RULE_STATUSES)[number];
-type ReferralStatus = (typeof REFERRAL_STATUSES)[number];
-type RedemptionStatus = (typeof REDEMPTION_STATUSES)[number];
-type EarningAction = (typeof EARNING_ACTIONS)[number];
-//#endregion
-export { RuleStatus as a, EARNING_ACTIONS as c, REFERRAL_STATUSES as d, RULE_STATUSES as f, ReferralStatus as i, MEMBER_STATUSES as l, TRANSACTION_TYPES as m, MemberStatus as n, RuleType as o, RULE_TYPES as p, RedemptionStatus as r, TransactionType as s, EarningAction as t, REDEMPTION_STATUSES as u };