@openlup/platform 0.27.0 → 0.28.0

package/dist/account-support/contracts/commands.d.ts

@@ -0,0 +1,307 @@
+import type { CustomerContext } from "./account.js";
+import type { AccountSupportCapabilities, AccountSupportLaneUnavailable } from "./capabilities.js";
+/** Local transcriptions of owner contracts; portFit checks equality against the owners. */
+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;
+    /** Empty string means no quote (semantic no-op). */
+    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 interface SubscriptionCommandRefusal {
+    outcome: "refused";
+    /** Stable machine code; never provider, PostgreSQL diagnostic or customer text.
+     * Unrecognized native or host diagnostics map to subscription_command_invalid_input. */
+    reason: "multi_cycle_prepaid_unsupported" | "subscription_command_addon_not_found" | "subscription_command_bundle_total_mismatch" | "subscription_command_charge_timing_not_confirmed" | "subscription_command_idempotency_conflict" | "subscription_command_invalid_composition_constraint" | "subscription_command_invalid_input" | "subscription_command_not_active" | "subscription_command_operation_busy" | "subscription_command_pause_forbidden" | "subscription_command_payment_blocked" | "subscription_command_preview_unsupported" | "subscription_command_renewal_terms_missing" | "subscription_command_unsupported_action" | "subscription_edit_catalog_unavailable" | "subscription_edit_invalid_lines" | "subscription_edit_invalid_request" | "subscription_edit_quote_expired" | "subscription_edit_quote_required" | "subscription_edit_stale_template" | "subscription_edit_window_closed" | "subscription_lifecycle_invalid_transition" | "subscription_lifecycle_invalid_skip" | "subscription_lifecycle_invalid_slide" | "subscription_lifecycle_payment_blocked";
+}
+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;
+}
+/** Exact raw native owner command; its result still requires a host codec. */
+export interface NativeSubscriptionCommand {
+    actorId: string;
+    clientId: string;
+    idempotencyKey: string;
+    subscriptionId: string;
+    action: string;
+    payload: Record<string, unknown>;
+    now: string;
+}
+/** Driver DTOs are explicit type arguments, never a claim that all graphs implement them. */
+export interface SelfServiceCommandFacade<ManagedRequest, ManagedPreviewRequest, ManagedPreview, ManagedReceipt, ProfileRequest, ProfileResult, MethodRequest, MethodResult, CommerceRequest, CommerceResult, RecoveryRequest, RecoveryResult, ControlSnapshot = unknown> {
+    capabilities: AccountSupportCapabilities;
+    managedSubscription: {
+        previewAction(userId: string, request: ManagedPreviewRequest): Promise<ManagedPreview | null | AccountSupportLaneUnavailable<"host_binding_required">>;
+        applyAction(userId: string, request: ManagedRequest): Promise<ManagedReceipt | null | AccountSupportLaneUnavailable<"host_binding_required">>;
+    };
+    nativeLegacySubscription: {
+        previewAction(userId: string, request: ManagedPreviewRequest): Promise<ManagedPreview | null | AccountSupportLaneUnavailable<"host_binding_required">>;
+        applyAction(userId: string, request: ManagedRequest): Promise<ManagedReceipt | null | AccountSupportLaneUnavailable<"host_binding_required">>;
+    };
+    subscriptionControl: {
+        getSnapshot(userId: string): Promise<ControlSnapshot | AccountSupportLaneUnavailable<"host_binding_required">>;
+    };
+    nativeRawSubscription: {
+        preview(command: NativeSubscriptionCommand): Promise<Record<string, unknown> | AccountSupportLaneUnavailable<"host_binding_required">>;
+        apply(command: NativeSubscriptionCommand): Promise<Record<string, unknown> | AccountSupportLaneUnavailable<"host_binding_required">>;
+    };
+    nativeSubscription: {
+        apply(command: SubscriptionCommand): Promise<SubscriptionCommandReceipt | SubscriptionCommandRefusal | SubscriptionUnsupported | AccountSupportLaneUnavailable<"host_binding_required">>;
+        preview(command: Extract<SubscriptionCommand, {
+            action: "edit_future_terms";
+        }>): Promise<Record<string, unknown> | SubscriptionCommandRefusal | AccountSupportLaneUnavailable<"host_binding_required">>;
+    };
+    profile: {
+        updateProfile(userId: string, request: ProfileRequest): Promise<ProfileResult | null | AccountSupportLaneUnavailable<"host_binding_required">>;
+    };
+    paymentMethod: {
+        execute(userId: string, request: MethodRequest): Promise<MethodResult | AccountSupportLaneUnavailable<"unsupported">>;
+    };
+    commerce: {
+        execute(userId: string, request: CommerceRequest): Promise<CommerceResult | AccountSupportLaneUnavailable<"host_binding_required">>;
+    };
+    recovery: {
+        startPaymentRecovery(userId: string, request: RecoveryRequest): Promise<RecoveryResult | null | AccountSupportLaneUnavailable<"host_binding_required">>;
+    };
+}
+export interface AccountSupportMoney {
+    amountMinor: number;
+    currency: string;
+}
+export type SubscriptionPaymentMethodStatus = "usable" | "expiring" | "missing" | "revoked" | "requires_action" | "invalid" | "provider_disabled";
+export type SubscriptionRenewalBlockStatus = "blocked_preflight" | "payment_pending" | "dunning" | "paid_fulfillment_pending" | "fulfillment_blocked" | "catalog_blocked" | "customer_action_required";
+export type EligibilityRefusal = "not_active" | "edit_window_closed" | "cycle_locked" | "payment_blocked" | "missing_payment_method" | "invalid_address" | null;
+export interface LegacySubscriptionPreviewResponse {
+    preview: {
+        subscriptionId: string;
+        action: string;
+        canApply: boolean;
+        blockedReason: EligibilityRefusal;
+        nextCycleAt: string | null;
+        editCutoffAt: string | null;
+        templateVersion: number | null;
+        lockedCycle?: {
+            locked: boolean;
+            status: SubscriptionRenewalBlockStatus | null;
+        };
+        futureTemplate?: {
+            templateVersion: number | null;
+            effectiveCycleAt: string | null;
+            priceAgreementPolicy: "lock_until_edit";
+        };
+        paymentMethodStatus?: SubscriptionPaymentMethodStatus;
+        deliverability?: {
+            status: "address_book_validated" | "blocked" | "unknown";
+            blockedReason: EligibilityRefusal;
+        };
+        catalogAvailability?: {
+            status: "available" | "blocked" | "unknown";
+            blockedReason: EligibilityRefusal;
+        };
+        quoteHash?: string;
+        quoteExpiresAt?: string;
+        currentTotal?: AccountSupportMoney;
+        newTotal?: AccountSupportMoney;
+        delta?: AccountSupportMoney;
+        chargeTiming?: {
+            requiresConfirmation: boolean;
+            confirmed: boolean;
+            earliestChargeAt: string | null;
+        };
+        dateAvailability?: {
+            earliestAllowedAt: string;
+            latestAllowedAt: string;
+            availableDates: string[];
+            blockedReason: EligibilityRefusal;
+        };
+        packageEdit?: {
+            currentRecurringPrice: AccountSupportMoney;
+            newRecurringPrice: AccountSupportMoney;
+            delta: AccountSupportMoney;
+            quoteHash: string;
+            effectiveCycleAt: string | null;
+            priceAgreementPolicy: "lock_until_edit";
+        };
+    };
+}
+/** Already resolved host request. The codec never supplies policy or catalogue fields. */
+export interface LegacySubscriptionRequest<Action extends string = string, Payload extends Record<string, unknown> = Record<string, unknown>> {
+    subscriptionId: string;
+    idempotencyKey: string;
+    action: Action;
+    payload: Payload;
+}
+export interface RawSubscriptionCommands {
+    preview(command: NativeSubscriptionCommand): Promise<Record<string, unknown>>;
+    apply(command: NativeSubscriptionCommand): Promise<Record<string, unknown>>;
+}
+/** Only checked native quote records reach a host projection. */
+export interface NativeSubscriptionPreview extends Record<string, unknown> {
+    status: "previewed";
+    canApply: true;
+    templateVersion: number;
+    quoteHash: string;
+    quoteExpiresAt: string;
+    currentTotalMinor: number;
+    newTotalMinor: number;
+    lines: {
+        variantId: string;
+        quantity: number;
+        isAddon: boolean;
+        sortOrder: number;
+        unitPriceMinor: number;
+        currency: string;
+    }[];
+    priceAgreementPolicy: {
+        kind: "lock_until_edit";
+        proration: "none";
+        cycleEffect: "future_unlocked_cycles_only";
+    };
+}
+export type NativePreviewProjection<Preview> = {
+    kind: "projected";
+    preview: Preview;
+} | {
+    kind: "owner";
+    result: Record<string, unknown>;
+};
+export interface SubscriptionDriver<Request, Preview, Receipt> {
+    preview(context: CustomerContext, request: Request): Promise<Preview>;
+    apply(context: CustomerContext, request: Request): Promise<Receipt>;
+}
+/** Browser-safe transcription of M07 collection; instantiate with its branded handoff. */
+export interface MethodSetupInput {
+    customer: string;
+    metadata: Record<string, string>;
+    idempotencyKey: string;
+}
+export type MethodSetupResult<Handoff> = {
+    kind: "ready";
+    setupRef: string;
+    handoff: Handoff;
+    replayed: boolean;
+} | {
+    kind: "unsupported";
+};
+export interface MethodSetupPort<Handoff> {
+    setupMethod(input: MethodSetupInput): Promise<MethodSetupResult<Handoff>>;
+}
+/** Host parts retain repricing, quote validation, authorization and error construction. */
+export interface NativeLegacySubscriptionParts<Request, PreviewRequest, Preview, Receipt, ControlSnapshot = unknown> {
+    explicitPause: {
+        applyAction(userId: string, request: Request): Promise<Receipt | null>;
+    };
+    control: LegacySubscriptionPort<Request, PreviewRequest, Preview, Receipt> & {
+        hasSubscription(userId: string, subscriptionId: string): Promise<boolean>;
+        getSnapshot(userId: string): Promise<ControlSnapshot>;
+    };
+    ownershipRefusal(): unknown;
+}
+export interface LegacySubscriptionPort<Request, PreviewRequest, Preview, Receipt> {
+    previewAction(userId: string, request: PreviewRequest): Promise<Preview | null>;
+    applyAction(userId: string, request: Request): Promise<Receipt | null>;
+}
+/** The host supplies capabilities and explicitly selects each owner lane. */
+export type SelfServiceCommandFacadeInput<Request, PreviewRequest, Preview, Receipt, ProfileRequest, ProfileResult, MethodRequest, MethodResult, CommerceRequest, CommerceResult, RecoveryRequest, RecoveryResult, ControlSnapshot = unknown> = {
+    context: CustomerContext;
+    capabilities: AccountSupportCapabilities;
+    managedSubscription?: LegacySubscriptionPort<Request, PreviewRequest, Preview, Receipt>;
+    nativeLegacySubscription?: NativeLegacySubscriptionParts<Request, PreviewRequest, Preview, Receipt, ControlSnapshot>;
+    nativeRawSubscription?: RawSubscriptionCommands;
+    nativeSubscription?: {
+        apply(command: SubscriptionCommand): Promise<SubscriptionCommandReceipt | SubscriptionCommandRefusal | SubscriptionUnsupported>;
+        preview(command: Extract<SubscriptionCommand, {
+            action: "edit_future_terms";
+        }>): Promise<Record<string, unknown> | SubscriptionCommandRefusal>;
+    };
+    profile?: {
+        updateProfile(userId: string, request: ProfileRequest): Promise<ProfileResult | null>;
+    };
+    paymentMethod?: {
+        execute(userId: string, request: MethodRequest): Promise<MethodResult>;
+    };
+    commerce?: {
+        execute(userId: string, request: CommerceRequest): Promise<CommerceResult>;
+    };
+    recovery?: {
+        startPaymentRecovery(userId: string, request: RecoveryRequest): Promise<RecoveryResult | null>;
+    };
+};

package/dist/account-support/contracts/commands.js

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

package/dist/account-support/contracts/customer360.d.ts

@@ -0,0 +1,154 @@
+/** Verified human administrator context, supplied by the host. */
+export interface OperatorContext {
+    operatorId: string;
+    role: "admin";
+    isMachineActor: false;
+    graph: "managed" | "native";
+}
+/** Verbatim parsed customer-360 lookup vocabulary; defaults belong to the host codec. */
+export interface Customer360Lookup {
+    query?: string;
+    subjectId?: string;
+    orderId?: string;
+    subscriptionId?: string;
+    email?: string;
+    pageSize: number;
+    mode?: "search" | "snapshot";
+}
+/** The supplied search/snapshot DTOs preserve owner coverage and omitted enrichments. */
+export interface Customer360ReadPort<Search, Snapshot> {
+    searchCustomerJourney(request: Customer360Lookup): Promise<Search>;
+    getCustomerJourney(request: Customer360Lookup): Promise<Snapshot | null>;
+}
+export type Customer360LifecycleStage = "lead" | "waitlist" | "tester" | "customer" | "inactive";
+export interface Customer360Subject {
+    subjectId: string;
+    displayName: string | null;
+    email: string | null;
+    phone?: string | null;
+    lifecycleStage: Customer360LifecycleStage;
+    lifecycle: {
+        stage: Customer360LifecycleStage;
+        enteredAt: string | null;
+        exitedAt: string | null;
+    }[];
+    firstSeenAt: string | null;
+    lastActivityAt: string | null;
+    authUserLinked?: boolean;
+    hasSignedIn?: boolean;
+}
+export interface Customer360Order {
+    orderId: string;
+    orderNumber: string | null;
+    status: string;
+    subscriptionId: string | null;
+    totalMinor: number | null;
+    currency: string | null;
+    createdAt: string | null;
+}
+export interface Customer360Subscription {
+    subscriptionId: string;
+    status: string;
+    nextCycleAt: string | null;
+    latestOrderId: string | null;
+    templateVersion?: number;
+    shippingAddressId?: string | null;
+    paymentMethodKind?: string | null;
+    paymentMethodStatus?: string | null;
+}
+export interface Customer360PaymentTruth {
+    orderId: string;
+    status: string;
+    recoverable: boolean;
+    amountMinor: number | null;
+    currency: string | null;
+    lastAttemptAt: string | null;
+}
+export interface Customer360DunningCase {
+    caseId: string;
+    subscriptionId: string;
+    orderId: string | null;
+    status: string;
+    retryAttempt: number;
+    nextRetryAt: string | null;
+    notificationStatus: string | null;
+    recoveryAvailable: boolean;
+}
+export interface Customer360Recovery {
+    caseId: string;
+    status: "available" | "unavailable";
+    actionAvailable: boolean;
+    lastIssuedAt: string | null;
+    lastDeliveryStatus: string | null;
+}
+export interface Customer360ContactHealth {
+    lastTerminalStatus: "delivered" | "bounced" | "complained" | "failed" | null;
+    lastTerminalAt: string | null;
+    reachable: boolean;
+}
+export interface Customer360Address {
+    addressId: string;
+    label: string | null;
+    recipientName: string | null;
+    line1: string;
+    line2: string | null;
+    postalCode: string;
+    city: string;
+    country: string;
+    contactPhone: string | null;
+    isDefault: boolean;
+    kind: "shipping" | "both";
+}
+export interface Customer360AuditEvent {
+    eventId: string;
+    occurredAt: string;
+    action: string;
+    outcome: string;
+    entity: {
+        kind: "subject" | "order" | "subscription" | "dunning_case" | "recovery";
+        id: string;
+    };
+}
+export interface Customer360LookupResult {
+    query: string;
+    matchedBy: "subject_id" | "email" | "order_id" | "order_number" | "subscription_id" | "text";
+    confidence: "exact" | "high" | "medium";
+    warnings: string[];
+}
+export interface Customer360SearchResponse {
+    contractVersion: "support.customer_360.v2";
+    query: string;
+    candidates: {
+        subjectId: string;
+        displayName: string | null;
+        email: string | null;
+        lifecycleStage: Customer360LifecycleStage;
+        matchedBy: Customer360LookupResult["matchedBy"];
+        confidence: Customer360LookupResult["confidence"];
+        lastActivityAt: string | null;
+        snapshotLookup: {
+            subjectId: string;
+        };
+    }[];
+    warnings: string[];
+}
+export interface Customer360Snapshot<Extension = unknown> {
+    contractVersion: "support.customer_360.v2";
+    lookup: Customer360LookupResult;
+    subject: Customer360Subject;
+    orders: Customer360Order[];
+    subscriptions: Customer360Subscription[];
+    payment: Customer360PaymentTruth[];
+    dunningCases: Customer360DunningCase[];
+    recovery: Customer360Recovery[];
+    auditTrail: Customer360AuditEvent[];
+    contactHealth?: Customer360ContactHealth;
+    addresses?: Customer360Address[];
+    extension?: Extension;
+}
+export interface Customer360SummaryReadPort<Request, Result> {
+    getPortableSummary(request: Request): Promise<Result>;
+}
+export interface DiagnosticHistoryReadPort<Request, Result> {
+    history(request: Request): Promise<Result>;
+}

package/dist/account-support/contracts/customer360.js

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

package/dist/account-support/contracts/index.d.ts

@@ -0,0 +1,10 @@
+export type { CustomerContext, AccountReadRefusal, AccountReadPort, AccountProfile, AccountAddress, AccountBillingProfile, AccountPaymentPreference, AccountPickupPoint, AccountDeliverySelection, AccountDeliveryPreference, AccountEvent, AccountSubscriptionLine, AccountSubscription, AccountTrackingReference, AccountTrackingEvent, AccountInvoiceSummary, AccountInvoiceDocument, AccountOrderSummary, AccountOrderLine, AccountFulfillmentSummary, AccountOrderDetail, AccountOrderList, AccountOrderDetailResponse, AccountActionRequired, AccountActionMessage, AccountSnapshot } from "./account.js";
+export type { OperatorContext, Customer360Lookup, Customer360ReadPort, Customer360LifecycleStage, Customer360Subject, Customer360Order, Customer360Subscription, Customer360PaymentTruth, Customer360DunningCase, Customer360Recovery, Customer360ContactHealth, Customer360Address, Customer360AuditEvent, Customer360LookupResult, Customer360SearchResponse, Customer360Snapshot, Customer360SummaryReadPort, DiagnosticHistoryReadPort } from "./customer360.js";
+export type { SubscriptionCommandContext, SubscriptionCommand, SubscriptionBundleLine, SubscriptionCommandReceipt, SubscriptionCommandRefusal, SubscriptionUnsupportedCode, SubscriptionUnsupported, SubscriptionCapabilities, NativeSubscriptionCommand, SelfServiceCommandFacade, AccountSupportMoney, SubscriptionPaymentMethodStatus, SubscriptionRenewalBlockStatus, EligibilityRefusal, LegacySubscriptionPreviewResponse } from "./commands.js";
+export type { OperatorSubscriptionAction, OperatorNewShippingAddress, OperatorShippingAddressPayload, OperatorSubscriptionPayload, OperatorSubscriptionRefusal, RecoveryRefusal, EmailCorrectionRefusal, PhoneCorrectionRefusal, LeadRefusal, OperatorContactCommand, OperatorLeadCommand, OperatorRecoveryCommand, OperatorRecoveryCommandEnvelope, OperatorSubscriptionResult } from "./operator.js";
+export type { InvoiceDocumentIdentity, InvoiceUnsupported, InvoiceClearanceState, InvoiceAccessPort, CustomerDocumentDeliveryStatus, CustomerInvoiceDocumentRole, CustomerInvoiceDownloadArtifact, CustomerInvoiceDownloadRequest, AccountInvoiceHistoryResult, AccountInvoiceHistoryDocument } from "./invoice.js";
+export type { AccountSupportCapability, AccountSupportCapabilities } from "./capabilities.js";
+export type { LegacySubscriptionRequest, RawSubscriptionCommands, NativeSubscriptionPreview, NativePreviewProjection, SubscriptionDriver, MethodSetupInput, MethodSetupResult, MethodSetupPort, NativeLegacySubscriptionParts, LegacySubscriptionPort, SelfServiceCommandFacadeInput } from "./commands.js";
+export type { AccountSupportLaneUnavailable } from "./capabilities.js";
+export type { OperatorOwnerReceipt, NativeOperatorSubscriptionResult, OperatorAuthorityUnavailable, OperatorEmailCorrectionResult, OperatorPhoneCorrectionResult, CustomerRecoveryAuthorityResult, LeadAbsorptionCarried, OperatorLeadAbsorptionResult, OperatorEmailCorrectionClaim, OperatorIdentityMovePort, OperatorEmailCorrectionAdmission, OperatorEmailCorrectionPhase, OperatorEmailCorrectionSettlement, OperatorEmailCorrectionExecution, OperatorAccountLinkRefusal, OperatorAccountLinkResult, OperatorAccountLinkRequest, OperatorAccountLinkIdentityPort, OperatorSubscriptionInput, OperatorEmailInput, OperatorPhoneInput, OperatorLinkInput, OperatorRecoveryInput, OperatorAbsorptionInput, ManagedOperatorAuthorityPort, NativeOperatorAuthorityPort, LinkThenSubscriptionResult } from "./operator.js";
+export type { OperatorAuthorityCapabilities } from "./capabilities.js";

package/dist/account-support/contracts/index.js

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

package/dist/account-support/contracts/invoice.d.ts

@@ -0,0 +1,79 @@
+/** Exact browser-safe transcriptions of M09 account-history inputs and outcomes. */
+export interface InvoiceDocumentIdentity {
+    readonly providerRef: string;
+    readonly documentRef: string;
+    readonly providerDocumentRef: string | null;
+    readonly orderRef: string;
+    readonly invoiceRef: string;
+    readonly parentProviderDocumentRef: string | null;
+}
+export interface InvoiceUnsupported {
+    readonly kind: "unsupported";
+    readonly code: "host_binding_required" | "unsupported";
+    readonly retryable: false;
+    readonly effectMayHaveSucceeded: false;
+}
+export type InvoiceClearanceState = "accepted" | "not_submitted" | "pending" | "rejected" | "not_required" | "unsupported";
+export type InvoiceAccessPort = {
+    read(input: {
+        readonly accountRef: string;
+        readonly orderId: string;
+    }): Promise<{
+        readonly kind: "found";
+        readonly accountRef: string;
+        readonly orderId: string;
+        readonly documents: readonly {
+            readonly documentRef: string;
+            readonly invoiceRef: string;
+            readonly parentDocumentRef: string | null;
+            readonly role: "original" | "correction" | "replacement";
+            readonly status: string;
+            readonly issuedAt: string | null;
+            readonly clearance: {
+                readonly state: InvoiceClearanceState;
+                readonly reference: string | null;
+            } | null;
+            readonly documentKind: string | null;
+            readonly artifact: "invoice" | "correction";
+            readonly providerDocumentNumber: string | null;
+            readonly totalGrossMinor: number | null;
+            readonly currency: string;
+            readonly emailState: "not_requested" | "pending" | "provider_accepted" | "failed";
+            readonly isCurrent: boolean;
+            readonly createdAt: string;
+            readonly downloadAvailable: boolean;
+        }[];
+    } | {
+        readonly kind: "denied";
+    } | {
+        readonly kind: "unknown";
+        readonly code: "unknown";
+    } | InvoiceUnsupported>;
+    resolveDownload(input: {
+        readonly accountRef: string;
+        readonly orderId: string;
+        readonly documentRef: string;
+    }): Promise<{
+        readonly kind: "authorized";
+        readonly identity: InvoiceDocumentIdentity;
+        readonly artifactRef: string;
+        readonly fileName: string;
+        readonly parentDocumentRef: string | null;
+    } | {
+        readonly kind: "denied";
+    } | {
+        readonly kind: "unknown";
+        readonly code: "unknown";
+    } | InvoiceUnsupported>;
+};
+export type CustomerDocumentDeliveryStatus = "not_ready" | "pdf_ready" | "ksef_pending" | "email_pending" | "email_provider_accepted" | "email_sent" | "requires_correction" | "delivery_failed";
+export type CustomerInvoiceDocumentRole = "original" | "correction" | "replacement";
+export type CustomerInvoiceDownloadArtifact = "invoice" | "correction";
+export interface CustomerInvoiceDownloadRequest {
+    invoiceId: string;
+    artifact: CustomerInvoiceDownloadArtifact;
+}
+export type AccountInvoiceHistoryResult = Awaited<ReturnType<InvoiceAccessPort["read"]>>;
+export type AccountInvoiceHistoryDocument = Extract<AccountInvoiceHistoryResult, {
+    kind: "found";
+}>["documents"][number];

package/dist/account-support/contracts/invoice.js

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