busroot-sdk 0.0.7-alpha.0 → 0.0.7-alpha.10

package/package.json

@@ -1,19 +1,11 @@
 {
   "name": "busroot-sdk",
-  "version": "0.0.7-alpha.0",
+  "version": "0.0.7-alpha.10",
   "description": "An SDK for accessing Busroot from output.industries",
   "homepage": "https://www.output.industries",
   "main": "./build/index.js",
   "types": "./build/index.d.ts",
   "license": "MIT",
-  "scripts": {
-    "example": "ts-node -r dotenv-expand/config ./src/example.ts",
-    "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"
   ],
@@ -22,7 +14,10 @@
     "@types/react": "^18.0.26",
     "@types/chroma-js": "^3.1.2",
     "ts-jest": "^29.4.0",
-    "typescript-eslint": "^8.38.0"
+    "dts-bundle-generator": "^9.5.1",
+    "tsup": "^8.5.0",
+    "typescript-eslint": "^8.38.0",
+    "busroot-common": "0.0.0"
   },
   "dependencies": {
     "eslint-config-prettier": "^8.10.0",
@@ -36,5 +31,14 @@
     "ts-node": "^10.9.1",
     "typescript": "^5.8.3",
     "zod": "^3.25.1"
+  },
+  "scripts": {
+    "example": "ts-node -r dotenv-expand/config ./src/example.ts",
+    "dev": "pnpm run lint && tsup --watch",
+    "build": "pnpm run lint && tsup && dts-bundle-generator -o build/index.d.ts src/index.ts --external-types zod --external-types mqtt --external-types react",
+    "lint": "eslint 'src/**/*.ts'",
+    "lint-fix": "eslint 'src/**/*.ts' --fix",
+    "test": "jest",
+    "publish-prerelease": "pnpm run build && npm version prerelease --preid=alpha --no-workspaces-update && pnpm publish --tag next --no-git-checks"
   }
-}
+}

package/build/client.d.ts

@@ -1,99 +0,0 @@
-import z from "zod";
-import { PlantSchema, PlantViewModel, ScheduleViewModel, BusrootSignals, SkuViewModel, StationSchema, StationViewModel, AccountViewModel, ApiKeyViewModel, AggregatedStationWindowsByStation, ProductionViewModel } from "./types";
-import mqtt from "mqtt";
-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;
-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 | 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;
-    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: (plant: Partial<PlantSchema>) => Promise<PlantViewModel>;
-    };
-    get station(): {
-        get: (stationCode: string) => Promise<StationViewModel[]>;
-        createUpdate: (station: Partial<StationSchema>) => Promise<StationViewModel>;
-        signal: (stationCode: string, payload: BusrootSignals) => void;
-    };
-    get production(): {
-        get: ({ plantCode, stationCodes, rangeCode, }: {
-            plantCode: string;
-            stationCodes?: string[];
-            rangeCode: string;
-        }) => Promise<ProductionViewModel[]>;
-        getRaw: ({ plantCode, stationCodes, rangeCode, }: {
-            plantCode: string;
-            stationCodes?: string[];
-            rangeCode: string;
-        }) => Promise<ProductionViewModel[]>;
-    };
-    get metrics(): {
-        get: ({ plantCode, stationCodes, rangeCode, aggregateWindow, }: {
-            plantCode: string;
-            stationCodes?: string[];
-            rangeCode: string;
-            aggregateWindow: string;
-        }) => Promise<AggregatedStationWindowsByStation[]>;
-    };
-    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 { BusrootClient };
-//# sourceMappingURL=client.d.ts.map

package/build/client.d.ts.map

@@ -1 +0,0 @@
-{"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

@@ -1,234 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-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.
-    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.
-};
-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_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;
-                    }
-                    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/${trimmedAccountId}/events/#`);
-        }
-    }
-    destroy() {
-        if (this.mqttClient != null) {
-            this.mqttClient.end();
-        }
-    }
-    async get(path, query) {
-        let url = this.config.apiEndpoint + path;
-        if (query != null) {
-            url +=
-                "?" +
-                    Object.entries(query)
-                        .filter((value) => value[1] != null)
-                        .map((value) => value[0] + "=" + value[1])
-                        .join("&");
-        }
-        if (this.config.enableDebug === true) {
-            console.log("Get Request: " + url);
-        }
-        const res = await fetch(url, {
-            headers: { "x-api-key": this.config.apiKey },
-            method: "GET",
-        });
-        if (res.status !== 200) {
-            const resBody = await res.json();
-            throw new Error(`${res.status}: ${res.statusText}: ${resBody.errorCode}`);
-        }
-        const resJson = await res.json();
-        return resJson;
-    }
-    async post(path, body) {
-        const res = await fetch(this.config.apiEndpoint + path, {
-            headers: { "x-api-key": this.config.apiKey, "Content-Type": "application/json" },
-            method: "POST",
-            body: JSON.stringify(body),
-        });
-        if (res.status !== 200) {
-            const resBody = await res.json();
-            throw new Error(`${res.status}: ${res.statusText}: ${resBody.errorCode}`);
-        }
-        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 (plant) => {
-                const res = await this.post("/plant", plant);
-                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");
-            },
-        };
-    }
-    get production() {
-        return {
-            get: async ({ plantCode, stationCodes, rangeCode, }) => {
-                const res = await this.get("/production", {
-                    plantcode: plantCode,
-                    stationcodes: stationCodes?.join(","),
-                    rangecode: rangeCode,
-                });
-                return res.results;
-            },
-            getRaw: async ({ plantCode, stationCodes, rangeCode, }) => {
-                const res = await this.get("/production/raw", {
-                    plantcode: plantCode,
-                    stationcodes: stationCodes?.join(","),
-                    rangecode: rangeCode,
-                });
-                return res.results;
-            },
-        };
-    }
-    get metrics() {
-        return {
-            get: async ({ plantCode, stationCodes, rangeCode, aggregateWindow, }) => {
-                const res = await this.get("/station-windows", {
-                    plantcode: plantCode,
-                    stationcodes: stationCodes?.join(","),
-                    rangecode: rangeCode,
-                    aggregatewindow: aggregateWindow,
-                });
-                return res.results;
-            },
-        };
-    }
-    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;
-        },
-    };
-    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;
-        },
-    };
-    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.BusrootClient = BusrootClient;

package/build/client.test.d.ts

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

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

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

package/build/client.test.js

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

package/build/hooks.d.ts

@@ -1,8 +0,0 @@
-import { BusrootClient, Config } from "./client";
-export declare function useBusroot(props?: {
-    config?: Config;
-}): {
-    client: BusrootClient | undefined;
-    logout: () => void;
-};
-//# sourceMappingURL=hooks.d.ts.map

package/build/hooks.d.ts.map

@@ -1 +0,0 @@
-{"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 +0,0 @@
-"use strict";
-"use client";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.useBusroot = useBusroot;
-const react_1 = require("react");
-const client_1 = require("./client");
-// 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.
-function useBusroot(props) {
-    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;
-        }
-        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;
-    }, []);
-    const logout = () => {
-        console.log("not implemented");
-    };
-    return { client, logout };
-}

package/build/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC;AAExB,YAAY,EACV,WAAW,EACX,cAAc,EACd,iBAAiB,EACjB,cAAc,EACd,YAAY,EACZ,aAAa,EACb,gBAAgB,EAChB,gBAAgB,EAChB,eAAe,GAChB,MAAM,SAAS,CAAC"}