@sassoftware/vi-api 1.5.0 → 1.9.0

package/object/object-api.d.ts

@@ -1,4 +1,4 @@
-import { Relationship, StoredObjectFieldDTO, Comment } from "../svi-datahub";
+import { Comment, Relationship, StoredObjectFieldDTO } from "../svi-datahub";
 import { FileOperation } from "../file/file-api";
 import { PageModel } from "../page-model/page-model-api";
 import { ClientSheet, Sheet } from "../sheet/sheet-api";
@@ -16,11 +16,11 @@ export interface FormatObjectFieldsOptions {
     skipFormatUserGroups?: boolean;
     skipFormatBooleans?: boolean;
     /**
-     * A function that will be the last thing called in order to format the object's field values
-     * @param fieldValue the current value of the field being formatted
-     * @param fieldName the name of the field currently being formatted
-     * @param objectFields all of the available fields in the object
-     * @param fieldMetadata the current field's metadata
+     * A function that will be the last thing called in order to format the object's field values.
+     * @param fieldValue the current value of the field being formatted.
+     * @param fieldName the name of the field currently being formatted.
+     * @param objectFields all of the available fields in the object.
+     * @param fieldMetadata the current field's metadata.
      */
     formatCallback?: (fieldValue: string | number | Date | PageData[], fieldName: string, objectFields: FieldValues, fieldMetadata: StoredObjectFieldDTO) => void;
 }
@@ -69,7 +69,7 @@ export interface ObjectApi {
      * @param objectId {string} Gets the child objects relating to the object ID.
      * @param childObjectType {string} Child object type.
      * @param [maxResponses = 25] {number} Maximum number of child objects to be returned.
-     * @return A promise that resolves to an array of objects, that are child objects of the specified object.
+     * @return A Promise that resolves to an array of objects, that are child objects of the specified object.
      */
     getChildObjects(objectType: string, objectId: string, childObjectType: string, maxResponses?: number): Promise<VIObject[]>;
     /**
@@ -81,15 +81,28 @@ export interface ObjectApi {
      * @param objectTypeVersion {number} Object type version.
      * @param fieldValues {FieldValues} Field values of the object.
      * @param [options] {UpdateObjectOptions} Optional extra parameters.
-     * @return A promise that resolves to the updated object once the object has successfully been updated.
+     * @return A Promise that resolves to the updated object when the object has successfully been updated.
      */
     updateObject(objectType: string, objectId: string, objectTypeId: number, objectTypeVersion: number, fieldValues: FieldValues, options?: UpdateObjectOptions): Promise<VIObject>;
+    /**
+     * @method
+     * @description Updates an existing object with the provided data.
+     * @param objectType {string} Object type.
+     * @param objectId {string} Object ID.
+     * @param objectTypeId {number} Object type ID.
+     * @param objectTypeVersion {number} Object type version.
+     * @param originalFieldValues {FieldValues} Field values before the object was edited
+     * @param newFieldValues {FieldValues} Field values after the object was edited
+     * @param [options] {UpdateObjectOptions} Optional extra parameters.
+     * @return A Promise that resolves to the updated object when the object has successfully been updated.
+     */
+    patchObject(objectType: string, objectId: string, objectTypeId: number, objectTypeVersion: number, originalFieldValues: FieldValues, newFieldValues: FieldValues, options?: UpdateObjectOptions): Promise<VIObject>;
     /**
      * @method
      * @description Deletes an object.
      * @param objectType {string} Object type.
      * @param objectId {string} Object ID.
-     * @return A promise that resolves to void when the specified object is successfully deleted.
+     * @return A Promise that resolves to void when the specified object is successfully deleted.
      */
     deleteObject(objectType: string, objectId: string): Promise<void>;
     /**
@@ -99,14 +112,14 @@ export interface ObjectApi {
      * @param objectTypeId {number} Object type ID.
      * @param fieldValues {FieldValues} Field values of the object.
      * @param [options] {CreateObjectOptions} Optional extra parameters.
-     * @return A promise that resolves to the created object once the object has successfully been created.
+     * @return A Promise that resolves to the created object when the object has successfully been created.
      */
     createObject(objectType: string, objectTypeId: number, fieldValues: FieldValues, options?: CreateObjectOptions): Promise<VIObject>;
     /**
      * @method
      * @description Gets relationship via the relationship ID.
      * @param relationshipId {string} Relationship ID.
-     * @return A promise that resolves to a relationship.
+     * @return A Promise that resolves to a relationship.
      */
     getObjectRelationship(relationshipId: string): Promise<ObjectRelationship>;
     /**
@@ -114,14 +127,14 @@ export interface ObjectApi {
      * @description Updates an existing relationship in SAS Visual Investigator.
      * @param relationshipId {string} Relationship ID.
      * @param payload {any} HTTP request content.
-     * @return A promise that resolves to a relationship.
+     * @return A Promise that resolves to a relationship.
      */
     updateObjectRelationship(relationshipId: string, payload: any): Promise<ObjectRelationship>;
     /**
      * @method
      * @description Deletes relationship with the specified ID.
      * @param relationshipId {string} Relationship ID.
-     * @return A promise that resolves to void when the object is successfully deleted.
+     * @return A Promise that resolves to void when the object is successfully deleted.
      */
     deleteObjectRelationship(relationshipId: string): Promise<void>;
     /**
@@ -130,7 +143,7 @@ export interface ObjectApi {
      * @param from {VIObject} Object that relationship is from.
      * @param to {VIObject} Object that relationship is to.
      * @param relationship {ObjectRelationship} The relationship.
-     * @return A promise that resolves to an object.
+     * @return A Promise that resolves to an object.
      */
     relateObject(from: VIObject, to: VIObject, relationship: ObjectRelationship): Promise<ObjectRelationship>;
     /**
@@ -147,7 +160,7 @@ export interface ObjectApi {
      * @param from {VIObject} Object that the relationship is from.
      * @param to {VIObject} Object that the relationship is to.
      * @param relationship {ObjectRelationship} The relationship.
-     * @return A promise that resolves to a newly created relationship.
+     * @return A Promise that resolves to a newly created relationship.
      */
     createAndRelateObject(from: VIObject, to: VIObject, relationship: ObjectRelationship): Promise<ObjectRelationship>;
     /**
@@ -156,7 +169,7 @@ export interface ObjectApi {
      * @param objects {VIObject[]} Array of objects.
      * @param objectType {string} Type of the objects in the array.
      * @param [options] {FormatObjectFieldsOptions} Optional parameters to control the formatting. By default, nothing is skipped and there is no formatCallback.
-     * @return A promise that resolves to the formatted array of objects.
+     * @return A Promise that resolves to the formatted array of objects.
      */
     formatObjectFieldsForDisplay(objects: VIObject[], objectType: string, options?: FormatObjectFieldsOptions): Promise<VIObject[]>;
     /**
@@ -165,7 +178,7 @@ export interface ObjectApi {
      * @param attachmentModel {AttachmentModel} Attachment model.
      * @param objectType {string} Object type.
      * @param objectId {string} Object ID.
-     * @return A promise that resolves to a HttpResponse with a FileAssociationResponse as the data.
+     * @return A Promise that resolves to a HttpResponse with a FileAssociationResponse as the data.
      */
     uploadAttachment(attachmentModel: AttachmentModel, objectType: string, objectId: string): Promise<FileAssociationResponse>;
     /**
@@ -174,21 +187,21 @@ export interface ObjectApi {
      * @param objectType {string} Object type.
      * @param objectId {string} Object ID.
      * @param attachmentId {string} Attachment ID.
-     * @return A promise that resolves to an empty HttpResponse when the attachment is successfully deleted.
+     * @return A Promise that resolves to an empty HttpResponse when the attachment is successfully deleted.
      */
     deleteAttachment(objectType: string, objectId: string, attachmentId: string): Promise<void>;
     /**
      * @method
      * @description Gets an attachment of the associated object.
-     * @param objectId {string} Object ID
+     * @param objectId {string} Object ID.
      * @param objectType {string} Object type.
      * @param attachmentId {string} Attachment ID.
-     * @return A promise that resolves to a HttpResponse with a FileAssociationResponse as the data.
+     * @return A Promise that resolves to a HttpResponse with a FileAssociationResponse as the data.
      */
     getAttachment(objectType: string, objectId: string, attachmentId: string): Promise<FileAssociationResponse>;
     /**
      * @method
-     * @description Validates the fields, controls and file categories of a child object.
+     * @description Validates the fields, controls, and file categories of a child object.
      * @param pageModel {PageModel} Page model.
      * @param childObject {StoredObjectMetadata} Child object metadata.
      * @return An observable that resolves to an array of validation results.

package/object/package.json

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sassoftware/vi-api",
-  "version": "1.5.0",
+  "version": "1.9.0",
   "description": "Types used in the SAS Visual Investigator API",
   "keywords": [
     "SAS",
@@ -24,6 +24,7 @@
   "files": [
     "**/*.d.ts",
     "**/*.js",
+    "**/package.json",
     "./README.md",
     "./LICENSE.txt"
   ],

package/page-admin/package.json

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

package/page-admin/page-admin-api.d.ts

@@ -17,8 +17,8 @@ export interface PageAdminApi {
      * @method
      * @description Registers a page designer configuration.
      * @param name {string} A unique name for the configuration.
-     * @param applicationType {ApplicationType} The name of the app type used for this page. Must be a valid datahub client application (for example, desktop | mobile).
-     * @param templateType {TemplateType} The name of the template type used for this page. Must be a valid datahub template type (for example, home | page).
+     * @param applicationType {ApplicationType} The name of the app type used for this page. Must be a valid datahub client application (for example, "desktop" or "mobile").
+     * @param templateType {TemplateType} The name of the template type used for this page. Must be a valid datahub template type (for example, "home" or "page").
      * @param controlGroups {Control[]} The control categories that are displayed in the designer's left hand side toolbox. Must be valid control categories.
      * @param canvasCssClass {string} A CSS class that is applied to the canvas in the designer.
      * @param previewCssClass {string} A CSS class that is applied to the preview (for example, template list).

package/page-model/package.json

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

package/page-model/page-model-api.d.ts

@@ -111,11 +111,102 @@ export interface LinkedPage {
     traversalUuid?: string;
     traversal?: PathsRepresentation;
 }
+export interface IPageEventHook<T extends IPageEventData, R extends IPageEventHookResponse> {
+    exec: (pageData: T) => Promise<R | void>;
+    /**
+     * Run onFail instead of exec if the preceding event action has failed.
+     * If not provided, nothing will be executed for this hook in the event of failure.
+     */
+    onFail?: (pageData: T) => Promise<R | void>;
+    /**
+     * Hooks are executed in ascending order.
+     */
+    order?: number;
+}
+export declare type IPrePageEventHook<T extends IPageEventData> = Omit<IPageEventHook<T, IPrePageEventHookResponse>, "onFail">;
+export declare type IPostPageEventHook<T extends IPageEventData> = IPageEventHook<T, IPostPageEventHookResponse>;
+export interface IPageEventHookResponse {
+    message: string;
+    messages?: string[];
+}
+export interface IPrePageEventHookResponse extends IPageEventHookResponse {
+    abort: boolean;
+}
+export declare type IPostPageEventHookResponse = IPageEventHookResponse;
+/**
+ * A callback to unregister a page event hook.
+ * @returns true if the hook was removed, false if it was already removed.
+ */
+export declare type PageEventHookRemove = () => boolean;
+export interface IPageEventData {
+    pageModel: PageModel;
+}
 /**
- * This API is used for creating a PageModel object from source data.
+ * Page model events which can have pre-event or post-event hooks.
+ */
+export declare const enum HookablePageEvents {
+    /**
+     * A pagemodel is being saved as an object.
+     */
+    SaveObject = "svi:hookable:pagemodel:saveObject"
+}
+export interface IPageEvent<T extends IPageEventData> {
+    /**
+     * @method
+     * @description Adds a hook to be executed before a hookable event is triggered.
+     * @param event {string} the event to hook onto.
+     * @param hook {IPrePageEventHook} the hook which defines the callback to run pre-event.
+     */
+    addPreHook(hook: IPrePageEventHook<T>): PageEventHookRemove;
+    /**
+     * @method
+     * @description Adds a hook to be executed after a hookable event is triggered.
+     * @param event {string} the event to hook onto.
+     * @param hook {IPostPageEventHook} the hook which defines the callback to run post-event.
+     */
+    addPostHook(hook: IPostPageEventHook<T>): PageEventHookRemove;
+    /**
+     * @method
+     * @description run pre-hooks, execute the action, run post hooks.
+     * @param payload is passed as input for any event hooks.
+     * @param action the action to perform.
+     */
+    trigger<R>(payload: T, action: () => Promise<R>): Promise<R>;
+}
+/**
+ * Methods related to page events.
+ */
+export interface PageEventsApiBase {
+    /**
+     * @method
+     * @description Get a reference to a hookable page event if it is defined.
+     * @param eventName The name of the event.
+     * @returns The reference to the hookable page event.
+     */
+    getPageEvent(eventName: HookablePageEvents.SaveObject): IPageEvent<IPageEventData> | undefined;
+    getPageEvent<T extends IPageEventData>(eventName: string): IPageEvent<T> | undefined;
+}
+/**
+ * {@link PageEventsApiBase} extension that provides more functionality.
+ * @extends PageEventsApiBase
+ */
+export interface PageEventsApi extends PageEventsApiBase {
+    /**
+     * @method
+     * @description Add a hookable page event. An error is thrown if the event is already registered.
+     * @param eventName The name of the event, this should be unique.
+     */
+    addPageEvent(eventName: string): void | never;
+}
+/**
+ * This API is used for PageModel utilities.
  * Accessed from the window at window.sas.vi.pageModel.
  */
 export interface PageModelApi {
+    /**
+     * Methods related to page event hooks.
+     */
+    readonly events: PageEventsApi;
     /**
      * @method
      * @description Creates a new instance of a PageModel when given the object source.

package/page-state/package.json

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

package/page-state/page-state-api.d.ts

@@ -1,31 +1,4 @@
-import { Template, StoredObjectDTO } from "../svi-datahub";
-/**
- * SAS Visual Investigator API's representation of a UI-Router state.
- * Accessed from the window at window.sas.vi.pageState.
- */
-export interface StateObject {
-    /** The parent StateObject. */
-    parent: StateObject;
-    /** Name used to register the state. */
-    name: string;
-    /** Parent StateObject array from this state up to the root. */
-    path: StateObject[];
-    data: any;
-    /**
-     * An object containing the parent States' names as keys and
-     * true as their values.
-     */
-    includes: {
-        [name: string]: boolean;
-    };
-    /**
-     * Function to return the root node of this state's tree.
-     *
-     * @returns The root of this state's tree.
-     */
-    root(): StateObject;
-    toString(): string;
-}
+import { StoredObjectDTO, Template } from "../svi-datahub";
 export interface HomepageDesignerState {
     isNew: boolean;
     page: Template;
@@ -48,21 +21,21 @@ export interface PageStateApi {
      * @description Returns the state of the current page.
      * @returns An object containing the page state data or undefined if no page exists.
      */
-    getCurrent(): StateObject | undefined;
+    getCurrent(): HomepageDesignerState | ObjectPageDesignerState | undefined;
     /**
      * @method
      * @description Returns the state of the page matching the ID.
      * @param id {string | number} Page ID for which the state will be returned.
      * @returns An object containing the page state data or undefined if the ID doesn't exist.
      */
-    get(id: string | number): StateObject | undefined;
+    get(id: string | number): HomepageDesignerState | ObjectPageDesignerState | undefined;
     /**
      * @method
      * @description Creates a page state.
      * @param id {string | number} Page ID to be created.
-     * @param state {StateObject} Object containing the state data required to create the page.
+     * @param state {HomepageDesignerState | ObjectPageDesignerState} Object containing the state data required to create the page.
      */
-    add(id: string | number, state: StateObject): void;
+    add(id: string | number, state: HomepageDesignerState | ObjectPageDesignerState): void;
     /**
      * @method
      * @description Deletes a page state.
@@ -70,7 +43,7 @@ export interface PageStateApi {
      */
     remove(id: string | number): void;
     /**
-     * Gives the currently active homepages state, or undefined if a homepage
+     * Gives the currently active Home page's state, or undefined if a Home page
      * designer tab is not active.
      */
     getCurrentHomepageDesigner(): HomepageDesignerState | undefined;

package/property/package.json

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

package/property/property-api.d.ts

@@ -49,9 +49,9 @@ export interface PropertyApi {
      * @method
      * @description Registers a custom element to be rendered as the property editor.
      * The element is rendered as a custom web component.
-     * The element is passed selectedNode, property, propertyKey and categoryKey as attributes.
+     * The element is passed selectedNode, property, propertyKey, and categoryKey as attributes.
      * Throws a console error if the type is already used by another registered editor.
-     * @param elementName {string} Element to be rendered. For example "custom-editor" renders an element with the tag name "custom-editor".
+     * @param elementName {string} Element to be rendered. For example, "custom-editor" renders an element with the tag name "custom-editor".
      * @param type {string} A custom type that is expected to be unique among registered editors.
      * @param [validatorFn] {PropertyApi~isPropertyEditorValid} Function to provide custom logic for determining if the editor is valid.
      * @param [metadataFn] {PropertyApi~getPropertyEditorMetadata} Function to provide custom metadata.
@@ -61,7 +61,7 @@ export interface PropertyApi {
      * @method
      * @description Determines whether or not the child object data source property editor is valid.
      * Typically passed as a function reference to registerCustomEditor() instead of being called directly.
-     * @param {PropertyConfig} propertyConfig Configuration details relating to the property type. For example, required, type and so on.
+     * @param {PropertyConfig} propertyConfig Configuration details relating to the property type. For example, required, type, and so on.
      * @param {string} propertyKey Key where this property's value is stored.
      * @param {Control | ToolbarPropertyControl} control The control.
      * @example
@@ -76,7 +76,7 @@ export interface PropertyApi {
      * @method
      * @description Get metadata for the child object data source property editor.
      * Typically passed as a function reference to registerCustomEditor() instead of being called directly.
-     * @param {PropertyConfig} propertyConfig Configuration details relating to the property type. For example, required, type and so on.
+     * @param {PropertyConfig} propertyConfig Configuration details relating to the property type. For example, required, type, and so on.
      * @param {string} propertyKey Key where this property's value is stored.
      * @param {Control | ToolbarPropertyControl} control The control.
      * @example
@@ -91,7 +91,7 @@ export interface PropertyApi {
 /**
  * Determines whether or not the property editor is valid.
  * @callback PropertyApi~isPropertyEditorValid
- * @param {PropertyConfig} propertyConfig Configuration details relating to the custom property type. For example, required, type and so on.
+ * @param {PropertyConfig} propertyConfig Configuration details relating to the custom property type. For example, required, type, and so on.
  * @param {string} propertyKey Key where this property's value is stored.
  * @param {Control | ToolbarPropertyControl} control The control.
  * @returns {boolean} true if valid, false if not.
@@ -99,7 +99,7 @@ export interface PropertyApi {
 /**
  * Get metadata for the property editor.
  * @callback PropertyApi~getPropertyEditorMetadata
- * @param {PropertyConfig} propertyConfig Configuration details relating to the custom property type. For example, required, type and so on.
+ * @param {PropertyConfig} propertyConfig Configuration details relating to the custom property type. For example, required, type, and so on.
  * @param {string} propertyKey Key where this property's value is stored.
  * @param {Control | ToolbarPropertyControl} control The control.
  * @returns {PageTemplateMetadata}

package/property/property-api.js

@@ -2,7 +2,7 @@ export {};
 /**
  * Determines whether or not the property editor is valid.
  * @callback PropertyApi~isPropertyEditorValid
- * @param {PropertyConfig} propertyConfig Configuration details relating to the custom property type. For example, required, type and so on.
+ * @param {PropertyConfig} propertyConfig Configuration details relating to the custom property type. For example, required, type, and so on.
  * @param {string} propertyKey Key where this property's value is stored.
  * @param {Control | ToolbarPropertyControl} control The control.
  * @returns {boolean} true if valid, false if not.
@@ -10,7 +10,7 @@ export {};
 /**
  * Get metadata for the property editor.
  * @callback PropertyApi~getPropertyEditorMetadata
- * @param {PropertyConfig} propertyConfig Configuration details relating to the custom property type. For example, required, type and so on.
+ * @param {PropertyConfig} propertyConfig Configuration details relating to the custom property type. For example, required, type, and so on.
  * @param {string} propertyKey Key where this property's value is stored.
  * @param {Control | ToolbarPropertyControl} control The control.
  * @returns {PageTemplateMetadata}

package/reference-data/package.json

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

package/resource/package.json

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

package/score-reps/index.d.ts

@@ -1,6 +1,6 @@
 /* tslint:disable */
 /* eslint-disable */
-// Generated using typescript-generator version 2.15.527 on 2023-01-24 10:52:36.
+// Generated using typescript-generator version 2.15.527 on 2023-07-07 09:38:54.
 
 export interface BaseRep extends TrackedResource {
     links?: Link[];

package/score-reps/package.json

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

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

@@ -1,5 +1,5 @@
 import { Relationship } from "../../svi-datahub";
-import { MapBoundedBoxFilter, MapBoundedPolygonFilter, MapRadiusFilter, MapShapeFilter, QueryMode, SearchRepresentation, SearchResponse } from "../../svi-sand";
+import { MapBoundedBoxFilter, MapBoundedPolygonFilter, MapRadiusFilter, MapShapeFilter, QueryMode, SearchRepresentation, SearchResponse, SummaryVisualizationResponse } from "../../svi-sand";
 import { ObjectIdentifier } from "../../object/object-api";
 import { QueryBuilderModel, SearchApi } from "../search-api";
 export declare enum SearchVisualization {
@@ -52,7 +52,7 @@ export interface SearchAndCreateDialogModel {
     canCreate?: boolean;
     linkReasons?: Relationship[];
     /**
-     * Values returned on the close of the dialog. May be undefined when dialog is cancelled.
+     * Values returned on the close of the dialog box. May be undefined when dialog box is cancelled.
      */
     result?: SearchAndCreateResponse;
 }
@@ -73,7 +73,7 @@ export interface SearchAndCreateResponse {
     relateToModel?: SearchAndCreateRelateToModel;
 }
 /**
- * {@link SearchApi} extension pertains to functionality related to SAS Visual Investigators search capabilities.
+ * {@link SearchApi} extension pertains to functionality related to SAS Visual Investigator's 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
@@ -83,7 +83,7 @@ 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.
+     * @returns A Promise containing the search response.
      */
     performSearch(query: SearchRepresentation): Promise<SearchResponse>;
     /**
@@ -92,7 +92,7 @@ export interface ClientSearchApi extends SearchApi {
      * @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".
+     * @param [queryMode] {"standard" | "phonetic" | "synonym"} Used to perform phonetic and synonym searches. Default: "standard".
      */
     navigateSearch(queryText: string, visualizationName: SearchVisualization, mapFilters?: MapFilter[], queryMode?: QueryMode[]): Promise<void>;
     /**
@@ -104,7 +104,7 @@ export interface ClientSearchApi extends SearchApi {
      * @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.
+     * @returns A Promise containing the string representation of the query.
      */
     createQueryStringFromModel(queryModel: QueryBuilderModel): Promise<string>;
     /**
@@ -117,15 +117,15 @@ export interface ClientSearchApi extends SearchApi {
     /**
      * @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.
+     * When 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.
+     * @param [id] {string} ID of the model to set. Default: 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.
+     * @description Opens the "Add Objects to Workspace" dialog box and then performs the action after a document and workspace have been selected.
+     * @param visualizationName {Visualization} Visualization to display after 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.
@@ -147,17 +147,27 @@ export interface ClientSearchApi extends SearchApi {
      * @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 [visualization] {"summary" | "map" | "table" | "timeline" | "networkDiagram"} 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.
+     * @description Launches a wizard allowing users to search, before creating an object/relationship.
+     * The relationship wizard is determined by the relateToParentLabel or relateToParentName defined in the wizardValues parameter.
      * @param wizardValues {SearchAndCreateDialogModel} Object containing entity and relationship data.
-     * @returns {Promise<SearchAndCreateDialogModel>} A promise resolving
+     * @returns A Promise which resolves when the dialog box is closed.
      */
     openSearchAndCreateDialog(wizardValues: SearchAndCreateDialogModel): Promise<SearchAndCreateDialogModel>;
+    /**
+     * @method
+     * @description Gets the selected items within the search result or specified workspace.
+     * @param selectionId {string} The selection ID for the currently selected objects. Default: "SEARCH".
+     * @param maxItems {number} The maximum number of items to get in the selection. Default: 50.
+     * @param textAnalytics {boolean} Boolean value to determine whether the current visualization is Text Analytics. Default: false.
+     */
+    getSelectedItems(selectionId: string, maxItems: number, textAnalytics: boolean): Promise<{
+        [index: string]: SummaryVisualizationResponse;
+    } | undefined>;
 }

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/search-api.d.ts

@@ -57,7 +57,7 @@ export interface SearchApi {
      * @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.
+     * @returns A Promise containing the result of the dialog box.
      * @example
      * const searchApi: SearchApi = window.sas.vi.search;
      * const dialogTitle = 'Intelligence Search'