busroot-sdk 0.0.6 → 0.0.7-alpha

package/build/client.d.ts

@@ -1,5 +1,6 @@
+import z from "zod";
 import { PlantSchema, PlantViewModel, ScheduleViewModel, BusrootSignals, SkuViewModel, StationSchema, StationViewModel, AccountViewModel, ApiKeyViewModel, AggregatedStationWindowsByStation, ProductionViewModel } from "./types";
-import mqtt from "mqtt/dist/mqtt.min";
+import mqtt from "mqtt";
 export declare const MqttEventType: {
     StationMetricNew: string;
     StationChanged: string;
@@ -10,18 +11,34 @@ export declare const MqttEventType: {
 };
 export type MqttEventType = keyof typeof MqttEventType;
 export type Listener = (msg: any) => void;
-export interface Config {
+export declare const Config: z.ZodObject<{
+    accountId: z.ZodString;
+    apiKey: z.ZodString;
+    apiEndpoint: z.ZodString;
+    mqttHost: z.ZodString;
+    enableMqtt: z.ZodOptional<z.ZodBoolean>;
+    enableDebug: z.ZodOptional<z.ZodBoolean>;
+}, "strip", z.ZodTypeAny, {
     accountId: string;
     apiKey: string;
     apiEndpoint: string;
-    mqttHost?: string;
-    enableMqtt?: boolean;
-    enableDebug?: boolean;
-}
+    mqttHost: string;
+    enableMqtt?: boolean | undefined;
+    enableDebug?: boolean | undefined;
+}, {
+    accountId: string;
+    apiKey: string;
+    apiEndpoint: string;
+    mqttHost: string;
+    enableMqtt?: boolean | undefined;
+    enableDebug?: boolean | undefined;
+}>;
+export type Config = z.infer<typeof Config>;
 declare class BusrootClient {
     config: Config;
     mqttClient: mqtt.MqttClient | undefined;
     listenersByEventType: Map<"StationMetricNew" | "StationChanged" | "ScheduleChanged" | "ScheduleStarted" | "ScheduleEnded" | "ProductionNew", Set<Listener>>;
+    static version: string;
     constructor(config: Config);
     destroy(): void;
     private get;

package/build/client.d.ts.map

@@ -1 +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,EACf,iCAAiC,EACjC,mBAAmB,EACpB,MAAM,SAAS,CAAC;AACjB,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,MAAM,WAAW,MAAM;IACrB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB;AAED,cAAM,aAAa;IAIE,MAAM,EAAE,MAAM;IAHjC,UAAU,EAAE,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;IACxC,oBAAoB,wIAAwD;gBAEzD,MAAM,EAAE,MAAM;IA8CjC,OAAO;YAMO,GAAG;YAgCH,IAAI;IAkBlB,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;8BAK3B,OAAO,CAAC,WAAW,CAAC,KAAG,OAAO,CAAC,cAAc,CAAC;MAM7E;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,IAAI,UAAU;uDAMP;YACD,SAAS,EAAE,MAAM,CAAC;YAClB,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;YACxB,SAAS,EAAE,MAAM,CAAC;SACnB,KAAG,OAAO,CAAC,mBAAmB,EAAE,CAAC;0DAa/B;YACD,SAAS,EAAE,MAAM,CAAC;YAClB,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;YACxB,SAAS,EAAE,MAAM,CAAC;SACnB,KAAG,OAAO,CAAC,mBAAmB,EAAE,CAAC;MAUrC;IAED,IAAI,OAAO;wEAOJ;YACD,SAAS,EAAE,MAAM,CAAC;YAClB,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;YACxB,SAAS,EAAE,MAAM,CAAC;YAClB,eAAe,EAAE,MAAM,CAAC;SACzB,KAAG,OAAO,CAAC,iCAAiC,EAAE,CAAC;MAWnD;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,aAAa,EAAE,CAAC"}
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,CAAC,MAAM,KAAK,CAAC;AACpB,OAAO,EACL,WAAW,EACX,cAAc,EACd,iBAAiB,EACjB,cAAc,EACd,YAAY,EACZ,aAAa,EACb,gBAAgB,EAChB,gBAAgB,EAChB,eAAe,EACf,iCAAiC,EACjC,mBAAmB,EACpB,MAAM,SAAS,CAAC;AACjB,OAAO,IAAI,MAAM,MAAM,CAAC;AAExB,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,eAAO,MAAM,MAAM;;;;;;;;;;;;;;;;;;;;;EAOjB,CAAC;AAEH,MAAM,MAAM,MAAM,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,MAAM,CAAC,CAAC;AAE5C,cAAM,aAAa;IAME,MAAM,EAAE,MAAM;IALjC,UAAU,EAAE,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;IACxC,oBAAoB,wIAAwD;IAE5E,MAAM,CAAC,OAAO,SAAQ;gBAEH,MAAM,EAAE,MAAM;IA8CjC,OAAO;YAMO,GAAG;YAgCH,IAAI;IAkBlB,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;8BAK3B,OAAO,CAAC,WAAW,CAAC,KAAG,OAAO,CAAC,cAAc,CAAC;MAM7E;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,IAAI,UAAU;uDAMP;YACD,SAAS,EAAE,MAAM,CAAC;YAClB,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;YACxB,SAAS,EAAE,MAAM,CAAC;SACnB,KAAG,OAAO,CAAC,mBAAmB,EAAE,CAAC;0DAa/B;YACD,SAAS,EAAE,MAAM,CAAC;YAClB,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;YACxB,SAAS,EAAE,MAAM,CAAC;SACnB,KAAG,OAAO,CAAC,mBAAmB,EAAE,CAAC;MAUrC;IAED,IAAI,OAAO;wEAOJ;YACD,SAAS,EAAE,MAAM,CAAC;YAClB,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;YACxB,SAAS,EAAE,MAAM,CAAC;YAClB,eAAe,EAAE,MAAM,CAAC;SACzB,KAAG,OAAO,CAAC,iCAAiC,EAAE,CAAC;MAWnD;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,aAAa,EAAE,CAAC"}

package/build/client.js

@@ -3,8 +3,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.BusrootClient = exports.MqttEventType = void 0;
-const mqtt_min_1 = __importDefault(require("mqtt/dist/mqtt.min"));
+exports.BusrootClient = exports.Config = exports.MqttEventType = void 0;
+const zod_1 = __importDefault(require("zod"));
+const mqtt_1 = __importDefault(require("mqtt"));
 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.
@@ -13,15 +14,24 @@ exports.MqttEventType = {
     ScheduleEnded: "SCHEDULE_ENDED", // When a schedule ends (actualEndAt). NOT IMPLEMENTED.
     ProductionNew: "PRODUCTION_NEW", // When new production is added. NOT IMPLEMENTED FOR MANUAL PRODUCTION YET.
 };
+exports.Config = zod_1.default.object({
+    accountId: zod_1.default.string().max(255),
+    apiKey: zod_1.default.string().max(255),
+    apiEndpoint: zod_1.default.string().max(255),
+    mqttHost: zod_1.default.string().max(255),
+    enableMqtt: zod_1.default.boolean().optional(),
+    enableDebug: zod_1.default.boolean().optional(),
+});
 class BusrootClient {
     config;
     mqttClient;
     listenersByEventType = new Map();
+    static version = "v0";
     constructor(config) {
         this.config = config;
         const trimmedAccountId = config.accountId.replace("account_", "");
         if (config.enableMqtt === true && config.mqttHost !== null) {
-            this.mqttClient = mqtt_min_1.default.connect({
+            this.mqttClient = mqtt_1.default.connect({
                 host: config.mqttHost,
                 port: 8883,
                 username: "api-key",

package/build/hooks.d.ts

@@ -1,23 +1,6 @@
-import { BusrootClient } from "./client";
-import z from "zod";
-export declare const ConfigPayloadSchema: z.ZodObject<{
-    accountId: z.ZodString;
-    apiKey: z.ZodString;
-    apiEndpoint: z.ZodString;
-    mqttHost: z.ZodString;
-}, "strip", z.ZodTypeAny, {
-    accountId: string;
-    apiKey: string;
-    apiEndpoint: string;
-    mqttHost: string;
-}, {
-    accountId: string;
-    apiKey: string;
-    apiEndpoint: string;
-    mqttHost: string;
-}>;
+import { BusrootClient, Config } from "./client";
 export declare function useBusroot(props?: {
-    enableMqtt?: boolean;
+    config?: Config;
 }): {
     client: BusrootClient | undefined;
     logout: () => void;

package/build/hooks.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"hooks.d.ts","sourceRoot":"","sources":["../src/hooks.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,CAAC,MAAM,KAAK,CAAC;AAMpB,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;EAK9B,CAAC;AAEH,wBAAgB,UAAU,CAAC,KAAK,CAAC,EAAE;IAAE,UAAU,CAAC,EAAE,OAAO,CAAA;CAAE;;;EAuC1D"}
+{"version":3,"file":"hooks.d.ts","sourceRoot":"","sources":["../src/hooks.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,aAAa,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAMjD,wBAAgB,UAAU,CAAC,KAAK,CAAC,EAAE;IAAE,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE;;;EA2CrD"}

package/build/hooks.js

@@ -1,45 +1,39 @@
 "use strict";
 "use client";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ConfigPayloadSchema = void 0;
 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),
-    apiEndpoint: zod_1.default.string().max(255),
-    mqttHost: zod_1.default.string().max(255),
-});
 function useBusroot(props) {
-    const enableMqtt = props && props.enableMqtt;
+    const enableMqtt = props && props.config != null && props.config.enableMqtt === true;
     const [client, setClient] = (0, react_1.useState)();
     (0, react_1.useEffect)(() => {
         if (typeof window === undefined) {
             return;
         }
-        const searchParams = new URLSearchParams(window.location.search);
-        const tokenParam = searchParams.get("busroot_token");
-        if (tokenParam != null && client == null) {
-            try {
-                const config = exports.ConfigPayloadSchema.parse(JSON.parse(atob(tokenParam)));
-                setClient(new client_1.BusrootClient({
-                    accountId: config.accountId,
-                    apiKey: config.apiKey,
-                    apiEndpoint: config.apiEndpoint,
-                    mqttHost: config.mqttHost,
-                    enableMqtt,
-                }));
-            }
-            catch (e) {
-                console.log(e.message);
+        if (props != null && props.config != null) {
+            setClient(new client_1.BusrootClient(props.config));
+        }
+        else {
+            const searchParams = new URLSearchParams(window.location.search);
+            const tokenParam = searchParams.get("busroot_token");
+            if (tokenParam != null && client == null) {
+                try {
+                    const config = client_1.Config.parse(JSON.parse(atob(tokenParam)));
+                    setClient(new client_1.BusrootClient({
+                        accountId: config.accountId,
+                        apiKey: config.apiKey,
+                        apiEndpoint: config.apiEndpoint,
+                        mqttHost: config.mqttHost,
+                        enableMqtt,
+                    }));
+                }
+                catch (e) {
+                    console.log(e.message);
+                }
             }
         }
         return;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "busroot-sdk",
-  "version": "0.0.6",
+  "version": "0.0.7-alpha",
   "description": "An SDK for accessing Busroot from output.industries",
   "homepage": "https://www.output.industries",
   "main": "./build/index.js",
@@ -11,6 +11,7 @@
     "dev": "pnpm run lint && tsc -b --watch",
     "build": "pnpm run lint && tsc --build --clean && tsc --build",
     "lint": "eslint 'src/**/*.ts'",
+    "lint-fix": "eslint 'src/**/*.ts' --fix",
     "test": "jest"  },
   "files": [
     "build"