@postxl/schema 1.3.1 → 1.4.1

package/dist/field/discriminated-union.js

@@ -128,7 +128,7 @@ const fieldDiscriminatedUnionTransformer = ({ fieldInput, model, projectSchema }
         }
         const decodedField = decodedFieldResult.data;
         const transformedField = Fields.fieldTransformer(decodedField, model, projectSchema, ctx);
-        commonFields.set(transformedField.name, addDiscriminatedUnionParent(transformedField, fieldInput.name));
+        commonFields.set(transformedField.name, addDiscriminatedUnionParent(transformedField, fieldInput.name, fieldInput.excelName));
     }
     const members = new Map();
     for (const memberInput of fieldInput.members) {
@@ -153,7 +153,7 @@ const fieldDiscriminatedUnionTransformer = ({ fieldInput, model, projectSchema }
                 return zod_1.z.NEVER;
             }
             const transformedField = Fields.fieldTransformer(decodedField, model, projectSchema, ctx);
-            memberFields.set(transformedField.name, addDiscriminatedUnionParentMember(transformedField, fieldInput.name, discriminator));
+            memberFields.set(transformedField.name, addDiscriminatedUnionParentMember(transformedField, fieldInput.name, fieldInput.excelName, discriminator));
         }
         members.set(discriminator, {
             type: discriminator,
@@ -174,7 +174,7 @@ const fieldDiscriminatedUnionTransformer = ({ fieldInput, model, projectSchema }
     return result;
 };
 exports.fieldDiscriminatedUnionTransformer = fieldDiscriminatedUnionTransformer;
-function addDiscriminatedUnionParent(field, duFieldName) {
+function addDiscriminatedUnionParent(field, duFieldName, duExcelName) {
     const result = {
         ...field,
         discriminatedUnionFieldName: duFieldName,
@@ -183,10 +183,16 @@ function addDiscriminatedUnionParent(field, duFieldName) {
             databaseName: field.databaseName,
             newName: `${duFieldName}${(0, utils_1.toPascalCase)(field.name)}`,
         }),
+        excelName: ensureCustomExcelName({
+            name: field.name,
+            label: field.label,
+            excelName: field.excelName,
+            newName: `${duExcelName} ${field.excelName}`,
+        }),
     };
     return result;
 }
-function addDiscriminatedUnionParentMember(field, duFieldName, duMemberType) {
+function addDiscriminatedUnionParentMember(field, duFieldName, duExcelName, duMemberType) {
     const result = {
         ...field,
         discriminatedUnionFieldName: duFieldName,
@@ -196,9 +202,22 @@ function addDiscriminatedUnionParentMember(field, duFieldName, duMemberType) {
             databaseName: field.databaseName,
             newName: `${duFieldName}${(0, utils_1.toPascalCase)(duMemberType)}${(0, utils_1.toPascalCase)(field.name)}`,
         }),
+        excelName: ensureCustomExcelName({
+            name: field.name,
+            label: field.label,
+            excelName: field.excelName,
+            newName: `${duExcelName} ${(0, utils_1.toPascalCase)(duMemberType)} ${field.excelName}`,
+        }),
     };
     return result;
 }
+function ensureCustomExcelName({ excelName, name, label, newName, }) {
+    // If the user explicitly set a custom excelName (different from the defaults), keep it
+    if (excelName !== name && excelName !== label && excelName !== (0, utils_1.toHumanReadable)(name)) {
+        return excelName;
+    }
+    return Branded.toExcelColumnName(newName);
+}
 function ensureCustomDatabaseName({ databaseName, name, newName, }) {
     if (databaseName !== name && databaseName !== (0, utils_1.toSnakeCase)(name)) {
         return databaseName;

package/dist/model/model.defaults.d.ts

@@ -5,12 +5,16 @@ export declare const standardModelName_User: string & import("zod").$brand<"PXL.
 export declare const standardModelName_Action: string & import("zod").$brand<"PXL.ModelName">;
 export declare const standardModelName_ActionOperation: string & import("zod").$brand<"PXL.ModelName">;
 export declare const standardModelName_File: string & import("zod").$brand<"PXL.ModelName">;
+export declare const standardModelName_TableView: string & import("zod").$brand<"PXL.ModelName">;
+export declare const standardModelName_Comment: string & import("zod").$brand<"PXL.ModelName">;
 export declare const defaultModelNames: {
     config: string & import("zod").$brand<"PXL.ModelName">;
     user: string & import("zod").$brand<"PXL.ModelName">;
     action: string & import("zod").$brand<"PXL.ModelName">;
     mutation: string & import("zod").$brand<"PXL.ModelName">;
     file: string & import("zod").$brand<"PXL.ModelName">;
+    tableView: string & import("zod").$brand<"PXL.ModelName">;
+    comment: string & import("zod").$brand<"PXL.ModelName">;
 };
 export declare const defaultModel_Config: ModelJSON;
 export declare const defaultModelJson_User: ModelJSON;
@@ -25,4 +29,6 @@ export declare const defaultModelJson_ActionOperation: ModelJSON & {
     };
 };
 export declare const defaultModelJson_File: ModelJSON;
+export declare const defaultModelJson_TableView: ModelJSON;
+export declare const defaultModelJson_Comment: ModelJSON;
 export declare const defaultModelsJson: Record<Branded.ModelName, ModelJSON>;

package/dist/model/model.defaults.js

@@ -33,7 +33,7 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.defaultModelsJson = exports.defaultModelJson_File = exports.defaultModelJson_ActionOperation = exports.defaultModelJson_Action = exports.defaultModelJson_User = exports.defaultModel_Config = exports.defaultModelNames = exports.standardModelName_File = exports.standardModelName_ActionOperation = exports.standardModelName_Action = exports.standardModelName_User = exports.defaultModelName_Config = void 0;
+exports.defaultModelsJson = exports.defaultModelJson_Comment = exports.defaultModelJson_TableView = exports.defaultModelJson_File = exports.defaultModelJson_ActionOperation = exports.defaultModelJson_Action = exports.defaultModelJson_User = exports.defaultModel_Config = exports.defaultModelNames = exports.standardModelName_Comment = exports.standardModelName_TableView = exports.standardModelName_File = exports.standardModelName_ActionOperation = exports.standardModelName_Action = exports.standardModelName_User = exports.defaultModelName_Config = void 0;
 const defaults_1 = require("../field/defaults");
 const project_schema_defaults_1 = require("../project-schema/project-schema.defaults");
 const Branded = __importStar(require("./model.brands"));
@@ -42,12 +42,16 @@ exports.standardModelName_User = Branded.toModelName('User');
 exports.standardModelName_Action = Branded.toModelName('Action');
 exports.standardModelName_ActionOperation = Branded.toModelName('ActionOperation');
 exports.standardModelName_File = Branded.toModelName('File');
+exports.standardModelName_TableView = Branded.toModelName('TableView');
+exports.standardModelName_Comment = Branded.toModelName('Comment');
 exports.defaultModelNames = {
     config: exports.defaultModelName_Config,
     user: exports.standardModelName_User,
     action: exports.standardModelName_Action,
     mutation: exports.standardModelName_ActionOperation,
     file: exports.standardModelName_File,
+    tableView: exports.standardModelName_TableView,
+    comment: exports.standardModelName_Comment,
 };
 exports.defaultModel_Config = {
     name: exports.defaultModelName_Config,
@@ -295,10 +299,111 @@ exports.defaultModelJson_File = {
     ],
     faker: { items: 0 },
 };
+exports.defaultModelJson_TableView = {
+    name: exports.standardModelName_TableView,
+    description: 'A persisted table view configuration, storing filters, sorting, column visibility, and column order.',
+    schema: project_schema_defaults_1.databaseSchemaNameConfig,
+    fields: [
+        {
+            name: 'name',
+            type: 'String',
+            label: 'Name',
+            description: 'The name of the view.',
+        },
+        {
+            name: 'model',
+            type: 'String',
+            description: 'The model/table this view applies to.',
+        },
+        {
+            name: 'userId',
+            type: 'User',
+            description: 'The user that created this view.',
+        },
+        {
+            name: 'isGlobal',
+            type: 'Boolean',
+            description: 'Whether this view is visible to all users.',
+        },
+        {
+            name: 'filters',
+            type: 'String?',
+            description: 'JSON string containing the filter configuration.',
+        },
+        {
+            name: 'sorting',
+            type: 'String?',
+            description: 'JSON string containing the sorting configuration.',
+        },
+        {
+            name: 'columnVisibility',
+            type: 'String?',
+            description: 'JSON string containing column visibility state.',
+        },
+        {
+            name: 'columnOrder',
+            type: 'String?',
+            description: 'JSON string containing column order.',
+        },
+        {
+            name: 'columnPinning',
+            type: 'String?',
+            description: 'JSON string containing column pinning state.',
+        },
+        {
+            name: 'columnSizing',
+            type: 'String?',
+            description: 'JSON string containing column sizing state.',
+        },
+    ],
+    faker: { items: 0 },
+};
+exports.defaultModelJson_Comment = {
+    name: exports.standardModelName_Comment,
+    description: 'A comment on a model entry, supporting threaded replies and resolution.',
+    schema: project_schema_defaults_1.databaseSchemaNameConfig,
+    standardFields: [defaults_1.standardFieldName_id, defaults_1.standardFieldName_createdAt],
+    labelField: defaults_1.standardFieldName_id,
+    fields: [
+        {
+            name: 'userId',
+            type: 'User',
+            description: 'The user who wrote the comment.',
+        },
+        {
+            name: 'model',
+            type: 'String',
+            description: 'The model this comment belongs to (e.g. "Deliverable").',
+        },
+        {
+            name: 'modelId',
+            type: 'String',
+            description: 'The id of the model entry this comment belongs to (e.g. "1.5.1").',
+        },
+        {
+            name: 'comment',
+            type: 'String',
+            description: 'The comment text.',
+        },
+        {
+            name: 'replyToCommentId',
+            type: 'Comment?',
+            description: 'If this comment is a reply, the id of the parent comment.',
+        },
+        {
+            name: 'isResolved',
+            type: 'Boolean?',
+            description: 'Whether this comment thread has been resolved.',
+        },
+    ],
+    faker: { items: 0 },
+};
 exports.defaultModelsJson = {
     [exports.defaultModelName_Config]: exports.defaultModel_Config,
     [exports.standardModelName_User]: exports.defaultModelJson_User,
     [exports.standardModelName_Action]: exports.defaultModelJson_Action,
     [exports.standardModelName_ActionOperation]: exports.defaultModelJson_ActionOperation,
     [exports.standardModelName_File]: exports.defaultModelJson_File,
+    [exports.standardModelName_TableView]: exports.defaultModelJson_TableView,
+    [exports.standardModelName_Comment]: exports.defaultModelJson_Comment,
 };

package/dist/project-schema/project-schema.json-decoder.js

@@ -111,7 +111,7 @@ exports.zProjectSchemaJSON = zod_1.z
         //
         .array(Model.zModelNameJSON)
         .optional().describe(`Names of standard models that should be included in the project.
-Currently, the following fields are supported: Config, User, Action, ActionOperation, File.
+Currently, the following fields are supported: Config, User, Action, ActionOperation, File, TableView, Comment.
 If not provided, all models are included by default.
 
 If any of the standard models are also provided in the \`models\` array, the custom models will take precedence.`),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@postxl/schema",
-  "version": "1.3.1",
+  "version": "1.4.1",
   "description": "Decoders for PXL Schema definitions and validation for PXL code generation framework",
   "main": "./dist/index.js",
   "module": "./dist/index.js",