@knovator/pagecreator-node 0.2.0 → 0.4.0

package/src/routes/PageRoute.ts

@@ -1,31 +0,0 @@
-import express from 'express';
-// eslint-disable-next-line @typescript-eslint/no-var-requires
-require('express-list-endpoints-descriptor')(express);
-import { IRouter } from '../types';
-
-import validate from '../utils/validate';
-import * as pageValidation from '../utils/validations/page';
-import * as pageController from '../controllers/PageController';
-
-const descriptorPrefix = process.env['PAGECREATOR_DESCRIPTOR_PREFIX'] || '';
-const routes = express.Router() as IRouter;
-routes.use(express.json());
-
-// Get all pages
-routes
-  .post(`/list`, validate(pageValidation.list), pageController.getPages)
-  .descriptor(`${descriptorPrefix}page.getAll`);
-// Create a page
-routes
-  .post(`/`, validate(pageValidation.create), pageController.createPage)
-  .descriptor(`${descriptorPrefix}page.create`);
-// Update a page
-routes
-  .put(`/:id`, validate(pageValidation.update), pageController.updatePage)
-  .descriptor(`${descriptorPrefix}page.update`);
-// Delete a page
-routes
-  .delete(`/:id`, pageController.deletePage)
-  .descriptor(`${descriptorPrefix}page.delete`);
-
-export default routes;

package/src/routes/UserRoute.ts

@@ -1,32 +0,0 @@
-import express from 'express';
-// eslint-disable-next-line @typescript-eslint/no-var-requires
-require('express-list-endpoints-descriptor')(express);
-import { IRouter } from '../types';
-
-import validate from '../utils/validate';
-import * as userValidation from '../utils/validations/user';
-import * as userController from '../controllers/UserController';
-
-const descriptorPrefix = process.env['PAGECREATOR_DESCRIPTOR_PREFIX'] || '';
-const routes = express.Router() as IRouter;
-routes.use(express.json());
-
-// Item Routes
-// Get Widget Data
-routes
-  .post(
-    `/widget-data`,
-    validate(userValidation.getWidgetData),
-    userController.getWidgetData
-  )
-  .descriptor(`${descriptorPrefix}user.getWidgetData`);
-// Get Page Data
-routes
-  .post(
-    '/page-data',
-    validate(userValidation.getPageData),
-    userController.getPageData
-  )
-  .descriptor(`${descriptorPrefix}user.getPageData`);
-
-export default routes;

package/src/routes/WidgetRoute.ts

@@ -1,56 +0,0 @@
-import express from 'express';
-// eslint-disable-next-line @typescript-eslint/no-var-requires
-require('express-list-endpoints-descriptor')(express);
-import { IRouter } from '../types';
-
-import validate from '../utils/validate';
-import * as widgetValidation from '../utils/validations/widget';
-import * as widgetController from '../controllers/WidgetController';
-
-const descriptorPrefix = process.env['PAGECREATOR_DESCRIPTOR_PREFIX'] || '';
-const routes = express.Router() as IRouter;
-routes.use(express.json());
-
-// Widget Routes
-// Get widget types
-routes
-  .get('/widget-types', widgetController.getItemsTypes)
-  .descriptor(`${descriptorPrefix}widget.getItemsTypes`);
-// Get widget selection types
-routes
-  .get('/selection-types', widgetController.getWidgetTypes)
-  .descriptor(`${descriptorPrefix}widget.getWidgetTypes`);
-// Get all widgets
-routes
-  .post(`/list`, validate(widgetValidation.list), widgetController.getWidgets)
-  .descriptor(`${descriptorPrefix}widget.getAll`);
-// Create a widget
-routes
-  .post(`/`, validate(widgetValidation.create), widgetController.createWidget)
-  .descriptor(`${descriptorPrefix}widget.create`);
-// Update a widget
-routes
-  .put(`/:id`, validate(widgetValidation.update), widgetController.updateWidget)
-  .descriptor(`${descriptorPrefix}widget.update`);
-// Partial Update a widget
-routes
-  .patch(
-    `/:id`,
-    validate(widgetValidation.partialUpdate),
-    widgetController.partialUpdateWidget
-  )
-  .descriptor(`${descriptorPrefix}widget.partialUpdate`);
-// Delete a widget
-routes
-  .delete(`/:id`, widgetController.deleteWidget)
-  .descriptor(`${descriptorPrefix}widget.delete`);
-// Get dynamic collection data
-routes
-  .post(
-    '/collection-data',
-    validate(widgetValidation.getCollectionData),
-    widgetController.getCollectionData
-  )
-  .descriptor(`${descriptorPrefix}widget.getCollectionData`);
-
-export default routes;

package/src/services/dbService.ts

@@ -1,82 +0,0 @@
-import {
-  Model,
-  FilterQuery,
-  QueryOptions,
-  ProjectionType,
-  HydratedDocument,
-  QueryWithHelpers,
-} from 'mongoose';
-import { EntityType, IModel, ReturnDocument } from '../types';
-
-// create
-export async function create<T extends EntityType>(
-  Modal: Model<T>,
-  data: Partial<T>
-): Promise<ReturnDocument> {
-  const modalInstance = new Modal(data);
-  return await modalInstance.save();
-}
-// update
-export async function update<T extends EntityType>(
-  Modal: Model<T>,
-  query: FilterQuery<EntityType>,
-  data: Partial<T>
-): Promise<ReturnDocument | undefined> {
-  await getOne(Modal, query);
-  const result = await Modal.findOneAndUpdate(query, data, { new: true });
-  return result || undefined;
-}
-// soft-delete
-export async function remove<T extends EntityType>(
-  Modal: Model<T>,
-  query: FilterQuery<EntityType>
-): Promise<ReturnDocument> {
-  const modalInstance = await getOne(Modal, query);
-  return await modalInstance.remove();
-}
-// delete-all
-export async function deleteAll<T extends EntityType>(Modal: Model<T>, query: FilterQuery<T>) {
-  return Modal.deleteMany(query);
-}
-// get-all
-export function getAll<T extends EntityType>(
-  Modal: Model<T>,
-  query: FilterQuery<EntityType> = {},
-  options?: QueryOptions<EntityType>,
-  projection?: ProjectionType<EntityType>
-  // eslint-disable-next-line @typescript-eslint/ban-types
-): QueryWithHelpers<Array<T>, T, {}, T> {
-  return Modal.find(query, projection, options);
-}
-// list
-export async function list<T extends EntityType>(
-  Modal: IModel<T>,
-  where: FilterQuery<T>,
-  options: QueryOptions<T>
-): Promise<ReturnDocument[]> {
-  try {
-    const documents = Modal.paginate(where, options);
-    return documents;
-  } catch (error) {
-    throw new Error((error as Error).message);
-  }
-}
-// get-one
-export async function getOne<T extends EntityType>(
-  Modal: Model<T>,
-  query: FilterQuery<EntityType>,
-  projection?: ProjectionType<EntityType>
-): Promise<HydratedDocument<T>> {
-  const modalInstance: HydratedDocument<T> | null = await Modal.findOne(
-    query,
-    projection
-  );
-  if (!modalInstance)
-    throw new Error(`Record not found ${Modal.name ? `in ${Modal.name}` : ''}`);
-
-  return modalInstance;
-}
-// bulk-insert
-export async function bulkInsert<T extends EntityType>(Modal: Model<T>, docs: T[]): Promise<ReturnDocument[]> {
-  return await Modal.insertMany(docs);
-}

package/src/types/common.ts

@@ -1,130 +0,0 @@
-import {
-  Document,
-  Model,
-  Types,
-  FilterQuery,
-  QueryOptions,
-  HydratedDocument,
-} from 'mongoose';
-import { ItemsType, WidgetTypes, ItemTypes } from '.';
-
-export type TypesType = { value: string; label: string };
-// export type CollectionItem = {
-//   title: string;
-//   collectionName: string;
-//   filters?: { [key: string]: string };
-//   searchColumns: string[];
-// };
-export interface iConfig {
-  logger: any;
-  catchAsync: (
-    fn: any,
-    modal?: string
-  ) => (req: any, res: any, next: any) => void;
-  collections: CollectionItem[];
-}
-// Collection
-export interface IPageSchema extends Document {
-  name: string;
-  code: string;
-  widgets: string[];
-}
-export interface ISrcSetSchema extends Document {
-  width: number;
-  height: number;
-  screenSize: number;
-  itemId: typeof Types.ObjectId;
-}
-export interface IWidgetSchema extends Document {
-  items: any;
-  name: string;
-  code: string;
-  autoPlay: boolean;
-  isActive: boolean;
-  widgetTitle: string;
-  webPerRow: number;
-  mobilePerRow: number;
-  tabletPerRow: number;
-  itemsType: ItemsType;
-  widgetType: WidgetTypes;
-  collectionName: string;
-  collectionItems: string[];
-}
-export interface IItemSchema extends Document {
-  widgetId: typeof Types.ObjectId;
-  title: string;
-  altText: string;
-  link: string;
-  sequence: number;
-  itemType: ItemTypes;
-  img: any;
-  srcset?: SrcSetItem[];
-}
-export interface SrcSetItem {
-  screenSize: number;
-  width: number;
-  height: number;
-}
-// \ End of Collection
-
-export type CollectionItem = {
-  title: string;
-  collectionName: string;
-  filters?: { [key: string]: string | number | boolean };
-  searchColumns?: string[];
-  match?: ObjectType;
-  project?: ObjectType;
-  lookup?: ObjectType;
-};
-
-export interface IConfig {
-  logger: any;
-  catchAsync: (
-    fn: any,
-    modal?: string
-  ) => (req: any, res: any, next: any) => void;
-  collections: CollectionItem[];
-}
-
-export type EntityType =
-  | IWidgetSchema
-  | IItemSchema
-  | IPageSchema
-  | ISrcSetSchema;
-export type ReturnDocument = EntityType;
-export interface IModel<T> extends Model<T> {
-  paginate: (
-    query: FilterQuery<T>,
-    options?: QueryOptions
-  ) => Promise<HydratedDocument<ReturnDocument>[]>;
-}
-
-export type ObjectType = {
-  [key: string]:
-    | string
-    | number
-    | boolean
-    | null
-    | undefined
-    | string[]
-    | number[]
-    | ObjectType
-    | ObjectType[]
-    | any;
-};
-
-export interface IDefaultValidations {
-  createdBy: string;
-  updatedBy: string;
-  deletedBy: string;
-  deletedAt: string;
-}
-
-// helper.ts
-export interface IWidgetDataSchema {
-  _id: string;
-  code: string;
-  collectionName: string;
-  collectionItems: string[];
-}
-export type IWidgetData = { [key: string]: IWidgetDataSchema };

package/src/types/enums.ts

@@ -1,13 +0,0 @@
-export enum ItemsType {
-  Image = 'Image',
-}
-
-export enum WidgetTypes {
-  FixedCard = 'FixedCard',
-  Carousel = 'Carousel',
-}
-
-export enum ItemTypes {
-  Web = 'Web',
-  Mobile = 'Mobile',
-}

package/src/utils/defaults.ts

@@ -1,30 +0,0 @@
-import { NextFunction } from 'express';
-import { CollectionItem, IConfig, IRequest, IResponse } from '../types';
-import { RESPONSE_CODES, internalServerError, REGEXS } from '../constants';
-
-export const defaults: IConfig = {
-  logger: console as any,
-  catchAsync:
-    (fn: any, modal = '') =>
-    (req: IRequest, res: IResponse, next: NextFunction) => {
-      Promise.resolve(fn(req, res, next)).catch((err) => {
-        let message = (err as Error).message;
-        if (message.match(REGEXS.OBJECTID_CAST_FAILED)) {
-          message = `${modal} not found with given id!`;
-        }
-        // this.logger.error(err.message);
-        res.status(internalServerError).json({
-          code: RESPONSE_CODES.ERROR,
-          message,
-          data: undefined,
-        });
-      });
-    },
-  collections: [] as CollectionItem[],
-};
-
-export const commonExcludedFields = {
-  __v: 0,
-  isDeleted: 0,
-  deletedAt: 0,
-};

package/src/utils/helper.ts

@@ -1,133 +0,0 @@
-import { Widget } from '../models';
-import { commonExcludedFields, defaults } from './defaults';
-import {
-  IWidgetData,
-  IWidgetDataSchema,
-  IWidgetSchema,
-  SrcSetItem,
-} from '../types';
-
-export async function appendCollectionData(widgetData: IWidgetSchema[]) {
-  // reduce widget data to optimize query
-  const newData: IWidgetData = widgetData.reduce(
-    (acc: IWidgetData, widget: IWidgetSchema) => {
-      if (widget.collectionName) {
-        acc[widget.code] = {
-          _id: widget._id,
-          code: widget.code,
-          collectionName: widget.collectionName,
-          collectionItems: widget.collectionItems,
-        };
-      }
-      return acc;
-    },
-    {}
-  );
-  if (Object.keys(newData).length > 0) {
-    const aggregationQuery: any = [
-      {
-        $match: {
-          _id: {
-            $in: Object.values(newData).map(
-              (item: IWidgetDataSchema) => item._id
-            ),
-          },
-        },
-      },
-      {
-        // Get only the fields that are not excluded
-        $project: {
-          _id: 1,
-          code: 1,
-        },
-      },
-    ];
-    let collectionConfig, aggregationQueryPiplelines: any[];
-    Object.keys(newData).forEach((key: string) => {
-      collectionConfig = defaults.collections.find(
-        (c) => c.collectionName === newData[key].collectionName
-      );
-      // Build piplelines with config
-      aggregationQueryPiplelines = [
-        {
-          $match: {
-            _id: {
-              $in: newData[key].collectionItems,
-            },
-            ...(collectionConfig?.match || {}),
-          },
-        },
-        {
-          $project: {
-            ...commonExcludedFields,
-          },
-        },
-      ];
-      // add project config if it exists
-      if (collectionConfig?.project)
-        aggregationQueryPiplelines.push({
-          $project: collectionConfig?.project,
-        });
-      // add lookup config if it exists
-      if (collectionConfig?.lookup)
-        aggregationQueryPiplelines.push({
-          $lookup: collectionConfig?.lookup,
-        });
-      // Build Aggregation Query
-      aggregationQuery.push({
-        $lookup: {
-          from: newData[key].collectionName,
-          pipeline: aggregationQueryPiplelines,
-          as: newData[key].code,
-        },
-      });
-    });
-    // getting collection data by populating widget
-    let aggregationData: any = await Widget.aggregate(aggregationQuery);
-    aggregationData = aggregationData.reduce((acc: any, aggregation: any) => {
-      acc[aggregation.code] = aggregation[aggregation.code];
-      return acc;
-    }, {});
-    // adding collection data to widgets
-    return widgetData.map((widget: IWidgetSchema) => {
-      if (aggregationData[widget.code]) {
-        return {
-          ...widget,
-          collectionItems: aggregationData[widget.code],
-        };
-      }
-      return widget;
-    });
-  }
-  // returning widget data as it is if they do not have dynamic collection
-  return widgetData;
-}
-
-export function buildSrcSetItem(uri: string, setItem: SrcSetItem) {
-  const imageItemArr = uri?.split('/') || [];
-  imageItemArr.splice(
-    imageItemArr.length - 1,
-    0,
-    `${setItem.width}x${setItem.height}`
-  );
-  return imageItemArr.join('/');
-}
-
-export function AddSrcSetsToItems(widgetData: IWidgetSchema) {
-  if (Array.isArray(widgetData.items) && widgetData.items.length > 0) {
-    widgetData.items.forEach((item) => {
-      if (Array.isArray(item.srcset) && item.srcset.length > 0 && item.image) {
-        item.srcSets = item.srcset.reduce(
-          (strArr: string[], setItem: SrcSetItem) => {
-            const imageUri = buildSrcSetItem(item.image.uri, setItem);
-            strArr.push(`${imageUri} ${setItem.screenSize}w`);
-            return strArr;
-          },
-          []
-        );
-
-        item.srcSets = item.srcSets.join(', ');
-      }
-    });
-  }
-}

package/src/utils/responseHandlers.ts

@@ -1,54 +0,0 @@
-import { RESPONSE_CODES, validationError, success, create } from '../constants';
-import { IResponse } from '../types';
-
-export const failureResponse = (data: any, res: IResponse) => {
-	let i = 0;
-	if (data.name === 'ValidationError') {
-		Object.keys(data.errors).forEach((key) => {
-			if (i !== 1) {
-				data.message = data.errors[key].message;
-			}
-			i++;
-		});
-	}
-	res.message = data.message;
-	return res.status(validationError).json({
-		code: RESPONSE_CODES.ERROR,
-		message: data.message ? data.message : data,
-	});
-};
-
-export const successResponse = (data: any, res: IResponse) => {
-	return res.status(success).json({
-		code: RESPONSE_CODES.DEFAULT,
-		message: res.message,
-		data: data,
-	});
-};
-
-export const createdDocumentResponse = (data: any, res: IResponse) => {
-	return res.status(create).json({
-		code: RESPONSE_CODES.DEFAULT,
-		message: res.message,
-		data: data,
-	});
-};
-
-export const recordNotFound = (res: IResponse) => {
-	return res.status(success).json({
-		code: RESPONSE_CODES.DEFAULT,
-		message: res.message,
-		data: {},
-	});
-};
-
-export const inValidParam = (message: any, res: IResponse) => {
-	/* eslint-disable no-useless-escape */
-	message = message.replace(/\"/g, '');
-	res.message = message;
-	return res.status(validationError).json({
-		code: RESPONSE_CODES.ERROR,
-		message: message,
-		data: undefined,
-	});
-};

package/src/utils/validate.ts

@@ -1,22 +0,0 @@
-import { ValidationError } from 'joi';
-import { NextFunction } from 'express';
-import { IRequest, IResponse } from './../types';
-
-import { defaults } from './defaults';
-import { inValidParam, failureResponse } from './responseHandlers';
-
-const validate = (validator: any) => {
-  return async function (req: IRequest, res: IResponse, next: NextFunction) {
-    try {
-      req.body = await validator.validateAsync(req.body);
-      next();
-    } catch (err) {
-      defaults.logger.error('ValidationError', err);
-      if ((err as ValidationError).isJoi)
-        inValidParam((err as Error).message, res);
-      else failureResponse((err as Error).message, res);
-    }
-  };
-};
-
-export default validate;

package/src/utils/validations/item.ts

@@ -1,51 +0,0 @@
-import joi from 'joi';
-import { IItemSchema, IDefaultValidations, ItemTypes } from '../../types';
-
-type ItemValidation = IItemSchema & IDefaultValidations;
-
-const srcset = joi.object().keys({
-  screenSize: joi.number().required(),
-  width: joi.number().required(),
-  height: joi.number().required(),
-});
-
-export const create = joi.object<ItemValidation>({
-  widgetId: joi.string().required(),
-  title: joi.string().required(),
-  altText: joi.string().optional(),
-  link: joi.string().required(),
-  sequence: joi.number().optional(),
-  srcset: joi.array().items(srcset),
-  img: joi.string().allow(null).optional(),
-  itemType: joi
-    .string()
-    .valid(...Object.values(ItemTypes))
-    .optional()
-    .default(ItemTypes.Web),
-  createdBy: joi.any().optional(),
-  updatedBy: joi.any().optional(),
-  deletedBy: joi.any().optional(),
-  deletedAt: joi.any().optional(),
-});
-
-export const update = joi.object<ItemValidation>({
-  widgetId: joi.string().required(),
-  title: joi.string().required(),
-  altText: joi.string().optional(),
-  link: joi.string().required(),
-  sequence: joi.number().optional(),
-  img: joi.string().allow(null).optional(),
-  srcset: joi.array().items(srcset),
-  itemType: joi
-    .string()
-    .valid(...Object.values(ItemTypes))
-    .optional(),
-  createdBy: joi.any().optional(),
-  updatedBy: joi.any().optional(),
-  deletedBy: joi.any().optional(),
-  deletedAt: joi.any().optional(),
-});
-
-export const list = joi.object({
-  search: joi.string().allow('').replace(/\s+/g, '_').default(''),
-});

package/src/utils/validations/page.ts

@@ -1,59 +0,0 @@
-import joi from 'joi';
-import { Page } from '../../models';
-import { getOne } from '../../services/dbService';
-import { VALIDATION } from '../../constants';
-import { IPageSchema, IDefaultValidations } from '../../types';
-
-type PageValidation = IPageSchema & IDefaultValidations;
-
-const checkUnique = async (value: string): Promise<void> => {
-  let result;
-  try {
-    // throws error if document not found
-    result = await getOne(Page, {
-      code: value,
-    });
-    // eslint-disable-next-line no-empty
-  } catch (e) {}
-  if (result) {
-    throw new Error(VALIDATION.WIDGET_EXISTS);
-  }
-};
-
-export const create = joi.object<PageValidation>({
-  name: joi.string().required(),
-  code: joi
-    .string()
-    .uppercase()
-    .replace(/\s+/g, '_')
-    .external(checkUnique)
-    .required(),
-  widgets: joi.array().items(joi.string()).optional(),
-  createdBy: joi.any().optional(),
-  updatedBy: joi.any().optional(),
-  deletedBy: joi.any().optional(),
-  deletedAt: joi.any().optional(),
-});
-
-export const update = joi.object<PageValidation>({
-  name: joi.string().optional(),
-  widgets: joi.array().items(joi.string()).optional(),
-  createdBy: joi.any().optional(),
-  updatedBy: joi.any().optional(),
-  deletedBy: joi.any().optional(),
-  deletedAt: joi.any().optional(),
-});
-
-export const list = joi.object({
-  search: joi.string().allow('').replace(/\s+/g, '_').optional().default(''),
-  options: joi
-    .object({
-      // sort: joi.alternatives().try(joi.object(), joi.string()).optional(),
-      populate: joi.array().items().optional().default([]),
-      offset: joi.number().optional(),
-      page: joi.number().optional(),
-      limit: joi.number().optional(),
-      pagination: joi.boolean().default(false),
-    })
-    .default({}),
-});