samuel-integrations-sdk 0.0.1 → 0.0.2

package/README.md

@@ -1,13 +1,14 @@
 # Samuel Agent Types SDK
 
-A TypeScript SDK for Agent Builder types, providing type-safe interfaces and utilities.
+A TypeScript SDK for UPTIQ Integrations, auto-generated from OpenAPI specifications.
 
 ## Features
 
-- 🎯 **TypeScript First**: Built with TypeScript for excellent developer experience
-- 🔧 **Modern Tooling**: ESLint and Prettier for code quality and formatting
-- 📦 **Ready to Publish**: Configured for npm package distribution
-- 🚀 **Zero Config**: Minimal setup required
+- 🎯 **TypeScript First**: Fully typed with auto-generated types from OpenAPI specs
+- 🔧 **Auto-generated**: SDK wrapper generated from OpenAPI spec
+- 📦 **Integration-specific Config**: Each integration can have its own default settings
+- 🚀 **Environment Variable Support**: Automatic fallback to environment variables
+- 🔐 **Type-safe**: Full TypeScript support with strict type checking
 
 ## Installation
 
@@ -17,6 +18,66 @@ npm install samuel-agent-types-sdk
 yarn add samuel-agent-types-sdk
 ```
 
+## Usage
+
+### Basic Usage with Environment Variables
+
+Set environment variables:
+```bash
+export INTEGRATION_BASE_URL="https://api.example.com"
+export PROJECT_ACCESS_KEY="your-access-key"
+export DEFAULT_MODEL_ID="gpt-4"
+export DEFAULT_PROVIDER="openai"
+```
+
+Use the default instance:
+```typescript
+import { llm } from 'samuel-agent-types-sdk';
+
+// ModelId and provider come from env vars
+const response = await llm.generate({
+  messages: [
+    { role: 'user', content: 'Hello!' }
+  ]
+});
+```
+
+### Custom Instance with Config
+
+```typescript
+import { Llm } from 'samuel-agent-types-sdk';
+
+const llm = new Llm({
+  accessKey: 'custom-access-key',
+  baseUrl: 'https://custom-api.example.com',
+  modelId: 'claude-3-opus-20240229',
+  provider: 'anthropic'
+});
+
+// Uses the config from constructor
+const response = await llm.generate({
+  messages: [
+    { role: 'user', content: 'Hello!' }
+  ]
+  // model and provider will use defaults from constructor if not specified
+});
+```
+
+### Override Defaults Per Call
+
+```typescript
+import { llm } from 'samuel-agent-types-sdk';
+
+// Override the default provider for this specific call
+const response = await llm.generate({
+  messages: [
+    { role: 'user', content: 'Hello!' }
+  ],
+  provider: 'gemini', // Override default
+  model: 'gemini-pro' // Override default
+});
+```
+
 ## Development
 
 ### Prerequisites
@@ -41,6 +102,49 @@ yarn add samuel-agent-types-sdk
 - `yarn format` - Format code with Prettier
 - `yarn format:check` - Check code formatting
 - `yarn clean` - Clean build artifacts
+- `yarn download:swagger` - Download the latest OpenAPI spec
+- `yarn generate` - Generate SDK wrapper from OpenAPI spec
+- `yarn generate:types` - Generate TypeScript types from OpenAPI spec
+
+### Adding Integration-Specific Defaults
+
+To add default configuration for an integration, edit `sdk-config.json`:
+
+```json
+{
+  "llm": {
+    "defaults": {
+      "modelId": {
+        "envVar": "DEFAULT_MODEL_ID",
+        "type": "string",
+        "description": "Default model ID to use for LLM calls"
+      },
+      "provider": {
+        "envVar": "DEFAULT_PROVIDER",
+        "type": "string",
+        "description": "Default provider to use"
+      }
+    },
+    "applyDefaults": {
+      "generate": {
+        "model": "modelId",
+        "provider": "provider"
+      }
+    }
+  }
+}
+```
+
+The `defaults` object defines:
+- Configuration field name (e.g., `modelId`)
+- Environment variable to use as fallback (e.g., `DEFAULT_MODEL_ID`)
+- Type and description
+
+The `applyDefaults` object maps operation names to parameter mappings:
+- Key: operation name from OpenAPI (e.g., `generate`)
+- Value: mapping of API parameter name to config field name
+
+After modifying `sdk-config.json`, run `yarn generate` to regenerate the SDK wrapper.
 
 ### Project Structure
 

package/dist/http-client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"http-client.d.ts","sourceRoot":"","sources":["../src/http-client.ts"],"names":[],"mappings":"AAAA,OAAc,EAAE,kBAAkB,EAAE,MAAM,OAAO,CAAC;AAClD,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAEhD,UAAU,UAAU;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,eAAO,MAAM,UAAU,+BAAsC,CAAC;AA2B9D,eAAO,MAAM,WAAW,GAAU,CAAC,EAAE,QAAQ,kBAAkB,KAAG,OAAO,CAAC,CAAC,CAG1E,CAAC"}
+{"version":3,"file":"http-client.d.ts","sourceRoot":"","sources":["../src/http-client.ts"],"names":[],"mappings":"AAAA,OAAc,EAAE,kBAAkB,EAAE,MAAM,OAAO,CAAC;AAClD,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAEhD,UAAU,UAAU;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,eAAO,MAAM,UAAU,+BAAsC,CAAC;AA0B9D,eAAO,MAAM,WAAW,GAAU,CAAC,EACjC,QAAQ,kBAAkB,KACzB,OAAO,CAAC,CAAC,CAGX,CAAC"}

package/dist/http-client.js

@@ -8,14 +8,14 @@ const axios_1 = __importDefault(require("axios"));
 const async_hooks_1 = require("async_hooks");
 exports.sdkContext = new async_hooks_1.AsyncLocalStorage();
 const axiosInstance = axios_1.default.create();
-axiosInstance.interceptors.request.use((config) => {
+axiosInstance.interceptors.request.use(config => {
     const context = exports.sdkContext.getStore();
-    const baseURL = context?.baseUrl || process.env["INTEGRATION_BASE_URL"];
+    const baseURL = context?.baseUrl || process.env['INTEGRATION_BASE_URL'];
     if (baseURL) {
         config.baseURL = baseURL;
     }
-    const accessKey = context?.accessKey || process.env["PROJECT_ACCESS_KEY"];
-    const tenantId = process.env["TENANT_ID"];
+    const accessKey = context?.accessKey || process.env['PROJECT_ACCESS_KEY'];
+    const tenantId = process.env['TENANT_ID'];
     if (accessKey) {
         config.headers = config.headers || {};
         config.headers['x-project-access-key'] = accessKey;

package/dist/http-client.js.map

@@ -1 +1 @@
-{"version":3,"file":"http-client.js","sourceRoot":"","sources":["../src/http-client.ts"],"names":[],"mappings":";;;;;;AAAA,kDAAkD;AAClD,6CAAgD;AAOnC,QAAA,UAAU,GAAG,IAAI,+BAAiB,EAAc,CAAC;AAE9D,MAAM,aAAa,GAAG,eAAK,CAAC,MAAM,EAAE,CAAC;AAErC,aAAa,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE;IAChD,MAAM,OAAO,GAAG,kBAAU,CAAC,QAAQ,EAAE,CAAC;IAEtC,MAAM,OAAO,GAAG,OAAO,EAAE,OAAO,IAAI,OAAO,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAC;IACxE,IAAI,OAAO,EAAE,CAAC;QACZ,MAAM,CAAC,OAAO,GAAG,OAAO,CAAC;IAC3B,CAAC;IAED,MAAM,SAAS,GAAG,OAAO,EAAE,SAAS,IAAI,OAAO,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAC;IAC1E,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;IAE1C,IAAI,SAAS,EAAE,CAAC;QACd,MAAM,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,IAAI,EAAE,CAAC;QACtC,MAAM,CAAC,OAAO,CAAC,sBAAsB,CAAC,GAAG,SAAS,CAAC;QACnD,IAAI,QAAQ,EAAE,CAAC;YACb,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,GAAG,QAAQ,CAAC;QAC3C,CAAC;IACH,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC,CAAC;AAGI,MAAM,WAAW,GAAG,KAAK,EAAK,MAA0B,EAAc,EAAE;IAC7E,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,aAAa,CAAC,MAAM,CAAC,CAAC;IAC7C,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAHW,QAAA,WAAW,eAGtB"}
+{"version":3,"file":"http-client.js","sourceRoot":"","sources":["../src/http-client.ts"],"names":[],"mappings":";;;;;;AAAA,kDAAkD;AAClD,6CAAgD;AAOnC,QAAA,UAAU,GAAG,IAAI,+BAAiB,EAAc,CAAC;AAE9D,MAAM,aAAa,GAAG,eAAK,CAAC,MAAM,EAAE,CAAC;AAErC,aAAa,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE;IAC9C,MAAM,OAAO,GAAG,kBAAU,CAAC,QAAQ,EAAE,CAAC;IAEtC,MAAM,OAAO,GAAG,OAAO,EAAE,OAAO,IAAI,OAAO,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAC;IACxE,IAAI,OAAO,EAAE,CAAC;QACZ,MAAM,CAAC,OAAO,GAAG,OAAO,CAAC;IAC3B,CAAC;IAED,MAAM,SAAS,GAAG,OAAO,EAAE,SAAS,IAAI,OAAO,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAC;IAC1E,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;IAE1C,IAAI,SAAS,EAAE,CAAC;QACd,MAAM,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,IAAI,EAAE,CAAC;QACtC,MAAM,CAAC,OAAO,CAAC,sBAAsB,CAAC,GAAG,SAAS,CAAC;QACnD,IAAI,QAAQ,EAAE,CAAC;YACb,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,GAAG,QAAQ,CAAC;QAC3C,CAAC;IACH,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC,CAAC;AAEI,MAAM,WAAW,GAAG,KAAK,EAC9B,MAA0B,EACd,EAAE;IACd,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,aAAa,CAAC,MAAM,CAAC,CAAC;IAC7C,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AALW,QAAA,WAAW,eAKtB"}

package/dist/index.d.ts

@@ -13,6 +13,8 @@ export declare class Llm {
     constructor(options?: {
         accessKey?: string;
         baseUrl?: string;
+        modelId?: string;
+        provider?: string;
     });
     private withContext;
     generate: (...args: Parameters<typeof this.api.generate>) => Promise<import("./generated-api").Generate200>;

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAGA;;;;;GAKG;AAEH;;GAEG;AACH,qBAAa,GAAG;IACd,OAAO,CAAC,MAAM,CAA2C;IACzD,OAAO,CAAC,GAAG,CAAwC;gBAEvC,OAAO,CAAC,EAAE;QACpB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB;IAQD,OAAO,CAAC,WAAW;IAInB,QAAQ,GAAI,GAAG,MAAM,UAAU,CAAC,OAAO,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,oDACJ;CACtD;AAED;;;;;GAKG;AACH,eAAO,MAAM,GAAG,KAAY,CAAC;AAG7B,cAAc,iBAAiB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAGA;;;;;GAKG;AAEH;;GAEG;AACH,qBAAa,GAAG;IACd,OAAO,CAAC,MAAM,CAES;IACvB,OAAO,CAAC,GAAG,CAAwC;gBAEvC,OAAO,CAAC,EAAE;QACpB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB;IAaD,OAAO,CAAC,WAAW;IAInB,QAAQ,GAAI,GAAG,MAAM,UAAU,CAAC,OAAO,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,oDAKnD;CACP;AAED;;;;;GAKG;AACH,eAAO,MAAM,GAAG,KAAY,CAAC;AAG7B,cAAc,iBAAiB,CAAC"}

package/dist/index.js

@@ -28,9 +28,18 @@ const http_client_1 = require("./http-client");
  */
 class Llm {
     constructor(options) {
-        this.generate = (...args) => this.withContext(() => this.api.generate(...args));
+        this.generate = (...args) => this.withContext(() => this.api.generate({
+            ...args[0],
+            ...(args[0].model || this.config.modelId ? { model: args[0].model || this.config.modelId } : {}),
+            ...(args[0].provider || this.config.provider ? { provider: args[0].provider || this.config.provider } : {})
+        }));
         // Store config for this instance (uses env vars if not provided)
-        this.config = options || {};
+        this.config = {
+            ...(options?.accessKey ? { accessKey: options.accessKey } : {}),
+            ...(options?.baseUrl ? { baseUrl: options.baseUrl } : {}),
+            ...(options?.modelId || process.env["LLM_MODEL"] ? { modelId: options?.modelId || process.env["LLM_MODEL"] } : {}),
+            ...(options?.provider || process.env["LLM_PROVIDER"] ? { provider: options?.provider || process.env["LLM_PROVIDER"] } : {})
+        };
         // Get the generated API methods
         this.api = (0, generated_api_1.getIntegrationsAPI)();
     }

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,mDAAqD;AACrD,+CAA2C;AAE3C;;;;;GAKG;AAEH;;GAEG;AACH,MAAa,GAAG;IAId,YAAY,OAGX;QAYD,aAAQ,GAAG,CAAC,GAAG,IAA0C,EAAE,EAAE,CAC3D,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;QAZnD,iEAAiE;QACjE,IAAI,CAAC,MAAM,GAAG,OAAO,IAAI,EAAE,CAAC;QAC5B,gCAAgC;QAChC,IAAI,CAAC,GAAG,GAAG,IAAA,kCAAkB,GAAE,CAAC;IAClC,CAAC;IAED,wCAAwC;IAChC,WAAW,CAAI,EAAoB;QACzC,OAAO,wBAAU,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;IACzC,CAAC;CAIF;AArBD,kBAqBC;AAED;;;;;GAKG;AACU,QAAA,GAAG,GAAG,IAAI,GAAG,EAAE,CAAC;AAE7B,yCAAyC;AACzC,kDAAgC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,mDAAqD;AACrD,+CAA2C;AAE3C;;;;;GAKG;AAEH;;GAEG;AACH,MAAa,GAAG;IAMd,YAAY,OAKX;QAiBD,aAAQ,GAAG,CAAC,GAAG,IAA0C,EAAE,EAAE,CAC3D,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC;YACvC,GAAG,IAAI,CAAC,CAAC,CAAC;YACV,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,IAAI,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,IAAI,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YAC9F,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,QAAQ,IAAI,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,QAAQ,IAAI,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;SAC9G,CAAC,CAAC,CAAC;QArBJ,iEAAiE;QACjE,IAAI,CAAC,MAAM,GAAG;YACZ,GAAG,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,OAAO,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YAC/D,GAAG,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACzD,GAAG,CAAC,OAAO,EAAE,OAAO,IAAI,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,IAAI,OAAO,CAAC,GAAG,CAAC,WAAW,CAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YAC5H,GAAG,CAAC,OAAO,EAAE,QAAQ,IAAI,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,IAAI,OAAO,CAAC,GAAG,CAAC,cAAc,CAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;SACtI,CAAC;QACF,gCAAgC;QAChC,IAAI,CAAC,GAAG,GAAG,IAAA,kCAAkB,GAAE,CAAC;IAClC,CAAC;IAED,wCAAwC;IAChC,WAAW,CAAI,EAAoB;QACzC,OAAO,wBAAU,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;IACzC,CAAC;CAQF;AAlCD,kBAkCC;AAED;;;;;GAKG;AACU,QAAA,GAAG,GAAG,IAAI,GAAG,EAAE,CAAC;AAE7B,yCAAyC;AACzC,kDAAgC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "samuel-integrations-sdk",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "SDK for UPTIQ integrations",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",