@metamask/snaps-utils 0.24.0

package/dist/versions.js

@@ -0,0 +1,77 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isValidSnapVersionRange = exports.resolveVersion = exports.getTargetVersion = exports.satisfiesVersionRange = exports.gtVersion = exports.DEFAULT_REQUESTED_SNAP_VERSION = void 0;
+const semver_1 = require("semver");
+exports.DEFAULT_REQUESTED_SNAP_VERSION = '*';
+/**
+ * Checks whether a SemVer version is greater than another.
+ *
+ * @param version1 - The left-hand version.
+ * @param version2 - The right-hand version.
+ * @returns `version1 > version2`.
+ */
+function gtVersion(version1, version2) {
+    return (0, semver_1.gt)(version1, version2, { includePrerelease: true });
+}
+exports.gtVersion = gtVersion;
+/**
+ * Returns whether a SemVer version satisfies a SemVer range.
+ *
+ * @param version - The SemVer version to check.
+ * @param versionRange - The SemVer version range to check against.
+ * @returns Whether the version satisfied the version range.
+ */
+function satisfiesVersionRange(version, versionRange) {
+    return (0, semver_1.satisfies)(version, versionRange, {
+        includePrerelease: true,
+    });
+}
+exports.satisfiesVersionRange = satisfiesVersionRange;
+/**
+ * Return the highest version in the list that satisfies the range, or `null` if
+ * none of them do. For the satisfaction check, pre-release versions will only
+ * be checked if no satisfactory non-prerelease version is found first.
+ *
+ * @param versions - The list of version to check.
+ * @param versionRange - The SemVer version range to check against.
+ * @returns The highest version in the list that satisfies the range,
+ * or `null` if none of them do.
+ */
+function getTargetVersion(versions, versionRange) {
+    const maxSatisfyingNonPreRelease = (0, semver_1.maxSatisfying)(versions, versionRange);
+    // By default don't use pre-release versions
+    if (maxSatisfyingNonPreRelease) {
+        return maxSatisfyingNonPreRelease;
+    }
+    // If no satisfying release version is found by default, try pre-release versions
+    return (0, semver_1.maxSatisfying)(versions, versionRange, {
+        includePrerelease: true,
+    });
+}
+exports.getTargetVersion = getTargetVersion;
+/**
+ * Parse a version received by some subject attempting to access a snap.
+ *
+ * @param version - The received version value.
+ * @returns `*` if the version is `undefined` or `latest", otherwise returns
+ * the specified version.
+ */
+function resolveVersion(version) {
+    if (version === undefined || version === 'latest') {
+        return exports.DEFAULT_REQUESTED_SNAP_VERSION;
+    }
+    return version;
+}
+exports.resolveVersion = resolveVersion;
+/**
+ * Checks whether a SemVer version range is valid.
+ *
+ * @param versionRange - A potential version range.
+ * @returns `true` if the version range is valid, and `false` otherwise.
+ */
+function isValidSnapVersionRange(versionRange) {
+    return Boolean(typeof versionRange === 'string' &&
+        (0, semver_1.validRange)(versionRange, { includePrerelease: true }) !== null);
+}
+exports.isValidSnapVersionRange = isValidSnapVersionRange;
+//# sourceMappingURL=versions.js.map

package/dist/versions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"versions.js","sourceRoot":"","sources":["../src/versions.ts"],"names":[],"mappings":";;;AACA,mCAKgB;AAEH,QAAA,8BAA8B,GAAG,GAAG,CAAC;AAElD;;;;;;GAMG;AACH,SAAgB,SAAS,CAAC,QAAgB,EAAE,QAAgB;IAC1D,OAAO,IAAA,WAAQ,EAAC,QAAQ,EAAE,QAAQ,EAAE,EAAE,iBAAiB,EAAE,IAAI,EAAE,CAAC,CAAC;AACnE,CAAC;AAFD,8BAEC;AAED;;;;;;GAMG;AACH,SAAgB,qBAAqB,CACnC,OAAe,EACf,YAAoB;IAEpB,OAAO,IAAA,kBAAe,EAAC,OAAO,EAAE,YAAY,EAAE;QAC5C,iBAAiB,EAAE,IAAI;KACxB,CAAC,CAAC;AACL,CAAC;AAPD,sDAOC;AAED;;;;;;;;;GASG;AACH,SAAgB,gBAAgB,CAC9B,QAAkB,EAClB,YAAoB;IAEpB,MAAM,0BAA0B,GAAG,IAAA,sBAAmB,EACpD,QAAQ,EACR,YAAY,CACb,CAAC;IAEF,4CAA4C;IAC5C,IAAI,0BAA0B,EAAE;QAC9B,OAAO,0BAA0B,CAAC;KACnC;IAED,iFAAiF;IACjF,OAAO,IAAA,sBAAmB,EAAC,QAAQ,EAAE,YAAY,EAAE;QACjD,iBAAiB,EAAE,IAAI;KACxB,CAAC,CAAC;AACL,CAAC;AAlBD,4CAkBC;AAED;;;;;;GAMG;AACH,SAAgB,cAAc,CAAC,OAAc;IAC3C,IAAI,OAAO,KAAK,SAAS,IAAI,OAAO,KAAK,QAAQ,EAAE;QACjD,OAAO,sCAA8B,CAAC;KACvC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AALD,wCAKC;AAED;;;;;GAKG;AACH,SAAgB,uBAAuB,CACrC,YAAqB;IAErB,OAAO,OAAO,CACZ,OAAO,YAAY,KAAK,QAAQ;QAC9B,IAAA,mBAAgB,EAAC,YAAY,EAAE,EAAE,iBAAiB,EAAE,IAAI,EAAE,CAAC,KAAK,IAAI,CACvE,CAAC;AACJ,CAAC;AAPD,0DAOC","sourcesContent":["import { Json } from '@metamask/utils';\nimport {\n  gt as gtSemver,\n  maxSatisfying as maxSatisfyingSemver,\n  satisfies as satisfiesSemver,\n  validRange as validRangeSemver,\n} from 'semver';\n\nexport const DEFAULT_REQUESTED_SNAP_VERSION = '*';\n\n/**\n * Checks whether a SemVer version is greater than another.\n *\n * @param version1 - The left-hand version.\n * @param version2 - The right-hand version.\n * @returns `version1 > version2`.\n */\nexport function gtVersion(version1: string, version2: string): boolean {\n  return gtSemver(version1, version2, { includePrerelease: true });\n}\n\n/**\n * Returns whether a SemVer version satisfies a SemVer range.\n *\n * @param version - The SemVer version to check.\n * @param versionRange - The SemVer version range to check against.\n * @returns Whether the version satisfied the version range.\n */\nexport function satisfiesVersionRange(\n  version: string,\n  versionRange: string,\n): boolean {\n  return satisfiesSemver(version, versionRange, {\n    includePrerelease: true,\n  });\n}\n\n/**\n * Return the highest version in the list that satisfies the range, or `null` if\n * none of them do. For the satisfaction check, pre-release versions will only\n * be checked if no satisfactory non-prerelease version is found first.\n *\n * @param versions - The list of version to check.\n * @param versionRange - The SemVer version range to check against.\n * @returns The highest version in the list that satisfies the range,\n * or `null` if none of them do.\n */\nexport function getTargetVersion(\n  versions: string[],\n  versionRange: string,\n): string | null {\n  const maxSatisfyingNonPreRelease = maxSatisfyingSemver(\n    versions,\n    versionRange,\n  );\n\n  // By default don't use pre-release versions\n  if (maxSatisfyingNonPreRelease) {\n    return maxSatisfyingNonPreRelease;\n  }\n\n  // If no satisfying release version is found by default, try pre-release versions\n  return maxSatisfyingSemver(versions, versionRange, {\n    includePrerelease: true,\n  });\n}\n\n/**\n * Parse a version received by some subject attempting to access a snap.\n *\n * @param version - The received version value.\n * @returns `*` if the version is `undefined` or `latest\", otherwise returns\n * the specified version.\n */\nexport function resolveVersion(version?: Json): Json {\n  if (version === undefined || version === 'latest') {\n    return DEFAULT_REQUESTED_SNAP_VERSION;\n  }\n  return version;\n}\n\n/**\n * Checks whether a SemVer version range is valid.\n *\n * @param versionRange - A potential version range.\n * @returns `true` if the version range is valid, and `false` otherwise.\n */\nexport function isValidSnapVersionRange(\n  versionRange: unknown,\n): versionRange is string {\n  return Boolean(\n    typeof versionRange === 'string' &&\n      validRangeSemver(versionRange, { includePrerelease: true }) !== null,\n  );\n}\n"]}

package/package.json

@@ -0,0 +1,100 @@
+{
+  "name": "@metamask/snaps-utils",
+  "version": "0.24.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/MetaMask/snaps-monorepo.git"
+  },
+  "exports": {
+    ".": {
+      "browser": {
+        "default": "./dist/index.browser.js"
+      },
+      "import": "./dist/index.js",
+      "require": "./dist/index.js"
+    },
+    "./test-utils": {
+      "import": "./dist/test-utils/index.js",
+      "require": "./dist/test-utils/index.js"
+    }
+  },
+  "main": "dist/index.js",
+  "browser": {
+    "./dist/index": "./dist/index.browser.js"
+  },
+  "typesVersions": {
+    "*": {
+      "*": [
+        "dist/index.d.ts"
+      ],
+      "test-utils": [
+        "dist/test-utils/index.d.ts"
+      ]
+    }
+  },
+  "files": [
+    "dist/"
+  ],
+  "scripts": {
+    "test": "jest && yarn posttest",
+    "posttest": "jest-it-up --margin 0.25",
+    "test:ci": "yarn test",
+    "lint:eslint": "eslint . --cache --ext js,ts",
+    "lint:misc": "prettier '**/*.json' '**/*.md' '!CHANGELOG.md' --ignore-path ../../.gitignore",
+    "lint": "yarn lint:eslint && yarn lint:misc --check",
+    "lint:fix": "yarn lint:eslint --fix && yarn lint:misc --write",
+    "lint:changelog": "yarn auto-changelog validate",
+    "build": "tsc --project tsconfig.build.json",
+    "build:clean": "yarn clean && yarn build",
+    "clean": "rimraf '*.tsbuildinfo' 'dist/*'",
+    "publish:package": "../../scripts/publish-package.sh"
+  },
+  "dependencies": {
+    "@babel/core": "^7.18.6",
+    "@babel/types": "^7.18.7",
+    "@metamask/snaps-types": "^0.24.0",
+    "@metamask/utils": "^3.3.1",
+    "@noble/hashes": "^1.1.3",
+    "@scure/base": "^1.1.1",
+    "cron-parser": "^4.5.0",
+    "eth-rpc-errors": "^4.0.3",
+    "fast-deep-equal": "^3.1.3",
+    "rfdc": "^1.3.0",
+    "semver": "^7.3.7",
+    "ses": "^0.17.0",
+    "superstruct": "^0.16.7"
+  },
+  "devDependencies": {
+    "@lavamoat/allow-scripts": "^2.0.3",
+    "@metamask/auto-changelog": "^2.6.0",
+    "@metamask/eslint-config": "^9.0.0",
+    "@metamask/eslint-config-jest": "^9.0.0",
+    "@metamask/eslint-config-nodejs": "^9.0.0",
+    "@metamask/eslint-config-typescript": "^9.0.1",
+    "@types/jest": "^27.5.1",
+    "@types/semver": "^7.3.10",
+    "deepmerge": "^4.2.2",
+    "eslint": "^7.30.0",
+    "eslint-config-prettier": "^8.3.0",
+    "eslint-plugin-import": "^2.23.4",
+    "eslint-plugin-jest": "^24.4.0",
+    "eslint-plugin-jsdoc": "^36.1.0",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-prettier": "^3.4.0",
+    "jest": "^29.0.2",
+    "jest-it-up": "^2.0.0",
+    "memfs": "^3.4.7",
+    "prettier": "^2.3.2",
+    "prettier-plugin-packagejson": "^2.2.11",
+    "rimraf": "^3.0.2",
+    "ts-jest": "^29.0.0",
+    "typescript": "^4.4.0"
+  },
+  "engines": {
+    "node": ">=16.0.0"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  }
+}