@sassoftware/vi-api 1.55.1 → 1.56.1

package/component/bindings.d.ts

@@ -10,12 +10,12 @@
  * If you need to add a new interface, please consider whether it can extend an existing one or if a new base interface should be created to group related bindings together.
  * Please also add JSDoc comments to the new bindings and interfaces to explain their purpose and usage.
  */
-import { PageDataChange, PageModeChange } from "../control/events";
+import { PageDataChange, PageDataChangeWithPageModel, PageModeChange, PageModeChangeWithPageModel } from "../control/events";
 import { Relationship } from "../svi-datahub";
 import { QueryMode } from "../svi-sand";
-import { ControlContainer, VIObject } from "../object/object-api";
+import { APISelectedItem, ControlContainer, CreateDialogResponse, IRelationshipWithLabel, RelationshipInformation, VIObject } from "../object/object-api";
 import { PageModel, PageModelObjectData } from "../page-model/page-model-api";
-import { SearchObject, SearchQuery } from "../search/client/client-search-api";
+import { LinkStatusResult, SearchObject, SearchQuery } from "../search/client/client-search-api";
 import { HandleType, MinMaxDates, TimeSliderContextMenuHideOptions, TimeSliderEventDates, TimeSliderRange, TimeSliderRangeChangedEvent } from "../time-slider";
 import { PageModeEvent } from "../control";
 export interface SearchAndSelectWithPreviewInputBindings {
@@ -135,7 +135,7 @@ export interface CommonPageViewerBindings {
     /** A callback that is called when the page viewer dirty state changes. */
     onDirty?: (isDirty: boolean) => void;
     /** A callback that is called when the pageModel's mode or data changes. */
-    onChange?: (change: PageDataChange | PageModeChange) => void;
+    onChange?: (change: PageDataChange | PageModeChange | PageDataChangeWithPageModel | PageModeChangeWithPageModel) => void;
 }
 /** @deprecated use {@link PageViewerBindings} */
 export interface PageBindings {
@@ -156,7 +156,7 @@ export interface PageBindings {
     setApi?: (api: PageViewerApi) => void;
     mainTab?: string;
     onDirty?: (isDirty: boolean) => void;
-    onChange?: (change: PageDataChange | PageModeChange) => void;
+    onChange?: (change: PageDataChange | PageModeChange | PageDataChangeWithPageModel | PageModeChangeWithPageModel) => void;
 }
 export interface PagePreviewBindings {
     templateUuid: string;
@@ -169,7 +169,7 @@ export interface ControlCollectionBindings {
 /**
  * Defines the bindings for managing relationship details in a component.
  */
-export interface RelationshipDetailsBindings {
+export interface RelationshipDetailsInputBindings {
     /**
      * Defines the identifier of the target object type that the relationship references.
      */
@@ -189,15 +189,16 @@ export interface RelationshipDetailsBindings {
     /**
      * Represents the list of reasons that define the purpose or context of the relationship.
      */
-    linkReasons: Relationship[];
+    linkReasons: Relationship[] | IRelationshipWithLabel[];
     /**
      * Represents the currently selected item in the relationship, if applicable.
-     * Contains an object with `id` and `type` fields to identify the selected item.
+     * Contains an object with `id`, `type`, and optional `title` fields to identify the selected item.
      */
-    selectedItem?: {
-        id: string;
-        type: string;
-    };
+    selectedItem?: APISelectedItem;
+    /**
+     * Represents the list of currently selected items in the relationship, if applicable.
+     */
+    selectedItems?: APISelectedItem[];
     /**
      * Fields that are read-only and cannot be modified by the user within the relationships properties panel
      */
@@ -208,24 +209,50 @@ export interface RelationshipDetailsBindings {
     hiddenFields?: string[];
     /**
      * Contains the data for a new page model, if applicable.
-     * Includes a `PageModelObjectData` object to represent the model structure.
+     * Includes a `PageModel` or `PageModelObjectData` object to represent the model structure.
      */
     newPageModel?: {
-        model: PageModelObjectData;
+        model: PageModel | PageModelObjectData;
     };
     /**
-     * Callback invoked when a link reason is selected.
-     * @param linkReason - The selected link reason.
+     * Indicates whether to display the page viewer component. Default: true
      */
-    onLinkReasonSelected: (linkReason: Relationship) => void;
+    showPageViewer?: boolean;
+    /**
+     * Used to show link status in the relationship properties component when coming from the relate to button bulk link flow
+     */
+    linkStatusResults?: LinkStatusResult[];
+    /**
+     * Used to show link status in the relationship properties component when coming from the relate to button bulk link flow
+     */
+    originalWizardResults?: CreateDialogResponse[];
     /**
      * Represents the current field values of the relationship as key-value pairs.
      */
-    relationshipValues?: Record<string, any>;
+    relationshipValues?: Record<string, unknown>;
     /**
      * Represents the initial field values used to populate the related object during creation.
      */
-    initialCreateData?: Record<string, any>;
+    initialCreateData?: Record<string, unknown>;
+    /**
+     * Entity names of the selected items.
+     */
+    entityNames?: string[];
+    /**
+     * Entity name of the parent object to which we are relating.
+     */
+    relateToParentName?: string;
+    /**
+     * Stored relationship info for each selected item, used to restore state when navigating between wizard steps.
+     */
+    storedAllRelationshipInfo?: Map<string, RelationshipInformation>;
+}
+export interface RelationshipDetailsBindings extends RelationshipDetailsInputBindings {
+    /**
+     * Callback invoked when a link reason is selected.
+     * @param linkReason - The selected link reason.
+     */
+    onLinkReasonSelected: (linkReason: Relationship | IRelationshipWithLabel | undefined) => void;
     /**
      * Callback to set the API for the page viewer.
      * Provides a `PageViewerAPI` instance to the component.
@@ -235,20 +262,36 @@ export interface RelationshipDetailsBindings {
     /**
      * Callback invoked when the related page changes.
      * Triggered by events such as data updates or mode transitions.
-     * @param change - The event describing the change, either `PageDataChange` or `PageModeChange`.
+     * @param change - The event describing the change, either `PageDataChange`, `PageModeChange`, `PageDataChangeWithPageModel`, or `PageModeChangeWithPageModel`.
      */
-    onRelatedPageChange?: (change: PageDataChange | PageModeChange) => void;
+    onRelatedPageChange?: (change: PageDataChange | PageModeChange | PageDataChangeWithPageModel | PageModeChangeWithPageModel) => void;
     /**
      * Callback invoked when the relationship values are updated.
      * Provides both the current and previous values for comparison.
-     * @param current - The updated relationship values.
-     * @param previous - The previous relationship values, if available.
+     * @param event - Object containing current and previous relationship values.
      */
-    onRelationshipValuesChange?: (current: Record<string, any>, previous?: Record<string, any>) => void;
+    onRelationshipValuesChange?: (event: {
+        current: Record<string, any>;
+        previous?: Record<string, any>;
+    }) => void;
     /**
-     * Callback invoked when the related page is loading is complete.
+     * Callback invoked when the related page loading is complete.
      */
     onRelatedPageLoad?: () => void;
+    /**
+     * Callback invoked when the relationship information is updated.
+     * @param allRelationshipInfo - Map of all relationship information keyed by item ID.
+     */
+    onAllRelationshipInfoChanged?: (allRelationshipInfo: Map<string, RelationshipInformation>) => void;
+    /**
+     * Callback invoked when the selected items are updated.
+     * @param event - Object containing the updated selected items and optionally the removed item.
+     */
+    selectedItemsUpdated?: (event: {
+        selectedItems: APISelectedItem[] | undefined;
+        removedItem?: APISelectedItem;
+        removedItemIndex?: number;
+    }) => void;
 }
 export interface SearchInputInputBindings {
     entityName: string;

package/config/standardPropertyTypes.d.ts

@@ -48,5 +48,6 @@ export declare enum StandardPropertyTypes {
     NetworkLinkSelector = "NetworkLinkSelector",
     Hidden = "Hidden",
     Disabled = "Disabled",
-    Condition = "Condition"
+    Condition = "Condition",
+    CreateRelationshipSelection = "CreateRelationshipSelection"
 }

package/config/standardPropertyTypes.js

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

package/control/events.d.ts

@@ -58,6 +58,11 @@ export interface PageDataChange {
         old?: PageModelData;
     };
 }
+export interface PageDataChangeWithPageModel extends PageDataChange {
+    pageModel: {
+        model: PageModelData;
+    };
+}
 export interface PageModeChange {
     readonly type: ChangeType.PAGE_MODE;
     value: {
@@ -65,6 +70,11 @@ export interface PageModeChange {
         old?: PageMode;
     };
 }
+export interface PageModeChangeWithPageModel extends PageModeChange {
+    pageModel: {
+        model: PageModelData;
+    };
+}
 export interface StateChange {
     readOnly?: boolean;
     hidden?: boolean;

package/mcp/mcp-api.d.ts

@@ -17,6 +17,7 @@ export interface RemoteMCPServerConfig {
 }
 export interface BaseMCPServerConfig {
     name: string;
+    title?: string;
     version: string;
 }
 export interface StreamableMCPServerConfig extends BaseMCPServerConfig, RemoteMCPServerConfig {

package/mcp/mcp-api.js

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

package/metadata/metadata-api.d.ts

@@ -282,4 +282,5 @@ export interface OptionsForGetRelationshipsForObjectType {
     includeHeterogeneous?: boolean;
     includeMultipleTypeRelationships?: boolean;
     expandMultipleRelationshipsToSingle?: boolean;
+    filterToRelationshipIds?: number[];
 }

package/object/object-api.d.ts

@@ -1,7 +1,9 @@
-import { Comment, Relationship, StoredObjectFieldDTO } from "../svi-datahub";
+import { Comment, Relationship, RelationshipDTO, StoredObjectFieldDTO } from "../svi-datahub";
 import { FileOperation } from "../file/file-api";
-import { PageModel } from "../page-model/page-model-api";
+import { PageModel, PageModelData } from "../page-model/page-model-api";
 import { ClientSheet, Sheet } from "../sheet/sheet-api";
+import { PageViewerApi } from "../component/bindings";
+import { PageDataChange, PageModeChange } from "../control";
 export interface ObjectIdentifier {
     id: string;
     type: string;
@@ -482,6 +484,13 @@ export interface ObjectRelationship {
     };
     qualifiedTypeName?: string;
 }
+export interface ObjectRelationshipMultiple extends ObjectRelationship {
+    fromId?: string;
+    fromEntityType?: string;
+    toId?: string;
+    toEntityType?: string;
+    operation?: string;
+}
 export interface AttachmentRow {
     description?: string;
     location: string;
@@ -534,14 +543,113 @@ export interface DisplayTextFields {
     name: string;
     displayIndex: number;
 }
+export declare enum SearchAndCreateStep {
+    Search = "search",
+    SearchResults = "searchResults",
+    Entity = "entity",
+    Relationship = "relationship"
+}
+interface SearchAndCreatePanelContext {
+    [SearchAndCreateStep.Search]: {
+        doSearch: (query: string, additionalModes?: string[]) => void;
+        updateQuery: (query: string) => void;
+        query: {
+            text: string;
+        };
+    };
+    [SearchAndCreateStep.SearchResults]: {
+        query: {
+            text: string;
+        };
+        updateSelection: (results: Array<{
+            id: string;
+            type: string;
+        }>) => void;
+    };
+    [SearchAndCreateStep.Entity]: {
+        setPageViewerApi(api: PageViewerApi): void;
+        onPageChange(change?: PageDataChange | PageModeChange): void;
+        newPageModel: {
+            model?: PageModel | PageModelData | null;
+        };
+        selectedItems: Array<{
+            id?: string;
+            type?: string;
+            title?: string;
+        }> | null | undefined;
+    };
+    [SearchAndCreateStep.Relationship]: {
+        updateLinkReason: (linkReason: Relationship) => void;
+        onPageChange(change?: PageDataChange | PageModeChange): void;
+        setPageViewerApi(api: PageViewerApi): void;
+        newPageModel: {
+            model?: PageModel | PageModelData | null;
+        };
+        selectedItems: Array<{
+            id?: string;
+            type?: string;
+            title?: string;
+        }> | null | undefined;
+    };
+}
+export interface SearchAndCreateFooterContext {
+    query?: {
+        text: string;
+    };
+    selectedItems?: Array<{
+        id?: string;
+        type?: string;
+        title?: string;
+    }> | null;
+    linkReason?: Relationship;
+    newPageModel?: {
+        model?: PageModel | PageModelData | null;
+    };
+    relationshipValues?: Record<string, any>;
+    doSearch: (queryText?: string) => void;
+    commit: () => void;
+    relateToSelected: () => void;
+    relateToNew: () => void;
+    close: (result?: unknown) => void;
+}
+interface BaseButton {
+    label: string;
+    primary?: boolean;
+    disabled?: boolean;
+}
+export type SearchAndCreateDialogButton = (BaseButton & {
+    onClick: () => void | Promise<void>;
+}) | (BaseButton & {
+    items: Array<{
+        text: string;
+        click: () => void;
+    }>;
+});
+export interface CustomSearchAndCreateStep<Step extends SearchAndCreateStep> {
+    panel?: {
+        render: (container: HTMLDivElement, context: SearchAndCreatePanelContext[Step]) => void;
+    };
+    footer?: {
+        getButtons: (context: SearchAndCreateFooterContext) => SearchAndCreateDialogButton[];
+    };
+}
+export type CustomSearchAndCreateSteps = {
+    [Step in SearchAndCreateStep]?: CustomSearchAndCreateStep<Step>;
+};
 export interface SearchOrCreateAndLinkDialogBase<T> {
     entityName: string;
     entityLabel: string;
+    entityNames?: string[];
+    entityLabels?: string[];
     onClose?: (result?: T) => Promise<boolean>;
     /**
      * Values returned on the close of the dialog box. May be undefined when dialog box is cancelled.
      */
     result?: T;
+    multipleSearchChoice?: boolean;
+    showPageViewer?: boolean;
+    customSteps?: CustomSearchAndCreateSteps;
+    customResult?: unknown;
 }
 export interface CreateRelationshipDialogModel<T> extends SearchOrCreateAndLinkDialogBase<T> {
     relateToParentName: string;
@@ -561,4 +669,18 @@ export interface CreateRelateToModel extends CreateRelationshipDialogResultModel
         model: PageModel;
     };
 }
+export interface IRelationshipWithLabel extends RelationshipDTO {
+    relationshipLabel: string;
+}
+export type APISelectedItem = ObjectIdentifier & {
+    title?: string;
+};
+export interface RelationshipInformation {
+    relationshipTypeId?: number;
+    relationshipValues?: Record<string, any>;
+    selectedItemTitle?: string;
+    requiredFieldsStatus?: any;
+    entityIconClass?: string;
+    entityType?: string;
+}
 export {};

package/object/object-api.js

@@ -16,3 +16,10 @@ export var ConditionFactType;
     ConditionFactType["Field"] = "FIELD";
     ConditionFactType["Condition"] = "CONDITION_REFERENCE";
 })(ConditionFactType || (ConditionFactType = {}));
+export var SearchAndCreateStep;
+(function (SearchAndCreateStep) {
+    SearchAndCreateStep["Search"] = "search";
+    SearchAndCreateStep["SearchResults"] = "searchResults";
+    SearchAndCreateStep["Entity"] = "entity";
+    SearchAndCreateStep["Relationship"] = "relationship";
+})(SearchAndCreateStep || (SearchAndCreateStep = {}));

package/package.json

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

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

@@ -1,5 +1,5 @@
 import { MapBoundedBoxFilter, MapBoundedPolygonFilter, MapRadiusFilter, MapShapeFilter, QueryMode, SearchRepresentation, SearchResponse, SummaryVisualizationResponse } from "../../svi-sand";
-import { CreateRelationshipDialogModel, CreateRelationshipDialogResultModel, ObjectIdentifier, SearchOrCreateAndLinkDialogBase } from "../../object/object-api";
+import { CreateDialogResponse, CreateRelationshipDialogModel, CreateRelationshipDialogResultModel, ObjectIdentifier, SearchOrCreateAndLinkDialogBase } from "../../object/object-api";
 import { QueryBuilderModel, SearchApi } from "../search-api";
 export declare enum SearchVisualization {
     Summary = "summary",
@@ -40,9 +40,36 @@ export interface NetworkData {
     };
     numNodes: number;
 }
+export interface LinkStatusErrorResponse {
+    errorCode?: number;
+    message?: string;
+    details?: string[];
+    id?: string;
+    version?: number;
+    httpStatusCode?: number;
+}
+export interface LinkStatusResult {
+    link: {
+        id?: string;
+        relationshipTypeName?: string;
+        fromEntityType?: string;
+        fromId?: string;
+        toEntityType?: string;
+        toId?: string;
+        operation?: string;
+        error?: LinkStatusErrorResponse;
+    };
+    success?: boolean;
+    error?: string;
+}
 export type SearchAndCreateDialogModel = CreateRelationshipDialogModel<SearchAndCreateResponse>;
 export interface SearchDialogModel extends SearchOrCreateAndLinkDialogBase<SearchDialogResponse> {
     canCreate?: boolean;
+    canCreateMap?: Record<string, boolean>;
+    initialQuery?: string;
+    initialCreateData?: Record<string, unknown>;
+    linkStatusResults?: LinkStatusResult[];
+    originalWizardResults?: CreateDialogResponse[];
 }
 export interface SearchDialogResponse {
     selectedItem?: SearchObject;