@sassoftware/vi-api 1.15.3 → 1.40.2

package/alert-reps/index.d.ts

@@ -1,6 +1,6 @@
 /* tslint:disable */
 /* eslint-disable */
-// Generated using typescript-generator version 2.15.527 on 2023-11-21 12:24:57.
+// Generated using typescript-generator version 2.15.527 on 2024-04-05 10:39:48.
 
 export interface ActionRequestRep {
     version?: number;
@@ -106,18 +106,18 @@ export interface AlertRep extends BaseRep {
     autoActivateScore?: number;
     strategyRangeLow?: number;
     strategyRangeHigh?: number;
-    alertVersionTimestamp?: string;
+    suppressionEndTimestamp?: string;
+    holdEndTimestamp?: string;
+    queueEntryTimestamp?: string;
+    assignmentTimestamp?: string;
+    checkoutTimestamp?: string;
     userServiceTimestamp?: string;
     systemServiceTimestamp?: string;
     autoCloseTimestamp?: string;
     autoActivateTimestamp?: string;
+    alertVersionTimestamp?: string;
     statusTimestamp?: string;
     dispositionTimestamp?: string;
-    suppressionEndTimestamp?: string;
-    holdEndTimestamp?: string;
-    queueEntryTimestamp?: string;
-    assignmentTimestamp?: string;
-    checkoutTimestamp?: string;
 }
 
 export interface AlertVersionSummaryRep {
@@ -630,8 +630,8 @@ export interface Link extends Serializable {
 }
 
 export interface TypedPayload {
-    payloadType?: string;
     eventType?: string;
+    payloadType?: string;
 }
 
 export interface TrackedResource extends Serializable, ETaggable, TimeTrackedResource, ETagAndLastModifiedProvider {

package/alert-reps/package.json

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

package/api.module.js

@@ -27,6 +27,7 @@ import { SheetApiService } from "./sheet/sheet-api.service";
 import { TabApiService } from "./tab/tab-api.service";
 import { ThemeApiService } from "./theme/theme-api.service";
 import { TraversalApiService } from "./traversal/traversal-api.service";
+import { PageTemplateApiService } from "./page-template/page-template-api.service";
 let ApiModule = class ApiModule {
 };
 ApiModule = __decorate([
@@ -45,6 +46,7 @@ ApiModule = __decorate([
             ObjectApiService,
             PageAdminApiService,
             PageModelApiService,
+            PageTemplateApiService,
             PageStateApiService,
             PropertyApiService,
             RefDataApiService,

package/component/bindings.d.ts

@@ -27,6 +27,7 @@ export interface PageBindings {
     showToolbar?: boolean;
     tempCreateId?: string;
     containerClass?: string;
+    fitToContainerHeight?: boolean;
     pageClass?: string;
     enableSheets?: string;
     pageModel?: PageModel;
@@ -37,6 +38,9 @@ export interface PageBindings {
     onDirty?: (isDirty: boolean) => void;
     onChange?: (change: PageDataChange | PageModeChange) => void;
 }
+export interface PagePreviewBindings {
+    templateUuid: string;
+}
 export interface ControlCollectionBindings {
     controlContainer?: ControlContainer;
     pageModel?: PageModel;
@@ -134,4 +138,4 @@ export interface TimeSliderBindings extends TimeSliderInputBindings {
     onLoad?: () => void;
     close?: () => void;
 }
-export declare type SviComponentBindings = ControlCollectionBindings | RelationshipDetailsBindings | SearchInputBindings | PageBindings | SearchAndSelectWithPreviewBindings | TimeSliderBindings;
+export type SviComponentBindings = ControlCollectionBindings | RelationshipDetailsBindings | SearchInputBindings | PageBindings | SearchAndSelectWithPreviewBindings | TimeSliderBindings;

package/component/index.d.ts

@@ -1,9 +1,10 @@
-import { ControlCollectionBindings, PageBindings, RelationshipDetailsBindings, SearchAndSelectWithPreviewBindings, SearchInputBindings, SviComponentBindings, TimeSliderBindings } from "./bindings";
+import { ControlCollectionBindings, PageBindings, PagePreviewBindings, RelationshipDetailsBindings, SearchAndSelectWithPreviewBindings, SearchInputBindings, SviComponentBindings, TimeSliderBindings } from "./bindings";
 export declare enum SviComponent {
     ControlCollection = "svi-control-collection",
     RelationshipDetails = "svi-relationship-details",
     SearchInput = "svi-search-input",
     Page = "svi-page",
+    PagePreview = "svi-page-preview",
     SearchAndSelectWithPreview = "svi-search-and-select-with-preview",
     TimeSlider = "svi-time-slider"
 }
@@ -20,6 +21,7 @@ export interface ComponentCreationResult<T> {
 export interface ComponentApi {
     create(component: SviComponent.ControlCollection, target: HTMLElement, bindings?: ControlCollectionBindings): Promise<ComponentCreationResult<ControlCollectionBindings>>;
     create(component: SviComponent.Page, target: HTMLElement, bindings?: PageBindings): Promise<ComponentCreationResult<PageBindings>>;
+    create(component: SviComponent.PagePreview, target: HTMLElement, bindings?: PagePreviewBindings): Promise<ComponentCreationResult<PagePreviewBindings>>;
     create(component: SviComponent.RelationshipDetails, target: HTMLElement, bindings?: RelationshipDetailsBindings): Promise<ComponentCreationResult<RelationshipDetailsBindings>>;
     create(component: SviComponent.SearchInput, target: HTMLElement, bindings?: SearchInputBindings): Promise<ComponentCreationResult<SearchInputBindings>>;
     create(component: SviComponent.SearchAndSelectWithPreview, target: HTMLElement, bindings?: SearchAndSelectWithPreviewBindings): Promise<ComponentCreationResult<SearchAndSelectWithPreviewBindings>>;

package/component/index.js

@@ -5,6 +5,7 @@ export var SviComponent;
     SviComponent["RelationshipDetails"] = "svi-relationship-details";
     SviComponent["SearchInput"] = "svi-search-input";
     SviComponent["Page"] = "svi-page";
+    SviComponent["PagePreview"] = "svi-page-preview";
     SviComponent["SearchAndSelectWithPreview"] = "svi-search-and-select-with-preview";
     SviComponent["TimeSlider"] = "svi-time-slider";
 })(SviComponent || (SviComponent = {}));

package/config/config-api.d.ts

@@ -11,8 +11,11 @@ export interface Solution {
 }
 export interface SolutionExtension extends ControlMetadata {
     controlAttributes?: SolutionExtensionConfigTypeAttributes;
+    /** refers to controlAttributes.metadata, populated upon registration */
     metadata?: SolutionExtensionMetadata;
+    /** resolved displayName resource string, populated upon registration */
     resolvedDisplayName?: string;
+    /** resolved description resource string, populated upon registration */
     resolvedDescription?: string;
     clientApplication?: string;
     name: string;
@@ -44,8 +47,9 @@ export interface SolutionExtensionMetadata {
     path?: string;
     showInToolbox?: "true" | "false";
     mainDocumentOnly?: boolean;
+    requiredServices?: RequiredResourcesExpression;
 }
-export declare type SviDocumentManager = {
+export type SviDocumentManager = {
     key: string;
     displayName: string;
     onClick: (onFilesAdded: (files: SviLinkedFile[]) => void) => void;
@@ -88,20 +92,36 @@ export interface AppConfigBundle<T> {
     solutionName?: string;
 }
 /**
- * Functionality related to configuration.
+ * A boolean expression to specify required resources by string identifier.
+ */
+export type RequiredResourcesExpression = string | RequiredResourcesAndExpression | RequiredResourcesOrExpression;
+export type RequiredResourcesOrExpression = {
+    or: RequiredResourcesExpression[];
+    and?: never;
+};
+export type RequiredResourcesAndExpression = {
+    and: RequiredResourcesExpression[];
+    or?: never;
+};
+export interface VersionSummary {
+    softwareVersionNumber: string;
+    apiVersionNumber: string;
+}
+/**
+ * Configuration-related functionality.
  * Accessed from the window at window.sas.vi.config.
  */
 export interface ConfigApi {
     /**
      * @method
      * @description Gets the soft expansion limit of the network nodes.
-     * @returns Promise containing the soft expansion limit.
+     * @returns A Promise containing the soft expansion limit.
      */
     getSoftExpansionLimit(): Promise<number>;
     /**
      * @method
      * @description Gets the hard expansion limit of the network nodes.
-     * @returns Promise containing the hard expansion limit.
+     * @returns A Promise containing the hard expansion limit.
      */
     getHardExpansionLimit(): Promise<number>;
     /**
@@ -112,10 +132,10 @@ export interface ConfigApi {
     getSolutions(): Map<string, Solution>;
     /**
      * @method
-     * @description Registers a new solution and version in the SAS Visual Investigator about dialog box.
+     * @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.
      * @param key {string} Unique identifier for the solution.
-     * @param label {string} Localised name of the solution to be shown to the user.
+     * @param label {string} Localized name of the solution to be shown to the user.
      * @param [version] {string} Version of the solution.
      */
     registerSolution(key: string, label: string, version?: string): void;
@@ -141,28 +161,41 @@ export interface ConfigApi {
     registerDocumentManager(config: SviDocumentManager): void;
     /**
      * @method
-     * @description Register a callback to override the default action when selecting the given configuration bundle in the administration application.
-     * @param bundleName the name of the configuration bundle.
-     * @param callback a function which should open a view to
+     * @description Register a callback to override the default action when selecting the configuration bundle in the administration application.
+     * @param bundleName {string} The name of the configuration bundle.
+     * @param callback {function(): void} A function which should open a view to
      * allow the user to modify the given configuration bundle.
      */
     registerOpenConfigurationCallback(bundleName: string, callback: () => void): void;
     /**
-     * GET an app configuration bundle.
-     *
-     * @param appConfigId ID for the the app config that the bundle belongs to.
-     * @param bundleName The name of the configuration bundle.
+     * @method
+     * @description Send a GET request to retrieve an application configuration bundle.
+     * @param appConfigId {string} The identifier for the application configuration that the bundle belongs to.
+     * @param bundleName {string} The name of the configuration bundle.
      */
     getAppConfigBundle<T extends object>(appConfigId: string, bundleName: string): Promise<AppConfigBundle<T>>;
     /**
-     * Send a PUT request to the appConfigurations endpoint with an updated bundle.
-     * @param bundle The updated app configuration bundle.
-     * @returns a promise resolving resolving to the saved configuration bundle.
+     * @method
+     * @description Send a PUT request to save an application configuration bundle.
+     * @param bundle {AppConfigBundle} The updated application configuration bundle.
+     * @returns A Promise resolving to the saved configuration bundle.
      */
     updateAppConfigBundle<T extends object>(bundle: AppConfigBundle<T>): Promise<AppConfigBundle<T>>;
     /**
      * @method
-     * @returns a reference to the HTML element which is the default container for modal dialogs to be spawned within the application.
+     * @returns A reference to the HTML element that is the default container for modal dialog boxes to be spawned within the application.
      */
     getSharedDialogContainer(): HTMLElement;
+    /**
+     * @method
+     * @description Get the services which are an optional part of the SAS Visual Investigator deployment.
+     * @returns A map of service identifiers to their enabled status (true or false).
+     */
+    getEnabledOptionalServices(): Record<string, boolean>;
+    /**
+     * @method
+     * @description Gets the current software version number and API version of the application.
+     * @returns The software version number and the installed version of the API.
+     */
+    getCurrentVersions(): VersionSummary;
 }

package/control/control-api.d.ts

@@ -307,6 +307,12 @@ export interface ControlPageApi extends ControlPageApiBase {
      * @returns True, if the toolbar is disabled. Otherwise false.
      */
     isToolbarDisabled(): boolean;
+    /**
+     * Sets the toolbar control to be disabled.
+     * @param control {Control} The control to be disabled.
+     * @method
+     */
+    setToolbarItemDisabled(actionName: string, setDisabled: boolean): void;
     /**
      * Triggers a certain type of notification for users.
      * For example, a type EDIT_FAIL notification if a sheet has failed to be added to a workspace.
@@ -339,6 +345,11 @@ export interface ControlPageApi extends ControlPageApiBase {
      * @param [controlToRefresh] {Control} Individual control to be refreshed.
      */
     reloadRefreshableControls(categoryToRefresh?: string, controlToRefresh?: Control): void;
+    /**
+     * @method
+     * @returns True if any RefreshableControls have options.requiresIndex present. Otherwise False
+     */
+    hasAnyRefreshableControlRequiresIndex(): boolean;
     /**
      * Sets a page to be dirty, that is, when it has been edited and not saved.
      * @method

package/control/data-types.d.ts

@@ -1,13 +1,14 @@
-export declare type FieldType = "STRING" | "BOOLEAN" | "REFERENCEDATA" | "USER_GROUP" | "JSON" | DateDataType | NumberDataType;
-export declare type NumberDataType = "SMALLINT" | "INTEGER" | "LONG" | "FLOAT" | "DOUBLE" | "NUMERIC";
-export declare type DateDataType = "DATE" | "TIMESTAMP" | "TIMESTAMP_WITH_TIME_ZONE";
+export type FieldType = "STRING" | "BOOLEAN" | "REFERENCEDATA" | "USER_GROUP" | "JSON" | DateDataType | NumberDataType;
+export type NumberDataType = "SMALLINT" | "INTEGER" | "LONG" | "FLOAT" | "DOUBLE" | "NUMERIC";
+export type DateDataType = "DATE" | "TIMESTAMP" | "TIMESTAMP_WITH_TIME_ZONE";
+export declare const isFieldDataTypeDate: (field?: string) => boolean;
 export interface UserGroup {
     id: string;
     type: "user" | "group";
 }
-export declare type FieldTypeToValue<Type extends FieldType> = Type extends "BOOLEAN" ? boolean : Type extends "STRING" | DateDataType | "REFERENCEDATA" ? string : Type extends NumberDataType ? number : Type extends "JSON" ? object : Type extends "USER_GROUP" ? UserGroup[] : never;
-export declare type FieldValue = undefined | string | number | boolean | object | UserGroup | Date | ChildObject[] | null;
-export declare type ChildObject = {
+export type FieldTypeToValue<Type extends FieldType> = Type extends "BOOLEAN" ? boolean : Type extends "STRING" | DateDataType | "REFERENCEDATA" ? string : Type extends NumberDataType ? number : Type extends "JSON" ? object : Type extends "USER_GROUP" ? UserGroup[] : never;
+export type FieldValue = undefined | string | number | boolean | object | UserGroup | Date | ChildObject[] | null;
+export type ChildObject = {
     id?: string;
     isNew?: boolean;
     fieldValues: Record<string, FieldValue>;

package/control/data-types.js

@@ -1 +1 @@
-export {};
+export const isFieldDataTypeDate = (field) => field ? ["DATE", "TIMESTAMP", "TIMESTAMP_WITH_TIME_ZONE"].includes(field) : false;

package/control/events.d.ts

@@ -28,7 +28,7 @@ export interface ControlConfigChange<ControlTypeAttributes extends TypeAttribute
     type: "controlConfig";
     config: TypeAttributesChange<ControlTypeAttributes> | ConfigStateChange;
 }
-export declare type TypeAttributesChange<ControlTypeAttributes extends TypeAttributes, Property extends keyof ControlTypeAttributes = keyof ControlTypeAttributes> = Property extends any ? {
+export type TypeAttributesChange<ControlTypeAttributes extends TypeAttributes, Property extends keyof ControlTypeAttributes = keyof ControlTypeAttributes> = Property extends any ? {
     type: "typeAttributes";
     value: {
         new: ControlTypeAttributes[Property];
@@ -48,7 +48,7 @@ export interface PageModelData {
     [property: string]: any;
 }
 export declare enum ChangeType {
-    PAGE_MODE = "mode",
+    PAGE_MODE = "mode",// aligned with Mobile API
     PAGE_DATA = "pageData"
 }
 export interface PageDataChange {

package/control/restrictions.d.ts

@@ -26,7 +26,7 @@ export interface ReferenceDataRestrictions extends FieldRestrictions {
     cascadingReferenceDataFilterByCode?: string;
     cascadingReferenceDataFilterByField?: string;
 }
-export declare type UserGroupStrategy = "USERS" | "GROUPS" | "USERS_AND_GROUPS";
+export type UserGroupStrategy = "USERS" | "GROUPS" | "USERS_AND_GROUPS";
 export interface UserGroupRestrictions extends FieldRestrictions {
     allowMultipleSelections: boolean;
     userSelectionStrategy: UserGroupStrategy;
@@ -34,4 +34,4 @@ export interface UserGroupRestrictions extends FieldRestrictions {
 export interface FileRestrictions extends RequirableRestriction {
     allowMultipleFiles: boolean;
 }
-export declare type FieldTypeToRestrictions<Type extends FieldType> = Type extends "STRING" ? StringRestrictions : Type extends "NUMERIC" ? NumericRestrictions : Type extends "REFERENCEDATA" ? ReferenceDataRestrictions : Type extends "USER_GROUP" ? UserGroupRestrictions : FieldRestrictions;
+export type FieldTypeToRestrictions<Type extends FieldType> = Type extends "STRING" ? StringRestrictions : Type extends "NUMERIC" ? NumericRestrictions : Type extends "REFERENCEDATA" ? ReferenceDataRestrictions : Type extends "USER_GROUP" ? UserGroupRestrictions : FieldRestrictions;

package/event/event-api.d.ts

@@ -20,6 +20,9 @@ export declare enum PageEvents {
     MaskToggleEvent = "spb::mask-toggle",
     MaskAllEvent = "spb::mask-all"
 }
+export declare enum DocumentGeneratorEvents {
+    AfterDocumentGenerated = "docgen::after-document-generated"
+}
 export interface Subscription {
     unsubscribe(): void;
 }

package/event/event-api.js

@@ -21,6 +21,10 @@ export var PageEvents;
     PageEvents["MaskToggleEvent"] = "spb::mask-toggle";
     PageEvents["MaskAllEvent"] = "spb::mask-all";
 })(PageEvents || (PageEvents = {}));
+export var DocumentGeneratorEvents;
+(function (DocumentGeneratorEvents) {
+    DocumentGeneratorEvents["AfterDocumentGenerated"] = "docgen::after-document-generated";
+})(DocumentGeneratorEvents || (DocumentGeneratorEvents = {}));
 /**
  * Callback function executed when subscription is triggered by an event.
  * @callback EventApi~subscriptionCallback

package/index.d.ts

@@ -21,6 +21,7 @@ import { TabApi } from "./tab/tab-api";
 import { ThemeApi } from "./theme/theme-api";
 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";
 /**
  * Common API Functions.
@@ -36,6 +37,7 @@ export interface SviCommonApi {
     pageAdmin: PageAdminApi;
     pageModel: PageModelApi;
     pageState: PageStateApi;
+    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. */
@@ -61,8 +63,8 @@ export interface SviClientApi extends SviCommonApi {
 export interface SviAdminApi extends SviCommonApi {
     metadata: AdminMetadataApi;
 }
-export declare type SviApi = SviClientApi | SviAdminApi;
-export declare type SviWindow = typeof window & {
+export type SviApi = SviClientApi | SviAdminApi;
+export type SviWindow = typeof window & {
     sas: {
         vi: SviApi;
         viInit: InitApi;

package/localization/localization-api.d.ts

@@ -24,54 +24,68 @@ export interface LocalizationApi {
      */
     getDirection(): "ltr" | "rtl";
     /**
-     * Methods related to Solution content localization.
+     * Methods related to solution content localization.
      */
     solution: SolutionLocalizationApi;
 }
+/**
+ * This API is used for solution content localization.
+ * Accessed from the window at window.sas.vi.localization.solution.
+ */
 export interface SolutionLocalizationApi {
     /**
-     * if {@link isEnabled}, returns the {@link SolutionLocalizationBundle} used to lookup translations.
+     * @method
+     * @returns The {@link SolutionLocalizationBundle} used to lookup translations if solution localization is enabled, else undefined.
      */
     getLocalizationBundle(): SolutionLocalizationBundle | undefined;
     /**
-     * returns true if solution localization is enabled.
-     * methods will return unmodified inputs if not enabled.
-     * note that solution localization is disabled in the administration application.
+     * @method
+     * @description
+     * Check that solution localization is enabled.
+     * Localization methods will return unmodified inputs if isEnabled returns false.
+     * Solution localization is not available in the administration application.
+     * @returns True if solution localization is enabled, else false.
      */
     isEnabled(): boolean;
     /**
-     * returns the localized value for the given resource key, else, undefined.
-     * @param resourceKey
+     * @method
+     * @returns The localized value for the given resource key, else undefined.
+     * @param resourceKey {string} A resource key used to lookup the localized value.
+     * @example
+     * getLocalizedResource("colours.red.txt") === "rouge"
      */
     getLocalizedResource(resourceKey: string): string | undefined;
     /**
-     * localize a string using a resourceKey.
-     * fallback to lookup by value if the resourceKey is not supplied/found.
-     * mappings are defined by the contents of {@link getLocalizationBundle}
-     * @param str string to localize
-     * @param resourceKey a resource key used to lookup the localized value
-     * @returns the localized string
+     * @method
+     * @description
+     * Localize a string using a resourceKey.
+     * Fallback to lookup by value if the resourceKey is not found or not supplied.
+     * @param str {string} The string to localize.
+     * @param resourceKey {string} A resource key used to lookup the localized value.
+     * @returns The localized string.
      * @example
      * localize("red", "colours.red.txt") === "rouge"
      */
     localize(str: string, resourceKey?: string): string;
     /**
-     * localize string properties of an object
-     * properties are provided as a map of <propertyKey, resourceKey>, deep property keys are accepted.
-     * {@link localize} is applied to each property with its given resourceKey.
-     * @param obj source object to localize
-     * @param props properties to localize and their resource keys
-     * @returns the localized object
+     * @method
+     * @description
+     * Localize string properties of an object.
+     * Properties are provided as a map of property keys to resource keys, deep property keys are accepted.
+     * @param obj {T} The source object to localize.
+     * @param props {Record<string, string | undefined>} The properties to localize and their resource keys.
+     * @returns The localized object.
      * @example
      * localizeObject({ label: "red" }, { "label": "colours.red.txt" }) === { label: "rouge" }
      */
     localizeObject<T extends object>(obj: T, props: Record<string, string | undefined>): T;
     /**
-     * localize a list of objects.
-     * {@link localizeObject} is applied to each element in the list.
-     * @param list objects to translate
-     * @param getProps callback to return a map of properties and resource keys for the given list element
-     * @returns the localized list
+     * @method
+     * @description
+     * Localize a list of objects.
+     * @param list {T[]} The objects to translate.
+     * @param getProps {function(T): Record<string, string | undefined>} A callback to return a map of properties and resource keys for the given list element.
+     * @returns The localized list.
      * @example
      *  localizeList(
      *      [{ id: "red", label: "Red" }, { id: "blue", label: "Blue"} ],

package/metadata/metadata-api.d.ts

@@ -137,7 +137,7 @@ export interface ReferenceDataItem {
     displayText: string;
     value: string | null;
 }
-export declare type Picklist = ReferenceDataItem[];
+export type Picklist = ReferenceDataItem[];
 export interface RelationshipWithLabel extends RelationshipDTO {
     relationshipLabel?: string;
 }
@@ -159,7 +159,7 @@ export interface MetadataApi {
     getEntityAccessRules(objectType: string): EntityAccessRules;
     /**
      * @method
-     * @description Gets create, read, and update access rights for the provided entities via Batch call.
+     * @description Gets create, read, and update access rights for the provided entities via batch call.
      * @param objectType {string[]} Entity name(s).
      * @returns Object with a Promise of type EntityAccessRule[] for each rule, where EntityAccessRule maps to the access rule of a given entity name.
      */

package/object/object-api.d.ts

@@ -216,6 +216,14 @@ export interface ObjectApi {
      * @return An observable that resolves to an array of validation results.
      */
     validate(model: PageModel, childObject: StoredObjectMetadata): Promise<ValidationResult[]>;
+    /**
+     * @method
+     * @description Launches a wizard allowing users to create an object/relationship.
+     * The relationship wizard is determined by the relateToParentLabel or relateToParentName defined in the wizardValues parameter.
+     * @param wizardValues {CreateDialogModel} Object containing entity and relationship data.
+     * @returns A Promise which resolves when the dialog box is closed.
+     */
+    openCreateAndLinkDialog(wizardValues: CreateDialogModel): Promise<CreateDialogModel>;
 }
 export interface PageData {
     fieldValues: FieldValues;
@@ -247,8 +255,8 @@ export interface VIObject {
     id: string;
     title?: string;
 }
-export declare type LinkObject = Pick<VIObject, "id" | "objectTypeName">;
-export declare type NewLinkObject = Pick<VIObject, "objectTypeName" | "fieldValues" | "fileOperations">;
+export type LinkObject = Pick<VIObject, "id" | "objectTypeName">;
+export type NewLinkObject = Pick<VIObject, "objectTypeName" | "fieldValues" | "fileOperations">;
 export interface ValidationResult {
     isValid: boolean;
     message?: string;
@@ -260,7 +268,7 @@ export interface PageAction {
         attributes: {
             [property: string]: any;
             displayName: string;
-            disabled: string;
+            disabled: boolean;
         };
         controlId?: number;
         displayName: string;
@@ -520,4 +528,31 @@ export interface DisplayTextFields {
     name: string;
     displayIndex: number;
 }
+export interface SearchOrCreateAndLinkDialogBase<T> {
+    entityName: string;
+    entityLabel: 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;
+}
+export interface CreateRelationshipDialogModel<T> extends SearchOrCreateAndLinkDialogBase<T> {
+    relateToParentName: string;
+    relateToParentLabel: string;
+    linkReasons?: Relationship[];
+}
+export interface CreateDialogModel extends CreateRelationshipDialogModel<CreateDialogResponse> {
+}
+export interface CreateDialogResponse {
+    relateToModel?: CreateRelateToModel;
+}
+export interface CreateReleationshipDialogResultModel {
+    linkReason?: Relationship;
+}
+export interface CreateRelateToModel extends CreateReleationshipDialogResultModel {
+    newPageModel?: {
+        model: PageModel;
+    };
+}
 export {};

package/package.json

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

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

@@ -3,6 +3,7 @@ import { Control } from "../control/page";
 import { FileOperation, SASObjectAttachedFile } from "../file/file-api";
 import { ObjectFieldRestrictions } from "../object/object-api";
 import { PathsRepresentation } from "../svi-sand";
+import { TemplateFileCategoryAssociationDTO } from "../svi-datahub";
 export declare enum PageMode {
     Create = "create",
     Edit = "edit",
@@ -25,7 +26,7 @@ export interface PageAction {
         attributes: {
             [property: string]: any;
             displayName?: string;
-            disabled?: string;
+            disabled?: boolean;
         };
         controlId?: number;
         displayName: string;
@@ -87,9 +88,13 @@ export interface PageTemplate {
 }
 export interface PageTemplateMetadata {
     dataSources: PageTemplateMetadataDataSource[];
+    fileCategories?: TemplateFileCategoryAssociationDTO[];
     insightsCreationEnabled: boolean;
     insightsEnabled: boolean;
-    linkedTemplates: any[];
+    linkedTemplates: Array<{
+        templateUuid: string;
+        traversalUuid: string;
+    }>;
     resources: {
         [property: string]: string;
     };
@@ -123,8 +128,8 @@ export interface IPageEventHook<T extends IPageEventData, R extends IPageEventHo
      */
     order?: number;
 }
-export declare type IPrePageEventHook<T extends IPageEventData> = Omit<IPageEventHook<T, IPrePageEventHookResponse>, "onFail">;
-export declare type IPostPageEventHook<T extends IPageEventData> = IPageEventHook<T, IPostPageEventHookResponse>;
+export type IPrePageEventHook<T extends IPageEventData> = Omit<IPageEventHook<T, IPrePageEventHookResponse>, "onFail">;
+export type IPostPageEventHook<T extends IPageEventData> = IPageEventHook<T, IPostPageEventHookResponse>;
 export interface IPageEventHookResponse {
     message: string;
     messages?: string[];
@@ -132,12 +137,12 @@ export interface IPageEventHookResponse {
 export interface IPrePageEventHookResponse extends IPageEventHookResponse {
     abort: boolean;
 }
-export declare type IPostPageEventHookResponse = IPageEventHookResponse;
+export type IPostPageEventHookResponse = IPageEventHookResponse;
 /**
  * A callback to unregister a page event hook.
  * @returns true if the hook was removed, false if it was already removed.
  */
-export declare type PageEventHookRemove = () => boolean;
+export type PageEventHookRemove = () => boolean;
 export interface IPageEventData {
     pageModel: PageModel;
 }

package/page-template/package.json

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