@helipod/id-codec 0.1.0 → 0.1.3
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.
- package/README.md +21 -0
- package/package.json +3 -3
package/README.md
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# @helipod/id-codec
|
|
2
|
+
|
|
3
|
+
Document id encoding and decoding for the Helipod engine.
|
|
4
|
+
|
|
5
|
+
A Helipod document id packs a table number and a random internal id into a compact,
|
|
6
|
+
self-validating string: base32-encoded with a checksum, so a corrupted or foreign id
|
|
7
|
+
is rejected at decode time rather than silently misrouted. This package owns that
|
|
8
|
+
codec and the binary primitives beneath it (base32, checksums, varints), plus the
|
|
9
|
+
table registry that maps table names to numbers, storage id helpers, and the shard
|
|
10
|
+
identity types used to route writes.
|
|
11
|
+
|
|
12
|
+
Everything in the engine that mints, parses, or compares a document id goes through
|
|
13
|
+
this package, which is what lets ids stay stable across storage backends and appear
|
|
14
|
+
as plain typed strings in application code.
|
|
15
|
+
|
|
16
|
+
> This is an internal package of the Helipod engine. Most applications should install
|
|
17
|
+
> [`helipod`](https://www.npmjs.com/package/helipod) instead.
|
|
18
|
+
|
|
19
|
+
Part of [Helipod](https://github.com/helipod-sh/helipod) — docs at https://helipod-six.vercel.app/docs
|
|
20
|
+
|
|
21
|
+
License: FSL-1.1-Apache-2.0
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@helipod/id-codec",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.3",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"license": "FSL-1.1-Apache-2.0",
|
|
6
6
|
"sideEffects": false,
|
|
@@ -17,11 +17,11 @@
|
|
|
17
17
|
"dist"
|
|
18
18
|
],
|
|
19
19
|
"dependencies": {
|
|
20
|
-
"@helipod/index-key-codec": "0.1.
|
|
20
|
+
"@helipod/index-key-codec": "0.1.3"
|
|
21
21
|
},
|
|
22
22
|
"scripts": {
|
|
23
23
|
"build": "tsup",
|
|
24
|
-
"test": "vitest run",
|
|
24
|
+
"test": "vitest run --testTimeout=60000 --hookTimeout=60000",
|
|
25
25
|
"typecheck": "tsc --noEmit",
|
|
26
26
|
"clean": "rm -rf dist .turbo"
|
|
27
27
|
},
|