@webiny/api-headless-cms 5.22.0 → 5.23.0-beta.1

package/content/contextSetup.js

@@ -7,58 +7,58 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = void 0;
 
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+
 var _error = _interopRequireDefault(require("@webiny/error"));
 
 var _handler = require("@webiny/handler");
 
-const extractHandlerHttpParameters = context => {
-  var _context$http, _context$http$request, _context$http$request2;
+var _CmsParametersPlugin = require("./plugins/CmsParametersPlugin");
+
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { (0, _defineProperty2.default)(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
 
-  const {
-    key = ""
-  } = ((_context$http = context.http) === null || _context$http === void 0 ? void 0 : (_context$http$request = _context$http.request) === null || _context$http$request === void 0 ? void 0 : (_context$http$request2 = _context$http$request.path) === null || _context$http$request2 === void 0 ? void 0 : _context$http$request2.parameters) || {};
-  const [type, locale] = key.split("/");
+const getParameters = async context => {
+  const plugins = context.plugins.byType(_CmsParametersPlugin.CmsParametersPlugin.type);
 
-  if (!type) {
-    throw new _error.default(`Missing context.http.request.path parameter "type".`);
-  } else if (!locale) {
-    throw new _error.default(`Missing context.http.request.path parameter "locale".`);
+  for (const plugin of plugins) {
+    const result = await plugin.getParameters(context);
+
+    if (result !== null) {
+      return result;
+    }
   }
 
-  return {
-    type,
-    locale
-  };
+  throw new _error.default("Could not determine locale and/or type of the CMS.", "CMS_LOCALE_AND_TYPE_ERROR");
 };
 
 var _default = () => {
   return new _handler.ContextPlugin(async context => {
-    var _context$http2, _context$http2$reques;
+    var _context$http, _context$http$request;
 
-    if (((_context$http2 = context.http) === null || _context$http2 === void 0 ? void 0 : (_context$http2$reques = _context$http2.request) === null || _context$http2$reques === void 0 ? void 0 : _context$http2$reques.method) === "OPTIONS") {
+    if (((_context$http = context.http) === null || _context$http === void 0 ? void 0 : (_context$http$request = _context$http.request) === null || _context$http$request === void 0 ? void 0 : _context$http$request.method) === "OPTIONS") {
       return;
-    } else if (context.cms) {
-      throw new _error.default("Context setup plugin must be first to be registered. Cannot have anything before it.", "CMS_CONTEXT_INITIALIZED_ERROR");
     }
 
     const {
       type,
       locale
-    } = extractHandlerHttpParameters(context);
+    } = await getParameters(context);
     const systemLocale = context.i18n.getLocale(locale);
 
     if (!systemLocale) {
       throw new _error.default(`There is no locale "${locale}" in the system.`);
     }
 
-    context.cms = {
+    context.cms = _objectSpread(_objectSpread({}, context.cms || {}), {}, {
       type,
       locale,
       getLocale: () => systemLocale,
       READ: type === "read",
       PREVIEW: type === "preview",
       MANAGE: type === "manage"
-    };
+    });
   });
 };
 

package/content/graphQLHandlerFactory.js

@@ -142,7 +142,7 @@ const graphQLHandlerFactory = (options = {}) => {
         http
       } = context;
 
-      if (!http || !http.request || !http.request.path || !http.request.path.parameters) {
+      if (!http || !http.request) {
         return next();
       }
 

package/content/parameterPlugins.d.ts

@@ -0,0 +1,6 @@
+import { CmsParametersPlugin, CmsParametersPluginResponse } from "./plugins/CmsParametersPlugin";
+export interface CreateParametersPluginsParams {
+    endpointType?: CmsParametersPluginResponse["type"];
+    locale?: CmsParametersPluginResponse["locale"];
+}
+export declare const createParametersPlugins: (params: CreateParametersPluginsParams) => CmsParametersPlugin[];

package/content/parameterPlugins.js

@@ -0,0 +1,78 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createParametersPlugins = void 0;
+
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+
+var _error = _interopRequireDefault(require("@webiny/error"));
+
+var _CmsParametersPlugin = require("./plugins/CmsParametersPlugin");
+
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { (0, _defineProperty2.default)(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+
+const createRequestPlugin = () => {
+  return new _CmsParametersPlugin.CmsParametersPlugin(async context => {
+    /**
+     * If any of the properties is not defined, just ignore this plugin
+     */
+    if (!context.http || !context.http.request || !context.http.request.path || !context.http.request.path.parameters) {
+      return null;
+    }
+
+    const {
+      key
+    } = context.http.request.path.parameters;
+
+    if (typeof key !== "string") {
+      throw new _error.default("The key property in context.http.request.path.parameters is not a string.", "MALFORMED_KEY", {
+        key
+      });
+    }
+
+    const [type, locale] = key.split("/");
+
+    if (!type) {
+      throw new _error.default(`Missing context.http.request.path.parameters.key parameter "type".`);
+    } else if (!locale) {
+      throw new _error.default(`Missing context.http.request.path.parameters.key "locale".`);
+    }
+
+    return {
+      type,
+      locale
+    };
+  });
+};
+
+const createManualPlugin = params => {
+  return new _CmsParametersPlugin.CmsParametersPlugin(async () => {
+    /**
+     * if both of parameters are not existing, just skip this plugin.
+     */
+    if (!params.endpointType && !params.locale) {
+      return null;
+    } else if (!params.endpointType) {
+      throw new _error.default(`There is defined locale CMS parameter but no endpointType.`, "MALFORMED_ENDPOINT_TYPE", _objectSpread({}, params));
+    } else if (!params.locale) {
+      throw new _error.default(`There is defined endpointType CMS parameter but no locale.`, "MALFORMED_LOCALE_TYPE", _objectSpread({}, params));
+    }
+
+    return {
+      type: params.endpointType,
+      locale: params.locale
+    };
+  });
+};
+
+const createParametersPlugins = params => {
+  return [createManualPlugin(params), createRequestPlugin()];
+};
+
+exports.createParametersPlugins = createParametersPlugins;

package/content/plugins/CmsParametersPlugin.d.ts

@@ -0,0 +1,15 @@
+import { Plugin } from "@webiny/plugins";
+import { CmsContext } from "../../types";
+export interface CmsParametersPluginResponse {
+    type: "read" | "manage" | "preview" | string;
+    locale: string;
+}
+export interface CmsParametersPluginCallable {
+    (context: CmsContext): Promise<CmsParametersPluginResponse>;
+}
+export declare class CmsParametersPlugin extends Plugin {
+    static readonly type: string;
+    private readonly callable;
+    constructor(callable: CmsParametersPluginCallable);
+    getParameters(context: CmsContext): Promise<CmsParametersPluginResponse | null>;
+}

package/content/plugins/CmsParametersPlugin.js

@@ -0,0 +1,28 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.CmsParametersPlugin = void 0;
+
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+
+var _plugins = require("@webiny/plugins");
+
+class CmsParametersPlugin extends _plugins.Plugin {
+  constructor(callable) {
+    super();
+    (0, _defineProperty2.default)(this, "callable", void 0);
+    this.callable = callable;
+  }
+
+  async getParameters(context) {
+    return this.callable(context);
+  }
+
+}
+
+exports.CmsParametersPlugin = CmsParametersPlugin;
+(0, _defineProperty2.default)(CmsParametersPlugin, "type", "cms-parameters-plugin");

package/content/plugins/graphqlFields/object.js

@@ -45,10 +45,7 @@ const typeFromField = ({
   const replace = new RegExp(`${mTypeName}_`, "g");
 
   for (const f of fields) {
-    const {
-      fields,
-      typeDefs
-    } = typeOfType === "type" ? (0, _renderFields.renderField)({
+    const result = typeOfType === "type" ? (0, _renderFields.renderField)({
       field: f,
       type,
       model,
@@ -58,6 +55,15 @@ const typeFromField = ({
       model,
       fieldTypePlugins
     });
+
+    if (!result) {
+      continue;
+    }
+
+    const {
+      fields,
+      typeDefs
+    } = result;
     typeFields.push(fields.replace(replace, `${fieldTypeName}_`));
 
     if (typeDefs) {

package/content/plugins/utils/renderInputFields.js

@@ -32,7 +32,7 @@ const renderInputField = ({
 
   if (!plugin) {
     // Let's not render the field if it does not exist in the field plugins.
-    return;
+    return null;
   }
 
   const def = plugin.manage.createInputField({

package/index.d.ts

@@ -2,11 +2,16 @@ import { Params as CreateAdminCrudsParams } from "./plugins/crud";
 import { Params as CreateContentCrudsParams } from "./content/plugins/crud";
 import { CreateGraphQLHandlerOptions } from "./content/graphQLHandlerFactory";
 import { StorageTransformPlugin } from "./content/plugins/storage/StorageTransformPlugin";
+import { CreateParametersPluginsParams } from "./content/parameterPlugins";
+import { CmsParametersPlugin } from "./content/plugins/CmsParametersPlugin";
+import { CmsGroupPlugin } from "./content/plugins/CmsGroupPlugin";
+import { CmsModelPlugin } from "./content/plugins/CmsModelPlugin";
 export declare type AdminContextParams = CreateAdminCrudsParams;
 export declare const createAdminHeadlessCmsContext: (params: AdminContextParams) => (import("@webiny/handler").ContextPlugin<import("./types").CmsContext> | import("@webiny/api-upgrade").UpgradePlugin<import("./types").CmsContext>[])[];
 export declare const createAdminHeadlessCmsGraphQL: () => import("@webiny/handler-graphql/types").GraphQLSchemaPlugin<import("@webiny/handler/types").Context>;
-export declare type ContentContextParams = CreateContentCrudsParams;
-export declare const createContentHeadlessCmsContext: (params: ContentContextParams) => (import("./types").ModelManagerPlugin | import("./types").CmsModelFieldToGraphQLPlugin[] | StorageTransformPlugin<any, any> | import("@webiny/handler").ContextPlugin<import("./types").CmsContext> | (import("./types").CmsModelFieldValidatorPlugin | import("./types").CmsModelFieldPatternValidatorPlugin[])[])[];
+export interface ContentContextParams extends CreateContentCrudsParams, CreateParametersPluginsParams {
+}
+export declare const createContentHeadlessCmsContext: (params: ContentContextParams) => (import("./types").ModelManagerPlugin | import("./types").CmsModelFieldToGraphQLPlugin[] | StorageTransformPlugin<any, any> | import("@webiny/handler").ContextPlugin<import("./types").CmsContext> | CmsParametersPlugin[] | (import("./types").CmsModelFieldValidatorPlugin | import("./types").CmsModelFieldPatternValidatorPlugin[])[])[];
 export declare type ContentGraphQLParams = CreateGraphQLHandlerOptions;
 export declare const createContentHeadlessCmsGraphQL: (params?: ContentGraphQLParams) => import("@webiny/plugins/types").PluginCollection;
-export { StorageTransformPlugin };
+export { StorageTransformPlugin, CmsParametersPlugin, CmsGroupPlugin, CmsModelPlugin };

package/index.js

@@ -5,6 +5,24 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+Object.defineProperty(exports, "CmsGroupPlugin", {
+  enumerable: true,
+  get: function () {
+    return _CmsGroupPlugin.CmsGroupPlugin;
+  }
+});
+Object.defineProperty(exports, "CmsModelPlugin", {
+  enumerable: true,
+  get: function () {
+    return _CmsModelPlugin.CmsModelPlugin;
+  }
+});
+Object.defineProperty(exports, "CmsParametersPlugin", {
+  enumerable: true,
+  get: function () {
+    return _CmsParametersPlugin.CmsParametersPlugin;
+  }
+});
 Object.defineProperty(exports, "StorageTransformPlugin", {
   enumerable: true,
   get: function () {
@@ -39,6 +57,14 @@ var _graphQLHandlerFactory = require("./content/graphQLHandlerFactory");
 
 var _StorageTransformPlugin = require("./content/plugins/storage/StorageTransformPlugin");
 
+var _parameterPlugins = require("./content/parameterPlugins");
+
+var _CmsParametersPlugin = require("./content/plugins/CmsParametersPlugin");
+
+var _CmsGroupPlugin = require("./content/plugins/CmsGroupPlugin");
+
+var _CmsModelPlugin = require("./content/plugins/CmsModelPlugin");
+
 const createAdminHeadlessCmsContext = params => {
   return [(0, _context.default)(), (0, _crud.createAdminCruds)(params), (0, _upgrades.default)()];
 };
@@ -52,7 +78,7 @@ const createAdminHeadlessCmsGraphQL = () => {
 exports.createAdminHeadlessCmsGraphQL = createAdminHeadlessCmsGraphQL;
 
 const createContentHeadlessCmsContext = params => {
-  return [(0, _contextSetup.default)(), (0, _modelManager.default)(), (0, _crud2.createContentCruds)(params), (0, _graphqlFields.default)(), (0, _validators.default)(), (0, _default.default)(), (0, _object.default)() // new InternalAuthenticationPlugin("read-api-key"),
+  return [(0, _parameterPlugins.createParametersPlugins)(params), (0, _contextSetup.default)(), (0, _modelManager.default)(), (0, _crud2.createContentCruds)(params), (0, _graphqlFields.default)(), (0, _validators.default)(), (0, _default.default)(), (0, _object.default)() // new InternalAuthenticationPlugin("read-api-key"),
   // new InternalAuthorizationPlugin("read-api-key")
   ];
 };

package/migrateCMSPermissions.js

@@ -153,9 +153,11 @@ const migrateCMSPermissions = async (permissions, getModel) => {
 exports.migrateCMSPermissions = migrateCMSPermissions;
 
 const mergeCustomizer = (objValue, srcValue) => {
-  if (Array.isArray(objValue)) {
-    return objValue.concat(srcValue).filter(removeDuplicate);
+  if (Array.isArray(objValue) === false) {
+    return [];
   }
+
+  return objValue.concat(srcValue).filter(removeDuplicate);
 };
 
 const removeDuplicate = (item, index, arr) => arr.findIndex(el => el === item) === index;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@webiny/api-headless-cms",
-	"version": "5.22.0",
+	"version": "5.23.0-beta.1",
 	"main": "index.js",
 	"keywords": [
 		"cms:base"
@@ -21,23 +21,23 @@
 		"@babel/runtime": "7.16.7",
 		"@commodo/fields": "1.1.2-beta.20",
 		"@graphql-tools/schema": "7.1.5",
-		"@webiny/api-file-manager": "5.22.0",
-		"@webiny/api-i18n": "5.22.0",
-		"@webiny/api-i18n-content": "5.22.0",
-		"@webiny/api-i18n-ddb": "5.22.0",
-		"@webiny/api-security": "5.22.0",
-		"@webiny/api-tenancy": "5.22.0",
-		"@webiny/api-upgrade": "5.22.0",
-		"@webiny/error": "5.22.0",
-		"@webiny/handler": "5.22.0",
-		"@webiny/handler-aws": "5.22.0",
-		"@webiny/handler-db": "5.22.0",
-		"@webiny/handler-graphql": "5.22.0",
-		"@webiny/handler-http": "5.22.0",
-		"@webiny/plugins": "5.22.0",
-		"@webiny/pubsub": "5.22.0",
-		"@webiny/utils": "5.22.0",
-		"@webiny/validation": "5.22.0",
+		"@webiny/api-file-manager": "5.23.0-beta.1",
+		"@webiny/api-i18n": "5.23.0-beta.1",
+		"@webiny/api-i18n-content": "5.23.0-beta.1",
+		"@webiny/api-i18n-ddb": "5.23.0-beta.1",
+		"@webiny/api-security": "5.23.0-beta.1",
+		"@webiny/api-tenancy": "5.23.0-beta.1",
+		"@webiny/api-upgrade": "5.23.0-beta.1",
+		"@webiny/error": "5.23.0-beta.1",
+		"@webiny/handler": "5.23.0-beta.1",
+		"@webiny/handler-aws": "5.23.0-beta.1",
+		"@webiny/handler-db": "5.23.0-beta.1",
+		"@webiny/handler-graphql": "5.23.0-beta.1",
+		"@webiny/handler-http": "5.23.0-beta.1",
+		"@webiny/plugins": "5.23.0-beta.1",
+		"@webiny/pubsub": "5.23.0-beta.1",
+		"@webiny/utils": "5.23.0-beta.1",
+		"@webiny/validation": "5.23.0-beta.1",
 		"boolean": "3.1.4",
 		"commodo-fields-object": "1.0.6",
 		"dataloader": "2.0.0",
@@ -54,10 +54,10 @@
 		"@babel/core": "^7.16.0",
 		"@babel/preset-env": "^7.16.4",
 		"@babel/preset-flow": "^7.16.0",
-		"@webiny/api-security-so-ddb": "^5.22.0",
-		"@webiny/api-tenancy-so-ddb": "^5.22.0",
-		"@webiny/cli": "^5.22.0",
-		"@webiny/project-utils": "^5.22.0",
+		"@webiny/api-security-so-ddb": "^5.23.0-beta.1",
+		"@webiny/api-tenancy-so-ddb": "^5.23.0-beta.1",
+		"@webiny/cli": "^5.23.0-beta.1",
+		"@webiny/project-utils": "^5.23.0-beta.1",
 		"apollo-graphql": "^0.9.5",
 		"get-yarn-workspaces": "^1.0.2",
 		"graphql": "^15.7.2",
@@ -77,5 +77,5 @@
 		"build": "yarn webiny run build",
 		"watch": "yarn webiny run watch"
 	},
-	"gitHead": "ab2ca1af058fdec3aa1bed3f30afd51f4592dbb6"
+	"gitHead": "04f2d5e43684b9086251e2a6370b3c085e6d51cb"
 }

package/types.d.ts

@@ -962,6 +962,7 @@ export interface CmsModelFieldInput {
     type: string;
     /**
      * A unique ID for the field. Values will be mapped via this value.
+     * This field MUST be in range of "a-zA-Z".
      */
     fieldId: string;
     /**