@webiny/app-headless-cms-common 0.0.0-unstable.ac6ebf63c6 → 0.0.0-unstable.b6d7105cee

package/constants.js

@@ -1,3 +1,4 @@
-export const CMS_MODEL_SINGLETON_TAG = "singleEntry";
+const CMS_MODEL_SINGLETON_TAG = "singleEntry";
+export { CMS_MODEL_SINGLETON_TAG };
 
 //# sourceMappingURL=constants.js.map

package/constants.js.map

@@ -1 +1 @@
-{"version":3,"names":["CMS_MODEL_SINGLETON_TAG"],"sources":["constants.ts"],"sourcesContent":["export const CMS_MODEL_SINGLETON_TAG = \"singleEntry\";\n"],"mappings":"AAAA,OAAO,MAAMA,uBAAuB,GAAG,aAAa","ignoreList":[]}
+{"version":3,"file":"constants.js","sources":["../src/constants.ts"],"sourcesContent":["export const CMS_MODEL_SINGLETON_TAG = \"singleEntry\";\n"],"names":["CMS_MODEL_SINGLETON_TAG"],"mappings":"AAAO,MAAMA,0BAA0B"}

package/exports/admin/cms.d.ts

@@ -1 +1 @@
-export type { CmsContentEntry, CmsModel, CmsModelField, CmsIdentity } from "../../types/index.ts";
+export type { CmsContentEntry, CmsModel, CmsModelField, CmsModelLayoutField, CmsIdentity } from "../../types/index.js";

package/exports/admin/cms.js

@@ -1,3 +0,0 @@
-export {};
-
-//# sourceMappingURL=cms.js.map

package/index.d.ts

@@ -1,10 +1 @@
-export * from "./Fields/index.js";
-export * from "./ModelFieldProvider/index.js";
-export * from "./ModelProvider/index.js";
-export * from "./entries.graphql.js";
-export * from "./getModelTitleFieldId.js";
-export * from "./createFieldsList.js";
-export * from "./createValidationContainer.js";
-export * from "./createValidators.js";
-export * from "./prepareFormData.js";
-export * from "./constants.js";
+export { CMS_MODEL_SINGLETON_TAG } from "./constants.js";

package/index.js

@@ -1,12 +1 @@
-export * from "./Fields/index.js";
-export * from "./ModelFieldProvider/index.js";
-export * from "./ModelProvider/index.js";
-export * from "./entries.graphql.js";
-export * from "./getModelTitleFieldId.js";
-export * from "./createFieldsList.js";
-export * from "./createValidationContainer.js";
-export * from "./createValidators.js";
-export * from "./prepareFormData.js";
-export * from "./constants.js";
-
-//# sourceMappingURL=index.js.map
+export { CMS_MODEL_SINGLETON_TAG } from "./constants.js";

package/package.json

@@ -1,8 +1,11 @@
 {
 	"name": "@webiny/app-headless-cms-common",
-	"version": "0.0.0-unstable.ac6ebf63c6",
+	"version": "0.0.0-unstable.b6d7105cee",
 	"type": "module",
-	"main": "index.js",
+	"exports": {
+		".": "./index.js",
+		"./*": "./*"
+	},
 	"repository": {
 		"type": "git",
 		"url": "https://github.com/webiny/webiny-js.git"
@@ -14,34 +17,27 @@
 	],
 	"license": "MIT",
 	"dependencies": {
-		"@emotion/react": "11.10.8",
-		"@emotion/styled": "11.10.6",
-		"@fortawesome/fontawesome-svg-core": "1.3.0",
-		"@webiny/admin-ui": "0.0.0-unstable.ac6ebf63c6",
-		"@webiny/app": "0.0.0-unstable.ac6ebf63c6",
-		"@webiny/app-admin": "0.0.0-unstable.ac6ebf63c6",
-		"@webiny/form": "0.0.0-unstable.ac6ebf63c6",
-		"@webiny/plugins": "0.0.0-unstable.ac6ebf63c6",
-		"@webiny/react-composition": "0.0.0-unstable.ac6ebf63c6",
-		"@webiny/validation": "0.0.0-unstable.ac6ebf63c6",
+		"@fortawesome/fontawesome-svg-core": "7.3.1",
+		"@webiny/admin-ui": "0.0.0-unstable.b6d7105cee",
+		"@webiny/app": "0.0.0-unstable.b6d7105cee",
+		"@webiny/app-admin": "0.0.0-unstable.b6d7105cee",
+		"@webiny/form": "0.0.0-unstable.b6d7105cee",
+		"@webiny/plugins": "0.0.0-unstable.b6d7105cee",
+		"@webiny/validation": "0.0.0-unstable.b6d7105cee",
 		"dnd-core": "16.0.1",
-		"graphql": "16.12.0",
-		"graphql-tag": "2.12.6",
-		"lodash": "4.17.23",
-		"prop-types": "15.8.1",
-		"react": "18.2.0"
+		"react": "18.3.1"
 	},
 	"devDependencies": {
-		"@emotion/babel-plugin": "11.13.5",
-		"@types/react": "18.2.79",
-		"@webiny/build-tools": "0.0.0-unstable.ac6ebf63c6",
-		"babel-plugin-module-resolver": "5.0.2",
+		"@types/react": "18.3.31",
+		"@webiny/build-tools": "0.0.0-unstable.b6d7105cee",
 		"rimraf": "6.1.3",
-		"typescript": "5.9.3"
+		"typescript": "7.0.2"
 	},
 	"publishConfig": {
-		"access": "public",
-		"directory": "dist"
+		"access": "public"
 	},
-	"gitHead": "ac6ebf63c6de308703d41f2c1b375e03cd96b813"
+	"gitHead": "8476da73b653c89cc1474d968baf55c1b0ae0e5f",
+	"webiny": {
+		"publishFrom": "dist"
+	}
 }

package/types/index.d.ts

@@ -3,24 +3,19 @@ import type { ReactElement, ReactNode } from "react";
 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 { CmsEditorFieldsLayout, CmsLayoutField, 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";
-import { GenericRecord } from "@webiny/app/types.js";
-import { Identity } from "@webiny/app-admin/domain/Identity.js";
+import type { GenericRecord } from "@webiny/app/types.js";
+import type { Identity } from "@webiny/app-admin/domain/Identity.js";
+import type { CmsModelFieldValidator } from "./model.js";
 export type DragObjectWithType = {
     type: SourceType;
 };
-export type * from "./validation.js";
 export type * from "./model.js";
+export { isLayoutField } from "./model.js";
 export type * from "./shared.js";
-interface QueryFieldParams {
-    model: CmsModel;
-    field: CmsModelField;
-    graphQLTypePrefix: string;
-}
 interface Position {
     row: number;
     index: number;
@@ -31,282 +26,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[];
-}
-/**
- * @deprecated Use `CmsModelFieldTypePlugin`.
- */
-export type CmsEditorFieldTypePlugin = CmsModelFieldTypePlugin;
-export interface CmsModelFieldTypePlugin extends Plugin {
-    /**
-     * a plugin type
-     */
-    type: "cms-editor-field-type";
-    field: {
-        /**
-         * A unique identifier of the field type (text, number, json, myField, ...).
-         *
-         * ```ts
-         * type: "myField"
-         * ```
-         */
-        type: string;
-        /**
-         * A display name for the field.
-         *
-         * ```ts
-         * label: "Field name"
-         * ```
-         */
-        label: string;
-        /**
-         * A list of available validators for the model field.
-         *
-         * ```ts
-         * validators: [
-         *     "required",
-         *     "gte",
-         *     "lte"
-         * ]
-         * ```
-         */
-        validators?: string[] | CmsModelFieldValidatorsGroup | CmsModelFieldValidatorsFactory;
-        /**
-         * A list of available validators when a model field accepts a list (array) of values.
-         *
-         * ```ts
-         * listValidators: [
-         *     "minLength",
-         *     "maxLength"
-         * ]
-         * ```
-         */
-        listValidators?: string[] | CmsModelFieldValidatorsGroup | CmsModelFieldValidatorsFactory;
-        /**
-         * An explanation of the field displayed beneath the label.
-         *
-         * ```ts
-         * description: "A short description of the field"
-         * ```
-         */
-        description: string;
-        /**
-         * A ReactNode to display the icon for the field.
-         *
-         * ```tsx
-         * icon: <MyIconComponent />
-         * ```
-         */
-        icon: React.ReactNode;
-        /**
-         * Is it allowed to have multiple values in this field?
-         *
-         * ```ts
-         * allowList: true
-         * ```
-         */
-        allowList?: boolean;
-        /**
-         * Does this field type have a fixed list of values that can be selected?
-         *
-         * ```ts
-         * allowPredefinedValues: false
-         * ```
-         */
-        allowPredefinedValues?: boolean;
-        /**
-         * A ReactNode label when multiple values are enabled.
-         */
-        listLabel?: React.ReactNode;
-        /**
-         * Determines if this field type should be hidden from the admin UI.
-         * If set to `true`, the field type will not be visible or selectable in the admin interface.
-         */
-        hideInAdmin?: boolean;
-        /**
-         * These are default values when the field is first created. This is a representation of the field that is stored in the database.
-         *
-         * ```ts
-         * createField: () => ({
-         *     type: "fieldType",
-         *     validation: [],
-         *     renderer: {
-         *         name: "fieldTypeRenderer"
-         *     }
-         * })
-         * ```
-         */
-        createField: () => Pick<CmsModelField, "type" | "validation" | "renderer" | "settings">;
-        /**
-         * If `true` (default), this field will be configurable via a settings dialog.
-         * If `false`, a user will not be able to open the settings dialog, not will the dialog be opened on field drop.
-         */
-        canEditSettings?: boolean;
-        /**
-         * Determine if a `draggable` can be dropped into this field.
-         * NOTE: This is only applicable to nested field types.
-         */
-        canAccept?(field: CmsModelField, draggable: DragSource): boolean;
-        /**
-         * If `true` (default), will allow fields to be laid out into columns (next to each other).
-         * If `false`, horizontal layout will not be allowed.
-         * NOTE: This is only applicable to nested field types.
-         */
-        allowLayout?: boolean;
-        /**
-         * A ReactNode that you can add in the section below the help text when creating/editing field.
-         *
-         * ```tsx
-         * renderSettings: (params) => {
-         *     return <FieldSettingsComponent />;
-         * }
-         * ```
-         */
-        renderSettings?: (params: {
-            afterChangeLabel: (value: string) => void;
-            uniqueFieldIdValidator: (fieldId: string) => void;
-            contentModel: CmsModel;
-        }) => React.ReactNode;
-        /**
-         * A ReactNode that renders in the Predefined values tab.
-         *
-         * ```tsx
-         * renderPredefinedValues: (params) => {
-         *     const {form: {Bind}} = params;
-         *     return (
-         *         <Bind name="fieldProperty">
-         *             <InputComponent />
-         *         </Bind>
-         *     );
-         * }
-         * ```
-         */
-        renderPredefinedValues?: (params: {
-            getBind: (index?: number) => any;
-        }) => React.ReactElement;
-        /**
-         * Object wrapper for GraphQL stuff
-         */
-        graphql?: {
-            /**
-             * Define field selection.
-             *
-             * ```ts
-             * graphql: {
-             *     queryField: `
-             *         {
-             *             id
-             *             title
-             *             createdOn
-             *         }
-             *     `,
-             * }
-             * ```
-             */
-            queryField?: string | ((params: QueryFieldParams) => string | null);
-        };
-        render?(params: any): React.ReactElement;
-        tags?: string[];
-        /**
-         * Render additional information in the Admin UI Model edit view
-         */
-        renderInfo?: (params: {
-            field: CmsModelField;
-            model: CmsModel;
-        }) => React.ReactElement;
-    };
-}
-export interface CmsModelFieldRendererSettingsProps {
-    field: CmsModelField;
-}
-export interface CmsModelFieldRendererProps {
-    field: CmsModelField;
-    Label: React.ComponentType<React.PropsWithChildren>;
-    getBind: <T = any>(index?: number, key?: string) => BindComponent<T>;
-    contentModel: CmsModel;
-}
-/**
- * @deprecated Use `CmsModelFieldRendererProps`.
- */
-export type CmsEditorFieldRendererProps = CmsModelFieldRendererProps;
-/**
- * @deprecated Use `CmsModelFieldRendererPlugin`.
- */
-export type CmsEditorFieldRendererPlugin = CmsModelFieldRendererPlugin;
-export interface CmsModelFieldRendererPlugin extends Plugin {
-    /**
-     * a plugin type
-     */
-    type: "cms-editor-field-renderer";
-    renderer: {
-        /**
-         * Name of the renderer to match the one from `createField()` method in `CmsModelFieldTypePlugin`.
-         *
-         * ```ts
-         * renderName: "myFieldTypeRenderer"
-         * ```
-         */
-        rendererName: string;
-        /**
-         * A display name for the field in the UI. It is a `ReactNode` type, so you can use a JSX element.
-         *
-         * ```tsx
-         * name: <MyFieldNameComponent />
-         * ```
-         */
-        name: React.ReactNode;
-        /**
-         * A description for the field in the UI. Works exactly like the `name` property.
-         *
-         * ```tsx
-         * name: <MyFieldDescriptionComponent />
-         * ```
-         */
-        description: React.ReactNode;
-        /**
-         * A method that determines if the field can be rendered by this plugin.
-         *
-         * ```ts
-         * canUse({ field }) {
-         *     return (
-         *         field.type === "myType" && !field.list
-         *     );
-         * }
-         * ```
-         */
-        canUse(props: {
-            field: CmsModelField;
-            fieldPlugin: CmsModelFieldTypePlugin;
-            model: CmsModel;
-        }): boolean;
-        /**
-         * Renders a field in the UI.
-         *
-         * ```tsx
-         * render({ field, getBind }) {
-         *     const Bind = getBind();
-         *
-         *     return (
-         *         <Bind>
-         *             {bind => {
-         *                 return (
-         *                     <Input
-         *                         value={bind.value}
-         *                         onChange={bind.onChange}
-         *                     />
-         *                 )
-         *             }}
-         *         </Bind>
-         *     );
-         * }
-         * ```
-         */
-        render(props: CmsModelFieldRendererProps): React.ReactNode;
-        renderSettings?: (props: CmsModelFieldRendererSettingsProps) => React.ReactNode;
-    };
+    layoutField?: CmsLayoutField;
 }
 export interface CmsEditorFieldPredefinedValuesEntry {
     label: string;
@@ -324,18 +49,17 @@ export interface CmsDynamicZoneTemplate {
     description: string;
     icon: string;
     fields: CmsModelField[];
-    layout: string[][];
+    layout: CmsEditorFieldsLayout;
     validation: CmsModelFieldValidator[];
     tags?: string[];
-}
-export interface CmsDynamicZoneTemplateWithTypename extends CmsDynamicZoneTemplate {
-    __typename: string;
+    componentName?: string;
 }
 export type CmsContentEntryStatusType = "draft" | "published" | "unpublished";
-/**
- * @deprecated Use `CmsContentEntry`.
- */
-export type CmsEditorContentEntry = CmsContentEntry;
+export interface CmsContentEntryLive {
+    version: number;
+}
+export interface CmsContentEntrySystem {
+}
 export interface CmsContentEntry<TValues extends GenericRecord = GenericRecord> {
     id: string;
     entryId: string;
@@ -365,6 +89,8 @@ export interface CmsContentEntry<TValues extends GenericRecord = GenericRecord>
     revisionLastPublishedOn: string | null;
     revisionLastPublishedBy: CmsIdentity | null;
     wbyAco_location: Location;
+    live: CmsContentEntryLive | null;
+    system: CmsContentEntrySystem | null;
     meta: {
         title: string;
         description?: string;
@@ -373,7 +99,8 @@ export interface CmsContentEntry<TValues extends GenericRecord = GenericRecord>
         status: CmsContentEntryStatusType;
         version: number;
     };
-    values?: TValues;
+    revisionDescription?: string;
+    values: TValues;
 }
 export interface CmsContentEntryRevision {
     id: string;
@@ -397,6 +124,7 @@ export interface CmsContentEntryRevision {
     revisionFirstPublishedBy: CmsIdentity | null;
     revisionLastPublishedBy: CmsIdentity | null;
     wbyAco_location: Location;
+    revisionDescription?: string;
     meta: {
         title: string;
         locked: boolean;
@@ -404,9 +132,6 @@ export interface CmsContentEntryRevision {
         version: number;
     };
 }
-export type CmsEditorContentTab = React.ComponentType<{
-    activeTab: boolean;
-}>;
 export interface CmsEditorFieldOptionPlugin extends Plugin {
     type: "cms-editor-field-option";
     render(): ReactElement;
@@ -414,10 +139,6 @@ export interface CmsEditorFieldOptionPlugin extends Plugin {
 export interface CmsContentDetailsPlugin extends Plugin {
     render: (params: any) => ReactNode;
 }
-export interface FieldLayoutPosition {
-    row: number;
-    index: number | null;
-}
 export interface CmsEditorFormSettingsPlugin<T = GenericRecord> extends Plugin {
     type: "cms-editor-form-settings";
     title: string;
@@ -517,6 +238,7 @@ export interface CmsSecurityPermission extends Identity.Permission {
     rwd?: string;
     own?: boolean;
     pw?: string;
+    _src?: string;
 }
 /**
  * @category GraphQL

package/types/index.js

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

package/types/model.d.ts

@@ -1,23 +1,31 @@
+import type React from "react";
 import type { Validator } from "@webiny/validation/types.js";
-import type { CmsModelFieldValidator } from "../types/validation.js";
-import type { CmsDynamicZoneTemplate, CmsEditorFieldPredefinedValues, CmsModelFieldRendererPlugin } from "../types/index.js";
+import type { CmsDynamicZoneTemplate, CmsEditorFieldPredefinedValues } from "../types/index.js";
 import type { CmsIdentity } from "../types/shared.js";
-import type React from "react";
-/**
- * @deprecated Use `CmsModelField` instead.
- */
-export type CmsEditorField<T = unknown> = CmsModelField<T>;
+export interface CmsModelFieldValidator {
+    name: string;
+    message?: string;
+    settings?: any;
+}
 export interface CmsModelFieldSettings<T = unknown> {
     defaultValue?: string | boolean | number | null | undefined;
     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;
@@ -36,21 +44,54 @@ export type CmsModelField<T = unknown> = T & {
     renderer: {
         name: string;
         settings?: Record<string, any>;
-    }
-    /**
-     * Use this only for programmatic assignment of renderers.
-     * Since functions cannot be serialized, this can only work via code.
-     */
-     | CmsModelFieldRendererPlugin["renderer"]["render"];
+    };
     tags?: string[];
+    rules?: FieldRule[];
 };
 export type CmsEditorFieldId = string;
-export type CmsEditorFieldsLayout = CmsEditorFieldId[][];
+export interface CmsModelLayoutField {
+    id: string;
+    type: string;
+    rules?: FieldRule[];
+}
+export interface CmsSeparatorLayoutField extends CmsModelLayoutField {
+    type: "separator";
+    label: string;
+    description?: string;
+}
+export interface CmsAlertLayoutField extends CmsModelLayoutField {
+    type: "alert";
+    label: string;
+    alertType: "info" | "success" | "warning" | "danger";
+}
+export interface CmsTabLayoutTab {
+    id: string;
+    label: string;
+    icon?: string;
+    layout: CmsEditorFieldsLayout;
+    rules?: FieldRule[];
+}
+export interface CmsTabLayoutField extends CmsModelLayoutField {
+    type: "tabs";
+    label: string;
+    description?: string | null;
+    help?: string | null;
+    tabs: CmsTabLayoutTab[];
+}
+export type CmsLayoutField = CmsSeparatorLayoutField | CmsAlertLayoutField | CmsTabLayoutField | CmsModelLayoutField;
+export type CmsEditorLayoutCell = CmsEditorFieldId | CmsLayoutField;
+export type CmsEditorFieldsLayout = CmsEditorLayoutCell[][];
 /**
- * @category GraphQL
- * @category Model
+ * Distinguish layout fields from field IDs (strings) and CmsModelField objects.
+ *
+ * In raw layout data (`CmsEditorFieldsLayout`), cells are either strings (field IDs)
+ * or layout field objects — the `typeof` check handles that.
+ *
+ * In resolved layout data (after `getFieldsInLayout`), cells are either `CmsModelField`
+ * or layout field objects — both have `{ id, type }`, but only `CmsModelField`
+ * has `fieldId`, so we use its absence as the discriminator.
  */
-export type CmsEditorContentModel = CmsModel;
+export declare function isLayoutField(cell: unknown): cell is CmsLayoutField;
 /**
  * @category GraphQL
  * @category Group
@@ -96,7 +137,11 @@ export interface CmsModel {
      * Is model currently being deleted?
      */
     isBeingDeleted?: boolean;
+    valuesSelection?: string;
     settings: {
         [key: string]: any;
     };
+    metadata: {
+        valuesSelection: string;
+    };
 }

package/types/model.js

@@ -1,3 +1,6 @@
-export {};
+function isLayoutField(cell) {
+    return "object" == typeof cell && null !== cell && "type" in cell && "string" == typeof cell.type && !("fieldId" in cell);
+}
+export { isLayoutField };
 
 //# 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,"file":"types/model.js","sources":["../../src/types/model.ts"],"sourcesContent":["import type React from \"react\";\nimport type { Validator } from \"@webiny/validation/types.js\";\nimport type { CmsDynamicZoneTemplate, CmsEditorFieldPredefinedValues } from \"~/types/index.js\";\nimport type { CmsIdentity } from \"~/types/shared.js\";\n\nexport interface CmsModelFieldValidator {\n    name: string;\n    message?: string;\n    settings?: any;\n}\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        name: string;\n        settings?: Record<string, any>;\n    };\n    tags?: string[];\n    rules?: FieldRule[];\n};\n\nexport type CmsEditorFieldId = string;\n\nexport interface CmsModelLayoutField {\n    id: string;\n    type: string;\n    rules?: FieldRule[];\n}\n\nexport interface CmsSeparatorLayoutField extends CmsModelLayoutField {\n    type: \"separator\";\n    label: string;\n    description?: string;\n}\n\nexport interface CmsAlertLayoutField extends CmsModelLayoutField {\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 CmsTabLayoutField extends CmsModelLayoutField {\n    type: \"tabs\";\n    label: string;\n    description?: string | null;\n    help?: string | null;\n    tabs: CmsTabLayoutTab[];\n}\n\nexport type CmsLayoutField =\n    | CmsSeparatorLayoutField\n    | CmsAlertLayoutField\n    | CmsTabLayoutField\n    | CmsModelLayoutField;\n\nexport type CmsEditorLayoutCell = CmsEditorFieldId | CmsLayoutField;\nexport type CmsEditorFieldsLayout = CmsEditorLayoutCell[][];\n\n/**\n * Distinguish layout fields from field IDs (strings) and CmsModelField objects.\n *\n * In raw layout data (`CmsEditorFieldsLayout`), cells are either strings (field IDs)\n * or layout field objects — the `typeof` check handles that.\n *\n * In resolved layout data (after `getFieldsInLayout`), cells are either `CmsModelField`\n * or layout field objects — both have `{ id, type }`, but only `CmsModelField`\n * has `fieldId`, so we use its absence as the discriminator.\n */\nexport function isLayoutField(cell: unknown): cell is CmsLayoutField {\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 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    valuesSelection?: string;\n    settings: {\n        [key: string]: any;\n    };\n    metadata: {\n        valuesSelection: string;\n    };\n}\n"],"names":["isLayoutField","cell"],"mappings":"AA+GO,SAASA,cAAcC,IAAa;IACvC,OACI,AAAgB,YAAhB,OAAOA,QACPA,AAAS,SAATA,QACA,UAAUA,QACV,AAA8B,YAA9B,OAAQA,KAAa,IAAI,IACzB,CAAE,cAAaA,IAAG;AAE1B"}

package/types/shared.d.ts

@@ -1,5 +1,11 @@
+import type { IconPickerIconDto } from "@webiny/admin-ui";
+import type { Plugin } from "@webiny/plugins/types.js";
 export interface CmsIdentity {
     id: string;
     displayName: string;
     type: string;
 }
+export interface CmsIconsPlugin extends Plugin {
+    type: "cms-icons";
+    getIcons(): IconPickerIconDto[];
+}