@gojinko/api-client 0.1.0 → 0.1.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/README.md +87 -0
- package/dist/auth.d.ts +1 -1
- package/dist/auth.d.ts.map +1 -1
- package/dist/auth.js +1 -1
- package/dist/auth.js.map +1 -1
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
# @gojinko/api-client
|
|
2
|
+
|
|
3
|
+
Typed API client for the Jinko BFF, built on [openapi-fetch](https://openapi-ts.dev/openapi-fetch/). Shared by `@gojinko/cli` and other Jinko developer tools.
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install @gojinko/api-client
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Usage
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { createJinkoClient } from '@gojinko/api-client';
|
|
15
|
+
|
|
16
|
+
const client = await createJinkoClient({
|
|
17
|
+
apiKey: 'jnk_your_api_key', // or an OAuth JWT token
|
|
18
|
+
baseUrl: 'https://bff.gojinko.com', // optional, this is the default
|
|
19
|
+
});
|
|
20
|
+
|
|
21
|
+
// Search flights (typed openapi-fetch client)
|
|
22
|
+
const response = await client.raw.POST('/api/v1/devplatform/flights/shop', {
|
|
23
|
+
body: {
|
|
24
|
+
origin: 'PAR',
|
|
25
|
+
destination: 'NYC',
|
|
26
|
+
departure_date: '2026-04-15',
|
|
27
|
+
trip_type: 'oneway',
|
|
28
|
+
cabin_class: 'economy',
|
|
29
|
+
passengers: { adults: 1 },
|
|
30
|
+
},
|
|
31
|
+
});
|
|
32
|
+
|
|
33
|
+
console.log(response.data);
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
## Authentication
|
|
37
|
+
|
|
38
|
+
Auth is resolved with precedence: parameter > environment variable > config file.
|
|
39
|
+
|
|
40
|
+
```typescript
|
|
41
|
+
// API key (detected by jnk_ prefix → sends X-API-Key header)
|
|
42
|
+
const client = await createJinkoClient({ apiKey: 'jnk_...' });
|
|
43
|
+
|
|
44
|
+
// OAuth JWT (anything else → sends Authorization: Bearer header)
|
|
45
|
+
const client = await createJinkoClient({ apiKey: 'eyJ...' });
|
|
46
|
+
|
|
47
|
+
// Or via environment variables
|
|
48
|
+
// JINKO_API_KEY=jnk_...
|
|
49
|
+
// JINKO_TOKEN=eyJ...
|
|
50
|
+
const client = await createJinkoClient();
|
|
51
|
+
|
|
52
|
+
// Or via ~/.jinko/config.yaml
|
|
53
|
+
// api_key: jnk_...
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
## Config File
|
|
57
|
+
|
|
58
|
+
Reads from `~/.jinko/config.yaml`:
|
|
59
|
+
|
|
60
|
+
```yaml
|
|
61
|
+
api_key: jnk_your_key
|
|
62
|
+
base_url: https://bff.gojinko.com
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
```typescript
|
|
66
|
+
import { readConfigFile, writeConfigFile } from '@gojinko/api-client';
|
|
67
|
+
|
|
68
|
+
await writeConfigFile({ api_key: 'jnk_new_key' });
|
|
69
|
+
const config = await readConfigFile();
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
## Error Handling
|
|
73
|
+
|
|
74
|
+
```typescript
|
|
75
|
+
import { createJinkoClient, ApiError, AuthError } from '@gojinko/api-client';
|
|
76
|
+
|
|
77
|
+
try {
|
|
78
|
+
const client = await createJinkoClient();
|
|
79
|
+
} catch (error) {
|
|
80
|
+
if (error instanceof AuthError) {
|
|
81
|
+
// No credentials configured
|
|
82
|
+
}
|
|
83
|
+
if (error instanceof ApiError) {
|
|
84
|
+
console.error(error.code, error.message, error.statusCode);
|
|
85
|
+
}
|
|
86
|
+
}
|
|
87
|
+
```
|
package/dist/auth.d.ts
CHANGED
|
@@ -8,7 +8,7 @@ interface ConfigFile {
|
|
|
8
8
|
readonly oauth_token?: string;
|
|
9
9
|
readonly base_url?: string;
|
|
10
10
|
}
|
|
11
|
-
declare const DEFAULT_BASE_URL = "https://bff.gojinko.com";
|
|
11
|
+
declare const DEFAULT_BASE_URL = "https://mcp-bff.dev.gojinko.com";
|
|
12
12
|
declare const CONFIG_DIR: string;
|
|
13
13
|
declare const CONFIG_FILE: string;
|
|
14
14
|
/**
|
package/dist/auth.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"auth.d.ts","sourceRoot":"","sources":["../src/auth.ts"],"names":[],"mappings":"AAKA,MAAM,MAAM,UAAU,GAAG,SAAS,GAAG,OAAO,CAAC;AAE7C,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC;IAC5B,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;CACxB;AAED,UAAU,UAAU;IAClB,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,QAAA,MAAM,gBAAgB,
|
|
1
|
+
{"version":3,"file":"auth.d.ts","sourceRoot":"","sources":["../src/auth.ts"],"names":[],"mappings":"AAKA,MAAM,MAAM,UAAU,GAAG,SAAS,GAAG,OAAO,CAAC;AAE7C,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC;IAC5B,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;CACxB;AAED,UAAU,UAAU;IAClB,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,QAAA,MAAM,gBAAgB,oCAAoC,CAAC;AAC3D,QAAA,MAAM,UAAU,QAA4B,CAAC;AAC7C,QAAA,MAAM,WAAW,QAAkC,CAAC;AAEpD;;;;;;GAMG;AACH,wBAAsB,WAAW,CAAC,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,GAAG,SAAS,CAAC,CAaxF;AAED;;GAEG;AACH,wBAAsB,cAAc,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAQvE;AAED;;GAEG;AACH,wBAAsB,cAAc,IAAI,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC,CAOtE;AAED;;GAEG;AACH,wBAAsB,eAAe,CAAC,OAAO,EAAE,OAAO,CAAC,UAAU,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CASjF;AAED,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,gBAAgB,EAAE,CAAC"}
|
package/dist/auth.js
CHANGED
|
@@ -2,7 +2,7 @@ import { readFile } from 'node:fs/promises';
|
|
|
2
2
|
import { join } from 'node:path';
|
|
3
3
|
import { homedir } from 'node:os';
|
|
4
4
|
import { parse as parseYaml } from 'yaml';
|
|
5
|
-
const DEFAULT_BASE_URL = 'https://bff.gojinko.com';
|
|
5
|
+
const DEFAULT_BASE_URL = 'https://mcp-bff.dev.gojinko.com';
|
|
6
6
|
const CONFIG_DIR = join(homedir(), '.jinko');
|
|
7
7
|
const CONFIG_FILE = join(CONFIG_DIR, 'config.yaml');
|
|
8
8
|
/**
|
package/dist/auth.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"auth.js","sourceRoot":"","sources":["../src/auth.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC5C,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAClC,OAAO,EAAE,KAAK,IAAI,SAAS,EAAE,MAAM,MAAM,CAAC;AAe1C,MAAM,gBAAgB,GAAG,
|
|
1
|
+
{"version":3,"file":"auth.js","sourceRoot":"","sources":["../src/auth.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC5C,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAClC,OAAO,EAAE,KAAK,IAAI,SAAS,EAAE,MAAM,MAAM,CAAC;AAe1C,MAAM,gBAAgB,GAAG,iCAAiC,CAAC;AAC3D,MAAM,UAAU,GAAG,IAAI,CAAC,OAAO,EAAE,EAAE,QAAQ,CAAC,CAAC;AAC7C,MAAM,WAAW,GAAG,IAAI,CAAC,UAAU,EAAE,aAAa,CAAC,CAAC;AAEpD;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAAC,UAAmB;IACnD,MAAM,KAAK,GAAG,UAAU;WACnB,OAAO,CAAC,GAAG,CAAC,eAAe,CAAC;WAC5B,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC;WAC1B,CAAC,MAAM,cAAc,EAAE,CAAC,EAAE,OAAO;WACjC,CAAC,MAAM,cAAc,EAAE,CAAC,EAAE,WAAW,CAAC;IAE3C,IAAI,CAAC,KAAK;QAAE,OAAO,SAAS,CAAC;IAE7B,OAAO;QACL,MAAM,EAAE,KAAK,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO;QACtD,KAAK;KACN,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAAC,QAAiB;IACpD,IAAI,QAAQ;QAAE,OAAO,QAAQ,CAAC;IAE9B,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;IAC7C,IAAI,MAAM;QAAE,OAAO,MAAM,CAAC;IAE1B,MAAM,MAAM,GAAG,MAAM,cAAc,EAAE,CAAC;IACtC,OAAO,MAAM,EAAE,QAAQ,IAAI,gBAAgB,CAAC;AAC9C,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc;IAClC,IAAI,CAAC;QACH,MAAM,OAAO,GAAG,MAAM,QAAQ,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;QACrD,OAAO,SAAS,CAAC,OAAO,CAAe,CAAC;IAC1C,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,SAAS,CAAC;IACnB,CAAC;AACH,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,eAAe,CAAC,OAA4B;IAChE,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,GAAG,MAAM,MAAM,CAAC,kBAAkB,CAAC,CAAC;IAC9D,MAAM,EAAE,SAAS,EAAE,aAAa,EAAE,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,CAAC;IAE1D,MAAM,KAAK,CAAC,UAAU,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAE7C,MAAM,QAAQ,GAAG,CAAC,MAAM,cAAc,EAAE,CAAC,IAAI,EAAE,CAAC;IAChD,MAAM,MAAM,GAAe,EAAE,GAAG,QAAQ,EAAE,GAAG,OAAO,EAAE,CAAC;IACvD,MAAM,SAAS,CAAC,WAAW,EAAE,aAAa,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,CAAC;AAC/D,CAAC;AAED,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,gBAAgB,EAAE,CAAC"}
|