busroot-sdk 0.0.0 → 0.0.1

package/build/client.d.ts

@@ -0,0 +1,63 @@
+import { PlantSchema, PlantViewModel, ScheduleViewModel, BusrootSignals, SkuViewModel, StationSchema, StationViewModel, AccountViewModel, ApiKeyViewModel } from "../build/common";
+import mqtt from "mqtt/dist/mqtt.esm";
+export declare const MqttEventType: {
+    StationMetricNew: string;
+    StationChanged: string;
+    ScheduleChanged: string;
+    ScheduleStarted: string;
+    ScheduleEnded: string;
+    ProductionNew: string;
+};
+export type MqttEventType = keyof typeof MqttEventType;
+export type Listener = (msg: any) => void;
+declare class Client {
+    config: {
+        accountId: string;
+        apiKey: string;
+        host: string;
+    };
+    mqttClient: mqtt.MqttClient;
+    listenersByEventType: Map<"StationMetricNew" | "StationChanged" | "ScheduleChanged" | "ScheduleStarted" | "ScheduleEnded" | "ProductionNew", Set<Listener>>;
+    apiUrl: string;
+    constructor(config: {
+        accountId: string;
+        apiKey: string;
+        host: string;
+    });
+    destroy(): void;
+    private get;
+    private post;
+    get profile(): {
+        get: () => Promise<any>;
+    };
+    get account(): {
+        create: (domain: string, plantName: string) => Promise<{
+            account: AccountViewModel;
+            apiKey: string;
+        }>;
+    };
+    get apiKey(): {
+        create: () => Promise<ApiKeyViewModel>;
+    };
+    get plant(): {
+        get: (plantCode: string) => Promise<PlantViewModel>;
+        createUpdate: (station: Partial<PlantSchema>) => Promise<PlantViewModel>;
+    };
+    get station(): {
+        get: (stationCode: string) => Promise<StationViewModel[]>;
+        createUpdate: (station: Partial<StationSchema>) => Promise<StationViewModel>;
+        signal: (stationCode: string, payload: BusrootSignals) => void;
+    };
+    sku: {
+        get: (skuCode: string) => Promise<SkuViewModel>;
+        createUpdate: (sku: Partial<SkuViewModel>) => Promise<SkuViewModel>;
+    };
+    schedule: {
+        get: (scheduleId: number) => Promise<ScheduleViewModel[]>;
+        createUpdate: (schedule: Partial<ScheduleViewModel>) => Promise<ScheduleViewModel>;
+    };
+    on(event: MqttEventType, listener: Listener): void;
+    off(event: MqttEventType, listener: Listener): void;
+}
+export { Client };
+//# sourceMappingURL=client.d.ts.map

package/build/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,WAAW,EACX,cAAc,EACd,iBAAiB,EACjB,cAAc,EACd,YAAY,EACZ,aAAa,EACb,gBAAgB,EAChB,gBAAgB,EAChB,eAAe,EAChB,MAAM,iBAAiB,CAAC;AACzB,OAAO,IAAI,MAAM,oBAAoB,CAAC;AAEtC,eAAO,MAAM,aAAa;;;;;;;CAOzB,CAAC;AACF,MAAM,MAAM,aAAa,GAAG,MAAM,OAAO,aAAa,CAAC;AAEvD,MAAM,MAAM,QAAQ,GAAG,CAAC,GAAG,EAAE,GAAG,KAAK,IAAI,CAAC;AAS1C,cAAM,MAAM;IAKS,MAAM,EAAE;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE;IAJ9E,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC;IAC5B,oBAAoB,wIAAwD;IAC5E,MAAM,EAAE,MAAM,CAAC;gBAEI,MAAM,EAAE;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE;IA4C9E,OAAO;YAIO,GAAG;YAyBH,IAAI;IAYlB,IAAI,OAAO;;MAQV;IAED,IAAI,OAAO;yBAEgB,MAAM,aAAa,MAAM,KAAG,OAAO,CAAC;YAAE,OAAO,EAAE,gBAAgB,CAAC;YAAC,MAAM,EAAE,MAAM,CAAA;SAAE,CAAC;MAM5G;IAED,IAAI,MAAM;sBAEY,OAAO,CAAC,eAAe,CAAC;MAM7C;IAED,IAAI,KAAK;yBAEkB,MAAM,KAAG,OAAO,CAAC,cAAc,CAAC;gCAKzB,OAAO,CAAC,WAAW,CAAC,KAAG,OAAO,CAAC,cAAc,CAAC;MAM/E;IAED,IAAI,OAAO;2BAEkB,MAAM,KAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC;gCAK/B,OAAO,CAAC,aAAa,CAAC,KAAG,OAAO,CAAC,gBAAgB,CAAC;8BAK1D,MAAM,WAAW,cAAc,KAAG,IAAI;MAI/D;IAED,GAAG;uBACoB,MAAM,KAAG,OAAO,CAAC,YAAY,CAAC;4BAKzB,OAAO,CAAC,YAAY,CAAC,KAAG,OAAO,CAAC,YAAY,CAAC;MAKvE;IAEF,QAAQ;0BACkB,MAAM,KAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC;iCAK9B,OAAO,CAAC,iBAAiB,CAAC,KAAG,OAAO,CAAC,iBAAiB,CAAC;MAKtF;IAEF,EAAE,CAAC,KAAK,EAAE,aAAa,EAAE,QAAQ,EAAE,QAAQ;IAU3C,GAAG,CAAC,KAAK,EAAE,aAAa,EAAE,QAAQ,EAAE,QAAQ;CAW7C;AAED,OAAO,EAAE,MAAM,EAAE,CAAC"}

package/build/client.js

@@ -0,0 +1,176 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Client = exports.MqttEventType = void 0;
+const mqtt_esm_1 = __importDefault(require("mqtt/dist/mqtt.esm"));
+exports.MqttEventType = {
+    StationMetricNew: "STATION_METRIC_NEW", // When a new station window is created and saved to DB.
+    StationChanged: "STATION_CHANGED", // When a station is added or edited. NOT IMPLEMENTED.
+    ScheduleChanged: "SCHEDULE_CHANGED", // When a schedule is added or edited. NOT IMPLEMENTED.
+    ScheduleStarted: "SCHEDULE_STARTED", // When a schedule starts (actualStartAt). NOT IMPLEMENTED.
+    ScheduleEnded: "SCHEDULE_ENDED", // When a schedule ends (actualEndAt). NOT IMPLEMENTED.
+    ProductionNew: "PRODUCTION_NEW", // When new production is added. NOT IMPLEMENTED FOR MANUAL PRODUCTION YET.
+};
+class Client {
+    constructor(config) {
+        this.config = config;
+        this.listenersByEventType = new Map();
+        this.sku = {
+            get: async (skuCode) => {
+                const res = await this.get("/sku", { skucodes: skuCode });
+                return res.result;
+            },
+            createUpdate: async (sku) => {
+                const res = await this.post("/sku", sku);
+                return res.result;
+            },
+        };
+        this.schedule = {
+            get: async (scheduleId) => {
+                const res = await this.get("/schedule", { ids: String(scheduleId) });
+                return res.results;
+            },
+            createUpdate: async (schedule) => {
+                const res = await this.post("/schedule", schedule);
+                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()));
+                    }
+                    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/#`);
+    }
+    destroy() {
+        this.mqttClient.end();
+    }
+    async get(path, query) {
+        let url = this.apiUrl + path;
+        if (query != null) {
+            url +=
+                "?" +
+                    Object.entries(query)
+                        .map((value) => value[0] + "=" + value[1])
+                        .join("&");
+        }
+        const res = await fetch(url, {
+            headers: { "x-api-key": this.config.apiKey },
+            method: "GET",
+        });
+        if (res.status !== 200) {
+            throw new Error(`${res.status}: ${res.statusText}`);
+        }
+        const resJson = await res.json();
+        return resJson;
+    }
+    async post(path, body) {
+        const res = await fetch(this.apiUrl + path, {
+            headers: { "x-api-key": this.config.apiKey, "Content-Type": "application/json" },
+            method: "POST",
+            body: JSON.stringify(body),
+        });
+        const resJson = await res.json();
+        return resJson;
+    }
+    get profile() {
+        return {
+            get: async () => {
+                const res = await this.get("/auth/profile");
+                return res.result;
+            },
+        };
+    }
+    get account() {
+        return {
+            create: async (domain, plantName) => {
+                const res = await this.post("/account/new", { domain, plantName });
+                return res.result;
+            },
+        };
+    }
+    get apiKey() {
+        return {
+            create: async () => {
+                const res = await this.post("/api-key", {});
+                return res.result;
+            },
+        };
+    }
+    get plant() {
+        return {
+            get: async (plantCode) => {
+                const res = await this.get("/plant", { plantCode });
+                return res.result;
+            },
+            createUpdate: async (station) => {
+                const res = await this.post("/station", station);
+                return res.result;
+            },
+        };
+    }
+    get station() {
+        return {
+            get: async (stationCode) => {
+                const res = await this.get("/station", { stationcodes: stationCode });
+                return res.results;
+            },
+            createUpdate: async (station) => {
+                const res = await this.post("/station", station);
+                return res.result;
+            },
+            signal: (stationCode, payload) => {
+                throw new Error("noop");
+            },
+        };
+    }
+    on(event, listener) {
+        let set = this.listenersByEventType.get(event);
+        if (!set) {
+            set = new Set();
+            this.listenersByEventType.set(event, set);
+        }
+        set.add(listener);
+    }
+    off(event, listener) {
+        const set = this.listenersByEventType.get(event);
+        if (!set) {
+            return;
+        }
+        set.delete(listener);
+        if (set.size === 0) {
+            this.listenersByEventType.delete(event);
+        }
+    }
+}
+exports.Client = Client;

package/build/client.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=client.test.d.ts.map

package/build/client.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.test.d.ts","sourceRoot":"","sources":["../src/client.test.ts"],"names":[],"mappings":""}

package/build/client.test.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const globals_1 = require("@jest/globals");
+(0, globals_1.describe)("test", () => {
+    (0, globals_1.test)("test", () => { });
+});