@anizoptera/uuid-slug 0.2.0 → 0.3.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 (95) hide show
  1. package/README.md +381 -27
  2. package/dist/alphabet.d.ts +21 -0
  3. package/dist/alphabet.d.ts.map +1 -0
  4. package/dist/alphabet.js +132 -0
  5. package/dist/alphabet.js.map +1 -0
  6. package/dist/base64url.d.ts +20 -0
  7. package/dist/base64url.d.ts.map +1 -0
  8. package/dist/base64url.js +33 -0
  9. package/dist/base64url.js.map +1 -0
  10. package/dist/codec.d.ts +17 -0
  11. package/dist/codec.d.ts.map +1 -0
  12. package/dist/codec.js +192 -0
  13. package/dist/codec.js.map +1 -0
  14. package/dist/errors.d.ts +16 -0
  15. package/dist/errors.d.ts.map +1 -0
  16. package/dist/errors.js +80 -0
  17. package/dist/errors.js.map +1 -0
  18. package/dist/feistel.js +105 -0
  19. package/dist/feistel.js.map +1 -0
  20. package/dist/index.d.ts +11 -168
  21. package/dist/index.js +10 -649
  22. package/dist/keyless.d.ts +31 -0
  23. package/dist/keyless.d.ts.map +1 -0
  24. package/dist/keyless.js +93 -0
  25. package/dist/keyless.js.map +1 -0
  26. package/dist/legacy-mask.js +55 -0
  27. package/dist/legacy-mask.js.map +1 -0
  28. package/dist/mask.js +108 -0
  29. package/dist/mask.js.map +1 -0
  30. package/dist/migration.js +66 -0
  31. package/dist/migration.js.map +1 -0
  32. package/dist/node/alphabet.js +130 -0
  33. package/dist/node/base64url.js +31 -0
  34. package/dist/node/codec.js +190 -0
  35. package/dist/node/errors.js +78 -0
  36. package/dist/node/feistel.js +103 -0
  37. package/dist/node/index.js +10 -647
  38. package/dist/node/keyless.js +91 -0
  39. package/dist/node/legacy-mask.js +53 -0
  40. package/dist/node/mask.js +106 -0
  41. package/dist/node/migration.js +64 -0
  42. package/dist/node/runtime/node.js +33 -0
  43. package/dist/node/runtime/pool.js +53 -0
  44. package/dist/node/schema.js +214 -0
  45. package/dist/node/siphash.js +106 -0
  46. package/dist/node/uuid.js +226 -0
  47. package/dist/node/v7.js +185 -0
  48. package/dist/node/yield.js +20 -0
  49. package/dist/runtime/pool.js +55 -0
  50. package/dist/runtime/pool.js.map +1 -0
  51. package/dist/runtime/web.js +39 -0
  52. package/dist/runtime/web.js.map +1 -0
  53. package/dist/schema.d.ts +20 -0
  54. package/dist/schema.d.ts.map +1 -0
  55. package/dist/schema.js +216 -0
  56. package/dist/schema.js.map +1 -0
  57. package/dist/siphash.js +108 -0
  58. package/dist/siphash.js.map +1 -0
  59. package/dist/types.d.ts +255 -0
  60. package/dist/types.d.ts.map +1 -0
  61. package/dist/uuid.d.ts +78 -0
  62. package/dist/uuid.d.ts.map +1 -0
  63. package/dist/uuid.js +228 -0
  64. package/dist/uuid.js.map +1 -0
  65. package/dist/v7.d.ts +12 -0
  66. package/dist/v7.d.ts.map +1 -0
  67. package/dist/v7.js +187 -0
  68. package/dist/v7.js.map +1 -0
  69. package/dist/yield.js +22 -0
  70. package/dist/yield.js.map +1 -0
  71. package/package.json +8 -12
  72. package/src/alphabet.ts +187 -0
  73. package/src/base64url.ts +28 -63
  74. package/src/codec.ts +227 -125
  75. package/src/errors.ts +83 -9
  76. package/src/feistel.ts +128 -0
  77. package/src/index.ts +52 -26
  78. package/src/keyless.ts +136 -0
  79. package/src/legacy-mask.ts +25 -0
  80. package/src/mask.ts +129 -67
  81. package/src/migration.ts +104 -0
  82. package/src/runtime/bun.ts +49 -24
  83. package/src/runtime/node.ts +33 -15
  84. package/src/runtime/pool.ts +62 -0
  85. package/src/runtime/types.ts +42 -5
  86. package/src/runtime/web.ts +37 -9
  87. package/src/schema.ts +274 -97
  88. package/src/siphash.ts +127 -0
  89. package/src/types.ts +221 -37
  90. package/src/uuid.ts +189 -50
  91. package/src/v7.ts +217 -45
  92. package/src/yield.ts +22 -0
  93. package/dist/index.d.ts.map +0 -1
  94. package/dist/index.js.map +0 -1
  95. package/dist/web/index.js +0 -648
package/dist/index.d.ts CHANGED
@@ -1,168 +1,11 @@
1
- //#region src/types.d.ts
2
- declare const brand: unique symbol;
3
- type Brand<T, Name extends string> = T & {
4
- readonly [brand]?: Name;
5
- };
6
- type Base64UrlString = Brand<string, "Base64UrlString">;
7
- type UuidString = Brand<string, "UuidString">;
8
- type UuidV4String = Brand<UuidString, "UuidV4String">;
9
- type UuidV7String = Brand<UuidString, "UuidV7String">;
10
- type UuidSlug = Brand<Base64UrlString, "UuidSlug">;
11
- type UuidV4Slug = Brand<UuidSlug, "UuidV4Slug">;
12
- type UuidV7Slug = Brand<UuidSlug, "UuidV7Slug">;
13
- type MaskedUuidSlug = Brand<UuidSlug, "MaskedUuidSlug">;
14
- type MaskedUuidV7Slug = Brand<MaskedUuidSlug, "MaskedUuidV7Slug">;
15
- type SentinelUuidV7Slug = Brand<UuidV7Slug, "SentinelUuidV7Slug">;
16
- type PublicUuidV7Slug = MaskedUuidV7Slug | SentinelUuidV7Slug;
17
- type UuidBytes = Brand<Uint8Array, "UuidBytes">;
18
- interface FreshValidationOptions {
19
- now?: () => number;
20
- windowMs?: number;
21
- }
22
- interface UuidV7Generator {
23
- uuidV7(): UuidV7String;
24
- uuidV7Bytes(out?: Uint8Array, offset?: number): Error | Uint8Array;
25
- }
26
- interface MaskSchema {
27
- readonly id: string;
28
- readonly inverse: Uint8Array;
29
- readonly permute: Uint8Array;
30
- readonly tagBits: 4 | 6;
31
- readonly xor: Uint8Array;
32
- }
33
- interface MaskSchemaOptions {
34
- readonly id?: string;
35
- readonly seed: string | Uint8Array;
36
- readonly tagBits?: 4 | 6;
37
- }
38
- interface ExplicitMaskSchema {
39
- readonly id?: string;
40
- readonly permute: Uint8Array;
41
- readonly tagBits: 4 | 6;
42
- readonly xor: Uint8Array;
43
- }
44
- interface UuidV7SentinelDefinition {
45
- readonly name: string;
46
- readonly uuid: UuidV7String;
47
- }
48
- interface UuidV7Sentinel {
49
- readonly name: string;
50
- readonly slug: SentinelUuidV7Slug;
51
- readonly uuid: UuidV7String;
52
- }
53
- interface UuidSlugCodecOptions {
54
- readonly generator?: UuidV7Generator;
55
- readonly legacy?: {
56
- readonly directDecode?: boolean;
57
- readonly masks?: readonly MaskSchema[];
58
- };
59
- readonly mask?: MaskSchema | MaskSchemaOptions;
60
- readonly sentinels?: readonly UuidV7SentinelDefinition[];
61
- }
62
- interface UuidSlugCodec {
63
- readonly sentinels: readonly UuidV7Sentinel[];
64
- uuidV4(): UuidV4String;
65
- uuidV7(): UuidV7String;
66
- uuidV4Bytes(out?: Uint8Array, offset?: number): Error | Uint8Array;
67
- uuidV7Bytes(out?: Uint8Array, offset?: number): Error | Uint8Array;
68
- uuidV4Slug(): UuidV4Slug;
69
- uuidV7Slug(): UuidV7Slug;
70
- uuidV7MaskedSlug(): MaskedUuidV7Slug;
71
- uuidToSlug(uuid: string): Error | UuidSlug;
72
- slugToUuid(slug: string): Error | UuidString;
73
- uuidToMaskedSlug(uuid: string): Error | MaskedUuidSlug;
74
- maskedSlugToUuid(slug: string): Error | UuidString;
75
- uuidV7ToMaskedSlug(uuid: string): Error | PublicUuidV7Slug;
76
- maskedSlugToUuidV7(slug: string): Error | UuidV7String;
77
- parseUuid(uuid: string, out?: Uint8Array, offset?: number): Error | Uint8Array;
78
- formatUuid(bytes: Uint8Array, offset?: number): Error | UuidString;
79
- parseUuidSlug(slug: string, out?: Uint8Array, offset?: number): Error | Uint8Array;
80
- formatUuidSlug(bytes: Uint8Array, offset?: number): Error | UuidSlug;
81
- }
82
- //#endregion
83
- //#region src/base64url.d.ts
84
- declare function encodeBase64Url(bytes: Uint8Array): Base64UrlString;
85
- declare function decodeBase64Url(value: string, out?: Uint8Array, offset?: number): Error | Uint8Array;
86
- declare function isBase64Url(value: null | string | undefined): value is Base64UrlString;
87
- //#endregion
88
- //#region src/uuid.d.ts
89
- declare function parseUuid(uuid: string, out?: Uint8Array, offset?: number): Error | Uint8Array;
90
- declare function formatUuid(bytes: Uint8Array, offset?: number): Error | UuidString;
91
- declare function isUuidString(uuid: null | string | undefined): uuid is UuidString;
92
- declare function isUuidV4String(uuid: null | string | undefined): uuid is UuidV4String;
93
- declare function isUuidV7String(uuid: null | string | undefined): uuid is UuidV7String;
94
- declare function isUuidV7Bytes(bytes: Uint8Array): boolean;
95
- declare function uuidBytesToSlug(bytes: Uint8Array, offset?: number): Error | UuidSlug;
96
- declare function slugToUuidBytes(slug: string, out?: Uint8Array, offset?: number): Error | Uint8Array;
97
- declare function uuidToSlug(uuid: string): Error | UuidSlug;
98
- declare function slugToUuid(slug: string): Error | UuidString;
99
- declare function formatUuidSlug(bytes: Uint8Array, offset?: number): Error | UuidSlug;
100
- declare function parseUuidSlug(slug: string, out?: Uint8Array, offset?: number): Error | Uint8Array;
101
- declare function isUuidSlug(slug: null | string | undefined): slug is UuidSlug;
102
- declare function isUuidV4Slug(slug: null | string | undefined): slug is UuidV4Slug;
103
- declare function isUuidV7Slug(slug: null | string | undefined): slug is UuidV7Slug;
104
- declare function extractUuidV7Timestamp(bytes: Uint8Array, offset?: number): number;
105
- declare function hasUuidV7Entropy(bytes: Uint8Array, offset?: number): boolean;
106
- //#endregion
107
- //#region src/codec.d.ts
108
- declare const UUID_V7_SENTINEL_DEFINITIONS: readonly UuidV7SentinelDefinition[];
109
- declare function createUuidSlugCodec(options?: UuidSlugCodecOptions): UuidSlugCodec;
110
- declare const defaultCodec: UuidSlugCodec;
111
- declare function validateUuidV7Fresh(uuid: string, options?: FreshValidationOptions): Error | UuidV7String;
112
- declare function validateUuidV7SlugFresh(slug: string, options?: FreshValidationOptions): Error | UuidV7Slug;
113
- declare function validateMaskedUuidV7SlugFresh(slug: string, options?: FreshValidationOptions): Error | MaskedUuidV7Slug;
114
- //#endregion
115
- //#region src/errors.d.ts
116
- type UuidSlugErrorCode = "invalid_base64url" | "invalid_buffer" | "invalid_mask_schema" | "invalid_uuid" | "invalid_uuid_slug" | "invalid_uuid_version" | "rng_unavailable" | "stale_uuid";
117
- declare class UuidSlugError extends Error {
118
- readonly code: UuidSlugErrorCode;
119
- constructor(code: UuidSlugErrorCode, message: string, options?: ErrorOptions);
120
- }
121
- declare class UuidRuntimeError extends UuidSlugError {
122
- constructor(message: string, options?: ErrorOptions);
123
- }
124
- //#endregion
125
- //#region src/schema.d.ts
126
- declare const LEGACY_MASK_SCHEMA_V1: MaskSchema;
127
- declare function defineMaskSchema(schema: ExplicitMaskSchema): Error | MaskSchema;
128
- declare function createMaskSchema(options: MaskSchemaOptions): Error | MaskSchema;
129
- declare const DEFAULT_MASK_SCHEMA: MaskSchema;
130
- //#endregion
131
- //#region src/runtime/types.d.ts
132
- interface Runtime {
133
- /**
134
- * The buffer is pinned to a plain `ArrayBuffer` because Web Crypto's `getRandomValues`
135
- * rejects a `SharedArrayBuffer` view at runtime, and the unparameterised `Uint8Array`
136
- * admits one. Narrowing here makes that refusal unrepresentable instead of a throw.
137
- */
138
- fillRandom(bytes: Uint8Array<ArrayBuffer>): void;
139
- uuidV4?(): string;
140
- uuidV7?(): string;
141
- uuidV7Bytes?(out?: Uint8Array, offset?: number): Uint8Array;
142
- uuidV7Slug?(): string;
143
- }
144
- //#endregion
145
- //#region src/v7.d.ts
146
- interface UuidV7GeneratorOptions {
147
- readonly clock?: () => number;
148
- readonly fillRandom: (bytes: Uint8Array<ArrayBuffer>) => void;
149
- }
150
- declare function createUuidV7Generator(options: UuidV7GeneratorOptions): UuidV7Generator;
151
- declare function createRuntimeGenerator(runtime: Runtime): UuidV7Generator;
152
- //#endregion
153
- //#region src/index.d.ts
154
- declare const uuidV4: () => UuidV4String;
155
- declare const uuidV7: () => UuidV7String;
156
- declare const uuidV4Bytes: (out?: Uint8Array, offset?: number) => Error | Uint8Array;
157
- declare const uuidV7Bytes: (out?: Uint8Array, offset?: number) => Error | Uint8Array;
158
- declare const uuidV4Slug: () => UuidV4Slug;
159
- declare const uuidV7Slug: () => UuidV7Slug;
160
- declare const uuidV7MaskedSlug: () => MaskedUuidV7Slug;
161
- declare const uuidToMaskedSlug: (uuid: string) => Error | MaskedUuidSlug;
162
- declare const maskedSlugToUuid: (slug: string) => Error | UuidString;
163
- declare const uuidV7ToMaskedSlug: (uuid: string) => Error | PublicUuidV7Slug;
164
- declare const maskedSlugToUuidV7: (slug: string) => Error | UuidV7String;
165
- declare const UUID_V7_SENTINELS: readonly UuidV7Sentinel[];
166
- //#endregion
167
- export { type Base64UrlString, DEFAULT_MASK_SCHEMA, type ExplicitMaskSchema, type FreshValidationOptions, LEGACY_MASK_SCHEMA_V1, type MaskSchema, type MaskSchemaOptions, type MaskedUuidSlug, type MaskedUuidV7Slug, type PublicUuidV7Slug, type SentinelUuidV7Slug, UUID_V7_SENTINELS, UUID_V7_SENTINEL_DEFINITIONS, type UuidBytes, UuidRuntimeError, type UuidSlug, type UuidSlugCodec, type UuidSlugCodecOptions, UuidSlugError, type UuidString, type UuidV4Slug, type UuidV4String, type UuidV7Generator, type UuidV7Sentinel, type UuidV7SentinelDefinition, type UuidV7Slug, type UuidV7String, createMaskSchema, createRuntimeGenerator, createUuidSlugCodec, createUuidV7Generator, decodeBase64Url, defaultCodec, defineMaskSchema, encodeBase64Url, extractUuidV7Timestamp, formatUuid, formatUuidSlug, hasUuidV7Entropy, isBase64Url, isUuidSlug, isUuidString, isUuidV4Slug, isUuidV4String, isUuidV7Bytes, isUuidV7Slug, isUuidV7String, maskedSlugToUuid, maskedSlugToUuidV7, parseUuid, parseUuidSlug, slugToUuid, slugToUuidBytes, uuidBytesToSlug, uuidToMaskedSlug, uuidToSlug, uuidV4, uuidV4Bytes, uuidV4Slug, uuidV7, uuidV7Bytes, uuidV7MaskedSlug, uuidV7Slug, uuidV7ToMaskedSlug, validateMaskedUuidV7SlugFresh, validateUuidV7Fresh, validateUuidV7SlugFresh };
168
- //# sourceMappingURL=index.d.ts.map
1
+ // SPDX-License-Identifier: Apache-2.0
2
+ // @anizoptera/uuid-slug 0.3.0 | https://github.com/Anizoptera/uuid-slug#readme
3
+ import { UUID_SLUG_ERROR_CODES, UuidRuntimeError, UuidSlugError, UuidSlugErrorCode } from "./errors.js";
4
+ import { SlugAlphabet, extractUuidV7Timestamp, formatUuid, formatUuidSlug, hasUuidV7Entropy, isUuidSlug, isUuidString, isUuidV4Slug, isUuidV4String, isUuidV7Bytes, isUuidV7Slug, isUuidV7String, parseUuid, parseUuidSlug, slugToUuid, uuidToSlug } from "./uuid.js";
5
+ import { AsyncMaskSchemaOptions, Base64UrlString, FreshValidationOptions, MaskSchema, MaskSchemaOptions, MaskedUuidSlug, MaskedUuidV7Slug, MigrationFormat, PublicUuidV7Slug, SentinelUuidV7Slug, UuidBytes, UuidSlug, UuidSlugCodec, UuidSlugCodecOptions, UuidSlugMigration, UuidSlugMigrationOptions, UuidString, UuidV4Slug, UuidV4String, UuidV7Generator, UuidV7Sentinel, UuidV7SentinelDefinition, UuidV7Slug, UuidV7String } from "./types.js";
6
+ import { decodeBase64Url, encodeBase64Url, isBase64Url } from "./base64url.js";
7
+ import { UUID_V7_SENTINEL_DEFINITIONS, createUuidSlugCodec, defaultCodec, validateUuidV7Fresh, validateUuidV7SlugFresh } from "./codec.js";
8
+ import { DEFAULT_MASK_SCHEMA, createMaskSchema, createMaskSchemaAsync } from "./schema.js";
9
+ import { UuidV7GeneratorOptions, createUuidV7Generator } from "./v7.js";
10
+ import { uuidV4, uuidV4Bytes, uuidV4Slug, uuidV7, uuidV7At, uuidV7Bytes, uuidV7BytesAt, uuidV7Slug } from "./keyless.js";
11
+ export { type AsyncMaskSchemaOptions, type Base64UrlString, DEFAULT_MASK_SCHEMA, type FreshValidationOptions, type MaskSchema, type MaskSchemaOptions, type MaskedUuidSlug, type MaskedUuidV7Slug, type MigrationFormat, type PublicUuidV7Slug, type SentinelUuidV7Slug, type SlugAlphabet, UUID_SLUG_ERROR_CODES, UUID_V7_SENTINEL_DEFINITIONS, type UuidBytes, UuidRuntimeError, type UuidSlug, type UuidSlugCodec, type UuidSlugCodecOptions, UuidSlugError, type UuidSlugErrorCode, type UuidSlugMigration, type UuidSlugMigrationOptions, type UuidString, type UuidV4Slug, type UuidV4String, type UuidV7Generator, type UuidV7GeneratorOptions, type UuidV7Sentinel, type UuidV7SentinelDefinition, type UuidV7Slug, type UuidV7String, createMaskSchema, createMaskSchemaAsync, createUuidSlugCodec, createUuidV7Generator, decodeBase64Url, defaultCodec, encodeBase64Url, extractUuidV7Timestamp, formatUuid, formatUuidSlug, hasUuidV7Entropy, isBase64Url, isUuidSlug, isUuidString, isUuidV4Slug, isUuidV4String, isUuidV7Bytes, isUuidV7Slug, isUuidV7String, parseUuid, parseUuidSlug, slugToUuid, uuidToSlug, uuidV4, uuidV4Bytes, uuidV4Slug, uuidV7, uuidV7At, uuidV7Bytes, uuidV7BytesAt, uuidV7Slug, validateUuidV7Fresh, validateUuidV7SlugFresh };