@sassoftware/vi-api 1.40.2 → 1.40.3

package/component/index.d.ts

@@ -15,7 +15,7 @@ export interface ComponentCreationResult<T> {
     setComponentInputValue?: (name: keyof T, value: unknown) => void;
 }
 /**
- * Functionality related to dynamically creating SAS Visual Investigator UI components.
+ * Functionality related to dynamically creating SAS Visual Investigator user interface components.
  * Accessed from the window at window.sas.vi.component.
  */
 export interface ComponentApi {
@@ -27,7 +27,7 @@ export interface ComponentApi {
     create(component: SviComponent.SearchAndSelectWithPreview, target: HTMLElement, bindings?: SearchAndSelectWithPreviewBindings): Promise<ComponentCreationResult<SearchAndSelectWithPreviewBindings>>;
     create(component: SviComponent.TimeSlider, target: HTMLElement, bindings?: TimeSliderBindings): Promise<ComponentCreationResult<TimeSliderBindings>>;
     /**
-     * Dynamically create a SAS Visual Investigator UI component appended to a given target DOM element location.
+     * Dynamically create a SAS Visual Investigator user interface component appended to a given target DOM element location.
      *
      * @method
      * @param component {SviComponent} Creates the component.

package/config/config-api.d.ts

@@ -133,15 +133,15 @@ export interface ConfigApi {
     /**
      * @method
      * @description Registers a new solution and version in the SAS Visual Investigator About dialog box.
-     * If a solution with that key already exists, it will not be overwritten.
+     * If a solution with that key already exists it will not be overwritten.
      * @param key {string} Unique identifier for the solution.
-     * @param label {string} Localized name of the solution to be shown to the user.
+     * @param label {string} Localized name of the solution to be displayed.
      * @param [version] {string} Version of the solution.
      */
     registerSolution(key: string, label: string, version?: string): void;
     /**
      * @method
-     * @description Retrieves registered solution extension with a given name.
+     * @description Retrieves the registered solution extension with a given name.
      * @param name {string} Name of the solution extension.
      * @returns A Promise that resolves to the solution extension if the name is found.
      */

package/control/control-api.d.ts

@@ -92,7 +92,7 @@ export interface ControlAdminApi {
     /**
      * Registers a function to be invoked when retrieving this control's internationalization resources.
      * @method
-     * @param fn {function} a function that returns each internationalization resource's key and value.
+     * @param fn {function} A function that returns each internationalization resource's key and value.
      * No parameters. Return type: Record<string, string>
      */
     registerGetI18nResourcesFn(fn: () => Record<string, string>): void;
@@ -415,7 +415,7 @@ export interface ControlPageApi extends ControlPageApiBase {
     save(stopEditing: boolean, closeObject: boolean): Promise<void>;
 }
 /**
- * Methods related to files
+ * Methods related to files.
  */
 export interface ControlFileApiBase {
     /**
@@ -432,15 +432,15 @@ export interface ControlFileApiBase {
  */
 export interface ControlFileApi extends ControlFileApiBase {
     /**
-     * Opens the file upload dialog.
+     * Opens the file upload dialog box.
      *
      * @method
-     * @param {IAttachmentFormData} options Additional options to pass to the file upload dialog.
+     * @param {IAttachmentFormData} options Additional options to pass to the file upload dialog box.
      * @returns {Promise<SASObjectAttachedFile[]>} Promise which resolves to an array of uploaded files.
      */
     openFileUploadDialog(options: AttachmentFormData): Promise<SASObjectAttachedFile[]>;
     /**
-     * Opens the image upload dialog.
+     * Opens the image upload dialog box.
      *
      * @method
      * @param {boolean} allowMultiple Determines if multiple files can be uploaded at once.

package/event/event-api.d.ts

@@ -43,7 +43,7 @@ export interface EventApi {
      * @description Subscribes to an event and registers a function to be called on any future published events.
      * If the eventName does not exist, it is created.
      * @param eventName {string} Name of the event to subscribe to.
-     * @param {EventApi~subscriptionCallback} Function invoked when the subscription is triggered by an event.
+     * @param {EventApi~subscriptionCallback} Function Invoked when the subscription is triggered by an event.
      * Has access to the event's payload.
      * @returns The subscription being made to the event.
      */

package/index.d.ts

@@ -40,7 +40,7 @@ export interface SviCommonApi {
     pageTemplate: PageTemplateApi;
     property: PropertyApi;
     refData: RefDataApi;
-    /** @deprecated Use window.sas.viInit.registerResourceBundle to register resources before the rest of the Visual Investigator API is ready. */
+    /** @deprecated Use window.sas.viInit.registerResourceBundle to register resources before the rest of the SAS Visual Investigator API is ready. */
     resource: ResourceApi;
     search: SearchApi;
     theme: ThemeApi;

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

@@ -4,7 +4,7 @@ export interface FieldTypeLabels {
 }
 /**
  * {@link MetadataApi} extension provides the functionality related to retrieval of metadata.
- * Additional methods are available only in the SAS Visual Investigator Admin Application.
+ * Additional methods are available only in the SAS Visual Investigator Manage and Investigate interface.
  * Accessed from the window at window.sas.vi.metadata.
  * @extends MetadataApi
  */

package/metadata/metadata-api.d.ts

@@ -160,7 +160,7 @@ export interface MetadataApi {
     /**
      * @method
      * @description Gets create, read, and update access rights for the provided entities via batch call.
-     * @param objectType {string[]} Entity name(s).
+     * @param objectType {string[]} Entity names.
      * @returns Object with a Promise of type EntityAccessRule[] for each rule, where EntityAccessRule maps to the access rule of a given entity name.
      */
     getEntitiesAccessRules(objectTypes: string[]): EntitiesAccessRules;
@@ -206,7 +206,7 @@ export interface MetadataApi {
      * @param objectType {string} Finds relationships for the entity.
      * @param [relationshipObjectType] {string} Used for filtering the name of an expected related entity.
      * @param [relationshipName] {string} Used for filtering the name of an expected relationship.
-     * @param flattenMultiLinkIntoSingles whether Relationships with a One->(multiple) links will get flattened into many One->Single relationships
+     * @param flattenMultiLinkIntoSingles Whether Relationships with a One->(multiple) links will get flattened into many One->Single relationships.
      * @returns A Promise resolving to an object containing relationship type metadata.
      * The object is empty if no relationship types exist.
      */
@@ -266,7 +266,7 @@ export interface MetadataApi {
      * @method
      * @description Gets relationships with a specified end type.
      * @param endType endType {string} End type entity name.
-     * @param options see {@link OptionsForGetRelationshipsForObjectType}
+     * @param options See {@link OptionsForGetRelationshipsForObjectType}
      */
     getRelationshipsForObjectType(endType: string, options: OptionsForGetRelationshipsForObjectType): Promise<RelationshipWithLabel[]>;
 }

package/object/object-api.d.ts

@@ -166,8 +166,8 @@ export interface ObjectApi {
     /**
      * @method
      * @description Creates a new object and relates it with an existing one.
-     * @param from {LinkObject} existing Object that the relationship is from.
-     * @param to {NewLinkObject} new Object to be created and related to.
+     * @param from {LinkObject} Existing Object that the relationship is from.
+     * @param to {NewLinkObject} New Object to be created and related to.
      * @param relationship {ObjectRelationship} The relationship.
      * @return A Promise that resolves to a newly created relationship.
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sassoftware/vi-api",
-  "version": "1.40.2",
+  "version": "1.40.3",
   "description": "Types used in the SAS Visual Investigator API",
   "keywords": [
     "SAS",

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

@@ -17,7 +17,7 @@ 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" or "mobile").
+     * @param applicationType {ApplicationType} The name of the application 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.

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

@@ -7,10 +7,10 @@ import { ApplicationType, TemplateType } from "../page-admin/page-admin-api";
 export interface PageTemplateApi {
     /**
      * @method
-     * @description Retrieves all Templates matching the parameters.
+     * @description Retrieves all templates matching the parameters.
      * @param entityType {string} The object type for which the templates are to be retrieved.
-     * @param includeNoDataSource {boolean} Should templates with no dataSource be included.
-     * @param clientApplication {ApplicationType} The name of the app type used for this page. Must be a valid datahub client application (for example, desktop | mobile).
+     * @param includeNoDataSource {boolean} Boolean to determine whether templates with no dataSource should be included.
+     * @param clientApplication {ApplicationType} The name of the application 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).
      * @returns A promise of an array of {@link TemplateResourceSummary}.
      */
@@ -18,21 +18,21 @@ export interface PageTemplateApi {
     /**
      * @method
      * @description Gets the page template with the specified ID.
-     * @param templateId {number} the ID of the page template.
-     * @returns A promise containing the page template metadata {@link Template}..
+     * @param templateId {number} The ID of the page template.
+     * @returns A promise containing the page template metadata {@link Template}.
      */
     getPageTemplateById(templateId: number): Promise<Template>;
     /**
      * @method
      * @description Gets the page template with the specified UUID.
-     * @param templateUuid {string} the UUID of the page template.
+     * @param templateUuid {string} The UUID of the page template.
      * @returns A promise containing the page template metadata {@link Template}.
      */
     getPageTemplateByUuid(templateUuid: string): Promise<Template>;
     /**
      * @method
      * @description Get all templates of a specific client and template type. If null params defaults to clientApplication = DESKTOP, templateType = PAGE
-     * @param [clientApplication] {ApplicationType} The name of the app type used for this page. Must be a valid datahub client application (for example, desktop | mobile).
+     * @param [clientApplication] {ApplicationType} The name of the application 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).
      * @returns A promise which returns an array of {@link TemplateResourceSummary}
      */

package/property/property-api.d.ts

@@ -81,11 +81,11 @@ export interface PageControlPropertyLocalizer extends PropertyLocalizer<Control>
  */
 export interface PropertyLocalizer<T> {
     /**
-     * control type to be localized
+     * Control type to be localized,
      */
     localizerType: LocalizerType;
     /**
-     * property type to be localized.
+     * Property type to be localized.
      * (the type that the property editor is registered against)
      */
     propertyType: string;
@@ -129,7 +129,7 @@ export interface PropertyApi {
     registerPropertyLocalizer(localizer: ControlPropertyLocalizer): void;
     /**
      * @method
-     * @description Determines whether or not the child object data source property editor is valid.
+     * @description Determines whether 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.
@@ -159,7 +159,7 @@ export interface PropertyApi {
     getChildObjectMetadata(propertyConfig: PropertyConfig, propertyKey: string, control: Control): PageTemplateMetadata | undefined;
 }
 /**
- * Determines whether or not the property editor is valid.
+ * Determines whether 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 {string} propertyKey Key where this property's value is stored.

package/property/property-api.js

@@ -1,6 +1,6 @@
 export {};
 /**
- * Determines whether or not the property editor is valid.
+ * Determines whether 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 {string} propertyKey Key where this property's value is stored.

package/resource/resource-api.d.ts

@@ -2,7 +2,7 @@ export interface I18nResources {
     [key: string]: string | I18nResources;
 }
 /**
- * @deprecated Use window.sas.viInit.registerResourceBundle to register resources before the rest of the Visual Investigator API is ready.
+ * @deprecated Use window.sas.viInit.registerResourceBundle to register resources before the rest of the SAS Visual Investigator API is ready.
  * This API provides the resource functionality in SAS Visual Investigator.
  * Accessed from the window at window.sas.vi.resource.
  */

package/score-reps/index.d.ts

@@ -1,6 +1,6 @@
 /* tslint:disable */
 /* eslint-disable */
-// Generated using typescript-generator version 2.15.527 on 2024-03-12 16:17:17.
+// Generated using typescript-generator version 2.15.527 on 2024-04-29 09:50:32.
 
 export interface BaseRep extends TrackedResource {
     links?: Link[];

package/score-reps/package.json

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

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

@@ -62,7 +62,7 @@ export interface SearchAndCreateResponse {
 }
 /**
  * {@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.
+ * These additional methods are available only in the SAS Visual Investigator Investigate and Search interface.
  * Accessed from the window at window.sas.vi.search.
  * @extends SearchApi
  */
@@ -121,7 +121,7 @@ export interface ClientSearchApi extends SearchApi {
     openAddObjectsToWorkspaceDialog(visualizationName: Visualization, objects: ObjectIdentifier[], currentObject?: ObjectIdentifier, networkData?: NetworkData): Promise<void>;
     /**
      * @method
-     * @description Adds an image to the Insights selected in the "Add image to Insights" dialog box.
+     * @description Adds an image to the Insights selected in the "Add image to Insights" dialog.
      * @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.

package/search/search-api.d.ts

@@ -44,16 +44,16 @@ export interface QueryBuilderResult {
     queryModel: QueryBuilderModel;
 }
 /**
- * This API pertains to functionality related to SAS Visual Investigator's search capabilities.
+ * This API relates to SAS Visual Investigator's search functionality.
  * 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
+     * @description Opens the query builder dialog box 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 [submitButtonText] {string} Text for the dialog box 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.

package/sheet/sheet-api.d.ts

@@ -1,7 +1,7 @@
 import { ObjectIdentifier, ObjectSheetSettings, VIObject } from "../object/object-api";
 import { NetworkData, Visualization } from "../search/client/client-search-api";
 /**
- * This API pertains to functionality related to SAS Visual Investigator's sheet capabilities.
+ * This API relates to SAS Visual Investigator's sheet functionality.
  * Accessed from the window at window.sas.vi.sheet.
  */
 export interface SheetApi {

package/shell-tabs/shell-tabs-api.d.ts

@@ -114,39 +114,39 @@ export interface ExternalTabConfig<T = SviShellTabData, P = any> {
     buildOnRegister?: boolean;
 }
 /**
- * This API provides functionality that pertains to the shell tabs.
+ * This API provides functionality relating to the shell tabs.
  * Accessed from the window at window.sas.vi.shellTabs.
  */
 export interface ShellTabsApi<T = SviShellTabData> {
     /**
      * @method
-     * @description this is used to expose any {@link PotentialTabItem} hooks on a component up to the Tab Service
+     * @description This is used to expose any {@link PotentialTabItem} hooks on a component up to the Tab Service.
      * @param [context] {this} pass "this"
-     * @param [elRef] {HTMLElement} pass the ElementRef for the component
+     * @param [elRef] {HTMLElement} This will pass the ElementRef for the component
      *
      *  onTabClose {@link OnTabClose}, optional, can be used to prevent closing of a tab or close async
      *  onAttachTab {@link OnAttachTab}, will always trigger when currentNavigationBarTab has set
      *  onAttachToolbar {@link TabWithToolbar}, optional, will set currentToolbar if there was a toolbar in the VI Router
      *  onTabEnter {@link OnTabEnter}, optional, will trigger when tab is entered
      *  onTabLeave {@link OnTabLeave}, optional, will trigger when tab is left
-     *  onTabSaveConfirm {@link OnTabSaveConfirm}, optional, basic dialog can be created whe closing a dirty tab
+     *  onTabSaveConfirm {@link OnTabSaveConfirm}, optional, basic dialog box can be created whe closing a dirty tab.
      */
     createTabApiForElement: (context: any, nativeElement: HTMLElement) => void;
     /**
      * @method
-     * @description Use this function to register new routes for tabs
-     * @param [tabsToAdd] {ExternalTabConfig[]} - see {@link ExternalTabConfig}
+     * @description Use this function to register new routes for tabs.
+     * @param [tabsToAdd] {ExternalTabConfig[]} - See {@link ExternalTabConfig}
      */
     registerExternalTabs: (tab: Array<ExternalTabConfig<T>>) => void;
     /**
      * @method
-     * @description Use this function to remove routes added via registerTabFn
-     * @param [tabsToRemove] {ExternalTabConfig[]} - see {@link ExternalTabConfig}
+     * @description Use this function to remove routes added via registerTabFn.
+     * @param [tabsToRemove] {ExternalTabConfig[]} - See {@link ExternalTabConfig}
      */
     unregisterExternalTabs: (tabsToRemove: Array<ExternalTabConfig<T>>) => void;
     /**
      * @method
-     * @description this will return the current primary and secondary tabs
+     * @description This will return the current primary and secondary tabs.
      */
     getSelectedTab: () => {
         primaryTab: INavigationBarTab;
@@ -154,17 +154,17 @@ export interface ShellTabsApi<T = SviShellTabData> {
     };
     /**
      * @method
-     * @description this stream will track the current top level tab
+     * @description This stream will track the current top level tab.
      */
     selectedPrimaryTabChanged$: Observable<INavigationBarTab>;
     /**
      * @method
-     * @description this stream will track the current second level tab
+     * @description This stream will track the current second level tab.
      */
     selectedSecondaryTabChanged$: Observable<INavigationBarTab | undefined>;
     /**
      * @method
-     * @description this stream will update after any additions/removals to either system or application tabs
+     * @description This stream will update after any additions/removals to either system or application tabs.
      */
     openTabsChanged$: Observable<{
         systemTabs: INavigationBarTab[];
@@ -172,18 +172,18 @@ export interface ShellTabsApi<T = SviShellTabData> {
     }>;
     /**
      * @method
-     * @description this stream will emit any removed tabs
+     * @description This stream will emit any removed tabs.
      */
     tabRemoved$: Observable<INavigationBarTab>;
     /**
      * @method
      * @description get Tab by ID
-     * @param [tabId] {string} will be ID of an existing tab
+     * @param [tabId] {string} This will be ID of an existing tab.
      */
     getTabById: (tabId: string) => INavigationBarTab | undefined;
     /**
      * @method
-     * @description will return a slice of the current system and application tabs
+     * @description This will return a slice of the current system and application tabs.
      */
     getAllTabs: () => {
         system: INavigationBarTab[];
@@ -191,48 +191,48 @@ export interface ShellTabsApi<T = SviShellTabData> {
     };
     /**
      * @method
-     * @description will move user to the default tab
+     * @description This will move user to the default tab.
      */
     selectDefaultTab: () => Promise<boolean>;
     /**
      * @method
-     * @description will attempt to open+select a matching INavigationBarTab and optional secondaryTab, returning false on failure
-     * in the event the tab doesn't exist already, it will add the tab assuming an appropriate route has been registered for it
-     * @param [tabToSelect] {INavigationBarTab} see {@link INavigationBarTab}
-     * @param [secondaryTab] {INavigationBarTab} see {@link INavigationBarTab} if left undefined, this will select the previously
-     * selected secondary tab of the primary tab or it's first index secondary tab
+     * @description This will attempt to open+select a matching INavigationBarTab and optional secondaryTab, returning false on failure
+     * in the event the tab doesn't exist already, it will add the tab assuming an appropriate route has been registered for it.
+     * @param [tabToSelect] {INavigationBarTab} See {@link INavigationBarTab}
+     * @param [secondaryTab] {INavigationBarTab} See {@link INavigationBarTab} if left undefined, this will select the previously
+     * selected secondary tab of the primary tab or its first index secondary tab.
      */
     openTab: (tabToSelect: INavigationBarTab, secondaryTab?: INavigationBarTab) => Promise<boolean>;
     /**
      * @method
-     * @description will attempt to select a tab by its id, returning false on failure
-     * @param [tabId] {string} will be ID of an existing tab
+     * @description This will attempt to select a tab by its id, returning false on failure.
+     * @param [tabId] {string} This will be ID of an existing tab.
      */
     selectTabById: (tabId: string) => Promise<boolean>;
     /**
      * @method
-     * @description will remove an application tab, if allowed, and will trigger any closing and saving logic beforehand
-     * @param [tabIdToRemove] {string} will be ID of an existing tab
-     * @param [suppressNavigation] {boolean} if you are closing a tab that isn't open, you want to supressNavigation=true
+     * @description This will remove an application tab, if allowed, and will trigger any closing and saving logic beforehand.
+     * @param [tabIdToRemove] {string} This will be ID of an existing tab.
+     * @param [suppressNavigation] {boolean} Set supressNavigation to true if you want to close a tab that isn't open.
      */
     removeApplicationTabById: (tabIdToRemove: string, suppressNavigation?: boolean) => Promise<boolean>;
     /**
      * @method
-     * @description will remove an existing application tab then replace with another, if {@link removeApplicationTabById} is unsuccessful this will fail
+     * @description This will remove an existing application tab then replace with another, if {@link removeApplicationTabById} is unsuccessful this will fail
      * use case can be saving a tab which has a temporary ID, and reopening it with a saved payload.
-     * @param [tabId] {string} will be ID of an existing tab
-     * @param [newTab] {INavigationBarTab} see {@link INavigationBarTab}
+     * @param [tabId] {string} This will be ID of an existing tab.
+     * @param [newTab] {INavigationBarTab} See {@link INavigationBarTab}
      *
      */
     replaceApplicationTab: (tabId: string, newTab: INavigationBarTab) => Promise<boolean>;
     /**
      * @method
-     * @description will run {@link removeApplicationTabById} on all tabs, will stop if any fail to close, will wait for each close to complete
+     * @description This will run {@link removeApplicationTabById} on all tabs, will stop if any fail to close, will wait for each close to complete.
      */
     removeAllApplicationTabs: () => Promise<boolean>;
     /**
      * @method
-     * @description will run same as {@link removeAllApplicationTabs}, but not on the provided tabIdToKeep
+     * @description This will run the same as {@link removeAllApplicationTabs}, but not on the provided tabIdToKeep.
      * @param [tabIdToKeep] {string}
      */
     removeOtherApplicationTabs: (tabIdToKeep?: string) => Promise<boolean>;