@sassoftware/vi-api 1.7.1 → 1.15.2

package/api.module.js

@@ -1,72 +1,60 @@
-var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
-    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
-    return c > 3 && r && Object.defineProperty(target, key, r), r;
-};
-import { NgModule } from "@angular/core";
-import { ComponentApiService } from "./component/component-api.service";
-import { ConfigApiService } from "./config/config-api.service";
-import { CurrentUserApiService } from "./current-user/currentUser-api.service";
-import { EventApiService } from "./event/event-api.service";
-import { FileApiService } from "./file/file-api.service";
-import { HttpApiService } from "./http/http-api.service";
-import { LocalizationApiService } from "./localization/localization-api.service";
-import { AdminMetadataApiService } from "./metadata/admin/admin-metadata-api.service";
-import { MetadataApiService } from "./metadata/metadata-api.service";
-import { ObjectApiService } from "./object/object-api.service";
-import { PageAdminApiService } from "./page-admin/page-admin-api.service";
-import { PageModelApiService } from "./page-model/page-model-api.service";
-import { PageStateApiService } from "./page-state/page-state-api.service";
-import { PropertyApiService } from "./property/property-api.service";
-import { RefDataApiService } from "./reference-data/refData.service";
-import { ResourceApiService } from "./resource/resource-api.service";
-import { ClientSearchApiService } from "./search/client/client-search-api.service";
-import { SearchApiService } from "./search/search-api.service";
-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 { LifeCycleEvent } from "../application-life-cycle.service";
-import { filter, take } from "rxjs/operators";
-let ApiModule = class ApiModule {
-    constructor(appBootstrapService, apiInitService) {
-        this.appBootstrapService = appBootstrapService;
-        this.apiInitService = apiInitService;
-        this.appBootstrapService
-            .getCurrentLifeCycleStage()
-            .pipe(filter(lifeCycleEvent => lifeCycleEvent === LifeCycleEvent.InitComplete), take(1))
-            .subscribe(() => {
-            this.apiInitService.createSviApi();
-        });
-    }
-};
-ApiModule = __decorate([
-    NgModule({
-        providers: [
-            AdminMetadataApiService,
-            ClientSearchApiService,
-            ComponentApiService,
-            ConfigApiService,
-            CurrentUserApiService,
-            EventApiService,
-            FileApiService,
-            HttpApiService,
-            LocalizationApiService,
-            MetadataApiService,
-            ObjectApiService,
-            PageAdminApiService,
-            PageModelApiService,
-            PageStateApiService,
-            PropertyApiService,
-            RefDataApiService,
-            ResourceApiService,
-            SheetApiService,
-            SearchApiService,
-            TabApiService,
-            ThemeApiService,
-            TraversalApiService
-        ]
-    })
-], ApiModule);
-export { ApiModule };
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+import { NgModule } from "@angular/core";
+import { ComponentApiService } from "./component/component-api.service";
+import { ConfigApiService } from "./config/config-api.service";
+import { CurrentUserApiService } from "./current-user/currentUser-api.service";
+import { EventApiService } from "./event/event-api.service";
+import { FileApiService } from "./file/file-api.service";
+import { HttpApiService } from "./http/http-api.service";
+import { LocalizationApiService } from "./localization/localization-api.service";
+import { AdminMetadataApiService } from "./metadata/admin/admin-metadata-api.service";
+import { MetadataApiService } from "./metadata/metadata-api.service";
+import { ObjectApiService } from "./object/object-api.service";
+import { PageAdminApiService } from "./page-admin/page-admin-api.service";
+import { PageModelApiService } from "./page-model/page-model-api.service";
+import { PageStateApiService } from "./page-state/page-state-api.service";
+import { PropertyApiService } from "./property/property-api.service";
+import { RefDataApiService } from "./reference-data/refData.service";
+import { ResourceApiService } from "./resource/resource-api.service";
+import { ClientSearchApiService } from "./search/client/client-search-api.service";
+import { SearchApiService } from "./search/search-api.service";
+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";
+let ApiModule = class ApiModule {
+};
+ApiModule = __decorate([
+    NgModule({
+        providers: [
+            AdminMetadataApiService,
+            ClientSearchApiService,
+            ComponentApiService,
+            ConfigApiService,
+            CurrentUserApiService,
+            EventApiService,
+            FileApiService,
+            HttpApiService,
+            LocalizationApiService,
+            MetadataApiService,
+            ObjectApiService,
+            PageAdminApiService,
+            PageModelApiService,
+            PageStateApiService,
+            PropertyApiService,
+            RefDataApiService,
+            ResourceApiService,
+            SheetApiService,
+            SearchApiService,
+            TabApiService,
+            ThemeApiService,
+            TraversalApiService
+        ]
+    })
+], ApiModule);
+export { ApiModule };

package/component/bindings.d.ts

@@ -68,6 +68,50 @@ export interface SearchInputInputBindings {
     showQueryBuilder?: boolean;
     queryText?: string;
     autoFocus?: boolean;
+    queryBuilderOkButtonLabel?: string;
+    queryModel?: QueryBuilderModel;
+    performSearch?: boolean;
+}
+export interface QueryBuilderModel {
+    manualQueryString?: string;
+    model: QueryBuilderEntityModel[];
+}
+export interface QueryBuilderEntityModel {
+    entity: string;
+    queries: QueryBuilderItem[];
+    singleChildSearch?: boolean;
+}
+export interface QueryBuilderItem {
+    booleanValue?: boolean | string;
+    boost?: number;
+    dateTimeValue?: string | Date;
+    dateValue?: string | Date;
+    exclude?: boolean;
+    field?: string;
+    fromDateTimeValue?: string | Date;
+    fromDateValue?: string | Date;
+    fromNumericValue?: number;
+    numericValue?: number;
+    operator?: string;
+    phonetic?: boolean;
+    previousField?: string;
+    proximity?: number;
+    rangeValidationError?: boolean;
+    referenceValue?: string;
+    relationshipField?: boolean;
+    relationshipTypeValue?: string;
+    relativeDateDatetimeNumericValue?: number;
+    relativeDateDatetimeUnitsValue?: string;
+    stringValidationError?: boolean;
+    synonym?: boolean;
+    textValue?: string;
+    toDateTimeValue?: string | Date;
+    toDateValue?: string | Date;
+    toNumericValue?: number;
+    userGroupValue?: Array<{
+        id: string;
+        type: string;
+    }>;
 }
 export interface SearchInputBindings extends SearchInputInputBindings {
     onSearch?: (model: SearchQuery) => void;

package/config/config-api.d.ts

@@ -14,6 +14,7 @@ export interface SolutionExtension extends ControlMetadata {
     metadata?: SolutionExtensionMetadata;
     resolvedDisplayName?: string;
     resolvedDescription?: string;
+    clientApplication?: string;
     name: string;
 }
 export interface SolutionExtensionConfigTypeAttributes {
@@ -56,6 +57,36 @@ export interface SviLinkedFile {
     content?: string;
     size: number;
 }
+export interface AppConfigBundle<T> {
+    /** unique bundle name */
+    name: string;
+    /** display name I18n resource key */
+    descriptiveName: string;
+    /** description I18n resource key */
+    description: string;
+    /** ID of the the app config that the bundle belongs to */
+    appConfigurationId: string;
+    /** configuration data */
+    configuration: T;
+    /** I18n resources to export localizable properties of the configuration data */
+    resources?: {
+        [key: string]: string;
+    };
+    /** configuration category e.g. category-desktop */
+    categoryId: string;
+    /** Visual Investigator version */
+    viVersion: string;
+    /** HTTP ETag header value based on the last modified timestamp */
+    eTag: string;
+    /** media type schema version */
+    version: number;
+    /** creation UTC timestamp string */
+    creationTimeStamp?: string;
+    /** last modified UTC timestamp string */
+    modifiedTimeStamp?: string;
+    /** name of the assigned solution */
+    solutionName?: string;
+}
 /**
  * Functionality related to configuration.
  * Accessed from the window at window.sas.vi.config.
@@ -108,4 +139,30 @@ export interface ConfigApi {
      * @param config {SviDocumentManager} Document manager configuration.
      */
     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
+     * 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.
+     */
+    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.
+     */
+    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.
+     */
+    getSharedDialogContainer(): HTMLElement;
 }

package/control/control-api.d.ts

@@ -46,6 +46,10 @@ export interface ControlApiBase<ControlTypeAttributes extends TypeAttributes = T
     readonly state: ControlStateApi;
     /** Control type. */
     readonly type: string;
+    /** Control Mask */
+    isMaskedControl(): boolean;
+    /** Control Mask Authorization */
+    isAuthorizedToUnmask(): boolean;
     /**
      * Sets the value of the control's field.
      * Field must be configured as dataSource in the control's typeAttributes.
@@ -166,6 +170,16 @@ export interface ControlStateApi {
      * True if the control is hidden, otherwise false.
      */
     readonly hidden: boolean;
+    /**
+     * Returns the masked state of the calling control.
+     * True if the control is masked, otherwise false.
+     */
+    readonly maskActive: boolean;
+    /**
+     * Returns the disabled state of the calling control.
+     * True if the control is disabled, otherwise false.
+     */
+    readonly disabled: boolean;
     /**
      * Registers a function to be invoked whenever a state change event occurs.
      * This function receives an object that contains information about the change event.

package/control/events.d.ts

@@ -72,4 +72,5 @@ export interface StateChange {
     allowInput?: boolean;
     couldBeReadOnly?: boolean;
     couldBeRequired?: boolean;
+    maskActive?: boolean;
 }

package/control/page.d.ts

@@ -1,4 +1,5 @@
 import { Type } from "@angular/core";
+import { ActionState } from "../object/object-api";
 export declare const enum PageModeEvent {
     CREATE = "create",
     EDIT = "edit",
@@ -16,8 +17,7 @@ export interface Control<ControlTypeAttributes extends TypeAttributes = TypeAttr
 export interface ControlAttrs {
     attributes?: {
         disabled: boolean;
-        showActionHistory: boolean;
-        showVersionHistory: boolean;
+        state?: ActionState;
     };
     id: string;
     category: string;

package/control/restrictions.d.ts

@@ -1,4 +1,4 @@
-import { FieldType } from "./data-types";
+import { FieldType, NumberDataType } from "./data-types";
 export interface RequirableRestriction {
     required: boolean;
 }
@@ -16,6 +16,10 @@ export interface NumericRestrictions extends FieldRestrictions {
     scale?: number;
     precision?: number;
 }
+export interface NumberRestrictions extends FieldRestrictions {
+    fieldDataType: NumberDataType;
+    precision?: number;
+}
 export interface ReferenceDataRestrictions extends FieldRestrictions {
     constrainingListName: string;
     cascadingReferenceDataName?: string;

package/event/event-api.d.ts

@@ -16,7 +16,9 @@ export declare enum PageEvents {
     SelectNodeEvent = "spb::selectNode",
     UpdateSubDocumentTypeEvent = "spb::updateSubDocumentType",
     TabSelectedEvent = "spb::tabSelected",
-    VisitAllTabs = "spb::mark-all-tabs-visited"
+    VisitAllTabs = "spb::mark-all-tabs-visited",
+    MaskToggleEvent = "spb::mask-toggle",
+    MaskAllEvent = "spb::mask-all"
 }
 export interface Subscription {
     unsubscribe(): void;

package/event/event-api.js

@@ -18,6 +18,8 @@ export var PageEvents;
     PageEvents["UpdateSubDocumentTypeEvent"] = "spb::updateSubDocumentType";
     PageEvents["TabSelectedEvent"] = "spb::tabSelected";
     PageEvents["VisitAllTabs"] = "spb::mark-all-tabs-visited";
+    PageEvents["MaskToggleEvent"] = "spb::mask-toggle";
+    PageEvents["MaskAllEvent"] = "spb::mask-all";
 })(PageEvents || (PageEvents = {}));
 /**
  * Callback function executed when subscription is triggered by an event.

package/index.d.ts

@@ -1,65 +1,70 @@
-import { ComponentApi } from "./component";
-import { ConfigApi } from "./config/config-api";
-import { CurrentUserApi } from "./current-user/currentUser-api";
-import { EventApi } from "./event/event-api";
-import { FileApi } from "./file/file-api";
-import { HttpApi } from "./http";
-import { LocalizationApi } from "./localization/localization-api";
-import { AdminMetadataApi } from "./metadata/admin/admin-metadata-api";
-import { MetadataApi } from "./metadata/metadata-api";
-import { ObjectApi } from "./object/object-api";
-import { PageAdminApi } from "./page-admin/page-admin-api";
-import { PageModelApi } from "./page-model/page-model-api";
-import { PageStateApi } from "./page-state/page-state-api";
-import { PropertyApi } from "./property/property-api";
-import { RefDataApi } from "./reference-data/refData";
-import { ResourceApi } from "./resource/resource-api";
-import { ClientSearchApi } from "./search/client/client-search-api";
-import { SearchApi } from "./search/search-api";
-import { SheetApi } from "./sheet/sheet-api";
-import { TabApi } from "./tab/tab-api";
-import { ThemeApi } from "./theme/theme-api";
-import { TraversalApi } from "./traversal/traversal-api";
-/**
- * Common API Functions.
- */
-export interface SviCommonApi {
-    component: ComponentApi;
-    currentUser: CurrentUserApi;
-    event: EventApi;
-    file: FileApi;
-    http: HttpApi;
-    localization: LocalizationApi;
-    metadata: MetadataApi;
-    pageAdmin: PageAdminApi;
-    pageModel: PageModelApi;
-    pageState: PageStateApi;
-    property: PropertyApi;
-    refData: RefDataApi;
-    resource: ResourceApi;
-    search: SearchApi;
-    theme: ThemeApi;
-    traversal: TraversalApi;
-    config: ConfigApi;
-}
-/**
- * The Client API.
- */
-export interface SviClientApi extends SviCommonApi {
-    object: ObjectApi;
-    search: ClientSearchApi;
-    sheet: SheetApi;
-    tab: TabApi;
-}
-/**
- * The Admin API.
- */
-export interface SviAdminApi extends SviCommonApi {
-    metadata: AdminMetadataApi;
-}
-export declare type SviApi = SviClientApi | SviAdminApi;
-export declare type SviWindow = typeof window & {
-    sas: {
-        vi: SviApi;
-    };
-};
+import { ComponentApi } from "./component";
+import { ConfigApi } from "./config/config-api";
+import { CurrentUserApi } from "./current-user/currentUser-api";
+import { EventApi } from "./event/event-api";
+import { FileApi } from "./file/file-api";
+import { HttpApi } from "./http";
+import { LocalizationApi } from "./localization/localization-api";
+import { AdminMetadataApi } from "./metadata/admin/admin-metadata-api";
+import { MetadataApi } from "./metadata/metadata-api";
+import { ObjectApi } from "./object/object-api";
+import { PageAdminApi } from "./page-admin/page-admin-api";
+import { PageModelApi } from "./page-model/page-model-api";
+import { PageStateApi } from "./page-state/page-state-api";
+import { PropertyApi } from "./property/property-api";
+import { RefDataApi } from "./reference-data/refData";
+import { ResourceApi } from "./resource/resource-api";
+import { ClientSearchApi } from "./search/client/client-search-api";
+import { SearchApi } from "./search/search-api";
+import { SheetApi } from "./sheet/sheet-api";
+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 { InitApi } from "./init";
+/**
+ * Common API Functions.
+ */
+export interface SviCommonApi {
+    component: ComponentApi;
+    currentUser: CurrentUserApi;
+    event: EventApi;
+    file: FileApi;
+    http: HttpApi;
+    localization: LocalizationApi;
+    metadata: MetadataApi;
+    pageAdmin: PageAdminApi;
+    pageModel: PageModelApi;
+    pageState: PageStateApi;
+    property: PropertyApi;
+    refData: RefDataApi;
+    /** @deprecated Use window.sas.viInit.registerResourceBundle to register resources before the rest of the Visual Investigator API is ready. */
+    resource: ResourceApi;
+    search: SearchApi;
+    theme: ThemeApi;
+    traversal: TraversalApi;
+    config: ConfigApi;
+    shellTabs: ShellTabsApi;
+}
+/**
+ * The Client API.
+ */
+export interface SviClientApi extends SviCommonApi {
+    object: ObjectApi;
+    search: ClientSearchApi;
+    sheet: SheetApi;
+    tab: TabApi;
+}
+/**
+ * The Admin API.
+ */
+export interface SviAdminApi extends SviCommonApi {
+    metadata: AdminMetadataApi;
+}
+export declare type SviApi = SviClientApi | SviAdminApi;
+export declare type SviWindow = typeof window & {
+    sas: {
+        vi: SviApi;
+        viInit: InitApi;
+    };
+};

package/index.js

@@ -1 +1 @@
-export {};
+export {};

package/init/index.d.ts

@@ -0,0 +1,54 @@
+export declare const APP_INIT_TIMEOUT_MS: number;
+export declare const ERR_EXISTING_APP_DECLARED: (appName: string) => string;
+export declare const ERR_EXISTING_RESOURCE_BUNDLE_DECLARED: (appName: string) => string;
+export declare const ERR_INIT_TIMEOUT: (name: string, timeout?: number) => string;
+/**
+ * An API to manage the asynchronous initialisation of solution applications
+ * before the Visual Investigator application is fully initialised.
+ */
+export interface InitApi {
+    /**
+     * Declare an application.
+     * Visual Investigator will await whenReady for each before continuing its own app initialisation.
+     * notifyAppReady should be called to indicate when the app initialisation is complete.
+     * if provided, registerResourceBundle should be called to indicate when the I18n resource bundle is ready.
+     * @param appName appName of the app configuration.
+     * @param i18nResourceBundleName I18n resource bundle name of the app configuration.
+     */
+    declareApp(appName: string, i18nResourceBundleName?: string): void;
+    /**
+     * Notify listeners that the app has been initialised.
+     * @param appName appName of the app configuration.
+     */
+    notifyAppReady(appName: string): void;
+    /**
+     * Resolves once notifyAppReady has been called for the given app name,
+     * or once the given {@link SviInitEvent} is ready.
+     * Will reject with an error if timeout elapses before notifyAppReady is called.
+     * @param name name of the app configuration or init event.
+     * @param timeout max wait (milliseconds) before the promise is rejected (defaults to {@link APP_INIT_TIMEOUT_MS}).
+     */
+    whenAppReady(name: SviInitEvent | string, timeout?: number): Promise<void>;
+    /**
+     * Register a resource bundle with the Resource Service.
+     * @param bundleName {string} Name for the bundle to be stored in the resource cache.
+     * @param resources {I18nResources} Object containing the resources to be added for the bundle
+     * specified by the bundleName parameter.
+     */
+    registerResourceBundle(bundleName: string, resources: I18nResources): void;
+}
+/**
+ * Initialisation events for the Visual Investigator application.
+ * These can be awaited using window.sas.viInit.whenReady
+ */
+export declare enum SviInitEvent {
+    /** all apps which were declared through window.sas.viInit */
+    AllDeclaredApps = "viInit::all-apps",
+    /** all I18n resource bundles which were declared through window.sas.viInit */
+    AllDeclaredI18nResourceBundles = "viInit::all-i18n-resources",
+    /** the full window.sas.vi API, depends on {@link AllDeclaredI18nResourceBundles} */
+    SviClientApi = "viInit::sas-vi-api"
+}
+export interface I18nResources {
+    [key: string]: string | I18nResources;
+}

package/init/index.js

@@ -0,0 +1,17 @@
+export const APP_INIT_TIMEOUT_MS = 120 * 1000;
+export const ERR_EXISTING_APP_DECLARED = (appName) => `App: '${appName}' has already been declared.`;
+export const ERR_EXISTING_RESOURCE_BUNDLE_DECLARED = (appName) => `I18n resource bundle: '${appName}' has already been declared.`;
+export const ERR_INIT_TIMEOUT = (name, timeout) => `Ready check for '${name}' timed out after ${timeout ?? APP_INIT_TIMEOUT_MS}ms.`;
+/**
+ * Initialisation events for the Visual Investigator application.
+ * These can be awaited using window.sas.viInit.whenReady
+ */
+export var SviInitEvent;
+(function (SviInitEvent) {
+    /** all apps which were declared through window.sas.viInit */
+    SviInitEvent["AllDeclaredApps"] = "viInit::all-apps";
+    /** all I18n resource bundles which were declared through window.sas.viInit */
+    SviInitEvent["AllDeclaredI18nResourceBundles"] = "viInit::all-i18n-resources";
+    /** the full window.sas.vi API, depends on {@link AllDeclaredI18nResourceBundles} */
+    SviInitEvent["SviClientApi"] = "viInit::sas-vi-api";
+})(SviInitEvent || (SviInitEvent = {}));

package/init/init-api.d.ts

@@ -0,0 +1,26 @@
+import { I18nResources, SviInitEvent, InitApi } from ".";
+export interface ResourceApi {
+    registerResourceBundle(bundleName: string, resources: I18nResources): void;
+}
+export declare class SviInitApi implements InitApi {
+    private globalI18nResources;
+    private appReadyStates;
+    private resourceReadyStates;
+    private resourceServiceSubject;
+    private resourceService$;
+    private defaultTimeout;
+    constructor(globalI18nResources: I18nResources);
+    declareApp(appName: string, i18nResourceBundleName?: string): void;
+    whenAppReady(appName: SviInitEvent | string, timeout?: number): Promise<void>;
+    notifyAppReady(appName: SviInitEvent | string): void;
+    registerResourceBundle(bundleName: string, resources: I18nResources): void;
+    checkAllDeclaredAppsReady(): void;
+    checkAllDeclaredResourcesReady(): void;
+    setResourceApi(resourceService: ResourceApi): void;
+    private isAppDeclared;
+    private isResourceBundleDeclared;
+    private notifyReady;
+    private whenReady;
+    private whenAllDeclaredReady;
+    private initReadyState;
+}