@floristcloud/api-lib 1.2.130 → 1.2.132

package/build/commands/discount-rules/get-product-discount-price.query.js

@@ -16,7 +16,9 @@ const GetProductDiscountPriceRequestSchema = zod_1.z.object({
  *
  * `discountValueData` описывает, чем правило обернулось для этого товара, а не как оно настроено:
  * у правила от себестоимости это готовая цена, и самой наценки здесь нет.
-
+ *
+ * В списки попадают только варианты, которые действительно снижают цену: правило, оставляющее базу
+ * как есть, выбором не является.
  */
 const ProductDiscountPriceItemSchema = zod_1.z.object({
     discountRulesUUID: zod_1.z.string(),
@@ -44,8 +46,25 @@ const GetProductDiscountPriceResponseSchema = zod_1.z.object({
             optionPrice: money_schema_1.MoneySchema.nullable(),
             optionPriceWithDiscount: money_schema_1.MoneySchema.nullable(),
             isDiscountApplicable: zod_1.z.boolean(),
+            /**
+             * Варианты по этой фасовке: те же правила, но посчитанные от её цены.
+             *
+             * Список свой у каждой кратности, потому что база у них разная — у правила нет
+             * одной цены на товар, пока не выбрана форма отгрузки. Пустой список означает
+             * «выбирать нечего»: скидки к этой кратности запрещены продавцом либо ни одно
+             * правило её цену не снижает.
+             *
+             * Порядок элементов не отсортирован по цене — он унаследован от сортировки правил
+             * товара, а база у фасовки другая. Лучшую цену берите из `optionPriceWithDiscount`,
+             * а не из первого элемента.
+             */
+            discountDataList: ProductDiscountPriceItemSchema.array(),
         })
             .array(),
+        /**
+         * Варианты по базовой цене товара. Как и у фасовок, порядок не гарантирован: лучшую цену
+         * отдаёт `priceWithBestDiscount`.
+         */
         discountDataList: ProductDiscountPriceItemSchema.array(),
     }),
 });

package/build/schemas/action-log/pre-order-product-info.schema.js

@@ -3,12 +3,19 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.PreOrderProductInfoSchema = void 0;
 const zod_1 = require("zod");
 const action_log_money_schema_1 = require("./action-log-money.schema");
+/**
+ * Снимок позиции предзаказа в журнале аудита.
+ *
+ * `name` и `price` — nullable: у позиции предзаказа наименование и цена появляются не сразу
+ * (в БД `pre_order_product.name` и `price` тоже nullable), и журнал фиксирует позицию такой,
+ * какой она была на момент события. Записи с `null` уже лежат в `action_log.payload`.
+ */
 exports.PreOrderProductInfoSchema = zod_1.z.object({
     preOrderUUID: zod_1.z.string(),
     preOrderProductUUID: zod_1.z.string(),
-    name: zod_1.z.string(),
+    name: zod_1.z.string().nullable(),
     categoryName: zod_1.z.string().nullable(),
     quantity: zod_1.z.coerce.number(),
-    price: action_log_money_schema_1.ActionLogMoneySchema,
+    price: action_log_money_schema_1.ActionLogMoneySchema.nullable(),
     comment: zod_1.z.string().nullable(),
 });

package/build/schemas/action-log/pre-order-product-update-action-log.schema.js

@@ -7,6 +7,7 @@ const action_log_money_schema_1 = require("./action-log-money.schema");
 exports.PreOrderProductUpdateActionLogSchema = zod_1.z.object({
     preOrderProduct: pre_order_product_info_schema_1.PreOrderProductInfoSchema,
     newQuantity: zod_1.z.coerce.number(),
-    newPrice: action_log_money_schema_1.ActionLogMoneySchema,
+    // Цену позиции предзаказа можно снять — новое значение бывает null, см. PreOrderProductInfoSchema.
+    newPrice: action_log_money_schema_1.ActionLogMoneySchema.nullable(),
     newComment: zod_1.z.string().nullable(),
 });

package/build/schemas/product/product.schema.js

@@ -91,6 +91,23 @@ exports.ProductExtendedForClientSchema = exports.ProductForClientSchema.merge(zo
         isInStock: zod_1.z.boolean(),
     }),
     multiplicityOptions: zod_1.z.array(product_multiplicity_option_for_client_schema_1.ProductMultiplicityOptionForClientSchema).optional(),
+    /**
+     * Правила клиента, снижающие **базовую цену товара**, — и только они.
+     *
+     * Правило, оставляющее цену как есть, в список не попадает: это не скидка, а «скидка» с
+     * той же ценой рядом. Так выходит у правила от себестоимости, когда «себестоимость +
+     * наценка» вышла выше прайса, и у скидки в 0 %. Отбор общий с панелью
+     * (`GetProductDiscountPriceContractQuery`) — правила отбираются одинаково.
+     *
+     * Список считается от базовой цены товара, поэтому пустой список **не означает**, что у
+     * клиента нет скидочных цен по этому товару вовсе: у кратности своя база, и правило может
+     * снижать цену фасовки, не снижая цену штуки. Цена каждой фасовки — в её собственных
+     * `optionPriceWithDiscount` и `isDiscountApplicable`, там результат уже посчитан от нужной
+     * базы. Пример: прайс 50, фасовка 80, «себестоимость + наценка» 60 — список пуст, а
+     * фасовка идёт по 60.
+     *
+     * Порядок не зафиксирован — лучшую цену базового тарифа берите из `priceWithBestDiscount`.
+     */
     discountDataList: zod_1.z
         .object({
         discountRulesUUID: zod_1.z.string(),

package/commands/discount-rules/get-product-discount-price.query.ts

@@ -15,7 +15,9 @@ const GetProductDiscountPriceRequestSchema = z.object({
  *
  * `discountValueData` описывает, чем правило обернулось для этого товара, а не как оно настроено:
  * у правила от себестоимости это готовая цена, и самой наценки здесь нет.
-
+ *
+ * В списки попадают только варианты, которые действительно снижают цену: правило, оставляющее базу
+ * как есть, выбором не является.
  */
 const ProductDiscountPriceItemSchema = z.object({
     discountRulesUUID: z.string(),
@@ -44,8 +46,25 @@ const GetProductDiscountPriceResponseSchema = z.object({
                 optionPrice: MoneySchema.nullable(),
                 optionPriceWithDiscount: MoneySchema.nullable(),
                 isDiscountApplicable: z.boolean(),
+                /**
+                 * Варианты по этой фасовке: те же правила, но посчитанные от её цены.
+                 *
+                 * Список свой у каждой кратности, потому что база у них разная — у правила нет
+                 * одной цены на товар, пока не выбрана форма отгрузки. Пустой список означает
+                 * «выбирать нечего»: скидки к этой кратности запрещены продавцом либо ни одно
+                 * правило её цену не снижает.
+                 *
+                 * Порядок элементов не отсортирован по цене — он унаследован от сортировки правил
+                 * товара, а база у фасовки другая. Лучшую цену берите из `optionPriceWithDiscount`,
+                 * а не из первого элемента.
+                 */
+                discountDataList: ProductDiscountPriceItemSchema.array(),
             })
             .array(),
+        /**
+         * Варианты по базовой цене товара. Как и у фасовок, порядок не гарантирован: лучшую цену
+         * отдаёт `priceWithBestDiscount`.
+         */
         discountDataList: ProductDiscountPriceItemSchema.array(),
     }),
 });

package/package.json

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

package/schemas/action-log/pre-order-product-info.schema.ts

@@ -1,12 +1,19 @@
 import { z } from 'zod';
 import { ActionLogMoneySchema } from './action-log-money.schema';
 
+/**
+ * Снимок позиции предзаказа в журнале аудита.
+ *
+ * `name` и `price` — nullable: у позиции предзаказа наименование и цена появляются не сразу
+ * (в БД `pre_order_product.name` и `price` тоже nullable), и журнал фиксирует позицию такой,
+ * какой она была на момент события. Записи с `null` уже лежат в `action_log.payload`.
+ */
 export const PreOrderProductInfoSchema = z.object({
     preOrderUUID: z.string(),
     preOrderProductUUID: z.string(),
-    name: z.string(),
+    name: z.string().nullable(),
     categoryName: z.string().nullable(),
     quantity: z.coerce.number(),
-    price: ActionLogMoneySchema,
+    price: ActionLogMoneySchema.nullable(),
     comment: z.string().nullable(),
 });

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

@@ -5,6 +5,7 @@ import { ActionLogMoneySchema } from './action-log-money.schema';
 export const PreOrderProductUpdateActionLogSchema = z.object({
     preOrderProduct: PreOrderProductInfoSchema,
     newQuantity: z.coerce.number(),
-    newPrice: ActionLogMoneySchema,
+    // Цену позиции предзаказа можно снять — новое значение бывает null, см. PreOrderProductInfoSchema.
+    newPrice: ActionLogMoneySchema.nullable(),
     newComment: z.string().nullable(),
 });

package/schemas/product/product.schema.ts

@@ -98,6 +98,23 @@ export const ProductExtendedForClientSchema = ProductForClientSchema.merge(
             isInStock: z.boolean(),
         }),
         multiplicityOptions: z.array(ProductMultiplicityOptionForClientSchema).optional(),
+        /**
+         * Правила клиента, снижающие **базовую цену товара**, — и только они.
+         *
+         * Правило, оставляющее цену как есть, в список не попадает: это не скидка, а «скидка» с
+         * той же ценой рядом. Так выходит у правила от себестоимости, когда «себестоимость +
+         * наценка» вышла выше прайса, и у скидки в 0 %. Отбор общий с панелью
+         * (`GetProductDiscountPriceContractQuery`) — правила отбираются одинаково.
+         *
+         * Список считается от базовой цены товара, поэтому пустой список **не означает**, что у
+         * клиента нет скидочных цен по этому товару вовсе: у кратности своя база, и правило может
+         * снижать цену фасовки, не снижая цену штуки. Цена каждой фасовки — в её собственных
+         * `optionPriceWithDiscount` и `isDiscountApplicable`, там результат уже посчитан от нужной
+         * базы. Пример: прайс 50, фасовка 80, «себестоимость + наценка» 60 — список пуст, а
+         * фасовка идёт по 60.
+         *
+         * Порядок не зафиксирован — лучшую цену базового тарифа берите из `priceWithBestDiscount`.
+         */
         discountDataList: z
             .object({
                 discountRulesUUID: z.string(),