@arcgis/lumina-toolkit 5.2.0-next.129 → 5.2.0-next.130

package/dist/reEmitEvent.d.ts

@@ -1,3 +1,14 @@
-import type { reEmitEvent as reEmitEventAliased } from "@arcgis/lumina/controllers/accessor";
+import type { Evented } from "@arcgis/core/core/Evented.js";
+import type { EventEmitter } from "@arcgis/lumina";
 
-export const reEmitEvent: typeof reEmitEventAliased;
+/**
+ * Re-emit an event from the accessor instance on the component
+ *
+ * @param getEventedAccessor
+ * @param eventName
+ * @example
+ * ```tsx
+ * arcgisGo = reEmitEvent<HomeViewModelGoEvent>(() => this.viewModel, "go");
+ * ```
+ */
+export function reEmitEvent<T>(getEventedAccessor: () => Evented, eventName: string): EventEmitter<T>;

package/dist/store.d.ts

@@ -1,7 +1,16 @@
-import type { createLegacyStore as createLegacyStoreAliased, createStore as createStoreAliased, ObservableMap as ObservableMapAliased } from "@arcgis/lumina/controllers/accessor";
+import type Accessor from "@arcgis/core/core/Accessor.js";
+import type { ObservableMap as ObservableMapAliased } from "@arcgis/lumina/controllers/accessor";
 
-export const createStore: typeof createStoreAliased;
+/**
+ * @param initializer
+ * @see https://webgis.esri.com/references/lumina/state-management#createstore
+ */
+export function createStore<T extends object>(initializer: T | (() => T)): Accessor & T;
 
-export const createLegacyStore: typeof createLegacyStoreAliased;
+/**
+ * @deprecated Use createStore instead.
+ * @param defaultState
+ */
+export function createLegacyStore<T extends object>(defaultState: T | (() => T)): ObservableMap<T>;
 
 export type ObservableMap<T> = ObservableMapAliased<T>;

package/dist/useAccessor.d.ts

@@ -1,16 +1,22 @@
 import type coreAccessor from "@arcgis/core/core/Accessor.js";
 import type { LitElement } from "@arcgis/lumina";
-import type { AccessorController as AccessorControllerAliased, getAccessorControllerBoundProperties as getAccessorControllerBoundPropertiesAliased, makeAccessorController as makeAccessorControllerAliased, makeBinderProxy as makeBinderProxyAliased, AccessorControllerRequires as AccessorControllerRequiresAliased } from "@arcgis/lumina/controllers/accessor";
+import type { AccessorController as AccessorControllerAliased, makeAccessorController as makeAccessorControllerAliased, makeBinderProxy as makeBinderProxyAliased, AccessorControllerRequires as AccessorControllerRequiresAliased } from "@arcgis/lumina/controllers/accessor";
 
 /**
+ * Given an Accessor class, create a controller that will do two-way binding of
+ * props between the component and the Accessor.
+ *
+ * See https://webgis.esri.com/references/lumina/controllers/useAccessor for
+ * documentation & examples.
+ *
  * @param createInstance
  * @param options
  */
-export function makeAccessorController<Props, Accessor extends InstanceType<typeof AccessorControllerAliased>["exports"], OmitProps extends string = never>(createInstance: ((props?: Props) => Accessor) | (new (props?: Props) => Accessor), options?: Parameters<typeof makeAccessorControllerAliased<Props, Accessor, OmitProps>>[1]): (component: AccessorControllerRequires<Props, Accessor, OmitProps>) => Accessor;
+export function makeAccessorController<Props, Accessor extends coreAccessor, OmitProps extends string = never>(createInstance: ((props?: Props) => Accessor) | (new (props?: Props) => Accessor), options?: Parameters<typeof makeAccessorControllerAliased<Props, Accessor, OmitProps>>[1]): (component: AccessorControllerRequires<Props, Accessor, OmitProps>) => Accessor;
 
 export const AccessorController: typeof AccessorControllerAliased;
 
-export type AccessorController<Props, Accessor extends InstanceType<typeof AccessorControllerAliased>["exports"], ExtraRequires = Record<never, never>> = AccessorControllerAliased<Props, Accessor, ExtraRequires>;
+export type AccessorController<Props, Accessor extends coreAccessor, ExtraRequires = Record<never, never>> = AccessorControllerAliased<Props, Accessor, ExtraRequires>;
 
 /**
  * @param instance
@@ -18,8 +24,16 @@ export type AccessorController<Props, Accessor extends InstanceType<typeof Acces
  */
 export function reCreateAccessor(instance: coreAccessor, component: LitElement): void;
 
-export const makeBinderProxy: typeof makeBinderProxyAliased;
+/**
+ * @param component
+ * @param accessorControllerRef
+ * @param accessorControllerIndex
+ * @param instance
+ * @param boundProperties
+ */
+export function makeBinderProxy(component: LitElement, accessorControllerRef: Parameters<typeof makeBinderProxyAliased>[1], accessorControllerIndex: number, instance: coreAccessor, boundProperties: Map<string, string>): unknown;
 
-export const getAccessorControllerBoundProperties: typeof getAccessorControllerBoundPropertiesAliased;
+/** @param controller */
+export function getAccessorControllerBoundProperties<Accessor extends coreAccessor>(controller: AccessorController<unknown, Accessor>): Map<string & keyof Accessor, string>;
 
-export type AccessorControllerRequires<Props, Accessor extends InstanceType<typeof AccessorControllerAliased>["exports"], OmitProps extends string = never> = AccessorControllerRequiresAliased<Props, Accessor, OmitProps>;
+export type AccessorControllerRequires<Props, Accessor extends coreAccessor, OmitProps extends string = never> = AccessorControllerRequiresAliased<Props, Accessor, OmitProps>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arcgis/lumina-toolkit",
-  "version": "5.2.0-next.129",
+  "version": "5.2.0-next.130",
   "description": "Higher level utilities on top of @arcgis/lumina",
   "sideEffects": false,
   "type": "module",
@@ -18,7 +18,7 @@
     "tslib": "^2.8.1"
   },
   "peerDependencies": {
-    "@arcgis/core": "5.2.0-next.129",
-    "@arcgis/lumina": "5.2.0-next.129"
+    "@arcgis/core": "5.2.0-next.130",
+    "@arcgis/lumina": "5.2.0-next.130"
   }
 }