@sassoftware/vi-api 0.0.29 → 1.5.0

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 2022-11-08 04:55:34.
 
 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 {
@@ -343,8 +342,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 {
@@ -532,6 +531,7 @@ export interface NumericalRangeBuilder {
 
 export interface Range<V> {
     description?: string;
+    id?: string;
     gt?: V;
     gte?: V;
     lt?: V;
@@ -616,8 +616,8 @@ export interface TraversalRepresentation {
     edgeFilter?: AbstractFilterUnion;
     depth?: number;
     extendedFormat?: boolean;
-    graphCompoundValues?: string[];
     graphObjectIds?: ObjectId[];
+    graphCompoundValues?: string[];
 }
 
 export interface AnalyticsCategoriesResponse extends ResponsesErrorResponse {
@@ -705,8 +705,8 @@ export interface Selection {
 
 export interface ManualSelection {
     query?: string;
-    compoundValues?: string[];
     objectIds?: ObjectId[];
+    compoundValues?: string[];
 }
 
 export interface EntityStyle {
@@ -880,9 +880,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 {

package/tab/tab-api.service.js

@@ -0,0 +1,35 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+import { Injectable } from "@angular/core";
+import { getAngularJsInjectable } from "../../commons/angular-angularjs-utils";
+import { zoneWrap } from "../../commons/api-utils";
+let TabApiService = class TabApiService {
+    constructor(ngZone) {
+        this.ngZone = ngZone;
+        this.tabService = () => getAngularJsInjectable("spbDocumentTabService");
+        this.openTab = (objectType, objectId, suppressNavigation = false, mode = "open" /* OPEN */) => {
+            return this.tabService().openDocumentTab(objectId, objectType, suppressNavigation, mode);
+        };
+        this.isOpenTabDirty = (objectType, objectId) => {
+            return this.tabService().getDirty(objectType, objectId);
+        };
+        this.setOpenTabDirty = (objectType, objectId, dirtyState) => {
+            return this.tabService().setTabDirtyState(objectType, objectId, dirtyState);
+        };
+    }
+    getApi() {
+        return {
+            openTab: zoneWrap(this.openTab, this.ngZone),
+            isOpenTabDirty: this.isOpenTabDirty,
+            setOpenTabDirty: zoneWrap(this.setOpenTabDirty, this.ngZone)
+        };
+    }
+};
+TabApiService = __decorate([
+    Injectable()
+], TabApiService);
+export { TabApiService };

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/theme/theme-api.service.js

@@ -0,0 +1,35 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+import { Injectable } from "@angular/core";
+import { getAngularJsInjectable } from "../../commons/angular-angularjs-utils";
+let ThemeApiService = class ThemeApiService {
+    constructor(eventService) {
+        this.eventService = eventService;
+        this.themeService = () => getAngularJsInjectable("sngThemeService");
+        this.getCurrent = () => {
+            return this.themeService().getCurrentTheme();
+        };
+        this.onChange = (callback) => {
+            const subscription = this.eventService.subscribe(this.themeService().themeChangedEventName, (event) => {
+                callback(event.args.newValue);
+            });
+            return () => {
+                subscription?.unsubscribe();
+            };
+        };
+    }
+    getApi() {
+        return {
+            getCurrent: this.getCurrent,
+            onChange: this.onChange
+        };
+    }
+};
+ThemeApiService = __decorate([
+    Injectable()
+], ThemeApiService);
+export { ThemeApiService };

package/time-slider/index.d.ts

@@ -33,3 +33,9 @@ export interface TimeSliderRange {
     start?: Date;
     end?: Date;
 }
+export interface TimeSliderContextMenuHideOptions {
+    pointInTime?: boolean;
+    timeRange?: boolean;
+    showHistogram?: boolean;
+    closeTimeSlider?: 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.

package/traversal/traversal-api.service.js

@@ -0,0 +1,77 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+import { Injectable } from "@angular/core";
+import { map } from "rxjs/operators";
+let TraversalApiService = class TraversalApiService {
+    constructor(adminTraversalsClientService, pathService) {
+        this.adminTraversalsClientService = adminTraversalsClientService;
+        this.pathService = pathService;
+        /**
+         * Gets an array of Records from a list of given traversals filtered by destinationType.
+         * The returned records will contain the values for fields specified in the fields param.
+         * @param rootObjectId {string} Traversal's root object ID.
+         * @param rootObjectType {string} Traversal's root object Type.
+         * @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<SviRecord[]>} An array of SviRecords for the given Traversal.
+         */
+        this.getFieldsByTraversals = (rootObjectId, rootObjectType, traversalUuids, destinationObjectType, fields, options) => {
+            return this.pathService
+                .getRecordValuesByTraversals(rootObjectId, rootObjectType, traversalUuids, destinationObjectType, fields, options)
+                .toPromise()
+                .then((result) => {
+                return result || [];
+            })
+                .catch((err) => Promise.reject(err?.message));
+        };
+        this.getTraversals = () => {
+            return this.adminTraversalsClientService
+                .getTraversals()
+                .pipe(map(result => (result.body ? this.addTraversalEndPoint(result.body) : [])))
+                .toPromise()
+                .catch(err => Promise.reject(err?.error?.message));
+        };
+        /**
+         * Adds the traversal end point to the top level of the object.
+         * @param traversals {Traversal[]} Traversals that need end points added.
+         * @returns {TraversalWithEndpoint[]} Array of traversals with end points.
+         * @ignore
+         */
+        this.addTraversalEndPoint = (traversals) => {
+            traversals?.forEach((traversal) => {
+                let traversalBranch = traversal.traversalDefinition;
+                if (traversalBranch) {
+                    while (traversalBranch.nextLevel) {
+                        traversalBranch = traversalBranch.nextLevel;
+                    }
+                    traversal.endPoint = traversalBranch.vertexTypes ? traversalBranch.vertexTypes[0] : null;
+                }
+            });
+            return traversals;
+        };
+        this.getTraversalByUuid = (uuid) => {
+            return this.adminTraversalsClientService
+                .getTraversalByUuid(uuid)
+                .pipe(map(result => result.body))
+                .toPromise()
+                .catch(err => Promise.reject(err?.error?.message));
+        };
+    }
+    getApi() {
+        return {
+            getFieldsByTraversals: this.getFieldsByTraversals,
+            getTraversals: this.getTraversals,
+            getTraversalByUuid: this.getTraversalByUuid
+        };
+    }
+};
+TraversalApiService = __decorate([
+    Injectable()
+], TraversalApiService);
+export { TraversalApiService };

package/alert-reps/package.json

@@ -1,5 +0,0 @@
-{
-  "name": "@types/alert-reps",
-  "version": "14.3.63",
-  "types": "index.d.ts"
-}

package/component/package.json

@@ -1,9 +0,0 @@
-{
-    "name": "@sassoftware/vi-api/component",
-    "files": [
-        "**/*.d.ts",
-        "**/*.js"
-    ],
-    "main": "public-api.js",
-    "types": "public-api.d.ts"
-}

package/config/package.json

@@ -1,9 +0,0 @@
-{
-    "name": "@sassoftware/vi-api/config",
-    "files": [
-        "**/*.d.ts",
-        "**/*.js"
-    ],
-    "main": "public-api.js",
-    "types": "public-api.d.ts"
-}

package/control/package.json

@@ -1,9 +0,0 @@
-{
-    "name": "@sassoftware/vi-api/control",
-    "files": [
-        "**/*.d.ts",
-        "**/*.js"
-    ],
-    "main": "public-api.js",
-    "types": "public-api.d.ts"
-}

package/current-user/package.json

@@ -1,9 +0,0 @@
-{
-    "name": "@sassoftware/vi-api/current-user",
-    "files": [
-        "**/*.d.ts",
-        "**/*.js"
-    ],
-    "main": "public-api.js",
-    "types": "public-api.d.ts"
-}

package/event/package.json

@@ -1,9 +0,0 @@
-{
-    "name": "@sassoftware/vi-api/event",
-    "files": [
-        "**/*.d.ts",
-        "**/*.js"
-    ],
-    "main": "public-api.js",
-    "types": "public-api.d.ts"
-}

package/file/package.json

@@ -1,9 +0,0 @@
-{
-    "name": "@sassoftware/vi-api/file",
-    "files": [
-        "**/*.d.ts",
-        "**/*.js"
-    ],
-    "main": "public-api.js",
-    "types": "public-api.d.ts"
-}

package/http/package.json

@@ -1,9 +0,0 @@
-{
-    "name": "@sassoftware/vi-api/http",
-    "files": [
-        "**/*.d.ts",
-        "**/*.js"
-    ],
-    "main": "public-api.js",
-    "types": "public-api.d.ts"
-}

package/localization/package.json

@@ -1,9 +0,0 @@
-{
-    "name": "@sassoftware/vi-api/localization",
-    "files": [
-        "**/*.d.ts",
-        "**/*.js"
-    ],
-    "main": "public-api.js",
-    "types": "public-api.d.ts"
-}

package/metadata/package.json

@@ -1,9 +0,0 @@
-{
-    "name": "@sassoftware/vi-api/metadata",
-    "files": [
-        "**/*.d.ts",
-        "**/*.js"
-    ],
-    "main": "public-api.js",
-    "types": "public-api.d.ts"
-}

package/object/package.json

@@ -1,9 +0,0 @@
-{
-    "name": "@sassoftware/vi-api/object",
-    "files": [
-        "**/*.d.ts",
-        "**/*.js"
-    ],
-    "main": "public-api.js",
-    "types": "public-api.d.ts"
-}

package/page-admin/package.json

@@ -1,9 +0,0 @@
-{
-    "name": "@sassoftware/vi-api/page-admin",
-    "files": [
-        "**/*.d.ts",
-        "**/*.js"
-    ],
-    "main": "public-api.js",
-    "types": "public-api.d.ts"
-}

package/page-model/package.json

@@ -1,9 +0,0 @@
-{
-    "name": "@sassoftware/vi-api/page-model",
-    "files": [
-        "**/*.d.ts",
-        "**/*.js"
-    ],
-    "main": "public-api.js",
-    "types": "public-api.d.ts"
-}

package/page-state/package.json

@@ -1,9 +0,0 @@
-{
-    "name": "@sassoftware/vi-api/page-state",
-    "files": [
-        "**/*.d.ts",
-        "**/*.js"
-    ],
-    "main": "public-api.js",
-    "types": "public-api.d.ts"
-}

package/property/package.json

@@ -1,9 +0,0 @@
-{
-    "name": "@sassoftware/vi-api/property",
-    "files": [
-        "**/*.d.ts",
-        "**/*.js"
-    ],
-    "main": "public-api.js",
-    "types": "public-api.d.ts"
-}

package/reference-data/package.json

@@ -1,9 +0,0 @@
-{
-    "name": "@sassoftware/vi-api/reference-data",
-    "files": [
-        "**/*.d.ts",
-        "**/*.js"
-    ],
-    "main": "public-api.js",
-    "types": "public-api.d.ts"
-}

package/resource/package.json

@@ -1,9 +0,0 @@
-{
-    "name": "@sassoftware/vi-api/resource",
-    "files": [
-        "**/*.d.ts",
-        "**/*.js"
-    ],
-    "main": "public-api.js",
-    "types": "public-api.d.ts"
-}

package/score-reps/package.json

@@ -1,5 +0,0 @@
-{
-  "name": "@types/score-reps",
-  "version": "2.3.63",
-  "types": "index.d.ts"
-}

package/search/package.json

@@ -1,9 +0,0 @@
-{
-    "name": "@sassoftware/vi-api/search",
-    "files": [
-        "**/*.d.ts",
-        "**/*.js"
-    ],
-    "main": "public-api.js",
-    "types": "public-api.d.ts"
-}

package/sheet/package.json

@@ -1,9 +0,0 @@
-{
-    "name": "@sassoftware/vi-api/sheet",
-    "files": [
-        "**/*.d.ts",
-        "**/*.js"
-    ],
-    "main": "public-api.js",
-    "types": "public-api.d.ts"
-}

package/svi-datahub/package.json

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

package/svi-sand/package.json

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

package/tab/package.json

@@ -1,9 +0,0 @@
-{
-    "name": "@sassoftware/vi-api/tab",
-    "files": [
-        "**/*.d.ts",
-        "**/*.js"
-    ],
-    "main": "public-api.js",
-    "types": "public-api.d.ts"
-}

package/theme/package.json

@@ -1,9 +0,0 @@
-{
-    "name": "@sassoftware/vi-api/theme",
-    "files": [
-        "**/*.d.ts",
-        "**/*.js"
-    ],
-    "main": "public-api.js",
-    "types": "public-api.d.ts"
-}

package/traversal/package.json

@@ -1,9 +0,0 @@
-{
-    "name": "@sassoftware/vi-api/traversal",
-    "files": [
-        "**/*.d.ts",
-        "**/*.js"
-    ],
-    "main": "public-api.js",
-    "types": "public-api.d.ts"
-}