@sassoftware/vi-api 1.40.3 → 1.42.0

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

@@ -5,8 +5,12 @@ export interface FieldTypeLabels {
 /**
  * {@link MetadataApi} extension provides the functionality related to retrieval of metadata.
  * Additional methods are available only in the SAS Visual Investigator Manage and Investigate interface.
- * Accessed from the window at window.sas.vi.metadata.
+ *
+ * Accessed from the window at `window.sas.vi.metadata`.
+ *
  * @extends MetadataApi
+ * @example window.sas.vi.metadata.getFieldDataTypeLabels();
+ * @category API
  */
 export interface AdminMetadataApi extends MetadataApi {
     /**

package/metadata/admin/index.d.ts

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

package/metadata/admin/index.js

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

package/metadata/metadata-api.d.ts

@@ -147,7 +147,11 @@ export interface ReferenceDataOptions {
 }
 /**
  * This API provides the functionality related to retrieval of metadata.
- * Accessed from the window at window.sas.vi.metadata.
+ *
+ * Accessed from the window at `window.sas.vi.metadata`.
+ *
+ * @example window.sas.vi.metadata.getEntityAccessRules(objectType);
+ * @category API
  */
 export interface MetadataApi {
     /**
@@ -160,7 +164,7 @@ export interface MetadataApi {
     /**
      * @method
      * @description Gets create, read, and update access rights for the provided entities via batch call.
-     * @param objectType {string[]} Entity names.
+     * @param {string[]} objectTypes Entity names.
      * @returns Object with a Promise of type EntityAccessRule[] for each rule, where EntityAccessRule maps to the access rule of a given entity name.
      */
     getEntitiesAccessRules(objectTypes: string[]): EntitiesAccessRules;
@@ -233,7 +237,7 @@ export interface MetadataApi {
      */
     getIconForEntity(objectType: string, iconType?: string): string | undefined;
     /**
-     * @deprecated Use `getRootTypes()` and `getResolvedEntities()` instead.
+     * @deprecated Use [getRootTypes()]{@link getRootTypes} and [getResolvedEntities()]{@link getResolvedEntities}` instead.
      *
      * @method
      * @description Gets metadata for both entities and resolved entities.
@@ -243,8 +247,8 @@ export interface MetadataApi {
     /**
      * @method
      * @description Gets reference data with the given name.
-     * @param refDataName {string} Reference data list name.
-     * @param [options] {ReferenceDataOptions} Object containing name and filter constraints.
+     * @param {string} name Reference data list name.
+     * @param {ReferenceDataOptions} [options] Object containing name and filter constraints.
      * If constrainingListName is defined, then the refDataName parameter is ignored.
      * parentCode is used to filter list items to those that are children of this list name.
      * @returns Promise containing the reference data or undefined if none exists.

package/metadata/package.json

@@ -4,6 +4,6 @@
         "**/*.d.ts",
         "**/*.js"
     ],
-    "main": "public-api.js",
-    "types": "public-api.d.ts"
+    "main": "index.js",
+    "types": "index.d.ts"
 }

package/object/object-api.d.ts

@@ -36,7 +36,11 @@ export interface CreateObjectOptions {
 }
 /**
  * This API provides the functionality related to objects within SAS Visual Investigator.
- * Accessed from the window at window.sas.vi.object.
+ *
+ * Accessed from the window at `window.sas.vi.object`.
+ *
+ * @example window.sas.vi.object.getObjectAccessRules(objectType, objectId);
+ * @category API
  */
 export interface ObjectApi {
     /**
@@ -211,8 +215,8 @@ export interface ObjectApi {
     /**
      * @method
      * @description Validates the fields, controls, and file categories of a child object.
-     * @param pageModel {PageModel} Page model.
-     * @param childObject {StoredObjectMetadata} Child object metadata.
+     * @param {PageModel} model Page model.
+     * @param {StoredObjectMetadata} childObject Child object metadata.
      * @return An observable that resolves to an array of validation results.
      */
     validate(model: PageModel, childObject: StoredObjectMetadata): Promise<ValidationResult[]>;
@@ -547,10 +551,10 @@ export interface CreateDialogModel extends CreateRelationshipDialogModel<CreateD
 export interface CreateDialogResponse {
     relateToModel?: CreateRelateToModel;
 }
-export interface CreateReleationshipDialogResultModel {
+export interface CreateRelationshipDialogResultModel {
     linkReason?: Relationship;
 }
-export interface CreateRelateToModel extends CreateReleationshipDialogResultModel {
+export interface CreateRelateToModel extends CreateRelationshipDialogResultModel {
     newPageModel?: {
         model: PageModel;
     };

package/object/package.json

@@ -4,6 +4,6 @@
         "**/*.d.ts",
         "**/*.js"
     ],
-    "main": "public-api.js",
-    "types": "public-api.d.ts"
+    "main": "index.js",
+    "types": "index.d.ts"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sassoftware/vi-api",
-  "version": "1.40.3",
+  "version": "1.42.0",
   "description": "Types used in the SAS Visual Investigator API",
   "keywords": [
     "SAS",
@@ -28,8 +28,8 @@
     "./README.md",
     "./LICENSE.txt"
   ],
-  "main": "public-api.js",
-  "types": "public-api.d.ts",
+  "main": "index.js",
+  "types": "index.d.ts",
   "peerDependencies": {
     "@types/angular": "^1.7.3",
     "@types/angular-resource": "^1.5.16"

package/page-admin/package.json

@@ -4,6 +4,6 @@
         "**/*.d.ts",
         "**/*.js"
     ],
-    "main": "public-api.js",
-    "types": "public-api.d.ts"
+    "main": "index.js",
+    "types": "index.d.ts"
 }

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

@@ -10,7 +10,11 @@ export declare enum TemplateType {
 }
 /**
  * This API provides administration functionality related to pages.
- * Accessed from the window at window.sas.vi.pageAdmin.
+ *
+ * Accessed from the window at `window.sas.vi.pageAdmin`.
+ *
+ * @example window.sas.vi.pageAdmin.registerPageType(...);
+ * @category API
  */
 export interface PageAdminApi {
     /**

package/page-model/package.json

@@ -4,6 +4,6 @@
         "**/*.d.ts",
         "**/*.js"
     ],
-    "main": "public-api.js",
-    "types": "public-api.d.ts"
+    "main": "index.js",
+    "types": "index.d.ts"
 }

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

@@ -159,15 +159,13 @@ export interface IPageEvent<T extends IPageEventData> {
     /**
      * @method
      * @description Adds a hook to be executed before a hookable event is triggered.
-     * @param event {string} the event to hook onto.
-     * @param hook {IPrePageEventHook} the hook which defines the callback to run pre-event.
+     * @param {IPrePageEventHook} hook the hook which defines the callback to run pre-event.
      */
     addPreHook(hook: IPrePageEventHook<T>): PageEventHookRemove;
     /**
      * @method
      * @description Adds a hook to be executed after a hookable event is triggered.
-     * @param event {string} the event to hook onto.
-     * @param hook {IPostPageEventHook} the hook which defines the callback to run post-event.
+     * @param {IPostPageEventHook} hook the hook which defines the callback to run post-event.
      */
     addPostHook(hook: IPostPageEventHook<T>): PageEventHookRemove;
     /**
@@ -205,7 +203,10 @@ export interface PageEventsApi extends PageEventsApiBase {
 }
 /**
  * This API is used for PageModel utilities.
- * Accessed from the window at window.sas.vi.pageModel.
+ * Accessed from the window at `window.sas.vi.pageModel`.
+ *
+ * @example window.sas.vi.pageModel.createFromObject(partialPageModel);
+ * @category API
  */
 export interface PageModelApi {
     /**

package/page-state/package.json

@@ -4,6 +4,6 @@
         "**/*.d.ts",
         "**/*.js"
     ],
-    "main": "public-api.js",
-    "types": "public-api.d.ts"
+    "main": "index.js",
+    "types": "index.d.ts"
 }

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

@@ -13,7 +13,10 @@ export interface ObjectPageDesignerState {
 }
 /**
  * This API provides functionality that pertains to the page state.
- * Accessed from the window at window.sas.vi.pageState.
+ * Accessed from the window at `window.sas.vi.pageState`.
+ *
+ * @example window.sas.vi.pageState.getCurrent();
+ * @category API
  */
 export interface PageStateApi {
     /**

package/page-template/package.json

@@ -4,6 +4,6 @@
         "**/*.d.ts",
         "**/*.js"
     ],
-    "main": "public-api.js",
-    "types": "public-api.d.ts"
+    "main": "index.js",
+    "types": "index.d.ts"
 }

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

@@ -2,7 +2,11 @@ import { Template, TemplateResourceSummary } from "../svi-datahub";
 import { ApplicationType, TemplateType } from "../page-admin/page-admin-api";
 /**
  * This API provides functionality that pertains to the page templates.
- * Accessed from the window at window.sas.vi.pageTemplate.
+ *
+ * Accessed from the window at `window.sas.vi.pageTemplate`.
+ *
+ * @example window.sas.vi.pageTemplate.getPageTemplateById(templateNumber);
+ * @category API
  */
 export interface PageTemplateApi {
     /**

package/property/package.json

@@ -4,6 +4,6 @@
         "**/*.d.ts",
         "**/*.js"
     ],
-    "main": "public-api.js",
-    "types": "public-api.d.ts"
+    "main": "index.js",
+    "types": "index.d.ts"
 }

package/property/property-api.d.ts

@@ -39,7 +39,7 @@ export type ControlPropertyLocalizer = ToolbarControlPropertyLocalizer | PageCon
 export interface ToolbarControlPropertyLocalizer extends PropertyLocalizer<EntityToolbarItem> {
     localizerType: "toolbar";
     /**
-     * Generate resources to be inluded when the toolbar item is saved.
+     * Generate resources to be included when the toolbar item is saved.
      *
      * @param propertyKey the control attribute
      * @param control the toolbar item
@@ -106,7 +106,11 @@ export interface EditorApi {
 }
 /**
  * This API pertains to page/toolbar control properties in SAS Visual Investigator.
- * Accessed from the window at window.sas.vi.property.
+ *
+ * Accessed from the window at `window.sas.vi.property`.
+ *
+ * @example window.sas.vi.property.registerPropertyLocalizer(localizer);
+ * @category API
  */
 export interface PropertyApi {
     /**

package/reference-data/package.json

@@ -4,6 +4,6 @@
         "**/*.d.ts",
         "**/*.js"
     ],
-    "main": "public-api.js",
-    "types": "public-api.d.ts"
+    "main": "index.js",
+    "types": "index.d.ts"
 }

package/reference-data/refData.d.ts

@@ -37,8 +37,11 @@ export interface LocalizedLabel extends PersistableObject {
 }
 /**
  * This API provides functionality related to retrieving reference data.
- * Accessed from the window at window.sas.vi.refData.
  *
+ * Accessed from the window at `window.sas.vi.refData`.
+ *
+ * @example window.sas.vi.refData.getReferenceLists();
+ * @category API
  */
 export interface RefDataApi {
     /**

package/resource/package.json

@@ -4,6 +4,6 @@
         "**/*.d.ts",
         "**/*.js"
     ],
-    "main": "public-api.js",
-    "types": "public-api.d.ts"
+    "main": "index.js",
+    "types": "index.d.ts"
 }

package/resource/resource-api.d.ts

@@ -4,7 +4,11 @@ export interface I18nResources {
 /**
  * @deprecated Use window.sas.viInit.registerResourceBundle to register resources before the rest of the SAS Visual Investigator API is ready.
  * This API provides the resource functionality in SAS Visual Investigator.
- * Accessed from the window at window.sas.vi.resource.
+ *
+ * Accessed from the window at `window.sas.vi.resource`.
+ *
+ * @example window.sas.vi.resource.registerResourceBundle("bundleName", resources);
+ * @category API
  */
 export interface ResourceApi {
     /**

package/search/client/client-search-api.d.ts

@@ -1,5 +1,5 @@
 import { MapBoundedBoxFilter, MapBoundedPolygonFilter, MapRadiusFilter, MapShapeFilter, QueryMode, SearchRepresentation, SearchResponse, SummaryVisualizationResponse } from "../../svi-sand";
-import { CreateRelationshipDialogModel, CreateReleationshipDialogResultModel, ObjectIdentifier, SearchOrCreateAndLinkDialogBase } from "../../object/object-api";
+import { CreateRelationshipDialogModel, CreateRelationshipDialogResultModel, ObjectIdentifier, SearchOrCreateAndLinkDialogBase } from "../../object/object-api";
 import { QueryBuilderModel, SearchApi } from "../search-api";
 export declare enum SearchVisualization {
     Summary = "summary",
@@ -53,7 +53,7 @@ export interface SearchObject extends ObjectIdentifier {
     typeLabel?: string;
     uniqueKey?: string;
 }
-export interface SearchAndCreateRelateToModel extends CreateReleationshipDialogResultModel {
+export interface SearchAndCreateRelateToModel extends CreateRelationshipDialogResultModel {
     relateToTargetId?: string;
     relateToTargetType?: string;
 }
@@ -63,8 +63,12 @@ export interface SearchAndCreateResponse {
 /**
  * {@link SearchApi} extension pertains to functionality related to SAS Visual Investigator's search capabilities.
  * These additional methods are available only in the SAS Visual Investigator Investigate and Search interface.
- * Accessed from the window at window.sas.vi.search.
+ *
+ * Accessed from the window at `window.sas.vi.search`.
+ *
  * @extends SearchApi
+ * @example window.sas.vi.search.navigateSearch("query text", "map");
+ * @category API
  */
 export interface ClientSearchApi extends SearchApi {
     /**

package/search/client/index.d.ts

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

package/search/client/index.js

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

package/search/package.json

@@ -4,6 +4,6 @@
         "**/*.d.ts",
         "**/*.js"
     ],
-    "main": "public-api.js",
-    "types": "public-api.d.ts"
+    "main": "index.js",
+    "types": "index.d.ts"
 }

package/search/search-api.d.ts

@@ -45,7 +45,11 @@ export interface QueryBuilderResult {
 }
 /**
  * This API relates to SAS Visual Investigator's search functionality.
- * Accessed from the window at window.sas.vi.search.
+ *
+ * Accessed from the window at `window.sas.vi.search`.
+ *
+ * @example window.sas.vi.search.openQueryBuilderDialog("Dialog Title");
+ * @category API
  */
 export interface SearchApi {
     /**

package/sheet/package.json

@@ -4,6 +4,6 @@
         "**/*.d.ts",
         "**/*.js"
     ],
-    "main": "public-api.js",
-    "types": "public-api.d.ts"
+    "main": "index.js",
+    "types": "index.d.ts"
 }

package/sheet/sheet-api.d.ts

@@ -2,7 +2,11 @@ import { ObjectIdentifier, ObjectSheetSettings, VIObject } from "../object/objec
 import { NetworkData, Visualization } from "../search/client/client-search-api";
 /**
  * This API relates to SAS Visual Investigator's sheet functionality.
- * Accessed from the window at window.sas.vi.sheet.
+ *
+ * Accessed from the window at `window.sas.vi.sheet`.
+ *
+ * @example window.sas.vi.sheet.getOpenObjects();
+ * @category API
  */
 export interface SheetApi {
     /**

package/shell-tabs/package.json

@@ -4,6 +4,6 @@
         "**/*.d.ts",
         "**/*.js"
     ],
-    "main": "public-api.js",
-    "types": "public-api.d.ts"
+    "main": "index.js",
+    "types": "index.d.ts"
 }

package/shell-tabs/shell-tabs-api.d.ts

@@ -19,7 +19,7 @@ export interface INavigationBarTab<D = {
     /** label for the tab, can be String or the resource.key (if .isLabelResourceKey:true) */
     label: string;
     /** a weight used during .sort to order the tabs; will default to the order the tabs came as
-     * doesnt mean their array index, as many can be the same, negatives, fractions
+     * doesn't mean their array index, as many can be the same, negatives, fractions
      * */
     sortIndex?: number;
     /** when true, will use resourceService.get to resolve INavigationBarTab.label */
@@ -115,14 +115,18 @@ export interface ExternalTabConfig<T = SviShellTabData, P = any> {
 }
 /**
  * This API provides functionality relating to the shell tabs.
- * Accessed from the window at window.sas.vi.shellTabs.
+ *
+ * Accessed from the window at `window.sas.vi.shellTabs`.
+ *
+ * @example window.sas.vi.shellTabs.getSelectedTab();
+ * @category API
  */
 export interface ShellTabsApi<T = SviShellTabData> {
     /**
      * @method
      * @description This is used to expose any {@link PotentialTabItem} hooks on a component up to the Tab Service.
-     * @param [context] {this} pass "this"
-     * @param [elRef] {HTMLElement} This will pass the ElementRef for the component
+     * @param {any} context pass "this"
+     * @param {HTMLElement} nativeElement This will pass the ElementRef for the component
      *
      *  onTabClose {@link OnTabClose}, optional, can be used to prevent closing of a tab or close async
      *  onAttachTab {@link OnAttachTab}, will always trigger when currentNavigationBarTab has set
@@ -135,13 +139,13 @@ export interface ShellTabsApi<T = SviShellTabData> {
     /**
      * @method
      * @description Use this function to register new routes for tabs.
-     * @param [tabsToAdd] {ExternalTabConfig[]} - See {@link ExternalTabConfig}
+     * @param {ExternalTabConfig[]} tab See {@link ExternalTabConfig}
      */
     registerExternalTabs: (tab: Array<ExternalTabConfig<T>>) => void;
     /**
      * @method
      * @description Use this function to remove routes added via registerTabFn.
-     * @param [tabsToRemove] {ExternalTabConfig[]} - See {@link ExternalTabConfig}
+     * @param {ExternalTabConfig[]} tabsToRemove See {@link ExternalTabConfig}
      */
     unregisterExternalTabs: (tabsToRemove: Array<ExternalTabConfig<T>>) => void;
     /**
@@ -213,7 +217,7 @@ export interface ShellTabsApi<T = SviShellTabData> {
      * @method
      * @description This will remove an application tab, if allowed, and will trigger any closing and saving logic beforehand.
      * @param [tabIdToRemove] {string} This will be ID of an existing tab.
-     * @param [suppressNavigation] {boolean} Set supressNavigation to true if you want to close a tab that isn't open.
+     * @param [suppressNavigation] {boolean} Set suppressNavigation to true if you want to close a tab that isn't open.
      */
     removeApplicationTabById: (tabIdToRemove: string, suppressNavigation?: boolean) => Promise<boolean>;
     /**