feat: add step pass hook

gravity-ui · Aug 3, 2023 · beae3e0 · beae3e0
1 parent 0233ff3
commit beae3e0
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 0 deletions.
diff --git a/src/controller.test.ts b/src/controller.test.ts
@@ -327,6 +327,20 @@ describe('pass step', function () {
         expect(newProgressState.finishedPresets).toEqual(['createProject']);
         expect(options.onSave.progress).toHaveBeenCalledTimes(1);
     });
+
+    describe('step hooks', function () {
+        it('pass step -> call onPass hook', async function () {
+            const options = getOptions();
+            const mock = jest.fn();
+
+            options.config.presets.createProject.steps[1].hooks = {onStepPass: mock};
+
+            const controller = new Controller(options);
+            await controller.passStep('createSprint');
+
+            expect(mock).toHaveBeenCalled();
+        });
+    });
 });
 
 describe('hints', function () {

diff --git a/src/controller.ts b/src/controller.ts
@@ -115,6 +115,7 @@ export class Controller<HintParams, Presets extends string, Steps extends string
         }
 
         this.options.hooks?.onStepPass?.({preset, step: stepSlug});
+        step?.hooks?.onStepPass?.();
 
         await this.savePassedStepData(preset, stepSlug, () => {
             if (step?.passMode !== 'onShowHint') {

diff --git a/src/types.ts b/src/types.ts
@@ -27,6 +27,9 @@ export type PresetStep<Steps extends string, HintParams> = {
     hintParams?: HintParams;
     closeOnElementUnmount?: boolean;
     passRestriction?: 'afterPrevious';
+    hooks?: {
+        onStepPass?: () => void;
+    };
 };
 
 export type Preset<HintParams, Steps extends string> = {