@sisense/sdk-ui-preact 1.34.0 → 2.0.0

package/dist/packages/sdk-ui-preact/src/component-adapter/hook-adapter.d.ts

@@ -5,11 +5,11 @@ export declare class HookAdapter<Hook extends AnyHookFunction> {
     private hook;
     private rootElement;
     private componentAdapter;
-    private resultSubscribeFn;
+    private resultObserver;
     private params;
     constructor(hook: Hook, contextConnectors?: ContextConnector<ContextData>[]);
     private handleHookResult;
     run(...params: Parameters<Hook>): void;
-    subscribe(hookResultSubscribeFn: (result: ReturnType<Hook>) => void): void;
+    subscribe(listener: (result: ReturnType<Hook>) => void): import("./utils").Subscription;
     destroy(): void;
 }

package/dist/packages/sdk-ui-preact/src/component-adapter/index.d.ts

@@ -3,4 +3,4 @@ export * from './context-connector';
 export * from './custom-element';
 export * from './hook-adapter';
 export type { AnyComponentFunction } from './types';
-export { DataObserver } from './utils/data-observer';
+export { createHookApiFacade, DataObserver } from './utils';

package/dist/packages/sdk-ui-preact/src/component-adapter/utils/create-hook-api-facade.d.ts

@@ -0,0 +1,31 @@
+import type { HookAdapter } from '../hook-adapter';
+import { AnyHookFunction } from '../types';
+/**
+ * Extracts the keys of an object `T` whose values are functions.
+ */
+type FunctionKeys<T> = {
+    [K in keyof T]: T[K] extends (...args: any[]) => any ? K : never;
+}[keyof T];
+/**
+ * Extracts the names of all functions returned by a given hook.
+ *
+ * @typeParam Hook - A function that returns an object.
+ */
+type HookApiName<Hook extends AnyHookFunction> = FunctionKeys<ReturnType<Hook>>;
+/**
+ * Extracts the parameter types of a specific function (by name) returned from a given hook.
+ *
+ * @typeParam Hook - A hook function that returns an object.
+ * @typeParam Name - The key of the API method within the returned object.
+ */
+type HookApiParameters<Hook extends AnyHookFunction, Name extends HookApiName<Hook> = HookApiName<Hook>> = Parameters<ReturnType<Hook>[Name]>;
+/**
+ * Extracts the return type of a specific function (by name) returned from a given hook.
+ *
+ * @typeParam Hook - A hook function that returns an object.
+ * @typeParam Name - The key of the API method within the returned object.
+ */
+type HookApiReturnType<Hook extends AnyHookFunction, Name extends HookApiName<Hook> = HookApiName<Hook>> = ReturnType<ReturnType<Hook>[Name]>;
+export declare function createHookApiFacade<Hook extends AnyHookFunction, Name extends HookApiName<Hook>>(hookAdapter: HookAdapter<Hook>, apiName: Name, shouldReturnHookApiResult: true): (...args: HookApiParameters<Hook, Name>) => Promise<HookApiReturnType<Hook, Name>>;
+export declare function createHookApiFacade<Hook extends AnyHookFunction, Name extends HookApiName<Hook>>(hookAdapter: HookAdapter<Hook>, apiName: Name, shouldReturnHookApiResult?: false): (...args: HookApiParameters<Hook, Name>) => void;
+export {};

package/dist/packages/sdk-ui-preact/src/component-adapter/utils/index.d.ts

@@ -1,2 +1,3 @@
+export * from './create-hook-api-facade';
 export * from './data-observer';
 export * from './observable';