@arcgis/lumina 5.2.0-next.10 → 5.2.0-next.11

package/dist/{ControllerManager-DpJfvft9.js → ControllerManager-4cSEnB5Y.js}

@@ -1,9 +1,13 @@
 import { safeCall, isEsriInternalEnv } from "@arcgis/toolkit/error";
-import { G as GenericController, p as propertyTrackResolve } from "./Controller-Cer_6Z29.js";
+import { G as GenericController, p as propertyTrackResolve } from "./GenericController-C8NSb50b.js";
 import { nothing, LitElement as LitElement$1 } from "lit";
 import { devToolsAwareTimeout } from "@arcgis/toolkit/promise";
 import { a as setAmbientComponent } from "./ControllerInternals-CeDntN3G.js";
 class ControllerManager extends GenericController {
+  /**
+   * @public
+   * @param component
+   */
   constructor(component) {
     super(component);
     this.destroyed = false;
@@ -79,8 +83,13 @@ class ControllerManager extends GenericController {
   }
   #autoDestroyTimeout;
   #component;
-  // Keep this method async needlessly for now to avoid a breaking change if we
-  // would need to make it async in the future
+  /**
+   * @public
+   * @privateRemarks
+   * Keeping this method async needlessly for now to avoid a breaking change if
+   * we would need to make it async in the future.
+   * Related: https://devtopia.esri.com/WebGIS/arcgis-web-components/pull/15301#issuecomment-6321306
+   */
   // eslint-disable-next-line @typescript-eslint/require-await
   async destroy() {
     if (this.destroyed) {
@@ -104,7 +113,6 @@ class ControllerManager extends GenericController {
     }
     this.#component.M.splice(0);
   }
-  /** @private */
   U() {
     if (this.#autoDestroyTimeout !== void 0) {
       clearTimeout(this.#autoDestroyTimeout);
@@ -118,7 +126,6 @@ class ControllerManager extends GenericController {
       }
     }
   }
-  /** @private */
   S(key, value) {
     const trackers = this.T;
     this.V = nothing;
@@ -129,15 +136,12 @@ class ControllerManager extends GenericController {
   /**
    * Associate an exports object with a controller for reverse lookup in
    * controller.use
-   *
-   * @private
    */
   W(controller, exports$1) {
     if (typeof exports$1 === "object" && exports$1 !== null || typeof exports$1 === "function") {
       this.#exportsStore.set(exports$1, controller);
     }
   }
-  /** @private */
   X(exports$1) {
     if (typeof exports$1 === "object" && exports$1 !== null || typeof exports$1 === "function") {
       return this.#exportsStore.get(exports$1);

package/dist/{Controller-Cer_6Z29.js → GenericController-C8NSb50b.js}

@@ -128,6 +128,10 @@ const createEvent = createEventFactory.bind(null, "");
 var _a;
 _a = controllerSymbol;
 class Controller {
+  /**
+   * @public
+   * @param component
+   */
   constructor(component) {
     this.#hostConnected = [];
     this.#hostDisconnected = [];
@@ -203,14 +207,16 @@ class Controller {
     ).catch(rethrowError(this.#component));
   }
   #exports;
+  /**
+   * Setting .exports set controller's exports property for usage with
+   * proxyExports() and marks the controller as ready for usage in other
+   * controllers. Also, this triggers re-render of the component.
+   *
+   * @public
+   */
   get exports() {
     return this.#exports;
   }
-  /**
-   * Set controller's exports property (for usage with proxyExports()) and mark
-   * controller as ready (for usage in other controllers). Also, triggers
-   * re-render of the component
-   */
   set exports(exports$1) {
     const oldExports = this.#exports;
     if (oldExports !== exports$1) {
@@ -227,6 +233,10 @@ class Controller {
     this.#exportWatchers.forEach(safeCall);
   }
   #exportWatchers;
+  /**
+   * @public
+   * @param callback
+   */
   watchExports(callback) {
     const safeCallback = () => callback(this.#exports);
     this.#exportWatchers.push(safeCallback);
@@ -236,6 +246,13 @@ class Controller {
    * A flexible utility for making sure a controller is loaded before it's used,
    * regardless of how or where a controller was defined:
    *
+   * If your controller is not async, and you are not creating it inside async
+   * function, then you are not required to use controller.use - you can create
+   * controller directly. Similarly, accessing controllers after
+   * componentWillLoad callback does not require awaiting them as they are
+   * guaranteed to be loaded by then.
+   *
+   * @public
    * @example
    * makeGenericController(async (component, controller) => {
    *   // Await some controller from the component:
@@ -245,12 +262,6 @@ class Controller {
    *   await controller.use(new ViewModelController(component,newWidgetsHomeHomeViewModel));
    *   await controller.use(someController(component));
    * });
-   *
-   * @remarks
-   * If your controller is not async, and you are not creating it async, then
-   * you are not required to use controller.use - you can use it directly.
-   * Similarly, accessing controllers after componentWillLoad callback does not
-   * require awaiting them as they are guaranteed to be loaded by then.
    */
   get use() {
     setAmbientComponent(this.#component);
@@ -268,6 +279,8 @@ class Controller {
    * - You have a controller exports only, and you want to retrieve the
    *   controller itself. This is useful if you wish to call .watchExports() or
    *   some other method on the controller
+   *
+   * @public
    */
   get useRef() {
     setAmbientComponent(this.#component);
@@ -275,44 +288,75 @@ class Controller {
   }
   /**
    * Like useRef, but doesn't wait for the controller to get ready
-   *
-   * @private
    */
   get useRefSync() {
     setAmbientComponent(this.#component);
     return useRefSync;
   }
+  /** @internal */
   controllerRemoved() {
     if (this.#component.el.isConnected) {
       this.triggerDisconnected();
     }
     this.triggerDestroy();
   }
-  // Register a lifecycle callback
+  /**
+   * Register a connected lifecycle callback
+   * @public
+   * @param callback
+   */
   onConnected(callback) {
     this.#hostConnected.push(callback);
   }
+  /**
+   * @public
+   * @param callback
+   */
   onDisconnected(callback) {
     this.#hostDisconnected.push(callback);
   }
+  /**
+   * @public
+   * @param callback
+   */
   onLoad(callback) {
     this.#hostLoad.push(callback);
   }
+  /**
+   * @public
+   * @param callback
+   */
   onLoaded(callback) {
     this.#hostLoaded.push(callback);
   }
+  /**
+   * @public
+   * @param callback
+   */
   onUpdate(callback) {
     this.#hostUpdate.push(callback);
   }
+  /**
+   * @public
+   * @param callback
+   */
   onUpdated(callback) {
     this.#hostUpdated.push(callback);
   }
+  /**
+   * @public
+   * @param callback
+   */
   onDestroy(callback) {
     if (process.env.NODE_ENV !== "production" && isEsriInternalEnv()) {
       this.#component.manager.devOnly$ensureHasDestroy?.();
     }
     this.#hostDestroy.push(callback);
   }
+  /**
+   * @public
+   * @param callback
+   */
   onLifecycle(callback) {
     this.#hostLifecycle.push(callback);
     if (this.connectedCalled && this.#component.el.isConnected) {
@@ -320,7 +364,6 @@ class Controller {
     }
   }
   // Call each lifecycle hook
-  /** @private */
   triggerConnected() {
     const that = this;
     if (that.hostConnected) {
@@ -330,7 +373,6 @@ class Controller {
     that.triggerLifecycle();
     that.connectedCalled = true;
   }
-  /** @private */
   triggerDisconnected() {
     const that = this;
     if (that.hostDisconnected) {
@@ -340,7 +382,6 @@ class Controller {
     that.#lifecycleCleanups.forEach(safeCall);
     that.#lifecycleCleanups = [];
   }
-  /** @private */
   async triggerLoad() {
     if (this.#loadCalled) {
       return;
@@ -355,7 +396,6 @@ class Controller {
     }
     this.P.resolve(this.#exports);
   }
-  /** @private */
   triggerLoaded() {
     if (this.loadedCalled) {
       return;
@@ -366,28 +406,24 @@ class Controller {
     this.#hostLoaded.forEach(safeCall);
     this.loadedCalled = true;
   }
-  /** @private */
   triggerUpdate(changes) {
     if (this.hostUpdate) {
       safeCall(this.hostUpdate, this, changes);
     }
     this.#hostUpdate.forEach(callUpdate, changes);
   }
-  /** @private */
   triggerUpdated(changes) {
     if (this.hostUpdated) {
       safeCall(this.hostUpdated, this, changes);
     }
     this.#hostUpdated.forEach(callUpdate, changes);
   }
-  /** @private */
   triggerDestroy() {
     if (this.hostDestroy) {
       safeCall(this.hostDestroy, this);
     }
     this.#hostDestroy.forEach(safeCall);
   }
-  /** @private */
   triggerLifecycle() {
     if (this.hostLifecycle) {
       this.#callLifecycle(() => this.hostLifecycle());
@@ -410,7 +446,6 @@ class Controller {
 function callUpdate(callback) {
   safeCall(callback, void 0, this);
 }
-const GenericController = Controller;
 const makeProvisionalValue = (base) => {
   if (typeof base !== "object" && typeof base !== "function" || base === null) {
     return base;
@@ -450,6 +485,7 @@ const accessBeforeLoad = process.env.NODE_ENV !== "production" && isEsriInternal
   "usage:\n",
   "makeController(async (component, controller)=>{ await controller.use(someOtherController); });"
 ].join("") : void 0;
+const GenericController = Controller;
 export {
   Controller as C,
   GenericController as G,