bruce-models 7.1.73 → 7.1.75

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

@@ -6,6 +6,19 @@ import { EntityCoords } from "./entity-coords";
 import { Transform } from "../common/transform";
 import { Geometry } from "../common/geometry";
 export declare namespace EntityHistoricData {
+    type TSeriesInterval = "hour" | "day" | "week" | "month";
+    type TSeriesAggregate = "min" | "max" | "sum" | "avg" | "count";
+    let STATIC_CACHE_DURATION: number;
+    let LIVE_CACHE_DURATION: number;
+    interface IRecord {
+        "Entity.ID"?: string;
+        AttrKey?: string;
+        DateTime?: string;
+        Entity?: any;
+        Scenario?: string | number;
+        Created?: string;
+        Updated?: string;
+    }
     interface IData {
         attrKey: string;
         dateTime: string;
@@ -25,6 +38,7 @@ export declare namespace EntityHistoricData {
     /**
      * 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.
+     * @deprecated Don't use.
      * @param params
      * @returns
      */
@@ -41,6 +55,7 @@ export declare namespace EntityHistoricData {
     }>;
     /**
      * Returns historic data statistics for an array of Entity IDs.
+     * @deprecated Don't use.
      * @param params
      * @returns
      */
@@ -55,6 +70,7 @@ export declare namespace EntityHistoricData {
     /**
      * Creates or updates historic data records.
      * Please note that the expected input/output does not include internal fields found inside the "Bruce" attribute.
+     * @deprecated Don't use.
      * @param params
      * @returns
      */
@@ -69,6 +85,7 @@ export declare namespace EntityHistoricData {
     /**
      * Deletes historic data records for an array of Entity IDs.
      * This deletes all records within a provided key + range.
+     * @deprecated Don't use.
      * @param params
      * @returns
      */
@@ -80,6 +97,211 @@ export declare namespace EntityHistoricData {
         api?: BruceApi.Api;
         req?: Api.IReqParams;
     }): Promise<void>;
+    interface IAnalysisBucket {
+        From: string;
+        To: string;
+        Count: number;
+    }
+    interface IAnalysis {
+        AttrKey: string;
+        Count: number;
+        DateTimeMin: string;
+        DateTimeMax: string;
+        Buckets: IAnalysisBucket[];
+    }
+    interface ISeriesPoint {
+        Time: string;
+        Value: number;
+        Samples: number;
+    }
+    interface ISeries {
+        AttrKey: string;
+        "Entity.ID"?: string;
+        Aggregate: string;
+        Interval: string;
+        DateTimeMin: string;
+        DateTimeMax: string;
+        PointCount: number;
+        Points: ISeriesPoint[];
+    }
+    /**
+     * Returns a histogram of where historic records sit in time, without returning the records.
+     * Answers "when does this data exist" for a timeline in one request, at a cost that does not grow with the number of records.
+     * @param params
+     * @returns
+     */
+    function GetAnalysis(params: {
+        entityIds?: string[];
+        entityTypeId?: string;
+        attrKey?: string | string[];
+        dateTimeFrom?: string;
+        dateTimeTo?: string;
+        scenario?: string | number;
+        buckets?: number;
+        live?: boolean;
+        api?: BruceApi.Api;
+        req?: Api.IReqParams;
+    }): Promise<{
+        analysis: IAnalysis[];
+    }>;
+    /**
+     * Returns the date range and record count per attribute key, in the shape GetStats returns.
+     * Prefer GetAnalysis directly, which also carries the distribution.
+     * @param params
+     * @returns
+     */
+    function GetRanges(params: {
+        entityIds?: string[];
+        entityTypeId?: string;
+        attrKey?: string | string[];
+        dateTimeFrom?: string;
+        dateTimeTo?: string;
+        scenario?: string | number;
+        live?: boolean;
+        api?: BruceApi.Api;
+        req?: Api.IReqParams;
+    }): Promise<{
+        stats: IStats[];
+    }>;
+    /**
+     * Returns a numeric attribute aggregated into time buckets, computed in the database.
+     * This is what a chart wants: the reduction happens server-side, so the response is the size of
+     * the plotted series rather than the size of the underlying records.
+     * @param params
+     * @returns
+     */
+    function GetSeries(params: {
+        entityIds?: string[];
+        entityTypeId?: string;
+        attrKey?: string | string[];
+        valueAttrKey: string | string[];
+        dateTimeFrom?: string;
+        dateTimeTo?: string;
+        scenario?: string | number;
+        aggregate?: TSeriesAggregate;
+        interval?: TSeriesInterval;
+        live?: boolean;
+        api?: BruceApi.Api;
+        req?: Api.IReqParams;
+    }): Promise<{
+        series: ISeries;
+    }>;
+    /**
+     * Returns one aggregated series per Entity, computed in the database in a single request.
+     * @param params
+     * @returns
+     */
+    function GetSeriesByEntity(params: {
+        entityIds?: string[];
+        entityTypeId?: string;
+        attrKey?: string | string[];
+        valueAttrKey: string | string[];
+        dateTimeFrom?: string;
+        dateTimeTo?: string;
+        scenario?: string | number;
+        aggregate?: TSeriesAggregate;
+        interval?: TSeriesInterval;
+        live?: boolean;
+        api?: BruceApi.Api;
+        req?: Api.IReqParams;
+    }): Promise<{
+        seriesByIds: IDictionary<ISeries>;
+    }>;
+    /**
+     * Returns one page of historic records, newest first by default.
+     * @param params
+     * @returns
+     */
+    function GetPage(params: {
+        entityIds?: string[];
+        entityTypeId?: string;
+        attrKey?: string | string[];
+        dateTimeFrom?: string;
+        dateTimeTo?: string;
+        scenario?: string | number;
+        pageIndex?: number;
+        pageSize?: number;
+        sample?: number;
+        orderBy?: "id" | "datetime" | "attrkey" | "created";
+        orderDir?: "ASC" | "DESC";
+        live?: boolean;
+        api?: BruceApi.Api;
+        req?: Api.IReqParams;
+    }): Promise<{
+        items: any[];
+        pageIndex: number;
+        pageSize: number;
+        sample: number;
+    }>;
+    function ToDataRecord(record: any): IData;
+    /**
+     * Returns records grouped per Entity.
+     * @param params
+     * @returns
+     */
+    function GetRecordsByEntity(params: {
+        entityIds?: string[];
+        entityTypeId?: string;
+        attrKey?: string | string[];
+        dateTimeFrom?: string;
+        dateTimeTo?: string;
+        scenario?: string | number;
+        sample?: number;
+        pageSize?: number;
+        pageIndex?: number;
+        orderBy?: "id" | "datetime" | "attrkey" | "created";
+        orderDir?: "ASC" | "DESC";
+        live?: boolean;
+        api?: BruceApi.Api;
+        req?: Api.IReqParams;
+    }): Promise<{
+        recordsByIds: IDictionary<IData[]>;
+        sample: number;
+    }>;
+    function BuildRecord(params: {
+        entityId: string;
+        attrKey: string | string[];
+        dateTime: string;
+        values?: any;
+        internal?: {
+            Location?: EntityCoords.ILocation;
+            Transform?: Transform.ITransform;
+            Boundaries?: Bounds.IBounds;
+            VectorGeometry?: Geometry.IGeometry;
+        };
+        scenario?: string | number;
+    }): IRecord;
+    /**
+     * Creates or updates historic records.
+     * @param params
+     * @returns
+     */
+    function Save(params: {
+        records: IRecord[];
+        scenario?: string | number;
+        api?: BruceApi.Api;
+        req?: Api.IReqParams;
+    }): Promise<{
+        records: IRecord[];
+        warnings: string[];
+    }>;
+    /**
+     * Deletes every historic record matching the filter, and reports how many were removed.
+     * The filter is the one the reads accept, so a caller can delete exactly what it just listed.
+     * @param params
+     * @returns
+     */
+    function DeleteRange(params: {
+        entityIds: string[];
+        attrKey?: string | string[];
+        dateTimeFrom?: string;
+        dateTimeTo?: string;
+        scenario?: string | number;
+        api?: BruceApi.Api;
+        req?: Api.IReqParams;
+    }): Promise<{
+        deleted: number;
+    }>;
     function GetListCacheKey(entityIds: string[], attrKey: string, dateTimeFrom: string, dateTimeTo: string): string;
     function GetStatsCacheKey(entityIds?: string[], typeId?: string): string;
     function ClearCacheByEntityIds(api: BruceApi.Api, entityIds: string[]): void;

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

@@ -41,6 +41,13 @@ export declare namespace Ontology {
         ontologyId: OntologyId;
         req?: Api.IReqParams;
     }): Promise<void>;
+    function Describe(params: {
+        api?: BruceApi.Api;
+        ontologyId: OntologyId;
+        req?: Api.IReqParams;
+    }): Promise<{
+        markdown: string;
+    }>;
     function ParseResponse(response: IOntology | {
         Ontology?: IOntology;
         BruceOntology?: IOntology;

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

@@ -275,6 +275,7 @@ export declare namespace MenuItem {
         interface IEntitiesTileset extends IItem {
             BruceEntity?: {
                 "EntityType.ID"?: string;
+                historicAttrKey?: string;
                 historic?: boolean;
             };
             Type: EType.EntityTileset;

package/package.json

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