@carlonicora/nextjs-jsonapi 1.110.0 → 1.111.0

package/scripts/generate-web-module/templates/table-hook.template.ts

@@ -5,7 +5,7 @@
  */
 
 import { FrontendTemplateData, FrontendField } from "../types/template-data.interface";
-import { toCamelCase } from "../transformers/name-transformer";
+import { toCamelCase, pluralize } from "../transformers/name-transformer";
 
 /**
  * Generate the table structure hook file content
@@ -96,7 +96,7 @@ registerTableGenerator(Modules.${names.pascalCase}, use${names.pascalCase}TableS
  * Generate field column map entries
  */
 function generateFieldColumnEntries(data: FrontendTemplateData): string {
-  const { names, fields, extendsContent } = data;
+  const { names, fields, extendsContent, relationships } = data;
   const entries: string[] = [];
 
   // Name field (with link and tooltip for tldr if Content-extending)
@@ -183,8 +183,37 @@ function generateFieldColumnEntries(data: FrontendTemplateData): string {
       enableSorting: false,
       enableHiding: false,
     }),`);
+    } else if (field.type === "date" || field.type === "datetime") {
+      entries.push(`    [${names.pascalCase}Fields.${field.name}]: () =>
+      cellDate({
+        name: "${field.name}",
+        title: t(\`features.${names.camelCase}.fields.${field.name}.label\`),
+      }),`);
     }
   });
 
+  // Relationship columns (rendered when flagged for table display)
+  relationships
+    .filter((rel) => rel.showInTable)
+    .forEach((rel) => {
+      const key = rel.single
+        ? toCamelCase(rel.alias || rel.variant || rel.name)
+        : pluralize(toCamelCase(rel.alias || rel.name));
+      const accessor = rel.single
+        ? `${names.camelCase}.${key}?.name ?? ""`
+        : `${names.camelCase}.${key}.map((r) => r.name).join(", ")`;
+      entries.push(`    [${names.pascalCase}Fields.${key}]: () => ({
+      id: "${key}",
+      accessorKey: "${key}",
+      header: t(\`generic.relationships.${key}.label\`),
+      cell: ({ row }: { row: TableContent<${names.pascalCase}Interface> }) => {
+        const ${names.camelCase}: ${names.pascalCase}Interface = row.original.jsonApiData;
+        return <span>{${accessor}}</span>;
+      },
+      enableSorting: false,
+      enableHiding: false,
+    }),`);
+    });
+
   return entries.join("\n");
 }

package/scripts/generate-web-module/transformers/import-resolver.ts

@@ -177,7 +177,6 @@ export interface ModuleFilePaths {
   selector: string;
   multiSelector: string;
   list: string;
-  details: string;
   content: string;
   container: string;
   listContainer: string;
@@ -220,7 +219,6 @@ export function buildFilePaths(
     selector: `${basePath}/components/forms/${names.pascalCase}Selector.tsx`,
     multiSelector: `${basePath}/components/forms/${names.pascalCase}MultiSelector.tsx`,
     list: `${basePath}/components/lists/${names.pascalCase}List.tsx`,
-    details: `${basePath}/components/details/${names.pascalCase}Details.tsx`,
     content: `${basePath}/components/details/${names.pascalCase}Content.tsx`,
     container: `${basePath}/components/containers/${names.pascalCase}Container.tsx`,
     listContainer: `${basePath}/components/containers/${names.pascalCase}ListContainer.tsx`,

package/scripts/generate-web-module/transformers/relationship-key.ts

@@ -0,0 +1,18 @@
+import { FrontendRelationship } from "../types/template-data.interface";
+import { toKebabCase, pluralize } from "./name-transformer";
+
+/** JSON:API wire key for a relationship. Schema dtoKey wins; otherwise derive
+ *  identically to the backend mapper so both sides of the wire agree. */
+export function resolveRelationshipKey(rel: FrontendRelationship): string {
+  if (rel.dtoKey) return rel.dtoKey;
+  // NOTE: Author relationships are normally NOT serialized through this helper — the backend
+  // special-cases Author via contextKey/currentUser and the model template skips Author
+  // serialization, so callers must not rely on this helper for Author wire keys.
+  if (rel.variant) {
+    return rel.single ? rel.variant.toLowerCase() : pluralize(rel.variant.toLowerCase());
+  }
+  if (rel.alias) {
+    return rel.single ? toKebabCase(rel.alias) : pluralize(toKebabCase(rel.alias));
+  }
+  return rel.single ? rel.name.toLowerCase() : pluralize(rel.name.toLowerCase());
+}

package/scripts/generate-web-module/transformers/relationship-resolver.ts

@@ -122,6 +122,8 @@ export function resolveRelationship(rel: JsonRelationshipDefinition, targetHasNa
     modelKebab,
     fields,
     targetHasName: targetHasNameMap?.get(rel.name) ?? true, // Foundation entities default to true
+    dtoKey: rel.dtoKey ?? "",
+    showInTable: rel.showInTable === true,
   };
 }
 

package/scripts/generate-web-module/types/json-schema.interface.ts

@@ -13,6 +13,7 @@ export interface JsonFieldDefinition {
   name: string;
   type: string;
   nullable: boolean;
+  readOnly?: boolean;
 }
 
 /**
@@ -29,6 +30,10 @@ export interface JsonRelationshipDefinition {
   toNode: boolean; // Backend-specific, ignored in frontend
   nullable: boolean;
   fields?: JsonFieldDefinition[]; // Relationship property fields (stored on edges)
+  /** Explicit JSON:API wire key. When absent it is derived identically to the backend mapper. */
+  dtoKey?: string;
+  description?: string;
+  showInTable?: boolean;
 }
 
 /**
@@ -44,4 +49,8 @@ export interface JsonModuleDefinition {
   relationships: JsonRelationshipDefinition[];
   /** Explicitly set whether this module extends Content. If not set, auto-detects based on fields. */
   extendsContent?: boolean;
+  featureId?: string;
+  displayProp?: string;
+  containerTabs?: { activity?: boolean; relations?: { module: string; listProp: string; directory: string }[] };
+  inclusions?: { related?: { endpoint: string; fields: string[] }[] };
 }

package/scripts/generate-web-module/types/template-data.interface.ts

@@ -30,6 +30,7 @@ export interface FrontendField {
   formComponent: FormComponentType;
   nullable: boolean;
   isContentField: boolean; // Indicates BlockNoteEditor
+  readOnly?: boolean;
 }
 
 /**
@@ -68,6 +69,8 @@ export interface FrontendRelationship {
   modelKebab: string; // e.g., "user"
   fields?: FrontendField[]; // Relationship property fields (stored on edges)
   targetHasName: boolean; // Whether the target entity has a "name" field (or extends Content)
+  dtoKey: string;       // resolved wire key; "" means derive at use-site
+  showInTable: boolean;
 }
 
 /**
@@ -153,6 +156,10 @@ export interface FrontendTemplateData {
 
   // For service generation
   relationshipServiceMethods: RelationshipServiceMethod[];
+  featureId?: string;
+  displayProp: string;
+  containerTabs: { activity: boolean; relations: { module: string; listProp: string; directory: string }[] };
+  relatedInclusions: { endpoint: string; fields: string[] }[];
 }
 
 /**

package/dist/scripts/generate-web-module/templates/components/details.template.d.ts

@@ -1,14 +0,0 @@
-/**
- * Details Template
- *
- * Generates {Module}Details.tsx component for displaying item details.
- */
-import { FrontendTemplateData } from "../../types/template-data.interface";
-/**
- * Generate the details component file content
- *
- * @param data - Frontend template data
- * @returns Generated file content
- */
-export declare function generateDetailsTemplate(data: FrontendTemplateData): string;
-//# sourceMappingURL=details.template.d.ts.map

package/dist/scripts/generate-web-module/templates/components/details.template.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"details.template.d.ts","sourceRoot":"","sources":["../../../../../scripts/generate-web-module/templates/components/details.template.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,EAAE,oBAAoB,EAAE,MAAM,qCAAqC,CAAC;AAE3E;;;;;GAKG;AACH,wBAAgB,uBAAuB,CAAC,IAAI,EAAE,oBAAoB,GAAG,MAAM,CAmC1E"}

package/dist/scripts/generate-web-module/templates/components/details.template.js

@@ -1,112 +0,0 @@
-"use strict";
-/**
- * Details Template
- *
- * Generates {Module}Details.tsx component for displaying item details.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateDetailsTemplate = generateDetailsTemplate;
-const name_transformer_1 = require("../../transformers/name-transformer");
-/**
- * Generate the details component file content
- *
- * @param data - Frontend template data
- * @returns Generated file content
- */
-function generateDetailsTemplate(data) {
-    const { names, fields, relationships, extendsContent } = data;
-    const attributeElements = generateAttributeElements(data);
-    return `"use client";
-
-import { use${names.pascalCase}Context } from "@/features/${data.importTargetDir}/${names.kebabCase}/contexts/${names.pascalCase}Context";
-import { AttributeElement, ContentTitle, ReactMarkdownContainer } from "@carlonicora/nextjs-jsonapi/components";
-import { useSharedContext } from "@carlonicora/nextjs-jsonapi/contexts";
-import { Modules } from "@carlonicora/nextjs-jsonapi/core";
-import { useTranslations } from "next-intl";
-
-function ${names.pascalCase}DetailsInternal() {
-  const { ${names.camelCase}, reload${names.pascalCase} } = use${names.pascalCase}Context();
-  const t = useTranslations();
-  const { title } = useSharedContext();
-
-  if (!${names.camelCase}) return null;
-
-  return (
-    <div className="flex w-full flex-col gap-y-2">
-      <ContentTitle type={title.type} element={title.element} functions={title.functions} module={Modules.${names.pascalCase}} />
-${attributeElements}
-    </div>
-  );
-}
-
-export default function ${names.pascalCase}Details() {
-  const { ${names.camelCase} } = use${names.pascalCase}Context();
-  if (!${names.camelCase}) return null;
-
-  return <${names.pascalCase}DetailsInternal />;
-}
-`;
-}
-/**
- * Generate attribute elements for display fields
- */
-function generateAttributeElements(data) {
-    const { names, fields, relationships, extendsContent } = data;
-    const elements = [];
-    // Show abstract if Content-extending
-    if (extendsContent) {
-        elements.push(`      <AttributeElement
-        title={t(\`generic.abstract\`)}
-        value={<ReactMarkdownContainer size="small" content={${names.camelCase}.abstract} />}
-      />`);
-    }
-    // Add custom fields (excluding name, tldr, abstract, content which are handled elsewhere)
-    const displayableFields = fields.filter((f) => !["name", "tldr", "abstract", "content", "id"].includes(f.name));
-    displayableFields.forEach((field) => {
-        if (field.type === "string") {
-            elements.push(`      <AttributeElement
-        title={t(\`features.${names.camelCase}.fields.${field.name}.label\`)}
-        value={${names.camelCase}.${field.name}}
-      />`);
-        }
-        else if (field.type === "boolean") {
-            elements.push(`      <AttributeElement
-        title={t(\`features.${names.camelCase}.fields.${field.name}.label\`)}
-        value={${names.camelCase}.${field.name} ? t(\`generic.yes\`) : t(\`generic.no\`)}
-      />`);
-        }
-        else if (field.type === "number") {
-            elements.push(`      <AttributeElement
-        title={t(\`features.${names.camelCase}.fields.${field.name}.label\`)}
-        value={${names.camelCase}.${field.name}?.toString()}
-      />`);
-        }
-    });
-    // Add relationship displays (basic - can be enhanced manually)
-    relationships
-        .filter((rel) => rel.variant !== "Author") // Skip author, usually shown in title
-        .forEach((rel) => {
-        const displayProp = rel.targetHasName ? "name" : "id";
-        if (rel.single) {
-            const propName = (0, name_transformer_1.toCamelCase)(rel.alias || rel.variant || rel.name);
-            elements.push(`      {${names.camelCase}.${propName} && (
-        <AttributeElement
-          title={t(\`generic.relationships.${propName}.label\`)}
-          value={${names.camelCase}.${propName}.${displayProp}}
-        />
-      )}`);
-        }
-        else {
-            const effectiveMany = rel.alias || rel.name;
-            const propName = (0, name_transformer_1.pluralize)((0, name_transformer_1.toCamelCase)(effectiveMany));
-            elements.push(`      {${names.camelCase}.${propName} && ${names.camelCase}.${propName}.length > 0 && (
-        <AttributeElement
-          title={t(\`entities.${(0, name_transformer_1.pluralize)(rel.name.toLowerCase())}\`, { count: 2 })}
-          value={${names.camelCase}.${propName}.map((item) => item.${displayProp}).join(", ")}
-        />
-      )}`);
-        }
-    });
-    return elements.join("\n");
-}
-//# sourceMappingURL=details.template.js.map

package/dist/scripts/generate-web-module/templates/components/details.template.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"details.template.js","sourceRoot":"","sources":["../../../../../scripts/generate-web-module/templates/components/details.template.ts"],"names":[],"mappings":";AAAA;;;;GAIG;;AAWH,0DAmCC;AA5CD,0EAA6E;AAG7E;;;;;GAKG;AACH,SAAgB,uBAAuB,CAAC,IAA0B;IAChE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,aAAa,EAAE,cAAc,EAAE,GAAG,IAAI,CAAC;IAE9D,MAAM,iBAAiB,GAAG,yBAAyB,CAAC,IAAI,CAAC,CAAC;IAE1D,OAAO;;cAEK,KAAK,CAAC,UAAU,8BAA8B,IAAI,CAAC,eAAe,IAAI,KAAK,CAAC,SAAS,aAAa,KAAK,CAAC,UAAU;;;;;;WAMrH,KAAK,CAAC,UAAU;YACf,KAAK,CAAC,SAAS,WAAW,KAAK,CAAC,UAAU,WAAW,KAAK,CAAC,UAAU;;;;SAIxE,KAAK,CAAC,SAAS;;;;4GAIoF,KAAK,CAAC,UAAU;EAC1H,iBAAiB;;;;;0BAKO,KAAK,CAAC,UAAU;YAC9B,KAAK,CAAC,SAAS,WAAW,KAAK,CAAC,UAAU;SAC7C,KAAK,CAAC,SAAS;;YAEZ,KAAK,CAAC,UAAU;;CAE3B,CAAC;AACF,CAAC;AAED;;GAEG;AACH,SAAS,yBAAyB,CAAC,IAA0B;IAC3D,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,aAAa,EAAE,cAAc,EAAE,GAAG,IAAI,CAAC;IAC9D,MAAM,QAAQ,GAAa,EAAE,CAAC;IAE9B,qCAAqC;IACrC,IAAI,cAAc,EAAE,CAAC;QACnB,QAAQ,CAAC,IAAI,CAAC;;+DAE6C,KAAK,CAAC,SAAS;SACrE,CAAC,CAAC;IACT,CAAC;IAED,0FAA0F;IAC1F,MAAM,iBAAiB,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;IAEhH,iBAAiB,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;QAClC,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC5B,QAAQ,CAAC,IAAI,CAAC;8BACU,KAAK,CAAC,SAAS,WAAW,KAAK,CAAC,IAAI;iBACjD,KAAK,CAAC,SAAS,IAAI,KAAK,CAAC,IAAI;SACrC,CAAC,CAAC;QACP,CAAC;aAAM,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YACpC,QAAQ,CAAC,IAAI,CAAC;8BACU,KAAK,CAAC,SAAS,WAAW,KAAK,CAAC,IAAI;iBACjD,KAAK,CAAC,SAAS,IAAI,KAAK,CAAC,IAAI;SACrC,CAAC,CAAC;QACP,CAAC;aAAM,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YACnC,QAAQ,CAAC,IAAI,CAAC;8BACU,KAAK,CAAC,SAAS,WAAW,KAAK,CAAC,IAAI;iBACjD,KAAK,CAAC,SAAS,IAAI,KAAK,CAAC,IAAI;SACrC,CAAC,CAAC;QACP,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,+DAA+D;IAC/D,aAAa;SACV,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,OAAO,KAAK,QAAQ,CAAC,CAAC,sCAAsC;SAChF,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;QACf,MAAM,WAAW,GAAG,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC;QACtD,IAAI,GAAG,CAAC,MAAM,EAAE,CAAC;YACf,MAAM,QAAQ,GAAG,IAAA,8BAAW,EAAC,GAAG,CAAC,KAAK,IAAI,GAAG,CAAC,OAAO,IAAI,GAAG,CAAC,IAAI,CAAC,CAAC;YACnE,QAAQ,CAAC,IAAI,CAAC,UAAU,KAAK,CAAC,SAAS,IAAI,QAAQ;;6CAEd,QAAQ;mBAClC,KAAK,CAAC,SAAS,IAAI,QAAQ,IAAI,WAAW;;SAEpD,CAAC,CAAC;QACL,CAAC;aAAM,CAAC;YACN,MAAM,aAAa,GAAG,GAAG,CAAC,KAAK,IAAI,GAAG,CAAC,IAAI,CAAC;YAC5C,MAAM,QAAQ,GAAG,IAAA,4BAAS,EAAC,IAAA,8BAAW,EAAC,aAAa,CAAC,CAAC,CAAC;YACvD,QAAQ,CAAC,IAAI,CAAC,UAAU,KAAK,CAAC,SAAS,IAAI,QAAQ,OAAO,KAAK,CAAC,SAAS,IAAI,QAAQ;;gCAE7D,IAAA,4BAAS,EAAC,GAAG,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;mBAC9C,KAAK,CAAC,SAAS,IAAI,QAAQ,uBAAuB,WAAW;;SAEvE,CAAC,CAAC;QACL,CAAC;IACH,CAAC,CAAC,CAAC;IAEL,OAAO,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC7B,CAAC"}

package/scripts/generate-web-module/templates/components/details.template.ts

@@ -1,116 +0,0 @@
-/**
- * Details Template
- *
- * Generates {Module}Details.tsx component for displaying item details.
- */
-
-import { pluralize, toCamelCase } from "../../transformers/name-transformer";
-import { FrontendTemplateData } from "../../types/template-data.interface";
-
-/**
- * Generate the details component file content
- *
- * @param data - Frontend template data
- * @returns Generated file content
- */
-export function generateDetailsTemplate(data: FrontendTemplateData): string {
-  const { names, fields, relationships, extendsContent } = data;
-
-  const attributeElements = generateAttributeElements(data);
-
-  return `"use client";
-
-import { use${names.pascalCase}Context } from "@/features/${data.importTargetDir}/${names.kebabCase}/contexts/${names.pascalCase}Context";
-import { AttributeElement, ContentTitle, ReactMarkdownContainer } from "@carlonicora/nextjs-jsonapi/components";
-import { useSharedContext } from "@carlonicora/nextjs-jsonapi/contexts";
-import { Modules } from "@carlonicora/nextjs-jsonapi/core";
-import { useTranslations } from "next-intl";
-
-function ${names.pascalCase}DetailsInternal() {
-  const { ${names.camelCase}, reload${names.pascalCase} } = use${names.pascalCase}Context();
-  const t = useTranslations();
-  const { title } = useSharedContext();
-
-  if (!${names.camelCase}) return null;
-
-  return (
-    <div className="flex w-full flex-col gap-y-2">
-      <ContentTitle type={title.type} element={title.element} functions={title.functions} module={Modules.${names.pascalCase}} />
-${attributeElements}
-    </div>
-  );
-}
-
-export default function ${names.pascalCase}Details() {
-  const { ${names.camelCase} } = use${names.pascalCase}Context();
-  if (!${names.camelCase}) return null;
-
-  return <${names.pascalCase}DetailsInternal />;
-}
-`;
-}
-
-/**
- * Generate attribute elements for display fields
- */
-function generateAttributeElements(data: FrontendTemplateData): string {
-  const { names, fields, relationships, extendsContent } = data;
-  const elements: string[] = [];
-
-  // Show abstract if Content-extending
-  if (extendsContent) {
-    elements.push(`      <AttributeElement
-        title={t(\`generic.abstract\`)}
-        value={<ReactMarkdownContainer size="small" content={${names.camelCase}.abstract} />}
-      />`);
-  }
-
-  // Add custom fields (excluding name, tldr, abstract, content which are handled elsewhere)
-  const displayableFields = fields.filter((f) => !["name", "tldr", "abstract", "content", "id"].includes(f.name));
-
-  displayableFields.forEach((field) => {
-    if (field.type === "string") {
-      elements.push(`      <AttributeElement
-        title={t(\`features.${names.camelCase}.fields.${field.name}.label\`)}
-        value={${names.camelCase}.${field.name}}
-      />`);
-    } else if (field.type === "boolean") {
-      elements.push(`      <AttributeElement
-        title={t(\`features.${names.camelCase}.fields.${field.name}.label\`)}
-        value={${names.camelCase}.${field.name} ? t(\`generic.yes\`) : t(\`generic.no\`)}
-      />`);
-    } else if (field.type === "number") {
-      elements.push(`      <AttributeElement
-        title={t(\`features.${names.camelCase}.fields.${field.name}.label\`)}
-        value={${names.camelCase}.${field.name}?.toString()}
-      />`);
-    }
-  });
-
-  // Add relationship displays (basic - can be enhanced manually)
-  relationships
-    .filter((rel) => rel.variant !== "Author") // Skip author, usually shown in title
-    .forEach((rel) => {
-      const displayProp = rel.targetHasName ? "name" : "id";
-      if (rel.single) {
-        const propName = toCamelCase(rel.alias || rel.variant || rel.name);
-        elements.push(`      {${names.camelCase}.${propName} && (
-        <AttributeElement
-          title={t(\`generic.relationships.${propName}.label\`)}
-          value={${names.camelCase}.${propName}.${displayProp}}
-        />
-      )}`);
-      } else {
-        const effectiveMany = rel.alias || rel.name;
-        const propName = pluralize(toCamelCase(effectiveMany));
-        elements.push(`      {${names.camelCase}.${propName} && ${names.camelCase}.${propName}.length > 0 && (
-        <AttributeElement
-          title={t(\`entities.${pluralize(rel.name.toLowerCase())}\`, { count: 2 })}
-          value={${names.camelCase}.${propName}.map((item) => item.${displayProp}).join(", ")}
-        />
-      )}`);
-      }
-    });
-
-  return elements.join("\n");
-}