@sassoftware/vi-api 0.0.29

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

@@ -0,0 +1,126 @@
+import { Control } from "../control/page";
+import { FileOperation, SASObjectAttachedFile } from "../file/file-api";
+import { ObjectFieldRestrictions } from "../object/object-api";
+export declare enum PageMode {
+    Create = "create",
+    Edit = "edit",
+    View = "view",
+    Design = "design"
+}
+export declare const enum ServerPageMode {
+    CREATE = "C",
+    EDIT = "E",
+    VIEW = "V"
+}
+export interface Condition {
+    type: string;
+    parameters: Array<string | number | boolean | Condition>;
+}
+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 PageModelData {
+    [property: string]: any;
+}
+export interface PageModelObjectData {
+    clientApplication: string;
+    data: PageModelData;
+    displayLabel?: string;
+    fieldRestrictions?: ObjectFieldRestrictions;
+    fileRestrictions?: ObjectFieldRestrictions;
+    id?: string;
+    linkedPages?: any[];
+    mode?: PageMode;
+    objectTypeId?: string;
+    objectTypeVersion?: number;
+    serverPageMode?: ServerPageMode;
+    template?: PageTemplate;
+    templateMetadata?: PageTemplateMetadata;
+    toolbar?: {
+        disabled: boolean;
+        items: Control[];
+    };
+    type?: string;
+}
+export interface PageModel extends PageModelObjectData {
+    attachmentCount?: number;
+    disableDragDrop?: boolean;
+    fileOperations?: FileOperation[];
+    isFormSearch?: boolean;
+    isSourceDocument?: boolean;
+    parent?: PageModel;
+    updateData(data: PageModelData | undefined): void;
+    isEditable(): boolean;
+    isInCreateMode(): boolean;
+    isValid(): Promise<boolean>;
+    addFileOperation(operation: string, id: string, data?: SASObjectAttachedFile): void;
+    removeFileOperation(operation: string, id: string): void;
+    removeAllFileOperations(): void;
+    getAllMissingFileCategories(): Promise<string[]>;
+    getAllMissingRequiredFields(): string[];
+    setParentModel(parentModel: PageModel): void;
+    getParentModel(): PageModel;
+    destroy(): void;
+}
+export interface PageTemplate {
+    errors?: boolean;
+    errorDetails?: Error;
+    showTabs: boolean;
+    id?: number;
+    screens: PageTemplateScreen[];
+}
+export interface PageTemplateMetadata {
+    dataSources: PageTemplateMetadataDataSource[];
+    insightsCreationEnabled: boolean;
+    insightsEnabled: boolean;
+    linkedTemplates: any[];
+    resources: {
+        [property: string]: string;
+    };
+    workspaceCreationEnabled: boolean;
+    workspaceEnabled: boolean;
+}
+export interface PageTemplateMetadataDataSource {
+    objectName: string;
+    fields: string[];
+}
+export interface PageTemplateScreen {
+    id: string;
+    name: string;
+    locked?: boolean;
+    childNodes?: Control[];
+}
+/**
+ * This API is used for creating a PageModel object from source data.
+ * Accessed from the window at window.sas.vi.pageModel.
+ */
+export interface PageModelApi {
+    /**
+     * @method
+     * @description Creates a new instance of a PageModel when given the object source.
+     * @param objectSource {PageModelObjectData} Object containing data for the page model.
+     * @param [options] {PageModelApi~CreateFromObjectOptions} Contains a boolean "clone" declaring whether to deep clone the object
+     * when creating the Page Model.
+     * @returns The instance of PageModel
+     */
+    createFromObject(objectSource: PageModelObjectData, options?: {
+        clone?: boolean;
+    }): PageModel;
+}
+/**
+ * @typedef {object} PageModelApi~CreateFromObjectOptions
+ * @property [clone] {boolean} Whether or not to clone the page model data or use the referenced values.
+ */

package/page-model/page-model-api.js

@@ -0,0 +1,11 @@
+export var PageMode;
+(function (PageMode) {
+    PageMode["Create"] = "create";
+    PageMode["Edit"] = "edit";
+    PageMode["View"] = "view";
+    PageMode["Design"] = "design";
+})(PageMode || (PageMode = {}));
+/**
+ * @typedef {object} PageModelApi~CreateFromObjectOptions
+ * @property [clone] {boolean} Whether or not to clone the page model data or use the referenced values.
+ */

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

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

package/page-model/public-api.js

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

package/page-state/package.json

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

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

@@ -0,0 +1,59 @@
+/**
+ * SAS Visual Investigator API's representation of a UI-Router state.
+ * Accessed from the window at window.sas.vi.pageState.
+ */
+export interface StateObject {
+    /** The parent StateObject. */
+    parent: StateObject;
+    /** Name used to register the state. */
+    name: string;
+    /** Parent StateObject array from this state up to the root. */
+    path: StateObject[];
+    data: any;
+    /**
+     * An object containing the parent States' names as keys and
+     * true as their values.
+     */
+    includes: {
+        [name: string]: boolean;
+    };
+    /**
+     * Function to return the root node of this state's tree.
+     *
+     * @returns The root of this state's tree.
+     */
+    root(): StateObject;
+    toString(): string;
+}
+/**
+ * This API provides functionality that pertains to the page state.
+ * Accessed from the window at window.sas.vi.pageState.
+ */
+export interface PageStateApi {
+    /**
+     * @method
+     * @description Returns the state of the current page.
+     * @returns An object containing the page state data or undefined if no page exists.
+     */
+    getCurrent(): StateObject | undefined;
+    /**
+     * @method
+     * @description Returns the state of the page matching the ID.
+     * @param id {string | number} Page ID for which the state will be returned.
+     * @returns An object containing the page state data or undefined if the ID doesn't exist.
+     */
+    get(id: string | number): StateObject | undefined;
+    /**
+     * @method
+     * @description Creates a page state.
+     * @param id {string | number} Page ID to be created.
+     * @param state {StateObject} Object containing the state data required to create the page.
+     */
+    add(id: string | number, state: StateObject): void;
+    /**
+     * @method
+     * @description Deletes a page state.
+     * @param id {string | number} ID of the page to be deleted.
+     */
+    remove(id: string | number): void;
+}

package/page-state/page-state-api.js

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

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

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

package/page-state/public-api.js

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

package/property/package.json

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

package/property/property-api.d.ts

@@ -0,0 +1,46 @@
+import { Control } from "../control/page";
+import { TypeAttributes } from "../object/object-api";
+import { PageTemplateMetadata } from "../page-model/page-model-api";
+export interface ToolbarPropertyControl {
+    typeAttributes: TypeAttributes;
+}
+export interface PropertyConfig {
+    [property: string]: any;
+    order?: number;
+    required?: boolean;
+    type: string;
+}
+/**
+ * This API provides the  utility or miscellaneous functionality in SAS Visual Investigator.
+ * Accessed from the window at window.sas.vi.property.
+ */
+export interface PropertyApi {
+    /**
+     * @method
+     * @description Registers a custom element to be rendered as the property editor.
+     * The element is rendered as a custom web component.
+     * The element is passed selectedNode, property, propertyKey and categoryKey as attributes.
+     * Throws a console error if the type is already used by another registered editor.
+     * @param elementName {string} Element to be rendered. For example "custom-editor" renders an element with the tag name "custom-editor".
+     * @param type {string} A custom type that is expected to be unique among registered editors.
+     * @param [validatorFn] {PropertyApi~isPropertyEditorValid} Function to provide custom logic for determining if the editor is valid.
+     * @param [metadataFn] {PropertyApi~getPropertyEditorMetadata} Function to provide custom metadata.
+     */
+    registerCustomEditor(elementName: string, type: string, validatorFn?: (propertyConfig: PropertyConfig, propertyKey: string, control: Control | ToolbarPropertyControl) => boolean, metadataFn?: (propertyConfig: PropertyConfig, propertyKey: string, control: Control | ToolbarPropertyControl) => PageTemplateMetadata): void;
+}
+/**
+ * Determines whether or not the property editor is valid.
+ * @callback PropertyApi~isPropertyEditorValid
+ * @param {PropertyConfig} propertyConfig Configuration details relating to the custom property type. For example, required, type and so on.
+ * @param {string} propertyKey Key where this property's value is stored.
+ * @param {Control | ToolbarPropertyControl} control The control.
+ * @returns {boolean} true if valid, false if not.
+ */
+/**
+ * Get metadata for the property editor.
+ * @callback PropertyApi~getPropertyEditorMetadata
+ * @param {PropertyConfig} propertyConfig Configuration details relating to the custom property type. For example, required, type and so on.
+ * @param {string} propertyKey Key where this property's value is stored.
+ * @param {Control | ToolbarPropertyControl} control The control.
+ * @returns {PageTemplateMetadata}
+ */

package/property/property-api.js

@@ -0,0 +1,17 @@
+export {};
+/**
+ * Determines whether or not the property editor is valid.
+ * @callback PropertyApi~isPropertyEditorValid
+ * @param {PropertyConfig} propertyConfig Configuration details relating to the custom property type. For example, required, type and so on.
+ * @param {string} propertyKey Key where this property's value is stored.
+ * @param {Control | ToolbarPropertyControl} control The control.
+ * @returns {boolean} true if valid, false if not.
+ */
+/**
+ * Get metadata for the property editor.
+ * @callback PropertyApi~getPropertyEditorMetadata
+ * @param {PropertyConfig} propertyConfig Configuration details relating to the custom property type. For example, required, type and so on.
+ * @param {string} propertyKey Key where this property's value is stored.
+ * @param {Control | ToolbarPropertyControl} control The control.
+ * @returns {PageTemplateMetadata}
+ */

package/property/public-api.d.ts

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

package/property/public-api.js

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

package/public-api.d.ts

@@ -0,0 +1 @@
+export { SviClientApi, SviAdminApi, SviWindow } from "./index";

package/public-api.js

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

package/reference-data/package.json

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

package/reference-data/public-api.d.ts

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

package/reference-data/public-api.js

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

package/reference-data/refData.d.ts

@@ -0,0 +1,72 @@
+import { PersistableObject } from "../metadata/metadata-api";
+export interface ReferenceList extends ReferenceListBase {
+    maxCodeLength: number;
+    archived: boolean;
+    type?: string;
+    localizedLabels?: LocalizedLabel[];
+    items: ReferenceListItem[];
+    alphabeticalSort: boolean;
+    hierarchyLevel?: number;
+    referenceListType?: string;
+    usedByField?: boolean;
+}
+export interface ReferenceListBase {
+    id?: string | number;
+    name: string;
+    label: string;
+    referenceListType?: string;
+    localizedLabels?: LocalizedLabel[];
+}
+export interface ReferenceListItem {
+    id?: string | number;
+    label: string;
+    code: string;
+    localizedLabels?: LocalizedLabel[];
+    archived?: boolean;
+    displayIndex?: number;
+    parentCode?: string;
+    newItem?: boolean;
+    hasChildren?: boolean;
+}
+export interface HierarchicalList extends ReferenceListBase {
+    levels: ReferenceList[];
+}
+export interface LocalizedLabel extends PersistableObject {
+    localeCd: string;
+    label: string;
+}
+/**
+ * This API provides functionality related to retrieving reference data.
+ * Accessed from the window at window.sas.vi.refData.
+ *
+ */
+export interface RefDataApi {
+    /**
+     * @method
+     * @description Gets all reference data lists.
+     * @returns Promise containing the array of reference data lists.
+     */
+    getReferenceLists(): Promise<ReferenceList[]>;
+    /**
+     * @method
+     * @description Gets all reference data hierarchies.
+     * @returns Promise containing the array of reference data hierarchies.
+     */
+    getReferenceHierarchies(): Promise<HierarchicalList[]>;
+    /**
+     * @method
+     * @description Gets reference data list with the given name.
+     * @param name {string} Name of the reference data list.
+     * @param [includeArchived] {boolean} Boolean to determine if an archived list can be returned.
+     * @returns Promise containing the reference data list.
+     */
+    getReferenceList(name: string, includeArchived?: boolean): Promise<ReferenceList>;
+    /**
+     * @method
+     * @description Gets reference data hierarchy with the given name.
+     * @param name {name} Name of the reference data hierarchy.
+     * @param [includeArchived] {boolean} Boolean to determine if an archived hierarchy can be returned.
+     * @returns Promise containing the reference data hierarchy.
+     */
+    getReferenceHierarchy(name: string, includeArchived?: boolean): Promise<HierarchicalList>;
+}

package/reference-data/refData.js

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

package/resource/package.json

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

package/resource/public-api.d.ts

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

package/resource/public-api.js

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

package/resource/resource-api.d.ts

@@ -0,0 +1,17 @@
+export interface I18nResources {
+    [key: string]: string | I18nResources;
+}
+/**
+ * This API provides the resource functionality in SAS Visual Investigator.
+ * Accessed from the window at window.sas.vi.resource.
+ */
+export interface ResourceApi {
+    /**
+     * @method
+     * @description 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;
+}

package/resource/resource-api.js

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

package/score-reps/index.d.ts

@@ -0,0 +1,133 @@
+/* tslint:disable */
+/* eslint-disable */
+// Generated using typescript-generator version 2.15.527 on 2022-01-30 09:29:49.
+
+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": "2.3.63",
+  "types": "index.d.ts"
+}