@autologix-engineering/shared 1.0.26 → 1.0.28

package/.eslintrc.json

@@ -0,0 +1,25 @@
+{
+	"extends": ["../../.eslintrc"],
+	"ignorePatterns": ["!**/*"],
+	"overrides": [
+		{
+			"files": ["*.ts", "*.tsx", "*.js", "*.jsx"],
+			"rules": {}
+		},
+		{
+			"files": ["*.ts", "*.tsx"],
+			"rules": {}
+		},
+		{
+			"files": ["*.js", "*.jsx"],
+			"rules": {}
+		},
+		{
+			"files": ["*.json"],
+			"parser": "jsonc-eslint-parser",
+			"rules": {
+				"@nx/dependency-checks": "error"
+			}
+		}
+	]
+}

package/jest.config.ts

@@ -0,0 +1,14 @@
+/* eslint-disable */
+export default {
+	displayName: 'shared',
+	preset: '../../jest.preset.js',
+	testEnvironment: 'node',
+	transform: {
+		'^.+\\.[tj]s$': [
+			'ts-jest',
+			{ tsconfig: '<rootDir>/tsconfig.spec.json' },
+		],
+	},
+	moduleFileExtensions: ['ts', 'js', 'html'],
+	coverageDirectory: '../../coverage/libs/shared',
+};

package/package.json

@@ -1,16 +1,15 @@
 {
-  "name": "@autologix-engineering/shared",
-  "version": "1.0.26",
-  "dependencies": {
-    "tslib": "^2.3.0"
-  },
-  "type": "module",
-  "main": "./src/index.js",
-  "typings": "./src/index.d.ts",
-  "description": "Autologix shared libraries",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
-  "author": "autologix-engineering",
-  "module": "./src/index.js"
+	"name": "@autologix-engineering/shared",
+	"version": "1.0.28",
+	"dependencies": {
+		"tslib": "^2.3.0"
+	},
+	"type": "module",
+	"main": "./src/index.js",
+	"typings": "./src/index.d.ts",
+	"description": "Autologix shared libraries",
+	"scripts": {
+		"test": "echo \"Error: no test specified\" && exit 1"
+	},
+	"author": "autologix-engineering"
 }

package/project.json

@@ -0,0 +1,48 @@
+{
+	"name": "shared",
+	"$schema": "../../node_modules/nx/schemas/project-schema.json",
+	"sourceRoot": "libs/shared/src",
+	"projectType": "library",
+	"targets": {
+		"build": {
+			"executor": "@nx/js:tsc",
+			"outputs": ["{options.outputPath}"],
+			"options": {
+				"outputPath": "dist/libs/shared",
+				"tsConfig": "libs/shared/tsconfig.lib.json",
+				"packageJson": "libs/shared/package.json",
+				"main": "libs/shared/src/index.ts",
+				"assets": ["libs/shared/*.md"]
+			}
+		},
+		"publish": {
+			"command": "node tools/scripts/publish.mjs shared {args.ver} {args.tag}",
+			"dependsOn": ["build"]
+		},
+		"lint": {
+			"executor": "@nx/eslint:lint",
+			"outputs": ["{options.outputFile}"],
+			"options": {
+				"lintFilePatterns": [
+					"libs/shared/**/*.ts",
+					"libs/shared/package.json"
+				]
+			}
+		},
+		"test": {
+			"executor": "@nx/jest:jest",
+			"outputs": ["{workspaceRoot}/coverage/{projectRoot}"],
+			"options": {
+				"jestConfig": "libs/shared/jest.config.ts",
+				"passWithNoTests": true
+			},
+			"configurations": {
+				"ci": {
+					"ci": true,
+					"codeCoverage": true
+				}
+			}
+		}
+	},
+	"tags": []
+}

package/src/lib/billing-conditions/.eslintrc

@@ -0,0 +1,5 @@
+{
+    "extends": "../../../.eslintrc",
+    "rules": {},
+    "ignorePatterns": ["!**/*"]
+}

package/src/lib/billing-conditions/src/bill.generator.ts

@@ -0,0 +1,303 @@
+import { BillItemHead, TripStatus } from '../../enums/src/index';
+import {
+	BillLineItemField,
+	ConditionField,
+	ConditionPartialField,
+	GeneratedBillField,
+	IBillLineItem,
+	IGeneratedBill,
+	IPackage,
+	IRateCardTemplate,
+	PackageField,
+	PackageTemplateField,
+} from '../../models/src/index';
+import { ITripTrace } from './definitions';
+
+import { DeepPartial } from '../../definitions/src/index';
+import { TariffRuleProcessor } from './tariff.rule.processor';
+import { TransitionManager } from './transition.manager';
+import { TripTimeProcessor } from './implementation';
+/*
+  1. Get Trace
+  2. Instantiate Trip Processor
+  3. Get Transition Rules
+  4. Group Conditions by Trip Billing Variable
+  5. Sort Conditions (Desc)
+  6. Evaluate Conditions and arrive at Effective Package
+  7. Load Tariff Rules
+  8. Sort Conditions (Desc) (if exist)
+  9. Apply Conditional Tariff(s) => Conditional Rule Application(s)
+  10. Apply Tariff Rule, aggregate output from step 9 => Bill Line Items
+  11. Apply Base Cost => Bill Line Item
+  12. Generate Invoice
+
+  Notes: Step # 3 - 6 handled by Transition Manager
+
+  Inputs:
+  1. Trip Trace (IDriverLocation)
+  2. Rate Card Template
+      => Packages
+        => Package Template
+          => Tariff Rule
+            => Billable
+            => Conditional Tariff
+              => Condition
+      => Transition Rule
+        => Condition
+
+  Output:
+  1. Generated Bill
+    => Bill Line Items
+  2. Generated Proforma Invoice
+    => Generated Proforma Invoice Line Item
+
+*/
+
+// 4. Group Conditions by Trip Billing Variable
+// 5. Sort Conditions (Desc)
+// 6. Evaluate Conditions and arrive at Effective Package
+// 7. Load Tariff Rules
+// 8. Sort Conditions (Desc) (if exist)
+// 9. Apply Conditional Tariff(s) => Conditional Rule Application(s)
+// 10. Apply Tariff Rule, aggregate output from step 9 => Bill Line Items
+// 11. Apply Base Cost => Bill Line Item
+// 12. Generate Invoice
+
+// Inputs:
+// 1. Trip Trace (IDriverLocation)
+// 2. Rate Card Template
+// => Packages
+// => Package Template
+// => Tariff Rule
+// => Billable
+// => Conditional Tariff
+// => Condition
+// => Transition Rule
+// => Condition
+
+// Output:
+// 1. Generated Bill
+// => Bill Line Items
+// 2. Generated Proforma Invoice
+// => Generated Proforma Invoice Line Item
+
+export class BillGenerator {
+	private readonly _transitionManager: TransitionManager;
+	private readonly _tripProcessor!: TripTimeProcessor;
+	private readonly _tariffRuleProcessor!: TariffRuleProcessor;
+	constructor(
+		// 1. Get Trace
+		private readonly _trace: ITripTrace,
+		private readonly _ratecard: IRateCardTemplate,
+		private readonly _tripStatus: TripStatus,
+	) {
+		// Trip Processor
+		this._tripProcessor = new TripTimeProcessor(this._trace, {
+			sampleBy: 'MIN',
+		});
+		// 2. Instantiate Transition Manager
+		this._transitionManager = new TransitionManager(
+			this._ratecard,
+			this._tripProcessor,
+		);
+		this._tariffRuleProcessor = new TariffRuleProcessor(
+			this._tripProcessor,
+		);
+	}
+	async generateBillFor(_preferredPackage: IPackage) {
+		await this._tripProcessor._generateQuantizedTrace();
+		let _effectivePackage =
+			this._transitionManager.getEffectivePackage(_preferredPackage);
+		let oldPackage = _preferredPackage;
+		while (
+			oldPackage?.[PackageField.PackageId] !==
+			_effectivePackage?.[PackageField.PackageId]
+		) {
+			oldPackage = _effectivePackage;
+			_effectivePackage =
+				this._transitionManager.getEffectivePackage(_effectivePackage);
+		}
+		const _basecost =
+			_effectivePackage?.[PackageField.PackageTemplate]?.[
+				PackageTemplateField.BaseCost
+			];
+		const _tariffRules =
+			_effectivePackage?.[PackageField.PackageTemplate]?.[
+				PackageTemplateField.TariffRules
+			];
+		let _billLineItems: DeepPartial<IBillLineItem>[] = [];
+		if (
+			this._tripStatus === TripStatus.PassengerCancelled ||
+			this._tripStatus === TripStatus.ClientCancelled
+		) {
+			const cnclRules =
+				_effectivePackage?.[PackageField.PackageTemplate]?.[
+					PackageTemplateField.CancellationRules
+				];
+			if (cnclRules?.length > 0) {
+				const _scheduleTime = this._trace?.scheduleTime;
+				const endTime = this._trace?.endTime;
+				const cnclTime = _scheduleTime - endTime?.getTime();
+				const _sortedcnclRules = cnclRules?.sort((_a, _b) => {
+					return (
+						_a?.[ConditionField.ConditionalPartial]
+							?.comparand_number -
+						_b?.[ConditionField.ConditionalPartial]
+							?.comparand_number
+					);
+				});
+				_sortedcnclRules.forEach((element) => {
+					const time = parseFloat(
+						element?.[ConditionField.ConditionalPartial]?.[
+							ConditionPartialField.ComparandNumber
+						] + '',
+					);
+					if (cnclTime <= time) {
+						_billLineItems.push({
+							[BillLineItemField.BillItemHead]:
+								BillItemHead.CancellationCost,
+							[BillLineItemField.Amount]: parseFloat(
+								element?.[ConditionField.ConditionalPartial]?.[
+									ConditionPartialField.EffectiveValue
+								] + '',
+							),
+						});
+						return;
+					}
+				});
+			}
+		}
+		if (this._tripStatus === TripStatus.PassengerNoShow) {
+			let _noShowCost =
+				_effectivePackage?.[PackageField.PackageTemplate]?.[
+					PackageTemplateField.PassengerNoShowCost
+				];
+			_billLineItems.push({
+				[BillLineItemField.BillItemHead]:
+					BillItemHead.PassengerNoShowCost,
+				[BillLineItemField.Amount]: _noShowCost ? _noShowCost : 0,
+			});
+		} else {
+			_billLineItems = _billLineItems.concat(
+				..._tariffRules.map((_tr) =>
+					this._tariffRuleProcessor.evaluate(_tr),
+				),
+			);
+			_billLineItems = _billLineItems.filter(
+				(e) => e?.[BillLineItemField.Amount] != null,
+			);
+			if (
+				_effectivePackage?.[PackageField.PackageTemplate]?.[
+					PackageTemplateField.MinimumFare
+				]
+			) {
+				let otherAmount = _billLineItems
+					?.map((_li) => _li?.[BillLineItemField.Amount])
+					.reduce((_acc, _curr) => _curr + _acc, 0);
+				if (otherAmount <= _basecost) {
+					_billLineItems = [];
+					_billLineItems.push({
+						[BillLineItemField.BillItemHead]: BillItemHead.BaseCost,
+						[BillLineItemField.Amount]: _basecost,
+					});
+				}
+			} else {
+				_billLineItems.push({
+					[BillLineItemField.BillItemHead]: BillItemHead.BaseCost,
+					[BillLineItemField.Amount]: _basecost,
+				});
+			}
+		}
+		if (
+			_effectivePackage?.[PackageField.PackageTemplate]?.[
+				PackageTemplateField.WaitingCharges
+			] &&
+			this._tripProcessor.waitTimeInMins > 0
+		) {
+			_billLineItems.push({
+				[BillLineItemField.BillItemHead]: BillItemHead.WaitingCharges,
+				[BillLineItemField.Amount]:
+					this._tripProcessor.waitTimeInMins *
+					_effectivePackage?.[PackageField.PackageTemplate]?.[
+						PackageTemplateField.WaitingCharges
+					],
+			});
+		}
+		if (
+			_effectivePackage?.[PackageField.PackageTemplate]?.[
+				PackageTemplateField.NightChargesValue
+			]
+		) {
+			const start =
+				_effectivePackage?.[PackageField.PackageTemplate]?.[
+					PackageTemplateField.NightChargesRange
+				].start;
+			const end =
+				_effectivePackage?.[PackageField.PackageTemplate]?.[
+					PackageTemplateField.NightChargesRange
+				].end;
+			let startTime = this._trace.startTime;
+			if (this._trace.totalDistance == null)
+				startTime.setTime(startTime.getTime() + 330 * 60 * 1000);
+			let endTime = this._trace.endTime;
+			if (this._trace.totalDistance == null)
+				endTime.setTime(endTime.getTime() + 330 * 60 * 1000);
+			let startMillis =
+				startTime.getHours() * 3600000 +
+				startTime.getMinutes() * 60000 +
+				startTime.getSeconds() * 1000 +
+				startTime.getMilliseconds();
+			let endMillis =
+				endTime.getHours() * 3600000 +
+				endTime.getMinutes() * 60000 +
+				endTime.getSeconds() * 1000 +
+				endTime.getMilliseconds();
+			if (start < end) {
+				if (
+					(startMillis >= start && startMillis <= end) ||
+					(endMillis >= start && endMillis <= end)
+				) {
+					_billLineItems.push({
+						[BillLineItemField.BillItemHead]:
+							BillItemHead.NightCharges,
+						[BillLineItemField.Amount]:
+							_effectivePackage?.[PackageField.PackageTemplate]?.[
+								PackageTemplateField.NightChargesValue
+							],
+					});
+				}
+			} else {
+				if (
+					startMillis >= start ||
+					startMillis <= end ||
+					endMillis >= start ||
+					endMillis <= end
+				) {
+					_billLineItems.push({
+						[BillLineItemField.BillItemHead]:
+							BillItemHead.NightCharges,
+						[BillLineItemField.Amount]:
+							_effectivePackage?.[PackageField.PackageTemplate]?.[
+								PackageTemplateField.NightChargesValue
+							],
+					});
+				}
+			}
+		}
+		const _generatedBill: DeepPartial<IGeneratedBill> = {
+			[GeneratedBillField.BasePackage]: {
+				[PackageField.PackageId]:
+					_preferredPackage?.[PackageField.PackageId],
+			},
+			[GeneratedBillField.EffectivePackage]: {
+				[PackageField.PackageId]:
+					_effectivePackage?.[PackageField.PackageId],
+			},
+			[GeneratedBillField.BillLineItems]: _billLineItems,
+			[GeneratedBillField.TotalBillAmount]: _billLineItems
+				?.map((_li) => _li?.[BillLineItemField.Amount])
+				.reduce((_acc, _curr) => _curr + _acc, 0),
+		};
+		return _generatedBill;
+	}
+}

package/src/lib/billing-conditions/src/condition.builder.ts

@@ -0,0 +1,36 @@
+import {
+	IConditionalPartial,
+	ConditionPartialField,
+} from '../../models/src/index';
+import { ComparandType } from '../../enums/src/index';
+import {
+	NumericalCondition,
+	StringCondition,
+	TimeRangeCondition,
+	NumericalRangeCondition,
+	CategoricalRangeCondition,
+} from './implementation';
+
+export class ConditionBuilder {
+	static build(obj: IConditionalPartial) {
+		switch (obj?.[ConditionPartialField.ComparandType]) {
+			case ComparandType.Number: {
+				return new NumericalCondition(obj);
+			}
+			case ComparandType.String: {
+				return new StringCondition(obj);
+			}
+			case ComparandType.TimeRange: {
+				return new TimeRangeCondition(obj);
+			}
+			case ComparandType.NumericalRange: {
+				return new NumericalRangeCondition(obj);
+			}
+			case ComparandType.CategoricalRange: {
+				return new CategoricalRangeCondition(obj);
+			}
+			default:
+				return undefined;
+		}
+	}
+}

package/src/lib/billing-conditions/src/condition.sorter.builder.ts

@@ -0,0 +1,24 @@
+import {
+	IConditionalPartial,
+	ConditionPartialField,
+} from '../../models/src/index';
+import { ComparandType } from '../../enums/src/index';
+import {
+	NumericalConditionSorter,
+	NumericalRangeConditionSorter,
+} from './implementation';
+
+export class ConditionSortBuilder {
+	static build(obj: IConditionalPartial) {
+		switch (obj?.[ConditionPartialField.ComparandType]) {
+			case ComparandType.Number: {
+				return new NumericalConditionSorter();
+			}
+			case ComparandType.NumericalRange: {
+				return new NumericalRangeConditionSorter();
+			}
+			default:
+				return undefined;
+		}
+	}
+}

package/src/lib/billing-conditions/src/definitions/condition.sorter.ts

@@ -0,0 +1,5 @@
+import { IConditionalPartial } from '../../../models/src/index';
+
+export interface IConditionSorter {
+	sort(a: IConditionalPartial, b: IConditionalPartial): 1 | -1 | 0;
+}

package/src/lib/billing-conditions/src/definitions/conditional.partial.ts

@@ -0,0 +1,29 @@
+import {
+	ConditionPartialField,
+	IConditionalPartial,
+	IRange,
+} from '../../../models/src/index';
+import {
+	TripBillingVariable,
+	ConditionalOperator,
+	ComparandType,
+} from '../../../enums/src/index';
+
+export abstract class ConditionalPartial<ComparandDataType>
+	implements IConditionalPartial {
+	[ConditionPartialField.TripBillingVariable]: TripBillingVariable;
+	[ConditionPartialField.Condition]: ConditionalOperator;
+	[ConditionPartialField.ComparandType]: ComparandType;
+
+	constructor(
+		variable: TripBillingVariable,
+		operator: ConditionalOperator,
+		comparandType: ComparandType
+	) {
+		this[ConditionPartialField.TripBillingVariable] = variable;
+		this[ConditionPartialField.Condition] = operator;
+		this[ConditionPartialField.ComparandType] = comparandType;
+	}
+
+	abstract evaluate(operand: ComparandDataType): boolean;
+}

package/src/lib/billing-conditions/src/definitions/displacement.ts

@@ -0,0 +1,4 @@
+export interface IDisplacement {
+	timestamp: Date;
+	displacement: number;
+}

package/src/lib/billing-conditions/src/definitions/trip.location.ts

@@ -0,0 +1,6 @@
+import { Point } from 'geojson';
+
+export interface ITripLocation {
+	timestamp: Date;
+	location: Point;
+}

package/src/lib/billing-conditions/src/definitions/trip.trace.ts

@@ -0,0 +1,18 @@
+import { TripBillingDistanceType } from '../../../enums/src/index';
+import { ITripLocation } from './trip.location';
+
+export interface ITripTrace {
+	startTime?: Date;
+	endTime?: Date;
+	scheduleTime?: number;
+	locations: ITripLocation[];
+	gToPlocations: ITripLocation[];
+	pToGlocations: ITripLocation[];
+	billingDistanceType: TripBillingDistanceType;
+	waitTime: number;
+	pToGDistance: number;
+	gToPDistance: number;
+	totalDistance?: number;
+	garageKms?: number;
+	distance?: number;
+}

package/src/lib/billing-conditions/src/implementation/categorical.range.condition.ts

@@ -0,0 +1,39 @@
+import {
+	ConditionPartialField,
+	IConditionalPartial,
+} from '../../../models/src/index';
+import { ComparandType, ConditionalOperator } from '../../../enums/src/index';
+import { ConditionalPartial } from '../definitions';
+
+export class CategoricalRangeCondition extends ConditionalPartial<string[]> {
+	[ConditionPartialField.ComparandCategoricalRange]!: string[];
+	constructor(obj: IConditionalPartial) {
+		super(
+			obj[ConditionPartialField.TripBillingVariable],
+			obj[ConditionPartialField.Condition],
+			ComparandType.CategoricalRange,
+		);
+		this[ConditionPartialField.ComparandCategoricalRange] = [
+			...obj[ConditionPartialField.ComparandCategoricalRange],
+		];
+	}
+	evaluate(operand: string[]): boolean {
+		const comparand = this[ConditionPartialField.ComparandCategoricalRange];
+		switch (this[ConditionPartialField.Condition]) {
+			case ConditionalOperator.In: {
+				if (
+					operand.filter((_str) =>
+						comparand
+							.map((_c) => _c?.toLowerCase())
+							.includes(_str?.toLowerCase()),
+					)?.length === operand?.length
+				) {
+					return true;
+				}
+				return false;
+			}
+			default:
+				return false;
+		}
+	}
+}

package/src/lib/billing-conditions/src/implementation/numerical.condition.sorter.ts

@@ -0,0 +1,31 @@
+import { IConditionSorter, ConditionalPartial } from '../definitions';
+import {
+	IConditionalPartial,
+	ConditionPartialField,
+} from '../../../models/src/index';
+import { ConditionalOperator, ComparandType } from '../../../enums/src/index';
+
+export class NumericalConditionSorter implements IConditionSorter {
+	sort(a: IConditionalPartial, b: IConditionalPartial) {
+		if (
+			a?.[ConditionPartialField.ComparandType] === ComparandType.Number &&
+			b?.[ConditionPartialField.ComparandType] === ComparandType.Number
+		) {
+			switch (a?.[ConditionPartialField.Condition]) {
+				// a ≡  > x1
+				case ConditionalOperator.MoreThan: {
+					switch (b?.[ConditionPartialField.Condition]) {
+						// b ≡  > x2
+						case ConditionalOperator.MoreThan: {
+							return a?.[ConditionPartialField.ComparandNumber] >
+								b?.[ConditionPartialField.ComparandNumber]
+								? 1
+								: -1;
+						}
+					}
+				}
+			}
+		}
+		return 0;
+	}
+}

package/src/lib/billing-conditions/src/implementation/numerical.condition.ts

@@ -0,0 +1,34 @@
+import {
+	ConditionPartialField,
+	IConditionalPartial,
+} from '../../../models/src/index';
+import { ConditionalPartial } from '../definitions';
+import { ComparandType, ConditionalOperator } from '../../../enums/src/index';
+
+export class NumericalCondition extends ConditionalPartial<number> {
+	[ConditionPartialField.ComparandNumber]!: number;
+	constructor(obj: IConditionalPartial) {
+		super(
+			obj[ConditionPartialField.TripBillingVariable],
+			obj[ConditionPartialField.Condition],
+			ComparandType.Number,
+		);
+		this[ConditionPartialField.ComparandNumber] =
+			obj[ConditionPartialField.ComparandNumber];
+	}
+	evaluate(operand: number): boolean {
+		const comparand = this[ConditionPartialField.ComparandNumber];
+		switch (this[ConditionPartialField.Condition]) {
+			case ConditionalOperator.MoreThanOrEqual:
+				return operand >= comparand;
+			case ConditionalOperator.MoreThan:
+				return operand > comparand;
+			case ConditionalOperator.LessThanOrEqual:
+				return operand <= comparand;
+			case ConditionalOperator.LessThan:
+				return operand < comparand;
+			default:
+				return false;
+		}
+	}
+}