nextjs-cms 0.5.9 → 0.5.11

package/dist/core/sections/section.js

@@ -1,341 +1,341 @@
-import { entityKind } from "../helpers.js";
-import { numberField } from "../fields.js";
-import chalk from 'chalk';
-import * as z from 'zod';
-import { getCMSConfig } from "../config/config-loader.js";
-const cmsConfig = getCMSConfig();
-export const fieldConfigSchema = z.custom();
-export const FieldGroupConfigSchema = z.custom();
-const variantSchema = z.custom();
-const hooksSchema = z.custom();
-export const baseSectionOptionsSchema = z.strictObject({
-    name: z.string().describe('The name of the section'),
-    order: z.number(),
-    icon: z.string().optional(),
-    readonly: z.boolean().default(false).optional(),
-    gallery: z
-        .strictObject({
-        db: z.strictObject({
-            tableName: z.string(),
-            identifierField: z.string().optional(),
-            photoNameField: z.string().optional(),
-            metaField: z.string().optional(),
-        }),
-        watermark: z.boolean().optional(),
-        thumbnail: z
-            .strictObject({
-            width: z.number(),
-            height: z.number(),
-            crop: z.boolean(),
-            quality: z.number(),
-        })
-            .optional(),
-    })
-        .optional(),
-    db: z.strictObject({
-        table: z.string(),
-        identifier: fieldConfigSchema.optional(),
-        orderByField: fieldConfigSchema.optional(),
-        primaryKey: z.array(fieldConfigSchema).optional(),
-        foreignKeys: z
-            .array(z.strictObject({
-            columns: z.array(fieldConfigSchema),
-            foreignColumns: z.array(fieldConfigSchema),
-            name: z.string(),
-        }))
-            .optional(),
-        index: z
-            .array(z.strictObject({
-            columns: z.array(fieldConfigSchema),
-            name: z.string().optional(),
-        }))
-            .optional(),
-        unique: z
-            .array(z.strictObject({
-            columns: z.array(fieldConfigSchema),
-            name: z.string().optional(),
-        }))
-            .optional(),
-        fulltext: z
-            .array(z.strictObject({
-            columns: z.array(fieldConfigSchema),
-            name: z.string().optional(),
-        }))
-            .optional(),
-    }),
-    fields: z.array(fieldConfigSchema),
-    fieldGroups: z.array(FieldGroupConfigSchema).optional(),
-    variants: z.array(variantSchema).optional(),
-    hooks: hooksSchema.optional(),
-});
-/**
- * This is the options schema for the helper functions that create section configs
- * We omit the fields and fieldGroups properties from the baseSectionOptionsSchema
- *  and change the fields to be an array of field configs or field group configs
- */
-export const baseHelperFunctionOptionsSchema = z.strictObject({
-    ...baseSectionOptionsSchema.omit({ fields: true, fieldGroups: true }).shape,
-    fields: z
-        .array(fieldConfigSchema)
-        .min(1)
-        .describe('The fields of the section')
-        .or(z
-        .array(FieldGroupConfigSchema)
-        .min(1)
-        .describe('The field groups of the section')
-        .describe('The fields or field groups of the section')),
-});
-export function validateSectionConfig(config) {
-    const result = baseSectionOptionsSchema.safeParse(config);
-    if (!result.success) {
-        throw new Error(result.error.message);
-    }
-}
-export class Section {
-    static [entityKind] = 'Section';
-    name;
-    order;
-    icon;
-    readonly = false;
-    gallery;
-    _fields = undefined;
-    _fieldGroupConfigs = undefined;
-    _hasFieldGroups;
-    _fieldGroups = undefined;
-    _fieldConfigs;
-    /**
-     * A helper property to access the field configs.
-     * Sometimes it's handy to access the field configs without building the actual fields array.
-     */
-    get fieldConfigs() {
-        return this._fieldConfigs ?? [];
-    }
-    get fieldGroups() {
-        return this._fieldGroups ?? [];
-    }
-    get fields() {
-        if (this._fields === undefined) {
-            const errorMessage = `Fields are not yer built for section "${this.name}". Please run buildFields() before accessing the fields property.`;
-            const reportMessage = 'If this is a system bug, please open a bug report on GitHub.';
-            console.error('\n');
-            console.error(chalk.bold.red('[Section Error]', errorMessage));
-            console.error(chalk.bold.bgRed(reportMessage));
-            console.error('\n');
-            throw new Error(errorMessage);
-        }
-        return this._fields;
-    }
-    set fields(value) {
-        this._fields = value;
-    }
-    db;
-    variants;
-    hooks;
-    constructor(config) {
-        // this.id = config.id
-        this.name = config.name;
-        this.order = config.order;
-        this.icon = config.icon;
-        this.readonly = config.readonly ?? false;
-        /**
-         * Resolve gallery config
-         */
-        if (config.gallery) {
-            this.gallery = {
-                db: {
-                    tableName: config.gallery.db.tableName,
-                    referenceIdentifierField: config.gallery.db.identifierField ?? 'reference_id',
-                    photoNameField: config.gallery.db.photoNameField ?? 'photo',
-                    metaField: config.gallery.db.metaField ?? 'meta',
-                },
-                watermark: config.gallery.watermark ?? cmsConfig.files.images.watermark,
-                thumbnail: config.gallery.thumbnail ?? cmsConfig.files.images.thumbnail,
-            };
-        }
-        /**
-         * Check for db identifier field config
-         */
-        if (!config.db.identifier) {
-            // Create default id field config
-            const idFieldConfig = numberField({
-                name: 'id',
-                label: 'ID',
-                required: true,
-                hasAutoIncrement: true,
-                order: 0,
-            });
-            config.db.identifier = idFieldConfig;
-            config.fields.unshift(idFieldConfig);
-        }
-        else {
-            /**
-             * Make sure the identifier field config is a number or text field config
-             */
-            if (config.db.identifier.type !== 'number' && config.db.identifier.type !== 'text') {
-                const message = `[Section: ${this.name}]: DB identifier field config must be a number or text field. Got type: ${config.db.identifier.type}`;
-                console.error(chalk.red.bold(message));
-                console.error(chalk.yellow('Please make sure the identifier field config is a number or text field.'));
-                throw new Error(message);
-            }
-        }
-        /**
-         * Resolve db configuration fields
-         * If user doesn't specify primaryKey, default to identifier field
-         */
-        this.db = {
-            table: config.db.table,
-            identifier: config.db.identifier,
-            orderByField: config.db.orderByField,
-            primaryKey: config.db.primaryKey ?? [config.db.identifier],
-            foreignKeys: config.db.foreignKeys,
-            fulltext: config.db.fulltext,
-            index: config.db.index,
-            unique: config.db.unique ?? [],
-        };
-        /**
-         * Add the identifier field to the unique array if it's not already there
-         */
-        if (!this.db.unique.some((unique) => unique.columns.includes(this.db.identifier))) {
-            /**
-             * Add the identifier field as the first item in the unique array
-             */
-            this.db.unique.unshift({ columns: [this.db.identifier] });
-        }
-        this._fieldConfigs = config.fields;
-        this._fieldGroupConfigs = config.fieldGroups;
-        // Cache the hasFieldGroups check once during construction (immutable after this point)
-        this._hasFieldGroups = (this._fieldGroupConfigs?.length ?? 0) > 0;
-        this.variants = config.variants;
-        this.hooks = config.hooks;
-    }
-    /**
-     * Returns whether this section has field groups.
-     * Value is cached during construction for optimal performance.
-     */
-    get hasFieldGroups() {
-        return this._hasFieldGroups;
-    }
-    buildFieldGroups() {
-        const configs = this._fieldGroupConfigs;
-        if (!configs?.length)
-            return;
-        const fieldGroups = [];
-        const fields = [];
-        configs.forEach((groupConfig, index) => {
-            const fields = groupConfig.fields.map((fieldConfig) => this.resolveField(fieldConfig));
-            fieldGroups.push({
-                id: index + 1,
-                title: groupConfig.title,
-                order: groupConfig.order,
-                fields,
-            });
-            fields.push(...fields);
-        });
-        this._fieldGroups = fieldGroups;
-        this._fields = fields;
-    }
-    buildFields() {
-        if (this.hasFieldGroups) {
-            this.buildFieldGroups();
-            return;
-        }
-        if (this._fieldConfigs === undefined) {
-            throw new Error(`This section: (${this.name}) has no fields. Please set at least one field.`);
-        }
-        this._fields = this._fieldConfigs.map((input) => this.resolveField(input));
-        /**
-         * Create one group to hold all the fields
-         */
-        this._fieldGroups = [
-            {
-                id: 1,
-                title: '',
-                order: 1,
-                fields: this._fields,
-            },
-        ];
-    }
-    /**
-     * Helper function to resolve a field config to an instance
-     * by calling the build() method on the config
-     * @param config - The field config to resolve
-     * @returns The field instance
-     * @throws An error if the field config does not have a build() method
-     */
-    resolveField(config) {
-        // Config must have a build() method
-        if (typeof config.build === 'function') {
-            return config.build();
-        }
-        throw new Error(`[Section: ${this.name}]: Field "${config.name}" config must have a build() method. Use helper functions like textField(), numberField(), etc. to create field configs.`);
-    }
-}
-/**
- * Helper function to ensure a section config has a db identifier field
- * If db.identifier is missing, creates a default 'id' number field config
- * and prepends it to fields and sets it as db.identifier
- *
- * @param section - Section config that may or may not have db.identifier
- * @returns Section config with db.identifier guaranteed to exist
- */
-export function ensureSectionDbIdentifier(section) {
-    // If identifier already exists, return as-is
-    if (section.db.identifier) {
-        return section;
-    }
-    // Create default id field config
-    const idFieldConfig = numberField({
-        name: 'id',
-        label: 'ID',
-        required: true,
-        hasAutoIncrement: true,
-        order: 0,
-    });
-    // Return modified config with identifier
-    return {
-        ...section,
-        fields: [idFieldConfig, ...section.fields],
-        db: {
-            ...section.db,
-            identifier: idFieldConfig,
-        },
-    };
-}
-/**
- * Helper function to normalize gallery config with default values
- * Sets defaults for identifierField, photoNameField, and metaField if not provided
- *
- * @param section - Section config that may or may not have gallery config
- * @returns Section config with normalized gallery config
- */
-export function ensureSectionGallery(section) {
-    // If no gallery config, return as-is
-    if (!section.gallery) {
-        return section;
-    }
-    // Return config with normalized gallery
-    return {
-        ...section,
-        gallery: {
-            ...section.gallery,
-            db: {
-                tableName: section.gallery.db.tableName,
-                identifierField: section.gallery.db.identifierField ?? 'reference_id',
-                photoNameField: section.gallery.db.photoNameField ?? 'photo',
-                metaField: section.gallery.db.metaField ?? 'meta',
-            },
-        },
-    };
-}
-export function resolveFieldsAndFieldGroups(config) {
-    if (config.fields.length) {
-        return {
-            fields: config.fields,
-            fieldGroups: [],
-        };
-    }
-    return {
-        fields: config.fieldGroups.flatMap((group) => group.fields),
-        fieldGroups: config.fieldGroups,
-    };
-}
+import { entityKind } from '../helpers/index.js';
+import { numberField } from '../fields/index.js';
+import chalk from 'chalk';
+import * as z from 'zod';
+import { getCMSConfig } from '../config/config-loader.js';
+const cmsConfig = getCMSConfig();
+export const fieldConfigSchema = z.custom();
+export const FieldGroupConfigSchema = z.custom();
+const variantSchema = z.custom();
+const hooksSchema = z.custom();
+export const baseSectionOptionsSchema = z.strictObject({
+    name: z.string().describe('The name of the section'),
+    order: z.number(),
+    icon: z.string().optional(),
+    readonly: z.boolean().default(false).optional(),
+    gallery: z
+        .strictObject({
+        db: z.strictObject({
+            tableName: z.string(),
+            identifierField: z.string().optional(),
+            photoNameField: z.string().optional(),
+            metaField: z.string().optional(),
+        }),
+        watermark: z.boolean().optional(),
+        thumbnail: z
+            .strictObject({
+            width: z.number(),
+            height: z.number(),
+            crop: z.boolean(),
+            quality: z.number(),
+        })
+            .optional(),
+    })
+        .optional(),
+    db: z.strictObject({
+        table: z.string(),
+        identifier: fieldConfigSchema.optional(),
+        orderByField: fieldConfigSchema.optional(),
+        primaryKey: z.array(fieldConfigSchema).optional(),
+        foreignKeys: z
+            .array(z.strictObject({
+            columns: z.array(fieldConfigSchema),
+            foreignColumns: z.array(fieldConfigSchema),
+            name: z.string(),
+        }))
+            .optional(),
+        index: z
+            .array(z.strictObject({
+            columns: z.array(fieldConfigSchema),
+            name: z.string().optional(),
+        }))
+            .optional(),
+        unique: z
+            .array(z.strictObject({
+            columns: z.array(fieldConfigSchema),
+            name: z.string().optional(),
+        }))
+            .optional(),
+        fulltext: z
+            .array(z.strictObject({
+            columns: z.array(fieldConfigSchema),
+            name: z.string().optional(),
+        }))
+            .optional(),
+    }),
+    fields: z.array(fieldConfigSchema),
+    fieldGroups: z.array(FieldGroupConfigSchema).optional(),
+    variants: z.array(variantSchema).optional(),
+    hooks: hooksSchema.optional(),
+});
+/**
+ * This is the options schema for the helper functions that create section configs
+ * We omit the fields and fieldGroups properties from the baseSectionOptionsSchema
+ *  and change the fields to be an array of field configs or field group configs
+ */
+export const baseHelperFunctionOptionsSchema = z.strictObject({
+    ...baseSectionOptionsSchema.omit({ fields: true, fieldGroups: true }).shape,
+    fields: z
+        .array(fieldConfigSchema)
+        .min(1)
+        .describe('The fields of the section')
+        .or(z
+        .array(FieldGroupConfigSchema)
+        .min(1)
+        .describe('The field groups of the section')
+        .describe('The fields or field groups of the section')),
+});
+export function validateSectionConfig(config) {
+    const result = baseSectionOptionsSchema.safeParse(config);
+    if (!result.success) {
+        throw new Error(result.error.message);
+    }
+}
+export class Section {
+    static [entityKind] = 'Section';
+    name;
+    order;
+    icon;
+    readonly = false;
+    gallery;
+    _fields = undefined;
+    _fieldGroupConfigs = undefined;
+    _hasFieldGroups;
+    _fieldGroups = undefined;
+    _fieldConfigs;
+    /**
+     * A helper property to access the field configs.
+     * Sometimes it's handy to access the field configs without building the actual fields array.
+     */
+    get fieldConfigs() {
+        return this._fieldConfigs ?? [];
+    }
+    get fieldGroups() {
+        return this._fieldGroups ?? [];
+    }
+    get fields() {
+        if (this._fields === undefined) {
+            const errorMessage = `Fields are not yer built for section "${this.name}". Please run buildFields() before accessing the fields property.`;
+            const reportMessage = 'If this is a system bug, please open a bug report on GitHub.';
+            console.error('\n');
+            console.error(chalk.bold.red('[Section Error]', errorMessage));
+            console.error(chalk.bold.bgRed(reportMessage));
+            console.error('\n');
+            throw new Error(errorMessage);
+        }
+        return this._fields;
+    }
+    set fields(value) {
+        this._fields = value;
+    }
+    db;
+    variants;
+    hooks;
+    constructor(config) {
+        // this.id = config.id
+        this.name = config.name;
+        this.order = config.order;
+        this.icon = config.icon;
+        this.readonly = config.readonly ?? false;
+        /**
+         * Resolve gallery config
+         */
+        if (config.gallery) {
+            this.gallery = {
+                db: {
+                    tableName: config.gallery.db.tableName,
+                    referenceIdentifierField: config.gallery.db.identifierField ?? 'reference_id',
+                    photoNameField: config.gallery.db.photoNameField ?? 'photo',
+                    metaField: config.gallery.db.metaField ?? 'meta',
+                },
+                watermark: config.gallery.watermark ?? cmsConfig.files.images.watermark,
+                thumbnail: config.gallery.thumbnail ?? cmsConfig.files.images.thumbnail,
+            };
+        }
+        /**
+         * Check for db identifier field config
+         */
+        if (!config.db.identifier) {
+            // Create default id field config
+            const idFieldConfig = numberField({
+                name: 'id',
+                label: 'ID',
+                required: true,
+                hasAutoIncrement: true,
+                order: 0,
+            });
+            config.db.identifier = idFieldConfig;
+            config.fields.unshift(idFieldConfig);
+        }
+        else {
+            /**
+             * Make sure the identifier field config is a number or text field config
+             */
+            if (config.db.identifier.type !== 'number' && config.db.identifier.type !== 'text') {
+                const message = `[Section: ${this.name}]: DB identifier field config must be a number or text field. Got type: ${config.db.identifier.type}`;
+                console.error(chalk.red.bold(message));
+                console.error(chalk.yellow('Please make sure the identifier field config is a number or text field.'));
+                throw new Error(message);
+            }
+        }
+        /**
+         * Resolve db configuration fields
+         * If user doesn't specify primaryKey, default to identifier field
+         */
+        this.db = {
+            table: config.db.table,
+            identifier: config.db.identifier,
+            orderByField: config.db.orderByField,
+            primaryKey: config.db.primaryKey ?? [config.db.identifier],
+            foreignKeys: config.db.foreignKeys,
+            fulltext: config.db.fulltext,
+            index: config.db.index,
+            unique: config.db.unique ?? [],
+        };
+        /**
+         * Add the identifier field to the unique array if it's not already there
+         */
+        if (!this.db.unique.some((unique) => unique.columns.includes(this.db.identifier))) {
+            /**
+             * Add the identifier field as the first item in the unique array
+             */
+            this.db.unique.unshift({ columns: [this.db.identifier] });
+        }
+        this._fieldConfigs = config.fields;
+        this._fieldGroupConfigs = config.fieldGroups;
+        // Cache the hasFieldGroups check once during construction (immutable after this point)
+        this._hasFieldGroups = (this._fieldGroupConfigs?.length ?? 0) > 0;
+        this.variants = config.variants;
+        this.hooks = config.hooks;
+    }
+    /**
+     * Returns whether this section has field groups.
+     * Value is cached during construction for optimal performance.
+     */
+    get hasFieldGroups() {
+        return this._hasFieldGroups;
+    }
+    buildFieldGroups() {
+        const configs = this._fieldGroupConfigs;
+        if (!configs?.length)
+            return;
+        const fieldGroups = [];
+        const fields = [];
+        configs.forEach((groupConfig, index) => {
+            const fields = groupConfig.fields.map((fieldConfig) => this.resolveField(fieldConfig));
+            fieldGroups.push({
+                id: index + 1,
+                title: groupConfig.title,
+                order: groupConfig.order,
+                fields,
+            });
+            fields.push(...fields);
+        });
+        this._fieldGroups = fieldGroups;
+        this._fields = fields;
+    }
+    buildFields() {
+        if (this.hasFieldGroups) {
+            this.buildFieldGroups();
+            return;
+        }
+        if (this._fieldConfigs === undefined) {
+            throw new Error(`This section: (${this.name}) has no fields. Please set at least one field.`);
+        }
+        this._fields = this._fieldConfigs.map((input) => this.resolveField(input));
+        /**
+         * Create one group to hold all the fields
+         */
+        this._fieldGroups = [
+            {
+                id: 1,
+                title: '',
+                order: 1,
+                fields: this._fields,
+            },
+        ];
+    }
+    /**
+     * Helper function to resolve a field config to an instance
+     * by calling the build() method on the config
+     * @param config - The field config to resolve
+     * @returns The field instance
+     * @throws An error if the field config does not have a build() method
+     */
+    resolveField(config) {
+        // Config must have a build() method
+        if (typeof config.build === 'function') {
+            return config.build();
+        }
+        throw new Error(`[Section: ${this.name}]: Field "${config.name}" config must have a build() method. Use helper functions like textField(), numberField(), etc. to create field configs.`);
+    }
+}
+/**
+ * Helper function to ensure a section config has a db identifier field
+ * If db.identifier is missing, creates a default 'id' number field config
+ * and prepends it to fields and sets it as db.identifier
+ *
+ * @param section - Section config that may or may not have db.identifier
+ * @returns Section config with db.identifier guaranteed to exist
+ */
+export function ensureSectionDbIdentifier(section) {
+    // If identifier already exists, return as-is
+    if (section.db.identifier) {
+        return section;
+    }
+    // Create default id field config
+    const idFieldConfig = numberField({
+        name: 'id',
+        label: 'ID',
+        required: true,
+        hasAutoIncrement: true,
+        order: 0,
+    });
+    // Return modified config with identifier
+    return {
+        ...section,
+        fields: [idFieldConfig, ...section.fields],
+        db: {
+            ...section.db,
+            identifier: idFieldConfig,
+        },
+    };
+}
+/**
+ * Helper function to normalize gallery config with default values
+ * Sets defaults for identifierField, photoNameField, and metaField if not provided
+ *
+ * @param section - Section config that may or may not have gallery config
+ * @returns Section config with normalized gallery config
+ */
+export function ensureSectionGallery(section) {
+    // If no gallery config, return as-is
+    if (!section.gallery) {
+        return section;
+    }
+    // Return config with normalized gallery
+    return {
+        ...section,
+        gallery: {
+            ...section.gallery,
+            db: {
+                tableName: section.gallery.db.tableName,
+                identifierField: section.gallery.db.identifierField ?? 'reference_id',
+                photoNameField: section.gallery.db.photoNameField ?? 'photo',
+                metaField: section.gallery.db.metaField ?? 'meta',
+            },
+        },
+    };
+}
+export function resolveFieldsAndFieldGroups(config) {
+    if (config.fields.length) {
+        return {
+            fields: config.fields,
+            fieldGroups: [],
+        };
+    }
+    return {
+        fields: config.fieldGroups.flatMap((group) => group.fields),
+        fieldGroups: config.fieldGroups,
+    };
+}