@webpieces/http-client 0.1.0

package/README.md

@@ -0,0 +1,19 @@
+# @webpieces/http-client
+
+> HTTP client for WebPieces framework
+
+Part of the [WebPieces TypeScript](https://github.com/deanhiller/webpieces-ts) framework.
+
+## Installation
+
+```bash
+npm install @webpieces/http-client
+```
+
+## Documentation
+
+See the main [WebPieces README](https://github.com/deanhiller/webpieces-ts#readme) for complete documentation and examples.
+
+## License
+
+Apache-2.0

package/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "@webpieces/http-client",
+  "version": "0.1.0",
+  "description": "HTTP client for WebPieces framework",
+  "type": "commonjs",
+  "main": "./src/index.js",
+  "types": "./src/index.d.ts",
+  "author": "Dean Hiller",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/deanhiller/webpieces-ts.git",
+    "directory": "packages/http/http-client"
+  },
+  "keywords": [
+    "webpieces",
+    "http",
+    "client"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@webpieces/http-api": "0.1.0"
+  }
+}

package/src/ClientFactory.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Configuration options for HTTP client.
+ */
+export interface ClientConfig {
+    /** Base URL for all requests (e.g., 'http://localhost:3000') */
+    baseUrl: string;
+    /** Optional headers to include in all requests */
+    headers?: Record<string, string>;
+    /** Optional fetch implementation (defaults to global fetch) */
+    fetch?: typeof fetch;
+}
+/**
+ * Creates a type-safe HTTP client from an API interface prototype.
+ *
+ * This is the client-side equivalent of RESTApiRoutes.
+ * - Server: RESTApiRoutes reads decorators → routes HTTP requests to controllers
+ * - Client: createClient reads decorators → generates HTTP requests from method calls
+ *
+ * Usage:
+ * ```typescript
+ * const client = createClient(SaveApiPrototype, { baseUrl: 'http://localhost:3000' });
+ * const response = await client.save({ query: 'test' }); // Type-safe!
+ * ```
+ *
+ * @param apiPrototype - The API prototype class with decorators (e.g., SaveApiPrototype)
+ * @param config - Client configuration (baseUrl, headers, etc.)
+ * @returns A proxy object that implements the API interface
+ */
+export declare function createClient<T extends object>(apiPrototype: Function & {
+    prototype: T;
+}, config: ClientConfig): T;

package/src/ClientFactory.js

@@ -0,0 +1,87 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createClient = createClient;
+const http_api_1 = require("@webpieces/http-api");
+/**
+ * Creates a type-safe HTTP client from an API interface prototype.
+ *
+ * This is the client-side equivalent of RESTApiRoutes.
+ * - Server: RESTApiRoutes reads decorators → routes HTTP requests to controllers
+ * - Client: createClient reads decorators → generates HTTP requests from method calls
+ *
+ * Usage:
+ * ```typescript
+ * const client = createClient(SaveApiPrototype, { baseUrl: 'http://localhost:3000' });
+ * const response = await client.save({ query: 'test' }); // Type-safe!
+ * ```
+ *
+ * @param apiPrototype - The API prototype class with decorators (e.g., SaveApiPrototype)
+ * @param config - Client configuration (baseUrl, headers, etc.)
+ * @returns A proxy object that implements the API interface
+ */
+function createClient(apiPrototype, config) {
+    // Validate that the API prototype is marked with @ApiInterface
+    if (!(0, http_api_1.isApiInterface)(apiPrototype)) {
+        const className = apiPrototype.name || 'Unknown';
+        throw new Error(`Class ${className} must be decorated with @ApiInterface()`);
+    }
+    // Get all routes from the API prototype
+    const routes = (0, http_api_1.getRoutes)(apiPrototype);
+    // Create a map of method name -> route metadata for fast lookup
+    const routeMap = new Map();
+    for (const route of routes) {
+        routeMap.set(route.methodName, route);
+    }
+    // Use fetch implementation from config or global
+    const fetchImpl = config.fetch || fetch;
+    // Create a proxy that intercepts method calls and makes HTTP requests
+    return new Proxy({}, {
+        get(target, prop) {
+            // Only handle string properties (method names)
+            if (typeof prop !== 'string') {
+                return undefined;
+            }
+            // Get the route metadata for this method
+            const route = routeMap.get(prop);
+            if (!route) {
+                throw new Error(`No route found for method ${prop}`);
+            }
+            // Return a function that makes the HTTP request
+            return async (...args) => {
+                return makeRequest(fetchImpl, config, route, args);
+            };
+        },
+    });
+}
+/**
+ * Make an HTTP request based on route metadata and arguments.
+ */
+async function makeRequest(fetchImpl, config, route, args) {
+    const { httpMethod, path } = route;
+    // Build the full URL
+    const url = `${config.baseUrl}${path}`;
+    // Build headers
+    const headers = {
+        'Content-Type': 'application/json',
+        ...config.headers,
+    };
+    // Build request options
+    const options = {
+        method: httpMethod,
+        headers,
+    };
+    // For POST/PUT/PATCH, include the body (first argument)
+    if (['POST', 'PUT', 'PATCH'].includes(httpMethod) && args.length > 0) {
+        options.body = JSON.stringify(args[0]);
+    }
+    // Make the HTTP request
+    const response = await fetchImpl(url, options);
+    // Check for HTTP errors
+    if (!response.ok) {
+        const errorText = await response.text();
+        throw new Error(`HTTP ${response.status}: ${response.statusText}. ${errorText}`);
+    }
+    // Parse and return the JSON response
+    return response.json();
+}
+//# sourceMappingURL=ClientFactory.js.map

package/src/ClientFactory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ClientFactory.js","sourceRoot":"","sources":["../../../../../packages/http/http-client/src/ClientFactory.ts"],"names":[],"mappings":";;AA+BA,oCA4CC;AA3ED,kDAA+E;AAc/E;;;;;;;;;;;;;;;;GAgBG;AACH,SAAgB,YAAY,CAC1B,YAAyC,EACzC,MAAoB;IAEpB,+DAA+D;IAC/D,IAAI,CAAC,IAAA,yBAAc,EAAC,YAAY,CAAC,EAAE,CAAC;QAClC,MAAM,SAAS,GAAG,YAAY,CAAC,IAAI,IAAI,SAAS,CAAC;QACjD,MAAM,IAAI,KAAK,CACb,SAAS,SAAS,yCAAyC,CAC5D,CAAC;IACJ,CAAC;IAED,wCAAwC;IACxC,MAAM,MAAM,GAAG,IAAA,oBAAS,EAAC,YAAY,CAAC,CAAC;IAEvC,gEAAgE;IAChE,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAyB,CAAC;IAClD,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;QAC3B,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;IACxC,CAAC;IAED,iDAAiD;IACjD,MAAM,SAAS,GAAG,MAAM,CAAC,KAAK,IAAI,KAAK,CAAC;IAExC,sEAAsE;IACtE,OAAO,IAAI,KAAK,CAAC,EAAO,EAAE;QACxB,GAAG,CAAC,MAAM,EAAE,IAAqB;YAC/B,+CAA+C;YAC/C,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;gBAC7B,OAAO,SAAS,CAAC;YACnB,CAAC;YAED,yCAAyC;YACzC,MAAM,KAAK,GAAG,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YACjC,IAAI,CAAC,KAAK,EAAE,CAAC;gBACX,MAAM,IAAI,KAAK,CAAC,6BAA6B,IAAI,EAAE,CAAC,CAAC;YACvD,CAAC;YAED,gDAAgD;YAChD,OAAO,KAAK,EAAE,GAAG,IAAW,EAAE,EAAE;gBAC9B,OAAO,WAAW,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;YACrD,CAAC,CAAC;QACJ,CAAC;KACF,CAAC,CAAC;AACL,CAAC;AAED;;GAEG;AACH,KAAK,UAAU,WAAW,CACxB,SAAuB,EACvB,MAAoB,EACpB,KAAoB,EACpB,IAAW;IAEX,MAAM,EAAE,UAAU,EAAE,IAAI,EAAE,GAAG,KAAK,CAAC;IAEnC,qBAAqB;IACrB,MAAM,GAAG,GAAG,GAAG,MAAM,CAAC,OAAO,GAAG,IAAI,EAAE,CAAC;IAEvC,gBAAgB;IAChB,MAAM,OAAO,GAA2B;QACtC,cAAc,EAAE,kBAAkB;QAClC,GAAG,MAAM,CAAC,OAAO;KAClB,CAAC;IAEF,wBAAwB;IACxB,MAAM,OAAO,GAAgB;QAC3B,MAAM,EAAE,UAAU;QAClB,OAAO;KACR,CAAC;IAEF,wDAAwD;IACxD,IAAI,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACrE,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IACzC,CAAC;IAED,wBAAwB;IACxB,MAAM,QAAQ,GAAG,MAAM,SAAS,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;IAE/C,wBAAwB;IACxB,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;QACjB,MAAM,SAAS,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QACxC,MAAM,IAAI,KAAK,CACb,QAAQ,QAAQ,CAAC,MAAM,KAAK,QAAQ,CAAC,UAAU,KAAK,SAAS,EAAE,CAChE,CAAC;IACJ,CAAC;IAED,qCAAqC;IACrC,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAC;AACzB,CAAC"}

package/src/index.d.ts

@@ -0,0 +1,34 @@
+/**
+ * @webpieces/http-client
+ *
+ * Client-side HTTP client generation package.
+ * Reads API decorators and generates type-safe HTTP clients.
+ *
+ * This is the client-side counterpart to @webpieces/http-routing:
+ * - Server (@webpieces/http-routing): API decorators → route HTTP to controllers
+ * - Client (@webpieces/http-client): API decorators → generate HTTP from method calls
+ *
+ * Both packages depend on @webpieces/http-api for shared decorator definitions.
+ *
+ * Architecture:
+ * ```
+ * http-api (defines the contract)
+ *    ↑
+ *    ├── http-routing (server: contract → handlers)
+ *    └── http-client (client: contract → HTTP requests)  ← YOU ARE HERE
+ * ```
+ *
+ * Usage:
+ * ```typescript
+ * import { createClient } from '@webpieces/http-client';
+ * import { SaveApiPrototype } from './api/SaveApi';
+ *
+ * const client = createClient(SaveApiPrototype, {
+ *   baseUrl: 'http://localhost:3000'
+ * });
+ *
+ * const response = await client.save({ query: 'test' });
+ * ```
+ */
+export { createClient, ClientConfig } from './ClientFactory';
+export { ApiInterface, Get, Post, Put, Delete, Patch, Path, ValidateImplementation, } from '@webpieces/http-api';

package/src/index.js

@@ -0,0 +1,47 @@
+"use strict";
+/**
+ * @webpieces/http-client
+ *
+ * Client-side HTTP client generation package.
+ * Reads API decorators and generates type-safe HTTP clients.
+ *
+ * This is the client-side counterpart to @webpieces/http-routing:
+ * - Server (@webpieces/http-routing): API decorators → route HTTP to controllers
+ * - Client (@webpieces/http-client): API decorators → generate HTTP from method calls
+ *
+ * Both packages depend on @webpieces/http-api for shared decorator definitions.
+ *
+ * Architecture:
+ * ```
+ * http-api (defines the contract)
+ *    ↑
+ *    ├── http-routing (server: contract → handlers)
+ *    └── http-client (client: contract → HTTP requests)  ← YOU ARE HERE
+ * ```
+ *
+ * Usage:
+ * ```typescript
+ * import { createClient } from '@webpieces/http-client';
+ * import { SaveApiPrototype } from './api/SaveApi';
+ *
+ * const client = createClient(SaveApiPrototype, {
+ *   baseUrl: 'http://localhost:3000'
+ * });
+ *
+ * const response = await client.save({ query: 'test' });
+ * ```
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Path = exports.Patch = exports.Delete = exports.Put = exports.Post = exports.Get = exports.ApiInterface = exports.createClient = void 0;
+var ClientFactory_1 = require("./ClientFactory");
+Object.defineProperty(exports, "createClient", { enumerable: true, get: function () { return ClientFactory_1.createClient; } });
+// Re-export API decorators for convenience (same as http-routing does)
+var http_api_1 = require("@webpieces/http-api");
+Object.defineProperty(exports, "ApiInterface", { enumerable: true, get: function () { return http_api_1.ApiInterface; } });
+Object.defineProperty(exports, "Get", { enumerable: true, get: function () { return http_api_1.Get; } });
+Object.defineProperty(exports, "Post", { enumerable: true, get: function () { return http_api_1.Post; } });
+Object.defineProperty(exports, "Put", { enumerable: true, get: function () { return http_api_1.Put; } });
+Object.defineProperty(exports, "Delete", { enumerable: true, get: function () { return http_api_1.Delete; } });
+Object.defineProperty(exports, "Patch", { enumerable: true, get: function () { return http_api_1.Patch; } });
+Object.defineProperty(exports, "Path", { enumerable: true, get: function () { return http_api_1.Path; } });
+//# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../packages/http/http-client/src/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;;;AAEH,iDAA6D;AAApD,6GAAA,YAAY,OAAA;AAErB,uEAAuE;AACvE,gDAS6B;AAR3B,wGAAA,YAAY,OAAA;AACZ,+FAAA,GAAG,OAAA;AACH,gGAAA,IAAI,OAAA;AACJ,+FAAA,GAAG,OAAA;AACH,kGAAA,MAAM,OAAA;AACN,iGAAA,KAAK,OAAA;AACL,gGAAA,IAAI,OAAA"}