@cbortech/hash-extension 0.1.0 → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +16 -7
  2. package/package.json +12 -12
package/README.md CHANGED
@@ -18,13 +18,22 @@ import { hash } from '@cbortech/hash-extension';
18
18
 
19
19
  const cbor = new CBOR({ extensions: [hash] });
20
20
 
21
- const value = cbor.fromEDN("hash'foo'");
22
- console.log(value.toEDN({ appStrings: false }));
23
- // h'2c26b46b68ffc68ff99b453c1d30413413422d706483bfa0f98a5e886266e7ae'
24
-
25
- const sha512 = cbor.fromEDN('hash<<"foo", "SHA-512">>');
26
- console.log(sha512.toEDN());
27
- // hash<<'foo', "SHA-512">>
21
+ // Parse CBOR-EDN containing hash values.
22
+ const document = cbor.parse(`{
23
+ "hash": hash'foo'
24
+ }`);
25
+ // document.hash is a bare Uint8Array.
26
+
27
+ // Convert CBOR-EDN containing a hash value into CBOR.
28
+ const encoded = cbor.fromEDN("hash'foo'").toCBOR();
29
+ // encoded is CBOR binary data stored as a Uint8Array.
30
+ // Inspect the encoded CBOR value with toHexDump():
31
+ console.log(CBOR.fromCBOR(encoded).toHexDump());
32
+ // 58 20 2C 26 B4 6B 68 FF C6 8F F9 9B 45 3C 1D 30 41 34 13 42 2D 70 64 83 BF A0 F9 8A 5E 88 62 66 E7 AE -- h'2c26b46b68ffc68ff99b453c1d30413413422d706483bfa0f98a5e886266e7ae'
33
+
34
+ // Format CBOR-EDN with hash values as h'...'.
35
+ console.log(cbor.format(`{ "hash" : hash'foo' }`, { appStrings: false }));
36
+ // {"hash":h'2c26b46b68ffc68ff99b453c1d30413413422d706483bfa0f98a5e886266e7ae'}
28
37
  ```
29
38
 
30
39
  ## EDN Forms
package/package.json CHANGED
@@ -1,13 +1,13 @@
1
1
  {
2
2
  "name": "@cbortech/hash-extension",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "description": "Cryptographic hash application-string extension for @cbortech/cbor",
5
5
  "keywords": [
6
6
  "cbor",
7
7
  "cbor-edn",
8
8
  "hash"
9
9
  ],
10
- "homepage": "https://cbor.tech/",
10
+ "homepage": "https://github.com/cbortech/hash-extension",
11
11
  "repository": {
12
12
  "type": "git",
13
13
  "url": "git+https://github.com/cbortech/hash-extension.git"
@@ -64,24 +64,24 @@
64
64
  "format:check": "prettier --check ."
65
65
  },
66
66
  "peerDependencies": {
67
- "@cbortech/cbor": "^0.23.1"
67
+ "@cbortech/cbor": "^0.24.0"
68
68
  },
69
69
  "dependencies": {
70
70
  "@noble/hashes": "^2.2.0"
71
71
  },
72
72
  "devDependencies": {
73
- "@cbortech/cbor": "^0.23.1",
74
- "@types/node": "^24.12.3",
75
- "@vitest/browser": "^4.1.5",
76
- "@vitest/browser-playwright": "^4.1.5",
77
- "@vitest/coverage-v8": "^4.1.5",
78
- "@vitest/ui": "^4.1.5",
73
+ "@cbortech/cbor": "^0.24.0",
74
+ "@types/node": "^24.12.4",
75
+ "@vitest/browser": "^4.1.6",
76
+ "@vitest/browser-playwright": "^4.1.6",
77
+ "@vitest/coverage-v8": "^4.1.6",
78
+ "@vitest/ui": "^4.1.6",
79
79
  "cross-env": "^10.1.0",
80
- "playwright": "^1.59.1",
80
+ "playwright": "^1.60.0",
81
81
  "prettier": "^3.8.3",
82
82
  "typescript": "^5.9.3",
83
- "vite": "^8.0.11",
83
+ "vite": "^8.0.12",
84
84
  "vite-plugin-dts": "^4.5.4",
85
- "vitest": "^4.1.5"
85
+ "vitest": "^4.1.6"
86
86
  }
87
87
  }