@classytic/promo 0.2.5 → 0.4.0

package/dist/promo-event-catalog-Dyh0xQ6w.mjs

@@ -0,0 +1,250 @@
+import { createEvent } from "@classytic/primitives/events";
+import { z } from "zod";
+//#region src/events/event-constants.ts
+const PromoEvents = {
+	PROGRAM_CREATED: "promo.program.created",
+	PROGRAM_ACTIVATED: "promo.program.activated",
+	PROGRAM_PAUSED: "promo.program.paused",
+	PROGRAM_ARCHIVED: "promo.program.archived",
+	RULE_ADDED: "promo.rule.added",
+	RULE_UPDATED: "promo.rule.updated",
+	RULE_REMOVED: "promo.rule.removed",
+	REWARD_ADDED: "promo.reward.added",
+	REWARD_UPDATED: "promo.reward.updated",
+	REWARD_REMOVED: "promo.reward.removed",
+	VOUCHER_GENERATED: "promo.voucher.generated",
+	VOUCHER_REDEEMED: "promo.voucher.redeemed",
+	VOUCHER_CANCELLED: "promo.voucher.cancelled",
+	VOUCHER_EXPIRED: "promo.voucher.expired",
+	GIFT_CARD_SPENT: "promo.gift_card.spent",
+	GIFT_CARD_TOPPED_UP: "promo.gift_card.topped_up",
+	GIFT_CARD_EXHAUSTED: "promo.gift_card.exhausted",
+	EVALUATION_COMPLETED: "promo.evaluation.completed",
+	EVALUATION_COMMITTED: "promo.evaluation.committed",
+	EVALUATION_ROLLED_BACK: "promo.evaluation.rolled_back"
+};
+//#endregion
+//#region src/events/promo-event-catalog.ts
+function definePromoEvent(input) {
+	const { name, version = 1, description, zodSchema } = input;
+	const def = {
+		name,
+		version,
+		schema: z.toJSONSchema(zodSchema),
+		zodSchema,
+		create(payload, meta) {
+			return createEvent(name, payload, {
+				source: "promo",
+				...meta
+			});
+		}
+	};
+	if (description !== void 0) def.description = description;
+	return def;
+}
+/** Mirrors `ProgramLifecyclePayload`. */
+const programLifecycleSchema = z.object({
+	programId: z.string(),
+	programType: z.string(),
+	status: z.string(),
+	actorRef: z.string().optional()
+});
+/** Mirrors `RulePayload`. */
+const ruleSchema = z.object({
+	programId: z.string(),
+	ruleId: z.string(),
+	actorRef: z.string().optional()
+});
+/** Mirrors `RewardPayload`. */
+const rewardSchema = z.object({
+	programId: z.string(),
+	rewardId: z.string(),
+	actorRef: z.string().optional()
+});
+/** Mirrors `VoucherGeneratedPayload`. */
+const voucherGeneratedSchema = z.object({
+	programId: z.string(),
+	voucherIds: z.array(z.string()),
+	codes: z.array(z.string()),
+	count: z.number().int().nonnegative(),
+	actorRef: z.string().optional()
+});
+/** Mirrors `VoucherRedeemedPayload`. */
+const voucherRedeemedSchema = z.object({
+	voucherId: z.string(),
+	code: z.string(),
+	orderId: z.string(),
+	discountAmount: z.number(),
+	customerId: z.string().optional()
+});
+/**
+* Mirrors `VoucherLifecyclePayload` — shared by VOUCHER_CANCELLED,
+* VOUCHER_EXPIRED, and GIFT_CARD_EXHAUSTED (repo emits `status: 'cancelled'`
+* / `'used'` / host-supplied terminal value).
+*/
+const voucherLifecycleSchema = z.object({
+	voucherId: z.string(),
+	code: z.string(),
+	status: z.string()
+});
+/** Mirrors `GiftCardSpentPayload`. */
+const giftCardSpentSchema = z.object({
+	voucherId: z.string(),
+	code: z.string(),
+	amount: z.number(),
+	remainingBalance: z.number(),
+	orderId: z.string()
+});
+/** Mirrors `GiftCardToppedUpPayload`. */
+const giftCardToppedUpSchema = z.object({
+	voucherId: z.string(),
+	code: z.string(),
+	amount: z.number(),
+	newBalance: z.number()
+});
+/** Mirrors `EvaluationCompletedPayload`. */
+const evaluationCompletedSchema = z.object({
+	evaluationId: z.string(),
+	totalDiscount: z.number(),
+	programsApplied: z.number().int().nonnegative(),
+	codesUsed: z.array(z.string()),
+	isPreview: z.boolean()
+});
+/** Mirrors `EvaluationCommittedPayload`. */
+const evaluationCommittedSchema = z.object({
+	evaluationId: z.string(),
+	orderId: z.string(),
+	totalDiscount: z.number()
+});
+/** Single-field rollback payload — emitted by `evaluation.service.ts`. */
+const evaluationRolledBackSchema = z.object({ evaluationId: z.string() });
+const ProgramCreated = definePromoEvent({
+	name: PromoEvents.PROGRAM_CREATED,
+	description: "A new promo program was created (starts in draft).",
+	zodSchema: programLifecycleSchema
+});
+const ProgramActivated = definePromoEvent({
+	name: PromoEvents.PROGRAM_ACTIVATED,
+	description: "A draft or paused program was activated.",
+	zodSchema: programLifecycleSchema
+});
+const ProgramPaused = definePromoEvent({
+	name: PromoEvents.PROGRAM_PAUSED,
+	description: "An active program was paused.",
+	zodSchema: programLifecycleSchema
+});
+const ProgramArchived = definePromoEvent({
+	name: PromoEvents.PROGRAM_ARCHIVED,
+	description: "A program was archived (terminal — no further transitions).",
+	zodSchema: programLifecycleSchema
+});
+const RuleAdded = definePromoEvent({
+	name: PromoEvents.RULE_ADDED,
+	description: "A new rule was added to a program.",
+	zodSchema: ruleSchema
+});
+const RuleUpdated = definePromoEvent({
+	name: PromoEvents.RULE_UPDATED,
+	description: "An existing rule on a program was updated.",
+	zodSchema: ruleSchema
+});
+const RuleRemoved = definePromoEvent({
+	name: PromoEvents.RULE_REMOVED,
+	description: "A rule was removed from a program.",
+	zodSchema: ruleSchema
+});
+const RewardAdded = definePromoEvent({
+	name: PromoEvents.REWARD_ADDED,
+	description: "A reward was added to a program.",
+	zodSchema: rewardSchema
+});
+const RewardUpdated = definePromoEvent({
+	name: PromoEvents.REWARD_UPDATED,
+	description: "A reward on a program was updated.",
+	zodSchema: rewardSchema
+});
+const RewardRemoved = definePromoEvent({
+	name: PromoEvents.REWARD_REMOVED,
+	description: "A reward was removed from a program.",
+	zodSchema: rewardSchema
+});
+const VoucherGenerated = definePromoEvent({
+	name: PromoEvents.VOUCHER_GENERATED,
+	description: "One or more vouchers were generated for a program.",
+	zodSchema: voucherGeneratedSchema
+});
+const VoucherRedeemed = definePromoEvent({
+	name: PromoEvents.VOUCHER_REDEEMED,
+	description: "A voucher was redeemed against an order.",
+	zodSchema: voucherRedeemedSchema
+});
+const VoucherCancelled = definePromoEvent({
+	name: PromoEvents.VOUCHER_CANCELLED,
+	description: "A voucher was cancelled by an operator.",
+	zodSchema: voucherLifecycleSchema
+});
+const VoucherExpired = definePromoEvent({
+	name: PromoEvents.VOUCHER_EXPIRED,
+	description: "A voucher reached its expiry date and was transitioned to expired.",
+	zodSchema: voucherLifecycleSchema
+});
+const GiftCardSpent = definePromoEvent({
+	name: PromoEvents.GIFT_CARD_SPENT,
+	description: "A gift-card voucher was debited against an order — remaining balance reported.",
+	zodSchema: giftCardSpentSchema
+});
+const GiftCardToppedUp = definePromoEvent({
+	name: PromoEvents.GIFT_CARD_TOPPED_UP,
+	description: "A gift-card voucher received a top-up — new balance reported.",
+	zodSchema: giftCardToppedUpSchema
+});
+const GiftCardExhausted = definePromoEvent({
+	name: PromoEvents.GIFT_CARD_EXHAUSTED,
+	description: "A gift-card voucher reached a zero balance and was marked used.",
+	zodSchema: voucherLifecycleSchema
+});
+const EvaluationCompleted = definePromoEvent({
+	name: PromoEvents.EVALUATION_COMPLETED,
+	description: "A cart evaluation finished (preview or pre-commit) — totals and applied codes reported.",
+	zodSchema: evaluationCompletedSchema
+});
+const EvaluationCommitted = definePromoEvent({
+	name: PromoEvents.EVALUATION_COMMITTED,
+	description: "A stored evaluation was committed against an order — usage counters moved.",
+	zodSchema: evaluationCommittedSchema
+});
+const EvaluationRolledBack = definePromoEvent({
+	name: PromoEvents.EVALUATION_ROLLED_BACK,
+	description: "A stored evaluation was discarded without commit.",
+	zodSchema: evaluationRolledBackSchema
+});
+/**
+* Every promo event defined in the package — pass to Arc's
+* `EventRegistry`. Hosts wire ONE array; the whole `promo.*` namespace
+* becomes introspectable via OpenAPI and auto-validated at publish time
+* when `eventPlugin({ validateMode: 'reject' })` is set.
+*/
+const promoEventDefinitions = [
+	ProgramCreated,
+	ProgramActivated,
+	ProgramPaused,
+	ProgramArchived,
+	RuleAdded,
+	RuleUpdated,
+	RuleRemoved,
+	RewardAdded,
+	RewardUpdated,
+	RewardRemoved,
+	VoucherGenerated,
+	VoucherRedeemed,
+	VoucherCancelled,
+	VoucherExpired,
+	GiftCardSpent,
+	GiftCardToppedUp,
+	GiftCardExhausted,
+	EvaluationCompleted,
+	EvaluationCommitted,
+	EvaluationRolledBack
+];
+//#endregion
+export { PromoEvents as S, VoucherCancelled as _, GiftCardSpent as a, VoucherRedeemed as b, ProgramArchived as c, RewardAdded as d, RewardRemoved as f, RuleUpdated as g, RuleRemoved as h, GiftCardExhausted as i, ProgramCreated as l, RuleAdded as m, EvaluationCompleted as n, GiftCardToppedUp as o, RewardUpdated as p, EvaluationRolledBack as r, ProgramActivated as s, EvaluationCommitted as t, ProgramPaused as u, VoucherExpired as v, promoEventDefinitions as x, VoucherGenerated as y };

package/dist/schemas/index.d.mts

@@ -1,4 +1,4 @@
-import { a as PROGRAM_STATUSES, d as STACKING_MODES, h as VOUCHER_STATUSES, l as REWARD_TYPES, n as DISCOUNT_SCOPES, o as PROGRAM_TYPES, p as TRIGGER_MODES, t as DISCOUNT_MODES } from "../constants-CrbSSQG5.mjs";
+import { a as PROGRAM_STATUSES, d as STACKING_MODES, h as VOUCHER_STATUSES, l as REWARD_TYPES, n as DISCOUNT_SCOPES, o as PROGRAM_TYPES, p as TRIGGER_MODES, t as DISCOUNT_MODES } from "../constants-hcMTDJml.mjs";
 import { z } from "zod";
 
 //#region src/schemas/index.d.ts
@@ -13,8 +13,8 @@ declare const programCreateSchema: z.ZodObject<{
     gift_card: "gift_card";
   }>;
   triggerMode: z.ZodEnum<{
-    auto: "auto";
     code: "code";
+    auto: "auto";
   }>;
   stackingMode: z.ZodOptional<z.ZodEnum<{
     exclusive: "exclusive";
@@ -41,8 +41,8 @@ declare const programUpdateSchema: z.ZodObject<{
     gift_card: "gift_card";
   }>>;
   triggerMode: z.ZodOptional<z.ZodEnum<{
-    auto: "auto";
     code: "code";
+    auto: "auto";
   }>>;
   stackingMode: z.ZodOptional<z.ZodOptional<z.ZodEnum<{
     exclusive: "exclusive";
@@ -229,8 +229,8 @@ declare const programListFilterSchema: z.ZodObject<{
     archived: "archived";
   }>>;
   triggerMode: z.ZodOptional<z.ZodEnum<{
-    auto: "auto";
     code: "code";
+    auto: "auto";
   }>>;
   stackingMode: z.ZodOptional<z.ZodEnum<{
     exclusive: "exclusive";

package/dist/schemas/index.mjs

@@ -1,4 +1,4 @@
-import { a as PROGRAM_TYPES, c as TRIGGER_MODES, i as PROGRAM_STATUSES, l as VOUCHER_STATUSES, n as DISCOUNT_SCOPES, o as REWARD_TYPES, s as STACKING_MODES, t as DISCOUNT_MODES } from "../constants-BB5O8zlN.mjs";
+import { a as PROGRAM_TYPES, c as TRIGGER_MODES, i as PROGRAM_STATUSES, l as VOUCHER_STATUSES, n as DISCOUNT_SCOPES, o as REWARD_TYPES, s as STACKING_MODES, t as DISCOUNT_MODES } from "../constants-BE886vJk.mjs";
 import { z } from "zod";
 //#region src/schemas/index.ts
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@classytic/promo",
-  "version": "0.2.5",
+  "version": "0.4.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",
@@ -27,6 +27,10 @@
     "./schemas": {
       "types": "./dist/schemas/index.d.mts",
       "default": "./dist/schemas/index.mjs"
+    },
+    "./events": {
+      "types": "./dist/events/promo-event-catalog.d.mts",
+      "default": "./dist/events/promo-event-catalog.mjs"
     }
   },
   "main": "./dist/index.mjs",
@@ -57,18 +61,18 @@
     "release": "npm run push -- main && npm run release:tag && npm publish"
   },
   "peerDependencies": {
-    "@classytic/mongokit": ">=3.13.3",
+    "@classytic/mongokit": ">=3.16.0",
     "@classytic/primitives": ">=0.5.0",
-    "@classytic/repo-core": ">=0.4.2",
+    "@classytic/repo-core": ">=0.6.0",
     "mongoose": ">=9.4.1",
     "zod": ">=4.0.0"
   },
   "devDependencies": {
     "@biomejs/biome": "^2.4.9",
     "@classytic/dev-tools": "^0.2.0",
-    "@classytic/mongokit": "^3.13.3",
-    "@classytic/primitives": ">=0.5.0",
-    "@classytic/repo-core": "^0.4.2",
+    "@classytic/mongokit": "^3.16.0",
+    "@classytic/primitives": "^0.7.2",
+    "@classytic/repo-core": "^0.6.0",
     "@types/node": "^25.5.0",
     "@vitest/coverage-v8": "^3.2.4",
     "knip": "^6.3.0",