bruce-models 3.2.0 → 3.2.1

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

@@ -1,8 +1,12 @@
 import { IDictionary } from "../common/dictionary";
 /**
- * Contains generic descriptions used for Bruce requests.
+ * Contains generic descriptions used for Nextspace requests.
  */
 export declare namespace Api {
+    /**
+     * Cache keys utilized by methods within this library.
+     * These help construct keys to store and retrieve data from the local cache.
+     */
     enum ECacheKey {
         Id = ":",
         Entity = "entity",
@@ -62,6 +66,10 @@ export declare namespace Api {
      * @returns
      */
     function Encode(str: string): string;
+    /**
+     * Standard list response from Nextspace APIs.
+     * Newer APIs will typically use a different format. Eg: "entities" for an entity list.
+     */
     interface IList<T> {
         Items: T[];
         TotalCount?: number;
@@ -71,23 +79,30 @@ export declare namespace Api {
         Asc = 1,
         Desc = -1
     }
+    /**
+     * Known response encodings from Nextspace APIs.
+     */
     enum EEncoding {
         UTF8 = "UTF-8",
         UTF16 = "UTF-16BE"
     }
+    /**
+     * Describes request params for any HTTP request performed through this library.
+     */
     interface IReqParams {
         noCache?: boolean;
         headers?: IDictionary<string>;
     }
-    interface IRes {
-    }
     /**
      * Prepares default settings for a request to Bruce Api.
-     * Our requests WRONGLY have utf-16 for 95% of them. Please be wary of that.
+     * (Currently none).
      * @param base
      * @returns
      */
     function PrepReqParams(base?: Api.IReqParams | IUploadReqParams): IReqParams | IUploadReqParams;
+    /**
+     * Describes upload request params.
+     */
     interface IUploadReqParams extends IReqParams {
         onProgress?: (e: ProgressEvent) => void;
         formData?: IDictionary<string> | FormData;

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

@@ -2,7 +2,16 @@ import { AbstractApi } from "./abstract-api";
 import { Api as A } from "./api";
 import { MessageBroker } from "../server/message-broker";
 import { GuardianApi } from "./guardian-api";
+/**
+ * The primary API for communication with Nextspace.
+ * This API is used to manage your data.
+ */
 export declare namespace BruceApi {
+    /**
+     * This is the interface for the Bruce Api getter.
+     * A getter helps manage requests to multiple client accounts.
+     * @deprecated, please pass an instance ApiGetters.ts instead.
+     */
     interface IGetter {
         accountId: string;
         env?: A.EEnv;
@@ -16,7 +25,6 @@ export declare namespace BruceApi {
         private accountId;
         get AccountId(): string;
         private env;
-        private loadProm;
         private loadCancelled;
         private messageBroker;
         get MessageBroker(): MessageBroker.IBroker;
@@ -24,10 +32,8 @@ export declare namespace BruceApi {
         EntityCdnUrl: string;
         LegacyTilesetCdnUrl: string;
         TilesetCdnUrl: string;
+        private loadProm;
         get Loading(): Promise<void>;
-        /**
-         * @param params
-         */
         constructor(params: {
             accountId: string;
             env?: A.Env;
@@ -63,10 +69,48 @@ export declare namespace BruceApi {
          * @param url
          */
         SetBaseUrl(url: string): void;
+        /**
+         * Performs an HTTP GET request.
+         * This will prepend the base url to the url.
+         * @param url
+         * @param params
+         * @returns
+         */
         GET(url: string, params?: A.IReqParams): Promise<any>;
+        /**
+         * Performs an HTTP DELETE request.
+         * This will prepend the base url to the url.
+         * @param url
+         * @param params
+         * @returns
+         */
         DELETE(url: string, params?: A.IReqParams): Promise<any>;
+        /**
+         * Performs an HTTP POST request.
+         * This will prepend the base url to the url.
+         * @param url
+         * @param data
+         * @param params
+         * @returns
+         */
         POST(url: string, data: any, params?: A.IReqParams): Promise<any>;
+        /**
+         * Performs an HTTP PUT request.
+         * This will prepend the base url to the url.
+         * @param url
+         * @param data
+         * @param params
+         * @returns
+         */
         PUT(url: string, data: any, params?: A.IReqParams): Promise<any>;
+        /**
+         * Performs a file upload request (HTTP POST).
+         * This will prepend the base url to the url.
+         * @param url
+         * @param blob
+         * @param params
+         * @returns
+         */
         UPLOAD(url: string, blob: Blob, params?: A.IUploadReqParams): Promise<any>;
     }
 }

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

@@ -1,25 +1,63 @@
 import { AbstractApi } from "./abstract-api";
 import { Api as A } from "./api";
+/**
+ * This is the request handler for Global Api,
+ * The global api is used to store information that is higher level than client accounts.
+ * For example it will store usage records, client account group settings, data sharing settings, etc.
+ */
 export declare namespace GlobalApi {
-    interface IGetter {
-        env: A.EEnv;
-        getApi: (env?: A.EEnv) => GlobalApi.Api;
-    }
-    /**
-     * This is the request handler for Global Api,
-     * it should be passed to any method that wants to communicate with this particular api.
-     */
     class Api extends AbstractApi {
         private env;
         constructor(params: {
             env?: A.Env;
         });
+        /**
+         * Sets the base url for this api.
+         */
         private setBaseUrl;
+        /**
+         * Gets the base url for this api.
+         * @returns
+         */
         GetBaseUrl(): string;
+        /**
+         * Sets the base url for this api.
+         * @param url
+         */
         SetBaseUrl(url: string): void;
+        /**
+         * Performs an HTTP GET request.
+         * This will prepend the base url to the url.
+         * @param url
+         * @param params
+         * @returns
+         */
         GET(url: string, params?: A.IReqParams): Promise<any>;
+        /**
+         * Performs an HTTP DELETE request.
+         * This will prepend the base url to the url.
+         * @param url
+         * @param params
+         * @returns
+         */
         DELETE(url: string, params?: A.IReqParams): Promise<any>;
+        /**
+         * Performs an HTTP POST request.
+         * This will prepend the base url to the url.
+         * @param url
+         * @param data
+         * @param params
+         * @returns
+         */
         POST(url: string, data: any, params?: A.IReqParams): Promise<any>;
+        /**
+         * Performs a file upload request (HTTP POST).
+         * This will prepend the base url to the url.
+         * @param url
+         * @param blob
+         * @param params
+         * @returns
+         */
         UPLOAD(url: string, blob: Blob, params?: A.IUploadReqParams): Promise<any>;
     }
 }

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

@@ -2,24 +2,61 @@ import { AbstractApi } from "./abstract-api";
 import { Api as A } from "./api";
 /**
  * This is the request handler for Cam/Idm Api,
- * it should be passed to any method that wants to communicate with this particular api.
+ * This API is in charge of user session management.
  */
 export declare namespace GuardianApi {
-    interface IGetter {
-        env: A.EEnv;
-        getApi: (env?: A.EEnv) => GuardianApi.Api;
-    }
     class Api extends AbstractApi {
         private env;
         constructor(params: {
             env?: A.Env;
         });
+        /**
+         * Sets the base url for this api.
+         */
         private setBaseUrl;
+        /**
+         * Gets the base url for this api.
+         * @returns
+         */
         GetBaseUrl(): string;
+        /**
+         * Sets the base url for this api.
+         * @param url
+         */
         SetBaseUrl(url: string): void;
+        /**
+         * Performs an HTTP GET request.
+         * This will prepend the base url to the url.
+         * @param url
+         * @param params
+         * @returns
+         */
         GET(url: string, params?: A.IReqParams): Promise<any>;
+        /**
+         * Performs an HTTP DELETE request.
+         * This will prepend the base url to the url.
+         * @param url
+         * @param params
+         * @returns
+         */
         DELETE(url: string, params?: A.IReqParams): Promise<any>;
+        /**
+         * Performs an HTTP POST request.
+         * This will prepend the base url to the url.
+         * @param url
+         * @param data
+         * @param params
+         * @returns
+         */
         POST(url: string, data: any, params?: A.IReqParams): Promise<any>;
+        /**
+         * Performs a file upload request (HTTP POST).
+         * This will prepend the base url to the url.
+         * @param url
+         * @param blob
+         * @param params
+         * @returns
+         */
         UPLOAD(url: string, blob: Blob, params?: A.IUploadReqParams): Promise<any>;
     }
 }

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

@@ -4,8 +4,6 @@ export * from "./custom-form/custom-form-content";
 export * from "./api/abstract-api";
 export * from "./api/api";
 export * from "./api/bruce-api";
-export * from "./api/cam-api";
-export * from "./api/idm-api";
 export * from "./api/global-api";
 export * from "./api/guardian-api";
 export * from "./api/api-getters";
@@ -79,4 +77,4 @@ export * from "./internal/uploader";
 export * from "./plugin/plugin";
 export * from "./environment";
 export * from "./data-source/data-source";
-export declare const VERSION = "3.2.0";
+export declare const VERSION = "3.2.1";

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

@@ -1,10 +1,14 @@
 import { Color } from "../common/color";
 import { Entity } from "../entity/entity";
 /**
- * Utility for calculating values from Bruce fields.
+ * Utility for calculating values from Nextspace fields.
  * These fields are typically found in entity styles.
  */
 export declare namespace Calculator {
+    /**
+     * Possible types of values that can be calculated.
+     * This will determine how to calculate the values, and if extra levels of validation for specific value types are done.
+     */
     enum EValueType {
         Color = 0,
         Input = 1,
@@ -13,14 +17,25 @@ export declare namespace Calculator {
         TagColor = 4,
         RandomColor = 5
     }
+    /**
+     * A mapping option for a mapping value.
+     */
     interface IMappingOption {
         fieldValue: string;
         appliedValue: string;
     }
+    /**
+     * A mapping value.
+     * This is a comparison between an attribute value to a set of available values.
+     * If the attribute value matches a field value, then the applied value is returned.
+     */
     interface IMappingValue {
         field: string;
         values: IMappingOption[];
     }
+    /**
+     * A gradient point.
+     */
     interface IGradientPoint {
         position: number;
         color: string;
@@ -31,6 +46,10 @@ export declare namespace Calculator {
         min?: number;
         max?: number;
     }
+    /**
+     * A field option.
+     * This is a value that can be calculated based on outlined settings.
+     */
     interface IField {
         value: IGradientValue | IMappingValue | string | number;
         type: EValueType;
@@ -53,9 +72,46 @@ export declare namespace Calculator {
      * @param tags
      */
     function GetColor(fields: IField[], entity: Entity.IEntity, tags: any[]): Color.IColor;
+    /**
+     * Calculates the value of arbitrary field options with assumption that desired result is a number.
+     * Will return null if a number is not found.
+     * @param fields
+     * @param entity
+     * @param tags
+     * @returns
+     */
     function GetNumber(fields: IField[], entity: Entity.IEntity, tags: any[]): number;
+    /**
+     * Calculates the value of arbitrary field options with assumption that desired result is a string.
+     * Will return null if a string is not found.
+     * @param fields
+     * @param entity
+     * @param tags
+     * @returns
+     */
     function GetString(fields: IField[], entity: Entity.IEntity, tags: any[]): string;
+    /**
+     * Calculates a mapping value. This can return any value type.
+     * It is intended to be parsed and validated within a value-type context. Eg: GetColor, GetNumber, GetString.
+     * @param value
+     * @param entity
+     * @returns
+     */
     function GetMappingValue(value: IMappingValue, entity: Entity.IEntity): string | number;
+    /**
+     * Calculates a gradient value. This can return any value type.
+     * It is intended to be parsed and validated within a value-type context. Eg: GetColor, GetNumber, GetString.
+     * @param value
+     * @param entity
+     * @returns
+     */
     function GetGradientValue(value: IGradientValue, entity: Entity.IEntity): Color.IColor;
+    /**
+     * Calculates an input value. This can return any value type.
+     * It is intended to be parsed and validated within a value-type context. Eg: GetColor, GetNumber, GetString.
+     * @param value
+     * @param entity
+     * @returns
+     */
     function GetInputValue(value: string, entity: Entity.IEntity): string | number;
 }

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

@@ -3,29 +3,61 @@ import { BruceApi } from "../api/bruce-api";
 import { UTC } from "../common/utc";
 import { Uploader } from "../internal/uploader";
 /**
- * Describes the "Client File" concept within Bruce.
+ * Describes the "Client File" concept within Nextspace.
  * A client file is a record of a file uploaded to Bruce.
  */
 export declare namespace ClientFile {
+    /**
+     * Returns cache identifier for a client file by ID.
+     * Example: {
+     *     const api: BruceApi.Api = ...;
+     *     const key = GetCacheKey("123");
+     *     api.Cache.Remove(key);
+     * }
+     * @param fileId
+     * @returns
+     */
     function GetCacheKey(fileId: string): string;
+    /**
+     * Describes a client file record.
+     */
     interface IFile {
-        UploadedTimeUTC: UTC.IUTC;
-        FileExt: string;
         ID: string;
+        FileExt: string;
         MIMEType: string;
         OriginalFileName: string;
         OriginalLength: number;
         "UploadedByUser.ID": string;
-        Purpose: string;
+        Purpose: Purpose;
+        UploadedTimeUTC: UTC.IUTC;
+    }
+    type Purpose = string | EPurpose;
+    enum EPurpose {
+        BookmarkThumbnail = "Bookmark Thumbnail"
     }
+    /**
+     * Returns the URL for a client file.
+     * @param params
+     * @returns
+     */
     function GetUrl(params: {
         api?: BruceApi.Api;
         fileId: string;
     }): string;
+    /**
+     * Returns the URL for a client file with the extension.
+     * @param params
+     * @returns
+     */
     function GetUrlWithExt(params: {
         api?: BruceApi.Api;
         file: IFile;
     }): string;
+    /**
+     * Returns a client file record by ID.
+     * @param params
+     * @returns
+     */
     function Get(params: {
         api?: BruceApi.Api;
         fileId: string;
@@ -33,11 +65,20 @@ export declare namespace ClientFile {
     }): Promise<{
         clientFile: IFile;
     }>;
+    /**
+     * Deletes one or many client file records by IDs.
+     * @param params
+     */
     function Delete(params: {
         api?: BruceApi.Api;
         fileIds: string[];
         req?: Api.IReqParams;
     }): Promise<void>;
+    /**
+     * Uploads a file and creates a new client file record.
+     * @param params
+     * @returns
+     */
     function Upload(params: {
         api?: BruceApi.Api;
         file: File;
@@ -47,6 +88,10 @@ export declare namespace ClientFile {
     }): Promise<{
         clientFile: IFile;
     }>;
+    /**
+     * Updates the purpose of a client file.
+     * @param params
+     */
     function UpdatePurpose(params: {
         api?: BruceApi.Api;
         fileId: string;
@@ -55,7 +100,7 @@ export declare namespace ClientFile {
     }): Promise<void>;
     /**
      * Uploads a temp file.
-     * This will return a temp file id which can be used in various endpoints.
+     * This will return a temp file ID.
      * @param params
      * @returns
      */
@@ -67,6 +112,9 @@ export declare namespace ClientFile {
     }): Promise<{
         tempFileId: string;
     }>;
+    /**
+     * Filter definitions for requesting a list of client files.
+     */
     namespace Filter {
         enum EColumn {
             ID = "id",
@@ -102,6 +150,11 @@ export declare namespace ClientFile {
         Purpose?: string;
         FilterRows?: Filter.IRow[];
     }
+    /**
+     * Returns a list of client files matching the filter.
+     * @param params
+     * @returns
+     */
     function GetList(params: {
         api?: BruceApi.Api;
         filter: IFilter;
@@ -110,12 +163,22 @@ export declare namespace ClientFile {
         clientFiles: IFile[];
         totalCount: number;
     }>;
+    /**
+     * Utility for processing client files.
+     * Commonly used to convert a file to a different format. Eg: FBX to GLB.
+     */
     namespace Processor {
+        /**
+         * Describes the result of a file processing operation.
+         */
         interface IResult {
             success: boolean;
             clientFileId: string;
             clientFileName: string;
         }
+        /**
+         * The desired file format to convert to.
+         */
         enum EConvertExt {
             GLB = ".glb",
             SKP = ".skp"
@@ -123,7 +186,7 @@ export declare namespace ClientFile {
         function ConvertFormat(params: {
             api?: BruceApi.Api;
             fileId: string;
-            ext: EConvertExt | string;
+            ext?: EConvertExt | string;
             req?: Api.IReqParams;
         }): Promise<IResult>;
     }

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

@@ -8,8 +8,8 @@ export declare namespace Bounds {
         maxLongitude: number;
         minLatitude: number;
         minLongitude: number;
-        maxAltitude: number;
-        minAltitude: number;
+        maxAltitude?: number;
+        minAltitude?: number;
     }
     /**
      * Describes the boundaries used in entity requests.
@@ -23,7 +23,7 @@ export declare namespace Bounds {
     }
     /**
      * Calculates boundaries from entity.
-     * This will not use the set entity boundaries and instead calculate from geometry and location.
+     * This will not use the entity's boundaries and instead calculate from geometry and location.
      * @param entity
      */
     function FromEntity(entity: Entity.IEntity): IBounds;

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

@@ -5,8 +5,27 @@
 export declare class BruceEvent<TArgs> {
     private _counter;
     private callbacks;
+    /**
+     * Subscribes to this event.
+     * The provided callback will be called when the event is triggered.
+     * @param callback
+     * @returns A function that can be called to unsubscribe from this event.
+     */
     Subscribe(callback: (data: TArgs) => void): (() => void);
+    /**
+     * Unsubscribes from this event.
+     * @param id specific subscription entry to remove.
+     * @warning please use the returned function from Subscribe() instead of this function.
+     */
     Unsubscribe(id: number): void;
+    /**
+     * Triggers this event with optional data.
+     * This will call all subscribed callbacks.
+     * @param data
+     */
     Trigger(data?: TArgs): void;
+    /**
+     * Clears all subscriptions.
+     */
     Clear(): void;
 }