@trackunit/react-core-contexts-api 1.4.77 → 1.4.79

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/react-core-contexts-api",
-  "version": "1.4.77",
+  "version": "1.4.79",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "engines": {
@@ -8,8 +8,8 @@
   },
   "dependencies": {
     "jest-fetch-mock": "^3.0.3",
-    "@trackunit/shared-utils": "1.5.75",
-    "@trackunit/geo-json-utils": "1.3.76"
+    "@trackunit/shared-utils": "1.5.76",
+    "@trackunit/geo-json-utils": "1.3.77"
   },
   "module": "./index.esm.js",
   "main": "./index.cjs.js",

package/src/index.d.ts

@@ -13,3 +13,4 @@ export * from "./timeRangeContext";
 export * from "./toastContext";
 export * from "./tokenContext";
 export * from "./userSubscriptionContext";
+export * from "./widgetConfigContext";

package/src/widgetConfigContext.d.ts

@@ -0,0 +1,37 @@
+export interface WidgetConfigContext {
+    /**
+     * Gets the title of the widget.
+     *
+     * @returns the title of the widget
+     */
+    getTitle: () => Promise<string>;
+    /**
+     * Sets the title of the widget.
+     *
+     * @param title - The title to set.
+     */
+    setTitle: (title: string) => Promise<void>;
+    /**
+     * Gets the data of the widget.
+     *
+     * @returns the data of the widget
+     */
+    getData: () => Promise<Record<string, unknown>>;
+    /**
+     * Gets the data version of the widget.
+     * Dataversion is used to make it easy for you to see what dataVersion is saved in the widget.
+     * Use it to upgrade the widget data to a new version when loading the widget.
+     *
+     * @returns the data version of the widget
+     */
+    getDataVersion: () => Promise<number>;
+    /**
+     * Sets the data of the widget.
+     * Dataversion is used to make it easy for you to see what dataVersion is saved in the widget.
+     * Use it to upgrade the widget data to a new version when loading the widget.
+     *
+     * @param data - The data to set.
+     * @param dataVersion - The data version to set.
+     */
+    setData: (data: Record<string, unknown>, dataVersion: number) => Promise<void>;
+}