@goharvest/simforge 0.1.0

package/README.md

@@ -0,0 +1,112 @@
+# Simforge TypeScript SDK
+
+Simforge client for provider-based API calls.
+
+## Installation
+
+```bash
+npm install @goharvest/simforge
+# or
+pnpm add @goharvest/simforge
+# or
+yarn add @goharvest/simforge
+```
+
+## Local Development
+
+```bash
+cd simforge-typescript-sdk
+pnpm install
+pnpm build
+```
+
+To link for local development:
+
+```bash
+# In this directory
+pnpm link --global
+
+# In your app directory
+pnpm link --global @harvest/simforge
+```
+
+To switch back to npm version:
+
+```bash
+pnpm unlink @harvest/simforge
+pnpm add @harvest/simforge
+```
+
+## Usage
+
+```typescript
+import { Simforge } from "@goharvest/simforge";
+
+const client = new Simforge({
+  apiKey: "sf_your_api_key_here", // Required: Your Simforge API key
+  serviceUrl: "https://your-simforge-instance.com", // Optional, can use SIMFORGE_URL env var
+});
+
+const result = await client.call("method_name", {
+  arg1: "value1",
+  arg2: "value2",
+});
+```
+
+### With TypeScript Generics
+
+You can specify the return type for type safety:
+
+```typescript
+interface MyResponse {
+  answer: string;
+  confidence: number;
+}
+
+const result = await client.call<MyResponse>("analyze", {
+  text: "Hello world",
+});
+
+console.log(result.answer); // TypeScript knows this is a string
+```
+
+### Error Handling
+
+```typescript
+import { Simforge, SimforgeError } from "@goharvest/simforge";
+
+const client = new Simforge({
+  apiKey: "sf_your_api_key_here",
+  serviceUrl: "https://your-simforge-instance.com",
+});
+
+try {
+  const result = await client.call("method_name", { input: "value" });
+} catch (error) {
+  if (error instanceof SimforgeError) {
+    console.error("Simforge error:", error.message);
+    if (error.url) {
+      console.error("Configure at:", error.url);
+    }
+  }
+}
+```
+
+## Configuration
+
+| Option       | Required | Description                                                                                     |
+| ------------ | -------- | ----------------------------------------------------------------------------------------------- |
+| `apiKey`     | Yes      | Your Simforge API key (generate from your Simforge dashboard)                                   |
+| `serviceUrl` | No       | The base URL for the Simforge API. Can also be set via the `SIMFORGE_URL` environment variable. |
+| `timeout`    | No       | Request timeout in milliseconds (default: 120000)                                               |
+
+## Environment Variables
+
+- `SIMFORGE_URL`: The base URL for the Simforge API (used if `serviceUrl` is not provided)
+
+## Publishing
+
+```bash
+pnpm build
+npm publish --access public
+```

package/dist/client.d.ts

@@ -0,0 +1,44 @@
+/**
+ * Simforge client for provider-based API calls.
+ */
+export interface SimforgeConfig {
+    /** The API key for Simforge API authentication */
+    apiKey: string;
+    /** The base URL for the Simforge API (default: https://simforge.goharvest.ai) */
+    serviceUrl?: string;
+    /** Request timeout in milliseconds (default: 120000) */
+    timeout?: number;
+}
+export interface CallResponse<T = unknown> {
+    result?: T;
+    error?: string;
+    url?: string;
+    traceId?: string;
+}
+export declare class SimforgeError extends Error {
+    readonly url?: string | undefined;
+    constructor(message: string, url?: string | undefined);
+}
+/**
+ * Client for making provider-based API calls via BAML.
+ */
+export declare class Simforge {
+    private readonly apiKey;
+    private readonly serviceUrl;
+    private readonly timeout;
+    /**
+     * Initialize the Simforge client.
+     *
+     * @param config - Configuration options for the client
+     */
+    constructor(config: SimforgeConfig);
+    /**
+     * Call a method with the given named arguments via BAML execution.
+     *
+     * @param methodName - The name of the method to call
+     * @param inputs - Named arguments to pass to the method
+     * @returns The result of the BAML function execution
+     * @throws {SimforgeError} If service_url is not set, or if an error occurs
+     */
+    call<T = unknown>(methodName: string, inputs?: Record<string, unknown>): Promise<T>;
+}

package/dist/client.js

@@ -0,0 +1,82 @@
+/**
+ * Simforge client for provider-based API calls.
+ */
+const DEFAULT_SERVICE_URL = "https://simforge.goharvest.ai";
+export class SimforgeError extends Error {
+    constructor(message, url) {
+        super(message);
+        this.url = url;
+        this.name = "SimforgeError";
+    }
+}
+/**
+ * Client for making provider-based API calls via BAML.
+ */
+export class Simforge {
+    /**
+     * Initialize the Simforge client.
+     *
+     * @param config - Configuration options for the client
+     */
+    constructor(config) {
+        this.apiKey = config.apiKey;
+        this.serviceUrl = config.serviceUrl ?? DEFAULT_SERVICE_URL;
+        this.timeout = config.timeout ?? 120000;
+    }
+    /**
+     * Call a method with the given named arguments via BAML execution.
+     *
+     * @param methodName - The name of the method to call
+     * @param inputs - Named arguments to pass to the method
+     * @returns The result of the BAML function execution
+     * @throws {SimforgeError} If service_url is not set, or if an error occurs
+     */
+    async call(methodName, inputs = {}) {
+        const url = `${this.serviceUrl}/api/sdk/call`;
+        const payload = {
+            name: methodName,
+            inputs,
+        };
+        const controller = new AbortController();
+        const timeoutId = setTimeout(() => controller.abort(), this.timeout);
+        try {
+            const response = await fetch(url, {
+                method: "POST",
+                headers: {
+                    "Content-Type": "application/json",
+                    Authorization: `Bearer ${this.apiKey}`,
+                },
+                body: JSON.stringify(payload),
+                signal: controller.signal,
+            });
+            if (!response.ok) {
+                const errorText = await response.text();
+                throw new SimforgeError(`HTTP ${response.status}: ${errorText.slice(0, 500)}`);
+            }
+            const result = await response.json();
+            // Check for errors in the response
+            if (result.error) {
+                if (result.url) {
+                    throw new SimforgeError(`${result.error} Configure it at: ${this.serviceUrl}${result.url}`, result.url);
+                }
+                throw new SimforgeError(result.error);
+            }
+            return result.result;
+        }
+        catch (error) {
+            if (error instanceof SimforgeError) {
+                throw error;
+            }
+            if (error instanceof Error) {
+                if (error.name === "AbortError") {
+                    throw new SimforgeError(`Request timed out after ${this.timeout}ms`);
+                }
+                throw new SimforgeError(error.message);
+            }
+            throw new SimforgeError("Unknown error occurred");
+        }
+        finally {
+            clearTimeout(timeoutId);
+        }
+    }
+}

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Simforge client for provider-based API calls.
+ */
+export { Simforge, SimforgeError } from "./client";
+export type { SimforgeConfig, CallResponse } from "./client";

package/dist/index.js

@@ -0,0 +1,4 @@
+/**
+ * Simforge client for provider-based API calls.
+ */
+export { Simforge, SimforgeError } from "./client";

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@goharvest/simforge",
+  "version": "0.1.0",
+  "description": "Simforge client for provider-based API calls",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "clean": "rm -rf dist"
+  },
+  "keywords": [
+    "simforge",
+    "baml",
+    "llm",
+    "api",
+    "client"
+  ],
+  "author": "Harvest Team",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/anthropic-harvest/simforge-typescript-sdk"
+  },
+  "homepage": "https://github.com/anthropic-harvest/simforge-typescript-sdk#readme",
+  "bugs": {
+    "url": "https://github.com/anthropic-harvest/simforge-typescript-sdk/issues"
+  },
+  "devDependencies": {
+    "@types/node": "^22.15.21",
+    "typescript": "^5.7.2"
+  }
+}