@mydoormot/app-types 1.1.3 → 1.1.5

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 4.42 KB
-CJS ⚡️ Build success in 92ms
+CJS dist/index.js 5.07 KB
+CJS ⚡️ Build success in 38ms
 DTS Build start
-DTS ⚡️ Build success in 1800ms
-DTS dist/index.d.ts 7.92 KB
-Done in 3.55s.
+DTS ⚡️ Build success in 1061ms
+DTS dist/index.d.ts 9.12 KB
+Done in 1.73s.

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @mydoormot/app-types
 
+## 1.1.5
+
+### Patch Changes
+
+- Modified app types
+
+## 1.1.4
+
+### Patch Changes
+
+- Added notification type
+
 ## 1.1.3
 
 ### Patch Changes

package/dist/index.d.ts

@@ -39,6 +39,9 @@ type User = {
     googleToken?: string;
     appleToken?: string;
     authType?: AuthType | `${AuthType}`;
+    passwordChangedAt?: string;
+    passwordResetToken?: string;
+    passwordResetExpires?: string;
 };
 type UserAddress = {
     user: string;
@@ -59,6 +62,27 @@ declare enum EnterpriseType {
     Property = "property",
     Store = "store"
 }
+type Enterprise = {
+    id: string;
+    user: string | User;
+    name: string;
+    city: string;
+    verified: boolean;
+    enterpriseType: EnterpriseType | `${EnterpriseType}`;
+    deleted: boolean;
+    updatedAt: Date;
+    createdAt: Date;
+    isActive: boolean;
+    version: number;
+    officeNumber?: string;
+    address?: {
+        coordinates?: number[];
+        address?: string;
+    };
+    image?: string;
+    coverImage?: string;
+    activationDate?: string;
+};
 
 declare enum InvoiceStatus {
     Pending = "pending",
@@ -84,6 +108,73 @@ interface Invoice {
     accessCode?: string;
 }
 
+type City = {
+    id: string;
+    state: string | State;
+    name: string;
+    slug: string;
+    location: {
+        coordinates: number[];
+    };
+    population: string;
+    populationProper: string;
+    updatedAt: Date;
+    createdAt: Date;
+    version: number;
+    isRiderActive: boolean;
+    isPropertyActive: boolean;
+    errandPrice?: number;
+};
+type State = {
+    id: string;
+    name: string;
+    slug: string;
+    location: {
+        coordinates: number[];
+    };
+    alias: string;
+    updatedAt: Date;
+    createdAt: Date;
+};
+type LatLng = `${number},${number}`;
+
+type Rider = {
+    id: string;
+    user: string | User;
+    city: string | City;
+    currLocation: {
+        coordinates: number[];
+    };
+    vehicle: string | Vehicle;
+    vehicleNumber: string;
+    verified: boolean;
+    active: boolean;
+    updatedAt: Date;
+    createdAt: Date;
+    rating: number;
+    version: number;
+    hasBeenRated: boolean;
+    enterprise: string | Enterprise;
+    isTracking: boolean;
+    state?: string | State;
+    currentErrand?: Errand;
+    lastDeliveredErrand?: Errand;
+};
+declare enum VehicleType {
+    Bike = "bike",
+    Shuttle = "shuttle"
+}
+type Vehicle = {
+    user: string;
+    vehicleNumber: string;
+    enterprise: string;
+    version: number;
+    createdAt: string;
+    updatedAt: string;
+    vehicleType: VehicleType | `${VehicleType}`;
+    rider?: string;
+};
+
 declare enum ErrandStatus {
     Pending = "pending",
     RiderAssigned = "rider-assigned",
@@ -152,7 +243,7 @@ interface PendingErrand {
 interface Errand {
     id: string;
     rider: string | Rider;
-    customerId: string;
+    customerId: string | User;
     nameOfItem: string;
     pickupDetails: AddressDetails;
     deliveryDetails: AddressDetails;
@@ -163,7 +254,7 @@ interface Errand {
         refId: string;
         authorizationUrl: string;
         accessCode: string;
-        invoiceId?: string;
+        invoiceId?: string | Invoice;
     };
     aliasId: string;
     errandTimeline: string | ErrandTimeline;
@@ -173,6 +264,7 @@ interface Errand {
     payOnDeliveryAmount?: string;
     additionalData?: string;
     deliveryDate?: Date;
+    city?: City;
 }
 interface AggragatedErrand extends Errand {
     parcelSize: `${ParcelSize}`;
@@ -211,47 +303,6 @@ declare enum AddressTypes {
     DeliveryAddress = "deliveryAddress",
     PickupAddress = "pickupAddress"
 }
-interface Rider {
-    id: string;
-    _id: string;
-    user: string | User;
-    city: string;
-    currLocation?: {
-        coordinates: number[];
-    };
-    name?: string;
-    vehicle: string;
-    vehicleNumber: string;
-    verified: boolean;
-    active: boolean;
-    updatedAt: Date;
-    createdAt: Date;
-    rating?: number;
-    hasBeenRated: boolean;
-    enterprise: string;
-    isTracking: boolean;
-}
-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",
@@ -304,35 +355,27 @@ type AddressDetails = {
     addressId?: string;
 };
 
-type City = {
+declare enum NotificationType {
+    Errand = "errand",
+    ErrandTimeline = "errand-timeline"
+}
+interface NotificationData {
+    notificationType: NotificationType;
     id: string;
-    state: string | State;
-    name: string;
-    slug: string;
-    location: {
-        coordinates: number[];
-    };
-    population: string;
-    populationProper: string;
-    updatedAt: Date;
-    createdAt: Date;
-    version: number;
-    isRiderActive: boolean;
-    isPropertyActive: boolean;
-    errandPrice?: number;
-};
-type State = {
+}
+type Notification = {
     id: string;
-    name: string;
-    slug: string;
-    location: {
-        coordinates: number[];
+    title: string;
+    user: string;
+    description: string;
+    isRead: boolean;
+    notificationData: {
+        notificationType: NotificationType | `${NotificationType}`;
+        id: string;
     };
-    alias: string;
-    updatedAt: Date;
-    createdAt: Date;
+    createdAt: string;
+    updatedAt: string;
 };
-type LatLng = `${number},${number}`;
 
 interface PaginateResult<T> {
     docs: T[];
@@ -349,5 +392,10 @@ interface PaginateResult<T> {
     meta?: any;
     [customLabel: string]: T[] | number | boolean | null | undefined;
 }
+declare enum LinkDestination {
+    Website = "web",
+    MainApp = "mydoormot:app",
+    RiderApp = "mydoormot:rider"
+}
 
-export { ActiveRider, AddressDetails, AddressTypes, AggragatedErrand, AuthType, City, DeliveryStatus, Errand, ErrandRating, ErrandStatus, ErrandTimeline, Invoice, InvoiceStatus, LatLng, PaginateResult, ParcelSize, PaymentOptions, PendingErrand, Rider, RoleType, State, User, UserAddress, errandTimeline };
+export { AddressDetails, AddressTypes, AggragatedErrand, AuthType, City, DeliveryStatus, Errand, ErrandRating, ErrandStatus, ErrandTimeline, Invoice, InvoiceStatus, LatLng, LinkDestination, Notification, NotificationData, NotificationType, PaginateResult, ParcelSize, PaymentOptions, PendingErrand, Rider, RoleType, State, User, UserAddress, Vehicle, errandTimeline };

package/dist/index.js

@@ -25,6 +25,8 @@ __export(src_exports, {
   DeliveryStatus: () => DeliveryStatus,
   ErrandStatus: () => ErrandStatus,
   InvoiceStatus: () => InvoiceStatus,
+  LinkDestination: () => LinkDestination,
+  NotificationType: () => NotificationType,
   ParcelSize: () => ParcelSize,
   PaymentOptions: () => PaymentOptions,
   RoleType: () => RoleType,
@@ -59,6 +61,7 @@ var ErrandStatus = /* @__PURE__ */ ((ErrandStatus2) => {
   ErrandStatus2["Cancelled"] = "cancelled";
   return ErrandStatus2;
 })(ErrandStatus || {});
+console.log("hello");
 var errandTimeline = [
   {
     status: "pending" /* Pending */,
@@ -119,6 +122,21 @@ var PaymentOptions = /* @__PURE__ */ ((PaymentOptions2) => {
   PaymentOptions2["Card"] = "card";
   return PaymentOptions2;
 })(PaymentOptions || {});
+
+// src/notification.ts
+var NotificationType = /* @__PURE__ */ ((NotificationType2) => {
+  NotificationType2["Errand"] = "errand";
+  NotificationType2["ErrandTimeline"] = "errand-timeline";
+  return NotificationType2;
+})(NotificationType || {});
+
+// src/index.ts
+var LinkDestination = /* @__PURE__ */ ((LinkDestination2) => {
+  LinkDestination2["Website"] = "web";
+  LinkDestination2["MainApp"] = "mydoormot:app";
+  LinkDestination2["RiderApp"] = "mydoormot:rider";
+  return LinkDestination2;
+})(LinkDestination || {});
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   AddressTypes,
@@ -126,6 +144,8 @@ var PaymentOptions = /* @__PURE__ */ ((PaymentOptions2) => {
   DeliveryStatus,
   ErrandStatus,
   InvoiceStatus,
+  LinkDestination,
+  NotificationType,
   ParcelSize,
   PaymentOptions,
   RoleType,

package/package.json

@@ -1,9 +1,10 @@
 {
   "name": "@mydoormot/app-types",
-  "version": "1.1.3",
+  "version": "1.1.5",
   "description": "",
-  "main": "./dist/index.js",
-  "types": "./dist/index.d.ts",
+  "mains": "./dist/index.js",
+  "typess": "./dist/index.d.ts",
+  "main": "./src/index.ts",
   "scripts": {
     "clean": "del ./build/*",
     "build": "tsup src/index.ts --format cjs --dts"

package/src/enterprise.ts

@@ -1,4 +1,4 @@
-// NOTE: Modify Enterprise Types
+import { User } from './user';
 
 export enum EnterpriseType {
   Restaurant = 'restaurant',
@@ -6,3 +6,25 @@ export enum EnterpriseType {
   Property = 'property',
   Store = 'store',
 }
+
+export type Enterprise = {
+  id: string;
+  user: string | User;
+  name: string;
+  city: string;
+  verified: boolean;
+  enterpriseType: EnterpriseType | `${EnterpriseType}`;
+  deleted: boolean;
+  updatedAt: Date;
+  createdAt: Date;
+  isActive: boolean;
+  version: number;
+  officeNumber?: string;
+  address?: {
+    coordinates?: number[];
+    address?: string;
+  };
+  image?: string;
+  coverImage?: string;
+  activationDate?: string;
+};

package/src/errand.ts

@@ -1,4 +1,6 @@
 import { Invoice, InvoiceStatus } from './invoice';
+import { City } from './location';
+import { Rider } from './rider';
 import { User } from './user';
 
 export enum ErrandStatus {
@@ -12,6 +14,7 @@ export enum ErrandStatus {
   Cancelled = 'cancelled',
 }
 
+console.log('hello');
 export const errandTimeline = [
   {
     status: ErrandStatus.Pending,
@@ -102,7 +105,7 @@ export interface PendingErrand {
 export interface Errand {
   id: string;
   rider: string | Rider;
-  customerId: string;
+  customerId: string | User;
   nameOfItem: string;
   pickupDetails: AddressDetails;
   deliveryDetails: AddressDetails;
@@ -113,17 +116,17 @@ export interface Errand {
     refId: string;
     authorizationUrl: string;
     accessCode: string;
-    invoiceId?: string;
+    invoiceId?: string | Invoice;
   };
   aliasId: string;
   errandTimeline: string | ErrandTimeline;
   updatedAt: Date;
   createdAt: Date;
-
   errandRating?: string;
   payOnDeliveryAmount?: string;
   additionalData?: string;
   deliveryDate?: Date;
+  city?: City;
 }
 
 export interface AggragatedErrand extends Errand {
@@ -181,49 +184,6 @@ export enum AddressTypes {
   PickupAddress = 'pickupAddress',
 }
 
-export interface Rider {
-  id: string;
-  _id: string;
-  user: string | User;
-  city: string;
-  currLocation?: {
-    coordinates: number[];
-  };
-  name?: string;
-  vehicle: string;
-  vehicleNumber: string;
-  verified: boolean;
-  active: boolean;
-  updatedAt: Date;
-  createdAt: Date;
-  rating?: number;
-  hasBeenRated: boolean; // NOTE: This tells app if the rider has an existing rating
-  enterprise: string;
-  isTracking: boolean;
-}
-
-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',

package/src/index.ts

@@ -14,7 +14,15 @@ export interface PaginateResult<T> {
   [customLabel: string]: T[] | number | boolean | null | undefined;
 }
 
+export enum LinkDestination {
+  Website = 'web',
+  MainApp = 'mydoormot:app',
+  RiderApp = 'mydoormot:rider',
+}
+
 export * from './user';
 export * from './errand';
 export * from './location';
 export * from './invoice';
+export * from './notification';
+export * from './rider';

package/src/notification.ts

@@ -7,3 +7,18 @@ export interface NotificationData {
   notificationType: NotificationType;
   id: string;
 }
+
+export type Notification = {
+  id: string;
+
+  title: string;
+  user: string;
+  description: string;
+  isRead: boolean;
+  notificationData: {
+    notificationType: NotificationType | `${NotificationType}`;
+    id: string;
+  };
+  createdAt: string;
+  updatedAt: string;
+};

package/src/rider.ts

@@ -0,0 +1,44 @@
+import { Enterprise } from './enterprise';
+import { Errand } from './errand';
+import { City, State } from './location';
+import { User } from './user';
+
+export type Rider = {
+  id: string;
+  user: string | User;
+  city: string | City;
+  currLocation: {
+    coordinates: number[];
+  };
+  vehicle: string | Vehicle;
+  vehicleNumber: string;
+  verified: boolean;
+  active: boolean;
+  updatedAt: Date;
+  createdAt: Date;
+  rating: number;
+  version: number;
+  hasBeenRated: boolean;
+  enterprise: string | Enterprise;
+  isTracking: boolean;
+
+  state?: string | State;
+  currentErrand?: Errand;
+  lastDeliveredErrand?: Errand;
+};
+
+enum VehicleType {
+  Bike = 'bike',
+  Shuttle = 'shuttle',
+}
+
+export type Vehicle = {
+  user: string;
+  vehicleNumber: string;
+  enterprise: string;
+  version: number;
+  createdAt: string;
+  updatedAt: string;
+  vehicleType: VehicleType | `${VehicleType}`;
+  rider?: string;
+};

package/src/user.ts

@@ -41,6 +41,9 @@ export type User = {
   googleToken?: string;
   appleToken?: string;
   authType?: AuthType | `${AuthType}`;
+  passwordChangedAt?: string;
+  passwordResetToken?: string;
+  passwordResetExpires?: string;
 };
 
 export type UserAddress = {