@vltpkg/user-agent 1.1.1

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,34 @@
+# @vltpkg/user-agent
+
+The `User-Agent` string that vlt sends with every outbound request.
+
+**[Usage](#usage)**
+
+## Overview
+
+Every place in the client that talks to a registry or an API sends the
+same `User-Agent`, and lifecycle scripts see the same value in
+`npm_config_user_agent`. This package is the single source of that
+string so the various clients cannot drift apart.
+
+The value is the vlt version followed by the runtime, which is taken
+from `navigator.userAgent` when one is available, and otherwise
+detected from `process.versions`.
+
+This package has no dependencies and touches no node builtins, so it
+is safe to use from browser-safe packages such as `@vltpkg/query`.
+
+## Usage
+
+```js
+import { userAgent, userAgentHeaders } from '@vltpkg/user-agent'
+
+console.log(userAgent) // vlt/1.0.10 Node.js/22.22.0
+
+// `userAgentHeaders` is `{ 'User-Agent': userAgent }` in Node.js, Bun and
+// Deno, and `{}` in a browser, where the header cannot be set by scripts
+// and would otherwise force a CORS preflight on cross-origin requests.
+await fetch(url, {
+  headers: { Accept: 'application/json', ...userAgentHeaders },
+})
+```

package/dist/index.d.ts

@@ -0,0 +1,18 @@
+/**
+ * The `User-Agent` header sent with every request vlt makes, and the value
+ * of `npm_config_user_agent` in lifecycle script environments.
+ *
+ * Looks like `vlt/1.2.3 Node.js/22.22.0`, with the trailing portion coming
+ * from `navigator.userAgent` when the runtime provides one.
+ */
+export declare const userAgent: string;
+/**
+ * Headers to spread into the `headers` of a `fetch()` call so that the
+ * request carries {@link userAgent}.
+ *
+ * Empty in browsers: the browser sets its own `User-Agent` and does not let
+ * scripts override it, and since `User-Agent` is not a CORS-safelisted
+ * request header, setting it would force a preflight on cross-origin
+ * registry requests that not every registry accepts.
+ */
+export declare const userAgentHeaders: Readonly<Record<string, string>>;

package/dist/index.js

@@ -0,0 +1,43 @@
+import pkg from '@vltpkg/user-agent/package.json' with { type: 'json' };
+// Read the runtime off of globalThis rather than importing `node:process`
+// so that this stays usable from browser-safe packages.
+const { navigator: nav, process: proc } = globalThis;
+/* c8 ignore next - there is no `process` in a browser */
+const versions = proc?.versions ?? {};
+const isObj = (v) => typeof v === 'object' && !!v;
+const { Deno, Bun } = globalThis;
+const isDeno = isObj(Deno);
+const isBun = !isDeno && isObj(Bun);
+// bun and deno also report 'node' in process.versions so its only
+// node if it is not bun or deno
+const isNode = !isDeno && !isBun && 'node' in versions;
+// All the runtimes put their versions into process.versions
+const bun = isBun ? versions.bun : undefined;
+const deno = isDeno ? versions.deno : undefined;
+const node = isNode ? versions.node : undefined;
+// Anything that is not one of the server-side runtimes we know about
+// is treated as a browser (or browser-like) environment.
+const isBrowser = !isDeno && !isBun && !isNode;
+const runtime = nav?.userAgent ??
+    (bun ? `Bun/${bun}`
+        : deno ? `Deno/${deno}`
+            : node ? `Node.js/${node}`
+                : '(unknown platform)');
+/**
+ * The `User-Agent` header sent with every request vlt makes, and the value
+ * of `npm_config_user_agent` in lifecycle script environments.
+ *
+ * Looks like `vlt/1.2.3 Node.js/22.22.0`, with the trailing portion coming
+ * from `navigator.userAgent` when the runtime provides one.
+ */
+export const userAgent = `vlt/${pkg.version} ${runtime}`;
+/**
+ * Headers to spread into the `headers` of a `fetch()` call so that the
+ * request carries {@link userAgent}.
+ *
+ * Empty in browsers: the browser sets its own `User-Agent` and does not let
+ * scripts override it, and since `User-Agent` is not a CORS-safelisted
+ * request header, setting it would force a preflight on cross-origin
+ * registry requests that not every registry accepts.
+ */
+export const userAgentHeaders = isBrowser ? {} : { 'User-Agent': userAgent };

package/package.json

@@ -0,0 +1,64 @@
+{
+  "name": "@vltpkg/user-agent",
+  "description": "The User-Agent string that vlt sends with every outbound request",
+  "version": "1.1.1",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/vltpkg/vltpkg.git",
+    "directory": "src/user-agent"
+  },
+  "author": {
+    "name": "vlt technology inc.",
+    "email": "support@vlt.sh",
+    "url": "http://vlt.sh"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.39.1",
+    "@types/node": "^22.19.2",
+    "eslint": "^9.39.1",
+    "prettier": "^3.7.4",
+    "tap": "^21.5.0",
+    "typedoc": "~0.27.9",
+    "typescript": "5.7.3",
+    "typescript-eslint": "^8.49.0"
+  },
+  "license": "BSD-2-Clause-Patent",
+  "engines": {
+    "node": ">=22.22.0"
+  },
+  "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 .",
+    "prepack": "tsc -p tsconfig.publish.json && ../../scripts/update-dist-exports.ts",
+    "snap": "tap",
+    "test": "tap",
+    "posttest": "tsc --noEmit",
+    "typecheck": "tsc --noEmit"
+  },
+  "tap": {
+    "extends": "../../tap-config.yaml"
+  },
+  "prettier": "../../.prettierrc.js",
+  "module": "./dist/index.js",
+  "type": "module",
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "import": {
+        "default": "./dist/index.js"
+      }
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "bugs": [
+    {
+      "type": "link",
+      "url": "https://github.com/vltpkg/vltpkg/issues"
+    }
+  ],
+  "homepage": "https://github.com/vltpkg/vltpkg/tree/main/src/user-agent#readme"
+}