@sassoftware/vi-api 0.0.29 → 1.7.1

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

@@ -1,6 +1,8 @@
+import { FileRestrictions } from "../control/restrictions";
 import { Control } from "../control/page";
 import { FileOperation, SASObjectAttachedFile } from "../file/file-api";
 import { ObjectFieldRestrictions } from "../object/object-api";
+import { PathsRepresentation } from "../svi-sand";
 export declare enum PageMode {
     Create = "create",
     Edit = "edit",
@@ -22,14 +24,17 @@ export interface PageAction {
         actionName: string;
         attributes: {
             [property: string]: any;
-            displayName: string;
-            disabled: string;
+            displayName?: string;
+            disabled?: string;
         };
         controlId?: number;
         displayName: string;
+        type: string;
     };
+    childNodes?: PageAction[];
 }
 export interface PageActions {
+    disabled: boolean;
     items?: PageAction[];
 }
 export interface PageModelData {
@@ -40,20 +45,18 @@ export interface PageModelObjectData {
     data: PageModelData;
     displayLabel?: string;
     fieldRestrictions?: ObjectFieldRestrictions;
-    fileRestrictions?: ObjectFieldRestrictions;
+    fileRestrictions?: Record<string, Record<string, FileRestrictions>>;
     id?: string;
-    linkedPages?: any[];
+    linkedPages?: LinkedPage[];
     mode?: PageMode;
-    objectTypeId?: string;
+    objectTypeId?: number;
     objectTypeVersion?: number;
     serverPageMode?: ServerPageMode;
     template?: PageTemplate;
     templateMetadata?: PageTemplateMetadata;
-    toolbar?: {
-        disabled: boolean;
-        items: Control[];
-    };
+    toolbar?: PageActions;
     type?: string;
+    uuid: string;
 }
 export interface PageModel extends PageModelObjectData {
     attachmentCount?: number;
@@ -72,8 +75,8 @@ export interface PageModel extends PageModelObjectData {
     getAllMissingFileCategories(): Promise<string[]>;
     getAllMissingRequiredFields(): string[];
     setParentModel(parentModel: PageModel): void;
-    getParentModel(): PageModel;
-    destroy(): void;
+    getParentModel(): PageModel | undefined;
+    destroy(): Promise<void>;
 }
 export interface PageTemplate {
     errors?: boolean;
@@ -103,20 +106,116 @@ export interface PageTemplateScreen {
     locked?: boolean;
     childNodes?: Control[];
 }
+export interface LinkedPage {
+    templateUuid?: string;
+    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;
 /**
- * This API is used for creating a PageModel object from source data.
+ * 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;
+}
+/**
+ * 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.
-     * @param objectSource {PageModelObjectData} Object containing data for the page model.
+     * @param object {Partial<PageModel>} Object containing data for the page model.
      * @param [options] {PageModelApi~CreateFromObjectOptions} Contains a boolean "clone" declaring whether to deep clone the object
      * when creating the Page Model.
      * @returns The instance of PageModel
      */
-    createFromObject(objectSource: PageModelObjectData, options?: {
+    createFromObject(object: Partial<PageModel>, options?: {
         clone?: boolean;
     }): PageModel;
 }

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

@@ -1,3 +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.
@@ -25,6 +26,18 @@ export interface StateObject {
     root(): StateObject;
     toString(): string;
 }
+export interface HomepageDesignerState {
+    isNew: boolean;
+    page: Template;
+    designerType: string;
+}
+export interface ObjectPageDesignerState {
+    isNew: boolean;
+    page: Template;
+    designerType: string;
+    childEntityDataSources: StoredObjectDTO[];
+    primaryDataSource: StoredObjectDTO;
+}
 /**
  * This API provides functionality that pertains to the page state.
  * Accessed from the window at window.sas.vi.pageState.
@@ -56,4 +69,14 @@ export interface PageStateApi {
      * @param id {string | number} ID of the page to be deleted.
      */
     remove(id: string | number): void;
+    /**
+     * Gives the currently active Home page's state, or undefined if a Home page
+     * designer tab is not active.
+     */
+    getCurrentHomepageDesigner(): HomepageDesignerState | undefined;
+    /**
+     * Gives the currently active object pages state, or undefined if an object page
+     * designer tab is not active.
+     */
+    getCurrentObjectPageDesigner(): ObjectPageDesignerState | undefined;
 }

package/property/property-api.d.ts

@@ -1,5 +1,6 @@
+import { ResourcedString } from "../svi-datahub";
 import { Control } from "../control/page";
-import { TypeAttributes } from "../object/object-api";
+import { ChildNode, TypeAttributes } from "../object/object-api";
 import { PageTemplateMetadata } from "../page-model/page-model-api";
 export interface ToolbarPropertyControl {
     typeAttributes: TypeAttributes;
@@ -7,8 +8,37 @@ export interface ToolbarPropertyControl {
 export interface PropertyConfig {
     [property: string]: any;
     order?: number;
-    required?: boolean;
     type: string;
+    displayName: ResourcedString;
+    required?: boolean | string;
+    localizable?: boolean | string;
+    allowMultiple?: boolean | string;
+    states?: Record<string, boolean>;
+    defaultValue?: any;
+    disabledExpression?: string;
+    picklistName?: string;
+    ignoreRestrictions?: boolean;
+}
+export interface SelectedNode {
+    id: number;
+    node: ChildNode;
+    parentNode?: ChildNode;
+    parentSubDocument: string;
+    dataSources?: {
+        [property: string]: any;
+    };
+}
+/**
+ * This API is available on property editors.
+ */
+export interface EditorApi {
+    /**
+     * Registers a function to be invoked whenever one of the editor's properties changes.
+     * @method
+     * @param handler The function to be invoked.
+     * @returns A function that stops the handler from being invoked.
+     */
+    onPropertyChange(handler: (category: string, property: string, currentValue: any, previousValue: any) => void): () => void;
 }
 /**
  * This API provides the  utility or miscellaneous functionality in SAS Visual Investigator.
@@ -19,19 +49,49 @@ 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.
      */
     registerCustomEditor(elementName: string, type: string, validatorFn?: (propertyConfig: PropertyConfig, propertyKey: string, control: Control | ToolbarPropertyControl) => boolean, metadataFn?: (propertyConfig: PropertyConfig, propertyKey: string, control: Control | ToolbarPropertyControl) => PageTemplateMetadata): void;
+    /**
+     * @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 {string} propertyKey Key where this property's value is stored.
+     * @param {Control | ToolbarPropertyControl} control The control.
+     * @example
+     * window.sas.vi.property.registerCustomEditor(
+     *     name,
+     *     type,
+     *     window.sas.vi.property.validateChildObjectDataSource,
+     *     window.sas.vi.property.getChildObjectMetadata)
+     */
+    validateChildObjectDataSource(propertyConfig: PropertyConfig, propertyKey: string, control: Control): boolean | undefined;
+    /**
+     * @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 {string} propertyKey Key where this property's value is stored.
+     * @param {Control | ToolbarPropertyControl} control The control.
+     * @example
+     * window.sas.vi.property.registerCustomEditor(
+     *     name,
+     *     type,
+     *     window.sas.vi.property.validateChildObjectDataSource,
+     *     window.sas.vi.property.getChildObjectMetadata)
+     */
+    getChildObjectMetadata(propertyConfig: PropertyConfig, propertyKey: string, control: Control): PageTemplateMetadata | undefined;
 }
 /**
  * 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.
@@ -39,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/score-reps/index.d.ts

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

package/score-reps/package.json

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

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

@@ -12,7 +12,7 @@ export declare enum Visualization {
     Map = "map",
     Table = "table",
     Timeline = "timeline",
-    Network = "network"
+    Network = "networkDiagram"
 }
 export declare type MapFilter = MapBoundedPolygonFilter | MapRadiusFilter | MapBoundedBoxFilter | MapShapeFilter;
 export interface SearchQuery {
@@ -39,6 +39,7 @@ export interface NetworkData {
         showTransactionDetails?: boolean;
         showTransactionLinks?: boolean;
     };
+    numNodes: number;
 }
 export interface ResolvedObjectIdentifier extends ObjectIdentifier {
     compoundValues: string[];
@@ -50,6 +51,10 @@ export interface SearchAndCreateDialogModel {
     relateToParentLabel?: string;
     canCreate?: boolean;
     linkReasons?: Relationship[];
+    /**
+     * Values returned on the close of the dialog. May be undefined when dialog is cancelled.
+     */
+    result?: SearchAndCreateResponse;
 }
 export interface SearchObject extends ObjectIdentifier {
     title?: string;
@@ -68,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
@@ -78,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>;
     /**
@@ -99,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>;
     /**
@@ -112,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.
      */
     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 initially 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.
@@ -142,7 +147,7 @@ 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.
      */
@@ -152,8 +157,7 @@ export interface ClientSearchApi extends SearchApi {
      * @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.
+     * @returns A Promise which resolves when the dialog is closed.
      */
-    openSearchAndCreateDialog(wizardValues: SearchAndCreateDialogModel, onRelationshipSuccess?: () => void): Promise<SearchAndCreateResponse>;
+    openSearchAndCreateDialog(wizardValues: SearchAndCreateDialogModel): Promise<SearchAndCreateDialogModel>;
 }

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

@@ -10,5 +10,5 @@ export var Visualization;
     Visualization["Map"] = "map";
     Visualization["Table"] = "table";
     Visualization["Timeline"] = "timeline";
-    Visualization["Network"] = "network";
+    Visualization["Network"] = "networkDiagram";
 })(Visualization || (Visualization = {}));

package/search/search-api.d.ts

@@ -1,12 +1,12 @@
 export interface QueryBuilderItem {
     booleanValue?: boolean | string;
     boost?: number;
-    dateTimeValue?: string;
-    dateValue?: string;
+    dateTimeValue?: string | Date;
+    dateValue?: string | Date;
     exclude?: boolean;
     field?: string;
-    fromDateTimeValue?: string;
-    fromDateValue?: string;
+    fromDateTimeValue?: string | Date;
+    fromDateValue?: string | Date;
     fromNumericValue?: number;
     numericValue?: number;
     operator?: string;
@@ -22,8 +22,8 @@ export interface QueryBuilderItem {
     stringValidationError?: boolean;
     synonym?: boolean;
     textValue?: string;
-    toDateTimeValue?: string;
-    toDateValue?: string;
+    toDateTimeValue?: string | Date;
+    toDateValue?: string | Date;
     toNumericValue?: number;
     userGroupValue?: Array<{
         id: string;
@@ -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'

package/sheet/sheet-api.d.ts

@@ -1,7 +1,7 @@
 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.
+ * This API pertains to functionality related to SAS Visual Investigator's sheet capabilities.
  * Accessed from the window at window.sas.vi.sheet.
  */
 export interface SheetApi {
@@ -27,15 +27,35 @@ export interface SheetApi {
      */
     getOpenObjectBySheet(sheet: ClientSheet): VIObject | undefined;
     /**
+     * @deprecated use {@link registerNetworkMenuCallback} instead.
      * @method
-     * @description Creates and returns the list containing all Context Menu Items for a right-click on a network diagram node.
+     * @description Deprecated. This function is deprecated and replaced with registerNetworkMenuCallback. The original
+     * function did not allow users to extend the menu being constructed by a context click.
+     *
+     * 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 workspace {ClientSheet} Workspace containing the network. The workspace should not be manually constructed.
+     * @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[]>;
+    createContextMenuForNodes(workspace: ClientSheet, handleAddToWorkspaceFn?: () => void, handleAddToInsightsFn?: () => void): Promise<ContextMenuItem[]>;
+    /**
+     * @method
+     * @description Registers a callback that is invoked whenever the node or network context menu is constructed.
+     * The caller can extend the menu to provide access to extra functionality. It is the caller's responsibility
+     * to ensure that they properly extend the menu. Failing to do so can result in application errors.
+     *
+     * The callback can be unregistered by calling this function without passing in a callback function
+     * or setting it to undefined.
+     *
+     * @param menuType {NetworkMenuType} The type of menu to extend.
+     * @param callback {NetworkMenuCallback} The callback function invoked when the context menu is constructed.
+     * This function is passed the menu object, which can be modified/extended, and the "client Id" of the current workspace.
+     * If callback not passed in or is undefined, the callback is unregistered.
+     * @returns void
+     */
+    registerNetworkMenuCallback(menuType: NetworkMenuType, callback?: NetworkMenuCallback): void;
     /**
      * @method
      * @description Adds objects to a workspace selected in the "Add Objects to Workspace" dialog box.
@@ -68,22 +88,22 @@ export interface SheetApi {
      * @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 [networkData] {NetworkData} If provided, network data that will 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
+     * The visualization to initially display after the objects have been added.
      */
     visualizationName?: Visualization;
     /**
-     * The object the user is currently viewing. This is used as a visual aid in the dialog
+     * 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
+     * Network visualization data to be copied to the workspace.
      */
     networkData?: NetworkData;
 }
@@ -182,3 +202,15 @@ export interface ClientSheet extends Sheet {
     clientId: string;
     document: ObjectSheetSettings;
 }
+/**
+ * The set of menu types which can be extended
+ * via the registerNetworkMenuCallback function.
+ */
+export declare enum NetworkMenuType {
+    NetworkContext = "networkContext",
+    NodeContext = "nodeContext"
+}
+/**
+ * The type of function that can be registered as a callback for modifying the Network menus.
+ */
+export declare type NetworkMenuCallback = (menu: ContextMenuItem, workspaceClientId: string) => void;

package/sheet/sheet-api.js

@@ -1 +1,9 @@
-export {};
+/**
+ * The set of menu types which can be extended
+ * via the registerNetworkMenuCallback function.
+ */
+export var NetworkMenuType;
+(function (NetworkMenuType) {
+    NetworkMenuType["NetworkContext"] = "networkContext";
+    NetworkMenuType["NodeContext"] = "nodeContext";
+})(NetworkMenuType || (NetworkMenuType = {}));