@chat-ads/chatads-sdk 0.1.3 → 0.1.5

package/README.md

@@ -27,7 +27,6 @@ const client = new ChatAdsClient({
 const response = await client.analyze({
   message: "Looking for CRM tools for a 10-person sales team",
   ip: "8.8.8.8",
-  userAgent: "Mozilla/5.0",
 });
 
 if (response.success && response.data?.ad) {
@@ -41,15 +40,12 @@ if (response.success && response.data?.ad) {
 
 ```ts
 const result = await client.analyzeMessage("Need scheduling ideas", {
-  pageUrl: "https://acme.com/contact",
-  domain: "acme.com",
-  extraFields: {
-    formId: "lead-gen-7",
-  },
+  country: "US",
+  message_analysis: "balanced",
 });
 ```
 
-- Reserved payload keys (like `message`, `pageUrl`, etc.) cannot be overwritten inside `extraFields`; the client throws if it detects a collision.
+- Reserved payload keys (like `message`, `country`, etc.) cannot be overwritten inside `extraFields`; the client throws if it detects a collision.
 - Pass `raiseOnFailure: true` to throw `ChatAdsAPIError` when the API returns `success: false` with HTTP 200 responses.
 - Retries honor `Retry-After` headers and exponential backoff (`maxRetries` + `retryBackoffFactorMs`).
 
@@ -95,23 +91,32 @@ try {
   "success": true,
   "data": {
     "matched": true,
+    "filled": true,
     "ad": {
       "product": "CRM Pro",
       "link": "https://getchatads.com/example",
       "message": "Try CRM Pro for your sales team",
       "category": "Software"
-    }
+    },
+    "keyword": "CRM tools",
+    "intent_score": 0.85,
+    "intent_level": "high"
   },
   "error": null,
   "meta": {
     "request_id": "req_123",
+    "extraction_method": "llm",
+    "message_analysis_used": "balanced",
+    "fill_priority_used": "coverage",
+    "min_intent_used": "low",
     "processing_time_ms": 42.3,
     "usage": {
       "monthly_requests": 120,
       "free_tier_limit": 1000,
       "free_tier_remaining": 880,
       "is_free_tier": false,
-      "has_credit_card": true
+      "daily_requests": 20,
+      "daily_limit": 100
     }
   }
 }

package/dist/client.d.ts

@@ -12,7 +12,6 @@ export interface ChatAdsClientOptions {
     raiseOnFailure?: boolean;
     fetchImplementation?: FetchLike;
     logger?: Logger;
-    userAgent?: string;
 }
 export interface AnalyzeOptions {
     timeoutMs?: number;
@@ -32,7 +31,6 @@ export declare class ChatAdsClient {
     private readonly raiseOnFailure;
     private readonly fetchImpl;
     private readonly logger?;
-    private readonly userAgent?;
     constructor(options: ChatAdsClientOptions);
     analyze(payload: FunctionItemPayload, options?: AnalyzeOptions): Promise<ChatAdsResponseEnvelope>;
     analyzeMessage(message: string, extra?: AnalyzeMessageOptions, options?: AnalyzeOptions): Promise<ChatAdsResponseEnvelope>;

package/dist/client.js

@@ -4,13 +4,19 @@ const DEFAULT_ENDPOINT = "/v1/chatads/messages";
 const DEFAULT_TIMEOUT_MS = 10000;
 const DEFAULT_BACKOFF_FACTOR = 500; // ms
 const DEFAULT_RETRYABLE_STATUSES = new Set([408, 409, 425, 429, 500, 502, 503, 504]);
+/**
+ * Field aliases for normalizing optional field names.
+ * Only includes the 6 optional fields from the OpenAPI spec.
+ */
 const FIELD_ALIASES = {
-    pageurl: "pageUrl",
-    page_url: "pageUrl",
-    pagetitle: "pageTitle",
-    page_title: "pageTitle",
-    useragent: "userAgent",
-    user_agent: "userAgent",
+    messageanalysis: "message_analysis",
+    message_analysis: "message_analysis",
+    fillpriority: "fill_priority",
+    fill_priority: "fill_priority",
+    minintent: "min_intent",
+    min_intent: "min_intent",
+    skipmessageanalysis: "skip_message_analysis",
+    skip_message_analysis: "skip_message_analysis",
 };
 export class ChatAdsClient {
     constructor(options) {
@@ -30,7 +36,6 @@ export class ChatAdsClient {
             throw new ChatAdsSDKError("Global fetch implementation not found. Pass fetchImplementation explicitly or upgrade to Node 18+");
         }
         this.logger = options.logger;
-        this.userAgent = options.userAgent;
     }
     async analyze(payload, options) {
         const body = buildPayload(payload);
@@ -53,9 +58,6 @@ export class ChatAdsClient {
             "x-api-key": this.apiKey,
             ...lowercaseHeaders(options?.headers),
         };
-        if (this.userAgent) {
-            headers["user-agent"] = this.userAgent;
-        }
         let attempt = 0;
         // eslint-disable-next-line no-constant-condition
         while (true) {

package/dist/examples/basic.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/examples/basic.js

@@ -0,0 +1,22 @@
+import { ChatAdsClient } from "@chat-ads/chatads-sdk";
+async function main() {
+    const apiKey = process.env.CHATADS_API_KEY;
+    if (!apiKey) {
+        throw new Error("CHATADS_API_KEY env var is required");
+    }
+    const client = new ChatAdsClient({
+        apiKey,
+        baseUrl: process.env.CHATADS_BASE_URL ?? "https://chatads--chatads-api-fastapiserver-serve.modal.run",
+        maxRetries: 1,
+        raiseOnFailure: true,
+    });
+    const response = await client.analyze({
+        message: "A great home gym always includes a yoga mat",
+        ip: "",
+    });
+    console.log(JSON.stringify(response, null, 2));
+}
+main().catch((error) => {
+    console.error(error);
+    process.exit(1);
+});

package/dist/index.d.ts

@@ -1,4 +1,4 @@
 export { ChatAdsClient } from "./client.js";
 export { ChatAdsAPIError, ChatAdsSDKError } from "./errors.js";
 export type { ChatAdsClientOptions, AnalyzeOptions, AnalyzeMessageOptions, } from "./client.js";
-export type { ChatAdsResponseEnvelope, ChatAdsAd, ChatAdsData, ChatAdsError, ChatAdsMeta, UsageInfo, FunctionItemPayload, FunctionItemOptionalFields, } from "./models.js";
+export type { ChatAdsResponseEnvelope, ChatAdsAd, ChatAdsData, ChatAdsError, ChatAdsMeta, UsageInfo, FunctionItemPayload, FunctionItemOptionalFields, MessageAnalysis, FillPriority, MinIntent, } from "./models.js";

package/dist/models.d.ts

@@ -1,19 +1,23 @@
+export type MessageAnalysis = "fast" | "balanced" | "thorough";
+export type FillPriority = "speed" | "coverage";
+export type MinIntent = "any" | "low" | "medium" | "high";
+/**
+ * Optional fields for ChatAds API requests.
+ * Only these 6 optional fields are supported (plus required `message`).
+ */
 export type FunctionItemOptionalFields = {
-    pageUrl?: string;
-    pageTitle?: string;
-    referrer?: string;
-    address?: string;
-    email?: string;
-    type?: string;
-    domain?: string;
-    userAgent?: string;
+    /** Client IP address for geo-detection (max 64 characters) */
     ip?: string;
-    reason?: string;
-    company?: string;
-    name?: string;
+    /** ISO 3166-1 alpha-2 country code for geo-targeting */
     country?: string;
-    language?: string;
-    website?: string;
+    /** Keyword extraction method. Default: "balanced" */
+    message_analysis?: MessageAnalysis;
+    /** URL resolution fallback behavior. Default: "coverage" */
+    fill_priority?: FillPriority;
+    /** Minimum purchase intent level. Default: "low" */
+    min_intent?: MinIntent;
+    /** Skip NLP/LLM extraction and use message directly as search query. Default: false */
+    skip_message_analysis?: boolean;
 };
 export type FunctionItemPayload = {
     message: string;
@@ -27,8 +31,13 @@ export interface ChatAdsAd {
 }
 export interface ChatAdsData {
     matched: boolean;
+    filled?: boolean;
     ad?: ChatAdsAd | null;
+    keyword?: string | null;
     reason?: string | null;
+    intent_score?: number | null;
+    intent_level?: string | null;
+    min_intent_required?: string | null;
 }
 export interface ChatAdsError {
     code: string;
@@ -37,20 +46,21 @@ export interface ChatAdsError {
 }
 export interface UsageInfo {
     monthly_requests: number;
-    free_tier_limit: number;
-    free_tier_remaining: number;
+    free_tier_limit?: number | null;
+    free_tier_remaining?: number | null;
     is_free_tier: boolean;
-    has_credit_card: boolean;
     daily_requests?: number | null;
     daily_limit?: number | null;
-    minute_requests?: number | null;
-    minute_limit?: number | null;
 }
 export interface ChatAdsMeta {
     request_id: string;
     user_id?: string | null;
     country?: string | null;
     language?: string | null;
+    extraction_method?: "llm" | "nlp" | "skip" | null;
+    message_analysis_used?: "fast" | "balanced" | "thorough" | "skip" | null;
+    fill_priority_used?: "speed" | "coverage" | "skip" | null;
+    min_intent_used?: "any" | "low" | "medium" | "high" | null;
     processing_time_ms?: number | null;
     usage?: UsageInfo | null;
     [key: string]: unknown;
@@ -62,4 +72,8 @@ export interface ChatAdsResponseEnvelope {
     meta: ChatAdsMeta;
     [key: string]: unknown;
 }
+/**
+ * Reserved payload keys that cannot be used in extraFields.
+ * These are the 7 allowed request fields per the OpenAPI spec.
+ */
 export declare const RESERVED_PAYLOAD_KEYS: ReadonlySet<string>;

package/dist/models.js

@@ -1,18 +1,13 @@
+/**
+ * Reserved payload keys that cannot be used in extraFields.
+ * These are the 7 allowed request fields per the OpenAPI spec.
+ */
 export const RESERVED_PAYLOAD_KEYS = new Set([
     "message",
-    "pageUrl",
-    "pageTitle",
-    "referrer",
-    "address",
-    "email",
-    "type",
-    "domain",
-    "userAgent",
     "ip",
-    "reason",
-    "company",
-    "name",
     "country",
-    "language",
-    "website",
+    "message_analysis",
+    "fill_priority",
+    "min_intent",
+    "skip_message_analysis",
 ]);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@chat-ads/chatads-sdk",
-  "version": "0.1.3",
+  "version": "0.1.5",
   "description": "TypeScript/JavaScript client for the ChatAds prospect scoring API",
   "license": "MIT",
   "type": "module",