@saasicat/nest 0.2.0

package/dist/promo/index.d.cts

@@ -0,0 +1,121 @@
+import { PromoCodeValueType, PromoCodeDurationType, BillingCycle, PromoCodeRepository, PromoCodeRedemptionRepository, PromoCodeValidationLogRepository, FirstTimeCustomerCheck, PromoSubscriptionLookup, PromoRevenueDeductionAggregator, TransactionRunner } from '@saasicat/types';
+import { f as PromoCodesService, c as PreviewResult, g as PromoServiceConfig } from '../service-DX8KbGXl.cjs';
+export { P as PreviewInput, a as PreviewInvalid, b as PreviewReason, d as PreviewValid, e as PromoCodeStats, R as RedeemInput } from '../service-DX8KbGXl.cjs';
+import { CanActivate, ExecutionContext, DynamicModule } from '@nestjs/common';
+import { P as ProviderSpec } from '../di-CcNeq9v-.cjs';
+
+/** Structural view of a PromoCode for the calculator functions.
+ *
+ * `value` deliberately accepts `number | string | { toString(): string }`, so
+ * that a Prisma `Decimal` (its own class with `toString()`) can be passed
+ * without a cast. Internally `Number(...)` is called.
+ */
+interface PromoCodeForCalc {
+    valueType: PromoCodeValueType | string;
+    value: number | string | {
+        toString(): string;
+    };
+    durationType?: PromoCodeDurationType | string;
+    durationValue?: number | null;
+}
+declare function computeDiscountGross(plan: {
+    gross: number;
+}, code: Pick<PromoCodeForCalc, 'valueType' | 'value'>): number;
+declare function computeDiscountedGross(planGross: number, discountGross: number): number;
+/**
+ * Next date on which the list price applies again (= end of the discount
+ * period). For ONCE: the first invoice is discounted, all others are
+ * regular — so directly the second period.
+ */
+declare function computeRegularStartsAt(startsAt: Date, cycle: BillingCycle, durationType: PromoCodeDurationType, durationValue: number | null): Date;
+declare function addCycles(date: Date, cycle: BillingCycle, n: number): Date;
+declare function buildLabel(code: Pick<PromoCodeForCalc, 'valueType' | 'value' | 'durationType' | 'durationValue'>, cycle: BillingCycle): string;
+
+declare function round2(n: number): number;
+/** Gross = net * (1 + vatRate/100). */
+declare function grossFromNet(net: number, vatRate: number): number;
+/** VAT included in the gross amount: gross * (vatRate / (100 + vatRate)). */
+declare function computeIncludedVat(grossAmount: number, vatRate: number): number;
+
+declare class PromoCodeExpirer {
+    private readonly promoRepo;
+    private readonly redemptionRepo;
+    private readonly logger;
+    constructor(promoRepo: PromoCodeRepository, redemptionRepo: PromoCodeRedemptionRepository);
+    expirePromoCodes(): Promise<void>;
+}
+
+interface RequestLike$1 {
+    headers: Record<string, string | string[] | undefined>;
+    ip?: string;
+    user?: {
+        id?: string;
+    };
+}
+declare class PromoCodeRateLimitGuard implements CanActivate {
+    private ipBuckets;
+    private sessionBuckets;
+    canActivate(context: ExecutionContext): boolean;
+    private exceeded;
+}
+declare function ipFingerprint(req: RequestLike$1): string;
+declare function hashIp(req: RequestLike$1): string;
+
+declare const PROMO_CODE_REPOSITORY_TOKEN: unique symbol;
+declare const PROMO_CODE_REDEMPTION_REPOSITORY_TOKEN: unique symbol;
+declare const PROMO_CODE_VALIDATION_LOG_REPOSITORY_TOKEN: unique symbol;
+declare const PROMO_FIRST_TIME_CUSTOMER_CHECK_TOKEN: unique symbol;
+declare const PROMO_SUBSCRIPTION_LOOKUP_TOKEN: unique symbol;
+declare const PROMO_REVENUE_DEDUCTION_AGGREGATOR_TOKEN: unique symbol;
+declare const PROMO_TRANSACTION_RUNNER_TOKEN: unique symbol;
+declare const PROMO_SERVICE_CONFIG_TOKEN: unique symbol;
+
+declare class PreviewPromoCodeDto {
+    code: string;
+    plan: string;
+    billingCycle: string;
+    email?: string;
+}
+
+interface RequestLike {
+    headers: Record<string, string | string[] | undefined>;
+    ip?: string;
+    user?: {
+        id?: string;
+        sub?: string;
+    };
+}
+declare class PromoCodePublicController {
+    private readonly promo;
+    constructor(promo: PromoCodesService);
+    preview(dto: PreviewPromoCodeDto, req: RequestLike): Promise<PreviewResult>;
+}
+
+interface PromoCodesModuleOptions {
+    promoCodeRepository: ProviderSpec<PromoCodeRepository>;
+    redemptionRepository: ProviderSpec<PromoCodeRedemptionRepository>;
+    validationLogRepository: ProviderSpec<PromoCodeValidationLogRepository>;
+    firstTimeCustomerCheck: ProviderSpec<FirstTimeCustomerCheck>;
+    subscriptionLookup: ProviderSpec<PromoSubscriptionLookup>;
+    revenueAggregator: ProviderSpec<PromoRevenueDeductionAggregator>;
+    transactionRunner: ProviderSpec<TransactionRunner>;
+    config?: PromoServiceConfig;
+    /**
+     * Default `true`. Set to `false` if the consumer wants to disable the cron
+     * (e.g. CLI boot, test setups without ScheduleModule).
+     */
+    includeExpirerCron?: boolean;
+    /**
+     * Default `true`. Registers `PromoCodePublicController` with
+     * `POST /billing/promo/preview`. Set to `false` if the consumer does not
+     * want to expose a public preview API (e.g. SuperAdmin-only deploy).
+     */
+    includePublicController?: boolean;
+    /** Register the module globally — default `false`. */
+    global?: boolean;
+}
+declare class PromoCodesModule {
+    static forRoot(options: PromoCodesModuleOptions): DynamicModule;
+}
+
+export { PROMO_CODE_REDEMPTION_REPOSITORY_TOKEN, PROMO_CODE_REPOSITORY_TOKEN, PROMO_CODE_VALIDATION_LOG_REPOSITORY_TOKEN, PROMO_FIRST_TIME_CUSTOMER_CHECK_TOKEN, PROMO_REVENUE_DEDUCTION_AGGREGATOR_TOKEN, PROMO_SERVICE_CONFIG_TOKEN, PROMO_SUBSCRIPTION_LOOKUP_TOKEN, PROMO_TRANSACTION_RUNNER_TOKEN, PreviewPromoCodeDto, PreviewResult, PromoCodeExpirer, type PromoCodeForCalc, PromoCodePublicController, PromoCodeRateLimitGuard, PromoCodesModule, type PromoCodesModuleOptions, PromoCodesService, PromoServiceConfig, addCycles, buildLabel, computeDiscountGross, computeDiscountedGross, computeIncludedVat, computeRegularStartsAt, grossFromNet, hashIp, ipFingerprint, round2 };

package/dist/promo/index.d.ts

@@ -0,0 +1,121 @@
+import { PromoCodeValueType, PromoCodeDurationType, BillingCycle, PromoCodeRepository, PromoCodeRedemptionRepository, PromoCodeValidationLogRepository, FirstTimeCustomerCheck, PromoSubscriptionLookup, PromoRevenueDeductionAggregator, TransactionRunner } from '@saasicat/types';
+import { f as PromoCodesService, c as PreviewResult, g as PromoServiceConfig } from '../service-DX8KbGXl.js';
+export { P as PreviewInput, a as PreviewInvalid, b as PreviewReason, d as PreviewValid, e as PromoCodeStats, R as RedeemInput } from '../service-DX8KbGXl.js';
+import { CanActivate, ExecutionContext, DynamicModule } from '@nestjs/common';
+import { P as ProviderSpec } from '../di-CcNeq9v-.js';
+
+/** Structural view of a PromoCode for the calculator functions.
+ *
+ * `value` deliberately accepts `number | string | { toString(): string }`, so
+ * that a Prisma `Decimal` (its own class with `toString()`) can be passed
+ * without a cast. Internally `Number(...)` is called.
+ */
+interface PromoCodeForCalc {
+    valueType: PromoCodeValueType | string;
+    value: number | string | {
+        toString(): string;
+    };
+    durationType?: PromoCodeDurationType | string;
+    durationValue?: number | null;
+}
+declare function computeDiscountGross(plan: {
+    gross: number;
+}, code: Pick<PromoCodeForCalc, 'valueType' | 'value'>): number;
+declare function computeDiscountedGross(planGross: number, discountGross: number): number;
+/**
+ * Next date on which the list price applies again (= end of the discount
+ * period). For ONCE: the first invoice is discounted, all others are
+ * regular — so directly the second period.
+ */
+declare function computeRegularStartsAt(startsAt: Date, cycle: BillingCycle, durationType: PromoCodeDurationType, durationValue: number | null): Date;
+declare function addCycles(date: Date, cycle: BillingCycle, n: number): Date;
+declare function buildLabel(code: Pick<PromoCodeForCalc, 'valueType' | 'value' | 'durationType' | 'durationValue'>, cycle: BillingCycle): string;
+
+declare function round2(n: number): number;
+/** Gross = net * (1 + vatRate/100). */
+declare function grossFromNet(net: number, vatRate: number): number;
+/** VAT included in the gross amount: gross * (vatRate / (100 + vatRate)). */
+declare function computeIncludedVat(grossAmount: number, vatRate: number): number;
+
+declare class PromoCodeExpirer {
+    private readonly promoRepo;
+    private readonly redemptionRepo;
+    private readonly logger;
+    constructor(promoRepo: PromoCodeRepository, redemptionRepo: PromoCodeRedemptionRepository);
+    expirePromoCodes(): Promise<void>;
+}
+
+interface RequestLike$1 {
+    headers: Record<string, string | string[] | undefined>;
+    ip?: string;
+    user?: {
+        id?: string;
+    };
+}
+declare class PromoCodeRateLimitGuard implements CanActivate {
+    private ipBuckets;
+    private sessionBuckets;
+    canActivate(context: ExecutionContext): boolean;
+    private exceeded;
+}
+declare function ipFingerprint(req: RequestLike$1): string;
+declare function hashIp(req: RequestLike$1): string;
+
+declare const PROMO_CODE_REPOSITORY_TOKEN: unique symbol;
+declare const PROMO_CODE_REDEMPTION_REPOSITORY_TOKEN: unique symbol;
+declare const PROMO_CODE_VALIDATION_LOG_REPOSITORY_TOKEN: unique symbol;
+declare const PROMO_FIRST_TIME_CUSTOMER_CHECK_TOKEN: unique symbol;
+declare const PROMO_SUBSCRIPTION_LOOKUP_TOKEN: unique symbol;
+declare const PROMO_REVENUE_DEDUCTION_AGGREGATOR_TOKEN: unique symbol;
+declare const PROMO_TRANSACTION_RUNNER_TOKEN: unique symbol;
+declare const PROMO_SERVICE_CONFIG_TOKEN: unique symbol;
+
+declare class PreviewPromoCodeDto {
+    code: string;
+    plan: string;
+    billingCycle: string;
+    email?: string;
+}
+
+interface RequestLike {
+    headers: Record<string, string | string[] | undefined>;
+    ip?: string;
+    user?: {
+        id?: string;
+        sub?: string;
+    };
+}
+declare class PromoCodePublicController {
+    private readonly promo;
+    constructor(promo: PromoCodesService);
+    preview(dto: PreviewPromoCodeDto, req: RequestLike): Promise<PreviewResult>;
+}
+
+interface PromoCodesModuleOptions {
+    promoCodeRepository: ProviderSpec<PromoCodeRepository>;
+    redemptionRepository: ProviderSpec<PromoCodeRedemptionRepository>;
+    validationLogRepository: ProviderSpec<PromoCodeValidationLogRepository>;
+    firstTimeCustomerCheck: ProviderSpec<FirstTimeCustomerCheck>;
+    subscriptionLookup: ProviderSpec<PromoSubscriptionLookup>;
+    revenueAggregator: ProviderSpec<PromoRevenueDeductionAggregator>;
+    transactionRunner: ProviderSpec<TransactionRunner>;
+    config?: PromoServiceConfig;
+    /**
+     * Default `true`. Set to `false` if the consumer wants to disable the cron
+     * (e.g. CLI boot, test setups without ScheduleModule).
+     */
+    includeExpirerCron?: boolean;
+    /**
+     * Default `true`. Registers `PromoCodePublicController` with
+     * `POST /billing/promo/preview`. Set to `false` if the consumer does not
+     * want to expose a public preview API (e.g. SuperAdmin-only deploy).
+     */
+    includePublicController?: boolean;
+    /** Register the module globally — default `false`. */
+    global?: boolean;
+}
+declare class PromoCodesModule {
+    static forRoot(options: PromoCodesModuleOptions): DynamicModule;
+}
+
+export { PROMO_CODE_REDEMPTION_REPOSITORY_TOKEN, PROMO_CODE_REPOSITORY_TOKEN, PROMO_CODE_VALIDATION_LOG_REPOSITORY_TOKEN, PROMO_FIRST_TIME_CUSTOMER_CHECK_TOKEN, PROMO_REVENUE_DEDUCTION_AGGREGATOR_TOKEN, PROMO_SERVICE_CONFIG_TOKEN, PROMO_SUBSCRIPTION_LOOKUP_TOKEN, PROMO_TRANSACTION_RUNNER_TOKEN, PreviewPromoCodeDto, PreviewResult, PromoCodeExpirer, type PromoCodeForCalc, PromoCodePublicController, PromoCodeRateLimitGuard, PromoCodesModule, type PromoCodesModuleOptions, PromoCodesService, PromoServiceConfig, addCycles, buildLabel, computeDiscountGross, computeDiscountedGross, computeIncludedVat, computeRegularStartsAt, grossFromNet, hashIp, ipFingerprint, round2 };

package/dist/promo/index.js

@@ -0,0 +1,58 @@
+import {
+  PreviewPromoCodeDto,
+  PromoCodeExpirer,
+  PromoCodePublicController,
+  PromoCodeRateLimitGuard,
+  PromoCodesModule,
+  hashIp,
+  ipFingerprint
+} from "../chunk-2VNZYRDV.js";
+import {
+  PROMO_CODE_REDEMPTION_REPOSITORY_TOKEN,
+  PROMO_CODE_REPOSITORY_TOKEN,
+  PROMO_CODE_VALIDATION_LOG_REPOSITORY_TOKEN,
+  PROMO_FIRST_TIME_CUSTOMER_CHECK_TOKEN,
+  PROMO_REVENUE_DEDUCTION_AGGREGATOR_TOKEN,
+  PROMO_SERVICE_CONFIG_TOKEN,
+  PROMO_SUBSCRIPTION_LOOKUP_TOKEN,
+  PROMO_TRANSACTION_RUNNER_TOKEN,
+  PromoCodesService,
+  addCycles,
+  buildLabel,
+  computeDiscountGross,
+  computeDiscountedGross,
+  computeRegularStartsAt
+} from "../chunk-ZL4LLE2Z.js";
+import {
+  computeIncludedVat,
+  grossFromNet,
+  round2
+} from "../chunk-MV6LW5UB.js";
+import "../chunk-SABTXESR.js";
+import "../chunk-SHUYVCID.js";
+export {
+  PROMO_CODE_REDEMPTION_REPOSITORY_TOKEN,
+  PROMO_CODE_REPOSITORY_TOKEN,
+  PROMO_CODE_VALIDATION_LOG_REPOSITORY_TOKEN,
+  PROMO_FIRST_TIME_CUSTOMER_CHECK_TOKEN,
+  PROMO_REVENUE_DEDUCTION_AGGREGATOR_TOKEN,
+  PROMO_SERVICE_CONFIG_TOKEN,
+  PROMO_SUBSCRIPTION_LOOKUP_TOKEN,
+  PROMO_TRANSACTION_RUNNER_TOKEN,
+  PreviewPromoCodeDto,
+  PromoCodeExpirer,
+  PromoCodePublicController,
+  PromoCodeRateLimitGuard,
+  PromoCodesModule,
+  PromoCodesService,
+  addCycles,
+  buildLabel,
+  computeDiscountGross,
+  computeDiscountedGross,
+  computeIncludedVat,
+  computeRegularStartsAt,
+  grossFromNet,
+  hashIp,
+  ipFingerprint,
+  round2
+};