stimulus-library 0.9.11 → 1.0.0-alpha.0

package/dist/index.d.ts

@@ -1,3 +1,3 @@
-export * from "./utilities";
-export * from "./mixins";
-export * from "./controllers";
+export * from "@stimulus-library/utilities";
+export * from "@stimulus-library/mixins";
+export * from "@stimulus-library/controllers";

package/dist/index.js

@@ -1,6 +1,6 @@
 // Utilities
-export * from "./utilities";
+export * from "@stimulus-library/utilities";
 // Mixins
-export * from "./mixins";
+export * from "@stimulus-library/mixins";
 // Controllers
-export * from "./controllers";
+export * from "@stimulus-library/controllers";

package/package.json

@@ -9,7 +9,7 @@
     "ruby on rails",
     "ruby-on-rails"
   ],
-  "version": "0.9.11",
+  "version": "1.0.0-alpha.0",
   "license": "MIT",
   "author": {
     "name": "Sub-Xaero",
@@ -28,26 +28,22 @@
   "scripts": {
     "build": "tsc",
     "dev": "tsc --watch",
-    "prepack": "yarn build",
+    "prepack": "npm run build",
     "release": "standard-version",
     "test": "cypress run",
     "test:treeshake": "agadoo dist"
   },
   "dependencies": {
-    "@babel/runtime": "^7.20.13",
     "@hotwired/stimulus": "^3.2.1",
-    "date-fns": "^2.29.3",
-    "dialog-polyfill": "^0.5.6",
-    "lodash-es": "^4.17.21",
-    "mitt": "^3.0.0",
-    "smoothscroll-polyfill": "^0.4.4"
+    "@stimulus-library/controllers": "^1.0.0-alpha.0",
+    "@stimulus-library/mixins": "^1.0.0-alpha.0",
+    "@stimulus-library/utilities": "*0"
   },
   "devDependencies": {
-    "@types/lodash-es": "^4.17.6",
-    "@types/smoothscroll-polyfill": "^0.3.1",
     "agadoo": "^3.0.0",
     "cypress": "^12.5.1",
     "fast-glob": "^3.2.12",
+    "lerna": "^6.5.1",
     "rimraf": "^4.1.2",
     "standard-version": "^9.5.0",
     "typescript": "^4.9.5",

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2022 Sub-Xaero
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

package/README.md

@@ -1,43 +0,0 @@
-# Stimulus-Library
-
-[Documentation](https://sub-xaero.github.io/stimulus-library/)  |  [Full List of Controllers](https://sub-xaero.github.io/stimulus-library/)
-
----
-![npm](https://img.shields.io/npm/dt/stimulus-library)
-![npm bundle size (version)](https://img.shields.io/bundlephobia/minzip/stimulus-library/latest?label=minified%20size)
----
-
-## Installation
-
-To get started, you'll need to add the `stimulus-library` package to your project.
-
-To do so, either add `stimulus-library` to your package.json manually
-
-```json
-{
-  "dependencies": {
-    "stimulus-library": "latest"
-  }
-}
-```
-
-or run
-`npm install --save stimulus-library` or `yarn add stimulus-library`
-
-
-Then, to get started, import and register the controllers you want to use.
-
-*Please Note* as below, that when registering the name for the controller, you should use `kebab-case` and omit the `-controller` suffix.
-
-```js
-import { Application } from "@hotwired/stimulus";
-import { AutoSubmitFormController } from "stimulus-library";
-
-const application = Application.start();
-application.register("auto-submit-form", AutoSubmitFormController);
-```
-
-## Tree-shaking
-If you use the ESM builds of the library, this library fully supports tree-shaking, 
-only the controllers you directly import will be bundled with your application.  
-

package/dist/controllers/ajax/async_block_controller.d.ts

@@ -1,17 +0,0 @@
-import { LoadBlockController } from "./load_block_controller";
-export declare class AsyncBlockController extends LoadBlockController {
-    static targets: string[];
-    static values: {
-        endpoint: StringConstructor;
-        errorMessage: StringConstructor;
-        selector: StringConstructor;
-        maxRetries: NumberConstructor;
-    };
-    readonly replaceTarget: HTMLElement;
-    readonly hasReplaceTarget: boolean;
-    readonly endpointValue: string;
-    readonly hasErrorMessageValue: boolean;
-    readonly errorMessageValue: string;
-    get _errorMessage(): string;
-    connect(): Promise<void>;
-}

package/dist/controllers/ajax/async_block_controller.js

@@ -1,19 +0,0 @@
-import { LoadBlockController } from "./load_block_controller";
-export class AsyncBlockController extends LoadBlockController {
-    static targets = ["replace"];
-    static values = {
-        endpoint: String,
-        errorMessage: String,
-        selector: String,
-        maxRetries: Number,
-    };
-    get _errorMessage() {
-        return this.hasErrorMessageValue ? this.errorMessageValue : "This content failed to load";
-    }
-    // This is a simple controller to load a block of content when the page loads.
-    // It should be used to give a quick initial response before calling out to an
-    // an AJAX endpoint to do some expensive work.
-    async connect() {
-        await this.loadContent();
-    }
-}

package/dist/controllers/ajax/index.d.ts

@@ -1,4 +0,0 @@
-export * from './async_block_controller';
-export * from './lazy_block_controller';
-export * from './load_block_controller';
-export * from './poll_block_controller';

package/dist/controllers/ajax/index.js

@@ -1,4 +0,0 @@
-export * from './async_block_controller';
-export * from './lazy_block_controller';
-export * from './load_block_controller';
-export * from './poll_block_controller';

package/dist/controllers/ajax/lazy_block_controller.d.ts

@@ -1,9 +0,0 @@
-import { LoadBlockController } from "./load_block_controller";
-export declare class LazyBlockController extends LoadBlockController {
-    observe: () => void;
-    unobserve: () => void;
-    isVisible: boolean;
-    disappear: () => void;
-    connect(): Promise<void>;
-    appear(entry: IntersectionObserverEntry): Promise<void>;
-}

package/dist/controllers/ajax/lazy_block_controller.js

@@ -1,24 +0,0 @@
-import { LoadBlockController } from "./load_block_controller";
-import { useIntersection } from "../../mixins/use_intersection";
-export class LazyBlockController extends LoadBlockController {
-    async connect() {
-        let element = this.el;
-        if ("IntersectionObserver" in window) {
-            let { observe, unobserve } = useIntersection(this, element, this.appear, null, { threshold: 0.3 });
-            this.observe = observe;
-            this.unobserve = unobserve;
-        }
-        else {
-            // Client doesn't support intersection observer, fallback to pre-loading
-            await this.loadContent();
-        }
-    }
-    async appear(entry) {
-        if (entry.target === this.el && entry.isIntersecting) {
-            await this.loadContent();
-            if (this.unobserve) {
-                this.unobserve();
-            }
-        }
-    }
-}

package/dist/controllers/ajax/load_block_controller.d.ts

@@ -1,23 +0,0 @@
-import { BaseController } from "../../utilities/base_controller";
-export declare class LoadBlockController extends BaseController {
-    static targets: string[];
-    static values: {
-        endpoint: StringConstructor;
-        errorMessage: StringConstructor;
-        selector: StringConstructor;
-        maxRetries: NumberConstructor;
-    };
-    maxRetriesValue: number;
-    readonly hasMaxRetriesValue: boolean;
-    readonly replaceTarget: HTMLElement;
-    readonly hasReplaceTarget: boolean;
-    readonly endpointValue: string;
-    readonly hasSelectorValue: boolean;
-    readonly selectorValue: string;
-    readonly hasErrorMessageValue: boolean;
-    readonly errorMessageValue: string;
-    get _errorMessage(): string;
-    get _maxRetries(): number;
-    connect(): void;
-    loadContent(event?: Event | null): Promise<void>;
-}

package/dist/controllers/ajax/load_block_controller.js

@@ -1,52 +0,0 @@
-import { BaseController } from "../../utilities/base_controller";
-import { fetchRetry } from "../../utilities/fetchRetry";
-export class LoadBlockController extends BaseController {
-    static targets = ["replace"];
-    static values = {
-        endpoint: String,
-        errorMessage: String,
-        selector: String,
-        maxRetries: Number,
-    };
-    get _errorMessage() {
-        return this.hasErrorMessageValue ? this.errorMessageValue : "This content failed to load";
-    }
-    get _maxRetries() {
-        return this.hasMaxRetriesValue ? this.maxRetriesValue : 1;
-    }
-    connect() {
-    }
-    async loadContent(event = null) {
-        event?.preventDefault();
-        let self = this;
-        let el = this.hasReplaceTarget ? this.replaceTarget : this.el;
-        let failure = () => {
-            el.replaceWith(this._errorMessage);
-            self.dispatchEvent(el, "ajax:error");
-        };
-        try {
-            let response = await fetchRetry(this._maxRetries, this.endpointValue);
-            if (!response.ok) {
-                failure();
-            }
-            let text = await response.text();
-            let newEl = document.createElement("div");
-            newEl.innerHTML = text;
-            if (this.hasSelectorValue) {
-                let selectedContent = newEl.querySelectorAll(this.selectorValue);
-                el.replaceWith(...selectedContent);
-            }
-            else {
-                el.replaceWith(...newEl.children);
-            }
-            // Trigger event to show block has loaded
-            self.dispatchEvent(el, "ajax:success");
-        }
-        catch (e) {
-            failure();
-        }
-        finally {
-            self.dispatchEvent(el, "ajax:complete");
-        }
-    }
-}

package/dist/controllers/ajax/poll_block_controller.d.ts

@@ -1,15 +0,0 @@
-import { LoadBlockController } from "./load_block_controller";
-export declare class PollBlockController extends LoadBlockController {
-    static targets: string[];
-    static values: {
-        endpoint: StringConstructor;
-        errorMessage: StringConstructor;
-        selector: StringConstructor;
-        maxRetries: NumberConstructor;
-        seconds: NumberConstructor;
-    };
-    readonly hasSecondsValue: boolean;
-    readonly secondsValue: number;
-    connect(): void;
-    _timeout(): Promise<void>;
-}

package/dist/controllers/ajax/poll_block_controller.js

@@ -1,24 +0,0 @@
-import { LoadBlockController } from "./load_block_controller";
-import { useInterval } from "../../mixins/use_interval";
-export class PollBlockController extends LoadBlockController {
-    static targets = ["replace"];
-    static values = {
-        endpoint: String,
-        errorMessage: String,
-        selector: String,
-        maxRetries: Number,
-        seconds: Number,
-    };
-    connect() {
-        if (!this.hasSecondsValue) {
-            throw new Error("Required value `seconds` is missing");
-        }
-        requestAnimationFrame(() => {
-            this._timeout();
-            useInterval(this, this._timeout, this.secondsValue * 1000);
-        });
-    }
-    async _timeout() {
-        await this.loadContent();
-    }
-}

package/dist/controllers/anchor_spy_controller.d.ts

@@ -1,21 +0,0 @@
-import { BaseController } from "../utilities/base_controller";
-import "../polyfills/string.replaceAll";
-export declare class AnchorSpyController extends BaseController {
-    static values: {
-        key: StringConstructor;
-    };
-    static classes: string[];
-    readonly keyValue: string;
-    addActiveClasses: (el?: HTMLElement) => void;
-    removeInactiveClasses: (el?: HTMLElement) => void;
-    addInactiveClasses: (el?: HTMLElement) => void;
-    removeActiveClasses: (el?: HTMLElement) => void;
-    get defaultActiveClasses(): string[];
-    get defaultInactiveClasses(): string[];
-    get _key(): string;
-    get _anchor(): string;
-    set _anchor(value: string);
-    connect(): void;
-    write(event?: Event): void;
-    private _checkAnchor;
-}

package/dist/controllers/anchor_spy_controller.js

@@ -1,47 +0,0 @@
-import { BaseController } from "../utilities/base_controller";
-import { useEventListener } from "../mixins/use_event_listener";
-import { installClassMethods } from "../mixins/install_class_methods";
-import "../polyfills/string.replaceAll";
-export class AnchorSpyController extends BaseController {
-    static values = { key: String };
-    static classes = ["active", "inactive"];
-    get defaultActiveClasses() {
-        return ["active"];
-    }
-    get defaultInactiveClasses() {
-        return ["inactive"];
-    }
-    get _key() {
-        // @ts-ignore
-        return this.keyValue.replaceAll('#', '');
-    }
-    get _anchor() {
-        return window.location.hash.substr(1);
-    }
-    set _anchor(value) {
-        window.location.hash = value;
-    }
-    connect() {
-        installClassMethods(this);
-        requestAnimationFrame(() => {
-            this._checkAnchor();
-            useEventListener(this, window, 'hashchange', this._checkAnchor);
-        });
-    }
-    write(event) {
-        event?.preventDefault();
-        this._anchor = this._key;
-    }
-    _checkAnchor() {
-        if (this._key === this._anchor) {
-            this.dispatchEvent(this.el, "anchor-spy:active");
-            this.addActiveClasses(this.el);
-            this.removeInactiveClasses(this.el);
-        }
-        else {
-            this.dispatchEvent(this.el, "anchor-spy:inactive");
-            this.addInactiveClasses(this.el);
-            this.removeActiveClasses(this.el);
-        }
-    }
-}

package/dist/controllers/back_link_controller.d.ts

@@ -1,16 +0,0 @@
-import { BaseController } from "../utilities/base_controller";
-export declare class BackLinkController extends BaseController {
-    static values: {
-        timeout: NumberConstructor;
-        pages: NumberConstructor;
-    };
-    readonly timeoutValue: number;
-    readonly hasTimeoutValue: boolean;
-    readonly pagesValue: number;
-    readonly hasPagesValue: boolean;
-    get _pages(): number;
-    get _timeout(): number;
-    connect(): void;
-    goBack(event?: Event): void;
-    fallback(): void;
-}

package/dist/controllers/back_link_controller.js

@@ -1,25 +0,0 @@
-import { BaseController } from "../utilities/base_controller";
-import { useTimeout } from "../mixins/use_timeout";
-import { useEventListener } from "../mixins/use_event_listener";
-export class BackLinkController extends BaseController {
-    static values = { timeout: Number, pages: Number };
-    get _pages() {
-        return this.hasPagesValue ? Math.abs(this.pagesValue) : 1;
-    }
-    get _timeout() {
-        return this.hasTimeoutValue ? this.timeoutValue : 1500;
-    }
-    connect() {
-        useEventListener(this, this.el, "click", this.goBack);
-    }
-    goBack(event) {
-        event?.preventDefault();
-        history.go(-this._pages);
-        if (this.el.href) {
-            useTimeout(this, this.fallback, this._timeout);
-        }
-    }
-    fallback() {
-        window.location.href = this.el.href;
-    }
-}

package/dist/controllers/clipboard_controller.d.ts

@@ -1,18 +0,0 @@
-import { BaseController } from "../utilities/base_controller";
-export declare class ClipboardController extends BaseController {
-    static targets: string[];
-    static values: {
-        removeUnused: BooleanConstructor;
-    };
-    readonly sourceTarget: HTMLElement;
-    readonly copyTarget: HTMLElement;
-    readonly hasCopyTarget: boolean;
-    readonly fallbackTarget: HTMLElement;
-    readonly hasFallbackTarget: boolean;
-    readonly hasRemoveUnusedValue: boolean;
-    readonly removeUnusedValue: boolean;
-    _supported: boolean;
-    connect(): void;
-    select(event: MouseEvent): void;
-    copy(event: ClipboardEvent): void;
-}

package/dist/controllers/clipboard_controller.js

@@ -1,32 +0,0 @@
-import { BaseController } from "../utilities/base_controller";
-export class ClipboardController extends BaseController {
-    static targets = ["source", "button", "copy", "fallback"];
-    static values = { removeUnused: Boolean };
-    _supported = false;
-    connect() {
-        this._supported = document.queryCommandSupported("copy");
-        if (this.hasRemoveUnusedValue && this.removeUnusedValue) {
-            if (this._supported && this.hasFallbackTarget) {
-                this.fallbackTarget.remove();
-            }
-            else if (this.hasCopyTarget) {
-                this.copyTarget.remove();
-            }
-        }
-    }
-    select(event) {
-        if (event) {
-            event.preventDefault();
-        }
-        this.sourceTarget.select();
-    }
-    copy(event) {
-        if (event) {
-            event.preventDefault();
-        }
-        this.sourceTarget.select();
-        if (this._supported) {
-            document.execCommand("copy");
-        }
-    }
-}

package/dist/controllers/confirm_controller.d.ts

@@ -1,12 +0,0 @@
-import { BaseController } from '../utilities/base_controller';
-export declare class ConfirmController extends BaseController {
-    static values: {
-        message: StringConstructor;
-    };
-    readonly messageValue: string;
-    readonly hasMessageValue: boolean;
-    get _message(): string;
-    get _eventType(): "submit" | "click";
-    connect(): void;
-    confirm(event: Event): void;
-}

package/dist/controllers/confirm_controller.js

@@ -1,33 +0,0 @@
-import { BaseController } from '../utilities/base_controller';
-import { isHTMLAnchorElement, isHTMLFormElement } from "../utilities/elements";
-import { useEventListener } from "../mixins/use_event_listener";
-export class ConfirmController extends BaseController {
-    static values = {
-        message: String,
-    };
-    get _message() {
-        return this.hasMessageValue ? this.messageValue : 'Are you sure?';
-    }
-    get _eventType() {
-        if (isHTMLFormElement(this.el)) {
-            return "submit";
-        }
-        else if (isHTMLAnchorElement(this.el)) {
-            return "click";
-        }
-        else {
-            throw new Error("Can't handle confirmation on attached element");
-        }
-    }
-    connect() {
-        requestAnimationFrame(() => {
-            useEventListener(this, this.el, this._eventType, this.confirm);
-        });
-    }
-    confirm(event) {
-        if (!(window.confirm(this._message))) {
-            event.preventDefault();
-            this.dispatchEvent(this.el, "confirm:cancelled");
-        }
-    }
-}

package/dist/controllers/confirm_navigation_controller.d.ts

@@ -1,14 +0,0 @@
-import { BaseController } from "../utilities/base_controller";
-export declare class ConfirmNavigationController extends BaseController {
-    static values: {
-        message: StringConstructor;
-    };
-    readonly messageValue: string;
-    readonly hasMessageValue: boolean;
-    get _message(): string;
-    connect(): void;
-    disconnect(): void;
-    allowSubmit(_event: Event): void;
-    confirmNavigation(_event: Event | PopStateEvent): boolean;
-    confirmTurboNavigation(event: Event): void;
-}

package/dist/controllers/confirm_navigation_controller.js

@@ -1,29 +0,0 @@
-import { BaseController } from "../utilities/base_controller";
-import { useEventListener } from "../mixins/use_event_listener";
-export class ConfirmNavigationController extends BaseController {
-    static values = { message: String };
-    get _message() {
-        return this.hasMessageValue ? this.messageValue : "Do you want to leave this page? Changes you made may not be saved";
-    }
-    connect() {
-        window.onbeforeunload = () => this._message;
-        useEventListener(this, window, "popstate", this.confirmNavigation);
-        useEventListener(this, window, "submit", this.allowSubmit);
-        useEventListener(this, window, ["turbolinks:before-visit", "turbo:before-visit"], this.confirmTurboNavigation);
-    }
-    disconnect() {
-        window.onbeforeunload = null;
-    }
-    allowSubmit(_event) {
-        window.removeEventListener("popstate", this.confirmNavigation);
-        window.onbeforeunload = null;
-    }
-    confirmNavigation(_event) {
-        return false;
-    }
-    confirmTurboNavigation(event) {
-        if (!confirm(this._message)) {
-            event.preventDefault();
-        }
-    }
-}

package/dist/controllers/debug_controller.d.ts

@@ -1,6 +0,0 @@
-import { BaseController } from "../utilities/base_controller";
-export declare class DebugController extends BaseController {
-    static targets: string[];
-    testTargets: HTMLElement[];
-    connect(): void;
-}

package/dist/controllers/debug_controller.js

@@ -1,7 +0,0 @@
-import { BaseController } from "../utilities/base_controller";
-export class DebugController extends BaseController {
-    static targets = ["test"];
-    connect() {
-        console.log("Debug Controller", this, this.testTargets);
-    }
-}

package/dist/controllers/disable_with_controller.d.ts

@@ -1,19 +0,0 @@
-import { BaseController } from '../utilities/base_controller';
-export declare class DisableWithController extends BaseController {
-    static values: {
-        message: StringConstructor;
-        timeout: NumberConstructor;
-    };
-    readonly messageValue: string;
-    readonly hasMessageValue: boolean;
-    readonly timeoutValue: number;
-    readonly hasTimeoutValue: boolean;
-    get _message(): string;
-    get _timeout(): number;
-    connect(): void;
-    disable(event?: Event): void;
-    enable(event?: Event): void;
-    _isDisabled(el: HTMLElement): boolean;
-    _disable(): void;
-    _enable(): void;
-}