@output.ai/http 0.1.0 → 0.1.1

package/README.md

@@ -1,6 +1,9 @@
 # @output.ai/http
 
-TypeScript HTTP client that wraps [ky](https://github.com/sindresorhus/ky) with Output SDK tracing hooks.
+HTTP client with built-in tracing for Output Framework workflows.
+
+[![npm version](https://img.shields.io/npm/v/@output.ai/http)](https://www.npmjs.com/package/@output.ai/http)
+[![Documentation](https://img.shields.io/badge/docs-docs.output.ai-blue)](https://docs.output.ai/packages/http)
 
 ## Installation
 
@@ -18,9 +21,65 @@ const client = httpClient({
 });
 
 const response = await client.get('users/1');
-const userData = await response.json();
+const data = await response.json();
+```
+
+## HTTP Methods
+
+```typescript
+// GET
+const users = await client.get('users').json();
+
+// POST
+const newUser = await client.post('users', {
+  json: { name: 'John', email: 'john@example.com' }
+}).json();
+
+// PUT
+await client.put('users/1', {
+  json: { name: 'Jane' }
+});
+
+// DELETE
+await client.delete('users/1');
 ```
 
+## Using in Steps
+
+Wrap HTTP calls in steps for automatic retry and tracing:
+
+```typescript
+import { step, z } from '@output.ai/core';
+import { httpClient } from '@output.ai/http';
+
+const api = httpClient({ prefixUrl: 'https://api.example.com' });
+
+export const fetchUser = step({
+  name: 'fetchUser',
+  inputSchema: z.string(),
+  outputSchema: z.object({
+    id: z.string(),
+    name: z.string()
+  }),
+  fn: async (userId) => {
+    return api.get(`users/${userId}`).json();
+  }
+});
+```
+
+## Tracing
+
+All HTTP requests are automatically traced and visible in the Temporal UI, including request/response details and timing.
+
 ## Environment Variables
 
-- `LOG_HTTP_VERBOSE=true` - Enables detailed request/response logging including headers and body
+| Variable | Description |
+|----------|-------------|
+| `LOG_HTTP_VERBOSE` | Set to `true` for detailed request/response logging |
+
+## Documentation
+
+For comprehensive documentation, visit:
+
+- [Package Reference](https://docs.output.ai/packages/http)
+- [Getting Started](https://docs.output.ai/quickstart)

package/dist/index.d.ts

@@ -1,12 +1,11 @@
 import type { Options } from 'ky';
 /**
- * Creates an HTTP client with Output SDK tracing
+ * Creates a ky client.
  *
- * @param options - ky options to extend the base client with
- * @returns Extended ky instance with Output SDK hooks
+ * This client is customized with hooks to integrate with Output SDK tracing.
  *
  * @example
- * ```typescript
+ * ```ts
  * import { httpClient } from '@output.ai/http';
  *
  * const client = httpClient({
@@ -18,6 +17,9 @@ import type { Options } from 'ky';
  * const response = await client.get('users/1');
  * const data = await response.json();
  * ```
+ *
+ * @param options - The ky options to extend the base client.
+ * @returns A ky instance extended with Output SDK tracing hooks.
  */
 export declare function httpClient(options?: Options): import("ky").KyInstance;
 export { HTTPError, TimeoutError } from 'ky';

package/dist/index.js

@@ -1,7 +1,6 @@
 import ky from 'ky';
 import { assignRequestId, traceRequest, traceResponse, traceError } from './hooks/index.js';
 import { applyFetchErrorTracing } from '#hooks/trace_error.js';
-// Create base HTTP client with standard Output SDK tracing hooks
 const baseHttpClient = ky.create({
     hooks: {
         beforeRequest: [
@@ -25,13 +24,12 @@ const applyDefaultOptions = (userOptions) => (parentOptions) => {
     };
 };
 /**
- * Creates an HTTP client with Output SDK tracing
+ * Creates a ky client.
  *
- * @param options - ky options to extend the base client with
- * @returns Extended ky instance with Output SDK hooks
+ * This client is customized with hooks to integrate with Output SDK tracing.
  *
  * @example
- * ```typescript
+ * ```ts
  * import { httpClient } from '@output.ai/http';
  *
  * const client = httpClient({
@@ -43,6 +41,9 @@ const applyDefaultOptions = (userOptions) => (parentOptions) => {
  * const response = await client.get('users/1');
  * const data = await response.json();
  * ```
+ *
+ * @param options - The ky options to extend the base client.
+ * @returns A ky instance extended with Output SDK tracing hooks.
  */
 export function httpClient(options = {}) {
     return baseHttpClient.extend(applyDefaultOptions(options));

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@output.ai/http",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Framework abstraction to make HTTP calls with tracing",
   "type": "module",
   "main": "dist/index.js",
-  "types": "dist/index.d.js",
+  "types": "dist/index.d.ts",
   "files": [
     "dist"
   ],
@@ -15,7 +15,10 @@
     "@output.ai/core": ">=0.0.1",
     "ky": "~1.9.1"
   },
-  "license": "UNLICENSED",
+  "license": "Apache-2.0",
+  "publishConfig": {
+    "access": "public"
+  },
   "imports": {
     "#*": "./dist/*"
   }