@webiny/api-headless-cms 0.0.0-unstable.c2780f51fe → 0.0.0-unstable.c7dec08bb0

package/types.d.ts

@@ -4,7 +4,6 @@ import { Context } from "@webiny/api/types";
 import { GraphQLFieldResolver, GraphQLSchemaDefinition, Resolvers } from "@webiny/handler-graphql/types";
 import { SecurityPermission } from "@webiny/api-security/types";
 import { DbContext } from "@webiny/handler-db/types";
-import { FileManagerContext } from "@webiny/api-file-manager/types";
 import { Topic } from "@webiny/pubsub/types";
 import { CmsModelConverterCallable } from "./utils/converters/ConverterCollection";
 export declare type ApiEndpoint = "manage" | "preview" | "read";
@@ -43,7 +42,7 @@ export interface HeadlessCms extends CmsSettingsContext, CmsSystemContext, CmsGr
  *
  * @category Context
  */
-export interface CmsContext extends Context, DbContext, I18NContext, FileManagerContext {
+export interface CmsContext extends Context, DbContext, I18NContext {
     cms: HeadlessCms;
 }
 interface CmsModelFieldPredefinedValuesValue {
@@ -118,6 +117,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.
  *
@@ -138,7 +138,7 @@ 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" | "dynamicZone" | string;
+    type: CmsModelFieldType;
     /**
      * A unique storage ID for storing actual values.
      * Must in form of a-zA-Z0-9@a-zA-Z0-9
@@ -513,6 +513,7 @@ interface CmsModelFieldToGraphQLCreateResolverParams<TField> {
     graphQLType: string;
     field: TField;
     createFieldResolvers: any;
+    fieldTypePlugins: CmsFieldTypePlugins;
 }
 export interface CmsModelFieldToGraphQLCreateResolver<TField = CmsModelField> {
     (params: CmsModelFieldToGraphQLCreateResolverParams<TField>): GraphQLFieldResolver | {
@@ -594,7 +595,7 @@ export interface CmsModelFieldToGraphQLPlugin<TField extends CmsModelField = Cms
      */
     createStorageId?: (params: {
         model: CmsModel;
-        field: TField;
+        field: Omit<TField, "storageId"> & Partial<Pick<TField, "storageId">>;
     }) => string | null | undefined;
     /**
      * Read API methods.
@@ -612,7 +613,6 @@ export interface CmsModelFieldToGraphQLPlugin<TField extends CmsModelField = Cms
          * ```
          */
         createGetFilters?(params: {
-            model: CmsModel;
             field: TField;
         }): string;
         /**
@@ -632,7 +632,7 @@ export interface CmsModelFieldToGraphQLPlugin<TField extends CmsModelField = Cms
          * ```
          */
         createListFilters?(params: {
-            model: CmsModel;
+            model: Pick<CmsModel, "singularApiName">;
             field: TField;
             plugins: CmsFieldTypePlugins;
         }): string;
@@ -713,7 +713,7 @@ export interface CmsModelFieldToGraphQLPlugin<TField extends CmsModelField = Cms
          * ```
          */
         createListFilters?: (params: {
-            model: CmsModel;
+            model: Pick<CmsModel, "singularApiName">;
             field: TField;
             plugins: CmsFieldTypePlugins;
         }) => string;
@@ -1478,6 +1478,12 @@ export interface CmsEntry<T = CmsEntryValues> {
      * @see CmsModelField
      */
     values: T;
+    /**
+     * Advanced Content Organization
+     */
+    location?: {
+        folderId?: string | null;
+    };
     /**
      * Settings for the given entry.
      *
@@ -1493,6 +1499,10 @@ export interface CmsEntry<T = CmsEntryValues> {
 export interface CmsStorageEntry extends CmsEntry {
     [key: string]: any;
 }
+export interface CmsEntryUniqueValue {
+    value: string;
+    count: number;
+}
 /**
  * A definition for content model manager to be used in the code.
  * The default one uses `CmsEntryContext` methods internally, but devs can change to what every they want.
@@ -1935,7 +1945,7 @@ export interface OnEntryAfterUpdateTopicParams {
 }
 export interface OnEntryUpdateErrorTopicParams {
     error: Error;
-    input: CreateFromCmsEntryInput;
+    input: UpdateCmsEntryInput;
     entry: CmsEntry;
     model: CmsModel;
 }
@@ -2016,6 +2026,22 @@ export interface OnEntryRevisionDeleteErrorTopicParams {
     entry: CmsEntry;
     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: CmsModel;
     where: CmsEntryListWhere;
@@ -2030,6 +2056,9 @@ export interface EntryBeforeListTopicParams {
  */
 export interface CreateCmsEntryInput {
     id?: string;
+    wbyAco_location?: {
+        folderId?: string | null;
+    };
     [key: string]: any;
 }
 /**
@@ -2044,8 +2073,39 @@ export interface CreateFromCmsEntryInput {
  * @category CmsEntry
  */
 export interface UpdateCmsEntryInput {
+    wbyAco_location?: {
+        folderId?: string | null;
+    };
     [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.
  *
@@ -2056,7 +2116,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).
      */
@@ -2068,15 +2128,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 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.
      */
@@ -2109,7 +2169,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.
      */
@@ -2123,7 +2187,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<CmsEntryUniqueValue[]>;
+    /**
+     * Lifecycle events - deprecated.
      */
     /**
      * @deprecated
@@ -2469,11 +2539,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.
@@ -2495,6 +2565,10 @@ export interface CmsEntryStorageOperationsUnpublishParams<T extends CmsStorageEn
      */
     storageEntry: T;
 }
+export interface CmsEntryStorageOperationsGetUniqueFieldValuesParams {
+    where: CmsEntryListWhere;
+    fieldId: string;
+}
 export interface CmsEntryStorageOperationsGetByIdsParams {
     ids: readonly string[];
 }
@@ -2608,6 +2682,10 @@ export interface CmsEntryStorageOperations<T extends CmsStorageEntry = CmsStorag
      * Delete the entry.
      */
     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.
      */
@@ -2616,6 +2694,12 @@ export interface CmsEntryStorageOperations<T extends CmsStorageEntry = CmsStorag
      * Unpublish the entry.
      */
     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<CmsEntryUniqueValue[]>;
 }
 export declare enum CONTENT_ENTRY_STATUS {
     DRAFT = "draft",

package/types.js

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