feat(onboarding): add customDefaultState option

src/controller.ts

@@ -19,13 +19,14 @@ let instanceCounter = 0;
 const defaultLoggerOptions = {
     context: 'Onboarding',
 };
-const getDefaultBaseState = (): BaseState => ({
+const base = {
     availablePresets: [],
     activePresets: [],
     suggestedPresets: [],
     wizardState: 'hidden' as const,
     enabled: false,
-});
+};
+const getDefaultBaseState = (): BaseState => base;
 
 const getDefaultProgressState = () => ({
     presetPassedSteps: {},
@@ -88,6 +89,7 @@ export class Controller<HintParams, Presets extends string, Steps extends string
         this.state = {
             base: {
                 ...getDefaultBaseState(),
+                ...options.customDefaultState,
                 ...options.baseState,
             },
         };

src/tests/controller.test.ts

@@ -532,3 +532,43 @@ describe('goNextStep and goNextStep', function () {
         });
     });
 });
+
+describe('custom default state', () => {
+    it('can use empty custom state', () => {
+        const options = getOptions();
+        // @ts-ignore
+        options.baseState = {};
+        options.customDefaultState = {};
+
+        const controller = new Controller(options);
+        expect(controller.state.base).toEqual({
+            wizardState: 'hidden',
+            enabled: false,
+            activePresets: [],
+            availablePresets: [],
+            suggestedPresets: [],
+        });
+    });
+
+    it('can apply custom state', () => {
+        const options = getOptions();
+        options.customDefaultState = {
+            wizardState: 'visible',
+            enabled: true,
+        };
+
+        const controller = new Controller(options);
+        expect(controller.state.base.wizardState).toBe('visible');
+        expect(controller.state.base.enabled).toBe(true);
+    });
+
+    it('should applies before saved value', () => {
+        const options = getOptions({wizardState: 'collapsed'});
+        options.customDefaultState = {
+            wizardState: 'visible',
+        };
+
+        const controller = new Controller(options);
+        expect(controller.state.base.wizardState).toBe('collapsed');
+    });
+});

src/tests/utils.ts

@@ -1,4 +1,11 @@
-import {BaseState, CombinedPreset, OnboardingPlugin, PresetStep, ProgressState} from '../types';
+import {
+    BaseState,
+    CombinedPreset,
+    InitOptions,
+    OnboardingPlugin,
+    PresetStep,
+    ProgressState,
+} from '../types';
 import {PromoPresetsPlugin} from '../plugins/promo-presets';
 
 export const getOptions = (
@@ -65,7 +72,8 @@ export const getOptions = (
             },
         },
         plugins: [] as OnboardingPlugin[],
-    };
+        customDefaultState: {} as Partial<BaseState>,
+    } satisfies InitOptions<any, any, any>;
 };
 
 export const getOptionsWithCombined = (

src/types.ts

@@ -134,6 +134,7 @@ export type InitOptions<HintParams, Presets extends string, Steps extends string
     showHint?: (params: ShowHintParams<HintParams, Presets, Steps>) => void;
     logger?: LoggerOptions;
     debugMode?: boolean;
+    customDefaultState?: Partial<BaseState>;
     plugins?: OnboardingPlugin[];
     hooks?: {
         [K in keyof EventsMap<HintParams, Presets, Steps>]?: (