@webiny/app-headless-cms-common 0.0.0-unstable.06b2ede40f

package/types/model.d.ts

@@ -0,0 +1,100 @@
+import type { Validator } from "@webiny/validation/types";
+import type { CmsModelFieldValidator } from "./validation";
+import type { CmsDynamicZoneTemplate, CmsEditorFieldPredefinedValues, CmsModelFieldRendererPlugin } from "./index";
+import type { CmsIdentity } from "./shared";
+/**
+ * @deprecated Use `CmsModelField` instead.
+ */
+export type CmsEditorField<T = unknown> = CmsModelField<T>;
+export interface CmsModelFieldSettings<T = unknown> {
+    defaultValue?: string | boolean | number | null | undefined;
+    defaultSetValue?: string;
+    type?: string;
+    fields?: CmsModelField<T>[];
+    layout?: string[][];
+    models?: Pick<CmsModel, "modelId">[];
+    templates?: CmsDynamicZoneTemplate[];
+    imagesOnly?: boolean;
+    [key: string]: any;
+}
+export type CmsModelField<T = unknown> = T & {
+    id: string;
+    type: string;
+    fieldId: CmsEditorFieldId;
+    storageId?: string;
+    label: string;
+    helpText?: string;
+    placeholderText?: string;
+    validation?: (CmsModelFieldValidator | Validator)[];
+    listValidation?: CmsModelFieldValidator[];
+    multipleValues?: boolean;
+    predefinedValues?: CmsEditorFieldPredefinedValues;
+    settings?: CmsModelFieldSettings<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[];
+};
+export type CmsEditorFieldId = string;
+export type CmsEditorFieldsLayout = CmsEditorFieldId[][];
+/**
+ * @category GraphQL
+ * @category Model
+ */
+export type CmsEditorContentModel = CmsModel;
+/**
+ * @category GraphQL
+ * @category Group
+ */
+export interface CmsGroup {
+    id: string;
+    name: string;
+    slug: string;
+    icon: string;
+    description?: string;
+    contentModels: CmsModel[];
+    createdBy: CmsIdentity;
+    /**
+     * 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[];
+    icon: string;
+    name: string;
+    modelId: string;
+    singularApiName: string;
+    pluralApiName: string;
+    titleFieldId: string | null;
+    descriptionFieldId: string | null;
+    imageFieldId: string | null;
+    settings: {
+        [key: string]: any;
+    };
+    status: string;
+    savedOn: string;
+    meta: any;
+    createdBy: CmsIdentity;
+    tags: string[];
+    /**
+     * If model is a plugin one (it cannot be changed/deleted)
+     */
+    plugin?: boolean;
+    /**
+     * Is model currently being deleted?
+     */
+    isBeingDeleted?: boolean;
+}

package/types/model.js

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

package/types/model.js.map

@@ -0,0 +1 @@
+{"version":3,"names":[],"sources":["model.ts"],"sourcesContent":["import type { Validator } from \"@webiny/validation/types\";\nimport type { CmsModelFieldValidator } from \"~/types/validation\";\nimport type {\n    CmsDynamicZoneTemplate,\n    CmsEditorFieldPredefinedValues,\n    CmsModelFieldRendererPlugin\n} from \"~/types/index\";\nimport type { 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     * Is model currently being deleted?\n     */\n    isBeingDeleted?: boolean;\n}\n"],"mappings":"","ignoreList":[]}

package/types/shared.d.ts

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

package/types/shared.js

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

package/types/shared.js.map

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

package/types/validation.d.ts

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

package/types/validation.js

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

package/types/validation.js.map

@@ -0,0 +1 @@
+{"version":3,"names":[],"sources":["validation.ts"],"sourcesContent":["import type * as React from \"react\";\nimport type { Plugin } from \"@webiny/plugins/types\";\nimport type { 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":[]}