@sisense/sdk-ai-core 0.15.0 → 0.15.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/constants.d.ts +0 -1
- package/dist/engines/build-chart/build-chart-engine.d.ts +0 -1
- package/dist/engines/build-chart/build-chart-service.d.ts +0 -1
- package/dist/engines/build-chart/create-chart/assemble-chart-widget.d.ts +0 -1
- package/dist/engines/build-chart/create-chart/chart-json-axes-mapping.d.ts +0 -1
- package/dist/engines/build-chart/create-chart/create-chart.d.ts +0 -1
- package/dist/engines/build-chart/create-chart/generate-chart-recommendations.d.ts +0 -1
- package/dist/engines/build-chart/create-chart/generate-chart.d.ts +0 -1
- package/dist/engines/build-chart/create-chart/get-columns-json.d.ts +0 -1
- package/dist/engines/build-chart/create-chart/rebind-chart-to-query.d.ts +0 -1
- package/dist/engines/build-chart/create-chart/resolve-chart-query.d.ts +0 -1
- package/dist/engines/build-chart/dataset-from-saved-chart-widget.d.ts +0 -1
- package/dist/engines/build-chart/shared/chart-column-utils.d.ts +0 -1
- package/dist/engines/build-chart/shared/csdk-data-options-for-llm.d.ts +0 -1
- package/dist/engines/build-chart/shared/finalize-chart-widget-save.d.ts +0 -1
- package/dist/engines/build-chart/shared/normalize-cartesian-axes-mapping.d.ts +0 -1
- package/dist/engines/build-chart/shared/sync-chart-state-measure-flags.d.ts +0 -1
- package/dist/engines/build-chart/types.d.ts +0 -1
- package/dist/engines/build-chart/update-chart/apply-prior-chart-style.d.ts +0 -1
- package/dist/engines/build-chart/update-chart/chart-options-schemas.d.ts +0 -1
- package/dist/engines/build-chart/update-chart/schemas.d.ts +0 -1
- package/dist/engines/build-chart/update-chart/update-chart-data-options.d.ts +0 -1
- package/dist/engines/build-chart/update-chart/update-chart-query.d.ts +0 -1
- package/dist/engines/build-chart/update-chart/update-chart-style-options.d.ts +0 -1
- package/dist/engines/build-chart/update-chart/update-chart-title.d.ts +0 -1
- package/dist/engines/build-chart/update-chart/update-chart-type.d.ts +0 -1
- package/dist/engines/build-csv-model/build-csv-model-engine.d.ts +0 -1
- package/dist/engines/build-csv-model/index.d.ts +0 -1
- package/dist/engines/build-csv-model/infer-relations.d.ts +0 -1
- package/dist/engines/build-csv-model/rest-build.d.ts +0 -1
- package/dist/engines/build-csv-model/types.d.ts +0 -1
- package/dist/engines/build-dashboard/add-dashboard-filters.d.ts +0 -1
- package/dist/engines/build-dashboard/add-dashboard-widgets.d.ts +0 -1
- package/dist/engines/build-dashboard/build-dashboard-engine.d.ts +0 -1
- package/dist/engines/build-dashboard/build-dashboard-service.d.ts +0 -1
- package/dist/engines/build-dashboard/create-dashboard.d.ts +0 -1
- package/dist/engines/build-dashboard/dashboard-filters/dashboard-filters-system-prompt.d.ts +0 -1
- package/dist/engines/build-dashboard/dashboard-filters/filter-factory-types.d.ts +0 -1
- package/dist/engines/build-dashboard/dashboard-filters/manipulate-dashboard-filters.d.ts +0 -1
- package/dist/engines/build-dashboard/dashboard-filters/measure-factory-types.d.ts +0 -1
- package/dist/engines/build-dashboard/dashboard-filters/translate-filters.d.ts +0 -1
- package/dist/engines/build-dashboard/index.d.ts +0 -1
- package/dist/engines/build-dashboard/load-existing-fusion-dashboard.d.ts +0 -1
- package/dist/engines/build-dashboard/types.d.ts +0 -1
- package/dist/engines/build-dashboard/update-dashboard.d.ts +0 -1
- package/dist/engines/build-data-model/build-data-model-engine.d.ts +0 -1
- package/dist/engines/build-data-model/fake-options.d.ts +0 -1
- package/dist/engines/build-data-model/faker-type-list.d.ts +0 -1
- package/dist/engines/build-data-model/index.d.ts +0 -1
- package/dist/engines/build-data-model/types.d.ts +0 -1
- package/dist/engines/build-data-model/validate-relationships.d.ts +0 -1
- package/dist/engines/build-query/build-query-engine.d.ts +0 -1
- package/dist/engines/build-query/index.d.ts +0 -1
- package/dist/engines/build-query/types.d.ts +0 -1
- package/dist/engines/get-dashboards/get-dashboards-engine.d.ts +0 -1
- package/dist/engines/get-dashboards/index.d.ts +0 -1
- package/dist/engines/get-dashboards/types.d.ts +0 -1
- package/dist/engines/get-data-source-fields/get-data-source-fields-engine.d.ts +0 -1
- package/dist/engines/get-data-source-fields/index.d.ts +0 -1
- package/dist/engines/get-data-source-fields/types.d.ts +0 -1
- package/dist/engines/get-data-sources/get-data-sources-engine.d.ts +0 -1
- package/dist/engines/get-data-sources/index.d.ts +0 -1
- package/dist/engines/get-data-sources/types.d.ts +0 -1
- package/dist/engines/index.d.ts +0 -1
- package/dist/engines/manage-perspectives/index.d.ts +0 -1
- package/dist/engines/manage-perspectives/manage-perspectives-engine.d.ts +0 -1
- package/dist/engines/manage-perspectives/types.d.ts +0 -1
- package/dist/engines/recommend-queries/index.d.ts +0 -1
- package/dist/engines/recommend-queries/recommend-queries-engine.d.ts +0 -1
- package/dist/engines/recommend-queries/types.d.ts +0 -1
- package/dist/engines/shared/get-filters-json-for-llm-summary.d.ts +0 -1
- package/dist/engines/shared/nlq-query-helpers.d.ts +0 -1
- package/dist/index.d.ts +0 -1
- package/dist/index.js +7205 -6940
- package/dist/services/dashboards/dashboards-service.d.ts +0 -1
- package/dist/services/dashboards/fusion-dashboards-service.d.ts +0 -1
- package/dist/services/data-models/data-models-service.d.ts +0 -1
- package/dist/services/data-models/ecm-service.d.ts +0 -1
- package/dist/services/data-sources/data-sources-service.d.ts +0 -1
- package/dist/services/formulas/formulas-service.d.ts +0 -1
- package/dist/services/llm/llm-consumption-service.d.ts +0 -1
- package/dist/services/llm/llm-models-service.d.ts +0 -1
- package/dist/services/llm/llm-settings-service.d.ts +0 -1
- package/dist/services/nlq/nlq-service.d.ts +0 -1
- package/dist/singleton-clients.d.ts +0 -1
- package/dist/utils/abort-signal.d.ts +0 -1
- package/dist/utils/create-custom-fetch.d.ts +0 -1
- package/dist/utils/create-serialized-tool-group.d.ts +0 -1
- package/dist/utils/create-stream-completion.d.ts +0 -1
- package/dist/utils/create-structured-completion.d.ts +0 -1
- package/dist/utils/create-tools-completion.d.ts +0 -1
- package/dist/utils/dev-debug.d.ts +0 -1
- package/dist/utils/http-client.d.ts +0 -1
- package/dist/utils/id-utils.d.ts +0 -1
- package/dist/utils/llm-client.d.ts +0 -1
- package/dist/utils/llm-provider-options.d.ts +0 -1
- package/dist/utils/proxy-utils.d.ts +0 -1
- package/dist/utils/trusted-base-url.d.ts +0 -1
- package/dist/utils/user-action-tracking.d.ts +0 -1
- package/dist/utils/utils.d.ts +0 -1
- package/dist/utils/zod-utils.d.ts +0 -1
- package/package.json +5 -5
- package/dist/constants.d.ts.map +0 -1
- package/dist/engines/build-chart/build-chart-engine.d.ts.map +0 -1
- package/dist/engines/build-chart/build-chart-service.d.ts.map +0 -1
- package/dist/engines/build-chart/create-chart/assemble-chart-widget.d.ts.map +0 -1
- package/dist/engines/build-chart/create-chart/chart-json-axes-mapping.d.ts.map +0 -1
- package/dist/engines/build-chart/create-chart/create-chart.d.ts.map +0 -1
- package/dist/engines/build-chart/create-chart/generate-chart-recommendations.d.ts.map +0 -1
- package/dist/engines/build-chart/create-chart/generate-chart.d.ts.map +0 -1
- package/dist/engines/build-chart/create-chart/get-columns-json.d.ts.map +0 -1
- package/dist/engines/build-chart/create-chart/rebind-chart-to-query.d.ts.map +0 -1
- package/dist/engines/build-chart/create-chart/resolve-chart-query.d.ts.map +0 -1
- package/dist/engines/build-chart/dataset-from-saved-chart-widget.d.ts.map +0 -1
- package/dist/engines/build-chart/shared/chart-column-utils.d.ts.map +0 -1
- package/dist/engines/build-chart/shared/csdk-data-options-for-llm.d.ts.map +0 -1
- package/dist/engines/build-chart/shared/finalize-chart-widget-save.d.ts.map +0 -1
- package/dist/engines/build-chart/shared/normalize-cartesian-axes-mapping.d.ts.map +0 -1
- package/dist/engines/build-chart/shared/sync-chart-state-measure-flags.d.ts.map +0 -1
- package/dist/engines/build-chart/types.d.ts.map +0 -1
- package/dist/engines/build-chart/update-chart/apply-prior-chart-style.d.ts.map +0 -1
- package/dist/engines/build-chart/update-chart/chart-options-schemas.d.ts.map +0 -1
- package/dist/engines/build-chart/update-chart/schemas.d.ts.map +0 -1
- package/dist/engines/build-chart/update-chart/update-chart-data-options.d.ts.map +0 -1
- package/dist/engines/build-chart/update-chart/update-chart-query.d.ts.map +0 -1
- package/dist/engines/build-chart/update-chart/update-chart-style-options.d.ts.map +0 -1
- package/dist/engines/build-chart/update-chart/update-chart-title.d.ts.map +0 -1
- package/dist/engines/build-chart/update-chart/update-chart-type.d.ts.map +0 -1
- package/dist/engines/build-csv-model/build-csv-model-engine.d.ts.map +0 -1
- package/dist/engines/build-csv-model/index.d.ts.map +0 -1
- package/dist/engines/build-csv-model/infer-relations.d.ts.map +0 -1
- package/dist/engines/build-csv-model/rest-build.d.ts.map +0 -1
- package/dist/engines/build-csv-model/types.d.ts.map +0 -1
- package/dist/engines/build-dashboard/add-dashboard-filters.d.ts.map +0 -1
- package/dist/engines/build-dashboard/add-dashboard-widgets.d.ts.map +0 -1
- package/dist/engines/build-dashboard/build-dashboard-engine.d.ts.map +0 -1
- package/dist/engines/build-dashboard/build-dashboard-service.d.ts.map +0 -1
- package/dist/engines/build-dashboard/create-dashboard.d.ts.map +0 -1
- package/dist/engines/build-dashboard/dashboard-filters/dashboard-filters-system-prompt.d.ts.map +0 -1
- package/dist/engines/build-dashboard/dashboard-filters/filter-factory-types.d.ts.map +0 -1
- package/dist/engines/build-dashboard/dashboard-filters/manipulate-dashboard-filters.d.ts.map +0 -1
- package/dist/engines/build-dashboard/dashboard-filters/measure-factory-types.d.ts.map +0 -1
- package/dist/engines/build-dashboard/dashboard-filters/translate-filters.d.ts.map +0 -1
- package/dist/engines/build-dashboard/index.d.ts.map +0 -1
- package/dist/engines/build-dashboard/load-existing-fusion-dashboard.d.ts.map +0 -1
- package/dist/engines/build-dashboard/types.d.ts.map +0 -1
- package/dist/engines/build-dashboard/update-dashboard.d.ts.map +0 -1
- package/dist/engines/build-data-model/build-data-model-engine.d.ts.map +0 -1
- package/dist/engines/build-data-model/fake-options.d.ts.map +0 -1
- package/dist/engines/build-data-model/faker-type-list.d.ts.map +0 -1
- package/dist/engines/build-data-model/index.d.ts.map +0 -1
- package/dist/engines/build-data-model/types.d.ts.map +0 -1
- package/dist/engines/build-data-model/validate-relationships.d.ts.map +0 -1
- package/dist/engines/build-query/build-query-engine.d.ts.map +0 -1
- package/dist/engines/build-query/index.d.ts.map +0 -1
- package/dist/engines/build-query/types.d.ts.map +0 -1
- package/dist/engines/get-dashboards/get-dashboards-engine.d.ts.map +0 -1
- package/dist/engines/get-dashboards/index.d.ts.map +0 -1
- package/dist/engines/get-dashboards/types.d.ts.map +0 -1
- package/dist/engines/get-data-source-fields/get-data-source-fields-engine.d.ts.map +0 -1
- package/dist/engines/get-data-source-fields/index.d.ts.map +0 -1
- package/dist/engines/get-data-source-fields/types.d.ts.map +0 -1
- package/dist/engines/get-data-sources/get-data-sources-engine.d.ts.map +0 -1
- package/dist/engines/get-data-sources/index.d.ts.map +0 -1
- package/dist/engines/get-data-sources/types.d.ts.map +0 -1
- package/dist/engines/index.d.ts.map +0 -1
- package/dist/engines/manage-perspectives/index.d.ts.map +0 -1
- package/dist/engines/manage-perspectives/manage-perspectives-engine.d.ts.map +0 -1
- package/dist/engines/manage-perspectives/types.d.ts.map +0 -1
- package/dist/engines/recommend-queries/index.d.ts.map +0 -1
- package/dist/engines/recommend-queries/recommend-queries-engine.d.ts.map +0 -1
- package/dist/engines/recommend-queries/types.d.ts.map +0 -1
- package/dist/engines/shared/get-filters-json-for-llm-summary.d.ts.map +0 -1
- package/dist/engines/shared/nlq-query-helpers.d.ts.map +0 -1
- package/dist/index.d.ts.map +0 -1
- package/dist/index.js.map +0 -1
- package/dist/services/dashboards/dashboards-service.d.ts.map +0 -1
- package/dist/services/dashboards/fusion-dashboards-service.d.ts.map +0 -1
- package/dist/services/data-models/data-models-service.d.ts.map +0 -1
- package/dist/services/data-models/ecm-service.d.ts.map +0 -1
- package/dist/services/data-sources/data-sources-service.d.ts.map +0 -1
- package/dist/services/formulas/formulas-service.d.ts.map +0 -1
- package/dist/services/llm/llm-consumption-service.d.ts.map +0 -1
- package/dist/services/llm/llm-models-service.d.ts.map +0 -1
- package/dist/services/llm/llm-settings-service.d.ts.map +0 -1
- package/dist/services/nlq/nlq-service.d.ts.map +0 -1
- package/dist/singleton-clients.d.ts.map +0 -1
- package/dist/utils/abort-signal.d.ts.map +0 -1
- package/dist/utils/create-custom-fetch.d.ts.map +0 -1
- package/dist/utils/create-serialized-tool-group.d.ts.map +0 -1
- package/dist/utils/create-stream-completion.d.ts.map +0 -1
- package/dist/utils/create-structured-completion.d.ts.map +0 -1
- package/dist/utils/create-tools-completion.d.ts.map +0 -1
- package/dist/utils/dev-debug.d.ts.map +0 -1
- package/dist/utils/http-client.d.ts.map +0 -1
- package/dist/utils/id-utils.d.ts.map +0 -1
- package/dist/utils/llm-client.d.ts.map +0 -1
- package/dist/utils/llm-provider-options.d.ts.map +0 -1
- package/dist/utils/proxy-utils.d.ts.map +0 -1
- package/dist/utils/trusted-base-url.d.ts.map +0 -1
- package/dist/utils/user-action-tracking.d.ts.map +0 -1
- package/dist/utils/utils.d.ts.map +0 -1
- package/dist/utils/zod-utils.d.ts.map +0 -1
package/dist/constants.d.ts
CHANGED
|
@@ -29,4 +29,3 @@ export declare const HEADER_INTERFACE_NAME = "x-interface-name";
|
|
|
29
29
|
export declare const HEADER_FEATURE_NAME = "x-feature-name";
|
|
30
30
|
export declare const HEADER_QUOTA_ID = "x-quota-id";
|
|
31
31
|
export declare const ALLOWED_HEADERS: string[];
|
|
32
|
-
//# sourceMappingURL=constants.d.ts.map
|
|
@@ -1,4 +1,3 @@
|
|
|
1
1
|
import { ChartSummary, BuildChartContext, buildChartSchema } from './types';
|
|
2
2
|
import { default as z } from 'zod/v4';
|
|
3
3
|
export declare function buildChartEngine(params: z.infer<typeof buildChartSchema>, context: BuildChartContext): Promise<ChartSummary>;
|
|
4
|
-
//# sourceMappingURL=build-chart-engine.d.ts.map
|
|
@@ -4,4 +4,3 @@ import { ExtendedChartWidgetProps, BaseChartSummary } from './types';
|
|
|
4
4
|
* Returns `undefined` when `chartState` has not yet been computed (e.g. unsupported chart type).
|
|
5
5
|
*/
|
|
6
6
|
export declare const getBaseChartSummary: (widgetProps: ExtendedChartWidgetProps) => BaseChartSummary | undefined;
|
|
7
|
-
//# sourceMappingURL=build-chart-service.d.ts.map
|
|
@@ -24,4 +24,3 @@ export declare function mapAxesToDataOptions<T extends {
|
|
|
24
24
|
* and the already-mapped data options.
|
|
25
25
|
*/
|
|
26
26
|
export declare function assembleChartJSON(queryState: QueryState, chartType: string, dataOptions: DataOptionsJSON): ChartJSON;
|
|
27
|
-
//# sourceMappingURL=chart-json-axes-mapping.d.ts.map
|
|
@@ -7,4 +7,3 @@ import { LanguageModel } from 'ai';
|
|
|
7
7
|
* Column array order defines axis indices; `id` is assigned from position.
|
|
8
8
|
*/
|
|
9
9
|
export declare const generateChartRecommendations: (userPrompt: string, columns: ColumnSummary[] | undefined, chartType: ChartType | undefined, llmClient?: LanguageModel) => Promise<z.infer<typeof chartRecommendationsSchema>>;
|
|
10
|
-
//# sourceMappingURL=generate-chart-recommendations.d.ts.map
|
|
@@ -15,4 +15,3 @@ export type GenerateChartOutput = {
|
|
|
15
15
|
widgetProps: ExtendedChartWidgetProps;
|
|
16
16
|
};
|
|
17
17
|
export declare const generateChart: ({ dataSourceTitle, queryPrompt, chartPrompt, chartType, chartTitle, queryId, priorQueryState, }: GenerateChartParams, context: BuildChartContext) => Promise<GenerateChartOutput>;
|
|
18
|
-
//# sourceMappingURL=generate-chart.d.ts.map
|
|
@@ -12,4 +12,3 @@ export declare function normalizeToStyledColumn(item: unknown): ColumnJSON | nul
|
|
|
12
12
|
export declare function getColumnsJSON(queryState: QueryState): ColumnJSON[];
|
|
13
13
|
export declare function toColumnSummaries(columnsJSON: ColumnJSON[]): ColumnSummary[];
|
|
14
14
|
export declare function columnSummariesFromQueryState(queryState: QueryState): ColumnSummary[];
|
|
15
|
-
//# sourceMappingURL=get-columns-json.d.ts.map
|
|
@@ -8,4 +8,3 @@ export type ResolveChartQueryParams = {
|
|
|
8
8
|
priorQueryState?: QueryState;
|
|
9
9
|
};
|
|
10
10
|
export declare const resolveChartQuery: ({ dataSourceTitle, queryPrompt, queryId, priorQueryState, }: ResolveChartQueryParams, context: BuildChartContext) => Promise<QueryResult>;
|
|
11
|
-
//# sourceMappingURL=resolve-chart-query.d.ts.map
|
|
@@ -8,4 +8,3 @@ import { ExtendedChartWidgetProps } from './types';
|
|
|
8
8
|
*/
|
|
9
9
|
export declare function datasetFromSavedChartWidget(naturalResponseEnabled: boolean | undefined, props: ExtendedChartWidgetProps | null): Dataset | undefined;
|
|
10
10
|
export declare function queryStateFromSavedChartWidget(props: ExtendedChartWidgetProps | null): QueryState | undefined;
|
|
11
|
-
//# sourceMappingURL=dataset-from-saved-chart-widget.d.ts.map
|
|
@@ -5,4 +5,3 @@ import { ExtendedChartWidgetProps } from '../types';
|
|
|
5
5
|
* flags such as showOnRightAxis — especially after y2Axis is enabled.
|
|
6
6
|
*/
|
|
7
7
|
export declare function finalizeChartWidgetSave(chartWidgetProps: ExtendedChartWidgetProps): void;
|
|
8
|
-
//# sourceMappingURL=finalize-chart-widget-save.d.ts.map
|
|
@@ -5,4 +5,3 @@ import { axesMappingSchema, ColumnJSON } from '../types';
|
|
|
5
5
|
* into value so translateChartFromJSON accepts the mapping.
|
|
6
6
|
*/
|
|
7
7
|
export declare function normalizeCartesianAxesMapping(axesMapping: z.infer<typeof axesMappingSchema>, columnsJSON: ColumnJSON[]): z.infer<typeof axesMappingSchema>;
|
|
8
|
-
//# sourceMappingURL=normalize-cartesian-axes-mapping.d.ts.map
|
|
@@ -19,4 +19,3 @@ export declare function restoreCartesianMeasureFlags(dataOptions: ChartDataOptio
|
|
|
19
19
|
* after translateChartToJSON, which can drop showOnRightAxis from the summary.
|
|
20
20
|
*/
|
|
21
21
|
export declare function syncChartStateMeasureFlagsFromDataOptions(chartState: BaseChartSummary, dataOptions: ChartDataOptions | undefined): BaseChartSummary;
|
|
22
|
-
//# sourceMappingURL=sync-chart-state-measure-flags.d.ts.map
|
|
@@ -7,4 +7,3 @@ import { ExtendedChartWidgetProps } from '../types';
|
|
|
7
7
|
* names that may no longer exist after structural changes (add/remove/swap dimensions).
|
|
8
8
|
*/
|
|
9
9
|
export declare function applyPriorChartStyle(widgetProps: ExtendedChartWidgetProps, priorChart: ExtendedChartWidgetProps): void;
|
|
10
|
-
//# sourceMappingURL=apply-prior-chart-style.d.ts.map
|
|
@@ -2891,4 +2891,3 @@ export declare const tableDataOptionsEditingSchemas: z.ZodObject<{
|
|
|
2891
2891
|
export declare const getChartDataOptionsEditingSchemas: (chartType: ChartType) => z.ZodObject<{}, z.core.$strip>;
|
|
2892
2892
|
export declare const chartDataOptionsSchemas: Partial<Record<ChartType, z.ZodObject<any>>>;
|
|
2893
2893
|
export {};
|
|
2894
|
-
//# sourceMappingURL=chart-options-schemas.d.ts.map
|
|
@@ -10,4 +10,3 @@ export interface BuildCsvModelProgressSnapshot {
|
|
|
10
10
|
relations?: BuiltRelation[];
|
|
11
11
|
}
|
|
12
12
|
export declare function buildCsvModelEngine(params: z.infer<typeof buildCsvModelParamsSchema>, context: CsvModelEngineContext, onProgress?: (phase: string, detail?: string, snapshot?: BuildCsvModelProgressSnapshot) => void): Promise<BuildCsvModelResult>;
|
|
13
|
-
//# sourceMappingURL=build-csv-model-engine.d.ts.map
|
|
@@ -4,4 +4,3 @@ export { buildCsvModelEngine } from './build-csv-model-engine';
|
|
|
4
4
|
export type { BuildCsvModelProgressSnapshot } from './build-csv-model-engine';
|
|
5
5
|
export { inferRelations } from './infer-relations';
|
|
6
6
|
export { triggerFullBuild, pollBuild } from './rest-build';
|
|
7
|
-
//# sourceMappingURL=index.d.ts.map
|
|
@@ -2,4 +2,3 @@ import { AddDashboardFiltersParams, BuildDashboardContext } from './types';
|
|
|
2
2
|
export declare const addDashboardFilters: ({ dashboardId, userPrompt }: AddDashboardFiltersParams, context: BuildDashboardContext) => Promise<{
|
|
3
3
|
message: string;
|
|
4
4
|
}>;
|
|
5
|
-
//# sourceMappingURL=add-dashboard-filters.d.ts.map
|
|
@@ -2,4 +2,3 @@ import { AddDashboardWidgetsParams, BuildDashboardContext } from './types';
|
|
|
2
2
|
export declare const addDashboardWidgets: ({ dashboardId, widgetIdsToAdd }: AddDashboardWidgetsParams, context: BuildDashboardContext) => Promise<{
|
|
3
3
|
message: string;
|
|
4
4
|
}>;
|
|
5
|
-
//# sourceMappingURL=add-dashboard-widgets.d.ts.map
|
|
@@ -1,4 +1,3 @@
|
|
|
1
1
|
import { BuildDashboardContext, DashboardSummary, buildDashboardSchema } from './types';
|
|
2
2
|
import { default as z } from 'zod/v4';
|
|
3
3
|
export declare function buildDashboardEngine(params: z.infer<typeof buildDashboardSchema>, context: BuildDashboardContext): Promise<DashboardSummary>;
|
|
4
|
-
//# sourceMappingURL=build-dashboard-engine.d.ts.map
|
|
@@ -4,4 +4,3 @@ import { BaseDashboardSummary, ExtendedDashboardProps } from './types';
|
|
|
4
4
|
* Returns `undefined` when `dashboardState` has not yet been computed.
|
|
5
5
|
*/
|
|
6
6
|
export declare const getBaseDashboardSummary: (dashboardProps: ExtendedDashboardProps) => BaseDashboardSummary | undefined;
|
|
7
|
-
//# sourceMappingURL=build-dashboard-service.d.ts.map
|
|
@@ -2,4 +2,3 @@ import { CreateDashboardParams, BuildDashboardContext } from './types';
|
|
|
2
2
|
export declare const createDashboard: ({ dashboardTitle, widgetIdsToAdd }: CreateDashboardParams, context: BuildDashboardContext) => Promise<{
|
|
3
3
|
message: string;
|
|
4
4
|
}>;
|
|
5
|
-
//# sourceMappingURL=create-dashboard.d.ts.map
|
|
@@ -1,2 +1 @@
|
|
|
1
1
|
export declare const FILTER_FACTORY_TYPES: "import {\n\tDateDimension,\n\tLevelAttribute,\n\tAttribute,\n\tMeasure,\n\tFilter,\n\tBaseMeasure,\n\tFilterRelationsNode,\n\tFilterRelations,\n\tMembersFilterConfig,\n\tBaseFilterConfig,\n} from '../interfaces.js';\n/**\n * Creates a filter representing the union of multiple filters on the same attribute. The resulting\n * union filter filters on items that match any of the given filters.\n *\n * To create 'or' filters using different attributes, use the {@link logic.and | `or()`} function.\n *\n * @example\n * Filter for countries that start with the letter 'A' **or** end with the letter 'A'\n * in the Sample ECommerce data model.\n * ```ts\n * filterFactory.union([\n * filterFactory.startsWith(DM.Country.Country, 'A'),\n * filterFactory.endsWith(DM.Country.Country, 'A'),\n * ])\n * ```\n * @param filters - Filters to union. The filters must all be on the same attribute.\n * @param config - Optional configuration for the filter\n * @returns A filter instance\n */\nexport declare function union(filters: Filter[], config?: BaseFilterConfig): Filter;\n/**\n * Creates a filter representing the intersection of multiple filters on the same attribute. The resulting\n * intersection filter filters on items that match all of the given filters.\n *\n * To create 'and' filters using different attributes, use the {@link logic.and | `and()`} function.\n *\n * @example\n * Filter for countries that start with the letter 'A' **and** end with the letter 'A'\n * in the Sample ECommerce data model.\n * ```ts\n * filterFactory.intersection([\n * filterFactory.startsWith(DM.Country.Country, 'A'),\n * filterFactory.endsWith(DM.Country.Country, 'A'),\n * ])\n * ```\n * @param filters - Filters to intersect. The filters must all be on the same attribute.\n * @param config - Optional configuration for the filter\n * @returns A filter instance\n */\nexport declare function intersection(filters: Filter[], config?: BaseFilterConfig): Filter;\n/**\n * Creates a filter that excludes items matching the given filter\n * from all items or from items matching the optional input filter.\n *\n * @example\n * Filter for items where the country name does not contain the letter 'A'\n * from the Sample ECommerce data model.\n * ```ts\n * filterFactory.exclude(filterFactory.contains(DM.Country.Country, 'A'))\n * ```\n *\n * Filter for items where the country name starts with the letter 'B' but does not contain the letter 'A'\n * from the Sample ECommerce data model. This filter will match countries like 'Belgium', but will not\n * match countries like 'Bermuda'.\n * ```ts\n * filterFactory.exclude(\n * filterFactory.contains(DM.Country.Country, 'A'),\n * filterFactory.startsWith(DM.Country.Country, 'B')\n * )\n * ```\n * @param filter - Filter to exclude\n * @param input - Input filter to exclude from, on the same attribute. If not provided, the filter excludes from all items.\n * @param config - Optional configuration for the filter\n * @returns A filter representing an exclusion of the given filter\n * from all attribute members or from the optional input filter\n */\nexport declare function exclude(filter: Filter, input?: Filter, config?: BaseFilterConfig): Filter;\n/**\n * Creates a filter to isolate attribute values that do not contain a specified string.\n *\n * Matching is case insensitive.\n *\n * You can optionally use wildcard characters for pattern matching, as described in the\n * {@link like | `like()`} function.\n *\n * @example\n * Filter for categories in the Sample ECommerce data model where the category name doesn't contain\n * 'digital'. This filter matches categories not like 'Digital Cameras' and 'MP3 & Digital Media Players'.\n * ```ts\n * filterFactory.contains(DM.Category.Category, 'digital')\n * ```\n * @param attribute - Text attribute to filter on\n * @param value - Value to filter by\n * @param config - Optional configuration for the filter\n * @returns A filter instance\n */\nexport declare function doesntContain(\n\tattribute: Attribute,\n\tvalue: string,\n\tconfig?: BaseFilterConfig,\n): Filter;\n/**\n * Creates a filter to isolate attribute values that do not end with a specified string.\n *\n * Matching is case insensitive.\n *\n * You can optionally use wildcard characters for pattern matching, as described in the\n * {@link like | `like()`} function.\n *\n * @example\n * Filter for countries in the Sample ECommerce data model where the country name doesn't end with\n * 'land'. This filter matches countries not like 'Iceland' and 'Ireland'.\n * ```ts\n * filterFactory.doesntEndWith(DM.Country.Country, 'land')\n * ```\n * @param attribute - Text attribute to filter on\n * @param value - Value to filter by\n * @param config - Optional configuration for the filter\n * @returns A filter instance\n */\nexport declare function doesntEndWith(\n\tattribute: Attribute,\n\tvalue: string,\n\tconfig?: BaseFilterConfig,\n): Filter;\n/**\n * Creates a filter to isolate attribute values that do not start with a specified string.\n *\n * Matching is case insensitive.\n *\n * You can optionally use wildcard characters for pattern matching, as described in the\n * {@link like | `like()`} function.\n *\n * @example\n * Filter for countries in the Sample ECommerce data model where the country name doesn't start with\n * 'United'. This filter matches countries not like 'United States' and 'United Kingdom'.\n * ```ts\n * filterFactory.doesntStartWith(DM.Country.Country, 'United')\n * ```\n * @param attribute - Text attribute to filter on\n * @param value - Value to filter by\n * @param config - Optional configuration for the filter\n * @returns A filter instance\n */\nexport declare function doesntStartWith(\n\tattribute: Attribute,\n\tvalue: string,\n\tconfig?: BaseFilterConfig,\n): Filter;\n/**\n * Creates a filter to isolate attribute values that contain a specified string.\n *\n * Matching is case insensitive.\n *\n * You can optionally use wildcard characters for pattern matching, as described in the\n * {@link like | `like()`} function.\n *\n * @example\n * Filter for categories in the Sample ECommerce data model where the category name contains\n * 'digital'. This filter matches categories like 'Digital Cameras' and 'MP3 & Digital Media Players'.\n * ```ts\n * filterFactory.contains(DM.Category.Category, 'digital')\n * ```\n * @param attribute - Text attribute to filter on\n * @param value - Value to filter by\n * @param config - Optional configuration for the filter\n * @returns A filter instance\n */\nexport declare function contains(\n\tattribute: Attribute,\n\tvalue: string,\n\tconfig?: BaseFilterConfig,\n): Filter;\n/**\n * Creates a filter to isolate attribute values that end with a specified string.\n *\n * Matching is case insensitive.\n *\n * You can optionally use wildcard characters for pattern matching, as described in the\n * {@link like | `like()`} function.\n *\n * @example\n * Filter for countries in the Sample ECommerce data model where the country name ends with\n * 'land'. This filter matches countries like 'Ireland' and 'Iceland'.\n * ```ts\n * filterFactory.endsWith(DM.Country.Country, 'land')\n * ```\n * @param attribute - Text attribute to filter on\n * @param value - Value to filter by\n * @param config - Optional configuration for the filter\n * @returns A filter instance\n */\nexport declare function endsWith(\n\tattribute: Attribute,\n\tvalue: string,\n\tconfig?: BaseFilterConfig,\n): Filter;\n/**\n * Creates a filter to isolate attribute values that start with a specified string.\n *\n * Matching is case insensitive.\n *\n * You can optionally use wildcard characters for pattern matching, as described in the\n * {@link like | `like()`} function.\n *\n * @example\n * Filter for countries in the Sample ECommerce data model where the country name starts with\n * 'United'. This filter matches countries like 'United States' and 'United Kingdom'.\n * ```ts\n * filterFactory.startsWith(DM.Country.Country, 'United')\n * ```\n * @param attribute - Text attribute to filter on\n * @param value - Value to filter by\n * @param config - Optional configuration for the filter\n * @returns A filter instance\n */\nexport declare function startsWith(\n\tattribute: Attribute,\n\tvalue: string,\n\tconfig?: BaseFilterConfig,\n): Filter;\n/**\n * Creates a filter to isolate attribute values that match a specified string pattern.\n *\n * The pattern can include the following wildcard characters:\n *\n * + `_`: Matches a single character\n * + `%`: Matches multiple characters\n *\n * To search for a literal underscore (`_`) or percent symbol (`%`), use the backslash (`\\`) escape\n * character.\n *\n * Matching is case insensitive.\n *\n * @example\n * Filter for countries from the Sample ECommerce data model where the country name starts with an\n * 'A' and ends with an 'a'. This filter matches countries like 'Argentina' and 'Australia'.\n * ```ts\n * filterFactory.like(DM.Country.Country, 'A%a')\n * ```\n * @param attribute - Text attribute to filter on\n * @param value - Value to filter by\n * @param config - Optional configuration for the filter\n * @returns A filter instance\n */\nexport declare function like(\n\tattribute: Attribute,\n\tvalue: string,\n\tconfig?: BaseFilterConfig,\n): Filter;\n/**\n * Creates a filter to isolate attribute values that do not equal a specified string or number.\n *\n * When filtering against a string:\n *\n * + Matching is case insensitive.\n * + You can optionally use wildcard characters for pattern matching, as described in the\n * {@link like | `like()`} function.\n *\n * @example\n * Filter for items not in new condition from the Sample ECommerce data model.\n * ```ts\n * filterFactory.doesntEqual(DM.Commerce.Condition, 'New')\n * ```\n * @param attribute - Text or numeric attribute to filter on\n * @param value - Value to filter by\n * @param config - Optional configuration for the filter\n * @returns A filter instance\n */\nexport declare function doesntEqual(\n\tattribute: Attribute,\n\tvalue: string | number,\n\tconfig?: BaseFilterConfig,\n): Filter;\n/**\n * Creates a filter to isolate attribute values that equal a specified string or number.\n *\n * When filtering against a string:\n *\n * + Matching is case insensitive.\n * + You can optionally use wildcard characters for pattern matching, as described in the\n * {@link like | `like()`} function.\n *\n * @example\n * Filter for items in new condition from the Sample ECommerce data model.\n * ```ts\n * filterFactory.equals(DM.Commerce.Condition, 'New')\n * ```\n * @param attribute - Text or numeric attribute to filter on\n * @param value - Value to filter by\n * @param config - Optional configuration for the filter\n * @returns A filter instance\n */\nexport declare function equals(\n\tattribute: Attribute,\n\tvalue: string | number,\n\tconfig?: BaseFilterConfig,\n): Filter;\n/**\n * Creates a filter to isolate attribute values strictly greater than a specified number.\n *\n * @example\n * Filter for items where the cost is greater than 100 from the Sample ECommerce data model.\n * ```ts\n * filterFactory.greaterThan(DM.Commerce.Cost, 100)\n * ```\n * @param attribute - Numeric attribute to filter on\n * @param value - Value to filter by\n * @param config - Optional configuration for the filter\n * @returns A filter instance\n */\nexport declare function greaterThan(\n\tattribute: Attribute,\n\tvalue: number,\n\tconfig?: BaseFilterConfig,\n): Filter;\n/**\n * Creates a filter to isolate attribute values greater than or equal to a specified number.\n *\n * @example\n * Filter for items where the cost is greater than or equal to 100 from the Sample ECommerce data model.\n * ```ts\n * filterFactory.greaterThanOrEqual(DM.Commerce.Cost, 100)\n * ```\n * @param attribute - Numeric attribute to filter on\n * @param value - Value to filter by\n * @param config - Optional configuration for the filter\n * @returns A filter instance\n */\nexport declare function greaterThanOrEqual(\n\tattribute: Attribute,\n\tvalue: number,\n\tconfig?: BaseFilterConfig,\n): Filter;\n/**\n * Creates a filter to isolate attribute values strictly less than a specified number.\n *\n * @example\n * Filter for items where the cost is less than 100 from the Sample ECommerce data model.\n * ```ts\n * filterFactory.lessThan(DM.Commerce.Cost, 100)\n * ```\n * @param attribute - Numeric attribute to filter on\n * @param value - Value to filter by\n * @param config - Optional configuration for the filter\n * @returns A filter instance\n */\nexport declare function lessThan(\n\tattribute: Attribute,\n\tvalue: number,\n\tconfig?: BaseFilterConfig,\n): Filter;\n/**\n * Creates a filter to isolate attribute values less than or equal to a specified number.\n *\n * @example\n * Filter for items where the cost is less than or equal to 100 from the Sample ECommerce data model.\n * ```ts\n * filterFactory.lessThanOrEqual(DM.Commerce.Cost, 100)\n * ```\n * @param attribute - Numeric attribute to filter on\n * @param value - Value to filter by\n * @param config - Optional configuration for the filter\n * @returns A filter instance\n */\nexport declare function lessThanOrEqual(\n\tattribute: Attribute,\n\tvalue: number,\n\tconfig?: BaseFilterConfig,\n): Filter;\n/**\n * Creates a filter to isolate attribute values within or exactly matching two specified numerical boundaries.\n *\n * @example\n * Filter for items from the Sample ECommerce data model where the cost is greater than or equal to 100 and less than or equal to 200.\n * ```ts\n * filterFactory.between(DM.Commerce.Cost, 100, 200)\n * ```\n * @param attribute - Numeric attribute to filter on\n * @param valueA - Value to filter from\n * @param valueB - Value to filter to\n * @param config - Optional configuration for the filter\n * @returns A filter instance\n */\nexport declare function between(\n\tattribute: Attribute,\n\tvalueA: number,\n\tvalueB: number,\n\tconfig?: BaseFilterConfig,\n): Filter;\n/**\n * Creates a filter that isolates attribute values strictly within two specified numerical boundaries.\n *\n * @example\n * Filter for items from the Sample ECommerce data model where the cost is greater than 100 and less than 200.\n * ```ts\n * filterFactory.betweenNotEqual(DM.Commerce.Cost, 100, 200)\n * ```\n * @param attribute - Numeric attribute to filter on\n * @param valueA - Value to filter from\n * @param valueB - Value to filter to\n * @param config - Optional configuration for the filter\n * @returns A filter instance\n */\nexport declare function betweenNotEqual(\n\tattribute: Attribute,\n\tvalueA: number,\n\tvalueB: number,\n\tconfig?: BaseFilterConfig,\n): Filter;\n/**\n * Creates a custom numeric filter that filters for given attribute values.\n *\n * @example\n * Filter for items where the cost is greater than 100 and less than 200\n * from the Sample ECommerce data model.\n * ```ts\n * filterFactory.numeric(\n * DM.Commerce.Cost,\n * NumericOperators.From,\n * 100,\n * NumericOperators.To,\n * 200\n * )\n * ```\n * @param attribute - Numeric attribute to filter\n * @param operatorA - First operator\n * @param valueA - First value\n * @param operatorB - Second operator\n * @param valueB - Second value\n * @param config - Optional configuration for the filter\n * @returns A custom numeric filter of the given attribute\n */\nexport declare function numeric(\n\tattribute: Attribute,\n\toperatorA?: string,\n\tvalueA?: number,\n\toperatorB?: string,\n\tvalueB?: number,\n\tconfig?: BaseFilterConfig,\n): Filter;\n/**\n * Creates a filter to isolate attribute values that match any of the specified strings.\n *\n * Matching is case sensitive.\n *\n * @example\n * Filter for items where the condition is 'Used' or 'Refurbished'\n * from the Sample ECommerce data model.\n * ```ts\n * filterFactory.members(DM.Commerce.Condition, ['Used', 'Refurbished'])\n * ```\n * @param attribute - Attribute to filter on\n * @param members - Array of member values to filter by\n * @param config - Optional configuration for the filter\n * @returns A filter instance\n * @shortDescription Creates filter on attribute to match certain string values\n */\nexport declare function members(\n\tattribute: Attribute,\n\tmembers: string[],\n\tconfig?: MembersFilterConfig,\n): Filter;\n/**\n * Creates a filter to isolate date values starting from and including the given date and level.\n *\n * @example\n * Filter for items in the Sample ECommerce data model where the date is not before the year 2010.\n * ```ts\n * filterFactory.dateFrom(DM.Commerce.Date.Years, '2010-01')\n * ```\n * @param level - Date {@link LevelAttribute} to filter on\n * @param from - Date or string representing the value to filter from\n * @param config - Optional configuration for the filter\n * @returns A filter instance\n */\nexport declare function dateFrom(\n\tlevel: LevelAttribute,\n\tfrom: Date | string,\n\tconfig?: BaseFilterConfig,\n): Filter;\n/**\n * Creates a filter to isolate items up until and including the given date and level.\n *\n * @example\n * Filter for items where the date is from the year 2010 or earlier in the Sample ECommerce data model.\n * ```ts\n * filterFactory.dateTo(DM.Commerce.Date.Years, '2010-01')\n * ```\n * @param level - Date {@link LevelAttribute} to filter on\n * @param to - Date or string representing the last member to filter to\n * @param config - Optional configuration for the filter\n * @returns A filter instance\n */\nexport declare function dateTo(\n\tlevel: LevelAttribute,\n\tto: Date | string,\n\tconfig?: BaseFilterConfig,\n): Filter;\n/**\n * Creates a filter to isolate items between and including the given dates and level.\n *\n * @example\n * Filter for items in the Sample ECommerce data model where the date is from the years 2009, 2010, or 2011.\n * ```ts\n * filterFactory.dateRange(DM.Commerce.Date.Years, '2009-01', '2011-01')\n * ```\n * @param level - Date {@link LevelAttribute} to filter on\n * @param from - Date or string representing the start member to filter from\n * @param to - Date or string representing the end member to filter to\n * @param config - Optional configuration for the filter\n * @returns A filter instance\n */\nexport declare function dateRange(\n\tlevel: LevelAttribute,\n\tfrom?: Date | string,\n\tto?: Date | string,\n\tconfig?: BaseFilterConfig,\n): Filter;\n/**\n * Creates a filter to isolate items with a date dimension value within a specified range after a\n * given date and level.\n *\n * Although the `offset` can be used to set a beginning date prior to the `anchor`, the filter range always\n * continues forward after the offset beginning date. So, using an `offset` of `-6` and a `count` of `18` when `level`\n * is a month level creates a range that begins 6 month before the `anchor` date and extends to 12 months after\n * the `anchor` date.\n *\n * @example\n * Filter for items in the Sample ECommerce data model where the date is in 2011 or the first half of 2012.\n * ```ts\n * filterFactory.dateRelative(DM.Commerce.Date.Months, 0, 18, '2011-01'),\n * ```\n *\n * Filter for items in the Sample ECommerce data model where the date is in the second half of 2010 or in 2011.\n * ```ts\n * filterFactory.dateRelative(DM.Commerce.Date.Months, -6, 18, '2011-01'),\n * ```\n *\n * Filter for items in the Sample ECommerce data model where the date is in the past 6 months.\n * ```ts\n * filterFactory.dateRelative(DM.Commerce.Date.Months, -6, 6),\n * ```\n * @param level - Date {@link LevelAttribute} to filter on\n * @param offset - Number of levels to skip from the given `anchor` or the default of the current day.\n * Positive numbers skip forwards and negative numbers skip backwards (e.g. `-6` is 6 months backwards when `level` is a months level attribute)\n * @param count - Number of levels to include in the filter (e.g. `6` is 6 months when `level` is a months level attribute)\n * @param anchor - Date to filter from, defaults to the current day\n * @param config - Optional configuration for the filter\n * @returns A filter instance\n */\nexport declare function dateRelative(\n\tlevel: LevelAttribute,\n\toffset: number,\n\tcount: number,\n\tanchor?: Date | string,\n\tconfig?: BaseFilterConfig,\n): Filter;\n/**\n * Creates a filter to isolate items with a date dimension value within a specified range after a\n * given date and level.\n *\n * @example\n * Filter for items in the Sample ECommerce data model where the date is in 2011 or the first half of 2012.\n * ```ts\n * filterFactory.dateRelativeFrom(DM.Commerce.Date.Months, 0, 18, '2011-01'),\n * ```\n * @param level - Date {@link LevelAttribute} to filter on\n * @param offset - Number of levels to skip from the given `anchor` or the default of the current day (e.g. `6` is 6 months when `level` is a months level attribute)\n * @param count - Number of levels to include in the filter (e.g. `6` is 6 months when `level` is a months level attribute)\n * @param anchor - Date to filter from, defaults to the current day\n * @param config - Optional configuration for the filter\n * @returns A filter instance\n */\nexport declare function dateRelativeFrom(\n\tlevel: LevelAttribute,\n\toffset: number,\n\tcount: number,\n\tanchor?: Date | string,\n\tconfig?: BaseFilterConfig,\n): Filter;\n/**\n * Creates a filter to isolate items with a date dimension value within a specified range before a\n * given date and level.\n *\n * @example\n * Filter for items in the Sample ECommerce data model where the date is in the first half of 2010 or in 2011.\n * ```ts\n * filterFactory.dateRelativeTo(DM.Commerce.Date.Months, 0, 18, '2011-12'),\n * ```\n * @param level - Date {@link LevelAttribute} to filter on\n * @param offset - Number of levels to skip from the given `anchor` or the default of the current day (e.g. `6` is 6 months when `level` is a months level attribute)\n * @param count - Number of levels to include in the filter (e.g. `6` is 6 months when `level` is a months level attribute)\n * @param anchor - Date to filter to, defaults to the current day\n * @param config - Optional configuration for the filter\n * @returns A filter instance\n */\nexport declare function dateRelativeTo(\n\tlevel: LevelAttribute,\n\toffset: number,\n\tcount: number,\n\tanchor?: Date | string,\n\tconfig?: BaseFilterConfig,\n): Filter;\n/**\n * Creates a filter to isolate items with a date dimension value in the current calendar year.\n *\n * @example\n * Filter for items where the date is in the current calendar year in the Sample ECommerce data model.\n * ```ts\n * filterFactory.thisYear(DM.Commerce.Date)\n * ```\n * @param dimension - Date dimension to filter\n * @param config - Optional configuration for the filter\n * @returns A filter instance\n */\nexport declare function thisYear(dimension: DateDimension, config?: BaseFilterConfig): Filter;\n/**\n * Creates a filter to isolate items with a date dimension value in the current calendar month.\n *\n * @example\n * Filter for items where the date is in the current calendar month in the Sample ECommerce data model.\n * ```ts\n * filterFactory.thisMonth(DM.Commerce.Date)\n * ```\n * @param dimension - Date dimension to filter\n * @param config - Optional configuration for the filter\n * @returns A filter instance\n */\nexport declare function thisMonth(dimension: DateDimension, config?: BaseFilterConfig): Filter;\n/**\n * Creates a filter to isolate items with a date dimension value in the current quarter.\n *\n * @example\n * Filter for items where the date is in the current quarter in the Sample ECommerce data model.\n * ```ts\n * filterFactory.thisQuarter(DM.Commerce.Date)\n * ```\n * @param dimension - Date dimension to filter\n * @param config - Optional configuration for the filter\n * @returns A filter instance\n */\nexport declare function thisQuarter(dimension: DateDimension, config?: BaseFilterConfig): Filter;\n/**\n * Creates a filter to isolate items with a date dimension value of the current date.\n *\n * @example\n * Filter for items where the date is today in the Sample ECommerce data model.\n * ```ts\n * filterFactory.today(DM.Commerce.Date)\n * ```\n * @param dimension - date dimension to filter\n * @param config - Optional configuration for the filter\n * @returns A filter instance\n */\nexport declare function today(dimension: DateDimension, config?: BaseFilterConfig): Filter;\n/**\n * Creates a filter on all measure values matching the provided criteria.\n *\n * @param attribute - Attribute to filter\n * @param measure - Measure to filter by\n * @param operatorA - Operator to apply on `valueA` ({@link NumericOperators})\n * @param valueA - First value\n * @param operatorB - Operator to apply on `valueB` ({@link NumericOperators})\n * @param valueB - Second value\n * @param config - Optional configuration for the filter\n * @returns A filter representing the provided logic\n * @internal\n */\nexport declare function measureBase(\n\tattribute: Attribute,\n\tmeasure: Measure,\n\toperatorA?: string,\n\tvalueA?: number,\n\toperatorB?: string,\n\tvalueB?: number,\n\tconfig?: BaseFilterConfig,\n): Filter;\n/**\n * Creates a filter to isolate a measure value equal to a given number.\n *\n * @example\n * Filter for categories that have an average revenue equal 50 in the Sample ECommerce data model.\n * ```ts\n * filterFactory.measureEquals(\n * measureFactory.average(DM.Commerce.Revenue),\n * 50\n * )\n * ```\n * @param measure - Measure to filter by\n * @param value - Value\n * @param config - Optional configuration for the filter\n * @returns A filter instance\n */\nexport declare function measureEquals(\n\tmeasure: BaseMeasure,\n\tvalue: number,\n\tconfig?: BaseFilterConfig,\n): Filter;\n/**\n * Creates a filter to isolate a measure value greater than to a given number.\n *\n * @example\n * Filter for categories that have an average revenue greater than\n * to 50 in the Sample ECommerce data model.\n * ```ts\n * filterFactory.measureGreaterThan(\n * measureFactory.average(DM.Commerce.Revenue),\n * 50\n * )\n * ```\n * @param measure - Measure to filter by\n * @param value - Min value\n * @param config - Optional configuration for the filter\n * @returns A filter instance\n */\nexport declare function measureGreaterThan(\n\tmeasure: BaseMeasure,\n\tvalue: number,\n\tconfig?: BaseFilterConfig,\n): Filter;\n/**\n * Creates a filter to isolate a measure value greater than or equal to a given number.\n *\n * @example\n * Filter for categories that have an average revenue greater than\n * or equal to 50 in the Sample ECommerce data model.\n * ```ts\n * filterFactory.measureGreaterThanOrEqual(\n * measureFactory.average(DM.Commerce.Revenue),\n * 50\n * )\n * ```\n * @param measure - Measure to filter by\n * @param value - Min value\n * @param config - Optional configuration for the filter\n * @returns A filter instance\n */\nexport declare function measureGreaterThanOrEqual(\n\tmeasure: BaseMeasure,\n\tvalue: number,\n\tconfig?: BaseFilterConfig,\n): Filter;\n/**\n * Creates a filter to isolate a measure value less than or equal to a given number.\n *\n * @example\n * Filter for categories that have an average revenue less than\n * or equal to 100 in the Sample ECommerce data model.\n * ```ts\n * filterFactory.measureLessThanOrEqual(\n * measureFactory.average(DM.Commerce.Revenue),\n * 100\n * )\n * ```\n * @param measure - Measure to filter by\n * @param value - Max value\n * @param config - Optional configuration for the filter\n * @returns A filter instance\n */\nexport declare function measureLessThanOrEqual(\n\tmeasure: BaseMeasure,\n\tvalue: number,\n\tconfig?: BaseFilterConfig,\n): Filter;\n/**\n * Creates a filter to isolate a measure value less than a given number.\n *\n * @example\n * Filter for categories that have an average revenue less than 100 in the Sample ECommerce data model.\n * ```ts\n * filterFactory.measureLessThan(\n * measureFactory.average(DM.Commerce.Revenue),\n * 100\n * )\n * ```\n * @param measure - Measure to filter by\n * @param value - Value\n * @param config - Optional configuration for the filter\n * @returns A filter instance\n */\nexport declare function measureLessThan(\n\tmeasure: BaseMeasure,\n\tvalue: number,\n\tconfig?: BaseFilterConfig,\n): Filter;\n/**\n * Creates a filter to isolate a measure value between or equal to two given numbers.\n *\n * @example\n * Filter for categories that have an average revenue greater than or equal to 50 and less than\n * or equal to 100 in the Sample ECommerce data model.\n * ```ts\n * filterFactory.measureBetween(\n * measureFactory.average(DM.Commerce.Revenue),\n * 50,\n * 100\n * )\n * ```\n * @param measure - Measure to filter by\n * @param valueA - Min value\n * @param valueB - Max value\n * @param config - Optional configuration for the filter\n * @returns A filter instance\n */\nexport declare function measureBetween(\n\tmeasure: BaseMeasure,\n\tvalueA: number,\n\tvalueB: number,\n\tconfig?: BaseFilterConfig,\n): Filter;\n/**\n * Creates a filter to isolate a measure value between but not equal to two given numbers.\n *\n * @example\n * Filter for categories that have an average revenue greater than 50 and less than\n * 100 in the Sample ECommerce data model.\n * ```ts\n * filterFactory.measureBetweenNotEqual(\n * measureFactory.average(DM.Commerce.Revenue),\n * 50,\n * 100\n * )\n * ```\n * @param measure - Measure to filter by\n * @param valueA - Min value\n * @param valueB - Max value\n * @param config - Optional configuration for the filter\n * @returns A filter instance\n */\nexport declare function measureBetweenNotEqual(\n\tmeasure: BaseMeasure,\n\tvalueA: number,\n\tvalueB: number,\n\tconfig?: BaseFilterConfig,\n): Filter;\n/**\n * Creates a filter to isolate items that rank towards the top for a given measure.\n *\n * @example\n * Filter for age ranges with the top 3 highest total revenue in the Sample ECommerce data model.\n * ```ts\n * filterFactory.topRanking(\n * DM.Commerce.AgeRange,\n * measureFactory.sum(DM.Commerce.Revenue),\n * 3\n * )\n * ```\n * @param attribute - Attribute to filter\n * @param measure - Measure to filter by\n * @param count - Number of members to return\n * @param config - Optional configuration for the filter\n * @returns A filter instance\n */\nexport declare function topRanking(\n\tattribute: Attribute,\n\tmeasure: Measure,\n\tcount: number,\n\tconfig?: BaseFilterConfig,\n): Filter;\n/**\n * Creates a filter to isolate items that rank towards the bottom for a given measure.\n *\n * @example\n * Filter for age ranges with the bottom 3 lowest total revenue in the Sample ECommerce data model.\n * ```ts\n * filterFactory.bottomRanking(\n * DM.Commerce.AgeRange,\n * measureFactory.sum(DM.Commerce.Revenue),\n * 3\n * )\n * ```\n * @param attribute - Attribute to filter\n * @param measure - Measure to filter by\n * @param count - Number of members to return\n * @param config - Optional configuration for the filter\n * @returns A filter instance\n */\nexport declare function bottomRanking(\n\tattribute: Attribute,\n\tmeasure: Measure,\n\tcount: number,\n\tconfig?: BaseFilterConfig,\n): Filter;\n/**\n * Creates a filter that contains a list of dependent/cascading filters,\n * where each filter depends on the results or state of the previous ones in the array.\n *\n * Each filter in the array operates in the context of its predecessors, and the\n * cascading behavior ensures that all filters are applied sequentially.\n *\n * @example\n * ```ts\n * // Create a cascading filter for gender and age range\n * const cascadingFilter = filterFactory.cascading(\n * [\n * filterFactory.members(DM.Commerce.Gender, ['Male', 'Female']),\n * filterFactory.members(DM.Commerce.AgeRange, ['0-18']),\n * ],\n * { disabled: true }, // Optional configuration to disable the cascading filter\n * );\n * ```\n * @param filters - Array of dependent filters\n * @param config - Optional configuration for the filter\n * @returns A filter instance\n */\nexport declare function cascading(filters: Filter[], config?: BaseFilterConfig): Filter;\n/**\n * Set of logic operators for filter relations construction\n *\n * These operators are still in beta.\n *\n * @example\n * ```ts\n * import { filters } from '@sisense/sdk-data';\n *\n * // define filters\n * const revenueFilter = filterFactory.greaterThan(DM.Commerce.Revenue, 1000);\n * const countryFilter = filterFactory.members(DM.Commerce.Country, ['USA', 'Canada']);\n * const genderFilter = filterFactory.doesntContain(DM.Commerce.Gender, 'Unspecified');\n * const costFilter = filterFactory.between(DM.Commerce.Cost, 1000, 2000);\n *\n * // create filter relations of two filters\n * const orFilerRelations = filterFactory.logic.or(revenueFilter, countryFilter);\n * // revenueFilter OR countryFilter\n *\n * // filter relations can have nested filter relations\n * const mixedFilterRelations = filterFactory.logic.and(genderFilter, orFilerRelations);\n * // genderFilter AND (revenueFilter OR countryFilter)\n *\n * // array, specified in filter relations, will be converted to an intersection of filters automatically\n * const arrayFilterRelations = filterFactory.logic.or([genderFilter, costFilter], mixedFilterRelations);\n * // (genderFilter AND costFilter) OR (genderFilter AND (revenueFilter OR countryFilter))\n * ```\n * @beta\n */\nexport declare namespace logic {\n\t/**\n\t * Creates an 'AND' filter relations\n\t *\n\t * @example\n\t * Create filter relations for items that have a revenue greater than 100 and are in new condition\n\t * in the Sample ECommerce data model.\n\t * ```ts\n\t * const revenueFilter = filterFactory.greaterThan(DM.Commerce.Revenue, 100);\n\t * const conditionFilter = filterFactory.equals(DM.Commerce.Condition, 'New');\n\t *\n\t * const andFilerRelation = filterFactory.logic.and(revenueFilter, conditionFilter);\n\t * ```\n\t * @param left First filter or filter relations\n\t * @param right Second filter or filter relations\n\t * @returns Filter relations\n\t * @beta\n\t */\n\tconst and: (left: FilterRelationsNode, right: FilterRelationsNode) => FilterRelations;\n\t/**\n\t * Creates an 'OR' filter relations\n\t *\n\t * @example\n\t * Create filter relations for items that have a revenue greater than 100 or are in new condition\n\t * in the Sample ECommerce data model.\n\t * ```ts\n\t * const revenueFilter = filterFactory.greaterThan(DM.Commerce.Revenue, 100);\n\t * const conditionFilter = filterFactory.equals(DM.Commerce.Condition, 'New');\n\t *\n\t * const orFilerRelation = filterFactory.logic.or(revenueFilter, conditionFilter);\n\t * ```\n\t * @param left First filter or filter relations\n\t * @param right Second filter or filter relations\n\t * @returns Filter relations\n\t * @beta\n\t */\n\tconst or: (left: FilterRelationsNode, right: FilterRelationsNode) => FilterRelations;\n}\n/**\n * Creates a filter from JAQL\n *\n * @param attribute - Attribute to filter\n * @param jaql - Filter Jaql\n * @param config - Optional configuration for the filter\n * @returns A filter instance\n * @internal\n */\nexport declare function customFilter(\n\tattribute: Attribute,\n\tjaql: any,\n\tconfig?: BaseFilterConfig,\n): Filter;";
|
|
2
|
-
//# sourceMappingURL=filter-factory-types.d.ts.map
|
|
@@ -1,2 +1 @@
|
|
|
1
1
|
export declare const MEASURE_FACTORY_TYPES: "import {\n\tAttribute,\n\tMeasure,\n\tFilter,\n\tCalculatedMeasure,\n\tBaseMeasure,\n\tCustomFormulaContext,\n} from '../interfaces.js';\nimport { ForecastFormulaOptions, TrendFormulaOptions } from '../../interfaces.js';\nimport { CustomFormulaJaql } from '../filters/utils/types.js';\n/**\n * Defines the different numeric operators that can be used with numeric filters\n *\n * @internal\n */\nexport declare const RankingTypes: {\n\t/**\n\t * In competition ranking, items that rank equally receive the same ranking number, and then a gap is left after the equally ranked items in the ranking numbers.\n\t */\n\tStandardCompetition: string;\n\t/**\n\t * In modified competition ranking, items that rank equally receive the same ranking number, and a gap is left before the equally ranked items in the ranking numbers.\n\t */\n\tModifiedCompetition: string;\n\t/**\n\t * In dense ranking, items that rank equally receive the same ranking number, and the next items receive the immediately following ranking number.\n\t */\n\tDense: string;\n\t/**\n\t * In ordinal ranking, all items receive distinct ordinal numbers, including items that rank equally. The assignment of distinct ordinal numbers for equal-ranking items is arbitrary.\n\t */\n\tOrdinal: string;\n};\n/**\n * Defines the different ranking sorting types supported by rank measure\n *\n * @internal\n */\nexport declare const RankingSortTypes: {\n\tAscending: string;\n\tDescending: string;\n};\n/**\n * Transforms a custom formula jaql into a calculated measure instance.\n *\n * As custom formulas can be nested, the function performs a recursive transformation via a helper function.\n *\n * @param jaql - Custom formula jaql\n * @returns Calculated measure instance\n * @internal\n */\nexport declare function transformCustomFormulaJaql(jaql: CustomFormulaJaql): CalculatedMeasure;\n/**\n * Creates a calculated measure for a valid custom formula built from [base functions](/guides/sdk/reference/functions.html#measured-value-functions).\n *\n * Use square brackets (`[]`) within the `formula` property to include dimensions, measures, or filters.\n * Each unique dimension, measure, or filter included in the `formula` must be defined using a property:value pair in the `context` parameter.\n *\n * You can nest custom formulas by placing one inside the `formula` parameter of another.\n *\n * Note: To use [shared formulas](https://docs.sisense.com/main/SisenseLinux/shared-formulas.htm)\n * from a Fusion instance, you must fetch them first using {@link @sisense/sdk-ui!useGetSharedFormula | useGetSharedFormula}.\n *\n * @example\n * An example of constructing a custom formulas using dimensions, measures, and nested custom formulas\n * from the Sample Ecommerce data model.\n * ```ts\n * // Custom formula\n * const profitabilityRatio = measureFactory.customFormula(\n * 'Profitability Ratio',\n * '([totalRevenue] - SUM([cost])) / [totalRevenue]',\n * {\n * totalRevenue: measureFactory.sum(DM.Commerce.Revenue),\n * cost: DM.Commerce.Cost,\n * },\n * );\n *\n * // Nested custom formula\n * const profitabilityRatioRank = measureFactory.customFormula(\n * 'Profitability Ratio Rank',\n * 'RANK([profRatio], \"ASC\", \"1224\")',\n * {\n * profRatio: profitabilityRatio,\n * },\n * );\n * ```\n *\n * Another example of constructing a custom formula using measures and filters\n * ```ts\n * const totalCostWithFilter = measureFactory.customFormula(\n * 'Total Cost with Filter',\n * '(SUM([cost]), [categoryFilter])',\n * {\n * cost: DM.Commerce.Cost,\n * categoryFilter: filterFactory.members(DM.Category.Category, ['Apple Mac Desktops']),\n * },\n * );\n * ```\n * @param title - Title of the measure to be displayed in legend\n * @param formula - Formula to be used for the measure\n * @param context - Formula context as a map of strings to attributes, measures, or filters\n * @returns A calculated measure instance\n * @group Advanced Analytics\n */\nexport declare function customFormula(\n\ttitle: string,\n\tformula: string,\n\tcontext: CustomFormulaContext,\n): CalculatedMeasure;\n/**\n * Creates an aggregated measure.\n *\n * This is a base function to build other aggregation functions (e.g., `sum`, `average`, etc.)\n * as listed in {@link AggregationTypes}.\n *\n * @example\n * Calculate the total cost across all items in a category from the Sample Ecommerce data model.\n * ```ts\n * measureFactory.aggregate(DM.Commerce.Cost, 'sum'),\n * ```\n * @param attribute - Attribute to aggregate\n * @param aggregationType - Aggregation type. See {@link AggregationTypes}\n * @param name - Optional name for the new measure\n * @param format - Optional numeric formatting to apply using a Numeral.js format string. Can only be used for explicit queries. Cannot be used in charts, tables, etc.\n * @returns A measure instance\n * @group Aggregation\n */\nexport declare function aggregate(\n\tattribute: Attribute,\n\taggregationType: string,\n\tname?: string,\n\tformat?: string,\n): BaseMeasure;\n/**\n * Creates a calculated measure from a numeric value.\n *\n * @example\n * Creates a calculated measure from a numeric value.\n * ```ts\n * measureFactory.constant(42)\n * ```\n * @param value - Value to be returned as a measure\n * @returns A calculated measure instance\n * @group Arithmetic\n */\nexport declare function constant(value: number): CalculatedMeasure;\n/**\n * Creates a sum aggregation measure over the given attribute.\n *\n * To create a running sum, use {@link runningSum}.\n *\n * @example\n * Calculate the total cost across all items in a category from the Sample Ecommerce data model.\n * ```ts\n * measureFactory.sum(DM.Commerce.Cost)\n * ```\n * @param attribute - Attribute to aggregate\n * @param name - Optional name for the new measure\n * @param format - Optional numeric formatting to apply using a Numeral.js format string. Can only be used for explicit queries. Cannot be used in charts, tables, etc.\n * @returns A measure instance\n * @group Aggregation\n */\nexport declare function sum(attribute: Attribute, name?: string, format?: string): BaseMeasure;\n/**\n * Creates an average aggregation measure over the given attribute.\n *\n * Both `average()` and `avg()` can be used interchangeably.\n *\n * @example\n * Calculate the average cost across all items in a category from the Sample Ecommerce data model.\n * ```ts\n * measureFactory.average(DM.Commerce.Cost)\n * ```\n * @param attribute - Attribute to aggregate\n * @param name - Optional name for the new measure\n * @param format - Optional numeric formatting to apply using a Numeral.js format string. Can only be used for explicit queries. Cannot be used in charts, tables, etc.\n * @returns A measure instance\n * @group Aggregation\n */\nexport declare function average(attribute: Attribute, name?: string, format?: string): BaseMeasure;\n/**\n * {@inheritDoc average}\n *\n * @example\n * Calculate the average cost across all items in a category from the Sample Ecommerce data model.\n * ```ts\n * measureFactory.avg(DM.Commerce.Cost)\n * ```\n * @group Aggregation\n */\nexport declare function avg(attribute: Attribute, name?: string, format?: string): BaseMeasure;\n/**\n * Creates a min aggregation measure over the given attribute.\n *\n * @example\n * Calculate the minimum cost across all items in a category from the Sample Ecommerce data model.\n * ```ts\n * measureFactory.min(DM.Commerce.Cost)\n * ```\n * @param attribute - Attribute to aggregate\n * @param name - Optional name for the new measure\n * @param format - Optional numeric formatting to apply using a Numeral.js format string. Can only be used for explicit queries. Cannot be used in charts, tables, etc.\n * @returns A measure instance\n * @group Aggregation\n */\nexport declare function min(attribute: Attribute, name?: string, format?: string): BaseMeasure;\n/**\n * Creates a max aggregation measure over the given attribute.\n *\n * @example\n * Calculate the maximum cost across all items in a category from the Sample Ecommerce data model.\n * ```ts\n * measureFactory.max(DM.Commerce.Cost)\n * ```\n * @param attribute - Attribute to aggregate\n * @param name - Optional name for the new measure\n * @param format - Optional numeric formatting to apply using a Numeral.js format string. Can only be used for explicit queries. Cannot be used in charts, tables, etc.\n * @returns A measure instance\n * @group Aggregation\n */\nexport declare function max(attribute: Attribute, name?: string, format?: string): BaseMeasure;\n/**\n * Creates a median aggregation measure over the given attribute.\n *\n * @example\n * Calculate the median cost across all items in a category from the Sample Ecommerce data model.\n * ```ts\n * measureFactory.median(DM.Commerce.Cost)\n * ```\n * @param attribute - Attribute to aggregate\n * @param name - Optional name for the new measure\n * @param format - Optional numeric formatting to apply using a Numeral.js format string. Can only be used for explicit queries. Cannot be used in charts, tables, etc.\n * @returns A measure instance\n * @group Aggregation\n */\nexport declare function median(attribute: Attribute, name?: string, format?: string): BaseMeasure;\n/**\n * Creates a count aggregation measure over the given attribute.\n *\n * To count distinct values in the given attribute, use {@link countDistinct}.\n *\n * @example\n * Counts the number of Commerce items from the Sample Ecommerce data model.\n * ```ts\n * measureFactory.count(DM.Commerce.BrandID)\n * ```\n * @param attribute - Attribute to aggregate\n * @param name - Optional name for the new measure\n * @param format - Optional numeric formatting to apply using a Numeral.js format string. Can only be used for explicit queries. Cannot be used in charts, tables, etc.\n * @returns A measure instance\n * @group Aggregation\n */\nexport declare function count(attribute: Attribute, name?: string, format?: string): BaseMeasure;\n/**\n * Creates a count distinct aggregation measure over the given attribute.\n *\n * To count all values in the given attribute, use {@link count}.\n *\n * @example\n * Calculate the number of distinct brands from the Sample Ecommerce data model.\n * ```ts\n * measureFactory.countDistinct(DM.Brand.BrandID)\n * ```\n * @param attribute - Attribute to aggregate\n * @param name - Optional name for the new measure\n * @param format - Optional numeric formatting to apply using a Numeral.js format string. Can only be used for explicit queries. Cannot be used in charts, tables, etc.\n * @returns A measure instance\n * @group Aggregation\n */\nexport declare function countDistinct(\n\tattribute: Attribute,\n\tname?: string,\n\tformat?: string,\n): BaseMeasure;\n/**\n * Creates a measured value with the given measure and set of filters.\n *\n * A measured value only includes values from items that match the provided filters.\n *\n * For example you can use a measured value to get a total cost for all items where the cost is greater than 100.\n *\n * Note that the filters on the measured value override the filters on the query, chart, or table the\n * measured value is used in.\n *\n * @example\n * Calculate the total cost across all items in a category from the Sample Ecommerce data model,\n * where the cost is greater than 100. Additional filtering on the cost will not affect this measure.\n * ```ts\n * measureFactory.measuredValue(\n * measureFactory.sum(DM.Commerce.Cost),\n * [filterFactory.greaterThan(DM.Commerce.Cost, 100)],\n * 'Cost Greater Than 100'\n * ),\n * ```\n * @param measure - Measure to filter\n * @param filters - Filters to apply to the measure\n * @param name - Optional name for the new measure\n * @param format - Optional numeric formatting to apply using a Numeral.js format string. Can only be used for explicit queries. Cannot be used in charts, tables, etc.\n * @returns A calculated measure instance\n * @group Advanced Analytics\n */\nexport declare function measuredValue(\n\tmeasure: Measure,\n\tfilters: Filter[],\n\tname?: string,\n\tformat?: string,\n): CalculatedMeasure;\n/**\n * Creates a calculated measure by adding two given numbers or measures.\n *\n * @example\n * ```ts\n * const measure1 = measureFactory.sum(DM.Dimension.Attribute1);\n * const measure2 = measureFactory.sum(DM.Dimension.Attribute2);\n * const measureSum = measureFactory.add(measure1, measure2);\n * ```\n * @param value1 - First value\n * @param value2 - Second value\n * @param name - Optional name for the new measure\n * @param withParentheses - Optional boolean flag whether to wrap the arithmetic operation with parentheses\n * @returns A calculated measure instance\n * @group Arithmetic\n */\nexport declare function add(\n\tvalue1: Measure | number,\n\tvalue2: Measure | number,\n\tname?: string,\n\twithParentheses?: boolean,\n): CalculatedMeasure;\n/**\n * Creates a calculated measure by subtracting two given numbers or measures. Subtracts `value2` from `value1`.\n *\n * @example\n * ```ts\n * const measure1 = measureFactory.sum(DM.Dimension.Attribute1);\n * const measure2 = measureFactory.sum(DM.Dimension.Attribute2);\n * const measureDifference = measureFactory.subtract(measure1, measure2);\n * ```\n * @param value1 - First value\n * @param value2 - Second value\n * @param name - Optional name for the new measure\n * @param withParentheses - Optional boolean flag whether to wrap the arithmetic operation with parentheses\n * @returns A calculated measure instance\n * @group Arithmetic\n */\nexport declare function subtract(\n\tvalue1: Measure | number,\n\tvalue2: Measure | number,\n\tname?: string,\n\twithParentheses?: boolean,\n): CalculatedMeasure;\n/**\n * Creates a calculated measure by multiplying two given numbers or measures.\n *\n * @example\n * ```ts\n * const measure1 = measureFactory.sum(DM.Dimension.Attribute1);\n * const measure2 = measureFactory.sum(DM.Dimension.Attribute2);\n * const measureProduct = measureFactory.multiply(measure1, measure2);\n * ```\n * @param value1 - First value\n * @param value2 - Second value\n * @param name - Optional name for the new measure\n * @param withParentheses - Optional boolean flag whether to wrap the arithmetic operation with parentheses\n * @returns A calculated measure instance\n * @group Arithmetic\n */\nexport declare function multiply(\n\tvalue1: Measure | number,\n\tvalue2: Measure | number,\n\tname?: string,\n\twithParentheses?: boolean,\n): CalculatedMeasure;\n/**\n * Creates a calculated measure by dividing two given numbers or measures. Divides `value1` by `value2`.\n *\n * @example\n * ```ts\n * const measure1 = measureFactory.sum(DM.Dimension.Attribute1);\n * const measure2 = measureFactory.sum(DM.Dimension.Attribute2);\n * const measureQuotient = measureFactory.divide(measure1, measure2);\n * ```\n * @param value1 - First value\n * @param value2 - Second value\n * @param name - Optional name for the new measure\n * @param withParentheses - Optional boolean flag whether to wrap the arithmetic operation with parentheses\n * @returns A calculated measure instance\n * @group Arithmetic\n */\nexport declare function divide(\n\tvalue1: Measure | number,\n\tvalue2: Measure | number,\n\tname?: string,\n\twithParentheses?: boolean,\n): CalculatedMeasure;\n/**\n * Creates a calculated measure that calculates the running total starting from the beginning\n * of the year up to the current day, week, month, or quarter.\n *\n * The time resolution is determined by the minimum date level of the date dimension in the query\n * that uses the returned measure.\n *\n * @example\n * Calculate the running total of total cost from the Sample Ecommerce data model, starting from the\n * beginning of the year up to the current day, week, month, or quarter.\n * ```ts\n * measureFactory.yearToDateSum(measureFactory.sum(DM.Commerce.Cost))\n * ```\n * @param measure - Measure to apply the YTD Sum to\n * @param name - Name for the new measure\n * @returns A calculated measure instance\n * @group Time-based\n */\nexport declare function yearToDateSum(measure: Measure, name?: string): CalculatedMeasure;\n/**\n * Creates a calculated measure that calculates the running total starting from the beginning\n * of the quarter up to the current day, week, or month.\n *\n * The time resolution is determined by the minimum date level of the date dimension in the query\n * that uses the returned measure.\n *\n * @example\n * Calculate the running total of total cost from the Sample Ecommerce data model, starting from the\n * beginning of the quarter up to the current day, week, or month.\n * ```ts\n * measureFactory.quarterToDateSum(measureFactory.sum(DM.Commerce.Cost))\n * ```\n * @param measure - Measure to apply the QTD Sum to\n * @param name - Name for the new measure\n * @returns A calculated measure instance\n * @group Time-based\n */\nexport declare function quarterToDateSum(measure: Measure, name?: string): CalculatedMeasure;\n/**\n * Creates a calculated measure that calculates the running total starting from the beginning\n * of the month up to the current day or week.\n *\n * The time resolution is determined by the minimum date level of the date dimension in the query\n * that uses the returned measure.\n *\n * @example\n * Calculate the running total of total cost from the Sample Ecommerce data model, starting from the\n * beginning of the month up to the current day or week.\n * ```ts\n * measureFactory.monthToDateSum(measureFactory.sum(DM.Commerce.Cost))\n * ```\n * @param measure - Measure to apply the MTD Sum to\n * @param name - Name for the new measure\n * @returns A calculated measure instance\n * @group Time-based\n */\nexport declare function monthToDateSum(measure: Measure, name?: string): CalculatedMeasure;\n/**\n * Creates a calculated measure that calculates the running total starting from the beginning\n * of the week up to the current day.\n *\n * The time resolution is determined by the minimum date level of the date dimension in the query\n * that uses the returned measure.\n *\n * @example\n * Calculate the running total of total cost from the Sample Ecommerce data model, starting from the\n * beginning of the week up to the current day.\n * ```ts\n * measureFactory.weekToDateSum(measureFactory.sum(DM.Commerce.Cost))\n * ```\n * @param measure - Measure to apply the WTD Sum to\n * @param name - Name for the new measure\n * @returns A calculated measure instance\n * @group Time-based\n */\nexport declare function weekToDateSum(measure: Measure, name?: string): CalculatedMeasure;\n/**\n * Creates a calculated measure that calculates the running total of a given measure.\n *\n * The running sum is calculated using the current sort order of the query it's used in.\n *\n * @example\n * Calculate the running sum of the total cost from the Sample Ecommerce data model across all categories.\n * ```ts\n * measureFactory.runningSum(measureFactory.sum(DM.Commerce.Cost)),\n * ```\n *\n * Running sum values from the Sample Ecommerce data model when categorizing by age range.\n * | AgeRange | Cost | Running Cost |\n * | --- | --- | --- |\n * | 0-18 | 4.32M | 4.32M |\n * | 19-24 | 8.66M | 12.98M |\n * | 25-34 | 21.19M | 34.16M |\n * | 35-44 | 23.64M | 57.8M |\n * | 45-54 | 20.39M | 78.19M |\n * | 55-64 | 11.82M | 90.01M |\n * | 65+ | 17.26M | 107.27M |\n * @param measure - Measure to apply the running sum to\n * @param _continuous - Boolean flag whether to accumulate the sum continuously\n * when there are two or more dimensions. The default value is false.\n * @param name - Name for the new measure\n * @returns A calculated measure instance\n * @group Statistics\n */\nexport declare function runningSum(\n\tmeasure: Measure,\n\t_continuous?: boolean,\n\tname?: string,\n): CalculatedMeasure;\n/**\n * Creates a calculated measure that calculates growth over a period of time.\n *\n * The time resolution is determined by the minimum date level of the date dimension in the query\n * that uses the returned measure.\n *\n * Growth is calculated using the following formula: `(currentPeriod \u2013 previousPeriod) / previousPeriod`.\n *\n * For example, if this period the value is 12 and the previous period's value was 10, the growth for\n * this period is 20%, returned as '0.2' (calculation: `(12 \u2013 10) / 10 = 0.2`).\n *\n * If the previous period's value is greater than the current period, the growth will be negative.\n *\n * For example, if this period the value is 80, and the previous period's was 100, the growth for\n * this period is -20%, returned as `-0.2` (calculation: `(80 \u2013 100) / 100 = -0.2`).\n *\n * @example\n * Calculate the growth in total cost this period in comparison to the previous period from the\n * Sample Ecommerce data model.\n * ```ts\n * measureFactory.growth(measureFactory.sum(DM.Commerce.Cost))\n * ```\n * @param measure - Measure to apply growth to\n * @param name - Name for the new measure\n * @returns A calculated measure instance\n * @group Statistics\n */\nexport declare function growth(measure: Measure, name?: string): CalculatedMeasure;\n/**\n * Creates a calculated measure that calculates growth rate over a period of time.\n *\n * The time resolution is determined by the minimum date level of the date dimension in the query\n * that uses the returned measure.\n *\n * Growth rate is calculated using the following formula: `currentPeriod / previousPeriod`.\n *\n * For example, if this period the value is 12 and the previous period's value was 10, the growth rate for\n * this period is 120%, returned as '1.2' (calculation: `12 / 10 = 1.2`).\n *\n * If the previous period's value is greater than the current period, the growth rate will be less than one.\n *\n * For example, if this period the value is 80, and the previous period's was 100, the growth for\n * this period is 80%, returned as `0.8` (calculation: `80 / 100 = .8`).\n *\n * @example\n * Calculate the growth rate in total cost this period in comparison to the previous period from the\n * Sample Ecommerce data model.\n * ```ts\n * measureFactory.growthRate(measureFactory.sum(DM.Commerce.Cost))\n * ```\n * @param measure - Measure to apply the Growth rate\n * @param name - Name for the new measure\n * @returns A calculated measure instance\n * @group Statistics\n */\nexport declare function growthRate(measure: Measure, name?: string): CalculatedMeasure;\n/**\n * Creates a calculated measure that calculates the growth from the previous week to the current week.\n *\n * The date dimension will be dynamically taken from the query that uses the returned measure.\n *\n * Growth is calculated using the following formula: `(currentWeek \u2013 previousWeek) / previousWeek`.\n *\n * For example, if this week the value is 12 and the previous week's value was 10, the growth for\n * this week is 20%, returned as '0.2' (calculation: `(12 \u2013 10) / 10 = 0.2`).\n *\n * If the previous week's value is greater than the current week, the growth will be negative.\n *\n * For example, if this week the value is 80, and the previous week's was 100, the growth for\n * this week is -20%, returned as `-0.2` (calculation: `(80 \u2013 100) / 100 = -0.2`).\n *\n * @example\n * Calculate the growth in total cost this week in comparison to the previous week from the Sample\n * Ecommerce data model.\n * ```ts\n * measureFactory.growthPastWeek(measureFactory.sum(DM.Commerce.Cost))\n * ```\n * @param measure - Measure to apply growth to\n * @param name - Name for the new measure\n * @returns A calculated measure instance\n * @group Statistics\n */\nexport declare function growthPastWeek(measure: Measure, name?: string): CalculatedMeasure;\n/**\n * Creates a calculated measure that calculates the growth from the previous month to the current month.\n *\n * The date dimension will be dynamically taken from the query that uses the returned measure.\n *\n * Growth is calculated using the following formula: `(currentMonth \u2013 previousMonth) / previousMonth`.\n *\n * For example, if this month the value is 12 and the previous month's value was 10, the growth for\n * this month is 20%, returned as '0.2' (calculation: `(12 \u2013 10) / 10 = 0.2`).\n *\n * If the previous month's value is greater than the current month, the growth will be negative.\n *\n * For example, if this month the value is 80, and the previous month's was 100, the growth for\n * this month is -20%, returned as `-0.2` (calculation: `(80 \u2013 100) / 100 = -0.2`).\n *\n * @example\n * Calculate the growth in total cost this month in comparison to the previous month from the Sample\n * Ecommerce data model.\n * ```ts\n * measureFactory.growthPastMonth(measureFactory.sum(DM.Commerce.Cost))\n * ```\n * @param measure - Measure to apply growth to\n * @param name - Name for the new measure\n * @returns A calculated measure instance\n * @group Statistics\n */\nexport declare function growthPastMonth(measure: Measure, name?: string): CalculatedMeasure;\n/**\n * Creates a calculated measure that calculates the growth from the previous quarter to the current quarter.\n *\n * The date dimension will be dynamically taken from the query that uses the returned measure.\n *\n * Growth is calculated using the following formula: `(currentQuarter \u2013 previousQuarter) / previousQuarter`.\n *\n * For example, if this quarter the value is 12 and the previous quarter's value was 10, the growth for\n * this quarter is 20%, returned as '0.2' (calculation: `(12 \u2013 10) / 10 = 0.2`).\n *\n * If the previous quarter's value is greater than the current quarter, the growth will be negative.\n *\n * For example, if this quarter the value is 80, and the previous quarter's was 100, the growth for\n * this quarter is -20%, returned as `-0.2` (calculation: `(80 \u2013 100) / 100 = -0.2`).\n *\n * @example\n * Calculate the growth in total cost this quarter in comparison to the previous quarter from the\n * Sample Ecommerce data model.\n * ```ts\n * measureFactory.growthPastQuarter(measureFactory.sum(DM.Commerce.Cost))\n * ```\n * @param measure - Measure to apply growth to\n * @param name - Name for the new measure\n * @returns A calculated measure instance\n * @group Statistics\n */\nexport declare function growthPastQuarter(measure: Measure, name?: string): CalculatedMeasure;\n/**\n * Creates a calculated measure that calculates the growth from the previous year to the current year.\n *\n * The date dimension will be dynamically taken from the query that uses the returned measure.\n *\n * Growth is calculated using the following formula: `(currentYear \u2013 previousYear) / previousYear`.\n *\n * For example, if this year the value is 12 and the previous year's value was 10, the growth for\n * this year is 20%, returned as '0.2' (calculation: `(12 \u2013 10) / 10 = 0.2`).\n *\n * If the previous year's value is greater than the current year, the growth will be negative.\n *\n * For example, if this year the value is 80, and the previous year's was 100, the growth for\n * this year is -20%, returned as `-0.2` (calculation: `(80 \u2013 100) / 100 = -0.2`).\n *\n * @example\n * Calculate the growth in total cost this year in comparison to the previous year from the Sample\n * Ecommerce data model.\n * ```ts\n * measureFactory.growthPastYear(measureFactory.sum(DM.Commerce.Cost))\n * ```\n * @param measure - Measure to apply growth to\n * @param name - Name for the new measure\n * @returns A calculated measure instance\n * @group Statistics\n */\nexport declare function growthPastYear(measure: Measure, name?: string): CalculatedMeasure;\n/**\n * Creates a calculated measure that calculates the difference between this period's data\n * and the data from the previous period for the given measure.\n *\n * The time resolution is determined by the minimum date level of the date dimension in the query\n * that uses the returned measure.\n *\n * @example\n * Calculate the difference between this period's total cost and the previous period's total cost\n * from the Sample Ecommerce data model.\n * ```ts\n * measureFactory.difference(measureFactory.sum(DM.Commerce.Cost))\n * ```\n * @param measure - Measure to apply difference to\n * @param name - Name for the new measure\n * @returns A calculated measure instance\n * @group Time-based\n */\nexport declare function difference(measure: Measure, name?: string): CalculatedMeasure;\n/**\n * Creates a calculated measure that calculates the difference between this week's data\n * and the data from the previous week for the given measure.\n *\n * The date dimension will be dynamically taken from the query that uses the returned measure.\n *\n * @example\n * Calculate the difference between this week's total cost and the previous week's total cost from\n * the Sample Ecommerce data model.\n * ```ts\n * measureFactory.diffPastWeek(measureFactory.sum(DM.Commerce.Cost))\n * ```\n * @param measure - Measure to apply difference to\n * @param name - Name for the new measure\n * @returns A calculated measure instance\n * @group Time-based\n */\nexport declare function diffPastWeek(measure: Measure, name?: string): CalculatedMeasure;\n/**\n * Creates a calculated measure that calculates the difference between this month's data\n * and the data from the previous month for the given measure.\n *\n * The date dimension will be dynamically taken from the query that uses the returned measure.\n *\n * @example\n * Calculate the difference between this month's total cost and the previous month's total cost from\n * the Sample Ecommerce data model.\n * ```ts\n * measureFactory.diffPastMonth(measureFactory.sum(DM.Commerce.Cost))\n * ```\n * @param measure - Measure to apply difference to\n * @param name - Name for the new measure\n * @returns A calculated measure instance\n * @group Time-based\n */\nexport declare function diffPastMonth(measure: Measure, name?: string): CalculatedMeasure;\n/**\n * Creates a calculated measure that calculates the difference between this quarter's data\n * and the data from the previous quarter for the given measure.\n *\n * The date dimension will be dynamically taken from the query that uses the returned measure.\n *\n * @example\n * Calculate the difference between this quarter's total cost and the previous quarter's total cost\n * from the Sample Ecommerce data model.\n * ```ts\n * measureFactory.diffPastQuarter(measureFactory.sum(DM.Commerce.Cost))\n * ```\n * @param measure - Measure to apply difference to\n * @param name - Name for the new measure\n * @returns A calculated measure instance\n * @group Time-based\n */\nexport declare function diffPastQuarter(measure: Measure, name?: string): CalculatedMeasure;\n/**\n * Creates a calculated measure that calculates the difference between this year's data\n * and the data from the previous year for the given measure.\n *\n * The date dimension will be dynamically taken from the query that uses the returned measure.\n *\n * @example\n * Calculate the difference between this year's total cost and the previous year's total cost from\n * the Sample Ecommerce data model.\n * ```ts\n * measureFactory.diffPastYear(measureFactory.sum(DM.Commerce.Cost))\n * ```\n * @param measure - Measure to apply difference to\n * @param name - Name for the new measure\n * @returns A calculated measure instance\n * @group Time-based\n */\nexport declare function diffPastYear(measure: Measure, name?: string): CalculatedMeasure;\n/**\n * Creates a calculated measure that calculates the value for the previous day.\n *\n * @example\n * Calculate total cost for the previous day from the Sample Ecommerce data model.\n * ```ts\n * measureFactory.pastDay(measureFactory.sum(DM.Commerce.Cost))\n * ```\n * @param measure - Measure to apply past value to\n * @param name - Name for the new measure\n * @returns A calculated measure instance\n * @group Time-based\n */\nexport declare function pastDay(measure: Measure, name?: string): CalculatedMeasure;\n/**\n * Creates a calculated measure that calculates the value for the same day in the previous week.\n *\n * The time resolution is determined by the minimum date level of the date dimension in the query\n * that uses the returned measure.\n *\n * @example\n * Calculate total cost for the corresponding day one week ago from the Sample Ecommerce data model.\n * ```ts\n * measureFactory.pastWeek(measureFactory.sum(DM.Commerce.Cost))\n * ```\n * @param measure - Measure to apply past value to\n * @param name - Name for the new measure\n * @returns A calculated measure instance\n * @group Time-based\n */\nexport declare function pastWeek(measure: Measure, name?: string): CalculatedMeasure;\n/**\n * Creates a calculated measure that calculates the value for the same day or week in the previous month.\n *\n * The time resolution is determined by the minimum date level of the date dimension in the query\n * that uses the returned measure.\n *\n * @example\n * Calculate total cost for the corresponding day or week one month ago from the Sample Ecommerce\n * data model.\n * ```ts\n * measureFactory.pastMonth(measureFactory.sum(DM.Commerce.Cost))\n * ```\n * @param measure - Measure to apply past value to\n * @param name - Name for the new measure\n * @returns A calculated measure instance\n * @group Time-based\n */\nexport declare function pastMonth(measure: Measure, name?: string): CalculatedMeasure;\n/**\n * Creates a calculated measure that calculates the value for the same day, week, or month in the previous quarter.\n *\n * The time resolution is determined by the minimum date level of the date dimension in the query\n * that uses the returned measure.\n *\n * @example\n * Calculate total cost for the corresponding day, week, or month one quarter ago from the Sample\n * Ecommerce data model.\n * ```ts\n * measureFactory.pastQuarter(measureFactory.sum(DM.Commerce.Cost))\n * ```\n * @param measure - Measure to apply past value to\n * @param name - Name for the new measure\n * @returns A calculated measure instance\n * @group Time-based\n */\nexport declare function pastQuarter(measure: Measure, name?: string): CalculatedMeasure;\n/**\n * Creates a calculated measure that calculates the value for the same day, week, month, or quarter in the previous year.\n *\n * The time resolution is determined by the minimum date level of the date dimension in the query\n * that uses the returned measure.\n *\n * @example\n * Calculate total cost for the corresponding day, week, month, or quarter one year ago from the\n * Sample Ecommerce data model.\n * ```ts\n * measureFactory.pastYear(measureFactory.sum(DM.Commerce.Cost))\n * ```\n * @param measure - Measure to apply past value to\n * @param name - Name for the new measure\n * @returns A calculated measure instance\n * @group Time-based\n */\nexport declare function pastYear(measure: Measure, name?: string): CalculatedMeasure;\n/**\n * Creates a calculated contribution measure.\n *\n * A contribution measure calculates the contribution, in percentage, of a measure towards the total.\n * Percentages are expressed as a number between 0 and 1 (e.g. 42% is `0.42`).\n *\n * For example, using the Sample Ecommerce data model you can retrieve the total cost of products\n * categorized by age range. Using a contribution measure you can calculate how much each age range's\n * total cost contributes to the total cost across all age ranges. So, the total cost for the 35-44\n * age range is 23.64M, which is 22% of the 107.27M of all age ranges together. Therefore, the\n * contribution of the 35-44 age range is `.22`.\n *\n * @example\n * Calculates the percentage of the total cost across all categories for items in a category from the\n * Sample Ecommerce data model.\n * ```ts\n * measureFactory.contribution(measureFactory.sum(DM.Commerce.Cost))\n * ```\n *\n * Contribution values from the Sample Ecommerce data model when categorizing by age range.\n * | AgeRange | Cost | Contribution |\n * | --- | --- | --- |\n * | 0-18 | 4.32M | 0.04 |\n * | 19-24 | 8.66M | 0.08 |\n * | 25-34 | 21.19M | 0.2 |\n * | 35-44 | 23.64M | 0.22 |\n * | 45-54 | 20.39M | 0.19 |\n * | 55-64 | 11.82M | 0.11 |\n * | 65+ | 17.26M | 0.16 |\n * @param measure - Measure to apply the Contribution logic to\n * @param name - Name for the new measure\n * @returns A calculated measure instance\n * @group Statistics\n */\nexport declare function contribution(measure: Measure, name?: string): CalculatedMeasure;\n/**\n * Creates a calculated measure that computes a specified trend type for a given measure.\n *\n * The trend types include linear (the default), logarithmic, advanced smoothing, and local estimates.\n * You can also opt to automatically identify and ignore anomalous values in the series.\n *\n * Trend requires a Sisense instance version of L2023.6.0 or greater.\n *\n * @example\n * Calculate the trend in total cost from the Sample Ecommerce data model.\n * ```ts\n * measureFactory.trend(\n * measureFactory.sum(DM.Commerce.Cost),\n * 'Total Cost Trend',\n * {\n * modelType: 'advancedSmoothing',\n * ignoreAnomalies: true,\n * }\n * )\n * ```\n * @param measure - Measure to apply the trend logic to\n * @param name - Name for the new measure\n * @param options - Trend options\n * @returns A calculated measure instance\n * @group Advanced Analytics\n */\nexport declare function trend(\n\tmeasure: Measure,\n\tname?: string,\n\toptions?: TrendFormulaOptions,\n): CalculatedMeasure;\n/**\n * Creates a calculated measure that generates a forecast based on a specified measure employing\n * advanced autoML techniques.\n *\n * This function offers flexible options allowing you to:\n * + Let the function auto-select the best statistical model or explicitly choose a preferred model\n * + Control the time period used for training the model\n * + Set additional options to improve forecast accuracy by supplying expected lower and upper limits.\n *\n * In addition to the forecast, upper and lower confidence intervals are returned\n * with the name of the new measure and a suffix of _upper and _lower\n * respectively.\n *\n * Forecast requires a Sisense instance version of L2023.6.0 or greater.\n *\n * @example\n * Calculate a forecast for total cost from the Sample Ecommerce data model from the Sample\n * Ecommerce data model.\n * ```ts\n * measureFactory.forecast(\n * measureFactory.sum(DM.Commerce.Cost),\n * 'Total Cost Forecast',\n * {\n * modelType: 'prophet',\n * roundToInt: true,\n * }\n * )\n * ```\n * @param measure - Measure to apply the forecast logic to\n * @param name - Name for the new measure\n * @param options - Forecast options\n * @returns A calculated measure instance\n * @group Advanced Analytics\n */\nexport declare function forecast(\n\tmeasure: Measure,\n\tname?: string,\n\toptions?: ForecastFormulaOptions,\n): CalculatedMeasure;\n/**\n * Creates a calculated measure that calculates the rank of a value in a list of values.\n *\n * This function includes options that allow you do customize the ranking order and how to handle\n * equally ranked items.\n *\n * The order options are:\n * + `'DESC'` (default): Descending, meaning the largest number is ranked first.\n * + `'ASC'`: Ascending, meaning the smallest number is ranked first.\n *\n * The rank type options are:\n * + `'1224'`: Standard competition, meaning items that rank equally receive the same ranking number,\n * and then a gap is left after the equally ranked items in the ranking numbers.\n * + `'1334'`: Modified competition ranking, meaning items that rank equally receive the same ranking number,\n * and a gap is left before the equally ranked items in the ranking numbers.\n * + `'1223'`: Dense ranking, meaning items that rank equally receive the same ranking number,\n * and the next items receive the immediately following ranking number.\n * + `'1234'`: Ordinal ranking, meaning all items receive distinct ordinal numbers,\n * including items that rank equally. The assignment of distinct ordinal numbers for equal-ranking items is arbitrary.\n *\n * @example\n * Calculate the rank of the total cost per category, sorted with the smallest cost ranked first,\n * and ranking ties are handled using the ordinal ranking type from the Sample Ecommerce data model.\n * ```ts\n * measureFactory.rank(\n * measureFactory.sum(DM.Commerce.Cost),\n * 'Cost Rank',\n * measureFactory.RankingSortTypes.Ascending,\n * measureFactory.RankingTypes.Ordinal\n * )\n * ```\n *\n * Ranking values from the Sample Ecommerce data model when categorizing by age range using the above ranking.\n * | AgeRange | Cost | Cost Rank |\n * | --- | --- | --- |\n * | 0-18 | 4.32M | 1 |\n * | 19-24 | 8.66M | 2 |\n * | 25-34 | 21.19M | 6 |\n * | 35-44 | 23.64M | 7 |\n * | 45-54 | 20.39M | 5 |\n * | 55-64 | 11.82M | 3 |\n * | 65+ | 17.26M | 4 |\n * @param measure - Measure to apply the ranking logic to\n * @param name - Name for the new measure\n * @param sort - Sorting for ranking. By default sort order is descending, where the largest number is ranked first.\n * @param rankType - How to handle equally ranked items. By default the type is standard competition ranking.\n * @param groupBy - Rank partition attributes\n * @returns A calculated measure instance\n * @group Statistics\n */\nexport declare function rank(\n\tmeasure: Measure,\n\tname?: string,\n\tsort?: string,\n\trankType?: string,\n\tgroupBy?: Attribute[],\n): CalculatedMeasure;";
|
|
2
|
-
//# sourceMappingURL=measure-factory-types.d.ts.map
|
|
@@ -41,4 +41,3 @@ export declare const filterFactoryFunctionsMap: Record<string, (...args: any[])
|
|
|
41
41
|
* @returns A Filter[] or FilterRelations object
|
|
42
42
|
*/
|
|
43
43
|
export declare const translateFiltersFromJsonFunctionCall: (filtersJson: string, dataSource: JaqlDataSourceForDto, dataFields: NormalizedDataSourceField[]) => Filter[] | FilterRelations;
|
|
44
|
-
//# sourceMappingURL=translate-filters.d.ts.map
|
|
@@ -2,4 +2,3 @@ import { LoadExistingFusionDashboardParams, BuildDashboardContext } from './type
|
|
|
2
2
|
export declare const loadExistingFusionDashboard: ({ dashboardTitle }: LoadExistingFusionDashboardParams, context: BuildDashboardContext) => Promise<{
|
|
3
3
|
message: string;
|
|
4
4
|
}>;
|
|
5
|
-
//# sourceMappingURL=load-existing-fusion-dashboard.d.ts.map
|
|
@@ -2,4 +2,3 @@ import { UpdateDashboardParams, BuildDashboardContext } from './types';
|
|
|
2
2
|
export declare const updateDashboard: ({ dashboardId, dashboardTitle }: UpdateDashboardParams, context: BuildDashboardContext) => Promise<{
|
|
3
3
|
message: string;
|
|
4
4
|
}>;
|
|
5
|
-
//# sourceMappingURL=update-dashboard.d.ts.map
|
|
@@ -10,4 +10,3 @@ type ToolParams = z.infer<typeof toolSchema>;
|
|
|
10
10
|
*/
|
|
11
11
|
export declare function buildDataModelEngine(params: Pick<ToolParams, 'prompt'>, context: BuildDataModelContext): Promise<BuildDataModelEngineResult>;
|
|
12
12
|
export {};
|
|
13
|
-
//# sourceMappingURL=build-data-model-engine.d.ts.map
|
|
@@ -1,2 +1 @@
|
|
|
1
1
|
export declare const fakerOptions = "Here are some of the fakerOptions available for some of the faker types:\nhelpers.enumValue: { <key>: <value>, ... }\nhelpers.arrayElements: { array: [<value>, ...], { count: <number> | { min: <number>, max: <number> } }\nhelpers.fromRegExp: '<regex>'\nairline.flightNumber: { addLeadingZeros: <boolean>, length: <number> | { min: <number>, max: <number> } }\nairline.recordLocator: { allowNumeric: <boolean>, allowVisuallySimilarCharacters: <boolean> }\nairline.seat: { aircraftType: 'narrowbody' | 'regional' | 'widebody' }\ncommerce.isbn: { separator?: <string>, variant: 10 | 13 } \ncommerce.price: { dec?: <number>, max?: <number>, min?: <number> }\ndatatype.boolean: { probability?: <number> }\ndate.anytime: { refDate?: <string> | <number> | <Date> }\ndate.between: { from: <string> | <number> | <Date>, to: <string> | <number> | <Date> }\ndate.betweens: { from: <string> | <number> | <Date>, to: <string> | <number> | <Date>, count: <number> | { min: <number>, max: <number> } }\ndate.birthdate: { refDate?: <string> | <number> | <Date>, min: <number>, max: <number>, mode: 'age' | 'year' }\ndate.future, date.past: { refDate?: <string> | <number> | <Date>, years?: <number> }\ndate.month, date.weekday: { abbreviated?: <boolean>, context?: <boolean> }\ndate.recent, date.soon: { refDate?: <string> | <number> | <Date>, days?: <number> }\nfinance.accountNumber: { optionsOrLength?: <number> | { length: <number> } }\nfinance.amount: { autoFormat?: <boolean>, dec?: <number>, max?: <number>, min?: <number> }\nfinance.bic: { includeBranchCode?: <boolean> }\nfinance.bitcoinAddress: { network?: 'mainnet' | 'testnet', type?: 'legacy' | 'segwit' | 'bech32' | 'taproot' }\nfinance.creditCardNumber: { issuer?: <string> }\nfinance.iban: { formatted?: <boolean>, countryCode?: <string> }\nfinance.maskedNumber: { ellipsis?: <boolean>, length?: <number>, parens?: <boolean> }\nfinance.pin: { length?: <number> }\nnumber.int: { max: 100000, min: 1 }\nnumber.float: { max: 100000, min: 1 }\nphone.number: { style?: 'international' | 'national' | 'human' }\nstring.alpha, string.alphaNumeric: { casing?: 'lower' | 'upper' | 'mixed', length?: <number>, exclude?: <string> | <AlphaChar | string>[] }\nstring.binary: { length?: <number>, prefix?: <string> }\nstring.fromCharacters: { characters: <string> | <string>[], length: <number> | { min: <number>, max: <number> } }\nstring.hexadecimal: { length?: <number>, prefix?: <string>, casing?: 'lower' | 'upper' | 'mixed' }\n\n";
|
|
2
|
-
//# sourceMappingURL=fake-options.d.ts.map
|
|
@@ -8,4 +8,3 @@ import { buildQuerySchema, BuildQueryContext, QueryResult } from './types';
|
|
|
8
8
|
* @returns The query result with queryId, nlqResult, and dataset
|
|
9
9
|
*/
|
|
10
10
|
export declare function buildQueryEngine(params: z.infer<typeof buildQuerySchema>, context: BuildQueryContext): Promise<QueryResult>;
|
|
11
|
-
//# sourceMappingURL=build-query-engine.d.ts.map
|
|
@@ -54,4 +54,3 @@ export interface QuerySummary {
|
|
|
54
54
|
* @param includeDataset - Whether to include the full dataset (enables natural response). When false, returns a directive to build a chart instead.
|
|
55
55
|
*/
|
|
56
56
|
export declare function toQuerySummary(result: QueryResult, includeDataset?: boolean): QuerySummary;
|
|
57
|
-
//# sourceMappingURL=types.d.ts.map
|
|
@@ -7,4 +7,3 @@ import { getDashboardsSchema, GetDashboardsContext, DashboardsResult } from './t
|
|
|
7
7
|
* @returns The dashboards result with list of dashboards
|
|
8
8
|
*/
|
|
9
9
|
export declare function getDashboardsEngine(params: z.infer<typeof getDashboardsSchema>, context: GetDashboardsContext): Promise<DashboardsResult>;
|
|
10
|
-
//# sourceMappingURL=get-dashboards-engine.d.ts.map
|
|
@@ -26,4 +26,3 @@ export declare function buildCompactSharedFormulas(formulas: MeasureItemJSON[]):
|
|
|
26
26
|
* @returns A compact schema string with table and column names, and shared formulas when provided
|
|
27
27
|
*/
|
|
28
28
|
export declare function getDataSourceFieldsSummary(dataSourceTitle: string, fields: DataSourceFieldWithDescription[] | DataSourceField[], formulas?: MeasureItemJSON[]): string;
|
|
29
|
-
//# sourceMappingURL=get-data-source-fields-engine.d.ts.map
|
|
@@ -7,4 +7,3 @@ import { getDataSourcesSchema, GetDataSourcesContext, DataSourcesResult } from '
|
|
|
7
7
|
* @returns The data sources summary with titles and full objects
|
|
8
8
|
*/
|
|
9
9
|
export declare function getDataSourcesEngine(params: z.infer<typeof getDataSourcesSchema>, context: GetDataSourcesContext): Promise<DataSourcesResult>;
|
|
10
|
-
//# sourceMappingURL=get-data-sources-engine.d.ts.map
|
package/dist/engines/index.d.ts
CHANGED
|
@@ -1,3 +1,2 @@
|
|
|
1
1
|
export { listDataModelsEngine, getModelSchemaEngine, addRelationEngine, removeRelationEngine, createPerspectiveEngine, updatePerspectiveEngine, getPerspectiveEngine, triggerBuildEngine, listPerspectivesEngine, } from './manage-perspectives-engine';
|
|
2
2
|
export * from './types';
|
|
3
|
-
//# sourceMappingURL=index.d.ts.map
|