@bitbitpress/client 0.1.7 → 0.1.8

package/README.md

@@ -306,6 +306,7 @@ client.user.signal(options: SignalRequest): Promise<SignalResponse>
   - `contentContext` (optional): Context about the content that triggered this signal
     - `contentId` (required): The ID of the content (e.g., your article ID)
     - `contentType` (required): The type of content (currently only `"article"`)
+- `options.isSynchronous` (optional): When `true`, the request waits for signals to be processed. Defaults to `false`. Use sparingly.
 
 ##### Returns
 
@@ -559,6 +560,8 @@ for await (const event of stream) {
 
 ### Types
 
+API request/response types are derived from the Control Room OpenAPI spec. The source of truth is `src/generated/openapi.d.ts`, generated by `npm run generate:types`. The types below mirror that spec for reference.
+
 #### BitBitPressClientConfig
 
 ```typescript
@@ -650,6 +653,8 @@ type SignalRequest = {
       contentType: 'article';
     };
   }>;
+  /** When true, wait for signals to be processed. Default false. Use sparingly. */
+  isSynchronous?: boolean;
 }
 ```
 

package/dist/generated/openapi.d.ts

@@ -482,6 +482,8 @@ export interface paths {
                                 contentType: "article";
                             };
                         }[];
+                        /** @description Whether the request should wait for the signals to be processed. False by default. Use sparingly. */
+                        isSynchronous?: boolean;
                     };
                 };
             };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bitbitpress/client",
-  "version": "0.1.7",
+  "version": "0.1.8",
   "description": "BitBitPress TypeScript client library",
   "type": "module",
   "main": "./dist/index.js",