@sassoftware/vi-api 1.5.0 → 1.9.0

package/alert-reps/index.d.ts

@@ -1,6 +1,6 @@
 /* tslint:disable */
 /* eslint-disable */
-// Generated using typescript-generator version 2.15.527 on 2023-01-24 10:52:40.
+// Generated using typescript-generator version 2.15.527 on 2023-07-07 09:34:28.
 
 export interface ActionRequestRep {
     version?: number;

package/alert-reps/package.json

@@ -0,0 +1,5 @@
+{
+  "name": "@types/alert-reps",
+  "version": "16.0.12",
+  "types": "index.d.ts"
+}

package/component/bindings.d.ts

@@ -4,7 +4,7 @@ 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";
+import { HandleType, MinMaxDates, TimeSliderContextMenuHideOptions, TimeSliderEventDates, TimeSliderRange, TimeSliderRangeChangedEvent } from "../time-slider";
 export interface SearchAndSelectWithPreviewInputBindings {
     initialQuery?: string;
     additionalModes?: QueryMode[];
@@ -77,11 +77,17 @@ export interface TimeSliderInputBindings {
     timeSliderId: string;
     timeSliderDates: TimeSliderEventDates;
     viewRange: TimeSliderRange;
-    isReadOnly: boolean;
-    sliderWidth: number;
+    handleType?: HandleType;
+    isReadOnly?: boolean;
+    sliderWidth?: number;
+    disableSwitchHandleType?: boolean;
+    contextMenuHideOptions: TimeSliderContextMenuHideOptions;
+    minMaxDates?: MinMaxDates;
 }
 export interface TimeSliderBindings extends TimeSliderInputBindings {
-    rangeChangeEvent?: () => void;
+    rangeChangeEvent?: (rangeChangedEvent: TimeSliderRangeChangedEvent) => void;
+    handleTypeChange?: (handleType: HandleType) => void;
+    onLoad?: () => void;
     close?: () => void;
 }
 export declare type SviComponentBindings = ControlCollectionBindings | RelationshipDetailsBindings | SearchInputBindings | PageBindings | SearchAndSelectWithPreviewBindings | TimeSliderBindings;

package/component/index.d.ts

@@ -7,22 +7,23 @@ export declare enum SviComponent {
     SearchAndSelectWithPreview = "svi-search-and-select-with-preview",
     TimeSlider = "svi-time-slider"
 }
-export interface ComponentCreationResult {
+export interface ComponentCreationResult<T> {
     element: HTMLElement;
     destroy: () => void;
     component: Record<string, any>;
+    setComponentInputValue?: (name: keyof T, value: unknown) => void;
 }
 /**
  * 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>;
+    create(component: SviComponent.ControlCollection, target: HTMLElement, bindings?: ControlCollectionBindings): Promise<ComponentCreationResult<ControlCollectionBindings>>;
+    create(component: SviComponent.Page, target: HTMLElement, bindings?: PageBindings): Promise<ComponentCreationResult<PageBindings>>;
+    create(component: SviComponent.RelationshipDetails, target: HTMLElement, bindings?: RelationshipDetailsBindings): Promise<ComponentCreationResult<RelationshipDetailsBindings>>;
+    create(component: SviComponent.SearchInput, target: HTMLElement, bindings?: SearchInputBindings): Promise<ComponentCreationResult<SearchInputBindings>>;
+    create(component: SviComponent.SearchAndSelectWithPreview, target: HTMLElement, bindings?: SearchAndSelectWithPreviewBindings): Promise<ComponentCreationResult<SearchAndSelectWithPreviewBindings>>;
+    create(component: SviComponent.TimeSlider, target: HTMLElement, bindings?: TimeSliderBindings): Promise<ComponentCreationResult<TimeSliderBindings>>;
     /**
      * Dynamically create a SAS Visual Investigator UI component appended to a given target DOM element location.
      *
@@ -30,10 +31,10 @@ export interface ComponentApi {
      * @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.
+     * @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>;
+    create(component: SviComponent, target: HTMLElement, bindings?: SviComponentBindings): Promise<ComponentCreationResult<SviComponentBindings>>;
     /**
      * @method
      * Notifies the application to identify and react to any changes that have been applied.
@@ -43,7 +44,7 @@ export interface ComponentApi {
 }
 /**
  * @callback ComponentApi~afterDetectChanges
- * @description A function to be called after change detection
+ * @description A function to be called after change detection.
  * @returns {void}
  */
 export * from "./bindings";

package/component/index.js

@@ -10,7 +10,7 @@ export var SviComponent;
 })(SviComponent || (SviComponent = {}));
 /**
  * @callback ComponentApi~afterDetectChanges
- * @description A function to be called after change detection
+ * @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/config/config-api.d.ts

@@ -14,6 +14,7 @@ export interface SolutionExtension extends ControlMetadata {
     metadata?: SolutionExtensionMetadata;
     resolvedDisplayName?: string;
     resolvedDescription?: string;
+    clientApplication?: string;
     name: string;
 }
 export interface SolutionExtensionConfigTypeAttributes {
@@ -44,6 +45,18 @@ export interface SolutionExtensionMetadata {
     showInToolbox?: "true" | "false";
     mainDocumentOnly?: boolean;
 }
+export declare type SviDocumentManager = {
+    key: string;
+    displayName: string;
+    onClick: (onFilesAdded: (files: SviLinkedFile[]) => void) => void;
+};
+export interface SviLinkedFile {
+    fileName: string;
+    link: string;
+    type: string;
+    content?: string;
+    size: number;
+}
 /**
  * Functionality related to configuration.
  * Accessed from the window at window.sas.vi.config.
@@ -80,14 +93,20 @@ export interface ConfigApi {
      * @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.
+     * @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.
-     * @returns A Promise that resolves once the solution has been sent to the cache.
+     * @returns A Promise that resolves when the solution has been sent to the cache.
      */
     registerSolutionExtension(config: SolutionExtension): Promise<void>;
+    /**
+     * @method
+     * @description Registers a document manager with the application.
+     * @param config {SviDocumentManager} Document manager configuration.
+     */
+    registerDocumentManager(config: SviDocumentManager): void;
 }

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/control/control-api.d.ts

@@ -1,5 +1,5 @@
 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, SlidingPanelContent, SlidingPanelProperties, TypeAttributes } from "./page";
@@ -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> {
     /**
@@ -127,7 +127,7 @@ export interface ControlApi<ControlTypeAttributes extends TypeAttributes = TypeA
      */
     getAriaLabel: () => string;
     /**
-     * Sets the value of the component specific API
+     * Sets the value of the component specific API.
      * @param componentSpecificApi
      */
     setComponentSpecificApi(componentSpecificApi?: any): void;
@@ -148,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;
     /**
@@ -166,6 +166,21 @@ export interface ControlStateApi {
      * True if the control is hidden, otherwise false.
      */
     readonly hidden: boolean;
+    /**
+     * Returns the masked state of the calling control.
+     * True if the control is masked, otherwise false.
+     */
+    readonly masked: boolean;
+    /**
+     * Returns the authorization state of a masked field of the calling control.
+     * True if the control is masked, otherwise false.
+     */
+    readonly authorizedToUnmask: boolean;
+    /**
+     * Returns the disabled state of the calling control.
+     * True if the control is disabled, otherwise false.
+     */
+    readonly disabled: boolean;
     /**
      * Registers a function to be invoked whenever a state change event occurs.
      * This function receives an object that contains information about the change event.
@@ -187,7 +202,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.
@@ -196,7 +211,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.
@@ -234,7 +249,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;
     /**
@@ -269,6 +284,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
@@ -335,7 +354,7 @@ export interface ControlPageApi extends ControlPageApiBase {
      * 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 [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.
@@ -354,7 +373,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;
@@ -362,18 +381,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>;
     /**
@@ -381,7 +400,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>;
 }
@@ -444,7 +463,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.
@@ -460,3 +479,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/package.json

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

package/control/restrictions.d.ts

@@ -1,4 +1,4 @@
-import { FieldType } from "./data-types";
+import { FieldType, NumberDataType } from "./data-types";
 export interface RequirableRestriction {
     required: boolean;
 }
@@ -16,6 +16,10 @@ export interface NumericRestrictions extends FieldRestrictions {
     scale?: number;
     precision?: number;
 }
+export interface NumberRestrictions extends FieldRestrictions {
+    fieldDataType: NumberDataType;
+    precision?: number;
+}
 export interface ReferenceDataRestrictions extends FieldRestrictions {
     constrainingListName: string;
     cascadingReferenceDataName?: string;

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/event/event-api.d.ts

@@ -16,7 +16,9 @@ export declare enum PageEvents {
     SelectNodeEvent = "spb::selectNode",
     UpdateSubDocumentTypeEvent = "spb::updateSubDocumentType",
     TabSelectedEvent = "spb::tabSelected",
-    VisitAllTabs = "spb::mark-all-tabs-visited"
+    VisitAllTabs = "spb::mark-all-tabs-visited",
+    MaskToggleEvent = "spb::mask-toggle",
+    MaskAllEvent = "spb::mask-all"
 }
 export interface Subscription {
     unsubscribe(): void;

package/event/event-api.js

@@ -18,6 +18,8 @@ export var PageEvents;
     PageEvents["UpdateSubDocumentTypeEvent"] = "spb::updateSubDocumentType";
     PageEvents["TabSelectedEvent"] = "spb::tabSelected";
     PageEvents["VisitAllTabs"] = "spb::mark-all-tabs-visited";
+    PageEvents["MaskToggleEvent"] = "spb::mask-toggle";
+    PageEvents["MaskAllEvent"] = "spb::mask-all";
 })(PageEvents || (PageEvents = {}));
 /**
  * Callback function executed when subscription is triggered by an event.

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/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/http/package.json

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

package/index.d.ts

@@ -20,8 +20,9 @@ import { SheetApi } from "./sheet/sheet-api";
 import { TabApi } from "./tab/tab-api";
 import { ThemeApi } from "./theme/theme-api";
 import { TraversalApi } from "./traversal/traversal-api";
+import { ShellTabsApi } from "./shell-tabs/shell-tabs-api";
 /**
- * Common API Functions
+ * Common API Functions.
  */
 export interface SviCommonApi {
     component: ComponentApi;
@@ -41,6 +42,7 @@ export interface SviCommonApi {
     theme: ThemeApi;
     traversal: TraversalApi;
     config: ConfigApi;
+    shellTabs: ShellTabsApi;
 }
 /**
  * The Client API.
@@ -52,7 +54,7 @@ export interface SviClientApi extends SviCommonApi {
     tab: TabApi;
 }
 /**
- * The Admin API
+ * The Admin API.
  */
 export interface SviAdminApi extends SviCommonApi {
     metadata: AdminMetadataApi;

package/localization/package.json

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

package/metadata/metadata-api.d.ts

@@ -1,3 +1,4 @@
+import { IIdentityOption } from "@sas/nexus-shared-ui/identities/input";
 import { CoreStoredObjectField, Entity, Relationship, RelationshipDTO, StoredObjectDTO } from "../svi-datahub";
 export interface NodeShapeMultipliers {
     square: number;
@@ -28,8 +29,8 @@ export interface SandDataObject extends DataObject {
 }
 export interface DataObject extends PersistableObject {
     name: string;
-    dataStoreName: string;
-    tableName: string;
+    dataStoreName?: string;
+    tableName?: string;
     deleteTableName?: string;
     readOnly: boolean;
     archived: boolean;
@@ -78,6 +79,8 @@ export interface DataObjectField extends PersistableObject, LocalizableObject {
     cascadingReferenceDataName?: string;
     cascadingReferenceDataFilterByCode?: string;
     cascadingReferenceDataFilterByField?: string;
+    masked?: boolean;
+    authorizedToRevealMasked?: IIdentityOption[];
     [index: string]: any;
 }
 export interface LocalizableObject {
@@ -136,16 +139,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>;
     /**
@@ -153,26 +156,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[]>;
     /**
@@ -189,15 +192,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>;
     /**
@@ -212,8 +215,8 @@ export interface MetadataApi {
      * @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/metadata/package.json

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