@webiny/api-headless-cms 5.20.0 → 5.22.0-beta.1

package/types.d.ts

@@ -1,9 +1,9 @@
 import { Plugin } from "@webiny/plugins/types";
 import { I18NContext, I18NLocale } from "@webiny/api-i18n/types";
-import { ContextInterface } from "@webiny/handler/types";
+import { Context } from "@webiny/handler/types";
 import { TenancyContext } from "@webiny/api-tenancy/types";
 import { GraphQLFieldResolver, GraphQLSchemaDefinition, Resolvers } from "@webiny/handler-graphql/types";
-import { BaseI18NContentContext } from "@webiny/api-i18n-content/types";
+import { I18NContentContext } from "@webiny/api-i18n-content/types";
 import { SecurityPermission } from "@webiny/api-security/types";
 import { HttpContext } from "@webiny/handler-http/types";
 import { DbContext } from "@webiny/handler-db/types";
@@ -45,12 +45,16 @@ export interface HeadlessCms extends CmsSettingsContext, CmsSystemContext, CmsGr
  *
  * @category Context
  */
-export interface CmsContext extends ContextInterface, DbContext, HttpContext, I18NContext, FileManagerContext, BaseI18NContentContext, TenancyContext {
+export interface CmsContext extends Context, DbContext, HttpContext, I18NContext, FileManagerContext, I18NContentContext, TenancyContext {
     cms: HeadlessCms;
 }
 interface CmsModelFieldPredefinedValuesValue {
     value: string;
     label: string;
+    /**
+     * Default selected predefined value.
+     */
+    selected?: boolean;
 }
 /**
  * Object containing content model field predefined options and values.
@@ -143,6 +147,13 @@ export interface CmsModelField {
      * @default {}
      */
     settings?: {
+        /**
+         * The default value for the field in case it is not predefined values field.
+         */
+        defaultValue?: string | number | null | undefined;
+        /**
+         * There are a lot of other settings that are possible to add so we keep the type opened.
+         */
         [key: string]: any;
     };
 }
@@ -186,7 +197,12 @@ export interface CmsModelFieldValidatorValidateParams<T = any> {
     /**
      * An instance of the content model being validated.
      */
-    contentModel: CmsModel;
+    model: CmsModel;
+    /**
+     * If entry is sent it means it is an update operation.
+     * First usage is for the unique field value.
+     */
+    entry?: CmsEntry;
 }
 /**
  * Definition for the field validator.
@@ -400,6 +416,9 @@ export interface CmsModelFieldToGraphQLPlugin extends Plugin {
      * ```
      */
     isSortable: boolean;
+    /**
+     * Read API methods.
+     */
     read: {
         /**
          * Definition for get filtering for GraphQL.
@@ -1180,12 +1199,12 @@ export interface AfterModelCreateTopicParams {
     model: CmsModel;
 }
 export interface BeforeModelCreateFromTopicParams {
-    input: CmsModelCreateFromInput;
+    input: CmsModelCreateInput;
     original: CmsModel;
     model: CmsModel;
 }
 export interface AfterModelCreateFromTopicParams {
-    input: CmsModelCreateFromInput;
+    input: CmsModelCreateInput;
     original: CmsModel;
     model: CmsModel;
 }
@@ -1216,15 +1235,6 @@ export interface CmsModelUpdateDirectParams {
  * @category CmsModel
  */
 export interface CmsModelContext {
-    /**
-     * A function defining usage of a method with authenticating the user but not throwing an error.
-     */
-    silentAuthModel: () => {
-        /**
-         * Get all content models.
-         */
-        list: () => Promise<CmsModel[]>;
-    };
     /**
      * Get a single content model.
      */
@@ -1259,7 +1269,7 @@ export interface CmsModelContext {
      *
      * @see CmsModelManager
      */
-    getModelManager: (modelId: string) => Promise<CmsModelManager>;
+    getModelManager: (model: CmsModel | string) => Promise<CmsModelManager>;
     /**
      * Get all content model managers mapped by modelId.
      * @see CmsModelManager
@@ -1410,33 +1420,37 @@ export interface CmsEntryMeta {
     totalCount: number;
 }
 export interface BeforeEntryCreateTopicParams {
-    input: Partial<CmsEntry>;
+    input: CreateCmsEntryInput;
     entry: CmsEntry;
     model: CmsModel;
 }
 export interface AfterEntryCreateTopicParams {
-    input: Partial<CmsEntry>;
+    input: CreateCmsEntryInput;
     entry: CmsEntry;
     model: CmsModel;
     storageEntry: CmsEntry;
 }
-export interface BeforeEntryRevisionCreateTopicParams {
+export interface BeforeEntryCreateRevisionTopicParams {
+    input: CreateFromCmsEntryInput;
     entry: CmsEntry;
+    original: CmsEntry;
     model: CmsModel;
 }
-export interface AfterEntryRevisionCreateTopicParams {
+export interface AfterEntryCreateRevisionTopicParams {
+    input: CreateFromCmsEntryInput;
     entry: CmsEntry;
+    original: CmsEntry;
     model: CmsModel;
     storageEntry: CmsEntry;
 }
 export interface BeforeEntryUpdateTopicParams {
-    input: Partial<CmsEntry>;
+    input: UpdateCmsEntryInput;
     original: CmsEntry;
     entry: CmsEntry;
     model: CmsModel;
 }
 export interface AfterEntryUpdateTopicParams {
-    input: Partial<CmsEntry>;
+    input: UpdateCmsEntryInput;
     original: CmsEntry;
     entry: CmsEntry;
     model: CmsModel;
@@ -1486,11 +1500,11 @@ export interface AfterEntryDeleteTopicParams {
     entry: CmsEntry;
     model: CmsModel;
 }
-export interface BeforeEntryRevisionDeleteTopicParams {
+export interface BeforeEntryDeleteRevisionTopicParams {
     entry: CmsEntry;
     model: CmsModel;
 }
-export interface AfterEntryRevisionDeleteTopicParams {
+export interface AfterEntryDeleteRevisionTopicParams {
     entry: CmsEntry;
     model: CmsModel;
 }
@@ -1502,6 +1516,27 @@ export interface BeforeEntryListTopicParams {
     where: CmsEntryListWhere;
     model: CmsModel;
 }
+/**
+ * @category Context
+ * @category CmsEntry
+ */
+export interface CreateCmsEntryInput {
+    [key: string]: any;
+}
+/**
+ * @category Context
+ * @category CmsEntry
+ */
+export interface CreateFromCmsEntryInput {
+    [key: string]: any;
+}
+/**
+ * @category Context
+ * @category CmsEntry
+ */
+export interface UpdateCmsEntryInput {
+    [key: string]: any;
+}
 /**
  * Cms Entry CRUD methods in the context.
  *
@@ -1544,15 +1579,15 @@ export interface CmsEntryContext {
     /**
      * Create a new content entry.
      */
-    createEntry: (model: CmsModel, data: Record<string, any>) => Promise<CmsEntry>;
+    createEntry: (model: CmsModel, input: CreateCmsEntryInput) => Promise<CmsEntry>;
     /**
      * Create a new entry from already existing entry.
      */
-    createEntryRevisionFrom: (model: CmsModel, id: string, data: Record<string, any>) => Promise<CmsEntry>;
+    createEntryRevisionFrom: (model: CmsModel, id: string, input: CreateFromCmsEntryInput) => Promise<CmsEntry>;
     /**
      * Update existing entry.
      */
-    updateEntry: (model: CmsModel, id: string, data?: Record<string, any>) => Promise<CmsEntry>;
+    updateEntry: (model: CmsModel, id: string, input?: UpdateCmsEntryInput) => Promise<CmsEntry>;
     /**
      * Method that republishes entry with given identifier.
      * @internal
@@ -1591,14 +1626,14 @@ export interface CmsEntryContext {
      */
     onBeforeEntryCreate: Topic<BeforeEntryCreateTopicParams>;
     onAfterEntryCreate: Topic<AfterEntryCreateTopicParams>;
-    onBeforeEntryRevisionCreate: Topic<BeforeEntryRevisionCreateTopicParams>;
-    onAfterEntryRevisionCreate: Topic<AfterEntryRevisionCreateTopicParams>;
+    onBeforeEntryCreateRevision: Topic<BeforeEntryCreateRevisionTopicParams>;
+    onAfterEntryCreateRevision: Topic<AfterEntryCreateRevisionTopicParams>;
     onBeforeEntryUpdate: Topic<BeforeEntryUpdateTopicParams>;
     onAfterEntryUpdate: Topic<AfterEntryUpdateTopicParams>;
     onBeforeEntryDelete: Topic<BeforeEntryDeleteTopicParams>;
     onAfterEntryDelete: Topic<AfterEntryDeleteTopicParams>;
-    onBeforeEntryRevisionDelete: Topic<BeforeEntryRevisionDeleteTopicParams>;
-    onAfterEntryRevisionDelete: Topic<AfterEntryRevisionDeleteTopicParams>;
+    onBeforeEntryDeleteRevision: Topic<BeforeEntryDeleteRevisionTopicParams>;
+    onAfterEntryDeleteRevision: Topic<AfterEntryDeleteRevisionTopicParams>;
     onBeforeEntryPublish: Topic<BeforeEntryPublishTopicParams>;
     onAfterEntryPublish: Topic<AfterEntryPublishTopicParams>;
     onBeforeEntryUnpublish: Topic<BeforeEntryUnpublishTopicParams>;

package/types.js

@@ -291,6 +291,21 @@ exports.CONTENT_ENTRY_STATUS = void 0;
  * @category GraphQL output
  */
 
+/**
+ * @category Context
+ * @category CmsEntry
+ */
+
+/**
+ * @category Context
+ * @category CmsEntry
+ */
+
+/**
+ * @category Context
+ * @category CmsEntry
+ */
+
 /**
  * Cms Entry CRUD methods in the context.
  *