@monorise/core 1.0.0

package/dist/types/event.js

@@ -0,0 +1,74 @@
+const SOURCE = {
+    CORE: 'monorise-core',
+    GENERAL: 'general',
+};
+const EVENT = {
+    CORE: {
+        LOGIN_EMAIL_REQUESTED: {
+            Source: SOURCE.CORE,
+            DetailType: 'login-email-requested',
+        },
+        /*
+         * Entity
+         */
+        ENTITY_CREATED: {
+            Source: SOURCE.CORE,
+            DetailType: 'entity-created',
+        },
+        ENTITY_UPSERTED: {
+            Source: SOURCE.CORE,
+            DetailType: 'entity-upserted',
+        },
+        ENTITY_UPDATED: {
+            Source: SOURCE.CORE,
+            DetailType: 'entity-updated',
+        },
+        ENTITY_DELETED: {
+            Source: SOURCE.CORE,
+            DetailType: 'entity-deleted',
+        },
+        ENTITY_MUTUAL_TO_CREATE: {
+            Source: SOURCE.CORE,
+            DetailType: 'entity-mutual-to-create',
+        },
+        ENTITY_MUTUAL_TO_UPDATE: {
+            Source: SOURCE.CORE,
+            DetailType: 'entity-mutual-to-update',
+        },
+        ENTITY_MUTUAL_PROCESSED: {
+            Source: SOURCE.CORE,
+            DetailType: 'entity-mutual-processed',
+        },
+        CREATE_ENTITY: {
+            Source: SOURCE.CORE,
+            DetailType: 'create-entity',
+        },
+        /*
+         * Mutual
+         */
+        MUTUAL_CREATED: {
+            Source: SOURCE.CORE,
+            DetailType: 'mutual-created',
+        },
+        MUTUAL_UPDATED: {
+            Source: SOURCE.CORE,
+            DetailType: 'mutual-updated',
+        },
+        MUTUAL_DELETED: {
+            Source: SOURCE.CORE,
+            DetailType: 'mutual-deleted',
+        },
+        PREJOIN_RELATIONSHIP_SYNC: {
+            Source: SOURCE.CORE,
+            DetailType: 'prejoin-relationship-sync',
+        },
+    },
+    GENERAL: {
+        ENDPOINT_ERROR: {
+            Source: SOURCE.GENERAL,
+            DetailType: 'endpoint-error',
+        },
+    },
+};
+export { SOURCE, EVENT };
+//# sourceMappingURL=event.js.map

package/dist/types/event.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"event.js","sourceRoot":"","sources":["../../types/event.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,GAAG;IACb,IAAI,EAAE,eAAe;IACrB,OAAO,EAAE,SAAS;CACnB,CAAC;AAOF,MAAM,KAAK,GAAG;IACZ,IAAI,EAAE;QACJ,qBAAqB,EAAE;YACrB,MAAM,EAAE,MAAM,CAAC,IAAI;YACnB,UAAU,EAAE,uBAAuB;SACpC;QAED;;WAEG;QACH,cAAc,EAAE;YACd,MAAM,EAAE,MAAM,CAAC,IAAI;YACnB,UAAU,EAAE,gBAAgB;SAC7B;QACD,eAAe,EAAE;YACf,MAAM,EAAE,MAAM,CAAC,IAAI;YACnB,UAAU,EAAE,iBAAiB;SAC9B;QACD,cAAc,EAAE;YACd,MAAM,EAAE,MAAM,CAAC,IAAI;YACnB,UAAU,EAAE,gBAAgB;SAC7B;QACD,cAAc,EAAE;YACd,MAAM,EAAE,MAAM,CAAC,IAAI;YACnB,UAAU,EAAE,gBAAgB;SAC7B;QACD,uBAAuB,EAAE;YACvB,MAAM,EAAE,MAAM,CAAC,IAAI;YACnB,UAAU,EAAE,yBAAyB;SACtC;QACD,uBAAuB,EAAE;YACvB,MAAM,EAAE,MAAM,CAAC,IAAI;YACnB,UAAU,EAAE,yBAAyB;SACtC;QACD,uBAAuB,EAAE;YACvB,MAAM,EAAE,MAAM,CAAC,IAAI;YACnB,UAAU,EAAE,yBAAyB;SACtC;QAED,aAAa,EAAE;YACb,MAAM,EAAE,MAAM,CAAC,IAAI;YACnB,UAAU,EAAE,eAAe;SAC5B;QAED;;WAEG;QACH,cAAc,EAAE;YACd,MAAM,EAAE,MAAM,CAAC,IAAI;YACnB,UAAU,EAAE,gBAAgB;SAC7B;QACD,cAAc,EAAE;YACd,MAAM,EAAE,MAAM,CAAC,IAAI;YACnB,UAAU,EAAE,gBAAgB;SAC7B;QACD,cAAc,EAAE;YACd,MAAM,EAAE,MAAM,CAAC,IAAI;YACnB,UAAU,EAAE,gBAAgB;SAC7B;QACD,yBAAyB,EAAE;YACzB,MAAM,EAAE,MAAM,CAAC,IAAI;YACnB,UAAU,EAAE,2BAA2B;SACxC;KACF;IAED,OAAO,EAAE;QACP,cAAc,EAAE;YACd,MAAM,EAAE,MAAM,CAAC,OAAO;YACtB,UAAU,EAAE,gBAAgB;SAC7B;KACF;CACF,CAAC;AAEF,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC"}

package/errors/api-error.ts

@@ -0,0 +1,39 @@
+import * as httpStatus from 'http-status';
+import ExtendableError from './extendable-error';
+
+/**
+ * Class representing an API error.
+ * @extends ExtendableError
+ */
+class APIError extends ExtendableError {
+  /**
+   * Creates an API error.
+   * @param {string} message - Error message.
+   * @param {number} status - HTTP status code of error.
+   * @param {boolean} isPublic - Whether the message should be visible to user or not.
+   * @param {string | undefined} stack - Stack trace.
+   */
+  constructor({
+    message,
+    errors,
+    stack,
+    status = httpStatus.INTERNAL_SERVER_ERROR,
+    isPublic = false,
+  }: {
+    message: string;
+    errors?: any;
+    stack?: string;
+    status?: number;
+    isPublic?: boolean;
+  }) {
+    super({
+      message,
+      errors,
+      status,
+      isPublic,
+      stack,
+    });
+  }
+}
+
+export default APIError;

package/errors/extendable-error.ts

@@ -0,0 +1,35 @@
+class ExtendableError extends Error {
+  public name: string;
+  public message: string;
+  public errors: any;
+  public status: number;
+  public isPublic: boolean;
+  public isOperational: boolean;
+  public stack?: string;
+
+  constructor({
+    message,
+    errors,
+    status,
+    isPublic,
+    stack,
+  }: {
+    message: string;
+    errors?: any;
+    status?: number;
+    isPublic?: boolean;
+    stack?: string;
+  }) {
+    super(message);
+    this.name = this.constructor.name;
+    this.message = message;
+    this.errors = errors;
+    this.status = status || 500; // Default value if status is not provided
+    this.isPublic = isPublic || false; // Default value if isPublic is not provided
+    this.isOperational = true; // This is required since bluebird 4 doesn't append it anymore.
+    this.stack = stack;
+    // Error.captureStackTrace(this, this.constructor.name);
+  }
+}
+
+export default ExtendableError;

package/errors/standard-error.ts

@@ -0,0 +1,29 @@
+export class StandardError extends Error {
+  public code: string;
+  public lastError?: object | null;
+  public context?: string | null;
+
+  constructor(
+    errorCode: string,
+    message: string,
+    lastError?: any,
+    context?: object | string | null,
+  ) {
+    super(message);
+
+    // So you can do typeof CustomError
+    Object.setPrototypeOf(this, new.target.prototype);
+
+    this.name = this.constructor.name;
+    this.code = errorCode;
+    this.lastError = lastError;
+    this.context = JSON.stringify(context, null, 2);
+  }
+
+  public toJSON() {
+    return {
+      code: this.code,
+      message: this.message,
+    };
+  }
+}

package/helpers/dependencies.ts

@@ -0,0 +1,10 @@
+import { nanoid } from 'nanoid';
+import { publishErrorEvent, publishEvent } from './event';
+
+export const getDependencies = () => {
+  return {
+    nanoid,
+    publishEvent,
+    publishErrorEvent,
+  };
+};

package/helpers/event.ts

@@ -0,0 +1,85 @@
+import {
+  EventBridgeClient,
+  PutEventsCommand,
+} from '@aws-sdk/client-eventbridge';
+import { CORE_EVENT_BUS } from '#/configs/service.config';
+import { EVENT, type EventDetail } from '#/types/event';
+
+const eventBridge = new EventBridgeClient();
+
+type PublishEventProps<T> = {
+  payload: T;
+  event: EventDetail;
+};
+
+type ParsedSQSBusEvent<T = Record<string, any>> = {
+  event: EventDetail;
+  detail: T;
+};
+
+export function parseSQSBusEvent<T>(
+  evRecordBody: string,
+): ParsedSQSBusEvent<T> {
+  const body = JSON.parse(evRecordBody);
+  return {
+    ...body,
+    detail: body.detail,
+    event: {
+      Source: body.source,
+      DetailType: body['detail-type'],
+    },
+  };
+}
+
+export async function publishEvent<T extends Record<string, any>>({
+  payload,
+  event,
+}: PublishEventProps<T>): Promise<void> {
+  const params = {
+    Entries: [
+      {
+        ...event,
+        Detail: JSON.stringify(payload),
+        EventBusName: CORE_EVENT_BUS,
+      },
+    ],
+  };
+
+  await eventBridge.send(new PutEventsCommand(params));
+}
+
+type PublishErrorEventPayload = {
+  id: string;
+  serviceName: string;
+  method: string;
+  path: string;
+  body?: Record<string, any>;
+  error: Error;
+};
+
+export async function publishErrorEvent({
+  id,
+  serviceName,
+  method,
+  path,
+  body,
+  error,
+}: PublishErrorEventPayload) {
+  await publishEvent({
+    event: EVENT.GENERAL.ENDPOINT_ERROR,
+    payload: {
+      id,
+      serviceName,
+      method,
+      path,
+      ...(body ? { requestBody: body } : {}),
+      error: {
+        name: error.name,
+        message: error.message,
+        // @ts-ignore
+        cause: error.cause,
+        stack: error.stack,
+      },
+    },
+  });
+}

package/helpers/fromLastKeyQuery.ts

@@ -0,0 +1,11 @@
+import type { NativeAttributeValue } from '@aws-sdk/util-dynamodb';
+
+export function fromLastKeyQuery(
+  lastKeyQuery?: string,
+): Record<string, NativeAttributeValue> | undefined {
+  if (!lastKeyQuery) {
+    return;
+  }
+
+  return JSON.parse(Buffer.from(lastKeyQuery, 'base64').toString('utf-8'));
+}

package/helpers/sleep.ts

@@ -0,0 +1 @@
+export const sleep = (ms: number) => new Promise((res) => setTimeout(res, ms));

package/helpers/toLastKeyResponse.ts

@@ -0,0 +1,11 @@
+import type { NativeAttributeValue } from '@aws-sdk/util-dynamodb';
+
+export function toLastKeyResponse(
+  lastKey?: Record<string, NativeAttributeValue>,
+): string | undefined {
+  if (!lastKey) {
+    return;
+  }
+
+  return Buffer.from(JSON.stringify(lastKey)).toString('base64');
+}

package/index.ts

@@ -0,0 +1,23 @@
+import { setupCommonRoutes } from './controllers/setupRoutes';
+import { Entity } from './data/Entity';
+import { Mutual } from './data/Mutual';
+import { PROJECTION_EXPRESSION } from './data/ProjectionExpression';
+import { handler as createEntityProcessor } from './processors/create-entity-processor';
+import { handler as mutualProcessor } from './processors/mutual-processor';
+import { handler as prejoinProcessor } from './processors/prejoin-processor';
+import { handler as replicationProcessor } from './processors/replication-processor';
+import { handler as tagProcessor } from './processors/tag-processor';
+import { DependencyContainer } from './services/DependencyContainer';
+
+export {
+  setupCommonRoutes,
+  Entity,
+  Mutual,
+  PROJECTION_EXPRESSION,
+  createEntityProcessor,
+  mutualProcessor,
+  prejoinProcessor,
+  replicationProcessor,
+  tagProcessor,
+  DependencyContainer,
+};

package/middlewares/entity-type-check.ts

@@ -0,0 +1,20 @@
+import type { Entity } from '@monorise/base';
+import type { NextFunction, Request, Response } from 'express';
+import httpStatus from 'http-status';
+import { AllowedEntityTypes } from '#/lambda-layer/monorise';
+
+export const entityTypeCheck: (
+  req: Request,
+  res: Response,
+  next: NextFunction,
+) => void = (req, res, next) => {
+  const { entityType } = req.params as unknown as { entityType: Entity };
+
+  if (!AllowedEntityTypes.includes(entityType)) {
+    return res.status(httpStatus.NOT_FOUND).json({
+      code: 'NOT_FOUND',
+    });
+  }
+
+  next();
+};

package/middlewares/mutual-type-check.ts

@@ -0,0 +1,26 @@
+import type { Entity } from '@monorise/base';
+import type { NextFunction, Request, Response } from 'express';
+import httpStatus from 'http-status';
+import { AllowedEntityTypes } from '#/lambda-layer/monorise';
+
+export const mutualTypeCheck: (
+  req: Request,
+  res: Response,
+  next: NextFunction,
+) => void = (req, res, next) => {
+  const { entityType, byEntityType } = req.params as unknown as {
+    entityType: Entity;
+    byEntityType: Entity;
+  };
+
+  if (
+    !AllowedEntityTypes.includes(entityType) ||
+    !AllowedEntityTypes.includes(byEntityType)
+  ) {
+    return res.status(httpStatus.NOT_FOUND).json({
+      code: 'NOT_FOUND',
+    });
+  }
+
+  next();
+};

package/mock/entity.ts

@@ -0,0 +1,12 @@
+export enum Entity {
+  ADMIN = 'admin',
+  CHAPTER = 'chapter',
+  COURSE = 'course',
+  LEARNER = 'learner',
+  LEARNING_ACTIVITY = 'learning-activity',
+  LEARNING_JOURNEY_CONFIG = 'learning-journey-config',
+  MODULE = 'module',
+  ORGANIZATION = 'organization',
+  REFERENCE = 'reference',
+  VIDEO = 'video',
+}

package/mock/monorise/admin.ts

@@ -0,0 +1,35 @@
+import { createEntityConfig } from '@monorise/cli';
+import { z } from 'zod';
+
+const baseSchema = z
+  .object({
+    email: z.string().toLowerCase(),
+    displayName: z.string(),
+  })
+  .partial();
+
+const createSchema = baseSchema.extend({
+  email: z
+    .string()
+    .toLowerCase()
+    .regex(
+      /^[a-zA-Z0-9.!#$%&’*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:\.[a-zA-Z0-9-]+)*$/,
+      "Doesn't seems like an email",
+    ),
+  displayName: z.string().min(1, 'Please provide a name for this user account'),
+});
+
+const config = createEntityConfig({
+  name: 'admin',
+  displayName: 'Admin',
+  authMethod: {
+    email: {
+      tokenExpiresIn: 1000 * 60 * 60 * 24 * 14, // 14 days
+    },
+  },
+  baseSchema,
+  createSchema,
+  searchableFields: ['email', 'displayName'],
+});
+
+export default config;

package/mock/monorise/chapter.ts

@@ -0,0 +1,94 @@
+import { createEntityConfig } from '@monorise/cli';
+import type { Mutual } from '@monorise/react';
+import { z } from 'zod';
+import { Entity } from '../entity';
+
+export enum CHAPTER_TYPE {
+  CHAPTER = 'CHAPTER',
+  CUSTOM = 'CUSTOM',
+  TOUCHPOINT = 'TOUCHPOINT',
+  CHECKPOINT = 'CHECKPOINT',
+}
+
+const baseSchema = z
+  .object({
+    description: z.string(),
+    discussionLink: z.string(),
+    remark: z.string(),
+    type: z.nativeEnum(CHAPTER_TYPE),
+    title: z.string(),
+    learningActivityDescription: z.string(),
+    body: z
+      .object({
+        type: z.string(),
+        id: z.string(),
+        content: z.any(),
+      })
+      .array()
+      .optional(),
+    progress: z.coerce.number().int(),
+  })
+  .partial();
+
+const createSchema = baseSchema.extend({
+  remark: z.string(),
+  type: z.nativeEnum(CHAPTER_TYPE),
+});
+
+const mutualSchema = z
+  .object({
+    learningActivityOrders: z.string().array(),
+    referenceOrders: z.string().array(),
+    videos: z.string().array().max(1),
+  })
+  .partial();
+
+const config = createEntityConfig({
+  name: 'chapter',
+  displayName: 'Chapter',
+  baseSchema,
+  createSchema,
+  searchableFields: ['remark', 'title'],
+  mutual: {
+    mutualSchema,
+    mutualFields: {
+      learningActivityOrders: {
+        entityType: Entity.LEARNING_ACTIVITY,
+        mutualDataProcessor: (
+          ids: string[],
+          context: Mutual<Entity.CHAPTER, Entity.LEARNING_ACTIVITY>,
+        ) => {
+          return { index: ids.indexOf(context.entityId) };
+        },
+      },
+      referenceOrders: {
+        entityType: Entity.REFERENCE,
+        mutualDataProcessor: (
+          ids: string[],
+          context: Mutual<Entity.CHAPTER, Entity.REFERENCE>,
+        ) => {
+          return { index: ids.indexOf(context.entityId) };
+        },
+      },
+      videos: {
+        entityType: Entity.VIDEO,
+      },
+    },
+  },
+  effect: (schema) => {
+    return schema.superRefine((value, ctx) => {
+      if (
+        value.type === CHAPTER_TYPE.CHAPTER &&
+        'videos' in value &&
+        !value.videos?.length
+      )
+        ctx.addIssue({
+          code: z.ZodIssueCode.custom,
+          message: 'Video is required',
+          path: ['videos'],
+        });
+    });
+  },
+});
+
+export default config;

package/mock/monorise/course.ts

@@ -0,0 +1,149 @@
+import { createEntityConfig } from '@monorise/cli';
+import type { Mutual } from '@monorise/react';
+import { z } from 'zod';
+import { Entity } from '../entity';
+
+const baseSchema = z
+  .object({
+    title: z.string(),
+    categories: z.string().array(),
+    duration: z.number(),
+    description: z.string(),
+    learningOutcomes: z.string().array(),
+    infographics: z.string().array(),
+    tags: z.string().array(),
+  })
+  .partial();
+
+const createSchema = baseSchema.extend({
+  title: z.string().min(4, {
+    message: 'Title must be at least 4 characters.',
+  }),
+});
+
+const mutualSchema = z
+  .object({
+    moduleOrders: z.string().array(),
+    videos: z.string().array(),
+    chapters: z.string().array(),
+    learningActivities: z.string().array(),
+  })
+  .partial();
+
+const config = createEntityConfig({
+  name: 'course',
+  displayName: 'Course',
+  baseSchema: baseSchema,
+  createSchema,
+  searchableFields: ['title'],
+  mutual: {
+    subscribes: [{ entityType: Entity.MODULE }],
+    mutualSchema,
+    mutualFields: {
+      moduleOrders: {
+        entityType: Entity.MODULE,
+        mutualDataProcessor: (
+          ids: string[],
+          context: Mutual<Entity.COURSE, Entity.MODULE>,
+        ) => {
+          return { index: ids.indexOf(context.entityId) };
+        },
+      },
+      videos: {
+        entityType: Entity.VIDEO,
+        mutualDataProcessor: (
+          ids: string[],
+          context: Mutual<Entity.COURSE, Entity.VIDEO>,
+          prejoinContext?: Record<string, any>,
+        ) => {
+          return {
+            index: ids.indexOf(context.entityId),
+            moduleId: prejoinContext?.[context.entityId],
+          };
+        },
+      },
+      chapters: {
+        entityType: Entity.CHAPTER,
+        mutualDataProcessor: (
+          ids: string[],
+          context: Mutual<Entity.COURSE, Entity.CHAPTER>,
+          prejoinContext?: Record<string, any>,
+        ) => ({
+          index: ids.indexOf(context.entityId),
+          moduleId: prejoinContext?.[context.entityId],
+        }),
+      },
+      learningActivities: {
+        entityType: Entity.LEARNING_ACTIVITY,
+        mutualDataProcessor: (
+          ids: string[],
+          context: Mutual<Entity.COURSE, Entity.LEARNING_ACTIVITY>,
+          prejoinContext?: Record<string, any>,
+        ) => {
+          return {
+            index: ids.indexOf(context.entityId),
+            moduleId: prejoinContext?.[context.entityId],
+          };
+        },
+      },
+    },
+
+    prejoins: [
+      {
+        mutualField: 'chapters',
+        targetEntityType: Entity.CHAPTER,
+        entityPaths: [
+          {
+            entityType: Entity.COURSE,
+          },
+          {
+            entityType: Entity.MODULE,
+          },
+          {
+            entityType: Entity.CHAPTER,
+          },
+        ],
+      },
+      {
+        mutualField: 'videos',
+        targetEntityType: Entity.VIDEO,
+        entityPaths: [
+          {
+            entityType: Entity.COURSE,
+          },
+          {
+            entityType: Entity.MODULE,
+          },
+          {
+            skipCache: true,
+            entityType: Entity.CHAPTER,
+          },
+          {
+            entityType: Entity.VIDEO,
+          },
+        ],
+      },
+      {
+        mutualField: 'learningActivities',
+        targetEntityType: Entity.LEARNING_ACTIVITY,
+        entityPaths: [
+          {
+            entityType: Entity.COURSE,
+          },
+          {
+            entityType: Entity.MODULE,
+          },
+          {
+            skipCache: true,
+            entityType: Entity.CHAPTER,
+          },
+          {
+            entityType: Entity.LEARNING_ACTIVITY,
+          },
+        ],
+      },
+    ],
+  },
+});
+
+export default config;