@sisense/sdk-ui-preact 2.20.0 → 2.21.0

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

@@ -0,0 +1,59 @@
+/**
+ * Interface for an adapter that manages an external component's lifecycle.
+ * This is used to bridge components from external frameworks (e.g., Angular, Vue)
+ * into the Preact rendering context.
+ *
+ * @internal
+ */
+export interface ExternalComponentAdapter<Props> {
+    /**
+     * Mounts the external component into the container element.
+     * Called once when the wrapper component mounts.
+     */
+    mount(container: HTMLElement, props: Props): void;
+    /**
+     * Updates props on the existing external component.
+     * Called whenever props change after initial mount.
+     */
+    update(props: Props): void;
+    /**
+     * Destroys the external component and cleans up resources.
+     * Called when the wrapper component unmounts.
+     */
+    destroy(): void;
+    /**
+     * Returns whether the adapter has an active component instance.
+     */
+    isActive(): boolean;
+}
+/**
+ * Factory function type that creates an adapter instance.
+ * The factory is called once per component mount.
+ *
+ * @internal
+ */
+export type AdapterFactory<Props> = () => ExternalComponentAdapter<Props>;
+/**
+ * Props for the ExternalComponentAdapterElement component.
+ *
+ * @internal
+ */
+export interface ExternalComponentAdapterElementProps<Props> {
+    /** Factory function to create the adapter */
+    adapterFactory: AdapterFactory<Props>;
+    /** Props to pass to the wrapped component */
+    componentProps: Props;
+}
+/**
+ * A Preact component that wraps an external framework component using an adapter pattern.
+ * This component:
+ * - Creates the adapter once on mount using the factory
+ * - Calls update() on the adapter when props change
+ * - Calls destroy() when unmounting
+ *
+ * This allows external framework components to be efficiently updated in-place
+ * rather than being destroyed and recreated on every prop change.
+ *
+ * @internal
+ */
+export declare const ExternalComponentAdapterElement: <Props>({ adapterFactory, componentProps, }: ExternalComponentAdapterElementProps<Props>) => import("preact").JSX.Element;

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

@@ -1,6 +1,7 @@
 export * from './component-adapter';
 export * from './context-connector';
 export * from './custom-element';
+export * from './external-component-adapter-element';
 export * from './hook-adapter';
 export type { AnyComponentFunction } from './types';
 export { createHookApiFacade, DataObserver } from './utils';