@sassoftware/vi-api 0.0.29

package/control/restrictions.d.ts

@@ -0,0 +1,33 @@
+import { FieldType } from "./data-types";
+export interface RequirableRestriction {
+    required: boolean;
+}
+export interface FieldRestrictions extends RequirableRestriction {
+    readOnly: boolean;
+    systemReserved: boolean;
+    dataType: FieldType;
+}
+export interface StringRestrictions extends FieldRestrictions {
+    dataType: "STRING";
+    maxLength?: number;
+}
+export interface NumericRestrictions extends FieldRestrictions {
+    fieldDataType: "NUMERIC";
+    scale?: number;
+    precision?: number;
+}
+export interface ReferenceDataRestrictions extends FieldRestrictions {
+    constrainingListName: string;
+    cascadingReferenceDataName?: string;
+    cascadingReferenceDataFilterByCode?: string;
+    cascadingReferenceDataFilterByField?: string;
+}
+export declare type UserGroupStrategy = "USERS" | "GROUPS" | "USERS_AND_GROUPS";
+export interface UserGroupRestrictions extends FieldRestrictions {
+    allowMultipleSelections: boolean;
+    userSelectionStrategy: UserGroupStrategy;
+}
+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;

package/control/restrictions.js

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

package/control/toolbar-property-api.d.ts

@@ -0,0 +1,16 @@
+/**
+ * This API is available on the Toolbar Property Editor controls to handle property changes and trigger refreshes.
+ */
+export interface ToolbarPropertyApi {
+    /**
+     * Methods related to the entire page.
+     */
+    readonly page: {
+        /**
+         * Registers a function to be invoked whenever one of the calling toolbar control's properties change.
+         * @method
+         * @param handler The function to be invoked.
+         */
+        onPropertyChange(handler: (category: string, property: string, currentValue: any, previousValue: any) => void): void;
+    };
+}

package/control/toolbar-property-api.js

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

package/current-user/currentUser-api.d.ts

@@ -0,0 +1,65 @@
+export declare enum IdentityState {
+    Active = "active",
+    Inactive = "inactive",
+    Locked = "locked"
+}
+export declare enum IdentityType {
+    User = "user",
+    Group = "group"
+}
+export interface IdentitySummary {
+    id: string;
+    name?: string;
+    description?: string;
+    creationTimeStamp?: string;
+    modifiedTimeStamp?: string;
+    providerId?: string;
+    state?: IdentityState;
+    type: IdentityType;
+}
+export interface UserSummary extends IdentitySummary {
+    readonly type: IdentityType.User;
+}
+export interface SessionDetails {
+    authorizedFeatures: string[];
+    displayName: string;
+    id: string;
+    softwareVersionNumber: string;
+}
+/**
+ * This API is used to get the details and functionality associated with the current user.
+ * Accessed from the window at window.sas.vi.currentUser.
+ */
+export interface CurrentUserApi {
+    /**
+     * @method
+     * @description Gets the object containing the users current session details.
+     * @returns The user's current session details.
+     */
+    getSessionDetails(): SessionDetails;
+    /**
+     * @method
+     * @description Gets the object containing the current user details.
+     * @returns The current user details.
+     */
+    getUserDetails(): Promise<UserSummary>;
+    /**
+     * @method
+     * @description Gets the list of groups to which the current user belongs.
+     * @returns A list of group details.
+     */
+    getUserMemberships(): Promise<IdentitySummary[]>;
+    /**
+     * @method
+     * @description Verifies if the current user has administration features.
+     * @returns A boolean value indicating if the user has access to the administration features.
+     */
+    hasAdminFeatures(): boolean;
+    /**
+     * @method
+     * @description Verifies if the current user has a set of features.
+     * @param features {string[]} Identifiers of the required features.
+     * @returns A boolean value indicating if the user has access to the features.
+     */
+    hasFeatures(features: string[]): boolean;
+}

package/current-user/currentUser-api.js

@@ -0,0 +1,11 @@
+export var IdentityState;
+(function (IdentityState) {
+    IdentityState["Active"] = "active";
+    IdentityState["Inactive"] = "inactive";
+    IdentityState["Locked"] = "locked";
+})(IdentityState || (IdentityState = {}));
+export var IdentityType;
+(function (IdentityType) {
+    IdentityType["User"] = "user";
+    IdentityType["Group"] = "group";
+})(IdentityType || (IdentityType = {}));

package/current-user/package.json

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

package/current-user/public-api.d.ts

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

package/current-user/public-api.js

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

package/event/event-api.d.ts

@@ -0,0 +1,57 @@
+export declare const TAB_ACTIVE_EVENT = "SNG_TAB_ACTIVE";
+export declare const CONTENT_PANE_RESIZE_EVENT = "SNG_CONTENT_PANE_RESIZE";
+export declare enum PageEvents {
+    ChildObjectOnSelect = "spb:ChildObjectSelect",
+    CommentsOnShowEvent = "spb::Comments:onShow",
+    DirtyStateChangeEvent = "spb::dirty-state-change",
+    LoadDocumentEvent = "spb::page-load-all",
+    ModeChangeEvent = "spb::page-mode-change",
+    ModelChangeEvent = "spb::page-model-change",
+    PanelOpenEvent = "spb::sliding-panel-open",
+    RefreshPageEvent = "spb::refreshPage",
+    SelectAttachmentEvent = "spb::Highlighting:SelectAttachment",
+    SelectChildObjectEvent = "spb::Highlighting:SelectChildObject",
+    SelectCommentEvent = "spb::Highlighting:SelectComment",
+    SelectNodeEvent = "spb::selectNode",
+    UpdateSubDocumentTypeEvent = "spb::updateSubDocumentType",
+    TabSelectedEvent = "spb::tabSelected",
+    VisitAllTabs = "spb::mark-all-tabs-visited"
+}
+export interface Subscription {
+    unsubscribe(): void;
+}
+/**
+ * This API provides the  details and functionality associated with publishing and subscribing to events.
+ * Accessed from the window at window.sas.vi.event.
+ */
+export interface EventApi {
+    /**
+     * @method
+     * @description Publishes an event for subscribers to consume.
+     * @param eventName {string} Name of the event to publish.
+     * @param [payload] {any} Data passed to all subscribers.
+     */
+    publish(eventName: string, payload?: any): void;
+    /**
+     * @method
+     * @description Subscribes to an event and registers a function to be called on any future published events.
+     * If the eventName does not exist, it is created.
+     * @param eventName {string} Name of the event to subscribe to.
+     * @param {EventApi~subscriptionCallback} Function invoked when the subscription is triggered by an event.
+     * Has access to the event's payload.
+     * @returns The subscription being made to the event.
+     */
+    subscribe(eventName: string, observer: (payload: any) => void): Subscription | undefined;
+    /**
+     * @method
+     * @description Unsubscribe from a given subscription and stop listening for events.
+     * @param subscription {Subscription} Subscription to stop.
+     */
+    unsubscribe(subscription: Subscription): void;
+}
+/**
+ * Callback function executed when subscription is triggered by an event.
+ * @callback EventApi~subscriptionCallback
+ * @param payload {any} Payload of the subscription.
+ * @returns {void}
+ */

package/event/event-api.js

@@ -0,0 +1,26 @@
+export const TAB_ACTIVE_EVENT = "SNG_TAB_ACTIVE";
+export const CONTENT_PANE_RESIZE_EVENT = "SNG_CONTENT_PANE_RESIZE";
+export var PageEvents;
+(function (PageEvents) {
+    PageEvents["ChildObjectOnSelect"] = "spb:ChildObjectSelect";
+    PageEvents["CommentsOnShowEvent"] = "spb::Comments:onShow";
+    PageEvents["DirtyStateChangeEvent"] = "spb::dirty-state-change";
+    PageEvents["LoadDocumentEvent"] = "spb::page-load-all";
+    PageEvents["ModeChangeEvent"] = "spb::page-mode-change";
+    PageEvents["ModelChangeEvent"] = "spb::page-model-change";
+    PageEvents["PanelOpenEvent"] = "spb::sliding-panel-open";
+    PageEvents["RefreshPageEvent"] = "spb::refreshPage";
+    PageEvents["SelectAttachmentEvent"] = "spb::Highlighting:SelectAttachment";
+    PageEvents["SelectChildObjectEvent"] = "spb::Highlighting:SelectChildObject";
+    PageEvents["SelectCommentEvent"] = "spb::Highlighting:SelectComment";
+    PageEvents["SelectNodeEvent"] = "spb::selectNode";
+    PageEvents["UpdateSubDocumentTypeEvent"] = "spb::updateSubDocumentType";
+    PageEvents["TabSelectedEvent"] = "spb::tabSelected";
+    PageEvents["VisitAllTabs"] = "spb::mark-all-tabs-visited";
+})(PageEvents || (PageEvents = {}));
+/**
+ * Callback function executed when subscription is triggered by an event.
+ * @callback EventApi~subscriptionCallback
+ * @param payload {any} Payload of the subscription.
+ * @returns {void}
+ */

package/event/package.json

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

package/event/public-api.d.ts

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

package/event/public-api.js

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

package/file/file-api.d.ts

@@ -0,0 +1,44 @@
+export interface SASUploadedFile {
+    type: string;
+    name: string;
+    size: number;
+    location: string;
+    id: string;
+}
+export interface SASObjectAttachedFile extends SASUploadedFile {
+    category: string;
+    description?: string;
+    displayOrder?: number;
+    uploadedAt?: string;
+    uploadedBy?: string;
+    version?: number;
+}
+export interface FileChange {
+    changeType: FileOperationMethod;
+    newFiles: SASObjectAttachedFile[];
+    changedFile?: SASObjectAttachedFile;
+}
+export declare const enum FileOperationMethod {
+    CREATE = "CREATE",
+    UPDATE = "UPDATE",
+    DELETE = "DELETE"
+}
+export interface FileOperation {
+    method: FileOperationMethod;
+    body?: SASObjectAttachedFile;
+    id?: string;
+}
+/**
+ * This API provides functionality related to uploading files.
+ * Accessed from the window at window.sas.vi.file.
+ */
+export interface FileApi {
+    /**
+     * @method
+     * @description Uploads the file to the SAS Visual Investigator folder without attaching it to an object.
+     * @param file {File} File to be uploaded.
+     * @param [fileName] {string} Name to give to the file to upload.
+     * @returns Promise containing the uploaded file.
+     */
+    uploadToViFolder(file: File, fileName?: string): Promise<SASUploadedFile>;
+}

package/file/file-api.js

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

package/file/package.json

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

package/file/public-api.d.ts

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

package/file/public-api.js

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