@nixopus/api-client 0.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE.md ADDED
@@ -0,0 +1,15 @@
1
+ # Functional Source License, Version 1.1, ALv2 Future License
2
+
3
+ ## Abbreviation
4
+
5
+ FSL-1.1-ALv2
6
+
7
+ ## Notice
8
+
9
+ Copyright 2025 Raghavendra Bhat
10
+
11
+ ## Terms and Conditions
12
+
13
+ This package is generated from the [Nixopus](https://github.com/raghavyuva/nixopus) OpenAPI specification and is subject to the same license as the Nixopus project.
14
+
15
+ See the full license at: https://github.com/raghavyuva/nixopus/blob/master/LICENSE.md
package/README.md ADDED
@@ -0,0 +1,51 @@
1
+ # @nixopus/api-client
2
+
3
+ TypeScript API client for [Nixopus](https://github.com/raghavyuva/nixopus), auto-generated from the OpenAPI spec.
4
+
5
+ ## Installation
6
+
7
+ ```bash
8
+ npm install @nixopus/api-client @hey-api/client-fetch
9
+ # or
10
+ yarn add @nixopus/api-client @hey-api/client-fetch
11
+ ```
12
+
13
+ ## Usage
14
+
15
+ ```typescript
16
+ import { createClient } from '@hey-api/client-fetch';
17
+ import { getApplications, getDeployments } from '@nixopus/api-client';
18
+
19
+ const client = createClient({
20
+ baseUrl: 'https://api.nixopus.com',
21
+ getRequestConfig: () => ({
22
+ headers: {
23
+ Authorization: `Bearer ${yourToken}`,
24
+ 'Content-Type': 'application/json',
25
+ },
26
+ }),
27
+ });
28
+
29
+ // Use the generated SDK functions
30
+ const applications = await getApplications({ client });
31
+ const deployments = await getDeployments({ client });
32
+ ```
33
+
34
+ ## Sync
35
+
36
+ This package is automatically regenerated and published when the OpenAPI spec changes in the [nixopus](https://github.com/raghavyuva/nixopus) repository.
37
+
38
+ ## Setup
39
+
40
+ 1. Create a new repo `nixopus/api-client` on GitHub (or use existing)
41
+ 2. Push this folder:
42
+ ```bash
43
+ cd nixopus-api-client
44
+ git init
45
+ git add .
46
+ git commit -m "Initial commit"
47
+ git remote add origin https://github.com/nixopus/api-client.git
48
+ git push -u origin master
49
+ ```
50
+ 3. Add secrets to the **nixopus** repo: `API_CLIENT_REPO_TOKEN` (GitHub PAT with `repo` scope)
51
+ 4. Add secrets to the **api-client** repo: `NPM_TOKEN` (from npmjs.com)