@sassoftware/vi-api 0.0.29

package/svi-sand/package.json

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

package/tab/package.json

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

package/tab/public-api.d.ts

@@ -0,0 +1 @@
+export * from "./tab-api";

package/tab/public-api.js

@@ -0,0 +1 @@
+export * from "./tab-api";

package/tab/tab-api.d.ts

@@ -0,0 +1,33 @@
+import { PageModeEvent } from "../control/page";
+/**
+ * This API provides the functionality related to tabs.
+ * Accessed from the window at window.sas.vi.tab.
+ */
+export interface TabApi {
+    /**
+     * @method
+     * @description Opens the tab of a specified object.
+     * @param objectType {string} Type of the object to be opened.
+     * @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.
+     */
+    openTab(objectType: string, objectId: string, suppressNavigation?: boolean, mode?: PageModeEvent): Promise<void>;
+    /**
+     * @method
+     * @description Checks to see if an open tab is dirty.
+     * @param objectType {string} Tab's object type.
+     * @param objectId {string} An open tab's object ID.
+     * @return true/false if the tab is dirty/not.
+     */
+    isOpenTabDirty(objectType: string, objectId: string): boolean;
+    /**
+     * @method
+     * @description Sets the dirty state of an open tab.
+     * @param objectType {string} Open tab's object type.
+     * @param objectId {string} Open tab's object ID.
+     * @param dirtyState {boolean} Sets the tab's dirty state.
+     */
+    setOpenTabDirty(objectType: string, objectId: string, dirtyState: boolean): Promise<void>;
+}

package/tab/tab-api.js

@@ -0,0 +1 @@
+export {};

package/theme/package.json

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

package/theme/public-api.d.ts

@@ -0,0 +1 @@
+export * from "./theme-api";

package/theme/public-api.js

@@ -0,0 +1 @@
+export * from "./theme-api";

package/theme/theme-api.d.ts

@@ -0,0 +1,35 @@
+export declare enum Theme {
+    Illuminate = "sas_corporate",
+    Inspire = "sas_inspire",
+    HighContrast = "sas_hcb"
+}
+/**
+ * This API provides the functionality related to SAS Visual Investigator's application theme.
+ * Accessed from the window at window.sas.vi.theme.
+ */
+export interface ThemeApi {
+    /**
+     * @method
+     * @description Gets the current theme.
+     * @returns The current theme.
+     */
+    getCurrent(): Theme;
+    /**
+     * @method
+     * @description Callback function when the theme is changed.
+     * @param {ThemeApi~themeChangeHandler} Function to be called when a theme is changed.
+     * @returns {ThemeApi~stopThemeChangeHandler} A function that, when invoked, stops the callback from being called.
+     */
+    onChange(callback: (themeName: Theme) => void): () => void;
+}
+/**
+ * A callback function to handle theme changes.
+ * @callback ThemeApi~themeChangeHandler
+ * @param {theme} themeName New theme.
+ * @returns {void}
+ */
+/**
+ * Stops handling theme change events.
+ * @callback ThemeApi~stopThemeChangeHandler
+ * @returns {void}
+ */

package/theme/theme-api.js

@@ -0,0 +1,17 @@
+export var Theme;
+(function (Theme) {
+    Theme["Illuminate"] = "sas_corporate";
+    Theme["Inspire"] = "sas_inspire";
+    Theme["HighContrast"] = "sas_hcb";
+})(Theme || (Theme = {}));
+/**
+ * A callback function to handle theme changes.
+ * @callback ThemeApi~themeChangeHandler
+ * @param {theme} themeName New theme.
+ * @returns {void}
+ */
+/**
+ * Stops handling theme change events.
+ * @callback ThemeApi~stopThemeChangeHandler
+ * @returns {void}
+ */

package/time-slider/index.d.ts

@@ -0,0 +1,35 @@
+/**
+ * This is the set of from and to events that is used to
+ * build the histogram within the time slider.
+ */
+export interface TimeSliderEventDates {
+    fromEvents: Date[];
+    toEvents: Date[];
+}
+export declare enum DateTimeInterval {
+    Second = "second",
+    Minute = "minute",
+    Hour = "hour",
+    Day = "day",
+    Week = "week",
+    Month = "month",
+    Year = "year",
+    Quarter = "qtr",
+    Millisecond = "millisecond"
+}
+export declare enum HandleType {
+    Single = 1,
+    Double = 2
+}
+/**
+ * The time-slider.component.ts uses a single or double handled slider
+ * to specify a range of dates. This interface is the data associated
+ * with that range. It accommodates a single or double handled range.
+ *
+ * For a single handled slider, the start and end dates are the same.
+ *
+ */
+export interface TimeSliderRange {
+    start?: Date;
+    end?: Date;
+}

package/time-slider/index.js

@@ -0,0 +1,17 @@
+export var DateTimeInterval;
+(function (DateTimeInterval) {
+    DateTimeInterval["Second"] = "second";
+    DateTimeInterval["Minute"] = "minute";
+    DateTimeInterval["Hour"] = "hour";
+    DateTimeInterval["Day"] = "day";
+    DateTimeInterval["Week"] = "week";
+    DateTimeInterval["Month"] = "month";
+    DateTimeInterval["Year"] = "year";
+    DateTimeInterval["Quarter"] = "qtr";
+    DateTimeInterval["Millisecond"] = "millisecond";
+})(DateTimeInterval || (DateTimeInterval = {}));
+export var HandleType;
+(function (HandleType) {
+    HandleType[HandleType["Single"] = 1] = "Single";
+    HandleType[HandleType["Double"] = 2] = "Double";
+})(HandleType || (HandleType = {}));

package/traversal/package.json

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

package/traversal/public-api.d.ts

@@ -0,0 +1 @@
+export * from "./traversal-api";

package/traversal/public-api.js

@@ -0,0 +1 @@
+export * from "./traversal-api";

package/traversal/traversal-api.d.ts

@@ -0,0 +1,34 @@
+import { Record, Traversal } from "../svi-datahub";
+export interface TraversalWithEndpoint extends Traversal {
+    endPoint?: string | null;
+}
+/**
+ * This API provides functionality related to traversal data.
+ * Accessed from the window at window.sas.vi.traversal.
+ */
+export interface TraversalApi {
+    /**
+     * @method
+     * @description Gets field values from a list of traversals.
+     * @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.
+     * @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[]>;
+    /**
+     * @method
+     * @description Gets all Traversals.
+     * @returns Promise containing the array of Traversals.
+     */
+    getTraversals(): Promise<TraversalWithEndpoint[]>;
+    /**
+     * @method
+     * @description Gets a traversal with the specified UUID parameter.
+     * @param uuid {string} UUID of the traversal to be returned.
+     * @returns Promise containing the specified traversal.
+     */
+    getTraversalByUuid(uuid: string): Promise<Traversal>;
+}

package/traversal/traversal-api.js

@@ -0,0 +1 @@
+export {};