@peter.naydenov/cuts 1.6.0 → 2.0.1

package/types/src/main.d.ts

@@ -0,0 +1,31 @@
+export default main;
+declare function main(cfg?: {
+    logLevel: number;
+}): {
+    hide: (endSteps?: number | string) => Promise<any>;
+    listShortcuts: (sceneName: string) => (Array<string> | null);
+    setScenes: (list: import("./methods/setScenes.js").sceneDescription[]) => void;
+    show: ({ scene: requestedScene, options }: {
+        scene: string;
+        options?: {
+            ssr: boolean;
+        } | undefined;
+    }, ...args?: any[]) => Promise<any>;
+    jump: ({ scene }: {
+        scene: string;
+    }, ...args?: any[]) => Promise<any>;
+    jumpBack: ({ hops }?: {
+        hops?: number | undefined;
+    }, ...args?: any[]) => Promise<any> | undefined;
+    jumpsReset: () => void;
+    loadPlugins(plugins: Array<"Key" | "Click" | "Form" | "Hover" | "Scroll">): Promise<Function[]>;
+    setDependencies(deps: any): void;
+    getDependencies(): any;
+    setNote(note: string): void;
+    listScenes(): Array<string>;
+    enablePlugin(plugin: Function, options?: any): void;
+    disablePlugin(pluginName: string): void;
+    getState(): Object;
+    emit(event: string, ...args: any[]): void;
+};
+//# sourceMappingURL=main.d.ts.map

package/types/src/main.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../../src/main.js"],"names":[],"mappings":";AAsCA;;;;;;;;;;;;;;;;;;;yBA8CmB,KAAK,+CAAc,GACjB,OAAO,CAAE,UAAU,CAAC;0BAgBtB,GAAC;uBAQC,GAAC;kBAMH,MAAM;kBAQJ,KAAK,CAAE,MAAM,CAAC;6CAQhB,GAAC;8BAQD,MAAM;gBAQJ,MAAM;gBAeP,MAAM,WACH,GAAC,EAAA;EAKvB"}

package/types/src/methods/hide.d.ts

@@ -0,0 +1,3 @@
+export default hide;
+declare function hide(dependencies: any, state: any): (endSteps?: number | string) => Promise<any>;
+//# sourceMappingURL=hide.d.ts.map

package/types/src/methods/hide.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"hide.d.ts","sourceRoot":"","sources":["../../../src/methods/hide.js"],"names":[],"mappings":";AAIA,uDAOuB,WAHZ,MAAM,GAAC,MAGe,kBAmC/B"}

package/types/src/methods/jump.d.ts

@@ -0,0 +1,5 @@
+export default jump;
+declare function jump(state: any, show: any): ({ scene }: {
+    scene: string;
+}, ...args?: any[]) => Promise<any>;
+//# sourceMappingURL=jump.d.ts.map

package/types/src/methods/jump.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"jump.d.ts","sourceRoot":"","sources":["../../../src/methods/jump.js"],"names":[],"mappings":";AAAA,0DAKO;IAAwB,KAAK,EAArB,MAAM;CACd,mCAQN"}

package/types/src/methods/jumpBack.d.ts

@@ -0,0 +1,5 @@
+export default jumpBack;
+declare function jumpBack(state: any, show: any): ({ hops }?: {
+    hops?: number | undefined;
+}, ...args?: any[]) => Promise<any> | undefined;
+//# sourceMappingURL=jumpBack.d.ts.map

package/types/src/methods/jumpBack.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"jumpBack.d.ts","sourceRoot":"","sources":["../../../src/methods/jumpBack.js"],"names":[],"mappings":";AAAA,8DAKO;IAAyB,IAAI;CAC7B,sBACU,eAAQ,SAAS,CAWjC"}

package/types/src/methods/jumpsReset.d.ts

@@ -0,0 +1,3 @@
+export default jumpsReset;
+declare function jumpsReset(state: any): () => void;
+//# sourceMappingURL=jumpsReset.d.ts.map

package/types/src/methods/jumpsReset.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"jumpsReset.d.ts","sourceRoot":"","sources":["../../../src/methods/jumpsReset.js"],"names":[],"mappings":";AAAA,+CAIiB,IAAI,CAKpB"}

package/types/src/methods/listShortcuts.d.ts

@@ -0,0 +1,3 @@
+export default listShortcuts;
+declare function listShortcuts(dependencies: any, state: any): (sceneName: string) => (Array<string> | null);
+//# sourceMappingURL=listShortcuts.d.ts.map

package/types/src/methods/listShortcuts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"listShortcuts.d.ts","sourceRoot":"","sources":["../../../src/methods/listShortcuts.js"],"names":[],"mappings":";AAEA,gEAOgC,WAHrB,MAG8B,KAF5B,CAAC,KAAK,CAAE,MAAM,CAAC,GAAC,IAAI,CAAC,CAOhC"}

package/types/src/methods/setScenes.d.ts

@@ -0,0 +1,69 @@
+export default setScenes;
+export type AskObject = {
+    /**
+     * - Mark the task as done
+     */
+    done: Function;
+};
+export type SceneObject = {
+    /**
+     * - load interface and prerequisites for the scene;
+     */
+    show: (arg0: {
+        task: AskObject;
+        dependencies: any;
+    }) => void;
+    /**
+     * - run after scene is loaded. Optional. Returns true to continue loading, false to cancel;
+     */
+    afterShow?: (() => boolean) | undefined;
+    /**
+     * - Reverse the settings from 'show';
+     */
+    hide: (arg0: {
+        task: AskObject;
+        dependencies: any;
+    }) => void;
+    /**
+     * - Run before scene is hidden. Optional;
+     */
+    beforeHide?: (() => void) | undefined;
+    /**
+     * - list of parent scene names.
+     */
+    parents?: string[] | undefined;
+    /**
+     * - shortcut descriptions
+     */
+    "": any;
+};
+export type sceneDescription = {
+    /**
+     * - name of the scene
+     */
+    name: string;
+    /**
+     * - object should contain 'show' and 'hide' + shortcuts and action functions
+     */
+    scene: SceneObject;
+};
+/**
+ * @typedef {Object} AskObject
+ * @property {function} done - Mark the task as done
+ */
+/**
+ * @typedef {Object} SceneObject
+ * @property {function({task: AskObject, dependencies: *}): void} show - load interface and prerequisites for the scene;
+ * @property {function():boolean} [afterShow] - run after scene is loaded. Optional. Returns true to continue loading, false to cancel;
+ * @property {function({task: AskObject, dependencies: *}): void} hide - Reverse the settings from 'show';
+ * @property {function():void} [beforeHide] - Run before scene is hidden. Optional;
+ * @property {Array.<string>} [parents] - list of parent scene names.
+ * @property {*} ... - shortcut descriptions
+ */
+/**
+ * @typedef {Object} sceneDescription
+ * @property {string} name - name of the scene
+ * @property {SceneObject} scene - object should contain 'show' and 'hide' + shortcuts and action functions
+ */
+declare function setScenes(dependencies: any, state: any): (list: sceneDescription[]) => void;
+//# sourceMappingURL=setScenes.d.ts.map

package/types/src/methods/setScenes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"setScenes.d.ts","sourceRoot":"","sources":["../../../src/methods/setScenes.js"],"names":[],"mappings":";;;;;;;;;;;UASc,CAAS,IAAkC,EAAlC;QAAC,IAAI,EAAE,SAAS,CAAC;QAAC,YAAY,EAAE,GAAC,CAAA;KAAC,KAAG,IAAI;;;;uBACvC,OAAO;;;;UAClB,CAAS,IAAkC,EAAlC;QAAC,IAAI,EAAE,SAAS,CAAC;QAAC,YAAY,EAAE,GAAC,CAAA;KAAC,KAAG,IAAI;;;;wBACvC,IAAI;;;;;;;;QAEf,GAAC;;;;;;UAOD,MAAM;;;;WACN,WAAW;;AAnBzB;;;GAGG;AACH;;;;;;;;GAQG;AAIH;;;;GAIG;AAKH,4DAOgC,MAJhB,gBAAgB,EAII,UAkClC"}

package/types/src/methods/show.d.ts

@@ -0,0 +1,8 @@
+export default show;
+declare function show(dependencies: any, state: any): ({ scene: requestedScene, options }: {
+    scene: string;
+    options?: {
+        ssr: boolean;
+    } | undefined;
+}, ...args?: any[]) => Promise<any>;
+//# sourceMappingURL=show.d.ts.map

package/types/src/methods/show.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"show.d.ts","sourceRoot":"","sources":["../../../src/methods/show.js"],"names":[],"mappings":";AAIA,2FAKG;IAAwB,KAAK,EAArB,MAAM;IACW,OAAO;aACxB,OAAO;;CACf,mCA4GF"}

package/types/src/setInstruction.d.ts

@@ -0,0 +1,3 @@
+export default setInstruction;
+declare function setInstruction(dependencies: any): (fn: Function, ...args: any[]) => Function;
+//# sourceMappingURL=setInstruction.d.ts.map

package/types/src/setInstruction.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"setInstruction.d.ts","sourceRoot":"","sources":["../../src/setInstruction.js"],"names":[],"mappings":";AAEA,qDAQiC,YAAE,EAAE,GAAG,MAHtB,GAAC,EAGyB,cAO1C"}

package/test-vitest/01-findPosition.test.js

@@ -1,119 +0,0 @@
-import { describe, it, expect } from 'vitest'
-import findInstructions from "../src/findInstructions.js"
-
-
-
-describe ( 'Find a Position', () => {
-
-
-
-   it ( 'Switch top level scenes', () => {
-                    let result = []
-                    let g = findInstructions ( 'old', [], 'new', [] )
-
-                    for (const n of g) { result.push(n) }
-
-                    expect(result.length).toBe ( 2 )
-                    expect(result[0][0]).toBe ( 'old' )
-                    expect(result[0][1]).toBe ( 'hide' )
-
-                    expect(result[1][0]).toBe ( 'new' )
-                    expect(result[1][1]).toBe ( 'show' )
-      }) // it switch top level scenes
-
-
-
-   it ( 'Switch from child scene to top level scene', () => {
-              let result = []
-              let g = findInstructions ( 'old', ['one', 'two'], 'new', [] )
-
-              for (const n of g) { result.push(n) }
-
-              expect(result[0]).toEqual(['old', 'hide'])
-              expect(result[1]).toEqual(['two', 'hide'])
-              expect(result[2]).toEqual(['one', 'hide'])
-              expect(result[3]).toEqual(['new', 'show'])
-      }) // it switch from child scene to top level scene
-
-
-
-   it ( 'Switch to child scene', () => {
-            let result = []
-            let g = findInstructions ( 'old', ['bla'], 'new', ['old', 'two', 'three'])
-            for (const n of g) { result.push(n) }
-
-            expect(result).toHaveLength(3)
-            expect(result[0]).toEqual(['two', 'show'])
-            expect(result[1]).toEqual(['three', 'show'])
-            expect(result[2]).toEqual(['new', 'show'])
-      }) // it switch to child scene
-
-
-
-   it ( 'From child scene to other siblings scene', () => {
-            let result = []
-            let g = findInstructions('old', ['two', 'three'], 'new', ['two', 'three'])
-            for (const n of g) { result.push(n) }
-
-            expect(result).toHaveLength ( 2 )
-            expect(result[0]).toEqual(['old', 'hide'])
-             expect(result[1]).toEqual(['new', 'show'])
-      }) // it from top level scene to not own child scene
-
-
-
-   it ( 'From top level scene to not own child scene', () => {
-            let result = []
-            let g = findInstructions('old', undefined, 'new', ['two', 'three'])
-            for (const n of g) { result.push(n) }
-
-            expect(result).toHaveLength(3)
-            expect(result[0]).toEqual(['old', 'hide'])
-            expect(result[1]).toEqual(['two', 'show'])
-             expect(result[2]).toEqual(['three', 'show'])
-      }) // it from top level scene to not own child scene
-
-
-
-  it ( 'Long chain of parents', () => {
-            let result = []
-            let g = findInstructions('old', ['one', 'branch'], 'new', ['one', 'two', 'three'])
-            for (const n of g) { result.push(n) }
-
-            expect(result).toHaveLength(5)
-            expect(result[0]).toEqual(['old', 'hide'])
-            expect(result[1]).toEqual(['branch', 'hide'])
-            expect(result[2]).toEqual(['two', 'show'])
-            expect(result[3]).toEqual(['three', 'show'])
-            expect(result[4]).toEqual(['new', 'show'])
-      }) // it long chain of parents
-
-
-
-  it ( 'Different branches', () => {
-            let result = []
-            let g = findInstructions('old', ['something', 'branch'], 'new', ['one', 'two', 'three'])
-            for (const n of g) { result.push(n) }
-
-            expect(result).toHaveLength(7)
-            expect(result[0]).toEqual(['old', 'hide'])
-            expect(result[1]).toEqual(['branch', 'hide'])
-            expect(result[2]).toEqual(['something', 'hide'])
-            expect(result[3]).toEqual(['one', 'show'])
-            expect(result[4]).toEqual(['two', 'show'])
-            expect(result[5]).toEqual(['three', 'show'])
-            expect(result[6]).toEqual(['new', 'show'])
-      }) // it long chain of parents
-
-
-      
-   it ( 'Target scene is in the list of parents of the current scene', () => {
-            let result = []
-            let g = findInstructions ( 'token-get-role', ['tokens', 'token-pop'], 'tokens', [] )
-            for (const n of g) { result.push(n) }
-            expect ( result ).toHaveLength ( 2 )
-            expect ( result[0] ).toEqual ( [ 'token-get-role', 'hide' ])
-            expect ( result[1] ).toEqual ( [ 'token-pop', 'hide' ])
-       }) // it Target scene is in the list of parents of the current scene
-
-}) // describe