@sisense/sdk-ui 0.14.0 → 0.15.0

package/dist/formulas/use-get-shared-formula.d.ts

@@ -0,0 +1,95 @@
+import { CalculatedMeasure } from '@sisense/sdk-data';
+import { UseGetSharedFormulaParams } from '../props.js';
+import { HookEnableParam } from '../common/hooks/types.js';
+/**
+ * Parameters for {@link useGetSharedFormula} hook.
+ */
+export interface GetSharedFormulaParams extends UseGetSharedFormulaParams, HookEnableParam {
+    /**
+     * Dashboard identifier
+     */
+    dashboardOid: string;
+}
+/**
+ * States of a shared formula load.
+ */
+export type SharedFormulaState = SharedFormulaLoadingState | SharedFormulaErrorState | SharedFormulaSuccessState;
+/**
+ * State of a shared formula loading.
+ */
+export type SharedFormulaLoadingState = {
+    /** Whether the shared formula is loading */
+    isLoading: true;
+    /** Whether the shared formula load has failed */
+    isError: false;
+    /** Whether the shared formula load has succeeded */
+    isSuccess: false;
+    /** The error if any occurred */
+    error: undefined;
+    /** The result shared formula if the load has succeeded */
+    formula: CalculatedMeasure | null;
+    /** The status of the shared formula load */
+    status: 'loading';
+};
+/**
+ * State of a shared formula load that has failed.
+ */
+export type SharedFormulaErrorState = {
+    /** Whether the shared formula is loading */
+    isLoading: false;
+    /** Whether the shared formula load has failed */
+    isError: true;
+    /** Whether the shared formula load has succeeded */
+    isSuccess: false;
+    /** The error if any occurred */
+    error: Error;
+    /** The result shared formula if the load has succeeded */
+    formula: undefined;
+    /** The status of the shared formula load */
+    status: 'error';
+};
+/**
+ * State of a shared formula load that has succeeded.
+ */
+export type SharedFormulaSuccessState = {
+    /** Whether the shared formula is loading */
+    isLoading: false;
+    /** Whether the shared formula load has failed */
+    isError: false;
+    /** Whether the shared formula load has succeeded */
+    isSuccess: true;
+    /** The error if any occurred */
+    error: undefined;
+    /** The result shared formula if the load has succeeded */
+    formula: CalculatedMeasure | null;
+    /** The status of the shared formula load */
+    status: 'success';
+};
+/**
+ * Fetch a [shared formula](https://docs.sisense.com/main/SisenseLinux/shared-formulas.htm) from the Sisense instance
+ *
+ * Formula can be identified either by `oid` or by name and data source pair
+ *
+ * When the retrieval is successful but the shared formula is not found, the result is altered from being `undefined` to `null`
+ *
+ * @example
+ * An example of retrieving a shared formula by oid:
+    ```tsx
+    const { formula, isLoading, isError } = useGetSharedFormula({ oid: 'd61c337b-fabc-4e9e-b4cc-a30116857153' })
+    ```
+ * @example
+ * An example of retrieving a shared formula by name and data source:
+    ```tsx
+    const { formula, isLoading, isError } = useGetSharedFormula({ name: 'My Shared Formula', datasource: DM.DataSource })
+    ```
+ * @param params - {@link UseGetSharedFormulaParams}
+ * @param dataSource - Data source in Sisense instance
+ * @returns Formula load state that contains the status of the execution, the result formula, or the error if any
+ */
+export declare const useGetSharedFormula: (params: UseGetSharedFormulaParams) => SharedFormulaState;
+/**
+ * {@link useGetSharedFormula} without tracking to be used inside other hooks or components in Compose SDK.
+ *
+ * @internal
+ */
+export declare function useGetSharedFormulaInternal(params: UseGetSharedFormulaParams): SharedFormulaState;

package/dist/index.d.ts

@@ -31,7 +31,8 @@ export * from './sisense-context/custom-sisense-context-provider';
 export * from './theme-provider/custom-theme-provider';
 export { getThemeSettingsByOid } from './themes/theme-loader';
 export { getDefaultThemeSettings } from './chart-options-processor/theme-option-service';
-export { useGetDashboardModel, useGetDashboardModels, getDashboardModel, getDashboardModels, type DashboardModel, type GetDashboardModelParams, type GetDashboardModelsParams, type DashboardModelState, type DashboardModelLoadingState, type DashboardModelSuccessState, type DashboardModelErrorState, type DashboardModelsState, type DashboardModelsLoadingState, type DashboardModelsSuccessState, type DashboardModelsErrorState, type WidgetModel, } from './models';
+export { useGetDashboardModel, useGetDashboardModels, getDashboardModel, getDashboardModels, type DashboardModel, type GetDashboardModelParams, type GetDashboardModelsParams, type DashboardModelState, type DashboardModelLoadingState, type DashboardModelSuccessState, type DashboardModelErrorState, type DashboardModelsState, type DashboardModelsLoadingState, type DashboardModelsSuccessState, type DashboardModelsErrorState, type WidgetModel, type GetDashboardModelOptions, type GetDashboardModelsOptions, } from './models';
 export * from './props';
 export * from './types';
 export * from './filters';
+export * from './formulas';