@sassoftware/vi-api 1.15.2 → 1.40.1

package/score-reps/index.d.ts

@@ -0,0 +1,133 @@
+/* tslint:disable */
+/* eslint-disable */
+// Generated using typescript-generator version 2.15.527 on 2024-03-12 16:17:17.
+
+export interface BaseRep extends TrackedResource {
+    links?: Link[];
+}
+
+export interface BatchJobRep extends BaseRep {
+    batchId?: string;
+    scorecardDefinitionId?: string;
+    batchStatus?: string;
+    dropZoneType?: string;
+    casLibraryName?: string;
+    inputScoreTableName?: string;
+    inputElementTableName?: string;
+    dropZoneTimeToLive?: number;
+    deleteCasTablesAfterCompletionFlag?: boolean;
+    expirationTimeStamp?: string;
+}
+
+export interface ElementRep extends BaseRep {
+    version?: number;
+    elementId?: string;
+    scoreId?: string;
+    batchId?: string;
+    elementEntityType?: string;
+    elementEntityId?: string;
+    elementEntityLabel?: string;
+    elementNativeId?: string;
+    elementNativeName?: string;
+    elementDescription?: string;
+    displayFlag?: boolean;
+    displayOrder?: number;
+    displayTypeCode?: DisplayType;
+    messageTemplateText?: string;
+    messageValuesJson?: { [index: string]: any };
+    score?: number;
+    minimumScore?: number;
+    maximumScore?: number;
+    meanScore?: number;
+    displayFormat?: string;
+    valueType?: ValueType;
+    valueText?: string;
+    valueBoolean?: boolean;
+    valueNumeric?: number;
+    valueTimeStamp?: string;
+}
+
+export interface EntityElementsRep {
+    entityType?: string;
+    entityId?: string;
+    entityLabel?: string;
+    elements?: ElementRep[];
+    version?: number;
+}
+
+export interface ScorecardDefinitionRep extends BaseRep {
+    currentTableName?: string;
+    domainId?: string;
+    elementTableName?: string;
+    entityType?: string;
+    historyTableName?: string;
+    inputElementTableName?: string;
+    inputScoreTableName?: string;
+    origin?: string;
+    scorecardDefinitionDescription?: string;
+    scorecardDefinitionId?: string;
+    scorecardDefinitionName?: string;
+    solutionId?: string;
+}
+
+export interface ScorecardFullRep extends ScorecardSummaryRep {
+    entities?: EntityElementsRep[];
+}
+
+export interface ScorecardSummaryRep extends BaseRep {
+    version?: number;
+    scoreId?: string;
+    batchId?: string;
+    actionableEntityType?: string;
+    actionableEntityId?: string;
+    actionableEntityLabel?: string;
+    score?: number;
+    scoreDescription?: string;
+    effectiveTimeStamp?: string;
+}
+
+export interface Link extends Serializable {
+    method?: string;
+    rel?: string;
+    href?: string;
+    uri?: string;
+    type?: string;
+    responseType?: string;
+    itemType?: string;
+    responseItemType?: string;
+    title?: string;
+}
+
+export interface TrackedResource extends Serializable, ETaggable, TimeTrackedResource, ETagAndLastModifiedProvider {
+    createdBy?: string;
+    modifiedBy?: string;
+}
+
+export interface Serializable {
+}
+
+export interface ETaggable extends Preconditionable {
+    etag?: string;
+}
+
+export interface TimeTrackedResource extends LastModifiedProviderFromModifiedTimeStamp {
+    creationTimeStamp?: string;
+}
+
+export interface ETagAndLastModifiedProvider extends ETaggable, LastModifiedProvider {
+}
+
+export interface Preconditionable {
+}
+
+export interface LastModifiedProviderFromModifiedTimeStamp extends LastModifiedProvider {
+    modifiedTimeStamp?: string;
+}
+
+export interface LastModifiedProvider extends Preconditionable {
+    lastModifiedHeaderDate?: string;
+}
+
+export type DisplayType = 'TEXT' | 'VARIABLE' | 'UNKNOWN';
+
+export type ValueType = 'TEXT' | 'NUMERIC' | 'TIMESTAMP' | 'BOOLEAN' | 'UNKNOWN';

package/score-reps/package.json

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

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

@@ -1,6 +1,5 @@
-import { Relationship } from "../../svi-datahub";
 import { MapBoundedBoxFilter, MapBoundedPolygonFilter, MapRadiusFilter, MapShapeFilter, QueryMode, SearchRepresentation, SearchResponse, SummaryVisualizationResponse } from "../../svi-sand";
-import { ObjectIdentifier } from "../../object/object-api";
+import { CreateRelationshipDialogModel, CreateReleationshipDialogResultModel, ObjectIdentifier, SearchOrCreateAndLinkDialogBase } from "../../object/object-api";
 import { QueryBuilderModel, SearchApi } from "../search-api";
 export declare enum SearchVisualization {
     Summary = "summary",
@@ -14,7 +13,7 @@ export declare enum Visualization {
     Timeline = "timeline",
     Network = "networkDiagram"
 }
-export declare type MapFilter = MapBoundedPolygonFilter | MapRadiusFilter | MapBoundedBoxFilter | MapShapeFilter;
+export type MapFilter = MapBoundedPolygonFilter | MapRadiusFilter | MapBoundedBoxFilter | MapShapeFilter;
 export interface SearchQuery {
     additionalModes?: string[];
     queryText: string;
@@ -41,30 +40,24 @@ export interface NetworkData {
     };
     numNodes: number;
 }
-export interface SearchAndCreateDialogModel {
-    entityName: string;
-    entityLabel: string;
-    relateToParentName?: string;
-    relateToParentLabel?: string;
+export interface SearchAndCreateDialogModel extends CreateRelationshipDialogModel<SearchAndCreateResponse> {
+}
+export interface SearchDialogModel extends SearchOrCreateAndLinkDialogBase<SearchDialogResponse> {
     canCreate?: boolean;
-    linkReasons?: Relationship[];
-    /**
-     * Values returned on the close of the dialog box. May be undefined when dialog box is cancelled.
-     */
-    result?: SearchAndCreateResponse;
+}
+export interface SearchDialogResponse {
+    selectedItem?: SearchObject;
 }
 export interface SearchObject extends ObjectIdentifier {
     title?: string;
     typeLabel?: string;
     uniqueKey?: string;
 }
-export interface SearchAndCreateRelateToModel {
-    linkReason?: Relationship;
+export interface SearchAndCreateRelateToModel extends CreateReleationshipDialogResultModel {
     relateToTargetId?: string;
     relateToTargetType?: string;
 }
 export interface SearchAndCreateResponse {
-    selectedItem?: SearchObject;
     relateToModel?: SearchAndCreateRelateToModel;
 }
 /**
@@ -155,6 +148,14 @@ export interface ClientSearchApi extends SearchApi {
      * @returns A Promise which 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.
+     * 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.
+     */
+    openSearchAndCreateDialog(wizardValues: SearchDialogModel): Promise<SearchDialogModel>;
     /**
      * @method
      * @description Gets the selected items within the search result or specified workspace.

package/sheet/sheet-api.d.ts

@@ -213,4 +213,4 @@ export declare enum NetworkMenuType {
 /**
  * The type of function that can be registered as a callback for modifying the Network menus.
  */
-export declare type NetworkMenuCallback = (menu: ContextMenuItem, workspaceClientId: string) => void;
+export type NetworkMenuCallback = (menu: ContextMenuItem, workspaceClientId: string) => void;

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

@@ -1,5 +1,6 @@
 import { Observable } from "rxjs";
 import { INavigationBarTabSaveOptions } from "./shell-tabs-lifecycle-api";
+import { RequiredResourcesExpression } from "../config/config-api";
 export interface WebElementData {
     elementName: string;
     doNotReuse?: boolean;
@@ -52,10 +53,27 @@ export interface INavigationBarTab<D = {
     /** any extra data to be associated with the tab */
     data?: D;
 }
-export declare type ISecondaryNavigationBarTab<D = {
+export type ISecondaryNavigationBarTab<D = {
     [key: string]: any;
 }> = Omit<INavigationBarTab<D>, "secondaryTabs" | "selectedSecondaryTab">;
-export interface ExternalTabConfig<T = any, P = any> {
+export interface SviShellTabData {
+    /**
+     * 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.
+     * @example
+     * { and: ["svi-alert", "documentGeneratorAdapter"] }
+     */
+    requiredServices?: RequiredResourcesExpression;
+    [key: string]: any;
+}
+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
      */
@@ -95,11 +113,16 @@ export interface ExternalTabConfig<T = any, P = any> {
      */
     buildOnRegister?: boolean;
 }
-export declare type ShellTabsApi = {
-    /**
-     * this is used to expose any {@link PotentialTabItem} hooks on a component up to the Tab Service
-     * @param context pass "this"
-     * @param elRef pass the ElementRef for the component
+/**
+ * This API provides functionality that pertains to the shell tabs.
+ * Accessed from the window at window.sas.vi.shellTabs.
+ */
+export interface ShellTabsApi<T = SviShellTabData> {
+    /**
+     * @method
+     * @description this is used to expose any {@link PotentialTabItem} hooks on a component up to the Tab Service
+     * @param [context] {this} pass "this"
+     * @param [elRef] {HTMLElement} 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
@@ -110,90 +133,107 @@ export declare type ShellTabsApi = {
      */
     createTabApiForElement: (context: any, nativeElement: HTMLElement) => void;
     /**
-     * Use this function to register new routes for tabs
-     * @param tabsToAdd - see {@link ExternalTabConfig}
+     * @method
+     * @description Use this function to register new routes for tabs
+     * @param [tabsToAdd] {ExternalTabConfig[]} - see {@link ExternalTabConfig}
      */
-    registerExternalTabs: (tab: ExternalTabConfig[]) => void;
+    registerExternalTabs: (tab: Array<ExternalTabConfig<T>>) => void;
     /**
-     * Use this function to remove routes added via registerTabFn
-     * @param tabsToAdd - see {@link ExternalTabConfig}
+     * @method
+     * @description Use this function to remove routes added via registerTabFn
+     * @param [tabsToRemove] {ExternalTabConfig[]} - see {@link ExternalTabConfig}
      */
-    unregisterExternalTabs: (tabsToRemove: ExternalTabConfig[]) => void;
+    unregisterExternalTabs: (tabsToRemove: Array<ExternalTabConfig<T>>) => void;
     /**
-     * this will return the current primary and secondary tabs
+     * @method
+     * @description this will return the current primary and secondary tabs
      */
     getSelectedTab: () => {
         primaryTab: INavigationBarTab;
         secondaryTab?: INavigationBarTab;
     };
     /**
-     * this stream will track the current top level tab
+     * @method
+     * @description this stream will track the current top level tab
      */
     selectedPrimaryTabChanged$: Observable<INavigationBarTab>;
     /**
-     * this stream will track the current second level tab
+     * @method
+     * @description this stream will track the current second level tab
      */
     selectedSecondaryTabChanged$: Observable<INavigationBarTab | undefined>;
     /**
-     * this stream will update after any additions/removals to either system or application tabs
+     * @method
+     * @description this stream will update after any additions/removals to either system or application tabs
      */
     openTabsChanged$: Observable<{
         systemTabs: INavigationBarTab[];
         applicationTabs: INavigationBarTab[];
     }>;
     /**
-     * this stream will emit any removed tabs
+     * @method
+     * @description this stream will emit any removed tabs
      */
     tabRemoved$: Observable<INavigationBarTab>;
     /**
-     * @param tabId will be ID of an existing tab
+     * @method
+     * @description get Tab by ID
+     * @param [tabId] {string} will be ID of an existing tab
      */
     getTabById: (tabId: string) => INavigationBarTab | undefined;
     /**
-     * will return a slice of the current system and application tabs
+     * @method
+     * @description will return a slice of the current system and application tabs
      */
     getAllTabs: () => {
         system: INavigationBarTab[];
         application: INavigationBarTab[];
     };
     /**
-     * will move user to the default tab
+     * @method
+     * @description will move user to the default tab
      */
     selectDefaultTab: () => Promise<boolean>;
     /**
-     * will attempt to open+select a matching INavigationBarTab and optional secondaryTab, returning false on failure
+     * @method
+     * @description will attempt to open+select a matching INavigationBarTab and optional secondaryTab, returning false on failure
      * in the event the tab doesn't exist already, it will add the tab assuming an appropriate route has been registered for it
-     * @param tabToSelect {@link INavigationBarTab}
-     * @param secondaryTab {@link INavigationBarTab} if left undefined, this will select the previously
+     * @param [tabToSelect] {INavigationBarTab} see {@link INavigationBarTab}
+     * @param [secondaryTab] {INavigationBarTab} see {@link INavigationBarTab} if left undefined, this will select the previously
      * selected secondary tab of the primary tab or it's first index secondary tab
      */
     openTab: (tabToSelect: INavigationBarTab, secondaryTab?: INavigationBarTab) => Promise<boolean>;
     /**
-     * will attempt to select a tab by its id, returning false on failure
-     * @param tabId will be ID of an existing tab
+     * @method
+     * @description will attempt to select a tab by its id, returning false on failure
+     * @param [tabId] {string} will be ID of an existing tab
      */
     selectTabById: (tabId: string) => Promise<boolean>;
     /**
-     * will remove an application tab, if allowed, and will trigger any closing and saving logic beforehand
-     * @param tabIdToRemove will be ID of an existing tab
-     * @param suppressNavigation if you are closing a tab that isn't open, you want to supressNavigation=true
+     * @method
+     * @description will remove an application tab, if allowed, and will trigger any closing and saving logic beforehand
+     * @param [tabIdToRemove] {string} will be ID of an existing tab
+     * @param [suppressNavigation] {boolean} if you are closing a tab that isn't open, you want to supressNavigation=true
      */
     removeApplicationTabById: (tabIdToRemove: string, suppressNavigation?: boolean) => Promise<boolean>;
     /**
-     * will remove an existing application tab then replace with another, if {@link removeApplicationTabById} is unsuccessful this will fail
+     * @method
+     * @description 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 will be ID of an existing tab
-     * @param newTab {@link INavigationBarTab}
+     * @param [tabId] {string} will be ID of an existing tab
+     * @param [newTab] {INavigationBarTab} see {@link INavigationBarTab}
      *
      */
     replaceApplicationTab: (tabId: string, newTab: INavigationBarTab) => Promise<boolean>;
     /**
-     * will run {@link removeApplicationTabById} on all tabs, will stop if any fail to close, will wait for each close to complete
+     * @method
+     * @description will run {@link removeApplicationTabById} on all tabs, will stop if any fail to close, will wait for each close to complete
      */
     removeAllApplicationTabs: () => Promise<boolean>;
     /**
-     * will run same as {@link removeAllApplicationTabs}, but not on the provided tabIdToKeep
-     * @param tabIdToKeep
+     * @method
+     * @description will run same as {@link removeAllApplicationTabs}, but not on the provided tabIdToKeep
+     * @param [tabIdToKeep] {string}
      */
     removeOtherApplicationTabs: (tabIdToKeep?: string) => Promise<boolean>;
-};
+}

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

@@ -1,7 +1,7 @@
 import { OnDestroy } from "@angular/core";
 import { INavigationBarTab, INavigationBarTabs } from "./shell-tabs-api";
 import { Observable } from "rxjs";
-export declare type PotentialTabItem<T = any, U = any> = Partial<OnAttachTab<T> & OnTabEnter & OnTabLeave & OnTabSaveConfirm & OnTabClose & TabWithToolbar<U> & OnDestroy>;
+export type PotentialTabItem<T = any, U = any> = Partial<OnAttachTab<T> & OnTabEnter & OnTabLeave & OnTabSaveConfirm & OnTabClose & TabWithToolbar<U> & OnDestroy>;
 export interface OnAttachTab<T = any> {
     currentNavigationBarTab?: INavigationBarTab<T>;
     /**
@@ -17,7 +17,7 @@ export interface OnTabEnterParams {
     toSecondary?: INavigationBarTab;
     recycled: boolean;
 }
-export declare type OnTabLeaveParams = Omit<OnTabEnterParams, "recycled">;
+export type OnTabLeaveParams = Omit<OnTabEnterParams, "recycled">;
 export interface OnTabEnter {
     /**
      * Function to run when the Tab is entered, this happens on first load as well
@@ -61,9 +61,9 @@ export interface INavigationBarTabSaveOptions {
     dialogMessage: string;
     saveFunction(): Promise<boolean> | Observable<boolean> | boolean;
 }
-export declare type WebElementTabApi<NavBarDataType = any, ComponentType = any> = Omit<PotentialTabItem<NavBarDataType, ComponentType>, "onAttachTab" | keyof TabWithToolbar<ComponentType>> & {
+export type WebElementTabApi<NavBarDataType = any, ComponentType = any> = Omit<PotentialTabItem<NavBarDataType, ComponentType>, "onAttachTab" | keyof TabWithToolbar<ComponentType>> & {
     onAttachTab?(tab: INavigationBarTab<NavBarDataType>): void;
 };
-export declare type WebTabApiElement = HTMLElement & {
+export type WebTabApiElement = HTMLElement & {
     tabApi?: WebElementTabApi;
 };