bruce-models 4.3.9 → 4.4.0

package/dist/bruce-models.umd.js

@@ -2738,6 +2738,114 @@
         ObjectUtils.UId = UId;
     })(exports.ObjectUtils || (exports.ObjectUtils = {}));
 
+    /**
+     * Describes an entity type schema attribute.
+     */
+    (function (EntityAttribute) {
+        let EType;
+        (function (EType) {
+            // Arbitrary text attribute.
+            EType["String"] = "String";
+            // Floating point number attribute.
+            EType["Double"] = "Double";
+            // Whole number attribute.
+            EType["Integer"] = "Integer";
+            // iso8601 date time string.
+            EType["Datetime"] = "Datetime";
+            // Group of attributes.
+            EType["Structure"] = "Structure";
+            // Nextspace vector geometry.
+            EType["Geometry"] = "Geometry";
+            // True/false attribute.
+            EType["Boolean"] = "Boolean";
+        })(EType = EntityAttribute.EType || (EntityAttribute.EType = {}));
+        /**
+         * Returns an attribute from a provided hierarchy of attributes.
+         * Eg: Use the path: ["Bruce", "ID"] to find the "ID" attribute.
+         * @param items
+         * @param path
+         * @returns
+         */
+        function GetAttribute(items, path) {
+            if (!items || !path || !path.length) {
+                return null;
+            }
+            const key = path[0];
+            const item = items.find((i) => i.Key === key);
+            if (!item || !item.Structure || !path.length) {
+                return item;
+            }
+            return GetAttribute(item.Structure, path.slice(1));
+        }
+        EntityAttribute.GetAttribute = GetAttribute;
+        /**
+         * Removes an attribute from a provided hierarchy of attributes.
+         * Eg: Use the path: ["Bruce", "ID"] to remove the "ID" attribute.
+         * This will mutate the items array.
+         * @param items
+         * @param path
+         */
+        function RemoveAttribute(items, path) {
+            if (!items || !(path === null || path === void 0 ? void 0 : path.length)) {
+                return;
+            }
+            const key = path[0];
+            if (path.length === 1) {
+                // If we're at the last key in the path, remove the item from the items array.
+                const index = items.findIndex((i) => i.Key === key);
+                if (index !== -1) {
+                    items.splice(index, 1);
+                }
+                return;
+            }
+            // If we're not at the end of the path, dig further.
+            const item = items.find((i) => i.Key === key);
+            if (item && item.Structure) {
+                RemoveAttribute(item.Structure, path.slice(1));
+            }
+        }
+        EntityAttribute.RemoveAttribute = RemoveAttribute;
+        /**
+         * Adds an attribute to a provided hierarchy of attributes.
+         * Eg: Use the path: ["Bruce", "ID"] to add the "ID" attribute.
+         * This will mutate the items array.
+         * This requires the path to be valid and for a parent attribute to exist.
+         * @param items
+         * @param path
+         * @param attribute
+         */
+        function AddAttribute(items, path, attribute) {
+            if (!items || !(path === null || path === void 0 ? void 0 : path.length)) {
+                return;
+            }
+            const key = path[0];
+            if (path.length === 1) {
+                // If we're at the last key in the path, add the attribute to the items array.
+                const index = items.findIndex((i) => i.Key === key);
+                if (index !== -1) {
+                    // Overwrite existing attribute if it already exists.
+                    items[index] = attribute;
+                }
+                else {
+                    // Add new attribute if it doesn't exist.
+                    items.push(attribute);
+                }
+                return;
+            }
+            // If we're not at the end of the path, dig further.
+            let item = items.find((i) => i.Key === key);
+            if (!item) {
+                item = { Key: key, Structure: [] };
+                items.push(item);
+            }
+            if (!item.Structure) {
+                item.Structure = [];
+            }
+            AddAttribute(item.Structure, path.slice(1), attribute);
+        }
+        EntityAttribute.AddAttribute = AddAttribute;
+    })(exports.EntityAttribute || (exports.EntityAttribute = {}));
+
     (function (EntityType) {
         /**
          * Gets an entity type record.
@@ -2761,6 +2869,7 @@
                 const prom = new Promise((res, rej) => __awaiter(this, void 0, void 0, function* () {
                     try {
                         const data = yield api.GET(`entitytype/${typeId}`, exports.Api.PrepReqParams(reqParams));
+                        appendInternalAttrSchema(data);
                         res({
                             entityType: data
                         });
@@ -2824,6 +2933,9 @@
                             }
                         }
                         const data = yield api.GET("entitytypes?" + urlParams.toString(), exports.Api.PrepReqParams(reqParams));
+                        for (const item of data.Items) {
+                            appendInternalAttrSchema(item);
+                        }
                         res({
                             entityTypes: data.Items
                         });
@@ -2864,6 +2976,7 @@
                 if (!data.Name) {
                     data.Name = data.ID;
                 }
+                appendInternalAttrSchema(data);
                 const res = yield api.POST(`entitytype/${data.ID}`, data, exports.Api.PrepReqParams(reqParams));
                 api.Cache.Remove(GetCacheKey(data.ID));
                 api.Cache.RemoveByStartsWith(GetListCacheKey());
@@ -2952,6 +3065,176 @@
         }
         EntityType.GetListCacheKey = GetListCacheKey;
     })(exports.EntityType || (exports.EntityType = {}));
+    /**
+     * Adds expected internal structure items even if they aren't there.
+     * Our API should be including them but this is a safety net.
+     * @param type
+     */
+    function appendInternalAttrSchema(type) {
+        // Schema not loaded. We'll ignore.
+        if (type == null || type.DataSchema == null) {
+            return;
+        }
+        // Append internal attributes.
+        if (!type.DataSchema.Structure) {
+            type.DataSchema.Structure = [];
+        }
+        let bruce = type.DataSchema.Structure.find(a => a.Key == "Bruce");
+        if (!bruce) {
+            bruce = {
+                Key: "Bruce",
+                Name: "Bruce",
+                Description: "Nextspace internal attributes.",
+                Type: exports.EntityAttribute.EType.Structure,
+                Structure: [],
+                IsIndexed: true,
+                IsImportant: false
+            };
+            type.DataSchema.Structure.push(bruce);
+        }
+        if (!bruce.Structure) {
+            bruce.Structure = [];
+        }
+        // Append any missing internal attributes.
+        if (!bruce.Structure.find(x => x.Key == "Location")) {
+            bruce.Structure.push({
+                Key: "Location",
+                Name: "Location",
+                Description: "Location data.",
+                Type: exports.EntityAttribute.EType.Structure,
+                Structure: [
+                    {
+                        Key: "latitude",
+                        Name: "Latitude",
+                        Type: exports.EntityAttribute.EType.Double,
+                        IsIndexed: true,
+                        IsImportant: false
+                    },
+                    {
+                        Key: "longitude",
+                        Name: "Longitude",
+                        Type: exports.EntityAttribute.EType.Double,
+                        IsIndexed: true,
+                        IsImportant: false
+                    },
+                    {
+                        Key: "altitude",
+                        Name: "Altitude",
+                        Type: exports.EntityAttribute.EType.Double,
+                        IsIndexed: true,
+                        IsImportant: false
+                    }
+                ]
+            });
+        }
+        if (!bruce.Structure.find(x => x.Key == "Boundaries")) {
+            bruce.Structure.push({
+                Key: "Boundaries",
+                Name: "Boundaries",
+                Description: "Boundaries data.",
+                Type: exports.EntityAttribute.EType.Structure,
+                Structure: [
+                    {
+                        Key: "minLongitude",
+                        Name: "Min Longitude",
+                        Type: exports.EntityAttribute.EType.Double,
+                        IsIndexed: true,
+                        IsImportant: false
+                    },
+                    {
+                        Key: "maxLongitude",
+                        Name: "Max Longitude",
+                        Type: exports.EntityAttribute.EType.Double,
+                        IsIndexed: true,
+                        IsImportant: false
+                    },
+                    {
+                        Key: "minLatitude",
+                        Name: "Min Latitude",
+                        Type: exports.EntityAttribute.EType.Double,
+                        IsIndexed: true,
+                        IsImportant: false
+                    },
+                    {
+                        Key: "maxLatitude",
+                        Name: "Max Latitude",
+                        Type: exports.EntityAttribute.EType.Double,
+                        IsIndexed: true,
+                        IsImportant: false
+                    },
+                    {
+                        Key: "minAltitude",
+                        Name: "Min Altitude",
+                        Type: exports.EntityAttribute.EType.Double,
+                        IsIndexed: true,
+                        IsImportant: false
+                    },
+                    {
+                        Key: "maxAltitude",
+                        Name: "Max Altitude",
+                        Type: exports.EntityAttribute.EType.Double,
+                        IsIndexed: true,
+                        IsImportant: false
+                    }
+                ]
+            });
+        }
+        if (!bruce.Structure.find(x => x.Key == "Transform")) {
+            bruce.Structure.push({
+                Key: "Transform",
+                Name: "Transform",
+                Description: "Transform data.",
+                IsIndexed: true,
+                IsImportant: false,
+                Type: exports.EntityAttribute.EType.Structure,
+                Structure: [
+                    {
+                        Key: "heading",
+                        Name: "Heading",
+                        IsIndexed: true,
+                        IsImportant: false,
+                        Type: exports.EntityAttribute.EType.Double
+                    },
+                    {
+                        Key: "pitch",
+                        Name: "Pitch",
+                        IsIndexed: true,
+                        IsImportant: false,
+                        Type: exports.EntityAttribute.EType.Double
+                    },
+                    {
+                        Key: "roll",
+                        Name: "Roll",
+                        IsIndexed: true,
+                        IsImportant: false,
+                        Type: exports.EntityAttribute.EType.Double
+                    },
+                    {
+                        Key: "scale",
+                        Name: "Scale",
+                        IsIndexed: true,
+                        IsImportant: false,
+                        Type: exports.EntityAttribute.EType.Double
+                    }
+                ]
+            });
+        }
+        if (!bruce.Structure.find(x => x.Key == "VectorGeometry")) {
+            bruce.Structure.push({
+                Key: "VectorGeometry",
+                Name: "Geometry",
+                Description: "Geometry data.",
+                Type: exports.EntityAttribute.EType.Geometry,
+                IsIndexed: true,
+                IsImportant: false
+            });
+        }
+        // Filter out migrated/outdated ones.
+        // Removed from root and the internal structure.
+        const OUTDATED_INTERNAL = ["position", "geometry", "location", "boundaries", "transform"];
+        bruce.Structure = bruce.Structure.filter(a => !OUTDATED_INTERNAL.includes(a.Key));
+        type.DataSchema.Structure = type.DataSchema.Structure.filter(a => !OUTDATED_INTERNAL.includes(a.Key));
+    }
 
     /**
      * Utility to help with parsing and wrapping Nextspace paths.
@@ -7170,114 +7453,6 @@
         })(EAction = EntityTypeVisualSettings.EAction || (EntityTypeVisualSettings.EAction = {}));
     })(exports.EntityTypeVisualSettings || (exports.EntityTypeVisualSettings = {}));
 
-    /**
-     * Describes an entity type schema attribute.
-     */
-    (function (EntityAttribute) {
-        let EType;
-        (function (EType) {
-            // Arbitrary text attribute.
-            EType["String"] = "String";
-            // Floating point number attribute.
-            EType["Double"] = "Double";
-            // Whole number attribute.
-            EType["Integer"] = "Integer";
-            // iso8601 date time string.
-            EType["Datetime"] = "Datetime";
-            // Group of attributes.
-            EType["Structure"] = "Structure";
-            // Nextspace vector geometry.
-            EType["Geometry"] = "Geometry";
-            // True/false attribute.
-            EType["Boolean"] = "Boolean";
-        })(EType = EntityAttribute.EType || (EntityAttribute.EType = {}));
-        /**
-         * Returns an attribute from a provided hierarchy of attributes.
-         * Eg: Use the path: ["Bruce", "ID"] to find the "ID" attribute.
-         * @param items
-         * @param path
-         * @returns
-         */
-        function GetAttribute(items, path) {
-            if (!items || !path || !path.length) {
-                return null;
-            }
-            const key = path[0];
-            const item = items.find((i) => i.Key === key);
-            if (!item || !item.Structure || !path.length) {
-                return item;
-            }
-            return GetAttribute(item.Structure, path.slice(1));
-        }
-        EntityAttribute.GetAttribute = GetAttribute;
-        /**
-         * Removes an attribute from a provided hierarchy of attributes.
-         * Eg: Use the path: ["Bruce", "ID"] to remove the "ID" attribute.
-         * This will mutate the items array.
-         * @param items
-         * @param path
-         */
-        function RemoveAttribute(items, path) {
-            if (!items || !(path === null || path === void 0 ? void 0 : path.length)) {
-                return;
-            }
-            const key = path[0];
-            if (path.length === 1) {
-                // If we're at the last key in the path, remove the item from the items array.
-                const index = items.findIndex((i) => i.Key === key);
-                if (index !== -1) {
-                    items.splice(index, 1);
-                }
-                return;
-            }
-            // If we're not at the end of the path, dig further.
-            const item = items.find((i) => i.Key === key);
-            if (item && item.Structure) {
-                RemoveAttribute(item.Structure, path.slice(1));
-            }
-        }
-        EntityAttribute.RemoveAttribute = RemoveAttribute;
-        /**
-         * Adds an attribute to a provided hierarchy of attributes.
-         * Eg: Use the path: ["Bruce", "ID"] to add the "ID" attribute.
-         * This will mutate the items array.
-         * This requires the path to be valid and for a parent attribute to exist.
-         * @param items
-         * @param path
-         * @param attribute
-         */
-        function AddAttribute(items, path, attribute) {
-            if (!items || !(path === null || path === void 0 ? void 0 : path.length)) {
-                return;
-            }
-            const key = path[0];
-            if (path.length === 1) {
-                // If we're at the last key in the path, add the attribute to the items array.
-                const index = items.findIndex((i) => i.Key === key);
-                if (index !== -1) {
-                    // Overwrite existing attribute if it already exists.
-                    items[index] = attribute;
-                }
-                else {
-                    // Add new attribute if it doesn't exist.
-                    items.push(attribute);
-                }
-                return;
-            }
-            // If we're not at the end of the path, dig further.
-            let item = items.find((i) => i.Key === key);
-            if (!item) {
-                item = { Key: key, Structure: [] };
-                items.push(item);
-            }
-            if (!item.Structure) {
-                item.Structure = [];
-            }
-            AddAttribute(item.Structure, path.slice(1), attribute);
-        }
-        EntityAttribute.AddAttribute = AddAttribute;
-    })(exports.EntityAttribute || (exports.EntityAttribute = {}));
-
     (function (Style) {
         /**
          * Types of styles available.
@@ -13088,7 +13263,7 @@
     })(exports.DataSource || (exports.DataSource = {}));
 
     // This is updated with the package.json version on build.
-    const VERSION = "4.3.9";
+    const VERSION = "4.4.0";
 
     exports.VERSION = VERSION;
     exports.AbstractApi = AbstractApi;