win-guid 0.1.3 → 0.2.0

package/README.md

@@ -4,14 +4,22 @@
 
 # win-guid
 
-Small, dependency-free utility for working with **Windows / CFBF GUIDs** in JavaScript and TypeScript.
+A module for decoding and encoding Windows GUIDs in the **Windows GUID byte layout** used by COM, OLE, and Compound File Binary Format (CFBF), and converting them back to the canonical string form when needed.
 
-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`, OLE/COM Structured Storage (CFBF), or other binary formats that store GUIDs in Windows order.
 
-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.
+## Windows GUID byte layout vs RFC 9562 UUID byte layout
 
-For RFC9562 compliant UUIDs (network byte order), use [uuid](https://github.com/uuidjs/uuid) instead.
+The table below shows how GUID `00112233-4455-6677-8899-AABBCCDDEEFF` is serialized as an [RFC 9562](https://www.rfc-editor.org/rfc/rfc9562.html) UUID versus a Windows GUID:
+
+| UUID / GUID type        | Serialized byte layout (hexadecimal)              |
+|-------------------------|---------------------------------------------------|
+| RFC 9562 UUID layout    | `00 11 22 33 44 55 66 77 88 99 AA BB CC DD EE FF` |
+| Windows GUID layout     | `33 22 11 00 55 44 77 66 88 99 AA BB CC DD EE FF` |
+
+Windows GUID layout reorders only the first three fields (32-bit, 16-bit, 16-bit). The remaining 8 bytes are stored as-is.
+
+For RFC 9562 compliant UUIDs (network byte order), use [uuid](https://github.com/uuidjs/uuid) instead.
 
 ## Installation
 
@@ -28,7 +36,7 @@ import { parseWindowsGuid } from "win-guid";
 
 const bytes = parseWindowsGuid("00020906-0000-0000-C000-000000000046");
 
-// Uint8Array(16) in Windows / CFBF byte order
+// Uint8Array(16) in Windows GUID byte order
 ```
 
 ### Use the Guid helper class
@@ -48,7 +56,7 @@ Parses a canonical GUID string:
 const bytes = parseWindowsGuid("00020906-0000-0000-C000-000000000046");
 ```
 
-into a 16-byte Uint8Array using Windows / CFBF byte order.
+into a 16-byte `Uint8Array` using Windows GUID byte order.
 
 - Input is validated strictly
 - Case-insensitive
@@ -71,14 +79,23 @@ Converts the GUID back into the canonical string form.
 
 ```js
 guid.toString();
-````
+```
 Outputs something like:
 ```
 00020906-0000-0000-C000-000000000046`
 ```
 
+`guid.bytes: Uint8Array`
 
+Provides access to the raw 16-byte GUID in Windows / CFBF byte order.
 
+Notes:
+- The returned value is a `Uint8Array(16)`
+- It represents the Windows GUID byte layout (as stored in COM, OLE, CFBF, and related formats)
+
+```js
+const bytes = guid.bytes;
+```
 
 ## Licence
 

package/lib/guid.d.ts

@@ -4,7 +4,7 @@
  */
 export declare function parseWindowsGuid(guid: string): Uint8Array;
 export declare class Guid {
-    private readonly bytes;
+    readonly bytes: Uint8Array;
     constructor(bytes: Uint8Array);
     static fromString(guid: string): Guid;
     /**

package/package.json

@@ -1,48 +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"
-  ]
-}
+{
+  "name": "win-guid",
+  "version": "0.2.0",
+  "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"
+  ]
+}