@sassoftware/vi-api 0.0.29 → 1.7.1

package/control/control-api.d.ts

@@ -1,8 +1,8 @@
 import { FileChange, SASObjectAttachedFile, SASUploadedFile } from "../file/file-api";
-import { PageMode, PageModel } from "../page-model/page-model-api";
+import { PageEventsApiBase, PageMode, PageModel } from "../page-model/page-model-api";
 import { FieldType, FieldTypeToValue } from "./data-types";
 import { PageDataChange, PageModeChange, StateChange } from "./events";
-import { Control, RefreshablePageControlOptions, SlidingPanelProperties, TypeAttributes } from "./page";
+import { Control, RefreshablePageControlOptions, SlidingPanelContent, SlidingPanelProperties, TypeAttributes } from "./page";
 import { FieldTypeToRestrictions, FileRestrictions } from "./restrictions";
 import { AttachmentFormData } from "./file";
 /**
@@ -24,7 +24,7 @@ export interface ControlMemberApiBase<ControlTypeAttributes extends TypeAttribut
  */
 export interface ControlMemberApi<ControlTypeAttributes extends TypeAttributes = TypeAttributes, ControlFieldType extends FieldType = any> extends ControlMemberApiBase<ControlTypeAttributes, ControlFieldType> {
     /**
-     * Methods related to this control
+     * Methods related to this control.
      */
     readonly control: ControlApi<ControlTypeAttributes, ControlFieldType>;
     /**
@@ -37,7 +37,7 @@ export interface ControlMemberApi<ControlTypeAttributes extends TypeAttributes =
     readonly admin: ControlAdminApi;
 }
 /**
- * This Control API pertains functionality that checks the state, registers event handlers and so on.
+ * This Control API pertains to functionality that checks the state, registers event handlers, and so on.
  */
 export interface ControlApiBase<ControlTypeAttributes extends TypeAttributes = TypeAttributes, ControlFieldType extends FieldType = never> {
     /**
@@ -126,6 +126,11 @@ export interface ControlApi<ControlTypeAttributes extends TypeAttributes = TypeA
      * @returns The aria label that should be applied.
      */
     getAriaLabel: () => string;
+    /**
+     * Sets the value of the component specific API.
+     * @param componentSpecificApi
+     */
+    setComponentSpecificApi(componentSpecificApi?: any): void;
 }
 /**
  * Methods and properties related to the state of the control.
@@ -143,7 +148,7 @@ export interface ControlStateApi {
     readonly required: boolean;
     /**
      * Checks if the current controls should allow input.
-     * Returns True if the control allows input, otherwise false.
+     * Returns true if the control allows input, otherwise false.
      */
     readonly allowInput: boolean;
     /**
@@ -182,7 +187,7 @@ export interface ControlStateApi {
 export interface ControlPageFieldApi {
     /**
      * Sets the value of the supplied field.
-     * This works only with fields for the current object for which the control is associated.
+     * This works only with fields for the current object with which the control is associated.
      * For example, if the control is on a parent object, you cannot set a child's field.
      * @method
      * @param value {FieldTypeToValue<Type>} New field value.
@@ -191,7 +196,7 @@ export interface ControlPageFieldApi {
     setFieldValue<Type extends FieldType>(value: FieldTypeToValue<Type>, field: string): void;
     /**
      * Returns the value of the supplied field.
-     * This works only with fields for the current object for which the control is associated with.
+     * This works only with fields for the current object with which the control is associated.
      * For example, if the control is on a parent object, you cannot get a child's field.
      * @method
      * @template {FieldType} File type.
@@ -229,7 +234,7 @@ export interface ControlPageApiBase {
      */
     readonly isExternalObject: boolean;
     /**
-     * Checks if the page is a home page.
+     * Checks if the page is a Home page.
      */
     readonly isHomepage: boolean;
     /**
@@ -264,6 +269,10 @@ export interface ControlPageApi extends ControlPageApiBase {
      * Methods related to the files associated with the page.
      */
     file: ControlFileApi;
+    /**
+     * Methods related to the hookable events associated with the page.
+     */
+    events: ControlPageEventsApi;
     /**
      * Returns the model of the page in which the calling control resides.
      * @method
@@ -275,9 +284,9 @@ export interface ControlPageApi extends ControlPageApiBase {
      * @method
      * @param handler {function} Function to be invoked on property change.
      * Parameters are (category: string, property: string, currentValue: any, previousValue: any).
-     * Returns void.
+     * @returns A function that stops the handler from being invoked.
      */
-    onPropertyChange(handler: (category: string, property: string, currentValue: any, previousValue: any) => void): void;
+    onPropertyChange(handler: (category: string, property: string, currentValue: any, previousValue: any) => void): () => void;
     /**
      * Returns the disabled status of the page toolbar.
      * @method
@@ -312,25 +321,32 @@ export interface ControlPageApi extends ControlPageApiBase {
      * By default, attempts to refresh all controls.
      * Specify categoryToRefresh or controlToRefresh to restrict what is refreshed.
      * @method
-     * @param categoryToRefresh {(string|undefined)} Name of the category to be refreshed.
+     * @param [categoryToRefresh] {(string|undefined)} Name of the category to be refreshed.
      * @param [controlToRefresh] {Control} Individual control to be refreshed.
      */
-    reloadRefreshableControls(categoryToRefresh: string | undefined, controlToRefresh: Control): void;
+    reloadRefreshableControls(categoryToRefresh?: string, controlToRefresh?: Control): void;
     /**
      * Sets a page to be dirty, that is, when it has been edited and not saved.
      * @method
      */
     setPageDirty(): void;
+    /**
+     * Gets the dirty state of the page.
+     * @method
+     */
+    getPageDirty(): boolean | undefined;
     /**
      * Toggle the page-level sliding panel. This panel should be used to contain information that is
      * supplementary to the document, for example attachments or workflow tasks.
      * @method
-     * @param sectionLabel {string} Describes the section, this should be internationalised.
-     * @param contentUrl {string} Contains the template URL of the contents to be ng-included.
-     * @param [panelProperties] {SlidingPanelProperties} Properties that are exposed to the template from the caller.
+     * @param [sectionLabel] {string} Describes the section, this should be internationalized.
+     * @param [content] {SlidingPanelContent} The content of the sliding panel.
+     * @param [panelProperties] {SlidingPanelProperties} Properties for the panel.
+     *      When providing a url for content: the panel properties will be available on the controller's "slidingPanel" object.
+     *      When providing a selector for content: the properties will be set on the element to be created.
      * @param [onClose] {function} A callback function invoked when the panel is dismissed. There are no parameters. Returns void.
      */
-    toggleSlidingPanel(sectionLabel: string, contentUrl: string, panelProperties?: SlidingPanelProperties, onClose?: () => void): void;
+    toggleSlidingPanel<T>(sectionLabel?: string, content?: SlidingPanelContent<T>, panelProperties?: SlidingPanelProperties, onClose?: () => void): void;
     /**
      * Checks if a page is in edit mode.
      * @method
@@ -342,7 +358,7 @@ export interface ControlPageApi extends ControlPageApiBase {
      * If the user has not saved, the user is prompted to do so.
      * @method
      * @param closeTab {boolean} Checks if the tab should close after edit mode is cancelled.
-     * @returns A promise that resolves once the edit has been cancelled.
+     * @returns A Promise that resolves when the edit has been cancelled.
      */
     cancelEdit(closeTab: boolean): Promise<{
         userSaved: boolean;
@@ -350,18 +366,18 @@ export interface ControlPageApi extends ControlPageApiBase {
     /**
      * Sets the page to be in edit mode. Used when clicking the Edit button.
      * @method
-     * @returns A promise that resolves when the page is put in edit mode.
+     * @returns A Promise that resolves when the page is put in edit mode.
      */
     edit(): Promise<any>;
     /**
-     * Refreshes the attachments grid to display new attachments when new attachment is uploaded.
+     * Refreshes the attachments grid to display new attachments when a new attachment is uploaded.
      * @method
      */
     refreshAttachments(): void;
     /**
      * Reloads an instance of a page.
      * @method
-     * @returns A promise that resolves when the page is reloaded.
+     * @returns A Promise that resolves when the page is reloaded.
      */
     reloadPage(): Promise<void>;
     /**
@@ -369,7 +385,7 @@ export interface ControlPageApi extends ControlPageApiBase {
      * @method
      * @param stopEditing {boolean} Checks if the page should leave edit mode after it is saved.
      * @param closeObject {boolean} Checks if the page should be closed after it is saved.
-     * @returns A promise which resolves when the page has been saved.
+     * @returns A Promise which resolves when the page has been saved.
      */
     save(stopEditing: boolean, closeObject: boolean): Promise<void>;
 }
@@ -432,7 +448,7 @@ export interface ControlFileApi extends ControlFileApiBase {
      */
     updateFile(updatedFile: SASUploadedFile): Promise<void>;
     /**
-     * Create a file operation to remove a file with a given ID.
+     * Creates a file operation to remove a file with a given ID.
      *
      * @method
      * @param {string} id The ID of the file to remove.
@@ -448,3 +464,9 @@ export interface ControlFileApi extends ControlFileApiBase {
      */
     onChange(handler: (change: FileChange) => void): void;
 }
+/**
+ * Equivalent to {@link PageEventsApiBase} with the exception that event hooks will be scoped to the page on which the calling control resides.
+ * @extends PageEventsApiBase
+ */
+export interface ControlPageEventsApi extends PageEventsApiBase {
+}

package/control/data-types.d.ts

@@ -6,4 +6,9 @@ export interface UserGroup {
     type: "user" | "group";
 }
 export declare type FieldTypeToValue<Type extends FieldType> = Type extends "BOOLEAN" ? boolean : Type extends "STRING" | DateDataType | "REFERENCEDATA" ? string : Type extends NumberDataType ? number : Type extends "JSON" ? object : Type extends "USER_GROUP" ? UserGroup[] : never;
-export declare type FieldValue = undefined | string | number | boolean | object | UserGroup;
+export declare type FieldValue = undefined | string | number | boolean | object | UserGroup | Date | ChildObject[] | null;
+export declare type ChildObject = {
+    id?: string;
+    isNew?: boolean;
+    fieldValues: Record<string, FieldValue>;
+};

package/control/page.d.ts

@@ -1,3 +1,4 @@
+import { Type } from "@angular/core";
 export declare const enum PageModeEvent {
     CREATE = "create",
     EDIT = "edit",
@@ -49,6 +50,19 @@ export interface GlobalControlStates {
 export interface SlidingPanelProperties {
     [property: string]: any;
 }
+/**
+ * Represents the content of a sliding panel.
+ */
+export interface SlidingPanelContent<T> {
+    /**
+     * The name of a custom element to be created in the content pane.
+     */
+    customElementName?: string;
+    /**
+     * An Angular component to be included in the content pane.
+     */
+    instanceClass?: Type<T>;
+}
 export interface RefreshablePageControlOptions {
     refreshCategory?: string;
     requiresIndex?: boolean;

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

@@ -10,7 +10,8 @@ export interface ToolbarPropertyApi {
          * Registers a function to be invoked whenever one of the calling toolbar control's properties change.
          * @method
          * @param handler The function to be invoked.
+         * @returns A function that stops the handler from being invoked.
          */
-        onPropertyChange(handler: (category: string, property: string, currentValue: any, previousValue: any) => void): void;
+        onPropertyChange(handler: (category: string, property: string, currentValue: any, previousValue: any) => void): () => void;
     };
 }

package/event/event-api.d.ts

@@ -8,6 +8,7 @@ export declare enum PageEvents {
     ModeChangeEvent = "spb::page-mode-change",
     ModelChangeEvent = "spb::page-model-change",
     PanelOpenEvent = "spb::sliding-panel-open",
+    RefreshAttachmentsGrid = "spb::refreshAttachmentsGrid",
     RefreshPageEvent = "spb::refreshPage",
     SelectAttachmentEvent = "spb::Highlighting:SelectAttachment",
     SelectChildObjectEvent = "spb::Highlighting:SelectChildObject",

package/event/event-api.js

@@ -9,6 +9,7 @@ export var PageEvents;
     PageEvents["ModeChangeEvent"] = "spb::page-mode-change";
     PageEvents["ModelChangeEvent"] = "spb::page-model-change";
     PageEvents["PanelOpenEvent"] = "spb::sliding-panel-open";
+    PageEvents["RefreshAttachmentsGrid"] = "spb::refreshAttachmentsGrid";
     PageEvents["RefreshPageEvent"] = "spb::refreshPage";
     PageEvents["SelectAttachmentEvent"] = "spb::Highlighting:SelectAttachment";
     PageEvents["SelectChildObjectEvent"] = "spb::Highlighting:SelectChildObject";

package/index.d.ts

@@ -21,7 +21,7 @@ import { TabApi } from "./tab/tab-api";
 import { ThemeApi } from "./theme/theme-api";
 import { TraversalApi } from "./traversal/traversal-api";
 /**
- * Common API Functions
+ * Common API Functions.
  */
 export interface SviCommonApi {
     component: ComponentApi;
@@ -52,7 +52,7 @@ export interface SviClientApi extends SviCommonApi {
     tab: TabApi;
 }
 /**
- * The Admin API
+ * The Admin API.
  */
 export interface SviAdminApi extends SviCommonApi {
     metadata: AdminMetadataApi;

package/metadata/metadata-api.d.ts

@@ -24,6 +24,7 @@ export interface SandDataObject extends DataObject {
     attachmentsIndexedForSearch?: boolean;
     resolvedEntity?: boolean;
     indexedForSearch?: boolean;
+    requireSearchBeforeCreate?: boolean;
 }
 export interface DataObject extends PersistableObject {
     name: string;
@@ -135,16 +136,16 @@ export interface ReferenceDataOptions {
 export interface MetadataApi {
     /**
      * @method
-     * @description Gets create, read and update access rights for an entity.
+     * @description Gets create, read, and update access rights for an entity.
      * @param objectType {string} Entity name.
-     * @returns Object with a promise of type boolean for each rule.
+     * @returns Object with a Promise of type boolean for each rule.
      */
     getEntityAccessRules(objectType: string): EntityAccessRules;
     /**
      * @method
      * @description Checks access rights and gets metadata for an entity. Returns undefined if the entity does not exist.
      * @param objectType {string} Entity name.
-     * @returns A promise containing the entity metadata.
+     * @returns A Promise containing the entity metadata.
      */
     getEntity(objectType: string): Promise<StoredObjectDTO | undefined>;
     /**
@@ -152,26 +153,26 @@ export interface MetadataApi {
      * @description Gets metadata for an entity field.
      * @param objectType {string} Entity name.
      * @param fieldName {string} Field name.
-     * @returns A promise containing the field metadata.
+     * @returns A Promise containing the field metadata.
      */
     getField(objectType: string, fieldName: string): Promise<CoreStoredObjectField>;
     /**
      * @method
      * @description Gets managed entity types.
-     * @returns A promise containing an array of managed entity types
+     * @returns A Promise containing an array of managed entity types.
      */
     getManagedEntityTypes(): Promise<StoredObjectDTO[]>;
     /**
      * @method
      * @description Gets root type entities that are not child types.
-     * @returns A promise containing an array of root types
+     * @returns A Promise containing an array of root types.
      */
     getRootTypes(): Promise<StoredObjectDTO[]>;
     /**
      * @method
      * @description Gets child entity types for a given entity.
      * @param objectType {string} Checks for children for the named entity.
-     * @returns A promise containing an array of child entity types or an empty list if none are found.
+     * @returns A Promise containing an array of child entity types or an empty list if none are found.
      */
     getChildEntityTypes(objectType: string): Promise<StoredObjectDTO[]>;
     /**
@@ -188,15 +189,15 @@ export interface MetadataApi {
     getAllValidRelationshipTypes(objectType: string, relationshipObjectType?: string, relationshipName?: string): Promise<ValidRelationshipTypes>;
     /**
      * @method
-     * @description Gets metadata for all resolved entities
-     * @returns A promise containing an array of the resolved entities metadata.
+     * @description Gets metadata for all resolved entities.
+     * @returns A Promise containing an array of the resolved entities metadata.
      */
     getResolvedEntities(): Promise<Entity[]>;
     /**
      * @method
      * @description Gets metadata for a resolved entity.
      * @param objectType {string} Resolved Entity Name.
-     * @returns A promise containing resolved entity metadata or undefined if none exists.
+     * @returns A Promise containing resolved entity metadata or undefined if none exists.
      */
     getResolvedEntityMetadata(objectType: string): Promise<Entity | undefined>;
     /**
@@ -208,9 +209,11 @@ export interface MetadataApi {
      */
     getIconForEntity(objectType: string, iconType?: string): string | undefined;
     /**
+     * @deprecated Use `getRootTypes()` and `getResolvedEntities()` instead.
+     *
      * @method
-     * @description Gets metadata for both entities and resolved entities
-     * @returns A promise resolving to Search entity metadata.
+     * @description Gets metadata for both entities and resolved entities.
+     * @returns A Promise resolving to Search entity metadata.
      */
     getSearchMetadata(): Promise<EntityMetadata>;
     /**

package/object/object-api.d.ts

@@ -1,4 +1,4 @@
-import { Relationship, StoredObjectFieldDTO } from "../svi-datahub";
+import { Relationship, StoredObjectFieldDTO, Comment } from "../svi-datahub";
 import { FileOperation } from "../file/file-api";
 import { PageModel } from "../page-model/page-model-api";
 import { ClientSheet, Sheet } from "../sheet/sheet-api";
@@ -16,11 +16,11 @@ export interface FormatObjectFieldsOptions {
     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
+     * 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;
 }
@@ -69,7 +69,7 @@ export interface ObjectApi {
      * @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.
+     * @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[]>;
     /**
@@ -77,36 +77,36 @@ export interface ObjectApi {
      * @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 objectTypeId {number} 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.
+     * @return A Promise that resolves to the updated object when the object has successfully been updated.
      */
-    updateObject(objectType: string, objectId: string, objectTypeId: string, objectTypeVersion: number, fieldValues: FieldValues, options?: UpdateObjectOptions): Promise<VIObject>;
+    updateObject(objectType: string, objectId: string, objectTypeId: number, 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.
+     * @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 objectTypeId {number} 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.
+     * @return A Promise that resolves to the created object when the object has successfully been created.
      */
-    createObject(objectType: string, objectTypeId: string, fieldValues: FieldValues, options?: CreateObjectOptions): Promise<VIObject>;
+    createObject(objectType: string, objectTypeId: number, 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.
+     * @return A Promise that resolves to a relationship.
      */
     getObjectRelationship(relationshipId: string): Promise<ObjectRelationship>;
     /**
@@ -114,14 +114,14 @@ export interface ObjectApi {
      * @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.
+     * @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.
+     * @return A Promise that resolves to void when the object is successfully deleted.
      */
     deleteObjectRelationship(relationshipId: string): Promise<void>;
     /**
@@ -130,7 +130,7 @@ export interface ObjectApi {
      * @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.
+     * @return A Promise that resolves to an object.
      */
     relateObject(from: VIObject, to: VIObject, relationship: ObjectRelationship): Promise<ObjectRelationship>;
     /**
@@ -147,7 +147,7 @@ export interface ObjectApi {
      * @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.
+     * @return A Promise that resolves to a newly created relationship.
      */
     createAndRelateObject(from: VIObject, to: VIObject, relationship: ObjectRelationship): Promise<ObjectRelationship>;
     /**
@@ -156,7 +156,7 @@ export interface ObjectApi {
      * @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.
+     * @return A Promise that resolves to the formatted array of objects.
      */
     formatObjectFieldsForDisplay(objects: VIObject[], objectType: string, options?: FormatObjectFieldsOptions): Promise<VIObject[]>;
     /**
@@ -165,7 +165,7 @@ export interface ObjectApi {
      * @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.
+     * @return A Promise that resolves to a HttpResponse with a FileAssociationResponse as the data.
      */
     uploadAttachment(attachmentModel: AttachmentModel, objectType: string, objectId: string): Promise<FileAssociationResponse>;
     /**
@@ -174,21 +174,21 @@ export interface ObjectApi {
      * @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.
+     * @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 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.
+     * @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.
+     * @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.
@@ -219,10 +219,11 @@ export interface VIObject {
     createdAt: string;
     displayLabel?: string;
     lastUpdatedAt: string;
-    objectTypeId: string;
+    objectTypeId: number;
     objectTypeName: string;
     sheets?: Sheet[];
     id: string;
+    title?: string;
 }
 export interface ValidationResult {
     isValid: boolean;
@@ -441,10 +442,10 @@ export interface ObjectRelationship {
     qualifiedTypeName?: string;
 }
 export interface AttachmentRow {
-    description: string;
+    description?: string;
     location: string;
     id: string;
-    uploadedBy: string;
+    uploadedBy?: string;
     name: string;
     size: number;
     type: string;
@@ -488,18 +489,6 @@ export interface FileAssociationResponse {
     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;

package/package.json

@@ -1,9 +1,32 @@
 {
   "name": "@sassoftware/vi-api",
-  "version": "0.0.29",
+  "version": "1.7.1",
+  "description": "Types used in the SAS Visual Investigator API",
+  "keywords": [
+    "SAS",
+    "VI",
+    "Visual Investigator",
+    "solution",
+    "extension",
+    "angular",
+    "API",
+    "types"
+  ],
+  "homepage": "https://github.com/sassoftware/vi-solution-extensions",
+  "bugs": {
+    "url": "https://github.com/sassoftware/vi-solution-extensions/issues"
+  },
+  "license": "SEE LICENSE IN LICENSE.txt",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/sassoftware/vi-solution-extensions"
+  },
   "files": [
     "**/*.d.ts",
-    "**/*.js"
+    "**/*.js",
+    "**/package.json",
+    "./README.md",
+    "./LICENSE.txt"
   ],
   "main": "public-api.js",
   "types": "public-api.d.ts",

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

@@ -17,8 +17,8 @@ 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 applicationType {ApplicationType} The name of the app type used for this page. Must be a valid datahub client application (for example, "desktop" or "mobile").
+     * @param templateType {TemplateType} The name of the template type used for this page. Must be a valid datahub template type (for example, "home" or "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).