@escapenavigator/types 1.10.122 → 1.10.124

package/dist/openapi/orders/openapi-order.ro.d.ts

@@ -35,6 +35,7 @@ declare class Slot {
     tariff: OpenapiTariffRO;
 }
 export declare class OpenapiOrderRO extends QuestroomRow {
+    id: number;
     createdAt: Date;
     code: string;
     language?: Languages;

package/dist/openapi/orders/openapi-order.ro.js

@@ -106,6 +106,10 @@ __decorate([
 class OpenapiOrderRO extends openapi_questroom_ro_1.QuestroomRow {
 }
 exports.OpenapiOrderRO = OpenapiOrderRO;
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    __metadata("design:type", Number)
+], OpenapiOrderRO.prototype, "id", void 0);
 __decorate([
     (0, class_transformer_1.Expose)(),
     __metadata("design:type", Date)

package/dist/questroom/questroom-admin.ro.d.ts

@@ -1,7 +1,7 @@
 import { LocationRO } from '../location/location.ro';
 import { ProfileRO } from '../profile/profile.ro';
-import { QuestroomLightLocale as QuestroomLocale } from './questroom-light.ro';
 import { QuestroomRO } from './questroom.ro';
+import { QuestroomLightLocale as QuestroomLocale } from './questroom-light.ro';
 declare class City {
     title: string;
 }
@@ -18,7 +18,6 @@ export declare class QuestroomAdminRO extends QuestroomRO {
     questroomAwards: AwardRO[];
     minPrice: number;
     maxPrice: number;
-    oldData: string;
     top: boolean;
     verified: boolean;
     location: LocationAdminRO;

package/dist/questroom/questroom-admin.ro.js

@@ -14,8 +14,8 @@ exports.QuestroomAdminRO = exports.LocationAdminRO = void 0;
 const class_transformer_1 = require("class-transformer");
 const location_ro_1 = require("../location/location.ro");
 const profile_ro_1 = require("../profile/profile.ro");
-const questroom_light_ro_1 = require("./questroom-light.ro");
 const questroom_ro_1 = require("./questroom.ro");
+const questroom_light_ro_1 = require("./questroom-light.ro");
 class City {
 }
 __decorate([
@@ -64,10 +64,6 @@ __decorate([
     (0, class_transformer_1.Expose)(),
     __metadata("design:type", Number)
 ], QuestroomAdminRO.prototype, "maxPrice", void 0);
-__decorate([
-    (0, class_transformer_1.Expose)(),
-    __metadata("design:type", String)
-], QuestroomAdminRO.prototype, "oldData", void 0);
 __decorate([
     (0, class_transformer_1.Expose)(),
     __metadata("design:type", Boolean)

package/dist/questroom/questroom-extras.ro.d.ts

@@ -0,0 +1,23 @@
+import { QuestroomLightLocale, QuestroomLightMode } from './questroom-light.ro';
+/**
+ * Lazy-payload `modes` + `locales` для одного квеста.
+ *
+ * Возвращается из `GET /questrooms/extras` единым массивом
+ * `QuestroomExtrasRO[]` для всего scope (current profile / scope.questroomsIds)
+ * и кэшируется на фронте в `questroom-extras-slice`.
+ *
+ * Зачем отдельный endpoint:
+ *  - `QuestroomLightRO` (bootstrap) после Phase 3 не несёт `modes`/`locales` —
+ *    три `OneToMany` сняты с `eager: true` ради `getSlots` `findByIds` и
+ *    самого bootstrap'а. См. `docs/optimization/15-questroom-eager-removal.md`.
+ *  - Горячие модалки (`order`, `order-new`, `email-example`) читают только
+ *    `modes`/`locales` — full `QuestroomRO` им избыточен. Один общий
+ *    запрос дешевле, чем N запросов `useGetOne(id)` при каждом открытии.
+ *
+ * Payload: ~700 байт на квест × до 50 квестов = ~35 КБ на сессию.
+ */
+export declare class QuestroomExtrasRO {
+    questroomId: number;
+    modes: QuestroomLightMode[];
+    locales: QuestroomLightLocale[];
+}

package/dist/questroom/questroom-extras.ro.js

@@ -0,0 +1,49 @@
+"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.QuestroomExtrasRO = void 0;
+/* eslint-disable max-classes-per-file */
+const class_transformer_1 = require("class-transformer");
+const questroom_light_ro_1 = require("./questroom-light.ro");
+/**
+ * Lazy-payload `modes` + `locales` для одного квеста.
+ *
+ * Возвращается из `GET /questrooms/extras` единым массивом
+ * `QuestroomExtrasRO[]` для всего scope (current profile / scope.questroomsIds)
+ * и кэшируется на фронте в `questroom-extras-slice`.
+ *
+ * Зачем отдельный endpoint:
+ *  - `QuestroomLightRO` (bootstrap) после Phase 3 не несёт `modes`/`locales` —
+ *    три `OneToMany` сняты с `eager: true` ради `getSlots` `findByIds` и
+ *    самого bootstrap'а. См. `docs/optimization/15-questroom-eager-removal.md`.
+ *  - Горячие модалки (`order`, `order-new`, `email-example`) читают только
+ *    `modes`/`locales` — full `QuestroomRO` им избыточен. Один общий
+ *    запрос дешевле, чем N запросов `useGetOne(id)` при каждом открытии.
+ *
+ * Payload: ~700 байт на квест × до 50 квестов = ~35 КБ на сессию.
+ */
+class QuestroomExtrasRO {
+}
+exports.QuestroomExtrasRO = QuestroomExtrasRO;
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    __metadata("design:type", Number)
+], QuestroomExtrasRO.prototype, "questroomId", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    (0, class_transformer_1.Type)(() => questroom_light_ro_1.QuestroomLightMode),
+    __metadata("design:type", Array)
+], QuestroomExtrasRO.prototype, "modes", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    (0, class_transformer_1.Type)(() => questroom_light_ro_1.QuestroomLightLocale),
+    __metadata("design:type", Array)
+], QuestroomExtrasRO.prototype, "locales", void 0);

package/dist/questroom/questroom-light.ro.d.ts

@@ -31,10 +31,16 @@ export declare class QuestroomLightMode {
  *  - `disabledLanguages`, `alternativeScenarioIds`,
  *    `requiredPositionsIds`
  *  - `profileId` (нигде в app-сторе не читается)
+ *  - `locales`, `modes` — три eager-OneToMany на `QuestroomEntity`
+ *    давали ×3 JOIN'а на каждый bootstrap и при `findByIds` в
+ *    `getSlots` (см. `docs/optimization/14-questroom-eager-removal.md`).
+ *    Модалки (order-new ModeSelector, email-example, questroom
+ *    localization, questroom modes editor) подтягивают полный
+ *    `QuestroomRO` через `useGetOne(id, questroomsApi.getOne)`.
  *
- * Остальное (включая `photos`, `legend`, `importantInfo`, `modes`,
- * `actors` и т.д.) используется в verify-company onboarding,
- * order-new, calendar и settings — поэтому остаётся в light.
+ * Остальное (`photos`, `legend`, `importantInfo`, `actors` и т.д.)
+ * используется в verify-company onboarding, calendar и settings —
+ * поэтому остаётся в light.
  */
 export declare class QuestroomLightRO extends RO {
     deletedAt?: Date;
@@ -42,17 +48,10 @@ export declare class QuestroomLightRO extends RO {
     locationId: number;
     type: QuestroomTypeEnum;
     difficult: number;
-    locales: QuestroomLightLocale[];
-    modes: QuestroomLightMode[];
     fear: number;
     minAge: number;
     time: number;
     templateId: number;
-    /**
-     * Type of the linked SlotTemplate (`fixed` or `flex`). Denormalized from
-     * `SlotTemplate.type` so consumers (calendar, schedule editor) can branch
-     * on the schedule kind without an extra fetch.
-     */
     templateType?: SlotTemplateType;
     ticketSystem: boolean;
     resourceUnitsTotal: number;

package/dist/questroom/questroom-light.ro.js

@@ -72,10 +72,16 @@ __decorate([
  *  - `disabledLanguages`, `alternativeScenarioIds`,
  *    `requiredPositionsIds`
  *  - `profileId` (нигде в app-сторе не читается)
+ *  - `locales`, `modes` — три eager-OneToMany на `QuestroomEntity`
+ *    давали ×3 JOIN'а на каждый bootstrap и при `findByIds` в
+ *    `getSlots` (см. `docs/optimization/14-questroom-eager-removal.md`).
+ *    Модалки (order-new ModeSelector, email-example, questroom
+ *    localization, questroom modes editor) подтягивают полный
+ *    `QuestroomRO` через `useGetOne(id, questroomsApi.getOne)`.
  *
- * Остальное (включая `photos`, `legend`, `importantInfo`, `modes`,
- * `actors` и т.д.) используется в verify-company onboarding,
- * order-new, calendar и settings — поэтому остаётся в light.
+ * Остальное (`photos`, `legend`, `importantInfo`, `actors` и т.д.)
+ * используется в verify-company onboarding, calendar и settings —
+ * поэтому остаётся в light.
  */
 class QuestroomLightRO extends ro_class_1.RO {
 }
@@ -100,16 +106,6 @@ __decorate([
     (0, class_transformer_1.Expose)(),
     __metadata("design:type", Number)
 ], QuestroomLightRO.prototype, "difficult", void 0);
-__decorate([
-    (0, class_transformer_1.Expose)(),
-    (0, class_transformer_1.Type)(() => QuestroomLightLocale),
-    __metadata("design:type", Array)
-], QuestroomLightRO.prototype, "locales", void 0);
-__decorate([
-    (0, class_transformer_1.Expose)(),
-    (0, class_transformer_1.Type)(() => QuestroomLightMode),
-    __metadata("design:type", Array)
-], QuestroomLightRO.prototype, "modes", void 0);
 __decorate([
     (0, class_transformer_1.Expose)(),
     __metadata("design:type", Number)

package/dist/questroom/questroom.ro.d.ts

@@ -1,8 +1,18 @@
 import { Languages } from '../shared/enum/languages.enum';
 import { QuestroomLightLocale, QuestroomLightMode, QuestroomLightRO } from './questroom-light.ro';
-export { QuestroomLightLocale as QuestroomLocale };
-export { QuestroomLightMode as QuestroomMode };
+export { QuestroomLightLocale as QuestroomLocale, QuestroomLightMode as QuestroomMode };
+/**
+ * Полный quest RO. Возвращается из `GET /questrooms/:id`. Содержит
+ * `locales` и `modes`, которые НЕ грузятся в `QuestroomLightRO` ради
+ * экономии на bootstrap и `getSlots` `findByIds` (см.
+ * `QuestroomEntity` — все три OneToMany сняты с `eager: true`).
+ *
+ * Модалки на app фронте подтягивают полный объект через
+ * `useGetOne(id, questroomsApi.getOne)`.
+ */
 export declare class QuestroomRO extends QuestroomLightRO {
+    locales: QuestroomLightLocale[];
+    modes: QuestroomLightMode[];
     profileId: number;
     requiredPositionsIds: number[];
     alternativeScenarioIds: number[];

package/dist/questroom/questroom.ro.js

@@ -15,9 +15,28 @@ const class_transformer_1 = require("class-transformer");
 const questroom_light_ro_1 = require("./questroom-light.ro");
 Object.defineProperty(exports, "QuestroomLocale", { enumerable: true, get: function () { return questroom_light_ro_1.QuestroomLightLocale; } });
 Object.defineProperty(exports, "QuestroomMode", { enumerable: true, get: function () { return questroom_light_ro_1.QuestroomLightMode; } });
+/**
+ * Полный quest RO. Возвращается из `GET /questrooms/:id`. Содержит
+ * `locales` и `modes`, которые НЕ грузятся в `QuestroomLightRO` ради
+ * экономии на bootstrap и `getSlots` `findByIds` (см.
+ * `QuestroomEntity` — все три OneToMany сняты с `eager: true`).
+ *
+ * Модалки на app фронте подтягивают полный объект через
+ * `useGetOne(id, questroomsApi.getOne)`.
+ */
 class QuestroomRO extends questroom_light_ro_1.QuestroomLightRO {
 }
 exports.QuestroomRO = QuestroomRO;
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    (0, class_transformer_1.Type)(() => questroom_light_ro_1.QuestroomLightLocale),
+    __metadata("design:type", Array)
+], QuestroomRO.prototype, "locales", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    (0, class_transformer_1.Type)(() => questroom_light_ro_1.QuestroomLightMode),
+    __metadata("design:type", Array)
+], QuestroomRO.prototype, "modes", void 0);
 __decorate([
     (0, class_transformer_1.Expose)(),
     __metadata("design:type", Number)

package/dist/statistics/certificates.d.ts

@@ -11,10 +11,9 @@
  *
  * Семантика финансовых полей:
  *  - gross — стоимость по прайсу (SUM(total)). Не выручка.
- *  - cash — реально полученные деньги (SUM(cashReceived)). Это «выручка».
+ *  - cash — нетто-выручка: SUM(cashReceived), возвраты уже учтены в транзакциях со знаком.
  *  - discount — сумма ручных скидок (SUM(discountTotal)).
  *  - promocode — сумма промокодов (SUM(promocodeTotal)).
- *  - refunded — реально возвращённые клиенту деньги (SUM(refundedAmount)).
  *  - nominalSold — суммарный номинал когорты (SUM(nominal)).
  *  - nominalRedeemed — сколько из этого номинала уже потрачено в заказах
  *    (SUM(usedAmount)).
@@ -29,13 +28,11 @@ export type CertificatesOverview = {
     annulledCount: number;
     /** Сколько из когорты уже полностью погашено (fullyUsedAt IS NOT NULL). */
     fullyUsedCount: number;
-    /** Сколько ушло в подарок (isGift = true) среди soldCount. */
-    giftCount: number;
     gross: number;
+    /** Нетто-выручка: SUM(cashReceived), возвраты уже внутри. */
     cash: number;
     discount: number;
     promocode: number;
-    refunded: number;
     /** Средний чек по cash: cash / soldCount, 0 если нет продаж. */
     avgCheck: number;
     /** Суммарный номинал по когорте: SUM(nominal). */
@@ -53,17 +50,19 @@ export type CertificatesDynamicRow = {
     cash: number;
     discount: number;
     promocode: number;
-    refunded: number;
 };
-export type CertificatesByTemplateRow = {
-    certificateId: number | null;
-    designId: number | null;
-    nominalId: number | null;
+/** Топ дизайнов по snapshot `designTitle` (fallback — title v1-шаблона). */
+export type CertificatesByDesignTitleRow = {
     title: string;
     soldCount: number;
-    cash: number;
-    avgCheck: number;
 };
+/** Топ номиналов по полю `nominal` (размер в мин. единицах валюты). */
+export type CertificatesByNominalRow = {
+    nominal: number;
+    soldCount: number;
+};
+/** @deprecated Используйте CertificatesByDesignTitleRow */
+export type CertificatesByTemplateRow = CertificatesByDesignTitleRow;
 export type CertificatesBySourceRow = {
     source: string;
     soldCount: number;
@@ -131,7 +130,10 @@ export type CertificatesRedemptionVelocity = {
 export type CertificatesReportRO = {
     overview: CertificatesOverview;
     dynamic: CertificatesDynamicRow[];
-    byTemplate: CertificatesByTemplateRow[];
+    /** Топ-3 по названию дизайна (`designTitle`). */
+    byDesignTitle: CertificatesByDesignTitleRow[];
+    /** Топ-3 по размеру номинала (`nominal`). */
+    byNominal: CertificatesByNominalRow[];
     bySource: CertificatesBySourceRow[];
     byDelivery: CertificatesByDeliveryRow[];
     byUtm: CertificatesByUtmRow[];

package/dist/statistics/pnl.d.ts

@@ -5,8 +5,21 @@ export declare enum PeriodType {
     QUARTER = "quarter",
     YEAR = "year"
 }
+/**
+ * Запрос статистических отчётов.
+ *
+ * Период задаётся диапазоном дней `dateFrom..dateTo` (включительно), оба —
+ * `YYYY-MM-DD`. Это единый контракт для всех вкладок (Месяц/Квартал/Год/
+ * Произвольный период): фронт раскрывает выбранный шаг до конкретных
+ * границ диапазона и шлёт их сюда. Никакого округления до месяцев —
+ * операционные отчёты (orders/certificates/promocodes) фильтруют по
+ * `createdAt`/`paidAt` напрямую. Бухгалтерские отчёты (P&L/Cash Flow)
+ * внутри сервиса разворачивают диапазон в список месяцев под денорм-
+ * колонки `paymentPeriod`/`period` (см. TransactionService).
+ */
 export declare class DashboardQueryDto {
-    periods: string[];
+    dateFrom: string;
+    dateTo: string;
     locationId?: number;
     questroomId?: number;
     utmSource?: string;

package/dist/statistics/pnl.js

@@ -17,13 +17,31 @@ var PeriodType;
     PeriodType["QUARTER"] = "quarter";
     PeriodType["YEAR"] = "year";
 })(PeriodType || (exports.PeriodType = PeriodType = {}));
+/**
+ * Запрос статистических отчётов.
+ *
+ * Период задаётся диапазоном дней `dateFrom..dateTo` (включительно), оба —
+ * `YYYY-MM-DD`. Это единый контракт для всех вкладок (Месяц/Квартал/Год/
+ * Произвольный период): фронт раскрывает выбранный шаг до конкретных
+ * границ диапазона и шлёт их сюда. Никакого округления до месяцев —
+ * операционные отчёты (orders/certificates/promocodes) фильтруют по
+ * `createdAt`/`paidAt` напрямую. Бухгалтерские отчёты (P&L/Cash Flow)
+ * внутри сервиса разворачивают диапазон в список месяцев под денорм-
+ * колонки `paymentPeriod`/`period` (см. TransactionService).
+ */
 class DashboardQueryDto {
 }
 exports.DashboardQueryDto = DashboardQueryDto;
 __decorate([
-    (0, class_validator_1.IsArray)(),
-    __metadata("design:type", Array)
-], DashboardQueryDto.prototype, "periods", void 0);
+    (0, class_validator_1.IsString)(),
+    (0, class_validator_1.Matches)(/^\d{4}-\d{2}-\d{2}$/),
+    __metadata("design:type", String)
+], DashboardQueryDto.prototype, "dateFrom", void 0);
+__decorate([
+    (0, class_validator_1.IsString)(),
+    (0, class_validator_1.Matches)(/^\d{4}-\d{2}-\d{2}$/),
+    __metadata("design:type", String)
+], DashboardQueryDto.prototype, "dateTo", void 0);
 __decorate([
     (0, class_validator_1.IsOptional)(),
     (0, class_validator_1.IsOptional)(),