bruce-models 3.7.0 → 3.7.1

package/dist/types/entity/entity-coords.d.ts

@@ -8,17 +8,6 @@ import { Entity } from "./entity";
  */
 export declare namespace EntityCoords {
     const UCS_ENTITY_TYPE_ID = "Bruce_UCS_Type";
-    /**
-     * Returns cache identifier for a UCS by entity id.
-     * Example: {
-     *     const api: BruceApi.Api = ...;
-     *     const key = GetCacheKey("123");
-     *     api.Cache.Remove(key);
-     * }
-     * @param entityId
-     * @returns
-     */
-    function GetCacheKey(entityId: string): string;
     /**
      * Describes a UCS record.
      */
@@ -116,4 +105,15 @@ export declare namespace EntityCoords {
         rootEntityId: string;
         req?: Api.IReqParams;
     }): Promise<void>;
+    /**
+     * Returns cache identifier for a UCS by entity id.
+     * Example: {
+     *     const api: BruceApi.Api = ...;
+     *     const key = GetCacheKey("123");
+     *     api.Cache.Remove(key);
+     * }
+     * @param entityId
+     * @returns
+     */
+    function GetCacheKey(entityId: string): string;
 }

package/dist/types/entity/entity-link.d.ts

@@ -5,28 +5,6 @@ import { BruceApi } from "../api/bruce-api";
  * An entity link is an external URL linked to an entity record.
  */
 export declare namespace EntityLink {
-    /**
-     * Returns cache identifier for a link record.
-     * Example: {
-     *     const api: BruceApi.Api = ...;
-     *     const key = GetCacheKey(1);
-     *     api.Cache.Remove(key);
-     * }
-     * @param id
-     * @returns
-     */
-    function GetCacheKey(id: number): string;
-    /**
-     * Returns cache identifier for a list of links for an entity.
-     * Example: {
-     *     const api: BruceApi.Api = ...;
-     *     const key = GetListCacheKey("abc");
-     *     api.Cache.Remove(key);
-     * }
-     * @param entityId
-     * @returns
-     */
-    function GetListCacheKey(entityId: string): string;
     /**
      * Describes a link record.
      */
@@ -70,4 +48,26 @@ export declare namespace EntityLink {
     }): Promise<{
         links: ILink[];
     }>;
+    /**
+     * Returns cache identifier for a link record.
+     * Example: {
+     *     const api: BruceApi.Api = ...;
+     *     const key = GetCacheKey(1);
+     *     api.Cache.Remove(key);
+     * }
+     * @param id
+     * @returns
+     */
+    function GetCacheKey(id: number): string;
+    /**
+     * Returns cache identifier for a list of links for an entity.
+     * Example: {
+     *     const api: BruceApi.Api = ...;
+     *     const key = GetListCacheKey("abc");
+     *     api.Cache.Remove(key);
+     * }
+     * @param entityId
+     * @returns
+     */
+    function GetListCacheKey(entityId: string): string;
 }

package/dist/types/entity/entity-lod-category.d.ts

@@ -6,27 +6,6 @@ import { BruceApi } from "../api/bruce-api";
  * This is typically used to group LODs by their extension.
  */
 export declare namespace EntityLodCategory {
-    /**
-     * Returns cache identifier for an entity lod category record.
-     * Example: {
-     *     const api: BruceApi.Api = ...;
-     *     const key = GetCacheKey("abc");
-     *     api.Cache.Remove(key);
-     * }
-     * @param id
-     * @returns
-     */
-    function GetCacheKey(id: string): string;
-    /**
-     * Returns cache identifier for a list of entity lod categories.
-     * Example: {
-     *     const api: BruceApi.Api = ...;
-     *     const key = GetListCacheKey();
-     *     api.Cache.Remove(key);
-     * }
-     * @returns
-     */
-    function GetListCacheKey(): string;
     /**
      * Describes an entity lod category record.
      */
@@ -79,4 +58,25 @@ export declare namespace EntityLodCategory {
     }): Promise<{
         category: ICategory;
     }>;
+    /**
+     * Returns cache identifier for an entity lod category record.
+     * Example: {
+     *     const api: BruceApi.Api = ...;
+     *     const key = GetCacheKey("abc");
+     *     api.Cache.Remove(key);
+     * }
+     * @param id
+     * @returns
+     */
+    function GetCacheKey(id: string): string;
+    /**
+     * Returns cache identifier for a list of entity lod categories.
+     * Example: {
+     *     const api: BruceApi.Api = ...;
+     *     const key = GetListCacheKey();
+     *     api.Cache.Remove(key);
+     * }
+     * @returns
+     */
+    function GetListCacheKey(): string;
 }

package/dist/types/entity/entity-lod.d.ts

@@ -8,40 +8,6 @@ import { ClientFile } from "../client-file/client-file";
  * The most common kind is a GLB.
  */
 export declare namespace EntityLod {
-    /**
-     * Returns cache identifier for an entity lod record.
-     * Example: {
-     *     const api: BruceApi.Api = ...;
-     *     const key = GetCacheKey("abc");
-     *     api.Cache.Remove(key);
-     * }
-     * @param url
-     * @returns
-     */
-    function GetCacheKey(url: string): string;
-    /**
-     * Returns cache identifier for a list of entity lods.
-     * Example: {
-     *     const api: BruceApi.Api = ...;
-     *     const key = GetListCacheKey("abc", "def");
-     *     api.Cache.Remove(key);
-     * }
-     * @param typeId
-     * @param group
-     * @returns
-     */
-    function GetTypeListKey(typeId: string, group: string): string;
-    /**
-     * Returns cache identifier for a list of entity lods.
-     * Example: {
-     *     const api: BruceApi.Api = ...;
-     *     const key = GetListCacheKey("abc");
-     *     api.Cache.Remove(key);
-     * }
-     * @param entityId
-     * @returns
-     */
-    function GetEntityListKey(entityId: string): string;
     /**
      * Describes an entity lod record.
      * This is a 2d/3d visualization of the entity record.
@@ -167,4 +133,38 @@ export declare namespace EntityLod {
             accountId: string;
         }
     }
+    /**
+     * Returns cache identifier for an entity lod record.
+     * Example: {
+     *     const api: BruceApi.Api = ...;
+     *     const key = GetCacheKey("abc");
+     *     api.Cache.Remove(key);
+     * }
+     * @param url
+     * @returns
+     */
+    function GetCacheKey(url: string): string;
+    /**
+     * Returns cache identifier for a list of entity lods.
+     * Example: {
+     *     const api: BruceApi.Api = ...;
+     *     const key = GetListCacheKey("abc", "def");
+     *     api.Cache.Remove(key);
+     * }
+     * @param typeId
+     * @param group
+     * @returns
+     */
+    function GetTypeListKey(typeId: string, group: string): string;
+    /**
+     * Returns cache identifier for a list of entity lods.
+     * Example: {
+     *     const api: BruceApi.Api = ...;
+     *     const key = GetListCacheKey("abc");
+     *     api.Cache.Remove(key);
+     * }
+     * @param entityId
+     * @returns
+     */
+    function GetEntityListKey(entityId: string): string;
 }

package/dist/types/entity/entity-relation-type.d.ts

@@ -5,27 +5,6 @@ import { BruceApi } from "../api/bruce-api";
  * A relationship type record describes the purpose of a relationship.
  */
 export declare namespace EntityRelationType {
-    /**
-     * Returns cache identifier for an entity relation type record.
-     * Example: {
-     *     const api: BruceApi.Api = ...;
-     *     const key = GetCacheKey("abc");
-     *     api.Cache.Remove(key);
-     * }
-     * @param id
-     * @returns
-     */
-    function GetCacheKey(id: string): string;
-    /**
-     * Returns cache identifier for a list of entity relation types.
-     * Example: {
-     *     const api: BruceApi.Api = ...;
-     *     const key = GetListCacheKey();
-     *     api.Cache.Remove(key);
-     * }
-     * @returns
-     */
-    function GetListCacheKey(): string;
     /**
      * Describes an entity relation type record.
      */
@@ -82,4 +61,25 @@ export declare namespace EntityRelationType {
     }): Promise<{
         relationType: IType;
     }>;
+    /**
+     * Returns cache identifier for an entity relation type record.
+     * Example: {
+     *     const api: BruceApi.Api = ...;
+     *     const key = GetCacheKey("abc");
+     *     api.Cache.Remove(key);
+     * }
+     * @param id
+     * @returns
+     */
+    function GetCacheKey(id: string): string;
+    /**
+     * Returns cache identifier for a list of entity relation types.
+     * Example: {
+     *     const api: BruceApi.Api = ...;
+     *     const key = GetListCacheKey();
+     *     api.Cache.Remove(key);
+     * }
+     * @returns
+     */
+    function GetListCacheKey(): string;
 }

package/dist/types/entity/entity-relation.d.ts

@@ -7,39 +7,6 @@ import { Entity } from "./entity";
  * The relationship can have a "data entity" linked to it as well for the relationship to store arbitrary data about itself.
  */
 export declare namespace EntityRelation {
-    /**
-     * Returns cache identifier for an entity relation record.
-     * Example: {
-     *     const api: BruceApi.Api = ...;
-     *     const key = GetCacheKey("abc", "def", "ghi");
-     *     api.Cache.Remove(key);
-     * }
-     * @param id
-     * @returns
-     */
-    function GetCacheKey(entityA: string, entityB: string, typeId: string): string;
-    /**
-     * Returns cache identifier for a list of entity relations.
-     * Example: {
-     *     const api: BruceApi.Api = ...;
-     *     const key = GetCacheKey("abc");
-     *     api.Cache.Remove(key);
-     * }
-     * @param id
-     * @returns
-     */
-    function GetEntityCacheKey(entityId: string): string;
-    /**
-     * Returns cache identifier for a list of entity relations.
-     * Example: {
-     *     const api: BruceApi.Api = ...;
-     *     const key = GetCacheKey("abc", {...});
-     *     api.Cache.Remove(key);
-     * }
-     * @param id
-     * @returns
-     */
-    function GetListCacheKey(entityId: string, params: IListParams): string;
     /**
      * Describes an entity relation record.
      */
@@ -112,4 +79,37 @@ export declare namespace EntityRelation {
     }): Promise<{
         relation: IRelation;
     }>;
+    /**
+     * Returns cache identifier for an entity relation record.
+     * Example: {
+     *     const api: BruceApi.Api = ...;
+     *     const key = GetCacheKey("abc", "def", "ghi");
+     *     api.Cache.Remove(key);
+     * }
+     * @param id
+     * @returns
+     */
+    function GetCacheKey(entityA: string, entityB: string, typeId: string): string;
+    /**
+     * Returns cache identifier for a list of entity relations.
+     * Example: {
+     *     const api: BruceApi.Api = ...;
+     *     const key = GetCacheKey("abc");
+     *     api.Cache.Remove(key);
+     * }
+     * @param id
+     * @returns
+     */
+    function GetEntityCacheKey(entityId: string): string;
+    /**
+     * Returns cache identifier for a list of entity relations.
+     * Example: {
+     *     const api: BruceApi.Api = ...;
+     *     const key = GetCacheKey("abc", {...});
+     *     api.Cache.Remove(key);
+     * }
+     * @param id
+     * @returns
+     */
+    function GetListCacheKey(entityId: string, params: IListParams): string;
 }

package/dist/types/entity/entity-source.d.ts

@@ -7,18 +7,6 @@ import { IDictionary } from "../common/dictionary";
  * For example an OSM building id to a Nextspace entity id.
  */
 export declare namespace EntitySource {
-    /**
-     * Returns cache identifier for an entity source record.
-     * Example: {
-     *     const api: BruceApi.Api = ...;
-     *     const key = GetCacheKey(1, "def");
-     *     api.Cache.Remove(key);
-     * }
-     * @param sourceId
-     * @param sourceKey
-     * @returns
-     */
-    function GetCacheKey(sourceId: number, sourceKey: string): string;
     /**
      * Describes an entity source record.
      */
@@ -77,4 +65,16 @@ export declare namespace EntitySource {
     }): Promise<{
         source: ISource;
     }>;
+    /**
+     * Returns cache identifier for an entity source record.
+     * Example: {
+     *     const api: BruceApi.Api = ...;
+     *     const key = GetCacheKey(1, "def");
+     *     api.Cache.Remove(key);
+     * }
+     * @param sourceId
+     * @param sourceKey
+     * @returns
+     */
+    function GetCacheKey(sourceId: number, sourceKey: string): string;
 }

package/dist/types/entity/entity-tag.d.ts

@@ -6,28 +6,6 @@ import { BruceApi } from "../api/bruce-api";
  * Entity tags can be used in filters, or to restrict entity access.
  */
 export declare namespace EntityTag {
-    /**
-     * Returns cache identifier for an entity tag record.
-     * Example: {
-     *     const api: BruceApi.Api = ...;
-     *     const key = GetCacheKey(1);
-     *     api.Cache.Remove(key);
-     * }
-     * @param tagId
-     * @returns
-     */
-    function GetCacheKey(tagId: number): string;
-    /**
-     * Returns cache identifier for a list of entity tags.
-     * Example: {
-     *     const api: BruceApi.Api = ...;
-     *     const key = GetListCacheKey("abc");
-     *     api.Cache.Remove(key);
-     * }
-     * @param entityTypeId
-     * @returns
-     */
-    function GetListCacheKey(entityTypeId?: string): string;
     /**
      * Describes an entity tag record.
      */
@@ -97,4 +75,26 @@ export declare namespace EntityTag {
     }): Promise<{
         tag: ITag;
     }>;
+    /**
+     * Returns cache identifier for an entity tag record.
+     * Example: {
+     *     const api: BruceApi.Api = ...;
+     *     const key = GetCacheKey(1);
+     *     api.Cache.Remove(key);
+     * }
+     * @param tagId
+     * @returns
+     */
+    function GetCacheKey(tagId: number): string;
+    /**
+     * Returns cache identifier for a list of entity tags.
+     * Example: {
+     *     const api: BruceApi.Api = ...;
+     *     const key = GetListCacheKey("abc");
+     *     api.Cache.Remove(key);
+     * }
+     * @param entityTypeId
+     * @returns
+     */
+    function GetListCacheKey(entityTypeId?: string): string;
 }

package/dist/types/entity/entity-type.d.ts

@@ -10,27 +10,6 @@ import { EntityTypeVisualSettings } from "./entity-type-visual-settings";
  * The schema is stencils onto entity data to filter out what we should display or search against.
  */
 export declare namespace EntityType {
-    /**
-     * Returns cache identifier for an entity type.
-     * Example: {
-     *     const api: BruceApi.Api = ...;
-     *     const key = GetCacheKey("abc");
-     *     api.Cache.Remove(key);
-     * }
-     * @param typeId
-     * @returns
-     */
-    function GetCacheKey(typeId: string): string;
-    /**
-     * Returns cache identifier for a list of entity types.
-     * Example: {
-     *     const api: BruceApi.Api = ...;
-     *     const key = GetListCacheKey();
-     *     api.Cache.Remove(key);
-     * }
-     * @returns
-     */
-    function GetListCacheKey(): string;
     /**
      * Describes an entity type record.
      */
@@ -105,4 +84,25 @@ export declare namespace EntityType {
     }): Promise<{
         entityType: IType;
     }>;
+    /**
+     * Returns cache identifier for an entity type.
+     * Example: {
+     *     const api: BruceApi.Api = ...;
+     *     const key = GetCacheKey("abc");
+     *     api.Cache.Remove(key);
+     * }
+     * @param typeId
+     * @returns
+     */
+    function GetCacheKey(typeId: string): string;
+    /**
+     * Returns cache identifier for a list of entity types.
+     * Example: {
+     *     const api: BruceApi.Api = ...;
+     *     const key = GetListCacheKey();
+     *     api.Cache.Remove(key);
+     * }
+     * @returns
+     */
+    function GetListCacheKey(): string;
 }

package/dist/types/entity/entity.d.ts

@@ -15,33 +15,6 @@ type _any = any;
  * Entity records have many thinks linked to them through their UIDs such as links, files and relationships.
  */
 export declare namespace Entity {
-    /**
-     * Returns cache identifier for an entity record.
-     * Example: {
-     *     const api: BruceApi.Api = ...;
-     *     const key = GetCacheKey({...});
-     *     api.Cache.Remove(key);
-     * }
-     * @param params
-     * @returns
-     */
-    function GetCacheKey(params: {
-        entityId: string;
-        entityTypeId?: string;
-        expandLocation?: boolean;
-        expandRelations?: boolean;
-    }): string;
-    /**
-     * Returns cache identifier for an entity record.
-     * Example: {
-     *     const api: BruceApi.Api = ...;
-     *     const key = GetCacheKey("abc");
-     *     api.Cache.Remove(key);
-     * }
-     * @param entityId
-     * @returns
-     */
-    function GetContainsKey(entityId: string): string;
     /**
      * Describes an entity record.
      */
@@ -237,5 +210,32 @@ export declare namespace Entity {
         includeUserData?: boolean;
         allowedDisplayTypes?: ZoomControl.EDisplayType[];
     }): any;
+    /**
+     * Returns cache identifier for an entity record.
+     * Example: {
+     *     const api: BruceApi.Api = ...;
+     *     const key = GetCacheKey({...});
+     *     api.Cache.Remove(key);
+     * }
+     * @param params
+     * @returns
+     */
+    function GetCacheKey(params: {
+        entityId: string;
+        entityTypeId?: string;
+        expandLocation?: boolean;
+        expandRelations?: boolean;
+    }): string;
+    /**
+     * Returns cache identifier for an entity record.
+     * Example: {
+     *     const api: BruceApi.Api = ...;
+     *     const key = GetCacheKey("abc");
+     *     api.Cache.Remove(key);
+     * }
+     * @param entityId
+     * @returns
+     */
+    function GetContainsKey(entityId: string): string;
 }
 export {};

package/dist/types/program-key/program-key.d.ts

@@ -6,27 +6,6 @@ type Id = ProgramKey.EProgramId | string;
  * A program key is an access token for an arbitrary software.
  */
 export declare namespace ProgramKey {
-    /**
-     * Returns cache identifier for a program key.
-     * Example: {
-     *     const api: BruceApi.Api = ...;
-     *     const key = GetCacheKey("abc");
-     *     api.Cache.Remove(key);
-     * }
-     * @param programId
-     * @returns
-     */
-    function GetCacheKey(programId: string): string;
-    /**
-     * Returns cache identifier for a list of program keys.
-     * Example: {
-     *     const api: BruceApi.Api = ...;
-     *     const key = GetListCacheKey();
-     *     api.Cache.Remove(key);
-     * }
-     * @returns
-     */
-    function GetListCacheKey(): string;
     /**
      * Known program IDs that Nextspace applications will reference.
      */
@@ -88,5 +67,26 @@ export declare namespace ProgramKey {
     }): Promise<{
         programKey: IKey;
     }>;
+    /**
+     * Returns cache identifier for a program key.
+     * Example: {
+     *     const api: BruceApi.Api = ...;
+     *     const key = GetCacheKey("abc");
+     *     api.Cache.Remove(key);
+     * }
+     * @param programId
+     * @returns
+     */
+    function GetCacheKey(programId: string): string;
+    /**
+     * Returns cache identifier for a list of program keys.
+     * Example: {
+     *     const api: BruceApi.Api = ...;
+     *     const key = GetListCacheKey();
+     *     api.Cache.Remove(key);
+     * }
+     * @returns
+     */
+    function GetListCacheKey(): string;
 }
 export {};

package/dist/types/project/menu-item.d.ts

@@ -236,6 +236,7 @@ export declare namespace MenuItem {
                 vehicleFileId?: string;
                 lineColor?: string;
                 alertFileId?: string;
+                vehicleEntityId?: string;
             }[];
         }
         /**

package/dist/types/project/project-view-bookmark.d.ts

@@ -14,29 +14,6 @@ import { ProjectViewTile } from "./project-view-tile";
  * A bookmark is a snapshot of what should be displayed and how in a particular project view.
  */
 export declare namespace ProjectViewBookmark {
-    /**
-     * Returns cache identifier for a bookmark.
-     * Example: {
-     *     const api: BruceApi.Api = ...;
-     *     const key = GetCacheKey("abc", "def");
-     *     api.Cache.Remove(key);
-     * }
-     * @param viewId
-     * @param bookmarkId
-     * @returns
-     */
-    function GetCacheKey(viewId: string, bookmarkId: string): string;
-    /**
-     * Returns cache identifier for a list of bookmarks.
-     * Example: {
-     *     const api: BruceApi.Api = ...;
-     *     const key = GetListCacheKey("abc");
-     *     api.Cache.Remove(key);
-     * }
-     * @param viewId
-     * @returns
-     */
-    function GetListCacheKey(viewId: string): string;
     const DEFAULT_DATA_VERSION = 2;
     /**
      * Describes a bookmark record.
@@ -233,4 +210,27 @@ export declare namespace ProjectViewBookmark {
             zoom: number;
         }
     }
+    /**
+     * Returns cache identifier for a bookmark.
+     * Example: {
+     *     const api: BruceApi.Api = ...;
+     *     const key = GetCacheKey("abc", "def");
+     *     api.Cache.Remove(key);
+     * }
+     * @param viewId
+     * @param bookmarkId
+     * @returns
+     */
+    function GetCacheKey(viewId: string, bookmarkId: string): string;
+    /**
+     * Returns cache identifier for a list of bookmarks.
+     * Example: {
+     *     const api: BruceApi.Api = ...;
+     *     const key = GetListCacheKey("abc");
+     *     api.Cache.Remove(key);
+     * }
+     * @param viewId
+     * @returns
+     */
+    function GetListCacheKey(viewId: string): string;
 }