@webiny/app-headless-cms 5.23.1-beta.0 → 5.24.0

package/types.d.ts

@@ -5,6 +5,7 @@ import { BindComponent, FormRenderPropParams, FormAPI } from "@webiny/form/types
 import { ApolloClient } from "apollo-client";
 import { IconPrefix, IconName } from "@fortawesome/fontawesome-svg-core";
 import Label from "./admin/components/ContentEntryForm/Label";
+import { SecurityPermission } from "@webiny/app-security/types";
 interface QueryFieldParams {
     field: CmsEditorField;
 }
@@ -230,7 +231,7 @@ export interface CmsEditorFieldRendererPlugin extends Plugin {
         render(props: {
             field: CmsEditorField;
             Label: typeof Label;
-            getBind: (index?: number, key?: string) => any;
+            getBind: (index?: number, key?: string) => BindComponent;
             contentModel: CmsEditorContentModel;
         }): React.ReactNode;
     };
@@ -266,11 +267,8 @@ export declare type CmsEditorField<T = unknown> = T & {
 export declare type CmsEditorFieldId = string;
 export declare type CmsEditorFieldsLayout = CmsEditorFieldId[][];
 export interface CmsEditorContentModel {
-    id: CmsEditorFieldId;
-    group: {
-        id: string;
-        name: string;
-    };
+    id: string;
+    group: Pick<CmsGroup, "id" | "name">;
     description?: string;
     version: number;
     layout?: CmsEditorFieldsLayout;
@@ -279,14 +277,23 @@ export interface CmsEditorContentModel {
     name: string;
     modelId: string;
     titleFieldId: string;
-    settings: any;
+    settings: {
+        [key: string]: any;
+    };
     status: string;
     savedOn: string;
     meta: any;
+    createdBy: CmsCreatedBy;
+    /**
+     * If model is a plugin one (it cannot be changed/deleted)
+     */
+    plugin?: boolean;
 }
 export interface CmsEditorContentEntry {
     id: string;
     savedOn: string;
+    modelId: string;
+    createdBy: CmsCreatedBy;
     [key: string]: any;
     meta: {
         title: string;
@@ -299,6 +306,8 @@ export interface CmsEditorContentEntry {
 export interface CmsContentEntryRevision {
     id: string;
     savedOn: string;
+    modelId: string;
+    createdBy: CmsCreatedBy;
     meta: {
         title: string;
         publishedOn: string;
@@ -312,22 +321,23 @@ export interface CmsEditorFieldValidator {
     message: string;
     settings: any;
 }
+export interface CmsEditorFieldValidatorPluginValidator {
+    name: string;
+    label: string;
+    description: string;
+    defaultMessage: string;
+    defaultSettings?: Record<string, any>;
+    renderSettings?: (props: {
+        field: CmsEditorField;
+        Bind: BindComponent;
+        setValue: (name: string, value: any) => void;
+        setMessage: (message: string) => void;
+        data: CmsEditorFieldValidator;
+    }) => React.ReactElement;
+}
 export interface CmsEditorFieldValidatorPlugin extends Plugin {
     type: "cms-editor-field-validator";
-    validator: {
-        name: string;
-        label: string;
-        description: string;
-        defaultMessage: string;
-        defaultSettings?: Record<string, any>;
-        renderSettings?: (props: {
-            field: CmsEditorField;
-            Bind: BindComponent;
-            setValue: (name: string, value: any) => void;
-            setMessage: (message: string) => void;
-            data: CmsEditorFieldValidator;
-        }) => React.ReactElement;
-    };
+    validator: CmsEditorFieldValidatorPluginValidator;
 }
 export declare type CmsEditorContentTab = React.FunctionComponent<{
     activeTab: boolean;
@@ -356,11 +366,11 @@ export interface CmsFieldValidator {
     message: any;
     settings: any;
 }
-export interface CmsModelFieldValidatorPlugin extends Plugin {
+export interface CmsModelFieldValidatorPlugin<T = any> extends Plugin {
     type: "cms-model-field-validator";
     validator: {
         name: string;
-        validate: (value: any, validator: CmsFieldValidator | any) => Promise<any>;
+        validate: (value: T, validator: CmsFieldValidator) => Promise<any>;
     };
 }
 /**
@@ -484,4 +494,59 @@ export interface CmsContentFormRendererPlugin extends Plugin {
         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>;
+}
+export interface CmsCreatedBy {
+    id: string;
+    displayName: string;
+    type: string;
+}
+/**
+ * @category GraphQL
+ * @category Model
+ */
+export declare type CmsModel = CmsEditorContentModel;
+/**
+ * @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;
+}
+/**
+ * @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;
+}
 export {};