bruce-models 3.2.0 → 3.2.1

package/dist/types/server/pending-action.d.ts

@@ -2,11 +2,14 @@ import { Api } from "../api/api";
 import { BruceApi } from "../api/bruce-api";
 import { UTC } from "../common/utc";
 /**
- * Describes the "Pending Action" concept within Bruce.
+ * Describes the "Pending Action" concept within Nextspace.
  * A pending action is a record of a server-side background process.
  * This record is used to monitor its progress and completion state.
  */
 export declare namespace PendingAction {
+    /**
+     * Describes a pending action record.
+     */
     interface IAction {
         ID: number;
         "CreatedBy.Application": string;
@@ -19,12 +22,18 @@ export declare namespace PendingAction {
         Status: EStatus;
         lastUpdated: UTC.IUTC;
     }
+    /**
+     * Available pending action statuses.
+     */
     enum EStatus {
         InProgress = "IN_PROGRESS",
         Cancelled = "CANCELLED",
         Complete = "COMPLETE",
         Failed = "FAILED"
     }
+    /**
+     * Describes a pending action message record.
+     */
     interface IMessage {
         "PendingAction.ID": number;
         ID: number;
@@ -33,12 +42,20 @@ export declare namespace PendingAction {
         "Message.Type": EMessageType | string;
         Message: string;
     }
+    /**
+     * Available message types.
+     */
     enum EMessageType {
         Warn = "WARNING",
         Error = "ERROR",
         Status = "STATUS",
         Info = "INFO"
     }
+    /**
+     * Returns a pending action record.
+     * @param params
+     * @returns
+     */
     function Get(params: {
         api?: BruceApi.Api;
         actionId: number;
@@ -46,6 +63,11 @@ export declare namespace PendingAction {
     }): Promise<{
         action: IAction;
     }>;
+    /**
+     * Returns a list of pending action records.
+     * @param params
+     * @returns
+     */
     function GetRelevantList(params: {
         api?: BruceApi.Api;
         stricter?: boolean;
@@ -53,6 +75,11 @@ export declare namespace PendingAction {
     }): Promise<{
         actions: IAction[];
     }>;
+    /**
+     * Returns a list of pending action record messages.
+     * @param params
+     * @returns
+     */
     function GetMessages(params: {
         api?: BruceApi.Api;
         actionId: number;

package/dist/types/server/task.d.ts

@@ -1,6 +1,13 @@
 import { Api } from "../api/api";
 import { GlobalApi } from "../api/global-api";
+/**
+ * Tasks are similar to pending actions except they run at a higher level.
+ * For example a task may be running a process on multiple client accounts.
+ */
 export declare namespace Task {
+    /**
+     * Describes a task record.
+     */
     interface ITask {
         account: string;
         context: string;
@@ -16,9 +23,17 @@ export declare namespace Task {
         type: string;
         updated: Date;
     }
+    /**
+     * Known task purposes.
+     */
     enum ETaskPurpose {
         BackupRestore = "BackupRestore"
     }
+    /**
+     * Returns a task record by ID.
+     * @param params
+     * @returns
+     */
     function Get(params: {
         api?: GlobalApi.Api;
         taskId: number;
@@ -26,6 +41,11 @@ export declare namespace Task {
     }): Promise<{
         task: ITask;
     }>;
+    /**
+     * Returns a list of task records.
+     * @param params
+     * @returns
+     */
     function GetList(params: {
         api?: GlobalApi.Api;
         accountId?: string;

package/dist/types/style/style.d.ts

@@ -2,32 +2,62 @@ import { Api } from "../api/api";
 import { BruceApi } from "../api/bruce-api";
 import { Calculator } from "../calculator/calculator";
 /**
- * Describes the "Style" concept within Bruce.
+ * Describes the "Style" concept within Nextspace.
  * A legacy way of referring to styles is "entity display settings".
  *
  * A style is a collection of settings (which can be calculations to perform on entity data) that
  * describe how an entity should be displayed.
  */
 export declare namespace Style {
+    /**
+     * Returns cache identifier for a style.
+     * Example: {
+     *     const api: BruceApi.Api = ...;
+     *     const key = GetCacheKey(1);
+     *     api.Cache.Remove(key);
+     * }
+     * @param id
+     * @returns
+     */
     function GetCacheKey(id: number): string;
+    /**
+     * Returns cache identifier for a list of styles.
+     * Example: {
+     *     const api: BruceApi.Api = ...;
+     *     const key = GetListCacheKey();
+     *     api.Cache.Remove(key);
+     * }
+     * @returns
+     */
     function GetListCacheKey(): string;
+    /**
+     * Types of styles available.
+     * The type will dictate what settings are available.
+     */
     enum EType {
         Entity = "ENTITY",
         EntityRelationship = "ENTITY_RELATIONSHIP"
     }
+    /**
+     * Available types of points.
+     * Default is POINT.
+     */
     enum EPointType {
         Point = "POINT",
         Icon = "ICON",
         Cylinder = "CYLINDER"
     }
+    /**
+     * Settings for rendering points
+     */
     interface IPointSettings {
+        Type: EPointType;
         color: Calculator.IField[];
         size: Calculator.IField[];
         iconId: string;
         iconUrl: Calculator.IField[];
         iconScale: Calculator.IField[];
         altitudeOption?: any;
-        Type: EPointType;
         renderOnTop?: boolean;
         CylinderFillColor?: Calculator.IField[];
         CylinderFillExtrusion?: Calculator.IField[];
@@ -39,6 +69,9 @@ export declare namespace Style {
         ClusterNearbyEntities?: boolean;
         MinimumEntitiesCountForClustering?: Calculator.IField[];
     }
+    /**
+     * Settings for rendering polygons.
+     */
     interface IPolygonSettings {
         useExtrusion: boolean;
         extrusionPath: Calculator.IField[];
@@ -50,6 +83,9 @@ export declare namespace Style {
         zIndex?: Calculator.IField[];
         drapeOver?: "TERRAIN" | "ALL";
     }
+    /**
+     * Settings for rendering polylines.
+     */
     interface IPolylineSettings {
         lineColor: Calculator.IField[];
         lineWidth: Calculator.IField[];
@@ -58,6 +94,9 @@ export declare namespace Style {
         zIndex?: Calculator.IField[];
         drapeOver?: "TERRAIN" | "ALL";
     }
+    /**
+     * Settings for rendering 3d models.
+     */
     interface IModelSettings {
         customize: boolean;
         fillColor: Calculator.IField[];
@@ -66,12 +105,18 @@ export declare namespace Style {
         fillColorBlendAmount?: number;
         altitudeOption?: any;
     }
+    /**
+     * Settings for rendering entities.
+     */
     interface IEntitySettings {
         pointStyle?: IPointSettings;
         polygonStyle?: IPolygonSettings;
         polylineStyle?: IPolylineSettings;
         modelStyle?: IModelSettings;
     }
+    /**
+     * Settings for rendering entity relationships.
+     */
     interface IRelationSettings {
         lineColor?: Calculator.IField[];
         lineWidth?: Calculator.IField[];
@@ -79,18 +124,31 @@ export declare namespace Style {
         duration?: Calculator.IField[];
     }
     type Settings = IEntitySettings | IRelationSettings;
+    /**
+     * Describes a style record.
+     */
     interface IStyle {
         ID: number;
         Name: string;
         Settings: Settings;
         Type: EType;
     }
+    /**
+     * Returns a list of styles.
+     * @param params
+     * @returns
+     */
     function GetList(params: {
         api?: BruceApi.Api;
         req?: Api.IReqParams;
     }): Promise<{
         styles: IStyle[];
     }>;
+    /**
+     * Returns a style.
+     * @param params
+     * @returns
+     */
     function Get(params: {
         api?: BruceApi.Api;
         styleId: number;
@@ -98,6 +156,11 @@ export declare namespace Style {
     }): Promise<{
         style: IStyle;
     }>;
+    /**
+     * Creates or updates a style.
+     * @param params
+     * @returns
+     */
     function Update(params: {
         api?: BruceApi.Api;
         style: IStyle;
@@ -105,6 +168,10 @@ export declare namespace Style {
     }): Promise<{
         style: IStyle;
     }>;
+    /**
+     * Deletes a style.
+     * @param params
+     */
     function Delete(params: {
         api?: BruceApi.Api;
         styleId: number;

package/dist/types/tileset/tileset.d.ts

@@ -9,7 +9,7 @@ import { Uploader } from "../internal/uploader";
 import { IDictionary } from "../common/dictionary";
 type Settings = Tileset.Settings.IPointcloud | Tileset.Settings.ICad | Tileset.Settings.IEntitiesMap | Tileset.Settings.IEntities | Tileset.Settings.IExternalMap | Tileset.Settings.IExternalTerrain | Tileset.Settings.IMap | Tileset.Settings.ITerrain;
 /**
- * Describes the "Tileset" concept in Bruce.
+ * Describes the "Tileset" concept in Nextspace.
  *
  * Tilesets come in three possible variants,
  * 1- A set of instructions to generate a tileset.
@@ -19,8 +19,31 @@ type Settings = Tileset.Settings.IPointcloud | Tileset.Settings.ICad | Tileset.S
  * Read the individual tileset-type settings for each variant.
  */
 export declare namespace Tileset {
+    /**
+     * Returns cache identifier for a tileset.
+     * Example: {
+     *     const api: BruceApi.Api = ...;
+     *     const key = GetCacheKey("abc", false);
+     *     api.Cache.Remove(key);
+     * }
+     * @param tilesetId
+     * @param loadFiles
+     * @returns
+     */
     function GetCacheKey(tilesetId: string, loadFiles: boolean): string;
+    /**
+     * Returns cache identifier for a list of tilesets.
+     * Example: {
+     *     const api: BruceApi.Api = ...;
+     *     const key = GetListCacheKey();
+     *     api.Cache.Remove(key);
+     * }
+     * @returns
+     */
     function GetListCacheKey(): string;
+    /**
+     * Describes a tileset record.
+     */
     interface ITileset {
         id: string;
         name: string;
@@ -35,6 +58,9 @@ export declare namespace Tileset {
         loadUrl?: string;
         isRestricted?: boolean;
     }
+    /**
+     * Available tileset types.
+     */
     enum EType {
         PointCloud = "POINT_CLOUD",
         GeoMap = "GEO_MAP",
@@ -48,12 +74,20 @@ export declare namespace Tileset {
         LegacyStatic = "S",
         LegacyExternal = "X"
     }
+    /**
+     * Available tileset pivot types.
+     */
     enum EPivot {
         None = "none",
         Box = "box",
         Weight = "weight",
         UCS = "ucs"
     }
+    /**
+     * Returns a tileset record.
+     * @param params
+     * @returns
+     */
     function Get(params: {
         api?: BruceApi.Api;
         tilesetId: string;
@@ -75,17 +109,31 @@ export declare namespace Tileset {
     }): Promise<{
         typeMapping: IDictionary<EType>;
     }>;
+    /**
+     * Returns a list of tileset records.
+     * @param params
+     * @returns
+     */
     function GetList(params: {
         api?: BruceApi.Api;
         req?: Api.IReqParams;
     }): Promise<{
         tilesets: ITileset[];
     }>;
+    /**
+     * Deletes a tileset record.
+     * @param params
+     */
     function Delete(params: {
         api?: BruceApi.Api;
         tilesetId: string;
         req?: Api.IReqParams;
     }): Promise<void>;
+    /**
+     * Creates or updates a tileset record.
+     * @param params
+     * @returns
+     */
     function Update(params: {
         api?: BruceApi.Api;
         tileset: ITileset;
@@ -93,6 +141,10 @@ export declare namespace Tileset {
     }): Promise<{
         tileset: ITileset;
     }>;
+    /**
+     * Uploads a file to a tileset.
+     * @param params
+     */
     function UploadFile(params: {
         api?: BruceApi.Api;
         tilesetId: string;
@@ -100,12 +152,22 @@ export declare namespace Tileset {
         onProgress?: (progress: Uploader.IProgress) => void;
         req?: Api.IUploadReqParams;
     }): Promise<void>;
+    /**
+     * Deletes a file from a tileset.
+     * @param params
+     */
     function DeleteFile(params: {
         api?: BruceApi.Api;
         tilesetId: string;
         file: string;
         req?: Api.IReqParams;
     }): Promise<void>;
+    /**
+     * Uploads a file to a tileset.
+     * Src files are used to generate tilesets.
+     * @param params
+     * @returns
+     */
     function UploadSrcFile(params: {
         api?: BruceApi.Api;
         tilesetId: string;
@@ -113,22 +175,42 @@ export declare namespace Tileset {
         onProgress?: (progress: Uploader.IProgress) => void;
         req?: Api.IUploadReqParams;
     }): Promise<void>;
+    /**
+     * Deletes a file from a tileset.
+     * Src files are used to generate tilesets.
+     * @param params
+     */
     function DeleteSrcFile(params: {
         api?: BruceApi.Api;
         tilesetId: string;
         file: string;
         req?: Api.IReqParams;
     }): Promise<void>;
+    /**
+     * Returns file url for a file + tileset.
+     * @param params
+     * @returns
+     */
     function GetFileUrl(params: {
         api?: BruceApi.Api;
         tilesetId: string;
         file: string;
     }): string;
+    /**
+     * Returns file url for a src file + tileset.
+     * @param params
+     * @returns
+     */
     function GetSrcFileUrl(params: {
         api?: BruceApi.Api;
         tilesetId: string;
         file: string;
     }): string;
+    /**
+     * Returns file url for a file + tileset.
+     * @param params
+     * @returns
+     */
     function GetPublicFileUrl(params: {
         api?: BruceApi.Api;
         tilesetId: string;
@@ -136,6 +218,12 @@ export declare namespace Tileset {
         viaCdnCacheToken?: number | string;
         file: string;
     }): string;
+    /**
+     * Calls the generate end-point for a tileset.
+     * The requirements for successful generation are based on the type of tileset.
+     * @param params
+     * @returns
+     */
     function Generate(params: {
         api?: BruceApi.Api;
         tilesetId: string;
@@ -143,6 +231,9 @@ export declare namespace Tileset {
     }): Promise<{
         pendingActionId: number;
     }>;
+    /**
+     * Utils for publishing the tileset to other Nextspace accounts.
+     */
     namespace Publish {
         function GetCacheKey(accountId: string, tilesetId?: string): string;
         function GetAccessAllowedCacheKey(tilesetId: string, sourceAccountId: string, forAccountId: string): string;

package/dist/types/user/permission.d.ts

@@ -1,5 +1,12 @@
+/**
+ * Permissions in Nextspace are arbitrary strings with meaning in specific contexts.
+ * This is a list of known permissions.
+ */
 export declare namespace Permission {
     type Perm = EPerm | string;
+    /**
+     * Standalone permissions.
+     */
     enum EPerm {
         ADMIN = "ADMIN",
         ADMIN_VIEW = "ADMIN_VIEW",
@@ -8,6 +15,10 @@ export declare namespace Permission {
         CREATE_ENTITY_TYPE = "CREATE_ENTITY_TYPE",
         UPDATE_ENTITY_TYPE = "UPDATE_ENTITY_TYPE"
     }
+    /**
+     * Permissions that are suffixed with another value.
+     * Eg: "UIVIEW_" will get the view's ID appended to it and be used as a permission to access the view.
+     */
     enum EPermPrefix {
         ACCESS_PROJECT_VIEW = "UIVIEW_",
         MANAGE_PROJECT_VIEW_BOOKMARKS = "UIVIEW_MANAGE_BOOKMARKS_",

package/dist/types/user/session.d.ts

@@ -1,15 +1,17 @@
 import { Api } from "../api/api";
 import { GuardianApi } from "../api/guardian-api";
-import { IdmApi } from "../api/idm-api";
 import { UTC } from "../common/utc";
 import { Permission } from "./permission";
 import { User } from "./user";
 /**
- * Describes the "Session" concept within Bruce.
+ * Describes the "Session" concept within Nextspace.
  * A session is a set of settings produced from a user or access token login.
  * The session describes what the access should be allowed to do.
  */
 export declare namespace Session {
+    /**
+     * Describes a session record.
+     */
     interface ISession {
         AccessPermissions: IAccountPermissions;
         HypeportalAccessPermisssions?: ISuperPermissions;
@@ -19,17 +21,28 @@ export declare namespace Session {
         LastAccessTime: UTC.IUTC;
         User: User.IUser;
     }
+    /**
+     * Describes a set of permissions for an account.
+     */
     interface IAccountPermissions {
         "ClientAccount.ID"?: string;
         EnabledFeatures?: Permission.Perm[];
         UserGroups?: string[];
     }
+    /**
+     * Describes a set of permissions for a super user.
+     */
     interface ISuperPermissions {
         EnabledFeatures?: Permission.Perm[];
         UserGroups?: string[];
     }
+    /**
+     * Gets a session record.
+     * @param params
+     * @returns
+     */
     function Get(params: {
-        api?: IdmApi.Api | GuardianApi.Api;
+        api?: GuardianApi.Api;
         sessionId?: string;
         accountId?: string;
         req?: Api.IReqParams;
@@ -43,7 +56,7 @@ export declare namespace Session {
      * @returns
      */
     function Login(params: {
-        api?: IdmApi.Api | GuardianApi.Api;
+        api?: GuardianApi.Api;
         username?: string;
         password?: string;
         accountId?: string;
@@ -51,23 +64,53 @@ export declare namespace Session {
     }): Promise<{
         session: ISession;
     }>;
+    /**
+     * Request to logout and void a session.
+     * This will use the sessionId set within the provided api instance.
+     * @param params
+     */
     function Logout(params: {
-        api?: IdmApi.Api | GuardianApi.Api;
+        api?: GuardianApi.Api;
         req?: Api.IReqParams;
     }): Promise<void>;
+    /**
+     * Returns if a permission is enabled for a session.
+     * This check is case-insensitive.
+     * Please use 'IsAccountAdmin' and 'IsSuperAdmin' when needed as they cover all account-level perms.
+     * @param params
+     * @returns
+     */
     function IsPermEnabled(params: {
         session: ISession;
         accountId: string;
         perm: string;
     }): boolean;
+    /**
+     * Returns if a super permission is enabled for a session.
+     * This check is case-insensitive.
+     * Please use 'IsSuperAdmin' when needed as it covers all perms.
+     * @param params
+     * @returns
+     */
     function IsSuperPermEnabled(params: {
         session: ISession;
         perm: string;
     }): boolean;
+    /**
+     * Returns if a session is an account admin.
+     * Please use 'IsSuperAdmin' when needed as it covers all perms.
+     * @param params
+     * @returns
+     */
     function IsAccountAdmin(params: {
         session: ISession;
         accountId: string;
     }): boolean;
+    /**
+     * Returns if a session is a super admin.
+     * @param params
+     * @returns
+     */
     function IsSuperAdmin(params: {
         session: ISession;
     }): boolean;