@floristcloud/api-lib 1.2.117 → 1.2.119

package/build/commands/client/get-client-debt-list.query.js

@@ -3,15 +3,20 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.GetClientDebtListContractQuery = void 0;
 const zod_1 = require("zod");
 const client_1 = require("../../schemas/client");
+const query_boolean_helper_1 = require("../../helpers/query-boolean.helper");
 const GetClientDebtListRequestSchema = zod_1.z.object({
     page: zod_1.z.coerce.number().optional().default(1),
     count: zod_1.z.coerce.number().optional().default(10),
     responsibleUserUUID: zod_1.z.string().optional(),
     searchQuery: zod_1.z.string().optional(),
     group: zod_1.z.string().optional(),
-    sortBy: zod_1.z.enum(['debtAmount', 'name']).optional().default('debtAmount'),
+    sortBy: zod_1.z.enum(['debtAmount', 'name', 'payableAmount']).optional().default('debtAmount'),
     sortOrder: zod_1.z.enum(['asc', 'desc']).optional().default('desc'),
-    onlyWithDebt: zod_1.z.coerce.boolean().optional().default(false),
+    // `queryBooleanSchema`, а не `z.coerce.boolean()`: в query всегда приходит текст, и
+    // `Boolean('false') === true`, то есть снятый на фронте чекбокс, отправленный явным
+    // `onlyWithDebt=false`, включал бы фильтр вместо того, чтобы его выключить.
+    onlyWithDebt: query_boolean_helper_1.queryBooleanSchema,
+    onlyOverdue: query_boolean_helper_1.queryBooleanSchema,
     clientUUIDList: zod_1.z.array(zod_1.z.string().uuid()).optional(),
 });
 const GetClientDebtListResponseSchema = zod_1.z.object({

package/build/commands/order/get-order-list.query.js

@@ -4,6 +4,7 @@ exports.GetOrderListContractQuery = void 0;
 const zod_1 = require("zod");
 const schemas_1 = require("../../schemas");
 const date_helper_1 = require("../../helpers/date.helper");
+const query_boolean_helper_1 = require("../../helpers/query-boolean.helper");
 const enum_1 = require("../../enum");
 const GetOrderListRequestSchema = zod_1.z
     .object({
@@ -28,6 +29,10 @@ const GetOrderListRequestSchema = zod_1.z
     // Только заказы, ещё не включённые ни в один счёт на оплату — список для пикера при
     // выставлении счёта. Комбинируется с остальными критериями обычным AND.
     withoutPaymentInvoice: zod_1.z.coerce.boolean().optional(),
+    // То же для передаточного документа — пикер заказов при выпуске УПД. Здесь `queryBooleanSchema`,
+    // а не `z.coerce.boolean()`: в query всегда приходит текст, и `Boolean('false') === true`,
+    // то есть флаг соседа невозможно выключить явным значением, только опустив параметр.
+    withoutTransferDocument: query_boolean_helper_1.queryBooleanSchema,
 })
     .refine(value => {
     const { startDate, endDate } = value;

package/build/schemas/client/client-debt.schema.js

@@ -1,8 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ClientDebtListSchema = exports.ClientDebtItemSchema = void 0;
+exports.ClientDebtListSchema = exports.ClientDebtSummarySchema = exports.ClientDebtItemSchema = void 0;
 const zod_1 = require("zod");
 const money_schema_1 = require("../money.schema");
+const non_negative_money_schema_1 = require("../non-negative-money.schema");
 exports.ClientDebtItemSchema = zod_1.z.object({
     clientUUID: zod_1.z.uuid(),
     name: zod_1.z.string(),
@@ -10,16 +11,44 @@ exports.ClientDebtItemSchema = zod_1.z.object({
     group: zod_1.z.string().nullable(),
     city: zod_1.z.string().nullable(),
     responsibleUserName: zod_1.z.string().nullable(),
+    // Сальдо клиента как оно лежит в `client.balance`: минус — клиент должен, плюс — переплата.
     currentBalance: money_schema_1.MoneySchema,
+    // То же сальдо, отсечённое по нулю, — «сколько должен». У переплативших клиентов ноль,
+    // поэтому колонку можно суммировать, не рискуя погасить чужой долг чужой переплатой.
+    debtAmount: non_negative_money_schema_1.NonNegativeMoneySchema,
     // Знаковые величины: сальдо транзакций и остатки по заказам законно уходят в минус
     // (переплата клиента, возврат), поэтому ограничения на знак здесь нет и быть не должно.
     transactionNet: money_schema_1.MoneySchema,
+    // Все завершённые заказы = просроченные + те, по которым срок оплаты ещё не наступил.
+    // Тождество выполняется построчно: completedOrdersBalance = completedOrdersBalanceWithDelay + withinGraceAmount.
     completedOrdersBalance: money_schema_1.MoneySchema,
     completedOrdersBalanceWithDelay: money_schema_1.MoneySchema,
+    withinGraceAmount: money_schema_1.MoneySchema,
     nonCompletedBalance: money_schema_1.MoneySchema,
+    // Долг за вычетом заказов в работе и заказов в непросроченной отсрочке — то, что фактически к уплате.
+    // Уже отсечён по нулю: переплата даёт 0, а не отрицательную величину.
+    payableAmount: non_negative_money_schema_1.NonNegativeMoneySchema,
     hasOverdueDebt: zod_1.z.boolean().nullable(),
 });
+/**
+ * Итоги по всей отфильтрованной выборке, а не по странице.
+ *
+ * Каждое поле — сумма ровно одной колонки строки, поэтому итог всегда сходится с тем, что
+ * пользователь видит в таблице. Складывать итоги между собой нельзя: `debt` и `payable`
+ * отсечены по нулю построчно, и вычитание одного из другого даёт не ту величину, что
+ * `payable`. Единственное тождество, которое выполняется и в строке, и в итогах, —
+ * `overdue + withinGrace = сумма completedOrdersBalance` (там нет отсечки).
+ */
+exports.ClientDebtSummarySchema = zod_1.z.object({
+    balance: money_schema_1.MoneySchema,
+    debt: non_negative_money_schema_1.NonNegativeMoneySchema,
+    nonCompleted: money_schema_1.MoneySchema,
+    overdue: money_schema_1.MoneySchema,
+    withinGrace: money_schema_1.MoneySchema,
+    payable: non_negative_money_schema_1.NonNegativeMoneySchema,
+});
 exports.ClientDebtListSchema = zod_1.z.object({
     clientList: exports.ClientDebtItemSchema.array(),
     total: zod_1.z.number(),
+    summary: exports.ClientDebtSummarySchema,
 });

package/build/schemas/order/order.schema.js

@@ -36,17 +36,23 @@ exports.OrderSchema = zod_1.z.object({
     // Счёт на оплату, в который включён заказ. Сам счёт (номер, файл, статус оплаты) читается
     // отдельным запросом GET /payment-invoice/:uuid — здесь только ссылка, чтобы не утяжелять список заказов.
     paymentInvoiceUUID: zod_1.z.uuid().nullable(),
+    // Передаточный документ (УПД), в который включён заказ. Тем же приёмом, что и счёт: здесь только
+    // ссылка, документ читается через GET /transfer-document/:uuid. Непустое значение означает, что
+    // заказ заморожен — состав, статус, доставка, дата отгрузки и скидка ему уже недоступны.
+    transferDocumentUUID: zod_1.z.uuid().nullable(),
     completedAt: zod_1.z.date().nullable(),
     paymentDueAt: zod_1.z.date().nullable(),
     createdAt: zod_1.z.date(),
     updatedAt: zod_1.z.date(),
     deletedAt: zod_1.z.date().nullable(),
 });
-// Витрина клиента не показывает внутреннюю кухню счетов, поэтому ссылка на счёт сюда не попадает.
+// Витрина клиента не показывает внутреннюю кухню документов, поэтому ссылки на счёт и на УПД
+// сюда не попадают.
 exports.OrderForClientSchema = exports.OrderSchema.omit({
     comment: true,
     tag: true,
     paymentInvoiceUUID: true,
+    transferDocumentUUID: true,
 });
 exports.OrderExtendedSchema = exports.OrderSchema.extend({
     client: client_1.ClientSchema,

package/commands/client/get-client-debt-list.query.ts

@@ -1,5 +1,6 @@
 import { z } from 'zod';
 import { ClientDebtListSchema } from '../../schemas/client';
+import { queryBooleanSchema } from '../../helpers/query-boolean.helper';
 
 const GetClientDebtListRequestSchema = z.object({
     page: z.coerce.number().optional().default(1),
@@ -7,9 +8,13 @@ const GetClientDebtListRequestSchema = z.object({
     responsibleUserUUID: z.string().optional(),
     searchQuery: z.string().optional(),
     group: z.string().optional(),
-    sortBy: z.enum(['debtAmount', 'name']).optional().default('debtAmount'),
+    sortBy: z.enum(['debtAmount', 'name', 'payableAmount']).optional().default('debtAmount'),
     sortOrder: z.enum(['asc', 'desc']).optional().default('desc'),
-    onlyWithDebt: z.coerce.boolean().optional().default(false),
+    // `queryBooleanSchema`, а не `z.coerce.boolean()`: в query всегда приходит текст, и
+    // `Boolean('false') === true`, то есть снятый на фронте чекбокс, отправленный явным
+    // `onlyWithDebt=false`, включал бы фильтр вместо того, чтобы его выключить.
+    onlyWithDebt: queryBooleanSchema,
+    onlyOverdue: queryBooleanSchema,
     clientUUIDList: z.array(z.string().uuid()).optional(),
 });
 

package/commands/order/get-order-list.query.ts

@@ -1,6 +1,7 @@
 import { z } from 'zod';
 import { OrderExtendedSchema } from '../../schemas';
 import { dateRangeCheck } from '../../helpers/date.helper';
+import { queryBooleanSchema } from '../../helpers/query-boolean.helper';
 import { OrderStatusEnum, OrderTypeEnum } from '../../enum';
 
 const GetOrderListRequestSchema = z
@@ -26,6 +27,10 @@ const GetOrderListRequestSchema = z
         // Только заказы, ещё не включённые ни в один счёт на оплату — список для пикера при
         // выставлении счёта. Комбинируется с остальными критериями обычным AND.
         withoutPaymentInvoice: z.coerce.boolean().optional(),
+        // То же для передаточного документа — пикер заказов при выпуске УПД. Здесь `queryBooleanSchema`,
+        // а не `z.coerce.boolean()`: в query всегда приходит текст, и `Boolean('false') === true`,
+        // то есть флаг соседа невозможно выключить явным значением, только опустив параметр.
+        withoutTransferDocument: queryBooleanSchema,
     })
     .refine(
         value => {

package/package.json

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

package/schemas/client/client-debt.schema.ts

@@ -1,5 +1,6 @@
 import { z } from 'zod';
 import { MoneySchema } from '../money.schema';
+import { NonNegativeMoneySchema } from '../non-negative-money.schema';
 
 export const ClientDebtItemSchema = z.object({
     clientUUID: z.uuid(),
@@ -8,17 +9,46 @@ export const ClientDebtItemSchema = z.object({
     group: z.string().nullable(),
     city: z.string().nullable(),
     responsibleUserName: z.string().nullable(),
+    // Сальдо клиента как оно лежит в `client.balance`: минус — клиент должен, плюс — переплата.
     currentBalance: MoneySchema,
+    // То же сальдо, отсечённое по нулю, — «сколько должен». У переплативших клиентов ноль,
+    // поэтому колонку можно суммировать, не рискуя погасить чужой долг чужой переплатой.
+    debtAmount: NonNegativeMoneySchema,
     // Знаковые величины: сальдо транзакций и остатки по заказам законно уходят в минус
     // (переплата клиента, возврат), поэтому ограничения на знак здесь нет и быть не должно.
     transactionNet: MoneySchema,
+    // Все завершённые заказы = просроченные + те, по которым срок оплаты ещё не наступил.
+    // Тождество выполняется построчно: completedOrdersBalance = completedOrdersBalanceWithDelay + withinGraceAmount.
     completedOrdersBalance: MoneySchema,
     completedOrdersBalanceWithDelay: MoneySchema,
+    withinGraceAmount: MoneySchema,
     nonCompletedBalance: MoneySchema,
+    // Долг за вычетом заказов в работе и заказов в непросроченной отсрочке — то, что фактически к уплате.
+    // Уже отсечён по нулю: переплата даёт 0, а не отрицательную величину.
+    payableAmount: NonNegativeMoneySchema,
     hasOverdueDebt: z.boolean().nullable(),
 });
 
+/**
+ * Итоги по всей отфильтрованной выборке, а не по странице.
+ *
+ * Каждое поле — сумма ровно одной колонки строки, поэтому итог всегда сходится с тем, что
+ * пользователь видит в таблице. Складывать итоги между собой нельзя: `debt` и `payable`
+ * отсечены по нулю построчно, и вычитание одного из другого даёт не ту величину, что
+ * `payable`. Единственное тождество, которое выполняется и в строке, и в итогах, —
+ * `overdue + withinGrace = сумма completedOrdersBalance` (там нет отсечки).
+ */
+export const ClientDebtSummarySchema = z.object({
+    balance: MoneySchema,
+    debt: NonNegativeMoneySchema,
+    nonCompleted: MoneySchema,
+    overdue: MoneySchema,
+    withinGrace: MoneySchema,
+    payable: NonNegativeMoneySchema,
+});
+
 export const ClientDebtListSchema = z.object({
     clientList: ClientDebtItemSchema.array(),
     total: z.number(),
+    summary: ClientDebtSummarySchema,
 });

package/schemas/order/order.schema.ts

@@ -38,6 +38,10 @@ export const OrderSchema = z.object({
     // Счёт на оплату, в который включён заказ. Сам счёт (номер, файл, статус оплаты) читается
     // отдельным запросом GET /payment-invoice/:uuid — здесь только ссылка, чтобы не утяжелять список заказов.
     paymentInvoiceUUID: z.uuid().nullable(),
+    // Передаточный документ (УПД), в который включён заказ. Тем же приёмом, что и счёт: здесь только
+    // ссылка, документ читается через GET /transfer-document/:uuid. Непустое значение означает, что
+    // заказ заморожен — состав, статус, доставка, дата отгрузки и скидка ему уже недоступны.
+    transferDocumentUUID: z.uuid().nullable(),
 
     completedAt: z.date().nullable(),
     paymentDueAt: z.date().nullable(),
@@ -47,11 +51,13 @@ export const OrderSchema = z.object({
     deletedAt: z.date().nullable(),
 });
 
-// Витрина клиента не показывает внутреннюю кухню счетов, поэтому ссылка на счёт сюда не попадает.
+// Витрина клиента не показывает внутреннюю кухню документов, поэтому ссылки на счёт и на УПД
+// сюда не попадают.
 export const OrderForClientSchema = OrderSchema.omit({
     comment: true,
     tag: true,
     paymentInvoiceUUID: true,
+    transferDocumentUUID: true,
 });
 
 export const OrderExtendedSchema = OrderSchema.extend({