@nimee/calculations 1.0.1

package/dist/index.d.ts

@@ -0,0 +1 @@
+export * from "./prices";

package/dist/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./prices"), exports);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAAyB"}

package/dist/prices.d.ts

@@ -0,0 +1,9 @@
+import { IAccountModel, IEventModel, IUserEventModel } from "@nimee/shared-types";
+export declare const getTotalTicketsAmount: (allUsersEvent: IUserEventModel[]) => number;
+export declare const calculateFinalPriceWithNimiFee: (totalPrice: number, event: IEventModel, account: IAccountModel) => {
+    nimiFeePercentage: number;
+    nimiFee: number;
+    finalPriceWithNimiFee: number;
+};
+export declare const calculateFinalPriceWithCouponDiscount: (totalPrice: number, couponDiscount: number) => number;
+export declare const validateFreeOrder: (ticketIds: string[], couponDiscount: number, accountId: string, eventId: string) => Promise<boolean>;

package/dist/prices.js

@@ -0,0 +1,71 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateFreeOrder = exports.calculateFinalPriceWithCouponDiscount = exports.calculateFinalPriceWithNimiFee = exports.getTotalTicketsAmount = void 0;
+/* Central the prices logic so we won't repeat it */
+const shared_types_1 = require("@nimee/shared-types");
+const api_clients_1 = require("@nimee/api-clients");
+const error_handler_1 = require("@nimee/error-handler");
+// Support both legacy and new userEvent schema (with ticketsInfo and without.)
+const getTotalTicketsAmount = (allUsersEvent) => {
+    return allUsersEvent.reduce((acc, userEvent) => {
+        var _a;
+        // For user-event to one ticket.
+        if (!((_a = userEvent === null || userEvent === void 0 ? void 0 : userEvent.ticketsInfo) === null || _a === void 0 ? void 0 : _a.length)) {
+            return acc + 1;
+        }
+        // For user-event to many ticket.
+        return acc + userEvent.ticketsInfo.length;
+    }, 0);
+};
+exports.getTotalTicketsAmount = getTotalTicketsAmount;
+const calculateFinalPriceWithNimiFee = (totalPrice, event, account) => {
+    switch (event.feeCollectionType) {
+        case shared_types_1.IFeeCollectionType.PERCENTAGE_FROM_TICKET:
+            return { finalPriceWithNimiFee: totalPrice, nimiFee: 0, nimiFeePercentage: account.marketFee };
+        case shared_types_1.IFeeCollectionType.ON_TOP_OF_TICKET:
+            // minimum 5
+            const unroundedValue = Math.max(5, (totalPrice * account.marketFee) / 100);
+            const roundedValue = Math.round(unroundedValue * 2) / 2;
+            return {
+                finalPriceWithNimiFee: roundedValue + totalPrice,
+                nimiFee: roundedValue,
+                nimiFeePercentage: (roundedValue / totalPrice) * 100,
+            };
+        default:
+            return { finalPriceWithNimiFee: totalPrice, nimiFee: 0, nimiFeePercentage: account.marketFee };
+    }
+};
+exports.calculateFinalPriceWithNimiFee = calculateFinalPriceWithNimiFee;
+const calculateFinalPriceWithCouponDiscount = (totalPrice, couponDiscount) => totalPrice - couponDiscount < 0 ? 0 : totalPrice - couponDiscount;
+exports.calculateFinalPriceWithCouponDiscount = calculateFinalPriceWithCouponDiscount;
+// Validate the order is really free, rather the tickets free or with the coupon discount.
+// we do this so the client won't be able to create orders with price 0 and it won't be validated
+const validateFreeOrder = (ticketIds, couponDiscount, accountId, eventId) => __awaiter(void 0, void 0, void 0, function* () {
+    const ticketClient = new api_clients_1.TicketClient();
+    const tickets = yield ticketClient.getTicketsByIds({ token: process.env.JWT_ADMIN, ticketIds, accountId, eventId });
+    if (!(tickets === null || tickets === void 0 ? void 0 : tickets.length)) {
+        throw new error_handler_1.CustomError("tickets_not_found_validate_free_order", 400, `tickets not found when try to validate free order with ticketIds - ${ticketIds} and eventId - ${eventId}`);
+    }
+    const rawOrderPriceFromTickets = tickets.reduce((acc, ticket) => acc + ticket.price, 0);
+    if (rawOrderPriceFromTickets === 0) {
+        return true;
+    }
+    if (couponDiscount) {
+        const orderPriceAfterCoupon = (0, exports.calculateFinalPriceWithCouponDiscount)(rawOrderPriceFromTickets, couponDiscount);
+        if (orderPriceAfterCoupon === 0) {
+            return true;
+        }
+    }
+    return false;
+});
+exports.validateFreeOrder = validateFreeOrder;
+//# sourceMappingURL=prices.js.map

package/dist/prices.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"prices.js","sourceRoot":"","sources":["../src/prices.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,oDAAoD;AACpD,sDAAsG;AACtG,oDAAkD;AAClD,wDAAmD;AAEnD,+EAA+E;AACxE,MAAM,qBAAqB,GAAG,CAAC,aAAgC,EAAU,EAAE;IAChF,OAAO,aAAa,CAAC,MAAM,CAAC,CAAC,GAAW,EAAE,SAA0B,EAAE,EAAE;;QACtE,gCAAgC;QAChC,IAAI,CAAC,CAAA,MAAA,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,WAAW,0CAAE,MAAM,CAAA,EAAE;YACnC,OAAO,GAAG,GAAG,CAAC,CAAC;SAChB;QACD,iCAAiC;QACjC,OAAO,GAAG,GAAG,SAAS,CAAC,WAAW,CAAC,MAAM,CAAC;IAC5C,CAAC,EAAE,CAAC,CAAC,CAAC;AACR,CAAC,CAAC;AATW,QAAA,qBAAqB,yBAShC;AAEK,MAAM,8BAA8B,GAAG,CAC5C,UAAkB,EAClB,KAAkB,EAClB,OAAsB,EACyD,EAAE;IACjF,QAAQ,KAAK,CAAC,iBAAiB,EAAE;QAC/B,KAAK,iCAAkB,CAAC,sBAAsB;YAC5C,OAAO,EAAE,qBAAqB,EAAE,UAAU,EAAE,OAAO,EAAE,CAAC,EAAE,iBAAiB,EAAE,OAAO,CAAC,SAAS,EAAE,CAAC;QACjG,KAAK,iCAAkB,CAAC,gBAAgB;YACtC,YAAY;YACZ,MAAM,cAAc,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,UAAU,GAAG,OAAO,CAAC,SAAS,CAAC,GAAG,GAAG,CAAC,CAAC;YAC3E,MAAM,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,cAAc,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;YACxD,OAAO;gBACL,qBAAqB,EAAE,YAAY,GAAG,UAAU;gBAChD,OAAO,EAAE,YAAY;gBACrB,iBAAiB,EAAE,CAAC,YAAY,GAAG,UAAU,CAAC,GAAG,GAAG;aACrD,CAAC;QACJ;YACE,OAAO,EAAE,qBAAqB,EAAE,UAAU,EAAE,OAAO,EAAE,CAAC,EAAE,iBAAiB,EAAE,OAAO,CAAC,SAAS,EAAE,CAAC;KAClG;AACH,CAAC,CAAC;AApBW,QAAA,8BAA8B,kCAoBzC;AACK,MAAM,qCAAqC,GAAG,CAAC,UAAkB,EAAE,cAAsB,EAAU,EAAE,CAC1G,UAAU,GAAG,cAAc,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,UAAU,GAAG,cAAc,CAAC;AADvD,QAAA,qCAAqC,yCACkB;AAEpE,0FAA0F;AAC1F,iGAAiG;AAC1F,MAAM,iBAAiB,GAAG,CAAO,SAAmB,EAAE,cAAsB,EAAE,SAAiB,EAAE,OAAe,EAAE,EAAE;IACzH,MAAM,YAAY,GAAG,IAAI,0BAAY,EAAE,CAAC;IACxC,MAAM,OAAO,GAAG,MAAM,YAAY,CAAC,eAAe,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC,CAAC;IACpH,IAAI,CAAC,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,MAAM,CAAA,EAAE;QACpB,MAAM,IAAI,2BAAW,CACnB,uCAAuC,EACvC,GAAG,EACH,sEAAsE,SAAS,kBAAkB,OAAO,EAAE,CAC3G,CAAC;KACH;IAED,MAAM,wBAAwB,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,GAAW,EAAE,MAAyB,EAAE,EAAE,CAAC,GAAG,GAAG,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;IACnH,IAAI,wBAAwB,KAAK,CAAC,EAAE;QAClC,OAAO,IAAI,CAAC;KACb;IAED,IAAI,cAAc,EAAE;QAClB,MAAM,qBAAqB,GAAG,IAAA,6CAAqC,EAAC,wBAAwB,EAAE,cAAc,CAAC,CAAC;QAC9G,IAAI,qBAAqB,KAAK,CAAC,EAAE;YAC/B,OAAO,IAAI,CAAC;SACb;KACF;IAED,OAAO,KAAK,CAAC;AACf,CAAC,CAAA,CAAC;AAxBW,QAAA,iBAAiB,qBAwB5B"}

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "@nimee/calculations",
+  "version": "1.0.1",
+  "description": "nimi calculations like prices for back and front",
+  "main": "dist/index.js",
+  "author": "dan goldberg",
+  "license": "ISC",
+  "scripts": {
+    "build-ts": "tsc",
+    "watch-ts": "tsc -w",
+    "build": "npm run build-ts",
+    "lint": "eslint -c ../../.eslintrc.js  --ext .ts src/**",
+    "prettier-format": "prettier --config .prettierrc 'src/**/*.ts' --write",
+    "incVersionAndPublish": "npm version patch && npm run publish-it && npm run i-all-workspaces",
+    "publish-it": "npm run build && npm publish --scope=nimee --access public",
+    "i-all-workspaces": "version=${npm_package_version} npm i @nimee/calculations@$version  --workspace=@nimee/event --workspace=@nimee/user-event --workspace=@nimee/send-notification --workspace=@nimee/user  --workspace=@nimee/payment --workspace=@nimee/analytics"
+  },
+  "devDependencies": {
+    "@typescript-eslint/eslint-plugin": "^5.18.0",
+    "@typescript-eslint/eslint-plugin-tslint": "^5.18.0",
+    "@typescript-eslint/parser": "^5.18.0",
+    "eslint": "8.22.0",
+    "eslint-plugin-jsdoc": "^38.1.6",
+    "eslint-plugin-no-null": "^1.0.2",
+    "nodemon": "^1.19.1",
+    "typescript": "^5.2.2"
+  },
+  "types": "dist/index.d.ts",
+  "dependencies": {
+    "@nimee/api-clients": "^1.1.15",
+    "@nimee/error-handler": "^0.0.7",
+    "axios": "1.2.1"
+  }
+}

package/src/index.ts

@@ -0,0 +1 @@
+export * from "./prices";

package/src/prices.ts

@@ -0,0 +1,68 @@
+/* Central the prices logic so we won't repeat it */
+import { IAccountModel, IEventModel, IFeeCollectionType, IUserEventModel } from "@nimee/shared-types";
+import { TicketClient } from "@nimee/api-clients";
+import { CustomError } from "@nimee/error-handler";
+
+// Support both legacy and new userEvent schema (with ticketsInfo and without.)
+export const getTotalTicketsAmount = (allUsersEvent: IUserEventModel[]): number => {
+  return allUsersEvent.reduce((acc: number, userEvent: IUserEventModel) => {
+    // For user-event to one ticket.
+    if (!userEvent?.ticketsInfo?.length) {
+      return acc + 1;
+    }
+    // For user-event to many ticket.
+    return acc + userEvent.ticketsInfo.length;
+  }, 0);
+};
+
+export const calculateFinalPriceWithNimiFee = (
+  totalPrice: number,
+  event: IEventModel,
+  account: IAccountModel
+): { nimiFeePercentage: number; nimiFee: number; finalPriceWithNimiFee: number } => {
+  switch (event.feeCollectionType) {
+    case IFeeCollectionType.PERCENTAGE_FROM_TICKET:
+      return { finalPriceWithNimiFee: totalPrice, nimiFee: 0, nimiFeePercentage: account.marketFee };
+    case IFeeCollectionType.ON_TOP_OF_TICKET:
+      // minimum 5
+      const unroundedValue = Math.max(5, (totalPrice * account.marketFee) / 100);
+      const roundedValue = Math.round(unroundedValue * 2) / 2;
+      return {
+        finalPriceWithNimiFee: roundedValue + totalPrice,
+        nimiFee: roundedValue,
+        nimiFeePercentage: (roundedValue / totalPrice) * 100,
+      };
+    default:
+      return { finalPriceWithNimiFee: totalPrice, nimiFee: 0, nimiFeePercentage: account.marketFee };
+  }
+};
+export const calculateFinalPriceWithCouponDiscount = (totalPrice: number, couponDiscount: number): number =>
+  totalPrice - couponDiscount < 0 ? 0 : totalPrice - couponDiscount;
+
+// Validate the order is really free, rather the tickets free or with the coupon discount.
+// we do this so the client won't be able to create orders with price 0 and it won't be validated
+export const validateFreeOrder = async (ticketIds: string[], couponDiscount: number, accountId: string, eventId: string) => {
+  const ticketClient = new TicketClient();
+  const tickets = await ticketClient.getTicketsByIds({ token: process.env.JWT_ADMIN, ticketIds, accountId, eventId });
+  if (!tickets?.length) {
+    throw new CustomError(
+      "tickets_not_found_validate_free_order",
+      400,
+      `tickets not found when try to validate free order with ticketIds - ${ticketIds} and eventId - ${eventId}`
+    );
+  }
+
+  const rawOrderPriceFromTickets = tickets.reduce((acc: number, ticket: { price: number }) => acc + ticket.price, 0);
+  if (rawOrderPriceFromTickets === 0) {
+    return true;
+  }
+
+  if (couponDiscount) {
+    const orderPriceAfterCoupon = calculateFinalPriceWithCouponDiscount(rawOrderPriceFromTickets, couponDiscount);
+    if (orderPriceAfterCoupon === 0) {
+      return true;
+    }
+  }
+
+  return false;
+};

package/tsconfig.json

@@ -0,0 +1,28 @@
+{
+    "compileOnSave": true,
+    "compilerOptions": {
+        "module": "commonjs",
+        "esModuleInterop": true,
+        "declaration": true,
+        "target": "es6",
+        "noImplicitAny": true,
+        "skipLibCheck": true,
+        "moduleResolution": "node",
+        "sourceMap": true,
+        "outDir": "./dist",
+        "baseUrl": ".",
+        "paths": {
+            "*": [
+                "node_modules/*",
+                "src/types/*"
+            ]
+        }
+    },
+    "include": [
+        "src/**/*"
+    ],
+    "exclude": [
+        "node_modules",
+        "dist"
+    ]
+}