@webiny/api-headless-cms 0.0.0-unstable.6f45466a1d → 0.0.0-unstable.7be00a75a9

package/types/plugins.d.ts

@@ -1,279 +1,5 @@
 import type { Plugin } from "@webiny/plugins/types.js";
-import type { GraphQLSchemaDefinition } from "@webiny/handler-graphql/types.js";
-import type { CmsContext, CmsFieldTypePlugins, CmsModelFieldDefinition, CmsModelFieldToGraphQLCreateResolver, CmsModelFieldToGraphQLNormalizeInputParams, CmsModelFieldToGraphQLPluginValidateChildFields, CmsModelFieldValidatorValidateParams } from "./types.js";
-import type { GetCmsModelFieldAst } from "./modelAst.js";
-import type { CmsModelField, CmsModelFieldType } from "./modelField.js";
-import type { CmsModel } from "./model.js";
-/**
- * @category Plugin
- * @category ModelField
- * @category GraphQL
- */
-export interface CmsModelFieldToGraphQLPlugin<TField extends CmsModelField = CmsModelField> extends Plugin {
-    /**
-     * A plugin type
-     */
-    type: "cms-model-field-to-graphql";
-    /**
-     * Field type name which must be exact as the one in `CmsEditorFieldTypePlugin` plugin.
-     *
-     * ```ts
-     * fieldType: "myField"
-     * ```
-     */
-    fieldType: CmsModelFieldType;
-    /**
-     * Is the field searchable via the GraphQL?
-     *
-     * ```ts
-     * isSearchable: false
-     * ```
-     */
-    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?
-     *
-     * ```ts
-     * isSortable: true
-     * ```
-     */
-    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: Omit<TField, "storageId"> & Partial<Pick<TField, "storageId">>;
-    }) => string | null | undefined;
-    /**
-     * Read API methods.
-     */
-    read: {
-        /**
-         * Definition for get filtering for GraphQL.
-         *
-         * ```ts
-         * read: {
-         *     createGetFilters({ field }) {
-         *         return `${field.fieldId}: MyField`;
-         *     }
-         * }
-         * ```
-         */
-        createGetFilters?(params: {
-            field: TField;
-        }): string;
-        /**
-         * Definition for list filtering for GraphQL.
-         *
-         * ```ts
-         * read: {
-         *     createListFilters({ field }) {
-         *         return `
-         *             ${field.fieldId}: MyType
-         *             ${field.fieldId}_not: MyType
-         *             ${field.fieldId}_in: [MyType]
-         *             ${field.fieldId}_not_in: [MyType]
-         *         `;
-         *     }
-         * }
-         * ```
-         */
-        createListFilters?(params: {
-            model: Pick<CmsModel, "singularApiName">;
-            field: TField;
-            plugins: CmsFieldTypePlugins;
-        }): string;
-        /**
-         * Definition of the field type for GraphQL - be aware if multiple values is selected.
-         *
-         * ```ts
-         * read: {
-         *     createTypeField({ field }) {
-         *         if (field.multipleValues) {
-         *             return `${field.fieldId}: [MyFieldType]`;
-         *         }
-         *
-         *         return `${field.fieldId}: MyField`;
-         *     }
-         * }
-         * ```
-         */
-        createTypeField(params: {
-            models: CmsModel[];
-            model: CmsModel;
-            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.
-         *
-         * ```ts
-         * read: {
-         *     createResolver({ field }) {
-         *         return instance => {
-         *             return instance.values[field.storageId];
-         *         };
-         *     }
-         * }
-         * ```
-         */
-        createResolver?: CmsModelFieldToGraphQLCreateResolver<TField>;
-        /**
-         * Read API schema definitions for the field and resolvers for them.
-         *
-         * ```ts
-         * read: {
-         *     createSchema() {
-         *         return {
-         *             typeDefs: `
-         *                 myField {
-         *                     id
-         *                     date
-         *                 }
-         *             `,
-         *             resolvers: {}
-         *         }
-         *     }
-         * }
-         * ```
-         */
-        createSchema?: (params: {
-            models: CmsModel[];
-        }) => GraphQLSchemaDefinition<CmsContext>;
-    };
-    manage: {
-        /**
-         * Definition for list filtering for GraphQL.
-         *
-         * ```ts
-         * manage: {
-         *     createListFilters({ field }) {
-         *         return `
-         *             ${field.fieldId}: MyType
-         *             ${field.fieldId}_not: MyType
-         *             ${field.fieldId}_in: [MyType]
-         *             ${field.fieldId}_not_in: [MyType]
-         *         `;
-         *     }
-         * }
-         * ```
-         */
-        createListFilters?: (params: {
-            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`.
-         *
-         * ```ts
-         *     createSchema() {
-         *         return {
-         *             typeDefs: `
-         *                 myField {
-         *                     id
-         *                     date
-         *                 }
-         *             `,
-         *             resolvers: {}
-         *         }
-         *     }
-         * ```
-         */
-        createSchema?: (params: {
-            models: CmsModel[];
-        }) => GraphQLSchemaDefinition<CmsContext>;
-        /**
-         * Definition of the field type for GraphQL - be aware if multiple values is selected. Probably same as `read.createTypeField`.
-         *
-         * ```ts
-         * manage: {
-         *     createTypeField({ field }) {
-         *         if (field.multipleValues) {
-         *             return field.fieldId + ": [MyType]";
-         *         }
-         *
-         *         return field.fieldId + ": MyType";
-         *     }
-         * }
-         * ```
-         */
-        createTypeField: (params: {
-            models: CmsModel[];
-            model: CmsModel;
-            field: TField;
-            fieldTypePlugins: CmsFieldTypePlugins;
-        }) => CmsModelFieldDefinition | string | null;
-        /**
-         * Definition for input GraphQL field type.
-         *
-         * ```ts
-         * manage: {
-         *     createInputField({ field }) {
-         *         if (field.multipleValues) {
-         *             return field.fieldId + ": [MyField]";
-         *         }
-         *
-         *         return field.fieldId + ": MyField";
-         *     }
-         * }
-         * ```
-         */
-        createInputField: (params: {
-            models: CmsModel[];
-            model: CmsModel;
-            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.
-         *
-         * ```ts
-         * manage: {
-         *     createResolver({ field }) {
-         *         return instance => {
-         *             return instance.values[field.storageId];
-         *         };
-         *     }
-         * }
-         * ```
-         */
-        createResolver?: CmsModelFieldToGraphQLCreateResolver<TField>;
-        normalizeInput?: <T>(params: CmsModelFieldToGraphQLNormalizeInputParams<TField>) => Promise<T>;
-    };
-    /**
-     *
-     * @param field
-     */
-    validateChildFields?: CmsModelFieldToGraphQLPluginValidateChildFields<TField>;
-    /**
-     * Get field AST.
-     */
-    getFieldAst?: GetCmsModelFieldAst<TField>;
-}
+import type { CmsModelFieldValidatorValidateParams } from "./types.js";
 /**
  * Definition for the field validator.
  *
@@ -303,33 +29,3 @@ export interface CmsModelFieldValidatorPlugin extends Plugin {
         validate: CmsModelFieldValidatorPluginValidateCb;
     };
 }
-/**
- * A pattern validator for the content entry field value.
- *
- * @category Plugin
- * @category ModelField
- * @category FieldValidation
- */
-export interface CmsModelFieldPatternValidatorPlugin extends Plugin {
-    /**
-     * A plugin type
-     */
-    type: "cms-model-field-validator-pattern";
-    /**
-     * A pattern object for the validator.
-     */
-    pattern: {
-        /**
-         * name of the pattern.
-         */
-        name: string;
-        /**
-         * RegExp of the validator.
-         */
-        regex: string;
-        /**
-         * RegExp flags
-         */
-        flags: string;
-    };
-}

package/types/plugins.js

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

package/types/types.d.ts

@@ -1,15 +1,15 @@
 import type { Context, GenericRecord } from "@webiny/api/types.js";
-import type { GraphQLFieldResolver, GraphQLRequestBody, Resolvers } from "@webiny/handler-graphql/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 { 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 { CmsModelFieldToGraphQLPlugin } from "./plugins.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 } from "./model.js";
+import type { CmsModel, CmsModelCreateFromInput, CmsModelCreateInput, 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";
@@ -137,46 +137,6 @@ export interface CmsModelFieldDefinition {
     fields: string;
     typeDefs?: string;
 }
-export interface CmsModelFieldToGraphQLNormalizeInputParams<TField> {
-    model: CmsModel;
-    field: TField;
-    input: GenericRecord<string> | Array<GenericRecord<string>>;
-}
-interface CmsModelFieldToGraphQLCreateResolverParams<TField> {
-    models: CmsModel[];
-    model: CmsModel;
-    graphQLType: string;
-    field: TField;
-    createFieldResolvers: any;
-    fieldTypePlugins: CmsFieldTypePlugins;
-}
-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 ModelField
- */
-export interface CmsFieldTypePlugins {
-    [key: string]: CmsModelFieldToGraphQLPlugin;
-}
 /**
  * A GraphQL `params.data` parameter received when creating content model group.
  *
@@ -257,11 +217,10 @@ export interface CmsEntryValues {
 export interface ICmsEntryLocation {
     folderId?: string;
 }
-export interface IEntryState {
-    state: string;
-    workflowId: string;
-    stepId: string;
-    stepName: string;
+export interface ICmsEntryLive {
+    version: number;
+}
+export interface ICmsEntrySystem {
 }
 /**
  * A content entry definition for and from the database.
@@ -425,15 +384,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?
      */
@@ -443,7 +393,19 @@ export interface CmsEntry<TValues extends CmsEntryValues = CmsEntryValues> {
      * The value is used when restoring the entry from the trash bin.
      */
     binOriginalFolderId?: string;
-    state?: IEntryState;
+    system?: ICmsEntrySystem;
+    /**
+     * Is this CMS Entry live (no matter the revision).
+     */
+    live: ICmsEntryLive | null;
+    /**
+     * 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;
@@ -680,8 +642,9 @@ export interface CreateCmsEntryInput<TValues extends CmsEntryValues = CmsEntryVa
     location?: {
         folderId?: string | null;
     };
-    state?: Partial<IEntryState>;
+    system?: Partial<ICmsEntrySystem>;
     values: TValues | undefined;
+    expiresAt?: Date | undefined;
 }
 export interface CreateCmsEntryOptionsInput {
     skipValidators?: string[];
@@ -717,7 +680,7 @@ export interface CreateFromCmsEntryInput<TValues extends CmsEntryValues = CmsEnt
     lastPublishedOn?: Date | string;
     firstPublishedBy?: CmsIdentity;
     lastPublishedBy?: CmsIdentity;
-    state?: Partial<IEntryState>;
+    system?: Partial<ICmsEntrySystem>;
     values: TValues;
 }
 export interface CreateRevisionCmsEntryOptionsInput {
@@ -768,8 +731,9 @@ export interface UpdateCmsEntryInput<TValues extends CmsEntryValues = CmsEntryVa
     location?: {
         folderId?: string | null;
     };
-    state?: Partial<IEntryState>;
+    system?: Partial<ICmsEntrySystem>;
     values?: Partial<TValues>;
+    expiresAt?: Date | number | null | undefined;
 }
 export interface UpdateCmsEntryOptionsInput {
     skipValidators?: string[];
@@ -817,7 +781,7 @@ export interface CmsEntryValidateResponse {
  */
 interface CmsEntryResolverFactoryParams {
     model: CmsModel;
-    fieldTypePlugins: CmsFieldTypePlugins;
+    fieldRegistry: ICmsModelFieldToGraphQLRegistry;
 }
 /**
  * A type for EntryResolvers. Used when creating get, list, update, publish, ...etc.
@@ -927,10 +891,10 @@ export interface CmsModelStorageOperationsListParams {
     where: CmsModelStorageOperationsListWhereParams;
 }
 export interface CmsModelStorageOperationsCreateParams {
-    model: CmsModel;
+    model: StorageCmsModel;
 }
 export interface CmsModelStorageOperationsUpdateParams {
-    model: CmsModel;
+    model: StorageCmsModel;
 }
 export interface CmsModelStorageOperationsDeleteParams {
     model: CmsModel;
@@ -944,23 +908,23 @@ export interface CmsModelStorageOperations {
     /**
      * Gets content model by given id.
      */
-    get: (params: CmsModelStorageOperationsGetParams) => Promise<CmsModel | null>;
+    get: (params: CmsModelStorageOperationsGetParams) => Promise<StorageCmsModel | null>;
     /**
      * List all content models. Filterable via params.
      */
-    list: (params: CmsModelStorageOperationsListParams) => Promise<CmsModel[]>;
+    list: (params: CmsModelStorageOperationsListParams) => Promise<StorageCmsModel[]>;
     /**
      * Create a new content model.
      */
-    create: (params: CmsModelStorageOperationsCreateParams) => Promise<CmsModel>;
+    create: (params: CmsModelStorageOperationsCreateParams) => Promise<StorageCmsModel>;
     /**
      * Update existing content model.
      */
-    update: (params: CmsModelStorageOperationsUpdateParams) => Promise<CmsModel>;
+    update: (params: CmsModelStorageOperationsUpdateParams) => Promise<StorageCmsModel>;
     /**
      * Delete the content model.
      */
-    delete: (params: CmsModelStorageOperationsDeleteParams) => Promise<CmsModel>;
+    delete: (params: CmsModelStorageOperationsDeleteParams) => Promise<void>;
 }
 export interface CmsEntryStorageOperationsGetParams {
     where: CmsEntryListWhere;
@@ -1225,7 +1189,7 @@ export declare enum CONTENT_ENTRY_STATUS {
     PUBLISHED = "published",
     UNPUBLISHED = "unpublished"
 }
-export interface HeadlessCmsStorageOperations<C = CmsContext> {
+export interface HeadlessCmsStorageOperations<C extends CmsContext = CmsContext> {
     name: string;
     groups: CmsGroupStorageOperations;
     models: CmsModelStorageOperations;