@floristcloud/api-lib 1.2.150 → 1.2.151

package/schemas/action-log/index.ts

@@ -23,3 +23,61 @@ export * from './group-update-consignment-items-action-log.schema';
 export * from './transfer-consignment-items-action-log.schema';
 export * from './action-log-money.schema';
 export * from './import-transactions-action-log.schema';
+export * from './order-discount-action-log.schema';
+export * from './order-service-line-info.schema';
+export * from './order-service-line-create-action-log.schema';
+export * from './order-service-line-update-action-log.schema';
+export * from './order-service-line-delete-action-log.schema';
+export * from './order-delivery-info.schema';
+export * from './order-delivery-create-action-log.schema';
+export * from './order-delivery-update-action-log.schema';
+export * from './order-delivery-delete-action-log.schema';
+export * from './order-split-action-log.schema';
+export * from './order-items-tag-update-action-log.schema';
+export * from './pre-order-status-update-action-log.schema';
+export * from './pre-order-fields-update-action-log.schema';
+export * from './pre-order-merge-action-log.schema';
+export * from './pre-order-convert-action-log.schema';
+export * from './pre-order-from-standing-order-action-log.schema';
+export * from './standing-order-create-action-log.schema';
+export * from './pre-order-copy-action-log.schema';
+export * from './pre-order-items-purchase-action-log.schema';
+export * from './consignment-info.schema';
+export * from './consignment-create-action-log.schema';
+export * from './consignment-update-action-log.schema';
+export * from './consignment-delete-action-log.schema';
+export * from './consignment-access-client-info.schema';
+export * from './consignment-access-clients-action-log.schema';
+export * from './consignment-distribute-action-log.schema';
+export * from './payment-update-action-log.schema';
+export * from './payment-apply-prepayment-action-log.schema';
+export * from './payment-assign-cash-flow-item-action-log.schema';
+export * from './write-off-info.schema';
+export * from './write-off-create-action-log.schema';
+export * from './write-off-status-update-action-log.schema';
+export * from './write-off-price-update-action-log.schema';
+export * from './write-off-delete-action-log.schema';
+export * from './payment-invoice-info.schema';
+export * from './payment-invoice-create-action-log.schema';
+export * from './payment-invoice-delete-action-log.schema';
+export * from './transfer-document-info.schema';
+export * from './transfer-document-create-action-log.schema';
+export * from './transfer-document-issue-action-log.schema';
+export * from './transfer-document-delete-action-log.schema';
+export * from './client-info.schema';
+export * from './client-create-action-log.schema';
+export * from './client-update-action-log.schema';
+export * from './client-delete-action-log.schema';
+export * from './client-responsible-action-log.schema';
+export * from './collection-item-info.schema';
+export * from './collection-item-ref.schema';
+export * from './collection-items-create-action-log.schema';
+export * from './collection-item-update-action-log.schema';
+export * from './collection-items-group-update-action-log.schema';
+export * from './collection-items-delete-action-log.schema';
+export * from './collection-items-move-action-log.schema';
+export * from './collection-item-multiplicity-option-info.schema';
+export * from './collection-item-multiplicity-options-action-log.schema';
+export * from './client-marking-action-log.schema';
+export * from './client-profile-action-log.schema';
+export * from './pre-order-collection-copy-action-log.schema';

package/schemas/action-log/order-delivery-create-action-log.schema.ts

@@ -0,0 +1,7 @@
+import { z } from 'zod';
+import { OrderDeliveryInfoSchema } from './order-delivery-info.schema';
+
+/** Доставка, добавленная к заказу. */
+export const OrderDeliveryCreateActionLogSchema = z.object({
+    delivery: OrderDeliveryInfoSchema,
+});

package/schemas/action-log/order-delivery-delete-action-log.schema.ts

@@ -0,0 +1,7 @@
+import { z } from 'zod';
+import { OrderDeliveryInfoSchema } from './order-delivery-info.schema';
+
+/** Доставка, удалённая у заказа. */
+export const OrderDeliveryDeleteActionLogSchema = z.object({
+    delivery: OrderDeliveryInfoSchema,
+});

package/schemas/action-log/order-delivery-info.schema.ts

@@ -0,0 +1,14 @@
+import { z } from 'zod';
+import { OrderDeliveryStatusEnum } from '../../enum/order-delivery-status.enum';
+
+/** Снимок доставки заказа на момент события. */
+export const OrderDeliveryInfoSchema = z.object({
+    orderUUID: z.string(),
+    deliveryUUID: z.string(),
+    deliveryDate: z.coerce.date().nullable(),
+    city: z.string().nullable(),
+    address: z.string().nullable(),
+    time: z.string().nullable(),
+    comment: z.string().nullable(),
+    status: z.nativeEnum(OrderDeliveryStatusEnum),
+});

package/schemas/action-log/order-delivery-update-action-log.schema.ts

@@ -0,0 +1,20 @@
+import { z } from 'zod';
+import { OrderDeliveryInfoSchema } from './order-delivery-info.schema';
+import { OrderDeliveryUpdatedFieldEnum } from '../../enum/order-delivery-updated-field.enum';
+
+/**
+ * Правка доставки: снимок до правки и список изменённых полей. Значения строками, как у правки
+ * заказа: журнал показывает снимок, а одна форма на все поля избавляет от ветвления при отрисовке.
+ */
+export const OrderDeliveryUpdateActionLogSchema = z.object({
+    delivery: OrderDeliveryInfoSchema,
+    changes: z
+        .array(
+            z.object({
+                field: z.nativeEnum(OrderDeliveryUpdatedFieldEnum),
+                oldValue: z.string().nullable(),
+                newValue: z.string().nullable(),
+            }),
+        )
+        .min(1),
+});

package/schemas/action-log/order-discount-action-log.schema.ts

@@ -0,0 +1,13 @@
+import { z } from 'zod';
+import { ActionLogMoneySchema } from './action-log-money.schema';
+
+/**
+ * Скидка на заказ: процент и итог до и после. Скидка переписывает цены позиций и сумму заказа,
+ * а с ней и баланс клиента, поэтому в записи обе величины, а не только процент.
+ */
+export const OrderDiscountActionLogSchema = z.object({
+    oldDiscount: z.string().nullable(),
+    newDiscount: z.string().nullable(),
+    oldTotalCost: ActionLogMoneySchema,
+    newTotalCost: ActionLogMoneySchema,
+});

package/schemas/action-log/order-items-tag-update-action-log.schema.ts

@@ -0,0 +1,15 @@
+import { z } from 'zod';
+
+/** Групповая смена метки у позиций заказа: одна запись на действие со списком затронутых позиций. */
+export const OrderItemsTagUpdateActionLogSchema = z.object({
+    tag: z.string().nullable(),
+    count: z.number(),
+    products: z.array(
+        z.object({
+            orderProductUUID: z.string(),
+            productUUID: z.string(),
+            productName: z.string(),
+            previousTag: z.string().nullable(),
+        }),
+    ),
+});

package/schemas/action-log/order-service-line-create-action-log.schema.ts

@@ -0,0 +1,7 @@
+import { z } from 'zod';
+import { OrderServiceLineInfoSchema } from './order-service-line-info.schema';
+
+/** Услуга, добавленная в заказ. */
+export const OrderServiceLineCreateActionLogSchema = z.object({
+    serviceLine: OrderServiceLineInfoSchema,
+});

package/schemas/action-log/order-service-line-delete-action-log.schema.ts

@@ -0,0 +1,7 @@
+import { z } from 'zod';
+import { OrderServiceLineInfoSchema } from './order-service-line-info.schema';
+
+/** Услуга, удалённая из заказа. */
+export const OrderServiceLineDeleteActionLogSchema = z.object({
+    serviceLine: OrderServiceLineInfoSchema,
+});

package/schemas/action-log/order-service-line-info.schema.ts

@@ -0,0 +1,16 @@
+import { z } from 'zod';
+import { ActionLogMoneySchema } from './action-log-money.schema';
+import { ServicePricingUnitEnum } from '../../enum/service-pricing-unit.enum';
+
+/** Снимок услуги в заказе на момент события: название, количество, цена и сумма. */
+export const OrderServiceLineInfoSchema = z.object({
+    orderUUID: z.string(),
+    serviceLineUUID: z.string(),
+    serviceUUID: z.string().nullable(),
+    name: z.string(),
+    quantity: z.number(),
+    price: ActionLogMoneySchema,
+    amount: ActionLogMoneySchema,
+    unit: z.nativeEnum(ServicePricingUnitEnum),
+    comment: z.string().nullable(),
+});

package/schemas/action-log/order-service-line-update-action-log.schema.ts

@@ -0,0 +1,11 @@
+import { z } from 'zod';
+import { ActionLogMoneySchema } from './action-log-money.schema';
+import { OrderServiceLineInfoSchema } from './order-service-line-info.schema';
+
+/** Правка услуги в заказе: снимок до правки и новые значения, как у позиции предзаказа. */
+export const OrderServiceLineUpdateActionLogSchema = z.object({
+    serviceLine: OrderServiceLineInfoSchema,
+    newQuantity: z.number(),
+    newPrice: ActionLogMoneySchema,
+    newComment: z.string().nullable(),
+});

package/schemas/action-log/order-split-action-log.schema.ts

@@ -0,0 +1,19 @@
+import { z } from 'zod';
+
+/**
+ * Разделение заказа по датам поставок. Запись ложится в журнал исходного заказа и каждого
+ * созданного: журнал фильтруется по одному entityUUID, и с одной стороны позиции иначе появлялись
+ * бы из ниоткуда. `isSourceDeleted` — исходный заказ опустел и удалён.
+ */
+export const OrderSplitActionLogSchema = z.object({
+    sourceOrderUUID: z.string(),
+    sourceOrderId: z.coerce.number(),
+    createdOrders: z.array(
+        z.object({
+            orderUUID: z.string(),
+            orderId: z.coerce.number(),
+            count: z.number(),
+        }),
+    ),
+    isSourceDeleted: z.boolean(),
+});

package/schemas/action-log/payment-apply-prepayment-action-log.schema.ts

@@ -0,0 +1,12 @@
+import { z } from 'zod';
+import { TransactionInfoSchema } from './transaction-info.schema';
+
+/**
+ * Зачёт предоплаты в заказ. Запись ложится в журнал платежа и заказа: с одной стороны предоплата
+ * «израсходована», с другой у заказа появились деньги, и обе стороны должны видеть связь.
+ */
+export const PaymentApplyPrepaymentActionLogSchema = z.object({
+    transaction: TransactionInfoSchema,
+    orderUUID: z.string().nullable(),
+    orderId: z.coerce.number().nullable(),
+});

package/schemas/action-log/payment-assign-cash-flow-item-action-log.schema.ts

@@ -0,0 +1,12 @@
+import { z } from 'zod';
+
+/**
+ * Привязка статьи ДДС к платежам. Статья определяет, в какую строку отчёта о движении денег попадёт
+ * платёж. Операция групповая: запись ложится в журнал каждого платежа с общим списком затронутых.
+ */
+export const PaymentAssignCashFlowItemActionLogSchema = z.object({
+    cashFlowItemUUID: z.string().nullable(),
+    cashFlowItemName: z.string().nullable(),
+    count: z.number(),
+    transactionUUIDs: z.array(z.string()),
+});

package/schemas/action-log/payment-invoice-create-action-log.schema.ts

@@ -0,0 +1,7 @@
+import { z } from 'zod';
+import { PaymentInvoiceInfoSchema } from './payment-invoice-info.schema';
+
+/** Выставлен счёт на оплату: документ уходит контрагенту, а раньше писалась только его оплата. */
+export const PaymentInvoiceCreateActionLogSchema = z.object({
+    paymentInvoice: PaymentInvoiceInfoSchema,
+});

package/schemas/action-log/payment-invoice-delete-action-log.schema.ts

@@ -0,0 +1,7 @@
+import { z } from 'zod';
+import { PaymentInvoiceInfoSchema } from './payment-invoice-info.schema';
+
+/** Удалён счёт на оплату: заказы отвязываются от него и снова доступны для другого счёта. */
+export const PaymentInvoiceDeleteActionLogSchema = z.object({
+    paymentInvoice: PaymentInvoiceInfoSchema,
+});

package/schemas/action-log/payment-invoice-info.schema.ts

@@ -0,0 +1,12 @@
+import { z } from 'zod';
+import { ActionLogMoneySchema } from './action-log-money.schema';
+
+/** Снимок счёта на оплату на момент события. */
+export const PaymentInvoiceInfoSchema = z.object({
+    paymentInvoiceUUID: z.string(),
+    number: z.string(),
+    invoiceDate: z.coerce.date(),
+    amount: ActionLogMoneySchema,
+    clientUUID: z.string(),
+    orderUUIDs: z.array(z.string()),
+});

package/schemas/action-log/payment-update-action-log.schema.ts

@@ -0,0 +1,20 @@
+import { z } from 'zod';
+import { TransactionInfoSchema } from './transaction-info.schema';
+import { PaymentUpdatedFieldEnum } from '../../enum/payment-updated-field.enum';
+
+/**
+ * Правка платежа: снимок до правки и изменённые поля. Журнал знал только создание и удаление,
+ * поэтому смена даты или статьи ДДС проходила бесследно, хотя двигает отчёты по деньгам.
+ */
+export const PaymentUpdateActionLogSchema = z.object({
+    transaction: TransactionInfoSchema,
+    changes: z
+        .array(
+            z.object({
+                field: z.nativeEnum(PaymentUpdatedFieldEnum),
+                oldValue: z.string().nullable(),
+                newValue: z.string().nullable(),
+            }),
+        )
+        .min(1),
+});

package/schemas/action-log/pre-order-collection-copy-action-log.schema.ts

@@ -0,0 +1,11 @@
+import { z } from 'zod';
+
+/**
+ * Копирование коллекции предзаказа целиком. Запись ложится в журнал обеих коллекций: у исходной —
+ * что с неё сняли копию, у новой — откуда она взялась; сами позиции пачкой не логируются.
+ */
+export const PreOrderCollectionCopyActionLogSchema = z.object({
+    sourcePreOrderCollectionUUID: z.string(),
+    targetPreOrderCollectionUUID: z.string(),
+    count: z.number(),
+});

package/schemas/action-log/pre-order-convert-action-log.schema.ts

@@ -0,0 +1,16 @@
+import { z } from 'zod';
+
+/**
+ * Конвертация предзаказа в заказы. Запись ложится в журнал предзаказа и каждого созданного заказа:
+ * с одной стороны предзаказ «завершился», с другой заказ «появился», и обе стороны должны видеть связь.
+ */
+export const PreOrderConvertActionLogSchema = z.object({
+    preOrderUUID: z.string(),
+    preOrderId: z.coerce.number(),
+    orders: z.array(
+        z.object({
+            orderUUID: z.string(),
+            orderId: z.coerce.number(),
+        }),
+    ),
+});

package/schemas/action-log/pre-order-copy-action-log.schema.ts

@@ -0,0 +1,10 @@
+import { z } from 'zod';
+
+/** Копирование предзаказа в другую коллекцию: запись в журнале исходного и созданного. */
+export const PreOrderCopyActionLogSchema = z.object({
+    sourcePreOrderUUID: z.string(),
+    sourcePreOrderId: z.coerce.number(),
+    targetPreOrderUUID: z.string(),
+    targetPreOrderId: z.coerce.number(),
+    targetCollectionUUID: z.string(),
+});

package/schemas/action-log/pre-order-fields-update-action-log.schema.ts

@@ -0,0 +1,18 @@
+import { z } from 'zod';
+import { PreOrderUpdatedFieldEnum } from '../../enum/pre-order-updated-field.enum';
+
+/**
+ * Правка предзаказа помимо статуса: клиент, филиал, коллекция, комментарий, метка. Значения
+ * строками, клиент и филиал по имени — как у правки заказа.
+ */
+export const PreOrderFieldsUpdateActionLogSchema = z.object({
+    changes: z
+        .array(
+            z.object({
+                field: z.nativeEnum(PreOrderUpdatedFieldEnum),
+                oldValue: z.string().nullable(),
+                newValue: z.string().nullable(),
+            }),
+        )
+        .min(1),
+});

package/schemas/action-log/pre-order-from-standing-order-action-log.schema.ts

@@ -0,0 +1,9 @@
+import { z } from 'zod';
+import { PreOrderInfoSchema } from './pre-order-info.schema';
+
+/** Предзаказ, созданный из постоянного заказа: запись в журнале созданного предзаказа. */
+export const PreOrderFromStandingOrderActionLogSchema = z.object({
+    preOrder: PreOrderInfoSchema,
+    standingOrderUUID: z.string(),
+    standingOrderId: z.coerce.number(),
+});

package/schemas/action-log/pre-order-items-purchase-action-log.schema.ts

@@ -0,0 +1,9 @@
+import { z } from 'zod';
+import { PreOrderProductInfoSchema } from './pre-order-product-info.schema';
+
+/** Групповая отметка выкупа позиций: одна запись на предзаказ со списком его позиций. */
+export const PreOrderItemsPurchaseActionLogSchema = z.object({
+    isPurchased: z.boolean(),
+    count: z.number(),
+    preOrderProducts: z.array(PreOrderProductInfoSchema),
+});

package/schemas/action-log/pre-order-merge-action-log.schema.ts

@@ -0,0 +1,7 @@
+import { z } from 'zod';
+
+/** Слияние предзаказов: запись в журнале целевого, как MERGE_ORDER у заказов. */
+export const PreOrderMergeActionLogSchema = z.object({
+    targetPreOrderUUID: z.string(),
+    sourcePreOrderUUIDs: z.array(z.string()),
+});

package/schemas/action-log/pre-order-status-update-action-log.schema.ts

@@ -0,0 +1,8 @@
+import { z } from 'zod';
+import { PreOrderStatusEnum } from '../../enum/pre-order-status.enum';
+
+/** Смена статуса предзаказа: старый и новый, как у заказа. */
+export const PreOrderStatusUpdateActionLogSchema = z.object({
+    oldStatus: z.nativeEnum(PreOrderStatusEnum),
+    newStatus: z.nativeEnum(PreOrderStatusEnum),
+});

package/schemas/action-log/standing-order-create-action-log.schema.ts

@@ -0,0 +1,9 @@
+import { z } from 'zod';
+import { PreOrderInfoSchema } from './pre-order-info.schema';
+
+/** Постоянный заказ, созданный из предзаказа: запись в журнале обоих. */
+export const StandingOrderCreateActionLogSchema = z.object({
+    standingOrder: PreOrderInfoSchema,
+    sourcePreOrderUUID: z.string(),
+    sourcePreOrderId: z.coerce.number(),
+});

package/schemas/action-log/transfer-document-create-action-log.schema.ts

@@ -0,0 +1,7 @@
+import { z } from 'zod';
+import { TransferDocumentInfoSchema } from './transfer-document-info.schema';
+
+/** Создан УПД. Пока заказ входит в документ, его нельзя менять, поэтому событие важно видеть. */
+export const TransferDocumentCreateActionLogSchema = z.object({
+    transferDocument: TransferDocumentInfoSchema,
+});

package/schemas/action-log/transfer-document-delete-action-log.schema.ts

@@ -0,0 +1,11 @@
+import { z } from 'zod';
+import { TransferDocumentInfoSchema } from './transfer-document-info.schema';
+
+/**
+ * Удалён УПД. `isForced` отмечает удаление уже выданного документа: его нельзя восстановить, и по
+ * журналу должно быть видно, что удаление было именно принудительным.
+ */
+export const TransferDocumentDeleteActionLogSchema = z.object({
+    transferDocument: TransferDocumentInfoSchema,
+    isForced: z.boolean(),
+});

package/schemas/action-log/transfer-document-info.schema.ts

@@ -0,0 +1,18 @@
+import { z } from 'zod';
+import { ActionLogMoneySchema } from './action-log-money.schema';
+import { TransferDocumentKindEnum } from '../../enum/transfer-document-kind.enum';
+import { TransferDocumentStateEnum } from '../../enum/transfer-document-state.enum';
+
+/** Снимок УПД на момент события: номер, даты, сумма и состояние. */
+export const TransferDocumentInfoSchema = z.object({
+    transferDocumentUUID: z.string(),
+    transferDocumentId: z.coerce.number(),
+    documentDate: z.coerce.date(),
+    shipmentDate: z.coerce.date(),
+    amount: ActionLogMoneySchema,
+    clientUUID: z.string(),
+    state: z.nativeEnum(TransferDocumentStateEnum),
+    kind: z.nativeEnum(TransferDocumentKindEnum),
+    revisionNumber: z.number(),
+    orderUUIDs: z.array(z.string()),
+});

package/schemas/action-log/transfer-document-issue-action-log.schema.ts

@@ -0,0 +1,7 @@
+import { z } from 'zod';
+import { TransferDocumentInfoSchema } from './transfer-document-info.schema';
+
+/** УПД выдан контрагенту: после этого документ правится только выпуском исправления. */
+export const TransferDocumentIssueActionLogSchema = z.object({
+    transferDocument: TransferDocumentInfoSchema,
+});

package/schemas/action-log/write-off-create-action-log.schema.ts

@@ -0,0 +1,8 @@
+import { z } from 'zod';
+import { WriteOffInfoSchema } from './write-off-info.schema';
+
+/** Заведено списание: снимает товар с остатка, а списание из заказа ещё и двигает баланс клиента. */
+export const WriteOffCreateActionLogSchema = z.object({
+    writeOff: WriteOffInfoSchema,
+    isFromOrder: z.boolean(),
+});

package/schemas/action-log/write-off-delete-action-log.schema.ts

@@ -0,0 +1,8 @@
+import { z } from 'zod';
+import { WriteOffInfoSchema } from './write-off-info.schema';
+
+/** Удалено списание: товар возвращается на остаток, а по списанию из заказа откатывается баланс. */
+export const WriteOffDeleteActionLogSchema = z.object({
+    writeOff: WriteOffInfoSchema,
+    isFromOrder: z.boolean(),
+});

package/schemas/action-log/write-off-info.schema.ts

@@ -0,0 +1,17 @@
+import { z } from 'zod';
+import { ActionLogMoneySchema } from './action-log-money.schema';
+import { WriteOffStatusEnum } from '../../enum/write-off-status.enum';
+
+/** Снимок списания на момент события: товар, количество, причина и статус. */
+export const WriteOffInfoSchema = z.object({
+    writeOffUUID: z.string(),
+    productUUID: z.string(),
+    productName: z.string(),
+    categoryName: z.string().nullable(),
+    quantity: z.number(),
+    price: ActionLogMoneySchema.nullable(),
+    reason: z.string(),
+    comment: z.string().nullable(),
+    status: z.nativeEnum(WriteOffStatusEnum),
+    orderUUID: z.string().nullable(),
+});

package/schemas/action-log/write-off-price-update-action-log.schema.ts

@@ -0,0 +1,15 @@
+import { z } from 'zod';
+import { ActionLogMoneySchema } from './action-log-money.schema';
+import { WriteOffInfoSchema } from './write-off-info.schema';
+
+/**
+ * Правка количества и цены списания: меняет сумму возврата клиенту. Исходное списание отклоняется,
+ * вместо него заводятся новое списание и новая позиция заказа по новой цене — обе ссылки в записи.
+ */
+export const WriteOffPriceUpdateActionLogSchema = z.object({
+    writeOff: WriteOffInfoSchema,
+    newQuantity: z.number(),
+    newPrice: ActionLogMoneySchema,
+    rejectedWriteOffUUID: z.string(),
+    newOrderProductUUID: z.string(),
+});

package/schemas/action-log/write-off-status-update-action-log.schema.ts

@@ -0,0 +1,11 @@
+import { z } from 'zod';
+import { WriteOffInfoSchema } from './write-off-info.schema';
+import { WriteOffStatusEnum } from '../../enum/write-off-status.enum';
+
+/** Решение по списанию: одобрено или отклонено. Одобрение возвращает деньги клиенту. */
+export const WriteOffStatusUpdateActionLogSchema = z.object({
+    writeOff: WriteOffInfoSchema,
+    oldStatus: z.nativeEnum(WriteOffStatusEnum),
+    newStatus: z.nativeEnum(WriteOffStatusEnum),
+    rejectionReason: z.string().nullable(),
+});