@floristcloud/api-lib 1.2.108 → 1.2.109

package/build/commands/report/export-sales-by-client.query.js

@@ -3,11 +3,14 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ExportSalesByClientContractQuery = void 0;
 const zod_1 = require("zod");
 const date_helper_1 = require("../../helpers/date.helper");
+const report_order_filter_schema_1 = require("../../schemas/report/report-order-filter.schema");
 const ExportSalesByClientRequestSchema = zod_1.z
     .object({
     startDate: zod_1.z.coerce.date(),
     endDate: zod_1.z.coerce.date(),
 })
+    // dateBasis / excludeClientUUID — те же, что у JSON-эндпоинтов отчётов по заказам.
+    .merge(report_order_filter_schema_1.ReportOrderFilterSchema)
     .refine(value => (0, date_helper_1.dateRangeCheck)(value.startDate, value.endDate), {
     message: 'validation.dateRange',
     path: ['endDate', 'startDate'],

package/build/commands/report/export-sales-by-position.query.js

@@ -4,12 +4,15 @@ exports.ExportSalesByPositionContractQuery = void 0;
 const zod_1 = require("zod");
 const date_helper_1 = require("../../helpers/date.helper");
 const sales_by_position_group_by_enum_1 = require("../../enum/sales-by-position-group-by.enum");
+const report_order_filter_schema_1 = require("../../schemas/report/report-order-filter.schema");
 const ExportSalesByPositionRequestSchema = zod_1.z
     .object({
     startDate: zod_1.z.coerce.date(),
     endDate: zod_1.z.coerce.date(),
     groupBy: zod_1.z.nativeEnum(sales_by_position_group_by_enum_1.SalesByPositionGroupByEnum).default(sales_by_position_group_by_enum_1.SalesByPositionGroupByEnum.PRODUCT),
 })
+    // dateBasis / excludeClientUUID — те же, что у JSON-эндпоинтов отчётов по заказам.
+    .merge(report_order_filter_schema_1.ReportOrderFilterSchema)
     .refine(value => (0, date_helper_1.dateRangeCheck)(value.startDate, value.endDate), {
     message: 'validation.dateRange',
     path: ['endDate', 'startDate'],

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

@@ -4,12 +4,15 @@ exports.ExportSalesRevenueContractQuery = 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 report_order_filter_schema_1 = require("../../schemas/report/report-order-filter.schema");
 const ExportSalesRevenueRequestSchema = 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),
 })
+    // dateBasis / excludeClientUUID — те же, что у JSON-эндпоинтов отчётов по заказам.
+    .merge(report_order_filter_schema_1.ReportOrderFilterSchema)
     .refine(value => {
     const { startDate, endDate } = value;
     if (startDate && endDate) {

package/build/commands/report/get-report-group-by-client.query.js

@@ -4,6 +4,7 @@ exports.GetReportGroupByClientContactQuery = void 0;
 const zod_1 = require("zod");
 const enum_1 = require("../../enum");
 const date_helper_1 = require("../../helpers/date.helper");
+const report_order_filter_schema_1 = require("../../schemas/report/report-order-filter.schema");
 const GetReportGroupByClientRequestSchema = zod_1.z
     .object({
     // Даты приходят «сырым» днём — раскладку в полуинтервал [start, endExclusive) делает сервис
@@ -23,6 +24,9 @@ const GetReportGroupByClientRequestSchema = zod_1.z
     // Без значения — ограничения нет: панель по-прежнему получает все строки.
     limit: zod_1.z.coerce.number().int().positive().optional().describe('Keep only the top N rows; implies sorting by gross profit desc.'),
 })
+    // dateBasis / excludeClientUUID общие с sales/summary: обе цифры живут на одном экране и должны
+    // сужаться одинаково.
+    .merge(report_order_filter_schema_1.ReportOrderFilterSchema)
     .refine(value => {
     const { startDate, endDate } = value;
     if (startDate && endDate) {

package/build/commands/report/get-sales-by-client.query.js

@@ -6,6 +6,7 @@ const enum_1 = require("../../enum");
 const date_helper_1 = require("../../helpers/date.helper");
 const pagination_helper_1 = require("../../helpers/pagination.helper");
 const sales_by_client_row_schema_1 = require("../../schemas/report/sales-by-client-row.schema");
+const report_order_filter_schema_1 = require("../../schemas/report/report-order-filter.schema");
 const GetSalesByClientRequestSchema = zod_1.z
     .object({
     startDate: zod_1.z.coerce.date(),
@@ -18,6 +19,8 @@ const GetSalesByClientRequestSchema = zod_1.z
     page: zod_1.z.coerce.number().int().positive().optional().describe('1-based page number, requires "count".'),
     count: zod_1.z.coerce.number().int().positive().optional().describe('Rows per page. Without it every client row is returned.'),
 })
+    // dateBasis / excludeClientUUID — те же, что у JSON-эндпоинтов отчётов по заказам.
+    .merge(report_order_filter_schema_1.ReportOrderFilterSchema)
     .refine(value => (0, date_helper_1.dateRangeCheck)(value.startDate, value.endDate), {
     message: 'validation.dateRange',
     path: ['endDate', 'startDate'],

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

@@ -4,12 +4,16 @@ 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 report_order_filter_schema_1 = require("../../schemas/report/report-order-filter.schema");
 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),
 })
+    // dateBasis / excludeClientUUID общие с group-client: обе цифры живут на одном экране и должны
+    // сужаться одинаково.
+    .merge(report_order_filter_schema_1.ReportOrderFilterSchema)
     .refine(value => {
     const { startDate, endDate } = value;
     if (startDate && endDate) {

package/build/constant/index.js

@@ -20,3 +20,4 @@ __exportStar(require("./error-i18n-key"), exports);
 __exportStar(require("./import.constant"), exports);
 __exportStar(require("./validation-i18n-key"), exports);
 __exportStar(require("./validation-i18n-message"), exports);
+__exportStar(require("./report.constant"), exports);

package/build/constant/report.constant.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.REPORT_EXCLUDE_CLIENT_LIMIT = void 0;
+/**
+ * Потолок списка исключаемых из отчёта клиентов. Список едет в query-строке и дальше в SQL
+ * как `= ANY($n::text[])`, поэтому ограничение защищает и от переполнения URL, и от запроса
+ * с массивом в тысячи элементов.
+ */
+exports.REPORT_EXCLUDE_CLIENT_LIMIT = 500;

package/build/enum/index.js

@@ -114,3 +114,4 @@ __exportStar(require("./cash-flow-item-status.enum"), exports);
 __exportStar(require("./payment-invoice-status.enum"), exports);
 __exportStar(require("./order-by.enum"), exports);
 __exportStar(require("./report-sort-by.enum"), exports);
+__exportStar(require("./report-order-date-basis.enum"), exports);

package/build/enum/report-order-date-basis.enum.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReportOrderDateBasisEnum = void 0;
+/**
+ * Ось периода для отчётов по заказам — ровно одна дата на отчёт.
+ *
+ * CREATED_AT — по дате создания заказа (историческое поведение всех отчётов).
+ * COMPLETED_AT — по дате отгрузки (завершения); заказ, созданный в июне и отгруженный в июле,
+ * попадёт в июль.
+ *
+ * Дизъюнкции («любая из дат») здесь намеренно нет: заказ, созданный в июне и отгруженный в июле,
+ * попал бы в оба месяца, сумма отчётов по месяцам перестала бы сходиться с отчётом за квартал.
+ */
+var ReportOrderDateBasisEnum;
+(function (ReportOrderDateBasisEnum) {
+    ReportOrderDateBasisEnum["CREATED_AT"] = "CREATED_AT";
+    ReportOrderDateBasisEnum["COMPLETED_AT"] = "COMPLETED_AT";
+})(ReportOrderDateBasisEnum || (exports.ReportOrderDateBasisEnum = ReportOrderDateBasisEnum = {}));

package/build/schemas/index.js

@@ -93,3 +93,4 @@ __exportStar(require("./account-deletion-request/account-deletion-request.schema
 __exportStar(require("./consignment-transfer"), exports);
 __exportStar(require("./api-error.schema"), exports);
 __exportStar(require("./access-policy"), exports);
+__exportStar(require("./report/report-order-filter.schema"), exports);

package/build/schemas/report/report-order-filter.schema.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReportOrderFilterSchema = void 0;
+const zod_1 = require("zod");
+const enum_1 = require("../../enum");
+const report_constant_1 = require("../../constant/report.constant");
+/**
+ * Общие фильтры отчётов, построенных на заказах: по какой дате заказ попадает в период и каких
+ * клиентов из него выкинуть. Схема одна на все такие отчёты — иначе `sales/summary` и
+ * `group-client` на одном экране разошлись бы в семантике при первой же правке.
+ *
+ * `excludeClientUUID` — типовой случай «отгружаем по себестоимости, в прибыли не учитываем».
+ * Принимается и CSV (`?excludeClientUUID=uuid1,uuid2`, как в get-notifications-status), и повтор
+ * параметра (`?excludeClientUUID=uuid1&excludeClientUUID=uuid2`) — Express отдаёт второй вариант
+ * массивом, и требовать от фронта именно CSV незачем.
+ */
+exports.ReportOrderFilterSchema = zod_1.z.object({
+    dateBasis: zod_1.z
+        .nativeEnum(enum_1.ReportOrderDateBasisEnum)
+        .default(enum_1.ReportOrderDateBasisEnum.CREATED_AT)
+        .describe('Which order date puts the order into the period. Defaults to the order creation date.'),
+    excludeClientUUID: zod_1.z
+        .union([zod_1.z.string(), zod_1.z.array(zod_1.z.string())])
+        .transform(value => (Array.isArray(value) ? value : value.split(',')).map(item => item.trim()).filter(Boolean))
+        .pipe(zod_1.z.array(zod_1.z.string().uuid()).max(report_constant_1.REPORT_EXCLUDE_CLIENT_LIMIT))
+        .optional()
+        .describe('Clients to drop from the report entirely — their orders, revenue and cost.'),
+});

package/commands/report/export-sales-by-client.query.ts

@@ -1,11 +1,14 @@
 import { z } from 'zod';
 import { dateRangeCheck, isStatementPeriodWithinLimit } from '../../helpers/date.helper';
+import { ReportOrderFilterSchema } from '../../schemas/report/report-order-filter.schema';
 
 const ExportSalesByClientRequestSchema = z
     .object({
         startDate: z.coerce.date(),
         endDate: z.coerce.date(),
     })
+    // dateBasis / excludeClientUUID — те же, что у JSON-эндпоинтов отчётов по заказам.
+    .merge(ReportOrderFilterSchema)
     .refine(value => dateRangeCheck(value.startDate, value.endDate), {
         message: 'validation.dateRange',
         path: ['endDate', 'startDate'],

package/commands/report/export-sales-by-position.query.ts

@@ -1,6 +1,7 @@
 import { z } from 'zod';
 import { dateRangeCheck, isStatementPeriodWithinLimit } from '../../helpers/date.helper';
 import { SalesByPositionGroupByEnum } from '../../enum/sales-by-position-group-by.enum';
+import { ReportOrderFilterSchema } from '../../schemas/report/report-order-filter.schema';
 
 const ExportSalesByPositionRequestSchema = z
     .object({
@@ -8,6 +9,8 @@ const ExportSalesByPositionRequestSchema = z
         endDate: z.coerce.date(),
         groupBy: z.nativeEnum(SalesByPositionGroupByEnum).default(SalesByPositionGroupByEnum.PRODUCT),
     })
+    // dateBasis / excludeClientUUID — те же, что у JSON-эндпоинтов отчётов по заказам.
+    .merge(ReportOrderFilterSchema)
     .refine(value => dateRangeCheck(value.startDate, value.endDate), {
         message: 'validation.dateRange',
         path: ['endDate', 'startDate'],

package/commands/report/export-sales-revenue.query.ts

@@ -1,6 +1,7 @@
 import { z } from 'zod';
 import { dateRangeCheck } from '../../helpers/date.helper';
 import { ReportPeriodTypeEnum } from '../../enum/report-period-type.enum';
+import { ReportOrderFilterSchema } from '../../schemas/report/report-order-filter.schema';
 
 const ExportSalesRevenueRequestSchema = z
     .object({
@@ -8,6 +9,8 @@ const ExportSalesRevenueRequestSchema = z
         endDate: z.coerce.date().optional(),
         periodType: z.nativeEnum(ReportPeriodTypeEnum).default(ReportPeriodTypeEnum.DAY),
     })
+    // dateBasis / excludeClientUUID — те же, что у JSON-эндпоинтов отчётов по заказам.
+    .merge(ReportOrderFilterSchema)
     .refine(
         value => {
             const { startDate, endDate } = value;

package/commands/report/get-report-group-by-client.query.ts

@@ -1,6 +1,7 @@
 import { z } from 'zod';
 import { OrderByEnum, ReportSortByEnum } from '../../enum';
 import { dateRangeCheck } from '../../helpers/date.helper';
+import { ReportOrderFilterSchema } from '../../schemas/report/report-order-filter.schema';
 
 const GetReportGroupByClientRequestSchema = z
     .object({
@@ -21,6 +22,9 @@ const GetReportGroupByClientRequestSchema = z
         // Без значения — ограничения нет: панель по-прежнему получает все строки.
         limit: z.coerce.number().int().positive().optional().describe('Keep only the top N rows; implies sorting by gross profit desc.'),
     })
+    // dateBasis / excludeClientUUID общие с sales/summary: обе цифры живут на одном экране и должны
+    // сужаться одинаково.
+    .merge(ReportOrderFilterSchema)
     .refine(
         value => {
             const { startDate, endDate } = value;

package/commands/report/get-sales-by-client.query.ts

@@ -3,6 +3,7 @@ import { OrderByEnum, ReportSortByEnum } from '../../enum';
 import { dateRangeCheck, isStatementPeriodWithinLimit } from '../../helpers/date.helper';
 import { isPageAccompaniedByCount } from '../../helpers/pagination.helper';
 import { SalesByClientRowSchema } from '../../schemas/report/sales-by-client-row.schema';
+import { ReportOrderFilterSchema } from '../../schemas/report/report-order-filter.schema';
 
 const GetSalesByClientRequestSchema = z
     .object({
@@ -16,6 +17,8 @@ const GetSalesByClientRequestSchema = z
         page: z.coerce.number().int().positive().optional().describe('1-based page number, requires "count".'),
         count: z.coerce.number().int().positive().optional().describe('Rows per page. Without it every client row is returned.'),
     })
+    // dateBasis / excludeClientUUID — те же, что у JSON-эндпоинтов отчётов по заказам.
+    .merge(ReportOrderFilterSchema)
     .refine(value => dateRangeCheck(value.startDate, value.endDate), {
         message: 'validation.dateRange',
         path: ['endDate', 'startDate'],

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

@@ -1,6 +1,7 @@
 import { z } from 'zod';
 import { dateRangeCheck } from '../../helpers/date.helper';
 import { ReportPeriodTypeEnum } from '../../enum/report-period-type.enum';
+import { ReportOrderFilterSchema } from '../../schemas/report/report-order-filter.schema';
 
 const GetSalesSummaryRequestSchema = z
     .object({
@@ -8,6 +9,9 @@ const GetSalesSummaryRequestSchema = z
         endDate: z.coerce.date().optional(),
         periodType: z.nativeEnum(ReportPeriodTypeEnum).default(ReportPeriodTypeEnum.DAY),
     })
+    // dateBasis / excludeClientUUID общие с group-client: обе цифры живут на одном экране и должны
+    // сужаться одинаково.
+    .merge(ReportOrderFilterSchema)
     .refine(
         value => {
             const { startDate, endDate } = value;

package/constant/index.ts

@@ -4,3 +4,4 @@ export * from './error-i18n-key';
 export * from './import.constant';
 export * from './validation-i18n-key';
 export * from './validation-i18n-message';
+export * from './report.constant';

package/constant/report.constant.ts

@@ -0,0 +1,6 @@
+/**
+ * Потолок списка исключаемых из отчёта клиентов. Список едет в query-строке и дальше в SQL
+ * как `= ANY($n::text[])`, поэтому ограничение защищает и от переполнения URL, и от запроса
+ * с массивом в тысячи элементов.
+ */
+export const REPORT_EXCLUDE_CLIENT_LIMIT = 500;

package/enum/index.ts

@@ -98,3 +98,4 @@ export * from './cash-flow-item-status.enum';
 export * from './payment-invoice-status.enum';
 export * from './order-by.enum';
 export * from './report-sort-by.enum';
+export * from './report-order-date-basis.enum';

package/enum/report-order-date-basis.enum.ts

@@ -0,0 +1,14 @@
+/**
+ * Ось периода для отчётов по заказам — ровно одна дата на отчёт.
+ *
+ * CREATED_AT — по дате создания заказа (историческое поведение всех отчётов).
+ * COMPLETED_AT — по дате отгрузки (завершения); заказ, созданный в июне и отгруженный в июле,
+ * попадёт в июль.
+ *
+ * Дизъюнкции («любая из дат») здесь намеренно нет: заказ, созданный в июне и отгруженный в июле,
+ * попал бы в оба месяца, сумма отчётов по месяцам перестала бы сходиться с отчётом за квартал.
+ */
+export enum ReportOrderDateBasisEnum {
+    CREATED_AT = 'CREATED_AT',
+    COMPLETED_AT = 'COMPLETED_AT',
+}

package/package.json

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

package/schemas/index.ts

@@ -77,3 +77,4 @@ export * from './account-deletion-request/account-deletion-request.schema';
 export * from './consignment-transfer';
 export * from './api-error.schema';
 export * from './access-policy';
+export * from './report/report-order-filter.schema';

package/schemas/report/report-order-filter.schema.ts

@@ -0,0 +1,26 @@
+import { z } from 'zod';
+import { ReportOrderDateBasisEnum } from '../../enum';
+import { REPORT_EXCLUDE_CLIENT_LIMIT } from '../../constant/report.constant';
+
+/**
+ * Общие фильтры отчётов, построенных на заказах: по какой дате заказ попадает в период и каких
+ * клиентов из него выкинуть. Схема одна на все такие отчёты — иначе `sales/summary` и
+ * `group-client` на одном экране разошлись бы в семантике при первой же правке.
+ *
+ * `excludeClientUUID` — типовой случай «отгружаем по себестоимости, в прибыли не учитываем».
+ * Принимается и CSV (`?excludeClientUUID=uuid1,uuid2`, как в get-notifications-status), и повтор
+ * параметра (`?excludeClientUUID=uuid1&excludeClientUUID=uuid2`) — Express отдаёт второй вариант
+ * массивом, и требовать от фронта именно CSV незачем.
+ */
+export const ReportOrderFilterSchema = z.object({
+    dateBasis: z
+        .nativeEnum(ReportOrderDateBasisEnum)
+        .default(ReportOrderDateBasisEnum.CREATED_AT)
+        .describe('Which order date puts the order into the period. Defaults to the order creation date.'),
+    excludeClientUUID: z
+        .union([z.string(), z.array(z.string())])
+        .transform(value => (Array.isArray(value) ? value : value.split(',')).map(item => item.trim()).filter(Boolean))
+        .pipe(z.array(z.string().uuid()).max(REPORT_EXCLUDE_CLIENT_LIMIT))
+        .optional()
+        .describe('Clients to drop from the report entirely — their orders, revenue and cost.'),
+});