@postxl/schema 1.8.1 → 1.9.0

package/dist/field/field.d.ts

@@ -66,6 +66,7 @@ export declare const createFieldJSONDecoder: (params: {
     faker: z.ZodOptional<z.ZodString>;
     seed: z.ZodOptional<z.ZodUnion<[z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodDate]>, z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodDate]>>]>>;
     placeholder: z.ZodOptional<z.ZodString>;
+    defaultValue: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>>;
 }, z.core.$strict>, z.ZodTransform<FieldScalarEnriched, {
     name: string;
     type: "BigInt" | "String" | "Boolean" | "DateTime" | "Decimal" | "Float" | "Int" | "Bytes" | "String?" | "Boolean?" | "DateTime?" | "Decimal?" | "Float?" | "Int?" | "Bytes?" | "BigInt?";
@@ -82,6 +83,7 @@ export declare const createFieldJSONDecoder: (params: {
     faker?: string | undefined;
     seed?: string | number | boolean | Date | (string | number | boolean | Date)[] | undefined;
     placeholder?: string | undefined;
+    defaultValue?: string | number | boolean | undefined;
 }>>, z.ZodPipe<z.ZodObject<{
     name: z.ZodString;
     type: z.ZodUnion<readonly [z.ZodLiteral<"Json">, z.ZodLiteral<"JSON">, z.ZodLiteral<"Json?">, z.ZodLiteral<"JSON?">]>;
@@ -248,6 +250,7 @@ export declare const zFieldJSONInput: (params: {
     faker: z.ZodOptional<z.ZodString>;
     seed: z.ZodOptional<z.ZodUnion<[z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodDate]>, z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodDate]>>]>>;
     placeholder: z.ZodOptional<z.ZodString>;
+    defaultValue: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>>;
 }, z.core.$strict>, z.ZodObject<{
     name: z.ZodString;
     type: z.ZodUnion<readonly [z.ZodLiteral<"Json">, z.ZodLiteral<"JSON">, z.ZodLiteral<"Json?">, z.ZodLiteral<"JSON?">]>;

package/dist/field/scalar.d.ts

@@ -33,6 +33,7 @@ type FieldCommonScalar = {
 type FieldScalarStringWithValidations = {
     type: 'string';
     validations: ValidationString;
+    defaultValue: string | undefined;
 };
 type ValidationString = {
     maxLength: number | undefined;
@@ -40,6 +41,7 @@ type ValidationString = {
 type FieldScalarNumberWithValidations = {
     type: 'number';
     validations: ValidationNumber;
+    defaultValue: number | undefined;
 };
 type ValidationNumber = {
     type: 'int' | 'float';
@@ -48,9 +50,11 @@ type ValidationNumber = {
 };
 type FieldScalarBooleanNoValidation = {
     type: 'boolean';
+    defaultValue: boolean | undefined;
 };
 type FieldScalarDateNoValidation = {
     type: 'Date';
+    defaultValue: string | undefined;
 };
 /**
  * JSON Schema for an scalar field
@@ -71,12 +75,14 @@ export declare const zFieldScalarJSON: z.ZodObject<{
     faker: z.ZodOptional<z.ZodString>;
     seed: z.ZodOptional<z.ZodUnion<[z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodDate]>, z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodDate]>>]>>;
     placeholder: z.ZodOptional<z.ZodString>;
+    defaultValue: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>>;
 }, z.core.$strict>;
 export type FieldScalarJSON = z.infer<typeof zFieldScalarJSON>;
 export declare function fieldScalarJSONTransformer(fieldInput: FieldScalarJSON, ctx: z.RefinementCtx): FieldScalarEnriched;
 export type FieldScalarEnriched = Omit<FieldCommon<FieldKindScalar>, 'modelName'> & FieldCommonScalar & {
     type: Branded.ScalarType;
     validations: Partial<ValidationString & ValidationNumber>;
+    defaultValue: string | number | boolean | undefined;
 };
 export declare const zFieldScalar: z.ZodPipe<z.ZodObject<{
     name: z.ZodString;
@@ -94,6 +100,7 @@ export declare const zFieldScalar: z.ZodPipe<z.ZodObject<{
     faker: z.ZodOptional<z.ZodString>;
     seed: z.ZodOptional<z.ZodUnion<[z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodDate]>, z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodDate]>>]>>;
     placeholder: z.ZodOptional<z.ZodString>;
+    defaultValue: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>>;
 }, z.core.$strict>, z.ZodTransform<FieldScalarEnriched, {
     name: string;
     type: "BigInt" | "String" | "Boolean" | "DateTime" | "Decimal" | "Float" | "Int" | "Bytes" | "String?" | "Boolean?" | "DateTime?" | "Decimal?" | "Float?" | "Int?" | "Bytes?" | "BigInt?";
@@ -110,6 +117,7 @@ export declare const zFieldScalar: z.ZodPipe<z.ZodObject<{
     faker?: string | undefined;
     seed?: string | number | boolean | Date | (string | number | boolean | Date)[] | undefined;
     placeholder?: string | undefined;
+    defaultValue?: string | number | boolean | undefined;
 }>>;
 export declare const fieldScalarTransformer: FieldTransformer<FieldKindScalar, FieldScalarEnriched, FieldScalar>;
 export {};

package/dist/field/scalar.js

@@ -105,6 +105,7 @@ exports.zFieldScalarJSON = zod_1.z
     faker: Decoders.zFieldFaker,
     seed: Decoders.zFieldSeed,
     placeholder: Decoders.zFieldPropertyPlaceholder,
+    defaultValue: Decoders.zFieldPropertyDefaultValue,
 })
     .strict();
 const defaultPlaceholders = {
@@ -128,6 +129,50 @@ function fieldScalarJSONTransformer(fieldInput, ctx) {
     const label = fieldInput.label ?? (0, utils_1.toHumanReadable)(fieldInput.name);
     const placeholderFactory = defaultPlaceholders[scalarDatabaseType];
     const placeholder = fieldInput.placeholder ?? placeholderFactory?.(label) ?? `${label} here...`;
+    // Validate defaultValue type matches the field type
+    const defaultValue = fieldInput.defaultValue;
+    if (defaultValue !== undefined) {
+        switch (type) {
+            case 'string':
+                if (typeof defaultValue !== 'string') {
+                    ctx.addIssue({
+                        code: zod_1.z.ZodIssueCode.custom,
+                        message: `Default value for String field "${fieldInput.name}" must be a string, but got ${typeof defaultValue}.`,
+                    });
+                }
+                break;
+            case 'number':
+                if (typeof defaultValue !== 'number') {
+                    ctx.addIssue({
+                        code: zod_1.z.ZodIssueCode.custom,
+                        message: `Default value for numeric field "${fieldInput.name}" must be a number, but got ${typeof defaultValue}.`,
+                    });
+                }
+                break;
+            case 'boolean':
+                if (typeof defaultValue !== 'boolean') {
+                    ctx.addIssue({
+                        code: zod_1.z.ZodIssueCode.custom,
+                        message: `Default value for Boolean field "${fieldInput.name}" must be a boolean, but got ${typeof defaultValue}.`,
+                    });
+                }
+                break;
+            case 'Date':
+                if (typeof defaultValue !== 'string') {
+                    ctx.addIssue({
+                        code: zod_1.z.ZodIssueCode.custom,
+                        message: `Default value for DateTime field "${fieldInput.name}" must be an ISO date string, but got ${typeof defaultValue}.`,
+                    });
+                }
+                else if (isNaN(Date.parse(defaultValue))) {
+                    ctx.addIssue({
+                        code: zod_1.z.ZodIssueCode.custom,
+                        message: `Default value for DateTime field "${fieldInput.name}" must be a valid ISO 8601 date string, but got "${defaultValue}".`,
+                    });
+                }
+                break;
+        }
+    }
     return {
         type,
         kind: exports.fieldKindScalar,
@@ -149,12 +194,13 @@ function fieldScalarJSONTransformer(fieldInput, ctx) {
             min: undefined,
             max: undefined,
         },
+        defaultValue,
         seed: (0, seed_1.seedTransformer)(fieldInput, ctx),
         placeholder,
     };
 }
 exports.zFieldScalar = exports.zFieldScalarJSON.transform(fieldScalarJSONTransformer);
-const fieldScalarTransformer = ({ fieldInput: { type, validations, ...shared }, model: { name: modelName }, }) => {
+const fieldScalarTransformer = ({ fieldInput: { type, validations, defaultValue, ...shared }, model: { name: modelName }, }) => {
     switch (type) {
         case 'string':
             return {
@@ -162,6 +208,7 @@ const fieldScalarTransformer = ({ fieldInput: { type, validations, ...shared },
                 validations: {
                     maxLength: validations.maxLength,
                 },
+                defaultValue: defaultValue,
                 ...shared,
                 modelName,
             };
@@ -173,18 +220,21 @@ const fieldScalarTransformer = ({ fieldInput: { type, validations, ...shared },
                     min: validations.min,
                     max: validations.max,
                 },
+                defaultValue: defaultValue,
                 ...shared,
                 modelName,
             };
         case 'boolean':
             return {
                 type,
+                defaultValue: defaultValue,
                 ...shared,
                 modelName,
             };
         case 'Date':
             return {
                 type,
+                defaultValue: defaultValue,
                 ...shared,
                 modelName,
             };

package/dist/field/shared/decoders.d.ts

@@ -15,3 +15,4 @@ export declare const zFieldFaker: z.ZodOptional<z.ZodString>;
 export declare const zScalarValue: z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodDate]>;
 export declare const zFieldSeed: z.ZodOptional<z.ZodUnion<[z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodDate]>, z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodDate]>>]>>;
 export declare const zFieldPropertyPlaceholder: z.ZodOptional<z.ZodString>;
+export declare const zFieldPropertyDefaultValue: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>>;

package/dist/field/shared/decoders.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.zFieldPropertyPlaceholder = exports.zFieldSeed = exports.zScalarValue = exports.zFieldFaker = exports.zFieldPropertyMaxLength = exports.zFieldPropertyIsUpdatedAt = exports.zFieldPropertyIsCreatedAt = exports.zFieldPropertyHasIndex = exports.zFieldPropertyIsUnique = exports.zFieldPropertyIsReadonly = exports.zFieldPropertyDescription = exports.zFieldPropertyLabel = exports.zFieldPropertyExcelName = exports.zFieldPropertyDatabaseName = exports.zFieldPropertyType = exports.zFieldPropertyName = void 0;
+exports.zFieldPropertyDefaultValue = exports.zFieldPropertyPlaceholder = exports.zFieldSeed = exports.zScalarValue = exports.zFieldFaker = exports.zFieldPropertyMaxLength = exports.zFieldPropertyIsUpdatedAt = exports.zFieldPropertyIsCreatedAt = exports.zFieldPropertyHasIndex = exports.zFieldPropertyIsUnique = exports.zFieldPropertyIsReadonly = exports.zFieldPropertyDescription = exports.zFieldPropertyLabel = exports.zFieldPropertyExcelName = exports.zFieldPropertyDatabaseName = exports.zFieldPropertyType = exports.zFieldPropertyName = void 0;
 const zod_1 = require("zod");
 const utils_1 = require("@postxl/utils");
 exports.zFieldPropertyName = zod_1.z
@@ -88,3 +88,7 @@ exports.zFieldPropertyPlaceholder = zod_1.z
     .string()
     .optional()
     .describe('A generic placeholder that is used to pre-populate empty fields.');
+exports.zFieldPropertyDefaultValue = zod_1.z
+    .union([zod_1.z.string(), zod_1.z.number(), zod_1.z.boolean()])
+    .optional()
+    .describe('An optional default value for the field. Must match the field type: string for String fields, number for numeric fields, boolean for Boolean fields, ISO date string for DateTime fields.');

package/dist/index.d.ts

@@ -2,6 +2,7 @@ export { zProjectSchema } from './project-schema/project-schema.transformer';
 export * from './project-schema/project-schema.auth';
 export * from './project-schema/project-schema.brands';
 export * from './project-schema/project-schema.types';
+export { defaultProjectRoles } from './project-schema/project-schema.defaults';
 export type { ProjectSchemaJSON } from './project-schema/project-schema.json-decoder';
 export type * from './enum/enum.brands';
 export * from './enum/enum.defaults';

package/dist/index.js

@@ -14,12 +14,14 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.zProjectSchema = void 0;
+exports.defaultProjectRoles = exports.zProjectSchema = void 0;
 var project_schema_transformer_1 = require("./project-schema/project-schema.transformer");
 Object.defineProperty(exports, "zProjectSchema", { enumerable: true, get: function () { return project_schema_transformer_1.zProjectSchema; } });
 __exportStar(require("./project-schema/project-schema.auth"), exports);
 __exportStar(require("./project-schema/project-schema.brands"), exports);
 __exportStar(require("./project-schema/project-schema.types"), exports);
+var project_schema_defaults_1 = require("./project-schema/project-schema.defaults");
+Object.defineProperty(exports, "defaultProjectRoles", { enumerable: true, get: function () { return project_schema_defaults_1.defaultProjectRoles; } });
 __exportStar(require("./enum/enum.defaults"), exports);
 __exportStar(require("./field"), exports);
 __exportStar(require("./model/model.defaults"), exports);

package/dist/project-schema/project-schema.defaults.d.ts

@@ -7,6 +7,10 @@ export declare const databaseSchemaNameData: string & import("zod").$brand<"PXL.
  * The name of the schema that contains the configuration of the project.
  */
 export declare const databaseSchemaNameConfig: string & import("zod").$brand<"PXL.DatabaseSchemaName">;
+/**
+ * The default project roles. Can be overridden via `defaultRoles` in the project schema.
+ */
+export declare const defaultProjectRoles: readonly ["superadmin", "admin", "editor", "viewer"];
 export declare const defaultSystemUser: {
     id: string;
     sub: null;

package/dist/project-schema/project-schema.defaults.js

@@ -33,7 +33,7 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.defaultSystemUser = exports.databaseSchemaNameConfig = exports.databaseSchemaNameData = void 0;
+exports.defaultSystemUser = exports.defaultProjectRoles = exports.databaseSchemaNameConfig = exports.databaseSchemaNameData = void 0;
 const Branded = __importStar(require("./project-schema.brands"));
 /**
  * The name of the default data schema of the project.
@@ -44,6 +44,10 @@ exports.databaseSchemaNameData = Branded.toDatabaseSchemaName('Data');
  * The name of the schema that contains the configuration of the project.
  */
 exports.databaseSchemaNameConfig = Branded.toDatabaseSchemaName('PXL');
+/**
+ * The default project roles. Can be overridden via `defaultRoles` in the project schema.
+ */
+exports.defaultProjectRoles = ['superadmin', 'admin', 'editor', 'viewer'];
 exports.defaultSystemUser = {
     id: 'root',
     sub: null,

package/dist/project-schema/project-schema.json-decoder.d.ts

@@ -70,6 +70,7 @@ export declare const zProjectSchemaJSON: z.ZodPipe<z.ZodTransform<unknown, unkno
         }, z.core.$strip>>>;
     }, z.core.$strip>>;
     systemUser: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+    defaultRoles: z.ZodOptional<z.ZodArray<z.ZodString>>;
     standardModels: z.ZodOptional<z.ZodArray<z.ZodString>>;
     models: z.ZodOptional<z.ZodArray<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodObject<{
         name: z.ZodString;

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

@@ -124,6 +124,12 @@ exports.zProjectSchemaJSON = zod_1.z
         .record(zod_1.z.string(), zod_1.z.any())
         .optional()
         .describe('The system user that is used for root/system tasks, e.g. data seeding.'),
+    defaultRoles: zod_1.z
+        //
+        .array(zod_1.z.string().min(1, { error: 'Role must not be empty.' }))
+        .min(1, { error: 'defaultRoles must contain at least one role.' })
+        .optional()
+        .describe(`Override the default project roles. If not provided, the default roles ["superadmin", "admin", "editor", "viewer"] are used. Roles from auth rules are added on top of these defaults.`),
     standardModels: zod_1.z
         //
         .array(Model.zModelNameJSON)

package/dist/project-schema/project-schema.transformer.d.ts

@@ -49,6 +49,7 @@ export declare const zProjectSchema: z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown,
         }, z.core.$strip>>>;
     }, z.core.$strip>>;
     systemUser: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+    defaultRoles: z.ZodOptional<z.ZodArray<z.ZodString>>;
     standardModels: z.ZodOptional<z.ZodArray<z.ZodString>>;
     models: z.ZodOptional<z.ZodArray<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodObject<{
         name: z.ZodString;
@@ -153,6 +154,7 @@ export declare const zProjectSchema: z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown,
         }> | undefined;
     } | undefined;
     systemUser?: Record<string, any> | undefined;
+    defaultRoles?: string[] | undefined;
     standardModels?: string[] | undefined;
     models?: {
         name: string;

package/dist/project-schema/project-schema.transformer.js

@@ -100,6 +100,7 @@ function addDefaults(input) {
             ...project_schema_defaults_1.defaultSystemUser,
             ...input.systemUser,
         },
+        defaultRoles: input.defaultRoles ?? [...project_schema_defaults_1.defaultProjectRoles],
         standardModels: input.standardModels ?? Array.from(Object.values(Model.defaultModelNames)),
         models: input.models ?? new Map(),
         standardEnums: input.standardEnums ?? Array.from(Object.values(Enum.defaultEnumNames)),

package/dist/project-schema/project-schema.types.d.ts

@@ -40,6 +40,11 @@ export type ProjectSchema = {
      * If not provided, the default schema "Data" is used.
      */
     defaultDatabaseSchema: Branded.DatabaseSchemaName;
+    /**
+     * The default roles for this project. Roles from auth rules are added on top of these.
+     * If not provided in the schema, defaults to ['superadmin', 'admin', 'editor', 'viewer'].
+     */
+    defaultRoles: string[];
     /**
      * Global authorization configuration for this project.
      */