@monetize.software/sdk 3.0.0-alpha.0 → 3.0.0-alpha.10

package/dist/core.d.ts

@@ -46,7 +46,9 @@ export declare class ApiGatewayClient {
 
 export declare interface ApiGatewayClientOptions {
     paywallId: string;
-    apiOrigin?: string;
+    /** Origin серверного API SDK — обязательное поле, тот же `custom_domain`, что
+     *  у BillingClient/AuthClient. См. {@link BillingClientOptions.apiOrigin}. */
+    apiOrigin: string;
     /** AuthClient — Bearer добавляется автоматически. На 401 от gateway клиент
      *  не делает refresh: AuthClient уже сделал lazy-refresh в getAccessToken. */
     auth?: AuthClient;
@@ -66,7 +68,28 @@ export declare interface ApiGatewayClientOptions {
     onQuotaExceeded?: (err: QuotaExceededError) => void;
 }
 
-export declare type AuthChangeListener = (session: AuthSession | null) => void;
+/** Дискриминатор для `onAuthChange`. Позволяет listener'у отличать первый
+ *  callback (восстановление сессии из storage / синтетический snapshot для
+ *  свежей подписки) от реальных переходов. Конвенция Supabase, минус события,
+ *  которых у нас нет (MFA, EMAIL_VERIFIED).
+ *
+ *  - INITIAL_SESSION — единственный гарантированный первый callback на каждую
+ *    подписку. Дёргается через microtask после resolve hydrated-promise, даже
+ *    если session=null. Listener'ы по этому event'у НЕ должны делать побочные
+ *    эффекты типа force-refetch — это просто доставка стартового state'а.
+ *  - SIGNED_IN — свежий вход: email/OAuth/anon, или появление session в этом
+ *    инстансе из другого контекста (storage.watch), когда раньше был null.
+ *  - SIGNED_OUT — signOut, revokeAllSessions, 401 на refresh, удаление session
+ *    из другого контекста.
+ *  - TOKEN_REFRESHED — тот же user, обновлённые токены: refresh(), либо
+ *    storage.watch когда содержимое сменилось но user.id остался.
+ *  - USER_UPDATED — изменился user.email / user.user_metadata (updatePassword,
+ *    upgradeAnonymousToEmail) при том же user.id.
+ *  - PASSWORD_RECOVERY — verifyOtp(type='recovery'). Listener знает, что надо
+ *    показать «set new password» UI вместо обычного post-login flow'а. */
+declare type AuthChangeEvent = 'INITIAL_SESSION' | 'SIGNED_IN' | 'SIGNED_OUT' | 'TOKEN_REFRESHED' | 'USER_UPDATED' | 'PASSWORD_RECOVERY';
+
+export declare type AuthChangeListener = (event: AuthChangeEvent, session: AuthSession | null) => void;
 
 export declare class AuthClient {
     readonly paywallId: string;
@@ -225,10 +248,8 @@ export declare class AuthClient {
      * когда сервер начнёт возвращать challenge_required в риск-сценариях,
      * SDK сможет передать proof-of-something обратно без breaking change.
      *
-     * `forceCaptcha: true` пропускает шаги 1-2 и сразу делает /signin (создаёт
-     * нового anon-юзера). Используется в switch-account flow. Имя поля исторически
-     * остаётся `forceCaptcha`, хотя капчи там больше нет — менять имя ломает
-     * host-сигнатуру; смысл «принудительно новая anon-сессия» сохранён.
+     * `forceNewAnon: true` пропускает шаги 1-2 и сразу делает /signin (создаёт
+     * нового anon-юзера). Используется в switch-account flow.
      *
      * Параллельные вызовы дедуплицируются через `inflightAnonSignin` — два
      * click'а на «Войти как гость» не создадут двух anon-юзеров (два /signup =
@@ -237,7 +258,7 @@ export declare class AuthClient {
     signInAnonymously(input?: {
         captchaToken?: string;
         userMeta?: Record<string, string>;
-        forceCaptcha?: boolean;
+        forceNewAnon?: boolean;
     }): Promise<AuthSession>;
     /**
      * Внутренний resume — пробует /auth/refresh с сохранённым anon refresh_token.
@@ -385,8 +406,19 @@ export declare class AuthClient {
     }): Promise<void>;
     /**
      * Подписка на изменения session: signin/signup/refresh/signOut/expired-401.
-     * Колбек вызывается с текущим snapshot через microtask (если session есть)
-     * + на каждое реальное изменение. Возвращает unsubscribe.
+     *
+     * Гарантированный контракт: ПЕРВЫЙ callback каждому subscriber'у — всегда
+     * `event = 'INITIAL_SESSION'`, дёргается асинхронно после resolve hydrate'а
+     * (даже если session=null — listener получает explicit «нет сессии», а не
+     * молчание). Все последующие callback'и — реальные переходы с конкретным
+     * event'ом (SIGNED_IN / SIGNED_OUT / TOKEN_REFRESHED / USER_UPDATED /
+     * PASSWORD_RECOVERY).
+     *
+     * Это позволяет listener'у безопасно делать «only on real signin» побочные
+     * эффекты (force refetch balances и т.п.) через `event === 'SIGNED_IN'`,
+     * не путая их с восстановлением из storage.
+     *
+     * Возвращает unsubscribe.
      */
     onAuthChange(cb: AuthChangeListener): () => void;
     private isFresh;
@@ -412,6 +444,18 @@ export declare class AuthClient {
     private readAnonRefreshToken;
     private writeAnonRefreshToken;
     private clearAnonRefreshToken;
+    /**
+     * Last-used auth method + email — для UI бейджа "Last used" и pre-fill'а
+     * email-инпута. Storage paywall-scoped, поэтому переключение между
+     * пейволами на одном host'е не пересекает данные. Чтение всегда возвращает
+     * объект — отсутствующие поля = null. */
+    getLastLogin(): Promise<LastLogin | null>;
+    /** Запись method и email атомарно (для email/password flows — оба известны
+     *  на момент signin/signup'а). OAuth-flows используют раздельные
+     *  recordLastLoginMethod (до popup) и recordLastLoginEmail (после exchange). */
+    private recordLastLogin;
+    private recordLastLoginMethod;
+    private recordLastLoginEmail;
     /**
      * Читает stable visitor_id из storage если он там уже есть. НЕ генерит:
      * AuthClient может быть инстанцирован раньше BillingClient, а синтетический
@@ -424,7 +468,9 @@ export declare class AuthClient {
 
 export declare interface AuthClientOptions {
     paywallId: string;
-    apiOrigin?: string;
+    /** Origin серверного API SDK — обязательное поле, тот же `custom_domain`, что
+     *  у BillingClient. См. {@link BillingClientOptions.apiOrigin}. */
+    apiOrigin: string;
     storage?: StorageAdapter;
     fetch?: typeof fetch;
     openPopup?: (url: string, name: string) => Window | null;
@@ -487,6 +533,8 @@ export declare class BillingClient {
     private balancesStorageUnwatch;
     private inflightBalances;
     private balanceListeners;
+    private readonly previewMode;
+    private previewVersionCounter;
     constructor(opts: BillingClientOptions);
     /**
      * Stable visitor_id (UUID v4). Первый вызов awaitит первичный резолв из
@@ -519,6 +567,24 @@ export declare class BillingClient {
      * unsubscribe.
      */
     onBootstrapChange(cb: (b: PaywallBootstrap) => void): () => void;
+    /**
+     * Заменить cachedBootstrap частичными или полными данными и эмитнуть всем
+     * подписчикам. Используется host'ом в preview-mode (редактор админки) для
+     * live-обновления открытой модалки без сетевого revalidate'а.
+     *
+     * Поведение:
+     *  - Без `cachedBootstrap` ожидаются как минимум `settings` + `prices` —
+     *    иначе PaywallRoot не сможет отрендерить тарифы и упадёт.
+     *  - С существующим кешем партиал мёрджится поверх: `settings` глубокий мёрдж
+     *    на 1 уровень (поля настроек), массивы `prices`/`offers` перезаписываются.
+     *  - Каждый вызов бампит `version` ("preview:<n>"), чтобы applyBootstrap'овая
+     *    проверка `versionChanged` всегда срабатывала и listener'ы дёргались.
+     *  - Persist в storage НЕ делаем — preview не должен утекать в другие вкладки.
+     *
+     * В non-preview режиме метод доступен, но это редкий путь (например, для
+     * тестов host'а) — production-код должен полагаться на bootstrap() + revalidate.
+     */
+    setBootstrap(partial: Partial<PaywallBootstrap>): void;
     private fetchBootstrap;
     private revalidateBootstrap;
     private applyBootstrap;
@@ -544,6 +610,13 @@ export declare class BillingClient {
     }): Promise<PaywallPrice[]>;
     /** Sync-снимок цен из последнего bootstrap'а. null = ещё не загружали. */
     getCachedPrices(): PaywallPrice[] | null;
+    /** Sync-снимок офферов из последнего bootstrap'а. null = bootstrap ещё не
+     *  загружали, пустой массив = бэк отдал пейвол без офферов. Бэк уже
+     *  применил серверный таргетинг (target_countries / target_emails /
+     *  targeting_mode из offer_settings) — наружу выезжает только то, что
+     *  применимо к текущему юзеру. Клиентская сторона остаётся ответственной
+     *  за price_id-matching и countdown (см. core/offer.ts → resolveOffer). */
+    getCachedOffers(): PaywallOffer[] | null;
     /**
      * Снимок того, какой язык SDK сейчас считает «языком юзера». Полезно для
      * синхронизации i18n хоста с тем, что фактически показывает пейвол — чтобы
@@ -718,21 +791,31 @@ export declare class BillingClient {
      * `/api/v1/paywall/[id]/user` без unstable_cache, потому что list для UI
      * должен быть свежим после cancel-а.
      *
-     * Auth: Bearer обязателен (через AuthClient). Без Bearer — 401 от бэка,
-     * пробрасываем как PaywallError('http_401'). Гость → пустой список.
+     * Auth (два пути):
+     *  - Bearer (через AuthClient) — user.id резолвится из сессии, identity
+     *    в query игнорируется.
+     *  - `apiKey` + `identity.email`/`identity.userId` — server-SDK путь для
+     *    интеграций со своей авторизацией. Бэк проверяет, что identity линкована
+     *    к этому пейволу (защита от cross-paywall lookup).
+     * Без auth и без apiKey+identity — `identity_required`.
      */
     listPurchases(opts?: {
         signal?: AbortSignal;
     }): Promise<PaywallPurchaseDetailed[]>;
     /**
-     * Отменить подписку. Бэк проверит что subscription принадлежит auth-юзеру
-     * и сделает cancel у acquiring'а (Stripe/Paddle/Chargebee). По умолчанию
-     * cancel в конце текущего периода — юзер сохраняет access до renewal date'ы.
+     * Отменить подписку. Бэк проверит, что subscription принадлежит юзеру
+     * (Bearer-путь — из сессии; apiKey-путь — из identity), и сделает cancel у
+     * acquiring'а (Stripe/Paddle/Chargebee/Overpay). По умолчанию cancel в
+     * конце текущего периода — юзер сохраняет access до renewal date'ы.
      *
-     * `reason` обязательна (валидация на бэке). Удобно собрать через select
-     * причин в host-UI, как в legacy customer portal'е.
+     * `reason` обязательна (валидация на бэке).
      *
-     * Auth: Bearer обязателен.
+     * Auth (два пути):
+     *  - Bearer (через AuthClient) — стандартный путь для UI customer-portal'a.
+     *  - `apiKey` + `identity.email`/`identity.userId` — для self-service UI на
+     *    бэке клиента со своей авторизацией. Бэк дополнительно фильтрует
+     *    subscription по paywall_id, чтобы owner пейвола A не отменил подписку
+     *    пейвола B.
      */
     cancelSubscription(params: {
         subscriptionId: string;
@@ -769,7 +852,15 @@ export declare class BillingClient {
 
 export declare interface BillingClientOptions {
     paywallId: string;
-    apiOrigin?: string;
+    /**
+     * Origin серверного API SDK — обязательное поле. Должно совпадать с
+     * `custom_domain`, заданным для пейвола в платформе (модерация привязывает
+     * домен к paywall_id). SDK сверяет это значение с `bootstrap.settings.custom_domain`
+     * на первом ответе и кидает `invalid_config` при расхождении — защита от
+     * опечаток интегратора. Промежуточный `appbox.space` в новом SDK НЕ
+     * используется (это только для legacy v2).
+     */
+    apiOrigin: string;
     identity?: Identity;
     storage?: StorageAdapter;
     capabilities?: string[];
@@ -790,6 +881,16 @@ export declare interface BillingClientOptions {
      * через `setIdentity`, Bearer не отправляется.
      */
     auth?: AuthClient;
+    /**
+     * Preview/editor-mode. Когда true:
+     *  - `bootstrap()` НЕ ходит в сеть — отдаёт только `cachedBootstrap`, заданный
+     *    через `setBootstrap()`. Без seed'а throw'ает (caller обязан засидить до open).
+     *  - Storage.watch / persist отключены (preview редактора локален для текущей вкладки).
+     *  - `setBootstrap(partial)` доступен как публичный setter — host'у разрешено
+     *    мутировать кеш для live-обновления модалки в редакторе админки.
+     * Дефолт false — обычный production-режим.
+     */
+    preview?: boolean;
 }
 
 export declare interface CheckoutResult {
@@ -845,6 +946,11 @@ export declare interface EventTrackerOptions {
     sendBeacon?: (url: string, data: BodyInit) => boolean;
 }
 
+/** Pick the offer applicable to a price. Targeted (`price_id === id`) wins
+ *  over the global default (`price_id === null`). Offers without a positive
+ *  `discount_percent` are ignored. */
+export declare function findApplicableOffer(offers: PaywallOffer[] | null | undefined, priceId: string): PaywallOffer | null;
+
 export declare function generateVisitorId(): string;
 
 export declare interface Identity {
@@ -853,6 +959,18 @@ export declare interface Identity {
     anonymousId?: string;
 }
 
+export declare interface LastLogin {
+    method: LastLoginMethod;
+    email: string | null;
+}
+
+/** Метод, которым юзер залогинился в последний раз на этом пейволе.
+ *  Хранится per-paywall в storage и используется UI чтобы:
+ *   - предзаполнить email-инпут last-known email'ом;
+ *   - подсветить ту же OAuth-кнопку / email-форму бейджем "Last used".
+ *  `email` — email/password forms (signin или signup → confirm). */
+export declare type LastLoginMethod = OAuthProvider | 'email';
+
 export declare interface Layout {
     type: 'modal';
     blocks: LayoutBlock[];
@@ -868,9 +986,13 @@ export declare type LayoutBlock = {
 } | {
     type: 'price_grid';
     priceIds?: string[];
-    /** Раскладка карточек цен. `vertical` (default) — стек сверху вниз;
-     *  `horizontal` — ряд side-by-side. v2-аналог `view: 'default' | 'telegram'`. */
-    view?: 'vertical' | 'horizontal';
+    /** Раскладка карточек цен:
+     *  - `vertical` (default) — стек карточек сверху вниз;
+     *  - `compact` — компактный список (одна строка на цену, без карточки,
+     *    с разделителем); v2-аналог `view: 'telegram'`;
+     *  - `horizontal` — несколько карточек рядом в ряд; v2-only с момента
+     *    SDK 3.0 (legacy не показывает выбор этой опции в админке). */
+    view?: 'vertical' | 'compact' | 'horizontal';
     /** ID цены, которая помечается лейблом «популярный план». v2-аналог
      *  пары `price_label_id` + `price_label`. */
     popular_price_id?: string;
@@ -879,7 +1001,10 @@ export declare type LayoutBlock = {
     popular_label?: string;
 } | {
     type: 'cta_button';
-    label: string;
+    /** Текст на кнопке. Если не задан — рендерер сам подберёт по
+     *  selected price'у и `trial_days`: "Start N-Day Free Trial",
+     *  "Get Lifetime Access", "Get Monthly Plan" и т.п. */
+    label?: string;
     action: 'checkout' | 'close';
     priceId?: string;
 } | {
@@ -898,8 +1023,23 @@ export declare type LayoutBlock = {
     /** Скрывать панель, если юзер уже залогинен. По умолчанию true.
      *  false — показываем "Signed in as ... [Sign out]" даже после логина. */
     hide_when_authenticated?: boolean;
-    /** Заголовок над формой (h2). Если опущен — заголовок не рендерится. */
+    /** Кастомный заголовок над формой. Если задан — отображается вместо
+     *  дефолтного (определяется по mode'у — "Welcome back!" / "Welcome!" /
+     *  "Forgot password?" / ...). Без `submit_label` также используется как
+     *  submit-лейбл для signin (например `heading="Restore Purchases"` →
+     *  submit тоже "Restore Purchases"). Длинные heading (типа "Войдите,
+     *  чтобы продолжить покупку") в кнопку влезают плохо — задай
+     *  `submit_label` отдельно. */
     heading?: string;
+    /** Подпись под заголовком. Если опущен — подставляется default-текст
+     *  для текущего mode'а. Передай пустую строку чтобы скрыть подпись. */
+    subheading?: string;
+    /** Явный текст submit-кнопки. Имеет приоритет над heading-эхо. Нужен
+     *  для интентов с длинным descriptive heading'ом (preauth: "Войдите,
+     *  чтобы продолжить покупку" — кнопка только "Войти"). Для коротких
+     *  action-headings (restore: "Restore Purchases") опускай — эхо
+     *  даёт правильный UX. */
+    submit_label?: string;
 } | {
     /** Список фич/преимуществ продукта. v2-аналог `features_list` + `features_view`.
      *  До 5 элементов — рендерим как чек-лист с заголовком и описанием. */
@@ -923,6 +1063,35 @@ export declare type LayoutBlock = {
         desc: string;
         count: number;
     }>;
+} | {
+    /** Money-back guarantee badge под cta_button: иконка + жирный заголовок +
+     *  пояснение мелким шрифтом + bottom divider, который визуально стыкуется
+     *  с current_session ниже. v2-аналог inline-блока в `PaywallPricing`. */
+    type: 'guarantee_badge';
+    /** Заголовок жирным. По умолчанию "100% Money-Back Guarantee". */
+    title?: string;
+    /** Подзаголовок мелким серым. По умолчанию
+     *  "Not satisfied? We'll refund you — no questions asked.". */
+    subtitle?: string;
+    /** Иконка слева от заголовка. По умолчанию `dollar_shield` —
+     *  зелёный shield с долларом (legacy-вид). `none` — без иконки. */
+    icon?: 'dollar_shield' | 'none';
+} | {
+    /** Urgency-баннер с countdown'ом до конца offer'а. Берёт первый offer
+     *  из `bootstrap.offers` с валидным `expires_at` или `duration_minutes`.
+     *  Авто-скрывается по истечении, чтобы не показывать "0d 0h 0m 0s".
+     *  Размещение — обычно первый блок в layout (над heading). */
+    type: 'offer_banner';
+    /** ID конкретного offer'а из bootstrap.offers. Если не задано — берётся
+     *  первый offer с активным таймером. */
+    offer_id?: string;
+    /** Текст слева от countdown'а. Если опущен — берётся `offer.label`,
+     *  иначе fallback "Limited-time offer". К нему дописывается процент:
+     *  "{title} {discount_percent}%" если discount задан. */
+    title?: string;
+    /** В превью админки — игнорировать expired-state, всё равно показывать
+     *  banner с нулями. Прод-режим — false (banner исчезает). */
+    force?: boolean;
 };
 
 /** Локализационные оверрайды для одного языка. Накатываются поверх дефолтного
@@ -942,6 +1111,11 @@ export declare interface LocaleOverrides {
 
 export declare type OAuthProvider = 'google' | 'apple' | 'github' | 'facebook';
 
+/** Storage key under which a relative `duration_minutes` offer records its
+ *  first-view timestamp. Shared between the renderer (which writes the
+ *  start on first open) and the host SDK helpers (which read it). */
+export declare function offerStartStorageKey(offerId: string): string;
+
 export declare type OtpVerifyType = 'email' | 'recovery' | 'signup' | 'magiclink' | 'invite';
 
 export declare interface PaywallBootstrap {
@@ -977,7 +1151,15 @@ export declare class PaywallError extends Error {
 export declare interface PaywallOffer {
     id: string;
     discount_percent: number | null;
+    /** Абсолютная expiration date (ISO 8601). Если задана — countdown отсчитывает
+     *  до этого момента, по истечении offer считается истёкшим. */
     expires_at: string | null;
+    /** Относительный таймер: сколько минут offer живёт **от первого просмотра
+     *  пейвола** данным юзером. Старт хранится в clientStorage под ключом
+     *  `pw-offer-{id}-start`, по истечении — auto-cleanup. Используется, когда
+     *  бэк хочет показывать "remaining time" без жёсткой server-time, а считать
+     *  относительно сессии юзера. expires_at имеет приоритет если задано. */
+    duration_minutes?: number | null;
     price_id: string | null;
     label?: string | null;
 }
@@ -1027,6 +1209,14 @@ export declare interface PaywallSettings {
     brand_color?: string | null;
     custom_css?: string | null;
     locale_default?: string | null;
+    /** Origin, на котором живёт бэк пейвола (тот же, что мерчант передаёт в
+     *  `BillingClientOptions.apiOrigin` при инициализации SDK). Бэк присылает
+     *  его на каждом bootstrap'е, SDK сверяет с init.apiOrigin — расхождение
+     *  даёт `invalid_config` (защита от опечатки интегратора). Без схемы:
+     *  "pay.your-domain.com" или "https://pay.your-domain.com" — оба валидны.
+     *  Для новых пейволов поле всегда заполнено (модерация требует custom_domain);
+     *  для legacy v2 может быть null/undefined. */
+    custom_domain?: string | null;
     runtime_mode?: 'client' | 'hybrid' | 'server' | 'client-native' | 'hybrid-native';
     /** true, если эквайринг пейвола в test-mode — SDK рисует TEST MODE бейдж. */
     is_test_mode?: boolean;
@@ -1084,6 +1274,12 @@ export declare interface PaywallUser {
         started_at: string | null;
         expires_at: string | null;
     } | null;
+    /** Был ли у юзера хотя бы один trial по этому пейволу когда-либо (включая
+     *  истёкшие и отменённые). Anti-abuse флаг для UI: CtaButton скрывает
+     *  "Start N-Day Free Trial" если true. Серверный enforcement в
+     *  `/start-checkout` дублирует — даже если UI обмануть, бэк не отдаст
+     *  trial_days в Stripe/Paddle. */
+    had_previous_trial: boolean;
 }
 
 export declare interface PaywallUserPurchase {
@@ -1108,6 +1304,51 @@ export declare class QuotaExceededError extends PaywallError {
     });
 }
 
+/** Safe browser localStorage getter — returns null in SSR / private mode. */
+export declare function readBrowserOfferStart(offerId: string): string | null;
+
+/**
+ * Resolved view of a paywall offer — what host UI actually needs to render
+ * a strike-through price + countdown without re-implementing the math.
+ *
+ * `remainingMs` ticks down with wall-clock time and reaches 0 on expiry.
+ * `totalMs` stays constant — useful for progress bars / share-of-time UX.
+ * `expiresAt` is the Date.now()-comparable epoch ms of expiry.
+ *
+ * For offers without an expiry mechanism (no `expires_at` and no
+ * `duration_minutes`), `remainingMs`/`totalMs`/`expiresAt` are all `null`,
+ * but the resolved view is still returned — discount badge / strike-through
+ * still make sense for "perpetual sale" offers.
+ */
+export declare interface ResolvedOffer {
+    offer: PaywallOffer;
+    discountPercent: number;
+    remainingMs: number | null;
+    totalMs: number | null;
+    expiresAt: number | null;
+}
+
+/** Compute the resolved view of an offer. Pure, no side-effects. */
+export declare function resolveOffer(offer: PaywallOffer, opts?: ResolveOfferOptions): ResolvedOffer | null;
+
+export declare interface ResolveOfferOptions {
+    /** Current epoch ms. Inject for deterministic tests; default `Date.now()`. */
+    now?: number;
+    /**
+     * Synchronous reader for the `duration_minutes` start-timestamp ISO string.
+     * Host passes a closure over its sync storage (browser → `localStorage`,
+     * memory → in-process map). Return `null` if no start has been recorded.
+     *
+     * Intentionally synchronous, because consumers call this from UI render —
+     * an async StorageAdapter would force every price card to suspend.
+     *
+     * If omitted, `duration_minutes`-only offers return `expiresAt = null`,
+     * which makes the resolved view treat them as "not yet started" (the
+     * renderer is responsible for writing the start on first paywall view).
+     */
+    readStart?: (offerId: string) => string | null;
+}
+
 export declare const SDK_VERSION = "3.0.0-alpha.0";
 
 export declare type SignUpResult = {