bruce-models 2.3.6 → 2.3.8

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

@@ -1,93 +1,93 @@
-import { IDictionary } from "../common/dictionary";
-/**
- * Contains generic descriptions used for Bruce requests.
- */
-export declare namespace Api {
-    enum ECacheKey {
-        Id = ":",
-        Entity = "entity",
-        EntityType = "entitytype",
-        ProjectView = "projectview",
-        ProjectViewBookmark = "pvbookmark",
-        Tileset = "tileset",
-        ClientFile = "clientfile",
-        Session = "session",
-        PendingAction = "pendingaction",
-        EntitySource = "entitysource",
-        ProgramKey = "programkey",
-        EntityCoords = "entitycoords",
-        Tag = "tag",
-        Attachment = "attachment",
-        Comment = "comment",
-        Link = "link",
-        AnnDocument = "anndocument",
-        AttachmentType = "attachmenttype",
-        Relation = "relation",
-        RelationType = "relationtype",
-        Lod = "lod",
-        LodCategory = "lodcategory",
-        Style = "style",
-        PublishTileset = "publishtileset",
-        User = "user",
-        UserSettings = "usersettings",
-        UserEmail = "useremail",
-        AccessToken = "accesstoken",
-        UserGroup = "usergroup",
-        Account = "account",
-        DatabaseRegion = "databaseregion",
-        CustomForm = "customform",
-        ImportedFile = "importedfile",
-        Plugin = "plugin"
-    }
-    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;
-    let DEFAULT_NO_CACHE: boolean;
-    /**
-     * Prepares a string to be included in a url.
-     * @param str
-     * @returns
-     */
-    function Encode(str: string): string;
-    interface IList<T> {
-        Items: T[];
-        TotalCount?: number;
-    }
-    enum ESortOrder {
-        None = 0,
-        Asc = 1,
-        Desc = -1
-    }
-    enum EEncoding {
-        UTF8 = "UTF-8",
-        UTF16 = "UTF-16BE"
-    }
-    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.
-     * @param base
-     * @returns
-     */
-    function PrepReqParams(base?: Api.IReqParams | IUploadReqParams): IReqParams | IUploadReqParams;
-    interface IUploadReqParams extends IReqParams {
-        onProgress?: (e: ProgressEvent) => void;
-        formData?: IDictionary<string> | FormData;
-    }
-}
+import { IDictionary } from "../common/dictionary";
+/**
+ * Contains generic descriptions used for Bruce requests.
+ */
+export declare namespace Api {
+    enum ECacheKey {
+        Id = ":",
+        Entity = "entity",
+        EntityType = "entitytype",
+        ProjectView = "projectview",
+        ProjectViewBookmark = "pvbookmark",
+        Tileset = "tileset",
+        ClientFile = "clientfile",
+        Session = "session",
+        PendingAction = "pendingaction",
+        EntitySource = "entitysource",
+        ProgramKey = "programkey",
+        EntityCoords = "entitycoords",
+        Tag = "tag",
+        Attachment = "attachment",
+        Comment = "comment",
+        Link = "link",
+        AnnDocument = "anndocument",
+        AttachmentType = "attachmenttype",
+        Relation = "relation",
+        RelationType = "relationtype",
+        Lod = "lod",
+        LodCategory = "lodcategory",
+        Style = "style",
+        PublishTileset = "publishtileset",
+        User = "user",
+        UserSettings = "usersettings",
+        UserEmail = "useremail",
+        AccessToken = "accesstoken",
+        UserGroup = "usergroup",
+        Account = "account",
+        DatabaseRegion = "databaseregion",
+        CustomForm = "customform",
+        ImportedFile = "importedfile",
+        Plugin = "plugin"
+    }
+    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;
+    let DEFAULT_NO_CACHE: boolean;
+    /**
+     * Prepares a string to be included in a url.
+     * @param str
+     * @returns
+     */
+    function Encode(str: string): string;
+    interface IList<T> {
+        Items: T[];
+        TotalCount?: number;
+    }
+    enum ESortOrder {
+        None = 0,
+        Asc = 1,
+        Desc = -1
+    }
+    enum EEncoding {
+        UTF8 = "UTF-8",
+        UTF16 = "UTF-16BE"
+    }
+    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.
+     * @param base
+     * @returns
+     */
+    function PrepReqParams(base?: Api.IReqParams | IUploadReqParams): IReqParams | IUploadReqParams;
+    interface IUploadReqParams extends IReqParams {
+        onProgress?: (e: ProgressEvent) => void;
+        formData?: IDictionary<string> | FormData;
+    }
+}

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

@@ -1,63 +1,64 @@
-import { AbstractApi } from "./abstract-api";
-import { Api as A } from "./api";
-import { MessageBroker } from "../server/message-broker";
-import { GuardianApi } from "./guardian-api";
-export declare namespace BruceApi {
-    interface IGetter {
-        env: A.EEnv;
-        accountId: string;
-        getApi: (accountId?: string, env?: A.EEnv) => BruceApi.Api;
-    }
-    /**
-     * This is the request handler for Bruce Api,
-     * it should be passed to any method that wants to communicate with this particular api.
-     */
-    class Api extends AbstractApi {
-        private accountId;
-        private env;
-        private loadProm;
-        private loadCancelled;
-        private messageBroker;
-        get MessageBroker(): MessageBroker.IBroker;
-        EntityCdnUrl: string;
-        LegacyTilesetCdnUrl: string;
-        get Loading(): Promise<void>;
-        /**
-         * @param params
-         */
-        constructor(params: {
-            accountId: string;
-            env?: A.Env;
-            loadRegionalBaseUrl?: boolean;
-            loadConfig?: boolean;
-            guardian?: GuardianApi.Api;
-        });
-        /**
-         * Loads regional base url and sets up message broker.
-         * @param guardian Required for loading regional base url.
-         * @param loadConfig
-         * @returns
-         */
-        private init;
-        /**
-         * Warning: This method does not wait for init to finish loading.
-         * This means the url could be changed once fully initialized.
-         * The url will be valid either way, but the loaded one may be faster as it is region specific.
-         * Await the "Loading" promise if you care about this.
-         * @returns
-         */
-        GetBaseUrl(): string;
-        /**
-         * Warning: This will cancel the init process.
-         * The init process loads a region specific endpoint.
-         * Setting a base url will stop that process from completing.
-         * @param url
-         */
-        SetBaseUrl(url: string): void;
-        GET(url: string, params?: A.IReqParams): Promise<any>;
-        DELETE(url: string, params?: A.IReqParams): Promise<any>;
-        POST(url: string, data: any, params?: A.IReqParams): Promise<any>;
-        PUT(url: string, data: any, params?: A.IReqParams): Promise<any>;
-        UPLOAD(url: string, blob: Blob, params?: A.IUploadReqParams): Promise<any>;
-    }
-}
+import { AbstractApi } from "./abstract-api";
+import { Api as A } from "./api";
+import { MessageBroker } from "../server/message-broker";
+import { GuardianApi } from "./guardian-api";
+export declare namespace BruceApi {
+    interface IGetter {
+        env: A.EEnv;
+        accountId: string;
+        getApi: (accountId?: string, env?: A.EEnv) => BruceApi.Api;
+    }
+    /**
+     * This is the request handler for Bruce Api,
+     * it should be passed to any method that wants to communicate with this particular api.
+     */
+    class Api extends AbstractApi {
+        private accountId;
+        private env;
+        private loadProm;
+        private loadCancelled;
+        private messageBroker;
+        get MessageBroker(): MessageBroker.IBroker;
+        EntityCdnUrl: string;
+        LegacyTilesetCdnUrl: string;
+        TilesetCdnUrl: string;
+        get Loading(): Promise<void>;
+        /**
+         * @param params
+         */
+        constructor(params: {
+            accountId: string;
+            env?: A.Env;
+            loadRegionalBaseUrl?: boolean;
+            loadConfig?: boolean;
+            guardian?: GuardianApi.Api;
+        });
+        /**
+         * Loads regional base url and sets up message broker.
+         * @param guardian Required for loading regional base url.
+         * @param loadConfig
+         * @returns
+         */
+        private init;
+        /**
+         * Warning: This method does not wait for init to finish loading.
+         * This means the url could be changed once fully initialized.
+         * The url will be valid either way, but the loaded one may be faster as it is region specific.
+         * Await the "Loading" promise if you care about this.
+         * @returns
+         */
+        GetBaseUrl(): string;
+        /**
+         * Warning: This will cancel the init process.
+         * The init process loads a region specific endpoint.
+         * Setting a base url will stop that process from completing.
+         * @param url
+         */
+        SetBaseUrl(url: string): void;
+        GET(url: string, params?: A.IReqParams): Promise<any>;
+        DELETE(url: string, params?: A.IReqParams): Promise<any>;
+        POST(url: string, data: any, params?: A.IReqParams): Promise<any>;
+        PUT(url: string, data: any, params?: A.IReqParams): Promise<any>;
+        UPLOAD(url: string, blob: Blob, params?: A.IUploadReqParams): Promise<any>;
+    }
+}

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

@@ -1,26 +1,26 @@
-import { AbstractApi } from "./abstract-api";
-import { Api as A } 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.
- * @deprecated Please use GuardianApi instead.
- */
-export declare namespace CamApi {
-    interface IGetter {
-        env: A.EEnv;
-        getApi: (env?: A.EEnv) => CamApi.Api;
-    }
-    class Api extends AbstractApi {
-        private env;
-        constructor(params: {
-            env?: A.Env;
-        });
-        private setBaseUrl;
-        GetBaseUrl(): string;
-        SetBaseUrl(url: string): void;
-        GET(url: string, params?: A.IReqParams): Promise<any>;
-        DELETE(url: string, params?: A.IReqParams): Promise<any>;
-        POST(url: string, data: any, params?: A.IReqParams): Promise<any>;
-        UPLOAD(url: string, blob: Blob, params?: A.IUploadReqParams): Promise<any>;
-    }
-}
+import { AbstractApi } from "./abstract-api";
+import { Api as A } 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.
+ * @deprecated Please use GuardianApi instead.
+ */
+export declare namespace CamApi {
+    interface IGetter {
+        env: A.EEnv;
+        getApi: (env?: A.EEnv) => CamApi.Api;
+    }
+    class Api extends AbstractApi {
+        private env;
+        constructor(params: {
+            env?: A.Env;
+        });
+        private setBaseUrl;
+        GetBaseUrl(): string;
+        SetBaseUrl(url: string): void;
+        GET(url: string, params?: A.IReqParams): Promise<any>;
+        DELETE(url: string, params?: A.IReqParams): Promise<any>;
+        POST(url: string, data: any, params?: A.IReqParams): Promise<any>;
+        UPLOAD(url: string, blob: Blob, params?: A.IUploadReqParams): Promise<any>;
+    }
+}

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

@@ -1,25 +1,25 @@
-import { AbstractApi } from "./abstract-api";
-import { Api as A } from "./api";
-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;
-        });
-        private setBaseUrl;
-        GetBaseUrl(): string;
-        SetBaseUrl(url: string): void;
-        GET(url: string, params?: A.IReqParams): Promise<any>;
-        DELETE(url: string, params?: A.IReqParams): Promise<any>;
-        POST(url: string, data: any, params?: A.IReqParams): Promise<any>;
-        UPLOAD(url: string, blob: Blob, params?: A.IUploadReqParams): Promise<any>;
-    }
-}
+import { AbstractApi } from "./abstract-api";
+import { Api as A } from "./api";
+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;
+        });
+        private setBaseUrl;
+        GetBaseUrl(): string;
+        SetBaseUrl(url: string): void;
+        GET(url: string, params?: A.IReqParams): Promise<any>;
+        DELETE(url: string, params?: A.IReqParams): Promise<any>;
+        POST(url: string, data: any, params?: A.IReqParams): Promise<any>;
+        UPLOAD(url: string, blob: Blob, params?: A.IUploadReqParams): Promise<any>;
+    }
+}

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

@@ -1,25 +1,25 @@
-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.
- */
-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;
-        });
-        private setBaseUrl;
-        GetBaseUrl(): string;
-        SetBaseUrl(url: string): void;
-        GET(url: string, params?: A.IReqParams): Promise<any>;
-        DELETE(url: string, params?: A.IReqParams): Promise<any>;
-        POST(url: string, data: any, params?: A.IReqParams): Promise<any>;
-        UPLOAD(url: string, blob: Blob, params?: A.IUploadReqParams): Promise<any>;
-    }
-}
+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.
+ */
+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;
+        });
+        private setBaseUrl;
+        GetBaseUrl(): string;
+        SetBaseUrl(url: string): void;
+        GET(url: string, params?: A.IReqParams): Promise<any>;
+        DELETE(url: string, params?: A.IReqParams): Promise<any>;
+        POST(url: string, data: any, params?: A.IReqParams): Promise<any>;
+        UPLOAD(url: string, blob: Blob, params?: A.IUploadReqParams): Promise<any>;
+    }
+}

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

@@ -1,28 +1,28 @@
-import { AbstractApi } from "./abstract-api";
-import { Api as A } from "./api";
-/**
- * * @deprecated Please use GuardianApi instead.
- */
-export declare namespace IdmApi {
-    interface IGetter {
-        env: A.EEnv;
-        getApi: (env?: A.EEnv) => IdmApi.Api;
-    }
-    /**
-     * This is the request handler for Idm 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;
-        });
-        private setBaseUrl;
-        GetBaseUrl(): string;
-        SetBaseUrl(url: string): void;
-        GET(url: string, params?: A.IReqParams): Promise<any>;
-        DELETE(url: string, params?: A.IReqParams): Promise<any>;
-        POST(url: string, data: any, params?: A.IReqParams): Promise<any>;
-        UPLOAD(url: string, blob: Blob, params?: A.IUploadReqParams): Promise<any>;
-    }
-}
+import { AbstractApi } from "./abstract-api";
+import { Api as A } from "./api";
+/**
+ * * @deprecated Please use GuardianApi instead.
+ */
+export declare namespace IdmApi {
+    interface IGetter {
+        env: A.EEnv;
+        getApi: (env?: A.EEnv) => IdmApi.Api;
+    }
+    /**
+     * This is the request handler for Idm 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;
+        });
+        private setBaseUrl;
+        GetBaseUrl(): string;
+        SetBaseUrl(url: string): void;
+        GET(url: string, params?: A.IReqParams): Promise<any>;
+        DELETE(url: string, params?: A.IReqParams): Promise<any>;
+        POST(url: string, data: any, params?: A.IReqParams): Promise<any>;
+        UPLOAD(url: string, blob: Blob, params?: A.IUploadReqParams): Promise<any>;
+    }
+}