@salesforce/lds-adapters-sfap-analytics-insights 1.332.0-dev2 → 1.332.0-dev21

package/dist/es/es2018/types/src/generated/types/GenerateInsightBundleResponse.d.ts

@@ -1,7 +1,8 @@
 import { Error as Error_Error } from './Error';
+import { UnifiedFilter as UnifiedFilter_UnifiedFilter } from './UnifiedFilter';
 import { InsightBundle as InsightBundle_InsightBundle } from './InsightBundle';
 import { KeyMetadata as $64$luvio_engine_KeyMetadata, NormalizedKeyMetadata as $64$luvio_engine_NormalizedKeyMetadata, Luvio as $64$luvio_engine_Luvio, IngestPath as $64$luvio_engine_IngestPath, Store as $64$luvio_engine_Store, FragmentSelection as $64$luvio_engine_FragmentSelection, ResourceIngest as $64$luvio_engine_ResourceIngest, DurableStoreKeyMetadataMap as $64$luvio_engine_DurableStoreKeyMetadataMap } from '@luvio/engine';
-export declare const VERSION = "2f50f3271c566971f91d15a361482b6c";
+export declare const VERSION = "5da3ddbbd8ef8f7b1f24b4d609f91108";
 export declare function validate(obj: any, path?: string): TypeError | null;
 export declare const RepresentationType: string;
 export interface KeyParams extends $64$luvio_engine_KeyMetadata {
@@ -26,6 +27,7 @@ export declare function getTypeCacheKeys(rootKeySet: $64$luvio_engine_DurableSto
  */
 export interface GenerateInsightBundleResponseNormalized {
     error?: Error_Error;
+    measurementPeriod?: UnifiedFilter_UnifiedFilter;
     /** Note that it is possible that we encountered some errors but were still
      able to compute part of the result. In that case, the result key will be
      present, and there will be errors at the appropriate level inside */
@@ -42,6 +44,7 @@ export interface GenerateInsightBundleResponseNormalized {
  */
 export interface GenerateInsightBundleResponse {
     error?: Error_Error;
+    measurementPeriod?: UnifiedFilter_UnifiedFilter;
     result?: InsightBundle_InsightBundle;
     sdm: string;
     submetric: string;

package/dist/es/es2018/types/src/generated/types/GoalMetadata.d.ts

@@ -0,0 +1,30 @@
+import { GoalMetadata_StatusCondition as GoalMetadata_StatusCondition_GoalMetadata_StatusCondition } from './GoalMetadata_StatusCondition';
+import { IngestPath as $64$luvio_engine_IngestPath, Luvio as $64$luvio_engine_Luvio, Store as $64$luvio_engine_Store, FragmentSelection as $64$luvio_engine_FragmentSelection, ResourceIngest as $64$luvio_engine_ResourceIngest, DurableStoreKeyMetadataMap as $64$luvio_engine_DurableStoreKeyMetadataMap, NormalizedKeyMetadata as $64$luvio_engine_NormalizedKeyMetadata } from '@luvio/engine';
+export declare const VERSION = "e50e1ade99afa0af26c6426ef1104abf";
+export declare function validate(obj: any, path?: string): TypeError | null;
+export declare const RepresentationType: string;
+export declare function normalize(input: GoalMetadata, existing: GoalMetadataNormalized, path: $64$luvio_engine_IngestPath, luvio: $64$luvio_engine_Luvio, store: $64$luvio_engine_Store, timestamp: number): GoalMetadataNormalized;
+export declare const select: () => $64$luvio_engine_FragmentSelection;
+export declare function equals(existing: GoalMetadataNormalized, incoming: GoalMetadataNormalized): boolean;
+export declare const ingest: $64$luvio_engine_ResourceIngest;
+export declare function getTypeCacheKeys(rootKeySet: $64$luvio_engine_DurableStoreKeyMetadataMap, luvio: $64$luvio_engine_Luvio, input: GoalMetadata, fullPathFactory: () => string | $64$luvio_engine_NormalizedKeyMetadata): void;
+/**
+ *
+ *
+ * Keys:
+ *    (none)
+ */
+export interface GoalMetadataNormalized {
+    forecasting?: boolean;
+    statusConditions?: Array<GoalMetadata_StatusCondition_GoalMetadata_StatusCondition>;
+}
+/**
+ *
+ *
+ * Keys:
+ *    (none)
+ */
+export interface GoalMetadata {
+    forecasting?: boolean;
+    statusConditions?: Array<GoalMetadata_StatusCondition_GoalMetadata_StatusCondition>;
+}

package/dist/es/es2018/types/src/generated/types/GoalMetadata_StatusCondition.d.ts

@@ -0,0 +1,37 @@
+import { IngestPath as $64$luvio_engine_IngestPath, Luvio as $64$luvio_engine_Luvio, Store as $64$luvio_engine_Store, FragmentSelection as $64$luvio_engine_FragmentSelection, ResourceIngest as $64$luvio_engine_ResourceIngest, DurableStoreKeyMetadataMap as $64$luvio_engine_DurableStoreKeyMetadataMap, NormalizedKeyMetadata as $64$luvio_engine_NormalizedKeyMetadata } from '@luvio/engine';
+export declare const VERSION = "04b77164c551085930f8c762fbc0baf7";
+export declare function validate(obj: any, path?: string): TypeError | null;
+export declare const RepresentationType: string;
+export declare function normalize(input: GoalMetadata_StatusCondition, existing: GoalMetadata_StatusConditionNormalized, path: $64$luvio_engine_IngestPath, luvio: $64$luvio_engine_Luvio, store: $64$luvio_engine_Store, timestamp: number): GoalMetadata_StatusConditionNormalized;
+export declare const select: () => $64$luvio_engine_FragmentSelection;
+export declare function equals(existing: GoalMetadata_StatusConditionNormalized, incoming: GoalMetadata_StatusConditionNormalized): boolean;
+export declare const ingest: $64$luvio_engine_ResourceIngest;
+export declare function getTypeCacheKeys(rootKeySet: $64$luvio_engine_DurableStoreKeyMetadataMap, luvio: $64$luvio_engine_Luvio, input: GoalMetadata_StatusCondition, fullPathFactory: () => string | $64$luvio_engine_NormalizedKeyMetadata): void;
+/**
+ *
+ *
+ * Keys:
+ *    (none)
+ */
+export interface GoalMetadata_StatusConditionNormalized {
+    color?: string;
+    currencyIsoCode?: string;
+    operator?: string;
+    primary?: boolean;
+    statusName?: string;
+    value?: string;
+}
+/**
+ *
+ *
+ * Keys:
+ *    (none)
+ */
+export interface GoalMetadata_StatusCondition {
+    color?: string;
+    currencyIsoCode?: string;
+    operator?: string;
+    primary?: boolean;
+    statusName?: string;
+    value?: string;
+}

package/dist/es/es2018/types/src/generated/types/InputMetric.d.ts

@@ -1,10 +1,11 @@
 import { ExtensionOptions as ExtensionOptions_ExtensionOptions } from './ExtensionOptions';
+import { GoalMetadata as GoalMetadata_GoalMetadata } from './GoalMetadata';
 import { InsightsOptions as InsightsOptions_InsightsOptions } from './InsightsOptions';
 import { MetricInstance as MetricInstance_MetricInstance } from './MetricInstance';
 import { MetricDefinition as MetricDefinition_MetricDefinition } from './MetricDefinition';
 import { RepresentationOptions as RepresentationOptions_RepresentationOptions } from './RepresentationOptions';
 import { IngestPath as $64$luvio_engine_IngestPath, Luvio as $64$luvio_engine_Luvio, Store as $64$luvio_engine_Store, FragmentSelection as $64$luvio_engine_FragmentSelection, ResourceIngest as $64$luvio_engine_ResourceIngest, DurableStoreKeyMetadataMap as $64$luvio_engine_DurableStoreKeyMetadataMap, NormalizedKeyMetadata as $64$luvio_engine_NormalizedKeyMetadata } from '@luvio/engine';
-export declare const VERSION = "3cd5a4d1df82c4262f020fcb6baf66d8";
+export declare const VERSION = "fabb0211ec0f98955089dfac31fe7c0c";
 export declare function validate(obj: any, path?: string): TypeError | null;
 export declare const RepresentationType: string;
 export declare function normalize(input: InputMetric, existing: InputMetricNormalized, path: $64$luvio_engine_IngestPath, luvio: $64$luvio_engine_Luvio, store: $64$luvio_engine_Store, timestamp: number): InputMetricNormalized;
@@ -20,6 +21,7 @@ export declare function getTypeCacheKeys(rootKeySet: $64$luvio_engine_DurableSto
  */
 export interface InputMetricNormalized {
     extensionOptions: ExtensionOptions_ExtensionOptions;
+    goals?: GoalMetadata_GoalMetadata;
     insightsOptions: InsightsOptions_InsightsOptions;
     instance: MetricInstance_MetricInstance;
     metric: MetricDefinition_MetricDefinition;
@@ -33,6 +35,7 @@ export interface InputMetricNormalized {
  */
 export interface InputMetric {
     extensionOptions: ExtensionOptions_ExtensionOptions;
+    goals?: GoalMetadata_GoalMetadata;
     insightsOptions: InsightsOptions_InsightsOptions;
     instance: MetricInstance_MetricInstance;
     metric: MetricDefinition_MetricDefinition;

package/dist/es/es2018/types/src/generated/types/MeasurementPeriod.d.ts

@@ -1,7 +1,7 @@
 import { Filter as Filter_Filter } from './Filter';
 import { RelativePeriod as RelativePeriod_RelativePeriod } from './RelativePeriod';
 import { IngestPath as $64$luvio_engine_IngestPath, Luvio as $64$luvio_engine_Luvio, Store as $64$luvio_engine_Store, FragmentSelection as $64$luvio_engine_FragmentSelection, ResourceIngest as $64$luvio_engine_ResourceIngest, DurableStoreKeyMetadataMap as $64$luvio_engine_DurableStoreKeyMetadataMap, NormalizedKeyMetadata as $64$luvio_engine_NormalizedKeyMetadata } from '@luvio/engine';
-export declare const VERSION = "1e869467244de8345ef0ae47db7efe5a";
+export declare const VERSION = "4a016b66b546a8ae805a5271877fa734";
 export declare function validate(obj: any, path?: string): TypeError | null;
 export declare const RepresentationType: string;
 export declare function normalize(input: MeasurementPeriod, existing: MeasurementPeriodNormalized, path: $64$luvio_engine_IngestPath, luvio: $64$luvio_engine_Luvio, store: $64$luvio_engine_Store, timestamp: number): MeasurementPeriodNormalized;
@@ -18,6 +18,9 @@ export declare function getTypeCacheKeys(rootKeySet: $64$luvio_engine_DurableSto
 export interface MeasurementPeriodNormalized {
     filter?: Filter_Filter;
     relativePeriod?: RelativePeriod_RelativePeriod;
+    /** We do not yet have support for fiscal year
+      We do not yet have support for unbounded time ranges (less than/greater than/all time) */
+    semanticFilter?: unknown;
 }
 /**
  *
@@ -28,4 +31,5 @@ export interface MeasurementPeriodNormalized {
 export interface MeasurementPeriod {
     filter?: Filter_Filter;
     relativePeriod?: RelativePeriod_RelativePeriod;
+    semanticFilter?: unknown;
 }

package/dist/es/es2018/types/src/generated/types/MetricDefinition.d.ts

@@ -21,6 +21,7 @@ export declare function getTypeCacheKeys(rootKeySet: $64$luvio_engine_DurableSto
  */
 export interface MetricDefinitionNormalized {
     comparison: CompareConfig_CompareConfig;
+    /** DEPRECATED Please don't use this field. */
     filters?: Array<Filter_Filter>;
     measure: Measure_Measure;
     runningTotal?: boolean;

package/dist/es/es2018/types/src/generated/types/MetricInstance.d.ts

@@ -1,8 +1,7 @@
 import { Filter as Filter_Filter } from './Filter';
-import { MeasurementPeriod as MeasurementPeriod_MeasurementPeriod } from './MeasurementPeriod';
 import { FlattenFilter as FlattenFilter_FlattenFilter } from './FlattenFilter';
 import { IngestPath as $64$luvio_engine_IngestPath, Luvio as $64$luvio_engine_Luvio, Store as $64$luvio_engine_Store, FragmentSelection as $64$luvio_engine_FragmentSelection, ResourceIngest as $64$luvio_engine_ResourceIngest, DurableStoreKeyMetadataMap as $64$luvio_engine_DurableStoreKeyMetadataMap, NormalizedKeyMetadata as $64$luvio_engine_NormalizedKeyMetadata } from '@luvio/engine';
-export declare const VERSION = "6109c7c8602d73ca0af0de991ebfdc58";
+export declare const VERSION = "0278f9efb04f0f3d2165d5c8f69125fb";
 export declare function validate(obj: any, path?: string): TypeError | null;
 export declare const RepresentationType: string;
 export declare function normalize(input: MetricInstance, existing: MetricInstanceNormalized, path: $64$luvio_engine_IngestPath, luvio: $64$luvio_engine_Luvio, store: $64$luvio_engine_Store, timestamp: number): MetricInstanceNormalized;
@@ -17,9 +16,10 @@ export declare function getTypeCacheKeys(rootKeySet: $64$luvio_engine_DurableSto
  *    (none)
  */
 export interface MetricInstanceNormalized {
-    /** The 'filters' and 'semantic_filters' will be ANDed together */
+    /** DEPRECATED Please don't use this field.
+    The 'filters' and 'semantic_filters' will be ANDed together */
     filters?: Array<Filter_Filter>;
-    measurementPeriod: MeasurementPeriod_MeasurementPeriod;
+    measurementPeriod?: unknown;
     semanticFilter?: FlattenFilter_FlattenFilter;
 }
 /**
@@ -30,6 +30,6 @@ export interface MetricInstanceNormalized {
  */
 export interface MetricInstance {
     filters?: Array<Filter_Filter>;
-    measurementPeriod: MeasurementPeriod_MeasurementPeriod;
+    measurementPeriod?: unknown;
     semanticFilter?: FlattenFilter_FlattenFilter;
 }

package/dist/es/es2018/types/src/generated/types/MetricInstanceInput.d.ts

@@ -1,5 +1,6 @@
+import { UnifiedFilter as UnifiedFilter_UnifiedFilter } from './UnifiedFilter';
 import { IngestPath as $64$luvio_engine_IngestPath, Luvio as $64$luvio_engine_Luvio, Store as $64$luvio_engine_Store, FragmentSelection as $64$luvio_engine_FragmentSelection, ResourceIngest as $64$luvio_engine_ResourceIngest, DurableStoreKeyMetadataMap as $64$luvio_engine_DurableStoreKeyMetadataMap, NormalizedKeyMetadata as $64$luvio_engine_NormalizedKeyMetadata } from '@luvio/engine';
-export declare const VERSION = "e84f600c5fe7f16d12eccf9b029e7246";
+export declare const VERSION = "4cfe0ca50285d8024e918cb1ede5847d";
 export declare function validate(obj: any, path?: string): TypeError | null;
 export declare const RepresentationType: string;
 export declare function normalize(input: MetricInstanceInput, existing: MetricInstanceInputNormalized, path: $64$luvio_engine_IngestPath, luvio: $64$luvio_engine_Luvio, store: $64$luvio_engine_Store, timestamp: number): MetricInstanceInputNormalized;
@@ -14,6 +15,7 @@ export declare function getTypeCacheKeys(rootKeySet: $64$luvio_engine_DurableSto
  *    (none)
  */
 export interface MetricInstanceInputNormalized {
+    measurementPeriod?: UnifiedFilter_UnifiedFilter;
     metricInstanceId: string;
     sdmId: string;
 }
@@ -24,6 +26,7 @@ export interface MetricInstanceInputNormalized {
  *    (none)
  */
 export interface MetricInstanceInput {
+    measurementPeriod?: UnifiedFilter_UnifiedFilter;
     metricInstanceId: string;
     sdmId: string;
 }

package/dist/es/es2018/types/src/generated/types/RelativePeriod.d.ts

@@ -1,5 +1,5 @@
 import { IngestPath as $64$luvio_engine_IngestPath, Luvio as $64$luvio_engine_Luvio, Store as $64$luvio_engine_Store, FragmentSelection as $64$luvio_engine_FragmentSelection, ResourceIngest as $64$luvio_engine_ResourceIngest, DurableStoreKeyMetadataMap as $64$luvio_engine_DurableStoreKeyMetadataMap, NormalizedKeyMetadata as $64$luvio_engine_NormalizedKeyMetadata } from '@luvio/engine';
-export declare const VERSION = "bd06b687a509789635a504a36836e7b1";
+export declare const VERSION = "9a4f0f6afd72539eaa9ecacc66570157";
 export declare function validate(obj: any, path?: string): TypeError | null;
 export declare const RepresentationType: string;
 export declare function normalize(input: RelativePeriod, existing: RelativePeriodNormalized, path: $64$luvio_engine_IngestPath, luvio: $64$luvio_engine_Luvio, store: $64$luvio_engine_Store, timestamp: number): RelativePeriodNormalized;
@@ -8,7 +8,7 @@ export declare function equals(existing: RelativePeriodNormalized, incoming: Rel
 export declare const ingest: $64$luvio_engine_ResourceIngest;
 export declare function getTypeCacheKeys(rootKeySet: $64$luvio_engine_DurableStoreKeyMetadataMap, luvio: $64$luvio_engine_Luvio, input: RelativePeriod, fullPathFactory: () => string | $64$luvio_engine_NormalizedKeyMetadata): void;
 /**
- *
+ * The old insights time filter
  *
  * Keys:
  *    (none)
@@ -18,7 +18,7 @@ export interface RelativePeriodNormalized {
     range?: string;
 }
 /**
- *
+ * The old insights time filter
  *
  * Keys:
  *    (none)

package/dist/es/es2018/types/src/generated/types/Status.d.ts

@@ -17,7 +17,7 @@ export interface StatusNormalized {
     /** Defines how the metric is tracking */
     qualifier?: string;
     /** Represents a sentiment towards metric status.
-     Sentiment is determined based on the metric directionality and status qualifier */
+     Status sentiment is determined based on metric sentiment (e.g. up is good) and status qualifier */
     sentiment?: string;
 }
 /**

package/dist/es/es2018/types/src/generated/types/UnifiedFilter.d.ts

@@ -0,0 +1,33 @@
+import { IngestPath as $64$luvio_engine_IngestPath, Luvio as $64$luvio_engine_Luvio, Store as $64$luvio_engine_Store, FragmentSelection as $64$luvio_engine_FragmentSelection, ResourceIngest as $64$luvio_engine_ResourceIngest, DurableStoreKeyMetadataMap as $64$luvio_engine_DurableStoreKeyMetadataMap, NormalizedKeyMetadata as $64$luvio_engine_NormalizedKeyMetadata } from '@luvio/engine';
+export declare const VERSION = "7948f62379bf327a3cc190504223aecc";
+export declare function validate(obj: any, path?: string): TypeError | null;
+export declare const RepresentationType: string;
+export declare function normalize(input: UnifiedFilter, existing: UnifiedFilterNormalized, path: $64$luvio_engine_IngestPath, luvio: $64$luvio_engine_Luvio, store: $64$luvio_engine_Store, timestamp: number): UnifiedFilterNormalized;
+export declare const select: () => $64$luvio_engine_FragmentSelection;
+export declare function equals(existing: UnifiedFilterNormalized, incoming: UnifiedFilterNormalized): boolean;
+export declare const ingest: $64$luvio_engine_ResourceIngest;
+export declare function getTypeCacheKeys(rootKeySet: $64$luvio_engine_DurableStoreKeyMetadataMap, luvio: $64$luvio_engine_Luvio, input: UnifiedFilter, fullPathFactory: () => string | $64$luvio_engine_NormalizedKeyMetadata): void;
+/**
+ * Message representing the Unified Filter.
+ *
+ * Keys:
+ *    (none)
+ */
+export interface UnifiedFilterNormalized {
+    /** tableName.ColumnName or calcFieldName */
+    fieldName?: string;
+    operator?: string;
+    /** An array of values. All values must be of the same type. We support  strings, numbers, and booleans. */
+    values?: Array<unknown>;
+}
+/**
+ * Message representing the Unified Filter.
+ *
+ * Keys:
+ *    (none)
+ */
+export interface UnifiedFilter {
+    fieldName?: string;
+    operator?: string;
+    values?: Array<unknown>;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salesforce/lds-adapters-sfap-analytics-insights",
-    "version": "1.332.0-dev2",
+    "version": "1.332.0-dev21",
     "description": "APIs for generating insights about metrics",
     "license": "SEE LICENSE IN LICENSE.txt",
     "main": "dist/es/es2018/sfap-analytics-insights.js",
@@ -40,10 +40,10 @@
         "test:unit": "jest"
     },
     "dependencies": {
-        "@salesforce/lds-bindings": "^1.332.0-dev2"
+        "@salesforce/lds-bindings": "^1.332.0-dev21"
     },
     "devDependencies": {
-        "@salesforce/lds-compiler-plugins": "^1.332.0-dev2"
+        "@salesforce/lds-compiler-plugins": "^1.332.0-dev21"
     },
     "nx": {
         "targets": {