@llamaduck/forgejo-ts 11.0.10 → 14.0.2-1

package/README.md

@@ -16,141 +16,139 @@ pnpm add @llamaduck/forgejo-ts
 
 ## Usage
 
-### Basic Configuration
+### Basic Usage
+
+Create a client and start making API calls:
 
 ```typescript
-import { configure, RepositoryService, UserService } from '@llamaduck/forgejo-ts';
+import { createClient, createConfig, getVersion, repoSearch } from '@llamaduck/forgejo-ts';
+
+// Create a client
+const client = createClient(createConfig({
+  baseUrl: 'https://codeberg.org/api/v1',
+  headers: { Authorization: 'token your-api-token' }
+}));
 
-// Configure the client
-configure({
-  baseUrl: 'https://your-forgejo-instance.com/api/v1',
-  token: 'your-api-token', // Optional: for authenticated requests
-});
+// Make API calls - pass the client in options
+const version = await getVersion({ client });
+console.log('Server version:', version.data?.version);
 
-// Now use any service
-const repos = await RepositoryService.repoSearch({ q: 'hello' });
-console.log(repos);
+const repos = await repoSearch({ query: { q: 'typescript', limit: 10 } }, { client });
+console.log('Found repos:', repos.data);
 ```
 
-### Authentication Options
+### Multiple Clients
+
+You can create multiple independent client instances:
 
 ```typescript
-import { configure } from '@llamaduck/forgejo-ts';
+import { createClient, createConfig, repoSearch } from '@llamaduck/forgejo-ts';
 
-// Token authentication (recommended)
-configure({
-  baseUrl: 'https://your-forgejo-instance.com/api/v1',
-  token: 'your-personal-access-token',
-});
+const clientA = createClient(createConfig({
+  baseUrl: 'https://codeberg.org/api/v1',
+  headers: { Authorization: 'token token-a' }
+}));
 
-// Basic authentication
-configure({
-  baseUrl: 'https://your-forgejo-instance.com/api/v1',
-  username: 'your-username',
-  password: 'your-password',
-});
-```
+const clientB = createClient(createConfig({
+  baseUrl: 'https://gitea.com/api/v1',
+  headers: { Authorization: 'token token-b' }
+}));
 
-### Direct OpenAPI Configuration
+// Use different clients for different requests
+const reposA = await repoSearch({ query: { q: 'test' } }, { client: clientA });
+const reposB = await repoSearch({ query: { q: 'test' } }, { client: clientB });
+```
 
-For more control, you can configure the OpenAPI object directly:
+### Authentication
 
 ```typescript
-import { OpenAPI } from '@llamaduck/forgejo-ts';
+import { createClient, createConfig } from '@llamaduck/forgejo-ts';
 
-OpenAPI.BASE = 'https://your-forgejo-instance.com/api/v1';
-OpenAPI.TOKEN = 'your-api-token';
+// Token authentication (recommended)
+const client = createClient(createConfig({
+  baseUrl: 'https://codeberg.org/api/v1',
+  headers: { Authorization: 'token your-personal-access-token' }
+}));
 
-// Or use a function for dynamic token retrieval
-OpenAPI.TOKEN = async () => {
-  return getTokenFromSomewhere();
-};
+// Basic authentication
+const auth = btoa('username:password');
+const client = createClient(createConfig({
+  baseUrl: 'https://codeberg.org/api/v1',
+  headers: { Authorization: `Basic ${auth}` }
+}));
 ```
 
-### Using Services
+## API Reference
 
-All API endpoints are organized into services:
+All API functions are exported directly from the package:
 
 ```typescript
 import {
-  RepositoryService,
-  UserService,
-  OrganizationService,
-  IssueService,
-  AdminService,
-  // ... and more
+  // Repositories
+  repoSearch,
+  repoGet,
+  userListRepos,
+  
+  // Users
+  userGetCurrent,
+  userGet,
+  
+  // Issues
+  issueSearch,
+  issueCreateIssue,
+  
+  // Organizations
+  orgGet,
+  
+  // And many more...
 } from '@llamaduck/forgejo-ts';
-
-// Get current user
-const user = await UserService.userGetCurrent();
-
-// List repositories
-const repos = await RepositoryService.repoSearch({
-  q: 'typescript',
-  limit: 10,
-});
-
-// Create an issue
-const issue = await IssueService.issueCreateIssue({
-  owner: 'username',
-  repo: 'repo-name',
-  body: {
-    title: 'Bug report',
-    body: 'Description of the bug',
-  },
-});
 ```
 
-### Error Handling
+Each function accepts:
+1. **Data/params** - The request data (path params, query params, body)
+2. **Options** (optional) - Request options including the `client` instance
 
+Example:
 ```typescript
-import { ApiError, RepositoryService } from '@llamaduck/forgejo-ts';
+// Search repositories
+const repos = await repoSearch(
+  { query: { q: 'typescript', limit: 10 } },
+  { client }
+);
+
+// Get a specific repository
+const repo = await repoGet(
+  { path: { owner: 'forgejo', repo: 'forgejo' } },
+  { client }
+);
 
-try {
-  const repo = await RepositoryService.repoGet({
-    owner: 'user',
-    repo: 'nonexistent',
-  });
-} catch (error) {
-  if (error instanceof ApiError) {
-    console.error('API Error:', error.status, error.message);
-    console.error('Response body:', error.body);
-  }
-}
+// Create an issue
+const issue = await issueCreateIssue(
+  { path: { owner: 'user', repo: 'repo' } },
+  { body: { title: 'Bug report', body: 'Description' } },
+  { client }
+);
 ```
 
-### Canceling Requests
+### Error Handling
 
 ```typescript
-import { RepositoryService, CancelError } from '@llamaduck/forgejo-ts';
-
-const request = RepositoryService.repoSearch({ q: 'test' });
-
-// Cancel the request
-request.cancel();
+import { repoGet } from '@llamaduck/forgejo-ts';
 
 try {
-  await request;
+  const repo = await repoGet(
+    { path: { owner: 'user', repo: 'nonexistent' } },
+    { client }
+  );
 } catch (error) {
-  if (error instanceof CancelError) {
-    console.log('Request was canceled');
+  if (error.status === 404) {
+    console.error('Repository not found');
+  } else {
+    console.error('API Error:', error);
   }
 }
 ```
 
-## Available Services
-
-- `ActivitypubService` - ActivityPub federation endpoints
-- `AdminService` - Administration endpoints (requires admin access)
-- `IssueService` - Issues and pull requests
-- `MiscellaneousService` - Miscellaneous endpoints (version, settings, etc.)
-- `NotificationService` - User notifications
-- `OrganizationService` - Organizations and teams
-- `PackageService` - Package registry
-- `RepositoryService` - Repositories, branches, commits, files
-- `SettingsService` - Instance settings
-- `UserService` - Users, followers, tokens, keys
-
 ## Version Information
 
 ```typescript
@@ -189,8 +187,6 @@ FORGEJO_VERSION=14.0.2 npm run generate
 npm run build
 ```
 
-The script fetches the Swagger spec directly from Codeberg. 
-
 ## Configuration
 
 The `config.json` file specifies which major versions to track: