feat: add useOnboardingPreset, add presetsNames to export

src/controller.test.ts

@@ -10,7 +10,6 @@ const getOptions = (
             presets: {
                 createProject: {
                     name: 'Creating project',
-                    description: '',
                     steps: [
                         {
                             slug: 'openBoard',
@@ -31,7 +30,6 @@ const getOptions = (
                 },
                 createQueue: {
                     name: 'Creating queue',
-                    description: '',
                     steps: [],
                 },
             },

src/hooks.tsx

@@ -39,9 +39,14 @@ export function getHooks<HintParams, Presets extends string, Steps extends strin
             await controller.finishPreset(preset);
         };
 
+        const resetPresetProgress = async () => {
+            await controller.resetPresetProgress([preset]);
+        };
+
         return {
             addPreset,
             finishPreset,
+            resetPresetProgress,
         };
     };
 

src/index.ts

@@ -37,7 +37,7 @@
     return preset as unknown as Preset<InferHintParamsFromPreset<T>, InferStepsFromPreset<T>>;
 }
 
 export function createOnboarding<T extends InitOptions<any, any, any>>(options: T) {
     const controller = new Controller<
         InferHintParamsFromOptions<T>,
         InferPresetsFromOptions<T>,
@@ -51,11 +51,16 @@
     const {useOnboarding, useOnboardingPreset, useOnboardingStep, useOnboardingHint} =
         getHooks(controller);
 
+    const presetsNames = Object.keys(
+        controller.options.config.presets,
+    ) as unknown as keyof typeof controller.options.config.presets;
+
     return {
         useOnboardingStep,
         useOnboardingPreset,
         useOnboardingHint,
         useOnboarding,
         controller,
+        presetsNames,
     };
 }

src/types.ts

@@ -1,3 +1,4 @@
+import type {ReactNode} from 'react';
 import type {LoggerOptions} from './logger';
 
 type HintPlacement =
@@ -30,7 +31,7 @@
 
 export type Preset<HintParams, Steps extends string> = {
     name: string;
-    description: string;
+    description?: ReactNode[];
     type?: 'default' | 'hidden';
     steps: PresetStep<Steps, HintParams | undefined>[];
     hidden?: boolean;
@@ -72,8 +73,8 @@
     baseState: Partial<BaseState> | undefined;
     getProgressState: () => Promise<Partial<ProgressState>>;
     onSave: {
         state: (state: BaseState) => Promise<any>;
         progress: (progress: ProgressState) => Promise<any>;
     };
     showHint?: (params: ShowHintParams<HintParams, Presets, Steps>) => void;
     logger?: LoggerOptions;
@@ -88,10 +89,10 @@
 
 // type inference utils
 type CommonKeys<T extends object> = keyof T;
 type AllKeys<T> = T extends any ? keyof T : never;
 type Subtract<A, C> = A extends C ? never : A;
 type NonCommonKeys<T extends object> = Subtract<AllKeys<T>, CommonKeys<T>>;
 type PickType<T, K extends AllKeys<T>> = T extends {[k in K]?: any} ? T[K] : undefined;
 
 export type Merge<T extends object> = {
     [k in keyof T]: PickTypeOf<T, k>;
@@ -104,18 +105,18 @@
     : never;
 
 export type InferStepsFromPreset<T> = T extends {steps: Array<infer U>}
     ? U extends PresetStep<infer Steps, any>
         ? Steps
         : never
     : never;
 
 export type InferHintParamsFromPreset<T> = T extends {steps: Array<infer U>}
     ? U extends PresetStep<any, infer HintParams>
         ? HintParams
         : never
     : never;
 
 export type InferStepsFromOptions<T extends InitOptions<any, any, any>> =
     T['config']['presets'] extends Record<any, infer U>
         ? U extends Preset<any, infer Steps>
             ? Steps