@sassoftware/vi-api 0.0.29

package/object/object-api.d.ts

@@ -0,0 +1,507 @@
+import { Relationship, StoredObjectFieldDTO } from "../svi-datahub";
+import { FileOperation } from "../file/file-api";
+import { PageModel } from "../page-model/page-model-api";
+import { ClientSheet, Sheet } from "../sheet/sheet-api";
+export interface ObjectIdentifier {
+    id: string;
+    type: string;
+}
+export interface ObjectAccessRules {
+    canReadObject: Promise<boolean>;
+    canUpdateObject: Promise<boolean>;
+    canDeleteObject: Promise<boolean>;
+}
+export interface FormatObjectFieldsOptions {
+    skipFormatReferenceData?: boolean;
+    skipFormatUserGroups?: boolean;
+    skipFormatBooleans?: boolean;
+    /**
+     * A function that will be the last thing called in order to format the object's field values
+     * @param fieldValue the current value of the field being formatted
+     * @param fieldName the name of the field currently being formatted
+     * @param objectFields all of the available fields in the object
+     * @param fieldMetadata the current field's metadata
+     */
+    formatCallback?: (fieldValue: string | number | Date | PageData[], fieldName: string, objectFields: FieldValues, fieldMetadata: StoredObjectFieldDTO) => void;
+}
+export interface UpdateObjectOptions {
+    fileOperations?: FileOperation[];
+    isExternalObject?: boolean;
+    sheets?: ClientSheet[];
+}
+export interface CreateObjectOptions {
+    comments?: Comment[];
+    fileOperations?: FileOperation[];
+    sheets?: ClientSheet[];
+}
+/**
+ * This API provides the functionality related to objects within SAS Visual Investigator.
+ * Accessed from the window at window.sas.vi.object.
+ */
+export interface ObjectApi {
+    /**
+     * @method
+     * @description Gets the object access rules for an object:
+     * The three methods that return booleans based on specified object are:
+     *
+     * canReadObject,
+     * canUpdateObject,
+     * and canDeleteObject.
+     *
+     * @param objectType {string} Object type.
+     * @param objectId {string} Object ID.
+     * @return Object with three boolean methods which provide boolean data on a specified object.
+     */
+    getObjectAccessRules(objectType: string, objectId: string): ObjectAccessRules;
+    /**
+     * @method
+     * @description Gets the specified object.
+     * @param objectType {string} Object type.
+     * @param objectId {string} Object ID.
+     * @param [includeDisplayLabel = true] {boolean} Checks whether or not to return the object with a display label.
+     * @return The specified object.
+     */
+    getObject(objectType: string, objectId: string, includeDisplayLabel?: boolean): Promise<VIObject>;
+    /**
+     * @method
+     * @description Gets the child objects of an object.
+     * @param objectType {string} Object type.
+     * @param objectId {string} Gets the child objects relating to the object ID.
+     * @param childObjectType {string} Child object type.
+     * @param [maxResponses = 25] {number} Maximum number of child objects to be returned.
+     * @return A promise that resolves to an array of objects, that are child objects of the specified object.
+     */
+    getChildObjects(objectType: string, objectId: string, childObjectType: string, maxResponses?: number): Promise<VIObject[]>;
+    /**
+     * @method
+     * @description Updates an existing object with the provided data.
+     * @param objectType {string} Object type.
+     * @param objectId {string} Object ID.
+     * @param objectTypeId {string} Object type ID.
+     * @param objectTypeVersion {number} Object type version.
+     * @param fieldValues {FieldValues} Field values of the object.
+     * @param [options] {UpdateObjectOptions} Optional extra parameters.
+     * @return A promise that resolves to the updated object once the object has successfully been updated.
+     */
+    updateObject(objectType: string, objectId: string, objectTypeId: string, objectTypeVersion: number, fieldValues: FieldValues, options?: UpdateObjectOptions): Promise<VIObject>;
+    /**
+     * @method
+     * @description Deletes an object.
+     * @param objectType {string} Object type.
+     * @param objectId {string} Object ID.
+     * @return A promise that resolves to void when the specified object is successfully deleted.
+     */
+    deleteObject(objectType: string, objectId: string): Promise<void>;
+    /**
+     * @method
+     * @description Creates an object.
+     * @param objectType {string} Object type.
+     * @param objectTypeId {string} Object type ID.
+     * @param fieldValues {FieldValues} Field values of the object.
+     * @param [options] {CreateObjectOptions} Optional extra parameters.
+     * @return A promise that resolves to the created object once the object has successfully been created.
+     */
+    createObject(objectType: string, objectTypeId: string, fieldValues: FieldValues, options?: CreateObjectOptions): Promise<VIObject>;
+    /**
+     * @method
+     * @description Gets relationship via the relationship ID.
+     * @param relationshipId {string} Relationship ID.
+     * @return A promise that resolves to a relationship.
+     */
+    getObjectRelationship(relationshipId: string): Promise<ObjectRelationship>;
+    /**
+     * @method
+     * @description Updates an existing relationship in SAS Visual Investigator.
+     * @param relationshipId {string} Relationship ID.
+     * @param payload {any} HTTP request content.
+     * @return A promise that resolves to a relationship.
+     */
+    updateObjectRelationship(relationshipId: string, payload: any): Promise<ObjectRelationship>;
+    /**
+     * @method
+     * @description Deletes relationship with the specified ID.
+     * @param relationshipId {string} Relationship ID.
+     * @return A promise that resolves to void when the object is successfully deleted.
+     */
+    deleteObjectRelationship(relationshipId: string): Promise<void>;
+    /**
+     * @method
+     * @description Creates a relationship between two objects.
+     * @param from {VIObject} Object that relationship is from.
+     * @param to {VIObject} Object that relationship is to.
+     * @param relationship {ObjectRelationship} The relationship.
+     * @return A promise that resolves to an object.
+     */
+    relateObject(from: VIObject, to: VIObject, relationship: ObjectRelationship): Promise<ObjectRelationship>;
+    /**
+     * @method
+     * @description Gets object summary label.
+     * @param objectType {string} Object type.
+     * @param objectId {string} Object ID.
+     * @return Summary label as a String.
+     */
+    getObjectSummaryLabel(objectType: string, objectId: string): Promise<string>;
+    /**
+     * @method
+     * @description Creates a new object and relates it with an existing one.
+     * @param from {VIObject} Object that the relationship is from.
+     * @param to {VIObject} Object that the relationship is to.
+     * @param relationship {ObjectRelationship} The relationship.
+     * @return A promise that resolves to a newly created relationship.
+     */
+    createAndRelateObject(from: VIObject, to: VIObject, relationship: ObjectRelationship): Promise<ObjectRelationship>;
+    /**
+     * @method
+     * @description Processes an array of objects and formats them for display.
+     * @param objects {VIObject[]} Array of objects.
+     * @param objectType {string} Type of the objects in the array.
+     * @param [options] {FormatObjectFieldsOptions} Optional parameters to control the formatting. By default, nothing is skipped and there is no formatCallback.
+     * @return A promise that resolves to the formatted array of objects.
+     */
+    formatObjectFieldsForDisplay(objects: VIObject[], objectType: string, options?: FormatObjectFieldsOptions): Promise<VIObject[]>;
+    /**
+     * @method
+     * @description Uploads an attachment.
+     * @param attachmentModel {AttachmentModel} Attachment model.
+     * @param objectType {string} Object type.
+     * @param objectId {string} Object ID.
+     * @return A promise that resolves to a HttpResponse with a FileAssociationResponse as the data.
+     */
+    uploadAttachment(attachmentModel: AttachmentModel, objectType: string, objectId: string): Promise<FileAssociationResponse>;
+    /**
+     * @method
+     * @description Deletes the specified attachment of the associated object.
+     * @param objectType {string} Object type.
+     * @param objectId {string} Object ID.
+     * @param attachmentId {string} Attachment ID.
+     * @return A promise that resolves to an empty HttpResponse when the attachment is successfully deleted.
+     */
+    deleteAttachment(objectType: string, objectId: string, attachmentId: string): Promise<void>;
+    /**
+     * @method
+     * @description Gets an attachment of the associated object.
+     * @param objectId {string} Object ID
+     * @param objectType {string} Object type.
+     * @param attachmentId {string} Attachment ID.
+     * @return A promise that resolves to a HttpResponse with a FileAssociationResponse as the data.
+     */
+    getAttachment(objectType: string, objectId: string, attachmentId: string): Promise<FileAssociationResponse>;
+    /**
+     * @method
+     * @description Validates the fields, controls and file categories of a child object.
+     * @param pageModel {PageModel} Page model.
+     * @param childObject {StoredObjectMetadata} Child object metadata.
+     * @return An observable that resolves to an array of validation results.
+     */
+    validate(model: PageModel, childObject: StoredObjectMetadata): Promise<ValidationResult[]>;
+}
+export interface PageData {
+    fieldValues: FieldValues;
+    id: string;
+    displayLabel?: string;
+}
+export interface FieldValues {
+    [property: string]: string | number | Date | PageData[];
+}
+export interface ObjectSheetSettings {
+    id: string;
+    type: string;
+    title: string;
+    allowWorksheets: boolean;
+    allowWorksheetCreation: boolean;
+    allowNotesheets: boolean;
+    allowNotesheetCreation: boolean;
+}
+export interface VIObject {
+    fieldValues: FieldValues;
+    comments?: Comment[];
+    fileOperations?: FileOperation[];
+    createdAt: string;
+    displayLabel?: string;
+    lastUpdatedAt: string;
+    objectTypeId: string;
+    objectTypeName: string;
+    sheets?: Sheet[];
+    id: string;
+}
+export interface ValidationResult {
+    isValid: boolean;
+    message?: string;
+}
+export interface PageAction {
+    attrs: {
+        actionId: number;
+        actionName: string;
+        attributes: {
+            [property: string]: any;
+            displayName: string;
+            disabled: string;
+        };
+        controlId?: number;
+        displayName: string;
+    };
+}
+export interface PageActions {
+    items?: PageAction[];
+}
+export interface ControlContainer {
+    childNodes?: ChildNode[];
+}
+export interface PageTemplateScreen extends ControlContainer {
+    id: string;
+    name: string;
+    locked?: boolean;
+}
+export interface PageTemplate {
+    errors?: boolean;
+    errorDetails?: Error;
+    showTabs: boolean;
+    id?: number;
+    screens: PageTemplateScreen[];
+}
+export interface FieldRestriction {
+    maxLength?: number;
+    required?: boolean;
+    fieldDataType?: string;
+    allowMultipleFiles?: boolean;
+    constrainingListName?: string;
+    cascadingReferenceDataFilterByCode?: string;
+    cascadingReferenceDataFilterByField?: string;
+}
+export interface FieldRestrictions {
+    [property: string]: FieldRestriction;
+}
+export interface ObjectFieldRestrictions {
+    [property: string]: FieldRestrictions;
+}
+export interface TypeAttributes {
+    [property: string]: any;
+}
+export interface NodeStates {
+    readOnly?: boolean;
+    required?: boolean;
+    hidden?: boolean;
+}
+interface GlobalNodeStates extends NodeStates {
+    conditions?: any[];
+}
+export interface NodeAttributes extends TypeAttributes {
+    global?: {
+        state?: GlobalNodeStates;
+        groupRestrictions?: Array<{
+            id: string;
+            name: string;
+        }>;
+    };
+}
+export interface ChildNodeAttrs {
+    attributes?: {
+        disabled: boolean;
+        showActionHistory: boolean;
+        showVersionHistory: boolean;
+    };
+    id: string;
+    category: string;
+    type: string;
+    states?: NodeStates;
+}
+export interface ChildNode extends ControlContainer {
+    id: string;
+    _fullScreen?: boolean;
+    attributes?: NodeAttributes;
+    typeAttributes: TypeAttributes;
+    inheritedAttributes?: TypeAttributes;
+    attrs: ChildNodeAttrs;
+}
+export declare enum ConditionReferenceType {
+    TemplateControl = "TEMPLATE_CONTROL",
+    Condition = "CONDITION",
+    RequiredField = "REQUIRED_FIELD",
+    ReadOnlyField = "READ_ONLY_FIELD",
+    NldStyling = "NLD_STYLING"
+}
+export interface ConditionReference {
+    association: string;
+    type: ConditionReferenceType;
+}
+export declare enum ConditionFactType {
+    Field = "FIELD",
+    Condition = "CONDITION_REFERENCE"
+}
+export interface ConditionFact {
+    factType: ConditionFactType;
+    factPlaceholder: string;
+    factValue: string;
+}
+export interface Condition {
+    type: string;
+    parameters: Array<string | number | boolean | Condition>;
+    isComplete?: boolean;
+}
+export interface StoredObjectField {
+    id: number;
+    label: string;
+    name: string;
+    columnName: string;
+    dataType: string;
+    length?: number;
+    required: boolean;
+    primaryKeyField: boolean;
+    unique: boolean;
+    autoGenerated: boolean;
+    systemReserved: boolean;
+    displayIndex: number;
+    version: number;
+    primaryKeySeqNo?: number;
+    readOnly: boolean;
+    indexedForSearch: boolean;
+    showTimeZone: boolean;
+    ownerName: string;
+    constrainingListName?: string;
+    cascadingReferenceDataFilterByCode?: string;
+    cascadingReferenceDataFilterByField?: string;
+}
+export interface FieldOperand {
+    type: string;
+    fieldName: string;
+    objectName: string;
+}
+export interface BooleanExpression {
+    type: string;
+    leftOperand?: {};
+    operator: string;
+    rightOperand: any;
+}
+export interface ConditionalExpression extends BooleanExpression {
+    type: string;
+    leftOperand: {};
+    operator: string;
+    rightOperands: Array<{}>;
+}
+export interface ObjectIcon {
+    id: number;
+    name: string;
+    imageType: string;
+    imageLocation: string;
+    version: number;
+}
+export interface StoredObjectFileCategory {
+    name: string;
+    displayName: string;
+    allowMultiple?: boolean;
+    required?: boolean;
+    documentLockRequired?: boolean;
+}
+export interface StoredObjectMetadata {
+    id: number;
+    label: string;
+    description: string;
+    name: string;
+    tableName: string;
+    historyEnabled: boolean;
+    version: number;
+    lastUpdatedAtTimeFieldName: string;
+    createdAtTimeFieldName: string;
+    displayTextFields?: DisplayTextFields[];
+    dataStoreAssignedTimeZone: string;
+    type: string;
+    markerColor: string;
+    nodeShape: string;
+    nodeColor: string;
+    borderColor: string;
+    borderWidth: number;
+    indexedForSearch: boolean;
+    attachmentsIndexedForSearch: boolean;
+    fields?: StoredObjectField[];
+    relationshipsFrom?: Relationship[];
+    defaultRegularIcon: ObjectIcon;
+    requireSearchBeforeCreate: boolean;
+    fileCategories?: StoredObjectFileCategory[];
+}
+export interface ObjectRelationship {
+    relationshipTypeName?: string;
+    relationshipTypeLabel?: string;
+    id?: string;
+    createdAt?: Date;
+    lastUpdatedAt?: Date;
+    validFrom?: Date;
+    validTo?: Date;
+    displayLabel?: string;
+    fromObjectTypeName?: string;
+    fromObjectTypeVersion?: number;
+    fromObjectId?: string;
+    fromObjectDisplayLabel?: string;
+    toObjectTypeName?: string;
+    toObjectTypeVersion?: number;
+    toObjectId?: string;
+    toObjectDisplayLabel?: string;
+    fieldValues?: {
+        [index: string]: any;
+    };
+    qualifiedTypeName?: string;
+}
+export interface AttachmentRow {
+    description: string;
+    location: string;
+    id: string;
+    uploadedBy: string;
+    name: string;
+    size: number;
+    type: string;
+}
+export interface AttachmentModel {
+    id: string;
+    name: string;
+    type?: string;
+    description?: string;
+    location: string;
+    uploadedBy?: string;
+    size?: number;
+    selectedFile: AttachmentRow;
+}
+export interface RestRepresentationsLink {
+    method?: string;
+    rel?: string;
+    href?: string;
+    uri?: string;
+    type?: string;
+    responseType?: string;
+    itemType?: string;
+    responseItemType?: string;
+    title?: string;
+}
+export interface FileAssociationResponse {
+    version?: number;
+    id?: string;
+    name?: string;
+    category?: string;
+    location?: string;
+    type?: string;
+    size?: number;
+    description?: string;
+    properties?: {
+        [index: string]: any;
+    };
+    uploadedAt?: Date;
+    uploadedBy?: string;
+    extractedContent?: string;
+    displayOrder?: number;
+    links?: RestRepresentationsLink[];
+}
+export interface Comment {
+    category: string;
+    createDate: string;
+    detail: string;
+    id: number;
+    lastUpdatedBy: string;
+    lastUpdatedAt: string;
+    author: {
+        id: string;
+        name: string;
+    };
+}
+export interface DisplayTextFields {
+    name: string;
+    displayIndex: number;
+}
+export {};

package/object/object-api.js

@@ -0,0 +1,13 @@
+export var ConditionReferenceType;
+(function (ConditionReferenceType) {
+    ConditionReferenceType["TemplateControl"] = "TEMPLATE_CONTROL";
+    ConditionReferenceType["Condition"] = "CONDITION";
+    ConditionReferenceType["RequiredField"] = "REQUIRED_FIELD";
+    ConditionReferenceType["ReadOnlyField"] = "READ_ONLY_FIELD";
+    ConditionReferenceType["NldStyling"] = "NLD_STYLING";
+})(ConditionReferenceType || (ConditionReferenceType = {}));
+export var ConditionFactType;
+(function (ConditionFactType) {
+    ConditionFactType["Field"] = "FIELD";
+    ConditionFactType["Condition"] = "CONDITION_REFERENCE";
+})(ConditionFactType || (ConditionFactType = {}));

package/object/package.json

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

package/object/public-api.d.ts

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

package/object/public-api.js

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

package/package.json

@@ -0,0 +1,14 @@
+{
+  "name": "@sassoftware/vi-api",
+  "version": "0.0.29",
+  "files": [
+    "**/*.d.ts",
+    "**/*.js"
+  ],
+  "main": "public-api.js",
+  "types": "public-api.d.ts",
+  "peerDependencies": {
+    "@types/angular": "^1.7.3",
+    "@types/angular-resource": "^1.5.16"
+  }
+}

package/page-admin/package.json

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

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

@@ -0,0 +1,29 @@
+import { Control } from "../control/page";
+export declare enum ApplicationType {
+    Desktop = "desktop",
+    Mobile = "mobile"
+}
+export declare enum TemplateType {
+    Home = "homepage",
+    Page = "page",
+    Print = "print"
+}
+/**
+ * This API provides administration functionality related to pages.
+ * Accessed from the window at window.sas.vi.pageAdmin.
+ */
+export interface PageAdminApi {
+    /**
+     * @method
+     * @description Registers a page designer configuration.
+     * @param name {string} A unique name for the configuration.
+     * @param applicationType {ApplicationType} The name of the app type used for this page. Must be a valid datahub client application (for example, desktop | mobile).
+     * @param templateType {TemplateType} The name of the template type used for this page. Must be a valid datahub template type (for example, home | page).
+     * @param controlGroups {Control[]} The control categories that are displayed in the designer's left hand side toolbox. Must be valid control categories.
+     * @param canvasCssClass {string} A CSS class that is applied to the canvas in the designer.
+     * @param previewCssClass {string} A CSS class that is applied to the preview (for example, template list).
+     * @param options {object} Other designer options: hideSaveAs, customToolbarTemplateUrl, hidePageSettings, hidePreviewGroups.
+     * @param dataTypeControlMappings {Record<string,any>} A mapping between the data type and the control used to generate data tab.
+     */
+    registerPageType(name: string, applicationType: ApplicationType, templateType: TemplateType, controlGroups: Control[], canvasCssClass: string, previewCssClass: string, options: any, dataTypeControlMappings: Record<string, any>): void;
+}

package/page-admin/page-admin-api.js

@@ -0,0 +1,11 @@
+export var ApplicationType;
+(function (ApplicationType) {
+    ApplicationType["Desktop"] = "desktop";
+    ApplicationType["Mobile"] = "mobile";
+})(ApplicationType || (ApplicationType = {}));
+export var TemplateType;
+(function (TemplateType) {
+    TemplateType["Home"] = "homepage";
+    TemplateType["Page"] = "page";
+    TemplateType["Print"] = "print";
+})(TemplateType || (TemplateType = {}));

package/page-admin/public-api.d.ts

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

package/page-admin/public-api.js

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

package/page-model/package.json

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