@webiny/api-headless-cms 6.3.0 → 6.4.0-beta.1

package/plugins/CmsParametersPlugin.js

@@ -1,18 +1,16 @@
 import { Plugin } from "@webiny/plugins";
-
-/**
- * Type can be null because it might be that Headless CMS context is loaded on a different Lambda where there is no GraphQL Schema generated.
- */
-
-export class CmsParametersPlugin extends Plugin {
-  static type = "cms-parameters-plugin";
-  constructor(callable) {
-    super();
-    this.callable = callable;
-  }
-  async getParameters(context) {
-    return this.callable(context);
-  }
+class CmsParametersPlugin extends Plugin {
+    static{
+        this.type = "cms-parameters-plugin";
+    }
+    constructor(callable){
+        super();
+        this.callable = callable;
+    }
+    async getParameters(context) {
+        return this.callable(context);
+    }
 }
+export { CmsParametersPlugin };
 
 //# sourceMappingURL=CmsParametersPlugin.js.map

package/plugins/CmsParametersPlugin.js.map

@@ -1 +1 @@
-{"version":3,"names":["Plugin","CmsParametersPlugin","type","constructor","callable","getParameters","context"],"sources":["CmsParametersPlugin.ts"],"sourcesContent":["import { Plugin } from \"@webiny/plugins\";\nimport type { ApiEndpoint, CmsContext } from \"~/types/index.js\";\n\n/**\n * Type can be null because it might be that Headless CMS context is loaded on a different Lambda where there is no GraphQL Schema generated.\n */\nexport type CmsParametersPluginResponseType = ApiEndpoint | null;\n\nexport interface CmsParametersPluginResponse {\n    type: CmsParametersPluginResponseType;\n}\n\nexport interface CmsParametersPluginCallable {\n    (context: CmsContext): Promise<CmsParametersPluginResponse | null>;\n}\n\nexport class CmsParametersPlugin extends Plugin {\n    public static override readonly type: string = \"cms-parameters-plugin\";\n\n    private readonly callable: CmsParametersPluginCallable;\n\n    public constructor(callable: CmsParametersPluginCallable) {\n        super();\n\n        this.callable = callable;\n    }\n\n    public async getParameters(context: CmsContext): Promise<CmsParametersPluginResponse | null> {\n        return this.callable(context);\n    }\n}\n"],"mappings":"AAAA,SAASA,MAAM,QAAQ,iBAAiB;;AAGxC;AACA;AACA;;AAWA,OAAO,MAAMC,mBAAmB,SAASD,MAAM,CAAC;EAC5C,OAAgCE,IAAI,GAAW,uBAAuB;EAI/DC,WAAWA,CAACC,QAAqC,EAAE;IACtD,KAAK,CAAC,CAAC;IAEP,IAAI,CAACA,QAAQ,GAAGA,QAAQ;EAC5B;EAEA,MAAaC,aAAaA,CAACC,OAAmB,EAA+C;IACzF,OAAO,IAAI,CAACF,QAAQ,CAACE,OAAO,CAAC;EACjC;AACJ","ignoreList":[]}
+{"version":3,"file":"plugins/CmsParametersPlugin.js","sources":["../../src/plugins/CmsParametersPlugin.ts"],"sourcesContent":["import { Plugin } from \"@webiny/plugins\";\nimport type { ApiEndpoint, CmsContext } from \"~/types/index.js\";\n\n/**\n * Type can be null because it might be that Headless CMS context is loaded on a different Lambda where there is no GraphQL Schema generated.\n */\nexport type CmsParametersPluginResponseType = ApiEndpoint | null;\n\nexport interface CmsParametersPluginResponse {\n    type: CmsParametersPluginResponseType;\n}\n\nexport interface CmsParametersPluginCallable {\n    (context: CmsContext): Promise<CmsParametersPluginResponse | null>;\n}\n\nexport class CmsParametersPlugin extends Plugin {\n    public static override readonly type: string = \"cms-parameters-plugin\";\n\n    private readonly callable: CmsParametersPluginCallable;\n\n    public constructor(callable: CmsParametersPluginCallable) {\n        super();\n\n        this.callable = callable;\n    }\n\n    public async getParameters(context: CmsContext): Promise<CmsParametersPluginResponse | null> {\n        return this.callable(context);\n    }\n}\n"],"names":["CmsParametersPlugin","Plugin","callable","context"],"mappings":";AAgBO,MAAMA,4BAA4BC;;aACL,IAAI,GAAW;;IAI/C,YAAmBC,QAAqC,CAAE;QACtD,KAAK;QAEL,IAAI,CAAC,QAAQ,GAAGA;IACpB;IAEA,MAAa,cAAcC,OAAmB,EAA+C;QACzF,OAAO,IAAI,CAAC,QAAQ,CAACA;IACzB;AACJ"}

package/plugins/StorageOperationsCmsModelPlugin.js

@@ -1,34 +1,27 @@
 import { Plugin } from "@webiny/plugins";
-/**
- * This plugin should be initialized only once and hence the name.
- */
-export class StorageOperationsCmsModelPlugin extends Plugin {
-  static type = "cms.storageOperations.model";
-  name = "cms.storageOperations.model";
-  models = {};
-  constructor(cb) {
-    super();
-    this.cb = cb;
-  }
-  getModel(input) {
-    const cacheKey = this.createCacheKey(input);
-    if (this.models[cacheKey]) {
-      return this.models[cacheKey];
+class StorageOperationsCmsModelPlugin extends Plugin {
+    static{
+        this.type = "cms.storageOperations.model";
+    }
+    constructor(cb){
+        super(), this.name = "cms.storageOperations.model", this.models = {};
+        this.cb = cb;
+    }
+    getModel(input) {
+        const cacheKey = this.createCacheKey(input);
+        if (this.models[cacheKey]) return this.models[cacheKey];
+        const model = this.cb(input);
+        this.models[cacheKey] = model;
+        return model;
+    }
+    createCacheKey(model) {
+        return [
+            model.tenant,
+            model.modelId,
+            model.savedOn || "unknown"
+        ].join("#");
     }
-    const model = this.cb(input);
-    this.models[cacheKey] = model;
-    return model;
-  }
-
-  /**
-   * We can cache the converters by having a cache key that is a combination of model ID and savedOn.
-   * The models created via the code will not have savedOn, so they will be unknown - and that is ok as they cannot change in the middle of the call.
-   *
-   * The models created via the CRUD operations might get changed in the middle of the call, so we need to re-create the SO model.
-   */
-  createCacheKey(model) {
-    return [model.tenant, model.modelId, model.savedOn || "unknown"].join("#");
-  }
 }
+export { StorageOperationsCmsModelPlugin };
 
 //# sourceMappingURL=StorageOperationsCmsModelPlugin.js.map

package/plugins/StorageOperationsCmsModelPlugin.js.map

@@ -1 +1 @@
-{"version":3,"names":["Plugin","StorageOperationsCmsModelPlugin","type","name","models","constructor","cb","getModel","input","cacheKey","createCacheKey","model","tenant","modelId","savedOn","join"],"sources":["StorageOperationsCmsModelPlugin.ts"],"sourcesContent":["import { Plugin } from \"@webiny/plugins\";\nimport type { CmsEntryValues, CmsModel, StorageOperationsCmsModel } from \"~/types/index.js\";\n\nexport interface StorageOperationsCmsModelPluginCallable {\n    (model: CmsModel): StorageOperationsCmsModel;\n}\n\n/**\n * This plugin should be initialized only once and hence the name.\n */\nexport class StorageOperationsCmsModelPlugin extends Plugin {\n    public static override readonly type: string = \"cms.storageOperations.model\";\n    public override name = \"cms.storageOperations.model\";\n\n    private readonly models: Record<string, StorageOperationsCmsModel> = {};\n    private readonly cb: StorageOperationsCmsModelPluginCallable;\n\n    public constructor(cb: StorageOperationsCmsModelPluginCallable) {\n        super();\n        this.cb = cb;\n    }\n\n    public getModel<T extends CmsEntryValues>(input: CmsModel) {\n        const cacheKey = this.createCacheKey(input);\n        if (this.models[cacheKey]) {\n            return this.models[cacheKey] as unknown as StorageOperationsCmsModel<T>;\n        }\n        const model = this.cb(input);\n\n        this.models[cacheKey] = model;\n\n        return model as unknown as StorageOperationsCmsModel<T>;\n    }\n\n    /**\n     * We can cache the converters by having a cache key that is a combination of model ID and savedOn.\n     * The models created via the code will not have savedOn, so they will be unknown - and that is ok as they cannot change in the middle of the call.\n     *\n     * The models created via the CRUD operations might get changed in the middle of the call, so we need to re-create the SO model.\n     */\n    private createCacheKey(model: CmsModel): string {\n        return [model.tenant, model.modelId, model.savedOn || \"unknown\"].join(\"#\");\n    }\n}\n"],"mappings":"AAAA,SAASA,MAAM,QAAQ,iBAAiB;AAOxC;AACA;AACA;AACA,OAAO,MAAMC,+BAA+B,SAASD,MAAM,CAAC;EACxD,OAAgCE,IAAI,GAAW,6BAA6B;EAC5DC,IAAI,GAAG,6BAA6B;EAEnCC,MAAM,GAA8C,CAAC,CAAC;EAGhEC,WAAWA,CAACC,EAA2C,EAAE;IAC5D,KAAK,CAAC,CAAC;IACP,IAAI,CAACA,EAAE,GAAGA,EAAE;EAChB;EAEOC,QAAQA,CAA2BC,KAAe,EAAE;IACvD,MAAMC,QAAQ,GAAG,IAAI,CAACC,cAAc,CAACF,KAAK,CAAC;IAC3C,IAAI,IAAI,CAACJ,MAAM,CAACK,QAAQ,CAAC,EAAE;MACvB,OAAO,IAAI,CAACL,MAAM,CAACK,QAAQ,CAAC;IAChC;IACA,MAAME,KAAK,GAAG,IAAI,CAACL,EAAE,CAACE,KAAK,CAAC;IAE5B,IAAI,CAACJ,MAAM,CAACK,QAAQ,CAAC,GAAGE,KAAK;IAE7B,OAAOA,KAAK;EAChB;;EAEA;AACJ;AACA;AACA;AACA;AACA;EACYD,cAAcA,CAACC,KAAe,EAAU;IAC5C,OAAO,CAACA,KAAK,CAACC,MAAM,EAAED,KAAK,CAACE,OAAO,EAAEF,KAAK,CAACG,OAAO,IAAI,SAAS,CAAC,CAACC,IAAI,CAAC,GAAG,CAAC;EAC9E;AACJ","ignoreList":[]}
+{"version":3,"file":"plugins/StorageOperationsCmsModelPlugin.js","sources":["../../src/plugins/StorageOperationsCmsModelPlugin.ts"],"sourcesContent":["import { Plugin } from \"@webiny/plugins\";\nimport type { CmsEntryValues, CmsModel, StorageOperationsCmsModel } from \"~/types/index.js\";\n\nexport interface StorageOperationsCmsModelPluginCallable {\n    (model: CmsModel): StorageOperationsCmsModel;\n}\n\n/**\n * This plugin should be initialized only once and hence the name.\n */\nexport class StorageOperationsCmsModelPlugin extends Plugin {\n    public static override readonly type: string = \"cms.storageOperations.model\";\n    public override name = \"cms.storageOperations.model\";\n\n    private readonly models: Record<string, StorageOperationsCmsModel> = {};\n    private readonly cb: StorageOperationsCmsModelPluginCallable;\n\n    public constructor(cb: StorageOperationsCmsModelPluginCallable) {\n        super();\n        this.cb = cb;\n    }\n\n    public getModel<T extends CmsEntryValues>(input: CmsModel) {\n        const cacheKey = this.createCacheKey(input);\n        if (this.models[cacheKey]) {\n            return this.models[cacheKey] as unknown as StorageOperationsCmsModel<T>;\n        }\n        const model = this.cb(input);\n\n        this.models[cacheKey] = model;\n\n        return model as unknown as StorageOperationsCmsModel<T>;\n    }\n\n    /**\n     * We can cache the converters by having a cache key that is a combination of model ID and savedOn.\n     * The models created via the code will not have savedOn, so they will be unknown - and that is ok as they cannot change in the middle of the call.\n     *\n     * The models created via the CRUD operations might get changed in the middle of the call, so we need to re-create the SO model.\n     */\n    private createCacheKey(model: CmsModel): string {\n        return [model.tenant, model.modelId, model.savedOn || \"unknown\"].join(\"#\");\n    }\n}\n"],"names":["StorageOperationsCmsModelPlugin","Plugin","cb","input","cacheKey","model"],"mappings":";AAUO,MAAMA,wCAAwCC;;aACjB,IAAI,GAAW;;IAM/C,YAAmBC,EAA2C,CAAE;QAC5D,KAAK,SANO,IAAI,GAAG,oCAEN,MAAM,GAA8C,CAAC;QAKlE,IAAI,CAAC,EAAE,GAAGA;IACd;IAEO,SAAmCC,KAAe,EAAE;QACvD,MAAMC,WAAW,IAAI,CAAC,cAAc,CAACD;QACrC,IAAI,IAAI,CAAC,MAAM,CAACC,SAAS,EACrB,OAAO,IAAI,CAAC,MAAM,CAACA,SAAS;QAEhC,MAAMC,QAAQ,IAAI,CAAC,EAAE,CAACF;QAEtB,IAAI,CAAC,MAAM,CAACC,SAAS,GAAGC;QAExB,OAAOA;IACX;IAQQ,eAAeA,KAAe,EAAU;QAC5C,OAAO;YAACA,MAAM,MAAM;YAAEA,MAAM,OAAO;YAAEA,MAAM,OAAO,IAAI;SAAU,CAAC,IAAI,CAAC;IAC1E;AACJ"}

package/plugins/index.js

@@ -4,5 +4,3 @@ export * from "./CmsParametersPlugin.js";
 export * from "./CmsModelFieldConverterPlugin.js";
 export * from "./CmsGraphQLSchemaPlugin/index.js";
 export * from "./StorageOperationsCmsModelPlugin.js";
-
-//# sourceMappingURL=index.js.map

package/types/context.d.ts

@@ -1,6 +1,5 @@
 import type { CmsDeleteEntryOptions, CmsEntry, CmsEntryGetParams, CmsEntryListParams, CmsEntryMeta, CmsEntryUniqueValue, CmsEntryValidateResponse, CmsEntryValues, CreateCmsEntryInput, CreateCmsEntryOptionsInput, CreateFromCmsEntryInput, CreateRevisionCmsEntryOptionsInput, DeleteMultipleEntriesParams, DeleteMultipleEntriesResponse, GetUniqueFieldValuesParams, UpdateCmsEntryInput, UpdateCmsEntryOptionsInput } from "./types.js";
 import type { CmsModel } from "./model.js";
-import type { GenericRecord } from "@webiny/api/types.js";
 /**
  * Cms Entry CRUD methods in the context.
  *
@@ -55,7 +54,12 @@ export interface CmsEntryContext {
     /**
      * Update existing entry.
      */
-    updateEntry: <TInput extends CmsEntryValues = CmsEntryValues>(model: CmsModel, id: string, input: UpdateCmsEntryInput<TInput>, meta?: GenericRecord, options?: UpdateCmsEntryOptionsInput) => Promise<CmsEntry<TInput>>;
+    updateEntry: <TInput extends CmsEntryValues = CmsEntryValues>(model: CmsModel, id: string, input: UpdateCmsEntryInput<TInput>, options?: UpdateCmsEntryOptionsInput) => Promise<CmsEntry<TInput>>;
+    /**
+     * Update entry revision description.
+     * It does not matter if the entry is published/unpublished or any other state.
+     */
+    updateRevisionDescription: <T extends CmsEntryValues = CmsEntryValues>(model: CmsModel, id: string, revisionDescription: string | undefined) => Promise<CmsEntry<T>>;
     /**
      * Validate the entry - either new one or existing one.
      */

package/types/context.js

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

package/types/fields/dynamicZoneField.js

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

package/types/fields/objectField.js

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

package/types/identity.js

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

package/types/index.js

@@ -1,3 +1 @@
 export * from "./types.js";
-
-//# sourceMappingURL=index.js.map

package/types/model.js

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

package/types/modelAst.js

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

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

@@ -384,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?
      */
@@ -407,6 +398,10 @@ export interface CmsEntry<TValues extends CmsEntryValues = CmsEntryValues> {
      * Is this CMS Entry live (no matter the revision).
      */
     live: ICmsEntryLive | null;
+    /**
+     * A revision description.
+     */
+    revisionDescription: string | undefined;
 }
 export interface CmsStorageEntry<T extends CmsEntryValues = CmsEntryValues> extends CmsEntry<T> {
     [key: string]: any;

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