@classytic/promo 0.1.0

package/dist/index-l09KqnlE.d.mts

@@ -0,0 +1,81 @@
+import { c as Rule, i as ProgramPort, l as Reward, n as RulePort, o as Voucher, r as RewardPort, t as VoucherPort, u as Program } from "./voucher.port-yxfb3MHJ.mjs";
+import { t as PromoModels } from "./index-B7lLH19a.mjs";
+import { Model } from "mongoose";
+import { PluginType } from "@classytic/mongokit";
+
+//#region src/repositories/program.repository.d.ts
+declare class ProgramRepository implements ProgramPort {
+  private repo;
+  private tenantField;
+  constructor(model: Model<any>, plugins?: PluginType[], tenantField?: string);
+  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/repositories/reward.repository.d.ts
+declare class RewardRepository implements RewardPort {
+  private repo;
+  private tenantField;
+  constructor(model: Model<any>, plugins?: PluginType[], tenantField?: string);
+  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/repositories/rule.repository.d.ts
+declare class RuleRepository implements RulePort {
+  private repo;
+  private tenantField;
+  constructor(model: Model<any>, plugins?: PluginType[], tenantField?: string);
+  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/repositories/voucher.repository.d.ts
+declare class VoucherRepository implements VoucherPort {
+  private repo;
+  private tenantField;
+  constructor(model: Model<any>, plugins?: PluginType[], tenantField?: string);
+  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
+//#region src/repositories/index.d.ts
+interface PromoRepositories {
+  program: ProgramRepository;
+  rule: RuleRepository;
+  reward: RewardRepository;
+  voucher: VoucherRepository;
+}
+interface RepositoryPluginsMap {
+  program?: PluginType[];
+  rule?: PluginType[];
+  reward?: PluginType[];
+  voucher?: PluginType[];
+}
+declare function createRepositories(models: PromoModels, plugins?: RepositoryPluginsMap, tenantField?: string): PromoRepositories;
+//#endregion
+export { RuleRepository as a, VoucherRepository as i, RepositoryPluginsMap as n, RewardRepository as o, createRepositories as r, ProgramRepository as s, PromoRepositories as t };

package/dist/index.d.mts

@@ -0,0 +1,20 @@
+import { a as BalanceLedgerEntry, c as Rule, l as Reward, o as Voucher, s as VoucherRedemption, u as Program } from "./voucher.port-yxfb3MHJ.mjs";
+import { t as EventEmitterPort } from "./event-emitter.port-DaodlJSG.mjs";
+import { o as PromoEvents } from "./index-C52zSBkI.mjs";
+import { i as PromoConfig, o as ResolvedConfig, s as ResolvedTenant } from "./config-iZjn_8pp.mjs";
+import { t as PromoModels } from "./index-B7lLH19a.mjs";
+import { t as PromoRepositories } from "./index-l09KqnlE.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";
+import { i as FullProgram, t as PromoServices } from "./index-Cu9iwy4v.mjs";
+
+//#region src/index.d.ts
+declare function resolveConfig(config: PromoConfig): ResolvedConfig;
+interface PromoEngine {
+  models: PromoModels;
+  repositories: PromoRepositories;
+  services: PromoServices;
+  events: EventEmitterPort;
+}
+declare function createPromoEngine(config: PromoConfig): PromoEngine;
+//#endregion
+export { type BalanceLedgerEntry, type CartItem, type CommitResult, type CreateProgramInput, type CreateRewardInput, type CreateRuleInput, type DiscountLine, type EvaluateInput, type EvaluationResult, type EventEmitterPort, type FreeProductLine, type FullProgram, type GenerateCodesInput, type GenerateSingleCodeInput, type GiftCardBalance, type GiftCardSpendInput, type GiftCardTopUpInput, type ListQuery, type PaginatedResult, type Program, type PromoConfig, type PromoContext, PromoEngine, PromoEvents, type PromoModels, type PromoRepositories, type PromoServices, type RedeemVoucherInput, type RejectedCode, type ResolvedConfig, type ResolvedTenant, type Reward, type Rule, type UpdateProgramInput, type UpdateRewardInput, type UpdateRuleInput, type Voucher, type VoucherRedemption, type VoucherValidation, createPromoEngine, resolveConfig };

package/dist/index.mjs

@@ -0,0 +1,86 @@
+import { n as DEFAULT_TENANT_TYPE, t as DEFAULT_TENANT_FIELD } from "./constants-BVajdyL3.mjs";
+import { l as ValidationError } from "./domain-errors-BEkXvy5O.mjs";
+import { t as InProcessEventBus } from "./events-CprEWlN7.mjs";
+import { t as createModels } from "./models-DdBNae7h.mjs";
+import { t as createRepositories } from "./repositories-DgZIY9wD.mjs";
+import { t as PromoEvents } from "./event-types-CsTV1FKX.mjs";
+import { t as createServices } from "./services-Cz0gHrmX.mjs";
+//#region src/index.ts
+function resolveConfig(config) {
+	let tenant;
+	if (config.tenant === false) tenant = {
+		enabled: false,
+		field: "",
+		type: "ObjectId",
+		contextKey: ""
+	};
+	else if (config.tenant === void 0) tenant = {
+		enabled: true,
+		field: DEFAULT_TENANT_FIELD,
+		type: DEFAULT_TENANT_TYPE,
+		contextKey: DEFAULT_TENANT_FIELD
+	};
+	else tenant = {
+		enabled: true,
+		field: config.tenant.field ?? "organizationId",
+		type: config.tenant.type ?? "ObjectId",
+		contextKey: config.tenant.contextKey ?? config.tenant.field ?? "organizationId",
+		...config.tenant.ref ? { ref: config.tenant.ref } : {}
+	};
+	const resolved = {
+		evaluation: {
+			maxStackablePromotions: config.evaluation?.maxStackablePromotions ?? 5,
+			allowExclusiveAndStackable: config.evaluation?.allowExclusiveAndStackable ?? true
+		},
+		voucher: {
+			codeLength: config.voucher?.codeLength ?? 8,
+			codePrefix: config.voucher?.codePrefix ?? "",
+			defaultExpiryDays: config.voucher?.defaultExpiryDays ?? null
+		},
+		giftCard: {
+			allowNegativeBalance: config.giftCard?.allowNegativeBalance ?? false,
+			maxBalance: config.giftCard?.maxBalance ?? null
+		},
+		tenant
+	};
+	if (resolved.voucher.codeLength < 4) throw new ValidationError("voucher codeLength must be >= 4");
+	if (resolved.evaluation.maxStackablePromotions < 1) throw new ValidationError("maxStackablePromotions must be >= 1");
+	return resolved;
+}
+var MongoUnitOfWork = class {
+	constructor(connection) {
+		this.connection = connection;
+	}
+	async withTransaction(cb) {
+		const session = await this.connection.startSession();
+		try {
+			let result;
+			await session.withTransaction(async () => {
+				result = await cb(session);
+			});
+			return result;
+		} finally {
+			await session.endSession();
+		}
+	}
+};
+function createPromoEngine(config) {
+	const resolvedConfig = resolveConfig(config);
+	const models = createModels(config.mongoose, resolvedConfig.tenant, config.indexes);
+	const repositories = createRepositories(models, config.plugins, resolvedConfig.tenant.field);
+	const unitOfWork = new MongoUnitOfWork(config.mongoose);
+	const events = config.events?.adapter ?? new InProcessEventBus();
+	return {
+		models,
+		repositories,
+		services: createServices({
+			repositories,
+			unitOfWork,
+			events,
+			config: resolvedConfig
+		}),
+		events
+	};
+}
+//#endregion
+export { PromoEvents, createPromoEngine, resolveConfig };

package/dist/models/index.d.mts

@@ -0,0 +1,2 @@
+import { n as createModels, t as PromoModels } from "../index-B7lLH19a.mjs";
+export { PromoModels, createModels };

package/dist/models/index.mjs

@@ -0,0 +1,2 @@
+import { t as createModels } from "../models-DdBNae7h.mjs";
+export { createModels };

package/dist/models-DdBNae7h.mjs

@@ -0,0 +1,277 @@
+import { a as PROGRAM_STATUSES, c as REWARD_TYPES, d as VOUCHER_STATUSES, i as DISCOUNT_SCOPES, l as STACKING_MODES, r as DISCOUNT_MODES, s as PROGRAM_TYPES, u as TRIGGER_MODES } from "./constants-BVajdyL3.mjs";
+import mongoose from "mongoose";
+//#region src/models/create-model.ts
+function injectTenantField(schema, tenant) {
+	if (!tenant.enabled) return;
+	schema.add({ [tenant.field]: {
+		type: tenant.type === "ObjectId" ? mongoose.Schema.Types.ObjectId : String,
+		required: true,
+		index: true,
+		...tenant.ref ? { ref: tenant.ref } : {}
+	} });
+	const existingIndexes = schema._indexes;
+	if (existingIndexes && existingIndexes.length > 0) for (const indexEntry of existingIndexes) {
+		const fields = indexEntry[0];
+		const newFields = { [tenant.field]: 1 };
+		for (const [key, val] of Object.entries(fields)) newFields[key] = val;
+		indexEntry[0] = newFields;
+	}
+}
+function applyUserIndexes(schema, indexes, tenant) {
+	for (const def of indexes) {
+		const fields = tenant.enabled ? {
+			[tenant.field]: 1,
+			...def.fields
+		} : { ...def.fields };
+		schema.index(fields, def.options ?? {});
+	}
+}
+//#endregion
+//#region src/models/schemas/program.schema.ts
+const { Schema: Schema$3 } = mongoose;
+function createProgramSchema() {
+	const schema = new Schema$3({
+		name: {
+			type: String,
+			required: true
+		},
+		description: { type: String },
+		programType: {
+			type: String,
+			enum: PROGRAM_TYPES,
+			required: true
+		},
+		triggerMode: {
+			type: String,
+			enum: TRIGGER_MODES,
+			required: true
+		},
+		status: {
+			type: String,
+			enum: PROGRAM_STATUSES,
+			default: "draft"
+		},
+		stackingMode: {
+			type: String,
+			enum: STACKING_MODES,
+			default: "exclusive"
+		},
+		priority: {
+			type: Number,
+			default: 0
+		},
+		startsAt: { type: Date },
+		endsAt: { type: Date },
+		maxUsageTotal: { type: Number },
+		usedCount: {
+			type: Number,
+			default: 0
+		},
+		maxUsagePerCustomer: { type: Number },
+		applicableCustomerIds: [{ type: String }],
+		applicableCustomerTags: [{ type: String }],
+		customerUsageCounts: {
+			type: Map,
+			of: Number,
+			default: () => /* @__PURE__ */ new Map()
+		},
+		metadata: { type: Schema$3.Types.Mixed }
+	}, { timestamps: true });
+	schema.index({
+		status: 1,
+		programType: 1,
+		priority: -1
+	});
+	schema.index({
+		status: 1,
+		startsAt: 1,
+		endsAt: 1
+	});
+	schema.index({
+		status: 1,
+		priority: -1,
+		_id: -1
+	});
+	return schema;
+}
+//#endregion
+//#region src/models/schemas/reward.schema.ts
+const { Schema: Schema$2 } = mongoose;
+function createRewardSchema() {
+	const schema = new Schema$2({
+		programId: {
+			type: Schema$2.Types.ObjectId,
+			required: true
+		},
+		ruleId: { type: Schema$2.Types.ObjectId },
+		rewardType: {
+			type: String,
+			enum: REWARD_TYPES,
+			required: true
+		},
+		discountMode: {
+			type: String,
+			enum: DISCOUNT_MODES
+		},
+		discountAmount: { type: Number },
+		maxDiscountAmount: { type: Number },
+		discountScope: {
+			type: String,
+			enum: DISCOUNT_SCOPES,
+			default: "order"
+		},
+		applicableProductIds: [{ type: String }],
+		freeProductId: { type: String },
+		freeProductSku: { type: String },
+		freeQuantity: {
+			type: Number,
+			default: 1
+		},
+		giftCardAmount: { type: Number },
+		metadata: { type: Schema$2.Types.Mixed }
+	}, { timestamps: true });
+	schema.index({ programId: 1 });
+	schema.index({ ruleId: 1 }, { sparse: true });
+	return schema;
+}
+//#endregion
+//#region src/models/schemas/rule.schema.ts
+const { Schema: Schema$1 } = mongoose;
+function createRuleSchema() {
+	const schema = new Schema$1({
+		programId: {
+			type: Schema$1.Types.ObjectId,
+			required: true
+		},
+		name: { type: String },
+		minimumAmount: {
+			type: Number,
+			default: 0
+		},
+		minimumQuantity: {
+			type: Number,
+			default: 0
+		},
+		applicableProductIds: [{ type: String }],
+		applicableCategories: [{ type: String }],
+		applicableSkus: [{ type: String }],
+		buyQuantity: { type: Number },
+		code: {
+			type: String,
+			uppercase: true,
+			trim: true
+		},
+		startsAt: { type: Date },
+		endsAt: { type: Date },
+		metadata: { type: Schema$1.Types.Mixed }
+	}, { timestamps: true });
+	schema.index({ programId: 1 });
+	schema.index({ code: 1 }, { sparse: true });
+	return schema;
+}
+//#endregion
+//#region src/models/schemas/voucher.schema.ts
+const { Schema } = mongoose;
+function createVoucherSchema() {
+	const schema = new Schema({
+		programId: {
+			type: Schema.Types.ObjectId,
+			required: true,
+			index: true
+		},
+		code: {
+			type: String,
+			required: true,
+			uppercase: true,
+			trim: true
+		},
+		status: {
+			type: String,
+			enum: VOUCHER_STATUSES,
+			default: "active"
+		},
+		customerId: { type: String },
+		usageLimit: {
+			type: Number,
+			default: 1
+		},
+		usedCount: {
+			type: Number,
+			default: 0
+		},
+		initialBalance: { type: Number },
+		currentBalance: { type: Number },
+		balanceLedger: [{
+			amount: {
+				type: Number,
+				required: true
+			},
+			orderId: { type: String },
+			description: { type: String },
+			createdAt: {
+				type: Date,
+				default: Date.now
+			},
+			idempotencyKey: { type: String }
+		}],
+		expiresAt: { type: Date },
+		redemptions: [{
+			orderId: {
+				type: String,
+				required: true
+			},
+			customerId: { type: String },
+			discountAmount: {
+				type: Number,
+				required: true
+			},
+			redeemedAt: {
+				type: Date,
+				default: Date.now
+			},
+			idempotencyKey: { type: String }
+		}],
+		metadata: { type: Schema.Types.Mixed }
+	}, { timestamps: true });
+	schema.index({ code: 1 }, { unique: true });
+	schema.index({
+		programId: 1,
+		status: 1
+	});
+	schema.index({
+		customerId: 1,
+		status: 1
+	}, { sparse: true });
+	schema.index({ expiresAt: 1 }, { sparse: true });
+	return schema;
+}
+//#endregion
+//#region src/models/index.ts
+function createModels(connection, tenant, indexes) {
+	if (connection.models.PromoProgram && connection.models.PromoRule && connection.models.PromoReward && connection.models.PromoVoucher) return {
+		Program: connection.models.PromoProgram,
+		Rule: connection.models.PromoRule,
+		Reward: connection.models.PromoReward,
+		Voucher: connection.models.PromoVoucher
+	};
+	const programSchema = createProgramSchema();
+	const ruleSchema = createRuleSchema();
+	const rewardSchema = createRewardSchema();
+	const voucherSchema = createVoucherSchema();
+	injectTenantField(programSchema, tenant);
+	injectTenantField(ruleSchema, tenant);
+	injectTenantField(rewardSchema, tenant);
+	injectTenantField(voucherSchema, tenant);
+	if (indexes?.program) applyUserIndexes(programSchema, indexes.program, tenant);
+	if (indexes?.rule) applyUserIndexes(ruleSchema, indexes.rule, tenant);
+	if (indexes?.reward) applyUserIndexes(rewardSchema, indexes.reward, tenant);
+	if (indexes?.voucher) applyUserIndexes(voucherSchema, indexes.voucher, tenant);
+	return {
+		Program: connection.models.PromoProgram ?? connection.model("PromoProgram", programSchema),
+		Rule: connection.models.PromoRule ?? connection.model("PromoRule", ruleSchema),
+		Reward: connection.models.PromoReward ?? connection.model("PromoReward", rewardSchema),
+		Voucher: connection.models.PromoVoucher ?? connection.model("PromoVoucher", voucherSchema)
+	};
+}
+//#endregion
+export { createModels as t };

package/dist/repositories/index.d.mts

@@ -0,0 +1,2 @@
+import { a as RuleRepository, i as VoucherRepository, n as RepositoryPluginsMap, o as RewardRepository, r as createRepositories, s as ProgramRepository, t as PromoRepositories } from "../index-l09KqnlE.mjs";
+export { ProgramRepository, PromoRepositories, RepositoryPluginsMap, RewardRepository, RuleRepository, VoucherRepository, createRepositories };

package/dist/repositories/index.mjs

@@ -0,0 +1,2 @@
+import { a as ProgramRepository, i as RewardRepository, n as VoucherRepository, r as RuleRepository, t as createRepositories } from "../repositories-DgZIY9wD.mjs";
+export { ProgramRepository, RewardRepository, RuleRepository, VoucherRepository, createRepositories };