ts-typed-api 0.1.0

package/.eslintrc.json

@@ -0,0 +1,16 @@
+{
+  "root": true,
+  "parser": "@typescript-eslint/parser",
+  "plugins": [
+    "@typescript-eslint"
+  ],
+  "extends": [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/recommended"
+  ],
+  "rules": {
+    "no-console": "warn",
+    "@typescript-eslint/no-explicit-any": "warn",
+    "no-unused-vars": "warn"
+  }
+}

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,181 @@
+# ts-typed-api 🚀
+
+A lightweight, type-safe API library for TypeScript with Zod validation.
+
+## Motivation
+
+After building several full-stack applications, I discovered that Large Language Models (LLMs) face significant challenges when implementing features that span both backend and frontend components, particularly around API interfaces.
+
+The core issues I observed:
+- **API Contract Drift**: LLMs struggle to maintain consistency when defining an API endpoint and then implementing its usage in the frontend
+- **Context Loss**: Without a clear, shared contract, LLMs lack the contextual assistance needed to ensure proper integration between client and server
+- **Integration Errors**: The disconnect between backend definitions and frontend consumption leads to runtime errors that could be prevented
+
+**The Solution**: Leverage TypeScript's powerful type system to provide real-time feedback and compile-time validation for both LLMs and developers. By creating a shared contract that enforces consistency across the entire stack, we eliminate the guesswork and reduce integration issues.
+
+## 🤖 Built for LLM-Assisted Development
+
+This module is specifically designed to make coding with Large Language Models (LLMs) easier and more efficient. When working on bigger applications with extensive APIs, maintaining context becomes challenging for both developers and AI assistants. ts-typed-api solves this by:
+
+### 🔑 Key Benefits for LLM Development
+- **Centralized Type Definitions**: Keep all API contracts in one place, making it easier for LLMs to understand your entire API surface
+- **Automatic Type Synchronization**: The type system ensures both client and server stay perfectly in sync, preventing the drift that commonly occurs in large codebases. Compile-time checks prevent the common client-server mismatches that occur in AI-assisted development
+- **Context-Friendly Structure**: Organized domain-based API definitions that LLMs can easily parse and understand
+- **Compile-Time Validation**: Catch integration issues before runtime, reducing the debugging cycles when working with AI-generated code
+- **Self-Documenting**: Type definitions serve as living documentation that LLMs can easily parse
+
+## 📦 Installation
+
+```bash
+npm install ts-typed-api
+```
+
+
+## How to use it?
+1. Define your API in a file that will be shared by both the server and the client
+2. Implement handlers in the server, leveraging the type system and request/response validation
+3. Implement the client based on the contract from #1 leveraging type system
+
+
+## Examples
+
+Check out the `examples/` directory:
+- `simple/` - Basic usage with ping endpoints and middleware
+- `advanced/` - Complex schemas with authentication, CRUD operations, and file uploads
+
+## 🚀 Quick Start
+
+### 1. Define API Routes with Domains
+
+Create your API definitions organized by logical domains:
+
+```typescript
+// definitions.ts
+import { ZodSchema as z, CreateApiDefinition, CreateResponses } from 'ts-typed-api';
+
+// you can create multiple definitions per app
+export const PublicApiDefinition = CreateApiDefinition({
+    prefix: '/api/v1/public',
+    endpoints: {
+        common: { // domain name
+            ping: { // endpoint name
+                method: 'GET',
+                path: '/ping',
+                // validate route parameters with Zod
+                params: z.object({}),
+                // validate query parameters with Zod
+                query: z.object({}), 
+                // validate body with Zod
+                body: z.object({}),
+                // validate query parameters with Zod
+                responses: CreateResponses({
+                    // specify response codes and response shapes
+                    200: z.enum(["pong"]),
+                    201: z.boolean()
+                })
+            },
+        }
+    }
+});
+```
+
+### 2. Implement Server-Side Handlers
+
+Register handlers with full type safety and middleware support:
+
+```typescript
+// server.ts
+import express from 'express';
+import { RegisterHandlers, EndpointMiddleware } from 'ts-typed-api';
+import { PublicApiDefinition } from './definitions';
+
+const app = express();
+app.use(express.json());
+
+// Example middleware with endpoint information
+const loggingMiddleware: EndpointMiddleware = (req, res, next, endpointInfo) => {
+    console.log(`[${new Date().toISOString()}] ${req.method} ${req.path} - Endpoint: ${endpointInfo.domain}.${endpointInfo.routeKey}`);
+    next();
+};
+
+// Register handlers with TypeScript enforcing all required handlers are present
+RegisterHandlers(app, PublicApiDefinition, {
+    common: {
+        ping: async (req, res) => {
+            console.log('Ping endpoint called');
+            res.respond(200, "pong");
+        }
+    },
+}, [loggingMiddleware]);
+
+app.listen(3001, () => {
+    console.log('Server running on http://localhost:3001');
+});
+```
+
+### 3. Type-Safe Client Calls
+
+Make API calls with full type safety and response handling:
+
+```typescript
+// client.ts
+import { ApiClient, FetchHttpClientAdapter } from 'ts-typed-api';
+import { PublicApiDefinition } from './definitions';
+
+async function runClientExample(): Promise<void> {
+    const apiClient = new ApiClient('http://localhost:3001', PublicApiDefinition);
+
+    // Type-safe API calls with response handlers
+    await apiClient.callApi('common', 'ping', {}, {
+        // you have to handle each possible status code defined in your contract
+        200: (payload) => {
+            console.log('Success:', payload); // payload is typed as "pong"
+        },
+        201: (payload) => {
+            console.log('Success:', payload); // payload is typed as boolean
+        },
+        // you always need to handle 422 since it's returned on request validation
+        422: (payload) => {
+            console.log('Request validation error:', payload);
+        }
+    });
+}
+```
+
+**Now both server and client are type safe and in sync! The moment you change the definition of the API, type system will let you know about potential changes you need to handle (like additional response code or a change request body schema).**
+
+## 🌟 Features
+
+### Custom HTTP Client Adapters
+
+Create custom HTTP client adapters by implementing the `HttpClientAdapter` interface:
+
+```typescript
+interface HttpClientAdapter {
+  request<T = any>(url: string, options: HttpRequestOptions): Promise<HttpResponse<T>>;
+}
+```
+
+### Middleware System
+
+Add cross-cutting concerns like authentication, logging, and validation:
+
+```typescript
+const customMiddleware: EndpointMiddleware = (req, res, next, endpointInfo) => {
+    // Access to endpoint metadata
+    console.log(`Domain: ${endpointInfo.domain}, Route: ${endpointInfo.routeKey}`);
+    next();
+};
+```
+
+## Roadmap
+
+- OpenAPI generation with dynamic documentation based on Swagger
+
+## 🤝 Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## 📄 License
+
+Apache 2.0 License

package/dist/apiClient.d.ts

@@ -0,0 +1,147 @@
+import { type ApiDefinitionSchema as BaseApiDefinitionSchema, // Renamed for clarity
+type ApiRouteKey, type ApiClientParams, type ApiClientQuery, type ApiClientBody, type RouteSchema, type UnifiedError, type InferDataFromUnifiedResponse } from "./router/definition";
+import { type ZodTypeAny } from 'zod';
+/**
+ * Options for an HTTP request made by an adapter.
+ */
+export interface HttpRequestOptions {
+    method: RouteSchema['method'];
+    headers?: Record<string, string>;
+    body?: string | FormData;
+}
+/**
+ * Represents an HTTP response from an adapter.
+ * @template T The expected type of the JSON body.
+ */
+export interface HttpResponse<T = any> {
+    status: number;
+    headers: Headers;
+    json(): Promise<T>;
+    text(): Promise<string>;
+    /**
+     * Gets the underlying raw response object from the adapter (e.g., Fetch API's Response object).
+     * The type of this object depends on the adapter implementation.
+     */
+    getRawResponse(): any;
+}
+/**
+ * Interface for an HTTP client adapter.
+ * Allows swapping out the underlying HTTP request mechanism (e.g., fetch, axios).
+ */
+export interface HttpClientAdapter {
+    /**
+     * Makes an HTTP request.
+     * @template T The expected type of the JSON response body.
+     * @param url The URL to request.
+     * @param options The request options.
+     * @returns A promise that resolves to an HttpResponse.
+     */
+    request<T = any>(url: string, options: HttpRequestOptions): Promise<HttpResponse<T>>;
+}
+/**
+ * An HttpClientAdapter implementation that uses the native Fetch API.
+ */
+export declare class FetchHttpClientAdapter implements HttpClientAdapter {
+    request<T = any>(url: string, options: HttpRequestOptions): Promise<HttpResponse<T>>;
+}
+type GetRoute<TActualDef extends BaseApiDefinitionSchema, TDomain extends keyof TActualDef, K extends ApiRouteKey<TActualDef, TDomain>> = TActualDef[TDomain][K] extends infer Rte ? Rte extends RouteSchema ? Rte : never : never;
+type GetResponses<Rte extends RouteSchema> = Rte['responses'];
+/**
+ * Discriminated union type for the result of callApi.
+ * @template TDef The specific ApiDefinition structure being used.
+ * @template TDomain The domain (controller) of the API.
+ * @template TRouteKey The key of the route within the domain.
+ */
+type ApiCallResultPayload<S_STATUS_NUM extends number, ActualSchema extends ZodTypeAny> = S_STATUS_NUM extends 422 ? {
+    status: S_STATUS_NUM;
+    error: UnifiedError;
+    rawResponse: any;
+    data?: undefined;
+} : S_STATUS_NUM extends 204 ? {
+    status: S_STATUS_NUM;
+    data: void;
+    rawResponse: any;
+    error?: undefined;
+} : {
+    status: S_STATUS_NUM;
+    data: InferDataFromUnifiedResponse<ActualSchema>;
+    rawResponse: any;
+    error?: undefined;
+};
+export type ApiCallResult<TActualDef extends BaseApiDefinitionSchema, TDomain extends keyof TActualDef, TRouteKey extends ApiRouteKey<TActualDef, TDomain>, CurrentRoute extends RouteSchema = GetRoute<TActualDef, TDomain, TRouteKey>, ResponsesMap = GetResponses<CurrentRoute>> = ResponsesMap extends Record<any, ZodTypeAny> ? {
+    [S_STATUS_NUM in keyof ResponsesMap]: S_STATUS_NUM extends number ? ResponsesMap[S_STATUS_NUM] extends infer ActualSchema extends ZodTypeAny ? ApiCallResultPayload<S_STATUS_NUM, ActualSchema> : never : never;
+}[keyof ResponsesMap] : never;
+/**
+ * Options for the callApi method.
+ * @template TDef The specific ApiDefinition structure being used.
+ * @template TDomainParam The domain (controller) of the API.
+ * @template TRouteKeyParam The key of the route within the domain.
+ */
+export type CallApiOptions<TActualDef extends BaseApiDefinitionSchema, // Made generic over TActualDef
+TDomainParam extends keyof TActualDef, TRouteKeyParam extends ApiRouteKey<TActualDef, TDomainParam>> = {
+    params?: ApiClientParams<TActualDef, TDomainParam, TRouteKeyParam>;
+    query?: ApiClientQuery<TActualDef, TDomainParam, TRouteKeyParam>;
+    body?: ApiClientBody<TActualDef, TDomainParam, TRouteKeyParam>;
+    headers?: Record<string, string>;
+};
+/**
+ * A client for making API calls defined by an ApiDefinition.
+ * It uses an HttpClientAdapter for making actual HTTP requests and supports persistent headers.
+ */
+export declare class ApiClient<TActualDef extends BaseApiDefinitionSchema> {
+    private baseUrl;
+    private apiDefinitionObject;
+    private adapter;
+    private persistentHeaders;
+    /**
+     * Creates an instance of ApiClient.
+     * @param baseUrl The base URL for all API calls (e.g., 'http://localhost:3001').
+     * @param apiDefinitionObject The API definition object.
+     * @param adapter An instance of HttpClientAdapter to use for requests.
+     */
+    constructor(baseUrl: string, apiDefinitionObject: TActualDef, // Parameter uses TActualDef
+    adapter: HttpClientAdapter);
+    /**
+     * Sets a persistent header that will be included in all subsequent API calls.
+     * If the header already exists, its value will be updated.
+     * @param name The name of the header.
+     * @param value The value of the header.
+     */
+    setHeader(name: string, value: string): void;
+    /**
+     * Gets the value of a persistent header.
+     * @param name The name of the header.
+     * @returns The value of the header, or undefined if not set.
+     */
+    getHeader(name: string): string | undefined;
+    /**
+     * Removes a persistent header.
+     * @param name The name of the header to remove.
+     */
+    removeHeader(name: string): void;
+    /**
+     * Clears all persistent headers.
+     */
+    clearHeaders(): void;
+    /**
+     * Makes an API call to a specified domain and route.
+     * @template TDomain The domain (controller) of the API.
+     * @template TRouteKey The key of the route within the domain.
+     * @template TInferredHandlers A type inferred from the handlers object, ensuring all defined statuses are handled.
+     * @param domain The API domain (e.g., 'user').
+     * @param routeKey The API route key (e.g., 'getUsers').
+     * @param callData Optional parameters, query, body, and headers for the request.
+     * @param handlers An object where keys are status codes and values are handler functions for those statuses.
+     * @returns A promise that resolves to the return value of the executed handler.
+     * @throws Error if the route configuration is invalid, a network error occurs, an unhandled status code is received, or JSON parsing fails.
+     */
+    callApi<TDomain extends keyof TActualDef, TRouteKey extends ApiRouteKey<TActualDef, TDomain>, TInferredHandlers extends {
+        [KStatus in ApiCallResult<TActualDef, TDomain, TRouteKey>['status']]: (payload: Extract<ApiCallResult<TActualDef, TDomain, TRouteKey>, {
+            status: KStatus;
+        }>) => any;
+    }>(domain: TDomain, routeKey: TRouteKey, callData: CallApiOptions<TActualDef, TDomain, TRouteKey> | undefined, // Uses TActualDef
+    handlers: TInferredHandlers): Promise<{
+        [SKey in keyof TInferredHandlers]: TInferredHandlers[SKey] extends (...args: any[]) => infer R ? R : never;
+    }[keyof TInferredHandlers]>;
+}
+export {};