@openlup/platform 0.21.0 → 0.23.0

package/dist/subscriptions/contracts/commands.d.ts

@@ -0,0 +1,115 @@
+export interface SubscriptionCommandContext {
+    actor: {
+        kind: "customer" | "operator";
+        actorId: string;
+        clientId: string;
+    };
+    subscriptionId: string;
+    idempotencyKey: string;
+    now: string;
+}
+export type SubscriptionCommand = SubscriptionCommandContext & ({
+    action: "pause";
+    pausePreset: string;
+    reason: string | null;
+    survey: string | null;
+    saveOffer: string | null;
+} | {
+    action: "resume" | "skip" | "cancel";
+    reason: string | null;
+    confirmedChargeTiming: boolean;
+} | {
+    action: "slide";
+    newNextCycleAt: string;
+    confirmedChargeTiming: boolean;
+} | {
+    action: "edit_future_terms";
+    shippingAddressId: string;
+    planDays: number;
+    cadenceDays: number;
+    expectedTemplateVersion: number;
+    acceptedQuoteHash: string;
+    confirmedChargeTiming: boolean;
+    coreLines: readonly SubscriptionBundleLine[];
+    addonLines: readonly SubscriptionBundleLine[];
+    compositionConstraint: string;
+});
+export interface SubscriptionBundleLine {
+    sku: string;
+    quantity: number;
+}
+export interface SubscriptionCommandReceipt {
+    actorId: string;
+    idempotencyKey: string;
+    commandFingerprint: string;
+    outcome: "applied" | "replayed" | "noop";
+    subscriptionId: string;
+    originalState: string;
+    nextCycleAt: string | null;
+    revision: string;
+    eventId: string | null;
+}
+export type SubscriptionUnsupportedCode = "multi_cycle_prepaid_unsupported" | "native_generic_bundle_commands_unsupported" | "native_command_bound_receipts_unsupported" | "native_prepared_attempt_store_unsupported";
+export interface SubscriptionUnsupported {
+    supported: false;
+    refusalCode: SubscriptionUnsupportedCode;
+}
+/** Readiness must be selected explicitly; a port declaration does not install a store. */
+export interface SubscriptionCapabilities {
+    graph: "managed" | "native";
+    multiCyclePrepaid: {
+        supported: false;
+        refusalCode: "multi_cycle_prepaid_unsupported";
+    };
+    genericBundleCommands: {
+        supported: true;
+    } | {
+        supported: false;
+        refusalCode: "native_generic_bundle_commands_unsupported";
+    };
+    commandBoundReceipts: {
+        supported: true;
+    } | {
+        supported: false;
+        refusalCode: "native_command_bound_receipts_unsupported";
+    };
+    preparedAttemptStore: {
+        supported: true;
+    } | {
+        supported: false;
+        refusalCode: "native_prepared_attempt_store_unsupported";
+    };
+    retryRecovery: "unavailable" | "selected";
+    stockRecovery: "unavailable" | "selected";
+    deliveryAdmission: "required";
+    executorCount: 1;
+    defaultEnabled: false;
+}
+export interface SubscriptionCommandPort {
+    readonly capabilities: SubscriptionCapabilities;
+    /** Future term writes, actor/command receipt and events must commit atomically. */
+    apply(command: SubscriptionCommand): Promise<SubscriptionCommandReceipt | SubscriptionUnsupported>;
+}
+export interface SubscriptionActivationPort {
+    activate(input: {
+        idempotencyKey: string;
+        orderId: string;
+        paymentIntentId: string;
+        paidEvidenceRef: string;
+        paidAt: string;
+        paymentMethodRef: string;
+        paymentMethodKind: string;
+        checkoutKind: string;
+    }): Promise<{
+        outcome: "noop" | "blocked";
+        reason: string;
+    } | {
+        outcome: "active";
+        subscriptionId: string;
+        orderId: string;
+        paymentIntentId: string;
+        nextCycleAt: string;
+        cadenceDays: number;
+        replayed: boolean;
+    }>;
+}

package/dist/subscriptions/contracts/commands.js

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

package/dist/subscriptions/contracts/dunning.d.ts

@@ -0,0 +1,133 @@
+export interface DunningCaseOpenInput {
+    idempotencyKey: string;
+    subscriptionId: string;
+    cycleId: string | null;
+    clientId: string;
+    retryAttempt: number;
+    nextRetryAt: string | null;
+    failureClass: string | null;
+    failureReason: string | null;
+    occurredAt: string;
+    amountMinor: number | null;
+    currency: string | null;
+    templateSlug: string;
+    recoveryUrlPath: string | null;
+}
+export interface DunningCaseOpened {
+    caseId: string;
+    caseStatus: string;
+    replayed: boolean;
+    notificationId: string | null;
+}
+export interface DunningCaseAdvanced {
+    caseId: string;
+    caseStatus: string;
+    notificationId: string | null;
+    retryAttempt: number | null;
+    paused: false;
+    pauseWindowId: null;
+    terminal: boolean;
+}
+export type DunningRefusalCode = "case_not_open" | "recoverable_order_unavailable";
+export interface DunningCaseLifecyclePort {
+    openCase(input: DunningCaseOpenInput): Promise<DunningCaseOpened>;
+    recordFailedAttempt(input: {
+        caseId: string;
+        occurredAt: string;
+        failureClass: string | null;
+        failureReason: string | null;
+        retryAttempt: number;
+        nextRetryAt: string | null;
+        templateSlug: string;
+        recoveryUrlPath: string | null;
+    }): Promise<DunningCaseAdvanced>;
+    recordRecovery(input: {
+        caseId: string;
+        recoveredAt: string;
+        templateSlug: string;
+    }): Promise<{
+        outcome: "recovered";
+        caseId: string;
+        caseStatus: string;
+        replayed: boolean;
+        notificationId: string | null;
+    } | {
+        outcome: "refused";
+        caseId: string;
+        caseStatus: string;
+        refusalCode: DunningRefusalCode;
+    }>;
+    issueRecoveryLink(input: {
+        caseId: string;
+        tokenHash: string;
+        expiresAt: string;
+    }): Promise<{
+        outcome: "issued";
+        orderId: string;
+    } | {
+        outcome: "refused";
+        refusalCode: DunningRefusalCode;
+    }>;
+}
+export interface RenewalRetryState {
+    rowPresent: boolean;
+    retryAttempt: number | null;
+    nextRetryAt: string | null;
+}
+export interface RenewalRetryObligation {
+    operationId: string;
+    subscriptionId: string;
+    cycleId: string;
+    orderId: string;
+    settlementIntentId: string;
+    logicalCycleNumber: number;
+    nativeRenewalCounter: number;
+    retryAttempt: number;
+    externalAttemptSequence: number;
+    nextRetryAt: string | null;
+    failureClass: string | null;
+    failureReason: string | null;
+    occurredAt: string;
+    identityKey: string;
+    requestFingerprint: string;
+    disposition: "retry_scheduled" | "payment_failed" | "paid";
+}
+export interface RenewalRecoveryAuthorization {
+    tokenId: string;
+    tokenHash: string;
+    caseId: string;
+    clientId: string;
+    authUserId: string | null;
+    subscriptionId: string;
+    cycleId: string;
+    orderId: string;
+    payerAccountRef: string | null;
+    purpose: "repair_payment" | "resume_subscription";
+    retryAttempt: number;
+    paymentMethodRef: string;
+    paymentMethodKind: string;
+    expiresAt: string;
+    usedAt: string | null;
+    revokedAt: string | null;
+    requestedAt: string;
+}
+export interface RenewalFailureHandoffPort {
+    handoffFailure(input: {
+        idempotencyKey: string;
+        subscriptionId: string;
+        clientId: string;
+        cycleId: string;
+        orderId: string;
+        paymentIntentId: string;
+        retryAttempt: number;
+        failureClass: string;
+        failureReason: string;
+        nextRetryAt: string | null;
+        occurredAt: string;
+        amountMinor: number | null;
+        currency: string | null;
+    }): Promise<{
+        caseId: string | null;
+        replayed: boolean;
+    }>;
+}

package/dist/subscriptions/contracts/dunning.js

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

package/dist/subscriptions/contracts/index.d.ts

@@ -0,0 +1,6 @@
+export type { RenewalSchedule, RenewalIdentity, RenewalAdmission, RenewalLine, RenewalCycleCorrelation, RenewalTemplateSnapshot, RenewalPricingSnapshot, RenewalOrderSnapshot, RenewalFrozenSnapshot, RenewalDue, RenewalOperationState, RenewalReadback, RenewalPaymentEvidence, RenewalTransactionUnits, RenewalReservationResult, RenewalPreparedSettlement, RenewalStorePort, RenewalSettlementPort, RenewalExecutionRequest, RenewalPaymentRail, RenewalResult } from "./renewal.js";
+export type { DunningCaseOpenInput, DunningCaseOpened, DunningCaseAdvanced, DunningRefusalCode, DunningCaseLifecyclePort, RenewalRetryState, RenewalRetryObligation, RenewalRecoveryAuthorization, RenewalFailureHandoffPort } from "./dunning.js";
+export type { StockWaitRecoveryBinding, StockWaitDeficit, StockWaitCase, StockWaitStorePort } from "./stockWait.js";
+export type { SubscriptionCommandContext, SubscriptionCommand, SubscriptionBundleLine, SubscriptionCommandReceipt, SubscriptionUnsupportedCode, SubscriptionUnsupported, SubscriptionCapabilities, SubscriptionCommandPort, SubscriptionActivationPort } from "./commands.js";
+export type { SubscriptionLifecycleFact, SubscriptionLifecycleMessageDescriptor, SubscriptionLifecycleMessagePort } from "./messages.js";
+export type { SubscriptionRenewalOutcome, HostedRenewalDue, SubscriptionRenewalChargeResult, SubscriptionCycleSnapshotResult, SubscriptionCycleOrderInput, SubscriptionCycleOrderResult, SubscriptionReservationPreflightResult, SubscriptionRenewalPersistencePort, FailurePropagationKind, FailurePropagationContext, CycleRetryState, DunningCaseOpenOutcome, CycleChargeFailurePropagationPort, FailurePropagationResult, RenewalPrepareInput, RenewalAttemptResult, RenewalIntentResult, RenewalPaymentPort, RenewalExecutionPort, RenewalDeliveryAdmission, RenewalAllowedAdmission, RenewalDeliveryClient, RenewalFailureDeps, RenewalPreflightDeps, RenewalCycleDeps, RenewalExecutionContext, RenewalOutcomeContext, RenewalReplayContext, RenewalPreparedAttemptPrepareInput, RenewalPreparedAttemptPersistenceResult, RenewalPreparedAttemptFinalizeInput, RenewalPreparedAttemptPersistencePort } from "./renewal.js";

package/dist/subscriptions/contracts/index.js

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

package/dist/subscriptions/contracts/messages.d.ts

@@ -0,0 +1,43 @@
+export type SubscriptionLifecycleFact = {
+    factId: string;
+    idempotencyKey: string;
+    subscriptionId: string;
+    clientId: string;
+    cycleId: string | null;
+    caseId: string | null;
+    orderId: string | null;
+    occurredAt: string;
+    firstRecordedAt: string;
+} & ({
+    kind: "payment_failed" | "payment_expired";
+    retryAttempt: number;
+    nextRetryAt: string | null;
+    failureClass: string | null;
+    amountMinor: number | null;
+    currency: string | null;
+} | {
+    kind: "payment_recovered";
+    paymentEvidenceRef: string;
+} | {
+    kind: "stock_wait_started" | "stock_wait_resumed";
+    frozenFingerprint: string;
+} | {
+    kind: "winback_eligible";
+    cancelledAt: string;
+    paymentMethodRef: string;
+});
+/** M04 receives a descriptor; host owns copy, recipient, consent and transport. */
+export interface SubscriptionLifecycleMessageDescriptor {
+    fact: SubscriptionLifecycleFact;
+    messageKey: string;
+    templateSlug: string;
+    recipientRef: string;
+    locale: string;
+    recoveryUrlPath: string | null;
+}
+export interface SubscriptionLifecycleMessagePort {
+    enqueue(descriptor: SubscriptionLifecycleMessageDescriptor): Promise<{
+        notificationId: string;
+        replayed: boolean;
+    }>;
+}

package/dist/subscriptions/contracts/messages.js

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