@evershop/evershop 1.1.0 → 1.2.1

package/src/modules/cms/api/updateWidget/finish[apiResponse].js

@@ -0,0 +1,27 @@
+const { buildUrl } = require('@evershop/evershop/src/lib/router/buildUrl');
+const { OK } = require('@evershop/evershop/src/lib/util/httpStatus');
+
+// eslint-disable-next-line no-unused-vars
+module.exports = async (request, response, delegate, next) => {
+  const widget = await delegate.updateWidget;
+  response.status(OK);
+  response.json({
+    data: {
+      ...widget,
+      links: [
+        {
+          rel: 'widgetGrid',
+          href: buildUrl('widgetGrid'),
+          action: 'GET',
+          types: ['text/xml']
+        },
+        {
+          rel: 'edit',
+          href: buildUrl('widgetEdit', { id: widget.uuid }),
+          action: 'GET',
+          types: ['text/xml']
+        }
+      ]
+    }
+  });
+};

package/src/modules/cms/api/updateWidget/payloadSchema.json

@@ -0,0 +1,18 @@
+{
+  "type": "object",
+  "properties": {
+    "area": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "route": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    }
+  },
+  "additionalProperties": true
+}

package/src/modules/cms/api/updateWidget/route.json

@@ -0,0 +1,5 @@
+{
+  "methods": ["PATCH"],
+  "path": "/widgets/:id",
+  "access": "private"
+}

package/src/modules/cms/api/updateWidget/updateWidget[finish].js

@@ -0,0 +1,17 @@
+const updateWidget = require('../../services/widget/updateWidget');
+
+// eslint-disable-next-line no-unused-vars
+module.exports = async (request, response, delegate) => {
+  const data = request.body;
+  if (!data.route || (data.route.length === 1 && data.route[0] === '')) {
+    data.route = [];
+  }
+  if (!data.area || (data.area.length === 1 && data.area[0] === '')) {
+    data.area = [];
+  }
+  const widget = await updateWidget(request.params.id, data, {
+    routeId: request.currentRoute.id
+  });
+
+  return widget;
+};

package/src/modules/cms/bootstrap.js

@@ -1,12 +1,173 @@
 const config = require('config');
+const { merge } = require('@evershop/evershop/src/lib/util/merge');
 const registerDefaultPageCollectionFilters = require('./services/registerDefaultPageCollectionFilters');
 const {
   defaultPaginationFilters
 } = require('../../lib/util/defaultPaginationFilters');
 const { addProcessor } = require('../../lib/util/registry');
+const registerDefaultWidgetCollectionFilters = require('./services/registerDefaultWidgetCollectionFilters');
 
 module.exports = () => {
-  const themeConfig = {
+  addProcessor('configuratonSchema', (schema) => {
+    merge(schema, {
+      properties: {
+        themeConfig: {
+          type: 'object',
+          properties: {
+            logo: {
+              type: 'object',
+              properties: {
+                alt: {
+                  type: 'string'
+                },
+                src: {
+                  type: 'string',
+                  format: 'uri-reference'
+                },
+                width: {
+                  type: 'integer'
+                },
+                height: {
+                  type: 'integer'
+                }
+              }
+            },
+            headTags: {
+              type: 'object',
+              properties: {
+                links: {
+                  type: 'array',
+                  items: {
+                    type: 'object',
+                    properties: {
+                      rel: {
+                        type: 'string'
+                      },
+                      href: {
+                        type: 'string',
+                        format: 'uri-reference'
+                      }
+                    },
+                    required: ['rel', 'href']
+                  }
+                },
+                metas: {
+                  type: 'array',
+                  items: {
+                    type: 'object',
+                    properties: {
+                      name: {
+                        type: 'string'
+                      },
+                      content: {
+                        type: 'string'
+                      }
+                    },
+                    required: ['name', 'content']
+                  }
+                },
+                scripts: {
+                  type: 'array',
+                  items: {
+                    type: 'object',
+                    properties: {
+                      src: {
+                        type: 'string',
+                        format: 'uri-reference'
+                      },
+                      type: {
+                        type: 'string'
+                      },
+                      async: {
+                        type: 'boolean'
+                      },
+                      defer: {
+                        type: 'boolean'
+                      },
+                      crossorigin: {
+                        type: 'string'
+                      },
+                      integrity: {
+                        type: 'string'
+                      },
+                      noModule: {
+                        type: 'string'
+                      },
+                      nonce: {
+                        type: 'string'
+                      }
+                    },
+                    required: ['src']
+                  }
+                },
+                bases: {
+                  type: 'array',
+                  items: {
+                    type: 'object',
+                    properties: {
+                      href: {
+                        type: 'string',
+                        format: 'uri-reference'
+                      }
+                    },
+                    required: ['href']
+                  }
+                }
+              }
+            }
+          }
+        },
+        system: {
+          type: 'object',
+          properties: {
+            file_storage: {
+              type: 'string',
+              enum: ['local']
+            }
+          }
+        },
+        widgets: {
+          type: 'object',
+          patternProperties: {
+            '^[a-zA-Z_]+$': {
+              type: 'object',
+              properties: {
+                setting_component: {
+                  type: 'string'
+                },
+                component: {
+                  type: 'string'
+                },
+                name: {
+                  type: 'string'
+                },
+                description: {
+                  type: 'string'
+                },
+                default_settings: {
+                  type: 'object'
+                },
+                enabled: {
+                  type: 'boolean'
+                }
+              },
+              required: [
+                'setting_component',
+                'component',
+                'name',
+                'description',
+                'enabled'
+              ],
+              additionalProperties: false
+            }
+          }
+        }
+      }
+    });
+    return schema;
+  });
+
+  const defaultThemeConfig = {
     logo: {
       alt: undefined,
       src: undefined,
@@ -21,12 +182,40 @@ module.exports = () => {
     },
     copyRight: `© 2022 Evershop. All Rights Reserved.`
   };
-  config.util.setModuleDefaults('themeConfig', themeConfig);
+  config.util.setModuleDefaults('themeConfig', defaultThemeConfig);
+
+  // Set the default file storage to local
   config.util.setModuleDefaults('system', {
     file_storage: 'local'
   });
 
-  // Reigtering the default filters for attribute collection
+  // Register default widgets
+  const defaultWidgets = {
+    text_block: {
+      setting_component:
+        '@evershop/evershop/src/components/admin/widgets/TextBlockSetting.jsx',
+      component:
+        '@evershop/evershop/src/components/frontStore/widgets/TextBlock.jsx',
+      name: 'Text block',
+      description: 'A text block widget',
+      default_settings: {
+        className: 'page-width'
+      },
+      enabled: true
+    },
+    basic_menu: {
+      setting_component:
+        '@evershop/evershop/src/components/admin/widgets/BasicMenuSetting.jsx',
+      component:
+        '@evershop/evershop/src/components/frontStore/widgets/BasicMenu.jsx',
+      name: 'Menu',
+      description: 'A menu widget',
+      enabled: true
+    }
+  };
+  config.util.setModuleDefaults('widgets', defaultWidgets);
+
+  // Reigtering the default filters for cms page collection
   addProcessor(
     'cmsPageCollectionFilters',
     registerDefaultPageCollectionFilters,
@@ -37,4 +226,35 @@ module.exports = () => {
     (filters) => [...filters, ...defaultPaginationFilters],
     2
   );
+
+  // Reigtering the default filters for widget collection
+  addProcessor(
+    'widgetCollectionFilters',
+    registerDefaultWidgetCollectionFilters,
+    1
+  );
+  addProcessor(
+    'widgetCollectionFilters',
+    (filters) => [...filters, ...defaultPaginationFilters],
+    2
+  );
+
+  const parseMenus = (data) => {
+    if (data?.type !== 'basic_menu') {
+      return data;
+    }
+    // eslint-disable-next-line no-param-reassign
+    data.settings = data.settings || {};
+    if (data.settings.menus) {
+      // eslint-disable-next-line no-param-reassign
+      data.settings.menus = JSON.parse(data.settings.menus);
+    } else {
+      // eslint-disable-next-line no-param-reassign
+      data.settings.menus = [];
+    }
+    return data;
+  };
+
+  addProcessor('widgetDataBeforeCreate', parseMenus, 1);
+  addProcessor('widgetDataBeforeUpdate', parseMenus, 1);
 };

package/src/modules/cms/graphql/types/CmsPage/CmsPage.graphql

@@ -4,11 +4,10 @@ Lookup CMS page by ID
 type CmsPage {
   cmsPageId: Int
   uuid: String!
-  layout: String!
   status: Int!
   urlKey: String!
   name: String!
-  content: String!
+  content: JSON!
   metaTitle: String
   metaKeywords: String
   metaDescription: String

package/src/modules/cms/graphql/types/CmsPage/CmsPage.resolvers.js

@@ -1,3 +1,4 @@
+const { v4: uuidv4 } = require('uuid');
 const { buildUrl } = require('@evershop/evershop/src/lib/router/buildUrl');
 const { camelCase } = require('@evershop/evershop/src/lib/util/camelCase');
 const {
@@ -24,6 +25,39 @@ module.exports = {
     url: ({ urlKey }) => buildUrl('cmsPageView', { url_key: urlKey }),
     editUrl: ({ uuid }) => buildUrl('cmsPageEdit', { id: uuid }),
     updateApi: (page) => buildUrl('updateCmsPage', { id: page.uuid }),
-    deleteApi: (page) => buildUrl('deleteCmsPage', { id: page.uuid })
+    deleteApi: (page) => buildUrl('deleteCmsPage', { id: page.uuid }),
+    content: ({ content }) => {
+      try {
+        return JSON.parse(content);
+      } catch (e) {
+        // This is for backward compatibility. If the content is not a JSON string then it is a raw HTML block
+        const rowId = `r__${uuidv4()}`;
+        return [
+          {
+            size: 1,
+            id: rowId,
+            columns: [
+              {
+                id: 'c__c5d90067-c786-4324-8e24-8e30520ac3d7',
+                size: 1,
+                data: {
+                  time: 1723347125344,
+                  blocks: [
+                    {
+                      id: 'AU89ItzUa7',
+                      type: 'raw',
+                      data: {
+                        html: content
+                      }
+                    }
+                  ],
+                  version: '2.30.2'
+                }
+              }
+            ]
+          }
+        ];
+      }
+    }
   }
 };

package/src/modules/cms/graphql/types/Widget/Widget.graphql

@@ -0,0 +1,91 @@
+"""
+Lookup Widget by ID
+"""
+type Widget {
+  widgetId: Int
+  uuid: String!
+  name: String!
+  type: String!
+  area: [String!]
+  route: [String!]
+  sortOrder: Int!
+  status: Int!
+  settings: JSON!
+  editUrl: String!
+  updateApi: String!
+  deleteApi: String!
+}
+
+"""
+Widget type
+"""
+type WidgetType {
+  code: String!
+  name: String!
+  description: String!
+  createWidgetUrl: String!
+  settingComponent: String!
+  component: String!
+  defaultSetting: JSON
+}
+
+"""
+Return a collection of Widget
+"""
+type WidgetCollection {
+  items: [Widget]
+  currentPage: Int!
+  total: Int!
+  currentFilters: [Filter]
+}
+
+"""
+Return a text Widget
+"""
+type TextBlockWidget {
+  text: JSON
+  className: String
+}
+
+"""
+Return a menu input
+"""
+input BasicMenuInput {
+  id: ID
+  name: String!
+  label: String
+  url: String
+  children: [BasicMenuInput]
+  type: String!
+  uuid: String
+}
+
+"""
+Return a menu item
+"""
+type Menu {
+  id: ID!
+  name: String!
+  url: String
+  children: [Menu]
+  type: String!
+  uuid: String
+}
+
+"""
+Return a menu Widget
+"""
+type BasicMenuWidget {
+  menus: [Menu],
+  isMain: Boolean
+  className: String
+}
+
+extend type Query {
+  widget(id: Int): Widget
+  widgets(filters: [FilterInput]): WidgetCollection
+  widgetTypes: [WidgetType]
+  widgetType(code: String!): WidgetType
+  textWidget(text: String, className: String): TextBlockWidget
+  basicMenuWidget(settings: JSON ): BasicMenuWidget
+}

package/src/modules/cms/graphql/types/Widget/Widget.resolvers.js

@@ -0,0 +1,142 @@
+const uniqid = require('uniqid');
+const { buildUrl } = require('@evershop/evershop/src/lib/router/buildUrl');
+const { camelCase } = require('@evershop/evershop/src/lib/util/camelCase');
+const {
+  getEnabledWidgets
+} = require('@evershop/evershop/src/lib/util/getEnabledWidgets');
+const { select } = require('@evershop/postgres-query-builder');
+const {
+  getWidgetsBaseQuery
+} = require('../../../services/getWidgetsBaseQuery');
+const { WidgetCollection } = require('../../../services/WidgetCollection');
+const {
+  getCmsPagesBaseQuery
+} = require('../../../services/getCmsPagesBaseQuery');
+
+module.exports = {
+  Query: {
+    widget: async (root, { id }, { pool }) => {
+      const query = getWidgetsBaseQuery();
+      query.where('widget_id', '=', id);
+      const widget = await query.load(pool);
+      return widget ? camelCase(widget) : null;
+    },
+    widgets: async (_, { filters = [] }, { user }) => {
+      const query = getWidgetsBaseQuery();
+      const root = new WidgetCollection(query);
+      await root.init(filters, !!user);
+      return root;
+    },
+    widgetTypes: () => {
+      const types = getEnabledWidgets();
+      return types.map((row) => ({
+        code: row.type,
+        name: row.name,
+        description: row.description,
+        settingComponent: row.setting_component,
+        component: row.component,
+        defaultSettings: row.default_settings,
+        createWidgetUrl: buildUrl('widgetNew', { type: row.type })
+      }));
+    },
+    widgetType: (_, { code }) => {
+      const types = getEnabledWidgets();
+      const type = types.find((row) => row.type === code);
+      return type
+        ? {
+            code: type.type,
+            name: type.name,
+            description: type.description,
+            settingComponent: type.setting_component,
+            component: type.component,
+            defaultSettings: type.default_settings,
+            createWidgetUrl: buildUrl('widgetNew', { type: type.type })
+          }
+        : null;
+    },
+    textWidget(_, { text, className }) {
+      const replacements = {
+        '&lt;': '<',
+        '&gt;': '>'
+      };
+      const jsonText = text
+        ? text.replace(/&lt;|&gt;/g, (match) => replacements[match])
+        : '[]';
+      return { text: JSON.parse(jsonText), className };
+    },
+    basicMenuWidget: async (_, { settings }, { pool }) => {
+      const categories = [];
+      const pages = [];
+      const menus = settings?.menus || undefined;
+      const isMain = [1, '1', 'true', true].includes(settings?.isMain) || false;
+      if (!menus) {
+        return { menus: [] };
+      }
+      // eslint-disable-next-line no-restricted-syntax
+      for (const menu of menus) {
+        if (menu.type === 'category') {
+          categories.push(menu.uuid);
+        }
+        if (menu.type === 'page') {
+          pages.push(menu.uuid);
+        }
+        menu.children.forEach((child) => {
+          if (child.type === 'category') {
+            categories.push(child.uuid);
+          }
+          if (child.type === 'page') {
+            pages.push(child.uuid);
+          }
+        });
+      }
+      let urls = [];
+      if (categories.length > 0) {
+        const rewrites = await select()
+          .from('url_rewrite')
+          .where('entity_uuid', 'IN', categories)
+          .execute(pool);
+        urls = urls.concat(
+          rewrites.map((r) => ({
+            uuid: r.entity_uuid,
+            url: r.request_path
+          }))
+        );
+      }
+      if (pages.length > 0) {
+        const query = getCmsPagesBaseQuery();
+        query.where('uuid', 'IN', pages);
+        const cmsPages = await query.execute(pool);
+        urls = urls.concat(
+          cmsPages.map((p) => ({
+            uuid: p.uuid,
+            url: buildUrl('cmsPageView', { url_key: p.url_key })
+          }))
+        );
+      }
+      const items = menus.map((menu) => {
+        const url = urls.find((u) => u.uuid === menu.uuid);
+        return {
+          ...menu,
+          id: uniqid(),
+          // eslint-disable-next-line no-nested-ternary
+          url: url ? url.url : menu.type === 'custom' ? menu.url : null,
+          children: menu.children.map((child) => {
+            const url = urls.find((u) => u.uuid === child.uuid);
+            return {
+              ...child,
+              id: uniqid(),
+              // eslint-disable-next-line no-nested-ternary
+              url: url ? url.url : child.type === 'custom' ? child.url : null
+            };
+          })
+        };
+      });
+      return { menus: items, isMain, className: settings?.className };
+    }
+  },
+  Widget: {
+    editUrl: ({ uuid }) => buildUrl('widgetEdit', { id: uuid }),
+    updateApi: (widget) => buildUrl('updateWidget', { id: widget.uuid }),
+    deleteApi: (widget) => buildUrl('deleteWidget', { id: widget.uuid })
+  }
+};

package/src/modules/cms/migration/Version-1.1.0.js

@@ -0,0 +1,22 @@
+const { execute } = require('@evershop/postgres-query-builder');
+
+// eslint-disable-next-line no-multi-assign
+module.exports = exports = async (connection) => {
+  await execute(
+    connection,
+    `CREATE TABLE "widget" (
+    "widget_id" INT GENERATED ALWAYS AS IDENTITY (START WITH 1 INCREMENT BY 1) PRIMARY KEY,
+    "uuid" UUID NOT NULL DEFAULT gen_random_uuid (),
+    "name" varchar NOT NULL,
+    "type" varchar NOT NULL,
+    "route" jsonb NOT NULL default '[]'::jsonb,
+    "area" jsonb NOT NULL default '[]'::jsonb,
+    "sort_order" INT NOT NULL DEFAULT 1,
+    "settings" jsonb NOT NULL default '{}'::jsonb,
+    "status" boolean DEFAULT NULL,
+    "created_at" TIMESTAMP WITH TIME ZONE DEFAULT CURRENT_TIMESTAMP,
+    "updated_at" TIMESTAMP WITH TIME ZONE DEFAULT CURRENT_TIMESTAMP,
+    CONSTRAINT "WIDGET_UUID" UNIQUE ("uuid")
+)`
+  );
+};