@sassoftware/vi-api 1.5.0 → 1.7.1

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

@@ -70,7 +70,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/package.json

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

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

@@ -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>;
     /**
@@ -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.
      */
     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.
@@ -147,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.
      */
@@ -157,7 +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.
-     * @returns {Promise<SearchAndCreateDialogModel>} A promise resolving
+     * @returns A Promise which resolves when the dialog is closed.
      */
     openSearchAndCreateDialog(wizardValues: SearchAndCreateDialogModel): Promise<SearchAndCreateDialogModel>;
 }

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'

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/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 {
@@ -35,7 +35,7 @@ export interface SheetApi {
      * 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. The workspace should not be manually constructed.
-     * @param handleAddToWorkspaceFn {function} A callback to handle adding the selected nodes to a Workspace.
+     * @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.
      */
@@ -88,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;
 }