@gitbeaker/requester-utils 35.7.0 → 35.8.1
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/dist/index.d.ts +74 -0
- package/dist/index.es.js.map +1 -1
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +111 -0
- package/package.json +4 -5
- package/LICENSE.md +0 -22
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
type ResponseBodyTypes = Record<string, unknown> | Record<string, unknown>[] | ReadableStream | Blob | string | string[] | number | void;
|
|
2
|
+
interface FormattedResponse<T extends ResponseBodyTypes = ResponseBodyTypes> {
|
|
3
|
+
body: T;
|
|
4
|
+
headers: Record<string, string>;
|
|
5
|
+
status: number;
|
|
6
|
+
}
|
|
7
|
+
interface RequesterType {
|
|
8
|
+
get<T extends ResponseBodyTypes>(endpoint: string, options?: Record<string, unknown>): Promise<FormattedResponse<T>>;
|
|
9
|
+
post<T extends ResponseBodyTypes>(endpoint: string, options?: Record<string, unknown>): Promise<FormattedResponse<T>>;
|
|
10
|
+
put<T extends ResponseBodyTypes>(endpoint: string, options?: Record<string, unknown>): Promise<FormattedResponse<T>>;
|
|
11
|
+
patch<T extends ResponseBodyTypes>(endpoint: string, options?: Record<string, unknown>): Promise<FormattedResponse<T>>;
|
|
12
|
+
delete<T extends ResponseBodyTypes>(endpoint: string, options?: Record<string, unknown>): Promise<FormattedResponse<T>>;
|
|
13
|
+
}
|
|
14
|
+
interface Constructable<T = any> {
|
|
15
|
+
new (...args: any[]): T;
|
|
16
|
+
}
|
|
17
|
+
type DefaultResourceOptions = {
|
|
18
|
+
headers: {
|
|
19
|
+
[header: string]: string;
|
|
20
|
+
};
|
|
21
|
+
requestTimeout: number;
|
|
22
|
+
url: string;
|
|
23
|
+
rejectUnauthorized: boolean;
|
|
24
|
+
};
|
|
25
|
+
type DefaultRequestOptions = {
|
|
26
|
+
body?: FormData | Record<string, unknown>;
|
|
27
|
+
searchParams?: Record<string, unknown>;
|
|
28
|
+
sudo?: string;
|
|
29
|
+
method?: string;
|
|
30
|
+
asStream?: boolean;
|
|
31
|
+
};
|
|
32
|
+
type RequestOptions = {
|
|
33
|
+
headers: Record<string, string>;
|
|
34
|
+
timeout?: number;
|
|
35
|
+
method: string;
|
|
36
|
+
searchParams?: string;
|
|
37
|
+
prefixUrl: string;
|
|
38
|
+
body?: string | FormData;
|
|
39
|
+
asStream?: boolean;
|
|
40
|
+
};
|
|
41
|
+
declare function formatQuery(params?: Record<string, unknown>): string;
|
|
42
|
+
type OptionsHandlerFn = (serviceOptions: DefaultResourceOptions, requestOptions: DefaultRequestOptions) => Promise<RequestOptions>;
|
|
43
|
+
declare function defaultOptionsHandler(resourceOptions: DefaultResourceOptions, { body, searchParams, sudo, asStream, method }?: DefaultRequestOptions): Promise<RequestOptions>;
|
|
44
|
+
type RequestHandlerFn<T extends ResponseBodyTypes = ResponseBodyTypes> = (endpoint: string, options?: Record<string, unknown>) => Promise<FormattedResponse<T>>;
|
|
45
|
+
declare function createRequesterFn(optionsHandler: OptionsHandlerFn, requestHandler: RequestHandlerFn): (serviceOptions: DefaultResourceOptions) => RequesterType;
|
|
46
|
+
declare function presetResourceArguments<T extends Record<string, Constructable>>(resources: T, customConfig?: Record<string, unknown>): T;
|
|
47
|
+
|
|
48
|
+
interface BaseResourceOptions<C> {
|
|
49
|
+
oauthToken?: string;
|
|
50
|
+
token?: string;
|
|
51
|
+
jobToken?: string;
|
|
52
|
+
host?: string;
|
|
53
|
+
prefixUrl?: string;
|
|
54
|
+
rejectUnauthorized?: boolean;
|
|
55
|
+
camelize?: C;
|
|
56
|
+
requesterFn?: (resourceOptions: DefaultResourceOptions) => RequesterType;
|
|
57
|
+
requestTimeout?: number;
|
|
58
|
+
profileToken?: string;
|
|
59
|
+
sudo?: string | number;
|
|
60
|
+
profileMode?: 'execution' | 'memory';
|
|
61
|
+
}
|
|
62
|
+
declare class BaseResource<C extends boolean = false> {
|
|
63
|
+
readonly url: string;
|
|
64
|
+
readonly requester: RequesterType;
|
|
65
|
+
readonly requestTimeout: number;
|
|
66
|
+
readonly headers: {
|
|
67
|
+
[header: string]: string;
|
|
68
|
+
};
|
|
69
|
+
readonly camelize: C | undefined;
|
|
70
|
+
readonly rejectUnauthorized: boolean;
|
|
71
|
+
constructor({ token, jobToken, oauthToken, sudo, profileToken, requesterFn, camelize, profileMode, host, prefixUrl, rejectUnauthorized, requestTimeout, }?: BaseResourceOptions<C>);
|
|
72
|
+
}
|
|
73
|
+
|
|
74
|
+
export { BaseResource, BaseResourceOptions, Constructable, DefaultRequestOptions, DefaultResourceOptions, FormattedResponse, OptionsHandlerFn, RequestHandlerFn, RequestOptions, RequesterType, ResponseBodyTypes, createRequesterFn, defaultOptionsHandler, formatQuery, presetResourceArguments };
|
package/dist/index.es.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.es.js","sources":["../src/RequesterUtils.ts","../src/BaseResource.ts"],"sourcesContent":["import { decamelizeKeys } from 'xcase';\nimport FormData, { Headers } from 'form-data';\nimport { stringify } from 'qs';\n\n// Types\nexport interface Constructable<T = any> {\n new (...args: any[]): T;\n}\n\nexport interface RequesterType {\n get(endpoint: string, options?: Record<string, unknown>): Promise<any>;\n post(endpoint: string, options?: Record<string, unknown>): Promise<any>;\n put(endpoint: string, options?: Record<string, unknown>): Promise<any>;\n delete(endpoint: string, options?: Record<string, unknown>): Promise<any>;\n stream?(endpoint: string, options?: Record<string, unknown>): NodeJS.ReadableStream;\n}\n\nexport type DefaultResourceOptions = {\n headers: { [header: string]: string };\n requestTimeout: number;\n url: string;\n rejectUnauthorized: boolean;\n};\n\nexport type DefaultRequestOptions = {\n body?: FormData | Record<string, unknown>;\n query?: Record<string, unknown>;\n sudo?: string;\n method?: string;\n};\n\nexport type DefaultRequestReturn = {\n headers: Record<string, string> | Headers;\n timeout?: number;\n method: string;\n searchParams?: string;\n prefixUrl?: string;\n body?: string | FormData;\n};\n\n// Utility methods\nexport function formatQuery(params: Record<string, unknown> = {}): string {\n const decamelized = decamelizeKeys(params);\n\n return stringify(decamelized, { arrayFormat: 'brackets' });\n}\n\nexport type OptionsHandlerFn = (\n serviceOptions: DefaultResourceOptions,\n requestOptions: DefaultRequestOptions,\n) => DefaultRequestReturn;\nexport function defaultOptionsHandler(\n resourceOptions: DefaultResourceOptions,\n { body, query, sudo, method = 'get' }: DefaultRequestOptions = {},\n): DefaultRequestReturn {\n const { headers: preconfiguredHeaders, requestTimeout, url } = resourceOptions;\n const headers = { ...preconfiguredHeaders };\n let bod: FormData | string;\n\n if (sudo) headers.sudo = sudo;\n\n // FIXME: Not the best comparison, but...it will have to do for now.\n if (typeof body === 'object' && body.constructor.name !== 'FormData') {\n bod = JSON.stringify(decamelizeKeys(body));\n headers['content-type'] = 'application/json';\n } else {\n bod = body as FormData;\n }\n\n return {\n headers,\n timeout: requestTimeout,\n method,\n searchParams: formatQuery(query),\n prefixUrl: url,\n body: bod,\n };\n}\n\nexport type RequestHandlerFn = (\n endpoint: string,\n options?: Record<string, unknown>,\n) =>\n | any\n | Promise<{\n body: Record<string, unknown> | Record<string, unknown>[];\n headers: Record<string, unknown> | Headers;\n status: number;\n }>;\n\nexport function createRequesterFn(\n optionsHandler: OptionsHandlerFn,\n requestHandler: RequestHandlerFn,\n): (serviceOptions: DefaultResourceOptions) => RequesterType {\n const methods = ['get', 'post', 'put', 'delete', 'stream'];\n\n return (serviceOptions) => {\n const requester: RequesterType = {} as RequesterType;\n\n methods.forEach((m) => {\n requester[m] = (endpoint: string, options: Record<string, unknown>) => {\n const requestOptions = optionsHandler(serviceOptions, { ...options, method: m });\n\n return requestHandler(endpoint, requestOptions);\n };\n });\n\n return requester;\n };\n}\n\nfunction extendClass<T extends Constructable>(Base: T, customConfig: Record<string, unknown>): T {\n return class extends Base {\n constructor(...options: any[]) {\n const [config, ...opts] = options;\n\n super({ ...customConfig, ...config }, ...opts);\n }\n };\n}\n\nexport function presetResourceArguments<T>(\n resources: T,\n customConfig: Record<string, unknown> = {},\n) {\n const updated = {};\n\n Object.entries(resources)\n .filter(([, s]) => typeof s === 'function') // FIXME: Odd default artifact included in this list during testing\n .forEach(([k, r]) => {\n updated[k] = extendClass(r, customConfig);\n });\n\n return updated as T;\n}\n","import { RequesterType, DefaultResourceOptions } from './RequesterUtils';\n\nexport interface BaseResourceOptions<C> {\n oauthToken?: string;\n token?: string;\n jobToken?: string;\n host?: string;\n prefixUrl?: string;\n version?: 3 | 4;\n rejectUnauthorized?: boolean;\n camelize?: C;\n requesterFn?: (resourceOptions: DefaultResourceOptions) => RequesterType;\n requestTimeout?: number;\n profileToken?: string;\n sudo?: string | number;\n profileMode?: 'execution' | 'memory';\n}\n\nexport class BaseResource<C extends boolean = false> {\n public readonly url: string;\n\n public readonly requester: RequesterType;\n\n public readonly requestTimeout: number;\n\n public readonly headers: { [header: string]: string };\n\n public readonly camelize: C | undefined;\n\n public readonly rejectUnauthorized: boolean;\n\n constructor({\n token,\n jobToken,\n oauthToken,\n sudo,\n profileToken,\n requesterFn,\n camelize,\n profileMode = 'execution',\n host = 'https://gitlab.com',\n prefixUrl = '',\n version = 4,\n rejectUnauthorized = true,\n requestTimeout = 300000,\n }: BaseResourceOptions<C> = {}) {\n if (!requesterFn) throw new ReferenceError('requesterFn must be passed');\n\n this.url = [host, 'api', `v${version}`, prefixUrl].join('/');\n\n this.headers = {\n 'user-agent': 'gitbeaker',\n };\n this.rejectUnauthorized = rejectUnauthorized;\n this.camelize = camelize;\n this.requestTimeout = requestTimeout;\n\n // Handle auth tokens\n if (oauthToken) this.headers.authorization = `Bearer ${oauthToken}`;\n else if (jobToken) this.headers['job-token'] = jobToken;\n else if (token) this.headers['private-token'] = token;\n\n // Profiling\n if (profileToken) {\n this.headers['X-Profile-Token'] = profileToken;\n this.headers['X-Profile-Mode'] = profileMode;\n }\n\n // Set sudo\n if (sudo) this.headers.Sudo = `${sudo}`;\n\n // Set requester instance using this information\n this.requester = requesterFn({ ...this });\n }\n}\n"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAwCA;SACgB,WAAW,CAAC,MAAoC;IAApC,uBAAA,EAAA,WAAoC;IAC9D,IAAM,WAAW,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC;IAE3C,OAAO,SAAS,CAAC,WAAW,EAAE,EAAE,WAAW,EAAE,UAAU,EAAE,CAAC,CAAC;AAC7D,CAAC;SAMe,qBAAqB,CACnC,eAAuC,EACvC,EAAiE;QAAjE,qBAA+D,EAAE,KAAA,EAA/D,IAAI,UAAA,EAAE,KAAK,WAAA,EAAE,IAAI,UAAA,EAAE,cAAc,EAAd,MAAM,mBAAG,KAAK,KAAA;IAE3B,IAAS,oBAAoB,GAA0B,eAAe,QAAzC,EAAE,cAAc,GAAU,eAAe,eAAzB,EAAE,GAAG,GAAK,eAAe,IAApB,CAAqB;IAC/E,IAAM,OAAO,gBAAQ,oBAAoB,CAAE,CAAC;IAC5C,IAAI,GAAsB,CAAC;IAE3B,IAAI,IAAI;QAAE,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC;;IAG9B,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,CAAC,WAAW,CAAC,IAAI,KAAK,UAAU,EAAE;QACpE,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC;QAC3C,OAAO,CAAC,cAAc,CAAC,GAAG,kBAAkB,CAAC;KAC9C;SAAM;QACL,GAAG,GAAG,IAAgB,CAAC;KACxB;IAED,OAAO;QACL,OAAO,SAAA;QACP,OAAO,EAAE,cAAc;QACvB,MAAM,QAAA;QACN,YAAY,EAAE,WAAW,CAAC,KAAK,CAAC;QAChC,SAAS,EAAE,GAAG;QACd,IAAI,EAAE,GAAG;KACV,CAAC;AACJ,CAAC;SAae,iBAAiB,CAC/B,cAAgC,EAChC,cAAgC;IAEhC,IAAM,OAAO,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;IAE3D,OAAO,UAAC,cAAc;QACpB,IAAM,SAAS,GAAkB,EAAmB,CAAC;QAErD,OAAO,CAAC,OAAO,CAAC,UAAC,CAAC;YAChB,SAAS,CAAC,CAAC,CAAC,GAAG,UAAC,QAAgB,EAAE,OAAgC;gBAChE,IAAM,cAAc,GAAG,cAAc,CAAC,cAAc,wBAAO,OAAO,KAAE,MAAM,EAAE,CAAC,IAAG,CAAC;gBAEjF,OAAO,cAAc,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAC;aACjD,CAAC;SACH,CAAC,CAAC;QAEH,OAAO,SAAS,CAAC;KAClB,CAAC;AACJ,CAAC;AAED,SAAS,WAAW,CAA0B,IAAO,EAAE,YAAqC;IAC1F;QAAqB,2BAAI;QACvB;YAAY,iBAAiB;iBAAjB,UAAiB,EAAjB,qBAAiB,EAAjB,IAAiB;gBAAjB,4BAAiB;;YAA7B,iBAIC;YAHO,IAAA,KAAA,OAAoB,OAAO,CAAA,EAA1B,MAAM,QAAA,EAAK,IAAI,cAAW,CAAC;YAElC,gEAAW,YAAY,GAAK,MAAM,WAAO,IAAI,mBAAE;;SAChD;QACH,cAAC;KANM,CAAc,IAAI,GAMvB;AACJ,CAAC;SAEe,uBAAuB,CACrC,SAAY,EACZ,YAA0C;IAA1C,6BAAA,EAAA,iBAA0C;IAE1C,IAAM,OAAO,GAAG,EAAE,CAAC;IAEnB,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC;SACtB,MAAM,CAAC,UAAC,EAAK;YAAL,KAAA,aAAK,EAAF,CAAC,QAAA;QAAM,OAAA,OAAO,CAAC,KAAK,UAAU;KAAA,CAAC;SAC1C,OAAO,CAAC,UAAC,EAAM;YAAN,KAAA,aAAM,EAAL,CAAC,QAAA,EAAE,CAAC,QAAA;QACb,OAAO,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC;KAC3C,CAAC,CAAC;IAEL,OAAO,OAAY,CAAC;AACtB;;;ICvGE,sBAAY,EAckB;YAdlB,qBAcgB,EAAE,KAAA,EAb5B,KAAK,WAAA,EACL,QAAQ,cAAA,EACR,UAAU,gBAAA,EACV,IAAI,UAAA,EACJ,YAAY,kBAAA,EACZ,WAAW,iBAAA,EACX,QAAQ,cAAA,EACR,mBAAyB,EAAzB,WAAW,mBAAG,WAAW,KAAA,EACzB,YAA2B,EAA3B,IAAI,mBAAG,oBAAoB,KAAA,EAC3B,iBAAc,EAAd,SAAS,mBAAG,EAAE,KAAA,EACd,eAAW,EAAX,OAAO,mBAAG,CAAC,KAAA,EACX,0BAAyB,EAAzB,kBAAkB,mBAAG,IAAI,KAAA,EACzB,sBAAuB,EAAvB,cAAc,mBAAG,MAAM,KAAA;QAEvB,IAAI,CAAC,WAAW;YAAE,MAAM,IAAI,cAAc,CAAC,4BAA4B,CAAC,CAAC;QAEzE,IAAI,CAAC,GAAG,GAAG,CAAC,IAAI,EAAE,KAAK,EAAE,WAAI,OAAO,CAAE,EAAE,SAAS,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAE7D,IAAI,CAAC,OAAO,GAAG;YACb,YAAY,EAAE,WAAW;SAC1B,CAAC;QACF,IAAI,CAAC,kBAAkB,GAAG,kBAAkB,CAAC;QAC7C,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;;QAGrC,IAAI,UAAU;YAAE,IAAI,CAAC,OAAO,CAAC,aAAa,GAAG,iBAAU,UAAU,CAAE,CAAC;aAC/D,IAAI,QAAQ;YAAE,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,GAAG,QAAQ,CAAC;aACnD,IAAI,KAAK;YAAE,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,GAAG,KAAK,CAAC;;QAGtD,IAAI,YAAY,EAAE;YAChB,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,GAAG,YAAY,CAAC;YAC/C,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,GAAG,WAAW,CAAC;SAC9C;;QAGD,IAAI,IAAI;YAAE,IAAI,CAAC,OAAO,CAAC,IAAI,GAAG,UAAG,IAAI,CAAE,CAAC;;QAGxC,IAAI,CAAC,SAAS,GAAG,WAAW,cAAM,IAAI,EAAG,CAAC;KAC3C;IACH,mBAAC;AAAD,CAAC;;;;"}
|
|
1
|
+
{"version":3,"file":"index.es.js","sources":["../src/RequesterUtils.ts","../src/BaseResource.ts"],"sourcesContent":["import { decamelizeKeys } from 'xcase';\nimport FormData, { Headers } from 'form-data';\nimport { stringify } from 'qs';\n\n// Types\nexport interface Constructable<T = any> {\n new (...args: any[]): T;\n}\n\nexport interface RequesterType {\n get(endpoint: string, options?: Record<string, unknown>): Promise<any>;\n post(endpoint: string, options?: Record<string, unknown>): Promise<any>;\n put(endpoint: string, options?: Record<string, unknown>): Promise<any>;\n delete(endpoint: string, options?: Record<string, unknown>): Promise<any>;\n stream?(endpoint: string, options?: Record<string, unknown>): NodeJS.ReadableStream;\n}\n\nexport type DefaultResourceOptions = {\n headers: { [header: string]: string };\n requestTimeout: number;\n url: string;\n rejectUnauthorized: boolean;\n};\n\nexport type DefaultRequestOptions = {\n body?: FormData | Record<string, unknown>;\n query?: Record<string, unknown>;\n sudo?: string;\n method?: string;\n};\n\nexport type DefaultRequestReturn = {\n headers: Record<string, string> | Headers;\n timeout?: number;\n method: string;\n searchParams?: string;\n prefixUrl?: string;\n body?: string | FormData;\n};\n\n// Utility methods\nexport function formatQuery(params: Record<string, unknown> = {}): string {\n const decamelized = decamelizeKeys(params);\n\n return stringify(decamelized, { arrayFormat: 'brackets' });\n}\n\nexport type OptionsHandlerFn = (\n serviceOptions: DefaultResourceOptions,\n requestOptions: DefaultRequestOptions,\n) => DefaultRequestReturn;\nexport function defaultOptionsHandler(\n resourceOptions: DefaultResourceOptions,\n { body, query, sudo, method = 'get' }: DefaultRequestOptions = {},\n): DefaultRequestReturn {\n const { headers: preconfiguredHeaders, requestTimeout, url } = resourceOptions;\n const headers = { ...preconfiguredHeaders };\n let bod: FormData | string;\n\n if (sudo) headers.sudo = sudo;\n\n // FIXME: Not the best comparison, but...it will have to do for now.\n if (typeof body === 'object' && body.constructor.name !== 'FormData') {\n bod = JSON.stringify(decamelizeKeys(body));\n headers['content-type'] = 'application/json';\n } else {\n bod = body as FormData;\n }\n\n return {\n headers,\n timeout: requestTimeout,\n method,\n searchParams: formatQuery(query),\n prefixUrl: url,\n body: bod,\n };\n}\n\nexport type RequestHandlerFn = (\n endpoint: string,\n options?: Record<string, unknown>,\n) =>\n | any\n | Promise<{\n body: Record<string, unknown> | Record<string, unknown>[];\n headers: Record<string, unknown> | Headers;\n status: number;\n }>;\n\nexport function createRequesterFn(\n optionsHandler: OptionsHandlerFn,\n requestHandler: RequestHandlerFn,\n): (serviceOptions: DefaultResourceOptions) => RequesterType {\n const methods = ['get', 'post', 'put', 'delete', 'stream'];\n\n return (serviceOptions) => {\n const requester: RequesterType = {} as RequesterType;\n\n methods.forEach((m) => {\n requester[m] = (endpoint: string, options: Record<string, unknown>) => {\n const requestOptions = optionsHandler(serviceOptions, { ...options, method: m });\n\n return requestHandler(endpoint, requestOptions);\n };\n });\n\n return requester;\n };\n}\n\nfunction extendClass<T extends Constructable>(Base: T, customConfig: Record<string, unknown>): T {\n return class extends Base {\n constructor(...options: any[]) {\n const [config, ...opts] = options;\n\n super({ ...customConfig, ...config }, ...opts);\n }\n };\n}\n\nexport function presetResourceArguments<T>(\n resources: T,\n customConfig: Record<string, unknown> = {},\n) {\n const updated = {};\n\n Object.entries(resources)\n .filter(([, s]) => typeof s === 'function') // FIXME: Odd default artifact included in this list during testing\n .forEach(([k, r]) => {\n updated[k] = extendClass(r, customConfig);\n });\n\n return updated as T;\n}\n","import { RequesterType, DefaultResourceOptions } from './RequesterUtils';\n\nexport interface BaseResourceOptions<C> {\n oauthToken?: string;\n token?: string;\n jobToken?: string;\n host?: string;\n prefixUrl?: string;\n version?: 3 | 4;\n rejectUnauthorized?: boolean;\n camelize?: C;\n requesterFn?: (resourceOptions: DefaultResourceOptions) => RequesterType;\n requestTimeout?: number;\n profileToken?: string;\n sudo?: string | number;\n profileMode?: 'execution' | 'memory';\n}\n\nexport class BaseResource<C extends boolean = false> {\n public readonly url: string;\n\n public readonly requester: RequesterType;\n\n public readonly requestTimeout: number;\n\n public readonly headers: { [header: string]: string };\n\n public readonly camelize: C | undefined;\n\n public readonly rejectUnauthorized: boolean;\n\n constructor({\n token,\n jobToken,\n oauthToken,\n sudo,\n profileToken,\n requesterFn,\n camelize,\n profileMode = 'execution',\n host = 'https://gitlab.com',\n prefixUrl = '',\n version = 4,\n rejectUnauthorized = true,\n requestTimeout = 300000,\n }: BaseResourceOptions<C> = {}) {\n if (!requesterFn) throw new ReferenceError('requesterFn must be passed');\n\n this.url = [host, 'api', `v${version}`, prefixUrl].join('/');\n\n this.headers = {\n 'user-agent': 'gitbeaker',\n };\n this.rejectUnauthorized = rejectUnauthorized;\n this.camelize = camelize;\n this.requestTimeout = requestTimeout;\n\n // Handle auth tokens\n if (oauthToken) this.headers.authorization = `Bearer ${oauthToken}`;\n else if (jobToken) this.headers['job-token'] = jobToken;\n else if (token) this.headers['private-token'] = token;\n\n // Profiling\n if (profileToken) {\n this.headers['X-Profile-Token'] = profileToken;\n this.headers['X-Profile-Mode'] = profileMode;\n }\n\n // Set sudo\n if (sudo) this.headers.Sudo = `${sudo}`;\n\n // Set requester instance using this information\n this.requester = requesterFn({ ...this });\n }\n}\n"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAwCA;AACM,SAAU,WAAW,CAAC,MAAoC,EAAA;AAApC,IAAA,IAAA,MAAA,KAAA,KAAA,CAAA,EAAA,EAAA,MAAoC,GAAA,EAAA,CAAA,EAAA;AAC9D,IAAA,IAAM,WAAW,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC;IAE3C,OAAO,SAAS,CAAC,WAAW,EAAE,EAAE,WAAW,EAAE,UAAU,EAAE,CAAC,CAAC;AAC7D,CAAC;AAMe,SAAA,qBAAqB,CACnC,eAAuC,EACvC,EAAiE,EAAA;AAAjE,IAAA,IAAA,EAAA,GAAA,EAAA,KAAA,KAAA,CAAA,GAA+D,EAAE,GAAA,EAAA,EAA/D,IAAI,GAAA,EAAA,CAAA,IAAA,EAAE,KAAK,GAAA,EAAA,CAAA,KAAA,EAAE,IAAI,UAAA,EAAE,EAAA,GAAA,EAAA,CAAA,MAAc,EAAd,MAAM,GAAA,EAAA,KAAA,KAAA,CAAA,GAAG,KAAK,GAAA,EAAA,CAAA;AAE3B,IAAA,IAAS,oBAAoB,GAA0B,eAAe,CAAA,OAAzC,EAAE,cAAc,GAAU,eAAe,CAAA,cAAzB,EAAE,GAAG,GAAK,eAAe,IAApB,CAAqB;AAC/E,IAAA,IAAM,OAAO,GAAA,QAAA,CAAA,EAAA,EAAQ,oBAAoB,CAAE,CAAC;AAC5C,IAAA,IAAI,GAAsB,CAAC;AAE3B,IAAA,IAAI,IAAI;AAAE,QAAA,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC;;AAG9B,IAAA,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,CAAC,WAAW,CAAC,IAAI,KAAK,UAAU,EAAE;QACpE,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC;AAC3C,QAAA,OAAO,CAAC,cAAc,CAAC,GAAG,kBAAkB,CAAC;AAC9C,KAAA;AAAM,SAAA;QACL,GAAG,GAAG,IAAgB,CAAC;AACxB,KAAA;IAED,OAAO;AACL,QAAA,OAAO,EAAA,OAAA;AACP,QAAA,OAAO,EAAE,cAAc;AACvB,QAAA,MAAM,EAAA,MAAA;AACN,QAAA,YAAY,EAAE,WAAW,CAAC,KAAK,CAAC;AAChC,QAAA,SAAS,EAAE,GAAG;AACd,QAAA,IAAI,EAAE,GAAG;KACV,CAAC;AACJ,CAAC;AAae,SAAA,iBAAiB,CAC/B,cAAgC,EAChC,cAAgC,EAAA;AAEhC,IAAA,IAAM,OAAO,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;AAE3D,IAAA,OAAO,UAAC,cAAc,EAAA;QACpB,IAAM,SAAS,GAAkB,EAAmB,CAAC;AAErD,QAAA,OAAO,CAAC,OAAO,CAAC,UAAC,CAAC,EAAA;AAChB,YAAA,SAAS,CAAC,CAAC,CAAC,GAAG,UAAC,QAAgB,EAAE,OAAgC,EAAA;AAChE,gBAAA,IAAM,cAAc,GAAG,cAAc,CAAC,cAAc,EAAA,QAAA,CAAA,QAAA,CAAA,EAAA,EAAO,OAAO,CAAA,EAAA,EAAE,MAAM,EAAE,CAAC,EAAA,CAAA,CAAG,CAAC;AAEjF,gBAAA,OAAO,cAAc,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAC;AAClD,aAAC,CAAC;AACJ,SAAC,CAAC,CAAC;AAEH,QAAA,OAAO,SAAS,CAAC;AACnB,KAAC,CAAC;AACJ,CAAC;AAED,SAAS,WAAW,CAA0B,IAAO,EAAE,YAAqC,EAAA;AAC1F,IAAA,sBAAA,UAAA,MAAA,EAAA;QAAqB,SAAI,CAAA,OAAA,EAAA,MAAA,CAAA,CAAA;AACvB,QAAA,SAAA,OAAA,GAAA;YAAY,IAAiB,OAAA,GAAA,EAAA,CAAA;iBAAjB,IAAiB,EAAA,GAAA,CAAA,EAAjB,EAAiB,GAAA,SAAA,CAAA,MAAA,EAAjB,EAAiB,EAAA,EAAA;gBAAjB,OAAiB,CAAA,EAAA,CAAA,GAAA,SAAA,CAAA,EAAA,CAAA,CAAA;;YAA7B,IAIC,KAAA,GAAA,IAAA,CAAA;YAHO,IAAA,EAAA,GAAA,MAAoB,CAAA,OAAO,CAAA,EAA1B,MAAM,GAAA,EAAA,CAAA,CAAA,CAAA,EAAK,IAAI,GAAA,EAAA,CAAA,KAAA,CAAA,CAAA,CAAW,CAAC;AAElC,YAAA,KAAA,GAAA,MAAA,CAAA,KAAA,CAAA,IAAA,EAAA,aAAA,CAAA,CAAA,QAAA,CAAA,QAAA,CAAA,EAAA,EAAW,YAAY,CAAA,EAAK,MAAM,CAAA,CAAA,EAAA,MAAA,CAAO,IAAI,CAAE,EAAA,KAAA,CAAA,CAAA,IAAA,IAAA,CAAA;;SAChD;QACH,OAAC,OAAA,CAAA;KANM,CAAc,IAAI,CAMvB,EAAA;AACJ,CAAC;AAEe,SAAA,uBAAuB,CACrC,SAAY,EACZ,YAA0C,EAAA;AAA1C,IAAA,IAAA,YAAA,KAAA,KAAA,CAAA,EAAA,EAAA,YAA0C,GAAA,EAAA,CAAA,EAAA;IAE1C,IAAM,OAAO,GAAG,EAAE,CAAC;AAEnB,IAAA,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC;SACtB,MAAM,CAAC,UAAC,EAAK,EAAA;YAAL,EAAA,GAAA,MAAA,CAAA,EAAA,EAAA,CAAA,CAAK,EAAF,CAAC,GAAA,EAAA,CAAA,CAAA,CAAA,CAAA;QAAM,OAAA,OAAO,CAAC,KAAK,UAAU,CAAA;KAAA,CAAC;SAC1C,OAAO,CAAC,UAAC,EAAM,EAAA;AAAN,QAAA,IAAA,EAAA,GAAA,aAAM,EAAL,CAAC,GAAA,EAAA,CAAA,CAAA,CAAA,EAAE,CAAC,GAAA,EAAA,CAAA,CAAA,CAAA,CAAA;QACb,OAAO,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC;AAC5C,KAAC,CAAC,CAAC;AAEL,IAAA,OAAO,OAAY,CAAC;AACtB;;ACpHA,IAAA,YAAA,kBAAA,YAAA;AAaE,IAAA,SAAA,YAAA,CAAY,EAckB,EAAA;AAdlB,QAAA,IAAA,EAAA,GAAA,EAAA,KAAA,KAAA,CAAA,GAcgB,EAAE,GAAA,EAAA,EAb5B,KAAK,GAAA,EAAA,CAAA,KAAA,EACL,QAAQ,GAAA,EAAA,CAAA,QAAA,EACR,UAAU,GAAA,EAAA,CAAA,UAAA,EACV,IAAI,GAAA,EAAA,CAAA,IAAA,EACJ,YAAY,GAAA,EAAA,CAAA,YAAA,EACZ,WAAW,GAAA,EAAA,CAAA,WAAA,EACX,QAAQ,GAAA,EAAA,CAAA,QAAA,EACR,EAAA,GAAA,EAAA,CAAA,WAAyB,EAAzB,WAAW,GAAG,EAAA,KAAA,KAAA,CAAA,GAAA,WAAW,KAAA,EACzB,EAAA,GAAA,EAAA,CAAA,IAA2B,EAA3B,IAAI,GAAG,EAAA,KAAA,KAAA,CAAA,GAAA,oBAAoB,GAAA,EAAA,EAC3B,EAAc,GAAA,EAAA,CAAA,SAAA,EAAd,SAAS,GAAA,EAAA,KAAA,KAAA,CAAA,GAAG,EAAE,GAAA,EAAA,EACd,EAAA,GAAA,EAAA,CAAA,OAAW,EAAX,OAAO,GAAA,EAAA,KAAA,KAAA,CAAA,GAAG,CAAC,GAAA,EAAA,EACX,EAAA,GAAA,EAAA,CAAA,kBAAyB,EAAzB,kBAAkB,GAAG,EAAA,KAAA,KAAA,CAAA,GAAA,IAAI,GAAA,EAAA,EACzB,EAAuB,GAAA,EAAA,CAAA,cAAA,EAAvB,cAAc,GAAA,EAAA,KAAA,KAAA,CAAA,GAAG,MAAM,GAAA,EAAA,CAAA;AAEvB,QAAA,IAAI,CAAC,WAAW;AAAE,YAAA,MAAM,IAAI,cAAc,CAAC,4BAA4B,CAAC,CAAC;AAEzE,QAAA,IAAI,CAAC,GAAG,GAAG,CAAC,IAAI,EAAE,KAAK,EAAE,GAAA,CAAA,MAAA,CAAI,OAAO,CAAE,EAAE,SAAS,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAE7D,IAAI,CAAC,OAAO,GAAG;AACb,YAAA,YAAY,EAAE,WAAW;SAC1B,CAAC;AACF,QAAA,IAAI,CAAC,kBAAkB,GAAG,kBAAkB,CAAC;AAC7C,QAAA,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;AACzB,QAAA,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;;AAGrC,QAAA,IAAI,UAAU;YAAE,IAAI,CAAC,OAAO,CAAC,aAAa,GAAG,SAAU,CAAA,MAAA,CAAA,UAAU,CAAE,CAAC;AAC/D,aAAA,IAAI,QAAQ;AAAE,YAAA,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,GAAG,QAAQ,CAAC;AACnD,aAAA,IAAI,KAAK;AAAE,YAAA,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,GAAG,KAAK,CAAC;;AAGtD,QAAA,IAAI,YAAY,EAAE;AAChB,YAAA,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,GAAG,YAAY,CAAC;AAC/C,YAAA,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,GAAG,WAAW,CAAC;AAC9C,SAAA;;AAGD,QAAA,IAAI,IAAI;YAAE,IAAI,CAAC,OAAO,CAAC,IAAI,GAAG,EAAG,CAAA,MAAA,CAAA,IAAI,CAAE,CAAC;;AAGxC,QAAA,IAAI,CAAC,SAAS,GAAG,WAAW,CAAM,QAAA,CAAA,EAAA,EAAA,IAAI,EAAG,CAAC;KAC3C;IACH,OAAC,YAAA,CAAA;AAAD,CAAC,EAAA;;;;"}
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sources":["../src/RequesterUtils.ts","../src/BaseResource.ts"],"sourcesContent":["import { decamelizeKeys } from 'xcase';\nimport FormData, { Headers } from 'form-data';\nimport { stringify } from 'qs';\n\n// Types\nexport interface Constructable<T = any> {\n new (...args: any[]): T;\n}\n\nexport interface RequesterType {\n get(endpoint: string, options?: Record<string, unknown>): Promise<any>;\n post(endpoint: string, options?: Record<string, unknown>): Promise<any>;\n put(endpoint: string, options?: Record<string, unknown>): Promise<any>;\n delete(endpoint: string, options?: Record<string, unknown>): Promise<any>;\n stream?(endpoint: string, options?: Record<string, unknown>): NodeJS.ReadableStream;\n}\n\nexport type DefaultResourceOptions = {\n headers: { [header: string]: string };\n requestTimeout: number;\n url: string;\n rejectUnauthorized: boolean;\n};\n\nexport type DefaultRequestOptions = {\n body?: FormData | Record<string, unknown>;\n query?: Record<string, unknown>;\n sudo?: string;\n method?: string;\n};\n\nexport type DefaultRequestReturn = {\n headers: Record<string, string> | Headers;\n timeout?: number;\n method: string;\n searchParams?: string;\n prefixUrl?: string;\n body?: string | FormData;\n};\n\n// Utility methods\nexport function formatQuery(params: Record<string, unknown> = {}): string {\n const decamelized = decamelizeKeys(params);\n\n return stringify(decamelized, { arrayFormat: 'brackets' });\n}\n\nexport type OptionsHandlerFn = (\n serviceOptions: DefaultResourceOptions,\n requestOptions: DefaultRequestOptions,\n) => DefaultRequestReturn;\nexport function defaultOptionsHandler(\n resourceOptions: DefaultResourceOptions,\n { body, query, sudo, method = 'get' }: DefaultRequestOptions = {},\n): DefaultRequestReturn {\n const { headers: preconfiguredHeaders, requestTimeout, url } = resourceOptions;\n const headers = { ...preconfiguredHeaders };\n let bod: FormData | string;\n\n if (sudo) headers.sudo = sudo;\n\n // FIXME: Not the best comparison, but...it will have to do for now.\n if (typeof body === 'object' && body.constructor.name !== 'FormData') {\n bod = JSON.stringify(decamelizeKeys(body));\n headers['content-type'] = 'application/json';\n } else {\n bod = body as FormData;\n }\n\n return {\n headers,\n timeout: requestTimeout,\n method,\n searchParams: formatQuery(query),\n prefixUrl: url,\n body: bod,\n };\n}\n\nexport type RequestHandlerFn = (\n endpoint: string,\n options?: Record<string, unknown>,\n) =>\n | any\n | Promise<{\n body: Record<string, unknown> | Record<string, unknown>[];\n headers: Record<string, unknown> | Headers;\n status: number;\n }>;\n\nexport function createRequesterFn(\n optionsHandler: OptionsHandlerFn,\n requestHandler: RequestHandlerFn,\n): (serviceOptions: DefaultResourceOptions) => RequesterType {\n const methods = ['get', 'post', 'put', 'delete', 'stream'];\n\n return (serviceOptions) => {\n const requester: RequesterType = {} as RequesterType;\n\n methods.forEach((m) => {\n requester[m] = (endpoint: string, options: Record<string, unknown>) => {\n const requestOptions = optionsHandler(serviceOptions, { ...options, method: m });\n\n return requestHandler(endpoint, requestOptions);\n };\n });\n\n return requester;\n };\n}\n\nfunction extendClass<T extends Constructable>(Base: T, customConfig: Record<string, unknown>): T {\n return class extends Base {\n constructor(...options: any[]) {\n const [config, ...opts] = options;\n\n super({ ...customConfig, ...config }, ...opts);\n }\n };\n}\n\nexport function presetResourceArguments<T>(\n resources: T,\n customConfig: Record<string, unknown> = {},\n) {\n const updated = {};\n\n Object.entries(resources)\n .filter(([, s]) => typeof s === 'function') // FIXME: Odd default artifact included in this list during testing\n .forEach(([k, r]) => {\n updated[k] = extendClass(r, customConfig);\n });\n\n return updated as T;\n}\n","import { RequesterType, DefaultResourceOptions } from './RequesterUtils';\n\nexport interface BaseResourceOptions<C> {\n oauthToken?: string;\n token?: string;\n jobToken?: string;\n host?: string;\n prefixUrl?: string;\n version?: 3 | 4;\n rejectUnauthorized?: boolean;\n camelize?: C;\n requesterFn?: (resourceOptions: DefaultResourceOptions) => RequesterType;\n requestTimeout?: number;\n profileToken?: string;\n sudo?: string | number;\n profileMode?: 'execution' | 'memory';\n}\n\nexport class BaseResource<C extends boolean = false> {\n public readonly url: string;\n\n public readonly requester: RequesterType;\n\n public readonly requestTimeout: number;\n\n public readonly headers: { [header: string]: string };\n\n public readonly camelize: C | undefined;\n\n public readonly rejectUnauthorized: boolean;\n\n constructor({\n token,\n jobToken,\n oauthToken,\n sudo,\n profileToken,\n requesterFn,\n camelize,\n profileMode = 'execution',\n host = 'https://gitlab.com',\n prefixUrl = '',\n version = 4,\n rejectUnauthorized = true,\n requestTimeout = 300000,\n }: BaseResourceOptions<C> = {}) {\n if (!requesterFn) throw new ReferenceError('requesterFn must be passed');\n\n this.url = [host, 'api', `v${version}`, prefixUrl].join('/');\n\n this.headers = {\n 'user-agent': 'gitbeaker',\n };\n this.rejectUnauthorized = rejectUnauthorized;\n this.camelize = camelize;\n this.requestTimeout = requestTimeout;\n\n // Handle auth tokens\n if (oauthToken) this.headers.authorization = `Bearer ${oauthToken}`;\n else if (jobToken) this.headers['job-token'] = jobToken;\n else if (token) this.headers['private-token'] = token;\n\n // Profiling\n if (profileToken) {\n this.headers['X-Profile-Token'] = profileToken;\n this.headers['X-Profile-Mode'] = profileMode;\n }\n\n // Set sudo\n if (sudo) this.headers.Sudo = `${sudo}`;\n\n // Set requester instance using this information\n this.requester = requesterFn({ ...this });\n }\n}\n"],"names":["decamelizeKeys","stringify"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAwCA;SACgB,WAAW,CAAC,MAAoC;IAApC,uBAAA,EAAA,WAAoC;IAC9D,IAAM,WAAW,GAAGA,oBAAc,CAAC,MAAM,CAAC,CAAC;IAE3C,OAAOC,YAAS,CAAC,WAAW,EAAE,EAAE,WAAW,EAAE,UAAU,EAAE,CAAC,CAAC;AAC7D,CAAC;SAMe,qBAAqB,CACnC,eAAuC,EACvC,EAAiE;QAAjE,qBAA+D,EAAE,KAAA,EAA/D,IAAI,UAAA,EAAE,KAAK,WAAA,EAAE,IAAI,UAAA,EAAE,cAAc,EAAd,MAAM,mBAAG,KAAK,KAAA;IAE3B,IAAS,oBAAoB,GAA0B,eAAe,QAAzC,EAAE,cAAc,GAAU,eAAe,eAAzB,EAAE,GAAG,GAAK,eAAe,IAApB,CAAqB;IAC/E,IAAM,OAAO,gBAAQ,oBAAoB,CAAE,CAAC;IAC5C,IAAI,GAAsB,CAAC;IAE3B,IAAI,IAAI;QAAE,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC;;IAG9B,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,CAAC,WAAW,CAAC,IAAI,KAAK,UAAU,EAAE;QACpE,GAAG,GAAG,IAAI,CAAC,SAAS,CAACD,oBAAc,CAAC,IAAI,CAAC,CAAC,CAAC;QAC3C,OAAO,CAAC,cAAc,CAAC,GAAG,kBAAkB,CAAC;KAC9C;SAAM;QACL,GAAG,GAAG,IAAgB,CAAC;KACxB;IAED,OAAO;QACL,OAAO,SAAA;QACP,OAAO,EAAE,cAAc;QACvB,MAAM,QAAA;QACN,YAAY,EAAE,WAAW,CAAC,KAAK,CAAC;QAChC,SAAS,EAAE,GAAG;QACd,IAAI,EAAE,GAAG;KACV,CAAC;AACJ,CAAC;SAae,iBAAiB,CAC/B,cAAgC,EAChC,cAAgC;IAEhC,IAAM,OAAO,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;IAE3D,OAAO,UAAC,cAAc;QACpB,IAAM,SAAS,GAAkB,EAAmB,CAAC;QAErD,OAAO,CAAC,OAAO,CAAC,UAAC,CAAC;YAChB,SAAS,CAAC,CAAC,CAAC,GAAG,UAAC,QAAgB,EAAE,OAAgC;gBAChE,IAAM,cAAc,GAAG,cAAc,CAAC,cAAc,wBAAO,OAAO,KAAE,MAAM,EAAE,CAAC,IAAG,CAAC;gBAEjF,OAAO,cAAc,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAC;aACjD,CAAC;SACH,CAAC,CAAC;QAEH,OAAO,SAAS,CAAC;KAClB,CAAC;AACJ,CAAC;AAED,SAAS,WAAW,CAA0B,IAAO,EAAE,YAAqC;IAC1F;QAAqB,2BAAI;QACvB;YAAY,iBAAiB;iBAAjB,UAAiB,EAAjB,qBAAiB,EAAjB,IAAiB;gBAAjB,4BAAiB;;YAA7B,iBAIC;YAHO,IAAA,KAAA,OAAoB,OAAO,CAAA,EAA1B,MAAM,QAAA,EAAK,IAAI,cAAW,CAAC;YAElC,gEAAW,YAAY,GAAK,MAAM,WAAO,IAAI,mBAAE;;SAChD;QACH,cAAC;KANM,CAAc,IAAI,GAMvB;AACJ,CAAC;SAEe,uBAAuB,CACrC,SAAY,EACZ,YAA0C;IAA1C,6BAAA,EAAA,iBAA0C;IAE1C,IAAM,OAAO,GAAG,EAAE,CAAC;IAEnB,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC;SACtB,MAAM,CAAC,UAAC,EAAK;YAAL,KAAA,aAAK,EAAF,CAAC,QAAA;QAAM,OAAA,OAAO,CAAC,KAAK,UAAU;KAAA,CAAC;SAC1C,OAAO,CAAC,UAAC,EAAM;YAAN,KAAA,aAAM,EAAL,CAAC,QAAA,EAAE,CAAC,QAAA;QACb,OAAO,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC;KAC3C,CAAC,CAAC;IAEL,OAAO,OAAY,CAAC;AACtB;;;ICvGE,sBAAY,EAckB;YAdlB,qBAcgB,EAAE,KAAA,EAb5B,KAAK,WAAA,EACL,QAAQ,cAAA,EACR,UAAU,gBAAA,EACV,IAAI,UAAA,EACJ,YAAY,kBAAA,EACZ,WAAW,iBAAA,EACX,QAAQ,cAAA,EACR,mBAAyB,EAAzB,WAAW,mBAAG,WAAW,KAAA,EACzB,YAA2B,EAA3B,IAAI,mBAAG,oBAAoB,KAAA,EAC3B,iBAAc,EAAd,SAAS,mBAAG,EAAE,KAAA,EACd,eAAW,EAAX,OAAO,mBAAG,CAAC,KAAA,EACX,0BAAyB,EAAzB,kBAAkB,mBAAG,IAAI,KAAA,EACzB,sBAAuB,EAAvB,cAAc,mBAAG,MAAM,KAAA;QAEvB,IAAI,CAAC,WAAW;YAAE,MAAM,IAAI,cAAc,CAAC,4BAA4B,CAAC,CAAC;QAEzE,IAAI,CAAC,GAAG,GAAG,CAAC,IAAI,EAAE,KAAK,EAAE,WAAI,OAAO,CAAE,EAAE,SAAS,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAE7D,IAAI,CAAC,OAAO,GAAG;YACb,YAAY,EAAE,WAAW;SAC1B,CAAC;QACF,IAAI,CAAC,kBAAkB,GAAG,kBAAkB,CAAC;QAC7C,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;;QAGrC,IAAI,UAAU;YAAE,IAAI,CAAC,OAAO,CAAC,aAAa,GAAG,iBAAU,UAAU,CAAE,CAAC;aAC/D,IAAI,QAAQ;YAAE,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,GAAG,QAAQ,CAAC;aACnD,IAAI,KAAK;YAAE,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,GAAG,KAAK,CAAC;;QAGtD,IAAI,YAAY,EAAE;YAChB,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,GAAG,YAAY,CAAC;YAC/C,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,GAAG,WAAW,CAAC;SAC9C;;QAGD,IAAI,IAAI;YAAE,IAAI,CAAC,OAAO,CAAC,IAAI,GAAG,UAAG,IAAI,CAAE,CAAC;;QAGxC,IAAI,CAAC,SAAS,GAAG,WAAW,cAAM,IAAI,EAAG,CAAC;KAC3C;IACH,mBAAC;AAAD,CAAC;;;;;;;;"}
|
|
1
|
+
{"version":3,"file":"index.js","sources":["../src/RequesterUtils.ts","../src/BaseResource.ts"],"sourcesContent":["import { decamelizeKeys } from 'xcase';\nimport FormData, { Headers } from 'form-data';\nimport { stringify } from 'qs';\n\n// Types\nexport interface Constructable<T = any> {\n new (...args: any[]): T;\n}\n\nexport interface RequesterType {\n get(endpoint: string, options?: Record<string, unknown>): Promise<any>;\n post(endpoint: string, options?: Record<string, unknown>): Promise<any>;\n put(endpoint: string, options?: Record<string, unknown>): Promise<any>;\n delete(endpoint: string, options?: Record<string, unknown>): Promise<any>;\n stream?(endpoint: string, options?: Record<string, unknown>): NodeJS.ReadableStream;\n}\n\nexport type DefaultResourceOptions = {\n headers: { [header: string]: string };\n requestTimeout: number;\n url: string;\n rejectUnauthorized: boolean;\n};\n\nexport type DefaultRequestOptions = {\n body?: FormData | Record<string, unknown>;\n query?: Record<string, unknown>;\n sudo?: string;\n method?: string;\n};\n\nexport type DefaultRequestReturn = {\n headers: Record<string, string> | Headers;\n timeout?: number;\n method: string;\n searchParams?: string;\n prefixUrl?: string;\n body?: string | FormData;\n};\n\n// Utility methods\nexport function formatQuery(params: Record<string, unknown> = {}): string {\n const decamelized = decamelizeKeys(params);\n\n return stringify(decamelized, { arrayFormat: 'brackets' });\n}\n\nexport type OptionsHandlerFn = (\n serviceOptions: DefaultResourceOptions,\n requestOptions: DefaultRequestOptions,\n) => DefaultRequestReturn;\nexport function defaultOptionsHandler(\n resourceOptions: DefaultResourceOptions,\n { body, query, sudo, method = 'get' }: DefaultRequestOptions = {},\n): DefaultRequestReturn {\n const { headers: preconfiguredHeaders, requestTimeout, url } = resourceOptions;\n const headers = { ...preconfiguredHeaders };\n let bod: FormData | string;\n\n if (sudo) headers.sudo = sudo;\n\n // FIXME: Not the best comparison, but...it will have to do for now.\n if (typeof body === 'object' && body.constructor.name !== 'FormData') {\n bod = JSON.stringify(decamelizeKeys(body));\n headers['content-type'] = 'application/json';\n } else {\n bod = body as FormData;\n }\n\n return {\n headers,\n timeout: requestTimeout,\n method,\n searchParams: formatQuery(query),\n prefixUrl: url,\n body: bod,\n };\n}\n\nexport type RequestHandlerFn = (\n endpoint: string,\n options?: Record<string, unknown>,\n) =>\n | any\n | Promise<{\n body: Record<string, unknown> | Record<string, unknown>[];\n headers: Record<string, unknown> | Headers;\n status: number;\n }>;\n\nexport function createRequesterFn(\n optionsHandler: OptionsHandlerFn,\n requestHandler: RequestHandlerFn,\n): (serviceOptions: DefaultResourceOptions) => RequesterType {\n const methods = ['get', 'post', 'put', 'delete', 'stream'];\n\n return (serviceOptions) => {\n const requester: RequesterType = {} as RequesterType;\n\n methods.forEach((m) => {\n requester[m] = (endpoint: string, options: Record<string, unknown>) => {\n const requestOptions = optionsHandler(serviceOptions, { ...options, method: m });\n\n return requestHandler(endpoint, requestOptions);\n };\n });\n\n return requester;\n };\n}\n\nfunction extendClass<T extends Constructable>(Base: T, customConfig: Record<string, unknown>): T {\n return class extends Base {\n constructor(...options: any[]) {\n const [config, ...opts] = options;\n\n super({ ...customConfig, ...config }, ...opts);\n }\n };\n}\n\nexport function presetResourceArguments<T>(\n resources: T,\n customConfig: Record<string, unknown> = {},\n) {\n const updated = {};\n\n Object.entries(resources)\n .filter(([, s]) => typeof s === 'function') // FIXME: Odd default artifact included in this list during testing\n .forEach(([k, r]) => {\n updated[k] = extendClass(r, customConfig);\n });\n\n return updated as T;\n}\n","import { RequesterType, DefaultResourceOptions } from './RequesterUtils';\n\nexport interface BaseResourceOptions<C> {\n oauthToken?: string;\n token?: string;\n jobToken?: string;\n host?: string;\n prefixUrl?: string;\n version?: 3 | 4;\n rejectUnauthorized?: boolean;\n camelize?: C;\n requesterFn?: (resourceOptions: DefaultResourceOptions) => RequesterType;\n requestTimeout?: number;\n profileToken?: string;\n sudo?: string | number;\n profileMode?: 'execution' | 'memory';\n}\n\nexport class BaseResource<C extends boolean = false> {\n public readonly url: string;\n\n public readonly requester: RequesterType;\n\n public readonly requestTimeout: number;\n\n public readonly headers: { [header: string]: string };\n\n public readonly camelize: C | undefined;\n\n public readonly rejectUnauthorized: boolean;\n\n constructor({\n token,\n jobToken,\n oauthToken,\n sudo,\n profileToken,\n requesterFn,\n camelize,\n profileMode = 'execution',\n host = 'https://gitlab.com',\n prefixUrl = '',\n version = 4,\n rejectUnauthorized = true,\n requestTimeout = 300000,\n }: BaseResourceOptions<C> = {}) {\n if (!requesterFn) throw new ReferenceError('requesterFn must be passed');\n\n this.url = [host, 'api', `v${version}`, prefixUrl].join('/');\n\n this.headers = {\n 'user-agent': 'gitbeaker',\n };\n this.rejectUnauthorized = rejectUnauthorized;\n this.camelize = camelize;\n this.requestTimeout = requestTimeout;\n\n // Handle auth tokens\n if (oauthToken) this.headers.authorization = `Bearer ${oauthToken}`;\n else if (jobToken) this.headers['job-token'] = jobToken;\n else if (token) this.headers['private-token'] = token;\n\n // Profiling\n if (profileToken) {\n this.headers['X-Profile-Token'] = profileToken;\n this.headers['X-Profile-Mode'] = profileMode;\n }\n\n // Set sudo\n if (sudo) this.headers.Sudo = `${sudo}`;\n\n // Set requester instance using this information\n this.requester = requesterFn({ ...this });\n }\n}\n"],"names":["decamelizeKeys","stringify"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAwCA;AACM,SAAU,WAAW,CAAC,MAAoC,EAAA;AAApC,IAAA,IAAA,MAAA,KAAA,KAAA,CAAA,EAAA,EAAA,MAAoC,GAAA,EAAA,CAAA,EAAA;AAC9D,IAAA,IAAM,WAAW,GAAGA,oBAAc,CAAC,MAAM,CAAC,CAAC;IAE3C,OAAOC,YAAS,CAAC,WAAW,EAAE,EAAE,WAAW,EAAE,UAAU,EAAE,CAAC,CAAC;AAC7D,CAAC;AAMe,SAAA,qBAAqB,CACnC,eAAuC,EACvC,EAAiE,EAAA;AAAjE,IAAA,IAAA,EAAA,GAAA,EAAA,KAAA,KAAA,CAAA,GAA+D,EAAE,GAAA,EAAA,EAA/D,IAAI,GAAA,EAAA,CAAA,IAAA,EAAE,KAAK,GAAA,EAAA,CAAA,KAAA,EAAE,IAAI,UAAA,EAAE,EAAA,GAAA,EAAA,CAAA,MAAc,EAAd,MAAM,GAAA,EAAA,KAAA,KAAA,CAAA,GAAG,KAAK,GAAA,EAAA,CAAA;AAE3B,IAAA,IAAS,oBAAoB,GAA0B,eAAe,CAAA,OAAzC,EAAE,cAAc,GAAU,eAAe,CAAA,cAAzB,EAAE,GAAG,GAAK,eAAe,IAApB,CAAqB;AAC/E,IAAA,IAAM,OAAO,GAAA,QAAA,CAAA,EAAA,EAAQ,oBAAoB,CAAE,CAAC;AAC5C,IAAA,IAAI,GAAsB,CAAC;AAE3B,IAAA,IAAI,IAAI;AAAE,QAAA,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC;;AAG9B,IAAA,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,CAAC,WAAW,CAAC,IAAI,KAAK,UAAU,EAAE;QACpE,GAAG,GAAG,IAAI,CAAC,SAAS,CAACD,oBAAc,CAAC,IAAI,CAAC,CAAC,CAAC;AAC3C,QAAA,OAAO,CAAC,cAAc,CAAC,GAAG,kBAAkB,CAAC;AAC9C,KAAA;AAAM,SAAA;QACL,GAAG,GAAG,IAAgB,CAAC;AACxB,KAAA;IAED,OAAO;AACL,QAAA,OAAO,EAAA,OAAA;AACP,QAAA,OAAO,EAAE,cAAc;AACvB,QAAA,MAAM,EAAA,MAAA;AACN,QAAA,YAAY,EAAE,WAAW,CAAC,KAAK,CAAC;AAChC,QAAA,SAAS,EAAE,GAAG;AACd,QAAA,IAAI,EAAE,GAAG;KACV,CAAC;AACJ,CAAC;AAae,SAAA,iBAAiB,CAC/B,cAAgC,EAChC,cAAgC,EAAA;AAEhC,IAAA,IAAM,OAAO,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;AAE3D,IAAA,OAAO,UAAC,cAAc,EAAA;QACpB,IAAM,SAAS,GAAkB,EAAmB,CAAC;AAErD,QAAA,OAAO,CAAC,OAAO,CAAC,UAAC,CAAC,EAAA;AAChB,YAAA,SAAS,CAAC,CAAC,CAAC,GAAG,UAAC,QAAgB,EAAE,OAAgC,EAAA;AAChE,gBAAA,IAAM,cAAc,GAAG,cAAc,CAAC,cAAc,EAAA,QAAA,CAAA,QAAA,CAAA,EAAA,EAAO,OAAO,CAAA,EAAA,EAAE,MAAM,EAAE,CAAC,EAAA,CAAA,CAAG,CAAC;AAEjF,gBAAA,OAAO,cAAc,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAC;AAClD,aAAC,CAAC;AACJ,SAAC,CAAC,CAAC;AAEH,QAAA,OAAO,SAAS,CAAC;AACnB,KAAC,CAAC;AACJ,CAAC;AAED,SAAS,WAAW,CAA0B,IAAO,EAAE,YAAqC,EAAA;AAC1F,IAAA,sBAAA,UAAA,MAAA,EAAA;QAAqB,SAAI,CAAA,OAAA,EAAA,MAAA,CAAA,CAAA;AACvB,QAAA,SAAA,OAAA,GAAA;YAAY,IAAiB,OAAA,GAAA,EAAA,CAAA;iBAAjB,IAAiB,EAAA,GAAA,CAAA,EAAjB,EAAiB,GAAA,SAAA,CAAA,MAAA,EAAjB,EAAiB,EAAA,EAAA;gBAAjB,OAAiB,CAAA,EAAA,CAAA,GAAA,SAAA,CAAA,EAAA,CAAA,CAAA;;YAA7B,IAIC,KAAA,GAAA,IAAA,CAAA;YAHO,IAAA,EAAA,GAAA,MAAoB,CAAA,OAAO,CAAA,EAA1B,MAAM,GAAA,EAAA,CAAA,CAAA,CAAA,EAAK,IAAI,GAAA,EAAA,CAAA,KAAA,CAAA,CAAA,CAAW,CAAC;AAElC,YAAA,KAAA,GAAA,MAAA,CAAA,KAAA,CAAA,IAAA,EAAA,aAAA,CAAA,CAAA,QAAA,CAAA,QAAA,CAAA,EAAA,EAAW,YAAY,CAAA,EAAK,MAAM,CAAA,CAAA,EAAA,MAAA,CAAO,IAAI,CAAE,EAAA,KAAA,CAAA,CAAA,IAAA,IAAA,CAAA;;SAChD;QACH,OAAC,OAAA,CAAA;KANM,CAAc,IAAI,CAMvB,EAAA;AACJ,CAAC;AAEe,SAAA,uBAAuB,CACrC,SAAY,EACZ,YAA0C,EAAA;AAA1C,IAAA,IAAA,YAAA,KAAA,KAAA,CAAA,EAAA,EAAA,YAA0C,GAAA,EAAA,CAAA,EAAA;IAE1C,IAAM,OAAO,GAAG,EAAE,CAAC;AAEnB,IAAA,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC;SACtB,MAAM,CAAC,UAAC,EAAK,EAAA;YAAL,EAAA,GAAA,MAAA,CAAA,EAAA,EAAA,CAAA,CAAK,EAAF,CAAC,GAAA,EAAA,CAAA,CAAA,CAAA,CAAA;QAAM,OAAA,OAAO,CAAC,KAAK,UAAU,CAAA;KAAA,CAAC;SAC1C,OAAO,CAAC,UAAC,EAAM,EAAA;AAAN,QAAA,IAAA,EAAA,GAAA,aAAM,EAAL,CAAC,GAAA,EAAA,CAAA,CAAA,CAAA,EAAE,CAAC,GAAA,EAAA,CAAA,CAAA,CAAA,CAAA;QACb,OAAO,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC;AAC5C,KAAC,CAAC,CAAC;AAEL,IAAA,OAAO,OAAY,CAAC;AACtB;;ACpHA,IAAA,YAAA,kBAAA,YAAA;AAaE,IAAA,SAAA,YAAA,CAAY,EAckB,EAAA;AAdlB,QAAA,IAAA,EAAA,GAAA,EAAA,KAAA,KAAA,CAAA,GAcgB,EAAE,GAAA,EAAA,EAb5B,KAAK,GAAA,EAAA,CAAA,KAAA,EACL,QAAQ,GAAA,EAAA,CAAA,QAAA,EACR,UAAU,GAAA,EAAA,CAAA,UAAA,EACV,IAAI,GAAA,EAAA,CAAA,IAAA,EACJ,YAAY,GAAA,EAAA,CAAA,YAAA,EACZ,WAAW,GAAA,EAAA,CAAA,WAAA,EACX,QAAQ,GAAA,EAAA,CAAA,QAAA,EACR,EAAA,GAAA,EAAA,CAAA,WAAyB,EAAzB,WAAW,GAAG,EAAA,KAAA,KAAA,CAAA,GAAA,WAAW,KAAA,EACzB,EAAA,GAAA,EAAA,CAAA,IAA2B,EAA3B,IAAI,GAAG,EAAA,KAAA,KAAA,CAAA,GAAA,oBAAoB,GAAA,EAAA,EAC3B,EAAc,GAAA,EAAA,CAAA,SAAA,EAAd,SAAS,GAAA,EAAA,KAAA,KAAA,CAAA,GAAG,EAAE,GAAA,EAAA,EACd,EAAA,GAAA,EAAA,CAAA,OAAW,EAAX,OAAO,GAAA,EAAA,KAAA,KAAA,CAAA,GAAG,CAAC,GAAA,EAAA,EACX,EAAA,GAAA,EAAA,CAAA,kBAAyB,EAAzB,kBAAkB,GAAG,EAAA,KAAA,KAAA,CAAA,GAAA,IAAI,GAAA,EAAA,EACzB,EAAuB,GAAA,EAAA,CAAA,cAAA,EAAvB,cAAc,GAAA,EAAA,KAAA,KAAA,CAAA,GAAG,MAAM,GAAA,EAAA,CAAA;AAEvB,QAAA,IAAI,CAAC,WAAW;AAAE,YAAA,MAAM,IAAI,cAAc,CAAC,4BAA4B,CAAC,CAAC;AAEzE,QAAA,IAAI,CAAC,GAAG,GAAG,CAAC,IAAI,EAAE,KAAK,EAAE,GAAA,CAAA,MAAA,CAAI,OAAO,CAAE,EAAE,SAAS,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAE7D,IAAI,CAAC,OAAO,GAAG;AACb,YAAA,YAAY,EAAE,WAAW;SAC1B,CAAC;AACF,QAAA,IAAI,CAAC,kBAAkB,GAAG,kBAAkB,CAAC;AAC7C,QAAA,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;AACzB,QAAA,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;;AAGrC,QAAA,IAAI,UAAU;YAAE,IAAI,CAAC,OAAO,CAAC,aAAa,GAAG,SAAU,CAAA,MAAA,CAAA,UAAU,CAAE,CAAC;AAC/D,aAAA,IAAI,QAAQ;AAAE,YAAA,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,GAAG,QAAQ,CAAC;AACnD,aAAA,IAAI,KAAK;AAAE,YAAA,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,GAAG,KAAK,CAAC;;AAGtD,QAAA,IAAI,YAAY,EAAE;AAChB,YAAA,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,GAAG,YAAY,CAAC;AAC/C,YAAA,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,GAAG,WAAW,CAAC;AAC9C,SAAA;;AAGD,QAAA,IAAI,IAAI;YAAE,IAAI,CAAC,OAAO,CAAC,IAAI,GAAG,EAAG,CAAA,MAAA,CAAA,IAAI,CAAE,CAAC;;AAGxC,QAAA,IAAI,CAAC,SAAS,GAAG,WAAW,CAAM,QAAA,CAAA,EAAA,EAAA,IAAI,EAAG,CAAC;KAC3C;IACH,OAAC,YAAA,CAAA;AAAD,CAAC,EAAA;;;;;;;;"}
|
package/dist/index.mjs
ADDED
|
@@ -0,0 +1,111 @@
|
|
|
1
|
+
import { decamelizeKeys } from 'xcase';
|
|
2
|
+
import { stringify } from 'qs';
|
|
3
|
+
|
|
4
|
+
// src/RequesterUtils.ts
|
|
5
|
+
function formatQuery(params = {}) {
|
|
6
|
+
const decamelized = decamelizeKeys(params);
|
|
7
|
+
return stringify(decamelized, { arrayFormat: "brackets" });
|
|
8
|
+
}
|
|
9
|
+
function isFormData(object) {
|
|
10
|
+
return typeof object === "object" && object.constructor.name === "FormData";
|
|
11
|
+
}
|
|
12
|
+
function defaultOptionsHandler(resourceOptions, { body, searchParams, sudo, asStream = false, method = "get" } = {}) {
|
|
13
|
+
const { headers: preconfiguredHeaders, requestTimeout, url } = resourceOptions;
|
|
14
|
+
const headers = { ...preconfiguredHeaders };
|
|
15
|
+
const defaultOptions = {
|
|
16
|
+
headers,
|
|
17
|
+
timeout: requestTimeout,
|
|
18
|
+
method,
|
|
19
|
+
asStream,
|
|
20
|
+
prefixUrl: url
|
|
21
|
+
};
|
|
22
|
+
if (sudo)
|
|
23
|
+
defaultOptions.headers.sudo = sudo;
|
|
24
|
+
if (body) {
|
|
25
|
+
if (isFormData(body)) {
|
|
26
|
+
defaultOptions.body = body;
|
|
27
|
+
} else {
|
|
28
|
+
defaultOptions.body = JSON.stringify(decamelizeKeys(body));
|
|
29
|
+
headers["content-type"] = "application/json";
|
|
30
|
+
}
|
|
31
|
+
}
|
|
32
|
+
const q = formatQuery(searchParams);
|
|
33
|
+
if (q)
|
|
34
|
+
defaultOptions.searchParams = q;
|
|
35
|
+
return Promise.resolve(defaultOptions);
|
|
36
|
+
}
|
|
37
|
+
function createRequesterFn(optionsHandler, requestHandler) {
|
|
38
|
+
const methods = ["get", "post", "put", "patch", "delete"];
|
|
39
|
+
return (serviceOptions) => {
|
|
40
|
+
const requester = {};
|
|
41
|
+
methods.forEach((m) => {
|
|
42
|
+
requester[m] = async (endpoint, options) => {
|
|
43
|
+
const requestOptions = await optionsHandler(serviceOptions, { ...options, method: m });
|
|
44
|
+
return requestHandler(endpoint, requestOptions);
|
|
45
|
+
};
|
|
46
|
+
});
|
|
47
|
+
return requester;
|
|
48
|
+
};
|
|
49
|
+
}
|
|
50
|
+
function extendClass(Base, customConfig = {}) {
|
|
51
|
+
return class extends Base {
|
|
52
|
+
constructor(...options) {
|
|
53
|
+
const [config, ...opts] = options;
|
|
54
|
+
super({ ...customConfig, ...config }, ...opts);
|
|
55
|
+
}
|
|
56
|
+
};
|
|
57
|
+
}
|
|
58
|
+
function presetResourceArguments(resources, customConfig = {}) {
|
|
59
|
+
const updated = {};
|
|
60
|
+
Object.entries(resources).filter(([, s]) => typeof s === "function").forEach(([k, r]) => {
|
|
61
|
+
updated[k] = extendClass(r, customConfig);
|
|
62
|
+
});
|
|
63
|
+
return updated;
|
|
64
|
+
}
|
|
65
|
+
|
|
66
|
+
// src/BaseResource.ts
|
|
67
|
+
var BaseResource = class {
|
|
68
|
+
url;
|
|
69
|
+
requester;
|
|
70
|
+
requestTimeout;
|
|
71
|
+
headers;
|
|
72
|
+
camelize;
|
|
73
|
+
rejectUnauthorized;
|
|
74
|
+
constructor({
|
|
75
|
+
token,
|
|
76
|
+
jobToken,
|
|
77
|
+
oauthToken,
|
|
78
|
+
sudo,
|
|
79
|
+
profileToken,
|
|
80
|
+
requesterFn,
|
|
81
|
+
camelize,
|
|
82
|
+
profileMode = "execution",
|
|
83
|
+
host = "https://gitlab.com",
|
|
84
|
+
prefixUrl = "",
|
|
85
|
+
rejectUnauthorized = true,
|
|
86
|
+
requestTimeout = 3e5
|
|
87
|
+
} = {}) {
|
|
88
|
+
if (!requesterFn)
|
|
89
|
+
throw new ReferenceError("requesterFn must be passed");
|
|
90
|
+
this.url = [host, "api", "v4", prefixUrl].join("/");
|
|
91
|
+
this.headers = {};
|
|
92
|
+
this.rejectUnauthorized = rejectUnauthorized;
|
|
93
|
+
this.camelize = camelize;
|
|
94
|
+
this.requestTimeout = requestTimeout;
|
|
95
|
+
if (oauthToken)
|
|
96
|
+
this.headers.authorization = `Bearer ${oauthToken}`;
|
|
97
|
+
else if (jobToken)
|
|
98
|
+
this.headers["job-token"] = jobToken;
|
|
99
|
+
else if (token)
|
|
100
|
+
this.headers["private-token"] = token;
|
|
101
|
+
if (profileToken) {
|
|
102
|
+
this.headers["X-Profile-Token"] = profileToken;
|
|
103
|
+
this.headers["X-Profile-Mode"] = profileMode;
|
|
104
|
+
}
|
|
105
|
+
if (sudo)
|
|
106
|
+
this.headers.Sudo = `${sudo}`;
|
|
107
|
+
this.requester = requesterFn({ ...this });
|
|
108
|
+
}
|
|
109
|
+
};
|
|
110
|
+
|
|
111
|
+
export { BaseResource, createRequesterFn, defaultOptionsHandler, formatQuery, presetResourceArguments };
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@gitbeaker/requester-utils",
|
|
3
3
|
"description": "Utility functions for requester implementatons used in @gitbeaker",
|
|
4
|
-
"version": "35.
|
|
4
|
+
"version": "35.8.1",
|
|
5
5
|
"author": {
|
|
6
6
|
"name": "Justin Dalrymple"
|
|
7
7
|
},
|
|
@@ -14,9 +14,9 @@
|
|
|
14
14
|
"xcase": "^2.0.1"
|
|
15
15
|
},
|
|
16
16
|
"devDependencies": {
|
|
17
|
-
"@types/node": "^
|
|
17
|
+
"@types/node": "^18.0.3",
|
|
18
18
|
"@types/qs": "^6.9.7",
|
|
19
|
-
"jest-extended": "^
|
|
19
|
+
"jest-extended": "^3.0.0",
|
|
20
20
|
"rollup": "^2.47.0",
|
|
21
21
|
"rollup-plugin-typescript2": "^0.31.1",
|
|
22
22
|
"tslib": "^2.3.1",
|
|
@@ -46,6 +46,5 @@
|
|
|
46
46
|
"build": "rollup -c",
|
|
47
47
|
"test:integration": "node --expose-gc ../../node_modules/.bin/jest --runInBand --logHeapUsage test/integration",
|
|
48
48
|
"test:unit": "node --expose-gc ../../node_modules/.bin/jest --runInBand --logHeapUsage test/unit"
|
|
49
|
-
}
|
|
50
|
-
"gitHead": "5037aabd6dc33187eb001efba84fee3dda4b0c4d"
|
|
49
|
+
}
|
|
51
50
|
}
|
package/LICENSE.md
DELETED
|
@@ -1,22 +0,0 @@
|
|
|
1
|
-
# The MIT License
|
|
2
|
-
|
|
3
|
-
Copyright (c)
|
|
4
|
-
**2020 Justin Dalrymple**
|
|
5
|
-
|
|
6
|
-
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
7
|
-
of this software and associated documentation files (the "Software"), to deal
|
|
8
|
-
in the Software without restriction, including without limitation the rights
|
|
9
|
-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
10
|
-
copies of the Software, and to permit persons to whom the Software is
|
|
11
|
-
furnished to do so, subject to the following conditions:
|
|
12
|
-
|
|
13
|
-
The above copyright notice and this permission notice shall be included in
|
|
14
|
-
all copies or substantial portions of the Software.
|
|
15
|
-
|
|
16
|
-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
17
|
-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
18
|
-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
19
|
-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
20
|
-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
21
|
-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
22
|
-
THE SOFTWARE.
|