@metamask/subscription-controller 9.1.0 → 10.0.1

package/dist/subscription-delegation/fingerprint.js

@@ -66,4 +66,44 @@ export function makeMatchesSubscriptionDelegation(expected) {
         }
     };
 }
+/**
+ * Reads the ERC-20 period-transfer `startDate` from a stored delegation.
+ *
+ * @param entry - Stored AUS delegation.
+ * @param enforcers - Enforcer addresses used to locate the period caveat.
+ * @returns Unix timestamp in seconds, or `undefined` when the caveat is
+ * missing or malformed.
+ */
+function getSubscriptionDelegationStartDate(entry, enforcers) {
+    const periodCaveat = entry.signedDelegation.caveats.find((caveat) => equalsIgnoreCase(caveat.enforcer, enforcers.erc20TokenPeriodTransfer));
+    if (!periodCaveat) {
+        return undefined;
+    }
+    try {
+        return Number(decodeERC20TokenPeriodTransferTerms(periodCaveat.terms).startDate);
+    }
+    catch {
+        return undefined;
+    }
+}
+/**
+ * Returns the fingerprint match with the latest period `startDate`.
+ *
+ * Equal `startDate`s keep list order. A delegation whose `startDate` cannot
+ * be read sorts last.
+ *
+ * @param matches - Fingerprint-matching AUS delegations, in list order.
+ * @param enforcers - Enforcer addresses used to read `startDate`.
+ * @returns The preferred match, or `undefined` when `matches` is empty.
+ */
+export function pickLatestMatchingSubscriptionDelegation(matches, enforcers) {
+    const byStartDateDescending = [...matches].sort((left, right) => {
+        const leftStart = getSubscriptionDelegationStartDate(left, enforcers) ??
+            Number.NEGATIVE_INFINITY;
+        const rightStart = getSubscriptionDelegationStartDate(right, enforcers) ??
+            Number.NEGATIVE_INFINITY;
+        return rightStart - leftStart;
+    });
+    return byStartDateDescending[0];
+}
 //# sourceMappingURL=fingerprint.js.map

package/dist/subscription-delegation/fingerprint.js.map

@@ -1 +1 @@
-{"version":3,"file":"fingerprint.js","sourceRoot":"","sources":["../../src/subscription-delegation/fingerprint.ts"],"names":[],"mappings":"AACA,OAAO,EACL,mCAAmC,EACnC,mBAAmB,GACpB,MAAM,2BAA2B,CAAC;AAInC,OAAO,EAAE,iCAAiC,EAAE,MAAM,YAAY,CAAC;AAsB/D;;;;;;GAMG;AACH,MAAM,UAAU,gBAAgB,CAAC,IAAY,EAAE,KAAa;IAC1D,OAAO,IAAI,CAAC,WAAW,EAAE,KAAK,KAAK,CAAC,WAAW,EAAE,CAAC;AACpD,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,iCAAiC,CAC/C,QAA2C;IAE3C,OAAO,CAAC,KAAK,EAAE,EAAE;QACf,IAAI,KAAK,CAAC,QAAQ,CAAC,IAAI,KAAK,iCAAiC,EAAE,CAAC;YAC9D,OAAO,KAAK,CAAC;QACf,CAAC;QACD,IACE,CAAC,gBAAgB,CACf,KAAK,CAAC,gBAAgB,CAAC,SAAS,EAChC,QAAQ,CAAC,gBAAgB,CAC1B,EACD,CAAC;YACD,OAAO,KAAK,CAAC;QACf,CAAC;QACD,IACE,CAAC,gBAAgB,CACf,KAAK,CAAC,gBAAgB,CAAC,QAAQ,EAC/B,QAAQ,CAAC,eAAe,CACzB,EACD,CAAC;YACD,OAAO,KAAK,CAAC;QACf,CAAC;QACD,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,QAAQ,CAAC,UAAU,EAAE,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;YACnE,OAAO,KAAK,CAAC;QACf,CAAC;QACD,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,QAAQ,CAAC,YAAY,EAAE,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC;YAC1E,OAAO,KAAK,CAAC;QACf,CAAC;QAED,MAAM,EAAE,OAAO,EAAE,GAAG,KAAK,CAAC,gBAAgB,CAAC;QAC3C,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACvB,OAAO,KAAK,CAAC;QACf,CAAC;QAED,MAAM,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAC7C,gBAAgB,CAAC,MAAM,CAAC,QAAQ,EAAE,QAAQ,CAAC,SAAS,CAAC,QAAQ,CAAC,CAC/D,CAAC;QACF,MAAM,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAC3C,gBAAgB,CACd,MAAM,CAAC,QAAQ,EACf,QAAQ,CAAC,SAAS,CAAC,wBAAwB,CAC5C,CACF,CAAC;QACF,IAAI,CAAC,cAAc,IAAI,CAAC,YAAY,EAAE,CAAC;YACrC,OAAO,KAAK,CAAC;QACf,CAAC;QAED,IAAI,CAAC;YACH,MAAM,UAAU,GAAG,mBAAmB,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;YAC7D,IAAI,UAAU,CAAC,QAAQ,KAAK,EAAE,EAAE,CAAC;gBAC/B,OAAO,KAAK,CAAC;YACf,CAAC;YAED,MAAM,WAAW,GAAG,mCAAmC,CACrD,YAAY,CAAC,KAAK,CACnB,CAAC;YACF,MAAM,eAAe,GAAG,MAAM,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;YACtD,MAAM,gBAAgB,GAAG,eAAe,GAAG,QAAQ,CAAC,UAAU,CAAC;YAC/D,IAAI,QAAQ,CAAC,eAAe,KAAK,gBAAgB,EAAE,CAAC;gBAClD,OAAO,KAAK,CAAC;YACf,CAAC;YAED,OAAO,CACL,gBAAgB,CAAC,WAAW,CAAC,YAAY,EAAE,QAAQ,CAAC,YAAY,CAAC;gBACjE,WAAW,CAAC,YAAY,KAAK,QAAQ,CAAC,YAAY;gBAClD,MAAM,CAAC,WAAW,CAAC,cAAc,CAAC,KAAK,QAAQ,CAAC,cAAc,CAC/D,CAAC;QACJ,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC,CAAC;AACJ,CAAC","sourcesContent":["import type { DelegationResponse } from '@metamask/authenticated-user-storage';\nimport {\n  decodeERC20TokenPeriodTransferTerms,\n  decodeValueLteTerms,\n} from '@metamask/delegation-core';\nimport type { Hex } from '@metamask/utils';\n\nimport type { SubscriptionDelegationEnforcers } from './types.js';\nimport { CASH_SUBSCRIPTION_DELEGATION_TYPE } from './types.js';\n\nexport type SubscriptionDelegationFingerprint = {\n  delegatorAddress: Hex;\n  delegateAddress: Hex;\n  chainId: Hex;\n  tokenAddress: Hex;\n  periodAmount: bigint;\n  periodDuration: number;\n  /**\n   * Current unix timestamp in seconds. Used to classify a stored period\n   * `startDate` as immediately redeemable (`<= now`) vs trial-deferred (`> now`).\n   */\n  nowSeconds: number;\n  /**\n   * When true, only a still-deferred period start (`> nowSeconds`) matches.\n   * When false, only an immediately redeemable start (`<= nowSeconds`) matches.\n   */\n  isTrialDeferred: boolean;\n  enforcers: SubscriptionDelegationEnforcers;\n};\n\n/**\n * Case-insensitive hex equality.\n *\n * @param left - First hex value.\n * @param right - Second hex value.\n * @returns Whether the values are equal ignoring case.\n */\nexport function equalsIgnoreCase(left: string, right: string): boolean {\n  return left.toLowerCase() === right.toLowerCase();\n}\n\n/**\n * Builds a predicate that matches a stored AUS delegation to the semantic\n * cash-subscription fingerprint. Salt is ignored so a previously signed\n * equivalent permission can be reused. Period `startDate` is compared only\n * as trial-deferred (`> nowSeconds`) vs immediately redeemable (`<= nowSeconds`)\n * so a positive-length trial cannot reuse a live permission and vice versa.\n *\n * @param expected - Semantic fields that must match.\n * @returns Predicate over {@link DelegationResponse}.\n */\nexport function makeMatchesSubscriptionDelegation(\n  expected: SubscriptionDelegationFingerprint,\n): (entry: DelegationResponse) => boolean {\n  return (entry) => {\n    if (entry.metadata.type !== CASH_SUBSCRIPTION_DELEGATION_TYPE) {\n      return false;\n    }\n    if (\n      !equalsIgnoreCase(\n        entry.signedDelegation.delegator,\n        expected.delegatorAddress,\n      )\n    ) {\n      return false;\n    }\n    if (\n      !equalsIgnoreCase(\n        entry.signedDelegation.delegate,\n        expected.delegateAddress,\n      )\n    ) {\n      return false;\n    }\n    if (!equalsIgnoreCase(entry.metadata.chainIdHex, expected.chainId)) {\n      return false;\n    }\n    if (!equalsIgnoreCase(entry.metadata.tokenAddress, expected.tokenAddress)) {\n      return false;\n    }\n\n    const { caveats } = entry.signedDelegation;\n    if (caveats.length < 2) {\n      return false;\n    }\n\n    const valueLteCaveat = caveats.find((caveat) =>\n      equalsIgnoreCase(caveat.enforcer, expected.enforcers.valueLte),\n    );\n    const periodCaveat = caveats.find((caveat) =>\n      equalsIgnoreCase(\n        caveat.enforcer,\n        expected.enforcers.erc20TokenPeriodTransfer,\n      ),\n    );\n    if (!valueLteCaveat || !periodCaveat) {\n      return false;\n    }\n\n    try {\n      const valueTerms = decodeValueLteTerms(valueLteCaveat.terms);\n      if (valueTerms.maxValue !== 0n) {\n        return false;\n      }\n\n      const periodTerms = decodeERC20TokenPeriodTransferTerms(\n        periodCaveat.terms,\n      );\n      const storedStartDate = Number(periodTerms.startDate);\n      const isStoredDeferred = storedStartDate > expected.nowSeconds;\n      if (expected.isTrialDeferred !== isStoredDeferred) {\n        return false;\n      }\n\n      return (\n        equalsIgnoreCase(periodTerms.tokenAddress, expected.tokenAddress) &&\n        periodTerms.periodAmount === expected.periodAmount &&\n        Number(periodTerms.periodDuration) === expected.periodDuration\n      );\n    } catch {\n      return false;\n    }\n  };\n}\n"]}
+{"version":3,"file":"fingerprint.js","sourceRoot":"","sources":["../../src/subscription-delegation/fingerprint.ts"],"names":[],"mappings":"AACA,OAAO,EACL,mCAAmC,EACnC,mBAAmB,GACpB,MAAM,2BAA2B,CAAC;AAInC,OAAO,EAAE,iCAAiC,EAAE,MAAM,YAAY,CAAC;AAsB/D;;;;;;GAMG;AACH,MAAM,UAAU,gBAAgB,CAAC,IAAY,EAAE,KAAa;IAC1D,OAAO,IAAI,CAAC,WAAW,EAAE,KAAK,KAAK,CAAC,WAAW,EAAE,CAAC;AACpD,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,iCAAiC,CAC/C,QAA2C;IAE3C,OAAO,CAAC,KAAK,EAAE,EAAE;QACf,IAAI,KAAK,CAAC,QAAQ,CAAC,IAAI,KAAK,iCAAiC,EAAE,CAAC;YAC9D,OAAO,KAAK,CAAC;QACf,CAAC;QACD,IACE,CAAC,gBAAgB,CACf,KAAK,CAAC,gBAAgB,CAAC,SAAS,EAChC,QAAQ,CAAC,gBAAgB,CAC1B,EACD,CAAC;YACD,OAAO,KAAK,CAAC;QACf,CAAC;QACD,IACE,CAAC,gBAAgB,CACf,KAAK,CAAC,gBAAgB,CAAC,QAAQ,EAC/B,QAAQ,CAAC,eAAe,CACzB,EACD,CAAC;YACD,OAAO,KAAK,CAAC;QACf,CAAC;QACD,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,QAAQ,CAAC,UAAU,EAAE,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;YACnE,OAAO,KAAK,CAAC;QACf,CAAC;QACD,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,QAAQ,CAAC,YAAY,EAAE,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC;YAC1E,OAAO,KAAK,CAAC;QACf,CAAC;QAED,MAAM,EAAE,OAAO,EAAE,GAAG,KAAK,CAAC,gBAAgB,CAAC;QAC3C,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACvB,OAAO,KAAK,CAAC;QACf,CAAC;QAED,MAAM,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAC7C,gBAAgB,CAAC,MAAM,CAAC,QAAQ,EAAE,QAAQ,CAAC,SAAS,CAAC,QAAQ,CAAC,CAC/D,CAAC;QACF,MAAM,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAC3C,gBAAgB,CACd,MAAM,CAAC,QAAQ,EACf,QAAQ,CAAC,SAAS,CAAC,wBAAwB,CAC5C,CACF,CAAC;QACF,IAAI,CAAC,cAAc,IAAI,CAAC,YAAY,EAAE,CAAC;YACrC,OAAO,KAAK,CAAC;QACf,CAAC;QAED,IAAI,CAAC;YACH,MAAM,UAAU,GAAG,mBAAmB,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;YAC7D,IAAI,UAAU,CAAC,QAAQ,KAAK,EAAE,EAAE,CAAC;gBAC/B,OAAO,KAAK,CAAC;YACf,CAAC;YAED,MAAM,WAAW,GAAG,mCAAmC,CACrD,YAAY,CAAC,KAAK,CACnB,CAAC;YACF,MAAM,eAAe,GAAG,MAAM,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;YACtD,MAAM,gBAAgB,GAAG,eAAe,GAAG,QAAQ,CAAC,UAAU,CAAC;YAC/D,IAAI,QAAQ,CAAC,eAAe,KAAK,gBAAgB,EAAE,CAAC;gBAClD,OAAO,KAAK,CAAC;YACf,CAAC;YAED,OAAO,CACL,gBAAgB,CAAC,WAAW,CAAC,YAAY,EAAE,QAAQ,CAAC,YAAY,CAAC;gBACjE,WAAW,CAAC,YAAY,KAAK,QAAQ,CAAC,YAAY;gBAClD,MAAM,CAAC,WAAW,CAAC,cAAc,CAAC,KAAK,QAAQ,CAAC,cAAc,CAC/D,CAAC;QACJ,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC,CAAC;AACJ,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,kCAAkC,CACzC,KAAyB,EACzB,SAA0C;IAE1C,MAAM,YAAY,GAAG,KAAK,CAAC,gBAAgB,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAClE,gBAAgB,CAAC,MAAM,CAAC,QAAQ,EAAE,SAAS,CAAC,wBAAwB,CAAC,CACtE,CAAC;IACF,IAAI,CAAC,YAAY,EAAE,CAAC;QAClB,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,IAAI,CAAC;QACH,OAAO,MAAM,CACX,mCAAmC,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,SAAS,CAClE,CAAC;IACJ,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,SAAS,CAAC;IACnB,CAAC;AACH,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,wCAAwC,CACtD,OAAsC,EACtC,SAA0C;IAE1C,MAAM,qBAAqB,GAAG,CAAC,GAAG,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;QAC9D,MAAM,SAAS,GACb,kCAAkC,CAAC,IAAI,EAAE,SAAS,CAAC;YACnD,MAAM,CAAC,iBAAiB,CAAC;QAC3B,MAAM,UAAU,GACd,kCAAkC,CAAC,KAAK,EAAE,SAAS,CAAC;YACpD,MAAM,CAAC,iBAAiB,CAAC;QAC3B,OAAO,UAAU,GAAG,SAAS,CAAC;IAChC,CAAC,CAAC,CAAC;IAEH,OAAO,qBAAqB,CAAC,CAAC,CAAC,CAAC;AAClC,CAAC","sourcesContent":["import type { DelegationResponse } from '@metamask/authenticated-user-storage';\nimport {\n  decodeERC20TokenPeriodTransferTerms,\n  decodeValueLteTerms,\n} from '@metamask/delegation-core';\nimport type { Hex } from '@metamask/utils';\n\nimport type { SubscriptionDelegationEnforcers } from './types.js';\nimport { CASH_SUBSCRIPTION_DELEGATION_TYPE } from './types.js';\n\nexport type SubscriptionDelegationFingerprint = {\n  delegatorAddress: Hex;\n  delegateAddress: Hex;\n  chainId: Hex;\n  tokenAddress: Hex;\n  periodAmount: bigint;\n  periodDuration: number;\n  /**\n   * Current unix timestamp in seconds. Used to classify a stored period\n   * `startDate` as immediately redeemable (`<= now`) vs trial-deferred (`> now`).\n   */\n  nowSeconds: number;\n  /**\n   * When true, only a still-deferred period start (`> nowSeconds`) matches.\n   * When false, only an immediately redeemable start (`<= nowSeconds`) matches.\n   */\n  isTrialDeferred: boolean;\n  enforcers: SubscriptionDelegationEnforcers;\n};\n\n/**\n * Case-insensitive hex equality.\n *\n * @param left - First hex value.\n * @param right - Second hex value.\n * @returns Whether the values are equal ignoring case.\n */\nexport function equalsIgnoreCase(left: string, right: string): boolean {\n  return left.toLowerCase() === right.toLowerCase();\n}\n\n/**\n * Builds a predicate that matches a stored AUS delegation to the semantic\n * cash-subscription fingerprint. Salt is ignored so a previously signed\n * equivalent permission can be reused. Period `startDate` is compared only\n * as trial-deferred (`> nowSeconds`) vs immediately redeemable (`<= nowSeconds`)\n * so a positive-length trial cannot reuse a live permission and vice versa.\n *\n * @param expected - Semantic fields that must match.\n * @returns Predicate over {@link DelegationResponse}.\n */\nexport function makeMatchesSubscriptionDelegation(\n  expected: SubscriptionDelegationFingerprint,\n): (entry: DelegationResponse) => boolean {\n  return (entry) => {\n    if (entry.metadata.type !== CASH_SUBSCRIPTION_DELEGATION_TYPE) {\n      return false;\n    }\n    if (\n      !equalsIgnoreCase(\n        entry.signedDelegation.delegator,\n        expected.delegatorAddress,\n      )\n    ) {\n      return false;\n    }\n    if (\n      !equalsIgnoreCase(\n        entry.signedDelegation.delegate,\n        expected.delegateAddress,\n      )\n    ) {\n      return false;\n    }\n    if (!equalsIgnoreCase(entry.metadata.chainIdHex, expected.chainId)) {\n      return false;\n    }\n    if (!equalsIgnoreCase(entry.metadata.tokenAddress, expected.tokenAddress)) {\n      return false;\n    }\n\n    const { caveats } = entry.signedDelegation;\n    if (caveats.length < 2) {\n      return false;\n    }\n\n    const valueLteCaveat = caveats.find((caveat) =>\n      equalsIgnoreCase(caveat.enforcer, expected.enforcers.valueLte),\n    );\n    const periodCaveat = caveats.find((caveat) =>\n      equalsIgnoreCase(\n        caveat.enforcer,\n        expected.enforcers.erc20TokenPeriodTransfer,\n      ),\n    );\n    if (!valueLteCaveat || !periodCaveat) {\n      return false;\n    }\n\n    try {\n      const valueTerms = decodeValueLteTerms(valueLteCaveat.terms);\n      if (valueTerms.maxValue !== 0n) {\n        return false;\n      }\n\n      const periodTerms = decodeERC20TokenPeriodTransferTerms(\n        periodCaveat.terms,\n      );\n      const storedStartDate = Number(periodTerms.startDate);\n      const isStoredDeferred = storedStartDate > expected.nowSeconds;\n      if (expected.isTrialDeferred !== isStoredDeferred) {\n        return false;\n      }\n\n      return (\n        equalsIgnoreCase(periodTerms.tokenAddress, expected.tokenAddress) &&\n        periodTerms.periodAmount === expected.periodAmount &&\n        Number(periodTerms.periodDuration) === expected.periodDuration\n      );\n    } catch {\n      return false;\n    }\n  };\n}\n\n/**\n * Reads the ERC-20 period-transfer `startDate` from a stored delegation.\n *\n * @param entry - Stored AUS delegation.\n * @param enforcers - Enforcer addresses used to locate the period caveat.\n * @returns Unix timestamp in seconds, or `undefined` when the caveat is\n * missing or malformed.\n */\nfunction getSubscriptionDelegationStartDate(\n  entry: DelegationResponse,\n  enforcers: SubscriptionDelegationEnforcers,\n): number | undefined {\n  const periodCaveat = entry.signedDelegation.caveats.find((caveat) =>\n    equalsIgnoreCase(caveat.enforcer, enforcers.erc20TokenPeriodTransfer),\n  );\n  if (!periodCaveat) {\n    return undefined;\n  }\n\n  try {\n    return Number(\n      decodeERC20TokenPeriodTransferTerms(periodCaveat.terms).startDate,\n    );\n  } catch {\n    return undefined;\n  }\n}\n\n/**\n * Returns the fingerprint match with the latest period `startDate`.\n *\n * Equal `startDate`s keep list order. A delegation whose `startDate` cannot\n * be read sorts last.\n *\n * @param matches - Fingerprint-matching AUS delegations, in list order.\n * @param enforcers - Enforcer addresses used to read `startDate`.\n * @returns The preferred match, or `undefined` when `matches` is empty.\n */\nexport function pickLatestMatchingSubscriptionDelegation(\n  matches: readonly DelegationResponse[],\n  enforcers: SubscriptionDelegationEnforcers,\n): DelegationResponse | undefined {\n  const byStartDateDescending = [...matches].sort((left, right) => {\n    const leftStart =\n      getSubscriptionDelegationStartDate(left, enforcers) ??\n      Number.NEGATIVE_INFINITY;\n    const rightStart =\n      getSubscriptionDelegationStartDate(right, enforcers) ??\n      Number.NEGATIVE_INFINITY;\n    return rightStart - leftStart;\n  });\n\n  return byStartDateDescending[0];\n}\n"]}

package/dist/types.d.ts

@@ -90,6 +90,13 @@ export declare const SUBSCRIPTION_STATUSES: {
     readonly paused: 'paused';
 };
 export type SubscriptionStatus = (typeof SUBSCRIPTION_STATUSES)[keyof typeof SUBSCRIPTION_STATUSES];
+export declare const INVOICE_PAYMENT_STATUSES: {
+    readonly PROCESSING: 'PROCESSING';
+    readonly SUCCEEDED: 'SUCCEEDED';
+    readonly FAILED: 'FAILED';
+    readonly UNKNOWN: 'UNKNOWN';
+};
+export type InvoicePaymentStatus = (typeof INVOICE_PAYMENT_STATUSES)[keyof typeof INVOICE_PAYMENT_STATUSES];
 export declare const CANCEL_TYPES: {
     readonly ALLOWED_IMMEDIATE: 'allowed_immediate';
     readonly ALLOWED_AT_PERIOD_END: 'allowed_at_period_end';
@@ -106,6 +113,22 @@ export declare const CRYPTO_PAYMENT_METHOD_ERRORS: {
     readonly INSUFFICIENT_ALLOWANCE: 'insufficient_allowance';
 };
 export type CryptoPaymentMethodError = (typeof CRYPTO_PAYMENT_METHOD_ERRORS)[keyof typeof CRYPTO_PAYMENT_METHOD_ERRORS];
+/**
+ * Errors returned by the Subscription API after crypto payment execution.
+ *
+ * These are distinct from {@link CRYPTO_PAYMENT_METHOD_ERRORS}, which describe
+ * approval/payment-method failures.
+ */
+export declare const CRYPTO_PAYMENT_ERRORS: {
+    readonly INSUFFICIENT_BALANCE: 'insufficient_balance';
+    readonly INSUFFICIENT_ALLOWANCE: 'insufficient_allowance';
+    readonly EXCEEDS_DELEGATION_ALLOWANCE: 'exceeds_delegation_allowance';
+    readonly DELEGATION_NOT_FOUND: 'delegation_not_found';
+    readonly DELEGATION_REVOKED: 'delegation_revoked';
+    readonly RECIPIENT_NOT_ALLOWLISTED: 'recipient_not_allowlisted';
+    readonly INTERNAL_SERVER_ERROR: 'internal_server_error';
+};
+export type CryptoPaymentError = (typeof CRYPTO_PAYMENT_ERRORS)[keyof typeof CRYPTO_PAYMENT_ERRORS];
 export declare const MODAL_TYPE: {
     readonly A: 'A';
     readonly B: 'B';
@@ -122,8 +145,8 @@ export type Product = {
 export type Subscription = {
     id: string;
     products: Product[];
-    currentPeriodStart: string;
-    currentPeriodEnd: string;
+    currentPeriodStart?: string;
+    currentPeriodEnd?: string;
     /** is subscription scheduled for cancellation */
     cancelAtPeriodEnd?: boolean;
     status: SubscriptionStatus;
@@ -137,12 +160,20 @@ export type Subscription = {
     /** The date the subscription was canceled. */
     canceledAt?: string;
     /** The cancellation type indicating what cancellation options are available for this subscription. */
-    cancelType: CancelType;
+    cancelType?: CancelType;
     /** The date the subscription was marked as inactive (paused/past_due/canceled). */
     inactiveAt?: string;
     /** Whether the user is eligible for support features (priority support and filing claims). True for active subscriptions and inactive subscriptions within grace period. */
-    isEligibleForSupport: boolean;
+    isEligibleForSupport?: boolean;
     billingCycles?: number;
+    /** The most recent invoice associated with the subscription. */
+    lastInvoice?: SubscriptionInvoice;
+};
+export type SubscriptionInvoice = {
+    id: string;
+    status: InvoicePaymentStatus;
+    errorCode?: CryptoPaymentError;
+    updatedAt: string;
 };
 export type SubscriptionCardPaymentMethod = {
     type: Extract<PaymentType, 'card'>;
@@ -352,27 +383,62 @@ type TokenPaymentInfoBase = {
     sources?: TokenPaymentInfo[];
 };
 /**
- * Spot (non-vault) settlement token. Priced via `conversionRate` when provided.
- * `accountantAddress` is not present on this variant.
+ * Named vault a vault-share settlement token belongs to, e.g. `base` or
+ * `premium`. Distinguishes which vault to withdraw from.
+ *
+ * Deliberately a plain `string` rather than a union: the set of vaults is
+ * server-driven and grows without a client release, so narrowing it here would
+ * make the pricing response fail validation the first time the API adds a
+ * vault. Compare against `VAULT_NAMES` instead of raw literals, and always
+ * handle the unknown case.
  */
-export type SpotTokenPaymentInfo = TokenPaymentInfoBase & {
-    isVaultShare?: false;
+export type VaultName = string;
+/**
+ * The vault names known at the time of writing. Not exhaustive — see
+ * {@link VaultName}.
+ */
+export declare const VAULT_NAMES: {
+    readonly base: 'base';
+    readonly premium: 'premium';
 };
+/**
+ * Spot (non-vault) settlement token. Priced via `conversionRate` when provided.
+ * Neither `accountantAddress` nor `vault` is present on this variant.
+ */
+export type SpotTokenPaymentInfo = TokenPaymentInfoBase;
 /**
  * Yield-bearing vault share priced via an accountant rate.
  */
 export type VaultTokenPaymentInfo = TokenPaymentInfoBase & {
-    isVaultShare: true;
     /**
-     * Veda accountant address used to value this vault share.
+     * Veda accountant address used to value this vault share. Every vault has
+     * its own accountant, so this is present on every vault-share token — which
+     * is what makes it the discriminant for this variant.
      */
     accountantAddress: Hex;
+    /**
+     * Named vault this token is a share of. Sent only for vault-share tokens.
+     */
+    vault?: VaultName;
 };
 /**
- * A settlement token in a pricing chain. Discriminated by `isVaultShare`:
- * vault shares require `accountantAddress`; spot tokens omit it.
+ * A settlement token in a pricing chain. Discriminated by the presence of
+ * `accountantAddress`: vault shares carry it (and may carry `vault`), spot
+ * tokens carry neither.
+ *
+ * The API previously sent an explicit `isVaultShare` boolean. It no longer
+ * does, so do not reintroduce a dependency on it — use
+ * {@link isVaultShareToken}.
  */
 export type TokenPaymentInfo = SpotTokenPaymentInfo | VaultTokenPaymentInfo;
+/**
+ * Whether a settlement token is a yield-bearing vault share, which must be
+ * valued through its accountant rate rather than at face value.
+ *
+ * @param token - The settlement token to check.
+ * @returns True if the token is a vault share.
+ */
+export declare function isVaultShareToken(token: TokenPaymentInfo): token is VaultTokenPaymentInfo;
 export type ChainPaymentInfo = {
     chainId: Hex;
     paymentAddress: Hex;
@@ -589,19 +655,43 @@ export type UpdatePaymentMethodCardRequest = {
 export type UpdatePaymentMethodCardResponse = {
     redirectUrl: string;
 };
-export type UpdatePaymentMethodCryptoRequest = {
+type UpdatePaymentMethodCryptoRequestBase = {
     subscriptionId: string;
     chainId: Hex;
     payerAddress: Hex;
     tokenSymbol: string;
+    recurringInterval: RecurringInterval;
+    billingCycles: number;
+};
+/**
+ * ERC-20 approval crypto payment-method update request.
+ *
+ * `rawTransaction` may be omitted when retrying after a balance top-up.
+ */
+export type UpdateErc20PaymentMethodCryptoRequest = UpdatePaymentMethodCryptoRequestBase & {
+    cryptoAuthMethod?: typeof CRYPTO_AUTH_METHODS.ERC20_APPROVAL;
     /**
-     * The raw transaction to pay for the subscription
-     * Can be empty if retry after topping up balance
+     * The raw transaction to pay for the subscription.
      */
     rawTransaction?: Hex;
-    recurringInterval: RecurringInterval;
-    billingCycles: number;
+    delegationHash?: never;
+};
+/**
+ * Delegation crypto payment-method update request used to rotate an active
+ * subscription to a replacement delegation.
+ */
+export type UpdateDelegationPaymentMethodCryptoRequest = UpdatePaymentMethodCryptoRequestBase & {
+    cryptoAuthMethod: typeof CRYPTO_AUTH_METHODS.DELEGATION;
+    delegationHash: Hex;
+    rawTransaction?: never;
 };
+/**
+ * Request to update a subscription's crypto payment method.
+ *
+ * Provide `rawTransaction` for the existing ERC-20 approval path, or provide
+ * `cryptoAuthMethod: 'delegation'` and `delegationHash` to rotate a delegation.
+ */
+export type UpdatePaymentMethodCryptoRequest = UpdateErc20PaymentMethodCryptoRequest | UpdateDelegationPaymentMethodCryptoRequest;
 export type BillingPortalResponse = {
     url: string;
 };

package/dist/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,kCAAkC,CAAC;AACxE,OAAO,KAAK,EAAE,aAAa,EAAE,GAAG,EAAE,MAAM,iBAAiB,CAAC;AAE1D,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAC;AAE3D;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,aAAa;IACxB;;OAEG;aACH,MAAM,EAAE,QAAQ;IAChB;;OAEG;aACH,kBAAkB,EAAE,oBAAoB;CAChC,CAAC;AAEX,MAAM,MAAM,WAAW,GAAG,CAAC,OAAO,aAAa,CAAC,CAAC,MAAM,OAAO,aAAa,CAAC,CAAC;AAE7E,eAAO,MAAM,mBAAmB;aAC9B,aAAa,EAAE,eAAe;aAC9B,cAAc,EAAE,gBAAgB;aAChC,aAAa,EAAE,eAAe;aAC9B,UAAU,EAAE,YAAY;CAChB,CAAC;AAEX,MAAM,MAAM,mBAAmB,GAC7B,CAAC,OAAO,mBAAmB,CAAC,CAAC,MAAM,OAAO,mBAAmB,CAAC,CAAC;AAEjE,MAAM,MAAM,wBAAwB,GAAG,MAAM,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAC;AAE5E,eAAO,MAAM,aAAa;aACxB,WAAW,EAAE,aAAa;aAC1B,eAAe,EAAE,iBAAiB;CAC1B,CAAC;AAEX,MAAM,MAAM,aAAa,GAAG,CAAC,OAAO,aAAa,CAAC,CAAC,MAAM,OAAO,aAAa,CAAC,CAAC;AAE/E,MAAM,MAAM,kBAAkB,GAAG,MAAM,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC;AAEhE,MAAM,MAAM,qBAAqB,GAAG;IAClC,IAAI,EAAE,MAAM,CAAC;IACb,YAAY,EAAE,wBAAwB,CAAC;CACxC,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,EAAE;QACvB,YAAY,EAAE,kBAAkB,CAAC;KAClC,CAAC;IACF,CAAC,aAAa,CAAC,kBAAkB,CAAC,CAAC,EAAE,qBAAqB,CAAC;CAC5D,CAAC;AAEF,MAAM,MAAM,4BAA4B,GAAG;IACzC,CAAC,aAAa,CAAC,MAAM,CAAC,EAAE,aAAa,CAAC;IACtC,CAAC,aAAa,CAAC,kBAAkB,CAAC,EAAE,mBAAmB,CAAC;CACzD,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,mBAAmB;IAC9B;;OAEG;aACH,cAAc,EAAE,gBAAgB;IAChC;;OAEG;aACH,UAAU,EAAE,YAAY;CAChB,CAAC;AAEX,MAAM,MAAM,gBAAgB,GAC1B,CAAC,OAAO,mBAAmB,CAAC,CAAC,MAAM,OAAO,mBAAmB,CAAC,CAAC;AAEjE,eAAO,MAAM,aAAa;aACxB,MAAM,EAAE,MAAM;aACd,QAAQ,EAAE,QAAQ;CACV,CAAC;AAEX,MAAM,MAAM,WAAW,GAAG,CAAC,OAAO,aAAa,CAAC,CAAC,MAAM,OAAO,aAAa,CAAC,CAAC;AAE7E,eAAO,MAAM,mBAAmB;aAC9B,KAAK,EAAE,OAAO;aACd,IAAI,EAAE,MAAM;CACJ,CAAC;AAEX,MAAM,MAAM,iBAAiB,GAC3B,CAAC,OAAO,mBAAmB,CAAC,CAAC,MAAM,OAAO,mBAAmB,CAAC,CAAC;AAEjE,eAAO,MAAM,qBAAqB;aAEhC,UAAU,EAAE,YAAY;aACxB,iBAAiB,EAAE,oBAAoB;aAEvC,WAAW,EAAE,aAAa;aAC1B,QAAQ,EAAE,UAAU;aACpB,MAAM,EAAE,QAAQ;aAEhB,OAAO,EAAE,UAAU;aACnB,MAAM,EAAE,QAAQ;aAEhB,QAAQ,EAAE,UAAU;aAEpB,MAAM,EAAE,QAAQ;CACR,CAAC;AAEX,MAAM,MAAM,kBAAkB,GAC5B,CAAC,OAAO,qBAAqB,CAAC,CAAC,MAAM,OAAO,qBAAqB,CAAC,CAAC;AAErE,eAAO,MAAM,YAAY;aACvB,iBAAiB,EAAE,mBAAmB;aACtC,qBAAqB,EAAE,uBAAuB;aAC9C,WAAW,EAAE,aAAa;aAC1B,gCAAgC,EAAE,kCAAkC;CAC5D,CAAC;AAEX,MAAM,MAAM,UAAU,GAAG,CAAC,OAAO,YAAY,CAAC,CAAC,MAAM,OAAO,YAAY,CAAC,CAAC;AAE1E,MAAM,MAAM,sBAAsB,GAChC,CAAC,OAAO,oBAAoB,CAAC,CAAC,MAAM,OAAO,oBAAoB,CAAC,CAAC;AAEnE,eAAO,MAAM,4BAA4B;aACvC,4BAA4B,EAAE,8BAA8B;aAC5D,6BAA6B,EAAE,+BAA+B;aAC9D,sDAAsD,EACpD,wDAAwD;aAC1D,oBAAoB,EAAE,sBAAsB;aAC5C,sBAAsB,EAAE,wBAAwB;CACxC,CAAC;AAEX,MAAM,MAAM,wBAAwB,GAClC,CAAC,OAAO,4BAA4B,CAAC,CAAC,MAAM,OAAO,4BAA4B,CAAC,CAAC;AAEnF,eAAO,MAAM,UAAU;aACrB,CAAC,EAAE,GAAG;aACN,CAAC,EAAE,GAAG;CACE,CAAC;AAEX,MAAM,MAAM,SAAS,GAAG,CAAC,OAAO,UAAU,CAAC,CAAC,MAAM,OAAO,UAAU,CAAC,CAAC;AAErE,uBAAuB;AACvB,MAAM,MAAM,QAAQ,GAAG,KAAK,CAAC;AAE7B,MAAM,MAAM,OAAO,GAAG;IACpB,IAAI,EAAE,WAAW,CAAC;IAClB,QAAQ,EAAE,QAAQ,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC;AAGF,MAAM,MAAM,YAAY,GAAG;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,OAAO,EAAE,CAAC;IACpB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,gBAAgB,EAAE,MAAM,CAAC;IACzB,iDAAiD;IACjD,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,MAAM,EAAE,kBAAkB,CAAC;IAC3B,QAAQ,EAAE,iBAAiB,CAAC;IAC5B,aAAa,EAAE,yBAAyB,CAAC;IACzC,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,yEAAyE;IACzE,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,8CAA8C;IAC9C,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,sGAAsG;IACtG,UAAU,EAAE,UAAU,CAAC;IACvB,mFAAmF;IACnF,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,4KAA4K;IAC5K,oBAAoB,EAAE,OAAO,CAAC;IAC9B,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,6BAA6B,GAAG;IAC1C,IAAI,EAAE,OAAO,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;IACnC,IAAI,EAAE;QACJ,KAAK,EAAE,MAAM,CAAC;QACd,gDAAgD;QAChD,YAAY,EAAE,MAAM,CAAC;QACrB,KAAK,EAAE,MAAM,CAAC;KACf,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,+BAA+B,GAAG;IAC5C,IAAI,EAAE,OAAO,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;IACrC,MAAM,EAAE;QACN,YAAY,EAAE,GAAG,CAAC;QAClB,OAAO,EAAE,GAAG,CAAC;QACb,WAAW,EAAE,MAAM,CAAC;QACpB,KAAK,CAAC,EAAE,wBAAwB,CAAC;KAClC,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,yBAAyB,GACjC,6BAA6B,GAC7B,+BAA+B,CAAC;AAEpC,MAAM,MAAM,wBAAwB,GAAG;IACrC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,aAAa,EAAE,YAAY,EAAE,CAAC;IAC9B,eAAe,EAAE,WAAW,EAAE,CAAC;IAC/B,mBAAmB,CAAC,EAAE,mBAAmB,CAAC;IAC1C,gEAAgE;IAChE,gBAAgB,CAAC,EAAE,YAAY,CAAC;IAChC,4EAA4E;IAC5E,eAAe,CAAC,EAAE,aAAa,CAAC;CACjC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,SAAS,EAAE,OAAO,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,SAAS,EAAE,OAAO,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,SAAS,EAAE,OAAO,CAAC;CACpB,CAAC;AAEF,KAAK,4BAA4B,GAAG;IAClC,KAAK,EAAE,iBAAiB,CAAC;IACzB,KAAK,EAAE,iBAAiB,CAAC;IACzB,OAAO,EAAE,mBAAmB,CAAC;CAC9B,CAAC;AAEF,MAAM,MAAM,4BAA4B,GAAG;IACzC,QAAQ,EAAE,OAAO,CAAC;IAClB,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,QAAQ,EAAE,4BAA4B,CAAC;CACxC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG,4BAA4B,GAAG;IACrE,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;CAChC,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG;IACrC,QAAQ,EAAE,WAAW,EAAE,CAAC;IACxB,gBAAgB,EAAE,OAAO,CAAC;IAC1B,iBAAiB,EAAE,iBAAiB,CAAC;IACrC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB;;;;;;;;OAQG;IACH,eAAe,CAAC,EAAE,aAAa,CAAC;CACjC,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG;IACtC,kBAAkB,EAAE,MAAM,CAAC;CAC5B,CAAC;AAEF,KAAK,kCAAkC,GAAG;IACxC,QAAQ,EAAE,WAAW,EAAE,CAAC;IACxB,gBAAgB,EAAE,OAAO,CAAC;IAC1B,iBAAiB,EAAE,iBAAiB,CAAC;IACrC,aAAa,EAAE,MAAM,CAAC;IACtB,OAAO,EAAE,GAAG,CAAC;IACb,YAAY,EAAE,GAAG,CAAC;IAClB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB;;;;;;;;OAQG;IACH,eAAe,CAAC,EAAE,aAAa,CAAC;CACjC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,mCAAmC,GAC7C,kCAAkC,GAAG;IACnC,gBAAgB,CAAC,EAAE,OAAO,mBAAmB,CAAC,cAAc,CAAC;IAC7D,cAAc,EAAE,GAAG,CAAC;IACpB,cAAc,CAAC,EAAE,KAAK,CAAC;CACxB,CAAC;AAEJ;;GAEG;AACH,MAAM,MAAM,wCAAwC,GAClD,kCAAkC,GAAG;IACnC,gBAAgB,EAAE,OAAO,mBAAmB,CAAC,UAAU,CAAC;IACxD,cAAc,EAAE,GAAG,CAAC;IACpB,cAAc,CAAC,EAAE,KAAK,CAAC;CACxB,CAAC;AAEJ;;;;;;;;GAQG;AACH,MAAM,MAAM,8BAA8B,GACtC,mCAAmC,GACnC,wCAAwC,CAAC;AAE7C,MAAM,MAAM,+BAA+B,GAAG;IAC5C,cAAc,EAAE,MAAM,CAAC;IACvB,MAAM,EAAE,kBAAkB,CAAC;CAC5B,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,8BAA8B,GAAG;IAC3C;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG;IACtC,cAAc,EAAE,MAAM,CAAC;IACvB,yDAAyD;IACzD,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,+CAA+C;IAC/C,kBAAkB,CAAC,EAAE,sBAAsB,CAAC;IAC5C,wDAAwD;IACxD,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG;IACtB,cAAc,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,CAAC;CACvC,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB,QAAQ,EAAE,iBAAiB,CAAC;IAC5B,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;IACrB,uBAAuB;IACvB,QAAQ,EAAE,QAAQ,CAAC;IACnB,eAAe,EAAE,MAAM,CAAC;IACxB,sCAAsC;IACtC,gBAAgB,EAAE,MAAM,CAAC;IACzB,mDAAmD;IACnD,0BAA0B,EAAE,MAAM,CAAC;CACpC,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,IAAI,EAAE,WAAW,CAAC;IAClB,MAAM,EAAE,YAAY,EAAE,CAAC;CACxB,CAAC;AAEF,KAAK,oBAAoB,GAAG;IAC1B,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,GAAG,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB;;;;OAIG;IACH,cAAc,CAAC,EAAE;QACf,GAAG,EAAE,MAAM,CAAC;KACb,CAAC;IACF;;OAEG;IACH,OAAO,CAAC,EAAE,gBAAgB,EAAE,CAAC;CAC9B,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,oBAAoB,GAAG,oBAAoB,GAAG;IACxD,YAAY,CAAC,EAAE,KAAK,CAAC;CACtB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,oBAAoB,GAAG;IACzD,YAAY,EAAE,IAAI,CAAC;IACnB;;OAEG;IACH,iBAAiB,EAAE,GAAG,CAAC;CACxB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,gBAAgB,GAAG,oBAAoB,GAAG,qBAAqB,CAAC;AAE5E,MAAM,MAAM,gBAAgB,GAAG;IAC7B,OAAO,EAAE,GAAG,CAAC;IACb,cAAc,EAAE,GAAG,CAAC;IACpB;;OAEG;IACH,eAAe,CAAC,EAAE,GAAG,CAAC;IACtB,MAAM,EAAE,gBAAgB,EAAE,CAAC;IAC3B;;;OAGG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;CAClC,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG;IACrC,IAAI,EAAE,OAAO,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;IACnC;;OAEG;IACH,QAAQ,CAAC,EAAE,WAAW,EAAE,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,0BAA0B,GAAG;IACvC,IAAI,EAAE,OAAO,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;IACrC;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;IACpC;;;;OAIG;IACH,QAAQ,CAAC,EAAE,WAAW,EAAE,CAAC;IACzB,MAAM,CAAC,EAAE,gBAAgB,EAAE,CAAC;CAC7B,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,oBAAoB,GAC5B,wBAAwB,GACxB,0BAA0B,CAAC;AAE/B,MAAM,MAAM,eAAe,GAAG;IAC5B,QAAQ,EAAE,cAAc,EAAE,CAAC;IAC3B,cAAc,EAAE,oBAAoB,EAAE,CAAC;CACxC,CAAC;AAEF,MAAM,MAAM,kCAAkC,GAAG;IAC/C;;OAEG;IACH,OAAO,EAAE,GAAG,CAAC;IACb;;OAEG;IACH,mBAAmB,EAAE,GAAG,CAAC;IACzB,WAAW,EAAE,WAAW,CAAC;IACzB,QAAQ,EAAE,iBAAiB,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,mCAAmC,GAAG;IAChD;;;OAGG;IACH,aAAa,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,cAAc,EAAE,GAAG,CAAC;IACpB;;OAEG;IACH,mBAAmB,EAAE,GAAG,CAAC;IACzB,OAAO,EAAE,GAAG,CAAC;CACd,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,uCAAuC,GAAG;IACpD;;;OAGG;IACH,WAAW,EAAE,OAAO,aAAa,CAAC,MAAM,CAAC;IACzC;;;OAGG;IACH,MAAM,EAAE,eAAe,CAAC;IACxB;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;OAEG;IACH,eAAe,CAAC,EAAE,aAAa,CAAC;CACjC,CAAC;AAEF,eAAO,MAAM,YAAY;aACvB,OAAO,EAAE,SAAS;aAClB,WAAW,EAAE,aAAa;CAClB,CAAC;AAEX,MAAM,MAAM,UAAU,GAAG,CAAC,OAAO,YAAY,CAAC,CAAC,MAAM,OAAO,YAAY,CAAC,CAAC;AAE1E,eAAO,MAAM,kBAAkB;aAC7B,UAAU,EAAE,MAAM;aAClB,aAAa,EAAE,SAAS;aACxB,aAAa,EAAE,SAAS;aACxB,eAAe,EAAE,WAAW;aAC5B,iBAAiB,EAAE,aAAa;aAChC,aAAa,EAAE,KAAK;CACZ,CAAC;AAEX,MAAM,MAAM,eAAe,GACzB,CAAC,OAAO,kBAAkB,CAAC,CAAC,MAAM,OAAO,kBAAkB,CAAC,CAAC;AAE/D,MAAM,MAAM,MAAM,GAAG;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,eAAe,EAAE,MAAM,CAAC;IACxB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IACpC,OAAO,EAAE,WAAW,CAAC;IACrB,YAAY,EAAE,OAAO,CAAC;IACtB,iBAAiB,EAAE,OAAO,CAAC;IAC3B,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,wBAAwB,EAAE,OAAO,CAAC;CACnC,CAAC;AAEF,eAAO,MAAM,qBAAqB;aAChC,sBAAsB,EAAE,2BAA2B;aACnD,oBAAoB,EAAE,wBAAwB;CACtC,CAAC;AAEX,MAAM,MAAM,yBAAyB,GACnC,CAAC,OAAO,qBAAqB,CAAC,CAAC,MAAM,OAAO,qBAAqB,CAAC,CAAC;AAErE,MAAM,MAAM,sBAAsB,GAAG;IACnC,KAAK,EAAE,yBAAyB,CAAC;IACjC,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,oCAAoC,GAAG;IACjD,eAAe,CAAC,EAAE,eAAe,CAAC;CACnC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,+BAA+B,GAAG;IAC5C,OAAO,EAAE,GAAG,CAAC;IACb,OAAO,EAAE,GAAG,CAAC;IACb,QAAQ,EAAE,WAAW,EAAE,CAAC;IACxB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,iBAAiB,EAAE,iBAAiB,CAAC;IACrC,aAAa,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,oCAAoC,GAAG,IAAI,CACrD,+BAA+B,EAC/B,SAAS,GAAG,SAAS,GAAG,UAAU,CACnC,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,gBAAgB,IAAI,OAAO,CAAC,wBAAwB,CAAC,CAAC;IACtD,WAAW,IAAI,OAAO,CAAC,4BAA4B,CAAC,CAAC;IACrD,kBAAkB,CAAC,OAAO,EAAE,yBAAyB,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IAC9E,oBAAoB,CAAC,OAAO,EAAE;QAC5B,cAAc,EAAE,MAAM,CAAC;KACxB,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IAC1B;;;;;;OAMG;IACH,yBAAyB,CACvB,OAAO,EAAE,wBAAwB,GAChC,OAAO,CAAC,yBAAyB,CAAC,CAAC;IACtC,mBAAmB,IAAI,OAAO,CAAC,qBAAqB,CAAC,CAAC;IACtD,UAAU,IAAI,OAAO,CAAC,eAAe,CAAC,CAAC;IACvC,2BAA2B,CACzB,OAAO,EAAE,8BAA8B,GACtC,OAAO,CAAC,+BAA+B,CAAC,CAAC;IAC5C,uBAAuB,CACrB,OAAO,EAAE,8BAA8B,GACtC,OAAO,CAAC,+BAA+B,CAAC,CAAC;IAC5C,yBAAyB,CACvB,OAAO,EAAE,gCAAgC,GACxC,OAAO,CAAC,IAAI,CAAC,CAAC;IACjB,6BAA6B,CAC3B,OAAO,CAAC,EAAE,oCAAoC,GAC7C,OAAO,CAAC,uBAAuB,EAAE,CAAC,CAAC;IACtC,eAAe,CAAC,OAAO,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAChE,kBAAkB,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEhE;;OAEG;IACH,WAAW,CACT,OAAO,EAAE,kBAAkB,GAC1B,OAAO,CAAC,8BAA8B,CAAC,CAAC;IAE3C;;;;;;;;;;;;;OAaG;IACH,wBAAwB,CACtB,OAAO,EAAE,+BAA+B,GACvC,OAAO,CAAC,IAAI,CAAC,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAC/B,CAAC;IACC,WAAW,EAAE,OAAO,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;CAC3C,GAAG,8BAA8B,CAAC,GACnC,CAAC;IACC,WAAW,EAAE,OAAO,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;CAC7C,GAAG,gCAAgC,CAAC,CAAC;AAE1C,MAAM,MAAM,8BAA8B,GAAG;IAC3C;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,iBAAiB,EAAE,iBAAiB,CAAC;IACrC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,+BAA+B,GAAG;IAC5C,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,gCAAgC,GAAG;IAC7C,cAAc,EAAE,MAAM,CAAC;IACvB,OAAO,EAAE,GAAG,CAAC;IACb,YAAY,EAAE,GAAG,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,cAAc,CAAC,EAAE,GAAG,CAAC;IACrB,iBAAiB,EAAE,iBAAiB,CAAC;IACrC,aAAa,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,+BAA+B,GAAG;IAC5C,IAAI,EAAE,WAAW,CAAC;IAClB,mBAAmB,CAAC,EAAE,GAAG,CAAC;IAC1B,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,IAAI,EAAE,iBAAiB,CAAC;IACxB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;CACrC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,qCAAqC,GAAG;IAClD;;OAEG;IACH,OAAO,EAAE,WAAW,CAAC;IACrB;;OAEG;IACH,aAAa,EAAE,+BAA+B,CAAC;CAChD,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;;;;;OAMG;IACH,eAAe,EAAE,aAAa,CAAC;CAChC,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,kCAAkC,CAAC;AACxE,OAAO,KAAK,EAAE,aAAa,EAAE,GAAG,EAAE,MAAM,iBAAiB,CAAC;AAE1D,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAC;AAE3D;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,aAAa;IACxB;;OAEG;aACH,MAAM,EAAE,QAAQ;IAChB;;OAEG;aACH,kBAAkB,EAAE,oBAAoB;CAChC,CAAC;AAEX,MAAM,MAAM,WAAW,GAAG,CAAC,OAAO,aAAa,CAAC,CAAC,MAAM,OAAO,aAAa,CAAC,CAAC;AAE7E,eAAO,MAAM,mBAAmB;aAC9B,aAAa,EAAE,eAAe;aAC9B,cAAc,EAAE,gBAAgB;aAChC,aAAa,EAAE,eAAe;aAC9B,UAAU,EAAE,YAAY;CAChB,CAAC;AAEX,MAAM,MAAM,mBAAmB,GAC7B,CAAC,OAAO,mBAAmB,CAAC,CAAC,MAAM,OAAO,mBAAmB,CAAC,CAAC;AAEjE,MAAM,MAAM,wBAAwB,GAAG,MAAM,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAC;AAE5E,eAAO,MAAM,aAAa;aACxB,WAAW,EAAE,aAAa;aAC1B,eAAe,EAAE,iBAAiB;CAC1B,CAAC;AAEX,MAAM,MAAM,aAAa,GAAG,CAAC,OAAO,aAAa,CAAC,CAAC,MAAM,OAAO,aAAa,CAAC,CAAC;AAE/E,MAAM,MAAM,kBAAkB,GAAG,MAAM,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC;AAEhE,MAAM,MAAM,qBAAqB,GAAG;IAClC,IAAI,EAAE,MAAM,CAAC;IACb,YAAY,EAAE,wBAAwB,CAAC;CACxC,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,EAAE;QACvB,YAAY,EAAE,kBAAkB,CAAC;KAClC,CAAC;IACF,CAAC,aAAa,CAAC,kBAAkB,CAAC,CAAC,EAAE,qBAAqB,CAAC;CAC5D,CAAC;AAEF,MAAM,MAAM,4BAA4B,GAAG;IACzC,CAAC,aAAa,CAAC,MAAM,CAAC,EAAE,aAAa,CAAC;IACtC,CAAC,aAAa,CAAC,kBAAkB,CAAC,EAAE,mBAAmB,CAAC;CACzD,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,mBAAmB;IAC9B;;OAEG;aACH,cAAc,EAAE,gBAAgB;IAChC;;OAEG;aACH,UAAU,EAAE,YAAY;CAChB,CAAC;AAEX,MAAM,MAAM,gBAAgB,GAC1B,CAAC,OAAO,mBAAmB,CAAC,CAAC,MAAM,OAAO,mBAAmB,CAAC,CAAC;AAEjE,eAAO,MAAM,aAAa;aACxB,MAAM,EAAE,MAAM;aACd,QAAQ,EAAE,QAAQ;CACV,CAAC;AAEX,MAAM,MAAM,WAAW,GAAG,CAAC,OAAO,aAAa,CAAC,CAAC,MAAM,OAAO,aAAa,CAAC,CAAC;AAE7E,eAAO,MAAM,mBAAmB;aAC9B,KAAK,EAAE,OAAO;aACd,IAAI,EAAE,MAAM;CACJ,CAAC;AAEX,MAAM,MAAM,iBAAiB,GAC3B,CAAC,OAAO,mBAAmB,CAAC,CAAC,MAAM,OAAO,mBAAmB,CAAC,CAAC;AAEjE,eAAO,MAAM,qBAAqB;aAEhC,UAAU,EAAE,YAAY;aACxB,iBAAiB,EAAE,oBAAoB;aAEvC,WAAW,EAAE,aAAa;aAC1B,QAAQ,EAAE,UAAU;aACpB,MAAM,EAAE,QAAQ;aAEhB,OAAO,EAAE,UAAU;aACnB,MAAM,EAAE,QAAQ;aAEhB,QAAQ,EAAE,UAAU;aAEpB,MAAM,EAAE,QAAQ;CACR,CAAC;AAEX,MAAM,MAAM,kBAAkB,GAC5B,CAAC,OAAO,qBAAqB,CAAC,CAAC,MAAM,OAAO,qBAAqB,CAAC,CAAC;AAErE,eAAO,MAAM,wBAAwB;aACnC,UAAU,EAAE,YAAY;aACxB,SAAS,EAAE,WAAW;aACtB,MAAM,EAAE,QAAQ;aAChB,OAAO,EAAE,SAAS;CACV,CAAC;AAEX,MAAM,MAAM,oBAAoB,GAC9B,CAAC,OAAO,wBAAwB,CAAC,CAAC,MAAM,OAAO,wBAAwB,CAAC,CAAC;AAE3E,eAAO,MAAM,YAAY;aACvB,iBAAiB,EAAE,mBAAmB;aACtC,qBAAqB,EAAE,uBAAuB;aAC9C,WAAW,EAAE,aAAa;aAC1B,gCAAgC,EAAE,kCAAkC;CAC5D,CAAC;AAEX,MAAM,MAAM,UAAU,GAAG,CAAC,OAAO,YAAY,CAAC,CAAC,MAAM,OAAO,YAAY,CAAC,CAAC;AAE1E,MAAM,MAAM,sBAAsB,GAChC,CAAC,OAAO,oBAAoB,CAAC,CAAC,MAAM,OAAO,oBAAoB,CAAC,CAAC;AAEnE,eAAO,MAAM,4BAA4B;aACvC,4BAA4B,EAAE,8BAA8B;aAC5D,6BAA6B,EAAE,+BAA+B;aAC9D,sDAAsD,EACpD,wDAAwD;aAC1D,oBAAoB,EAAE,sBAAsB;aAC5C,sBAAsB,EAAE,wBAAwB;CACxC,CAAC;AAEX,MAAM,MAAM,wBAAwB,GAClC,CAAC,OAAO,4BAA4B,CAAC,CAAC,MAAM,OAAO,4BAA4B,CAAC,CAAC;AAEnF;;;;;GAKG;AACH,eAAO,MAAM,qBAAqB;aAChC,oBAAoB,EAAE,sBAAsB;aAC5C,sBAAsB,EAAE,wBAAwB;aAChD,4BAA4B,EAAE,8BAA8B;aAC5D,oBAAoB,EAAE,sBAAsB;aAC5C,kBAAkB,EAAE,oBAAoB;aACxC,yBAAyB,EAAE,2BAA2B;aACtD,qBAAqB,EAAE,uBAAuB;CACtC,CAAC;AAEX,MAAM,MAAM,kBAAkB,GAC5B,CAAC,OAAO,qBAAqB,CAAC,CAAC,MAAM,OAAO,qBAAqB,CAAC,CAAC;AAErE,eAAO,MAAM,UAAU;aACrB,CAAC,EAAE,GAAG;aACN,CAAC,EAAE,GAAG;CACE,CAAC;AAEX,MAAM,MAAM,SAAS,GAAG,CAAC,OAAO,UAAU,CAAC,CAAC,MAAM,OAAO,UAAU,CAAC,CAAC;AAErE,uBAAuB;AACvB,MAAM,MAAM,QAAQ,GAAG,KAAK,CAAC;AAE7B,MAAM,MAAM,OAAO,GAAG;IACpB,IAAI,EAAE,WAAW,CAAC;IAClB,QAAQ,EAAE,QAAQ,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC;AAGF,MAAM,MAAM,YAAY,GAAG;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,OAAO,EAAE,CAAC;IACpB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,iDAAiD;IACjD,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,MAAM,EAAE,kBAAkB,CAAC;IAC3B,QAAQ,EAAE,iBAAiB,CAAC;IAC5B,aAAa,EAAE,yBAAyB,CAAC;IACzC,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,yEAAyE;IACzE,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,8CAA8C;IAC9C,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,sGAAsG;IACtG,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,mFAAmF;IACnF,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,4KAA4K;IAC5K,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,gEAAgE;IAChE,WAAW,CAAC,EAAE,mBAAmB,CAAC;CACnC,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,oBAAoB,CAAC;IAC7B,SAAS,CAAC,EAAE,kBAAkB,CAAC;IAC/B,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,6BAA6B,GAAG;IAC1C,IAAI,EAAE,OAAO,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;IACnC,IAAI,EAAE;QACJ,KAAK,EAAE,MAAM,CAAC;QACd,gDAAgD;QAChD,YAAY,EAAE,MAAM,CAAC;QACrB,KAAK,EAAE,MAAM,CAAC;KACf,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,+BAA+B,GAAG;IAC5C,IAAI,EAAE,OAAO,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;IACrC,MAAM,EAAE;QACN,YAAY,EAAE,GAAG,CAAC;QAClB,OAAO,EAAE,GAAG,CAAC;QACb,WAAW,EAAE,MAAM,CAAC;QACpB,KAAK,CAAC,EAAE,wBAAwB,CAAC;KAClC,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,yBAAyB,GACjC,6BAA6B,GAC7B,+BAA+B,CAAC;AAEpC,MAAM,MAAM,wBAAwB,GAAG;IACrC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,aAAa,EAAE,YAAY,EAAE,CAAC;IAC9B,eAAe,EAAE,WAAW,EAAE,CAAC;IAC/B,mBAAmB,CAAC,EAAE,mBAAmB,CAAC;IAC1C,gEAAgE;IAChE,gBAAgB,CAAC,EAAE,YAAY,CAAC;IAChC,4EAA4E;IAC5E,eAAe,CAAC,EAAE,aAAa,CAAC;CACjC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,SAAS,EAAE,OAAO,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,SAAS,EAAE,OAAO,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,SAAS,EAAE,OAAO,CAAC;CACpB,CAAC;AAEF,KAAK,4BAA4B,GAAG;IAClC,KAAK,EAAE,iBAAiB,CAAC;IACzB,KAAK,EAAE,iBAAiB,CAAC;IACzB,OAAO,EAAE,mBAAmB,CAAC;CAC9B,CAAC;AAEF,MAAM,MAAM,4BAA4B,GAAG;IACzC,QAAQ,EAAE,OAAO,CAAC;IAClB,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,QAAQ,EAAE,4BAA4B,CAAC;CACxC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG,4BAA4B,GAAG;IACrE,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;CAChC,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG;IACrC,QAAQ,EAAE,WAAW,EAAE,CAAC;IACxB,gBAAgB,EAAE,OAAO,CAAC;IAC1B,iBAAiB,EAAE,iBAAiB,CAAC;IACrC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB;;;;;;;;OAQG;IACH,eAAe,CAAC,EAAE,aAAa,CAAC;CACjC,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG;IACtC,kBAAkB,EAAE,MAAM,CAAC;CAC5B,CAAC;AAEF,KAAK,kCAAkC,GAAG;IACxC,QAAQ,EAAE,WAAW,EAAE,CAAC;IACxB,gBAAgB,EAAE,OAAO,CAAC;IAC1B,iBAAiB,EAAE,iBAAiB,CAAC;IACrC,aAAa,EAAE,MAAM,CAAC;IACtB,OAAO,EAAE,GAAG,CAAC;IACb,YAAY,EAAE,GAAG,CAAC;IAClB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB;;;;;;;;OAQG;IACH,eAAe,CAAC,EAAE,aAAa,CAAC;CACjC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,mCAAmC,GAC7C,kCAAkC,GAAG;IACnC,gBAAgB,CAAC,EAAE,OAAO,mBAAmB,CAAC,cAAc,CAAC;IAC7D,cAAc,EAAE,GAAG,CAAC;IACpB,cAAc,CAAC,EAAE,KAAK,CAAC;CACxB,CAAC;AAEJ;;GAEG;AACH,MAAM,MAAM,wCAAwC,GAClD,kCAAkC,GAAG;IACnC,gBAAgB,EAAE,OAAO,mBAAmB,CAAC,UAAU,CAAC;IACxD,cAAc,EAAE,GAAG,CAAC;IACpB,cAAc,CAAC,EAAE,KAAK,CAAC;CACxB,CAAC;AAEJ;;;;;;;;GAQG;AACH,MAAM,MAAM,8BAA8B,GACtC,mCAAmC,GACnC,wCAAwC,CAAC;AAE7C,MAAM,MAAM,+BAA+B,GAAG;IAC5C,cAAc,EAAE,MAAM,CAAC;IACvB,MAAM,EAAE,kBAAkB,CAAC;CAC5B,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,8BAA8B,GAAG;IAC3C;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG;IACtC,cAAc,EAAE,MAAM,CAAC;IACvB,yDAAyD;IACzD,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,+CAA+C;IAC/C,kBAAkB,CAAC,EAAE,sBAAsB,CAAC;IAC5C,wDAAwD;IACxD,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG;IACtB,cAAc,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,CAAC;CACvC,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB,QAAQ,EAAE,iBAAiB,CAAC;IAC5B,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;IACrB,uBAAuB;IACvB,QAAQ,EAAE,QAAQ,CAAC;IACnB,eAAe,EAAE,MAAM,CAAC;IACxB,sCAAsC;IACtC,gBAAgB,EAAE,MAAM,CAAC;IACzB,mDAAmD;IACnD,0BAA0B,EAAE,MAAM,CAAC;CACpC,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,IAAI,EAAE,WAAW,CAAC;IAClB,MAAM,EAAE,YAAY,EAAE,CAAC;CACxB,CAAC;AAEF,KAAK,oBAAoB,GAAG;IAC1B,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,GAAG,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB;;;;OAIG;IACH,cAAc,CAAC,EAAE;QACf,GAAG,EAAE,MAAM,CAAC;KACb,CAAC;IACF;;OAEG;IACH,OAAO,CAAC,EAAE,gBAAgB,EAAE,CAAC;CAC9B,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC;AAE/B;;;GAGG;AACH,eAAO,MAAM,WAAW;aACtB,IAAI,EAAE,MAAM;aACZ,OAAO,EAAE,SAAS;CACV,CAAC;AAEX;;;GAGG;AACH,MAAM,MAAM,oBAAoB,GAAG,oBAAoB,CAAC;AAExD;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,oBAAoB,GAAG;IACzD;;;;OAIG;IACH,iBAAiB,EAAE,GAAG,CAAC;IACvB;;OAEG;IACH,KAAK,CAAC,EAAE,SAAS,CAAC;CACnB,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,MAAM,gBAAgB,GAAG,oBAAoB,GAAG,qBAAqB,CAAC;AAE5E;;;;;;GAMG;AACH,wBAAgB,iBAAiB,CAC/B,KAAK,EAAE,gBAAgB,GACtB,KAAK,IAAI,qBAAqB,CAEhC;AAED,MAAM,MAAM,gBAAgB,GAAG;IAC7B,OAAO,EAAE,GAAG,CAAC;IACb,cAAc,EAAE,GAAG,CAAC;IACpB;;OAEG;IACH,eAAe,CAAC,EAAE,GAAG,CAAC;IACtB,MAAM,EAAE,gBAAgB,EAAE,CAAC;IAC3B;;;OAGG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;CAClC,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG;IACrC,IAAI,EAAE,OAAO,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;IACnC;;OAEG;IACH,QAAQ,CAAC,EAAE,WAAW,EAAE,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,0BAA0B,GAAG;IACvC,IAAI,EAAE,OAAO,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;IACrC;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;IACpC;;;;OAIG;IACH,QAAQ,CAAC,EAAE,WAAW,EAAE,CAAC;IACzB,MAAM,CAAC,EAAE,gBAAgB,EAAE,CAAC;CAC7B,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,oBAAoB,GAC5B,wBAAwB,GACxB,0BAA0B,CAAC;AAE/B,MAAM,MAAM,eAAe,GAAG;IAC5B,QAAQ,EAAE,cAAc,EAAE,CAAC;IAC3B,cAAc,EAAE,oBAAoB,EAAE,CAAC;CACxC,CAAC;AAEF,MAAM,MAAM,kCAAkC,GAAG;IAC/C;;OAEG;IACH,OAAO,EAAE,GAAG,CAAC;IACb;;OAEG;IACH,mBAAmB,EAAE,GAAG,CAAC;IACzB,WAAW,EAAE,WAAW,CAAC;IACzB,QAAQ,EAAE,iBAAiB,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,mCAAmC,GAAG;IAChD;;;OAGG;IACH,aAAa,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,cAAc,EAAE,GAAG,CAAC;IACpB;;OAEG;IACH,mBAAmB,EAAE,GAAG,CAAC;IACzB,OAAO,EAAE,GAAG,CAAC;CACd,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,uCAAuC,GAAG;IACpD;;;OAGG;IACH,WAAW,EAAE,OAAO,aAAa,CAAC,MAAM,CAAC;IACzC;;;OAGG;IACH,MAAM,EAAE,eAAe,CAAC;IACxB;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;OAEG;IACH,eAAe,CAAC,EAAE,aAAa,CAAC;CACjC,CAAC;AAEF,eAAO,MAAM,YAAY;aACvB,OAAO,EAAE,SAAS;aAClB,WAAW,EAAE,aAAa;CAClB,CAAC;AAEX,MAAM,MAAM,UAAU,GAAG,CAAC,OAAO,YAAY,CAAC,CAAC,MAAM,OAAO,YAAY,CAAC,CAAC;AAE1E,eAAO,MAAM,kBAAkB;aAC7B,UAAU,EAAE,MAAM;aAClB,aAAa,EAAE,SAAS;aACxB,aAAa,EAAE,SAAS;aACxB,eAAe,EAAE,WAAW;aAC5B,iBAAiB,EAAE,aAAa;aAChC,aAAa,EAAE,KAAK;CACZ,CAAC;AAEX,MAAM,MAAM,eAAe,GACzB,CAAC,OAAO,kBAAkB,CAAC,CAAC,MAAM,OAAO,kBAAkB,CAAC,CAAC;AAE/D,MAAM,MAAM,MAAM,GAAG;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,eAAe,EAAE,MAAM,CAAC;IACxB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IACpC,OAAO,EAAE,WAAW,CAAC;IACrB,YAAY,EAAE,OAAO,CAAC;IACtB,iBAAiB,EAAE,OAAO,CAAC;IAC3B,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,wBAAwB,EAAE,OAAO,CAAC;CACnC,CAAC;AAEF,eAAO,MAAM,qBAAqB;aAChC,sBAAsB,EAAE,2BAA2B;aACnD,oBAAoB,EAAE,wBAAwB;CACtC,CAAC;AAEX,MAAM,MAAM,yBAAyB,GACnC,CAAC,OAAO,qBAAqB,CAAC,CAAC,MAAM,OAAO,qBAAqB,CAAC,CAAC;AAErE,MAAM,MAAM,sBAAsB,GAAG;IACnC,KAAK,EAAE,yBAAyB,CAAC;IACjC,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,oCAAoC,GAAG;IACjD,eAAe,CAAC,EAAE,eAAe,CAAC;CACnC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,+BAA+B,GAAG;IAC5C,OAAO,EAAE,GAAG,CAAC;IACb,OAAO,EAAE,GAAG,CAAC;IACb,QAAQ,EAAE,WAAW,EAAE,CAAC;IACxB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,iBAAiB,EAAE,iBAAiB,CAAC;IACrC,aAAa,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,oCAAoC,GAAG,IAAI,CACrD,+BAA+B,EAC/B,SAAS,GAAG,SAAS,GAAG,UAAU,CACnC,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,gBAAgB,IAAI,OAAO,CAAC,wBAAwB,CAAC,CAAC;IACtD,WAAW,IAAI,OAAO,CAAC,4BAA4B,CAAC,CAAC;IACrD,kBAAkB,CAAC,OAAO,EAAE,yBAAyB,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IAC9E,oBAAoB,CAAC,OAAO,EAAE;QAC5B,cAAc,EAAE,MAAM,CAAC;KACxB,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IAC1B;;;;;;OAMG;IACH,yBAAyB,CACvB,OAAO,EAAE,wBAAwB,GAChC,OAAO,CAAC,yBAAyB,CAAC,CAAC;IACtC,mBAAmB,IAAI,OAAO,CAAC,qBAAqB,CAAC,CAAC;IACtD,UAAU,IAAI,OAAO,CAAC,eAAe,CAAC,CAAC;IACvC,2BAA2B,CACzB,OAAO,EAAE,8BAA8B,GACtC,OAAO,CAAC,+BAA+B,CAAC,CAAC;IAC5C,uBAAuB,CACrB,OAAO,EAAE,8BAA8B,GACtC,OAAO,CAAC,+BAA+B,CAAC,CAAC;IAC5C,yBAAyB,CACvB,OAAO,EAAE,gCAAgC,GACxC,OAAO,CAAC,IAAI,CAAC,CAAC;IACjB,6BAA6B,CAC3B,OAAO,CAAC,EAAE,oCAAoC,GAC7C,OAAO,CAAC,uBAAuB,EAAE,CAAC,CAAC;IACtC,eAAe,CAAC,OAAO,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAChE,kBAAkB,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEhE;;OAEG;IACH,WAAW,CACT,OAAO,EAAE,kBAAkB,GAC1B,OAAO,CAAC,8BAA8B,CAAC,CAAC;IAE3C;;;;;;;;;;;;;OAaG;IACH,wBAAwB,CACtB,OAAO,EAAE,+BAA+B,GACvC,OAAO,CAAC,IAAI,CAAC,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAC/B,CAAC;IACC,WAAW,EAAE,OAAO,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;CAC3C,GAAG,8BAA8B,CAAC,GACnC,CAAC;IACC,WAAW,EAAE,OAAO,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;CAC7C,GAAG,gCAAgC,CAAC,CAAC;AAE1C,MAAM,MAAM,8BAA8B,GAAG;IAC3C;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,iBAAiB,EAAE,iBAAiB,CAAC;IACrC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,+BAA+B,GAAG;IAC5C,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,KAAK,oCAAoC,GAAG;IAC1C,cAAc,EAAE,MAAM,CAAC;IACvB,OAAO,EAAE,GAAG,CAAC;IACb,YAAY,EAAE,GAAG,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,iBAAiB,EAAE,iBAAiB,CAAC;IACrC,aAAa,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,qCAAqC,GAC/C,oCAAoC,GAAG;IACrC,gBAAgB,CAAC,EAAE,OAAO,mBAAmB,CAAC,cAAc,CAAC;IAC7D;;OAEG;IACH,cAAc,CAAC,EAAE,GAAG,CAAC;IACrB,cAAc,CAAC,EAAE,KAAK,CAAC;CACxB,CAAC;AAEJ;;;GAGG;AACH,MAAM,MAAM,0CAA0C,GACpD,oCAAoC,GAAG;IACrC,gBAAgB,EAAE,OAAO,mBAAmB,CAAC,UAAU,CAAC;IACxD,cAAc,EAAE,GAAG,CAAC;IACpB,cAAc,CAAC,EAAE,KAAK,CAAC;CACxB,CAAC;AAEJ;;;;;GAKG;AACH,MAAM,MAAM,gCAAgC,GACxC,qCAAqC,GACrC,0CAA0C,CAAC;AAE/C,MAAM,MAAM,qBAAqB,GAAG;IAClC,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,+BAA+B,GAAG;IAC5C,IAAI,EAAE,WAAW,CAAC;IAClB,mBAAmB,CAAC,EAAE,GAAG,CAAC;IAC1B,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,IAAI,EAAE,iBAAiB,CAAC;IACxB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;CACrC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,qCAAqC,GAAG;IAClD;;OAEG;IACH,OAAO,EAAE,WAAW,CAAC;IACrB;;OAEG;IACH,aAAa,EAAE,+BAA+B,CAAC;CAChD,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;;;;;OAMG;IACH,eAAe,EAAE,aAAa,CAAC;CAChC,CAAC"}

package/dist/types.js

@@ -61,6 +61,12 @@ export const SUBSCRIPTION_STATUSES = {
     // Paused states
     paused: 'paused',
 };
+export const INVOICE_PAYMENT_STATUSES = {
+    PROCESSING: 'PROCESSING',
+    SUCCEEDED: 'SUCCEEDED',
+    FAILED: 'FAILED',
+    UNKNOWN: 'UNKNOWN',
+};
 export const CANCEL_TYPES = {
     ALLOWED_IMMEDIATE: 'allowed_immediate',
     ALLOWED_AT_PERIOD_END: 'allowed_at_period_end',
@@ -74,10 +80,43 @@ export const CRYPTO_PAYMENT_METHOD_ERRORS = {
     INSUFFICIENT_BALANCE: 'insufficient_balance',
     INSUFFICIENT_ALLOWANCE: 'insufficient_allowance',
 };
+/**
+ * Errors returned by the Subscription API after crypto payment execution.
+ *
+ * These are distinct from {@link CRYPTO_PAYMENT_METHOD_ERRORS}, which describe
+ * approval/payment-method failures.
+ */
+export const CRYPTO_PAYMENT_ERRORS = {
+    INSUFFICIENT_BALANCE: 'insufficient_balance',
+    INSUFFICIENT_ALLOWANCE: 'insufficient_allowance',
+    EXCEEDS_DELEGATION_ALLOWANCE: 'exceeds_delegation_allowance',
+    DELEGATION_NOT_FOUND: 'delegation_not_found',
+    DELEGATION_REVOKED: 'delegation_revoked',
+    RECIPIENT_NOT_ALLOWLISTED: 'recipient_not_allowlisted',
+    INTERNAL_SERVER_ERROR: 'internal_server_error',
+};
 export const MODAL_TYPE = {
     A: 'A',
     B: 'B',
 };
+/**
+ * The vault names known at the time of writing. Not exhaustive — see
+ * {@link VaultName}.
+ */
+export const VAULT_NAMES = {
+    base: 'base',
+    premium: 'premium',
+};
+/**
+ * Whether a settlement token is a yield-bearing vault share, which must be
+ * valued through its accountant rate rather than at face value.
+ *
+ * @param token - The settlement token to check.
+ * @returns True if the token is a vault share.
+ */
+export function isVaultShareToken(token) {
+    return token.accountantAddress !== undefined;
+}
 export const COHORT_NAMES = {
     POST_TX: 'post_tx',
     WALLET_HOME: 'wallet_home',

package/dist/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAcA;;GAEG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B;;OAEG;IACH,MAAM,EAAE,QAAQ;IAChB;;OAEG;IACH,kBAAkB,EAAE,oBAAoB;CAChC,CAAC;AAIX,MAAM,CAAC,MAAM,mBAAmB,GAAG;IACjC,aAAa,EAAE,eAAe;IAC9B,cAAc,EAAE,gBAAgB;IAChC,aAAa,EAAE,eAAe;IAC9B,UAAU,EAAE,YAAY;CAChB,CAAC;AAOX,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B,WAAW,EAAE,aAAa;IAC1B,eAAe,EAAE,iBAAiB;CAC1B,CAAC;AAuBX;;;;;GAKG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG;IACjC;;OAEG;IACH,cAAc,EAAE,gBAAgB;IAChC;;OAEG;IACH,UAAU,EAAE,YAAY;CAChB,CAAC;AAKX,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B,MAAM,EAAE,MAAM;IACd,QAAQ,EAAE,QAAQ;CACV,CAAC;AAIX,MAAM,CAAC,MAAM,mBAAmB,GAAG;IACjC,KAAK,EAAE,OAAO;IACd,IAAI,EAAE,MAAM;CACJ,CAAC;AAKX,MAAM,CAAC,MAAM,qBAAqB,GAAG;IACnC,iBAAiB;IACjB,UAAU,EAAE,YAAY;IACxB,iBAAiB,EAAE,oBAAoB;IACvC,gBAAgB;IAChB,WAAW,EAAE,aAAa;IAC1B,QAAQ,EAAE,UAAU;IACpB,MAAM,EAAE,QAAQ;IAChB,iBAAiB;IACjB,OAAO,EAAE,UAAU;IACnB,MAAM,EAAE,QAAQ;IAChB,mBAAmB;IACnB,QAAQ,EAAE,UAAU;IACpB,gBAAgB;IAChB,MAAM,EAAE,QAAQ;CACR,CAAC;AAKX,MAAM,CAAC,MAAM,YAAY,GAAG;IAC1B,iBAAiB,EAAE,mBAAmB;IACtC,qBAAqB,EAAE,uBAAuB;IAC9C,WAAW,EAAE,aAAa;IAC1B,gCAAgC,EAAE,kCAAkC;CAC5D,CAAC;AAOX,MAAM,CAAC,MAAM,4BAA4B,GAAG;IAC1C,4BAA4B,EAAE,8BAA8B;IAC5D,6BAA6B,EAAE,+BAA+B;IAC9D,sDAAsD,EACpD,wDAAwD;IAC1D,oBAAoB,EAAE,sBAAsB;IAC5C,sBAAsB,EAAE,wBAAwB;CACxC,CAAC;AAKX,MAAM,CAAC,MAAM,UAAU,GAAG;IACxB,CAAC,EAAE,GAAG;IACN,CAAC,EAAE,GAAG;CACE,CAAC;AA0ZX,MAAM,CAAC,MAAM,YAAY,GAAG;IAC1B,OAAO,EAAE,SAAS;IAClB,WAAW,EAAE,aAAa;CAClB,CAAC;AAIX,MAAM,CAAC,MAAM,kBAAkB,GAAG;IAChC,UAAU,EAAE,MAAM;IAClB,aAAa,EAAE,SAAS;IACxB,aAAa,EAAE,SAAS;IACxB,eAAe,EAAE,WAAW;IAC5B,iBAAiB,EAAE,aAAa;IAChC,aAAa,EAAE,KAAK;CACZ,CAAC;AAsBX,MAAM,CAAC,MAAM,qBAAqB,GAAG;IACnC,sBAAsB,EAAE,2BAA2B;IACnD,oBAAoB,EAAE,wBAAwB;CACtC,CAAC","sourcesContent":["import type { TransactionMeta } from '@metamask/transaction-controller';\nimport type { CaipAccountId, Hex } from '@metamask/utils';\n\nimport type { CANCELLATION_REASONS } from './constants.js';\n\n/**\n * Error response from the Subscription API.\n */\nexport type SubscriptionApiError = {\n  errorCode?: string;\n  message?: string;\n  statusCode?: number;\n};\n\n/**\n * Supported subscription products.\n */\nexport const PRODUCT_TYPES = {\n  /**\n   * MetaMask Shield.\n   */\n  SHIELD: 'shield',\n  /**\n   * Money Account Plus (delegation-based crypto billing).\n   */\n  MONEY_ACCOUNT_PLUS: 'money_account_plus',\n} as const;\n\nexport type ProductType = (typeof PRODUCT_TYPES)[keyof typeof PRODUCT_TYPES];\n\nexport const MoneyAccountFeature = {\n  SwapFeeWaiver: 'swapFeeWaiver',\n  PerpsFeeWaiver: 'perpsFeeWaiver',\n  PredictFreeTx: 'predictFreeTx',\n  PremiumApy: 'premiumApy',\n} as const;\n\nexport type MoneyAccountFeature =\n  (typeof MoneyAccountFeature)[keyof typeof MoneyAccountFeature];\n\nexport type MoneyAccountEntitlements = Record<MoneyAccountFeature, boolean>;\n\nexport const ShieldFeature = {\n  ShieldClaim: 'shieldClaim',\n  PrioritySupport: 'prioritySupport',\n} as const;\n\nexport type ShieldFeature = (typeof ShieldFeature)[keyof typeof ShieldFeature];\n\nexport type ShieldEntitlements = Record<ShieldFeature, boolean>;\n\nexport type MoneyAccountPlusClaim = {\n  plan: string;\n  entitlements: MoneyAccountEntitlements;\n};\n\nexport type ProductEntitlements = {\n  [PRODUCT_TYPES.SHIELD]?: {\n    entitlements: ShieldEntitlements;\n  };\n  [PRODUCT_TYPES.MONEY_ACCOUNT_PLUS]?: MoneyAccountPlusClaim;\n};\n\nexport type ProductEntitlementFeatureMap = {\n  [PRODUCT_TYPES.SHIELD]: ShieldFeature;\n  [PRODUCT_TYPES.MONEY_ACCOUNT_PLUS]: MoneyAccountFeature;\n};\n\n/**\n * How a crypto subscription is authorized.\n *\n * Use `erc20_approval` with `rawTransaction` (e.g. Shield). Use `delegation`\n * with `delegationHash` (e.g. Money Account Plus).\n */\nexport const CRYPTO_AUTH_METHODS = {\n  /**\n   * User signs an ERC-20 approve transaction.\n   */\n  ERC20_APPROVAL: 'erc20_approval',\n  /**\n   * User authorizes via a stored delegation hash.\n   */\n  DELEGATION: 'delegation',\n} as const;\n\nexport type CryptoAuthMethod =\n  (typeof CRYPTO_AUTH_METHODS)[keyof typeof CRYPTO_AUTH_METHODS];\n\nexport const PAYMENT_TYPES = {\n  byCard: 'card',\n  byCrypto: 'crypto',\n} as const;\n\nexport type PaymentType = (typeof PAYMENT_TYPES)[keyof typeof PAYMENT_TYPES];\n\nexport const RECURRING_INTERVALS = {\n  month: 'month',\n  year: 'year',\n} as const;\n\nexport type RecurringInterval =\n  (typeof RECURRING_INTERVALS)[keyof typeof RECURRING_INTERVALS];\n\nexport const SUBSCRIPTION_STATUSES = {\n  // Initial states\n  incomplete: 'incomplete',\n  incompleteExpired: 'incomplete_expired',\n  // Active states\n  provisional: 'provisional',\n  trialing: 'trialing',\n  active: 'active',\n  // Payment issues\n  pastDue: 'past_due',\n  unpaid: 'unpaid',\n  // Cancelled states\n  canceled: 'canceled',\n  // Paused states\n  paused: 'paused',\n} as const;\n\nexport type SubscriptionStatus =\n  (typeof SUBSCRIPTION_STATUSES)[keyof typeof SUBSCRIPTION_STATUSES];\n\nexport const CANCEL_TYPES = {\n  ALLOWED_IMMEDIATE: 'allowed_immediate',\n  ALLOWED_AT_PERIOD_END: 'allowed_at_period_end',\n  NOT_ALLOWED: 'not_allowed',\n  NOT_ALLOWED_PENDING_VERIFICATION: 'not_allowed_pending_verification',\n} as const;\n\nexport type CancelType = (typeof CANCEL_TYPES)[keyof typeof CANCEL_TYPES];\n\nexport type CancellationReasonCode =\n  (typeof CANCELLATION_REASONS)[keyof typeof CANCELLATION_REASONS];\n\nexport const CRYPTO_PAYMENT_METHOD_ERRORS = {\n  APPROVAL_TRANSACTION_TOO_OLD: 'approval_transaction_too_old',\n  APPROVAL_TRANSACTION_REVERTED: 'approval_transaction_reverted',\n  APPROVAL_TRANSACTION_MAX_VERIFICATION_ATTEMPTS_REACHED:\n    'approval_transaction_max_verification_attempts_reached',\n  INSUFFICIENT_BALANCE: 'insufficient_balance',\n  INSUFFICIENT_ALLOWANCE: 'insufficient_allowance',\n} as const;\n\nexport type CryptoPaymentMethodError =\n  (typeof CRYPTO_PAYMENT_METHOD_ERRORS)[keyof typeof CRYPTO_PAYMENT_METHOD_ERRORS];\n\nexport const MODAL_TYPE = {\n  A: 'A',\n  B: 'B',\n} as const;\n\nexport type ModalType = (typeof MODAL_TYPE)[keyof typeof MODAL_TYPE];\n\n/** only usd for now */\nexport type Currency = 'usd';\n\nexport type Product = {\n  name: ProductType;\n  currency: Currency;\n  unitAmount: number;\n  unitDecimals: number;\n};\n\n// state\nexport type Subscription = {\n  id: string;\n  products: Product[];\n  currentPeriodStart: string; // ISO 8601\n  currentPeriodEnd: string; // ISO 8601\n  /** is subscription scheduled for cancellation */\n  cancelAtPeriodEnd?: boolean;\n  status: SubscriptionStatus;\n  interval: RecurringInterval;\n  paymentMethod: SubscriptionPaymentMethod;\n  trialPeriodDays?: number;\n  trialStart?: string; // ISO 8601\n  trialEnd?: string; // ISO 8601\n  /** Crypto payment only: next billing cycle date (e.g after 12 months) */\n  endDate?: string; // ISO 8601\n  /** The date the subscription was canceled. */\n  canceledAt?: string; // ISO 8601\n  /** The cancellation type indicating what cancellation options are available for this subscription. */\n  cancelType: CancelType;\n  /** The date the subscription was marked as inactive (paused/past_due/canceled). */\n  inactiveAt?: string; // ISO 8601\n  /** Whether the user is eligible for support features (priority support and filing claims). True for active subscriptions and inactive subscriptions within grace period. */\n  isEligibleForSupport: boolean;\n  billingCycles?: number;\n};\n\nexport type SubscriptionCardPaymentMethod = {\n  type: Extract<PaymentType, 'card'>;\n  card: {\n    brand: string;\n    /** display brand account for dual brand card */\n    displayBrand: string;\n    last4: string;\n  };\n};\n\nexport type SubscriptionCryptoPaymentMethod = {\n  type: Extract<PaymentType, 'crypto'>;\n  crypto: {\n    payerAddress: Hex;\n    chainId: Hex;\n    tokenSymbol: string;\n    error?: CryptoPaymentMethodError;\n  };\n};\n\nexport type SubscriptionPaymentMethod =\n  | SubscriptionCardPaymentMethod\n  | SubscriptionCryptoPaymentMethod;\n\nexport type GetSubscriptionsResponse = {\n  customerId?: string;\n  subscriptions: Subscription[];\n  trialedProducts: ProductType[];\n  productEntitlements?: ProductEntitlements;\n  /** The last subscription that user has subscribed to if any. */\n  lastSubscription?: Subscription;\n  /** The reward account ID if user has linked rewards to the subscription. */\n  rewardAccountId?: CaipAccountId;\n};\n\n/**\n * Benefits available to a subscription user.\n */\nexport type SwapsBenefitUsage = {\n  feeBips: string | null;\n  capMicroUsd?: number;\n  consumedMicroUsd?: number;\n  remainingMicroUsd: number | null;\n  exhausted: boolean;\n};\n\nexport type PerpsBenefitUsage = {\n  builderFeeBips: string | null;\n  builderCode: string | null;\n  capMicroUsd?: number;\n  consumedMicroUsd?: number;\n  remainingMicroUsd: number | null;\n  exhausted: boolean;\n};\n\nexport type PredictBenefitUsage = {\n  builderCode: string | null;\n  capTxCount?: number;\n  consumedTxCount?: number;\n  remainingTxCount: number | null;\n  exhausted: boolean;\n};\n\ntype SubscriptionBenefitsProducts = {\n  swaps: SwapsBenefitUsage;\n  perps: PerpsBenefitUsage;\n  predict: PredictBenefitUsage;\n};\n\nexport type SubscriptionBenefitsResponse = {\n  eligible: boolean;\n  billingPeriodId: string | null;\n  products: SubscriptionBenefitsProducts;\n};\n\n/**\n * Benefits state exposed to the UI.\n */\nexport type SubscriptionBenefitsState = SubscriptionBenefitsProducts & {\n  billingPeriodId: string | null;\n};\n\nexport type StartSubscriptionRequest = {\n  products: ProductType[];\n  isTrialRequested: boolean;\n  recurringInterval: RecurringInterval;\n  successUrl?: string;\n  cancelUrl?: string;\n  useTestClock?: boolean;\n\n  /**\n   * Optional CAIP account ID of the rewards account to opt in alongside this\n   * subscription. Required when the user wants to link rewards during\n   * subscription creation.\n   *\n   * @example {\n   *   rewardAccountId: 'eip155:1:0x1234567890123456789012345678901234567890',\n   * }\n   */\n  rewardAccountId?: CaipAccountId;\n};\n\nexport type StartSubscriptionResponse = {\n  checkoutSessionUrl: string;\n};\n\ntype StartCryptoSubscriptionRequestBase = {\n  products: ProductType[];\n  isTrialRequested: boolean;\n  recurringInterval: RecurringInterval;\n  billingCycles: number;\n  chainId: Hex;\n  payerAddress: Hex;\n  /**\n   * e.g. \"USDC\"\n   */\n  tokenSymbol: string;\n  isSponsored?: boolean;\n  useTestClock?: boolean;\n  /**\n   * Optional CAIP account ID of the rewards account to opt in alongside this\n   * subscription. Required when the user wants to link rewards during\n   * subscription creation.\n   *\n   * @example {\n   *   rewardAccountId: 'eip155:1:0x1234567890123456789012345678901234567890',\n   * }\n   */\n  rewardAccountId?: CaipAccountId;\n};\n\n/**\n * ERC-20 approval crypto subscription request (e.g. Shield).\n *\n * `cryptoAuthMethod` defaults to `CRYPTO_AUTH_METHODS.ERC20_APPROVAL` when\n * omitted.\n */\nexport type StartErc20CryptoSubscriptionRequest =\n  StartCryptoSubscriptionRequestBase & {\n    cryptoAuthMethod?: typeof CRYPTO_AUTH_METHODS.ERC20_APPROVAL;\n    rawTransaction: Hex;\n    delegationHash?: never;\n  };\n\n/**\n * Delegation-based crypto subscription request (e.g. Money Account Plus).\n */\nexport type StartDelegationCryptoSubscriptionRequest =\n  StartCryptoSubscriptionRequestBase & {\n    cryptoAuthMethod: typeof CRYPTO_AUTH_METHODS.DELEGATION;\n    delegationHash: Hex;\n    rawTransaction?: never;\n  };\n\n/**\n * Request to start a crypto subscription.\n *\n * Discriminated union of ERC-20 approval vs delegation. Provide\n * `rawTransaction` for ERC-20 approval (the default when `cryptoAuthMethod` is\n * omitted), or `delegationHash` with `cryptoAuthMethod: 'delegation'`.\n * Combining or omitting both is a type error, and is also rejected at runtime\n * by `startSubscriptionWithCrypto`.\n */\nexport type StartCryptoSubscriptionRequest =\n  | StartErc20CryptoSubscriptionRequest\n  | StartDelegationCryptoSubscriptionRequest;\n\nexport type StartCryptoSubscriptionResponse = {\n  subscriptionId: string;\n  status: SubscriptionStatus;\n};\n\n/**\n * General response type for the subscription API requests\n * which doesn't require any specific response data.\n */\nexport type SubscriptionApiGeneralResponse = {\n  /**\n   * Whether the request was successful.\n   */\n  success: boolean;\n  /**\n   * The message of the response.\n   */\n  message?: string;\n};\n\nexport type CancelSubscriptionRequest = {\n  subscriptionId: string;\n  /** Whether to cancel at the end of the current period */\n  cancelAtPeriodEnd?: boolean;\n  /** Stable reason code for the cancellation. */\n  cancellationReason?: CancellationReasonCode;\n  /** Optional free-text feedback for the cancellation. */\n  cancellationFeedback?: string;\n};\n\nexport type AuthUtils = {\n  getAccessToken: () => Promise<string>;\n};\n\nexport type ProductPrice = {\n  interval: RecurringInterval;\n  unitAmount: number; // amount in the smallest unit of the currency, e.g., cents\n  unitDecimals: number; // number of decimals for the smallest unit of the currency\n  /** only usd for now */\n  currency: Currency;\n  trialPeriodDays: number;\n  /** min billing cycles for approval */\n  minBillingCycles: number;\n  /** min billing cycles for account balance check */\n  minBillingCyclesForBalance: number;\n};\n\nexport type ProductPricing = {\n  name: ProductType;\n  prices: ProductPrice[];\n};\n\ntype TokenPaymentInfoBase = {\n  symbol: string;\n  address: Hex;\n  decimals: number;\n  /**\n   * example: {\n      usd: '1.0',\n    },\n   */\n  conversionRate?: {\n    usd: string;\n  };\n  /**\n   * Source tokens that can be converted into this settlement token.\n   */\n  sources?: TokenPaymentInfo[];\n};\n\n/**\n * Spot (non-vault) settlement token. Priced via `conversionRate` when provided.\n * `accountantAddress` is not present on this variant.\n */\nexport type SpotTokenPaymentInfo = TokenPaymentInfoBase & {\n  isVaultShare?: false;\n};\n\n/**\n * Yield-bearing vault share priced via an accountant rate.\n */\nexport type VaultTokenPaymentInfo = TokenPaymentInfoBase & {\n  isVaultShare: true;\n  /**\n   * Veda accountant address used to value this vault share.\n   */\n  accountantAddress: Hex;\n};\n\n/**\n * A settlement token in a pricing chain. Discriminated by `isVaultShare`:\n * vault shares require `accountantAddress`; spot tokens omit it.\n */\nexport type TokenPaymentInfo = SpotTokenPaymentInfo | VaultTokenPaymentInfo;\n\nexport type ChainPaymentInfo = {\n  chainId: Hex;\n  paymentAddress: Hex;\n  /**\n   * Delegate address clients authorize when using the delegation auth method.\n   */\n  delegateAddress?: Hex;\n  tokens: TokenPaymentInfo[];\n  /**\n   * Whether the chain supports sponsorship for the trialed subscription approval transaction.\n   * This is used to determine if the user can be sponsored for the gas fees for the trialed subscription approval transaction.\n   */\n  isSponsorshipSupported?: boolean;\n};\n\nexport type PricingCardPaymentMethod = {\n  type: Extract<PaymentType, 'card'>;\n  /**\n   * Products that support this payment method.\n   */\n  products?: ProductType[];\n};\n\nexport type PricingCryptoPaymentMethod = {\n  type: Extract<PaymentType, 'crypto'>;\n  /**\n   * Crypto authorization method. Omitted together with `products` on persisted\n   * pre-multi-product pricing rows; those rows are treated as Shield + `erc20_approval`.\n   * If `products` is set, this field must be explicit.\n   */\n  cryptoAuthMethod?: CryptoAuthMethod;\n  /**\n   * Products that support this payment method. Omitted together with\n   * `cryptoAuthMethod` on persisted pre-multi-product pricing rows (treated as Shield).\n   * If present, must be non-empty and paired with an explicit `cryptoAuthMethod`.\n   */\n  products?: ProductType[];\n  chains?: ChainPaymentInfo[];\n};\n\n/**\n * A pricing payment-method row. Discriminated by `type`: card rows have no\n * crypto fields; crypto rows may include `cryptoAuthMethod` and `chains`.\n */\nexport type PricingPaymentMethod =\n  | PricingCardPaymentMethod\n  | PricingCryptoPaymentMethod;\n\nexport type PricingResponse = {\n  products: ProductPricing[];\n  paymentMethods: PricingPaymentMethod[];\n};\n\nexport type GetCryptoApproveTransactionRequest = {\n  /**\n   * payment chain ID\n   */\n  chainId: Hex;\n  /**\n   * Payment token address\n   */\n  paymentTokenAddress: Hex;\n  productType: ProductType;\n  interval: RecurringInterval;\n};\n\nexport type GetCryptoApproveTransactionResponse = {\n  /**\n   * The amount to approve\n   * e.g: \"100000000\"\n   */\n  approveAmount: string;\n  /**\n   * The contract address (spender)\n   */\n  paymentAddress: Hex;\n  /**\n   * The payment token address\n   */\n  paymentTokenAddress: Hex;\n  chainId: Hex;\n};\n\n/**\n * Request to submit a Shield ERC-20 crypto approval transaction.\n */\nexport type SubmitSubscriptionCryptoApprovalRequest = {\n  /**\n   * The subscription product. Typed as `typeof PRODUCT_TYPES.SHIELD` only at\n   * the moment (future might support more product).\n   */\n  productType: typeof PRODUCT_TYPES.SHIELD;\n  /**\n   * The transaction metadata. Must have type\n   * `TransactionType.shieldSubscriptionApprove`.\n   */\n  txMeta: TransactionMeta;\n  /**\n   * Whether the transaction is sponsored.\n   */\n  isSponsored?: boolean;\n  /**\n   * The account ID of the reward subscription to link.\n   */\n  rewardAccountId?: CaipAccountId;\n};\n\nexport const COHORT_NAMES = {\n  POST_TX: 'post_tx',\n  WALLET_HOME: 'wallet_home',\n} as const;\n\nexport type CohortName = (typeof COHORT_NAMES)[keyof typeof COHORT_NAMES];\n\nexport const BALANCE_CATEGORIES = {\n  RANGE_0_99: '0-99',\n  RANGE_100_999: '100-999',\n  RANGE_1K_9_9K: '1k-9.9k',\n  RANGE_10K_99_9K: '10k-99.9k',\n  RANGE_100K_999_9K: '100k-999.9k',\n  RANGE_1M_PLUS: '1M+',\n} as const;\n\nexport type BalanceCategory =\n  (typeof BALANCE_CATEGORIES)[keyof typeof BALANCE_CATEGORIES];\n\nexport type Cohort = {\n  cohort: string;\n  eligibilityRate: number; // 0-1 probability of being assigned to this cohort\n  priority: number; // lower number = higher priority\n  eligible: boolean;\n};\n\nexport type SubscriptionEligibility = {\n  product: ProductType;\n  canSubscribe: boolean;\n  canViewEntryModal: boolean;\n  modalType?: ModalType;\n  cohorts: Cohort[];\n  assignedCohort: string | null;\n  hasAssignedCohortExpired: boolean;\n};\n\nexport const SubscriptionUserEvent = {\n  ShieldEntryModalViewed: 'shield_entry_modal_viewed',\n  ShieldCohortAssigned: 'shield_cohort_assigned',\n} as const;\n\nexport type SubscriptionUserEventType =\n  (typeof SubscriptionUserEvent)[keyof typeof SubscriptionUserEvent];\n\nexport type SubmitUserEventRequest = {\n  event: SubscriptionUserEventType;\n  cohort?: string;\n};\n\nexport type AssignCohortRequest = {\n  cohort: string;\n};\n\nexport type GetSubscriptionsEligibilitiesRequest = {\n  balanceCategory?: BalanceCategory;\n};\n\n/**\n * Request object for submitting sponsorship intents.\n */\nexport type SubmitSponsorshipIntentsRequest = {\n  chainId: Hex;\n  address: Hex;\n  products: ProductType[];\n  paymentTokenSymbol: string;\n  recurringInterval: RecurringInterval;\n  billingCycles: number;\n};\n\nexport type SubmitSponsorshipIntentsMethodParams = Pick<\n  SubmitSponsorshipIntentsRequest,\n  'chainId' | 'address' | 'products'\n>;\n\nexport type ISubscriptionService = {\n  getSubscriptions(): Promise<GetSubscriptionsResponse>;\n  getBenefits(): Promise<SubscriptionBenefitsResponse>;\n  cancelSubscription(request: CancelSubscriptionRequest): Promise<Subscription>;\n  unCancelSubscription(request: {\n    subscriptionId: string;\n  }): Promise<Subscription>;\n  /**\n   * Starts a card-paid subscription checkout session for the requested products\n   * (e.g. Shield or Money Account Plus).\n   *\n   * @param request - The start subscription request.\n   * @returns The checkout session response.\n   */\n  startSubscriptionWithCard(\n    request: StartSubscriptionRequest,\n  ): Promise<StartSubscriptionResponse>;\n  getBillingPortalUrl(): Promise<BillingPortalResponse>;\n  getPricing(): Promise<PricingResponse>;\n  startSubscriptionWithCrypto(\n    request: StartCryptoSubscriptionRequest,\n  ): Promise<StartCryptoSubscriptionResponse>;\n  updatePaymentMethodCard(\n    request: UpdatePaymentMethodCardRequest,\n  ): Promise<UpdatePaymentMethodCardResponse>;\n  updatePaymentMethodCrypto(\n    request: UpdatePaymentMethodCryptoRequest,\n  ): Promise<void>;\n  getSubscriptionsEligibilities(\n    request?: GetSubscriptionsEligibilitiesRequest,\n  ): Promise<SubscriptionEligibility[]>;\n  submitUserEvent(request: SubmitUserEventRequest): Promise<void>;\n  assignUserToCohort(request: AssignCohortRequest): Promise<void>;\n\n  /**\n   * Link rewards to a subscription.\n   */\n  linkRewards(\n    request: LinkRewardsRequest,\n  ): Promise<SubscriptionApiGeneralResponse>;\n\n  /**\n   * Submit sponsorship intents to the Subscription Service backend.\n   *\n   * This is intended to be used together with the crypto subscription flow.\n   * When the user has enabled the smart transaction feature, we will sponsor the gas fees for the subscription approval transaction.\n   *\n   * @param request - Request object containing the address and products.\n   * @example {\n   *   address: '0x1234567890123456789012345678901234567890',\n   *   products: [ProductType.Shield],\n   *   recurringInterval: RecurringInterval.Month,\n   *   billingCycles: 1,\n   * }\n   */\n  submitSponsorshipIntents(\n    request: SubmitSponsorshipIntentsRequest,\n  ): Promise<void>;\n};\n\nexport type UpdatePaymentMethodOpts =\n  | ({\n      paymentType: Extract<PaymentType, 'card'>;\n    } & UpdatePaymentMethodCardRequest)\n  | ({\n      paymentType: Extract<PaymentType, 'crypto'>;\n    } & UpdatePaymentMethodCryptoRequest);\n\nexport type UpdatePaymentMethodCardRequest = {\n  /**\n   * Subscription ID\n   */\n  subscriptionId: string;\n\n  /**\n   * Recurring interval\n   */\n  recurringInterval: RecurringInterval;\n  successUrl?: string;\n  cancelUrl?: string;\n};\n\nexport type UpdatePaymentMethodCardResponse = {\n  redirectUrl: string;\n};\n\nexport type UpdatePaymentMethodCryptoRequest = {\n  subscriptionId: string;\n  chainId: Hex;\n  payerAddress: Hex;\n  tokenSymbol: string;\n  /**\n   * The raw transaction to pay for the subscription\n   * Can be empty if retry after topping up balance\n   */\n  rawTransaction?: Hex;\n  recurringInterval: RecurringInterval;\n  billingCycles: number;\n};\n\nexport type BillingPortalResponse = {\n  url: string;\n};\n\n/**\n * The cached result of last selected payment methods for the user.\n * These details are being cached to be used internally to track the last selected payment method for the user. (e.g. for crypto subscriptions)\n */\nexport type CachedLastSelectedPaymentMethod = {\n  type: PaymentType;\n  paymentTokenAddress?: Hex;\n  paymentTokenSymbol?: string;\n  plan: RecurringInterval;\n  useTestClock?: boolean;\n  /**\n   * Crypto authorization method. Omitted on persisted cache entries written\n   * before this field existed; treat as `erc20_approval` when missing.\n   */\n  cryptoAuthMethod?: CryptoAuthMethod;\n};\n\n/**\n * Request to cache the last selected payment method for a product.\n */\nexport type CacheLastSelectedPaymentMethodRequest = {\n  /**\n   * The product to cache the payment method for.\n   */\n  product: ProductType;\n  /**\n   * The payment method to cache.\n   */\n  paymentMethod: CachedLastSelectedPaymentMethod;\n};\n\n/**\n * Request object for linking rewards to a subscription.\n */\nexport type LinkRewardsRequest = {\n  /**\n   * The ID of the reward subscription to be linked to the subscription.\n   *\n   * @example {\n   *   rewardAccountId: 'eip155:1:0x1234567890123456789012345678901234567890',\n   * }\n   */\n  rewardAccountId: CaipAccountId;\n};\n"]}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAcA;;GAEG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B;;OAEG;IACH,MAAM,EAAE,QAAQ;IAChB;;OAEG;IACH,kBAAkB,EAAE,oBAAoB;CAChC,CAAC;AAIX,MAAM,CAAC,MAAM,mBAAmB,GAAG;IACjC,aAAa,EAAE,eAAe;IAC9B,cAAc,EAAE,gBAAgB;IAChC,aAAa,EAAE,eAAe;IAC9B,UAAU,EAAE,YAAY;CAChB,CAAC;AAOX,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B,WAAW,EAAE,aAAa;IAC1B,eAAe,EAAE,iBAAiB;CAC1B,CAAC;AAuBX;;;;;GAKG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG;IACjC;;OAEG;IACH,cAAc,EAAE,gBAAgB;IAChC;;OAEG;IACH,UAAU,EAAE,YAAY;CAChB,CAAC;AAKX,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B,MAAM,EAAE,MAAM;IACd,QAAQ,EAAE,QAAQ;CACV,CAAC;AAIX,MAAM,CAAC,MAAM,mBAAmB,GAAG;IACjC,KAAK,EAAE,OAAO;IACd,IAAI,EAAE,MAAM;CACJ,CAAC;AAKX,MAAM,CAAC,MAAM,qBAAqB,GAAG;IACnC,iBAAiB;IACjB,UAAU,EAAE,YAAY;IACxB,iBAAiB,EAAE,oBAAoB;IACvC,gBAAgB;IAChB,WAAW,EAAE,aAAa;IAC1B,QAAQ,EAAE,UAAU;IACpB,MAAM,EAAE,QAAQ;IAChB,iBAAiB;IACjB,OAAO,EAAE,UAAU;IACnB,MAAM,EAAE,QAAQ;IAChB,mBAAmB;IACnB,QAAQ,EAAE,UAAU;IACpB,gBAAgB;IAChB,MAAM,EAAE,QAAQ;CACR,CAAC;AAKX,MAAM,CAAC,MAAM,wBAAwB,GAAG;IACtC,UAAU,EAAE,YAAY;IACxB,SAAS,EAAE,WAAW;IACtB,MAAM,EAAE,QAAQ;IAChB,OAAO,EAAE,SAAS;CACV,CAAC;AAKX,MAAM,CAAC,MAAM,YAAY,GAAG;IAC1B,iBAAiB,EAAE,mBAAmB;IACtC,qBAAqB,EAAE,uBAAuB;IAC9C,WAAW,EAAE,aAAa;IAC1B,gCAAgC,EAAE,kCAAkC;CAC5D,CAAC;AAOX,MAAM,CAAC,MAAM,4BAA4B,GAAG;IAC1C,4BAA4B,EAAE,8BAA8B;IAC5D,6BAA6B,EAAE,+BAA+B;IAC9D,sDAAsD,EACpD,wDAAwD;IAC1D,oBAAoB,EAAE,sBAAsB;IAC5C,sBAAsB,EAAE,wBAAwB;CACxC,CAAC;AAKX;;;;;GAKG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG;IACnC,oBAAoB,EAAE,sBAAsB;IAC5C,sBAAsB,EAAE,wBAAwB;IAChD,4BAA4B,EAAE,8BAA8B;IAC5D,oBAAoB,EAAE,sBAAsB;IAC5C,kBAAkB,EAAE,oBAAoB;IACxC,yBAAyB,EAAE,2BAA2B;IACtD,qBAAqB,EAAE,uBAAuB;CACtC,CAAC;AAKX,MAAM,CAAC,MAAM,UAAU,GAAG;IACxB,CAAC,EAAE,GAAG;IACN,CAAC,EAAE,GAAG;CACE,CAAC;AA2SX;;;GAGG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG;IACzB,IAAI,EAAE,MAAM;IACZ,OAAO,EAAE,SAAS;CACV,CAAC;AAmCX;;;;;;GAMG;AACH,MAAM,UAAU,iBAAiB,CAC/B,KAAuB;IAEvB,OAAQ,KAA+B,CAAC,iBAAiB,KAAK,SAAS,CAAC;AAC1E,CAAC;AA6GD,MAAM,CAAC,MAAM,YAAY,GAAG;IAC1B,OAAO,EAAE,SAAS;IAClB,WAAW,EAAE,aAAa;CAClB,CAAC;AAIX,MAAM,CAAC,MAAM,kBAAkB,GAAG;IAChC,UAAU,EAAE,MAAM;IAClB,aAAa,EAAE,SAAS;IACxB,aAAa,EAAE,SAAS;IACxB,eAAe,EAAE,WAAW;IAC5B,iBAAiB,EAAE,aAAa;IAChC,aAAa,EAAE,KAAK;CACZ,CAAC;AAsBX,MAAM,CAAC,MAAM,qBAAqB,GAAG;IACnC,sBAAsB,EAAE,2BAA2B;IACnD,oBAAoB,EAAE,wBAAwB;CACtC,CAAC","sourcesContent":["import type { TransactionMeta } from '@metamask/transaction-controller';\nimport type { CaipAccountId, Hex } from '@metamask/utils';\n\nimport type { CANCELLATION_REASONS } from './constants.js';\n\n/**\n * Error response from the Subscription API.\n */\nexport type SubscriptionApiError = {\n  errorCode?: string;\n  message?: string;\n  statusCode?: number;\n};\n\n/**\n * Supported subscription products.\n */\nexport const PRODUCT_TYPES = {\n  /**\n   * MetaMask Shield.\n   */\n  SHIELD: 'shield',\n  /**\n   * Money Account Plus (delegation-based crypto billing).\n   */\n  MONEY_ACCOUNT_PLUS: 'money_account_plus',\n} as const;\n\nexport type ProductType = (typeof PRODUCT_TYPES)[keyof typeof PRODUCT_TYPES];\n\nexport const MoneyAccountFeature = {\n  SwapFeeWaiver: 'swapFeeWaiver',\n  PerpsFeeWaiver: 'perpsFeeWaiver',\n  PredictFreeTx: 'predictFreeTx',\n  PremiumApy: 'premiumApy',\n} as const;\n\nexport type MoneyAccountFeature =\n  (typeof MoneyAccountFeature)[keyof typeof MoneyAccountFeature];\n\nexport type MoneyAccountEntitlements = Record<MoneyAccountFeature, boolean>;\n\nexport const ShieldFeature = {\n  ShieldClaim: 'shieldClaim',\n  PrioritySupport: 'prioritySupport',\n} as const;\n\nexport type ShieldFeature = (typeof ShieldFeature)[keyof typeof ShieldFeature];\n\nexport type ShieldEntitlements = Record<ShieldFeature, boolean>;\n\nexport type MoneyAccountPlusClaim = {\n  plan: string;\n  entitlements: MoneyAccountEntitlements;\n};\n\nexport type ProductEntitlements = {\n  [PRODUCT_TYPES.SHIELD]?: {\n    entitlements: ShieldEntitlements;\n  };\n  [PRODUCT_TYPES.MONEY_ACCOUNT_PLUS]?: MoneyAccountPlusClaim;\n};\n\nexport type ProductEntitlementFeatureMap = {\n  [PRODUCT_TYPES.SHIELD]: ShieldFeature;\n  [PRODUCT_TYPES.MONEY_ACCOUNT_PLUS]: MoneyAccountFeature;\n};\n\n/**\n * How a crypto subscription is authorized.\n *\n * Use `erc20_approval` with `rawTransaction` (e.g. Shield). Use `delegation`\n * with `delegationHash` (e.g. Money Account Plus).\n */\nexport const CRYPTO_AUTH_METHODS = {\n  /**\n   * User signs an ERC-20 approve transaction.\n   */\n  ERC20_APPROVAL: 'erc20_approval',\n  /**\n   * User authorizes via a stored delegation hash.\n   */\n  DELEGATION: 'delegation',\n} as const;\n\nexport type CryptoAuthMethod =\n  (typeof CRYPTO_AUTH_METHODS)[keyof typeof CRYPTO_AUTH_METHODS];\n\nexport const PAYMENT_TYPES = {\n  byCard: 'card',\n  byCrypto: 'crypto',\n} as const;\n\nexport type PaymentType = (typeof PAYMENT_TYPES)[keyof typeof PAYMENT_TYPES];\n\nexport const RECURRING_INTERVALS = {\n  month: 'month',\n  year: 'year',\n} as const;\n\nexport type RecurringInterval =\n  (typeof RECURRING_INTERVALS)[keyof typeof RECURRING_INTERVALS];\n\nexport const SUBSCRIPTION_STATUSES = {\n  // Initial states\n  incomplete: 'incomplete',\n  incompleteExpired: 'incomplete_expired',\n  // Active states\n  provisional: 'provisional',\n  trialing: 'trialing',\n  active: 'active',\n  // Payment issues\n  pastDue: 'past_due',\n  unpaid: 'unpaid',\n  // Cancelled states\n  canceled: 'canceled',\n  // Paused states\n  paused: 'paused',\n} as const;\n\nexport type SubscriptionStatus =\n  (typeof SUBSCRIPTION_STATUSES)[keyof typeof SUBSCRIPTION_STATUSES];\n\nexport const INVOICE_PAYMENT_STATUSES = {\n  PROCESSING: 'PROCESSING',\n  SUCCEEDED: 'SUCCEEDED',\n  FAILED: 'FAILED',\n  UNKNOWN: 'UNKNOWN',\n} as const;\n\nexport type InvoicePaymentStatus =\n  (typeof INVOICE_PAYMENT_STATUSES)[keyof typeof INVOICE_PAYMENT_STATUSES];\n\nexport const CANCEL_TYPES = {\n  ALLOWED_IMMEDIATE: 'allowed_immediate',\n  ALLOWED_AT_PERIOD_END: 'allowed_at_period_end',\n  NOT_ALLOWED: 'not_allowed',\n  NOT_ALLOWED_PENDING_VERIFICATION: 'not_allowed_pending_verification',\n} as const;\n\nexport type CancelType = (typeof CANCEL_TYPES)[keyof typeof CANCEL_TYPES];\n\nexport type CancellationReasonCode =\n  (typeof CANCELLATION_REASONS)[keyof typeof CANCELLATION_REASONS];\n\nexport const CRYPTO_PAYMENT_METHOD_ERRORS = {\n  APPROVAL_TRANSACTION_TOO_OLD: 'approval_transaction_too_old',\n  APPROVAL_TRANSACTION_REVERTED: 'approval_transaction_reverted',\n  APPROVAL_TRANSACTION_MAX_VERIFICATION_ATTEMPTS_REACHED:\n    'approval_transaction_max_verification_attempts_reached',\n  INSUFFICIENT_BALANCE: 'insufficient_balance',\n  INSUFFICIENT_ALLOWANCE: 'insufficient_allowance',\n} as const;\n\nexport type CryptoPaymentMethodError =\n  (typeof CRYPTO_PAYMENT_METHOD_ERRORS)[keyof typeof CRYPTO_PAYMENT_METHOD_ERRORS];\n\n/**\n * Errors returned by the Subscription API after crypto payment execution.\n *\n * These are distinct from {@link CRYPTO_PAYMENT_METHOD_ERRORS}, which describe\n * approval/payment-method failures.\n */\nexport const CRYPTO_PAYMENT_ERRORS = {\n  INSUFFICIENT_BALANCE: 'insufficient_balance',\n  INSUFFICIENT_ALLOWANCE: 'insufficient_allowance',\n  EXCEEDS_DELEGATION_ALLOWANCE: 'exceeds_delegation_allowance',\n  DELEGATION_NOT_FOUND: 'delegation_not_found',\n  DELEGATION_REVOKED: 'delegation_revoked',\n  RECIPIENT_NOT_ALLOWLISTED: 'recipient_not_allowlisted',\n  INTERNAL_SERVER_ERROR: 'internal_server_error',\n} as const;\n\nexport type CryptoPaymentError =\n  (typeof CRYPTO_PAYMENT_ERRORS)[keyof typeof CRYPTO_PAYMENT_ERRORS];\n\nexport const MODAL_TYPE = {\n  A: 'A',\n  B: 'B',\n} as const;\n\nexport type ModalType = (typeof MODAL_TYPE)[keyof typeof MODAL_TYPE];\n\n/** only usd for now */\nexport type Currency = 'usd';\n\nexport type Product = {\n  name: ProductType;\n  currency: Currency;\n  unitAmount: number;\n  unitDecimals: number;\n};\n\n// state\nexport type Subscription = {\n  id: string;\n  products: Product[];\n  currentPeriodStart?: string; // ISO 8601\n  currentPeriodEnd?: string; // ISO 8601\n  /** is subscription scheduled for cancellation */\n  cancelAtPeriodEnd?: boolean;\n  status: SubscriptionStatus;\n  interval: RecurringInterval;\n  paymentMethod: SubscriptionPaymentMethod;\n  trialPeriodDays?: number;\n  trialStart?: string; // ISO 8601\n  trialEnd?: string; // ISO 8601\n  /** Crypto payment only: next billing cycle date (e.g after 12 months) */\n  endDate?: string; // ISO 8601\n  /** The date the subscription was canceled. */\n  canceledAt?: string; // ISO 8601\n  /** The cancellation type indicating what cancellation options are available for this subscription. */\n  cancelType?: CancelType;\n  /** The date the subscription was marked as inactive (paused/past_due/canceled). */\n  inactiveAt?: string; // ISO 8601\n  /** Whether the user is eligible for support features (priority support and filing claims). True for active subscriptions and inactive subscriptions within grace period. */\n  isEligibleForSupport?: boolean;\n  billingCycles?: number;\n  /** The most recent invoice associated with the subscription. */\n  lastInvoice?: SubscriptionInvoice;\n};\n\nexport type SubscriptionInvoice = {\n  id: string;\n  status: InvoicePaymentStatus;\n  errorCode?: CryptoPaymentError;\n  updatedAt: string; // ISO 8601\n};\n\nexport type SubscriptionCardPaymentMethod = {\n  type: Extract<PaymentType, 'card'>;\n  card: {\n    brand: string;\n    /** display brand account for dual brand card */\n    displayBrand: string;\n    last4: string;\n  };\n};\n\nexport type SubscriptionCryptoPaymentMethod = {\n  type: Extract<PaymentType, 'crypto'>;\n  crypto: {\n    payerAddress: Hex;\n    chainId: Hex;\n    tokenSymbol: string;\n    error?: CryptoPaymentMethodError;\n  };\n};\n\nexport type SubscriptionPaymentMethod =\n  | SubscriptionCardPaymentMethod\n  | SubscriptionCryptoPaymentMethod;\n\nexport type GetSubscriptionsResponse = {\n  customerId?: string;\n  subscriptions: Subscription[];\n  trialedProducts: ProductType[];\n  productEntitlements?: ProductEntitlements;\n  /** The last subscription that user has subscribed to if any. */\n  lastSubscription?: Subscription;\n  /** The reward account ID if user has linked rewards to the subscription. */\n  rewardAccountId?: CaipAccountId;\n};\n\n/**\n * Benefits available to a subscription user.\n */\nexport type SwapsBenefitUsage = {\n  feeBips: string | null;\n  capMicroUsd?: number;\n  consumedMicroUsd?: number;\n  remainingMicroUsd: number | null;\n  exhausted: boolean;\n};\n\nexport type PerpsBenefitUsage = {\n  builderFeeBips: string | null;\n  builderCode: string | null;\n  capMicroUsd?: number;\n  consumedMicroUsd?: number;\n  remainingMicroUsd: number | null;\n  exhausted: boolean;\n};\n\nexport type PredictBenefitUsage = {\n  builderCode: string | null;\n  capTxCount?: number;\n  consumedTxCount?: number;\n  remainingTxCount: number | null;\n  exhausted: boolean;\n};\n\ntype SubscriptionBenefitsProducts = {\n  swaps: SwapsBenefitUsage;\n  perps: PerpsBenefitUsage;\n  predict: PredictBenefitUsage;\n};\n\nexport type SubscriptionBenefitsResponse = {\n  eligible: boolean;\n  billingPeriodId: string | null;\n  products: SubscriptionBenefitsProducts;\n};\n\n/**\n * Benefits state exposed to the UI.\n */\nexport type SubscriptionBenefitsState = SubscriptionBenefitsProducts & {\n  billingPeriodId: string | null;\n};\n\nexport type StartSubscriptionRequest = {\n  products: ProductType[];\n  isTrialRequested: boolean;\n  recurringInterval: RecurringInterval;\n  successUrl?: string;\n  cancelUrl?: string;\n  useTestClock?: boolean;\n\n  /**\n   * Optional CAIP account ID of the rewards account to opt in alongside this\n   * subscription. Required when the user wants to link rewards during\n   * subscription creation.\n   *\n   * @example {\n   *   rewardAccountId: 'eip155:1:0x1234567890123456789012345678901234567890',\n   * }\n   */\n  rewardAccountId?: CaipAccountId;\n};\n\nexport type StartSubscriptionResponse = {\n  checkoutSessionUrl: string;\n};\n\ntype StartCryptoSubscriptionRequestBase = {\n  products: ProductType[];\n  isTrialRequested: boolean;\n  recurringInterval: RecurringInterval;\n  billingCycles: number;\n  chainId: Hex;\n  payerAddress: Hex;\n  /**\n   * e.g. \"USDC\"\n   */\n  tokenSymbol: string;\n  isSponsored?: boolean;\n  useTestClock?: boolean;\n  /**\n   * Optional CAIP account ID of the rewards account to opt in alongside this\n   * subscription. Required when the user wants to link rewards during\n   * subscription creation.\n   *\n   * @example {\n   *   rewardAccountId: 'eip155:1:0x1234567890123456789012345678901234567890',\n   * }\n   */\n  rewardAccountId?: CaipAccountId;\n};\n\n/**\n * ERC-20 approval crypto subscription request (e.g. Shield).\n *\n * `cryptoAuthMethod` defaults to `CRYPTO_AUTH_METHODS.ERC20_APPROVAL` when\n * omitted.\n */\nexport type StartErc20CryptoSubscriptionRequest =\n  StartCryptoSubscriptionRequestBase & {\n    cryptoAuthMethod?: typeof CRYPTO_AUTH_METHODS.ERC20_APPROVAL;\n    rawTransaction: Hex;\n    delegationHash?: never;\n  };\n\n/**\n * Delegation-based crypto subscription request (e.g. Money Account Plus).\n */\nexport type StartDelegationCryptoSubscriptionRequest =\n  StartCryptoSubscriptionRequestBase & {\n    cryptoAuthMethod: typeof CRYPTO_AUTH_METHODS.DELEGATION;\n    delegationHash: Hex;\n    rawTransaction?: never;\n  };\n\n/**\n * Request to start a crypto subscription.\n *\n * Discriminated union of ERC-20 approval vs delegation. Provide\n * `rawTransaction` for ERC-20 approval (the default when `cryptoAuthMethod` is\n * omitted), or `delegationHash` with `cryptoAuthMethod: 'delegation'`.\n * Combining or omitting both is a type error, and is also rejected at runtime\n * by `startSubscriptionWithCrypto`.\n */\nexport type StartCryptoSubscriptionRequest =\n  | StartErc20CryptoSubscriptionRequest\n  | StartDelegationCryptoSubscriptionRequest;\n\nexport type StartCryptoSubscriptionResponse = {\n  subscriptionId: string;\n  status: SubscriptionStatus;\n};\n\n/**\n * General response type for the subscription API requests\n * which doesn't require any specific response data.\n */\nexport type SubscriptionApiGeneralResponse = {\n  /**\n   * Whether the request was successful.\n   */\n  success: boolean;\n  /**\n   * The message of the response.\n   */\n  message?: string;\n};\n\nexport type CancelSubscriptionRequest = {\n  subscriptionId: string;\n  /** Whether to cancel at the end of the current period */\n  cancelAtPeriodEnd?: boolean;\n  /** Stable reason code for the cancellation. */\n  cancellationReason?: CancellationReasonCode;\n  /** Optional free-text feedback for the cancellation. */\n  cancellationFeedback?: string;\n};\n\nexport type AuthUtils = {\n  getAccessToken: () => Promise<string>;\n};\n\nexport type ProductPrice = {\n  interval: RecurringInterval;\n  unitAmount: number; // amount in the smallest unit of the currency, e.g., cents\n  unitDecimals: number; // number of decimals for the smallest unit of the currency\n  /** only usd for now */\n  currency: Currency;\n  trialPeriodDays: number;\n  /** min billing cycles for approval */\n  minBillingCycles: number;\n  /** min billing cycles for account balance check */\n  minBillingCyclesForBalance: number;\n};\n\nexport type ProductPricing = {\n  name: ProductType;\n  prices: ProductPrice[];\n};\n\ntype TokenPaymentInfoBase = {\n  symbol: string;\n  address: Hex;\n  decimals: number;\n  /**\n   * example: {\n      usd: '1.0',\n    },\n   */\n  conversionRate?: {\n    usd: string;\n  };\n  /**\n   * Source tokens that can be converted into this settlement token.\n   */\n  sources?: TokenPaymentInfo[];\n};\n\n/**\n * Named vault a vault-share settlement token belongs to, e.g. `base` or\n * `premium`. Distinguishes which vault to withdraw from.\n *\n * Deliberately a plain `string` rather than a union: the set of vaults is\n * server-driven and grows without a client release, so narrowing it here would\n * make the pricing response fail validation the first time the API adds a\n * vault. Compare against `VAULT_NAMES` instead of raw literals, and always\n * handle the unknown case.\n */\nexport type VaultName = string;\n\n/**\n * The vault names known at the time of writing. Not exhaustive — see\n * {@link VaultName}.\n */\nexport const VAULT_NAMES = {\n  base: 'base',\n  premium: 'premium',\n} as const;\n\n/**\n * Spot (non-vault) settlement token. Priced via `conversionRate` when provided.\n * Neither `accountantAddress` nor `vault` is present on this variant.\n */\nexport type SpotTokenPaymentInfo = TokenPaymentInfoBase;\n\n/**\n * Yield-bearing vault share priced via an accountant rate.\n */\nexport type VaultTokenPaymentInfo = TokenPaymentInfoBase & {\n  /**\n   * Veda accountant address used to value this vault share. Every vault has\n   * its own accountant, so this is present on every vault-share token — which\n   * is what makes it the discriminant for this variant.\n   */\n  accountantAddress: Hex;\n  /**\n   * Named vault this token is a share of. Sent only for vault-share tokens.\n   */\n  vault?: VaultName;\n};\n\n/**\n * A settlement token in a pricing chain. Discriminated by the presence of\n * `accountantAddress`: vault shares carry it (and may carry `vault`), spot\n * tokens carry neither.\n *\n * The API previously sent an explicit `isVaultShare` boolean. It no longer\n * does, so do not reintroduce a dependency on it — use\n * {@link isVaultShareToken}.\n */\nexport type TokenPaymentInfo = SpotTokenPaymentInfo | VaultTokenPaymentInfo;\n\n/**\n * Whether a settlement token is a yield-bearing vault share, which must be\n * valued through its accountant rate rather than at face value.\n *\n * @param token - The settlement token to check.\n * @returns True if the token is a vault share.\n */\nexport function isVaultShareToken(\n  token: TokenPaymentInfo,\n): token is VaultTokenPaymentInfo {\n  return (token as VaultTokenPaymentInfo).accountantAddress !== undefined;\n}\n\nexport type ChainPaymentInfo = {\n  chainId: Hex;\n  paymentAddress: Hex;\n  /**\n   * Delegate address clients authorize when using the delegation auth method.\n   */\n  delegateAddress?: Hex;\n  tokens: TokenPaymentInfo[];\n  /**\n   * Whether the chain supports sponsorship for the trialed subscription approval transaction.\n   * This is used to determine if the user can be sponsored for the gas fees for the trialed subscription approval transaction.\n   */\n  isSponsorshipSupported?: boolean;\n};\n\nexport type PricingCardPaymentMethod = {\n  type: Extract<PaymentType, 'card'>;\n  /**\n   * Products that support this payment method.\n   */\n  products?: ProductType[];\n};\n\nexport type PricingCryptoPaymentMethod = {\n  type: Extract<PaymentType, 'crypto'>;\n  /**\n   * Crypto authorization method. Omitted together with `products` on persisted\n   * pre-multi-product pricing rows; those rows are treated as Shield + `erc20_approval`.\n   * If `products` is set, this field must be explicit.\n   */\n  cryptoAuthMethod?: CryptoAuthMethod;\n  /**\n   * Products that support this payment method. Omitted together with\n   * `cryptoAuthMethod` on persisted pre-multi-product pricing rows (treated as Shield).\n   * If present, must be non-empty and paired with an explicit `cryptoAuthMethod`.\n   */\n  products?: ProductType[];\n  chains?: ChainPaymentInfo[];\n};\n\n/**\n * A pricing payment-method row. Discriminated by `type`: card rows have no\n * crypto fields; crypto rows may include `cryptoAuthMethod` and `chains`.\n */\nexport type PricingPaymentMethod =\n  | PricingCardPaymentMethod\n  | PricingCryptoPaymentMethod;\n\nexport type PricingResponse = {\n  products: ProductPricing[];\n  paymentMethods: PricingPaymentMethod[];\n};\n\nexport type GetCryptoApproveTransactionRequest = {\n  /**\n   * payment chain ID\n   */\n  chainId: Hex;\n  /**\n   * Payment token address\n   */\n  paymentTokenAddress: Hex;\n  productType: ProductType;\n  interval: RecurringInterval;\n};\n\nexport type GetCryptoApproveTransactionResponse = {\n  /**\n   * The amount to approve\n   * e.g: \"100000000\"\n   */\n  approveAmount: string;\n  /**\n   * The contract address (spender)\n   */\n  paymentAddress: Hex;\n  /**\n   * The payment token address\n   */\n  paymentTokenAddress: Hex;\n  chainId: Hex;\n};\n\n/**\n * Request to submit a Shield ERC-20 crypto approval transaction.\n */\nexport type SubmitSubscriptionCryptoApprovalRequest = {\n  /**\n   * The subscription product. Typed as `typeof PRODUCT_TYPES.SHIELD` only at\n   * the moment (future might support more product).\n   */\n  productType: typeof PRODUCT_TYPES.SHIELD;\n  /**\n   * The transaction metadata. Must have type\n   * `TransactionType.shieldSubscriptionApprove`.\n   */\n  txMeta: TransactionMeta;\n  /**\n   * Whether the transaction is sponsored.\n   */\n  isSponsored?: boolean;\n  /**\n   * The account ID of the reward subscription to link.\n   */\n  rewardAccountId?: CaipAccountId;\n};\n\nexport const COHORT_NAMES = {\n  POST_TX: 'post_tx',\n  WALLET_HOME: 'wallet_home',\n} as const;\n\nexport type CohortName = (typeof COHORT_NAMES)[keyof typeof COHORT_NAMES];\n\nexport const BALANCE_CATEGORIES = {\n  RANGE_0_99: '0-99',\n  RANGE_100_999: '100-999',\n  RANGE_1K_9_9K: '1k-9.9k',\n  RANGE_10K_99_9K: '10k-99.9k',\n  RANGE_100K_999_9K: '100k-999.9k',\n  RANGE_1M_PLUS: '1M+',\n} as const;\n\nexport type BalanceCategory =\n  (typeof BALANCE_CATEGORIES)[keyof typeof BALANCE_CATEGORIES];\n\nexport type Cohort = {\n  cohort: string;\n  eligibilityRate: number; // 0-1 probability of being assigned to this cohort\n  priority: number; // lower number = higher priority\n  eligible: boolean;\n};\n\nexport type SubscriptionEligibility = {\n  product: ProductType;\n  canSubscribe: boolean;\n  canViewEntryModal: boolean;\n  modalType?: ModalType;\n  cohorts: Cohort[];\n  assignedCohort: string | null;\n  hasAssignedCohortExpired: boolean;\n};\n\nexport const SubscriptionUserEvent = {\n  ShieldEntryModalViewed: 'shield_entry_modal_viewed',\n  ShieldCohortAssigned: 'shield_cohort_assigned',\n} as const;\n\nexport type SubscriptionUserEventType =\n  (typeof SubscriptionUserEvent)[keyof typeof SubscriptionUserEvent];\n\nexport type SubmitUserEventRequest = {\n  event: SubscriptionUserEventType;\n  cohort?: string;\n};\n\nexport type AssignCohortRequest = {\n  cohort: string;\n};\n\nexport type GetSubscriptionsEligibilitiesRequest = {\n  balanceCategory?: BalanceCategory;\n};\n\n/**\n * Request object for submitting sponsorship intents.\n */\nexport type SubmitSponsorshipIntentsRequest = {\n  chainId: Hex;\n  address: Hex;\n  products: ProductType[];\n  paymentTokenSymbol: string;\n  recurringInterval: RecurringInterval;\n  billingCycles: number;\n};\n\nexport type SubmitSponsorshipIntentsMethodParams = Pick<\n  SubmitSponsorshipIntentsRequest,\n  'chainId' | 'address' | 'products'\n>;\n\nexport type ISubscriptionService = {\n  getSubscriptions(): Promise<GetSubscriptionsResponse>;\n  getBenefits(): Promise<SubscriptionBenefitsResponse>;\n  cancelSubscription(request: CancelSubscriptionRequest): Promise<Subscription>;\n  unCancelSubscription(request: {\n    subscriptionId: string;\n  }): Promise<Subscription>;\n  /**\n   * Starts a card-paid subscription checkout session for the requested products\n   * (e.g. Shield or Money Account Plus).\n   *\n   * @param request - The start subscription request.\n   * @returns The checkout session response.\n   */\n  startSubscriptionWithCard(\n    request: StartSubscriptionRequest,\n  ): Promise<StartSubscriptionResponse>;\n  getBillingPortalUrl(): Promise<BillingPortalResponse>;\n  getPricing(): Promise<PricingResponse>;\n  startSubscriptionWithCrypto(\n    request: StartCryptoSubscriptionRequest,\n  ): Promise<StartCryptoSubscriptionResponse>;\n  updatePaymentMethodCard(\n    request: UpdatePaymentMethodCardRequest,\n  ): Promise<UpdatePaymentMethodCardResponse>;\n  updatePaymentMethodCrypto(\n    request: UpdatePaymentMethodCryptoRequest,\n  ): Promise<void>;\n  getSubscriptionsEligibilities(\n    request?: GetSubscriptionsEligibilitiesRequest,\n  ): Promise<SubscriptionEligibility[]>;\n  submitUserEvent(request: SubmitUserEventRequest): Promise<void>;\n  assignUserToCohort(request: AssignCohortRequest): Promise<void>;\n\n  /**\n   * Link rewards to a subscription.\n   */\n  linkRewards(\n    request: LinkRewardsRequest,\n  ): Promise<SubscriptionApiGeneralResponse>;\n\n  /**\n   * Submit sponsorship intents to the Subscription Service backend.\n   *\n   * This is intended to be used together with the crypto subscription flow.\n   * When the user has enabled the smart transaction feature, we will sponsor the gas fees for the subscription approval transaction.\n   *\n   * @param request - Request object containing the address and products.\n   * @example {\n   *   address: '0x1234567890123456789012345678901234567890',\n   *   products: [ProductType.Shield],\n   *   recurringInterval: RecurringInterval.Month,\n   *   billingCycles: 1,\n   * }\n   */\n  submitSponsorshipIntents(\n    request: SubmitSponsorshipIntentsRequest,\n  ): Promise<void>;\n};\n\nexport type UpdatePaymentMethodOpts =\n  | ({\n      paymentType: Extract<PaymentType, 'card'>;\n    } & UpdatePaymentMethodCardRequest)\n  | ({\n      paymentType: Extract<PaymentType, 'crypto'>;\n    } & UpdatePaymentMethodCryptoRequest);\n\nexport type UpdatePaymentMethodCardRequest = {\n  /**\n   * Subscription ID\n   */\n  subscriptionId: string;\n\n  /**\n   * Recurring interval\n   */\n  recurringInterval: RecurringInterval;\n  successUrl?: string;\n  cancelUrl?: string;\n};\n\nexport type UpdatePaymentMethodCardResponse = {\n  redirectUrl: string;\n};\n\ntype UpdatePaymentMethodCryptoRequestBase = {\n  subscriptionId: string;\n  chainId: Hex;\n  payerAddress: Hex;\n  tokenSymbol: string;\n  recurringInterval: RecurringInterval;\n  billingCycles: number;\n};\n\n/**\n * ERC-20 approval crypto payment-method update request.\n *\n * `rawTransaction` may be omitted when retrying after a balance top-up.\n */\nexport type UpdateErc20PaymentMethodCryptoRequest =\n  UpdatePaymentMethodCryptoRequestBase & {\n    cryptoAuthMethod?: typeof CRYPTO_AUTH_METHODS.ERC20_APPROVAL;\n    /**\n     * The raw transaction to pay for the subscription.\n     */\n    rawTransaction?: Hex;\n    delegationHash?: never;\n  };\n\n/**\n * Delegation crypto payment-method update request used to rotate an active\n * subscription to a replacement delegation.\n */\nexport type UpdateDelegationPaymentMethodCryptoRequest =\n  UpdatePaymentMethodCryptoRequestBase & {\n    cryptoAuthMethod: typeof CRYPTO_AUTH_METHODS.DELEGATION;\n    delegationHash: Hex;\n    rawTransaction?: never;\n  };\n\n/**\n * Request to update a subscription's crypto payment method.\n *\n * Provide `rawTransaction` for the existing ERC-20 approval path, or provide\n * `cryptoAuthMethod: 'delegation'` and `delegationHash` to rotate a delegation.\n */\nexport type UpdatePaymentMethodCryptoRequest =\n  | UpdateErc20PaymentMethodCryptoRequest\n  | UpdateDelegationPaymentMethodCryptoRequest;\n\nexport type BillingPortalResponse = {\n  url: string;\n};\n\n/**\n * The cached result of last selected payment methods for the user.\n * These details are being cached to be used internally to track the last selected payment method for the user. (e.g. for crypto subscriptions)\n */\nexport type CachedLastSelectedPaymentMethod = {\n  type: PaymentType;\n  paymentTokenAddress?: Hex;\n  paymentTokenSymbol?: string;\n  plan: RecurringInterval;\n  useTestClock?: boolean;\n  /**\n   * Crypto authorization method. Omitted on persisted cache entries written\n   * before this field existed; treat as `erc20_approval` when missing.\n   */\n  cryptoAuthMethod?: CryptoAuthMethod;\n};\n\n/**\n * Request to cache the last selected payment method for a product.\n */\nexport type CacheLastSelectedPaymentMethodRequest = {\n  /**\n   * The product to cache the payment method for.\n   */\n  product: ProductType;\n  /**\n   * The payment method to cache.\n   */\n  paymentMethod: CachedLastSelectedPaymentMethod;\n};\n\n/**\n * Request object for linking rewards to a subscription.\n */\nexport type LinkRewardsRequest = {\n  /**\n   * The ID of the reward subscription to be linked to the subscription.\n   *\n   * @example {\n   *   rewardAccountId: 'eip155:1:0x1234567890123456789012345678901234567890',\n   * }\n   */\n  rewardAccountId: CaipAccountId;\n};\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask/subscription-controller",
-  "version": "9.1.0",
+  "version": "10.0.1",
   "description": "Handle user subscription",
   "keywords": [
     "Ethereum",
@@ -50,7 +50,7 @@
     "test:watch": "NODE_OPTIONS=--experimental-vm-modules jest --watch"
   },
   "dependencies": {
-    "@metamask/authenticated-user-storage": "^4.0.0",
+    "@metamask/authenticated-user-storage": "^4.1.0",
     "@metamask/base-controller": "^10.0.0",
     "@metamask/base-data-service": "^2.0.0",
     "@metamask/chomp-api-service": "^5.0.0",
@@ -60,27 +60,27 @@
     "@metamask/delegation-deployments": "^1.4.0",
     "@metamask/messenger": "^3.0.0",
     "@metamask/money-account-balance-service": "^3.0.0",
-    "@metamask/money-account-utils": "^2.0.0",
+    "@metamask/money-account-utils": "^2.0.1",
     "@metamask/polling-controller": "^17.0.0",
-    "@metamask/profile-sync-controller": "^32.1.1",
+    "@metamask/profile-sync-controller": "^33.0.0",
     "@metamask/remote-feature-flag-controller": "^7.0.0",
     "@metamask/superstruct": "^3.4.1",
-    "@metamask/transaction-controller": "^70.1.0",
+    "@metamask/transaction-controller": "^72.0.0",
     "@metamask/utils": "^12.0.0",
-    "@tanstack/query-core": "^5.62.16",
+    "@tanstack/query-core": "^5.89.0",
     "bignumber.js": "^9.1.2",
     "fast-deep-equal": "^3.1.3"
   },
   "devDependencies": {
-    "@metamask/auto-changelog": "^6.1.0",
+    "@metamask/auto-changelog": "^6.2.1",
     "@types/jest": "^30.0.0",
     "@typescript/native": "npm:typescript@^7.0.2",
     "deepmerge": "^4.2.2",
     "jest": "^30.4.2",
     "jest-environment-node": "^30.4.1",
-    "rimraf": "^5.0.5",
-    "ts-jest": "^29.4.11",
-    "tsx": "^4.20.5",
+    "rimraf": "^6.1.3",
+    "ts-jest": "^29.4.12",
+    "tsx": "^4.23.15",
     "typedoc": "^0.25.13",
     "typedoc-plugin-missing-exports": "^2.0.0",
     "typescript": "npm:@typescript/typescript6@^6.0.2"