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

package/package.descriptor.mjs

@@ -1,7 +1,7 @@
 export default Object.freeze({
   packageVersion: 1,
   packageId: "@jskit-ai/crud-ui-generator",
-  version: "0.1.40",
+  version: "0.1.41",
   kind: "generator",
   description: "Generate CRUD route trees from resource validators at an explicit route root relative to src/pages/.",
   options: {
@@ -168,7 +168,7 @@ export default Object.freeze({
   mutations: {
     dependencies: {
       runtime: {
-        "@jskit-ai/users-web": "0.1.72"
+        "@jskit-ai/users-web": "0.1.73"
       },
       dev: {}
     },
@@ -353,7 +353,7 @@ export default Object.freeze({
         position: "bottom",
         skipIfContains: "__JSKIT_UI_MENU_MARKER__",
         value:
-          "\n// __JSKIT_UI_MENU_MARKER__\n{\n  addPlacement({\n    id: \"__JSKIT_UI_MENU_PLACEMENT_ID__\",\n    target: \"__JSKIT_UI_MENU_PLACEMENT_TARGET__\",\n    surfaces: [\"__JSKIT_UI_SURFACE_ID__\"],\n    order: 155,\n    componentToken: \"__JSKIT_UI_MENU_COMPONENT_TOKEN__\",\n    props: {\n      label: \"__JSKIT_UI_MENU_LABEL__\",\n      surface: \"__JSKIT_UI_SURFACE_ID__\",\n      scopedSuffix: \"__JSKIT_UI_MENU_WORKSPACE_SUFFIX__\",\n      unscopedSuffix: \"__JSKIT_UI_MENU_NON_WORKSPACE_SUFFIX__\",\n__JSKIT_UI_MENU_TO_PROP_LINE__    },\n__JSKIT_UI_MENU_WHEN_LINE__  });\n}\n",
+          "\n// __JSKIT_UI_MENU_MARKER__\n{\n  addPlacement({\n    id: \"__JSKIT_UI_MENU_PLACEMENT_ID__\",\n    target: \"__JSKIT_UI_MENU_PLACEMENT_TARGET__\",\n    surfaces: [\"__JSKIT_UI_SURFACE_ID__\"],\n    order: 155,\n    componentToken: \"__JSKIT_UI_MENU_COMPONENT_TOKEN__\",\n    props: {\n      label: \"__JSKIT_UI_MENU_LABEL__\",\n      icon: \"__JSKIT_UI_MENU_ICON__\",\n      surface: \"__JSKIT_UI_SURFACE_ID__\",\n      scopedSuffix: \"__JSKIT_UI_MENU_WORKSPACE_SUFFIX__\",\n      unscopedSuffix: \"__JSKIT_UI_MENU_NON_WORKSPACE_SUFFIX__\",\n__JSKIT_UI_MENU_TO_PROP_LINE__    },\n__JSKIT_UI_MENU_WHEN_LINE__  });\n}\n",
         reason: "Append generated CRUD list-page placement.",
         category: "crud-ui-generator",
         id: "crud-ui-placement-menu",

package/package.json

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

package/src/server/buildTemplateContext.js

@@ -59,6 +59,7 @@ const DEFAULT_OPERATIONS = normalizeText(descriptor?.options?.operations?.defaul
 const DEFAULT_LIST_HIDDEN_FIELD_KEYS = new Set(["createdAt", "updatedAt"]);
 const DEFAULT_FORM_COMPONENT_FILE = "CrudAddEditForm.vue";
 const DEFAULT_FORM_FIELDS_FILE = "CrudAddEditFormFields.js";
+const DEFAULT_GENERATED_LINK_ICON = "mdi-view-list-outline";
 
 function splitTextIntoWords(value = "") {
   const normalized = String(value || "")
@@ -659,6 +660,7 @@ async function buildUiTemplateContext({ appRoot, options } = {}) {
     __JSKIT_UI_MENU_PLACEMENT_ID__: String(pageLinkTarget?.pageTarget?.placementId || ""),
     __JSKIT_UI_MENU_PLACEMENT_TARGET__: String(pageLinkTarget?.placementTarget?.id || ""),
     __JSKIT_UI_MENU_COMPONENT_TOKEN__: String(pageLinkTarget?.componentToken || ""),
+    __JSKIT_UI_MENU_ICON__: DEFAULT_GENERATED_LINK_ICON,
     __JSKIT_UI_MENU_WORKSPACE_SUFFIX__: String(pageLinkTarget?.pageTarget?.routeUrlSuffix || ""),
     __JSKIT_UI_MENU_NON_WORKSPACE_SUFFIX__: String(pageLinkTarget?.pageTarget?.routeUrlSuffix || ""),
     __JSKIT_UI_MENU_WHEN_LINE__: String(pageLinkTarget?.whenLine || ""),

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

@@ -63,12 +63,6 @@ const UI_VIEW_URL = __JSKIT_UI_EDIT_PAGE_VIEW_URL__;
 const UI_CANCEL_URL = UI_VIEW_URL || UI_LIST_URL;
 const UI_RECORD_CHANGED_EVENT = __JSKIT_UI_RECORD_CHANGED_EVENT__;
 const UI_EDIT_FORM_FIELDS = [];
-const UI_EDIT_TRANSPORT = Object.freeze({
-  kind: "jsonapi-resource",
-  requestType: "__JSKIT_UI_RESOURCE_NAMESPACE__",
-  responseType: "__JSKIT_UI_RESOURCE_NAMESPACE__",
-  responseKind: "record"
-});
 
 // @jskit-contract crud.ui.form-fields.__JSKIT_UI_RESOURCE_NAMESPACE__.edit.v1
 void UI_EDIT_FORM_FIELDS;
@@ -105,7 +99,6 @@ const formRuntime = useCrudAddEdit({
       routeRecordId.value
     ],
     placementSource: "ui-generator.__JSKIT_UI_RESOURCE_NAMESPACE__.edit",
-    transport: UI_EDIT_TRANSPORT,
     writeMethod: "PATCH",
     fallbackLoadError: "Unable to load record.",
     fallbackSaveError: "Unable to save record.",

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

@@ -26,12 +26,6 @@ const UI_LIST_URL = __JSKIT_UI_EDIT_PAGE_LIST_URL__;
 const UI_VIEW_URL = __JSKIT_UI_EDIT_PAGE_VIEW_URL__;
 const UI_CANCEL_URL = UI_VIEW_URL || UI_LIST_URL;
 const UI_RECORD_CHANGED_EVENT = __JSKIT_UI_RECORD_CHANGED_EVENT__;
-const UI_EDIT_TRANSPORT = Object.freeze({
-  kind: "jsonapi-resource",
-  requestType: "__JSKIT_UI_RESOURCE_NAMESPACE__",
-  responseType: "__JSKIT_UI_RESOURCE_NAMESPACE__",
-  responseKind: "record"
-});
 const route = useRoute();
 
 // jskit:crud-ui-fields-target ../_components/__JSKIT_UI_FORM_COMPONENT_FILE__
@@ -64,7 +58,6 @@ const formRuntime = useCrudAddEdit({
       routeRecordId.value
     ],
     placementSource: "ui-generator.__JSKIT_UI_RESOURCE_NAMESPACE__.edit",
-    transport: UI_EDIT_TRANSPORT,
     writeMethod: "PATCH",
     fallbackLoadError: "Unable to load record.",
     fallbackSaveError: "Unable to save record.",

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

@@ -101,11 +101,6 @@ const UI_EDIT_URL = __JSKIT_UI_LIST_PAGE_EDIT_URL__;
 const UI_NEW_URL = __JSKIT_UI_LIST_PAGE_NEW_URL__;
 const UI_RECORD_CHANGED_EVENTS = __JSKIT_UI_LIST_REALTIME_EVENTS__;
 const UI_ROUTE_QUERY_BLACKLIST = Object.freeze(["include", "cursor", "limit"]);
-const UI_LIST_TRANSPORT = Object.freeze({
-  kind: "jsonapi-resource",
-  responseType: "__JSKIT_UI_RESOURCE_NAMESPACE__",
-  responseKind: "collection"
-});
 
 const records = useCrudList({
   adapter: UI_OPERATION_ADAPTER || undefined,
@@ -131,7 +126,6 @@ const records = useCrudList({
   },
   placementSource: "ui-generator.__JSKIT_UI_RESOURCE_NAMESPACE__.list",
   fallbackLoadError: "Unable to load records.",
-  transport: UI_LIST_TRANSPORT,
   recordIdParam: UI_RECORD_ID_PARAM,
   recordIdSelector: (item = {}) => __JSKIT_UI_LIST_RECORD_ID_EXPR__,
   viewUrlTemplate: UI_VIEW_URL,

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

@@ -50,12 +50,6 @@ const UI_LIST_URL = __JSKIT_UI_NEW_PAGE_LIST_URL__;
 const UI_VIEW_URL = __JSKIT_UI_NEW_PAGE_VIEW_URL__;
 const UI_RECORD_CHANGED_EVENT = __JSKIT_UI_RECORD_CHANGED_EVENT__;
 const UI_CREATE_FORM_FIELDS = [];
-const UI_CREATE_TRANSPORT = Object.freeze({
-  kind: "jsonapi-resource",
-  requestType: "__JSKIT_UI_RESOURCE_NAMESPACE__",
-  responseType: "__JSKIT_UI_RESOURCE_NAMESPACE__",
-  responseKind: "record"
-});
 
 // @jskit-contract crud.ui.form-fields.__JSKIT_UI_RESOURCE_NAMESPACE__.new.v1
 void UI_CREATE_FORM_FIELDS;
@@ -81,7 +75,6 @@ const formRuntime = useCrudAddEdit({
     ],
     placementSource: "ui-generator.__JSKIT_UI_RESOURCE_NAMESPACE__.new",
     readEnabled: false,
-    transport: UI_CREATE_TRANSPORT,
     writeMethod: "POST",
     fallbackSaveError: "Unable to save record.",
     recordIdParam: UI_RECORD_ID_PARAM,

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

@@ -23,12 +23,6 @@ const UI_LIST_URL = __JSKIT_UI_NEW_PAGE_LIST_URL__;
 const UI_VIEW_URL = __JSKIT_UI_NEW_PAGE_VIEW_URL__;
 const UI_CANCEL_URL = UI_LIST_URL;
 const UI_RECORD_CHANGED_EVENT = __JSKIT_UI_RECORD_CHANGED_EVENT__;
-const UI_CREATE_TRANSPORT = Object.freeze({
-  kind: "jsonapi-resource",
-  requestType: "__JSKIT_UI_RESOURCE_NAMESPACE__",
-  responseType: "__JSKIT_UI_RESOURCE_NAMESPACE__",
-  responseKind: "record"
-});
 
 // jskit:crud-ui-fields-target ./_components/__JSKIT_UI_FORM_COMPONENT_FILE__
 // jskit:crud-ui-form-fields-target ./_components/__JSKIT_UI_FORM_FIELDS_FILE__
@@ -51,7 +45,6 @@ const formRuntime = useCrudAddEdit({
     ],
     placementSource: "ui-generator.__JSKIT_UI_RESOURCE_NAMESPACE__.new",
     readEnabled: false,
-    transport: UI_CREATE_TRANSPORT,
     writeMethod: "POST",
     fallbackSaveError: "Unable to save record.",
     recordIdParam: UI_RECORD_ID_PARAM,

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

@@ -57,6 +57,7 @@ __JSKIT_UI_VIEW_COLUMNS__
 
 <script setup>
 import { useCrudView } from "@jskit-ai/users-web/client/composables/useCrudView";
+import { resource as uiResource } from "__JSKIT_UI_RESOURCE_IMPORT_PATH__";
 
 const UI_OPERATION_ADAPTER = null;
 const UI_RECORD_ID_PARAM = "__JSKIT_UI_RECORD_ID_PARAM__";
@@ -66,14 +67,10 @@ const UI_LIST_URL = __JSKIT_UI_VIEW_PAGE_LIST_URL__;
 const UI_EDIT_URL = __JSKIT_UI_VIEW_PAGE_EDIT_URL__;
 const UI_VIEW_TITLE_FALLBACK_FIELD_KEY = __JSKIT_UI_VIEW_TITLE_FALLBACK_FIELD_KEY__;
 const UI_RECORD_CHANGED_EVENT = __JSKIT_UI_RECORD_CHANGED_EVENT__;
-const UI_VIEW_TRANSPORT = Object.freeze({
-  kind: "jsonapi-resource",
-  responseType: "__JSKIT_UI_RESOURCE_NAMESPACE__",
-  responseKind: "record"
-});
 
 const view = useCrudView({
   adapter: UI_OPERATION_ADAPTER || undefined,
+  resource: uiResource,
   apiUrlTemplate: UI_VIEW_API_URL,
   recordIdParam: UI_RECORD_ID_PARAM,
   includeRecordIdInQueryKey: true,
@@ -85,7 +82,6 @@ const view = useCrudView({
     String(workspaceSlug || "")
   ],
   placementSource: "ui-generator.__JSKIT_UI_RESOURCE_NAMESPACE__.view",
-  transport: UI_VIEW_TRANSPORT,
   fallbackLoadError: "Unable to load record.",
   notFoundMessage: "Record not found.",
   listUrlTemplate: UI_LIST_URL,

package/test/buildTemplateContext.test.js

@@ -628,7 +628,8 @@ test("buildUiTemplateContext infers tab placement and relative link-to from the
     });
 
     assert.equal(context.__JSKIT_UI_MENU_PLACEMENT_TARGET__, "catalog:sub-pages");
-    assert.equal(context.__JSKIT_UI_MENU_COMPONENT_TOKEN__, "local.main.ui.tab-link-item");
+    assert.equal(context.__JSKIT_UI_MENU_COMPONENT_TOKEN__, "local.main.ui.surface-aware-menu-link-item");
+    assert.equal(context.__JSKIT_UI_MENU_ICON__, "mdi-view-list-outline");
     assert.equal(context.__JSKIT_UI_MENU_TO_PROP_LINE__, "      to: \"./products\",\n");
     assert.equal(context.__JSKIT_UI_MENU_WORKSPACE_SUFFIX__, "/catalog/products");
   });
@@ -714,7 +715,7 @@ test("buildUiTemplateContext validates operations against the supported CRUD set
   });
 });
 
-test("crud ui templates opt into shared JSON:API client transport", async () => {
+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");
 
@@ -725,25 +726,28 @@ test("crud ui templates opt into shared JSON:API client transport", async () =>
   const newWrapperTemplateSource = await readFile(path.join(templateRoot, "NewWrapperElement.vue"), "utf8");
   const editWrapperTemplateSource = await readFile(path.join(templateRoot, "EditWrapperElement.vue"), "utf8");
 
-  assert.match(listTemplateSource, /const UI_LIST_TRANSPORT = Object\.freeze\(\{/);
-  assert.match(listTemplateSource, /responseKind: "collection"/);
-  assert.match(listTemplateSource, /transport: UI_LIST_TRANSPORT,/);
+  assert.match(listTemplateSource, /resource: uiResource,/);
+  assert.doesNotMatch(listTemplateSource, /const UI_LIST_TRANSPORT = Object\.freeze\(\{/);
+  assert.doesNotMatch(listTemplateSource, /transport:\s*UI_LIST_TRANSPORT,/);
 
-  assert.match(viewTemplateSource, /const UI_VIEW_TRANSPORT = Object\.freeze\(\{/);
-  assert.match(viewTemplateSource, /responseKind: "record"/);
-  assert.match(viewTemplateSource, /transport: UI_VIEW_TRANSPORT,/);
+  assert.match(viewTemplateSource, /import \{ resource as uiResource \} from/);
+  assert.match(viewTemplateSource, /resource: uiResource,/);
+  assert.doesNotMatch(viewTemplateSource, /const UI_VIEW_TRANSPORT = Object\.freeze\(\{/);
+  assert.doesNotMatch(viewTemplateSource, /transport:\s*UI_VIEW_TRANSPORT,/);
 
-  assert.match(newTemplateSource, /const UI_CREATE_TRANSPORT = Object\.freeze\(\{/);
-  assert.match(newTemplateSource, /requestType: "__JSKIT_UI_RESOURCE_NAMESPACE__"/);
-  assert.match(newTemplateSource, /transport: UI_CREATE_TRANSPORT,/);
+  assert.match(newTemplateSource, /resource: uiResource,/);
+  assert.doesNotMatch(newTemplateSource, /const UI_CREATE_TRANSPORT = Object\.freeze\(\{/);
+  assert.doesNotMatch(newTemplateSource, /transport:\s*UI_CREATE_TRANSPORT,/);
 
-  assert.match(editTemplateSource, /const UI_EDIT_TRANSPORT = Object\.freeze\(\{/);
-  assert.match(editTemplateSource, /requestType: "__JSKIT_UI_RESOURCE_NAMESPACE__"/);
-  assert.match(editTemplateSource, /transport: UI_EDIT_TRANSPORT,/);
+  assert.match(editTemplateSource, /resource: uiResource,/);
+  assert.doesNotMatch(editTemplateSource, /const UI_EDIT_TRANSPORT = Object\.freeze\(\{/);
+  assert.doesNotMatch(editTemplateSource, /transport:\s*UI_EDIT_TRANSPORT,/);
 
-  assert.match(newWrapperTemplateSource, /const UI_CREATE_TRANSPORT = Object\.freeze\(\{/);
-  assert.match(newWrapperTemplateSource, /transport: UI_CREATE_TRANSPORT,/);
+  assert.match(newWrapperTemplateSource, /resource: uiResource,/);
+  assert.doesNotMatch(newWrapperTemplateSource, /const UI_CREATE_TRANSPORT = Object\.freeze\(\{/);
+  assert.doesNotMatch(newWrapperTemplateSource, /transport:\s*UI_CREATE_TRANSPORT,/);
 
-  assert.match(editWrapperTemplateSource, /const UI_EDIT_TRANSPORT = Object\.freeze\(\{/);
-  assert.match(editWrapperTemplateSource, /transport: UI_EDIT_TRANSPORT,/);
+  assert.match(editWrapperTemplateSource, /resource: uiResource,/);
+  assert.doesNotMatch(editWrapperTemplateSource, /const UI_EDIT_TRANSPORT = Object\.freeze\(\{/);
+  assert.doesNotMatch(editWrapperTemplateSource, /transport:\s*UI_EDIT_TRANSPORT,/);
 });

package/test/packageDescriptor.test.js

@@ -12,3 +12,10 @@ test("crud-ui-generator operations option exposes structured csv-enum metadata",
   assert.equal(descriptor.options?.operations?.defaultValue, "list,view,new,edit");
   assert.equal(descriptor.metadata?.generatorSubcommands?.crud?.optionNames?.includes("operations"), 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"
+  );
+  assert.match(String(placementMutation?.value || ""), /icon: "__JSKIT_UI_MENU_ICON__"/);
+});