@metamask-previews/chain-agnostic-permission 0.1.0-preview-b69c669

package/dist/scope/assert.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"assert.cjs","sourceRoot":"","sources":["../../src/scope/assert.ts"],"names":[],"mappings":";;;AAAA,2CASyB;AAEzB,yCAAwC;AACxC,+CAIqB;AAYrB;;;;;;;;;GASG;AACI,MAAM,oBAAoB,GAAG,CAClC,WAAmB,EACnB,WAAkC,EAClC,EACE,qBAAqB,EACrB,sBAAsB,EACtB,yBAAyB,GAK1B,EACD,EAAE;IACF,MAAM,EAAE,OAAO,EAAE,aAAa,EAAE,GAAG,WAAW,CAAC;IAC/C,IACE,CAAC,IAAA,kCAAsB,EAAC,WAAW,EAAE;QACnC,qBAAqB;QACrB,sBAAsB;KACvB,CAAC,EACF;QACA,MAAM,qBAAY,CAAC,gCAAgC,EAAE,CAAC;KACvD;IAED,MAAM,mBAAmB,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE,EAAE,CACnD,IAAA,6BAAiB,EAAC,WAAW,EAAE,MAAM,EAAE,EAAE,yBAAyB,EAAE,CAAC,CACtE,CAAC;IAEF,IAAI,CAAC,mBAAmB,EAAE;QACxB,MAAM,qBAAY,CAAC,iCAAiC,EAAE,CAAC;KACxD;IAED,IACE,aAAa;QACb,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,YAAY,EAAE,EAAE,CACpC,IAAA,mCAAuB,EAAC,WAAW,EAAE,YAAY,CAAC,CACnD,EACD;QACA,MAAM,qBAAY,CAAC,uCAAuC,EAAE,CAAC;KAC9D;AACH,CAAC,CAAC;AAvCW,QAAA,oBAAoB,wBAuC/B;AAEF;;;;;;;;GAQG;AACI,MAAM,qBAAqB,GAAG,CACnC,MAA8B,EAC9B,EACE,qBAAqB,EACrB,sBAAsB,EACtB,yBAAyB,GAK1B,EACD,EAAE;IACF,KAAK,MAAM,CAAC,WAAW,EAAE,WAAW,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;QAC/D,IAAA,4BAAoB,EAAC,WAAW,EAAE,WAAW,EAAE;YAC7C,qBAAqB;YACrB,sBAAsB;YACtB,yBAAyB;SAC1B,CAAC,CAAC;KACJ;AACH,CAAC,CAAC;AAnBW,QAAA,qBAAqB,yBAmBhC;AACF;;;;GAIG;AACH,SAAS,2BAA2B,CAClC,GAAY;IAEZ,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,IAAI,EAAE;QAC3C,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;KAC1D;IAED,IAAI,IAAA,mBAAW,EAAC,GAAG,EAAE,YAAY,CAAC,EAAE;QAClC,IACE,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC;YAC9B,CAAC,GAAG,CAAC,UAAU,CAAC,KAAK,CAAC,uBAAe,CAAC,EACtC;YACA,MAAM,IAAI,KAAK,CACb,kEAAkE,CACnE,CAAC;SACH;KACF;IAED,IAAI,IAAA,mBAAW,EAAC,GAAG,EAAE,UAAU,CAAC,EAAE;QAChC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,uBAAe,CAAC,EAAE;YACxE,MAAM,IAAI,KAAK,CACb,gEAAgE,CACjE,CAAC;SACH;KACF;IAED,IAAI,IAAA,mBAAW,EAAC,GAAG,EAAE,SAAS,CAAC,EAAE;QAC/B,IACE,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC;YAC3B,CAAC,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,OAAO,MAAM,KAAK,QAAQ,CAAC,EAC1D;YACA,MAAM,IAAI,KAAK,CACb,yDAAyD,CAC1D,CAAC;SACH;KACF;IAED,IAAI,IAAA,mBAAW,EAAC,GAAG,EAAE,eAAe,CAAC,EAAE;QACrC,IACE,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC;YACjC,CAAC,GAAG,CAAC,aAAa,CAAC,KAAK,CACtB,CAAC,YAAY,EAAE,EAAE,CAAC,OAAO,YAAY,KAAK,QAAQ,CACnD,EACD;YACA,MAAM,IAAI,KAAK,CACb,+DAA+D,CAChE,CAAC;SACH;KACF;IAED,IAAI,IAAA,mBAAW,EAAC,GAAG,EAAE,cAAc,CAAC,EAAE;QACpC,IACE,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC;YAChC,CAAC,GAAG,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,OAAO,GAAG,KAAK,QAAQ,CAAC,EACzD;YACA,MAAM,IAAI,KAAK,CACb,8DAA8D,CAC/D,CAAC;SACH;KACF;IAED,IAAI,IAAA,mBAAW,EAAC,GAAG,EAAE,cAAc,CAAC,EAAE;QACpC,IACE,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC;YAChC,CAAC,GAAG,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,OAAO,QAAQ,KAAK,QAAQ,CAAC,EACnE;YACA,MAAM,IAAI,KAAK,CACb,8DAA8D,CAC/D,CAAC;SACH;KACF;AACH,CAAC;AAED;;;;GAIG;AACH,SAAS,2BAA2B,CAClC,WAAoB;IAEpB,IACE,OAAO,WAAW,KAAK,QAAQ;QAC/B,CAAC,CAAC,IAAA,uBAAe,EAAC,WAAW,CAAC,IAAI,CAAC,IAAA,qBAAa,EAAC,WAAW,CAAC,CAAC,EAC9D;QACA,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAC;KACnE;AACH,CAAC;AAED;;;;GAIG;AACH,SAAgB,4BAA4B,CAC1C,GAAY;IAEZ,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,IAAI,EAAE;QAC3C,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;KAC3D;IAED,KAAK,MAAM,CAAC,WAAW,EAAE,WAAW,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;QAC5D,2BAA2B,CAAC,WAAW,CAAC,CAAC;QACzC,2BAA2B,CAAC,WAAW,CAAC,CAAC;KAC1C;AACH,CAAC;AAXD,oEAWC;AAED;;;;GAIG;AACH,SAAS,2BAA2B,CAClC,GAAY;IAEZ,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,IAAI,EAAE;QAC3C,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;KAC1D;IAED,IACE,CAAC,IAAA,mBAAW,EAAC,GAAG,EAAE,UAAU,CAAC;QAC7B,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC;QAC5B,CAAC,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,uBAAe,CAAC,EACpC;QACA,MAAM,IAAI,KAAK,CACb,gEAAgE,CACjE,CAAC;KACH;AACH,CAAC;AAED;;;;GAIG;AACH,SAAgB,2BAA2B,CACzC,WAAoB;IAEpB,IACE,OAAO,WAAW,KAAK,QAAQ;QAC/B,4EAA4E;QAC5E,iEAAiE;QACjE,wEAAwE;QACxE,CAAC,WAAW,KAAK,0BAAkB,CAAC,MAAM,IAAI,CAAC,IAAA,qBAAa,EAAC,WAAW,CAAC,CAAC,EAC1E;QACA,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAC;KACnE;AACH,CAAC;AAZD,kEAYC;AAED;;;;GAIG;AACH,SAAgB,4BAA4B,CAC1C,GAAY;IAEZ,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,IAAI,EAAE;QAC3C,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;KAC3D;IAED,KAAK,MAAM,CAAC,WAAW,EAAE,WAAW,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;QAC5D,2BAA2B,CAAC,WAAW,CAAC,CAAC;QACzC,2BAA2B,CAAC,WAAW,CAAC,CAAC;KAC1C;AACH,CAAC;AAXD,oEAWC","sourcesContent":["import {\n  type CaipChainId,\n  hasProperty,\n  isCaipAccountId,\n  isCaipChainId,\n  isCaipNamespace,\n  isCaipReference,\n  KnownCaipNamespace,\n  type Hex,\n} from '@metamask/utils';\n\nimport { Caip25Errors } from './errors';\nimport {\n  isSupportedMethod,\n  isSupportedNotification,\n  isSupportedScopeString,\n} from './supported';\nimport type {\n  ExternalScopeObject,\n  ExternalScopesObject,\n  ExternalScopeString,\n  InternalScopeObject,\n  InternalScopesObject,\n  InternalScopeString,\n  NormalizedScopeObject,\n  NormalizedScopesObject,\n} from './types';\n\n/**\n * Asserts that a scope string and its associated scope object are supported.\n *\n * @param scopeString - The scope string against which to assert support.\n * @param scopeObject - The scope object against which to assert support.\n * @param hooks - An object containing the following properties:\n * @param hooks.isEvmChainIdSupported - A predicate that determines if an EVM chainID is supported.\n * @param hooks.isNonEvmScopeSupported - A predicate that determines if an non EVM scopeString is supported.\n * @param hooks.getNonEvmSupportedMethods - A function that returns the supported methods for a non EVM scope.\n */\nexport const assertScopeSupported = (\n  scopeString: string,\n  scopeObject: NormalizedScopeObject,\n  {\n    isEvmChainIdSupported,\n    isNonEvmScopeSupported,\n    getNonEvmSupportedMethods,\n  }: {\n    isEvmChainIdSupported: (chainId: Hex) => boolean;\n    isNonEvmScopeSupported: (scope: CaipChainId) => boolean;\n    getNonEvmSupportedMethods: (scope: CaipChainId) => string[];\n  },\n) => {\n  const { methods, notifications } = scopeObject;\n  if (\n    !isSupportedScopeString(scopeString, {\n      isEvmChainIdSupported,\n      isNonEvmScopeSupported,\n    })\n  ) {\n    throw Caip25Errors.requestedChainsNotSupportedError();\n  }\n\n  const allMethodsSupported = methods.every((method) =>\n    isSupportedMethod(scopeString, method, { getNonEvmSupportedMethods }),\n  );\n\n  if (!allMethodsSupported) {\n    throw Caip25Errors.requestedMethodsNotSupportedError();\n  }\n\n  if (\n    notifications &&\n    !notifications.every((notification) =>\n      isSupportedNotification(scopeString, notification),\n    )\n  ) {\n    throw Caip25Errors.requestedNotificationsNotSupportedError();\n  }\n};\n\n/**\n * Asserts that all scope strings and their associated scope objects are supported.\n *\n * @param scopes - The scopes object against which to assert support.\n * @param hooks - An object containing the following properties:\n * @param hooks.isEvmChainIdSupported - A predicate that determines if an EVM chainID is supported.\n * @param hooks.isNonEvmScopeSupported - A predicate that determines if an non EVM scopeString is supported.\n * @param hooks.getNonEvmSupportedMethods - A function that returns the supported methods for a non EVM scope.\n */\nexport const assertScopesSupported = (\n  scopes: NormalizedScopesObject,\n  {\n    isEvmChainIdSupported,\n    isNonEvmScopeSupported,\n    getNonEvmSupportedMethods,\n  }: {\n    isEvmChainIdSupported: (chainId: Hex) => boolean;\n    isNonEvmScopeSupported: (scope: CaipChainId) => boolean;\n    getNonEvmSupportedMethods: (scope: CaipChainId) => string[];\n  },\n) => {\n  for (const [scopeString, scopeObject] of Object.entries(scopes)) {\n    assertScopeSupported(scopeString, scopeObject, {\n      isEvmChainIdSupported,\n      isNonEvmScopeSupported,\n      getNonEvmSupportedMethods,\n    });\n  }\n};\n/**\n * Asserts that an object is a valid ExternalScopeObject.\n *\n * @param obj - The object to assert.\n */\nfunction assertIsExternalScopeObject(\n  obj: unknown,\n): asserts obj is ExternalScopeObject {\n  if (typeof obj !== 'object' || obj === null) {\n    throw new Error('ExternalScopeObject must be an object');\n  }\n\n  if (hasProperty(obj, 'references')) {\n    if (\n      !Array.isArray(obj.references) ||\n      !obj.references.every(isCaipReference)\n    ) {\n      throw new Error(\n        'ExternalScopeObject.references must be an array of CaipReference',\n      );\n    }\n  }\n\n  if (hasProperty(obj, 'accounts')) {\n    if (!Array.isArray(obj.accounts) || !obj.accounts.every(isCaipAccountId)) {\n      throw new Error(\n        'ExternalScopeObject.accounts must be an array of CaipAccountId',\n      );\n    }\n  }\n\n  if (hasProperty(obj, 'methods')) {\n    if (\n      !Array.isArray(obj.methods) ||\n      !obj.methods.every((method) => typeof method === 'string')\n    ) {\n      throw new Error(\n        'ExternalScopeObject.methods must be an array of strings',\n      );\n    }\n  }\n\n  if (hasProperty(obj, 'notifications')) {\n    if (\n      !Array.isArray(obj.notifications) ||\n      !obj.notifications.every(\n        (notification) => typeof notification === 'string',\n      )\n    ) {\n      throw new Error(\n        'ExternalScopeObject.notifications must be an array of strings',\n      );\n    }\n  }\n\n  if (hasProperty(obj, 'rpcDocuments')) {\n    if (\n      !Array.isArray(obj.rpcDocuments) ||\n      !obj.rpcDocuments.every((doc) => typeof doc === 'string')\n    ) {\n      throw new Error(\n        'ExternalScopeObject.rpcDocuments must be an array of strings',\n      );\n    }\n  }\n\n  if (hasProperty(obj, 'rpcEndpoints')) {\n    if (\n      !Array.isArray(obj.rpcEndpoints) ||\n      !obj.rpcEndpoints.every((endpoint) => typeof endpoint === 'string')\n    ) {\n      throw new Error(\n        'ExternalScopeObject.rpcEndpoints must be an array of strings',\n      );\n    }\n  }\n}\n\n/**\n * Asserts that a scope string is a valid ExternalScopeString.\n *\n * @param scopeString - The scope string to assert.\n */\nfunction assertIsExternalScopeString(\n  scopeString: unknown,\n): asserts scopeString is ExternalScopeString {\n  if (\n    typeof scopeString !== 'string' ||\n    (!isCaipNamespace(scopeString) && !isCaipChainId(scopeString))\n  ) {\n    throw new Error('scopeString is not a valid ExternalScopeString');\n  }\n}\n\n/**\n * Asserts that an object is a valid ExternalScopesObject.\n *\n * @param obj - The object to assert.\n */\nexport function assertIsExternalScopesObject(\n  obj: unknown,\n): asserts obj is ExternalScopesObject {\n  if (typeof obj !== 'object' || obj === null) {\n    throw new Error('ExternalScopesObject must be an object');\n  }\n\n  for (const [scopeString, scopeObject] of Object.entries(obj)) {\n    assertIsExternalScopeString(scopeString);\n    assertIsExternalScopeObject(scopeObject);\n  }\n}\n\n/**\n * Asserts that an object is a valid InternalScopeObject.\n *\n * @param obj - The object to assert.\n */\nfunction assertIsInternalScopeObject(\n  obj: unknown,\n): asserts obj is InternalScopeObject {\n  if (typeof obj !== 'object' || obj === null) {\n    throw new Error('InternalScopeObject must be an object');\n  }\n\n  if (\n    !hasProperty(obj, 'accounts') ||\n    !Array.isArray(obj.accounts) ||\n    !obj.accounts.every(isCaipAccountId)\n  ) {\n    throw new Error(\n      'InternalScopeObject.accounts must be an array of CaipAccountId',\n    );\n  }\n}\n\n/**\n * Asserts that a scope string is a valid InternalScopeString.\n *\n * @param scopeString - The scope string to assert.\n */\nexport function assertIsInternalScopeString(\n  scopeString: unknown,\n): asserts scopeString is InternalScopeString {\n  if (\n    typeof scopeString !== 'string' ||\n    // `InternalScopeString` is defined as either `KnownCaipNamespace.Wallet` or\n    // `CaipChainId`, so our conditions intentionally match the type.\n    // eslint-disable-next-line @typescript-eslint/no-unsafe-enum-comparison\n    (scopeString !== KnownCaipNamespace.Wallet && !isCaipChainId(scopeString))\n  ) {\n    throw new Error('scopeString is not a valid InternalScopeString');\n  }\n}\n\n/**\n * Asserts that an object is a valid InternalScopesObject.\n *\n * @param obj - The object to assert.\n */\nexport function assertIsInternalScopesObject(\n  obj: unknown,\n): asserts obj is InternalScopesObject {\n  if (typeof obj !== 'object' || obj === null) {\n    throw new Error('InternalScopesObject must be an object');\n  }\n\n  for (const [scopeString, scopeObject] of Object.entries(obj)) {\n    assertIsInternalScopeString(scopeString);\n    assertIsInternalScopeObject(scopeObject);\n  }\n}\n"]}

package/dist/scope/assert.d.cts

@@ -0,0 +1,50 @@
+import { type CaipChainId, type Hex } from "@metamask/utils";
+import type { ExternalScopesObject, InternalScopesObject, InternalScopeString, NormalizedScopeObject, NormalizedScopesObject } from "./types.cjs";
+/**
+ * Asserts that a scope string and its associated scope object are supported.
+ *
+ * @param scopeString - The scope string against which to assert support.
+ * @param scopeObject - The scope object against which to assert support.
+ * @param hooks - An object containing the following properties:
+ * @param hooks.isEvmChainIdSupported - A predicate that determines if an EVM chainID is supported.
+ * @param hooks.isNonEvmScopeSupported - A predicate that determines if an non EVM scopeString is supported.
+ * @param hooks.getNonEvmSupportedMethods - A function that returns the supported methods for a non EVM scope.
+ */
+export declare const assertScopeSupported: (scopeString: string, scopeObject: NormalizedScopeObject, { isEvmChainIdSupported, isNonEvmScopeSupported, getNonEvmSupportedMethods, }: {
+    isEvmChainIdSupported: (chainId: Hex) => boolean;
+    isNonEvmScopeSupported: (scope: CaipChainId) => boolean;
+    getNonEvmSupportedMethods: (scope: CaipChainId) => string[];
+}) => void;
+/**
+ * Asserts that all scope strings and their associated scope objects are supported.
+ *
+ * @param scopes - The scopes object against which to assert support.
+ * @param hooks - An object containing the following properties:
+ * @param hooks.isEvmChainIdSupported - A predicate that determines if an EVM chainID is supported.
+ * @param hooks.isNonEvmScopeSupported - A predicate that determines if an non EVM scopeString is supported.
+ * @param hooks.getNonEvmSupportedMethods - A function that returns the supported methods for a non EVM scope.
+ */
+export declare const assertScopesSupported: (scopes: NormalizedScopesObject, { isEvmChainIdSupported, isNonEvmScopeSupported, getNonEvmSupportedMethods, }: {
+    isEvmChainIdSupported: (chainId: Hex) => boolean;
+    isNonEvmScopeSupported: (scope: CaipChainId) => boolean;
+    getNonEvmSupportedMethods: (scope: CaipChainId) => string[];
+}) => void;
+/**
+ * Asserts that an object is a valid ExternalScopesObject.
+ *
+ * @param obj - The object to assert.
+ */
+export declare function assertIsExternalScopesObject(obj: unknown): asserts obj is ExternalScopesObject;
+/**
+ * Asserts that a scope string is a valid InternalScopeString.
+ *
+ * @param scopeString - The scope string to assert.
+ */
+export declare function assertIsInternalScopeString(scopeString: unknown): asserts scopeString is InternalScopeString;
+/**
+ * Asserts that an object is a valid InternalScopesObject.
+ *
+ * @param obj - The object to assert.
+ */
+export declare function assertIsInternalScopesObject(obj: unknown): asserts obj is InternalScopesObject;
+//# sourceMappingURL=assert.d.cts.map

package/dist/scope/assert.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"assert.d.cts","sourceRoot":"","sources":["../../src/scope/assert.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,WAAW,EAOhB,KAAK,GAAG,EACT,wBAAwB;AAQzB,OAAO,KAAK,EAEV,oBAAoB,EAGpB,oBAAoB,EACpB,mBAAmB,EACnB,qBAAqB,EACrB,sBAAsB,EACvB,oBAAgB;AAEjB;;;;;;;;;GASG;AACH,eAAO,MAAM,oBAAoB,gBAClB,MAAM,eACN,qBAAqB;qCAMC,GAAG,KAAK,OAAO;oCAChB,WAAW,KAAK,OAAO;uCACpB,WAAW,KAAK,MAAM,EAAE;UA6B9D,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,qBAAqB,WACxB,sBAAsB;qCAMK,GAAG,KAAK,OAAO;oCAChB,WAAW,KAAK,OAAO;uCACpB,WAAW,KAAK,MAAM,EAAE;UAU9D,CAAC;AA+FF;;;;GAIG;AACH,wBAAgB,4BAA4B,CAC1C,GAAG,EAAE,OAAO,GACX,OAAO,CAAC,GAAG,IAAI,oBAAoB,CASrC;AAyBD;;;;GAIG;AACH,wBAAgB,2BAA2B,CACzC,WAAW,EAAE,OAAO,GACnB,OAAO,CAAC,WAAW,IAAI,mBAAmB,CAU5C;AAED;;;;GAIG;AACH,wBAAgB,4BAA4B,CAC1C,GAAG,EAAE,OAAO,GACX,OAAO,CAAC,GAAG,IAAI,oBAAoB,CASrC"}

package/dist/scope/assert.d.mts

@@ -0,0 +1,50 @@
+import { type CaipChainId, type Hex } from "@metamask/utils";
+import type { ExternalScopesObject, InternalScopesObject, InternalScopeString, NormalizedScopeObject, NormalizedScopesObject } from "./types.mjs";
+/**
+ * Asserts that a scope string and its associated scope object are supported.
+ *
+ * @param scopeString - The scope string against which to assert support.
+ * @param scopeObject - The scope object against which to assert support.
+ * @param hooks - An object containing the following properties:
+ * @param hooks.isEvmChainIdSupported - A predicate that determines if an EVM chainID is supported.
+ * @param hooks.isNonEvmScopeSupported - A predicate that determines if an non EVM scopeString is supported.
+ * @param hooks.getNonEvmSupportedMethods - A function that returns the supported methods for a non EVM scope.
+ */
+export declare const assertScopeSupported: (scopeString: string, scopeObject: NormalizedScopeObject, { isEvmChainIdSupported, isNonEvmScopeSupported, getNonEvmSupportedMethods, }: {
+    isEvmChainIdSupported: (chainId: Hex) => boolean;
+    isNonEvmScopeSupported: (scope: CaipChainId) => boolean;
+    getNonEvmSupportedMethods: (scope: CaipChainId) => string[];
+}) => void;
+/**
+ * Asserts that all scope strings and their associated scope objects are supported.
+ *
+ * @param scopes - The scopes object against which to assert support.
+ * @param hooks - An object containing the following properties:
+ * @param hooks.isEvmChainIdSupported - A predicate that determines if an EVM chainID is supported.
+ * @param hooks.isNonEvmScopeSupported - A predicate that determines if an non EVM scopeString is supported.
+ * @param hooks.getNonEvmSupportedMethods - A function that returns the supported methods for a non EVM scope.
+ */
+export declare const assertScopesSupported: (scopes: NormalizedScopesObject, { isEvmChainIdSupported, isNonEvmScopeSupported, getNonEvmSupportedMethods, }: {
+    isEvmChainIdSupported: (chainId: Hex) => boolean;
+    isNonEvmScopeSupported: (scope: CaipChainId) => boolean;
+    getNonEvmSupportedMethods: (scope: CaipChainId) => string[];
+}) => void;
+/**
+ * Asserts that an object is a valid ExternalScopesObject.
+ *
+ * @param obj - The object to assert.
+ */
+export declare function assertIsExternalScopesObject(obj: unknown): asserts obj is ExternalScopesObject;
+/**
+ * Asserts that a scope string is a valid InternalScopeString.
+ *
+ * @param scopeString - The scope string to assert.
+ */
+export declare function assertIsInternalScopeString(scopeString: unknown): asserts scopeString is InternalScopeString;
+/**
+ * Asserts that an object is a valid InternalScopesObject.
+ *
+ * @param obj - The object to assert.
+ */
+export declare function assertIsInternalScopesObject(obj: unknown): asserts obj is InternalScopesObject;
+//# sourceMappingURL=assert.d.mts.map

package/dist/scope/assert.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"assert.d.mts","sourceRoot":"","sources":["../../src/scope/assert.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,WAAW,EAOhB,KAAK,GAAG,EACT,wBAAwB;AAQzB,OAAO,KAAK,EAEV,oBAAoB,EAGpB,oBAAoB,EACpB,mBAAmB,EACnB,qBAAqB,EACrB,sBAAsB,EACvB,oBAAgB;AAEjB;;;;;;;;;GASG;AACH,eAAO,MAAM,oBAAoB,gBAClB,MAAM,eACN,qBAAqB;qCAMC,GAAG,KAAK,OAAO;oCAChB,WAAW,KAAK,OAAO;uCACpB,WAAW,KAAK,MAAM,EAAE;UA6B9D,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,qBAAqB,WACxB,sBAAsB;qCAMK,GAAG,KAAK,OAAO;oCAChB,WAAW,KAAK,OAAO;uCACpB,WAAW,KAAK,MAAM,EAAE;UAU9D,CAAC;AA+FF;;;;GAIG;AACH,wBAAgB,4BAA4B,CAC1C,GAAG,EAAE,OAAO,GACX,OAAO,CAAC,GAAG,IAAI,oBAAoB,CASrC;AAyBD;;;;GAIG;AACH,wBAAgB,2BAA2B,CACzC,WAAW,EAAE,OAAO,GACnB,OAAO,CAAC,WAAW,IAAI,mBAAmB,CAU5C;AAED;;;;GAIG;AACH,wBAAgB,4BAA4B,CAC1C,GAAG,EAAE,OAAO,GACX,OAAO,CAAC,GAAG,IAAI,oBAAoB,CASrC"}

package/dist/scope/assert.mjs

@@ -0,0 +1,162 @@
+import { hasProperty, isCaipAccountId, isCaipChainId, isCaipNamespace, isCaipReference, KnownCaipNamespace } from "@metamask/utils";
+import { Caip25Errors } from "./errors.mjs";
+import { isSupportedMethod, isSupportedNotification, isSupportedScopeString } from "./supported.mjs";
+/**
+ * Asserts that a scope string and its associated scope object are supported.
+ *
+ * @param scopeString - The scope string against which to assert support.
+ * @param scopeObject - The scope object against which to assert support.
+ * @param hooks - An object containing the following properties:
+ * @param hooks.isEvmChainIdSupported - A predicate that determines if an EVM chainID is supported.
+ * @param hooks.isNonEvmScopeSupported - A predicate that determines if an non EVM scopeString is supported.
+ * @param hooks.getNonEvmSupportedMethods - A function that returns the supported methods for a non EVM scope.
+ */
+export const assertScopeSupported = (scopeString, scopeObject, { isEvmChainIdSupported, isNonEvmScopeSupported, getNonEvmSupportedMethods, }) => {
+    const { methods, notifications } = scopeObject;
+    if (!isSupportedScopeString(scopeString, {
+        isEvmChainIdSupported,
+        isNonEvmScopeSupported,
+    })) {
+        throw Caip25Errors.requestedChainsNotSupportedError();
+    }
+    const allMethodsSupported = methods.every((method) => isSupportedMethod(scopeString, method, { getNonEvmSupportedMethods }));
+    if (!allMethodsSupported) {
+        throw Caip25Errors.requestedMethodsNotSupportedError();
+    }
+    if (notifications &&
+        !notifications.every((notification) => isSupportedNotification(scopeString, notification))) {
+        throw Caip25Errors.requestedNotificationsNotSupportedError();
+    }
+};
+/**
+ * Asserts that all scope strings and their associated scope objects are supported.
+ *
+ * @param scopes - The scopes object against which to assert support.
+ * @param hooks - An object containing the following properties:
+ * @param hooks.isEvmChainIdSupported - A predicate that determines if an EVM chainID is supported.
+ * @param hooks.isNonEvmScopeSupported - A predicate that determines if an non EVM scopeString is supported.
+ * @param hooks.getNonEvmSupportedMethods - A function that returns the supported methods for a non EVM scope.
+ */
+export const assertScopesSupported = (scopes, { isEvmChainIdSupported, isNonEvmScopeSupported, getNonEvmSupportedMethods, }) => {
+    for (const [scopeString, scopeObject] of Object.entries(scopes)) {
+        assertScopeSupported(scopeString, scopeObject, {
+            isEvmChainIdSupported,
+            isNonEvmScopeSupported,
+            getNonEvmSupportedMethods,
+        });
+    }
+};
+/**
+ * Asserts that an object is a valid ExternalScopeObject.
+ *
+ * @param obj - The object to assert.
+ */
+function assertIsExternalScopeObject(obj) {
+    if (typeof obj !== 'object' || obj === null) {
+        throw new Error('ExternalScopeObject must be an object');
+    }
+    if (hasProperty(obj, 'references')) {
+        if (!Array.isArray(obj.references) ||
+            !obj.references.every(isCaipReference)) {
+            throw new Error('ExternalScopeObject.references must be an array of CaipReference');
+        }
+    }
+    if (hasProperty(obj, 'accounts')) {
+        if (!Array.isArray(obj.accounts) || !obj.accounts.every(isCaipAccountId)) {
+            throw new Error('ExternalScopeObject.accounts must be an array of CaipAccountId');
+        }
+    }
+    if (hasProperty(obj, 'methods')) {
+        if (!Array.isArray(obj.methods) ||
+            !obj.methods.every((method) => typeof method === 'string')) {
+            throw new Error('ExternalScopeObject.methods must be an array of strings');
+        }
+    }
+    if (hasProperty(obj, 'notifications')) {
+        if (!Array.isArray(obj.notifications) ||
+            !obj.notifications.every((notification) => typeof notification === 'string')) {
+            throw new Error('ExternalScopeObject.notifications must be an array of strings');
+        }
+    }
+    if (hasProperty(obj, 'rpcDocuments')) {
+        if (!Array.isArray(obj.rpcDocuments) ||
+            !obj.rpcDocuments.every((doc) => typeof doc === 'string')) {
+            throw new Error('ExternalScopeObject.rpcDocuments must be an array of strings');
+        }
+    }
+    if (hasProperty(obj, 'rpcEndpoints')) {
+        if (!Array.isArray(obj.rpcEndpoints) ||
+            !obj.rpcEndpoints.every((endpoint) => typeof endpoint === 'string')) {
+            throw new Error('ExternalScopeObject.rpcEndpoints must be an array of strings');
+        }
+    }
+}
+/**
+ * Asserts that a scope string is a valid ExternalScopeString.
+ *
+ * @param scopeString - The scope string to assert.
+ */
+function assertIsExternalScopeString(scopeString) {
+    if (typeof scopeString !== 'string' ||
+        (!isCaipNamespace(scopeString) && !isCaipChainId(scopeString))) {
+        throw new Error('scopeString is not a valid ExternalScopeString');
+    }
+}
+/**
+ * Asserts that an object is a valid ExternalScopesObject.
+ *
+ * @param obj - The object to assert.
+ */
+export function assertIsExternalScopesObject(obj) {
+    if (typeof obj !== 'object' || obj === null) {
+        throw new Error('ExternalScopesObject must be an object');
+    }
+    for (const [scopeString, scopeObject] of Object.entries(obj)) {
+        assertIsExternalScopeString(scopeString);
+        assertIsExternalScopeObject(scopeObject);
+    }
+}
+/**
+ * Asserts that an object is a valid InternalScopeObject.
+ *
+ * @param obj - The object to assert.
+ */
+function assertIsInternalScopeObject(obj) {
+    if (typeof obj !== 'object' || obj === null) {
+        throw new Error('InternalScopeObject must be an object');
+    }
+    if (!hasProperty(obj, 'accounts') ||
+        !Array.isArray(obj.accounts) ||
+        !obj.accounts.every(isCaipAccountId)) {
+        throw new Error('InternalScopeObject.accounts must be an array of CaipAccountId');
+    }
+}
+/**
+ * Asserts that a scope string is a valid InternalScopeString.
+ *
+ * @param scopeString - The scope string to assert.
+ */
+export function assertIsInternalScopeString(scopeString) {
+    if (typeof scopeString !== 'string' ||
+        // `InternalScopeString` is defined as either `KnownCaipNamespace.Wallet` or
+        // `CaipChainId`, so our conditions intentionally match the type.
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-enum-comparison
+        (scopeString !== KnownCaipNamespace.Wallet && !isCaipChainId(scopeString))) {
+        throw new Error('scopeString is not a valid InternalScopeString');
+    }
+}
+/**
+ * Asserts that an object is a valid InternalScopesObject.
+ *
+ * @param obj - The object to assert.
+ */
+export function assertIsInternalScopesObject(obj) {
+    if (typeof obj !== 'object' || obj === null) {
+        throw new Error('InternalScopesObject must be an object');
+    }
+    for (const [scopeString, scopeObject] of Object.entries(obj)) {
+        assertIsInternalScopeString(scopeString);
+        assertIsInternalScopeObject(scopeObject);
+    }
+}
+//# sourceMappingURL=assert.mjs.map

package/dist/scope/assert.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"assert.mjs","sourceRoot":"","sources":["../../src/scope/assert.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,WAAW,EACX,eAAe,EACf,aAAa,EACb,eAAe,EACf,eAAe,EACf,kBAAkB,EAEnB,wBAAwB;AAEzB,OAAO,EAAE,YAAY,EAAE,qBAAiB;AACxC,OAAO,EACL,iBAAiB,EACjB,uBAAuB,EACvB,sBAAsB,EACvB,wBAAoB;AAYrB;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAClC,WAAmB,EACnB,WAAkC,EAClC,EACE,qBAAqB,EACrB,sBAAsB,EACtB,yBAAyB,GAK1B,EACD,EAAE;IACF,MAAM,EAAE,OAAO,EAAE,aAAa,EAAE,GAAG,WAAW,CAAC;IAC/C,IACE,CAAC,sBAAsB,CAAC,WAAW,EAAE;QACnC,qBAAqB;QACrB,sBAAsB;KACvB,CAAC,EACF;QACA,MAAM,YAAY,CAAC,gCAAgC,EAAE,CAAC;KACvD;IAED,MAAM,mBAAmB,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE,EAAE,CACnD,iBAAiB,CAAC,WAAW,EAAE,MAAM,EAAE,EAAE,yBAAyB,EAAE,CAAC,CACtE,CAAC;IAEF,IAAI,CAAC,mBAAmB,EAAE;QACxB,MAAM,YAAY,CAAC,iCAAiC,EAAE,CAAC;KACxD;IAED,IACE,aAAa;QACb,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,YAAY,EAAE,EAAE,CACpC,uBAAuB,CAAC,WAAW,EAAE,YAAY,CAAC,CACnD,EACD;QACA,MAAM,YAAY,CAAC,uCAAuC,EAAE,CAAC;KAC9D;AACH,CAAC,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CACnC,MAA8B,EAC9B,EACE,qBAAqB,EACrB,sBAAsB,EACtB,yBAAyB,GAK1B,EACD,EAAE;IACF,KAAK,MAAM,CAAC,WAAW,EAAE,WAAW,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;QAC/D,oBAAoB,CAAC,WAAW,EAAE,WAAW,EAAE;YAC7C,qBAAqB;YACrB,sBAAsB;YACtB,yBAAyB;SAC1B,CAAC,CAAC;KACJ;AACH,CAAC,CAAC;AACF;;;;GAIG;AACH,SAAS,2BAA2B,CAClC,GAAY;IAEZ,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,IAAI,EAAE;QAC3C,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;KAC1D;IAED,IAAI,WAAW,CAAC,GAAG,EAAE,YAAY,CAAC,EAAE;QAClC,IACE,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC;YAC9B,CAAC,GAAG,CAAC,UAAU,CAAC,KAAK,CAAC,eAAe,CAAC,EACtC;YACA,MAAM,IAAI,KAAK,CACb,kEAAkE,CACnE,CAAC;SACH;KACF;IAED,IAAI,WAAW,CAAC,GAAG,EAAE,UAAU,CAAC,EAAE;QAChC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,eAAe,CAAC,EAAE;YACxE,MAAM,IAAI,KAAK,CACb,gEAAgE,CACjE,CAAC;SACH;KACF;IAED,IAAI,WAAW,CAAC,GAAG,EAAE,SAAS,CAAC,EAAE;QAC/B,IACE,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC;YAC3B,CAAC,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,OAAO,MAAM,KAAK,QAAQ,CAAC,EAC1D;YACA,MAAM,IAAI,KAAK,CACb,yDAAyD,CAC1D,CAAC;SACH;KACF;IAED,IAAI,WAAW,CAAC,GAAG,EAAE,eAAe,CAAC,EAAE;QACrC,IACE,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC;YACjC,CAAC,GAAG,CAAC,aAAa,CAAC,KAAK,CACtB,CAAC,YAAY,EAAE,EAAE,CAAC,OAAO,YAAY,KAAK,QAAQ,CACnD,EACD;YACA,MAAM,IAAI,KAAK,CACb,+DAA+D,CAChE,CAAC;SACH;KACF;IAED,IAAI,WAAW,CAAC,GAAG,EAAE,cAAc,CAAC,EAAE;QACpC,IACE,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC;YAChC,CAAC,GAAG,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,OAAO,GAAG,KAAK,QAAQ,CAAC,EACzD;YACA,MAAM,IAAI,KAAK,CACb,8DAA8D,CAC/D,CAAC;SACH;KACF;IAED,IAAI,WAAW,CAAC,GAAG,EAAE,cAAc,CAAC,EAAE;QACpC,IACE,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC;YAChC,CAAC,GAAG,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,OAAO,QAAQ,KAAK,QAAQ,CAAC,EACnE;YACA,MAAM,IAAI,KAAK,CACb,8DAA8D,CAC/D,CAAC;SACH;KACF;AACH,CAAC;AAED;;;;GAIG;AACH,SAAS,2BAA2B,CAClC,WAAoB;IAEpB,IACE,OAAO,WAAW,KAAK,QAAQ;QAC/B,CAAC,CAAC,eAAe,CAAC,WAAW,CAAC,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC,EAC9D;QACA,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAC;KACnE;AACH,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,4BAA4B,CAC1C,GAAY;IAEZ,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,IAAI,EAAE;QAC3C,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;KAC3D;IAED,KAAK,MAAM,CAAC,WAAW,EAAE,WAAW,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;QAC5D,2BAA2B,CAAC,WAAW,CAAC,CAAC;QACzC,2BAA2B,CAAC,WAAW,CAAC,CAAC;KAC1C;AACH,CAAC;AAED;;;;GAIG;AACH,SAAS,2BAA2B,CAClC,GAAY;IAEZ,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,IAAI,EAAE;QAC3C,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;KAC1D;IAED,IACE,CAAC,WAAW,CAAC,GAAG,EAAE,UAAU,CAAC;QAC7B,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC;QAC5B,CAAC,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,eAAe,CAAC,EACpC;QACA,MAAM,IAAI,KAAK,CACb,gEAAgE,CACjE,CAAC;KACH;AACH,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,2BAA2B,CACzC,WAAoB;IAEpB,IACE,OAAO,WAAW,KAAK,QAAQ;QAC/B,4EAA4E;QAC5E,iEAAiE;QACjE,wEAAwE;QACxE,CAAC,WAAW,KAAK,kBAAkB,CAAC,MAAM,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC,EAC1E;QACA,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAC;KACnE;AACH,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,4BAA4B,CAC1C,GAAY;IAEZ,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,IAAI,EAAE;QAC3C,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;KAC3D;IAED,KAAK,MAAM,CAAC,WAAW,EAAE,WAAW,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;QAC5D,2BAA2B,CAAC,WAAW,CAAC,CAAC;QACzC,2BAA2B,CAAC,WAAW,CAAC,CAAC;KAC1C;AACH,CAAC","sourcesContent":["import {\n  type CaipChainId,\n  hasProperty,\n  isCaipAccountId,\n  isCaipChainId,\n  isCaipNamespace,\n  isCaipReference,\n  KnownCaipNamespace,\n  type Hex,\n} from '@metamask/utils';\n\nimport { Caip25Errors } from './errors';\nimport {\n  isSupportedMethod,\n  isSupportedNotification,\n  isSupportedScopeString,\n} from './supported';\nimport type {\n  ExternalScopeObject,\n  ExternalScopesObject,\n  ExternalScopeString,\n  InternalScopeObject,\n  InternalScopesObject,\n  InternalScopeString,\n  NormalizedScopeObject,\n  NormalizedScopesObject,\n} from './types';\n\n/**\n * Asserts that a scope string and its associated scope object are supported.\n *\n * @param scopeString - The scope string against which to assert support.\n * @param scopeObject - The scope object against which to assert support.\n * @param hooks - An object containing the following properties:\n * @param hooks.isEvmChainIdSupported - A predicate that determines if an EVM chainID is supported.\n * @param hooks.isNonEvmScopeSupported - A predicate that determines if an non EVM scopeString is supported.\n * @param hooks.getNonEvmSupportedMethods - A function that returns the supported methods for a non EVM scope.\n */\nexport const assertScopeSupported = (\n  scopeString: string,\n  scopeObject: NormalizedScopeObject,\n  {\n    isEvmChainIdSupported,\n    isNonEvmScopeSupported,\n    getNonEvmSupportedMethods,\n  }: {\n    isEvmChainIdSupported: (chainId: Hex) => boolean;\n    isNonEvmScopeSupported: (scope: CaipChainId) => boolean;\n    getNonEvmSupportedMethods: (scope: CaipChainId) => string[];\n  },\n) => {\n  const { methods, notifications } = scopeObject;\n  if (\n    !isSupportedScopeString(scopeString, {\n      isEvmChainIdSupported,\n      isNonEvmScopeSupported,\n    })\n  ) {\n    throw Caip25Errors.requestedChainsNotSupportedError();\n  }\n\n  const allMethodsSupported = methods.every((method) =>\n    isSupportedMethod(scopeString, method, { getNonEvmSupportedMethods }),\n  );\n\n  if (!allMethodsSupported) {\n    throw Caip25Errors.requestedMethodsNotSupportedError();\n  }\n\n  if (\n    notifications &&\n    !notifications.every((notification) =>\n      isSupportedNotification(scopeString, notification),\n    )\n  ) {\n    throw Caip25Errors.requestedNotificationsNotSupportedError();\n  }\n};\n\n/**\n * Asserts that all scope strings and their associated scope objects are supported.\n *\n * @param scopes - The scopes object against which to assert support.\n * @param hooks - An object containing the following properties:\n * @param hooks.isEvmChainIdSupported - A predicate that determines if an EVM chainID is supported.\n * @param hooks.isNonEvmScopeSupported - A predicate that determines if an non EVM scopeString is supported.\n * @param hooks.getNonEvmSupportedMethods - A function that returns the supported methods for a non EVM scope.\n */\nexport const assertScopesSupported = (\n  scopes: NormalizedScopesObject,\n  {\n    isEvmChainIdSupported,\n    isNonEvmScopeSupported,\n    getNonEvmSupportedMethods,\n  }: {\n    isEvmChainIdSupported: (chainId: Hex) => boolean;\n    isNonEvmScopeSupported: (scope: CaipChainId) => boolean;\n    getNonEvmSupportedMethods: (scope: CaipChainId) => string[];\n  },\n) => {\n  for (const [scopeString, scopeObject] of Object.entries(scopes)) {\n    assertScopeSupported(scopeString, scopeObject, {\n      isEvmChainIdSupported,\n      isNonEvmScopeSupported,\n      getNonEvmSupportedMethods,\n    });\n  }\n};\n/**\n * Asserts that an object is a valid ExternalScopeObject.\n *\n * @param obj - The object to assert.\n */\nfunction assertIsExternalScopeObject(\n  obj: unknown,\n): asserts obj is ExternalScopeObject {\n  if (typeof obj !== 'object' || obj === null) {\n    throw new Error('ExternalScopeObject must be an object');\n  }\n\n  if (hasProperty(obj, 'references')) {\n    if (\n      !Array.isArray(obj.references) ||\n      !obj.references.every(isCaipReference)\n    ) {\n      throw new Error(\n        'ExternalScopeObject.references must be an array of CaipReference',\n      );\n    }\n  }\n\n  if (hasProperty(obj, 'accounts')) {\n    if (!Array.isArray(obj.accounts) || !obj.accounts.every(isCaipAccountId)) {\n      throw new Error(\n        'ExternalScopeObject.accounts must be an array of CaipAccountId',\n      );\n    }\n  }\n\n  if (hasProperty(obj, 'methods')) {\n    if (\n      !Array.isArray(obj.methods) ||\n      !obj.methods.every((method) => typeof method === 'string')\n    ) {\n      throw new Error(\n        'ExternalScopeObject.methods must be an array of strings',\n      );\n    }\n  }\n\n  if (hasProperty(obj, 'notifications')) {\n    if (\n      !Array.isArray(obj.notifications) ||\n      !obj.notifications.every(\n        (notification) => typeof notification === 'string',\n      )\n    ) {\n      throw new Error(\n        'ExternalScopeObject.notifications must be an array of strings',\n      );\n    }\n  }\n\n  if (hasProperty(obj, 'rpcDocuments')) {\n    if (\n      !Array.isArray(obj.rpcDocuments) ||\n      !obj.rpcDocuments.every((doc) => typeof doc === 'string')\n    ) {\n      throw new Error(\n        'ExternalScopeObject.rpcDocuments must be an array of strings',\n      );\n    }\n  }\n\n  if (hasProperty(obj, 'rpcEndpoints')) {\n    if (\n      !Array.isArray(obj.rpcEndpoints) ||\n      !obj.rpcEndpoints.every((endpoint) => typeof endpoint === 'string')\n    ) {\n      throw new Error(\n        'ExternalScopeObject.rpcEndpoints must be an array of strings',\n      );\n    }\n  }\n}\n\n/**\n * Asserts that a scope string is a valid ExternalScopeString.\n *\n * @param scopeString - The scope string to assert.\n */\nfunction assertIsExternalScopeString(\n  scopeString: unknown,\n): asserts scopeString is ExternalScopeString {\n  if (\n    typeof scopeString !== 'string' ||\n    (!isCaipNamespace(scopeString) && !isCaipChainId(scopeString))\n  ) {\n    throw new Error('scopeString is not a valid ExternalScopeString');\n  }\n}\n\n/**\n * Asserts that an object is a valid ExternalScopesObject.\n *\n * @param obj - The object to assert.\n */\nexport function assertIsExternalScopesObject(\n  obj: unknown,\n): asserts obj is ExternalScopesObject {\n  if (typeof obj !== 'object' || obj === null) {\n    throw new Error('ExternalScopesObject must be an object');\n  }\n\n  for (const [scopeString, scopeObject] of Object.entries(obj)) {\n    assertIsExternalScopeString(scopeString);\n    assertIsExternalScopeObject(scopeObject);\n  }\n}\n\n/**\n * Asserts that an object is a valid InternalScopeObject.\n *\n * @param obj - The object to assert.\n */\nfunction assertIsInternalScopeObject(\n  obj: unknown,\n): asserts obj is InternalScopeObject {\n  if (typeof obj !== 'object' || obj === null) {\n    throw new Error('InternalScopeObject must be an object');\n  }\n\n  if (\n    !hasProperty(obj, 'accounts') ||\n    !Array.isArray(obj.accounts) ||\n    !obj.accounts.every(isCaipAccountId)\n  ) {\n    throw new Error(\n      'InternalScopeObject.accounts must be an array of CaipAccountId',\n    );\n  }\n}\n\n/**\n * Asserts that a scope string is a valid InternalScopeString.\n *\n * @param scopeString - The scope string to assert.\n */\nexport function assertIsInternalScopeString(\n  scopeString: unknown,\n): asserts scopeString is InternalScopeString {\n  if (\n    typeof scopeString !== 'string' ||\n    // `InternalScopeString` is defined as either `KnownCaipNamespace.Wallet` or\n    // `CaipChainId`, so our conditions intentionally match the type.\n    // eslint-disable-next-line @typescript-eslint/no-unsafe-enum-comparison\n    (scopeString !== KnownCaipNamespace.Wallet && !isCaipChainId(scopeString))\n  ) {\n    throw new Error('scopeString is not a valid InternalScopeString');\n  }\n}\n\n/**\n * Asserts that an object is a valid InternalScopesObject.\n *\n * @param obj - The object to assert.\n */\nexport function assertIsInternalScopesObject(\n  obj: unknown,\n): asserts obj is InternalScopesObject {\n  if (typeof obj !== 'object' || obj === null) {\n    throw new Error('InternalScopesObject must be an object');\n  }\n\n  for (const [scopeString, scopeObject] of Object.entries(obj)) {\n    assertIsInternalScopeString(scopeString);\n    assertIsInternalScopeObject(scopeObject);\n  }\n}\n"]}

package/dist/scope/authorization.cjs

@@ -0,0 +1,51 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.bucketScopes = exports.validateAndNormalizeScopes = void 0;
+const filter_1 = require("./filter.cjs");
+const transform_1 = require("./transform.cjs");
+const validation_1 = require("./validation.cjs");
+/**
+ * Validates and normalizes a set of scopes according to the [CAIP-217](https://chainagnostic.org/CAIPs/caip-217) spec.
+ *
+ * @param requiredScopes - The required scopes to validate and normalize.
+ * @param optionalScopes - The optional scopes to validate and normalize.
+ * @returns An object containing the normalized required scopes and normalized optional scopes.
+ */
+const validateAndNormalizeScopes = (requiredScopes, optionalScopes) => {
+    const { validRequiredScopes, validOptionalScopes } = (0, validation_1.getValidScopes)(requiredScopes, optionalScopes);
+    const normalizedRequiredScopes = (0, transform_1.normalizeAndMergeScopes)(validRequiredScopes);
+    const normalizedOptionalScopes = (0, transform_1.normalizeAndMergeScopes)(validOptionalScopes);
+    return {
+        normalizedRequiredScopes,
+        normalizedOptionalScopes,
+    };
+};
+exports.validateAndNormalizeScopes = validateAndNormalizeScopes;
+/**
+ * Groups a NormalizedScopesObject into three separate
+ * NormalizedScopesObjects for supported scopes,
+ * supportable scopes, and unsupportable scopes.
+ *
+ * @param scopes - The NormalizedScopesObject to group.
+ * @param hooks - The hooks.
+ * @param hooks.isEvmChainIdSupported - A helper that returns true if an eth chainId is currently supported by the wallet.
+ * @param hooks.isEvmChainIdSupportable - A helper that returns true if an eth chainId could be supported by the wallet.
+ * @param hooks.isNonEvmScopeSupported - A predicate that determines if an non EVM scopeString is supported.
+ * @param hooks.getNonEvmSupportedMethods - A function that returns the supported methods for a non EVM scope.
+ * @returns an object with three NormalizedScopesObjects separated by support.
+ */
+const bucketScopes = (scopes, { isEvmChainIdSupported, isEvmChainIdSupportable, isNonEvmScopeSupported, getNonEvmSupportedMethods, }) => {
+    const { supportedScopes, unsupportedScopes: maybeSupportableScopes } = (0, filter_1.bucketScopesBySupport)(scopes, {
+        isEvmChainIdSupported,
+        isNonEvmScopeSupported,
+        getNonEvmSupportedMethods,
+    });
+    const { supportedScopes: supportableScopes, unsupportedScopes: unsupportableScopes, } = (0, filter_1.bucketScopesBySupport)(maybeSupportableScopes, {
+        isEvmChainIdSupported: isEvmChainIdSupportable,
+        isNonEvmScopeSupported,
+        getNonEvmSupportedMethods,
+    });
+    return { supportedScopes, supportableScopes, unsupportableScopes };
+};
+exports.bucketScopes = bucketScopes;
+//# sourceMappingURL=authorization.cjs.map

package/dist/scope/authorization.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"authorization.cjs","sourceRoot":"","sources":["../../src/scope/authorization.ts"],"names":[],"mappings":";;;AAEA,yCAAiD;AACjD,+CAAsD;AAMtD,iDAA8C;AAmB9C;;;;;;GAMG;AACI,MAAM,0BAA0B,GAAG,CACxC,cAAoC,EACpC,cAAoC,EAIpC,EAAE;IACF,MAAM,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,GAAG,IAAA,2BAAc,EACjE,cAAc,EACd,cAAc,CACf,CAAC;IAEF,MAAM,wBAAwB,GAAG,IAAA,mCAAuB,EAAC,mBAAmB,CAAC,CAAC;IAC9E,MAAM,wBAAwB,GAAG,IAAA,mCAAuB,EAAC,mBAAmB,CAAC,CAAC;IAE9E,OAAO;QACL,wBAAwB;QACxB,wBAAwB;KACzB,CAAC;AACJ,CAAC,CAAC;AAnBW,QAAA,0BAA0B,8BAmBrC;AAEF;;;;;;;;;;;;GAYG;AACI,MAAM,YAAY,GAAG,CAC1B,MAA8B,EAC9B,EACE,qBAAqB,EACrB,uBAAuB,EACvB,sBAAsB,EACtB,yBAAyB,GAM1B,EAKD,EAAE;IACF,MAAM,EAAE,eAAe,EAAE,iBAAiB,EAAE,sBAAsB,EAAE,GAClE,IAAA,8BAAqB,EAAC,MAAM,EAAE;QAC5B,qBAAqB;QACrB,sBAAsB;QACtB,yBAAyB;KAC1B,CAAC,CAAC;IAEL,MAAM,EACJ,eAAe,EAAE,iBAAiB,EAClC,iBAAiB,EAAE,mBAAmB,GACvC,GAAG,IAAA,8BAAqB,EAAC,sBAAsB,EAAE;QAChD,qBAAqB,EAAE,uBAAuB;QAC9C,sBAAsB;QACtB,yBAAyB;KAC1B,CAAC,CAAC;IAEH,OAAO,EAAE,eAAe,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,CAAC;AACrE,CAAC,CAAC;AAnCW,QAAA,YAAY,gBAmCvB","sourcesContent":["import type { CaipChainId, Hex, Json } from '@metamask/utils';\n\nimport { bucketScopesBySupport } from './filter';\nimport { normalizeAndMergeScopes } from './transform';\nimport type {\n  ExternalScopesObject,\n  ExternalScopeString,\n  NormalizedScopesObject,\n} from './types';\nimport { getValidScopes } from './validation';\n\n/**\n * Represents the parameters of a [CAIP-25](https://chainagnostic.org/CAIPs/caip-25) request.\n */\nexport type Caip25Authorization = (\n  | {\n      requiredScopes: ExternalScopesObject;\n      optionalScopes?: ExternalScopesObject;\n    }\n  | {\n      requiredScopes?: ExternalScopesObject;\n      optionalScopes: ExternalScopesObject;\n    }\n) & {\n  sessionProperties?: Record<string, Json>;\n  scopedProperties?: Record<ExternalScopeString, Json>;\n};\n\n/**\n * Validates and normalizes a set of scopes according to the [CAIP-217](https://chainagnostic.org/CAIPs/caip-217) spec.\n *\n * @param requiredScopes - The required scopes to validate and normalize.\n * @param optionalScopes - The optional scopes to validate and normalize.\n * @returns An object containing the normalized required scopes and normalized optional scopes.\n */\nexport const validateAndNormalizeScopes = (\n  requiredScopes: ExternalScopesObject,\n  optionalScopes: ExternalScopesObject,\n): {\n  normalizedRequiredScopes: NormalizedScopesObject;\n  normalizedOptionalScopes: NormalizedScopesObject;\n} => {\n  const { validRequiredScopes, validOptionalScopes } = getValidScopes(\n    requiredScopes,\n    optionalScopes,\n  );\n\n  const normalizedRequiredScopes = normalizeAndMergeScopes(validRequiredScopes);\n  const normalizedOptionalScopes = normalizeAndMergeScopes(validOptionalScopes);\n\n  return {\n    normalizedRequiredScopes,\n    normalizedOptionalScopes,\n  };\n};\n\n/**\n * Groups a NormalizedScopesObject into three separate\n * NormalizedScopesObjects for supported scopes,\n * supportable scopes, and unsupportable scopes.\n *\n * @param scopes - The NormalizedScopesObject to group.\n * @param hooks - The hooks.\n * @param hooks.isEvmChainIdSupported - A helper that returns true if an eth chainId is currently supported by the wallet.\n * @param hooks.isEvmChainIdSupportable - A helper that returns true if an eth chainId could be supported by the wallet.\n * @param hooks.isNonEvmScopeSupported - A predicate that determines if an non EVM scopeString is supported.\n * @param hooks.getNonEvmSupportedMethods - A function that returns the supported methods for a non EVM scope.\n * @returns an object with three NormalizedScopesObjects separated by support.\n */\nexport const bucketScopes = (\n  scopes: NormalizedScopesObject,\n  {\n    isEvmChainIdSupported,\n    isEvmChainIdSupportable,\n    isNonEvmScopeSupported,\n    getNonEvmSupportedMethods,\n  }: {\n    isEvmChainIdSupported: (chainId: Hex) => boolean;\n    isEvmChainIdSupportable: (chainId: Hex) => boolean;\n    isNonEvmScopeSupported: (scope: CaipChainId) => boolean;\n    getNonEvmSupportedMethods: (scope: CaipChainId) => string[];\n  },\n): {\n  supportedScopes: NormalizedScopesObject;\n  supportableScopes: NormalizedScopesObject;\n  unsupportableScopes: NormalizedScopesObject;\n} => {\n  const { supportedScopes, unsupportedScopes: maybeSupportableScopes } =\n    bucketScopesBySupport(scopes, {\n      isEvmChainIdSupported,\n      isNonEvmScopeSupported,\n      getNonEvmSupportedMethods,\n    });\n\n  const {\n    supportedScopes: supportableScopes,\n    unsupportedScopes: unsupportableScopes,\n  } = bucketScopesBySupport(maybeSupportableScopes, {\n    isEvmChainIdSupported: isEvmChainIdSupportable,\n    isNonEvmScopeSupported,\n    getNonEvmSupportedMethods,\n  });\n\n  return { supportedScopes, supportableScopes, unsupportableScopes };\n};\n"]}

package/dist/scope/authorization.d.cts

@@ -0,0 +1,50 @@
+import type { CaipChainId, Hex, Json } from "@metamask/utils";
+import type { ExternalScopesObject, ExternalScopeString, NormalizedScopesObject } from "./types.cjs";
+/**
+ * Represents the parameters of a [CAIP-25](https://chainagnostic.org/CAIPs/caip-25) request.
+ */
+export type Caip25Authorization = ({
+    requiredScopes: ExternalScopesObject;
+    optionalScopes?: ExternalScopesObject;
+} | {
+    requiredScopes?: ExternalScopesObject;
+    optionalScopes: ExternalScopesObject;
+}) & {
+    sessionProperties?: Record<string, Json>;
+    scopedProperties?: Record<ExternalScopeString, Json>;
+};
+/**
+ * Validates and normalizes a set of scopes according to the [CAIP-217](https://chainagnostic.org/CAIPs/caip-217) spec.
+ *
+ * @param requiredScopes - The required scopes to validate and normalize.
+ * @param optionalScopes - The optional scopes to validate and normalize.
+ * @returns An object containing the normalized required scopes and normalized optional scopes.
+ */
+export declare const validateAndNormalizeScopes: (requiredScopes: ExternalScopesObject, optionalScopes: ExternalScopesObject) => {
+    normalizedRequiredScopes: NormalizedScopesObject;
+    normalizedOptionalScopes: NormalizedScopesObject;
+};
+/**
+ * Groups a NormalizedScopesObject into three separate
+ * NormalizedScopesObjects for supported scopes,
+ * supportable scopes, and unsupportable scopes.
+ *
+ * @param scopes - The NormalizedScopesObject to group.
+ * @param hooks - The hooks.
+ * @param hooks.isEvmChainIdSupported - A helper that returns true if an eth chainId is currently supported by the wallet.
+ * @param hooks.isEvmChainIdSupportable - A helper that returns true if an eth chainId could be supported by the wallet.
+ * @param hooks.isNonEvmScopeSupported - A predicate that determines if an non EVM scopeString is supported.
+ * @param hooks.getNonEvmSupportedMethods - A function that returns the supported methods for a non EVM scope.
+ * @returns an object with three NormalizedScopesObjects separated by support.
+ */
+export declare const bucketScopes: (scopes: NormalizedScopesObject, { isEvmChainIdSupported, isEvmChainIdSupportable, isNonEvmScopeSupported, getNonEvmSupportedMethods, }: {
+    isEvmChainIdSupported: (chainId: Hex) => boolean;
+    isEvmChainIdSupportable: (chainId: Hex) => boolean;
+    isNonEvmScopeSupported: (scope: CaipChainId) => boolean;
+    getNonEvmSupportedMethods: (scope: CaipChainId) => string[];
+}) => {
+    supportedScopes: NormalizedScopesObject;
+    supportableScopes: NormalizedScopesObject;
+    unsupportableScopes: NormalizedScopesObject;
+};
+//# sourceMappingURL=authorization.d.cts.map

package/dist/scope/authorization.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"authorization.d.cts","sourceRoot":"","sources":["../../src/scope/authorization.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,GAAG,EAAE,IAAI,EAAE,wBAAwB;AAI9D,OAAO,KAAK,EACV,oBAAoB,EACpB,mBAAmB,EACnB,sBAAsB,EACvB,oBAAgB;AAGjB;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,CAC9B;IACE,cAAc,EAAE,oBAAoB,CAAC;IACrC,cAAc,CAAC,EAAE,oBAAoB,CAAC;CACvC,GACD;IACE,cAAc,CAAC,EAAE,oBAAoB,CAAC;IACtC,cAAc,EAAE,oBAAoB,CAAC;CACtC,CACJ,GAAG;IACF,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IACzC,gBAAgB,CAAC,EAAE,MAAM,CAAC,mBAAmB,EAAE,IAAI,CAAC,CAAC;CACtD,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,0BAA0B,mBACrB,oBAAoB,kBACpB,oBAAoB;8BAEV,sBAAsB;8BACtB,sBAAsB;CAcjD,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,YAAY,WACf,sBAAsB;qCAOK,GAAG,KAAK,OAAO;uCACb,GAAG,KAAK,OAAO;oCAClB,WAAW,KAAK,OAAO;uCACpB,WAAW,KAAK,MAAM,EAAE;;qBAG5C,sBAAsB;uBACpB,sBAAsB;yBACpB,sBAAsB;CAmB5C,CAAC"}

package/dist/scope/authorization.d.mts

@@ -0,0 +1,50 @@
+import type { CaipChainId, Hex, Json } from "@metamask/utils";
+import type { ExternalScopesObject, ExternalScopeString, NormalizedScopesObject } from "./types.mjs";
+/**
+ * Represents the parameters of a [CAIP-25](https://chainagnostic.org/CAIPs/caip-25) request.
+ */
+export type Caip25Authorization = ({
+    requiredScopes: ExternalScopesObject;
+    optionalScopes?: ExternalScopesObject;
+} | {
+    requiredScopes?: ExternalScopesObject;
+    optionalScopes: ExternalScopesObject;
+}) & {
+    sessionProperties?: Record<string, Json>;
+    scopedProperties?: Record<ExternalScopeString, Json>;
+};
+/**
+ * Validates and normalizes a set of scopes according to the [CAIP-217](https://chainagnostic.org/CAIPs/caip-217) spec.
+ *
+ * @param requiredScopes - The required scopes to validate and normalize.
+ * @param optionalScopes - The optional scopes to validate and normalize.
+ * @returns An object containing the normalized required scopes and normalized optional scopes.
+ */
+export declare const validateAndNormalizeScopes: (requiredScopes: ExternalScopesObject, optionalScopes: ExternalScopesObject) => {
+    normalizedRequiredScopes: NormalizedScopesObject;
+    normalizedOptionalScopes: NormalizedScopesObject;
+};
+/**
+ * Groups a NormalizedScopesObject into three separate
+ * NormalizedScopesObjects for supported scopes,
+ * supportable scopes, and unsupportable scopes.
+ *
+ * @param scopes - The NormalizedScopesObject to group.
+ * @param hooks - The hooks.
+ * @param hooks.isEvmChainIdSupported - A helper that returns true if an eth chainId is currently supported by the wallet.
+ * @param hooks.isEvmChainIdSupportable - A helper that returns true if an eth chainId could be supported by the wallet.
+ * @param hooks.isNonEvmScopeSupported - A predicate that determines if an non EVM scopeString is supported.
+ * @param hooks.getNonEvmSupportedMethods - A function that returns the supported methods for a non EVM scope.
+ * @returns an object with three NormalizedScopesObjects separated by support.
+ */
+export declare const bucketScopes: (scopes: NormalizedScopesObject, { isEvmChainIdSupported, isEvmChainIdSupportable, isNonEvmScopeSupported, getNonEvmSupportedMethods, }: {
+    isEvmChainIdSupported: (chainId: Hex) => boolean;
+    isEvmChainIdSupportable: (chainId: Hex) => boolean;
+    isNonEvmScopeSupported: (scope: CaipChainId) => boolean;
+    getNonEvmSupportedMethods: (scope: CaipChainId) => string[];
+}) => {
+    supportedScopes: NormalizedScopesObject;
+    supportableScopes: NormalizedScopesObject;
+    unsupportableScopes: NormalizedScopesObject;
+};
+//# sourceMappingURL=authorization.d.mts.map

package/dist/scope/authorization.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"authorization.d.mts","sourceRoot":"","sources":["../../src/scope/authorization.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,GAAG,EAAE,IAAI,EAAE,wBAAwB;AAI9D,OAAO,KAAK,EACV,oBAAoB,EACpB,mBAAmB,EACnB,sBAAsB,EACvB,oBAAgB;AAGjB;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,CAC9B;IACE,cAAc,EAAE,oBAAoB,CAAC;IACrC,cAAc,CAAC,EAAE,oBAAoB,CAAC;CACvC,GACD;IACE,cAAc,CAAC,EAAE,oBAAoB,CAAC;IACtC,cAAc,EAAE,oBAAoB,CAAC;CACtC,CACJ,GAAG;IACF,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IACzC,gBAAgB,CAAC,EAAE,MAAM,CAAC,mBAAmB,EAAE,IAAI,CAAC,CAAC;CACtD,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,0BAA0B,mBACrB,oBAAoB,kBACpB,oBAAoB;8BAEV,sBAAsB;8BACtB,sBAAsB;CAcjD,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,YAAY,WACf,sBAAsB;qCAOK,GAAG,KAAK,OAAO;uCACb,GAAG,KAAK,OAAO;oCAClB,WAAW,KAAK,OAAO;uCACpB,WAAW,KAAK,MAAM,EAAE;;qBAG5C,sBAAsB;uBACpB,sBAAsB;yBACpB,sBAAsB;CAmB5C,CAAC"}

package/dist/scope/authorization.mjs

@@ -0,0 +1,46 @@
+import { bucketScopesBySupport } from "./filter.mjs";
+import { normalizeAndMergeScopes } from "./transform.mjs";
+import { getValidScopes } from "./validation.mjs";
+/**
+ * Validates and normalizes a set of scopes according to the [CAIP-217](https://chainagnostic.org/CAIPs/caip-217) spec.
+ *
+ * @param requiredScopes - The required scopes to validate and normalize.
+ * @param optionalScopes - The optional scopes to validate and normalize.
+ * @returns An object containing the normalized required scopes and normalized optional scopes.
+ */
+export const validateAndNormalizeScopes = (requiredScopes, optionalScopes) => {
+    const { validRequiredScopes, validOptionalScopes } = getValidScopes(requiredScopes, optionalScopes);
+    const normalizedRequiredScopes = normalizeAndMergeScopes(validRequiredScopes);
+    const normalizedOptionalScopes = normalizeAndMergeScopes(validOptionalScopes);
+    return {
+        normalizedRequiredScopes,
+        normalizedOptionalScopes,
+    };
+};
+/**
+ * Groups a NormalizedScopesObject into three separate
+ * NormalizedScopesObjects for supported scopes,
+ * supportable scopes, and unsupportable scopes.
+ *
+ * @param scopes - The NormalizedScopesObject to group.
+ * @param hooks - The hooks.
+ * @param hooks.isEvmChainIdSupported - A helper that returns true if an eth chainId is currently supported by the wallet.
+ * @param hooks.isEvmChainIdSupportable - A helper that returns true if an eth chainId could be supported by the wallet.
+ * @param hooks.isNonEvmScopeSupported - A predicate that determines if an non EVM scopeString is supported.
+ * @param hooks.getNonEvmSupportedMethods - A function that returns the supported methods for a non EVM scope.
+ * @returns an object with three NormalizedScopesObjects separated by support.
+ */
+export const bucketScopes = (scopes, { isEvmChainIdSupported, isEvmChainIdSupportable, isNonEvmScopeSupported, getNonEvmSupportedMethods, }) => {
+    const { supportedScopes, unsupportedScopes: maybeSupportableScopes } = bucketScopesBySupport(scopes, {
+        isEvmChainIdSupported,
+        isNonEvmScopeSupported,
+        getNonEvmSupportedMethods,
+    });
+    const { supportedScopes: supportableScopes, unsupportedScopes: unsupportableScopes, } = bucketScopesBySupport(maybeSupportableScopes, {
+        isEvmChainIdSupported: isEvmChainIdSupportable,
+        isNonEvmScopeSupported,
+        getNonEvmSupportedMethods,
+    });
+    return { supportedScopes, supportableScopes, unsupportableScopes };
+};
+//# sourceMappingURL=authorization.mjs.map

package/dist/scope/authorization.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"authorization.mjs","sourceRoot":"","sources":["../../src/scope/authorization.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,qBAAqB,EAAE,qBAAiB;AACjD,OAAO,EAAE,uBAAuB,EAAE,wBAAoB;AAMtD,OAAO,EAAE,cAAc,EAAE,yBAAqB;AAmB9C;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,CACxC,cAAoC,EACpC,cAAoC,EAIpC,EAAE;IACF,MAAM,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,GAAG,cAAc,CACjE,cAAc,EACd,cAAc,CACf,CAAC;IAEF,MAAM,wBAAwB,GAAG,uBAAuB,CAAC,mBAAmB,CAAC,CAAC;IAC9E,MAAM,wBAAwB,GAAG,uBAAuB,CAAC,mBAAmB,CAAC,CAAC;IAE9E,OAAO;QACL,wBAAwB;QACxB,wBAAwB;KACzB,CAAC;AACJ,CAAC,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAC1B,MAA8B,EAC9B,EACE,qBAAqB,EACrB,uBAAuB,EACvB,sBAAsB,EACtB,yBAAyB,GAM1B,EAKD,EAAE;IACF,MAAM,EAAE,eAAe,EAAE,iBAAiB,EAAE,sBAAsB,EAAE,GAClE,qBAAqB,CAAC,MAAM,EAAE;QAC5B,qBAAqB;QACrB,sBAAsB;QACtB,yBAAyB;KAC1B,CAAC,CAAC;IAEL,MAAM,EACJ,eAAe,EAAE,iBAAiB,EAClC,iBAAiB,EAAE,mBAAmB,GACvC,GAAG,qBAAqB,CAAC,sBAAsB,EAAE;QAChD,qBAAqB,EAAE,uBAAuB;QAC9C,sBAAsB;QACtB,yBAAyB;KAC1B,CAAC,CAAC;IAEH,OAAO,EAAE,eAAe,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,CAAC;AACrE,CAAC,CAAC","sourcesContent":["import type { CaipChainId, Hex, Json } from '@metamask/utils';\n\nimport { bucketScopesBySupport } from './filter';\nimport { normalizeAndMergeScopes } from './transform';\nimport type {\n  ExternalScopesObject,\n  ExternalScopeString,\n  NormalizedScopesObject,\n} from './types';\nimport { getValidScopes } from './validation';\n\n/**\n * Represents the parameters of a [CAIP-25](https://chainagnostic.org/CAIPs/caip-25) request.\n */\nexport type Caip25Authorization = (\n  | {\n      requiredScopes: ExternalScopesObject;\n      optionalScopes?: ExternalScopesObject;\n    }\n  | {\n      requiredScopes?: ExternalScopesObject;\n      optionalScopes: ExternalScopesObject;\n    }\n) & {\n  sessionProperties?: Record<string, Json>;\n  scopedProperties?: Record<ExternalScopeString, Json>;\n};\n\n/**\n * Validates and normalizes a set of scopes according to the [CAIP-217](https://chainagnostic.org/CAIPs/caip-217) spec.\n *\n * @param requiredScopes - The required scopes to validate and normalize.\n * @param optionalScopes - The optional scopes to validate and normalize.\n * @returns An object containing the normalized required scopes and normalized optional scopes.\n */\nexport const validateAndNormalizeScopes = (\n  requiredScopes: ExternalScopesObject,\n  optionalScopes: ExternalScopesObject,\n): {\n  normalizedRequiredScopes: NormalizedScopesObject;\n  normalizedOptionalScopes: NormalizedScopesObject;\n} => {\n  const { validRequiredScopes, validOptionalScopes } = getValidScopes(\n    requiredScopes,\n    optionalScopes,\n  );\n\n  const normalizedRequiredScopes = normalizeAndMergeScopes(validRequiredScopes);\n  const normalizedOptionalScopes = normalizeAndMergeScopes(validOptionalScopes);\n\n  return {\n    normalizedRequiredScopes,\n    normalizedOptionalScopes,\n  };\n};\n\n/**\n * Groups a NormalizedScopesObject into three separate\n * NormalizedScopesObjects for supported scopes,\n * supportable scopes, and unsupportable scopes.\n *\n * @param scopes - The NormalizedScopesObject to group.\n * @param hooks - The hooks.\n * @param hooks.isEvmChainIdSupported - A helper that returns true if an eth chainId is currently supported by the wallet.\n * @param hooks.isEvmChainIdSupportable - A helper that returns true if an eth chainId could be supported by the wallet.\n * @param hooks.isNonEvmScopeSupported - A predicate that determines if an non EVM scopeString is supported.\n * @param hooks.getNonEvmSupportedMethods - A function that returns the supported methods for a non EVM scope.\n * @returns an object with three NormalizedScopesObjects separated by support.\n */\nexport const bucketScopes = (\n  scopes: NormalizedScopesObject,\n  {\n    isEvmChainIdSupported,\n    isEvmChainIdSupportable,\n    isNonEvmScopeSupported,\n    getNonEvmSupportedMethods,\n  }: {\n    isEvmChainIdSupported: (chainId: Hex) => boolean;\n    isEvmChainIdSupportable: (chainId: Hex) => boolean;\n    isNonEvmScopeSupported: (scope: CaipChainId) => boolean;\n    getNonEvmSupportedMethods: (scope: CaipChainId) => string[];\n  },\n): {\n  supportedScopes: NormalizedScopesObject;\n  supportableScopes: NormalizedScopesObject;\n  unsupportableScopes: NormalizedScopesObject;\n} => {\n  const { supportedScopes, unsupportedScopes: maybeSupportableScopes } =\n    bucketScopesBySupport(scopes, {\n      isEvmChainIdSupported,\n      isNonEvmScopeSupported,\n      getNonEvmSupportedMethods,\n    });\n\n  const {\n    supportedScopes: supportableScopes,\n    unsupportedScopes: unsupportableScopes,\n  } = bucketScopesBySupport(maybeSupportableScopes, {\n    isEvmChainIdSupported: isEvmChainIdSupportable,\n    isNonEvmScopeSupported,\n    getNonEvmSupportedMethods,\n  });\n\n  return { supportedScopes, supportableScopes, unsupportableScopes };\n};\n"]}