@shirudo/ddd-kit 1.0.0-rc.9 → 1.0.1

package/dist/http.d.ts

@@ -0,0 +1,46 @@
+import { ValidationError, ProblemDetailsOptions, ProblemDetails } from '@shirudo/base-error';
+
+/** Extension member that carries the collected field issues. */
+type ValidationProblemMember = "errors" | "invalid-params";
+/**
+ * Options for {@link toProblemDetails}. Mirrors base-error's
+ * `ProblemDetailsOptions` but takes over the `extensions` member to attach the
+ * collected field issues, and adds {@link member} to choose the wire key.
+ */
+interface ValidationProblemOptions extends Omit<ProblemDetailsOptions, "extensions"> {
+    /**
+     * Extension member that carries the field issues. Default `"errors"`
+     * (`{ message, path, code?, pointer? }` entries). RFC 9457 does not
+     * standardize a multi-error member; `errors` is the common convention.
+     */
+    member?: ValidationProblemMember;
+    /** Extra public extension members merged alongside the issues. */
+    extensions?: Record<string, unknown>;
+}
+/**
+ * Projects a base-error {@link ValidationError} to an RFC 9457 Problem Details
+ * object with the collected field issues attached under an extension member.
+ *
+ * base-error is **safe by default**: `ValidationError.toProblemDetails()` does
+ * not expose the issues on its own — they only cross to a client through the
+ * `publicIssues()` whitelist. This helper performs that explicit projection and
+ * applies sensible validation defaults (`422`, `"Validation Failed"`), so the
+ * common boundary case is a one-liner instead of a footgun.
+ *
+ * This is a presentation/transport concern and ships from the opt-in
+ * `@shirudo/ddd-kit/http` entry point — the core kit stays transport-free.
+ *
+ * @example
+ * ```ts
+ * import { toProblemDetails } from "@shirudo/ddd-kit/http";
+ *
+ * if (result.isErr()) {
+ *   return Response.json(toProblemDetails(result.error), { status: 422 });
+ * }
+ * // → { type, title: "Validation Failed", status: 422,
+ * //     errors: [{ message: "must be a valid email", path: ["email"], pointer: "email" }] }
+ * ```
+ */
+declare function toProblemDetails(error: ValidationError, options?: ValidationProblemOptions): ProblemDetails;
+
+export { type ValidationProblemMember, type ValidationProblemOptions, toProblemDetails };

package/dist/http.js

@@ -0,0 +1,18 @@
+var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+
+// src/http/problem-details.ts
+function toProblemDetails(error, options = {}) {
+  const { member = "errors", extensions, ...rest } = options;
+  return error.toProblemDetails({
+    title: "Validation Failed",
+    status: 422,
+    ...rest,
+    extensions: { ...extensions, [member]: error.publicIssues() }
+  });
+}
+__name(toProblemDetails, "toProblemDetails");
+
+export { toProblemDetails };
+//# sourceMappingURL=http.js.map
+//# sourceMappingURL=http.js.map

package/dist/http.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/http/problem-details.ts"],"names":[],"mappings":";;;;AAkDO,SAAS,gBAAA,CACf,KAAA,EACA,OAAA,GAAoC,EAAC,EACpB;AACjB,EAAA,MAAM,EAAE,MAAA,GAAS,QAAA,EAAU,UAAA,EAAY,GAAG,MAAK,GAAI,OAAA;AACnD,EAAA,OAAO,MAAM,gBAAA,CAAiB;AAAA,IAC7B,KAAA,EAAO,mBAAA;AAAA,IACP,MAAA,EAAQ,GAAA;AAAA,IACR,GAAG,IAAA;AAAA,IACH,UAAA,EAAY,EAAE,GAAG,UAAA,EAAY,CAAC,MAAM,GAAG,KAAA,CAAM,YAAA,EAAa;AAAE,GAC5D,CAAA;AACF;AAXgB,MAAA,CAAA,gBAAA,EAAA,kBAAA,CAAA","file":"http.js","sourcesContent":["import type {\n\tProblemDetails,\n\tProblemDetailsOptions,\n\tValidationError,\n} from \"@shirudo/base-error\";\n\n/** Extension member that carries the collected field issues. */\nexport type ValidationProblemMember = \"errors\" | \"invalid-params\";\n\n/**\n * Options for {@link toProblemDetails}. Mirrors base-error's\n * `ProblemDetailsOptions` but takes over the `extensions` member to attach the\n * collected field issues, and adds {@link member} to choose the wire key.\n */\nexport interface ValidationProblemOptions\n\textends Omit<ProblemDetailsOptions, \"extensions\"> {\n\t/**\n\t * Extension member that carries the field issues. Default `\"errors\"`\n\t * (`{ message, path, code?, pointer? }` entries). RFC 9457 does not\n\t * standardize a multi-error member; `errors` is the common convention.\n\t */\n\tmember?: ValidationProblemMember;\n\t/** Extra public extension members merged alongside the issues. */\n\textensions?: Record<string, unknown>;\n}\n\n/**\n * Projects a base-error {@link ValidationError} to an RFC 9457 Problem Details\n * object with the collected field issues attached under an extension member.\n *\n * base-error is **safe by default**: `ValidationError.toProblemDetails()` does\n * not expose the issues on its own — they only cross to a client through the\n * `publicIssues()` whitelist. This helper performs that explicit projection and\n * applies sensible validation defaults (`422`, `\"Validation Failed\"`), so the\n * common boundary case is a one-liner instead of a footgun.\n *\n * This is a presentation/transport concern and ships from the opt-in\n * `@shirudo/ddd-kit/http` entry point — the core kit stays transport-free.\n *\n * @example\n * ```ts\n * import { toProblemDetails } from \"@shirudo/ddd-kit/http\";\n *\n * if (result.isErr()) {\n *   return Response.json(toProblemDetails(result.error), { status: 422 });\n * }\n * // → { type, title: \"Validation Failed\", status: 422,\n * //     errors: [{ message: \"must be a valid email\", path: [\"email\"], pointer: \"email\" }] }\n * ```\n */\nexport function toProblemDetails(\n\terror: ValidationError,\n\toptions: ValidationProblemOptions = {},\n): ProblemDetails {\n\tconst { member = \"errors\", extensions, ...rest } = options;\n\treturn error.toProblemDetails({\n\t\ttitle: \"Validation Failed\",\n\t\tstatus: 422,\n\t\t...rest,\n\t\textensions: { ...extensions, [member]: error.publicIssues() },\n\t});\n}\n"]}

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { Result } from '@shirudo/result';
-import { BaseError } from '@shirudo/base-error';
+import { BaseError, ValidationError } from '@shirudo/base-error';
 import { DeepEqualExceptOptions } from './utils.js';
 export { DeepOmitOptions, Key, PathSegment, deepEqual, deepEqualExcept, deepOmit } from './utils.js';
 
@@ -2553,4 +2553,37 @@ declare abstract class ValueObject<T extends object> implements IValueObject<T>
     toJSON(): Readonly<T>;
 }
 
-export { type AggregateConfig, AggregateNotFoundError, AggregateRoot, type AggregateSnapshot, type AnyDomainEvent, type ClockFactory, type Command, CommandBus, type CommandHandler, ConcurrencyConflictError, type CreateDomainEventOptions, DeepEqualExceptOptions, DomainError, type DomainEvent, Entity, type EventBus, EventBusImpl, type EventHandler, type EventIdFactory, type EventMetadata, EventSourcedAggregate, type IAggregateRoot, type ICommandBus, type IEntity, type IEventSourcedAggregate, type IQueryBus, type IQueryableRepository, type IRepository, type IValueObject, type Id, type IdGenerator, type Identifiable, InMemoryOutbox, InfrastructureError, MissingHandlerError, type OnceOptions, type Outbox, type OutboxRecord, type Query, QueryBus, type QueryHandler, type TransactionScope, type VO, ValueObject, type Version, copyMetadata, createDomainEvent, createDomainEventWithMetadata, deepFreeze, entityIds, findEntityById, freezeShallow, hasEntityId, mergeMetadata, removeEntityById, replaceEntityById, resetClockFactory, resetEventIdFactory, sameEntity, sameVersion, setClockFactory, setEventIdFactory, updateEntityById, vo, voEquals, voEqualsExcept, voWithValidation, withClockFactory, withCommit, withEventIdFactory };
+/**
+ * Builds an immutable value object while collecting **all** validation
+ * violations into a single {@link ValidationError}, instead of failing on the
+ * first one. This is the Result-first, multi-error counterpart to
+ * `voWithValidation` (which returns a single string message).
+ *
+ * The `validate` callback receives a fresh `ValidationError` to push field
+ * issues onto (via `addIssue` / `addIssues`) and the raw input. When no issue
+ * was recorded the input is frozen into a `VO<T>` and returned as `Ok`;
+ * otherwise the populated `ValidationError` is returned as `Err`.
+ *
+ * `ValidationError` comes from `@shirudo/base-error` — import it from there to
+ * narrow the `Err` branch, exactly as `Result` is imported from
+ * `@shirudo/result`. It serializes to RFC 9457 Problem Details; use
+ * {@link validationProblemDetails} at the HTTP boundary to surface the issues.
+ *
+ * @example
+ * ```ts
+ * const result = voValidated(
+ *   { email, age },
+ *   (issues, m) => {
+ *     if (!isEmail(m.email))
+ *       issues.addIssue({ message: "must be a valid email", path: ["email"] });
+ *     if (m.age < 0)
+ *       issues.addIssue({ message: "must not be negative", path: ["age"] });
+ *   },
+ *   "Registration is invalid",
+ * );
+ * // result.isErr() → result.error.publicIssues() has both violations
+ * ```
+ */
+declare function voValidated<T>(t: T, validate: (issues: ValidationError, value: T) => void, message?: string): Result<VO<T>, ValidationError>;
+
+export { type AggregateConfig, AggregateNotFoundError, AggregateRoot, type AggregateSnapshot, type AnyDomainEvent, type ClockFactory, type Command, CommandBus, type CommandHandler, ConcurrencyConflictError, type CreateDomainEventOptions, DeepEqualExceptOptions, DomainError, type DomainEvent, Entity, type EventBus, EventBusImpl, type EventHandler, type EventIdFactory, type EventMetadata, EventSourcedAggregate, type IAggregateRoot, type ICommandBus, type IEntity, type IEventSourcedAggregate, type IQueryBus, type IQueryableRepository, type IRepository, type IValueObject, type Id, type IdGenerator, type Identifiable, InMemoryOutbox, InfrastructureError, MissingHandlerError, type OnceOptions, type Outbox, type OutboxRecord, type Query, QueryBus, type QueryHandler, type TransactionScope, type VO, ValueObject, type Version, copyMetadata, createDomainEvent, createDomainEventWithMetadata, deepFreeze, entityIds, findEntityById, freezeShallow, hasEntityId, mergeMetadata, removeEntityById, replaceEntityById, resetClockFactory, resetEventIdFactory, sameEntity, sameVersion, setClockFactory, setEventIdFactory, updateEntityById, vo, voEquals, voEqualsExcept, voValidated, voWithValidation, withClockFactory, withCommit, withEventIdFactory };

package/dist/index.js

@@ -1,5 +1,5 @@
 import { err, ok } from '@shirudo/result';
-import { BaseError } from '@shirudo/base-error';
+import { BaseError, ValidationError } from '@shirudo/base-error';
 
 var __defProp = Object.defineProperty;
 var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
@@ -1260,7 +1260,13 @@ var InMemoryOutbox = class {
     for (const id of dispatchIds) this.pending.delete(id);
   }
 };
+function voValidated(t, validate, message = "Validation failed") {
+  const issues = new ValidationError(message);
+  validate(issues, t);
+  return issues.hasIssues() ? err(issues) : ok(vo(t));
+}
+__name(voValidated, "voValidated");
 
-export { AggregateNotFoundError, AggregateRoot, CommandBus, ConcurrencyConflictError, DomainError, Entity, EventBusImpl, EventSourcedAggregate, InMemoryOutbox, InfrastructureError, MissingHandlerError, QueryBus, ValueObject, copyMetadata, createDomainEvent, createDomainEventWithMetadata, deepEqual, deepEqualExcept, deepFreeze, deepOmit, entityIds, findEntityById, freezeShallow, hasEntityId, mergeMetadata, removeEntityById, replaceEntityById, resetClockFactory, resetEventIdFactory, sameEntity, sameVersion, setClockFactory, setEventIdFactory, updateEntityById, vo, voEquals, voEqualsExcept, voWithValidation, withClockFactory, withCommit, withEventIdFactory };
+export { AggregateNotFoundError, AggregateRoot, CommandBus, ConcurrencyConflictError, DomainError, Entity, EventBusImpl, EventSourcedAggregate, InMemoryOutbox, InfrastructureError, MissingHandlerError, QueryBus, ValueObject, copyMetadata, createDomainEvent, createDomainEventWithMetadata, deepEqual, deepEqualExcept, deepFreeze, deepOmit, entityIds, findEntityById, freezeShallow, hasEntityId, mergeMetadata, removeEntityById, replaceEntityById, resetClockFactory, resetEventIdFactory, sameEntity, sameVersion, setClockFactory, setEventIdFactory, updateEntityById, vo, voEquals, voEqualsExcept, voValidated, voWithValidation, withClockFactory, withCommit, withEventIdFactory };
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map