@wireflowapp/vue-websocket 0.0.0-stage → 1.0.0

package/README.md

@@ -1,3 +1,36 @@
-# Temporary Holding Version
+# @wireflowapp/vue-websocket
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Vue 3 composable for native WebSocket connection management in **Wireflow**.
+
+## Features
+
+- **Reactive State**: Exposes `Ref<ConnectionStatus>` for straightforward template binding.
+- **Automatic Cleanup**: Integrates with Vue's `onUnmounted` lifecycle.
+- **Zero Framework Pollution in Core**: Thin, type-safe adapter over `@wireflowapp/websocket-core`.
+
+## Installation
+
+```bash
+pnpm add @wireflowapp/vue-websocket @wireflowapp/websocket-core @wireflowapp/core
+```
+
+## Quick Start
+
+```vue
+<script setup lang="ts">
+import { useWebSocket } from "@wireflowapp/vue-websocket";
+
+const { status, connect, retry, disconnect, send } = useWebSocket("wss://example.com/ws", {
+  retryAttempts: 5,
+});
+</script>
+
+<template>
+  <div>
+    <p>Status: {{ status }}</p>
+    <button @click="send('Ping')">Send Ping</button>
+    <button @click="disconnect">Disconnect</button>
+    <button @click="retry">Retry</button>
+  </div>
+</template>
+```

package/dist/index.d.mts

@@ -0,0 +1,42 @@
+import { Ref } from 'vue';
+import { ConnectionStatus } from '@wireflowapp/core';
+import { WebSocketOptions, WebSocketDataType, WebSocketClient } from '@wireflowapp/websocket-core';
+
+interface UseWebSocketOptions extends WebSocketOptions {
+}
+interface UseWebSocketResult {
+    /**
+     * Reactive connection status.
+     */
+    readonly status: Ref<ConnectionStatus>;
+    /**
+     * Connect to the WebSocket server.
+     */
+    connect: () => void;
+    /**
+     * Retry connection if idle or failed.
+     */
+    retry: () => void;
+    /**
+     * Disconnect the active socket and cancel retries.
+     */
+    disconnect: () => void;
+    /**
+     * Send data through the active WebSocket connection.
+     */
+    send: (data: WebSocketDataType) => boolean;
+    /**
+     * The underlying WebSocketClient instance.
+     */
+    client: WebSocketClient;
+}
+
+/**
+ * Vue composable providing reactive connection state and controls over a native WebSocket connection.
+ *
+ * @param url The WebSocket server URL.
+ * @param options Optional configuration parameters and lifecycle event handlers.
+ */
+declare function useWebSocket(url: string, options?: UseWebSocketOptions): UseWebSocketResult;
+
+export { type UseWebSocketOptions, type UseWebSocketResult, useWebSocket };

package/dist/index.d.ts

@@ -0,0 +1,42 @@
+import { Ref } from 'vue';
+import { ConnectionStatus } from '@wireflowapp/core';
+import { WebSocketOptions, WebSocketDataType, WebSocketClient } from '@wireflowapp/websocket-core';
+
+interface UseWebSocketOptions extends WebSocketOptions {
+}
+interface UseWebSocketResult {
+    /**
+     * Reactive connection status.
+     */
+    readonly status: Ref<ConnectionStatus>;
+    /**
+     * Connect to the WebSocket server.
+     */
+    connect: () => void;
+    /**
+     * Retry connection if idle or failed.
+     */
+    retry: () => void;
+    /**
+     * Disconnect the active socket and cancel retries.
+     */
+    disconnect: () => void;
+    /**
+     * Send data through the active WebSocket connection.
+     */
+    send: (data: WebSocketDataType) => boolean;
+    /**
+     * The underlying WebSocketClient instance.
+     */
+    client: WebSocketClient;
+}
+
+/**
+ * Vue composable providing reactive connection state and controls over a native WebSocket connection.
+ *
+ * @param url The WebSocket server URL.
+ * @param options Optional configuration parameters and lifecycle event handlers.
+ */
+declare function useWebSocket(url: string, options?: UseWebSocketOptions): UseWebSocketResult;
+
+export { type UseWebSocketOptions, type UseWebSocketResult, useWebSocket };

package/dist/index.js

@@ -0,0 +1,69 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  useWebSocket: () => useWebSocket
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/composables/useWebSocket.ts
+var import_vue = require("vue");
+var import_websocket_core = require("@wireflowapp/websocket-core");
+function useWebSocket(url, options = {}) {
+  const status = (0, import_vue.ref)("Idle");
+  const client = new import_websocket_core.WebSocketClient(url, {
+    ...options,
+    onStatusChange: (newStatus) => {
+      status.value = newStatus;
+      options.onStatusChange?.(newStatus);
+    }
+  });
+  status.value = client.status;
+  if ((0, import_vue.getCurrentInstance)()) {
+    (0, import_vue.onUnmounted)(() => {
+      client.dispose();
+    });
+  }
+  const connect = () => {
+    client.connect();
+  };
+  const retry = () => {
+    client.retry();
+  };
+  const disconnect = () => {
+    client.disconnect();
+  };
+  const send = (data) => {
+    return client.send(data);
+  };
+  return {
+    status,
+    connect,
+    retry,
+    disconnect,
+    send,
+    client
+  };
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  useWebSocket
+});

package/dist/index.mjs

@@ -0,0 +1,44 @@
+// src/composables/useWebSocket.ts
+import { getCurrentInstance, onUnmounted, ref } from "vue";
+import {
+  WebSocketClient
+} from "@wireflowapp/websocket-core";
+function useWebSocket(url, options = {}) {
+  const status = ref("Idle");
+  const client = new WebSocketClient(url, {
+    ...options,
+    onStatusChange: (newStatus) => {
+      status.value = newStatus;
+      options.onStatusChange?.(newStatus);
+    }
+  });
+  status.value = client.status;
+  if (getCurrentInstance()) {
+    onUnmounted(() => {
+      client.dispose();
+    });
+  }
+  const connect = () => {
+    client.connect();
+  };
+  const retry = () => {
+    client.retry();
+  };
+  const disconnect = () => {
+    client.disconnect();
+  };
+  const send = (data) => {
+    return client.send(data);
+  };
+  return {
+    status,
+    connect,
+    retry,
+    disconnect,
+    send,
+    client
+  };
+}
+export {
+  useWebSocket
+};

package/package.json

@@ -1,6 +1,51 @@
 {
   "name": "@wireflowapp/vue-websocket",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "1.0.0",
+  "description": "Vue composable for native WebSocket connection management with Wireflow",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.mts",
+        "default": "./dist/index.mjs"
+      },
+      "require": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      }
+    }
+  },
+  "sideEffects": false,
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "dist"
+  ],
+  "peerDependencies": {
+    "vue": ">=3.0.0"
+  },
+  "dependencies": {
+    "@wireflowapp/core": "1.0.0",
+    "@wireflowapp/websocket-core": "1.0.0"
+  },
+  "devDependencies": {
+    "vue": "^3.5.13"
+  },
+  "keywords": [
+    "vue",
+    "composable",
+    "websocket",
+    "wireflow",
+    "real-time"
+  ],
+  "author": "",
+  "license": "MIT",
+  "scripts": {
+    "build": "tsup src/index.ts --format esm,cjs --dts --clean",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run"
+  }
 }