nextjs-cms 0.0.1 → 0.5.1

package/dist/core/sections/hasItems.js

@@ -0,0 +1,144 @@
+// import { Variant } from '@/lz/types'
+import { entityKind } from '../helpers';
+import { Section, baseHelperFunctionOptionsSchema, FieldGroupConfigSchema, fieldConfigSchema } from './section';
+import chalk from 'chalk';
+import * as z from 'zod';
+const configSchema = z.strictObject({
+    headingField: z
+        .custom()
+        .describe('Heading field must be a config - will be resolved during instantiation'),
+    title: z
+        .strictObject({
+        section: z.string().describe('The section title'),
+        singular: z.string().describe('The singular form of the title'),
+        plural: z.string().describe('The plural form of the title'),
+    })
+        .describe('The title configuration for the has items section'),
+    requirePublishPermission: z.boolean().optional().describe('Require publish permission'),
+    search: z
+        .strictObject({
+        searchFields: z
+            .array(z.custom())
+            .readonly()
+            .describe('Search fields must be configs - will be resolved during instantiation'),
+    })
+        .optional()
+        .describe('Search configuration'),
+    coverPhotoField: z
+        .custom()
+        .optional()
+        .describe('Cover photo field must be a config - will be resolved during instantiation'),
+    generateQR: z.boolean().optional().describe('Generate QR code'),
+});
+export class HasItemsSection extends Section {
+    static [entityKind] = 'HasItemsSection';
+    type = 'has_items';
+    headingField;
+    title;
+    requirePublishPermission;
+    search;
+    coverPhotoField;
+    generateQR;
+    // override variants?: Variant[] | undefined
+    constructor(config) {
+        super(config);
+        this.headingField = config.headingField;
+        this.title = config.title;
+        this.requirePublishPermission = config.requirePublishPermission ?? false;
+        this.search = config.search;
+        this.coverPhotoField = config.coverPhotoField;
+        this.generateQR = config.generateQR;
+    }
+}
+const optionsSchema = z.strictObject({
+    ...baseHelperFunctionOptionsSchema.shape,
+    ...configSchema.shape,
+});
+const compiledOptionsSchema = z.strictObject({
+    ...optionsSchema.shape,
+    fieldGroups: z.array(FieldGroupConfigSchema).optional().describe('The field groups of the section if provided'),
+});
+const hasItemsSectionConfigSchema = z.strictObject({
+    ...compiledOptionsSchema.shape,
+    type: z.literal('has_items').describe('The type of the section'),
+    fields: z.array(fieldConfigSchema).describe('The fields of the section'),
+    build: z
+        .function()
+        .output(z.instanceof(HasItemsSection))
+        .describe('Build a HasItemsSection instance from this config'),
+});
+/**
+ * Helper function to create a hasItems section configuration
+ * Returns a config object with a build() method that can be serialized and used anywhere
+ *
+ * @example
+ * ```typescript
+ * const sectionConfig = hasItemsSection({ name: 'posts', ... })
+ * const sectionInstance = sectionConfig.build()
+ * ```
+ *
+ * @param section
+ */
+export function hasItemsSection(section) {
+    /**
+     * Validate the section config
+     */
+    const result = optionsSchema.safeParse(section);
+    if (!result.success) {
+        throw new Error(`[Section: ${section.name}]: ${z.prettifyError(result.error)}`);
+    }
+    /**
+     * Resolve fields and fieldGroups
+     */
+    let fields = [];
+    let fieldGroups = [];
+    if (section.fields.length > 0) {
+        const firstInput = section.fields[0];
+        /**
+         * Check if the first item is a field group.
+         * We don't need to check every item,
+         * because zod already validated the fields array.
+         */
+        if (firstInput && 'fields' in firstInput) {
+            fieldGroups = section.fields;
+            fields = fieldGroups.flatMap((group) => group.fields);
+        }
+        else {
+            fields = section.fields;
+        }
+    }
+    else {
+        const message = `[Section: ${section.name}]: No fields or field groups provided.`;
+        console.log(chalk.red('--------------------------------'));
+        console.error(chalk.red.bold(message));
+        console.log('\n');
+        console.log(chalk.yellow('Please make sure to provide at least one input or field group in the section config.'));
+        console.log('\n');
+        console.log(chalk.red('--------------------------------'));
+        throw new Error(message);
+    }
+    /**
+     * Check for duplicate field names
+     */
+    const fieldNames = fields.map((field) => field.name);
+    const duplicates = fieldNames.filter((name, index) => fieldNames.indexOf(name) !== index);
+    if (duplicates.length > 0) {
+        const uniqueDuplicates = [...new Set(duplicates)];
+        const message = `${chalk.red.bold(` - ${chalk.underline(`[Section: ${section.name}]:`)} Duplicate field names detected: ${uniqueDuplicates.join(', ')}.`)}\n${chalk.yellow(' Field names must be unique. Please make sure every field name is unique in each section.')}`;
+        throw new Error(message);
+    }
+    const config = {
+        ...section,
+        fields,
+        fieldGroups: fieldGroups.length > 0 ? fieldGroups : undefined,
+        type: 'has_items',
+        build() {
+            return new HasItemsSection({
+                ...section,
+                fields,
+                fieldGroups: fieldGroups.length > 0 ? fieldGroups : undefined,
+            });
+        },
+    };
+    return config;
+}

package/dist/core/sections/index.d.ts

@@ -0,0 +1,5 @@
+export * from './simple';
+export * from './hasItems';
+export * from './category';
+export * from './section';
+//# sourceMappingURL=index.d.ts.map

package/dist/core/sections/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/core/sections/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAA;AACxB,cAAc,YAAY,CAAA;AAC1B,cAAc,YAAY,CAAA;AAC1B,cAAc,WAAW,CAAA"}

package/dist/core/sections/index.js

@@ -0,0 +1,4 @@
+export * from './simple';
+export * from './hasItems';
+export * from './category';
+export * from './section';

package/dist/core/sections/section.d.ts

@@ -0,0 +1,226 @@
+import { Field } from '../fields';
+import { entityKind } from '../helpers';
+import type { NumberFieldConfigType, TextFieldConfig } from '../fields';
+import type { Variant } from '../types';
+import type { FieldConfig } from '../fields';
+import type { FieldGroup, FieldGroupConfig } from '../fields/field-group';
+import * as z from 'zod';
+export declare const fieldConfigSchema: z.ZodCustom<FieldConfig, FieldConfig>;
+export declare const FieldGroupConfigSchema: z.ZodCustom<FieldGroupConfig, FieldGroupConfig>;
+export declare const baseSectionOptionsSchema: z.ZodObject<{
+    name: z.ZodString;
+    order: z.ZodNumber;
+    icon: z.ZodOptional<z.ZodString>;
+    readonly: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+    gallery: z.ZodOptional<z.ZodObject<{
+        db: z.ZodObject<{
+            tableName: z.ZodString;
+            identifierField: z.ZodOptional<z.ZodString>;
+            photoNameField: z.ZodOptional<z.ZodString>;
+            metaField: z.ZodOptional<z.ZodString>;
+        }, z.core.$strict>;
+        watermark: z.ZodOptional<z.ZodBoolean>;
+        thumbnail: z.ZodOptional<z.ZodObject<{
+            width: z.ZodNumber;
+            height: z.ZodNumber;
+            crop: z.ZodBoolean;
+            quality: z.ZodNumber;
+        }, z.core.$strict>>;
+    }, z.core.$strict>>;
+    db: z.ZodObject<{
+        table: z.ZodString;
+        identifier: z.ZodOptional<z.ZodCustom<FieldConfig, FieldConfig>>;
+        orderByField: z.ZodOptional<z.ZodCustom<FieldConfig, FieldConfig>>;
+        primaryKey: z.ZodOptional<z.ZodArray<z.ZodCustom<FieldConfig, FieldConfig>>>;
+        foreignKeys: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            columns: z.ZodArray<z.ZodCustom<FieldConfig, FieldConfig>>;
+            foreignColumns: z.ZodArray<z.ZodCustom<FieldConfig, FieldConfig>>;
+            name: z.ZodString;
+        }, z.core.$strict>>>;
+        index: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            columns: z.ZodArray<z.ZodCustom<FieldConfig, FieldConfig>>;
+            name: z.ZodOptional<z.ZodString>;
+        }, z.core.$strict>>>;
+        unique: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            columns: z.ZodArray<z.ZodCustom<FieldConfig, FieldConfig>>;
+            name: z.ZodOptional<z.ZodString>;
+        }, z.core.$strict>>>;
+        fulltext: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            columns: z.ZodArray<z.ZodCustom<FieldConfig, FieldConfig>>;
+            name: z.ZodOptional<z.ZodString>;
+        }, z.core.$strict>>>;
+    }, z.core.$strict>;
+    fields: z.ZodArray<z.ZodCustom<FieldConfig, FieldConfig>>;
+    fieldGroups: z.ZodOptional<z.ZodArray<z.ZodCustom<FieldGroupConfig, FieldGroupConfig>>>;
+    variants: z.ZodOptional<z.ZodArray<z.ZodCustom<Variant, Variant>>>;
+    hooks: z.ZodOptional<z.ZodCustom<Hooks, Hooks>>;
+}, z.core.$strict>;
+/**
+ * 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 declare const baseHelperFunctionOptionsSchema: z.ZodObject<{
+    fields: z.ZodUnion<[z.ZodArray<z.ZodCustom<FieldConfig, FieldConfig>>, z.ZodArray<z.ZodCustom<FieldGroupConfig, FieldGroupConfig>>]>;
+    variants: z.ZodOptional<z.ZodArray<z.ZodCustom<Variant, Variant>>>;
+    name: z.ZodString;
+    order: z.ZodNumber;
+    readonly: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+    db: z.ZodObject<{
+        table: z.ZodString;
+        identifier: z.ZodOptional<z.ZodCustom<FieldConfig, FieldConfig>>;
+        orderByField: z.ZodOptional<z.ZodCustom<FieldConfig, FieldConfig>>;
+        primaryKey: z.ZodOptional<z.ZodArray<z.ZodCustom<FieldConfig, FieldConfig>>>;
+        foreignKeys: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            columns: z.ZodArray<z.ZodCustom<FieldConfig, FieldConfig>>;
+            foreignColumns: z.ZodArray<z.ZodCustom<FieldConfig, FieldConfig>>;
+            name: z.ZodString;
+        }, z.core.$strict>>>;
+        index: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            columns: z.ZodArray<z.ZodCustom<FieldConfig, FieldConfig>>;
+            name: z.ZodOptional<z.ZodString>;
+        }, z.core.$strict>>>;
+        unique: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            columns: z.ZodArray<z.ZodCustom<FieldConfig, FieldConfig>>;
+            name: z.ZodOptional<z.ZodString>;
+        }, z.core.$strict>>>;
+        fulltext: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            columns: z.ZodArray<z.ZodCustom<FieldConfig, FieldConfig>>;
+            name: z.ZodOptional<z.ZodString>;
+        }, z.core.$strict>>>;
+    }, z.core.$strict>;
+    icon: z.ZodOptional<z.ZodString>;
+    gallery: z.ZodOptional<z.ZodObject<{
+        db: z.ZodObject<{
+            tableName: z.ZodString;
+            identifierField: z.ZodOptional<z.ZodString>;
+            photoNameField: z.ZodOptional<z.ZodString>;
+            metaField: z.ZodOptional<z.ZodString>;
+        }, z.core.$strict>;
+        watermark: z.ZodOptional<z.ZodBoolean>;
+        thumbnail: z.ZodOptional<z.ZodObject<{
+            width: z.ZodNumber;
+            height: z.ZodNumber;
+            crop: z.ZodBoolean;
+            quality: z.ZodNumber;
+        }, z.core.$strict>>;
+    }, z.core.$strict>>;
+    hooks: z.ZodOptional<z.ZodCustom<Hooks, Hooks>>;
+}, z.core.$strict>;
+export declare function validateSectionConfig(config: BaseSectionOptions): void;
+export type AfterUpdateContext = {
+    itemId?: string | number;
+    values: Record<string, unknown>;
+    section: Section;
+};
+export type Hooks = {
+    afterUpdate?: (ctx: AfterUpdateContext) => Promise<void> | void;
+};
+export declare abstract class Section<TExtraSectionConfig extends object = object> {
+    static readonly [entityKind]: string;
+    abstract readonly type: 'has_items' | 'simple' | 'category';
+    name: string;
+    order: number;
+    icon: string | undefined;
+    readonly: boolean;
+    gallery?: {
+        db: {
+            tableName: string;
+            referenceIdentifierField: string;
+            photoNameField: string;
+            metaField: string;
+        };
+        watermark?: boolean;
+        thumbnail?: {
+            width: number;
+            height: number;
+            crop: boolean;
+            quality: number;
+        };
+    };
+    private _fields;
+    private readonly _fieldGroupConfigs;
+    private readonly _hasFieldGroups;
+    private _fieldGroups;
+    protected _fieldConfigs: FieldConfig[] | undefined;
+    /**
+     * 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(): FieldConfig[];
+    get fieldGroups(): FieldGroup[];
+    get fields(): Field[];
+    set fields(value: Field[]);
+    readonly db: {
+        table: string;
+        identifier: NumberFieldConfigType | TextFieldConfig;
+        orderByField?: FieldConfig;
+        primaryKey: FieldConfig[];
+        foreignKeys?: {
+            columns: FieldConfig[];
+            foreignColumns: FieldConfig[];
+            name: string;
+        }[];
+        fulltext?: {
+            columns: FieldConfig[];
+            name?: string;
+        }[];
+        index?: {
+            columns: FieldConfig[];
+            name?: string;
+        }[];
+        unique: {
+            columns: FieldConfig[];
+            name?: string;
+        }[];
+    };
+    abstract title: any;
+    variants?: Variant[] | undefined;
+    hooks?: Hooks;
+    constructor(config: BaseSectionOptions<TExtraSectionConfig>);
+    /**
+     * Returns whether this section has field groups.
+     * Value is cached during construction for optimal performance.
+     */
+    private get hasFieldGroups();
+    private buildFieldGroups;
+    buildFields(): void;
+    /**
+     * 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
+     */
+    private resolveField;
+}
+export type BaseSectionOptions<TExtraSectionConfig extends object = object> = z.infer<typeof baseSectionOptionsSchema> & TExtraSectionConfig;
+/**
+ * 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 declare function ensureSectionDbIdentifier<T extends BaseSectionOptions>(section: T): T & {
+    db: T['db'] & {
+        identifier: FieldConfig;
+    };
+};
+/**
+ * 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 declare function ensureSectionGallery<T extends BaseSectionOptions>(section: T): T;
+export declare function resolveFieldsAndFieldGroups(config: {
+    fields: FieldConfig[];
+    fieldGroups: FieldGroupConfig[];
+}): {
+    fields: FieldConfig[];
+    fieldGroups: FieldGroupConfig[];
+};
+//# sourceMappingURL=section.d.ts.map

package/dist/core/sections/section.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"section.d.ts","sourceRoot":"","sources":["../../../src/core/sections/section.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,WAAW,CAAA;AACjC,OAAO,EAAE,UAAU,EAAE,MAAM,YAAY,CAAA;AACvC,OAAO,KAAK,EAAE,qBAAqB,EAAE,eAAe,EAAE,MAAM,WAAW,CAAA;AAEvE,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,UAAU,CAAA;AACvC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,WAAW,CAAA;AAE5C,OAAO,KAAK,EAAE,UAAU,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;AAEzE,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AAKxB,eAAO,MAAM,iBAAiB,uCAA0B,CAAA;AACxD,eAAO,MAAM,sBAAsB,iDAA+B,CAAA;AAIlE,eAAO,MAAM,wBAAwB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBAmEnC,CAAA;AAEF;;;;GAIG;AACH,eAAO,MAAM,+BAA+B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBAa1C,CAAA;AAEF,wBAAgB,qBAAqB,CAAC,MAAM,EAAE,kBAAkB,GAAG,IAAI,CAKtE;AAED,MAAM,MAAM,kBAAkB,GAAG;IAC7B,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IACxB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAC/B,OAAO,EAAE,OAAO,CAAA;CACnB,CAAA;AAED,MAAM,MAAM,KAAK,GAAG;IAChB,WAAW,CAAC,EAAE,CAAC,GAAG,EAAE,kBAAkB,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAA;CAClE,CAAA;AAED,8BAAsB,OAAO,CAAC,mBAAmB,SAAS,MAAM,GAAG,MAAM;IACrE,MAAM,CAAC,QAAQ,CAAC,CAAC,UAAU,CAAC,EAAE,MAAM,CAAY;IAChD,QAAQ,CAAC,QAAQ,CAAC,IAAI,EAAE,WAAW,GAAG,QAAQ,GAAG,UAAU,CAAA;IAC3D,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,GAAG,SAAS,CAAA;IACxB,QAAQ,UAAQ;IAChB,OAAO,CAAC,EAAE;QACN,EAAE,EAAE;YACA,SAAS,EAAE,MAAM,CAAA;YACjB,wBAAwB,EAAE,MAAM,CAAA;YAChC,cAAc,EAAE,MAAM,CAAA;YACtB,SAAS,EAAE,MAAM,CAAA;SACpB,CAAA;QACD,SAAS,CAAC,EAAE,OAAO,CAAA;QACnB,SAAS,CAAC,EAAE;YACR,KAAK,EAAE,MAAM,CAAA;YACb,MAAM,EAAE,MAAM,CAAA;YACd,IAAI,EAAE,OAAO,CAAA;YACb,OAAO,EAAE,MAAM,CAAA;SAClB,CAAA;KACJ,CAAA;IACD,OAAO,CAAC,OAAO,CAAiC;IAChD,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAA4C;IAC/E,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAS;IACzC,OAAO,CAAC,YAAY,CAAsC;IAC1D,SAAS,CAAC,aAAa,EAAE,WAAW,EAAE,GAAG,SAAS,CAAA;IAElD;;;OAGG;IACH,IAAI,YAAY,IAAI,WAAW,EAAE,CAEhC;IAED,IAAI,WAAW,IAAI,UAAU,EAAE,CAE9B;IAED,IAAI,MAAM,IAAI,KAAK,EAAE,CAYpB;IAED,IAAI,MAAM,CAAC,KAAK,EAAE,KAAK,EAAE,EAExB;IAED,QAAQ,CAAC,EAAE,EAAE;QACT,KAAK,EAAE,MAAM,CAAA;QACb,UAAU,EAAE,qBAAqB,GAAG,eAAe,CAAA;QACnD,YAAY,CAAC,EAAE,WAAW,CAAA;QAC1B,UAAU,EAAE,WAAW,EAAE,CAAA;QACzB,WAAW,CAAC,EAAE;YAAE,OAAO,EAAE,WAAW,EAAE,CAAC;YAAC,cAAc,EAAE,WAAW,EAAE,CAAC;YAAC,IAAI,EAAE,MAAM,CAAA;SAAE,EAAE,CAAA;QACvF,QAAQ,CAAC,EAAE;YAAE,OAAO,EAAE,WAAW,EAAE,CAAC;YAAC,IAAI,CAAC,EAAE,MAAM,CAAA;SAAE,EAAE,CAAA;QACtD,KAAK,CAAC,EAAE;YAAE,OAAO,EAAE,WAAW,EAAE,CAAC;YAAC,IAAI,CAAC,EAAE,MAAM,CAAA;SAAE,EAAE,CAAA;QACnD,MAAM,EAAE;YAAE,OAAO,EAAE,WAAW,EAAE,CAAC;YAAC,IAAI,CAAC,EAAE,MAAM,CAAA;SAAE,EAAE,CAAA;KACtD,CAAA;IACD,QAAQ,CAAC,KAAK,EAAE,GAAG,CAAA;IACnB,QAAQ,CAAC,EAAE,OAAO,EAAE,GAAG,SAAS,CAAA;IAChC,KAAK,CAAC,EAAE,KAAK,CAAA;gBAED,MAAM,EAAE,kBAAkB,CAAC,mBAAmB,CAAC;IAmF3D;;;OAGG;IACH,OAAO,KAAK,cAAc,GAEzB;IAED,OAAO,CAAC,gBAAgB;IAwBjB,WAAW,IAAI,IAAI;IAyB1B;;;;;;OAMG;IACH,OAAO,CAAC,YAAY;CAUvB;AAED,MAAM,MAAM,kBAAkB,CAAC,mBAAmB,SAAS,MAAM,GAAG,MAAM,IAAI,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,GAClH,mBAAmB,CAAA;AAEvB;;;;;;;GAOG;AACH,wBAAgB,yBAAyB,CAAC,CAAC,SAAS,kBAAkB,EAClE,OAAO,EAAE,CAAC,GACX,CAAC,GAAG;IAAE,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG;QAAE,UAAU,EAAE,WAAW,CAAA;KAAE,CAAA;CAAE,CAwBnD;AAED;;;;;;GAMG;AACH,wBAAgB,oBAAoB,CAAC,CAAC,SAAS,kBAAkB,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAmBhF;AAED,wBAAgB,2BAA2B,CAAC,MAAM,EAAE;IAAE,MAAM,EAAE,WAAW,EAAE,CAAC;IAAC,WAAW,EAAE,gBAAgB,EAAE,CAAA;CAAE,GAAG;IAC7G,MAAM,EAAE,WAAW,EAAE,CAAA;IACrB,WAAW,EAAE,gBAAgB,EAAE,CAAA;CAClC,CAYA"}