@owlmeans/payment 0.1.18-rc.8 → 0.1.18

package/build/consumer/types.d.ts

@@ -0,0 +1,196 @@
+import type { ConsumerRightsMechanisms, ConsumerRightsPolicy, BillingProfileView, CancellationBody, CancellationReceipt, ConsumerRightsPublicView, DeclarationReceipt, PerformanceConsentBody, PerformanceConsentResponse, PerformanceConsentView, PurchaseList, SubscriptionStartBody, SubscriptionStartQuery, SubscriptionStartResponse, SubscriptionStartView, WithdrawalBody, WithdrawalCandidateList, WithdrawalReceipt, PlanWithdrawalComponent } from '../types.js';
+import type { RouteParent } from '@owlmeans/route';
+import type { EntrypointOptions, EntrypointProtocol, OpenRequest, OpenValue } from '@owlmeans/entrypoint';
+import type { PublicOf } from './types.local.js';
+export type BillingInterval = 'month' | 'year';
+/** A copy bundle: nested keys, string leaves. */
+export interface CopyTree {
+    [key: string]: string | CopyTree;
+}
+export type CopyValues = Record<string, string | number>;
+export interface LegalLabels {
+    withdrawal: {
+        function: string;
+        confirm: string;
+    };
+    cancellation: {
+        function: string;
+        confirm: string;
+    };
+}
+export interface ConsentStatement {
+    request: string;
+    acknowledgement: string;
+    /** The checkbox text: the request and the acknowledgement together. */
+    checkbox: string;
+}
+export interface WithdrawalDeadlineRule {
+    /** Default 14. */
+    days?: number;
+    /** A period ending on a Saturday or Sunday ends on the Monday after. Default on. */
+    weekendRollover?: boolean;
+    /** Whole days added after the rollover, covering public holidays. Default 5. */
+    marginDays?: number;
+}
+/** What decides whether a purchase can still be withdrawn from. */
+export interface WithdrawalWindow {
+    deadline?: Date | null;
+    withdrawnAt?: Date | null;
+    refundedAt?: Date | null;
+}
+/** Units granted at one instant — a purchase's credits. */
+export interface FifoLot {
+    id: string;
+    units: number;
+    at: Date;
+}
+/** Units spent at one instant. */
+export interface FifoSpend {
+    units: number;
+    at: Date;
+}
+/** One lot after allocation, with every slice of it a spend took. */
+export interface FifoLotUsage {
+    id: string;
+    at: Date;
+    granted: number;
+    used: number;
+    slices: Array<{
+        at: Date;
+        units: number;
+    }>;
+}
+export interface FifoAllocation {
+    lots: FifoLotUsage[];
+    /** Spent units no lot granted at or before the spend could cover. */
+    unallocated: number;
+}
+/** What an application must state itself; everything else defaults. */
+export type ConsumerRightsDeclaration = Partial<Omit<ConsumerRightsPolicy, 'mechanisms' | 'deadline'>> & Pick<ConsumerRightsPolicy, 'textVersion' | 'links'> & {
+    mechanisms?: Partial<ConsumerRightsMechanisms>;
+    deadline?: Partial<ConsumerRightsPolicy['deadline']>;
+};
+export interface ConsumerRightsPublicOptions {
+    /** Default `/public/consumer-rights`. */
+    path?: string;
+    /** An UNGUARDED parent only — whatever it guards, this subtree inherits. */
+    parent?: RouteParent;
+    /**
+     * Declare the two public frontend screens (sticky, like every legal page): the withdrawal
+     * function and the cancellation page. Both or neither.
+     */
+    screens?: {
+        withdrawal?: string;
+        cancellation?: string;
+        parent?: RouteParent;
+    };
+}
+export interface ConsumerRightsProtocolOptions {
+    /** Alias prefix of every declaration, e.g. `my-app:account:consumer`. */
+    prefix: string;
+    /** The application's guarded parent (its account base) — its guards and gate are inherited. */
+    parent?: RouteParent;
+    /** Guards of a tree mounted without a parent. */
+    guards?: EntrypointOptions['guards'];
+    gate?: EntrypointOptions['gate'];
+    /** Default `/consumer-rights`. */
+    path?: string;
+    /** The unguarded public subtree; absent or `false` declares none. */
+    public?: false | ConsumerRightsPublicOptions;
+}
+/** The guarded account subtree: one entity's own purchases, consents and declarations. */
+export interface ConsumerRightsAccountProtocols {
+    base: EntrypointProtocol<OpenRequest, OpenValue>;
+    profile: EntrypointProtocol<{}, BillingProfileView>;
+    purchases: EntrypointProtocol<{}, PurchaseList>;
+    consent: EntrypointProtocol<{}, PerformanceConsentView>;
+    giveConsent: EntrypointProtocol<{
+        body: PerformanceConsentBody;
+    }, PerformanceConsentResponse>;
+    start: EntrypointProtocol<{
+        query: SubscriptionStartQuery;
+    }, SubscriptionStartView>;
+    requestStart: EntrypointProtocol<{
+        body: SubscriptionStartBody;
+    }, SubscriptionStartResponse>;
+    withdrawals: EntrypointProtocol<{}, WithdrawalCandidateList>;
+    withdraw: EntrypointProtocol<{
+        body: WithdrawalBody;
+    }, WithdrawalReceipt>;
+    cancel: EntrypointProtocol<{
+        body: CancellationBody;
+    }, CancellationReceipt>;
+}
+export interface ConsumerRightsScreens {
+    withdrawal: EntrypointProtocol<OpenRequest, OpenValue>;
+    cancellation: EntrypointProtocol<OpenRequest, OpenValue>;
+}
+/**
+ * The unguarded public subtree: reachable WITHOUT a login (§ 312k BGB). Its receipts carry only
+ * what was declared and when — never whether a contract matched.
+ */
+export interface ConsumerRightsPublicProtocols {
+    base: EntrypointProtocol<OpenRequest, OpenValue>;
+    policy: EntrypointProtocol<{}, ConsumerRightsPublicView>;
+    withdraw: EntrypointProtocol<{
+        body: WithdrawalBody;
+    }, DeclarationReceipt>;
+    cancel: EntrypointProtocol<{
+        body: CancellationBody;
+    }, DeclarationReceipt>;
+}
+/** The tree for given options — `public` (and its `screens`) present only when declared. */
+export type ConsumerRightsProtocols<O extends ConsumerRightsProtocolOptions = ConsumerRightsProtocolOptions> = O['public'] extends ConsumerRightsPublicOptions ? ConsumerRightsAccountProtocols & {
+    public: PublicOf<O['public']>;
+} : ConsumerRightsAccountProtocols;
+export interface OneTimeRefundInput {
+    paidMinor: number;
+    /** Already refunded (an earlier partial refund); the refund never exceeds the rest. */
+    refundedMinor?: number;
+    unitsGranted: number;
+    /** Units used AFTER consent — before it, the consumer bears no cost. Clamped to `0..granted`. */
+    unitsUsed: number;
+}
+export interface OneTimeRefund {
+    refundMinor: number;
+    /** The share of the purchase that is unused: `(granted − used) / granted`. */
+    netRatio: number;
+    /** The unused units a withdrawal takes back. */
+    unitsReturned: number;
+}
+export interface SubscriptionRefundInput {
+    paidMinor: number;
+    refundedMinor?: number;
+    /** The price net of tax — the base the components split and the deductions come from. */
+    netMinor: number;
+    /** Absent or empty: the whole price is one `time` component. */
+    components?: PlanWithdrawalComponent[];
+    periodStart: Date;
+    periodEnd: Date;
+    /** When the consumer expressly requested the services. None: no time deduction at all. */
+    servicesRequestedAt?: Date | null;
+    withdrawnAt: Date;
+    /** Units granted with the purchase and used after consent — applied to every `units` component. */
+    units?: {
+        granted: number;
+        used: number;
+    } | null;
+}
+export interface SubscriptionRefundComponent extends PlanWithdrawalComponent {
+    /** The component's part of `netMinor`. */
+    amountMinor: number;
+    deductionMinor: number;
+}
+export interface SubscriptionRefund {
+    /** Gross (tax-inclusive) refund, capped at what is still unrefunded. */
+    refundMinor: number;
+    refundNetMinor: number;
+    timeDeductionMinor: number;
+    unitsDeductionMinor: number;
+    elapsedDays: number;
+    periodDays: number;
+    unitsUsed?: number;
+    unitsGranted?: number;
+    components: SubscriptionRefundComponent[];
+}
+//# sourceMappingURL=types.d.ts.map

package/build/consumer/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/consumer/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,wBAAwB,EAAE,oBAAoB,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,mBAAmB,EAAE,wBAAwB,EAAE,kBAAkB,EAAE,sBAAsB,EAAE,0BAA0B,EAAE,sBAAsB,EAAE,YAAY,EAAE,qBAAqB,EAAE,sBAAsB,EAAE,yBAAyB,EAAE,qBAAqB,EAAE,cAAc,EAAE,uBAAuB,EAAE,iBAAiB,EAAE,uBAAuB,EAAE,MAAM,aAAa,CAAA;AAC1c,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAA;AAClD,OAAO,KAAK,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AACzG,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAA;AAEhD,MAAM,MAAM,eAAe,GAAG,OAAO,GAAG,MAAM,CAAA;AAE9C,iDAAiD;AACjD,MAAM,WAAW,QAAQ;IACvB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,QAAQ,CAAA;CACjC;AAED,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,CAAA;AAExD,MAAM,WAAW,WAAW;IAC1B,UAAU,EAAE;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAA;IACjD,YAAY,EAAE;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAA;CACpD;AAED,MAAM,WAAW,gBAAgB;IAC/B,OAAO,EAAE,MAAM,CAAA;IACf,eAAe,EAAE,MAAM,CAAA;IACvB,uEAAuE;IACvE,QAAQ,EAAE,MAAM,CAAA;CACjB;AAED,MAAM,WAAW,sBAAsB;IACrC,kBAAkB;IAClB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,oFAAoF;IACpF,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB,gFAAgF;IAChF,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AAED,mEAAmE;AACnE,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IACtB,WAAW,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IACzB,UAAU,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;CACzB;AAED,2DAA2D;AAC3D,MAAM,WAAW,OAAO;IACtB,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,EAAE,MAAM,CAAA;IACb,EAAE,EAAE,IAAI,CAAA;CACT;AAED,kCAAkC;AAClC,MAAM,WAAW,SAAS;IACxB,KAAK,EAAE,MAAM,CAAA;IACb,EAAE,EAAE,IAAI,CAAA;CACT;AAED,qEAAqE;AACrE,MAAM,WAAW,YAAY;IAC3B,EAAE,EAAE,MAAM,CAAA;IACV,EAAE,EAAE,IAAI,CAAA;IACR,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,KAAK,CAAC;QAAE,EAAE,EAAE,IAAI,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAAA;CAC3C;AAED,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,YAAY,EAAE,CAAA;IACpB,qEAAqE;IACrE,WAAW,EAAE,MAAM,CAAA;CACpB;AAGD,uEAAuE;AACvE,MAAM,MAAM,yBAAyB,GAAG,OAAO,CAAC,IAAI,CAAC,oBAAoB,EAAE,YAAY,GAAG,UAAU,CAAC,CAAC,GAClG,IAAI,CAAC,oBAAoB,EAAE,aAAa,GAAG,OAAO,CAAC,GACnD;IAAE,UAAU,CAAC,EAAE,OAAO,CAAC,wBAAwB,CAAC,CAAC;IAAC,QAAQ,CAAC,EAAE,OAAO,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAC,CAAA;CAAE,CAAA;AAE5G,MAAM,WAAW,2BAA2B;IAC1C,yCAAyC;IACzC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,4EAA4E;IAC5E,MAAM,CAAC,EAAE,WAAW,CAAA;IACpB;;;OAGG;IACH,OAAO,CAAC,EAAE;QAAE,UAAU,CAAC,EAAE,MAAM,CAAC;QAAC,YAAY,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,WAAW,CAAA;KAAE,CAAA;CAC/E;AAED,MAAM,WAAW,6BAA6B;IAC5C,yEAAyE;IACzE,MAAM,EAAE,MAAM,CAAA;IACd,+FAA+F;IAC/F,MAAM,CAAC,EAAE,WAAW,CAAA;IACpB,iDAAiD;IACjD,MAAM,CAAC,EAAE,iBAAiB,CAAC,QAAQ,CAAC,CAAA;IACpC,IAAI,CAAC,EAAE,iBAAiB,CAAC,MAAM,CAAC,CAAA;IAChC,kCAAkC;IAClC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,qEAAqE;IACrE,MAAM,CAAC,EAAE,KAAK,GAAG,2BAA2B,CAAA;CAC7C;AAED,0FAA0F;AAC1F,MAAM,WAAW,8BAA8B;IAC7C,IAAI,EAAE,kBAAkB,CAAC,WAAW,EAAE,SAAS,CAAC,CAAA;IAChD,OAAO,EAAE,kBAAkB,CAAC,EAAE,EAAE,kBAAkB,CAAC,CAAA;IACnD,SAAS,EAAE,kBAAkB,CAAC,EAAE,EAAE,YAAY,CAAC,CAAA;IAC/C,OAAO,EAAE,kBAAkB,CAAC,EAAE,EAAE,sBAAsB,CAAC,CAAA;IACvD,WAAW,EAAE,kBAAkB,CAAC;QAAE,IAAI,EAAE,sBAAsB,CAAA;KAAE,EAAE,0BAA0B,CAAC,CAAA;IAC7F,KAAK,EAAE,kBAAkB,CAAC;QAAE,KAAK,EAAE,sBAAsB,CAAA;KAAE,EAAE,qBAAqB,CAAC,CAAA;IACnF,YAAY,EAAE,kBAAkB,CAAC;QAAE,IAAI,EAAE,qBAAqB,CAAA;KAAE,EAAE,yBAAyB,CAAC,CAAA;IAC5F,WAAW,EAAE,kBAAkB,CAAC,EAAE,EAAE,uBAAuB,CAAC,CAAA;IAC5D,QAAQ,EAAE,kBAAkB,CAAC;QAAE,IAAI,EAAE,cAAc,CAAA;KAAE,EAAE,iBAAiB,CAAC,CAAA;IACzE,MAAM,EAAE,kBAAkB,CAAC;QAAE,IAAI,EAAE,gBAAgB,CAAA;KAAE,EAAE,mBAAmB,CAAC,CAAA;CAC5E;AAED,MAAM,WAAW,qBAAqB;IACpC,UAAU,EAAE,kBAAkB,CAAC,WAAW,EAAE,SAAS,CAAC,CAAA;IACtD,YAAY,EAAE,kBAAkB,CAAC,WAAW,EAAE,SAAS,CAAC,CAAA;CACzD;AAED;;;GAGG;AACH,MAAM,WAAW,6BAA6B;IAC5C,IAAI,EAAE,kBAAkB,CAAC,WAAW,EAAE,SAAS,CAAC,CAAA;IAChD,MAAM,EAAE,kBAAkB,CAAC,EAAE,EAAE,wBAAwB,CAAC,CAAA;IACxD,QAAQ,EAAE,kBAAkB,CAAC;QAAE,IAAI,EAAE,cAAc,CAAA;KAAE,EAAE,kBAAkB,CAAC,CAAA;IAC1E,MAAM,EAAE,kBAAkB,CAAC;QAAE,IAAI,EAAE,gBAAgB,CAAA;KAAE,EAAE,kBAAkB,CAAC,CAAA;CAC3E;AAED,4FAA4F;AAC5F,MAAM,MAAM,uBAAuB,CAAC,CAAC,SAAS,6BAA6B,GAAG,6BAA6B,IACzG,CAAC,CAAC,QAAQ,CAAC,SAAS,2BAA2B,GAC3C,8BAA8B,GAAG;IAAE,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAA;CAAE,GAClE,8BAA8B,CAAA;AAEpC,MAAM,WAAW,kBAAkB;IACjC,SAAS,EAAE,MAAM,CAAA;IACjB,uFAAuF;IACvF,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,YAAY,EAAE,MAAM,CAAA;IACpB,iGAAiG;IACjG,SAAS,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,WAAW,aAAa;IAC5B,WAAW,EAAE,MAAM,CAAA;IACnB,8EAA8E;IAC9E,QAAQ,EAAE,MAAM,CAAA;IAChB,gDAAgD;IAChD,aAAa,EAAE,MAAM,CAAA;CACtB;AAED,MAAM,WAAW,uBAAuB;IACtC,SAAS,EAAE,MAAM,CAAA;IACjB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,yFAAyF;IACzF,QAAQ,EAAE,MAAM,CAAA;IAChB,gEAAgE;IAChE,UAAU,CAAC,EAAE,uBAAuB,EAAE,CAAA;IACtC,WAAW,EAAE,IAAI,CAAA;IACjB,SAAS,EAAE,IAAI,CAAA;IACf,0FAA0F;IAC1F,mBAAmB,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IACjC,WAAW,EAAE,IAAI,CAAA;IACjB,mGAAmG;IACnG,KAAK,CAAC,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI,CAAA;CACjD;AAED,MAAM,WAAW,2BAA4B,SAAQ,uBAAuB;IAC1E,0CAA0C;IAC1C,WAAW,EAAE,MAAM,CAAA;IACnB,cAAc,EAAE,MAAM,CAAA;CACvB;AAED,MAAM,WAAW,kBAAkB;IACjC,wEAAwE;IACxE,WAAW,EAAE,MAAM,CAAA;IACnB,cAAc,EAAE,MAAM,CAAA;IACtB,kBAAkB,EAAE,MAAM,CAAA;IAC1B,mBAAmB,EAAE,MAAM,CAAA;IAC3B,WAAW,EAAE,MAAM,CAAA;IACnB,UAAU,EAAE,MAAM,CAAA;IAClB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,UAAU,EAAE,2BAA2B,EAAE,CAAA;CAC1C"}

package/build/consumer/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/build/consumer/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/consumer/types.ts"],"names":[],"mappings":""}

package/build/consumer/types.local.d.ts

@@ -0,0 +1,11 @@
+import type { ConsumerRightsPolicy } from '../types.js';
+import type { ConsumerRightsPublicProtocols, ConsumerRightsScreens } from './types.js';
+export interface DeadlinePolicy extends Pick<ConsumerRightsPolicy, 'withdrawalDays' | 'deadline'> {
+}
+export type PublicOf<P> = P extends {
+    screens: object;
+} ? ConsumerRightsPublicProtocols & {
+    screens: ConsumerRightsScreens;
+} : ConsumerRightsPublicProtocols;
+export type Dated = Record<string, unknown>;
+//# sourceMappingURL=types.local.d.ts.map

package/build/consumer/types.local.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.local.d.ts","sourceRoot":"","sources":["../../src/consumer/types.local.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAA;AACvD,OAAO,KAAK,EAAE,6BAA6B,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAA;AAEtF,MAAM,WAAW,cAAe,SAAQ,IAAI,CAAC,oBAAoB,EAAE,gBAAgB,GAAG,UAAU,CAAC;CAAG;AAEpG,MAAM,MAAM,QAAQ,CAAC,CAAC,IAAI,CAAC,SAAS;IAAE,OAAO,EAAE,MAAM,CAAA;CAAE,GACnD,6BAA6B,GAAG;IAAE,OAAO,EAAE,qBAAqB,CAAA;CAAE,GAClE,6BAA6B,CAAA;AAEjC,MAAM,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA"}

package/build/consumer/types.local.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.local.js.map

package/build/consumer/types.local.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.local.js","sourceRoot":"","sources":["../../src/consumer/types.local.ts"],"names":[],"mappings":""}

package/build/countries.d.ts

@@ -0,0 +1,3 @@
+/** The lowercase ISO 4217 currency of a country, or `null` when this map has no entry for it. */
+export declare const currencyOfCountry: (country: string) => string | null;
+//# sourceMappingURL=countries.d.ts.map

package/build/countries.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"countries.d.ts","sourceRoot":"","sources":["../src/countries.ts"],"names":[],"mappings":"AAEA,iGAAiG;AACjG,eAAO,MAAM,iBAAiB,YAAa,MAAM,KAAG,MAAM,GAAG,IACV,CAAA"}

package/build/countries.js

@@ -0,0 +1,4 @@
+import { COUNTRY_CURRENCIES } from './consts.js';
+/** The lowercase ISO 4217 currency of a country, or `null` when this map has no entry for it. */
+export const currencyOfCountry = (country) => COUNTRY_CURRENCIES[country.toUpperCase()] ?? null;
+//# sourceMappingURL=countries.js.map

package/build/countries.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"countries.js","sourceRoot":"","sources":["../src/countries.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAA;AAEhD,iGAAiG;AACjG,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,OAAe,EAAiB,EAAE,CAClE,kBAAkB,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,IAAI,IAAI,CAAA"}

package/build/entitled.d.ts

@@ -0,0 +1,14 @@
+import type { EntrypointOptions } from '@owlmeans/entrypoint';
+/**
+ * Declare that an entrypoint needs a paid capability.
+ *
+ * Compatibility sugar over the protocol option
+ * `{ gate: { alias: ENTITLEMENT_GATE, params } }` so a route reads as what it means. Several
+ * parameters are OR'd, matching every other gate in the framework.
+ *
+ * Putting the requirement HERE rather than in a handler is the point: the framework asserts a gate
+ * before the handler is entered, so the route table states what a feature costs and no new
+ * endpoint can forget to check.
+ */
+export declare const entitled: (params: string | string[], opts?: EntrypointOptions) => EntrypointOptions;
+//# sourceMappingURL=entitled.d.ts.map

package/build/entitled.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"entitled.d.ts","sourceRoot":"","sources":["../src/entitled.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAA;AAG7D;;;;;;;;;;GAUG;AACH,eAAO,MAAM,QAAQ,WACX,MAAM,GAAG,MAAM,EAAE,SAAS,iBAAiB,KAClD,iBAGD,CAAA"}

package/build/entitled.js

@@ -0,0 +1,17 @@
+import { ENTITLEMENT_GATE } from './consts.js';
+/**
+ * Declare that an entrypoint needs a paid capability.
+ *
+ * Compatibility sugar over the protocol option
+ * `{ gate: { alias: ENTITLEMENT_GATE, params } }` so a route reads as what it means. Several
+ * parameters are OR'd, matching every other gate in the framework.
+ *
+ * Putting the requirement HERE rather than in a handler is the point: the framework asserts a gate
+ * before the handler is entered, so the route table states what a feature costs and no new
+ * endpoint can forget to check.
+ */
+export const entitled = (params, opts) => ({
+    ...opts,
+    gate: { alias: ENTITLEMENT_GATE, params },
+});
+//# sourceMappingURL=entitled.js.map

package/build/entitled.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"entitled.js","sourceRoot":"","sources":["../src/entitled.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAA;AAE9C;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG,CACtB,MAAyB,EAAE,IAAwB,EAChC,EAAE,CAAC,CAAC;IACvB,GAAG,IAAI;IACP,IAAI,EAAE,EAAE,KAAK,EAAE,gBAAgB,EAAE,MAAM,EAAE;CAC1C,CAAC,CAAA"}

package/build/entitlement/types.d.ts

@@ -0,0 +1,29 @@
+import type { PermissionSet } from '@owlmeans/auth';
+import type { EntitlementParam } from '../types.js';
+/** The entitlement parameter grammar and the capability predicate the server gate and the browser share. */
+export interface EntitlementParamHelper {
+    /**
+     * Grammar: `[<scope>:]<permission>[>=<n>]`.
+     *
+     * `feature:branding--whitelabel` · `renewable:credits>=100` · `production--standalone`
+     *
+     * `@` is deliberately not part of it: that is `@owlmeans/iam`'s resource-selector syntax, and a
+     * grammar that reused it would make two different things look the same in a route declaration.
+     */
+    parseEntitlementParam: (param: string) => EntitlementParam;
+    formatEntitlementParam: (parsed: EntitlementParam) => string;
+    /**
+     * Whether a union of capability sets satisfies one requirement.
+     *
+     * Pure, and shared by the server gate and the browser: the UI has to know whether to render a
+     * control disabled, and a second implementation of the rule for the client would eventually
+     * disagree with the one that actually refuses.
+     *
+     * A malformed parameter answers `false` rather than throwing. A gate that crashed on a typo would
+     * take down the endpoint it guards, which is a strictly worse failure than refusing it.
+     */
+    hasEntitlement: (capabilities: PermissionSet[] | undefined, param: string) => boolean;
+    /** Everything a union grants, formatted back into parameters. The wire shape of a client read. */
+    entitlementList: (capabilities: PermissionSet[] | undefined) => string[];
+}
+//# sourceMappingURL=types.d.ts.map

package/build/entitlement/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/entitlement/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAA;AACnD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAA;AAEnD,4GAA4G;AAC5G,MAAM,WAAW,sBAAsB;IACrC;;;;;;;OAOG;IACH,qBAAqB,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,gBAAgB,CAAA;IAC1D,sBAAsB,EAAE,CAAC,MAAM,EAAE,gBAAgB,KAAK,MAAM,CAAA;IAC5D;;;;;;;;;OASG;IACH,cAAc,EAAE,CAAC,YAAY,EAAE,aAAa,EAAE,GAAG,SAAS,EAAE,KAAK,EAAE,MAAM,KAAK,OAAO,CAAA;IACrF,kGAAkG;IAClG,eAAe,EAAE,CAAC,YAAY,EAAE,aAAa,EAAE,GAAG,SAAS,KAAK,MAAM,EAAE,CAAA;CACzE"}

package/build/entitlement/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/build/entitlement/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/entitlement/types.ts"],"names":[],"mappings":""}

package/build/entitlement.d.ts

@@ -0,0 +1,12 @@
+import type { PermissionSet } from '@owlmeans/auth';
+import type { EntitlementParam } from './types.js';
+import type { EntitlementParamHelper } from './entitlement/types.js';
+export declare const createEntitlementParamHelper: () => EntitlementParamHelper;
+export declare const entitlementParamHelper: EntitlementParamHelper;
+/** @deprecated compat:factory-refactor — use `entitlementParamHelper.parseEntitlementParam(…)` */
+export declare const parseEntitlementParam: (param: string) => EntitlementParam;
+/** @deprecated compat:factory-refactor — use `entitlementParamHelper.formatEntitlementParam(…)` */
+export declare const formatEntitlementParam: (parsed: EntitlementParam) => string;
+/** @deprecated compat:factory-refactor — use `entitlementParamHelper.hasEntitlement(…)` */
+export declare const hasEntitlement: (capabilities: PermissionSet[] | undefined, param: string) => boolean;
+//# sourceMappingURL=entitlement.d.ts.map

package/build/entitlement.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"entitlement.d.ts","sourceRoot":"","sources":["../src/entitlement.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAA;AAEnD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAA;AAClD,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,wBAAwB,CAAA;AAEpE,eAAO,MAAM,4BAA4B,QAAO,sBAkE/C,CAAA;AAED,eAAO,MAAM,sBAAsB,wBAAiC,CAAA;AAEpE,kGAAkG;AAClG,eAAO,MAAM,qBAAqB,UAAW,MAAM,KAAG,gBACD,CAAA;AAErD,mGAAmG;AACnG,eAAO,MAAM,sBAAsB,WAAY,gBAAgB,KAAG,MACX,CAAA;AAEvD,2FAA2F;AAC3F,eAAO,MAAM,cAAc,iBAAkB,aAAa,EAAE,GAAG,SAAS,SAAS,MAAM,KAAG,OAC9B,CAAA"}

package/build/entitlement.js

@@ -0,0 +1,64 @@
+import { CAPABILITY_LIMIT_SCOPE } from './consts.js';
+export const createEntitlementParamHelper = () => {
+    const parseEntitlementParam = (param) => {
+        const [scoped, floor] = param.split('>=');
+        const colon = scoped.indexOf(':');
+        const parsed = colon >= 0
+            ? { scope: scoped.slice(0, colon), permission: scoped.slice(colon + 1) }
+            : { permission: scoped };
+        if (floor != null) {
+            const value = Number.parseFloat(floor);
+            if (!Number.isNaN(value)) {
+                parsed.atLeast = value;
+            }
+        }
+        return parsed;
+    };
+    const formatEntitlementParam = (parsed) => `${parsed.scope != null ? `${parsed.scope}:` : ''}${parsed.permission}` +
+        `${parsed.atLeast != null ? `>=${parsed.atLeast}` : ''}`;
+    const hasEntitlement = (capabilities, param) => {
+        if (capabilities == null || capabilities.length < 1) {
+            return false;
+        }
+        if (typeof param !== 'string') {
+            return false;
+        }
+        const { scope, permission, atLeast } = parseEntitlementParam(param);
+        // A limit is never a capability: its room is counted, not granted.
+        if (permission === '' || scope === CAPABILITY_LIMIT_SCOPE) {
+            return false;
+        }
+        return capabilities.some(set => {
+            if (scope != null && set.scope !== scope) {
+                return false;
+            }
+            const held = set.permissions?.[permission];
+            if (held == null || held === false) {
+                return false;
+            }
+            // A floor is a numeric question: a boolean flag, however true, does not answer it.
+            return atLeast != null ? typeof held === 'number' && held >= atLeast : true;
+        });
+    };
+    const entitlementList = (capabilities) => {
+        const list = [];
+        for (const set of capabilities ?? []) {
+            for (const [permission, value] of Object.entries(set.permissions ?? {})) {
+                if (value == null || value === false) {
+                    continue;
+                }
+                list.push(formatEntitlementParam({ scope: set.scope, permission }));
+            }
+        }
+        return [...new Set(list)];
+    };
+    return { parseEntitlementParam, formatEntitlementParam, hasEntitlement, entitlementList };
+};
+export const entitlementParamHelper = createEntitlementParamHelper();
+/** @deprecated compat:factory-refactor — use `entitlementParamHelper.parseEntitlementParam(…)` */
+export const parseEntitlementParam = (param) => entitlementParamHelper.parseEntitlementParam(param);
+/** @deprecated compat:factory-refactor — use `entitlementParamHelper.formatEntitlementParam(…)` */
+export const formatEntitlementParam = (parsed) => entitlementParamHelper.formatEntitlementParam(parsed);
+/** @deprecated compat:factory-refactor — use `entitlementParamHelper.hasEntitlement(…)` */
+export const hasEntitlement = (capabilities, param) => entitlementParamHelper.hasEntitlement(capabilities, param);
+//# sourceMappingURL=entitlement.js.map

package/build/entitlement.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"entitlement.js","sourceRoot":"","sources":["../src/entitlement.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,sBAAsB,EAAE,MAAM,aAAa,CAAA;AAIpD,MAAM,CAAC,MAAM,4BAA4B,GAAG,GAA2B,EAAE;IACvE,MAAM,qBAAqB,GAAG,CAAC,KAAa,EAAoB,EAAE;QAChE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;QACzC,MAAM,KAAK,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAA;QACjC,MAAM,MAAM,GAAqB,KAAK,IAAI,CAAC;YACzC,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,UAAU,EAAE,MAAM,CAAC,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC,EAAE;YACxE,CAAC,CAAC,EAAE,UAAU,EAAE,MAAM,EAAE,CAAA;QAE1B,IAAI,KAAK,IAAI,IAAI,EAAE,CAAC;YAClB,MAAM,KAAK,GAAG,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,CAAA;YACtC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;gBACzB,MAAM,CAAC,OAAO,GAAG,KAAK,CAAA;YACxB,CAAC;QACH,CAAC;QAED,OAAO,MAAM,CAAA;IACf,CAAC,CAAA;IAED,MAAM,sBAAsB,GAAG,CAAC,MAAwB,EAAU,EAAE,CAClE,GAAG,MAAM,CAAC,KAAK,IAAI,IAAI,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,MAAM,CAAC,UAAU,EAAE;QACvE,GAAG,MAAM,CAAC,OAAO,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAA;IAE1D,MAAM,cAAc,GAAG,CACrB,YAAyC,EAAE,KAAa,EAC/C,EAAE;QACX,IAAI,YAAY,IAAI,IAAI,IAAI,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACpD,OAAO,KAAK,CAAA;QACd,CAAC;QACD,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC9B,OAAO,KAAK,CAAA;QACd,CAAC;QACD,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,qBAAqB,CAAC,KAAK,CAAC,CAAA;QACnE,mEAAmE;QACnE,IAAI,UAAU,KAAK,EAAE,IAAI,KAAK,KAAK,sBAAsB,EAAE,CAAC;YAC1D,OAAO,KAAK,CAAA;QACd,CAAC;QAED,OAAO,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;YAC7B,IAAI,KAAK,IAAI,IAAI,IAAI,GAAG,CAAC,KAAK,KAAK,KAAK,EAAE,CAAC;gBACzC,OAAO,KAAK,CAAA;YACd,CAAC;YACD,MAAM,IAAI,GAAG,GAAG,CAAC,WAAW,EAAE,CAAC,UAAU,CAAC,CAAA;YAC1C,IAAI,IAAI,IAAI,IAAI,IAAI,IAAI,KAAK,KAAK,EAAE,CAAC;gBACnC,OAAO,KAAK,CAAA;YACd,CAAC;YAED,mFAAmF;YACnF,OAAO,OAAO,IAAI,IAAI,CAAC,CAAC,CAAC,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,IAAI,OAAO,CAAC,CAAC,CAAC,IAAI,CAAA;QAC7E,CAAC,CAAC,CAAA;IACJ,CAAC,CAAA;IAED,MAAM,eAAe,GAAG,CAAC,YAAyC,EAAY,EAAE;QAC9E,MAAM,IAAI,GAAa,EAAE,CAAA;QACzB,KAAK,MAAM,GAAG,IAAI,YAAY,IAAI,EAAE,EAAE,CAAC;YACrC,KAAK,MAAM,CAAC,UAAU,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,IAAI,EAAE,CAAC,EAAE,CAAC;gBACxE,IAAI,KAAK,IAAI,IAAI,IAAI,KAAK,KAAK,KAAK,EAAE,CAAC;oBACrC,SAAQ;gBACV,CAAC;gBACD,IAAI,CAAC,IAAI,CAAC,sBAAsB,CAAC,EAAE,KAAK,EAAE,GAAG,CAAC,KAAK,EAAE,UAAU,EAAE,CAAC,CAAC,CAAA;YACrE,CAAC;QACH,CAAC;QAED,OAAO,CAAC,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,CAAC,CAAA;IAC3B,CAAC,CAAA;IAED,OAAO,EAAE,qBAAqB,EAAE,sBAAsB,EAAE,cAAc,EAAE,eAAe,EAAE,CAAA;AAC3F,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,sBAAsB,GAAG,4BAA4B,EAAE,CAAA;AAEpE,kGAAkG;AAClG,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,KAAa,EAAoB,EAAE,CACvE,sBAAsB,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAA;AAErD,mGAAmG;AACnG,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,MAAwB,EAAU,EAAE,CACzE,sBAAsB,CAAC,sBAAsB,CAAC,MAAM,CAAC,CAAA;AAEvD,2FAA2F;AAC3F,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,YAAyC,EAAE,KAAa,EAAW,EAAE,CAClG,sBAAsB,CAAC,cAAc,CAAC,YAAY,EAAE,KAAK,CAAC,CAAA"}

package/build/errors.d.ts

@@ -1,4 +1,6 @@
 import { ResilientError } from '@owlmeans/error';
+import { AuthForbidden } from '@owlmeans/auth';
+import type { BillingCountryLockedDetails, CheckoutLimitExceededDetails, LimitExhaustedDetails, PerformanceConsentRequiredDetails } from './types.js';
 export declare class PaymentError extends ResilientError {
     static typeName: string;
     constructor(message?: string);
@@ -15,6 +17,17 @@ export declare class PaygateMappingError extends PaygateError {
     static typeName: string;
     constructor(message?: string);
 }
+/**
+ * A webhook delivery whose signature is missing or verifies against no known secret. The sender is
+ * refused as a client error (400): a forged or unsigned POST at a public hook is not a server fault,
+ * and answering 500 would page operators for it and invite the sender to retry it.
+ */
+export declare class PaygateSignatureError extends PaygateError {
+    static typeName: string;
+    /** Read by the HTTP boundary (`server-api` `declaredErrorStatus`). */
+    static httpStatus: number;
+    constructor();
+}
 export declare class ProductError extends PaymentError {
     static typeName: string;
     constructor(message?: string);
@@ -39,4 +52,180 @@ export declare class UnknownSubscription extends SubscriptionError {
     static typeName: string;
     constructor(message?: string);
 }
+export declare class LimitUnknown extends ProductError {
+    static typeName: string;
+    constructor(message?: string);
+}
+export declare class LimitMisdeclared extends ProductError {
+    static typeName: string;
+    constructor(message?: string);
+}
+export declare class PlanRequired extends ProductError {
+    static typeName: string;
+    constructor(message?: string);
+}
+export declare class PlanRankConflict extends ProductError {
+    static typeName: string;
+    constructor(message?: string);
+}
+export declare class WebhookSetupError extends PaygateError {
+    static typeName: string;
+    constructor(message?: string);
+}
+/**
+ * The entity has nothing the requested portal flow can act on — no paygate customer, no entitling
+ * subscription, no plan or item to change to. The entity's own state, not a fault: an HTTP boundary
+ * that honours `httpStatus` (`@owlmeans/server-api`) answers 409 Conflict.
+ */
+export declare class PortalUnavailable extends PaygateError {
+    static typeName: string;
+    static httpStatus: number;
+    constructor(message?: string);
+}
+/**
+ * The entity's plan does not allow the request.
+ *
+ * Extends `AuthForbidden` so an HTTP boundary answers 403, never 500. Only `type` and `message`
+ * survive a marshal round trip, so each subclass packs its fields into the message and rebuilds
+ * them in `finalizeUnmarshal()`.
+ */
+export declare class EntitlementRefusal extends AuthForbidden {
+    static typeName: string;
+    constructor(message?: string);
+}
+/** None of the capability parameters (OR'd) is granted. Message marker `capability-required:<a|b>`. */
+export declare class CapabilityRequired extends EntitlementRefusal {
+    static typeName: string;
+    /** The refused parameters, as the gate took them. */
+    params: string[];
+    constructor(params?: string | string[]);
+    private applyFields;
+    finalizeUnmarshal(): void;
+}
+/**
+ * A limit has no room left. Message marker `limit-exhausted:<key>:<used>/<limit>[:<resetsAt ISO>]`.
+ */
+export declare class LimitExhausted extends EntitlementRefusal {
+    static typeName: string;
+    limitKey: string;
+    used: number;
+    limit: number;
+    resetsAt?: Date;
+    /** The packed marker body of a refusal. */
+    static encode(details: LimitExhaustedDetails): string;
+    constructor(details: LimitExhaustedDetails);
+    /** A packed marker body (`LimitExhausted.encode`) or a marshaled message — the error registry's path. */
+    constructor(message: string);
+    private applyFields;
+    finalizeUnmarshal(): void;
+}
+/**
+ * A consumer-rights fault — a misdeclared policy (`policy:<field>`), a missing usage meter or
+ * mailer, a copy template without a value (`copy:<path>`). Declares no status: 500.
+ */
+export declare class ConsumerRightsError extends PaymentError {
+    static typeName: string;
+    constructor(message?: string);
+}
+/**
+ * The consumer's own position refuses the request — never a fault. Deliberately NOT an
+ * `AuthForbidden`: an HTTP boundary tests that family first, and a 403 would hide the declared
+ * 428/409 a client acts on.
+ */
+export declare class ConsumerRightsRefusal extends ConsumerRightsError {
+    static typeName: string;
+    constructor(message?: string);
+}
+/**
+ * Billed work would spend credits of a purchase still inside its withdrawal window, and the
+ * consumer has not expressly requested performance. HTTP 428. Marker
+ * `performance-consent-required:<pending>[:<deadline ISO>]`.
+ */
+export declare class PerformanceConsentRequired extends ConsumerRightsRefusal {
+    static typeName: string;
+    static httpStatus: number;
+    pending: number;
+    deadline?: Date;
+    static encode(details: PerformanceConsentRequiredDetails): string;
+    constructor(details: PerformanceConsentRequiredDetails);
+    /** A packed marker body (`encode`) or a marshaled message — the error registry's path. */
+    constructor(message: string);
+    private applyFields;
+    finalizeUnmarshal(): void;
+}
+/**
+ * A subscription checkout needs a fresh express start request bound to this plan. HTTP 428.
+ * Marker `subscription-start-required:<encodeURIComponent(planSku)>`.
+ */
+export declare class SubscriptionStartRequired extends ConsumerRightsRefusal {
+    static typeName: string;
+    static httpStatus: number;
+    planSku: string;
+    static encode(planSku: string): string;
+    /** `planSku` as is, or a packed marker body / marshaled message (the registry's path). */
+    constructor(planSku?: string | {
+        planSku: string;
+    });
+    /** A string that already is a marker (the registry path) passes through unencoded. */
+    private static encodeLoose;
+    private applyFields;
+    finalizeUnmarshal(): void;
+}
+/**
+ * The entity's billing country is fixed and the request declared another. HTTP 409. Marker
+ * `billing-country-locked:<country>[:<requested>]`.
+ */
+export declare class BillingCountryLocked extends ConsumerRightsRefusal {
+    static typeName: string;
+    static httpStatus: number;
+    country: string;
+    requested?: string;
+    static encode(details: BillingCountryLockedDetails): string;
+    constructor(details: BillingCountryLockedDetails);
+    constructor(message: string);
+    private applyFields;
+    finalizeUnmarshal(): void;
+}
+/**
+ * The named purchase cannot be withdrawn from (`WithdrawalUnavailableReason`). HTTP 409. Marker
+ * `withdrawal-unavailable:<reason>`. Never raised on the public page, which discloses nothing.
+ */
+export declare class WithdrawalUnavailable extends ConsumerRightsRefusal {
+    static typeName: string;
+    static httpStatus: number;
+    reason: string;
+    constructor(reason?: string);
+    private applyFields;
+    finalizeUnmarshal(): void;
+}
+/**
+ * Nothing to cancel in-app (`CancellationUnavailableReason`). HTTP 409. Marker
+ * `cancellation-unavailable:<reason>`.
+ */
+export declare class CancellationUnavailable extends ConsumerRightsRefusal {
+    static typeName: string;
+    static httpStatus: number;
+    reason: string;
+    constructor(reason?: string);
+    private applyFields;
+    finalizeUnmarshal(): void;
+}
+/**
+ * The amount is above what this entity may buy now (a narrowing of the plan's policy). HTTP 409.
+ * Marker `checkout-limit-exceeded:<encodeURIComponent(reason)>:<maximumMinor>:<currency>[:<ISO>]`.
+ * A payment refusal, not a consumer-rights one.
+ */
+export declare class CheckoutLimitExceeded extends PaymentError {
+    static typeName: string;
+    static httpStatus: number;
+    reason: string;
+    maximumMinor: number;
+    currency: string;
+    resetsAt?: Date;
+    static encode(details: CheckoutLimitExceededDetails): string;
+    constructor(details: CheckoutLimitExceededDetails);
+    constructor(message: string);
+    private applyFields;
+    finalizeUnmarshal(): void;
+}
 //# sourceMappingURL=errors.d.ts.map

package/build/errors.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAA;AAEhD,qBAAa,YAAa,SAAQ,cAAc;IAC9C,OAAuB,QAAQ,EAAE,MAAM,CAAiB;IAExD,YAAY,OAAO,GAAE,MAAgB,EAEpC;CACF;AAED,qBAAa,YAAa,SAAQ,YAAY;IAC5C,OAAuB,QAAQ,EAAE,MAAM,CAAoC;IAE3E,YAAY,OAAO,GAAE,MAAgB,EAGpC;CACF;AAED,qBAAa,cAAe,SAAQ,YAAY;IAC9C,OAAuB,QAAQ,EAAE,MAAM,CAAoC;IAE3E,YAAY,OAAO,GAAE,MAAgB,EAGpC;CACF;AAED,qBAAa,mBAAoB,SAAQ,YAAY;IACnD,OAAuB,QAAQ,EAAE,MAAM,CAAoC;IAE3E,YAAY,OAAO,GAAE,MAAgB,EAGpC;CACF;AAED,qBAAa,YAAa,SAAQ,YAAY;IAC5C,OAAuB,QAAQ,EAAE,MAAM,CAAoC;IAE3E,YAAY,OAAO,GAAE,MAAgB,EAGpC;CACF;AAED,qBAAa,cAAe,SAAQ,YAAY;IAC9C,OAAuB,QAAQ,EAAE,MAAM,CAAoC;IAE3E,YAAY,OAAO,GAAE,MAAgB,EAGpC;CACF;AAED,qBAAa,WAAY,SAAQ,YAAY;IAC3C,OAAuB,QAAQ,EAAE,MAAM,CAAiC;IAExE,YAAY,OAAO,GAAE,MAAgB,EAGpC;CACF;AAED,qBAAa,0BAA2B,SAAQ,YAAY;IAC1D,OAAuB,QAAQ,EAAE,MAAM,CAA2C;IAElF,YAAY,OAAO,GAAE,MAAgB,EAGpC;CACF;AAED,qBAAa,iBAAkB,SAAQ,YAAY;IACjD,OAAuB,QAAQ,EAAE,MAAM,CAAyC;IAEhF,YAAY,OAAO,GAAE,MAAgB,EAGpC;CACF;AAED,qBAAa,mBAAoB,SAAQ,iBAAiB;IACxD,OAAuB,QAAQ,EAAE,MAAM,CAAyC;IAEhF,YAAY,OAAO,GAAE,MAAgB,EAGpC;CACF"}
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAA;AAChD,OAAO,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAA;AAE9C,OAAO,KAAK,EAAE,2BAA2B,EAAE,4BAA4B,EAAE,qBAAqB,EAAE,iCAAiC,EAAE,MAAM,YAAY,CAAA;AAErJ,qBAAa,YAAa,SAAQ,cAAc;IAC9C,OAAuB,QAAQ,EAAE,MAAM,CAAiB;IAExD,YAAY,OAAO,GAAE,MAAgB,EAEpC;CACF;AAED,qBAAa,YAAa,SAAQ,YAAY;IAC5C,OAAuB,QAAQ,EAAE,MAAM,CAAoC;IAE3E,YAAY,OAAO,GAAE,MAAgB,EAGpC;CACF;AAED,qBAAa,cAAe,SAAQ,YAAY;IAC9C,OAAuB,QAAQ,EAAE,MAAM,CAAoC;IAE3E,YAAY,OAAO,GAAE,MAAgB,EAGpC;CACF;AAED,qBAAa,mBAAoB,SAAQ,YAAY;IACnD,OAAuB,QAAQ,EAAE,MAAM,CAAoC;IAE3E,YAAY,OAAO,GAAE,MAAgB,EAGpC;CACF;AAED;;;;GAIG;AACH,qBAAa,qBAAsB,SAAQ,YAAY;IACrD,OAAuB,QAAQ,EAAE,MAAM,CAAsC;IAC7E,sEAAsE;IACtE,OAAc,UAAU,EAAE,MAAM,CAAM;IAEtC,cAGC;CACF;AAED,qBAAa,YAAa,SAAQ,YAAY;IAC5C,OAAuB,QAAQ,EAAE,MAAM,CAAoC;IAE3E,YAAY,OAAO,GAAE,MAAgB,EAGpC;CACF;AAED,qBAAa,cAAe,SAAQ,YAAY;IAC9C,OAAuB,QAAQ,EAAE,MAAM,CAAoC;IAE3E,YAAY,OAAO,GAAE,MAAgB,EAGpC;CACF;AAED,qBAAa,WAAY,SAAQ,YAAY;IAC3C,OAAuB,QAAQ,EAAE,MAAM,CAAiC;IAExE,YAAY,OAAO,GAAE,MAAgB,EAGpC;CACF;AAED,qBAAa,0BAA2B,SAAQ,YAAY;IAC1D,OAAuB,QAAQ,EAAE,MAAM,CAA2C;IAElF,YAAY,OAAO,GAAE,MAAgB,EAGpC;CACF;AAED,qBAAa,iBAAkB,SAAQ,YAAY;IACjD,OAAuB,QAAQ,EAAE,MAAM,CAAyC;IAEhF,YAAY,OAAO,GAAE,MAAgB,EAGpC;CACF;AAED,qBAAa,mBAAoB,SAAQ,iBAAiB;IACxD,OAAuB,QAAQ,EAAE,MAAM,CAAyC;IAEhF,YAAY,OAAO,GAAE,MAAgB,EAGpC;CACF;AAED,qBAAa,YAAa,SAAQ,YAAY;IAC5C,OAAuB,QAAQ,EAAE,MAAM,CAAyC;IAEhF,YAAY,OAAO,GAAE,MAAgB,EAGpC;CACF;AAED,qBAAa,gBAAiB,SAAQ,YAAY;IAChD,OAAuB,QAAQ,EAAE,MAAM,CAA6C;IAEpF,YAAY,OAAO,GAAE,MAAgB,EAGpC;CACF;AAED,qBAAa,YAAa,SAAQ,YAAY;IAC5C,OAAuB,QAAQ,EAAE,MAAM,CAAyC;IAEhF,YAAY,OAAO,GAAE,MAAgB,EAGpC;CACF;AAED,qBAAa,gBAAiB,SAAQ,YAAY;IAChD,OAAuB,QAAQ,EAAE,MAAM,CAA6C;IAEpF,YAAY,OAAO,GAAE,MAAgB,EAGpC;CACF;AAED,qBAAa,iBAAkB,SAAQ,YAAY;IACjD,OAAuB,QAAQ,EAAE,MAAM,CAAyC;IAEhF,YAAY,OAAO,GAAE,MAAgB,EAGpC;CACF;AAED;;;;GAIG;AACH,qBAAa,iBAAkB,SAAQ,YAAY;IACjD,OAAuB,QAAQ,EAAE,MAAM,CAA8C;IACrF,OAAc,UAAU,SAAM;IAE9B,YAAY,OAAO,GAAE,MAAgB,EAGpC;CACF;AAED;;;;;;GAMG;AACH,qBAAa,kBAAmB,SAAQ,aAAa;IACnD,OAAuB,QAAQ,EAAE,MAAM,CAAuB;IAE9D,YAAY,OAAO,GAAE,MAAgB,EAGpC;CACF;AAED,uGAAuG;AACvG,qBAAa,kBAAmB,SAAQ,kBAAkB;IACxD,OAAuB,QAAQ,EAAE,MAAM,CAAqD;IAE5F,qDAAqD;IAC9C,MAAM,EAAE,MAAM,EAAE,CAAK;IAE5B,YAAY,MAAM,GAAE,MAAM,GAAG,MAAM,EAAO,EAKzC;IAED,OAAO,CAAC,WAAW;IAMV,iBAAiB,IAAI,IAAI,CAEjC;CACF;AAGD;;GAEG;AACH,qBAAa,cAAe,SAAQ,kBAAkB;IACpD,OAAuB,QAAQ,EAAE,MAAM,CAAiD;IAEjF,QAAQ,EAAE,MAAM,CAAK;IACrB,IAAI,EAAE,MAAM,CAAI;IAChB,KAAK,EAAE,MAAM,CAAI;IACjB,QAAQ,CAAC,EAAE,IAAI,CAAA;IAEtB,2CAA2C;IAC3C,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,qBAAqB,GAAG,MAAM,CAIpD;IAED,YAAY,OAAO,EAAE,qBAAqB,EAAC;IAC3C,yGAAyG;IACzG,YAAY,OAAO,EAAE,MAAM,EAAC;IAO5B,OAAO,CAAC,WAAW;IAeV,iBAAiB,IAAI,IAAI,CAEjC;CACF;AAED;;;GAGG;AACH,qBAAa,mBAAoB,SAAQ,YAAY;IACnD,OAAuB,QAAQ,EAAE,MAAM,CAA2C;IAElF,YAAY,OAAO,GAAE,MAAgB,EAGpC;CACF;AAED;;;;GAIG;AACH,qBAAa,qBAAsB,SAAQ,mBAAmB;IAC5D,OAAuB,QAAQ,EAAE,MAAM,CAA2C;IAElF,YAAY,OAAO,GAAE,MAAgB,EAGpC;CACF;AA0BD;;;;GAIG;AACH,qBAAa,0BAA2B,SAAQ,qBAAqB;IACnE,OAAuB,QAAQ,EAAE,MAAM,CAAgE;IACvG,OAAc,UAAU,SAAM;IAEvB,OAAO,EAAE,MAAM,CAAI;IACnB,QAAQ,CAAC,EAAE,IAAI,CAAA;IAEtB,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,iCAAiC,GAAG,MAAM,CAEhE;IAED,YAAY,OAAO,EAAE,iCAAiC,EAAC;IACvD,0FAA0F;IAC1F,YAAY,OAAO,EAAE,MAAM,EAAC;IAO5B,OAAO,CAAC,WAAW;IASV,iBAAiB,IAAI,IAAI,CAEjC;CACF;AAED;;;GAGG;AACH,qBAAa,yBAA0B,SAAQ,qBAAqB;IAClE,OAAuB,QAAQ,EAAE,MAAM,CAA+D;IACtG,OAAc,UAAU,SAAM;IAEvB,OAAO,EAAE,MAAM,CAAK;IAE3B,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAErC;IAED,0FAA0F;IAC1F,YAAY,OAAO,GAAE,MAAM,GAAG;QAAE,OAAO,EAAE,MAAM,CAAA;KAAY,EAI1D;IAED,sFAAsF;IACtF,OAAO,CAAC,MAAM,CAAC,WAAW;IAI1B,OAAO,CAAC,WAAW;IAOV,iBAAiB,IAAI,IAAI,CAEjC;CACF;AAED;;;GAGG;AACH,qBAAa,oBAAqB,SAAQ,qBAAqB;IAC7D,OAAuB,QAAQ,EAAE,MAAM,CAA0D;IACjG,OAAc,UAAU,SAAM;IAEvB,OAAO,EAAE,MAAM,CAAK;IACpB,SAAS,CAAC,EAAE,MAAM,CAAA;IAEzB,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,2BAA2B,GAAG,MAAM,CAG1D;IAED,YAAY,OAAO,EAAE,2BAA2B,EAAC;IACjD,YAAY,OAAO,EAAE,MAAM,EAAC;IAO5B,OAAO,CAAC,WAAW;IASV,iBAAiB,IAAI,IAAI,CAEjC;CACF;AAED;;;GAGG;AACH,qBAAa,qBAAsB,SAAQ,qBAAqB;IAC9D,OAAuB,QAAQ,EAAE,MAAM,CAA2D;IAClG,OAAc,UAAU,SAAM;IAEvB,MAAM,EAAE,MAAM,CAAK;IAE1B,YAAY,MAAM,GAAE,MAAgB,EAInC;IAED,OAAO,CAAC,WAAW;IAIV,iBAAiB,IAAI,IAAI,CAEjC;CACF;AAED;;;GAGG;AACH,qBAAa,uBAAwB,SAAQ,qBAAqB;IAChE,OAAuB,QAAQ,EAAE,MAAM,CAA6D;IACpG,OAAc,UAAU,SAAM;IAEvB,MAAM,EAAE,MAAM,CAAK;IAE1B,YAAY,MAAM,GAAE,MAAgB,EAInC;IAED,OAAO,CAAC,WAAW;IAIV,iBAAiB,IAAI,IAAI,CAEjC;CACF;AAED;;;;GAIG;AACH,qBAAa,qBAAsB,SAAQ,YAAY;IACrD,OAAuB,QAAQ,EAAE,MAAM,CAAkD;IACzF,OAAc,UAAU,SAAM;IAEvB,MAAM,EAAE,MAAM,CAAK;IACnB,YAAY,EAAE,MAAM,CAAI;IACxB,QAAQ,EAAE,MAAM,CAAK;IACrB,QAAQ,CAAC,EAAE,IAAI,CAAA;IAEtB,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,4BAA4B,GAAG,MAAM,CAG3D;IAED,YAAY,OAAO,EAAE,4BAA4B,EAAC;IAClD,YAAY,OAAO,EAAE,MAAM,EAAC;IAO5B,OAAO,CAAC,WAAW;IAWV,iBAAiB,IAAI,IAAI,CAEjC;CACF"}