@signaliz/sdk 1.0.1

package/dist/index.d.mts

@@ -0,0 +1,311 @@
+interface SignalizConfig {
+    /** API key (sk_...) — simplest auth method */
+    apiKey?: string;
+    /** OAuth2 client ID for M2M auth */
+    clientId?: string;
+    /** OAuth2 client secret for M2M auth */
+    clientSecret?: string;
+    /** Base URL override (defaults to https://api.signaliz.com/functions/v1) */
+    baseUrl?: string;
+    /** Request timeout in ms (default: 120_000) */
+    timeout?: number;
+    /** Max retries on 429/5xx (default: 3) */
+    maxRetries?: number;
+}
+type ErrorType = 'validation' | 'not_found' | 'rate_limited' | 'provider_error' | 'timeout' | 'auth_expired' | 'insufficient_credits' | 'unknown';
+interface SignalizErrorData {
+    code: string;
+    message: string;
+    errorType: ErrorType;
+    retryAfter?: number;
+    details?: Record<string, unknown>;
+}
+interface FindEmailParams {
+    fullName?: string;
+    firstName?: string;
+    lastName?: string;
+    companyDomain: string;
+    linkedinUrl?: string;
+    companyName?: string;
+}
+interface FindEmailResult {
+    email: string;
+    firstName?: string;
+    lastName?: string;
+    confidence: number;
+    verificationStatus: 'valid' | 'invalid' | 'catch_all' | 'unknown';
+    providerUsed: string;
+}
+interface VerifyEmailResult {
+    email: string;
+    isValid: boolean;
+    isDeliverable: boolean;
+    isCatchAll: boolean;
+    provider?: string;
+    confidenceScore: number;
+    verificationSource?: string;
+}
+interface EnrichSignalsParams {
+    companyName: string;
+    domain?: string;
+    researchPrompt?: string;
+    signalTypes?: string[];
+}
+interface Signal {
+    title: string;
+    signalType: string;
+    confidenceScore: number;
+    detectedAt: string;
+    url?: string;
+    content: string;
+}
+interface EnrichSignalsResult {
+    companyName: string;
+    signals: Signal[];
+    totalSignals: number;
+    fromCache: boolean;
+}
+interface EnrichSignalsV2Params {
+    companyName?: string;
+    domain?: string;
+    companyDomain?: string;
+    researchPrompt?: string;
+    signalTypes?: string[];
+    online?: boolean;
+    targetSignalCount?: number;
+    lookbackDays?: number;
+    model?: string;
+    enableDeepSearch?: boolean;
+    enableOutreachIntelligence?: boolean;
+    enablePredictiveIntelligence?: boolean;
+    icpId?: string;
+    cacheTtlHours?: number;
+    skipCache?: boolean;
+}
+interface SignalV2 {
+    id: string;
+    title: string;
+    type: string;
+    content: string;
+    date: string | null;
+    sourceUrl: string | null;
+    sourceType: string;
+    confidence: number | null;
+}
+interface OutreachIntelligence {
+    urgencyScore: number | null;
+    bestTiming: string | null;
+    primaryAngle: string | null;
+    ctas: {
+        soft?: string;
+        direct?: string;
+        valueFirst?: string;
+    } | null;
+    conversationStarters: string[];
+}
+interface Prediction {
+    prediction: string;
+    confidence: number;
+    targetPersona: string | null;
+    recommendedAction: string | null;
+}
+interface IntelligenceV2 {
+    executiveSummary: string | null;
+    keyThemes: string[];
+    relevanceScore: number | null;
+    outreach: OutreachIntelligence | null;
+    predictions: Prediction[];
+}
+interface EnrichSignalsV2Result {
+    success: boolean;
+    company: {
+        name: string | null;
+        domain: string | null;
+    };
+    signals: SignalV2[];
+    signalCount: number;
+    intelligence: IntelligenceV2 | null;
+    credits: {
+        charged: number;
+        billingType: string;
+        breakdown: {
+            signalCredits: number;
+            modelCostUsd: number;
+            modelCredits: number;
+            explanation: string;
+        };
+    };
+    metadata: {
+        version: string;
+        model: string;
+        online: boolean;
+        processingTimeMs: number;
+    };
+}
+interface CompanyIntelligenceParams {
+    companyName: string;
+    domain?: string;
+    websiteUrl?: string;
+    researchPrompt: string;
+}
+interface CompanyIntelligenceResult {
+    companyName: string;
+    insights: Array<{
+        title: string;
+        content: string;
+        sourceUrl?: string;
+    }>;
+    totalInsights: number;
+    creditsUsed: number;
+}
+interface CreateSystemParams {
+    name: string;
+    description?: string;
+    capabilities: string[];
+    fieldMappings?: Record<string, Record<string, string>>;
+}
+interface SystemResult {
+    id: string;
+    name: string;
+    status: string;
+    nodeCount: number;
+    createdAt: string;
+}
+interface RunSystemParams {
+    data: Record<string, unknown>[];
+    async?: boolean;
+}
+interface RunResult {
+    runId: string;
+    status: string;
+    totalRows?: number;
+    completedRows?: number;
+    creditsUsed?: number;
+}
+interface HttpRequestParams {
+    url: string;
+    method: 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
+    headers?: Record<string, string>;
+    body?: unknown;
+}
+interface HttpRequestResult {
+    statusCode: number;
+    headers: Record<string, string>;
+    body: unknown;
+}
+interface WorkspaceInfo {
+    id: string;
+    name: string;
+    creditsRemaining: number;
+    plan: string;
+}
+interface RunProgressEvent {
+    runId: string;
+    status: string;
+    completedRows: number;
+    totalRows: number;
+    creditsUsed: number;
+    errors?: string[];
+}
+interface MCPToolInfo {
+    name: string;
+    description: string;
+    category?: string;
+    costCredits?: number;
+}
+
+declare class HttpClient {
+    private baseUrl;
+    private timeout;
+    private maxRetries;
+    private apiKey?;
+    private accessToken?;
+    private clientId?;
+    private clientSecret?;
+    constructor(config: SignalizConfig);
+    request<T = any>(functionName: string, body: Record<string, unknown>, method?: 'POST' | 'GET'): Promise<T>;
+    /** Convenience wrapper for POST-based edge function calls */
+    post<T = any>(functionName: string, body: Record<string, unknown>): Promise<T>;
+    /** JSON-RPC call to the MCP server */
+    mcp<T = any>(method: string, params?: Record<string, unknown>): Promise<T>;
+    private getToken;
+}
+
+declare class Emails {
+    private client;
+    constructor(client: HttpClient);
+    /** Find and verify an email address for a person at a company */
+    find(params: FindEmailParams): Promise<FindEmailResult>;
+    /** Verify a single email address */
+    verify(email: string): Promise<VerifyEmailResult>;
+}
+
+declare class Signals {
+    private client;
+    constructor(client: HttpClient);
+    /** Enrich a company with actionable signals (V1) */
+    enrich(params: EnrichSignalsParams): Promise<EnrichSignalsResult>;
+    /** Enrich a company with actionable signals (V2 — clean response + online mode) */
+    enrichV2(params: EnrichSignalsV2Params): Promise<EnrichSignalsV2Result>;
+}
+
+declare class Systems {
+    private client;
+    constructor(client: HttpClient);
+    /** Create a new pipeline/system */
+    create(params: CreateSystemParams): Promise<SystemResult>;
+    /** Run a system with input data */
+    run(systemId: string, params: RunSystemParams): Promise<RunResult>;
+    /** Get a system by ID */
+    get(systemId: string): Promise<SystemResult>;
+    /** List all systems */
+    list(): Promise<SystemResult[]>;
+}
+
+declare class Runs {
+    private client;
+    constructor(client: HttpClient);
+    /** Get run status */
+    get(runId: string): Promise<RunResult>;
+    /** Poll until a run completes. Returns final result. */
+    waitForCompletion(runId: string, pollIntervalMs?: number): Promise<RunResult>;
+    /**
+     * Stream run progress as an async iterator.
+     * Usage: for await (const event of signaliz.runs.stream(runId)) { ... }
+     */
+    stream(runId: string, pollIntervalMs?: number): AsyncGenerator<RunProgressEvent>;
+}
+
+declare class Http {
+    private client;
+    constructor(client: HttpClient);
+    /** Proxy an HTTP request through Signaliz */
+    request(params: HttpRequestParams): Promise<HttpRequestResult>;
+}
+
+declare class SignalizError extends Error {
+    readonly code: string;
+    readonly errorType: ErrorType;
+    readonly retryAfter?: number;
+    readonly details?: Record<string, unknown>;
+    constructor(data: SignalizErrorData);
+    get isRetryable(): boolean;
+}
+
+declare class Signaliz {
+    readonly emails: Emails;
+    readonly signals: Signals;
+    readonly systems: Systems;
+    readonly runs: Runs;
+    readonly http: Http;
+    private client;
+    constructor(config: SignalizConfig);
+    /** Get current workspace info including credits */
+    getWorkspace(): Promise<WorkspaceInfo>;
+    /** List all available MCP tools */
+    listTools(): Promise<MCPToolInfo[]>;
+    /** Discover tools by natural language query */
+    discover(query: string, category?: string): Promise<MCPToolInfo[]>;
+}
+
+export { type CompanyIntelligenceParams, type CompanyIntelligenceResult, type CreateSystemParams, type EnrichSignalsParams, type EnrichSignalsResult, type ErrorType, type FindEmailParams, type FindEmailResult, type HttpRequestParams, type HttpRequestResult, type MCPToolInfo, type RunProgressEvent, type RunResult, type RunSystemParams, type Signal, Signaliz, type SignalizConfig, SignalizError, type SignalizErrorData, type SystemResult, type VerifyEmailResult, type WorkspaceInfo };

package/dist/index.d.ts

@@ -0,0 +1,311 @@
+interface SignalizConfig {
+    /** API key (sk_...) — simplest auth method */
+    apiKey?: string;
+    /** OAuth2 client ID for M2M auth */
+    clientId?: string;
+    /** OAuth2 client secret for M2M auth */
+    clientSecret?: string;
+    /** Base URL override (defaults to https://api.signaliz.com/functions/v1) */
+    baseUrl?: string;
+    /** Request timeout in ms (default: 120_000) */
+    timeout?: number;
+    /** Max retries on 429/5xx (default: 3) */
+    maxRetries?: number;
+}
+type ErrorType = 'validation' | 'not_found' | 'rate_limited' | 'provider_error' | 'timeout' | 'auth_expired' | 'insufficient_credits' | 'unknown';
+interface SignalizErrorData {
+    code: string;
+    message: string;
+    errorType: ErrorType;
+    retryAfter?: number;
+    details?: Record<string, unknown>;
+}
+interface FindEmailParams {
+    fullName?: string;
+    firstName?: string;
+    lastName?: string;
+    companyDomain: string;
+    linkedinUrl?: string;
+    companyName?: string;
+}
+interface FindEmailResult {
+    email: string;
+    firstName?: string;
+    lastName?: string;
+    confidence: number;
+    verificationStatus: 'valid' | 'invalid' | 'catch_all' | 'unknown';
+    providerUsed: string;
+}
+interface VerifyEmailResult {
+    email: string;
+    isValid: boolean;
+    isDeliverable: boolean;
+    isCatchAll: boolean;
+    provider?: string;
+    confidenceScore: number;
+    verificationSource?: string;
+}
+interface EnrichSignalsParams {
+    companyName: string;
+    domain?: string;
+    researchPrompt?: string;
+    signalTypes?: string[];
+}
+interface Signal {
+    title: string;
+    signalType: string;
+    confidenceScore: number;
+    detectedAt: string;
+    url?: string;
+    content: string;
+}
+interface EnrichSignalsResult {
+    companyName: string;
+    signals: Signal[];
+    totalSignals: number;
+    fromCache: boolean;
+}
+interface EnrichSignalsV2Params {
+    companyName?: string;
+    domain?: string;
+    companyDomain?: string;
+    researchPrompt?: string;
+    signalTypes?: string[];
+    online?: boolean;
+    targetSignalCount?: number;
+    lookbackDays?: number;
+    model?: string;
+    enableDeepSearch?: boolean;
+    enableOutreachIntelligence?: boolean;
+    enablePredictiveIntelligence?: boolean;
+    icpId?: string;
+    cacheTtlHours?: number;
+    skipCache?: boolean;
+}
+interface SignalV2 {
+    id: string;
+    title: string;
+    type: string;
+    content: string;
+    date: string | null;
+    sourceUrl: string | null;
+    sourceType: string;
+    confidence: number | null;
+}
+interface OutreachIntelligence {
+    urgencyScore: number | null;
+    bestTiming: string | null;
+    primaryAngle: string | null;
+    ctas: {
+        soft?: string;
+        direct?: string;
+        valueFirst?: string;
+    } | null;
+    conversationStarters: string[];
+}
+interface Prediction {
+    prediction: string;
+    confidence: number;
+    targetPersona: string | null;
+    recommendedAction: string | null;
+}
+interface IntelligenceV2 {
+    executiveSummary: string | null;
+    keyThemes: string[];
+    relevanceScore: number | null;
+    outreach: OutreachIntelligence | null;
+    predictions: Prediction[];
+}
+interface EnrichSignalsV2Result {
+    success: boolean;
+    company: {
+        name: string | null;
+        domain: string | null;
+    };
+    signals: SignalV2[];
+    signalCount: number;
+    intelligence: IntelligenceV2 | null;
+    credits: {
+        charged: number;
+        billingType: string;
+        breakdown: {
+            signalCredits: number;
+            modelCostUsd: number;
+            modelCredits: number;
+            explanation: string;
+        };
+    };
+    metadata: {
+        version: string;
+        model: string;
+        online: boolean;
+        processingTimeMs: number;
+    };
+}
+interface CompanyIntelligenceParams {
+    companyName: string;
+    domain?: string;
+    websiteUrl?: string;
+    researchPrompt: string;
+}
+interface CompanyIntelligenceResult {
+    companyName: string;
+    insights: Array<{
+        title: string;
+        content: string;
+        sourceUrl?: string;
+    }>;
+    totalInsights: number;
+    creditsUsed: number;
+}
+interface CreateSystemParams {
+    name: string;
+    description?: string;
+    capabilities: string[];
+    fieldMappings?: Record<string, Record<string, string>>;
+}
+interface SystemResult {
+    id: string;
+    name: string;
+    status: string;
+    nodeCount: number;
+    createdAt: string;
+}
+interface RunSystemParams {
+    data: Record<string, unknown>[];
+    async?: boolean;
+}
+interface RunResult {
+    runId: string;
+    status: string;
+    totalRows?: number;
+    completedRows?: number;
+    creditsUsed?: number;
+}
+interface HttpRequestParams {
+    url: string;
+    method: 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
+    headers?: Record<string, string>;
+    body?: unknown;
+}
+interface HttpRequestResult {
+    statusCode: number;
+    headers: Record<string, string>;
+    body: unknown;
+}
+interface WorkspaceInfo {
+    id: string;
+    name: string;
+    creditsRemaining: number;
+    plan: string;
+}
+interface RunProgressEvent {
+    runId: string;
+    status: string;
+    completedRows: number;
+    totalRows: number;
+    creditsUsed: number;
+    errors?: string[];
+}
+interface MCPToolInfo {
+    name: string;
+    description: string;
+    category?: string;
+    costCredits?: number;
+}
+
+declare class HttpClient {
+    private baseUrl;
+    private timeout;
+    private maxRetries;
+    private apiKey?;
+    private accessToken?;
+    private clientId?;
+    private clientSecret?;
+    constructor(config: SignalizConfig);
+    request<T = any>(functionName: string, body: Record<string, unknown>, method?: 'POST' | 'GET'): Promise<T>;
+    /** Convenience wrapper for POST-based edge function calls */
+    post<T = any>(functionName: string, body: Record<string, unknown>): Promise<T>;
+    /** JSON-RPC call to the MCP server */
+    mcp<T = any>(method: string, params?: Record<string, unknown>): Promise<T>;
+    private getToken;
+}
+
+declare class Emails {
+    private client;
+    constructor(client: HttpClient);
+    /** Find and verify an email address for a person at a company */
+    find(params: FindEmailParams): Promise<FindEmailResult>;
+    /** Verify a single email address */
+    verify(email: string): Promise<VerifyEmailResult>;
+}
+
+declare class Signals {
+    private client;
+    constructor(client: HttpClient);
+    /** Enrich a company with actionable signals (V1) */
+    enrich(params: EnrichSignalsParams): Promise<EnrichSignalsResult>;
+    /** Enrich a company with actionable signals (V2 — clean response + online mode) */
+    enrichV2(params: EnrichSignalsV2Params): Promise<EnrichSignalsV2Result>;
+}
+
+declare class Systems {
+    private client;
+    constructor(client: HttpClient);
+    /** Create a new pipeline/system */
+    create(params: CreateSystemParams): Promise<SystemResult>;
+    /** Run a system with input data */
+    run(systemId: string, params: RunSystemParams): Promise<RunResult>;
+    /** Get a system by ID */
+    get(systemId: string): Promise<SystemResult>;
+    /** List all systems */
+    list(): Promise<SystemResult[]>;
+}
+
+declare class Runs {
+    private client;
+    constructor(client: HttpClient);
+    /** Get run status */
+    get(runId: string): Promise<RunResult>;
+    /** Poll until a run completes. Returns final result. */
+    waitForCompletion(runId: string, pollIntervalMs?: number): Promise<RunResult>;
+    /**
+     * Stream run progress as an async iterator.
+     * Usage: for await (const event of signaliz.runs.stream(runId)) { ... }
+     */
+    stream(runId: string, pollIntervalMs?: number): AsyncGenerator<RunProgressEvent>;
+}
+
+declare class Http {
+    private client;
+    constructor(client: HttpClient);
+    /** Proxy an HTTP request through Signaliz */
+    request(params: HttpRequestParams): Promise<HttpRequestResult>;
+}
+
+declare class SignalizError extends Error {
+    readonly code: string;
+    readonly errorType: ErrorType;
+    readonly retryAfter?: number;
+    readonly details?: Record<string, unknown>;
+    constructor(data: SignalizErrorData);
+    get isRetryable(): boolean;
+}
+
+declare class Signaliz {
+    readonly emails: Emails;
+    readonly signals: Signals;
+    readonly systems: Systems;
+    readonly runs: Runs;
+    readonly http: Http;
+    private client;
+    constructor(config: SignalizConfig);
+    /** Get current workspace info including credits */
+    getWorkspace(): Promise<WorkspaceInfo>;
+    /** List all available MCP tools */
+    listTools(): Promise<MCPToolInfo[]>;
+    /** Discover tools by natural language query */
+    discover(query: string, category?: string): Promise<MCPToolInfo[]>;
+}
+
+export { type CompanyIntelligenceParams, type CompanyIntelligenceResult, type CreateSystemParams, type EnrichSignalsParams, type EnrichSignalsResult, type ErrorType, type FindEmailParams, type FindEmailResult, type HttpRequestParams, type HttpRequestResult, type MCPToolInfo, type RunProgressEvent, type RunResult, type RunSystemParams, type Signal, Signaliz, type SignalizConfig, SignalizError, type SignalizErrorData, type SystemResult, type VerifyEmailResult, type WorkspaceInfo };