win-guid 0.1.3

package/LICENSE.txt

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright © 2026 Borewit
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,85 @@
+[![NPM version](https://img.shields.io/npm/v/win-guid.svg)](https://npmjs.org/package/win-guid)
+[![Node.js CI](https://github.com/Borewit/win-guid/actions/workflows/nodejs-ci.yml/badge.svg)](https://github.com/Borewit/win-guid/actions/workflows/nodejs-ci.yml)
+[![npm downloads](http://img.shields.io/npm/dm/win-guid.svg)](https://npmcharts.com/compare/win-guid?start=365)
+
+# win-guid
+
+Small, dependency-free utility for working with **Windows / CFBF GUIDs** in JavaScript and TypeScript.
+
+It parses canonical GUID strings into the **Windows byte layout** used by COM, OLE, and Compound File Binary Format (CFBF), and converts them back to the standard string form when needed.
+
+This is useful when dealing with Microsoft file formats such as `.asf`, `.doc,`, `.xls`, `.ppt`, structured storage,
+or other binary formats that store GUIDs in little-endian Windows order.
+
+For RFC9562 compliant UUIDs (network byte order), use [uuid](https://github.com/uuidjs/uuid) instead.
+
+## Installation
+
+```bash
+npm install win-guid
+```
+
+## Usage
+
+### Parse a GUID string
+
+```js
+import { parseWindowsGuid } from "win-guid";
+
+const bytes = parseWindowsGuid("00020906-0000-0000-C000-000000000046");
+
+// Uint8Array(16) in Windows / CFBF byte order
+```
+
+### Use the Guid helper class
+
+```js
+import { Guid } from "win-guid";
+
+const guid = Guid.fromString("00020906-0000-0000-C000-000000000046");
+```
+
+## API
+
+`parseWindowsGuid(guid: string): Uint8Array`
+
+Parses a canonical GUID string:
+```js
+const bytes = parseWindowsGuid("00020906-0000-0000-C000-000000000046");
+```
+
+into a 16-byte Uint8Array using Windows / CFBF byte order.
+
+- Input is validated strictly
+- Case-insensitive
+- Throws Error on invalid input
+
+`class Guid`
+
+Creates a GUID from a canonical GUID string.
+
+```js
+const guid = Guid.fromString("00020906-0000-0000-C000-000000000046");
+```
+
+`guid.toString(): string`
+
+Converts the GUID back into the canonical string form.
+
+- Always uppercase
+- Round-trips cleanly with fromString
+
+```js
+guid.toString();
+````
+Outputs something like:
+```
+00020906-0000-0000-C000-000000000046`
+```
+
+
+
+
+## Licence
+
+This project is licensed under the [MIT License](LICENSE.txt). Feel free to use, modify, and distribute as needed.

package/lib/guid.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Parse canonical GUID string (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)
+ * into Windows / CFBF byte order.
+ */
+export declare function parseWindowsGuid(guid: string): Uint8Array;
+export declare class Guid {
+    private readonly bytes;
+    constructor(bytes: Uint8Array);
+    static fromString(guid: string): Guid;
+    /**
+     * Convert Windows / CFBF byte order into canonical GUID string:
+     * xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
+     */
+    toString(): string;
+    /**
+     * Compare against a Uint8Array containing GUID bytes
+     * in Windows / CFBF layout.
+     */
+    equals(buf: Uint8Array, offset?: number): boolean;
+}

package/lib/guid.js

@@ -0,0 +1,107 @@
+/**
+ * Parse canonical GUID string (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)
+ * into Windows / CFBF byte order.
+ */
+export function parseWindowsGuid(guid) {
+    let s = guid.trim();
+    // Keep validation readable and strict, avoid lowercasing allocations
+    if (s.length !== 36 ||
+        s[8] !== "-" ||
+        s[13] !== "-" ||
+        s[18] !== "-" ||
+        s[23] !== "-") {
+        throw new Error(`Invalid GUID format: ${guid}`);
+    }
+    let v;
+    const out = new Uint8Array(16);
+    // Data1: 8 hex, uint32 little-endian
+    v = parseInt(s.slice(0, 8), 16);
+    out[0] = v & 0xff;
+    out[1] = (v >>> 8) & 0xff;
+    out[2] = (v >>> 16) & 0xff;
+    out[3] = (v >>> 24) & 0xff;
+    // Data2: 4 hex, uint16 little-endian
+    v = parseInt(s.slice(9, 13), 16);
+    out[4] = v & 0xff;
+    out[5] = (v >>> 8) & 0xff;
+    // Data3: 4 hex, uint16 little-endian
+    v = parseInt(s.slice(14, 18), 16);
+    out[6] = v & 0xff;
+    out[7] = (v >>> 8) & 0xff;
+    // Data4: 4 hex, as-is (string order)
+    v = parseInt(s.slice(19, 23), 16);
+    out[8] = (v >>> 8) & 0xff;
+    out[9] = v & 0xff;
+    // Data5: 12 hex, 6 bytes, as-is (string order)
+    // Parse as two chunks to avoid any precision worries, keep it simple.
+    v = parseInt(s.slice(24, 32), 16); // 8 hex -> 4 bytes
+    out[10] = (v >>> 24) & 0xff;
+    out[11] = (v >>> 16) & 0xff;
+    out[12] = (v >>> 8) & 0xff;
+    out[13] = v & 0xff;
+    v = parseInt(s.slice(32, 36), 16); // 4 hex -> 2 bytes
+    out[14] = (v >>> 8) & 0xff;
+    out[15] = v & 0xff;
+    // Ensure all parsed parts were valid hex (parseInt can yield NaN)
+    for (let i = 0; i < 16; i++) {
+        if (!Number.isFinite(out[i])) {
+            throw new Error(`Invalid GUID format: ${guid}`);
+        }
+    }
+    // Also catch NaN early (more useful error locality)
+    // If any parseInt produced NaN, assignments above would have become 0,
+    // so instead validate hex characters directly with a lightweight check.
+    // (Keeps code small while staying strict.)
+    if (!/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/.test(s)) {
+        throw new Error(`Invalid GUID format: ${guid}`);
+    }
+    return out;
+}
+export class Guid {
+    constructor(bytes) {
+        if (bytes.length !== 16)
+            throw new Error("GUID must be exactly 16 bytes");
+        this.bytes = bytes;
+    }
+    static fromString(guid) {
+        return new Guid(parseWindowsGuid(guid));
+    }
+    /**
+     * Convert Windows / CFBF byte order into canonical GUID string:
+     * xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
+     */
+    toString() {
+        const b = this.bytes;
+        const hx = (n) => n.toString(16).padStart(2, "0");
+        // Data1 (uint32 LE) -> big-endian text
+        const g1 = hx(b[3]) + hx(b[2]) + hx(b[1]) + hx(b[0]);
+        // Data2 (uint16 LE)
+        const g2 = hx(b[5]) + hx(b[4]);
+        // Data3 (uint16 LE)
+        const g3 = hx(b[7]) + hx(b[6]);
+        // Data4 (as-is)
+        const g4 = hx(b[8]) + hx(b[9]);
+        // Data5 (as-is)
+        const g5 = hx(b[10]) +
+            hx(b[11]) +
+            hx(b[12]) +
+            hx(b[13]) +
+            hx(b[14]) +
+            hx(b[15]);
+        return `${g1}-${g2}-${g3}-${g4}-${g5}`.toUpperCase();
+    }
+    /**
+     * Compare against a Uint8Array containing GUID bytes
+     * in Windows / CFBF layout.
+     */
+    equals(buf, offset = 0) {
+        if (offset < 0 || buf.length - offset < 16)
+            return false;
+        const a = this.bytes;
+        for (let i = 0; i < 16; i++) {
+            if (buf[offset + i] !== a[i])
+                return false;
+        }
+        return true;
+    }
+}

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "win-guid",
+  "version": "0.1.3",
+  "description": "Windows GUID",
+  "type": "module",
+  "exports": "./lib/guid.js",
+  "scripts": {
+    "clean": "del-cli 'lib/**/*.js' 'lib/**/*.js.map' 'lib/**/*.d.ts' 'src/**/*.d.ts'",
+    "compile-src": "tsc -p lib",
+    "compile": "yarn run  compile-src",
+    "format": "biome format",
+    "lint:ts": "biome check",
+    "build": "yarn run clean && yarn run compile",
+    "test": "mocha",
+    "prepublishOnly": "yarn run build",
+    "update-biome": "yarn add -D --exact @biomejs/biome && npx @biomejs/biome migrate --write"
+  },
+  "files": [
+    "lib/**/*.js",
+    "lib/**/*.d.ts",
+    "lib/*.cjs"
+  ],
+  "author": {
+    "name": "Borewit",
+    "url": "https://github.com/Borewit"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Borewit/win-guid.git"
+  },
+  "license": "MIT",
+  "devDependencies": {
+    "@types/chai": "^5.2.3",
+    "@types/mocha": "^10.0.10",
+    "biome": "^0.3.3",
+    "chai": "^6.2.2",
+    "del-cli": "^7.0.0",
+    "mocha": "^11.7.5",
+    "typescript": "^5.9.3"
+  },
+  "main": "index.js",
+  "packageManager": "yarn@4.9.1",
+  "keywords": [
+    "GUID",
+    "Windows",
+    "COM"
+  ]
+}