@floristcloud/api-lib 1.2.64 → 1.2.66

package/build/commands/report/export-sales-revenue.query.js

@@ -21,13 +21,10 @@ const ExportSalesRevenueRequestSchema = zod_1.z
     path: ['endDate', 'startDate'],
 });
 const ExportSalesRevenueResponseSchema = zod_1.z.object({
-    data: zod_1.z.array(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(),
-    })),
+    data: zod_1.z.object({
+        fileUrl: zod_1.z.string(),
+        fileKey: zod_1.z.string(),
+    }),
 });
 var ExportSalesRevenueContractQuery;
 (function (ExportSalesRevenueContractQuery) {

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/commands/report/export-sales-revenue.query.ts

@@ -23,15 +23,10 @@ const ExportSalesRevenueRequestSchema = z
     );
 
 const ExportSalesRevenueResponseSchema = z.object({
-    data: z.array(
-        z.object({
-            period: z.string(),
-            revenue: z.number(),
-            orders: z.number(),
-            units: z.number(),
-            avgCheck: z.number(),
-        }),
-    ),
+    data: z.object({
+        fileUrl: z.string(),
+        fileKey: z.string(),
+    }),
 });
 
 export namespace ExportSalesRevenueContractQuery {

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/package.json

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