@vltpkg/keychain 0.0.0-2

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,31 @@
+# @vltpkg/keychain
+
+The filesystem keychain for `@vltpkg/registry-client`
+
+**[Usage](#usage)**
+
+## Overview
+
+This is a tool to store and retrieve private keys for use in the
+`@vltpkg/registry-client`.
+
+## Usage
+
+```js
+import { Keychain } from '@vltpkg/keychain'
+
+// define a keychain with a given application scope
+const kc = new Keychain('vlt/auth')
+
+// fetch the auth for a given origin, for example.
+// will load file on demand when first get() called.
+const auth = await kc.get('https://registry.npmjs.org')
+
+// set a value like this
+kc.set('https://some-registry.com', 'Bearer newtoken')
+
+// will attempt to save on process end if there are pending
+// writes, but only if the file has not been modified since.
+// you can also trigger a write explicitly.
+await kc.save()
+```

package/dist/esm/index.d.ts

@@ -0,0 +1,15 @@
+export declare class Keychain<V extends string = string> {
+    #private;
+    constructor(application: string);
+    get file(): string;
+    get dirty(): boolean;
+    get(key: string): Promise<V | undefined>;
+    getSync(key: string): V | undefined;
+    load(): Promise<void>;
+    has(key: string): Promise<boolean>;
+    hasSync(key: string): boolean;
+    set(key: string, value: V): void;
+    delete(key: string): void;
+    save(): Promise<void>;
+}
+//# 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":"AAiBA,qBAAa,QAAQ,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM;;gBAOjC,WAAW,EAAE,MAAM;IAK/B,IAAI,IAAI,WAEP;IACD,IAAI,KAAK,YAER;IAEK,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;IAI9C,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,CAAC,GAAG,SAAS;IAI7B,IAAI;IAuBJ,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAIxC,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;IAW7B,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC;IAKzB,MAAM,CAAC,GAAG,EAAE,MAAM;IAgBZ,IAAI;CASX"}

package/dist/esm/index.js

@@ -0,0 +1,99 @@
+// Note: this class does NOT handle reading from the environment,
+// only the keychain file. Any other source of auth data should be
+// handled before or instead of this utility.
+import { XDG } from '@vltpkg/xdg';
+import { mkdir, readFile, rename, writeFile } from 'fs/promises';
+import { dirname } from 'path';
+const writeFileAtomic = async (path, data) => {
+    const p = path + String(Math.random());
+    await writeFile(p, data, { mode: 0o600 });
+    await rename(p, path);
+};
+const { hasOwnProperty } = Object.prototype;
+const hasOwn = (obj, key) => !!obj && typeof obj === 'object' && hasOwnProperty.call(obj, key);
+export class Keychain {
+    #data;
+    #didExitSave = false;
+    #dirty = false;
+    #file;
+    #xdg;
+    constructor(application) {
+        this.#xdg = new XDG(application);
+        this.#file = this.#xdg.data('keychain.json');
+    }
+    get file() {
+        return this.#file;
+    }
+    get dirty() {
+        return this.#dirty;
+    }
+    async get(key) {
+        return (await this.#load()).getSync(key);
+    }
+    getSync(key) {
+        return this.#data?.[key];
+    }
+    async load() {
+        await this.#load();
+    }
+    async #load() {
+        if (this.#data)
+            return this;
+        let ok = false;
+        try {
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+            this.#data = JSON.parse(await readFile(this.#file, 'utf8'));
+            ok = !!this.#data;
+        }
+        finally {
+            if (!ok) {
+                // just write the file if it failed in any way.
+                await this.#mkdir();
+                await writeFileAtomic(this.#file, '{}\n');
+                this.#data = {};
+            }
+            // eslint-disable-next-line no-unsafe-finally
+            return this;
+        }
+    }
+    async has(key) {
+        return (await this.#load()).hasSync(key);
+    }
+    hasSync(key) {
+        return !!hasOwn(this.#data, key);
+    }
+    async #mkdir() {
+        await mkdir(dirname(this.#file), {
+            recursive: true,
+            mode: 0o700,
+        });
+    }
+    set(key, value) {
+        ;
+        (this.#data ??= {})[key] = value;
+        this.#makeDirty();
+    }
+    delete(key) {
+        if (!this.#data)
+            return;
+        delete this.#data[key];
+        this.#makeDirty();
+    }
+    #makeDirty() {
+        this.#dirty = true;
+        if (!this.#didExitSave) {
+            this.#didExitSave = true;
+            process.once('beforeExit', () => {
+                void this.save();
+            });
+        }
+    }
+    async save() {
+        if (!this.#dirty || !this.#data)
+            return;
+        this.#dirty = false;
+        await this.#mkdir();
+        await writeFileAtomic(this.#file, JSON.stringify(this.#data) + '\n');
+    }
+}
+//# 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,iEAAiE;AACjE,kEAAkE;AAClE,6CAA6C;AAC7C,OAAO,EAAE,GAAG,EAAE,MAAM,aAAa,CAAA;AACjC,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAChE,OAAO,EAAE,OAAO,EAAE,MAAM,MAAM,CAAA;AAE9B,MAAM,eAAe,GAAG,KAAK,EAAE,IAAY,EAAE,IAAY,EAAE,EAAE;IAC3D,MAAM,CAAC,GAAG,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAA;IACtC,MAAM,SAAS,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAA;IACzC,MAAM,MAAM,CAAC,CAAC,EAAE,IAAI,CAAC,CAAA;AACvB,CAAC,CAAA;AAED,MAAM,EAAE,cAAc,EAAE,GAAG,MAAM,CAAC,SAAS,CAAA;AAC3C,MAAM,MAAM,GAAG,CAAC,GAAY,EAAE,GAAW,EAAE,EAAE,CAC3C,CAAC,CAAC,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,cAAc,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,CAAC,CAAA;AAEnE,MAAM,OAAO,QAAQ;IACnB,KAAK,CAAoB;IACzB,YAAY,GAAG,KAAK,CAAA;IACpB,MAAM,GAAG,KAAK,CAAA;IACd,KAAK,CAAQ;IACb,IAAI,CAAK;IAET,YAAY,WAAmB;QAC7B,IAAI,CAAC,IAAI,GAAG,IAAI,GAAG,CAAC,WAAW,CAAC,CAAA;QAChC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,CAAA;IAC9C,CAAC;IAED,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,KAAK,CAAA;IACnB,CAAC;IACD,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAA;IACpB,CAAC;IAED,KAAK,CAAC,GAAG,CAAC,GAAW;QACnB,OAAO,CAAC,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAA;IAC1C,CAAC;IAED,OAAO,CAAC,GAAW;QACjB,OAAO,IAAI,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC,CAAA;IAC1B,CAAC;IAED,KAAK,CAAC,IAAI;QACR,MAAM,IAAI,CAAC,KAAK,EAAE,CAAA;IACpB,CAAC;IAED,KAAK,CAAC,KAAK;QACT,IAAI,IAAI,CAAC,KAAK;YAAE,OAAO,IAAI,CAAA;QAC3B,IAAI,EAAE,GAAG,KAAK,CAAA;QACd,IAAI,CAAC;YACH,mEAAmE;YACnE,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,QAAQ,CAAC,IAAI,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAA;YAC3D,EAAE,GAAG,CAAC,CAAC,IAAI,CAAC,KAAK,CAAA;QACnB,CAAC;gBAAS,CAAC;YACT,IAAI,CAAC,EAAE,EAAE,CAAC;gBACR,+CAA+C;gBAC/C,MAAM,IAAI,CAAC,MAAM,EAAE,CAAA;gBACnB,MAAM,eAAe,CAAC,IAAI,CAAC,KAAK,EAAE,MAAM,CAAC,CAAA;gBACzC,IAAI,CAAC,KAAK,GAAG,EAAE,CAAA;YACjB,CAAC;YACD,6CAA6C;YAC7C,OAAO,IAAI,CAAA;QACb,CAAC;IACH,CAAC;IAED,KAAK,CAAC,GAAG,CAAC,GAAW;QACnB,OAAO,CAAC,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAA;IAC1C,CAAC;IAED,OAAO,CAAC,GAAW;QACjB,OAAO,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,GAAG,CAAC,CAAA;IAClC,CAAC;IAED,KAAK,CAAC,MAAM;QACV,MAAM,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE;YAC/B,SAAS,EAAE,IAAI;YACf,IAAI,EAAE,KAAK;SACZ,CAAC,CAAA;IACJ,CAAC;IAED,GAAG,CAAC,GAAW,EAAE,KAAQ;QACvB,CAAC;QAAA,CAAC,IAAI,CAAC,KAAK,KAAK,EAAE,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK,CAAA;QACjC,IAAI,CAAC,UAAU,EAAE,CAAA;IACnB,CAAC;IAED,MAAM,CAAC,GAAW;QAChB,IAAI,CAAC,IAAI,CAAC,KAAK;YAAE,OAAM;QACvB,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;QACtB,IAAI,CAAC,UAAU,EAAE,CAAA;IACnB,CAAC;IAED,UAAU;QACR,IAAI,CAAC,MAAM,GAAG,IAAI,CAAA;QAClB,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC;YACvB,IAAI,CAAC,YAAY,GAAG,IAAI,CAAA;YACxB,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,GAAG,EAAE;gBAC9B,KAAK,IAAI,CAAC,IAAI,EAAE,CAAA;YAClB,CAAC,CAAC,CAAA;QACJ,CAAC;IACH,CAAC;IAED,KAAK,CAAC,IAAI;QACR,IAAI,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,KAAK;YAAE,OAAM;QACvC,IAAI,CAAC,MAAM,GAAG,KAAK,CAAA;QACnB,MAAM,IAAI,CAAC,MAAM,EAAE,CAAA;QACnB,MAAM,eAAe,CACnB,IAAI,CAAC,KAAK,EACV,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,IAAI,CAClC,CAAA;IACH,CAAC;CACF","sourcesContent":["// Note: this class does NOT handle reading from the environment,\n// only the keychain file. Any other source of auth data should be\n// handled before or instead of this utility.\nimport { XDG } from '@vltpkg/xdg'\nimport { mkdir, readFile, rename, writeFile } from 'fs/promises'\nimport { dirname } from 'path'\n\nconst writeFileAtomic = async (path: string, data: string) => {\n  const p = path + String(Math.random())\n  await writeFile(p, data, { mode: 0o600 })\n  await rename(p, path)\n}\n\nconst { hasOwnProperty } = Object.prototype\nconst hasOwn = (obj: unknown, key: string) =>\n  !!obj && typeof obj === 'object' && hasOwnProperty.call(obj, key)\n\nexport class Keychain<V extends string = string> {\n  #data?: Record<string, V>\n  #didExitSave = false\n  #dirty = false\n  #file: string\n  #xdg: XDG\n\n  constructor(application: string) {\n    this.#xdg = new XDG(application)\n    this.#file = this.#xdg.data('keychain.json')\n  }\n\n  get file() {\n    return this.#file\n  }\n  get dirty() {\n    return this.#dirty\n  }\n\n  async get(key: string): Promise<V | undefined> {\n    return (await this.#load()).getSync(key)\n  }\n\n  getSync(key: string): V | undefined {\n    return this.#data?.[key]\n  }\n\n  async load() {\n    await this.#load()\n  }\n\n  async #load(): Promise<this> {\n    if (this.#data) return this\n    let ok = false\n    try {\n      // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment\n      this.#data = JSON.parse(await readFile(this.#file, 'utf8'))\n      ok = !!this.#data\n    } finally {\n      if (!ok) {\n        // just write the file if it failed in any way.\n        await this.#mkdir()\n        await writeFileAtomic(this.#file, '{}\\n')\n        this.#data = {}\n      }\n      // eslint-disable-next-line no-unsafe-finally\n      return this\n    }\n  }\n\n  async has(key: string): Promise<boolean> {\n    return (await this.#load()).hasSync(key)\n  }\n\n  hasSync(key: string): boolean {\n    return !!hasOwn(this.#data, key)\n  }\n\n  async #mkdir() {\n    await mkdir(dirname(this.#file), {\n      recursive: true,\n      mode: 0o700,\n    })\n  }\n\n  set(key: string, value: V) {\n    ;(this.#data ??= {})[key] = value\n    this.#makeDirty()\n  }\n\n  delete(key: string) {\n    if (!this.#data) return\n    delete this.#data[key]\n    this.#makeDirty()\n  }\n\n  #makeDirty() {\n    this.#dirty = true\n    if (!this.#didExitSave) {\n      this.#didExitSave = true\n      process.once('beforeExit', () => {\n        void this.save()\n      })\n    }\n  }\n\n  async save() {\n    if (!this.#dirty || !this.#data) return\n    this.#dirty = false\n    await this.#mkdir()\n    await writeFileAtomic(\n      this.#file,\n      JSON.stringify(this.#data) + '\\n',\n    )\n  }\n}\n"]}

package/dist/esm/package.json

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

package/package.json

@@ -0,0 +1,72 @@
+{
+  "name": "@vltpkg/keychain",
+  "description": "The filesystem keychain for `@vltpkg/registry-client`",
+  "version": "0.0.0-2",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/vltpkg/vltpkg.git",
+    "directory": "src/keychain"
+  },
+  "tshy": {
+    "selfLink": false,
+    "liveDev": true,
+    "dialects": [
+      "esm"
+    ],
+    "exports": {
+      "./package.json": "./package.json",
+      ".": "./src/index.ts"
+    }
+  },
+  "dependencies": {
+    "lru-cache": "^11.0.2",
+    "rimraf": "^6.0.1",
+    "@vltpkg/xdg": "0.0.0-2",
+    "@vltpkg/error-cause": "0.0.0-2",
+    "@vltpkg/types": "0.0.0-2"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.20.0",
+    "@types/eslint__js": "^8.42.3",
+    "@types/node": "^22.13.1",
+    "eslint": "^9.20.0",
+    "prettier": "^3.4.2",
+    "tap": "^21.1.0",
+    "tshy": "^3.0.2",
+    "typedoc": "0.27.6",
+    "typescript": "5.7.3",
+    "typescript-eslint": "^8.23.0"
+  },
+  "license": "BSD-2-Clause-Patent",
+  "engines": {
+    "node": ">=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"
+      }
+    }
+  },
+  "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 .",
+    "snap": "tap",
+    "test": "tap",
+    "posttest": "tsc --noEmit",
+    "typecheck": "tsc --noEmit"
+  }
+}