@webiny/api-headless-cms 0.0.0-unstable.615a930a68 → 0.0.0-unstable.6509387258

package/types.d.ts

@@ -5,7 +5,6 @@ import { GraphQLFieldResolver, GraphQLSchemaDefinition, Resolvers } from "@webin
 import { SecurityPermission } from "@webiny/api-security/types";
 import { DbContext } from "@webiny/handler-db/types";
 import { FileManagerContext } from "@webiny/api-file-manager/types";
-import { UpgradePlugin } from "@webiny/api-upgrade/types";
 import { Topic } from "@webiny/pubsub/types";
 import { CmsModelConverterCallable } from "./utils/converters/ConverterCollection";
 export declare type ApiEndpoint = "manage" | "preview" | "read";
@@ -98,6 +97,10 @@ export interface CmsModelFieldSettings {
      * Object field has child fields.
      */
     fields?: CmsModelField[];
+    /**
+     * Is the file field images only one?
+     */
+    imagesOnly?: boolean;
     /**
      * Object field has child fields - so it needs to have a layout.
      */
@@ -135,18 +138,16 @@ export interface CmsModelField {
      * A type of the field.
      * We are defining our built-in fields, so people know which are available by the default.
      */
-    type: "boolean" | "datetime" | "file" | "long-text" | "number" | "object" | "ref" | "rich-text" | "text" | string;
+    type: "boolean" | "datetime" | "file" | "long-text" | "number" | "object" | "ref" | "rich-text" | "text" | "dynamicZone" | string;
     /**
      * A unique storage ID for storing actual values.
-     * Must in form of a-zA-Z0-9@a-zA-Z0-9@a-zA-Z0-9.
+     * Must in form of a-zA-Z0-9@a-zA-Z0-9
      *
      * This is an auto-generated value: uses `id` and `type`
      *
      * This is used as path for the entry value.
-     *
-     * @internal
      */
-    storageId: string;
+    storageId: `${string}@${string}` | string;
     /**
      * Field identifier for the model field that will be available to the outside world.
      * `storageId` is used as path (or column) to store the data.
@@ -195,6 +196,10 @@ export interface CmsModelField {
      *
      */
     multipleValues?: boolean;
+    /**
+     * Fields can be tagged to give them contextual meaning.
+     */
+    tags?: string[];
     /**
      * Any user defined settings.
      *
@@ -202,18 +207,42 @@ export interface CmsModelField {
      */
     settings?: CmsModelFieldSettings;
 }
+export interface CmsDynamicZoneTemplate {
+    id: string;
+    name: string;
+    gqlTypeName: string;
+    description: string;
+    icon: string;
+    fields: CmsModelField[];
+    layout: string[][];
+    validation: CmsModelFieldValidation[];
+}
+/**
+ * A definition for dynamic-zone field to show possible type of the field in settings.
+ */
+export interface CmsModelDynamicZoneField extends CmsModelField {
+    /**
+     * Settings object for the field. Contains `templates` property.
+     */
+    settings: {
+        templates: CmsDynamicZoneTemplate[];
+    };
+}
 /**
  * Used for our internal functionality.
  */
 export interface CmsModelFieldWithParent extends CmsModelField {
     parent?: CmsModelFieldWithParent | null;
 }
+export interface CmsModelDynamicZoneFieldWithParent extends CmsModelDynamicZoneField {
+    parent?: CmsModelDynamicZoneFieldWithParent | null;
+}
 /**
  * A definition for dateTime field to show possible type of the field in settings.
  */
 export interface CmsModelDateTimeField extends CmsModelField {
     /**
-     * Settings object for the field. Contains type property.
+     * Settings object for the field. Contains `type` property.
      */
     settings: {
         type: "time" | "date" | "dateTimeWithoutTimezone" | "dateTimeWithTimezone";
@@ -335,7 +364,21 @@ export interface LockedField {
     [key: string]: any;
 }
 /**
- * Cms Model defining an entry.
+ * @category Database model
+ * @category CmsModel
+ */
+export interface CmsModelGroup {
+    /**
+     * Generated ID of the group
+     */
+    id: string;
+    /**
+     * Name of the group
+     */
+    name: string;
+}
+/**
+ * Base CMS Model. Should not be exported and used outside of this package.
  *
  * @category Database model
  * @category CmsModel
@@ -349,6 +392,24 @@ export interface CmsModel {
      * Unique ID for the content model. Created from name if not defined by user.
      */
     modelId: string;
+    /**
+     * Name of the content model in singular form to be used in the API.
+     * example:
+     * - Article
+     * - Fruit
+     * - Vegetable
+     * - Car
+     */
+    singularApiName: string;
+    /**
+     * Name of the content model in plural form to be used in the API.
+     * example:
+     * - Articles
+     * - Fruits
+     * - Vegetables
+     * - Cars
+     */
+    pluralApiName: string;
     /**
      * Model tenant.
      */
@@ -360,20 +421,15 @@ export interface CmsModel {
     /**
      * Cms Group reference object.
      */
-    group: {
-        /**
-         * Generated ID of the group
-         */
-        id: string;
-        /**
-         * Name of the group
-         */
-        name: string;
-    };
+    group: CmsModelGroup;
+    /**
+     * Icon for the content model.
+     */
+    icon?: string | null;
     /**
      * Description for the content model.
      */
-    description: string;
+    description: string | null;
     /**
      * Date created
      */
@@ -385,7 +441,7 @@ export interface CmsModel {
     /**
      * CreatedBy object wrapper. Contains id, name and type of the user.
      */
-    createdBy?: CreatedBy;
+    createdBy?: CmsIdentity;
     /**
      * List of fields defining entry values.
      */
@@ -401,6 +457,10 @@ export interface CmsModel {
      * ```
      */
     layout: string[][];
+    /**
+     * Models can be tagged to give them contextual meaning.
+     */
+    tags?: string[];
     /**
      * List of locked fields. Updated when entry is saved and a field has been used.
      */
@@ -410,6 +470,16 @@ export interface CmsModel {
      * It is picked as first available text field. Or user can select own field.
      */
     titleFieldId: string;
+    /**
+     * The field which is displayed as the description one.
+     * Only way this is null or undefined is that there are no long-text fields to be set as description.
+     */
+    descriptionFieldId?: string | null;
+    /**
+     * The field which is displayed as the image.
+     * Only way this is null or undefined is that there are no file fields, with images only set, to be set as image.
+     */
+    imageFieldId?: string | null;
     /**
      * The version of Webiny which this record was stored with.
      */
@@ -437,25 +507,40 @@ export interface CmsModelFieldDefinition {
     fields: string;
     typeDefs?: string;
 }
-interface CmsModelFieldToGraphQLCreateResolverParams {
+interface CmsModelFieldToGraphQLCreateResolverParams<TField> {
     models: CmsModel[];
     model: CmsModel;
     graphQLType: string;
-    field: CmsModelField;
+    field: TField;
     createFieldResolvers: any;
 }
-export interface CmsModelFieldToGraphQLCreateResolver {
-    (params: CmsModelFieldToGraphQLCreateResolverParams): GraphQLFieldResolver | {
+export interface CmsModelFieldToGraphQLCreateResolver<TField = CmsModelField> {
+    (params: CmsModelFieldToGraphQLCreateResolverParams<TField>): GraphQLFieldResolver | {
         resolver: GraphQLFieldResolver | null;
         typeResolvers: Resolvers<CmsContext>;
     } | false;
 }
+export interface CmsModelFieldToGraphQLPluginValidateChildFieldsValidateParams<TField extends CmsModelField = CmsModelField> {
+    fields: TField[];
+    originalFields: TField[];
+}
+export interface CmsModelFieldToGraphQLPluginValidateChildFieldsValidate {
+    (params: CmsModelFieldToGraphQLPluginValidateChildFieldsValidateParams): void;
+}
+export interface CmsModelFieldToGraphQLPluginValidateChildFieldsParams<TField extends CmsModelField = CmsModelField> {
+    field: TField;
+    originalField?: TField;
+    validate: CmsModelFieldToGraphQLPluginValidateChildFieldsValidate;
+}
+export interface CmsModelFieldToGraphQLPluginValidateChildFields<TField extends CmsModelField = CmsModelField> {
+    (params: CmsModelFieldToGraphQLPluginValidateChildFieldsParams<TField>): void;
+}
 /**
  * @category Plugin
  * @category ModelField
  * @category GraphQL
  */
-export interface CmsModelFieldToGraphQLPlugin extends Plugin {
+export interface CmsModelFieldToGraphQLPlugin<TField extends CmsModelField = CmsModelField> extends Plugin {
     /**
      * A plugin type
      */
@@ -509,7 +594,7 @@ export interface CmsModelFieldToGraphQLPlugin extends Plugin {
      */
     createStorageId?: (params: {
         model: CmsModel;
-        field: CmsModelField;
+        field: TField;
     }) => string | null | undefined;
     /**
      * Read API methods.
@@ -528,7 +613,7 @@ export interface CmsModelFieldToGraphQLPlugin extends Plugin {
          */
         createGetFilters?(params: {
             model: CmsModel;
-            field: CmsModelField;
+            field: TField;
         }): string;
         /**
          * Definition for list filtering for GraphQL.
@@ -548,7 +633,7 @@ export interface CmsModelFieldToGraphQLPlugin extends Plugin {
          */
         createListFilters?(params: {
             model: CmsModel;
-            field: CmsModelField;
+            field: TField;
             plugins: CmsFieldTypePlugins;
         }): string;
         /**
@@ -567,13 +652,14 @@ export interface CmsModelFieldToGraphQLPlugin extends Plugin {
          * ```
          */
         createTypeField(params: {
+            models: CmsModel[];
             model: CmsModel;
-            field: CmsModelField;
+            field: TField;
             fieldTypePlugins: CmsFieldTypePlugins;
         }): CmsModelFieldDefinition | string | null;
         /**
          * Definition for field resolver.
-         * By default it is simple return of the `instance.values[storageId]` but if required, users can define their own.
+         * By default, it is simple return of the `instance.values[storageId]` but if required, users can define their own.
          *
          * ```ts
          * read: {
@@ -585,7 +671,7 @@ export interface CmsModelFieldToGraphQLPlugin extends Plugin {
          * }
          * ```
          */
-        createResolver?: CmsModelFieldToGraphQLCreateResolver;
+        createResolver?: CmsModelFieldToGraphQLCreateResolver<TField>;
         /**
          * Read API schema definitions for the field and resolvers for them.
          *
@@ -628,7 +714,7 @@ export interface CmsModelFieldToGraphQLPlugin extends Plugin {
          */
         createListFilters?: (params: {
             model: CmsModel;
-            field: CmsModelField;
+            field: TField;
             plugins: CmsFieldTypePlugins;
         }) => string;
         /**
@@ -667,8 +753,9 @@ export interface CmsModelFieldToGraphQLPlugin extends Plugin {
          * ```
          */
         createTypeField: (params: {
+            models: CmsModel[];
             model: CmsModel;
-            field: CmsModelField;
+            field: TField;
             fieldTypePlugins: CmsFieldTypePlugins;
         }) => CmsModelFieldDefinition | string | null;
         /**
@@ -687,13 +774,14 @@ export interface CmsModelFieldToGraphQLPlugin extends Plugin {
          * ```
          */
         createInputField: (params: {
+            models: CmsModel[];
             model: CmsModel;
-            field: CmsModelField;
+            field: TField;
             fieldTypePlugins: CmsFieldTypePlugins;
         }) => CmsModelFieldDefinition | string | null;
         /**
          * Definition for field resolver.
-         * By default it is simple return of the `instance.values[storageId]` but if required, users can define their own.
+         * By default, it is simple return of the `instance.values[storageId]` but if required, users can define their own.
          *
          * ```ts
          * manage: {
@@ -705,8 +793,13 @@ export interface CmsModelFieldToGraphQLPlugin extends Plugin {
          * }
          * ```
          */
-        createResolver?: CmsModelFieldToGraphQLCreateResolver;
+        createResolver?: CmsModelFieldToGraphQLCreateResolver<TField>;
     };
+    /**
+     *
+     * @param field
+     */
+    validateChildFields?: CmsModelFieldToGraphQLPluginValidateChildFields<TField>;
 }
 /**
  * Check for content model locked field.
@@ -745,11 +838,11 @@ export interface CmsFieldTypePlugins {
     [key: string]: CmsModelFieldToGraphQLPlugin;
 }
 /**
- * A interface describing the reference to a user that created some data in the database.
+ * An interface describing the reference to a user that created some data in the database.
  *
  * @category General
  */
-export interface CreatedBy {
+export interface CmsIdentity {
     /**
      * ID if the user.
      */
@@ -817,9 +910,7 @@ export interface OnSystemInstallErrorTopicParams {
 export declare type CmsSystemContext = {
     getSystemVersion: () => Promise<string | null>;
     setSystemVersion: (version: string) => Promise<void>;
-    getReadAPIKey(): Promise<string | null>;
     installSystem: () => Promise<void>;
-    upgradeSystem: (version: string) => Promise<boolean>;
     /**
      * Lifecycle events - deprecated
      */
@@ -839,7 +930,7 @@ export declare type CmsSystemContext = {
     onSystemInstallError: Topic<OnSystemInstallErrorTopicParams>;
 };
 /**
- * A GraphQL params.data parameter received when creating content model group.
+ * A GraphQL `params.data` parameter received when creating content model group.
  *
  * @category CmsGroup
  * @category GraphQL params
@@ -851,7 +942,7 @@ export interface CmsGroupCreateInput {
     icon: string;
 }
 /**
- * A GraphQL params.data parameter received when updating content model group.
+ * A GraphQL `params.data` parameter received when updating content model group.
  *
  * @category CmsGroup
  * @category GraphQL params
@@ -900,7 +991,7 @@ export interface CmsGroup {
     /**
      * CreatedBy reference object.
      */
-    createdBy?: CreatedBy;
+    createdBy?: CmsIdentity;
     /**
      * Date group was created on.
      */
@@ -921,7 +1012,7 @@ export interface CmsGroup {
     isPrivate?: boolean;
 }
 /**
- * A data.where parameter received when listing content model groups.
+ * A `data.where` parameter received when listing content model groups.
  *
  * @category CmsGroup
  * @category GraphQL params
@@ -947,6 +1038,15 @@ export interface OnGroupBeforeCreateTopicParams {
 export interface OnGroupAfterCreateTopicParams {
     group: CmsGroup;
 }
+/**
+ * @category CmsGroup
+ * @category Topic
+ */
+export interface OnGroupCreateErrorTopicParams {
+    input: CmsGroupCreateInput;
+    group: CmsGroup;
+    error: Error;
+}
 /**
  * @category CmsGroup
  * @category Topic
@@ -963,6 +1063,16 @@ export interface OnGroupAfterUpdateTopicParams {
     original: CmsGroup;
     group: CmsGroup;
 }
+/**
+ * @category CmsGroup
+ * @category Topic
+ */
+export interface OnGroupUpdateErrorTopicParams {
+    input: CmsGroupUpdateInput;
+    original: CmsGroup;
+    group: CmsGroup;
+    error: Error;
+}
 /**
  * @category CmsGroup
  * @category Topic
@@ -977,6 +1087,14 @@ export interface OnGroupBeforeDeleteTopicParams {
 export interface OnGroupAfterDeleteTopicParams {
     group: CmsGroup;
 }
+/**
+ * @category CmsGroup
+ * @category Topic
+ */
+export interface OnGroupDeleteErrorTopicParams {
+    group: CmsGroup;
+    error: Error;
+}
 /**
  * Cms Group in context.
  *
@@ -1040,10 +1158,13 @@ export interface CmsGroupContext {
      */
     onGroupBeforeCreate: Topic<OnGroupBeforeCreateTopicParams>;
     onGroupAfterCreate: Topic<OnGroupAfterCreateTopicParams>;
+    onGroupCreateError: Topic<OnGroupCreateErrorTopicParams>;
     onGroupBeforeUpdate: Topic<OnGroupBeforeUpdateTopicParams>;
     onGroupAfterUpdate: Topic<OnGroupAfterUpdateTopicParams>;
+    onGroupUpdateError: Topic<OnGroupUpdateErrorTopicParams>;
     onGroupBeforeDelete: Topic<OnGroupBeforeDeleteTopicParams>;
     onGroupAfterDelete: Topic<OnGroupAfterDeleteTopicParams>;
+    onGroupDeleteError: Topic<OnGroupDeleteErrorTopicParams>;
 }
 /**
  * Definition for content model field validator.
@@ -1062,7 +1183,7 @@ export interface CmsModelFieldValidation {
     };
 }
 /**
- * A GraphQL params.data parameter received when creating content model.
+ * A GraphQL `params.data` parameter received when creating content model.
  *
  * @category GraphQL params
  * @category CmsModel
@@ -1072,6 +1193,14 @@ export interface CmsModelCreateInput {
      * Name of the content model.
      */
     name: string;
+    /**
+     * Singular name of the content model to be used in the API.
+     */
+    singularApiName: string;
+    /**
+     * Plural name of the content model to be used in the API.
+     */
+    pluralApiName: string;
     /**
      * Unique ID of the content model. Created from name if not sent by the user. Cannot be changed.
      */
@@ -1079,7 +1208,7 @@ export interface CmsModelCreateInput {
     /**
      * Description of the content model.
      */
-    description?: string;
+    description?: string | null;
     /**
      * Group where to put the content model in.
      */
@@ -1100,13 +1229,18 @@ export interface CmsModelCreateInput {
      */
     layout?: string[][];
     /**
-     * The field that is being displayed as entry title.
-     * It is picked as first available text field. Or user can select own field.
+     * Models can be tagged to give them contextual meaning.
+     */
+    tags?: string[];
+    /**
+     * Fields fieldId which are picked to represent the CMS entry.
      */
-    titleFieldId?: string;
+    titleFieldId?: string | null;
+    descriptionFieldId?: string | null;
+    imageFieldId?: string | null;
 }
 /**
- * A GraphQL params.data parameter received when creating content model from existing model.
+ * A GraphQL `params.data` parameter received when creating content model from existing model.
  *
  * @category GraphQL params
  * @category CmsModel
@@ -1147,11 +1281,15 @@ export interface CmsModelFieldInput {
     /**
      * Text to display below the field to help user what to write in the field.
      */
-    helpText?: string;
+    helpText?: string | null;
     /**
      * Text to display in the field.
      */
-    placeholderText?: string;
+    placeholderText?: string | null;
+    /**
+     * Fields can be tagged to give them contextual meaning.
+     */
+    tags?: string[];
     /**
      * Are multiple values allowed?
      */
@@ -1171,14 +1309,14 @@ export interface CmsModelFieldInput {
     /**
      * @see CmsModelField.listValidation
      */
-    listValidation: CmsModelFieldValidation[];
+    listValidation?: CmsModelFieldValidation[];
     /**
      * User defined settings.
      */
     settings?: Record<string, any>;
 }
 /**
- * A GraphQL params.data parameter received when updating content model.
+ * A GraphQL `params.data` parameter received when updating content model.
  *
  * @category GraphQL params
  * @category CmsModel
@@ -1188,6 +1326,14 @@ export interface CmsModelUpdateInput {
      * A new content model name.
      */
     name?: string;
+    /**
+     * A new singular name of the content model to be used in the API.
+     */
+    singularApiName?: string;
+    /**
+     * A new plural name of the content model to be used in the API.
+     */
+    pluralApiName?: string;
     /**
      * A group we want to move the model to.
      */
@@ -1195,7 +1341,7 @@ export interface CmsModelUpdateInput {
     /**
      * A new description of the content model.
      */
-    description?: string;
+    description?: string | null;
     /**
      * A list of content model fields to define the entry values.
      */
@@ -1212,10 +1358,11 @@ export interface CmsModelUpdateInput {
      */
     layout: string[][];
     /**
-     * The field that is being displayed as entry title.
-     * It is picked as first available text field. Or user can select own field.
+     * Fields fieldId which are picked to represent the CMS entry.
      */
-    titleFieldId?: string;
+    titleFieldId?: string | null;
+    descriptionFieldId?: string | null;
+    imageFieldId?: string | null;
 }
 /**
  * A plugin to load a CmsModelManager.
@@ -1260,7 +1407,7 @@ export interface CmsEntryValues {
 export interface CmsEntry<T = CmsEntryValues> {
     /**
      * A version of the webiny this entry was created with.
-     * This can be used when upgrading the system so we know which entries to update.
+     * This can be used when upgrading the system, so we know which entries to update.
      */
     webinyVersion: string;
     /**
@@ -1279,11 +1426,15 @@ export interface CmsEntry<T = CmsEntryValues> {
     /**
      * CreatedBy object reference.
      */
-    createdBy: CreatedBy;
+    createdBy: CmsIdentity;
     /**
      * OwnedBy object reference. Can be different from CreatedBy.
      */
-    ownedBy: CreatedBy;
+    ownedBy: CmsIdentity;
+    /**
+     * ModifiedBy object reference. Last person who modified the entry.
+     */
+    modifiedBy?: CmsIdentity | null;
     /**
      * A string of Date.toISOString() type.
      * Populated on creation.
@@ -1330,10 +1481,10 @@ export interface CmsEntry<T = CmsEntryValues> {
     /**
      * Settings for the given entry.
      *
-     * Introduced with Advanced Publishing Workflow - will be always inserted after this PR is merged.
-     * Be aware that when accessing properties in it on old systems - it will break if not checked first.
+     * Introduced with Advanced Publishing Workflow. Will always be inserted once this PR is merged.
+     * Be aware that when accessing properties in it on old systems, it will break if not checked first.
      *
-     * Available only on the Manage API in entry GraphQL type meta.data property.
+     * Available only on the Manage API in entry GraphQL type `meta.data` property.
      */
     meta?: {
         [key: string]: any;
@@ -1366,7 +1517,7 @@ export interface CmsModelManager {
      */
     getPublishedByIds: (ids: string[]) => Promise<CmsEntry[]>;
     /**
-     * Get a list of latest entries by the ID list.
+     * Get a list of the latest entries by the ID list.
      */
     getLatestByIds: (ids: string[]) => Promise<CmsEntry[]>;
     /**
@@ -1374,18 +1525,21 @@ export interface CmsModelManager {
      */
     get: (id: string) => Promise<CmsEntry>;
     /**
-     * Create a entry.
+     * Create an entry.
      */
     create: (data: CreateCmsEntryInput) => Promise<CmsEntry>;
     /**
-     * Update a entry.
+     * Update an entry.
      */
     update: (id: string, data: UpdateCmsEntryInput) => Promise<CmsEntry>;
     /**
-     * Delete a entry.
+     * Delete an entry.
      */
     delete: (id: string) => Promise<void>;
 }
+/**
+ * Create
+ */
 export interface OnModelBeforeCreateTopicParams {
     input: CmsModelCreateInput;
     model: CmsModel;
@@ -1394,6 +1548,14 @@ export interface OnModelAfterCreateTopicParams {
     input: CmsModelCreateInput;
     model: CmsModel;
 }
+export interface OnModelCreateErrorTopicParams {
+    input: CmsModelCreateInput;
+    model: CmsModel;
+    error: Error;
+}
+/**
+ * Create From / Clone
+ */
 export interface OnModelBeforeCreateFromTopicParams {
     input: CmsModelCreateInput;
     original: CmsModel;
@@ -1404,6 +1566,15 @@ export interface OnModelAfterCreateFromTopicParams {
     original: CmsModel;
     model: CmsModel;
 }
+export interface OnModelCreateFromErrorParams {
+    input: CmsModelCreateInput;
+    original: CmsModel;
+    model: CmsModel;
+    error: Error;
+}
+/**
+ * Update
+ */
 export interface OnModelBeforeUpdateTopicParams {
     input: CmsModelUpdateInput;
     original: CmsModel;
@@ -1414,15 +1585,35 @@ export interface OnModelAfterUpdateTopicParams {
     original: CmsModel;
     model: CmsModel;
 }
+export interface OnModelUpdateErrorTopicParams {
+    input: CmsModelUpdateInput;
+    original: CmsModel;
+    model: CmsModel;
+    error: Error;
+}
+/**
+ * Delete
+ */
 export interface OnModelBeforeDeleteTopicParams {
     model: CmsModel;
 }
 export interface OnModelAfterDeleteTopicParams {
     model: CmsModel;
 }
+export interface OnModelDeleteErrorTopicParams {
+    model: CmsModel;
+    error: Error;
+}
+/**
+ * Initialize
+ */
 export interface OnModelInitializeParams {
     model: CmsModel;
+    data: Record<string, any>;
 }
+/**
+ *
+ */
 export interface CmsModelUpdateDirectParams {
     model: CmsModel;
     original: CmsModel;
@@ -1469,9 +1660,9 @@ export interface CmsModelContext {
      *
      * Primary idea behind this is creating the index, for the code models, in the ES.
      */
-    initializeModel: (modelId: string) => Promise<boolean>;
+    initializeModel: (modelId: string, data: Record<string, any>) => Promise<boolean>;
     /**
-     * Get a instance of CmsModelManager for given content modelId.
+     * Get an instance of CmsModelManager for given content modelId.
      *
      * @see CmsModelManager
      *
@@ -1530,12 +1721,16 @@ export interface CmsModelContext {
      */
     onModelBeforeCreate: Topic<OnModelBeforeCreateTopicParams>;
     onModelAfterCreate: Topic<OnModelAfterCreateTopicParams>;
+    onModelCreateError: Topic<OnModelCreateErrorTopicParams>;
     onModelBeforeCreateFrom: Topic<OnModelBeforeCreateFromTopicParams>;
     onModelAfterCreateFrom: Topic<OnModelAfterCreateFromTopicParams>;
+    onModelCreateFromError: Topic<OnModelCreateFromErrorParams>;
     onModelBeforeUpdate: Topic<OnModelBeforeUpdateTopicParams>;
     onModelAfterUpdate: Topic<OnModelAfterUpdateTopicParams>;
+    onModelUpdateError: Topic<OnModelUpdateErrorTopicParams>;
     onModelBeforeDelete: Topic<OnModelBeforeDeleteTopicParams>;
     onModelAfterDelete: Topic<OnModelAfterDeleteTopicParams>;
+    onModelDeleteError: Topic<OnModelDeleteErrorTopicParams>;
     onModelInitialize: Topic<OnModelInitializeParams>;
 }
 /**
@@ -1679,6 +1874,9 @@ export interface CmsEntryMeta {
      */
     totalCount: number;
 }
+/**
+ * Create
+ */
 export interface OnEntryBeforeCreateTopicParams {
     input: CreateCmsEntryInput;
     entry: CmsEntry;
@@ -1696,6 +1894,9 @@ export interface OnEntryCreateErrorTopicParams {
     entry: CmsEntry;
     model: CmsModel;
 }
+/**
+ * Revision Create
+ */
 export interface OnEntryRevisionBeforeCreateTopicParams {
     input: CreateFromCmsEntryInput;
     entry: CmsEntry;
@@ -1712,9 +1913,13 @@ export interface OnEntryRevisionAfterCreateTopicParams {
 export interface OnEntryCreateRevisionErrorTopicParams {
     error: Error;
     input: CreateFromCmsEntryInput;
+    original: CmsEntry;
     entry: CmsEntry;
     model: CmsModel;
 }
+/**
+ * Update
+ */
 export interface OnEntryBeforeUpdateTopicParams {
     input: UpdateCmsEntryInput;
     original: CmsEntry;
@@ -1734,6 +1939,9 @@ export interface OnEntryUpdateErrorTopicParams {
     entry: CmsEntry;
     model: CmsModel;
 }
+/**
+ * Publish
+ */
 export interface OnEntryBeforePublishTopicParams {
     entry: CmsEntry;
     model: StorageOperationsCmsModel;
@@ -1748,6 +1956,26 @@ export interface OnEntryPublishErrorTopicParams {
     entry: CmsEntry;
     model: StorageOperationsCmsModel;
 }
+/**
+ * Republish
+ */
+export interface OnEntryBeforeRepublishTopicParams {
+    entry: CmsEntry;
+    model: StorageOperationsCmsModel;
+}
+export interface OnEntryAfterRepublishTopicParams {
+    entry: CmsEntry;
+    model: StorageOperationsCmsModel;
+    storageEntry: CmsEntry;
+}
+export interface OnEntryRepublishErrorTopicParams {
+    error: Error;
+    entry: CmsEntry;
+    model: StorageOperationsCmsModel;
+}
+/**
+ * Unpublish
+ */
 export interface OnEntryBeforeUnpublishTopicParams {
     entry: CmsEntry;
     model: StorageOperationsCmsModel;
@@ -1801,6 +2029,7 @@ export interface EntryBeforeListTopicParams {
  * @category CmsEntry
  */
 export interface CreateCmsEntryInput {
+    id?: string;
     [key: string]: any;
 }
 /**
@@ -1841,7 +2070,7 @@ export interface CmsEntryContext {
      */
     listEntries: (model: CmsModel, params: CmsEntryListParams) => Promise<[CmsEntry[], CmsEntryMeta]>;
     /**
-     * Lists latest entries. Used for manage API.
+     * Lists the latest entries. Used for manage API.
      */
     listLatestEntries: (model: CmsModel, params?: CmsEntryListParams) => Promise<[CmsEntry[], CmsEntryMeta]>;
     /**
@@ -1981,6 +2210,9 @@ export interface CmsEntryContext {
     onEntryBeforePublish: Topic<OnEntryBeforePublishTopicParams>;
     onEntryAfterPublish: Topic<OnEntryAfterPublishTopicParams>;
     onEntryPublishError: Topic<OnEntryPublishErrorTopicParams>;
+    onEntryBeforeRepublish: Topic<OnEntryBeforeRepublishTopicParams>;
+    onEntryAfterRepublish: Topic<OnEntryAfterRepublishTopicParams>;
+    onEntryRepublishError: Topic<OnEntryRepublishErrorTopicParams>;
     onEntryBeforeUnpublish: Topic<OnEntryBeforeUnpublishTopicParams>;
     onEntryAfterUnpublish: Topic<OnEntryAfterUnpublishTopicParams>;
     onEntryUnpublishError: Topic<OnEntryUnpublishErrorTopicParams>;
@@ -2029,13 +2261,13 @@ export interface BaseCmsSecurityPermission extends SecurityPermission {
  */
 export interface CmsModelPermission extends BaseCmsSecurityPermission {
     /**
-     * A object representing `key: model.modelId` values where key is locale code.
+     * An object representing `key: model.modelId` values where key is locale code.
      */
     models?: {
         [key: string]: string[];
     };
     /**
-     * A object representing `key: group.id` values where key is locale code.
+     * {locale: groupId[]} map, where key is a locale code.
      */
     groups?: {
         [key: string]: string[];
@@ -2049,7 +2281,7 @@ export interface CmsModelPermission extends BaseCmsSecurityPermission {
  */
 export interface CmsGroupPermission extends BaseCmsSecurityPermission {
     /**
-     * A object representing `key: group.id` values where key is locale code.
+     * {locale: groupId[]} map, where key is a locale code.
      */
     groups?: {
         [key: string]: string[];
@@ -2064,13 +2296,13 @@ export interface CmsGroupPermission extends BaseCmsSecurityPermission {
 export interface CmsEntryPermission extends BaseCmsSecurityPermission {
     pw?: string;
     /**
-     * A object representing `key: model.modelId` values where key is locale code.
+     * An object representing `key: model.modelId` values where key is locale code.
      */
     models?: {
         [key: string]: string[];
     };
     /**
-     * A object representing `key: group.id` values where key is locale code.
+     * {locale: groupId[]} map, where key is a locale code.
      */
     groups?: {
         [key: string]: string[];
@@ -2185,7 +2417,7 @@ export interface CmsEntryStorageOperationsListParams {
     sort?: CmsEntryListSort;
     search?: string;
     fields?: string[];
-    limit?: number;
+    limit: number;
     after?: string | null;
 }
 export interface CmsEntryStorageOperationsCreateParams<T extends CmsStorageEntry = CmsStorageEntry> {
@@ -2457,9 +2689,5 @@ export interface HeadlessCmsStorageOperations<C = CmsContext> {
      */
     beforeInit?: (context: C) => Promise<void>;
     init?: (context: C) => Promise<void>;
-    /**
-     * An upgrade to run if necessary.
-     */
-    upgrade?: UpgradePlugin | null;
 }
 export {};