@floristcloud/api-lib 1.2.107 → 1.2.108

package/commands/settings/get-company-profile.query.ts

@@ -0,0 +1,24 @@
+import { z } from 'zod';
+
+/**
+ * Company-level facts every panel role may read: who the company is, how it is named, which time
+ * zone its calendar days are counted in and which currency its figures are in. `companyUUID` is
+ * echoed so a caller can prove the profile belongs to its own tenant — the ADMIN-only
+ * `settings/for-admin` answer carries no such marker and cannot be cross-checked.
+ */
+const CompanyProfileSchema = z.object({
+    companyUUID: z.string(),
+    companyName: z.string().nullable(),
+    timeZone: z.string().nullable(),
+    currency: z.string().nullable(),
+});
+
+const GetCompanyProfileResponseSchema = z.object({
+    message: z.string().optional(),
+    data: CompanyProfileSchema,
+});
+
+export namespace GetCompanyProfileContractQuery {
+    export const ResponseSchema = GetCompanyProfileResponseSchema;
+    export type Response = z.infer<typeof ResponseSchema>;
+}

package/commands/settings/index.ts

@@ -1,3 +1,4 @@
 export * from './get-settings.query';
 export * from './update-settings.command';
 export * from './get-settings-for-admin.query';
+export * from './get-company-profile.query';

package/enum/client-contract-status.enum.ts

@@ -0,0 +1,9 @@
+export enum ClientContractStatusEnum {
+    NONE = 'NONE',
+    REQUIRED = 'REQUIRED',
+    PREPARED = 'PREPARED',
+    SENT = 'SENT',
+    SIGNED = 'SIGNED',
+    EXPIRED = 'EXPIRED',
+    TERMINATED = 'TERMINATED',
+}

package/enum/index.ts

@@ -36,6 +36,7 @@ export * from './order-distribute-status-list';
 export * from './order-active-status-list';
 export * from './order-price-correction-skipped-status-list';
 export * from './client-status.enum';
+export * from './client-contract-status.enum';
 export * from './client-type.enum';
 export * from './consignment-distribution-validation-status.enum';
 export * from './consignment-distribution-validation-type.enum';
@@ -95,3 +96,5 @@ export * from './legal-identifier-field.enum';
 export * from './permission-key.enum';
 export * from './cash-flow-item-status.enum';
 export * from './payment-invoice-status.enum';
+export * from './order-by.enum';
+export * from './report-sort-by.enum';

package/enum/report-sort-by.enum.ts

@@ -0,0 +1,9 @@
+/**
+ * Метрика сортировки для отчётов-группировок (по позициям и по клиентам).
+ * Значения совпадают с именами полей ответа, чтобы клиент мог сортировать «по тому, что видит».
+ */
+export enum ReportSortByEnum {
+    GROSS_PROFIT = 'grossProfit',
+    TOTAL_SALES = 'totalSales',
+    SOLD_UNITS = 'soldUnits',
+}

package/helpers/index.ts

@@ -1 +1,3 @@
 export * from './date.helper';
+export * from './pagination.helper';
+export * from './query-boolean.helper';

package/helpers/pagination.helper.ts

@@ -0,0 +1,9 @@
+/**
+ * `page` имеет смысл только вместе с `count`.
+ *
+ * Раньше `page` без `count` молча игнорировался и отчёт отдавался целиком: агент, листающий
+ * страницы, бесконечно получал одну и ту же выдачу и не мог отличить это от «страниц больше нет».
+ * Поэтому неполная пара отклоняется валидацией — единообразно во всех постраничных отчётах.
+ */
+export const isPageAccompaniedByCount = (value: { page?: number; count?: number }): boolean =>
+    value.page === undefined || value.count !== undefined;

package/helpers/query-boolean.helper.ts

@@ -0,0 +1,14 @@
+import { z } from 'zod';
+
+/**
+ * Boolean-флаг, приходящий в query-строке.
+ *
+ * Не `z.coerce.boolean()`: в query всегда приходит текст, а `Boolean('false') === true` —
+ * такой флаг невозможно выключить явным значением. Принимаем `true` / `1` как включение,
+ * всё остальное — выключение. По умолчанию флаг выключен, чтобы поведение без параметра не менялось.
+ */
+export const queryBooleanSchema = z
+    .union([z.boolean(), z.string()])
+    .optional()
+    .default(false)
+    .transform(value => (typeof value === 'boolean' ? value : value === 'true' || value === '1'));

package/package.json

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

package/schemas/client/client.schema.ts

@@ -1,5 +1,6 @@
 import { z } from 'zod';
 import { ClientStatusEnum } from '../../enum/client-status.enum';
+import { ClientContractStatusEnum } from '../../enum/client-contract-status.enum';
 import { ClientTypeEnum } from '../../enum/client-type.enum';
 import { UserSchema } from '../user/user.schema';
 import { ClientIndividualProfileSchema } from './client-individual-profile.schema';
@@ -17,6 +18,7 @@ export const ClientSchema = z.object({
     isCommon: z.boolean(),
     contractNumber: z.string().nullable(),
     contractDate: z.date().nullable(),
+    contractStatus: z.nativeEnum(ClientContractStatusEnum),
     address: z.string().nullable(),
     city: z.string().nullable(),
     code: z.string().nullable(),

package/schemas/index.ts

@@ -22,6 +22,7 @@ export * from './product-image/product-image.schema';
 export * from './settings/settings.schema';
 export * from './payment-invoice/payment-invoice.schema';
 export * from './money-account/money-account.schema';
+export * from './money-account/money-account-with-balance.schema';
 export * from './domain/domain.schema';
 export * from './category/category.schema';
 export * from './branch/branch.schema';
@@ -52,6 +53,12 @@ export * from './consignment/consignment-distribution-validation.schema';
 export * from './product-image-template/product-image-template.schema';
 export * from './report/client-statement.schema';
 export * from './report/client-by-weeks.schema';
+export * from './report/inventory-stock-category-item.schema';
+export * from './report/inventory-stock-detailed-item.schema';
+export * from './report/inventory-turnover-category-item.schema';
+export * from './report/inventory-turnover-detailed-item.schema';
+export * from './report/sales-by-client-top-item.schema';
+export * from './report/sales-by-client-row.schema';
 export * from './action-log/index';
 export * from './delivery-route/delivery-route.schema';
 export * from './product/product-multiplicity-option.schema';

package/schemas/money-account/money-account-with-balance.schema.ts

@@ -0,0 +1,11 @@
+import { z } from 'zod';
+import { MoneyAccountSchema } from './money-account.schema';
+
+/**
+ * Денежный счёт в ответах списков. `balance` — текущий остаток счёта (приход минус расход),
+ * приходит только при `?withBalance=true`: поле аддитивное, клиенты без этого параметра
+ * получают ровно прежнюю форму ответа.
+ */
+export const MoneyAccountWithBalanceSchema = MoneyAccountSchema.extend({
+    balance: z.number().optional(),
+});

package/schemas/report/inventory-stock-category-item.schema.ts

@@ -0,0 +1,8 @@
+import { z } from 'zod';
+
+/** Строка отчёта об остатках в разрезе категорий (`detailed=false`). */
+export const InventoryStockCategoryItemSchema = z.object({
+    categoryUUID: z.string(),
+    categoryName: z.string(),
+    balance: z.number(),
+});

package/schemas/report/inventory-stock-detailed-item.schema.ts

@@ -0,0 +1,12 @@
+import { z } from 'zod';
+
+/** Строка отчёта об остатках с детализацией по name/size/grower (`detailed=true`). */
+export const InventoryStockDetailedItemSchema = z.object({
+    categoryUUID: z.string(),
+    categoryName: z.string(),
+    name: z.string(),
+    color: z.string().nullable(),
+    size: z.string().nullable(),
+    grower: z.string().nullable(),
+    balance: z.number(),
+});

package/schemas/report/inventory-turnover-category-item.schema.ts

@@ -0,0 +1,13 @@
+import { z } from 'zod';
+
+/** Строка отчёта об оборачиваемости в разрезе категорий (`detailed=false`). */
+export const InventoryTurnoverCategoryItemSchema = z.object({
+    categoryUUID: z.string(),
+    categoryName: z.string(),
+    initialBalance: z.number(), // начальный остаток
+    receipts: z.number(), // приходы
+    sales: z.number(), // продажи
+    currentBalance: z.number(), // текущий остаток
+    daysInStock: z.number(), // дни в наличии на складе
+    turnoverRate: z.number(), // коэффициент оборачиваемости
+});

package/schemas/report/inventory-turnover-detailed-item.schema.ts

@@ -0,0 +1,17 @@
+import { z } from 'zod';
+
+/** Строка отчёта об оборачиваемости с детализацией по name/size/grower (`detailed=true`). */
+export const InventoryTurnoverDetailedItemSchema = z.object({
+    categoryUUID: z.string(),
+    categoryName: z.string(),
+    name: z.string(),
+    color: z.string().nullable(),
+    size: z.string().nullable(),
+    grower: z.string().nullable(), // производитель
+    initialBalance: z.number(), // начальный остаток
+    receipts: z.number(), // приходы
+    sales: z.number(), // продажи
+    currentBalance: z.number(), // текущий остаток
+    daysInStock: z.number(), // дни в наличии на складе
+    turnoverRate: z.number(), // коэффициент оборачиваемости
+});

package/schemas/report/sales-by-client-row.schema.ts

@@ -0,0 +1,43 @@
+import { z } from 'zod';
+import { SalesByClientTopItemSchema } from './sales-by-client-top-item.schema';
+
+/**
+ * Строка отчёта «продажи по клиентам» — те же данные, что уходят в Excel из `export/sales/clients`.
+ * Опциональные поля отсутствуют в ответе, когда у клиента нет соответствующего значения.
+ */
+export const SalesByClientRowSchema = z.object({
+    uuid: z.string(),
+    clientName: z.string(),
+    responsibleUserName: z.string().optional(),
+    totalOrders: z.number(),
+    soldUnits: z.number(),
+    soldUnitsByUnit: z.object({
+        PIECE: z.number(),
+        PACK: z.number(),
+        BOX: z.number(),
+    }),
+    totalSales: z.number(),
+    avgCheck: z.number(),
+    totalWriteOff: z.number(),
+    grossProfit: z.number(),
+    marginality: z.number(),
+    // Оплаты (INCOME) и предоплаты (PREPAYMENT) клиента за период
+    totalPayments: z.number(),
+    totalPrepayments: z.number(),
+    // Сумма услуг (order_service_line) за период — отдельно, вне товарных sales/margin
+    totalServiceAmount: z.number(),
+    // Текущий баланс клиента (на момент формирования отчёта)
+    balance: z.number(),
+    lastOrderDate: z.coerce.date().optional(),
+    // Топ-5 по сумме выручки за период
+    topCategories: z.array(SalesByClientTopItemSchema),
+    topProducts: z.array(SalesByClientTopItemSchema),
+    // Статическая информация о клиенте
+    code: z.string().optional(),
+    city: z.string().optional(),
+    contactName: z.string().optional(),
+    phone: z.string().optional(),
+    clientType: z.string().optional(),
+    status: z.string().optional(),
+    group: z.string().optional(),
+});

package/schemas/report/sales-by-client-top-item.schema.ts

@@ -0,0 +1,7 @@
+import { z } from 'zod';
+
+/** Элемент топа (категория или товар) внутри строки отчёта «продажи по клиентам». */
+export const SalesByClientTopItemSchema = z.object({
+    name: z.string(),
+    amount: z.number(),
+});