@webiny/api-headless-cms 0.0.0-unstable.990c3ab1b6 → 0.0.0-unstable.aa00eecd97

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.
      */
@@ -115,6 +118,7 @@ export interface CmsModelFieldSettings {
      */
     [key: string]: any;
 }
+export declare type CmsModelFieldType = "boolean" | "datetime" | "file" | "long-text" | "number" | "object" | "ref" | "rich-text" | "text" | "dynamicZone" | string;
 /**
  * A definition for content model field. This type exists on the app side as well.
  *
@@ -135,18 +139,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: CmsModelFieldType;
     /**
      * 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 +197,10 @@ export interface CmsModelField {
      *
      */
     multipleValues?: boolean;
+    /**
+     * Fields can be tagged to give them contextual meaning.
+     */
+    tags?: string[];
     /**
      * Any user defined settings.
      *
@@ -202,18 +208,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 +365,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 +393,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 +422,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 +442,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 +458,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 +471,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 +508,41 @@ export interface CmsModelFieldDefinition {
     fields: string;
     typeDefs?: string;
 }
-interface CmsModelFieldToGraphQLCreateResolverParams {
+interface CmsModelFieldToGraphQLCreateResolverParams<TField> {
     models: CmsModel[];
     model: CmsModel;
     graphQLType: string;
-    field: CmsModelField;
+    field: TField;
     createFieldResolvers: any;
+    fieldTypePlugins: CmsFieldTypePlugins;
 }
-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
      */
@@ -493,24 +580,6 @@ export interface CmsModelFieldToGraphQLPlugin extends Plugin {
      * ```
      */
     isSortable: boolean;
-    /**
-     * Optional method which creates the storageId.
-     * Primary use is for the datetime field, but if users has some specific fields, they can customize the storageId to their needs.
-     *
-     * ```ts
-     * createStorageId: ({field}) => {
-     *     if (field.settings.type === "time) {
-     *         return `${field.type}_time@${field.id}`
-     *     }
-     *     // use default method
-     *     return undefined;
-     * }
-     * ```
-     */
-    createStorageId?: (params: {
-        model: CmsModel;
-        field: CmsModelField;
-    }) => string | null | undefined;
     /**
      * Read API methods.
      */
@@ -527,8 +596,7 @@ export interface CmsModelFieldToGraphQLPlugin extends Plugin {
          * ```
          */
         createGetFilters?(params: {
-            model: CmsModel;
-            field: CmsModelField;
+            field: TField;
         }): string;
         /**
          * Definition for list filtering for GraphQL.
@@ -547,8 +615,9 @@ export interface CmsModelFieldToGraphQLPlugin extends Plugin {
          * ```
          */
         createListFilters?(params: {
-            model: CmsModel;
-            field: CmsModelField;
+            model: Pick<CmsModel, "singularApiName">;
+            field: TField;
+            plugins: CmsFieldTypePlugins;
         }): string;
         /**
          * Definition of the field type for GraphQL - be aware if multiple values is selected.
@@ -566,13 +635,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: {
@@ -584,7 +654,7 @@ export interface CmsModelFieldToGraphQLPlugin extends Plugin {
          * }
          * ```
          */
-        createResolver?: CmsModelFieldToGraphQLCreateResolver;
+        createResolver?: CmsModelFieldToGraphQLCreateResolver<TField>;
         /**
          * Read API schema definitions for the field and resolvers for them.
          *
@@ -626,8 +696,9 @@ export interface CmsModelFieldToGraphQLPlugin extends Plugin {
          * ```
          */
         createListFilters?: (params: {
-            model: CmsModel;
-            field: CmsModelField;
+            model: Pick<CmsModel, "singularApiName">;
+            field: TField;
+            plugins: CmsFieldTypePlugins;
         }) => string;
         /**
          * Manage API schema definitions for the field and resolvers for them. Probably similar to `read.createSchema`.
@@ -665,8 +736,9 @@ export interface CmsModelFieldToGraphQLPlugin extends Plugin {
          * ```
          */
         createTypeField: (params: {
+            models: CmsModel[];
             model: CmsModel;
-            field: CmsModelField;
+            field: TField;
             fieldTypePlugins: CmsFieldTypePlugins;
         }) => CmsModelFieldDefinition | string | null;
         /**
@@ -685,13 +757,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: {
@@ -703,8 +776,13 @@ export interface CmsModelFieldToGraphQLPlugin extends Plugin {
          * }
          * ```
          */
-        createResolver?: CmsModelFieldToGraphQLCreateResolver;
+        createResolver?: CmsModelFieldToGraphQLCreateResolver<TField>;
     };
+    /**
+     *
+     * @param field
+     */
+    validateChildFields?: CmsModelFieldToGraphQLPluginValidateChildFields<TField>;
 }
 /**
  * Check for content model locked field.
@@ -743,11 +821,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.
      */
@@ -797,7 +875,7 @@ export interface CmsSettingsContext {
     /**
      * Get the datetime when content model last changed.
      */
-    getModelLastChange: () => Promise<Date>;
+    getModelLastChange: () => Promise<Date | null>;
 }
 export interface OnSystemBeforeInstallTopicParams {
     tenant: string;
@@ -815,9 +893,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
      */
@@ -837,7 +913,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
@@ -849,7 +925,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
@@ -898,7 +974,7 @@ export interface CmsGroup {
     /**
      * CreatedBy reference object.
      */
-    createdBy?: CreatedBy;
+    createdBy?: CmsIdentity;
     /**
      * Date group was created on.
      */
@@ -919,7 +995,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
@@ -945,6 +1021,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
@@ -961,6 +1046,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
@@ -975,6 +1070,14 @@ export interface OnGroupBeforeDeleteTopicParams {
 export interface OnGroupAfterDeleteTopicParams {
     group: CmsGroup;
 }
+/**
+ * @category CmsGroup
+ * @category Topic
+ */
+export interface OnGroupDeleteErrorTopicParams {
+    group: CmsGroup;
+    error: Error;
+}
 /**
  * Cms Group in context.
  *
@@ -1038,10 +1141,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.
@@ -1060,7 +1166,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
@@ -1070,6 +1176,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.
      */
@@ -1077,7 +1191,7 @@ export interface CmsModelCreateInput {
     /**
      * Description of the content model.
      */
-    description?: string;
+    description?: string | null;
     /**
      * Group where to put the content model in.
      */
@@ -1098,13 +1212,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
@@ -1145,11 +1264,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?
      */
@@ -1169,14 +1292,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
@@ -1186,6 +1309,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.
      */
@@ -1193,7 +1324,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.
      */
@@ -1210,10 +1341,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.
@@ -1258,7 +1390,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;
     /**
@@ -1277,11 +1409,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.
@@ -1328,10 +1464,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;
@@ -1364,7 +1500,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[]>;
     /**
@@ -1372,18 +1508,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;
@@ -1392,6 +1531,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;
@@ -1402,6 +1549,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;
@@ -1412,15 +1568,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;
@@ -1467,9 +1643,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
      *
@@ -1528,12 +1704,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>;
 }
 /**
@@ -1619,7 +1799,12 @@ export interface CmsEntryListWhere {
     /**
      * This is to allow querying by any content model field defined by the user.
      */
-    [key: string]: any | CmsEntryListWhereRef;
+    [key: string]: string | number | boolean | undefined | string[] | number[] | null | CmsEntryListWhere[] | CmsEntryListWhere | CmsEntryListWhereRef;
+    /**
+     * To allow querying via nested queries, we added the AND / OR properties.
+     */
+    AND?: CmsEntryListWhere[];
+    OR?: CmsEntryListWhere[];
 }
 /**
  * Entry listing sort.
@@ -1672,15 +1857,18 @@ export interface CmsEntryMeta {
      */
     totalCount: number;
 }
+/**
+ * Create
+ */
 export interface OnEntryBeforeCreateTopicParams {
     input: CreateCmsEntryInput;
     entry: CmsEntry;
-    model: StorageOperationsCmsModel;
+    model: CmsModel;
 }
 export interface OnEntryAfterCreateTopicParams {
     input: CreateCmsEntryInput;
     entry: CmsEntry;
-    model: StorageOperationsCmsModel;
+    model: CmsModel;
     storageEntry: CmsEntry;
 }
 export interface OnEntryCreateErrorTopicParams {
@@ -1689,36 +1877,43 @@ export interface OnEntryCreateErrorTopicParams {
     entry: CmsEntry;
     model: CmsModel;
 }
+/**
+ * Revision Create
+ */
 export interface OnEntryRevisionBeforeCreateTopicParams {
     input: CreateFromCmsEntryInput;
     entry: CmsEntry;
     original: CmsEntry;
-    model: StorageOperationsCmsModel;
+    model: CmsModel;
 }
 export interface OnEntryRevisionAfterCreateTopicParams {
     input: CreateFromCmsEntryInput;
     entry: CmsEntry;
     original: CmsEntry;
-    model: StorageOperationsCmsModel;
+    model: CmsModel;
     storageEntry: CmsEntry;
 }
 export interface OnEntryCreateRevisionErrorTopicParams {
     error: Error;
     input: CreateFromCmsEntryInput;
+    original: CmsEntry;
     entry: CmsEntry;
     model: CmsModel;
 }
+/**
+ * Update
+ */
 export interface OnEntryBeforeUpdateTopicParams {
     input: UpdateCmsEntryInput;
     original: CmsEntry;
     entry: CmsEntry;
-    model: StorageOperationsCmsModel;
+    model: CmsModel;
 }
 export interface OnEntryAfterUpdateTopicParams {
     input: UpdateCmsEntryInput;
     original: CmsEntry;
     entry: CmsEntry;
-    model: StorageOperationsCmsModel;
+    model: CmsModel;
     storageEntry: CmsEntry;
 }
 export interface OnEntryUpdateErrorTopicParams {
@@ -1727,27 +1922,50 @@ export interface OnEntryUpdateErrorTopicParams {
     entry: CmsEntry;
     model: CmsModel;
 }
+/**
+ * Publish
+ */
 export interface OnEntryBeforePublishTopicParams {
     entry: CmsEntry;
-    model: StorageOperationsCmsModel;
+    model: CmsModel;
 }
 export interface OnEntryAfterPublishTopicParams {
     entry: CmsEntry;
-    model: StorageOperationsCmsModel;
+    model: CmsModel;
     storageEntry: CmsEntry;
 }
 export interface OnEntryPublishErrorTopicParams {
     error: Error;
     entry: CmsEntry;
-    model: StorageOperationsCmsModel;
+    model: CmsModel;
+}
+/**
+ * Republish
+ */
+export interface OnEntryBeforeRepublishTopicParams {
+    entry: CmsEntry;
+    model: CmsModel;
 }
+export interface OnEntryAfterRepublishTopicParams {
+    entry: CmsEntry;
+    model: CmsModel;
+    storageEntry: CmsEntry;
+}
+export interface OnEntryRepublishErrorTopicParams {
+    error: Error;
+    entry: CmsEntry;
+    model: CmsModel;
+}
+/**
+ * Unpublish
+ */
 export interface OnEntryBeforeUnpublishTopicParams {
     entry: CmsEntry;
-    model: StorageOperationsCmsModel;
+    model: CmsModel;
 }
 export interface OnEntryAfterUnpublishTopicParams {
     entry: CmsEntry;
-    model: StorageOperationsCmsModel;
+    model: CmsModel;
     storageEntry: CmsEntry;
 }
 export interface OnEntryUnpublishErrorTopicParams {
@@ -1757,43 +1975,60 @@ export interface OnEntryUnpublishErrorTopicParams {
 }
 export interface OnEntryBeforeDeleteTopicParams {
     entry: CmsEntry;
-    model: StorageOperationsCmsModel;
+    model: CmsModel;
 }
 export interface OnEntryAfterDeleteTopicParams {
     entry: CmsEntry;
-    model: StorageOperationsCmsModel;
+    model: CmsModel;
 }
 export interface OnEntryDeleteErrorTopicParams {
     error: Error;
     entry: CmsEntry;
-    model: StorageOperationsCmsModel;
+    model: CmsModel;
 }
 export interface OnEntryRevisionBeforeDeleteTopicParams {
     entry: CmsEntry;
-    model: StorageOperationsCmsModel;
+    model: CmsModel;
 }
 export interface OnEntryRevisionAfterDeleteTopicParams {
     entry: CmsEntry;
-    model: StorageOperationsCmsModel;
+    model: CmsModel;
 }
 export interface OnEntryRevisionDeleteErrorTopicParams {
     error: Error;
     entry: CmsEntry;
-    model: StorageOperationsCmsModel;
+    model: CmsModel;
+}
+export interface OnEntryBeforeDeleteMultipleTopicParams {
+    model: CmsModel;
+    entries: CmsEntry[];
+    ids: string[];
+}
+export interface OnEntryAfterDeleteMultipleTopicParams {
+    model: CmsModel;
+    entries: CmsEntry[];
+    ids: string[];
+}
+export interface OnEntryDeleteMultipleErrorTopicParams {
+    model: CmsModel;
+    entries: CmsEntry[];
+    ids: string[];
+    error: Error;
 }
 export interface OnEntryBeforeGetTopicParams {
-    model: StorageOperationsCmsModel;
+    model: CmsModel;
     where: CmsEntryListWhere;
 }
 export interface EntryBeforeListTopicParams {
     where: CmsEntryListWhere;
-    model: StorageOperationsCmsModel;
+    model: CmsModel;
 }
 /**
  * @category Context
  * @category CmsEntry
  */
 export interface CreateCmsEntryInput {
+    id?: string;
     [key: string]: any;
 }
 /**
@@ -1810,6 +2045,34 @@ export interface CreateFromCmsEntryInput {
 export interface UpdateCmsEntryInput {
     [key: string]: any;
 }
+/**
+ * @category Context
+ * @category CmsEntry
+ */
+export interface GetUniqueFieldValuesParams {
+    where: CmsEntryListWhere;
+    fieldId: string;
+}
+/**
+ * @category CmsEntry
+ */
+export interface CmsDeleteEntryOptions {
+    /**
+     * Runs the delete commands even if the entry is not found in the DynamoDB.
+     * This is to force clean the entry records that might have been left behind a failed delete.
+     */
+    force?: boolean;
+}
+/**
+ * @category Context
+ * @category CmsEntry
+ */
+export interface DeleteMultipleEntriesParams {
+    entries: string[];
+}
+export declare type DeleteMultipleEntriesResponse = {
+    id: string;
+}[];
 /**
  * Cms Entry CRUD methods in the context.
  *
@@ -1820,7 +2083,7 @@ export interface CmsEntryContext {
     /**
      * Get a single content entry for a model.
      */
-    getEntry: (model: CmsModel, params: CmsEntryGetParams) => Promise<CmsEntry | null>;
+    getEntry: (model: CmsModel, params: CmsEntryGetParams) => Promise<CmsEntry>;
     /**
      * Get a list of entries for a model by a given ID (revision).
      */
@@ -1832,15 +2095,15 @@ export interface CmsEntryContext {
     /**
      * List entries for a model. Internal method used by get, listLatest and listPublished.
      */
-    listEntries: (model: CmsModel, params: CmsEntryListParams) => Promise<[CmsEntry[], CmsEntryMeta]>;
+    listEntries: <T = CmsEntryValues>(model: CmsModel, params: CmsEntryListParams) => Promise<[CmsEntry<T>[], CmsEntryMeta]>;
     /**
-     * Lists latest entries. Used for manage API.
+     * Lists the latest entries. Used for manage API.
      */
-    listLatestEntries: (model: CmsModel, params?: CmsEntryListParams) => Promise<[CmsEntry[], CmsEntryMeta]>;
+    listLatestEntries: <T = CmsEntryValues>(model: CmsModel, params?: CmsEntryListParams) => Promise<[CmsEntry<T>[], CmsEntryMeta]>;
     /**
      * List published entries. Used for read API.
      */
-    listPublishedEntries: (model: CmsModel, params?: CmsEntryListParams) => Promise<[CmsEntry[], CmsEntryMeta]>;
+    listPublishedEntries: <T = CmsEntryValues>(model: CmsModel, params?: CmsEntryListParams) => Promise<[CmsEntry<T>[], CmsEntryMeta]>;
     /**
      * List published entries by IDs.
      */
@@ -1873,7 +2136,11 @@ export interface CmsEntryContext {
     /**
      * Delete entry with all its revisions.
      */
-    deleteEntry: (model: CmsModel, id: string) => Promise<void>;
+    deleteEntry: (model: CmsModel, id: string, options?: CmsDeleteEntryOptions) => Promise<void>;
+    /**
+     * Delete multiple entries
+     */
+    deleteMultipleEntries: (model: CmsModel, params: DeleteMultipleEntriesParams) => Promise<DeleteMultipleEntriesResponse>;
     /**
      * Publish entry.
      */
@@ -1887,7 +2154,13 @@ export interface CmsEntryContext {
      */
     getEntryRevisions: (model: CmsModel, id: string) => Promise<CmsEntry[]>;
     /**
-     * Lifecyle events - deprecated.
+     * List all unique values for a given field.
+     *
+     * @internal
+     */
+    getUniqueFieldValues: (model: CmsModel, params: GetUniqueFieldValuesParams) => Promise<string[]>;
+    /**
+     * Lifecycle events - deprecated.
      */
     /**
      * @deprecated
@@ -1974,6 +2247,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>;
@@ -2022,13 +2298,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[];
@@ -2042,7 +2318,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[];
@@ -2057,13 +2333,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[];
@@ -2178,7 +2454,7 @@ export interface CmsEntryStorageOperationsListParams {
     sort?: CmsEntryListSort;
     search?: string;
     fields?: string[];
-    limit?: number;
+    limit: number;
     after?: string | null;
 }
 export interface CmsEntryStorageOperationsCreateParams<T extends CmsStorageEntry = CmsStorageEntry> {
@@ -2230,11 +2506,11 @@ export interface CmsEntryStorageOperationsDeleteRevisionParams<T extends CmsStor
     latestStorageEntry: T | null;
 }
 export interface CmsEntryStorageOperationsDeleteParams {
-    /**
-     * Entry that is going to be deleted.
-     */
     entry: CmsEntry;
 }
+export interface CmsEntryStorageOperationsDeleteEntriesParams {
+    entries: string[];
+}
 export interface CmsEntryStorageOperationsPublishParams<T extends CmsStorageEntry = CmsStorageEntry> {
     /**
      * The modified entry that is going to be saved as published.
@@ -2256,6 +2532,10 @@ export interface CmsEntryStorageOperationsUnpublishParams<T extends CmsStorageEn
      */
     storageEntry: T;
 }
+export interface CmsEntryStorageOperationsGetUniqueFieldValuesParams {
+    where: CmsEntryListWhere;
+    fieldId: string;
+}
 export interface CmsEntryStorageOperationsGetByIdsParams {
     ids: readonly string[];
 }
@@ -2312,71 +2592,81 @@ export interface CmsEntryStorageOperations<T extends CmsStorageEntry = CmsStorag
     /**
      * Get all the entries of the ids.
      */
-    getByIds: (model: StorageOperationsCmsModel, params: CmsEntryStorageOperationsGetByIdsParams) => Promise<T[]>;
+    getByIds: (model: CmsModel, params: CmsEntryStorageOperationsGetByIdsParams) => Promise<T[]>;
     /**
      * Get all the published entries of the ids.
      */
-    getPublishedByIds: (model: StorageOperationsCmsModel, params: CmsEntryStorageOperationsGetPublishedByIdsParams) => Promise<T[]>;
+    getPublishedByIds: (model: CmsModel, params: CmsEntryStorageOperationsGetPublishedByIdsParams) => Promise<T[]>;
     /**
      * Get all the latest entries of the ids.
      */
-    getLatestByIds: (model: StorageOperationsCmsModel, params: CmsEntryStorageOperationsGetLatestByIdsParams) => Promise<T[]>;
+    getLatestByIds: (model: CmsModel, params: CmsEntryStorageOperationsGetLatestByIdsParams) => Promise<T[]>;
     /**
      * Get all revisions of the given entry id.
      */
-    getRevisions: (model: StorageOperationsCmsModel, params: CmsEntryStorageOperationsGetRevisionsParams) => Promise<T[]>;
+    getRevisions: (model: CmsModel, params: CmsEntryStorageOperationsGetRevisionsParams) => Promise<T[]>;
     /**
      * Get the entry by the given revision id.
      */
-    getRevisionById: (model: StorageOperationsCmsModel, params: CmsEntryStorageOperationsGetRevisionParams) => Promise<T | null>;
+    getRevisionById: (model: CmsModel, params: CmsEntryStorageOperationsGetRevisionParams) => Promise<T | null>;
     /**
      * Get the published entry by given entryId.
      */
-    getPublishedRevisionByEntryId: (model: StorageOperationsCmsModel, params: CmsEntryStorageOperationsGetPublishedRevisionParams) => Promise<T | null>;
+    getPublishedRevisionByEntryId: (model: CmsModel, params: CmsEntryStorageOperationsGetPublishedRevisionParams) => Promise<T | null>;
     /**
      * Get the latest entry by given entryId.
      */
-    getLatestRevisionByEntryId: (model: StorageOperationsCmsModel, params: CmsEntryStorageOperationsGetLatestRevisionParams) => Promise<T | null>;
+    getLatestRevisionByEntryId: (model: CmsModel, params: CmsEntryStorageOperationsGetLatestRevisionParams) => Promise<T | null>;
     /**
      * Get the revision of the entry before given one.
      */
-    getPreviousRevision: (model: StorageOperationsCmsModel, params: CmsEntryStorageOperationsGetPreviousRevisionParams) => Promise<T | null>;
+    getPreviousRevision: (model: CmsModel, params: CmsEntryStorageOperationsGetPreviousRevisionParams) => Promise<T | null>;
     /**
      * Gets entry by given params.
      */
-    get: (model: StorageOperationsCmsModel, params: CmsEntryStorageOperationsGetParams) => Promise<T | null>;
+    get: (model: CmsModel, params: CmsEntryStorageOperationsGetParams) => Promise<T | null>;
     /**
      * List all entries. Filterable via params.
      */
-    list: (model: StorageOperationsCmsModel, params: CmsEntryStorageOperationsListParams) => Promise<CmsEntryStorageOperationsListResponse<T>>;
+    list: (model: CmsModel, params: CmsEntryStorageOperationsListParams) => Promise<CmsEntryStorageOperationsListResponse<T>>;
     /**
      * Create a new entry.
      */
-    create: (model: StorageOperationsCmsModel, params: CmsEntryStorageOperationsCreateParams<T>) => Promise<T>;
+    create: (model: CmsModel, params: CmsEntryStorageOperationsCreateParams<T>) => Promise<T>;
     /**
      * Create a new entry from existing one.
      */
-    createRevisionFrom: (model: StorageOperationsCmsModel, params: CmsEntryStorageOperationsCreateRevisionFromParams<T>) => Promise<T>;
+    createRevisionFrom: (model: CmsModel, params: CmsEntryStorageOperationsCreateRevisionFromParams<T>) => Promise<T>;
     /**
      * Update existing entry.
      */
-    update: (model: StorageOperationsCmsModel, params: CmsEntryStorageOperationsUpdateParams<T>) => Promise<T>;
+    update: (model: CmsModel, params: CmsEntryStorageOperationsUpdateParams<T>) => Promise<T>;
     /**
      * Delete the entry revision.
      */
-    deleteRevision: (model: StorageOperationsCmsModel, params: CmsEntryStorageOperationsDeleteRevisionParams<T>) => Promise<void>;
+    deleteRevision: (model: CmsModel, params: CmsEntryStorageOperationsDeleteRevisionParams<T>) => Promise<void>;
     /**
      * Delete the entry.
      */
-    delete: (model: StorageOperationsCmsModel, params: CmsEntryStorageOperationsDeleteParams) => Promise<void>;
+    delete: (model: CmsModel, params: CmsEntryStorageOperationsDeleteParams) => Promise<void>;
+    /**
+     * Delete multiple entries, with a limit on how much can be deleted in one call.
+     */
+    deleteMultipleEntries: (model: CmsModel, params: CmsEntryStorageOperationsDeleteEntriesParams) => Promise<void>;
     /**
      * Publish the entry.
      */
-    publish: (model: StorageOperationsCmsModel, params: CmsEntryStorageOperationsPublishParams<T>) => Promise<T>;
+    publish: (model: CmsModel, params: CmsEntryStorageOperationsPublishParams<T>) => Promise<T>;
     /**
      * Unpublish the entry.
      */
-    unpublish: (model: StorageOperationsCmsModel, params: CmsEntryStorageOperationsUnpublishParams<T>) => Promise<T>;
+    unpublish: (model: CmsModel, params: CmsEntryStorageOperationsUnpublishParams<T>) => Promise<T>;
+    /**
+     * Method to list all the unique values for the given field id.
+     * Simplest use case would be to aggregate tags for some content.
+     * @internal
+     */
+    getUniqueFieldValues: (model: CmsModel, params: CmsEntryStorageOperationsGetUniqueFieldValuesParams) => Promise<string[]>;
 }
 export declare enum CONTENT_ENTRY_STATUS {
     DRAFT = "draft",
@@ -2439,6 +2729,7 @@ export interface CmsSystemStorageOperations {
     update: (params: CmsSystemStorageOperationsUpdateParams) => Promise<CmsSystem>;
 }
 export interface HeadlessCmsStorageOperations<C = CmsContext> {
+    name: string;
     system: CmsSystemStorageOperations;
     settings: CmsSettingsStorageOperations;
     groups: CmsGroupStorageOperations;
@@ -2447,11 +2738,7 @@ export interface HeadlessCmsStorageOperations<C = CmsContext> {
     /**
      * Either attach something from the storage operations or run something in it.
      */
-    beforeInit?: (context: C) => Promise<void>;
+    beforeInit: (context: C) => Promise<void>;
     init?: (context: C) => Promise<void>;
-    /**
-     * An upgrade to run if necessary.
-     */
-    upgrade?: UpgradePlugin | null;
 }
 export {};