@sassoftware/vi-api 0.0.29 → 1.7.1

package/svi-datahub/package.json

@@ -1,5 +1,5 @@
 {
   "name": "@types/svi-datahub",
-  "version": "16.5.111",
+  "version": "17.10.44",
   "types": "index.d.ts"
 }

package/svi-sand/index.d.ts

@@ -1,6 +1,6 @@
 /* tslint:disable */
 /* eslint-disable */
-// Generated using typescript-generator version 2.15.527 on 2022-01-30 09:30:50.
+// Generated using typescript-generator version 2.15.527 on 2023-01-24 10:53:58.
 
 export interface ApplicationSetting extends ResponsesErrorResponse {
     name?: string;
@@ -34,7 +34,6 @@ export interface SandType extends ResponsesErrorResponse {
     fields?: { [index: string]: SandField };
     options?: { [index: string]: any };
     config?: SandConfiguration;
-    version?: number;
     links?: Link[];
 }
 
@@ -110,12 +109,12 @@ export interface Fields {
     category?: string;
     label?: string;
     description?: string;
-    longitude?: string;
-    latitude?: string;
-    geoJson?: string;
     pointTimestamp?: string;
     intervalStartTimestamp?: string;
     intervalEndTimestamp?: string;
+    longitude?: string;
+    latitude?: string;
+    geoJson?: string;
 }
 
 export interface FieldsConfiguration {
@@ -144,8 +143,8 @@ export interface SummaryConfiguration extends FieldsConfiguration {
 
 export interface HighlightingConfiguration {
     highlighter?: string;
-    fragments?: number;
     fragmentSize?: number;
+    fragments?: number;
 }
 
 export interface TextAnalyticsConfiguration extends FieldsConfiguration {
@@ -265,6 +264,10 @@ export interface TypeBucket {
     selected?: boolean;
 }
 
+export interface MaskedFieldConfiguration {
+    type?: MaskedFieldType;
+}
+
 export interface AbstractCompositeFilter extends AbstractFilter {
     type: "and" | "or";
     filters?: AbstractFilterUnion[];
@@ -298,8 +301,8 @@ export interface FilterVisitor<T> {
 export interface MapBoundedBoxFilter extends AbstractFilter {
     type: "box";
     coordinates?: number[][];
-    bottomRight?: Coordinate;
     topLeft?: Coordinate;
+    bottomRight?: Coordinate;
 }
 
 export interface MapBoundedPolygonFilter extends AbstractFilter {
@@ -343,8 +346,8 @@ export interface QueryFilter extends AbstractFilter {
 export interface TermsFilter extends AbstractFilter {
     type: "terms";
     field?: string;
-    terms?: any[];
     objectType?: string;
+    terms?: any[];
 }
 
 export interface TypeFilter extends AbstractFilter {
@@ -378,8 +381,8 @@ export interface Edge extends Endpoint {
     endpoints?: EndpointUnion[];
     subtype?: string;
     label?: string;
-    validFrom?: Date;
-    validTo?: Date;
+    validFrom?: string;
+    validTo?: string;
     fields?: SummaryFieldValue[];
     style?: RelationshipStyle;
 }
@@ -423,8 +426,8 @@ export interface Vertex extends Endpoint {
     typeLabel?: string;
     label?: string;
     attachmentsCount?: number;
-    validFrom?: Date;
-    validTo?: Date;
+    validFrom?: string;
+    validTo?: string;
     style?: EntityStyle;
 }
 
@@ -442,6 +445,7 @@ export interface ChildObjectHighlighting {
     id?: string;
     name?: string;
     highlighting?: { [index: string]: any[] };
+    maskedFields?: { [index: string]: MaskedFieldConfiguration };
 }
 
 export interface ObjectId extends Serializable {
@@ -532,6 +536,7 @@ export interface NumericalRangeBuilder {
 
 export interface Range<V> {
     description?: string;
+    id?: string;
     gt?: V;
     gte?: V;
     lt?: V;
@@ -616,8 +621,8 @@ export interface TraversalRepresentation {
     edgeFilter?: AbstractFilterUnion;
     depth?: number;
     extendedFormat?: boolean;
-    graphCompoundValues?: string[];
     graphObjectIds?: ObjectId[];
+    graphCompoundValues?: string[];
 }
 
 export interface AnalyticsCategoriesResponse extends ResponsesErrorResponse {
@@ -681,6 +686,7 @@ export interface HighlightResponse extends ResponsesErrorResponse {
     defaultChildEntityLimit?: number;
     fieldHighlighting?: { [index: string]: any[] };
     childEntityHighlighting?: { [index: string]: ChildEntityHighlighting };
+    maskedFields?: { [index: string]: MaskedFieldConfiguration };
 }
 
 export interface OperationResponse extends OperationRepresentation {
@@ -705,8 +711,8 @@ export interface Selection {
 
 export interface ManualSelection {
     query?: string;
-    compoundValues?: string[];
     objectIds?: ObjectId[];
+    compoundValues?: string[];
 }
 
 export interface EntityStyle {
@@ -757,12 +763,14 @@ export interface SummaryFieldValue {
     name?: string;
     type?: FieldType;
     value?: any;
+    masked?: MaskedFieldConfiguration;
 }
 
 export interface TableColumnHeading {
     field?: string;
     label?: string;
     type?: FieldType;
+    masked?: MaskedFieldConfiguration;
 }
 
 export interface ClusterSwimLaneEntry extends SwimLaneEntry {
@@ -779,7 +787,7 @@ export interface ObjectSwimLaneEntry extends SwimLaneEntry {
 }
 
 export interface SwimLane {
-    id?: Id;
+    id?: string;
     label?: string;
     description?: string;
     attachmentsCount?: number;
@@ -789,18 +797,15 @@ export interface SwimLane {
     objectType?: string;
 }
 
-export interface Id extends ObjectId {
-}
-
 export interface SwimLaneEntry {
     entryType: "cluster" | "object";
-    group?: Id;
-    startTimestamp?: Date;
-    endTimestamp?: Date;
+    group?: string;
+    startTimestamp?: string;
+    endTimestamp?: string;
 }
 
 export interface TimebarInterval {
-    start?: Date;
+    start?: string;
     hitCount?: number;
 }
 
@@ -880,9 +885,9 @@ export interface MapVisualizationResponse extends VisualizationResponse {
 
 export interface PagedVisualizationRepresentation extends VisualizationRepresentation {
     type: "PagedVisualizationRepresentation" | "summary" | "table" | "timeline";
-    order?: OrderUnion;
     start?: number;
     limit?: number;
+    order?: OrderUnion;
 }
 
 export interface PagedVisualizationResponse extends VisualizationResponse {
@@ -914,8 +919,8 @@ export interface TableVisualizationResponse extends PagedVisualizationResponse {
 
 export interface TimebarVisualizationRepresentation extends VisualizationRepresentation {
     type: "timebar";
-    startTimestamp?: Date;
-    endTimestamp?: Date;
+    startTimestamp?: string;
+    endTimestamp?: string;
     intervalCount?: number;
     geoEventsRequired?: boolean;
 }
@@ -926,8 +931,8 @@ export interface TimebarVisualizationResponse extends VisualizationResponse {
     geoEventsRequired?: boolean;
     hitCount?: number;
     eventCount?: number;
-    globalMinTime?: Date;
-    globalMaxTime?: Date;
+    globalMinTime?: string;
+    globalMaxTime?: string;
     interval?: string;
     intervalSize?: number;
     timebarIntervals?: TimebarInterval[];
@@ -935,8 +940,8 @@ export interface TimebarVisualizationResponse extends VisualizationResponse {
 
 export interface TimelineVisualizationRepresentation extends PagedVisualizationRepresentation {
     type: "timeline";
-    startTimestamp?: Date;
-    endTimestamp?: Date;
+    startTimestamp?: string;
+    endTimestamp?: string;
     intervalCount?: number;
     minimumClusterSize?: number;
     paddingFactor?: number;
@@ -948,10 +953,10 @@ export interface TimelineVisualizationResponse extends PagedVisualizationRespons
     minimumClusterSize?: number;
     paddingFactor?: number;
     eventCount?: number;
-    globalMinTime?: Date;
-    globalMaxTime?: Date;
-    minTime?: Date;
-    maxTime?: Date;
+    globalMinTime?: string;
+    globalMaxTime?: string;
+    minTime?: string;
+    maxTime?: string;
     interval?: DateTimeInterval;
     swimLanes?: SwimLane[];
     swimLaneEntries?: SwimLaneEntryUnion[];
@@ -1020,6 +1025,8 @@ export type DateTimeInterval = "oneHundredYear" | "fiftyYear" | "tenYear" | "yea
 
 export type FieldType = "boolean" | "date" | "double" | "float" | "geoPoint" | "geoShape" | "integer" | "long" | "nested" | "object" | "text";
 
+export type MaskedFieldType = "full" | "partial" | "none";
+
 export type TextFieldFeature = "search" | "facet" | "sort" | "html" | "email";
 
 export type MapRelation = "contains" | "disjoint" | "intersects" | "within";

package/svi-sand/package.json

@@ -1,5 +1,5 @@
 {
   "name": "@types/svi-sand",
-  "version": "12.4.64",
+  "version": "13.5.3",
   "types": "index.d.ts"
 }

package/tab/tab-api.d.ts

@@ -11,7 +11,7 @@ export interface TabApi {
      * @param objectId {string} ID of the object to be opened.
      * @param [suppressNavigation = false] {boolean} Allows the tab to be opened without navigating to it.
      * @param [mode = PageModeEvent.OPEN] {PageModeEvent} Mode to open the tab in.
-     * @return A promise that resolves when the tab is opened.
+     * @return A Promise that resolves when the tab is opened.
      */
     openTab(objectType: string, objectId: string, suppressNavigation?: boolean, mode?: PageModeEvent): Promise<void>;
     /**

package/theme/theme-api.d.ts

@@ -1,6 +1,6 @@
 export declare enum Theme {
     Illuminate = "sas_corporate",
-    Inspire = "sas_inspire",
+    Ignite = "sas_ignite",
     HighContrast = "sas_hcb"
 }
 /**

package/theme/theme-api.js

@@ -1,7 +1,7 @@
 export var Theme;
 (function (Theme) {
     Theme["Illuminate"] = "sas_corporate";
-    Theme["Inspire"] = "sas_inspire";
+    Theme["Ignite"] = "sas_ignite";
     Theme["HighContrast"] = "sas_hcb";
 })(Theme || (Theme = {}));
 /**

package/time-slider/index.d.ts

@@ -33,3 +33,18 @@ export interface TimeSliderRange {
     start?: Date;
     end?: Date;
 }
+export interface TimeSliderContextMenuHideOptions {
+    pointInTime?: boolean;
+    timeRange?: boolean;
+    showHistogram?: boolean;
+    closeTimeSlider?: boolean;
+}
+export interface MinMaxDates {
+    min: Date;
+    max: Date;
+}
+export interface TimeSliderRangeChangedEvent {
+    start: Date;
+    end: Date;
+    rangeChangedOutsideTimeSlider: boolean;
+}

package/traversal/traversal-api.d.ts

@@ -2,6 +2,9 @@ import { Record, Traversal } from "../svi-datahub";
 export interface TraversalWithEndpoint extends Traversal {
     endPoint?: string | null;
 }
+export interface SviRecord extends Record {
+    displayLabel?: string;
+}
 /**
  * This API provides functionality related to traversal data.
  * Accessed from the window at window.sas.vi.traversal.
@@ -15,9 +18,12 @@ export interface TraversalApi {
      * @param traversalUuids {string[]} Array of traversal UUIDs associated with the root object type.
      * @param destinationObjectType {string} Destination object's type.
      * @param fields {string[]} Names of the fields to be retrieved.
+     * @param options {object} Optional object containing options: includeDisplayLabels.
      * @returns Promise containing the array of objects with specified fields and their values.
      */
-    getFieldsByTraversals(rootObjectId: string, rootObjectType: string, traversalUuids: string[], destinationObjectType: string, fields: string[]): Promise<Record[]>;
+    getFieldsByTraversals(rootObjectId: string, rootObjectType: string, traversalUuids: string[], destinationObjectType: string, fields: string[], options?: {
+        includeDisplayLabels?: boolean;
+    }): Promise<SviRecord[]>;
     /**
      * @method
      * @description Gets all Traversals.