@monorise/core 1.0.2 → 1.0.4-0

package/controllers/mutual/get-mutual.controller.ts

@@ -1,38 +0,0 @@
-import type { Entity } from '@monorise/base';
-import type { Request, Response } from 'express';
-import httpStatus from 'http-status';
-import type { MutualRepository } from '../../data/Mutual';
-
-export class GetMutualController {
-  constructor(private associateRepository: MutualRepository) {}
-
-  controller: (req: Request, res: Response) => void = async (req, res) => {
-    const { byEntityType, byEntityId, entityType, entityId } =
-      req.params as unknown as {
-        byEntityType: Entity;
-        byEntityId: string;
-        entityType: Entity;
-        entityId: string;
-      };
-
-    try {
-      const associate = await this.associateRepository.getMutual(
-        byEntityType,
-        byEntityId,
-        entityType,
-        entityId,
-      );
-
-      return res.status(httpStatus.OK).json(associate);
-    } catch (err) {
-      if ((err as any).code === 'MUTUAL_IS_UNDEFINED') {
-        return res.status(httpStatus.NOT_FOUND).json({
-          code: 'MUTUAL_NOT_FOUND',
-          message: 'Mutual not found',
-        });
-      }
-
-      throw err;
-    }
-  };
-}

package/controllers/mutual/list-entities-by-entity.controller.ts

@@ -1,76 +0,0 @@
-import type { Entity } from '@monorise/base';
-import type { Request, Response } from 'express';
-import httpStatus from 'http-status';
-import { z } from 'zod';
-import type { Mutual, MutualRepository } from '../../data/Mutual';
-
-export class ListEntitiesByEntityController {
-  constructor(private associateRepository: MutualRepository) {}
-
-  controller: (req: Request, res: Response) => void = async (req, res) => {
-    const { byEntityType, byEntityId, entityType } = req.params as unknown as {
-      byEntityType: Entity;
-      byEntityId: string;
-      entityType: Entity;
-    };
-
-    /**
-     * Chain query is a query that allows to query entities by a chain of mutual types.
-     * if /core/mutual/learner/:learnerId/pathways?chainEntityQuery=type1,type2
-     * then the query will look for list of type1 in learner based on learnerId,
-     * then look for list of type2 in type1 by list of entityId of type1,
-     * then finally look for list of pathways in type2 by list of entityId of type2.
-     */
-    const querySchema = z.object({
-      chainEntityQuery: z.string().optional(),
-    });
-    const queryParam = querySchema.parse(req.query);
-    if (queryParam?.chainEntityQuery) {
-      try {
-        const mutualTypes = queryParam.chainEntityQuery.split(
-          ',',
-        ) as unknown as Entity[];
-
-        const chainMutualTypes = [byEntityType, ...mutualTypes, entityType];
-        let byIds = [byEntityId];
-        let items: Mutual<Entity, Entity, Record<string, unknown>>[] = [];
-
-        for (let i = 1; i < chainMutualTypes.length; i++) {
-          const byType = chainMutualTypes[i - 1];
-          const type = chainMutualTypes[i];
-          items = [];
-
-          for (const byId of byIds) {
-            const resp = await this.associateRepository.listEntitiesByEntity(
-              byType,
-              byId,
-              type,
-            );
-            items = items.concat(resp.items);
-          }
-          byIds = items.map((item) => item.entityId);
-        }
-
-        return res.json({
-          entities: items,
-        });
-      } catch (err) {
-        return res.status(httpStatus.BAD_REQUEST).json({
-          code: 'INVALID_CHAIN_QUERY',
-          message:
-            'Chain query is invalid. Please double check the chainEntityQuery param',
-        });
-      }
-    } else {
-      const resp = await this.associateRepository.listEntitiesByEntity(
-        byEntityType,
-        byEntityId,
-        entityType,
-      );
-
-      return res.json({
-        entities: resp.items,
-      });
-    }
-  };
-}

package/controllers/mutual/mutual.http

@@ -1,88 +0,0 @@
-### Mutual
-
-@byEntityType=learner
-@byEntityId=01J5R3ZS09J1GHP3DKSRC6D601
-@entityType=course
-@entityId=01J5R4032JRV4ABQE42GVGW96C
-
-### Create mutual: Associate entity x with entity y
-
-POST {{BASE_URL}}/core/mutual/{{byEntityType}}/{{byEntityId}}/{{entityType}}/{{entityId}}
-content-type: application/json
-x-api-key: {{X_API_KEY}}
-
-{
-    "scope": ["member"]
-}
-
-### Reverse associate, same as associate (should failed if already associated)
-
-POST {{BASE_URL}}/core/mutual/{{entityType}}/{{entityId}}/{{byEntityType}}/{{byEntityId}}
-content-type: application/json
-x-api-key: {{X_API_KEY}}
-
-{
-    "scope": ["member"]
-}
-
-### List associated accounts (flexible)
-
-GET {{BASE_URL}}/core/mutual/{{byEntityType}}/{{byEntityId}}/{{entityType}}
-content-type: application/json
-x-api-key: {{X_API_KEY}}
-
-### List associated via chain query
-
-GET {{BASE_URL}}/core/mutual/{{byEntityType}}/{{byEntityId}}/{{entityType}}?chainEntityQuery=organization
-content-type: application/json
-x-api-key: {{X_API_KEY}}
-
-### Reverse list associated accounts (list from the other perspective)
-
-GET {{BASE_URL}}/core/mutual/{{entityType}}/{{entityId}}/{{byEntityType}}
-content-type: application/json
-x-api-key: {{X_API_KEY}}
-
-### Get account by entityId
-
-GET {{BASE_URL}}/core/mutual/{{byEntityType}}/{{byEntityId}}/{{entityType}}/{{entityId}}
-content-type: application/json
-x-api-key: {{X_API_KEY}}
-
-### Reverse get account by entityId (should get the same thing but reversed ID)
-
-GET {{BASE_URL}}/core/mutual/{{entityType}}/{{entityId}}/{{byEntityType}}/{{byEntityId}}
-content-type: application/json
-x-api-key: {{X_API_KEY}}
-
-### Update associate
-
-PATCH {{BASE_URL}}/core/mutual/{{byEntityType}}/{{byEntityId}}/{{entityType}}/{{entityId}}
-content-type: application/json
-x-api-key: {{X_API_KEY}}
-
-{
-    "scope": ["superadmin"]
-}
-
-### Reverse update associate
-
-PATCH {{BASE_URL}}/core/mutual/{{entityType}}/{{entityId}}/{{byEntityType}}/{{byEntityId}}
-content-type: application/json
-x-api-key: {{X_API_KEY}}
-
-{
-    "scope": ["hello"]
-}
-
-### Delete associate
-
-DELETE {{BASE_URL}}/core/mutual/{{byEntityType}}/{{byEntityId}}/{{entityType}}/{{entityId}}
-content-type: application/json
-x-api-key: {{X_API_KEY}}
-
-### Reverse delete associate
-
-DELETE {{BASE_URL}}/core/mutual/{{entityType}}/{{entityId}}/{{byEntityType}}/{{byEntityId}}
-content-type: application/json
-x-api-key: {{X_API_KEY}}

package/controllers/mutual/update-mutual.controller.ts

@@ -1,50 +0,0 @@
-import type { Entity } from '@monorise/base';
-import type { Request, Response } from 'express';
-import httpStatus from 'http-status';
-import { ZodError } from 'zod';
-import { StandardError } from '../../errors/standard-error';
-import type { MutualService } from '../../services/mutual.service';
-
-export class UpdateMutualController {
-  constructor(private mutualService: MutualService) {}
-
-  controller: (req: Request, res: Response) => void = async (req, res) => {
-    const accountId = req.headers['account-id'];
-    const { byEntityType, byEntityId, entityType, entityId } =
-      req.params as unknown as {
-        byEntityType: Entity;
-        byEntityId: string;
-        entityType: Entity;
-        entityId: string;
-      };
-
-    try {
-      const mutual = await this.mutualService.updateMutual({
-        byEntityType,
-        byEntityId,
-        entityType,
-        entityId,
-        mutualPayload: req.body,
-        accountId,
-      });
-
-      return res.status(httpStatus.OK).json(mutual);
-    } catch (err) {
-      if (err instanceof ZodError) {
-        return res.status(httpStatus.BAD_REQUEST).json({
-          code: 'API_VALIDATION_ERROR',
-          message: 'API validation failed',
-          details: err.flatten(),
-        });
-      }
-
-      if (err instanceof StandardError && err.code === 'MUTUAL_NOT_FOUND') {
-        return res.status(httpStatus.BAD_REQUEST).json({
-          ...err.toJSON(),
-        });
-      }
-
-      throw err;
-    }
-  };
-}

package/controllers/setupRoutes.ts

@@ -1,73 +0,0 @@
-import type { Router } from 'express';
-import { entityTypeCheck } from '../middlewares/entity-type-check';
-import { mutualTypeCheck } from '../middlewares/mutual-type-check';
-import { DependencyContainer } from '../services/DependencyContainer';
-
-const setupCommonRoutes = (router: Router) => {
-  /*
-   * Mutual endpoint
-   */
-  const container = new DependencyContainer();
-
-  router.use('/mutual/:byEntityType/:byEntityId/:entityType', mutualTypeCheck);
-  router.get(
-    '/mutual/:byEntityType/:byEntityId/:entityType',
-    container.listEntitiesByEntityController.controller,
-  );
-  router.post(
-    '/mutual/:byEntityType/:byEntityId/:entityType/:entityId',
-    container.createMutualController.controller,
-  );
-  router.get(
-    '/mutual/:byEntityType/:byEntityId/:entityType/:entityId',
-    container.getMutualController.controller,
-  );
-  router.patch(
-    '/mutual/:byEntityType/:byEntityId/:entityType/:entityId',
-    container.updateMutualController.controller,
-  );
-  router.delete(
-    '/mutual/:byEntityType/:byEntityId/:entityType/:entityId',
-    container.deleteMutualController.controller,
-  );
-
-  /*
-   * Entities endpoint
-   */
-
-  router.use('/entity/:entityType', entityTypeCheck);
-  router.get(
-    '/entity/:entityType',
-    container.listEntitiesController.controller,
-  );
-  router.post(
-    '/entity/:entityType',
-    container.createEntityController.controller,
-  );
-  router.get(
-    '/entity/:entityType/:entityId',
-    container.getEntityController.controller,
-  );
-  router.put(
-    '/entity/:entityType/:entityId',
-    container.upsertEntityController.controller,
-  );
-  router.patch(
-    '/entity/:entityType/:entityId',
-    container.updateEntityController.controller,
-  );
-  router.delete(
-    '/entity/:entityType/:entityId',
-    container.deleteEntityController.controller,
-  );
-
-  /*
-   * Tag endpoint
-   */
-  router.get(
-    '/tag/:entityType/:tagName',
-    container.listTagsController.controller,
-  );
-};
-
-export { setupCommonRoutes };

package/controllers/tag/list-tags.controller.ts

@@ -1,57 +0,0 @@
-import type { Entity } from '@monorise/base';
-import type { Request, Response } from 'express';
-import { z } from 'zod';
-import type { TagRepository } from '../../data/Tag';
-import { fromLastKeyQuery } from '../../helpers/fromLastKeyQuery';
-import { toLastKeyResponse } from '../../helpers/toLastKeyResponse';
-
-const querySchema = z.object({
-  group: z.string().optional(),
-  query: z.string().optional(),
-  start: z.string().optional(),
-  end: z.string().optional(),
-  limit: z.string().optional(),
-  lastKey: z.string().optional(),
-});
-
-export class ListTagsController {
-  constructor(private tagRepository: TagRepository) {}
-
-  controller: (req: Request, res: Response) => void = async (req, res) => {
-    const errorContext: Record<string, unknown> = {};
-    try {
-      errorContext.params = req.params;
-      errorContext.query = req.query;
-
-      const { entityType, tagName } = req.params as unknown as {
-        entityType: Entity;
-        tagName: string;
-      };
-
-      const { lastKey, query, limit, start, end, group } = querySchema.parse(
-        req.query,
-      );
-
-      const results = await this.tagRepository.listTags({
-        entityType,
-        tagName,
-        limit: Number(limit),
-        options: {
-          lastKey: fromLastKeyQuery(lastKey),
-        },
-        query,
-        group,
-        start,
-        end,
-      });
-      return res.json({
-        entities: results.items.map((item) => item.toJSON()),
-        totalCount: results.totalCount,
-        lastKey: toLastKeyResponse(results.lastKey),
-      });
-    } catch (error) {
-      console.log({ error, errorContext });
-      return res.status(500).json({ message: error });
-    }
-  };
-}

package/data/DbUtils.ts

@@ -1,40 +0,0 @@
-import {
-  BatchStatementErrorCodeEnum,
-  type DynamoDB,
-  type TransactWriteItemsInput,
-  TransactionCanceledException,
-} from '@aws-sdk/client-dynamodb';
-import { StandardError } from '../errors/standard-error';
-
-export class DbUtils {
-  constructor(private ddbClient: DynamoDB) {}
-
-  async executeTransactWrite(params: TransactWriteItemsInput) {
-    try {
-      await this.ddbClient.transactWriteItems(params);
-    } catch (err) {
-      if (err instanceof TransactionCanceledException) {
-        const hasConditionalCheckFailed = err.CancellationReasons?.some(
-          (reason) =>
-            reason.Code === BatchStatementErrorCodeEnum.ConditionalCheckFailed,
-        );
-
-        if (hasConditionalCheckFailed) {
-          throw new StandardError(
-            'CONDITIONAL_CHECK_FAILED',
-            'Failed to executeTransactWrite',
-            err,
-            { params },
-          );
-        }
-      }
-
-      throw new StandardError(
-        'TRANSACTION_FAILED',
-        'Failed to executeTransactWrite',
-        err,
-        { params },
-      );
-    }
-  }
-}