bruce-models 0.1.6 → 0.1.7

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

@@ -1,5 +1,10 @@
 import { Api } from "../api/api";
 import { BruceApi, UTC } from "../bruce-models";
+/**
+ * Describes the "Pending Action" concept within Bruce.
+ * 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 {
     interface IAction {
         ID: number;

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

@@ -1,4 +1,11 @@
 import { BruceApi, Calculator } from "../bruce-models";
+/**
+ * Describes the "Style" concept within Bruce.
+ * 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 {
     function GetCacheKey(id: number): string;
     function GetListCacheKey(): string;

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

@@ -1,5 +1,9 @@
 import { Tileset } from "../bruce-models";
 import { Carto } from "../common/carto";
+/**
+ * Describes expected settings for a CAD tileset.
+ * A CAD tileset is sometimes referred to as a "MODEL" tileset in Bruce.
+ */
 export declare namespace TilesetCad {
     interface ISettings {
         rootEntityId: string;

package/dist/types/tileset/tileset-entities-map-tiles.d.ts

@@ -1,4 +1,9 @@
 import { Bounds } from "../common/bounds";
+/**
+ * Describes expected settings for an entities-map tileset.
+ * This is the kind of tileset generated from arbitrary Bruce entities-
+ * which produced map tiles of the entity vector geometry.
+ */
 export declare namespace TilesetEntitiesMapTiles {
     enum ETileSize {
         IMG_256 = 256,

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

@@ -1,4 +1,8 @@
 import { Bounds } from "../bruce-models";
+/**
+ * Describes expected settings for an entities-set tileset.
+ * This is the kind of tileset generated from arbitrary Bruce entities.
+ */
 export declare namespace TilesetEntities {
     interface ISettings {
         zoomControl?: any[];

package/dist/types/tileset/tileset-ext-map-tiles.d.ts

@@ -1,3 +1,7 @@
+/**
+ * Describes settings for an external map-tiles tileset.
+ * This will serve content from elsewhere with the assumption that the data is valid map tiles.
+ */
 export declare namespace TilesetExtMapTiles {
     enum EType {
         TileMapImagery = "TileMapImagery",

package/dist/types/tileset/tileset-ext-terrain-tiles.d.ts

@@ -1,3 +1,7 @@
+/**
+ * Describes settings for an external terrain-tiles tileset.
+ * This will serve content from elsewhere with the assumption that the data is valid terrain tiles.
+ */
 export declare namespace TilesetExtTerrainTiles {
     interface ISettings {
         requestVertexNormals?: boolean;

package/dist/types/tileset/tileset-map-tiles.d.ts

@@ -1,3 +1,7 @@
+/**
+ * Describes settings for a map-tiles tileset.
+ * This tileset will ingest a .tif file and produce pictures to serve as map tiles.
+ */
 export declare namespace TilesetMapTiles {
     interface ISettings {
         sourceFileId: string;

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

@@ -1,5 +1,9 @@
 import { Tileset } from "../bruce-models";
 import { Carto } from "../common/carto";
+/**
+ * Describes settings for a point-cloud tileset.
+ * This tileset ingests a .laz or .las file and produces a point cloud that can be streamed into viewers.
+ */
 export declare namespace TilesetPointcloud {
     interface ISettings {
         sourceFileIds: string[];

package/dist/types/tileset/tileset-terrain-tiles.d.ts

@@ -1,3 +1,7 @@
+/**
+ * Describes settings for a terrain-tiles tileset.
+ * This tileset will ingest a .tif file and produce pictures to serve as terrain tiles.
+ */
 export declare namespace TilesetTerrainTiles {
     interface ISettings {
         sourceFileId?: string;

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

@@ -10,6 +10,16 @@ import { TilesetMapTiles } from "./tileset-map-tiles";
 import { TilesetTerrainTiles } from "./tileset-terrain-tiles";
 import { GlobalApi } from "../api/global-api";
 declare type Settings = TilesetPointcloud.ISettings | TilesetCad.ISettings | TilesetEntitiesMapTiles.ISettings | TilesetEntities.ISettings | TilesetExtMapTiles.ISettings | TilesetExtTerrainTiles.ISettings | TilesetMapTiles.ISettings | TilesetTerrainTiles.ISettings;
+/**
+ * Describes the "Tileset" concept in Bruce.
+ *
+ * Tilesets come in three possible variants,
+ * 1- A set of instructions to generate a tileset.
+ * 2- Settings to load a tileset hosted elsewhere.
+ * 3- A set of user-provided files to serve.
+ *
+ * Read the individual tileset-type settings for each variant.
+ */
 export declare namespace Tileset {
     function GetCacheKey(tilesetId: string, loadFiles: boolean): string;
     function GetListCacheKey(): string;

package/dist/types/ucs/ucs.d.ts

@@ -1,4 +1,9 @@
 import { BruceApi, Tileset } from "../bruce-models";
+/**
+ * Describes the "UCS" concept within Bruce.
+ * A UCS is a user-coordinate-system.
+ * It is a description of an offset to apply to tilesets so that they can all align with each other.
+ */
 export declare namespace Ucs {
     function GetCacheKey(id: number, expandUsage: boolean): string;
     function GetListCacheKey(): string;

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

@@ -2,6 +2,11 @@ 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.
+ * 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 {
     interface ISession {
         AccessPermissions: IAccessPermissions;

package/dist/types/user/user-group.d.ts

@@ -1,5 +1,9 @@
 import { IdmApi, Permission } from "../bruce-models";
 import { User } from "./user";
+/**
+ * Describes the "User Group" concept within Bruce.
+ * A user group is a collection of permissions ("Features") and what users should be in the group.
+ */
 export declare namespace UserGroup {
     interface IGroup {
         "ClientAccount.ID"?: string;

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

@@ -1,5 +1,12 @@
 import { IdmApi } from "../api/idm-api";
 import { UserGroup } from "./user-group";
+/**
+ * Describes the "User" concept within Bruce.
+ * A user is either a login-user or an access-token.
+ *
+ * You cannot login using an access-token, but both concepts are-
+ * treated the same way in terms of permissions and user groups.
+ */
 export declare namespace User {
     function GetCacheKey(userId: string, accountId: string): string;
     interface IUser {

package/dist/types/util/math-utils.d.ts

@@ -1,4 +1,16 @@
 export declare namespace MathUtils {
+    /**
+     * Rounds a number to a given number of decimal places.
+     * @param num
+     * @param decimals
+     * @returns
+     */
     function Round(num: number, decimals?: number): number;
+    /**
+     * Returns a random integer between min (inclusive) and max (inclusive).
+     * @param min
+     * @param max
+     * @returns
+     */
     function RandInt(min: number, max: number): number;
 }

package/dist/types/util/object-utils.d.ts

@@ -1,3 +1,7 @@
 export declare namespace ObjectUtils {
+    /**
+     * Generates a Bruce compatible UID.
+     * @returns
+     */
     function UId(): string;
 }

package/dist/types/util/path-utils.d.ts

@@ -1,3 +1,6 @@
+/**
+ * Utility to help with parsing and wrapping Bruce paths.
+ */
 export declare namespace PathUtils {
     function Parse(str: string): string[];
     function Wrap(path: string[]): string;

package/dist/types/util/url-utils.d.ts

@@ -1,6 +1,12 @@
 import { IDictionary } from "../common/dictionary";
+/**
+ * Utility to help with url manipulation.
+ */
 export declare namespace UrlUtils {
     function GetQueryString(doc: Document): IDictionary<string>;
+    /**
+     * Helper to get and set url params for a given window.
+     */
     class Handler {
         private _window;
         get window(): Window;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bruce-models",
-  "version": "0.1.6",
+  "version": "0.1.7",
   "description": "",
   "keywords": [],
   "main": "dist/bruce-models.umd.js",