{"id":41770570,"url":"https://github.com/tojoo-dev/akmj","last_synced_at":"2026-01-25T03:05:37.650Z","repository":{"id":267601807,"uuid":"893389133","full_name":"tojoo-dev/akmj","owner":"tojoo-dev","description":"API Kit for Modern JavaScript - A sleek, type-safe HTTP client for modern JavaScript.","archived":false,"fork":false,"pushed_at":"2025-05-06T08:16:01.000Z","size":235,"stargazers_count":2,"open_issues_count":0,"forks_count":1,"subscribers_count":0,"default_branch":"current","last_synced_at":"2025-10-26T05:52:56.826Z","etag":null,"topics":["rest-api","simplification","typesafe","typescript"],"latest_commit_sha":null,"homepage":"https://npmjs.com/package/akmj","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tojoo-dev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-11-24T10:14:31.000Z","updated_at":"2025-05-06T08:16:04.000Z","dependencies_parsed_at":null,"dependency_job_id":"27460edf-0090-46f7-84a8-5095a303b74e","html_url":"https://github.com/tojoo-dev/akmj","commit_stats":null,"previous_names":["tojoo-dev/akmj"],"tags_count":8,"template":false,"template_full_name":null,"purl":"pkg:github/tojoo-dev/akmj","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tojoo-dev%2Fakmj","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tojoo-dev%2Fakmj/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tojoo-dev%2Fakmj/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tojoo-dev%2Fakmj/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tojoo-dev","download_url":"https://codeload.github.com/tojoo-dev/akmj/tar.gz/refs/heads/current","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tojoo-dev%2Fakmj/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28742973,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-25T02:46:29.005Z","status":"ssl_error","status_checked_at":"2026-01-25T02:44:29.968Z","response_time":113,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["rest-api","simplification","typesafe","typescript"],"created_at":"2026-01-25T03:05:37.584Z","updated_at":"2026-01-25T03:05:37.642Z","avatar_url":"https://github.com/tojoo-dev.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# **AKMJ: API Kit for Modern JavaScript**\n\n[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Ftojoo-dev%2Fakmj.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Ftojoo-dev%2Fakmj?ref=badge_shield)\n\n\u003e [!WARNING]\n\u003e This library is still in experimental stage, API changes may occur without warning.\n\n\"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.\n\n### Key Features\n\n- **Type-Safe Interactions**: Full TypeScript support with automatic type inference\n- **Declarative API Definitions**: Clean, structured format to define your API routes\n- **Path Parameter Inference**: Automatically extracts and types path parameters\n- **Dynamic Method Calls**: Intuitive syntax (e.g., `client.auth.$login({ email, password })`) based on API definitions\n- **Request Lifecycle Hooks**: Built-in support for request/response lifecycle events\n- **Small Footprint**: Lightweight core powered by [Ky](https://github.com/sindresorhus/ky)\n\n## Installation\n\n```bash\n# npm\nnpm install akmj\n\n# pnpm\npnpm add akmj\n\n# yarn\nyarn add akmj\n```\n\n## Usage\n\n### Basic Setup\n\n```typescript\nimport { createClient, type AkmjDefinition } from \"akmj\";\n\nconst api = {\n  auth: {\n    $login: {\n      method: \"post\",\n      path: \"/login\",\n      types: {\n        request: akmj.object({\n          email: akmj.string(),\n          password: akmj.string(),\n        }),\n        response: {\n          200: akmj.object({\n            token: akmj.string(),\n          }),\n        },\n      },\n    },\n  },\n} as const satisfies AkmjDefinition;\n\nconst client = createClient({\n  baseUrl: \"https://api.example.com\",\n  api,\n});\n\n// Use the client\nconst { token } = await client.auth.$login({\n  email: \"user@example.com\",\n  password: \"password\",\n});\n```\n\n### Path Parameters\n\nParameters in the URL path are automatically inferred from `:param` syntax:\n\n```typescript\nconst api = {\n  users: {\n    $getUser: {\n      method: \"get\",\n      path: \"/users/:id\",\n      types: {\n        request: akmj.object({\n          include: akmj.string().optional(),\n        }),\n        response: {\n          200: akmj.object({\n            id: akmj.string(),\n            name: akmj.string(),\n          }),\n        },\n      },\n    },\n  },\n} as const satisfies AkmjDefinition;\n\n// Usage\nconst user = await client.users.$getUser(\n  { id: \"123\" }, // Path parameters\n  { include: \"profile\" } // Query parameters\n);\n```\n\n### Type Utilities\n\nAKMJ provides several type utilities to define your API schema:\n\n```typescript\n// Array types\nakmj.string().array(); // string[]\nakmj.object({ id: akmj.string() }).array(); // Array\u003c{ id: string }\u003e\n\n// Optional fields\nakmj.string().optional(); // string | undefined\n\n// Nullable fields\nakmj.string().nullable(); // string | null\n```\n\n## Advanced Configuration\n\nFor additional options and hooks, refer to [Ky documentation](https://github.com/sindresorhus/ky#options).\n\n## Roadmap\n\n- [x] Automatic path parameter type inference\n- [ ] RPC-style client support (`GET /users/1` as `client.users({ id: 1 }).$get()`)\n- [ ] Enum, union, and intersection types\n- [ ] Comprehensive test suite\n\n## Contributing\n\nContributions are welcome! Please feel free to submit a Pull Request.\n\n## License\n\n[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Ftojoo-dev%2Fakmj.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Ftojoo-dev%2Fakmj?ref=badge_large)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftojoo-dev%2Fakmj","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftojoo-dev%2Fakmj","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftojoo-dev%2Fakmj/lists"}