@sassoftware/vi-api 0.0.29

package/component/bindings.d.ts

@@ -0,0 +1,85 @@
+import { PageDataChange, PageModeChange } from "../control/events";
+import { Relationship } from "../svi-datahub";
+import { QueryMode } from "../svi-sand";
+import { ControlContainer } from "../object/object-api";
+import { PageModel, PageModelObjectData } from "../page-model/page-model-api";
+import { SearchObject, SearchQuery } from "../search/client/client-search-api";
+import { TimeSliderEventDates, TimeSliderRange } from "../time-slider";
+export interface SearchAndSelectWithPreviewBindings {
+    onSearchItemSelected: (selectedItem: SearchObject | null) => void;
+    onSearchItemDoubleClicked?: (selectedItem: SearchObject) => void;
+    initialQuery?: string;
+    additionalModes?: QueryMode[];
+    objectTypeFilter?: string[];
+}
+export interface PageViewerApi {
+    save: () => Promise<void>;
+    isDirty: () => boolean;
+    isValid: () => Promise<boolean>;
+}
+export interface PageBindings {
+    docId?: string;
+    docType?: string;
+    eventName?: string;
+    templateUuid?: string;
+    showToolbar?: boolean;
+    tempCreateId?: string;
+    containerClass?: string;
+    pageClass?: string;
+    enableSheets?: string;
+    pageModel?: PageModel;
+    staticDocumentData?: Record<string, any>;
+    initialCreateData?: Record<string, any>;
+    setApi?: (api: PageViewerApi) => void;
+    mainTab?: string;
+    onDirty?: (isDirty: boolean) => void;
+    onChange?: (change: PageDataChange | PageModeChange) => void;
+}
+export interface ControlCollectionBindings {
+    controlContainer?: ControlContainer;
+    pageModel?: PageModel;
+    root?: boolean;
+}
+export interface RelationshipDetailsBindings {
+    targetObjectTypeName: string;
+    targetObjectTypeLabel: string;
+    parentObjectTypeName: string;
+    parentObjectTypeLabel: string;
+    linkReasons: Relationship[];
+    selectedItem?: {
+        id: string;
+        type: string;
+    };
+    newPageModel?: {
+        model: PageModelObjectData;
+    };
+    onLinkReasonSelected: (linkReason: Relationship) => void;
+    relationshipValues?: Record<string, any>;
+    initialCreateData?: Record<string, any>;
+    setApi?: (api: PageViewerApi) => void;
+    onRelatedPageChange?: (change: PageDataChange | PageModeChange) => void;
+    onRelationshipValuesChange?: (current: Record<string, any>, previous?: Record<string, any>) => void;
+}
+export interface SearchInputInputBindings {
+    entityName: string;
+    queryBuilderId?: string;
+    showQueryBuilder?: boolean;
+    queryText?: string;
+    autoFocus?: boolean;
+}
+export interface SearchInputBindings extends SearchInputInputBindings {
+    onSearch?: (model: SearchQuery) => void;
+    onValueChange?: (val: string) => void;
+}
+export interface TimeSliderInputBindings {
+    timeSliderId: string;
+    timeSliderDates: TimeSliderEventDates;
+    viewRange: TimeSliderRange;
+    isReadOnly: boolean;
+    sliderWidth: number;
+}
+export interface TimeSliderBindings extends TimeSliderInputBindings {
+    rangeChangeEvent?: () => void;
+    close?: () => void;
+}
+export declare type SviComponentBindings = ControlCollectionBindings | RelationshipDetailsBindings | SearchInputBindings | PageBindings | SearchAndSelectWithPreviewBindings | TimeSliderBindings;

package/component/bindings.js

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

package/component/index.d.ts

@@ -0,0 +1,49 @@
+import { ControlCollectionBindings, PageBindings, 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",
+    SearchAndSelectWithPreview = "svi-search-and-select-with-preview",
+    TimeSlider = "svi-time-slider"
+}
+export interface ComponentCreationResult {
+    element: HTMLElement;
+    destroy: () => void;
+    component: Record<string, any>;
+}
+/**
+ * Functionality related to dynamically creating SAS Visual Investigator UI components.
+ * Accessed from the window at window.sas.vi.component.
+ */
+export interface ComponentApi {
+    create(component: SviComponent.ControlCollection, target: HTMLElement, bindings?: ControlCollectionBindings): Promise<ComponentCreationResult>;
+    create(component: SviComponent.Page, target: HTMLElement, bindings?: PageBindings): Promise<ComponentCreationResult>;
+    create(component: SviComponent.RelationshipDetails, target: HTMLElement, bindings?: RelationshipDetailsBindings): Promise<ComponentCreationResult>;
+    create(component: SviComponent.SearchInput, target: HTMLElement, bindings?: SearchInputBindings): Promise<ComponentCreationResult>;
+    create(component: SviComponent.SearchAndSelectWithPreview, target: HTMLElement, bindings?: SearchAndSelectWithPreviewBindings): Promise<ComponentCreationResult>;
+    create(component: SviComponent.TimeSlider, target: HTMLElement, bindings?: TimeSliderBindings): Promise<ComponentCreationResult>;
+    /**
+     * Dynamically create a SAS Visual Investigator UI component appended to a given target DOM element location.
+     *
+     * @method
+     * @param component {SviComponent} Creates the component.
+     * @param target {HTMLElement} Appends the component to the element.
+     * @param [bindings] {SviComponentBindings} Creates the component with the bindings.
+     * @returns A promise that resolves when the component has been created.
+     * Resolves to an object containing the created element and a function to destroy it.
+     */
+    create(component: SviComponent, target: HTMLElement, bindings?: SviComponentBindings): Promise<ComponentCreationResult>;
+    /**
+     * @method
+     * Notifies the application to identify and react to any changes that have been applied.
+     * @param [callback] {ComponentApi~afterDetectChanges} Function to be called after a change is detected.
+     */
+    detectChanges(callback?: () => void): void;
+}
+/**
+ * @callback ComponentApi~afterDetectChanges
+ * @description A function to be called after change detection
+ * @returns {void}
+ */
+export * from "./bindings";

package/component/index.js

@@ -0,0 +1,16 @@
+/* An enum containing the components that we support the creation of. */
+export var SviComponent;
+(function (SviComponent) {
+    SviComponent["ControlCollection"] = "svi-control-collection";
+    SviComponent["RelationshipDetails"] = "svi-relationship-details";
+    SviComponent["SearchInput"] = "svi-search-input";
+    SviComponent["Page"] = "svi-page";
+    SviComponent["SearchAndSelectWithPreview"] = "svi-search-and-select-with-preview";
+    SviComponent["TimeSlider"] = "svi-time-slider";
+})(SviComponent || (SviComponent = {}));
+/**
+ * @callback ComponentApi~afterDetectChanges
+ * @description A function to be called after change detection
+ * @returns {void}
+ */
+export * from "./bindings";

package/component/package.json

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

package/component/public-api.d.ts

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

package/component/public-api.js

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

package/config/config-api.d.ts

@@ -0,0 +1,92 @@
+import { ControlMetadata, ResourcedString } from "../svi-datahub";
+import { ControlStates } from "../control/page";
+export declare enum ControlType {
+    AngularJS = "angularjs",
+    Angular = "angular",
+    WebComponent = "webcomponent"
+}
+export interface Solution {
+    label: string;
+    version?: string;
+}
+export interface SolutionExtension extends ControlMetadata {
+    controlAttributes?: SolutionExtensionConfigTypeAttributes;
+    metadata?: SolutionExtensionMetadata;
+    resolvedDisplayName?: string;
+    resolvedDescription?: string;
+    name: string;
+}
+export interface SolutionExtensionConfigTypeAttributes {
+    metadata?: SolutionExtensionMetadata;
+    attributes?: Record<string, SolutionExtensionAttribute>;
+}
+export interface SolutionExtensionAttribute {
+    type: string;
+    displayName: ResourcedString;
+    order?: number;
+    required?: boolean | string;
+    localizable?: boolean | string;
+    allowMultiple?: boolean | string;
+    states?: Record<string, boolean>;
+    defaultValue?: any;
+    disabledExpression?: string;
+    picklistName?: string;
+    ignoreRestrictions?: boolean;
+}
+export interface SolutionExtensionMetadata {
+    iconClass?: string;
+    useDragHandle?: boolean;
+    renderAs?: ControlType;
+    containerRestrictions?: string[];
+    fullScreenMode?: boolean;
+    states?: ControlStates;
+    path?: string;
+    showInToolbox?: "true" | "false";
+    mainDocumentOnly?: boolean;
+}
+/**
+ * Functionality related to configuration.
+ * 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.
+     */
+    getSoftExpansionLimit(): Promise<number>;
+    /**
+     * @method
+     * @description Gets the hard expansion limit of the network nodes.
+     * @returns Promise containing the hard expansion limit.
+     */
+    getHardExpansionLimit(): Promise<number>;
+    /**
+     * @method
+     * @description Gets the registered solutions and their labels and versions.
+     * @returns The currently registered solutions.
+     */
+    getSolutions(): Map<string, Solution>;
+    /**
+     * @method
+     * @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 [version] {string} Version of the solution.
+     */
+    registerSolution(key: string, label: string, version?: string): void;
+    /**
+     * @method
+     * @description Retrieves registered solution extension with a given name.
+     * @param name {string} Name of the solution extension.
+     * @returns A promise that resolves to the solution extension if the name is found.
+     */
+    getSolutionExtension(name: string): Promise<SolutionExtension | undefined>;
+    /**
+     * @method
+     * @description Registers a solution extension with the application.
+     * @param config {SolutionExtension} Solution extension configuration.
+     */
+    registerSolutionExtension(config: SolutionExtension): void;
+}

package/config/config-api.js

@@ -0,0 +1,6 @@
+export var ControlType;
+(function (ControlType) {
+    ControlType["AngularJS"] = "angularjs";
+    ControlType["Angular"] = "angular";
+    ControlType["WebComponent"] = "webcomponent";
+})(ControlType || (ControlType = {}));

package/config/package.json

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

package/config/public-api.d.ts

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

package/config/public-api.js

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