@constructive-io/errors 0.3.0

package/LICENSE

@@ -0,0 +1,23 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Dan Lynch <pyramation@gmail.com>
+Copyright (c) 2025 Constructive <developers@constructive.io>
+Copyright (c) 2020-present, Interweb, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,139 @@
+# @constructive-io/errors
+
+Canonical Constructive error system. Zero runtime dependencies — usable by any
+service or client without pulling in pgpm.
+
+- **Registry** — the single source of truth mapping each stable `code` to its
+  classification (`public` vs `internal`), HTTP hint, and default message.
+- **`parse(anyError)`** — normalize an error from any source (a
+  `ConstructiveError`, a node-postgres `DatabaseError`, a GraphQL error or
+  `{ errors: [...] }` wrapper, a plain `Error`, or a string) into a canonical
+  `{ code, context, class, known }`.
+- **`format(code, context, locale)`** — render a localized, interpolated
+  message. `{{var}}` placeholders + registerable per-locale catalogs (i18n).
+- **`errors.*` factory** — type-safe throwable builders derived from the
+  registry, e.g. `throw errors.MODULE_NOT_FOUND({ name })`.
+- **`classify(code)`** — `public` or `internal`; unknown codes are `internal`
+  (fail safe) so transports never leak unregistered errors.
+
+```ts
+import { parse, format, errors, classify } from '@constructive-io/errors';
+
+// Normalize a DB error surfaced through GraphQL
+const parsed = parse(graphqlError);
+if (parsed.class === 'public') {
+  showUser(format(parsed.code!, parsed.context, locale));
+}
+
+// Throw a structured error
+throw errors.ACCOUNT_EXISTS();
+```
+
+## Design notes
+
+- The machine `code` is deliberately separate from user-facing copy so codes
+  are stable and messages are localizable.
+- `parse()` recovers structure from the code's precedence: structured `DETAIL`
+  JSON → GraphQL `extensions.code` → a leading ALL_CAPS token in the message
+  (legacy DB `RAISE`, incl. `CODE (arg, arg)` positional args) → native
+  SQLSTATE constraint mapping.
+- The registry has two layers, merged at lookup time (curated wins):
+  - **Generated** (`src/generated/registry.generated.ts`) — every code raised via
+    `EXCEPTION`/`THROW` across constructive-db (deploy sources + generated output),
+    each with a `public`/`internal` class, HTTP hint, and default message.
+  - **Curated** (`src/registry.ts`) — refined, typed-context entries for the codes
+    that matter most (public auth/limit copy, native PostgreSQL constraint codes,
+    pgpm CLI codes). These override the generated entries.
+- Unregistered codes still `parse()` and are classified `internal` (masked).
+
+## Regenerating the full registry
+
+The generated layer is produced from a committed audit snapshot:
+
+```bash
+# 1. re-audit constructive-db (refreshes scripts/db-error-inventory.json)
+CONSTRUCTIVE_DB_DIR=~/repos/constructive-db python3 scripts/audit-db-errors.py
+# 2. regenerate src/generated/registry.generated.ts from the snapshot
+python3 scripts/generate-registry.py
+```
+
+`audit-db-errors.py` scans every `EXCEPTION`/`THROW` across constructive-db deploy
+sources and generated output and writes `scripts/db-error-inventory.json` (the
+committed audit snapshot). `generate-registry.py` reads that snapshot and, when a
+`constructive-io/dashboard` checkout is found (via `DASHBOARD_DIR` or a sibling
+`../dashboard`), seeds public copy from its error catalogs. Re-run both whenever
+constructive-db error codes change. Never hand-edit the generated file.
+
+---
+
+## Education and Tutorials
+
+ 1. 🚀 [Quickstart: Getting Up and Running](https://constructive.io/learn/quickstart)
+Get started with modular databases in minutes. Install prerequisites and deploy your first module.
+
+ 2. 📦 [Modular PostgreSQL Development with Database Packages](https://constructive.io/learn/modular-postgres)
+Learn to organize PostgreSQL projects with pgpm workspaces and reusable database modules.
+
+ 3. ✏️ [Authoring Database Changes](https://constructive.io/learn/authoring-database-changes)
+Master the workflow for adding, organizing, and managing database changes with pgpm.
+
+ 4. 🧪 [End-to-End PostgreSQL Testing with TypeScript](https://constructive.io/learn/e2e-postgres-testing)
+Master end-to-end PostgreSQL testing with ephemeral databases, RLS testing, and CI/CD automation.
+
+ 5. ⚡ [Supabase Testing](https://constructive.io/learn/supabase)
+Use TypeScript-first tools to test Supabase projects with realistic RLS, policies, and auth contexts.
+
+ 6. 💧 [Drizzle ORM Testing](https://constructive.io/learn/drizzle-testing)
+Run full-stack tests with Drizzle ORM, including database setup, teardown, and RLS enforcement.
+
+ 7. 🔧 [Troubleshooting](https://constructive.io/learn/troubleshooting)
+Common issues and solutions for pgpm, PostgreSQL, and testing.
+
+## Related Constructive Tooling
+
+### 📦 Package Management
+
+* [pgpm](https://github.com/constructive-io/constructive/tree/main/pgpm/pgpm): **🖥️ PostgreSQL Package Manager** for modular Postgres development. Works with database workspaces, scaffolding, migrations, seeding, and installing database packages.
+
+### 🧪 Testing
+
+* [pgsql-test](https://github.com/constructive-io/constructive/tree/main/postgres/pgsql-test): **📊 Isolated testing environments** with per-test transaction rollbacks—ideal for integration tests, complex migrations, and RLS simulation.
+* [pglite-test](https://github.com/constructive-io/constructive/tree/main/postgres/pglite-test): **🪶 Drop-in pgsql-test replacement backed by PGlite** — in-process Postgres, no server required, instance-per-suite isolation.
+* [pgsql-seed](https://github.com/constructive-io/constructive/tree/main/postgres/pgsql-seed): **🌱 PostgreSQL seeding utilities** for CSV, JSON, SQL data loading, and pgpm deployment.
+* [supabase-test](https://github.com/constructive-io/constructive/tree/main/postgres/supabase-test): **🧪 Supabase-native test harness** preconfigured for the local Supabase stack—per-test rollbacks, JWT/role context helpers, and CI/GitHub Actions ready.
+* [graphile-test](https://github.com/constructive-io/constructive/tree/main/graphile/graphile-test): **🔐 Authentication mocking** for Graphile-focused test helpers and emulating row-level security contexts.
+* [pg-query-context](https://github.com/constructive-io/constructive/tree/main/postgres/pg-query-context): **🔒 Session context injection** to add session-local context (e.g., `SET LOCAL`) into queries—ideal for setting `role`, `jwt.claims`, and other session settings.
+
+### 🧠 Parsing & AST
+
+* [pgsql-parser](https://www.npmjs.com/package/pgsql-parser): **🔄 SQL conversion engine** that interprets and converts PostgreSQL syntax.
+* [libpg-query-node](https://www.npmjs.com/package/libpg-query): **🌉 Node.js bindings** for `libpg_query`, converting SQL into parse trees.
+* [pg-proto-parser](https://www.npmjs.com/package/pg-proto-parser): **📦 Protobuf parser** for parsing PostgreSQL Protocol Buffers definitions to generate TypeScript interfaces, utility functions, and JSON mappings for enums.
+* [@pgsql/enums](https://www.npmjs.com/package/@pgsql/enums): **🏷️ TypeScript enums** for PostgreSQL AST for safe and ergonomic parsing logic.
+* [@pgsql/types](https://www.npmjs.com/package/@pgsql/types): **📝 Type definitions** for PostgreSQL AST nodes in TypeScript.
+* [@pgsql/utils](https://www.npmjs.com/package/@pgsql/utils): **🛠️ AST utilities** for constructing and transforming PostgreSQL syntax trees.
+
+### 📚 Documentation & Skills
+
+* [constructive-skills](https://github.com/constructive-io/constructive-skills): **📖 Platform documentation and AI agent skills** — feature catalog, blueprint reference, SDK guides (i18n, billing, limits, events, uploads, security, entities, search, AI), and deployment guides.
+
+Install skills for AI coding agents:
+
+```bash
+# All platform skills (security, blueprints, codegen, billing, etc.)
+npx skills add constructive-io/constructive-skills
+
+# Individual repo skills (pgpm, testing, CLI, search, etc.)
+npx skills add https://github.com/constructive-io/constructive --skill pgpm
+npx skills add https://github.com/constructive-io/constructive --skill constructive-testing
+```
+
+## Credits
+
+**🛠 Built by the [Constructive](https://constructive.io) team — creators of modular Postgres tooling for secure, composable backends. If you like our work, contribute on [GitHub](https://github.com/constructive-io).**
+
+## Disclaimer
+
+AS DESCRIBED IN THE LICENSES, THE SOFTWARE IS PROVIDED "AS IS", AT YOUR OWN RISK, AND WITHOUT WARRANTIES OF ANY KIND.
+
+No developer or entity involved in creating this software will be liable for any claims or damages whatsoever associated with your use, inability to use, or your interaction with other users of the code, including any direct, indirect, incidental, special, exemplary, punitive or consequential damages, or loss of profits, cryptocurrencies, tokens, or anything else of value.

package/classify.d.ts

@@ -0,0 +1,10 @@
+import type { ErrorClass } from './types';
+/**
+ * Classify a code as `public` or `internal`.
+ *
+ * Unknown codes are classified `internal` on purpose: transports mask internal
+ * errors, so an unregistered code is never leaked to end users by default.
+ */
+export declare function classify(code: string | null | undefined): ErrorClass;
+/** Whether a code is registered and classified `public`. */
+export declare function isPublicCode(code: string | null | undefined): boolean;

package/classify.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.classify = classify;
+exports.isPublicCode = isPublicCode;
+const registry_1 = require("./registry");
+/**
+ * Classify a code as `public` or `internal`.
+ *
+ * Unknown codes are classified `internal` on purpose: transports mask internal
+ * errors, so an unregistered code is never leaked to end users by default.
+ */
+function classify(code) {
+    if (!code)
+        return 'internal';
+    return (0, registry_1.getDefinition)(code)?.class ?? 'internal';
+}
+/** Whether a code is registered and classified `public`. */
+function isPublicCode(code) {
+    return classify(code) === 'public';
+}

package/define.d.ts

@@ -0,0 +1,16 @@
+import type { EmptyContext, ErrorContext, ErrorDefinition } from './types';
+/**
+ * A registry entry plus a phantom type carrier for its context. The
+ * contravariant `__context` field lets `ErrorsApi` recover `C` by inference
+ * even when `C` appears only in optional positions of {@link ErrorDefinition}.
+ * It is type-level only — never set at runtime.
+ */
+export type DefinedError<C extends ErrorContext = EmptyContext> = ErrorDefinition<C> & {
+    readonly __context: (context: C) => void;
+};
+/**
+ * Identity helper that captures each entry's context type for inference while
+ * keeping the registry a plain object. `errors.MODULE_NOT_FOUND({ name })` is
+ * then type-checked against the declared context.
+ */
+export declare function defineError<C extends ErrorContext = EmptyContext>(def: ErrorDefinition<C>): DefinedError<C>;

package/define.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defineError = defineError;
+/**
+ * Identity helper that captures each entry's context type for inference while
+ * keeping the registry a plain object. `errors.MODULE_NOT_FOUND({ name })` is
+ * then type-checked against the declared context.
+ */
+function defineError(def) {
+    return def;
+}

package/error.d.ts

@@ -0,0 +1,32 @@
+import type { ErrorClass, ErrorContext } from './types';
+export interface ConstructiveErrorArgs {
+    code: string;
+    message: string;
+    errorClass: ErrorClass;
+    http: number;
+    context?: ErrorContext;
+}
+/**
+ * The single canonical error class for Constructive. Carries the machine
+ * `code`, its classification, an HTTP hint, and structured `context`.
+ *
+ * Replaces the previously separate `PgpmError`, `AuthError`, and `DataError`
+ * shapes. GraphQL transports should serialize {@link toExtensions}.
+ */
+export declare class ConstructiveError extends Error {
+    readonly code: string;
+    readonly errorClass: ErrorClass;
+    readonly http: number;
+    readonly context?: ErrorContext;
+    constructor(args: ConstructiveErrorArgs);
+    /** Whether this error is safe to surface to end users. */
+    get isPublic(): boolean;
+    /** GraphQL `extensions` payload for this error. */
+    toExtensions(): {
+        code: string;
+        class: ErrorClass;
+        http: number;
+        context?: ErrorContext;
+    };
+    toString(): string;
+}

package/error.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConstructiveError = void 0;
+/**
+ * The single canonical error class for Constructive. Carries the machine
+ * `code`, its classification, an HTTP hint, and structured `context`.
+ *
+ * Replaces the previously separate `PgpmError`, `AuthError`, and `DataError`
+ * shapes. GraphQL transports should serialize {@link toExtensions}.
+ */
+class ConstructiveError extends Error {
+    code;
+    errorClass;
+    http;
+    context;
+    constructor(args) {
+        super(args.message);
+        this.name = 'ConstructiveError';
+        this.code = args.code;
+        this.errorClass = args.errorClass;
+        this.http = args.http;
+        this.context = args.context;
+        if (Error.captureStackTrace) {
+            Error.captureStackTrace(this, ConstructiveError);
+        }
+    }
+    /** Whether this error is safe to surface to end users. */
+    get isPublic() {
+        return this.errorClass === 'public';
+    }
+    /** GraphQL `extensions` payload for this error. */
+    toExtensions() {
+        const ext = {
+            code: this.code,
+            class: this.errorClass,
+            http: this.http
+        };
+        if (this.context && Object.keys(this.context).length > 0) {
+            ext.context = this.context;
+        }
+        return ext;
+    }
+    toString() {
+        return `[${this.code}] ${this.message}`;
+    }
+}
+exports.ConstructiveError = ConstructiveError;

package/esm/classify.d.ts

@@ -0,0 +1,10 @@
+import type { ErrorClass } from './types';
+/**
+ * Classify a code as `public` or `internal`.
+ *
+ * Unknown codes are classified `internal` on purpose: transports mask internal
+ * errors, so an unregistered code is never leaked to end users by default.
+ */
+export declare function classify(code: string | null | undefined): ErrorClass;
+/** Whether a code is registered and classified `public`. */
+export declare function isPublicCode(code: string | null | undefined): boolean;

package/esm/classify.js

@@ -0,0 +1,16 @@
+import { getDefinition } from './registry';
+/**
+ * Classify a code as `public` or `internal`.
+ *
+ * Unknown codes are classified `internal` on purpose: transports mask internal
+ * errors, so an unregistered code is never leaked to end users by default.
+ */
+export function classify(code) {
+    if (!code)
+        return 'internal';
+    return getDefinition(code)?.class ?? 'internal';
+}
+/** Whether a code is registered and classified `public`. */
+export function isPublicCode(code) {
+    return classify(code) === 'public';
+}

package/esm/define.d.ts

@@ -0,0 +1,16 @@
+import type { EmptyContext, ErrorContext, ErrorDefinition } from './types';
+/**
+ * A registry entry plus a phantom type carrier for its context. The
+ * contravariant `__context` field lets `ErrorsApi` recover `C` by inference
+ * even when `C` appears only in optional positions of {@link ErrorDefinition}.
+ * It is type-level only — never set at runtime.
+ */
+export type DefinedError<C extends ErrorContext = EmptyContext> = ErrorDefinition<C> & {
+    readonly __context: (context: C) => void;
+};
+/**
+ * Identity helper that captures each entry's context type for inference while
+ * keeping the registry a plain object. `errors.MODULE_NOT_FOUND({ name })` is
+ * then type-checked against the declared context.
+ */
+export declare function defineError<C extends ErrorContext = EmptyContext>(def: ErrorDefinition<C>): DefinedError<C>;

package/esm/define.js

@@ -0,0 +1,8 @@
+/**
+ * Identity helper that captures each entry's context type for inference while
+ * keeping the registry a plain object. `errors.MODULE_NOT_FOUND({ name })` is
+ * then type-checked against the declared context.
+ */
+export function defineError(def) {
+    return def;
+}

package/esm/error.d.ts

@@ -0,0 +1,32 @@
+import type { ErrorClass, ErrorContext } from './types';
+export interface ConstructiveErrorArgs {
+    code: string;
+    message: string;
+    errorClass: ErrorClass;
+    http: number;
+    context?: ErrorContext;
+}
+/**
+ * The single canonical error class for Constructive. Carries the machine
+ * `code`, its classification, an HTTP hint, and structured `context`.
+ *
+ * Replaces the previously separate `PgpmError`, `AuthError`, and `DataError`
+ * shapes. GraphQL transports should serialize {@link toExtensions}.
+ */
+export declare class ConstructiveError extends Error {
+    readonly code: string;
+    readonly errorClass: ErrorClass;
+    readonly http: number;
+    readonly context?: ErrorContext;
+    constructor(args: ConstructiveErrorArgs);
+    /** Whether this error is safe to surface to end users. */
+    get isPublic(): boolean;
+    /** GraphQL `extensions` payload for this error. */
+    toExtensions(): {
+        code: string;
+        class: ErrorClass;
+        http: number;
+        context?: ErrorContext;
+    };
+    toString(): string;
+}

package/esm/error.js

@@ -0,0 +1,43 @@
+/**
+ * The single canonical error class for Constructive. Carries the machine
+ * `code`, its classification, an HTTP hint, and structured `context`.
+ *
+ * Replaces the previously separate `PgpmError`, `AuthError`, and `DataError`
+ * shapes. GraphQL transports should serialize {@link toExtensions}.
+ */
+export class ConstructiveError extends Error {
+    code;
+    errorClass;
+    http;
+    context;
+    constructor(args) {
+        super(args.message);
+        this.name = 'ConstructiveError';
+        this.code = args.code;
+        this.errorClass = args.errorClass;
+        this.http = args.http;
+        this.context = args.context;
+        if (Error.captureStackTrace) {
+            Error.captureStackTrace(this, ConstructiveError);
+        }
+    }
+    /** Whether this error is safe to surface to end users. */
+    get isPublic() {
+        return this.errorClass === 'public';
+    }
+    /** GraphQL `extensions` payload for this error. */
+    toExtensions() {
+        const ext = {
+            code: this.code,
+            class: this.errorClass,
+            http: this.http
+        };
+        if (this.context && Object.keys(this.context).length > 0) {
+            ext.context = this.context;
+        }
+        return ext;
+    }
+    toString() {
+        return `[${this.code}] ${this.message}`;
+    }
+}

package/esm/factory.d.ts

@@ -0,0 +1,35 @@
+import { ConstructiveError } from './error';
+import { registry } from './registry';
+import type { ErrorClass, ErrorContext, ErrorDefinition } from './types';
+/**
+ * The callable produced for a registry entry. Codes with no context params can
+ * be called with no arguments; codes with params require a matching context.
+ * The `[keyof C]` tuple wrapper prevents `never` from distributing.
+ */
+export type ErrorFactory<C extends ErrorContext> = [keyof C] extends [never] ? (context?: Record<string, never>, overrideMessage?: string) => ConstructiveError : (context: C, overrideMessage?: string) => ConstructiveError;
+export type ErrorsApi<R> = {
+    [K in keyof R]: R[K] extends {
+        __context: (context: infer C) => void;
+    } ? C extends ErrorContext ? ErrorFactory<C> : never : never;
+};
+/** Build a throwable factory for a single definition. */
+export declare function makeErrorFromDefinition<C extends ErrorContext>(def: ErrorDefinition<C>): ErrorFactory<C>;
+/** Build the `errors.*` factory object from a registry. */
+export declare function buildErrors<R extends Record<string, {
+    __context: (context: never) => void;
+}>>(reg: R): ErrorsApi<R>;
+/**
+ * Low-level factory helper for defining an error inline (the pattern the former
+ * pgpm `error-factory` exposed). Prefer registering codes in the registry, but
+ * this remains available for ad-hoc / dynamically-coded errors.
+ */
+export declare function makeError<C extends ErrorContext>(code: string, messageFn: (context: C) => string, httpCode?: number, errorClass?: ErrorClass): (context: C, overrideMessage?: string) => ConstructiveError;
+/**
+ * The canonical `errors.*` factory.
+ *
+ * Curated codes are strongly typed (`errors.MODULE_NOT_FOUND({ name })`); every
+ * other constructive-db code is available via a generic factory through the
+ * index signature (`errors.ACCOUNT_EXISTS()`), backed by the generated
+ * registry. Curated entries override generated ones on conflict.
+ */
+export declare const errors: ErrorsApi<typeof registry> & Record<string, ErrorFactory<ErrorContext>>;

package/esm/factory.js

@@ -0,0 +1,49 @@
+import { ConstructiveError } from './error';
+import { format } from './format';
+import { generatedRegistry } from './generated/registry.generated';
+import { registry } from './registry';
+/** Build a throwable factory for a single definition. */
+export function makeErrorFromDefinition(def) {
+    const factory = (context, overrideMessage) => new ConstructiveError({
+        code: def.code,
+        message: overrideMessage ?? format(def.code, context ?? {}),
+        errorClass: def.class,
+        http: def.http,
+        context
+    });
+    return factory;
+}
+/** Build the `errors.*` factory object from a registry. */
+export function buildErrors(reg) {
+    const out = {};
+    for (const key of Object.keys(reg)) {
+        out[key] = makeErrorFromDefinition(reg[key]);
+    }
+    return out;
+}
+/**
+ * Low-level factory helper for defining an error inline (the pattern the former
+ * pgpm `error-factory` exposed). Prefer registering codes in the registry, but
+ * this remains available for ad-hoc / dynamically-coded errors.
+ */
+export function makeError(code, messageFn, httpCode = 500, errorClass = 'internal') {
+    return (context, overrideMessage) => new ConstructiveError({
+        code,
+        message: overrideMessage ?? messageFn(context),
+        errorClass,
+        http: httpCode,
+        context
+    });
+}
+/**
+ * The canonical `errors.*` factory.
+ *
+ * Curated codes are strongly typed (`errors.MODULE_NOT_FOUND({ name })`); every
+ * other constructive-db code is available via a generic factory through the
+ * index signature (`errors.ACCOUNT_EXISTS()`), backed by the generated
+ * registry. Curated entries override generated ones on conflict.
+ */
+export const errors = buildErrors({
+    ...generatedRegistry,
+    ...registry
+});

package/esm/format.d.ts

@@ -0,0 +1,24 @@
+import type { ErrorContext } from './types';
+/** A locale catalog maps `code` → message template (with `{{var}}`). */
+export type MessageCatalog = Record<string, string>;
+/**
+ * Locale to use when `format` is called without one. This is a plain fallback
+ * label, not a special catalog: the untagged default copy lives in the registry
+ * itself, so there is no built-in `'en'` catalog to keep in sync.
+ */
+export declare const DEFAULT_LOCALE = "en";
+/**
+ * Register or extend a locale catalog. Merges with any existing entries for
+ * that locale (new entries win), so hosts can override individual codes — pass
+ * the default locale to override the base copy.
+ */
+export declare function registerCatalog(locale: string, catalog: MessageCatalog): void;
+/**
+ * Render a localized message for a code.
+ *
+ * Resolution order:
+ * 1. requested-locale overlay entry (template) → interpolate
+ * 2. registry default message (template → interpolate, or function → call)
+ * 3. humanized code
+ */
+export declare function format(code: string, context?: ErrorContext, locale?: string): string;

package/esm/format.js

@@ -0,0 +1,54 @@
+import { interpolate } from './interpolate';
+import { getDefinition } from './registry';
+/**
+ * Locale to use when `format` is called without one. This is a plain fallback
+ * label, not a special catalog: the untagged default copy lives in the registry
+ * itself, so there is no built-in `'en'` catalog to keep in sync.
+ */
+export const DEFAULT_LOCALE = 'en';
+/**
+ * Registered locale overlays. Empty by default — the base/default message for
+ * every code is the registry entry, so a locale only needs entries for the
+ * codes it actually translates.
+ */
+const catalogs = {};
+/**
+ * Register or extend a locale catalog. Merges with any existing entries for
+ * that locale (new entries win), so hosts can override individual codes — pass
+ * the default locale to override the base copy.
+ */
+export function registerCatalog(locale, catalog) {
+    catalogs[locale] = { ...catalogs[locale], ...catalog };
+}
+/** Humanize a code as a last-resort message, e.g. `LIMIT_REACHED` → `Limit reached`. */
+function humanize(code) {
+    const lower = code.toLowerCase().replace(/_/g, ' ');
+    return lower.charAt(0).toUpperCase() + lower.slice(1);
+}
+/** The registry's default message for a code (string template or function). */
+function defaultMessage(code, context) {
+    const def = getDefinition(code);
+    if (def) {
+        if (typeof def.message === 'string')
+            return interpolate(def.message, context);
+        if (typeof def.message === 'function') {
+            return def.message(context);
+        }
+    }
+    return humanize(code);
+}
+/**
+ * Render a localized message for a code.
+ *
+ * Resolution order:
+ * 1. requested-locale overlay entry (template) → interpolate
+ * 2. registry default message (template → interpolate, or function → call)
+ * 3. humanized code
+ */
+export function format(code, context = {}, locale = DEFAULT_LOCALE) {
+    const overlay = catalogs[locale]?.[code];
+    if (typeof overlay === 'string') {
+        return interpolate(overlay, context);
+    }
+    return defaultMessage(code, context);
+}

package/esm/generated/registry.generated.d.ts

@@ -0,0 +1,27 @@
+/**
+ * GENERATED FILE — DO NOT EDIT BY HAND.
+ *
+ * Source of truth: the constructive-db error audit (289 distinct codes
+ * raised via EXCEPTION/THROW across deploy sources + generated output).
+ * Regenerate with `python3 scripts/generate-registry.py` (see README.md).
+ *
+ * Public copy is seeded from the dashboard error catalogs; developer/invariant
+ * codes carry their raw message (with %-args rendered as {{argN}}). Curated
+ * entries in `registry.ts` override anything here (typed context + refined copy).
+ *
+ * Counts: 289 total, 82 public, 207 internal.
+ */
+import { type DefinedError } from '../define';
+import type { ErrorContext } from '../types';
+export interface GeneratedCodeMeta {
+    class: 'public' | 'internal';
+    dynamic: boolean;
+    /** True when the code is only emitted by DB code generators (no hand source). */
+    generatedOnly: boolean;
+}
+/** Every constructive-db error code, keyed by code. */
+export declare const generatedRegistry: Record<string, DefinedError<ErrorContext>>;
+/** Audit metadata for each generated code. */
+export declare const GENERATED_CODE_META: Record<string, GeneratedCodeMeta>;
+/** Total number of codes collected from constructive-db. */
+export declare const GENERATED_CODE_COUNT = 289;