@floristcloud/api-lib 1.2.132 → 1.2.133

package/build/commands/consignment/analyze-consignment-product-enrichment.query.js

@@ -0,0 +1,68 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AnalyzeConsignmentProductEnrichmentContractQuery = void 0;
+const zod_1 = require("zod");
+const query_boolean_helper_1 = require("../../helpers/query-boolean.helper");
+const consignment_product_enrichment_constant_1 = require("../../constant/consignment-product-enrichment.constant");
+const product_enrichment_field_enum_1 = require("../../enum/product-enrichment-field.enum");
+const product_enrichment_field_state_enum_1 = require("../../enum/product-enrichment-field-state.enum");
+const AnalyzeConsignmentProductEnrichmentRequestSchema = zod_1.z.object({
+    page: zod_1.z.coerce.number().int().min(1).default(1),
+    count: zod_1.z.coerce
+        .number()
+        .int()
+        .min(1)
+        .max(consignment_product_enrichment_constant_1.CONSIGNMENT_PRODUCT_ENRICHMENT_LIMITS.MAX_PAGE_SIZE)
+        .default(consignment_product_enrichment_constant_1.CONSIGNMENT_PRODUCT_ENRICHMENT_LIMITS.DEFAULT_PAGE_SIZE),
+    // Показывать только товары, у которых есть хотя бы одно поле к заполнению или конфликт.
+    // По умолчанию false: пользователь видит всю поставку и понимает, почему строк меньше, чем товаров.
+    // Не `z.coerce.boolean()`: в query приходит текст, а `Boolean('false') === true` — флаг нельзя
+    // было бы выключить явным значением.
+    isOnlyChanged: query_boolean_helper_1.queryBooleanSchema,
+});
+const ProductEnrichmentFieldSchema = zod_1.z.object({
+    current: zod_1.z.string().nullable(),
+    proposed: zod_1.z.string().nullable(),
+    state: zod_1.z.nativeEnum(product_enrichment_field_state_enum_1.ProductEnrichmentFieldStateEnum),
+});
+const ProductEnrichmentItemSchema = zod_1.z.object({
+    productUUID: zod_1.z.string(),
+    productName: zod_1.z.string(),
+    article: zod_1.z.string().nullable(),
+    size: zod_1.z.string().nullable(),
+    categoryName: zod_1.z.string().nullable(),
+    imageUUID: zod_1.z.string(),
+    imageName: zod_1.z.string(),
+    imageUrl: zod_1.z.string(),
+    fields: zod_1.z.record(zod_1.z.nativeEnum(product_enrichment_field_enum_1.ProductEnrichmentFieldEnum), ProductEnrichmentFieldSchema),
+});
+const ProductEnrichmentFieldStatsSchema = zod_1.z.object({
+    fillable: zod_1.z.number(),
+    conflicts: zod_1.z.number(),
+});
+const ProductEnrichmentSummarySchema = zod_1.z.object({
+    // Всего товаров в поставке.
+    totalProducts: zod_1.z.number(),
+    // Из них с привязанной карточкой — только они попадают в таблицу.
+    linkedProducts: zod_1.z.number(),
+    // Товаров, у которых есть хотя бы одно поле к заполнению.
+    fillableProducts: zod_1.z.number(),
+    // Товаров, у которых есть хотя бы один конфликт.
+    conflictProducts: zod_1.z.number(),
+    byField: zod_1.z.record(zod_1.z.nativeEnum(product_enrichment_field_enum_1.ProductEnrichmentFieldEnum), ProductEnrichmentFieldStatsSchema),
+});
+const AnalyzeConsignmentProductEnrichmentResponseSchema = zod_1.z.object({
+    data: zod_1.z.object({
+        items: zod_1.z.array(ProductEnrichmentItemSchema),
+        total: zod_1.z.number(),
+        page: zod_1.z.number(),
+        count: zod_1.z.number(),
+        // Считается по всей поставке, а не по текущей странице: иначе счётчики прыгали бы при листании.
+        summary: ProductEnrichmentSummarySchema,
+    }),
+});
+var AnalyzeConsignmentProductEnrichmentContractQuery;
+(function (AnalyzeConsignmentProductEnrichmentContractQuery) {
+    AnalyzeConsignmentProductEnrichmentContractQuery.RequestSchema = AnalyzeConsignmentProductEnrichmentRequestSchema;
+    AnalyzeConsignmentProductEnrichmentContractQuery.ResponseSchema = AnalyzeConsignmentProductEnrichmentResponseSchema;
+})(AnalyzeConsignmentProductEnrichmentContractQuery || (exports.AnalyzeConsignmentProductEnrichmentContractQuery = AnalyzeConsignmentProductEnrichmentContractQuery = {}));

package/build/commands/consignment/execute-consignment-product-enrichment.command.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExecuteConsignmentProductEnrichmentContractCommand = void 0;
+const zod_1 = require("zod");
+const error_message_schema_1 = require("../../schemas/error-message.schema");
+const consignment_product_enrichment_constant_1 = require("../../constant/consignment-product-enrichment.constant");
+const product_enrichment_field_enum_1 = require("../../enum/product-enrichment-field.enum");
+const ExecuteConsignmentProductEnrichmentItemSchema = zod_1.z.object({
+    productUUID: zod_1.z.string().uuid(),
+    // Какие поля переносим из карточки в этот товар. Пустой список — товар пропускается.
+    fields: zod_1.z.array(zod_1.z.nativeEnum(product_enrichment_field_enum_1.ProductEnrichmentFieldEnum)).min(1),
+});
+const ExecuteConsignmentProductEnrichmentRequestSchema = zod_1.z.object({
+    // Фронт шлёт пачками по EXECUTE_BATCH_SIZE и сам собирает итог: одна поставка может
+    // содержать до 1200 товаров, и одним запросом это отправлять не нужно.
+    // Повторы `productUUID` допустимы и схлопываются на сервере в объединение полей: товар
+    // обновляется и логируется один раз, сколько бы записей о нём ни пришло.
+    items: zod_1.z.array(ExecuteConsignmentProductEnrichmentItemSchema).min(1).max(consignment_product_enrichment_constant_1.CONSIGNMENT_PRODUCT_ENRICHMENT_LIMITS.EXECUTE_BATCH_SIZE),
+});
+const ExecuteConsignmentProductEnrichmentResponseSchema = zod_1.z.object({
+    data: zod_1.z.object({
+        success: zod_1.z.boolean(),
+        // Товаров, у которых изменилось хотя бы одно поле.
+        successCount: zod_1.z.number(),
+        // Товаров, где менять было нечего: значение уже совпадало или карточка опустела с момента разбора.
+        skippedCount: zod_1.z.number(),
+        // Товаров, которые кто-то изменил между разбором и применением. Отдельно от skipped, потому
+        // что это единственный исход, требующий действия: пользователю нужно перечитать разбор.
+        conflictedCount: zod_1.z.number(),
+        failedCount: zod_1.z.number(),
+        errors: zod_1.z.array(error_message_schema_1.ErrorMessageSchema.extend({
+            uuid: zod_1.z.string(),
+        })),
+    }),
+});
+var ExecuteConsignmentProductEnrichmentContractCommand;
+(function (ExecuteConsignmentProductEnrichmentContractCommand) {
+    ExecuteConsignmentProductEnrichmentContractCommand.RequestSchema = ExecuteConsignmentProductEnrichmentRequestSchema;
+    ExecuteConsignmentProductEnrichmentContractCommand.ResponseSchema = ExecuteConsignmentProductEnrichmentResponseSchema;
+})(ExecuteConsignmentProductEnrichmentContractCommand || (exports.ExecuteConsignmentProductEnrichmentContractCommand = ExecuteConsignmentProductEnrichmentContractCommand = {}));

package/build/commands/consignment/index.js

@@ -29,3 +29,5 @@ __exportStar(require("./get-access-clients-consignment.query"), exports);
 __exportStar(require("./get-consignment-filters-values.query"), exports);
 __exportStar(require("./execute-consignment-product-update.command"), exports);
 __exportStar(require("./determine-consignment-product-images.command"), exports);
+__exportStar(require("./analyze-consignment-product-enrichment.query"), exports);
+__exportStar(require("./execute-consignment-product-enrichment.command"), exports);

package/build/constant/consignment-product-enrichment.constant.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CONSIGNMENT_PRODUCT_ENRICHMENT_LIMITS = void 0;
+// Лимиты операции «получить характеристики из номенклатуры».
+// Анализ читает всю поставку целиком (потолок задан лимитами импорта: MAX_ROWS_WITHOUT_IMAGES = 1200),
+// но наружу отдаёт страницами, а применение принимает пачками — чтобы ни ответ, ни запрос не росли
+// вместе с размером поставки.
+exports.CONSIGNMENT_PRODUCT_ENRICHMENT_LIMITS = {
+    DEFAULT_PAGE_SIZE: 50,
+    MAX_PAGE_SIZE: 200,
+    EXECUTE_BATCH_SIZE: 100,
+};

package/build/constant/index.js

@@ -25,3 +25,4 @@ __exportStar(require("./oksm"), exports);
 __exportStar(require("./okei"), exports);
 __exportStar(require("./contact-phone.constant"), exports);
 __exportStar(require("./settings.constant"), exports);
+__exportStar(require("./consignment-product-enrichment.constant"), exports);

package/build/enum/index.js

@@ -122,3 +122,5 @@ __exportStar(require("./transfer-document-state.enum"), exports);
 __exportStar(require("./transfer-document-kind.enum"), exports);
 __exportStar(require("./transfer-document-item-kind.enum"), exports);
 __exportStar(require("./write-off-report-date-basis.enum"), exports);
+__exportStar(require("./product-enrichment-field.enum"), exports);
+__exportStar(require("./product-enrichment-field-state.enum"), exports);

package/build/enum/product-enrichment-field-state.enum.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProductEnrichmentFieldStateEnum = void 0;
+// Состояние одного поля товара относительно привязанной карточки номенклатуры.
+// Определяет и подсказку в интерфейсе («собственные данные» / «из номенклатуры»), и то,
+// отмечен ли чекбокс по умолчанию: предзаполняется только FILLABLE.
+var ProductEnrichmentFieldStateEnum;
+(function (ProductEnrichmentFieldStateEnum) {
+    // У товара пусто, в карточке значение есть — это и есть «дополнить».
+    ProductEnrichmentFieldStateEnum["FILLABLE"] = "FILLABLE";
+    // Оба заполнены и различаются. Показываем, но по умолчанию не отмечаем.
+    ProductEnrichmentFieldStateEnum["CONFLICT"] = "CONFLICT";
+    // Значения совпадают — брать нечего.
+    ProductEnrichmentFieldStateEnum["SAME"] = "SAME";
+    // В карточке пусто — источника нет.
+    ProductEnrichmentFieldStateEnum["NO_SOURCE"] = "NO_SOURCE";
+})(ProductEnrichmentFieldStateEnum || (exports.ProductEnrichmentFieldStateEnum = ProductEnrichmentFieldStateEnum = {}));

package/build/enum/product-enrichment-field.enum.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PRODUCT_ENRICHMENT_FIELD_LIST = exports.ProductEnrichmentFieldEnum = void 0;
+// Поля товара, которые можно дополнить из привязанной карточки номенклатуры (ProductImage).
+// Значения совпадают с именами полей Product и ProductImage — это ключи, по которым фронт
+// собирает решения, поэтому переименование значения ломает контракт.
+var ProductEnrichmentFieldEnum;
+(function (ProductEnrichmentFieldEnum) {
+    ProductEnrichmentFieldEnum["COLOR"] = "color";
+    ProductEnrichmentFieldEnum["COUNTRY"] = "country";
+    ProductEnrichmentFieldEnum["GROWER"] = "grower";
+})(ProductEnrichmentFieldEnum || (exports.ProductEnrichmentFieldEnum = ProductEnrichmentFieldEnum = {}));
+const PRODUCT_ENRICHMENT_FIELD_KEYS = Object.keys(ProductEnrichmentFieldEnum);
+exports.PRODUCT_ENRICHMENT_FIELD_LIST = PRODUCT_ENRICHMENT_FIELD_KEYS.map(key => ProductEnrichmentFieldEnum[key]);

package/commands/consignment/analyze-consignment-product-enrichment.query.ts

@@ -0,0 +1,78 @@
+import { z } from 'zod';
+import { queryBooleanSchema } from '../../helpers/query-boolean.helper';
+import { CONSIGNMENT_PRODUCT_ENRICHMENT_LIMITS } from '../../constant/consignment-product-enrichment.constant';
+import { ProductEnrichmentFieldEnum } from '../../enum/product-enrichment-field.enum';
+import { ProductEnrichmentFieldStateEnum } from '../../enum/product-enrichment-field-state.enum';
+
+const AnalyzeConsignmentProductEnrichmentRequestSchema = z.object({
+    page: z.coerce.number().int().min(1).default(1),
+    count: z.coerce
+        .number()
+        .int()
+        .min(1)
+        .max(CONSIGNMENT_PRODUCT_ENRICHMENT_LIMITS.MAX_PAGE_SIZE)
+        .default(CONSIGNMENT_PRODUCT_ENRICHMENT_LIMITS.DEFAULT_PAGE_SIZE),
+    // Показывать только товары, у которых есть хотя бы одно поле к заполнению или конфликт.
+    // По умолчанию false: пользователь видит всю поставку и понимает, почему строк меньше, чем товаров.
+    // Не `z.coerce.boolean()`: в query приходит текст, а `Boolean('false') === true` — флаг нельзя
+    // было бы выключить явным значением.
+    isOnlyChanged: queryBooleanSchema,
+});
+
+const ProductEnrichmentFieldSchema = z.object({
+    current: z.string().nullable(),
+    proposed: z.string().nullable(),
+    state: z.nativeEnum(ProductEnrichmentFieldStateEnum),
+});
+
+const ProductEnrichmentItemSchema = z.object({
+    productUUID: z.string(),
+    productName: z.string(),
+    article: z.string().nullable(),
+    size: z.string().nullable(),
+    categoryName: z.string().nullable(),
+    imageUUID: z.string(),
+    imageName: z.string(),
+    imageUrl: z.string(),
+    fields: z.record(z.nativeEnum(ProductEnrichmentFieldEnum), ProductEnrichmentFieldSchema),
+});
+
+const ProductEnrichmentFieldStatsSchema = z.object({
+    fillable: z.number(),
+    conflicts: z.number(),
+});
+
+const ProductEnrichmentSummarySchema = z.object({
+    // Всего товаров в поставке.
+    totalProducts: z.number(),
+    // Из них с привязанной карточкой — только они попадают в таблицу.
+    linkedProducts: z.number(),
+    // Товаров, у которых есть хотя бы одно поле к заполнению.
+    fillableProducts: z.number(),
+    // Товаров, у которых есть хотя бы один конфликт.
+    conflictProducts: z.number(),
+    byField: z.record(z.nativeEnum(ProductEnrichmentFieldEnum), ProductEnrichmentFieldStatsSchema),
+});
+
+const AnalyzeConsignmentProductEnrichmentResponseSchema = z.object({
+    data: z.object({
+        items: z.array(ProductEnrichmentItemSchema),
+        total: z.number(),
+        page: z.number(),
+        count: z.number(),
+        // Считается по всей поставке, а не по текущей странице: иначе счётчики прыгали бы при листании.
+        summary: ProductEnrichmentSummarySchema,
+    }),
+});
+
+export namespace AnalyzeConsignmentProductEnrichmentContractQuery {
+    export const RequestSchema = AnalyzeConsignmentProductEnrichmentRequestSchema;
+    export type Request = z.infer<typeof RequestSchema>;
+
+    export const ResponseSchema = AnalyzeConsignmentProductEnrichmentResponseSchema;
+    export type Response = z.infer<typeof ResponseSchema>;
+
+    export type Item = z.infer<typeof ProductEnrichmentItemSchema>;
+    export type FieldDiff = z.infer<typeof ProductEnrichmentFieldSchema>;
+    export type Summary = z.infer<typeof ProductEnrichmentSummarySchema>;
+}

package/commands/consignment/execute-consignment-product-enrichment.command.ts

@@ -0,0 +1,47 @@
+import { z } from 'zod';
+import { ErrorMessageSchema } from '../../schemas/error-message.schema';
+import { CONSIGNMENT_PRODUCT_ENRICHMENT_LIMITS } from '../../constant/consignment-product-enrichment.constant';
+import { ProductEnrichmentFieldEnum } from '../../enum/product-enrichment-field.enum';
+
+const ExecuteConsignmentProductEnrichmentItemSchema = z.object({
+    productUUID: z.string().uuid(),
+    // Какие поля переносим из карточки в этот товар. Пустой список — товар пропускается.
+    fields: z.array(z.nativeEnum(ProductEnrichmentFieldEnum)).min(1),
+});
+
+const ExecuteConsignmentProductEnrichmentRequestSchema = z.object({
+    // Фронт шлёт пачками по EXECUTE_BATCH_SIZE и сам собирает итог: одна поставка может
+    // содержать до 1200 товаров, и одним запросом это отправлять не нужно.
+    // Повторы `productUUID` допустимы и схлопываются на сервере в объединение полей: товар
+    // обновляется и логируется один раз, сколько бы записей о нём ни пришло.
+    items: z.array(ExecuteConsignmentProductEnrichmentItemSchema).min(1).max(CONSIGNMENT_PRODUCT_ENRICHMENT_LIMITS.EXECUTE_BATCH_SIZE),
+});
+
+const ExecuteConsignmentProductEnrichmentResponseSchema = z.object({
+    data: z.object({
+        success: z.boolean(),
+        // Товаров, у которых изменилось хотя бы одно поле.
+        successCount: z.number(),
+        // Товаров, где менять было нечего: значение уже совпадало или карточка опустела с момента разбора.
+        skippedCount: z.number(),
+        // Товаров, которые кто-то изменил между разбором и применением. Отдельно от skipped, потому
+        // что это единственный исход, требующий действия: пользователю нужно перечитать разбор.
+        conflictedCount: z.number(),
+        failedCount: z.number(),
+        errors: z.array(
+            ErrorMessageSchema.extend({
+                uuid: z.string(),
+            }),
+        ),
+    }),
+});
+
+export namespace ExecuteConsignmentProductEnrichmentContractCommand {
+    export const RequestSchema = ExecuteConsignmentProductEnrichmentRequestSchema;
+    export type Request = z.infer<typeof RequestSchema>;
+
+    export const ResponseSchema = ExecuteConsignmentProductEnrichmentResponseSchema;
+    export type Response = z.infer<typeof ResponseSchema>;
+
+    export type Item = z.infer<typeof ExecuteConsignmentProductEnrichmentItemSchema>;
+}

package/commands/consignment/index.ts

@@ -13,3 +13,5 @@ export * from './get-access-clients-consignment.query';
 export * from './get-consignment-filters-values.query';
 export * from './execute-consignment-product-update.command';
 export * from './determine-consignment-product-images.command';
+export * from './analyze-consignment-product-enrichment.query';
+export * from './execute-consignment-product-enrichment.command';

package/constant/consignment-product-enrichment.constant.ts

@@ -0,0 +1,9 @@
+// Лимиты операции «получить характеристики из номенклатуры».
+// Анализ читает всю поставку целиком (потолок задан лимитами импорта: MAX_ROWS_WITHOUT_IMAGES = 1200),
+// но наружу отдаёт страницами, а применение принимает пачками — чтобы ни ответ, ни запрос не росли
+// вместе с размером поставки.
+export const CONSIGNMENT_PRODUCT_ENRICHMENT_LIMITS = {
+    DEFAULT_PAGE_SIZE: 50,
+    MAX_PAGE_SIZE: 200,
+    EXECUTE_BATCH_SIZE: 100,
+} as const;

package/constant/index.ts

@@ -9,3 +9,4 @@ export * from './oksm';
 export * from './okei';
 export * from './contact-phone.constant';
 export * from './settings.constant';
+export * from './consignment-product-enrichment.constant';

package/enum/index.ts

@@ -106,3 +106,5 @@ export * from './transfer-document-state.enum';
 export * from './transfer-document-kind.enum';
 export * from './transfer-document-item-kind.enum';
 export * from './write-off-report-date-basis.enum';
+export * from './product-enrichment-field.enum';
+export * from './product-enrichment-field-state.enum';

package/enum/product-enrichment-field-state.enum.ts

@@ -0,0 +1,13 @@
+// Состояние одного поля товара относительно привязанной карточки номенклатуры.
+// Определяет и подсказку в интерфейсе («собственные данные» / «из номенклатуры»), и то,
+// отмечен ли чекбокс по умолчанию: предзаполняется только FILLABLE.
+export enum ProductEnrichmentFieldStateEnum {
+    // У товара пусто, в карточке значение есть — это и есть «дополнить».
+    FILLABLE = 'FILLABLE',
+    // Оба заполнены и различаются. Показываем, но по умолчанию не отмечаем.
+    CONFLICT = 'CONFLICT',
+    // Значения совпадают — брать нечего.
+    SAME = 'SAME',
+    // В карточке пусто — источника нет.
+    NO_SOURCE = 'NO_SOURCE',
+}

package/enum/product-enrichment-field.enum.ts

@@ -0,0 +1,14 @@
+// Поля товара, которые можно дополнить из привязанной карточки номенклатуры (ProductImage).
+// Значения совпадают с именами полей Product и ProductImage — это ключи, по которым фронт
+// собирает решения, поэтому переименование значения ломает контракт.
+export enum ProductEnrichmentFieldEnum {
+    COLOR = 'color',
+    COUNTRY = 'country',
+    GROWER = 'grower',
+}
+
+const PRODUCT_ENRICHMENT_FIELD_KEYS = Object.keys(ProductEnrichmentFieldEnum) as Array<keyof typeof ProductEnrichmentFieldEnum>;
+
+export const PRODUCT_ENRICHMENT_FIELD_LIST: readonly ProductEnrichmentFieldEnum[] = PRODUCT_ENRICHMENT_FIELD_KEYS.map(
+    key => ProductEnrichmentFieldEnum[key],
+);

package/package.json

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