@cobbl-ai/sdk 0.1.0

package/dist/index.d.mts

@@ -0,0 +1,348 @@
+// Generated by dts-bundle-generator v9.5.1
+
+import { z } from 'zod';
+
+declare const ProviderSchema: z.ZodEnum<{
+	openai: "openai";
+	anthropic: "anthropic";
+	google: "google";
+}>;
+export type Provider = z.infer<typeof ProviderSchema>;
+declare const VariableConfigSchema: z.ZodObject<{
+	key: z.ZodString;
+	type: z.ZodEnum<{
+		string: "string";
+		number: "number";
+		boolean: "boolean";
+		object: "object";
+		list: "list";
+	}>;
+	required: z.ZodBoolean;
+	description: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export type VariableConfig = z.infer<typeof VariableConfigSchema>;
+declare const PromptInputSchema: z.ZodRecord<z.ZodString, z.ZodUnion<readonly [
+	z.ZodString,
+	z.ZodNumber,
+	z.ZodBoolean,
+	z.ZodArray<z.ZodAny>,
+	z.ZodRecord<z.ZodString, z.ZodAny>
+]>>;
+export type PromptInput = z.infer<typeof PromptInputSchema>;
+declare const PromptVersionClientSchema: z.ZodDiscriminatedUnion<[
+	z.ZodObject<{
+		tenantId: z.ZodString;
+		environmentId: z.ZodString;
+		promptId: z.ZodString;
+		slug: z.ZodString;
+		versionNumber: z.ZodNumber;
+		template: z.ZodString;
+		variables: z.ZodArray<z.ZodObject<{
+			key: z.ZodString;
+			type: z.ZodEnum<{
+				string: "string";
+				number: "number";
+				boolean: "boolean";
+				object: "object";
+				list: "list";
+			}>;
+			required: z.ZodBoolean;
+			description: z.ZodOptional<z.ZodString>;
+		}, z.core.$strip>>;
+		provider: z.ZodEnum<{
+			openai: "openai";
+			anthropic: "anthropic";
+			google: "google";
+		}>;
+		model: z.ZodString;
+		status: z.ZodEnum<{
+			draft: "draft";
+			active: "active";
+			inactive: "inactive";
+		}>;
+		parentVersionId: z.ZodOptional<z.ZodString>;
+		authorId: z.ZodString;
+		authorName: z.ZodString;
+		source: z.ZodLiteral<"manual">;
+		publishedAt: z.ZodOptional<z.ZodDate>;
+		id: z.ZodString;
+		schemaVersion: z.ZodNumber;
+		createdAt: z.ZodDate;
+		updatedAt: z.ZodDate;
+	}, z.core.$strip>,
+	z.ZodObject<{
+		tenantId: z.ZodString;
+		environmentId: z.ZodString;
+		promptId: z.ZodString;
+		slug: z.ZodString;
+		versionNumber: z.ZodNumber;
+		template: z.ZodString;
+		variables: z.ZodArray<z.ZodObject<{
+			key: z.ZodString;
+			type: z.ZodEnum<{
+				string: "string";
+				number: "number";
+				boolean: "boolean";
+				object: "object";
+				list: "list";
+			}>;
+			required: z.ZodBoolean;
+			description: z.ZodOptional<z.ZodString>;
+		}, z.core.$strip>>;
+		provider: z.ZodEnum<{
+			openai: "openai";
+			anthropic: "anthropic";
+			google: "google";
+		}>;
+		model: z.ZodString;
+		status: z.ZodEnum<{
+			draft: "draft";
+			active: "active";
+			inactive: "inactive";
+		}>;
+		parentVersionId: z.ZodOptional<z.ZodString>;
+		feedbackId: z.ZodString;
+		source: z.ZodLiteral<"feedback_llm_suggestion">;
+		publishedAt: z.ZodOptional<z.ZodDate>;
+		id: z.ZodString;
+		schemaVersion: z.ZodNumber;
+		createdAt: z.ZodDate;
+		updatedAt: z.ZodDate;
+	}, z.core.$strip>,
+	z.ZodObject<{
+		tenantId: z.ZodString;
+		environmentId: z.ZodString;
+		promptId: z.ZodString;
+		slug: z.ZodString;
+		versionNumber: z.ZodNumber;
+		template: z.ZodString;
+		variables: z.ZodArray<z.ZodObject<{
+			key: z.ZodString;
+			type: z.ZodEnum<{
+				string: "string";
+				number: "number";
+				boolean: "boolean";
+				object: "object";
+				list: "list";
+			}>;
+			required: z.ZodBoolean;
+			description: z.ZodOptional<z.ZodString>;
+		}, z.core.$strip>>;
+		provider: z.ZodEnum<{
+			openai: "openai";
+			anthropic: "anthropic";
+			google: "google";
+		}>;
+		model: z.ZodString;
+		status: z.ZodEnum<{
+			draft: "draft";
+			active: "active";
+			inactive: "inactive";
+		}>;
+		parentVersionId: z.ZodOptional<z.ZodString>;
+		authorId: z.ZodString;
+		authorName: z.ZodString;
+		feedbackId: z.ZodString;
+		source: z.ZodLiteral<"feedback_llm_override">;
+		publishedAt: z.ZodOptional<z.ZodDate>;
+		id: z.ZodString;
+		schemaVersion: z.ZodNumber;
+		createdAt: z.ZodDate;
+		updatedAt: z.ZodDate;
+	}, z.core.$strip>
+], "source">;
+export type PromptVersionClient = z.infer<typeof PromptVersionClientSchema>;
+declare const helpfulSchema: z.ZodEnum<{
+	helpful: "helpful";
+	not_helpful: "not_helpful";
+}>;
+export type Helpful = z.infer<typeof helpfulSchema>;
+declare const tokenUsageSchema: z.ZodObject<{
+	inputTokens: z.ZodNumber;
+	outputTokens: z.ZodNumber;
+	totalTokens: z.ZodNumber;
+}, z.core.$strip>;
+export type TokenUsage = z.infer<typeof tokenUsageSchema>;
+/**
+ * Configuration options for the CobblClient
+ */
+export interface CobblConfig {
+	/**
+	 * Your Cobbl API key
+	 * @required
+	 */
+	apiKey: string;
+}
+/**
+ * Response from running a prompt
+ */
+export interface RunPromptResponse {
+	/**
+	 * Unique ID for this prompt run - use this to link feedback
+	 */
+	runId: string;
+	/**
+	 * The AI-generated output
+	 */
+	output: string;
+	/**
+	 * Token usage statistics
+	 */
+	tokenUsage: TokenUsage;
+	/**
+	 * The rendered prompt that was sent to the LLM (with variables substituted)
+	 */
+	renderedPrompt: string;
+	/**
+	 * Information about the prompt version that was used
+	 */
+	promptVersion: PromptVersionClient;
+}
+/**
+ * Feedback submission data
+ */
+export interface FeedbackSubmission {
+	/**
+	 * The run ID from a previous runPrompt call
+	 * @required
+	 */
+	runId: string;
+	/**
+	 * Whether the output was helpful
+	 * @required
+	 */
+	helpful: Helpful;
+	/**
+	 * Detailed feedback message from the user
+	 * @required
+	 */
+	userFeedback: string;
+}
+/**
+ * Response from submitting feedback
+ */
+export interface SubmitFeedbackResponse {
+	/**
+	 * Unique ID for the created feedback item
+	 */
+	feedbackId: string;
+	/**
+	 * Success message
+	 */
+	message: string;
+}
+export declare class CobblClient {
+	private readonly apiKey;
+	/**
+	 * Initialize the Cobbl SDK client
+	 *
+	 * @param config - Configuration object
+	 * @param config.apiKey - Your Cobbl API key
+	 *
+	 * @example
+	 * ```typescript
+	 * const client = new CobblClient({
+	 *   apiKey: process.env.COBBL_API_KEY
+	 * })
+	 * ```
+	 */
+	constructor(config: CobblConfig);
+	/**
+	 * Execute a prompt with the given input variables
+	 *
+	 * @param promptSlug - The unique slug identifier for the prompt
+	 * @param input - Input variables to populate the prompt template
+	 * @returns Promise containing the prompt execution results
+	 *
+	 * @throws {CobblError} When the request fails or API returns an error
+	 *
+	 * @example
+	 * ```typescript
+	 * const result = await client.runPrompt('sales_summary', {
+	 *   topic: 'Q4 Results',
+	 *   tone: 'friendly',
+	 *   audience: 'investors'
+	 * })
+	 *
+	 * console.log(result.output) // AI-generated response
+	 * console.log(result.runId) // Save this to link feedback later
+	 * ```
+	 */
+	runPrompt(promptSlug: string, input: PromptInput): Promise<RunPromptResponse>;
+	/**
+	 * Submit user feedback for a prompt run
+	 *
+	 * @param feedback - Feedback submission data
+	 * @param feedback.runId - The run ID from a previous runPrompt call
+	 * @param feedback.helpful - Whether the output was helpful ('helpful' or 'not_helpful')
+	 * @param feedback.userFeedback - Detailed feedback message from the user
+	 * @returns Promise containing the created feedback ID
+	 *
+	 * @throws {CobblError} When the request fails or API returns an error
+	 *
+	 * @example
+	 * ```typescript
+	 * await client.submitFeedback({
+	 *   runId: result.runId,
+	 *   helpful: 'not_helpful',
+	 *   userFeedback: 'The response was too formal and lengthy'
+	 * })
+	 * ```
+	 */
+	submitFeedback(feedback: FeedbackSubmission): Promise<SubmitFeedbackResponse>;
+	/**
+	 * Make an HTTP request to the Cobbl API
+	 * @private
+	 */
+	private makeRequest;
+	/**
+	 * Handle error responses from the API
+	 * @private
+	 */
+	private handleErrorResponse;
+}
+/**
+ * Error types that can be thrown by the Cobbl SDK
+ */
+export type CobblErrorCode = "INVALID_CONFIG" | "INVALID_REQUEST" | "UNAUTHORIZED" | "NOT_FOUND" | "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)
+ *   }
+ * }
+ * ```
+ */
+export 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 {};

package/dist/index.d.ts

@@ -0,0 +1,348 @@
+// Generated by dts-bundle-generator v9.5.1
+
+import { z } from 'zod';
+
+declare const ProviderSchema: z.ZodEnum<{
+	openai: "openai";
+	anthropic: "anthropic";
+	google: "google";
+}>;
+export type Provider = z.infer<typeof ProviderSchema>;
+declare const VariableConfigSchema: z.ZodObject<{
+	key: z.ZodString;
+	type: z.ZodEnum<{
+		string: "string";
+		number: "number";
+		boolean: "boolean";
+		object: "object";
+		list: "list";
+	}>;
+	required: z.ZodBoolean;
+	description: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export type VariableConfig = z.infer<typeof VariableConfigSchema>;
+declare const PromptInputSchema: z.ZodRecord<z.ZodString, z.ZodUnion<readonly [
+	z.ZodString,
+	z.ZodNumber,
+	z.ZodBoolean,
+	z.ZodArray<z.ZodAny>,
+	z.ZodRecord<z.ZodString, z.ZodAny>
+]>>;
+export type PromptInput = z.infer<typeof PromptInputSchema>;
+declare const PromptVersionClientSchema: z.ZodDiscriminatedUnion<[
+	z.ZodObject<{
+		tenantId: z.ZodString;
+		environmentId: z.ZodString;
+		promptId: z.ZodString;
+		slug: z.ZodString;
+		versionNumber: z.ZodNumber;
+		template: z.ZodString;
+		variables: z.ZodArray<z.ZodObject<{
+			key: z.ZodString;
+			type: z.ZodEnum<{
+				string: "string";
+				number: "number";
+				boolean: "boolean";
+				object: "object";
+				list: "list";
+			}>;
+			required: z.ZodBoolean;
+			description: z.ZodOptional<z.ZodString>;
+		}, z.core.$strip>>;
+		provider: z.ZodEnum<{
+			openai: "openai";
+			anthropic: "anthropic";
+			google: "google";
+		}>;
+		model: z.ZodString;
+		status: z.ZodEnum<{
+			draft: "draft";
+			active: "active";
+			inactive: "inactive";
+		}>;
+		parentVersionId: z.ZodOptional<z.ZodString>;
+		authorId: z.ZodString;
+		authorName: z.ZodString;
+		source: z.ZodLiteral<"manual">;
+		publishedAt: z.ZodOptional<z.ZodDate>;
+		id: z.ZodString;
+		schemaVersion: z.ZodNumber;
+		createdAt: z.ZodDate;
+		updatedAt: z.ZodDate;
+	}, z.core.$strip>,
+	z.ZodObject<{
+		tenantId: z.ZodString;
+		environmentId: z.ZodString;
+		promptId: z.ZodString;
+		slug: z.ZodString;
+		versionNumber: z.ZodNumber;
+		template: z.ZodString;
+		variables: z.ZodArray<z.ZodObject<{
+			key: z.ZodString;
+			type: z.ZodEnum<{
+				string: "string";
+				number: "number";
+				boolean: "boolean";
+				object: "object";
+				list: "list";
+			}>;
+			required: z.ZodBoolean;
+			description: z.ZodOptional<z.ZodString>;
+		}, z.core.$strip>>;
+		provider: z.ZodEnum<{
+			openai: "openai";
+			anthropic: "anthropic";
+			google: "google";
+		}>;
+		model: z.ZodString;
+		status: z.ZodEnum<{
+			draft: "draft";
+			active: "active";
+			inactive: "inactive";
+		}>;
+		parentVersionId: z.ZodOptional<z.ZodString>;
+		feedbackId: z.ZodString;
+		source: z.ZodLiteral<"feedback_llm_suggestion">;
+		publishedAt: z.ZodOptional<z.ZodDate>;
+		id: z.ZodString;
+		schemaVersion: z.ZodNumber;
+		createdAt: z.ZodDate;
+		updatedAt: z.ZodDate;
+	}, z.core.$strip>,
+	z.ZodObject<{
+		tenantId: z.ZodString;
+		environmentId: z.ZodString;
+		promptId: z.ZodString;
+		slug: z.ZodString;
+		versionNumber: z.ZodNumber;
+		template: z.ZodString;
+		variables: z.ZodArray<z.ZodObject<{
+			key: z.ZodString;
+			type: z.ZodEnum<{
+				string: "string";
+				number: "number";
+				boolean: "boolean";
+				object: "object";
+				list: "list";
+			}>;
+			required: z.ZodBoolean;
+			description: z.ZodOptional<z.ZodString>;
+		}, z.core.$strip>>;
+		provider: z.ZodEnum<{
+			openai: "openai";
+			anthropic: "anthropic";
+			google: "google";
+		}>;
+		model: z.ZodString;
+		status: z.ZodEnum<{
+			draft: "draft";
+			active: "active";
+			inactive: "inactive";
+		}>;
+		parentVersionId: z.ZodOptional<z.ZodString>;
+		authorId: z.ZodString;
+		authorName: z.ZodString;
+		feedbackId: z.ZodString;
+		source: z.ZodLiteral<"feedback_llm_override">;
+		publishedAt: z.ZodOptional<z.ZodDate>;
+		id: z.ZodString;
+		schemaVersion: z.ZodNumber;
+		createdAt: z.ZodDate;
+		updatedAt: z.ZodDate;
+	}, z.core.$strip>
+], "source">;
+export type PromptVersionClient = z.infer<typeof PromptVersionClientSchema>;
+declare const helpfulSchema: z.ZodEnum<{
+	helpful: "helpful";
+	not_helpful: "not_helpful";
+}>;
+export type Helpful = z.infer<typeof helpfulSchema>;
+declare const tokenUsageSchema: z.ZodObject<{
+	inputTokens: z.ZodNumber;
+	outputTokens: z.ZodNumber;
+	totalTokens: z.ZodNumber;
+}, z.core.$strip>;
+export type TokenUsage = z.infer<typeof tokenUsageSchema>;
+/**
+ * Configuration options for the CobblClient
+ */
+export interface CobblConfig {
+	/**
+	 * Your Cobbl API key
+	 * @required
+	 */
+	apiKey: string;
+}
+/**
+ * Response from running a prompt
+ */
+export interface RunPromptResponse {
+	/**
+	 * Unique ID for this prompt run - use this to link feedback
+	 */
+	runId: string;
+	/**
+	 * The AI-generated output
+	 */
+	output: string;
+	/**
+	 * Token usage statistics
+	 */
+	tokenUsage: TokenUsage;
+	/**
+	 * The rendered prompt that was sent to the LLM (with variables substituted)
+	 */
+	renderedPrompt: string;
+	/**
+	 * Information about the prompt version that was used
+	 */
+	promptVersion: PromptVersionClient;
+}
+/**
+ * Feedback submission data
+ */
+export interface FeedbackSubmission {
+	/**
+	 * The run ID from a previous runPrompt call
+	 * @required
+	 */
+	runId: string;
+	/**
+	 * Whether the output was helpful
+	 * @required
+	 */
+	helpful: Helpful;
+	/**
+	 * Detailed feedback message from the user
+	 * @required
+	 */
+	userFeedback: string;
+}
+/**
+ * Response from submitting feedback
+ */
+export interface SubmitFeedbackResponse {
+	/**
+	 * Unique ID for the created feedback item
+	 */
+	feedbackId: string;
+	/**
+	 * Success message
+	 */
+	message: string;
+}
+export declare class CobblClient {
+	private readonly apiKey;
+	/**
+	 * Initialize the Cobbl SDK client
+	 *
+	 * @param config - Configuration object
+	 * @param config.apiKey - Your Cobbl API key
+	 *
+	 * @example
+	 * ```typescript
+	 * const client = new CobblClient({
+	 *   apiKey: process.env.COBBL_API_KEY
+	 * })
+	 * ```
+	 */
+	constructor(config: CobblConfig);
+	/**
+	 * Execute a prompt with the given input variables
+	 *
+	 * @param promptSlug - The unique slug identifier for the prompt
+	 * @param input - Input variables to populate the prompt template
+	 * @returns Promise containing the prompt execution results
+	 *
+	 * @throws {CobblError} When the request fails or API returns an error
+	 *
+	 * @example
+	 * ```typescript
+	 * const result = await client.runPrompt('sales_summary', {
+	 *   topic: 'Q4 Results',
+	 *   tone: 'friendly',
+	 *   audience: 'investors'
+	 * })
+	 *
+	 * console.log(result.output) // AI-generated response
+	 * console.log(result.runId) // Save this to link feedback later
+	 * ```
+	 */
+	runPrompt(promptSlug: string, input: PromptInput): Promise<RunPromptResponse>;
+	/**
+	 * Submit user feedback for a prompt run
+	 *
+	 * @param feedback - Feedback submission data
+	 * @param feedback.runId - The run ID from a previous runPrompt call
+	 * @param feedback.helpful - Whether the output was helpful ('helpful' or 'not_helpful')
+	 * @param feedback.userFeedback - Detailed feedback message from the user
+	 * @returns Promise containing the created feedback ID
+	 *
+	 * @throws {CobblError} When the request fails or API returns an error
+	 *
+	 * @example
+	 * ```typescript
+	 * await client.submitFeedback({
+	 *   runId: result.runId,
+	 *   helpful: 'not_helpful',
+	 *   userFeedback: 'The response was too formal and lengthy'
+	 * })
+	 * ```
+	 */
+	submitFeedback(feedback: FeedbackSubmission): Promise<SubmitFeedbackResponse>;
+	/**
+	 * Make an HTTP request to the Cobbl API
+	 * @private
+	 */
+	private makeRequest;
+	/**
+	 * Handle error responses from the API
+	 * @private
+	 */
+	private handleErrorResponse;
+}
+/**
+ * Error types that can be thrown by the Cobbl SDK
+ */
+export type CobblErrorCode = "INVALID_CONFIG" | "INVALID_REQUEST" | "UNAUTHORIZED" | "NOT_FOUND" | "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)
+ *   }
+ * }
+ * ```
+ */
+export 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 {};