@classytic/loyalty 0.1.0

package/dist/tier-definition-Djf72UPa.d.mts

@@ -0,0 +1,120 @@
+import { a as RuleStatus, n as MemberStatus, o as RuleType, s as TransactionType } from "./index-CaH4GhSF.mjs";
+
+//#region src/domain/entities/earning-rule.d.ts
+interface EarningConditions {
+  minOrderAmount?: number;
+  categories?: string[];
+  tiers?: string[];
+  actions?: string[];
+  dayOfWeek?: number[];
+  dateRange?: {
+    start?: Date;
+    end?: Date;
+  };
+}
+interface EarningReward {
+  pointsPerAmount?: number;
+  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/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;
+  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;
+  createdAt: Date;
+}
+//#endregion
+//#region src/domain/entities/tier-definition.d.ts
+interface TierQualification {
+  minLifetimePoints?: number;
+  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
+export { PointTransaction as a, EarningConditions as c, TierQualification as i, EarningReward as l, TierDefinition as n, Member as o, TierDowngrade as r, MemberBalance as s, TierBenefits as t, EarningRule as u };

package/dist/tier-definition.port-BzrHYBRo.d.mts

@@ -0,0 +1,143 @@
+import { i as ReferralStatus, r as RedemptionStatus } from "./index-CaH4GhSF.mjs";
+import { a as PointTransaction, n as TierDefinition, o as Member, u as EarningRule } from "./tier-definition-Djf72UPa.mjs";
+
+//#region src/domain/entities/redemption.d.ts
+interface Redemption {
+  _id: string;
+  memberId: string;
+  programId: string;
+  pointsReserved: number;
+  pointsConfirmed: number;
+  discountAmount: number;
+  conversionRate: number;
+  status: RedemptionStatus;
+  ownerType: string;
+  ownerId: string;
+  expiresAt?: Date;
+  confirmedAt?: Date;
+  releasedAt?: Date;
+  transactionId?: string;
+  createdAt: Date;
+  updatedAt: Date;
+}
+//#endregion
+//#region src/domain/entities/referral.d.ts
+interface Referral {
+  _id: string;
+  programId: string;
+  referrerId: string;
+  refereeId: string;
+  referralCode: string;
+  status: ReferralStatus;
+  referrerRewardPoints?: number;
+  refereeRewardPoints?: number;
+  referrerTransactionId?: string;
+  refereeTransactionId?: string;
+  approvedAt?: Date;
+  rejectedAt?: Date;
+  rejectionReason?: string;
+  expiresAt?: Date;
+  metadata?: Record<string, unknown>;
+  createdAt: Date;
+  updatedAt: Date;
+}
+//#endregion
+//#region src/domain/ports/unit-of-work.port.d.ts
+type TransactionSession = unknown;
+interface UnitOfWork {
+  withTransaction<T>(callback: (session: TransactionSession) => Promise<T>): Promise<T>;
+}
+//#endregion
+//#region src/domain/ports/earning-rule.port.d.ts
+interface EarningRulePort {
+  create(data: Record<string, unknown>, session?: TransactionSession): Promise<EarningRule>;
+  getById(id: string, tenantId?: string): Promise<EarningRule | null>;
+  update(id: string, data: Record<string, unknown>, tenantId?: string, session?: TransactionSession): Promise<EarningRule>;
+  findActive(tenantId?: string, programId?: string): Promise<EarningRule[]>;
+  paginate(query: Record<string, unknown>, options: {
+    page?: number;
+    limit?: number;
+    sort?: Record<string, number>;
+  }): Promise<{
+    docs: EarningRule[];
+    total: number;
+    page: number;
+    pages: number;
+  }>;
+}
+//#endregion
+//#region src/domain/ports/member.port.d.ts
+interface MemberPort {
+  create(data: Record<string, unknown>, session?: TransactionSession): Promise<Member>;
+  getById(id: string, tenantId?: string): Promise<Member | null>;
+  getByExternalId(externalId: string, externalType: string, tenantId?: string): Promise<Member | null>;
+  getByCardId(cardId: string, tenantId?: string): Promise<Member | null>;
+  getByReferralCode(code: string, tenantId?: string): Promise<Member | null>;
+  update(id: string, data: Record<string, unknown>, tenantId?: string, session?: TransactionSession): Promise<Member>;
+  updateBalance(id: string, balanceUpdate: Record<string, number>, tenantId?: string, session?: TransactionSession): Promise<Member>;
+  findMany(query: Record<string, unknown>, options?: Record<string, unknown>): Promise<Member[]>;
+}
+//#endregion
+//#region src/domain/ports/point-transaction.port.d.ts
+interface PointTransactionPort {
+  create(data: Record<string, unknown>, session?: TransactionSession): Promise<PointTransaction>;
+  getById(id: string, tenantId?: string): Promise<PointTransaction | null>;
+  getByIdempotencyKey(key: string, tenantId?: string): Promise<PointTransaction | null>;
+  update(id: string, data: Record<string, unknown>, session?: TransactionSession): Promise<PointTransaction>;
+  findMany(query: Record<string, unknown>, options?: Record<string, unknown>): Promise<PointTransaction[]>;
+  paginate(query: Record<string, unknown>, options: {
+    page?: number;
+    limit?: number;
+    sort?: Record<string, number>;
+  }): Promise<{
+    docs: PointTransaction[];
+    total: number;
+    page: number;
+    pages: number;
+  }>;
+  findExpired(now: Date, tenantId?: string, limit?: number): Promise<PointTransaction[]>;
+}
+//#endregion
+//#region src/domain/ports/redemption.port.d.ts
+interface RedemptionPort {
+  create(data: Record<string, unknown>, session?: TransactionSession): Promise<Redemption>;
+  getById(id: string, tenantId?: string): Promise<Redemption | null>;
+  getByOwner(ownerType: string, ownerId: string, tenantId?: string): Promise<Redemption | null>;
+  update(id: string, data: Record<string, unknown>, tenantId?: string, session?: TransactionSession): Promise<Redemption>;
+  /** Atomically update only if current status matches. Returns null if status already changed. */
+  atomicStatusTransition(id: string, expectedStatus: string, data: Record<string, unknown>, tenantId?: string, session?: TransactionSession): Promise<Redemption | null>;
+  findExpired(now: Date, tenantId?: string): Promise<Redemption[]>;
+}
+//#endregion
+//#region src/domain/ports/referral.port.d.ts
+interface ReferralPort {
+  create(data: Record<string, unknown>, session?: TransactionSession): Promise<Referral>;
+  getById(id: string, tenantId?: string): Promise<Referral | null>;
+  getByReferee(refereeId: string, tenantId?: string): Promise<Referral | null>;
+  update(id: string, data: Record<string, unknown>, tenantId?: string, session?: TransactionSession): Promise<Referral>;
+  /** Atomically update only if current status matches. Returns null if status already changed. */
+  atomicStatusTransition(id: string, expectedStatus: string, data: Record<string, unknown>, tenantId?: string, session?: TransactionSession): Promise<Referral | null>;
+  countByReferrerInPeriod(referrerId: string, since: Date, tenantId?: string): Promise<number>;
+  findByReferrer(referrerId: string, options: {
+    page?: number;
+    limit?: number;
+  }, tenantId?: string): Promise<{
+    docs: Referral[];
+    total: number;
+    page: number;
+    pages: number;
+  }>;
+  findExpired(now: Date, tenantId?: string): Promise<Referral[]>;
+}
+//#endregion
+//#region src/domain/ports/tier-definition.port.d.ts
+interface TierDefinitionPort {
+  create(data: Record<string, unknown>, session?: TransactionSession): Promise<TierDefinition>;
+  getById(id: string, tenantId?: string): Promise<TierDefinition | null>;
+  getByName(name: string, tenantId?: string, programId?: string): Promise<TierDefinition | null>;
+  update(id: string, data: Record<string, unknown>, tenantId?: string, session?: TransactionSession): Promise<TierDefinition>;
+  delete(id: string, tenantId?: string): Promise<void>;
+  findAll(tenantId?: string, programId?: string): Promise<TierDefinition[]>;
+}
+//#endregion
+export { MemberPort as a, UnitOfWork as c, PointTransactionPort as i, Referral as l, ReferralPort as n, EarningRulePort as o, RedemptionPort as r, TransactionSession as s, TierDefinitionPort as t, Redemption as u };

package/dist/types/index.d.mts

@@ -0,0 +1,3 @@
+import { a as RepositoryPlugins, c as TenantConfig, i as PluginType, n as LoyaltyConfig, o as ResolvedConfig, r as ModelName, s as ResolvedTenant, t as IndexDefinition } from "../config-aNigy4ec.mjs";
+import { _ as TierEvaluationBatch, a as EnrollInput, c as UpdateTierInput, d as EarningResult, f as ExpirationResult, g as TierEvaluation, h as RedemptionValidation, i as EarnPointsInput, l as BalanceSummary, m as PaginatedResult, n as CreateEarningRuleInput, o as LoyaltyContext, p as ListQuery, r as CreateTierInput, s as UpdateEarningRuleInput, t as AdjustPointsInput, u as EarningBreakdown } from "../index-DqzTjeEB.mjs";
+export { AdjustPointsInput, BalanceSummary, CreateEarningRuleInput, CreateTierInput, EarnPointsInput, EarningBreakdown, EarningResult, EnrollInput, ExpirationResult, IndexDefinition, ListQuery, LoyaltyConfig, LoyaltyContext, ModelName, PaginatedResult, PluginType, RedemptionValidation, RepositoryPlugins, ResolvedConfig, ResolvedTenant, TenantConfig, TierEvaluation, TierEvaluationBatch, UpdateEarningRuleInput, UpdateTierInput };

package/dist/types/index.mjs

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -0,0 +1,111 @@
+{
+  "name": "@classytic/loyalty",
+  "version": "0.1.0",
+  "description": "Loyalty points, tiers, earning rules, referrals, and redemption engine for MongoDB",
+  "author": "Classytic",
+  "homepage": "https://www.npmjs.com/package/@classytic/loyalty",
+  "bugs": {
+    "url": "https://github.com/classytic/loyalty/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/classytic/loyalty.git"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "type": "module",
+  "sideEffects": false,
+  "engines": {
+    "node": ">=22"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.mts",
+      "default": "./dist/index.mjs"
+    },
+    "./domain": {
+      "types": "./dist/domain/index.d.mts",
+      "default": "./dist/domain/index.mjs"
+    },
+    "./domain/enums": {
+      "types": "./dist/domain/enums/index.d.mts",
+      "default": "./dist/domain/enums/index.mjs"
+    },
+    "./models": {
+      "types": "./dist/models/index.d.mts",
+      "default": "./dist/models/index.mjs"
+    },
+    "./repositories": {
+      "types": "./dist/repositories/index.d.mts",
+      "default": "./dist/repositories/index.mjs"
+    },
+    "./services": {
+      "types": "./dist/services/index.d.mts",
+      "default": "./dist/services/index.mjs"
+    },
+    "./events": {
+      "types": "./dist/events/index.d.mts",
+      "default": "./dist/events/index.mjs"
+    },
+    "./types": {
+      "types": "./dist/types/index.d.mts",
+      "default": "./dist/types/index.mjs"
+    },
+    "./notifications": {
+      "types": "./dist/notifications/index.d.mts",
+      "default": "./dist/notifications/index.mjs"
+    }
+  },
+  "main": "./dist/index.mjs",
+  "types": "./dist/index.d.mts",
+  "files": [
+    "dist",
+    "README.md",
+    "CHANGELOG.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "tsdown",
+    "dev": "tsdown --watch",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage",
+    "typecheck": "tsc --noEmit",
+    "lint": "biome check src/ tests/",
+    "lint:fix": "biome check --write src/ tests/",
+    "format": "biome format --write src/ tests/",
+    "check": "biome check --write --unsafe src/ tests/",
+    "prepublishOnly": "npm run lint && npm run typecheck && npm run test && npm run build",
+    "release": "npm run build && npm run typecheck && npm publish --access public"
+  },
+  "peerDependencies": {
+    "@classytic/mongokit": ">=3.5.3",
+    "mongoose": ">=9.0.0"
+  },
+  "devDependencies": {
+    "@biomejs/biome": "^2.4.9",
+    "@classytic/mongokit": ">=3.5.3",
+    "@types/node": "^25.5.0",
+    "@vitest/coverage-v8": "^3.2.4",
+    "knip": "^6.3.0",
+    "mongodb-memory-server": "^10.2.3",
+    "mongoose": "^9.3.3",
+    "tsdown": "^0.21.5",
+    "typescript": "^5.7.0",
+    "vitest": "^3.0.0"
+  },
+  "keywords": [
+    "loyalty",
+    "points",
+    "rewards",
+    "tiers",
+    "referral",
+    "membership",
+    "earning-rules",
+    "redemption",
+    "mongodb",
+    "mongoose"
+  ],
+  "license": "MIT"
+}