@jskit-ai/crud-ui-generator 0.1.41 → 0.1.42

package/package.descriptor.mjs

@@ -1,7 +1,7 @@
 export default Object.freeze({
   packageVersion: 1,
   packageId: "@jskit-ai/crud-ui-generator",
-  version: "0.1.41",
+  version: "0.1.42",
   kind: "generator",
   description: "Generate CRUD route trees from resource validators at an explicit route root relative to src/pages/.",
   options: {
@@ -43,6 +43,15 @@ export default Object.freeze({
       promptLabel: "Route id param",
       promptHint: "Route param used by view and edit pages (default: recordId)."
     },
+    "parent-title": {
+      required: false,
+      inputType: "text",
+      defaultValue: "contextual",
+      validationType: "enum",
+      allowedValues: ["contextual", "none"],
+      promptLabel: "Parent title mode",
+      promptHint: "Whether list pages should show a parent-aware heading: contextual | none."
+    },
     force: {
       required: false,
       inputType: "flag",
@@ -108,6 +117,7 @@ export default Object.freeze({
           "operations",
           "display-fields",
           "id-param",
+          "parent-title",
           "link-placement",
           "link-component-token",
           "namespace",
@@ -130,7 +140,8 @@ export default Object.freeze({
             lines: [
               "npx jskit generate crud-ui-generator crud \\",
               "  admin/catalog/index/products \\",
-              "  --resource-file packages/products/src/shared/productResource.js"
+              "  --resource-file packages/products/src/shared/productResource.js \\",
+              "  --parent-title contextual"
             ]
           },
           {
@@ -141,6 +152,7 @@ export default Object.freeze({
               "  --resource-file packages/pets/src/shared/petResource.js \\",
               "  --id-param petId \\",
               "  --display-fields name,breedId,sex \\",
+              "  --parent-title none \\",
               "  --force"
             ]
           }
@@ -168,7 +180,7 @@ export default Object.freeze({
   mutations: {
     dependencies: {
       runtime: {
-        "@jskit-ai/users-web": "0.1.73"
+        "@jskit-ai/users-web": "0.1.74"
       },
       dev: {}
     },

package/package.json

@@ -1,14 +1,14 @@
 {
   "name": "@jskit-ai/crud-ui-generator",
-  "version": "0.1.41",
+  "version": "0.1.42",
   "type": "module",
   "scripts": {
     "test": "node --test"
   },
   "dependencies": {
-    "@jskit-ai/crud-core": "0.1.66",
-    "@jskit-ai/kernel": "0.1.58",
-    "@jskit-ai/resource-crud-core": "0.1.3"
+    "@jskit-ai/crud-core": "0.1.67",
+    "@jskit-ai/kernel": "0.1.59",
+    "@jskit-ai/resource-crud-core": "0.1.4"
   },
   "exports": {
     "./server/buildTemplateContext": "./src/server/buildTemplateContext.js"

package/src/server/buildTemplateContext.js

@@ -32,6 +32,7 @@ import {
 import descriptor from "../../package.descriptor.mjs";
 
 const DEFAULT_ALLOWED_OPERATIONS = Object.freeze(["list", "view", "new", "edit"]);
+const DEFAULT_ALLOWED_PARENT_TITLE_VALUES = Object.freeze(["contextual", "none"]);
 function resolveAllowedValues(schema = {}, fallbackValues = []) {
   const resolvedValues = [];
   const seen = new Set();
@@ -56,6 +57,14 @@ function resolveAllowedValues(schema = {}, fallbackValues = []) {
 const OPERATION_VALUES = resolveAllowedValues(descriptor?.options?.operations, DEFAULT_ALLOWED_OPERATIONS);
 const ALLOWED_OPERATIONS = new Set(OPERATION_VALUES);
 const DEFAULT_OPERATIONS = normalizeText(descriptor?.options?.operations?.defaultValue) || OPERATION_VALUES.join(",");
+const PARENT_TITLE_VALUES = resolveAllowedValues(
+  descriptor?.options?.["parent-title"],
+  DEFAULT_ALLOWED_PARENT_TITLE_VALUES
+);
+const ALLOWED_PARENT_TITLE_VALUES = new Set(PARENT_TITLE_VALUES);
+const DEFAULT_PARENT_TITLE_MODE = normalizeText(descriptor?.options?.["parent-title"]?.defaultValue).toLowerCase()
+  || PARENT_TITLE_VALUES[0]
+  || "contextual";
 const DEFAULT_LIST_HIDDEN_FIELD_KEYS = new Set(["createdAt", "updatedAt"]);
 const DEFAULT_FORM_COMPONENT_FILE = "CrudAddEditForm.vue";
 const DEFAULT_FORM_FIELDS_FILE = "CrudAddEditFormFields.js";
@@ -222,6 +231,17 @@ function parseDisplayFieldsOption(options) {
   return Object.freeze(unique);
 }
 
+function parseParentTitleOption(options) {
+  const parentTitleMode = normalizeText(options?.["parent-title"]).toLowerCase() || DEFAULT_PARENT_TITLE_MODE;
+  if (!ALLOWED_PARENT_TITLE_VALUES.has(parentTitleMode)) {
+    throw new Error(
+      `crud-ui-generator option "parent-title" supports only: ${PARENT_TITLE_VALUES.join(", ")}.`
+    );
+  }
+
+  return parentTitleMode;
+}
+
 function validateDisplayFieldsForOperation(selectedFieldKeys, fields, operationName) {
   const selectedFields = Array.isArray(selectedFieldKeys) ? selectedFieldKeys : [];
   if (selectedFields.length < 1) {
@@ -461,11 +481,52 @@ function resolveCrudRelativePath(namespace = "") {
   })}`;
 }
 
+function buildListParentTitleImportLine(parentTitleMode = "contextual") {
+  if (parentTitleMode !== "contextual") {
+    return "";
+  }
+
+  return 'import { useCrudListParentTitle } from "@jskit-ai/users-web/client/composables/useCrudListParentTitle";';
+}
+
+function buildListHeadingTitleSetup({
+  parentTitleMode = "contextual",
+  resourceNamespace = "",
+  routeTitle = "Records"
+} = {}) {
+  const normalizedRouteTitle = normalizeText(routeTitle) || "Records";
+  const routeTitleLiteral = JSON.stringify(normalizedRouteTitle);
+  if (parentTitleMode !== "contextual") {
+    return `const listHeadingTitle = computed(() => ${routeTitleLiteral});`;
+  }
+
+  return `const parentTitle = useCrudListParentTitle({
+  listRuntime: records,
+  resource: uiResource,
+  adapter: UI_OPERATION_ADAPTER || undefined,
+  recordIdParam: UI_RECORD_ID_PARAM,
+  queryKeyPrefix: ["ui-generator", "${resourceNamespace}", "list", "parent-title"],
+  placementSource: "ui-generator.${resourceNamespace}.list.parent-title",
+  fallbackLoadError: "Unable to load parent record.",
+  notFoundMessage: "Parent record not found."
+});
+
+const listHeadingTitle = computed(() => {
+  const resolvedParentTitle = String(parentTitle.title || "").trim();
+  if (!resolvedParentTitle) {
+    return ${routeTitleLiteral};
+  }
+
+  return ${JSON.stringify(`${normalizedRouteTitle} for `)} + resolvedParentTitle;
+});`;
+}
+
 async function buildUiTemplateContext({ appRoot, options } = {}) {
   const targetRoot = requireTargetRootOption(options);
   const listTargetFile = resolveListTargetFile(targetRoot);
   const selectedOperations = parseOperationsOption(options);
   const selectedDisplayFields = parseDisplayFieldsOption(options);
+  const parentTitleMode = parseParentTitleOption(options);
   const pageTarget = await resolvePageTargetDetails({
     appRoot,
     targetFile: listTargetFile,
@@ -607,6 +668,13 @@ async function buildUiTemplateContext({ appRoot, options } = {}) {
     __JSKIT_UI_RESOURCE_SINGULAR_TITLE__: resourceLabels.singularTitle,
     __JSKIT_UI_RESOURCE_PLURAL_TITLE__: resourceLabels.pluralTitle,
     __JSKIT_UI_ROUTE_TITLE__: pageTarget.defaultName,
+    __JSKIT_UI_PARENT_TITLE_MODE__: parentTitleMode,
+    __JSKIT_UI_LIST_PARENT_TITLE_IMPORT_LINE__: buildListParentTitleImportLine(parentTitleMode),
+    __JSKIT_UI_LIST_HEADING_TITLE_SETUP__: buildListHeadingTitleSetup({
+      parentTitleMode,
+      resourceNamespace,
+      routeTitle: pageTarget.defaultName
+    }),
     __JSKIT_UI_FORM_COMPONENT_FILE__: DEFAULT_FORM_COMPONENT_FILE,
     __JSKIT_UI_FORM_FIELDS_FILE__: DEFAULT_FORM_FIELDS_FILE,
     __JSKIT_UI_SURFACE_ID__: pageTarget.surfaceId,

package/templates/src/pages/admin/ui-generator/ListElement.vue

@@ -89,7 +89,7 @@ __JSKIT_UI_LIST_ROW_COLUMNS__
 
 <script setup>
 import { computed } from "vue";
-import { useCrudListParentTitle } from "@jskit-ai/users-web/client/composables/useCrudListParentTitle";
+__JSKIT_UI_LIST_PARENT_TITLE_IMPORT_LINE__
 import { useCrudList } from "@jskit-ai/users-web/client/composables/useCrudList";
 import { resource as uiResource } from "__JSKIT_UI_RESOURCE_IMPORT_PATH__";
 
@@ -137,25 +137,7 @@ const records = useCrudList({
     : null
 });
 
-const parentTitle = useCrudListParentTitle({
-  listRuntime: records,
-  resource: uiResource,
-  adapter: UI_OPERATION_ADAPTER || undefined,
-  recordIdParam: UI_RECORD_ID_PARAM,
-  queryKeyPrefix: ["ui-generator", "__JSKIT_UI_RESOURCE_NAMESPACE__", "list", "parent-title"],
-  placementSource: "ui-generator.__JSKIT_UI_RESOURCE_NAMESPACE__.list.parent-title",
-  fallbackLoadError: "Unable to load parent record.",
-  notFoundMessage: "Parent record not found."
-});
-
-const listHeadingTitle = computed(() => {
-  const resolvedParentTitle = String(parentTitle.title || "").trim();
-  if (!resolvedParentTitle) {
-    return "__JSKIT_UI_ROUTE_TITLE__";
-  }
-
-  return `__JSKIT_UI_ROUTE_TITLE__ for ${resolvedParentTitle}`;
-});
+__JSKIT_UI_LIST_HEADING_TITLE_SETUP__
 </script>
 
 <style scoped>

package/test/buildTemplateContext.test.js

@@ -320,6 +320,9 @@ test("buildUiTemplateContext derives CRUD placeholders from the explicit target-
     assert.equal(context.__JSKIT_UI_RESOURCE_SINGULAR_TITLE__, "Customer");
     assert.equal(context.__JSKIT_UI_RESOURCE_PLURAL_TITLE__, "Customers");
     assert.equal(context.__JSKIT_UI_ROUTE_TITLE__, "Customers");
+    assert.equal(context.__JSKIT_UI_PARENT_TITLE_MODE__, "contextual");
+    assert.match(context.__JSKIT_UI_LIST_PARENT_TITLE_IMPORT_LINE__, /useCrudListParentTitle/);
+    assert.match(context.__JSKIT_UI_LIST_HEADING_TITLE_SETUP__, /Customers for /);
     assert.equal(context.__JSKIT_UI_FORM_COMPONENT_FILE__, "CrudAddEditForm.vue");
     assert.equal(context.__JSKIT_UI_FORM_FIELDS_FILE__, "CrudAddEditFormFields.js");
     assert.equal(context.__JSKIT_UI_SURFACE_ID__, "admin");
@@ -350,6 +353,24 @@ test("buildUiTemplateContext derives CRUD placeholders from the explicit target-
   });
 });
 
+test("buildUiTemplateContext can suppress parent-title heading generation with parent-title none", async () => {
+  await withTempApp(async (appRoot) => {
+    await writeResource(appRoot, RESOURCE_FILE, FULL_RESOURCE_SOURCE);
+
+    const context = await buildUiTemplateContext({
+      appRoot,
+      options: createOptions({
+        "parent-title": "none"
+      })
+    });
+
+    assert.equal(context.__JSKIT_UI_PARENT_TITLE_MODE__, "none");
+    assert.equal(context.__JSKIT_UI_LIST_PARENT_TITLE_IMPORT_LINE__, "");
+    assert.doesNotMatch(context.__JSKIT_UI_LIST_HEADING_TITLE_SETUP__, /useCrudListParentTitle/);
+    assert.match(context.__JSKIT_UI_LIST_HEADING_TITLE_SETUP__, /computed\(\(\) => "Customers"\)/);
+  });
+});
+
 test("buildUiTemplateContext keeps non-nullable booleans as switches", async () => {
   await withTempApp(async (appRoot) => {
     await writeResource(appRoot, RESOURCE_FILE, FULL_RESOURCE_SOURCE);
@@ -715,6 +736,23 @@ test("buildUiTemplateContext validates operations against the supported CRUD set
   });
 });
 
+test("buildUiTemplateContext validates parent-title against the supported modes", async () => {
+  await withTempApp(async (appRoot) => {
+    await writeResource(appRoot, RESOURCE_FILE, FULL_RESOURCE_SOURCE);
+
+    await assert.rejects(
+      () =>
+        buildUiTemplateContext({
+          appRoot,
+          options: createOptions({
+            "parent-title": "always"
+          })
+        }),
+      /parent-title" supports only: contextual, none/
+    );
+  });
+});
+
 test("crud ui templates derive JSON:API transport from the shared CRUD resource", async () => {
   const testDirectory = path.dirname(fileURLToPath(import.meta.url));
   const templateRoot = path.resolve(testDirectory, "..", "templates", "src", "pages", "admin", "ui-generator");

package/test/packageDescriptor.test.js

@@ -13,6 +13,16 @@ test("crud-ui-generator operations option exposes structured csv-enum metadata",
   assert.equal(descriptor.metadata?.generatorSubcommands?.crud?.optionNames?.includes("operations"), true);
 });
 
+test("crud-ui-generator parent-title option exposes structured enum metadata", () => {
+  assert.equal(descriptor.options?.["parent-title"]?.validationType, "enum");
+  assert.deepEqual(
+    descriptor.options?.["parent-title"]?.allowedValues,
+    ["contextual", "none"]
+  );
+  assert.equal(descriptor.options?.["parent-title"]?.defaultValue, "contextual");
+  assert.equal(descriptor.metadata?.generatorSubcommands?.crud?.optionNames?.includes("parent-title"), true);
+});
+
 test("crud-ui-generator placement scaffold includes an explicit stock icon prop", () => {
   const placementMutation = descriptor?.mutations?.text?.find(
     (entry) => String(entry?.id || "").trim() === "crud-ui-placement-menu"