bruce-models 3.8.3 → 3.8.5

package/dist/types/entity/entity-historic-data.d.ts

@@ -0,0 +1,74 @@
+import { Api } from "../api/api";
+import { BruceApi } from "../api/bruce-api";
+import { IDictionary } from "../common/dictionary";
+export declare namespace EntityHistoricData {
+    interface IData {
+        attrKey: string;
+        dateTime: string;
+        entityId?: string;
+        data: any;
+    }
+    interface IStats {
+        attrKey: string;
+        dateTimeMax: string;
+        dateTimeMin: string;
+        count: number;
+    }
+    /**
+     * Returns historic data for an array of Entity IDs.
+     * A maximum number of records will be returned per Entity ID, this information is returned in the response.
+     * @param params
+     * @returns
+     */
+    function GetList(params: {
+        entityIds: string[];
+        attrKey: string | string[];
+        dateTimeFrom: string;
+        dateTimeTo: string;
+        api?: BruceApi.Api;
+        req?: Api.IReqParams;
+    }): Promise<{
+        recordsByIds: IDictionary<IData[]>;
+        limitPerEntity: number;
+    }>;
+    /**
+     * Returns historic data statistics for an array of Entity IDs.
+     * @param params
+     * @returns
+     */
+    function GetStats(params: {
+        entityIds: string[];
+        api?: BruceApi.Api;
+        req?: Api.IReqParams;
+    }): Promise<{
+        stats: IDictionary<IStats>;
+    }>;
+    /**
+     * Creates or updates historic data records.
+     * Please note that the expected input/output does not include internal fields found inside the "Bruce" attribute.
+     * @param params
+     * @returns
+     */
+    function Update(params: {
+        records: IData[];
+        api?: BruceApi.Api;
+        req?: Api.IReqParams;
+    }): Promise<{
+        records: IData[];
+        errors?: string[];
+    }>;
+    /**
+     * Deletes historic data records for an array of Entity IDs.
+     * This deletes all records within a provided key + range.
+     * @param params
+     * @returns
+     */
+    function Delete(params: {
+        entityIds: string[];
+        attrKey: string | string[];
+        dateTimeFrom: string;
+        dateTimeTo: string;
+        api?: BruceApi.Api;
+        req?: Api.IReqParams;
+    }): Promise<void>;
+}

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

@@ -1,5 +1,6 @@
 import { Api } from "../api/api";
 import { BruceApi } from "../api/bruce-api";
+import { PendingAction } from "../bruce-models";
 import { UTC } from "../common/utc";
 import { Entity } from "./entity";
 import { EntityAttribute } from "./entity-attribute";
@@ -84,6 +85,29 @@ export declare namespace EntityType {
     }): Promise<{
         entityType: IType;
     }>;
+    /**
+     * Starts a re-index background action on a specified Entity Type.
+     * This will ensure searchable data follows the current schema version.
+     * This will also perform certain data cleanup so that the data is consistent.
+     * @param params
+     * @returns
+     */
+    function ReIndex(params: {
+        api?: BruceApi.Api;
+        entityTypeId: string;
+        dataTransformId?: number;
+        req?: Api.IReqParams;
+    }): Promise<PendingAction.IAction>;
+    /**
+     * Counts the total number of Entities in an Entity Type.
+     * @param params
+     * @returns
+     */
+    function Count(params: {
+        entityTypeId: string;
+        api?: BruceApi.Api;
+        req?: Api.IReqParams;
+    }): Promise<number>;
     /**
      * Returns cache identifier for an entity type.
      * Example: {

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

@@ -26,6 +26,8 @@ export declare namespace Entity {
             ID?: string;
             "Layer.ID"?: number[];
             relations?: IRelationData[];
+            historicAttrKey?: string;
+            historicDateTime?: string;
         };
         location?: Carto.ICarto;
         boundaries?: Bounds.IBounds;
@@ -55,6 +57,9 @@ export declare namespace Entity {
         entityTypeId?: string;
         expandLocation?: boolean;
         expandRelations?: boolean;
+        historicKey?: string;
+        historicFrom?: string;
+        historicTo?: string;
         req?: Api.IReqParams;
     }): Promise<{
         entity: IEntity;
@@ -69,6 +74,9 @@ export declare namespace Entity {
         entityIds: string[];
         expandLocation?: boolean;
         expandRelations?: boolean;
+        historicKey?: string;
+        historicFrom?: string;
+        historicTo?: string;
         req?: Api.IReqParams;
     }): Promise<{
         entities: IEntity[];
@@ -199,6 +207,9 @@ export declare namespace Entity {
         analysis?: boolean;
         viaCdn?: boolean;
         viaCdnCacheToken?: number | string;
+        historicKey?: string;
+        historicFrom?: string;
+        historicTo?: string;
         req?: Api.IReqParams;
     }): Promise<{
         entities?: IEntity[];
@@ -226,6 +237,9 @@ export declare namespace Entity {
         entityTypeId?: string;
         expandLocation?: boolean;
         expandRelations?: boolean;
+        historicKey?: string;
+        historicFrom?: string;
+        historicTo?: string;
     }): string;
     /**
      * Returns cache identifier for an entity record.
@@ -238,5 +252,11 @@ export declare namespace Entity {
      * @returns
      */
     function GetContainsKey(entityId: string): string;
+    /**
+     * Returns cache identifier for entity records that have historic data.
+     * @param attrKey
+     * @returns
+     */
+    function GetHistoricContainsKey(attrKey: string): string;
 }
 export {};

package/package.json

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