@gooddata/sdk-ui 10.22.0-alpha.2 → 10.22.0-alpha.20

package/esm/sdk-ui.d.ts

@@ -56,6 +56,7 @@ import { IPositiveAttributeFilter } from '@gooddata/sdk-model';
 import { IPreparedExecution } from '@gooddata/sdk-backend-spi';
 import { IRankingFilter } from '@gooddata/sdk-model';
 import { IRelativeDateFilter } from '@gooddata/sdk-model';
+import { IRequestCorrelationMetadata } from '@gooddata/sdk-backend-spi';
 import { IResultAttributeHeader } from '@gooddata/sdk-model';
 import { IResultAttributeHeaderItem } from '@gooddata/sdk-model';
 import { IResultHeader } from '@gooddata/sdk-model';
@@ -209,6 +210,15 @@ export declare type AttributesOrPlaceholders = ValuesOrPlaceholders<IAttribute>;
  */
 export declare const BackendProvider: React_2.FC<IBackendProviderProps>;
 
+/**
+ * Combined provider for both backend and correlation metadata.
+ * This is a convenience component that wraps BackendProvider and CorrelationProvider
+ * to provide both a backend instance and correlation metadata to components.
+ *
+ * @public
+ */
+export declare const BackendProviderWithCorrelation: React_2.FC<IBackendProviderWithCorrelationProps>;
+
 /**
  * This error means that server could not understand the request due to invalid syntax.
  *
@@ -369,6 +379,14 @@ export declare function convertDrillableItemsToPredicates(drillableItems: Explic
  */
 export declare function convertError(error: unknown): GoodDataSdkError;
 
+/**
+ * CorrelationProvider provides request correlation metadata to components.
+ * When nested, correlation metadata from ancestor providers is merged with the current provider.
+ *
+ * @public
+ */
+export declare const CorrelationProvider: React_2.FC<ICorrelationProviderProps>;
+
 /**
  * Creates function that should be passed to onExportReady in the event that the backend execution
  * fails and export is not possible.
@@ -388,6 +406,14 @@ export declare function createExportErrorFunction(error: GoodDataSdkError): IExp
  */
 export declare function createExportFunction(result: IExecutionResult, exportTitle?: string): IExportFunction;
 
+/**
+ * Creates function to export Raw data in the provided result.
+ *
+ * @param result - data view that will be exported
+ * @internal
+ */
+export declare function createExportRawFunction(result: IExecutionResult, filename: string): Promise<IExportResult>;
+
 /**
  * @internal
  */
@@ -761,6 +787,12 @@ export declare class DataViewLoader {
      * @alpha
      */
     withTotals: (...totals: ITotal[]) => DataViewLoader;
+    /**
+     * Runs execution with the provided AbortSignal.
+     *
+     * @alpha
+     */
+    withSignal: (signal: AbortSignal) => DataViewLoader;
     /**
      * Loads subset of the result data and wraps them in {@link DataViewFacade}.
      *
@@ -1263,6 +1295,26 @@ export declare interface IBackendProviderProps {
     children?: React_2.ReactNode;
 }
 
+/**
+ * Combined provider for both backend and correlation metadata.
+ *
+ * @public
+ */
+export declare interface IBackendProviderWithCorrelationProps {
+    /**
+     * Backend instance to use or enhance with correlation
+     */
+    backend?: IAnalyticalBackend;
+    /**
+     * Key-value pairs of correlation metadata to be used for telemetry
+     */
+    correlationData: IRequestCorrelationMetadata;
+    /**
+     * React children
+     */
+    children?: React_2.ReactNode;
+}
+
 /**
  * @internal
  */
@@ -1402,6 +1454,21 @@ export declare interface IComposedPlaceholder<TReturn, TValue extends any[], TCo
     use: IUseComposedPlaceholderHook<IComposedPlaceholder<TReturn, TValue, TContext>>;
 }
 
+/**
+ * Props of the {@link CorrelationProvider} component.
+ * @public
+ */
+export declare interface ICorrelationProviderProps {
+    /**
+     * Key-value pairs of correlation metadata to be used for telemetry
+     */
+    correlationData: Record<string, string>;
+    /**
+     * React children
+     */
+    children?: React_2.ReactNode;
+}
+
 /**
  * Defines methods to access data in the data view.
  *
@@ -1934,6 +2001,15 @@ export declare interface IExecuteInsightProps extends IWithLoadingEvents<IExecut
      * this mode.
      */
     executeByReference?: boolean;
+    /**
+     * Optionally enable real execution cancellation.
+     *
+     * This means that if the execution request is not yet finished and the execution changes,
+     * the request will be cancelled and the new execution will be started.
+     *
+     * Default: false
+     */
+    enableExecutionCancelling?: boolean;
     /**
      * Child component to which rendering is delegated.
      *
@@ -2053,6 +2129,15 @@ export declare interface IExecuteProps extends IWithLoadingEvents<IExecuteProps>
      * If not specified, all data will be loaded.
      */
     window?: DataViewWindow;
+    /**
+     * Optionally enable real execution cancellation.
+     *
+     * This means that if the execution request is not yet finished and the execution changes,
+     * the request will be cancelled and the new execution will be started.
+     *
+     * Default: false
+     */
+    enableExecutionCancelling?: boolean;
     /**
      * Child component to which rendering is delegated.
      *
@@ -2556,6 +2641,15 @@ export declare interface IRawExecuteProps extends IWithLoadingEvents<IRawExecute
      * to trigger the execution and loading.
      */
     loadOnMount?: boolean;
+    /**
+     * Optionally enable real execution cancellation.
+     *
+     * This means that if the execution request is not yet finished and the execution changes,
+     * the request will be cancelled and the new execution will be started.
+     *
+     * Default: false
+     */
+    enableExecutionCancelling?: boolean;
     /**
      * Child component to which rendering is delegated.
      *
@@ -3068,6 +3162,15 @@ export declare interface IUseExecutionDataViewConfig {
      * workspace here, then the executor MUST be rendered within an existing WorkspaceContext.
      */
     workspace?: string;
+    /**
+     * Optionally enable real execution cancellation.
+     *
+     * This means that if the execution request is not yet finished and the execution changes,
+     * the request will be cancelled and the new execution will be started.
+     *
+     * Default: false
+     */
+    enableExecutionCancelling?: boolean;
 }
 
 /**
@@ -3139,6 +3242,15 @@ export declare interface IUseInsightDataViewConfig {
      * workspace here, then the executor MUST be rendered within an existing WorkspaceContext.
      */
     workspace?: string;
+    /**
+     * Optionally enable real execution cancellation.
+     *
+     * This means that if the execution request is not yet finished and the execution changes,
+     * the request will be cancelled and the new execution will be started.
+     *
+     * Default: false
+     */
+    enableExecutionCancelling?: boolean;
 }
 
 /**
@@ -3270,6 +3382,15 @@ export declare interface IWithExecution<T> {
      * Specify event callbacks which the HOC will trigger in different situations.
      */
     events?: IWithLoadingEvents<T> | ((props: T) => IWithLoadingEvents<T>);
+    /**
+     * Optionally enable real execution cancellation.
+     *
+     * This means that if the execution request is not yet finished and the execution changes,
+     * the request will be cancelled and the new execution will be started.
+     *
+     * Default: false
+     */
+    enableExecutionCancelling?: boolean | ((props: T) => boolean);
     /**
      * Customize, whether execution & data loading should start as soon as component is mounted.
      *
@@ -3315,8 +3436,9 @@ export declare interface IWithExecutionLoading<TProps> {
      *
      * @param props - wrapped component props
      * @param window - data view window to retrieve, not specified in case all data should be retrieved
+     * @param signal - abort signal, will be used to cancel the execution
      */
-    promiseFactory: (props: TProps, window?: DataViewWindow) => Promise<DataViewFacade>;
+    promiseFactory: (props: TProps, window?: DataViewWindow, signal?: AbortSignal) => Promise<DataViewFacade>;
     /**
      * Specify data view window to retrieve from backend.
      *
@@ -3343,6 +3465,15 @@ export declare interface IWithExecutionLoading<TProps> {
      * @param nextProps - next props
      */
     shouldRefetch?: (prevProps: TProps, nextProps: TProps) => boolean;
+    /**
+     * Optionally enable real execution cancellation.
+     *
+     * This means that if the execution request is not yet finished and the execution changes,
+     * the request will be cancelled and the new execution will be started.
+     *
+     * Default: false
+     */
+    enableExecutionCancelling?: boolean | ((props: TProps) => boolean);
 }
 
 /**
@@ -3455,7 +3586,7 @@ export declare function localIdentifierMatch(localIdOrMeasure: string | IMeasure
  *
  * @internal
  */
-export declare function makeCancelable<T>(promise: Promise<T>): ICancelablePromise<T>;
+export declare function makeCancelable<T>(promise: (signal: AbortSignal) => Promise<T>, enableAbortController?: boolean): ICancelablePromise<T>;
 
 /**
  * Generate union of measures from union of measure definitions.
@@ -4017,6 +4148,20 @@ export declare const useBackend: (backend?: IAnalyticalBackend) => IAnalyticalBa
  */
 export declare const useBackendStrict: (backend?: IAnalyticalBackend, context?: string) => IAnalyticalBackend;
 
+/**
+ * Hook to get a backend instance with correlation metadata from context,
+ * and optionally merge them with additional correlation metadata provided as a parameter.
+ *
+ * @remarks
+ * This hook enhances the backend from useBackend() with correlation metadata
+ * from the nearest CorrelationProvider.
+ *
+ * @param backend - optional backend override
+ * @param correlationMetadata - optional correlation metadata to merge with the context data
+ * @public
+ */
+export declare const useBackendWithCorrelation: (backend?: IAnalyticalBackend, correlationMetadata?: IRequestCorrelationMetadata) => IAnalyticalBackend | undefined;
+
 /**
  * This hook provides easy way to work with Promises in React components.
  *
@@ -4088,7 +4233,14 @@ export declare type UseCancelablePromiseLoadingState = {
  * @public
  */
 export declare type UseCancelablePromiseOptions<TResult, TError> = UseCancelablePromiseCallbacks<TResult, TError> & {
-    promise: (() => Promise<TResult>) | undefined | null;
+    promise: ((signal: AbortSignal) => Promise<TResult>) | undefined | null;
+    /**
+     * Optionally enable the AbortController that will be aborted when the dependency list changes, if the promise is still running.
+     *
+     * Note that the provided promise implementation must support cancellation by handling
+     * the AbortSignal parameter.
+     */
+    enableAbortController?: boolean;
 };
 
 /**
@@ -4159,6 +4311,13 @@ export declare const useClientWorkspaceStatus: () => UseCancelablePromiseStatus;
  */
 export declare function useComposedPlaceholder<TContext, TPlaceholder extends IComposedPlaceholder<any, any, TContext>>(placeholder: TPlaceholder, resolutionContext?: TContext): PlaceholderResolvedValue<TPlaceholder>;
 
+/**
+ * Hook to get correlation metadata from the nearest correlation provider.
+ *
+ * @public
+ */
+export declare const useCorrelationData: () => Record<string, string>;
+
 /**
  * This hook provides easy way to export data in your preferred format (csv/xlsx/raw) for the provided {@link @gooddata/sdk-backend-spi#IPreparedExecution}.
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gooddata/sdk-ui",
-  "version": "10.22.0-alpha.2",
+  "version": "10.22.0-alpha.20",
   "description": "GoodData.UI SDK - Core",
   "repository": {
     "type": "git",
@@ -41,9 +41,9 @@
     "ts-invariant": "^0.7.5",
     "tslib": "^2.5.0",
     "uuid": "^8.3.2",
-    "@gooddata/sdk-backend-spi": "10.22.0-alpha.2",
-    "@gooddata/sdk-model": "10.22.0-alpha.2",
-    "@gooddata/util": "10.22.0-alpha.2"
+    "@gooddata/sdk-backend-spi": "10.22.0-alpha.20",
+    "@gooddata/sdk-model": "10.22.0-alpha.20",
+    "@gooddata/util": "10.22.0-alpha.20"
   },
   "peerDependencies": {
     "react": "^16.10.0 || ^17.0.0 || ^18.0.0",
@@ -94,10 +94,10 @@
     "typescript": "5.3.3",
     "vitest": "1.0.4",
     "vitest-dom": "0.1.1",
-    "@gooddata/i18n-toolkit": "10.22.0-alpha.2",
-    "@gooddata/reference-workspace": "10.22.0-alpha.2",
-    "@gooddata/sdk-backend-base": "10.22.0-alpha.2",
-    "@gooddata/sdk-backend-mockingbird": "10.22.0-alpha.2"
+    "@gooddata/i18n-toolkit": "10.22.0-alpha.20",
+    "@gooddata/reference-workspace": "10.22.0-alpha.20",
+    "@gooddata/sdk-backend-mockingbird": "10.22.0-alpha.20",
+    "@gooddata/sdk-backend-base": "10.22.0-alpha.20"
   },
   "scripts": {
     "clean": "rm -rf ci dist esm coverage *.log tsconfig.tsbuildinfo",