0.0.23

Author: forman

chartlets.js/CHANGES.md

@@ -1,4 +1,7 @@
-## Version 0.0.23 (in development)
+## Version 0.0.23 (from 2024/11/19)
+
+* Introduced new interface `HostState` that applications may implement
+  to provide computed properties, i.e., a derived state. (#43)
 
 * Replacing entire components if a related component `StateChange` 
   has an empty `property`. (#38)

chartlets.js/package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "chartlets",
-  "version": "0.0.22",
+  "version": "0.0.23",
   "description": "An experimental library for integrating interactive charts into existing JavaScript applications.",
   "type": "module",
   "files": [

chartlets.js/package.json

@@ -11,8 +11,11 @@ import { getValue, setValue } from "@/lib/utils/objPath";
 
 initializeContributions({
   hostStore: {
+    // Let Chartlets listen to changes in application state.
     subscribe: (listener: () => void) => appStore.subscribe(listener),
+    // Compute a property value and return it. We simply use getValue() here.
     get: (property: string): unknown => getValue(appStore.getState(), property),
+    // Set a property value in the application state.
     set: (property: string, value: unknown) =>
       void appStore.setState(setValue(appStore.getState(), property, value)),
   },

chartlets.js/src/demo/App.tsx

@@ -1,9 +1,36 @@
 import type { ApiOptions } from "@/lib/types/api";
 import type { LoggingOptions } from "@/lib/actions/helpers/configureLogging";
 
+/**
+ * The host store represents an interface to the state of
+ * the application that is using Chartlets.
+ */
 export interface HostStore {
+  /**
+   * Let Chartlets listen to changes in the host store that may
+   * cause different values to be returned from the `get()` method.
+   *
+   * @param listener A listener that is called when the
+   *  host store changes
+   */
   subscribe: (listener: () => void) => void;
+
+  /**
+   * Get a property value from the host state.
+   *
+   * @param property The property name.
+   * @returns The property value.
+   */
   get: (property: string) => unknown;
+
+  /**
+   * **UNSTABLE API**
+   *
+   * Set a property value in the host state.
+   *
+   * @param property The property name.
+   * @param value The new property value.
+   */
   set?: (property: string, value: unknown) => void;
 }
 
@@ -17,8 +44,12 @@ export function isMutableHostStore(
   return !!hostStore && typeof hostStore.set === "function";
 }
 
+/**
+ * Chartlets options to be provided
+ * by the application that is using Chartlets.
+ */
 export interface FrameworkOptions {
-  /** The host application's store. */
+  /** The host store. */
   hostStore?: HostStore;
   /** API options to configure backend. */
   api?: ApiOptions;