@embed-ai/sdk 0.1.1 → 0.1.3

package/README.md

@@ -13,6 +13,14 @@ The core TypeScript package for embed APIs, featuring an Effect-based HTTP clien
 - 📊 **Built-in logging** of failed requests and retries
 - 🎯 **Selective retry logic** for different error types
 
+## Installation
+
+```bash
+bun install @embed-ai/sdk effect
+```
+
+> **Note:** `effect` is a peer dependency and must be installed alongside `@embed-ai/sdk`
+
 ## Quick Start
 
 ### Basic Usage
@@ -264,10 +272,10 @@ function getUserFriendlyError(error: unknown): string {
 }
 ```
 
-#### 3. **Implement Fallback Strategies**
+#### 3. **Implement Cache Strategies**
 
 ```typescript
-async function getFeedWithFallback(userId: string) {
+async function getFeedWithCache(userId: string) {
   try {
     return await client.feed.byUserId(userId)
   } catch (error) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@embed-ai/sdk",
-  "version": "0.1.1",
-  "type": "module",
+  "version": "0.1.3",
+  "main": "src/index.js",
   "license": "BSD-3-Clause",
   "description": "The typescript sdk package for embed AI APIs.",
   "repository": {
@@ -9,6 +9,12 @@
     "url": "https://github.com/ZKAI-Network/embed-sdk/",
     "directory": "packages/sdk"
   },
+  "files": [
+    "src/**/*.js",
+    "src/**/*.d.ts",
+    "!src/**/*.map",
+    "!**/*.tsbuildinfo"
+  ],
   "publishConfig": {
     "access": "public",
     "directory": "dist"
@@ -24,8 +30,10 @@
     "coverage": "vitest --coverage"
   },
   "dependencies": {
-    "@embed-ai/types": "^0.1.0",
-    "effect": "latest"
+    "@embed-ai/types": "^0.1.2"
+  },
+  "peerDependencies": {
+    "effect": ">=3.0.0"
   },
   "types": "src/index.d.ts"
 }

package/src/client.d.ts

@@ -1,4 +1,5 @@
 import { FeedNamespace } from "./feed/namespace.js";
+import { SearchNamespace } from "./search/namespace.js";
 declare const NetworkError_base: new <A extends Record<string, any> = {}>(args: import("effect/Types").Equals<A, {}> extends true ? void : { readonly [P in keyof A as P extends "_tag" ? never : P]: A[P]; }) => import("effect/Cause").YieldableError & {
     readonly _tag: "NetworkError";
 } & Readonly<A>;
@@ -105,7 +106,7 @@ export interface mbdClientConfig {
     readonly retry?: RetryConfig;
 }
 /**
- * Main Embed API client providing access to personalized feeds and feed management
+ * Main Embed API client providing access to personalized feeds, feed management, and search
  *
  * @example
  * ```typescript
@@ -121,11 +122,18 @@ export interface mbdClientConfig {
  *   name: 'My Custom Feed',
  *   description: 'A feed for my app'
  * })
+ *
+ * // Search for similar users
+ * const similarUsers = await client.search.users.similar('16085')
+ *
+ * // Search users by query
+ * const users = await client.search.users.byQuery('web3 developers')
  * ```
  */
 export declare class mbdClient {
     private http;
     readonly feed: FeedNamespace;
+    readonly search: SearchNamespace;
     constructor(token?: string, options?: mbdClientConfig);
 }
 /**
@@ -151,6 +159,12 @@ export declare class mbdClient {
  *   description: 'A feed for my app'
  * })
  *
+ * // Search for similar users
+ * const similarUsers = await client.search.users.similar('16085')
+ *
+ * // Search users by query
+ * const users = await client.search.users.byQuery('web3 developers')
+ *
  * // With configuration
  * const client = getClient('your-api-key', {
  *   retry: {

package/src/client.js

@@ -3,37 +3,40 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.TimeoutError = exports.ParseError = exports.NetworkError = exports.HttpRequestError = void 0;
+exports.mbdClient = exports.TimeoutError = exports.ParseError = exports.HttpRequestError = exports.NetworkError = void 0;
 exports.getClient = getClient;
-exports.mbdClient = void 0;
-var _effect = require("effect");
-var _namespace = require("./feed/namespace.js");
+const effect_1 = /*#__PURE__*/require("effect");
+const Data = /*#__PURE__*/require("effect/Data");
+const Effect = /*#__PURE__*/require("effect/Effect");
+const Schedule = /*#__PURE__*/require("effect/Schedule");
+const namespace_js_1 = /*#__PURE__*/require("./feed/namespace.js");
+const namespace_js_2 = /*#__PURE__*/require("./search/namespace.js");
 // ============================================================================
 // ERROR TYPES
 // ============================================================================
 /**
  * Network-related errors (connection issues, DNS failures, etc.)
  */
-class NetworkError extends _effect.Data.TaggedError("NetworkError") {}
+class NetworkError extends Data.TaggedError("NetworkError") {}
+exports.NetworkError = NetworkError;
 /**
  * HTTP response errors (4xx, 5xx status codes)
  */
-exports.NetworkError = NetworkError;
-class HttpRequestError extends _effect.Data.TaggedError("HttpRequestError") {}
+class HttpRequestError extends Data.TaggedError("HttpRequestError") {}
+exports.HttpRequestError = HttpRequestError;
 /**
  * JSON parsing errors
  */
-exports.HttpRequestError = HttpRequestError;
-class ParseError extends _effect.Data.TaggedError("ParseError") {}
+class ParseError extends Data.TaggedError("ParseError") {}
+exports.ParseError = ParseError;
 /**
  * Timeout errors
  */
-exports.ParseError = ParseError;
-class TimeoutError extends _effect.Data.TaggedError("TimeoutError") {}
+class TimeoutError extends Data.TaggedError("TimeoutError") {}
+exports.TimeoutError = TimeoutError;
 /**
  * Default retry configuration
  */
-exports.TimeoutError = TimeoutError;
 const DEFAULT_RETRY_CONFIG = {
   exponentialBackoff: true,
   initialDelay: 1000,
@@ -73,7 +76,7 @@ class HttpClient {
    * Create a timeout effect that fails after the specified duration
    */
   createTimeoutEffect(timeoutMs) {
-    return (0, _effect.pipe)(_effect.Effect.sleep(`${timeoutMs} millis`), _effect.Effect.flatMap(() => _effect.Effect.fail(new TimeoutError({
+    return (0, effect_1.pipe)(Effect.sleep(`${timeoutMs} millis`), Effect.flatMap(() => Effect.fail(new TimeoutError({
       message: `Request timed out after ${timeoutMs}ms`,
       timeoutMs
     }))));
@@ -100,7 +103,7 @@ class HttpClient {
    */
   performFetch(endpoint, method, baseUrl, body, queryParams, useBasicAuth) {
     const url = this.buildUrl(endpoint, baseUrl, queryParams);
-    return _effect.Effect.tryPromise({
+    return Effect.tryPromise({
       try: async () => {
         const requestOptions = {
           method,
@@ -166,12 +169,12 @@ class HttpClient {
     } = this.config.retry;
     let baseSchedule;
     if (exponentialBackoff) {
-      baseSchedule = (0, _effect.pipe)(_effect.Schedule.exponential(`${initialDelay} millis`), _effect.Schedule.either(_effect.Schedule.spaced(`${maxDelay} millis`)), _effect.Schedule.compose(_effect.Schedule.recurs(maxRetries)));
+      baseSchedule = (0, effect_1.pipe)(Schedule.exponential(`${initialDelay} millis`), Schedule.either(Schedule.spaced(`${maxDelay} millis`)), Schedule.compose(Schedule.recurs(maxRetries)));
     } else {
-      baseSchedule = (0, _effect.pipe)(_effect.Schedule.spaced(`${initialDelay} millis`), _effect.Schedule.compose(_effect.Schedule.recurs(maxRetries)));
+      baseSchedule = (0, effect_1.pipe)(Schedule.spaced(`${initialDelay} millis`), Schedule.compose(Schedule.recurs(maxRetries)));
     }
     // Only retry on specific errors
-    return (0, _effect.pipe)(baseSchedule, _effect.Schedule.whileInput(error => {
+    return (0, effect_1.pipe)(baseSchedule, Schedule.whileInput(error => {
       switch (error._tag) {
         case "NetworkError":
           return true;
@@ -196,45 +199,45 @@ class HttpClient {
     const fetchEffect = this.performFetch(endpoint, method, baseUrl, body, queryParams, useBasicAuth);
     const timeoutEffect = this.createTimeoutEffect(this.config.retry.timeoutMs);
     // Race fetch against timeout
-    const requestWithTimeout = _effect.Effect.race(fetchEffect, timeoutEffect);
+    const requestWithTimeout = Effect.race(fetchEffect, timeoutEffect);
     // Apply retry logic
     const retrySchedule = this.createRetrySchedule();
-    return (0, _effect.pipe)(requestWithTimeout, _effect.Effect.retry(retrySchedule), _effect.Effect.tapError(error => _effect.Effect.logError("HTTP request failed after retries", error)));
+    return (0, effect_1.pipe)(requestWithTimeout, Effect.retry(retrySchedule), Effect.tapError(error => Effect.logError("HTTP request failed after retries", error)));
   }
   /**
    * Make a POST request to the API with Effect-based error handling and retries
    */
   async post(endpoint, body) {
     const effect = this.executeRequestWithRetries(endpoint, "POST", undefined, body);
-    return _effect.Effect.runPromise(effect);
+    return Effect.runPromise(effect);
   }
   /**
    * Make a GET request to the API with Effect-based error handling and retries
    */
   async get(endpoint, queryParams) {
     const effect = this.executeRequestWithRetries(endpoint, "GET", undefined, undefined, queryParams);
-    return _effect.Effect.runPromise(effect);
+    return Effect.runPromise(effect);
   }
   /**
    * Make a PATCH request to the API with Effect-based error handling and retries
    */
   async patch(endpoint, body) {
     const effect = this.executeRequestWithRetries(endpoint, "PATCH", undefined, body);
-    return _effect.Effect.runPromise(effect);
+    return Effect.runPromise(effect);
   }
   /**
    * Make a request to a custom base URL
    */
   async requestWithCustomBaseUrl(method, baseUrl, endpoint, body, queryParams, useBasicAuth) {
     const effect = this.executeRequestWithRetries(endpoint, method, baseUrl, body, queryParams, useBasicAuth);
-    return _effect.Effect.runPromise(effect);
+    return Effect.runPromise(effect);
   }
 }
 // ============================================================================
 // MAIN CLIENT
 // ============================================================================
 /**
- * Main Embed API client providing access to personalized feeds and feed management
+ * Main Embed API client providing access to personalized feeds, feed management, and search
  *
  * @example
  * ```typescript
@@ -250,11 +253,18 @@ class HttpClient {
  *   name: 'My Custom Feed',
  *   description: 'A feed for my app'
  * })
+ *
+ * // Search for similar users
+ * const similarUsers = await client.search.users.similar('16085')
+ *
+ * // Search users by query
+ * const users = await client.search.users.byQuery('web3 developers')
  * ```
  */
 class mbdClient {
   http;
   feed;
+  search;
   constructor(token, options) {
     if (!token && !options?.token) {
       throw new Error("Token is required");
@@ -264,9 +274,11 @@ class mbdClient {
       ...options
     };
     this.http = new HttpClient(config);
-    this.feed = new _namespace.FeedNamespace(this.http);
+    this.feed = new namespace_js_1.FeedNamespace(this.http);
+    this.search = new namespace_js_2.SearchNamespace(this.http);
   }
 }
+exports.mbdClient = mbdClient;
 /**
  * Get a new Embed Client instance
  *
@@ -290,6 +302,12 @@ class mbdClient {
  *   description: 'A feed for my app'
  * })
  *
+ * // Search for similar users
+ * const similarUsers = await client.search.users.similar('16085')
+ *
+ * // Search users by query
+ * const users = await client.search.users.byQuery('web3 developers')
+ *
  * // With configuration
  * const client = getClient('your-api-key', {
  *   retry: {
@@ -299,7 +317,6 @@ class mbdClient {
  * })
  * ```
  */
-exports.mbdClient = mbdClient;
 function getClient(token, options) {
   return new mbdClient(token, options);
 }

package/src/feed/feed.d.ts

@@ -1,6 +1,6 @@
 import type { ForYou as ForYouParams, ForYouResponse } from "@embed-ai/types";
 import type { IHttpClient } from "../interfaces/index.js";
-export type FeedOptions = Omit<ForYouParams, "wallet_address" | "user_id">;
-export declare function byUserId(httpClient: IHttpClient, userId: string, options?: FeedOptions): Promise<ForYouResponse>;
-export declare function byWalletAddress(httpClient: IHttpClient, walletAddress: string, options?: FeedOptions): Promise<ForYouResponse>;
+export type FeedOptions = Omit<ForYouParams, "wallet_address" | "user_id" | "feed_id">;
+export declare function byUserId(httpClient: IHttpClient, userId: string, feedId?: string, options?: FeedOptions): Promise<ForYouResponse>;
+export declare function byWalletAddress(httpClient: IHttpClient, walletAddress: string, feedId?: string, options?: FeedOptions): Promise<ForYouResponse>;
 //# sourceMappingURL=feed.d.ts.map

package/src/feed/feed.js

@@ -5,7 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.byUserId = byUserId;
 exports.byWalletAddress = byWalletAddress;
-async function byUserId(httpClient, userId, options) {
+async function byUserId(httpClient, userId, feedId, options) {
   const top_k = options?.top_k ?? 25;
   const impression_count = options?.impression_count ?? top_k;
   const params = {
@@ -13,12 +13,13 @@ async function byUserId(httpClient, userId, options) {
     return_metadata: true,
     top_k,
     impression_count,
+    feed_id: feedId,
     ...options
   };
   const response = await httpClient.post("/v2/farcaster/casts/feed/for-you", params);
   return [...response.body];
 }
-async function byWalletAddress(httpClient, walletAddress, options) {
+async function byWalletAddress(httpClient, walletAddress, feedId, options) {
   const top_k = options?.top_k ?? 25;
   const impression_count = options?.impression_count ?? top_k;
   const params = {
@@ -26,6 +27,7 @@ async function byWalletAddress(httpClient, walletAddress, options) {
     return_metadata: true,
     top_k,
     impression_count,
+    feed_id: feedId,
     ...options
   };
   const response = await httpClient.post("/v2/farcaster/casts/feed/for-you", params);

package/src/feed/index.js

@@ -1,39 +1,28 @@
 "use strict";
 
+var __createBinding = void 0 && (void 0).__createBinding || (Object.create ? function (o, m, k, k2) {
+  if (k2 === undefined) k2 = k;
+  var desc = Object.getOwnPropertyDescriptor(m, k);
+  if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+    desc = {
+      enumerable: true,
+      get: function () {
+        return m[k];
+      }
+    };
+  }
+  Object.defineProperty(o, k2, desc);
+} : function (o, m, k, k2) {
+  if (k2 === undefined) k2 = k;
+  o[k2] = m[k];
+});
+var __exportStar = void 0 && (void 0).__exportStar || function (m, exports) {
+  for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-var _feed = require("./feed.js");
-Object.keys(_feed).forEach(function (key) {
-  if (key === "default" || key === "__esModule") return;
-  if (key in exports && exports[key] === _feed[key]) return;
-  Object.defineProperty(exports, key, {
-    enumerable: true,
-    get: function () {
-      return _feed[key];
-    }
-  });
-});
-var _management = require("./management.js");
-Object.keys(_management).forEach(function (key) {
-  if (key === "default" || key === "__esModule") return;
-  if (key in exports && exports[key] === _management[key]) return;
-  Object.defineProperty(exports, key, {
-    enumerable: true,
-    get: function () {
-      return _management[key];
-    }
-  });
-});
-var _namespace = require("./namespace.js");
-Object.keys(_namespace).forEach(function (key) {
-  if (key === "default" || key === "__esModule") return;
-  if (key in exports && exports[key] === _namespace[key]) return;
-  Object.defineProperty(exports, key, {
-    enumerable: true,
-    get: function () {
-      return _namespace[key];
-    }
-  });
-});
+__exportStar(require("./feed.js"), exports);
+__exportStar(require("./management.js"), exports);
+__exportStar(require("./namespace.js"), exports);
 //# sourceMappingURL=index.js.map

package/src/feed/management.d.ts

@@ -1,7 +1,8 @@
 import type { CreateFeedOptions, FeedCreateUpdateResponse, FeedGetResponse, ListFeedsResponse, UpdateFeedOptions } from "@embed-ai/types";
 import type { IHttpClient } from "../interfaces/index.js";
+export type UpdateFeedParams = Omit<UpdateFeedOptions, "config_id">;
 export declare function createConfig(httpClient: IHttpClient, options: CreateFeedOptions): Promise<FeedCreateUpdateResponse>;
-export declare function getConfig(httpClient: IHttpClient, configId: string): Promise<FeedGetResponse>;
-export declare function listConfigs(httpClient: IHttpClient, visibility?: "private" | "public"): Promise<ListFeedsResponse>;
-export declare function updateConfig(httpClient: IHttpClient, options: UpdateFeedOptions): Promise<void>;
+export declare function getConfig(httpClient: IHttpClient, feedId: string): Promise<FeedGetResponse>;
+export declare function listConfigs(httpClient: IHttpClient, visibility?: "private" | "template" | "public"): Promise<ListFeedsResponse>;
+export declare function updateConfig(httpClient: IHttpClient, feedId: string, options: UpdateFeedParams): Promise<void>;
 //# sourceMappingURL=management.d.ts.map

package/src/feed/management.js

@@ -40,9 +40,9 @@ async function createConfig(httpClient, options) {
   );
   return response.data;
 }
-async function getConfig(httpClient, configId) {
+async function getConfig(httpClient, feedId) {
   const response = await httpClient.requestWithCustomBaseUrl("GET", CONSOLE_API_BASE_URL, "/api/feed/config", undefined, {
-    config_id: configId
+    config_id: feedId
   }, true // Use Basic auth
   );
   return response.data;
@@ -55,20 +55,16 @@ async function listConfigs(httpClient, visibility = "private") {
   );
   return [...response.data];
 }
-async function updateConfig(httpClient, options) {
+async function updateConfig(httpClient, feedId, options) {
   // First get the current feed configuration
-  const currentFeed = await getConfig(httpClient, options.config_id);
-  const {
-    config_id: _config_id,
-    ...updateOptions
-  } = options;
+  const currentFeed = await getConfig(httpClient, feedId);
   // Merge the current configuration with the updates
   const updatedConfig = {
     ...currentFeed,
-    ...updateOptions,
+    ...options,
     config: {
       ...currentFeed.config,
-      ...updateOptions.config
+      ...options.config
     }
   };
   await httpClient.requestWithCustomBaseUrl("PATCH", CONSOLE_API_BASE_URL, "/api/feed/config", updatedConfig, undefined, true // Use Basic auth

package/src/feed/namespace.d.ts

@@ -1,4 +1,4 @@
-import type { CreateFeedOptions, FeedCreateUpdateResponse, FeedGetResponse, ForYouResponse, ListFeedsResponse, UpdateFeedOptions } from "@embed-ai/types";
+import type { CreateFeedOptions, FeedCreateUpdateResponse, FeedGetResponse, ForYouResponse, ListFeedsResponse } from "@embed-ai/types";
 import type { IHttpClient } from "../interfaces/index.js";
 import type { FeedOptions } from "./feed.js";
 /**
@@ -8,8 +8,8 @@ import type { FeedOptions } from "./feed.js";
  * ```typescript
  * const client = getClient('your-api-key')
  *
- * // Get personalized feed
- * const feed = await client.feed.byUserId('16085')
+ * // Get personalized feed based on the For-You template
+ * const feed = await client.feed.byUserId('16085', 'feed_390')
  *
  * // Create a custom feed
  * const customFeed = await client.feed.createConfig({
@@ -25,13 +25,14 @@ export declare class FeedNamespace {
      * Get personalized "For You" feed by user ID
      *
      * @param userId - The Farcaster user ID to get personalized feed for
+     * @param feedId - The feed ID to use for the request
      * @param options - Optional configuration for feed generation
      * @returns Promise<ForYouFeedItem[]> - Array of personalized feed items
      *
      * @example
      * ```typescript
      * const client = getClient("your-api-key")
-     * const feed = await client.feed.byUserId("16085", {
+     * const feed = await client.feed.byUserId("16085", "feed_390", {
      *   top_k: 10,
      *   return_metadata: true
      * })
@@ -39,25 +40,26 @@ export declare class FeedNamespace {
      * console.log(feed[0].metadata?.author.username) // Access author username
      * ```
      */
-    byUserId(userId: string, options?: FeedOptions): Promise<ForYouResponse>;
+    byUserId(userId: string, feedId?: string, options?: FeedOptions): Promise<ForYouResponse>;
     /**
      * Get personalized "For You" feed by wallet address
      *
      * @param walletAddress - The user's wallet address to get personalized feed for
+     * @param feedId - The feed ID to use for the request
      * @param options - Optional configuration for feed generation
      * @returns Promise<ForYouFeedItem[]> - Array of personalized feed items
      *
      * @example
      * ```typescript
      * const client = getClient("your-api-key")
-     * const feed = await client.feed.byWalletAddress("0x1234...", {
+     * const feed = await client.feed.byWalletAddress("0x1234...", "feed_390", {
      *   top_k: 15,
      * })
      * console.log(feed[0].metadata?.author.username) // Access author username
      * console.log(feed[0].score) // Access recommendation score
      * ```
      */
-    byWalletAddress(walletAddress: string, options?: FeedOptions): Promise<ForYouResponse>;
+    byWalletAddress(walletAddress: string, feedId?: string, options?: FeedOptions): Promise<ForYouResponse>;
     /**
      * Create a new feed configuration
      *
@@ -83,9 +85,9 @@ export declare class FeedNamespace {
      */
     createConfig(options: CreateFeedOptions): Promise<FeedCreateUpdateResponse>;
     /**
-     * Get a feed configuration by ID
+     * Get a feed configuration by feedId
      *
-     * @param configId - The feed configuration ID
+     * @param feedId - The feedId for which to get the configuration
      * @returns Promise<FeedConfigurationResponse> - The feed configuration details
      *
      * @example
@@ -96,11 +98,11 @@ export declare class FeedNamespace {
      * console.log(feed.config.filters) // Access feed filters
      * ```
      */
-    getConfig(configId: string): Promise<FeedGetResponse>;
+    getConfig(feedId: string): Promise<FeedGetResponse>;
     /**
      * List all feed configurations for the account
      *
-     * @param visibility - Filter by visibility (private/public), defaults to "private"
+     * @param visibility - Filter by visibility (private/template/public), defaults to "private"
      * @returns Promise<FeedConfigurationResponse[]> - Array of feed configurations
      *
      * @example
@@ -111,18 +113,18 @@ export declare class FeedNamespace {
      * feeds.forEach(feed => console.log(feed.name))
      * ```
      */
-    listConfigs(visibility?: "private" | "public"): Promise<ListFeedsResponse>;
+    listConfigs(visibility?: "private" | "template" | "public"): Promise<ListFeedsResponse>;
     /**
      * Update an existing feed configuration
      *
-     * @param options - Feed update options, must include config_id
+     * @param feedId - The feedId for which to update the configuration
+     * @param options - Feed update options
      * @returns Promise<void> - Resolves when the feed is successfully updated
      *
      * @example
      * ```typescript
      * const client = getClient("your-api-key")
-     * await client.feed.updateConfig({
-     *   config_id: "feed_123",
+     * await client.feed.updateConfig("feed_123", {
      *   name: "Updated Feed Name",
      *   config: {
      *     filters: {
@@ -133,6 +135,6 @@ export declare class FeedNamespace {
      * console.log("Feed updated successfully")
      * ```
      */
-    updateConfig(options: UpdateFeedOptions): Promise<void>;
+    updateConfig(feedId: string, options: CreateFeedOptions): Promise<void>;
 }
 //# sourceMappingURL=namespace.d.ts.map