@machhub-dev/sdk-ts 1.0.15 → 1.0.16

package/README.md

@@ -0,0 +1,139 @@
+# @machhub-dev/sdk-ts
+
+Official TypeScript SDK for the MACHHUB platform by [Intellogic Technology Sdn Bhd](https://intellogic.com.my).
+
+## Overview
+
+MACHHUB is an industrial IoT platform for building real-time data-driven applications. This SDK provides a unified TypeScript interface to interact with MACHHUB services, including:
+
+- **Authentication** — Login, session management, and permission checks
+- **Collections** — Query and manage structured data with a fluent, chainable API
+- **Tags** — Publish and subscribe to real-time machine/sensor data over MQTT
+- **Historian** — Retrieve historical tag data and run time-series queries
+- **Processes** — Execute named processes defined on the MACHHUB platform
+
+The SDK supports both browser and Node.js environments and can be initialized with an explicit config or automatically when used alongside the MACHHUB VS Code Extension.
+
+## Installation
+
+```bash
+npm install @machhub-dev/sdk-ts
+```
+
+## Quick Start
+
+**With explicit config:**
+
+```typescript
+import { SDK, type SDKConfig } from '@machhub-dev/sdk-ts';
+
+const config: SDKConfig = {
+  application_id: 'your-app-id',
+  httpUrl: 'http://localhost:6188', // optional, defaults to http://localhost:6188
+  mqttUrl: 'ws://localhost:180',    // optional, defaults to ws://localhost:180
+  developer_key: 'your-dev-key',   // optional
+};
+
+const sdk = new SDK();
+await sdk.Initialize(config);
+```
+
+**With the MACHHUB VS Code Extension:**
+
+When running inside a MACHHUB Extension environment, `Initialize()` can be called without any config. The SDK will automatically resolve the application ID and connection URLs from the Extension context.
+
+```typescript
+import { SDK } from '@machhub-dev/sdk-ts';
+
+const sdk = new SDK();
+await sdk.Initialize(); // config not required when using the Extension
+```
+
+## Modules
+
+### Auth
+
+```typescript
+// Login
+const session = await sdk.auth.login('username', 'password');
+
+// Get current user
+const user = await sdk.auth.getCurrentUser();
+
+// Logout
+await sdk.auth.logout();
+```
+
+### Collection
+
+Query and manage data collections with a fluent builder API.
+
+```typescript
+const results = await sdk.collection('my-collection')
+  .filter('status', 'eq', 'active')
+  .sort('created_at', 'desc')
+  .limit(20)
+  .offset(0)
+  .expand('related_field')
+  .getAll();
+```
+
+### Tag
+
+Publish and subscribe to real-time tag data over MQTT.
+
+```typescript
+// List all tags
+const tags = await sdk.tag.getAllTags();
+
+// Subscribe to live data
+await sdk.tag.subscribe('my/topic', (data, topic) => {
+  console.log(topic, data);
+});
+
+// Publish data
+await sdk.tag.publish('my/topic', { value: 42 });
+
+// Unsubscribe
+await sdk.tag.unsubscribe('my/topic');
+```
+
+### Historian
+
+Access historical tag data.
+
+```typescript
+// Fetch historical data from a start time
+const history = await sdk.historian.getHistoricalData(
+  'my/topic',
+  new Date('2024-01-01T00:00:00Z'),
+  '1h' // optional range
+);
+
+// Get the last N values (max 100)
+const latest = await sdk.historian.getLastNValues('my/topic', 10);
+
+// Subscribe to live historized data
+await sdk.historian.subscribeLiveData('my/topic', (data) => {
+  console.log(data);
+});
+
+// Raw SurrealQL query
+const result = await sdk.historian.query('SELECT * FROM tag WHERE topic = "my/topic"');
+```
+
+### Processes
+
+Execute named processes defined on the MACHHUB platform.
+
+```typescript
+// Execute a process by name
+const result = await sdk.processes.execute('my-process', { key: 'value' });
+
+// Execute without input
+const result = await sdk.processes.execute('my-process');
+```
+
+## License
+
+[MPL-2.0](LICENSE)

package/dist/cjs/sdk-ts.d.ts

@@ -1,7 +1,6 @@
 import { Collection } from "./classes/collection.js";
 import { Historian } from "./classes/historian.js";
 import { Tag } from "./classes/tag.js";
-import { Flow } from "./classes/flow.js";
 import { Auth } from "./classes/auth.js";
 import { Processes } from "./classes/processes.js";
 export interface SDKConfig {
@@ -16,7 +15,6 @@ export declare class SDK {
     private _historian;
     private _tag;
     private _function;
-    private _flow;
     private _auth;
     private _processes;
     private applicationID;
@@ -64,10 +62,6 @@ export declare class SDK {
      * Getter for `function`. Ensures `function` is accessed only after initialization.
      */
     get function(): Function;
-    /**
-     * Getter for `flow`. Ensures `flow` is accessed only after initialization.
-     */
-    get flow(): Flow;
     /**
      * Getter for `processes`. Ensures `processes` is accessed only after initialization.
      */

package/dist/cjs/sdk-ts.js

@@ -6,7 +6,6 @@ const mqtt_service_js_1 = require("./services/mqtt.service.js");
 const collection_js_1 = require("./classes/collection.js");
 const historian_js_1 = require("./classes/historian.js");
 const tag_js_1 = require("./classes/tag.js");
-const flow_js_1 = require("./classes/flow.js");
 const auth_js_1 = require("./classes/auth.js");
 const processes_js_1 = require("./classes/processes.js");
 const MACHHUB_SDK_PATH = "machhub";
@@ -75,7 +74,6 @@ class SDK {
         this._historian = null;
         this._tag = null;
         this._function = null;
-        this._flow = null;
         this._auth = null;
         this._processes = null;
         this.applicationID = "";
@@ -158,7 +156,6 @@ class SDK {
             this.mqtt = await MQTTClient.getInstance(this.applicationID, mqttUrl, config.developer_key);
             this._historian = new historian_js_1.Historian(this.http["httpService"], this.mqtt["mqttService"]);
             this._tag = new tag_js_1.Tag(this.http["httpService"], this.mqtt["mqttService"]);
-            this._flow = new flow_js_1.Flow(this.http["httpService"]);
             this._auth = new auth_js_1.Auth(this.http["httpService"], this.applicationID);
             this._processes = new processes_js_1.Processes(this.http["httpService"]);
         }
@@ -204,15 +201,6 @@ class SDK {
         }
         return this._function;
     }
-    /**
-     * Getter for `flow`. Ensures `flow` is accessed only after initialization.
-     */
-    get flow() {
-        if (!this._flow) {
-            throw new Error("SDK is not initialized. Call `Initialize` before accessing `flow`.");
-        }
-        return this._flow;
-    }
     /**
      * Getter for `processes`. Ensures `processes` is accessed only after initialization.
      */

package/dist/sdk-ts.d.ts

@@ -1,7 +1,6 @@
 import { Collection } from "./classes/collection.js";
 import { Historian } from "./classes/historian.js";
 import { Tag } from "./classes/tag.js";
-import { Flow } from "./classes/flow.js";
 import { Auth } from "./classes/auth.js";
 import { Processes } from "./classes/processes.js";
 export interface SDKConfig {
@@ -16,7 +15,6 @@ export declare class SDK {
     private _historian;
     private _tag;
     private _function;
-    private _flow;
     private _auth;
     private _processes;
     private applicationID;
@@ -64,10 +62,6 @@ export declare class SDK {
      * Getter for `function`. Ensures `function` is accessed only after initialization.
      */
     get function(): Function;
-    /**
-     * Getter for `flow`. Ensures `flow` is accessed only after initialization.
-     */
-    get flow(): Flow;
     /**
      * Getter for `processes`. Ensures `processes` is accessed only after initialization.
      */

package/dist/sdk-ts.js

@@ -3,7 +3,6 @@ import { MQTTService } from "./services/mqtt.service.js";
 import { Collection } from "./classes/collection.js";
 import { Historian } from "./classes/historian.js";
 import { Tag } from "./classes/tag.js";
-import { Flow } from "./classes/flow.js";
 import { Auth } from "./classes/auth.js";
 import { Processes } from "./classes/processes.js";
 const MACHHUB_SDK_PATH = "machhub";
@@ -72,7 +71,6 @@ export class SDK {
         this._historian = null;
         this._tag = null;
         this._function = null;
-        this._flow = null;
         this._auth = null;
         this._processes = null;
         this.applicationID = "";
@@ -155,7 +153,6 @@ export class SDK {
             this.mqtt = await MQTTClient.getInstance(this.applicationID, mqttUrl, config.developer_key);
             this._historian = new Historian(this.http["httpService"], this.mqtt["mqttService"]);
             this._tag = new Tag(this.http["httpService"], this.mqtt["mqttService"]);
-            this._flow = new Flow(this.http["httpService"]);
             this._auth = new Auth(this.http["httpService"], this.applicationID);
             this._processes = new Processes(this.http["httpService"]);
         }
@@ -201,15 +198,6 @@ export class SDK {
         }
         return this._function;
     }
-    /**
-     * Getter for `flow`. Ensures `flow` is accessed only after initialization.
-     */
-    get flow() {
-        if (!this._flow) {
-            throw new Error("SDK is not initialized. Call `Initialize` before accessing `flow`.");
-        }
-        return this._flow;
-    }
     /**
      * Getter for `processes`. Ensures `processes` is accessed only after initialization.
      */

package/package.json

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

package/src/sdk-ts.ts

@@ -3,7 +3,6 @@ import { MQTTService } from "./services/mqtt.service.js";
 import { Collection } from "./classes/collection.js";
 import { Historian } from "./classes/historian.js";
 import { Tag } from "./classes/tag.js";
-import { Flow } from "./classes/flow.js";
 import { Auth } from "./classes/auth.js";
 import { Processes } from "./classes/processes.js";
 
@@ -91,7 +90,6 @@ export class SDK {
   private _historian: Historian | null = null;
   private _tag: Tag | null = null;
   private _function: Function | null = null;
-  private _flow: Flow | null = null;
   private _auth: Auth | null = null;
   private _processes: Processes | null = null;
   private applicationID: string = "";
@@ -182,7 +180,6 @@ export class SDK {
 
       this._historian = new Historian(this.http["httpService"], this.mqtt["mqttService"]);
       this._tag = new Tag(this.http["httpService"], this.mqtt["mqttService"]);
-      this._flow = new Flow(this.http["httpService"]);
       this._auth = new Auth(this.http["httpService"], this.applicationID);
       this._processes = new Processes(this.http["httpService"]);
     } catch (error: any) {
@@ -233,16 +230,6 @@ export class SDK {
     return this._function;
   }
 
-  /**
-   * Getter for `flow`. Ensures `flow` is accessed only after initialization.
-   */
-  public get flow(): Flow {
-    if (!this._flow) {
-      throw new Error("SDK is not initialized. Call `Initialize` before accessing `flow`.");
-    }
-    return this._flow;
-  }
-
   /**
    * Getter for `processes`. Ensures `processes` is accessed only after initialization.
    */

package/src/classes/flow.ts

@@ -1,13 +0,0 @@
-import { HTTPService } from "../services/http.service.js";
-
-export class Flow {
-  private httpService: HTTPService;
-
-  constructor(httpService: HTTPService) {
-    this.httpService = httpService;
-  }
-
-  public async executeFlow(name: string, payload: any): Promise<any> {
-    return await this.httpService.request.withJSON(payload).post("flow/execute/name/" + name);
-  }
-}