@machhub-dev/sdk-ts 1.0.17 → 1.0.18

package/dist/cjs/classes/collection.d.ts

@@ -24,9 +24,7 @@ export declare class Collection {
         expand?: string | string[];
         fields?: string | string[];
     }): Promise<any[]>;
-    count(options?: {
-        filter?: any;
-    }): Promise<number>;
+    count(): Promise<number>;
     getOne(id: string, options?: {
         expand?: string | string[];
     }): Promise<any>;

package/dist/cjs/classes/collection.js

@@ -66,12 +66,9 @@ class Collection {
             throw new CollectionError('getAll', this.collectionName, error);
         }
     }
-    async count(options) {
+    async count() {
         try {
-            this.applyOptions(options);
-            // Build query parameters for filters
             const response = await this.httpService.request.get(`${this.collectionName}/count`, this.queryParams);
-            // Extract count from response
             return response.count;
         }
         catch (error) {

package/dist/cjs/classes/historian.d.ts

@@ -1,6 +1,13 @@
 import { HTTPService } from "../services/http.service.js";
 import { MQTTService } from "../services/mqtt.service.js";
 import { HistorizedData } from "../types/tag.models.js";
+interface AggregationOption {
+    mean: "mean";
+    sum: "sum";
+    min: "min";
+    max: "max";
+    median: "median";
+}
 export declare class Historian {
     private httpService;
     private mqttService;
@@ -10,4 +17,20 @@ export declare class Historian {
     subscribeLiveData(topic: string, callback: (data: any) => void): Promise<any>;
     getLastNValues(topic: string, n: number): Promise<HistorizedData[]>;
     query(SurrealQL: string): Promise<any>;
+    /**
+     * Export historized data for one or more topics as a gzipped CSV file (Blob).
+     * When multiple topics are provided, they are merged into a single CSV with columns: [Timestamp, topic1, topic2, ...].
+     * Supports optional time bucketing (sampleRate) and aggregation (mean, sum, min, max, median).
+     *
+     * @param topics - Array of topic strings to export
+     * @param startDate - Start date for the data range
+     * @param endDate - End date for the data range
+     * @param timezone - Optional Timezone string (e.g. "Asia/Kuala Lumpur")
+     * @param sampleRate - Optional bucket interval in underscore format (e.g. "5_second", "1_minute", "1_hour")
+     * @param aggregation - Optional aggregation function: "mean" | "sum" | "min" | "max" | "median" | "none"
+     * @param mapping - Optional key-value pairs to rename topic columns in the CSV header (e.g. { "Sensor/Temperature": "Temp °C" })
+     * @returns A Blob containing the gzipped CSV data
+     */
+    getHistoricalDataAsCSV(topics: string[], startDate: Date, endDate: Date, timezone?: string, sampleRate?: string, aggregation?: AggregationOption, mapping?: Record<string, string>): Promise<Blob>;
 }
+export {};

package/dist/cjs/classes/historian.js

@@ -41,5 +41,30 @@ class Historian {
             query: SurrealQL
         }).post("historian/query");
     }
+    /**
+     * Export historized data for one or more topics as a gzipped CSV file (Blob).
+     * When multiple topics are provided, they are merged into a single CSV with columns: [Timestamp, topic1, topic2, ...].
+     * Supports optional time bucketing (sampleRate) and aggregation (mean, sum, min, max, median).
+     *
+     * @param topics - Array of topic strings to export
+     * @param startDate - Start date for the data range
+     * @param endDate - End date for the data range
+     * @param timezone - Optional Timezone string (e.g. "Asia/Kuala Lumpur")
+     * @param sampleRate - Optional bucket interval in underscore format (e.g. "5_second", "1_minute", "1_hour")
+     * @param aggregation - Optional aggregation function: "mean" | "sum" | "min" | "max" | "median" | "none"
+     * @param mapping - Optional key-value pairs to rename topic columns in the CSV header (e.g. { "Sensor/Temperature": "Temp °C" })
+     * @returns A Blob containing the gzipped CSV data
+     */
+    async getHistoricalDataAsCSV(topics, startDate, endDate, timezone, sampleRate, aggregation, mapping) {
+        return this.httpService.request.withJSON({
+            topics,
+            startDate: startDate.toISOString(),
+            endDate: endDate.toISOString(),
+            timezone,
+            sampleRate: sampleRate ?? "",
+            aggregation: aggregation ?? "",
+            mapping: mapping ?? {},
+        }).postAsBlob("historian/export/aggregated");
+    }
 }
 exports.Historian = Historian;

package/dist/cjs/sdk-ts.js

@@ -145,7 +145,8 @@ class SDK {
                 host += envCfg.pathHosted;
             }
             if (!config.httpUrl) {
-                config.httpUrl = `${secured ? 'https' : 'http'}://${host}`;
+                const httpHost = envCfg.hostingMode === 'path' ? `${host}/` : host;
+                config.httpUrl = `${secured ? 'https' : 'http'}://${httpHost}`;
             }
             if (!config.mqttUrl) {
                 config.mqttUrl = `${secured ? 'wss' : 'ws'}://${host}/mqtt`;

package/dist/cjs/services/http.service.d.ts

@@ -40,6 +40,7 @@ declare class RequestParameters {
     withJSON(body: Record<string, unknown>): RequestParameters;
     get<ReturnType>(path: string, query?: Record<string, string>): Promise<ReturnType>;
     post<ReturnType>(path: string, query?: Record<string, string>, body?: FormData | Record<string, string>): Promise<ReturnType>;
+    postAsBlob(path: string, query?: Record<string, string>): Promise<Blob>;
     put<ReturnType>(path: string, query?: Record<string, string>): Promise<ReturnType>;
     delete<ReturnType>(path: string, query?: Record<string, string>): Promise<ReturnType>;
     patch<ReturnType>(path: string, query?: Record<string, string>): Promise<ReturnType>;

package/dist/cjs/services/http.service.js

@@ -40,7 +40,7 @@ class RequestParameters {
         this.withRuntimeID(); // Ensure withRuntimeID() is called by default
     }
     withQuery(path, query) {
-        const newPath = [this.base.pathname, path].map(pathPart => pathPart.replace(/(^\/|\/$)/g, "")).join("/");
+        const newPath = "/" + [this.base.pathname, path].map(pathPart => pathPart.replace(/(^\/|\/$)/g, "")).join("/");
         const newURL = new URL(newPath, this.base);
         for (const key in query) {
             newURL.searchParams.append(key, query[key]);
@@ -183,6 +183,14 @@ class RequestParameters {
         }
         return response.json();
     }
+    async postAsBlob(path, query) {
+        const init = this.parseInit("POST") || {};
+        const response = await fetch(this.withQuery(path, query), init);
+        if (!response.ok) {
+            throw new HTTPException(response.status, response.statusText, await response.text());
+        }
+        return response.blob();
+    }
     async put(path, query) {
         const response = await fetch(this.withQuery(path, query), this.parseInit("PUT"));
         if (!response.ok) {

package/dist/classes/collection.d.ts

@@ -24,9 +24,7 @@ export declare class Collection {
         expand?: string | string[];
         fields?: string | string[];
     }): Promise<any[]>;
-    count(options?: {
-        filter?: any;
-    }): Promise<number>;
+    count(): Promise<number>;
     getOne(id: string, options?: {
         expand?: string | string[];
     }): Promise<any>;

package/dist/classes/collection.js

@@ -62,12 +62,9 @@ export class Collection {
             throw new CollectionError('getAll', this.collectionName, error);
         }
     }
-    async count(options) {
+    async count() {
         try {
-            this.applyOptions(options);
-            // Build query parameters for filters
             const response = await this.httpService.request.get(`${this.collectionName}/count`, this.queryParams);
-            // Extract count from response
             return response.count;
         }
         catch (error) {

package/dist/classes/historian.d.ts

@@ -1,6 +1,13 @@
 import { HTTPService } from "../services/http.service.js";
 import { MQTTService } from "../services/mqtt.service.js";
 import { HistorizedData } from "../types/tag.models.js";
+interface AggregationOption {
+    mean: "mean";
+    sum: "sum";
+    min: "min";
+    max: "max";
+    median: "median";
+}
 export declare class Historian {
     private httpService;
     private mqttService;
@@ -10,4 +17,20 @@ export declare class Historian {
     subscribeLiveData(topic: string, callback: (data: any) => void): Promise<any>;
     getLastNValues(topic: string, n: number): Promise<HistorizedData[]>;
     query(SurrealQL: string): Promise<any>;
+    /**
+     * Export historized data for one or more topics as a gzipped CSV file (Blob).
+     * When multiple topics are provided, they are merged into a single CSV with columns: [Timestamp, topic1, topic2, ...].
+     * Supports optional time bucketing (sampleRate) and aggregation (mean, sum, min, max, median).
+     *
+     * @param topics - Array of topic strings to export
+     * @param startDate - Start date for the data range
+     * @param endDate - End date for the data range
+     * @param timezone - Optional Timezone string (e.g. "Asia/Kuala Lumpur")
+     * @param sampleRate - Optional bucket interval in underscore format (e.g. "5_second", "1_minute", "1_hour")
+     * @param aggregation - Optional aggregation function: "mean" | "sum" | "min" | "max" | "median" | "none"
+     * @param mapping - Optional key-value pairs to rename topic columns in the CSV header (e.g. { "Sensor/Temperature": "Temp °C" })
+     * @returns A Blob containing the gzipped CSV data
+     */
+    getHistoricalDataAsCSV(topics: string[], startDate: Date, endDate: Date, timezone?: string, sampleRate?: string, aggregation?: AggregationOption, mapping?: Record<string, string>): Promise<Blob>;
 }
+export {};

package/dist/classes/historian.js

@@ -38,4 +38,29 @@ export class Historian {
             query: SurrealQL
         }).post("historian/query");
     }
+    /**
+     * Export historized data for one or more topics as a gzipped CSV file (Blob).
+     * When multiple topics are provided, they are merged into a single CSV with columns: [Timestamp, topic1, topic2, ...].
+     * Supports optional time bucketing (sampleRate) and aggregation (mean, sum, min, max, median).
+     *
+     * @param topics - Array of topic strings to export
+     * @param startDate - Start date for the data range
+     * @param endDate - End date for the data range
+     * @param timezone - Optional Timezone string (e.g. "Asia/Kuala Lumpur")
+     * @param sampleRate - Optional bucket interval in underscore format (e.g. "5_second", "1_minute", "1_hour")
+     * @param aggregation - Optional aggregation function: "mean" | "sum" | "min" | "max" | "median" | "none"
+     * @param mapping - Optional key-value pairs to rename topic columns in the CSV header (e.g. { "Sensor/Temperature": "Temp °C" })
+     * @returns A Blob containing the gzipped CSV data
+     */
+    async getHistoricalDataAsCSV(topics, startDate, endDate, timezone, sampleRate, aggregation, mapping) {
+        return this.httpService.request.withJSON({
+            topics,
+            startDate: startDate.toISOString(),
+            endDate: endDate.toISOString(),
+            timezone,
+            sampleRate: sampleRate ?? "",
+            aggregation: aggregation ?? "",
+            mapping: mapping ?? {},
+        }).postAsBlob("historian/export/aggregated");
+    }
 }

package/dist/sdk-ts.js

@@ -142,7 +142,8 @@ export class SDK {
                 host += envCfg.pathHosted;
             }
             if (!config.httpUrl) {
-                config.httpUrl = `${secured ? 'https' : 'http'}://${host}`;
+                const httpHost = envCfg.hostingMode === 'path' ? `${host}/` : host;
+                config.httpUrl = `${secured ? 'https' : 'http'}://${httpHost}`;
             }
             if (!config.mqttUrl) {
                 config.mqttUrl = `${secured ? 'wss' : 'ws'}://${host}/mqtt`;

package/dist/services/http.service.d.ts

@@ -40,6 +40,7 @@ declare class RequestParameters {
     withJSON(body: Record<string, unknown>): RequestParameters;
     get<ReturnType>(path: string, query?: Record<string, string>): Promise<ReturnType>;
     post<ReturnType>(path: string, query?: Record<string, string>, body?: FormData | Record<string, string>): Promise<ReturnType>;
+    postAsBlob(path: string, query?: Record<string, string>): Promise<Blob>;
     put<ReturnType>(path: string, query?: Record<string, string>): Promise<ReturnType>;
     delete<ReturnType>(path: string, query?: Record<string, string>): Promise<ReturnType>;
     patch<ReturnType>(path: string, query?: Record<string, string>): Promise<ReturnType>;

package/dist/services/http.service.js

@@ -35,7 +35,7 @@ class RequestParameters {
         this.withRuntimeID(); // Ensure withRuntimeID() is called by default
     }
     withQuery(path, query) {
-        const newPath = [this.base.pathname, path].map(pathPart => pathPart.replace(/(^\/|\/$)/g, "")).join("/");
+        const newPath = "/" + [this.base.pathname, path].map(pathPart => pathPart.replace(/(^\/|\/$)/g, "")).join("/");
         const newURL = new URL(newPath, this.base);
         for (const key in query) {
             newURL.searchParams.append(key, query[key]);
@@ -178,6 +178,14 @@ class RequestParameters {
         }
         return response.json();
     }
+    async postAsBlob(path, query) {
+        const init = this.parseInit("POST") || {};
+        const response = await fetch(this.withQuery(path, query), init);
+        if (!response.ok) {
+            throw new HTTPException(response.status, response.statusText, await response.text());
+        }
+        return response.blob();
+    }
     async put(path, query) {
         const response = await fetch(this.withQuery(path, query), this.parseInit("PUT"));
         if (!response.ok) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@machhub-dev/sdk-ts",
-  "version": "1.0.17",
+  "version": "1.0.18",
   "description": "MACHHUB TYPESCRIPT SDK",
   "keywords": [
     "machhub",

package/src/classes/collection.ts

@@ -84,14 +84,9 @@ export class Collection {
     }
   }
 
-  async count(options?: { filter?: any }): Promise<number> {
+  async count(): Promise<number> {
     try {
-      this.applyOptions(options);
-
-      // Build query parameters for filters
       const response: { count: number } = await this.httpService.request.get(`${this.collectionName}/count`, this.queryParams);
-
-      // Extract count from response
       return response.count;
     } catch (error) {
       throw new CollectionError('count', this.collectionName, error as Error);

package/src/classes/historian.ts

@@ -2,6 +2,15 @@ import { HTTPService } from "../services/http.service.js";
 import { MQTTService } from "../services/mqtt.service.js";
 import { HistorizedData } from "../types/tag.models.js";
 
+interface AggregationOption {
+  mean: "mean",
+  sum: "sum",
+  min: "min",
+  max: "max",
+  median: "median",
+}
+
+
 export class Historian {
   private httpService: HTTPService;
   private mqttService: MQTTService | null;
@@ -36,7 +45,7 @@ export class Historian {
       throw new Error("The number of values to fetch must be greater than 0.");
     }
 
-    if (n > 100){
+    if (n > 100) {
       throw new Error("The number of values to fetch must be less than 100.");
     }
 
@@ -47,9 +56,43 @@ export class Historian {
     }).patch("historian/last");
   }
 
-  async query(SurrealQL:string): Promise<any> {
+  async query(SurrealQL: string): Promise<any> {
     return this.httpService.request.withJSON({
       query: SurrealQL
     }).post("historian/query");
   }
+
+  /**
+   * Export historized data for one or more topics as a gzipped CSV file (Blob).
+   * When multiple topics are provided, they are merged into a single CSV with columns: [Timestamp, topic1, topic2, ...].
+   * Supports optional time bucketing (sampleRate) and aggregation (mean, sum, min, max, median).
+   *
+   * @param topics - Array of topic strings to export
+   * @param startDate - Start date for the data range
+   * @param endDate - End date for the data range
+   * @param timezone - Optional Timezone string (e.g. "Asia/Kuala Lumpur")
+   * @param sampleRate - Optional bucket interval in underscore format (e.g. "5_second", "1_minute", "1_hour")
+   * @param aggregation - Optional aggregation function: "mean" | "sum" | "min" | "max" | "median" | "none"
+   * @param mapping - Optional key-value pairs to rename topic columns in the CSV header (e.g. { "Sensor/Temperature": "Temp °C" })
+   * @returns A Blob containing the gzipped CSV data
+   */
+  async getHistoricalDataAsCSV(
+    topics: string[],
+    startDate: Date,
+    endDate: Date,
+    timezone?: string,
+    sampleRate?: string,
+    aggregation?: AggregationOption,
+    mapping?: Record<string, string>,
+  ): Promise<Blob> {
+    return this.httpService.request.withJSON({
+      topics,
+      startDate: startDate.toISOString(),
+      endDate: endDate.toISOString(),
+      timezone,
+      sampleRate: sampleRate ?? "",
+      aggregation: aggregation ?? "",
+      mapping: mapping ?? {},
+    }).postAsBlob("historian/export/aggregated");
+  }
 }

package/src/sdk-ts.ts

@@ -138,7 +138,6 @@ export class SDK {
       if (!config.application_id) config = { application_id: "" }
 
       const envCfg = await getEnvConfig();
-
       // Extract application_id from runtimeID if not provided in config
       const application_id = config.application_id ||
         this.extractApplicationIDFromRuntimeID(envCfg.runtimeID);
@@ -164,7 +163,8 @@ export class SDK {
       }
 
       if (!config.httpUrl) {
-        config.httpUrl = `${secured ? 'https' : 'http'}://${host}`;
+        const httpHost = envCfg.hostingMode === 'path' ? `${host}/` : host;
+        config.httpUrl = `${secured ? 'https' : 'http'}://${httpHost}`;
       }
 
       if (!config.mqttUrl) {

package/src/services/http.service.ts

@@ -56,7 +56,7 @@ class RequestParameters {
     }
 
     private withQuery(path: string, query?: Record<string, string>): URL {
-        const newPath = [this.base.pathname, path].map(pathPart => pathPart.replace(/(^\/|\/$)/g, "")).join("/");
+        const newPath = "/" + [this.base.pathname, path].map(pathPart => pathPart.replace(/(^\/|\/$)/g, "")).join("/");
         const newURL = new URL(newPath, this.base);
 
         for (const key in query) {
@@ -231,6 +231,22 @@ class RequestParameters {
     }
 
 
+    public async postAsBlob(path: string, query?: Record<string, string>): Promise<Blob> {
+        const init: RequestInit = this.parseInit("POST") || {};
+
+        const response = await fetch(this.withQuery(path, query), init);
+
+        if (!response.ok) {
+            throw new HTTPException(
+                response.status,
+                response.statusText,
+                await response.text(),
+            );
+        }
+        return response.blob();
+    }
+
+
     public async put<ReturnType>(path: string, query?: Record<string, string>): Promise<ReturnType> {
         const response = await fetch(this.withQuery(path, query), this.parseInit("PUT"));