nextjs-cms 0.0.1 → 0.5.1

package/dist/core/fields/select.d.ts

@@ -0,0 +1,366 @@
+import type { BaseFieldConfig } from './field';
+import { Field } from './field';
+import { entityKind } from '../helpers';
+import type { CategorySection, HasItemsSection } from '../sections';
+import * as z from 'zod';
+export declare const selectOptionSchema: z.ZodObject<{
+    value: z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>;
+    label: z.ZodString;
+}, z.core.$strict>;
+export type SelectOption = z.infer<typeof selectOptionSchema>;
+export declare const selectFieldDestinationDbSchema: z.ZodObject<{
+    table: z.ZodString;
+    /**
+     * The identifier of the item that has this select field as a field
+     */
+    itemIdentifier: z.ZodString;
+    /**
+     * The identifier of the value of the select option that is coming from the select options
+     */
+    selectIdentifier: z.ZodString;
+}, z.core.$strict>;
+type SelectSectionOption = {
+    type: 'has_items' | 'category';
+    name: string;
+    depth?: number;
+    build(): HasItemsSection | CategorySection;
+};
+export declare const selectFieldSpecificConfigSchema: z.ZodUnion<readonly [z.ZodObject<{
+    destinationDb: z.ZodOptional<z.ZodObject<{
+        table: z.ZodString;
+        /**
+         * The identifier of the item that has this select field as a field
+         */
+        itemIdentifier: z.ZodString;
+        /**
+         * The identifier of the value of the select option that is coming from the select options
+         */
+        selectIdentifier: z.ZodString;
+    }, z.core.$strict>>;
+    checkValueExists: z.ZodOptional<z.ZodBoolean>;
+    options: z.ZodOptional<z.ZodNever>;
+    db: z.ZodObject<{
+        table: z.ZodString;
+        identifier: z.ZodString;
+        label: z.ZodString;
+        orderBy: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>;
+    section: z.ZodOptional<z.ZodNever>;
+}, z.core.$strict>, z.ZodObject<{
+    destinationDb: z.ZodOptional<z.ZodObject<{
+        table: z.ZodString;
+        /**
+         * The identifier of the item that has this select field as a field
+         */
+        itemIdentifier: z.ZodString;
+        /**
+         * The identifier of the value of the select option that is coming from the select options
+         */
+        selectIdentifier: z.ZodString;
+    }, z.core.$strict>>;
+    checkValueExists: z.ZodOptional<z.ZodBoolean>;
+    options: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        value: z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>;
+        label: z.ZodString;
+    }, z.core.$strict>>>;
+    db: z.ZodOptional<z.ZodNever>;
+    section: z.ZodCustom<SelectSectionOption, SelectSectionOption>;
+}, z.core.$strict>, z.ZodObject<{
+    destinationDb: z.ZodOptional<z.ZodObject<{
+        table: z.ZodString;
+        /**
+         * The identifier of the item that has this select field as a field
+         */
+        itemIdentifier: z.ZodString;
+        /**
+         * The identifier of the value of the select option that is coming from the select options
+         */
+        selectIdentifier: z.ZodString;
+    }, z.core.$strict>>;
+    checkValueExists: z.ZodOptional<z.ZodBoolean>;
+    options: z.ZodArray<z.ZodObject<{
+        value: z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>;
+        label: z.ZodString;
+    }, z.core.$strict>>;
+    db: z.ZodOptional<z.ZodNever>;
+    section: z.ZodOptional<z.ZodNever>;
+}, z.core.$strict>]>;
+export type SelectFieldConfig = z.infer<typeof selectFieldSpecificConfigSchema>;
+export declare class SelectField extends Field<'select', SelectFieldConfig> {
+    static readonly [entityKind]: string;
+    readonly checkValueExists: boolean;
+    readonly optionsType: 'db' | 'section' | 'static';
+    readonly db: {
+        table: string;
+        identifier: string;
+        label: string;
+        orderBy?: string;
+    };
+    readonly destinationDb?: {
+        table: string;
+        itemIdentifier: string;
+        selectIdentifier: string;
+    } | undefined;
+    value: SelectOption[] | undefined;
+    readonly section: SelectSectionOption | undefined;
+    private _itemIdentifier;
+    options: SelectOption[] | undefined;
+    private _allOptions;
+    constructor(config: BaseFieldConfig<SelectFieldConfig>);
+    /**
+     * @param value The value of a single select field,
+     * or values array of multiple select fields if the select is selecting from
+     * a category section with depth higher than 1.
+     */
+    setValue(value: string | SelectOption[] | undefined): void;
+    hasSqlNameAndValue(): boolean;
+    hasDepth(): boolean;
+    /**
+     * Get the value of the field
+     */
+    getValue(): SelectOption[] | undefined;
+    /**
+     * Get the value of the field when submitting to the database
+     */
+    getSubmitValue(): string | number | undefined;
+    exportForClient(): {
+        options: {
+            value: string | number;
+            label: string;
+        }[] | undefined;
+        section: {
+            name: string;
+            depth: number | undefined;
+        } | undefined;
+        /**
+         * Add the values with the level if present
+         */
+        value: {
+            level: number;
+            value: string | number;
+            label: string;
+        }[] | undefined;
+        type: "select";
+        name: string;
+        label: string;
+        required: boolean;
+        conditionalFields: import("../types").ConditionalField[];
+        readonly: boolean;
+        defaultValue: any;
+    };
+    postSubmit(itemId: string): Promise<void>;
+    postSubmitRollback(): Promise<void>;
+    /**
+     * Check the destination db config is set
+     * @private
+     */
+    private checkDestinationDBConfig;
+    /**
+     * Check if destination table and columns exist
+     * @private
+     */
+    private checkDestinationDBTableAndColumns;
+    /**
+     * Build the field to be used in a form
+     */
+    build(): Promise<void>;
+    private fetchOptions;
+    /**
+     * Check if table and columns exist
+     * @private
+     */
+    private checkDBTableAndColumns;
+    /**
+     * Check the db config is set
+     * @private
+     */
+    private checkDBConfig;
+    checkRequired(): void;
+    /**
+     * Prepare the field for submission
+     */
+    prepareForSubmission(): Promise<void>;
+}
+export type SelectFieldClientConfig = ReturnType<SelectField['exportForClient']>;
+export declare const selectFieldOptionsSchema: z.ZodUnion<readonly [z.ZodObject<{
+    destinationDb: z.ZodOptional<z.ZodObject<{
+        table: z.ZodString;
+        /**
+         * The identifier of the item that has this select field as a field
+         */
+        itemIdentifier: z.ZodString;
+        /**
+         * The identifier of the value of the select option that is coming from the select options
+         */
+        selectIdentifier: z.ZodString;
+    }, z.core.$strict>>;
+    checkValueExists: z.ZodOptional<z.ZodBoolean>;
+    options: z.ZodOptional<z.ZodNever>;
+    db: z.ZodObject<{
+        table: z.ZodString;
+        identifier: z.ZodString;
+        label: z.ZodString;
+        orderBy: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>;
+    section: z.ZodOptional<z.ZodNever>;
+    name: z.ZodString;
+    label: z.ZodOptional<z.ZodString>;
+    required: z.ZodOptional<z.ZodBoolean>;
+    defaultValue: z.ZodOptional<z.ZodAny>;
+    order: z.ZodOptional<z.ZodNumber>;
+    conditionalRules: z.ZodOptional<z.ZodArray<z.ZodCustom<import("../types").ConditionalRule, import("../types").ConditionalRule>>>;
+    adminGenerated: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<true>, z.ZodLiteral<false>, z.ZodLiteral<"readonly">]>>;
+}, z.core.$strict>, z.ZodObject<{
+    destinationDb: z.ZodOptional<z.ZodObject<{
+        table: z.ZodString;
+        /**
+         * The identifier of the item that has this select field as a field
+         */
+        itemIdentifier: z.ZodString;
+        /**
+         * The identifier of the value of the select option that is coming from the select options
+         */
+        selectIdentifier: z.ZodString;
+    }, z.core.$strict>>;
+    checkValueExists: z.ZodOptional<z.ZodBoolean>;
+    options: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        value: z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>;
+        label: z.ZodString;
+    }, z.core.$strict>>>;
+    db: z.ZodOptional<z.ZodNever>;
+    section: z.ZodCustom<SelectSectionOption, SelectSectionOption>;
+    name: z.ZodString;
+    label: z.ZodOptional<z.ZodString>;
+    required: z.ZodOptional<z.ZodBoolean>;
+    defaultValue: z.ZodOptional<z.ZodAny>;
+    order: z.ZodOptional<z.ZodNumber>;
+    conditionalRules: z.ZodOptional<z.ZodArray<z.ZodCustom<import("../types").ConditionalRule, import("../types").ConditionalRule>>>;
+    adminGenerated: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<true>, z.ZodLiteral<false>, z.ZodLiteral<"readonly">]>>;
+}, z.core.$strict>, z.ZodObject<{
+    destinationDb: z.ZodOptional<z.ZodObject<{
+        table: z.ZodString;
+        /**
+         * The identifier of the item that has this select field as a field
+         */
+        itemIdentifier: z.ZodString;
+        /**
+         * The identifier of the value of the select option that is coming from the select options
+         */
+        selectIdentifier: z.ZodString;
+    }, z.core.$strict>>;
+    checkValueExists: z.ZodOptional<z.ZodBoolean>;
+    options: z.ZodArray<z.ZodObject<{
+        value: z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>;
+        label: z.ZodString;
+    }, z.core.$strict>>;
+    db: z.ZodOptional<z.ZodNever>;
+    section: z.ZodOptional<z.ZodNever>;
+    name: z.ZodString;
+    label: z.ZodOptional<z.ZodString>;
+    required: z.ZodOptional<z.ZodBoolean>;
+    defaultValue: z.ZodOptional<z.ZodAny>;
+    order: z.ZodOptional<z.ZodNumber>;
+    conditionalRules: z.ZodOptional<z.ZodArray<z.ZodCustom<import("../types").ConditionalRule, import("../types").ConditionalRule>>>;
+    adminGenerated: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<true>, z.ZodLiteral<false>, z.ZodLiteral<"readonly">]>>;
+}, z.core.$strict>]>;
+declare const selectFieldConfigSchema: z.ZodIntersection<z.ZodUnion<readonly [z.ZodObject<{
+    destinationDb: z.ZodOptional<z.ZodObject<{
+        table: z.ZodString;
+        /**
+         * The identifier of the item that has this select field as a field
+         */
+        itemIdentifier: z.ZodString;
+        /**
+         * The identifier of the value of the select option that is coming from the select options
+         */
+        selectIdentifier: z.ZodString;
+    }, z.core.$strict>>;
+    checkValueExists: z.ZodOptional<z.ZodBoolean>;
+    options: z.ZodOptional<z.ZodNever>;
+    db: z.ZodObject<{
+        table: z.ZodString;
+        identifier: z.ZodString;
+        label: z.ZodString;
+        orderBy: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>;
+    section: z.ZodOptional<z.ZodNever>;
+    name: z.ZodString;
+    label: z.ZodOptional<z.ZodString>;
+    required: z.ZodOptional<z.ZodBoolean>;
+    defaultValue: z.ZodOptional<z.ZodAny>;
+    order: z.ZodOptional<z.ZodNumber>;
+    conditionalRules: z.ZodOptional<z.ZodArray<z.ZodCustom<import("../types").ConditionalRule, import("../types").ConditionalRule>>>;
+    adminGenerated: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<true>, z.ZodLiteral<false>, z.ZodLiteral<"readonly">]>>;
+}, z.core.$strict>, z.ZodObject<{
+    destinationDb: z.ZodOptional<z.ZodObject<{
+        table: z.ZodString;
+        /**
+         * The identifier of the item that has this select field as a field
+         */
+        itemIdentifier: z.ZodString;
+        /**
+         * The identifier of the value of the select option that is coming from the select options
+         */
+        selectIdentifier: z.ZodString;
+    }, z.core.$strict>>;
+    checkValueExists: z.ZodOptional<z.ZodBoolean>;
+    options: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        value: z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>;
+        label: z.ZodString;
+    }, z.core.$strict>>>;
+    db: z.ZodOptional<z.ZodNever>;
+    section: z.ZodCustom<SelectSectionOption, SelectSectionOption>;
+    name: z.ZodString;
+    label: z.ZodOptional<z.ZodString>;
+    required: z.ZodOptional<z.ZodBoolean>;
+    defaultValue: z.ZodOptional<z.ZodAny>;
+    order: z.ZodOptional<z.ZodNumber>;
+    conditionalRules: z.ZodOptional<z.ZodArray<z.ZodCustom<import("../types").ConditionalRule, import("../types").ConditionalRule>>>;
+    adminGenerated: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<true>, z.ZodLiteral<false>, z.ZodLiteral<"readonly">]>>;
+}, z.core.$strict>, z.ZodObject<{
+    destinationDb: z.ZodOptional<z.ZodObject<{
+        table: z.ZodString;
+        /**
+         * The identifier of the item that has this select field as a field
+         */
+        itemIdentifier: z.ZodString;
+        /**
+         * The identifier of the value of the select option that is coming from the select options
+         */
+        selectIdentifier: z.ZodString;
+    }, z.core.$strict>>;
+    checkValueExists: z.ZodOptional<z.ZodBoolean>;
+    options: z.ZodArray<z.ZodObject<{
+        value: z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>;
+        label: z.ZodString;
+    }, z.core.$strict>>;
+    db: z.ZodOptional<z.ZodNever>;
+    section: z.ZodOptional<z.ZodNever>;
+    name: z.ZodString;
+    label: z.ZodOptional<z.ZodString>;
+    required: z.ZodOptional<z.ZodBoolean>;
+    defaultValue: z.ZodOptional<z.ZodAny>;
+    order: z.ZodOptional<z.ZodNumber>;
+    conditionalRules: z.ZodOptional<z.ZodArray<z.ZodCustom<import("../types").ConditionalRule, import("../types").ConditionalRule>>>;
+    adminGenerated: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<true>, z.ZodLiteral<false>, z.ZodLiteral<"readonly">]>>;
+}, z.core.$strict>]>, z.ZodObject<{
+    type: z.ZodLiteral<"select">;
+    optionsType: z.ZodEnum<{
+        db: "db";
+        section: "section";
+        static: "static";
+    }>;
+    build: z.ZodFunction<z.core.$ZodFunctionArgs, z.ZodCustom<SelectField, SelectField>>;
+}, z.core.$strict>>;
+/**
+ * Select field configuration type
+ * This is a plain object that can be serialized and used anywhere.
+ */
+export type SelectFieldConfigType = z.infer<typeof selectFieldConfigSchema>;
+/**
+ * Helper function to create a select field configuration
+ * Returns a config object with a build() method that can be serialized and used anywhere.
+ */
+export declare function selectField(field: BaseFieldConfig<SelectFieldConfig>): SelectFieldConfigType;
+export {};
+//# sourceMappingURL=select.d.ts.map

package/dist/core/fields/select.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"select.d.ts","sourceRoot":"","sources":["../../../src/core/fields/select.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,SAAS,CAAA;AAC9C,OAAO,EAAE,KAAK,EAAyB,MAAM,SAAS,CAAA;AACtD,OAAO,EAAE,UAAU,EAAE,MAAM,YAAY,CAAA;AAMvC,OAAO,KAAK,EAAE,eAAe,EAAyB,eAAe,EAAyB,MAAM,aAAa,CAAA;AAEjH,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AAExB,eAAO,MAAM,kBAAkB;;;kBAG7B,CAAA;AAEF,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAA;AAE7D,eAAO,MAAM,8BAA8B;;IAEvC;;OAEG;;IAEH;;OAEG;;kBAEL,CAAA;AAEF,KAAK,mBAAmB,GAAG;IACvB,IAAI,EAAE,WAAW,GAAG,UAAU,CAAA;IAC9B,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,KAAK,IAAI,eAAe,GAAG,eAAe,CAAA;CAC7C,CAAA;AAoCD,eAAO,MAAM,+BAA+B;;;QAnDxC;;WAEG;;QAEH;;WAEG;;;;;;;;;;;;;;;QANH;;WAEG;;QAEH;;WAEG;;;;;;;;;;;;;QANH;;WAEG;;QAEH;;WAEG;;;;;;;;;;oBAiDL,CAAA;AAEF,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,+BAA+B,CAAC,CAAA;AAE/E,qBAAa,WAAY,SAAQ,KAAK,CAAC,QAAQ,EAAE,iBAAiB,CAAC;IAC/D,gBAAyB,CAAC,UAAU,CAAC,EAAE,MAAM,CAAgB;IAC7D,QAAQ,CAAC,gBAAgB,EAAE,OAAO,CAAA;IAClC,QAAQ,CAAC,WAAW,EAAE,IAAI,GAAG,SAAS,GAAG,QAAQ,CAAA;IACjD,QAAQ,CAAC,EAAE,EAAE;QACT,KAAK,EAAE,MAAM,CAAA;QACb,UAAU,EAAE,MAAM,CAAA;QAClB,KAAK,EAAE,MAAM,CAAA;QACb,OAAO,CAAC,EAAE,MAAM,CAAA;KACnB,CAAA;IACD,SAAkB,aAAa,CAAC,EAC1B;QACI,KAAK,EAAE,MAAM,CAAA;QACb,cAAc,EAAE,MAAM,CAAA;QACtB,gBAAgB,EAAE,MAAM,CAAA;KAC3B,GACD,SAAS,CAAY;IAClB,KAAK,EAAE,YAAY,EAAE,GAAG,SAAS,CAAY;IAEtD,QAAQ,CAAC,OAAO,EAAE,mBAAmB,GAAG,SAAS,CAAA;IACjD,OAAO,CAAC,eAAe,CAAoB;IAC3C,OAAO,EAAE,YAAY,EAAE,GAAG,SAAS,CAAA;IACnC,OAAO,CAAC,WAAW,CAA4B;gBACnC,MAAM,EAAE,eAAe,CAAC,iBAAiB,CAAC;IAqDtD;;;;OAIG;IACM,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,YAAY,EAAE,GAAG,SAAS;IA8C5C,kBAAkB,IAAI,OAAO;IAItC,QAAQ,IAAI,OAAO;IAI1B;;OAEG;IACH,QAAQ,IAAI,YAAY,EAAE,GAAG,SAAS;IAOtC;;OAEG;IACM,cAAc,IAAI,MAAM,GAAG,MAAM,GAAG,SAAS;IAQtC,eAAe;;;;;;;;;QAUvB;;WAEG;;;;;;;;;;;;;;IAKW,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAuDzC,kBAAkB,IAAI,OAAO,CAAC,IAAI,CAAC;IAuBzD;;;OAGG;IACH,OAAO,CAAC,wBAAwB;IAYhC;;;OAGG;YACW,iCAAiC;IAiB/C;;OAEG;IACY,KAAK;YAsBN,YAAY;IA4D1B;;;OAGG;YACW,sBAAsB;IASpC;;;OAGG;IACH,OAAO,CAAC,aAAa;IAUrB,aAAa;IAWb;;OAEG;IACG,oBAAoB;CAgC7B;AAED,MAAM,MAAM,uBAAuB,GAAG,UAAU,CAAC,WAAW,CAAC,iBAAiB,CAAC,CAAC,CAAA;AAehF,eAAO,MAAM,wBAAwB;;;QA1gBjC;;WAEG;;QAEH;;WAEG;;;;;;;;;;;;;;;;;;;;;;QANH;;WAEG;;QAEH;;WAEG;;;;;;;;;;;;;;;;;;;;QANH;;WAEG;;QAEH;;WAEG;;;;;;;;;;;;;;;;;oBAwgBL,CAAA;AAEF,QAAA,MAAM,uBAAuB;;;QAhhBzB;;WAEG;;QAEH;;WAEG;;;;;;;;;;;;;;;;;;;;;;QANH;;WAEG;;QAEH;;WAEG;;;;;;;;;;;;;;;;;;;;QANH;;WAEG;;QAEH;;WAEG;;;;;;;;;;;;;;;;;;;;;;;;;mBAihBN,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAA;AAE3E;;;GAGG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,eAAe,CAAC,iBAAiB,CAAC,GAAG,qBAAqB,CAgC5F"}