@floristcloud/api-lib 1.2.63 → 1.2.65

package/build/commands/delivery-route/get-delivery-route-invoices.query.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GetDeliveryRouteInvoicesContractQuery = void 0;
+const zod_1 = require("zod");
+const DeliveryRouteInvoiceFileSchema = zod_1.z.object({
+    file_key: zod_1.z.string(),
+    name: zod_1.z.string(),
+});
+const GetDeliveryRouteInvoicesResponseSchema = zod_1.z.object({
+    message: zod_1.z.string().optional(),
+    data: zod_1.z
+        .object({
+        files: zod_1.z.array(DeliveryRouteInvoiceFileSchema),
+    })
+        .nullable(),
+});
+var GetDeliveryRouteInvoicesContractQuery;
+(function (GetDeliveryRouteInvoicesContractQuery) {
+    GetDeliveryRouteInvoicesContractQuery.ResponseSchema = GetDeliveryRouteInvoicesResponseSchema;
+})(GetDeliveryRouteInvoicesContractQuery || (exports.GetDeliveryRouteInvoicesContractQuery = GetDeliveryRouteInvoicesContractQuery = {}));

package/build/commands/delivery-route/index.js

@@ -19,5 +19,6 @@ __exportStar(require("./update-delivery-route.command"), exports);
 __exportStar(require("./delete-delivery-route.command"), exports);
 __exportStar(require("./get-delivery-route-list.query"), exports);
 __exportStar(require("./get-delivery-route.query"), exports);
+__exportStar(require("./get-delivery-route-invoices.query"), exports);
 __exportStar(require("./attach-order-list-to-delivery-route.command"), exports);
 __exportStar(require("./detach-order-list-to-delivery-route.command"), exports);

package/build/commands/report/get-sales-summary.query.js

@@ -0,0 +1,54 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GetSalesSummaryContractQuery = void 0;
+const zod_1 = require("zod");
+const date_helper_1 = require("../../helpers/date.helper");
+const report_period_type_enum_1 = require("../../enum/report-period-type.enum");
+const GetSalesSummaryRequestSchema = zod_1.z
+    .object({
+    startDate: zod_1.z.coerce.date().optional(),
+    endDate: zod_1.z.coerce.date().optional(),
+    periodType: zod_1.z.nativeEnum(report_period_type_enum_1.ReportPeriodTypeEnum).default(report_period_type_enum_1.ReportPeriodTypeEnum.DAY),
+})
+    .refine(value => {
+    const { startDate, endDate } = value;
+    if (startDate && endDate) {
+        return (0, date_helper_1.dateRangeCheck)(startDate, endDate);
+    }
+    return true;
+}, {
+    message: 'End date must be greater than start date',
+    path: ['endDate', 'startDate'],
+});
+const SalesSummaryTotalsSchema = zod_1.z.object({
+    totalRevenue: zod_1.z.number(),
+    totalRevenueWithDelivery: zod_1.z.number(),
+    totalOrders: zod_1.z.number(),
+    uniqueClients: zod_1.z.number(),
+    soldUnits: zod_1.z.number(),
+    avgCheck: zod_1.z.number(),
+    totalVatAmount: zod_1.z.number(),
+    totalCost: zod_1.z.number(),
+    totalDeliveryCost: zod_1.z.number(),
+    totalDiscountAmount: zod_1.z.number(),
+    grossProfit: zod_1.z.number(),
+    marginality: zod_1.z.number(),
+});
+const SalesSummarySeriesItemSchema = zod_1.z.object({
+    period: zod_1.z.string(),
+    revenue: zod_1.z.number(),
+    orders: zod_1.z.number(),
+    units: zod_1.z.number(),
+    avgCheck: zod_1.z.number(),
+});
+const GetSalesSummaryResponseSchema = zod_1.z.object({
+    data: zod_1.z.object({
+        totals: SalesSummaryTotalsSchema,
+        series: zod_1.z.array(SalesSummarySeriesItemSchema),
+    }),
+});
+var GetSalesSummaryContractQuery;
+(function (GetSalesSummaryContractQuery) {
+    GetSalesSummaryContractQuery.RequestSchema = GetSalesSummaryRequestSchema;
+    GetSalesSummaryContractQuery.ResponseSchema = GetSalesSummaryResponseSchema;
+})(GetSalesSummaryContractQuery || (exports.GetSalesSummaryContractQuery = GetSalesSummaryContractQuery = {}));

package/build/commands/report/index.js

@@ -18,6 +18,7 @@ __exportStar(require("./get-report-for-period.query"), exports);
 __exportStar(require("./get-report-group-by-client.query"), exports);
 __exportStar(require("./get-report-group-by-position.query"), exports);
 __exportStar(require("./export-sales-revenue.query"), exports);
+__exportStar(require("./get-sales-summary.query"), exports);
 __exportStar(require("./export-sales-by-client.query"), exports);
 __exportStar(require("./export-sales-by-position.query"), exports);
 __exportStar(require("./export-inventory-stock.query"), exports);

package/build/constant/error.js

@@ -960,6 +960,12 @@ exports.ERRORS = {
     DELIVERY_ROUTE_NOT_DELETED: { code: 'DLR003', message: 'Failed to delete delivery route', httpCode: 500 },
     DELIVERY_ROUTE_NOT_UPDATED: { code: 'DLR004', message: 'Failed to update delivery route', httpCode: 500 },
     DELIVERY_ROUTE_FETCH_FAILED: { code: 'DLR005', message: 'Error when retrieving delivery routes', httpCode: 500 },
+    DELIVERY_ROUTE_TOO_MANY_ORDERS: { code: 'DLR006', message: 'Too many orders in the delivery route to export invoices', httpCode: 400 },
+    DELIVERY_ROUTE_INVOICE_EXPORT_IN_PROGRESS: {
+        code: 'DLR007',
+        message: 'Invoice export for this company is already in progress',
+        httpCode: 409,
+    },
     FAILED_TO_CREATE: {
         code: 'FAILED_TO_CREATE',
         message: 'Failed to create entity',

package/build/helpers/date.helper.js

@@ -1,8 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.setEndDay = exports.setStartDay = exports.isStatementPeriodWithinLimit = exports.STATEMENT_MAX_PERIOD_DAYS = exports.dateRangeCheck = void 0;
+// Allows a single-day range (startDate === endDate); callers expand bounds to start/end-of-day downstream.
 const dateRangeCheck = (startDate, endDate) => {
-    return endDate > startDate;
+    return endDate >= startDate;
 };
 exports.dateRangeCheck = dateRangeCheck;
 // 1 year + 1 day to tolerate leap years.

package/commands/delivery-route/get-delivery-route-invoices.query.ts

@@ -0,0 +1,20 @@
+import { z } from 'zod';
+
+const DeliveryRouteInvoiceFileSchema = z.object({
+    file_key: z.string(),
+    name: z.string(),
+});
+
+const GetDeliveryRouteInvoicesResponseSchema = z.object({
+    message: z.string().optional(),
+    data: z
+        .object({
+            files: z.array(DeliveryRouteInvoiceFileSchema),
+        })
+        .nullable(),
+});
+
+export namespace GetDeliveryRouteInvoicesContractQuery {
+    export const ResponseSchema = GetDeliveryRouteInvoicesResponseSchema;
+    export type Response = z.infer<typeof ResponseSchema>;
+}

package/commands/delivery-route/index.ts

@@ -3,5 +3,6 @@ export * from './update-delivery-route.command';
 export * from './delete-delivery-route.command';
 export * from './get-delivery-route-list.query';
 export * from './get-delivery-route.query';
+export * from './get-delivery-route-invoices.query';
 export * from './attach-order-list-to-delivery-route.command';
 export * from './detach-order-list-to-delivery-route.command';

package/commands/report/get-sales-summary.query.ts

@@ -0,0 +1,61 @@
+import { z } from 'zod';
+import { dateRangeCheck } from '../../helpers/date.helper';
+import { ReportPeriodTypeEnum } from '../../enum/report-period-type.enum';
+
+const GetSalesSummaryRequestSchema = z
+    .object({
+        startDate: z.coerce.date().optional(),
+        endDate: z.coerce.date().optional(),
+        periodType: z.nativeEnum(ReportPeriodTypeEnum).default(ReportPeriodTypeEnum.DAY),
+    })
+    .refine(
+        value => {
+            const { startDate, endDate } = value;
+            if (startDate && endDate) {
+                return dateRangeCheck(startDate, endDate);
+            }
+            return true;
+        },
+        {
+            message: 'End date must be greater than start date',
+            path: ['endDate', 'startDate'],
+        },
+    );
+
+const SalesSummaryTotalsSchema = z.object({
+    totalRevenue: z.number(),
+    totalRevenueWithDelivery: z.number(),
+    totalOrders: z.number(),
+    uniqueClients: z.number(),
+    soldUnits: z.number(),
+    avgCheck: z.number(),
+    totalVatAmount: z.number(),
+    totalCost: z.number(),
+    totalDeliveryCost: z.number(),
+    totalDiscountAmount: z.number(),
+    grossProfit: z.number(),
+    marginality: z.number(),
+});
+
+const SalesSummarySeriesItemSchema = z.object({
+    period: z.string(),
+    revenue: z.number(),
+    orders: z.number(),
+    units: z.number(),
+    avgCheck: z.number(),
+});
+
+const GetSalesSummaryResponseSchema = z.object({
+    data: z.object({
+        totals: SalesSummaryTotalsSchema,
+        series: z.array(SalesSummarySeriesItemSchema),
+    }),
+});
+
+export namespace GetSalesSummaryContractQuery {
+    export const RequestSchema = GetSalesSummaryRequestSchema;
+    export type Request = z.infer<typeof RequestSchema>;
+
+    export const ResponseSchema = GetSalesSummaryResponseSchema;
+    export type Response = z.infer<typeof ResponseSchema>;
+}

package/commands/report/index.ts

@@ -2,6 +2,7 @@ export * from './get-report-for-period.query';
 export * from './get-report-group-by-client.query';
 export * from './get-report-group-by-position.query';
 export * from './export-sales-revenue.query';
+export * from './get-sales-summary.query';
 export * from './export-sales-by-client.query';
 export * from './export-sales-by-position.query';
 export * from './export-inventory-stock.query';

package/constant/error.ts

@@ -1008,6 +1008,12 @@ export const ERRORS = {
     DELIVERY_ROUTE_NOT_DELETED: { code: 'DLR003', message: 'Failed to delete delivery route', httpCode: 500 },
     DELIVERY_ROUTE_NOT_UPDATED: { code: 'DLR004', message: 'Failed to update delivery route', httpCode: 500 },
     DELIVERY_ROUTE_FETCH_FAILED: { code: 'DLR005', message: 'Error when retrieving delivery routes', httpCode: 500 },
+    DELIVERY_ROUTE_TOO_MANY_ORDERS: { code: 'DLR006', message: 'Too many orders in the delivery route to export invoices', httpCode: 400 },
+    DELIVERY_ROUTE_INVOICE_EXPORT_IN_PROGRESS: {
+        code: 'DLR007',
+        message: 'Invoice export for this company is already in progress',
+        httpCode: 409,
+    },
 
     FAILED_TO_CREATE: {
         code: 'FAILED_TO_CREATE',

package/helpers/date.helper.ts

@@ -1,5 +1,6 @@
+// Allows a single-day range (startDate === endDate); callers expand bounds to start/end-of-day downstream.
 export const dateRangeCheck = (startDate: Date, endDate: Date) => {
-    return endDate > startDate;
+    return endDate >= startDate;
 };
 
 // 1 year + 1 day to tolerate leap years.

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@floristcloud/api-lib",
-    "version": "1.2.63",
+    "version": "1.2.65",
     "description": "",
     "main": "./build/index.js",
     "scripts": {