@webiny/api-headless-cms 0.0.0-unstable.e6f0dc8ca7 → 0.0.0-unstable.eb81deee7e

package/types/modelField.d.ts

@@ -1,9 +1,10 @@
 import type { CmsModel, CmsModelLayout } from "./model.js";
 import type { GenericRecord } from "@webiny/api/types.js";
 import type { CmsDynamicZoneTemplate } from "../types/fields/dynamicZoneField.js";
+import type { IModelSettings } from "../features/modelBuilder/abstractions.js";
 export type FieldRuleAction = "hide" | "disable" | string;
 export interface FieldRule {
-    type: "accessControl" | "entryValue";
+    type: "accessControl" | "condition";
     target: string;
     operator: string;
     value: string | number | boolean | null;
@@ -97,6 +98,13 @@ export interface CmsModelField {
      *
      */
     list?: boolean;
+    /**
+     * Renders the field in the admin app, but doesn't let anyone edit its value.
+     *
+     * This only affects the admin app. The API doesn't check it, so a disabled field
+     * can still be written to over GraphQL.
+     */
+    disabled?: boolean;
     /**
      * Fields can be tagged to give them contextual meaning.
      */
@@ -163,6 +171,10 @@ export interface CmsModelFieldInput {
      * Are multiple values allowed?
      */
     list?: boolean;
+    /**
+     * @see CmsModelField.disabled
+     */
+    disabled?: boolean;
     /**
      * Predefined values options for the field. Check the reference for more information.
      */
@@ -242,6 +254,7 @@ export interface CmsModelUpdateInput {
     titleFieldId?: string | null;
     descriptionFieldId?: string | null;
     imageFieldId?: string | null;
+    settings?: IModelSettings | null;
 }
 /**
  * Object containing content model field renderer options.

package/types/modelField.js

@@ -1,3 +0,0 @@
-export {};
-
-//# sourceMappingURL=modelField.js.map

package/types/modelGroup.js

@@ -1,3 +0,0 @@
-export {};
-
-//# sourceMappingURL=modelGroup.js.map

package/types/plugins.js

@@ -1,3 +0,0 @@
-export {};
-
-//# sourceMappingURL=plugins.js.map

package/types/types.d.ts

@@ -1,18 +1,11 @@
 import type { Context, GenericRecord } from "@webiny/api/types.js";
-import type { GraphQLFieldResolver, GraphQLRequestBody } from "@webiny/handler-graphql/types.js";
-import type { processRequestBody } from "@webiny/handler-graphql";
-import type { DbContext } from "@webiny/handler-db/types.js";
+import type { GraphQLFieldResolver } from "@webiny/api-graphql/types.js";
 import type { CmsModelConverterCallable } from "../utils/converters/ConverterCollection.js";
-import type { HeadlessCmsExport, HeadlessCmsImport } from "../export/types.js";
-import type { AccessControl } from "../crud/AccessControl/AccessControl.js";
-import type { CmsModelToAstConverter } from "../utils/contentModelAst/CmsModelToAstConverter.js";
 import type { ICmsModelFieldToGraphQLRegistry } from "../features/graphql/fields/abstractions/CmsModelFieldToGraphQLRegistry.js";
-import type { CmsEntryContext } from "./context.js";
-import type { CmsModelField, CmsModelFieldValidation, CmsModelUpdateInput } from "./modelField.js";
-import type { CmsModel, CmsModelCreateFromInput, CmsModelCreateInput, StorageCmsModel } from "./model.js";
+import type { CmsModelField, CmsModelFieldValidation } from "./modelField.js";
+import type { CmsModel, StorageCmsModel } from "./model.js";
 import type { CmsGroup } from "./modelGroup.js";
 import type { CmsIdentity } from "./identity.js";
-import type { ApiCoreContext } from "@webiny/api-core/types/core.js";
 import type { SecurityPermission } from "@webiny/api-core/types/security.js";
 import type { DateStringInterfaceGenerator, IdentityInterfaceGenerator, IdInterfaceGenerator, IdMixedInterfaceGenerator, NumericInterfaceGenerator, TruthfulInterfaceGenerator } from "@webiny/api";
 export type CmsIcon = {
@@ -27,47 +20,15 @@ export interface CmsError {
     stack?: string;
 }
 export type ApiEndpoint = "manage" | "preview" | "read";
-export interface HeadlessCms extends CmsGroupContext, CmsModelContext, CmsEntryContext {
-    /**
-     * API type
-     */
-    type: ApiEndpoint | null;
-    /**
-     * Means this request is a READ API
-     */
-    READ: boolean;
-    /**
-     * Means this request is a MANAGE API
-     */
-    MANAGE: boolean;
-    /**
-     * Means this request is a PREVIEW API
-     */
-    PREVIEW: boolean;
-    /**
-     * The storage operations loaded for current context.
-     */
-    storageOperations: HeadlessCmsStorageOperations;
-    /**
-     * Use to ensure perform authorization and ensure identities have access to the groups, models and entries.
-     */
-    accessControl: AccessControl;
-    /**
-     * Export operations.
-     */
-    export: HeadlessCmsExport;
-    importing: HeadlessCmsImport;
-    getExecutableSchema: GetExecutableSchema;
-}
-export type GetExecutableSchema = (type: ApiEndpoint) => Promise<(<TData = Record<string, any>, TExtensions = Record<string, any>>(input: GraphQLRequestBody | GraphQLRequestBody[]) => ReturnType<typeof processRequestBody<TData, TExtensions>>)>;
 /**
- * @description This combines all contexts used in the CMS into a single one.
+ * The CMS request context. Services are resolved from the DI container
+ * (`context.container.resolve(...)`). ApiCoreContext aliases the base Context
+ * and DbContext only adds an unused `db`, so the historical
+ * `Context & DbContext & ApiCoreContext` merge collapses to the base Context.
  *
  * @category Context
  */
-export interface CmsContext extends Context, DbContext, ApiCoreContext {
-    cms: HeadlessCms;
-}
+export type CmsContext = Context;
 /**
  * Used for our internal functionality.
  */
@@ -173,38 +134,6 @@ export interface CmsGroupListParams {
         tenant: string;
     };
 }
-/**
- * Cms Group in context.
- *
- * @category Context
- * @category CmsGroup
- */
-export interface CmsGroupContext {
-    /**
-     * Gets content model group by given id.
-     */
-    getGroup: (id: string) => Promise<CmsGroup>;
-    /**
-     * List all content model groups. Filterable via params.
-     */
-    listGroups: (params?: CmsGroupListParams) => Promise<CmsGroup[]>;
-    /**
-     * Create a new content model group.
-     */
-    createGroup: (data: CmsGroupCreateInput) => Promise<CmsGroup>;
-    /**
-     * Update existing content model group.
-     */
-    updateGroup: (id: string, data: CmsGroupUpdateInput) => Promise<CmsGroup>;
-    /**
-     * Delete content model group by given id.
-     */
-    deleteGroup: (id: string) => Promise<boolean>;
-    /**
-     * Clear the cached groups.
-     */
-    clearGroupsCache: () => void;
-}
 /**
  * A content entry values definition for and from the database.
  *
@@ -384,15 +313,6 @@ export interface CmsEntry<TValues extends CmsEntryValues = CmsEntryValues> {
      * Advanced Content Organization
      */
     location?: ICmsEntryLocation;
-    /**
-     * Settings for the given entry.
-     *
-     * 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.
-     */
-    meta?: GenericRecord;
     /**
      * Is the entry in the bin?
      */
@@ -411,6 +331,10 @@ export interface CmsEntry<TValues extends CmsEntryValues = CmsEntryValues> {
      * A revision description.
      */
     revisionDescription: string | undefined;
+    /**
+     * A timestamp of when the entry should be automatically deleted from the database.
+     */
+    expiresAt: number | null;
 }
 export interface CmsStorageEntry<T extends CmsEntryValues = CmsEntryValues> extends CmsEntry<T> {
     [key: string]: any;
@@ -426,48 +350,6 @@ export interface ICmsModelListParams {
     includePrivate?: boolean;
     includePlugins?: boolean;
 }
-/**
- * Cms Model in the context.
- *
- * @category Context
- * @category CmsModel
- */
-export interface CmsModelContext {
-    /**
-     * Get a single content model.
-     *
-     * @throws NotFoundError
-     */
-    getModel(modelId: string): Promise<CmsModel>;
-    /**
-     * Get model to AST converter.
-     */
-    getModelToAstConverter: () => CmsModelToAstConverter;
-    /**
-     * Get all content models.
-     */
-    listModels(params?: ICmsModelListParams): Promise<CmsModel[]>;
-    /**
-     * Create a content model.
-     */
-    createModel(data: CmsModelCreateInput): Promise<CmsModel>;
-    /**
-     * Create a content model from the given model - clone.
-     */
-    createModelFrom(modelId: string, data: CmsModelCreateFromInput): Promise<CmsModel>;
-    /**
-     * Update content model.
-     */
-    updateModel(modelId: string, data: CmsModelUpdateInput): Promise<CmsModel>;
-    /**
-     * Delete content model. Should not allow deletion if there are entries connected to it.
-     */
-    deleteModel(modelId: string): Promise<void>;
-    /**
-     * Clear all the model caches.
-     */
-    clearModelsCache(): void;
-}
 /**
  * Available statuses for content entry.
  *
@@ -649,9 +531,10 @@ export interface CreateCmsEntryInput<TValues extends CmsEntryValues = CmsEntryVa
     };
     system?: Partial<ICmsEntrySystem>;
     values: TValues | undefined;
+    expiresAt?: Date | undefined;
 }
 export interface CreateCmsEntryOptionsInput {
-    skipValidators?: string[];
+    skipValidation?: boolean;
 }
 /**
  * @category Context
@@ -688,7 +571,7 @@ export interface CreateFromCmsEntryInput<TValues extends CmsEntryValues = CmsEnt
     values: TValues;
 }
 export interface CreateRevisionCmsEntryOptionsInput {
-    skipValidators?: string[];
+    skipValidation?: boolean;
 }
 /**
  * @category Context
@@ -737,9 +620,10 @@ export interface UpdateCmsEntryInput<TValues extends CmsEntryValues = CmsEntryVa
     };
     system?: Partial<ICmsEntrySystem>;
     values?: Partial<TValues>;
+    expiresAt?: Date | number | null | undefined;
 }
 export interface UpdateCmsEntryOptionsInput {
-    skipValidators?: string[];
+    skipValidation?: boolean;
 }
 /**
  * @category Context
@@ -855,33 +739,6 @@ export interface CmsGroupStorageOperationsUpdateParams {
 export interface CmsGroupStorageOperationsDeleteParams {
     group: CmsGroup;
 }
-/**
- * Description of the CmsGroup CRUD operations.
- * If user wants to add another database to the application, this is how it is done.
- * This is just plain read, update, write, delete and list - no authentication or permission checks.
- */
-export interface CmsGroupStorageOperations {
-    /**
-     * Gets content model group by given id.
-     */
-    get: (params: CmsGroupStorageOperationsGetParams) => Promise<CmsGroup | null>;
-    /**
-     * List all content model groups. Filterable via params.
-     */
-    list: (params: CmsGroupStorageOperationsListParams) => Promise<CmsGroup[]>;
-    /**
-     * Create a new content model group.
-     */
-    create: (params: CmsGroupStorageOperationsCreateParams) => Promise<void>;
-    /**
-     * Update existing content model group.
-     */
-    update: (params: CmsGroupStorageOperationsUpdateParams) => Promise<void>;
-    /**
-     * Delete the content model group.
-     */
-    delete: (params: CmsGroupStorageOperationsDeleteParams) => Promise<void>;
-}
 export interface CmsModelStorageOperationsGetParams {
     tenant: string;
     modelId: string;
@@ -902,33 +759,6 @@ export interface CmsModelStorageOperationsUpdateParams {
 export interface CmsModelStorageOperationsDeleteParams {
     model: CmsModel;
 }
-/**
- * Description of the CmsModel storage operations.
- * If user wants to add another database to the application, this is how it is done.
- * This is just plain read, update, write, delete and list - no authentication or permission checks.
- */
-export interface CmsModelStorageOperations {
-    /**
-     * Gets content model by given id.
-     */
-    get: (params: CmsModelStorageOperationsGetParams) => Promise<StorageCmsModel | null>;
-    /**
-     * List all content models. Filterable via params.
-     */
-    list: (params: CmsModelStorageOperationsListParams) => Promise<StorageCmsModel[]>;
-    /**
-     * Create a new content model.
-     */
-    create: (params: CmsModelStorageOperationsCreateParams) => Promise<StorageCmsModel>;
-    /**
-     * Update existing content model.
-     */
-    update: (params: CmsModelStorageOperationsUpdateParams) => Promise<StorageCmsModel>;
-    /**
-     * Delete the content model.
-     */
-    delete: (params: CmsModelStorageOperationsDeleteParams) => Promise<void>;
-}
 export interface CmsEntryStorageOperationsGetParams {
     where: CmsEntryListWhere;
     sort?: CmsEntryListSort;
@@ -1086,121 +916,9 @@ export interface CmsEntryStorageOperationsListResponse<T extends CmsStorageEntry
      */
     totalCount: number;
 }
-/**
- * Description of the CmsModel storage operations.
- * If user wants to add another database to the application, this is how it is done.
- * This is just plain read, update, write, delete and list - no authentication or permission checks.
- *
- *
- * @category StorageOperations
- * @category CmsEntry
- */
-export interface CmsEntryStorageOperations {
-    /**
-     * Get all the entries of the ids.
-     */
-    getByIds: <T extends CmsEntryValues = CmsEntryValues>(model: CmsModel, params: CmsEntryStorageOperationsGetByIdsParams) => Promise<CmsEntry<T>[]>;
-    /**
-     * Get all the published entries of the ids.
-     */
-    getPublishedByIds: <T extends CmsEntryValues = CmsEntryValues>(model: CmsModel, params: CmsEntryStorageOperationsGetPublishedByIdsParams) => Promise<CmsEntry<T>[]>;
-    /**
-     * Get all the latest entries of the ids.
-     */
-    getLatestByIds: <T extends CmsEntryValues = CmsEntryValues>(model: CmsModel, params: CmsEntryStorageOperationsGetLatestByIdsParams) => Promise<CmsEntry<T>[]>;
-    /**
-     * Get all revisions of the given entry id.
-     */
-    getRevisions: <T extends CmsEntryValues = CmsEntryValues>(model: CmsModel, params: CmsEntryStorageOperationsGetRevisionsParams) => Promise<CmsEntry<T>[]>;
-    /**
-     * Get the entry by the given revision id.
-     */
-    getRevisionById: <T extends CmsEntryValues = CmsEntryValues>(model: CmsModel, params: CmsEntryStorageOperationsGetRevisionParams) => Promise<CmsEntry<T> | null>;
-    /**
-     * Get the published entry by given entryId.
-     */
-    getPublishedRevisionByEntryId: <T extends CmsEntryValues = CmsEntryValues>(model: CmsModel, params: CmsEntryStorageOperationsGetPublishedRevisionParams) => Promise<CmsEntry<T> | null>;
-    /**
-     * Get the latest entry by given entryId.
-     */
-    getLatestRevisionByEntryId: <T extends CmsEntryValues = CmsEntryValues>(model: CmsModel, params: CmsEntryStorageOperationsGetLatestRevisionParams) => Promise<CmsEntry<T> | null>;
-    /**
-     * Get the revision of the entry before given one.
-     */
-    getPreviousRevision: <T extends CmsEntryValues = CmsEntryValues>(model: CmsModel, params: CmsEntryStorageOperationsGetPreviousRevisionParams) => Promise<CmsEntry<T> | null>;
-    /**
-     * Gets entry by given params.
-     */
-    get: <T extends CmsEntryValues = CmsEntryValues>(model: CmsModel, params: CmsEntryStorageOperationsGetParams) => Promise<CmsEntry<T> | null>;
-    /**
-     * List all entries. Filterable via params.
-     */
-    list: <T extends CmsEntryValues = CmsEntryValues>(model: CmsModel, params: CmsEntryStorageOperationsListParams) => Promise<CmsEntryStorageOperationsListResponse<CmsEntry<T>>>;
-    /**
-     * Create a new entry.
-     */
-    create: <T extends CmsEntryValues = CmsEntryValues>(model: CmsModel, params: CmsEntryStorageOperationsCreateParams<T>) => Promise<CmsEntry<T>>;
-    /**
-     * Create a new entry from existing one.
-     */
-    createRevisionFrom: <T extends CmsEntryValues = CmsEntryValues>(model: CmsModel, params: CmsEntryStorageOperationsCreateRevisionFromParams<T>) => Promise<CmsEntry<T>>;
-    /**
-     * Update existing entry.
-     */
-    update: <T extends CmsEntryValues = CmsEntryValues>(model: CmsModel, params: CmsEntryStorageOperationsUpdateParams<T>) => Promise<CmsEntry<T>>;
-    /**
-     * Move entry and all its entries into a new folder.
-     */
-    move: (model: CmsModel, id: string, folderId: string) => Promise<void>;
-    /**
-     * Delete the entry revision.
-     */
-    deleteRevision: <T extends CmsEntryValues = CmsEntryValues>(model: CmsModel, params: CmsEntryStorageOperationsDeleteRevisionParams<T>) => Promise<void>;
-    /**
-     * Delete the entry.
-     */
-    delete: (model: CmsModel, params: CmsEntryStorageOperationsDeleteParams) => Promise<void>;
-    /**
-     * Move the entry to bin.
-     */
-    moveToBin: (model: CmsModel, params: CmsEntryStorageOperationsMoveToBinParams) => Promise<void>;
-    /**
-     * Restore the entry from the bin.
-     */
-    restoreFromBin: <T extends CmsEntryValues = CmsEntryValues>(model: CmsModel, params: CmsEntryStorageOperationsRestoreFromBinParams<T>) => Promise<CmsEntry<T>>;
-    /**
-     * 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: <T extends CmsEntryValues = CmsEntryValues>(model: CmsModel, params: CmsEntryStorageOperationsPublishParams<T>) => Promise<CmsEntry<T>>;
-    /**
-     * Unpublish the entry.
-     */
-    unpublish: <T extends CmsEntryValues = CmsEntryValues>(model: CmsModel, params: CmsEntryStorageOperationsUnpublishParams<T>) => Promise<CmsEntry<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",
     PUBLISHED = "published",
     UNPUBLISHED = "unpublished"
 }
-export interface HeadlessCmsStorageOperations<C extends CmsContext = CmsContext> {
-    name: string;
-    groups: CmsGroupStorageOperations;
-    models: CmsModelStorageOperations;
-    entries: CmsEntryStorageOperations;
-    /**
-     * Either attach something from the storage operations or run something in it.
-     */
-    beforeInit: (context: C) => Promise<void>;
-    init?: (context: C) => Promise<void>;
-}
 export {};

package/types/types.js

@@ -1,221 +1,9 @@
-/**
- * @description This combines all contexts used in the CMS into a single one.
- *
- * @category Context
- */
-
-/**
- * Used for our internal functionality.
- */
-
-/**
- * A definition for dateTime field to show possible type of the field in settings.
- */
-
-/**
- * Arguments for the field validator validate method.
- *
- * @category ModelField
- * @category FieldValidation
- */
-
-/**
- * When sending model to the storage operations, it must contain createValueKeyToStorageConverter and createValueKeyFromStorageConverter
- *
- * @category CmsModel
- */
-
-/**
- * @category ModelField
- */
-
-/**
- * A GraphQL `params.data` parameter received when creating content model group.
- *
- * @category CmsGroup
- * @category GraphQL params
- */
-
-/**
- * A GraphQL `params.data` parameter received when updating content model group.
- *
- * @category CmsGroup
- * @category GraphQL params
- */
-
-/**
- * A `data.where` parameter received when listing content model groups.
- *
- * @category CmsGroup
- * @category GraphQL params
- */
-
-/**
- * Cms Group in context.
- *
- * @category Context
- * @category CmsGroup
- */
-
-/**
- * A content entry values definition for and from the database.
- *
- * @category Database model
- * @category CmsEntry
- */
-
-/**
- * A content entry definition for and from the database.
- *
- * @category Database model
- * @category CmsEntry
- */
-
-/**
- * Cms Model in the context.
- *
- * @category Context
- * @category CmsModel
- */
-
-/**
- * Available statuses for content entry.
- *
- * @category CmsEntry
- */
-
-/**
- * Entry listing where params.
- *
- * @category CmsEntry
- * @category GraphQL params
- */
-
-/**
- * Entry listing sort.
- *
- * @category CmsEntry
- * @category GraphQL params
- */
-
-/**
- * Get entry GraphQL resolver params.
- *
- * @category CmsEntry
- * @category GraphQL params
- */
-
-/**
- * List entries GraphQL resolver params.
- *
- * @category CmsEntry
- * @category GraphQL params
- */
-
-/**
- * Meta information for GraphQL output.
- *
- * @category CmsEntry
- * @category GraphQL output
- */
-
-/**
- * @category Context
- * @category CmsEntry
- */
-
-/**
- * @category Context
- * @category CmsEntry
- */
-
-/**
- * @category Context
- * @category CmsEntry
- */
-
-/**
- * @category Context
- * @category CmsEntry
- */
-
-/**
- * @category CmsEntry
- */
-
-/**
- * @category Context
- * @category CmsEntry
- */
-
-/**
- * Parameters for CmsEntryResolverFactory.
- *
- * @category GraphQL resolver
- * @category CmsEntry
- */
-
-/**
- * A type for EntryResolvers. Used when creating get, list, update, publish, ...etc.
- *
- * @category GraphQL resolver
- * @category CmsEntry
- */
-
-/**
- * A base security permission for CMS.
- *
- * @category SecurityPermission
- */
-
-/**
- * A security permission for content model.
- *
- * @category SecurityPermission
- * @category CmsModel
- */
-
-/**
- * The security permission for content model groups.
- *
- * @category SecurityPermission
- * @category CmsGroup
- */
-
-/**
- * The security permission for content entry.
- *
- * @category SecurityPermission
- * @category CmsEntry
- */
-
-/**
- * Description of the CmsGroup CRUD operations.
- * If user wants to add another database to the application, this is how it is done.
- * This is just plain read, update, write, delete and list - no authentication or permission checks.
- */
-
-/**
- * Description of the CmsModel storage operations.
- * If user wants to add another database to the application, this is how it is done.
- * This is just plain read, update, write, delete and list - no authentication or permission checks.
- */
-
-/**
- * Description of the CmsModel storage operations.
- * If user wants to add another database to the application, this is how it is done.
- * This is just plain read, update, write, delete and list - no authentication or permission checks.
- *
- *
- * @category StorageOperations
- * @category CmsEntry
- */
-
-export let CONTENT_ENTRY_STATUS = /*#__PURE__*/function (CONTENT_ENTRY_STATUS) {
-  CONTENT_ENTRY_STATUS["DRAFT"] = "draft";
-  CONTENT_ENTRY_STATUS["PUBLISHED"] = "published";
-  CONTENT_ENTRY_STATUS["UNPUBLISHED"] = "unpublished";
-  return CONTENT_ENTRY_STATUS;
+var types_CONTENT_ENTRY_STATUS = /*#__PURE__*/ function(CONTENT_ENTRY_STATUS) {
+    CONTENT_ENTRY_STATUS["DRAFT"] = "draft";
+    CONTENT_ENTRY_STATUS["PUBLISHED"] = "published";
+    CONTENT_ENTRY_STATUS["UNPUBLISHED"] = "unpublished";
+    return CONTENT_ENTRY_STATUS;
 }({});
+export { types_CONTENT_ENTRY_STATUS as CONTENT_ENTRY_STATUS };
 
 //# sourceMappingURL=types.js.map