@webiny/api-headless-cms 0.0.0-unstable.1e66d121db → 0.0.0-unstable.2696f9d9e8

package/parameters/path.js

@@ -1,38 +1,28 @@
 "use strict";
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
-
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.createPathParameterPlugin = void 0;
-
 var _error = _interopRequireDefault(require("@webiny/error"));
-
 var _CmsParametersPlugin = require("../plugins/CmsParametersPlugin");
-
 const allowedEndpoints = ["manage", "read", "preview"];
-
 const createPathParameterPlugin = () => {
   return new _CmsParametersPlugin.CmsParametersPlugin(async context => {
-    var _context$request;
-
     /**
      * If any of the properties is not defined, just ignore this plugin
      */
-    if (!((_context$request = context.request) !== null && _context$request !== void 0 && _context$request.params)) {
+    if (!context.request?.params) {
       return null;
     }
-
     const {
       type,
       locale
     } = context.request.params;
-
     if (!type && !locale) {
       return null;
     }
-
     if (!type) {
       throw new _error.default(`Missing request parameter "type".`);
     } else if (!locale) {
@@ -40,12 +30,12 @@ const createPathParameterPlugin = () => {
     } else if (allowedEndpoints.includes(type) === false) {
       throw new _error.default(`Endpoint "${type}" not allowed!`);
     }
-
     return {
       type: type,
       locale
     };
   });
 };
+exports.createPathParameterPlugin = createPathParameterPlugin;
 
-exports.createPathParameterPlugin = createPathParameterPlugin;
+//# sourceMappingURL=path.js.map

package/parameters/path.js.map

@@ -1 +1 @@
-{"version":3,"names":["allowedEndpoints","createPathParameterPlugin","CmsParametersPlugin","context","request","params","type","locale","WebinyError","includes"],"sources":["path.ts"],"sourcesContent":["import WebinyError from \"@webiny/error\";\nimport { CmsParametersPlugin } from \"~/plugins/CmsParametersPlugin\";\nimport { ApiEndpoint } from \"~/types\";\n\nconst allowedEndpoints: ApiEndpoint[] = [\"manage\", \"read\", \"preview\"];\n\nexport const createPathParameterPlugin = () => {\n    return new CmsParametersPlugin(async context => {\n        /**\n         * If any of the properties is not defined, just ignore this plugin\n         */\n        if (!context.request?.params) {\n            return null;\n        }\n\n        const { type, locale } = context.request.params as Record<string, string | null>;\n        if (!type && !locale) {\n            return null;\n        }\n\n        if (!type) {\n            throw new WebinyError(`Missing request parameter \"type\".`);\n        } else if (!locale) {\n            throw new WebinyError(`Missing request parameter \"locale\".`);\n        } else if (allowedEndpoints.includes(type as ApiEndpoint) === false) {\n            throw new WebinyError(`Endpoint \"${type}\" not allowed!`);\n        }\n\n        return {\n            type: type as ApiEndpoint,\n            locale\n        };\n    });\n};\n"],"mappings":";;;;;;;;;AAAA;;AACA;;AAGA,MAAMA,gBAA+B,GAAG,CAAC,QAAD,EAAW,MAAX,EAAmB,SAAnB,CAAxC;;AAEO,MAAMC,yBAAyB,GAAG,MAAM;EAC3C,OAAO,IAAIC,wCAAJ,CAAwB,MAAMC,OAAN,IAAiB;IAAA;;IAC5C;AACR;AACA;IACQ,IAAI,sBAACA,OAAO,CAACC,OAAT,6CAAC,iBAAiBC,MAAlB,CAAJ,EAA8B;MAC1B,OAAO,IAAP;IACH;;IAED,MAAM;MAAEC,IAAF;MAAQC;IAAR,IAAmBJ,OAAO,CAACC,OAAR,CAAgBC,MAAzC;;IACA,IAAI,CAACC,IAAD,IAAS,CAACC,MAAd,EAAsB;MAClB,OAAO,IAAP;IACH;;IAED,IAAI,CAACD,IAAL,EAAW;MACP,MAAM,IAAIE,cAAJ,CAAiB,mCAAjB,CAAN;IACH,CAFD,MAEO,IAAI,CAACD,MAAL,EAAa;MAChB,MAAM,IAAIC,cAAJ,CAAiB,qCAAjB,CAAN;IACH,CAFM,MAEA,IAAIR,gBAAgB,CAACS,QAAjB,CAA0BH,IAA1B,MAAmD,KAAvD,EAA8D;MACjE,MAAM,IAAIE,cAAJ,CAAiB,aAAYF,IAAK,gBAAlC,CAAN;IACH;;IAED,OAAO;MACHA,IAAI,EAAEA,IADH;MAEHC;IAFG,CAAP;EAIH,CAzBM,CAAP;AA0BH,CA3BM"}
+{"version":3,"names":["_error","_interopRequireDefault","require","_CmsParametersPlugin","allowedEndpoints","createPathParameterPlugin","CmsParametersPlugin","context","request","params","type","locale","WebinyError","includes","exports"],"sources":["path.ts"],"sourcesContent":["import WebinyError from \"@webiny/error\";\nimport { CmsParametersPlugin } from \"~/plugins/CmsParametersPlugin\";\nimport { ApiEndpoint } from \"~/types\";\n\nconst allowedEndpoints: ApiEndpoint[] = [\"manage\", \"read\", \"preview\"];\n\nexport const createPathParameterPlugin = () => {\n    return new CmsParametersPlugin(async context => {\n        /**\n         * If any of the properties is not defined, just ignore this plugin\n         */\n        if (!context.request?.params) {\n            return null;\n        }\n\n        const { type, locale } = context.request.params as Record<string, string | null>;\n        if (!type && !locale) {\n            return null;\n        }\n\n        if (!type) {\n            throw new WebinyError(`Missing request parameter \"type\".`);\n        } else if (!locale) {\n            throw new WebinyError(`Missing request parameter \"locale\".`);\n        } else if (allowedEndpoints.includes(type as ApiEndpoint) === false) {\n            throw new WebinyError(`Endpoint \"${type}\" not allowed!`);\n        }\n\n        return {\n            type: type as ApiEndpoint,\n            locale\n        };\n    });\n};\n"],"mappings":";;;;;;;AAAA,IAAAA,MAAA,GAAAC,sBAAA,CAAAC,OAAA;AACA,IAAAC,oBAAA,GAAAD,OAAA;AAGA,MAAME,gBAA+B,GAAG,CAAC,QAAQ,EAAE,MAAM,EAAE,SAAS,CAAC;AAE9D,MAAMC,yBAAyB,GAAGA,CAAA,KAAM;EAC3C,OAAO,IAAIC,wCAAmB,CAAC,MAAMC,OAAO,IAAI;IAC5C;AACR;AACA;IACQ,IAAI,CAACA,OAAO,CAACC,OAAO,EAAEC,MAAM,EAAE;MAC1B,OAAO,IAAI;IACf;IAEA,MAAM;MAAEC,IAAI;MAAEC;IAAO,CAAC,GAAGJ,OAAO,CAACC,OAAO,CAACC,MAAuC;IAChF,IAAI,CAACC,IAAI,IAAI,CAACC,MAAM,EAAE;MAClB,OAAO,IAAI;IACf;IAEA,IAAI,CAACD,IAAI,EAAE;MACP,MAAM,IAAIE,cAAW,CAAE,mCAAkC,CAAC;IAC9D,CAAC,MAAM,IAAI,CAACD,MAAM,EAAE;MAChB,MAAM,IAAIC,cAAW,CAAE,qCAAoC,CAAC;IAChE,CAAC,MAAM,IAAIR,gBAAgB,CAACS,QAAQ,CAACH,IAAmB,CAAC,KAAK,KAAK,EAAE;MACjE,MAAM,IAAIE,cAAW,CAAE,aAAYF,IAAK,gBAAe,CAAC;IAC5D;IAEA,OAAO;MACHA,IAAI,EAAEA,IAAmB;MACzBC;IACJ,CAAC;EACL,CAAC,CAAC;AACN,CAAC;AAACG,OAAA,CAAAT,yBAAA,GAAAA,yBAAA"}

package/plugins/CmsGraphQLSchemaPlugin.d.ts

@@ -0,0 +1,5 @@
+import { GraphQLSchemaPlugin } from "@webiny/handler-graphql";
+import { CmsContext } from "../types";
+export declare class CmsGraphQLSchemaPlugin<T = CmsContext> extends GraphQLSchemaPlugin<T> {
+    static type: string;
+}

package/plugins/CmsGraphQLSchemaPlugin.js

@@ -0,0 +1,13 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.CmsGraphQLSchemaPlugin = void 0;
+var _handlerGraphql = require("@webiny/handler-graphql");
+class CmsGraphQLSchemaPlugin extends _handlerGraphql.GraphQLSchemaPlugin {
+  static type = "cms.graphql.schema";
+}
+exports.CmsGraphQLSchemaPlugin = CmsGraphQLSchemaPlugin;
+
+//# sourceMappingURL=CmsGraphQLSchemaPlugin.js.map

package/plugins/CmsGraphQLSchemaPlugin.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["_handlerGraphql","require","CmsGraphQLSchemaPlugin","GraphQLSchemaPlugin","type","exports"],"sources":["CmsGraphQLSchemaPlugin.ts"],"sourcesContent":["import { GraphQLSchemaPlugin } from \"@webiny/handler-graphql\";\nimport { CmsContext } from \"~/types\";\n\nexport class CmsGraphQLSchemaPlugin<T = CmsContext> extends GraphQLSchemaPlugin<T> {\n    public static override type = \"cms.graphql.schema\";\n}\n"],"mappings":";;;;;;AAAA,IAAAA,eAAA,GAAAC,OAAA;AAGO,MAAMC,sBAAsB,SAAyBC,mCAAmB,CAAI;EAC/E,OAAuBC,IAAI,GAAG,oBAAoB;AACtD;AAACC,OAAA,CAAAH,sBAAA,GAAAA,sBAAA"}

package/plugins/CmsGraphQLSchemaSorterPlugin.d.ts

@@ -0,0 +1,20 @@
+import { Plugin } from "@webiny/plugins";
+import { CmsModel } from "../types";
+interface CmsGraphQLSchemaSorterPluginCallableParams {
+    model: CmsModel;
+    sorters: string[];
+}
+interface CmsGraphQLSchemaSorterPluginCallable {
+    (params: CmsGraphQLSchemaSorterPluginCallableParams): string[];
+}
+export declare class CmsGraphQLSchemaSorterPlugin extends Plugin {
+    static readonly type: string;
+    private readonly cb;
+    constructor(cb: CmsGraphQLSchemaSorterPluginCallable);
+    /**
+     * Method must return new sorting array. Or existing one if no changes are made.
+     */
+    createSorter(params: CmsGraphQLSchemaSorterPluginCallableParams): string[];
+}
+export declare const createCmsGraphQLSchemaSorterPlugin: (cb: CmsGraphQLSchemaSorterPluginCallable) => CmsGraphQLSchemaSorterPlugin;
+export {};

package/plugins/CmsGraphQLSchemaSorterPlugin.js

@@ -0,0 +1,27 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createCmsGraphQLSchemaSorterPlugin = exports.CmsGraphQLSchemaSorterPlugin = void 0;
+var _plugins = require("@webiny/plugins");
+class CmsGraphQLSchemaSorterPlugin extends _plugins.Plugin {
+  static type = "cms.graphql.schema.sorter";
+  constructor(cb) {
+    super();
+    this.cb = cb;
+  }
+  /**
+   * Method must return new sorting array. Or existing one if no changes are made.
+   */
+  createSorter(params) {
+    return this.cb(params);
+  }
+}
+exports.CmsGraphQLSchemaSorterPlugin = CmsGraphQLSchemaSorterPlugin;
+const createCmsGraphQLSchemaSorterPlugin = cb => {
+  return new CmsGraphQLSchemaSorterPlugin(cb);
+};
+exports.createCmsGraphQLSchemaSorterPlugin = createCmsGraphQLSchemaSorterPlugin;
+
+//# sourceMappingURL=CmsGraphQLSchemaSorterPlugin.js.map

package/plugins/CmsGraphQLSchemaSorterPlugin.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["_plugins","require","CmsGraphQLSchemaSorterPlugin","Plugin","type","constructor","cb","createSorter","params","exports","createCmsGraphQLSchemaSorterPlugin"],"sources":["CmsGraphQLSchemaSorterPlugin.ts"],"sourcesContent":["import { Plugin } from \"@webiny/plugins\";\nimport { CmsModel } from \"~/types\";\n\ninterface CmsGraphQLSchemaSorterPluginCallableParams {\n    model: CmsModel;\n    sorters: string[];\n}\ninterface CmsGraphQLSchemaSorterPluginCallable {\n    (params: CmsGraphQLSchemaSorterPluginCallableParams): string[];\n}\nexport class CmsGraphQLSchemaSorterPlugin extends Plugin {\n    public static override readonly type: string = \"cms.graphql.schema.sorter\";\n\n    private readonly cb: CmsGraphQLSchemaSorterPluginCallable;\n    public constructor(cb: CmsGraphQLSchemaSorterPluginCallable) {\n        super();\n\n        this.cb = cb;\n    }\n    /**\n     * Method must return new sorting array. Or existing one if no changes are made.\n     */\n    public createSorter(params: CmsGraphQLSchemaSorterPluginCallableParams): string[] {\n        return this.cb(params);\n    }\n}\n\nexport const createCmsGraphQLSchemaSorterPlugin = (\n    cb: CmsGraphQLSchemaSorterPluginCallable\n): CmsGraphQLSchemaSorterPlugin => {\n    return new CmsGraphQLSchemaSorterPlugin(cb);\n};\n"],"mappings":";;;;;;AAAA,IAAAA,QAAA,GAAAC,OAAA;AAUO,MAAMC,4BAA4B,SAASC,eAAM,CAAC;EACrD,OAAgCC,IAAI,GAAW,2BAA2B;EAGnEC,WAAWA,CAACC,EAAwC,EAAE;IACzD,KAAK,CAAC,CAAC;IAEP,IAAI,CAACA,EAAE,GAAGA,EAAE;EAChB;EACA;AACJ;AACA;EACWC,YAAYA,CAACC,MAAkD,EAAY;IAC9E,OAAO,IAAI,CAACF,EAAE,CAACE,MAAM,CAAC;EAC1B;AACJ;AAACC,OAAA,CAAAP,4BAAA,GAAAA,4BAAA;AAEM,MAAMQ,kCAAkC,GAC3CJ,EAAwC,IACT;EAC/B,OAAO,IAAIJ,4BAA4B,CAACI,EAAE,CAAC;AAC/C,CAAC;AAACG,OAAA,CAAAC,kCAAA,GAAAA,kCAAA"}

package/plugins/CmsGroupPlugin.d.ts

@@ -1,13 +1,16 @@
 import { Plugin } from "@webiny/plugins";
 import { CmsGroup as BaseCmsGroup } from "../types";
-interface CmsGroup extends Omit<BaseCmsGroup, "locale" | "tenant" | "webinyVersion"> {
+export interface CmsGroupInput extends Omit<BaseCmsGroup, "locale" | "tenant" | "webinyVersion" | "isPlugin"> {
+    tenant?: string;
+    locale?: string;
+}
+export interface CmsGroup extends Omit<BaseCmsGroup, "locale" | "tenant" | "webinyVersion"> {
     tenant?: string;
     locale?: string;
 }
 export declare class CmsGroupPlugin extends Plugin {
     static readonly type: string;
     readonly contentModelGroup: CmsGroup;
-    constructor(contentModelGroup: CmsGroup);
+    constructor(contentModelGroup: CmsGroupInput);
 }
 export declare const createCmsGroup: (group: CmsGroup) => CmsGroupPlugin;
-export {};

package/plugins/CmsGroupPlugin.js

@@ -1,30 +1,24 @@
 "use strict";
 
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
-
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.createCmsGroup = exports.CmsGroupPlugin = void 0;
-
-var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
-
 var _plugins = require("@webiny/plugins");
-
 class CmsGroupPlugin extends _plugins.Plugin {
+  static type = "cms-content-model-group";
   constructor(contentModelGroup) {
     super();
-    (0, _defineProperty2.default)(this, "contentModelGroup", void 0);
-    this.contentModelGroup = contentModelGroup;
+    this.contentModelGroup = {
+      ...contentModelGroup,
+      isPlugin: true
+    };
   }
-
 }
-
 exports.CmsGroupPlugin = CmsGroupPlugin;
-(0, _defineProperty2.default)(CmsGroupPlugin, "type", "cms-content-model-group");
-
 const createCmsGroup = group => {
   return new CmsGroupPlugin(group);
 };
+exports.createCmsGroup = createCmsGroup;
 
-exports.createCmsGroup = createCmsGroup;
+//# sourceMappingURL=CmsGroupPlugin.js.map

package/plugins/CmsGroupPlugin.js.map

@@ -1 +1 @@
-{"version":3,"names":["CmsGroupPlugin","Plugin","constructor","contentModelGroup","createCmsGroup","group"],"sources":["CmsGroupPlugin.ts"],"sourcesContent":["import { Plugin } from \"@webiny/plugins\";\nimport { CmsGroup as BaseCmsGroup } from \"~/types\";\n\ninterface CmsGroup extends Omit<BaseCmsGroup, \"locale\" | \"tenant\" | \"webinyVersion\"> {\n    tenant?: string;\n    locale?: string;\n}\nexport class CmsGroupPlugin extends Plugin {\n    public static override readonly type: string = \"cms-content-model-group\";\n    public readonly contentModelGroup: CmsGroup;\n\n    constructor(contentModelGroup: CmsGroup) {\n        super();\n        this.contentModelGroup = contentModelGroup;\n    }\n}\n\nexport const createCmsGroup = (group: CmsGroup): CmsGroupPlugin => {\n    return new CmsGroupPlugin(group);\n};\n"],"mappings":";;;;;;;;;;;AAAA;;AAOO,MAAMA,cAAN,SAA6BC,eAA7B,CAAoC;EAIvCC,WAAW,CAACC,iBAAD,EAA8B;IACrC;IADqC;IAErC,KAAKA,iBAAL,GAAyBA,iBAAzB;EACH;;AAPsC;;;8BAA9BH,c,UACsC,yB;;AAS5C,MAAMI,cAAc,GAAIC,KAAD,IAAqC;EAC/D,OAAO,IAAIL,cAAJ,CAAmBK,KAAnB,CAAP;AACH,CAFM"}
+{"version":3,"names":["_plugins","require","CmsGroupPlugin","Plugin","type","constructor","contentModelGroup","isPlugin","exports","createCmsGroup","group"],"sources":["CmsGroupPlugin.ts"],"sourcesContent":["import { Plugin } from \"@webiny/plugins\";\nimport { CmsGroup as BaseCmsGroup } from \"~/types\";\n\nexport interface CmsGroupInput\n    extends Omit<BaseCmsGroup, \"locale\" | \"tenant\" | \"webinyVersion\" | \"isPlugin\"> {\n    tenant?: string;\n    locale?: string;\n}\n\nexport interface CmsGroup extends Omit<BaseCmsGroup, \"locale\" | \"tenant\" | \"webinyVersion\"> {\n    tenant?: string;\n    locale?: string;\n}\n\nexport class CmsGroupPlugin extends Plugin {\n    public static override readonly type: string = \"cms-content-model-group\";\n    public readonly contentModelGroup: CmsGroup;\n\n    constructor(contentModelGroup: CmsGroupInput) {\n        super();\n        this.contentModelGroup = {\n            ...contentModelGroup,\n            isPlugin: true\n        };\n    }\n}\n\nexport const createCmsGroup = (group: CmsGroup): CmsGroupPlugin => {\n    return new CmsGroupPlugin(group);\n};\n"],"mappings":";;;;;;AAAA,IAAAA,QAAA,GAAAC,OAAA;AAcO,MAAMC,cAAc,SAASC,eAAM,CAAC;EACvC,OAAgCC,IAAI,GAAW,yBAAyB;EAGxEC,WAAWA,CAACC,iBAAgC,EAAE;IAC1C,KAAK,CAAC,CAAC;IACP,IAAI,CAACA,iBAAiB,GAAG;MACrB,GAAGA,iBAAiB;MACpBC,QAAQ,EAAE;IACd,CAAC;EACL;AACJ;AAACC,OAAA,CAAAN,cAAA,GAAAA,cAAA;AAEM,MAAMO,cAAc,GAAIC,KAAe,IAAqB;EAC/D,OAAO,IAAIR,cAAc,CAACQ,KAAK,CAAC;AACpC,CAAC;AAACF,OAAA,CAAAC,cAAA,GAAAA,cAAA"}

package/plugins/CmsModelFieldConverterPlugin.d.ts

@@ -1,8 +1,8 @@
 import { Plugin } from "@webiny/plugins";
 import { CmsEntryValues, CmsModelFieldWithParent } from "../types";
 import { ConverterCollection } from "../utils/converters/ConverterCollection";
-export interface ConvertParams {
-    field: CmsModelFieldWithParent;
+export interface ConvertParams<F = CmsModelFieldWithParent> {
+    field: F;
     value: any;
     converterCollection: ConverterCollection;
 }

package/plugins/CmsModelFieldConverterPlugin.js

@@ -1,17 +1,13 @@
 "use strict";
 
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
-
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.CmsModelFieldConverterPlugin = void 0;
-
-var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
-
 var _plugins = require("@webiny/plugins");
-
-class CmsModelFieldConverterPlugin extends _plugins.Plugin {}
-
+class CmsModelFieldConverterPlugin extends _plugins.Plugin {
+  static type = "cms.field.converter";
+}
 exports.CmsModelFieldConverterPlugin = CmsModelFieldConverterPlugin;
-(0, _defineProperty2.default)(CmsModelFieldConverterPlugin, "type", "cms.field.converter");
+
+//# sourceMappingURL=CmsModelFieldConverterPlugin.js.map

package/plugins/CmsModelFieldConverterPlugin.js.map

@@ -1 +1 @@
-{"version":3,"names":["CmsModelFieldConverterPlugin","Plugin"],"sources":["CmsModelFieldConverterPlugin.ts"],"sourcesContent":["import { Plugin } from \"@webiny/plugins\";\nimport { CmsEntryValues, CmsModelFieldWithParent } from \"~/types\";\nimport { ConverterCollection } from \"~/utils/converters/ConverterCollection\";\n\nexport interface ConvertParams {\n    field: CmsModelFieldWithParent;\n    value: any;\n    converterCollection: ConverterCollection;\n}\n\nexport abstract class CmsModelFieldConverterPlugin extends Plugin {\n    public static override type = \"cms.field.converter\";\n\n    public abstract getFieldType(): string;\n\n    public abstract convertToStorage(params: ConvertParams): CmsEntryValues;\n    public abstract convertFromStorage(params: ConvertParams): CmsEntryValues;\n}\n"],"mappings":";;;;;;;;;;;AAAA;;AAUO,MAAeA,4BAAf,SAAoDC,eAApD,CAA2D;;;8BAA5CD,4B,UACY,qB"}
+{"version":3,"names":["_plugins","require","CmsModelFieldConverterPlugin","Plugin","type","exports"],"sources":["CmsModelFieldConverterPlugin.ts"],"sourcesContent":["import { Plugin } from \"@webiny/plugins\";\nimport { CmsEntryValues, CmsModelFieldWithParent } from \"~/types\";\nimport { ConverterCollection } from \"~/utils/converters/ConverterCollection\";\n\nexport interface ConvertParams<F = CmsModelFieldWithParent> {\n    field: F;\n    value: any;\n    converterCollection: ConverterCollection;\n}\n\nexport abstract class CmsModelFieldConverterPlugin extends Plugin {\n    public static override type = \"cms.field.converter\";\n\n    public abstract getFieldType(): string;\n\n    public abstract convertToStorage(params: ConvertParams): CmsEntryValues;\n    public abstract convertFromStorage(params: ConvertParams): CmsEntryValues;\n}\n"],"mappings":";;;;;;AAAA,IAAAA,QAAA,GAAAC,OAAA;AAUO,MAAeC,4BAA4B,SAASC,eAAM,CAAC;EAC9D,OAAuBC,IAAI,GAAG,qBAAqB;AAMvD;AAACC,OAAA,CAAAH,4BAAA,GAAAA,4BAAA"}

package/plugins/CmsModelPlugin.d.ts

@@ -20,12 +20,31 @@ interface CmsModelFieldInput extends Omit<CmsModelFieldBase, "storageId" | "sett
      */
     settings?: CmsModelFieldSettings;
 }
-interface CmsModelInput extends Omit<CmsModelBase, "locale" | "tenant" | "webinyVersion" | "fields"> {
+export interface CmsApiModel extends Omit<CmsModelPluginModel, "isPrivate" | "fields" | "singularApiName" | "pluralApiName" | "isPlugin"> {
+    isPrivate?: never;
+    noValidate?: never;
+    singularApiName?: string;
+    pluralApiName?: string;
     fields: CmsModelFieldInput[];
-    locale?: string;
-    tenant?: string;
 }
-interface CmsModel extends Omit<CmsModelBase, "locale" | "tenant" | "webinyVersion"> {
+export interface CmsApiModelFull extends Omit<CmsApiModel, "fields" | "noValidate"> {
+    noValidate: true;
+    fields: CmsModelFieldBase[];
+}
+interface CmsPrivateModel extends Omit<CmsModelPluginModel, "isPrivate" | "singularApiName" | "pluralApiName" | "fields" | "isPlugin" | "layout" | "titleFieldId" | "description"> {
+    noValidate?: never;
+    titleFieldId?: string;
+    singularApiName?: never;
+    pluralApiName?: never;
+    isPrivate: true;
+    fields: CmsModelFieldInput[];
+}
+export interface CmsPrivateModelFull extends Omit<CmsPrivateModel, "fields" | "noValidate"> {
+    fields: CmsModelFieldBase[];
+    noValidate: true;
+}
+export declare type CmsModelInput = CmsApiModel | CmsPrivateModel | CmsApiModelFull | CmsPrivateModelFull;
+export interface CmsModelPluginModel extends Omit<CmsModelBase, "locale" | "tenant" | "webinyVersion"> {
     locale?: string;
     tenant?: string;
 }
@@ -34,7 +53,7 @@ interface CmsModelPluginOptions {
 }
 export declare class CmsModelPlugin extends Plugin {
     static readonly type: string;
-    readonly contentModel: CmsModel;
+    readonly contentModel: CmsModelPluginModel;
     private readonly options;
     constructor(contentModel: CmsModelInput, options?: CmsModelPluginOptions);
     private buildModel;
@@ -42,4 +61,5 @@ export declare class CmsModelPlugin extends Plugin {
     private validateLayout;
 }
 export declare const createCmsModel: (model: CmsModelInput, options?: CmsModelPluginOptions) => CmsModelPlugin;
+export declare const createPrivateModelDefinition: (input: Omit<CmsPrivateModelFull, "group" | "isPrivate" | "noValidate">) => CmsPrivateModelFull;
 export {};

package/plugins/CmsModelPlugin.js

@@ -1,55 +1,78 @@
 "use strict";
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
-
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.createCmsModel = exports.CmsModelPlugin = void 0;
-
-var _objectSpread2 = _interopRequireDefault(require("@babel/runtime/helpers/objectSpread2"));
-
-var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
-
-var _plugins = require("@webiny/plugins");
-
+exports.createPrivateModelDefinition = exports.createCmsModel = exports.CmsModelPlugin = void 0;
 var _error = _interopRequireDefault(require("@webiny/error"));
-
-var _createFieldStorageId = require("../crud/contentModel/createFieldStorageId");
-
 var _camelCase = _interopRequireDefault(require("lodash/camelCase"));
-
+var _upperFirst = _interopRequireDefault(require("lodash/upperFirst"));
+var _pluralize = _interopRequireDefault(require("pluralize"));
+var _plugins = require("@webiny/plugins");
+var _createFieldStorageId = require("../crud/contentModel/createFieldStorageId");
+const createApiName = name => {
+  return (0, _upperFirst.default)((0, _camelCase.default)(name));
+};
+const createPluralApiName = name => {
+  return (0, _pluralize.default)(createApiName(name));
+};
 class CmsModelPlugin extends _plugins.Plugin {
+  static type = "cms-content-model";
   constructor(contentModel, options) {
     super();
-    (0, _defineProperty2.default)(this, "contentModel", void 0);
-    (0, _defineProperty2.default)(this, "options", void 0);
     this.options = options || {};
     this.contentModel = this.buildModel(contentModel);
   }
-
   buildModel(input) {
-    const model = (0, _objectSpread2.default)((0, _objectSpread2.default)({}, input), {}, {
+    const isPrivate = input.isPrivate ?? false;
+    const singularApiName = input.singularApiName ? createApiName(input.singularApiName) : createApiName(input.name);
+    const pluralApiName = input.pluralApiName ? createApiName(input.pluralApiName) : createPluralApiName(input.name);
+    const modelPlugin = {
+      group: {
+        id: "",
+        name: ""
+      },
+      description: "",
+      fields: [],
+      isPlugin: true,
+      isPrivate,
+      layout: [],
+      modelId: input.modelId,
+      name: input.name,
+      pluralApiName,
+      singularApiName,
+      titleFieldId: "id"
+    };
+    if (input.noValidate) {
+      /**
+       * We can safely ignore this error, because we are sure noValidate is not a model field.
+       */
+      // @ts-expect-error
+      delete input["noValidate"];
+      return {
+        ...modelPlugin,
+        ...input
+      };
+    }
+    const model = {
+      ...modelPlugin,
+      ...input,
       fields: this.buildFields(input, input.fields)
-    });
+    };
     this.validateLayout(model);
     return model;
   }
-
   buildFields(model, inputFields) {
     if (inputFields.length === 0) {
       throw new _error.default(`Missing fields for the defined model "${model.modelId}".`, "MISSING_FIELDS", {
         model
       });
     }
-
     const fields = [];
     const storageIdList = [];
     const fieldIdList = [];
-
     for (const input of inputFields) {
-      var _settings;
-
       /**
        * Field must contain an fieldId. It is required in the graphql, but lets check it just in case
        */
@@ -59,12 +82,10 @@ class CmsModelPlugin extends _plugins.Plugin {
           field: input
         });
       }
-
       const fieldId = (0, _camelCase.default)(input.fieldId);
       /**
        * FieldID must be in correct pattern.
        */
-
       if (fieldId.match(/^[0-9]/) !== null) {
         throw new _error.default(`Field's "fieldId" does not match correct pattern in the content model "${model.modelId}" - cannot start with a number.`, "FIELD_FIELD_ID_ERROR", {
           model,
@@ -74,8 +95,6 @@ class CmsModelPlugin extends _plugins.Plugin {
       /**
        * FieldID also must be camelCased.
        */
-
-
       if (fieldId !== input.fieldId) {
         throw new _error.default(`Field's "fieldId" must be a camel cased string in the content model "${model.modelId}".`, "FIELD_FIELD_ID_ERROR", {
           model,
@@ -85,20 +104,16 @@ class CmsModelPlugin extends _plugins.Plugin {
       /**
        * ... and fieldId must be unique.
        */
-
-
-      if (fieldIdList.includes(fieldId) === true) {
+      if (fieldIdList.includes(fieldId)) {
         throw new _error.default(`Field's "fieldId" is not unique in the content model "${model.modelId}".`, "FIELD_ID_NOT_UNIQUE_ERROR", {
           model,
           field: input
         });
       }
-
       let storageId = input.storageId ? (0, _camelCase.default)(input.storageId) : null;
       /**
        * If defined, storageId MUST be camel cased string - for backward compatibility.
        */
-
       if (storageId && (storageId.match(/^([a-zA-Z-0-9]+)$/) === null || storageId !== input.storageId)) {
         throw new _error.default(`Field's "storageId" of the field with "fieldId" ${input.fieldId} is not camel cased string in the content model "${model.modelId}".`, "STORAGE_ID_NOT_CAMEL_CASED_ERROR", {
           model,
@@ -108,48 +123,43 @@ class CmsModelPlugin extends _plugins.Plugin {
       } else if (!storageId) {
         storageId = (0, _createFieldStorageId.createFieldStorageId)(input);
       }
+
       /**
        * Fields storageId must be unique.
        */
-
-
-      if (storageIdList.includes(storageId) === true) {
+      if (storageIdList.includes(storageId)) {
         throw new _error.default(`Field's "storageId" is not unique in the content model "${model.modelId}".`, "STORAGE_ID_ERROR", {
           model,
           field: input
         });
       }
+
       /**
        * We can safely ignore error because we are going through the fields and making sure each has storageId.
        */
-      // @ts-ignore
-
-
+      // @ts-expect-error
       let settings = input.settings;
-      const childFields = ((_settings = settings) === null || _settings === void 0 ? void 0 : _settings.fields) || [];
-
+      const childFields = settings?.fields || [];
       if (input.type === "object" && childFields.length > 0) {
-        settings = (0, _objectSpread2.default)((0, _objectSpread2.default)({}, settings || {}), {}, {
+        settings = {
+          ...(settings || {}),
           fields: this.buildFields(model, childFields)
-        });
+        };
       }
-
-      const field = (0, _objectSpread2.default)((0, _objectSpread2.default)({}, input), {}, {
+      const field = {
+        ...input,
         settings,
         storageId
-      });
+      };
       /**
        * Add all relevant data to arrays.
        */
-
       fields.push(field);
       storageIdList.push(field.storageId);
       fieldIdList.push(field.fieldId);
     }
-
     return fields;
   }
-
   validateLayout(model) {
     /**
      * Only skip validation if option.validateLayout was set as false, explicitly.
@@ -157,15 +167,12 @@ class CmsModelPlugin extends _plugins.Plugin {
     if (this.options.validateLayout === false) {
       return;
     }
-
     for (const field of model.fields) {
       let total = 0;
-
       for (const row of model.layout) {
         const count = row.filter(cell => cell === field.id).length;
         total = total + count;
       }
-
       if (total === 1) {
         continue;
       } else if (total > 1) {
@@ -174,21 +181,29 @@ class CmsModelPlugin extends _plugins.Plugin {
           field
         });
       }
-
       throw new _error.default(`Missing field "${field.id}" in layout.`, "MISSING_FIELD_IN_LAYOUT", {
         model,
         field
       });
     }
   }
-
 }
-
 exports.CmsModelPlugin = CmsModelPlugin;
-(0, _defineProperty2.default)(CmsModelPlugin, "type", "cms-content-model");
-
 const createCmsModel = (model, options) => {
   return new CmsModelPlugin(model, options);
 };
+exports.createCmsModel = createCmsModel;
+const createPrivateModelDefinition = input => {
+  return {
+    ...input,
+    isPrivate: true,
+    noValidate: true,
+    group: {
+      id: "private",
+      name: "Private Models"
+    }
+  };
+};
+exports.createPrivateModelDefinition = createPrivateModelDefinition;
 
-exports.createCmsModel = createCmsModel;
+//# sourceMappingURL=CmsModelPlugin.js.map