@webiny/api-headless-cms 0.0.0-unstable.df6d94b531 → 0.0.0-unstable.df7a8bb475

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,QAAQ,EAAE,MAAM,EAAE,SAAS,CAAC;AAE9D,MAAMC,yBAAyB,GAAG,MAAM;EAC3C,OAAO,IAAIC,wCAAmB,CAAC,MAAMC,OAAO,IAAI;IAAA;IAC5C;AACR;AACA;IACQ,IAAI,sBAACA,OAAO,CAACC,OAAO,6CAAf,iBAAiBC,MAAM,GAAE;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,IAAI,CAAgB,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;AAAC"}
+{"version":3,"names":["CmsParametersPlugin","createPathParameterPlugin","context","request","params","type"],"sources":["path.ts"],"sourcesContent":["import { CmsParametersPlugin } from \"~/plugins/CmsParametersPlugin.js\";\nimport type { ApiEndpoint } from \"~/types/index.js\";\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 } = context.request.params as Record<string, string | null>;\n\n        if (!type) {\n            return null;\n        }\n\n        return {\n            type: type as ApiEndpoint\n        };\n    });\n};\n"],"mappings":"AAAA,SAASA,mBAAmB;AAG5B,OAAO,MAAMC,yBAAyB,GAAGA,CAAA,KAAM;EAC3C,OAAO,IAAID,mBAAmB,CAAC,MAAME,OAAO,IAAI;IAC5C;AACR;AACA;IACQ,IAAI,CAACA,OAAO,CAACC,OAAO,EAAEC,MAAM,EAAE;MAC1B,OAAO,IAAI;IACf;IAEA,MAAM;MAAEC;IAAK,CAAC,GAAGH,OAAO,CAACC,OAAO,CAACC,MAAuC;IAExE,IAAI,CAACC,IAAI,EAAE;MACP,OAAO,IAAI;IACf;IAEA,OAAO;MACHA,IAAI,EAAEA;IACV,CAAC;EACL,CAAC,CAAC;AACN,CAAC","ignoreList":[]}

package/plugins/CmsGraphQLSchemaPlugin/CmsGraphQLSchemaPlugin.d.ts

@@ -0,0 +1,9 @@
+import type { GraphQLSchemaPluginConfig as BaseGraphQLSchemaPluginConfig, IGraphQLSchemaPlugin } from "@webiny/handler-graphql";
+import { GraphQLSchemaPlugin } from "@webiny/handler-graphql";
+import type { CmsContext } from "../../types/index.js";
+export type ICmsGraphQLSchemaPlugin<T extends CmsContext = CmsContext> = IGraphQLSchemaPlugin<T>;
+export type CmsGraphQLSchemaPluginConfig<T extends CmsContext = CmsContext> = BaseGraphQLSchemaPluginConfig<T>;
+export declare class CmsGraphQLSchemaPlugin<T extends CmsContext = CmsContext> extends GraphQLSchemaPlugin<T> implements ICmsGraphQLSchemaPlugin<T> {
+    static readonly type = "cms.graphql.schema";
+}
+export declare const createCmsGraphQLSchemaPlugin: <T extends CmsContext = CmsContext>(config: CmsGraphQLSchemaPluginConfig<T>) => ICmsGraphQLSchemaPlugin<T>;

package/plugins/CmsGraphQLSchemaPlugin/CmsGraphQLSchemaPlugin.js

@@ -0,0 +1,9 @@
+import { GraphQLSchemaPlugin } from "@webiny/handler-graphql";
+export class CmsGraphQLSchemaPlugin extends GraphQLSchemaPlugin {
+  static type = "cms.graphql.schema";
+}
+export const createCmsGraphQLSchemaPlugin = config => {
+  return new CmsGraphQLSchemaPlugin(config);
+};
+
+//# sourceMappingURL=CmsGraphQLSchemaPlugin.js.map

package/plugins/CmsGraphQLSchemaPlugin/CmsGraphQLSchemaPlugin.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["GraphQLSchemaPlugin","CmsGraphQLSchemaPlugin","type","createCmsGraphQLSchemaPlugin","config"],"sources":["CmsGraphQLSchemaPlugin.ts"],"sourcesContent":["import type {\n    GraphQLSchemaPluginConfig as BaseGraphQLSchemaPluginConfig,\n    IGraphQLSchemaPlugin\n} from \"@webiny/handler-graphql\";\nimport { GraphQLSchemaPlugin } from \"@webiny/handler-graphql\";\nimport type { CmsContext } from \"~/types/index.js\";\n\nexport type ICmsGraphQLSchemaPlugin<T extends CmsContext = CmsContext> = IGraphQLSchemaPlugin<T>;\n\nexport type CmsGraphQLSchemaPluginConfig<T extends CmsContext = CmsContext> =\n    BaseGraphQLSchemaPluginConfig<T>;\n\nexport class CmsGraphQLSchemaPlugin<T extends CmsContext = CmsContext>\n    extends GraphQLSchemaPlugin<T>\n    implements ICmsGraphQLSchemaPlugin<T>\n{\n    public static override readonly type = \"cms.graphql.schema\";\n}\n\nexport const createCmsGraphQLSchemaPlugin = <T extends CmsContext = CmsContext>(\n    config: CmsGraphQLSchemaPluginConfig<T>\n): ICmsGraphQLSchemaPlugin<T> => {\n    return new CmsGraphQLSchemaPlugin(config);\n};\n"],"mappings":"AAIA,SAASA,mBAAmB,QAAQ,yBAAyB;AAQ7D,OAAO,MAAMC,sBAAsB,SACvBD,mBAAmB,CAE/B;EACI,OAAgCE,IAAI,GAAG,oBAAoB;AAC/D;AAEA,OAAO,MAAMC,4BAA4B,GACrCC,MAAuC,IACV;EAC7B,OAAO,IAAIH,sBAAsB,CAACG,MAAM,CAAC;AAC7C,CAAC","ignoreList":[]}

package/plugins/CmsGraphQLSchemaPlugin/index.d.ts

@@ -0,0 +1 @@
+export * from "./CmsGraphQLSchemaPlugin.js";

package/plugins/CmsGraphQLSchemaPlugin/index.js

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

package/plugins/CmsGraphQLSchemaPlugin/index.js.map

@@ -0,0 +1 @@
+{"version":3,"names":[],"sources":["index.ts"],"sourcesContent":["export * from \"./CmsGraphQLSchemaPlugin.js\";\n"],"mappings":"AAAA","ignoreList":[]}

package/plugins/CmsGraphQLSchemaSorterPlugin.d.ts

@@ -1,5 +1,5 @@
 import { Plugin } from "@webiny/plugins";
-import { CmsModel } from "../types";
+import type { CmsModel } from "../types/index.js";
 interface CmsGraphQLSchemaSorterPluginCallableParams {
     model: CmsModel;
     sorters: string[];

package/plugins/CmsGraphQLSchemaSorterPlugin.js

@@ -1,16 +1,8 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.createCmsGraphQLSchemaSorterPlugin = exports.CmsGraphQLSchemaSorterPlugin = void 0;
-var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
-var _plugins = require("@webiny/plugins");
-class CmsGraphQLSchemaSorterPlugin extends _plugins.Plugin {
+import { Plugin } from "@webiny/plugins";
+export class CmsGraphQLSchemaSorterPlugin extends Plugin {
+  static type = "cms.graphql.schema.sorter";
   constructor(cb) {
     super();
-    (0, _defineProperty2.default)(this, "cb", void 0);
     this.cb = cb;
   }
   /**
@@ -20,9 +12,8 @@ class CmsGraphQLSchemaSorterPlugin extends _plugins.Plugin {
     return this.cb(params);
   }
 }
-exports.CmsGraphQLSchemaSorterPlugin = CmsGraphQLSchemaSorterPlugin;
-(0, _defineProperty2.default)(CmsGraphQLSchemaSorterPlugin, "type", "cms.graphql.schema.sorter");
-const createCmsGraphQLSchemaSorterPlugin = cb => {
+export const createCmsGraphQLSchemaSorterPlugin = cb => {
   return new CmsGraphQLSchemaSorterPlugin(cb);
 };
-exports.createCmsGraphQLSchemaSorterPlugin = createCmsGraphQLSchemaSorterPlugin;
+
+//# sourceMappingURL=CmsGraphQLSchemaSorterPlugin.js.map

package/plugins/CmsGraphQLSchemaSorterPlugin.js.map

@@ -1 +1 @@
-{"version":3,"names":["CmsGraphQLSchemaSorterPlugin","Plugin","constructor","cb","createSorter","params","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;AAUO,MAAMA,4BAA4B,SAASC,eAAM,CAAC;EAI9CC,WAAW,CAACC,EAAwC,EAAE;IACzD,KAAK,EAAE;IAAC;IAER,IAAI,CAACA,EAAE,GAAGA,EAAE;EAChB;EACA;AACJ;AACA;EACWC,YAAY,CAACC,MAAkD,EAAY;IAC9E,OAAO,IAAI,CAACF,EAAE,CAACE,MAAM,CAAC;EAC1B;AACJ;AAAC;AAAA,8BAfYL,4BAA4B,UACU,2BAA2B;AAgBvE,MAAMM,kCAAkC,GAC3CH,EAAwC,IACT;EAC/B,OAAO,IAAIH,4BAA4B,CAACG,EAAE,CAAC;AAC/C,CAAC;AAAC"}
+{"version":3,"names":["Plugin","CmsGraphQLSchemaSorterPlugin","type","constructor","cb","createSorter","params","createCmsGraphQLSchemaSorterPlugin"],"sources":["CmsGraphQLSchemaSorterPlugin.ts"],"sourcesContent":["import { Plugin } from \"@webiny/plugins\";\nimport type { CmsModel } from \"~/types/index.js\";\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,SAASA,MAAM,QAAQ,iBAAiB;AAUxC,OAAO,MAAMC,4BAA4B,SAASD,MAAM,CAAC;EACrD,OAAgCE,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;AAEA,OAAO,MAAMC,kCAAkC,GAC3CH,EAAwC,IACT;EAC/B,OAAO,IAAIH,4BAA4B,CAACG,EAAE,CAAC;AAC/C,CAAC","ignoreList":[]}

package/plugins/CmsGroupPlugin.d.ts

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

package/plugins/CmsGroupPlugin.js

@@ -1,22 +1,30 @@
-"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 {
+import { Plugin } from "@webiny/plugins";
+export class CmsGroupPlugin extends 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 => {
+
+/**
+ * @deprecated Use `createCmsGroupPlugin` instead.
+ */
+export const createCmsGroup = group => {
+  return new CmsGroupPlugin(group);
+};
+
+/**
+ * @deprecated Use `createModelGroupPlugin` instead.
+ */
+export const createCmsGroupPlugin = group => {
+  return new CmsGroupPlugin(group);
+};
+export const createModelGroupPlugin = group => {
   return new CmsGroupPlugin(group);
 };
-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,cAAc,SAASC,eAAM,CAAC;EAIvCC,WAAW,CAACC,iBAA2B,EAAE;IACrC,KAAK,EAAE;IAAC;IACR,IAAI,CAACA,iBAAiB,GAAGA,iBAAiB;EAC9C;AACJ;AAAC;AAAA,8BARYH,cAAc,UACwB,yBAAyB;AASrE,MAAMI,cAAc,GAAIC,KAAe,IAAqB;EAC/D,OAAO,IAAIL,cAAc,CAACK,KAAK,CAAC;AACpC,CAAC;AAAC"}
+{"version":3,"names":["Plugin","CmsGroupPlugin","type","constructor","contentModelGroup","isPlugin","createCmsGroup","group","createCmsGroupPlugin","createModelGroupPlugin"],"sources":["CmsGroupPlugin.ts"],"sourcesContent":["import { Plugin } from \"@webiny/plugins\";\nimport type { CmsGroup as BaseCmsGroup } from \"~/types/index.js\";\n\nexport interface CmsGroupInput extends Omit<BaseCmsGroup, \"tenant\" | \"isPlugin\"> {\n    tenant?: string;\n}\n\nexport interface CmsGroup extends Omit<BaseCmsGroup, \"tenant\"> {\n    tenant?: 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\n/**\n * @deprecated Use `createCmsGroupPlugin` instead.\n */\nexport const createCmsGroup = (group: CmsGroup): CmsGroupPlugin => {\n    return new CmsGroupPlugin(group);\n};\n\n/**\n * @deprecated Use `createModelGroupPlugin` instead.\n */\nexport const createCmsGroupPlugin = (group: CmsGroup): CmsGroupPlugin => {\n    return new CmsGroupPlugin(group);\n};\n\nexport const createModelGroupPlugin = (group: CmsGroup): CmsGroupPlugin => {\n    return new CmsGroupPlugin(group);\n};\n"],"mappings":"AAAA,SAASA,MAAM,QAAQ,iBAAiB;AAWxC,OAAO,MAAMC,cAAc,SAASD,MAAM,CAAC;EACvC,OAAgCE,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;;AAEA;AACA;AACA;AACA,OAAO,MAAMC,cAAc,GAAIC,KAAe,IAAqB;EAC/D,OAAO,IAAIN,cAAc,CAACM,KAAK,CAAC;AACpC,CAAC;;AAED;AACA;AACA;AACA,OAAO,MAAMC,oBAAoB,GAAID,KAAe,IAAqB;EACrE,OAAO,IAAIN,cAAc,CAACM,KAAK,CAAC;AACpC,CAAC;AAED,OAAO,MAAME,sBAAsB,GAAIF,KAAe,IAAqB;EACvE,OAAO,IAAIN,cAAc,CAACM,KAAK,CAAC;AACpC,CAAC","ignoreList":[]}

package/plugins/CmsModelFieldConverterPlugin.d.ts

@@ -1,6 +1,9 @@
+/**
+ * Field converters are used to convert the fieldId to storageId and vice versa.
+ */
 import { Plugin } from "@webiny/plugins";
-import { CmsEntryValues, CmsModelFieldWithParent } from "../types";
-import { ConverterCollection } from "../utils/converters/ConverterCollection";
+import type { CmsEntryValues, CmsModelFieldWithParent } from "../types/index.js";
+import type { ConverterCollection } from "../utils/converters/ConverterCollection.js";
 export interface ConvertParams<F = CmsModelFieldWithParent> {
     field: F;
     value: any;

package/plugins/CmsModelFieldConverterPlugin.js

@@ -1,12 +1,9 @@
-"use strict";
+/**
+ * Field converters are used to convert the fieldId to storageId and vice versa.
+ */
+import { Plugin } from "@webiny/plugins";
+export class CmsModelFieldConverterPlugin extends Plugin {
+  static type = "cms.field.converter";
+}
 
-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 {}
-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<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;AAUO,MAAeA,4BAA4B,SAASC,eAAM,CAAC;AAOjE;AAAA,8BAPqBD,4BAA4B,UAChB,qBAAqB"}
+{"version":3,"names":["Plugin","CmsModelFieldConverterPlugin","type"],"sources":["CmsModelFieldConverterPlugin.ts"],"sourcesContent":["/**\n * Field converters are used to convert the fieldId to storageId and vice versa.\n */\nimport { Plugin } from \"@webiny/plugins\";\nimport type { CmsEntryValues, CmsModelFieldWithParent } from \"~/types/index.js\";\nimport type { ConverterCollection } from \"~/utils/converters/ConverterCollection.js\";\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;AACA;AACA;AACA,SAASA,MAAM,QAAQ,iBAAiB;AAUxC,OAAO,MAAeC,4BAA4B,SAASD,MAAM,CAAC;EAC9D,OAAuBE,IAAI,GAAG,qBAAqB;AAMvD","ignoreList":[]}

package/plugins/CmsModelPlugin.d.ts

@@ -1,5 +1,5 @@
 import { Plugin } from "@webiny/plugins";
-import { CmsModel as CmsModelBase, CmsModelField as CmsModelFieldBase, CmsModelFieldSettings as BaseCmsModelFieldSettings } from "../types";
+import type { CmsModel as CmsModelBase, CmsModelField as CmsModelFieldBase, CmsModelFieldSettings as BaseCmsModelFieldSettings } from "../types/index.js";
 interface CmsModelFieldSettings extends Omit<BaseCmsModelFieldSettings, "fields"> {
     /**
      * Object field has child fields.
@@ -12,7 +12,7 @@ interface CmsModelFieldInput extends Omit<CmsModelFieldBase, "storageId" | "sett
      * This is for backwards compatibility - before fields had storageId.
      *
      * This should only be populated in old model fields.
-     * News ones must have this empty.
+     * New ones must have this empty.
      */
     storageId?: string;
     /**
@@ -20,23 +20,29 @@ interface CmsModelFieldInput extends Omit<CmsModelFieldBase, "storageId" | "sett
      */
     settings?: CmsModelFieldSettings;
 }
-interface CmsApiModel extends Omit<CmsModelBase, "isPrivate" | "locale" | "tenant" | "webinyVersion" | "fields"> {
+export interface CmsApiModel extends Omit<CmsModelPluginModel, "isPrivate" | "fields" | "singularApiName" | "pluralApiName" | "isPlugin"> {
     isPrivate?: never;
+    noValidate?: boolean;
+    singularApiName?: string;
+    pluralApiName?: string;
     fields: CmsModelFieldInput[];
-    locale?: string;
-    tenant?: string;
 }
-interface CmsPrivateModel extends Omit<CmsModelBase, "isPrivate" | "singularApiName" | "pluralApiName" | "locale" | "tenant" | "webinyVersion" | "fields"> {
+export interface CmsApiModelFull extends Omit<CmsApiModel, "fields"> {
+    fields: CmsModelFieldBase[];
+}
+interface CmsPrivateModel extends Omit<CmsModelPluginModel, "isPrivate" | "singularApiName" | "pluralApiName" | "fields" | "isPlugin" | "layout" | "icon" | "titleFieldId" | "description"> {
+    noValidate?: boolean;
+    titleFieldId?: string;
     singularApiName?: never;
     pluralApiName?: never;
     isPrivate: true;
     fields: CmsModelFieldInput[];
-    locale?: string;
-    tenant?: string;
 }
-declare type CmsModelInput = CmsApiModel | CmsPrivateModel;
-interface CmsModel extends Omit<CmsModelBase, "locale" | "tenant" | "webinyVersion"> {
-    locale?: string;
+export interface CmsPrivateModelFull extends Omit<CmsPrivateModel, "fields" | "createdBy" | "createdOn" | "savedOn"> {
+    fields: CmsModelFieldBase[];
+}
+export type CmsModelInput = CmsApiModel | CmsPrivateModel | CmsApiModelFull | CmsPrivateModelFull;
+export interface CmsModelPluginModel extends Omit<CmsModelBase, "tenant"> {
     tenant?: string;
 }
 interface CmsModelPluginOptions {
@@ -44,12 +50,21 @@ 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;
     private buildFields;
     private validateLayout;
 }
-export declare const createCmsModel: (model: CmsModelInput, options?: CmsModelPluginOptions) => CmsModelPlugin;
+/**
+ * IMPORTANT! This function should NOT be used outside the `api-headless-cms` package!
+ * @internal
+ */
+export declare const createModelPlugin: (model: CmsModelInput, options?: CmsModelPluginOptions) => CmsModelPlugin;
+/**
+ * IMPORTANT! This function should NOT be used outside the `api-headless-cms` package!
+ * @internal
+ */
+export declare const createPrivateModelPlugin: (input: Omit<CmsPrivateModelFull, "group" | "isPrivate">) => CmsModelPlugin;
 export {};

package/plugins/CmsModelPlugin.js

@@ -1,45 +1,69 @@
-"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 _error = _interopRequireDefault(require("@webiny/error"));
-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 transformNameToSingularApiName = name => {
-  return (0, _upperFirst.default)((0, _camelCase.default)(name));
+import WebinyError from "@webiny/error";
+import lodashCamelCase from "lodash/camelCase.js";
+import camelCase from "lodash/camelCase.js";
+import upperFirst from "lodash/upperFirst.js";
+import pluralize from "pluralize";
+import { Plugin } from "@webiny/plugins";
+import { createFieldStorageId } from "../crud/contentModel/createFieldStorageId.js";
+import { validateStorageId } from "../crud/contentModel/validateStorageId.js";
+const createApiName = name => {
+  return upperFirst(camelCase(name));
 };
-const transformNameToPluralApiName = name => {
-  return (0, _pluralize.default)(transformNameToSingularApiName(name));
+const createPluralApiName = name => {
+  return pluralize(createApiName(name));
 };
-class CmsModelPlugin extends _plugins.Plugin {
+export class CmsModelPlugin extends 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), {}, {
-      isPrivate: input.isPrivate || false,
-      singularApiName: input.singularApiName || transformNameToSingularApiName(input.name),
-      pluralApiName: input.pluralApiName || transformNameToPluralApiName(input.name),
+    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: input.group ?? "ungrouped",
+      description: "",
+      fields: [],
+      isPlugin: true,
+      isPrivate,
+      icon: null,
+      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.
+       */
+      delete input["noValidate"];
+      return {
+        ...modelPlugin,
+        ...input,
+        // Since `noValidate` is set, we trust the input, and cast to `CmsModelFieldBase`.
+        fields: input.fields,
+        pluralApiName,
+        singularApiName
+      };
+    }
+    const model = {
+      ...modelPlugin,
+      ...input,
+      pluralApiName,
+      singularApiName,
       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", {
+      throw new WebinyError(`Missing fields for the defined model "${model.modelId}".`, "MISSING_FIELDS", {
         model
       });
     }
@@ -47,22 +71,21 @@ class CmsModelPlugin extends _plugins.Plugin {
     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
        */
       if (!(input.fieldId || "").trim()) {
-        throw new _error.default(`Field's "storageId" is not defined for the content model "${model.modelId}".`, "FIELD_ID_ERROR", {
+        throw new WebinyError(`Field's "storageId" is not defined for the content model "${model.modelId}".`, "FIELD_ID_ERROR", {
           model,
           field: input
         });
       }
-      const fieldId = (0, _camelCase.default)(input.fieldId);
+      const fieldId = lodashCamelCase(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", {
+        throw new WebinyError(`Field's "fieldId" does not match correct pattern in the content model "${model.modelId}" - cannot start with a number.`, "FIELD_FIELD_ID_ERROR", {
           model,
           field: input
         });
@@ -71,7 +94,7 @@ 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", {
+        throw new WebinyError(`Field's "fieldId" must be a camel cased string in the content model "${model.modelId}".`, "FIELD_FIELD_ID_ERROR", {
           model,
           field: input
         });
@@ -79,31 +102,34 @@ class CmsModelPlugin extends _plugins.Plugin {
       /**
        * ... and fieldId must be unique.
        */
-      if (fieldIdList.includes(fieldId) === true) {
-        throw new _error.default(`Field's "fieldId" is not unique in the content model "${model.modelId}".`, "FIELD_ID_NOT_UNIQUE_ERROR", {
+      if (fieldIdList.includes(fieldId)) {
+        throw new WebinyError(`Field's "fieldId" (id: ${input.id}) 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,
-          storageId,
-          field: input
-        });
-      } else if (!storageId) {
-        storageId = (0, _createFieldStorageId.createFieldStorageId)(input);
+      let storageId = input.storageId;
+      if (storageId) {
+        try {
+          validateStorageId(storageId);
+        } catch (e) {
+          throw WebinyError.from(e, {
+            data: {
+              model,
+              storageId,
+              field: input
+            }
+          });
+        }
+      } else {
+        storageId = createFieldStorageId(input);
       }
 
       /**
        * Fields storageId must be unique.
        */
-      if (storageIdList.includes(storageId) === true) {
-        throw new _error.default(`Field's "storageId" is not unique in the content model "${model.modelId}".`, "STORAGE_ID_ERROR", {
+      if (storageIdList.includes(storageId)) {
+        throw new WebinyError(`Field's "storageId" is not unique in the content model "${model.modelId}".`, "STORAGE_ID_ERROR", {
           model,
           field: input
         });
@@ -112,18 +138,20 @@ class CmsModelPlugin extends _plugins.Plugin {
       /**
        * 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.
        */
@@ -149,21 +177,41 @@ class CmsModelPlugin extends _plugins.Plugin {
       if (total === 1) {
         continue;
       } else if (total > 1) {
-        throw new _error.default(`Field "${field.id}" is in more than one layout cell.`, "DUPLICATE_FIELD_IN_LAYOUT", {
+        throw new WebinyError(`Field "${field.id}" is in more than one layout cell.`, "DUPLICATE_FIELD_IN_LAYOUT", {
           model,
           field
         });
       }
-      throw new _error.default(`Missing field "${field.id}" in layout.`, "MISSING_FIELD_IN_LAYOUT", {
+      throw new WebinyError(`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) => {
+
+/**
+ * IMPORTANT! This function should NOT be used outside the `api-headless-cms` package!
+ * @internal
+ */
+export const createModelPlugin = (model, options) => {
   return new CmsModelPlugin(model, options);
 };
-exports.createCmsModel = createCmsModel;
+
+/**
+ * IMPORTANT! This function should NOT be used outside the `api-headless-cms` package!
+ * @internal
+ */
+export const createPrivateModelPlugin = input => {
+  return createModelPlugin({
+    authorization: false,
+    noValidate: true,
+    isPrivate: true,
+    group: "private",
+    ...input
+  }, {
+    validateLayout: false
+  });
+};
+
+//# sourceMappingURL=CmsModelPlugin.js.map