bruce-models 2.2.5 → 2.2.6

package/dist/lib/server/hosting-location.js

@@ -0,0 +1,138 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HostingLocation = void 0;
+const account_1 = require("../account/account");
+const api_1 = require("../api/api");
+/**
+ * A hosting location is a record for a possible bruce-api server configuration.
+ * A hosting location will have one or many database servers as well, this is an additional setting.
+ */
+var HostingLocation;
+(function (HostingLocation) {
+    /**
+     * @Warning: This will not return the Settings property.
+     * @param params
+     * @returns
+     */
+    function GetList(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const res = yield params.api.GET("hostinglocations", api_1.Api.PrepReqParams(params.req));
+            return {
+                locations: res.Items
+            };
+        });
+    }
+    HostingLocation.GetList = GetList;
+    function GetById(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { id, api, req } = params;
+            if (!id) {
+                throw ("Invalid id");
+            }
+            const res = yield api.GET(`hostinglocation/id/${id}`, api_1.Api.PrepReqParams(req));
+            return {
+                location: res
+            };
+        });
+    }
+    HostingLocation.GetById = GetById;
+    function GetByKey(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { key, api, req } = params;
+            if (!key) {
+                throw ("Invalid key");
+            }
+            const res = yield api.GET(`hostinglocation/key/${key}`, api_1.Api.PrepReqParams(req));
+            return {
+                location: res
+            };
+        });
+    }
+    HostingLocation.GetByKey = GetByKey;
+    /**
+     * Returns hostingLocationKey from given db url.
+     * Some older accounts don't have this set, so we need to guess it.
+     * @param params
+     * @returns
+     */
+    function GuessKey(params) {
+        const { DBServer: databaseUrl } = params;
+        if (databaseUrl.includes("hyperfarm-prod-instance-1")) {
+            return "HYPERFARM";
+        }
+        if (databaseUrl.includes("prod-syd1.nextspace.host")) {
+            return "AU-VULTR-FIRST";
+        }
+        else if (databaseUrl.includes("prod-nyc1.nextspace.host")) {
+            return "US-VULTR-FIRST";
+        }
+        else if (databaseUrl.includes("prod-ams1.nextspace.host")) {
+            return "EU-VULTR-FIRST";
+        }
+        else if (databaseUrl.includes("prod-sing1.nextspace.host")) {
+            return "SE-VULTR-FIRST";
+        }
+        else if (databaseUrl.includes("dev-first")) {
+            return "DEV-FIRST";
+        }
+        else if (databaseUrl.includes(".ap-southeast-1.")) {
+            return "SE";
+        }
+        else if (databaseUrl.includes(".us-west-1.")) {
+            return "US";
+        }
+        else if (databaseUrl.includes(".eu-west-3.")) {
+            return "EU";
+        }
+        else if (databaseUrl.includes("bruce-prod-au")) {
+            return "AU";
+        }
+        else if (databaseUrl.includes("bruce-dev")) {
+            return "DEV";
+        }
+        return null;
+    }
+    HostingLocation.GuessKey = GuessKey;
+    function GetByAccountId(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { accountId, apiSettings, api, req } = params;
+            if (!accountId && !apiSettings) {
+                throw ("Invalid accountId or apiSettings");
+            }
+            const settings = apiSettings ? apiSettings : (yield account_1.Account.GetAppSettings({
+                api,
+                accountId,
+                appId: account_1.Account.EAppId.BruceApi
+            })).settings;
+            let hostingKey = settings["HostingLocation.Key"];
+            if (!hostingKey) {
+                hostingKey = settings.DBServer;
+            }
+            if (!hostingKey) {
+                hostingKey = GuessKey({
+                    DBServer: settings.DBServer
+                });
+            }
+            if (!hostingKey) {
+                return null;
+            }
+            const data = yield GetByKey({
+                key: hostingKey,
+                api,
+                req
+            });
+            return data;
+        });
+    }
+    HostingLocation.GetByAccountId = GetByAccountId;
+})(HostingLocation = exports.HostingLocation || (exports.HostingLocation = {}));
+//# sourceMappingURL=hosting-location.js.map

package/dist/lib/server/hosting-location.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"hosting-location.js","sourceRoot":"","sources":["../../../src/server/hosting-location.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,gDAA6C;AAE7C,oCAAiC;AAGjC;;;GAGG;AACH,IAAiB,eAAe,CAoK/B;AApKD,WAAiB,eAAe;IA6B5B;;;;OAIG;IACH,SAAsB,OAAO,CAAC,MAG7B;;YAGG,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,kBAAkB,EAAE,SAAG,CAAC,aAAa,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;YACpF,OAAO;gBACH,SAAS,EAAE,GAAG,CAAC,KAAK;aACvB,CAAC;QACN,CAAC;KAAA;IAVqB,uBAAO,UAU5B,CAAA;IAED,SAAsB,OAAO,CAAC,MAI7B;;YAGG,MAAM,EAAE,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,MAAM,CAAC;YAChC,IAAI,CAAC,EAAE,EAAE;gBACL,MAAK,CAAC,YAAY,CAAC,CAAC;aACvB;YACD,MAAM,GAAG,GAAG,MAAM,GAAG,CAAC,GAAG,CAAC,sBAAsB,EAAE,EAAE,EAAE,SAAG,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC;YAC9E,OAAO;gBACH,QAAQ,EAAE,GAAG;aAChB,CAAC;QACN,CAAC;KAAA;IAfqB,uBAAO,UAe5B,CAAA;IAED,SAAsB,QAAQ,CAAC,MAI9B;;YAGG,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,MAAM,CAAC;YACjC,IAAI,CAAC,GAAG,EAAE;gBACN,MAAK,CAAC,aAAa,CAAC,CAAC;aACxB;YACD,MAAM,GAAG,GAAG,MAAM,GAAG,CAAC,GAAG,CAAC,uBAAuB,GAAG,EAAE,EAAE,SAAG,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC;YAChF,OAAO;gBACH,QAAQ,EAAE,GAAG;aAChB,CAAC;QACN,CAAC;KAAA;IAfqB,wBAAQ,WAe7B,CAAA;IAED;;;;;OAKG;IACH,SAAgB,QAAQ,CAAC,MAGxB;QACG,MAAM,EAAE,QAAQ,EAAE,WAAW,EAAE,GAAG,MAAM,CAAC;QACzC,IAAI,WAAW,CAAC,QAAQ,CAAC,2BAA2B,CAAC,EAAE;YACnD,OAAO,WAAW,CAAC;SACtB;QACD,IAAI,WAAW,CAAC,QAAQ,CAAC,0BAA0B,CAAC,EAAE;YAClD,OAAO,gBAAgB,CAAC;SAC3B;aACI,IAAI,WAAW,CAAC,QAAQ,CAAC,0BAA0B,CAAC,EAAE;YACvD,OAAO,gBAAgB,CAAC;SAC3B;aACI,IAAI,WAAW,CAAC,QAAQ,CAAC,0BAA0B,CAAC,EAAE;YACvD,OAAO,gBAAgB,CAAC;SAC3B;aACI,IAAI,WAAW,CAAC,QAAQ,CAAC,2BAA2B,CAAC,EAAE;YACxD,OAAO,gBAAgB,CAAC;SAC3B;aACI,IAAI,WAAW,CAAC,QAAQ,CAAC,WAAW,CAAC,EAAE;YACxC,OAAO,WAAW,CAAC;SACtB;aACI,IAAI,WAAW,CAAC,QAAQ,CAAC,kBAAkB,CAAC,EAAE;YAC/C,OAAO,IAAI,CAAC;SACf;aACI,IAAI,WAAW,CAAC,QAAQ,CAAC,aAAa,CAAC,EAAE;YAC1C,OAAO,IAAI,CAAC;SACf;aACI,IAAI,WAAW,CAAC,QAAQ,CAAC,aAAa,CAAC,EAAE;YAC1C,OAAO,IAAI,CAAC;SACf;aACI,IAAI,WAAW,CAAC,QAAQ,CAAC,eAAe,CAAC,EAAE;YAC5C,OAAO,IAAI,CAAC;SACf;aACI,IAAI,WAAW,CAAC,QAAQ,CAAC,WAAW,CAAC,EAAE;YACxC,OAAO,KAAK,CAAC;SAChB;QACD,OAAO,IAAI,CAAC;IAChB,CAAC;IAvCe,wBAAQ,WAuCvB,CAAA;IAED,SAAsB,cAAc,CAAC,MAMpC;;YAGG,MAAM,EAAE,SAAS,EAAE,WAAW,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,MAAM,CAAC;YACpD,IAAI,CAAC,SAAS,IAAI,CAAC,WAAW,EAAE;gBAC5B,MAAK,CAAC,kCAAkC,CAAC,CAAC;aAC7C;YACD,MAAM,QAAQ,GAAG,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,MAAM,iBAAO,CAAC,cAAc,CAAC;gBACvE,GAAG;gBACH,SAAS;gBACT,KAAK,EAAE,iBAAO,CAAC,MAAM,CAAC,QAAQ;aACjC,CAAC,CAAC,CAAC,QAAqC,CAAC;YAC1C,IAAI,UAAU,GAAG,QAAQ,CAAC,qBAAqB,CAAC,CAAC;YACjD,IAAI,CAAC,UAAU,EAAE;gBACb,UAAU,GAAG,QAAQ,CAAC,QAAQ,CAAC;aAClC;YACD,IAAI,CAAC,UAAU,EAAE;gBACb,UAAU,GAAG,QAAQ,CAAC;oBAClB,QAAQ,EAAE,QAAQ,CAAC,QAAQ;iBAC9B,CAAC,CAAC;aACN;YACD,IAAI,CAAC,UAAU,EAAE;gBACb,OAAO,IAAI,CAAC;aACf;YACD,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC;gBACxB,GAAG,EAAE,UAAU;gBACf,GAAG;gBACH,GAAG;aACN,CAAC,CAAC;YACH,OAAO,IAAI,CAAC;QAChB,CAAC;KAAA;IApCqB,8BAAc,iBAoCnC,CAAA;AACL,CAAC,EApKgB,eAAe,GAAf,uBAAe,KAAf,uBAAe,QAoK/B"}

package/dist/types/account/account-settings.d.ts

@@ -2,6 +2,8 @@ import { Api } from "../bruce-models";
 export declare namespace AccountSettings {
     type Settings = IBruceApi | INavigator | any;
     interface IBruceApi {
+        "HostingLocation.Key"?: string;
+        "DatabaseServer.ID"?: number;
         DBLocation?: string;
         DBServer?: string;
         DBReadonlyServers?: string[];

package/dist/types/account/account.d.ts

@@ -1,6 +1,7 @@
 import { Api } from "../api/api";
 import { BruceApi } from "../api/bruce-api";
 import { CamApi } from "../api/cam-api";
+import { GuardianApi } from "../api/guardian-api";
 import { IdmApi } from "../api/idm-api";
 import { AccountSettings } from "./account-settings";
 /**
@@ -11,21 +12,6 @@ export declare namespace Account {
     function GetCacheKey(accountId: string, appSettingsId?: string): string;
     function GetListCacheKey(ssid: string): string;
     function GetDbRegionListCacheKey(): Api.ECacheKey;
-    interface IDbRegion {
-        key: EDbRegion | string;
-        name?: string;
-        allowCreation?: boolean;
-        CDN?: {
-            legacyTilesetURL?: Record<Api.Env, string>;
-            entityURL?: Record<Api.Env, string>;
-        };
-    }
-    enum EDbRegion {
-        USA = "US",
-        Paris = "EU",
-        Singapore = "SE",
-        Australia = "AU"
-    }
     enum EAppId {
         BruceApi = "BruceAPI",
         Navigator = "Navigator"
@@ -46,7 +32,7 @@ export declare namespace Account {
         "Application.Settings"?: AccountSettings.Settings;
     }
     function Get(params: {
-        api: CamApi.Api;
+        api: CamApi.Api | GuardianApi.Api;
         accountId: string;
         req?: Api.IReqParams;
     }): Promise<{
@@ -59,7 +45,7 @@ export declare namespace Account {
         accounts: IAccount[];
     }>;
     function GetAppSettings(params: {
-        api: CamApi.Api;
+        api: CamApi.Api | GuardianApi.Api;
         accountId: string;
         appId: AppId;
         req?: Api.IReqParams;
@@ -72,7 +58,7 @@ export declare namespace Account {
      * @returns
      */
     function UpdateAppSettings(params: {
-        api: CamApi.Api;
+        api: CamApi.Api | GuardianApi.Api;
         accountId: string;
         appId: string;
         settings: AccountSettings.Settings;
@@ -89,21 +75,10 @@ export declare namespace Account {
         api: BruceApi.Api;
         accountId: string;
         name: string;
-        region: EDbRegion | string;
+        hostingLocationKey: string;
         starterContent?: EStarterContent;
         req?: Api.IReqParams;
     }): Promise<{
         account: IAccount;
     }>;
-    function GetDbRegions(params: {
-        api: BruceApi.Api;
-        key?: EDbRegion | string;
-        req?: Api.IReqParams;
-    }): Promise<{
-        regions: IDbRegion[];
-        errors: string[];
-    }>;
-    function GuessDbLocation(params: {
-        DBServer?: string;
-    }): "HYPERFARM" | "AU-VULTR-FIRST" | "US-VULTR-FIRST" | "EU-VULTR-FIRST" | "SE-VULTR-FIRST" | "DEV-FIRST" | "SE" | "US" | "EU" | "AU" | "DEV";
 }

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

@@ -2,11 +2,13 @@ import { Api } from "./api";
 import { BruceApi } from "./bruce-api";
 import { CamApi } from "./cam-api";
 import { GlobalApi } from "./global-api";
+import { GuardianApi } from "./guardian-api";
 import { IdmApi } from "./idm-api";
 export declare class ApiGetters {
     private bruce;
     private idm;
     private cam;
+    private guardian;
     private global;
     private accountId;
     private env;
@@ -27,16 +29,36 @@ export declare class ApiGetters {
         env?: Api.EEnv;
     }): BruceApi.Api;
     GetBruceGetter(): BruceApi.IGetter;
+    /**
+     * Deprecated: Use GetGuardianApi instead.
+     * @returns
+     */
     GetIdmApi(params: {
         env?: Api.EEnv;
     }): IdmApi.Api;
+    /**
+     * Deprecated: Use GetGuardianGetter instead.
+     * @returns
+     */
     GetIdmGetter(): IdmApi.IGetter;
+    /**
+     * Deprecated: Use GetGuardianApi instead.
+     * @returns
+     */
     GetCamApi(params: {
         env?: Api.EEnv;
     }): CamApi.Api;
+    /**
+     * Deprecated: Use GetGuardianGetter instead.
+     * @returns
+     */
     GetCamGetter(): CamApi.IGetter;
     GetGlobalApi(params: {
         env?: Api.EEnv;
     }): GlobalApi.Api;
     GetGlobalGetter(): GlobalApi.IGetter;
+    GetGuardianApi(params: {
+        env?: Api.EEnv;
+    }): GuardianApi.Api;
+    GetGuardianGetter(): GuardianApi.IGetter;
 }

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

@@ -1,7 +1,7 @@
 import { AbstractApi } from "./abstract-api";
 import { Api as A } from "./api";
-import { CamApi } from "./cam-api";
 import { MessageBroker } from "../server/message-broker";
+import { GuardianApi } from "./guardian-api";
 export declare namespace BruceApi {
     interface IGetter {
         env: A.EEnv;
@@ -30,11 +30,11 @@ export declare namespace BruceApi {
             env?: A.Env;
             loadRegionalBaseUrl?: boolean;
             loadConfig?: boolean;
-            cam?: CamApi.Api;
+            guardian?: GuardianApi.Api;
         });
         /**
          * Loads regional base url and sets up message broker.
-         * @param cam Required for loading regional base url.
+         * @param guardian Required for loading regional base url.
          * @param loadConfig
          * @returns
          */

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

@@ -3,6 +3,7 @@ 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 {

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

@@ -0,0 +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>;
+    }
+}

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

@@ -1,5 +1,8 @@
 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;

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

@@ -52,6 +52,7 @@ export * from "./project/project-view-legacy-tile";
 export * from "./project/project-view-tile";
 export * from "./server/pending-action";
 export * from "./server/message-broker";
+export * from "./server/hosting-location";
 export * from "./style/style";
 export * from "./tileset/tileset";
 export * from "./user/permission";

package/dist/types/server/hosting-location.d.ts

@@ -0,0 +1,65 @@
+import { AccountSettings } from "../account/account-settings";
+import { Api } from "../api/api";
+import { GuardianApi } from "../api/guardian-api";
+/**
+ * A hosting location is a record for a possible bruce-api server configuration.
+ * A hosting location will have one or many database servers as well, this is an additional setting.
+ */
+export declare namespace HostingLocation {
+    interface ILocation {
+        ID: number;
+        Key: string;
+        IsEnabledForNewAccounts: boolean;
+        DisplayName?: string;
+        Description?: string;
+        AWSRegion?: string;
+        Country?: string;
+        Hoster?: string;
+        City?: string;
+        BruceAPIURL?: string;
+        Environment?: string;
+        Settings?: any;
+    }
+    /**
+     * @Warning: This will not return the Settings property.
+     * @param params
+     * @returns
+     */
+    function GetList(params: {
+        api: GuardianApi.Api;
+        req?: Api.IReqParams;
+    }): Promise<{
+        locations: ILocation[];
+    }>;
+    function GetById(params: {
+        id: number;
+        api: GuardianApi.Api;
+        req?: Api.IReqParams;
+    }): Promise<{
+        location: ILocation;
+    }>;
+    function GetByKey(params: {
+        key: string;
+        api: GuardianApi.Api;
+        req?: Api.IReqParams;
+    }): Promise<{
+        location: ILocation;
+    }>;
+    /**
+     * Returns hostingLocationKey from given db url.
+     * Some older accounts don't have this set, so we need to guess it.
+     * @param params
+     * @returns
+     */
+    function GuessKey(params: {
+        DBServer?: string;
+    }): "HYPERFARM" | "AU-VULTR-FIRST" | "US-VULTR-FIRST" | "EU-VULTR-FIRST" | "SE-VULTR-FIRST" | "DEV-FIRST" | "SE" | "US" | "EU" | "AU" | "DEV";
+    function GetByAccountId(params: {
+        accountId?: string;
+        apiSettings?: AccountSettings.IBruceApi;
+        api: GuardianApi.Api;
+        req?: Api.IReqParams;
+    }): Promise<{
+        location: ILocation;
+    }>;
+}

package/package.json

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