@webiny/app-headless-cms-common 6.0.0-rc.2 → 6.0.0-rc.4

package/ModelFieldProvider/index.js.map

@@ -1 +1 @@
-{"version":3,"names":[],"sources":["index.ts"],"sourcesContent":["export * from \"./ModelFieldContext.js\";\nexport * from \"./useModelField.js\";\n"],"mappings":"AAAA;AACA","ignoreList":[]}
+{"version":3,"names":[],"sources":["index.ts"],"sourcesContent":["export * from \"./ModelFieldContext.js\";\nexport * from \"./useModelField.js\";\nexport * from \"./CanEditField.js\";\n"],"mappings":"AAAA;AACA;AACA","ignoreList":[]}

package/ModelFieldProvider/useModelField.js

@@ -14,10 +14,10 @@ const getFieldPlugin = type => {
  */
 export const useModelField = makeDecoratable(() => {
   const field = useContext(ModelFieldContext);
-  const parentValueIndex = useParentValueIndex();
   if (!field) {
     throw Error(`Missing "ModelFieldProvider" in the component tree. Are you using the "useModelField()" hook in the right place?`);
   }
+  const parentValueIndex = useParentValueIndex();
   const fieldPlugin = getFieldPlugin(field.type);
   return {
     field,

package/ModelFieldProvider/useModelField.js.map

@@ -1 +1 @@
-{"version":3,"names":["useContext","plugins","makeDecoratable","ModelFieldContext","useParentValueIndex","getFieldPlugin","type","plugin","byType","find","field","Error","useModelField","parentValueIndex","fieldPlugin"],"sources":["useModelField.ts"],"sourcesContent":["import { useContext } from \"react\";\nimport { plugins } from \"@webiny/plugins\";\nimport { makeDecoratable } from \"@webiny/react-composition\";\nimport { ModelFieldContext, useParentValueIndex } from \"./ModelFieldContext.js\";\nimport type { CmsModelField, CmsModelFieldTypePlugin } from \"~/types/index.js\";\n\ninterface GetFieldPlugin {\n    (type: string): CmsModelFieldTypePlugin;\n}\n\nconst getFieldPlugin: GetFieldPlugin = type => {\n    const plugin = plugins\n        .byType<CmsModelFieldTypePlugin>(\"cms-editor-field-type\")\n        .find(plugin => plugin.field.type === type);\n\n    if (!plugin) {\n        throw Error(`Missing plugin for field type \"${type}\"!`);\n    }\n\n    return plugin;\n};\n\nexport interface UseModelField {\n    field: CmsModelField;\n    parentValueIndex: number;\n    fieldPlugin: CmsModelFieldTypePlugin;\n}\n\n/**\n * Get model field from the current context.\n */\nexport const useModelField = makeDecoratable((): UseModelField => {\n    const field = useContext(ModelFieldContext);\n    const parentValueIndex = useParentValueIndex();\n\n    if (!field) {\n        throw Error(\n            `Missing \"ModelFieldProvider\" in the component tree. Are you using the \"useModelField()\" hook in the right place?`\n        );\n    }\n\n    const fieldPlugin = getFieldPlugin(field.type);\n\n    return { field, fieldPlugin, parentValueIndex };\n});\n"],"mappings":"AAAA,SAASA,UAAU,QAAQ,OAAO;AAClC,SAASC,OAAO,QAAQ,iBAAiB;AACzC,SAASC,eAAe,QAAQ,2BAA2B;AAC3D,SAASC,iBAAiB,EAAEC,mBAAmB;AAO/C,MAAMC,cAA8B,GAAGC,IAAI,IAAI;EAC3C,MAAMC,MAAM,GAAGN,OAAO,CACjBO,MAAM,CAA0B,uBAAuB,CAAC,CACxDC,IAAI,CAACF,MAAM,IAAIA,MAAM,CAACG,KAAK,CAACJ,IAAI,KAAKA,IAAI,CAAC;EAE/C,IAAI,CAACC,MAAM,EAAE;IACT,MAAMI,KAAK,CAAC,kCAAkCL,IAAI,IAAI,CAAC;EAC3D;EAEA,OAAOC,MAAM;AACjB,CAAC;AAQD;AACA;AACA;AACA,OAAO,MAAMK,aAAa,GAAGV,eAAe,CAAC,MAAqB;EAC9D,MAAMQ,KAAK,GAAGV,UAAU,CAACG,iBAAiB,CAAC;EAC3C,MAAMU,gBAAgB,GAAGT,mBAAmB,CAAC,CAAC;EAE9C,IAAI,CAACM,KAAK,EAAE;IACR,MAAMC,KAAK,CACP,kHACJ,CAAC;EACL;EAEA,MAAMG,WAAW,GAAGT,cAAc,CAACK,KAAK,CAACJ,IAAI,CAAC;EAE9C,OAAO;IAAEI,KAAK;IAAEI,WAAW;IAAED;EAAiB,CAAC;AACnD,CAAC,CAAC","ignoreList":[]}
+{"version":3,"names":["useContext","plugins","makeDecoratable","ModelFieldContext","useParentValueIndex","getFieldPlugin","type","plugin","byType","find","field","Error","useModelField","parentValueIndex","fieldPlugin"],"sources":["useModelField.ts"],"sourcesContent":["import { useContext } from \"react\";\nimport { plugins } from \"@webiny/plugins\";\nimport { makeDecoratable } from \"@webiny/react-composition\";\nimport { ModelFieldContext, useParentValueIndex } from \"./ModelFieldContext.js\";\nimport type { CmsModelField, CmsModelFieldTypePlugin } from \"~/types/index.js\";\n\ninterface GetFieldPlugin {\n    (type: string): CmsModelFieldTypePlugin;\n}\n\nconst getFieldPlugin: GetFieldPlugin = type => {\n    const plugin = plugins\n        .byType<CmsModelFieldTypePlugin>(\"cms-editor-field-type\")\n        .find(plugin => plugin.field.type === type);\n\n    if (!plugin) {\n        throw Error(`Missing plugin for field type \"${type}\"!`);\n    }\n\n    return plugin;\n};\n\nexport interface UseModelField {\n    field: CmsModelField;\n    parentValueIndex: number;\n    fieldPlugin: CmsModelFieldTypePlugin;\n}\n\n/**\n * Get model field from the current context.\n */\nexport const useModelField = makeDecoratable((): UseModelField => {\n    const field = useContext(ModelFieldContext);\n\n    if (!field) {\n        throw Error(\n            `Missing \"ModelFieldProvider\" in the component tree. Are you using the \"useModelField()\" hook in the right place?`\n        );\n    }\n\n    const parentValueIndex = useParentValueIndex();\n\n    const fieldPlugin = getFieldPlugin(field.type);\n\n    return { field, fieldPlugin, parentValueIndex };\n});\n"],"mappings":"AAAA,SAASA,UAAU,QAAQ,OAAO;AAClC,SAASC,OAAO,QAAQ,iBAAiB;AACzC,SAASC,eAAe,QAAQ,2BAA2B;AAC3D,SAASC,iBAAiB,EAAEC,mBAAmB;AAO/C,MAAMC,cAA8B,GAAGC,IAAI,IAAI;EAC3C,MAAMC,MAAM,GAAGN,OAAO,CACjBO,MAAM,CAA0B,uBAAuB,CAAC,CACxDC,IAAI,CAACF,MAAM,IAAIA,MAAM,CAACG,KAAK,CAACJ,IAAI,KAAKA,IAAI,CAAC;EAE/C,IAAI,CAACC,MAAM,EAAE;IACT,MAAMI,KAAK,CAAC,kCAAkCL,IAAI,IAAI,CAAC;EAC3D;EAEA,OAAOC,MAAM;AACjB,CAAC;AAQD;AACA;AACA;AACA,OAAO,MAAMK,aAAa,GAAGV,eAAe,CAAC,MAAqB;EAC9D,MAAMQ,KAAK,GAAGV,UAAU,CAACG,iBAAiB,CAAC;EAE3C,IAAI,CAACO,KAAK,EAAE;IACR,MAAMC,KAAK,CACP,kHACJ,CAAC;EACL;EAEA,MAAME,gBAAgB,GAAGT,mBAAmB,CAAC,CAAC;EAE9C,MAAMU,WAAW,GAAGT,cAAc,CAACK,KAAK,CAACJ,IAAI,CAAC;EAE9C,OAAO;IAAEI,KAAK;IAAEI,WAAW;IAAED;EAAiB,CAAC;AACnD,CAAC,CAAC","ignoreList":[]}

package/exports/admin/cms/model.d.ts

@@ -0,0 +1,2 @@
+export { useFieldAccessControlRules, useEffectiveRules } from "../../../Fields/index.js";
+export type { CmsLayoutFieldTypePlugin, CmsLayoutDescriptorRendererPlugin, CmsBaseLayoutDescriptor, CmsLayoutDescriptor } from "../../../types/index.ts";

package/exports/admin/cms/model.js

@@ -0,0 +1,3 @@
+export { useFieldAccessControlRules, useEffectiveRules } from "../../../Fields/index.js";
+
+//# sourceMappingURL=model.js.map

package/exports/admin/cms/model.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["useFieldAccessControlRules","useEffectiveRules"],"sources":["model.ts"],"sourcesContent":["export { useFieldAccessControlRules, useEffectiveRules } from \"~/Fields/index.js\";\n\nexport type {\n    CmsLayoutFieldTypePlugin,\n    CmsLayoutDescriptorRendererPlugin,\n    CmsBaseLayoutDescriptor,\n    CmsLayoutDescriptor\n} from \"~/types/index.ts\";\n"],"mappings":"AAAA,SAASA,0BAA0B,EAAEC,iBAAiB","ignoreList":[]}

package/exports/admin/cms.d.ts

@@ -1 +1 @@
-export type { CmsContentEntry, CmsModel, CmsModelField, CmsIdentity } from "../../types/index.ts";
+export type { CmsContentEntry, CmsModel, CmsModelField, CmsIdentity, CmsLayoutFieldTypePlugin, CmsLayoutDescriptorRendererPlugin, CmsBaseLayoutDescriptor, CmsLayoutDescriptor } from "../../types/index.ts";

package/exports/admin/cms.js.map

@@ -1 +1 @@
-{"version":3,"names":[],"sources":["cms.ts"],"sourcesContent":["export type { CmsContentEntry, CmsModel, CmsModelField, CmsIdentity } from \"~/types/index.ts\";\n"],"mappings":"","ignoreList":[]}
+{"version":3,"names":[],"sources":["cms.ts"],"sourcesContent":["export type {\n    CmsContentEntry,\n    CmsModel,\n    CmsModelField,\n    CmsIdentity,\n    CmsLayoutFieldTypePlugin,\n    CmsLayoutDescriptorRendererPlugin,\n    CmsBaseLayoutDescriptor,\n    CmsLayoutDescriptor\n} from \"~/types/index.ts\";\n"],"mappings":"","ignoreList":[]}

package/normalizeIcon.d.ts

@@ -0,0 +1,3 @@
+import type { IconProp } from "@fortawesome/fontawesome-svg-core";
+import type { CmsIcon } from "./types/index.js";
+export declare const normalizeIcon: (icon: string | CmsIcon | undefined) => IconProp | undefined;

package/normalizeIcon.js

@@ -0,0 +1,10 @@
+export const normalizeIcon = icon => {
+  let iconName = undefined;
+  if (icon) {
+    const name = typeof icon === "string" ? icon : icon.name;
+    iconName = name.split("/");
+  }
+  return iconName;
+};
+
+//# sourceMappingURL=normalizeIcon.js.map

package/normalizeIcon.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["normalizeIcon","icon","iconName","undefined","name","split"],"sources":["normalizeIcon.ts"],"sourcesContent":["import type { IconProp } from \"@fortawesome/fontawesome-svg-core\";\nimport type { CmsIcon } from \"~/types/index.js\";\n\nexport const normalizeIcon = (icon: string | CmsIcon | undefined) => {\n    let iconName: IconProp | undefined = undefined;\n    if (icon) {\n        const name = typeof icon === \"string\" ? icon : icon.name;\n        iconName = name.split(\"/\") as IconProp;\n    }\n    return iconName;\n};\n"],"mappings":"AAGA,OAAO,MAAMA,aAAa,GAAIC,IAAkC,IAAK;EACjE,IAAIC,QAA8B,GAAGC,SAAS;EAC9C,IAAIF,IAAI,EAAE;IACN,MAAMG,IAAI,GAAG,OAAOH,IAAI,KAAK,QAAQ,GAAGA,IAAI,GAAGA,IAAI,CAACG,IAAI;IACxDF,QAAQ,GAAGE,IAAI,CAACC,KAAK,CAAC,GAAG,CAAa;EAC1C;EACA,OAAOH,QAAQ;AACnB,CAAC","ignoreList":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@webiny/app-headless-cms-common",
-	"version": "6.0.0-rc.2",
+	"version": "6.0.0-rc.4",
 	"type": "module",
 	"main": "index.js",
 	"repository": {
@@ -17,13 +17,14 @@
 		"@emotion/react": "11.10.8",
 		"@emotion/styled": "11.10.6",
 		"@fortawesome/fontawesome-svg-core": "1.3.0",
-		"@webiny/admin-ui": "6.0.0-rc.2",
-		"@webiny/app": "6.0.0-rc.2",
-		"@webiny/app-admin": "6.0.0-rc.2",
-		"@webiny/form": "6.0.0-rc.2",
-		"@webiny/plugins": "6.0.0-rc.2",
-		"@webiny/react-composition": "6.0.0-rc.2",
-		"@webiny/validation": "6.0.0-rc.2",
+		"@fortawesome/react-fontawesome": "0.1.19",
+		"@webiny/admin-ui": "6.0.0-rc.4",
+		"@webiny/app": "6.0.0-rc.4",
+		"@webiny/app-admin": "6.0.0-rc.4",
+		"@webiny/form": "6.0.0-rc.4",
+		"@webiny/plugins": "6.0.0-rc.4",
+		"@webiny/react-composition": "6.0.0-rc.4",
+		"@webiny/validation": "6.0.0-rc.4",
 		"dnd-core": "16.0.1",
 		"graphql": "16.13.0",
 		"graphql-tag": "2.12.6",
@@ -34,7 +35,7 @@
 	"devDependencies": {
 		"@emotion/babel-plugin": "11.13.5",
 		"@types/react": "18.2.79",
-		"@webiny/build-tools": "6.0.0-rc.2",
+		"@webiny/build-tools": "6.0.0-rc.4",
 		"babel-plugin-module-resolver": "5.0.2",
 		"rimraf": "6.1.3",
 		"typescript": "5.9.3"
@@ -43,5 +44,5 @@
 		"access": "public",
 		"directory": "dist"
 	},
-	"gitHead": "5facada4cbb8617cc60e3c98be0f1839f44be38e"
+	"gitHead": "e2758ee1cfa3b9a7152e9bb995a90ccabd33266f"
 }

package/types/index.d.ts

@@ -4,7 +4,7 @@ import type { Plugin } from "@webiny/plugins/types.js";
 import type { BindComponent as BaseBindComponent, BindComponentProps as BaseBindComponentProps, BindComponentRenderProp as BaseBindComponentRenderProp, FormAPI } from "@webiny/form";
 import type { IconName, IconPrefix } from "@fortawesome/fontawesome-svg-core";
 import type { CmsModelFieldValidator, CmsModelFieldValidatorsFactory, CmsModelFieldValidatorsGroup } from "./validation.js";
-import type { CmsModel, CmsModelField } from "./model.js";
+import type { CmsBaseLayoutDescriptor, CmsEditorFieldsLayout, CmsLayoutDescriptor, CmsModel, CmsModelField } from "./model.js";
 import type { CmsIdentity } from "../types/shared.js";
 import type { SourceType } from "dnd-core";
 import type { IconPickerIconDto } from "@webiny/admin-ui";
@@ -15,6 +15,7 @@ export type DragObjectWithType = {
 };
 export type * from "./validation.js";
 export type * from "./model.js";
+export { isLayoutDescriptor } from "./model.js";
 export type * from "./shared.js";
 interface QueryFieldParams {
     model: CmsModel;
@@ -31,10 +32,12 @@ interface Location {
 export interface DragSource extends DragObjectWithType {
     parent?: string;
     pos?: Partial<Position>;
-    type: "row" | "field" | "newField";
+    type: "row" | "field" | "newField" | "newLayoutField" | "layoutField";
     fieldType?: string;
+    layoutFieldType?: string;
     field?: CmsModelField | null;
     fields?: CmsModelField[];
+    descriptor?: CmsLayoutDescriptor;
 }
 /**
  * @deprecated Use `CmsModelFieldTypePlugin`.
@@ -219,6 +222,59 @@ export interface CmsModelFieldTypePlugin extends Plugin {
         }) => React.ReactElement;
     };
 }
+export interface CmsLayoutFieldTypePlugin extends Plugin {
+    type: "cms-editor-layout-field-type";
+    field: {
+        type: CmsLayoutDescriptor["type"];
+        label: string;
+        description: string;
+        icon: React.ReactElement;
+        createDescriptor(): Omit<CmsLayoutDescriptor, "id">;
+        canEditSettings?: boolean;
+        renderSettings?(): React.ReactNode;
+        /**
+         * Collect all model fields embedded inside a layout descriptor's nested layout.
+         * Used during drag-and-drop to move embedded fields along with the descriptor
+         * across parent boundaries. Return `[]` or omit for descriptors with no nested fields.
+         */
+        collectFields?(params: {
+            descriptor: CmsLayoutDescriptor;
+            getField: (id: string) => CmsModelField | undefined;
+        }): CmsModelField[];
+        /**
+         * Return a label prefix for each field ID nested inside this layout descriptor.
+         * Used by `buildFieldOptions` to include layout hierarchy in field labels.
+         *
+         * For example, a tabs descriptor with label "My Tabs" containing a tab "SEO"
+         * with field "metaTitle" would return: `{ "metaTitle": "My Tabs › SEO" }`.
+         *
+         * Omit or return `{}` for descriptors that don't group fields.
+         */
+        getFieldLabelPrefixes?(params: {
+            descriptor: CmsLayoutDescriptor;
+        }): Record<string, string>;
+        /**
+         * Controls how this layout field looks on the model editor canvas.
+         * Each plugin fully owns its visual representation.
+         */
+        render(params: {
+            descriptor: CmsLayoutDescriptor;
+            onUpdate: (d: CmsLayoutDescriptor) => void;
+            onDelete: () => void;
+        }): React.ReactElement;
+    };
+}
+export interface CmsLayoutDescriptorRendererPlugin extends Plugin {
+    type: "cms-layout-descriptor-renderer";
+    descriptorType: string;
+    render(props: {
+        descriptor: CmsBaseLayoutDescriptor;
+        Bind: BindComponent;
+        fields: CmsModelField[];
+        contentModel: CmsModel;
+        gridClassName?: string;
+    }): React.ReactElement | null;
+}
 export interface CmsModelFieldRendererSettingsProps {
     field: CmsModelField;
 }
@@ -324,7 +380,7 @@ export interface CmsDynamicZoneTemplate {
     description: string;
     icon: string;
     fields: CmsModelField[];
-    layout: string[][];
+    layout: CmsEditorFieldsLayout;
     validation: CmsModelFieldValidator[];
     tags?: string[];
 }

package/types/index.js

@@ -1,3 +1,53 @@
-export {};
+export { isLayoutDescriptor } from "./model.js";
+
+/**
+ * @deprecated Use `CmsModelFieldTypePlugin`.
+ */
+
+/**
+ * @deprecated Use `CmsModelFieldRendererProps`.
+ */
+
+/**
+ * @deprecated Use `CmsModelFieldRendererPlugin`.
+ */
+
+/**
+ * @deprecated Use `CmsContentEntry`.
+ */
+
+// ------------------------------------------------------------------------------------------------------------
+
+/**
+ * Transform field value when sending data to the API.
+ */
+
+/**
+ * Define a custom form layout renderer for a specific content model.
+ */
+
+/**
+ * #########################
+ * Data types
+ * #########################
+ */
+
+/**
+ * @category GraphQL
+ * @category Error
+ */
+
+/**
+ * @category GraphQL
+ * @category Meta
+ */
+
+/***
+ * ###### FORM ########
+ */
+
+/**
+ * After RequestReview and RequestChanges was removed, we need an option to add new status filters
+ */
 
 //# sourceMappingURL=index.js.map

package/types/index.js.map

@@ -1 +1 @@
-{"version":3,"names":[],"sources":["index.ts"],"sourcesContent":["import type * as React from \"react\";\nimport type { ReactElement, ReactNode } from \"react\";\nimport type { Plugin } from \"@webiny/plugins/types.js\";\nimport type {\n    BindComponent as BaseBindComponent,\n    BindComponentProps as BaseBindComponentProps,\n    BindComponentRenderProp as BaseBindComponentRenderProp,\n    FormAPI\n} from \"@webiny/form\";\nimport type { IconName, IconPrefix } from \"@fortawesome/fontawesome-svg-core\";\nimport type {\n    CmsModelFieldValidator,\n    CmsModelFieldValidatorsFactory,\n    CmsModelFieldValidatorsGroup\n} from \"./validation.js\";\nimport type { CmsModel, CmsModelField } from \"./model.js\";\nimport type { CmsIdentity } from \"~/types/shared.js\";\nimport type { SourceType } from \"dnd-core\";\nimport type { IconPickerIconDto } from \"@webiny/admin-ui\";\nimport { GenericRecord } from \"@webiny/app/types.js\";\nimport { Identity } from \"@webiny/app-admin/domain/Identity.js\";\n\nexport type DragObjectWithType = {\n    type: SourceType;\n};\n\nexport type * from \"./validation.js\";\nexport type * from \"./model.js\";\nexport type * from \"./shared.js\";\n\ninterface QueryFieldParams {\n    model: CmsModel;\n    field: CmsModelField;\n    graphQLTypePrefix: string;\n}\n\ninterface Position {\n    row: number;\n    index: number;\n}\n\ninterface Location {\n    folderId: string;\n}\n\nexport interface DragSource extends DragObjectWithType {\n    parent?: string;\n    pos?: Partial<Position>;\n    type: \"row\" | \"field\" | \"newField\";\n    fieldType?: string;\n    field?: CmsModelField | null;\n    fields?: CmsModelField[];\n}\n\n/**\n * @deprecated Use `CmsModelFieldTypePlugin`.\n */\nexport type CmsEditorFieldTypePlugin = CmsModelFieldTypePlugin;\n\nexport interface CmsModelFieldTypePlugin extends Plugin {\n    /**\n     * a plugin type\n     */\n    type: \"cms-editor-field-type\";\n    field: {\n        /**\n         * A unique identifier of the field type (text, number, json, myField, ...).\n         *\n         * ```ts\n         * type: \"myField\"\n         * ```\n         */\n        type: string;\n        /**\n         * A display name for the field.\n         *\n         * ```ts\n         * label: \"Field name\"\n         * ```\n         */\n        label: string;\n        /**\n         * A list of available validators for the model field.\n         *\n         * ```ts\n         * validators: [\n         *     \"required\",\n         *     \"gte\",\n         *     \"lte\"\n         * ]\n         * ```\n         */\n        validators?: string[] | CmsModelFieldValidatorsGroup | CmsModelFieldValidatorsFactory;\n        /**\n         * A list of available validators when a model field accepts a list (array) of values.\n         *\n         * ```ts\n         * listValidators: [\n         *     \"minLength\",\n         *     \"maxLength\"\n         * ]\n         * ```\n         */\n        listValidators?: string[] | CmsModelFieldValidatorsGroup | CmsModelFieldValidatorsFactory;\n        /**\n         * An explanation of the field displayed beneath the label.\n         *\n         * ```ts\n         * description: \"A short description of the field\"\n         * ```\n         */\n        description: string;\n        /**\n         * A ReactNode to display the icon for the field.\n         *\n         * ```tsx\n         * icon: <MyIconComponent />\n         * ```\n         */\n        icon: React.ReactNode;\n        /**\n         * Is it allowed to have multiple values in this field?\n         *\n         * ```ts\n         * allowList: true\n         * ```\n         */\n        allowList?: boolean;\n        /**\n         * Does this field type have a fixed list of values that can be selected?\n         *\n         * ```ts\n         * allowPredefinedValues: false\n         * ```\n         */\n        allowPredefinedValues?: boolean;\n        /**\n         * A ReactNode label when multiple values are enabled.\n         */\n        listLabel?: React.ReactNode;\n        /**\n         * Determines if this field type should be hidden from the admin UI.\n         * If set to `true`, the field type will not be visible or selectable in the admin interface.\n         */\n        hideInAdmin?: boolean;\n        /**\n         * These are default values when the field is first created. This is a representation of the field that is stored in the database.\n         *\n         * ```ts\n         * createField: () => ({\n         *     type: \"fieldType\",\n         *     validation: [],\n         *     renderer: {\n         *         name: \"fieldTypeRenderer\"\n         *     }\n         * })\n         * ```\n         */\n        createField: () => Pick<CmsModelField, \"type\" | \"validation\" | \"renderer\" | \"settings\">;\n        /**\n         * If `true` (default), this field will be configurable via a settings dialog.\n         * If `false`, a user will not be able to open the settings dialog, not will the dialog be opened on field drop.\n         */\n        canEditSettings?: boolean;\n        /**\n         * Determine if a `draggable` can be dropped into this field.\n         * NOTE: This is only applicable to nested field types.\n         */\n        canAccept?(field: CmsModelField, draggable: DragSource): boolean;\n        /**\n         * If `true` (default), will allow fields to be laid out into columns (next to each other).\n         * If `false`, horizontal layout will not be allowed.\n         * NOTE: This is only applicable to nested field types.\n         */\n        allowLayout?: boolean;\n        /**\n         * A ReactNode that you can add in the section below the help text when creating/editing field.\n         *\n         * ```tsx\n         * renderSettings: (params) => {\n         *     return <FieldSettingsComponent />;\n         * }\n         * ```\n         */\n        renderSettings?: (params: {\n            afterChangeLabel: (value: string) => void;\n            uniqueFieldIdValidator: (fieldId: string) => void;\n            contentModel: CmsModel;\n        }) => React.ReactNode;\n        /**\n         * A ReactNode that renders in the Predefined values tab.\n         *\n         * ```tsx\n         * renderPredefinedValues: (params) => {\n         *     const {form: {Bind}} = params;\n         *     return (\n         *         <Bind name=\"fieldProperty\">\n         *             <InputComponent />\n         *         </Bind>\n         *     );\n         * }\n         * ```\n         */\n        renderPredefinedValues?: (params: {\n            getBind: (index?: number) => any;\n        }) => React.ReactElement;\n        /**\n         * Object wrapper for GraphQL stuff\n         */\n        graphql?: {\n            /**\n             * Define field selection.\n             *\n             * ```ts\n             * graphql: {\n             *     queryField: `\n             *         {\n             *             id\n             *             title\n             *             createdOn\n             *         }\n             *     `,\n             * }\n             * ```\n             */\n            queryField?: string | ((params: QueryFieldParams) => string | null);\n        };\n        render?(params: any): React.ReactElement;\n        tags?: string[];\n        /**\n         * Render additional information in the Admin UI Model edit view\n         */\n        renderInfo?: (params: { field: CmsModelField; model: CmsModel }) => React.ReactElement;\n    };\n}\n\nexport interface CmsModelFieldRendererSettingsProps {\n    field: CmsModelField;\n}\n\nexport interface CmsModelFieldRendererProps {\n    field: CmsModelField;\n    Label: React.ComponentType<React.PropsWithChildren>;\n    getBind: <T = any>(index?: number, key?: string) => BindComponent<T>;\n    contentModel: CmsModel;\n}\n\n/**\n * @deprecated Use `CmsModelFieldRendererProps`.\n */\nexport type CmsEditorFieldRendererProps = CmsModelFieldRendererProps;\n\n/**\n * @deprecated Use `CmsModelFieldRendererPlugin`.\n */\nexport type CmsEditorFieldRendererPlugin = CmsModelFieldRendererPlugin;\n\nexport interface CmsModelFieldRendererPlugin extends Plugin {\n    /**\n     * a plugin type\n     */\n    type: \"cms-editor-field-renderer\";\n    renderer: {\n        /**\n         * Name of the renderer to match the one from `createField()` method in `CmsModelFieldTypePlugin`.\n         *\n         * ```ts\n         * renderName: \"myFieldTypeRenderer\"\n         * ```\n         */\n        rendererName: string;\n        /**\n         * A display name for the field in the UI. It is a `ReactNode` type, so you can use a JSX element.\n         *\n         * ```tsx\n         * name: <MyFieldNameComponent />\n         * ```\n         */\n        name: React.ReactNode;\n        /**\n         * A description for the field in the UI. Works exactly like the `name` property.\n         *\n         * ```tsx\n         * name: <MyFieldDescriptionComponent />\n         * ```\n         */\n        description: React.ReactNode;\n        /**\n         * A method that determines if the field can be rendered by this plugin.\n         *\n         * ```ts\n         * canUse({ field }) {\n         *     return (\n         *         field.type === \"myType\" && !field.list\n         *     );\n         * }\n         * ```\n         */\n        canUse(props: {\n            field: CmsModelField;\n            fieldPlugin: CmsModelFieldTypePlugin;\n            model: CmsModel;\n        }): boolean;\n        /**\n         * Renders a field in the UI.\n         *\n         * ```tsx\n         * render({ field, getBind }) {\n         *     const Bind = getBind();\n         *\n         *     return (\n         *         <Bind>\n         *             {bind => {\n         *                 return (\n         *                     <Input\n         *                         value={bind.value}\n         *                         onChange={bind.onChange}\n         *                     />\n         *                 )\n         *             }}\n         *         </Bind>\n         *     );\n         * }\n         * ```\n         */\n        render(props: CmsModelFieldRendererProps): React.ReactNode;\n        renderSettings?: (props: CmsModelFieldRendererSettingsProps) => React.ReactNode;\n    };\n}\n\nexport interface CmsEditorFieldPredefinedValuesEntry {\n    label: string;\n    value: string;\n    selected?: boolean;\n}\n\nexport interface CmsEditorFieldPredefinedValues {\n    enabled: boolean;\n    values: CmsEditorFieldPredefinedValuesEntry[];\n}\n\nexport interface CmsDynamicZoneTemplate {\n    id: string;\n    name: string;\n    gqlTypeName: string;\n    description: string;\n    icon: string;\n    fields: CmsModelField[];\n    layout: string[][];\n    validation: CmsModelFieldValidator[];\n    tags?: string[];\n}\n\nexport interface CmsDynamicZoneTemplateWithTypename extends CmsDynamicZoneTemplate {\n    __typename: string;\n}\n\nexport type CmsContentEntryStatusType = \"draft\" | \"published\" | \"unpublished\";\n\n/**\n * @deprecated Use `CmsContentEntry`.\n */\nexport type CmsEditorContentEntry = CmsContentEntry;\n\nexport interface CmsContentEntryLive {\n    version: number;\n}\n\nexport interface CmsContentEntrySystem {\n    // to be extended\n}\n\nexport interface CmsContentEntry<TValues extends GenericRecord = GenericRecord> {\n    id: string;\n    entryId: string;\n    modelId: string;\n    createdOn: string;\n    createdBy: CmsIdentity;\n    savedOn: string;\n    savedBy: CmsIdentity;\n    modifiedOn: string | null;\n    modifiedBy: CmsIdentity | null;\n    deletedOn: string | null;\n    deletedBy: CmsIdentity | null;\n    firstPublishedOn: string | null;\n    firstPublishedBy: CmsIdentity | null;\n    lastPublishedOn: string | null;\n    lastPublishedBy: CmsIdentity | null;\n    revisionCreatedOn: string;\n    revisionCreatedBy: CmsIdentity;\n    revisionSavedOn: string;\n    revisionSavedBy: CmsIdentity;\n    revisionModifiedOn: string | null;\n    revisionModifiedBy: CmsIdentity | null;\n    revisionDeletedOn: string | null;\n    revisionDeletedBy: CmsIdentity | null;\n    revisionFirstPublishedOn: string | null;\n    revisionFirstPublishedBy: CmsIdentity | null;\n    revisionLastPublishedOn: string | null;\n    revisionLastPublishedBy: CmsIdentity | null;\n    wbyAco_location: Location;\n    live: CmsContentEntryLive | null;\n    system: CmsContentEntrySystem | null;\n    meta: {\n        title: string;\n        description?: string;\n        image?: string;\n        locked: boolean;\n        status: CmsContentEntryStatusType;\n        version: number;\n    };\n    values?: TValues;\n}\n\nexport interface CmsContentEntryRevision {\n    id: string;\n    modelId: string;\n    savedOn: string;\n    deletedOn: string | null;\n    firstPublishedOn: string | null;\n    lastPublishedOn: string | null;\n    createdBy: CmsIdentity;\n    deletedBy: CmsIdentity | null;\n    revisionCreatedOn: string;\n    revisionSavedOn: string;\n    revisionModifiedOn: string | null;\n    revisionDeletedOn: string | null;\n    revisionFirstPublishedOn: string | null;\n    revisionLastPublishedOn: string | null;\n    revisionCreatedBy: CmsIdentity;\n    revisionSavedBy: CmsIdentity;\n    revisionModifiedBy: CmsIdentity | null;\n    revisionDeletedBy: CmsIdentity | null;\n    revisionFirstPublishedBy: CmsIdentity | null;\n    revisionLastPublishedBy: CmsIdentity | null;\n    wbyAco_location: Location;\n    meta: {\n        title: string;\n        locked: boolean;\n        status: CmsContentEntryStatusType;\n        version: number;\n    };\n}\n\nexport type CmsEditorContentTab = React.ComponentType<{ activeTab: boolean }>;\n\n// ------------------------------------------------------------------------------------------------------------\nexport interface CmsEditorFieldOptionPlugin extends Plugin {\n    type: \"cms-editor-field-option\";\n    render(): ReactElement;\n}\n\nexport interface CmsContentDetailsPlugin extends Plugin {\n    render: (params: any) => ReactNode;\n}\n\nexport interface FieldLayoutPosition {\n    row: number;\n    index: number | null;\n}\n\nexport interface CmsEditorFormSettingsPlugin<T = GenericRecord> extends Plugin {\n    type: \"cms-editor-form-settings\";\n    title: string;\n    description: string;\n    icon: React.ReactElement;\n    showSave?: boolean;\n    render(props: { Bind: BaseBindComponent; form: FormAPI<T>; formData: T }): React.ReactNode;\n    renderHeaderActions?(props: {\n        Bind: BaseBindComponent;\n        form: FormAPI<T>;\n        formData: T;\n    }): React.ReactNode;\n}\n\nexport interface CmsIcon {\n    /**\n     * [ pack, icon ], ex: [\"fab\", \"cog\"]\n     */\n    id: [IconPrefix, IconName];\n    /**\n     * Icon name\n     */\n    name: string;\n    /**\n     * SVG element\n     */\n    svg: ReactElement;\n}\n\nexport interface CmsIconsPlugin extends Plugin {\n    type: \"cms-icons\";\n    getIcons(): IconPickerIconDto[];\n}\n\n/**\n * Transform field value when sending data to the API.\n */\nexport interface CmsFieldValueTransformer<TField extends CmsModelField = CmsModelField>\n    extends Plugin {\n    /**\n     * A plugin type.\n     */\n    type: \"cms-field-value-transformer\";\n    /**\n     * A field type for the value transformer. Or a list of field types.\n     */\n    fieldType: string | string[];\n    /**\n     * A transformer function that takes a value and returns a new one.\n     */\n    transform: (value: any, field: TField) => any;\n}\n\n/**\n * Define a custom form layout renderer for a specific content model.\n */\nexport interface CmsContentFormRendererPlugin extends Plugin {\n    /**\n     * A plugin type.\n     */\n    type: \"cms-content-form-renderer\";\n    /**\n     * Content model ID that will use this renderer.\n     */\n    modelId: string;\n\n    /**\n     * A function that will render a custom form layout.\n     */\n    render(props: {\n        /**\n         * Content model that is being rendered.\n         */\n        contentModel: CmsModel;\n        /**\n         * Content entry data handled by the Form element.\n         */\n        data: Record<string, any>;\n        /**\n         * A component to bind data to the Form.\n         */\n        Bind: BindComponent;\n        /**\n         * Content model fields to render.\n         */\n        fields: Record<string, React.ReactElement>;\n    }): React.ReactNode;\n}\n/**\n * #########################\n * Data types\n * #########################\n */\nexport interface CmsSecurityPermission extends Identity.Permission {\n    accessLevel?: \"full\" | \"no\" | \"custom\";\n    models?: string[];\n    groups?: string[];\n    endpoints?: string[];\n    rwd?: string;\n    own?: boolean;\n    pw?: string;\n}\n\n/**\n * @category GraphQL\n * @category Error\n */\nexport interface CmsErrorResponse {\n    message: string;\n    code: string;\n    data?: Record<string, any> | null;\n}\n/**\n * @category GraphQL\n * @category Meta\n */\nexport interface CmsMetaResponse {\n    totalCount: number;\n    cursor: string | null;\n    hasMoreItems: boolean;\n}\n\n/***\n * ###### FORM ########\n */\nexport interface BindComponentRenderProp<T = any> extends BaseBindComponentRenderProp<T> {\n    parentName: string;\n    appendValue: (value: any, index?: number) => void;\n    prependValue: (value: any) => void;\n    appendValues: (values: any[]) => void;\n    removeValue: (index: number) => void;\n    moveValueUp: (index: number) => void;\n    moveValueDown: (index: number) => void;\n}\n\ninterface BindComponentProps<T = any> extends Omit<BaseBindComponentProps, \"children\" | \"name\"> {\n    name?: string;\n    children?: ((props: BindComponentRenderProp<T>) => React.ReactElement) | React.ReactElement;\n}\n\nexport type BindComponent<T = any> = React.ComponentType<BindComponentProps<T>> & {\n    parentName: string;\n    ValidationContainer: React.ComponentType<{ children: React.ReactNode }>;\n};\n\n/**\n * After RequestReview and RequestChanges was removed, we need an option to add new status filters\n */\nexport interface CmsEntryFilterStatusPlugin extends Plugin {\n    type: \"cms.entry.filter.status\";\n    label: string;\n    value: string;\n}\n"],"mappings":"","ignoreList":[]}
+{"version":3,"names":["isLayoutDescriptor"],"sources":["index.ts"],"sourcesContent":["import type * as React from \"react\";\nimport type { ReactElement, ReactNode } from \"react\";\nimport type { Plugin } from \"@webiny/plugins/types.js\";\nimport type {\n    BindComponent as BaseBindComponent,\n    BindComponentProps as BaseBindComponentProps,\n    BindComponentRenderProp as BaseBindComponentRenderProp,\n    FormAPI\n} from \"@webiny/form\";\nimport type { IconName, IconPrefix } from \"@fortawesome/fontawesome-svg-core\";\nimport type {\n    CmsModelFieldValidator,\n    CmsModelFieldValidatorsFactory,\n    CmsModelFieldValidatorsGroup\n} from \"./validation.js\";\nimport type {\n    CmsBaseLayoutDescriptor,\n    CmsEditorFieldsLayout,\n    CmsLayoutDescriptor,\n    CmsModel,\n    CmsModelField\n} from \"./model.js\";\nimport type { CmsIdentity } from \"~/types/shared.js\";\nimport type { SourceType } from \"dnd-core\";\nimport type { IconPickerIconDto } from \"@webiny/admin-ui\";\nimport { GenericRecord } from \"@webiny/app/types.js\";\nimport { Identity } from \"@webiny/app-admin/domain/Identity.js\";\n\nexport type DragObjectWithType = {\n    type: SourceType;\n};\n\nexport type * from \"./validation.js\";\nexport type * from \"./model.js\";\nexport { isLayoutDescriptor } from \"./model.js\";\nexport type * from \"./shared.js\";\n\ninterface QueryFieldParams {\n    model: CmsModel;\n    field: CmsModelField;\n    graphQLTypePrefix: string;\n}\n\ninterface Position {\n    row: number;\n    index: number;\n}\n\ninterface Location {\n    folderId: string;\n}\n\nexport interface DragSource extends DragObjectWithType {\n    parent?: string;\n    pos?: Partial<Position>;\n    type: \"row\" | \"field\" | \"newField\" | \"newLayoutField\" | \"layoutField\";\n    fieldType?: string;\n    layoutFieldType?: string;\n    field?: CmsModelField | null;\n    fields?: CmsModelField[];\n    descriptor?: CmsLayoutDescriptor;\n}\n\n/**\n * @deprecated Use `CmsModelFieldTypePlugin`.\n */\nexport type CmsEditorFieldTypePlugin = CmsModelFieldTypePlugin;\n\nexport interface CmsModelFieldTypePlugin extends Plugin {\n    /**\n     * a plugin type\n     */\n    type: \"cms-editor-field-type\";\n    field: {\n        /**\n         * A unique identifier of the field type (text, number, json, myField, ...).\n         *\n         * ```ts\n         * type: \"myField\"\n         * ```\n         */\n        type: string;\n        /**\n         * A display name for the field.\n         *\n         * ```ts\n         * label: \"Field name\"\n         * ```\n         */\n        label: string;\n        /**\n         * A list of available validators for the model field.\n         *\n         * ```ts\n         * validators: [\n         *     \"required\",\n         *     \"gte\",\n         *     \"lte\"\n         * ]\n         * ```\n         */\n        validators?: string[] | CmsModelFieldValidatorsGroup | CmsModelFieldValidatorsFactory;\n        /**\n         * A list of available validators when a model field accepts a list (array) of values.\n         *\n         * ```ts\n         * listValidators: [\n         *     \"minLength\",\n         *     \"maxLength\"\n         * ]\n         * ```\n         */\n        listValidators?: string[] | CmsModelFieldValidatorsGroup | CmsModelFieldValidatorsFactory;\n        /**\n         * An explanation of the field displayed beneath the label.\n         *\n         * ```ts\n         * description: \"A short description of the field\"\n         * ```\n         */\n        description: string;\n        /**\n         * A ReactNode to display the icon for the field.\n         *\n         * ```tsx\n         * icon: <MyIconComponent />\n         * ```\n         */\n        icon: React.ReactNode;\n        /**\n         * Is it allowed to have multiple values in this field?\n         *\n         * ```ts\n         * allowList: true\n         * ```\n         */\n        allowList?: boolean;\n        /**\n         * Does this field type have a fixed list of values that can be selected?\n         *\n         * ```ts\n         * allowPredefinedValues: false\n         * ```\n         */\n        allowPredefinedValues?: boolean;\n        /**\n         * A ReactNode label when multiple values are enabled.\n         */\n        listLabel?: React.ReactNode;\n        /**\n         * Determines if this field type should be hidden from the admin UI.\n         * If set to `true`, the field type will not be visible or selectable in the admin interface.\n         */\n        hideInAdmin?: boolean;\n        /**\n         * These are default values when the field is first created. This is a representation of the field that is stored in the database.\n         *\n         * ```ts\n         * createField: () => ({\n         *     type: \"fieldType\",\n         *     validation: [],\n         *     renderer: {\n         *         name: \"fieldTypeRenderer\"\n         *     }\n         * })\n         * ```\n         */\n        createField: () => Pick<CmsModelField, \"type\" | \"validation\" | \"renderer\" | \"settings\">;\n        /**\n         * If `true` (default), this field will be configurable via a settings dialog.\n         * If `false`, a user will not be able to open the settings dialog, not will the dialog be opened on field drop.\n         */\n        canEditSettings?: boolean;\n        /**\n         * Determine if a `draggable` can be dropped into this field.\n         * NOTE: This is only applicable to nested field types.\n         */\n        canAccept?(field: CmsModelField, draggable: DragSource): boolean;\n        /**\n         * If `true` (default), will allow fields to be laid out into columns (next to each other).\n         * If `false`, horizontal layout will not be allowed.\n         * NOTE: This is only applicable to nested field types.\n         */\n        allowLayout?: boolean;\n        /**\n         * A ReactNode that you can add in the section below the help text when creating/editing field.\n         *\n         * ```tsx\n         * renderSettings: (params) => {\n         *     return <FieldSettingsComponent />;\n         * }\n         * ```\n         */\n        renderSettings?: (params: {\n            afterChangeLabel: (value: string) => void;\n            uniqueFieldIdValidator: (fieldId: string) => void;\n            contentModel: CmsModel;\n        }) => React.ReactNode;\n        /**\n         * A ReactNode that renders in the Predefined values tab.\n         *\n         * ```tsx\n         * renderPredefinedValues: (params) => {\n         *     const {form: {Bind}} = params;\n         *     return (\n         *         <Bind name=\"fieldProperty\">\n         *             <InputComponent />\n         *         </Bind>\n         *     );\n         * }\n         * ```\n         */\n        renderPredefinedValues?: (params: {\n            getBind: (index?: number) => any;\n        }) => React.ReactElement;\n        /**\n         * Object wrapper for GraphQL stuff\n         */\n        graphql?: {\n            /**\n             * Define field selection.\n             *\n             * ```ts\n             * graphql: {\n             *     queryField: `\n             *         {\n             *             id\n             *             title\n             *             createdOn\n             *         }\n             *     `,\n             * }\n             * ```\n             */\n            queryField?: string | ((params: QueryFieldParams) => string | null);\n        };\n        render?(params: any): React.ReactElement;\n        tags?: string[];\n        /**\n         * Render additional information in the Admin UI Model edit view\n         */\n        renderInfo?: (params: { field: CmsModelField; model: CmsModel }) => React.ReactElement;\n    };\n}\n\nexport interface CmsLayoutFieldTypePlugin extends Plugin {\n    type: \"cms-editor-layout-field-type\";\n    field: {\n        type: CmsLayoutDescriptor[\"type\"];\n        label: string;\n        description: string;\n        icon: React.ReactElement;\n        createDescriptor(): Omit<CmsLayoutDescriptor, \"id\">;\n        canEditSettings?: boolean;\n        renderSettings?(): React.ReactNode;\n        /**\n         * Collect all model fields embedded inside a layout descriptor's nested layout.\n         * Used during drag-and-drop to move embedded fields along with the descriptor\n         * across parent boundaries. Return `[]` or omit for descriptors with no nested fields.\n         */\n        collectFields?(params: {\n            descriptor: CmsLayoutDescriptor;\n            getField: (id: string) => CmsModelField | undefined;\n        }): CmsModelField[];\n        /**\n         * Return a label prefix for each field ID nested inside this layout descriptor.\n         * Used by `buildFieldOptions` to include layout hierarchy in field labels.\n         *\n         * For example, a tabs descriptor with label \"My Tabs\" containing a tab \"SEO\"\n         * with field \"metaTitle\" would return: `{ \"metaTitle\": \"My Tabs › SEO\" }`.\n         *\n         * Omit or return `{}` for descriptors that don't group fields.\n         */\n        getFieldLabelPrefixes?(params: { descriptor: CmsLayoutDescriptor }): Record<string, string>;\n        /**\n         * Controls how this layout field looks on the model editor canvas.\n         * Each plugin fully owns its visual representation.\n         */\n        render(params: {\n            descriptor: CmsLayoutDescriptor;\n            onUpdate: (d: CmsLayoutDescriptor) => void;\n            onDelete: () => void;\n        }): React.ReactElement;\n    };\n}\n\nexport interface CmsLayoutDescriptorRendererPlugin extends Plugin {\n    type: \"cms-layout-descriptor-renderer\";\n    descriptorType: string;\n    render(props: {\n        descriptor: CmsBaseLayoutDescriptor;\n        Bind: BindComponent;\n        fields: CmsModelField[];\n        contentModel: CmsModel;\n        gridClassName?: string;\n    }): React.ReactElement | null;\n}\n\nexport interface CmsModelFieldRendererSettingsProps {\n    field: CmsModelField;\n}\n\nexport interface CmsModelFieldRendererProps {\n    field: CmsModelField;\n    Label: React.ComponentType<React.PropsWithChildren>;\n    getBind: <T = any>(index?: number, key?: string) => BindComponent<T>;\n    contentModel: CmsModel;\n}\n\n/**\n * @deprecated Use `CmsModelFieldRendererProps`.\n */\nexport type CmsEditorFieldRendererProps = CmsModelFieldRendererProps;\n\n/**\n * @deprecated Use `CmsModelFieldRendererPlugin`.\n */\nexport type CmsEditorFieldRendererPlugin = CmsModelFieldRendererPlugin;\n\nexport interface CmsModelFieldRendererPlugin extends Plugin {\n    /**\n     * a plugin type\n     */\n    type: \"cms-editor-field-renderer\";\n    renderer: {\n        /**\n         * Name of the renderer to match the one from `createField()` method in `CmsModelFieldTypePlugin`.\n         *\n         * ```ts\n         * renderName: \"myFieldTypeRenderer\"\n         * ```\n         */\n        rendererName: string;\n        /**\n         * A display name for the field in the UI. It is a `ReactNode` type, so you can use a JSX element.\n         *\n         * ```tsx\n         * name: <MyFieldNameComponent />\n         * ```\n         */\n        name: React.ReactNode;\n        /**\n         * A description for the field in the UI. Works exactly like the `name` property.\n         *\n         * ```tsx\n         * name: <MyFieldDescriptionComponent />\n         * ```\n         */\n        description: React.ReactNode;\n        /**\n         * A method that determines if the field can be rendered by this plugin.\n         *\n         * ```ts\n         * canUse({ field }) {\n         *     return (\n         *         field.type === \"myType\" && !field.list\n         *     );\n         * }\n         * ```\n         */\n        canUse(props: {\n            field: CmsModelField;\n            fieldPlugin: CmsModelFieldTypePlugin;\n            model: CmsModel;\n        }): boolean;\n        /**\n         * Renders a field in the UI.\n         *\n         * ```tsx\n         * render({ field, getBind }) {\n         *     const Bind = getBind();\n         *\n         *     return (\n         *         <Bind>\n         *             {bind => {\n         *                 return (\n         *                     <Input\n         *                         value={bind.value}\n         *                         onChange={bind.onChange}\n         *                     />\n         *                 )\n         *             }}\n         *         </Bind>\n         *     );\n         * }\n         * ```\n         */\n        render(props: CmsModelFieldRendererProps): React.ReactNode;\n        renderSettings?: (props: CmsModelFieldRendererSettingsProps) => React.ReactNode;\n    };\n}\n\nexport interface CmsEditorFieldPredefinedValuesEntry {\n    label: string;\n    value: string;\n    selected?: boolean;\n}\n\nexport interface CmsEditorFieldPredefinedValues {\n    enabled: boolean;\n    values: CmsEditorFieldPredefinedValuesEntry[];\n}\n\nexport interface CmsDynamicZoneTemplate {\n    id: string;\n    name: string;\n    gqlTypeName: string;\n    description: string;\n    icon: string;\n    fields: CmsModelField[];\n    layout: CmsEditorFieldsLayout;\n    validation: CmsModelFieldValidator[];\n    tags?: string[];\n}\n\nexport interface CmsDynamicZoneTemplateWithTypename extends CmsDynamicZoneTemplate {\n    __typename: string;\n}\n\nexport type CmsContentEntryStatusType = \"draft\" | \"published\" | \"unpublished\";\n\n/**\n * @deprecated Use `CmsContentEntry`.\n */\nexport type CmsEditorContentEntry = CmsContentEntry;\n\nexport interface CmsContentEntryLive {\n    version: number;\n}\n\nexport interface CmsContentEntrySystem {\n    // to be extended\n}\n\nexport interface CmsContentEntry<TValues extends GenericRecord = GenericRecord> {\n    id: string;\n    entryId: string;\n    modelId: string;\n    createdOn: string;\n    createdBy: CmsIdentity;\n    savedOn: string;\n    savedBy: CmsIdentity;\n    modifiedOn: string | null;\n    modifiedBy: CmsIdentity | null;\n    deletedOn: string | null;\n    deletedBy: CmsIdentity | null;\n    firstPublishedOn: string | null;\n    firstPublishedBy: CmsIdentity | null;\n    lastPublishedOn: string | null;\n    lastPublishedBy: CmsIdentity | null;\n    revisionCreatedOn: string;\n    revisionCreatedBy: CmsIdentity;\n    revisionSavedOn: string;\n    revisionSavedBy: CmsIdentity;\n    revisionModifiedOn: string | null;\n    revisionModifiedBy: CmsIdentity | null;\n    revisionDeletedOn: string | null;\n    revisionDeletedBy: CmsIdentity | null;\n    revisionFirstPublishedOn: string | null;\n    revisionFirstPublishedBy: CmsIdentity | null;\n    revisionLastPublishedOn: string | null;\n    revisionLastPublishedBy: CmsIdentity | null;\n    wbyAco_location: Location;\n    live: CmsContentEntryLive | null;\n    system: CmsContentEntrySystem | null;\n    meta: {\n        title: string;\n        description?: string;\n        image?: string;\n        locked: boolean;\n        status: CmsContentEntryStatusType;\n        version: number;\n    };\n    values?: TValues;\n}\n\nexport interface CmsContentEntryRevision {\n    id: string;\n    modelId: string;\n    savedOn: string;\n    deletedOn: string | null;\n    firstPublishedOn: string | null;\n    lastPublishedOn: string | null;\n    createdBy: CmsIdentity;\n    deletedBy: CmsIdentity | null;\n    revisionCreatedOn: string;\n    revisionSavedOn: string;\n    revisionModifiedOn: string | null;\n    revisionDeletedOn: string | null;\n    revisionFirstPublishedOn: string | null;\n    revisionLastPublishedOn: string | null;\n    revisionCreatedBy: CmsIdentity;\n    revisionSavedBy: CmsIdentity;\n    revisionModifiedBy: CmsIdentity | null;\n    revisionDeletedBy: CmsIdentity | null;\n    revisionFirstPublishedBy: CmsIdentity | null;\n    revisionLastPublishedBy: CmsIdentity | null;\n    wbyAco_location: Location;\n    meta: {\n        title: string;\n        locked: boolean;\n        status: CmsContentEntryStatusType;\n        version: number;\n    };\n}\n\nexport type CmsEditorContentTab = React.ComponentType<{ activeTab: boolean }>;\n\n// ------------------------------------------------------------------------------------------------------------\nexport interface CmsEditorFieldOptionPlugin extends Plugin {\n    type: \"cms-editor-field-option\";\n    render(): ReactElement;\n}\n\nexport interface CmsContentDetailsPlugin extends Plugin {\n    render: (params: any) => ReactNode;\n}\n\nexport interface FieldLayoutPosition {\n    row: number;\n    index: number | null;\n}\n\nexport interface CmsEditorFormSettingsPlugin<T = GenericRecord> extends Plugin {\n    type: \"cms-editor-form-settings\";\n    title: string;\n    description: string;\n    icon: React.ReactElement;\n    showSave?: boolean;\n    render(props: { Bind: BaseBindComponent; form: FormAPI<T>; formData: T }): React.ReactNode;\n    renderHeaderActions?(props: {\n        Bind: BaseBindComponent;\n        form: FormAPI<T>;\n        formData: T;\n    }): React.ReactNode;\n}\n\nexport interface CmsIcon {\n    /**\n     * [ pack, icon ], ex: [\"fab\", \"cog\"]\n     */\n    id: [IconPrefix, IconName];\n    /**\n     * Icon name\n     */\n    name: string;\n    /**\n     * SVG element\n     */\n    svg: ReactElement;\n}\n\nexport interface CmsIconsPlugin extends Plugin {\n    type: \"cms-icons\";\n    getIcons(): IconPickerIconDto[];\n}\n\n/**\n * Transform field value when sending data to the API.\n */\nexport interface CmsFieldValueTransformer<TField extends CmsModelField = CmsModelField>\n    extends Plugin {\n    /**\n     * A plugin type.\n     */\n    type: \"cms-field-value-transformer\";\n    /**\n     * A field type for the value transformer. Or a list of field types.\n     */\n    fieldType: string | string[];\n    /**\n     * A transformer function that takes a value and returns a new one.\n     */\n    transform: (value: any, field: TField) => any;\n}\n\n/**\n * Define a custom form layout renderer for a specific content model.\n */\nexport interface CmsContentFormRendererPlugin extends Plugin {\n    /**\n     * A plugin type.\n     */\n    type: \"cms-content-form-renderer\";\n    /**\n     * Content model ID that will use this renderer.\n     */\n    modelId: string;\n\n    /**\n     * A function that will render a custom form layout.\n     */\n    render(props: {\n        /**\n         * Content model that is being rendered.\n         */\n        contentModel: CmsModel;\n        /**\n         * Content entry data handled by the Form element.\n         */\n        data: Record<string, any>;\n        /**\n         * A component to bind data to the Form.\n         */\n        Bind: BindComponent;\n        /**\n         * Content model fields to render.\n         */\n        fields: Record<string, React.ReactElement>;\n    }): React.ReactNode;\n}\n/**\n * #########################\n * Data types\n * #########################\n */\nexport interface CmsSecurityPermission extends Identity.Permission {\n    accessLevel?: \"full\" | \"no\" | \"custom\";\n    models?: string[];\n    groups?: string[];\n    endpoints?: string[];\n    rwd?: string;\n    own?: boolean;\n    pw?: string;\n}\n\n/**\n * @category GraphQL\n * @category Error\n */\nexport interface CmsErrorResponse {\n    message: string;\n    code: string;\n    data?: Record<string, any> | null;\n}\n/**\n * @category GraphQL\n * @category Meta\n */\nexport interface CmsMetaResponse {\n    totalCount: number;\n    cursor: string | null;\n    hasMoreItems: boolean;\n}\n\n/***\n * ###### FORM ########\n */\nexport interface BindComponentRenderProp<T = any> extends BaseBindComponentRenderProp<T> {\n    parentName: string;\n    appendValue: (value: any, index?: number) => void;\n    prependValue: (value: any) => void;\n    appendValues: (values: any[]) => void;\n    removeValue: (index: number) => void;\n    moveValueUp: (index: number) => void;\n    moveValueDown: (index: number) => void;\n}\n\ninterface BindComponentProps<T = any> extends Omit<BaseBindComponentProps, \"children\" | \"name\"> {\n    name?: string;\n    children?: ((props: BindComponentRenderProp<T>) => React.ReactElement) | React.ReactElement;\n}\n\nexport type BindComponent<T = any> = React.ComponentType<BindComponentProps<T>> & {\n    parentName: string;\n    ValidationContainer: React.ComponentType<{ children: React.ReactNode }>;\n};\n\n/**\n * After RequestReview and RequestChanges was removed, we need an option to add new status filters\n */\nexport interface CmsEntryFilterStatusPlugin extends Plugin {\n    type: \"cms.entry.filter.status\";\n    label: string;\n    value: string;\n}\n"],"mappings":"AAkCA,SAASA,kBAAkB;;AA6B3B;AACA;AACA;;AAoPA;AACA;AACA;;AAGA;AACA;AACA;;AAyGA;AACA;AACA;;AAqFA;;AAiDA;AACA;AACA;;AAiBA;AACA;AACA;;AAiCA;AACA;AACA;AACA;AACA;;AAWA;AACA;AACA;AACA;;AAMA;AACA;AACA;AACA;;AAOA;AACA;AACA;;AAqBA;AACA;AACA","ignoreList":[]}

package/types/model.d.ts

@@ -12,12 +12,20 @@ export interface CmsModelFieldSettings<T = unknown> {
     defaultSetValue?: string;
     type?: string;
     fields?: CmsModelField<T>[];
-    layout?: string[][];
+    layout?: CmsEditorFieldsLayout;
     models?: Pick<CmsModel, "modelId">[];
     templates?: CmsDynamicZoneTemplate[];
     imagesOnly?: boolean;
     [key: string]: any;
 }
+export type FieldRuleAction = "hide" | "disable" | string;
+export interface FieldRule {
+    type: "accessControl" | "condition";
+    target: string;
+    operator: string;
+    value: string | number | boolean | null;
+    action: FieldRuleAction;
+}
 export type CmsModelField<T = unknown> = T & {
     id: string;
     type: string;
@@ -43,9 +51,52 @@ export type CmsModelField<T = unknown> = T & {
      */
      | CmsModelFieldRendererPlugin["renderer"]["render"];
     tags?: string[];
+    rules?: FieldRule[];
 };
 export type CmsEditorFieldId = string;
-export type CmsEditorFieldsLayout = CmsEditorFieldId[][];
+export interface CmsBaseLayoutDescriptor {
+    id: string;
+    type: string;
+    rules?: FieldRule[];
+}
+export interface CmsSeparatorLayoutDescriptor extends CmsBaseLayoutDescriptor {
+    type: "separator";
+    label: string;
+    description?: string;
+}
+export interface CmsAlertLayoutDescriptor extends CmsBaseLayoutDescriptor {
+    type: "alert";
+    label: string;
+    alertType: "info" | "success" | "warning" | "danger";
+}
+export interface CmsTabLayoutTab {
+    id: string;
+    label: string;
+    icon?: string;
+    layout: CmsEditorFieldsLayout;
+    rules?: FieldRule[];
+}
+export interface CmsTabLayoutDescriptor extends CmsBaseLayoutDescriptor {
+    type: "tabs";
+    label: string;
+    description?: string | null;
+    help?: string | null;
+    tabs: CmsTabLayoutTab[];
+}
+export type CmsLayoutDescriptor = CmsSeparatorLayoutDescriptor | CmsAlertLayoutDescriptor | CmsTabLayoutDescriptor | CmsBaseLayoutDescriptor;
+export type CmsEditorLayoutCell = CmsEditorFieldId | CmsLayoutDescriptor;
+export type CmsEditorFieldsLayout = CmsEditorLayoutCell[][];
+/**
+ * Distinguish layout descriptors from field IDs (strings) and CmsModelField objects.
+ *
+ * In raw layout data (`CmsEditorFieldsLayout`), cells are either strings (field IDs)
+ * or layout descriptor objects — the `typeof` check handles that.
+ *
+ * In resolved layout data (after `getFieldsInLayout`), cells are either `CmsModelField`
+ * or layout descriptor objects — both have `{ id, type }`, but only `CmsModelField`
+ * has `fieldId`, so we use its absence as the discriminator.
+ */
+export declare function isLayoutDescriptor(cell: unknown): cell is CmsLayoutDescriptor;
 /**
  * @category GraphQL
  * @category Model

package/types/model.js

@@ -1,3 +1,29 @@
-export {};
+/**
+ * @deprecated Use `CmsModelField` instead.
+ */
+
+/**
+ * Distinguish layout descriptors from field IDs (strings) and CmsModelField objects.
+ *
+ * In raw layout data (`CmsEditorFieldsLayout`), cells are either strings (field IDs)
+ * or layout descriptor objects — the `typeof` check handles that.
+ *
+ * In resolved layout data (after `getFieldsInLayout`), cells are either `CmsModelField`
+ * or layout descriptor objects — both have `{ id, type }`, but only `CmsModelField`
+ * has `fieldId`, so we use its absence as the discriminator.
+ */
+export function isLayoutDescriptor(cell) {
+  return typeof cell === "object" && cell !== null && "type" in cell && typeof cell.type === "string" && !("fieldId" in cell);
+}
+
+/**
+ * @category GraphQL
+ * @category Model
+ */
+
+/**
+ * @category GraphQL
+ * @category Group
+ */
 
 //# sourceMappingURL=model.js.map

package/types/model.js.map

@@ -1 +1 @@
-{"version":3,"names":[],"sources":["model.ts"],"sourcesContent":["import type { Validator } from \"@webiny/validation/types.js\";\nimport type { CmsModelFieldValidator } from \"~/types/validation.js\";\nimport type {\n    CmsDynamicZoneTemplate,\n    CmsEditorFieldPredefinedValues,\n    CmsModelFieldRendererPlugin\n} from \"~/types/index.js\";\nimport type { CmsIdentity } from \"~/types/shared.js\";\nimport type React from \"react\";\n\n/**\n * @deprecated Use `CmsModelField` instead.\n */\nexport type CmsEditorField<T = unknown> = CmsModelField<T>;\n\nexport interface CmsModelFieldSettings<T = unknown> {\n    defaultValue?: string | boolean | number | null | undefined;\n    defaultSetValue?: string;\n    type?: string;\n    fields?: CmsModelField<T>[];\n    layout?: string[][];\n    models?: Pick<CmsModel, \"modelId\">[];\n    templates?: CmsDynamicZoneTemplate[];\n    imagesOnly?: boolean;\n    [key: string]: any;\n}\n\nexport type CmsModelField<T = unknown> = T & {\n    id: string;\n    type: string;\n    fieldId: CmsEditorFieldId;\n    storageId?: string;\n    label: string;\n    help?: string | React.ReactNode;\n    description?: string | React.ReactNode;\n    note?: string | React.ReactNode;\n    placeholder?: string;\n    validation?: (CmsModelFieldValidator | Validator)[];\n    listValidation?: CmsModelFieldValidator[];\n    list?: boolean;\n    predefinedValues?: CmsEditorFieldPredefinedValues;\n    settings?: CmsModelFieldSettings<T>;\n    renderer:\n        | {\n              name: string;\n              settings?: Record<string, any>;\n          }\n        /**\n         * Use this only for programmatic assignment of renderers.\n         * Since functions cannot be serialized, this can only work via code.\n         */\n        | CmsModelFieldRendererPlugin[\"renderer\"][\"render\"];\n    tags?: string[];\n};\n\nexport type CmsEditorFieldId = string;\nexport type CmsEditorFieldsLayout = CmsEditorFieldId[][];\n\n/**\n * @category GraphQL\n * @category Model\n */\nexport type CmsEditorContentModel = CmsModel;\n\n/**\n * @category GraphQL\n * @category Group\n */\nexport interface CmsGroup {\n    id: string;\n    name: string;\n    slug: string;\n    icon: string;\n    description?: string;\n    contentModels: CmsModel[];\n    createdBy: CmsIdentity;\n    /**\n     * Tells if this group is a plugin one (cannot be changed/deleted)\n     */\n    plugin?: boolean;\n}\n\nexport interface CmsModel {\n    id: string;\n    group: string;\n    description?: string;\n    version: number;\n    layout?: CmsEditorFieldsLayout;\n    fields: CmsModelField[];\n    icon: string;\n    name: string;\n    modelId: string;\n    singularApiName: string;\n    pluralApiName: string;\n    titleFieldId: string | null;\n    descriptionFieldId: string | null;\n    imageFieldId: string | null;\n    status: string;\n    savedOn: string;\n    meta: any;\n    createdBy: CmsIdentity;\n    tags: string[];\n    /**\n     * If model is a plugin one (it cannot be changed/deleted)\n     */\n    plugin?: boolean;\n    /**\n     * Is model currently being deleted?\n     */\n    isBeingDeleted?: boolean;\n    settings: {\n        [key: string]: any;\n    };\n}\n"],"mappings":"","ignoreList":[]}
+{"version":3,"names":["isLayoutDescriptor","cell","type"],"sources":["model.ts"],"sourcesContent":["import type { Validator } from \"@webiny/validation/types.js\";\nimport type { CmsModelFieldValidator } from \"~/types/validation.js\";\nimport type {\n    CmsDynamicZoneTemplate,\n    CmsEditorFieldPredefinedValues,\n    CmsModelFieldRendererPlugin\n} from \"~/types/index.js\";\nimport type { CmsIdentity } from \"~/types/shared.js\";\nimport type React from \"react\";\n\n/**\n * @deprecated Use `CmsModelField` instead.\n */\nexport type CmsEditorField<T = unknown> = CmsModelField<T>;\n\nexport interface CmsModelFieldSettings<T = unknown> {\n    defaultValue?: string | boolean | number | null | undefined;\n    defaultSetValue?: string;\n    type?: string;\n    fields?: CmsModelField<T>[];\n    layout?: CmsEditorFieldsLayout;\n    models?: Pick<CmsModel, \"modelId\">[];\n    templates?: CmsDynamicZoneTemplate[];\n    imagesOnly?: boolean;\n    [key: string]: any;\n}\n\nexport type FieldRuleAction = \"hide\" | \"disable\" | string;\n\nexport interface FieldRule {\n    type: \"accessControl\" | \"condition\";\n    target: string;\n    operator: string;\n    value: string | number | boolean | null;\n    action: FieldRuleAction;\n}\n\nexport type CmsModelField<T = unknown> = T & {\n    id: string;\n    type: string;\n    fieldId: CmsEditorFieldId;\n    storageId?: string;\n    label: string;\n    help?: string | React.ReactNode;\n    description?: string | React.ReactNode;\n    note?: string | React.ReactNode;\n    placeholder?: string;\n    validation?: (CmsModelFieldValidator | Validator)[];\n    listValidation?: CmsModelFieldValidator[];\n    list?: boolean;\n    predefinedValues?: CmsEditorFieldPredefinedValues;\n    settings?: CmsModelFieldSettings<T>;\n    renderer:\n        | {\n              name: string;\n              settings?: Record<string, any>;\n          }\n        /**\n         * Use this only for programmatic assignment of renderers.\n         * Since functions cannot be serialized, this can only work via code.\n         */\n        | CmsModelFieldRendererPlugin[\"renderer\"][\"render\"];\n    tags?: string[];\n    rules?: FieldRule[];\n};\n\nexport type CmsEditorFieldId = string;\n\nexport interface CmsBaseLayoutDescriptor {\n    id: string;\n    type: string;\n    rules?: FieldRule[];\n}\n\nexport interface CmsSeparatorLayoutDescriptor extends CmsBaseLayoutDescriptor {\n    type: \"separator\";\n    label: string;\n    description?: string;\n}\n\nexport interface CmsAlertLayoutDescriptor extends CmsBaseLayoutDescriptor {\n    type: \"alert\";\n    label: string;\n    alertType: \"info\" | \"success\" | \"warning\" | \"danger\";\n}\n\nexport interface CmsTabLayoutTab {\n    id: string;\n    label: string;\n    icon?: string;\n    layout: CmsEditorFieldsLayout;\n    rules?: FieldRule[];\n}\n\nexport interface CmsTabLayoutDescriptor extends CmsBaseLayoutDescriptor {\n    type: \"tabs\";\n    label: string;\n    description?: string | null;\n    help?: string | null;\n    tabs: CmsTabLayoutTab[];\n}\n\nexport type CmsLayoutDescriptor =\n    | CmsSeparatorLayoutDescriptor\n    | CmsAlertLayoutDescriptor\n    | CmsTabLayoutDescriptor\n    | CmsBaseLayoutDescriptor;\n\nexport type CmsEditorLayoutCell = CmsEditorFieldId | CmsLayoutDescriptor;\nexport type CmsEditorFieldsLayout = CmsEditorLayoutCell[][];\n\n/**\n * Distinguish layout descriptors from field IDs (strings) and CmsModelField objects.\n *\n * In raw layout data (`CmsEditorFieldsLayout`), cells are either strings (field IDs)\n * or layout descriptor objects — the `typeof` check handles that.\n *\n * In resolved layout data (after `getFieldsInLayout`), cells are either `CmsModelField`\n * or layout descriptor objects — both have `{ id, type }`, but only `CmsModelField`\n * has `fieldId`, so we use its absence as the discriminator.\n */\nexport function isLayoutDescriptor(cell: unknown): cell is CmsLayoutDescriptor {\n    return (\n        typeof cell === \"object\" &&\n        cell !== null &&\n        \"type\" in cell &&\n        typeof (cell as any).type === \"string\" &&\n        !(\"fieldId\" in cell)\n    );\n}\n\n/**\n * @category GraphQL\n * @category Model\n */\nexport type CmsEditorContentModel = CmsModel;\n\n/**\n * @category GraphQL\n * @category Group\n */\nexport interface CmsGroup {\n    id: string;\n    name: string;\n    slug: string;\n    icon: string;\n    description?: string;\n    contentModels: CmsModel[];\n    createdBy: CmsIdentity;\n    /**\n     * Tells if this group is a plugin one (cannot be changed/deleted)\n     */\n    plugin?: boolean;\n}\n\nexport interface CmsModel {\n    id: string;\n    group: string;\n    description?: string;\n    version: number;\n    layout?: CmsEditorFieldsLayout;\n    fields: CmsModelField[];\n    icon: string;\n    name: string;\n    modelId: string;\n    singularApiName: string;\n    pluralApiName: string;\n    titleFieldId: string | null;\n    descriptionFieldId: string | null;\n    imageFieldId: string | null;\n    status: string;\n    savedOn: string;\n    meta: any;\n    createdBy: CmsIdentity;\n    tags: string[];\n    /**\n     * If model is a plugin one (it cannot be changed/deleted)\n     */\n    plugin?: boolean;\n    /**\n     * Is model currently being deleted?\n     */\n    isBeingDeleted?: boolean;\n    settings: {\n        [key: string]: any;\n    };\n}\n"],"mappings":"AAUA;AACA;AACA;;AAmGA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASA,kBAAkBA,CAACC,IAAa,EAA+B;EAC3E,OACI,OAAOA,IAAI,KAAK,QAAQ,IACxBA,IAAI,KAAK,IAAI,IACb,MAAM,IAAIA,IAAI,IACd,OAAQA,IAAI,CAASC,IAAI,KAAK,QAAQ,IACtC,EAAE,SAAS,IAAID,IAAI,CAAC;AAE5B;;AAEA;AACA;AACA;AACA;;AAGA;AACA;AACA;AACA","ignoreList":[]}