akmj v0.0.3

AKMJ: API Kit for Modern JavaScript

Request and response type safe only support primitive types in ^v.0.1.0-next.0!!!

AKMJ is a lightweight and powerful library designed to streamline API integration in modern JavaScript applications. With a focus on simplicity, flexibility, and type safety, AKMJ empowers developers to define and interact with RESTful APIs efficiently while maintaining robust code quality.

Key Features:

• Declarative API Definitions: Use a clean, structured format to define your API routes, parameters, and methods.
• Type-Safe Interactions: Leverage TypeScript support to ensure request and response data align with your API schema.
• Dynamic Proxy-based API Calls: Access endpoints with intuitive syntax, e.g., client.auth.$login({ email, password }).
• Request Lifecycle Management: Easily manage headers, query parameters, and hooks for request/response lifecycle events.
• Extensible Design: Customize behaviors like error handling, retries, and middleware with ease.
• Small Footprint: Lightweight and optimized for modern JavaScript frameworks and libraries.

Inspired by Tuyau and powered by Ky.

Usage

Install

npm install akmj

Quick Start

You can directly input api route in createClient or create separate variable for it, you have to define it as satisfies AkmjDefinition type.

import type { AkmjDefinition, MakeApiDefinition } from "akmj";

const api: AkmjDefinition = {
  auth: {
    $login: {
      method: "post",
      path: "/login",
      types: {} as MakeApiDefinition<
        {
          email: string;
          password: string;
        },
        {
          token: string;
        }
      >,
    },
  },
} satisfies AkmjDefinition;

Pass it to createClient function and you're ready to go!

import { createClient } from "akmj";

const client = createClient({
  baseUrl: "https://api.example.com",
  api,
  // other options
});

const data = await client.auth.$login({
  email: "user@example.com",
  password: "password",
});

console.log(data);
// { token: "token here"}

Type-safe Request and Response

import { akmj, createClient } from "akmj";

const api: AkmjDefinition = {
  auth: {
    $login: {
      method: "post",
      path: "/login",
      types: {
        request: akmj.object({
          email: akmj.string(),
          password: akmj.string(),
          secret: akmj
            .object({
              key: akmj.string(),
            })
            .optional(),
        }),
        response: {
          200: akmj.object({
            token: akmj.string(),
          }),
        },
      },
    },
  },
};

Currently, only supported types are primitive types.

Array Type

Make an array type from existing type

akmj.string().array();

or from object type

akmj
  .object({
    key: akmj.string(),
  })
  .array();

Nullable Type

akmj.string().nullable();

Some options you can find in ky and ky hooks.

Contributing

Contributions are welcome! If you find a bug or have a feature request, please open an issue or submit a pull request on the GitHub repository.

License