@webiny/api-headless-cms 0.0.0-unstable.e6f0dc8ca7 → 0.0.0-unstable.e9333b3f0b

package/features/modelBuilder/fields/BooleanFieldType.js

@@ -1,26 +1,27 @@
 import { FieldType } from "./abstractions.js";
 import { DataFieldBuilder } from "./FieldBuilder.js";
 class BooleanFieldBuilder extends DataFieldBuilder {
-  constructor() {
-    super("boolean");
-  }
-  defaultValue(value) {
-    this.config.settings = this.config.settings || {};
-    this.config.settings.defaultValue = value;
-    return this;
-  }
+    constructor(){
+        super("boolean");
+    }
+    defaultValue(value) {
+        this.config.settings = this.config.settings || {};
+        this.config.settings.defaultValue = value;
+        return this;
+    }
 }
 class BooleanFieldTypeFactory {
-  type = "boolean";
-  create() {
-    return new BooleanFieldBuilder();
-  }
+    create() {
+        return new BooleanFieldBuilder();
+    }
+    constructor(){
+        this.type = "boolean";
+    }
 }
-export const BooleanFieldType = FieldType.createImplementation({
-  implementation: BooleanFieldTypeFactory,
-  dependencies: []
+const BooleanFieldType = FieldType.createImplementation({
+    implementation: BooleanFieldTypeFactory,
+    dependencies: []
 });
-
-// Module augmentation for TypeScript autocomplete
+export { BooleanFieldType };
 
 //# sourceMappingURL=BooleanFieldType.js.map

package/features/modelBuilder/fields/BooleanFieldType.js.map

@@ -1 +1 @@
-{"version":3,"names":["FieldType","DataFieldBuilder","BooleanFieldBuilder","constructor","defaultValue","value","config","settings","BooleanFieldTypeFactory","type","create","BooleanFieldType","createImplementation","implementation","dependencies"],"sources":["BooleanFieldType.ts"],"sourcesContent":["import { FieldType, type IFieldTypeFactory } from \"./abstractions.js\";\nimport { DataFieldBuilder } from \"./FieldBuilder.js\";\n\nexport interface IBooleanFieldBuilder extends DataFieldBuilder<\"boolean\"> {\n    defaultValue(value: boolean): this;\n}\n\nclass BooleanFieldBuilder extends DataFieldBuilder<\"boolean\"> implements IBooleanFieldBuilder {\n    public constructor() {\n        super(\"boolean\");\n    }\n\n    override defaultValue(value: boolean): this {\n        this.config.settings = this.config.settings || {};\n        this.config.settings.defaultValue = value;\n        return this;\n    }\n}\n\nclass BooleanFieldTypeFactory implements IFieldTypeFactory {\n    readonly type = \"boolean\";\n\n    create(): IBooleanFieldBuilder {\n        return new BooleanFieldBuilder();\n    }\n}\n\nexport const BooleanFieldType = FieldType.createImplementation({\n    implementation: BooleanFieldTypeFactory,\n    dependencies: []\n});\n\n// Module augmentation for TypeScript autocomplete\ndeclare module \"../abstractions.js\" {\n    interface IFieldBuilderRegistry {\n        boolean(): IBooleanFieldBuilder;\n    }\n}\n"],"mappings":"AAAA,SAASA,SAAS;AAClB,SAASC,gBAAgB;AAMzB,MAAMC,mBAAmB,SAASD,gBAAgB,CAA4C;EACnFE,WAAWA,CAAA,EAAG;IACjB,KAAK,CAAC,SAAS,CAAC;EACpB;EAESC,YAAYA,CAACC,KAAc,EAAQ;IACxC,IAAI,CAACC,MAAM,CAACC,QAAQ,GAAG,IAAI,CAACD,MAAM,CAACC,QAAQ,IAAI,CAAC,CAAC;IACjD,IAAI,CAACD,MAAM,CAACC,QAAQ,CAACH,YAAY,GAAGC,KAAK;IACzC,OAAO,IAAI;EACf;AACJ;AAEA,MAAMG,uBAAuB,CAA8B;EAC9CC,IAAI,GAAG,SAAS;EAEzBC,MAAMA,CAAA,EAAyB;IAC3B,OAAO,IAAIR,mBAAmB,CAAC,CAAC;EACpC;AACJ;AAEA,OAAO,MAAMS,gBAAgB,GAAGX,SAAS,CAACY,oBAAoB,CAAC;EAC3DC,cAAc,EAAEL,uBAAuB;EACvCM,YAAY,EAAE;AAClB,CAAC,CAAC;;AAEF","ignoreList":[]}
+{"version":3,"file":"features/modelBuilder/fields/BooleanFieldType.js","sources":["../../../../src/features/modelBuilder/fields/BooleanFieldType.ts"],"sourcesContent":["import { FieldType, type IFieldTypeFactory } from \"./abstractions.js\";\nimport { DataFieldBuilder } from \"./FieldBuilder.js\";\n\nexport interface IBooleanFieldBuilder extends DataFieldBuilder<\"boolean\"> {\n    defaultValue(value: boolean): this;\n}\n\nclass BooleanFieldBuilder extends DataFieldBuilder<\"boolean\"> implements IBooleanFieldBuilder {\n    public constructor() {\n        super(\"boolean\");\n    }\n\n    override defaultValue(value: boolean): this {\n        this.config.settings = this.config.settings || {};\n        this.config.settings.defaultValue = value;\n        return this;\n    }\n}\n\nclass BooleanFieldTypeFactory implements IFieldTypeFactory {\n    readonly type = \"boolean\";\n\n    create(): IBooleanFieldBuilder {\n        return new BooleanFieldBuilder();\n    }\n}\n\nexport const BooleanFieldType = FieldType.createImplementation({\n    implementation: BooleanFieldTypeFactory,\n    dependencies: []\n});\n\n// Module augmentation for TypeScript autocomplete\ndeclare module \"../abstractions.js\" {\n    interface IFieldBuilderRegistry {\n        boolean(): IBooleanFieldBuilder;\n    }\n}\n"],"names":["BooleanFieldBuilder","DataFieldBuilder","value","BooleanFieldTypeFactory","BooleanFieldType","FieldType"],"mappings":";;AAOA,MAAMA,4BAA4BC;IAC9B,aAAqB;QACjB,KAAK,CAAC;IACV;IAES,aAAaC,KAAc,EAAQ;QACxC,IAAI,CAAC,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,IAAI,CAAC;QAChD,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,YAAY,GAAGA;QACpC,OAAO,IAAI;IACf;AACJ;AAEA,MAAMC;IAGF,SAA+B;QAC3B,OAAO,IAAIH;IACf;;aAJS,IAAI,GAAG;;AAKpB;AAEO,MAAMI,mBAAmBC,UAAU,oBAAoB,CAAC;IAC3D,gBAAgBF;IAChB,cAAc,EAAE;AACpB"}

package/features/modelBuilder/fields/DataFieldBuilder.d.ts

@@ -25,15 +25,18 @@ export interface IFieldRendererRegistry {
     dateTimeInputs: {
         fieldType: "datetime";
         settings?: {
-            multiValue?: {
-                addValueButtonLabel?: string;
-            };
+            addItemLabel?: string;
         };
     };
     dynamicZone: {
         fieldType: "dynamicZone";
         settings?: {
+            /** Whether the accordion is expanded by default. */
             open?: boolean;
+            /** Wrap the zone in a container panel. Set to `false` for a flat inline layout. */
+            container?: boolean;
+            /** Label for the "add item" button (defaults to "Add Item"). */
+            addItemLabel?: string;
         };
     };
     hidden: {
@@ -47,9 +50,7 @@ export interface IFieldRendererRegistry {
     lexicalEditors: {
         fieldType: "rich-text";
         settings?: {
-            multiValue?: {
-                addValueButtonLabel?: string;
-            };
+            addItemLabel?: string;
         };
     };
     textarea: {
@@ -59,9 +60,7 @@ export interface IFieldRendererRegistry {
     textareas: {
         fieldType: "long-text";
         settings: {
-            multiValue?: {
-                addValueButtonLabel?: string;
-            };
+            addItemLabel?: string;
         };
     };
     numberInput: {
@@ -71,24 +70,35 @@ export interface IFieldRendererRegistry {
     numberInputs: {
         fieldType: "number";
         settings?: {
-            multiValue?: {
-                addValueButtonLabel?: string;
-            };
+            addItemLabel?: string;
         };
     };
     objectAccordionSingle: {
         fieldType: "object";
         settings?: {
+            /** Whether the accordion is expanded by default. */
             open?: boolean;
+            /** Wrap the object in a container panel. Set to `false` for a flat inline layout. */
+            container?: boolean;
+            /** Field ID whose value is used as the accordion title, or a function receiving the object data. */
+            itemTitle?: string;
+            /** Field ID whose value is used as the accordion description, or a function receiving the object data. */
+            itemDescription?: string;
         };
     };
     objectAccordionMultiple: {
         fieldType: "object";
         settings?: {
+            /** Whether each accordion item is expanded by default. */
             open?: boolean;
-            multiValue?: {
-                addValueButtonLabel?: string;
-            };
+            /** Wrap the list in a container panel. Set to `false` for a flat inline layout. */
+            container?: boolean;
+            /** Field ID whose value is used as each item's accordion title. */
+            itemTitle?: string;
+            /** Field ID whose value is used as each item's accordion description. */
+            itemDescription?: string;
+            /** Label for the "add item" button (defaults to "Add {fieldLabel}"). */
+            addItemLabel?: string;
         };
     };
     passthrough: {
@@ -106,6 +116,7 @@ export interface IFieldRendererRegistry {
     refDialogMultiple: {
         fieldType: "ref";
         settings?: {
+            /** Where newly picked references are inserted: `"first"` (top) or `"last"` (bottom, default). */
             newItemPosition?: "first" | "last";
         };
     };
@@ -125,6 +136,11 @@ export interface IFieldRendererRegistry {
         fieldType: "ref";
         settings: undefined;
     };
+    select: {
+        fieldType: "text" | "number";
+        settings: undefined;
+    };
+    /** @deprecated Use "select" instead. */
     dropdown: {
         fieldType: "text" | "number";
         settings: undefined;
@@ -140,21 +156,41 @@ export interface IFieldRendererRegistry {
     textInputs: {
         fieldType: "text";
         settings?: {
-            multiValue?: {
-                addValueButtonLabel?: string;
-            };
+            addItemLabel?: string;
         };
     };
+    /** @deprecated Use `assetField` instead. */
     file: {
         fieldType: "file";
         settings?: {
+            /** Only allow image files to be selected. */
             imagesOnly?: boolean;
         };
     };
+    /** @deprecated Use `assetFields` instead. */
     files: {
         fieldType: "file";
         settings?: {
+            /** Only allow image files to be selected. */
+            imagesOnly?: boolean;
+        };
+    };
+    assetField: {
+        fieldType: "asset";
+        settings?: {
+            /** Only allow image files to be selected. */
             imagesOnly?: boolean;
+            /** MIME types or extensions to allow (e.g. `["image/png", "application/pdf"]`). Leave empty to allow all. */
+            accept?: string[];
+        };
+    };
+    assetFields: {
+        fieldType: "asset";
+        settings?: {
+            /** Only allow image files to be selected. */
+            imagesOnly?: boolean;
+            /** MIME types or extensions to allow (e.g. `["image/png", "application/pdf"]`). Leave empty to allow all. */
+            accept?: string[];
         };
     };
     uiSeparator: {
@@ -191,6 +227,14 @@ export declare class DataFieldBuilder<TType extends string = string> extends Bas
     storageId(id: string): this;
     defaultValue(value: any): this;
     list(): this;
+    /**
+     * Renders the field in the admin app, but doesn't let anyone edit its value.
+     * Handy for values your own code owns, like an external ID or a generated slug.
+     *
+     * Only the admin app honours this. The API doesn't check it, so the field can
+     * still be written to over GraphQL.
+     */
+    disabled(value?: boolean): this;
     tags(tags: string[]): this;
     /**
      * List validators - these methods are available after calling list()
@@ -217,4 +261,5 @@ export declare class DataFieldBuilder<TType extends string = string> extends Bas
      * @internal
      */
     build(): DataFieldBuildResult;
+    private getFieldType;
 }

package/features/modelBuilder/fields/DataFieldBuilder.js

@@ -1,211 +1,180 @@
 import camelCase from "lodash/camelCase.js";
 import { getBaseFieldType } from "../../../utils/getBaseFieldType.js";
 import { BaseFieldBuilder } from "./BaseFieldBuilder.js";
-
-/**
- * Augmentable renderer registry. Each entry maps a renderer name to its applicable field type(s) and settings.
- */
-
-/**
- * Maps camelCase renderer names (used in the builder API) to the
- * kebab-case names expected by the frontend renderer registry.
- */
 const rendererNameMap = {
-  switch: "boolean-input",
-  checkboxes: "checkboxes",
-  dateTimeInput: "date-time-input",
-  dateTimeInputs: "date-time-inputs",
-  dynamicZone: "dynamicZone",
-  hidden: "hidden",
-  lexicalEditor: "lexical-text-input",
-  lexicalEditors: "lexical-text-inputs",
-  textarea: "long-text-text-area",
-  textareas: "long-text-inputs",
-  numberInput: "number-input",
-  numberInputs: "number-inputs",
-  objectAccordionSingle: "object-accordion",
-  objectAccordionMultiple: "objects-accordion",
-  passthrough: "passthrough",
-  radioButtons: "radio-buttons",
-  refDialogSingle: "ref-advanced-single",
-  refDialogMultiple: "ref-advanced-multiple",
-  refAutocompleteSingle: "ref-input",
-  refAutocompleteMultiple: "ref-inputs",
-  refCheckboxes: "ref-simple-multiple",
-  refRadioButtons: "ref-simple-single",
-  dropdown: "select-box",
-  tags: "tags",
-  textInput: "text-input",
-  textInputs: "text-inputs",
-  file: "file-input",
-  files: "file-inputs",
-  uiSeparator: "uiSeparator",
-  uiAlert: "uiAlert",
-  uiTabs: "uiTabs"
+    switch: "boolean-input",
+    checkboxes: "checkboxes",
+    dateTimeInput: "date-time-input",
+    dateTimeInputs: "date-time-inputs",
+    dynamicZone: "dynamicZone",
+    hidden: "hidden",
+    lexicalEditor: "lexical-text-input",
+    lexicalEditors: "lexical-text-inputs",
+    textarea: "long-text-text-area",
+    textareas: "long-text-inputs",
+    numberInput: "number-input",
+    numberInputs: "number-inputs",
+    objectAccordionSingle: "object-accordion",
+    objectAccordionMultiple: "objects-accordion",
+    passthrough: "passthrough",
+    radioButtons: "radio-buttons",
+    refDialogSingle: "ref-advanced-single",
+    refDialogMultiple: "ref-advanced-multiple",
+    refAutocompleteSingle: "ref-input",
+    refAutocompleteMultiple: "ref-inputs",
+    refCheckboxes: "ref-simple-multiple",
+    refRadioButtons: "ref-simple-single",
+    select: "select-box",
+    dropdown: "select-box",
+    tags: "tags",
+    textInput: "text-input",
+    textInputs: "text-inputs",
+    file: "file-input",
+    files: "file-inputs",
+    assetField: "asset-input",
+    assetFields: "asset-inputs",
+    uiSeparator: "uiSeparator",
+    uiAlert: "uiAlert",
+    uiTabs: "uiTabs"
 };
-
-/**
- * Resolves a camelCase renderer name to the kebab-case name used by the frontend.
- */
 function resolveRendererName(name) {
-  return rendererNameMap[name] ?? name;
+    return rendererNameMap[name] ?? name;
 }
-
-/**
- * Extracts renderer names valid for the given field type.
- * When TType is a broad `string`, all renderer names are returned.
- */
-
-/**
- * DataFieldBuilder class for data fields that produce CmsModelField instances.
- * Provides storageId, list, validation, renderer, and other data-field methods.
- */
-export class DataFieldBuilder extends BaseFieldBuilder {
-  constructor(type, label) {
-    super(type, label);
-    this.config = {
-      label: label || "",
-      validation: [],
-      listValidation: [],
-      list: false,
-      predefinedValues: {
-        enabled: false,
-        values: []
-      },
-      help: null,
-      placeholder: null,
-      description: null,
-      note: null,
-      renderer: null,
-      settings: {},
-      tags: []
-    };
-  }
-  placeholder(text) {
-    this.config.placeholder = text;
-    return this;
-  }
-  storageId(id) {
-    // We do not allow developers to specify the field type!
-    this.config._storageId = id.split("@").pop();
-    return this;
-  }
-  defaultValue(value) {
-    this.config.settings = {
-      ...this.config.settings,
-      defaultValue: value
-    };
-    return this;
-  }
-  list() {
-    this.config.list = true;
-    return this;
-  }
-  tags(tags) {
-    this.config.tags = tags;
-    return this;
-  }
-
-  /**
-   * List validators - these methods are available after calling list()
-   */
-  listMinLength(value, message) {
-    return this.listValidation({
-      name: "minLength",
-      message: message || `At least ${value} item(s) required.`,
-      settings: {
-        value
-      }
-    });
-  }
-  listMaxLength(value, message) {
-    return this.listValidation({
-      name: "maxLength",
-      message: message || `At most ${value} item(s) allowed.`,
-      settings: {
-        value
-      }
-    });
-  }
-
-  /**
-   * Add a validation rule to this field.
-   * This method is protected and should only be used by field-specific validator methods.
-   * @internal
-   */
-  validation(validation) {
-    this.config.validation = this.config.validation || [];
-    this.config.validation.push(validation);
-    return this;
-  }
-
-  /**
-   * Add a list validation rule to this field (for list fields).
-   * This method is protected and should only be used by field-specific validator methods.
-   * @internal
-   */
-  listValidation(validation) {
-    this.config.listValidation = this.config.listValidation || [];
-    this.config.listValidation.push(validation);
-    return this;
-  }
-  predefinedValues(values) {
-    this.config.predefinedValues = {
-      enabled: true,
-      values
-    };
-    return this;
-  }
-  renderer(name, ...args) {
-    this.config.renderer = {
-      name: resolveRendererName(name),
-      settings: args[0] ?? null
-    };
-    return this;
-  }
-  settings(settings) {
-    this.config.settings = {
-      ...this.config.settings,
-      ...settings
-    };
-    return this;
-  }
-
-  /**
-   * Build the final CmsModelField
-   * @internal
-   */
-  build() {
-    const fieldId = this.config._fieldId || camelCase(this.config.label);
-    const baseType = getBaseFieldType({
-      type: this.type
-    });
-    const storageId = `${baseType}@${this.config._storageId ?? fieldId}`;
-    return {
-      type: "data",
-      field: {
-        id: fieldId,
-        fieldId,
-        storageId,
-        type: this.type,
-        label: this.config.label,
-        validation: this.config.validation || [],
-        listValidation: this.config.listValidation || [],
-        list: this.config.list || false,
-        predefinedValues: this.config.predefinedValues || {
-          enabled: false,
-          values: []
-        },
-        help: this.config.help || null,
-        placeholder: this.config.placeholder || null,
-        description: this.config.description || null,
-        note: this.config.note || null,
-        renderer: this.config.renderer || null,
-        settings: this.config.settings || {},
-        tags: this.config.tags || []
-      }
-    };
-  }
+class DataFieldBuilder extends BaseFieldBuilder {
+    constructor(type, label){
+        super(type, label);
+        this.config = {
+            label: label || "",
+            validation: [],
+            listValidation: [],
+            list: false,
+            predefinedValues: {
+                enabled: false,
+                values: []
+            },
+            help: null,
+            placeholder: null,
+            description: null,
+            note: null,
+            renderer: null,
+            settings: {},
+            tags: []
+        };
+    }
+    placeholder(text) {
+        this.config.placeholder = text;
+        return this;
+    }
+    storageId(id) {
+        this.config._storageId = id.split("@").pop();
+        return this;
+    }
+    defaultValue(value) {
+        this.config.settings = {
+            ...this.config.settings,
+            defaultValue: value
+        };
+        return this;
+    }
+    list() {
+        this.config.list = true;
+        return this;
+    }
+    disabled(value = true) {
+        this.config.disabled = value;
+        return this;
+    }
+    tags(tags) {
+        this.config.tags = tags;
+        return this;
+    }
+    listMinLength(value, message) {
+        return this.listValidation({
+            name: "minLength",
+            message: message || `At least ${value} item(s) required.`,
+            settings: {
+                value
+            }
+        });
+    }
+    listMaxLength(value, message) {
+        return this.listValidation({
+            name: "maxLength",
+            message: message || `At most ${value} item(s) allowed.`,
+            settings: {
+                value
+            }
+        });
+    }
+    validation(validation) {
+        this.config.validation = this.config.validation || [];
+        this.config.validation.push(validation);
+        return this;
+    }
+    listValidation(validation) {
+        this.config.listValidation = this.config.listValidation || [];
+        this.config.listValidation.push(validation);
+        return this;
+    }
+    predefinedValues(values) {
+        this.config.predefinedValues = {
+            enabled: true,
+            values
+        };
+        return this;
+    }
+    renderer(name, ...args) {
+        this.config.renderer = {
+            name: resolveRendererName(name),
+            settings: args[0] ?? null
+        };
+        return this;
+    }
+    settings(settings) {
+        this.config.settings = {
+            ...this.config.settings,
+            ...settings
+        };
+        return this;
+    }
+    build() {
+        const fieldId = this.config._fieldId || camelCase(this.config.label);
+        const baseType = getBaseFieldType({
+            type: this.type
+        });
+        const storageId = `${baseType}@${this.config._storageId ?? fieldId}`;
+        return {
+            type: "data",
+            field: {
+                id: fieldId,
+                fieldId,
+                storageId,
+                type: this.getFieldType(),
+                label: this.config.label,
+                validation: this.config.validation || [],
+                listValidation: this.config.listValidation || [],
+                list: this.config.list || false,
+                disabled: this.config.disabled || false,
+                predefinedValues: this.config.predefinedValues || {
+                    enabled: false,
+                    values: []
+                },
+                help: this.config.help || null,
+                placeholder: this.config.placeholder || null,
+                description: this.config.description || null,
+                note: this.config.note || null,
+                renderer: this.config.renderer || null,
+                settings: this.config.settings || {},
+                tags: this.config.tags || [],
+                rules: this.config.rules
+            }
+        };
+    }
+    getFieldType() {
+        if (!this.subType?.length) return this.type;
+        return `${this.type}:${this.subType}`;
+    }
 }
+export { DataFieldBuilder };
 
 //# sourceMappingURL=DataFieldBuilder.js.map