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

package/test/addFieldSubcommand.test.js

@@ -5,82 +5,75 @@ import { mkdtemp, mkdir, readFile, rm, writeFile } from "node:fs/promises";
 import { tmpdir } from "node:os";
 import { runGeneratorSubcommand } from "../src/server/subcommands/addField.js";
 
-const RESOURCE_SOURCE = `import { Type } from "typebox";
-import { normalizeObjectInput, createCursorListValidator } from "@jskit-ai/kernel/shared/validators";
-import { normalizeText, normalizeIfInSource, normalizeIfPresent, normalizeOrNull } from "@jskit-ai/kernel/shared/support/normalize";
+const RESOURCE_SOURCE = `import { defineCrudResource } from "@jskit-ai/resource-crud-core/shared/crudResource";
 
-const RESOURCE_LOOKUP_CONTAINER_KEY = "lookups";
-
-const recordOutputSchema = Type.Object(
-  {
-    id: Type.Integer({ minimum: 1 }),
-    firstName: Type.Union([Type.String(), Type.Null()]),
-    [RESOURCE_LOOKUP_CONTAINER_KEY]: Type.Optional(Type.Record(Type.String(), Type.Unknown()))
-  },
-  { additionalProperties: false }
-);
-
-const createBodySchema = Type.Object(
-  {
-    firstName: Type.Union([Type.String({ maxLength: 160 }), Type.Null()])
+const resource = defineCrudResource({
+  namespace: "contacts",
+  tableName: "contacts",
+  schema: {
+    firstName: {
+      type: "string",
+      nullable: true,
+      maxLength: 160,
+      operations: {
+        output: { required: true },
+        create: { required: false },
+        patch: { required: false }
+      }
+    }
   },
-  {
-    additionalProperties: false,
-    required: []
-  }
-);
-
-const patchBodySchema = Type.Partial(createBodySchema, { additionalProperties: false });
-
-const recordOutputValidator = Object.freeze({
-  schema: recordOutputSchema,
-  normalize(payload = {}) {
-    const source = normalizeObjectInput(payload);
-    const normalized = {
-      id: normalizeIfPresent(source.id, Number),
-      firstName: normalizeOrNull(source.firstName, normalizeText)
-    };
-    const sourceLookupContainer = source[RESOURCE_LOOKUP_CONTAINER_KEY];
-    if (sourceLookupContainer && typeof sourceLookupContainer === "object" && !Array.isArray(sourceLookupContainer)) {
-      normalized[RESOURCE_LOOKUP_CONTAINER_KEY] = sourceLookupContainer;
+  contract: {
+    lookup: {
+      containerKey: "lookups"
     }
-    return normalized;
   }
 });
 
-const listOutputValidator = createCursorListValidator(recordOutputValidator);
-
-const createBodyValidator = Object.freeze({
-  schema: createBodySchema,
-  normalize(payload = {}) {
-    const source = normalizeObjectInput(payload);
-    const normalized = {};
+export { resource };
+`;
 
-    normalizeIfInSource(source, normalized, "firstName", normalizeText);
+const NON_INLINE_RESOURCE_SOURCE = `import { defineCrudResource } from "@jskit-ai/resource-crud-core/shared/crudResource";
 
-    return normalized;
+const resourceConfig = {
+  namespace: "contacts",
+  tableName: "contacts",
+  schema: {
+    firstName: {
+      type: "string",
+      required: true,
+      operations: {
+        output: { required: true },
+        create: { required: true },
+        patch: { required: false }
+      }
+    }
   }
-});
+};
 
-const patchBodyValidator = Object.freeze({
-  schema: patchBodySchema,
-  normalize: createBodyValidator.normalize
-});
+const resource = defineCrudResource(resourceConfig);
+
+export { resource };
+`;
 
-const RESOURCE_FIELD_META = [];
+const NON_INLINE_SCHEMA_RESOURCE_SOURCE = `import { defineCrudResource } from "@jskit-ai/resource-crud-core/shared/crudResource";
 
-const resource = {
+const schemaFields = {
+  firstName: {
+    type: "string",
+    required: true,
+    operations: {
+      output: { required: true },
+      create: { required: true },
+      patch: { required: false }
+    }
+  }
+};
+
+const resource = defineCrudResource({
   namespace: "contacts",
   tableName: "contacts",
-  idColumn: "id",
-  operations: {
-    list: { method: "GET", outputValidator: listOutputValidator },
-    view: { method: "GET", outputValidator: recordOutputValidator },
-    create: { method: "POST", bodyValidator: createBodyValidator, outputValidator: recordOutputValidator },
-    patch: { method: "PATCH", bodyValidator: patchBodyValidator, outputValidator: recordOutputValidator }
-  },
-  fieldMeta: RESOURCE_FIELD_META
-};
+  schema: schemaFields
+});
 
 export { resource };
 `;
@@ -145,21 +138,15 @@ test("scaffold-field patches CRUD resource file using DB snapshot metadata", asy
     assert.deepEqual(result.touchedFiles, [resourceFile]);
 
     const content = await readFile(path.join(appRoot, resourceFile), "utf8");
-    assert.match(content, /categoryId: nullableRecordIdSchema/);
-    assert.match(
-      content,
-      /normalizeIfInSource\(source, normalized, "categoryId", \(value\) => normalizeRecordId\(value, \{ fallback: null \}\)\);/
-    );
-    assert.match(
-      content,
-      /categoryId: normalizeOrNull\(source\.categoryId, \(value\) => normalizeRecordId\(value, \{ fallback: null \}\)\)/
-    );
-    assert.match(content, /RESOURCE_FIELD_META\.push\(\{/);
-    assert.match(content, /key: "categoryId"/);
-    assert.match(content, /namespace: "customer-categories"/);
-    assert.match(content, /valueKey: "id"/);
-    assert.match(content, /formControl: "autocomplete" \/\/ or "select"/);
-    assert.match(content, /normalizeRecordId/);
+    assert.match(content, /categoryId: \{/);
+    assert.match(content, /type: "id"/);
+    assert.match(content, /nullable: true/);
+    assert.match(content, /operations: \{/);
+    assert.match(content, /create: \{ required: false \}/);
+    assert.match(content, /patch: \{ required: false \}/);
+    assert.match(content, /relation: \{ kind: "lookup", namespace: "customer-categories", valueKey: "id" \}/);
+    assert.match(content, /ui: \{ formControl: "autocomplete" \}/);
+    assert.doesNotMatch(content, /normalizeIfInSource|normalizeIfPresent|normalizeOrNull|normalizeRecordId/);
 
     const secondRun = await runGeneratorSubcommand({
       appRoot,
@@ -171,3 +158,39 @@ test("scaffold-field patches CRUD resource file using DB snapshot metadata", asy
     assert.deepEqual(secondRun.touchedFiles, []);
   });
 });
+
+test("scaffold-field rejects resource modules that do not inline the defineCrudResource config object", async () => {
+  await withTempApp(async (appRoot) => {
+    const resourceFile = "packages/contacts/src/shared/contactResource.js";
+    await writeAppFile(appRoot, resourceFile, NON_INLINE_RESOURCE_SOURCE);
+
+    await assert.rejects(
+      () => runGeneratorSubcommand({
+        appRoot,
+        subcommand: "scaffold-field",
+        args: ["categoryId", resourceFile],
+        options: {},
+        resolveSnapshot: async () => createSnapshot()
+      }),
+      /requires defineCrudResource\(\.\.\.\) to receive an inline object literal\./
+    );
+  });
+});
+
+test("scaffold-field rejects resource modules without an inline schema object literal", async () => {
+  await withTempApp(async (appRoot) => {
+    const resourceFile = "packages/contacts/src/shared/contactResource.js";
+    await writeAppFile(appRoot, resourceFile, NON_INLINE_SCHEMA_RESOURCE_SOURCE);
+
+    await assert.rejects(
+      () => runGeneratorSubcommand({
+        appRoot,
+        subcommand: "scaffold-field",
+        args: ["categoryId", resourceFile],
+        options: {},
+        resolveSnapshot: async () => createSnapshot()
+      }),
+      /requires defineCrudResource\(\{ \.\.\., schema: \{ \.\.\. \} \}\) with an inline schema object literal\./
+    );
+  });
+});