@vltpkg/dep-id 0.0.0-0.1730239248325

package/LICENSE

@@ -0,0 +1,15 @@
+Copyright (c) vlt technology, Inc.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+   Subject to the terms and conditions of this license, each copyright holder and contributor hereby grants to those receiving rights under this license a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except for failure to satisfy the conditions of this license) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer this software, where such license applies only to those patent claims, already acquired or hereafter acquired, licensable by such copyright holder or contributor that are necessarily infringed by:
+
+(a) their Contribution(s) (the licensed copyrights of copyright holders and non-copyrightable additions of contributors, in source or binary form) alone; or
+(b) combination of their Contribution(s) with the work of authorship to which such Contribution(s) was added by such copyright holder or contributor, if, at the time the Contribution is added, such addition causes such combination to be necessarily infringed. The patent license shall not apply to any other combinations which include the Contribution.
+Except as expressly stated above, no rights or licenses from any copyright holder or contributor is granted under this license, whether expressly, by implication, estoppel or otherwise.
+
+DISCLAIMER
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -0,0 +1,55 @@
+# `@vltpkg/dep-id`
+
+A library for serializing dependencies into terse string
+identifiers, and turning those serialized identifiers back into
+`Spec` objects.
+
+## USAGE
+
+```js
+import {
+  getId,
+  getTuple,
+  hydrate,
+  hydrateTuple,
+  joinDepIDTuple,
+  splitDepID,
+} from '@vltpkg/dep-id'
+import { manifest } from '@vltpkg/package-info'
+
+{
+  // default registry
+  const spec = Spec.parse('x@latest')
+  const mani = await manifest(spec)
+  const id = getId(spec, mani) // registry;;x@1.2.3
+}
+
+{
+  // not default registry
+  const spec = Spec.parse('x@vlt:y@latest', {
+    registries: { vlt: 'http://vlt.sh' },
+  })
+  const mani = await manifest(spec)
+  const id = getId(spec, mani) // registry;vlt;y@latest
+}
+
+{
+  // git, hosted
+  const spec = Spec.parse('x@github:a/b#branch')
+  const mani = await manifest(spec)
+  const id = getId(spec, mani) // git;github:a/b;branch
+}
+
+// Hydrate by providing a name, and options for the spec creation
+const spec = hydrate('git;github:a/b;branch', 'x') // x@github:a/b#branch
+```
+
+Note: multiple different spec/manifest combinations _can_ result
+in the same identifier. For example, the specifiers
+`x@npm:y@latest` and `asdf@npm:y@1.x` might both ultimately
+resolve to the same package, so they only need to appear in the
+store once.
+
+## BROWSER API
+
+An isomorphic API `@vltpkg/dep-id/browser` is provided for use in the browser.

package/dist/esm/browser.d.ts

@@ -0,0 +1,54 @@
+export declare const delimiter: Delimiter;
+export type Delimiter = '·';
+/**
+ * Dependency IDs are a URI-encoded set of strings, separated
+ * by the {@link Delimiter} character (`'·'`).
+ *
+ * The first entry is always the specifier type. The rest depend on the
+ * type. `git`, `registry`, and `workspace` entries have 3 fields, the rest
+ * have 2.
+ *
+ * - `registry`: `'registry·<registry>·name@specifier'`
+ *   The `<registry>` portion can be a known named registry name, or a
+ *   url to a registry. If empty, it is the default registry.
+ *   Examples:
+ *   - `··some-package@2.0.1`
+ *   - `·npm·whatever@1.2.3'
+ *   - `·http%3A%2F%2Fvlt.sh%2F·x@1.2.3`
+ * - `git`: `'git·<git remote>·<git selector>`. For example:
+ *   - `git·github:user/project·branchname`
+ *   - `git·git%2Bssh%3A%2F%2Fuser%40host%3Aproject.git·semver:1.x`
+ * - `workspace`: `'workspace·<path>`. For example:
+ *   - `workspace·src/mything`
+ * - `remote`: `'remote·<url>'`
+ * - `file`: `'file·<path>`
+ *
+ * Lastly, the final portion can contain arbitrary string data, and is
+ * used to store peer dep resolutions to maintain the peerDep contract.
+ */
+export type DepID = `${'' | 'git'}${Delimiter}${string}${Delimiter}${string}${Delimiter}${string}` | `${'' | 'git'}${Delimiter}${string}${Delimiter}${string}` | `${'file' | 'remote' | 'workspace'}${Delimiter}${string}${Delimiter}${string}` | `${'file' | 'remote' | 'workspace'}${Delimiter}${string}`;
+/**
+ * A {@link DepID}, split apart and URI-decoded
+ */
+export type DepIDTuple = [
+    type: 'git',
+    gitRemote: string,
+    gitSelector: string,
+    extra?: string
+] | [
+    type: 'registry',
+    registry: string,
+    registrySpec: string,
+    extra?: string
+] | [type: 'file', path: string, extra?: string] | [type: 'remote', url: string, extra?: string] | [type: 'workspace', workspace: string, extra?: string];
+export declare const isDepID: (str: unknown) => str is DepID;
+export declare const asDepID: (str: string) => DepID;
+/**
+ * turn a {@link DepIDTuple} into a {@link DepID}
+ */
+export declare const joinDepIDTuple: (list: DepIDTuple) => DepID;
+/**
+ * turn a {@link DepID} into a {@link DepIDTuple}
+ */
+export declare const splitDepID: (id: string) => DepIDTuple;
+//# sourceMappingURL=browser.d.ts.map

package/dist/esm/browser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"browser.d.ts","sourceRoot":"","sources":["../../src/browser.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,SAAS,EAAE,SAAe,CAAA;AACvC,MAAM,MAAM,SAAS,GAAG,GAAG,CAAA;AAE3B;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,MAAM,KAAK,GACb,GAAG,EAAE,GAAG,KAAK,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,GAAG,MAAM,EAAE,GAC9E,GAAG,EAAE,GAAG,KAAK,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,GAAG,MAAM,EAAE,GACzD,GAAG,MAAM,GAAG,QAAQ,GAAG,WAAW,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,GAAG,MAAM,EAAE,GAC9E,GAAG,MAAM,GAAG,QAAQ,GAAG,WAAW,GAAG,SAAS,GAAG,MAAM,EAAE,CAAA;AAE7D;;GAEG;AACH,MAAM,MAAM,UAAU,GAClB;IACE,IAAI,EAAE,KAAK;IACX,SAAS,EAAE,MAAM;IACjB,WAAW,EAAE,MAAM;IACnB,KAAK,CAAC,EAAE,MAAM;CACf,GACD;IACE,IAAI,EAAE,UAAU;IAChB,QAAQ,EAAE,MAAM;IAChB,YAAY,EAAE,MAAM;IACpB,KAAK,CAAC,EAAE,MAAM;CACf,GACD,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,CAAC,GAC5C,CAAC,IAAI,EAAE,QAAQ,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,CAAC,GAC7C,CAAC,IAAI,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,CAAC,CAAA;AAY1D,eAAO,MAAM,OAAO,QAAS,OAAO,KAAG,GAAG,IAAI,KACI,CAAA;AAElD,eAAO,MAAM,OAAO,QAAS,MAAM,KAAG,KAOrC,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,cAAc,SAAU,UAAU,KAAG,KAWjD,CAAA;AAMD;;GAEG;AACH,eAAO,MAAM,UAAU,OAAQ,MAAM,KAAG,UA+BvC,CAAA"}

package/dist/esm/browser.js

@@ -0,0 +1,69 @@
+import { error } from '@vltpkg/error-cause';
+export const delimiter = '·';
+const depIDRegExp = new RegExp(`^((git)?${delimiter}[^${delimiter}]*${delimiter}[^${delimiter}]*(${delimiter}[^${delimiter}]*)?$` +
+    `|` +
+    `^(file|remote|workspace)${delimiter}[^${delimiter}]*)(${delimiter}[^${delimiter}]*)?$`);
+export const isDepID = (str) => typeof str === 'string' && depIDRegExp.test(str);
+export const asDepID = (str) => {
+    if (!isDepID(str)) {
+        throw error('Expected dep id', {
+            found: str,
+        });
+    }
+    return str;
+};
+/**
+ * turn a {@link DepIDTuple} into a {@link DepID}
+ */
+export const joinDepIDTuple = (list) => {
+    const [type, first, second, extra] = list;
+    const f = encode(first);
+    switch (type) {
+        case 'registry':
+            return `${delimiter}${f}${delimiter}${encode(second)}${extra ? `${delimiter}${encode(extra)}` : ''}`;
+        case 'git':
+            return `${type}${delimiter}${f}${delimiter}${encode(second)}${extra ? `${delimiter}${encode(extra)}` : ''}`;
+        default:
+            return `${type}${delimiter}${f}${second ? `${delimiter}${encode(second)}` : ''}`;
+    }
+};
+// allow @, but otherwise, escape everything urls do
+const encode = (s) => encodeURIComponent(s).replaceAll('%40', '@');
+/**
+ * turn a {@link DepID} into a {@link DepIDTuple}
+ */
+export const splitDepID = (id) => {
+    const [type, first = '', second, extra] = id.split(delimiter, 4);
+    const f = decodeURIComponent(first);
+    switch (type) {
+        case 'git':
+        case '': {
+            if (second === undefined) {
+                throw error(`invalid ${type} id`, { found: id });
+            }
+            const t = [
+                type || 'registry',
+                f,
+                decodeURIComponent(second),
+            ];
+            if (extra)
+                t.push(decodeURIComponent(extra));
+            return t;
+        }
+        case 'file':
+        case 'remote':
+        case 'workspace': {
+            const t = [type, f];
+            if (second)
+                t.push(decodeURIComponent(second));
+            return t;
+        }
+        default: {
+            throw error('invalid DepID type', {
+                found: type,
+                validOptions: ['git', 'file', 'workspace', 'remote', ''],
+            });
+        }
+    }
+};
+//# sourceMappingURL=browser.js.map

package/dist/esm/browser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"browser.js","sourceRoot":"","sources":["../../src/browser.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,qBAAqB,CAAA;AAE3C,MAAM,CAAC,MAAM,SAAS,GAAc,GAAG,CAAA;AAuDvC,MAAM,WAAW,GAAG,IAAI,MAAM,CAC5B,WAAW,SAAS,KAAK,SAAS,KAAK,SAAS,KAAK,SAAS,MAC5D,SACF,KAAK,SAAS,OAAO;IACnB,GAAG;IACH,2BAA2B,SAAS,KAClC,SACF,OAAO,SAAS,KAAK,SAAS,OAAO,CACxC,CAAA;AAED,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,GAAY,EAAgB,EAAE,CACpD,OAAO,GAAG,KAAK,QAAQ,IAAI,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;AAElD,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,GAAW,EAAS,EAAE;IAC5C,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;QAClB,MAAM,KAAK,CAAC,iBAAiB,EAAE;YAC7B,KAAK,EAAE,GAAG;SACX,CAAC,CAAA;IACJ,CAAC;IACD,OAAO,GAAG,CAAA;AACZ,CAAC,CAAA;AAED;;GAEG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,IAAgB,EAAS,EAAE;IACxD,MAAM,CAAC,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,CAAC,GAAG,IAAI,CAAA;IACzC,MAAM,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,CAAA;IACvB,QAAQ,IAAI,EAAE,CAAC;QACb,KAAK,UAAU;YACb,OAAO,GAAG,SAAS,GAAG,CAAC,GAAG,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,GAAG,SAAS,GAAG,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAA;QACtG,KAAK,KAAK;YACR,OAAO,GAAG,IAAI,GAAG,SAAS,GAAG,CAAC,GAAG,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,GAAG,SAAS,GAAG,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAA;QAC7G;YACE,OAAO,GAAG,IAAI,GAAG,SAAS,GAAG,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,GAAG,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAA;IACpF,CAAC;AACH,CAAC,CAAA;AAED,oDAAoD;AACpD,MAAM,MAAM,GAAG,CAAC,CAAS,EAAU,EAAE,CACnC,kBAAkB,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,KAAK,EAAE,GAAG,CAAC,CAAA;AAE9C;;GAEG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,EAAU,EAAc,EAAE;IACnD,MAAM,CAAC,IAAI,EAAE,KAAK,GAAG,EAAE,EAAE,MAAM,EAAE,KAAK,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,SAAS,EAAE,CAAC,CAAC,CAAA;IAChE,MAAM,CAAC,GAAG,kBAAkB,CAAC,KAAK,CAAC,CAAA;IACnC,QAAQ,IAAI,EAAE,CAAC;QACb,KAAK,KAAK,CAAC;QACX,KAAK,EAAE,CAAC,CAAC,CAAC;YACR,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;gBACzB,MAAM,KAAK,CAAC,WAAW,IAAI,KAAK,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,CAAA;YAClD,CAAC;YACD,MAAM,CAAC,GAAe;gBACpB,IAAI,IAAI,UAAU;gBAClB,CAAC;gBACD,kBAAkB,CAAC,MAAM,CAAC;aAC3B,CAAA;YACD,IAAI,KAAK;gBAAE,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC,CAAA;YAC5C,OAAO,CAAC,CAAA;QACV,CAAC;QACD,KAAK,MAAM,CAAC;QACZ,KAAK,QAAQ,CAAC;QACd,KAAK,WAAW,CAAC,CAAC,CAAC;YACjB,MAAM,CAAC,GAAe,CAAC,IAAI,EAAE,CAAC,CAAC,CAAA;YAC/B,IAAI,MAAM;gBAAE,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC,CAAA;YAC9C,OAAO,CAAC,CAAA;QACV,CAAC;QACD,OAAO,CAAC,CAAC,CAAC;YACR,MAAM,KAAK,CAAC,oBAAoB,EAAE;gBAChC,KAAK,EAAE,IAAI;gBACX,YAAY,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,WAAW,EAAE,QAAQ,EAAE,EAAE,CAAC;aACzD,CAAC,CAAA;QACJ,CAAC;IACH,CAAC;AACH,CAAC,CAAA","sourcesContent":["import { error } from '@vltpkg/error-cause'\n\nexport const delimiter: Delimiter = '·'\nexport type Delimiter = '·'\n\n/**\n * Dependency IDs are a URI-encoded set of strings, separated\n * by the {@link Delimiter} character (`'·'`).\n *\n * The first entry is always the specifier type. The rest depend on the\n * type. `git`, `registry`, and `workspace` entries have 3 fields, the rest\n * have 2.\n *\n * - `registry`: `'registry·<registry>·name@specifier'`\n *   The `<registry>` portion can be a known named registry name, or a\n *   url to a registry. If empty, it is the default registry.\n *   Examples:\n *   - `··some-package@2.0.1`\n *   - `·npm·whatever@1.2.3'\n *   - `·http%3A%2F%2Fvlt.sh%2F·x@1.2.3`\n * - `git`: `'git·<git remote>·<git selector>`. For example:\n *   - `git·github:user/project·branchname`\n *   - `git·git%2Bssh%3A%2F%2Fuser%40host%3Aproject.git·semver:1.x`\n * - `workspace`: `'workspace·<path>`. For example:\n *   - `workspace·src/mything`\n * - `remote`: `'remote·<url>'`\n * - `file`: `'file·<path>`\n *\n * Lastly, the final portion can contain arbitrary string data, and is\n * used to store peer dep resolutions to maintain the peerDep contract.\n */\nexport type DepID =\n  | `${'' | 'git'}${Delimiter}${string}${Delimiter}${string}${Delimiter}${string}`\n  | `${'' | 'git'}${Delimiter}${string}${Delimiter}${string}`\n  | `${'file' | 'remote' | 'workspace'}${Delimiter}${string}${Delimiter}${string}`\n  | `${'file' | 'remote' | 'workspace'}${Delimiter}${string}`\n\n/**\n * A {@link DepID}, split apart and URI-decoded\n */\nexport type DepIDTuple =\n  | [\n      type: 'git',\n      gitRemote: string,\n      gitSelector: string,\n      extra?: string,\n    ]\n  | [\n      type: 'registry',\n      registry: string,\n      registrySpec: string,\n      extra?: string,\n    ]\n  | [type: 'file', path: string, extra?: string]\n  | [type: 'remote', url: string, extra?: string]\n  | [type: 'workspace', workspace: string, extra?: string]\n\nconst depIDRegExp = new RegExp(\n  `^((git)?${delimiter}[^${delimiter}]*${delimiter}[^${delimiter}]*(${\n    delimiter\n  }[^${delimiter}]*)?$` +\n    `|` +\n    `^(file|remote|workspace)${delimiter}[^${\n      delimiter\n    }]*)(${delimiter}[^${delimiter}]*)?$`,\n)\n\nexport const isDepID = (str: unknown): str is DepID =>\n  typeof str === 'string' && depIDRegExp.test(str)\n\nexport const asDepID = (str: string): DepID => {\n  if (!isDepID(str)) {\n    throw error('Expected dep id', {\n      found: str,\n    })\n  }\n  return str\n}\n\n/**\n * turn a {@link DepIDTuple} into a {@link DepID}\n */\nexport const joinDepIDTuple = (list: DepIDTuple): DepID => {\n  const [type, first, second, extra] = list\n  const f = encode(first)\n  switch (type) {\n    case 'registry':\n      return `${delimiter}${f}${delimiter}${encode(second)}${extra ? `${delimiter}${encode(extra)}` : ''}`\n    case 'git':\n      return `${type}${delimiter}${f}${delimiter}${encode(second)}${extra ? `${delimiter}${encode(extra)}` : ''}`\n    default:\n      return `${type}${delimiter}${f}${second ? `${delimiter}${encode(second)}` : ''}`\n  }\n}\n\n// allow @, but otherwise, escape everything urls do\nconst encode = (s: string): string =>\n  encodeURIComponent(s).replaceAll('%40', '@')\n\n/**\n * turn a {@link DepID} into a {@link DepIDTuple}\n */\nexport const splitDepID = (id: string): DepIDTuple => {\n  const [type, first = '', second, extra] = id.split(delimiter, 4)\n  const f = decodeURIComponent(first)\n  switch (type) {\n    case 'git':\n    case '': {\n      if (second === undefined) {\n        throw error(`invalid ${type} id`, { found: id })\n      }\n      const t: DepIDTuple = [\n        type || 'registry',\n        f,\n        decodeURIComponent(second),\n      ]\n      if (extra) t.push(decodeURIComponent(extra))\n      return t\n    }\n    case 'file':\n    case 'remote':\n    case 'workspace': {\n      const t: DepIDTuple = [type, f]\n      if (second) t.push(decodeURIComponent(second))\n      return t\n    }\n    default: {\n      throw error('invalid DepID type', {\n        found: type,\n        validOptions: ['git', 'file', 'workspace', 'remote', ''],\n      })\n    }\n  }\n}\n"]}

package/dist/esm/index.d.ts

@@ -0,0 +1,78 @@
+import { Spec, SpecOptions } from '@vltpkg/spec';
+import { Manifest } from '@vltpkg/types';
+export declare const delimiter: Delimiter;
+export type Delimiter = '·';
+/**
+ * Dependency IDs are a URI-encoded set of strings, separated
+ * by the {@link Delimiter} character (`'·'`).
+ *
+ * The first entry is always the specifier type. The rest depend on the
+ * type. `git`, `registry`, and `workspace` entries have 3 fields, the rest
+ * have 2.
+ *
+ * - `registry`: `'registry·<registry>·name@specifier'`
+ *   The `<registry>` portion can be a known named registry name, or a
+ *   url to a registry. If empty, it is the default registry.
+ *   Examples:
+ *   - `··some-package@2.0.1`
+ *   - `·npm·whatever@1.2.3'
+ *   - `·http%3A%2F%2Fvlt.sh%2F·x@1.2.3`
+ * - `git`: `'git·<git remote>·<git selector>`. For example:
+ *   - `git·github:user/project·branchname`
+ *   - `git·git%2Bssh%3A%2F%2Fuser%40host%3Aproject.git·semver:1.x`
+ * - `workspace`: `'workspace·<path>`. For example:
+ *   - `workspace·src/mything`
+ * - `remote`: `'remote·<url>'`
+ * - `file`: `'file·<path>`
+ *
+ * Lastly, the final portion can contain arbitrary string data, and is
+ * used to store peer dep resolutions to maintain the peerDep contract.
+ */
+export type DepID = `${'' | 'git'}${Delimiter}${string}${Delimiter}${string}${Delimiter}${string}` | `${'' | 'git'}${Delimiter}${string}${Delimiter}${string}` | `${'file' | 'remote' | 'workspace'}${Delimiter}${string}${Delimiter}${string}` | `${'file' | 'remote' | 'workspace'}${Delimiter}${string}`;
+/**
+ * A {@link DepID}, split apart and URI-decoded
+ */
+export type DepIDTuple = [
+    type: 'git',
+    gitRemote: string,
+    gitSelector: string,
+    extra?: string
+] | [
+    type: 'registry',
+    registry: string,
+    registrySpec: string,
+    extra?: string
+] | [type: 'file', path: string, extra?: string] | [type: 'remote', url: string, extra?: string] | [type: 'workspace', workspace: string, extra?: string];
+export declare const isDepID: (str: unknown) => str is DepID;
+export declare const asDepID: (str: string) => DepID;
+/**
+ * turn a {@link DepIDTuple} into a {@link DepID}
+ */
+export declare const joinDepIDTuple: (list: DepIDTuple) => DepID;
+/**
+ * turn a {@link DepID} into a {@link DepIDTuple}
+ */
+export declare const splitDepID: (id: string) => DepIDTuple;
+/**
+ * Turn a {@link DepID} into a {@link Spec} object
+ */
+export declare const hydrate: (id: DepID, name?: string, options?: SpecOptions) => Spec;
+/**
+ * Turn a {@link DepIDTuple} into a {@link Spec} object
+ */
+export declare const hydrateTuple: (tuple: DepIDTuple, name?: string, options?: SpecOptions) => import("@vltpkg/spec/browser").Spec;
+/**
+ * Get the {@link DepIDTuple} for a given {@link Spec} and {@link Manifest}.
+ * The Manifest is used to get the name and version, if possible. If not found
+ * in the manifest, registry ID types will use the name or bareSpec from the
+ * specifier, so at least there's something to use later.
+ */
+export declare const getTuple: (spec: Spec, mani: Manifest) => DepIDTuple;
+/**
+ * Get the {@link DepID} for a given {@link Spec} and {@link Manifest}. The
+ * Manifest is used to get the name and version, if possible. If not found in
+ * the manifest, registry ID types will use the name or bareSpec from the
+ * specifier, so at least there's something to use later.
+ */
+export declare const getId: (spec: Spec, mani: Manifest) => DepID;
+//# sourceMappingURL=index.d.ts.map

package/dist/esm/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AAChD,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAA;AAExC,eAAO,MAAM,SAAS,EAAE,SAAe,CAAA;AACvC,MAAM,MAAM,SAAS,GAAG,GAAG,CAAA;AAE3B;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,MAAM,KAAK,GACb,GAAG,EAAE,GAAG,KAAK,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,GAAG,MAAM,EAAE,GAC9E,GAAG,EAAE,GAAG,KAAK,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,GAAG,MAAM,EAAE,GACzD,GAAG,MAAM,GAAG,QAAQ,GAAG,WAAW,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,GAAG,MAAM,EAAE,GAC9E,GAAG,MAAM,GAAG,QAAQ,GAAG,WAAW,GAAG,SAAS,GAAG,MAAM,EAAE,CAAA;AAE7D;;GAEG;AACH,MAAM,MAAM,UAAU,GAClB;IACE,IAAI,EAAE,KAAK;IACX,SAAS,EAAE,MAAM;IACjB,WAAW,EAAE,MAAM;IACnB,KAAK,CAAC,EAAE,MAAM;CACf,GACD;IACE,IAAI,EAAE,UAAU;IAChB,QAAQ,EAAE,MAAM;IAChB,YAAY,EAAE,MAAM;IACpB,KAAK,CAAC,EAAE,MAAM;CACf,GACD,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,CAAC,GAC5C,CAAC,IAAI,EAAE,QAAQ,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,CAAC,GAC7C,CAAC,IAAI,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,CAAC,CAAA;AAY1D,eAAO,MAAM,OAAO,QAAS,OAAO,KAAG,GAAG,IAAI,KACI,CAAA;AAElD,eAAO,MAAM,OAAO,QAAS,MAAM,KAAG,KAOrC,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,cAAc,SAAU,UAAU,KAAG,KAWjD,CAAA;AAMD;;GAEG;AACH,eAAO,MAAM,UAAU,OAAQ,MAAM,KAAG,UA+BvC,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,OAAO,OACd,KAAK,SACF,MAAM,YACJ,WAAW,KACnB,IAAmD,CAAA;AAEtD;;GAEG;AACH,eAAO,MAAM,YAAY,UAChB,UAAU,SACV,MAAM,YACJ,WAAW,wCAmFrB,CAAA;AAYD;;;;;GAKG;AACH,eAAO,MAAM,QAAQ,SAAU,IAAI,QAAQ,QAAQ,KAAG,UAwDrD,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,KAAK,SAAU,IAAI,QAAQ,QAAQ,KAAG,KACb,CAAA"}

package/dist/esm/index.js

@@ -0,0 +1,219 @@
+import { error } from '@vltpkg/error-cause';
+import { Spec } from '@vltpkg/spec';
+export const delimiter = '·';
+const depIDRegExp = new RegExp(`^((git)?${delimiter}[^${delimiter}]*${delimiter}[^${delimiter}]*(${delimiter}[^${delimiter}]*)?$` +
+    `|` +
+    `^(file|remote|workspace)${delimiter}[^${delimiter}]*)(${delimiter}[^${delimiter}]*)?$`);
+export const isDepID = (str) => typeof str === 'string' && depIDRegExp.test(str);
+export const asDepID = (str) => {
+    if (!isDepID(str)) {
+        throw error('Expected dep id', {
+            found: str,
+        });
+    }
+    return str;
+};
+/**
+ * turn a {@link DepIDTuple} into a {@link DepID}
+ */
+export const joinDepIDTuple = (list) => {
+    const [type, first, second, extra] = list;
+    const f = encode(first);
+    switch (type) {
+        case 'registry':
+            return `${delimiter}${f}${delimiter}${encode(second)}${extra ? `${delimiter}${encode(extra)}` : ''}`;
+        case 'git':
+            return `${type}${delimiter}${f}${delimiter}${encode(second)}${extra ? `${delimiter}${encode(extra)}` : ''}`;
+        default:
+            return `${type}${delimiter}${f}${second ? `${delimiter}${encode(second)}` : ''}`;
+    }
+};
+// allow @, but otherwise, escape everything urls do
+const encode = (s) => encodeURIComponent(s).replaceAll('%40', '@');
+/**
+ * turn a {@link DepID} into a {@link DepIDTuple}
+ */
+export const splitDepID = (id) => {
+    const [type, first = '', second, extra] = id.split(delimiter, 4);
+    const f = decodeURIComponent(first);
+    switch (type) {
+        case 'git':
+        case '': {
+            if (second === undefined) {
+                throw error(`invalid ${type} id`, { found: id });
+            }
+            const t = [
+                type || 'registry',
+                f,
+                decodeURIComponent(second),
+            ];
+            if (extra)
+                t.push(decodeURIComponent(extra));
+            return t;
+        }
+        case 'file':
+        case 'remote':
+        case 'workspace': {
+            const t = [type, f];
+            if (second)
+                t.push(decodeURIComponent(second));
+            return t;
+        }
+        default: {
+            throw error('invalid DepID type', {
+                found: type,
+                validOptions: ['git', 'file', 'workspace', 'remote', ''],
+            });
+        }
+    }
+};
+/**
+ * Turn a {@link DepID} into a {@link Spec} object
+ */
+export const hydrate = (id, name, options = {}) => hydrateTuple(splitDepID(id), name, options);
+/**
+ * Turn a {@link DepIDTuple} into a {@link Spec} object
+ */
+export const hydrateTuple = (tuple, name, options = {}) => {
+    const [type, first, second] = tuple;
+    switch (type) {
+        case 'remote': {
+            if (!first)
+                throw error('no remoteURL found on remote id', {
+                    found: tuple,
+                });
+            return Spec.parse(name ?? '(unknown)', first);
+        }
+        case 'file': {
+            if (!first) {
+                throw error('no file path found on remote id', {
+                    found: tuple,
+                });
+            }
+            return Spec.parse(name ?? '(unknown)', `file:${first}`, options);
+        }
+        case 'registry': {
+            if (typeof first !== 'string') {
+                throw error('no registry url or name in registry ID', {
+                    found: tuple,
+                });
+            }
+            if (!second) {
+                throw error('no name/specifier in registry ID', {
+                    found: tuple,
+                });
+            }
+            if (!first) {
+                // just a normal name@version on the default registry
+                const s = Spec.parse(second);
+                if (name && s.name !== name) {
+                    return Spec.parse(`${name}@npm:${second}`);
+                }
+                else {
+                    return s;
+                }
+            }
+            if (!/^https?:\/\//.test(first)) {
+                const reg = options.registries?.[first];
+                if (first !== 'npm' && !reg) {
+                    throw error('named registry not found in options', {
+                        name: first,
+                        found: tuple,
+                    });
+                }
+                return Spec.parse(name ?? '(unknown)', `${first}:${second}`, options);
+            }
+            const s = Spec.parse(name ?? '(unknown)', `registry:${first}#${second}`, options);
+            return name && s.final.name !== name ?
+                Spec.parse(s.final.name + '@' + s.bareSpec)
+                : s;
+        }
+        case 'git': {
+            if (!first) {
+                throw error('no git remote in git ID', {
+                    found: tuple,
+                });
+            }
+            return Spec.parse(name ?? '(unknown)', first + '#' + second, options);
+        }
+        case 'workspace': {
+            if (!first) {
+                throw error('no name/path on workspace id', { found: tuple });
+            }
+            return name && name !== first ?
+                Spec.parse(name, `workspace:${first}@*`, options)
+                : Spec.parse(first, `workspace:*`, options);
+        }
+    }
+};
+// Strip out the default registry, there's no need to store that
+const omitDefReg = (s) => (!s ||
+    s === 'https://registry.npmjs.org' ||
+    s === 'https://registry.npmjs.org/') ?
+    ''
+    : s;
+/**
+ * Get the {@link DepIDTuple} for a given {@link Spec} and {@link Manifest}.
+ * The Manifest is used to get the name and version, if possible. If not found
+ * in the manifest, registry ID types will use the name or bareSpec from the
+ * specifier, so at least there's something to use later.
+ */
+export const getTuple = (spec, mani) => {
+    const f = spec.final;
+    switch (f.type) {
+        case 'registry': {
+            // try to shorten to a known name if we can.
+            const reg = omitDefReg(f.registry);
+            if (!f.namedRegistry && reg) {
+                for (const [alias, host] of Object.entries(spec.options.registries)) {
+                    if (reg === host) {
+                        f.namedRegistry = alias;
+                        break;
+                    }
+                }
+            }
+            return [
+                f.type,
+                f.namedRegistry ?? reg,
+                `${mani.name ?? spec.name}@${mani.version ?? spec.bareSpec}`,
+            ];
+        }
+        case 'git': {
+            const { namedGitHost, namedGitHostPath, gitRemote, gitSelector = '', } = f;
+            if (!gitRemote)
+                throw error('no host on git specifier', { spec });
+            if (namedGitHost) {
+                if (!namedGitHostPath) {
+                    throw error('named git host without path portion', {
+                        spec,
+                    });
+                }
+                return [
+                    f.type,
+                    `${namedGitHost}:${namedGitHostPath}`,
+                    gitSelector,
+                ];
+            }
+            else {
+                return [f.type, gitRemote, gitSelector];
+            }
+        }
+        case 'remote': {
+            const { remoteURL } = f;
+            if (!remoteURL)
+                throw error('no URL on remote specifier', { spec });
+            return [f.type, remoteURL];
+        }
+        case 'file':
+        case 'workspace':
+            throw error('Path-based dep ids are not supported', { spec });
+    }
+};
+/**
+ * Get the {@link DepID} for a given {@link Spec} and {@link Manifest}. The
+ * Manifest is used to get the name and version, if possible. If not found in
+ * the manifest, registry ID types will use the name or bareSpec from the
+ * specifier, so at least there's something to use later.
+ */
+export const getId = (spec, mani) => joinDepIDTuple(getTuple(spec, mani));
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,qBAAqB,CAAA;AAC3C,OAAO,EAAE,IAAI,EAAe,MAAM,cAAc,CAAA;AAGhD,MAAM,CAAC,MAAM,SAAS,GAAc,GAAG,CAAA;AAuDvC,MAAM,WAAW,GAAG,IAAI,MAAM,CAC5B,WAAW,SAAS,KAAK,SAAS,KAAK,SAAS,KAAK,SAAS,MAC5D,SACF,KAAK,SAAS,OAAO;IACnB,GAAG;IACH,2BAA2B,SAAS,KAClC,SACF,OAAO,SAAS,KAAK,SAAS,OAAO,CACxC,CAAA;AAED,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,GAAY,EAAgB,EAAE,CACpD,OAAO,GAAG,KAAK,QAAQ,IAAI,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;AAElD,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,GAAW,EAAS,EAAE;IAC5C,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;QAClB,MAAM,KAAK,CAAC,iBAAiB,EAAE;YAC7B,KAAK,EAAE,GAAG;SACX,CAAC,CAAA;IACJ,CAAC;IACD,OAAO,GAAG,CAAA;AACZ,CAAC,CAAA;AAED;;GAEG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,IAAgB,EAAS,EAAE;IACxD,MAAM,CAAC,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,CAAC,GAAG,IAAI,CAAA;IACzC,MAAM,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,CAAA;IACvB,QAAQ,IAAI,EAAE,CAAC;QACb,KAAK,UAAU;YACb,OAAO,GAAG,SAAS,GAAG,CAAC,GAAG,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,GAAG,SAAS,GAAG,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAA;QACtG,KAAK,KAAK;YACR,OAAO,GAAG,IAAI,GAAG,SAAS,GAAG,CAAC,GAAG,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,GAAG,SAAS,GAAG,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAA;QAC7G;YACE,OAAO,GAAG,IAAI,GAAG,SAAS,GAAG,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,GAAG,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAA;IACpF,CAAC;AACH,CAAC,CAAA;AAED,oDAAoD;AACpD,MAAM,MAAM,GAAG,CAAC,CAAS,EAAU,EAAE,CACnC,kBAAkB,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,KAAK,EAAE,GAAG,CAAC,CAAA;AAE9C;;GAEG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,EAAU,EAAc,EAAE;IACnD,MAAM,CAAC,IAAI,EAAE,KAAK,GAAG,EAAE,EAAE,MAAM,EAAE,KAAK,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,SAAS,EAAE,CAAC,CAAC,CAAA;IAChE,MAAM,CAAC,GAAG,kBAAkB,CAAC,KAAK,CAAC,CAAA;IACnC,QAAQ,IAAI,EAAE,CAAC;QACb,KAAK,KAAK,CAAC;QACX,KAAK,EAAE,CAAC,CAAC,CAAC;YACR,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;gBACzB,MAAM,KAAK,CAAC,WAAW,IAAI,KAAK,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,CAAA;YAClD,CAAC;YACD,MAAM,CAAC,GAAe;gBACpB,IAAI,IAAI,UAAU;gBAClB,CAAC;gBACD,kBAAkB,CAAC,MAAM,CAAC;aAC3B,CAAA;YACD,IAAI,KAAK;gBAAE,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC,CAAA;YAC5C,OAAO,CAAC,CAAA;QACV,CAAC;QACD,KAAK,MAAM,CAAC;QACZ,KAAK,QAAQ,CAAC;QACd,KAAK,WAAW,CAAC,CAAC,CAAC;YACjB,MAAM,CAAC,GAAe,CAAC,IAAI,EAAE,CAAC,CAAC,CAAA;YAC/B,IAAI,MAAM;gBAAE,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC,CAAA;YAC9C,OAAO,CAAC,CAAA;QACV,CAAC;QACD,OAAO,CAAC,CAAC,CAAC;YACR,MAAM,KAAK,CAAC,oBAAoB,EAAE;gBAChC,KAAK,EAAE,IAAI;gBACX,YAAY,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,WAAW,EAAE,QAAQ,EAAE,EAAE,CAAC;aACzD,CAAC,CAAA;QACJ,CAAC;IACH,CAAC;AACH,CAAC,CAAA;AAED;;GAEG;AACH,MAAM,CAAC,MAAM,OAAO,GAAG,CACrB,EAAS,EACT,IAAa,EACb,UAAuB,EAAE,EACnB,EAAE,CAAC,YAAY,CAAC,UAAU,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,CAAA;AAEtD;;GAEG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAC1B,KAAiB,EACjB,IAAa,EACb,UAAuB,EAAE,EACzB,EAAE;IACF,MAAM,CAAC,IAAI,EAAE,KAAK,EAAE,MAAM,CAAC,GAAG,KAAK,CAAA;IACnC,QAAQ,IAAI,EAAE,CAAC;QACb,KAAK,QAAQ,CAAC,CAAC,CAAC;YACd,IAAI,CAAC,KAAK;gBACR,MAAM,KAAK,CAAC,iCAAiC,EAAE;oBAC7C,KAAK,EAAE,KAAK;iBACb,CAAC,CAAA;YACJ,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,IAAI,WAAW,EAAE,KAAK,CAAC,CAAA;QAC/C,CAAC;QACD,KAAK,MAAM,CAAC,CAAC,CAAC;YACZ,IAAI,CAAC,KAAK,EAAE,CAAC;gBACX,MAAM,KAAK,CAAC,iCAAiC,EAAE;oBAC7C,KAAK,EAAE,KAAK;iBACb,CAAC,CAAA;YACJ,CAAC;YACD,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,IAAI,WAAW,EAAE,QAAQ,KAAK,EAAE,EAAE,OAAO,CAAC,CAAA;QAClE,CAAC;QACD,KAAK,UAAU,CAAC,CAAC,CAAC;YAChB,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;gBAC9B,MAAM,KAAK,CAAC,wCAAwC,EAAE;oBACpD,KAAK,EAAE,KAAK;iBACb,CAAC,CAAA;YACJ,CAAC;YACD,IAAI,CAAC,MAAM,EAAE,CAAC;gBACZ,MAAM,KAAK,CAAC,kCAAkC,EAAE;oBAC9C,KAAK,EAAE,KAAK;iBACb,CAAC,CAAA;YACJ,CAAC;YACD,IAAI,CAAC,KAAK,EAAE,CAAC;gBACX,qDAAqD;gBACrD,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAA;gBAC5B,IAAI,IAAI,IAAI,CAAC,CAAC,IAAI,KAAK,IAAI,EAAE,CAAC;oBAC5B,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,IAAI,QAAQ,MAAM,EAAE,CAAC,CAAA;gBAC5C,CAAC;qBAAM,CAAC;oBACN,OAAO,CAAC,CAAA;gBACV,CAAC;YACH,CAAC;YACD,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;gBAChC,MAAM,GAAG,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC,KAAK,CAAC,CAAA;gBACvC,IAAI,KAAK,KAAK,KAAK,IAAI,CAAC,GAAG,EAAE,CAAC;oBAC5B,MAAM,KAAK,CAAC,qCAAqC,EAAE;wBACjD,IAAI,EAAE,KAAK;wBACX,KAAK,EAAE,KAAK;qBACb,CAAC,CAAA;gBACJ,CAAC;gBACD,OAAO,IAAI,CAAC,KAAK,CACf,IAAI,IAAI,WAAW,EACnB,GAAG,KAAK,IAAI,MAAM,EAAE,EACpB,OAAO,CACR,CAAA;YACH,CAAC;YACD,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,CAClB,IAAI,IAAI,WAAW,EACnB,YAAY,KAAK,IAAI,MAAM,EAAE,EAC7B,OAAO,CACR,CAAA;YACD,OAAO,IAAI,IAAI,CAAC,CAAC,KAAK,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;gBAClC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,GAAG,GAAG,GAAG,CAAC,CAAC,QAAQ,CAAC;gBAC7C,CAAC,CAAC,CAAC,CAAA;QACP,CAAC;QACD,KAAK,KAAK,CAAC,CAAC,CAAC;YACX,IAAI,CAAC,KAAK,EAAE,CAAC;gBACX,MAAM,KAAK,CAAC,yBAAyB,EAAE;oBACrC,KAAK,EAAE,KAAK;iBACb,CAAC,CAAA;YACJ,CAAC;YACD,OAAO,IAAI,CAAC,KAAK,CACf,IAAI,IAAI,WAAW,EACnB,KAAK,GAAG,GAAG,GAAG,MAAM,EACpB,OAAO,CACR,CAAA;QACH,CAAC;QACD,KAAK,WAAW,CAAC,CAAC,CAAC;YACjB,IAAI,CAAC,KAAK,EAAE,CAAC;gBACX,MAAM,KAAK,CAAC,8BAA8B,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAA;YAC/D,CAAC;YACD,OAAO,IAAI,IAAI,IAAI,KAAK,KAAK,CAAC,CAAC;gBAC3B,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,aAAa,KAAK,IAAI,EAAE,OAAO,CAAC;gBACnD,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,aAAa,EAAE,OAAO,CAAC,CAAA;QAC/C,CAAC;IACH,CAAC;AACH,CAAC,CAAA;AAED,gEAAgE;AAChE,MAAM,UAAU,GAAG,CAAC,CAAU,EAAU,EAAE,CACxC,CACE,CAAC,CAAC;IACF,CAAC,KAAK,4BAA4B;IAClC,CAAC,KAAK,6BAA6B,CACpC,CAAC,CAAC;IACD,EAAE;IACJ,CAAC,CAAC,CAAC,CAAA;AAEL;;;;;GAKG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,IAAU,EAAE,IAAc,EAAc,EAAE;IACjE,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,CAAA;IACpB,QAAQ,CAAC,CAAC,IAAI,EAAE,CAAC;QACf,KAAK,UAAU,CAAC,CAAC,CAAC;YAChB,4CAA4C;YAC5C,MAAM,GAAG,GAAG,UAAU,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAA;YAClC,IAAI,CAAC,CAAC,CAAC,aAAa,IAAI,GAAG,EAAE,CAAC;gBAC5B,KAAK,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,MAAM,CAAC,OAAO,CACxC,IAAI,CAAC,OAAO,CAAC,UAAU,CACxB,EAAE,CAAC;oBACF,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;wBACjB,CAAC,CAAC,aAAa,GAAG,KAAK,CAAA;wBACvB,MAAK;oBACP,CAAC;gBACH,CAAC;YACH,CAAC;YACD,OAAO;gBACL,CAAC,CAAC,IAAI;gBACN,CAAC,CAAC,aAAa,IAAI,GAAG;gBACtB,GAAG,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,QAAQ,EAAE;aAC7D,CAAA;QACH,CAAC;QACD,KAAK,KAAK,CAAC,CAAC,CAAC;YACX,MAAM,EACJ,YAAY,EACZ,gBAAgB,EAChB,SAAS,EACT,WAAW,GAAG,EAAE,GACjB,GAAG,CAAC,CAAA;YACL,IAAI,CAAC,SAAS;gBACZ,MAAM,KAAK,CAAC,0BAA0B,EAAE,EAAE,IAAI,EAAE,CAAC,CAAA;YACnD,IAAI,YAAY,EAAE,CAAC;gBACjB,IAAI,CAAC,gBAAgB,EAAE,CAAC;oBACtB,MAAM,KAAK,CAAC,qCAAqC,EAAE;wBACjD,IAAI;qBACL,CAAC,CAAA;gBACJ,CAAC;gBACD,OAAO;oBACL,CAAC,CAAC,IAAI;oBACN,GAAG,YAAY,IAAI,gBAAgB,EAAE;oBACrC,WAAW;iBACZ,CAAA;YACH,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,CAAC,CAAC,IAAI,EAAE,SAAS,EAAE,WAAW,CAAC,CAAA;YACzC,CAAC;QACH,CAAC;QACD,KAAK,QAAQ,CAAC,CAAC,CAAC;YACd,MAAM,EAAE,SAAS,EAAE,GAAG,CAAC,CAAA;YACvB,IAAI,CAAC,SAAS;gBACZ,MAAM,KAAK,CAAC,4BAA4B,EAAE,EAAE,IAAI,EAAE,CAAC,CAAA;YACrD,OAAO,CAAC,CAAC,CAAC,IAAI,EAAE,SAAS,CAAC,CAAA;QAC5B,CAAC;QACD,KAAK,MAAM,CAAC;QACZ,KAAK,WAAW;YACd,MAAM,KAAK,CAAC,sCAAsC,EAAE,EAAE,IAAI,EAAE,CAAC,CAAA;IACjE,CAAC;AACH,CAAC,CAAA;AAED;;;;;GAKG;AACH,MAAM,CAAC,MAAM,KAAK,GAAG,CAAC,IAAU,EAAE,IAAc,EAAS,EAAE,CACzD,cAAc,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAA","sourcesContent":["import { error } from '@vltpkg/error-cause'\nimport { Spec, SpecOptions } from '@vltpkg/spec'\nimport { Manifest } from '@vltpkg/types'\n\nexport const delimiter: Delimiter = '·'\nexport type Delimiter = '·'\n\n/**\n * Dependency IDs are a URI-encoded set of strings, separated\n * by the {@link Delimiter} character (`'·'`).\n *\n * The first entry is always the specifier type. The rest depend on the\n * type. `git`, `registry`, and `workspace` entries have 3 fields, the rest\n * have 2.\n *\n * - `registry`: `'registry·<registry>·name@specifier'`\n *   The `<registry>` portion can be a known named registry name, or a\n *   url to a registry. If empty, it is the default registry.\n *   Examples:\n *   - `··some-package@2.0.1`\n *   - `·npm·whatever@1.2.3'\n *   - `·http%3A%2F%2Fvlt.sh%2F·x@1.2.3`\n * - `git`: `'git·<git remote>·<git selector>`. For example:\n *   - `git·github:user/project·branchname`\n *   - `git·git%2Bssh%3A%2F%2Fuser%40host%3Aproject.git·semver:1.x`\n * - `workspace`: `'workspace·<path>`. For example:\n *   - `workspace·src/mything`\n * - `remote`: `'remote·<url>'`\n * - `file`: `'file·<path>`\n *\n * Lastly, the final portion can contain arbitrary string data, and is\n * used to store peer dep resolutions to maintain the peerDep contract.\n */\nexport type DepID =\n  | `${'' | 'git'}${Delimiter}${string}${Delimiter}${string}${Delimiter}${string}`\n  | `${'' | 'git'}${Delimiter}${string}${Delimiter}${string}`\n  | `${'file' | 'remote' | 'workspace'}${Delimiter}${string}${Delimiter}${string}`\n  | `${'file' | 'remote' | 'workspace'}${Delimiter}${string}`\n\n/**\n * A {@link DepID}, split apart and URI-decoded\n */\nexport type DepIDTuple =\n  | [\n      type: 'git',\n      gitRemote: string,\n      gitSelector: string,\n      extra?: string,\n    ]\n  | [\n      type: 'registry',\n      registry: string,\n      registrySpec: string,\n      extra?: string,\n    ]\n  | [type: 'file', path: string, extra?: string]\n  | [type: 'remote', url: string, extra?: string]\n  | [type: 'workspace', workspace: string, extra?: string]\n\nconst depIDRegExp = new RegExp(\n  `^((git)?${delimiter}[^${delimiter}]*${delimiter}[^${delimiter}]*(${\n    delimiter\n  }[^${delimiter}]*)?$` +\n    `|` +\n    `^(file|remote|workspace)${delimiter}[^${\n      delimiter\n    }]*)(${delimiter}[^${delimiter}]*)?$`,\n)\n\nexport const isDepID = (str: unknown): str is DepID =>\n  typeof str === 'string' && depIDRegExp.test(str)\n\nexport const asDepID = (str: string): DepID => {\n  if (!isDepID(str)) {\n    throw error('Expected dep id', {\n      found: str,\n    })\n  }\n  return str\n}\n\n/**\n * turn a {@link DepIDTuple} into a {@link DepID}\n */\nexport const joinDepIDTuple = (list: DepIDTuple): DepID => {\n  const [type, first, second, extra] = list\n  const f = encode(first)\n  switch (type) {\n    case 'registry':\n      return `${delimiter}${f}${delimiter}${encode(second)}${extra ? `${delimiter}${encode(extra)}` : ''}`\n    case 'git':\n      return `${type}${delimiter}${f}${delimiter}${encode(second)}${extra ? `${delimiter}${encode(extra)}` : ''}`\n    default:\n      return `${type}${delimiter}${f}${second ? `${delimiter}${encode(second)}` : ''}`\n  }\n}\n\n// allow @, but otherwise, escape everything urls do\nconst encode = (s: string): string =>\n  encodeURIComponent(s).replaceAll('%40', '@')\n\n/**\n * turn a {@link DepID} into a {@link DepIDTuple}\n */\nexport const splitDepID = (id: string): DepIDTuple => {\n  const [type, first = '', second, extra] = id.split(delimiter, 4)\n  const f = decodeURIComponent(first)\n  switch (type) {\n    case 'git':\n    case '': {\n      if (second === undefined) {\n        throw error(`invalid ${type} id`, { found: id })\n      }\n      const t: DepIDTuple = [\n        type || 'registry',\n        f,\n        decodeURIComponent(second),\n      ]\n      if (extra) t.push(decodeURIComponent(extra))\n      return t\n    }\n    case 'file':\n    case 'remote':\n    case 'workspace': {\n      const t: DepIDTuple = [type, f]\n      if (second) t.push(decodeURIComponent(second))\n      return t\n    }\n    default: {\n      throw error('invalid DepID type', {\n        found: type,\n        validOptions: ['git', 'file', 'workspace', 'remote', ''],\n      })\n    }\n  }\n}\n\n/**\n * Turn a {@link DepID} into a {@link Spec} object\n */\nexport const hydrate = (\n  id: DepID,\n  name?: string,\n  options: SpecOptions = {},\n): Spec => hydrateTuple(splitDepID(id), name, options)\n\n/**\n * Turn a {@link DepIDTuple} into a {@link Spec} object\n */\nexport const hydrateTuple = (\n  tuple: DepIDTuple,\n  name?: string,\n  options: SpecOptions = {},\n) => {\n  const [type, first, second] = tuple\n  switch (type) {\n    case 'remote': {\n      if (!first)\n        throw error('no remoteURL found on remote id', {\n          found: tuple,\n        })\n      return Spec.parse(name ?? '(unknown)', first)\n    }\n    case 'file': {\n      if (!first) {\n        throw error('no file path found on remote id', {\n          found: tuple,\n        })\n      }\n      return Spec.parse(name ?? '(unknown)', `file:${first}`, options)\n    }\n    case 'registry': {\n      if (typeof first !== 'string') {\n        throw error('no registry url or name in registry ID', {\n          found: tuple,\n        })\n      }\n      if (!second) {\n        throw error('no name/specifier in registry ID', {\n          found: tuple,\n        })\n      }\n      if (!first) {\n        // just a normal name@version on the default registry\n        const s = Spec.parse(second)\n        if (name && s.name !== name) {\n          return Spec.parse(`${name}@npm:${second}`)\n        } else {\n          return s\n        }\n      }\n      if (!/^https?:\\/\\//.test(first)) {\n        const reg = options.registries?.[first]\n        if (first !== 'npm' && !reg) {\n          throw error('named registry not found in options', {\n            name: first,\n            found: tuple,\n          })\n        }\n        return Spec.parse(\n          name ?? '(unknown)',\n          `${first}:${second}`,\n          options,\n        )\n      }\n      const s = Spec.parse(\n        name ?? '(unknown)',\n        `registry:${first}#${second}`,\n        options,\n      )\n      return name && s.final.name !== name ?\n          Spec.parse(s.final.name + '@' + s.bareSpec)\n        : s\n    }\n    case 'git': {\n      if (!first) {\n        throw error('no git remote in git ID', {\n          found: tuple,\n        })\n      }\n      return Spec.parse(\n        name ?? '(unknown)',\n        first + '#' + second,\n        options,\n      )\n    }\n    case 'workspace': {\n      if (!first) {\n        throw error('no name/path on workspace id', { found: tuple })\n      }\n      return name && name !== first ?\n          Spec.parse(name, `workspace:${first}@*`, options)\n        : Spec.parse(first, `workspace:*`, options)\n    }\n  }\n}\n\n// Strip out the default registry, there's no need to store that\nconst omitDefReg = (s?: string): string =>\n  (\n    !s ||\n    s === 'https://registry.npmjs.org' ||\n    s === 'https://registry.npmjs.org/'\n  ) ?\n    ''\n  : s\n\n/**\n * Get the {@link DepIDTuple} for a given {@link Spec} and {@link Manifest}.\n * The Manifest is used to get the name and version, if possible. If not found\n * in the manifest, registry ID types will use the name or bareSpec from the\n * specifier, so at least there's something to use later.\n */\nexport const getTuple = (spec: Spec, mani: Manifest): DepIDTuple => {\n  const f = spec.final\n  switch (f.type) {\n    case 'registry': {\n      // try to shorten to a known name if we can.\n      const reg = omitDefReg(f.registry)\n      if (!f.namedRegistry && reg) {\n        for (const [alias, host] of Object.entries(\n          spec.options.registries,\n        )) {\n          if (reg === host) {\n            f.namedRegistry = alias\n            break\n          }\n        }\n      }\n      return [\n        f.type,\n        f.namedRegistry ?? reg,\n        `${mani.name ?? spec.name}@${mani.version ?? spec.bareSpec}`,\n      ]\n    }\n    case 'git': {\n      const {\n        namedGitHost,\n        namedGitHostPath,\n        gitRemote,\n        gitSelector = '',\n      } = f\n      if (!gitRemote)\n        throw error('no host on git specifier', { spec })\n      if (namedGitHost) {\n        if (!namedGitHostPath) {\n          throw error('named git host without path portion', {\n            spec,\n          })\n        }\n        return [\n          f.type,\n          `${namedGitHost}:${namedGitHostPath}`,\n          gitSelector,\n        ]\n      } else {\n        return [f.type, gitRemote, gitSelector]\n      }\n    }\n    case 'remote': {\n      const { remoteURL } = f\n      if (!remoteURL)\n        throw error('no URL on remote specifier', { spec })\n      return [f.type, remoteURL]\n    }\n    case 'file':\n    case 'workspace':\n      throw error('Path-based dep ids are not supported', { spec })\n  }\n}\n\n/**\n * Get the {@link DepID} for a given {@link Spec} and {@link Manifest}. The\n * Manifest is used to get the name and version, if possible. If not found in\n * the manifest, registry ID types will use the name or bareSpec from the\n * specifier, so at least there's something to use later.\n */\nexport const getId = (spec: Spec, mani: Manifest): DepID =>\n  joinDepIDTuple(getTuple(spec, mani))\n"]}

package/dist/esm/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "module"
+}

package/package.json

@@ -0,0 +1,70 @@
+{
+  "name": "@vltpkg/dep-id",
+  "description": "create and hydrate dependency IDs",
+  "version": "0.0.0-0.1730239248325",
+  "tshy": {
+    "selfLink": false,
+    "dialects": [
+      "esm"
+    ],
+    "exports": {
+      "./package.json": "./package.json",
+      ".": "./src/index.ts",
+      "./browser": "./src/browser.ts"
+    }
+  },
+  "dependencies": {
+    "@vltpkg/error-cause": "0.0.0-0.1730239248325",
+    "@vltpkg/types": "0.0.0-0.1730239248325",
+    "@vltpkg/spec": "0.0.0-0.1730239248325"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.8.0",
+    "@types/eslint__js": "^8.42.3",
+    "@types/node": "^22.4.1",
+    "eslint": "^9.8.0",
+    "prettier": "^3.3.2",
+    "tap": "^21.0.1",
+    "tshy": "^3.0.2",
+    "typescript": "^5.5.4",
+    "typescript-eslint": "^8.0.1"
+  },
+  "license": "BSD-2-Clause-Patent",
+  "engines": {
+    "node": "20 || >=22"
+  },
+  "tap": {
+    "extends": "../../tap-config.yaml"
+  },
+  "prettier": "../../.prettierrc.js",
+  "module": "./dist/esm/index.js",
+  "type": "module",
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "import": {
+        "types": "./dist/esm/index.d.ts",
+        "default": "./dist/esm/index.js"
+      }
+    },
+    "./browser": {
+      "import": {
+        "types": "./dist/esm/browser.d.ts",
+        "default": "./dist/esm/browser.js"
+      }
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "format": "prettier --write . --log-level warn --ignore-path ../../.prettierignore --cache",
+    "format:check": "prettier --check . --ignore-path ../../.prettierignore --cache",
+    "lint": "eslint . --fix",
+    "lint:check": "eslint .",
+    "presnap": "tshy",
+    "snap": "tap",
+    "pretest": "tshy",
+    "test": "tap"
+  }
+}