@knovator/pagecreator-node 0.0.7 → 0.2.0

package/README.md

@@ -78,7 +78,7 @@
 
 ## Getting Started
 
-To integrate `@knovator/pagecreator-node`, you should be having basic nodejs application up and running with express (optionally using mongoose for mongodb database). `@knovator/pagecreator-node` provides routes for `widget`, `page`, `tile` and `user` to use in application.
+To integrate `@knovator/pagecreator-node`, you should be having basic nodejs application up and running with express (optionally using mongoose for mongodb database). `@knovator/pagecreator-node` provides routes for `widget`, `page`, `item` and `user` to use in application.
 
 ### Prerequisites
 
@@ -172,7 +172,7 @@ App/Main file is a good place to use `@knovator/pagecreator-node`
 const {
   setConfig,
   WidgetRoutes,
-  TileRoutes,
+  ItemRoutes,
   FileUploadRoute,
   PageRoutes,
   UserRoutes,
@@ -190,7 +190,7 @@ setConfig({
 });
 
 app.use('/widgets', WidgetRoutes);
-app.use('/tiles', TileRoutes);
+app.use('/items', ItemRoutes);
 app.use('/media', FileUploadRoute);
 app.use('/pages', PageRoutes);
 app.use('/users', UserRoutes);
@@ -349,14 +349,14 @@ This are the routes that gets integrated by `@knovator/pagecreator-node`,
 | `/:id`  | **PUT**    | Update `page`                       |
 | `/:id`  | **DELETE** | Delete page whose `id` send in body |
 
-#### Tile
+#### Item
 
 | Route        | Method     | Description                         |
 | ------------ | ---------- | ----------------------------------- |
-| `/:widgetId` | **GET**    | Get Tiles data for `widgetId`       |
-| `/`          | **POST**   | Create `tile`                       |
-| `/:id`       | **PUT**    | Update `tile`                       |
-| `/:id`       | **DELETE** | Delete tile whose `id` send in body |
+| `/:widgetId` | **GET**    | Get Items data for `widgetId`       |
+| `/`          | **POST**   | Create `item`                       |
+| `/:id`       | **PUT**    | Update `item`                       |
+| `/:id`       | **DELETE** | Delete item whose `id` send in body |
 
 #### User
 
@@ -376,8 +376,8 @@ req?.i18n?.(CODE);
 
 | CODE                       | Description                                                  |
 | -------------------------- | ------------------------------------------------------------ |
-| `widget.getWidgetTypes`    | While fetching widget types                                  |
-| `widget.getSelectionTypes` | While fetching selection types                               |
+| `widget.getItemsTypes`    | While fetching widget types                                  |
+| `widget.getWidgetTypes` | While fetching selection types                               |
 | `widget.getAll`            | While fetching widgets                                       |
 | `widget.create`            | While creating widget                                        |
 | `widget.update`            | While updating widget                                        |
@@ -388,9 +388,9 @@ req?.i18n?.(CODE);
 | `page.create`              | While creating page                                          |
 | `page.update`              | While updating page                                          |
 | `page.delete`              | While deleting page                                          |
-| `tile.getAll`              | While getting tiles for widget                               |
-| `tile.create`              | While creating tile                                          |
-| `tile.update`              | While updating tile                                          |
+| `item.getAll`              | While getting items for widget                               |
+| `item.create`              | While creating item                                          |
+| `item.update`              | While updating item                                          |
 | `user.getWidgetData`       | While getting widget data                                    |
 | `user.getPageData`         | While getting page data                                      |
 

package/package.json

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

package/src/constants/index.ts

@@ -0,0 +1,26 @@
+export const VALIDATION = {
+	WIDGET_EXISTS: 'Widget with same code is available',
+};
+export const RESPONSE_CODES = {
+	DEFAULT: 'SUCCESS',
+	ERROR: 'ERROR',
+};
+export const REGEXS = {
+	OBJECTID_CAST_FAILED: /Cast to ObjectId failed/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 messageRoutePrefix = 'msg';

package/src/controllers/ItemController.ts

@@ -0,0 +1,139 @@
+import { Types } from 'mongoose';
+import { SrcSet, Item } from '../models';
+import {
+  create,
+  remove,
+  update,
+  deleteAll,
+  bulkInsert,
+} from '../services/dbService';
+import {
+  successResponse,
+  createdDocumentResponse,
+} from '../utils/responseHandlers';
+
+import { commonExcludedFields, defaults } from '../utils/defaults';
+import { IRequest, IResponse, IItemSchema, SrcSetItem } from '../types';
+
+const catchAsync = (fn: any) => {
+  return defaults.catchAsync(fn, 'Notification');
+};
+
+export const createItem = catchAsync(async (req: IRequest, res: IResponse) => {
+  const data = req.body;
+  const createdItem = (await create(Item, data)) as IItemSchema;
+  let response = createdItem.toJSON();
+  if (data.srcset) {
+    response = {
+      ...response,
+      srcset: (await updateItemSrcSet(
+        createdItem._id,
+        data.srcset
+      )) as SrcSetItem[],
+    };
+  }
+  res.message = req?.i18n?.t('item.create');
+  return createdDocumentResponse(response, res);
+});
+
+export const updateItem = catchAsync(async (req: IRequest, res: IResponse) => {
+  const data = req.body;
+  const _id = req.params['id'];
+  const updatedItem = (await update(Item, { _id }, data)) as IItemSchema;
+  let response = updatedItem.toJSON();
+  if (data.srcset) {
+    response = {
+      ...response,
+      srcset: (await updateItemSrcSet(_id, data.srcset)) as SrcSetItem[],
+    };
+  }
+  res.message = req?.i18n?.t('item.update');
+  return successResponse(response, res);
+});
+
+export const deleteItem = catchAsync(async (req: IRequest, res: IResponse) => {
+  const _id = new Types.ObjectId(req.params['id']);
+  const deletedItem = await remove(Item, { _id });
+  res.message = req?.i18n?.t('item.delete');
+  return successResponse(deletedItem, res);
+});
+
+export const getItems = catchAsync(async (req: IRequest, res: IResponse) => {
+  const widgetId = req.params['widgetId'];
+  const items = await Item.aggregate([
+    {
+      $match: {
+        widgetId: new Types.ObjectId(widgetId),
+        isDeleted: false,
+      },
+    },
+    {
+      $project: {
+        ...commonExcludedFields,
+      },
+    },
+    {
+      $lookup: {
+        from: 'file',
+        let: { imgId: '$img' },
+        as: 'img',
+        pipeline: [
+          {
+            $match: {
+              $expr: {
+                $eq: ['$_id', '$$imgId'],
+              },
+            },
+          },
+          {
+            $project: {
+              ...commonExcludedFields,
+              width: 0,
+              module: 0,
+              height: 0,
+            },
+          },
+        ],
+      },
+    },
+    {
+      $lookup: {
+        from: 'srcsets',
+        let: { item: '$_id' },
+        as: 'srcset',
+        pipeline: [
+          {
+            $match: {
+              $expr: {
+                $eq: ['$itemId', '$$item'],
+              },
+            },
+          },
+          {
+            $project: {
+              ...commonExcludedFields,
+              _id: 0,
+              itemId: 0,
+            },
+          },
+        ],
+      },
+    },
+    {
+      $unwind: '$img',
+    },
+  ]);
+  res.message = req?.i18n?.t('item.getAll');
+  return successResponse(items, res);
+});
+
+const updateItemSrcSet = async (itemId: string, srcSets: SrcSetItem[]) => {
+  await deleteAll(SrcSet, { itemId });
+  const modifiedSrcSets = srcSets.map((set) => ({
+    ...set,
+    itemId,
+  }));
+  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+  // @ts-ignore
+  return await bulkInsert(SrcSet, modifiedSrcSets);
+};

package/src/controllers/PageController.ts

@@ -0,0 +1,65 @@
+import { Types } from 'mongoose';
+import { Page } from './../models';
+import { create, remove, update, list } from '../services/dbService';
+import {
+  successResponse,
+  createdDocumentResponse,
+} from './../utils/responseHandlers';
+import { IRequest, IResponse } from '../types';
+
+import { defaults } from '../utils/defaults';
+
+const catchAsync = (fn: any) => {
+  return defaults.catchAsync(fn, 'Page');
+};
+
+export const createPage = catchAsync(async (req: IRequest, res: IResponse) => {
+  const data = req.body;
+  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 data = req.body;
+  const _id = req.params['id'];
+  const updatedPage = await update(Page, { _id }, data);
+  res.message = req?.i18n?.t('page.update');
+  return successResponse(updatedPage, res);
+});
+
+export const deletePage = catchAsync(async (req: IRequest, res: IResponse) => {
+  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 search = req.body.search || '';
+  const { page, limit, populate } = req.body.options;
+  const customOptions = {
+    populate,
+    ...(page && limit ? { page, limit } : {}),
+  };
+  const query = {
+    isDeleted: false,
+    $or: [
+      {
+        name: {
+          $regex: search,
+          $options: 'i',
+        },
+      },
+      {
+        code: {
+          $regex: search,
+          $options: 'i',
+        },
+      },
+    ],
+  };
+  const pages = await list(Page, query, customOptions);
+  res.message = req?.i18n?.t('page.getAll');
+  return successResponse(pages, res);
+});

package/src/controllers/UserController.ts

@@ -0,0 +1,265 @@
+import { AggregateOptions, models } from 'mongoose';
+import { Widget, Page } from './../models';
+import { AddSrcSetsToItems, appendCollectionData } from '../utils/helper';
+import { successResponse } from './../utils/responseHandlers';
+import { defaults, commonExcludedFields } from '../utils/defaults';
+import { IPageSchema, IRequest, IResponse, IWidgetSchema } from '../types';
+
+const catchAsync = (fn: any) => {
+  return defaults.catchAsync(fn, 'User');
+};
+
+// TO Do: Optimize the following
+export const getWidgetData = catchAsync(
+  async (req: IRequest, res: IResponse) => {
+    const { code } = req.body;
+    const widgetDataArr = (await Widget.aggregate([
+      {
+        $match: {
+          isDeleted: false,
+          isActive: true,
+          code,
+        },
+      },
+      {
+        // Get only the fields that are not excluded
+        $project: {
+          ...commonExcludedFields,
+        },
+      },
+      {
+        // Get Items data
+        $lookup: {
+          from: 'items',
+          let: { widget: '$_id' },
+          pipeline: [
+            {
+              $match: {
+                $expr: {
+                  $eq: ['$widgetId', '$$widget'],
+                },
+                isDeleted: false,
+              },
+            },
+            {
+              $project: {
+                ...commonExcludedFields,
+              },
+            },
+            {
+              $lookup: {
+                from: 'file',
+                let: { img: '$img' },
+                as: 'image',
+                pipeline: [
+                  {
+                    $match: {
+                      $expr: {
+                        $eq: ['$_id', '$$img'],
+                      },
+                    },
+                  },
+                  {
+                    $project: {
+                      _id: 1,
+                      uri: 1,
+                    },
+                  },
+                ],
+              },
+            },
+            {
+              $lookup: {
+                from: 'srcsets',
+                let: { item: '$_id' },
+                as: 'srcset',
+                pipeline: [
+                  {
+                    $match: {
+                      $expr: {
+                        $eq: ['$itemId', '$$item'],
+                      },
+                    },
+                  },
+                  {
+                    $project: {
+                      ...commonExcludedFields,
+                      _id: 0,
+                      itemId: 0,
+                    },
+                  },
+                ],
+              },
+            },
+            {
+              $unwind: '$image',
+            },
+          ],
+          as: 'items',
+        },
+      },
+    ])) as Array<IWidgetSchema>;
+
+    if (!widgetDataArr.length) throw new Error(`Widget not found`);
+    const widgetData = widgetDataArr[0];
+
+    if (widgetData.collectionName && widgetData.collectionItems.length > 0) {
+      const collectionConfig = defaults.collections.find(
+        (c) => c.collectionName === widgetData.collectionName
+      );
+      const aggregateQuery: AggregateOptions = {
+        $match: {
+          _id: {
+            $in: widgetData.collectionItems,
+          },
+          ...(collectionConfig?.match || {}),
+        },
+      };
+      if (collectionConfig?.project)
+        aggregateQuery['$project'] = collectionConfig?.project;
+      if (collectionConfig?.lookup)
+        aggregateQuery['$lookup'] = collectionConfig?.lookup;
+
+      const aggregateQueryItem: AggregateOptions[] = [];
+      if (aggregateQuery['$match'])
+        aggregateQueryItem.push({ $match: aggregateQuery['$match'] });
+      if (aggregateQuery['$lookup'])
+        aggregateQueryItem.push({ $lookup: aggregateQuery['$lookup'] });
+      if (aggregateQuery['$project'])
+        aggregateQueryItem.push({ $project: aggregateQuery['$project'] });
+
+      const collectionItems = await models[widgetData.collectionName].aggregate(
+        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+        // @ts-ignore
+        aggregateQueryItem
+      );
+      widgetData.collectionItems = collectionItems;
+    }
+    AddSrcSetsToItems(widgetData);
+    return successResponse(widgetData, res);
+  }
+);
+
+// TO Do: Optimize the following
+export const getPageData = catchAsync(async (req: IRequest, res: IResponse) => {
+  const { code } = req.body;
+  const pageData: any = (await Page.aggregate([
+    {
+      $match: {
+        isDeleted: false,
+        code: code,
+      },
+    },
+    {
+      $project: {
+        isDeleted: 0,
+        deletedAt: 0,
+        __v: 0,
+      },
+    },
+    {
+      $lookup: {
+        from: 'widgets',
+        let: { widgets: '$widgets' },
+        pipeline: [
+          {
+            $match: {
+              $expr: {
+                $in: ['$_id', '$$widgets'],
+              },
+              isDeleted: false,
+            },
+          },
+          {
+            $project: {
+              widgetId: 0,
+              sequence: 0,
+              ...commonExcludedFields,
+            },
+          },
+          {
+            $lookup: {
+              from: 'items',
+              let: { widget: '$_id' },
+              pipeline: [
+                {
+                  $match: {
+                    $expr: {
+                      $eq: ['$widgetId', '$$widget'],
+                    },
+                    isDeleted: false,
+                  },
+                },
+                {
+                  $project: {
+                    ...commonExcludedFields,
+                  },
+                },
+                {
+                  $lookup: {
+                    from: 'file',
+                    let: { img: '$img' },
+                    as: 'image',
+                    pipeline: [
+                      {
+                        $match: {
+                          $expr: {
+                            $eq: ['$_id', '$$img'],
+                          },
+                        },
+                      },
+                      {
+                        $project: {
+                          _id: 1,
+                          uri: 1,
+                        },
+                      },
+                    ],
+                  },
+                },
+                {
+                  $lookup: {
+                    from: 'srcsets',
+                    let: { item: '$_id' },
+                    as: 'srcset',
+                    pipeline: [
+                      {
+                        $match: {
+                          $expr: {
+                            $eq: ['$itemId', '$$item'],
+                          },
+                        },
+                      },
+                      {
+                        $project: {
+                          ...commonExcludedFields,
+                          _id: 0,
+                          itemId: 0,
+                        },
+                      },
+                    ],
+                  },
+                },
+                {
+                  $unwind: '$image',
+                },
+              ],
+              as: 'items',
+            },
+          },
+        ],
+        as: 'widgets',
+      },
+    },
+  ])) as Array<IPageSchema>;
+
+  if (!pageData.length) throw new Error('Page not found');
+  pageData[0].widgets = await appendCollectionData(pageData[0].widgets);
+  if (Array.isArray(pageData[0].widgets) && pageData[0].widgets.length > 0) {
+    pageData[0].widgets.forEach((widget: IWidgetSchema) => {
+      AddSrcSetsToItems(widget);
+    });
+  }
+  res.message = req?.i18n?.t('user.pageData');
+  return successResponse(pageData[0], res);
+});