bruce-models 5.5.4 → 5.5.6

package/dist/bruce-models.es5.js

@@ -3172,7 +3172,7 @@ var Entity;
      */
     function Get(params) {
         return __awaiter(this, void 0, void 0, function* () {
-            let { api, entityId, migrated, schemaId, req: reqParams, expandLocation, expandRelations, entityTypeId, historicFrom, historicKey, historicTo, historicPoint } = params;
+            let { api, entityId, scenario, migrated, schemaId, req: reqParams, expandLocation, expandRelations, entityTypeId, historicFrom, historicKey, historicTo, historicPoint } = params;
             if (!entityId) {
                 throw ("Entity ID is required.");
             }
@@ -3188,7 +3188,8 @@ var Entity;
                 historicKey,
                 historicTo,
                 historicPoint,
-                schemaId
+                schemaId,
+                scenario
             });
             const cache = api.GetCacheItem(key, reqParams);
             if (cache === null || cache === void 0 ? void 0 : cache.found) {
@@ -3228,6 +3229,9 @@ var Entity;
                     if (schemaId) {
                         urlParams.set("schema", schemaId);
                     }
+                    if (scenario && scenario > 0) {
+                        urlParams.set("Scenario", String(scenario));
+                    }
                     urlParams.set("hasMigrated", String(Boolean(migrated)));
                     const data = yield api.GET(`entity/${entityId}?${urlParams.toString()}`, Api.PrepReqParams(reqParams));
                     res({
@@ -3254,7 +3258,7 @@ var Entity;
      */
     function GetListByIds(params) {
         return __awaiter(this, void 0, void 0, function* () {
-            let { api, entityIds, migrated, schemaId, req: reqParams, expandRelations, expandLocation, historicFrom, historicKey, historicTo, historicPoint, expandSources, expandImports, maxSearchTimeSec } = params;
+            let { api, entityIds, scenario, migrated, schemaId, req: reqParams, expandRelations, expandLocation, historicFrom, historicKey, historicTo, historicPoint, expandSources, expandImports, maxSearchTimeSec } = params;
             if (!entityIds.length) {
                 throw ("Entity IDs are required.");
             }
@@ -3271,7 +3275,8 @@ var Entity;
                 historicKey: historicKey,
                 historicTo: historicTo,
                 historicPoint: historicPoint,
-                schemaId: schemaId
+                schemaId: schemaId,
+                scenario: scenario
             };
             const crashRiskReqs = [];
             const reqIds = [];
@@ -3328,6 +3333,9 @@ var Entity;
             if (historicPoint) {
                 reqData["historicPoint"] = historicPoint;
             }
+            if (scenario) {
+                reqData["Scenario"] = scenario;
+            }
             const urlParams = new URLSearchParams();
             if (schemaId) {
                 urlParams.set("schema", schemaId);
@@ -3765,7 +3773,7 @@ var Entity;
     function GetList(params) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
-            let { api, filter, migrated, schemaId, req: reqParams, viaCdn, viaCdnCacheToken, analysis, expandRelations, expandImports, historicFrom, historicKey, historicTo, historicPoint, expandLocation, expandSources, maxSearchTimeSec } = params;
+            let { api, filter, scenario, migrated, schemaId, req: reqParams, viaCdn, viaCdnCacheToken, analysis, expandRelations, expandImports, historicFrom, historicKey, historicTo, historicPoint, expandLocation, expandSources, maxSearchTimeSec } = params;
             if (!api) {
                 api = ENVIRONMENT.Api().GetBruceApi();
             }
@@ -3806,7 +3814,8 @@ var Entity;
                 historicFrom: historicFrom,
                 historicTo: historicTo,
                 historicPoint: historicPoint,
-                ExpandSources: expandSources
+                ExpandSources: expandSources,
+                Scenario: scenario
             };
             if (expandLocation || expandRelations || expandImports) {
                 let expand = "";
@@ -3883,6 +3892,9 @@ var Entity;
                 if (schemaId) {
                     urlParams.set("schema", schemaId);
                 }
+                if (scenario && scenario > 0) {
+                    urlParams.set("Scenario", String(scenario));
+                }
                 if (maxSearchTimeSec) {
                     urlParams.set("MaxSearchTimeSec", String(Math.ceil(maxSearchTimeSec)));
                 }
@@ -3946,7 +3958,8 @@ var Entity;
                                 historicFrom: historicFrom,
                                 historicKey: historicKey,
                                 historicTo: historicTo,
-                                schemaId: schemaId
+                                schemaId: schemaId,
+                                scenario: scenario
                             }),
                             value: {
                                 entity: entity
@@ -4005,7 +4018,10 @@ var Entity;
      * @returns
      */
     function GetCacheKey(params) {
-        let { entityId, entityTypeId, schemaId, expandLocation, expandRelations, expandImports, expandSources, historicFrom, historicKey, historicTo, historicPoint } = params;
+        let { entityId, scenario: scenarioId, entityTypeId, schemaId, expandLocation, expandRelations, expandImports, expandSources, historicFrom, historicKey, historicTo, historicPoint } = params;
+        if (!scenarioId) {
+            scenarioId = 0;
+        }
         if (!entityTypeId) {
             entityTypeId = "";
         }
@@ -4027,6 +4043,7 @@ var Entity;
         let key = `${Api.ECacheKey.Entity}${Api.ECacheKey.Id}${entityId}${String(entityTypeId)}${schemaId}`;
         key += `${String(Boolean(expandLocation))}${String(Boolean(expandRelations))}${String(Boolean(expandSources))}${String(Boolean(expandImports))}`;
         key += `${Api.ECacheKey.EntityHistoricData}${Api.ECacheKey.Id}${historicKey}-${historicFrom}-${historicTo}-${historicPoint}`;
+        key += `${Api.ECacheKey.Id}${scenarioId}`;
         return key;
     }
     Entity.GetCacheKey = GetCacheKey;
@@ -15001,8 +15018,110 @@ var DataSource;
     DataSource.GetListCacheKey = GetListCacheKey;
 })(DataSource || (DataSource = {}));
 
+/**
+ * A scenario is a way to manage alternative states for Entities.
+ * Once a scenario is made, you can use its ID to create/update an Entity record without affecting the primary state.
+ * When a scenario is deleted, all related alternative Entity data is also deleted.
+ */
+var Scenario;
+(function (Scenario) {
+    /**
+     * Returns a scenario record matching the provided ID or Key.
+     * @param params
+     * @returns
+     */
+    function Get(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let { scenarioId: id, scenarioKey: key, api, req } = params;
+            if (!api) {
+                api = ENVIRONMENT.Api().GetBruceApi();
+            }
+            const prom = new Promise((res, rej) => __awaiter(this, void 0, void 0, function* () {
+                try {
+                    const url = key ? `scenario/key/${key}` : `scenario/${id}`;
+                    const data = yield api.GET(url, Api.PrepReqParams(req));
+                    res({
+                        plugin: data
+                    });
+                }
+                catch (e) {
+                    rej(e);
+                }
+            }));
+            return prom;
+        });
+    }
+    Scenario.Get = Get;
+    /**
+     * Returns a list of scenarios.
+     * @param params
+     * @returns
+     */
+    function GetList(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let { api, req } = params;
+            if (!api) {
+                api = ENVIRONMENT.Api().GetBruceApi();
+            }
+            const prom = new Promise((res, rej) => __awaiter(this, void 0, void 0, function* () {
+                try {
+                    const data = yield api.GET("scenarios", Api.PrepReqParams(req));
+                    res({
+                        scenario: data.Items
+                    });
+                }
+                catch (e) {
+                    rej(e);
+                }
+            }));
+            return prom;
+        });
+    }
+    Scenario.GetList = GetList;
+    /**
+     * Creates or updates a scenario.
+     * @param params
+     */
+    function Update(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let { scenario, api, req } = params;
+            if (!scenario.DisplayName || !scenario.Key) {
+                throw ("Display name and key are required.");
+            }
+            if (!api) {
+                api = ENVIRONMENT.Api().GetBruceApi();
+            }
+            if (!scenario.ID) {
+                scenario.ID = 0;
+            }
+            const data = yield api.POST(`scenario/${scenario.ID}`, scenario, Api.PrepReqParams(req));
+            return {
+                scenario: data
+            };
+        });
+    }
+    Scenario.Update = Update;
+    /**
+     * Deletes a scenario.
+     * @param params
+     */
+    function Delete(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let { scenarioId, api, req } = params;
+            if (!scenarioId) {
+                throw ("Scenario ID is required.");
+            }
+            if (!api) {
+                api = ENVIRONMENT.Api().GetBruceApi();
+            }
+            yield api.DELETE(`scenario/${scenarioId}`, Api.PrepReqParams(req));
+        });
+    }
+    Scenario.Delete = Delete;
+})(Scenario || (Scenario = {}));
+
 // This is updated with the package.json version on build.
-const VERSION = "5.5.4";
+const VERSION = "5.5.6";
 
-export { VERSION, AnnDocument, CustomForm, AbstractApi, Api, BruceApi, GlobalApi, GuardianApi, ApiGetters, Calculator, Bounds, BruceEvent, CacheControl, Camera, Cartes, Carto, Color, DelayQueue, Geometry, UTC, BruceVariable, LRUCache, GeoJson, EntityAttachmentType, EntityAttachment, EntityComment, EntityLink, EntityLod, EntityLodCategory, EntityRelationType, EntityRelation, EntitySource, EntityTag, EntityType, Entity, EntityCoords, EntityTypeVisualSettings, EntityAttribute, EntityHistoricData, EntityTableView, Comment, ClientFile, ProgramKey, ZoomControl, MenuItem, ProjectViewBookmark, ProjectView, ProjectViewLegacyTile, ProjectViewTile, ProjectViewLegacy, ProjectViewLegacyBookmark, PendingAction, MessageBroker, HostingLocation, Style, Tileset, Permission, Session, UserGroup, User, Account, AccountInvite, AccountFeatures, AccountLimits, AccountTemplate, AccountType, EncryptUtils, MathUtils, ObjectUtils, PathUtils, UrlUtils, DataLab, DataLabGroup, ImportAssembly, ImportCad, ImportCsv, ImportJson, ImportGeoJson, ImportKml, ImportedFile, ExportBrz, ExportUsd, Markup, Uploader, Plugin, ENVIRONMENT, DataSource };
+export { VERSION, AnnDocument, CustomForm, AbstractApi, Api, BruceApi, GlobalApi, GuardianApi, ApiGetters, Calculator, Bounds, BruceEvent, CacheControl, Camera, Cartes, Carto, Color, DelayQueue, Geometry, UTC, BruceVariable, LRUCache, GeoJson, EntityAttachmentType, EntityAttachment, EntityComment, EntityLink, EntityLod, EntityLodCategory, EntityRelationType, EntityRelation, EntitySource, EntityTag, EntityType, Entity, EntityCoords, EntityTypeVisualSettings, EntityAttribute, EntityHistoricData, EntityTableView, Comment, ClientFile, ProgramKey, ZoomControl, MenuItem, ProjectViewBookmark, ProjectView, ProjectViewLegacyTile, ProjectViewTile, ProjectViewLegacy, ProjectViewLegacyBookmark, PendingAction, MessageBroker, HostingLocation, Style, Tileset, Permission, Session, UserGroup, User, Account, AccountInvite, AccountFeatures, AccountLimits, AccountTemplate, AccountType, EncryptUtils, MathUtils, ObjectUtils, PathUtils, UrlUtils, DataLab, DataLabGroup, ImportAssembly, ImportCad, ImportCsv, ImportJson, ImportGeoJson, ImportKml, ImportedFile, ExportBrz, ExportUsd, Markup, Uploader, Plugin, ENVIRONMENT, DataSource, Scenario };
 //# sourceMappingURL=bruce-models.es5.js.map