@evershop/evershop 2.1.1 → 2.1.2

package/src/modules/cms/api/updateCmsPage/{finish[apiResponse].js → finish[apiResponse].ts}

@@ -1,9 +1,15 @@
 import { getDelegate } from '../../../../lib/middleware/delegate.js';
 import { buildUrl } from '../../../../lib/router/buildUrl.js';
 import { OK } from '../../../../lib/util/httpStatus.js';
+import { EvershopRequest } from '../../../../types/request.js';
+import { EvershopResponse } from '../../../../types/response.js';
 
-export default async (request, response, next) => {
-  const page = await getDelegate('updatePage', request);
+export default async (
+  request: EvershopRequest,
+  response: EvershopResponse,
+  next
+) => {
+  const page = await getDelegate<Record<string, any>>('updatePage', request);
   response.status(OK);
   response.json({
     data: {
@@ -17,13 +23,13 @@ export default async (request, response, next) => {
         },
         {
           rel: 'edit',
-          href: buildUrl('cmsPageEdit', { id: page.uuid }),
+          href: buildUrl('cmsPageEdit', { id: page?.uuid }),
           action: 'GET',
           types: ['text/xml']
         },
         {
           rel: 'view',
-          href: buildUrl('cmsPageView', { url_key: page.url_key }),
+          href: buildUrl('cmsPageView', { url_key: page?.url_key }),
           action: 'GET',
           types: ['text/xml']
         }

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

@@ -0,0 +1,76 @@
+{
+  "type": "object",
+  "properties": {
+    "content": {
+      "type": "array",
+      "skipEscape": true,
+      "items": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "errorMessage": {
+              "type": "Content block ID must be a string"
+            }
+          },
+          "size": {
+            "type": "number",
+            "errorMessage": {
+              "type": "Content block size must be a number"
+            }
+          },
+          "columns": {
+            "type": "array",
+            "items": {
+              "type": "object",
+              "properties": {
+                "id": {
+                  "type": "string",
+                  "errorMessage": {
+                    "type": "Column ID must be a string"
+                  }
+                },
+                "size": {
+                  "type": "number",
+                  "errorMessage": {
+                    "type": "Column size must be a number"
+                  }
+                },
+                "data": {
+                  "type": "object",
+                  "errorMessage": {
+                    "type": "Column data must be an object"
+                  }
+                }
+              },
+              "required": ["id", "size", "data"],
+              "errorMessage": {
+                "required": {
+                  "id": "Column ID is required",
+                  "size": "Column size is required",
+                  "data": "Column data is required"
+                }
+              }
+            },
+            "errorMessage": {
+              "type": "Columns must be an array"
+            }
+          }
+        },
+        "required": ["id", "size", "columns"],
+        "errorMessage": {
+          "required": {
+            "id": "Content block ID is required",
+            "size": "Content block size is required",
+            "columns": "Content block columns are required"
+          }
+        }
+      },
+      "default": [],
+      "errorMessage": {
+        "type": "Content must be an array"
+      }
+    }
+  },
+  "additionalProperties": true
+}

package/src/modules/cms/api/updateCmsPage/{updatePage[finish].js → updatePage[finish].ts}

@@ -1,6 +1,7 @@
+import { EvershopRequest } from '../../../../types/request.js';
 import updatePage from '../../services/page/updatePage.js';
 
-export default async (request, response) => {
+export default async (request: EvershopRequest, response) => {
   const data = request.body;
   const page = await updatePage(request.params.id, data, {
     routeId: request.currentRoute.id

package/src/modules/cms/{bootstrap.js → bootstrap.ts}

@@ -1,4 +1,5 @@
 import path from 'path';
+import { JSONSchemaType } from 'ajv';
 import config from 'config';
 import { CONSTANTS } from '../../lib/helpers.js';
 import { defaultPaginationFilters } from '../../lib/util/defaultPaginationFilters.js';
@@ -7,6 +8,7 @@ import { addProcessor } from '../../lib/util/registry.js';
 import { registerWidget } from '../../lib/widget/widgetManager.js';
 import { registerDefaultPageCollectionFilters } from '../../modules/cms/services/registerDefaultPageCollectionFilters.js';
 import { registerDefaultWidgetCollectionFilters } from '../../modules/cms/services/registerDefaultWidgetCollectionFilters.js';
+import { Route } from '../../types/route.js';
 
 export default () => {
   addProcessor('configurationSchema', (schema) => {
@@ -184,6 +186,7 @@ export default () => {
     ),
     name: 'Menu',
     description: 'Navigation links',
+    defaultSettings: {},
     enabled: true
   });
 
@@ -194,6 +197,7 @@ export default () => {
       'cms/components/BannerSetting.js'
     ),
     component: path.resolve(CONSTANTS.MODULESPATH, 'cms/components/Banner.js'),
+    defaultSettings: {},
     name: 'Banner',
     description: 'Image with call-to-action',
     enabled: true
@@ -209,6 +213,7 @@ export default () => {
       CONSTANTS.MODULESPATH,
       'cms/components/Slideshow.js'
     ),
+    defaultSettings: {},
     name: 'Simple Slideshow',
     description: 'Rotating image carousel',
     enabled: true
@@ -220,21 +225,37 @@ export default () => {
     registerDefaultPageCollectionFilters,
     1
   );
-  addProcessor(
+  addProcessor<Array<any>>(
     'cmsPageCollectionFilters',
     (filters) => [...filters, ...defaultPaginationFilters],
     2
   );
 
   // Reigtering the default filters for widget collection
-  addProcessor(
+  addProcessor<Array<any>>(
     'widgetCollectionFilters',
     registerDefaultWidgetCollectionFilters,
     1
   );
-  addProcessor(
+  addProcessor<Array<any>>(
     'widgetCollectionFilters',
     (filters) => [...filters, ...defaultPaginationFilters],
     2
   );
+
+  addProcessor('payloadSchema', function (schema: JSONSchemaType<any>) {
+    const ctx = this as { route: Route };
+    const route = ctx.route;
+    if (route.id === 'createWidget' || route.id === 'updateWidget') {
+      schema.properties.settings = {
+        properties: {
+          text: {
+            type: 'string',
+            skipEscape: true
+          }
+        }
+      };
+    }
+    return schema;
+  });
 };

package/src/modules/cms/components/BasicMenu.tsx

@@ -6,7 +6,7 @@ import {
   NavigationMenuLink,
   NavigationMenuList,
   NavigationMenuTrigger
-} from '@evershop/evershop/components/common/ui/NavigationMenu';
+} from '@components/common/ui/NavigationMenu.js';
 import { cn } from '@evershop/evershop/lib/util/cn';
 import React from 'react';
 

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

@@ -1,4 +1,3 @@
-import sanitize from 'sanitize-html';
 import { v4 as uuidv4 } from 'uuid';
 import { buildUrl } from '../../../../../lib/router/buildUrl.js';
 import { camelCase } from '../../../../../lib/util/camelCase.js';
@@ -41,26 +40,6 @@ export default {
     content: ({ content }) => {
       try {
         const json = JSON.parse(content);
-        // Loop through each row and find the columns with raw block type. Use dompurify to sanitize the HTML content.
-        json.forEach((row: any) => {
-          row.columns.forEach((column: any) => {
-            column.data.blocks.forEach((block: any) => {
-              if (block.type === 'raw' && block.data.html) {
-                const replacements = {
-                  '&lt;': '<',
-                  '&gt;': '>'
-                };
-                const jsonText = block.data.html
-                  ? block.data.html.replace(
-                      /&lt;|&gt;/g,
-                      (match) => replacements[match]
-                    )
-                  : '';
-                block.data.html = sanitize(jsonText);
-              }
-            });
-          });
-        });
         return json;
       } catch (e) {
         // This is for backward compatibility. If the content is not a JSON string then it is a raw HTML block

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

@@ -56,26 +56,6 @@ export default {
           return { text: [], className };
         }
         const json = JSON.parse(text);
-        // Loop through each row and find the columns with raw block type. Use dompurify to sanitize the HTML content.
-        json.forEach((row) => {
-          row.columns.forEach((column) => {
-            column.data.blocks.forEach((block) => {
-              if (block.type === 'raw' && block.data.html) {
-                const replacements = {
-                  '&lt;': '<',
-                  '&gt;': '>'
-                };
-                const jsonText = block.data.html
-                  ? block.data.html.replace(
-                      /&lt;|&gt;/g,
-                      (match) => replacements[match]
-                    )
-                  : '';
-                block.data.html = sanitizeHtml(jsonText);
-              }
-            });
-          });
-        });
         return {
           text: json,
           className

package/src/modules/cms/services/index.ts

@@ -2,3 +2,6 @@ export * from './browFiles.js';
 export * from './createFolder.js';
 export * from './deleteFile.js';
 export * from './uploadFile.js';
+export * from './page/createPage.js';
+export * from './page/deletePage.js';
+export * from './page/updatePage.js';

package/src/modules/cms/services/page/{createPage.js → createPage.ts}

@@ -5,15 +5,17 @@ import {
   startTransaction
 } from '@evershop/postgres-query-builder';
 import { getConnection } from '../../../../lib/postgres/connection.js';
-import { hookable } from '../../../../lib/util/hookable.js';
+import { hookable, hookBefore, hookAfter } from '../../../../lib/util/hookable.js';
 import {
   getValue,
   getValueSync
 } from '../../../../lib/util/registry.js';
+import { sanitizeRawHtml } from '../../../../lib/util/sanitizeHtml.js';
+import type { CmsPageRow, CmsPageDescriptionRow } from '../../../../types/db/index.js';
 import { getAjv } from '../../../base/services/getAjv.js';
 import pageDataSchema from './pageDataSchema.json' with { type: 'json' };
 
-function validatePageDataBeforeInsert(data) {
+function validatePageDataBeforeInsert(data): any {
   const ajv = getAjv();
   pageDataSchema.required = [
     'status',
@@ -22,7 +24,7 @@ function validatePageDataBeforeInsert(data) {
     'content',
     'meta_title'
   ];
-  const jsonSchema = getValueSync('createPageDataJsonSchema', pageDataSchema);
+  const jsonSchema = getValueSync('createPageDataJsonSchema', pageDataSchema, {});
   const validate = ajv.compile(jsonSchema);
   const valid = validate(data);
   if (valid) {
@@ -32,7 +34,7 @@ function validatePageDataBeforeInsert(data) {
   }
 }
 
-async function insertPageData(data, connection) {
+async function insertPageData(data, connection): Promise<CmsPageRow & CmsPageDescriptionRow> {
   const page = await insert('cms_page').given(data).execute(connection);
   const description = await insert('cms_page_description')
     .given(data)
@@ -50,14 +52,17 @@ async function insertPageData(data, connection) {
  * @param {Object} data
  * @param {Object} context
  */
-async function createPage(data, context) {
+const _createPage = async function createPage(data, context): Promise<CmsPageRow & CmsPageDescriptionRow> {
   const connection = await getConnection();
   await startTransaction(connection);
   try {
     const pageData = await getValue('pageDataBeforeCreate', data);
     // Validate page data
     validatePageDataBeforeInsert(pageData);
-
+// Sanitize raw HTML blocks in EditorJS content
+    if (pageData.content) {
+      sanitizeRawHtml(pageData.content);
+    }
     // Insert page data
     const page = await hookable(insertPageData, { ...context, connection })(
       pageData,
@@ -72,11 +77,63 @@ async function createPage(data, context) {
   }
 }
 
-export default async (data, context) => {
+export async function createPage(data, context): Promise<CmsPageRow & CmsPageDescriptionRow> {
   // Make sure the context is either not provided or is an object
   if (context && typeof context !== 'object') {
     throw new Error('Context must be an object');
   }
-  const page = await hookable(createPage, context)(data, context);
+  const page = await hookable(_createPage, context)(data, context);
   return page;
 };
+
+export function hookBeforeInsertPageData(
+  callback: (
+    this: Record<string, any>,
+    ...args: [
+    data: any,
+    connection: any
+    ]
+  ) => void | Promise<void>,
+  priority: number = 10
+): void {
+  hookBefore('insertPageData', callback, priority);
+}
+
+export function hookAfterInsertPageData(
+  callback: (
+    this: Record<string, any>,
+    ...args: [
+    data: any,
+    connection: any
+    ]
+  ) => void | Promise<void>,
+  priority: number = 10
+): void {
+  hookAfter('insertPageData', callback, priority);
+}
+
+export function hookBeforeCreatePage(
+  callback: (
+    this: Record<string, any>,
+    ...args: [
+    data: any,
+    context: any
+    ]
+  ) => void | Promise<void>,
+  priority: number = 10
+): void {
+  hookBefore('createPage', callback, priority);
+}
+
+export function hookAfterCreatePage(
+  callback: (
+    this: Record<string, any>,
+    ...args: [
+    data: any,
+    context: any
+    ]
+  ) => void | Promise<void>,
+  priority: number = 10
+): void {
+  hookAfter('createPage', callback, priority);
+}

package/src/modules/cms/services/page/deletePage.ts

@@ -0,0 +1,109 @@
+import {
+  commit,
+  del,
+  rollback,
+  select,
+  startTransaction
+} from '@evershop/postgres-query-builder';
+import { getConnection } from '../../../../lib/postgres/connection.js';
+import {
+  hookable,
+  hookBefore,
+  hookAfter
+} from '../../../../lib/util/hookable.js';
+import type {
+  CmsPageRow,
+  CmsPageDescriptionRow
+} from '../../../../types/db/index.js';
+
+async function deletePageData(uuid, connection): Promise<void> {
+  await del('cms_page').where('uuid', '=', uuid).execute(connection);
+}
+/**
+ * Delete page service. This service will delete a page with all related data
+ * @param {String} uuid
+ * @param {Object} context
+ */
+const _deletePage = async function deletePage(
+  uuid,
+  context
+): Promise<CmsPageRow & CmsPageDescriptionRow> {
+  const connection = await getConnection();
+  await startTransaction(connection);
+  try {
+    const query = select().from('cms_page');
+    query
+      .leftJoin('cms_page_description')
+      .on(
+        'cms_page_description.cms_page_description_cms_page_id',
+        '=',
+        'cms_page.cms_page_id'
+      );
+
+    const page = await query.where('uuid', '=', uuid).load(connection);
+    if (!page) {
+      throw new Error('Invalid page id');
+    }
+    await hookable(deletePageData, { ...context, page, connection })(
+      uuid,
+      connection
+    );
+    await commit(connection);
+    return page;
+  } catch (e) {
+    await rollback(connection);
+    throw e;
+  }
+};
+
+export async function deletePage(
+  uuid,
+  context
+): Promise<CmsPageRow & CmsPageDescriptionRow> {
+  // Make sure the context is either not provided or is an object
+  if (context && typeof context !== 'object') {
+    throw new Error('Context must be an object');
+  }
+  const page = await hookable(_deletePage, context)(uuid, context);
+  return page;
+}
+
+export function hookBeforeDeletePageData(
+  callback: (
+    this: Record<string, any>,
+    ...args: [uuid: any, connection: any]
+  ) => void | Promise<void>,
+  priority: number = 10
+): void {
+  hookBefore('deletePageData', callback, priority);
+}
+
+export function hookAfterDeletePageData(
+  callback: (
+    this: Record<string, any>,
+    ...args: [uuid: any, connection: any]
+  ) => void | Promise<void>,
+  priority: number = 10
+): void {
+  hookAfter('deletePageData', callback, priority);
+}
+
+export function hookBeforeDeletePage(
+  callback: (
+    this: Record<string, any>,
+    ...args: [uuid: any, context: any]
+  ) => void | Promise<void>,
+  priority: number = 10
+): void {
+  hookBefore('deletePage', callback, priority);
+}
+
+export function hookAfterDeletePage(
+  callback: (
+    this: Record<string, any>,
+    ...args: [uuid: any, context: any]
+  ) => void | Promise<void>,
+  priority: number = 10
+): void {
+  hookAfter('deletePage', callback, priority);
+}

package/src/modules/cms/services/page/pageDataSchema.json

@@ -111,5 +111,13 @@
       }
     }
   },
-  "additionalProperties": true
+  "additionalProperties": true,
+  "required": [
+    "status",
+    "name",
+    "content",
+    "url_key",
+    "meta_title",
+    "meta_description"
+  ]
 }

package/src/modules/cms/services/page/{updatePage.js → updatePage.ts}

@@ -6,18 +6,20 @@ import {
   update
 } from '@evershop/postgres-query-builder';
 import { getConnection } from '../../../../lib/postgres/connection.js';
-import { hookable } from '../../../../lib/util/hookable.js';
+import { hookable, hookBefore, hookAfter } from '../../../../lib/util/hookable.js';
 import {
   getValue,
   getValueSync
 } from '../../../../lib/util/registry.js';
+import { sanitizeRawHtml } from '../../../../lib/util/sanitizeHtml.js';
+import type { CmsPageRow, CmsPageDescriptionRow } from '../../../../types/db/index.js';
 import { getAjv } from '../../../base/services/getAjv.js';
 import pageDataSchema from './pageDataSchema.json' with { type: 'json' };
 
-function validatePageDataBeforeInsert(data) {
+function validatePageDataBeforeInsert(data): any {
   const ajv = getAjv();
   pageDataSchema.required = ['status'];
-  const jsonSchema = getValueSync('updatePageDataJsonSchema', pageDataSchema);
+  const jsonSchema = getValueSync('updatePageDataJsonSchema', pageDataSchema, {});
   const validate = ajv.compile(jsonSchema);
   const valid = validate(data);
   if (valid) {
@@ -27,7 +29,7 @@ function validatePageDataBeforeInsert(data) {
   }
 }
 
-async function updatePageData(uuid, data, connection) {
+async function updatePageData(uuid, data, connection): Promise<CmsPageRow & CmsPageDescriptionRow> {
   const query = select().from('cms_page');
   query
     .leftJoin('cms_page_description')
@@ -71,13 +73,17 @@ async function updatePageData(uuid, data, connection) {
  * @param {Object} data
  * @param {Object} context
  */
-async function updatePage(uuid, data, context) {
+async function updatePage(uuid, data, context): Promise<CmsPageRow & CmsPageDescriptionRow> {
   const connection = await getConnection();
   await startTransaction(connection);
   try {
     const pageData = await getValue('pageDataBeforeUpdate', data);
     // Validate page data
     validatePageDataBeforeInsert(pageData);
+    // Sanitize raw HTML blocks in EditorJS content
+    if (pageData.content) {
+      sanitizeRawHtml(pageData.content);
+    }
 
     // Insert page data
     const page = await hookable(updatePageData, { ...context, connection })(
@@ -94,7 +100,7 @@ async function updatePage(uuid, data, context) {
   }
 }
 
-export default async (uuid, data, context) => {
+export default async (uuid, data, context): Promise<CmsPageRow & CmsPageDescriptionRow> => {
   // Make sure the context is either not provided or is an object
   if (context && typeof context !== 'object') {
     throw new Error('Context must be an object');
@@ -102,3 +108,59 @@ export default async (uuid, data, context) => {
   const page = await hookable(updatePage, context)(uuid, data, context);
   return page;
 };
+
+export function hookBeforeUpdatePageData(
+  callback: (
+    this: Record<string, any>,
+    ...args: [
+    uuid: any,
+    data: any,
+    connection: any
+    ]
+  ) => void | Promise<void>,
+  priority: number = 10
+): void {
+  hookBefore('updatePageData', callback, priority);
+}
+
+export function hookAfterUpdatePageData(
+  callback: (
+    this: Record<string, any>,
+    ...args: [
+    uuid: any,
+    data: any,
+    connection: any
+    ]
+  ) => void | Promise<void>,
+  priority: number = 10
+): void {
+  hookAfter('updatePageData', callback, priority);
+}
+
+export function hookBeforeUpdatePage(
+  callback: (
+    this: Record<string, any>,
+    ...args: [
+    uuid: any,
+    data: any,
+    context: any
+    ]
+  ) => void | Promise<void>,
+  priority: number = 10
+): void {
+  hookBefore('updatePage', callback, priority);
+}
+
+export function hookAfterUpdatePage(
+  callback: (
+    this: Record<string, any>,
+    ...args: [
+    uuid: any,
+    data: any,
+    context: any
+    ]
+  ) => void | Promise<void>,
+  priority: number = 10
+): void {
+  hookAfter('updatePage', callback, priority);
+}