@arcgis/lumina 4.32.0-next.21 → 4.32.0-next.23

package/dist/PublicLitElement.d.ts

@@ -13,4 +13,5 @@ export declare class PublicLitElement extends HTMLElement {
      * });
      */
     componentOnReady(): Promise<this>;
+    private el;
 }

package/dist/chunk-PEVP6JYY.js

@@ -0,0 +1,424 @@
+import {
+  lazyMetaGroupJoiner,
+  lazyMetaItemJoiner,
+  lazyMetaSubItemJoiner
+} from "./chunk-PGHUBTOM.js";
+
+// src/lazyLoad.ts
+import { Deferred, camelToKebab } from "@arcgis/components-utils";
+
+// src/devOnlyDetectIncorrectLazyUsages.ts
+function devOnlyDetectIncorrectLazyUsages(LitClass) {
+  const genericPrototype = LitClass.prototype;
+  const descriptor = Object.getOwnPropertyDescriptor(genericPrototype, "innerText");
+  if (descriptor !== void 0 && descriptor.get === descriptor.set) {
+    return;
+  }
+  const allowList = /* @__PURE__ */ new Set([
+    // We shouldn't be overwriting this property
+    "constructor",
+    // Called by Lit - we proxy it to this.el in ProxyComponent
+    "setAttribute",
+    // Called by Lit SSR - we proxy it to this.el in ProxyComponent
+    "removeAttribute",
+    // Called by Lit - we proxy it to this.el in ProxyComponent
+    "isConnected",
+    // Called by Lit, but only in dev mode for warnings, so we don't have to proxy.
+    "localName",
+    // Called by Lit Context - we proxy it to this.el in ProxyComponent.
+    // Interestingly, they never call removeEventListener.
+    "addEventListener"
+  ]);
+  const customErrorMessages = {
+    addEventListener: "use this.listen() or this.el.addEventListener()"
+  };
+  Object.entries({
+    ...Object.getOwnPropertyDescriptors(HTMLElement.prototype),
+    ...Object.getOwnPropertyDescriptors(Element.prototype),
+    ...Object.getOwnPropertyDescriptors(Node.prototype),
+    ...Object.getOwnPropertyDescriptors(EventTarget.prototype)
+  }).forEach(([key, value]) => {
+    if (allowList.has(key)) {
+      return;
+    }
+    const callback = (...args) => {
+      if (key === "hasAttribute" && args[0] === "defer-hydration") {
+        return false;
+      }
+      throw new Error(
+        `You should not be trying to access this.${key} directly as it won't work correctly in lazy-builds. Instead, ${customErrorMessages[key] ?? `use this.el.${key}`}`
+      );
+    };
+    if (typeof value.value === "function") {
+      genericPrototype[key] = callback;
+    } else {
+      Object.defineProperty(genericPrototype, key, { get: callback, set: callback });
+    }
+  });
+}
+
+// src/lifecycleSupport.ts
+function attachToAncestor(child) {
+  let ancestor = child;
+  while (ancestor = ancestor.parentNode ?? ancestor.host) {
+    if (ancestor?.constructor?.lumina) {
+      const litParent = ancestor;
+      if (!litParent.manager?.loadedCalled) {
+        litParent._offspring.push(child);
+      }
+      return litParent._postLoad.promise;
+    }
+  }
+  return false;
+}
+
+// src/lazyLoad.ts
+var makeDefineCustomElements = (runtime, structure) => function defineCustomElements(windowOrOptions, options) {
+  if (!globalThis.customElements) {
+    return;
+  }
+  const resolvedOptions = options ?? windowOrOptions ?? {};
+  const resourcesUrl = resolvedOptions.resourcesUrl;
+  if (resourcesUrl) {
+    runtime.setAssetPath(resourcesUrl);
+  }
+  Object.entries(structure).forEach(createLazyElement);
+};
+function createLazyElement([tagName, [load, compactMeta = ""]]) {
+  if (customElements.get(tagName)) {
+    return;
+  }
+  const [compactObservedProps, compactAsyncMethods, compactSyncMethods] = compactMeta.split(lazyMetaGroupJoiner);
+  const observedProps = compactObservedProps ? compactObservedProps?.split(lazyMetaItemJoiner).map(parseCondensedProp) : void 0;
+  const observedProperties = observedProps?.map(([property]) => property);
+  const ProxyClass = class extends ProxyComponent {
+    static {
+      this.observedAttributes = observedProps?.map(([, attribute]) => attribute).filter((attribute) => attribute !== "");
+    }
+    static {
+      this._properties = observedProperties;
+    }
+    static {
+      this._asyncMethods = compactAsyncMethods ? compactAsyncMethods?.split(lazyMetaItemJoiner) : void 0;
+    }
+    static {
+      this._syncMethods = compactSyncMethods?.split(lazyMetaItemJoiner);
+    }
+    static {
+      this._name = tagName;
+    }
+    constructor() {
+      const isFirstInstanceOfType = !ProxyClass._loadPromise;
+      if (isFirstInstanceOfType) {
+        ProxyClass._loadPromise = load();
+        ProxyClass._initializePrototype();
+      }
+      super();
+    }
+  };
+  customElements.define(tagName, ProxyClass);
+}
+var defineProperty = Object.defineProperty;
+function parseCondensedProp(propAndAttribute) {
+  const name = propAndAttribute.split(lazyMetaSubItemJoiner);
+  return name.length === 1 ? [name[0], camelToKebab(name[0])] : name;
+}
+var HtmlElement = globalThis.HTMLElement ?? parseCondensedProp;
+var ProxyComponent = class extends HtmlElement {
+  constructor() {
+    super();
+    /** @internal */
+    this._store = {};
+    /**
+     * If attributeChangedCallback() is called before the LitElement is loaded,
+     * store the attributes here, and replay later
+     */
+    this._pendingAttributes = [];
+    /**
+     * Resolved once LitElement's load() is complete.
+     * Not read inside of this class, but needed for LitElement to determine if
+     * it's closest ancestor finished load()
+     */
+    this._postLoad = new Deferred();
+    /**
+     * Resolved once LitElement's loaded() is complete
+     */
+    this._postLoaded = new Deferred();
+    /**
+     * Direct offspring that should be awaited before loaded() is emitted
+     */
+    this._offspring = [];
+    if (process.env.NODE_ENV !== "production") {
+      this._hmrSetProps = /* @__PURE__ */ new Set();
+      this._hmrSetAttributes = /* @__PURE__ */ new Set();
+      globalThis.devOnly$createdElements ??= [];
+      globalThis.devOnly$createdElements.push(new WeakRef(this));
+    }
+    this._saveInstanceProperties();
+    const ProxyClass = this.constructor;
+    if (ProxyClass._LitConstructor) {
+      this._initializeComponent({ a: ProxyClass._LitConstructor });
+    } else {
+      void ProxyClass._loadPromise.then(this._initializeComponent.bind(this)).catch((error) => {
+        this._postLoaded.reject(error);
+        setTimeout(() => {
+          throw error;
+        });
+      });
+    }
+    if (process.env.NODE_ENV !== "production") {
+      ProxyClass._hmrInstances ??= [];
+      ProxyClass._hmrInstances.push(new WeakRef(this));
+      Object.defineProperty(this, "_store", {
+        value: this._store,
+        enumerable: false,
+        configurable: true
+      });
+    }
+  }
+  static {
+    this.lumina = true;
+  }
+  /** @internal */
+  static _initializePrototype() {
+    this._properties?.forEach(this._bindProp, this);
+    this._asyncMethods?.forEach(this._bindAsync, this);
+    this._syncMethods?.forEach(this._bindSync, this);
+  }
+  static _bindProp(propName) {
+    defineProperty(this.prototype, propName, {
+      configurable: true,
+      enumerable: true,
+      get() {
+        return this._store[propName];
+      },
+      set(value) {
+        this._store[propName] = value;
+        if (process.env.NODE_ENV !== "production") {
+          this._hmrSetProps.add(propName);
+        }
+      }
+    });
+  }
+  static _bindAsync(methodName) {
+    defineProperty(this.prototype, methodName, {
+      async value(...args) {
+        if (!this._litElement) {
+          await this._postLoaded.promise;
+        }
+        const genericLitElement = this._litElement;
+        return await genericLitElement[methodName](...args);
+      },
+      configurable: true
+    });
+  }
+  static _bindSync(methodName) {
+    defineProperty(this.prototype, methodName, {
+      value(...args) {
+        if (process.env.NODE_ENV === "development" && !this._litElement) {
+          const ProxyClass = this.constructor;
+          throw new Error(
+            `Tried to call method ${methodName}() on <${ProxyClass._name}> component before it's fully loaded. Please do 'await component.componentOnReady();' before calling this method.`
+          );
+        }
+        const genericLitElement = this._litElement;
+        return genericLitElement[methodName](...args);
+      },
+      configurable: true
+    });
+  }
+  get manager() {
+    return this._litElement?.manager;
+  }
+  /**
+   * Until the custom element is registered on the page, an instance of that
+   * element can be constructed and some properties on that instance set.
+   *
+   * These properties are set before the element prototype is set to this proxy
+   * class and thus none of our getters/setters are yet registered - such
+   * properties will be set by JavaScript on the instance directly.
+   *
+   * Once element is registered, the properties set in the meanwhile will shadow
+   * the getter/setters, and thus break reactivity. The fix is to delete these
+   * properties from the instance, and re-apply them once accessors are set.
+   *
+   * @example
+   * ```ts
+   * import { defineCustomElements } from '@arcgis/map-components';
+   * const map = document.createElement('arcgis-map');
+   * // This will shadow the getter/setters
+   * map.itemId = '...';
+   * // This finally defines the custom elements and sets the property accessors
+   * defineCustomElements();
+   * ```
+   *
+   * @remarks
+   * This is an equivalent of the __saveInstanceProperties method in Lit's
+   * ReactiveElement. Lit takes care of this on LitElement, but we have to take
+   * care of this on the lazy proxy
+   */
+  _saveInstanceProperties() {
+    const ProxyClass = this.constructor;
+    const genericThis = this;
+    ProxyClass._properties?.forEach((propName) => {
+      if (Object.hasOwn(this, propName)) {
+        this._store[propName] = genericThis[propName];
+        delete genericThis[propName];
+      }
+    });
+  }
+  /*
+   * This method must be statically present rather than added later, or else,
+   * browsers won't call it. Same for connected and disconnected callbacks.
+   */
+  attributeChangedCallback(name, oldValue, newValue) {
+    this._litElement?.attributeChangedCallback(name, oldValue, newValue);
+    if (!this._litElement) {
+      this._pendingAttributes.push(name);
+    }
+    if (process.env.NODE_ENV !== "production") {
+      this._hmrSetAttributes.add(name);
+    }
+  }
+  connectedCallback() {
+    if (this._litElement) {
+      this._litElement.connectedCallback?.();
+    } else {
+      queueMicrotask(() => {
+        this._ancestorLoad = attachToAncestor(this);
+      });
+    }
+  }
+  disconnectedCallback() {
+    this._litElement?.disconnectedCallback?.();
+  }
+  /**
+   * Create a promise that resolves once component is fully loaded
+   */
+  async componentOnReady() {
+    await this._postLoaded.promise;
+    return this;
+  }
+  /** @internal */
+  _initializeComponent(module) {
+    const ProxyClass = this.constructor;
+    const tagName = ProxyClass._name;
+    const store = this._store;
+    if (process.env.NODE_ENV !== "production") {
+      Object.entries(module).forEach(([name, LitConstructor2]) => {
+        if (name !== "exportsForTests" && typeof LitConstructor2 !== "function" || typeof LitConstructor2.tagName !== "string") {
+          console.warn(
+            `Found non-component export "${name}" in the file for the "${tagName}" component. This will interfere with hot module replacement. Please move "${name}" into a separate file.`
+          );
+        }
+      });
+    }
+    const LitConstructor = Object.values(module).find(
+      (LitConstructor2) => LitConstructor2.tagName === tagName
+    );
+    if (process.env.NODE_ENV !== "production" && !LitConstructor) {
+      throw new Error(
+        `Unable to find the LitElement class for the "${tagName}" custom element in the lazy-loaded module`
+      );
+    }
+    const lazyTagName = process.env.NODE_ENV === "production" ? `${tagName}--lazy` : (ProxyClass._hmrIndex ?? 0) === 0 ? `${tagName}--lazy` : `${tagName}--lazy-${ProxyClass._hmrIndex}`;
+    let parentClass = LitConstructor;
+    while (parentClass && !Object.hasOwn(parentClass, "lumina")) {
+      parentClass = Object.getPrototypeOf(parentClass);
+    }
+    const litElementPrototype = parentClass.prototype;
+    const elementPrototype = Element.prototype;
+    const alreadyPatched = Object.hasOwn(litElementPrototype, "isConnected");
+    if (!alreadyPatched) {
+      litElementPrototype.setAttribute = function(qualifiedName, value) {
+        elementPrototype.setAttribute.call(this.el, qualifiedName, value);
+      };
+      litElementPrototype.removeAttribute = function(qualifiedName) {
+        elementPrototype.removeAttribute.call(this.el, qualifiedName);
+      };
+      defineProperty(litElementPrototype, "isConnected", {
+        get() {
+          return Reflect.get(elementPrototype, "isConnected", this.el);
+        }
+      });
+    }
+    if (process.env.NODE_ENV !== "production") {
+      devOnlyDetectIncorrectLazyUsages(parentClass);
+    }
+    const isFirstInitialization = !ProxyClass._LitConstructor;
+    if (isFirstInitialization) {
+      ProxyClass._LitConstructor = LitConstructor;
+      customElements.define(lazyTagName, LitConstructor);
+    }
+    LitConstructor.lazy = this;
+    const litElement = document.createElement(lazyTagName);
+    LitConstructor.lazy = void 0;
+    if (process.env.NODE_ENV !== "production") {
+      Object.defineProperty(this, "_litElement", {
+        value: litElement,
+        configurable: true,
+        enumerable: false
+      });
+    } else {
+      this._litElement = litElement;
+    }
+    this._store = litElement;
+    this._pendingAttributes.forEach((name) => {
+      const value = this.getAttribute(name);
+      litElement.attributeChangedCallback(
+        name,
+        // Lit doesn't look at this value, thus even if attribute already exists, that's ok
+        null,
+        value
+      );
+    });
+    Object.entries(store).forEach(syncLitElement, litElement);
+    if (process.env.NODE_ENV !== "production") {
+      const litObserved = LitConstructor.observedAttributes ?? [];
+      const lazyObserved = ProxyClass.observedAttributes ?? [];
+      const missingFromLazy = litObserved.filter((attribute) => !lazyObserved.includes(attribute));
+      const missingFromLit = lazyObserved.filter((attribute) => !litObserved.includes(attribute));
+      if (missingFromLazy.length > 0) {
+        console.warn(
+          `The following attributes on <${ProxyClass._name}> are present on the Lit element, but are missing from the lazy proxy component: ${missingFromLazy.join(", ")}. This either indicates a bug in Lumina, or you are creating the attribute dynamically in a way that compiler cannot infer statically. For these attributes, lazy-loading version of your component won't work correctly, thus this must be resolved`
+        );
+      }
+      if (missingFromLit.length > 0) {
+        console.warn(
+          `The following attributes on <${ProxyClass._name}> are defined on the lazy proxy component, but not on the actual Lit element: ${missingFromLit.join(", ")}. This either indicates a bug in Lumina, or you are creating the attribute dynamically in a way that compiler cannot infer statically. This is a non-critical issue, but does indicate that something is going wrong and should be fixed`
+        );
+      }
+    }
+    const isStillConnected = this.isConnected;
+    if (isStillConnected || this._ancestorLoad) {
+      litElement.connectedCallback?.();
+      if (!isStillConnected) {
+        litElement.disconnectedCallback();
+      }
+    }
+  }
+  /**
+   * Implemented on the proxy for compatibility with Lit Context.
+   */
+  addController() {
+  }
+  /**
+   * Implemented on the proxy for compatibility with Lit Context.
+   */
+  requestUpdate() {
+    this._litElement?.requestUpdate();
+  }
+};
+function syncLitElement([key, value]) {
+  this[key] = value;
+}
+
+// src/utils.ts
+var noShadowRoot = {};
+
+export {
+  attachToAncestor,
+  makeDefineCustomElements,
+  ProxyComponent,
+  noShadowRoot
+};

package/dist/hmrSupport.d.ts

@@ -5,8 +5,11 @@ import type { ModuleNamespace } from "vite/types/hot.js";
  * @remarks
  * You should not need to call this function directly - it will be inserted
  * automatically when running in serve mode.
+ *
+ * @private
  */
 export declare function handleHmrUpdate(newModules: (ModuleNamespace | undefined)[]): void;
+/** @private */
 export type HmrComponentMeta = {
     readonly tagName: string;
     /**
@@ -25,5 +28,7 @@ export type HmrComponentMeta = {
  * @remarks
  * You should not need to call this function directly - it will be inserted
  * automatically when running in serve mode.
+ *
+ * @private
  */
 export declare function handleComponentMetaUpdate(meta: HmrComponentMeta): void;

package/dist/hmrSupport.js

@@ -0,0 +1,121 @@
+import {
+  ProxyComponent,
+  noShadowRoot
+} from "./chunk-PEVP6JYY.js";
+import "./chunk-PGHUBTOM.js";
+
+// src/hmrSupport.ts
+import { camelToKebab } from "@arcgis/components-utils";
+function handleHmrUpdate(newModules) {
+  newModules.forEach((newModule) => {
+    if (newModule === void 0) {
+      return;
+    }
+    Object.values(newModule).forEach((exported) => {
+      if (typeof exported !== "function" || typeof exported.tagName !== "string") {
+        return;
+      }
+      const LitConstructor = exported;
+      const ProxyClass = customElements.get(LitConstructor.tagName);
+      if (ProxyClass === void 0) {
+        throw new Error(`Failed to find custom element proxy for tag name: ${LitConstructor.tagName}`);
+      }
+      ProxyClass._LitConstructor = void 0;
+      ProxyClass._loadPromise = void 0;
+      ProxyClass._hmrIndex ??= 0;
+      ProxyClass._hmrIndex += 1;
+      ProxyClass._initializePrototype();
+      ProxyClass._hmrInstances?.forEach((instanceWeakRef) => {
+        const instance = instanceWeakRef.deref();
+        if (instance === void 0) {
+          return;
+        }
+        if (instance._litElement === void 0) {
+          void ProxyClass._loadPromise.then(() => reInitialize(instance, newModule));
+        } else {
+          reInitialize(instance, newModule);
+        }
+      });
+      return;
+    });
+  });
+}
+function reInitialize(instance, newModule) {
+  const PreviousLitConstructor = instance._litElement.constructor;
+  const isShadowRoot = PreviousLitConstructor.shadowRootOptions !== noShadowRoot;
+  if (!isShadowRoot) {
+    const root = instance.getRootNode() ?? document;
+    if ("adoptedStyleSheets" in root) {
+      const rootStyles = Array.from(root.adoptedStyleSheets);
+      PreviousLitConstructor.elementStyles.forEach((style) => {
+        const styleSheet = "styleSheet" in style ? style.styleSheet : style;
+        const index = rootStyles.lastIndexOf(styleSheet);
+        if (index > -1) {
+          rootStyles.splice(index, 1);
+        }
+      });
+      root.adoptedStyleSheets = rootStyles;
+    }
+  }
+  const properties = PreviousLitConstructor.elementProperties;
+  const preservedProperties = Array.from(properties.entries()).filter(
+    ([propertyName, descriptor]) => typeof propertyName === "string" && (instance._hmrSetProps.has(propertyName) || typeof descriptor.attribute === "string" && instance._hmrSetAttributes.has(descriptor.attribute))
+  ).map(([key]) => [key, instance[key]]);
+  instance._store = Object.fromEntries(preservedProperties);
+  const isConnected = instance.isConnected;
+  if (isConnected) {
+    instance._litElement.disconnectedCallback();
+  }
+  instance._initializeComponent(newModule);
+}
+function handleComponentMetaUpdate(meta) {
+  const ProxyClass = customElements.get(meta.tagName);
+  if (ProxyClass === void 0) {
+    return;
+  }
+  const attributes = meta.properties.map(([property, attribute]) => attribute ?? camelToKebab(property)).filter(Boolean);
+  const observedAttributes = initializeAttributeObserver();
+  observedAttributes[meta.tagName] ??= {};
+  observedAttributes[meta.tagName].original ??= new Set(ProxyClass.observedAttributes);
+  const originallyObserved = observedAttributes[meta.tagName].original;
+  observedAttributes[meta.tagName].manuallyObserved = new Set(
+    /**
+     * Never manually observe attributes that were in the original
+     * observedAttributes as those would be observed by the browser
+     */
+    attributes.filter((attribute) => !originallyObserved.has(attribute))
+  );
+  ProxyClass._asyncMethods = meta.asyncMethods;
+  ProxyClass._syncMethods = meta.syncMethods;
+  ProxyClass._properties = meta.properties.map(([name]) => name);
+  ProxyClass.observedAttributes = attributes;
+}
+function initializeAttributeObserver() {
+  const observedAttributesSymbol = Symbol.for("@arcgis/lumina:observedAttributes");
+  const globalThisWithObservedAttributes = globalThis;
+  const alreadyHadObservers = observedAttributesSymbol in globalThisWithObservedAttributes;
+  globalThisWithObservedAttributes[observedAttributesSymbol] ??= {};
+  const observedAttributes = globalThisWithObservedAttributes[observedAttributesSymbol];
+  if (!alreadyHadObservers) {
+    const makeObserver = (original) => function observeAttributes(qualifiedName, ...rest) {
+      const observed = observedAttributes[this.tagName.toLowerCase()]?.manuallyObserved;
+      if (observed?.has(qualifiedName)) {
+        const oldValue = this.getAttribute(qualifiedName);
+        const returns = original.call(this, qualifiedName, ...rest);
+        const newValue = this.getAttribute(qualifiedName);
+        this.attributeChangedCallback(qualifiedName, oldValue, newValue);
+        return returns;
+      } else {
+        return original.call(this, qualifiedName, ...rest);
+      }
+    };
+    ProxyComponent.prototype.setAttribute = makeObserver(ProxyComponent.prototype.setAttribute);
+    ProxyComponent.prototype.toggleAttribute = makeObserver(ProxyComponent.prototype.toggleAttribute);
+    ProxyComponent.prototype.removeAttribute = makeObserver(ProxyComponent.prototype.removeAttribute);
+  }
+  return observedAttributes;
+}
+export {
+  handleComponentMetaUpdate,
+  handleHmrUpdate
+};

package/dist/index.d.ts

@@ -2,8 +2,6 @@ export { useContextProvider, useContextConsumer } from "./context";
 export type { EventOptions } from "./createEvent";
 export { createEvent } from "./createEvent";
 export { state, property, method } from "./decorators";
-export type { HmrComponentMeta } from "./hmrSupport";
-export { handleComponentMetaUpdate, handleHmrUpdate } from "./hmrSupport";
 export type { DefineCustomElements, LazyLoadOptions, GlobalThisWithPuppeteerEnv } from "./lazyLoad";
 export { makeDefineCustomElements } from "./lazyLoad";
 export { LitElement } from "./LitElement";