sockress-client 0.1.4 → 0.1.5

package/README.md

@@ -0,0 +1,61 @@
+# Sockress Client SDK
+
+sockress-client is the companion SDK for Sockress-powered backends. It automatically prefers a WebSocket transport (sharing the same request/response semantics as HTTP) and silently falls back to etch when a socket is unavailable. Multipart uploads (FormData) are serialized over the wire, so you can use a single API surface for avatars, profile forms, and realtime commands.
+
+Created by **Also Coder** · [alsocoder.com](https://alsocoder.com) · [github.com/alsocoders](https://github.com/alsocoders)
+
+## Installation
+
+`ash
+npm install sockress-client
+`
+
+## Usage
+
+`	s
+import { sockressClient } from 'sockress-client';
+
+const api = sockressClient({
+  baseUrl: 'http://localhost:5051',
+  autoConnect: true,
+  preferSocket: true
+});
+
+const login = async () => {
+  const response = await api.post('/api/auth/login', {
+    body: { email: 'demo@sockress.dev', password: 'pass123' }
+  });
+
+  console.log('token', response.body.token);
+};
+`
+
+### File Uploads
+
+`	s
+export async function uploadAvatar(file, token) {
+  const formData = new FormData();
+  formData.append('avatar', file);
+
+  const response = await api.request({
+    path: '/api/profile/avatar',
+    method: 'POST',
+    body: formData,
+    headers: { Authorization: Bearer  }
+  });
+
+  return response.body;
+}
+`
+
+### Events
+
+`	s
+api.on('open', () => console.log('socket ready'));  // when the WebSocket connects
+api.on('error', (err) => console.error(err));
+api.on('reconnect', ({ attempt }) => console.log('retry', attempt));
+`
+
+---
+
+Questions or feedback? Ping [alsocoder.com](https://alsocoder.com) or [@alsocoders](https://github.com/alsocoders).

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "sockress-client",
-  "version": "0.1.4",
-  "description": "Client SDK for Sockress with socket-first transport and HTTP fallback",
+  "version": "0.1.5",
+  "description": "Socket-first client SDK for Sockress servers with automatic HTTP fallback and FormData serialization.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "type": "commonjs",
@@ -16,6 +16,29 @@
     "build": "tsc -p tsconfig.json",
     "prepublishOnly": "npm run build"
   },
+  "author": {
+    "name": "Also Coder",
+    "email": "hello@alsocoder.com",
+    "url": "https://alsocoder.com"
+  },
+  "homepage": "https://alsocoder.com",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/alsocoders/sockress"
+  },
+  "bugs": {
+    "url": "https://github.com/alsocoders/sockress/issues"
+  },
+  "keywords": [
+    "sockress",
+    "websocket",
+    "http",
+    "client",
+    "upload",
+    "realtime",
+    "nodejs",
+    "browser"
+  ],
   "dependencies": {
     "nanoid": "^5.0.7"
   },