ahdjs 0.0.6

package/build/types/GuideChimp.d.ts

@@ -0,0 +1,279 @@
+export default class GuideChimp {
+    /**
+     * Default options
+     * @return {Object}
+     */
+    static getDefaultOptions(): Object;
+    static getDefaultKeyboardCodes(): {
+        previous: number[];
+        next: number[];
+        stop: number[];
+    };
+    static getEventListenersPriorities(): string[];
+    static getBodyClass(): string;
+    static getLoadingClass(): string;
+    static getHighlightClass(): string;
+    static getFixedClass(): string;
+    static getRelativePositionClass(): string;
+    /**
+     * Get element offset
+     * @param el
+     * @return {{top: number, left: number, width: number, height: number}}
+     */
+    static getOffset(el: any): {
+        top: number;
+        left: number;
+        width: number;
+        height: number;
+    };
+    /**
+     * Check if el or his parent has fixed position
+     * @param el
+     * @return {boolean}
+     */
+    static isFixed(el: any): boolean;
+    /**
+     * GuideChimp constructor
+     * @param tour
+     * @param options
+     */
+    constructor(tour: any, options?: {});
+    cache: Map<any, any>;
+    listeners: {};
+    observers: {};
+    options: {};
+    tour: any;
+    notifications: any[];
+    elements: Map<any, any>;
+    /**
+     * Called after construction, this hook allows you to add some extra setup
+     * logic without having to override the constructor.
+     */
+    init(): void;
+    setDefaults(): GuideChimp;
+    previousStep: any;
+    currentStep: any;
+    nextStep: any;
+    fromStep: any;
+    toStep: any;
+    previousStepIndex: number;
+    currentStepIndex: number;
+    nextStepIndex: number;
+    fromStepIndex: number;
+    toStepIndex: number;
+    steps: any[];
+    isDisplayed: boolean;
+    /**
+     * Set tour name or steps
+     * @param tour
+     * @return {this}
+     */
+    setTour(tour: any): this;
+    /**
+     * Get tour name or steps
+     */
+    getTour(): any;
+    /**
+     * Set tour options
+     * @param options
+     * @return {this}
+     */
+    setOptions(options: any): this;
+    /**
+     * Get tour options
+     */
+    getOptions(): {};
+    /**
+     * Start tour
+     * @param number step number or it index
+     * @param useIndex whether to use step number or index
+     * @return {Promise<boolean>}
+     */
+    start(number?: number, useIndex?: boolean, ...args: any[]): Promise<boolean>;
+    /**
+     * Go to step
+     * @param number step number or it index
+     * @param useIndex whether to use step number or index
+     * @param args
+     * @return {Promise<boolean>}
+     */
+    go(number: any, useIndex?: boolean, ...args: any[]): Promise<boolean>;
+    previous(...args: any[]): Promise<boolean>;
+    next(...args: any[]): Promise<boolean>;
+    stop(...args: any[]): Promise<GuideChimp>;
+    getSteps(tour: any): any;
+    getDataSteps(tour: any): {
+        element: Element;
+        step: number;
+        title: string;
+        description: string;
+        position: any;
+        interaction: any;
+    }[];
+    getJsSteps(tour: any): any;
+    sortSteps(steps: any): any[];
+    getStepEl(step: any): any;
+    scrollParentsToStepEl(): GuideChimp;
+    getScrollableParentsEls(el: any): any[];
+    getScrollableParentEl(el: any): any;
+    scrollParentsToEl(el: any, scrollPadding?: number): GuideChimp;
+    scrollTo(el: any, behavior?: string, scrollPadding?: number): GuideChimp;
+    highlightStepEl(animation?: boolean): GuideChimp;
+    resetHighlightStepEl(): GuideChimp;
+    setInteractionPosition(interactionEl: any): GuideChimp;
+    setControlPosition(controlEl: any): GuideChimp;
+    setTooltipPosition(tooltipEl: any, options?: {}): GuideChimp;
+    startPreloader(): GuideChimp;
+    stopPreloader(): GuideChimp;
+    getDefaultTmplData(): {
+        previousStep: any;
+        currentStep: any;
+        nextStep: any;
+        fromStep: any;
+        toStep: any;
+        previousStepIndex: number;
+        currentStepIndex: number;
+        nextStepIndex: number;
+        fromStepIndex: number;
+        toStepIndex: number;
+        steps: any[];
+        go: (...args: any[]) => Promise<boolean>;
+        previous: (...args: any[]) => Promise<boolean>;
+        next: (...args: any[]) => Promise<boolean>;
+        stop: (...args: any[]) => Promise<GuideChimp>;
+    };
+    mountStep(): GuideChimp;
+    unmountStep(): GuideChimp;
+    createEl(name: any, tmpl: any, data?: {}): Element;
+    getEl(key: any, def?: any): any;
+    mountEl(el: any, parent: any): any;
+    removeEl(key: any): GuideChimp;
+    isEl(el: any, key: any): boolean;
+    getFakeStepTmpl(): any;
+    createFakeStepEl(data?: {}): Element;
+    mountFakeStepEl(data?: {}): any;
+    removeFakeStepEl(): GuideChimp;
+    getPreloaderTmpl(): any;
+    createPreloaderEl(data?: {}): Element;
+    mountPreloaderEl(data?: {}): any;
+    removePreloaderEl(): GuideChimp;
+    getOverlayDocumentPath(): string;
+    getOverlayStepPath(step: any): string;
+    getOverlayElPath(el: any): string;
+    getOverlayTmpl(): any;
+    createOverlayEl(data?: {}): Element;
+    mountOverlayEl(data?: {}): any;
+    removeOverlayEl(): GuideChimp;
+    getInteractionTmpl(): any;
+    createInteractionEl(data?: {}): Element;
+    mountInteractionEl(data?: {}): any;
+    removeInteractionEl(): GuideChimp;
+    getControlTmpl(): any;
+    createControlEl(data?: {}): Element;
+    mountControlEl(data?: {}): any;
+    removeControlEl(): GuideChimp;
+    getTooltipTmpl(): any;
+    createTooltipEl(data?: {}): Element;
+    getCloseTmpl(): any;
+    createCloseEl(data?: {}): Element;
+    getProgressbarTmpl(): any;
+    createProgressbarEl(data?: {}): Element;
+    getTitleTmpl(): any;
+    createTitleEl(data?: {}): Element;
+    getDescriptionTmpl(): any;
+    createDescriptionEl(data?: {}): Element;
+    getCustomButtonsTmpl(): any;
+    createCustomButtonsEl(data?: {}): Element;
+    getPaginationTmpl(): any;
+    createPaginationEl(data?: {}): Element;
+    getPreviousTmpl(): any;
+    createPreviousEl(data?: {}): Element;
+    getNextTmpl(): any;
+    createNextEl(data?: {}): Element;
+    getCopyrightTmpl(): any;
+    createCopyrightEl(data?: {}): Element;
+    getNotificationTmpl(): any;
+    createNotificationEl(data?: {}): Element;
+    notify(message: any): GuideChimp;
+    /**
+     * Register an event listener for a tour event.
+     *
+     * Event names can be comma-separated to register multiple events.
+     *
+     * @param {string} event The name of the event to listen for.
+     * @param {function} listener The event listener, accepts context.
+     * @param {object} options Listener options
+     * @return {this}
+     */
+    on(event: string, listener: Function, options?: object): this;
+    /**
+     * Emits an event by name to all registered listeners on that event.
+     * Listeners will be called in the order that they were added. If a listener
+     * returns `false`, no other listeners will be called.
+     *
+     * @param {string} event    The name of the event to emit.
+     * @param args  The context args of the event, passed to listeners.
+     * @returns {Promise}
+     */
+    emit(event: string, ...args: any[]): Promise<any>;
+    /**
+     * Add keydown event listener
+     * @return {this}
+     */
+    addOnKeydownListener(): this;
+    /**
+     * Return on key down event listener function
+     * @returns {function}
+     */
+    getOnKeydownListener(): Function;
+    /**
+     * Remove keydown event listener
+     * @return {this}
+     */
+    removeOnKeydownListener(): this;
+    /**
+     * Add window resize event listener
+     * @return {this}
+     */
+    addOnWindowResizeListener(): this;
+    /**
+     * Return on window resize event listener function
+     * @returns {function}
+     */
+    getOnWindowResizeListener(): Function;
+    /**
+     * Remove window resize event listener
+     * @return {this}
+     */
+    removeOnWindowResizeListener(): this;
+    /**
+     * Add window scroll event listener
+     * @returns {GuideChimp}
+     */
+    addOnWindowScrollListener(): GuideChimp;
+    /**
+     * Return on window scroll event listener function
+     * @returns {function}
+     */
+    getOnWindowScrollListener(): Function;
+    /**
+     * Remove window resize event listener
+     * @return {this}
+     */
+    removeOnWindowScrollListener(): this;
+    removeListeners(): void;
+    observeStep(): void;
+    observeResizing(options?: {
+        box: string;
+    }): boolean;
+    unobserveResizing(): boolean;
+    observeMutation(): boolean;
+    unobserveMutation(): boolean;
+    unobserveStep(): void;
+    beforeChangeStep(): void;
+    /**
+     * Refresh layers position
+     * @returns {this}
+     */
+    refresh(): this;
+}

package/build/types/index.d.ts

@@ -0,0 +1,9 @@
+import "./index.scss";
+declare class ahdjs {
+    private guideChimp;
+    constructor(...args: any);
+    beacons: (...args: any) => void;
+    start: (...args: any) => void;
+    showInformation: (...args: any) => void;
+}
+export default ahdjs;

package/build/types/plugins/_boilerplate/index.d.ts

@@ -0,0 +1,2 @@
+declare function _exports(cls: Class, factory: Object, ...args: any[]): void;
+export = _exports;

package/build/types/plugins/beacons/Beacons.d.ts

@@ -0,0 +1,84 @@
+export default class Beacons {
+    /**
+     * Default options
+     * @return {Object}
+     */
+    static getDefaultOptions(): Object;
+    static getFixedClass(): string;
+    static getBeaconDataPrefix(): string;
+    /**
+     * Check if el or his parent has fixed position
+     * @param el
+     * @return {boolean}
+     */
+    static isFixed(el: any): boolean;
+    constructor(beacons: any, options?: {});
+    beacons: any[];
+    options: {};
+    observers: {};
+    cache: Map<any, any>;
+    elements: Map<any, any>;
+    /**
+     * Called after construction, this hook allows you to add some extra setup
+     * logic without having to override the constructor.
+     */
+    init(): void;
+    /**
+     * Set beacons options
+     * @param options
+     * @return {this}
+     */
+    setOptions(options: any): this;
+    setBeacons(beacons: any): Beacons;
+    getBeacons(): any[];
+    getBeacon(id: any, def: any): any;
+    getDataBeacons(ids: any): any[];
+    getJsBeacons(beacons: any): any[];
+    getBeaconTpl(): any;
+    createBeaconEl(beacon: any): Element;
+    getEl(selector: any): any;
+    setBeaconPosition(el: any, beaconEl: any, options?: {}): Beacons;
+    isCanShowBeacon({ canShow }: {
+        canShow: any;
+    }): boolean;
+    showAll(force?: boolean): Beacons;
+    show(id: any, force?: boolean): Beacons;
+    hideAll(): Beacons;
+    hide(id: any): Beacons;
+    removeAll(): Beacons;
+    remove(id: any): Beacons;
+    refresh(): Beacons;
+    /**
+     * Add window resize event listener
+     * @return {this}
+     */
+    addOnWindowResizeListener(): this;
+    /**
+     * Return on window resize event listener function
+     * @returns {function}
+     */
+    getOnWindowResizeListener(): Function;
+    /**
+     * Remove window resize event listener
+     * @return {this}
+     */
+    removeOnWindowResizeListener(): this;
+    /**
+     * Observe resize step element
+     * @return {this}
+     */
+    observeResizing(el: any, options?: {
+        box: string;
+    }): this;
+    /**
+     * Unobserve resize step element
+     * @param el
+     * @return {this}
+     */
+    unobserveResizing(el: any): this;
+    /**
+     * Unobserve all resize steps elements
+     * @return {this}
+     */
+    unobserveResizeAllElements(): this;
+}

package/build/types/plugins/beacons/index.d.ts

@@ -0,0 +1,2 @@
+declare function _default(Class: any, factory: any): void;
+export default _default;

package/build/types/plugins/blurredOverlay/index.d.ts

@@ -0,0 +1 @@
+export {};

package/build/types/plugins/information/Information.d.ts

@@ -0,0 +1,84 @@
+export default class Information {
+    /**
+     * Default options
+     * @return {Object}
+     */
+    static getDefaultOptions(): Object;
+    static getFixedClass(): string;
+    static getInformationDataPrefix(): string;
+    /**
+     * Check if el or his parent has fixed position
+     * @param el
+     * @return {boolean}
+     */
+    static isFixed(el: any): boolean;
+    constructor(informations: any, options?: {});
+    informations: any[];
+    options: {};
+    observers: {};
+    cache: Map<any, any>;
+    elements: Map<any, any>;
+    /**
+     * Called after construction, this hook allows you to add some extra setup
+     * logic without having to override the constructor.
+     */
+    init(): void;
+    /**
+     * Set informations options
+     * @param options
+     * @return {this}
+     */
+    setOptions(options: any): this;
+    setInformations(informations: any): Information;
+    getInformations(): any[];
+    getInformation(id: any, def: any): any;
+    getDataInformations(ids: any): any[];
+    getJsInformations(informations: any): any[];
+    getInformationTpl(): any;
+    createInformationEl(information: any): Element;
+    getEl(selector: any): any;
+    setInformationPosition(el: any, informationEl: any, options?: {}): Information;
+    isCanShowInformation({ canShow }: {
+        canShow: any;
+    }): boolean;
+    showAll(force?: boolean): Information;
+    show(id: any, force?: boolean): Information;
+    hideAll(): Information;
+    hide(id: any): Information;
+    removeAll(): Information;
+    remove(id: any): Information;
+    refresh(): Information;
+    /**
+     * Add window resize event listener
+     * @return {this}
+     */
+    addOnWindowResizeListener(): this;
+    /**
+     * Return on window resize event listener function
+     * @returns {function}
+     */
+    getOnWindowResizeListener(): Function;
+    /**
+     * Remove window resize event listener
+     * @return {this}
+     */
+    removeOnWindowResizeListener(): this;
+    /**
+     * Observe resize step element
+     * @return {this}
+     */
+    observeResizing(el: any, options?: {
+        box: string;
+    }): this;
+    /**
+     * Unobserve resize step element
+     * @param el
+     * @return {this}
+     */
+    unobserveResizing(el: any): this;
+    /**
+     * Unobserve all resize steps elements
+     * @return {this}
+     */
+    unobserveResizeAllElements(): this;
+}

package/build/types/plugins/information/index.d.ts

@@ -0,0 +1,2 @@
+declare function _default(Class: any, factory: any): void;
+export default _default;

package/build/types/plugins/lazyLoading/index.d.ts

@@ -0,0 +1,2 @@
+declare function _exports(cls: Class, factory: Object, options: Object): void;
+export = _exports;

package/build/types/plugins/vueRouter/index.d.ts

@@ -0,0 +1,2 @@
+declare function _exports(cls: any, factory: any, router: any, debug?: boolean): void;
+export = _exports;

package/build/types/utils/domTemplate.d.ts

@@ -0,0 +1,2 @@
+declare function _default(tpl: any, data?: {}): Element;
+export default _default;

package/build/types/utils/isHtmlElement.d.ts

@@ -0,0 +1,2 @@
+declare function _default(el: any): boolean;
+export default _default;

package/build/types/utils/isNodeList.d.ts

@@ -0,0 +1,2 @@
+declare function _default(el: any): boolean;
+export default _default;

package/build/types/utils/isSvgElement.d.ts

@@ -0,0 +1,2 @@
+declare function _default(el: any): boolean;
+export default _default;

package/build/types/xindex.d.ts

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -0,0 +1,94 @@
+{
+  "name": "ahdjs",
+  "version": "0.0.6",
+  "description": "",
+  "main": "build/index.js",
+  "types": "build/types/index.d.ts",
+  "scripts": {
+    "start": "webpack serve --config webpack.config.demo.js",
+    "build": "webpack && tsc",
+    "build:demo": "webpack --config webpack.config.demo.js",
+    "testx": "jest --silent",
+    "test": "echo \"no test\"",
+    "coverage": "npm run test -- --coverage",
+    "prepare": "npm run build",
+    "trypublish": "npm publish || true",
+    "storybook": "start-storybook -p 6006",
+    "build-storybook": "build-storybook -o docs-build"
+  },
+  "repository": {
+    "type": "git",
+    "url": ""
+  },
+  "author": "Ishaan Puniani <ishaan.puniani@gamil.com> (https://github.com/ishaan-puniani)",
+  "license": "MIT",
+  "bugs": {
+    "url": "/issues"
+  },
+  "homepage": "",
+  "keywords": [
+    "library",
+    "starter",
+    "es6"
+  ],
+  "devDependencies": {
+    "@babel/cli": "^7.19.3",
+    "@babel/core": "^7.19.6",
+    "@babel/plugin-proposal-class-properties": "^7.18.6",
+    "@babel/plugin-transform-typescript": "^7.19.3",
+    "@babel/polyfill": "^7.12.1",
+    "@babel/preset-env": "^7.19.4",
+    "@storybook/addon-actions": "^6.5.12",
+    "@storybook/addon-essentials": "^6.5.12",
+    "@storybook/addon-interactions": "^6.5.12",
+    "@storybook/addon-links": "^6.5.12",
+    "@storybook/builder-webpack5": "^6.5.12",
+    "@storybook/html": "^6.5.12",
+    "@storybook/manager-webpack5": "^6.5.12",
+    "@storybook/testing-library": "^0.0.13",
+    "@storybook/preset-scss": "^1.0.3",
+    "@types/jest": "^29.2.0",
+    "@typescript-eslint/eslint-plugin": "^5.40.1",
+    "@typescript-eslint/parser": "^5.40.1",
+    "babel-eslint": "^10.1.0",
+    "babel-loader": "^8.2.5",
+    "babel-preset-minify": "^0.5.2",
+    "css-loader": "^6.7.1",
+    "css-minimizer-webpack-plugin": "^4.2.2",
+    "eslint": "^8.26.0",
+    "eslint-plugin-storybook": "^0.6.6",
+    "file-loader": "^6.2.0",
+    "html-loader": "^4.2.0",
+    "html-webpack-plugin": "^5.5.0",
+    "jest": "^29.2.1",
+    "mini-css-extract-plugin": "^2.6.1",
+    "sass": "^1.55.0",
+    "sass-loader": "^13.1.0",
+    "style-loader": "^3.3.1",
+    "terser-webpack-plugin": "^5.3.6",
+    "typescript": "^4.8.4",
+    "url-loader": "^4.1.1",
+    "webpack": "^5.74.0",
+    "webpack-cli": "^4.10.0",
+    "webpack-dev-server": "4.11.1"
+  },
+  "jest": {
+    "moduleNameMapper": {
+      "\\.(jpg|jpeg|png|gif|eot|otf|webp|svg|ttf|woff|woff2|mp4|webm|wav|mp3|m4a|aac|oga)$": "<rootDir>/scripts/testMock.js",
+      "\\.(css|less)$": "<rootDir>/scripts/testMock.js"
+    },
+    "moduleFileExtensions": [
+      "web.js",
+      "js",
+      "web.ts",
+      "ts",
+      "web.tsx",
+      "tsx",
+      "json",
+      "web.jsx",
+      "jsx",
+      "node"
+    ]
+  },
+  "dependencies": {}
+}

package/tsconfig.json

@@ -0,0 +1,18 @@
+{
+    "compilerOptions": {
+      "noImplicitAny": true,
+      "outDir": "build/types",
+      "module": "esnext",
+      "target": "es5",
+      "allowJs": true,
+      "sourceMap": true,
+      "declaration": true,
+      "emitDeclarationOnly": true,
+      "suppressImplicitAnyIndexErrors": true,
+      "lib": ["es2018", "dom"],
+      "moduleResolution": "node",
+      "skipLibCheck": true
+    },
+    "include": ["src/lib"],
+    "exclude": ["src/lib/**/tests","node_modules"],
+}

package/webpack.config.demo.js

@@ -0,0 +1,75 @@
+const MiniCssExtractPlugin = require("mini-css-extract-plugin");
+const HtmlWebpackPlugin = require("html-webpack-plugin");
+
+module.exports = [
+  {
+    mode: "development",
+    devtool: "cheap-module-source-map",
+    entry: "./src/demo/index.ts",
+    output: {
+      filename: "index.js",
+    },
+    optimization: {
+      minimize: false,
+    },
+    devServer: {
+      open: true,
+      hot: true,
+      host: "localhost",
+      port: 9000,
+    },
+    module: {
+      rules: [
+        {
+          test: /\.html$/i,
+          loader: "html-loader",
+          options: {
+            minimize: {
+              caseSensitive: true,
+              collapseWhitespace: true,
+              conservativeCollapse: true,
+              keepClosingSlash: true,
+              minifyCSS: false,
+              minifyJS: true,
+              removeComments: true,
+              removeRedundantAttributes: true,
+              removeScriptTypeAttributes: true,
+              removeStyleLinkTypeAttributes: true,
+            },
+          },
+        },
+        {
+          test: /\.(m|j|t)s$/,
+          exclude: /(node_modules|bower_components)/,
+          use: {
+            loader: "babel-loader",
+          },
+        },
+        {
+          test: /\.(sa|sc|c)ss$/,
+          use: [
+            {
+              loader: MiniCssExtractPlugin.loader,
+            },
+            {
+              loader: "css-loader",
+              options: {
+                sourceMap: true,
+              },
+            },
+            "sass-loader",
+          ],
+        },
+      ],
+    },
+    plugins: [
+      new MiniCssExtractPlugin({
+        filename: "css/index.css",
+      }),
+      new HtmlWebpackPlugin(),
+    ],
+    resolve: {
+      extensions: [".ts", ".js", ".json"],
+    },
+  },
+];