@jskit-ai/crud-server-generator 0.1.65 → 0.1.67

package/package.descriptor.mjs

@@ -1,7 +1,7 @@
 export default Object.freeze({
   packageVersion: 1,
   packageId: "@jskit-ai/crud-server-generator",
-  version: "0.1.65",
+  version: "0.1.67",
   kind: "generator",
   description: "CRUD server generator with routes, actions, and persistence scaffolding.",
   options: {
@@ -152,14 +152,14 @@ export default Object.freeze({
   mutations: {
     dependencies: {
       runtime: {
-        "@jskit-ai/auth-core": "0.1.56",
-        "@jskit-ai/crud-core": "0.1.65",
-        "@jskit-ai/database-runtime": "0.1.57",
-        "@jskit-ai/http-runtime": "0.1.56",
-        "@jskit-ai/json-rest-api-core": "0.1.2",
-        "@jskit-ai/kernel": "0.1.57",
-        "@jskit-ai/realtime": "0.1.56",
-        "@jskit-ai/resource-crud-core": "0.1.2",
+        "@jskit-ai/auth-core": "0.1.58",
+        "@jskit-ai/crud-core": "0.1.67",
+        "@jskit-ai/database-runtime": "0.1.59",
+        "@jskit-ai/http-runtime": "0.1.58",
+        "@jskit-ai/json-rest-api-core": "0.1.4",
+        "@jskit-ai/kernel": "0.1.59",
+        "@jskit-ai/realtime": "0.1.58",
+        "@jskit-ai/resource-crud-core": "0.1.4",
         "@local/${option:namespace|kebab}": "file:packages/${option:namespace|kebab}"
       },
       dev: {}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jskit-ai/crud-server-generator",
-  "version": "0.1.65",
+  "version": "0.1.67",
   "type": "module",
   "scripts": {
     "test": "node --test"
@@ -13,12 +13,12 @@
   },
   "dependencies": {
     "@babel/parser": "^7.29.2",
-    "@jskit-ai/crud-core": "0.1.65",
-    "@jskit-ai/database-runtime": "0.1.57",
-    "@jskit-ai/http-runtime": "0.1.56",
-    "@jskit-ai/json-rest-api-core": "0.1.2",
-    "@jskit-ai/kernel": "0.1.57",
-    "@jskit-ai/resource-crud-core": "0.1.2",
+    "@jskit-ai/crud-core": "0.1.67",
+    "@jskit-ai/database-runtime": "0.1.59",
+    "@jskit-ai/http-runtime": "0.1.58",
+    "@jskit-ai/json-rest-api-core": "0.1.4",
+    "@jskit-ai/kernel": "0.1.59",
+    "@jskit-ai/resource-crud-core": "0.1.4",
     "recast": "^0.23.11"
   }
 }

package/src/server/subcommands/resourceAst.js

@@ -31,6 +31,16 @@ const BABEL_REC_AST_PARSER = Object.freeze({
 });
 
 const IDENTIFIER_PATTERN = /^[A-Za-z_$][A-Za-z0-9_$]*$/;
+const EXPLICIT_CRUD_SCHEMA_OVERRIDE_KEYS = Object.freeze([
+  "body",
+  "output",
+  "listOutput",
+  "listItemOutput",
+  "createBody",
+  "replaceBody",
+  "patchBody",
+  "deleteOutput"
+]);
 
 function isIdentifierName(value = "") {
   return IDENTIFIER_PATTERN.test(String(value || ""));
@@ -138,6 +148,7 @@ function requireCrudResourceConfigObject(programNode, context = "crud-server-gen
 
 function requireResourceSchemaObject(programNode, context = "crud-server-generator scaffold-field") {
   const resourceObject = requireCrudResourceConfigObject(programNode, context);
+  assertNoExplicitCrudSchemaOverrides(resourceObject, context);
   const schemaProperty = findObjectPropertyByName(resourceObject, "schema");
   if (!schemaProperty || !n.ObjectExpression.check(schemaProperty.value)) {
     throw new Error(
@@ -148,6 +159,30 @@ function requireResourceSchemaObject(programNode, context = "crud-server-generat
   return schemaProperty.value;
 }
 
+function assertNoExplicitCrudSchemaOverrides(resourceObject, context = "crud-server-generator scaffold-field") {
+  const crudProperty = findObjectPropertyByName(resourceObject, "crud");
+  if (!crudProperty) {
+    return;
+  }
+
+  if (!n.ObjectExpression.check(crudProperty.value)) {
+    throw new Error(
+      `${context} cannot patch defineCrudResource({ ..., crud: ... }) unless crud is omitted or authored as an inline object literal without explicit schema overrides.`
+    );
+  }
+
+  const overrideKeys = EXPLICIT_CRUD_SCHEMA_OVERRIDE_KEYS.filter((propertyName) =>
+    hasObjectProperty(crudProperty.value, propertyName)
+  );
+  if (overrideKeys.length === 0) {
+    return;
+  }
+
+  throw new Error(
+    `${context} cannot patch defineCrudResource({ ..., crud: { ... } }) when explicit crud schema overrides are authored (${overrideKeys.join(", ")}). Update schema and override validators manually.`
+  );
+}
+
 function findObjectPropertyByName(objectNode, propertyName = "") {
   const targetName = normalizeText(propertyName);
   if (!targetName || !n.ObjectExpression.check(objectNode)) {

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

@@ -6,7 +6,7 @@ import {
   returnNullWhenJsonRestResourceMissing
 } from "@jskit-ai/json-rest-api-core/server/jsonRestApiHost";
 import { resource } from "../shared/${option:namespace|singular|camel}Resource.js";
-const RESOURCE_TYPE = resource.namespace;
+const JSON_REST_SCOPE_NAME = __JSKIT_CRUD_JSONREST_SCOPE_NAME__;
 
 function createRepository({ api, knex } = {}) {
   const withTransaction = createWithTransaction(knex);
@@ -14,7 +14,7 @@ function createRepository({ api, knex } = {}) {
   async function queryDocuments(query = {}, options = {}) {
     return api.resources.${option:namespace|camel}.query(
       {
-        queryParams: buildJsonRestQueryParams(RESOURCE_TYPE, query),
+        queryParams: buildJsonRestQueryParams(JSON_REST_SCOPE_NAME, query),
         transaction: options?.trx || null,
         simplified: false
       },
@@ -27,7 +27,7 @@ function createRepository({ api, knex } = {}) {
       api.resources.${option:namespace|camel}.get(
         {
           id: recordId,
-          queryParams: buildJsonRestQueryParams(RESOURCE_TYPE, {}, {
+          queryParams: buildJsonRestQueryParams(JSON_REST_SCOPE_NAME, {}, {
             include: options?.include
           }),
           transaction: options?.trx || null,
@@ -41,7 +41,9 @@ function createRepository({ api, knex } = {}) {
   async function createDocument(payload = {}, options = {}) {
     return api.resources.${option:namespace|camel}.post(
       {
-        inputRecord: createJsonApiInputRecord(RESOURCE_TYPE, payload),
+        inputRecord: createJsonApiInputRecord(JSON_REST_SCOPE_NAME, payload, {
+          resource
+        }),
         transaction: options?.trx || null,
         simplified: false
       },
@@ -60,10 +62,13 @@ function createRepository({ api, knex } = {}) {
         {
           id: recordId,
           inputRecord: createJsonApiInputRecord(
-            RESOURCE_TYPE,
+            JSON_REST_SCOPE_NAME,
             {
               ...sourcePatch,
               updatedAt: new Date()
+            },
+            {
+              resource
             }
           ),
           transaction: options?.trx || null,
@@ -85,7 +90,7 @@ function createRepository({ api, knex } = {}) {
         createJsonRestContext(options?.context || null)
       );
 
-      return true;
+      return null;
     });
   }
 

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

@@ -43,11 +43,10 @@ function createService({ ${option:namespace|camel}Repository } = {}) {
   }
 
   async function deleteDocumentById(recordId, options = {}) {
-    return404IfNotFound(await ${option:namespace|camel}Repository.deleteDocumentById(recordId, {
+    return ${option:namespace|camel}Repository.deleteDocumentById(recordId, {
       trx: options?.trx || null,
       context: options?.context || null
-    }));
-    return null;
+    });
   }
 
   return Object.freeze({

package/test/addFieldSubcommand.test.js

@@ -78,6 +78,38 @@ const resource = defineCrudResource({
 export { resource };
 `;
 
+const EXPLICIT_CRUD_OVERRIDE_RESOURCE_SOURCE = `import { createSchema } from "json-rest-schema";
+import { defineCrudResource } from "@jskit-ai/resource-crud-core/shared/crudResource";
+
+const recordOutputSchema = createSchema({
+  id: {
+    type: "string",
+    required: true
+  }
+});
+
+const resource = defineCrudResource({
+  namespace: "contacts",
+  tableName: "contacts",
+  schema: {
+    firstName: {
+      type: "string",
+      required: true,
+      operations: {
+        output: { required: true },
+        create: { required: true },
+        patch: { required: false }
+      }
+    }
+  },
+  crud: {
+    output: recordOutputSchema
+  }
+});
+
+export { resource };
+`;
+
 async function withTempApp(run) {
   const appRoot = await mkdtemp(path.join(tmpdir(), "crud-server-scaffold-field-"));
   try {
@@ -194,3 +226,21 @@ test("scaffold-field rejects resource modules without an inline schema object li
     );
   });
 });
+
+test("scaffold-field rejects defineCrudResource modules with explicit crud schema overrides", async () => {
+  await withTempApp(async (appRoot) => {
+    const resourceFile = "packages/contacts/src/shared/contactResource.js";
+    await writeAppFile(appRoot, resourceFile, EXPLICIT_CRUD_OVERRIDE_RESOURCE_SOURCE);
+
+    await assert.rejects(
+      () => runGeneratorSubcommand({
+        appRoot,
+        subcommand: "scaffold-field",
+        args: ["categoryId", resourceFile],
+        options: {},
+        resolveSnapshot: async () => createSnapshot()
+      }),
+      /cannot patch defineCrudResource\(\{ \.\.\., crud: \{ \.\.\. \} \}\) when explicit crud schema overrides are authored \(output\)\. Update schema and override validators manually\./
+    );
+  });
+});

package/test/buildTemplateContext.test.js

@@ -958,6 +958,7 @@ test("crud repository template defines a json-rest-api adapter over the injected
   const templatePath = path.resolve(testDirectory, "..", "templates", "src", "local-package", "server", "repository.js");
   const templateSource = await readFile(templatePath, "utf8");
   assert.doesNotMatch(templateSource, /from "@jskit-ai\/http-runtime\/shared";/);
+  assert.match(templateSource, /const JSON_REST_SCOPE_NAME = __JSKIT_CRUD_JSONREST_SCOPE_NAME__;/);
   assert.match(templateSource, /returnNullWhenJsonRestResourceMissing/);
   assert.match(templateSource, /return api\.resources\.\$\{option:namespace\|camel\}\.query\(/);
   assert.match(templateSource, /return returnNullWhenJsonRestResourceMissing\(\(\) =>\s+api\.resources\.\$\{option:namespace\|camel\}\.get\(/s);
@@ -965,8 +966,8 @@ test("crud repository template defines a json-rest-api adapter over the injected
   assert.match(templateSource, /return returnNullWhenJsonRestResourceMissing\(\(\) =>\s+api\.resources\.\$\{option:namespace\|camel\}\.patch\(/s);
   assert.match(templateSource, /return returnNullWhenJsonRestResourceMissing\(async \(\) => \{\s+await api\.resources\.\$\{option:namespace\|camel\}\.delete\(/s);
   assert.match(templateSource, /createJsonRestContext\(options\?\.context \|\| null\)/);
-  assert.match(templateSource, /buildJsonRestQueryParams\(RESOURCE_TYPE, query\)/);
-  assert.match(templateSource, /createJsonApiInputRecord\(RESOURCE_TYPE, payload\)/);
+  assert.match(templateSource, /buildJsonRestQueryParams\(JSON_REST_SCOPE_NAME, query\)/);
+  assert.match(templateSource, /createJsonApiInputRecord\(JSON_REST_SCOPE_NAME, payload/);
   assert.doesNotMatch(templateSource, /function toJsonRestContext\(context = null\)/);
   assert.doesNotMatch(templateSource, /function normalizeArrayInput\(value\)/);
   assert.doesNotMatch(templateSource, /function buildJsonRestQueryParams\(query = \{\}/);
@@ -1039,6 +1040,9 @@ test("crud service template preserves JSON:API output and emits entity ids from
   assert.match(templateSource, /returnJsonApiDocument\(await \$\{option:namespace\|camel\}Repository\.queryDocuments\(query, \{/);
   assert.match(templateSource, /async function patchDocumentById\(recordId, payload = \{\}, options = \{\}\)/);
   assert.match(templateSource, /returnJsonApiDocument\(return404IfNotFound\(await \$\{option:namespace\|camel\}Repository\.patchDocumentById\(recordId, payload, \{/);
+  assert.match(templateSource, /async function deleteDocumentById\(recordId, options = \{\}\)/);
+  assert.match(templateSource, /return \$\{option:namespace\|camel\}Repository\.deleteDocumentById\(recordId, \{/);
+  assert.doesNotMatch(templateSource, /return404IfNotFound\(await \$\{option:namespace\|camel\}Repository\.deleteDocumentById/);
   assert.match(templateSource, /return Object\.freeze\(\{/);
   assert.match(templateSource, /export \{ createService \};/);
 });

package/test/crudServerGuards.test.js

@@ -117,6 +117,50 @@ test("template createRepository builds mutable JSON:API input documents for writ
   });
 });
 
+test("template createRepository returns null for successful deletes", async () => {
+  const calls = [];
+  const api = {
+    resources: {
+      customers: {
+        async delete(params, context) {
+          calls.push({ params, context });
+        }
+      }
+    }
+  };
+  const knex = {
+    async transaction(work) {
+      return work("trx");
+    }
+  };
+
+  const repository = createRepository({ api, knex });
+  const result = await repository.deleteDocumentById("7", {
+    trx: "trx-1",
+    context: {
+      visibilityContext: {
+        visibility: "workspace",
+        scopeOwnerId: "7"
+      }
+    }
+  });
+
+  assert.equal(result, null);
+  assert.deepEqual(calls[0], {
+    params: {
+      id: "7",
+      transaction: "trx-1",
+      simplified: false
+    },
+    context: {
+      visibilityContext: {
+        visibility: "workspace",
+        scopeOwnerId: "7"
+      }
+    }
+  });
+});
+
 test("template createService turns missing resource records into 404 errors", async () => {
   const service = createService({
     customersRepository: {
@@ -139,6 +183,45 @@ test("template createService turns missing resource records into 404 errors", as
   );
 });
 
+test("template createService returns delete results unchanged", async () => {
+  const service = createService({
+    customersRepository: {
+      async deleteDocumentById(recordId, options) {
+        return {
+          recordId,
+          options,
+          deleted: true
+        };
+      }
+    }
+  });
+
+  assert.deepEqual(
+    await service.deleteDocumentById("7", {
+      trx: "trx-1",
+      context: {
+        visibilityContext: {
+          visibility: "workspace",
+          scopeOwnerId: "7"
+        }
+      }
+    }),
+    {
+      recordId: "7",
+      options: {
+        trx: "trx-1",
+        context: {
+          visibilityContext: {
+            visibility: "workspace",
+            scopeOwnerId: "7"
+          }
+        }
+      },
+      deleted: true
+    }
+  );
+});
+
 test("template createActions requires namespaced CRUD permissions by default", () => {
   const actions = createActions({ surface: "admin" });
 

package/test/crudService.test.js

@@ -30,7 +30,7 @@ test("crudService exposes the explicit JSON:API CRUD service contract", async ()
     },
     async deleteDocumentById(recordId, options) {
       calls.push(["deleteDocumentById", recordId, options]);
-      return true;
+      return null;
     }
   };
 
@@ -131,9 +131,42 @@ test("crudService throws 404 when a document is missing", async () => {
     () => service.patchDocumentById(9, { textField: "Changed" }, {}),
     (error) => error?.status === 404 && error?.message === "Document not found."
   );
+});
 
-  await assert.rejects(
-    () => service.deleteDocumentById(9, {}),
-    (error) => error?.status === 404 && error?.message === "Document not found."
-  );
+test("crudService returns delete results unchanged", async () => {
+  const service = createService({
+    customersRepository: {
+      async deleteDocumentById(recordId, options) {
+        return {
+          recordId,
+          options,
+          deleted: true
+        };
+      }
+    }
+  });
+
+  const result = await service.deleteDocumentById(9, {
+    trx: "trx-1",
+    context: {
+      visibilityContext: {
+        visibility: "workspace",
+        scopeOwnerId: "7"
+      }
+    }
+  });
+
+  assert.deepEqual(result, {
+    recordId: 9,
+    options: {
+      trx: "trx-1",
+      context: {
+        visibilityContext: {
+          visibility: "workspace",
+          scopeOwnerId: "7"
+        }
+      }
+    },
+    deleted: true
+  });
 });