@mydoormot/app-types 1.0.2 → 1.1.0

package/.turbo/turbo-build.log

@@ -5,9 +5,9 @@ CLI Using tsconfig: tsconfig.json
 CLI tsup v7.2.0
 CLI Target: node16
 CJS Build start
-CJS dist/index.js 3.20 KB
-CJS ⚡️ Build success in 58ms
+CJS dist/index.js 4.42 KB
+CJS ⚡️ Build success in 91ms
 DTS Build start
-DTS ⚡️ Build success in 788ms
-DTS dist/index.d.ts 2.50 KB
-Done in 1.42s.
+DTS ⚡️ Build success in 1371ms
+DTS dist/index.d.ts 7.67 KB
+Done in 2.37s.

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @mydoormot/app-types
 
+## 1.1.0
+
+### Minor Changes
+
+- Added errand invoice types
+
 ## 1.0.2
 
 ### Patch Changes

package/dist/index.d.ts

@@ -53,6 +53,37 @@ type UserAddress = {
     direction?: string;
 };
 
+declare enum EnterpriseType {
+    Restaurant = "restaurant",
+    Dispatch = "dispatch",
+    Property = "property",
+    Store = "store"
+}
+
+declare enum InvoiceStatus {
+    Pending = "pending",
+    Paid = "paid",
+    Cancelled = "cancelled",
+    Failed = "failed"
+}
+declare enum PaymentOptions {
+    Cash = "cash",
+    Card = "card"
+}
+interface Invoice {
+    id: string;
+    user: string;
+    invoiceType: EnterpriseType | `${EnterpriseType}`;
+    amount: number;
+    paymentType: PaymentOptions | `${PaymentOptions}`;
+    status: InvoiceStatus | `${InvoiceStatus}`;
+    version: number;
+    referenceId?: string;
+    errandId?: string;
+    authorizationUrl?: string;
+    accessCode?: string;
+}
+
 declare enum ErrandStatus {
     Pending = "pending",
     RiderAssigned = "rider-assigned",
@@ -68,6 +99,201 @@ declare const errandTimeline: {
     title: ErrandStatus;
     description: string;
 }[];
+interface PendingErrand {
+    _id: string;
+    rider: string;
+    customerId: string;
+    parcelSize: ParcelSize;
+    deliveryStatus: ErrandStatus;
+    invoice: {
+        invoiceStatus: string;
+        refId: string;
+        transactionId: string;
+    };
+    nameOfItem: string;
+    pickupDetails: {
+        cityId: string;
+        address: string;
+        landmark: string;
+        fullName: string;
+        mobileNumber: string;
+    };
+    deliveryDetails: {
+        cityId: string;
+        address: string;
+        landmark: string;
+        fullName: string;
+        mobileNumber: string;
+    };
+    scheduleDate: string;
+    additionalData: string;
+    createdAt: string;
+    updatedAt: string;
+    version: number;
+    pickupLocation: {
+        cityId: string;
+        cityName: string;
+        cityCoords: number[];
+        stateId: string;
+        stateName: string;
+        stateCoords: number[];
+    };
+    deliveryLocation: {
+        cityId: string;
+        cityName: string;
+        cityCoords: number[];
+        stateId: string;
+        stateName: string;
+        stateCoords: number[];
+    };
+    errandTimeline: string;
+    id: string;
+}
+interface Errand {
+    id: string;
+    rider: string | Rider;
+    customerId: string;
+    nameOfItem: string;
+    pickupDetails: AddressDetails;
+    deliveryDetails: AddressDetails;
+    parcelSize: `${ParcelSize}`;
+    deliveryStatus: ErrandStatus | `${ErrandStatus}`;
+    invoice: {
+        invoiceStatus: InvoiceStatus | `${InvoiceStatus}`;
+        refId: string;
+        authorizationUrl: string;
+        accessCode: string;
+        invoiceId?: string;
+    };
+    aliasId: string;
+    errandTimeline: string | ErrandTimeline;
+    updatedAt: Date;
+    createdAt: Date;
+    errandRating?: string;
+    payOnDeliveryAmount?: string;
+    additionalData?: string;
+    deliveryDate?: Date;
+}
+interface AggragatedErrand extends Errand {
+    parcelSize: `${ParcelSize}`;
+    invoiceDetails: Invoice;
+    pickupLocation: {
+        cityId: string;
+        cityName: string;
+        cityCoords: number[];
+        stateId: string;
+        stateName: string;
+        stateCoords: number[];
+    };
+    deliveryLocation: {
+        cityId: string;
+        cityName: string;
+        cityCoords: number[];
+        stateId: string;
+        stateName: string;
+        stateCoords: number[];
+    };
+    riderUserDetails: User;
+    errandRatingDetails?: ErrandRating;
+}
+interface ErrandRating {
+    createdAt: string;
+    errandId: string;
+    rating: number;
+    ratingText: string;
+    riderId: string;
+    updatedAt: string;
+    userId: string;
+    version: number;
+    _id: string;
+}
+declare enum AddressTypes {
+    DeliveryAddress = "deliveryAddress",
+    PickupAddress = "pickupAddress"
+}
+interface Rider {
+    id: string;
+    _id: string;
+    user: string | User;
+    city: string;
+    currLocation?: {
+        coordinates: number[];
+    };
+    active: boolean;
+    name?: string;
+}
+interface ActiveRider {
+    _id: string;
+    user: string;
+    enterprise: string;
+    city: string;
+    verified: boolean;
+    currLocation: {
+        type: 'Point';
+        coordinates: [];
+    };
+    active: boolean;
+    vehicleNumber: string;
+    rating: number;
+    hasBeenRated: number;
+    createdAt: string;
+    updatedAt: string;
+    version: number;
+    numErrands: number;
+    available: boolean;
+    fullName: string;
+}
+declare enum DeliveryStatus {
+    Pending = "pending",
+    EnRoute = "en-route",
+    Delivered = "delivered",
+    Cancelled = "cancelled"
+}
+declare enum ParcelSize {
+    Bike = "bike",
+    Large = "large",
+    Medium = "medium",
+    Small = "small"
+}
+interface ErrandTimeline {
+    id: string;
+    errandId: string;
+    timeline: {
+        status: ErrandStatus;
+        title: string;
+        description: string;
+        time?: string;
+        date?: Date;
+    }[];
+    currTimelineIndex: number;
+    updatedAt: Date;
+    createdAt: Date;
+}
+interface ErrandTimeline {
+    id: string;
+    errandId: string;
+    timeline: {
+        status: ErrandStatus;
+        title: string;
+        description: string;
+        time?: string;
+        date?: Date;
+    }[];
+    currTimelineIndex: number;
+    updatedAt: Date;
+    createdAt: Date;
+}
+type AddressDetails = {
+    cityId: string;
+    address: string;
+    fullName: string;
+    location: {
+        coordinates: number[];
+    };
+    mobileNumber?: string;
+    landmark?: string;
+    addressId?: string;
+};
 
 type City = {
     id: string;
@@ -114,4 +340,4 @@ interface PaginateResult<T> {
     [customLabel: string]: T[] | number | boolean | null | undefined;
 }
 
-export { AuthType, City, ErrandStatus, PaginateResult, RoleType, State, User, UserAddress, errandTimeline };
+export { ActiveRider, AddressDetails, AddressTypes, AggragatedErrand, AuthType, City, DeliveryStatus, Errand, ErrandRating, ErrandStatus, ErrandTimeline, Invoice, InvoiceStatus, PaginateResult, ParcelSize, PaymentOptions, PendingErrand, Rider, RoleType, State, User, UserAddress, errandTimeline };

package/dist/index.js

@@ -20,8 +20,13 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var src_exports = {};
 __export(src_exports, {
+  AddressTypes: () => AddressTypes,
   AuthType: () => AuthType,
+  DeliveryStatus: () => DeliveryStatus,
   ErrandStatus: () => ErrandStatus,
+  InvoiceStatus: () => InvoiceStatus,
+  ParcelSize: () => ParcelSize,
+  PaymentOptions: () => PaymentOptions,
   RoleType: () => RoleType,
   errandTimeline: () => errandTimeline
 });
@@ -60,11 +65,6 @@ 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 */,
@@ -86,10 +86,48 @@ var errandTimeline = [
     description: "Your package has been delivered and the errand closed, please leave a review and a rating for the rider"
   }
 ];
+var AddressTypes = /* @__PURE__ */ ((AddressTypes2) => {
+  AddressTypes2["DeliveryAddress"] = "deliveryAddress";
+  AddressTypes2["PickupAddress"] = "pickupAddress";
+  return AddressTypes2;
+})(AddressTypes || {});
+var DeliveryStatus = /* @__PURE__ */ ((DeliveryStatus2) => {
+  DeliveryStatus2["Pending"] = "pending";
+  DeliveryStatus2["EnRoute"] = "en-route";
+  DeliveryStatus2["Delivered"] = "delivered";
+  DeliveryStatus2["Cancelled"] = "cancelled";
+  return DeliveryStatus2;
+})(DeliveryStatus || {});
+var ParcelSize = /* @__PURE__ */ ((ParcelSize2) => {
+  ParcelSize2["Bike"] = "bike";
+  ParcelSize2["Large"] = "large";
+  ParcelSize2["Medium"] = "medium";
+  ParcelSize2["Small"] = "small";
+  return ParcelSize2;
+})(ParcelSize || {});
+
+// src/invoice.ts
+var InvoiceStatus = /* @__PURE__ */ ((InvoiceStatus2) => {
+  InvoiceStatus2["Pending"] = "pending";
+  InvoiceStatus2["Paid"] = "paid";
+  InvoiceStatus2["Cancelled"] = "cancelled";
+  InvoiceStatus2["Failed"] = "failed";
+  return InvoiceStatus2;
+})(InvoiceStatus || {});
+var PaymentOptions = /* @__PURE__ */ ((PaymentOptions2) => {
+  PaymentOptions2["Cash"] = "cash";
+  PaymentOptions2["Card"] = "card";
+  return PaymentOptions2;
+})(PaymentOptions || {});
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  AddressTypes,
   AuthType,
+  DeliveryStatus,
   ErrandStatus,
+  InvoiceStatus,
+  ParcelSize,
+  PaymentOptions,
   RoleType,
   errandTimeline
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mydoormot/app-types",
-  "version": "1.0.2",
+  "version": "1.1.0",
   "description": "",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",

package/src/errand.ts

@@ -1,3 +1,6 @@
+import { Invoice, InvoiceStatus } from './invoice';
+import { User } from './user';
+
 export enum ErrandStatus {
   Pending = 'pending',
   RiderAssigned = 'rider-assigned',
@@ -17,13 +20,6 @@ export const errandTimeline = [
       'Your errand is pending, you would be notified as soon as it is started',
   },
 
-  {
-    status: ErrandStatus.RiderAssigned,
-    title: ErrandStatus.RiderAssigned,
-    description:
-      'Your errand has been assigned to a dispatch rider, you would be notified by the dispatch rider shortly',
-  },
-
   {
     status: ErrandStatus.Started,
     title: ErrandStatus.Started,
@@ -50,3 +46,212 @@ export const errandTimeline = [
       'Your package has been delivered and the errand closed, please leave a review and a rating for the rider',
   },
 ];
+
+export interface PendingErrand {
+  _id: string;
+  rider: string;
+  customerId: string;
+  parcelSize: ParcelSize;
+  deliveryStatus: ErrandStatus;
+  invoice: {
+    invoiceStatus: string;
+    refId: string;
+    transactionId: string;
+  };
+  nameOfItem: string;
+  pickupDetails: {
+    cityId: string;
+    address: string;
+    landmark: string;
+    fullName: string;
+    mobileNumber: string;
+  };
+  deliveryDetails: {
+    cityId: string;
+    address: string;
+    landmark: string;
+    fullName: string;
+    mobileNumber: string;
+  };
+  scheduleDate: string;
+
+  additionalData: string;
+  createdAt: string;
+  updatedAt: string;
+  version: number;
+  pickupLocation: {
+    cityId: string;
+    cityName: string;
+    cityCoords: number[];
+    stateId: string;
+    stateName: string;
+    stateCoords: number[];
+  };
+  deliveryLocation: {
+    cityId: string;
+    cityName: string;
+    cityCoords: number[];
+    stateId: string;
+    stateName: string;
+    stateCoords: number[];
+  };
+  errandTimeline: string;
+  id: string;
+}
+
+export interface Errand {
+  id: string;
+  rider: string | Rider;
+  customerId: string;
+  nameOfItem: string;
+  pickupDetails: AddressDetails;
+  deliveryDetails: AddressDetails;
+  parcelSize: `${ParcelSize}`;
+  deliveryStatus: ErrandStatus | `${ErrandStatus}`;
+  invoice: {
+    invoiceStatus: InvoiceStatus | `${InvoiceStatus}`;
+    refId: string;
+    authorizationUrl: string;
+    accessCode: string;
+    invoiceId?: string;
+  };
+  aliasId: string;
+  errandTimeline: string | ErrandTimeline;
+  updatedAt: Date;
+  createdAt: Date;
+
+  errandRating?: string;
+  payOnDeliveryAmount?: string;
+  additionalData?: string;
+  deliveryDate?: Date;
+}
+
+export interface AggragatedErrand extends Errand {
+  parcelSize: `${ParcelSize}`;
+  invoiceDetails: Invoice;
+  pickupLocation: {
+    cityId: string;
+    cityName: string;
+    cityCoords: number[];
+    stateId: string;
+    stateName: string;
+    stateCoords: number[];
+  };
+  deliveryLocation: {
+    cityId: string;
+    cityName: string;
+    cityCoords: number[];
+    stateId: string;
+    stateName: string;
+    stateCoords: number[];
+  };
+  riderUserDetails: User;
+  errandRatingDetails?: ErrandRating;
+}
+
+export interface ErrandTimeline {
+  id: string;
+  errandId: string;
+  timeline: {
+    status: ErrandStatus;
+    title: string;
+    description: string;
+    time?: string;
+    date?: Date;
+  }[];
+  currTimelineIndex: number;
+  updatedAt: Date;
+  createdAt: Date;
+}
+
+export interface ErrandRating {
+  createdAt: string;
+  errandId: string;
+  rating: number;
+  ratingText: string;
+  riderId: string;
+  updatedAt: string;
+  userId: string;
+  version: number;
+  _id: string;
+}
+
+export enum AddressTypes {
+  DeliveryAddress = 'deliveryAddress',
+  PickupAddress = 'pickupAddress',
+}
+
+export interface Rider {
+  id: string;
+  _id: string;
+  user: string | User;
+  city: string;
+  currLocation?: {
+    coordinates: number[];
+  };
+  active: boolean;
+  name?: string;
+}
+
+export interface ActiveRider {
+  _id: string;
+  user: string;
+  enterprise: string;
+  city: string;
+  verified: boolean;
+  currLocation: {
+    type: 'Point';
+    coordinates: [];
+  };
+  active: boolean;
+  vehicleNumber: string;
+  rating: number;
+  hasBeenRated: number;
+  createdAt: string;
+  updatedAt: string;
+  version: number;
+  numErrands: number;
+  available: boolean;
+  fullName: string;
+}
+
+export enum DeliveryStatus {
+  Pending = 'pending',
+  EnRoute = 'en-route',
+  Delivered = 'delivered',
+  Cancelled = 'cancelled',
+}
+
+export enum ParcelSize {
+  Bike = 'bike',
+  Large = 'large',
+  Medium = 'medium',
+  Small = 'small',
+}
+
+export interface ErrandTimeline {
+  id: string;
+  errandId: string;
+  timeline: {
+    status: ErrandStatus;
+    title: string;
+    description: string;
+    time?: string;
+    date?: Date;
+  }[];
+  currTimelineIndex: number;
+  updatedAt: Date;
+  createdAt: Date;
+}
+
+export type AddressDetails = {
+  cityId: string;
+  address: string;
+  fullName: string;
+  location: {
+    coordinates: number[];
+  };
+  mobileNumber?: string;
+  landmark?: string;
+  addressId?: string;
+};

package/src/index.ts

@@ -17,3 +17,4 @@ export interface PaginateResult<T> {
 export * from './user';
 export * from './errand';
 export * from './location';
+export * from './invoice';

package/src/invoice.ts

@@ -1,3 +1,5 @@
+import { EnterpriseType } from './enterprise';
+
 export enum InvoiceStatus {
   Pending = 'pending',
   Paid = 'paid',
@@ -9,3 +11,17 @@ export enum PaymentOptions {
   Cash = 'cash',
   Card = 'card',
 }
+
+export interface Invoice {
+  id: string;
+  user: string;
+  invoiceType: EnterpriseType | `${EnterpriseType}`;
+  amount: number;
+  paymentType: PaymentOptions | `${PaymentOptions}`;
+  status: InvoiceStatus | `${InvoiceStatus}`;
+  version: number;
+  referenceId?: string;
+  errandId?: string;
+  authorizationUrl?: string;
+  accessCode?: string;
+}