@bitbitpress/client 0.1.3 → 0.1.5

package/README.md

@@ -43,8 +43,11 @@ More details can also be found in your control room's API docs @ https://your-co
 - [User Methods](#user-methods)
   - [authenticate](#authenticate)
   - [token](#token)
+  - [profile](#profile)
   - [recommendations](#recommendations)
+  - [report](#report)
   - [signal](#signal)
+  - [signalItem](#signalitem)
   - [synthesizeItem](#synthesizeitem)
   - [synthesize](#synthesize)
 - [Types](#types)
@@ -66,6 +69,7 @@ new BitBitPressClient(options: BitBitPressClientOptions)
 - `options.headers` (optional): Additional headers to include in all requests
 - `options.timeout` (optional): Request timeout in milliseconds (default: `30000`)
 - `options.synthesizeBatchTimeout` (optional): Batch timeout for `synthesizeItem` in milliseconds (default: `250`)
+- `options.signalBatchTimeout` (optional): Batch timeout for `signalItem` in milliseconds (default: `250`)
 
 ##### Example
 
@@ -74,6 +78,7 @@ const client = new BitBitPressClient({
   baseUrl: 'https://your-control-room.api.dev.bitbitpress.com',
   timeout: 30000,
   synthesizeBatchTimeout: 250,
+  signalBatchTimeout: 250,
 });
 ```
 
@@ -151,6 +156,32 @@ console.log('Access token:', tokenResponse.accessToken);
 
 ---
 
+#### profile
+
+Get user profile information, including suggested interest topics.
+
+```typescript
+client.user.profile(): Promise<ProfileResponse>
+```
+
+##### Returns
+
+- `Promise<ProfileResponse>`: Response containing:
+  - `suggestedInterestTopics?: string[]`: Suggested interest topics for the user
+
+##### Example
+
+```typescript
+const profile = await client.user.profile();
+console.log('Suggested topics:', profile.suggestedInterestTopics);
+```
+
+##### Throws
+
+- `Error`: If the request fails or no data is returned
+
+---
+
 #### recommendations
 
 Get recommended articles for the authenticated user.
@@ -163,6 +194,7 @@ client.user.recommendations(options?: RecommendationsRequest): Promise<Recommend
 
 - `options.limit` (optional): Maximum number of recommendations to return
 - `options.cursor` (optional): Cursor from previous response to fetch the next page
+- `options.fields` (optional): Asset fields to return (dot or bracket notation, e.g. `tags[0]`, `images[1].src`). Allowed: `title`, `tags`, `images`, `videos`, `publishedAt`, `externalId` (your content id), `externalData` and subfields. Returned as JSON string in `fields`.
 
 ##### Returns
 
@@ -172,12 +204,23 @@ client.user.recommendations(options?: RecommendationsRequest): Promise<Recommend
 
 ##### RecommendationItem
 
-- `id?: string`: Your article ID
 - `assetId?: string`: BitBitPress's ID
-- `title?: string`: Article title
-- `content?: string`: Article content
-- `publishedAt?: string`: Publication date (e.g., "2021-01-01")
 - `score?: number`: Recommendation score (e.g., 0.95)
+- `fields?: string`: JSON string of requested asset fields (when `fields` provided in request)
+
+##### Available Fields
+
+Use dot or bracket notation (e.g. `tags[0]`, `images[1].src`). Requested values are returned as a JSON string in each item's `fields` property.
+
+| Field | Type | Structure |
+|-------|------|-----------|
+| `title` | string | Title |
+| `tags` | string[] | Array of strings (auto-extracted or manual tags) |
+| `images` | array | Each item: `{ src, externalId, alt, width, height, credit }` |
+| `videos` | array | Each item: `{ sources: [{ mimeType, src }], externalId, alt, credit, posterUrl, caption, width, height }` |
+| `publishedAt` | string | ISO date when the article was originally published |
+| `externalId` | string | unique identifier from source (your content id) |
+| `externalData` | any | data unique to your content (you must extract subfields that you need from your article data type) |
 
 ##### Example
 
@@ -185,10 +228,54 @@ client.user.recommendations(options?: RecommendationsRequest): Promise<Recommend
 const recommendations = await client.user.recommendations({
   limit: 10,
   cursor: 'optional-cursor-from-previous-response',
+  fields: ['title', 'tags', 'images[0].src', 'publishedAt'],
 });
 
 console.log('Recommendations:', recommendations.items);
 console.log('Next cursor:', recommendations.cursor);
+
+// Access requested fields from the fields JSON string
+if (recommendations.items) {
+  for (const item of recommendations.items) {
+    if (item.fields) {
+      const fields = JSON.parse(item.fields);
+      console.log('Title:', fields.title);
+      console.log('Tags:', fields.tags);
+    }
+  }
+}
+```
+
+##### Throws
+
+- `Error`: If the request fails or no data is returned
+
+---
+
+#### report
+
+Report a bit (create a user-provided bit to be ingested into the system). This may include news or any other content that the user wants to share.
+
+```typescript
+client.user.report(options: ReportRequest): Promise<ReportResponse>
+```
+
+##### Parameters
+
+- `options.title` (optional): Title of the reported content
+- `options.content` (required): Content body of the report
+
+##### Returns
+
+- `Promise<ReportResponse>`: Response containing the report data
+
+##### Example
+
+```typescript
+await client.user.report({
+  title: 'Breaking News: Important Update',
+  content: 'This is the content of the news article or bit that the user wants to share.',
+});
 ```
 
 ##### Throws
@@ -199,7 +286,7 @@ console.log('Next cursor:', recommendations.cursor);
 
 #### signal
 
-Record a user signal (e.g., clicked topic, read article) to inform profile interests. Signals are used to power a user's recommendations.
+Record user signals (e.g., clicked topic, read article) to inform profile interests. Signals are used to power a user's recommendations.
 
 ```typescript
 client.user.signal(options: SignalRequest): Promise<SignalResponse>
@@ -207,25 +294,88 @@ client.user.signal(options: SignalRequest): Promise<SignalResponse>
 
 ##### Parameters
 
-- `options.signal` (required): User action with the text associated with the interaction (e.g., `'searched for \"best restaurants\"'`)
-- `options.type` (required): Signal type - `"active"` or `"passive"`
-  - `"active"`: Explicit intent (click, search, subscribe)
-  - `"passive"`: Implicit intent (read, scroll, dwell)
-- `options.negative` (optional): When `true`, indicates the signal is negative (e.g., dislike, unfollow). Defaults to `false`. Use sparingly.
-- `options.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.signals` (required): Array of signals to record. Each signal object contains:
+  - `signal` (required): User action with the text associated with the interaction (e.g., `'searched for \"best restaurants\"'`)
+  - `type` (required): Signal type - `"active"` or `"passive"`
+    - `"active"`: Explicit intent (click, search, subscribe)
+    - `"passive"`: Implicit intent (read, scroll, dwell)
+  - `negative` (optional): When `true`, indicates the signal is negative (e.g., dislike, unfollow). Defaults to `false`. Use sparingly.
+  - `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"`)
 
 ##### Returns
 
 - `Promise<SignalResponse>`: Response containing:
-  - `recorded?: boolean`: Whether the signal was recorded (false if no user or empty signal)
+  - `recorded?: boolean`: Whether the signals were recorded (false if no user or no valid signals)
 
 ##### Example
 
 ```typescript
-// Active signal (explicit intent)
+// Record multiple signals at once
 await client.user.signal({
+  signals: [
+    {
+      signal: 'searched "best restaurants"',
+      type: 'active',
+      contentContext: {
+        contentId: 'article-123',
+        contentType: 'article',
+      },
+    },
+    {
+      signal: 'read article about NBA trades',
+      type: 'passive',
+      contentContext: {
+        contentId: 'article-456',
+        contentType: 'article',
+      },
+    },
+    {
+      signal: 'unfollowed topic "Politics"',
+      type: 'active',
+      negative: true,
+    },
+  ],
+});
+```
+
+##### Throws
+
+- `Error`: If the request fails or no data is returned
+
+---
+
+#### signalItem
+
+Record a single signal (batched). Signals are automatically batched and sent together after the configured timeout.
+
+```typescript
+client.user.signalItem(signal: Signal): Promise<SignalResponse>
+```
+
+##### Parameters
+
+- `signal` (required): A single signal object (same format as items in the `signals` array for `signal`)
+
+##### Returns
+
+- `Promise<SignalResponse>`: Response containing:
+  - `recorded?: boolean`: Whether the signal was recorded (false if no user or no valid signals)
+
+##### Behavior
+
+- Signals added within the batch timeout window (default: 250ms) are grouped together and sent in a single request
+- Each signal's promise resolves with the batch response when the request completes
+- The batching happens in the background - promises resolve as soon as the batch request completes
+- The batch timeout can be configured when creating the client via `signalBatchTimeout`
+
+##### Example
+
+```typescript
+// Signals are automatically batched and sent together after the timeout
+// Each promise resolves with the batch response
+const response1 = await client.user.signalItem({
   signal: 'searched "best restaurants"',
   type: 'active',
   contentContext: {
@@ -234,8 +384,7 @@ await client.user.signal({
   },
 });
 
-// Passive signal (implicit intent)
-await client.user.signal({
+const response2 = await client.user.signalItem({
   signal: 'read article about NBA trades',
   type: 'passive',
   contentContext: {
@@ -244,12 +393,10 @@ await client.user.signal({
   },
 });
 
-// Negative signal (use sparingly)
-await client.user.signal({
-  signal: 'unfollowed topic "Politics"',
-  type: 'active',
-  negative: true,
-});
+// Both signals are sent together in a single batch request
+// Each promise resolves when the batch request completes
+console.log('Signal 1 recorded:', response1.recorded);
+console.log('Signal 2 recorded:', response2.recorded);
 ```
 
 ##### Throws
@@ -330,6 +477,7 @@ client.user.synthesize(items: SynthesizeRequest['items']): Promise<AsyncIterable
 
 - `fieldName` (required): Name of the field
 - `fieldDescription` (required): A prompt describing the value of the field
+- `fieldCharacterLimit` (optional): The maximum number of characters that can be returned for this field
 
 ##### ContentContext (required for CUSTOM items)
 
@@ -400,6 +548,7 @@ interface BitBitPressClientConfig {
   headers?: Record<string, string>;
   timeout?: number;
   synthesizeBatchTimeout?: number;
+  signalBatchTimeout?: number;
 }
 ```
 
@@ -428,6 +577,15 @@ type TokenResponse = {
 type RecommendationsRequest = {
   limit?: number;
   cursor?: string;
+  fields?: string[];
+}
+```
+
+#### ProfileResponse
+
+```typescript
+type ProfileResponse = {
+  suggestedInterestTopics?: string[];
 }
 ```
 
@@ -436,22 +594,49 @@ type RecommendationsRequest = {
 ```typescript
 type RecommendationsResponse = {
   items?: Array<{
-    id?: string;
     assetId?: string;
-    title?: string;
-    summary?: string;
-    content?: string;
-    publishedAt?: string;
     score?: number;
+    fields?: string; // JSON string of requested asset fields
   }>;
   cursor?: string;
 }
 ```
 
+#### ReportRequest
+
+```typescript
+type ReportRequest = {
+  title?: string;
+  content: string;
+}
+```
+
+#### ReportResponse
+
+```typescript
+type ReportResponse = unknown;
+```
+
 #### SignalRequest
 
 ```typescript
 type SignalRequest = {
+  signals: Array<{
+    signal: string;
+    type: 'active' | 'passive';
+    negative?: boolean;
+    contentContext?: {
+      contentId: string;
+      contentType: 'article';
+    };
+  }>;
+}
+```
+
+#### Signal
+
+```typescript
+type Signal = {
   signal: string;
   type: 'active' | 'passive';
   negative?: boolean;

package/dist/client.d.ts

@@ -26,6 +26,12 @@ export interface BitBitPressClientConfig {
      * @default 250
      */
     synthesizeBatchTimeout?: number;
+    /**
+     * Batch timeout for signalItem in milliseconds
+     * Signals will be batched and sent after this delay
+     * @default 250
+     */
+    signalBatchTimeout?: number;
 }
 /**
  * Options for creating a BitBitPress client instance
@@ -54,6 +60,10 @@ export declare class BitBitPressClient {
      * Get synthesize batch timeout configuration
      */
     private getSynthesizeBatchTimeout;
+    /**
+     * Get signal batch timeout configuration
+     */
+    private getSignalBatchTimeout;
     /**
      * User-related API methods
      * Provides type-safe access to user endpoints like signal, recommendations, synthesize, etc.

package/dist/client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AACA,OAAO,EAAqB,KAAK,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAEtE;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,KAAK,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAEjC;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;OAIG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,wBAAyB,SAAQ,uBAAuB;CAAG;AAE5E;;;;;GAKG;AACH,qBAAa,iBAAiB;IAC5B,OAAO,CAAC,MAAM,CACkE;IAChF,OAAO,CAAC,mBAAmB,CAAC,CAAc;gBAE9B,OAAO,EAAE,wBAAwB;IAqB7C;;OAEG;IACH,UAAU,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAMjC;;OAEG;IACH,OAAO,CAAC,gBAAgB;IASxB;;OAEG;IACH,OAAO,CAAC,yBAAyB;IAIjC;;;OAGG;IACH,IAAI,IAAI,IAAI,WAAW,CAQtB;CACF"}
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AACA,OAAO,EAAqB,KAAK,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAEtE;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,KAAK,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAEjC;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;OAIG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAEhC;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,wBAAyB,SAAQ,uBAAuB;CAAG;AAE5E;;;;;GAKG;AACH,qBAAa,iBAAiB;IAC5B,OAAO,CAAC,MAAM,CACyF;IACvG,OAAO,CAAC,mBAAmB,CAAC,CAAc;gBAE9B,OAAO,EAAE,wBAAwB;IAsB7C;;OAEG;IACH,UAAU,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAMjC;;OAEG;IACH,OAAO,CAAC,gBAAgB;IASxB;;OAEG;IACH,OAAO,CAAC,yBAAyB;IAIjC;;OAEG;IACH,OAAO,CAAC,qBAAqB;IAI7B;;;OAGG;IACH,IAAI,IAAI,IAAI,WAAW,CAStB;CACF"}

package/dist/client.js

@@ -19,6 +19,7 @@ class BitBitPressClient {
             baseUrl: options.baseUrl,
             timeout: options.timeout ?? 30000,
             synthesizeBatchTimeout: options.synthesizeBatchTimeout,
+            signalBatchTimeout: options.signalBatchTimeout,
             fetch: options.fetch ?? (typeof globalThis !== 'undefined' ? globalThis.fetch : undefined),
             headers: options.headers,
         };
@@ -52,13 +53,19 @@ class BitBitPressClient {
     getSynthesizeBatchTimeout() {
         return this.config.synthesizeBatchTimeout;
     }
+    /**
+     * Get signal batch timeout configuration
+     */
+    getSignalBatchTimeout() {
+        return this.config.signalBatchTimeout;
+    }
     /**
      * User-related API methods
      * Provides type-safe access to user endpoints like signal, recommendations, synthesize, etc.
      */
     get user() {
         if (!this.userMethodsInstance) {
-            this.userMethodsInstance = (0, index_js_1.createUserMethods)(this.getRequestConfig(), this.getSynthesizeBatchTimeout());
+            this.userMethodsInstance = (0, index_js_1.createUserMethods)(this.getRequestConfig(), this.getSynthesizeBatchTimeout(), this.getSignalBatchTimeout());
         }
         return this.userMethodsInstance;
     }

package/dist/client.js.map

@@ -1 +1 @@
-{"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":";;;AACA,8CAAsE;AAwCtE;;;;;GAKG;AACH,MAAa,iBAAiB;IACpB,MAAM,CACkE;IACxE,mBAAmB,CAAe;IAE1C,YAAY,OAAiC;QAC3C,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;YACrB,MAAM,IAAI,KAAK,CAAC,uEAAuE,CAAC,CAAC;QAC3F,CAAC;QAED,IAAI,CAAC,MAAM,GAAG;YACZ,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,OAAO,EAAE,OAAO,CAAC,OAAO,IAAI,KAAK;YACjC,sBAAsB,EAAE,OAAO,CAAC,sBAAsB;YACtD,KAAK,EAAE,OAAO,CAAC,KAAK,IAAI,CAAC,OAAO,UAAU,KAAK,WAAW,CAAC,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;YAC1F,OAAO,EAAE,OAAO,CAAC,OAAO;SACzB,CAAC;QAEF,8BAA8B;QAC9B,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;YACvB,MAAM,IAAI,KAAK,CACb,iIAAiI,CAClI,CAAC;QACJ,CAAC;IACH,CAAC;IAED;;OAEG;IACH,UAAU,CAAC,OAAe;QACxB,IAAI,CAAC,MAAM,CAAC,OAAO,GAAG,OAAO,CAAC;QAC9B,gFAAgF;QAChF,IAAI,CAAC,mBAAmB,GAAG,SAAS,CAAC;IACvC,CAAC;IAED;;OAEG;IACK,gBAAgB;QACtB,OAAO;YACL,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,OAAO;YAC5B,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,OAAO;YAC5B,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,KAAM;YACzB,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,OAAO;SAC7B,CAAC;IACJ,CAAC;IAED;;OAEG;IACK,yBAAyB;QAC/B,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC;IAC5C,CAAC;IAED;;;OAGG;IACH,IAAI,IAAI;QACN,IAAI,CAAC,IAAI,CAAC,mBAAmB,EAAE,CAAC;YAC9B,IAAI,CAAC,mBAAmB,GAAG,IAAA,4BAAiB,EAC1C,IAAI,CAAC,gBAAgB,EAAE,EACvB,IAAI,CAAC,yBAAyB,EAAE,CACjC,CAAC;QACJ,CAAC;QACD,OAAO,IAAI,CAAC,mBAAmB,CAAC;IAClC,CAAC;CACF;AAnED,8CAmEC"}
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":";;;AACA,8CAAsE;AA+CtE;;;;;GAKG;AACH,MAAa,iBAAiB;IACpB,MAAM,CACyF;IAC/F,mBAAmB,CAAe;IAE1C,YAAY,OAAiC;QAC3C,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;YACrB,MAAM,IAAI,KAAK,CAAC,uEAAuE,CAAC,CAAC;QAC3F,CAAC;QAED,IAAI,CAAC,MAAM,GAAG;YACZ,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,OAAO,EAAE,OAAO,CAAC,OAAO,IAAI,KAAK;YACjC,sBAAsB,EAAE,OAAO,CAAC,sBAAsB;YACtD,kBAAkB,EAAE,OAAO,CAAC,kBAAkB;YAC9C,KAAK,EAAE,OAAO,CAAC,KAAK,IAAI,CAAC,OAAO,UAAU,KAAK,WAAW,CAAC,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;YAC1F,OAAO,EAAE,OAAO,CAAC,OAAO;SACzB,CAAC;QAEF,8BAA8B;QAC9B,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;YACvB,MAAM,IAAI,KAAK,CACb,iIAAiI,CAClI,CAAC;QACJ,CAAC;IACH,CAAC;IAED;;OAEG;IACH,UAAU,CAAC,OAAe;QACxB,IAAI,CAAC,MAAM,CAAC,OAAO,GAAG,OAAO,CAAC;QAC9B,gFAAgF;QAChF,IAAI,CAAC,mBAAmB,GAAG,SAAS,CAAC;IACvC,CAAC;IAED;;OAEG;IACK,gBAAgB;QACtB,OAAO;YACL,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,OAAO;YAC5B,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,OAAO;YAC5B,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,KAAM;YACzB,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,OAAO;SAC7B,CAAC;IACJ,CAAC;IAED;;OAEG;IACK,yBAAyB;QAC/B,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC;IAC5C,CAAC;IAED;;OAEG;IACK,qBAAqB;QAC3B,OAAO,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC;IACxC,CAAC;IAED;;;OAGG;IACH,IAAI,IAAI;QACN,IAAI,CAAC,IAAI,CAAC,mBAAmB,EAAE,CAAC;YAC9B,IAAI,CAAC,mBAAmB,GAAG,IAAA,4BAAiB,EAC1C,IAAI,CAAC,gBAAgB,EAAE,EACvB,IAAI,CAAC,yBAAyB,EAAE,EAChC,IAAI,CAAC,qBAAqB,EAAE,CAC7B,CAAC;QACJ,CAAC;QACD,OAAO,IAAI,CAAC,mBAAmB,CAAC;IAClC,CAAC;CACF;AA5ED,8CA4EC"}

package/dist/examples/basic-usage.d.ts

@@ -7,5 +7,6 @@ declare function basicExample(): Promise<void>;
 declare function streamingExample(): Promise<void>;
 declare function batchedSynthesisExample(): Promise<void>;
 declare function signalExample(): Promise<void>;
-export { basicExample, streamingExample, batchedSynthesisExample, signalExample };
+declare function batchedSignalExample(): Promise<void>;
+export { basicExample, streamingExample, batchedSynthesisExample, signalExample, batchedSignalExample };
 //# sourceMappingURL=basic-usage.d.ts.map

package/dist/examples/basic-usage.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"basic-usage.d.ts","sourceRoot":"","sources":["../../src/examples/basic-usage.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAKH,iBAAe,YAAY,kBAwB1B;AAGD,iBAAe,gBAAgB,kBAyC9B;AAGD,iBAAe,uBAAuB,kBA4BrC;AAGD,iBAAe,aAAa,kBAkC3B;AAED,OAAO,EAAE,YAAY,EAAE,gBAAgB,EAAE,uBAAuB,EAAE,aAAa,EAAE,CAAC"}
+{"version":3,"file":"basic-usage.d.ts","sourceRoot":"","sources":["../../src/examples/basic-usage.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAKH,iBAAe,YAAY,kBA4B1B;AAGD,iBAAe,gBAAgB,kBAyC9B;AAGD,iBAAe,uBAAuB,kBA4BrC;AAGD,iBAAe,aAAa,kBAqC3B;AAGD,iBAAe,oBAAoB,kBAiClC;AAED,OAAO,EAAE,YAAY,EAAE,gBAAgB,EAAE,uBAAuB,EAAE,aAAa,EAAE,oBAAoB,EAAE,CAAC"}

package/dist/examples/basic-usage.js

@@ -16,14 +16,18 @@ async function basicExample() {
         limit: 10,
     });
     console.log('Recommendations:', recommendations.items);
-    // Record a user signal (e.g., user clicked on an article)
+    // Record user signals (e.g., user clicked on an article)
     const signalResult = await client.user.signal({
-        signal: 'clicked "Warriors intend to keep Jimmy Butler despite season-ending injury"',
-        type: 'active',
-        contentContext: {
-            contentId: 'article-123',
-            contentType: 'article',
-        },
+        signals: [
+            {
+                signal: 'searched "best restaurants"',
+                type: 'active',
+                contentContext: {
+                    contentId: 'article-123',
+                    contentType: 'article',
+                },
+            },
+        ],
     });
     console.log('Signal recorded:', signalResult.recorded);
 }
@@ -100,8 +104,47 @@ async function signalExample() {
     });
     // Authenticate first
     await client.user.authenticate("your-user's-auth-sso-token");
-    // Record an active signal (explicit intent like click, search, subscribe)
+    // Record multiple signals at once
     await client.user.signal({
+        signals: [
+            // Active signal (explicit intent like click, search, subscribe)
+            {
+                signal: 'clicked "Warriors intend to keep Jimmy Butler despite season-ending injury"',
+                type: 'active',
+                contentContext: {
+                    contentId: 'article-123',
+                    contentType: 'article',
+                },
+            },
+            // Passive signal (implicit like read, scroll, dwell)
+            {
+                signal: 'read about NBA trades',
+                type: 'passive',
+                contentContext: {
+                    contentId: 'article-456',
+                    contentType: 'article',
+                },
+            },
+            // Negative signal (e.g., dislike, unfollow) - use sparingly
+            {
+                signal: 'unfollowed topic "Politics"',
+                type: 'active',
+                negative: true,
+            },
+        ],
+    });
+}
+// Example 5: Batched signals with signalItem
+async function batchedSignalExample() {
+    const client = new BitBitPressClient({
+        baseUrl: 'https://your-control-room.api.dev.bitbitpress.com',
+        signalBatchTimeout: 250, // Optional: customize batch timeout
+    });
+    // Authenticate first
+    await client.user.authenticate("your-user's-auth-sso-token");
+    // Signals are automatically batched and sent together after the timeout
+    // Each promise resolves with the batch response
+    const response1 = await client.user.signalItem({
         signal: 'clicked "Warriors intend to keep Jimmy Butler despite season-ending injury"',
         type: 'active',
         contentContext: {
@@ -109,8 +152,7 @@ async function signalExample() {
             contentType: 'article',
         },
     });
-    // Record a passive signal (implicit like read, scroll, dwell)
-    await client.user.signal({
+    const response2 = await client.user.signalItem({
         signal: 'read about NBA trades',
         type: 'passive',
         contentContext: {
@@ -118,12 +160,10 @@ async function signalExample() {
             contentType: 'article',
         },
     });
-    // Record a negative signal (e.g., dislike, unfollow) - use sparingly
-    await client.user.signal({
-        signal: 'unfollowed topic "Politics"',
-        type: 'active',
-        negative: true,
-    });
+    // Both signals are sent together in a single batch request
+    // Each promise resolves when the batch request completes
+    console.log('Signal 1 recorded:', response1.recorded);
+    console.log('Signal 2 recorded:', response2.recorded);
 }
-export { basicExample, streamingExample, batchedSynthesisExample, signalExample };
+export { basicExample, streamingExample, batchedSynthesisExample, signalExample, batchedSignalExample };
 //# sourceMappingURL=basic-usage.js.map

package/dist/examples/basic-usage.js.map

@@ -1 +1 @@
-{"version":3,"file":"basic-usage.js","sourceRoot":"","sources":["../../src/examples/basic-usage.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAEjD,6CAA6C;AAC7C,KAAK,UAAU,YAAY;IACzB,MAAM,MAAM,GAAG,IAAI,iBAAiB,CAAC;QACnC,OAAO,EAAE,mDAAmD;KAC7D,CAAC,CAAC;IAEH,gFAAgF;IAChF,MAAM,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,4BAA4B,CAAC,CAAC;IAE7D,sBAAsB;IACtB,MAAM,eAAe,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC;QACxD,KAAK,EAAE,EAAE;KACV,CAAC,CAAC;IACH,OAAO,CAAC,GAAG,CAAC,kBAAkB,EAAE,eAAe,CAAC,KAAK,CAAC,CAAC;IAEvD,0DAA0D;IAC1D,MAAM,YAAY,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC;QAC5C,MAAM,EAAE,6EAA6E;QACrF,IAAI,EAAE,QAAQ;QACd,cAAc,EAAE;YACd,SAAS,EAAE,aAAa;YACxB,WAAW,EAAE,SAAS;SACvB;KACF,CAAC,CAAC;IACH,OAAO,CAAC,GAAG,CAAC,kBAAkB,EAAE,YAAY,CAAC,QAAQ,CAAC,CAAC;AACzD,CAAC;AAED,iCAAiC;AACjC,KAAK,UAAU,gBAAgB;IAC7B,MAAM,MAAM,GAAG,IAAI,iBAAiB,CAAC;QACnC,OAAO,EAAE,mDAAmD;KAC7D,CAAC,CAAC;IAEH,qBAAqB;IACrB,MAAM,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,4BAA4B,CAAC,CAAC;IAE7D,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC;QAC1C;YACE,IAAI,EAAE,eAAe;SACtB;QACD;YACE,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE;gBACN,EAAE,SAAS,EAAE,OAAO,EAAE,gBAAgB,EAAE,mBAAmB,EAAE;gBAC7D,EAAE,SAAS,EAAE,SAAS,EAAE,gBAAgB,EAAE,iBAAiB,EAAE;aAC9D;YACD,cAAc,EAAE;gBACd,SAAS,EAAE,aAAa;gBACxB,WAAW,EAAE,SAAS;aACvB;SACF;KACF,CAAC,CAAC;IAEH,IAAI,KAAK,EAAE,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;QACjC,QAAQ,KAAK,CAAC,IAAI,EAAE,CAAC;YACnB,KAAK,WAAW;gBACd,OAAO,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;gBAChC,MAAM;YACR,KAAK,eAAe;gBAClB,OAAO,CAAC,GAAG,CAAC,gBAAgB,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;gBAC1C,MAAM;YACR,KAAK,QAAQ;gBACX,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;gBACxC,MAAM;YACR,KAAK,UAAU;gBACb,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;gBAC/B,MAAM;QACV,CAAC;IACH,CAAC;AACH,CAAC;AAED,mDAAmD;AACnD,KAAK,UAAU,uBAAuB;IACpC,MAAM,MAAM,GAAG,IAAI,iBAAiB,CAAC;QACnC,OAAO,EAAE,mDAAmD;QAC5D,sBAAsB,EAAE,GAAG,EAAE,oCAAoC;KAClE,CAAC,CAAC;IAEH,qBAAqB;IACrB,MAAM,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,4BAA4B,CAAC,CAAC;IAE7D,sEAAsE;IACtE,2DAA2D;IAC3D,MAAM,gBAAgB,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC;QACxD,IAAI,EAAE,eAAe;KACtB,CAAC,CAAC;IACH,OAAO,CAAC,GAAG,CAAC,gBAAgB,EAAE,gBAAgB,CAAC,CAAC;IAEhD,MAAM,UAAU,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC;QAClD,IAAI,EAAE,QAAQ;QACd,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,OAAO,EAAE,gBAAgB,EAAE,mBAAmB,EAAE,CAAC;QACvE,cAAc,EAAE;YACd,SAAS,EAAE,aAAa;YACxB,WAAW,EAAE,SAAS;SACvB;KACF,CAAC,CAAC;IACH,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,UAAU,CAAC,CAAC;IAExC,yDAAyD;IACzD,gEAAgE;AAClE,CAAC;AAED,oCAAoC;AACpC,KAAK,UAAU,aAAa;IAC1B,MAAM,MAAM,GAAG,IAAI,iBAAiB,CAAC;QACnC,OAAO,EAAE,mDAAmD;KAC7D,CAAC,CAAC;IAEH,qBAAqB;IACrB,MAAM,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,4BAA4B,CAAC,CAAC;IAE7D,0EAA0E;IAC1E,MAAM,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC;QACvB,MAAM,EAAE,6EAA6E;QACrF,IAAI,EAAE,QAAQ;QACd,cAAc,EAAE;YACd,SAAS,EAAE,aAAa;YACxB,WAAW,EAAE,SAAS;SACvB;KACF,CAAC,CAAC;IAEH,8DAA8D;IAC9D,MAAM,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC;QACvB,MAAM,EAAE,uBAAuB;QAC/B,IAAI,EAAE,SAAS;QACf,cAAc,EAAE;YACd,SAAS,EAAE,aAAa;YACxB,WAAW,EAAE,SAAS;SACvB;KACF,CAAC,CAAC;IAEH,qEAAqE;IACrE,MAAM,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC;QACvB,MAAM,EAAE,6BAA6B;QACrC,IAAI,EAAE,QAAQ;QACd,QAAQ,EAAE,IAAI;KACf,CAAC,CAAC;AACL,CAAC;AAED,OAAO,EAAE,YAAY,EAAE,gBAAgB,EAAE,uBAAuB,EAAE,aAAa,EAAE,CAAC"}
+{"version":3,"file":"basic-usage.js","sourceRoot":"","sources":["../../src/examples/basic-usage.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAEjD,6CAA6C;AAC7C,KAAK,UAAU,YAAY;IACzB,MAAM,MAAM,GAAG,IAAI,iBAAiB,CAAC;QACnC,OAAO,EAAE,mDAAmD;KAC7D,CAAC,CAAC;IAEH,gFAAgF;IAChF,MAAM,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,4BAA4B,CAAC,CAAC;IAE7D,sBAAsB;IACtB,MAAM,eAAe,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC;QACxD,KAAK,EAAE,EAAE;KACV,CAAC,CAAC;IACH,OAAO,CAAC,GAAG,CAAC,kBAAkB,EAAE,eAAe,CAAC,KAAK,CAAC,CAAC;IAEvD,yDAAyD;IACzD,MAAM,YAAY,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC;QAC5C,OAAO,EAAE;YACP;gBACE,MAAM,EAAE,6BAA6B;gBACrC,IAAI,EAAE,QAAQ;gBACd,cAAc,EAAE;oBACd,SAAS,EAAE,aAAa;oBACxB,WAAW,EAAE,SAAS;iBACvB;aACF;SACF;KACF,CAAC,CAAC;IACH,OAAO,CAAC,GAAG,CAAC,kBAAkB,EAAE,YAAY,CAAC,QAAQ,CAAC,CAAC;AACzD,CAAC;AAED,iCAAiC;AACjC,KAAK,UAAU,gBAAgB;IAC7B,MAAM,MAAM,GAAG,IAAI,iBAAiB,CAAC;QACnC,OAAO,EAAE,mDAAmD;KAC7D,CAAC,CAAC;IAEH,qBAAqB;IACrB,MAAM,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,4BAA4B,CAAC,CAAC;IAE7D,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC;QAC1C;YACE,IAAI,EAAE,eAAe;SACtB;QACD;YACE,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE;gBACN,EAAE,SAAS,EAAE,OAAO,EAAE,gBAAgB,EAAE,mBAAmB,EAAE;gBAC7D,EAAE,SAAS,EAAE,SAAS,EAAE,gBAAgB,EAAE,iBAAiB,EAAE;aAC9D;YACD,cAAc,EAAE;gBACd,SAAS,EAAE,aAAa;gBACxB,WAAW,EAAE,SAAS;aACvB;SACF;KACF,CAAC,CAAC;IAEH,IAAI,KAAK,EAAE,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;QACjC,QAAQ,KAAK,CAAC,IAAI,EAAE,CAAC;YACnB,KAAK,WAAW;gBACd,OAAO,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;gBAChC,MAAM;YACR,KAAK,eAAe;gBAClB,OAAO,CAAC,GAAG,CAAC,gBAAgB,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;gBAC1C,MAAM;YACR,KAAK,QAAQ;gBACX,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;gBACxC,MAAM;YACR,KAAK,UAAU;gBACb,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;gBAC/B,MAAM;QACV,CAAC;IACH,CAAC;AACH,CAAC;AAED,mDAAmD;AACnD,KAAK,UAAU,uBAAuB;IACpC,MAAM,MAAM,GAAG,IAAI,iBAAiB,CAAC;QACnC,OAAO,EAAE,mDAAmD;QAC5D,sBAAsB,EAAE,GAAG,EAAE,oCAAoC;KAClE,CAAC,CAAC;IAEH,qBAAqB;IACrB,MAAM,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,4BAA4B,CAAC,CAAC;IAE7D,sEAAsE;IACtE,2DAA2D;IAC3D,MAAM,gBAAgB,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC;QACxD,IAAI,EAAE,eAAe;KACtB,CAAC,CAAC;IACH,OAAO,CAAC,GAAG,CAAC,gBAAgB,EAAE,gBAAgB,CAAC,CAAC;IAEhD,MAAM,UAAU,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC;QAClD,IAAI,EAAE,QAAQ;QACd,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,OAAO,EAAE,gBAAgB,EAAE,mBAAmB,EAAE,CAAC;QACvE,cAAc,EAAE;YACd,SAAS,EAAE,aAAa;YACxB,WAAW,EAAE,SAAS;SACvB;KACF,CAAC,CAAC;IACH,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,UAAU,CAAC,CAAC;IAExC,yDAAyD;IACzD,gEAAgE;AAClE,CAAC;AAED,oCAAoC;AACpC,KAAK,UAAU,aAAa;IAC1B,MAAM,MAAM,GAAG,IAAI,iBAAiB,CAAC;QACnC,OAAO,EAAE,mDAAmD;KAC7D,CAAC,CAAC;IAEH,qBAAqB;IACrB,MAAM,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,4BAA4B,CAAC,CAAC;IAE7D,kCAAkC;IAClC,MAAM,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC;QACvB,OAAO,EAAE;YACP,gEAAgE;YAChE;gBACE,MAAM,EAAE,6EAA6E;gBACrF,IAAI,EAAE,QAAQ;gBACd,cAAc,EAAE;oBACd,SAAS,EAAE,aAAa;oBACxB,WAAW,EAAE,SAAS;iBACvB;aACF;YACD,qDAAqD;YACrD;gBACE,MAAM,EAAE,uBAAuB;gBAC/B,IAAI,EAAE,SAAS;gBACf,cAAc,EAAE;oBACd,SAAS,EAAE,aAAa;oBACxB,WAAW,EAAE,SAAS;iBACvB;aACF;YACD,4DAA4D;YAC5D;gBACE,MAAM,EAAE,6BAA6B;gBACrC,IAAI,EAAE,QAAQ;gBACd,QAAQ,EAAE,IAAI;aACf;SACF;KACF,CAAC,CAAC;AACL,CAAC;AAED,6CAA6C;AAC7C,KAAK,UAAU,oBAAoB;IACjC,MAAM,MAAM,GAAG,IAAI,iBAAiB,CAAC;QACnC,OAAO,EAAE,mDAAmD;QAC5D,kBAAkB,EAAE,GAAG,EAAE,oCAAoC;KAC9D,CAAC,CAAC;IAEH,qBAAqB;IACrB,MAAM,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,4BAA4B,CAAC,CAAC;IAE7D,wEAAwE;IACxE,gDAAgD;IAChD,MAAM,SAAS,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC;QAC7C,MAAM,EAAE,6EAA6E;QACrF,IAAI,EAAE,QAAQ;QACd,cAAc,EAAE;YACd,SAAS,EAAE,aAAa;YACxB,WAAW,EAAE,SAAS;SACvB;KACF,CAAC,CAAC;IAEH,MAAM,SAAS,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC;QAC7C,MAAM,EAAE,uBAAuB;QAC/B,IAAI,EAAE,SAAS;QACf,cAAc,EAAE;YACd,SAAS,EAAE,aAAa;YACxB,WAAW,EAAE,SAAS;SACvB;KACF,CAAC,CAAC;IAEH,2DAA2D;IAC3D,yDAAyD;IACzD,OAAO,CAAC,GAAG,CAAC,oBAAoB,EAAE,SAAS,CAAC,QAAQ,CAAC,CAAC;IACtD,OAAO,CAAC,GAAG,CAAC,oBAAoB,EAAE,SAAS,CAAC,QAAQ,CAAC,CAAC;AACxD,CAAC;AAED,OAAO,EAAE,YAAY,EAAE,gBAAgB,EAAE,uBAAuB,EAAE,aAAa,EAAE,oBAAoB,EAAE,CAAC"}