@astral/ui 4.82.0 → 4.84.0

package/node/components/Onboarding/core/ProgressStorage/ProgressStorage.d.ts

@@ -0,0 +1,24 @@
+import { type Logger } from '../../../../services/Logger';
+import { type SaveStrategy, type TourProgress } from '../../types';
+/**
+ * Обёртка над переданной SaveStrategy, изолирующая тур от исключений хранилища
+ *
+ * Записи выполняются строго последовательно : при async-стратегии это
+ * не даёт конкурентным вызовам переставиться местами — быстрый next/next,
+ * save→reset или save→skip сохранят порядок.
+ * `load()` ждёт текущее сохранение, поэтому читает уже применённое состояние.
+ */
+export declare class ProgressStorage {
+    private readonly strategy;
+    private readonly logger;
+    private saving;
+    constructor(strategy: SaveStrategy, logger: Logger);
+    load(): Promise<TourProgress | null>;
+    save(state: TourProgress): Promise<void>;
+    /**
+     * Полный сброс прогресса. Если стратегия умеет `remove` — запись удаляется;
+     * иначе поверх пишется пустое состояние.
+     */
+    reset(): Promise<void>;
+    private enqueue;
+}

package/node/components/Onboarding/core/ProgressStorage/ProgressStorage.js

@@ -0,0 +1,66 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProgressStorage = void 0;
+/**
+ * «Пустой» прогресс
+ */
+const CLEARED_STATE = {
+    lastStepName: '',
+    isCompleted: false,
+    isDismissed: false,
+};
+/**
+ * Обёртка над переданной SaveStrategy, изолирующая тур от исключений хранилища
+ *
+ * Записи выполняются строго последовательно : при async-стратегии это
+ * не даёт конкурентным вызовам переставиться местами — быстрый next/next,
+ * save→reset или save→skip сохранят порядок.
+ * `load()` ждёт текущее сохранение, поэтому читает уже применённое состояние.
+ */
+class ProgressStorage {
+    constructor(strategy, logger) {
+        this.strategy = strategy;
+        this.logger = logger;
+        this.saving = Promise.resolve();
+    }
+    async load() {
+        // Дожидаемся текущего сохранения, чтобы не прочитать состояние до него.
+        await this.saving;
+        try {
+            return await this.strategy.load();
+        }
+        catch (error) {
+            // Ошибка хранилища не должна ронять тур, но остаётся видимой в логах.
+            this.logger.warn('Ошибка чтения прогресса из хранилища', error);
+            return null;
+        }
+    }
+    save(state) {
+        return this.enqueue(() => this.strategy.save(state));
+    }
+    /**
+     * Полный сброс прогресса. Если стратегия умеет `remove` — запись удаляется;
+     * иначе поверх пишется пустое состояние.
+     */
+    reset() {
+        return this.enqueue(() => {
+            if (this.strategy.remove) {
+                return this.strategy.remove();
+            }
+            return this.strategy.save(CLEARED_STATE);
+        });
+    }
+    enqueue(write) {
+        this.saving = this.saving.then(async () => {
+            try {
+                await write();
+            }
+            catch (error) {
+                // Ошибка хранилища не должна ронять тур, но остаётся видимой в логах.
+                this.logger.warn('Ошибка записи прогресса в хранилище', error);
+            }
+        });
+        return this.saving;
+    }
+}
+exports.ProgressStorage = ProgressStorage;

package/node/components/Onboarding/core/ProgressStorage/index.d.ts

@@ -0,0 +1 @@
+export * from './ProgressStorage';

package/node/components/Onboarding/core/ProgressStorage/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./ProgressStorage"), exports);

package/node/components/Onboarding/core/StepNavigator/StepNavigator.d.ts

@@ -0,0 +1,28 @@
+import { type Step } from '../../types';
+/**
+ * Навигатор по шагам тура. Пропущенные шаги в навигации и в прогрессе не существуют.
+ */
+export declare class StepNavigator<TSteps extends readonly Step[] = readonly Step[]> {
+    private readonly steps;
+    /** Видимые шаги в порядке прохождения. */
+    private visibleSteps;
+    /** Текущая позиция среди видимых шагов */
+    private cursor;
+    constructor(steps: TSteps);
+    get current(): TSteps[number];
+    get position(): number;
+    get total(): number;
+    get hasNext(): boolean;
+    get hasPrev(): boolean;
+    next(): TSteps[number];
+    prev(): TSteps[number];
+    goToPosition(position: number): TSteps[number];
+    goToStep(stepName: string): TSteps[number];
+    /**
+     * Пересобирает список видимых шагов под актуальное состояние (здесь и только
+     * здесь вычисляются предикаты `shouldSkip`) и встаёт на первый шаг. Вызывается
+     * при (пере)запуске тура.
+     */
+    reset(): TSteps[number];
+    private collectVisibleSteps;
+}

package/node/components/Onboarding/core/StepNavigator/StepNavigator.js

@@ -0,0 +1,77 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StepNavigator = void 0;
+/**
+ * Нужно ли пропустить шаг.
+ */
+const isStepSkipped = (step) => {
+    const { shouldSkip } = step;
+    return typeof shouldSkip === 'function' ? shouldSkip() : Boolean(shouldSkip);
+};
+/**
+ * Навигатор по шагам тура. Пропущенные шаги в навигации и в прогрессе не существуют.
+ */
+class StepNavigator {
+    constructor(steps) {
+        this.steps = steps;
+        /** Видимые шаги в порядке прохождения. */
+        this.visibleSteps = [];
+        /** Текущая позиция среди видимых шагов */
+        this.cursor = 0;
+        this.visibleSteps = this.collectVisibleSteps();
+    }
+    get current() {
+        return this.visibleSteps[this.cursor] ?? this.steps[0];
+    }
+    get position() {
+        return this.cursor;
+    }
+    get total() {
+        return this.visibleSteps.length;
+    }
+    get hasNext() {
+        return this.cursor < this.visibleSteps.length - 1;
+    }
+    get hasPrev() {
+        return this.cursor > 0;
+    }
+    next() {
+        if (this.hasNext) {
+            this.cursor += 1;
+        }
+        return this.current;
+    }
+    prev() {
+        if (this.hasPrev) {
+            this.cursor -= 1;
+        }
+        return this.current;
+    }
+    goToPosition(position) {
+        if (position >= 0 && position < this.visibleSteps.length) {
+            this.cursor = position;
+        }
+        return this.current;
+    }
+    goToStep(stepName) {
+        const position = this.visibleSteps.findIndex((step) => step.name === stepName);
+        if (position !== -1) {
+            this.cursor = position;
+        }
+        return this.current;
+    }
+    /**
+     * Пересобирает список видимых шагов под актуальное состояние (здесь и только
+     * здесь вычисляются предикаты `shouldSkip`) и встаёт на первый шаг. Вызывается
+     * при (пере)запуске тура.
+     */
+    reset() {
+        this.visibleSteps = this.collectVisibleSteps();
+        this.cursor = 0;
+        return this.current;
+    }
+    collectVisibleSteps() {
+        return this.steps.filter((step) => !isStepSkipped(step));
+    }
+}
+exports.StepNavigator = StepNavigator;

package/node/components/Onboarding/core/StepNavigator/index.d.ts

@@ -0,0 +1 @@
+export * from './StepNavigator';

package/node/components/Onboarding/core/StepNavigator/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./StepNavigator"), exports);

package/node/components/Onboarding/core/StepResolver/StepResolver.d.ts

@@ -0,0 +1,19 @@
+import { type OnboardingTourConfig, type ResolvedStep, type Step, type StepOverride, type TourPresentation } from '../../types';
+/**
+ * Вычисляет итоговые значения по приоритету источников:
+ * - `title`/`content`: рантайм-override → значение шага;
+ * - `position`/`dialogSize`/видимость кнопок: шаг → значение по умолчанию;
+ * - `isInteractive`/`waitForTimeout`: шаг → конфигурация тура → значение по умолчанию;
+ * - презентация тура (`resolvePresentation`): конфигурация тура → значение по умолчанию.
+ */
+export declare class StepResolver {
+    private readonly config;
+    constructor(config: OnboardingTourConfig<readonly Step[]>);
+    resolve(step: Step, override?: StepOverride): ResolvedStep;
+    private resolveWaitForTimeout;
+    resolveIsInteractive(step: Step): boolean;
+    /**
+     * Конфигурация тура с применёнными значениями по умолчанию.
+     */
+    resolvePresentation(): TourPresentation;
+}

package/node/components/Onboarding/core/StepResolver/StepResolver.js

@@ -0,0 +1,53 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StepResolver = void 0;
+const constants_1 = require("../../constants");
+/**
+ * Вычисляет итоговые значения по приоритету источников:
+ * - `title`/`content`: рантайм-override → значение шага;
+ * - `position`/`dialogSize`/видимость кнопок: шаг → значение по умолчанию;
+ * - `isInteractive`/`waitForTimeout`: шаг → конфигурация тура → значение по умолчанию;
+ * - презентация тура (`resolvePresentation`): конфигурация тура → значение по умолчанию.
+ */
+class StepResolver {
+    constructor(config) {
+        this.config = config;
+    }
+    resolve(step, override) {
+        return {
+            ...step,
+            title: override?.title ?? step.title,
+            content: override?.content ?? step.content,
+            position: step.position ?? 'bottom',
+            dialogSize: step.dialogSize ?? 'xs',
+            isNextButtonVisible: step.isNextButtonVisible ?? true,
+            isPrevButtonVisible: step.isPrevButtonVisible ?? true,
+            waitForTimeout: this.resolveWaitForTimeout(step),
+        };
+    }
+    resolveWaitForTimeout(step) {
+        return (step.waitForTimeout ??
+            this.config.waitForTimeout ??
+            constants_1.DEFAULT_WAIT_ELEMENT_TIMEOUT_MS);
+    }
+    resolveIsInteractive(step) {
+        return step.isInteractive ?? this.config.isInteractive ?? false;
+    }
+    /**
+     * Конфигурация тура с применёнными значениями по умолчанию.
+     */
+    resolvePresentation() {
+        return {
+            isDotsVisible: this.config.isDotsVisible ?? true,
+            isCounterVisible: this.config.isCounterVisible ?? true,
+            confirmExit: this.config.confirmExit ?? {},
+            buttons: {
+                prevLabel: this.config.buttons?.prevLabel ?? 'Назад',
+                nextLabel: this.config.buttons?.nextLabel ?? 'Далее',
+                finishLabel: this.config.buttons?.finishLabel ?? 'Закрыть',
+                finishVariant: this.config.buttons?.finishVariant ?? 'contained',
+            },
+        };
+    }
+}
+exports.StepResolver = StepResolver;

package/node/components/Onboarding/core/StepResolver/index.d.ts

@@ -0,0 +1 @@
+export * from './StepResolver';

package/node/components/Onboarding/core/StepResolver/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./StepResolver"), exports);

package/node/components/Onboarding/core/StepsController/StepsController.d.ts

@@ -0,0 +1,16 @@
+import { type Step, type StepHandles, type StepOverride } from '../../types';
+/**
+ * Владеет рантайм-переопределениями содержимого шагов (через `tour.steps[name].setX`)
+ * и строит типобезопасную карту объектов управления `tour.steps`. О каждом изменении сообщает
+ * наружу через `onChange`, чтобы оркестратор перерисовал активный шаг, если он
+ * сейчас показан.
+ */
+export declare class StepsController<TSteps extends readonly Step[]> {
+    private readonly onChange;
+    private readonly overrides;
+    readonly handles: StepHandles<TSteps>;
+    constructor(steps: TSteps, onChange: (stepName: string) => void);
+    getOverride(stepName: string): StepOverride | undefined;
+    private patch;
+    private createHandles;
+}

package/node/components/Onboarding/core/StepsController/StepsController.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StepsController = void 0;
+const constants_1 = require("../../constants");
+/**
+ * Владеет рантайм-переопределениями содержимого шагов (через `tour.steps[name].setX`)
+ * и строит типобезопасную карту объектов управления `tour.steps`. О каждом изменении сообщает
+ * наружу через `onChange`, чтобы оркестратор перерисовал активный шаг, если он
+ * сейчас показан.
+ */
+class StepsController {
+    constructor(steps, onChange) {
+        this.onChange = onChange;
+        this.overrides = new Map();
+        this.handles = this.createHandles(steps);
+    }
+    getOverride(stepName) {
+        return this.overrides.get(stepName);
+    }
+    patch(stepName, override) {
+        this.overrides.set(stepName, {
+            ...this.overrides.get(stepName),
+            ...override,
+        });
+        this.onChange(stepName);
+    }
+    createHandles(steps) {
+        const handles = {};
+        steps.forEach((step) => {
+            handles[step.name] = {
+                getHighlightProps: () => ({ [constants_1.TOUR_ID_ATTR]: step.name }),
+                setTitle: (title) => this.patch(step.name, { title }),
+                setContent: (content) => this.patch(step.name, { content }),
+            };
+        });
+        return handles;
+    }
+}
+exports.StepsController = StepsController;

package/node/components/Onboarding/core/StepsController/index.d.ts

@@ -0,0 +1 @@
+export * from './StepsController';

package/node/components/Onboarding/core/StepsController/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./StepsController"), exports);

package/node/components/Onboarding/faker.d.ts

@@ -0,0 +1,27 @@
+import { type ActiveStepState, type ResolvedStep, type SaveStrategy, type Step, type TourProgress } from './types';
+/**
+ * Фабрика шага со значениями по умолчанию standalone-типа.
+ */
+export declare const makeStep: (data?: Partial<Step>) => Step;
+/**
+ * Фабрика шага с уже применёнными значениями по умолчанию.
+ */
+export declare const makeResolvedStep: (data?: Partial<ResolvedStep>) => ResolvedStep;
+/**
+ * Фабрика состояния активного шага, которое тур публикует в store.
+ */
+export declare const makeActiveStepState: (data?: Partial<ActiveStepState>) => ActiveStepState;
+/**
+ * Список standalone-шагов по именам — частый кейс, когда важны только имена и
+ * порядок. `data` применяется к каждому шагу.
+ */
+export declare const makeSteps: (names: string[], data?: Partial<Step>) => Step[];
+/**
+ * Фабрика прогресса тура со значениями по умолчанию «в процессе».
+ */
+export declare const makeTourProgress: (data?: Partial<TourProgress>) => TourProgress;
+/**
+ * Стратегия хранения в памяти со шпионами: `save` пишет в замыкание, `load`
+ * читает оттуда же. Заменяет реальный localStorage/бэкенд в тестах.
+ */
+export declare const createMemoryStrategy: (initial?: TourProgress | null) => SaveStrategy;

package/node/components/Onboarding/faker.js

@@ -0,0 +1,88 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createMemoryStrategy = exports.makeTourProgress = exports.makeSteps = exports.makeActiveStepState = exports.makeResolvedStep = exports.makeStep = void 0;
+const vitest_1 = require("vitest");
+/**
+ * Фабрика шага со значениями по умолчанию standalone-типа.
+ */
+const makeStep = (data = {}) => ({
+    name: 'step',
+    type: 'standalone',
+    ...data,
+});
+exports.makeStep = makeStep;
+/**
+ * Фабрика шага с уже применёнными значениями по умолчанию.
+ */
+const makeResolvedStep = (data = {}) => ({
+    name: 'step',
+    type: 'standalone',
+    position: 'bottom',
+    dialogSize: 'xs',
+    isNextButtonVisible: true,
+    isPrevButtonVisible: true,
+    waitForTimeout: 0,
+    ...data,
+});
+exports.makeResolvedStep = makeResolvedStep;
+/**
+ * Фабрика состояния активного шага, которое тур публикует в store.
+ */
+const makeActiveStepState = (data = {}) => ({
+    tourName: 'tour',
+    step: (0, exports.makeResolvedStep)(),
+    position: 0,
+    total: 1,
+    hasNext: false,
+    hasPrev: false,
+    isInteractive: false,
+    isConfirming: false,
+    isDotsVisible: true,
+    isCounterVisible: true,
+    confirmExit: {},
+    buttons: {
+        prevLabel: 'Назад',
+        nextLabel: 'Далее',
+        finishLabel: 'Закрыть',
+        finishVariant: 'contained',
+    },
+    onNext: vitest_1.vi.fn(),
+    onPrev: vitest_1.vi.fn(),
+    onSelectStep: vitest_1.vi.fn(),
+    requestClose: vitest_1.vi.fn(),
+    onConfirmExit: vitest_1.vi.fn(),
+    onCancelExit: vitest_1.vi.fn(),
+    onError: vitest_1.vi.fn(),
+    ...data,
+});
+exports.makeActiveStepState = makeActiveStepState;
+/**
+ * Список standalone-шагов по именам — частый кейс, когда важны только имена и
+ * порядок. `data` применяется к каждому шагу.
+ */
+const makeSteps = (names, data = {}) => names.map((name) => (0, exports.makeStep)({ name, ...data }));
+exports.makeSteps = makeSteps;
+/**
+ * Фабрика прогресса тура со значениями по умолчанию «в процессе».
+ */
+const makeTourProgress = (data = {}) => ({
+    lastStepName: 'step',
+    isCompleted: false,
+    isDismissed: false,
+    ...data,
+});
+exports.makeTourProgress = makeTourProgress;
+/**
+ * Стратегия хранения в памяти со шпионами: `save` пишет в замыкание, `load`
+ * читает оттуда же. Заменяет реальный localStorage/бэкенд в тестах.
+ */
+const createMemoryStrategy = (initial = null) => {
+    let saved = initial;
+    return {
+        save: vitest_1.vi.fn((data) => {
+            saved = data;
+        }),
+        load: vitest_1.vi.fn(() => saved),
+    };
+};
+exports.createMemoryStrategy = createMemoryStrategy;

package/node/components/Onboarding/index.d.ts

@@ -0,0 +1,5 @@
+export { createOnboarding, type Onboarding } from './Onboarding';
+export { OnboardingContainer, type OnboardingContainerProps, } from './ui/OnboardingContainer';
+export { LocalStorageSaveStrategy } from './services/LocalStorageSaveStrategy';
+export type { OnboardingTour } from './core/OnboardingTour';
+export type { OnboardingConfig, OnboardingTourConfig, SaveStrategy as OnboardingSaveStrategy, TourProgress as OnboardingTourProgress, } from './types';

package/node/components/Onboarding/index.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LocalStorageSaveStrategy = exports.OnboardingContainer = exports.createOnboarding = void 0;
+var Onboarding_1 = require("./Onboarding");
+Object.defineProperty(exports, "createOnboarding", { enumerable: true, get: function () { return Onboarding_1.createOnboarding; } });
+var OnboardingContainer_1 = require("./ui/OnboardingContainer");
+Object.defineProperty(exports, "OnboardingContainer", { enumerable: true, get: function () { return OnboardingContainer_1.OnboardingContainer; } });
+var LocalStorageSaveStrategy_1 = require("./services/LocalStorageSaveStrategy");
+Object.defineProperty(exports, "LocalStorageSaveStrategy", { enumerable: true, get: function () { return LocalStorageSaveStrategy_1.LocalStorageSaveStrategy; } });

package/node/components/Onboarding/public.d.ts

@@ -0,0 +1,5 @@
+export type { OnboardingTour } from './core/OnboardingTour';
+export { createOnboarding, type Onboarding } from './Onboarding';
+export { LocalStorageSaveStrategy } from './services/LocalStorageSaveStrategy';
+export type { OnboardingConfig, OnboardingTourConfig, SaveStrategy as OnboardingSaveStrategy, TourProgress as OnboardingTourProgress, } from './types';
+export { OnboardingContainer, type OnboardingContainerProps, } from './ui/OnboardingContainer';

package/node/components/Onboarding/public.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OnboardingContainer = exports.LocalStorageSaveStrategy = exports.createOnboarding = void 0;
+var Onboarding_1 = require("./Onboarding");
+Object.defineProperty(exports, "createOnboarding", { enumerable: true, get: function () { return Onboarding_1.createOnboarding; } });
+var LocalStorageSaveStrategy_1 = require("./services/LocalStorageSaveStrategy");
+Object.defineProperty(exports, "LocalStorageSaveStrategy", { enumerable: true, get: function () { return LocalStorageSaveStrategy_1.LocalStorageSaveStrategy; } });
+var OnboardingContainer_1 = require("./ui/OnboardingContainer");
+Object.defineProperty(exports, "OnboardingContainer", { enumerable: true, get: function () { return OnboardingContainer_1.OnboardingContainer; } });

package/node/components/Onboarding/services/LocalStorageSaveStrategy/LocalStorageSaveStrategy.d.ts

@@ -0,0 +1,20 @@
+import { type SaveStrategy, type SaveStrategyFactory, type TourProgress } from '../../types';
+/**
+ * Префикс ключа `localStorage` для стратегии хранения прогресса по умолчанию.
+ * К нему добавляется имя тура.
+ */
+export declare const LOCAL_STORAGE_KEY_PREFIX = "astral-ui-onboarding:";
+/**
+ * Реализация по умолчанию SaveStrategy: хранит прогресс тура в `localStorage`
+ */
+export declare class LocalStorageSaveStrategy implements SaveStrategy {
+    /**
+     * Ключ уникален на тур (префикс + имя), чтобы туры не перетирали друг друга.
+     */
+    private readonly key;
+    constructor(tourName: string);
+    save: (data: TourProgress) => void;
+    load: () => TourProgress | null;
+    remove: () => void;
+}
+export declare const createLocalStorageSaveStrategy: SaveStrategyFactory;

package/node/components/Onboarding/services/LocalStorageSaveStrategy/LocalStorageSaveStrategy.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createLocalStorageSaveStrategy = exports.LocalStorageSaveStrategy = exports.LOCAL_STORAGE_KEY_PREFIX = void 0;
+/**
+ * Префикс ключа `localStorage` для стратегии хранения прогресса по умолчанию.
+ * К нему добавляется имя тура.
+ */
+exports.LOCAL_STORAGE_KEY_PREFIX = 'astral-ui-onboarding:';
+/**
+ * Реализация по умолчанию SaveStrategy: хранит прогресс тура в `localStorage`
+ */
+class LocalStorageSaveStrategy {
+    constructor(tourName) {
+        this.save = (data) => {
+            localStorage.setItem(this.key, JSON.stringify(data));
+        };
+        this.load = () => {
+            const raw = localStorage.getItem(this.key);
+            return raw ? JSON.parse(raw) : null;
+        };
+        this.remove = () => {
+            localStorage.removeItem(this.key);
+        };
+        this.key = `${exports.LOCAL_STORAGE_KEY_PREFIX}${tourName}`;
+    }
+}
+exports.LocalStorageSaveStrategy = LocalStorageSaveStrategy;
+const createLocalStorageSaveStrategy = (tourName) => new LocalStorageSaveStrategy(tourName);
+exports.createLocalStorageSaveStrategy = createLocalStorageSaveStrategy;

package/node/components/Onboarding/services/LocalStorageSaveStrategy/index.d.ts

@@ -0,0 +1 @@
+export * from './LocalStorageSaveStrategy';

package/node/components/Onboarding/services/LocalStorageSaveStrategy/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./LocalStorageSaveStrategy"), exports);