@webiny/api-headless-cms 5.25.0 → 5.26.0-beta.0

package/types.d.ts

@@ -3,7 +3,6 @@ import { I18NContext, I18NLocale } from "@webiny/api-i18n/types";
 import { Context } from "@webiny/handler/types";
 import { TenancyContext } from "@webiny/api-tenancy/types";
 import { GraphQLFieldResolver, GraphQLSchemaDefinition, Resolvers } from "@webiny/handler-graphql/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";
@@ -46,7 +45,7 @@ export interface HeadlessCms extends CmsSettingsContext, CmsSystemContext, CmsGr
  *
  * @category Context
  */
-export interface CmsContext extends Context, DbContext, HttpContext, I18NContext, FileManagerContext, I18NContentContext, TenancyContext {
+export interface CmsContext extends Context, DbContext, HttpContext, I18NContext, FileManagerContext, TenancyContext {
     cms: HeadlessCms;
 }
 interface CmsModelFieldPredefinedValuesValue {
@@ -320,6 +319,10 @@ export interface CmsModel {
      * Unique ID for the content model. Created from name if not defined by user.
      */
     modelId: string;
+    /**
+     * Model tenant.
+     */
+    tenant: string;
     /**
      * Locale this model belongs to.
      */
@@ -340,7 +343,7 @@ export interface CmsModel {
     /**
      * Description for the content model.
      */
-    description?: string | null;
+    description: string;
     /**
      * Date created
      */
@@ -381,10 +384,6 @@ export interface CmsModel {
      * The version of Webiny which this record was stored with.
      */
     webinyVersion: string;
-    /**
-     * Model tenant.
-     */
-    tenant: string;
 }
 /**
  * @category ModelField
@@ -432,6 +431,15 @@ export interface CmsModelFieldToGraphQLPlugin extends Plugin {
      * ```
      */
     isSearchable: boolean;
+    /**
+     * Is the field searchable via full text search?
+     *
+     * Field is not full text searchable by default.
+     * ```ts
+     * fullTextSearch: false
+     * ```
+     */
+    fullTextSearch?: boolean;
     /**
      * Is the field sortable via the GraphQL?
      *
@@ -730,9 +738,11 @@ export interface CmsSettingsContext {
 }
 export interface BeforeInstallTopicParams {
     tenant: string;
+    locale: string;
 }
 export interface AfterInstallTopicParams {
     tenant: string;
+    locale: string;
 }
 export declare type CmsSystemContext = {
     getSystemVersion: () => Promise<string | null>;
@@ -789,6 +799,10 @@ export interface CmsGroup {
      * Slug for the group. Must be unique.
      */
     slug: string;
+    /**
+     * Group tenant.
+     */
+    tenant: string;
     /**
      * Locale this group belongs to.
      */
@@ -796,11 +810,11 @@ export interface CmsGroup {
     /**
      * Description for the group.
      */
-    description?: string;
+    description: string;
     /**
      * Icon for the group. In a form of "ico/ico".
      */
-    icon?: string;
+    icon: string;
     /**
      * CreatedBy reference object.
      */
@@ -817,10 +831,6 @@ export interface CmsGroup {
      * Which Webiny version was this record stored with.
      */
     webinyVersion: string;
-    /**
-     * Group tenant.
-     */
-    tenant: string;
 }
 /**
  * A data.where parameter received when listing content model groups.
@@ -906,6 +916,10 @@ export interface CmsGroupContext {
      * Delete content model group by given id.
      */
     deleteGroup: (id: string) => Promise<boolean>;
+    /**
+     * Clear the cached groups.
+     */
+    clearGroupsCache: () => void;
     /**
      * Events.
      */
@@ -1296,13 +1310,22 @@ export interface CmsModelContext {
      * Get a instance of CmsModelManager for given content modelId.
      *
      * @see CmsModelManager
+     *
+     * @deprecated use the getEntryManager() method instead
      */
     getModelManager: (model: CmsModel | string) => Promise<CmsModelManager>;
+    getEntryManager: (model: CmsModel | string) => Promise<CmsModelManager>;
     /**
      * Get all content model managers mapped by modelId.
      * @see CmsModelManager
+     * @deprecated use getEntryManagers instead
      */
     getManagers: () => Map<string, CmsModelManager>;
+    getEntryManagers: () => Map<string, CmsModelManager>;
+    /**
+     * Clear all the model caches.
+     */
+    clearModelsCache: () => void;
     /**
      * Events.
      */
@@ -1320,7 +1343,7 @@ export interface CmsModelContext {
  *
  * @category CmsEntry
  */
-declare type CmsEntryStatus = "published" | "unpublished" | "reviewRequested" | "changesRequested" | "draft";
+export declare type CmsEntryStatus = "published" | "unpublished" | "reviewRequested" | "changesRequested" | "draft";
 export interface CmsEntryListWhereRef {
     id?: string;
     id_in?: string[];
@@ -1353,7 +1376,9 @@ export interface CmsEntryListWhere {
     entryId_in?: string[];
     entryId_not_in?: string[];
     /**
-     * Entry is owned by whom?
+     * Contains the owner of the entry. An "owner" is the identity who originally created the entry.
+     * Subsequent revisions can be created by other identities, and those will be stored in `createdBy`,
+     * but the `owner` is always the original author of the entry.
      *
      * Can be sent via the API or set internal if user can see only their own entries.
      */
@@ -1378,32 +1403,23 @@ export interface CmsEntryListWhere {
     version_lt?: number;
     version_gt?: number;
     /**
-     * Each operations implementation MUST determine how to use this field.
-     * In SQL it can be published field and in DynamoDB can be a secondary key.
+     * Each storage operations implementation MUST determine how to use this field.
+     * In SQL, it can be a `published` field, and in DynamoDB it can be an SK.
      *
      * It is not meant to be used via the API.
      * @internal
      */
     published?: boolean;
     /**
-     * Each operations implementation MUST determine how to use this field.
-     * In SQL it can be published field and in DynamoDB can be a secondary key.
+     * Each storage operations implementation MUST determine how to use this field.
+     * In SQL, it can be a `latest` field, and in DynamoDB it can be an SK.
      *
      * It is not meant to be used via the API.
      * @internal
      */
     latest?: boolean;
     /**
-     * Search for exact locale.
-     * This will most likely be populated, but leave it as optional.
-     */
-    locale?: string;
-    /**
-     * Exact tenant. No multi-tenancy search.
-     */
-    tenant: string;
-    /**
-     * Can be reference field or, actually, anything else.
+     * This is to allow querying by any content model field defined by the user.
      */
     [key: string]: any | CmsEntryListWhereRef;
 }
@@ -1431,8 +1447,10 @@ export interface CmsEntryGetParams {
  * @category GraphQL params
  */
 export interface CmsEntryListParams {
-    where: CmsEntryListWhere;
+    where?: CmsEntryListWhere;
     sort?: CmsEntryListSort;
+    search?: string;
+    fields?: string[];
     limit?: number;
     after?: string | null;
 }
@@ -1786,13 +1804,10 @@ export interface CmsGroupStorageOperationsListParams {
     sort?: string[];
 }
 export interface CmsGroupStorageOperationsCreateParams {
-    input: CmsGroupCreateInput;
     group: CmsGroup;
 }
 export interface CmsGroupStorageOperationsUpdateParams {
-    original: CmsGroup;
     group: CmsGroup;
-    input: CmsGroupUpdateInput;
 }
 export interface CmsGroupStorageOperationsDeleteParams {
     group: CmsGroup;
@@ -1838,13 +1853,10 @@ export interface CmsModelStorageOperationsListParams {
     where: CmsModelStorageOperationsListWhereParams;
 }
 export interface CmsModelStorageOperationsCreateParams {
-    input: CmsModelCreateInput;
     model: CmsModel;
 }
 export interface CmsModelStorageOperationsUpdateParams {
-    original: CmsModel;
     model: CmsModel;
-    input: CmsModelUpdateInput;
 }
 export interface CmsModelStorageOperationsDeleteParams {
     model: CmsModel;
@@ -1884,14 +1896,12 @@ export interface CmsEntryStorageOperationsGetParams {
 export interface CmsEntryStorageOperationsListParams {
     where: CmsEntryListWhere;
     sort?: CmsEntryListSort;
+    search?: string;
+    fields?: string[];
     limit?: number;
     after?: string | null;
 }
 export interface CmsEntryStorageOperationsCreateParams<T extends CmsStorageEntry = CmsStorageEntry> {
-    /**
-     * Input received from the user.
-     */
-    input: Record<string, any>;
     /**
      * Real entry, with no transformations on it.
      */
@@ -1902,14 +1912,6 @@ export interface CmsEntryStorageOperationsCreateParams<T extends CmsStorageEntry
     storageEntry: T;
 }
 export interface CmsEntryStorageOperationsCreateRevisionFromParams<T extends CmsStorageEntry = CmsStorageEntry> {
-    /**
-     * The entry we are creating new one from.
-     */
-    originalEntry: CmsEntry;
-    /**
-     * The entry we are creating new one from, directly from storage, with transformations on it.
-     */
-    originalStorageEntry: T;
     /**
      * Latest entry, used to calculate the new version.
      */
@@ -1928,18 +1930,6 @@ export interface CmsEntryStorageOperationsCreateRevisionFromParams<T extends Cms
     storageEntry: T;
 }
 export interface CmsEntryStorageOperationsUpdateParams<T extends CmsStorageEntry = CmsStorageEntry> {
-    /**
-     * Input received from the user.
-     */
-    input: Record<string, any>;
-    /**
-     * Used to compare IDs, versions and passed into storage operations to be used if required.
-     */
-    originalEntry: CmsEntry;
-    /**
-     * Directly from storage, with transformations on it.
-     */
-    originalStorageEntry: T;
     /**
      * Real entry, with no transformations on it.
      */
@@ -1953,39 +1943,27 @@ export interface CmsEntryStorageOperationsDeleteRevisionParams<T extends CmsStor
     /**
      * Entry that was deleted.
      */
-    entryToDelete: CmsEntry;
+    entry: CmsEntry;
     /**
      * Entry that was deleted, directly from storage, with transformations.
      */
-    storageEntryToDelete: T;
+    storageEntry: T;
     /**
      * Entry that was set as latest.
      */
-    entryToSetAsLatest: CmsEntry | null;
+    latestEntry: CmsEntry | null;
     /**
      * Entry that was set as latest, directly from storage, with transformations.
      */
-    storageEntryToSetAsLatest: T | null;
+    latestStorageEntry: T | null;
 }
-export interface CmsEntryStorageOperationsDeleteParams<T extends CmsStorageEntry = CmsStorageEntry> {
+export interface CmsEntryStorageOperationsDeleteParams {
     /**
      * Entry that is going to be deleted.
      */
     entry: CmsEntry;
-    /**
-     * Entry that is going to be deleted, directly from storage.
-     */
-    storageEntry: T;
 }
 export interface CmsEntryStorageOperationsPublishParams<T extends CmsStorageEntry = CmsStorageEntry> {
-    /**
-     * The entry record before it was published.
-     */
-    originalEntry: CmsEntry;
-    /**
-     * Directly from storage, with transformations on it.
-     */
-    originalStorageEntry: T;
     /**
      * The modified entry that is going to be saved as published.
      * Entry is in its original form.
@@ -1997,14 +1975,6 @@ export interface CmsEntryStorageOperationsPublishParams<T extends CmsStorageEntr
     storageEntry: T;
 }
 export interface CmsEntryStorageOperationsUnpublishParams<T extends CmsStorageEntry = CmsStorageEntry> {
-    /**
-     * The entry record before it was unpublished.
-     */
-    originalEntry: CmsEntry;
-    /**
-     * The entry record before it was unpublished, with transformations on it.
-     */
-    originalStorageEntry: T;
     /**
      * The modified entry that is going to be saved as unpublished.
      */
@@ -2023,14 +1993,6 @@ export interface CmsEntryStorageOperationsRequestChangesParams<T extends CmsStor
      * Entry that is prepared for the storageOperations, with the transformations.
      */
     storageEntry: T;
-    /**
-     * Original entry from the storage.
-     */
-    originalEntry: CmsEntry;
-    /**
-     * Original entry to be updated, directly from storage, with the transformations.
-     */
-    originalStorageEntry: T;
 }
 export interface CmsEntryStorageOperationsRequestReviewParams<T extends CmsStorageEntry = CmsStorageEntry> {
     /**
@@ -2041,14 +2003,6 @@ export interface CmsEntryStorageOperationsRequestReviewParams<T extends CmsStora
      * Entry that is prepared for the storageOperations, with the transformations.
      */
     storageEntry: T;
-    /**
-     * Original entry from the storage.
-     */
-    originalEntry: CmsEntry;
-    /**
-     * Original entry to be updated, directly from storage, with the transformations.
-     */
-    originalStorageEntry: T;
 }
 export interface CmsEntryStorageOperationsGetByIdsParams {
     ids: readonly string[];
@@ -2165,7 +2119,7 @@ export interface CmsEntryStorageOperations<T extends CmsStorageEntry = CmsStorag
     /**
      * Delete the entry.
      */
-    delete: (model: CmsModel, params: CmsEntryStorageOperationsDeleteParams<T>) => Promise<void>;
+    delete: (model: CmsModel, params: CmsEntryStorageOperationsDeleteParams) => Promise<void>;
     /**
      * Publish the entry.
      */
@@ -2198,7 +2152,6 @@ export interface CmsSettingsStorageOperationsCreateParams {
     settings: CmsSettings;
 }
 export interface CmsSettingsStorageOperationsUpdateParams {
-    original: CmsSettings;
     settings: CmsSettings;
 }
 export interface CmsSettingsStorageOperations {
@@ -2231,7 +2184,6 @@ export interface CmsSystemStorageOperationsCreateParams {
 }
 export interface CmsSystemStorageOperationsUpdateParams {
     system: CmsSystem;
-    original: CmsSystem;
 }
 export interface CmsSystemStorageOperations {
     /**
@@ -2253,11 +2205,11 @@ export interface HeadlessCmsStorageOperations {
     groups: CmsGroupStorageOperations;
     models: CmsModelStorageOperations;
     entries: CmsEntryStorageOperations;
-    init?: (cms: HeadlessCms) => Promise<void>;
     /**
-     * Plugins to be attached to the main context.
+     * Either attach something from the storage operations or run something in it.
      */
-    plugins?: Plugin[] | Plugin[][];
+    beforeInit?: (context: CmsContext) => Promise<void>;
+    init?: (context: CmsContext) => Promise<void>;
     /**
      * An upgrade to run if necessary.
      */