@cobbl-ai/sdk 0.1.0 → 0.1.2

package/dist/errors-BaYZ2rGo.d.mts

@@ -0,0 +1,208 @@
+/**
+ * Type definitions for the Cobbl SDK
+ *
+ * All types are defined locally to keep the SDK self-contained.
+ * These match the API contract and are used as type hints for SDK consumers.
+ */
+/**
+ * Configuration options for the CobblClient
+ */
+interface CobblConfig {
+    /**
+     * Your Cobbl API key
+     * @required
+     */
+    apiKey: string;
+    /**
+     * Base URL for the API
+     * @optional
+     * @default 'https://api.cobbl.ai'
+     * @internal
+     * @example 'http://localhost:5001/your-project/us-central1/externalApi' // For local development
+     */
+    baseUrl?: string;
+}
+/**
+ * Whether the AI output was helpful
+ */
+type Helpful = 'helpful' | 'not_helpful';
+/**
+ * Request payload for creating feedback
+ * Supports segmented feedback submission - at least one of helpful or userFeedback required
+ */
+interface CreateFeedbackRequest {
+    runId: string;
+    helpful?: Helpful;
+    userFeedback?: string;
+}
+/**
+ * Response from creating feedback
+ */
+interface CreateFeedbackResponse {
+    id: string;
+    message: string;
+}
+/**
+ * Request payload for updating feedback
+ * At least one of helpful or userFeedback required
+ */
+interface UpdateFeedbackRequest {
+    helpful?: Helpful;
+    userFeedback?: string;
+}
+/**
+ * Response from updating feedback
+ */
+interface UpdateFeedbackResponse {
+    id: string;
+    message: string;
+}
+/**
+ * Supported LLM providers
+ */
+type Provider = 'openai' | 'anthropic' | 'google';
+/**
+ * Configuration for a variable in the prompt
+ */
+interface VariableConfig {
+    key: string;
+    type: 'string' | 'number' | 'boolean' | 'list' | 'object';
+    required: boolean;
+    description?: string;
+}
+/**
+ * Input values provided when executing a prompt
+ */
+type PromptInput = Record<string, string | number | boolean | unknown[] | Record<string, unknown>>;
+/**
+ * Token usage breakdown for a completed prompt run
+ */
+interface TokenUsage {
+    inputTokens: number;
+    outputTokens: number;
+    totalTokens: number;
+}
+/**
+ * Aggregated analytics for a prompt or prompt version
+ */
+interface PromptAggregatedAnalytics {
+    runs: {
+        totalCount: number;
+        successCount: number;
+        errorCount: number;
+        totalProviderMs: number;
+        totalRequestMs: number;
+        successRate: number;
+        errorRate: number;
+        avgProviderMs: number;
+        avgRequestMs: number;
+    };
+    feedback: {
+        totalCount: number;
+        helpfulCount: number;
+        notHelpfulCount: number;
+        helpfulRate: number;
+    };
+}
+/**
+ * Base fields shared across all prompt version sources
+ */
+interface PromptVersionBase {
+    id: string;
+    schemaVersion: number;
+    createdAt: Date;
+    updatedAt: Date;
+    tenantId: string;
+    environmentId: string;
+    promptId: string;
+    versionNumber: number;
+    template: string;
+    variables: VariableConfig[];
+    provider: Provider;
+    model: string;
+    status: 'draft' | 'active' | 'inactive';
+    parentVersionId: string | null;
+    analytics: PromptAggregatedAnalytics;
+    publishedAt: Date | null;
+}
+/**
+ * Manually created prompt version (by a user or from feedback edits)
+ */
+interface PromptVersionManual extends PromptVersionBase {
+    source: 'manual';
+    authorId: string;
+    authorName: string | null;
+}
+/**
+ * AI-generated prompt version suggestion from feedback issue assessment
+ */
+interface PromptVersionIssueLlmSuggestion extends PromptVersionBase {
+    source: 'issue_llm_suggestion';
+}
+/**
+ * Prompt version - discriminated union by source
+ */
+type PromptVersionClient = PromptVersionManual | PromptVersionIssueLlmSuggestion;
+/**
+ * Request payload for running a prompt
+ */
+interface RunPromptRequest {
+    promptSlug: string;
+    input: PromptInput;
+}
+/**
+ * Response from running a prompt
+ */
+interface RunPromptResponse {
+    runId: string;
+    output: string;
+    tokenUsage: TokenUsage;
+    renderedPrompt: string;
+    promptVersion: PromptVersionClient;
+}
+
+/**
+ * Error types that can be thrown by the Cobbl SDK
+ */
+type CobblErrorCode = 'INVALID_CONFIG' | 'INVALID_REQUEST' | 'UNAUTHORIZED' | 'FORBIDDEN' | 'NOT_FOUND' | 'ARCHIVED' | 'RATE_LIMIT_EXCEEDED' | 'SERVER_ERROR' | 'NETWORK_ERROR' | 'API_ERROR';
+/**
+ * Custom error class for Cobbl SDK errors
+ *
+ * @example
+ * ```typescript
+ * try {
+ *   await client.runPrompt('my-prompt', { topic: 'test' })
+ * } catch (error) {
+ *   if (error instanceof CobblError) {
+ *     console.error(`Error [${error.code}]: ${error.message}`)
+ *     console.error('Details:', error.details)
+ *   }
+ * }
+ * ```
+ */
+declare class CobblError extends Error {
+    /**
+     * Error code indicating the type of error
+     */
+    readonly code: CobblErrorCode;
+    /**
+     * Additional details about the error (e.g., missing variables, validation issues)
+     */
+    readonly details?: unknown;
+    constructor(message: string, code: CobblErrorCode, details?: unknown);
+    /**
+     * Check if an error is a CobblError
+     */
+    static isCobblError(error: unknown): error is CobblError;
+    /**
+     * Convert error to JSON-serializable object
+     */
+    toJSON(): {
+        name: string;
+        message: string;
+        code: CobblErrorCode;
+        details: unknown;
+    };
+}
+
+export { CobblError as C, type Helpful as H, type PromptInput as P, type RunPromptRequest as R, type TokenUsage as T, type UpdateFeedbackRequest as U, type VariableConfig as V, type CobblErrorCode as a, type CobblConfig as b, type RunPromptResponse as c, type CreateFeedbackRequest as d, type CreateFeedbackResponse as e, type UpdateFeedbackResponse as f, type PromptVersionClient as g, type Provider as h };

package/dist/errors-BaYZ2rGo.d.ts

@@ -0,0 +1,208 @@
+/**
+ * Type definitions for the Cobbl SDK
+ *
+ * All types are defined locally to keep the SDK self-contained.
+ * These match the API contract and are used as type hints for SDK consumers.
+ */
+/**
+ * Configuration options for the CobblClient
+ */
+interface CobblConfig {
+    /**
+     * Your Cobbl API key
+     * @required
+     */
+    apiKey: string;
+    /**
+     * Base URL for the API
+     * @optional
+     * @default 'https://api.cobbl.ai'
+     * @internal
+     * @example 'http://localhost:5001/your-project/us-central1/externalApi' // For local development
+     */
+    baseUrl?: string;
+}
+/**
+ * Whether the AI output was helpful
+ */
+type Helpful = 'helpful' | 'not_helpful';
+/**
+ * Request payload for creating feedback
+ * Supports segmented feedback submission - at least one of helpful or userFeedback required
+ */
+interface CreateFeedbackRequest {
+    runId: string;
+    helpful?: Helpful;
+    userFeedback?: string;
+}
+/**
+ * Response from creating feedback
+ */
+interface CreateFeedbackResponse {
+    id: string;
+    message: string;
+}
+/**
+ * Request payload for updating feedback
+ * At least one of helpful or userFeedback required
+ */
+interface UpdateFeedbackRequest {
+    helpful?: Helpful;
+    userFeedback?: string;
+}
+/**
+ * Response from updating feedback
+ */
+interface UpdateFeedbackResponse {
+    id: string;
+    message: string;
+}
+/**
+ * Supported LLM providers
+ */
+type Provider = 'openai' | 'anthropic' | 'google';
+/**
+ * Configuration for a variable in the prompt
+ */
+interface VariableConfig {
+    key: string;
+    type: 'string' | 'number' | 'boolean' | 'list' | 'object';
+    required: boolean;
+    description?: string;
+}
+/**
+ * Input values provided when executing a prompt
+ */
+type PromptInput = Record<string, string | number | boolean | unknown[] | Record<string, unknown>>;
+/**
+ * Token usage breakdown for a completed prompt run
+ */
+interface TokenUsage {
+    inputTokens: number;
+    outputTokens: number;
+    totalTokens: number;
+}
+/**
+ * Aggregated analytics for a prompt or prompt version
+ */
+interface PromptAggregatedAnalytics {
+    runs: {
+        totalCount: number;
+        successCount: number;
+        errorCount: number;
+        totalProviderMs: number;
+        totalRequestMs: number;
+        successRate: number;
+        errorRate: number;
+        avgProviderMs: number;
+        avgRequestMs: number;
+    };
+    feedback: {
+        totalCount: number;
+        helpfulCount: number;
+        notHelpfulCount: number;
+        helpfulRate: number;
+    };
+}
+/**
+ * Base fields shared across all prompt version sources
+ */
+interface PromptVersionBase {
+    id: string;
+    schemaVersion: number;
+    createdAt: Date;
+    updatedAt: Date;
+    tenantId: string;
+    environmentId: string;
+    promptId: string;
+    versionNumber: number;
+    template: string;
+    variables: VariableConfig[];
+    provider: Provider;
+    model: string;
+    status: 'draft' | 'active' | 'inactive';
+    parentVersionId: string | null;
+    analytics: PromptAggregatedAnalytics;
+    publishedAt: Date | null;
+}
+/**
+ * Manually created prompt version (by a user or from feedback edits)
+ */
+interface PromptVersionManual extends PromptVersionBase {
+    source: 'manual';
+    authorId: string;
+    authorName: string | null;
+}
+/**
+ * AI-generated prompt version suggestion from feedback issue assessment
+ */
+interface PromptVersionIssueLlmSuggestion extends PromptVersionBase {
+    source: 'issue_llm_suggestion';
+}
+/**
+ * Prompt version - discriminated union by source
+ */
+type PromptVersionClient = PromptVersionManual | PromptVersionIssueLlmSuggestion;
+/**
+ * Request payload for running a prompt
+ */
+interface RunPromptRequest {
+    promptSlug: string;
+    input: PromptInput;
+}
+/**
+ * Response from running a prompt
+ */
+interface RunPromptResponse {
+    runId: string;
+    output: string;
+    tokenUsage: TokenUsage;
+    renderedPrompt: string;
+    promptVersion: PromptVersionClient;
+}
+
+/**
+ * Error types that can be thrown by the Cobbl SDK
+ */
+type CobblErrorCode = 'INVALID_CONFIG' | 'INVALID_REQUEST' | 'UNAUTHORIZED' | 'FORBIDDEN' | 'NOT_FOUND' | 'ARCHIVED' | 'RATE_LIMIT_EXCEEDED' | 'SERVER_ERROR' | 'NETWORK_ERROR' | 'API_ERROR';
+/**
+ * Custom error class for Cobbl SDK errors
+ *
+ * @example
+ * ```typescript
+ * try {
+ *   await client.runPrompt('my-prompt', { topic: 'test' })
+ * } catch (error) {
+ *   if (error instanceof CobblError) {
+ *     console.error(`Error [${error.code}]: ${error.message}`)
+ *     console.error('Details:', error.details)
+ *   }
+ * }
+ * ```
+ */
+declare class CobblError extends Error {
+    /**
+     * Error code indicating the type of error
+     */
+    readonly code: CobblErrorCode;
+    /**
+     * Additional details about the error (e.g., missing variables, validation issues)
+     */
+    readonly details?: unknown;
+    constructor(message: string, code: CobblErrorCode, details?: unknown);
+    /**
+     * Check if an error is a CobblError
+     */
+    static isCobblError(error: unknown): error is CobblError;
+    /**
+     * Convert error to JSON-serializable object
+     */
+    toJSON(): {
+        name: string;
+        message: string;
+        code: CobblErrorCode;
+        details: unknown;
+    };
+}
+
+export { CobblError as C, type Helpful as H, type PromptInput as P, type RunPromptRequest as R, type TokenUsage as T, type UpdateFeedbackRequest as U, type VariableConfig as V, type CobblErrorCode as a, type CobblConfig as b, type RunPromptResponse as c, type CreateFeedbackRequest as d, type CreateFeedbackResponse as e, type UpdateFeedbackResponse as f, type PromptVersionClient as g, type Provider as h };