Setup

Author: owjs3901

.gitignore

@@ -0,0 +1,34 @@
+# dependencies (bun install)
+node_modules
+
+# output
+out
+dist
+*.tgz
+
+# code coverage
+coverage
+*.lcov
+
+# logs
+logs
+_.log
+report.[0-9]_.[0-9]_.[0-9]_.[0-9]_.json
+
+# dotenv environment variable files
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# caches
+.eslintcache
+.cache
+*.tsbuildinfo
+
+# IntelliJ based IDEs
+.idea
+
+# Finder (MacOS) folder config
+.DS_Store

README.md

@@ -0,0 +1,134 @@
+# Devup API
+
+**A fully typed API client generator powered by OpenAPI.  
+Fetch-compatible, auto-generated types, zero generics required.**
+
+Devup API reads your `openapi.json` file and automatically generates a fully typed client that behaves like an ergonomic, type-safe version of `fetch()`.  
+No manual type declarations. No generics. No SDK boilerplate.  
+Just write API calls — the types are already there.
+
+---
+
+## ✨ Features
+
+### **🔍 OpenAPI-driven type generation**
+- Reads `openapi.json` and transforms every path, method, schema into typed API functions.
+- Parameters, request bodies, headers, responses — all typed automatically.
+- No need to write or maintain separate TypeScript definitions.
+
+### **🪝 Fetch-compatible design**
+Devup API feels like using `fetch`, but with superpowers:
+
+- Path params automatically replaced  
+- Query/body/header types enforced  
+- Typed success & error responses  
+- Optional runtime schema validation  
+- Minimal abstraction over standard fetch
+
+---
+
+## 🚀 Quick Start
+
+### **1. Initialize the client**
+
+```ts
+import { devupApi } from "devup-api";
+
+// create api instance
+const api = await devupApi("https://api.example.com");
+```
+
+### **2. Call endpoints — types are automatic**
+
+```ts
+const user = await api.get("/users/{id}", {
+  params: { id: "123" },
+  headers: {
+    Authorization: "Bearer TOKEN"
+  }
+});
+
+const user = await api.get("getUser", {
+  params: { id: "123" },
+  headers: {
+    Authorization: "Bearer TOKEN"
+  }
+});
+```
+
+---
+
+## 📦 Installation
+
+```bash
+npm install @devup-api/fetch
+
+npm install @devup-api/next-plugin
+npm install @devup-api/webpack-plugin
+npm install @devup-api/rsbuild-plugin
+npm install @devup-api/vite-plugin
+```
+
+---
+
+## 📚 API Usage
+
+### **GET Example**
+
+```ts
+await api.get("/posts", {
+  query: { page: 1, limit: 20 }
+});
+```
+
+### **POST Example**
+
+```ts
+await api.post("/posts", {
+  body: {
+    title: "Hello World",
+    content: "This is a typed API request."
+  }
+});
+```
+
+### **Path Params Example**
+
+```ts
+await api.get("/posts/{id}", {
+  params: { id: "777" }
+});
+```
+
+---
+
+## ⚙️ How It Works
+
+1. Download `openapi.json`
+2. Extract paths, methods, schemas, parameters, bodies
+3. Generate TypeScript types automatically
+4. Build a typed wrapper around `fetch()`
+5. Expose methods based on the API structure
+
+---
+
+## 🎯 Why Devup API?
+
+- No code generators
+- No build steps
+- No boilerplate
+- Uses OpenAPI schema directly  
+- Works in Next.js, Bun, Vite, rsbuild
+
+---
+
+## 🛠️ Roadmap
+
+- [ ] Typescript interface generation
+- [ ] Zod schema generation
+
+---
+
+## 📄 License
+
+Apache 2.0

bun.lock

@@ -0,0 +1,21 @@
+{
+  "lockfileVersion": 1,
+  "configVersion": 1,
+  "workspaces": {
+    "": {
+      "name": "devup-api",
+      "devDependencies": {
+        "@types/bun": "latest",
+      },
+    },
+  },
+  "packages": {
+    "@types/bun": ["@types/[email protected]", "", { "dependencies": { "bun-types": "1.3.3" } }, "sha512-ogrKbJ2X5N0kWLLFKeytG0eHDleBYtngtlbu9cyBKFtNL3cnpDZkNdQj8flVf6WTZUX5ulI9AY1oa7ljhSrp+g=="],
+
+    "@types/node": ["@types/[email protected]", "", { "dependencies": { "undici-types": "~7.16.0" } }, "sha512-GNWcUTRBgIRJD5zj+Tq0fKOJ5XZajIiBroOF0yvj2bSU1WvNdYS/dn9UxwsujGW4JX06dnHyjV2y9rRaybH0iQ=="],
+
+    "bun-types": ["[email protected]", "", { "dependencies": { "@types/node": "*" } }, "sha512-z3Xwlg7j2l9JY27x5Qn3Wlyos8YAp0kKRlrePAOjgjMGS5IG6E7Jnlx736vH9UVI4wUICwwhC9anYL++XeOgTQ=="],
+
+    "undici-types": ["[email protected]", "", {}, "sha512-Zz+aZWSj8LE6zoxD+xrjh4VfkIG8Ya6LvYkZqtUQGJPZjYl53ypCaUwWqo7eI0x66KBGeRo+mlBEkMSeSZ38Nw=="],
+  }
+}

index.ts

@@ -0,0 +1 @@
+console.log("Hello via Bun!");

package.json

@@ -0,0 +1,12 @@
+{
+  "name": "devup-api",
+  "module": "index.ts",
+  "type": "module",
+  "private": true,
+  "devDependencies": {
+    "@types/bun": "latest"
+  },
+  "workspaces": [
+    "packages/*"
+  ]
+}

tsconfig.json

@@ -0,0 +1,29 @@
+{
+  "compilerOptions": {
+    // Environment setup & latest features
+    "lib": ["ESNext"],
+    "target": "ESNext",
+    "module": "Preserve",
+    "moduleDetection": "force",
+    "jsx": "react-jsx",
+    "allowJs": true,
+
+    // Bundler mode
+    "moduleResolution": "bundler",
+    "allowImportingTsExtensions": true,
+    "verbatimModuleSyntax": true,
+    "noEmit": true,
+
+    // Best practices
+    "strict": true,
+    "skipLibCheck": true,
+    "noFallthroughCasesInSwitch": true,
+    "noUncheckedIndexedAccess": true,
+    "noImplicitOverride": true,
+
+    // Some stricter flags (disabled by default)
+    "noUnusedLocals": false,
+    "noUnusedParameters": false,
+    "noPropertyAccessFromIndexSignature": false
+  }
+}