@short.io/client-node 2.0.1 → 2.2.0

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.
Files changed (40) hide show
  1. package/README.md +3 -13
  2. package/dist/client/index.d.ts +4 -0
  3. package/dist/client/index.js +115 -0
  4. package/dist/client/index.js.map +1 -0
  5. package/dist/client/types.d.ts +78 -0
  6. package/dist/client/types.js +2 -0
  7. package/dist/client/types.js.map +1 -0
  8. package/dist/client/utils.d.ts +57 -0
  9. package/dist/client/utils.js +383 -0
  10. package/dist/client/utils.js.map +1 -0
  11. package/dist/example.d.ts +0 -0
  12. package/dist/example.js +1 -0
  13. package/dist/example.js.map +1 -0
  14. package/dist/generated/client/index.d.ts +4 -0
  15. package/dist/generated/client/index.js +116 -0
  16. package/dist/generated/client/index.js.map +1 -0
  17. package/dist/generated/client/types.d.ts +78 -0
  18. package/dist/generated/client/types.js +2 -0
  19. package/dist/generated/client/types.js.map +1 -0
  20. package/dist/generated/client/utils.d.ts +57 -0
  21. package/dist/generated/client/utils.js +382 -0
  22. package/dist/generated/client/utils.js.map +1 -0
  23. package/dist/generated/index.d.ts +2 -0
  24. package/dist/generated/index.js +3 -0
  25. package/dist/generated/index.js.map +1 -0
  26. package/dist/generated/sdk.gen.d.ts +474 -0
  27. package/dist/generated/sdk.gen.js +323 -0
  28. package/dist/generated/sdk.gen.js.map +1 -0
  29. package/dist/generated/types.gen.d.ts +1198 -0
  30. package/dist/generated/types.gen.js +2 -0
  31. package/dist/generated/types.gen.js.map +1 -0
  32. package/dist/index.d.ts +3 -2
  33. package/dist/index.js +13 -2
  34. package/dist/index.js.map +1 -1
  35. package/dist/sdk.gen.d.ts +43 -45
  36. package/dist/sdk.gen.js +82 -82
  37. package/dist/sdk.gen.js.map +1 -1
  38. package/dist/types.gen.d.ts +80 -80
  39. package/dist/types.gen.js.map +1 -1
  40. package/package.json +5 -5
package/README.md CHANGED
@@ -21,14 +21,9 @@ First you need to get your API key from the Short.io dashboard in the [Integrati
21
21
  Then you need to set the configuration for the client:
22
22
 
23
23
  ```js
24
- import { client } from "@short.io/client-node";
24
+ import { setApiKey } from "@short.io/client-node";
25
25
 
26
- client.setConfig({
27
- baseUrl: "https://api.short.io",
28
- headers: {
29
- Authorization: "YOUR_API_KEY",
30
- },
31
- });
26
+ setApiKey("YOUR_API_KEY");
32
27
  ```
33
28
 
34
29
  ## Usage
@@ -37,17 +32,12 @@ Import the needed methods from the SDK and use them in your code:
37
32
 
38
33
  ```js
39
34
  import {
40
- client,
41
35
  getApiDomains,
42
36
  getLinksExpand,
43
37
  // and other needed methods
44
38
  } from "@short.io/client-node";
45
- ```
46
-
47
- Pass created client to the methods:
48
39
 
49
- ```js
50
- const domainsResp = await getApiDomains({ client });
40
+ const domainsResp = await getApiDomains();
51
41
  ```
52
42
 
53
43
  `domainsResp.data` will contain the list of domains.
@@ -0,0 +1,4 @@
1
+ import type { Client, Config } from './types.js';
2
+ export declare const createClient: (config?: Config) => Client;
3
+ export type { Client, Config, Options, OptionsLegacyParser, RequestOptionsBase, RequestResult, } from './types.js';
4
+ export { createConfig, formDataBodySerializer, jsonBodySerializer, type QuerySerializerOptions, urlSearchParamsBodySerializer, } from './utils.js';
@@ -0,0 +1,115 @@
1
+ import { createConfig, createInterceptors, createQuerySerializer, getParseAs, getUrl, mergeConfigs, mergeHeaders, } from './utils.js';
2
+ export const createClient = (config = {}) => {
3
+ let _config = mergeConfigs(createConfig(), config);
4
+ const getConfig = () => ({ ..._config });
5
+ const setConfig = (config) => {
6
+ _config = mergeConfigs(_config, config);
7
+ return getConfig();
8
+ };
9
+ const buildUrl = (options) => {
10
+ const url = getUrl({
11
+ baseUrl: options.baseUrl ?? '',
12
+ path: options.path,
13
+ query: options.query,
14
+ querySerializer: typeof options.querySerializer === 'function'
15
+ ? options.querySerializer
16
+ : createQuerySerializer(options.querySerializer),
17
+ url: options.url,
18
+ });
19
+ return url;
20
+ };
21
+ const interceptors = createInterceptors();
22
+ const request = async (options) => {
23
+ const opts = {
24
+ ..._config,
25
+ ...options,
26
+ headers: mergeHeaders(_config.headers, options.headers),
27
+ };
28
+ if (opts.body && opts.bodySerializer) {
29
+ opts.body = opts.bodySerializer(opts.body);
30
+ }
31
+ if (!opts.body) {
32
+ opts.headers.delete('Content-Type');
33
+ }
34
+ const url = buildUrl(opts);
35
+ const requestInit = {
36
+ redirect: 'follow',
37
+ ...opts,
38
+ };
39
+ let request = new Request(url, requestInit);
40
+ for (const fn of interceptors.request._fns) {
41
+ request = await fn(request, opts);
42
+ }
43
+ const _fetch = opts.fetch;
44
+ let response = await _fetch(request);
45
+ for (const fn of interceptors.response._fns) {
46
+ response = await fn(response, request, opts);
47
+ }
48
+ const result = {
49
+ request,
50
+ response,
51
+ };
52
+ if (response.ok) {
53
+ if (response.status === 204 ||
54
+ response.headers.get('Content-Length') === '0') {
55
+ return {
56
+ data: {},
57
+ ...result,
58
+ };
59
+ }
60
+ if (opts.parseAs === 'stream') {
61
+ return {
62
+ data: response.body,
63
+ ...result,
64
+ };
65
+ }
66
+ const parseAs = (opts.parseAs === 'auto'
67
+ ? getParseAs(response.headers.get('Content-Type'))
68
+ : opts.parseAs) ?? 'json';
69
+ let data = await response[parseAs]();
70
+ if (parseAs === 'json' && opts.responseTransformer) {
71
+ data = await opts.responseTransformer(data);
72
+ }
73
+ return {
74
+ data,
75
+ ...result,
76
+ };
77
+ }
78
+ let error = await response.text();
79
+ try {
80
+ error = JSON.parse(error);
81
+ }
82
+ catch {
83
+ }
84
+ let finalError = error;
85
+ for (const fn of interceptors.error._fns) {
86
+ finalError = (await fn(error, response, request, opts));
87
+ }
88
+ finalError = finalError || {};
89
+ if (opts.throwOnError) {
90
+ throw finalError;
91
+ }
92
+ return {
93
+ error: finalError,
94
+ ...result,
95
+ };
96
+ };
97
+ return {
98
+ buildUrl,
99
+ connect: (options) => request({ ...options, method: 'CONNECT' }),
100
+ delete: (options) => request({ ...options, method: 'DELETE' }),
101
+ get: (options) => request({ ...options, method: 'GET' }),
102
+ getConfig,
103
+ head: (options) => request({ ...options, method: 'HEAD' }),
104
+ interceptors,
105
+ options: (options) => request({ ...options, method: 'OPTIONS' }),
106
+ patch: (options) => request({ ...options, method: 'PATCH' }),
107
+ post: (options) => request({ ...options, method: 'POST' }),
108
+ put: (options) => request({ ...options, method: 'PUT' }),
109
+ request,
110
+ setConfig,
111
+ trace: (options) => request({ ...options, method: 'TRACE' }),
112
+ };
113
+ };
114
+ export { createConfig, formDataBodySerializer, jsonBodySerializer, urlSearchParamsBodySerializer, } from './utils.js';
115
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/client/index.ts"],"names":[],"mappings":"AACA,OAAO,EACL,YAAY,EACZ,kBAAkB,EAClB,qBAAqB,EACrB,UAAU,EACV,MAAM,EACN,YAAY,EACZ,YAAY,GACb,MAAM,SAAS,CAAC;AAOjB,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,SAAiB,EAAE,EAAU,EAAE;IAC1D,IAAI,OAAO,GAAG,YAAY,CAAC,YAAY,EAAE,EAAE,MAAM,CAAC,CAAC;IAEnD,MAAM,SAAS,GAAG,GAAW,EAAE,CAAC,CAAC,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAEjD,MAAM,SAAS,GAAG,CAAC,MAAc,EAAU,EAAE;QAC3C,OAAO,GAAG,YAAY,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QACxC,OAAO,SAAS,EAAE,CAAC;IACrB,CAAC,CAAC;IAEF,MAAM,QAAQ,GAAuB,CAAC,OAAO,EAAE,EAAE;QAC/C,MAAM,GAAG,GAAG,MAAM,CAAC;YACjB,OAAO,EAAE,OAAO,CAAC,OAAO,IAAI,EAAE;YAC9B,IAAI,EAAE,OAAO,CAAC,IAAI;YAClB,KAAK,EAAE,OAAO,CAAC,KAAK;YACpB,eAAe,EACb,OAAO,OAAO,CAAC,eAAe,KAAK,UAAU;gBAC3C,CAAC,CAAC,OAAO,CAAC,eAAe;gBACzB,CAAC,CAAC,qBAAqB,CAAC,OAAO,CAAC,eAAe,CAAC;YACpD,GAAG,EAAE,OAAO,CAAC,GAAG;SACjB,CAAC,CAAC;QACH,OAAO,GAAG,CAAC;IACb,CAAC,CAAC;IAEF,MAAM,YAAY,GAAG,kBAAkB,EAKpC,CAAC;IAGJ,MAAM,OAAO,GAAsB,KAAK,EAAE,OAAO,EAAE,EAAE;QAEnD,MAAM,IAAI,GAAmB;YAC3B,GAAG,OAAO;YACV,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,OAAO,CAAC,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC;SACxD,CAAC;QACF,IAAI,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;YACrC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC7C,CAAC;QAGD,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;YACf,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;QACtC,CAAC;QAED,MAAM,GAAG,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;QAC3B,MAAM,WAAW,GAAY;YAC3B,QAAQ,EAAE,QAAQ;YAClB,GAAG,IAAI;SACR,CAAC;QAEF,IAAI,OAAO,GAAG,IAAI,OAAO,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC;QAE5C,KAAK,MAAM,EAAE,IAAI,YAAY,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;YAC3C,OAAO,GAAG,MAAM,EAAE,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QACpC,CAAC;QAED,MAAM,MAAM,GAAG,IAAI,CAAC,KAAM,CAAC;QAC3B,IAAI,QAAQ,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,CAAC;QAErC,KAAK,MAAM,EAAE,IAAI,YAAY,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;YAC5C,QAAQ,GAAG,MAAM,EAAE,CAAC,QAAQ,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;QAC/C,CAAC;QAED,MAAM,MAAM,GAAG;YACb,OAAO;YACP,QAAQ;SACT,CAAC;QAEF,IAAI,QAAQ,CAAC,EAAE,EAAE,CAAC;YAChB,IACE,QAAQ,CAAC,MAAM,KAAK,GAAG;gBACvB,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC,KAAK,GAAG,EAC9C,CAAC;gBACD,OAAO;oBACL,IAAI,EAAE,EAAE;oBACR,GAAG,MAAM;iBACV,CAAC;YACJ,CAAC;YAED,IAAI,IAAI,CAAC,OAAO,KAAK,QAAQ,EAAE,CAAC;gBAC9B,OAAO;oBACL,IAAI,EAAE,QAAQ,CAAC,IAAI;oBACnB,GAAG,MAAM;iBACV,CAAC;YACJ,CAAC;YAED,MAAM,OAAO,GACX,CAAC,IAAI,CAAC,OAAO,KAAK,MAAM;gBACtB,CAAC,CAAC,UAAU,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;gBAClD,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,MAAM,CAAC;YAE9B,IAAI,IAAI,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;YACrC,IAAI,OAAO,KAAK,MAAM,IAAI,IAAI,CAAC,mBAAmB,EAAE,CAAC;gBACnD,IAAI,GAAG,MAAM,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC;YAC9C,CAAC;YAED,OAAO;gBACL,IAAI;gBACJ,GAAG,MAAM;aACV,CAAC;QACJ,CAAC;QAED,IAAI,KAAK,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QAElC,IAAI,CAAC;YACH,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAC5B,CAAC;QAAC,MAAM,CAAC;QAET,CAAC;QAED,IAAI,UAAU,GAAG,KAAK,CAAC;QAEvB,KAAK,MAAM,EAAE,IAAI,YAAY,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;YACzC,UAAU,GAAG,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,IAAI,CAAC,CAAW,CAAC;QACpE,CAAC;QAED,UAAU,GAAG,UAAU,IAAK,EAAa,CAAC;QAE1C,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;YACtB,MAAM,UAAU,CAAC;QACnB,CAAC;QAED,OAAO;YACL,KAAK,EAAE,UAAU;YACjB,GAAG,MAAM;SACV,CAAC;IACJ,CAAC,CAAC;IAEF,OAAO;QACL,QAAQ;QACR,OAAO,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,EAAE,GAAG,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC;QAChE,MAAM,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,EAAE,GAAG,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC;QAC9D,GAAG,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,EAAE,GAAG,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC;QACxD,SAAS;QACT,IAAI,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,EAAE,GAAG,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC;QAC1D,YAAY;QACZ,OAAO,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,EAAE,GAAG,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC;QAChE,KAAK,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,EAAE,GAAG,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC;QAC5D,IAAI,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,EAAE,GAAG,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC;QAC1D,GAAG,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,EAAE,GAAG,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC;QACxD,OAAO;QACP,SAAS;QACT,KAAK,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,EAAE,GAAG,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC;KAC7D,CAAC;AACJ,CAAC,CAAC;AAUF,OAAO,EACL,YAAY,EACZ,sBAAsB,EACtB,kBAAkB,EAElB,6BAA6B,GAC9B,MAAM,SAAS,CAAC","sourcesContent":["import type { Client, Config, RequestOptions } from './types';\nimport {\n createConfig,\n createInterceptors,\n createQuerySerializer,\n getParseAs,\n getUrl,\n mergeConfigs,\n mergeHeaders,\n} from './utils';\n\ntype ReqInit = Omit<RequestInit, 'body' | 'headers'> & {\n body?: any;\n headers: ReturnType<typeof mergeHeaders>;\n};\n\nexport const createClient = (config: Config = {}): Client => {\n let _config = mergeConfigs(createConfig(), config);\n\n const getConfig = (): Config => ({ ..._config });\n\n const setConfig = (config: Config): Config => {\n _config = mergeConfigs(_config, config);\n return getConfig();\n };\n\n const buildUrl: Client['buildUrl'] = (options) => {\n const url = getUrl({\n baseUrl: options.baseUrl ?? '',\n path: options.path,\n query: options.query,\n querySerializer:\n typeof options.querySerializer === 'function'\n ? options.querySerializer\n : createQuerySerializer(options.querySerializer),\n url: options.url,\n });\n return url;\n };\n\n const interceptors = createInterceptors<\n Request,\n Response,\n unknown,\n RequestOptions\n >();\n\n // @ts-expect-error\n const request: Client['request'] = async (options) => {\n // @ts-expect-error\n const opts: RequestOptions = {\n ..._config,\n ...options,\n headers: mergeHeaders(_config.headers, options.headers),\n };\n if (opts.body && opts.bodySerializer) {\n opts.body = opts.bodySerializer(opts.body);\n }\n\n // remove Content-Type header if body is empty to avoid sending invalid requests\n if (!opts.body) {\n opts.headers.delete('Content-Type');\n }\n\n const url = buildUrl(opts);\n const requestInit: ReqInit = {\n redirect: 'follow',\n ...opts,\n };\n\n let request = new Request(url, requestInit);\n\n for (const fn of interceptors.request._fns) {\n request = await fn(request, opts);\n }\n\n const _fetch = opts.fetch!;\n let response = await _fetch(request);\n\n for (const fn of interceptors.response._fns) {\n response = await fn(response, request, opts);\n }\n\n const result = {\n request,\n response,\n };\n\n if (response.ok) {\n if (\n response.status === 204 ||\n response.headers.get('Content-Length') === '0'\n ) {\n return {\n data: {},\n ...result,\n };\n }\n\n if (opts.parseAs === 'stream') {\n return {\n data: response.body,\n ...result,\n };\n }\n\n const parseAs =\n (opts.parseAs === 'auto'\n ? getParseAs(response.headers.get('Content-Type'))\n : opts.parseAs) ?? 'json';\n\n let data = await response[parseAs]();\n if (parseAs === 'json' && opts.responseTransformer) {\n data = await opts.responseTransformer(data);\n }\n\n return {\n data,\n ...result,\n };\n }\n\n let error = await response.text();\n\n try {\n error = JSON.parse(error);\n } catch {\n // noop\n }\n\n let finalError = error;\n\n for (const fn of interceptors.error._fns) {\n finalError = (await fn(error, response, request, opts)) as string;\n }\n\n finalError = finalError || ({} as string);\n\n if (opts.throwOnError) {\n throw finalError;\n }\n\n return {\n error: finalError,\n ...result,\n };\n };\n\n return {\n buildUrl,\n connect: (options) => request({ ...options, method: 'CONNECT' }),\n delete: (options) => request({ ...options, method: 'DELETE' }),\n get: (options) => request({ ...options, method: 'GET' }),\n getConfig,\n head: (options) => request({ ...options, method: 'HEAD' }),\n interceptors,\n options: (options) => request({ ...options, method: 'OPTIONS' }),\n patch: (options) => request({ ...options, method: 'PATCH' }),\n post: (options) => request({ ...options, method: 'POST' }),\n put: (options) => request({ ...options, method: 'PUT' }),\n request,\n setConfig,\n trace: (options) => request({ ...options, method: 'TRACE' }),\n };\n};\n\nexport type {\n Client,\n Config,\n Options,\n OptionsLegacyParser,\n RequestOptionsBase,\n RequestResult,\n} from './types';\nexport {\n createConfig,\n formDataBodySerializer,\n jsonBodySerializer,\n type QuerySerializerOptions,\n urlSearchParamsBodySerializer,\n} from './utils';\n"]}
@@ -0,0 +1,78 @@
1
+ import type { BodySerializer, Middleware, QuerySerializer, QuerySerializerOptions } from './utils.js';
2
+ type OmitKeys<T, K> = Pick<T, Exclude<keyof T, K>>;
3
+ export interface Config<ThrowOnError extends boolean = boolean> extends Omit<RequestInit, 'body' | 'headers' | 'method'> {
4
+ baseUrl?: string;
5
+ body?: RequestInit['body'] | Record<string, unknown> | Array<Record<string, unknown>> | Array<unknown> | number;
6
+ bodySerializer?: BodySerializer;
7
+ fetch?: (request: Request) => ReturnType<typeof fetch>;
8
+ headers?: RequestInit['headers'] | Record<string, string | number | boolean | (string | number | boolean)[] | null | undefined | unknown>;
9
+ method?: 'CONNECT' | 'DELETE' | 'GET' | 'HEAD' | 'OPTIONS' | 'PATCH' | 'POST' | 'PUT' | 'TRACE';
10
+ parseAs?: Exclude<keyof Body, 'body' | 'bodyUsed'> | 'auto' | 'stream';
11
+ querySerializer?: QuerySerializer | QuerySerializerOptions;
12
+ responseTransformer?: (data: unknown) => Promise<unknown>;
13
+ throwOnError?: ThrowOnError;
14
+ }
15
+ export interface RequestOptionsBase<ThrowOnError extends boolean, Url extends string = string> extends Config<ThrowOnError> {
16
+ path?: Record<string, unknown>;
17
+ query?: Record<string, unknown>;
18
+ url: Url;
19
+ }
20
+ export type RequestResult<Data = unknown, TError = unknown, ThrowOnError extends boolean = boolean> = ThrowOnError extends true ? Promise<{
21
+ data: Data;
22
+ request: Request;
23
+ response: Response;
24
+ }> : Promise<({
25
+ data: Data;
26
+ error: undefined;
27
+ } | {
28
+ data: undefined;
29
+ error: TError;
30
+ }) & {
31
+ request: Request;
32
+ response: Response;
33
+ }>;
34
+ type MethodFn = <Data = unknown, TError = unknown, ThrowOnError extends boolean = false>(options: Omit<RequestOptionsBase<ThrowOnError>, 'method'>) => RequestResult<Data, TError, ThrowOnError>;
35
+ type RequestFn = <Data = unknown, TError = unknown, ThrowOnError extends boolean = false>(options: Omit<RequestOptionsBase<ThrowOnError>, 'method'> & Pick<Required<RequestOptionsBase<ThrowOnError>>, 'method'>) => RequestResult<Data, TError, ThrowOnError>;
36
+ export interface Client<Req = Request, Res = Response, Err = unknown, Opts = RequestOptions> {
37
+ buildUrl: <T extends {
38
+ url: string;
39
+ }>(options: T & Options<T>) => string;
40
+ connect: MethodFn;
41
+ delete: MethodFn;
42
+ get: MethodFn;
43
+ getConfig: () => Config;
44
+ head: MethodFn;
45
+ interceptors: Middleware<Req, Res, Err, Opts>;
46
+ options: MethodFn;
47
+ patch: MethodFn;
48
+ post: MethodFn;
49
+ put: MethodFn;
50
+ request: RequestFn;
51
+ setConfig: (config: Config) => Config;
52
+ trace: MethodFn;
53
+ }
54
+ export type RequestOptions = RequestOptionsBase<false> & Config<false> & {
55
+ headers: Headers;
56
+ };
57
+ type OptionsBase<ThrowOnError extends boolean> = Omit<RequestOptionsBase<ThrowOnError>, 'url'> & {
58
+ client?: Client;
59
+ };
60
+ export type Options<T extends {
61
+ url: string;
62
+ } = {
63
+ url: string;
64
+ }, ThrowOnError extends boolean = boolean> = T extends {
65
+ body?: any;
66
+ } ? T extends {
67
+ headers?: any;
68
+ } ? OmitKeys<OptionsBase<ThrowOnError>, 'body' | 'headers'> & Omit<T, 'url'> : OmitKeys<OptionsBase<ThrowOnError>, 'body'> & Omit<T, 'url'> & Pick<OptionsBase<ThrowOnError>, 'headers'> : T extends {
69
+ headers?: any;
70
+ } ? OmitKeys<OptionsBase<ThrowOnError>, 'headers'> & Omit<T, 'url'> & Pick<OptionsBase<ThrowOnError>, 'body'> : OptionsBase<ThrowOnError> & Omit<T, 'url'>;
71
+ export type OptionsLegacyParser<T = unknown, ThrowOnError extends boolean = boolean> = T extends {
72
+ body?: any;
73
+ } ? T extends {
74
+ headers?: any;
75
+ } ? OmitKeys<OptionsBase<ThrowOnError>, 'body' | 'headers'> & T : OmitKeys<OptionsBase<ThrowOnError>, 'body'> & T & Pick<OptionsBase<ThrowOnError>, 'headers'> : T extends {
76
+ headers?: any;
77
+ } ? OmitKeys<OptionsBase<ThrowOnError>, 'headers'> & T & Pick<OptionsBase<ThrowOnError>, 'body'> : OptionsBase<ThrowOnError> & T;
78
+ export {};
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=types.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/client/types.ts"],"names":[],"mappings":"","sourcesContent":["import type {\n BodySerializer,\n Middleware,\n QuerySerializer,\n QuerySerializerOptions,\n} from './utils';\n\ntype OmitKeys<T, K> = Pick<T, Exclude<keyof T, K>>;\n\nexport interface Config<ThrowOnError extends boolean = boolean>\n extends Omit<RequestInit, 'body' | 'headers' | 'method'> {\n /**\n * Base URL for all requests made by this client.\n * @default ''\n */\n baseUrl?: string;\n /**\n * Any body that you want to add to your request.\n *\n * {@link https://developer.mozilla.org/docs/Web/API/fetch#body}\n */\n body?:\n | RequestInit['body']\n | Record<string, unknown>\n | Array<Record<string, unknown>>\n | Array<unknown>\n | number;\n /**\n * A function for serializing request body parameter. By default,\n * {@link JSON.stringify()} will be used.\n */\n bodySerializer?: BodySerializer;\n /**\n * Fetch API implementation. You can use this option to provide a custom\n * fetch instance.\n * @default globalThis.fetch\n */\n fetch?: (request: Request) => ReturnType<typeof fetch>;\n /**\n * An object containing any HTTP headers that you want to pre-populate your\n * `Headers` object with.\n *\n * {@link https://developer.mozilla.org/docs/Web/API/Headers/Headers#init See more}\n */\n headers?:\n | RequestInit['headers']\n | Record<\n string,\n | string\n | number\n | boolean\n | (string | number | boolean)[]\n | null\n | undefined\n | unknown\n >;\n /**\n * The request method.\n *\n * {@link https://developer.mozilla.org/docs/Web/API/fetch#method See more}\n */\n method?:\n | 'CONNECT'\n | 'DELETE'\n | 'GET'\n | 'HEAD'\n | 'OPTIONS'\n | 'PATCH'\n | 'POST'\n | 'PUT'\n | 'TRACE';\n /**\n * Return the response data parsed in a specified format. By default, `auto`\n * will infer the appropriate method from the `Content-Type` response header.\n * You can override this behavior with any of the {@link Body} methods.\n * Select `stream` if you don't want to parse response data at all.\n * @default 'auto'\n */\n parseAs?: Exclude<keyof Body, 'body' | 'bodyUsed'> | 'auto' | 'stream';\n /**\n * A function for serializing request query parameters. By default, arrays\n * will be exploded in form style, objects will be exploded in deepObject\n * style, and reserved characters are percent-encoded.\n *\n * {@link https://swagger.io/docs/specification/serialization/#query View examples}\n */\n querySerializer?: QuerySerializer | QuerySerializerOptions;\n /**\n * A function for transforming response data before it's returned to the\n * caller function. This is an ideal place to post-process server data,\n * e.g. convert date ISO strings into native Date objects.\n */\n responseTransformer?: (data: unknown) => Promise<unknown>;\n /**\n * Throw an error instead of returning it in the response?\n * @default false\n */\n throwOnError?: ThrowOnError;\n}\n\nexport interface RequestOptionsBase<\n ThrowOnError extends boolean,\n Url extends string = string,\n> extends Config<ThrowOnError> {\n path?: Record<string, unknown>;\n query?: Record<string, unknown>;\n url: Url;\n}\n\nexport type RequestResult<\n Data = unknown,\n TError = unknown,\n ThrowOnError extends boolean = boolean,\n> = ThrowOnError extends true\n ? Promise<{\n data: Data;\n request: Request;\n response: Response;\n }>\n : Promise<\n (\n | { data: Data; error: undefined }\n | { data: undefined; error: TError }\n ) & {\n request: Request;\n response: Response;\n }\n >;\n\ntype MethodFn = <\n Data = unknown,\n TError = unknown,\n ThrowOnError extends boolean = false,\n>(\n options: Omit<RequestOptionsBase<ThrowOnError>, 'method'>,\n) => RequestResult<Data, TError, ThrowOnError>;\n\ntype RequestFn = <\n Data = unknown,\n TError = unknown,\n ThrowOnError extends boolean = false,\n>(\n options: Omit<RequestOptionsBase<ThrowOnError>, 'method'> &\n Pick<Required<RequestOptionsBase<ThrowOnError>>, 'method'>,\n) => RequestResult<Data, TError, ThrowOnError>;\n\nexport interface Client<\n Req = Request,\n Res = Response,\n Err = unknown,\n Opts = RequestOptions,\n> {\n /**\n * Returns the final request URL. This method works only with experimental parser.\n */\n buildUrl: <T extends { url: string }>(options: T & Options<T>) => string;\n connect: MethodFn;\n delete: MethodFn;\n get: MethodFn;\n getConfig: () => Config;\n head: MethodFn;\n interceptors: Middleware<Req, Res, Err, Opts>;\n options: MethodFn;\n patch: MethodFn;\n post: MethodFn;\n put: MethodFn;\n request: RequestFn;\n setConfig: (config: Config) => Config;\n trace: MethodFn;\n}\n\nexport type RequestOptions = RequestOptionsBase<false> &\n Config<false> & {\n headers: Headers;\n };\n\ntype OptionsBase<ThrowOnError extends boolean> = Omit<\n RequestOptionsBase<ThrowOnError>,\n 'url'\n> & {\n /**\n * You can provide a client instance returned by `createClient()` instead of\n * individual options. This might be also useful if you want to implement a\n * custom client.\n */\n client?: Client;\n};\n\nexport type Options<\n T extends { url: string } = { url: string },\n ThrowOnError extends boolean = boolean,\n> = T extends { body?: any }\n ? T extends { headers?: any }\n ? OmitKeys<OptionsBase<ThrowOnError>, 'body' | 'headers'> & Omit<T, 'url'>\n : OmitKeys<OptionsBase<ThrowOnError>, 'body'> &\n Omit<T, 'url'> &\n Pick<OptionsBase<ThrowOnError>, 'headers'>\n : T extends { headers?: any }\n ? OmitKeys<OptionsBase<ThrowOnError>, 'headers'> &\n Omit<T, 'url'> &\n Pick<OptionsBase<ThrowOnError>, 'body'>\n : OptionsBase<ThrowOnError> & Omit<T, 'url'>;\n\nexport type OptionsLegacyParser<\n T = unknown,\n ThrowOnError extends boolean = boolean,\n> = T extends { body?: any }\n ? T extends { headers?: any }\n ? OmitKeys<OptionsBase<ThrowOnError>, 'body' | 'headers'> & T\n : OmitKeys<OptionsBase<ThrowOnError>, 'body'> &\n T &\n Pick<OptionsBase<ThrowOnError>, 'headers'>\n : T extends { headers?: any }\n ? OmitKeys<OptionsBase<ThrowOnError>, 'headers'> &\n T &\n Pick<OptionsBase<ThrowOnError>, 'body'>\n : OptionsBase<ThrowOnError> & T;\n"]}
@@ -0,0 +1,57 @@
1
+ import type { Config } from './types.js';
2
+ type ArrayStyle = 'form' | 'spaceDelimited' | 'pipeDelimited';
3
+ type ObjectStyle = 'form' | 'deepObject';
4
+ export type QuerySerializer = (query: Record<string, unknown>) => string;
5
+ export type BodySerializer = (body: any) => any;
6
+ interface SerializerOptions<T> {
7
+ explode: boolean;
8
+ style: T;
9
+ }
10
+ export interface QuerySerializerOptions {
11
+ allowReserved?: boolean;
12
+ array?: SerializerOptions<ArrayStyle>;
13
+ object?: SerializerOptions<ObjectStyle>;
14
+ }
15
+ export declare const createQuerySerializer: <T = unknown>({ allowReserved, array, object, }?: QuerySerializerOptions) => (queryParams: T) => string;
16
+ export declare const getParseAs: (contentType: string | null) => Exclude<Config["parseAs"], "auto" | "stream">;
17
+ export declare const getUrl: ({ baseUrl, path, query, querySerializer, url: _url, }: {
18
+ baseUrl: string;
19
+ path?: Record<string, unknown>;
20
+ query?: Record<string, unknown>;
21
+ querySerializer: QuerySerializer;
22
+ url: string;
23
+ }) => string;
24
+ export declare const mergeConfigs: (a: Config, b: Config) => Config;
25
+ export declare const mergeHeaders: (...headers: Array<Required<Config>["headers"] | undefined>) => Headers;
26
+ type ErrInterceptor<Err, Res, Req, Options> = (error: Err, response: Res, request: Req, options: Options) => Err | Promise<Err>;
27
+ type ReqInterceptor<Req, Options> = (request: Req, options: Options) => Req | Promise<Req>;
28
+ type ResInterceptor<Res, Req, Options> = (response: Res, request: Req, options: Options) => Res | Promise<Res>;
29
+ declare class Interceptors<Interceptor> {
30
+ _fns: Interceptor[];
31
+ constructor();
32
+ clear(): void;
33
+ exists(fn: Interceptor): boolean;
34
+ eject(fn: Interceptor): void;
35
+ use(fn: Interceptor): void;
36
+ }
37
+ export interface Middleware<Req, Res, Err, Options> {
38
+ error: Pick<Interceptors<ErrInterceptor<Err, Res, Req, Options>>, 'eject' | 'use'>;
39
+ request: Pick<Interceptors<ReqInterceptor<Req, Options>>, 'eject' | 'use'>;
40
+ response: Pick<Interceptors<ResInterceptor<Res, Req, Options>>, 'eject' | 'use'>;
41
+ }
42
+ export declare const createInterceptors: <Req, Res, Err, Options>() => {
43
+ error: Interceptors<ErrInterceptor<Err, Res, Req, Options>>;
44
+ request: Interceptors<ReqInterceptor<Req, Options>>;
45
+ response: Interceptors<ResInterceptor<Res, Req, Options>>;
46
+ };
47
+ export declare const formDataBodySerializer: {
48
+ bodySerializer: <T extends Record<string, any> | Array<Record<string, any>>>(body: T) => FormData;
49
+ };
50
+ export declare const jsonBodySerializer: {
51
+ bodySerializer: <T>(body: T) => string;
52
+ };
53
+ export declare const urlSearchParamsBodySerializer: {
54
+ bodySerializer: <T extends Record<string, any> | Array<Record<string, any>>>(body: T) => URLSearchParams;
55
+ };
56
+ export declare const createConfig: (override?: Config) => Config;
57
+ export {};