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

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.d.ts

@@ -1,8 +1,6 @@
 export * from "./CmsGroupPlugin.js";
 export * from "./CmsModelPlugin.js";
-export * from "./StorageTransformPlugin.js";
 export * from "./CmsParametersPlugin.js";
 export * from "./CmsModelFieldConverterPlugin.js";
 export * from "./CmsGraphQLSchemaPlugin/index.js";
-export * from "./CmsGraphQLSchemaSorterPlugin.js";
 export * from "./StorageOperationsCmsModelPlugin.js";

package/plugins/index.js

@@ -1,10 +1,6 @@
 export * from "./CmsGroupPlugin.js";
 export * from "./CmsModelPlugin.js";
-export * from "./StorageTransformPlugin.js";
 export * from "./CmsParametersPlugin.js";
 export * from "./CmsModelFieldConverterPlugin.js";
 export * from "./CmsGraphQLSchemaPlugin/index.js";
-export * from "./CmsGraphQLSchemaSorterPlugin.js";
 export * from "./StorageOperationsCmsModelPlugin.js";
-
-//# sourceMappingURL=index.js.map

package/types/context.d.ts

@@ -1,7 +1,5 @@
-import type { ContentEntryTraverser } from "../utils/contentEntryTraverser/ContentEntryTraverser.js";
 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.
  *
@@ -9,10 +7,6 @@ import type { GenericRecord } from "@webiny/api/types.js";
  * @category CmsEntry
  */
 export interface CmsEntryContext {
-    /**
-     * Get content entry traverser.
-     */
-    getEntryTraverser: (modelId: string) => Promise<ContentEntryTraverser>;
     /**
      * Get a single content entry for a model.
      */
@@ -60,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.d.ts

@@ -1,4 +1,5 @@
 import type { CmsModelField } from "../modelField.js";
+import type { CmsModelLayout } from "../../types/index.js";
 /**
  * A definition for object field to show possible type of the field in settings.
  */
@@ -8,6 +9,7 @@ export interface CmsModelObjectField extends CmsModelField {
      */
     settings: {
         fields: CmsModelField[];
+        layout?: CmsModelLayout;
         parents?: string[];
     };
 }

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.d.ts

@@ -1,6 +1,35 @@
 import type { CmsIdentity } from "./identity.js";
-import type { CmsModelField, CmsModelFieldInput } from "./modelField.js";
+import type { CmsModelField, CmsModelFieldInput, FieldRule } from "./modelField.js";
 import type { CmsIcon } from "../types/types.js";
+export interface CmsTabLayoutTab {
+    id: string;
+    label: string;
+    icon?: CmsIcon | null;
+    layout: CmsModelLayout;
+    rules?: FieldRule[];
+}
+export interface CmsTabLayoutDescriptor {
+    type: "tabs";
+    label: string;
+    description?: string | null;
+    help?: string | null;
+    tabs: CmsTabLayoutTab[];
+    rules?: FieldRule[];
+}
+export interface CmsSeparatorLayoutDescriptor {
+    type: "separator";
+    label: string;
+    description: string | null | undefined;
+    rules?: FieldRule[];
+}
+export interface CmsAlertLayoutDescriptor {
+    type: "alert";
+    label: string;
+    alertType: "info" | "success" | "warning" | "danger";
+    rules?: FieldRule[];
+}
+export type CmsModelLayoutCell = string | CmsTabLayoutDescriptor | CmsSeparatorLayoutDescriptor | CmsAlertLayoutDescriptor;
+export type CmsModelLayout = CmsModelLayoutCell[][];
 /**
  * Base CMS Model. Should not be exported and used outside of this package.
  *
@@ -76,7 +105,7 @@ export interface CmsModel {
      * ]
      * ```
      */
-    layout: string[][];
+    layout: CmsModelLayout;
     /**
      * Models can be tagged to give them contextual meaning.
      */
@@ -112,6 +141,13 @@ export interface CmsModel {
      */
     isPlugin?: boolean;
 }
+export interface StorageCmsModelFields {
+    compression: string;
+    value: string;
+}
+export interface StorageCmsModel extends Omit<CmsModel, "fields"> {
+    fields: StorageCmsModelFields | CmsModelField[];
+}
 export interface CmsModelAuthorization {
     permissions: boolean;
     [key: string]: any;
@@ -161,7 +197,7 @@ export interface CmsModelCreateInput {
      * ]
      * ```
      */
-    layout?: string[][];
+    layout?: CmsModelLayout;
     /**
      * Models can be tagged to give them contextual meaning.
      */

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.d.ts

@@ -1,6 +1,14 @@
-import type { CmsModel } from "./model.js";
+import type { CmsModel, CmsModelLayout } from "./model.js";
 import type { GenericRecord } from "@webiny/api/types.js";
 import type { CmsDynamicZoneTemplate } from "../types/fields/dynamicZoneField.js";
+export type FieldRuleAction = "hide" | "disable" | string;
+export interface FieldRule {
+    type: "accessControl" | "entryValue";
+    target: string;
+    operator: string;
+    value: string | number | boolean | null;
+    action: FieldRuleAction;
+}
 export type CmsModelFieldType = "boolean" | "datetime" | "file" | "long-text" | "number" | "json" | "object" | "ref" | "rich-text" | "text" | "dynamicZone" | string;
 export type ICmsModelFieldStorageId = `${string}@${string}` | string;
 /**
@@ -43,17 +51,25 @@ export interface CmsModelField {
      */
     fieldId: string;
     /**
-     * A label for the field
+     * A label for the field.
      */
     label: string;
     /**
-     * Text below the field to clarify what is it meant to be in the field value
+     * Field description right below the label.
+     */
+    description?: string | null;
+    /**
+     * Note displayed below the input.
      */
-    helpText?: string | null;
+    note?: string | null;
     /**
-     * Text to be displayed in the field
+     * Text in the tooltip next to the input label.
      */
-    placeholderText?: string | null;
+    help?: string | null;
+    /**
+     * Placeholder text to be displayed in the field
+     */
+    placeholder?: string | null;
     /**
      * Are predefined values enabled? And list of them
      */
@@ -80,7 +96,7 @@ export interface CmsModelField {
      * Is this a multiple values field?
      *
      */
-    multipleValues?: boolean;
+    list?: boolean;
     /**
      * Fields can be tagged to give them contextual meaning.
      */
@@ -91,6 +107,10 @@ export interface CmsModelField {
      * @default {}
      */
     settings?: CmsModelFieldSettings;
+    /**
+     * Rules that control field visibility and editability (access control and entry value conditions).
+     */
+    rules?: FieldRule[];
 }
 /**
  * A definition for content model field received from the user.
@@ -108,7 +128,7 @@ export interface CmsModelFieldInput {
     id: string;
     /**
      * Type of the field. A plugin for the field must be defined.
-     * @see CmsModelFieldToGraphQLPlugin
+     * @see CmsModelFieldToGraphQL
      */
     type: string;
     /**
@@ -120,13 +140,21 @@ export interface CmsModelFieldInput {
      */
     label: string;
     /**
-     * Text to display below the field to help user what to write in the field.
+     * Field description right below the label.
      */
-    helpText?: string | null;
+    description?: string | null;
+    /**
+     * Note displayed below the input.
+     */
+    note?: string | null;
     /**
-     * Text to display in the field.
+     * Text in the tooltip next to the input label.
      */
-    placeholderText?: string | null;
+    help?: string | null;
+    /**
+     * Placeholder text to be displayed in the field
+     */
+    placeholder?: string | null;
     /**
      * Fields can be tagged to give them contextual meaning.
      */
@@ -134,7 +162,7 @@ export interface CmsModelFieldInput {
     /**
      * Are multiple values allowed?
      */
-    multipleValues?: boolean;
+    list?: boolean;
     /**
      * Predefined values options for the field. Check the reference for more information.
      */
@@ -157,6 +185,10 @@ export interface CmsModelFieldInput {
     settings?: {
         [key: string]: any;
     };
+    /**
+     * Rules that control field visibility and editability (access control and entry value conditions).
+     */
+    rules?: FieldRule[];
 }
 /**
  * A GraphQL `params.data` parameter received when updating content model.
@@ -199,7 +231,7 @@ export interface CmsModelUpdateInput {
      * ]
      * ```
      */
-    layout: string[][];
+    layout: CmsModelLayout;
     /**
      * Tags for the content model.
      */
@@ -250,7 +282,7 @@ export interface CmsModelFieldSettings {
     /**
      * Object field has child fields - so it needs to have a layout.
      */
-    layout?: string[][];
+    layout?: CmsModelLayout;
     /**
      * Ref field.
      */

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