@floristcloud/api-lib 1.2.189 → 1.2.191

package/build/schemas/report/write-off-summary-totals.schema.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WriteOffSummaryTotalsSchema = void 0;
+const zod_1 = require("zod");
+const money_schema_1 = require("../money.schema");
+/**
+ * totals = warehouse + byClient, считается по всем строкам — усечение `clientLimit` на итоги
+ * не влияет.
+ */
+exports.WriteOffSummaryTotalsSchema = zod_1.z.object({
+    units: zod_1.z.number(),
+    cost: money_schema_1.MoneySchema,
+    // Себестоимость прихода партий периода и доля списаний от неё в процентах — только на
+    // оси CONSIGNMENT_DELIVERY_DATE, иначе null: на оси даты списания товар мог прийти
+    // раньше периода, и делить его на приход периода некорректно.
+    receivedCost: money_schema_1.MoneySchema.nullable(),
+    share: zod_1.z.number().nullable(),
+});

package/build/schemas/report/write-off-summary-warehouse.schema.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WriteOffSummaryWarehouseSchema = void 0;
+const zod_1 = require("zod");
+const money_schema_1 = require("../money.schema");
+const write_off_summary_reason_row_schema_1 = require("./write-off-summary-reason-row.schema");
+/** Списания без заказа: до этого отчёта они не попадали ни в одну сводку. */
+exports.WriteOffSummaryWarehouseSchema = zod_1.z.object({
+    units: zod_1.z.number(),
+    cost: money_schema_1.MoneySchema,
+    byReason: write_off_summary_reason_row_schema_1.WriteOffSummaryReasonRowSchema.array(),
+});

package/commands/report/get-write-off-breakdown.query.ts

@@ -0,0 +1,11 @@
+import type { z } from 'zod';
+import { GetWriteOffBreakdownRequestSchema } from '../../schemas/report/get-write-off-breakdown-request.schema';
+import { GetWriteOffBreakdownResponseSchema } from '../../schemas/report/get-write-off-breakdown-response.schema';
+
+export namespace GetWriteOffBreakdownContractQuery {
+    export const RequestSchema = GetWriteOffBreakdownRequestSchema;
+    export type Request = z.infer<typeof RequestSchema>;
+
+    export const ResponseSchema = GetWriteOffBreakdownResponseSchema;
+    export type Response = z.infer<typeof ResponseSchema>;
+}

package/commands/report/get-write-off-by-client.query.ts

@@ -0,0 +1,11 @@
+import type { z } from 'zod';
+import { GetWriteOffByClientRequestSchema } from '../../schemas/report/get-write-off-by-client-request.schema';
+import { GetWriteOffByClientResponseSchema } from '../../schemas/report/get-write-off-by-client-response.schema';
+
+export namespace GetWriteOffByClientContractQuery {
+    export const RequestSchema = GetWriteOffByClientRequestSchema;
+    export type Request = z.infer<typeof RequestSchema>;
+
+    export const ResponseSchema = GetWriteOffByClientResponseSchema;
+    export type Response = z.infer<typeof ResponseSchema>;
+}

package/commands/report/get-write-off-summary.query.ts

@@ -1,85 +1,6 @@
-import { z } from 'zod';
-import { dateRangeCheck, isStatementPeriodWithinLimit } from '../../helpers/date.helper';
-import { MoneySchema } from '../../schemas/money.schema';
-import { WriteOffReportDateBasisEnum } from '../../enum/write-off-report-date-basis.enum';
-import {
-    REPORT_EXCLUDE_CLIENT_LIMIT,
-    REPORT_WRITE_OFF_CLIENT_LIMIT_DEFAULT,
-    REPORT_WRITE_OFF_CLIENT_LIMIT_MAX,
-} from '../../constant/report.constant';
-
-const GetWriteOffSummaryRequestSchema = z
-    .object({
-        startDate: z.coerce.date(),
-        endDate: z.coerce.date(),
-        dateBasis: z.nativeEnum(WriteOffReportDateBasisEnum).default(WriteOffReportDateBasisEnum.WRITE_OFF_DATE),
-        // Тот же формат, что в ReportOrderFilterSchema: CSV или повтор параметра. Применяется
-        // только к разрезу по клиентам — у складских списаний клиента нет.
-        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(),
-        clientLimit: z.coerce
-            .number()
-            .int()
-            .positive()
-            .max(REPORT_WRITE_OFF_CLIENT_LIMIT_MAX)
-            .default(REPORT_WRITE_OFF_CLIENT_LIMIT_DEFAULT),
-    })
-    .refine(value => dateRangeCheck(value.startDate, value.endDate), {
-        message: 'validation.dateRange',
-        path: ['endDate', 'startDate'],
-    })
-    .refine(value => isStatementPeriodWithinLimit(value.startDate, value.endDate), {
-        message: 'validation.reportPeriodMax',
-        path: ['endDate', 'startDate'],
-    });
-
-const WriteOffSummaryReasonRowSchema = z.object({
-    // Свободный текст из справочника причин, схлопнут только по краевым пробелам (TRIM).
-    // Регистр не нормализуем: «Брак» и «брак» останутся разными строками.
-    reason: z.string(),
-    units: z.number(),
-    cost: MoneySchema,
-});
-
-const WriteOffSummaryClientRowSchema = z.object({
-    clientUUID: z.string(),
-    clientName: z.string(),
-    orderCount: z.number(),
-    units: z.number(),
-    cost: MoneySchema,
-    orderAmount: MoneySchema,
-});
-
-const GetWriteOffSummaryResponseSchema = z.object({
-    message: z.string().optional(),
-    data: z.object({
-        // totals = warehouse + byClient, считается по всем строкам — усечение `clientLimit`
-        // на итоги не влияет.
-        totals: z.object({
-            units: z.number(),
-            cost: MoneySchema,
-        }),
-        // Списания без заказа: до этого отчёта они не попадали ни в одну сводку.
-        warehouse: z.object({
-            units: z.number(),
-            cost: MoneySchema,
-            byReason: WriteOffSummaryReasonRowSchema.array(),
-        }),
-        // Списания по заказу: клиенту они уже вернулись на баланс, то есть это выручка,
-        // которой по факту не было.
-        byClient: z.object({
-            units: z.number(),
-            cost: MoneySchema,
-            orderAmount: MoneySchema,
-            rows: WriteOffSummaryClientRowSchema.array(),
-            // Сколько клиентов всего — чтобы отличить усечённый ответ от полного.
-            rowsTotal: z.number(),
-        }),
-    }),
-});
+import type { z } from 'zod';
+import { GetWriteOffSummaryRequestSchema } from '../../schemas/report/get-write-off-summary-request.schema';
+import { GetWriteOffSummaryResponseSchema } from '../../schemas/report/get-write-off-summary-response.schema';
 
 export namespace GetWriteOffSummaryContractQuery {
     export const RequestSchema = GetWriteOffSummaryRequestSchema;

package/commands/report/index.ts

@@ -13,6 +13,8 @@ export * from './get-report-by-client-weeks.query';
 export * from './get-daily-orders-summary.query';
 export * from './get-cash-flow.query';
 export * from './get-write-off-summary.query';
+export * from './get-write-off-breakdown.query';
+export * from './get-write-off-by-client.query';
 export * from './get-inventory-stock.query';
 export * from './get-inventory-turnover.query';
 export * from './get-sales-by-client.query';

package/constant/error.ts

@@ -1548,6 +1548,8 @@ export const ERRORS = {
     REPORT_EXPORT_FAILED: { code: 'REP002', message: 'Failed to export report', httpCode: 500 },
     REPORT_NO_DATA: { code: 'REP003', message: 'No data available for the selected period', httpCode: 404 },
     WRITE_OFF_SUMMARY_REPORT_FAILED: { code: 'REP004', message: 'Failed to build write-off summary report', httpCode: 500 },
+    WRITE_OFF_BREAKDOWN_REPORT_FAILED: { code: 'REP005', message: 'Failed to build write-off breakdown report', httpCode: 500 },
+    WRITE_OFF_BY_CLIENT_REPORT_FAILED: { code: 'REP006', message: 'Failed to build write-off by client report', httpCode: 500 },
     STATEMENT_PERIOD_TOO_LONG: { code: 'REP004', message: 'Statement period must not exceed 1 year', httpCode: 400 },
 
     // PAYMENT INVOICE
@@ -1844,6 +1846,10 @@ export const ERRORS = {
         message: 'Product stock cannot be recomputed: it is not in the 1C sync consignment',
         httpCode: 409,
     },
+    // Файл обмена больше ONE_C_MAX_EXCHANGE_FILE_BYTES: тело сбрасывается без чтения в память.
+    ONE_C_EXCHANGE_FILE_TOO_LARGE: { code: 'OC024', message: '1C exchange file exceeds the size limit', httpCode: 413 },
+    // Приём каталога выключен на интеграции (CompanyIntegration.isCatalogExchangeEnabled), обмен заказами продолжается.
+    ONE_C_CATALOG_EXCHANGE_DISABLED: { code: 'OC025', message: '1C catalog exchange is disabled for this company', httpCode: 409 },
 
     // COMPANY INTEGRATION (общая запись интеграции компании)
     COMPANY_INTEGRATION_FETCH_FAILED: { code: 'CINT001', message: 'Failed to read company integration', httpCode: 500 },
@@ -1855,6 +1861,7 @@ export const ERRORS = {
         message: 'The unit is not among the saved units of the company integration',
         httpCode: 400,
     },
+    INTEGRATION_WAREHOUSES_NOT_SAVED: { code: 'CINT006', message: 'Failed to save integration warehouses', httpCode: 500 },
 
     // OZEXPORT INTEGRATION (FC-513)
     OZEXPORT_AUTH_FAILED: { code: 'OZ001', message: 'ozexport rejected the username or password', httpCode: 400 },

package/constant/report.constant.ts

@@ -13,3 +13,11 @@ export const REPORT_EXCLUDE_CLIENT_LIMIT = 500;
 export const REPORT_WRITE_OFF_CLIENT_LIMIT_DEFAULT = 50;
 
 export const REPORT_WRITE_OFF_CLIENT_LIMIT_MAX = 500;
+
+/**
+ * Страница строк в разрезах вкладки «Списания» (`breakdown`, `by-client`). Итоги считаются по всем
+ * строкам независимо от `limit`/`offset`; полный список фронт выбирает постранично через `offset`.
+ */
+export const REPORT_WRITE_OFF_BREAKDOWN_LIMIT_DEFAULT = 50;
+
+export const REPORT_WRITE_OFF_BREAKDOWN_LIMIT_MAX = 500;

package/enum/index.ts

@@ -148,6 +148,7 @@ export * from './userRole.enum';
 export * from './userStatus.enum';
 export * from './webshop-main-display-mode.enum';
 export * from './webshop-mode.enum';
+export * from './write-off-breakdown-group-by.enum';
 export * from './write-off-report-date-basis.enum';
 export * from './write-off-status.enum';
 export * from './one-c-stock-conflict-status.enum';

package/enum/write-off-breakdown-group-by.enum.ts

@@ -0,0 +1,14 @@
+/**
+ * Разрез отчёта `/report/write-off/breakdown` — по какому признаку группируются списания.
+ *
+ * `CONSIGNMENT` — партия (база процента — приход партии целиком, на любой оси периода).
+ * `GROWER` — производитель `product.grower`, без учёта регистра и краевых пробелов.
+ * `CATEGORY` — категория, снимок `write_off.category_uuid` на момент списания.
+ * `REASON` — причина, свободный текст без краевых пробелов; процента у причин нет.
+ */
+export enum WriteOffBreakdownGroupByEnum {
+    CONSIGNMENT = 'CONSIGNMENT',
+    GROWER = 'GROWER',
+    CATEGORY = 'CATEGORY',
+    REASON = 'REASON',
+}

package/package.json

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

package/schemas/report/get-write-off-breakdown-request.schema.ts

@@ -0,0 +1,26 @@
+import { z } from 'zod';
+import { dateRangeCheck, isStatementPeriodWithinLimit } from '../../helpers/date.helper';
+import { WriteOffBreakdownGroupByEnum } from '../../enum/write-off-breakdown-group-by.enum';
+import { WriteOffReportDateBasisEnum } from '../../enum/write-off-report-date-basis.enum';
+import { ReportOrderFilterSchema } from './report-order-filter.schema';
+import { WriteOffReportPageSchema } from './write-off-report-page.schema';
+
+export const GetWriteOffBreakdownRequestSchema = WriteOffReportPageSchema.extend({
+    startDate: z.coerce.date(),
+    endDate: z.coerce.date(),
+    // Дефолт тот же, что у write-off/summary: один и тот же запрос без оси не должен давать разную
+    // выборку на двух эндпоинтах. Вкладка «Списания» передаёт ось явно.
+    dateBasis: z.nativeEnum(WriteOffReportDateBasisEnum).default(WriteOffReportDateBasisEnum.WRITE_OFF_DATE),
+    groupBy: z.nativeEnum(WriteOffBreakdownGroupByEnum),
+    excludeClientUUID: ReportOrderFilterSchema.shape.excludeClientUUID.describe(
+        'Clients whose order write-offs are dropped. Warehouse write-offs have no client and stay.',
+    ),
+})
+    .refine(value => dateRangeCheck(value.startDate, value.endDate), {
+        message: 'validation.dateRange',
+        path: ['endDate', 'startDate'],
+    })
+    .refine(value => isStatementPeriodWithinLimit(value.startDate, value.endDate), {
+        message: 'validation.reportPeriodMax',
+        path: ['endDate', 'startDate'],
+    });

package/schemas/report/get-write-off-breakdown-response-data.schema.ts

@@ -0,0 +1,10 @@
+import { z } from 'zod';
+import { WriteOffBreakdownRowSchema } from './write-off-breakdown-row.schema';
+import { WriteOffBreakdownTotalsSchema } from './write-off-breakdown-totals.schema';
+
+export const GetWriteOffBreakdownResponseDataSchema = z.object({
+    totals: WriteOffBreakdownTotalsSchema,
+    rows: WriteOffBreakdownRowSchema.array(),
+    // Строк во всём разрезе — чтобы отличить страницу от полного списка.
+    rowsTotal: z.number(),
+});

package/schemas/report/get-write-off-breakdown-response.schema.ts

@@ -0,0 +1,7 @@
+import { z } from 'zod';
+import { GetWriteOffBreakdownResponseDataSchema } from './get-write-off-breakdown-response-data.schema';
+
+export const GetWriteOffBreakdownResponseSchema = z.object({
+    message: z.string().optional(),
+    data: GetWriteOffBreakdownResponseDataSchema,
+});

package/schemas/report/get-write-off-by-client-request.schema.ts

@@ -0,0 +1,27 @@
+import { z } from 'zod';
+import { dateRangeCheck, isStatementPeriodWithinLimit } from '../../helpers/date.helper';
+import { ReportOrderDateBasisEnum } from '../../enum/report-order-date-basis.enum';
+import { ReportOrderFilterSchema } from './report-order-filter.schema';
+import { WriteOffReportPageSchema } from './write-off-report-page.schema';
+
+/**
+ * Ось разреза — заказы периода, а не списания: списание по заказу попадает сюда независимо от
+ * своей даты, иначе процент делил бы брак по заказу прошлого месяца на выручку текущего.
+ *
+ * Параметр назван `orderDateBasis`, а не `dateBasis`, как в отчётах продаж: остальные запросы
+ * вкладки шлют `dateBasis` с осью списаний, и общее имя позволило бы молча перепутать перечисления.
+ */
+export const GetWriteOffByClientRequestSchema = WriteOffReportPageSchema.extend({
+    startDate: z.coerce.date(),
+    endDate: z.coerce.date(),
+    orderDateBasis: z.nativeEnum(ReportOrderDateBasisEnum).default(ReportOrderDateBasisEnum.CREATED_AT),
+    excludeClientUUID: ReportOrderFilterSchema.shape.excludeClientUUID,
+})
+    .refine(value => dateRangeCheck(value.startDate, value.endDate), {
+        message: 'validation.dateRange',
+        path: ['endDate', 'startDate'],
+    })
+    .refine(value => isStatementPeriodWithinLimit(value.startDate, value.endDate), {
+        message: 'validation.reportPeriodMax',
+        path: ['endDate', 'startDate'],
+    });

package/schemas/report/get-write-off-by-client-response-data.schema.ts

@@ -0,0 +1,10 @@
+import { z } from 'zod';
+import { WriteOffByClientRowSchema } from './write-off-by-client-row.schema';
+import { WriteOffByClientTotalsSchema } from './write-off-by-client-totals.schema';
+
+export const GetWriteOffByClientResponseDataSchema = z.object({
+    totals: WriteOffByClientTotalsSchema,
+    rows: WriteOffByClientRowSchema.array(),
+    // Клиентов со списаниями всего — чтобы отличить страницу от полного списка.
+    rowsTotal: z.number(),
+});

package/schemas/report/get-write-off-by-client-response.schema.ts

@@ -0,0 +1,7 @@
+import { z } from 'zod';
+import { GetWriteOffByClientResponseDataSchema } from './get-write-off-by-client-response-data.schema';
+
+export const GetWriteOffByClientResponseSchema = z.object({
+    message: z.string().optional(),
+    data: GetWriteOffByClientResponseDataSchema,
+});

package/schemas/report/get-write-off-summary-request.schema.ts

@@ -0,0 +1,36 @@
+import { z } from 'zod';
+import { dateRangeCheck, isStatementPeriodWithinLimit } from '../../helpers/date.helper';
+import { WriteOffReportDateBasisEnum } from '../../enum/write-off-report-date-basis.enum';
+import {
+    REPORT_EXCLUDE_CLIENT_LIMIT,
+    REPORT_WRITE_OFF_CLIENT_LIMIT_DEFAULT,
+    REPORT_WRITE_OFF_CLIENT_LIMIT_MAX,
+} from '../../constant/report.constant';
+
+export const GetWriteOffSummaryRequestSchema = z
+    .object({
+        startDate: z.coerce.date(),
+        endDate: z.coerce.date(),
+        dateBasis: z.nativeEnum(WriteOffReportDateBasisEnum).default(WriteOffReportDateBasisEnum.WRITE_OFF_DATE),
+        // Тот же формат, что в ReportOrderFilterSchema: CSV или повтор параметра. Применяется
+        // только к разрезу по клиентам — у складских списаний клиента нет.
+        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(),
+        clientLimit: z.coerce
+            .number()
+            .int()
+            .positive()
+            .max(REPORT_WRITE_OFF_CLIENT_LIMIT_MAX)
+            .default(REPORT_WRITE_OFF_CLIENT_LIMIT_DEFAULT),
+    })
+    .refine(value => dateRangeCheck(value.startDate, value.endDate), {
+        message: 'validation.dateRange',
+        path: ['endDate', 'startDate'],
+    })
+    .refine(value => isStatementPeriodWithinLimit(value.startDate, value.endDate), {
+        message: 'validation.reportPeriodMax',
+        path: ['endDate', 'startDate'],
+    });

package/schemas/report/get-write-off-summary-response-data.schema.ts

@@ -0,0 +1,10 @@
+import { z } from 'zod';
+import { WriteOffSummaryByClientSchema } from './write-off-summary-by-client.schema';
+import { WriteOffSummaryTotalsSchema } from './write-off-summary-totals.schema';
+import { WriteOffSummaryWarehouseSchema } from './write-off-summary-warehouse.schema';
+
+export const GetWriteOffSummaryResponseDataSchema = z.object({
+    totals: WriteOffSummaryTotalsSchema,
+    warehouse: WriteOffSummaryWarehouseSchema,
+    byClient: WriteOffSummaryByClientSchema,
+});

package/schemas/report/get-write-off-summary-response.schema.ts

@@ -0,0 +1,7 @@
+import { z } from 'zod';
+import { GetWriteOffSummaryResponseDataSchema } from './get-write-off-summary-response-data.schema';
+
+export const GetWriteOffSummaryResponseSchema = z.object({
+    message: z.string().optional(),
+    data: GetWriteOffSummaryResponseDataSchema,
+});

package/schemas/report/index.ts

@@ -6,3 +6,28 @@ export * from './daily-orders-summary-by-day-item.schema';
 export * from './daily-orders-summary-by-responsible-item.schema';
 export * from './get-daily-orders-summary-response-data.schema';
 export * from './get-daily-orders-summary-response.schema';
+export * from './get-write-off-summary-request.schema';
+export * from './write-off-summary-reason-row.schema';
+export * from './write-off-summary-client-row.schema';
+export * from './write-off-summary-totals.schema';
+export * from './write-off-summary-warehouse.schema';
+export * from './write-off-summary-by-client.schema';
+export * from './get-write-off-summary-response-data.schema';
+export * from './get-write-off-summary-response.schema';
+export * from './write-off-report-page.schema';
+export * from './get-write-off-breakdown-request.schema';
+export * from './write-off-breakdown-totals.schema';
+export * from './write-off-breakdown-row-base.schema';
+export * from './write-off-breakdown-consignment.schema';
+export * from './write-off-breakdown-consignment-row.schema';
+export * from './write-off-breakdown-grower-row.schema';
+export * from './write-off-breakdown-category-row.schema';
+export * from './write-off-breakdown-reason-row.schema';
+export * from './write-off-breakdown-row.schema';
+export * from './get-write-off-breakdown-response-data.schema';
+export * from './get-write-off-breakdown-response.schema';
+export * from './get-write-off-by-client-request.schema';
+export * from './write-off-by-client-totals.schema';
+export * from './write-off-by-client-row.schema';
+export * from './get-write-off-by-client-response-data.schema';
+export * from './get-write-off-by-client-response.schema';

package/schemas/report/write-off-breakdown-category-row.schema.ts

@@ -0,0 +1,7 @@
+import { z } from 'zod';
+import { WriteOffBreakdownGroupByEnum } from '../../enum/write-off-breakdown-group-by.enum';
+import { WriteOffBreakdownRowBaseSchema } from './write-off-breakdown-row-base.schema';
+
+export const WriteOffBreakdownCategoryRowSchema = WriteOffBreakdownRowBaseSchema.extend({
+    groupBy: z.literal(WriteOffBreakdownGroupByEnum.CATEGORY),
+});

package/schemas/report/write-off-breakdown-consignment-row.schema.ts

@@ -0,0 +1,9 @@
+import { z } from 'zod';
+import { WriteOffBreakdownGroupByEnum } from '../../enum/write-off-breakdown-group-by.enum';
+import { WriteOffBreakdownConsignmentSchema } from './write-off-breakdown-consignment.schema';
+import { WriteOffBreakdownRowBaseSchema } from './write-off-breakdown-row-base.schema';
+
+export const WriteOffBreakdownConsignmentRowSchema = WriteOffBreakdownRowBaseSchema.extend({
+    groupBy: z.literal(WriteOffBreakdownGroupByEnum.CONSIGNMENT),
+    consignment: WriteOffBreakdownConsignmentSchema,
+});

package/schemas/report/write-off-breakdown-consignment.schema.ts

@@ -0,0 +1,9 @@
+import { z } from 'zod';
+
+/** Партия в строке разреза по поставкам. */
+export const WriteOffBreakdownConsignmentSchema = z.object({
+    uuid: z.string(),
+    id: z.number(),
+    label: z.string().nullable(),
+    deliveryDate: z.coerce.date(),
+});

package/schemas/report/write-off-breakdown-grower-row.schema.ts

@@ -0,0 +1,7 @@
+import { z } from 'zod';
+import { WriteOffBreakdownGroupByEnum } from '../../enum/write-off-breakdown-group-by.enum';
+import { WriteOffBreakdownRowBaseSchema } from './write-off-breakdown-row-base.schema';
+
+export const WriteOffBreakdownGrowerRowSchema = WriteOffBreakdownRowBaseSchema.extend({
+    groupBy: z.literal(WriteOffBreakdownGroupByEnum.GROWER),
+});

package/schemas/report/write-off-breakdown-reason-row.schema.ts

@@ -0,0 +1,7 @@
+import { z } from 'zod';
+import { WriteOffBreakdownGroupByEnum } from '../../enum/write-off-breakdown-group-by.enum';
+import { WriteOffBreakdownRowBaseSchema } from './write-off-breakdown-row-base.schema';
+
+export const WriteOffBreakdownReasonRowSchema = WriteOffBreakdownRowBaseSchema.extend({
+    groupBy: z.literal(WriteOffBreakdownGroupByEnum.REASON),
+});

package/schemas/report/write-off-breakdown-row-base.schema.ts

@@ -0,0 +1,19 @@
+import { z } from 'zod';
+import { MoneySchema } from '../money.schema';
+
+/**
+ * Общая часть строки разреза списаний.
+ *
+ * `key` — устойчивый идентификатор группы (uuid партии или категории, нормализованный
+ * производитель, причина); у групп «Без категории» и «Не указан» — пустая строка.
+ * `receivedCost` — база процента, `share` — доля списаний от неё в процентах с округлением на бэке;
+ * `null` там, где процент не считается, и при нулевой базе.
+ */
+export const WriteOffBreakdownRowBaseSchema = z.object({
+    key: z.string(),
+    label: z.string(),
+    units: z.number(),
+    cost: MoneySchema,
+    receivedCost: MoneySchema.nullable(),
+    share: z.number().nullable(),
+});

package/schemas/report/write-off-breakdown-row.schema.ts

@@ -0,0 +1,13 @@
+import { z } from 'zod';
+import { WriteOffBreakdownCategoryRowSchema } from './write-off-breakdown-category-row.schema';
+import { WriteOffBreakdownConsignmentRowSchema } from './write-off-breakdown-consignment-row.schema';
+import { WriteOffBreakdownGrowerRowSchema } from './write-off-breakdown-grower-row.schema';
+import { WriteOffBreakdownReasonRowSchema } from './write-off-breakdown-reason-row.schema';
+
+/** Строка разреза: форма зависит от `groupBy`, поэтому фронт сужает тип по дискриминатору. */
+export const WriteOffBreakdownRowSchema = z.discriminatedUnion('groupBy', [
+    WriteOffBreakdownConsignmentRowSchema,
+    WriteOffBreakdownGrowerRowSchema,
+    WriteOffBreakdownCategoryRowSchema,
+    WriteOffBreakdownReasonRowSchema,
+]);

package/schemas/report/write-off-breakdown-totals.schema.ts

@@ -0,0 +1,16 @@
+import { z } from 'zod';
+import { MoneySchema } from '../money.schema';
+
+/**
+ * Итог разреза по всем строкам, независимо от `limit`/`offset`.
+ *
+ * `receivedCost` — себестоимость прихода всех партий периода, `share` — доля списаний от него в
+ * процентах. Обе величины есть только на оси `CONSIGNMENT_DELIVERY_DATE`: на оси даты списания
+ * товар мог прийти раньше периода, и делить его на приход периода некорректно.
+ */
+export const WriteOffBreakdownTotalsSchema = z.object({
+    units: z.number(),
+    cost: MoneySchema,
+    receivedCost: MoneySchema.nullable(),
+    share: z.number().nullable(),
+});

package/schemas/report/write-off-by-client-row.schema.ts

@@ -0,0 +1,19 @@
+import { z } from 'zod';
+import { MoneySchema } from '../money.schema';
+
+/**
+ * Клиент со списаниями по заказам периода.
+ *
+ * `revenue` — выручка всех заказов клиента за период (товары по цене продажи, без доставки и
+ * услуг), `share` — `writeOffOrderAmount ÷ revenue` в процентах; `null` при нулевой выручке.
+ */
+export const WriteOffByClientRowSchema = z.object({
+    clientUUID: z.string(),
+    clientName: z.string(),
+    revenue: MoneySchema,
+    ordersWithWriteOff: z.number(),
+    writeOffOrderAmount: MoneySchema,
+    cost: MoneySchema,
+    units: z.number(),
+    share: z.number().nullable(),
+});

package/schemas/report/write-off-by-client-totals.schema.ts

@@ -0,0 +1,18 @@
+import { z } from 'zod';
+import { MoneySchema } from '../money.schema';
+
+/**
+ * Итог разреза по клиентам.
+ *
+ * `revenue` — выручка ВСЕХ клиентов периода, а не только тех, у кого были списания: `share` здесь —
+ * доля брака по клиентам вообще. Она не равна ни сумме, ни среднему долей по строкам.
+ * Списания (`writeOffOrderAmount`, `cost`, `units`) суммируются по всем строкам независимо от
+ * `limit`/`offset`.
+ */
+export const WriteOffByClientTotalsSchema = z.object({
+    revenue: MoneySchema,
+    writeOffOrderAmount: MoneySchema,
+    cost: MoneySchema,
+    units: z.number(),
+    share: z.number().nullable(),
+});

package/schemas/report/write-off-report-page.schema.ts

@@ -0,0 +1,11 @@
+import { z } from 'zod';
+import { REPORT_WRITE_OFF_BREAKDOWN_LIMIT_DEFAULT, REPORT_WRITE_OFF_BREAKDOWN_LIMIT_MAX } from '../../constant/report.constant';
+
+/**
+ * Страница строк разреза списаний. Итоги от неё не зависят; чтобы выбрать список целиком (выгрузка
+ * в Excel), фронт идёт по `offset` с шагом `limit`, пока не наберёт `rowsTotal`.
+ */
+export const WriteOffReportPageSchema = z.object({
+    limit: z.coerce.number().int().positive().max(REPORT_WRITE_OFF_BREAKDOWN_LIMIT_MAX).default(REPORT_WRITE_OFF_BREAKDOWN_LIMIT_DEFAULT),
+    offset: z.coerce.number().int().nonnegative().default(0),
+});

package/schemas/report/write-off-summary-by-client.schema.ts

@@ -0,0 +1,16 @@
+import { z } from 'zod';
+import { MoneySchema } from '../money.schema';
+import { WriteOffSummaryClientRowSchema } from './write-off-summary-client-row.schema';
+
+/**
+ * Списания по заказу: клиенту они уже вернулись на баланс, то есть это выручка, которой по факту
+ * не было.
+ */
+export const WriteOffSummaryByClientSchema = z.object({
+    units: z.number(),
+    cost: MoneySchema,
+    orderAmount: MoneySchema,
+    rows: WriteOffSummaryClientRowSchema.array(),
+    // Сколько клиентов всего — чтобы отличить усечённый ответ от полного.
+    rowsTotal: z.number(),
+});

package/schemas/report/write-off-summary-client-row.schema.ts

@@ -0,0 +1,11 @@
+import { z } from 'zod';
+import { MoneySchema } from '../money.schema';
+
+export const WriteOffSummaryClientRowSchema = z.object({
+    clientUUID: z.string(),
+    clientName: z.string(),
+    orderCount: z.number(),
+    units: z.number(),
+    cost: MoneySchema,
+    orderAmount: MoneySchema,
+});

package/schemas/report/write-off-summary-reason-row.schema.ts

@@ -0,0 +1,10 @@
+import { z } from 'zod';
+import { MoneySchema } from '../money.schema';
+
+export const WriteOffSummaryReasonRowSchema = z.object({
+    // Свободный текст из справочника причин, схлопнут только по краевым пробелам (TRIM).
+    // Регистр не нормализуем: «Брак» и «брак» останутся разными строками.
+    reason: z.string(),
+    units: z.number(),
+    cost: MoneySchema,
+});

package/schemas/report/write-off-summary-totals.schema.ts

@@ -0,0 +1,16 @@
+import { z } from 'zod';
+import { MoneySchema } from '../money.schema';
+
+/**
+ * totals = warehouse + byClient, считается по всем строкам — усечение `clientLimit` на итоги
+ * не влияет.
+ */
+export const WriteOffSummaryTotalsSchema = z.object({
+    units: z.number(),
+    cost: MoneySchema,
+    // Себестоимость прихода партий периода и доля списаний от неё в процентах — только на
+    // оси CONSIGNMENT_DELIVERY_DATE, иначе null: на оси даты списания товар мог прийти
+    // раньше периода, и делить его на приход периода некорректно.
+    receivedCost: MoneySchema.nullable(),
+    share: z.number().nullable(),
+});