bruce-models 7.1.76 → 7.1.77

package/dist/lib/bruce-models.js

@@ -81,6 +81,7 @@ __exportStar(require("./entity/ontology"), exports);
 __exportStar(require("./environment"), exports);
 __exportStar(require("./export/export-brz"), exports);
 __exportStar(require("./export/export-usd"), exports);
+__exportStar(require("./geography/hexbin"), exports);
 __exportStar(require("./import/import-assembly"), exports);
 __exportStar(require("./import/import-cad"), exports);
 __exportStar(require("./import/import-csv"), exports);
@@ -127,5 +128,5 @@ __exportStar(require("./util/object-utils"), exports);
 __exportStar(require("./util/path-utils"), exports);
 __exportStar(require("./util/url-utils"), exports);
 // This is updated with the package.json version on build.
-exports.VERSION = "7.1.76";
+exports.VERSION = "7.1.77";
 //# sourceMappingURL=bruce-models.js.map

package/dist/lib/bruce-models.js.map

@@ -1 +1 @@
-{"version":3,"file":"bruce-models.js","sourceRoot":"","sources":["../../src/bruce-models.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,oDAAkC;AAClC,0DAAwC;AACxC,4DAA0C;AAC1C,6DAA2C;AAC3C,2DAAyC;AACzC,2DAAyC;AACzC,6DAA2C;AAC3C,6DAA2C;AAC3C,yDAAuC;AACvC,8DAA4C;AAC5C,qDAAmC;AACnC,4CAA0B;AAC1B,oDAAkC;AAClC,kDAAgC;AAChC,mDAAiC;AACjC,qDAAmC;AACnC,sDAAoC;AACpC,0DAAwC;AACxC,0DAAwC;AACxC,4DAA0C;AAC1C,kDAAgC;AAChC,uDAAqC;AACrC,0DAAwC;AACxC,iDAA+B;AAC/B,kDAAgC;AAChC,kDAAgC;AAChC,iDAA+B;AAC/B,iDAA+B;AAC/B,uDAAqC;AACrC,sDAAoC;AACpC,mDAAiC;AACjC,oDAAkC;AAClC,qDAAmC;AACnC,mDAAiC;AACjC,qDAAmC;AACnC,+CAA6B;AAC7B,4DAA0C;AAC1C,oEAAkD;AAClD,6DAA2C;AAC3C,wDAAsC;AACtC,sDAAoC;AACpC,4DAA0C;AAC1C,4DAA0C;AAC1C,kEAAgD;AAChD,8DAA4C;AAC5C,kDAAgC;AAChC,6DAA2C;AAC3C,kEAAgD;AAChD,4DAA0C;AAC1C,0DAAwC;AACxC,yDAAuC;AACvC,gEAA8C;AAC9C,uDAAqC;AACrC,sDAAoC;AACpC,+DAA6C;AAC7C,2DAAyC;AACzC,gEAA8C;AAC9C,yDAAuC;AACvC,6DAA2C;AAC3C,sDAAoC;AACpC,uDAAqC;AACrC,+DAA6C;AAC7C,oDAAkC;AAClC,gDAA8B;AAC9B,sDAAoC;AACpC,sDAAoC;AACpC,2DAAyC;AACzC,sDAAoC;AACpC,sDAAoC;AACpC,0DAAwC;AACxC,uDAAqC;AACrC,sDAAoC;AACpC,sDAAoC;AACpC,yDAAuC;AACvC,sDAAoC;AACpC,kDAAgC;AAChC,qDAAmC;AACnC,uDAAqC;AACrC,gEAA8C;AAC9C,kDAAgC;AAChC,4DAA0C;AAC1C,sDAAoC;AACpC,yDAAuC;AACvC,kEAAgD;AAChD,wEAAsD;AACtD,gEAA8C;AAC9C,yEAAuD;AACvD,qEAAmD;AACnD,mEAAiD;AACjD,8DAA4C;AAC5C,yDAAuC;AACvC,sDAAoC;AACpC,2DAAyC;AACzC,+DAA6C;AAC7C,4DAA0C;AAC1C,0DAAwC;AACxC,0DAAwC;AACxC,8DAA4C;AAC5C,gDAA8B;AAC9B,oDAAkC;AAClC,sDAAoC;AACpC,oDAAkC;AAClC,iDAA+B;AAC/B,8CAA4B;AAC5B,oDAAkC;AAClC,yDAAuC;AACvC,uDAAqC;AACrC,oDAAkC;AAClC,sDAAoC;AACpC,oDAAkC;AAClC,mDAAiC;AAEjC,0DAA0D;AAC7C,QAAA,OAAO,GAAG,QAAQ,CAAC"}
+{"version":3,"file":"bruce-models.js","sourceRoot":"","sources":["../../src/bruce-models.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,oDAAkC;AAClC,0DAAwC;AACxC,4DAA0C;AAC1C,6DAA2C;AAC3C,2DAAyC;AACzC,2DAAyC;AACzC,6DAA2C;AAC3C,6DAA2C;AAC3C,yDAAuC;AACvC,8DAA4C;AAC5C,qDAAmC;AACnC,4CAA0B;AAC1B,oDAAkC;AAClC,kDAAgC;AAChC,mDAAiC;AACjC,qDAAmC;AACnC,sDAAoC;AACpC,0DAAwC;AACxC,0DAAwC;AACxC,4DAA0C;AAC1C,kDAAgC;AAChC,uDAAqC;AACrC,0DAAwC;AACxC,iDAA+B;AAC/B,kDAAgC;AAChC,kDAAgC;AAChC,iDAA+B;AAC/B,iDAA+B;AAC/B,uDAAqC;AACrC,sDAAoC;AACpC,mDAAiC;AACjC,oDAAkC;AAClC,qDAAmC;AACnC,mDAAiC;AACjC,qDAAmC;AACnC,+CAA6B;AAC7B,4DAA0C;AAC1C,oEAAkD;AAClD,6DAA2C;AAC3C,wDAAsC;AACtC,sDAAoC;AACpC,4DAA0C;AAC1C,4DAA0C;AAC1C,kEAAgD;AAChD,8DAA4C;AAC5C,kDAAgC;AAChC,6DAA2C;AAC3C,kEAAgD;AAChD,4DAA0C;AAC1C,0DAAwC;AACxC,yDAAuC;AACvC,gEAA8C;AAC9C,uDAAqC;AACrC,sDAAoC;AACpC,+DAA6C;AAC7C,2DAAyC;AACzC,gEAA8C;AAC9C,yDAAuC;AACvC,6DAA2C;AAC3C,sDAAoC;AACpC,uDAAqC;AACrC,+DAA6C;AAC7C,oDAAkC;AAClC,gDAA8B;AAC9B,sDAAoC;AACpC,sDAAoC;AACpC,qDAAmC;AACnC,2DAAyC;AACzC,sDAAoC;AACpC,sDAAoC;AACpC,0DAAwC;AACxC,uDAAqC;AACrC,sDAAoC;AACpC,sDAAoC;AACpC,yDAAuC;AACvC,sDAAoC;AACpC,kDAAgC;AAChC,qDAAmC;AACnC,uDAAqC;AACrC,gEAA8C;AAC9C,kDAAgC;AAChC,4DAA0C;AAC1C,sDAAoC;AACpC,yDAAuC;AACvC,kEAAgD;AAChD,wEAAsD;AACtD,gEAA8C;AAC9C,yEAAuD;AACvD,qEAAmD;AACnD,mEAAiD;AACjD,8DAA4C;AAC5C,yDAAuC;AACvC,sDAAoC;AACpC,2DAAyC;AACzC,+DAA6C;AAC7C,4DAA0C;AAC1C,0DAAwC;AACxC,0DAAwC;AACxC,8DAA4C;AAC5C,gDAA8B;AAC9B,oDAAkC;AAClC,sDAAoC;AACpC,oDAAkC;AAClC,iDAA+B;AAC/B,8CAA4B;AAC5B,oDAAkC;AAClC,yDAAuC;AACvC,uDAAqC;AACrC,oDAAkC;AAClC,sDAAoC;AACpC,oDAAkC;AAClC,mDAAiC;AAEjC,0DAA0D;AAC7C,QAAA,OAAO,GAAG,QAAQ,CAAC"}

package/dist/lib/geography/hexbin.js

@@ -0,0 +1,90 @@
+"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.Hexbin = void 0;
+const api_1 = require("../api/api");
+const environment_1 = require("../environment");
+/**
+ * Describes the Bruce API Hexbin geography helpers.
+ */
+var Hexbin;
+(function (Hexbin) {
+    const RESOLUTIONS_CACHE_KEY = "hexbin:resolutions";
+    function GetResolutionsCacheKey() {
+        return RESOLUTIONS_CACHE_KEY;
+    }
+    Hexbin.GetResolutionsCacheKey = GetResolutionsCacheKey;
+    function GetResolutions(params) {
+        var _a, _b;
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!params) {
+                params = {};
+            }
+            let { api, req: reqParams } = params;
+            if (!api) {
+                api = environment_1.ENVIRONMENT.Api().GetBruceApi();
+            }
+            const cache = (_a = api.GetCacheItem) === null || _a === void 0 ? void 0 : _a.call(api, GetResolutionsCacheKey(), reqParams);
+            if (cache === null || cache === void 0 ? void 0 : cache.found) {
+                return cache.data;
+            }
+            const prom = api.GET("geography/hexbin/resolutions", api_1.Api.PrepReqParams(reqParams));
+            (_b = api.SetCacheItem) === null || _b === void 0 ? void 0 : _b.call(api, {
+                key: GetResolutionsCacheKey(),
+                value: prom,
+                req: reqParams
+            });
+            return prom;
+        });
+    }
+    Hexbin.GetResolutions = GetResolutions;
+    function GenerateEntities(params) {
+        var _a, _b, _c, _d;
+        return __awaiter(this, void 0, void 0, function* () {
+            let { api, targetEntityTypeId, resolution, geometry, wkt, entityId, objectBase, body, req: reqParams } = params;
+            if (!api) {
+                api = environment_1.ENVIRONMENT.Api().GetBruceApi();
+            }
+            const payload = Object.assign({}, (body !== null && body !== void 0 ? body : {}));
+            const resolvedTargetEntityTypeId = (_b = (_a = targetEntityTypeId !== null && targetEntityTypeId !== void 0 ? targetEntityTypeId : payload.TargetEntityTypeID) !== null && _a !== void 0 ? _a : payload.EntityTypeId) !== null && _b !== void 0 ? _b : payload.Type;
+            if (!resolvedTargetEntityTypeId) {
+                throw new Error("Target Entity Type ID is required. Set targetEntityTypeId, body.TargetEntityTypeID, body.EntityTypeId, or body.Type.");
+            }
+            const resolvedResolution = resolution !== null && resolution !== void 0 ? resolution : payload.Resolution;
+            if (resolvedResolution == null) {
+                throw new Error("Resolution is required.");
+            }
+            const resolvedEntityId = (_c = entityId !== null && entityId !== void 0 ? entityId : payload.EntityID) !== null && _c !== void 0 ? _c : (_d = payload.Entity) === null || _d === void 0 ? void 0 : _d.ID;
+            const resolvedGeometry = geometry !== null && geometry !== void 0 ? geometry : payload.Geometry;
+            const resolvedWkt = wkt !== null && wkt !== void 0 ? wkt : payload.WKT;
+            if (resolvedGeometry == null && resolvedWkt == null && !resolvedEntityId) {
+                throw new Error("Specify one of geometry, wkt, entityId, body.Geometry, body.WKT, or body.EntityID.");
+            }
+            payload.TargetEntityTypeID = resolvedTargetEntityTypeId;
+            payload.Resolution = resolvedResolution;
+            if (resolvedGeometry != null) {
+                payload.Geometry = resolvedGeometry;
+            }
+            if (resolvedWkt != null) {
+                payload.WKT = resolvedWkt;
+            }
+            if (resolvedEntityId) {
+                payload.EntityID = resolvedEntityId;
+            }
+            if (objectBase != null) {
+                payload.ObjectBase = objectBase;
+            }
+            return yield api.POST("geography/hexbin/entities", payload, api_1.Api.PrepReqParams(reqParams));
+        });
+    }
+    Hexbin.GenerateEntities = GenerateEntities;
+})(Hexbin = exports.Hexbin || (exports.Hexbin = {}));
+//# sourceMappingURL=hexbin.js.map

package/dist/lib/geography/hexbin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"hexbin.js","sourceRoot":"","sources":["../../../src/geography/hexbin.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,oCAAiC;AAIjC,gDAA6C;AAE7C;;GAEG;AACH,IAAiB,MAAM,CAyKtB;AAzKD,WAAiB,MAAM;IACnB,MAAM,qBAAqB,GAAG,oBAAoB,CAAC;IA8DnD,SAAgB,sBAAsB;QAClC,OAAO,qBAAqB,CAAC;IACjC,CAAC;IAFe,6BAAsB,yBAErC,CAAA;IAED,SAAsB,cAAc,CAAC,MAGpC;;;YACG,IAAI,CAAC,MAAM,EAAE;gBACT,MAAM,GAAG,EAAS,CAAC;aACtB;YACD,IAAI,EAAE,GAAG,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC;YACrC,IAAI,CAAC,GAAG,EAAE;gBACN,GAAG,GAAG,yBAAW,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC;aACzC;YAED,MAAM,KAAK,GAAG,MAAA,GAAG,CAAC,YAAY,oDAAG,sBAAsB,EAAE,EAAE,SAAS,CAAC,CAAC;YACtE,IAAI,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,KAAK,EAAE;gBACd,OAAO,KAAK,CAAC,IAAI,CAAC;aACrB;YAED,MAAM,IAAI,GAAG,GAAG,CAAC,GAAG,CAChB,8BAA8B,EAC9B,SAAG,CAAC,aAAa,CAAC,SAAS,CAAC,CACA,CAAC;YAEjC,MAAA,GAAG,CAAC,YAAY,oDAAG;gBACf,GAAG,EAAE,sBAAsB,EAAE;gBAC7B,KAAK,EAAE,IAAI;gBACX,GAAG,EAAE,SAAS;aACjB,CAAC,CAAC;YAEH,OAAO,IAAI,CAAC;;KACf;IA7BqB,qBAAc,iBA6BnC,CAAA;IAED,SAAsB,gBAAgB,CAAC,MAUtC;;;YACG,IAAI,EACA,GAAG,EACH,kBAAkB,EAClB,UAAU,EACV,QAAQ,EACR,GAAG,EACH,QAAQ,EACR,UAAU,EACV,IAAI,EACJ,GAAG,EAAE,SAAS,EACjB,GAAG,MAAM,CAAC;YAEX,IAAI,CAAC,GAAG,EAAE;gBACN,GAAG,GAAG,yBAAW,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC;aACzC;YAED,MAAM,OAAO,qBACN,CAAC,IAAI,aAAJ,IAAI,cAAJ,IAAI,GAAI,EAAE,CAAC,CAClB,CAAC;YAEF,MAAM,0BAA0B,GAAG,MAAA,MAAA,kBAAkB,aAAlB,kBAAkB,cAAlB,kBAAkB,GAAI,OAAO,CAAC,kBAAkB,mCAAI,OAAO,CAAC,YAAY,mCAAI,OAAO,CAAC,IAAI,CAAC;YAC5H,IAAI,CAAC,0BAA0B,EAAE;gBAC7B,MAAM,IAAI,KAAK,CAAC,sHAAsH,CAAC,CAAC;aAC3I;YAED,MAAM,kBAAkB,GAAG,UAAU,aAAV,UAAU,cAAV,UAAU,GAAI,OAAO,CAAC,UAAU,CAAC;YAC5D,IAAI,kBAAkB,IAAI,IAAI,EAAE;gBAC5B,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;aAC9C;YAED,MAAM,gBAAgB,GAAG,MAAA,QAAQ,aAAR,QAAQ,cAAR,QAAQ,GAAI,OAAO,CAAC,QAAQ,mCAAI,MAAA,OAAO,CAAC,MAAM,0CAAE,EAAE,CAAC;YAC5E,MAAM,gBAAgB,GAAG,QAAQ,aAAR,QAAQ,cAAR,QAAQ,GAAI,OAAO,CAAC,QAAQ,CAAC;YACtD,MAAM,WAAW,GAAG,GAAG,aAAH,GAAG,cAAH,GAAG,GAAI,OAAO,CAAC,GAAG,CAAC;YAEvC,IAAI,gBAAgB,IAAI,IAAI,IAAI,WAAW,IAAI,IAAI,IAAI,CAAC,gBAAgB,EAAE;gBACtE,MAAM,IAAI,KAAK,CAAC,oFAAoF,CAAC,CAAC;aACzG;YAED,OAAO,CAAC,kBAAkB,GAAG,0BAA0B,CAAC;YACxD,OAAO,CAAC,UAAU,GAAG,kBAAkB,CAAC;YAExC,IAAI,gBAAgB,IAAI,IAAI,EAAE;gBAC1B,OAAO,CAAC,QAAQ,GAAG,gBAAgB,CAAC;aACvC;YACD,IAAI,WAAW,IAAI,IAAI,EAAE;gBACrB,OAAO,CAAC,GAAG,GAAG,WAAW,CAAC;aAC7B;YACD,IAAI,gBAAgB,EAAE;gBAClB,OAAO,CAAC,QAAQ,GAAG,gBAAgB,CAAC;aACvC;YACD,IAAI,UAAU,IAAI,IAAI,EAAE;gBACpB,OAAO,CAAC,UAAU,GAAG,UAAU,CAAC;aACnC;YAED,OAAO,MAAM,GAAG,CAAC,IAAI,CACjB,2BAA2B,EAC3B,OAAO,EACP,SAAG,CAAC,aAAa,CAAC,SAAS,CAAC,CACP,CAAC;;KAC7B;IAtEqB,uBAAgB,mBAsErC,CAAA;AACL,CAAC,EAzKgB,MAAM,GAAN,cAAM,KAAN,cAAM,QAyKtB"}

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

@@ -64,6 +64,7 @@ export * from "./entity/ontology";
 export * from "./environment";
 export * from "./export/export-brz";
 export * from "./export/export-usd";
+export * from "./geography/hexbin";
 export * from "./import/import-assembly";
 export * from "./import/import-cad";
 export * from "./import/import-csv";
@@ -109,4 +110,4 @@ export * from "./util/math-utils";
 export * from "./util/object-utils";
 export * from "./util/path-utils";
 export * from "./util/url-utils";
-export declare const VERSION = "7.1.76";
+export declare const VERSION = "7.1.77";

package/dist/types/geography/hexbin.d.ts

@@ -0,0 +1,79 @@
+import { Api } from "../api/api";
+import { BruceApi } from "../api/bruce-api";
+import { GeoJson } from "../common/geojson";
+import { Geometry } from "../common/geometry";
+/**
+ * Describes the Bruce API Hexbin geography helpers.
+ */
+export declare namespace Hexbin {
+    interface IResolution {
+        Resolution: number;
+        Code: string;
+        AverageAreaKm2: number;
+        AverageAreaM2: number;
+        AverageEdgeLengthKm: number;
+    }
+    interface IGetResolutionsRes {
+        Items: IResolution[];
+    }
+    interface IGenerateEntitiesReq {
+        TargetEntityTypeID?: string;
+        EntityTypeId?: string;
+        Type?: string;
+        Resolution?: number;
+        Geometry?: Geometry.IGeometry | GeoJson.Geometry | any;
+        WKT?: string;
+        EntityID?: string;
+        Entity?: {
+            ID?: string;
+        };
+        ObjectBase?: any;
+        [key: string]: any;
+    }
+    interface IGeneratedEntityItem {
+        Address: string;
+        Resolution: number;
+        AverageAreaKm2: number;
+        AreaM2: number;
+        Boundary: Geometry.IGeometry;
+        Location: any;
+    }
+    interface IGenerateEntitiesStats {
+        ProducedEntityCount: number;
+        HexbinCount: number;
+        Resolution: number;
+        TotalCoveredAreaM2: number;
+        TotalCoveredAreaKm2: number;
+        InputGeometryAreaM2?: number;
+        InputGeometryAreaKm2?: number;
+        [key: string]: any;
+    }
+    interface IGenerateEntitiesRes {
+        TargetEntityTypeID: string;
+        SourceKind: string;
+        SourceEntityID?: string;
+        EntityIDs: string[];
+        Items: IGeneratedEntityItem[];
+        Stats: IGenerateEntitiesStats;
+        Warning?: any;
+        Error?: any;
+        Trace?: any;
+        [key: string]: any;
+    }
+    function GetResolutionsCacheKey(): string;
+    function GetResolutions(params?: {
+        api?: BruceApi.Api;
+        req?: Api.IReqParams;
+    }): Promise<IGetResolutionsRes>;
+    function GenerateEntities(params: {
+        api?: BruceApi.Api;
+        targetEntityTypeId?: string;
+        resolution?: number;
+        geometry?: Geometry.IGeometry | GeoJson.Geometry;
+        wkt?: string;
+        entityId?: string;
+        objectBase?: any;
+        body?: IGenerateEntitiesReq;
+        req?: Api.IReqParams;
+    }): Promise<IGenerateEntitiesRes>;
+}

package/package.json

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