@wippy-fe/types-global-proxy 0.0.13 → 0.0.15

package/index.d.ts

@@ -419,12 +419,16 @@ type Events = {
 };
 declare function createEvents(): <T extends string>(topicPattern: T, callback: T extends KnownTopics ? Events[T] : Events["@message"]) => nanoevents.Unsubscribe;
 
+interface StateApiOptions {
+    /** Override the default page-level scope. Used by web components with persist-key or nested artifacts. */
+    scope?: string;
+}
 interface StateApi {
-    get<T = unknown>(key: string): Promise<T | null>;
-    set(key: string, value: unknown): Promise<void>;
-    remove(key: string): Promise<void>;
-    clear(): Promise<void>;
-    getAll(): Promise<Record<string, unknown>>;
+    get: <T = unknown>(key: string, options?: StateApiOptions) => Promise<T | null>;
+    set: (key: string, value: unknown, options?: StateApiOptions) => Promise<void>;
+    remove: (key: string, options?: StateApiOptions) => Promise<void>;
+    clear: (options?: StateApiOptions) => Promise<void>;
+    getAll: (options?: StateApiOptions) => Promise<Record<string, unknown>>;
 }
 
 var session = {
@@ -841,9 +845,11 @@ declare global {
             config: () => Promise<AppConfig>;
             instance: () => Promise<ProxyApiInstance>;
             api: () => Promise<ProxyApiInstance['api']>;
-            form: () => Promise<ProxyApiInstance['form']>;
+            /** @deprecated Use `$W.api` instead */
+            form: () => Promise<ProxyApiInstance['api']>;
             host: () => Promise<ProxyApiInstance['host']>;
-            iframe: () => Promise<ProxyApiInstance['iframe']>;
+            /** @deprecated Use `$W.host` instead */
+            iframe: () => Promise<ProxyApiInstance['host']>;
             on: () => Promise<ProxyApiInstance['on']>;
             state: () => Promise<ProxyApiInstance['state']>;
             loadWebComponent: () => Promise<ProxyApiInstance['loadWebComponent']>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wippy-fe/types-global-proxy",
-  "version": "0.0.13",
+  "version": "0.0.15",
   "description": "Global type declarations for Wippy iframe proxy (window.getWippyApi, $W, etc.)",
   "types": "index.d.ts"
 }