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

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

@@ -0,0 +1 @@
+{"version":3,"file":"validation.d.cts","sourceRoot":"","sources":["../../src/scope/validation.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EACV,mBAAmB,EACnB,mBAAmB,EACnB,oBAAoB,EACrB,oBAAgB;AAGjB;;;;;;GAMG;AACH,eAAO,MAAM,YAAY,gBACV,mBAAmB,eACnB,mBAAmB,KAC/B,OAsEF,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,cAAc,oBACR,oBAAoB,mBACpB,oBAAoB;;;CA8BtC,CAAC"}

package/dist/scope/validation.d.mts

@@ -0,0 +1,21 @@
+import type { ExternalScopeString, ExternalScopeObject, ExternalScopesObject } from "./types.mjs";
+/**
+ * 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.mts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"validation.d.mts","sourceRoot":"","sources":["../../src/scope/validation.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EACV,mBAAmB,EACnB,mBAAmB,EACnB,oBAAoB,EACrB,oBAAgB;AAGjB;;;;;;GAMG;AACH,eAAO,MAAM,YAAY,gBACV,mBAAmB,eACnB,mBAAmB,KAC/B,OAsEF,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,cAAc,oBACR,oBAAoB,mBACpB,oBAAoB;;;CA8BtC,CAAC"}

package/dist/scope/validation.mjs

@@ -0,0 +1,82 @@
+import { isCaipReference } from "@metamask/utils";
+import { parseScopeString } from "./types.mjs";
+/**
+ * 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 const isValidScope = (scopeString, scopeObject) => {
+    const { namespace, reference } = 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) => 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;
+};
+/**
+ * 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 const getValidScopes = (requiredScopes, optionalScopes) => {
+    const validRequiredScopes = {};
+    for (const [scopeString, scopeObject] of Object.entries(requiredScopes || {})) {
+        if (isValidScope(scopeString, scopeObject)) {
+            validRequiredScopes[scopeString] = {
+                accounts: [],
+                ...scopeObject,
+            };
+        }
+    }
+    const validOptionalScopes = {};
+    for (const [scopeString, scopeObject] of Object.entries(optionalScopes || {})) {
+        if (isValidScope(scopeString, scopeObject)) {
+            validOptionalScopes[scopeString] = {
+                accounts: [],
+                ...scopeObject,
+            };
+        }
+    }
+    return {
+        validRequiredScopes,
+        validOptionalScopes,
+    };
+};
+//# sourceMappingURL=validation.mjs.map

package/dist/scope/validation.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"validation.mjs","sourceRoot":"","sources":["../../src/scope/validation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,wBAAwB;AAOlD,OAAO,EAAE,gBAAgB,EAAE,oBAAgB;AAE3C;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAC1B,WAAgC,EAChC,WAAgC,EACvB,EAAE;IACX,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,GAAG,gBAAgB,CAAC,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,eAAe,CAAC,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;AAEF;;;;;;GAMG;AACH,MAAM,CAAC,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,YAAY,CAAC,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,YAAY,CAAC,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","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/package.json

@@ -0,0 +1,75 @@
+{
+  "name": "@metamask-previews/chain-agnostic-permission",
+  "version": "0.1.0-preview-b69c669",
+  "description": "Defines a CAIP-25 based endowment permission and helpers for interfacing with it",
+  "keywords": [
+    "MetaMask",
+    "Ethereum"
+  ],
+  "homepage": "https://github.com/MetaMask/core/tree/main/packages/chain-agnostic-permission#readme",
+  "bugs": {
+    "url": "https://github.com/MetaMask/core/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/MetaMask/core.git"
+  },
+  "license": "MIT",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.mts",
+        "default": "./dist/index.mjs"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "./dist/index.cjs",
+  "types": "./dist/index.d.cts",
+  "files": [
+    "dist/"
+  ],
+  "scripts": {
+    "build": "ts-bridge --project tsconfig.build.json --verbose --clean --no-references",
+    "build:docs": "typedoc",
+    "changelog:update": "../../scripts/update-changelog.sh @metamask/chain-agnostic-permission",
+    "changelog:validate": "../../scripts/validate-changelog.sh @metamask/chain-agnostic-permission",
+    "publish:preview": "yarn npm publish --tag preview",
+    "since-latest-release": "../../scripts/since-latest-release.sh",
+    "test": "NODE_OPTIONS=--experimental-vm-modules jest --reporters=jest-silent-reporter",
+    "test:clean": "NODE_OPTIONS=--experimental-vm-modules jest --clearCache",
+    "test:verbose": "NODE_OPTIONS=--experimental-vm-modules jest --verbose",
+    "test:watch": "NODE_OPTIONS=--experimental-vm-modules jest --watch"
+  },
+  "dependencies": {
+    "@metamask/api-specs": "^0.10.12",
+    "@metamask/controller-utils": "^11.6.0",
+    "@metamask/network-controller": "^22.2.1",
+    "@metamask/permission-controller": "^11.0.6",
+    "@metamask/rpc-errors": "^7.0.2",
+    "@metamask/utils": "^11.2.0",
+    "lodash": "^4.17.21"
+  },
+  "devDependencies": {
+    "@metamask/auto-changelog": "^3.4.4",
+    "@types/jest": "^27.4.1",
+    "deepmerge": "^4.2.2",
+    "jest": "^27.5.1",
+    "ts-jest": "^27.1.4",
+    "typedoc": "^0.24.8",
+    "typedoc-plugin-missing-exports": "^2.0.0",
+    "typescript": "~5.2.2"
+  },
+  "engines": {
+    "node": "^18.18 || >=20"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  }
+}