@startsimpli/funnels 0.1.3 → 0.1.5

package/dist/client-3ESO2NHy.d.ts

@@ -1,310 +0,0 @@
-import { i as Funnel, C as CreateFunnelInput, U as UpdateFunnelInput, a as CreateStageInput, m as FunnelStage, p as UpdateStageInput, k as FunnelRun, j as FunnelResult } from './index-BGDEXbuz.js';
-
-/**
- * ApiAdapter Interface
- *
- * Generic HTTP adapter for flexible API integration.
- * Consumers can provide their own implementation to handle:
- * - Custom authentication (JWT, API keys, OAuth)
- * - Custom headers (tenant IDs, correlation IDs)
- * - Custom error handling
- * - Request/response transformation
- *
- * @packageDocumentation
- */
-/**
- * Generic API adapter interface
- *
- * Allows applications to inject their own HTTP client
- * with custom auth, headers, error handling, etc.
- */
-interface ApiAdapter {
-    /**
-     * HTTP GET request
-     *
-     * @param url - Full or relative URL to fetch
-     * @param params - Optional query parameters
-     * @returns Parsed response data
-     * @throws ApiError on HTTP error or network failure
-     */
-    get<T>(url: string, params?: Record<string, any>): Promise<T>;
-    /**
-     * HTTP POST request
-     *
-     * @param url - Full or relative URL
-     * @param data - Request body (will be JSON serialized)
-     * @returns Parsed response data
-     * @throws ApiError on HTTP error or network failure
-     */
-    post<T>(url: string, data: any): Promise<T>;
-    /**
-     * HTTP PATCH request
-     *
-     * @param url - Full or relative URL
-     * @param data - Request body (will be JSON serialized)
-     * @returns Parsed response data
-     * @throws ApiError on HTTP error or network failure
-     */
-    patch<T>(url: string, data: any): Promise<T>;
-    /**
-     * HTTP DELETE request
-     *
-     * @param url - Full or relative URL
-     * @returns Parsed response data (often empty)
-     * @throws ApiError on HTTP error or network failure
-     */
-    delete<T>(url: string): Promise<T>;
-}
-/**
- * Standard API error structure
- */
-interface ApiError extends Error {
-    /** HTTP status code (404, 500, etc) */
-    status?: number;
-    /** Error code from API */
-    code?: string;
-    /** Response body (if available) */
-    response?: any;
-    /** Original error (network, parse, etc) */
-    cause?: Error;
-}
-/**
- * Create ApiError from response
- */
-declare function createApiError(message: string, status?: number, response?: any, cause?: Error): ApiError;
-/**
- * Type guard for ApiError
- */
-declare function isApiError(error: unknown): error is ApiError;
-
-/**
- * FunnelApiClient - Generic API client for funnel operations
- *
- * Adapter-based client that works with any HTTP implementation.
- * Consumers inject their own ApiAdapter for custom auth, headers, error handling.
- *
- * @packageDocumentation
- */
-
-/**
- * List filters for funnels
- */
-interface FunnelListFilters {
-    /** Filter by status */
-    status?: 'draft' | 'active' | 'paused' | 'archived';
-    /** Filter by input type */
-    input_type?: string;
-    /** Filter by owner */
-    owner_id?: string;
-    /** Filter by team */
-    team_id?: string;
-    /** Search by name */
-    search?: string;
-    /** Pagination: page number (1-indexed) */
-    page?: number;
-    /** Pagination: page size */
-    page_size?: number;
-    /** Ordering: field name (prefix with - for descending) */
-    ordering?: string;
-}
-/**
- * List response with pagination
- */
-interface PaginatedResponse<T> {
-    count: number;
-    next: string | null;
-    previous: string | null;
-    results: T[];
-}
-/**
- * Preview result (client-side evaluation)
- */
-interface PreviewResult<TEntity = any> {
-    /** Sample entities that would match */
-    matched_entities: TEntity[];
-    /** Sample entities that would be excluded */
-    excluded_entities: TEntity[];
-    /** Stage-by-stage breakdown */
-    stage_breakdown: {
-        stage_id: string;
-        stage_name: string;
-        input_count: number;
-        matched_count: number;
-        excluded_count: number;
-    }[];
-    /** Total counts */
-    total_input: number;
-    total_matched: number;
-    total_excluded: number;
-}
-/**
- * Generic API client for funnel operations
- *
- * Usage:
- * ```ts
- * const adapter = new FetchAdapter({ headers: { 'Authorization': 'Bearer token' } });
- * const client = new FunnelApiClient(adapter, 'https://api.example.com');
- *
- * const funnels = await client.listFunnels({ status: 'active' });
- * const funnel = await client.getFunnel('funnel-123');
- * const run = await client.runFunnel('funnel-123');
- * ```
- */
-declare class FunnelApiClient {
-    private adapter;
-    private baseUrl;
-    constructor(adapter: ApiAdapter, baseUrl: string);
-    /**
-     * Build full URL for endpoint
-     */
-    private url;
-    /**
-     * List funnels with optional filters
-     *
-     * @param filters - Optional filters (status, owner, pagination, etc)
-     * @returns Paginated list of funnels
-     */
-    listFunnels<TEntity = any>(filters?: FunnelListFilters): Promise<PaginatedResponse<Funnel<TEntity>>>;
-    /**
-     * Get single funnel by ID
-     *
-     * @param id - Funnel ID
-     * @returns Funnel detail
-     * @throws ApiError with status 404 if not found
-     */
-    getFunnel<TEntity = any>(id: string): Promise<Funnel<TEntity>>;
-    /**
-     * Create new funnel
-     *
-     * @param data - Funnel creation data
-     * @returns Created funnel
-     * @throws ApiError with status 400 if validation fails
-     */
-    createFunnel<TEntity = any>(data: CreateFunnelInput<TEntity>): Promise<Funnel<TEntity>>;
-    /**
-     * Update existing funnel
-     *
-     * @param id - Funnel ID
-     * @param data - Funnel update data
-     * @returns Updated funnel
-     * @throws ApiError with status 404 if not found, 400 if validation fails
-     */
-    updateFunnel<TEntity = any>(id: string, data: Partial<UpdateFunnelInput<TEntity>>): Promise<Funnel<TEntity>>;
-    /**
-     * Delete funnel
-     *
-     * @param id - Funnel ID
-     * @throws ApiError with status 404 if not found
-     */
-    deleteFunnel(id: string): Promise<void>;
-    /**
-     * Create stage in funnel
-     *
-     * @param funnelId - Funnel ID
-     * @param data - Stage creation data
-     * @returns Created stage
-     * @throws ApiError with status 404 if funnel not found, 400 if validation fails
-     */
-    createStage<TEntity = any>(funnelId: string, data: CreateStageInput<TEntity>): Promise<FunnelStage<TEntity>>;
-    /**
-     * Update stage
-     *
-     * @param funnelId - Funnel ID
-     * @param stageId - Stage ID
-     * @param data - Stage update data
-     * @returns Updated stage
-     * @throws ApiError with status 404 if not found, 400 if validation fails
-     */
-    updateStage<TEntity = any>(funnelId: string, stageId: string, data: Partial<UpdateStageInput<TEntity>>): Promise<FunnelStage<TEntity>>;
-    /**
-     * Delete stage
-     *
-     * @param funnelId - Funnel ID
-     * @param stageId - Stage ID
-     * @throws ApiError with status 404 if not found
-     */
-    deleteStage(funnelId: string, stageId: string): Promise<void>;
-    /**
-     * Trigger funnel run
-     *
-     * @param funnelId - Funnel ID
-     * @param options - Optional run configuration (trigger_type, metadata, etc)
-     * @returns Created funnel run (status: pending or running)
-     * @throws ApiError with status 404 if funnel not found, 400 if validation fails
-     */
-    runFunnel(funnelId: string, options?: {
-        trigger_type?: 'manual' | 'scheduled' | 'webhook' | 'api';
-        metadata?: Record<string, any>;
-    }): Promise<FunnelRun>;
-    /**
-     * Get funnel run history
-     *
-     * @param funnelId - Funnel ID
-     * @param filters - Optional filters (status, pagination, etc)
-     * @returns List of funnel runs
-     * @throws ApiError with status 404 if funnel not found
-     */
-    getFunnelRuns(funnelId: string, filters?: {
-        status?: 'pending' | 'running' | 'completed' | 'failed' | 'cancelled';
-        page?: number;
-        page_size?: number;
-        ordering?: string;
-    }): Promise<PaginatedResponse<FunnelRun>>;
-    /**
-     * Get single run detail
-     *
-     * @param runId - Run ID
-     * @returns Funnel run detail
-     * @throws ApiError with status 404 if not found
-     */
-    getFunnelRun(runId: string): Promise<FunnelRun>;
-    /**
-     * Get run results (entities that were processed)
-     *
-     * @param runId - Run ID
-     * @param filters - Optional filters (matched, pagination, etc)
-     * @returns Paginated list of results
-     * @throws ApiError with status 404 if run not found
-     */
-    getFunnelResults<TEntity = any>(runId: string, filters?: {
-        matched?: boolean;
-        page?: number;
-        page_size?: number;
-    }): Promise<PaginatedResponse<FunnelResult<TEntity>>>;
-    /**
-     * Cancel running funnel
-     *
-     * @param runId - Run ID
-     * @returns Updated run with status 'cancelled'
-     * @throws ApiError with status 404 if not found, 400 if already completed
-     */
-    cancelFunnelRun(runId: string): Promise<FunnelRun>;
-    /**
-     * Preview funnel with sample entities (client-side evaluation)
-     *
-     * Useful for testing funnel logic before running on full dataset.
-     * Does NOT hit the server - evaluates locally.
-     *
-     * Note: This requires the evaluation engine to be available client-side.
-     * If not available, this will throw an error.
-     *
-     * @param funnel - Funnel definition
-     * @param sampleEntities - Sample entities to test
-     * @returns Preview results showing which entities would match/exclude
-     */
-    previewFunnel<TEntity = any>(funnel: Funnel<TEntity>, sampleEntities: TEntity[]): Promise<PreviewResult<TEntity>>;
-    /**
-     * Server-side preview (recommended)
-     *
-     * Send sample entities to server for evaluation.
-     * Useful for testing funnel logic before running on full dataset.
-     *
-     * @param funnelId - Funnel ID
-     * @param sampleEntities - Sample entities to test
-     * @returns Preview results
-     * @throws ApiError with status 404 if funnel not found
-     */
-    previewFunnelServer<TEntity = any>(funnelId: string, sampleEntities: TEntity[]): Promise<PreviewResult<TEntity>>;
-}
-
-export { type ApiAdapter as A, FunnelApiClient as F, type PaginatedResponse as P, type ApiError as a, type FunnelListFilters as b, createApiError as c, isApiError as i };

package/dist/client-CZu03ACp.d.cts

@@ -1,310 +0,0 @@
-import { i as Funnel, C as CreateFunnelInput, U as UpdateFunnelInput, a as CreateStageInput, m as FunnelStage, p as UpdateStageInput, k as FunnelRun, j as FunnelResult } from './index-BGDEXbuz.cjs';
-
-/**
- * ApiAdapter Interface
- *
- * Generic HTTP adapter for flexible API integration.
- * Consumers can provide their own implementation to handle:
- * - Custom authentication (JWT, API keys, OAuth)
- * - Custom headers (tenant IDs, correlation IDs)
- * - Custom error handling
- * - Request/response transformation
- *
- * @packageDocumentation
- */
-/**
- * Generic API adapter interface
- *
- * Allows applications to inject their own HTTP client
- * with custom auth, headers, error handling, etc.
- */
-interface ApiAdapter {
-    /**
-     * HTTP GET request
-     *
-     * @param url - Full or relative URL to fetch
-     * @param params - Optional query parameters
-     * @returns Parsed response data
-     * @throws ApiError on HTTP error or network failure
-     */
-    get<T>(url: string, params?: Record<string, any>): Promise<T>;
-    /**
-     * HTTP POST request
-     *
-     * @param url - Full or relative URL
-     * @param data - Request body (will be JSON serialized)
-     * @returns Parsed response data
-     * @throws ApiError on HTTP error or network failure
-     */
-    post<T>(url: string, data: any): Promise<T>;
-    /**
-     * HTTP PATCH request
-     *
-     * @param url - Full or relative URL
-     * @param data - Request body (will be JSON serialized)
-     * @returns Parsed response data
-     * @throws ApiError on HTTP error or network failure
-     */
-    patch<T>(url: string, data: any): Promise<T>;
-    /**
-     * HTTP DELETE request
-     *
-     * @param url - Full or relative URL
-     * @returns Parsed response data (often empty)
-     * @throws ApiError on HTTP error or network failure
-     */
-    delete<T>(url: string): Promise<T>;
-}
-/**
- * Standard API error structure
- */
-interface ApiError extends Error {
-    /** HTTP status code (404, 500, etc) */
-    status?: number;
-    /** Error code from API */
-    code?: string;
-    /** Response body (if available) */
-    response?: any;
-    /** Original error (network, parse, etc) */
-    cause?: Error;
-}
-/**
- * Create ApiError from response
- */
-declare function createApiError(message: string, status?: number, response?: any, cause?: Error): ApiError;
-/**
- * Type guard for ApiError
- */
-declare function isApiError(error: unknown): error is ApiError;
-
-/**
- * FunnelApiClient - Generic API client for funnel operations
- *
- * Adapter-based client that works with any HTTP implementation.
- * Consumers inject their own ApiAdapter for custom auth, headers, error handling.
- *
- * @packageDocumentation
- */
-
-/**
- * List filters for funnels
- */
-interface FunnelListFilters {
-    /** Filter by status */
-    status?: 'draft' | 'active' | 'paused' | 'archived';
-    /** Filter by input type */
-    input_type?: string;
-    /** Filter by owner */
-    owner_id?: string;
-    /** Filter by team */
-    team_id?: string;
-    /** Search by name */
-    search?: string;
-    /** Pagination: page number (1-indexed) */
-    page?: number;
-    /** Pagination: page size */
-    page_size?: number;
-    /** Ordering: field name (prefix with - for descending) */
-    ordering?: string;
-}
-/**
- * List response with pagination
- */
-interface PaginatedResponse<T> {
-    count: number;
-    next: string | null;
-    previous: string | null;
-    results: T[];
-}
-/**
- * Preview result (client-side evaluation)
- */
-interface PreviewResult<TEntity = any> {
-    /** Sample entities that would match */
-    matched_entities: TEntity[];
-    /** Sample entities that would be excluded */
-    excluded_entities: TEntity[];
-    /** Stage-by-stage breakdown */
-    stage_breakdown: {
-        stage_id: string;
-        stage_name: string;
-        input_count: number;
-        matched_count: number;
-        excluded_count: number;
-    }[];
-    /** Total counts */
-    total_input: number;
-    total_matched: number;
-    total_excluded: number;
-}
-/**
- * Generic API client for funnel operations
- *
- * Usage:
- * ```ts
- * const adapter = new FetchAdapter({ headers: { 'Authorization': 'Bearer token' } });
- * const client = new FunnelApiClient(adapter, 'https://api.example.com');
- *
- * const funnels = await client.listFunnels({ status: 'active' });
- * const funnel = await client.getFunnel('funnel-123');
- * const run = await client.runFunnel('funnel-123');
- * ```
- */
-declare class FunnelApiClient {
-    private adapter;
-    private baseUrl;
-    constructor(adapter: ApiAdapter, baseUrl: string);
-    /**
-     * Build full URL for endpoint
-     */
-    private url;
-    /**
-     * List funnels with optional filters
-     *
-     * @param filters - Optional filters (status, owner, pagination, etc)
-     * @returns Paginated list of funnels
-     */
-    listFunnels<TEntity = any>(filters?: FunnelListFilters): Promise<PaginatedResponse<Funnel<TEntity>>>;
-    /**
-     * Get single funnel by ID
-     *
-     * @param id - Funnel ID
-     * @returns Funnel detail
-     * @throws ApiError with status 404 if not found
-     */
-    getFunnel<TEntity = any>(id: string): Promise<Funnel<TEntity>>;
-    /**
-     * Create new funnel
-     *
-     * @param data - Funnel creation data
-     * @returns Created funnel
-     * @throws ApiError with status 400 if validation fails
-     */
-    createFunnel<TEntity = any>(data: CreateFunnelInput<TEntity>): Promise<Funnel<TEntity>>;
-    /**
-     * Update existing funnel
-     *
-     * @param id - Funnel ID
-     * @param data - Funnel update data
-     * @returns Updated funnel
-     * @throws ApiError with status 404 if not found, 400 if validation fails
-     */
-    updateFunnel<TEntity = any>(id: string, data: Partial<UpdateFunnelInput<TEntity>>): Promise<Funnel<TEntity>>;
-    /**
-     * Delete funnel
-     *
-     * @param id - Funnel ID
-     * @throws ApiError with status 404 if not found
-     */
-    deleteFunnel(id: string): Promise<void>;
-    /**
-     * Create stage in funnel
-     *
-     * @param funnelId - Funnel ID
-     * @param data - Stage creation data
-     * @returns Created stage
-     * @throws ApiError with status 404 if funnel not found, 400 if validation fails
-     */
-    createStage<TEntity = any>(funnelId: string, data: CreateStageInput<TEntity>): Promise<FunnelStage<TEntity>>;
-    /**
-     * Update stage
-     *
-     * @param funnelId - Funnel ID
-     * @param stageId - Stage ID
-     * @param data - Stage update data
-     * @returns Updated stage
-     * @throws ApiError with status 404 if not found, 400 if validation fails
-     */
-    updateStage<TEntity = any>(funnelId: string, stageId: string, data: Partial<UpdateStageInput<TEntity>>): Promise<FunnelStage<TEntity>>;
-    /**
-     * Delete stage
-     *
-     * @param funnelId - Funnel ID
-     * @param stageId - Stage ID
-     * @throws ApiError with status 404 if not found
-     */
-    deleteStage(funnelId: string, stageId: string): Promise<void>;
-    /**
-     * Trigger funnel run
-     *
-     * @param funnelId - Funnel ID
-     * @param options - Optional run configuration (trigger_type, metadata, etc)
-     * @returns Created funnel run (status: pending or running)
-     * @throws ApiError with status 404 if funnel not found, 400 if validation fails
-     */
-    runFunnel(funnelId: string, options?: {
-        trigger_type?: 'manual' | 'scheduled' | 'webhook' | 'api';
-        metadata?: Record<string, any>;
-    }): Promise<FunnelRun>;
-    /**
-     * Get funnel run history
-     *
-     * @param funnelId - Funnel ID
-     * @param filters - Optional filters (status, pagination, etc)
-     * @returns List of funnel runs
-     * @throws ApiError with status 404 if funnel not found
-     */
-    getFunnelRuns(funnelId: string, filters?: {
-        status?: 'pending' | 'running' | 'completed' | 'failed' | 'cancelled';
-        page?: number;
-        page_size?: number;
-        ordering?: string;
-    }): Promise<PaginatedResponse<FunnelRun>>;
-    /**
-     * Get single run detail
-     *
-     * @param runId - Run ID
-     * @returns Funnel run detail
-     * @throws ApiError with status 404 if not found
-     */
-    getFunnelRun(runId: string): Promise<FunnelRun>;
-    /**
-     * Get run results (entities that were processed)
-     *
-     * @param runId - Run ID
-     * @param filters - Optional filters (matched, pagination, etc)
-     * @returns Paginated list of results
-     * @throws ApiError with status 404 if run not found
-     */
-    getFunnelResults<TEntity = any>(runId: string, filters?: {
-        matched?: boolean;
-        page?: number;
-        page_size?: number;
-    }): Promise<PaginatedResponse<FunnelResult<TEntity>>>;
-    /**
-     * Cancel running funnel
-     *
-     * @param runId - Run ID
-     * @returns Updated run with status 'cancelled'
-     * @throws ApiError with status 404 if not found, 400 if already completed
-     */
-    cancelFunnelRun(runId: string): Promise<FunnelRun>;
-    /**
-     * Preview funnel with sample entities (client-side evaluation)
-     *
-     * Useful for testing funnel logic before running on full dataset.
-     * Does NOT hit the server - evaluates locally.
-     *
-     * Note: This requires the evaluation engine to be available client-side.
-     * If not available, this will throw an error.
-     *
-     * @param funnel - Funnel definition
-     * @param sampleEntities - Sample entities to test
-     * @returns Preview results showing which entities would match/exclude
-     */
-    previewFunnel<TEntity = any>(funnel: Funnel<TEntity>, sampleEntities: TEntity[]): Promise<PreviewResult<TEntity>>;
-    /**
-     * Server-side preview (recommended)
-     *
-     * Send sample entities to server for evaluation.
-     * Useful for testing funnel logic before running on full dataset.
-     *
-     * @param funnelId - Funnel ID
-     * @param sampleEntities - Sample entities to test
-     * @returns Preview results
-     * @throws ApiError with status 404 if funnel not found
-     */
-    previewFunnelServer<TEntity = any>(funnelId: string, sampleEntities: TEntity[]): Promise<PreviewResult<TEntity>>;
-}
-
-export { type ApiAdapter as A, FunnelApiClient as F, type PaginatedResponse as P, type ApiError as a, type FunnelListFilters as b, createApiError as c, isApiError as i };