initial implementation of WebSocket client with error handling and buffer management

packages/ws/.npmignore

@@ -0,0 +1,3 @@
+__test__/
+out/**
+src/**

packages/ws/README.md

@@ -0,0 +1 @@
+# [View the documentation here.](https://discloud.github.io/discloud.app/modules/_discloudapp_ws.html)

packages/ws/esbuild.mjs

@@ -0,0 +1,35 @@
+import { context } from "esbuild";
+import { esbuildDefaultPlugins } from "../../esbuild.mjs";
+
+async function main() {
+  const production = process.argv.includes("--production");
+  const watch = process.argv.includes("--watch");
+
+  const ctx = await context({
+    entryPoints: ["src/index.ts"],
+    bundle: true,
+    format: "cjs",
+    minify: production,
+    sourcemap: "inline",
+    sourcesContent: false,
+    platform: "node",
+    outdir: "dist",
+    logLevel: "warning",
+    packages: "external",
+    plugins: esbuildDefaultPlugins,
+  });
+
+  if (watch) {
+    await ctx.watch();
+  } else {
+    await ctx.rebuild();
+    await ctx.dispose();
+  }
+}
+
+try {
+  await main();
+} catch (error) {
+  console.error(error);
+  process.exit(1);
+}

packages/ws/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "@discloudapp/ws",
+  "version": "0.1.0",
+  "description": "A WebSocket for discloud.app",
+  "main": "dist",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "watch": "npm-run-all -p watch:*",
+    "watch:esbuild": "node esbuild.mjs --watch",
+    "watch:tsc": "tsc --noEmit --watch",
+    "prepublish": "node esbuild.mjs --production && tsc --emitDeclarationOnly --outDir dist",
+    "release:pre": "npm version pre --legacy-peer-deps --no-git-tag-version && npm run prepublish && npm publish --tag=beta",
+    "release": "npm run prepublish && npm publish",
+    "test": "tsc --noEmit && tsc && npm run test:node",
+    "test:node": "node --test"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/discloud/discloud.app.git"
+  },
+  "keywords": [
+    "discloud",
+    "discloud.app"
+  ],
+  "license": "Apache-2.0",
+  "dependencies": {
+    "@discloudapp/api-types": "^1.0.2",
+    "ws": "^8.18.2"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

packages/ws/src/actions/commit.ts

@@ -0,0 +1,50 @@
+import { type SocketClient } from "../client";
+import { SocketEvents } from "../enum";
+import type { SocketCommitActionOptions, SocketEventCommitData } from "../types";
+
+/** *Note* Setting the `options.onError` property prevents promise rejection */
+export function commitAction(
+  socket: SocketClient<SocketEventCommitData>,
+  buffer: Buffer,
+  options: SocketCommitActionOptions = {},
+) {
+  return new Promise<boolean>((resolve, reject) => {
+    let success = false;
+
+    function onError(error: any) {
+      if (typeof options.onError === "function") return options.onError(error);
+      socket.dispose();
+      reject(error);
+    }
+
+    socket
+      .on(SocketEvents.close, (code, reason) => {
+        if (typeof options.onClose === "function") options.onClose(code, reason);
+        resolve(success);
+      })
+      .on(SocketEvents.error, onError)
+      .on(SocketEvents.connecting, () => {
+        if (typeof options.onConnecting === "function") options.onConnecting();
+      })
+      .on(SocketEvents.connected, async () => {
+        if (typeof options.onConnected === "function") options.onConnected();
+
+        try {
+          await socket.sendBuffer(buffer, options.onProgress);
+        } catch (error: any) {
+          onError(error);
+        }
+      })
+      .on(SocketEvents.data, (data) => {
+        if (typeof options.onData === "function") options.onData(data);
+
+        switch (data.statusCode) {
+          case 200:
+            success = true;
+            break;
+        }
+      })
+      .connect()
+      .catch(onError);
+  });
+}

packages/ws/src/actions/upload.ts

@@ -0,0 +1,49 @@
+import { type ApiApp } from "@discloudapp/api-types/v2";
+import { type SocketClient } from "../client";
+import { SocketEvents } from "../enum";
+import type { SocketEventUploadData, SocketUploadActionOptions } from "../types";
+
+/** *Note* Setting the `options.onError` property prevents promise rejection */
+export function uploadAction(socket: SocketClient<SocketEventUploadData>, buffer: Buffer, options?: SocketUploadActionOptions): Promise<ApiApp | void>
+export function uploadAction(socket: SocketClient, buffer: Buffer, options?: SocketUploadActionOptions): Promise<ApiApp | void>
+export function uploadAction(socket: SocketClient<SocketEventUploadData>, buffer: Buffer, options: SocketUploadActionOptions = {}) {
+  return new Promise<ApiApp | void>((resolve, reject) => {
+    let app: ApiApp;
+
+    function onError(error: any) {
+      if (typeof options.onError === "function") return options.onError(error);
+      socket.dispose();
+      reject(error);
+    }
+
+    socket
+      .on(SocketEvents.close, (code, reason) => {
+        if (typeof options.onClose === "function") options.onClose(code, reason);
+        resolve(app);
+      })
+      .on(SocketEvents.error, onError)
+      .on(SocketEvents.connecting, () => {
+        if (typeof options.onConnecting === "function") options.onConnecting();
+      })
+      .on(SocketEvents.connected, async () => {
+        if (typeof options.onConnected === "function") options.onConnected();
+
+        try {
+          await socket.sendBuffer(buffer, options.onProgress);
+        } catch (error: any) {
+          onError(error);
+        }
+      })
+      .on(SocketEvents.data, (data) => {
+        switch (data.statusCode) {
+          case 102:
+            if (typeof options.onData === "function") options.onData(data);
+            break;
+        }
+
+        if (data.app) app = data.app;
+      })
+      .connect()
+      .catch(onError);
+  });
+}