@sassoftware/vi-api 1.48.0 → 1.51.2

package/package.json

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

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

@@ -4,6 +4,7 @@ import { FileOperation, SASObjectAttachedFile } from "../file/file-api";
 import { ObjectFieldRestrictions } from "../object/object-api";
 import { PathsRepresentation } from "../svi-sand";
 import { TemplateFileCategoryAssociationDTO } from "../svi-datahub";
+import { ClientFieldProperties } from "../control/client-field-properties";
 export declare enum PageMode {
     Create = "create",
     Edit = "edit",
@@ -47,6 +48,7 @@ export interface PageModelObjectData {
     displayLabel?: string;
     fieldRestrictions?: ObjectFieldRestrictions;
     fileRestrictions?: Record<string, Record<string, FileRestrictions>>;
+    clientFieldProperties?: Record<string, Record<string, ClientFieldProperties>>;
     id?: string;
     linkedPages?: LinkedPage[];
     mode?: PageMode;
@@ -170,7 +172,7 @@ export interface IPageEvent<T extends IPageEventData> {
     addPostHook(hook: IPostPageEventHook<T>): PageEventHookRemove;
     /**
      * @method
-     * @description run pre-hooks, execute the action, run post hooks.
+     * @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.
      */

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

@@ -12,7 +12,7 @@ export interface ObjectPageDesignerState {
     primaryDataSource: StoredObjectDTO;
 }
 /**
- * This API provides functionality that pertains to the page state.
+ * This API provides functionality that relates to the page state.
  * Accessed from the window at `window.sas.vi.pageState`.
  *
  * @example window.sas.vi.pageState.getCurrent();
@@ -51,7 +51,7 @@ export interface PageStateApi {
      */
     getCurrentHomepageDesigner(): HomepageDesignerState | undefined;
     /**
-     * Gives the currently active object pages state, or undefined if an object page
+     * Gives the currently active object page's state, or undefined if an object page
      * designer tab is not active.
      */
     getCurrentObjectPageDesigner(): ObjectPageDesignerState | undefined;

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

@@ -1,7 +1,7 @@
 import { Template, TemplateResourceSummary } from "../svi-datahub";
 import { ApplicationType, TemplateType } from "../page-admin/page-admin-api";
 /**
- * This API provides functionality that pertains to the page templates.
+ * This API provides functionality that relates to the page templates.
  *
  * Accessed from the window at `window.sas.vi.pageTemplate`.
  *

package/property/property-api.d.ts

@@ -92,7 +92,7 @@ export interface EditorApi {
     onPropertyChange(handler: (category: string, property: string, currentValue: any, previousValue: any) => void): () => void;
 }
 /**
- * This API pertains to page/toolbar control properties in SAS Visual Investigator.
+ * This API relates to page/toolbar control properties in SAS Visual Investigator.
  *
  * Accessed from the window at `window.sas.vi.property`.
  *

package/score-reps/index.d.ts

@@ -1,6 +1,6 @@
 /* tslint:disable */
 /* eslint-disable */
-// Generated using typescript-generator version 2.15.527 on 2025-04-07 09:10:17.
+// Generated using typescript-generator version 2.15.527 on 2025-09-03 08:54:03.
 
 export interface BaseRep extends TrackedResource {
     links?: Link[];

package/score-reps/package.json

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

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

@@ -40,8 +40,7 @@ export interface NetworkData {
     };
     numNodes: number;
 }
-export interface SearchAndCreateDialogModel extends CreateRelationshipDialogModel<SearchAndCreateResponse> {
-}
+export type SearchAndCreateDialogModel = CreateRelationshipDialogModel<SearchAndCreateResponse>;
 export interface SearchDialogModel extends SearchOrCreateAndLinkDialogBase<SearchDialogResponse> {
     canCreate?: boolean;
 }
@@ -61,7 +60,7 @@ export interface SearchAndCreateResponse {
     relateToModel?: SearchAndCreateRelateToModel;
 }
 /**
- * {@link SearchApi} extension pertains to functionality related to SAS Visual Investigator's search capabilities.
+ * {@link SearchApi} extension relates to functionality related to SAS Visual Investigator's search capabilities.
  * These additional methods are available only in the SAS Visual Investigator Investigate and Search interface.
  *
  * Accessed from the window at `window.sas.vi.search`.
@@ -83,13 +82,13 @@ export interface ClientSearchApi extends SearchApi {
      * @description Performs a search against the svi-sand service and navigates the user to the Search Results page.
      * @param queryText {string} Text used to form the query.
      * @param visualizationName {"summary" | "map" | "table"} Visualization to query for and then display to the user.
-     * @param [mapFilters] {MapFilter[]} The map filter object to include with the search query. This can consist of MapBoundedPolygonFilter, MapRadiusFilter, MapBoundedBoxFilter or MapShapeFilter.
+     * @param [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: "standard".
      */
     navigateSearch(queryText: string, visualizationName: SearchVisualization, mapFilters?: MapFilter[], queryMode?: QueryMode[]): Promise<void>;
     /**
      * @method
-     * @description Gets the current search query if one exists. Otherwise undefined.
+     * @description Gets the current search query if one exists. Otherwise, undefined.
      */
     getCurrentSearchQuery(): SearchQuery | undefined;
     /**
@@ -127,7 +126,7 @@ export interface ClientSearchApi extends SearchApi {
      * @method
      * @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 contentType {string} This is used in the content-type header when the file is uploaded. For example, 'image/png'.
      * @param [height] {string} Height of the Insights cell.
      * @param [width] {string} Width of the Insights cell.
      */
@@ -146,18 +145,18 @@ export interface ClientSearchApi extends SearchApi {
     addToNewWorkspace(objectsToAdd: ObjectIdentifier[], targetObjectType: string, targetObjectId?: string, visualization?: Visualization, workspaceName?: string, networkData?: NetworkData): Promise<void>;
     /**
      * @method
-     * @description Launches a wizard allowing users to search, before creating an object/relationship.
+     * @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 A Promise which resolves when the dialog box is closed.
+     * @returns A Promise that resolves when the dialog box is closed.
      */
     openSearchAndCreateDialog(wizardValues: SearchAndCreateDialogModel): Promise<SearchAndCreateDialogModel>;
     /**
      * @method
-     * @description Launches a wizard allowing users to search, before creating an object/relationship.
+     * @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 {SearchDialogModel} Object containing entity and relationship data.
-     * @returns A Promise which resolves when the dialog box is closed.
+     * @returns A Promise that resolves when the dialog box is closed.
      */
     openSearchAndCreateDialog(wizardValues: SearchDialogModel): Promise<SearchDialogModel>;
     /**

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

@@ -12,45 +12,45 @@ export interface INavigationBarTabs<D1 = any, D2 = D1> {
 export interface INavigationBarTab<D = {
     [key: string]: any;
 }, SecondaryData = D> {
-    /** unique tab id */
+    /** Unique tab identifier */
     id: string;
-    /** url relative to shell root e.g. /user/123 - this must start with a / */
+    /** URL relative to shell root (e.g., /user/123) - must start with a forward slash */
     routeUrl: string;
-    /** label for the tab, can be String or the resource.key (if .isLabelResourceKey:true) */
+    /** Label for the tab, can be a string or resource key (if isLabelResourceKey is true) */
     label: string;
-    /** a weight used during .sort to order the tabs; will default to the order the tabs came as
-     * doesn't mean their array index, as many can be the same, negatives, fractions
-     * */
+    /** Weight used during sorting to order the tabs; defaults to the order in which tabs were added.
+     * This doesn't refer to array index, as many tabs can have the same value, including negatives and fractions.
+     */
     sortIndex?: number;
-    /** when true, will use resourceService.get to resolve INavigationBarTab.label */
+    /** When true, uses resourceService.get to resolve INavigationBarTab.label */
     isLabelResourceKey?: boolean;
-    /** font icon */
+    /** Font icon */
     icon?: string;
-    /**  image url */
+    /** Image URL */
     img?: string;
-    /** aria-controls id */
+    /** aria-controls ID */
     controlsId?: string;
-    /** list  of secondary tabs which will be displayed under the top-level tab */
+    /** List of secondary tabs displayed under the top-level tab */
     secondaryTabs?: Array<ISecondaryNavigationBarTab<SecondaryData>>;
-    /** keep track of the currently selected secondary tab */
+    /** Currently selected secondary tab */
     selectedSecondaryTab?: ISecondaryNavigationBarTab<SecondaryData>;
-    /** callback to configure save confirm actions on close. */
+    /** Callback to configure save confirmation actions on close */
     getSaveOptions?(tab: INavigationBarTab): INavigationBarTabSaveOptions | undefined;
-    /** callback when tab is removed */
+    /** Callback executed when tab is removed */
     onClose?(tab: INavigationBarTab): Promise<boolean> | Observable<boolean> | boolean;
-    /** mark tab as dirty */
+    /** Mark tab as having unsaved changes */
     dirty?: boolean;
-    /** visually disable and make tab unselectable */
+    /** Visually disable and make tab unselectable */
     disabled?: boolean;
-    /** visually hide tab and make unselectable */
+    /** Visually hide tab and make it unselectable */
     hidden?: boolean;
-    /** exclude tab from appearing in the navigation bar system tab menu */
+    /** Exclude tab from appearing in the navigation bar system tab menu */
     excludedFromSystemMenu?: boolean;
-    /** visually hide secondary tabs bar for a tab */
+    /** Visually hide secondary tabs bar for this tab */
     hideSecondaryTabs?: boolean;
-    /** indicate that the tab is associated with some new object being created. */
+    /** Indicate that the tab is associated with a new object being created */
     creating?: boolean;
-    /** any extra data to be associated with the tab */
+    /** Any additional data to be associated with the tab */
     data?: D;
 }
 export type ISecondaryNavigationBarTab<D = {
@@ -58,15 +58,15 @@ export type ISecondaryNavigationBarTab<D = {
 }> = Omit<INavigationBarTab<D>, "secondaryTabs" | "selectedSecondaryTab">;
 export interface SviShellTabData {
     /**
-     * required user capabilities for the tab.
-     * if unmet, the tab is hidden and cannot be navigated to.
+     * Required user capabilities for the tab.
+     * If unmet, the tab is hidden and cannot be navigated to.
      * @example
      * { or: ["svi.administration.alerts", "svi.vsd.flow.view"] }
      */
     requiredCapabilities?: RequiredResourcesExpression;
     /**
      * REST APIs required by the tab's content.
-     * if unavailable, the tab is hidden and cannot be navigated to.
+     * If unavailable, the tab is hidden and cannot be navigated to.
      * @example
      * { and: ["svi-alert", "documentGeneratorAdapter"] }
      */
@@ -82,41 +82,41 @@ export interface SviShellTabData {
 }
 export interface ExternalTabConfig<T = SviShellTabData, P = any> {
     /**
-     * will try to place at this index, can be negative, fraction, etc to put before/between existing tabs
+     * Will try to place at this index, can be negative, fraction, etc. to put before/between existing tabs.
      */
     sortIndex?: number;
     /**
-     * finds TabId, and adds this as a secondaryTab to that tab
+     * Finds TabId, and adds this as a secondaryTab to that tab.
      */
     mainTabId?: string;
     /**
-     * this is the element/tag name that will get presented
+     * This is the element/tag name that will be presented.
      */
     elementName: string;
     /**
-     * this is the URL that the tab will be registered under,
-     * technically it's just a unique ID as this will be used to unregister a route and close any related tab(s)
+     * This is the URL that the tab will be registered under.
+     * Technically it's just a unique ID as this will be used to unregister a route and close any related tab(s).
      */
     configUrl: string;
     /**
-     * function to return {@link INavigationBarTab} , remember routeUrl is from baseURL with a leading /
-     * fullUrl is the full URL that relates to the tab, useful when catching wildcards
-     * params is constructed as of /:param1/:param2, so {param1: string, param2: string}
-     * be aware fullUrl/params will be undefined if buildOnRegister true
+     * Function to return {@link INavigationBarTab}. Remember routeUrl is from baseURL with a leading /.
+     * fullUrl is the full URL that relates to the tab, useful when catching wildcards.
+     * params is constructed as of /:param1/:param2, so {param1: string, param2: string}.
+     * Be aware fullUrl/params will be undefined if buildOnRegister is true.
      */
     buildTab: (fullUrl?: string, params?: P) => INavigationBarTab<T>;
     /**
-     * add as a systemTab?, if left out will default to applicationTab, ignored if mainTabId is defined
+     * Add as a system tab. If left out will default to application tab, ignored if mainTabId is defined.
      */
     systemTab?: boolean;
     /**
-     * set this to true if you want the component to reset every time you navigate away
+     * Set this to true if you want the component to reset every time you navigate away.
      */
     doNotReuse?: boolean;
     /**
-     * set this to true if you want buildTab to run when registered (e.g. for a system tab that's always there)
-     * if your buildTab takes params, this can not be provided and must be assumed undefined
-     * a secondaryTab (one that has mainTabId) will be created regardless of this flag.
+     * Set this to true if you want buildTab to run when registered (e.g. for a system tab that's always there).
+     * If your buildTab takes params, this cannot be provided and must be assumed undefined.
+     * A secondaryTab (one that has mainTabId) will be created regardless of this flag.
      */
     buildOnRegister?: boolean;
 }
@@ -132,27 +132,27 @@ export interface ShellTabsApi<T = SviShellTabData> {
     /**
      * @method
      * @description This is used to expose any {@link PotentialTabItem} hooks on a component up to the Tab Service.
-     * @param {any} context pass "this"
-     * @param {HTMLElement} nativeElement This will pass the ElementRef for the component
+     * @param {any} context Pass "this".
+     * @param {HTMLElement} nativeElement 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 box can be created whe closing a dirty tab.
+     *  onTabClose {@link OnTabClose}, optional, can be used to prevent closing of a tab or close async.
+     *  onAttachTab {@link OnAttachTab}, will always trigger when currentNavigationBarTab is 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 box can be created when closing a dirty tab.
      */
     createTabApiForElement: (context: any, nativeElement: HTMLElement) => void;
     /**
      * @method
      * @description Use this function to register new routes for tabs.
-     * @param {ExternalTabConfig[]} tab See {@link ExternalTabConfig}
+     * @param {ExternalTabConfig[]} tab See {@link ExternalTabConfig}.
      */
     registerExternalTabs: (tab: Array<ExternalTabConfig<T>>) => void;
     /**
      * @method
      * @description Use this function to remove routes added via registerTabFn.
-     * @param {ExternalTabConfig[]} tabsToRemove See {@link ExternalTabConfig}
+     * @param {ExternalTabConfig[]} tabsToRemove See {@link ExternalTabConfig}.
      */
     unregisterExternalTabs: (tabsToRemove: Array<ExternalTabConfig<T>>) => void;
     /**
@@ -165,12 +165,12 @@ 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>;
     /**
@@ -188,7 +188,7 @@ export interface ShellTabsApi<T = SviShellTabData> {
     tabRemoved$: Observable<INavigationBarTab>;
     /**
      * @method
-     * @description get Tab by ID
+     * @description Get Tab by ID.
      * @param [tabId] {string} This will be ID of an existing tab.
      */
     getTabById: (tabId: string) => INavigationBarTab | undefined;
@@ -207,10 +207,10 @@ export interface ShellTabsApi<T = SviShellTabData> {
     selectDefaultTab: () => Promise<boolean>;
     /**
      * @method
-     * @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
+     * @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>;
@@ -229,10 +229,10 @@ export interface ShellTabsApi<T = SviShellTabData> {
     removeApplicationTabById: (tabIdToRemove: string, suppressNavigation?: boolean) => Promise<boolean>;
     /**
      * @method
-     * @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.
+     * @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} This will be ID of an existing tab.
-     * @param [newTab] {INavigationBarTab} See {@link INavigationBarTab}
+     * @param [newTab] {INavigationBarTab} See {@link INavigationBarTab}.
      *
      */
     replaceApplicationTab: (tabId: string, newTab: INavigationBarTab) => Promise<boolean>;

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

@@ -20,16 +20,16 @@ export interface OnTabEnterParams {
 export type OnTabLeaveParams = Omit<OnTabEnterParams, "recycled">;
 export interface OnTabEnter {
     /**
-     * Function to run when the Tab is entered, this happens on first load as well
-     * @param params - from is previous tab (possibly undefined on first load), to is always this tab;
-     *                 type {@link INavigationBarTab}, recycled is whether the component was recycled or not
+     * Function to run when the tab is entered. This happens on first load as well.
+     * @param params - from is the previous tab (possibly undefined on first load), to is always this tab;
+     *                 type {@link INavigationBarTab}, recycled indicates whether the component was recycled or not.
      */
     onTabEnter(params: OnTabEnterParams): void;
 }
 export interface OnTabLeave {
     /**
-     * Function to run when the Tab is left
-     * @param params - from is always this tab, to is where the user is going; type {@link INavigationBarTab}
+     * Function to run when the tab is left.
+     * @param params - from is always this tab, to is where the user is going; type {@link INavigationBarTab}.
      */
     onTabLeave(params: OnTabLeaveParams): void;
 }
@@ -46,13 +46,13 @@ export interface TabWithToolbar<T> {
 }
 export interface OnTabClose {
     /**
-     * @param tab the current tab model that is closing.
+     * @param tab The current tab model that is closing.
      */
     onTabClose(tab: INavigationBarTab): boolean | Promise<boolean> | Observable<boolean>;
 }
 export interface OnTabSaveConfirm {
     /**
-     * @param tab the current tab model that is closing.
+     * @param tab The current tab model that is closing.
      */
     onTabSaveConfirm(tab: INavigationBarTab): INavigationBarTabSaveOptions | undefined;
 }