@sassoftware/vi-api 1.51.1 → 1.54.1

package/README.md

@@ -4,7 +4,7 @@ The [SAS Visual Investigator](https://www.sas.com/en_us/software/intelligence-an
 
 ## Getting Started
 
-For documentation and examples please see our [Solution Extension GitHub](https://github.com/sassoftware/vi-solution-extensions).
+For documentation and examples, see the SAS [Solution Extension GitHub](https://github.com/sassoftware/vi-solution-extensions).
 
 ### Installation
 To use the API, install the NPM package [@sassoftware/vi-api](https://www.npmjs.com/package/@sassoftware/vi-api):

package/alert-reps/index.d.ts

@@ -1,6 +1,6 @@
 /* tslint:disable */
 /* eslint-disable */
-// Generated using typescript-generator version 2.15.527 on 2025-09-03 08:54:51.
+// Generated using typescript-generator version 2.15.527 on 2026-02-12 22:23:08.
 
 export interface ActionRequestRep {
     version?: number;
@@ -124,18 +124,6 @@ export interface AlertRep extends BaseRep {
     autoActivateScore?: number;
     strategyRangeLow?: number;
     strategyRangeHigh?: number;
-    systemServiceTimestamp?: string;
-    autoCloseTimestamp?: string;
-    autoActivateTimestamp?: string;
-    alertVersionTimestamp?: string;
-    statusTimestamp?: string;
-    dispositionTimestamp?: string;
-    suppressionEndTimestamp?: string;
-    holdEndTimestamp?: string;
-    queueEntryTimestamp?: string;
-    assignmentTimestamp?: string;
-    checkoutTimestamp?: string;
-    userServiceTimestamp?: string;
 }
 
 export interface AlertVersionSummaryRep {
@@ -176,6 +164,14 @@ export interface AlertingDataNestedRep extends TypedPayload {
     alertingEvents?: AlertingEventNestedRep<any>[];
 }
 
+export interface AlertingEventFieldDescriptionRep {
+    fieldName?: string;
+    labelText?: string;
+    headerText?: string;
+    dataType?: string;
+    isEnrichment?: boolean;
+}
+
 export interface AlertingEventNestedRep<SFE> extends AlertingEventRep {
     scenarioFiredEvents?: SFE[];
     contributingObjects?: ContributingObjectRep[];
@@ -204,7 +200,7 @@ export interface AlertingEventRep extends BaseRep {
     rollingCalculationTimeStamp?: string;
     scoreAggregationPolicy?: string;
     scoreDescription?: string;
-    rollingCalculationTimestamp?: string;
+    jobId?: string;
 }
 
 export interface BaseRep extends TrackedResource {
@@ -317,21 +313,29 @@ export interface ExtendedScenarioFiredEventRep extends ScenarioFiredEventRep {
     alertingEventId?: string;
     modelName?: string;
     alertTypeCode?: string;
+    alertTypeLabel?: string;
     alertTriggerText?: string;
     suppressedFlag?: boolean;
     reasonCode?: string;
+    reasonLabel?: string;
 }
 
 export interface FieldDescriptionRep {
     version?: number;
     fieldName?: string;
     type?: string;
+    dataType?: string;
     size?: number;
     labelText?: string;
     headerText?: string;
     isEnrichment?: boolean;
 }
 
+export interface IdRep extends Serializable {
+    version?: number;
+    id?: string;
+}
+
 export interface LogicExpressionRep extends BaseRep {
     conditionCode?: string;
     logicExpressionId?: string;
@@ -369,6 +373,15 @@ export interface QueueRep extends BaseRep {
     version?: number;
 }
 
+export interface ReflectionUtilsTest {
+}
+
+export interface NoAnnotatedFieldsClass {
+}
+
+export interface TestClass {
+}
+
 export interface RelationshipRep extends Serializable {
     relationshipType?: string;
     fields?: { [index: string]: any };
@@ -430,17 +443,39 @@ export interface ScenarioDispositionSummaryRequestRep {
     startDatetime?: string;
 }
 
+export interface ScenarioFieldEventFieldDescriptionRep {
+    fieldName?: string;
+    labelText?: string;
+    headerText?: string;
+    dataType?: string;
+}
+
+export interface ScenarioFiredEventBulkDispositionRep extends BaseRep {
+    version?: number;
+    scenarioFiredEventDispositionReps?: ScenarioFiredEventDispositionRep[];
+    scenarioFiredEventFailedDispositionReps?: ScenarioFiredEventFailedDispositionRep[];
+}
+
 export interface ScenarioFiredEventDispositionRep extends BaseRep {
     version?: number;
     scenarioFiredEventDispositionId?: string;
     scenarioFiredEventId?: string;
     alertDispositionId?: string;
+    alertId?: string;
     resolutionCode?: string;
     resolutionComment?: string;
     reasonCode?: string;
     logicalDeleteFlag?: string;
 }
 
+export interface ScenarioFiredEventFailedDispositionRep extends BaseRep {
+    version?: number;
+    scenarioFiredEventId?: string;
+    actionableEntityId?: string;
+    alertId?: string;
+    errorMessage?: string;
+}
+
 export interface ScenarioFiredEventFlatRep extends ScenarioFiredEventRep {
     alertingEventId?: string;
 }
@@ -449,6 +484,7 @@ export interface ScenarioFiredEventRep extends BaseRep {
     version?: number;
     scenarioFiredEventId?: string;
     scenarioFiredEntityType?: string;
+    scenarioFiredEntityLabel?: string;
     scenarioFiredEntityId?: string;
     scenarioId?: string;
     scenarioName?: string;
@@ -470,20 +506,27 @@ export interface ScenarioFiredEventRep extends BaseRep {
     messageValuesJsonAsText?: string;
     weight?: number;
     recommendedQueueId?: string;
+    recommendedQueueName?: string;
     contextRelationshipName?: string;
     contextTimeStampFieldName?: string;
+    contextTimeStampFieldLabel?: string;
     contextStartTimeStamp?: string;
     contextEndTimeStamp?: string;
     replicateFlag?: boolean;
     replicationPolicy?: ScenarioFiredEventReplicationPolicyType;
     externalReplicationEntityName?: string;
+    externalReplicationEntityLabel?: string;
     externalReplicationEntitySFEIdFieldName?: string;
+    externalReplicationEntitySFEIdFieldLabel?: string;
     contributingObjects?: ContributingObjectRep[];
     currentDispositionResolutionCode?: string;
+    currentDispositionResolutionLabel?: string;
     currentProductiveUserId?: string;
+    currentProductiveUserName?: string;
     currentProductiveTimeStamp?: string;
     currentDispositionComment?: string;
     receivedScenarioFiredEntityType?: string;
+    receivedScenarioFiredEntityLabel?: string;
     receivedScenarioFiredEntityId?: string;
     valueText?: string;
     valueNumeric?: number;
@@ -496,8 +539,18 @@ export interface ScenarioFiredEventRep extends BaseRep {
     segmentGroupId?: string;
     entitySegmentCode?: string;
     appliedSegmentCode?: string;
+    createdByName?: string;
+    modifiedByName?: string;
     currentProductiveTimestamp?: string;
     valueTimestamp?: string;
+    value?: any;
+}
+
+export interface ScenarioRep extends BaseRep {
+    scenarioId?: string;
+    scenarioName?: string;
+    strategyId?: string;
+    version?: number;
 }
 
 export interface ScenarioTagRep extends BaseRep {
@@ -636,6 +689,9 @@ export interface MapType {
     entry?: MapEntryType[];
 }
 
+export interface ReflectionUtils {
+}
+
 export interface Link extends Serializable, Comparable<Link> {
     method?: string;
     rel?: string;

package/alert-reps/package.json

@@ -1,5 +1,5 @@
 {
   "name": "@types/alert-reps",
-  "version": "21.1.1",
+  "version": "22.0.7",
   "types": "index.d.ts"
 }

package/api.module.js

@@ -30,6 +30,7 @@ import { TraversalApiService } from "./traversal/traversal-api.service";
 import { PageTemplateApiService } from "./page-template/page-template-api.service";
 import { PageSharedModule } from "../spb/shared/spb-shared.module";
 import { HubCommonsModule } from "../fdh/hub-commons/hub-commons.module";
+import { McpApiService } from "./mcp/mcp-api.service";
 let ApiModule = class ApiModule {
 };
 ApiModule = __decorate([
@@ -57,13 +58,11 @@ ApiModule = __decorate([
             SearchApiService,
             TabApiService,
             ThemeApiService,
-            TraversalApiService
+            TraversalApiService,
+            McpApiService
         ],
         // Import modules which bootstrap used AngularJs injectables
-        imports: [
-            PageSharedModule,
-            HubCommonsModule
-        ]
+        imports: [PageSharedModule, HubCommonsModule]
     })
 ], ApiModule);
 export { ApiModule };

package/component/bindings.d.ts

@@ -19,6 +19,7 @@ export interface PageViewerApi {
     save: () => Promise<void>;
     isDirty: () => boolean;
     isValid: () => Promise<boolean>;
+    getPageModel: () => PageModel | undefined;
 }
 export type PageViewerBindings = CreateObjectPageBindings | EditObjectPageBindings | ViewObjectPageBindings | StaticDataPageBindings | PageBindings;
 export declare enum PageViewerBindingsType {

package/component/bindings.js

@@ -1,3 +1,4 @@
+/* eslint-enable @typescript-eslint/no-deprecated */
 export var PageViewerBindingsType;
 (function (PageViewerBindingsType) {
     PageViewerBindingsType["CreateObject"] = "CREATE";

package/config/standardPropertyTypes.js

@@ -51,4 +51,8 @@ export var StandardPropertyTypes;
     StandardPropertyTypes["Hidden"] = "Hidden";
     StandardPropertyTypes["Disabled"] = "Disabled";
     StandardPropertyTypes["Condition"] = "Condition";
+    /**
+     * @internal For now as there is no consumer request and the editor only supports the usage by the (feature flagged) generated text control.
+     */
+    StandardPropertyTypes["PromptTemplate"] = "PromptTemplate";
 })(StandardPropertyTypes || (StandardPropertyTypes = {}));

package/control/control-api.d.ts

@@ -40,7 +40,7 @@ export interface ControlMemberApi<ControlTypeAttributes extends TypeAttributes =
     readonly admin: ControlAdminApi;
 }
 /**
- * This Control API pertains to functionality that checks the state, registers event handlers, and so on.
+ * This Control API relates to functionality that checks the state, registers event handlers, and so on.
  */
 export interface ControlApiBase<ControlTypeAttributes extends TypeAttributes = TypeAttributes, ControlFieldType extends FieldType = never> {
     /**
@@ -51,12 +51,13 @@ export interface ControlApiBase<ControlTypeAttributes extends TypeAttributes = T
     readonly type: string;
     /**
      * Control Mask
-     * @deprecated use `api.control.masking.isConfiguredForMasking` instead.
-     **/
+     * @deprecated Use `api.control.masking.isConfiguredForMasking` instead.
+     */
     isMaskedControl(): boolean;
-    /** Control Mask Authorization
-     * @deprecated use `api.control.masking.isAuthorizedToUnmask`
-     **/
+    /**
+     * Control Mask Authorization
+     * @deprecated Use `api.control.masking.isAuthorizedToUnmask` instead.
+     */
     isAuthorizedToUnmask(): boolean;
     /**
      * Sets the value of the control's field.
@@ -83,7 +84,7 @@ export interface ControlApiBase<ControlTypeAttributes extends TypeAttributes = T
      * Returns the client field properties that are associated with the calling control.
      * Field must be configured as dataSource in the control's typeAttributes.
      * @method
-     * @returns The field restrictions that should be applied.
+     * @returns The client field properties that should be applied.
      */
     getClientFieldProperties(): FieldTypeToClientFieldProperties<ControlFieldType> | undefined;
     /**
@@ -107,12 +108,12 @@ export interface ControlApiBase<ControlTypeAttributes extends TypeAttributes = T
      */
     getControl(): Control<ControlTypeAttributes>;
     /**
-     * Access the Control Data Masking API
+     * Access the Control Data Masking API.
      */
     masking: MaskingControlApi;
 }
 /**
- * This API pertains to administration functionality for controls, for example registering resources.
+ * This API relates to administration functionality for controls, for example registering resources.
  *
  * @category API
  */
@@ -209,7 +210,7 @@ export interface ControlStateApi {
     /**
      * Returns the masked state of the calling control.
      * True if the control is masked, otherwise false.
-     * @deprecated use `api.control.masking.isMasked`
+     * @deprecated Use `api.control.masking.isMasked` instead.
      */
     readonly maskActive: boolean;
     /**
@@ -411,7 +412,7 @@ export interface ControlPageApi extends ControlPageApiBase {
     reloadRefreshableControls(categoryToRefresh?: string, controlToRefresh?: Control): void;
     /**
      * @method
-     * @returns True if any RefreshableControls have options.requiresIndex present. Otherwise false
+     * @returns True if any RefreshableControls have options.requiresIndex present. Otherwise, false.
      */
     hasAnyRefreshableControlRequiresIndex(): boolean;
     /**
@@ -428,10 +429,10 @@ export interface ControlPageApi extends ControlPageApiBase {
      * Toggle the page-level sliding panel. This panel should be used to contain information that is
      * supplementary to the document, for example attachments or workflow tasks.
      * @method
-     * @param [sectionLabel] {string} Describes the section, this should be internationalized.
+     * @param [sectionLabel] {string} Describes the section; this should be internationalized.
      * @param [content] {SlidingPanelContent} The content of the sliding panel.
      * @param [panelProperties] {SlidingPanelProperties} Properties for the panel.
-     *      When providing a url for content: the panel properties will be available on the controller's "slidingPanel" object.
+     *      When providing a URL for content: the panel properties will be available on the controller's "slidingPanel" object.
      *      When providing a selector for content: the properties will be set on the element to be created.
      * @param [onClose] {function} A callback function invoked when the panel is dismissed. There are no parameters. Returns void.
      * @param [focusPreviousActiveElementOnClose] {boolean} Toggle for whether the app should apply focus to the last active element before the panel was opened.
@@ -479,15 +480,26 @@ export interface ControlPageApi extends ControlPageApiBase {
      */
     save(stopEditing: boolean, closeObject: boolean): Promise<void>;
     /**
-     * Access the Page Data Masking API
+     * Access the Page Data Masking API.
      */
     masking: MaskingPageApi;
+    /**
+     * Register a callback function that is invoked when the page that contains the current control is navigated back to.
+     * Useful for updating homepage controls whose config sets "reuse" to true and need to update when the homepage is reloaded.
+     * @method
+     * @param callback {function} The function to be invoked.
+     */
     onNavigationStart(callback: () => void): void;
     /**
-     * Checks if the sliding panel is pinned
+     * Checks if the sliding panel is pinned.
      * @returns A boolean value that checks whether the sliding panel is pinned.
      */
     isSlidingPanelPinned(): boolean | undefined;
+    /**
+     * Gives whether a loading mask is shown for the page.
+     * This loading mask is shown when the page is saving or a disposition is in progress.
+     */
+    isLoadingMaskShown(): boolean;
 }
 /**
  * Methods related to files.
@@ -569,8 +581,7 @@ export interface ControlFileApi extends ControlFileApiBase {
  * Equivalent to {@link PageEventsApiBase} with the exception that event hooks will be scoped to the page on which the calling control resides.
  * @extends PageEventsApiBase
  */
-export interface ControlPageEventsApi extends PageEventsApiBase {
-}
+export type ControlPageEventsApi = PageEventsApiBase;
 export interface FieldNotOnPageError {
     name: "FieldNotOnPageError";
     message: string;

package/control/restrictions.d.ts

@@ -31,6 +31,7 @@ export interface ReferenceDataRestrictions extends FieldRestrictions {
     cascadingReferenceDataName?: string;
     cascadingReferenceDataFilterByCode?: string;
     cascadingReferenceDataFilterByField?: string;
+    cascadingReferenceDataFilterByParentCode?: string;
 }
 export type UserGroupStrategy = "USERS" | "GROUPS" | "USERS_AND_GROUPS";
 export interface UserGroupRestrictions extends FieldRestrictions {

package/current-user/currentUser-api.js

@@ -1,3 +1,4 @@
+// eslint-disable-next-line no-restricted-imports -- these get tree shaken out
 import { expectType } from "../../shared/util/helper-functions";
 export var IdentityState;
 (function (IdentityState) {

package/elements/identity-select.js

@@ -1,3 +1,4 @@
+// eslint-disable-next-line no-restricted-imports -- these get tree shaken out
 import { expectType } from "../../shared/util/helper-functions";
 /** @category Identities Types */
 export var SizeType;

package/index.d.ts

@@ -23,6 +23,7 @@ import { TraversalApi } from "./traversal/traversal-api";
 import { ShellTabsApi } from "./shell-tabs/shell-tabs-api";
 import { PageTemplateApi } from "./page-template/page-template-api";
 import { InitApi } from "./init";
+import { McpApi } from "./mcp";
 /**
  * The SVI API contains common API functions and can be accessed directly from the window via `window.sas.vi`
  *
@@ -58,6 +59,7 @@ export interface SviClientApi extends SviCommonApi {
     search: ClientSearchApi;
     sheet: SheetApi;
     tab: TabApi;
+    mcpApi?: McpApi;
 }
 /**
  * The Admin API.
@@ -66,9 +68,14 @@ export interface SviAdminApi extends SviCommonApi {
     metadata: AdminMetadataApi;
 }
 export type SviApi = SviClientApi | SviAdminApi;
-export type SviWindow = typeof window & {
-    sas: {
-        vi: SviApi;
-        viInit: InitApi;
-    };
-};
+export type SviWindow = typeof globalThis & Window & VIWindowApi;
+export interface VIWindowApi {
+    sas: VISASApi;
+}
+export interface VISASApi {
+    vi: SviApi;
+    viInit: InitApi;
+}
+export declare function getApi<T extends SviApi = SviApi>(): T;
+export declare function isUserAppApi(api: SviApi): api is SviClientApi;
+export declare function isAdminAppApi(api: SviApi): api is SviAdminApi;

package/index.js

@@ -1 +1,13 @@
-export {};
+export function getApi() {
+    const api = globalThis.sas.vi;
+    if (typeof api !== "object" || api === null) {
+        throw new TypeError("SVI API is not available or not properly initialized");
+    }
+    return api;
+}
+export function isUserAppApi(api) {
+    return "sheet" in api;
+}
+export function isAdminAppApi(api) {
+    return !isUserAppApi(api);
+}

package/mcp/index.d.ts

@@ -0,0 +1 @@
+export * from "./mcp-api";

package/mcp/index.js

@@ -0,0 +1 @@
+export * from "./mcp-api";

package/mcp/mcp-api.d.ts

@@ -0,0 +1,75 @@
+import { Transport } from "@modelcontextprotocol/sdk/shared/transport.js";
+export interface PromptPlaceholderDefinition {
+    title: string;
+    type: "string" | "number" | "boolean" | "date" | "date-time";
+    enumNames?: string[];
+    required?: boolean;
+}
+export interface SimpleContextMenuPrompt {
+    label: string;
+    parentLabel: string;
+    prompt: string;
+    placeholders?: Record<string, PromptPlaceholderDefinition>;
+}
+export interface RemoteMCPServerConfig {
+    url: string;
+}
+export interface BaseMCPServerConfig {
+    name: string;
+    version: string;
+}
+export interface StreamableMCPServerConfig extends BaseMCPServerConfig, RemoteMCPServerConfig {
+    url: string;
+    name: string;
+    transport: "streamable";
+    headers?: Record<string, string>;
+}
+export interface LocalTransportConfig extends BaseMCPServerConfig {
+    name: string;
+    version: string;
+    transport: "local";
+    connect: (transport: Transport) => void;
+}
+/**
+ * This API provides functionality related to extension of MCP (Model Context Protocol) on the VI platform.
+ *
+ * Accessed from the window at `window.sas.vi.mcp`.
+ *
+ * @example window.sas.vi.mcp.registerMCPServer(newMcpConfig);
+ * @category API
+ */
+export interface McpApi {
+    /**
+     * @method
+     * @description Registers an MCP server with the VI platform using the provided configuration.
+     * @param config The configuration object for the MCP server to register.
+     * @returns A Promise that resolves when the server has been successfully registered.
+     */
+    registerServer(config: StreamableMCPServerConfig | LocalTransportConfig): Promise<void>;
+    /**
+     * @method
+     * @description Deregisters an MCP server from the VI platform using the provided configuration.
+     * @param config The configuration object for the MCP server to deregister.
+     * @returns A Promise that resolves when the server has been successfully deregistered.
+     */
+    deregisterServer(config: StreamableMCPServerConfig | LocalTransportConfig): Promise<void>;
+    /**
+     * @method
+     * @description Registers prompts with the VI platform that can be used in MCP interactions.
+     * @param prompts The array of prompts to add to the existing prompts on the system. If a prompt with the same label and parentLabel already exists, it will be ignored.
+     * @see SimpleContextMenuPrompt for more detail on prompt definitions.
+     * @example window.sas.vi.mcpApi.registerPrompts([{label: "Example Prompt", parentLabel: "Example Prompts", prompt: "Tell me more about Visual Investigator."}]);
+     */
+    registerPrompts(prompts: SimpleContextMenuPrompt[]): void;
+}
+export type ValidElicitationDataTypes = number | string | boolean | undefined;
+export type ElicitationDialogResponse = {
+    action: "accept";
+    data: {
+        values: Record<string, ValidElicitationDataTypes>;
+        promptResult?: string;
+    };
+} | {
+    action: "decline" | "cancel";
+    data: undefined;
+};

package/mcp/mcp-api.js

@@ -0,0 +1,6 @@
+// eslint-disable-next-line no-restricted-imports
+import { expectType } from "../../shared/util/helper-functions";
+expectType(true);
+expectType(true);
+expectType(true);
+expectType(true);

package/mcp/package.json

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

package/metadata/metadata-api.d.ts

@@ -113,7 +113,7 @@ export interface ValidRelationshipTypes {
     [relationshipName: string]: RelationshipTypes;
 }
 export interface RelationshipTypes {
-    isIndexedForSearch: boolean;
+    indexedForSearch: boolean;
     linkTypes: Relationship[];
     name: string;
     searchBeforeCreate: boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sassoftware/vi-api",
-  "version": "1.51.1",
+  "version": "1.54.1",
   "description": "Types used in the SAS Visual Investigator API",
   "keywords": [
     "SAS",
@@ -32,6 +32,7 @@
   "types": "index.d.ts",
   "peerDependencies": {
     "@types/angular": "^1.7.3",
-    "@types/angular-resource": "^1.5.16"
+    "@types/angular-resource": "^1.5.16",
+    "@modelcontextprotocol/sdk": "^1.20.2"
   }
 }

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

@@ -172,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

@@ -90,9 +90,40 @@ export interface EditorApi {
      * @returns A function that stops the handler from being invoked.
      */
     onPropertyChange(handler: (category: string, property: string, currentValue: any, previousValue: any) => void): () => void;
+    /**
+     * Methods and properties related to the state of the property editor.
+     */
+    readonly state: EditorStateApi;
+}
+/**
+ * Methods and properties related to the state of the property editor.
+ *
+ * @category API
+ */
+export interface EditorStateApi extends EditorState {
+    /**
+     * Registers a function to be invoked whenever a state change event occurs.
+     * This function receives an object that contains information about the change event.
+     *
+     * @method
+     * @param handler {function} Function to be invoked when a state is changed.
+     */
+    onChange(handler: (state: EditorState) => void): void;
+}
+export interface EditorState {
+    /**
+     * Returns the disabled state of the property editor.
+     * True if the control is disabled, otherwise false.
+     */
+    readonly disabled: boolean;
+    /**
+     * Returns the required state of the property editor.
+     * True if the control is required, otherwise false.
+     */
+    readonly required: boolean;
 }
 /**
- * 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`.
  *