@postxl/schema 0.0.2

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

@@ -0,0 +1,285 @@
+import { z } from 'zod';
+export declare const zSchemaName: z.ZodString;
+export declare const zProjectSchemaJSON: z.ZodEffects<z.ZodObject<{
+    name: z.ZodString;
+    slug: z.ZodString;
+    description: z.ZodOptional<z.ZodString>;
+    projectType: z.ZodOptional<z.ZodUnion<[z.ZodObject<{
+        kind: z.ZodLiteral<"standalone">;
+    }, "strip", z.ZodTypeAny, {
+        kind: "standalone";
+    }, {
+        kind: "standalone";
+    }>, z.ZodObject<{
+        kind: z.ZodLiteral<"workspace">;
+        projectDirectory: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        kind: "workspace";
+        projectDirectory: string;
+    }, {
+        kind: "workspace";
+        projectDirectory: string;
+    }>]>>;
+    version: z.ZodOptional<z.ZodString>;
+    schemas: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    defaultSchema: z.ZodOptional<z.ZodString>;
+    systemUser: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+    standardModels: z.ZodOptional<z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">>;
+    models: z.ZodOptional<z.ZodArray<z.ZodEffects<z.ZodObject<{
+        name: z.ZodEffects<z.ZodString, string, string>;
+        description: z.ZodOptional<z.ZodString>;
+        isReadonly: z.ZodOptional<z.ZodBoolean>;
+        schema: z.ZodOptional<z.ZodString>;
+        databaseName: z.ZodOptional<z.ZodString>;
+        excelName: z.ZodEffects<z.ZodOptional<z.ZodString>, string | undefined, string | undefined>;
+        fields: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+        }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+            name: z.ZodString;
+        }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+            name: z.ZodString;
+        }, z.ZodTypeAny, "passthrough">>, "many">>;
+        standardFields: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        defaultField: z.ZodOptional<z.ZodString>;
+        labelField: z.ZodOptional<z.ZodString>;
+        indexes: z.ZodOptional<z.ZodArray<z.ZodArray<z.ZodBranded<z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, string, string>, "PXL.FieldName">, "many">, "many">>;
+        seed: z.ZodOptional<z.ZodArray<z.ZodAny, "many">>;
+        source: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        faker: z.ZodOptional<z.ZodObject<{
+            items: z.ZodOptional<z.ZodNumber>;
+            seed: z.ZodOptional<z.ZodNumber>;
+        }, "strip", z.ZodTypeAny, {
+            seed?: number | undefined;
+            items?: number | undefined;
+        }, {
+            seed?: number | undefined;
+            items?: number | undefined;
+        }>>;
+    }, "strip", z.ZodTypeAny, {
+        name: string;
+        description?: string | undefined;
+        schema?: string | undefined;
+        databaseName?: string | undefined;
+        excelName?: string | undefined;
+        isReadonly?: boolean | undefined;
+        faker?: {
+            seed?: number | undefined;
+            items?: number | undefined;
+        } | undefined;
+        seed?: any[] | undefined;
+        fields?: z.objectOutputType<{
+            name: z.ZodString;
+        }, z.ZodTypeAny, "passthrough">[] | undefined;
+        standardFields?: string[] | undefined;
+        defaultField?: string | undefined;
+        labelField?: string | undefined;
+        indexes?: (string & z.BRAND<"PXL.FieldName">)[][] | undefined;
+        source?: Record<string, unknown> | undefined;
+    }, {
+        name: string;
+        description?: string | undefined;
+        schema?: string | undefined;
+        databaseName?: string | undefined;
+        excelName?: string | undefined;
+        isReadonly?: boolean | undefined;
+        faker?: {
+            seed?: number | undefined;
+            items?: number | undefined;
+        } | undefined;
+        seed?: any[] | undefined;
+        fields?: z.objectInputType<{
+            name: z.ZodString;
+        }, z.ZodTypeAny, "passthrough">[] | undefined;
+        standardFields?: string[] | undefined;
+        defaultField?: string | undefined;
+        labelField?: string | undefined;
+        indexes?: string[][] | undefined;
+        source?: Record<string, unknown> | undefined;
+    }>, {
+        name: string;
+        description?: string | undefined;
+        schema?: string | undefined;
+        databaseName?: string | undefined;
+        excelName?: string | undefined;
+        isReadonly?: boolean | undefined;
+        faker?: {
+            seed?: number | undefined;
+            items?: number | undefined;
+        } | undefined;
+        seed?: any[] | undefined;
+        fields?: z.objectOutputType<{
+            name: z.ZodString;
+        }, z.ZodTypeAny, "passthrough">[] | undefined;
+        standardFields?: string[] | undefined;
+        defaultField?: string | undefined;
+        labelField?: string | undefined;
+        indexes?: (string & z.BRAND<"PXL.FieldName">)[][] | undefined;
+        source?: Record<string, unknown> | undefined;
+    }, unknown>, "many">>;
+    standardEnums: z.ZodOptional<z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">>;
+    enums: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        name: z.ZodEffects<z.ZodString, string, string>;
+        description: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+        schema: z.ZodOptional<z.ZodString>;
+        databaseName: z.ZodOptional<z.ZodString>;
+        members: z.ZodArray<z.ZodUnion<[z.ZodObject<{
+            value: z.ZodString;
+            description: z.ZodOptional<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            value: string;
+            description?: string | undefined;
+        }, {
+            value: string;
+            description?: string | undefined;
+        }>, z.ZodString]>, "many">;
+    }, "strip", z.ZodTypeAny, {
+        description: string;
+        name: string;
+        members: (string | {
+            value: string;
+            description?: string | undefined;
+        })[];
+        schema?: string | undefined;
+        databaseName?: string | undefined;
+    }, {
+        name: string;
+        members: (string | {
+            value: string;
+            description?: string | undefined;
+        })[];
+        description?: string | undefined;
+        schema?: string | undefined;
+        databaseName?: string | undefined;
+    }>, "many">>;
+    source: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    source: Record<string, unknown>;
+    slug: string;
+    description?: string | undefined;
+    version?: string | undefined;
+    projectType?: {
+        kind: "standalone";
+    } | {
+        kind: "workspace";
+        projectDirectory: string;
+    } | undefined;
+    schemas?: string[] | undefined;
+    defaultSchema?: string | undefined;
+    systemUser?: Record<string, any> | undefined;
+    standardModels?: string[] | undefined;
+    models?: {
+        name: string;
+        description?: string | undefined;
+        schema?: string | undefined;
+        databaseName?: string | undefined;
+        excelName?: string | undefined;
+        isReadonly?: boolean | undefined;
+        faker?: {
+            seed?: number | undefined;
+            items?: number | undefined;
+        } | undefined;
+        seed?: any[] | undefined;
+        fields?: z.objectOutputType<{
+            name: z.ZodString;
+        }, z.ZodTypeAny, "passthrough">[] | undefined;
+        standardFields?: string[] | undefined;
+        defaultField?: string | undefined;
+        labelField?: string | undefined;
+        indexes?: (string & z.BRAND<"PXL.FieldName">)[][] | undefined;
+        source?: Record<string, unknown> | undefined;
+    }[] | undefined;
+    standardEnums?: string[] | undefined;
+    enums?: {
+        description: string;
+        name: string;
+        members: (string | {
+            value: string;
+            description?: string | undefined;
+        })[];
+        schema?: string | undefined;
+        databaseName?: string | undefined;
+    }[] | undefined;
+}, {
+    name: string;
+    source: Record<string, unknown>;
+    slug: string;
+    description?: string | undefined;
+    version?: string | undefined;
+    projectType?: {
+        kind: "standalone";
+    } | {
+        kind: "workspace";
+        projectDirectory: string;
+    } | undefined;
+    schemas?: string[] | undefined;
+    defaultSchema?: string | undefined;
+    systemUser?: Record<string, any> | undefined;
+    standardModels?: string[] | undefined;
+    models?: unknown[] | undefined;
+    standardEnums?: string[] | undefined;
+    enums?: {
+        name: string;
+        members: (string | {
+            value: string;
+            description?: string | undefined;
+        })[];
+        description?: string | undefined;
+        schema?: string | undefined;
+        databaseName?: string | undefined;
+    }[] | undefined;
+}>, {
+    name: string;
+    source: Record<string, unknown>;
+    slug: string;
+    description?: string | undefined;
+    version?: string | undefined;
+    projectType?: {
+        kind: "standalone";
+    } | {
+        kind: "workspace";
+        projectDirectory: string;
+    } | undefined;
+    schemas?: string[] | undefined;
+    defaultSchema?: string | undefined;
+    systemUser?: Record<string, any> | undefined;
+    standardModels?: string[] | undefined;
+    models?: {
+        name: string;
+        description?: string | undefined;
+        schema?: string | undefined;
+        databaseName?: string | undefined;
+        excelName?: string | undefined;
+        isReadonly?: boolean | undefined;
+        faker?: {
+            seed?: number | undefined;
+            items?: number | undefined;
+        } | undefined;
+        seed?: any[] | undefined;
+        fields?: z.objectOutputType<{
+            name: z.ZodString;
+        }, z.ZodTypeAny, "passthrough">[] | undefined;
+        standardFields?: string[] | undefined;
+        defaultField?: string | undefined;
+        labelField?: string | undefined;
+        indexes?: (string & z.BRAND<"PXL.FieldName">)[][] | undefined;
+        source?: Record<string, unknown> | undefined;
+    }[] | undefined;
+    standardEnums?: string[] | undefined;
+    enums?: {
+        description: string;
+        name: string;
+        members: (string | {
+            value: string;
+            description?: string | undefined;
+        })[];
+        schema?: string | undefined;
+        databaseName?: string | undefined;
+    }[] | undefined;
+}, unknown>;
+/**
+ * The JSON format of a `ProjectSchema`
+ */
+export type ProjectSchemaJSON = Omit<z.infer<typeof zProjectSchemaJSON>, 'source'> & {
+    source?: Record<string, unknown>;
+};

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

@@ -0,0 +1,145 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.zProjectSchemaJSON = exports.zSchemaName = void 0;
+const zod_1 = require("zod");
+const utils_1 = require("@postxl/utils");
+const Enum = __importStar(require("../enum"));
+const Model = __importStar(require("../model"));
+exports.zSchemaName = zod_1.z
+    //
+    .string()
+    .min(1, 'Schema name must not be empty')
+    .regex(/^\w+$/, 'Schema name can only contain letters, numbers and underscores.')
+    .describe('Name of the database schema.');
+exports.zProjectSchemaJSON = zod_1.z
+    // We want to keep any extra fields that are not defined in the schema. However, these fields should
+    // not really be exposed as "main fields" of the parsed schema - instead, they should be nested under
+    // the `source` field. Zod does not expose the original input of an object (unless you use `.passthrough()`,
+    // but that would also expose the extra fields as main fields). So we need to preprocess the input to
+    // extract the `source` field.
+    .preprocess((input) => {
+    if (typeof input === 'object' && input !== null) {
+        const original = input;
+        return {
+            ...original,
+            // We omit models from the source fields as we keep the original input in model.source
+            // as part of the model schema.
+            source: (0, utils_1.omit)(original, 'models'),
+        };
+    }
+    return input;
+}, zod_1.z.object({
+    name: zod_1.z
+        //
+        .string()
+        .min(1, 'Name of the project must not be empty.')
+        .describe('Name of the project, e.g. "Client1 CRM System".'),
+    slug: zod_1.z
+        //
+        .string()
+        .min(1, 'Slug of the project must not be empty')
+        .regex(/^[a-z0-9-]+$/, 'Slug can only contain lowercase letters, numbers and dashes.')
+        .describe('Slug of the project, e.g. "client1-crm". '),
+    description: zod_1.z
+        //
+        .string()
+        .optional()
+        .describe('A helpful description of the project.'),
+    projectType: zod_1.z
+        //
+        .union([
+        zod_1.z.object({
+            kind: zod_1.z.literal('standalone'),
+        }),
+        zod_1.z.object({
+            kind: zod_1.z.literal('workspace'),
+            projectDirectory: zod_1.z
+                .string()
+                .min(1, 'Project directory must not be empty')
+                .describe('The project directory, without leading or trailing slash.'),
+        }),
+    ], (0, utils_1.unionErrorMessage)((data) => `Project type must be either ${(0, utils_1.yellow)('"standalone"')} or ${(0, utils_1.yellow)('"workspace"')} (with additional fields)! Instead, received ${(0, utils_1.red)(JSON.stringify(data))}.`))
+        .optional()
+        .describe('The type of the project, either "standalone" or "workspace".'),
+    version: zod_1.z
+        //
+        .string()
+        .min(1, 'Version of the project must not be empty')
+        .optional()
+        .describe('The version of the project/schema. Should follow semantic versioning, see https://semver.org/.'),
+    schemas: zod_1.z
+        //
+        .array(exports.zSchemaName)
+        .min(1, 'Schemas of the project must not be empty! If you want to use the default schemas, omit this field.')
+        .optional()
+        .describe('The database schemas that are used in the project. If not provided, the default schemas "PXL" and "Data" are used.'),
+    defaultSchema: exports.zSchemaName
+        //
+        .optional()
+        .describe(`The default database schema that is used if model/enum does not specify a schema. If not provided, the default schema "Data" is used.`),
+    systemUser: zod_1.z
+        //
+        .record(zod_1.z.any())
+        .optional()
+        .describe('The system user that is used for root/system tasks, e.g. data seeding.'),
+    standardModels: 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.
+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.`),
+    models: zod_1.z
+        //
+        .array(Model.zModelJSON)
+        .optional()
+        .describe('The models that are used in the project.'),
+    standardEnums: zod_1.z
+        //
+        .array(Enum.zEnumNameJSON)
+        .optional().describe(`Names of standard enums that should be included in the project.
+Currently, the following fields are supported: ActionStatus, MutationStatus, MutationKind.
+If not provided, all enums are included by default.
+
+If any of the standard enums are also provided in the \`enums\` array, the custom enums will take precedence.`),
+    enums: zod_1.z
+        //
+        .array(Enum.zEnumJSON)
+        .optional()
+        .describe('The enums that are used in the project.'),
+    source: zod_1.z.record(zod_1.z.string(), zod_1.z.unknown()),
+}));