@jskit-ai/crud-server-generator 0.1.63 → 0.1.64

package/test/routeInputContracts.test.js

@@ -36,7 +36,7 @@ function findRoute(routes, method, path) {
   return routes.find((route) => route.method === method && route.path === path) || null;
 }
 
-test("crud routes build create/update action input with explicit payload and patch keys", async () => {
+test("crud routes build flattened create/update action input", async () => {
   const registeredRoutes = [];
   const router = {
     register(method, path, route, handler) {
@@ -100,12 +100,14 @@ test("crud routes build create/update action input with explicit payload and pat
 
   assert.deepEqual(calls[0].input, {
     workspaceSlug: "acme",
-    payload: { textField: "A", dateField: "2026-03-11", numberField: 2 }
+    textField: "A",
+    dateField: "2026-03-11",
+    numberField: 2
   });
   assert.deepEqual(calls[1].input, {
     workspaceSlug: "acme",
     recordId: 12,
-    patch: { textField: "Renamed" }
+    textField: "Renamed"
   });
 });
 
@@ -138,7 +140,7 @@ test("crud routes omit workspaceSlug for non-workspace calls and apply configure
   const createRoute = findRoute(registeredRoutes, "POST", "/api/customers");
   assert.ok(createRoute);
   assert.equal(createRoute.route.surface, "console");
-  assert.equal(createRoute.route.paramsValidator, undefined);
+  assert.equal(createRoute.route.params, undefined);
 
   const calls = [];
   const executeAction = async (payload) => {
@@ -158,7 +160,9 @@ test("crud routes omit workspaceSlug for non-workspace calls and apply configure
   );
 
   assert.deepEqual(calls[0].input, {
-    payload: { textField: "A", dateField: "2026-03-11", numberField: 2 }
+    textField: "A",
+    dateField: "2026-03-11",
+    numberField: 2
   });
 });
 
@@ -195,9 +199,74 @@ test("crud non-workspace record routes validate only recordId params", () => {
   assert.ok(viewRoute);
   assert.ok(updateRoute);
   assert.ok(deleteRoute);
-  assert.equal(viewRoute.route.paramsValidator, recordIdParamsValidator);
-  assert.equal(updateRoute.route.paramsValidator, recordIdParamsValidator);
-  assert.equal(deleteRoute.route.paramsValidator, recordIdParamsValidator);
+  assert.equal(viewRoute.route.params, recordIdParamsValidator);
+  assert.equal(updateRoute.route.params, recordIdParamsValidator);
+  assert.equal(deleteRoute.route.params, recordIdParamsValidator);
+});
+
+test("crud routes register JSON:API transport contracts and delete replies with 204", async () => {
+  const registeredRoutes = [];
+  const router = {
+    register(method, path, route, handler) {
+      registeredRoutes.push({
+        method,
+        path,
+        route,
+        handler
+      });
+    }
+  };
+  const app = {
+    make(token) {
+      if (token !== "jskit.http.router") {
+        throw new Error(`Unexpected token: ${String(token)}`);
+      }
+      return router;
+    }
+  };
+
+  registerWorkspaceRoutes(app, {
+    routeRelativePath: "/customers"
+  });
+
+  const workspaceRouteBase = resolveScopedApiBasePath({
+    routeBase: "/w/:workspaceSlug",
+    relativePath: "/customers",
+    strictParams: false
+  });
+  const listRoute = findRoute(registeredRoutes, "GET", workspaceRouteBase);
+  const viewRoute = findRoute(registeredRoutes, "GET", `${workspaceRouteBase}/:recordId`);
+  const createRoute = findRoute(registeredRoutes, "POST", workspaceRouteBase);
+  const updateRoute = findRoute(registeredRoutes, "PATCH", `${workspaceRouteBase}/:recordId`);
+  const deleteRoute = findRoute(registeredRoutes, "DELETE", `${workspaceRouteBase}/:recordId`);
+
+  assert.ok(listRoute);
+  assert.ok(viewRoute);
+  assert.ok(createRoute);
+  assert.ok(updateRoute);
+  assert.ok(deleteRoute);
+  assert.equal(listRoute.route.transport?.kind, "jsonapi-resource");
+  assert.equal(viewRoute.route.transport?.kind, "jsonapi-resource");
+  assert.equal(createRoute.route.transport?.kind, "jsonapi-resource");
+  assert.equal(updateRoute.route.transport?.kind, "jsonapi-resource");
+  assert.equal(deleteRoute.route.transport?.kind, "jsonapi-resource");
+  assert.ok(listRoute.route.advanced?.fastifySchema?.querystring);
+  assert.ok(viewRoute.route.advanced?.fastifySchema?.querystring);
+  assert.ok(createRoute.route.advanced?.fastifySchema?.body);
+  assert.ok(updateRoute.route.advanced?.fastifySchema?.body);
+
+  const reply = createReplyDouble();
+  await deleteRoute.handler(
+    {
+      input: {
+        params: { workspaceSlug: "acme", recordId: 7 }
+      },
+      executeAction: async () => ({ id: 7 })
+    },
+    reply
+  );
+
+  assert.equal(reply.statusCode, 204);
 });
 
 test("crud routes validate route ownership filter values before registering visibility", () => {

package/test/templateSymbolConsistency.test.js

@@ -7,7 +7,7 @@ function resolveTemplatePath(relativePath) {
   return fileURLToPath(new URL(`../templates/${relativePath}`, import.meta.url));
 }
 
-test("actions template uses resource symbol for view output validator", async () => {
+test("actions template does not emit resource action output validators", async () => {
   const actionsTemplate = await readFile(
     resolveTemplatePath("src/local-package/server/actions.js"),
     "utf8"
@@ -15,11 +15,11 @@ test("actions template uses resource symbol for view output validator", async ()
 
   assert.match(
     actionsTemplate,
-    /outputValidator:\s*resource\.operations\.view\.outputValidator,/
+    /output:\s*null,/
   );
   assert.doesNotMatch(
     actionsTemplate,
-    /\$\{option:namespace\|singular\|camel\}Resource\.operations\.view\.outputValidator/
+    /createJsonApiResourceActionOutputValidator/
   );
 });
 
@@ -38,3 +38,19 @@ test("shared index template re-exports standardized resource symbol", async () =
     /export\s*\{\s*\$\{option:namespace\|singular\|camel\}Resource\s*\}/s
   );
 });
+
+test("shared resource template uses defineCrudResource export", async () => {
+  const sharedResourceTemplate = await readFile(
+    resolveTemplatePath("src/local-package/shared/crudResource.js"),
+    "utf8"
+  );
+
+  assert.match(
+    sharedResourceTemplate,
+    /import\s*\{\s*defineCrudResource\s*\}\s*from\s*"@jskit-ai\/resource-crud-core\/shared\/crudResource";/s
+  );
+  assert.doesNotMatch(
+    sharedResourceTemplate,
+    /from\s*"json-rest-schema";/
+  );
+});

package/test-support/templateServerFixture.js

@@ -64,38 +64,97 @@ function buildTemplateReplacements({
     ["${option:namespace|camel}", CRUD_NAMESPACE.camel],
     ["${option:namespace|singular|camel}", CRUD_NAMESPACE.singularCamel],
     ["${option:namespace|pascal}", CRUD_NAMESPACE.pascal],
+    ["__JSKIT_CRUD_TABLE_NAME__", JSON.stringify("customers")],
     ["__JSKIT_CRUD_ID_COLUMN__", JSON.stringify("id")],
     ["__JSKIT_CRUD_SURFACE_ID__", JSON.stringify(surfaceId)],
     ["__JSKIT_CRUD_ACTION_PERMISSION_SUPPORT__", actionPermissionSupport],
     ["__JSKIT_CRUD_ACTION_WORKSPACE_VALIDATOR_IMPORT__", actionWorkspaceValidatorImport],
+    ["__JSKIT_CRUD_LIST_ACTION_INPUT__", surfaceRequiresWorkspace
+      ? [
+          "composeSchemaDefinitions([",
+          "  workspaceSlugParamsValidator,",
+          "  listCursorPaginationQueryValidator,",
+          "  listSearchQueryValidator,",
+          "  listParentFilterQueryValidator,",
+          "  lookupIncludeQueryValidator,",
+          "])"
+        ].join("\n")
+      : [
+          "composeSchemaDefinitions([",
+          "  listCursorPaginationQueryValidator,",
+          "  listSearchQueryValidator,",
+          "  listParentFilterQueryValidator,",
+          "  lookupIncludeQueryValidator,",
+          "])"
+        ].join("\n")],
+    ["__JSKIT_CRUD_VIEW_ACTION_INPUT__", surfaceRequiresWorkspace
+      ? [
+          "composeSchemaDefinitions([",
+          "  workspaceSlugParamsValidator,",
+          "  recordIdParamsValidator,",
+          "  lookupIncludeQueryValidator,",
+          "])"
+        ].join("\n")
+      : [
+          "composeSchemaDefinitions([",
+          "  recordIdParamsValidator,",
+          "  lookupIncludeQueryValidator,",
+          "])"
+        ].join("\n")],
+    ["__JSKIT_CRUD_CREATE_ACTION_INPUT__", surfaceRequiresWorkspace
+      ? [
+          "composeSchemaDefinitions([",
+          "  workspaceSlugParamsValidator,",
+          "  resource.operations.create.body,",
+          '], {',
+          '  mode: "create"',
+          "})"
+        ].join("\n")
+      : "resource.operations.create.body"],
+    ["__JSKIT_CRUD_UPDATE_ACTION_INPUT__", surfaceRequiresWorkspace
+      ? [
+          "composeSchemaDefinitions([",
+          "  workspaceSlugParamsValidator,",
+          "  recordIdParamsValidator,",
+          "  resource.operations.patch.body,",
+          "])"
+        ].join("\n")
+      : [
+          "composeSchemaDefinitions([",
+          "  recordIdParamsValidator,",
+          "  resource.operations.patch.body,",
+          "])"
+        ].join("\n")],
+    ["__JSKIT_CRUD_DELETE_ACTION_INPUT__", surfaceRequiresWorkspace
+      ? [
+          "composeSchemaDefinitions([",
+          "  workspaceSlugParamsValidator,",
+          "  recordIdParamsValidator,",
+          "])"
+        ].join("\n")
+      : "recordIdParamsValidator"],
     ["__JSKIT_CRUD_LIST_ACTION_PERMISSION__", listActionPermission],
-    ["__JSKIT_CRUD_LIST_ACTION_INPUT_VALIDATOR__", surfaceRequiresWorkspace
-      ? "[workspaceSlugParamsValidator, listCursorPaginationQueryValidator, listSearchQueryValidator, listParentFilterQueryValidator, lookupIncludeQueryValidator]"
-      : "[listCursorPaginationQueryValidator, listSearchQueryValidator, listParentFilterQueryValidator, lookupIncludeQueryValidator]"],
     ["__JSKIT_CRUD_VIEW_ACTION_PERMISSION__", viewActionPermission],
-    ["__JSKIT_CRUD_VIEW_ACTION_INPUT_VALIDATOR__", surfaceRequiresWorkspace
-      ? "[workspaceSlugParamsValidator, recordIdParamsValidator, lookupIncludeQueryValidator]"
-      : "[recordIdParamsValidator, lookupIncludeQueryValidator]"],
     ["__JSKIT_CRUD_CREATE_ACTION_PERMISSION__", createActionPermission],
-    ["__JSKIT_CRUD_CREATE_ACTION_INPUT_VALIDATOR__", surfaceRequiresWorkspace
-      ? '[workspaceSlugParamsValidator, { payload: resource.operations.create.bodyValidator }]'
-      : "{ payload: resource.operations.create.bodyValidator }"],
     ["__JSKIT_CRUD_UPDATE_ACTION_PERMISSION__", updateActionPermission],
-    ["__JSKIT_CRUD_UPDATE_ACTION_INPUT_VALIDATOR__", surfaceRequiresWorkspace
-      ? '[workspaceSlugParamsValidator, recordIdParamsValidator, { patch: resource.operations.patch.bodyValidator }]'
-      : "[recordIdParamsValidator, { patch: resource.operations.patch.bodyValidator }]"],
     ["__JSKIT_CRUD_DELETE_ACTION_PERMISSION__", deleteActionPermission],
-    ["__JSKIT_CRUD_DELETE_ACTION_INPUT_VALIDATOR__", surfaceRequiresWorkspace
-      ? "[workspaceSlugParamsValidator, recordIdParamsValidator]"
-      : "recordIdParamsValidator"],
     ["__JSKIT_CRUD_ROUTE_SURFACE_REQUIRES_WORKSPACE__", String(surfaceRequiresWorkspace === true)],
     ["__JSKIT_CRUD_ROUTE_BASE__", JSON.stringify(surfaceRequiresWorkspace ? "/w/:workspaceSlug" : "/")],
     ["__JSKIT_CRUD_ROUTE_WORKSPACE_SUPPORT_IMPORTS__", routeWorkspaceSupportImports],
-    ["__JSKIT_CRUD_LIST_ROUTE_PARAMS_VALIDATOR_LINE__", surfaceRequiresWorkspace ? "      paramsValidator: routeParamsValidator," : ""],
-    ["__JSKIT_CRUD_VIEW_ROUTE_PARAMS_VALIDATOR_LINE__", surfaceRequiresWorkspace ? "      paramsValidator: [routeParamsValidator, recordIdParamsValidator]," : "      paramsValidator: recordIdParamsValidator,"],
-    ["__JSKIT_CRUD_CREATE_ROUTE_PARAMS_VALIDATOR_LINE__", surfaceRequiresWorkspace ? "      paramsValidator: routeParamsValidator," : ""],
-    ["__JSKIT_CRUD_UPDATE_ROUTE_PARAMS_VALIDATOR_LINE__", surfaceRequiresWorkspace ? "      paramsValidator: [routeParamsValidator, recordIdParamsValidator]," : "      paramsValidator: recordIdParamsValidator,"],
-    ["__JSKIT_CRUD_DELETE_ROUTE_PARAMS_VALIDATOR_LINE__", surfaceRequiresWorkspace ? "      paramsValidator: [routeParamsValidator, recordIdParamsValidator]," : "      paramsValidator: recordIdParamsValidator,"],
+    ["__JSKIT_CRUD_ROUTE_CONTRACTS_RESOURCE_ARGS__", surfaceRequiresWorkspace ? ",\n  routeParamsValidator" : ""],
+    ["__JSKIT_CRUD_ROUTE_VALIDATOR_CONSTANTS__", surfaceRequiresWorkspace
+      ? [
+          "const recordRouteParamsValidator = composeSchemaDefinitions([",
+          "  routeParamsValidator,",
+          "  recordIdParamsValidator",
+          "]);"
+        ].join("\n")
+      : ""],
+    ["__JSKIT_CRUD_LIST_ROUTE_PARAMS_VALIDATOR_LINE__", surfaceRequiresWorkspace ? "      params: routeParamsValidator," : ""],
+    ["__JSKIT_CRUD_VIEW_ROUTE_PARAMS_VALIDATOR_LINE__", "      params: recordRouteParamsValidator,"],
+    ["__JSKIT_CRUD_CREATE_ROUTE_PARAMS_VALIDATOR_LINE__", surfaceRequiresWorkspace ? "      params: routeParamsValidator," : ""],
+    ["__JSKIT_CRUD_UPDATE_ROUTE_PARAMS_VALIDATOR_LINE__", "      params: recordRouteParamsValidator,"],
+    ["__JSKIT_CRUD_DELETE_ROUTE_PARAMS_VALIDATOR_LINE__", "      params: recordRouteParamsValidator,"],
     ["__JSKIT_CRUD_LIST_ROUTE_INPUT_LINES__", surfaceRequiresWorkspace
       ? ["          ...buildWorkspaceInputFromRouteParams(request.input.params),", "          ...(request.input.query || {})"].join("\n")
       : "          ...(request.input.query || {})"],
@@ -112,18 +171,18 @@ function buildTemplateReplacements({
     ["__JSKIT_CRUD_CREATE_ROUTE_INPUT_LINES__", surfaceRequiresWorkspace
       ? [
           "          ...buildWorkspaceInputFromRouteParams(request.input.params),",
-          "          payload: request.input.body"
+          "          ...(request.input.body || {})"
         ].join("\n")
-      : "          payload: request.input.body"],
+      : "          ...(request.input.body || {})"],
     ["__JSKIT_CRUD_UPDATE_ROUTE_INPUT_LINES__", surfaceRequiresWorkspace
       ? [
           "          ...buildWorkspaceInputFromRouteParams(request.input.params),",
           "          recordId: request.input.params.recordId,",
-          "          patch: request.input.body"
+          "          ...(request.input.body || {})"
         ].join("\n")
       : [
           "          recordId: request.input.params.recordId,",
-          "          patch: request.input.body"
+          "          ...(request.input.body || {})"
         ].join("\n")],
     ["__JSKIT_CRUD_DELETE_ROUTE_INPUT_LINES__", surfaceRequiresWorkspace
       ? [
@@ -131,14 +190,41 @@ function buildTemplateReplacements({
           "          recordId: request.input.params.recordId"
         ].join("\n")
       : "          recordId: request.input.params.recordId"],
-    [
-      "__JSKIT_CRUD_LIST_CONFIG_LINES__",
-      [
-        "  // defaultLimit: 20,",
-        "  // maxLimit: 100,",
-        "  // searchColumns: [\"name\"],"
-      ].join("\n")
-    ]
+    ["__JSKIT_CRUD_JSONREST_SCOPE_NAME__", JSON.stringify("customers")],
+    ["__JSKIT_CRUD_RESOURCE_AUTOFILTER__", JSON.stringify(surfaceRequiresWorkspace ? "workspace" : "public")],
+    ["__JSKIT_CRUD_RESOURCE_SEARCH_SCHEMA_LINES__", [
+      '    id: { type: "id", actualField: "id" },',
+      '    q: { type: "string", oneOf: ["name"], filterOperator: "like", splitBy: " ", matchAll: true },'
+    ].join("\n")],
+    ["__JSKIT_CRUD_RESOURCE_DEFAULT_SORT__", '["-createdAt"]'],
+    ["__JSKIT_CRUD_RESOURCE_SCHEMA_PROPERTIES__", [
+      "    name: {",
+      '      type: "string",',
+      "      required: true,",
+      "      search: true,",
+      "      operations: {",
+      '        output: { required: true },',
+      '        create: { required: true },',
+      '        patch: { required: false }',
+      "      }",
+      "    },",
+      "    createdAt: {",
+      '      type: "dateTime",',
+      '      default: "now()",',
+      '      storage: { writeSerializer: "datetime-utc" },',
+      "      operations: {",
+      '        output: { required: true }',
+      "      }",
+      "    },",
+      "    updatedAt: {",
+      '      type: "dateTime",',
+      '      default: "now()",',
+      '      storage: { writeSerializer: "datetime-utc" },',
+      "      operations: {",
+      '        output: { required: true }',
+      "      }",
+      "    },"
+    ].join("\n")]
   ]);
 }
 
@@ -151,93 +237,50 @@ function applyTemplateReplacements(sourceText = "", options = {}) {
 }
 
 function buildResourceStubSource() {
-  return `const recordOutputValidator = Object.freeze({
-  schema: {
-    properties: {
-      id: {},
-      name: {}
-    }
-  },
-  normalize(payload = {}) {
-    return payload;
-  }
-});
+  return `import { defineCrudResource } from "@jskit-ai/resource-crud-core/shared/crudResource";
 
-const createBodyValidator = Object.freeze({
-  schema: {
-    properties: {
-      name: {},
-      contactId: {}
-    }
-  },
-  normalize(payload = {}) {
-    return payload;
-  }
-});
-
-const patchBodyValidator = Object.freeze({
+const resource = defineCrudResource({
+  namespace: "customers",
+  tableName: "customers",
   schema: {
-    properties: {
-      name: {},
-      contactId: {}
+  name: {
+    type: "string",
+    required: true,
+    search: true,
+    operations: {
+      output: { required: true },
+      create: { required: true },
+      patch: { required: false }
     }
   },
-  normalize: createBodyValidator.normalize
-});
-
-const resource = Object.freeze({
-  namespace: "customers",
-  tableName: "customers",
-  idColumn: "id",
-  operations: {
-    list: {
-      outputValidator: Object.freeze({
-        schema: {
-          properties: {
-            items: {},
-            nextCursor: {}
-          }
-        },
-        normalize(payload = {}) {
-          return payload;
-        }
-      })
-    },
-    view: {
-      outputValidator: recordOutputValidator
+  contactId: {
+    type: "id",
+    nullable: true,
+    relation: {
+      kind: "lookup",
+      namespace: "contacts",
+      valueKey: "id"
     },
-    create: {
-      bodyValidator: createBodyValidator,
-      outputValidator: recordOutputValidator
-    },
-    patch: {
-      bodyValidator: patchBodyValidator,
-      outputValidator: recordOutputValidator
-    },
-    delete: {
-      outputValidator: Object.freeze({
-        schema: {
-          properties: {
-            id: {},
-            deleted: {}
-          }
-        },
-        normalize(payload = {}) {
-          return payload;
-        }
-      })
+    operations: {
+      output: { required: true },
+      create: { required: false },
+      patch: { required: false }
     }
+  }
   },
-  fieldMeta: [
-    {
-      key: "contactId",
-      relation: {
-        kind: "lookup",
-        namespace: "contacts",
-        valueKey: "id"
-      }
+  searchSchema: {
+    id: { type: "id", actualField: "id" },
+    q: { type: "string", oneOf: ["name"], filterOperator: "like", splitBy: " ", matchAll: true }
+  },
+  defaultSort: ["-createdAt"],
+  autofilter: "workspace",
+  contract: {
+    lookup: {
+      containerKey: "lookups",
+      defaultInclude: "*",
+      maxDepth: 3
     }
-  ]
+  }
 });
 
 export { resource };
@@ -266,7 +309,7 @@ async function createTemplateServerFixture(options = {}) {
   );
   await writeFile(path.join(sharedRoot, "customerResource.js"), buildResourceStubSource(), "utf8");
 
-  for (const fileName of ["actionIds.js", "actions.js", "listConfig.js", "registerRoutes.js", "repository.js", "service.js"]) {
+  for (const fileName of ["actions.js", "registerRoutes.js", "repository.js", "service.js"]) {
     await renderServerTemplateFile(serverRoot, fileName, options);
   }
 

package/templates/src/local-package/server/actionIds.js

@@ -1,9 +0,0 @@
-const actionIds = Object.freeze({
-  list: "crud.${option:namespace|snake}.list",
-  view: "crud.${option:namespace|snake}.view",
-  create: "crud.${option:namespace|snake}.create",
-  update: "crud.${option:namespace|snake}.update",
-  delete: "crud.${option:namespace|snake}.delete"
-});
-
-export { actionIds };

package/templates/src/local-package/server/listConfig.js

@@ -1,5 +0,0 @@
-const LIST_CONFIG = Object.freeze({
-__JSKIT_CRUD_LIST_CONFIG_LINES__
-});
-
-export { LIST_CONFIG };