@leancodepl/rx-pipe-client 8.5.0 → 8.6.0

package/README.md

@@ -0,0 +1,104 @@
+# @leancodepl/rx-pipe-client
+
+RxJS-based topic functions for real-time data subscriptions using @leancodepl/pipe.
+
+## Installation
+
+```bash
+npm install @leancodepl/rx-pipe-client
+# or
+yarn add @leancodepl/rx-pipe-client
+```
+
+## API
+
+### `mkPipeClient(pipe)`
+
+Creates topic functions for data subscriptions using @leancodepl/pipe.
+
+**Parameters:**
+
+- `pipe: Pipe` - Pipe instance from @leancodepl/pipe
+
+**Returns:** Object containing `createTopic` method for creating typed observables
+
+## Usage Examples
+
+### Basic Setup
+
+```typescript
+import { mkPipeClient } from "@leancodepl/rx-pipe-client"
+import { createPipe } from "@leancodepl/pipe"
+
+const pipe = createPipe({
+    url: "wss://api.example.com/pipe",
+    getAccessToken: () => localStorage.getItem("token"),
+})
+
+const pipeClient = mkPipeClient({ pipe })
+```
+
+### Chat Messages
+
+```typescript
+import { mkPipeClient } from "@leancodepl/rx-pipe-client"
+import { createPipe } from "@leancodepl/pipe"
+
+interface ChatTopic {
+    roomId: string
+}
+
+interface ChatNotifications {
+    MessageReceived: {
+        id: string
+        content: string
+        authorId: string
+    }
+}
+
+const pipe = createPipe({
+    url: "wss://api.example.com/pipe",
+    getAccessToken: () => localStorage.getItem("token"),
+})
+const pipeClient = mkPipeClient({ pipe })
+const chatTopic = pipeClient.createTopic<ChatTopic, ChatNotifications>("chat")
+
+chatTopic({ roomId: "room1" }).subscribe(notification => {
+    if (notification.type === "MessageReceived") {
+        console.log(`New message: ${notification.data.content}`)
+    }
+})
+```
+
+### Live Metrics with RxJS Operators
+
+```typescript
+import { filter, map } from "rxjs/operators"
+import { mkPipeClient } from "@leancodepl/rx-pipe-client"
+import { createPipe } from "@leancodepl/pipe"
+
+interface MetricsTopic {
+    dashboardId: string
+}
+
+interface MetricsNotifications {
+    CpuUpdate: { value: number }
+    MemoryUpdate: { value: number }
+}
+
+const pipe = createPipe({
+    url: "wss://api.example.com/pipe",
+    getAccessToken: () => localStorage.getItem("token"),
+})
+const pipeClient = mkPipeClient({ pipe })
+const metricsTopic = pipeClient.createTopic<MetricsTopic, MetricsNotifications>("metrics")
+
+const cpuUpdates$ = metricsTopic({ dashboardId: "main" }).pipe(
+    filter(notification => notification.type === "CpuUpdate"),
+    map(notification => notification.data.value),
+)
+
+cpuUpdates$.subscribe(value => {
+    console.log(`CPU: ${value}%`)
+})
+```

package/index.cjs.default.js

@@ -0,0 +1 @@
+exports._default = require('./index.cjs.js').default;

package/index.cjs.js

@@ -0,0 +1,24 @@
+'use strict';
+
+/**
+ * Creates RxJS-based topic functions for real-time data subscriptions using "@leancodepl/pipe".
+ * 
+ * @param pipe - Pipe instance from "@leancodepl/pipe"
+ * @returns Object containing `createTopic` method for creating typed observables
+ * @example
+ * ```typescript
+ * const pipe = createPipe({ url: 'wss://api.example.com/pipe' });
+ * const pipeClient = mkPipeClient({ pipe });
+ * 
+ * const chatTopic = pipeClient.createTopic('chat');
+ * const messages$ = chatTopic({ roomId: 'room1' });
+ * ```
+ */ function mkPipeClient({ pipe }) {
+    return {
+        createTopic (topicType) {
+            return (topic)=>pipe.topic(topicType, topic);
+        }
+    };
+}
+
+exports.mkPipeClient = mkPipeClient;

package/index.cjs.mjs

@@ -0,0 +1,2 @@
+export * from './index.cjs.js';
+export { _default as default } from './index.cjs.default.js';

package/index.d.ts

@@ -0,0 +1 @@
+export * from "./src/index";

package/index.esm.js

@@ -0,0 +1,22 @@
+/**
+ * Creates RxJS-based topic functions for real-time data subscriptions using "@leancodepl/pipe".
+ * 
+ * @param pipe - Pipe instance from "@leancodepl/pipe"
+ * @returns Object containing `createTopic` method for creating typed observables
+ * @example
+ * ```typescript
+ * const pipe = createPipe({ url: 'wss://api.example.com/pipe' });
+ * const pipeClient = mkPipeClient({ pipe });
+ * 
+ * const chatTopic = pipeClient.createTopic('chat');
+ * const messages$ = chatTopic({ roomId: 'room1' });
+ * ```
+ */ function mkPipeClient({ pipe }) {
+    return {
+        createTopic (topicType) {
+            return (topic)=>pipe.topic(topicType, topic);
+        }
+    };
+}
+
+export { mkPipeClient };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@leancodepl/rx-pipe-client",
-  "version": "8.5.0",
+  "version": "8.6.0",
   "license": "Apache-2.0",
   "dependencies": {
     "@leancodepl/pipe": "^1.0.0"
@@ -37,11 +37,6 @@
     "name": "LeanCode",
     "url": "https://leancode.co"
   },
-  "files": [
-    "dist",
-    "README.md",
-    "CHANGELOG.md"
-  ],
   "sideEffects": false,
   "exports": {
     "./package.json": "./package.json",

package/src/index.d.ts

@@ -0,0 +1 @@
+export * from "./lib/mkPipeClient";

package/src/lib/mkPipeClient.d.ts

@@ -0,0 +1,20 @@
+import { Pipe } from "@leancodepl/pipe";
+/**
+ * Creates RxJS-based topic functions for real-time data subscriptions using "@leancodepl/pipe".
+ *
+ * @param pipe - Pipe instance from "@leancodepl/pipe"
+ * @returns Object containing `createTopic` method for creating typed observables
+ * @example
+ * ```typescript
+ * const pipe = createPipe({ url: 'wss://api.example.com/pipe' });
+ * const pipeClient = mkPipeClient({ pipe });
+ *
+ * const chatTopic = pipeClient.createTopic('chat');
+ * const messages$ = chatTopic({ roomId: 'room1' });
+ * ```
+ */
+export declare function mkPipeClient({ pipe }: {
+    pipe: Pipe;
+}): {
+    createTopic<TTopic, TNotifications extends Record<string, unknown>>(topicType: string): (topic: TTopic) => import("rxjs").Observable<import("@leancodepl/pipe").NotificationsUnion<TNotifications>>;
+};