@gitbeaker/requester-utils 34.4.0 → 34.4.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.es.js +177 -0
- package/dist/index.es.js.map +1 -0
- package/dist/index.js +185 -0
- package/dist/index.js.map +1 -0
- package/dist/types/BaseResource.d.ts +27 -0
- package/dist/types/RequesterUtils.d.ts +44 -0
- package/dist/types/index.d.ts +2 -0
- package/package.json +2 -2
package/dist/index.es.js
ADDED
|
@@ -0,0 +1,177 @@
|
|
|
1
|
+
import { decamelizeKeys } from 'xcase';
|
|
2
|
+
import { stringify } from 'qs';
|
|
3
|
+
|
|
4
|
+
/*! *****************************************************************************
|
|
5
|
+
Copyright (c) Microsoft Corporation.
|
|
6
|
+
|
|
7
|
+
Permission to use, copy, modify, and/or distribute this software for any
|
|
8
|
+
purpose with or without fee is hereby granted.
|
|
9
|
+
|
|
10
|
+
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
|
|
11
|
+
REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
|
|
12
|
+
AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
|
|
13
|
+
INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
|
|
14
|
+
LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
|
|
15
|
+
OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
|
|
16
|
+
PERFORMANCE OF THIS SOFTWARE.
|
|
17
|
+
***************************************************************************** */
|
|
18
|
+
/* global Reflect, Promise */
|
|
19
|
+
|
|
20
|
+
var extendStatics = function(d, b) {
|
|
21
|
+
extendStatics = Object.setPrototypeOf ||
|
|
22
|
+
({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
|
|
23
|
+
function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
|
|
24
|
+
return extendStatics(d, b);
|
|
25
|
+
};
|
|
26
|
+
|
|
27
|
+
function __extends(d, b) {
|
|
28
|
+
if (typeof b !== "function" && b !== null)
|
|
29
|
+
throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
|
|
30
|
+
extendStatics(d, b);
|
|
31
|
+
function __() { this.constructor = d; }
|
|
32
|
+
d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
var __assign = function() {
|
|
36
|
+
__assign = Object.assign || function __assign(t) {
|
|
37
|
+
for (var s, i = 1, n = arguments.length; i < n; i++) {
|
|
38
|
+
s = arguments[i];
|
|
39
|
+
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p)) t[p] = s[p];
|
|
40
|
+
}
|
|
41
|
+
return t;
|
|
42
|
+
};
|
|
43
|
+
return __assign.apply(this, arguments);
|
|
44
|
+
};
|
|
45
|
+
|
|
46
|
+
function __read(o, n) {
|
|
47
|
+
var m = typeof Symbol === "function" && o[Symbol.iterator];
|
|
48
|
+
if (!m) return o;
|
|
49
|
+
var i = m.call(o), r, ar = [], e;
|
|
50
|
+
try {
|
|
51
|
+
while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
|
|
52
|
+
}
|
|
53
|
+
catch (error) { e = { error: error }; }
|
|
54
|
+
finally {
|
|
55
|
+
try {
|
|
56
|
+
if (r && !r.done && (m = i["return"])) m.call(i);
|
|
57
|
+
}
|
|
58
|
+
finally { if (e) throw e.error; }
|
|
59
|
+
}
|
|
60
|
+
return ar;
|
|
61
|
+
}
|
|
62
|
+
|
|
63
|
+
function __spreadArray(to, from) {
|
|
64
|
+
for (var i = 0, il = from.length, j = to.length; i < il; i++, j++)
|
|
65
|
+
to[j] = from[i];
|
|
66
|
+
return to;
|
|
67
|
+
}
|
|
68
|
+
|
|
69
|
+
// Utility methods
|
|
70
|
+
function formatQuery(params) {
|
|
71
|
+
if (params === void 0) { params = {}; }
|
|
72
|
+
var decamelized = decamelizeKeys(params);
|
|
73
|
+
return stringify(decamelized, { arrayFormat: 'brackets' });
|
|
74
|
+
}
|
|
75
|
+
function defaultOptionsHandler(resourceOptions, _a) {
|
|
76
|
+
var _b = _a === void 0 ? {} : _a, body = _b.body, query = _b.query, sudo = _b.sudo, _c = _b.method, method = _c === void 0 ? 'get' : _c;
|
|
77
|
+
var preconfiguredHeaders = resourceOptions.headers, requestTimeout = resourceOptions.requestTimeout, url = resourceOptions.url;
|
|
78
|
+
var headers = __assign({}, preconfiguredHeaders);
|
|
79
|
+
var bod;
|
|
80
|
+
if (sudo)
|
|
81
|
+
headers.sudo = sudo;
|
|
82
|
+
// FIXME: Not the best comparison, but...it will have to do for now.
|
|
83
|
+
if (typeof body === 'object' && body.constructor.name !== 'FormData') {
|
|
84
|
+
bod = JSON.stringify(decamelizeKeys(body));
|
|
85
|
+
headers['content-type'] = 'application/json';
|
|
86
|
+
}
|
|
87
|
+
else {
|
|
88
|
+
bod = body;
|
|
89
|
+
}
|
|
90
|
+
return {
|
|
91
|
+
headers: headers,
|
|
92
|
+
timeout: requestTimeout,
|
|
93
|
+
method: method,
|
|
94
|
+
searchParams: formatQuery(query),
|
|
95
|
+
prefixUrl: url,
|
|
96
|
+
body: bod,
|
|
97
|
+
};
|
|
98
|
+
}
|
|
99
|
+
function createRequesterFn(optionsHandler, requestHandler) {
|
|
100
|
+
var methods = ['get', 'post', 'put', 'delete', 'stream'];
|
|
101
|
+
return function (serviceOptions) {
|
|
102
|
+
var requester = {};
|
|
103
|
+
methods.forEach(function (m) {
|
|
104
|
+
requester[m] = function (endpoint, options) {
|
|
105
|
+
var requestOptions = optionsHandler(serviceOptions, __assign(__assign({}, options), { method: m }));
|
|
106
|
+
return requestHandler(endpoint, requestOptions);
|
|
107
|
+
};
|
|
108
|
+
});
|
|
109
|
+
return requester;
|
|
110
|
+
};
|
|
111
|
+
}
|
|
112
|
+
function extendClass(Base, customConfig) {
|
|
113
|
+
return /** @class */ (function (_super) {
|
|
114
|
+
__extends(class_1, _super);
|
|
115
|
+
function class_1() {
|
|
116
|
+
var options = [];
|
|
117
|
+
for (var _i = 0; _i < arguments.length; _i++) {
|
|
118
|
+
options[_i] = arguments[_i];
|
|
119
|
+
}
|
|
120
|
+
var _this = this;
|
|
121
|
+
var _a = __read(options), config = _a[0], opts = _a.slice(1);
|
|
122
|
+
_this = _super.apply(this, __spreadArray([__assign(__assign({}, customConfig), config)], __read(opts))) || this;
|
|
123
|
+
return _this;
|
|
124
|
+
}
|
|
125
|
+
return class_1;
|
|
126
|
+
}(Base));
|
|
127
|
+
}
|
|
128
|
+
function presetResourceArguments(resources, customConfig) {
|
|
129
|
+
if (customConfig === void 0) { customConfig = {}; }
|
|
130
|
+
var updated = {};
|
|
131
|
+
Object.entries(resources)
|
|
132
|
+
.filter(function (_a) {
|
|
133
|
+
var _b = __read(_a, 2), s = _b[1];
|
|
134
|
+
return typeof s === 'function';
|
|
135
|
+
}) // FIXME: Odd default artifact included in this list during testing
|
|
136
|
+
.forEach(function (_a) {
|
|
137
|
+
var _b = __read(_a, 2), k = _b[0], r = _b[1];
|
|
138
|
+
updated[k] = extendClass(r, customConfig);
|
|
139
|
+
});
|
|
140
|
+
return updated;
|
|
141
|
+
}
|
|
142
|
+
|
|
143
|
+
var BaseResource = /** @class */ (function () {
|
|
144
|
+
function BaseResource(_a) {
|
|
145
|
+
var _b = _a === void 0 ? {} : _a, token = _b.token, jobToken = _b.jobToken, oauthToken = _b.oauthToken, sudo = _b.sudo, profileToken = _b.profileToken, requesterFn = _b.requesterFn, camelize = _b.camelize, _c = _b.profileMode, profileMode = _c === void 0 ? 'execution' : _c, _d = _b.host, host = _d === void 0 ? 'https://gitlab.com' : _d, _e = _b.prefixUrl, prefixUrl = _e === void 0 ? '' : _e, _f = _b.version, version = _f === void 0 ? 4 : _f, _g = _b.rejectUnauthorized, rejectUnauthorized = _g === void 0 ? true : _g, _h = _b.requestTimeout, requestTimeout = _h === void 0 ? 300000 : _h;
|
|
146
|
+
if (!requesterFn)
|
|
147
|
+
throw new ReferenceError('requesterFn must be passed');
|
|
148
|
+
this.url = [host, 'api', "v" + version, prefixUrl].join('/');
|
|
149
|
+
this.headers = {
|
|
150
|
+
'user-agent': 'gitbeaker',
|
|
151
|
+
};
|
|
152
|
+
this.rejectUnauthorized = rejectUnauthorized;
|
|
153
|
+
this.camelize = camelize;
|
|
154
|
+
this.requestTimeout = requestTimeout;
|
|
155
|
+
// Handle auth tokens
|
|
156
|
+
if (oauthToken)
|
|
157
|
+
this.headers.authorization = "Bearer " + oauthToken;
|
|
158
|
+
else if (jobToken)
|
|
159
|
+
this.headers['job-token'] = jobToken;
|
|
160
|
+
else if (token)
|
|
161
|
+
this.headers['private-token'] = token;
|
|
162
|
+
// Profiling
|
|
163
|
+
if (profileToken) {
|
|
164
|
+
this.headers['X-Profile-Token'] = profileToken;
|
|
165
|
+
this.headers['X-Profile-Mode'] = profileMode;
|
|
166
|
+
}
|
|
167
|
+
// Set sudo
|
|
168
|
+
if (sudo)
|
|
169
|
+
this.headers.Sudo = "" + sudo;
|
|
170
|
+
// Set requester instance using this information
|
|
171
|
+
this.requester = requesterFn(__assign({}, this));
|
|
172
|
+
}
|
|
173
|
+
return BaseResource;
|
|
174
|
+
}());
|
|
175
|
+
|
|
176
|
+
export { BaseResource, createRequesterFn, defaultOptionsHandler, formatQuery, presetResourceArguments };
|
|
177
|
+
//# sourceMappingURL=index.es.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.es.js","sources":["../src/RequesterUtils.ts","../src/BaseResource.ts"],"sourcesContent":["import { decamelizeKeys } from 'xcase';\nimport FormData 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,YAAE;;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,MAAI,OAAS,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,YAAU,UAAY,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,KAAG,IAAM,CAAC;;QAGxC,IAAI,CAAC,SAAS,GAAG,WAAW,cAAM,IAAI,EAAG,CAAC;KAC3C;IACH,mBAAC;AAAD,CAAC;;;;"}
|
package/dist/index.js
ADDED
|
@@ -0,0 +1,185 @@
|
|
|
1
|
+
'use strict';
|
|
2
|
+
|
|
3
|
+
Object.defineProperty(exports, '__esModule', { value: true });
|
|
4
|
+
|
|
5
|
+
var xcase = require('xcase');
|
|
6
|
+
var qs = require('qs');
|
|
7
|
+
|
|
8
|
+
/*! *****************************************************************************
|
|
9
|
+
Copyright (c) Microsoft Corporation.
|
|
10
|
+
|
|
11
|
+
Permission to use, copy, modify, and/or distribute this software for any
|
|
12
|
+
purpose with or without fee is hereby granted.
|
|
13
|
+
|
|
14
|
+
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
|
|
15
|
+
REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
|
|
16
|
+
AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
|
|
17
|
+
INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
|
|
18
|
+
LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
|
|
19
|
+
OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
|
|
20
|
+
PERFORMANCE OF THIS SOFTWARE.
|
|
21
|
+
***************************************************************************** */
|
|
22
|
+
/* global Reflect, Promise */
|
|
23
|
+
|
|
24
|
+
var extendStatics = function(d, b) {
|
|
25
|
+
extendStatics = Object.setPrototypeOf ||
|
|
26
|
+
({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
|
|
27
|
+
function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
|
|
28
|
+
return extendStatics(d, b);
|
|
29
|
+
};
|
|
30
|
+
|
|
31
|
+
function __extends(d, b) {
|
|
32
|
+
if (typeof b !== "function" && b !== null)
|
|
33
|
+
throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
|
|
34
|
+
extendStatics(d, b);
|
|
35
|
+
function __() { this.constructor = d; }
|
|
36
|
+
d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
var __assign = function() {
|
|
40
|
+
__assign = Object.assign || function __assign(t) {
|
|
41
|
+
for (var s, i = 1, n = arguments.length; i < n; i++) {
|
|
42
|
+
s = arguments[i];
|
|
43
|
+
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p)) t[p] = s[p];
|
|
44
|
+
}
|
|
45
|
+
return t;
|
|
46
|
+
};
|
|
47
|
+
return __assign.apply(this, arguments);
|
|
48
|
+
};
|
|
49
|
+
|
|
50
|
+
function __read(o, n) {
|
|
51
|
+
var m = typeof Symbol === "function" && o[Symbol.iterator];
|
|
52
|
+
if (!m) return o;
|
|
53
|
+
var i = m.call(o), r, ar = [], e;
|
|
54
|
+
try {
|
|
55
|
+
while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
|
|
56
|
+
}
|
|
57
|
+
catch (error) { e = { error: error }; }
|
|
58
|
+
finally {
|
|
59
|
+
try {
|
|
60
|
+
if (r && !r.done && (m = i["return"])) m.call(i);
|
|
61
|
+
}
|
|
62
|
+
finally { if (e) throw e.error; }
|
|
63
|
+
}
|
|
64
|
+
return ar;
|
|
65
|
+
}
|
|
66
|
+
|
|
67
|
+
function __spreadArray(to, from) {
|
|
68
|
+
for (var i = 0, il = from.length, j = to.length; i < il; i++, j++)
|
|
69
|
+
to[j] = from[i];
|
|
70
|
+
return to;
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
// Utility methods
|
|
74
|
+
function formatQuery(params) {
|
|
75
|
+
if (params === void 0) { params = {}; }
|
|
76
|
+
var decamelized = xcase.decamelizeKeys(params);
|
|
77
|
+
return qs.stringify(decamelized, { arrayFormat: 'brackets' });
|
|
78
|
+
}
|
|
79
|
+
function defaultOptionsHandler(resourceOptions, _a) {
|
|
80
|
+
var _b = _a === void 0 ? {} : _a, body = _b.body, query = _b.query, sudo = _b.sudo, _c = _b.method, method = _c === void 0 ? 'get' : _c;
|
|
81
|
+
var preconfiguredHeaders = resourceOptions.headers, requestTimeout = resourceOptions.requestTimeout, url = resourceOptions.url;
|
|
82
|
+
var headers = __assign({}, preconfiguredHeaders);
|
|
83
|
+
var bod;
|
|
84
|
+
if (sudo)
|
|
85
|
+
headers.sudo = sudo;
|
|
86
|
+
// FIXME: Not the best comparison, but...it will have to do for now.
|
|
87
|
+
if (typeof body === 'object' && body.constructor.name !== 'FormData') {
|
|
88
|
+
bod = JSON.stringify(xcase.decamelizeKeys(body));
|
|
89
|
+
headers['content-type'] = 'application/json';
|
|
90
|
+
}
|
|
91
|
+
else {
|
|
92
|
+
bod = body;
|
|
93
|
+
}
|
|
94
|
+
return {
|
|
95
|
+
headers: headers,
|
|
96
|
+
timeout: requestTimeout,
|
|
97
|
+
method: method,
|
|
98
|
+
searchParams: formatQuery(query),
|
|
99
|
+
prefixUrl: url,
|
|
100
|
+
body: bod,
|
|
101
|
+
};
|
|
102
|
+
}
|
|
103
|
+
function createRequesterFn(optionsHandler, requestHandler) {
|
|
104
|
+
var methods = ['get', 'post', 'put', 'delete', 'stream'];
|
|
105
|
+
return function (serviceOptions) {
|
|
106
|
+
var requester = {};
|
|
107
|
+
methods.forEach(function (m) {
|
|
108
|
+
requester[m] = function (endpoint, options) {
|
|
109
|
+
var requestOptions = optionsHandler(serviceOptions, __assign(__assign({}, options), { method: m }));
|
|
110
|
+
return requestHandler(endpoint, requestOptions);
|
|
111
|
+
};
|
|
112
|
+
});
|
|
113
|
+
return requester;
|
|
114
|
+
};
|
|
115
|
+
}
|
|
116
|
+
function extendClass(Base, customConfig) {
|
|
117
|
+
return /** @class */ (function (_super) {
|
|
118
|
+
__extends(class_1, _super);
|
|
119
|
+
function class_1() {
|
|
120
|
+
var options = [];
|
|
121
|
+
for (var _i = 0; _i < arguments.length; _i++) {
|
|
122
|
+
options[_i] = arguments[_i];
|
|
123
|
+
}
|
|
124
|
+
var _this = this;
|
|
125
|
+
var _a = __read(options), config = _a[0], opts = _a.slice(1);
|
|
126
|
+
_this = _super.apply(this, __spreadArray([__assign(__assign({}, customConfig), config)], __read(opts))) || this;
|
|
127
|
+
return _this;
|
|
128
|
+
}
|
|
129
|
+
return class_1;
|
|
130
|
+
}(Base));
|
|
131
|
+
}
|
|
132
|
+
function presetResourceArguments(resources, customConfig) {
|
|
133
|
+
if (customConfig === void 0) { customConfig = {}; }
|
|
134
|
+
var updated = {};
|
|
135
|
+
Object.entries(resources)
|
|
136
|
+
.filter(function (_a) {
|
|
137
|
+
var _b = __read(_a, 2), s = _b[1];
|
|
138
|
+
return typeof s === 'function';
|
|
139
|
+
}) // FIXME: Odd default artifact included in this list during testing
|
|
140
|
+
.forEach(function (_a) {
|
|
141
|
+
var _b = __read(_a, 2), k = _b[0], r = _b[1];
|
|
142
|
+
updated[k] = extendClass(r, customConfig);
|
|
143
|
+
});
|
|
144
|
+
return updated;
|
|
145
|
+
}
|
|
146
|
+
|
|
147
|
+
var BaseResource = /** @class */ (function () {
|
|
148
|
+
function BaseResource(_a) {
|
|
149
|
+
var _b = _a === void 0 ? {} : _a, token = _b.token, jobToken = _b.jobToken, oauthToken = _b.oauthToken, sudo = _b.sudo, profileToken = _b.profileToken, requesterFn = _b.requesterFn, camelize = _b.camelize, _c = _b.profileMode, profileMode = _c === void 0 ? 'execution' : _c, _d = _b.host, host = _d === void 0 ? 'https://gitlab.com' : _d, _e = _b.prefixUrl, prefixUrl = _e === void 0 ? '' : _e, _f = _b.version, version = _f === void 0 ? 4 : _f, _g = _b.rejectUnauthorized, rejectUnauthorized = _g === void 0 ? true : _g, _h = _b.requestTimeout, requestTimeout = _h === void 0 ? 300000 : _h;
|
|
150
|
+
if (!requesterFn)
|
|
151
|
+
throw new ReferenceError('requesterFn must be passed');
|
|
152
|
+
this.url = [host, 'api', "v" + version, prefixUrl].join('/');
|
|
153
|
+
this.headers = {
|
|
154
|
+
'user-agent': 'gitbeaker',
|
|
155
|
+
};
|
|
156
|
+
this.rejectUnauthorized = rejectUnauthorized;
|
|
157
|
+
this.camelize = camelize;
|
|
158
|
+
this.requestTimeout = requestTimeout;
|
|
159
|
+
// Handle auth tokens
|
|
160
|
+
if (oauthToken)
|
|
161
|
+
this.headers.authorization = "Bearer " + oauthToken;
|
|
162
|
+
else if (jobToken)
|
|
163
|
+
this.headers['job-token'] = jobToken;
|
|
164
|
+
else if (token)
|
|
165
|
+
this.headers['private-token'] = token;
|
|
166
|
+
// Profiling
|
|
167
|
+
if (profileToken) {
|
|
168
|
+
this.headers['X-Profile-Token'] = profileToken;
|
|
169
|
+
this.headers['X-Profile-Mode'] = profileMode;
|
|
170
|
+
}
|
|
171
|
+
// Set sudo
|
|
172
|
+
if (sudo)
|
|
173
|
+
this.headers.Sudo = "" + sudo;
|
|
174
|
+
// Set requester instance using this information
|
|
175
|
+
this.requester = requesterFn(__assign({}, this));
|
|
176
|
+
}
|
|
177
|
+
return BaseResource;
|
|
178
|
+
}());
|
|
179
|
+
|
|
180
|
+
exports.BaseResource = BaseResource;
|
|
181
|
+
exports.createRequesterFn = createRequesterFn;
|
|
182
|
+
exports.defaultOptionsHandler = defaultOptionsHandler;
|
|
183
|
+
exports.formatQuery = formatQuery;
|
|
184
|
+
exports.presetResourceArguments = presetResourceArguments;
|
|
185
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sources":["../src/RequesterUtils.ts","../src/BaseResource.ts"],"sourcesContent":["import { decamelizeKeys } from 'xcase';\nimport FormData 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,YAAE;;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,MAAI,OAAS,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,YAAU,UAAY,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,KAAG,IAAM,CAAC;;QAGxC,IAAI,CAAC,SAAS,GAAG,WAAW,cAAM,IAAI,EAAG,CAAC;KAC3C;IACH,mBAAC;AAAD,CAAC;;;;;;;;"}
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
import { RequesterType, DefaultResourceOptions } from './RequesterUtils';
|
|
2
|
+
export interface BaseResourceOptions<C> {
|
|
3
|
+
oauthToken?: string;
|
|
4
|
+
token?: string;
|
|
5
|
+
jobToken?: string;
|
|
6
|
+
host?: string;
|
|
7
|
+
prefixUrl?: string;
|
|
8
|
+
version?: 3 | 4;
|
|
9
|
+
rejectUnauthorized?: boolean;
|
|
10
|
+
camelize?: C;
|
|
11
|
+
requesterFn?: (resourceOptions: DefaultResourceOptions) => RequesterType;
|
|
12
|
+
requestTimeout?: number;
|
|
13
|
+
profileToken?: string;
|
|
14
|
+
sudo?: string | number;
|
|
15
|
+
profileMode?: 'execution' | 'memory';
|
|
16
|
+
}
|
|
17
|
+
export declare class BaseResource<C extends boolean = false> {
|
|
18
|
+
readonly url: string;
|
|
19
|
+
readonly requester: RequesterType;
|
|
20
|
+
readonly requestTimeout: number;
|
|
21
|
+
readonly headers: {
|
|
22
|
+
[header: string]: string;
|
|
23
|
+
};
|
|
24
|
+
readonly camelize: C | undefined;
|
|
25
|
+
readonly rejectUnauthorized: boolean;
|
|
26
|
+
constructor({ token, jobToken, oauthToken, sudo, profileToken, requesterFn, camelize, profileMode, host, prefixUrl, version, rejectUnauthorized, requestTimeout, }?: BaseResourceOptions<C>);
|
|
27
|
+
}
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
/// <reference types="node" />
|
|
2
|
+
import FormData from 'form-data';
|
|
3
|
+
export interface Constructable<T = any> {
|
|
4
|
+
new (...args: any[]): T;
|
|
5
|
+
}
|
|
6
|
+
export interface RequesterType {
|
|
7
|
+
get(endpoint: string, options?: Record<string, unknown>): Promise<any>;
|
|
8
|
+
post(endpoint: string, options?: Record<string, unknown>): Promise<any>;
|
|
9
|
+
put(endpoint: string, options?: Record<string, unknown>): Promise<any>;
|
|
10
|
+
delete(endpoint: string, options?: Record<string, unknown>): Promise<any>;
|
|
11
|
+
stream?(endpoint: string, options?: Record<string, unknown>): NodeJS.ReadableStream;
|
|
12
|
+
}
|
|
13
|
+
export declare type DefaultResourceOptions = {
|
|
14
|
+
headers: {
|
|
15
|
+
[header: string]: string;
|
|
16
|
+
};
|
|
17
|
+
requestTimeout: number;
|
|
18
|
+
url: string;
|
|
19
|
+
rejectUnauthorized: boolean;
|
|
20
|
+
};
|
|
21
|
+
export declare type DefaultRequestOptions = {
|
|
22
|
+
body?: FormData | Record<string, unknown>;
|
|
23
|
+
query?: Record<string, unknown>;
|
|
24
|
+
sudo?: string;
|
|
25
|
+
method?: string;
|
|
26
|
+
};
|
|
27
|
+
export declare type DefaultRequestReturn = {
|
|
28
|
+
headers: Record<string, string> | Headers;
|
|
29
|
+
timeout?: number;
|
|
30
|
+
method: string;
|
|
31
|
+
searchParams?: string;
|
|
32
|
+
prefixUrl?: string;
|
|
33
|
+
body?: string | FormData;
|
|
34
|
+
};
|
|
35
|
+
export declare function formatQuery(params?: Record<string, unknown>): string;
|
|
36
|
+
export declare type OptionsHandlerFn = (serviceOptions: DefaultResourceOptions, requestOptions: DefaultRequestOptions) => DefaultRequestReturn;
|
|
37
|
+
export declare function defaultOptionsHandler(resourceOptions: DefaultResourceOptions, { body, query, sudo, method }?: DefaultRequestOptions): DefaultRequestReturn;
|
|
38
|
+
export declare type RequestHandlerFn = (endpoint: string, options?: Record<string, unknown>) => any | Promise<{
|
|
39
|
+
body: Record<string, unknown> | Record<string, unknown>[];
|
|
40
|
+
headers: Record<string, unknown> | Headers;
|
|
41
|
+
status: number;
|
|
42
|
+
}>;
|
|
43
|
+
export declare function createRequesterFn(optionsHandler: OptionsHandlerFn, requestHandler: RequestHandlerFn): (serviceOptions: DefaultResourceOptions) => RequesterType;
|
|
44
|
+
export declare function presetResourceArguments<T>(resources: T, customConfig?: Record<string, unknown>): T;
|
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": "34.4.
|
|
4
|
+
"version": "34.4.1",
|
|
5
5
|
"author": {
|
|
6
6
|
"name": "Justin Dalrymple"
|
|
7
7
|
},
|
|
@@ -47,5 +47,5 @@
|
|
|
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
49
|
},
|
|
50
|
-
"gitHead": "
|
|
50
|
+
"gitHead": "a0ae1f9525efd06d7a6462740eb5cac01d12af8e"
|
|
51
51
|
}
|