@webiny/app-headless-cms-common 6.0.0-beta.0 → 6.0.0-rc.0

package/types/model.d.ts

@@ -1,11 +1,12 @@
-import { Validator } from "@webiny/validation/types";
-import { CmsModelFieldValidator } from "./validation";
-import { CmsDynamicZoneTemplate, CmsEditorFieldPredefinedValues, CmsModelFieldRendererPlugin } from "./index";
-import { CmsIdentity } from "./shared";
+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 { CmsIdentity } from "../types/shared.js";
+import type React from "react";
 /**
  * @deprecated Use `CmsModelField` instead.
  */
-export declare type CmsEditorField<T = unknown> = CmsModelField<T>;
+export type CmsEditorField<T = unknown> = CmsModelField<T>;
 export interface CmsModelFieldSettings<T = unknown> {
     defaultValue?: string | boolean | number | null | undefined;
     defaultSetValue?: string;
@@ -17,17 +18,19 @@ export interface CmsModelFieldSettings<T = unknown> {
     imagesOnly?: boolean;
     [key: string]: any;
 }
-export declare type CmsModelField<T = unknown> = T & {
+export type CmsModelField<T = unknown> = T & {
     id: string;
     type: string;
     fieldId: CmsEditorFieldId;
     storageId?: string;
     label: string;
-    helpText?: string;
-    placeholderText?: string;
+    help?: string | React.ReactNode;
+    description?: string | React.ReactNode;
+    note?: string | React.ReactNode;
+    placeholder?: string;
     validation?: (CmsModelFieldValidator | Validator)[];
     listValidation?: CmsModelFieldValidator[];
-    multipleValues?: boolean;
+    list?: boolean;
     predefinedValues?: CmsEditorFieldPredefinedValues;
     settings?: CmsModelFieldSettings<T>;
     renderer: {
@@ -41,13 +44,13 @@ export declare type CmsModelField<T = unknown> = T & {
      | CmsModelFieldRendererPlugin["renderer"]["render"];
     tags?: string[];
 };
-export declare type CmsEditorFieldId = string;
-export declare type CmsEditorFieldsLayout = CmsEditorFieldId[][];
+export type CmsEditorFieldId = string;
+export type CmsEditorFieldsLayout = CmsEditorFieldId[][];
 /**
  * @category GraphQL
  * @category Model
  */
-export declare type CmsEditorContentModel = CmsModel;
+export type CmsEditorContentModel = CmsModel;
 /**
  * @category GraphQL
  * @category Group
@@ -67,12 +70,11 @@ export interface CmsGroup {
 }
 export interface CmsModel {
     id: string;
-    group: Pick<CmsGroup, "id" | "name">;
+    group: string;
     description?: string;
     version: number;
     layout?: CmsEditorFieldsLayout;
     fields: CmsModelField[];
-    lockedFields: CmsModelField[];
     icon: string;
     name: string;
     modelId: string;
@@ -81,9 +83,6 @@ export interface CmsModel {
     titleFieldId: string | null;
     descriptionFieldId: string | null;
     imageFieldId: string | null;
-    settings: {
-        [key: string]: any;
-    };
     status: string;
     savedOn: string;
     meta: any;
@@ -93,4 +92,11 @@ export interface CmsModel {
      * If model is a plugin one (it cannot be changed/deleted)
      */
     plugin?: boolean;
+    /**
+     * Is model currently being deleted?
+     */
+    isBeingDeleted?: boolean;
+    settings: {
+        [key: string]: any;
+    };
 }

package/types/model.js

@@ -1,7 +1,3 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
+export {};
 
 //# sourceMappingURL=model.js.map

package/types/model.js.map

@@ -1 +1 @@
-{"version":3,"names":[],"sources":["model.ts"],"sourcesContent":["import { Validator } from \"@webiny/validation/types\";\nimport { CmsModelFieldValidator } from \"~/types/validation\";\nimport {\n    CmsDynamicZoneTemplate,\n    CmsEditorFieldPredefinedValues,\n    CmsModelFieldRendererPlugin\n} from \"~/types/index\";\nimport { CmsIdentity } from \"~/types/shared\";\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    helpText?: string;\n    placeholderText?: string;\n    validation?: (CmsModelFieldValidator | Validator)[];\n    listValidation?: CmsModelFieldValidator[];\n    multipleValues?: 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: Pick<CmsGroup, \"id\" | \"name\">;\n    description?: string;\n    version: number;\n    layout?: CmsEditorFieldsLayout;\n    fields: CmsModelField[];\n    lockedFields: 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    settings: {\n        [key: string]: any;\n    };\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"],"mappings":"","ignoreList":[]}
+{"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":[]}

package/types/shared.js

@@ -1,7 +1,3 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
+export {};
 
 //# sourceMappingURL=shared.js.map

package/types/validation.d.ts

@@ -1,6 +1,6 @@
-import * as React from "react";
-import { Plugin } from "@webiny/plugins/types";
-import { CmsModelField } from "./";
+import type * as React from "react";
+import type { Plugin } from "@webiny/plugins/types.js";
+import type { CmsModelField } from "../types/index.js";
 export interface CmsModelFieldValidatorConfigAdapter {
     isRequired(): boolean;
     getName(): string;

package/types/validation.js

@@ -1,7 +1,3 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
+export {};
 
 //# sourceMappingURL=validation.js.map

package/types/validation.js.map

@@ -1 +1 @@
-{"version":3,"names":[],"sources":["validation.ts"],"sourcesContent":["import * as React from \"react\";\nimport { Plugin } from \"@webiny/plugins/types\";\nimport { CmsModelField } from \"~/types\";\n\nexport interface CmsModelFieldValidatorConfigAdapter {\n    isRequired(): boolean;\n    getName(): string;\n    getLabel(): string;\n    getDescription(): string;\n    getDefaultMessage(): string;\n    getDefaultSettings(): Record<string, any> | undefined;\n    getVariables(): CmsModelFieldValidatorVariable[];\n    getVariableDescription(variableName: string): string | undefined;\n}\n\nexport interface CmsModelFieldValidatorVariable {\n    name: string;\n    description: string;\n}\n\n/**\n * This interface is used in the validator configuration UI (Field dialog).\n */\nexport interface CmsModelFieldValidatorConfig {\n    name: string;\n    required?: boolean;\n    label?: string;\n    description?: string;\n    defaultMessage?: string;\n    defaultSettings?: Record<string, any>;\n    variables?: CmsModelFieldValidatorVariable[];\n}\n\n/**\n * This interface allows you to control the title, description, and validators located in the specific\n * validators group, like `validators` or `listValidators` within the Field dialog.\n */\nexport interface CmsModelFieldValidatorsGroup {\n    validators: (string | CmsModelFieldValidatorConfig)[];\n    title?: string;\n    description?: string;\n}\n\n/**\n * This interface allows you to generate validators based on the field configuration.\n */\nexport interface CmsModelFieldValidatorsFactory {\n    (field: CmsModelField): string[] | CmsModelFieldValidatorsGroup;\n}\n\nexport interface CmsModelFieldValidator {\n    name: string;\n    message?: string;\n    settings?: any;\n}\n\nexport interface CmsModelFieldValidatorPlugin<T = any> extends Plugin {\n    type: \"cms-model-field-validator\";\n    validator: {\n        name: string;\n        label: string;\n        description: string;\n        defaultMessage: string;\n        variables?: CmsModelFieldValidatorVariable[];\n        defaultSettings?: Record<string, any>;\n        getVariableValues?: (context: {\n            validator: CmsModelFieldValidator;\n        }) => Record<string, string>;\n        renderSettings?: (config: CmsModelFieldValidatorConfigAdapter) => React.ReactElement;\n        renderCustomUi?: () => React.ReactElement;\n        validate: (\n            value: T,\n            context: {\n                validator: CmsModelFieldValidator;\n                field: CmsModelField;\n            }\n        ) => Promise<any>;\n    };\n}\n\nexport interface CmsModelFieldRegexValidatorExpressionPlugin extends Plugin {\n    type: \"cms-model-field-regex-validator-expression\";\n    pattern: {\n        name: string;\n        message: string;\n        label: string;\n        regex: string;\n        flags: string;\n    };\n}\n"],"mappings":"","ignoreList":[]}
+{"version":3,"names":[],"sources":["validation.ts"],"sourcesContent":["import type * as React from \"react\";\nimport type { Plugin } from \"@webiny/plugins/types.js\";\nimport type { CmsModelField } from \"~/types/index.js\";\n\nexport interface CmsModelFieldValidatorConfigAdapter {\n    isRequired(): boolean;\n    getName(): string;\n    getLabel(): string;\n    getDescription(): string;\n    getDefaultMessage(): string;\n    getDefaultSettings(): Record<string, any> | undefined;\n    getVariables(): CmsModelFieldValidatorVariable[];\n    getVariableDescription(variableName: string): string | undefined;\n}\n\nexport interface CmsModelFieldValidatorVariable {\n    name: string;\n    description: string;\n}\n\n/**\n * This interface is used in the validator configuration UI (Field dialog).\n */\nexport interface CmsModelFieldValidatorConfig {\n    name: string;\n    required?: boolean;\n    label?: string;\n    description?: string;\n    defaultMessage?: string;\n    defaultSettings?: Record<string, any>;\n    variables?: CmsModelFieldValidatorVariable[];\n}\n\n/**\n * This interface allows you to control the title, description, and validators located in the specific\n * validators group, like `validators` or `listValidators` within the Field dialog.\n */\nexport interface CmsModelFieldValidatorsGroup {\n    validators: (string | CmsModelFieldValidatorConfig)[];\n    title?: string;\n    description?: string;\n}\n\n/**\n * This interface allows you to generate validators based on the field configuration.\n */\nexport interface CmsModelFieldValidatorsFactory {\n    (field: CmsModelField): string[] | CmsModelFieldValidatorsGroup;\n}\n\nexport interface CmsModelFieldValidator {\n    name: string;\n    message?: string;\n    settings?: any;\n}\n\nexport interface CmsModelFieldValidatorPlugin<T = any> extends Plugin {\n    type: \"cms-model-field-validator\";\n    validator: {\n        name: string;\n        label: string;\n        description: string;\n        defaultMessage: string;\n        variables?: CmsModelFieldValidatorVariable[];\n        defaultSettings?: Record<string, any>;\n        getVariableValues?: (context: {\n            validator: CmsModelFieldValidator;\n        }) => Record<string, string>;\n        renderSettings?: (config: CmsModelFieldValidatorConfigAdapter) => React.ReactElement;\n        renderCustomUi?: () => React.ReactElement;\n        validate: (\n            value: T,\n            context: {\n                validator: CmsModelFieldValidator;\n                field: CmsModelField;\n            }\n        ) => Promise<any>;\n    };\n}\n\nexport interface CmsModelFieldRegexValidatorExpressionPlugin extends Plugin {\n    type: \"cms-model-field-regex-validator-expression\";\n    pattern: {\n        name: string;\n        message: string;\n        label: string;\n        regex: string;\n        flags: string;\n    };\n}\n"],"mappings":"","ignoreList":[]}