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

package/dist/scope/transform.d.cts

@@ -0,0 +1,50 @@
+import type { ExternalScopeObject, ExternalScopesObject, InternalScopesObject, NormalizedScopeObject, NormalizedScopesObject } from "./types.cjs";
+/**
+ * Returns a list of unique items
+ *
+ * @param list - The list of items to filter
+ * @returns A list of unique items
+ */
+export declare const getUniqueArrayItems: <Value>(list: Value[]) => Value[];
+/**
+ * Normalizes a ScopeString and ExternalScopeObject into a separate
+ * InternalScopeString and NormalizedScopeObject for each reference in the `references`
+ * value if defined and adds an empty `accounts` array if not defined.
+ *
+ * @param scopeString - The string representing the scope
+ * @param externalScopeObject - The object that defines the scope
+ * @returns a map of caipChainId to ScopeObjects
+ */
+export declare const normalizeScope: (scopeString: string, externalScopeObject: ExternalScopeObject) => NormalizedScopesObject;
+/**
+ * Merges two NormalizedScopeObjects
+ *
+ * @param scopeObjectA - The first scope object to merge.
+ * @param scopeObjectB - The second scope object to merge.
+ * @returns The merged scope object.
+ */
+export declare const mergeScopeObject: (scopeObjectA: NormalizedScopeObject, scopeObjectB: NormalizedScopeObject) => NormalizedScopeObject;
+/**
+ * Merges two NormalizedScopeObjects
+ *
+ * @param scopeA - The first normalized scope object to merge.
+ * @param scopeB - The second normalized scope object to merge.
+ * @returns The merged normalized scope object from the [CAIP-25](https://github.com/ChainAgnostic/CAIPs/blob/main/CAIPs/caip-25.md) request.
+ */
+export declare const mergeNormalizedScopes: (scopeA: NormalizedScopesObject, scopeB: NormalizedScopesObject) => NormalizedScopesObject;
+/**
+ * Merges two InternalScopeObjects
+ *
+ * @param scopeA - The first internal scope object to merge.
+ * @param scopeB - The second internal scope object to merge.
+ * @returns The merged internal scope object from the [CAIP-25](https://github.com/ChainAgnostic/CAIPs/blob/main/CAIPs/caip-25.md) request.
+ */
+export declare const mergeInternalScopes: (scopeA: InternalScopesObject, scopeB: InternalScopesObject) => InternalScopesObject;
+/**
+ * Normalizes and merges a set of ExternalScopesObjects into a NormalizedScopesObject (i.e. a set of NormalizedScopeObjects where references are flattened).
+ *
+ * @param scopes - The external scopes to normalize and merge.
+ * @returns The normalized and merged scopes.
+ */
+export declare const normalizeAndMergeScopes: (scopes: ExternalScopesObject) => NormalizedScopesObject;
+//# sourceMappingURL=transform.d.cts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"transform.d.cts","sourceRoot":"","sources":["../../src/scope/transform.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EACV,mBAAmB,EACnB,oBAAoB,EACpB,oBAAoB,EACpB,qBAAqB,EACrB,sBAAsB,EACvB,oBAAgB;AAGjB;;;;;GAKG;AACH,eAAO,MAAM,mBAAmB,mCAE/B,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,cAAc,gBACZ,MAAM,uBACE,mBAAmB,KACvC,sBAwBF,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,gBAAgB,iBACb,qBAAqB,gBACrB,qBAAqB,0BAgCpC,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,qBAAqB,WACxB,sBAAsB,UACtB,sBAAsB,KAC7B,sBAwBF,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,mBAAmB,WACtB,oBAAoB,UACpB,oBAAoB,KAC3B,oBAmBF,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,uBAAuB,WAC1B,oBAAoB,KAC3B,sBAQF,CAAC"}

package/dist/scope/transform.d.mts

@@ -0,0 +1,50 @@
+import type { ExternalScopeObject, ExternalScopesObject, InternalScopesObject, NormalizedScopeObject, NormalizedScopesObject } from "./types.mjs";
+/**
+ * Returns a list of unique items
+ *
+ * @param list - The list of items to filter
+ * @returns A list of unique items
+ */
+export declare const getUniqueArrayItems: <Value>(list: Value[]) => Value[];
+/**
+ * Normalizes a ScopeString and ExternalScopeObject into a separate
+ * InternalScopeString and NormalizedScopeObject for each reference in the `references`
+ * value if defined and adds an empty `accounts` array if not defined.
+ *
+ * @param scopeString - The string representing the scope
+ * @param externalScopeObject - The object that defines the scope
+ * @returns a map of caipChainId to ScopeObjects
+ */
+export declare const normalizeScope: (scopeString: string, externalScopeObject: ExternalScopeObject) => NormalizedScopesObject;
+/**
+ * Merges two NormalizedScopeObjects
+ *
+ * @param scopeObjectA - The first scope object to merge.
+ * @param scopeObjectB - The second scope object to merge.
+ * @returns The merged scope object.
+ */
+export declare const mergeScopeObject: (scopeObjectA: NormalizedScopeObject, scopeObjectB: NormalizedScopeObject) => NormalizedScopeObject;
+/**
+ * Merges two NormalizedScopeObjects
+ *
+ * @param scopeA - The first normalized scope object to merge.
+ * @param scopeB - The second normalized scope object to merge.
+ * @returns The merged normalized scope object from the [CAIP-25](https://github.com/ChainAgnostic/CAIPs/blob/main/CAIPs/caip-25.md) request.
+ */
+export declare const mergeNormalizedScopes: (scopeA: NormalizedScopesObject, scopeB: NormalizedScopesObject) => NormalizedScopesObject;
+/**
+ * Merges two InternalScopeObjects
+ *
+ * @param scopeA - The first internal scope object to merge.
+ * @param scopeB - The second internal scope object to merge.
+ * @returns The merged internal scope object from the [CAIP-25](https://github.com/ChainAgnostic/CAIPs/blob/main/CAIPs/caip-25.md) request.
+ */
+export declare const mergeInternalScopes: (scopeA: InternalScopesObject, scopeB: InternalScopesObject) => InternalScopesObject;
+/**
+ * Normalizes and merges a set of ExternalScopesObjects into a NormalizedScopesObject (i.e. a set of NormalizedScopeObjects where references are flattened).
+ *
+ * @param scopes - The external scopes to normalize and merge.
+ * @returns The normalized and merged scopes.
+ */
+export declare const normalizeAndMergeScopes: (scopes: ExternalScopesObject) => NormalizedScopesObject;
+//# sourceMappingURL=transform.d.mts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"transform.d.mts","sourceRoot":"","sources":["../../src/scope/transform.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EACV,mBAAmB,EACnB,oBAAoB,EACpB,oBAAoB,EACpB,qBAAqB,EACrB,sBAAsB,EACvB,oBAAgB;AAGjB;;;;;GAKG;AACH,eAAO,MAAM,mBAAmB,mCAE/B,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,cAAc,gBACZ,MAAM,uBACE,mBAAmB,KACvC,sBAwBF,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,gBAAgB,iBACb,qBAAqB,gBACrB,qBAAqB,0BAgCpC,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,qBAAqB,WACxB,sBAAsB,UACtB,sBAAsB,KAC7B,sBAwBF,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,mBAAmB,WACtB,oBAAoB,UACpB,oBAAoB,KAC3B,oBAmBF,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,uBAAuB,WAC1B,oBAAoB,KAC3B,sBAQF,CAAC"}

package/dist/scope/transform.mjs

@@ -0,0 +1,144 @@
+import $lodash from "lodash";
+const { cloneDeep } = $lodash;
+import { parseScopeString } from "./types.mjs";
+/**
+ * Returns a list of unique items
+ *
+ * @param list - The list of items to filter
+ * @returns A list of unique items
+ */
+export const getUniqueArrayItems = (list) => {
+    return Array.from(new Set(list));
+};
+/**
+ * Normalizes a ScopeString and ExternalScopeObject into a separate
+ * InternalScopeString and NormalizedScopeObject for each reference in the `references`
+ * value if defined and adds an empty `accounts` array if not defined.
+ *
+ * @param scopeString - The string representing the scope
+ * @param externalScopeObject - The object that defines the scope
+ * @returns a map of caipChainId to ScopeObjects
+ */
+export const normalizeScope = (scopeString, externalScopeObject) => {
+    const { references, ...scopeObject } = externalScopeObject;
+    const { namespace, reference } = parseScopeString(scopeString);
+    const normalizedScopeObject = {
+        accounts: [],
+        ...scopeObject,
+    };
+    const shouldFlatten = namespace &&
+        !reference &&
+        references !== undefined &&
+        references.length > 0;
+    if (shouldFlatten) {
+        return Object.fromEntries(references.map((ref) => [
+            `${namespace}:${ref}`,
+            cloneDeep(normalizedScopeObject),
+        ]));
+    }
+    return { [scopeString]: normalizedScopeObject };
+};
+/**
+ * Merges two NormalizedScopeObjects
+ *
+ * @param scopeObjectA - The first scope object to merge.
+ * @param scopeObjectB - The second scope object to merge.
+ * @returns The merged scope object.
+ */
+export const mergeScopeObject = (scopeObjectA, scopeObjectB) => {
+    const mergedScopeObject = {
+        methods: getUniqueArrayItems([
+            ...scopeObjectA.methods,
+            ...scopeObjectB.methods,
+        ]),
+        notifications: getUniqueArrayItems([
+            ...scopeObjectA.notifications,
+            ...scopeObjectB.notifications,
+        ]),
+        accounts: getUniqueArrayItems([
+            ...scopeObjectA.accounts,
+            ...scopeObjectB.accounts,
+        ]),
+    };
+    if (scopeObjectA.rpcDocuments || scopeObjectB.rpcDocuments) {
+        mergedScopeObject.rpcDocuments = getUniqueArrayItems([
+            ...(scopeObjectA.rpcDocuments ?? []),
+            ...(scopeObjectB.rpcDocuments ?? []),
+        ]);
+    }
+    if (scopeObjectA.rpcEndpoints || scopeObjectB.rpcEndpoints) {
+        mergedScopeObject.rpcEndpoints = getUniqueArrayItems([
+            ...(scopeObjectA.rpcEndpoints ?? []),
+            ...(scopeObjectB.rpcEndpoints ?? []),
+        ]);
+    }
+    return mergedScopeObject;
+};
+/**
+ * Merges two NormalizedScopeObjects
+ *
+ * @param scopeA - The first normalized scope object to merge.
+ * @param scopeB - The second normalized scope object to merge.
+ * @returns The merged normalized scope object from the [CAIP-25](https://github.com/ChainAgnostic/CAIPs/blob/main/CAIPs/caip-25.md) request.
+ */
+export const mergeNormalizedScopes = (scopeA, scopeB) => {
+    const scope = {};
+    Object.entries(scopeA).forEach(([_scopeString, scopeObjectA]) => {
+        // Cast needed because index type is returned as `string` by `Object.entries`
+        const scopeString = _scopeString;
+        const scopeObjectB = scopeB[scopeString];
+        scope[scopeString] = scopeObjectB
+            ? mergeScopeObject(scopeObjectA, scopeObjectB)
+            : scopeObjectA;
+    });
+    Object.entries(scopeB).forEach(([_scopeString, scopeObjectB]) => {
+        // Cast needed because index type is returned as `string` by `Object.entries`
+        const scopeString = _scopeString;
+        const scopeObjectA = scopeA[scopeString];
+        if (!scopeObjectA) {
+            scope[scopeString] = scopeObjectB;
+        }
+    });
+    return scope;
+};
+/**
+ * Merges two InternalScopeObjects
+ *
+ * @param scopeA - The first internal scope object to merge.
+ * @param scopeB - The second internal scope object to merge.
+ * @returns The merged internal scope object from the [CAIP-25](https://github.com/ChainAgnostic/CAIPs/blob/main/CAIPs/caip-25.md) request.
+ */
+export const mergeInternalScopes = (scopeA, scopeB) => {
+    const resultScope = cloneDeep(scopeA);
+    Object.entries(scopeB).forEach(([scopeString, rightScopeObject]) => {
+        const internalScopeString = scopeString;
+        const leftRequiredScopeObject = resultScope[internalScopeString];
+        if (!leftRequiredScopeObject) {
+            resultScope[internalScopeString] = rightScopeObject;
+        }
+        else {
+            resultScope[internalScopeString] = {
+                accounts: getUniqueArrayItems([
+                    ...leftRequiredScopeObject.accounts,
+                    ...rightScopeObject.accounts,
+                ]),
+            };
+        }
+    });
+    return resultScope;
+};
+/**
+ * Normalizes and merges a set of ExternalScopesObjects into a NormalizedScopesObject (i.e. a set of NormalizedScopeObjects where references are flattened).
+ *
+ * @param scopes - The external scopes to normalize and merge.
+ * @returns The normalized and merged scopes.
+ */
+export const normalizeAndMergeScopes = (scopes) => {
+    let mergedScopes = {};
+    Object.keys(scopes).forEach((scopeString) => {
+        const normalizedScopes = normalizeScope(scopeString, scopes[scopeString]);
+        mergedScopes = mergeNormalizedScopes(mergedScopes, normalizedScopes);
+    });
+    return mergedScopes;
+};
+//# sourceMappingURL=transform.mjs.map

package/dist/scope/transform.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"transform.mjs","sourceRoot":"","sources":["../../src/scope/transform.ts"],"names":[],"mappings":";;AAUA,OAAO,EAAE,gBAAgB,EAAE,oBAAgB;AAE3C;;;;;GAKG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAQ,IAAa,EAAW,EAAE;IACnE,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;AACnC,CAAC,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAC5B,WAAmB,EACnB,mBAAwC,EAChB,EAAE;IAC1B,MAAM,EAAE,UAAU,EAAE,GAAG,WAAW,EAAE,GAAG,mBAAmB,CAAC;IAC3D,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,GAAG,gBAAgB,CAAC,WAAW,CAAC,CAAC;IAE/D,MAAM,qBAAqB,GAA0B;QACnD,QAAQ,EAAE,EAAE;QACZ,GAAG,WAAW;KACf,CAAC;IAEF,MAAM,aAAa,GACjB,SAAS;QACT,CAAC,SAAS;QACV,UAAU,KAAK,SAAS;QACxB,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC;IAExB,IAAI,aAAa,EAAE;QACjB,OAAO,MAAM,CAAC,WAAW,CACvB,UAAU,CAAC,GAAG,CAAC,CAAC,GAAkB,EAAE,EAAE,CAAC;YACrC,GAAG,SAAS,IAAI,GAAG,EAAE;YACrB,SAAS,CAAC,qBAAqB,CAAC;SACjC,CAAC,CACH,CAAC;KACH;IACD,OAAO,EAAE,CAAC,WAAW,CAAC,EAAE,qBAAqB,EAAE,CAAC;AAClD,CAAC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAC9B,YAAmC,EACnC,YAAmC,EACnC,EAAE;IACF,MAAM,iBAAiB,GAA0B;QAC/C,OAAO,EAAE,mBAAmB,CAAC;YAC3B,GAAG,YAAY,CAAC,OAAO;YACvB,GAAG,YAAY,CAAC,OAAO;SACxB,CAAC;QACF,aAAa,EAAE,mBAAmB,CAAC;YACjC,GAAG,YAAY,CAAC,aAAa;YAC7B,GAAG,YAAY,CAAC,aAAa;SAC9B,CAAC;QACF,QAAQ,EAAE,mBAAmB,CAAC;YAC5B,GAAG,YAAY,CAAC,QAAQ;YACxB,GAAG,YAAY,CAAC,QAAQ;SACzB,CAAC;KACH,CAAC;IAEF,IAAI,YAAY,CAAC,YAAY,IAAI,YAAY,CAAC,YAAY,EAAE;QAC1D,iBAAiB,CAAC,YAAY,GAAG,mBAAmB,CAAC;YACnD,GAAG,CAAC,YAAY,CAAC,YAAY,IAAI,EAAE,CAAC;YACpC,GAAG,CAAC,YAAY,CAAC,YAAY,IAAI,EAAE,CAAC;SACrC,CAAC,CAAC;KACJ;IAED,IAAI,YAAY,CAAC,YAAY,IAAI,YAAY,CAAC,YAAY,EAAE;QAC1D,iBAAiB,CAAC,YAAY,GAAG,mBAAmB,CAAC;YACnD,GAAG,CAAC,YAAY,CAAC,YAAY,IAAI,EAAE,CAAC;YACpC,GAAG,CAAC,YAAY,CAAC,YAAY,IAAI,EAAE,CAAC;SACrC,CAAC,CAAC;KACJ;IAED,OAAO,iBAAiB,CAAC;AAC3B,CAAC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CACnC,MAA8B,EAC9B,MAA8B,EACN,EAAE;IAC1B,MAAM,KAAK,GAA2B,EAAE,CAAC;IAEzC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,YAAY,EAAE,YAAY,CAAC,EAAE,EAAE;QAC9D,6EAA6E;QAC7E,MAAM,WAAW,GAAG,YAAmC,CAAC;QACxD,MAAM,YAAY,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC;QAEzC,KAAK,CAAC,WAAW,CAAC,GAAG,YAAY;YAC/B,CAAC,CAAC,gBAAgB,CAAC,YAAY,EAAE,YAAY,CAAC;YAC9C,CAAC,CAAC,YAAY,CAAC;IACnB,CAAC,CAAC,CAAC;IAEH,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,YAAY,EAAE,YAAY,CAAC,EAAE,EAAE;QAC9D,6EAA6E;QAC7E,MAAM,WAAW,GAAG,YAAmC,CAAC;QACxD,MAAM,YAAY,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC;QAEzC,IAAI,CAAC,YAAY,EAAE;YACjB,KAAK,CAAC,WAAW,CAAC,GAAG,YAAY,CAAC;SACnC;IACH,CAAC,CAAC,CAAC;IAEH,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CACjC,MAA4B,EAC5B,MAA4B,EACN,EAAE;IACxB,MAAM,WAAW,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC;IAEtC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,WAAW,EAAE,gBAAgB,CAAC,EAAE,EAAE;QACjE,MAAM,mBAAmB,GAAG,WAAkC,CAAC;QAC/D,MAAM,uBAAuB,GAAG,WAAW,CAAC,mBAAmB,CAAC,CAAC;QACjE,IAAI,CAAC,uBAAuB,EAAE;YAC5B,WAAW,CAAC,mBAAmB,CAAC,GAAG,gBAAgB,CAAC;SACrD;aAAM;YACL,WAAW,CAAC,mBAAmB,CAAC,GAAG;gBACjC,QAAQ,EAAE,mBAAmB,CAAC;oBAC5B,GAAG,uBAAuB,CAAC,QAAQ;oBACnC,GAAG,gBAAgB,CAAC,QAAQ;iBAC7B,CAAC;aACH,CAAC;SACH;IACH,CAAC,CAAC,CAAC;IAEH,OAAO,WAAW,CAAC;AACrB,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,CACrC,MAA4B,EACJ,EAAE;IAC1B,IAAI,YAAY,GAA2B,EAAE,CAAC;IAC9C,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,WAAW,EAAE,EAAE;QAC1C,MAAM,gBAAgB,GAAG,cAAc,CAAC,WAAW,EAAE,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC;QAC1E,YAAY,GAAG,qBAAqB,CAAC,YAAY,EAAE,gBAAgB,CAAC,CAAC;IACvE,CAAC,CAAC,CAAC;IAEH,OAAO,YAAY,CAAC;AACtB,CAAC,CAAC","sourcesContent":["import type { CaipReference } from '@metamask/utils';\nimport { cloneDeep } from 'lodash';\n\nimport type {\n  ExternalScopeObject,\n  ExternalScopesObject,\n  InternalScopesObject,\n  NormalizedScopeObject,\n  NormalizedScopesObject,\n} from './types';\nimport { parseScopeString } from './types';\n\n/**\n * Returns a list of unique items\n *\n * @param list - The list of items to filter\n * @returns A list of unique items\n */\nexport const getUniqueArrayItems = <Value>(list: Value[]): Value[] => {\n  return Array.from(new Set(list));\n};\n\n/**\n * Normalizes a ScopeString and ExternalScopeObject into a separate\n * InternalScopeString and NormalizedScopeObject for each reference in the `references`\n * value if defined and adds an empty `accounts` array if not defined.\n *\n * @param scopeString - The string representing the scope\n * @param externalScopeObject - The object that defines the scope\n * @returns a map of caipChainId to ScopeObjects\n */\nexport const normalizeScope = (\n  scopeString: string,\n  externalScopeObject: ExternalScopeObject,\n): NormalizedScopesObject => {\n  const { references, ...scopeObject } = externalScopeObject;\n  const { namespace, reference } = parseScopeString(scopeString);\n\n  const normalizedScopeObject: NormalizedScopeObject = {\n    accounts: [],\n    ...scopeObject,\n  };\n\n  const shouldFlatten =\n    namespace &&\n    !reference &&\n    references !== undefined &&\n    references.length > 0;\n\n  if (shouldFlatten) {\n    return Object.fromEntries(\n      references.map((ref: CaipReference) => [\n        `${namespace}:${ref}`,\n        cloneDeep(normalizedScopeObject),\n      ]),\n    );\n  }\n  return { [scopeString]: normalizedScopeObject };\n};\n\n/**\n * Merges two NormalizedScopeObjects\n *\n * @param scopeObjectA - The first scope object to merge.\n * @param scopeObjectB - The second scope object to merge.\n * @returns The merged scope object.\n */\nexport const mergeScopeObject = (\n  scopeObjectA: NormalizedScopeObject,\n  scopeObjectB: NormalizedScopeObject,\n) => {\n  const mergedScopeObject: NormalizedScopeObject = {\n    methods: getUniqueArrayItems([\n      ...scopeObjectA.methods,\n      ...scopeObjectB.methods,\n    ]),\n    notifications: getUniqueArrayItems([\n      ...scopeObjectA.notifications,\n      ...scopeObjectB.notifications,\n    ]),\n    accounts: getUniqueArrayItems([\n      ...scopeObjectA.accounts,\n      ...scopeObjectB.accounts,\n    ]),\n  };\n\n  if (scopeObjectA.rpcDocuments || scopeObjectB.rpcDocuments) {\n    mergedScopeObject.rpcDocuments = getUniqueArrayItems([\n      ...(scopeObjectA.rpcDocuments ?? []),\n      ...(scopeObjectB.rpcDocuments ?? []),\n    ]);\n  }\n\n  if (scopeObjectA.rpcEndpoints || scopeObjectB.rpcEndpoints) {\n    mergedScopeObject.rpcEndpoints = getUniqueArrayItems([\n      ...(scopeObjectA.rpcEndpoints ?? []),\n      ...(scopeObjectB.rpcEndpoints ?? []),\n    ]);\n  }\n\n  return mergedScopeObject;\n};\n\n/**\n * Merges two NormalizedScopeObjects\n *\n * @param scopeA - The first normalized scope object to merge.\n * @param scopeB - The second normalized scope object to merge.\n * @returns The merged normalized scope object from the [CAIP-25](https://github.com/ChainAgnostic/CAIPs/blob/main/CAIPs/caip-25.md) request.\n */\nexport const mergeNormalizedScopes = (\n  scopeA: NormalizedScopesObject,\n  scopeB: NormalizedScopesObject,\n): NormalizedScopesObject => {\n  const scope: NormalizedScopesObject = {};\n\n  Object.entries(scopeA).forEach(([_scopeString, scopeObjectA]) => {\n    // Cast needed because index type is returned as `string` by `Object.entries`\n    const scopeString = _scopeString as keyof typeof scopeA;\n    const scopeObjectB = scopeB[scopeString];\n\n    scope[scopeString] = scopeObjectB\n      ? mergeScopeObject(scopeObjectA, scopeObjectB)\n      : scopeObjectA;\n  });\n\n  Object.entries(scopeB).forEach(([_scopeString, scopeObjectB]) => {\n    // Cast needed because index type is returned as `string` by `Object.entries`\n    const scopeString = _scopeString as keyof typeof scopeB;\n    const scopeObjectA = scopeA[scopeString];\n\n    if (!scopeObjectA) {\n      scope[scopeString] = scopeObjectB;\n    }\n  });\n\n  return scope;\n};\n\n/**\n * Merges two InternalScopeObjects\n *\n * @param scopeA - The first internal scope object to merge.\n * @param scopeB - The second internal scope object to merge.\n * @returns The merged internal scope object from the [CAIP-25](https://github.com/ChainAgnostic/CAIPs/blob/main/CAIPs/caip-25.md) request.\n */\nexport const mergeInternalScopes = (\n  scopeA: InternalScopesObject,\n  scopeB: InternalScopesObject,\n): InternalScopesObject => {\n  const resultScope = cloneDeep(scopeA);\n\n  Object.entries(scopeB).forEach(([scopeString, rightScopeObject]) => {\n    const internalScopeString = scopeString as keyof typeof scopeB;\n    const leftRequiredScopeObject = resultScope[internalScopeString];\n    if (!leftRequiredScopeObject) {\n      resultScope[internalScopeString] = rightScopeObject;\n    } else {\n      resultScope[internalScopeString] = {\n        accounts: getUniqueArrayItems([\n          ...leftRequiredScopeObject.accounts,\n          ...rightScopeObject.accounts,\n        ]),\n      };\n    }\n  });\n\n  return resultScope;\n};\n\n/**\n * Normalizes and merges a set of ExternalScopesObjects into a NormalizedScopesObject (i.e. a set of NormalizedScopeObjects where references are flattened).\n *\n * @param scopes - The external scopes to normalize and merge.\n * @returns The normalized and merged scopes.\n */\nexport const normalizeAndMergeScopes = (\n  scopes: ExternalScopesObject,\n): NormalizedScopesObject => {\n  let mergedScopes: NormalizedScopesObject = {};\n  Object.keys(scopes).forEach((scopeString) => {\n    const normalizedScopes = normalizeScope(scopeString, scopes[scopeString]);\n    mergedScopes = mergeNormalizedScopes(mergedScopes, normalizedScopes);\n  });\n\n  return mergedScopes;\n};\n"]}

package/dist/scope/types.cjs

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseScopeString = void 0;
+const utils_1 = require("@metamask/utils");
+/**
+ * Parses a scope string into a namespace and reference.
+ *
+ * @param scopeString - The scope string to parse.
+ * @returns An object containing the namespace and reference.
+ */
+const parseScopeString = (scopeString) => {
+    if ((0, utils_1.isCaipNamespace)(scopeString)) {
+        return {
+            namespace: scopeString,
+        };
+    }
+    if ((0, utils_1.isCaipChainId)(scopeString)) {
+        return (0, utils_1.parseCaipChainId)(scopeString);
+    }
+    return {};
+};
+exports.parseScopeString = parseScopeString;
+//# sourceMappingURL=types.cjs.map

package/dist/scope/types.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.cjs","sourceRoot":"","sources":["../../src/scope/types.ts"],"names":[],"mappings":";;;AAAA,2CAIyB;AAuFzB;;;;;GAKG;AACI,MAAM,gBAAgB,GAAG,CAC9B,WAAmB,EAInB,EAAE;IACF,IAAI,IAAA,uBAAe,EAAC,WAAW,CAAC,EAAE;QAChC,OAAO;YACL,SAAS,EAAE,WAAW;SACvB,CAAC;KACH;IACD,IAAI,IAAA,qBAAa,EAAC,WAAW,CAAC,EAAE;QAC9B,OAAO,IAAA,wBAAgB,EAAC,WAAW,CAAC,CAAC;KACtC;IAED,OAAO,EAAE,CAAC;AACZ,CAAC,CAAC;AAhBW,QAAA,gBAAgB,oBAgB3B","sourcesContent":["import {\n  isCaipNamespace,\n  isCaipChainId,\n  parseCaipChainId,\n} from '@metamask/utils';\nimport type {\n  CaipChainId,\n  CaipReference,\n  CaipAccountId,\n  KnownCaipNamespace,\n  CaipNamespace,\n  Json,\n} from '@metamask/utils';\n\n/**\n * Represents a `scopeString` as defined in [CAIP-217](https://chainagnostic.org/CAIPs/caip-217).\n */\nexport type ExternalScopeString = CaipChainId | CaipNamespace;\n/**\n * Represents a `scopeObject` as defined in [CAIP-217](https://chainagnostic.org/CAIPs/caip-217).\n */\nexport type ExternalScopeObject = Omit<NormalizedScopeObject, 'accounts'> & {\n  references?: CaipReference[];\n  accounts?: CaipAccountId[];\n};\n/**\n * Represents a `scope` as defined in [CAIP-217](https://chainagnostic.org/CAIPs/caip-217).\n * TODO update the language in CAIP-217 to use \"scope\" instead of \"scopeObject\" for this full record type.\n */\nexport type ExternalScopesObject = Record<\n  ExternalScopeString,\n  ExternalScopeObject\n>;\n\n/**\n * Represents a `scopeString` as defined in\n * [CAIP-217](https://chainagnostic.org/CAIPs/caip-217), with the exception that\n * CAIP namespaces without a reference (aside from \"wallet\") are disallowed for our internal representations of CAIP-25 session scopes\n */\nexport type InternalScopeString = CaipChainId | KnownCaipNamespace.Wallet;\n\n/**\n * A trimmed down version of a [CAIP-217](https://chainagnostic.org/CAIPs/caip-217) defined scopeObject that is stored in a `endowment:caip25` permission.\n * The only property from the original CAIP-25 scopeObject that we use for permissioning is `accounts`.\n */\nexport type InternalScopeObject = {\n  accounts: CaipAccountId[];\n};\n\n/**\n * A trimmed down version of a [CAIP-217](https://chainagnostic.org/CAIPs/caip-217) scope that is stored in a `endowment:caip25` permission.\n * Accounts arrays are mapped to CAIP-2 chainIds. These are currently the only properties used by the permission system.\n */\nexport type InternalScopesObject = Record<CaipChainId, InternalScopeObject> & {\n  [KnownCaipNamespace.Wallet]?: InternalScopeObject;\n};\n\n/**\n * Represents a `scopeObject` as defined in\n * [CAIP-217](https://chainagnostic.org/CAIPs/caip-217), with the exception that\n * we resolve the `references` property into a scopeObject per reference and\n * assign an empty array to the `accounts` property if not already defined\n * to more easily perform support checks for `wallet_createSession` requests.\n * Also used as the return type for `wallet_createSession` and `wallet_sessionChanged`.\n */\nexport type NormalizedScopeObject = {\n  methods: string[];\n  notifications: string[];\n  accounts: CaipAccountId[];\n  rpcDocuments?: string[];\n  rpcEndpoints?: string[];\n};\n/**\n * Represents a keyed `scopeObject` as defined in\n * [CAIP-217](https://chainagnostic.org/CAIPs/caip-217), with the exception that\n * we resolve the `references` property into a scopeObject per reference and\n * assign an empty array to the `accounts` property if not already defined\n * to more easily perform support checks for `wallet_createSession` requests.\n * Also used as the return type for `wallet_createSession` and `wallet_sessionChanged`.\n */\nexport type NormalizedScopesObject = Record<\n  CaipChainId,\n  NormalizedScopeObject\n> & {\n  [KnownCaipNamespace.Wallet]?: NormalizedScopeObject;\n};\n\nexport type ScopedProperties = Record<CaipChainId, Record<string, Json>> & {\n  [KnownCaipNamespace.Wallet]?: Record<string, Json>;\n};\n\n/**\n * Parses a scope string into a namespace and reference.\n *\n * @param scopeString - The scope string to parse.\n * @returns An object containing the namespace and reference.\n */\nexport const parseScopeString = (\n  scopeString: string,\n): {\n  namespace?: string;\n  reference?: string;\n} => {\n  if (isCaipNamespace(scopeString)) {\n    return {\n      namespace: scopeString,\n    };\n  }\n  if (isCaipChainId(scopeString)) {\n    return parseCaipChainId(scopeString);\n  }\n\n  return {};\n};\n\n/**\n * CAIP namespaces excluding \"wallet\" currently supported by/known to the wallet.\n */\nexport type NonWalletKnownCaipNamespace = Exclude<\n  KnownCaipNamespace,\n  KnownCaipNamespace.Wallet\n>;\n"]}

package/dist/scope/types.d.cts

@@ -0,0 +1,81 @@
+import type { CaipChainId, CaipReference, CaipAccountId, KnownCaipNamespace, CaipNamespace, Json } from "@metamask/utils";
+/**
+ * Represents a `scopeString` as defined in [CAIP-217](https://chainagnostic.org/CAIPs/caip-217).
+ */
+export type ExternalScopeString = CaipChainId | CaipNamespace;
+/**
+ * Represents a `scopeObject` as defined in [CAIP-217](https://chainagnostic.org/CAIPs/caip-217).
+ */
+export type ExternalScopeObject = Omit<NormalizedScopeObject, 'accounts'> & {
+    references?: CaipReference[];
+    accounts?: CaipAccountId[];
+};
+/**
+ * Represents a `scope` as defined in [CAIP-217](https://chainagnostic.org/CAIPs/caip-217).
+ * TODO update the language in CAIP-217 to use "scope" instead of "scopeObject" for this full record type.
+ */
+export type ExternalScopesObject = Record<ExternalScopeString, ExternalScopeObject>;
+/**
+ * Represents a `scopeString` as defined in
+ * [CAIP-217](https://chainagnostic.org/CAIPs/caip-217), with the exception that
+ * CAIP namespaces without a reference (aside from "wallet") are disallowed for our internal representations of CAIP-25 session scopes
+ */
+export type InternalScopeString = CaipChainId | KnownCaipNamespace.Wallet;
+/**
+ * A trimmed down version of a [CAIP-217](https://chainagnostic.org/CAIPs/caip-217) defined scopeObject that is stored in a `endowment:caip25` permission.
+ * The only property from the original CAIP-25 scopeObject that we use for permissioning is `accounts`.
+ */
+export type InternalScopeObject = {
+    accounts: CaipAccountId[];
+};
+/**
+ * A trimmed down version of a [CAIP-217](https://chainagnostic.org/CAIPs/caip-217) scope that is stored in a `endowment:caip25` permission.
+ * Accounts arrays are mapped to CAIP-2 chainIds. These are currently the only properties used by the permission system.
+ */
+export type InternalScopesObject = Record<CaipChainId, InternalScopeObject> & {
+    [KnownCaipNamespace.Wallet]?: InternalScopeObject;
+};
+/**
+ * Represents a `scopeObject` as defined in
+ * [CAIP-217](https://chainagnostic.org/CAIPs/caip-217), with the exception that
+ * we resolve the `references` property into a scopeObject per reference and
+ * assign an empty array to the `accounts` property if not already defined
+ * to more easily perform support checks for `wallet_createSession` requests.
+ * Also used as the return type for `wallet_createSession` and `wallet_sessionChanged`.
+ */
+export type NormalizedScopeObject = {
+    methods: string[];
+    notifications: string[];
+    accounts: CaipAccountId[];
+    rpcDocuments?: string[];
+    rpcEndpoints?: string[];
+};
+/**
+ * Represents a keyed `scopeObject` as defined in
+ * [CAIP-217](https://chainagnostic.org/CAIPs/caip-217), with the exception that
+ * we resolve the `references` property into a scopeObject per reference and
+ * assign an empty array to the `accounts` property if not already defined
+ * to more easily perform support checks for `wallet_createSession` requests.
+ * Also used as the return type for `wallet_createSession` and `wallet_sessionChanged`.
+ */
+export type NormalizedScopesObject = Record<CaipChainId, NormalizedScopeObject> & {
+    [KnownCaipNamespace.Wallet]?: NormalizedScopeObject;
+};
+export type ScopedProperties = Record<CaipChainId, Record<string, Json>> & {
+    [KnownCaipNamespace.Wallet]?: Record<string, Json>;
+};
+/**
+ * Parses a scope string into a namespace and reference.
+ *
+ * @param scopeString - The scope string to parse.
+ * @returns An object containing the namespace and reference.
+ */
+export declare const parseScopeString: (scopeString: string) => {
+    namespace?: string;
+    reference?: string;
+};
+/**
+ * CAIP namespaces excluding "wallet" currently supported by/known to the wallet.
+ */
+export type NonWalletKnownCaipNamespace = Exclude<KnownCaipNamespace, KnownCaipNamespace.Wallet>;
+//# sourceMappingURL=types.d.cts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.cts","sourceRoot":"","sources":["../../src/scope/types.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EACV,WAAW,EACX,aAAa,EACb,aAAa,EACb,kBAAkB,EAClB,aAAa,EACb,IAAI,EACL,wBAAwB;AAEzB;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,WAAW,GAAG,aAAa,CAAC;AAC9D;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,IAAI,CAAC,qBAAqB,EAAE,UAAU,CAAC,GAAG;IAC1E,UAAU,CAAC,EAAE,aAAa,EAAE,CAAC;IAC7B,QAAQ,CAAC,EAAE,aAAa,EAAE,CAAC;CAC5B,CAAC;AACF;;;GAGG;AACH,MAAM,MAAM,oBAAoB,GAAG,MAAM,CACvC,mBAAmB,EACnB,mBAAmB,CACpB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAAG,WAAW,GAAG,kBAAkB,CAAC,MAAM,CAAC;AAE1E;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,QAAQ,EAAE,aAAa,EAAE,CAAC;CAC3B,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,oBAAoB,GAAG,MAAM,CAAC,WAAW,EAAE,mBAAmB,CAAC,GAAG;IAC5E,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC,EAAE,mBAAmB,CAAC;CACnD,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,aAAa,EAAE,MAAM,EAAE,CAAC;IACxB,QAAQ,EAAE,aAAa,EAAE,CAAC;IAC1B,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IACxB,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;CACzB,CAAC;AACF;;;;;;;GAOG;AACH,MAAM,MAAM,sBAAsB,GAAG,MAAM,CACzC,WAAW,EACX,qBAAqB,CACtB,GAAG;IACF,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC,EAAE,qBAAqB,CAAC;CACrD,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,GAAG;IACzE,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;CACpD,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,gBACd,MAAM,KAClB;IACD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;CAYpB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,2BAA2B,GAAG,OAAO,CAC/C,kBAAkB,EAClB,kBAAkB,CAAC,MAAM,CAC1B,CAAC"}

package/dist/scope/types.d.mts

@@ -0,0 +1,81 @@
+import type { CaipChainId, CaipReference, CaipAccountId, KnownCaipNamespace, CaipNamespace, Json } from "@metamask/utils";
+/**
+ * Represents a `scopeString` as defined in [CAIP-217](https://chainagnostic.org/CAIPs/caip-217).
+ */
+export type ExternalScopeString = CaipChainId | CaipNamespace;
+/**
+ * Represents a `scopeObject` as defined in [CAIP-217](https://chainagnostic.org/CAIPs/caip-217).
+ */
+export type ExternalScopeObject = Omit<NormalizedScopeObject, 'accounts'> & {
+    references?: CaipReference[];
+    accounts?: CaipAccountId[];
+};
+/**
+ * Represents a `scope` as defined in [CAIP-217](https://chainagnostic.org/CAIPs/caip-217).
+ * TODO update the language in CAIP-217 to use "scope" instead of "scopeObject" for this full record type.
+ */
+export type ExternalScopesObject = Record<ExternalScopeString, ExternalScopeObject>;
+/**
+ * Represents a `scopeString` as defined in
+ * [CAIP-217](https://chainagnostic.org/CAIPs/caip-217), with the exception that
+ * CAIP namespaces without a reference (aside from "wallet") are disallowed for our internal representations of CAIP-25 session scopes
+ */
+export type InternalScopeString = CaipChainId | KnownCaipNamespace.Wallet;
+/**
+ * A trimmed down version of a [CAIP-217](https://chainagnostic.org/CAIPs/caip-217) defined scopeObject that is stored in a `endowment:caip25` permission.
+ * The only property from the original CAIP-25 scopeObject that we use for permissioning is `accounts`.
+ */
+export type InternalScopeObject = {
+    accounts: CaipAccountId[];
+};
+/**
+ * A trimmed down version of a [CAIP-217](https://chainagnostic.org/CAIPs/caip-217) scope that is stored in a `endowment:caip25` permission.
+ * Accounts arrays are mapped to CAIP-2 chainIds. These are currently the only properties used by the permission system.
+ */
+export type InternalScopesObject = Record<CaipChainId, InternalScopeObject> & {
+    [KnownCaipNamespace.Wallet]?: InternalScopeObject;
+};
+/**
+ * Represents a `scopeObject` as defined in
+ * [CAIP-217](https://chainagnostic.org/CAIPs/caip-217), with the exception that
+ * we resolve the `references` property into a scopeObject per reference and
+ * assign an empty array to the `accounts` property if not already defined
+ * to more easily perform support checks for `wallet_createSession` requests.
+ * Also used as the return type for `wallet_createSession` and `wallet_sessionChanged`.
+ */
+export type NormalizedScopeObject = {
+    methods: string[];
+    notifications: string[];
+    accounts: CaipAccountId[];
+    rpcDocuments?: string[];
+    rpcEndpoints?: string[];
+};
+/**
+ * Represents a keyed `scopeObject` as defined in
+ * [CAIP-217](https://chainagnostic.org/CAIPs/caip-217), with the exception that
+ * we resolve the `references` property into a scopeObject per reference and
+ * assign an empty array to the `accounts` property if not already defined
+ * to more easily perform support checks for `wallet_createSession` requests.
+ * Also used as the return type for `wallet_createSession` and `wallet_sessionChanged`.
+ */
+export type NormalizedScopesObject = Record<CaipChainId, NormalizedScopeObject> & {
+    [KnownCaipNamespace.Wallet]?: NormalizedScopeObject;
+};
+export type ScopedProperties = Record<CaipChainId, Record<string, Json>> & {
+    [KnownCaipNamespace.Wallet]?: Record<string, Json>;
+};
+/**
+ * Parses a scope string into a namespace and reference.
+ *
+ * @param scopeString - The scope string to parse.
+ * @returns An object containing the namespace and reference.
+ */
+export declare const parseScopeString: (scopeString: string) => {
+    namespace?: string;
+    reference?: string;
+};
+/**
+ * CAIP namespaces excluding "wallet" currently supported by/known to the wallet.
+ */
+export type NonWalletKnownCaipNamespace = Exclude<KnownCaipNamespace, KnownCaipNamespace.Wallet>;
+//# sourceMappingURL=types.d.mts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.mts","sourceRoot":"","sources":["../../src/scope/types.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EACV,WAAW,EACX,aAAa,EACb,aAAa,EACb,kBAAkB,EAClB,aAAa,EACb,IAAI,EACL,wBAAwB;AAEzB;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,WAAW,GAAG,aAAa,CAAC;AAC9D;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,IAAI,CAAC,qBAAqB,EAAE,UAAU,CAAC,GAAG;IAC1E,UAAU,CAAC,EAAE,aAAa,EAAE,CAAC;IAC7B,QAAQ,CAAC,EAAE,aAAa,EAAE,CAAC;CAC5B,CAAC;AACF;;;GAGG;AACH,MAAM,MAAM,oBAAoB,GAAG,MAAM,CACvC,mBAAmB,EACnB,mBAAmB,CACpB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAAG,WAAW,GAAG,kBAAkB,CAAC,MAAM,CAAC;AAE1E;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,QAAQ,EAAE,aAAa,EAAE,CAAC;CAC3B,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,oBAAoB,GAAG,MAAM,CAAC,WAAW,EAAE,mBAAmB,CAAC,GAAG;IAC5E,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC,EAAE,mBAAmB,CAAC;CACnD,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,aAAa,EAAE,MAAM,EAAE,CAAC;IACxB,QAAQ,EAAE,aAAa,EAAE,CAAC;IAC1B,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IACxB,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;CACzB,CAAC;AACF;;;;;;;GAOG;AACH,MAAM,MAAM,sBAAsB,GAAG,MAAM,CACzC,WAAW,EACX,qBAAqB,CACtB,GAAG;IACF,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC,EAAE,qBAAqB,CAAC;CACrD,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,GAAG;IACzE,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;CACpD,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,gBACd,MAAM,KAClB;IACD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;CAYpB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,2BAA2B,GAAG,OAAO,CAC/C,kBAAkB,EAClB,kBAAkB,CAAC,MAAM,CAC1B,CAAC"}

package/dist/scope/types.mjs

@@ -0,0 +1,19 @@
+import { isCaipNamespace, isCaipChainId, parseCaipChainId } from "@metamask/utils";
+/**
+ * Parses a scope string into a namespace and reference.
+ *
+ * @param scopeString - The scope string to parse.
+ * @returns An object containing the namespace and reference.
+ */
+export const parseScopeString = (scopeString) => {
+    if (isCaipNamespace(scopeString)) {
+        return {
+            namespace: scopeString,
+        };
+    }
+    if (isCaipChainId(scopeString)) {
+        return parseCaipChainId(scopeString);
+    }
+    return {};
+};
+//# sourceMappingURL=types.mjs.map

package/dist/scope/types.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.mjs","sourceRoot":"","sources":["../../src/scope/types.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,eAAe,EACf,aAAa,EACb,gBAAgB,EACjB,wBAAwB;AAuFzB;;;;;GAKG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAC9B,WAAmB,EAInB,EAAE;IACF,IAAI,eAAe,CAAC,WAAW,CAAC,EAAE;QAChC,OAAO;YACL,SAAS,EAAE,WAAW;SACvB,CAAC;KACH;IACD,IAAI,aAAa,CAAC,WAAW,CAAC,EAAE;QAC9B,OAAO,gBAAgB,CAAC,WAAW,CAAC,CAAC;KACtC;IAED,OAAO,EAAE,CAAC;AACZ,CAAC,CAAC","sourcesContent":["import {\n  isCaipNamespace,\n  isCaipChainId,\n  parseCaipChainId,\n} from '@metamask/utils';\nimport type {\n  CaipChainId,\n  CaipReference,\n  CaipAccountId,\n  KnownCaipNamespace,\n  CaipNamespace,\n  Json,\n} from '@metamask/utils';\n\n/**\n * Represents a `scopeString` as defined in [CAIP-217](https://chainagnostic.org/CAIPs/caip-217).\n */\nexport type ExternalScopeString = CaipChainId | CaipNamespace;\n/**\n * Represents a `scopeObject` as defined in [CAIP-217](https://chainagnostic.org/CAIPs/caip-217).\n */\nexport type ExternalScopeObject = Omit<NormalizedScopeObject, 'accounts'> & {\n  references?: CaipReference[];\n  accounts?: CaipAccountId[];\n};\n/**\n * Represents a `scope` as defined in [CAIP-217](https://chainagnostic.org/CAIPs/caip-217).\n * TODO update the language in CAIP-217 to use \"scope\" instead of \"scopeObject\" for this full record type.\n */\nexport type ExternalScopesObject = Record<\n  ExternalScopeString,\n  ExternalScopeObject\n>;\n\n/**\n * Represents a `scopeString` as defined in\n * [CAIP-217](https://chainagnostic.org/CAIPs/caip-217), with the exception that\n * CAIP namespaces without a reference (aside from \"wallet\") are disallowed for our internal representations of CAIP-25 session scopes\n */\nexport type InternalScopeString = CaipChainId | KnownCaipNamespace.Wallet;\n\n/**\n * A trimmed down version of a [CAIP-217](https://chainagnostic.org/CAIPs/caip-217) defined scopeObject that is stored in a `endowment:caip25` permission.\n * The only property from the original CAIP-25 scopeObject that we use for permissioning is `accounts`.\n */\nexport type InternalScopeObject = {\n  accounts: CaipAccountId[];\n};\n\n/**\n * A trimmed down version of a [CAIP-217](https://chainagnostic.org/CAIPs/caip-217) scope that is stored in a `endowment:caip25` permission.\n * Accounts arrays are mapped to CAIP-2 chainIds. These are currently the only properties used by the permission system.\n */\nexport type InternalScopesObject = Record<CaipChainId, InternalScopeObject> & {\n  [KnownCaipNamespace.Wallet]?: InternalScopeObject;\n};\n\n/**\n * Represents a `scopeObject` as defined in\n * [CAIP-217](https://chainagnostic.org/CAIPs/caip-217), with the exception that\n * we resolve the `references` property into a scopeObject per reference and\n * assign an empty array to the `accounts` property if not already defined\n * to more easily perform support checks for `wallet_createSession` requests.\n * Also used as the return type for `wallet_createSession` and `wallet_sessionChanged`.\n */\nexport type NormalizedScopeObject = {\n  methods: string[];\n  notifications: string[];\n  accounts: CaipAccountId[];\n  rpcDocuments?: string[];\n  rpcEndpoints?: string[];\n};\n/**\n * Represents a keyed `scopeObject` as defined in\n * [CAIP-217](https://chainagnostic.org/CAIPs/caip-217), with the exception that\n * we resolve the `references` property into a scopeObject per reference and\n * assign an empty array to the `accounts` property if not already defined\n * to more easily perform support checks for `wallet_createSession` requests.\n * Also used as the return type for `wallet_createSession` and `wallet_sessionChanged`.\n */\nexport type NormalizedScopesObject = Record<\n  CaipChainId,\n  NormalizedScopeObject\n> & {\n  [KnownCaipNamespace.Wallet]?: NormalizedScopeObject;\n};\n\nexport type ScopedProperties = Record<CaipChainId, Record<string, Json>> & {\n  [KnownCaipNamespace.Wallet]?: Record<string, Json>;\n};\n\n/**\n * Parses a scope string into a namespace and reference.\n *\n * @param scopeString - The scope string to parse.\n * @returns An object containing the namespace and reference.\n */\nexport const parseScopeString = (\n  scopeString: string,\n): {\n  namespace?: string;\n  reference?: string;\n} => {\n  if (isCaipNamespace(scopeString)) {\n    return {\n      namespace: scopeString,\n    };\n  }\n  if (isCaipChainId(scopeString)) {\n    return parseCaipChainId(scopeString);\n  }\n\n  return {};\n};\n\n/**\n * CAIP namespaces excluding \"wallet\" currently supported by/known to the wallet.\n */\nexport type NonWalletKnownCaipNamespace = Exclude<\n  KnownCaipNamespace,\n  KnownCaipNamespace.Wallet\n>;\n"]}

package/dist/scope/validation.cjs

@@ -0,0 +1,87 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getValidScopes = exports.isValidScope = void 0;
+const utils_1 = require("@metamask/utils");
+const types_1 = require("./types.cjs");
+/**
+ * Validates a scope object according to the [CAIP-217](https://chainagnostic.org/CAIPs/caip-217) spec.
+ *
+ * @param scopeString - The scope string to validate.
+ * @param scopeObject - The scope object to validate.
+ * @returns A boolean indicating if the scope object is valid according to the [CAIP-217](https://chainagnostic.org/CAIPs/caip-217) spec.
+ */
+const isValidScope = (scopeString, scopeObject) => {
+    const { namespace, reference } = (0, types_1.parseScopeString)(scopeString);
+    // Namespace is required
+    if (!namespace) {
+        return false;
+    }
+    const { references, methods, notifications, accounts, rpcDocuments, rpcEndpoints, ...extraProperties } = scopeObject;
+    // Methods and notifications are required
+    if (!methods || !notifications) {
+        return false;
+    }
+    // For namespaces other than 'wallet', either reference or non-empty references array must be present
+    if (namespace !== 'wallet' &&
+        !reference &&
+        (!references || references.length === 0)) {
+        return false;
+    }
+    // If references are present, reference must be absent and all references must be valid
+    if (references) {
+        if (reference) {
+            return false;
+        }
+        const areReferencesValid = references.every((nestedReference) => (0, utils_1.isCaipReference)(nestedReference));
+        if (!areReferencesValid) {
+            return false;
+        }
+    }
+    const areMethodsValid = methods.every((method) => typeof method === 'string' && method.trim() !== '');
+    if (!areMethodsValid) {
+        return false;
+    }
+    const areNotificationsValid = notifications.every((notification) => typeof notification === 'string' && notification.trim() !== '');
+    if (!areNotificationsValid) {
+        return false;
+    }
+    // Ensure no unexpected properties are present in the scope object
+    if (Object.keys(extraProperties).length > 0) {
+        return false;
+    }
+    return true;
+};
+exports.isValidScope = isValidScope;
+/**
+ * Filters out invalid scopes and returns valid sets of required and optional scopes according to the [CAIP-217](https://chainagnostic.org/CAIPs/caip-217) spec.
+ *
+ * @param requiredScopes - The required scopes to validate.
+ * @param optionalScopes - The optional scopes to validate.
+ * @returns An object containing valid required scopes and optional scopes.
+ */
+const getValidScopes = (requiredScopes, optionalScopes) => {
+    const validRequiredScopes = {};
+    for (const [scopeString, scopeObject] of Object.entries(requiredScopes || {})) {
+        if ((0, exports.isValidScope)(scopeString, scopeObject)) {
+            validRequiredScopes[scopeString] = {
+                accounts: [],
+                ...scopeObject,
+            };
+        }
+    }
+    const validOptionalScopes = {};
+    for (const [scopeString, scopeObject] of Object.entries(optionalScopes || {})) {
+        if ((0, exports.isValidScope)(scopeString, scopeObject)) {
+            validOptionalScopes[scopeString] = {
+                accounts: [],
+                ...scopeObject,
+            };
+        }
+    }
+    return {
+        validRequiredScopes,
+        validOptionalScopes,
+    };
+};
+exports.getValidScopes = getValidScopes;
+//# sourceMappingURL=validation.cjs.map

package/dist/scope/validation.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"validation.cjs","sourceRoot":"","sources":["../../src/scope/validation.ts"],"names":[],"mappings":";;;AAAA,2CAAkD;AAOlD,uCAA2C;AAE3C;;;;;;GAMG;AACI,MAAM,YAAY,GAAG,CAC1B,WAAgC,EAChC,WAAgC,EACvB,EAAE;IACX,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,GAAG,IAAA,wBAAgB,EAAC,WAAW,CAAC,CAAC;IAE/D,wBAAwB;IACxB,IAAI,CAAC,SAAS,EAAE;QACd,OAAO,KAAK,CAAC;KACd;IAED,MAAM,EACJ,UAAU,EACV,OAAO,EACP,aAAa,EACb,QAAQ,EACR,YAAY,EACZ,YAAY,EACZ,GAAG,eAAe,EACnB,GAAG,WAAW,CAAC;IAEhB,yCAAyC;IACzC,IAAI,CAAC,OAAO,IAAI,CAAC,aAAa,EAAE;QAC9B,OAAO,KAAK,CAAC;KACd;IAED,qGAAqG;IACrG,IACE,SAAS,KAAK,QAAQ;QACtB,CAAC,SAAS;QACV,CAAC,CAAC,UAAU,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,CAAC,EACxC;QACA,OAAO,KAAK,CAAC;KACd;IAED,uFAAuF;IACvF,IAAI,UAAU,EAAE;QACd,IAAI,SAAS,EAAE;YACb,OAAO,KAAK,CAAC;SACd;QAED,MAAM,kBAAkB,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC,eAAe,EAAE,EAAE,CAC9D,IAAA,uBAAe,EAAC,eAAe,CAAC,CACjC,CAAC;QAEF,IAAI,CAAC,kBAAkB,EAAE;YACvB,OAAO,KAAK,CAAC;SACd;KACF;IAED,MAAM,eAAe,GAAG,OAAO,CAAC,KAAK,CACnC,CAAC,MAAM,EAAE,EAAE,CAAC,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,CAAC,IAAI,EAAE,KAAK,EAAE,CAC/D,CAAC;IAEF,IAAI,CAAC,eAAe,EAAE;QACpB,OAAO,KAAK,CAAC;KACd;IAED,MAAM,qBAAqB,GAAG,aAAa,CAAC,KAAK,CAC/C,CAAC,YAAY,EAAE,EAAE,CACf,OAAO,YAAY,KAAK,QAAQ,IAAI,YAAY,CAAC,IAAI,EAAE,KAAK,EAAE,CACjE,CAAC;IAEF,IAAI,CAAC,qBAAqB,EAAE;QAC1B,OAAO,KAAK,CAAC;KACd;IAED,kEAAkE;IAClE,IAAI,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE;QAC3C,OAAO,KAAK,CAAC;KACd;IAED,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAzEW,QAAA,YAAY,gBAyEvB;AAEF;;;;;;GAMG;AACI,MAAM,cAAc,GAAG,CAC5B,cAAqC,EACrC,cAAqC,EACrC,EAAE;IACF,MAAM,mBAAmB,GAAyB,EAAE,CAAC;IACrD,KAAK,MAAM,CAAC,WAAW,EAAE,WAAW,CAAC,IAAI,MAAM,CAAC,OAAO,CACrD,cAAc,IAAI,EAAE,CACrB,EAAE;QACD,IAAI,IAAA,oBAAY,EAAC,WAAW,EAAE,WAAW,CAAC,EAAE;YAC1C,mBAAmB,CAAC,WAAW,CAAC,GAAG;gBACjC,QAAQ,EAAE,EAAE;gBACZ,GAAG,WAAW;aACf,CAAC;SACH;KACF;IAED,MAAM,mBAAmB,GAAyB,EAAE,CAAC;IACrD,KAAK,MAAM,CAAC,WAAW,EAAE,WAAW,CAAC,IAAI,MAAM,CAAC,OAAO,CACrD,cAAc,IAAI,EAAE,CACrB,EAAE;QACD,IAAI,IAAA,oBAAY,EAAC,WAAW,EAAE,WAAW,CAAC,EAAE;YAC1C,mBAAmB,CAAC,WAAW,CAAC,GAAG;gBACjC,QAAQ,EAAE,EAAE;gBACZ,GAAG,WAAW;aACf,CAAC;SACH;KACF;IAED,OAAO;QACL,mBAAmB;QACnB,mBAAmB;KACpB,CAAC;AACJ,CAAC,CAAC;AAhCW,QAAA,cAAc,kBAgCzB","sourcesContent":["import { isCaipReference } from '@metamask/utils';\n\nimport type {\n  ExternalScopeString,\n  ExternalScopeObject,\n  ExternalScopesObject,\n} from './types';\nimport { parseScopeString } from './types';\n\n/**\n * Validates a scope object according to the [CAIP-217](https://chainagnostic.org/CAIPs/caip-217) spec.\n *\n * @param scopeString - The scope string to validate.\n * @param scopeObject - The scope object to validate.\n * @returns A boolean indicating if the scope object is valid according to the [CAIP-217](https://chainagnostic.org/CAIPs/caip-217) spec.\n */\nexport const isValidScope = (\n  scopeString: ExternalScopeString,\n  scopeObject: ExternalScopeObject,\n): boolean => {\n  const { namespace, reference } = parseScopeString(scopeString);\n\n  // Namespace is required\n  if (!namespace) {\n    return false;\n  }\n\n  const {\n    references,\n    methods,\n    notifications,\n    accounts,\n    rpcDocuments,\n    rpcEndpoints,\n    ...extraProperties\n  } = scopeObject;\n\n  // Methods and notifications are required\n  if (!methods || !notifications) {\n    return false;\n  }\n\n  // For namespaces other than 'wallet', either reference or non-empty references array must be present\n  if (\n    namespace !== 'wallet' &&\n    !reference &&\n    (!references || references.length === 0)\n  ) {\n    return false;\n  }\n\n  // If references are present, reference must be absent and all references must be valid\n  if (references) {\n    if (reference) {\n      return false;\n    }\n\n    const areReferencesValid = references.every((nestedReference) =>\n      isCaipReference(nestedReference),\n    );\n\n    if (!areReferencesValid) {\n      return false;\n    }\n  }\n\n  const areMethodsValid = methods.every(\n    (method) => typeof method === 'string' && method.trim() !== '',\n  );\n\n  if (!areMethodsValid) {\n    return false;\n  }\n\n  const areNotificationsValid = notifications.every(\n    (notification) =>\n      typeof notification === 'string' && notification.trim() !== '',\n  );\n\n  if (!areNotificationsValid) {\n    return false;\n  }\n\n  // Ensure no unexpected properties are present in the scope object\n  if (Object.keys(extraProperties).length > 0) {\n    return false;\n  }\n\n  return true;\n};\n\n/**\n * Filters out invalid scopes and returns valid sets of required and optional scopes according to the [CAIP-217](https://chainagnostic.org/CAIPs/caip-217) spec.\n *\n * @param requiredScopes - The required scopes to validate.\n * @param optionalScopes - The optional scopes to validate.\n * @returns An object containing valid required scopes and optional scopes.\n */\nexport const getValidScopes = (\n  requiredScopes?: ExternalScopesObject,\n  optionalScopes?: ExternalScopesObject,\n) => {\n  const validRequiredScopes: ExternalScopesObject = {};\n  for (const [scopeString, scopeObject] of Object.entries(\n    requiredScopes || {},\n  )) {\n    if (isValidScope(scopeString, scopeObject)) {\n      validRequiredScopes[scopeString] = {\n        accounts: [],\n        ...scopeObject,\n      };\n    }\n  }\n\n  const validOptionalScopes: ExternalScopesObject = {};\n  for (const [scopeString, scopeObject] of Object.entries(\n    optionalScopes || {},\n  )) {\n    if (isValidScope(scopeString, scopeObject)) {\n      validOptionalScopes[scopeString] = {\n        accounts: [],\n        ...scopeObject,\n      };\n    }\n  }\n\n  return {\n    validRequiredScopes,\n    validOptionalScopes,\n  };\n};\n"]}

package/dist/scope/validation.d.cts

@@ -0,0 +1,21 @@
+import type { ExternalScopeString, ExternalScopeObject, ExternalScopesObject } from "./types.cjs";
+/**
+ * Validates a scope object according to the [CAIP-217](https://chainagnostic.org/CAIPs/caip-217) spec.
+ *
+ * @param scopeString - The scope string to validate.
+ * @param scopeObject - The scope object to validate.
+ * @returns A boolean indicating if the scope object is valid according to the [CAIP-217](https://chainagnostic.org/CAIPs/caip-217) spec.
+ */
+export declare const isValidScope: (scopeString: ExternalScopeString, scopeObject: ExternalScopeObject) => boolean;
+/**
+ * Filters out invalid scopes and returns valid sets of required and optional scopes according to the [CAIP-217](https://chainagnostic.org/CAIPs/caip-217) spec.
+ *
+ * @param requiredScopes - The required scopes to validate.
+ * @param optionalScopes - The optional scopes to validate.
+ * @returns An object containing valid required scopes and optional scopes.
+ */
+export declare const getValidScopes: (requiredScopes?: ExternalScopesObject, optionalScopes?: ExternalScopesObject) => {
+    validRequiredScopes: ExternalScopesObject;
+    validOptionalScopes: ExternalScopesObject;
+};
+//# sourceMappingURL=validation.d.cts.map