@dbx-tools/shared-core 0.3.43 → 0.4.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.
- package/lib/index.d.ts +36 -0
- package/lib/index.js +30 -0
- package/lib/src/async.d.ts +152 -0
- package/lib/src/async.js +163 -0
- package/lib/src/brand.d.ts +94 -0
- package/lib/src/brand.js +123 -0
- package/lib/src/error.d.ts +76 -0
- package/lib/src/error.js +168 -0
- package/lib/src/function.d.ts +38 -0
- package/lib/src/function.js +44 -0
- package/lib/src/hash.d.ts +102 -0
- package/lib/src/hash.js +274 -0
- package/lib/src/http.d.ts +79 -0
- package/lib/src/http.js +189 -0
- package/lib/src/json.d.ts +48 -0
- package/lib/src/json.js +49 -0
- package/lib/src/log.d.ts +86 -0
- package/lib/src/log.js +352 -0
- package/lib/src/net.d.ts +246 -0
- package/lib/src/net.js +465 -0
- package/lib/src/object.d.ts +382 -0
- package/lib/src/object.js +749 -0
- package/lib/src/predicate.d.ts +81 -0
- package/lib/src/predicate.js +43 -0
- package/lib/src/string.d.ts +221 -0
- package/lib/src/string.js +509 -0
- package/lib/src/token.d.ts +30 -0
- package/lib/src/token.js +126 -0
- package/lib/tsconfig.tsbuildinfo +1 -0
- package/package.json +9 -5
package/lib/src/brand.js
ADDED
|
@@ -0,0 +1,123 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Browser-safe brand contract, defaults, and LLM serialization helpers.
|
|
3
|
+
*
|
|
4
|
+
* Asset values are intentionally strings: they may be relative file paths,
|
|
5
|
+
* package exports, data URLs, or network URLs depending on the consumer.
|
|
6
|
+
*
|
|
7
|
+
* @module
|
|
8
|
+
*/
|
|
9
|
+
import { z } from "zod";
|
|
10
|
+
const nonBlankString = z.string().trim().min(1);
|
|
11
|
+
const color = z.string().regex(/^#(?:[\da-f]{3}|[\da-f]{6}|[\da-f]{8})$/i, "Expected a hex color.");
|
|
12
|
+
export const DEFAULT_BRAND_ASSETS = {
|
|
13
|
+
icon: {
|
|
14
|
+
light: "@dbx-tools/ui-branding/assets/icon-light.svg",
|
|
15
|
+
dark: "@dbx-tools/ui-branding/assets/icon-dark.svg",
|
|
16
|
+
},
|
|
17
|
+
logo: {
|
|
18
|
+
light: "@dbx-tools/ui-branding/assets/logo-light.svg",
|
|
19
|
+
dark: "@dbx-tools/ui-branding/assets/logo-dark.svg",
|
|
20
|
+
},
|
|
21
|
+
favicon: "@dbx-tools/ui-branding/assets/icon-light.svg",
|
|
22
|
+
};
|
|
23
|
+
export const BrandAssetSetSchema = z
|
|
24
|
+
.object({
|
|
25
|
+
light: nonBlankString.describe("Asset for light surfaces."),
|
|
26
|
+
dark: nonBlankString.optional().describe("Asset for dark surfaces; light is the fallback."),
|
|
27
|
+
})
|
|
28
|
+
.strict()
|
|
29
|
+
.describe("Theme-aware references to one visual asset.");
|
|
30
|
+
export const BrandColorsSchema = z
|
|
31
|
+
.object({
|
|
32
|
+
primary: color.default("#FF3621").describe("Primary action and identity color."),
|
|
33
|
+
primaryHover: color.default("#D92D18").describe("Primary hover or pressed color."),
|
|
34
|
+
accent: color.default("#2EB88A").describe("Secondary accent color."),
|
|
35
|
+
foreground: color.default("#0B2026").describe("Default text and mark color."),
|
|
36
|
+
background: color.default("#FFFFFF").describe("Default page background."),
|
|
37
|
+
surface: color.default("#F6F7F8").describe("Secondary surface background."),
|
|
38
|
+
muted: color.default("#5F6B70").describe("Muted text color."),
|
|
39
|
+
border: color.default("#DCE2E5").describe("Default border color."),
|
|
40
|
+
})
|
|
41
|
+
.strict()
|
|
42
|
+
.prefault({});
|
|
43
|
+
export const BrandVoiceSchema = z
|
|
44
|
+
.object({
|
|
45
|
+
audience: z
|
|
46
|
+
.array(nonBlankString)
|
|
47
|
+
.default(["Databricks developers", "application engineers", "AI agents"]),
|
|
48
|
+
tone: z.array(nonBlankString).default(["direct", "practical", "technical", "approachable"]),
|
|
49
|
+
principles: z
|
|
50
|
+
.array(nonBlankString)
|
|
51
|
+
.default([
|
|
52
|
+
"Lead with the useful outcome.",
|
|
53
|
+
"Prefer concrete examples and accurate technical language.",
|
|
54
|
+
"Keep product claims specific and defensible.",
|
|
55
|
+
]),
|
|
56
|
+
avoid: z
|
|
57
|
+
.array(nonBlankString)
|
|
58
|
+
.default(["unsupported superlatives", "vague AI claims", "unnecessary jargon"]),
|
|
59
|
+
})
|
|
60
|
+
.strict()
|
|
61
|
+
.prefault({});
|
|
62
|
+
export const BrandContextSchema = z
|
|
63
|
+
.object({
|
|
64
|
+
schemaVersion: z.literal("1").default("1"),
|
|
65
|
+
name: nonBlankString.default("dbx tools").describe("Canonical display name."),
|
|
66
|
+
shortName: nonBlankString.default("dbx").describe("Compact name for constrained UI."),
|
|
67
|
+
tagline: nonBlankString
|
|
68
|
+
.default("Practical tools for Databricks builders.")
|
|
69
|
+
.describe("Short product line suitable for a header or metadata."),
|
|
70
|
+
description: nonBlankString
|
|
71
|
+
.default("Companion packages for Databricks developers building apps, agents, data workflows, and reusable UI.")
|
|
72
|
+
.describe("Plain-language product description."),
|
|
73
|
+
assets: z
|
|
74
|
+
.object({
|
|
75
|
+
icon: BrandAssetSetSchema.default(DEFAULT_BRAND_ASSETS.icon),
|
|
76
|
+
logo: BrandAssetSetSchema.default(DEFAULT_BRAND_ASSETS.logo),
|
|
77
|
+
favicon: nonBlankString.default(DEFAULT_BRAND_ASSETS.favicon),
|
|
78
|
+
})
|
|
79
|
+
.strict()
|
|
80
|
+
.default(DEFAULT_BRAND_ASSETS),
|
|
81
|
+
colors: BrandColorsSchema,
|
|
82
|
+
typography: z
|
|
83
|
+
.object({
|
|
84
|
+
sans: nonBlankString.default("Inter, ui-sans-serif, system-ui, sans-serif"),
|
|
85
|
+
mono: nonBlankString.default("ui-monospace, SFMono-Regular, Menlo, monospace"),
|
|
86
|
+
})
|
|
87
|
+
.strict()
|
|
88
|
+
.prefault({}),
|
|
89
|
+
voice: BrandVoiceSchema,
|
|
90
|
+
links: z
|
|
91
|
+
.object({
|
|
92
|
+
website: z.string().url().optional(),
|
|
93
|
+
repository: z.string().url().optional(),
|
|
94
|
+
documentation: z.string().url().optional(),
|
|
95
|
+
})
|
|
96
|
+
.strict()
|
|
97
|
+
.default({}),
|
|
98
|
+
extensions: z
|
|
99
|
+
.record(nonBlankString, z.unknown())
|
|
100
|
+
.default({})
|
|
101
|
+
.describe("Namespaced consumer-specific values that do not belong in the portable core."),
|
|
102
|
+
})
|
|
103
|
+
.strict()
|
|
104
|
+
.describe("Portable identity, visual, and voice context for UI, libraries, and LLMs.");
|
|
105
|
+
/** Validate input and fill every dbx tools default. */
|
|
106
|
+
export function parseBrandContext(input = {}) {
|
|
107
|
+
return BrandContextSchema.parse(input);
|
|
108
|
+
}
|
|
109
|
+
export const defaultBrandContext = parseBrandContext();
|
|
110
|
+
/** JSON Schema representation suitable for structured-output and tool definitions. */
|
|
111
|
+
export function brandContextJsonSchema() {
|
|
112
|
+
return z.toJSONSchema(BrandContextSchema);
|
|
113
|
+
}
|
|
114
|
+
/** Stable prompt block for an LLM that needs to write or design in this brand. */
|
|
115
|
+
export function brandContextPrompt(context = defaultBrandContext) {
|
|
116
|
+
return [
|
|
117
|
+
`Use the following ${context.name} brand context for names, visual choices, and writing voice.`,
|
|
118
|
+
"Treat explicit task instructions as higher priority than this context.",
|
|
119
|
+
"",
|
|
120
|
+
JSON.stringify(context, null, 2),
|
|
121
|
+
].join("\n");
|
|
122
|
+
}
|
|
123
|
+
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"brand.js","sourceRoot":"","sources":["../../src/brand.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,MAAM,cAAc,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;AAChD,MAAM,KAAK,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,0CAA0C,EAAE,uBAAuB,CAAC,CAAC;AAEpG,MAAM,CAAC,MAAM,oBAAoB,GAAG;IAClC,IAAI,EAAE;QACJ,KAAK,EAAE,8CAA8C;QACrD,IAAI,EAAE,6CAA6C;KACpD;IACD,IAAI,EAAE;QACJ,KAAK,EAAE,8CAA8C;QACrD,IAAI,EAAE,6CAA6C;KACpD;IACD,OAAO,EAAE,8CAA8C;CAC/C,CAAC;AAEX,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC;KACjC,MAAM,CAAC;IACN,KAAK,EAAE,cAAc,CAAC,QAAQ,CAAC,2BAA2B,CAAC;IAC3D,IAAI,EAAE,cAAc,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,iDAAiD,CAAC;CAC5F,CAAC;KACD,MAAM,EAAE;KACR,QAAQ,CAAC,6CAA6C,CAAC,CAAC;AAE3D,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC;KAC/B,MAAM,CAAC;IACN,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,QAAQ,CAAC,oCAAoC,CAAC;IAChF,YAAY,EAAE,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,QAAQ,CAAC,iCAAiC,CAAC;IAClF,MAAM,EAAE,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,QAAQ,CAAC,yBAAyB,CAAC;IACpE,UAAU,EAAE,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,QAAQ,CAAC,8BAA8B,CAAC;IAC7E,UAAU,EAAE,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,QAAQ,CAAC,0BAA0B,CAAC;IACzE,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,QAAQ,CAAC,+BAA+B,CAAC;IAC3E,KAAK,EAAE,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,QAAQ,CAAC,mBAAmB,CAAC;IAC7D,MAAM,EAAE,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,QAAQ,CAAC,uBAAuB,CAAC;CACnE,CAAC;KACD,MAAM,EAAE;KACR,QAAQ,CAAC,EAAE,CAAC,CAAC;AAEhB,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC;KAC9B,MAAM,CAAC;IACN,QAAQ,EAAE,CAAC;SACR,KAAK,CAAC,cAAc,CAAC;SACrB,OAAO,CAAC,CAAC,uBAAuB,EAAE,uBAAuB,EAAE,WAAW,CAAC,CAAC;IAC3E,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,WAAW,EAAE,WAAW,EAAE,cAAc,CAAC,CAAC;IAC3F,UAAU,EAAE,CAAC;SACV,KAAK,CAAC,cAAc,CAAC;SACrB,OAAO,CAAC;QACP,+BAA+B;QAC/B,2DAA2D;QAC3D,8CAA8C;KAC/C,CAAC;IACJ,KAAK,EAAE,CAAC;SACL,KAAK,CAAC,cAAc,CAAC;SACrB,OAAO,CAAC,CAAC,0BAA0B,EAAE,iBAAiB,EAAE,oBAAoB,CAAC,CAAC;CAClF,CAAC;KACD,MAAM,EAAE;KACR,QAAQ,CAAC,EAAE,CAAC,CAAC;AAEhB,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC;KAChC,MAAM,CAAC;IACN,aAAa,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC;IAC1C,IAAI,EAAE,cAAc,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,QAAQ,CAAC,yBAAyB,CAAC;IAC7E,SAAS,EAAE,cAAc,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,kCAAkC,CAAC;IACrF,OAAO,EAAE,cAAc;SACpB,OAAO,CAAC,0CAA0C,CAAC;SACnD,QAAQ,CAAC,uDAAuD,CAAC;IACpE,WAAW,EAAE,cAAc;SACxB,OAAO,CACN,sGAAsG,CACvG;SACA,QAAQ,CAAC,qCAAqC,CAAC;IAClD,MAAM,EAAE,CAAC;SACN,MAAM,CAAC;QACN,IAAI,EAAE,mBAAmB,CAAC,OAAO,CAAC,oBAAoB,CAAC,IAAI,CAAC;QAC5D,IAAI,EAAE,mBAAmB,CAAC,OAAO,CAAC,oBAAoB,CAAC,IAAI,CAAC;QAC5D,OAAO,EAAE,cAAc,CAAC,OAAO,CAAC,oBAAoB,CAAC,OAAO,CAAC;KAC9D,CAAC;SACD,MAAM,EAAE;SACR,OAAO,CAAC,oBAAoB,CAAC;IAChC,MAAM,EAAE,iBAAiB;IACzB,UAAU,EAAE,CAAC;SACV,MAAM,CAAC;QACN,IAAI,EAAE,cAAc,CAAC,OAAO,CAAC,6CAA6C,CAAC;QAC3E,IAAI,EAAE,cAAc,CAAC,OAAO,CAAC,gDAAgD,CAAC;KAC/E,CAAC;SACD,MAAM,EAAE;SACR,QAAQ,CAAC,EAAE,CAAC;IACf,KAAK,EAAE,gBAAgB;IACvB,KAAK,EAAE,CAAC;SACL,MAAM,CAAC;QACN,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;QACpC,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;QACvC,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;KAC3C,CAAC;SACD,MAAM,EAAE;SACR,OAAO,CAAC,EAAE,CAAC;IACd,UAAU,EAAE,CAAC;SACV,MAAM,CAAC,cAAc,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;SACnC,OAAO,CAAC,EAAE,CAAC;SACX,QAAQ,CAAC,8EAA8E,CAAC;CAC5F,CAAC;KACD,MAAM,EAAE;KACR,QAAQ,CAAC,2EAA2E,CAAC,CAAC;AAMzF,uDAAuD;AACvD,MAAM,UAAU,iBAAiB,CAAC,QAAiB,EAAE;IACnD,OAAO,kBAAkB,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;AACzC,CAAC;AAED,MAAM,CAAC,MAAM,mBAAmB,GAAiB,iBAAiB,EAAE,CAAC;AAErE,sFAAsF;AACtF,MAAM,UAAU,sBAAsB;IACpC,OAAO,CAAC,CAAC,YAAY,CAAC,kBAAkB,CAA4B,CAAC;AACvE,CAAC;AAED,kFAAkF;AAClF,MAAM,UAAU,kBAAkB,CAAC,UAAwB,mBAAmB;IAC5E,OAAO;QACL,qBAAqB,OAAO,CAAC,IAAI,8DAA8D;QAC/F,wEAAwE;QACxE,EAAE;QACF,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;KACjC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACf,CAAC","sourcesContent":["/**\n * Browser-safe brand contract, defaults, and LLM serialization helpers.\n *\n * Asset values are intentionally strings: they may be relative file paths,\n * package exports, data URLs, or network URLs depending on the consumer.\n *\n * @module\n */\nimport { z } from \"zod\";\n\nconst nonBlankString = z.string().trim().min(1);\nconst color = z.string().regex(/^#(?:[\\da-f]{3}|[\\da-f]{6}|[\\da-f]{8})$/i, \"Expected a hex color.\");\n\nexport const DEFAULT_BRAND_ASSETS = {\n  icon: {\n    light: \"@dbx-tools/ui-branding/assets/icon-light.svg\",\n    dark: \"@dbx-tools/ui-branding/assets/icon-dark.svg\",\n  },\n  logo: {\n    light: \"@dbx-tools/ui-branding/assets/logo-light.svg\",\n    dark: \"@dbx-tools/ui-branding/assets/logo-dark.svg\",\n  },\n  favicon: \"@dbx-tools/ui-branding/assets/icon-light.svg\",\n} as const;\n\nexport const BrandAssetSetSchema = z\n  .object({\n    light: nonBlankString.describe(\"Asset for light surfaces.\"),\n    dark: nonBlankString.optional().describe(\"Asset for dark surfaces; light is the fallback.\"),\n  })\n  .strict()\n  .describe(\"Theme-aware references to one visual asset.\");\n\nexport const BrandColorsSchema = z\n  .object({\n    primary: color.default(\"#FF3621\").describe(\"Primary action and identity color.\"),\n    primaryHover: color.default(\"#D92D18\").describe(\"Primary hover or pressed color.\"),\n    accent: color.default(\"#2EB88A\").describe(\"Secondary accent color.\"),\n    foreground: color.default(\"#0B2026\").describe(\"Default text and mark color.\"),\n    background: color.default(\"#FFFFFF\").describe(\"Default page background.\"),\n    surface: color.default(\"#F6F7F8\").describe(\"Secondary surface background.\"),\n    muted: color.default(\"#5F6B70\").describe(\"Muted text color.\"),\n    border: color.default(\"#DCE2E5\").describe(\"Default border color.\"),\n  })\n  .strict()\n  .prefault({});\n\nexport const BrandVoiceSchema = z\n  .object({\n    audience: z\n      .array(nonBlankString)\n      .default([\"Databricks developers\", \"application engineers\", \"AI agents\"]),\n    tone: z.array(nonBlankString).default([\"direct\", \"practical\", \"technical\", \"approachable\"]),\n    principles: z\n      .array(nonBlankString)\n      .default([\n        \"Lead with the useful outcome.\",\n        \"Prefer concrete examples and accurate technical language.\",\n        \"Keep product claims specific and defensible.\",\n      ]),\n    avoid: z\n      .array(nonBlankString)\n      .default([\"unsupported superlatives\", \"vague AI claims\", \"unnecessary jargon\"]),\n  })\n  .strict()\n  .prefault({});\n\nexport const BrandContextSchema = z\n  .object({\n    schemaVersion: z.literal(\"1\").default(\"1\"),\n    name: nonBlankString.default(\"dbx tools\").describe(\"Canonical display name.\"),\n    shortName: nonBlankString.default(\"dbx\").describe(\"Compact name for constrained UI.\"),\n    tagline: nonBlankString\n      .default(\"Practical tools for Databricks builders.\")\n      .describe(\"Short product line suitable for a header or metadata.\"),\n    description: nonBlankString\n      .default(\n        \"Companion packages for Databricks developers building apps, agents, data workflows, and reusable UI.\",\n      )\n      .describe(\"Plain-language product description.\"),\n    assets: z\n      .object({\n        icon: BrandAssetSetSchema.default(DEFAULT_BRAND_ASSETS.icon),\n        logo: BrandAssetSetSchema.default(DEFAULT_BRAND_ASSETS.logo),\n        favicon: nonBlankString.default(DEFAULT_BRAND_ASSETS.favicon),\n      })\n      .strict()\n      .default(DEFAULT_BRAND_ASSETS),\n    colors: BrandColorsSchema,\n    typography: z\n      .object({\n        sans: nonBlankString.default(\"Inter, ui-sans-serif, system-ui, sans-serif\"),\n        mono: nonBlankString.default(\"ui-monospace, SFMono-Regular, Menlo, monospace\"),\n      })\n      .strict()\n      .prefault({}),\n    voice: BrandVoiceSchema,\n    links: z\n      .object({\n        website: z.string().url().optional(),\n        repository: z.string().url().optional(),\n        documentation: z.string().url().optional(),\n      })\n      .strict()\n      .default({}),\n    extensions: z\n      .record(nonBlankString, z.unknown())\n      .default({})\n      .describe(\"Namespaced consumer-specific values that do not belong in the portable core.\"),\n  })\n  .strict()\n  .describe(\"Portable identity, visual, and voice context for UI, libraries, and LLMs.\");\n\nexport type BrandContext = z.output<typeof BrandContextSchema>;\nexport type BrandContextInput = z.input<typeof BrandContextSchema>;\nexport type BrandAssetSet = z.output<typeof BrandAssetSetSchema>;\n\n/** Validate input and fill every dbx tools default. */\nexport function parseBrandContext(input: unknown = {}): BrandContext {\n  return BrandContextSchema.parse(input);\n}\n\nexport const defaultBrandContext: BrandContext = parseBrandContext();\n\n/** JSON Schema representation suitable for structured-output and tool definitions. */\nexport function brandContextJsonSchema(): Record<string, unknown> {\n  return z.toJSONSchema(BrandContextSchema) as Record<string, unknown>;\n}\n\n/** Stable prompt block for an LLM that needs to write or design in this brand. */\nexport function brandContextPrompt(context: BrandContext = defaultBrandContext): string {\n  return [\n    `Use the following ${context.name} brand context for names, visual choices, and writing voice.`,\n    \"Treat explicit task instructions as higher priority than this context.\",\n    \"\",\n    JSON.stringify(context, null, 2),\n  ].join(\"\\n\");\n}\n"]}
|
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Error normalization helpers: collapse the ubiquitous
|
|
3
|
+
* `err instanceof Error ? err.message : String(err)` dance into a single
|
|
4
|
+
* call, walk `cause` / `AggregateError` chains, and coerce any thrown
|
|
5
|
+
* value into a real `Error`. Dependency-free and browser-safe.
|
|
6
|
+
*
|
|
7
|
+
* @module
|
|
8
|
+
*/
|
|
9
|
+
/**
|
|
10
|
+
* Normalize any thrown value into an `Error`. Returns `value` unchanged
|
|
11
|
+
* when it already is an `Error`, otherwise wraps its {@link errorMessage}
|
|
12
|
+
* in a fresh `Error`. Use when a consumer needs a real `Error` object
|
|
13
|
+
* (React error state, `reject`, rethrow) rather than just a printable
|
|
14
|
+
* string.
|
|
15
|
+
*/
|
|
16
|
+
export declare function toError(value: unknown): Error;
|
|
17
|
+
/**
|
|
18
|
+
* Extract a human-readable message from any thrown value. Returns
|
|
19
|
+
* `value.message` when `value` is an `Error`, otherwise coerces via
|
|
20
|
+
* `String(value)`. Collapses the ubiquitous
|
|
21
|
+
*
|
|
22
|
+
* ```ts
|
|
23
|
+
* err instanceof Error ? err.message : String(err)
|
|
24
|
+
* ```
|
|
25
|
+
*
|
|
26
|
+
* dance into a single helper, useful for log attributes and any other
|
|
27
|
+
* "give me something printable" context.
|
|
28
|
+
*/
|
|
29
|
+
export declare function errorMessage(value: unknown): string;
|
|
30
|
+
/**
|
|
31
|
+
* Yield `message` / `errorCode` strings from every node in the error
|
|
32
|
+
* tree (see {@link errorNodes}). Used by {@link errorMessage} and
|
|
33
|
+
* message predicates elsewhere.
|
|
34
|
+
*/
|
|
35
|
+
export declare function errorMessages(value: unknown): Generator<string, void, undefined>;
|
|
36
|
+
/**
|
|
37
|
+
* Depth-first walk of an error value: the root, then `errors` (e.g.
|
|
38
|
+
* `AggregateError`) and `cause` chains. Cycle-safe via a `seen` set.
|
|
39
|
+
*/
|
|
40
|
+
export declare function errorNodes(err: unknown): Generator<NonNullable<unknown>, void, undefined>;
|
|
41
|
+
/**
|
|
42
|
+
* Lazy view over a thrown value for HTTP-status + message classification.
|
|
43
|
+
* Status comes from the last positive `statusCode` / `code` on the error tree;
|
|
44
|
+
* messages/tokens come from every `message` / `errorCode` field (including
|
|
45
|
+
* `cause` and `AggregateError.errors`). Build with {@link errorContext}.
|
|
46
|
+
*/
|
|
47
|
+
export type ErrorContext = ErrorContextImpl;
|
|
48
|
+
declare class ErrorContextImpl {
|
|
49
|
+
private readonly err;
|
|
50
|
+
private _statusCode;
|
|
51
|
+
private _messages;
|
|
52
|
+
private _messageTokens;
|
|
53
|
+
constructor(err: NonNullable<unknown>);
|
|
54
|
+
/** Last positive `statusCode` / `code` found on the error tree, else `undefined` (0 ignored). */
|
|
55
|
+
get statusCode(): number | undefined;
|
|
56
|
+
/** Every `message` / `errorCode` string in the error tree. */
|
|
57
|
+
get messages(): string[];
|
|
58
|
+
/** Lowercased tokens from {@link messages}. */
|
|
59
|
+
get messageTokens(): string[];
|
|
60
|
+
/** True for any 4xx status or message tokens `not exist` / `not found`. */
|
|
61
|
+
get notAccessible(): boolean;
|
|
62
|
+
/**
|
|
63
|
+
* Match HTTP status. Pass a full code (`404`) or a class (`4` for any 4xx).
|
|
64
|
+
* Extra filters are OR'd. `false` when no status is on the error tree.
|
|
65
|
+
*/
|
|
66
|
+
hasStatusCode(statusCodeFilter: number, ...statusCodeFilters: number[]): boolean;
|
|
67
|
+
/**
|
|
68
|
+
* True when every token from the filter phrase(s) appears in
|
|
69
|
+
* {@link messageTokens}. Each argument is tokenized on non-alphanumeric
|
|
70
|
+
* boundaries (e.g. `hasMessage("not", "found")` or `hasMessage("not found")`).
|
|
71
|
+
*/
|
|
72
|
+
hasMessage(messageFilter: string, ...messageFilters: string[]): boolean;
|
|
73
|
+
}
|
|
74
|
+
/** Build an {@link ErrorContext} for status + message checks. `null` / `undefined` become `{}`. */
|
|
75
|
+
export declare function errorContext(err: unknown): ErrorContext;
|
|
76
|
+
export {};
|
package/lib/src/error.js
ADDED
|
@@ -0,0 +1,168 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Error normalization helpers: collapse the ubiquitous
|
|
3
|
+
* `err instanceof Error ? err.message : String(err)` dance into a single
|
|
4
|
+
* call, walk `cause` / `AggregateError` chains, and coerce any thrown
|
|
5
|
+
* value into a real `Error`. Dependency-free and browser-safe.
|
|
6
|
+
*
|
|
7
|
+
* @module
|
|
8
|
+
*/
|
|
9
|
+
import { tokenizeWithOptions } from "./string.js";
|
|
10
|
+
/**
|
|
11
|
+
* Normalize any thrown value into an `Error`. Returns `value` unchanged
|
|
12
|
+
* when it already is an `Error`, otherwise wraps its {@link errorMessage}
|
|
13
|
+
* in a fresh `Error`. Use when a consumer needs a real `Error` object
|
|
14
|
+
* (React error state, `reject`, rethrow) rather than just a printable
|
|
15
|
+
* string.
|
|
16
|
+
*/
|
|
17
|
+
export function toError(value) {
|
|
18
|
+
return value instanceof Error ? value : new Error(errorMessage(value));
|
|
19
|
+
}
|
|
20
|
+
/**
|
|
21
|
+
* Extract a human-readable message from any thrown value. Returns
|
|
22
|
+
* `value.message` when `value` is an `Error`, otherwise coerces via
|
|
23
|
+
* `String(value)`. Collapses the ubiquitous
|
|
24
|
+
*
|
|
25
|
+
* ```ts
|
|
26
|
+
* err instanceof Error ? err.message : String(err)
|
|
27
|
+
* ```
|
|
28
|
+
*
|
|
29
|
+
* dance into a single helper, useful for log attributes and any other
|
|
30
|
+
* "give me something printable" context.
|
|
31
|
+
*/
|
|
32
|
+
export function errorMessage(value) {
|
|
33
|
+
const message = errorMessages(value).next().value;
|
|
34
|
+
return message ?? String(value);
|
|
35
|
+
}
|
|
36
|
+
/**
|
|
37
|
+
* Yield `message` / `errorCode` strings from every node in the error
|
|
38
|
+
* tree (see {@link errorNodes}). Used by {@link errorMessage} and
|
|
39
|
+
* message predicates elsewhere.
|
|
40
|
+
*/
|
|
41
|
+
export function* errorMessages(value) {
|
|
42
|
+
for (const node of errorNodes(value)) {
|
|
43
|
+
if (typeof node === "object") {
|
|
44
|
+
for (const key of ["message", "errorCode"]) {
|
|
45
|
+
if (key in node) {
|
|
46
|
+
const value = node[key];
|
|
47
|
+
if (typeof value === "string" && value) {
|
|
48
|
+
yield value;
|
|
49
|
+
}
|
|
50
|
+
}
|
|
51
|
+
}
|
|
52
|
+
}
|
|
53
|
+
else if (typeof node === "string" && node) {
|
|
54
|
+
yield node;
|
|
55
|
+
}
|
|
56
|
+
}
|
|
57
|
+
}
|
|
58
|
+
/**
|
|
59
|
+
* Depth-first walk of an error value: the root, then `errors` (e.g.
|
|
60
|
+
* `AggregateError`) and `cause` chains. Cycle-safe via a `seen` set.
|
|
61
|
+
*/
|
|
62
|
+
export function* errorNodes(err) {
|
|
63
|
+
const seen = new Set();
|
|
64
|
+
function* visit(node) {
|
|
65
|
+
if (node === undefined || node === null)
|
|
66
|
+
return;
|
|
67
|
+
if (Array.isArray(node)) {
|
|
68
|
+
for (const child of node) {
|
|
69
|
+
yield* visit(child);
|
|
70
|
+
}
|
|
71
|
+
return;
|
|
72
|
+
}
|
|
73
|
+
if (seen.has(node))
|
|
74
|
+
return;
|
|
75
|
+
seen.add(node);
|
|
76
|
+
yield node;
|
|
77
|
+
if (typeof node === "object") {
|
|
78
|
+
for (const key of ["errors", "cause"]) {
|
|
79
|
+
if (key in node) {
|
|
80
|
+
const value = node[key];
|
|
81
|
+
yield* visit(value);
|
|
82
|
+
}
|
|
83
|
+
}
|
|
84
|
+
}
|
|
85
|
+
}
|
|
86
|
+
yield* visit(err);
|
|
87
|
+
}
|
|
88
|
+
class ErrorContextImpl {
|
|
89
|
+
err;
|
|
90
|
+
_statusCode;
|
|
91
|
+
_messages;
|
|
92
|
+
_messageTokens;
|
|
93
|
+
constructor(err) {
|
|
94
|
+
this.err = err;
|
|
95
|
+
}
|
|
96
|
+
/** Last positive `statusCode` / `code` found on the error tree, else `undefined` (0 ignored). */
|
|
97
|
+
get statusCode() {
|
|
98
|
+
if (this._statusCode === undefined) {
|
|
99
|
+
outer: for (const node of errorNodes(this.err)) {
|
|
100
|
+
if (typeof node !== "object" || node === null)
|
|
101
|
+
continue;
|
|
102
|
+
for (const key of ["statusCode", "code"]) {
|
|
103
|
+
if (!(key in node))
|
|
104
|
+
continue;
|
|
105
|
+
const value = node[key];
|
|
106
|
+
if (typeof value === "number" && value > 99 && value < 600) {
|
|
107
|
+
this._statusCode = value;
|
|
108
|
+
break outer;
|
|
109
|
+
}
|
|
110
|
+
}
|
|
111
|
+
}
|
|
112
|
+
if (this._statusCode === undefined) {
|
|
113
|
+
this._statusCode = -1;
|
|
114
|
+
}
|
|
115
|
+
}
|
|
116
|
+
return this._statusCode == -1 ? undefined : this._statusCode;
|
|
117
|
+
}
|
|
118
|
+
/** Every `message` / `errorCode` string in the error tree. */
|
|
119
|
+
get messages() {
|
|
120
|
+
if (this._messages === undefined) {
|
|
121
|
+
this._messages = [...errorMessages(this.err)];
|
|
122
|
+
}
|
|
123
|
+
return this._messages;
|
|
124
|
+
}
|
|
125
|
+
/** Lowercased tokens from {@link messages}. */
|
|
126
|
+
get messageTokens() {
|
|
127
|
+
if (this._messageTokens === undefined) {
|
|
128
|
+
this._messageTokens = [...tokenizeWithOptions({ lowerCase: true }, ...this.messages)];
|
|
129
|
+
}
|
|
130
|
+
return this._messageTokens;
|
|
131
|
+
}
|
|
132
|
+
/** True for any 4xx status or message tokens `not exist` / `not found`. */
|
|
133
|
+
get notAccessible() {
|
|
134
|
+
if (this.hasStatusCode(4))
|
|
135
|
+
return true;
|
|
136
|
+
return this.hasMessage("not", "exist") || this.hasMessage("not", "found");
|
|
137
|
+
}
|
|
138
|
+
/**
|
|
139
|
+
* Match HTTP status. Pass a full code (`404`) or a class (`4` for any 4xx).
|
|
140
|
+
* Extra filters are OR'd. `false` when no status is on the error tree.
|
|
141
|
+
*/
|
|
142
|
+
hasStatusCode(statusCodeFilter, ...statusCodeFilters) {
|
|
143
|
+
const code = this.statusCode;
|
|
144
|
+
if (code) {
|
|
145
|
+
for (const filter of [statusCodeFilter, ...statusCodeFilters]) {
|
|
146
|
+
const match = (filter < 100 ? Math.trunc(code / 100) : code) === filter;
|
|
147
|
+
if (match)
|
|
148
|
+
return true;
|
|
149
|
+
}
|
|
150
|
+
}
|
|
151
|
+
return false;
|
|
152
|
+
}
|
|
153
|
+
/**
|
|
154
|
+
* True when every token from the filter phrase(s) appears in
|
|
155
|
+
* {@link messageTokens}. Each argument is tokenized on non-alphanumeric
|
|
156
|
+
* boundaries (e.g. `hasMessage("not", "found")` or `hasMessage("not found")`).
|
|
157
|
+
*/
|
|
158
|
+
hasMessage(messageFilter, ...messageFilters) {
|
|
159
|
+
return [messageFilter, ...messageFilters]
|
|
160
|
+
.flatMap((filter) => Array.from(tokenizeWithOptions({ lowerCase: true }, filter)))
|
|
161
|
+
.every((filterToken) => this.messageTokens.includes(filterToken));
|
|
162
|
+
}
|
|
163
|
+
}
|
|
164
|
+
/** Build an {@link ErrorContext} for status + message checks. `null` / `undefined` become `{}`. */
|
|
165
|
+
export function errorContext(err) {
|
|
166
|
+
return new ErrorContextImpl(err ?? {});
|
|
167
|
+
}
|
|
168
|
+
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"error.js","sourceRoot":"","sources":["../../src/error.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AAE/C;;;;;;GAMG;AACH,MAAM,UAAU,OAAO,CAAC,KAAc;IACpC,OAAO,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC;AACzE,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,YAAY,CAAC,KAAc;IACzC,MAAM,OAAO,GAAG,aAAa,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC;IAClD,OAAO,OAAO,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC;AAClC,CAAC;AAED;;;;GAIG;AACH,MAAM,SAAS,CAAC,CAAC,aAAa,CAAC,KAAc;IAC3C,KAAK,MAAM,IAAI,IAAI,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC;QACrC,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC7B,KAAK,MAAM,GAAG,IAAI,CAAC,SAAS,EAAE,WAAW,CAAC,EAAE,CAAC;gBAC3C,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;oBAChB,MAAM,KAAK,GAAI,IAAgC,CAAC,GAAG,CAAC,CAAC;oBACrD,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,EAAE,CAAC;wBACvC,MAAM,KAAK,CAAC;oBACd,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;aAAM,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,EAAE,CAAC;YAC5C,MAAM,IAAI,CAAC;QACb,CAAC;IACH,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,MAAM,SAAS,CAAC,CAAC,UAAU,CAAC,GAAY;IACtC,MAAM,IAAI,GAAG,IAAI,GAAG,EAAW,CAAC;IAEhC,QAAQ,CAAC,CAAC,KAAK,CAAC,IAAa;QAC3B,IAAI,IAAI,KAAK,SAAS,IAAI,IAAI,KAAK,IAAI;YAAE,OAAO;QAChD,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YACxB,KAAK,MAAM,KAAK,IAAI,IAAI,EAAE,CAAC;gBACzB,KAAK,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YACtB,CAAC;YACD,OAAO;QACT,CAAC;QACD,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC;YAAE,OAAO;QAC3B,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACf,MAAM,IAAI,CAAC;QACX,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC7B,KAAK,MAAM,GAAG,IAAI,CAAC,QAAQ,EAAE,OAAO,CAAC,EAAE,CAAC;gBACtC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;oBAChB,MAAM,KAAK,GAAI,IAAgC,CAAC,GAAG,CAAC,CAAC;oBACrD,KAAK,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;gBACtB,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IACD,KAAK,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;AACpB,CAAC;AAUD,MAAM,gBAAgB;IAKS;IAJrB,WAAW,CAAqB;IAChC,SAAS,CAAuB;IAChC,cAAc,CAAuB;IAE7C,YAA6B,GAAyB;QAAzB,QAAG,GAAH,GAAG,CAAsB;IAAG,CAAC;IAE1D,iGAAiG;IACjG,IAAI,UAAU;QACZ,IAAI,IAAI,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;YACnC,KAAK,EAAE,KAAK,MAAM,IAAI,IAAI,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC/C,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,IAAI;oBAAE,SAAS;gBACxD,KAAK,MAAM,GAAG,IAAI,CAAC,YAAY,EAAE,MAAM,CAAU,EAAE,CAAC;oBAClD,IAAI,CAAC,CAAC,GAAG,IAAI,IAAI,CAAC;wBAAE,SAAS;oBAC7B,MAAM,KAAK,GAAI,IAAgC,CAAC,GAAG,CAAC,CAAC;oBACrD,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,GAAG,EAAE,IAAI,KAAK,GAAG,GAAG,EAAE,CAAC;wBAC3D,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC;wBACzB,MAAM,KAAK,CAAC;oBACd,CAAC;gBACH,CAAC;YACH,CAAC;YACD,IAAI,IAAI,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;gBACnC,IAAI,CAAC,WAAW,GAAG,CAAC,CAAC,CAAC;YACxB,CAAC;QACH,CAAC;QACD,OAAO,IAAI,CAAC,WAAW,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC;IAC/D,CAAC;IAED,8DAA8D;IAC9D,IAAI,QAAQ;QACV,IAAI,IAAI,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;YACjC,IAAI,CAAC,SAAS,GAAG,CAAC,GAAG,aAAa,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;QAChD,CAAC;QACD,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED,+CAA+C;IAC/C,IAAI,aAAa;QACf,IAAI,IAAI,CAAC,cAAc,KAAK,SAAS,EAAE,CAAC;YACtC,IAAI,CAAC,cAAc,GAAG,CAAC,GAAG,mBAAmB,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,EAAE,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;QACxF,CAAC;QACD,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC;IAED,2EAA2E;IAC3E,IAAI,aAAa;QACf,IAAI,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC;YAAE,OAAO,IAAI,CAAC;QACvC,OAAO,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,OAAO,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IAC5E,CAAC;IAED;;;OAGG;IACH,aAAa,CAAC,gBAAwB,EAAE,GAAG,iBAA2B;QACpE,MAAM,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC;QAC7B,IAAI,IAAI,EAAE,CAAC;YACT,KAAK,MAAM,MAAM,IAAI,CAAC,gBAAgB,EAAE,GAAG,iBAAiB,CAAC,EAAE,CAAC;gBAC9D,MAAM,KAAK,GAAG,CAAC,MAAM,GAAG,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,MAAM,CAAC;gBACxE,IAAI,KAAK;oBAAE,OAAO,IAAI,CAAC;YACzB,CAAC;QACH,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;OAIG;IACH,UAAU,CAAC,aAAqB,EAAE,GAAG,cAAwB;QAC3D,OAAO,CAAC,aAAa,EAAE,GAAG,cAAc,CAAC;aACtC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,mBAAmB,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,EAAE,MAAM,CAAC,CAAC,CAAC;aACjF,KAAK,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC;IACtE,CAAC;CACF;AAED,mGAAmG;AACnG,MAAM,UAAU,YAAY,CAAC,GAAY;IACvC,OAAO,IAAI,gBAAgB,CAAC,GAAG,IAAI,EAAE,CAAC,CAAC;AACzC,CAAC","sourcesContent":["/**\n * Error normalization helpers: collapse the ubiquitous\n * `err instanceof Error ? err.message : String(err)` dance into a single\n * call, walk `cause` / `AggregateError` chains, and coerce any thrown\n * value into a real `Error`. Dependency-free and browser-safe.\n *\n * @module\n */\n\nimport { tokenizeWithOptions } from \"./string\";\n\n/**\n * Normalize any thrown value into an `Error`. Returns `value` unchanged\n * when it already is an `Error`, otherwise wraps its {@link errorMessage}\n * in a fresh `Error`. Use when a consumer needs a real `Error` object\n * (React error state, `reject`, rethrow) rather than just a printable\n * string.\n */\nexport function toError(value: unknown): Error {\n  return value instanceof Error ? value : new Error(errorMessage(value));\n}\n\n/**\n * Extract a human-readable message from any thrown value. Returns\n * `value.message` when `value` is an `Error`, otherwise coerces via\n * `String(value)`. Collapses the ubiquitous\n *\n * ```ts\n * err instanceof Error ? err.message : String(err)\n * ```\n *\n * dance into a single helper, useful for log attributes and any other\n * \"give me something printable\" context.\n */\nexport function errorMessage(value: unknown): string {\n  const message = errorMessages(value).next().value;\n  return message ?? String(value);\n}\n\n/**\n * Yield `message` / `errorCode` strings from every node in the error\n * tree (see {@link errorNodes}). Used by {@link errorMessage} and\n * message predicates elsewhere.\n */\nexport function* errorMessages(value: unknown): Generator<string, void, undefined> {\n  for (const node of errorNodes(value)) {\n    if (typeof node === \"object\") {\n      for (const key of [\"message\", \"errorCode\"]) {\n        if (key in node) {\n          const value = (node as Record<string, unknown>)[key];\n          if (typeof value === \"string\" && value) {\n            yield value;\n          }\n        }\n      }\n    } else if (typeof node === \"string\" && node) {\n      yield node;\n    }\n  }\n}\n\n/**\n * Depth-first walk of an error value: the root, then `errors` (e.g.\n * `AggregateError`) and `cause` chains. Cycle-safe via a `seen` set.\n */\nexport function* errorNodes(err: unknown): Generator<NonNullable<unknown>, void, undefined> {\n  const seen = new Set<unknown>();\n\n  function* visit(node: unknown): Generator<NonNullable<unknown>, void, undefined> {\n    if (node === undefined || node === null) return;\n    if (Array.isArray(node)) {\n      for (const child of node) {\n        yield* visit(child);\n      }\n      return;\n    }\n    if (seen.has(node)) return;\n    seen.add(node);\n    yield node;\n    if (typeof node === \"object\") {\n      for (const key of [\"errors\", \"cause\"]) {\n        if (key in node) {\n          const value = (node as Record<string, unknown>)[key];\n          yield* visit(value);\n        }\n      }\n    }\n  }\n  yield* visit(err);\n}\n\n/**\n * Lazy view over a thrown value for HTTP-status + message classification.\n * Status comes from the last positive `statusCode` / `code` on the error tree;\n * messages/tokens come from every `message` / `errorCode` field (including\n * `cause` and `AggregateError.errors`). Build with {@link errorContext}.\n */\nexport type ErrorContext = ErrorContextImpl;\n\nclass ErrorContextImpl {\n  private _statusCode: number | undefined;\n  private _messages: string[] | undefined;\n  private _messageTokens: string[] | undefined;\n\n  constructor(private readonly err: NonNullable<unknown>) {}\n\n  /** Last positive `statusCode` / `code` found on the error tree, else `undefined` (0 ignored). */\n  get statusCode(): number | undefined {\n    if (this._statusCode === undefined) {\n      outer: for (const node of errorNodes(this.err)) {\n        if (typeof node !== \"object\" || node === null) continue;\n        for (const key of [\"statusCode\", \"code\"] as const) {\n          if (!(key in node)) continue;\n          const value = (node as Record<string, unknown>)[key];\n          if (typeof value === \"number\" && value > 99 && value < 600) {\n            this._statusCode = value;\n            break outer;\n          }\n        }\n      }\n      if (this._statusCode === undefined) {\n        this._statusCode = -1;\n      }\n    }\n    return this._statusCode == -1 ? undefined : this._statusCode;\n  }\n\n  /** Every `message` / `errorCode` string in the error tree. */\n  get messages(): string[] {\n    if (this._messages === undefined) {\n      this._messages = [...errorMessages(this.err)];\n    }\n    return this._messages;\n  }\n\n  /** Lowercased tokens from {@link messages}. */\n  get messageTokens(): string[] {\n    if (this._messageTokens === undefined) {\n      this._messageTokens = [...tokenizeWithOptions({ lowerCase: true }, ...this.messages)];\n    }\n    return this._messageTokens;\n  }\n\n  /** True for any 4xx status or message tokens `not exist` / `not found`. */\n  get notAccessible(): boolean {\n    if (this.hasStatusCode(4)) return true;\n    return this.hasMessage(\"not\", \"exist\") || this.hasMessage(\"not\", \"found\");\n  }\n\n  /**\n   * Match HTTP status. Pass a full code (`404`) or a class (`4` for any 4xx).\n   * Extra filters are OR'd. `false` when no status is on the error tree.\n   */\n  hasStatusCode(statusCodeFilter: number, ...statusCodeFilters: number[]): boolean {\n    const code = this.statusCode;\n    if (code) {\n      for (const filter of [statusCodeFilter, ...statusCodeFilters]) {\n        const match = (filter < 100 ? Math.trunc(code / 100) : code) === filter;\n        if (match) return true;\n      }\n    }\n    return false;\n  }\n\n  /**\n   * True when every token from the filter phrase(s) appears in\n   * {@link messageTokens}. Each argument is tokenized on non-alphanumeric\n   * boundaries (e.g. `hasMessage(\"not\", \"found\")` or `hasMessage(\"not found\")`).\n   */\n  hasMessage(messageFilter: string, ...messageFilters: string[]): boolean {\n    return [messageFilter, ...messageFilters]\n      .flatMap((filter) => Array.from(tokenizeWithOptions({ lowerCase: true }, filter)))\n      .every((filterToken) => this.messageTokens.includes(filterToken));\n  }\n}\n\n/** Build an {@link ErrorContext} for status + message checks. `null` / `undefined` become `{}`. */\nexport function errorContext(err: unknown): ErrorContext {\n  return new ErrorContextImpl(err ?? {});\n}\n"]}
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
export interface MemoizeOptions {
|
|
2
|
+
/**
|
|
3
|
+
* Time-to-live in milliseconds. The cached value expires `ttlMs` after
|
|
4
|
+
* it was stored, so the next call past that recomputes; a rejection is
|
|
5
|
+
* also evicted so a later call retries rather than replaying the error.
|
|
6
|
+
* Omitted or `<= 0` means a successful value is cached forever (the default).
|
|
7
|
+
* Errors are never cached - see {@link memoize}.
|
|
8
|
+
*
|
|
9
|
+
* Use for periodically-refreshed data (published IP ranges, feature
|
|
10
|
+
* flags, anything fetched once and reused across requests).
|
|
11
|
+
*/
|
|
12
|
+
ttlMs?: number;
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* Run a zero-argument factory once; later calls return the same result.
|
|
16
|
+
* The memoized function mirrors the factory's sync / async nature: a
|
|
17
|
+
* sync factory yields a sync getter (`() => T`), an async / thenable
|
|
18
|
+
* factory yields a promise-returning getter (`() => Promise<T>`) whose
|
|
19
|
+
* concurrent callers share the one in-flight promise until it settles.
|
|
20
|
+
*
|
|
21
|
+
* Errors are never cached: a sync factory that throws propagates the
|
|
22
|
+
* throw, and an async factory that rejects evicts the cached promise, so
|
|
23
|
+
* in both cases the next call retries. Pass `{ ttlMs }` to also expire
|
|
24
|
+
* and recompute a successful value after a window; without a TTL a
|
|
25
|
+
* success is cached forever.
|
|
26
|
+
*
|
|
27
|
+
* For an async factory the TTL window starts when the promise
|
|
28
|
+
* *resolves*, not when it was created - a slow in-flight request never
|
|
29
|
+
* counts as already-expired, and concurrent callers keep sharing the one
|
|
30
|
+
* pending promise until it settles.
|
|
31
|
+
*
|
|
32
|
+
* @example
|
|
33
|
+
* const ranges = functionModule.memoize(fetchIpRanges, { ttlMs: 24 * 60 * 60 * 1000 });
|
|
34
|
+
* await ranges(); // fetches
|
|
35
|
+
* await ranges(); // cached until 24h later
|
|
36
|
+
*/
|
|
37
|
+
export declare function memoize<T>(factory: () => PromiseLike<T>, options?: MemoizeOptions): () => Promise<T>;
|
|
38
|
+
export declare function memoize<T>(factory: () => T, options?: MemoizeOptions): () => T;
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
export function memoize(factory, options) {
|
|
2
|
+
const ttlMs = options?.ttlMs ?? 0;
|
|
3
|
+
let cache;
|
|
4
|
+
return () => {
|
|
5
|
+
if (cache === undefined || (ttlMs > 0 && Date.now() >= cache.expiresAt)) {
|
|
6
|
+
const result = factory();
|
|
7
|
+
if (isThenable(result)) {
|
|
8
|
+
const pending = Promise.resolve(result);
|
|
9
|
+
// `Infinity` keeps the entry unexpired while in flight (so a slow
|
|
10
|
+
// request isn't refetched and concurrent callers share it); the
|
|
11
|
+
// TTL window is stamped from resolution below.
|
|
12
|
+
const entry = { value: pending, expiresAt: Infinity };
|
|
13
|
+
cache = entry;
|
|
14
|
+
void pending.then(() => {
|
|
15
|
+
entry.expiresAt = Date.now() + ttlMs;
|
|
16
|
+
},
|
|
17
|
+
// Never cache a rejection: evict so a later call retries.
|
|
18
|
+
() => {
|
|
19
|
+
if (cache === entry)
|
|
20
|
+
cache = undefined;
|
|
21
|
+
});
|
|
22
|
+
}
|
|
23
|
+
else {
|
|
24
|
+
cache = { value: result, expiresAt: Date.now() + ttlMs };
|
|
25
|
+
}
|
|
26
|
+
}
|
|
27
|
+
return cache.value;
|
|
28
|
+
};
|
|
29
|
+
}
|
|
30
|
+
/** Duck-type any value with a callable `.then` as a thenable. */
|
|
31
|
+
function isThenable(value) {
|
|
32
|
+
if (value !== null) {
|
|
33
|
+
if (value instanceof Promise) {
|
|
34
|
+
return true;
|
|
35
|
+
}
|
|
36
|
+
else if (typeof value === "object" &&
|
|
37
|
+
"then" in value &&
|
|
38
|
+
typeof value.then === "function") {
|
|
39
|
+
return true;
|
|
40
|
+
}
|
|
41
|
+
}
|
|
42
|
+
return false;
|
|
43
|
+
}
|
|
44
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZnVuY3Rpb24uanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvZnVuY3Rpb24udHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBMkNBLE1BQU0sVUFBVSxPQUFPLENBQ3JCLE9BQWlDLEVBQ2pDLE9BQXdCO0lBRXhCLE1BQU0sS0FBSyxHQUFHLE9BQU8sRUFBRSxLQUFLLElBQUksQ0FBQyxDQUFDO0lBQ2xDLElBQUksS0FBK0QsQ0FBQztJQUNwRSxPQUFPLEdBQUcsRUFBRTtRQUNWLElBQUksS0FBSyxLQUFLLFNBQVMsSUFBSSxDQUFDLEtBQUssR0FBRyxDQUFDLElBQUksSUFBSSxDQUFDLEdBQUcsRUFBRSxJQUFJLEtBQUssQ0FBQyxTQUFTLENBQUMsRUFBRSxDQUFDO1lBQ3hFLE1BQU0sTUFBTSxHQUFHLE9BQU8sRUFBRSxDQUFDO1lBQ3pCLElBQUksVUFBVSxDQUFDLE1BQU0sQ0FBQyxFQUFFLENBQUM7Z0JBQ3ZCLE1BQU0sT0FBTyxHQUFHLE9BQU8sQ0FBQyxPQUFPLENBQUMsTUFBTSxDQUFDLENBQUM7Z0JBQ3hDLGtFQUFrRTtnQkFDbEUsZ0VBQWdFO2dCQUNoRSwrQ0FBK0M7Z0JBQy9DLE1BQU0sS0FBSyxHQUFHLEVBQUUsS0FBSyxFQUFFLE9BQU8sRUFBRSxTQUFTLEVBQUUsUUFBUSxFQUFFLENBQUM7Z0JBQ3RELEtBQUssR0FBRyxLQUFLLENBQUM7Z0JBQ2QsS0FBSyxPQUFPLENBQUMsSUFBSSxDQUNmLEdBQUcsRUFBRTtvQkFDSCxLQUFLLENBQUMsU0FBUyxHQUFHLElBQUksQ0FBQyxHQUFHLEVBQUUsR0FBRyxLQUFLLENBQUM7Z0JBQ3ZDLENBQUM7Z0JBQ0QsMERBQTBEO2dCQUMxRCxHQUFHLEVBQUU7b0JBQ0gsSUFBSSxLQUFLLEtBQUssS0FBSzt3QkFBRSxLQUFLLEdBQUcsU0FBUyxDQUFDO2dCQUN6QyxDQUFDLENBQ0YsQ0FBQztZQUNKLENBQUM7aUJBQU0sQ0FBQztnQkFDTixLQUFLLEdBQUcsRUFBRSxLQUFLLEVBQUUsTUFBTSxFQUFFLFNBQVMsRUFBRSxJQUFJLENBQUMsR0FBRyxFQUFFLEdBQUcsS0FBSyxFQUFFLENBQUM7WUFDM0QsQ0FBQztRQUNILENBQUM7UUFDRCxPQUFPLEtBQUssQ0FBQyxLQUFLLENBQUM7SUFDckIsQ0FBQyxDQUFDO0FBQ0osQ0FBQztBQUVELGlFQUFpRTtBQUNqRSxTQUFTLFVBQVUsQ0FBSSxLQUF5QjtJQUM5QyxJQUFJLEtBQUssS0FBSyxJQUFJLEVBQUUsQ0FBQztRQUNuQixJQUFJLEtBQUssWUFBWSxPQUFPLEVBQUUsQ0FBQztZQUM3QixPQUFPLElBQUksQ0FBQztRQUNkLENBQUM7YUFBTSxJQUNMLE9BQU8sS0FBSyxLQUFLLFFBQVE7WUFDekIsTUFBTSxJQUFJLEtBQUs7WUFDZixPQUFRLEtBQXdCLENBQUMsSUFBSSxLQUFLLFVBQVUsRUFDcEQsQ0FBQztZQUNELE9BQU8sSUFBSSxDQUFDO1FBQ2QsQ0FBQztJQUNILENBQUM7SUFDRCxPQUFPLEtBQUssQ0FBQztBQUNmLENBQUMiLCJzb3VyY2VzQ29udGVudCI6WyJleHBvcnQgaW50ZXJmYWNlIE1lbW9pemVPcHRpb25zIHtcbiAgLyoqXG4gICAqIFRpbWUtdG8tbGl2ZSBpbiBtaWxsaXNlY29uZHMuIFRoZSBjYWNoZWQgdmFsdWUgZXhwaXJlcyBgdHRsTXNgIGFmdGVyXG4gICAqIGl0IHdhcyBzdG9yZWQsIHNvIHRoZSBuZXh0IGNhbGwgcGFzdCB0aGF0IHJlY29tcHV0ZXM7IGEgcmVqZWN0aW9uIGlzXG4gICAqIGFsc28gZXZpY3RlZCBzbyBhIGxhdGVyIGNhbGwgcmV0cmllcyByYXRoZXIgdGhhbiByZXBsYXlpbmcgdGhlIGVycm9yLlxuICAgKiBPbWl0dGVkIG9yIGA8PSAwYCBtZWFucyBhIHN1Y2Nlc3NmdWwgdmFsdWUgaXMgY2FjaGVkIGZvcmV2ZXIgKHRoZSBkZWZhdWx0KS5cbiAgICogRXJyb3JzIGFyZSBuZXZlciBjYWNoZWQgLSBzZWUge0BsaW5rIG1lbW9pemV9LlxuICAgKlxuICAgKiBVc2UgZm9yIHBlcmlvZGljYWxseS1yZWZyZXNoZWQgZGF0YSAocHVibGlzaGVkIElQIHJhbmdlcywgZmVhdHVyZVxuICAgKiBmbGFncywgYW55dGhpbmcgZmV0Y2hlZCBvbmNlIGFuZCByZXVzZWQgYWNyb3NzIHJlcXVlc3RzKS5cbiAgICovXG4gIHR0bE1zPzogbnVtYmVyO1xufVxuXG4vKipcbiAqIFJ1biBhIHplcm8tYXJndW1lbnQgZmFjdG9yeSBvbmNlOyBsYXRlciBjYWxscyByZXR1cm4gdGhlIHNhbWUgcmVzdWx0LlxuICogVGhlIG1lbW9pemVkIGZ1bmN0aW9uIG1pcnJvcnMgdGhlIGZhY3RvcnkncyBzeW5jIC8gYXN5bmMgbmF0dXJlOiBhXG4gKiBzeW5jIGZhY3RvcnkgeWllbGRzIGEgc3luYyBnZXR0ZXIgKGAoKSA9PiBUYCksIGFuIGFzeW5jIC8gdGhlbmFibGVcbiAqIGZhY3RvcnkgeWllbGRzIGEgcHJvbWlzZS1yZXR1cm5pbmcgZ2V0dGVyIChgKCkgPT4gUHJvbWlzZTxUPmApIHdob3NlXG4gKiBjb25jdXJyZW50IGNhbGxlcnMgc2hhcmUgdGhlIG9uZSBpbi1mbGlnaHQgcHJvbWlzZSB1bnRpbCBpdCBzZXR0bGVzLlxuICpcbiAqIEVycm9ycyBhcmUgbmV2ZXIgY2FjaGVkOiBhIHN5bmMgZmFjdG9yeSB0aGF0IHRocm93cyBwcm9wYWdhdGVzIHRoZVxuICogdGhyb3csIGFuZCBhbiBhc3luYyBmYWN0b3J5IHRoYXQgcmVqZWN0cyBldmljdHMgdGhlIGNhY2hlZCBwcm9taXNlLCBzb1xuICogaW4gYm90aCBjYXNlcyB0aGUgbmV4dCBjYWxsIHJldHJpZXMuIFBhc3MgYHsgdHRsTXMgfWAgdG8gYWxzbyBleHBpcmVcbiAqIGFuZCByZWNvbXB1dGUgYSBzdWNjZXNzZnVsIHZhbHVlIGFmdGVyIGEgd2luZG93OyB3aXRob3V0IGEgVFRMIGFcbiAqIHN1Y2Nlc3MgaXMgY2FjaGVkIGZvcmV2ZXIuXG4gKlxuICogRm9yIGFuIGFzeW5jIGZhY3RvcnkgdGhlIFRUTCB3aW5kb3cgc3RhcnRzIHdoZW4gdGhlIHByb21pc2VcbiAqICpyZXNvbHZlcyosIG5vdCB3aGVuIGl0IHdhcyBjcmVhdGVkIC0gYSBzbG93IGluLWZsaWdodCByZXF1ZXN0IG5ldmVyXG4gKiBjb3VudHMgYXMgYWxyZWFkeS1leHBpcmVkLCBhbmQgY29uY3VycmVudCBjYWxsZXJzIGtlZXAgc2hhcmluZyB0aGUgb25lXG4gKiBwZW5kaW5nIHByb21pc2UgdW50aWwgaXQgc2V0dGxlcy5cbiAqXG4gKiBAZXhhbXBsZVxuICogY29uc3QgcmFuZ2VzID0gZnVuY3Rpb25Nb2R1bGUubWVtb2l6ZShmZXRjaElwUmFuZ2VzLCB7IHR0bE1zOiAyNCAqIDYwICogNjAgKiAxMDAwIH0pO1xuICogYXdhaXQgcmFuZ2VzKCk7IC8vIGZldGNoZXNcbiAqIGF3YWl0IHJhbmdlcygpOyAvLyBjYWNoZWQgdW50aWwgMjRoIGxhdGVyXG4gKi9cbmV4cG9ydCBmdW5jdGlvbiBtZW1vaXplPFQ+KFxuICBmYWN0b3J5OiAoKSA9PiBQcm9taXNlTGlrZTxUPixcbiAgb3B0aW9ucz86IE1lbW9pemVPcHRpb25zLFxuKTogKCkgPT4gUHJvbWlzZTxUPjtcbmV4cG9ydCBmdW5jdGlvbiBtZW1vaXplPFQ+KGZhY3Rvcnk6ICgpID0+IFQsIG9wdGlvbnM/OiBNZW1vaXplT3B0aW9ucyk6ICgpID0+IFQ7XG5cbmV4cG9ydCBmdW5jdGlvbiBtZW1vaXplPFQ+KFxuICBmYWN0b3J5OiAoKSA9PiBUIHwgUHJvbWlzZUxpa2U8VD4sXG4gIG9wdGlvbnM/OiBNZW1vaXplT3B0aW9ucyxcbik6ICgpID0+IFQgfCBQcm9taXNlPFQ+IHtcbiAgY29uc3QgdHRsTXMgPSBvcHRpb25zPy50dGxNcyA/PyAwO1xuICBsZXQgY2FjaGU6IHsgdmFsdWU6IFQgfCBQcm9taXNlPFQ+OyBleHBpcmVzQXQ6IG51bWJlciB9IHwgdW5kZWZpbmVkO1xuICByZXR1cm4gKCkgPT4ge1xuICAgIGlmIChjYWNoZSA9PT0gdW5kZWZpbmVkIHx8ICh0dGxNcyA+IDAgJiYgRGF0ZS5ub3coKSA+PSBjYWNoZS5leHBpcmVzQXQpKSB7XG4gICAgICBjb25zdCByZXN1bHQgPSBmYWN0b3J5KCk7XG4gICAgICBpZiAoaXNUaGVuYWJsZShyZXN1bHQpKSB7XG4gICAgICAgIGNvbnN0IHBlbmRpbmcgPSBQcm9taXNlLnJlc29sdmUocmVzdWx0KTtcbiAgICAgICAgLy8gYEluZmluaXR5YCBrZWVwcyB0aGUgZW50cnkgdW5leHBpcmVkIHdoaWxlIGluIGZsaWdodCAoc28gYSBzbG93XG4gICAgICAgIC8vIHJlcXVlc3QgaXNuJ3QgcmVmZXRjaGVkIGFuZCBjb25jdXJyZW50IGNhbGxlcnMgc2hhcmUgaXQpOyB0aGVcbiAgICAgICAgLy8gVFRMIHdpbmRvdyBpcyBzdGFtcGVkIGZyb20gcmVzb2x1dGlvbiBiZWxvdy5cbiAgICAgICAgY29uc3QgZW50cnkgPSB7IHZhbHVlOiBwZW5kaW5nLCBleHBpcmVzQXQ6IEluZmluaXR5IH07XG4gICAgICAgIGNhY2hlID0gZW50cnk7XG4gICAgICAgIHZvaWQgcGVuZGluZy50aGVuKFxuICAgICAgICAgICgpID0+IHtcbiAgICAgICAgICAgIGVudHJ5LmV4cGlyZXNBdCA9IERhdGUubm93KCkgKyB0dGxNcztcbiAgICAgICAgICB9LFxuICAgICAgICAgIC8vIE5ldmVyIGNhY2hlIGEgcmVqZWN0aW9uOiBldmljdCBzbyBhIGxhdGVyIGNhbGwgcmV0cmllcy5cbiAgICAgICAgICAoKSA9PiB7XG4gICAgICAgICAgICBpZiAoY2FjaGUgPT09IGVudHJ5KSBjYWNoZSA9IHVuZGVmaW5lZDtcbiAgICAgICAgICB9LFxuICAgICAgICApO1xuICAgICAgfSBlbHNlIHtcbiAgICAgICAgY2FjaGUgPSB7IHZhbHVlOiByZXN1bHQsIGV4cGlyZXNBdDogRGF0ZS5ub3coKSArIHR0bE1zIH07XG4gICAgICB9XG4gICAgfVxuICAgIHJldHVybiBjYWNoZS52YWx1ZTtcbiAgfTtcbn1cblxuLyoqIER1Y2stdHlwZSBhbnkgdmFsdWUgd2l0aCBhIGNhbGxhYmxlIGAudGhlbmAgYXMgYSB0aGVuYWJsZS4gKi9cbmZ1bmN0aW9uIGlzVGhlbmFibGU8VD4odmFsdWU6IFQgfCBQcm9taXNlTGlrZTxUPik6IHZhbHVlIGlzIFByb21pc2VMaWtlPFQ+IHtcbiAgaWYgKHZhbHVlICE9PSBudWxsKSB7XG4gICAgaWYgKHZhbHVlIGluc3RhbmNlb2YgUHJvbWlzZSkge1xuICAgICAgcmV0dXJuIHRydWU7XG4gICAgfSBlbHNlIGlmIChcbiAgICAgIHR5cGVvZiB2YWx1ZSA9PT0gXCJvYmplY3RcIiAmJlxuICAgICAgXCJ0aGVuXCIgaW4gdmFsdWUgJiZcbiAgICAgIHR5cGVvZiAodmFsdWUgYXMgUHJvbWlzZUxpa2U8VD4pLnRoZW4gPT09IFwiZnVuY3Rpb25cIlxuICAgICkge1xuICAgICAgcmV0dXJuIHRydWU7XG4gICAgfVxuICB9XG4gIHJldHVybiBmYWxzZTtcbn1cbiJdfQ==
|
|
@@ -0,0 +1,102 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Short, deterministic non-cryptographic hashing and id minting.
|
|
3
|
+
*
|
|
4
|
+
* {@link fnvHash} / {@link fnvHashWithOptions} produce a stable FNV-1a
|
|
5
|
+
* digest over arbitrary structured input; {@link toBase32} encodes a
|
|
6
|
+
* 32-bit integer compactly; {@link id} mints v4 UUIDs (or short hex
|
|
7
|
+
* slices). All browser-safe - built on `globalThis.crypto`, no
|
|
8
|
+
* `node:crypto` import. **Never** use these for tokens, signatures, or
|
|
9
|
+
* anything an attacker shouldn't be able to forge.
|
|
10
|
+
*
|
|
11
|
+
* @module
|
|
12
|
+
*/
|
|
13
|
+
/**
|
|
14
|
+
* Mint a v4 UUID, or a short hex slice of one when `length` is set.
|
|
15
|
+
*
|
|
16
|
+
* - `id()` returns a full RFC 4122 v4 UUID. Pick this when global
|
|
17
|
+
* uniqueness matters: long-running batches, ids that cross a storage /
|
|
18
|
+
* process boundary, anything that may collide across machines.
|
|
19
|
+
* - `id(length)` returns the first `length` hex chars of a fresh UUID
|
|
20
|
+
* with dashes stripped (e.g. `id(8) -> "a3f1c92b"`). Pick this when the
|
|
21
|
+
* id has to be short / typeable and the scope is bounded - cache keys
|
|
22
|
+
* local to a request, slug suffixes. `length <= 0` throws.
|
|
23
|
+
*
|
|
24
|
+
* Prefers `crypto.randomUUID()`, which covers Node (>= 19) and a browser on
|
|
25
|
+
* a secure origin. Browsers gate `randomUUID` behind a secure context, so a
|
|
26
|
+
* page served over plain http (a LAN dev host) has `crypto` but not that
|
|
27
|
+
* method; this package is browser-safe and its callers mint ids on the
|
|
28
|
+
* render path, so it degrades instead of throwing: `getRandomValues` when
|
|
29
|
+
* present, else `Math.random`. Every branch returns a well-formed v4 UUID -
|
|
30
|
+
* only the entropy source differs.
|
|
31
|
+
*
|
|
32
|
+
* @example
|
|
33
|
+
* id(); // "123e4567-e89b-12d3-a456-426614174000"
|
|
34
|
+
* id(8); // "a3f1c92b"
|
|
35
|
+
*/
|
|
36
|
+
export declare function id(length?: number): string;
|
|
37
|
+
/**
|
|
38
|
+
* Short, deterministic FNV-1a hash over one or more values. Wraps
|
|
39
|
+
* {@link fnvHashWithOptions} with all defaults: 6-char Crockford-style
|
|
40
|
+
* base-32 output (digits + lowercase, minus `i`/`l`/`o`/`u`).
|
|
41
|
+
* Browser-safe (no `node:crypto`).
|
|
42
|
+
*
|
|
43
|
+
* Accepts any mix of primitives, arrays, plain objects, `Map`s, and
|
|
44
|
+
* `Set`s; nested structures are walked deterministically so the hash is
|
|
45
|
+
* order-stable for objects / maps / sets and order-sensitive for arrays.
|
|
46
|
+
* Cycles are detected and folded into a `circular:` marker.
|
|
47
|
+
*
|
|
48
|
+
* Use for cache keys, slug suffixes, log correlation ids, and other
|
|
49
|
+
* "give me something short and stable" needs - **never** for tokens or
|
|
50
|
+
* signatures. FNV-1a is a non-cryptographic hash.
|
|
51
|
+
*
|
|
52
|
+
* @example
|
|
53
|
+
* fnvHash("databricks-claude-sonnet-4-6"); // "k3p9q7"
|
|
54
|
+
* fnvHash([1, 2, 3]) !== fnvHash([3, 2, 1]);
|
|
55
|
+
*/
|
|
56
|
+
export declare function fnvHash(...values: unknown[]): string;
|
|
57
|
+
/**
|
|
58
|
+
* Configurable counterpart to {@link fnvHash}.
|
|
59
|
+
*
|
|
60
|
+
* Options:
|
|
61
|
+
* - `length` (default `6`): number of base-32 chars to return. Capped
|
|
62
|
+
* at 7 - the underlying digest is 32 bits, which base-32-encodes to
|
|
63
|
+
* at most 7 chars. Output is left-padded with the alphabet's zero
|
|
64
|
+
* character so short digests still hit the requested width.
|
|
65
|
+
* - `alphabet` (default Crockford-style
|
|
66
|
+
* `"0123456789abcdefghjkmnpqrstvwxyz"`): 32 distinct characters used
|
|
67
|
+
* to encode the digest. Throws when not exactly 32 unique chars.
|
|
68
|
+
* - `digest` (default `0x811c9dc5`, the FNV-1a offset basis): the seed
|
|
69
|
+
* the running digest starts from. Useful for namespacing so
|
|
70
|
+
* otherwise-identical inputs hashed under different namespaces never
|
|
71
|
+
* collide, and for chaining hashes across pipeline stages.
|
|
72
|
+
*
|
|
73
|
+
* The hash is **not** stable across changes to the alphabet or `length` -
|
|
74
|
+
* those tune the output, not the digest input.
|
|
75
|
+
*
|
|
76
|
+
* @example
|
|
77
|
+
* fnvHashWithOptions({ length: 4 }, "user@example.com"); // 4 chars
|
|
78
|
+
* fnvHashWithOptions({ digest: nsHash }, key) !== fnvHash(key); // namespaced
|
|
79
|
+
*/
|
|
80
|
+
export declare function fnvHashWithOptions(options?: {
|
|
81
|
+
length?: number;
|
|
82
|
+
alphabet?: string;
|
|
83
|
+
digest?: number;
|
|
84
|
+
}, ...values: unknown[]): string;
|
|
85
|
+
/**
|
|
86
|
+
* Encode a 32-bit unsigned integer as base-32 using the default
|
|
87
|
+
* Crockford-style alphabet (or `alphabet` when provided). The encoding
|
|
88
|
+
* has **no** zero-padding by default - `toBase32(0)` returns the
|
|
89
|
+
* alphabet's zero character, otherwise the result is the minimal number
|
|
90
|
+
* of digits that fits the value. Pad / truncate at the call site when you
|
|
91
|
+
* need a fixed width.
|
|
92
|
+
*
|
|
93
|
+
* `disableAlphabetValidation` skips the unique-32-char check for hot
|
|
94
|
+
* paths that have already validated the alphabet. The function still
|
|
95
|
+
* requires `alphabet.length === 32` either way.
|
|
96
|
+
*
|
|
97
|
+
* @example
|
|
98
|
+
* toBase32(0); // "0"
|
|
99
|
+
* toBase32(31); // "z"
|
|
100
|
+
* toBase32(0xdeadbe); // "6vmtw"
|
|
101
|
+
*/
|
|
102
|
+
export declare function toBase32(value: number, alphabet?: string, disableAlphabetValidation?: boolean): string;
|