@evershop/evershop 1.1.0 → 1.2.1

package/src/lib/router/loadModuleRoutes.js

@@ -20,6 +20,7 @@ exports.loadModuleRoutes = function loadModuleRoutes(modulePath) {
         route.id,
         route.method,
         route.path,
+        route.name,
         route.isApi,
         route.folder
       );
@@ -37,6 +38,7 @@ exports.loadModuleRoutes = function loadModuleRoutes(modulePath) {
         route.id,
         route.method,
         route.path,
+        route.name,
         route.isApi,
         route.folder
       );
@@ -51,6 +53,7 @@ exports.loadModuleRoutes = function loadModuleRoutes(modulePath) {
         route.id,
         route.method,
         route.path,
+        route.name,
         route.isApi,
         route.folder,
         route.payloadSchema,

package/src/lib/router/registerAdminRoute.js

@@ -11,7 +11,14 @@ module.exports = exports = {};
  * @param   {string}  path    The path of route
  *
  */
-exports.registerAdminRoute = (id, method, path, isApi = false, folder = '') => {
+exports.registerAdminRoute = (
+  id,
+  method,
+  path,
+  name,
+  isApi = false,
+  folder = ''
+) => {
   // const route = validateRoute(id, method, path);
   const route = {
     id: String(id),
@@ -22,5 +29,6 @@ exports.registerAdminRoute = (id, method, path, isApi = false, folder = '') => {
   route.isApi = isApi;
   route.path = route.path === '/' ? '/admin' : `/admin${path}`;
   route.folder = folder;
+  route.name = name;
   addRoute(route);
 };

package/src/lib/router/registerFrontStoreRoute.js

@@ -15,6 +15,7 @@ exports.registerFrontStoreRoute = (
   id,
   method,
   path,
+  name,
   isApi = false,
   folder = '',
   payloadSchema = null,
@@ -31,5 +32,6 @@ exports.registerFrontStoreRoute = (
   route.isAdmin = false;
   route.isApi = isApi;
   route.folder = folder;
+  route.name = name;
   addRoute(route);
 };

package/src/lib/router/scanForRoutes.js

@@ -65,6 +65,7 @@ exports.scanForRoutes = (path, isAdmin, isApi) => {
 
             return {
               id: r,
+              name: routeJson?.name || r,
               method: methods,
               path: routePath,
               isAdmin,

package/src/lib/router/tests/unit/unit.validateRoute.test.js

@@ -8,7 +8,13 @@ describe('Test validateRoute', () => {
   beforeAll(() => {
     const routes = scanForRoutes(path.resolve(__dirname, 'b'), true, false);
     routes.forEach((route) => {
-      registerAdminRoute(route.id, route.method, route.path, route.isApi);
+      registerAdminRoute(
+        route.id,
+        route.method,
+        route.path,
+        route.name,
+        route.isApi
+      );
     });
   });
 

package/src/lib/util/defaultPaginationFilters.js

@@ -54,7 +54,7 @@ const defaultPaginationFilters = [
         } else {
           query.limit(0, parseInt(value, 10));
           currentFilters.push({
-            key: 'page',
+            key: 'limit',
             operation: 'eq',
             value
           });
@@ -77,22 +77,24 @@ const defaultPaginationFilters = [
     key: '*',
     operation: ['eq'],
     callback: (query, operation, value, currentFilters) => {
-      const page = currentFilters.find((f) => f.key === 'page');
-      const limit = currentFilters.find((f) => f.key === 'limit');
-      if (!limit) {
-        currentFilters.push({
-          key: 'limit',
-          operation: 'eq',
-          value: CONSTANTS.ADMIN_COLLECTION_SIZE
-        });
-      }
-      if (!page) {
-        currentFilters.push({
-          key: 'page',
-          operation: 'eq',
-          value: 1
-        });
-      }
+      const page = currentFilters.find((f) => f.key === 'page') || { value: 1 };
+      const limit = currentFilters.find((f) => f.key === 'limit') || {
+        value: CONSTANTS.ADMIN_COLLECTION_SIZE
+      };
+      currentFilters.push({
+        key: 'page',
+        operation: 'eq',
+        value: page.value
+      });
+      currentFilters.push({
+        key: 'limit',
+        operation: 'eq',
+        value: limit.value
+      });
+      query.limit(
+        (parseInt(page.value, 10) - 1) * parseInt(limit.value, 10),
+        parseInt(limit.value, 10)
+      );
     }
   }
 ];

package/src/lib/util/getEnabledWidgets.js

@@ -0,0 +1,34 @@
+const isResolvable = require('is-resolvable');
+const { getConfig } = require('./getConfig');
+const { generateComponentKey } = require('../webpack/util/keyGenerator');
+
+module.exports = exports = {};
+
+exports.getEnabledWidgets = function getEnabledWidgets() {
+  const configuredWidgets = getConfig('widgets', {});
+  const widgets = [];
+  Object.keys(configuredWidgets).forEach((widget) => {
+    // Make sure the enabled = true and the component path is exist
+    const { setting_component } = configuredWidgets[widget];
+    const { component } = configuredWidgets[widget];
+    // Make sure path is existed and it is a jsx file
+    if (!isResolvable(setting_component)) {
+      throw new Error(
+        `Widget ${widget} is not configured correctly. The setting_component is not existed or not a jsx file`
+      );
+    } else if (!isResolvable(component)) {
+      throw new Error(
+        `Widget ${widget} is not configured correctly. The component is not existed or not a jsx file`
+      );
+    }
+    if (configuredWidgets[widget].enabled === true) {
+      widgets.push({
+        ...configuredWidgets[widget],
+        type: widget,
+        settingComponentKey: generateComponentKey(setting_component),
+        componentKey: generateComponentKey(component)
+      });
+    }
+  });
+  return widgets;
+};

package/src/lib/util/merge.js

@@ -1,28 +1,81 @@
 /* eslint-disable no-param-reassign */
 /**
- * This function take 2 objects and merge them into a new object
+ * This function take 2 objects: target and source, and merge them together recursively
+ * This function will not merge built-in objects like Date, RegExp, Map, Set
+ * This function will overwrite the value from the first object by the value from the second object if they have the same key and the value is primitive
+ * This function will merge array property from 2 objects
  *
- * @param   {object}  objectOne  The first object
- * @param   {object}  objectTwo  The second object
+ * @param   {object}  target  The target object
+ * @param   {object}  source  The source object
  *
- * @return  {object}             The new object
+ * @return  {object}  The new target object
  */
-function merge(objectOne, objectTwo) {
-  if (typeof objectOne !== 'object' || objectOne === null) {
-    throw new Error('`object` must be an object');
+function merge(target, source, maxDepth = 20, currentDepth = 0) {
+  function isBuiltInObject(obj) {
+    return (
+      obj instanceof Date ||
+      obj instanceof RegExp ||
+      obj instanceof Map ||
+      obj instanceof Set
+    );
   }
-  if (typeof objectTwo !== 'object' || objectTwo === null) {
-    throw new Error('`object` must be an object');
+
+  if (isBuiltInObject(target) || isBuiltInObject(source)) {
+    throw new Error(
+      'deepMerge cannot merge built-in objects like Date or RegExp'
+    );
+  }
+
+  if (
+    typeof target !== 'object' ||
+    target === null ||
+    typeof source !== 'object' ||
+    source === null
+  ) {
+    throw new Error('merge function can only merge plain objects');
   }
 
-  const result = Object.create({});
+  if (currentDepth > maxDepth) {
+    throw new Error(`Maximum depth of ${maxDepth} exceeded`);
+  }
+
+  function getAllKeys(obj) {
+    let keys = [];
+    Object.getOwnPropertyNames(obj).forEach((key) => {
+      if (!keys.includes(key)) {
+        keys.push(key);
+      }
+    });
+    keys = keys.concat(Object.getOwnPropertySymbols(obj));
+    return keys;
+  }
 
-  Object.keys(objectOne).forEach((key) => {
-    result[key] = objectOne[key] ? objectOne[key] : objectTwo[key];
-    delete objectTwo[key];
+  getAllKeys(source).forEach((key) => {
+    if (key in target) {
+      if (Array.isArray(target[key]) && Array.isArray(source[key])) {
+        target[key] = Array.from(new Set([...target[key], ...source[key]]));
+      } else if (
+        typeof target[key] === 'object' &&
+        typeof source[key] === 'object'
+      ) {
+        if (isBuiltInObject(target[key]) || isBuiltInObject(source[key])) {
+          target[key] = source[key];
+        } else {
+          merge(target[key], source[key], maxDepth, currentDepth + 1);
+        }
+      } else {
+        target[key] = source[key];
+      }
+    } else {
+      Object.defineProperty(
+        target,
+        key,
+        Object.getOwnPropertyDescriptor(source, key)
+      );
+    }
   });
 
-  return { ...result, ...objectTwo };
+  return target;
 }
 
 // eslint-disable-next-line no-multi-assign

package/src/lib/util/tests/unit/util.merge.test.js

@@ -20,19 +20,36 @@ describe('Test until merge', () => {
     expect(merge(a, b)).toEqual({ a: 1, b: 1, c: 1 });
   });
 
-  it('It should not overwrite the value from the first object if it is existed and truthy', () => {
+  it('It should not overwrite the value from the first object if it is existed', () => {
     const a = { a: 1 };
     const b = { a: 2, c: 1 };
     const c = merge(a, b);
-    expect(c.a).toEqual(1);
+    expect(c.a).toEqual(2);
   });
 
-  it('It should overwrite the value from the first object if it is not truthy', () => {
+  it('It should overwrite the value from the first object', () => {
     const a = { a: '', c: null, d: [] };
     const b = { a: 2, c: 1, d: 1 };
     const c = merge(a, b);
     expect(c.a).toEqual(2);
     expect(c.c).toEqual(1);
-    expect(c.d).toEqual([]);
+    expect(c.d).toEqual(1);
+  });
+
+  it('It should merge array property from 2 objects', () => {
+    const a = { a: [1, 2] };
+    const b = { a: [2, 3], c: 1 };
+    const c = merge(a, b);
+    expect(c.a).toEqual([1, 2, 3]);
+  });
+
+  it('It should thrown an exception if the maximum depth is exceeded', () => {
+    const a = {
+      a: { b: { c: { d: { e: { f: { g: { h: { i: { j: { k: 1 } } } } } } } } } }
+    };
+    const b = {
+      a: { b: { c: { d: { e: { f: { g: { h: { i: { j: { k: 2 } } } } } } } } } }
+    };
+    expect(() => merge(a, b, 5)).toThrow(Error);
   });
 });

package/src/lib/util/validateConfiguration.js

@@ -0,0 +1,83 @@
+const { getAjv } = require('../../modules/base/services/getAjv');
+const { getValueSync } = require('./registry');
+
+module.exports.validateConfiguration = function validateConfiguration(config) {
+  const ajv = getAjv();
+  const configSchema = getValueSync(
+    'configuratonSchema',
+    { type: 'object' },
+    null,
+    (schema) => {
+      ajv.validateSchema(schema);
+      if (ajv.errors) {
+        throw new Error(
+          `Your configuration schema is not valid: ${ajv.errors[0].instancePath}`
+        );
+      } else {
+        return true;
+      }
+    }
+  );
+
+  // Validate by using Ajv
+  const validate = ajv.compile(configSchema);
+  const reservedKeys = [
+    'get',
+    'has',
+    'util',
+    'getConfigSources',
+    'makeHidden',
+    'makeImmutable',
+    'setModuleDefaults',
+    'watch',
+    '_attachProtoDeep',
+    '_cloneDeep',
+    '_diffDeep',
+    '_equalsDeep',
+    '_extendDeep',
+    '_get',
+    '_getCmdLineArg',
+    '_initParam',
+    '_isObject',
+    '_loadFileConfigs',
+    '_parseFile',
+    '_stripComments',
+    '_stripYamlComments'
+  ];
+  const configuration = Object.keys(config).reduce((acc, key) => {
+    if (configSchema.properties[key] || !reservedKeys.includes(key)) {
+      acc[key] = config[key];
+    }
+    return acc;
+  }, {});
+  const valid = validate(configuration);
+  if (!valid) {
+    throw new Error(errorFormatter(validate.errors));
+  } else {
+    return true;
+  }
+};
+
+function errorFormatter(errors) {
+  const messages = ['Invalid configuration:'];
+  errors.forEach((error) => {
+    if (error.keyword === 'errorMessage') {
+      messages.push(`${error.message}. ${error.instancePath}`);
+    } else if (error.keyword === 'additionalProperties') {
+      messages.push(
+        `${error.instancePath}/${error.params.additionalProperty} is not allowed.`
+      );
+    } else if (error.keyword === 'enum') {
+      messages.push(
+        `${
+          error.instancePath
+        } must be one of the following values: ${error.params.allowedValues.join(
+          ', '
+        )}`
+      );
+    } else {
+      messages.push(`${error.instancePath} ${error.message}`);
+    }
+  });
+  return messages.join('\n');
+}

package/src/lib/webpack/createBaseConfig.js

@@ -167,7 +167,10 @@ module.exports.createBaseConfig = function createBaseConfig(isServer) {
             parse: {
               ecma: 2020
             },
-            compress: false,
+            compress: {
+              unused: true,
+              dead_code: true
+            },
             mangle: {
               safari10: true
             },

package/src/lib/webpack/dev/createConfigClient.js

@@ -5,6 +5,7 @@ const { createBaseConfig } = require('../createBaseConfig');
 const { getComponentsByRoute } = require('../../componee/getComponentsByRoute');
 const { CONSTANTS } = require('../../helpers');
 const { GraphqlPlugin } = require('../plugins/GraphqlPlugin');
+const { getEnabledWidgets } = require('../../util/getEnabledWidgets');
 
 module.exports.createConfigClient = function createConfigClient(route) {
   const config = createBaseConfig(false);
@@ -21,7 +22,7 @@ module.exports.createConfigClient = function createConfigClient(route) {
         ),
         options: {
           getComponents: () => getComponentsByRoute(route),
-          routeId: route.id
+          route
         }
       }
     ]
@@ -81,6 +82,7 @@ module.exports.createConfigClient = function createConfigClient(route) {
 
   config.entry = () => {
     const entry = {};
+
     entry[route.id] = [
       ...getComponentsByRoute(route),
       path.resolve(
@@ -89,7 +91,13 @@ module.exports.createConfigClient = function createConfigClient(route) {
       ),
       `webpack-hot-middleware/client?path=/eHot/${route.id}&reload=true&overlay=true`
     ];
-
+    // Widgets
+    const widgets = getEnabledWidgets();
+    if (!route.isAdmin) {
+      Object.keys(widgets).forEach((widget) => {
+        entry[route.id].push(widgets[widget].component);
+      });
+    }
     return entry;
   };
   config.watchOptions = {

package/src/lib/webpack/loaders/AreaLoader.js

@@ -3,13 +3,15 @@ const { inspect } = require('util');
 const JSON5 = require('json5');
 const { CONSTANTS } = require('../../helpers');
 const { error } = require('../../log/logger');
+const { getEnabledWidgets } = require('../../util/getEnabledWidgets');
+const { generateComponentKey } = require('../util/keyGenerator');
 
 /* eslint-disable no-multi-assign */
 /* eslint-disable global-require */
 module.exports = exports = function AreaLoader(c) {
   this.cacheable(false);
   const components = this.getOptions().getComponents();
-  const { routeId } = this.getOptions();
+  const { route } = this.getOptions();
   const areas = {};
   components.forEach((module) => {
     this.addDependency(module);
@@ -28,9 +30,7 @@ module.exports = exports = function AreaLoader(c) {
         .replace(/(['"])?([a-zA-Z0-9_]+)(['"])?:/g, '"$2": ');
       try {
         const layout = JSON5.parse(check);
-        const id = Buffer.from(module.replace(CONSTANTS.ROOTPATH, '')).toString(
-          'base64'
-        );
+        const id = generateComponentKey(module.replace(CONSTANTS.ROOTPATH, ''));
         areas[layout.areaId] = areas[layout.areaId] || {};
         areas[layout.areaId][id] = {
           id,
@@ -43,11 +43,21 @@ module.exports = exports = function AreaLoader(c) {
       }
     }
   });
-
+  const widgets = getEnabledWidgets();
+  areas['*'] = areas['*'] || {};
+  widgets.forEach((widget) => {
+    areas['*'][widget.type] = {
+      id: widget.type,
+      sortOrder: widget.sortOrder || 0,
+      component: route.isAdmin
+        ? `---require('${widget.setting_component}')---`
+        : `---require('${widget.component}')---`
+    };
+  });
   const content = `Area.defaultProps.components = ${inspect(areas, { depth: 5 })
     .replace(/"---/g, '')
     .replace(/---"/g, '')} `;
   return c
     .replace('/** render */', content)
-    .replace('/eHot', `/eHot/${routeId}`);
+    .replace('/eHot', `/eHot/${route.id}`);
 };

package/src/lib/webpack/util/keyGenerator.js

@@ -0,0 +1,9 @@
+const crypto = require('crypto');
+
+function generateComponentKey(text) {
+  return crypto.createHash('md5').update(text).digest('hex');
+}
+
+module.exports = exports = {
+  generateComponentKey
+};

package/src/lib/webpack/util/parseGraphql.js

@@ -1,29 +1,39 @@
 const fs = require('fs');
 const uniqid = require('uniqid');
 const JSON5 = require('json5');
+const isResolvable = require('is-resolvable');
 const { CONSTANTS } = require('../../helpers');
 const { parseGraphqlByFile } = require('./parseGraphqlByFile');
+const { generateComponentKey } = require('./keyGenerator');
 
 module.exports.parseGraphql = function parseGraphql(modules) {
   let inUsedFragments = [];
   const propsMap = {};
-  let queryStr = '';
+  let queries = {};
   let fragmentStr = '';
-  const variables = {
-    values: {},
-    defs: []
-  };
-
+  const variableList = {};
   modules.forEach((module) => {
-    if (!fs.existsSync(module)) {
+    if (!fs.existsSync(module) && !isResolvable(module)) {
       return;
     }
-
-    const moduleKey = Buffer.from(
-      module.replace(CONSTANTS.ROOTPATH, '')
-    ).toString('base64');
-    const moduleGraphqlData = parseGraphqlByFile(module);
-    queryStr += `\n${moduleGraphqlData.query.source}`;
+    const variables = {
+      values: {},
+      defs: []
+    };
+    let modulePath;
+    let moduleKey;
+    // If the module is resolvable, get the apsolute path
+    if (!fs.existsSync(module)) {
+      modulePath = require.resolve(module);
+      moduleKey = generateComponentKey(module);
+    } else {
+      modulePath = module;
+      moduleKey = generateComponentKey(
+        modulePath.replace(CONSTANTS.ROOTPATH, '')
+      );
+    }
+    const moduleGraphqlData = parseGraphqlByFile(modulePath);
+    queries[moduleKey] = moduleGraphqlData.query.source;
     fragmentStr += `\n${moduleGraphqlData.fragments.source}`;
     Object.assign(
       variables.values,
@@ -32,6 +42,7 @@ module.exports.parseGraphql = function parseGraphql(modules) {
     variables.defs = variables.defs.concat(
       moduleGraphqlData.variables.definitions
     );
+    variableList[moduleKey] = variables;
     propsMap[moduleKey] = moduleGraphqlData.query.props;
     inUsedFragments = inUsedFragments.concat(moduleGraphqlData.fragments.pairs);
   });
@@ -46,7 +57,10 @@ module.exports.parseGraphql = function parseGraphql(modules) {
     if (f) {
       // Replace fragment alias with the one already processed
       const regex = new RegExp(`\\.\\.\\.([ ]+)?${fragment.alias}`, 'g');
-      queryStr = queryStr.replace(regex, `...${f.alias}`);
+      queries = Object.keys(queries).reduce((acc, key) => {
+        acc[key] = queries[key].replace(regex, `...${f.alias}`);
+        return acc;
+      }, {});
       fragmentStr = fragmentStr.replace(regex, `...${f.alias}`);
     } else {
       const regex = new RegExp(
@@ -80,9 +94,9 @@ module.exports.parseGraphql = function parseGraphql(modules) {
   });
 
   return {
-    query: queryStr,
+    queries,
     fragments: fragmentStr,
-    variables: JSON5.stringify(variables),
+    variables: variableList,
     propsMap
   };
 };

package/src/lib/webpack/util/parseGraphqlByFile.js

@@ -33,6 +33,14 @@ module.exports.parseGraphqlByFile = function parseGraphqlByFile(module) {
       }
     );
 
+    queryBody = queryBody.replace(
+      /getWidgetSetting\(([^)]+)\)/g,
+      (match, p1) => {
+        const base64 = Buffer.from(p1).toString('base64');
+        return `"getWidgetSetting_${base64}"`;
+      }
+    );
+
     const queryAst = parse(queryBody);
     const map = queryAst.definitions[0].selectionSet.selections.map(
       (selection) => {
@@ -74,7 +82,7 @@ module.exports.parseGraphqlByFile = function parseGraphqlByFile(module) {
         variables.push({
           origin: name,
           type,
-          alias: `v${uniqid()}`
+          alias: `variable_${uniqid()}`
         });
       });
     }
@@ -179,7 +187,13 @@ module.exports.parseGraphqlByFile = function parseGraphqlByFile(module) {
         return `"getContextValue_${base64}"`;
       }
     );
-
+    variablesBody = variablesBody.replace(
+      /getWidgetSetting\(([^)]*)\)/g,
+      (match, p1) => {
+        const base64 = Buffer.from(p1).toString('base64');
+        return `"getWidgetSetting_${base64}"`;
+      }
+    );
     try {
       // Json parse the variables body
       const variablesJson = JSON5.parse(variablesBody);