ddd-ts-kit 0.12.0 → 0.13.0

package/templates/route/route.none.ts.tpl

@@ -1,7 +1,7 @@
 {{#if route.protected}}
 import { actorOf } from '@ddd-ts-kit/auth';
 {{/if}}
-import { defineRoute, type Route } from '@ddd-ts-kit/http';
+import { {{#if route.sharedAccepted}}acceptedSchema, {{/if}}defineRoute, type Route } from '@ddd-ts-kit/http';
 {{#if route.usesSchema}}
 import { err, ok, type {{route.busType}} } from '@ddd-ts-kit/kernel';
 import { customSchema } from '@ddd-ts-kit/validation';
@@ -26,7 +26,7 @@ const anyObject = customSchema<Record<string, unknown>>(
 const body = anyObject;
 
 {{/if}}
-{{#if route.returnsId}}
+{{#if route.ownAccepted}}
 const accepted = customSchema<{ readonly id: string }>(
   (input) =>
     typeof input === 'object' && input !== null && 'id' in input && typeof input.id === 'string'
@@ -53,7 +53,7 @@ export function {{name.camel}}Route({{route.bus}}: {{route.busType}}): Route {
       request: { body },
       {{/if}}
       {{#if route.returnsId}}
-      responses: { {{route.status}}: { description: 'Done; the body carries the identifier.', body: accepted } },
+      responses: { {{route.status}}: { description: 'Done; the body carries the identifier.', body: {{route.acceptedBody}} } },
       {{/if}}
       {{#if route.returnsNothing}}
       responses: { {{route.status}}: { description: 'Done.' } },

package/templates/route/route.search.ts.tpl

@@ -1,6 +1,9 @@
 {{#if validation.zod}}
 import { z } from 'zod';
 {{/if}}
+{{#if validation.typebox}}
+import Type from 'typebox';
+{{/if}}
 import { actorOf } from '@ddd-ts-kit/auth';
 import { defineRoute, pageQuerySchema, pageResponse, pageSchemaOf, type Route } from '@ddd-ts-kit/http';
 {{#if search.customSchema}}
@@ -16,6 +19,9 @@ import { zodSchema } from '@ddd-ts-kit/validation/zod';
 {{#if validation.classValidator}}
 import { classSchema } from '@ddd-ts-kit/validation/class-validator';
 {{/if}}
+{{#if validation.typebox}}
+import { typeboxSchema } from '@ddd-ts-kit/validation/typebox';
+{{/if}}
 {{route.useCaseImport}}
 {{#if validation.classValidator}}
 import { {{name.pascal}}Line } from '{{alias.context}}/presentation/http/{{name.kebab}}-line.dto{{alias.ext}}';
@@ -36,6 +42,14 @@ const line = zodSchema(
 {{#if validation.classValidator}}
 const line = classSchema({{name.pascal}}Line);
 {{/if}}
+{{#if validation.typebox}}
+const line = typeboxSchema(
+  Type.Object({
+    id: Type.String(),
+    // TODO(domain): declare the fields of {{name.pascal}}Item that are part of the public contract.
+  }),
+);
+{{/if}}
 {{#if search.customSchema}}
 interface {{name.pascal}}Line {
   readonly id: string;

package/templates/route/route.standard-schema.ts.tpl

@@ -1,7 +1,7 @@
 {{#if route.protected}}
 import { actorOf } from '@ddd-ts-kit/auth';
 {{/if}}
-import { defineRoute, type Route } from '@ddd-ts-kit/http';
+import { {{#if route.sharedAccepted}}acceptedSchema, {{/if}}defineRoute, type Route } from '@ddd-ts-kit/http';
 import type { {{route.busType}} } from '@ddd-ts-kit/kernel';
 {{#if route.usesSchema}}
 import { standardSchema, type StandardSchemaV1 } from '@ddd-ts-kit/validation/standard-schema';
@@ -26,7 +26,7 @@ const anyObject: StandardSchemaV1<unknown, Record<string, unknown>> = {
 const body = standardSchema(anyObject, { type: 'object' });
 
 {{/if}}
-{{#if route.returnsId}}
+{{#if route.ownAccepted}}
 const acceptedShape: StandardSchemaV1<unknown, { readonly id: string }> = {
   '~standard': {
     version: 1,
@@ -62,7 +62,7 @@ export function {{name.camel}}Route({{route.bus}}: {{route.busType}}): Route {
       request: { body },
       {{/if}}
       {{#if route.returnsId}}
-      responses: { {{route.status}}: { description: 'Done; the body carries the identifier.', body: accepted } },
+      responses: { {{route.status}}: { description: 'Done; the body carries the identifier.', body: {{route.acceptedBody}} } },
       {{/if}}
       {{#if route.returnsNothing}}
       responses: { {{route.status}}: { description: 'Done.' } },

package/templates/route/route.typebox.ts.tpl

@@ -0,0 +1,79 @@
+import Type from 'typebox';
+{{#if route.protected}}
+import { actorOf } from '@ddd-ts-kit/auth';
+{{/if}}
+import { {{#if route.sharedAccepted}}acceptedSchema, {{/if}}defineRoute, type Route } from '@ddd-ts-kit/http';
+import type { {{route.busType}} } from '@ddd-ts-kit/kernel';
+import { typeboxSchema } from '@ddd-ts-kit/validation/typebox';
+{{route.useCaseImport}}
+
+{{#if route.hasParams}}
+const params = typeboxSchema(Type.Object({ {{route.typeboxParams}} }));
+
+{{/if}}
+{{#if route.hasBody}}
+const body = typeboxSchema(
+  Type.Object({
+    // TODO(domain): declare the fields the client sends for "{{name.words}}", with shape constraints only (types, formats, lengths); business rules stay in the domain.
+  }),
+);
+
+{{/if}}
+{{#if route.ownAccepted}}
+const accepted = typeboxSchema(Type.Object({ id: Type.String() }));
+
+{{/if}}
+{{#if route.isQuery}}
+const answer = typeboxSchema(
+  Type.Object({
+    // TODO(domain): declare the fields of {{name.pascal}}Result that are part of the public contract.
+  }),
+);
+
+{{/if}}
+export function {{name.camel}}Route({{route.bus}}: {{route.busType}}): Route {
+  return defineRoute(
+    {
+      method: '{{route.method}}',
+      path: '{{route.path}}',
+      operationId: '{{name.camel}}',
+      summary: '{{name.title}}',
+      tags: ['{{context.kebab}}'],
+      {{#if route.hasRequest}}
+      request: { {{route.requestParts}} },
+      {{/if}}
+      {{#if route.returnsId}}
+      responses: { {{route.status}}: { description: 'Done; the body carries the identifier.', body: {{route.acceptedBody}} } },
+      {{/if}}
+      {{#if route.returnsNothing}}
+      responses: { {{route.status}}: { description: 'Done.' } },
+      {{/if}}
+      {{#if route.isQuery}}
+      responses: { {{route.status}}: { description: 'The answer.', body: answer } },
+      {{/if}}
+      // TODO(domain): list the codes of the refusals "{{name.words}}" can raise, as their factories set them, so that they appear in the contract with their status (`errors/known-code`).
+      errors: [{{route.errorCodes}}],
+      security: {{route.security}},
+    },
+    async (input) => {
+      {{#if route.isQuery}}
+      // TODO(domain): build the query from `input` (params, query string); the actor is already there and map its answer to the public fields.
+      await {{route.bus}}.execute(new {{route.input}}({{route.actor}}));
+
+      return { status: {{route.status}}, body: {} };
+      {{/if}}
+      {{#if route.returnsId}}
+      // TODO(domain): build the command from `input` (body, params); the actor is already there.
+      const id = await {{route.bus}}.execute(new {{route.input}}({{route.actor}}));
+
+      return { status: {{route.status}}, body: { id } };
+      {{/if}}
+      {{#if route.returnsNothing}}
+      // TODO(domain): build the command from `input` (body, params); the actor is already there.
+      await {{route.bus}}.execute(new {{route.input}}({{route.actor}}));
+
+      return { status: {{route.status}} };
+      {{/if}}
+    },
+  );
+}

package/templates/route/route.zod.ts.tpl

@@ -2,7 +2,7 @@ import { z } from 'zod';
 {{#if route.protected}}
 import { actorOf } from '@ddd-ts-kit/auth';
 {{/if}}
-import { defineRoute, type Route } from '@ddd-ts-kit/http';
+import { {{#if route.sharedAccepted}}acceptedSchema, {{/if}}defineRoute, type Route } from '@ddd-ts-kit/http';
 import type { {{route.busType}} } from '@ddd-ts-kit/kernel';
 import { zodSchema } from '@ddd-ts-kit/validation/zod';
 {{route.useCaseImport}}
@@ -19,7 +19,7 @@ const body = zodSchema(
 );
 
 {{/if}}
-{{#if route.returnsId}}
+{{#if route.ownAccepted}}
 const accepted = zodSchema(z.object({ id: z.string() }), { io: 'output' });
 
 {{/if}}
@@ -44,7 +44,7 @@ export function {{name.camel}}Route({{route.bus}}: {{route.busType}}): Route {
       request: { {{route.requestParts}} },
       {{/if}}
       {{#if route.returnsId}}
-      responses: { {{route.status}}: { description: 'Done; the body carries the identifier.', body: accepted } },
+      responses: { {{route.status}}: { description: 'Done; the body carries the identifier.', body: {{route.acceptedBody}} } },
       {{/if}}
       {{#if route.returnsNothing}}
       responses: { {{route.status}}: { description: 'Done.' } },

package/templates/schema/schema.class-validator.ts.tpl

@@ -0,0 +1,3 @@
+export class {{name.pascal}} {
+  // TODO(domain): declare the fields of "{{name.words}}" as a client sees them, each with its class-validator decorators (shape constraints only). A route uses the class whole (`classSchema({{name.pascal}}, { shared: true })`), nested (`@ValidateNested()` and `@Type`) or in part (`class Body extends pickClass({{name.pascal}}, [...]) {}`, `omitClass`, `partialClass`); the contract documents it once, as {{name.pascal}}.
+}

package/templates/schema/schema.custom.ts.tpl

@@ -0,0 +1,14 @@
+import { err, ok } from '@ddd-ts-kit/kernel';
+import { customSchema, sharedSchema } from '@ddd-ts-kit/validation';
+
+// TODO(domain): replace the object check by the schema of "{{name.words}}" written with the validation library of the project, wrapped as it is here, and describe its fields in the JSON Schema; the contract documents it once, as {{name.pascal}}.
+export const {{name.camel}}Schema = sharedSchema(
+  '{{name.pascal}}',
+  customSchema<Record<string, unknown>>(
+    (input) =>
+      typeof input === 'object' && input !== null && !Array.isArray(input)
+        ? ok({ ...input })
+        : err([{ path: '', code: 'invalid_type', message: 'An object is expected.' }]),
+    { type: 'object' },
+  ),
+);

package/templates/schema/schema.typebox.ts.tpl

@@ -0,0 +1,8 @@
+import Type from 'typebox';
+
+export const {{name.camel}}Schema = Type.Object(
+  {
+    // TODO(domain): declare the fields of "{{name.words}}" as a client sees them, with shape constraints only (types, formats, lengths). A route uses the schema whole (`typeboxSchema({{name.camel}}Schema)`), inside another one, in part (`Type.Pick`, `Type.Omit`, `Type.Partial`) or extended (`Type.Intersect([{{name.camel}}Schema, Type.Object({...})])` keeps the reference); the contract documents it once, as {{name.pascal}}.
+  },
+  { $id: '{{name.pascal}}' },
+);

package/templates/schema/schema.zod.ts.tpl

@@ -0,0 +1,7 @@
+import { z } from 'zod';
+
+export const {{name.camel}}Schema = z
+  .object({
+    // TODO(domain): declare the fields of "{{name.words}}" as a client sees them, with shape constraints only (types, formats, lengths). A route uses the schema whole (`zodSchema({{name.camel}}Schema)`), inside another one, or in part (`.pick`, `.omit`, `.partial`, `.extend`); the contract documents it once, as {{name.pascal}}.
+  })
+  .meta({ id: '{{name.pascal}}' });