@webiny/api-headless-cms 0.0.0-unstable.40876133bb → 0.0.0-unstable.496cf268ac

package/types.js

@@ -4,54 +4,48 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.CONTENT_ENTRY_STATUS = void 0;
-
 /**
  * @description This combines all contexts used in the CMS into a single one.
  *
  * @category Context
  */
-
 /**
  * Object containing content model field predefined options and values.
  *
  * @category CmsModelField
  */
-
 /**
  * Object containing content model field renderer options.
  *
  * @category CmsModelField
  */
-
 /**
  * A definition for content model field settings.
  *
  * @category ModelField
  * @category Database model
  */
-
 /**
  * A definition for content model field. This type exists on the app side as well.
  *
  * @category ModelField
  * @category Database model
  */
-
+/**
+ * A definition for dynamic-zone field to show possible type of the field in settings.
+ */
 /**
  * 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
  */
-
 /**
  * Definition for the field validator.
  *
@@ -59,7 +53,6 @@ exports.CONTENT_ENTRY_STATUS = void 0;
  * @category ModelField
  * @category FieldValidation
  */
-
 /**
  * A pattern validator for the content entry field value.
  *
@@ -67,7 +60,6 @@ exports.CONTENT_ENTRY_STATUS = void 0;
  * @category ModelField
  * @category FieldValidation
  */
-
 /**
  * Locked field in the content model
  *
@@ -75,30 +67,29 @@ exports.CONTENT_ENTRY_STATUS = void 0;
  *
  * @category ModelField
  */
-
 /**
- * Cms Model defining an entry.
+ * @category Database model
+ * @category CmsModel
+ */
+/**
+ * Base CMS Model. Should not be exported and used outside of this package.
  *
  * @category Database model
  * @category CmsModel
  */
-
 /**
  * When sending model to the storage operations, it must contain createValueKeyToStorageConverter and createValueKeyFromStorageConverter
  *
  * @category CmsModel
  */
-
 /**
  * @category ModelField
  */
-
 /**
  * @category Plugin
  * @category ModelField
  * @category GraphQL
  */
-
 /**
  * Check for content model locked field.
  * A custom plugin definable by the user.
@@ -106,115 +97,108 @@ exports.CONTENT_ENTRY_STATUS = void 0;
  * @category CmsModel
  * @category Plugin
  */
-
 /**
  * @category ModelField
  */
-
 /**
- * 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
  */
-
 /**
  * Representation of settings database model.
  *
  * @category Database model
  */
-
 /**
  * Settings CRUD in context.
  *
  * @category Context
  */
-
 /**
- * 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
  */
-
 /**
- * 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
  */
-
 /**
  * A representation of content model group in the database.
  *
  * @category CmsGroup
  * @category Database model
  */
-
 /**
- * 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
  */
-
 /**
  * @category CmsGroup
  * @category Topic
  */
-
 /**
  * @category CmsGroup
  * @category Topic
  */
-
 /**
  * @category CmsGroup
  * @category Topic
  */
-
 /**
  * @category CmsGroup
  * @category Topic
  */
-
 /**
  * @category CmsGroup
  * @category Topic
  */
-
 /**
  * @category CmsGroup
  * @category Topic
  */
-
+/**
+ * @category CmsGroup
+ * @category Topic
+ */
+/**
+ * @category CmsGroup
+ * @category Topic
+ */
+/**
+ * @category CmsGroup
+ * @category Topic
+ */
 /**
  * Cms Group in context.
  *
  * @category Context
  * @category CmsGroup
  */
-
 /**
  * Definition for content model field validator.
  *
  * @category ModelField
  * @category FieldValidation
  */
-
 /**
- * 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
  */
-
 /**
- * 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
  */
-
 /**
  * A definition for content model field received from the user.
  *
@@ -224,14 +208,12 @@ exports.CONTENT_ENTRY_STATUS = void 0;
  * @category GraphQL params
  * @category ModelField
  */
-
 /**
- * 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
  */
-
 /**
  * A plugin to load a CmsModelManager.
  *
@@ -241,21 +223,18 @@ exports.CONTENT_ENTRY_STATUS = void 0;
  * @category CmsModel
  * @category CmsEntry
  */
-
 /**
  * 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
  */
-
 /**
  * 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.
@@ -266,137 +245,152 @@ exports.CONTENT_ENTRY_STATUS = void 0;
  * @category CmsEntry
  * @category CmsModel
  */
-
+/**
+ * Create
+ */
+/**
+ * Create From / Clone
+ */
+/**
+ * Update
+ */
+/**
+ * Delete
+ */
+/**
+ * Initialize
+ */
+/**
+ *
+ */
 /**
  * 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
  */
-
+/**
+ * Create
+ */
+/**
+ * Revision Create
+ */
+/**
+ * Update
+ */
+/**
+ * Publish
+ */
+/**
+ * Republish
+ */
+/**
+ * Unpublish
+ */
 /**
  * @category Context
  * @category CmsEntry
  */
-
 /**
  * @category Context
  * @category CmsEntry
  */
-
 /**
  * @category Context
  * @category CmsEntry
  */
-
 /**
  * Cms Entry CRUD methods in the context.
  *
  * @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
  */
-
 /**
  * Settings security permission.
  *
  * @category SecurityPermission
  */
 // eslint-disable-line
-
 /**
  * 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.
@@ -408,7 +402,6 @@ exports.CONTENT_ENTRY_STATUS = void 0;
  */
 let CONTENT_ENTRY_STATUS;
 exports.CONTENT_ENTRY_STATUS = CONTENT_ENTRY_STATUS;
-
 (function (CONTENT_ENTRY_STATUS) {
   CONTENT_ENTRY_STATUS["DRAFT"] = "draft";
   CONTENT_ENTRY_STATUS["PUBLISHED"] = "published";