@spectrum-web-components/reactive-controllers 0.41.2 → 0.42.1

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@spectrum-web-components/reactive-controllers",
-    "version": "0.41.2",
+    "version": "0.42.1",
     "publishConfig": {
         "access": "public"
     },
@@ -29,6 +29,10 @@
             "development": "./src/Color.dev.js",
             "default": "./src/Color.js"
         },
+        "./src/DependencyManger.js": {
+            "development": "./src/DependencyManger.dev.js",
+            "default": "./src/DependencyManger.js"
+        },
         "./src/ElementResolution.js": {
             "development": "./src/ElementResolution.dev.js",
             "default": "./src/ElementResolution.js"
@@ -79,5 +83,5 @@
     "sideEffects": [
         "./**/*.dev.js"
     ],
-    "gitHead": "78c3f16b08c9133c9e5ca88d0c9fef5ea7d2ab87"
+    "gitHead": "c7ab5516e86d20194e92114afd04affa490b7248"
 }

package/src/DependencyManger.d.ts

@@ -0,0 +1,26 @@
+import type { ReactiveElement } from 'lit';
+export declare const dependencyManagerLoadedSymbol: unique symbol;
+/**
+ * Manage the availability of custom element dependencies of a host element
+ * to gate render and functional behavior before and after their presence
+ */
+export declare class DependencyManagerController {
+    private dependencies;
+    private host;
+    /**
+     * Whether all of the provided dependencies have been registered.
+     * This will be `false` when no dependencies have been listed for management.
+     * Changes to this value will trigger `requestUpdate()` on the host.
+     */
+    get loaded(): boolean;
+    private set loaded(value);
+    private _loaded;
+    constructor(host: ReactiveElement);
+    /**
+     * Submit a custom element tag name to be managed as a dependency.
+     *
+     * @param dependency {string} - the custom element tag to manage
+     * @param alreadyLoaded {boolean} - force the managemented custom element to be listed as loaded
+     */
+    add(dependency: string, alreadyLoaded?: boolean): void;
+}

package/src/DependencyManger.dev.js

@@ -0,0 +1,47 @@
+"use strict";
+export const dependencyManagerLoadedSymbol = Symbol(
+  "dependency manager loaded"
+);
+export class DependencyManagerController {
+  constructor(host) {
+    this.dependencies = {};
+    this._loaded = false;
+    this.host = host;
+  }
+  /**
+   * Whether all of the provided dependencies have been registered.
+   * This will be `false` when no dependencies have been listed for management.
+   * Changes to this value will trigger `requestUpdate()` on the host.
+   */
+  get loaded() {
+    return this._loaded;
+  }
+  set loaded(loaded) {
+    if (loaded === this.loaded)
+      return;
+    this._loaded = loaded;
+    this.host.requestUpdate(dependencyManagerLoadedSymbol, !this.loaded);
+  }
+  /**
+   * Submit a custom element tag name to be managed as a dependency.
+   *
+   * @param dependency {string} - the custom element tag to manage
+   * @param alreadyLoaded {boolean} - force the managemented custom element to be listed as loaded
+   */
+  add(dependency, alreadyLoaded) {
+    const loaded = !!alreadyLoaded || !!customElements.get(dependency) || this.dependencies[dependency];
+    if (!loaded) {
+      customElements.whenDefined(dependency).then(() => {
+        this.add(dependency, true);
+      });
+    }
+    this.dependencies = {
+      ...this.dependencies,
+      [dependency]: loaded
+    };
+    this.loaded = Object.values(this.dependencies).every(
+      (loaded2) => loaded2
+    );
+  }
+}
+//# sourceMappingURL=DependencyManger.dev.js.map

package/src/DependencyManger.dev.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["DependencyManger.ts"],
+  "sourcesContent": ["/*\nCopyright 2022 Adobe. All rights reserved.\nThis file is licensed to you under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License. You may obtain a copy\nof the License at http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software distributed under\nthe License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS\nOF ANY KIND, either express or implied. See the License for the specific language\ngoverning permissions and limitations under the License.\n*/\n\nimport type { ReactiveElement } from 'lit';\nexport const dependencyManagerLoadedSymbol = Symbol(\n    'dependency manager loaded'\n);\n\n/**\n * Manage the availability of custom element dependencies of a host element\n * to gate render and functional behavior before and after their presence\n */\nexport class DependencyManagerController {\n    private dependencies: Record<string, boolean> = {};\n\n    private host!: ReactiveElement;\n\n    /**\n     * Whether all of the provided dependencies have been registered.\n     * This will be `false` when no dependencies have been listed for management.\n     * Changes to this value will trigger `requestUpdate()` on the host.\n     */\n    public get loaded(): boolean {\n        return this._loaded;\n    }\n\n    private set loaded(loaded: boolean) {\n        if (loaded === this.loaded) return;\n        this._loaded = loaded;\n        this.host.requestUpdate(dependencyManagerLoadedSymbol, !this.loaded);\n    }\n\n    private _loaded = false;\n\n    constructor(host: ReactiveElement) {\n        this.host = host;\n    }\n\n    /**\n     * Submit a custom element tag name to be managed as a dependency.\n     *\n     * @param dependency {string} - the custom element tag to manage\n     * @param alreadyLoaded {boolean} - force the managemented custom element to be listed as loaded\n     */\n    public add(dependency: string, alreadyLoaded?: boolean): void {\n        const loaded =\n            !!alreadyLoaded ||\n            !!customElements.get(dependency) ||\n            this.dependencies[dependency];\n        if (!loaded) {\n            customElements.whenDefined(dependency).then(() => {\n                this.add(dependency, true);\n            });\n        }\n        this.dependencies = {\n            ...this.dependencies,\n            [dependency]: loaded,\n        };\n        // Update the loaded property based on the new loaded state of all dependencies\n        this.loaded = Object.values(this.dependencies).every(\n            (loaded) => loaded\n        );\n    }\n}\n"],
+  "mappings": ";AAaO,aAAM,gCAAgC;AAAA,EACzC;AACJ;AAMO,aAAM,4BAA4B;AAAA,EAsBrC,YAAY,MAAuB;AArBnC,SAAQ,eAAwC,CAAC;AAmBjD,SAAQ,UAAU;AAGd,SAAK,OAAO;AAAA,EAChB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAdA,IAAW,SAAkB;AACzB,WAAO,KAAK;AAAA,EAChB;AAAA,EAEA,IAAY,OAAO,QAAiB;AAChC,QAAI,WAAW,KAAK;AAAQ;AAC5B,SAAK,UAAU;AACf,SAAK,KAAK,cAAc,+BAA+B,CAAC,KAAK,MAAM;AAAA,EACvE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAcO,IAAI,YAAoB,eAA+B;AAC1D,UAAM,SACF,CAAC,CAAC,iBACF,CAAC,CAAC,eAAe,IAAI,UAAU,KAC/B,KAAK,aAAa,UAAU;AAChC,QAAI,CAAC,QAAQ;AACT,qBAAe,YAAY,UAAU,EAAE,KAAK,MAAM;AAC9C,aAAK,IAAI,YAAY,IAAI;AAAA,MAC7B,CAAC;AAAA,IACL;AACA,SAAK,eAAe;AAAA,MAChB,GAAG,KAAK;AAAA,MACR,CAAC,UAAU,GAAG;AAAA,IAClB;AAEA,SAAK,SAAS,OAAO,OAAO,KAAK,YAAY,EAAE;AAAA,MAC3C,CAACA,YAAWA;AAAA,IAChB;AAAA,EACJ;AACJ;",
+  "names": ["loaded"]
+}

package/src/DependencyManger.js

@@ -0,0 +1,2 @@
+"use strict";export const dependencyManagerLoadedSymbol=Symbol("dependency manager loaded");export class DependencyManagerController{constructor(e){this.dependencies={};this._loaded=!1;this.host=e}get loaded(){return this._loaded}set loaded(e){e!==this.loaded&&(this._loaded=e,this.host.requestUpdate(dependencyManagerLoadedSymbol,!this.loaded))}add(e,o){const t=!!o||!!customElements.get(e)||this.dependencies[e];t||customElements.whenDefined(e).then(()=>{this.add(e,!0)}),this.dependencies={...this.dependencies,[e]:t},this.loaded=Object.values(this.dependencies).every(d=>d)}}
+//# sourceMappingURL=DependencyManger.js.map

package/src/DependencyManger.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["DependencyManger.ts"],
+  "sourcesContent": ["/*\nCopyright 2022 Adobe. All rights reserved.\nThis file is licensed to you under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License. You may obtain a copy\nof the License at http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software distributed under\nthe License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS\nOF ANY KIND, either express or implied. See the License for the specific language\ngoverning permissions and limitations under the License.\n*/\n\nimport type { ReactiveElement } from 'lit';\nexport const dependencyManagerLoadedSymbol = Symbol(\n    'dependency manager loaded'\n);\n\n/**\n * Manage the availability of custom element dependencies of a host element\n * to gate render and functional behavior before and after their presence\n */\nexport class DependencyManagerController {\n    private dependencies: Record<string, boolean> = {};\n\n    private host!: ReactiveElement;\n\n    /**\n     * Whether all of the provided dependencies have been registered.\n     * This will be `false` when no dependencies have been listed for management.\n     * Changes to this value will trigger `requestUpdate()` on the host.\n     */\n    public get loaded(): boolean {\n        return this._loaded;\n    }\n\n    private set loaded(loaded: boolean) {\n        if (loaded === this.loaded) return;\n        this._loaded = loaded;\n        this.host.requestUpdate(dependencyManagerLoadedSymbol, !this.loaded);\n    }\n\n    private _loaded = false;\n\n    constructor(host: ReactiveElement) {\n        this.host = host;\n    }\n\n    /**\n     * Submit a custom element tag name to be managed as a dependency.\n     *\n     * @param dependency {string} - the custom element tag to manage\n     * @param alreadyLoaded {boolean} - force the managemented custom element to be listed as loaded\n     */\n    public add(dependency: string, alreadyLoaded?: boolean): void {\n        const loaded =\n            !!alreadyLoaded ||\n            !!customElements.get(dependency) ||\n            this.dependencies[dependency];\n        if (!loaded) {\n            customElements.whenDefined(dependency).then(() => {\n                this.add(dependency, true);\n            });\n        }\n        this.dependencies = {\n            ...this.dependencies,\n            [dependency]: loaded,\n        };\n        // Update the loaded property based on the new loaded state of all dependencies\n        this.loaded = Object.values(this.dependencies).every(\n            (loaded) => loaded\n        );\n    }\n}\n"],
+  "mappings": "aAaO,aAAM,8BAAgC,OACzC,2BACJ,EAMO,aAAM,2BAA4B,CAsBrC,YAAYA,EAAuB,CArBnC,KAAQ,aAAwC,CAAC,EAmBjD,KAAQ,QAAU,GAGd,KAAK,KAAOA,CAChB,CAdA,IAAW,QAAkB,CACzB,OAAO,KAAK,OAChB,CAEA,IAAY,OAAOC,EAAiB,CAC5BA,IAAW,KAAK,SACpB,KAAK,QAAUA,EACf,KAAK,KAAK,cAAc,8BAA+B,CAAC,KAAK,MAAM,EACvE,CAcO,IAAIC,EAAoBC,EAA+B,CAC1D,MAAMF,EACF,CAAC,CAACE,GACF,CAAC,CAAC,eAAe,IAAID,CAAU,GAC/B,KAAK,aAAaA,CAAU,EAC3BD,GACD,eAAe,YAAYC,CAAU,EAAE,KAAK,IAAM,CAC9C,KAAK,IAAIA,EAAY,EAAI,CAC7B,CAAC,EAEL,KAAK,aAAe,CAChB,GAAG,KAAK,aACR,CAACA,CAAU,EAAGD,CAClB,EAEA,KAAK,OAAS,OAAO,OAAO,KAAK,YAAY,EAAE,MAC1CA,GAAWA,CAChB,CACJ,CACJ",
+  "names": ["host", "loaded", "dependency", "alreadyLoaded"]
+}

package/test/dependency-manager.test.js

@@ -0,0 +1,24 @@
+"use strict";
+import { expect, nextFrame } from "@open-wc/testing";
+import { DependencyManagerController } from "@spectrum-web-components/reactive-controllers/src/DependencyManger.js";
+import { spy } from "sinon";
+describe("Dependency Manager", () => {
+  it("manages dependencies", async function() {
+    this.retries(0);
+    const tagName = "some-heavy-element";
+    const requestUpdateSpy = spy();
+    const manager = new DependencyManagerController({
+      requestUpdate: () => requestUpdateSpy()
+    });
+    expect(manager.loaded).to.be.false;
+    manager.add(tagName);
+    expect(manager.loaded).to.be.false;
+    expect(requestUpdateSpy.notCalled).to.be.true;
+    customElements.define(tagName, class extends HTMLElement {
+    });
+    await nextFrame();
+    expect(manager.loaded).to.be.true;
+    expect(requestUpdateSpy.notCalled).to.be.false;
+  });
+});
+//# sourceMappingURL=dependency-manager.test.js.map

package/test/dependency-manager.test.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["dependency-manager.test.ts"],
+  "sourcesContent": ["/*\nCopyright 2022 Adobe. All rights reserved.\nThis file is licensed to you under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License. You may obtain a copy\nof the License at http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software distributed under\nthe License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS\nOF ANY KIND, either express or implied. See the License for the specific language\ngoverning permissions and limitations under the License.\n*/\n\nimport { ReactiveElement } from 'lit';\nimport { expect, nextFrame } from '@open-wc/testing';\nimport { DependencyManagerController } from '@spectrum-web-components/reactive-controllers/src/DependencyManger.js';\nimport { spy } from 'sinon';\n\ndescribe('Dependency Manager', () => {\n    it('manages dependencies', async function () {\n        this.retries(0);\n        const tagName = 'some-heavy-element';\n        const requestUpdateSpy = spy();\n        const manager = new DependencyManagerController({\n            requestUpdate: () => requestUpdateSpy(),\n        } as unknown as ReactiveElement);\n        expect(manager.loaded).to.be.false;\n        manager.add(tagName);\n        expect(manager.loaded).to.be.false;\n        expect(requestUpdateSpy.notCalled).to.be.true;\n        customElements.define(tagName, class extends HTMLElement {});\n        // Allow time for the registration to propagate.\n        await nextFrame();\n        expect(manager.loaded).to.be.true;\n        expect(requestUpdateSpy.notCalled).to.be.false;\n    });\n});\n"],
+  "mappings": ";AAaA,SAAS,QAAQ,iBAAiB;AAClC,SAAS,mCAAmC;AAC5C,SAAS,WAAW;AAEpB,SAAS,sBAAsB,MAAM;AACjC,KAAG,wBAAwB,iBAAkB;AACzC,SAAK,QAAQ,CAAC;AACd,UAAM,UAAU;AAChB,UAAM,mBAAmB,IAAI;AAC7B,UAAM,UAAU,IAAI,4BAA4B;AAAA,MAC5C,eAAe,MAAM,iBAAiB;AAAA,IAC1C,CAA+B;AAC/B,WAAO,QAAQ,MAAM,EAAE,GAAG,GAAG;AAC7B,YAAQ,IAAI,OAAO;AACnB,WAAO,QAAQ,MAAM,EAAE,GAAG,GAAG;AAC7B,WAAO,iBAAiB,SAAS,EAAE,GAAG,GAAG;AACzC,mBAAe,OAAO,SAAS,cAAc,YAAY;AAAA,IAAC,CAAC;AAE3D,UAAM,UAAU;AAChB,WAAO,QAAQ,MAAM,EAAE,GAAG,GAAG;AAC7B,WAAO,iBAAiB,SAAS,EAAE,GAAG,GAAG;AAAA,EAC7C,CAAC;AACL,CAAC;",
+  "names": []
+}