@mydoormot/app-types 1.7.14 → 1.7.16

package/.turbo/turbo-build.log

@@ -1,5 +1,5 @@
 
-> @mydoormot/app-types@1.7.13 build /Users/chuksben/Desktop/projects/microservices/mydoormot/packages/app-types
+> @mydoormot/app-types@1.7.15 build /Users/chuksben/Desktop/projects/microservices/mydoormot/packages/app-types
 > tsup src/index.ts --format esm,cjs --dts
 
 CLI Building entry: src/index.ts
@@ -8,11 +8,11 @@
 CLI Target: es2021
 ESM Build start
 CJS Build start
-ESM dist/index.js 6.17 KB
-ESM ⚡️ Build success in 71ms
 CJS dist/index.cjs 7.84 KB
-CJS ⚡️ Build success in 70ms
+CJS ⚡️ Build success in 61ms
+ESM dist/index.js 6.17 KB
+ESM ⚡️ Build success in 61ms
 DTS Build start
-DTS ⚡️ Build success in 1097ms
-DTS dist/index.d.ts  17.80 KB
-DTS dist/index.d.cts 17.80 KB
+DTS ⚡️ Build success in 686ms
+DTS dist/index.d.ts  17.71 KB
+DTS dist/index.d.cts 17.71 KB

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @mydoormot/app-types
 
+## 1.7.16
+
+### Patch Changes
+
+- Modified invoice stypes
+
+## 1.7.15
+
+### Patch Changes
+
+- 4cf55ae: Modified transactions test
+
 ## 1.7.14
 
 ### Patch Changes

package/dist/index.d.cts

@@ -107,59 +107,26 @@ interface Coupon {
     fullName?: string;
 }
 
-declare enum EnterpriseType {
-    Restaurant = "restaurant",
-    Dispatch = "dispatch",
-    Property = "property",
-    Store = "store"
-}
-type Enterprise = {
-    id: string;
-    user: string | User;
-    name: string;
-    city: string;
-    verified: boolean;
-    mobileNumber?: string;
-    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;
-    category: EnterpriseCategoryDoc[] | string[];
-    subCategory: EnterpriseSubCategoryDoc[] | string[];
-    socialLinks: {
-        name: string;
-        url: string;
-        active: boolean;
-    }[];
-};
-interface EnterpriseCategoryDoc {
-    id: string;
-    name: string;
-    slug: string;
-    subCategories: EnterpriseSubCategoryDoc[];
+interface CustomerTransactionStats {
+    totalSaleCount: number;
+    totalSaleAmount: number;
+    totalExpenseCount: number;
+    totalExpenseAmount: number;
+    lastTransactionDate: string | null;
     updatedAt: string;
-    createdAt: string;
-    image?: string;
 }
-interface EnterpriseSubCategoryDoc {
+interface Customer {
     id: string;
-    name: string;
-    category: string;
-    slug: string;
-    image?: string;
-    serviceItems: string[];
-    updatedAt: string;
+    businessId: string;
+    phoneNumber: string;
+    fullName: string;
+    cityId: string;
+    address: string;
+    landmark?: string;
     createdAt: string;
+    updatedAt: string;
+    customerBusinessId?: string;
+    transactionStats?: CustomerTransactionStats;
 }
 
 declare enum InvoiceStatus {
@@ -183,26 +150,20 @@ declare enum PaymentOptions {
 }
 interface Invoice {
     id: string;
-    user: string;
-    invoiceType: EnterpriseType | `${EnterpriseType}`;
-    amount: number;
-    paymentType: PaymentOptions | `${PaymentOptions}`;
+    businessId: string;
+    userId: string;
+    invoiceNumber: string;
+    startDate: string;
+    endDate: string;
+    totalAmount: number;
+    paidAmount: number;
+    unpaidAmount: number;
     status: InvoiceStatus | `${InvoiceStatus}`;
-    version: number;
-    referenceId?: string;
-    errandId?: string;
-    authorizationUrl?: string;
-    accessCode?: string;
-    generationType?: InvoiceGenerationType | `${InvoiceGenerationType}`;
-    startDate?: string;
-    endDate?: string;
-    dueDate?: string;
-    invoiceNumber?: string;
-    isErrandsPaid?: boolean;
+    customerId: string;
     items: InvoiceItem[];
-    businessId?: string;
     createdAt: string;
     updatedAt: string;
+    customerDetails?: Customer;
 }
 interface InvoiceItem {
     id: string;
@@ -274,6 +235,7 @@ type VehicleLog = {
     errandIdsSinceLastRefuel?: string[];
     maintenanceType?: string;
     maintenanceCost?: number;
+    vehicleDetails?: Vehicle;
 };
 type VehicleLogWithErrands = VehicleLog & {
     errandsCount?: number;
@@ -359,13 +321,7 @@ interface Errand {
     parcelSize: `${ParcelSize}`;
     deliveryStatus: ErrandStatus | `${ErrandStatus}`;
     paymentStatus: `${InvoiceStatus}`;
-    invoice: {
-        invoiceStatus: InvoiceStatus | `${InvoiceStatus}`;
-        refId: string;
-        authorizationUrl: string;
-        accessCode: string;
-        invoiceId?: string | Invoice;
-    };
+    invoiceId?: string;
     aliasId: string;
     updatedAt: Date;
     createdAt: Date;
@@ -537,6 +493,61 @@ type Notification = {
     updatedAt: string;
 };
 
+declare enum EnterpriseType {
+    Restaurant = "restaurant",
+    Dispatch = "dispatch",
+    Property = "property",
+    Store = "store"
+}
+type Enterprise = {
+    id: string;
+    user: string | User;
+    name: string;
+    city: string;
+    verified: boolean;
+    mobileNumber?: string;
+    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;
+    category: EnterpriseCategoryDoc[] | string[];
+    subCategory: EnterpriseSubCategoryDoc[] | string[];
+    socialLinks: {
+        name: string;
+        url: string;
+        active: boolean;
+    }[];
+};
+interface EnterpriseCategoryDoc {
+    id: string;
+    name: string;
+    slug: string;
+    subCategories: EnterpriseSubCategoryDoc[];
+    updatedAt: string;
+    createdAt: string;
+    image?: string;
+}
+interface EnterpriseSubCategoryDoc {
+    id: string;
+    name: string;
+    category: string;
+    slug: string;
+    image?: string;
+    serviceItems: string[];
+    updatedAt: string;
+    createdAt: string;
+}
+
 interface Business {
     id: string;
     userId: string;
@@ -612,19 +623,6 @@ interface BusinessMember {
     updatedAt: string | NullOrUndefined;
 }
 
-interface Customer {
-    id: string;
-    businessId: string;
-    phoneNumber: string;
-    fullName: string;
-    cityId: string;
-    address: string;
-    landmark?: string;
-    createdAt: string;
-    updatedAt: string;
-    customerBusinessId?: string;
-}
-
 type TransactionType = 'sale' | 'expense';
 interface TransactionItem {
     name: string;
@@ -710,4 +708,4 @@ declare enum LinkDestination {
 }
 type NullOrUndefined = null | undefined;
 
-export { type AddressDetails, AddressTypes, type AggregatedErrand, AuthType, type Business, type BusinessCategory, type BusinessMember, type BusinessPg, BusinessRole, type City, type Coupon, type Customer, DeliveryStatus, type Enterprise, type EnterpriseCategoryDoc, type EnterpriseSubCategoryDoc, EnterpriseType, type Errand, type ErrandDeliveryTiming, type ErrandPackagingQuality, type ErrandRating, type ErrandReview, type ErrandReviewLink, type ErrandRiderBehavior, ErrandStatus, type ErrandTimeline, GlobalRoles, type Invoice, InvoiceGenerationType, type InvoiceItem, InvoiceItemType, InvoiceStatus, type LatLng, LinkDestination, MembershipStatus, type Notification, type NotificationData, NotificationType, type NullOrUndefined, type PaginateResult, ParcelSize, PaymentOptions, type PendingErrand, type Rider, RoleType, type State, type Transaction, type TransactionCategory, type TransactionItem, type TransactionType, type TransactionWithCategory, type TransactionWithJoin, type User, type UserAddress, type Vehicle, type VehicleLog, type VehicleLogStatsSummary, VehicleLogType, type VehicleLogWithErrands, VehicleType, type VehicleWithRider, type Vendor, errandTimeline };
+export { type AddressDetails, AddressTypes, type AggregatedErrand, AuthType, type Business, type BusinessCategory, type BusinessMember, type BusinessPg, BusinessRole, type City, type Coupon, type Customer, type CustomerTransactionStats, DeliveryStatus, type Enterprise, type EnterpriseCategoryDoc, type EnterpriseSubCategoryDoc, EnterpriseType, type Errand, type ErrandDeliveryTiming, type ErrandPackagingQuality, type ErrandRating, type ErrandReview, type ErrandReviewLink, type ErrandRiderBehavior, ErrandStatus, type ErrandTimeline, GlobalRoles, type Invoice, InvoiceGenerationType, type InvoiceItem, InvoiceItemType, InvoiceStatus, type LatLng, LinkDestination, MembershipStatus, type Notification, type NotificationData, NotificationType, type NullOrUndefined, type PaginateResult, ParcelSize, PaymentOptions, type PendingErrand, type Rider, RoleType, type State, type Transaction, type TransactionCategory, type TransactionItem, type TransactionType, type TransactionWithCategory, type TransactionWithJoin, type User, type UserAddress, type Vehicle, type VehicleLog, type VehicleLogStatsSummary, VehicleLogType, type VehicleLogWithErrands, VehicleType, type VehicleWithRider, type Vendor, errandTimeline };

package/dist/index.d.ts

@@ -107,59 +107,26 @@ interface Coupon {
     fullName?: string;
 }
 
-declare enum EnterpriseType {
-    Restaurant = "restaurant",
-    Dispatch = "dispatch",
-    Property = "property",
-    Store = "store"
-}
-type Enterprise = {
-    id: string;
-    user: string | User;
-    name: string;
-    city: string;
-    verified: boolean;
-    mobileNumber?: string;
-    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;
-    category: EnterpriseCategoryDoc[] | string[];
-    subCategory: EnterpriseSubCategoryDoc[] | string[];
-    socialLinks: {
-        name: string;
-        url: string;
-        active: boolean;
-    }[];
-};
-interface EnterpriseCategoryDoc {
-    id: string;
-    name: string;
-    slug: string;
-    subCategories: EnterpriseSubCategoryDoc[];
+interface CustomerTransactionStats {
+    totalSaleCount: number;
+    totalSaleAmount: number;
+    totalExpenseCount: number;
+    totalExpenseAmount: number;
+    lastTransactionDate: string | null;
     updatedAt: string;
-    createdAt: string;
-    image?: string;
 }
-interface EnterpriseSubCategoryDoc {
+interface Customer {
     id: string;
-    name: string;
-    category: string;
-    slug: string;
-    image?: string;
-    serviceItems: string[];
-    updatedAt: string;
+    businessId: string;
+    phoneNumber: string;
+    fullName: string;
+    cityId: string;
+    address: string;
+    landmark?: string;
     createdAt: string;
+    updatedAt: string;
+    customerBusinessId?: string;
+    transactionStats?: CustomerTransactionStats;
 }
 
 declare enum InvoiceStatus {
@@ -183,26 +150,20 @@ declare enum PaymentOptions {
 }
 interface Invoice {
     id: string;
-    user: string;
-    invoiceType: EnterpriseType | `${EnterpriseType}`;
-    amount: number;
-    paymentType: PaymentOptions | `${PaymentOptions}`;
+    businessId: string;
+    userId: string;
+    invoiceNumber: string;
+    startDate: string;
+    endDate: string;
+    totalAmount: number;
+    paidAmount: number;
+    unpaidAmount: number;
     status: InvoiceStatus | `${InvoiceStatus}`;
-    version: number;
-    referenceId?: string;
-    errandId?: string;
-    authorizationUrl?: string;
-    accessCode?: string;
-    generationType?: InvoiceGenerationType | `${InvoiceGenerationType}`;
-    startDate?: string;
-    endDate?: string;
-    dueDate?: string;
-    invoiceNumber?: string;
-    isErrandsPaid?: boolean;
+    customerId: string;
     items: InvoiceItem[];
-    businessId?: string;
     createdAt: string;
     updatedAt: string;
+    customerDetails?: Customer;
 }
 interface InvoiceItem {
     id: string;
@@ -274,6 +235,7 @@ type VehicleLog = {
     errandIdsSinceLastRefuel?: string[];
     maintenanceType?: string;
     maintenanceCost?: number;
+    vehicleDetails?: Vehicle;
 };
 type VehicleLogWithErrands = VehicleLog & {
     errandsCount?: number;
@@ -359,13 +321,7 @@ interface Errand {
     parcelSize: `${ParcelSize}`;
     deliveryStatus: ErrandStatus | `${ErrandStatus}`;
     paymentStatus: `${InvoiceStatus}`;
-    invoice: {
-        invoiceStatus: InvoiceStatus | `${InvoiceStatus}`;
-        refId: string;
-        authorizationUrl: string;
-        accessCode: string;
-        invoiceId?: string | Invoice;
-    };
+    invoiceId?: string;
     aliasId: string;
     updatedAt: Date;
     createdAt: Date;
@@ -537,6 +493,61 @@ type Notification = {
     updatedAt: string;
 };
 
+declare enum EnterpriseType {
+    Restaurant = "restaurant",
+    Dispatch = "dispatch",
+    Property = "property",
+    Store = "store"
+}
+type Enterprise = {
+    id: string;
+    user: string | User;
+    name: string;
+    city: string;
+    verified: boolean;
+    mobileNumber?: string;
+    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;
+    category: EnterpriseCategoryDoc[] | string[];
+    subCategory: EnterpriseSubCategoryDoc[] | string[];
+    socialLinks: {
+        name: string;
+        url: string;
+        active: boolean;
+    }[];
+};
+interface EnterpriseCategoryDoc {
+    id: string;
+    name: string;
+    slug: string;
+    subCategories: EnterpriseSubCategoryDoc[];
+    updatedAt: string;
+    createdAt: string;
+    image?: string;
+}
+interface EnterpriseSubCategoryDoc {
+    id: string;
+    name: string;
+    category: string;
+    slug: string;
+    image?: string;
+    serviceItems: string[];
+    updatedAt: string;
+    createdAt: string;
+}
+
 interface Business {
     id: string;
     userId: string;
@@ -612,19 +623,6 @@ interface BusinessMember {
     updatedAt: string | NullOrUndefined;
 }
 
-interface Customer {
-    id: string;
-    businessId: string;
-    phoneNumber: string;
-    fullName: string;
-    cityId: string;
-    address: string;
-    landmark?: string;
-    createdAt: string;
-    updatedAt: string;
-    customerBusinessId?: string;
-}
-
 type TransactionType = 'sale' | 'expense';
 interface TransactionItem {
     name: string;
@@ -710,4 +708,4 @@ declare enum LinkDestination {
 }
 type NullOrUndefined = null | undefined;
 
-export { type AddressDetails, AddressTypes, type AggregatedErrand, AuthType, type Business, type BusinessCategory, type BusinessMember, type BusinessPg, BusinessRole, type City, type Coupon, type Customer, DeliveryStatus, type Enterprise, type EnterpriseCategoryDoc, type EnterpriseSubCategoryDoc, EnterpriseType, type Errand, type ErrandDeliveryTiming, type ErrandPackagingQuality, type ErrandRating, type ErrandReview, type ErrandReviewLink, type ErrandRiderBehavior, ErrandStatus, type ErrandTimeline, GlobalRoles, type Invoice, InvoiceGenerationType, type InvoiceItem, InvoiceItemType, InvoiceStatus, type LatLng, LinkDestination, MembershipStatus, type Notification, type NotificationData, NotificationType, type NullOrUndefined, type PaginateResult, ParcelSize, PaymentOptions, type PendingErrand, type Rider, RoleType, type State, type Transaction, type TransactionCategory, type TransactionItem, type TransactionType, type TransactionWithCategory, type TransactionWithJoin, type User, type UserAddress, type Vehicle, type VehicleLog, type VehicleLogStatsSummary, VehicleLogType, type VehicleLogWithErrands, VehicleType, type VehicleWithRider, type Vendor, errandTimeline };
+export { type AddressDetails, AddressTypes, type AggregatedErrand, AuthType, type Business, type BusinessCategory, type BusinessMember, type BusinessPg, BusinessRole, type City, type Coupon, type Customer, type CustomerTransactionStats, DeliveryStatus, type Enterprise, type EnterpriseCategoryDoc, type EnterpriseSubCategoryDoc, EnterpriseType, type Errand, type ErrandDeliveryTiming, type ErrandPackagingQuality, type ErrandRating, type ErrandReview, type ErrandReviewLink, type ErrandRiderBehavior, ErrandStatus, type ErrandTimeline, GlobalRoles, type Invoice, InvoiceGenerationType, type InvoiceItem, InvoiceItemType, InvoiceStatus, type LatLng, LinkDestination, MembershipStatus, type Notification, type NotificationData, NotificationType, type NullOrUndefined, type PaginateResult, ParcelSize, PaymentOptions, type PendingErrand, type Rider, RoleType, type State, type Transaction, type TransactionCategory, type TransactionItem, type TransactionType, type TransactionWithCategory, type TransactionWithJoin, type User, type UserAddress, type Vehicle, type VehicleLog, type VehicleLogStatsSummary, VehicleLogType, type VehicleLogWithErrands, VehicleType, type VehicleWithRider, type Vendor, errandTimeline };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mydoormot/app-types",
-  "version": "1.7.14",
+  "version": "1.7.16",
   "description": "",
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",

package/src/customer.ts

@@ -1,5 +1,14 @@
 // import { Business, City, State } from '.';
 
+export interface CustomerTransactionStats {
+  totalSaleCount: number;
+  totalSaleAmount: number;
+  totalExpenseCount: number;
+  totalExpenseAmount: number;
+  lastTransactionDate: string | null;
+  updatedAt: string;
+}
+
 export interface Customer {
   id: string;
   businessId: string;
@@ -13,6 +22,8 @@ export interface Customer {
 
   customerBusinessId?: string;
 
+  transactionStats?: CustomerTransactionStats;
+
   // From aggregation
   // errandsCount?: number;
   // city?: City;

package/src/errand.ts

@@ -129,13 +129,15 @@ export interface Errand {
   parcelSize: `${ParcelSize}`;
   deliveryStatus: ErrandStatus | `${ErrandStatus}`;
   paymentStatus: `${InvoiceStatus}`;
-  invoice: {
-    invoiceStatus: InvoiceStatus | `${InvoiceStatus}`;
-    refId: string;
-    authorizationUrl: string;
-    accessCode: string;
-    invoiceId?: string | Invoice;
-  };
+  invoiceId?: string;
+
+  // invoice: {
+  //   invoiceStatus: InvoiceStatus | `${InvoiceStatus}`;
+  //   refId: string;
+  //   authorizationUrl: string;
+  //   accessCode: string;
+  //   invoiceId?: string | Invoice;
+  // };
   aliasId: string;
   updatedAt: Date;
   createdAt: Date;

package/src/invoice.ts

@@ -1,4 +1,4 @@
-import { EnterpriseType } from './enterprise';
+import { Customer } from './customer';
 import { Errand } from './errand';
 
 export enum InvoiceStatus {
@@ -27,26 +27,21 @@ export enum PaymentOptions {
 
 export interface Invoice {
   id: string;
-  user: string;
-  invoiceType: EnterpriseType | `${EnterpriseType}`;
-  amount: number;
-  paymentType: PaymentOptions | `${PaymentOptions}`;
+  businessId: string;
+  userId: string;
+  invoiceNumber: string;
+  startDate: string;
+  endDate: string;
+  totalAmount: number;
+  paidAmount: number;
+  unpaidAmount: number;
   status: InvoiceStatus | `${InvoiceStatus}`;
-  version: number;
-  referenceId?: string;
-  errandId?: string;
-  authorizationUrl?: string;
-  accessCode?: string;
-  generationType?: InvoiceGenerationType | `${InvoiceGenerationType}`;
-  startDate?: string;
-  endDate?: string;
-  dueDate?: string;
-  invoiceNumber?: string;
-  isErrandsPaid?: boolean;
+  customerId: string;
   items: InvoiceItem[];
-  businessId?: string;
   createdAt: string;
   updatedAt: string;
+
+  customerDetails?: Customer;
 }
 
 export interface InvoiceItem {

package/src/rider.ts

@@ -72,6 +72,7 @@ export type VehicleLog = {
   errandIdsSinceLastRefuel?: string[];
   maintenanceType?: string;
   maintenanceCost?: number;
+  vehicleDetails?: Vehicle;
 };
 
 export type VehicleLogWithErrands = VehicleLog & {