@mydoormot/app-types 1.4.1 → 1.4.2

package/.turbo/turbo-build.log

@@ -1,14 +1,18 @@
-
-> @mydoormot/app-types@1.4.0 build /Users/chuksben/Desktop/projects/microservices/mydoormot/packages/app-types
-> tsup src/index.ts --format cjs --dts
-
-CLI Building entry: src/index.ts
-CLI Using tsconfig: tsconfig.json
-CLI tsup v7.2.0
-CLI Target: es2021
-CJS Build start
-CJS dist/index.cjs 6.10 KB
-CJS ⚡️ Build success in 77ms
-DTS Build start
-DTS ⚡️ Build success in 578ms
-DTS dist/index.d.cts 11.79 KB
+
+> @mydoormot/app-types@1.4.1 build /Users/chuksben/Desktop/projects/microservices/mydoormot/packages/app-types
+> tsup src/index.ts --format esm,cjs --dts
+
+CLI Building entry: src/index.ts
+CLI Using tsconfig: tsconfig.json
+CLI tsup v7.3.0
+CLI Target: es2021
+ESM Build start
+CJS Build start
+ESM dist/index.js 5.14 KB
+ESM ⚡️ Build success in 46ms
+CJS dist/index.cjs 6.67 KB
+CJS ⚡️ Build success in 46ms
+DTS Build start
+DTS ⚡️ Build success in 686ms
+DTS dist/index.d.ts  12.76 KB
+DTS dist/index.d.cts 12.76 KB

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @mydoormot/app-types
 
+## 1.4.2
+
+### Patch Changes
+
+- Modified business types
+
 ## 1.4.1
 
 ### Patch Changes

package/dist/index.cjs

@@ -25,6 +25,8 @@ __export(src_exports, {
   DeliveryStatus: () => DeliveryStatus,
   EnterpriseType: () => EnterpriseType,
   ErrandStatus: () => ErrandStatus,
+  InvoiceGenerationType: () => InvoiceGenerationType,
+  InvoiceItemType: () => InvoiceItemType,
   InvoiceStatus: () => InvoiceStatus,
   LinkDestination: () => LinkDestination,
   NotificationType: () => NotificationType,
@@ -126,9 +128,19 @@ var InvoiceStatus = /* @__PURE__ */ ((InvoiceStatus2) => {
   InvoiceStatus2["Failed"] = "failed";
   return InvoiceStatus2;
 })(InvoiceStatus || {});
+var InvoiceItemType = /* @__PURE__ */ ((InvoiceItemType2) => {
+  InvoiceItemType2["Errand"] = "errand";
+  return InvoiceItemType2;
+})(InvoiceItemType || {});
+var InvoiceGenerationType = /* @__PURE__ */ ((InvoiceGenerationType2) => {
+  InvoiceGenerationType2["Auto"] = "auto";
+  InvoiceGenerationType2["Manual"] = "manual";
+  return InvoiceGenerationType2;
+})(InvoiceGenerationType || {});
 var PaymentOptions = /* @__PURE__ */ ((PaymentOptions2) => {
   PaymentOptions2["Cash"] = "cash";
   PaymentOptions2["Card"] = "card";
+  PaymentOptions2["BusinessInvoice"] = "business_invoice";
   return PaymentOptions2;
 })(PaymentOptions || {});
 
@@ -171,6 +183,8 @@ var LinkDestination = /* @__PURE__ */ ((LinkDestination2) => {
   DeliveryStatus,
   EnterpriseType,
   ErrandStatus,
+  InvoiceGenerationType,
+  InvoiceItemType,
   InvoiceStatus,
   LinkDestination,
   NotificationType,

package/dist/index.d.cts

@@ -159,9 +159,17 @@ declare enum InvoiceStatus {
     Cancelled = "cancelled",
     Failed = "failed"
 }
+declare enum InvoiceItemType {
+    Errand = "errand"
+}
+declare enum InvoiceGenerationType {
+    Auto = "auto",
+    Manual = "manual"
+}
 declare enum PaymentOptions {
     Cash = "cash",
-    Card = "card"
+    Card = "card",
+    BusinessInvoice = "business_invoice"
 }
 interface Invoice {
     id: string;
@@ -175,6 +183,27 @@ interface Invoice {
     errandId?: string;
     authorizationUrl?: string;
     accessCode?: string;
+    generationType?: InvoiceGenerationType | `${InvoiceGenerationType}`;
+    startDate?: string;
+    endDate?: string;
+    dueDate?: string;
+    invoiceNumber?: string;
+    isErrandsPaid?: boolean;
+    items: InvoiceItem[];
+    businessId?: string;
+    createdAt: string;
+    updatedAt: string;
+}
+interface InvoiceItem {
+    id: string;
+    invoiceId: string;
+    itemType: InvoiceItemType | `${InvoiceItemType}`;
+    itemId: string | Errand;
+    amount: number;
+    description: string;
+    date: string;
+    createdAt: string;
+    updatedAt: string;
 }
 
 type Rider = {
@@ -309,6 +338,8 @@ interface Errand {
     ownerMobileNumber?: string;
     errandTimeline?: string | ErrandTimeline;
     queuePosition?: number;
+    isTest?: boolean;
+    isInBusinessInvoice?: boolean;
 }
 interface AggregatedErrand extends Errand {
     parcelSize: `${ParcelSize}`;
@@ -329,7 +360,7 @@ interface AggregatedErrand extends Errand {
         stateName: string;
         stateCoords: number[];
     };
-    riderUserDetails: User;
+    riderUserDetails?: User;
 }
 interface ErrandRating {
     createdAt: string;
@@ -450,6 +481,7 @@ interface Business {
     updatedAt: string | NullOrUndefined | Date;
     verifiedAt: string | NullOrUndefined | Date;
     registrationCompletedAt: string | NullOrUndefined | Date;
+    mongoId: string;
     version: number;
 }
 interface BusinessCategory {
@@ -496,4 +528,4 @@ declare enum LinkDestination {
 }
 type NullOrUndefined = null | undefined;
 
-export { AddressDetails, AddressTypes, AggregatedErrand, AuthType, Business, BusinessCategory, City, Coupon, Customer, DeliveryStatus, Enterprise, EnterpriseCategoryDoc, EnterpriseSubCategoryDoc, EnterpriseType, Errand, ErrandRating, ErrandStatus, ErrandTimeline, Invoice, InvoiceStatus, LatLng, LinkDestination, Notification, NotificationData, NotificationType, NullOrUndefined, PaginateResult, ParcelSize, PaymentOptions, PendingErrand, Rider, RoleType, State, User, UserAddress, Vehicle, VehicleType, errandTimeline };
+export { type AddressDetails, AddressTypes, type AggregatedErrand, AuthType, type Business, type BusinessCategory, type City, type Coupon, type Customer, DeliveryStatus, type Enterprise, type EnterpriseCategoryDoc, type EnterpriseSubCategoryDoc, EnterpriseType, type Errand, type ErrandRating, ErrandStatus, type ErrandTimeline, type Invoice, InvoiceGenerationType, type InvoiceItem, InvoiceItemType, InvoiceStatus, type LatLng, LinkDestination, type Notification, type NotificationData, NotificationType, type NullOrUndefined, type PaginateResult, ParcelSize, PaymentOptions, type PendingErrand, type Rider, RoleType, type State, type User, type UserAddress, type Vehicle, VehicleType, errandTimeline };

package/dist/index.d.ts

@@ -8,8 +8,8 @@ type City = {
     };
     population: string;
     populationProper: string;
-    updatedAt: Date;
-    createdAt: Date;
+    updatedAt: Date | string;
+    createdAt: Date | string;
     version: number;
     isRiderActive: boolean;
     isPropertyActive: boolean;
@@ -24,8 +24,8 @@ type State = {
     };
     alias: string;
     version: number;
-    updatedAt: Date;
-    createdAt: Date;
+    updatedAt: Date | string;
+    createdAt: Date | string;
 };
 type LatLng = `${number},${number}`;
 
@@ -159,9 +159,17 @@ declare enum InvoiceStatus {
     Cancelled = "cancelled",
     Failed = "failed"
 }
+declare enum InvoiceItemType {
+    Errand = "errand"
+}
+declare enum InvoiceGenerationType {
+    Auto = "auto",
+    Manual = "manual"
+}
 declare enum PaymentOptions {
     Cash = "cash",
-    Card = "card"
+    Card = "card",
+    BusinessInvoice = "business_invoice"
 }
 interface Invoice {
     id: string;
@@ -175,6 +183,27 @@ interface Invoice {
     errandId?: string;
     authorizationUrl?: string;
     accessCode?: string;
+    generationType?: InvoiceGenerationType | `${InvoiceGenerationType}`;
+    startDate?: string;
+    endDate?: string;
+    dueDate?: string;
+    invoiceNumber?: string;
+    isErrandsPaid?: boolean;
+    items: InvoiceItem[];
+    businessId?: string;
+    createdAt: string;
+    updatedAt: string;
+}
+interface InvoiceItem {
+    id: string;
+    invoiceId: string;
+    itemType: InvoiceItemType | `${InvoiceItemType}`;
+    itemId: string | Errand;
+    amount: number;
+    description: string;
+    date: string;
+    createdAt: string;
+    updatedAt: string;
 }
 
 type Rider = {
@@ -206,7 +235,6 @@ declare enum VehicleType {
 type Vehicle = {
     user: string;
     vehicleNumber: string;
-    enterprise: string;
     version: number;
     createdAt: string;
     updatedAt: string;
@@ -309,8 +337,11 @@ interface Errand {
     coupon?: string | Coupon;
     ownerMobileNumber?: string;
     errandTimeline?: string | ErrandTimeline;
+    queuePosition?: number;
+    isTest?: boolean;
+    isInBusinessInvoice?: boolean;
 }
-interface AggragatedErrand extends Errand {
+interface AggregatedErrand extends Errand {
     parcelSize: `${ParcelSize}`;
     invoiceDetails: Invoice;
     pickupLocation: {
@@ -329,7 +360,7 @@ interface AggragatedErrand extends Errand {
         stateName: string;
         stateCoords: number[];
     };
-    riderUserDetails: User;
+    riderUserDetails?: User;
 }
 interface ErrandRating {
     createdAt: string;
@@ -420,6 +451,7 @@ type Notification = {
 };
 
 interface Business {
+    id: string;
     pgId: string;
     seqId: number;
     userId: string;
@@ -428,7 +460,10 @@ interface Business {
     officeNumber: string;
     categoryId: string;
     address: string | NullOrUndefined;
-    addressCoordinates: number[] | NullOrUndefined | [number, number];
+    addressCoordinates: number[] | NullOrUndefined | {
+        x: number;
+        y: number;
+    };
     loggedIn: boolean | NullOrUndefined;
     slug: string;
     verified: boolean | NullOrUndefined;
@@ -436,7 +471,7 @@ interface Business {
     registrationCompleted: boolean | NullOrUndefined;
     stateId: string | NullOrUndefined;
     cityId: string | NullOrUndefined;
-    orginalLogoUrl: string | NullOrUndefined;
+    originalLogoUrl: string | NullOrUndefined;
     logoUrl: string | NullOrUndefined;
     logoBlurHash: string | NullOrUndefined;
     coverImageUrl: string | NullOrUndefined;
@@ -446,8 +481,30 @@ interface Business {
     updatedAt: string | NullOrUndefined | Date;
     verifiedAt: string | NullOrUndefined | Date;
     registrationCompletedAt: string | NullOrUndefined | Date;
+    mongoId: string;
     version: number;
 }
+interface BusinessCategory {
+    id: string;
+    seqId: number;
+    name: string;
+    slug: string;
+    createdAt: string;
+    updatedAt: string;
+}
+
+interface Customer {
+    id: string;
+    businessId: string | Business;
+    phoneNumber: string;
+    fullName: string;
+    cityId: string;
+    address: string;
+    landmark?: string;
+    errandsCount?: number;
+    city?: City;
+    state?: State;
+}
 
 interface PaginateResult<T> {
     docs: T[];
@@ -471,4 +528,4 @@ declare enum LinkDestination {
 }
 type NullOrUndefined = null | undefined;
 
-export { AddressDetails, AddressTypes, AggragatedErrand, AuthType, Business, City, Coupon, DeliveryStatus, Enterprise, EnterpriseCategoryDoc, EnterpriseSubCategoryDoc, EnterpriseType, Errand, ErrandRating, ErrandStatus, ErrandTimeline, Invoice, InvoiceStatus, LatLng, LinkDestination, Notification, NotificationData, NotificationType, NullOrUndefined, PaginateResult, ParcelSize, PaymentOptions, PendingErrand, Rider, RoleType, State, User, UserAddress, Vehicle, errandTimeline };
+export { type AddressDetails, AddressTypes, type AggregatedErrand, AuthType, type Business, type BusinessCategory, type City, type Coupon, type Customer, DeliveryStatus, type Enterprise, type EnterpriseCategoryDoc, type EnterpriseSubCategoryDoc, EnterpriseType, type Errand, type ErrandRating, ErrandStatus, type ErrandTimeline, type Invoice, InvoiceGenerationType, type InvoiceItem, InvoiceItemType, InvoiceStatus, type LatLng, LinkDestination, type Notification, type NotificationData, NotificationType, type NullOrUndefined, type PaginateResult, ParcelSize, PaymentOptions, type PendingErrand, type Rider, RoleType, type State, type User, type UserAddress, type Vehicle, VehicleType, errandTimeline };

package/dist/index.js

@@ -1,40 +1,3 @@
-"use strict";
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-
-// src/index.ts
-var src_exports = {};
-__export(src_exports, {
-  AddressTypes: () => AddressTypes,
-  AuthType: () => AuthType,
-  DeliveryStatus: () => DeliveryStatus,
-  EnterpriseType: () => EnterpriseType,
-  ErrandStatus: () => ErrandStatus,
-  InvoiceStatus: () => InvoiceStatus,
-  LinkDestination: () => LinkDestination,
-  NotificationType: () => NotificationType,
-  ParcelSize: () => ParcelSize,
-  PaymentOptions: () => PaymentOptions,
-  RoleType: () => RoleType,
-  errandTimeline: () => errandTimeline
-});
-module.exports = __toCommonJS(src_exports);
-
 // src/user.ts
 var RoleType = /* @__PURE__ */ ((RoleType2) => {
   RoleType2["Rider"] = "rider";
@@ -70,6 +33,11 @@ var errandTimeline = [
     title: "pending" /* Pending */,
     description: "Your errand is pending, you would be notified as soon as it is started"
   },
+  {
+    status: "rider-assigned" /* RiderAssigned */,
+    title: "rider-assigned" /* RiderAssigned */,
+    description: "Your errand has been assigned to a dispatch rider, you would be notified by the dispatch rider shortly"
+  },
   {
     status: "started" /* Started */,
     title: "started" /* Started */,
@@ -120,9 +88,19 @@ var InvoiceStatus = /* @__PURE__ */ ((InvoiceStatus2) => {
   InvoiceStatus2["Failed"] = "failed";
   return InvoiceStatus2;
 })(InvoiceStatus || {});
+var InvoiceItemType = /* @__PURE__ */ ((InvoiceItemType2) => {
+  InvoiceItemType2["Errand"] = "errand";
+  return InvoiceItemType2;
+})(InvoiceItemType || {});
+var InvoiceGenerationType = /* @__PURE__ */ ((InvoiceGenerationType2) => {
+  InvoiceGenerationType2["Auto"] = "auto";
+  InvoiceGenerationType2["Manual"] = "manual";
+  return InvoiceGenerationType2;
+})(InvoiceGenerationType || {});
 var PaymentOptions = /* @__PURE__ */ ((PaymentOptions2) => {
   PaymentOptions2["Cash"] = "cash";
   PaymentOptions2["Card"] = "card";
+  PaymentOptions2["BusinessInvoice"] = "business_invoice";
   return PaymentOptions2;
 })(PaymentOptions || {});
 
@@ -135,6 +113,13 @@ var NotificationType = /* @__PURE__ */ ((NotificationType2) => {
   return NotificationType2;
 })(NotificationType || {});
 
+// src/rider.ts
+var VehicleType = /* @__PURE__ */ ((VehicleType2) => {
+  VehicleType2["Bike"] = "bike";
+  VehicleType2["Shuttle"] = "shuttle";
+  return VehicleType2;
+})(VehicleType || {});
+
 // src/enterprise.ts
 var EnterpriseType = /* @__PURE__ */ ((EnterpriseType2) => {
   EnterpriseType2["Restaurant"] = "restaurant";
@@ -151,18 +136,20 @@ var LinkDestination = /* @__PURE__ */ ((LinkDestination2) => {
   LinkDestination2["RiderApp"] = "mydoormot:rider";
   return LinkDestination2;
 })(LinkDestination || {});
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
+export {
   AddressTypes,
   AuthType,
   DeliveryStatus,
   EnterpriseType,
   ErrandStatus,
+  InvoiceGenerationType,
+  InvoiceItemType,
   InvoiceStatus,
   LinkDestination,
   NotificationType,
   ParcelSize,
   PaymentOptions,
   RoleType,
+  VehicleType,
   errandTimeline
-});
+};

package/package.json

@@ -1,10 +1,14 @@
 {
   "name": "@mydoormot/app-types",
-  "version": "1.4.1",
+  "version": "1.4.2",
   "description": "",
-  "mains": "./dist/index.js",
-  "typess": "./dist/index.d.ts",
-  "main": "./src/index.ts",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    "import": "./dist/index.js",
+    "require": "./dist/index.cjs"
+  },
   "keywords": [],
   "author": "",
   "license": "ISC",
@@ -17,7 +21,7 @@
   },
   "type": "module",
   "scripts": {
-    "clean": "del ./build/*",
-    "build": "tsup src/index.ts --format cjs --dts"
+    "clean": "del ./dist/*",
+    "build": "tsup src/index.ts --format esm,cjs --dts"
   }
 }

package/src/business.ts

@@ -39,6 +39,7 @@ export interface Business {
   updatedAt: string | NullOrUndefined | Date;
   verifiedAt: string | NullOrUndefined | Date;
   registrationCompletedAt: string | NullOrUndefined | Date;
+  mongoId: string;
   version: number;
 }
 

package/src/errand.ts

@@ -140,6 +140,8 @@ export interface Errand {
   ownerMobileNumber?: string;
   errandTimeline?: string | ErrandTimeline;
   queuePosition?: number;
+  isTest?: boolean;
+  isInBusinessInvoice?: boolean;
 }
 
 export interface AggregatedErrand extends Errand {
@@ -161,7 +163,7 @@ export interface AggregatedErrand extends Errand {
     stateName: string;
     stateCoords: number[];
   };
-  riderUserDetails: User;
+  riderUserDetails?: User;
 }
 
 export interface ErrandTimeline {

package/src/invoice.ts

@@ -1,4 +1,5 @@
 import { EnterpriseType } from './enterprise';
+import { Errand } from './errand';
 
 export enum InvoiceStatus {
   Pending = 'pending',
@@ -8,9 +9,20 @@ export enum InvoiceStatus {
   Failed = 'failed',
 }
 
+export enum InvoiceItemType {
+  Errand = 'errand',
+  // Future item types can be added here
+}
+
+export enum InvoiceGenerationType {
+  Auto = 'auto',
+  Manual = 'manual',
+}
+
 export enum PaymentOptions {
   Cash = 'cash',
   Card = 'card',
+  BusinessInvoice = 'business_invoice',
 }
 
 export interface Invoice {
@@ -25,4 +37,26 @@ export interface Invoice {
   errandId?: string;
   authorizationUrl?: string;
   accessCode?: string;
+  generationType?: InvoiceGenerationType | `${InvoiceGenerationType}`;
+  startDate?: string;
+  endDate?: string;
+  dueDate?: string;
+  invoiceNumber?: string;
+  isErrandsPaid?: boolean;
+  items: InvoiceItem[];
+  businessId?: string;
+  createdAt: string;
+  updatedAt: string;
+}
+
+export interface InvoiceItem {
+  id: string;
+  invoiceId: string;
+  itemType: InvoiceItemType | `${InvoiceItemType}`;
+  itemId: string | Errand;
+  amount: number;
+  description: string;
+  date: string;
+  createdAt: string;
+  updatedAt: string;
 }

package/tsconfig.json

@@ -25,10 +25,9 @@
     // "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
     // "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
     // "moduleDetection": "auto",                        /* Control what method is used to detect module-format JS files. */
-
     "preserveWatchOutput": true,
     /* Modules */
-    "module": "ESNext" /* Specify what module code is generated. */,
+    "module": "CommonJS" /* Specify what module code is generated. */,
     // "rootDir": "./",                                  /* Specify the root folder within your source files. */
     "moduleResolution": "node" /* Specify how TypeScript looks up a file from a given module specifier. */,
     // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */