bruce-models 0.1.5 → 0.1.7

package/dist/lib/util/url-utils.js

@@ -1,6 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.UrlUtils = void 0;
+/**
+ * Utility to help with url manipulation.
+ */
 var UrlUtils;
 (function (UrlUtils) {
     function GetQueryString(doc) {
@@ -19,6 +22,9 @@ var UrlUtils;
         return qs;
     }
     UrlUtils.GetQueryString = GetQueryString;
+    /**
+     * Helper to get and set url params for a given window.
+     */
     var Handler = /** @class */ (function () {
         function Handler(window, allowedKeys) {
             this._allowedKeys = null;

package/dist/lib/util/url-utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"url-utils.js","sourceRoot":"","sources":["../../../src/util/url-utils.ts"],"names":[],"mappings":";;;AAEA,IAAiB,QAAQ,CA2FxB;AA3FD,WAAiB,QAAQ;IACrB,SAAgB,cAAc,CAAC,GAAa;QACxC,IAAM,EAAE,GAAQ,EAAE,CAAC;QACnB,IAAM,EAAE,GAAG,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAC1C,IAAI,EAAE,IAAI,CAAC,EAAE;YACT,IAAM,GAAG,GAAG,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;YAChD,IAAM,MAAM,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YAC9B,MAAM,CAAC,OAAO,CAAC,UAAA,KAAK;gBAChB,IAAM,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBAC3B,IAAI,CAAC,CAAC,MAAM,IAAI,CAAC,EAAE;oBACf,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;iBACnB;YACL,CAAC,CAAC,CAAC;SACN;QACD,OAAO,EAAE,CAAC;IACd,CAAC;IAde,uBAAc,iBAc7B,CAAA;IAED;QAaI,iBAAmB,MAAc,EAAE,WAAsB;YALjD,iBAAY,GAAkB,IAAI,CAAC;YAMvC,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;YACtB,IAAI,CAAC,YAAY,GAAa,WAAW,CAAC;QAC9C,CAAC;QAdD,sBAAW,2BAAM;iBAAjB;gBACI,OAAO,IAAI,CAAC,OAAO,CAAC;YACxB,CAAC;;;WAAA;QACD,sBAAY,6BAAQ;iBAApB;;gBACI,aAAO,IAAI,CAAC,MAAM,0CAAE,QAAQ,CAAC;YACjC,CAAC;;;WAAA;QAED,sBAAW,gCAAW;iBAAtB;gBACI,OAAO,IAAI,CAAC,YAAY,CAAC;YAC7B,CAAC;;;WAAA;QAOM,mCAAiB,GAAxB,UAAyB,WAAqB;YAC1C,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC;YAChC,IAAI,MAAM,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;YAC9B,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QACzB,CAAC;QAEM,6BAAW,GAAlB,UAAmB,GAAW,EAAE,KAAsB;YAClD,IAAI,MAAM,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;YAC9B,MAAM,CAAC,GAAG,GAAG,EAAE,CAAC,GAAG,KAAK,GAAG,EAAE,CAAC;YAC9B,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QACzB,CAAC;QAEM,6BAAW,GAAlB,UAAmB,GAAW;YAC1B,IAAI,MAAM,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;YAC9B,MAAM,CAAC,GAAG,GAAG,EAAE,CAAC,GAAQ,IAAI,CAAC;YAC7B,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QACzB,CAAC;QAEM,8BAAY,GAAnB;YACI,IAAI,MAAM,GAAG,cAAc,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAC3C,OAAO,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC/B,CAAC;QAEM,2BAAS,GAAhB;YACI,OAAO,cAAc,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACzC,CAAC;QAEM,0BAAQ,GAAf,UAAgB,GAAW;YACvB,IAAI,MAAM,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;YAC9B,OAAO,MAAM,CAAC,GAAG,GAAG,EAAE,CAAC,CAAC;QAC5B,CAAC;QAEM,uBAAK,GAAZ;YACI,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QACrB,CAAC;QAEO,yBAAO,GAAf,UAAgB,IAAkC;YAC9C,IAAM,MAAM,GAAa,EAAE,CAAC;YAC5B,IAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC/B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;gBAClC,IAAM,GAAG,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;gBACpB,IAAI,IAAI,CAAC,YAAY,IAAI,IAAI,IAAI,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;oBAC9D,IAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC;oBACtB,IAAI,CAAC,CAAC,GAAG,IAAI,GAAG,IAAI,CAAC,EAAE;wBACnB,MAAM,CAAC,IAAI,CAAI,GAAG,SAAI,GAAK,CAAC,CAAC;qBAChC;iBACJ;aACJ;YACD,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE;gBACnB,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,EAAO,IAAI,EAAE,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;aAC3E;iBACI;gBACD,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,EAAO,IAAI,EAAE,EAAE,CAAC,CAAC;aACvD;QACL,CAAC;QACL,cAAC;IAAD,CAAC,AAzED,IAyEC;IAzEY,gBAAO,UAyEnB,CAAA;AACL,CAAC,EA3FgB,QAAQ,GAAR,gBAAQ,KAAR,gBAAQ,QA2FxB"}
+{"version":3,"file":"url-utils.js","sourceRoot":"","sources":["../../../src/util/url-utils.ts"],"names":[],"mappings":";;;AAEA;;GAEG;AACH,IAAiB,QAAQ,CA8FxB;AA9FD,WAAiB,QAAQ;IACrB,SAAgB,cAAc,CAAC,GAAa;QACxC,IAAM,EAAE,GAAQ,EAAE,CAAC;QACnB,IAAM,EAAE,GAAG,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAC1C,IAAI,EAAE,IAAI,CAAC,EAAE;YACT,IAAM,GAAG,GAAG,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;YAChD,IAAM,MAAM,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YAC9B,MAAM,CAAC,OAAO,CAAC,UAAA,KAAK;gBAChB,IAAM,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBAC3B,IAAI,CAAC,CAAC,MAAM,IAAI,CAAC,EAAE;oBACf,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;iBACnB;YACL,CAAC,CAAC,CAAC;SACN;QACD,OAAO,EAAE,CAAC;IACd,CAAC;IAde,uBAAc,iBAc7B,CAAA;IAED;;OAEG;IACH;QAaI,iBAAmB,MAAc,EAAE,WAAsB;YALjD,iBAAY,GAAkB,IAAI,CAAC;YAMvC,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;YACtB,IAAI,CAAC,YAAY,GAAa,WAAW,CAAC;QAC9C,CAAC;QAdD,sBAAW,2BAAM;iBAAjB;gBACI,OAAO,IAAI,CAAC,OAAO,CAAC;YACxB,CAAC;;;WAAA;QACD,sBAAY,6BAAQ;iBAApB;;gBACI,aAAO,IAAI,CAAC,MAAM,0CAAE,QAAQ,CAAC;YACjC,CAAC;;;WAAA;QAED,sBAAW,gCAAW;iBAAtB;gBACI,OAAO,IAAI,CAAC,YAAY,CAAC;YAC7B,CAAC;;;WAAA;QAOM,mCAAiB,GAAxB,UAAyB,WAAqB;YAC1C,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC;YAChC,IAAI,MAAM,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;YAC9B,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QACzB,CAAC;QAEM,6BAAW,GAAlB,UAAmB,GAAW,EAAE,KAAsB;YAClD,IAAI,MAAM,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;YAC9B,MAAM,CAAC,GAAG,GAAG,EAAE,CAAC,GAAG,KAAK,GAAG,EAAE,CAAC;YAC9B,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QACzB,CAAC;QAEM,6BAAW,GAAlB,UAAmB,GAAW;YAC1B,IAAI,MAAM,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;YAC9B,MAAM,CAAC,GAAG,GAAG,EAAE,CAAC,GAAQ,IAAI,CAAC;YAC7B,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QACzB,CAAC;QAEM,8BAAY,GAAnB;YACI,IAAI,MAAM,GAAG,cAAc,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAC3C,OAAO,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC/B,CAAC;QAEM,2BAAS,GAAhB;YACI,OAAO,cAAc,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACzC,CAAC;QAEM,0BAAQ,GAAf,UAAgB,GAAW;YACvB,IAAI,MAAM,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;YAC9B,OAAO,MAAM,CAAC,GAAG,GAAG,EAAE,CAAC,CAAC;QAC5B,CAAC;QAEM,uBAAK,GAAZ;YACI,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QACrB,CAAC;QAEO,yBAAO,GAAf,UAAgB,IAAkC;YAC9C,IAAM,MAAM,GAAa,EAAE,CAAC;YAC5B,IAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC/B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;gBAClC,IAAM,GAAG,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;gBACpB,IAAI,IAAI,CAAC,YAAY,IAAI,IAAI,IAAI,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;oBAC9D,IAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC;oBACtB,IAAI,CAAC,CAAC,GAAG,IAAI,GAAG,IAAI,CAAC,EAAE;wBACnB,MAAM,CAAC,IAAI,CAAI,GAAG,SAAI,GAAK,CAAC,CAAC;qBAChC;iBACJ;aACJ;YACD,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE;gBACnB,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,EAAO,IAAI,EAAE,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;aAC3E;iBACI;gBACD,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,EAAO,IAAI,EAAE,EAAE,CAAC,CAAC;aACvD;QACL,CAAC;QACL,cAAC;IAAD,CAAC,AAzED,IAyEC;IAzEY,gBAAO,UAyEnB,CAAA;AACL,CAAC,EA9FgB,QAAQ,GAAR,gBAAQ,KAAR,gBAAQ,QA8FxB"}

package/dist/types/ann-document/ann-document.d.ts

@@ -1,5 +1,9 @@
 import { BruceApi } from "../bruce-models";
 declare type Type = AnnDocument.EType | string;
+/**
+ * Describes communication with the "Annotated Document" concept in Bruce.
+ * Annotated documents are files with hotspots that can link to Entity records.
+ */
 export declare namespace AnnDocument {
     function GetCacheKey(id: number): string;
     function GetListCacheKey(type: Type): string;

package/dist/types/api/abstract-api.d.ts

@@ -1,5 +1,8 @@
 import { CacheControl } from "../common/cache";
 import { Api } from "./api";
+/**
+ * This is a base class for communication with an arbitrary Bruce Api.
+ */
 export declare class AbstractApi {
     private ssidHeader;
     private ssid;

package/dist/types/api/api.d.ts

@@ -1,4 +1,7 @@
 import { IDictionary } from "../common/dictionary";
+/**
+ * Contains generic descriptions used for Bruce requests.
+ */
 export declare namespace Api {
     enum ECacheKey {
         Id = ":",
@@ -27,11 +30,28 @@ export declare namespace Api {
         User = "user",
         AccessToken = "accesstoken",
         UserGroup = "usergroup",
-        Account = "account"
+        Account = "account",
+        CustomForm = "customform"
     }
     const DEFAULT_CACHE_DURATION: number;
     const TEMPLATE_ACCOUNT_ID = "template";
     const ACCESS_TOKEN_HEADER = "X-Access-Token";
+    /**
+     * Possible environments we host Bruce apps on.
+     * When these are matched, they should be case-insensitive.
+     */
+    enum EEnv {
+        DEV = "DEV",
+        STG = "STG",
+        UAT = "UAT",
+        PROD = "PROD"
+    }
+    type Env = EEnv | string;
+    /**
+     * Prepares a string to be included in a url.
+     * @param str
+     * @returns
+     */
     function Encode(str: string): string;
     interface IList<T> {
         Items: T[];
@@ -46,19 +66,17 @@ export declare namespace Api {
         UTF8 = "UTF-8",
         UTF16 = "UTF-16BE"
     }
-    enum EEnv {
-        DEV = "DEV",
-        STG = "STG",
-        UAT = "UAT",
-        PROD = "PROD"
-    }
-    type Env = EEnv | string;
     interface IReqParams {
         headers?: IDictionary<string>;
         response?: {
             encoding?: EEncoding | string;
         };
     }
+    /**
+     * Prepares default settings for a request to Bruce Api.
+     * Our requests WRONGLY have utf-16 for 95% of them. Please be wary of that.
+     * @returns
+     */
     function PrepReqParams(): IReqParams;
     interface IUploadReqParams extends IReqParams {
         onProgress?: (e: ProgressEvent) => void;

package/dist/types/api/bruce-api.d.ts

@@ -1,5 +1,9 @@
 import { AbstractApi } from "./abstract-api";
 import { Api } from "./api";
+/**
+ * This is the request handler for Bruce Api,
+ * it should be passed to any method that wants to communicate with this particular api.
+ */
 export declare class BruceApi extends AbstractApi {
     private baseUrl;
     private accountId;
@@ -7,6 +11,7 @@ export declare class BruceApi extends AbstractApi {
     constructor(accountId: string, env?: Api.Env);
     private setBaseUrl;
     GetBaseUrl(): string;
+    SetBaseUrl(url: string): void;
     GET(url: string, params?: Api.IReqParams): Promise<any>;
     DELETE(url: string, params?: Api.IReqParams): Promise<any>;
     POST(url: string, data: any, params?: Api.IReqParams): Promise<any>;

package/dist/types/api/cam-api.d.ts

@@ -1,11 +1,16 @@
 import { AbstractApi } from "./abstract-api";
 import { Api } from "./api";
+/**
+ * This is the request handler for Cam Api,
+ * it should be passed to any method that wants to communicate with this particular api.
+ */
 export declare class CamApi extends AbstractApi {
     private baseUrl;
     private env;
     constructor(env?: Api.Env);
     private setBaseUrl;
     GetBaseUrl(): string;
+    SetBaseUrl(url: string): void;
     GET(url: string, params?: Api.IReqParams): Promise<any>;
     DELETE(url: string, params?: Api.IReqParams): Promise<any>;
     POST(url: string, data: any, params?: Api.IReqParams): Promise<any>;

package/dist/types/api/global-api.d.ts

@@ -1,11 +1,16 @@
 import { AbstractApi } from "./abstract-api";
 import { Api } from "./api";
+/**
+ * This is the request handler for Global Api,
+ * it should be passed to any method that wants to communicate with this particular api.
+ */
 export declare class GlobalApi extends AbstractApi {
     private baseUrl;
     private env;
     constructor(env?: Api.Env);
     private setBaseUrl;
     GetBaseUrl(): string;
+    SetBaseUrl(url: string): void;
     GET(url: string, params?: Api.IReqParams): Promise<any>;
     DELETE(url: string, params?: Api.IReqParams): Promise<any>;
     POST(url: string, data: any, params?: Api.IReqParams): Promise<any>;

package/dist/types/api/idm-api.d.ts

@@ -1,11 +1,16 @@
 import { AbstractApi } from "./abstract-api";
 import { Api } from "./api";
+/**
+ * This is the request handler for Idm Api,
+ * it should be passed to any method that wants to communicate with this particular api.
+ */
 export declare class IdmApi extends AbstractApi {
     private baseUrl;
     private env;
     constructor(env?: Api.Env);
     private setBaseUrl;
     GetBaseUrl(): string;
+    SetBaseUrl(url: string): void;
     GET(url: string, params?: Api.IReqParams): Promise<any>;
     DELETE(url: string, params?: Api.IReqParams): Promise<any>;
     POST(url: string, data: any, params?: Api.IReqParams): Promise<any>;

package/dist/types/bruce-models.d.ts

@@ -1,4 +1,5 @@
 export * from "./ann-document/ann-document";
+export * from "./custom-form/custom-form";
 export * from "./api/abstract-api";
 export * from "./api/api";
 export * from "./api/bruce-api";

package/dist/types/calculator/calculator.d.ts

@@ -1,5 +1,9 @@
 import { Color } from "../common/color";
 import { Entity } from "../entity/entity";
+/**
+ * Utility for calculating values from Bruce fields.
+ * These fields are typically found in entity styles.
+ */
 export declare namespace Calculator {
     enum EValueType {
         Color = 0,
@@ -31,6 +35,14 @@ export declare namespace Calculator {
         value: IGradientValue | IMappingValue | string | number;
         type: EValueType;
     }
+    /**
+     * Calculates the value of arbitrary field options.
+     * The context calling this should validate results and parse stuff if needed.
+     * @param fields
+     * @param entity
+     * @param tags
+     * @returns
+     */
     function GetValue(fields: IField[], entity: Entity.IEntity, tags: any[]): string | number | Color.IColor;
     function GetMappingValue(value: IMappingValue, entity: Entity.IEntity): string | number;
     function GetGradientValue(value: IGradientValue, entity: Entity.IEntity): Color.IColor;

package/dist/types/common/bounds.d.ts

@@ -1,4 +1,7 @@
 export declare namespace Bounds {
+    /**
+     * Description of an entity's bounding box.
+     */
     interface IBounds {
         maxLatitude: number;
         maxLongitude: number;
@@ -7,6 +10,9 @@ export declare namespace Bounds {
         maxAltitude: number;
         minAltitude: number;
     }
+    /**
+     * Describes the boundaries used in entity requests.
+     */
     interface IReqBounds {
         south: number;
         west: number;

package/dist/types/common/bruce-event.d.ts

@@ -1,3 +1,7 @@
+/**
+ * Simple event utility.
+ * Instantiate the model, then subscribe and trigger events.
+ */
 export declare class BruceEvent<TArgs> {
     private _counter;
     private callbacks;

package/dist/types/common/bruce-variable.d.ts

@@ -1,4 +1,17 @@
 import { Entity } from "../entity/entity";
+/**
+ * Utilities for parsing "Bruce variables", typically within strings.
+ *
+ * A Bruce variable is a string that starts with "${" and ends with "}".
+ * Within those brackets is a path to an attribute in an entity.
+ */
 export declare namespace BruceVariable {
+    /**
+     * Replaces all Bruce variables in a string with the value of the attribute.
+     * @param str
+     * @param data
+     * @param legacyParse
+     * @returns
+     */
     function SwapValues(str: string, data: Entity.IEntity, legacyParse?: boolean): string;
 }

package/dist/types/common/cache.d.ts

@@ -1,4 +1,7 @@
 declare type Key = string | number;
+/**
+ * Simple local cache controller.
+ */
 export declare class CacheControl<T> {
     private data;
     Disabled: boolean;

package/dist/types/common/cartes.d.ts

@@ -1,3 +1,9 @@
+/**
+ * Describes 2d and 3d coordinates.
+ *
+ * In 2d the x/y typically refers to a window left/top offset.
+ * In 3d the x/y/z, the units are in meters.
+ */
 export declare namespace Cartes {
     interface ICartes2 {
         x: number;

package/dist/types/common/carto.d.ts

@@ -1,3 +1,8 @@
+/**
+ * Describes a geographic point.
+ * The units of the stored data should be in Degrees.
+ * Utilities may use this in Radians for temporary calculations.
+ */
 export declare namespace Carto {
     interface ICarto {
         latitude: number;

package/dist/types/common/color.d.ts

@@ -15,5 +15,10 @@ export declare namespace Color {
         blendPercent?: number;
     }
     function RandomColor(): IColor;
+    /**
+     * Attempts to parse a given color string into a model.
+     * @param str
+     * @returns
+     */
     function ColorFromStr(str: string): IColor;
 }

package/dist/types/common/delay-queue.d.ts

@@ -1,3 +1,7 @@
+/**
+ * Controls the flow of method calls.
+ * If you have a method that may be called often, but you don't want it to run often, use this.
+ */
 export declare class DelayQueue {
     private callback;
     delay: number;

package/dist/types/common/geometry.d.ts

@@ -1,4 +1,7 @@
 import { Carto } from "./carto";
+/**
+ * Describes vector geometry that Bruce uses.
+ */
 export declare namespace Geometry {
     interface IGeometry {
         Polygon?: IPolygonRing[];
@@ -16,8 +19,26 @@ export declare namespace Geometry {
         Boundaries = "out",
         Hole = "in"
     }
+    /**
+     * Turns an array of points into string vector geometry that Bruce can use.
+     * This is used for saving polyline and polygon data.
+     * @param points
+     * @returns
+     */
     function LineStrFromPoints(points: Carto.ICarto[]): string;
+    /**
+     * Removes same points that occur in a row.
+     * This will not modify the original array.
+     * @param positions
+     * @returns
+     */
     function RemoveRepeatPoints(positions: Carto.ICarto[]): Carto.ICarto[];
     function ParsePoints(data: string): Carto.ICarto[];
+    /**
+     * Parses both string and object Bruce geometry.
+     * String geometry is legacy Bruce data.
+     * @param geometry
+     * @returns
+     */
     function ParseGeometry(geometry: any): IGeometry;
 }

package/dist/types/common/transform.d.ts

@@ -1,4 +1,8 @@
 export declare namespace Transform {
+    /**
+     * Stored in degrees typically.
+     * Will be stored in radians when in bookmarks/project-views annoyingly.
+     */
     interface ITransform {
         heading: number;
         pitch: number;

package/dist/types/common/utc.d.ts

@@ -1,3 +1,6 @@
+/**
+ * Describes a Bruce stored date.
+ */
 export declare namespace UTC {
     enum EMonth {
         January = 1,

package/dist/types/custom-form/custom-form.d.ts

@@ -0,0 +1,25 @@
+import { BruceApi } from "../api/bruce-api";
+import { Markup } from "../markup/markup";
+/**
+ * Describes the "Custom Form" concept within Bruce.
+ * Custom forms are dynamic dialogs that get populated with Entity data.
+ */
+export declare namespace CustomForm {
+    function GetCacheKey(id: number): string;
+    function GetListCacheKey(typeId: string): string;
+    interface IForm {
+        ID?: number;
+        "EntityType.ID"?: string;
+        Name?: string;
+        Settings?: any | Markup.IMarkup;
+        Type?: EType;
+    }
+    enum EType {
+        Form = "GENERIC",
+        Markup = "MARKUP"
+    }
+    function Get(api: BruceApi, id: number): Promise<IForm>;
+    function Delete(api: BruceApi, id: number): Promise<void>;
+    function GetList(api: BruceApi, typeId: string): Promise<IForm[]>;
+    function Update(api: BruceApi, data: IForm): Promise<IForm>;
+}

package/dist/types/entity/entity-attachment-type.d.ts

@@ -1,5 +1,9 @@
 import { BruceApi } from "../api/bruce-api";
 declare type Type = EntityAttachmentType.EType | string;
+/**
+ * Describes the "Entity Attachment Type" concept within Bruce.
+ * It is a record that describes the purpose of an attachment.
+ */
 export declare namespace EntityAttachmentType {
     function GetCacheKey(id: Type): string;
     function GetListCacheKey(): string;
@@ -10,10 +14,7 @@ export declare namespace EntityAttachmentType {
     }
     enum EType {
         Photo = "photo",
-        Document = "document",
-        Video = "video",
-        Drawing = "drawing",
-        Model = "model"
+        Document = "document"
     }
     function Delete(api: BruceApi, id: Type): Promise<void>;
     function Update(api: BruceApi, data: IType): Promise<IType>;

package/dist/types/entity/entity-attachment.d.ts

@@ -2,6 +2,11 @@ import { BruceApi } from "../bruce-models";
 import { ClientFile } from "../file/client-file";
 import { EntityAttachmentType } from "./entity-attachment-type";
 declare type Type = EntityAttachmentType.EType | string;
+/**
+ * Describes the "Entity Attachment" concept within Bruce.
+ * An entity attachment is an arbitrary file record that is linked to an entity record.
+ * The same file can be attached to multiple entities.
+ */
 export declare namespace EntityAttachment {
     function GetCacheKey(entityId: string, typeId: Type, fileId: string): string;
     function GetListCacheKey(entityId: string): string;

package/dist/types/entity/entity-comment.d.ts

@@ -1,4 +1,8 @@
 import { BruceApi, UTC } from "../bruce-models";
+/**
+ * Describes the "Entity Comment" concept within Bruce.
+ * An entity comment is a user written message that is linked to an entity record.
+ */
 export declare namespace EntityComment {
     function GetCacheKey(id: number): string;
     function GetListCacheKey(entityId: string): string;

package/dist/types/entity/entity-link.d.ts

@@ -1,4 +1,8 @@
 import { BruceApi } from "../bruce-models";
+/**
+ * Describes the "Entity Link" concept within Bruce.
+ * An entity link is a URL linked to an entity record.
+ */
 export declare namespace EntityLink {
     function GetCacheKey(id: number): string;
     function GetListCacheKey(entityId: string): string;

package/dist/types/entity/entity-lod.d.ts

@@ -1,4 +1,10 @@
 import { BruceApi } from "../bruce-models";
+/**
+ * Describes the "Entity LOD" concept within Bruce.
+ * LOD stands for Level of Detail.
+ * An lod record is a possible 2d/3d visualization of the entity record.
+ * The most common kind is a GLB.
+ */
 export declare namespace EntityLod {
     function GetCacheKey(url: string): string;
     interface ILod {

package/dist/types/entity/entity-relation-type.d.ts

@@ -1,4 +1,8 @@
 import { BruceApi } from "../api/bruce-api";
+/**
+ * Describes the "Entity Relationship Type" concept within Bruce.
+ * A relationship type record describes the purpose of a relationship.
+ */
 export declare namespace EntityRelationType {
     function GetCacheKey(id: string): string;
     function GetListCacheKey(): string;

package/dist/types/entity/entity-relation.d.ts

@@ -1,5 +1,10 @@
 import { BruceApi } from "../api/bruce-api";
 import { Entity } from "./entity";
+/**
+ * Describes the "Entity Relationship" concept within Bruce.
+ * An entity relationship is an arbitrary link between two entity records.
+ * The relationship can have a "data entity" linked to it as well for the relationship to store arbitrary data about itself.
+ */
 export declare namespace EntityRelation {
     function GetCacheKey(entityA: string, entityB: string, typeId: string): string;
     function GetEntityCacheKey(entityId: string): string;

package/dist/types/entity/entity-source.d.ts

@@ -1,4 +1,9 @@
 import { BruceApi, IDictionary } from "../bruce-models";
+/**
+ * Describes the "Entity Source" concept within Bruce.
+ * An entity source is a record which links an arbitrary source id to a Bruce entity id.
+ * For example an OSM building id to a Bruce entity id.
+ */
 export declare namespace EntitySource {
     function GetCacheKey(sourceId: number, sourceKey: string): string;
     interface ISource {

package/dist/types/entity/entity-tag.d.ts

@@ -1,4 +1,9 @@
 import { BruceApi } from "../api/bruce-api";
+/**
+ * Describes the "Entity Tag" concept within Bruce.
+ * An entity tag is used to categorize an entity record.
+ * Entity tags can be used in filters, or to restrict entity access.
+ */
 export declare namespace EntityTag {
     function GetCacheKey(tagId: number): string;
     function GetListCacheKey(entityTypeId?: string): string;

package/dist/types/entity/entity-type.d.ts

@@ -1,5 +1,10 @@
 import { BruceApi } from "../api/bruce-api";
 import { UTC } from "../bruce-models";
+/**
+ * Describes the "Entity Type" concept within Bruce.
+ * An entity type is an "expectation" of what data "should" look like in a particular entity record.
+ * The schema is stencils onto entity data to filter out what we should display or search against.
+ */
 export declare namespace EntityType {
     function GetCacheKey(typeId: string): string;
     function GetListCacheKey(): string;

package/dist/types/entity/entity.d.ts

@@ -5,8 +5,14 @@ import { Carto } from "../common/carto";
 import { Geometry } from "../common/geometry";
 import { Transform } from "../common/transform";
 import { UTC } from "../common/utc";
-import { IDictionary } from "../bruce-models";
+import { EntityType } from "./entity-type";
+import { IDictionary } from "../common/dictionary";
 declare type _any = any;
+/**
+ * Describes the "Entity" concept within Bruce.
+ * An entity is a JSON blob containing both internal data and user-defined data.
+ * Entity records have many thinks linked to them through their UIDs such as links, files and relationships.
+ */
 export declare namespace Entity {
     function GetCacheKey(entityId: string): string;
     interface IEntity extends _any {
@@ -31,6 +37,7 @@ export declare namespace Entity {
     function AddTag(data: IEntity, tagId: number): void;
     function SetValue(data: IEntity, path: string[], value: any): void;
     function GetValue(data: IEntity, path: string[]): any;
+    function CalculateName(entity: IEntity, type: EntityType.IEntityType): string;
     namespace Filter {
         namespace V1 {
             interface IFilter {

package/dist/types/entity/getters/batched-data-getter.d.ts

@@ -1,5 +1,9 @@
 import { BruceEvent } from "../../common/bruce-event";
 import { ViewMonitor } from "./view-monitor";
+/**
+ * This is a batched "arbitrary data" getter.
+ * You feed it an array of data, then it will emit that data in batches when the view changes.
+ */
 export declare namespace BatchedDataGetter {
     class Getter<T> {
         private viewPort;

package/dist/types/entity/getters/entity-filter-getter.d.ts

@@ -3,6 +3,11 @@ import { BruceEvent } from "../../common/bruce-event";
 import { IDictionary } from "../../common/dictionary";
 import { Entity } from "../entity";
 import { ViewMonitor } from "./view-monitor";
+/**
+ * This is a batched entity getter.
+ * It will scan for entity records in a view-area and emit them in batches.
+ * It will restart scanning if the camera moves.
+ */
 export declare namespace EntityFilterGetter {
     enum EStatus {
         Scanning = "SCANNING",

package/dist/types/entity/getters/entity-globe.d.ts

@@ -6,6 +6,11 @@ declare class Cell {
     Boundaries: Bounds.IBounds;
     GetBounds(): Bounds.IReqBounds;
 }
+/**
+ * This is a helper for making entity requests based on a grid area.
+ * It will return grid cells based on given view-area then will remember when stuff-
+ * was fully-fetched for those cells to avoid making duplicate requests.
+ */
 export declare namespace EntityGlobe {
     class Grid {
         private cells;

package/dist/types/file/client-file.d.ts

@@ -1,5 +1,9 @@
 import { BruceApi } from "../bruce-models";
 import { UTC } from "../common/utc";
+/**
+ * Describes the "Client File" concept within Bruce.
+ * A client file is a record of a file uploaded to Bruce.
+ */
 export declare namespace ClientFile {
     function GetCacheKey(fileId: string): string;
     interface IClientFile {

package/dist/types/markup/markup.d.ts

@@ -1,4 +1,7 @@
 import { Cartes, EntityAttachmentType } from "../bruce-models";
+/**
+ * Description of a "Markup" which is stored in custom-form or bookmark records.
+ */
 export declare namespace Markup {
     interface IMarkup {
         divs?: Element.Div.IDiv[];

package/dist/types/program-key/program-key.d.ts

@@ -1,5 +1,9 @@
 import { BruceApi } from "../api/bruce-api";
 declare type Id = ProgramKey.EProgramId | string;
+/**
+ * Describes the "Program Key" concept within Bruce.
+ * A program key is an access token for an arbitrary software.
+ */
 export declare namespace ProgramKey {
     function GetCacheKey(programId: string): string;
     function GetListCacheKey(): string;

package/dist/types/project/menu-item.d.ts

@@ -1,6 +1,11 @@
 import { Entity } from "../entity/entity";
 import { Tileset } from "../tileset/tileset";
 import { ZoomControl } from "./zoom-control";
+/**
+ * Describes a menu item found in project views.
+ * Menu items are used to dictate what data to load in a scene.
+ * A menu item may be a container for other items.
+ */
 export declare namespace MenuItem {
     enum EType {
         None = "NONE",

package/dist/types/project/project-view-bookmark.d.ts

@@ -2,6 +2,12 @@ import { BruceApi } from "../api/bruce-api";
 import { Camera } from "../common/camera";
 import { UTC } from "../common/utc";
 import { Markup } from "../markup/markup";
+/**
+ * Describe the "Project View Bookmark" concept within Bruce.
+ * This is referred to as "slides" in older code.
+ *
+ * A bookmark is a snapshot of what should be displayed and how in a particular project view.
+ */
 export declare namespace ProjectViewBookmark {
     function GetCacheKey(viewId: string, bookmarkId: string): string;
     function GetListCacheKey(): string;