@shirudo/ddd-kit 1.3.0 → 2.0.0

package/dist/presentation.d.ts

@@ -0,0 +1,54 @@
+import { PublicIssue } from '@shirudo/base-error';
+import { PublicErrorView } from '@shirudo/base-error/presentation';
+
+/** Details shape carried by the view for a {@link toPublicErrorView} result. */
+interface PublicErrorViewDetails {
+    /** Whitelisted field issues, present only for a `ValidationError`. */
+    readonly issues: readonly PublicIssue[];
+}
+/** Options for {@link toPublicErrorView}. */
+interface PublicErrorViewOptions {
+    /**
+     * BCP 47 locale tag stamped on the view. The built-in messages are English;
+     * pass a locale only when you supply your own message resolution upstream.
+     * Default `"en"`.
+     */
+    locale?: string;
+}
+/**
+ * Maps a kit error (or any caught value) to a base-error
+ * {@link PublicErrorView}: a **transport-neutral**, client-safe representation
+ * (`code`, `message`, `locale`, optional `details`). It is deliberately *not* a
+ * transport adapter: it carries no HTTP status, header, or exit code, because
+ * those are the consumer's concern. Feed the view into base-error's
+ * `defineProblemDetailsAdapter` (HTTP / RFC 9457), a gRPC status mapper, or a
+ * CLI exit-code table, whichever boundary you are at.
+ *
+ * Total over `unknown`: an unmapped or non-kit value degrades to a generic
+ * `INTERNAL_ERROR` view rather than leaking the technical message or throwing.
+ * The kit's class-based errors match by their pinned `error.name`, so it
+ * survives minification and duplicate installs (no `instanceof`). A
+ * `ValidationError` is detected by its `publicIssues()` whitelist (base-error
+ * names it after its code), and those issues ride along in `details.issues`.
+ *
+ * For richer, multi-locale messages, register the kit's errors in a base-error
+ * `PublicErrorRegistry` and use `PublicErrorPresenter` instead; this helper is
+ * the lean, single-locale default.
+ *
+ * @example
+ * ```ts
+ * import { toPublicErrorView } from "@shirudo/ddd-kit/presentation";
+ * import { defineProblemDetailsAdapter } from "@shirudo/base-error/problem-details";
+ *
+ * const adapter = defineProblemDetailsAdapter({
+ *   definitions: { AggregateNotFoundError: { type: "about:blank", status: 404 } },
+ *   fallback: { type: "about:blank", status: 500 },
+ * });
+ *
+ * const { body, status } = adapter.map(toPublicErrorView(error));
+ * return Response.json(body, { status });
+ * ```
+ */
+declare function toPublicErrorView(error: unknown, options?: PublicErrorViewOptions): PublicErrorView<PublicErrorViewDetails>;
+
+export { type PublicErrorViewDetails, type PublicErrorViewOptions, toPublicErrorView };

package/dist/presentation.js

@@ -0,0 +1,45 @@
+var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+
+// src/presentation/public-error-view.ts
+var KIT_PUBLIC_MESSAGES = {
+  AggregateNotFoundError: "The requested resource could not be found.",
+  ConcurrencyConflictError: "The resource was modified by another request. Please reload and try again.",
+  DuplicateAggregateError: "The resource already exists."
+};
+var VALIDATION_MESSAGE = "The submitted data is invalid.";
+var FALLBACK_CODE = "INTERNAL_ERROR";
+var FALLBACK_MESSAGE = "An unexpected error occurred.";
+var DEFAULT_LOCALE = "en";
+function toPublicErrorView(error, options = {}) {
+  const locale = options.locale ?? DEFAULT_LOCALE;
+  const name = errorName(error);
+  if (hasPublicIssues(error)) {
+    return {
+      code: name ?? "VALIDATION_FAILED",
+      message: VALIDATION_MESSAGE,
+      locale,
+      details: { issues: error.publicIssues() }
+    };
+  }
+  const message = name ? KIT_PUBLIC_MESSAGES[name] : void 0;
+  if (message === void 0) {
+    return { code: FALLBACK_CODE, message: FALLBACK_MESSAGE, locale };
+  }
+  return { code: name, message, locale };
+}
+__name(toPublicErrorView, "toPublicErrorView");
+function errorName(error) {
+  if (typeof error !== "object" || error === null) return void 0;
+  const { name } = error;
+  return typeof name === "string" ? name : void 0;
+}
+__name(errorName, "errorName");
+function hasPublicIssues(error) {
+  return typeof error.publicIssues === "function";
+}
+__name(hasPublicIssues, "hasPublicIssues");
+
+export { toPublicErrorView };
+//# sourceMappingURL=presentation.js.map
+//# sourceMappingURL=presentation.js.map

package/dist/presentation.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/presentation/public-error-view.ts"],"names":[],"mappings":";;;;AAaA,IAAM,mBAAA,GAAwD;AAAA,EAC7D,sBAAA,EAAwB,4CAAA;AAAA,EACxB,wBAAA,EACC,4EAAA;AAAA,EACD,uBAAA,EAAyB;AAC1B,CAAA;AAGA,IAAM,kBAAA,GAAqB,gCAAA;AAE3B,IAAM,aAAA,GAAgB,gBAAA;AACtB,IAAM,gBAAA,GAAmB,+BAAA;AAEzB,IAAM,cAAA,GAAiB,IAAA;AAoDhB,SAAS,iBAAA,CACf,KAAA,EACA,OAAA,GAAkC,EAAC,EACO;AAC1C,EAAA,MAAM,MAAA,GAAS,QAAQ,MAAA,IAAU,cAAA;AACjC,EAAA,MAAM,IAAA,GAAO,UAAU,KAAK,CAAA;AAK5B,EAAA,IAAI,eAAA,CAAgB,KAAK,CAAA,EAAG;AAC3B,IAAA,OAAO;AAAA,MACN,MAAM,IAAA,IAAQ,mBAAA;AAAA,MACd,OAAA,EAAS,kBAAA;AAAA,MACT,MAAA;AAAA,MACA,OAAA,EAAS,EAAE,MAAA,EAAQ,KAAA,CAAM,cAAa;AAAE,KACzC;AAAA,EACD;AAEA,EAAA,MAAM,OAAA,GAAU,IAAA,GAAO,mBAAA,CAAoB,IAAI,CAAA,GAAI,MAAA;AACnD,EAAA,IAAI,YAAY,MAAA,EAAW;AAC1B,IAAA,OAAO,EAAE,IAAA,EAAM,aAAA,EAAe,OAAA,EAAS,kBAAkB,MAAA,EAAO;AAAA,EACjE;AAEA,EAAA,OAAO,EAAE,IAAA,EAAM,IAAA,EAAgB,OAAA,EAAS,MAAA,EAAO;AAChD;AAzBgB,MAAA,CAAA,iBAAA,EAAA,mBAAA,CAAA;AA4BhB,SAAS,UAAU,KAAA,EAAoC;AACtD,EAAA,IAAI,OAAO,KAAA,KAAU,QAAA,IAAY,KAAA,KAAU,MAAM,OAAO,MAAA;AACxD,EAAA,MAAM,EAAE,MAAK,GAAI,KAAA;AACjB,EAAA,OAAO,OAAO,IAAA,KAAS,QAAA,GAAW,IAAA,GAAO,MAAA;AAC1C;AAJS,MAAA,CAAA,SAAA,EAAA,WAAA,CAAA;AAOT,SAAS,gBACR,KAAA,EAC6C;AAC7C,EAAA,OACC,OAAQ,MAAqC,YAAA,KAAiB,UAAA;AAEhE;AANS,MAAA,CAAA,eAAA,EAAA,iBAAA,CAAA","file":"presentation.js","sourcesContent":["import type { PublicIssue } from \"@shirudo/base-error\";\nimport type { PublicErrorView } from \"@shirudo/base-error/presentation\";\n\n/**\n * Safe, client-facing English messages for the kit's known errors. They carry\n * no occurrence data (no id, version, or technical detail), so they never leak\n * across the boundary. This is the transport-neutral *presentation* layer: the\n * technical error classes stay free of these strings (removed from the core in\n * 2.0); here is their opt-in home.\n *\n * Keyed by the kit's pinned `error.name` (stable across minification and\n * duplicate installs), so matching does not depend on `instanceof`.\n */\nconst KIT_PUBLIC_MESSAGES: Readonly<Record<string, string>> = {\n\tAggregateNotFoundError: \"The requested resource could not be found.\",\n\tConcurrencyConflictError:\n\t\t\"The resource was modified by another request. Please reload and try again.\",\n\tDuplicateAggregateError: \"The resource already exists.\",\n};\n\n/** Message for a `ValidationError`, which is detected by capability, not name. */\nconst VALIDATION_MESSAGE = \"The submitted data is invalid.\";\n/** Public code and message used for any unmapped or non-kit error. */\nconst FALLBACK_CODE = \"INTERNAL_ERROR\";\nconst FALLBACK_MESSAGE = \"An unexpected error occurred.\";\n/** BCP 47 locale the built-in messages are written in. */\nconst DEFAULT_LOCALE = \"en\";\n\n/** Details shape carried by the view for a {@link toPublicErrorView} result. */\nexport interface PublicErrorViewDetails {\n\t/** Whitelisted field issues, present only for a `ValidationError`. */\n\treadonly issues: readonly PublicIssue[];\n}\n\n/** Options for {@link toPublicErrorView}. */\nexport interface PublicErrorViewOptions {\n\t/**\n\t * BCP 47 locale tag stamped on the view. The built-in messages are English;\n\t * pass a locale only when you supply your own message resolution upstream.\n\t * Default `\"en\"`.\n\t */\n\tlocale?: string;\n}\n\n/**\n * Maps a kit error (or any caught value) to a base-error\n * {@link PublicErrorView}: a **transport-neutral**, client-safe representation\n * (`code`, `message`, `locale`, optional `details`). It is deliberately *not* a\n * transport adapter: it carries no HTTP status, header, or exit code, because\n * those are the consumer's concern. Feed the view into base-error's\n * `defineProblemDetailsAdapter` (HTTP / RFC 9457), a gRPC status mapper, or a\n * CLI exit-code table, whichever boundary you are at.\n *\n * Total over `unknown`: an unmapped or non-kit value degrades to a generic\n * `INTERNAL_ERROR` view rather than leaking the technical message or throwing.\n * The kit's class-based errors match by their pinned `error.name`, so it\n * survives minification and duplicate installs (no `instanceof`). A\n * `ValidationError` is detected by its `publicIssues()` whitelist (base-error\n * names it after its code), and those issues ride along in `details.issues`.\n *\n * For richer, multi-locale messages, register the kit's errors in a base-error\n * `PublicErrorRegistry` and use `PublicErrorPresenter` instead; this helper is\n * the lean, single-locale default.\n *\n * @example\n * ```ts\n * import { toPublicErrorView } from \"@shirudo/ddd-kit/presentation\";\n * import { defineProblemDetailsAdapter } from \"@shirudo/base-error/problem-details\";\n *\n * const adapter = defineProblemDetailsAdapter({\n *   definitions: { AggregateNotFoundError: { type: \"about:blank\", status: 404 } },\n *   fallback: { type: \"about:blank\", status: 500 },\n * });\n *\n * const { body, status } = adapter.map(toPublicErrorView(error));\n * return Response.json(body, { status });\n * ```\n */\nexport function toPublicErrorView(\n\terror: unknown,\n\toptions: PublicErrorViewOptions = {},\n): PublicErrorView<PublicErrorViewDetails> {\n\tconst locale = options.locale ?? DEFAULT_LOCALE;\n\tconst name = errorName(error);\n\n\t// ValidationError (and subclasses) are detected by the publicIssues()\n\t// whitelist, not by name: base-error names a ValidationError after its code\n\t// (\"VALIDATION_FAILED\"), so a name match would miss it.\n\tif (hasPublicIssues(error)) {\n\t\treturn {\n\t\t\tcode: name ?? \"VALIDATION_FAILED\",\n\t\t\tmessage: VALIDATION_MESSAGE,\n\t\t\tlocale,\n\t\t\tdetails: { issues: error.publicIssues() },\n\t\t};\n\t}\n\n\tconst message = name ? KIT_PUBLIC_MESSAGES[name] : undefined;\n\tif (message === undefined) {\n\t\treturn { code: FALLBACK_CODE, message: FALLBACK_MESSAGE, locale };\n\t}\n\n\treturn { code: name as string, message, locale };\n}\n\n/** Reads a string `name` off a caught value without assuming it is an Error. */\nfunction errorName(error: unknown): string | undefined {\n\tif (typeof error !== \"object\" || error === null) return undefined;\n\tconst { name } = error as { name?: unknown };\n\treturn typeof name === \"string\" ? name : undefined;\n}\n\n/** Duck-types base-error's `ValidationError.publicIssues()` accessor. */\nfunction hasPublicIssues(\n\terror: unknown,\n): error is { publicIssues(): PublicIssue[] } {\n\treturn (\n\t\ttypeof (error as { publicIssues?: unknown }).publicIssues === \"function\"\n\t);\n}\n"]}

package/dist/testing.d.ts

@@ -1,4 +1,4 @@
-import { I as IAggregateRoot, a as Id, A as AnyDomainEvent } from './aggregate-BGdgvqKh.js';
+import { I as IAggregateRoot, a as Id, A as AnyDomainEvent } from './aggregate-CePTINEt.js';
 import '@shirudo/result';
 import '@shirudo/base-error';
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@shirudo/ddd-kit",
-	"version": "1.3.0",
+	"version": "2.0.0",
 	"description": "Composable TypeScript toolkit for tactical DDD",
 	"type": "module",
 	"repository": {
@@ -11,22 +11,29 @@
 	"types": "./dist/index.d.ts",
 	"exports": {
 		".": {
-			"import": "./dist/index.js",
-			"types": "./dist/index.d.ts"
+			"types": "./dist/index.d.ts",
+			"import": "./dist/index.js"
 		},
 		"./utils": {
-			"import": "./dist/utils.js",
-			"types": "./dist/utils.d.ts"
+			"types": "./dist/utils.d.ts",
+			"import": "./dist/utils.js"
 		},
 		"./http": {
-			"import": "./dist/http.js",
-			"types": "./dist/http.d.ts"
+			"types": "./dist/http.d.ts",
+			"import": "./dist/http.js"
+		},
+		"./presentation": {
+			"types": "./dist/presentation.d.ts",
+			"import": "./dist/presentation.js"
 		},
 		"./testing": {
-			"import": "./dist/testing.js",
-			"types": "./dist/testing.d.ts"
+			"types": "./dist/testing.d.ts",
+			"import": "./dist/testing.js"
 		}
 	},
+	"engines": {
+		"node": ">=20"
+	},
 	"sideEffects": false,
 	"files": [
 		"dist"
@@ -56,7 +63,7 @@
 	},
 	"devDependencies": {
 		"@biomejs/biome": "2.1.4",
-		"@shirudo/base-error": "^5.0.0",
+		"@shirudo/base-error": "^7.1.1",
 		"@shirudo/result": "^1.0.0",
 		"tsup": "^8.5.0",
 		"typedoc": "^0.28.19",
@@ -77,7 +84,7 @@
 		"url": "https://github.com/shi-rudo/ddd-kit-ts/issues"
 	},
 	"peerDependencies": {
-		"@shirudo/base-error": "^5.0.0",
+		"@shirudo/base-error": "^7.1.1",
 		"@shirudo/result": "^1.0.0"
 	}
 }