@output.ai/http 0.1.1 → 0.2.0

package/README.md

@@ -3,83 +3,9 @@
 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
-
-```bash
-npm install @output.ai/http
-```
-
-## Quick Start
-
-```typescript
-import { httpClient } from '@output.ai/http';
-
-const client = httpClient({
-  prefixUrl: 'https://api.example.com'
-});
-
-const response = await client.get('users/1');
-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
-
-| Variable | Description |
-|----------|-------------|
-| `LOG_HTTP_VERBOSE` | Set to `true` for detailed request/response logging |
 
 ## Documentation
+- [README](https://docs.output.ai/packages/http)
+- [API Reference](https://output-ai-reference-code-docs.onrender.com/modules/http_src.html)
 
-For comprehensive documentation, visit:
-
-- [Package Reference](https://docs.output.ai/packages/http)
-- [Getting Started](https://docs.output.ai/quickstart)
+<!-- Internal Dev Note: The documentation for this package is found at docs/guides/packages/http.mdx -->

package/dist/config.d.ts

@@ -4,7 +4,7 @@
 export declare const config: {
     /**
      * Whether to log verbose HTTP information (headers and bodies)
-     * Controlled by LOG_HTTP_VERBOSE environment variable
+     * Controlled by OUTPUT_TRACE_HTTP_VERBOSE environment variable
      */
     logVerbose: boolean;
 };

package/dist/config.js

@@ -4,7 +4,7 @@
 export const config = {
     /**
      * Whether to log verbose HTTP information (headers and bodies)
-     * Controlled by LOG_HTTP_VERBOSE environment variable
+     * Controlled by OUTPUT_TRACE_HTTP_VERBOSE environment variable
      */
-    logVerbose: ['1', 'true'].includes(process.env.LOG_HTTP_VERBOSE)
+    logVerbose: ['1', 'true'].includes(process.env.OUTPUT_TRACE_HTTP_VERBOSE)
 };

package/dist/hooks/trace_error.d.ts

@@ -9,6 +9,6 @@ import type { BeforeErrorHook, Input } from 'ky';
  */
 export declare function applyFetchErrorTracing(fetchFn: (input: Input, init?: RequestInit) => Promise<Response>): (input: Input, init?: RequestInit) => Promise<Response>;
 /**
- * Traces HTTP errors for observability using Output SDK tracing
+ * Traces HTTP errors for observability using Output.ai tracing
  */
 export declare const traceError: BeforeErrorHook;

package/dist/hooks/trace_error.js

@@ -39,7 +39,7 @@ export function applyFetchErrorTracing(fetchFn) {
     };
 }
 /**
- * Traces HTTP errors for observability using Output SDK tracing
+ * Traces HTTP errors for observability using Output.ai tracing
  */
 export const traceError = (error) => {
     const traceId = createTraceId(error.request);

package/dist/hooks/trace_request.d.ts

@@ -1,6 +1,6 @@
 import type { BeforeRequestHook } from 'ky';
 /**
- * Traces HTTP request for observability using Output SDK tracing
- * Respects LOG_HTTP_VERBOSE environment variable for detailed logging
+ * Traces HTTP request for observability using Output.ai tracing
+ * Respects OUTPUT_TRACE_HTTP_VERBOSE environment variable for detailed logging
  */
 export declare const traceRequest: BeforeRequestHook;

package/dist/hooks/trace_request.js

@@ -2,8 +2,8 @@ import { Tracing } from '@output.ai/core/tracing';
 import { redactHeaders, createTraceId, parseRequestBody } from '#utils/index.js';
 import { config } from '#config.js';
 /**
- * Traces HTTP request for observability using Output SDK tracing
- * Respects LOG_HTTP_VERBOSE environment variable for detailed logging
+ * Traces HTTP request for observability using Output.ai tracing
+ * Respects OUTPUT_TRACE_HTTP_VERBOSE environment variable for detailed logging
  */
 export const traceRequest = async (request, _options) => {
     const traceId = createTraceId(request);

package/dist/hooks/trace_response.d.ts

@@ -1,6 +1,6 @@
 import type { AfterResponseHook } from 'ky';
 /**
- * Traces HTTP response for observability using Output SDK tracing
- * Respects LOG_HTTP_VERBOSE environment variable for detailed logging
+ * Traces HTTP response for observability using Output.ai tracing
+ * Respects OUTPUT_TRACE_HTTP_VERBOSE environment variable for detailed logging
  */
 export declare const traceResponse: AfterResponseHook;

package/dist/hooks/trace_response.js

@@ -2,8 +2,8 @@ import { Tracing } from '@output.ai/core/tracing';
 import { redactHeaders, createTraceId, parseResponseBody } from '#utils/index.js';
 import { config } from '#config.js';
 /**
- * Traces HTTP response for observability using Output SDK tracing
- * Respects LOG_HTTP_VERBOSE environment variable for detailed logging
+ * Traces HTTP response for observability using Output.ai tracing
+ * Respects OUTPUT_TRACE_HTTP_VERBOSE environment variable for detailed logging
  */
 export const traceResponse = async (request, _options, response) => {
     const traceId = createTraceId(request);

package/dist/index.d.ts

@@ -2,7 +2,7 @@ import type { Options } from 'ky';
 /**
  * Creates a ky client.
  *
- * This client is customized with hooks to integrate with Output SDK tracing.
+ * This client is customized with hooks to integrate with Output.ai tracing.
  *
  * @example
  * ```ts
@@ -19,7 +19,7 @@ import type { Options } from 'ky';
  * ```
  *
  * @param options - The ky options to extend the base client.
- * @returns A ky instance extended with Output SDK tracing hooks.
+ * @returns A ky instance extended with Output.ai tracing hooks.
  */
 export declare function httpClient(options?: Options): import("ky").KyInstance;
 export { HTTPError, TimeoutError } from 'ky';

package/dist/index.js

@@ -26,7 +26,7 @@ const applyDefaultOptions = (userOptions) => (parentOptions) => {
 /**
  * Creates a ky client.
  *
- * This client is customized with hooks to integrate with Output SDK tracing.
+ * This client is customized with hooks to integrate with Output.ai tracing.
  *
  * @example
  * ```ts
@@ -43,7 +43,7 @@ const applyDefaultOptions = (userOptions) => (parentOptions) => {
  * ```
  *
  * @param options - The ky options to extend the base client.
- * @returns A ky instance extended with Output SDK tracing hooks.
+ * @returns A ky instance extended with Output.ai tracing hooks.
  */
 export function httpClient(options = {}) {
     return baseHttpClient.extend(applyDefaultOptions(options));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@output.ai/http",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "description": "Framework abstraction to make HTTP calls with tracing",
   "type": "module",
   "main": "dist/index.js",