@webiny/app-headless-cms 0.0.0-ee-vpcs.549378cf03

package/types/index.d.ts

@@ -0,0 +1,468 @@
+import * as React from "react";
+import { Plugin } from "@webiny/plugins/types";
+import { ReactElement, ReactNode } from "react";
+import { FormAPI, BindComponent as BaseBindComponent, BindComponentRenderProp as BaseBindComponentRenderProp, BindComponentProps as BaseBindComponentProps } from "@webiny/form";
+import { IconPrefix, IconName } from "@fortawesome/fontawesome-svg-core";
+import Label from "../admin/components/ContentEntryForm/Label";
+import { SecurityPermission } from "@webiny/app-security/types";
+import { DragSource } from "../admin/components/FieldEditor/FieldEditorContext";
+import { CmsModelFieldValidator, CmsModelFieldValidatorsGroup, CmsModelFieldValidatorsFactory } from "./validation";
+import { CmsModelField, CmsModel } from "./model";
+import { CmsCreatedBy } from "./shared";
+export * from "./validation";
+export * from "./model";
+export * from "./shared";
+interface QueryFieldParams {
+    model: CmsModel;
+    field: CmsModelField;
+}
+export declare 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
+         * allowMultipleValues: true
+         * ```
+         */
+        allowMultipleValues: 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.
+         */
+        multipleValuesLabel: React.ReactNode;
+        /**
+         * 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);
+        };
+        render?(params: any): React.ReactElement;
+        tags?: string[];
+    };
+}
+export interface CmsEditorFieldRendererProps {
+    field: CmsModelField;
+    Label: typeof Label;
+    getBind: (index?: number, key?: string) => BindComponent;
+    contentModel: CmsModel;
+}
+export interface CmsEditorFieldRendererPlugin extends Plugin {
+    /**
+     * a plugin type
+     */
+    type: "cms-editor-field-renderer";
+    renderer: {
+        /**
+         * Name of the renderer to match the one from `createField()` method in `CmsEditorFieldTypePlugin`.
+         *
+         * ```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.multipleValues
+         *     );
+         * }
+         * ```
+         */
+        canUse(props: {
+            field: CmsModelField;
+            fieldPlugin: CmsEditorFieldTypePlugin;
+        }): 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: CmsEditorFieldRendererProps): React.ReactNode;
+    };
+}
+export interface CmsEditorFieldPredefinedValuesEntry {
+    label: string;
+    value: string;
+    selected?: boolean;
+}
+export interface CmsEditorFieldPredefinedValues {
+    enabled: boolean;
+    values: CmsEditorFieldPredefinedValuesEntry[];
+}
+export interface CmsDynamicZoneTemplate {
+    id: string;
+    name: string;
+    gqlTypeName: string;
+    description: string;
+    icon: string;
+    fields: CmsModelField[];
+    layout: string[][];
+    validation: CmsModelFieldValidator[];
+}
+export declare type CmsContentEntryStatusType = "draft" | "published" | "unpublished";
+export interface CmsEditorContentEntry {
+    id: string;
+    savedOn: string;
+    modelId: string;
+    createdBy: CmsCreatedBy;
+    meta: {
+        title: string;
+        publishedOn: string;
+        locked: boolean;
+        status: CmsContentEntryStatusType;
+        version: number;
+    };
+    [key: string]: any;
+}
+export interface CmsContentEntryRevision {
+    id: string;
+    savedOn: string;
+    modelId: string;
+    createdBy: CmsCreatedBy;
+    meta: {
+        title: string;
+        publishedOn: string;
+        locked: boolean;
+        status: CmsContentEntryStatusType;
+        version: number;
+    };
+}
+export declare type CmsEditorContentTab = React.FC<{
+    activeTab: boolean;
+}>;
+export interface CmsEditorFieldOptionPlugin extends Plugin {
+    type: "cms-editor-field-option";
+    render(): ReactElement;
+}
+export interface CmsContentDetailsPlugin extends Plugin {
+    render: (params: any) => ReactNode;
+}
+export interface FieldLayoutPosition {
+    row: number;
+    index: number | null;
+}
+export interface CmsEditorFormSettingsPlugin extends Plugin {
+    type: "cms-editor-form-settings";
+    title: string;
+    description: string;
+    icon: React.ReactElement;
+    render(props: {
+        Bind: BaseBindComponent;
+        form: FormAPI;
+        formData: any;
+    }): React.ReactNode;
+    renderHeaderActions?(props: {
+        Bind: BaseBindComponent;
+        form: FormAPI;
+        formData: any;
+    }): React.ReactNode;
+}
+export interface CmsIcon {
+    /**
+     * [ pack, icon ], ex: ["fab", "cog"]
+     */
+    id: [IconPrefix, IconName];
+    /**
+     * Icon name
+     */
+    name: string;
+    /**
+     * SVG element
+     */
+    svg: ReactElement;
+}
+export interface CmsIconsPlugin extends Plugin {
+    type: "cms-icons";
+    getIcons(): CmsIcon[];
+}
+/**
+ * Transform field value when sending data to the API.
+ */
+export interface CmsFieldValueTransformer<TField extends CmsModelField = CmsModelField> extends Plugin {
+    /**
+     * A plugin type.
+     */
+    type: "cms-field-value-transformer";
+    /**
+     * A field type for the value transformer. Or a list of field types.
+     */
+    fieldType: string | string[];
+    /**
+     * A transformer function that takes a value and returns a new one.
+     */
+    transform: (value: any, field: TField) => any;
+}
+/**
+ * Define a custom form layout renderer for a specific content model.
+ */
+export interface CmsContentFormRendererPlugin extends Plugin {
+    /**
+     * A plugin type.
+     */
+    type: "cms-content-form-renderer";
+    /**
+     * Content model ID that will use this renderer.
+     */
+    modelId: string;
+    /**
+     * A function that will render a custom form layout.
+     */
+    render(props: {
+        /**
+         * Content model that is being rendered.
+         */
+        contentModel: CmsModel;
+        /**
+         * Content entry data handled by the Form element.
+         */
+        data: Record<string, any>;
+        /**
+         * A component to bind data to the Form.
+         */
+        Bind: BindComponent;
+        /**
+         * Content model fields to render.
+         */
+        fields: Record<string, React.ReactElement>;
+    }): React.ReactNode;
+}
+/**
+ * #########################
+ * Data types
+ * #########################
+ */
+export interface CmsSecurityPermission extends SecurityPermission {
+    accessLevel?: "full" | "no" | "custom";
+    models?: Record<string, string>;
+    groups?: Record<string, string>;
+    endpoints?: string[];
+    locales?: string[];
+    rwd?: string;
+    own?: boolean;
+    pw?: string;
+}
+/**
+ * @category GraphQL
+ * @category Error
+ */
+export interface CmsErrorResponse {
+    message: string;
+    code: string;
+    data: Record<string, any> | Record<string, any>[];
+}
+/**
+ * @category GraphQL
+ * @category Meta
+ */
+export interface CmsMetaResponse {
+    totalCount: number;
+    cursor: string | null;
+    hasMoreItems: boolean;
+}
+/***
+ * ###### FORM ########
+ */
+export interface BindComponentRenderProp extends BaseBindComponentRenderProp {
+    parentName: string;
+    appendValue: (value: any, index?: number) => void;
+    prependValue: (value: any) => void;
+    appendValues: (values: any[]) => void;
+    removeValue: (index: number) => void;
+    moveValueUp: (index: number) => void;
+    moveValueDown: (index: number) => void;
+}
+interface BindComponentProps extends Omit<BaseBindComponentProps, "children" | "name"> {
+    name?: string;
+    children?: ((props: BindComponentRenderProp) => React.ReactElement) | React.ReactElement;
+}
+export declare type BindComponent = React.FC<BindComponentProps> & {
+    parentName?: string;
+};
+/**
+ * After RequestReview and RequestChanges was removed, we need an option to add new status filters
+ */
+export interface CmsEntryFilterStatusPlugin extends Plugin {
+    type: "cms.entry.filter.status";
+    label: string;
+    value: string;
+}

package/types/index.js

@@ -0,0 +1,44 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+
+var _validation = require("./validation");
+
+Object.keys(_validation).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _validation[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _validation[key];
+    }
+  });
+});
+
+var _model = require("./model");
+
+Object.keys(_model).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _model[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _model[key];
+    }
+  });
+});
+
+var _shared = require("./shared");
+
+Object.keys(_shared).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _shared[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _shared[key];
+    }
+  });
+});

package/types/index.js.map

@@ -0,0 +1 @@
+{"version":3,"names":[],"sources":["index.ts"],"sourcesContent":["import * as React from \"react\";\nimport { Plugin } from \"@webiny/plugins/types\";\nimport { ReactElement, ReactNode } from \"react\";\nimport {\n    FormAPI,\n    BindComponent as BaseBindComponent,\n    BindComponentRenderProp as BaseBindComponentRenderProp,\n    BindComponentProps as BaseBindComponentProps\n} from \"@webiny/form\";\nimport { IconPrefix, IconName } from \"@fortawesome/fontawesome-svg-core\";\nimport Label from \"~/admin/components/ContentEntryForm/Label\";\nimport { SecurityPermission } from \"@webiny/app-security/types\";\nimport { DragSource } from \"~/admin/components/FieldEditor/FieldEditorContext\";\nimport {\n    CmsModelFieldValidator,\n    CmsModelFieldValidatorsGroup,\n    CmsModelFieldValidatorsFactory\n} from \"./validation\";\n\nimport { CmsModelField, CmsModel } from \"./model\";\nimport { CmsCreatedBy } from \"~/types/shared\";\n\nexport * from \"./validation\";\nexport * from \"./model\";\nexport * from \"./shared\";\n\ninterface QueryFieldParams {\n    model: CmsModel;\n    field: CmsModelField;\n}\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         * allowMultipleValues: true\n         * ```\n         */\n        allowMultipleValues: 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        multipleValuesLabel: React.ReactNode;\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);\n        };\n        render?(params: any): React.ReactElement;\n        tags?: string[];\n    };\n}\n\nexport interface CmsEditorFieldRendererProps {\n    field: CmsModelField;\n    Label: typeof Label;\n    getBind: (index?: number, key?: string) => BindComponent;\n    contentModel: CmsModel;\n}\n\nexport interface CmsEditorFieldRendererPlugin 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 `CmsEditorFieldTypePlugin`.\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.multipleValues\n         *     );\n         * }\n         * ```\n         */\n        canUse(props: { field: CmsModelField; fieldPlugin: CmsEditorFieldTypePlugin }): 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: CmsEditorFieldRendererProps): 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}\n\nexport type CmsContentEntryStatusType = \"draft\" | \"published\" | \"unpublished\";\n\nexport interface CmsEditorContentEntry {\n    id: string;\n    savedOn: string;\n    modelId: string;\n    createdBy: CmsCreatedBy;\n    meta: {\n        title: string;\n        publishedOn: string;\n        locked: boolean;\n        status: CmsContentEntryStatusType;\n        version: number;\n    };\n    [key: string]: any;\n}\n\nexport interface CmsContentEntryRevision {\n    id: string;\n    savedOn: string;\n    modelId: string;\n    createdBy: CmsCreatedBy;\n    meta: {\n        title: string;\n        publishedOn: string;\n        locked: boolean;\n        status: CmsContentEntryStatusType;\n        version: number;\n    };\n}\n\nexport type CmsEditorContentTab = React.FC<{ 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 extends Plugin {\n    type: \"cms-editor-form-settings\";\n    title: string;\n    description: string;\n    icon: React.ReactElement;\n    render(props: { Bind: BaseBindComponent; form: FormAPI; formData: any }): React.ReactNode;\n    renderHeaderActions?(props: {\n        Bind: BaseBindComponent;\n        form: FormAPI;\n        formData: any;\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(): CmsIcon[];\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 SecurityPermission {\n    accessLevel?: \"full\" | \"no\" | \"custom\";\n    models?: Record<string, string>;\n    groups?: Record<string, string>;\n    endpoints?: string[];\n    locales?: 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> | Record<string, any>[];\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 extends BaseBindComponentRenderProp {\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 extends Omit<BaseBindComponentProps, \"children\" | \"name\"> {\n    name?: string;\n    children?: ((props: BindComponentRenderProp) => React.ReactElement) | React.ReactElement;\n}\n\nexport type BindComponent = React.FC<BindComponentProps> & {\n    parentName?: string;\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":";;;;;;AAsBA;;AAAA;EAAA;EAAA;EAAA;IAAA;IAAA;MAAA;IAAA;EAAA;AAAA;;AACA;;AAAA;EAAA;EAAA;EAAA;IAAA;IAAA;MAAA;IAAA;EAAA;AAAA;;AACA;;AAAA;EAAA;EAAA;EAAA;IAAA;IAAA;MAAA;IAAA;EAAA;AAAA"}

package/types/model.d.ts

@@ -0,0 +1,83 @@
+import { CmsModelFieldValidator } from "./validation";
+import { CmsDynamicZoneTemplate, CmsEditorFieldPredefinedValues } from "./index";
+import { CmsCreatedBy } from "./shared";
+/**
+ * @deprecated Use `CmsModelField` instead.
+ */
+export declare type CmsEditorField<T = unknown> = CmsModelField<T>;
+export declare type CmsModelField<T = unknown> = T & {
+    id: string;
+    type: string;
+    fieldId: CmsEditorFieldId;
+    storageId?: string;
+    label?: string;
+    helpText?: string;
+    placeholderText?: string;
+    validation?: CmsModelFieldValidator[];
+    listValidation?: CmsModelFieldValidator[];
+    multipleValues?: boolean;
+    predefinedValues?: CmsEditorFieldPredefinedValues;
+    settings?: {
+        defaultValue?: string | null | undefined;
+        defaultSetValue?: string;
+        type?: string;
+        fields?: CmsModelField<any>[];
+        layout?: string[][];
+        models?: Pick<CmsModel, "modelId" | "name">[];
+        templates?: CmsDynamicZoneTemplate[];
+        imagesOnly?: boolean;
+        [key: string]: any;
+    };
+    renderer: {
+        name: string;
+    };
+    tags?: string[];
+};
+export declare type CmsEditorFieldId = string;
+export declare type CmsEditorFieldsLayout = CmsEditorFieldId[][];
+/**
+ * @category GraphQL
+ * @category Model
+ */
+export declare type CmsEditorContentModel = CmsModel;
+/**
+ * @category GraphQL
+ * @category Group
+ */
+export interface CmsGroup {
+    id: string;
+    name: string;
+    slug: string;
+    icon?: string;
+    description?: string;
+    contentModels: CmsModel[];
+    createdBy: CmsCreatedBy;
+    /**
+     * Tells if this group is a plugin one (cannot be changed/deleted)
+     */
+    plugin?: boolean;
+}
+export interface CmsModel {
+    id: string;
+    group: Pick<CmsGroup, "id" | "name">;
+    description?: string;
+    version: number;
+    layout?: CmsEditorFieldsLayout;
+    fields: CmsModelField[];
+    lockedFields: CmsModelField[];
+    name: string;
+    modelId: string;
+    titleFieldId: string;
+    settings: {
+        [key: string]: any;
+    };
+    status: string;
+    savedOn: string;
+    meta: any;
+    createdBy: CmsCreatedBy;
+    tags: string[];
+    /**
+     * If model is a plugin one (it cannot be changed/deleted)
+     */
+    plugin?: boolean;
+}

package/types/model.js

@@ -0,0 +1,5 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});

package/types/model.js.map

@@ -0,0 +1 @@
+{"version":3,"names":[],"sources":["model.ts"],"sourcesContent":["import { CmsModelFieldValidator } from \"~/types/validation\";\nimport { CmsDynamicZoneTemplate, CmsEditorFieldPredefinedValues } from \"~/types/index\";\nimport { CmsCreatedBy } from \"~/types/shared\";\n\n/**\n * @deprecated Use `CmsModelField` instead.\n */\nexport type CmsEditorField<T = unknown> = CmsModelField<T>;\n\nexport type CmsModelField<T = unknown> = T & {\n    id: string;\n    type: string;\n    fieldId: CmsEditorFieldId;\n    storageId?: string;\n    label?: string;\n    helpText?: string;\n    placeholderText?: string;\n    validation?: CmsModelFieldValidator[];\n    listValidation?: CmsModelFieldValidator[];\n    multipleValues?: boolean;\n    predefinedValues?: CmsEditorFieldPredefinedValues;\n    settings?: {\n        defaultValue?: string | null | undefined;\n        defaultSetValue?: string;\n        type?: string;\n        fields?: CmsModelField<any>[];\n        layout?: string[][];\n        models?: Pick<CmsModel, \"modelId\" | \"name\">[];\n        templates?: CmsDynamicZoneTemplate[];\n        imagesOnly?: boolean;\n        [key: string]: any;\n    };\n    renderer: {\n        name: string;\n    };\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: CmsCreatedBy;\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: Pick<CmsGroup, \"id\" | \"name\">;\n    description?: string;\n    version: number;\n    layout?: CmsEditorFieldsLayout;\n    fields: CmsModelField[];\n    lockedFields: CmsModelField[];\n    name: string;\n    modelId: string;\n    titleFieldId: string;\n    settings: {\n        [key: string]: any;\n    };\n    status: string;\n    savedOn: string;\n    meta: any;\n    createdBy: CmsCreatedBy;\n    tags: string[];\n    /**\n     * If model is a plugin one (it cannot be changed/deleted)\n     */\n    plugin?: boolean;\n}\n"],"mappings":""}

package/types/shared.d.ts

@@ -0,0 +1,5 @@
+export interface CmsCreatedBy {
+    id: string;
+    displayName: string;
+    type: string;
+}

package/types/shared.js

@@ -0,0 +1,5 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});

package/types/shared.js.map

@@ -0,0 +1 @@
+{"version":3,"names":[],"sources":["shared.ts"],"sourcesContent":["export interface CmsCreatedBy {\n    id: string;\n    displayName: string;\n    type: string;\n}\n"],"mappings":""}