@classytic/promo 0.1.0

package/dist/types/index.d.mts

@@ -0,0 +1,3 @@
+import { a as RepositoryPlugins, c as TenantConfig, i as PromoConfig, n as ModelName, o as ResolvedConfig, r as PluginType, s as ResolvedTenant, t as IndexDefinition } from "../config-iZjn_8pp.mjs";
+import { C as UpdateRuleInput, S as UpdateRewardInput, _ as GiftCardTopUpInput, a as GiftCardBalance, b as RedeemVoucherInput, c as VoucherValidation, d as CreateRewardInput, f as CreateRuleInput, g as GiftCardSpendInput, h as GenerateSingleCodeInput, i as FreeProductLine, l as CartItem, m as GenerateCodesInput, n as DiscountLine, o as PaginatedResult, p as EvaluateInput, r as EvaluationResult, s as RejectedCode, t as CommitResult, u as CreateProgramInput, v as ListQuery, x as UpdateProgramInput, y as PromoContext } from "../results-Ca5ZCNbN.mjs";
+export { type CartItem, type CommitResult, type CreateProgramInput, type CreateRewardInput, type CreateRuleInput, type DiscountLine, type EvaluateInput, type EvaluationResult, type FreeProductLine, type GenerateCodesInput, type GenerateSingleCodeInput, type GiftCardBalance, type GiftCardSpendInput, type GiftCardTopUpInput, type IndexDefinition, type ListQuery, type ModelName, type PaginatedResult, type PluginType, type PromoConfig, type PromoContext, type RedeemVoucherInput, type RejectedCode, type RepositoryPlugins, type ResolvedConfig, type ResolvedTenant, type TenantConfig, type UpdateProgramInput, type UpdateRewardInput, type UpdateRuleInput, type VoucherValidation };

package/dist/types/index.mjs

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

package/dist/unit-of-work.port-DaMW8WZK.d.mts

@@ -0,0 +1,7 @@
+//#region src/domain/ports/unit-of-work.port.d.ts
+type TransactionSession = unknown;
+interface UnitOfWork {
+  withTransaction<T>(cb: (session: TransactionSession) => Promise<T>): Promise<T>;
+}
+//#endregion
+export { UnitOfWork as n, TransactionSession as t };

package/dist/voucher.port-yxfb3MHJ.d.mts

@@ -0,0 +1,146 @@
+import { a as RewardType, c as VoucherStatus, i as ProgramType, n as DiscountScope, o as StackingMode, r as ProgramStatus, s as TriggerMode, t as DiscountMode } from "./index-J5BC20DN.mjs";
+
+//#region src/domain/entities/program.d.ts
+interface Program {
+  _id: string;
+  name: string;
+  description?: string;
+  programType: ProgramType;
+  triggerMode: TriggerMode;
+  status: ProgramStatus;
+  stackingMode: StackingMode;
+  priority: number;
+  startsAt?: Date;
+  endsAt?: Date;
+  maxUsageTotal?: number;
+  usedCount: number;
+  maxUsagePerCustomer?: number;
+  applicableCustomerIds: string[];
+  applicableCustomerTags: string[];
+  customerUsageCounts?: Record<string, number>;
+  metadata?: Record<string, unknown>;
+  createdAt: Date;
+  updatedAt: Date;
+}
+//#endregion
+//#region src/domain/entities/reward.d.ts
+interface Reward {
+  _id: string;
+  programId: string;
+  ruleId?: string;
+  rewardType: RewardType;
+  discountMode?: DiscountMode;
+  discountAmount?: number;
+  maxDiscountAmount?: number;
+  discountScope: DiscountScope;
+  applicableProductIds: string[];
+  freeProductId?: string;
+  freeProductSku?: string;
+  freeQuantity: number;
+  giftCardAmount?: number;
+  metadata?: Record<string, unknown>;
+  createdAt: Date;
+  updatedAt: Date;
+}
+//#endregion
+//#region src/domain/entities/rule.d.ts
+interface Rule {
+  _id: string;
+  programId: string;
+  name?: string;
+  minimumAmount: number;
+  minimumQuantity: number;
+  applicableProductIds: string[];
+  applicableCategories: string[];
+  applicableSkus: string[];
+  buyQuantity?: number;
+  code?: string;
+  startsAt?: Date;
+  endsAt?: Date;
+  metadata?: Record<string, unknown>;
+  createdAt: Date;
+  updatedAt: Date;
+}
+//#endregion
+//#region src/domain/entities/voucher.d.ts
+interface BalanceLedgerEntry {
+  amount: number;
+  orderId?: string;
+  description?: string;
+  createdAt: Date;
+  idempotencyKey?: string;
+}
+interface VoucherRedemption {
+  orderId: string;
+  customerId?: string;
+  discountAmount: number;
+  redeemedAt: Date;
+  idempotencyKey?: string;
+}
+interface Voucher {
+  _id: string;
+  programId: string;
+  code: string;
+  status: VoucherStatus;
+  customerId?: string;
+  usageLimit: number;
+  usedCount: number;
+  initialBalance?: number;
+  currentBalance?: number;
+  balanceLedger: BalanceLedgerEntry[];
+  expiresAt?: Date;
+  redemptions: VoucherRedemption[];
+  metadata?: Record<string, unknown>;
+  createdAt: Date;
+  updatedAt: Date;
+}
+//#endregion
+//#region src/domain/ports/program.port.d.ts
+interface ProgramPort {
+  create(data: Record<string, unknown>, session?: unknown): Promise<Program>;
+  getById(id: string, tenantId?: string): Promise<Program | null>;
+  update(id: string, data: Record<string, unknown>, tenantId?: string, session?: unknown): Promise<Program>;
+  findMany(query: Record<string, unknown>, options?: Record<string, unknown>): Promise<Program[]>;
+  findActive(tenantId?: string, now?: Date): Promise<Program[]>;
+  incrementUsage(id: string, tenantId?: string, session?: unknown): Promise<Program>;
+  decrementUsage(id: string, tenantId?: string, session?: unknown): Promise<Program>;
+  getCustomerUsage(id: string, customerId: string, tenantId?: string): Promise<number>;
+  incrementCustomerUsage(id: string, customerId: string, tenantId?: string, session?: unknown): Promise<Program>;
+}
+//#endregion
+//#region src/domain/ports/reward.port.d.ts
+interface RewardPort {
+  create(data: Record<string, unknown>, session?: unknown): Promise<Reward>;
+  getById(id: string, tenantId?: string): Promise<Reward | null>;
+  update(id: string, data: Record<string, unknown>, tenantId?: string, session?: unknown): Promise<Reward>;
+  delete(id: string, tenantId?: string, session?: unknown): Promise<void>;
+  findByProgramId(programId: string, tenantId?: string): Promise<Reward[]>;
+  findByProgramIds(programIds: string[], tenantId?: string): Promise<Reward[]>;
+}
+//#endregion
+//#region src/domain/ports/rule.port.d.ts
+interface RulePort {
+  create(data: Record<string, unknown>, session?: unknown): Promise<Rule>;
+  getById(id: string, tenantId?: string): Promise<Rule | null>;
+  update(id: string, data: Record<string, unknown>, tenantId?: string, session?: unknown): Promise<Rule>;
+  delete(id: string, tenantId?: string, session?: unknown): Promise<void>;
+  findByProgramId(programId: string, tenantId?: string): Promise<Rule[]>;
+  findByCode(code: string, tenantId?: string): Promise<Rule | null>;
+  findByProgramIds(programIds: string[], tenantId?: string): Promise<Rule[]>;
+}
+//#endregion
+//#region src/domain/ports/voucher.port.d.ts
+interface VoucherPort {
+  create(data: Record<string, unknown>, session?: unknown): Promise<Voucher>;
+  createMany(data: Record<string, unknown>[], session?: unknown): Promise<Voucher[]>;
+  getById(id: string, tenantId?: string): Promise<Voucher | null>;
+  getByCode(code: string, tenantId?: string): Promise<Voucher | null>;
+  update(id: string, data: Record<string, unknown>, tenantId?: string, session?: unknown): Promise<Voucher>;
+  findMany(query: Record<string, unknown>, options?: Record<string, unknown>): Promise<Voucher[]>;
+  incrementUsage(id: string, redemption: Record<string, unknown>, tenantId?: string, session?: unknown): Promise<Voucher>;
+  addLedgerEntry(id: string, entry: Record<string, unknown>, balanceDelta: number, tenantId?: string, session?: unknown): Promise<Voucher>;
+  expireByDate(before: Date, tenantId?: string): Promise<number>;
+  hasIdempotencyKey(id: string, key: string): Promise<boolean>;
+}
+//#endregion
+export { BalanceLedgerEntry as a, Rule as c, ProgramPort as i, Reward as l, RulePort as n, Voucher as o, RewardPort as r, VoucherRedemption as s, VoucherPort as t, Program as u };

package/package.json

@@ -0,0 +1,108 @@
+{
+  "name": "@classytic/promo",
+  "version": "0.1.0",
+  "description": "Production-grade promotion, coupon, and discount engine for MongoDB — programs, rules, rewards, vouchers, gift cards, buy-x-get-y",
+  "author": "Classytic",
+  "homepage": "https://www.npmjs.com/package/@classytic/promo",
+  "bugs": {
+    "url": "https://github.com/classytic/promo/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/classytic/promo.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"
+    }
+  },
+  "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": [
+    "promotion",
+    "coupon",
+    "discount",
+    "promo-code",
+    "gift-card",
+    "buy-x-get-y",
+    "voucher",
+    "mongodb",
+    "mongoose",
+    "commerce",
+    "ecommerce"
+  ],
+  "license": "MIT"
+}