@sisense/sdk-ui 0.14.0 → 0.16.0

package/dist/query-execution/use-execute-csv-query.d.ts

@@ -0,0 +1,82 @@
+import { CsvQueryState, ExecuteCsvQueryParams } from './types.js';
+/**
+ * React hook that executes a CSV data query.
+ * Similar to {@link useExecuteQuery}, but returns the data in CSV format as text or as a stream.
+ *
+ * @example
+ * An example of using the hook to obtain data in a CSV string:
+ ```tsx
+ const { data, isLoading, isError } = useExecuteCsvQuery({
+   dataSource: DM.DataSource,
+   dimensions: [DM.Commerce.AgeRange],
+   measures: [measures.sum(DM.Commerce.Revenue)],
+   filters: [filters.greaterThan(DM.Commerce.Revenue, 1000)],
+ });
+ if (isLoading) {
+   return <div>Loading...</div>;
+ }
+ if (isError) {
+   return <div>Error</div>;
+ }
+ if (data) {
+   return <div>{`CSV as string: ${data}`}</div>;
+ }
+ return null;
+ ```
+ * An example of using the hook to obtain data in CSV format as a stream, translating headers, and triggering file download:
+ ```tsx
+ const { data, isLoading, isError } = useExecuteCsvQuery({
+   dataSource: DM.DataSource,
+   dimensions: [DM.Commerce.AgeRange],
+   measures: [measures.sum(DM.Commerce.Revenue)],
+   filters: [filters.greaterThan(DM.Commerce.Revenue, 1000)],
+   config: { asDataStream: true },
+ });
+ if (isLoading) {
+   return <div>Loading...</div>;
+ }
+ if (isError) {
+   return <div>Error</div>;
+ }
+ if (data) {
+   const reader = new FileReader();
+   reader.onload = () => {
+     if (reader.result) {
+       const text = reader.result as string;
+       const lines = text.split('\n');
+       // Update headers
+       if (lines.length > 0) {
+         lines[0] = translateHeaders(lines[0]); // replace with own implementation
+       }
+       // Join modified lines back to a text
+       const modifiedCsv = lines.join('\n');
+       // Create a new Blob with modified content
+       const modifiedBlob = new Blob([modifiedCsv], { type: 'text/csv' });
+       // Trigger file download
+       const blobURL = window.URL.createObjectURL(modifiedBlob);
+       const a = document.createElement('a');
+       a.href = blobURL;
+       const fileName = 'data_translated_headers'
+       a.download = fileName;
+       document.body.appendChild(a);
+       a.click();
+       window.URL.revokeObjectURL(blobURL);
+       document.body.removeChild(a);
+     }
+   };
+   reader.readAsText(data as Blob);
+ }
+ return null;
+ ```
+
+ *
+ * @param params - Parameters of the query
+ * @returns Query state that contains the status of the query execution, the result data, or the error if any occurred
+ */
+export declare const useExecuteCsvQuery: (params: ExecuteCsvQueryParams) => CsvQueryState;
+/**
+ * {@link useExecuteQuery} without tracking to be used inside other hooks or components in Compose SDK.
+ *
+ * @internal
+ */
+export declare function useExecuteCsvQueryInternal(params: ExecuteCsvQueryParams): CsvQueryState;

package/dist/query-execution/use-execute-query-by-widget-id.d.ts

@@ -1,41 +1,6 @@
-import { type Filter } from '@sisense/sdk-data';
 import { ExecuteQueryParams } from './';
-import { QueryState } from './query-state-reducer';
-import { FiltersMergeStrategy } from '../dashboard-widget/types';
 import { ClientApplication } from '../app/client-application';
-/**
- * Parameters for {@link useExecuteQueryByWidgetId} hook.
- */
-export interface ExecuteQueryByWidgetIdParams {
-    /** {@inheritDoc ExecuteQueryByWidgetIdProps.widgetOid} */
-    widgetOid: string;
-    /** {@inheritDoc ExecuteQueryByWidgetIdProps.dashboardOid} */
-    dashboardOid: string;
-    /** {@inheritDoc ExecuteQueryByWidgetIdProps.filters} */
-    filters?: Filter[];
-    /** {@inheritDoc ExecuteQueryByWidgetIdProps.highlights} */
-    highlights?: Filter[];
-    /** {@inheritDoc ExecuteQueryProps.count} */
-    count?: number;
-    /** {@inheritDoc ExecuteQueryProps.offset} */
-    offset?: number;
-    /** {@inheritDoc ExecuteQueryByWidgetIdProps.filtersMergeStrategy} */
-    filtersMergeStrategy?: FiltersMergeStrategy;
-    /** {@inheritDoc ExecuteQueryByWidgetIdProps.includeDashboardFilters} */
-    includeDashboardFilters?: boolean;
-    /** {@inheritDoc ExecuteQueryByWidgetIdProps.onBeforeQuery} */
-    onBeforeQuery?: (jaql: any) => any | Promise<any>;
-    /**
-     * Boolean flag to control if query is executed
-     *
-     * If not specified, the default value is `true`
-     */
-    enabled?: boolean;
-}
-export type QueryByWidgetIdState = QueryState & {
-    /** Query parameters constructed over the widget */
-    query: ExecuteQueryParams | undefined;
-};
+import { ExecuteQueryByWidgetIdParams, QueryByWidgetIdState } from './types';
 /**
  * React hook that executes a data query extracted from an existing widget in the Sisense instance.
  *
@@ -81,6 +46,6 @@ export declare function isParamsChanged(prevParams: ExecuteQueryByWidgetIdParams
 export declare function executeQueryByWidgetId({ widgetOid, dashboardOid, filters, highlights, filtersMergeStrategy, count, offset, includeDashboardFilters, app, onBeforeQuery, }: ExecuteQueryByWidgetIdParams & {
     app: ClientApplication;
 }): Promise<{
-    data: import("@sisense/sdk-data").QueryResultData;
+    data: import("packages/sdk-data/dist").QueryResultData;
     query: ExecuteQueryParams;
 }>;

package/dist/query-execution/use-execute-query.d.ts

@@ -1,36 +1,4 @@
-import { Attribute, DataSource, Filter, Measure } from '@sisense/sdk-data';
-import { QueryState } from './query-state-reducer';
-/**
- * Parameters for {@link useExecuteQuery} hook.
- */
-export interface ExecuteQueryParams {
-    /**
-     * Data source the query is run against - e.g. `Sample ECommerce`
-     *
-     * If not specified, the query will use the `defaultDataSource` specified in the parent Sisense Context.
-     */
-    dataSource?: DataSource;
-    /** Dimensions of the query */
-    dimensions?: Attribute[];
-    /** Measures of the query */
-    measures?: Measure[];
-    /** Filters that will slice query results */
-    filters?: Filter[];
-    /** Highlight filters that will highlight results that pass filter criteria */
-    highlights?: Filter[];
-    /** {@inheritDoc ExecuteQueryProps.count} */
-    count?: number;
-    /** {@inheritDoc ExecuteQueryProps.offset} */
-    offset?: number;
-    /**
-     * Boolean flag to control if query is executed
-     *
-     * If not specified, the default value is `true`
-     */
-    enabled?: boolean;
-    /** {@inheritDoc ExecuteQueryProps.onBeforeQuery} */
-    onBeforeQuery?: (jaql: any) => any | Promise<any>;
-}
+import { ExecuteQueryParams, QueryState } from './types';
 /**
  * React hook that executes a data query.
  * This approach, which offers an alternative to {@link ExecuteQuery} component, is similar to React Query's `useQuery` hook.
@@ -69,3 +37,10 @@ export declare const useExecuteQuery: (params: ExecuteQueryParams) => QueryState
  * @internal
  */
 export declare function useExecuteQueryInternal(params: ExecuteQueryParams): QueryState;
+/**
+ * Checks if the query parameters have changed by deep comparison.
+ *
+ * @param prevParams - Previous query parameters
+ * @param newParams - New query parameters
+ */
+export declare function isQueryParamsChanged(prevParams: ExecuteQueryParams | undefined, newParams: ExecuteQueryParams): boolean;

package/dist/table/hooks/use-table-data.d.ts

@@ -1,4 +1,4 @@
-import { Data, DataSource, Filter } from '@sisense/sdk-data';
+import { Attribute, Data, DataSource, Filter, Measure } from '@sisense/sdk-data';
 import { TableDataOptionsInternal } from '../../chart-data-options/types';
 type UseDataProps = {
     dataSet: Data | DataSource | undefined;
@@ -7,5 +7,9 @@ type UseDataProps = {
     count: number;
     offset: number;
 };
+export declare const getTableAttributesAndMeasures: (dataOptions: TableDataOptionsInternal) => {
+    attributes: Attribute[];
+    measures: Measure[];
+};
 export declare const useTableData: ({ dataSet, dataOptions, filters, count, offset, }: UseDataProps) => Data | null;
 export {};

package/dist/table/table.d.ts

@@ -48,3 +48,6 @@ import { TableProps } from '../props';
  * @returns Table component
  */
 export declare const Table: React.FunctionComponent<TableProps>;
+export declare const DEFAULT_TABLE_ROWS_PER_PAGE: 25;
+/** How many pages of data will be loaded in one query */
+export declare const PAGES_BATCH_SIZE = 10;