@knovator/pagecreator-node 1.1.9 → 1.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knovator/pagecreator-node",
-  "version": "1.1.9",
+  "version":  "1.2.0",
   "type": "commonjs",
   "author": "knovator (https://knovator.com/)",
   "description": "PageCreator Node.js module",
@@ -29,14 +29,11 @@
   },
   "peerDependencies": {
     "mongoose": "*",
-    "express": "*",
-    "tslib": "2.4.1"
+    "express": "*"
   },
   "files": [
     "src",
     "package.json",
     "README.md"
-  ],
-  "main": "./src/index.js",
-  "types": "./src/index.d.ts"
+  ]
 }

package/src/constants/index.ts

@@ -0,0 +1,30 @@
+export const VALIDATION = {
+  WIDGET_EXISTS: 'Widget with same code is available!',
+  SLUG_EXISTS: 'Widget with same slug is available!',
+};
+export const RESPONSE_CODES = {
+	DEFAULT: 'SUCCESS',
+	ERROR: 'ERROR',
+	VALIDATION_FAILED: 'VALIDATION_FAILED'
+};
+export const REGEXS = {
+	OBJECTID_CAST_FAILED: /Cast to ObjectId failed/gm,
+	IS_AVAILABLE: /is available!/gm
+};
+export const MONGOOSE_FIND_QUERIES = [
+	'count',
+	'find',
+	'findOne',
+	'findOneAndDelete',
+	'findOneAndRemove',
+	'findOneAndUpdate',
+	'update',
+	'updateOne',
+	'updateMany',
+];
+export const success = 200;
+export const create = 201;
+export const internalServerError = 500;
+export const validationError = 422;
+export const notFoundError = 404;
+export const messageRoutePrefix = 'msg';

package/src/controllers/PageController.ts

@@ -0,0 +1,88 @@
+import { Types } from 'mongoose';
+import { create, remove, update, list , checkUnique } from '../services/dbService';
+import {
+  successResponse,
+  createdDocumentResponse,
+} from './../utils/responseHandlers';
+import { IRequest, IResponse } from '../types';
+import { defaults } from '../utils/defaults';
+import { updateRedisPage } from '../services/dataService';
+import { VALIDATION } from '../constants';
+
+const catchAsync = (fn: any) => {
+  return defaults.catchAsync(fn, 'Page');
+};
+const getModals = (req: IRequest) => defaults.getModals(req);
+
+export const createPage = catchAsync(async (req: IRequest, res: IResponse) => {
+  const { Page } = getModals(req);
+  const data = req.body;
+
+  await checkUnique({
+    Modal: Page,
+    uniqueField: 'code',
+    value: data.code,
+    errorMessage: VALIDATION.WIDGET_EXISTS
+  });
+ 
+  await checkUnique({
+    Modal: Page,
+    uniqueField: 'slug',
+    value: data.slug,
+    errorMessage: VALIDATION.SLUG_EXISTS
+  });
+  const page = await create(Page, data);
+  res.message = req?.i18n?.t('page.create');
+  return createdDocumentResponse(page, res);
+});
+
+export const updatePage = catchAsync(async (req: IRequest, res: IResponse) => {
+  const models = getModals(req);
+  const data = req.body;
+  const _id = req.params['id'];
+  const updatedPage = await update(models['Page'], { _id }, data);
+  res.message = req?.i18n?.t('page.update');
+  if (updatedPage) updateRedisPage(updatedPage.code, models); // update redis
+  return successResponse(updatedPage, res);
+});
+
+export const deletePage = catchAsync(async (req: IRequest, res: IResponse) => {
+  const { Page } = getModals(req);
+  const _id = new Types.ObjectId(req.params['id']);
+  const createdPage = await remove(Page, { _id });
+  res.message = req?.i18n?.t('page.delete');
+  return successResponse(createdPage, res);
+});
+
+export const getPages = catchAsync(async (req: IRequest, res: IResponse) => {
+  const { Page } = getModals(req);
+  const search = req.body.search || '';
+  const { page, limit, populate, sort } = req.body.options;
+  const customOptions = {
+    populate,
+    sort,
+    ...(page && limit ? { page, limit } : {}),
+  };
+  const query = {
+    isDeleted: false,
+    $or: [
+      {
+        name: {
+          $regex: search,
+          $options: 'i',
+        },
+      },
+      {
+        code: {
+          $regex: search,
+          $options: 'i',
+        },
+      },
+    ],
+  };
+  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+  // @ts-ignore
+  const pages = await list(Page, query, customOptions);
+  res.message = req?.i18n?.t('page.getAll');
+  return successResponse(pages, res);
+});

package/src/controllers/TabController.ts

@@ -0,0 +1,47 @@
+import { Types } from 'mongoose';
+import { create, remove, update, getAll } from '../services/dbService';
+import {
+  successResponse,
+  createdDocumentResponse,
+} from './../utils/responseHandlers';
+
+import { defaults } from '../utils/defaults';
+import { IRequest, IResponse } from '../types';
+
+const catchAsync = (fn: any) => {
+  return defaults.catchAsync(fn, 'Tab');
+};
+const getModals = (req: IRequest) => defaults.getModals(req);
+
+export const createTab = catchAsync(async (req: IRequest, res: IResponse) => {
+  const { Tab } = getModals(req);
+  const data = req.body;
+  const tab = await create(Tab, data);
+  res.message = req?.i18n?.t('tab.create');
+  return createdDocumentResponse(tab, res);
+});
+
+export const updateTab = catchAsync(async (req: IRequest, res: IResponse) => {
+  const { Tab } = getModals(req);
+  const data = req.body;
+  const _id = req.params['tabId'];
+  const updatedTab = await update(Tab, { _id }, data);
+  res.message = req?.i18n?.t('tab.update');
+  return successResponse(updatedTab, res);
+});
+
+export const deleteTab = catchAsync(async (req: IRequest, res: IResponse) => {
+  const { Tab } = getModals(req);
+  const _id = new Types.ObjectId(req.params['tabId']);
+  const deletedTab = await remove(Tab, { _id });
+  res.message = req?.i18n?.t('tab.delete');
+  return successResponse(deletedTab, res);
+});
+
+export const getTabs = catchAsync(async (req: IRequest, res: IResponse) => {
+  const { Tab } = getModals(req);
+  const widgetId = new Types.ObjectId(req.params['widgetId']);
+  const tab = await getAll(Tab, { widgetId });
+  res.message = req?.i18n?.t('tab.getAll');
+  return successResponse(tab, res);
+});

package/src/controllers/UserController.ts

@@ -0,0 +1,69 @@
+import { getRedisValue, setRedisValue } from '../utils/redis';
+import { successResponse, recordNotFound } from './../utils/responseHandlers';
+import { defaults } from '../utils/defaults';
+import { IRequest, IResponse } from '../types';
+import { getPageDataDB, getWidgetDataDB } from '../services/dataService';
+
+const catchAsync = (fn: any) => {
+  return defaults.catchAsync(fn, 'User');
+};
+
+const getModals = (req: IRequest) => defaults.getModals(req);
+
+// TO Do: Optimize the following
+export const getWidgetData = catchAsync(
+  async (req: IRequest, res: IResponse) => {
+    const models = getModals(req);
+    const { fresh } = req.query;
+    const { code } = req.body;
+    let widgetData = await getRedisValue(`widgetData_${code}`);
+    if (widgetData && fresh !== 'true') {
+      return successResponse(widgetData, res);
+    }
+    widgetData = await getWidgetDataDB(code, models);
+
+    if (!widgetData) {
+      res.message = req?.i18n?.t('user.widgetNotFound');
+      return recordNotFound(res);
+    }
+
+    await setRedisValue(`widgetData_${code}`, widgetData);
+
+    return successResponse(widgetData, res);
+  }
+);
+
+// TO Do: Optimize the following
+export const getPageData = catchAsync(async (req: IRequest, res: IResponse) => {
+  const models = getModals(req);
+  const { fresh } = req.query;
+  let code = req.body.code;
+  const slug = req.body.slug;
+  const { Page } = models;
+  if (slug) {
+    const page = await Page.findOne({ slug });
+    if (!page) {
+      res.message = req?.i18n?.t('user.pageNotFound');
+      return recordNotFound(res);
+    }
+    code = page.code;
+  }
+  let pageData = await getRedisValue(`pageData_${code}`);
+  if (pageData && fresh !== 'true') {
+    return successResponse(pageData, res);
+  }
+  try {
+    pageData = await getPageDataDB(code, models);
+    console.log(code);
+  } catch (error) {
+    console.log(error);
+  }
+
+  if (!pageData) {
+    res.message = req?.i18n?.t('user.pageNotFound');
+    return recordNotFound(res);
+  }
+  await setRedisValue(`pageData_${code}`, pageData);
+
+  return successResponse(pageData, res);
+});

package/src/controllers/WidgetController.ts

@@ -0,0 +1,420 @@
+import { Models, Types } from 'mongoose';
+import {
+  create,
+  remove,
+  update,
+  list,
+  bulkInsert,
+  deleteAll,
+  getOne,
+  checkUnique,
+} from '../services/dbService';
+import { VALIDATION } from '../constants';
+import {
+  successResponse,
+  createdDocumentResponse,
+} from './../utils/responseHandlers';
+
+import { commonExcludedFields, defaults } from '../utils/defaults';
+import { formatCollectionItems, getCollectionModal } from '../utils/helper';
+import {
+  CollectionItem,
+  IRequest,
+  IResponse,
+  WidgetTypes,
+  TypesType,
+  ItemsType,
+} from '../types';
+import {
+  updateRedisWidget,
+  updateWidgetPagesData,
+} from '../services/dataService';
+
+const catchAsync = (fn: any) => {
+  return defaults.catchAsync(fn, 'Widget');
+};
+
+const getModals = (req: IRequest) => defaults.getModals(req);
+
+const deleteItems = async (widgetId: string, models: Models) => {
+  const { Item } = models;
+  await deleteAll(Item, { widgetId: new Types.ObjectId(widgetId) });
+};
+const createItems = async (
+  itemsData: any[],
+  widgetId: string,
+  models: Models
+) => {
+  const { Item, SrcSet } = models;
+  itemsData = itemsData.map((item: any) => ({
+    ...item,
+    _id: new Types.ObjectId(),
+    widgetId,
+  }));
+  const srcSetItems = itemsData.reduce((acc: any[], item: any) => {
+    if (Array.isArray(item.srcset)) {
+      acc.push(
+        ...item.srcset.map((srcSetItem: any) => ({
+          ...srcSetItem,
+          itemId: item._id,
+        }))
+      );
+      delete item.srcset;
+    }
+    return acc;
+  }, []);
+  await bulkInsert(Item, itemsData);
+  await bulkInsert(SrcSet, srcSetItems);
+};
+
+export const createWidget = catchAsync(
+  async (req: IRequest, res: IResponse) => {
+    const models = getModals(req);
+    const data = req.body;
+    let items = [];
+   
+    await checkUnique({
+      Modal: models['Widget'],
+      uniqueField: 'code',
+      value: data.code,
+      errorMessage: VALIDATION.WIDGET_EXISTS
+    });
+
+    if ('items' in data) {
+      items = JSON.parse(JSON.stringify(data.items));
+      delete data.items;
+    }
+    const widget = await create(models['Widget'], data);
+    if (items.length > 0) {
+      await createItems(items, widget._id, models);
+    }
+    res.message = req?.i18n?.t('widget.create');
+    return createdDocumentResponse(widget, res);
+  }
+);
+
+export const updateWidget = catchAsync(
+  async (req: IRequest, res: IResponse) => {
+    const models = getModals(req);
+    const data = req.body;
+    const _id = req.params['id'];
+    let items = [];
+    if ('items' in data) {
+      items = JSON.parse(JSON.stringify(data.items));
+      delete data.items;
+    }
+    const updatedWidget = await update(models['Widget'], { _id }, data);
+    if (items.length > 0 && updatedWidget) {
+      await deleteItems(_id, models);
+      await createItems(items, updatedWidget._id, models);
+    }
+    if (updatedWidget) {
+      updateRedisWidget(updatedWidget.code, models);
+      updateWidgetPagesData([updatedWidget.id], models);
+    }
+    res.message = req?.i18n?.t('widget.update');
+    return successResponse(updatedWidget, res);
+  }
+);
+
+export const deleteWidget = catchAsync(
+  async (req: IRequest, res: IResponse) => {
+    const models = getModals(req);
+    await deleteItems(req.params['id'], models);
+    const _id = new Types.ObjectId(req.params['id']);
+    const deletedWidget = await remove(models['Widget'], { _id });
+    if (deletedWidget) {
+      updateRedisWidget(deletedWidget.code, models);
+      updateWidgetPagesData([deletedWidget.id], models);
+    }
+    res.message = req?.i18n?.t('widget.delete');
+    return successResponse(deletedWidget, res);
+  }
+);
+
+export const getWidgets = catchAsync(async (req: IRequest, res: IResponse) => {
+  const { Widget } = getModals(req);
+  const search = req.body.search || '';
+  const { collectionItems } = req.body;
+  const { page, limit, sort } = req.body.options;
+  const all =
+    (typeof req.body.all !== 'undefined' && req.body.all === true) || false;
+  const isActive =
+    typeof req.body.isActive !== 'undefined'
+      ? req.body.isActive || false
+      : null;
+  const customOptions = {
+    pagination: !all,
+    sort,
+    select: 'name code isActive canDel',
+    ...(page && limit ? { page, limit } : {}),
+  };
+  const orOptions: any = [];
+  if (search) {
+    orOptions.push({ name: { $regex: search, $options: 'i' } });
+    orOptions.push({ code: { $regex: search, $options: 'i' } });
+  } else {
+    orOptions.push({});
+  }
+  if (Array.isArray(collectionItems) && collectionItems.length) {
+    orOptions.push({ _id: { $in: collectionItems } });
+  }
+  const query = {
+    isDeleted: false,
+    isActive: { $in: isActive === null ? [true, false] : [isActive] },
+    $or: orOptions,
+  };
+  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+  // @ts-ignore
+  const notifications = await list(Widget, query, customOptions);
+  res.message = req?.i18n?.t('widget.getAll');
+  return successResponse(notifications, res);
+});
+
+export const getSingleWidget = catchAsync(
+  async (req: IRequest, res: IResponse) => {
+    const { Widget, Item } = getModals(req);
+    const _id = req.params['id'];
+    const widget = await (
+      await getOne(Widget, { _id, isDeleted: true })
+    ).toJSON();
+    widget['items'] = await Item.aggregate([
+      {
+        $match: {
+          widgetId: new Types.ObjectId(_id),
+          isDeleted: false,
+        },
+      },
+      {
+        $project: {
+          ...commonExcludedFields,
+        },
+      },
+      ...(defaults.languages && defaults.languages?.length > 0
+        ? defaults.languages.reduce((arr: any[], lng) => {
+            arr.push(
+              {
+                $lookup: {
+                  from: 'file',
+                  let: { imgsId: { $toObjectId: `$imgs.${lng.code}` } },
+                  as: `imgs.${lng.code}`,
+                  pipeline: [
+                    {
+                      $match: {
+                        $expr: {
+                          $eq: ['$_id', '$$imgsId'],
+                        },
+                      },
+                    },
+                    {
+                      $project: {
+                        ...commonExcludedFields,
+                        width: 0,
+                        module: 0,
+                        height: 0,
+                      },
+                    },
+                  ],
+                },
+              },
+              {
+                $unwind: {
+                  path: `$imgs.${lng.code}`,
+                  preserveNullAndEmptyArrays: true,
+                },
+              }
+            );
+            return arr;
+          }, [])
+        : [
+            {
+              $lookup: {
+                from: 'file',
+                let: { imgId: '$img' },
+                as: 'img',
+                pipeline: [
+                  {
+                    $match: {
+                      $expr: {
+                        $eq: ['$_id', '$$imgId'],
+                      },
+                    },
+                  },
+                  {
+                    $project: {
+                      ...commonExcludedFields,
+                      width: 0,
+                      module: 0,
+                      height: 0,
+                    },
+                  },
+                ],
+              },
+            },
+            {
+              $unwind: {
+                path: '$img',
+                preserveNullAndEmptyArrays: true,
+              },
+            },
+          ]),
+      {
+        $lookup: {
+          from: 'srcsets',
+          let: { item: '$_id' },
+          as: 'srcset',
+          pipeline: [
+            {
+              $match: {
+                $expr: {
+                  $eq: ['$itemId', '$$item'],
+                },
+              },
+            },
+            {
+              $project: {
+                ...commonExcludedFields,
+                _id: 0,
+                itemId: 0,
+              },
+            },
+          ],
+        },
+      },
+    ]);
+    res.message = req?.i18n?.t('widget.getOne');
+    return successResponse(widget, res);
+  }
+);
+
+export const partialUpdateWidget = catchAsync(
+  async (req: IRequest, res: IResponse) => {
+    const models = getModals(req);
+    const data = req.body;
+    const _id = req.params['id'];
+    const updatedWidget = await update(models['Widget'], { _id }, data);
+    if (updatedWidget) {
+      updateRedisWidget(updatedWidget.code, models);
+      updateWidgetPagesData([updatedWidget.id], models);
+    }
+    res.message = req?.i18n?.t('widget.partialUpdate');
+    return successResponse(updatedWidget, res);
+  }
+);
+
+export const getItemsTypes = catchAsync(
+  async (req: IRequest, res: IResponse) => {
+    const itemsTypes: TypesType[] = [
+      {
+        value: Object.keys(ItemsType)[0],
+        label: Object.values(ItemsType)[0],
+      },
+    ];
+    defaults.collections.forEach((item: CollectionItem) => {
+      itemsTypes.push({
+        value: item.collectionName,
+        label: item.title,
+      });
+    });
+    res.message = req?.i18n?.t('widget.getItemsTypes');
+    return successResponse(itemsTypes, res);
+  }
+);
+
+export const getWidgetTypes = catchAsync(
+  async (req: IRequest, res: IResponse) => {
+    const widgetTypes: any[] = Object.entries(WidgetTypes).map((e) => ({
+      label: e[1],
+      value: e[0],
+    }));
+    if (
+      Array.isArray(defaults.customWidgetTypes) &&
+      defaults.customWidgetTypes.length > 0
+    ) {
+      widgetTypes.push(...defaults.customWidgetTypes);
+    }
+    res.message = req?.i18n?.t('widget.getWidgetTypes');
+    return successResponse(widgetTypes, res);
+  }
+);
+
+export const getCollectionData = catchAsync(async (req: IRequest, res: IResponse) => {
+  const models = getModals(req);
+  const { search, collectionName, collectionItems } = req.body;
+  const collectionItem: CollectionItem | undefined = defaults.collections.find(
+    (collection) => collection.collectionName === collectionName
+  );
+  if (!collectionItem) {
+    throw new Error(`No collection is specified with ${collectionName}`);
+  }
+  let limit = collectionItem.searchLimit || 10;
+  if (Array.isArray(collectionItems))
+    limit = Math.max(collectionItems.length, limit);
+  // setting up mongoose model
+  const TempModel = getCollectionModal(collectionName, models);
+  // fetching data
+  let query: any = collectionItem.filters || {};
+  const orOptions: any = [];
+  let addFieldOptions: any = {};
+  if (
+    search &&
+    Array.isArray(collectionItem.searchColumns) &&
+    collectionItem.searchColumns.length
+  ) {
+    collectionItem.searchColumns.forEach((column) =>
+      orOptions.push({
+        [column]: {
+          $regex: search,
+          $options: 'i',
+        },
+      })
+    );
+  } else {
+    orOptions.push({});
+  }
+  if (Array.isArray(collectionItems) && collectionItems.length) {
+    addFieldOptions = {
+      __order: {
+        $indexOfArray: [
+          collectionItems,
+          {
+            $toString: '$_id',
+          },
+        ],
+      },
+    };
+    orOptions.push({ _id: { $in: formatCollectionItems(collectionItems) } });
+  }
+  if (orOptions.length > 0) {
+    query = {
+      ...query,
+      $or: orOptions,
+    };
+  }
+  const collectionData = await TempModel.aggregate([
+    ...(Array.isArray(collectionItem.aggregations)
+      ? collectionItem.aggregations
+      : []),
+    {
+      $match: query,
+    },
+    { $addFields: addFieldOptions },
+    {
+      $sort: {
+        __order: -1,
+      },
+    },
+    {
+      $limit: limit,
+    },
+  ]);
+  res.message = req?.i18n?.t('widget.getCollectionData');
+  return successResponse({ docs: collectionData }, res);
+});
+
+export const getLanguages = catchAsync(async (req: any, res: any) => {
+  return successResponse(
+    Array.isArray(defaults.languages) ? defaults.languages : [],
+    res
+  );
+});