@anizoptera/uuid-slug 0.3.0 → 0.5.0

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 (202) hide show
  1. package/LICENSE +54 -31
  2. package/README.md +373 -324
  3. package/dist/alphabet.d.ts +5 -17
  4. package/dist/alphabet.d.ts.map +1 -1
  5. package/dist/alphabet.js +146 -112
  6. package/dist/alphabet.js.map +1 -1
  7. package/dist/base64url-name.d.ts +7 -0
  8. package/dist/base64url-name.d.ts.map +1 -0
  9. package/dist/base64url-name.js +8 -0
  10. package/dist/base64url-name.js.map +1 -0
  11. package/dist/errors.d.ts +50 -9
  12. package/dist/errors.d.ts.map +1 -1
  13. package/dist/errors.js +145 -63
  14. package/dist/errors.js.map +1 -1
  15. package/dist/feistel.js +29 -95
  16. package/dist/feistel.js.map +1 -1
  17. package/dist/generation-options.js +20 -0
  18. package/dist/generation-options.js.map +1 -0
  19. package/dist/index.d.ts +22 -10
  20. package/dist/index.js +21 -9
  21. package/dist/instant.js +83 -0
  22. package/dist/instant.js.map +1 -0
  23. package/dist/mask-handle.d.ts +16 -0
  24. package/dist/mask-handle.d.ts.map +1 -0
  25. package/dist/mask-handle.js +60 -0
  26. package/dist/mask-handle.js.map +1 -0
  27. package/dist/mask.d.ts +27 -0
  28. package/dist/mask.d.ts.map +1 -0
  29. package/dist/mask.js +151 -95
  30. package/dist/mask.js.map +1 -1
  31. package/dist/masking-codec-protocol.js +23 -0
  32. package/dist/masking-codec-protocol.js.map +1 -0
  33. package/dist/masking-codec-types.d.ts +245 -0
  34. package/dist/masking-codec-types.d.ts.map +1 -0
  35. package/dist/masking-codec.d.ts +19 -0
  36. package/dist/masking-codec.d.ts.map +1 -0
  37. package/dist/masking-codec.js +391 -0
  38. package/dist/masking-codec.js.map +1 -0
  39. package/dist/migration.js +114 -51
  40. package/dist/migration.js.map +1 -1
  41. package/dist/node/runtime.js +39 -0
  42. package/dist/node/runtime.js.map +1 -0
  43. package/dist/payload.d.ts +7 -0
  44. package/dist/payload.d.ts.map +1 -0
  45. package/dist/payload.js +118 -0
  46. package/dist/payload.js.map +1 -0
  47. package/dist/runtime/pool.js +21 -46
  48. package/dist/runtime/pool.js.map +1 -1
  49. package/dist/runtime/portable.js +27 -0
  50. package/dist/runtime/portable.js.map +1 -0
  51. package/dist/sentinel.js +10 -0
  52. package/dist/sentinel.js.map +1 -0
  53. package/dist/siphash.js +20 -99
  54. package/dist/siphash.js.map +1 -1
  55. package/dist/slug.d.ts +169 -0
  56. package/dist/slug.d.ts.map +1 -0
  57. package/dist/slug.js +268 -0
  58. package/dist/slug.js.map +1 -0
  59. package/dist/timestamp.d.ts +19 -0
  60. package/dist/timestamp.d.ts.map +1 -0
  61. package/dist/timestamp.js +44 -0
  62. package/dist/timestamp.js.map +1 -0
  63. package/dist/types.d.ts +480 -200
  64. package/dist/types.d.ts.map +1 -1
  65. package/dist/types.js +8 -0
  66. package/dist/types.js.map +1 -0
  67. package/dist/uuid-value-protocol.js +46 -0
  68. package/dist/uuid-value-protocol.js.map +1 -0
  69. package/dist/uuid-value.d.ts +17 -0
  70. package/dist/uuid-value.d.ts.map +1 -0
  71. package/dist/uuid-value.js +127 -0
  72. package/dist/uuid-value.js.map +1 -0
  73. package/dist/uuid.d.ts +51 -64
  74. package/dist/uuid.d.ts.map +1 -1
  75. package/dist/uuid.js +203 -199
  76. package/dist/uuid.js.map +1 -1
  77. package/dist/v4-slug.d.ts +16 -0
  78. package/dist/v4-slug.d.ts.map +1 -0
  79. package/dist/v4-slug.js +16 -0
  80. package/dist/v4-slug.js.map +1 -0
  81. package/dist/v4.d.ts +42 -0
  82. package/dist/v4.d.ts.map +1 -0
  83. package/dist/v4.js +85 -0
  84. package/dist/v4.js.map +1 -0
  85. package/dist/v7-bounds.d.ts +36 -0
  86. package/dist/v7-bounds.d.ts.map +1 -0
  87. package/dist/v7-bounds.js +49 -0
  88. package/dist/v7-bounds.js.map +1 -0
  89. package/dist/v7-generator-input.js +75 -0
  90. package/dist/v7-generator-input.js.map +1 -0
  91. package/dist/v7-generator.d.ts +43 -0
  92. package/dist/v7-generator.d.ts.map +1 -0
  93. package/dist/v7-generator.js +105 -0
  94. package/dist/v7-generator.js.map +1 -0
  95. package/dist/v7-keyless.d.ts +46 -0
  96. package/dist/v7-keyless.d.ts.map +1 -0
  97. package/dist/v7-keyless.js +106 -0
  98. package/dist/v7-keyless.js.map +1 -0
  99. package/dist/v7-payload.js +54 -0
  100. package/dist/v7-payload.js.map +1 -0
  101. package/dist/v7-slug.d.ts +46 -0
  102. package/dist/v7-slug.d.ts.map +1 -0
  103. package/dist/v7-slug.js +127 -0
  104. package/dist/v7-slug.js.map +1 -0
  105. package/dist/v7-timestamp.js +9 -0
  106. package/dist/v7-timestamp.js.map +1 -0
  107. package/dist/v7-value-options.js +28 -0
  108. package/dist/v7-value-options.js.map +1 -0
  109. package/dist/v7-value.d.ts +23 -0
  110. package/dist/v7-value.d.ts.map +1 -0
  111. package/dist/v7-value.js +31 -0
  112. package/dist/v7-value.js.map +1 -0
  113. package/dist/v7.js +127 -171
  114. package/dist/v7.js.map +1 -1
  115. package/package.json +15 -8
  116. package/src/alphabet.ts +456 -27
  117. package/src/base64url-name.ts +5 -0
  118. package/src/errors.ts +373 -37
  119. package/src/feistel.ts +69 -56
  120. package/src/generation-options.ts +48 -0
  121. package/src/index.ts +134 -80
  122. package/src/instant.ts +196 -0
  123. package/src/keyless.ts +7 -134
  124. package/src/mask-handle.ts +141 -0
  125. package/src/mask.ts +354 -129
  126. package/src/masking-codec-protocol.ts +29 -0
  127. package/src/masking-codec-types.ts +380 -0
  128. package/src/masking-codec.ts +923 -0
  129. package/src/migration.ts +195 -42
  130. package/src/payload.ts +321 -0
  131. package/src/runtime/bun.ts +30 -49
  132. package/src/runtime/node.ts +43 -24
  133. package/src/runtime/pool.ts +49 -21
  134. package/src/runtime/portable.ts +68 -0
  135. package/src/runtime/types.ts +23 -35
  136. package/src/sentinel.ts +13 -0
  137. package/src/siphash.ts +5 -4
  138. package/src/slug.ts +884 -0
  139. package/src/timestamp.ts +122 -0
  140. package/src/types.ts +759 -205
  141. package/src/uuid-value-protocol.ts +77 -0
  142. package/src/uuid-value.ts +341 -0
  143. package/src/uuid.ts +514 -234
  144. package/src/v4-slug.ts +27 -0
  145. package/src/v4.ts +234 -0
  146. package/src/v7-bounds.ts +171 -0
  147. package/src/v7-generator-input.ts +169 -0
  148. package/src/v7-generator.ts +245 -0
  149. package/src/v7-keyless.ts +354 -0
  150. package/src/v7-payload.ts +121 -0
  151. package/src/v7-slug.ts +293 -0
  152. package/src/v7-timestamp.ts +21 -0
  153. package/src/v7-value-options.ts +62 -0
  154. package/src/v7-value.ts +54 -0
  155. package/src/v7.ts +377 -200
  156. package/dist/base64url.d.ts +0 -20
  157. package/dist/base64url.d.ts.map +0 -1
  158. package/dist/base64url.js +0 -33
  159. package/dist/base64url.js.map +0 -1
  160. package/dist/codec.d.ts +0 -17
  161. package/dist/codec.d.ts.map +0 -1
  162. package/dist/codec.js +0 -192
  163. package/dist/codec.js.map +0 -1
  164. package/dist/keyless.d.ts +0 -31
  165. package/dist/keyless.d.ts.map +0 -1
  166. package/dist/keyless.js +0 -93
  167. package/dist/keyless.js.map +0 -1
  168. package/dist/legacy-mask.js +0 -55
  169. package/dist/legacy-mask.js.map +0 -1
  170. package/dist/node/alphabet.js +0 -130
  171. package/dist/node/base64url.js +0 -31
  172. package/dist/node/codec.js +0 -190
  173. package/dist/node/errors.js +0 -78
  174. package/dist/node/feistel.js +0 -103
  175. package/dist/node/index.js +0 -10
  176. package/dist/node/keyless.js +0 -91
  177. package/dist/node/legacy-mask.js +0 -53
  178. package/dist/node/mask.js +0 -106
  179. package/dist/node/migration.js +0 -64
  180. package/dist/node/runtime/node.js +0 -33
  181. package/dist/node/runtime/pool.js +0 -53
  182. package/dist/node/schema.js +0 -214
  183. package/dist/node/siphash.js +0 -106
  184. package/dist/node/uuid.js +0 -226
  185. package/dist/node/v7.js +0 -185
  186. package/dist/node/yield.js +0 -20
  187. package/dist/runtime/web.js +0 -39
  188. package/dist/runtime/web.js.map +0 -1
  189. package/dist/schema.d.ts +0 -20
  190. package/dist/schema.d.ts.map +0 -1
  191. package/dist/schema.js +0 -216
  192. package/dist/schema.js.map +0 -1
  193. package/dist/v7.d.ts +0 -12
  194. package/dist/v7.d.ts.map +0 -1
  195. package/dist/yield.js +0 -22
  196. package/dist/yield.js.map +0 -1
  197. package/src/base64url.ts +0 -41
  198. package/src/codec.ts +0 -320
  199. package/src/legacy-mask.ts +0 -25
  200. package/src/runtime/web.ts +0 -48
  201. package/src/schema.ts +0 -300
  202. package/src/yield.ts +0 -22
@@ -0,0 +1,19 @@
1
+ // SPDX-License-Identifier: Apache-2.0
2
+ // @anizoptera/uuid-slug 0.5.0 | https://github.com/Anizoptera/uuid-slug#readme
3
+ import { UuidSlugError } from "./errors.js";
4
+ import { UUID_TEXT_LOWERCASE, UuidTextCase, UuidTextCaseArguments, UuidV7StringFor, UuidV7StringInput, UuidV7TimestampWindow } from "./types.js";
5
+ //#region src/timestamp.d.ts
6
+ /**
7
+ * Validate accepted UUIDv7 text and return its normalized hyphenated spelling when its timestamp is
8
+ * inside the inclusive symmetric window. Return `timestamp_outside_window` when it is not. This checks clock plausibility, not
9
+ * expiry, authentication, replay, or issuance. TypeScript rejects known slug and UUIDv4 values. A
10
+ * preceding `UuidSlugError` is returned unchanged.
11
+ *
12
+ * @param uuid - UUIDv7 text in an accepted spelling to validate and normalize. JavaScript also
13
+ * accepts a genuine `String` object.
14
+ * @param window - Inclusive maximum distance from an explicit or current reference time.
15
+ * @param textCase - Built-in output spelling. Omit for lowercase.
16
+ */
17
+ export declare function validateUuidV7StringUnixMs<Input extends string | UuidSlugError, Case extends UuidTextCase = typeof UUID_TEXT_LOWERCASE>(uuid: UuidV7StringInput<Input>, window: UuidV7TimestampWindow, ...textCase: UuidTextCaseArguments<Case>): UuidV7StringFor<Case> | UuidSlugError;
18
+ //#endregion
19
+ //# sourceMappingURL=timestamp.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"timestamp.d.ts","names":[],"sources":["../src/timestamp.ts"],"mappings":";;;;;;;;;;;;;;;;wBAuFgB,2BACd,uBAAuB,eACvB,aAAa,sBAAsB,qBAEnC,MAAM,kBAAkB,QACxB,QAAQ,0BACL,UAAU,sBAAsB,QAClC,gBAAgB,QAAQ"}
@@ -0,0 +1,44 @@
1
+ // SPDX-License-Identifier: Apache-2.0
2
+ // @anizoptera/uuid-slug 0.5.0 | https://github.com/Anizoptera/uuid-slug#readme
3
+ import { INVALID_TIMESTAMP as e, INVALID_UUID_VERSION as t, TIMESTAMP_OUTSIDE_WINDOW as n, UuidSlugError as r, findUnknownOption as i, normalizeUuidStringInput as a } from "./errors.js";
4
+ import { UUID_TEXT_LOWERCASE as o } from "./types.js";
5
+ import { formatUuidBytesUnchecked as s, isUuidV7Bytes as c, resolveUuidTextCase as l, uuidStringToBytes as u, uuidTimestampFromBytesUnchecked as d } from "./uuid.js";
6
+ //#region src/timestamp.ts
7
+ const f = {
8
+ maxTimestampDeltaMs: !0,
9
+ referenceUnixMs: !0
10
+ };
11
+ function validateTimestampBytes(a, o) {
12
+ if (!/* @__PURE__ */ c(a)) return new r(t, "Timestamp validation requires an RFC-variant UUIDv7.");
13
+ let s = /* @__PURE__ */ d(a, 0), l, u;
14
+ try {
15
+ if (typeof o != "object" || !o || Array.isArray(o)) return new r(e, "Timestamp window must be an object.");
16
+ let t = /* @__PURE__ */ i(o, f);
17
+ if (t !== void 0) return new r(e, `Unknown timestamp window option: ${t}.`);
18
+ l = o.maxTimestampDeltaMs, u = o.referenceUnixMs ?? Date.now();
19
+ } catch (t) {
20
+ return new r(e, "Timestamp window could not be read.", { cause: t });
21
+ }
22
+ if (!Number.isFinite(l) || l < 0) return new r(e, "maxTimestampDeltaMs must be a finite, nonnegative number of milliseconds.");
23
+ if (!Number.isFinite(u)) return new r(e, "referenceUnixMs must be a finite number of Unix milliseconds.");
24
+ if (s < u - l || s > u + l) return new r(n, `UUIDv7 timestamp ${s} is outside ${u - l}..${u + l} Unix milliseconds.`);
25
+ }
26
+ function validateUuidV7StringUnixMs(e, t, n = o) {
27
+ let r;
28
+ if (typeof e == "string") r = e;
29
+ else {
30
+ let t = a(e);
31
+ if (typeof t != "string") return t;
32
+ r = t;
33
+ }
34
+ let i = l(n);
35
+ if (i instanceof Error) return i;
36
+ let c = u(r);
37
+ if (c instanceof Error) return c;
38
+ let d = validateTimestampBytes(c, t);
39
+ return d instanceof Error ? d : r.length === 36 && (i === "lowercase" ? r === r.toLowerCase() : r === r.toUpperCase()) ? r : /* @__PURE__ */ s(c, 0, i);
40
+ }
41
+ //#endregion
42
+ export { validateTimestampBytes, validateUuidV7StringUnixMs };
43
+
44
+ //# sourceMappingURL=timestamp.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"timestamp.js","names":["TIMESTAMP_WINDOW_OPTIONS","bytes","UuidSlugError","INVALID_UUID_VERSION","timestamp","maxTimestampDeltaMs","referenceUnixMs","window","INVALID_TIMESTAMP","unknown","cause","TIMESTAMP_OUTSIDE_WINDOW","UUID_TEXT_LOWERCASE","uuidText","uuid","normalized","normalizeUuidStringInput","selectedCase","resolveUuidTextCase","textCase","uuidStringToBytes","valid"],"sources":["../src/timestamp.ts"],"mappings":";;;;;;AA0BA,MAAMA,IAA2B;CAC/B,qBAAqB;CACrB,iBAAiB;AACnB;AAGA,SAAgB,uBACd,GACA,GAC2B;CAC3B,IAAI,CAAC,kBAAcC,CAAK,GACtB,OAAO,IAAIC,EACTC,GACA,sDACF;CACF,IAAMC,IAAY,kBAAgCH,GAAO,CAAC,GACtDI,GACAC;CACJ,IAAI;EACF,IAAI,OAAOC,KAAW,aAAYA,KAAmB,MAAM,QAAQA,CAAM,GACvE,OAAO,IAAIL,EAAcM,GAAmB,qCAAqC;EACnF,IAAMC,IAAU,kBAAkBF,GAAQP,CAAwB;EAClE,IAAIS,MAAY,KAAA,GACd,OAAO,IAAIP,EAAcM,GAAmB,oCAAoCC,EAAQ,EAAE;EAE5F,AADA,IAAsBF,EAAO,qBAC7B,IAAkBA,EAAO,mBAAmB,KAAK,IAAI;CACvD,SAASG,GAAO;EACd,OAAO,IAAIR,EAAcM,GAAmB,uCAAuC,EAAE,SAAM,CAAC;CAC9F;CACA,IAAI,CAAC,OAAO,SAASH,CAAmB,KAAKA,IAAsB,GACjE,OAAO,IAAIH,EACTM,GACA,2EACF;CACF,IAAI,CAAC,OAAO,SAASF,CAAe,GAClC,OAAO,IAAIJ,EACTM,GACA,+DACF;CACF,IACEJ,IAAYE,IAAkBD,KAC9BD,IAAYE,IAAkBD,GAE9B,OAAO,IAAIH,EACTS,GACA,oBAAoBP,EAAU,cAAcE,IAAkBD,EAAoB,IAAIC,IAAkBD,EAAoB,oBAC9H;AAEJ;AAqBA,SAAgB,2BACd,GACA,GACA,IAAyBO,GACD;CACxB,IAAIC;CACJ,IAAI,OAAOC,KAAS,UAClB,IAAWA;MACN;EACL,IAAMC,IAAaC,EAAyBF,CAAI;EAChD,IAAI,OAAOC,KAAe,UAAU,OAAOA;EAC3C,IAAWA;CACb;CACA,IAAME,IAAeC,EAAoBC,CAAQ;CACjD,IAAIF,aAAwB,OAAO,OAAOA;CAC1C,IAAMhB,IAAQmB,EAAkBP,CAAQ;CACxC,IAAIZ,aAAiB,OAAO,OAAOA;CACnC,IAAMoB,IAAQ,uBAAuBpB,GAAOM,CAAM;CAQlD,OAPIc,aAAiB,QAAcA,IAEjCR,EAAS,WAAW,OACnBI,MAAA,cACGJ,MAAaA,EAAS,YAAY,IAClCA,MAAaA,EAAS,YAAY,KACZA,IACrB,kBAAyBZ,GAAO,GAAGgB,CAAY;AACxD"}