@sassoftware/vi-api 0.0.29

package/search/client/client-search-api.d.ts

@@ -0,0 +1,159 @@
+import { Relationship } from "../../svi-datahub";
+import { MapBoundedBoxFilter, MapBoundedPolygonFilter, MapRadiusFilter, MapShapeFilter, QueryMode, SearchRepresentation, SearchResponse } from "../../svi-sand";
+import { ObjectIdentifier } from "../../object/object-api";
+import { QueryBuilderModel, SearchApi } from "../search-api";
+export declare enum SearchVisualization {
+    Summary = "summary",
+    Map = "map",
+    Table = "table"
+}
+export declare enum Visualization {
+    Summary = "summary",
+    Map = "map",
+    Table = "table",
+    Timeline = "timeline",
+    Network = "network"
+}
+export declare type MapFilter = MapBoundedPolygonFilter | MapRadiusFilter | MapBoundedBoxFilter | MapShapeFilter;
+export interface SearchQuery {
+    additionalModes?: string[];
+    queryText: string;
+    visualizationName?: Visualization;
+}
+export interface NetworkData {
+    nodes: Array<{
+        type: string;
+        id: string;
+    }>;
+    links: Array<{
+        source: string;
+        target: string;
+        id: string;
+        type: string;
+    }>;
+    options: {
+        showLinkLabels?: boolean;
+        showNodeAnnotation?: boolean;
+        showNodeLabels?: boolean;
+        showTimeline?: boolean;
+        showTransactionDetails?: boolean;
+        showTransactionLinks?: boolean;
+    };
+}
+export interface ResolvedObjectIdentifier extends ObjectIdentifier {
+    compoundValues: string[];
+}
+export interface SearchAndCreateDialogModel {
+    entityName: string;
+    entityLabel: string;
+    relateToParentName?: string;
+    relateToParentLabel?: string;
+    canCreate?: boolean;
+    linkReasons?: Relationship[];
+}
+export interface SearchObject extends ObjectIdentifier {
+    title?: string;
+    isResolvedEntity?: boolean;
+    typeLabel?: string;
+    uniqueKey?: string;
+    compoundValues?: string[];
+}
+export interface SearchAndCreateRelateToModel {
+    linkReason?: Relationship;
+    relateToTargetId?: string;
+    relateToTargetType?: string;
+}
+export interface SearchAndCreateResponse {
+    selectedItem?: SearchObject;
+    relateToModel?: SearchAndCreateRelateToModel;
+}
+/**
+ * {@link SearchApi} extension pertains to functionality related to SAS Visual Investigators search capabilities.
+ * These additional methods are available only in the SAS Visual Investigator Client Application.
+ * Accessed from the window at window.sas.vi.search.
+ * @extends SearchApi
+ */
+export interface ClientSearchApi extends SearchApi {
+    /**
+     * @method
+     * @description Performs a search against the svi-sand service.
+     * @param query {SearchRepresentation} Query to send to the service.
+     * @returns A promise containing the search response.
+     */
+    performSearch(query: SearchRepresentation): Promise<SearchResponse>;
+    /**
+     * @method
+     * @description Performs a search against the svi-sand service and navigates the user to the Search Results page.
+     * @param queryText {string} Text used to form the query.
+     * @param visualizationName {"summary" | "map" | "table"} Visualization to query for and then display to the user.
+     * @param [mapFilters] {MapFilter[]} The map filter object to include with the search query. This can consist of MapBoundedPolygonFilter, MapRadiusFilter, MapBoundedBoxFilter or MapShapeFilter.
+     * @param [queryMode] {"standard" | "phonetic" | "synonym"} Used to perform phonetic and synonym searches. Default is "standard".
+     */
+    navigateSearch(queryText: string, visualizationName: SearchVisualization, mapFilters?: MapFilter[], queryMode?: QueryMode[]): Promise<void>;
+    /**
+     * @method
+     * @description Gets the current search query if one exists. Otherwise undefined.
+     */
+    getCurrentSearchQuery(): SearchQuery | undefined;
+    /**
+     * @method
+     * @description Converts a query model generated by the query builder to a string.
+     * @param queryModel {QueryBuilderModel} Query builder model.
+     * @returns A promise containing the string representation of the query.
+     */
+    createQueryStringFromModel(queryModel: QueryBuilderModel): Promise<string>;
+    /**
+     * @method
+     * @description Gets the query builder model for the given ID. If no ID is given, it returns the query model for SEARCH.
+     * @param [id] {string} ID of the model to get. Defaults to SEARCH.
+     * @returns A query builder model.
+     */
+    getQueryBuilderModel(id?: string): QueryBuilderModel | undefined;
+    /**
+     * @method
+     * @description Sets the query builder model for the given ID. If no ID is given, it sets the query model for SEARCH.
+     * Once stored, the query model is used to initially populate a Query Builder opened with the given ID.
+     * @param queryModel {QueryBuilderModel} A query builder model.
+     * @param [id] {string} ID of the model to set. Defaults to SEARCH.
+     */
+    setQueryBuilderModel(queryModel: QueryBuilderModel, id?: string): void;
+    /**
+     * @method
+     * @description Opens up the "Add Objects to Workspace" dialog box and then performs the action once a document and workspace have been selected.
+     * @param visualizationName {Visualization} Visualization to initially display once the objects have been added.
+     * @param objects {Array<ObjectIdentifier | ResolvedObjectIdentifier>} Objects to add to the workspace.
+     * @param [currentObject] {ObjectIdentifier} The document the user is currently viewing. This is used as a visual aid in the dialog box.
+     * @param [networkData] {NetworkData} Network visualization data to be copied to the workspace.
+     */
+    openAddObjectsToWorkspaceDialog(visualizationName: Visualization, objects: Array<ObjectIdentifier | ResolvedObjectIdentifier>, currentObject?: ObjectIdentifier, networkData?: NetworkData): Promise<void>;
+    /**
+     * @method
+     * @description Adds an image to the Insights selected in the "Add image to Insights" dialog box.
+     * @param imageData {Uint8Array} Image to add.
+     * @param contentType {string} This is used in the content-type header when the file is uploaded. For example 'image/png'.
+     * @param [height] {string} Height of the Insights cell.
+     * @param [width] {string} Width of the Insights cell.
+     */
+    openAddImageToInsightsDialog(imageData: Uint8Array, contentType: string, height?: string, width?: string): Promise<void>;
+    /**
+     * @method
+     * @description Creates a new workspace in the target object, populating it with an initial set of objects.
+     * Allows the creation of new objects assuming create mode is supported for the object type.
+     * @param objectsToAdd {Array<ObjectIdentifier | ResolvedObjectIdentifier>} Objects to add to the workspace.
+     * @param targetObjectType {string} Object type where the workspace is created.
+     * @param [targetObjectId] {string} Object to add to the workspace. If undefined, a new object is created.
+     * @param [visualization] {"summary" | "map" | "table" | "timeline" | "network"} Visualization to initially display in the new workspace.
+     * @param [workspaceName] {string} Name of the new workspace.
+     * @param [networkData] {NetworkData} Network visualization data to be copied to the new workspace.
+     */
+    addToNewWorkspace(objectsToAdd: Array<ObjectIdentifier | ResolvedObjectIdentifier>, targetObjectType: string, targetObjectId?: string, visualization?: Visualization, workspaceName?: string, networkData?: NetworkData): Promise<void>;
+    /**
+     * @method
+     * @description Launches a wizard allowing users to search first, before creating an object/relationship.
+     * Relationship wizard is determined by relateToParentLabel or relateToParentName being defined within the wizardValues parameter.
+     * @param wizardValues {SearchAndCreateDialogModel} Object containing entity and relationship data.
+     * @param [onRelationshipSuccess] {function} A callback function that is defined when creating a relationship.
+     * It is invoked when a relationship is saved successfully.
+     */
+    openSearchAndCreateDialog(wizardValues: SearchAndCreateDialogModel, onRelationshipSuccess?: () => void): Promise<SearchAndCreateResponse>;
+}

package/search/client/client-search-api.js

@@ -0,0 +1,14 @@
+export var SearchVisualization;
+(function (SearchVisualization) {
+    SearchVisualization["Summary"] = "summary";
+    SearchVisualization["Map"] = "map";
+    SearchVisualization["Table"] = "table";
+})(SearchVisualization || (SearchVisualization = {}));
+export var Visualization;
+(function (Visualization) {
+    Visualization["Summary"] = "summary";
+    Visualization["Map"] = "map";
+    Visualization["Table"] = "table";
+    Visualization["Timeline"] = "timeline";
+    Visualization["Network"] = "network";
+})(Visualization || (Visualization = {}));

package/search/package.json

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

package/search/public-api.d.ts

@@ -0,0 +1,2 @@
+export * from "./client/client-search-api";
+export * from "./search-api";

package/search/public-api.js

@@ -0,0 +1,2 @@
+export * from "./client/client-search-api";
+export * from "./search-api";

package/search/search-api.d.ts

@@ -0,0 +1,72 @@
+export interface QueryBuilderItem {
+    booleanValue?: boolean | string;
+    boost?: number;
+    dateTimeValue?: string;
+    dateValue?: string;
+    exclude?: boolean;
+    field?: string;
+    fromDateTimeValue?: string;
+    fromDateValue?: string;
+    fromNumericValue?: number;
+    numericValue?: number;
+    operator?: string;
+    phonetic?: boolean;
+    previousField?: string;
+    proximity?: number;
+    rangeValidationError?: boolean;
+    referenceValue?: string;
+    relationshipField?: boolean;
+    relationshipTypeValue?: string;
+    relativeDateDatetimeNumericValue?: number;
+    relativeDateDatetimeUnitsValue?: string;
+    stringValidationError?: boolean;
+    synonym?: boolean;
+    textValue?: string;
+    toDateTimeValue?: string;
+    toDateValue?: string;
+    toNumericValue?: number;
+    userGroupValue?: Array<{
+        id: string;
+        type: string;
+    }>;
+}
+export interface QueryBuilderEntityModel {
+    entity: string;
+    queries: QueryBuilderItem[];
+    singleChildSearch?: boolean;
+}
+export interface QueryBuilderModel {
+    manualQueryString?: string;
+    model: QueryBuilderEntityModel[];
+}
+export interface QueryBuilderResult {
+    queryString: string;
+    queryModel: QueryBuilderModel;
+}
+/**
+ * This API pertains to functionality related to SAS Visual Investigator's search capabilities.
+ * Accessed from the window at window.sas.vi.search.
+ */
+export interface SearchApi {
+    /**
+     * @method
+     * @description Opens the query builder dialog allowing the user to create a new query or edit an existing one passed in via the
+     * query model parameter.
+     * @param dialogTitle {string} Title of the dialog.
+     * @param [submitButtonText] {string} Text for the dialog submit button.
+     * @param [queryModel] {QueryBuilderModel} An existing query model that can be used to initially populate the query builder.
+     * @param [enforceObjectType] {string} If enforceObjectType is set, the user cannot choose which entity to query. It is pre-set to the specified entity.
+     * @param [restrictObjectTypes] {Array<string>} If restrictObjectTypes is set, then the entity dropdown is filtered to show only the entities in this list.
+     * @returns A promise containing the result of the dialog box.
+     * @example
+     * const searchApi: SearchApi = window.sas.vi.search;
+     * const dialogTitle = 'Intelligence Search'
+     * const submitButtonText = 'Submit'
+     * const objectType = 'intel'
+     *
+     * searchApi.openQueryBuilderDialog(dialogTitle, submitButtonText, undefined, objectType).then( (query) => {
+     *     // Perform query action
+     * })
+     */
+    openQueryBuilderDialog(dialogTitle: string, submitButtonText?: string, queryModel?: QueryBuilderModel, enforceObjectType?: string, restrictObjectTypes?: string[]): Promise<QueryBuilderResult>;
+}

package/search/search-api.js

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

package/sheet/package.json

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

package/sheet/public-api.d.ts

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

package/sheet/public-api.js

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

package/sheet/sheet-api.d.ts

@@ -0,0 +1,184 @@
+import { ObjectIdentifier, ObjectSheetSettings, VIObject } from "../object/object-api";
+import { NetworkData, ResolvedObjectIdentifier, Visualization } from "../search/client/client-search-api";
+/**
+ * This API pertains to functionality related to SAS Visual Investigators sheet capabilities.
+ * Accessed from the window at window.sas.vi.sheet.
+ */
+export interface SheetApi {
+    /**
+     * @method
+     * @description Gets a specified object that is currently open and allows sheets.
+     * @param objectId {string} Open object's ID.
+     * @param objectType {string} Open object's type.
+     * @returns The specified object or undefined if it is not found.
+     */
+    getOpenObject(objectId: string, objectType: string): VIObject | undefined;
+    /**
+     * @method
+     * @description Gets all of the objects currently open that allow sheets.
+     * @returns A list of currently open objects or an empty list if none are found.
+     */
+    getOpenObjects(): VIObject[];
+    /**
+     * @method
+     * @description Gets the open object containing the specified sheet.
+     * @param sheet {ClientSheet} Sheet contained within the expected object.
+     * @returns The requested object or undefined if it could not be found.
+     */
+    getOpenObjectBySheet(sheet: ClientSheet): VIObject | undefined;
+    /**
+     * @method
+     * @description Creates and returns the list containing all Context Menu Items for a right-click on a network diagram node.
+     * The menu is not rendered on the network diagram.
+     * @param workspace {ClientSheet} Workspace containing the network.
+     * @param handleAddToWorkspaceFn {function} A callback to handle adding the selected nodes to a Workspace.
+     * @param handleAddToInsightsFn {function} A callback to handle adding the NLD to an Insight.
+     * @returns Promise resolving to the list containing all Context Menu Items.
+     */
+    createContextMenuForNodes(workspace: ClientSheet, handleAddToWorkspaceFn: () => void, handleAddToInsightsFn: () => void): Promise<ContextMenuItem[]>;
+    /**
+     * @method
+     * @description Adds objects to a workspace selected in the "Add Objects to Workspace" dialog box.
+     * @param objects {Array<ObjectIdentifier> | ResolvedObjectIdentifier} Objects to add to a workspace.
+     * @param [options] {AddAllObjectsToWorkspaceDialogOptions} Additional options to customize the dialog box and select the Visualization to display after the objects are added.
+     */
+    openAddAllObjectsToWorkspaceDialog(objects: Array<ObjectIdentifier | ResolvedObjectIdentifier>, options?: AddAllObjectsToWorkspaceDialogOptions): Promise<void>;
+    /**
+     * @method
+     * @description Adds an image to the Insights selected in the "Add image to Insights" dialog box.
+     * @param imageData {Uint8Array | HTMLElement} Image to add. Either directly as an array of bytes or from an HTMLElement on the page.
+     * @param [contentType="image/png"] {string} Used in the content-type header when the file is uploaded.
+     * @param [height] {string} Height of the Insights cell.
+     * @param [width] {string} Width of the Insights cell.
+     */
+    openAddImageToInsightsDialog(imageData: Uint8Array | HTMLElement, contentType: string, height?: string, width?: string): Promise<void>;
+    /**
+     * @method
+     * @description Creates a new workspace in the target object, populating it with an initial set of objects.
+     * Allows the creation of new objects assuming create mode is supported for the object type.
+     * If options.targetObjectId is undefined, then a new object is created.
+     * @param objectsToAdd {Array<ObjectIdentifier | ResolvedObjectIdentifier>} Objects to add to the new workspace.
+     * @param targetObjectType {string} Object type where the workspace is created.
+     * @param [options] {AddToNewWorkspaceOptions} Additional options to set a target object ID, workspace name and so on.
+     */
+    addToNewWorkspace(objectsToAdd: Array<ObjectIdentifier | ResolvedObjectIdentifier>, targetObjectType: string, options: AddToNewWorkspaceOptions): Promise<void>;
+    /**
+     * @method
+     * @description Adds objects to an existing workspace.
+     * @param targetObject {VIObject} Object containing the existing workspace.
+     * @param workspaceClientId {string} Client ID of the workspace to add to.
+     * @param objectsToAdd {Array<ObjectIdentifier | ResolvedObjectIdentifier>} Objects to add. It is safe to pass objects that are already in the workspace.
+     * @param [networkData] {NetworkData} If provided, network data that shall be merged into any existing network data on the workspace.
+     * @param [isUndoRedo] {boolean} Specifies if the function was called as part of an undo/redo operation.
+     */
+    addToExistingWorkspace(targetObject: VIObject, workspaceClientId: string, objectsToAdd: Array<ObjectIdentifier | ResolvedObjectIdentifier>, networkData?: NetworkData, isUndoRedo?: boolean): Promise<void>;
+}
+export interface AddAllObjectsToWorkspaceDialogOptions {
+    /**
+     * The visualization to initially display once the objects have been added
+     */
+    visualizationName?: Visualization;
+    /**
+     * The object the user is currently viewing. This is used as a visual aid in the dialog
+     */
+    currentObject?: ObjectIdentifier;
+    /**
+     * Network visualization data to be copied to the workspace
+     */
+    networkData?: NetworkData;
+}
+export interface AddToNewWorkspaceOptions {
+    /**
+     * The object to add the workspace to. If undefined a new object will be created.
+     */
+    targetObjectId?: string;
+    /**
+     * The visualization to initially display in the new workspace.
+     */
+    visualization?: Visualization;
+    /**
+     * The name of the new workspace.
+     */
+    workspaceName?: string;
+    /**
+     * Network visualization data to be copied to the new workspace.
+     */
+    networkData?: NetworkData;
+}
+export interface ContextMenuItem {
+    /**
+     * The default label string for the menu item.
+     */
+    label?: string;
+    /**
+     * The default field for the font icon to be displayed next to the menu item.
+     */
+    icon?: string;
+    /**
+     * The default name for the field used to place a checkmark on the menu item.
+     * The meaning of value is:
+     *   true - will show a checkbox on the menu item
+     *   false - will show no checkmark but an empty space will be reserved for a checkmark
+     *   undefined - checkmarks are not used for this menu item.
+     *
+     * Notes: The menu component will not automatically change the value.  It must be done by
+     *        the selectItem handler.
+     *        When value is false, it is recommended that the menu text indicate that the menu item
+     *        can have a value.
+     */
+    value?: boolean;
+    /**
+     * The default CSS class name of a SAS font icon that will be placed
+     * next to the menu expand arrow in the menu item.
+     */
+    indicatorIcon?: string;
+    /**
+     * URL to retrieve custom icon to display
+     */
+    iconUrl?: string;
+    /**
+     * Indicates whether the menu item can be clicked.
+     */
+    disabled?: boolean;
+    /**
+     * If true, this item will be shown as a separator, and all other properties will be ignored.
+     */
+    separator?: boolean;
+    /**
+     * Indicates that the menu item is not selectable but is displayed as a heading.
+     * If heading is true then the value field and indicator are ignored.
+     */
+    heading?: boolean;
+    /**
+     * If there is a cascade menu then its data is in the items.
+     */
+    items?: any[];
+    /**
+     * When present, this method will be called when this menu item is selected.
+     */
+    click?: (event?: any) => void;
+}
+export interface SheetCell {
+    id: string;
+    type: string;
+}
+export interface Sheet {
+    id: number;
+    name: string;
+    cells: SheetCell[];
+    type: string;
+    created?: string;
+    createdBy?: string;
+    lastModified?: string;
+    lastModifiedBy?: string;
+    tabOrder: number;
+    version?: string;
+    document: {
+        id: string;
+        type: string;
+    };
+}
+export interface ClientSheet extends Sheet {
+    clientId: string;
+    document: ObjectSheetSettings;
+}

package/sheet/sheet-api.js

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