@escapenavigator/types 1.10.106 → 1.10.108

package/dist/order/order.ro.d.ts

@@ -107,7 +107,28 @@ declare class ReturnedPromocode {
     discount: number;
 }
 export declare class OrderRO extends RO {
-    utm: Utm;
+    /**
+     * UTM-метки — flat-поля прямо на ордере. Источник истины:
+     * денормализованные колонки `OrderEntity.utm*`. Legacy-relation
+     * `OrderEntity.utm` (eager:false) и сам `OrderUtmEntity` остались
+     * только под refill, в RO/UI больше не пробрасываются.
+     */
+    utmSource?: string | null;
+    utmMedium?: string | null;
+    utmCampaign?: string | null;
+    utmContent?: string | null;
+    utmTerm?: string | null;
+    /**
+     * Внутренний (escapenavigator) FK на `profile-marketing-email-campaign.id`.
+     * В отличие от `utmCampaign`, не редактируется юзером — используется
+     * для точной атрибуции кампаний без `LIKE`-матчинга по slug-у.
+     */
+    enCampaignId?: number | null;
+    /**
+     * Last-click ID конкретной ссылки внутри письма (`cta_primary`,
+     * `section_${i}` и т.п.). При повторном клике перезаписывается.
+     */
+    enLinkId?: string | null;
     customFields: CustomFiled[];
     otherId: string;
     updatedAt: Date;

package/dist/order/order.ro.js

@@ -315,9 +315,32 @@ class OrderRO extends ro_class_1.RO {
 exports.OrderRO = OrderRO;
 __decorate([
     (0, class_transformer_1.Expose)(),
-    (0, class_transformer_1.Type)(() => Utm),
-    __metadata("design:type", Utm)
-], OrderRO.prototype, "utm", void 0);
+    __metadata("design:type", String)
+], OrderRO.prototype, "utmSource", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    __metadata("design:type", String)
+], OrderRO.prototype, "utmMedium", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    __metadata("design:type", String)
+], OrderRO.prototype, "utmCampaign", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    __metadata("design:type", String)
+], OrderRO.prototype, "utmContent", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    __metadata("design:type", String)
+], OrderRO.prototype, "utmTerm", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    __metadata("design:type", Number)
+], OrderRO.prototype, "enCampaignId", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    __metadata("design:type", String)
+], OrderRO.prototype, "enLinkId", void 0);
 __decorate([
     (0, class_transformer_1.Expose)(),
     (0, class_transformer_1.Type)(() => CustomFiled),

package/dist/shared/export-limits.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Единые лимиты на размер XLSX-выгрузок. Импортится и бэком
+ * (`*.Service.EXPORT_LIMIT` + count-precheck в контроллере), и
+ * фронтом (`ExportAndCount` дизейблит кнопку, если `count > limit`).
+ *
+ * Зачем общая константа: иначе магическое `5000` живёт в двух местах,
+ * и при апдейте бэка фронт продолжит разрешать клик на 5001-й строке,
+ * валя пользователя в 400 `EXPORT_TOO_LARGE`.
+ *
+ * Реализованные на бэке потолки:
+ *  - `OrderService.EXPORT_LIMIT` — `GET /orders/export`
+ *  - `ClientService.EXPORT_LIMIT` — `GET /clients/export`
+ *
+ * Не покрыты лимитом (TODO): `transactions/export`, `users/sessions/export`.
+ * Когда добавится — взять отсюда же.
+ */
+export declare const EXPORT_LIMITS: {
+    readonly ORDERS: 5000;
+    readonly CLIENTS: 5000;
+};
+export type ExportLimitKey = keyof typeof EXPORT_LIMITS;

package/dist/shared/export-limits.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EXPORT_LIMITS = void 0;
+/**
+ * Единые лимиты на размер XLSX-выгрузок. Импортится и бэком
+ * (`*.Service.EXPORT_LIMIT` + count-precheck в контроллере), и
+ * фронтом (`ExportAndCount` дизейблит кнопку, если `count > limit`).
+ *
+ * Зачем общая константа: иначе магическое `5000` живёт в двух местах,
+ * и при апдейте бэка фронт продолжит разрешать клик на 5001-й строке,
+ * валя пользователя в 400 `EXPORT_TOO_LARGE`.
+ *
+ * Реализованные на бэке потолки:
+ *  - `OrderService.EXPORT_LIMIT` — `GET /orders/export`
+ *  - `ClientService.EXPORT_LIMIT` — `GET /clients/export`
+ *
+ * Не покрыты лимитом (TODO): `transactions/export`, `users/sessions/export`.
+ * Когда добавится — взять отсюда же.
+ */
+exports.EXPORT_LIMITS = {
+    ORDERS: 5000,
+    CLIENTS: 5000,
+};

package/dist/statistics/certificates.d.ts

@@ -2,8 +2,12 @@
  * Сводный отчёт по продажам сертификатов за выбранный период.
  *
  * Все денежные суммы — в минимальных единицах валюты (копейки/центы).
- * Базовая фильтрация на бэке: `code != NOT_GENERATED_CODE` (висящие
- * корзины не учитываем) + `paidAt` в окне `periods`.
+ *
+ * Когорта периода = `code != NOT_GENERATED_CODE` + `annul = false` +
+ * `paidAt ∈ [start, end)`. ВСЕ агрегаты overview (включая остаток
+ * номиналов, количество полностью использованных и аннулированных)
+ * считаются по одной и той же когорте — это снимает прежний разнобой,
+ * когда `outstandingBalance` суммировался по всей истории профиля.
  *
  * Семантика финансовых полей:
  *  - gross — стоимость по прайсу (SUM(total)). Не выручка.
@@ -11,13 +15,19 @@
  *  - discount — сумма ручных скидок (SUM(discountTotal)).
  *  - promocode — сумма промокодов (SUM(promocodeTotal)).
  *  - refunded — реально возвращённые клиенту деньги (SUM(refundedAmount)).
+ *  - nominalSold — суммарный номинал когорты (SUM(nominal)).
+ *  - nominalRedeemed — сколько из этого номинала уже потрачено в заказах
+ *    (SUM(usedAmount)).
+ *  - outstandingBalance — остаток номиналов когорты у ещё не закрытых
+ *    сертификатов (SUM(balance) WHERE used = false).
+ *  - redemptionRate — целое число процентов, nominalRedeemed / nominalSold.
  */
 export type CertificatesOverview = {
     /** Сколько сертификатов выписано (paid) за период. */
     soldCount: number;
-    /** Сколько аннулировано в этом же периоде (по annulledAt). */
+    /** Сколько из когорты уже аннулировано (annul = true к моменту запроса). */
     annulledCount: number;
-    /** Сколько использовано полностью (по fullyUsedAt). */
+    /** Сколько из когорты уже полностью погашено (fullyUsedAt IS NOT NULL). */
     fullyUsedCount: number;
     /** Сколько ушло в подарок (isGift = true) среди soldCount. */
     giftCount: number;
@@ -28,8 +38,14 @@ export type CertificatesOverview = {
     refunded: number;
     /** Средний чек по cash: cash / soldCount, 0 если нет продаж. */
     avgCheck: number;
-    /** Не использованный остаток номиналов: SUM(balance) у не-аннулированных. */
+    /** Суммарный номинал по когорте: SUM(nominal). */
+    nominalSold: number;
+    /** Сколько номинала уже потрачено в заказах: SUM(usedAmount). */
+    nominalRedeemed: number;
+    /** Остаток номиналов когорты у не закрытых сертификатов: SUM(balance) WHERE used = false. */
     outstandingBalance: number;
+    /** Доля погашения номинала, целое число процентов (0..100). */
+    redemptionRate: number;
 };
 export type CertificatesDynamicRow = {
     period: string;
@@ -66,6 +82,52 @@ export type CertificatesByUtmRow = {
     soldCount: number;
     cash: number;
 };
+/**
+ * Бакеты «через сколько дней после покупки сертификат…»
+ *  - d0      — в день покупки
+ *  - d1_7    — 1..7 дней
+ *  - d8_30   — 8..30 дней
+ *  - d31_90  — 31..90 дней
+ *  - d91_180 — 91..180 дней
+ *  - d181_365 — 181..365 дней
+ *  - d_over_365 — больше года
+ *  - not_yet — ещё не активирован / не погашен полностью
+ */
+export type CertificatesVelocityBucket = 'd0' | 'd1_7' | 'd8_30' | 'd31_90' | 'd91_180' | 'd181_365' | 'd_over_365' | 'not_yet';
+export type CertificatesVelocityBucketRow = {
+    bucket: CertificatesVelocityBucket;
+    /** Сколько сертификатов когорты попало в бакет. */
+    count: number;
+};
+/**
+ * Скорость использования сертификатов когорты периода.
+ *
+ * Когорта = `code != NOT_GENERATED_CODE` + `annul = false` +
+ * `paidAt ∈ [start, end)`. Источники дат — `firstUsedAt`, `fullyUsedAt`,
+ * `expireDate`. Никаких джоинов — считаем по плоской `certificatesales`.
+ */
+export type CertificatesRedemptionVelocity = {
+    /** Распределение времени до первого применения. */
+    firstUseBuckets: CertificatesVelocityBucketRow[];
+    /** Распределение времени до полного погашения. */
+    fullRedeemBuckets: CertificatesVelocityBucketRow[];
+    /** Медианное число дней от покупки до первого применения. */
+    medianDaysToFirstUse: number | null;
+    /** Медианное число дней от покупки до полного погашения. */
+    medianDaysToFullRedeem: number | null;
+    /** Активировано в течение 7 дней после покупки. */
+    activatedWithin7d: number;
+    /** Активировано в течение 30 дней после покупки. */
+    activatedWithin30d: number;
+    /** Полностью погашено в течение 30 дней после покупки. */
+    fullyRedeemedWithin30d: number;
+    /** Полностью погашено в течение 90 дней после покупки. */
+    fullyRedeemedWithin90d: number;
+    /** «Спящие» — куплены больше 90 дней назад и ни разу не применены. */
+    dormantOver90d: number;
+    /** Сгорели (expireDate < сегодня) и не были полностью использованы. */
+    expiredUnused: number;
+};
 export type CertificatesReportRO = {
     overview: CertificatesOverview;
     dynamic: CertificatesDynamicRow[];
@@ -73,4 +135,5 @@ export type CertificatesReportRO = {
     bySource: CertificatesBySourceRow[];
     byDelivery: CertificatesByDeliveryRow[];
     byUtm: CertificatesByUtmRow[];
+    redemption: CertificatesRedemptionVelocity;
 };

package/dist/statistics/promocodes.d.ts

@@ -1,4 +1,13 @@
 import { PromocodeKindEnum } from '../promocode/emun/promocode-kind.enum';
+import { DashboardQueryDto } from './pnl';
+/**
+ * Запрос отчёта по промокодам. Расширяет общий `DashboardQueryDto`
+ * опциональным фильтром по типу промокода (`kind`). При отсутствии
+ * `kind` бекенд считает по всем типам как раньше.
+ */
+export declare class PromocodesQueryDto extends DashboardQueryDto {
+    kind?: PromocodeKindEnum;
+}
 /**
  * Богатый отчёт по промокодам за выбранный период.
  *
@@ -37,22 +46,9 @@ export type PromocodesTopRow = {
     applications: number;
     discountAmount: number;
 };
-export type PromocodesTimelineRow = {
-    period: string;
-    created: number;
-    applied: number;
-    discountAmount: number;
-};
-export type PromocodesByUtmRow = {
-    utmCampaign: string;
-    applications: number;
-    discountAmount: number;
-};
 export type PromocodesReportRO = {
     kpi: PromocodesKpi;
     byKind: PromocodesByKindRow[];
     byChannel: PromocodesByChannelRow[];
     topPromocodes: PromocodesTopRow[];
-    timeline: PromocodesTimelineRow[];
-    topUtmCampaigns: PromocodesByUtmRow[];
 };

package/dist/statistics/promocodes.js

@@ -1,2 +1,28 @@
 "use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.PromocodesQueryDto = void 0;
+const class_validator_1 = require("class-validator");
+const promocode_kind_enum_1 = require("../promocode/emun/promocode-kind.enum");
+const pnl_1 = require("./pnl");
+/**
+ * Запрос отчёта по промокодам. Расширяет общий `DashboardQueryDto`
+ * опциональным фильтром по типу промокода (`kind`). При отсутствии
+ * `kind` бекенд считает по всем типам как раньше.
+ */
+class PromocodesQueryDto extends pnl_1.DashboardQueryDto {
+}
+exports.PromocodesQueryDto = PromocodesQueryDto;
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsEnum)(promocode_kind_enum_1.PromocodeKindEnum),
+    __metadata("design:type", String)
+], PromocodesQueryDto.prototype, "kind", void 0);