bruce-models 4.3.9 → 4.4.0

package/dist/bruce-models.es5.js

@@ -2777,6 +2777,115 @@ var ObjectUtils;
     ObjectUtils.UId = UId;
 })(ObjectUtils || (ObjectUtils = {}));
 
+/**
+ * Describes an entity type schema attribute.
+ */
+var EntityAttribute;
+(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;
+})(EntityAttribute || (EntityAttribute = {}));
+
 /**
  * Describes the "Entity Type" concept within Nextspace.
  * An entity type is an "expectation" of what data "should" look like in a particular entity record.
@@ -2806,6 +2915,7 @@ var EntityType;
             const prom = new Promise((res, rej) => __awaiter(this, void 0, void 0, function* () {
                 try {
                     const data = yield api.GET(`entitytype/${typeId}`, Api.PrepReqParams(reqParams));
+                    appendInternalAttrSchema(data);
                     res({
                         entityType: data
                     });
@@ -2869,6 +2979,9 @@ var EntityType;
                         }
                     }
                     const data = yield api.GET("entitytypes?" + urlParams.toString(), Api.PrepReqParams(reqParams));
+                    for (const item of data.Items) {
+                        appendInternalAttrSchema(item);
+                    }
                     res({
                         entityTypes: data.Items
                     });
@@ -2909,6 +3022,7 @@ var EntityType;
             if (!data.Name) {
                 data.Name = data.ID;
             }
+            appendInternalAttrSchema(data);
             const res = yield api.POST(`entitytype/${data.ID}`, data, Api.PrepReqParams(reqParams));
             api.Cache.Remove(GetCacheKey(data.ID));
             api.Cache.RemoveByStartsWith(GetListCacheKey());
@@ -2997,6 +3111,176 @@ var EntityType;
     }
     EntityType.GetListCacheKey = GetListCacheKey;
 })(EntityType || (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: 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: EntityAttribute.EType.Structure,
+            Structure: [
+                {
+                    Key: "latitude",
+                    Name: "Latitude",
+                    Type: EntityAttribute.EType.Double,
+                    IsIndexed: true,
+                    IsImportant: false
+                },
+                {
+                    Key: "longitude",
+                    Name: "Longitude",
+                    Type: EntityAttribute.EType.Double,
+                    IsIndexed: true,
+                    IsImportant: false
+                },
+                {
+                    Key: "altitude",
+                    Name: "Altitude",
+                    Type: 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: EntityAttribute.EType.Structure,
+            Structure: [
+                {
+                    Key: "minLongitude",
+                    Name: "Min Longitude",
+                    Type: EntityAttribute.EType.Double,
+                    IsIndexed: true,
+                    IsImportant: false
+                },
+                {
+                    Key: "maxLongitude",
+                    Name: "Max Longitude",
+                    Type: EntityAttribute.EType.Double,
+                    IsIndexed: true,
+                    IsImportant: false
+                },
+                {
+                    Key: "minLatitude",
+                    Name: "Min Latitude",
+                    Type: EntityAttribute.EType.Double,
+                    IsIndexed: true,
+                    IsImportant: false
+                },
+                {
+                    Key: "maxLatitude",
+                    Name: "Max Latitude",
+                    Type: EntityAttribute.EType.Double,
+                    IsIndexed: true,
+                    IsImportant: false
+                },
+                {
+                    Key: "minAltitude",
+                    Name: "Min Altitude",
+                    Type: EntityAttribute.EType.Double,
+                    IsIndexed: true,
+                    IsImportant: false
+                },
+                {
+                    Key: "maxAltitude",
+                    Name: "Max Altitude",
+                    Type: 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: EntityAttribute.EType.Structure,
+            Structure: [
+                {
+                    Key: "heading",
+                    Name: "Heading",
+                    IsIndexed: true,
+                    IsImportant: false,
+                    Type: EntityAttribute.EType.Double
+                },
+                {
+                    Key: "pitch",
+                    Name: "Pitch",
+                    IsIndexed: true,
+                    IsImportant: false,
+                    Type: EntityAttribute.EType.Double
+                },
+                {
+                    Key: "roll",
+                    Name: "Roll",
+                    IsIndexed: true,
+                    IsImportant: false,
+                    Type: EntityAttribute.EType.Double
+                },
+                {
+                    Key: "scale",
+                    Name: "Scale",
+                    IsIndexed: true,
+                    IsImportant: false,
+                    Type: EntityAttribute.EType.Double
+                }
+            ]
+        });
+    }
+    if (!bruce.Structure.find(x => x.Key == "VectorGeometry")) {
+        bruce.Structure.push({
+            Key: "VectorGeometry",
+            Name: "Geometry",
+            Description: "Geometry data.",
+            Type: 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.
@@ -7307,115 +7591,6 @@ var EntityTypeVisualSettings;
     })(EAction = EntityTypeVisualSettings.EAction || (EntityTypeVisualSettings.EAction = {}));
 })(EntityTypeVisualSettings || (EntityTypeVisualSettings = {}));
 
-/**
- * Describes an entity type schema attribute.
- */
-var EntityAttribute;
-(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;
-})(EntityAttribute || (EntityAttribute = {}));
-
 /**
  * Describes the "Style" concept within Nextspace.
  * A legacy way of referring to styles is "entity display settings".
@@ -13354,7 +13529,7 @@ var DataSource;
 })(DataSource || (DataSource = {}));
 
 // This is updated with the package.json version on build.
-const VERSION = "4.3.9";
+const VERSION = "4.4.0";
 
 export { VERSION, AnnDocument, CustomForm, AbstractApi, Api, BruceApi, GlobalApi, GuardianApi, ApiGetters, Calculator, Bounds, BruceEvent, CacheControl, Camera, Cartes, Carto, Color, DelayQueue, Geometry, UTC, BruceVariable, LRUCache, EntityAttachmentType, EntityAttachment, EntityComment, EntityLink, EntityLod, EntityLodCategory, EntityRelationType, EntityRelation, EntitySource, EntityTag, EntityType, Entity, EntityCoords, EntityTypeVisualSettings, EntityAttribute, EntityHistoricData, Comment, ClientFile, ProgramKey, ZoomControl, MenuItem, ProjectViewBookmark, ProjectView, ProjectViewLegacyTile, ProjectViewTile, ProjectViewLegacy, ProjectViewLegacyBookmark, PendingAction, MessageBroker, HostingLocation, Style, Tileset, Permission, Session, UserGroup, User, Account, AccountInvite, AccountFeatures, AccountLimits, EncryptUtils, MathUtils, ObjectUtils, PathUtils, UrlUtils, DataLab, ImportCad, ImportCsv, ImportJson, ImportKml, ImportedFile, Markup, Uploader, Plugin, ENVIRONMENT, DataSource };
 //# sourceMappingURL=bruce-models.es5.js.map