@carlonicora/nestjs-neo4jsonapi 7.0.0 → 8.0.0

package/dist/foundations/billing/billing.module.js

@@ -0,0 +1,74 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var BillingModule_1;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BillingModule = void 0;
+const bullmq_1 = require("@nestjs/bullmq");
+const common_1 = require("@nestjs/common");
+const conditional_service_decorator_1 = require("../../common/decorators/conditional-service.decorator");
+const queue_id_1 = require("../../config/enums/queue.id");
+const email_module_1 = require("../../core/email/email.module");
+const stripe_customer_module_1 = require("../stripe-customer/stripe-customer.module");
+const stripe_subscription_module_1 = require("../stripe-subscription/stripe-subscription.module");
+const stripe_webhook_module_1 = require("../stripe-webhook/stripe-webhook.module");
+const billing_lifecycle_cron_1 = require("./cron/billing-lifecycle.cron");
+const billing_config_interface_1 = require("./interfaces/billing.config.interface");
+const billing_email_processor_1 = require("./processors/billing-email.processor");
+const card_expiry_warning_service_1 = require("./services/card-expiry-warning.service");
+/**
+ * BillingModule — per-app billing settings and billing housekeeping.
+ *
+ * - `BILLING_CONFIG` (global): the resolved settings every billing service reads
+ * - `BillingLifecycleCron` (worker only): hourly card-expiry check
+ * - `BillingEmailProcessor` (worker only, opt-in): the library billing email sender on `QueueId.EMAIL`
+ *
+ * Always mounted by `FoundationsModule`.
+ *
+ * @example
+ * ```typescript
+ * // Through bootstrap, which forwards it to FoundationsModule
+ * bootstrap({ billing: { emailSender: { enabled: true } } })
+ * ```
+ */
+let BillingModule = BillingModule_1 = class BillingModule {
+    /**
+     * Configure the BillingModule.
+     *
+     * @param config - Optional configuration merged key by key over DEFAULT_BILLING_CONFIG
+     */
+    static forRoot(config) {
+        const resolved = (0, billing_config_interface_1.resolveBillingConfig)(config);
+        const configProvider = {
+            provide: billing_config_interface_1.BILLING_CONFIG,
+            useValue: resolved,
+        };
+        return {
+            module: BillingModule_1,
+            global: true,
+            imports: [
+                bullmq_1.BullModule.registerQueue({ name: queue_id_1.QueueId.EMAIL }),
+                email_module_1.EmailModule,
+                stripe_subscription_module_1.StripeSubscriptionModule,
+                stripe_customer_module_1.StripeCustomerModule,
+                stripe_webhook_module_1.StripeWebhookModule,
+            ],
+            providers: [
+                configProvider,
+                card_expiry_warning_service_1.CardExpiryWarningService,
+                (0, conditional_service_decorator_1.createWorkerProvider)(billing_lifecycle_cron_1.BillingLifecycleCron),
+                ...(resolved.emailSender.enabled ? [(0, conditional_service_decorator_1.createWorkerProvider)(billing_email_processor_1.BillingEmailProcessor)] : []),
+            ],
+            exports: [billing_config_interface_1.BILLING_CONFIG],
+        };
+    }
+};
+exports.BillingModule = BillingModule;
+exports.BillingModule = BillingModule = BillingModule_1 = __decorate([
+    (0, common_1.Module)({})
+], BillingModule);
+//# sourceMappingURL=billing.module.js.map

package/dist/foundations/billing/billing.module.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"billing.module.js","sourceRoot":"","sources":["../../../src/foundations/billing/billing.module.ts"],"names":[],"mappings":";;;;;;;;;;AAAA,2CAA4C;AAC5C,2CAAiE;AACjE,yGAA6F;AAC7F,0DAAsD;AACtD,gEAA4D;AAC5D,sFAAiF;AACjF,kGAA6F;AAC7F,mFAA8E;AAC9E,0EAAqE;AACrE,oFAAkH;AAClH,kFAA6E;AAC7E,wFAAkF;AAElF;;;;;;;;;;;;;;GAcG;AAEI,IAAM,aAAa,qBAAnB,MAAM,aAAa;IACxB;;;;OAIG;IACH,MAAM,CAAC,OAAO,CAAC,MAA4B;QACzC,MAAM,QAAQ,GAAG,IAAA,+CAAoB,EAAC,MAAM,CAAC,CAAC;QAE9C,MAAM,cAAc,GAAa;YAC/B,OAAO,EAAE,yCAAc;YACvB,QAAQ,EAAE,QAAQ;SACnB,CAAC;QAEF,OAAO;YACL,MAAM,EAAE,eAAa;YACrB,MAAM,EAAE,IAAI;YACZ,OAAO,EAAE;gBACP,mBAAU,CAAC,aAAa,CAAC,EAAE,IAAI,EAAE,kBAAO,CAAC,KAAK,EAAE,CAAC;gBACjD,0BAAW;gBACX,qDAAwB;gBACxB,6CAAoB;gBACpB,2CAAmB;aACpB;YACD,SAAS,EAAE;gBACT,cAAc;gBACd,sDAAwB;gBACxB,IAAA,oDAAoB,EAAC,6CAAoB,CAAC;gBAC1C,GAAG,CAAC,QAAQ,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAA,oDAAoB,EAAC,+CAAqB,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;aACvF;YACD,OAAO,EAAE,CAAC,yCAAc,CAAC;SAC1B,CAAC;IACJ,CAAC;CACF,CAAA;AAjCY,sCAAa;wBAAb,aAAa;IADzB,IAAA,eAAM,EAAC,EAAE,CAAC;GACE,aAAa,CAiCzB"}

package/dist/foundations/billing/cron/billing-lifecycle.cron.d.ts

@@ -0,0 +1,16 @@
+import { AppLoggingService } from "../../../core/logging/services/logging.service";
+import { CardExpiryWarningService } from "../services/card-expiry-warning.service";
+/**
+ * BillingLifecycleCron — hourly billing housekeeping, registered on worker
+ * instances only (`createWorkerProvider`).
+ *
+ * Checks the cards that expire before their renewal. A failure is logged, never
+ * thrown, so the next hourly run tries again.
+ */
+export declare class BillingLifecycleCron {
+    private readonly cardExpiryWarningService;
+    private readonly logger;
+    constructor(cardExpiryWarningService: CardExpiryWarningService, logger: AppLoggingService);
+    run(): Promise<void>;
+}
+//# sourceMappingURL=billing-lifecycle.cron.d.ts.map

package/dist/foundations/billing/cron/billing-lifecycle.cron.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"billing-lifecycle.cron.d.ts","sourceRoot":"","sources":["../../../../src/foundations/billing/cron/billing-lifecycle.cron.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,iBAAiB,EAAE,MAAM,gDAAgD,CAAC;AACnF,OAAO,EAAE,wBAAwB,EAAE,MAAM,yCAAyC,CAAC;AAEnF;;;;;;GAMG;AACH,qBACa,oBAAoB;IAE7B,OAAO,CAAC,QAAQ,CAAC,wBAAwB;IACzC,OAAO,CAAC,QAAQ,CAAC,MAAM;gBADN,wBAAwB,EAAE,wBAAwB,EAClD,MAAM,EAAE,iBAAiB;IAItC,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC;CAU3B"}

package/dist/foundations/billing/cron/billing-lifecycle.cron.js

@@ -0,0 +1,52 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BillingLifecycleCron = void 0;
+const common_1 = require("@nestjs/common");
+const schedule_1 = require("@nestjs/schedule");
+const logging_service_1 = require("../../../core/logging/services/logging.service");
+const card_expiry_warning_service_1 = require("../services/card-expiry-warning.service");
+/**
+ * BillingLifecycleCron — hourly billing housekeeping, registered on worker
+ * instances only (`createWorkerProvider`).
+ *
+ * Checks the cards that expire before their renewal. A failure is logged, never
+ * thrown, so the next hourly run tries again.
+ */
+let BillingLifecycleCron = class BillingLifecycleCron {
+    constructor(cardExpiryWarningService, logger) {
+        this.cardExpiryWarningService = cardExpiryWarningService;
+        this.logger = logger;
+    }
+    async run() {
+        const now = new Date();
+        try {
+            const { checked, warned } = await this.cardExpiryWarningService.processDue({ now });
+            this.logger.log(`Billing lifecycle: ${checked} card(s) checked, ${warned} warned`, "BillingLifecycleCron");
+        }
+        catch (error) {
+            this.logger.error(`Failed to check expiring cards: ${error.message}`, "BillingLifecycleCron");
+        }
+    }
+};
+exports.BillingLifecycleCron = BillingLifecycleCron;
+__decorate([
+    (0, schedule_1.Cron)(schedule_1.CronExpression.EVERY_HOUR),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", Promise)
+], BillingLifecycleCron.prototype, "run", null);
+exports.BillingLifecycleCron = BillingLifecycleCron = __decorate([
+    (0, common_1.Injectable)(),
+    __metadata("design:paramtypes", [card_expiry_warning_service_1.CardExpiryWarningService,
+        logging_service_1.AppLoggingService])
+], BillingLifecycleCron);
+//# sourceMappingURL=billing-lifecycle.cron.js.map

package/dist/foundations/billing/cron/billing-lifecycle.cron.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"billing-lifecycle.cron.js","sourceRoot":"","sources":["../../../../src/foundations/billing/cron/billing-lifecycle.cron.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,2CAA4C;AAC5C,+CAAwD;AACxD,oFAAmF;AACnF,yFAAmF;AAEnF;;;;;;GAMG;AAEI,IAAM,oBAAoB,GAA1B,MAAM,oBAAoB;IAC/B,YACmB,wBAAkD,EAClD,MAAyB;QADzB,6BAAwB,GAAxB,wBAAwB,CAA0B;QAClD,WAAM,GAAN,MAAM,CAAmB;IACzC,CAAC;IAGE,AAAN,KAAK,CAAC,GAAG;QACP,MAAM,GAAG,GAAG,IAAI,IAAI,EAAE,CAAC;QAEvB,IAAI,CAAC;YACH,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,MAAM,IAAI,CAAC,wBAAwB,CAAC,UAAU,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC;YACpF,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,sBAAsB,OAAO,qBAAqB,MAAM,SAAS,EAAE,sBAAsB,CAAC,CAAC;QAC7G,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,mCAAoC,KAAe,CAAC,OAAO,EAAE,EAAE,sBAAsB,CAAC,CAAC;QAC3G,CAAC;IACH,CAAC;CACF,CAAA;AAjBY,oDAAoB;AAOzB;IADL,IAAA,eAAI,EAAC,yBAAc,CAAC,UAAU,CAAC;;;;+CAU/B;+BAhBU,oBAAoB;IADhC,IAAA,mBAAU,GAAE;qCAGkC,sDAAwB;QAC1C,mCAAiB;GAHjC,oBAAoB,CAiBhC"}

package/dist/foundations/billing/index.d.ts

@@ -0,0 +1,7 @@
+export * from "./billing.module";
+export * from "./interfaces/billing.config.interface";
+export * from "./processors/billing-email.jobs";
+export * from "./processors/billing-email.processor";
+export * from "./cron/billing-lifecycle.cron";
+export * from "./services/card-expiry-warning.service";
+//# sourceMappingURL=index.d.ts.map

package/dist/foundations/billing/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/foundations/billing/index.ts"],"names":[],"mappings":"AACA,cAAc,kBAAkB,CAAC;AAGjC,cAAc,uCAAuC,CAAC;AAGtD,cAAc,iCAAiC,CAAC;AAChD,cAAc,sCAAsC,CAAC;AAGrD,cAAc,+BAA+B,CAAC;AAG9C,cAAc,wCAAwC,CAAC"}

package/dist/foundations/billing/index.js

@@ -0,0 +1,28 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+// Module
+__exportStar(require("./billing.module"), exports);
+// Config
+__exportStar(require("./interfaces/billing.config.interface"), exports);
+// Sender
+__exportStar(require("./processors/billing-email.jobs"), exports);
+__exportStar(require("./processors/billing-email.processor"), exports);
+// Cron
+__exportStar(require("./cron/billing-lifecycle.cron"), exports);
+// Services
+__exportStar(require("./services/card-expiry-warning.service"), exports);
+//# sourceMappingURL=index.js.map

package/dist/foundations/billing/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/foundations/billing/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,SAAS;AACT,mDAAiC;AAEjC,SAAS;AACT,wEAAsD;AAEtD,SAAS;AACT,kEAAgD;AAChD,uEAAqD;AAErD,OAAO;AACP,gEAA8C;AAE9C,WAAW;AACX,yEAAuD"}

package/dist/foundations/billing/interfaces/billing.config.interface.d.ts

@@ -0,0 +1,71 @@
+/**
+ * The three billing emails an app can switch off one by one.
+ */
+export type BillingEmailKey = "paymentFailed" | "cardExpiring" | "subscriptionEnded";
+/**
+ * App-relative paths the billing emails link to. The sender prefixes each with
+ * the app URL (`app.url`, trailing slash removed).
+ */
+export type BillingLinks = {
+    billing: string;
+    paymentMethod: string;
+    subscribe: string;
+    resubscribe: string;
+};
+/**
+ * One email job the library sender handles: the template id and the mapping from
+ * the queued payload to the template data.
+ */
+export interface BillingEmailJobDefinition {
+    template: string;
+    toTemplateData: (payload: Record<string, unknown>, ctx: {
+        appUrl: string;
+        locale: string;
+        links: BillingLinks;
+    }) => Record<string, unknown>;
+}
+/**
+ * Configuration for the BillingModule. Every key is optional; omitted keys keep
+ * the value in `DEFAULT_BILLING_CONFIG`.
+ */
+export interface BillingModuleConfig {
+    /**
+     * The library billing email sender (a BullMQ worker on `QueueId.EMAIL`).
+     * OFF by default: apps that consume the email queue with their own processor
+     * keep doing so. `extraJobs` adds or overrides job types for the app.
+     */
+    emailSender?: {
+        enabled?: boolean;
+        extraJobs?: Record<string, BillingEmailJobDefinition>;
+    };
+    /** Per-email switches. Default: every email on. */
+    emails?: Partial<Record<BillingEmailKey, boolean>>;
+    /** Keep full access while Stripe retries a failed renewal, for GMs who have paid before. Default on. */
+    failedCardGrace?: boolean;
+    /** Days between a subscription ending and the company's deletion date. Default 30. */
+    deletion?: {
+        afterSubscriptionEndedDays?: number;
+    };
+    /** App-relative paths used in billing emails. */
+    links?: Partial<BillingLinks>;
+}
+export type ResolvedBillingConfig = {
+    emailSender: {
+        enabled: boolean;
+        extraJobs: Record<string, BillingEmailJobDefinition>;
+    };
+    emails: Record<BillingEmailKey, boolean>;
+    failedCardGrace: boolean;
+    deletion: {
+        afterSubscriptionEndedDays: number;
+    };
+    links: BillingLinks;
+};
+export declare const DEFAULT_BILLING_CONFIG: ResolvedBillingConfig;
+export declare const BILLING_CONFIG: unique symbol;
+/**
+ * Merges an app's billing config over the defaults, key by key: a partial
+ * `emails` or `links` object keeps every key it does not name.
+ */
+export declare function resolveBillingConfig(config?: BillingModuleConfig): ResolvedBillingConfig;
+//# sourceMappingURL=billing.config.interface.d.ts.map

package/dist/foundations/billing/interfaces/billing.config.interface.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"billing.config.interface.d.ts","sourceRoot":"","sources":["../../../../src/foundations/billing/interfaces/billing.config.interface.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,eAAe,GAAG,cAAc,GAAG,mBAAmB,CAAC;AAErF;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,aAAa,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,WAAW,EAAE,MAAM,CAAA;CAAE,CAAC;AAE9G;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACxC,QAAQ,EAAE,MAAM,CAAC;IACjB,cAAc,EAAE,CACd,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAChC,GAAG,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,YAAY,CAAA;KAAE,KACzD,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC9B;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC;;;;OAIG;IACH,WAAW,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,OAAO,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,yBAAyB,CAAC,CAAA;KAAE,CAAC;IAC3F,mDAAmD;IACnD,MAAM,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC,CAAC;IACnD,wGAAwG;IACxG,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,sFAAsF;IACtF,QAAQ,CAAC,EAAE;QAAE,0BAA0B,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IACnD,iDAAiD;IACjD,KAAK,CAAC,EAAE,OAAO,CAAC,YAAY,CAAC,CAAC;CAC/B;AAED,MAAM,MAAM,qBAAqB,GAAG;IAClC,WAAW,EAAE;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,yBAAyB,CAAC,CAAA;KAAE,CAAC;IACxF,MAAM,EAAE,MAAM,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC;IACzC,eAAe,EAAE,OAAO,CAAC;IACzB,QAAQ,EAAE;QAAE,0BAA0B,EAAE,MAAM,CAAA;KAAE,CAAC;IACjD,KAAK,EAAE,YAAY,CAAC;CACrB,CAAC;AAEF,eAAO,MAAM,sBAAsB,EAAE,qBAWpC,CAAC;AAEF,eAAO,MAAM,cAAc,eAA2B,CAAC;AAEvD;;;GAGG;AACH,wBAAgB,oBAAoB,CAAC,MAAM,CAAC,EAAE,mBAAmB,GAAG,qBAAqB,CAcxF"}

package/dist/foundations/billing/interfaces/billing.config.interface.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BILLING_CONFIG = exports.DEFAULT_BILLING_CONFIG = void 0;
+exports.resolveBillingConfig = resolveBillingConfig;
+exports.DEFAULT_BILLING_CONFIG = {
+    emailSender: { enabled: false, extraJobs: {} },
+    emails: { paymentFailed: true, cardExpiring: true, subscriptionEnded: true },
+    failedCardGrace: true,
+    deletion: { afterSubscriptionEndedDays: 30 },
+    links: {
+        billing: "/settings/billing",
+        paymentMethod: "/settings/billing",
+        subscribe: "/settings/billing?action=subscribe",
+        resubscribe: "/settings/billing",
+    },
+};
+exports.BILLING_CONFIG = Symbol("BILLING_CONFIG");
+/**
+ * Merges an app's billing config over the defaults, key by key: a partial
+ * `emails` or `links` object keeps every key it does not name.
+ */
+function resolveBillingConfig(config) {
+    return {
+        emailSender: {
+            enabled: config?.emailSender?.enabled ?? exports.DEFAULT_BILLING_CONFIG.emailSender.enabled,
+            extraJobs: { ...exports.DEFAULT_BILLING_CONFIG.emailSender.extraJobs, ...(config?.emailSender?.extraJobs ?? {}) },
+        },
+        emails: { ...exports.DEFAULT_BILLING_CONFIG.emails, ...stripUndefined(config?.emails) },
+        failedCardGrace: config?.failedCardGrace ?? exports.DEFAULT_BILLING_CONFIG.failedCardGrace,
+        deletion: {
+            afterSubscriptionEndedDays: config?.deletion?.afterSubscriptionEndedDays ?? exports.DEFAULT_BILLING_CONFIG.deletion.afterSubscriptionEndedDays,
+        },
+        links: { ...exports.DEFAULT_BILLING_CONFIG.links, ...stripUndefined(config?.links) },
+    };
+}
+function stripUndefined(value) {
+    if (!value)
+        return {};
+    return Object.fromEntries(Object.entries(value).filter(([, v]) => v !== undefined));
+}
+//# sourceMappingURL=billing.config.interface.js.map

package/dist/foundations/billing/interfaces/billing.config.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"billing.config.interface.js","sourceRoot":"","sources":["../../../../src/foundations/billing/interfaces/billing.config.interface.ts"],"names":[],"mappings":";;;AAuEA,oDAcC;AAjCY,QAAA,sBAAsB,GAA0B;IAC3D,WAAW,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,EAAE,EAAE;IAC9C,MAAM,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,iBAAiB,EAAE,IAAI,EAAE;IAC5E,eAAe,EAAE,IAAI;IACrB,QAAQ,EAAE,EAAE,0BAA0B,EAAE,EAAE,EAAE;IAC5C,KAAK,EAAE;QACL,OAAO,EAAE,mBAAmB;QAC5B,aAAa,EAAE,mBAAmB;QAClC,SAAS,EAAE,oCAAoC;QAC/C,WAAW,EAAE,mBAAmB;KACjC;CACF,CAAC;AAEW,QAAA,cAAc,GAAG,MAAM,CAAC,gBAAgB,CAAC,CAAC;AAEvD;;;GAGG;AACH,SAAgB,oBAAoB,CAAC,MAA4B;IAC/D,OAAO;QACL,WAAW,EAAE;YACX,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,OAAO,IAAI,8BAAsB,CAAC,WAAW,CAAC,OAAO;YACnF,SAAS,EAAE,EAAE,GAAG,8BAAsB,CAAC,WAAW,CAAC,SAAS,EAAE,GAAG,CAAC,MAAM,EAAE,WAAW,EAAE,SAAS,IAAI,EAAE,CAAC,EAAE;SAC1G;QACD,MAAM,EAAE,EAAE,GAAG,8BAAsB,CAAC,MAAM,EAAE,GAAG,cAAc,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE;QAC/E,eAAe,EAAE,MAAM,EAAE,eAAe,IAAI,8BAAsB,CAAC,eAAe;QAClF,QAAQ,EAAE;YACR,0BAA0B,EACxB,MAAM,EAAE,QAAQ,EAAE,0BAA0B,IAAI,8BAAsB,CAAC,QAAQ,CAAC,0BAA0B;SAC7G;QACD,KAAK,EAAE,EAAE,GAAG,8BAAsB,CAAC,KAAK,EAAE,GAAG,cAAc,CAAC,MAAM,EAAE,KAAK,CAAC,EAAE;KAC7E,CAAC;AACJ,CAAC;AAED,SAAS,cAAc,CAAmB,KAAS;IACjD,IAAI,CAAC,KAAK;QAAE,OAAO,EAAE,CAAC;IACtB,OAAO,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,SAAS,CAAC,CAAe,CAAC;AACpG,CAAC"}

package/dist/foundations/billing/processors/billing-email.jobs.d.ts

@@ -0,0 +1,127 @@
+import { BillingEmailJobDefinition } from "../interfaces/billing.config.interface";
+/**
+ * Job types the library billing email sender handles out of the box.
+ *
+ * The mapping below is copied from only35's `apps/api/src/processors/email.processor.ts`
+ * (every job type except the app-specific `cull-completed`), with the hard-coded
+ * paths turned into the configurable `links`. `card-expiring` is new.
+ */
+export type LibraryBillingJobType = "payment-failure" | "subscription-status-change" | "payment-success-customer" | "payment-success-admin" | "trial-ending-reminder" | "trial-ended" | "deletion-warning" | "subscription-cancelled" | "company-deleted" | "referral-invite" | "referral-reward" | "card-expiring";
+export interface BillingEmailJobData {
+    jobType: string;
+    payload: Record<string, unknown> & {
+        to: string;
+        locale?: string;
+    };
+}
+export interface PaymentFailureEmailParams {
+    to: string;
+    customerName: string;
+    stripeCustomerId: string;
+    stripeInvoiceId?: string;
+    stripePaymentIntentId?: string;
+    amount?: number;
+    currency?: string;
+    errorMessage?: string;
+    invoiceUrl?: string;
+    invoiceNumber?: string;
+    keepsAccess?: boolean;
+    locale?: string;
+}
+export interface SubscriptionStatusEmailParams {
+    to: string;
+    customerName: string;
+    stripeCustomerId: string;
+    subscriptionId: string;
+    status: string;
+    locale?: string;
+}
+export interface PaymentSuccessCustomerEmailParams {
+    to: string;
+    customerName: string;
+    stripeCustomerId: string;
+    stripeInvoiceId?: string;
+    stripePaymentIntentId?: string;
+    amount: number;
+    currency: string;
+    invoiceUrl?: string;
+    invoiceNumber?: string;
+    isOneTimePurchase: boolean;
+    locale?: string;
+}
+export interface PaymentSuccessAdminEmailParams {
+    to: string;
+    adminName: string;
+    companyName: string;
+    amount: number;
+    currency: string;
+    isOneTimePurchase: boolean;
+    locale?: string;
+}
+export interface TrialEndingReminderEmailParams {
+    to: string;
+    customerName: string;
+    stripeCustomerId: string;
+    stripeSubscriptionId: string;
+    trialEndDate: string;
+    locale?: string;
+}
+export interface TrialEndedEmailParams {
+    to: string;
+    customerName: string;
+    companyName: string;
+    stripeCustomerId: string;
+    stripeSubscriptionId: string;
+    trialEndDate: string;
+    dataRemovalDate: string;
+    locale?: string;
+}
+export interface DeletionWarningEmailParams {
+    to: string;
+    companyName: string;
+    daysRemaining: number;
+    deletionDate: string;
+    reason: "trial_expired" | "subscription_cancelled";
+    isTrialExpired: boolean;
+    isSubscriptionCancelled: boolean;
+    locale?: string;
+}
+export interface SubscriptionCancelledEmailParams {
+    to: string;
+    companyName: string;
+    dataRemovalDate: string;
+    locale?: string;
+}
+export interface CompanyDeletedEmailParams {
+    to: string;
+    companyName: string;
+    reason: "trial_expired" | "subscription_cancelled" | "immediate_deletion";
+    deletionDate: string;
+    locale?: string;
+}
+export interface ReferralInviteEmailParams {
+    to: string;
+    referralCode: string;
+    companyName: string;
+    inviterName: string;
+    inviterEmail: string;
+    referralUrl: string;
+    locale?: string;
+}
+export interface ReferralRewardEmailParams {
+    to: string;
+    userName: string;
+    tokensAwarded: number;
+    locale?: string;
+}
+export interface CardExpiringEmailParams {
+    to: string;
+    customerName: string;
+    stripeCustomerId: string;
+    renewalDate: string;
+    cardBrand: string;
+    cardLast4: string;
+    locale?: string;
+}
+export declare const LIBRARY_BILLING_EMAIL_JOBS: Record<LibraryBillingJobType, BillingEmailJobDefinition>;
+//# sourceMappingURL=billing-email.jobs.d.ts.map

package/dist/foundations/billing/processors/billing-email.jobs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"billing-email.jobs.d.ts","sourceRoot":"","sources":["../../../../src/foundations/billing/processors/billing-email.jobs.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,yBAAyB,EAAE,MAAM,wCAAwC,CAAC;AAEnF;;;;;;GAMG;AACH,MAAM,MAAM,qBAAqB,GAC7B,iBAAiB,GACjB,4BAA4B,GAC5B,0BAA0B,GAC1B,uBAAuB,GACvB,uBAAuB,GACvB,aAAa,GACb,kBAAkB,GAClB,wBAAwB,GACxB,iBAAiB,GACjB,iBAAiB,GACjB,iBAAiB,GACjB,eAAe,CAAC;AAEpB,MAAM,WAAW,mBAAmB;IAClC,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;CACpE;AAED,MAAM,WAAW,yBAAyB;IACxC,EAAE,EAAE,MAAM,CAAC;IACX,YAAY,EAAE,MAAM,CAAC;IACrB,gBAAgB,EAAE,MAAM,CAAC;IACzB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,6BAA6B;IAC5C,EAAE,EAAE,MAAM,CAAC;IACX,YAAY,EAAE,MAAM,CAAC;IACrB,gBAAgB,EAAE,MAAM,CAAC;IACzB,cAAc,EAAE,MAAM,CAAC;IACvB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,iCAAiC;IAChD,EAAE,EAAE,MAAM,CAAC;IACX,YAAY,EAAE,MAAM,CAAC;IACrB,gBAAgB,EAAE,MAAM,CAAC;IACzB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,iBAAiB,EAAE,OAAO,CAAC;IAC3B,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,8BAA8B;IAC7C,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,iBAAiB,EAAE,OAAO,CAAC;IAC3B,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,8BAA8B;IAC7C,EAAE,EAAE,MAAM,CAAC;IACX,YAAY,EAAE,MAAM,CAAC;IACrB,gBAAgB,EAAE,MAAM,CAAC;IACzB,oBAAoB,EAAE,MAAM,CAAC;IAC7B,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,qBAAqB;IACpC,EAAE,EAAE,MAAM,CAAC;IACX,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,MAAM,CAAC;IACpB,gBAAgB,EAAE,MAAM,CAAC;IACzB,oBAAoB,EAAE,MAAM,CAAC;IAC7B,YAAY,EAAE,MAAM,CAAC;IACrB,eAAe,EAAE,MAAM,CAAC;IACxB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,0BAA0B;IACzC,EAAE,EAAE,MAAM,CAAC;IACX,WAAW,EAAE,MAAM,CAAC;IACpB,aAAa,EAAE,MAAM,CAAC;IACtB,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,eAAe,GAAG,wBAAwB,CAAC;IACnD,cAAc,EAAE,OAAO,CAAC;IACxB,uBAAuB,EAAE,OAAO,CAAC;IACjC,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,gCAAgC;IAC/C,EAAE,EAAE,MAAM,CAAC;IACX,WAAW,EAAE,MAAM,CAAC;IACpB,eAAe,EAAE,MAAM,CAAC;IACxB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,yBAAyB;IACxC,EAAE,EAAE,MAAM,CAAC;IACX,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,eAAe,GAAG,wBAAwB,GAAG,oBAAoB,CAAC;IAC1E,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,yBAAyB;IACxC,EAAE,EAAE,MAAM,CAAC;IACX,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,yBAAyB;IACxC,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,MAAM,CAAC;IACjB,aAAa,EAAE,MAAM,CAAC;IACtB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,uBAAuB;IACtC,EAAE,EAAE,MAAM,CAAC;IACX,YAAY,EAAE,MAAM,CAAC;IACrB,gBAAgB,EAAE,MAAM,CAAC;IACzB,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAOD,eAAO,MAAM,0BAA0B,EAAE,MAAM,CAAC,qBAAqB,EAAE,yBAAyB,CAwM/F,CAAC"}

package/dist/foundations/billing/processors/billing-email.jobs.js

@@ -0,0 +1,196 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LIBRARY_BILLING_EMAIL_JOBS = void 0;
+const email_helpers_1 = require("../../../core/email/email.helpers");
+/** Narrows the queued payload to the shape a job expects. */
+function asParams(payload) {
+    return payload;
+}
+exports.LIBRARY_BILLING_EMAIL_JOBS = {
+    "payment-failure": {
+        template: "paymentFailure",
+        toTemplateData: (payload, { appUrl, locale, links }) => {
+            const params = asParams(payload);
+            return {
+                to: params.to,
+                customerName: params.customerName,
+                stripeInvoiceId: params.stripeInvoiceId,
+                stripePaymentIntentId: params.stripePaymentIntentId,
+                amount: params.amount,
+                currency: params.currency,
+                errorMessage: params.errorMessage,
+                invoiceUrl: params.invoiceUrl,
+                invoiceNumber: params.invoiceNumber,
+                updatePaymentUrl: `${appUrl}${links.paymentMethod}`,
+                keepsAccess: params.keepsAccess ?? false,
+                locale,
+            };
+        },
+    },
+    "subscription-status-change": {
+        template: "subscriptionStatusChange",
+        toTemplateData: (payload, { appUrl, locale, links }) => {
+            const params = asParams(payload);
+            return {
+                to: params.to,
+                customerName: params.customerName,
+                subscriptionId: params.subscriptionId,
+                status: params.status,
+                dashboardUrl: `${appUrl}${links.billing}`,
+                locale,
+            };
+        },
+    },
+    "payment-success-customer": {
+        template: "paymentSuccessCustomer",
+        toTemplateData: (payload, { appUrl, locale, links }) => {
+            const params = asParams(payload);
+            return {
+                to: params.to,
+                customerName: params.customerName,
+                amount: params.amount,
+                currency: params.currency?.toUpperCase() || "USD",
+                invoiceUrl: params.invoiceUrl,
+                invoiceNumber: params.invoiceNumber,
+                isOneTimePurchase: params.isOneTimePurchase,
+                billingDashboardUrl: `${appUrl}${links.billing}`,
+                locale,
+            };
+        },
+    },
+    "payment-success-admin": {
+        template: "paymentSuccessAdmin",
+        toTemplateData: (payload, { locale }) => {
+            const params = asParams(payload);
+            return {
+                to: params.to,
+                adminName: params.adminName,
+                companyName: params.companyName,
+                amount: params.amount,
+                currency: params.currency?.toUpperCase() || "USD",
+                isOneTimePurchase: params.isOneTimePurchase,
+                locale,
+            };
+        },
+    },
+    "trial-ending-reminder": {
+        template: "trialEndingReminder",
+        toTemplateData: (payload, { appUrl, locale, links }) => {
+            const params = asParams(payload);
+            return {
+                to: params.to,
+                customerName: params.customerName,
+                trialEndDate: (0, email_helpers_1.formatEmailDate)(params.trialEndDate, locale),
+                upgradeUrl: `${appUrl}${links.subscribe}`,
+                locale,
+            };
+        },
+    },
+    "trial-ended": {
+        template: "trialEndedWithoutPayment",
+        toTemplateData: (payload, { appUrl, locale, links }) => {
+            const params = asParams(payload);
+            return {
+                to: params.to,
+                customerName: params.customerName,
+                companyName: params.companyName,
+                trialEndDate: (0, email_helpers_1.formatEmailDate)(params.trialEndDate, locale),
+                dataRemovalDate: (0, email_helpers_1.formatEmailDate)(params.dataRemovalDate, locale),
+                upgradeUrl: `${appUrl}${links.resubscribe}`,
+                locale,
+            };
+        },
+    },
+    "deletion-warning": {
+        template: "deletionWarning",
+        toTemplateData: (payload, { appUrl, locale, links }) => {
+            const params = asParams(payload);
+            const subject = params.daysRemaining === 1
+                ? `Final Warning: Your ${params.companyName} data will be deleted tomorrow`
+                : `Warning: Your ${params.companyName} data will be deleted in ${params.daysRemaining} days`;
+            return {
+                to: params.to,
+                subject,
+                companyName: params.companyName,
+                daysRemaining: params.daysRemaining,
+                deletionDate: (0, email_helpers_1.formatEmailDate)(params.deletionDate, locale),
+                isTrialExpired: params.isTrialExpired,
+                isSubscriptionCancelled: params.isSubscriptionCancelled,
+                isFinalWarning: params.daysRemaining === 1,
+                resubscribeUrl: `${appUrl}${links.resubscribe}`,
+                locale,
+            };
+        },
+    },
+    "subscription-cancelled": {
+        template: "subscriptionCancelled",
+        toTemplateData: (payload, { appUrl, locale, links }) => {
+            const params = asParams(payload);
+            return {
+                to: params.to,
+                companyName: params.companyName,
+                dataRemovalDate: (0, email_helpers_1.formatEmailDate)(params.dataRemovalDate, locale),
+                resubscribeUrl: `${appUrl}${links.resubscribe}`,
+                locale,
+            };
+        },
+    },
+    "company-deleted": {
+        template: "companyDeleted",
+        toTemplateData: (payload, { locale }) => {
+            const params = asParams(payload);
+            return {
+                to: params.to,
+                companyName: params.companyName,
+                deletionDate: (0, email_helpers_1.formatEmailDate)(params.deletionDate, locale),
+                isTrialExpired: params.reason === "trial_expired",
+                isSubscriptionCancelled: params.reason === "subscription_cancelled",
+                isImmediateDeletion: params.reason === "immediate_deletion",
+                locale,
+            };
+        },
+    },
+    "referral-invite": {
+        template: "referralInvite",
+        toTemplateData: (payload, { locale }) => {
+            const params = asParams(payload);
+            return {
+                to: params.to,
+                referralCode: params.referralCode,
+                companyName: params.companyName,
+                inviterName: params.inviterName,
+                inviterEmail: params.inviterEmail,
+                referralUrl: params.referralUrl,
+                locale,
+            };
+        },
+    },
+    "referral-reward": {
+        template: "referralReward",
+        toTemplateData: (payload, { locale }) => {
+            const params = asParams(payload);
+            return {
+                to: params.to,
+                userName: params.userName,
+                tokensAwarded: params.tokensAwarded,
+                locale,
+            };
+        },
+    },
+    "card-expiring": {
+        template: "cardExpiring",
+        toTemplateData: (payload, { appUrl, locale, links }) => {
+            const params = asParams(payload);
+            return {
+                to: params.to,
+                customerName: params.customerName,
+                renewalDate: (0, email_helpers_1.formatEmailDate)(params.renewalDate, locale),
+                cardBrand: params.cardBrand,
+                cardLast4: params.cardLast4,
+                updatePaymentUrl: `${appUrl}${links.paymentMethod}`,
+                locale,
+            };
+        },
+    },
+};
+//# sourceMappingURL=billing-email.jobs.js.map