mppx 0.6.18 → 0.6.20

package/dist/tempo/server/Subscription.d.ts

@@ -0,0 +1,221 @@
+import { type Address } from 'viem';
+import type { LooseOmit, MaybePromise, NoExtraKeys } from '../../internal/types.js';
+import * as Method from '../../Method.js';
+import * as Store from '../../Store.js';
+import type * as Client from '../../viem/Client.js';
+import * as Account from '../internal/account.js';
+import type * as types from '../internal/types.js';
+import * as Methods from '../Methods.js';
+import type { SubscriptionAccessKey, SubscriptionCredentialPayload, SubscriptionLookup, SubscriptionPeriodUnit, SubscriptionRecord, SubscriptionReceipt as SubscriptionReceiptValue } from '../subscription/Types.js';
+type SubscriptionRequest = ReturnType<typeof Methods.subscription.schema.request.parse>;
+/**
+ * Creates a Tempo subscription method for recurring TIP-20 token payments.
+ *
+ * The method handles activation, request-path reuse, and optional lazy renewals.
+ */
+export declare function subscription<const parameters extends subscription.Parameters>(p: NoExtraKeys<parameters, subscription.Parameters>): Method.Server<{
+    readonly name: "tempo";
+    readonly intent: "subscription";
+    readonly schema: {
+        readonly credential: {
+            readonly payload: import("zod/mini").ZodMiniObject<{
+                signature: import("zod/mini").ZodMiniString<string>;
+                type: import("zod/mini").ZodMiniLiteral<"keyAuthorization">;
+            }, import("zod/v4/core").$strip>;
+        };
+        readonly request: import("zod/mini").ZodMiniPipe<import("zod/mini").ZodMiniObject<{
+            amount: import("zod/mini").ZodMiniString<string>;
+            accessKey: import("zod/mini").ZodMiniOptional<import("zod/mini").ZodMiniObject<{
+                accessKeyAddress: import("zod/mini").ZodMiniPipe<import("zod/mini").ZodMiniString<string>, import("zod/mini").ZodMiniTransform<`0x${string}`, string>>;
+                keyType: import("zod/mini").ZodMiniEnum<{
+                    secp256k1: "secp256k1";
+                    p256: "p256";
+                    webAuthn: "webAuthn";
+                }>;
+            }, import("zod/v4/core").$strip>>;
+            chainId: import("zod/mini").ZodMiniOptional<import("zod/mini").ZodMiniNumber<number>>;
+            currency: import("zod/mini").ZodMiniPipe<import("zod/mini").ZodMiniString<string>, import("zod/mini").ZodMiniTransform<`0x${string}`, string>>;
+            decimals: import("zod/mini").ZodMiniNumber<number>;
+            description: import("zod/mini").ZodMiniOptional<import("zod/mini").ZodMiniString<string>>;
+            externalId: import("zod/mini").ZodMiniOptional<import("zod/mini").ZodMiniString<string>>;
+            methodDetails: import("zod/mini").ZodMiniOptional<import("zod/mini").ZodMiniObject<{
+                accessKey: import("zod/mini").ZodMiniOptional<import("zod/mini").ZodMiniObject<{
+                    accessKeyAddress: import("zod/mini").ZodMiniPipe<import("zod/mini").ZodMiniString<string>, import("zod/mini").ZodMiniTransform<`0x${string}`, string>>;
+                    keyType: import("zod/mini").ZodMiniEnum<{
+                        secp256k1: "secp256k1";
+                        p256: "p256";
+                        webAuthn: "webAuthn";
+                    }>;
+                }, import("zod/v4/core").$strip>>;
+                chainId: import("zod/mini").ZodMiniOptional<import("zod/mini").ZodMiniNumber<number>>;
+            }, import("zod/v4/core").$strip>>;
+            periodCount: import("zod/mini").ZodMiniPipe<import("zod/mini").ZodMiniUnion<readonly [import("zod/mini").ZodMiniString<string>, import("zod/mini").ZodMiniBigInt<bigint>, import("zod/mini").ZodMiniCustom<number, number>]>, import("zod/mini").ZodMiniTransform<string, string | number | bigint>>;
+            periodUnit: import("zod/mini").ZodMiniEnum<{
+                day: "day";
+                week: "week";
+            }>;
+            recipient: import("zod/mini").ZodMiniPipe<import("zod/mini").ZodMiniString<string>, import("zod/mini").ZodMiniTransform<`0x${string}`, string>>;
+            subscriptionExpires: import("zod/mini").ZodMiniPipe<import("zod/mini").ZodMiniUnion<readonly [import("zod/mini").ZodMiniString<string>, import("zod/mini").ZodMiniCustom<Date, Date>]>, import("zod/mini").ZodMiniTransform<Date, import("../../zod.js").DatetimeInput>>;
+        }, import("zod/v4/core").$strip>, import("zod/mini").ZodMiniTransform<{
+            methodDetails?: {
+                accessKey?: import("zod").infer<import("zod/mini").ZodMiniObject<{
+                    accessKeyAddress: import("zod/mini").ZodMiniPipe<import("zod/mini").ZodMiniString<string>, import("zod/mini").ZodMiniTransform<`0x${string}`, string>>;
+                    keyType: import("zod/mini").ZodMiniEnum<{
+                        secp256k1: "secp256k1";
+                        p256: "p256";
+                        webAuthn: "webAuthn";
+                    }>;
+                }, import("zod/v4/core").$strip>> | undefined;
+                chainId?: number | undefined;
+            } | undefined;
+            amount: string;
+            subscriptionExpires: string;
+            currency: `0x${string}`;
+            periodCount: string;
+            periodUnit: "day" | "week";
+            recipient: `0x${string}`;
+            description?: string | undefined;
+            externalId?: string | undefined;
+        }, {
+            amount: string;
+            currency: `0x${string}`;
+            decimals: number;
+            periodCount: string;
+            periodUnit: "day" | "week";
+            recipient: `0x${string}`;
+            subscriptionExpires: Date;
+            accessKey?: {
+                accessKeyAddress: `0x${string}`;
+                keyType: "secp256k1" | "p256" | "webAuthn";
+            } | undefined;
+            chainId?: number | undefined;
+            description?: string | undefined;
+            externalId?: string | undefined;
+            methodDetails?: {
+                accessKey?: {
+                    accessKeyAddress: `0x${string}`;
+                    keyType: "secp256k1" | "p256" | "webAuthn";
+                } | undefined;
+                chainId?: number | undefined;
+            } | undefined;
+        }>>;
+    };
+}, subscription.DeriveDefaults<parameters>, undefined>;
+/**
+ * Renews an overdue subscription outside of the HTTP request path.
+ * Intended for cron jobs or background workers that bill subscriptions on a schedule.
+ *
+ * Returns the renewal result if the subscription was overdue, or `null` if already current.
+ */
+export declare function renew(parameters: renew.Parameters): Promise<renew.Result | null>;
+export declare namespace renew {
+    /** Parameters for renewing an overdue subscription outside the request path. */
+    type Parameters = {
+        /** The subscription to renew. */
+        subscriptionId: string;
+        /** Billing callback — same signature as the `renew` hook on {@link subscription}. */
+        renew?: ((parameters: {
+            /** Stable idempotency/reconciliation reference persisted before the renewal hook runs. */
+            inFlightReference: string;
+            periodIndex: number;
+            subscription: SubscriptionRecord;
+        }) => Promise<subscription.RenewalResult>) | undefined;
+        /** Store containing subscription records. */
+        store: Store.AtomicStore<Record<string, unknown>>;
+        /**
+         * Milliseconds before an in-flight renewal lock can be replaced.
+         * Keeps concurrent renewal safe while allowing recovery from abandoned attempts.
+         */
+        renewalTimeoutMs?: number | undefined;
+        waitForConfirmation?: boolean | undefined;
+    } & Client.getResolver.Parameters;
+    /** Renewal result returned by {@link renew}. */
+    type Result = subscription.RenewalResult;
+}
+export declare namespace subscription {
+    /** Request-scoped lookup key used to find the active subscription. */
+    type ResolvedSubscription = SubscriptionLookup;
+    /** Activation result returned after the initial credential is verified. */
+    type ActivationResult = {
+        receipt: SubscriptionReceiptValue;
+        subscription: SubscriptionRecord;
+    };
+    /** Renewal result returned when an overdue subscription is charged. */
+    type RenewalResult = {
+        receipt: SubscriptionReceiptValue;
+        subscription: SubscriptionRecord;
+    };
+    /** Request defaults supported by the subscription method. */
+    type Defaults = LooseOmit<Method.RequestDefaults<typeof Methods.subscription>, 'accessKey' | 'recipient'>;
+    /** Parameters for configuring a Tempo subscription method. */
+    type Parameters = Account.resolve.Parameters & Client.getResolver.Parameters & {
+        accessKey?: ((parameters: {
+            input: Request;
+            request: SubscriptionRequest;
+            resolved: ResolvedSubscription;
+        }) => MaybePromise<SubscriptionAccessKey>) | undefined;
+        /**
+         * Milliseconds before an in-flight activation lock can be replaced.
+         * Keeps concurrent activation safe while allowing recovery from abandoned attempts.
+         */
+        activationTimeoutMs?: number | undefined;
+        /**
+         * Milliseconds before an in-flight renewal lock can be replaced.
+         * Keeps concurrent renewal safe while allowing recovery from abandoned attempts.
+         */
+        renewalTimeoutMs?: number | undefined;
+        activate?: ((parameters: {
+            /** Custom activation must verify this access key matches the resolved subscription. */
+            accessKey: SubscriptionAccessKey;
+            credential: {
+                payload: SubscriptionCredentialPayload;
+                source?: string | undefined;
+            };
+            input: Request;
+            request: SubscriptionRequest;
+            resolved: ResolvedSubscription;
+            source: {
+                address: Address;
+                chainId: number;
+            } | null;
+        }) => Promise<ActivationResult>) | undefined;
+        hooks?: {
+            activated?: ((parameters: {
+                receipt: SubscriptionReceiptValue;
+                subscription: SubscriptionRecord;
+            }) => MaybePromise<void>) | undefined;
+            renewed?: ((parameters: {
+                periodIndex: number;
+                receipt: SubscriptionReceiptValue;
+                subscription: SubscriptionRecord;
+            }) => MaybePromise<void>) | undefined;
+        } | undefined;
+        periodCount?: Methods.SubscriptionPeriodCountInput | undefined;
+        periodUnit?: SubscriptionPeriodUnit | undefined;
+        /**
+         * Resolves the request identity. This callback must authenticate and
+         * authorize the caller before returning a key; automatic mode may create
+         * a server-owned access key for that key while issuing a challenge.
+         */
+        resolve: (parameters: {
+            input: Request;
+            request: SubscriptionRequest;
+        }) => MaybePromise<ResolvedSubscription | null>;
+        renew?: (parameters: {
+            /** Stable idempotency/reconciliation reference persisted before the renewal hook runs. */
+            inFlightReference: string;
+            periodIndex: number;
+            /** Custom renewal hooks must preserve amount, currency, recipient, period, expiry, and lookup key. */
+            subscription: SubscriptionRecord;
+        }) => Promise<RenewalResult>;
+        store?: Store.AtomicStore<Record<string, unknown>> | undefined;
+        testnet?: boolean | undefined;
+        waitForConfirmation?: boolean | undefined;
+    } & Defaults;
+    /** Derived defaults after account and chain configuration are applied. */
+    type DeriveDefaults<parameters extends Parameters> = types.DeriveDefaults<parameters, Defaults> & {
+        decimals: number;
+    };
+}
+export {};
+//# sourceMappingURL=Subscription.d.ts.map

package/dist/tempo/server/Subscription.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Subscription.d.ts","sourceRoot":"","sources":["../../../src/tempo/server/Subscription.ts"],"names":[],"mappings":"AAEA,OAAO,EAAsC,KAAK,OAAO,EAA6B,MAAM,MAAM,CAAA;AAWlG,OAAO,KAAK,EAAE,SAAS,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAA;AACnF,OAAO,KAAK,MAAM,MAAM,iBAAiB,CAAA;AACzC,OAAO,KAAK,KAAK,MAAM,gBAAgB,CAAA;AACvC,OAAO,KAAK,KAAK,MAAM,MAAM,sBAAsB,CAAA;AAGnD,OAAO,KAAK,OAAO,MAAM,wBAAwB,CAAA;AAGjD,OAAO,KAAK,KAAK,KAAK,MAAM,sBAAsB,CAAA;AAClD,OAAO,KAAK,OAAO,MAAM,eAAe,CAAA;AAQxC,OAAO,KAAK,EACV,qBAAqB,EACrB,6BAA6B,EAC7B,kBAAkB,EAClB,sBAAsB,EACtB,kBAAkB,EAClB,mBAAmB,IAAI,wBAAwB,EAChD,MAAM,0BAA0B,CAAA;AAEjC,KAAK,mBAAmB,GAAG,UAAU,CAAC,OAAO,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;AAEvF;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,KAAK,CAAC,UAAU,SAAS,YAAY,CAAC,UAAU,EAC3E,CAAC,EAAE,WAAW,CAAC,UAAU,EAAE,YAAY,CAAC,UAAU,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;uDA8OpD;AAuiBD;;;;;GAKG;AACH,wBAAsB,KAAK,CAAC,UAAU,EAAE,KAAK,CAAC,UAAU,GAAG,OAAO,CAAC,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,CAqCtF;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,gFAAgF;IAChF,KAAK,UAAU,GAAG;QAChB,iCAAiC;QACjC,cAAc,EAAE,MAAM,CAAA;QACtB,qFAAqF;QACrF,KAAK,CAAC,EACF,CAAC,CAAC,UAAU,EAAE;YACZ,0FAA0F;YAC1F,iBAAiB,EAAE,MAAM,CAAA;YACzB,WAAW,EAAE,MAAM,CAAA;YACnB,YAAY,EAAE,kBAAkB,CAAA;SACjC,KAAK,OAAO,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC,GAC1C,SAAS,CAAA;QACb,6CAA6C;QAC7C,KAAK,EAAE,KAAK,CAAC,WAAW,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAA;QACjD;;;WAGG;QACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;QACrC,mBAAmB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;KAC1C,GAAG,MAAM,CAAC,WAAW,CAAC,UAAU,CAAA;IAEjC,gDAAgD;IAChD,KAAK,MAAM,GAAG,YAAY,CAAC,aAAa,CAAA;CACzC;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,sEAAsE;IACtE,KAAK,oBAAoB,GAAG,kBAAkB,CAAA;IAE9C,2EAA2E;IAC3E,KAAK,gBAAgB,GAAG;QACtB,OAAO,EAAE,wBAAwB,CAAA;QACjC,YAAY,EAAE,kBAAkB,CAAA;KACjC,CAAA;IAED,uEAAuE;IACvE,KAAK,aAAa,GAAG;QACnB,OAAO,EAAE,wBAAwB,CAAA;QACjC,YAAY,EAAE,kBAAkB,CAAA;KACjC,CAAA;IAED,6DAA6D;IAC7D,KAAK,QAAQ,GAAG,SAAS,CACvB,MAAM,CAAC,eAAe,CAAC,OAAO,OAAO,CAAC,YAAY,CAAC,EACnD,WAAW,GAAG,WAAW,CAC1B,CAAA;IAED,8DAA8D;IAC9D,KAAK,UAAU,GAAG,OAAO,CAAC,OAAO,CAAC,UAAU,GAC1C,MAAM,CAAC,WAAW,CAAC,UAAU,GAAG;QAC9B,SAAS,CAAC,EACN,CAAC,CAAC,UAAU,EAAE;YACZ,KAAK,EAAE,OAAO,CAAA;YACd,OAAO,EAAE,mBAAmB,CAAA;YAC5B,QAAQ,EAAE,oBAAoB,CAAA;SAC/B,KAAK,YAAY,CAAC,qBAAqB,CAAC,CAAC,GAC1C,SAAS,CAAA;QACb;;;WAGG;QACH,mBAAmB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;QACxC;;;WAGG;QACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;QACrC,QAAQ,CAAC,EACL,CAAC,CAAC,UAAU,EAAE;YACZ,uFAAuF;YACvF,SAAS,EAAE,qBAAqB,CAAA;YAChC,UAAU,EAAE;gBACV,OAAO,EAAE,6BAA6B,CAAA;gBACtC,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;aAC5B,CAAA;YACD,KAAK,EAAE,OAAO,CAAA;YACd,OAAO,EAAE,mBAAmB,CAAA;YAC5B,QAAQ,EAAE,oBAAoB,CAAA;YAC9B,MAAM,EAAE;gBAAE,OAAO,EAAE,OAAO,CAAC;gBAAC,OAAO,EAAE,MAAM,CAAA;aAAE,GAAG,IAAI,CAAA;SACrD,KAAK,OAAO,CAAC,gBAAgB,CAAC,CAAC,GAChC,SAAS,CAAA;QACb,KAAK,CAAC,EACF;YACE,SAAS,CAAC,EACN,CAAC,CAAC,UAAU,EAAE;gBACZ,OAAO,EAAE,wBAAwB,CAAA;gBACjC,YAAY,EAAE,kBAAkB,CAAA;aACjC,KAAK,YAAY,CAAC,IAAI,CAAC,CAAC,GACzB,SAAS,CAAA;YACb,OAAO,CAAC,EACJ,CAAC,CAAC,UAAU,EAAE;gBACZ,WAAW,EAAE,MAAM,CAAA;gBACnB,OAAO,EAAE,wBAAwB,CAAA;gBACjC,YAAY,EAAE,kBAAkB,CAAA;aACjC,KAAK,YAAY,CAAC,IAAI,CAAC,CAAC,GACzB,SAAS,CAAA;SACd,GACD,SAAS,CAAA;QACb,WAAW,CAAC,EAAE,OAAO,CAAC,4BAA4B,GAAG,SAAS,CAAA;QAC9D,UAAU,CAAC,EAAE,sBAAsB,GAAG,SAAS,CAAA;QAC/C;;;;WAIG;QACH,OAAO,EAAE,CAAC,UAAU,EAAE;YACpB,KAAK,EAAE,OAAO,CAAA;YACd,OAAO,EAAE,mBAAmB,CAAA;SAC7B,KAAK,YAAY,CAAC,oBAAoB,GAAG,IAAI,CAAC,CAAA;QAC/C,KAAK,CAAC,EAAE,CAAC,UAAU,EAAE;YACnB,0FAA0F;YAC1F,iBAAiB,EAAE,MAAM,CAAA;YACzB,WAAW,EAAE,MAAM,CAAA;YACnB,sGAAsG;YACtG,YAAY,EAAE,kBAAkB,CAAA;SACjC,KAAK,OAAO,CAAC,aAAa,CAAC,CAAA;QAC5B,KAAK,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,GAAG,SAAS,CAAA;QAC9D,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;QAC7B,mBAAmB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;KAC1C,GAAG,QAAQ,CAAA;IAEd,0EAA0E;IAC1E,KAAK,cAAc,CAAC,UAAU,SAAS,UAAU,IAAI,KAAK,CAAC,cAAc,CACvE,UAAU,EACV,QAAQ,CACT,GAAG;QACF,QAAQ,EAAE,MAAM,CAAA;KACjB,CAAA;CACF"}