busroot-sdk 0.0.2 → 0.0.3

package/build/{common.d.ts → busroot.d.ts}

@@ -170,6 +170,7 @@ declare const ScheduleViewModel = z.object({
   idealEndAtTimestamp: z.number().optional(),
   quantityGood: z.number().optional(),
   quantityBad: z.number().optional(),
+  quantityTotal: z.number().optional(),
   skuGroupCode: z.string().optional(),
   skuGroupName: z.string().optional(),
   extendShift: z.boolean().optional(),

package/build/client.d.ts

@@ -1,4 +1,4 @@
-import { PlantSchema, PlantViewModel, ScheduleViewModel, BusrootSignals, SkuViewModel, StationSchema, StationViewModel, AccountViewModel, ApiKeyViewModel } from "./common";
+import { PlantSchema, PlantViewModel, ScheduleViewModel, BusrootSignals, SkuViewModel, StationSchema, StationViewModel, AccountViewModel, ApiKeyViewModel } from "./busroot";
 import mqtt from "mqtt/dist/mqtt.esm";
 export declare const MqttEventType: {
     StationMetricNew: string;
@@ -14,15 +14,18 @@ declare class Client {
     config: {
         accountId: string;
         apiKey: string;
-        host: string;
+        endpoint: string;
+        mqttHost?: string;
+        enableMqtt?: boolean;
     };
-    mqttClient: mqtt.MqttClient;
+    mqttClient: mqtt.MqttClient | undefined;
     listenersByEventType: Map<"StationMetricNew" | "StationChanged" | "ScheduleChanged" | "ScheduleStarted" | "ScheduleEnded" | "ProductionNew", Set<Listener>>;
-    apiUrl: string;
     constructor(config: {
         accountId: string;
         apiKey: string;
-        host: string;
+        endpoint: string;
+        mqttHost?: string;
+        enableMqtt?: boolean;
     });
     destroy(): void;
     private get;

package/build/client.js

@@ -37,46 +37,50 @@ class Client {
                 return res.result;
             },
         };
-        this.apiUrl = "http://" + config.host + ":3000/api";
-        this.mqttClient = mqtt_esm_1.default.connect({
-            host: config.host,
-            port: 8883,
-            username: "api-key",
-            password: this.config.apiKey,
-            clientId: this.config.accountId + "/sdk",
-        });
-        this.mqttClient.on("message", (topic, payload) => {
-            const eventType = topic.toUpperCase().split("/").at(-1);
-            for (const [listenerEventType, listeners] of this.listenersByEventType) {
-                if (exports.MqttEventType[listenerEventType] !== eventType) {
-                    continue;
-                }
-                for (const listener of listeners) {
-                    try {
-                        listener(JSON.parse(payload.toString()));
+        const trimmedAccountId = config.accountId.replace("account_", "");
+        if (config.enableMqtt === true && config.mqttHost !== null) {
+            this.mqttClient = mqtt_esm_1.default.connect({
+                host: config.mqttHost,
+                port: 8883,
+                username: "api-key",
+                password: this.config.apiKey,
+                clientId: trimmedAccountId + "/sdk",
+            });
+            this.mqttClient.on("message", (topic, payload) => {
+                const eventType = topic.toUpperCase().split("/").at(-1);
+                for (const [listenerEventType, listeners] of this.listenersByEventType) {
+                    if (exports.MqttEventType[listenerEventType] !== eventType) {
+                        continue;
                     }
-                    catch (e) {
-                        //
+                    for (const listener of listeners) {
+                        try {
+                            listener(JSON.parse(payload.toString()));
+                        }
+                        catch (e) {
+                            //
+                        }
                     }
                 }
-            }
-        });
-        this.mqttClient.on("error", (error) => {
-            console.error(error);
-        });
-        this.mqttClient.on("connect", () => {
-            console.log("Connected to Busroot MQTT...");
-        });
-        this.mqttClient.on("reconnect", () => {
-            console.log("Disconnected from Busroot MQTT...");
-        });
-        this.mqttClient.subscribe(`busroot/v2/${this.config.accountId}/events/#`);
+            });
+            this.mqttClient.on("error", (error) => {
+                console.error(error);
+            });
+            this.mqttClient.on("connect", () => {
+                console.log("Connected to Busroot MQTT...");
+            });
+            this.mqttClient.on("reconnect", () => {
+                console.log("Disconnected from Busroot MQTT...");
+            });
+            this.mqttClient.subscribe(`busroot/v2/${trimmedAccountId}/events/#`);
+        }
     }
     destroy() {
-        this.mqttClient.end();
+        if (this.mqttClient != null) {
+            this.mqttClient.end();
+        }
     }
     async get(path, query) {
-        let url = this.apiUrl + path;
+        let url = this.config.endpoint + path;
         if (query != null) {
             url +=
                 "?" +
@@ -95,7 +99,7 @@ class Client {
         return resJson;
     }
     async post(path, body) {
-        const res = await fetch(this.apiUrl + path, {
+        const res = await fetch(this.config.endpoint + path, {
             headers: { "x-api-key": this.config.apiKey, "Content-Type": "application/json" },
             method: "POST",
             body: JSON.stringify(body),

package/build/hooks.d.ts

@@ -3,17 +3,22 @@ import z from "zod";
 export declare const ConfigPayloadSchema: z.ZodObject<{
     accountId: z.ZodString;
     apiKey: z.ZodString;
-    host: z.ZodString;
+    endpoint: z.ZodString;
+    mqttHost: z.ZodString;
 }, "strip", z.ZodTypeAny, {
     accountId: string;
-    host: string;
     apiKey: string;
+    endpoint: string;
+    mqttHost: string;
 }, {
     accountId: string;
-    host: string;
     apiKey: string;
+    endpoint: string;
+    mqttHost: string;
 }>;
-export declare function useBusroot(): {
+export declare function useBusroot(props?: {
+    enableMqtt?: boolean;
+}): {
     client: Client | undefined;
     logout: () => void;
 };

package/build/hooks.js

@@ -1,4 +1,5 @@
 "use strict";
+"use client";
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -8,14 +9,17 @@ exports.useBusroot = useBusroot;
 const react_1 = require("react");
 const client_1 = require("./client");
 const zod_1 = __importDefault(require("zod"));
+// TODO: Should accept a JWT token with a limited expiry time, instead of an API key. MQTT auth will need to be altered to make this work.
 // TODO: Account ID and API key should be saved to a local cookie and removed from the query param.
 // TODO: Add logout functionality, that clears the cookies.
 exports.ConfigPayloadSchema = zod_1.default.object({
     accountId: zod_1.default.string().max(255),
     apiKey: zod_1.default.string().max(255),
-    host: zod_1.default.string().max(255),
+    endpoint: zod_1.default.string().max(255),
+    mqttHost: zod_1.default.string().max(255),
 });
-function useBusroot() {
+function useBusroot(props) {
+    const enableMqtt = props && props.enableMqtt;
     const [client, setClient] = (0, react_1.useState)();
     (0, react_1.useEffect)(() => {
         if (typeof window === undefined) {
@@ -26,7 +30,13 @@ function useBusroot() {
         if (tokenParam != null && client == null) {
             try {
                 const config = exports.ConfigPayloadSchema.parse(JSON.parse(atob(tokenParam)));
-                setClient(new client_1.Client({ accountId: config.accountId, apiKey: config.apiKey, host: config.host }));
+                setClient(new client_1.Client({
+                    accountId: config.accountId,
+                    apiKey: config.apiKey,
+                    endpoint: config.endpoint,
+                    mqttHost: config.mqttHost,
+                    enableMqtt,
+                }));
             }
             catch (e) {
                 console.log(e.message);

package/build/index.d.ts

@@ -1,2 +1,3 @@
 export * from "./client";
 export * from "./hooks";
+export type { PlantSchema, PlantViewModel, ScheduleViewModel, BusrootSignals, SkuViewModel, StationSchema, StationViewModel, AccountViewModel, ApiKeyViewModel, } from "./busroot";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "busroot-sdk",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "description": "An SDK for accessing Busroot from output.industries",
   "homepage": "https://www.output.industries",
   "main": "./build/index.js",

package/build/example.d.ts

@@ -1 +0,0 @@
-export {};

package/build/example.js

@@ -1,31 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const moment_1 = __importDefault(require("moment"));
-const client_1 = require("./client");
-async function main() {
-    const busrootOiClient = new client_1.Client({ accountId: "account_000", apiKey: "admin_api_key", host: "localhost" });
-    // const profile = await busroot.profile.get();
-    // console.log(profile);
-    const account = await busrootOiClient.account.create("opind.co", "London");
-    // console.log(account);
-    const busrootClient = new client_1.Client({ accountId: account.account.id, apiKey: account.apiKey, host: "localhost" });
-    // const profile = await busrootClient.profile.get();
-    // console.log(profile);
-    const station1 = await busrootClient.station.createUpdate({ code: "machine1", name: "Machine 1", groupCode: "unknown" });
-    const sku1 = await busrootClient.sku.createUpdate({ code: "PRODUCT1", name: "Product 1" });
-    const { id: scheduleId } = await busrootClient.schedule.createUpdate({
-        stationCode: station1.code,
-        skuCode: sku1.code,
-        plannedStartAt: (0, moment_1.default)().toISOString(),
-    });
-    console.log(scheduleId);
-    // busrootClient.station.signal(station1.code, { production_complete: 1 });
-    const schedule = await busrootClient.schedule.get(scheduleId);
-    console.log(schedule[0]);
-    busrootOiClient.destroy();
-    busrootClient.destroy();
-}
-main();