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

package/package.descriptor.mjs

@@ -1,7 +1,7 @@
 export default Object.freeze({
   packageVersion: 1,
   packageId: "@jskit-ai/crud-server-generator",
-  version: "0.1.64",
+  version: "0.1.66",
   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.55",
-        "@jskit-ai/crud-core": "0.1.64",
-        "@jskit-ai/database-runtime": "0.1.56",
-        "@jskit-ai/http-runtime": "0.1.55",
-        "@jskit-ai/json-rest-api-core": "0.1.1",
-        "@jskit-ai/kernel": "0.1.56",
-        "@jskit-ai/realtime": "0.1.55",
-        "@jskit-ai/resource-crud-core": "0.1.1",
+        "@jskit-ai/auth-core": "0.1.57",
+        "@jskit-ai/crud-core": "0.1.66",
+        "@jskit-ai/database-runtime": "0.1.58",
+        "@jskit-ai/http-runtime": "0.1.57",
+        "@jskit-ai/json-rest-api-core": "0.1.3",
+        "@jskit-ai/kernel": "0.1.58",
+        "@jskit-ai/realtime": "0.1.57",
+        "@jskit-ai/resource-crud-core": "0.1.3",
         "@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.64",
+  "version": "0.1.66",
   "type": "module",
   "scripts": {
     "test": "node --test"
@@ -13,12 +13,12 @@
   },
   "dependencies": {
     "@babel/parser": "^7.29.2",
-    "@jskit-ai/crud-core": "0.1.64",
-    "@jskit-ai/database-runtime": "0.1.56",
-    "@jskit-ai/http-runtime": "0.1.55",
-    "@jskit-ai/json-rest-api-core": "0.1.1",
-    "@jskit-ai/kernel": "0.1.56",
-    "@jskit-ai/resource-crud-core": "0.1.1",
+    "@jskit-ai/crud-core": "0.1.66",
+    "@jskit-ai/database-runtime": "0.1.58",
+    "@jskit-ai/http-runtime": "0.1.57",
+    "@jskit-ai/json-rest-api-core": "0.1.3",
+    "@jskit-ai/kernel": "0.1.58",
+    "@jskit-ai/resource-crud-core": "0.1.3",
     "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,

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 = \{\}/);