@resolution/confluence-api-client 0.7.12 → 0.11.0

package/lib/openapi/core/CommonHttpClient.js

@@ -25,7 +25,7 @@ exports.CommonHttpClient = exports.createClientWithServices = exports.discardRes
 class CommonHttpClientError extends Error {
     constructor(url, request, response, options, message) {
         super(message);
-        this.name = "OpenApiClientError";
+        this.name = 'OpenApiClientError';
         this.url = url;
         this.request = request;
         this.response = response;
@@ -58,59 +58,59 @@ function convertResponseBody(body, destType) {
         if (body.type === destType) {
             return body;
         }
-        if (body.type === "json") {
+        if (body.type === 'json') {
             const blob = new Blob([JSON.stringify(body.data)]);
-            if (destType === "blob") {
+            if (destType === 'blob') {
                 return {
-                    type: "blob",
-                    data: blob,
+                    type: 'blob',
+                    data: blob
                 };
             }
-            else if (destType === "readableStream") {
+            else if (destType === 'readableStream') {
                 return {
-                    type: "readableStream",
-                    data: blob.stream(),
+                    type: 'readableStream',
+                    data: blob.stream()
                 };
             }
             else {
-                throw new Error("Invalid destination type.");
+                throw new Error('Invalid destination type.');
             }
         }
-        if (body.type === "blob") {
-            if (destType === "json") {
+        if (body.type === 'blob') {
+            if (destType === 'json') {
                 return {
-                    type: "json",
-                    data: JSON.parse(yield body.data.text()),
+                    type: 'json',
+                    data: JSON.parse(yield body.data.text())
                 };
             }
-            else if (destType === "readableStream") {
+            else if (destType === 'readableStream') {
                 return {
-                    type: "readableStream",
-                    data: body.data.stream(),
+                    type: 'readableStream',
+                    data: body.data.stream()
                 };
             }
             else {
-                throw new Error("Invalid destination type.");
+                throw new Error('Invalid destination type.');
             }
         }
-        if (body.type === "readableStream") {
-            if (destType === "json") {
+        if (body.type === 'readableStream') {
+            if (destType === 'json') {
                 return {
-                    type: "json",
-                    data: JSON.parse(yield (yield readableStreamToBlob(body.data)).text()),
+                    type: 'json',
+                    data: JSON.parse(yield (yield readableStreamToBlob(body.data)).text())
                 };
             }
-            else if (destType === "blob") {
+            else if (destType === 'blob') {
                 return {
-                    type: "blob",
-                    data: yield readableStreamToBlob(body.data),
+                    type: 'blob',
+                    data: yield readableStreamToBlob(body.data)
                 };
             }
             else {
-                throw new Error("Invalid destination type.");
+                throw new Error('Invalid destination type.');
             }
         }
-        throw new Error("Invalid response body type.");
+        throw new Error('Invalid response body type.');
     });
 }
 function checkReponseMediaType(response, mediaType) {
@@ -129,13 +129,13 @@ function asCreatedResponse(...keys) {
         if (response.status === 201) {
             return {
                 created: true,
-                [keyCreated]: response.body,
+                [keyCreated]: response.body
             };
         }
         else {
             return {
                 created: false,
-                [keyOther]: response.body,
+                [keyOther]: response.body
             };
         }
     };
@@ -152,9 +152,7 @@ function createClientWithServices(services, options) {
     const extension = {};
     for (const serviceName in services) {
         if (Object.prototype.hasOwnProperty.call(services, serviceName)) {
-            extension[serviceName
-                .replace(/[^\b]Service$/, "")
-                .replace(/^\w/, (s) => s.toLowerCase())] = new services[serviceName](client.getClient());
+            extension[serviceName.replace(/[^\b]Service$/, '').replace(/^\w/, s => s.toLowerCase())] = new services[serviceName](client.getClient());
         }
     }
     return Object.assign(client, extension);
@@ -164,277 +162,212 @@ function getErrorMessage(e) {
     return e instanceof Error ? e.message : String(e);
 }
 function parameterHasValue(value) {
-    return (value !== null &&
-        value !== undefined &&
-        (!Array.isArray(value) || value.length > 0) &&
-        (typeof value !== "object" || Object.keys(value).length > 0));
+    return value !== null && value !== undefined && (!Array.isArray(value) || value.length > 0) && (typeof value !== 'object' || Object.keys(value).length > 0);
 }
-function parameterFormattedParameterToString({ pairs, pairSeparator = "", keyValueSeparator = "", }) {
-    return pairs
-        .map(({ key, value }) => key !== undefined ? `${key}${keyValueSeparator}${value}` : value)
-        .join(pairSeparator);
+function parameterFormattedParameterToString({ pairs, pairSeparator = '', keyValueSeparator = '' }) {
+    return pairs.map(({ key, value }) => key !== undefined ? `${key}${keyValueSeparator}${value}` : value).join(pairSeparator);
 }
 const formatParameter = {
     simple(_key, value, explode) {
         if (!parameterHasValue(value)) {
             return {
-                pairs: [],
+                pairs: []
             };
         }
         if (Array.isArray(value)) {
             return {
-                pairs: [
-                    {
-                        value: value.join(","),
-                    },
-                ],
+                pairs: [{
+                        value: value.join(',')
+                    }]
             };
         }
-        if (typeof value === "object" && value !== null) {
+        if (typeof value === 'object' && value !== null) {
             return {
-                pairs: [
-                    {
-                        value: Object.entries(value)
-                            .map(([key, val]) => `${key}${explode ? "=" : ","}${val}`)
-                            .join(","),
-                    },
-                ],
+                pairs: [{
+                        value: Object.entries(value).map(([key, val]) => `${key}${explode ? '=' : ','}${val}`).join(',')
+                    }]
             };
         }
         return {
-            pairs: [
-                {
-                    value: String(value),
-                },
-            ],
+            pairs: [{
+                    value: String(value)
+                }]
         };
     },
     label(_key, value, explode) {
         if (!parameterHasValue(value)) {
             return {
-                pairs: [
-                    {
-                        value: ".",
-                    },
-                ],
+                pairs: [{
+                        value: '.'
+                    }]
             };
         }
         if (Array.isArray(value)) {
             return {
-                pairs: [
-                    {
-                        value: "." + value.join("."),
-                    },
-                ],
+                pairs: [{
+                        value: '.' + value.join('.')
+                    }]
             };
         }
-        if (typeof value === "object" && value !== null) {
+        if (typeof value === 'object' && value !== null) {
             return {
-                pairs: [
-                    {
-                        value: Object.entries(value)
-                            .map(([key, val]) => `.${key}${explode ? "=" : "."}${val}`)
-                            .join(""),
-                    },
-                ],
+                pairs: [{
+                        value: Object.entries(value).map(([key, val]) => `.${key}${explode ? '=' : '.'}${val}`).join('')
+                    }]
             };
         }
         return {
-            pairs: [
-                {
-                    value: "." + String(value),
-                },
-            ],
+            pairs: [{
+                    value: '.' + String(value)
+                }]
         };
     },
     matrix(key, value, explode) {
         if (!parameterHasValue(value)) {
             return {
-                pairs: [
-                    {
-                        value: `;${key}`,
-                    },
-                ],
+                pairs: [{
+                        value: `;${key}`
+                    }]
             };
         }
         if (Array.isArray(value)) {
             return {
-                pairs: [
-                    {
-                        value: explode
-                            ? value.map((val) => `;${key}=${val}`).join("")
-                            : `;${key}=${value.join(",")}`,
-                    },
-                ],
+                pairs: [{
+                        value: explode ? value.map(val => `;${key}=${val}`).join('') : `;${key}=${value.join(',')}`
+                    }]
             };
         }
-        if (typeof value === "object") {
+        if (typeof value === 'object') {
             return {
-                pairs: [
-                    {
-                        value: explode
-                            ? Object.entries(value)
-                                .map(([subKey, subValue]) => `;${subKey}=${subValue}`)
-                                .join("")
-                            : `;${key}=${Object.entries(value)
-                                .map(([subKey, subValue]) => `${subKey},${subValue}`)
-                                .join(",")}`,
-                    },
-                ],
+                pairs: [{
+                        value: explode ? Object.entries(value).map(([subKey, subValue]) => `;${subKey}=${subValue}`).join('') : `;${key}=${Object.entries(value).map(([subKey, subValue]) => `${subKey},${subValue}`).join(',')}`
+                    }]
             };
         }
         return {
-            pairs: [
-                {
-                    value: `;${key}=${String(value)}`,
-                },
-            ],
+            pairs: [{
+                    value: `;${key}=${String(value)}`
+                }]
         };
     },
     form(key, value, explode) {
         if (!parameterHasValue(value)) {
             return {
-                pairs: [],
+                pairs: []
             };
         }
         if (Array.isArray(value)) {
             return {
-                pairs: explode
-                    ? value.map((val) => ({
+                pairs: explode ? value.map(val => ({
+                    key,
+                    value: String(val)
+                })) : [{
                         key,
-                        value: String(val),
-                    }))
-                    : [
-                        {
-                            key,
-                            value: value.join(","),
-                        },
-                    ],
-                pairSeparator: "&",
-                keyValueSeparator: "=",
+                        value: value.join(',')
+                    }],
+                pairSeparator: '&',
+                keyValueSeparator: '='
             };
         }
-        if (typeof value === "object") {
+        if (typeof value === 'object') {
             return {
-                pairs: explode
-                    ? Object.entries(value).map(([subKey, subValue]) => ({
-                        key: subKey,
-                        value: String(subValue),
-                    }))
-                    : [
-                        {
-                            key,
-                            value: Object.entries(value)
-                                .map(([subKey, subValue]) => `${subKey},${subValue}`)
-                                .join(","),
-                        },
-                    ],
-                pairSeparator: "&",
-                keyValueSeparator: "=",
+                pairs: explode ? Object.entries(value).map(([subKey, subValue]) => ({
+                    key: subKey,
+                    value: String(subValue)
+                })) : [{
+                        key,
+                        value: Object.entries(value).map(([subKey, subValue]) => `${subKey},${subValue}`).join(',')
+                    }],
+                pairSeparator: '&',
+                keyValueSeparator: '='
             };
         }
         return {
-            pairs: [
-                {
+            pairs: [{
                     key,
-                    value: String(value),
-                },
-            ],
+                    value: String(value)
+                }]
         };
     },
     spaceDelimited(key, value) {
         if (!parameterHasValue(value)) {
             return {
-                pairs: [],
+                pairs: []
             };
         }
         if (Array.isArray(value)) {
             return {
-                pairs: [
-                    {
+                pairs: [{
                         key,
-                        value: value.join(" "),
-                    },
-                ],
+                        value: value.join(' ')
+                    }]
             };
         }
-        if (typeof value === "object") {
+        if (typeof value === 'object') {
             return {
-                pairs: [
-                    {
+                pairs: [{
                         key,
-                        value: Object.entries(value)
-                            .map(([subKey, subValue]) => `${subKey} ${subValue}`)
-                            .join(" "),
-                    },
-                ],
+                        value: Object.entries(value).map(([subKey, subValue]) => `${subKey} ${subValue}`).join(' ')
+                    }]
             };
         }
         return {
-            pairs: [
-                {
+            pairs: [{
                     key,
-                    value: String(value),
-                },
-            ],
+                    value: String(value)
+                }]
         };
     },
     pipeDelimited(key, value) {
         if (!parameterHasValue(value)) {
             return {
-                pairs: [],
+                pairs: []
             };
         }
         if (Array.isArray(value)) {
             return {
-                pairs: [
-                    {
+                pairs: [{
                         key,
-                        value: value.join("|"),
-                    },
-                ],
+                        value: value.join('|')
+                    }]
             };
         }
-        if (typeof value === "object") {
+        if (typeof value === 'object') {
             return {
-                pairs: [
-                    {
+                pairs: [{
                         key,
-                        value: Object.entries(value)
-                            .map(([subKey, subValue]) => `${subKey}|${subValue}`)
-                            .join("|"),
-                    },
-                ],
+                        value: Object.entries(value).map(([subKey, subValue]) => `${subKey}|${subValue}`).join('|')
+                    }]
             };
         }
         return {
-            pairs: [
-                {
+            pairs: [{
                     key,
-                    value: String(value),
-                },
-            ],
+                    value: String(value)
+                }]
         };
     },
     deepObject(key, value) {
-        if (typeof value === "object" && !Array.isArray(value) && value !== null) {
+        if (typeof value === 'object' && !Array.isArray(value) && value !== null) {
             return {
-                pairs: Object.entries(value).flatMap(([subKey, subValue]) => formatParameter.deepObject(`${key}[${subKey}]`, subValue, true)
-                    .pairs),
-                pairSeparator: "&",
-                keyValueSeparator: "=",
+                pairs: Object.entries(value).flatMap(([subKey, subValue]) => formatParameter.deepObject(`${key}[${subKey}]`, subValue, true).pairs),
+                pairSeparator: '&',
+                keyValueSeparator: '='
             };
         }
         return {
-            pairs: [
-                {
+            pairs: [{
                     key,
-                    value: String(value),
-                },
-            ],
+                    value: String(value)
+                }]
         };
-    },
+    }
 };
+/**
+ * Stores the deprecation warning state. For every shown deprecation warning, the method and path are stored in order to
+ * avoid showing the same warning appearing multiple times.
+ */
+const deprecationWarningShown = {};
 /** Common HTTP client. Configurable for different environments. */
 class CommonHttpClient {
     constructor(options) {
@@ -448,12 +381,34 @@ class CommonHttpClient {
     getOptions() {
         return this.options;
     }
+    /** Logs a deprecation warning if the operation is deprecated. */
+    logDeprecationWarningIfNecessary(params) {
+        var _a;
+        const methodAndPath = `${params.method} ${params.path}`;
+        const operationName = (_a = this.options.deprecatedOperations) === null || _a === void 0 ? void 0 : _a[methodAndPath];
+        if (!operationName) {
+            return;
+        }
+        if (!deprecationWarningShown[methodAndPath]) {
+            deprecationWarningShown[methodAndPath] = true;
+            if (this.options.logDeprecationWarning) {
+                this.options.logDeprecationWarning({
+                    method: params.method,
+                    path: params.path,
+                    operationName
+                });
+            }
+            else {
+                console.warn(`Deprecated API call ${this.options.apiClientClassName}.${operationName}: ${methodAndPath}`);
+            }
+        }
+    }
     /** Turns an object with query params into a URLSearchParams object. */
     getSearchParams(params, parameters) {
         var _a;
         const result = new URLSearchParams();
         for (const [key, value] of Object.entries(params)) {
-            const { style = "form", explode = style === "form", } = (_a = parameters[key]) !== null && _a !== void 0 ? _a : {};
+            const { style = 'form', explode = style === 'form' } = (_a = parameters[key]) !== null && _a !== void 0 ? _a : {};
             const { pairs } = formatParameter[style](key, value, explode);
             for (const { key, value } of pairs) {
                 if (key !== undefined) {
@@ -470,7 +425,7 @@ class CommonHttpClient {
             return request.path.replace(/\{(.*?)}/g, (original, paramName) => {
                 var _a;
                 if (Object.prototype.hasOwnProperty.call(pathParams, paramName)) {
-                    const { style = "simple", explode = false } = (_a = parameters[paramName]) !== null && _a !== void 0 ? _a : {};
+                    const { style = 'simple', explode = false } = (_a = parameters[paramName]) !== null && _a !== void 0 ? _a : {};
                     return encodeURI(parameterFormattedParameterToString(formatParameter[style](paramName, pathParams[paramName], explode)));
                 }
                 return original;
@@ -481,7 +436,7 @@ class CommonHttpClient {
     /** Build the full URL from the request. */
     buildUrl(request) {
         var _a, _b, _c, _d;
-        const url = new URL(this.buildUrlPath(request, (_b = (_a = request.parameters) === null || _a === void 0 ? void 0 : _a.path) !== null && _b !== void 0 ? _b : {}).replace(/^\//, ""), this.options.baseUrl.replace(/\/?$/, "/"));
+        const url = new URL(this.buildUrlPath(request, (_b = (_a = request.parameters) === null || _a === void 0 ? void 0 : _a.path) !== null && _b !== void 0 ? _b : {}).replace(/^\//, ''), this.options.baseUrl.replace(/\/?$/, '/'));
         if (request.query) {
             for (const [key, value] of this.getSearchParams(request.query, (_d = (_c = request.parameters) === null || _c === void 0 ? void 0 : _c.query) !== null && _d !== void 0 ? _d : {})) {
                 url.searchParams.append(key, value);
@@ -496,22 +451,19 @@ class CommonHttpClient {
             const requestProps = __rest(request, []);
             const requestInit = requestProps;
             const response = yield fetch(url, requestInit);
-            const body = isJsonMediaType((_a = response.headers.get("content-type")) !== null && _a !== void 0 ? _a : "")
-                ? {
-                    type: "json",
-                    data: yield response.json(),
-                }
-                : {
-                    type: "blob",
-                    data: yield response.blob(),
-                };
+            const body = isJsonMediaType((_a = response.headers.get('content-type')) !== null && _a !== void 0 ? _a : '') ? {
+                type: 'json',
+                data: yield response.json()
+            } : {
+                type: 'blob',
+                data: yield response.blob()
+            };
             const headers = {};
             response.headers.forEach((value, key) => {
                 headers[key] = value;
             });
-            if (response.headers.has("set-cookie") &&
-                "getSetCookie" in response.headers) {
-                headers["set-cookie"] = response.headers.getSetCookie();
+            if (response.headers.has('set-cookie') && 'getSetCookie' in response.headers) {
+                headers['set-cookie'] = response.headers.getSetCookie();
             }
             return {
                 status: response.status,
@@ -520,13 +472,14 @@ class CommonHttpClient {
                 url: response.url,
                 headers,
                 ok: response.ok,
-                customRequestProps: request.customRequestProps,
+                customRequestProps: request.customRequestProps
             };
         });
     }
     /** Perform a request. */
     request(request) {
         return __awaiter(this, void 0, void 0, function* () {
+            this.logDeprecationWarningIfNecessary(request);
             try {
                 request = yield this.preprocessRequest(request);
             }
@@ -549,7 +502,7 @@ class CommonHttpClient {
             }
             const { body, path: _path, pathParams: _pathParams, query: _query, headers: requestHeaders, cache, credentials, redirect } = request, otherRequestProps = __rest(request, ["body", "path", "pathParams", "query", "headers", "cache", "credentials", "redirect"]);
             const headers = this.cleanupHeaders(requestHeaders);
-            const fetchRequest = Object.assign(Object.assign({}, otherRequestProps), { headers, cache: cache !== null && cache !== void 0 ? cache : "default", credentials: credentials !== null && credentials !== void 0 ? credentials : "same-origin", redirect: redirect !== null && redirect !== void 0 ? redirect : "follow", body: this.getRequestBody(request) });
+            const fetchRequest = Object.assign(Object.assign({}, otherRequestProps), { headers, cache: cache !== null && cache !== void 0 ? cache : 'default', credentials: credentials !== null && credentials !== void 0 ? credentials : 'same-origin', redirect: redirect !== null && redirect !== void 0 ? redirect : 'follow', body: this.getRequestBody(request) });
             let fetchResponse;
             try {
                 if (this.options.fetch) {
@@ -571,9 +524,7 @@ class CommonHttpClient {
                 }
             }
             if (!fetchResponse.ok) {
-                throw new this.options.errorClass(url, fetchRequest, fetchResponse, this.options, this.options.formatHttpErrorMessage
-                    ? this.options.formatHttpErrorMessage(fetchResponse, fetchRequest)
-                    : `HTTP Error ${fetchResponse.status} (${fetchResponse.statusText})`);
+                throw new this.options.errorClass(url, fetchRequest, fetchResponse, this.options, this.options.formatHttpErrorMessage ? this.options.formatHttpErrorMessage(fetchResponse, fetchRequest) : `HTTP Error ${request.method} ${url.toString()} ${fetchResponse.status} (${fetchResponse.statusText})`);
             }
             return fetchResponse;
         });
@@ -583,26 +534,24 @@ class CommonHttpClient {
         return (response) => __awaiter(this, void 0, void 0, function* () {
             var _a;
             const body = response.body;
-            const contentType = response.headers["content-type"];
-            const mediaType = contentType
-                ? contentType.replace(/;.*$/, "")
-                : undefined;
+            const contentType = response.headers['content-type'];
+            const mediaType = contentType ? contentType.replace(/;.*$/, '') : undefined;
             const mediaTypes = (_a = distribution[response.status]) !== null && _a !== void 0 ? _a : {};
             let destType;
             if (mediaType) {
                 destType = mediaTypes[mediaType];
                 if (!destType) {
-                    destType = mediaTypes[mediaType.replace(/\/.*$/, "/*")];
+                    destType = mediaTypes[mediaType.replace(/\/.*$/, '/*')];
                 }
                 if (!destType) {
-                    destType = mediaTypes[mediaType.replace(/^.*\//, "*/")];
+                    destType = mediaTypes[mediaType.replace(/^.*\//, '*/')];
                 }
                 if (!destType) {
-                    destType = mediaTypes["*/*"];
+                    destType = mediaTypes['*/*'];
                 }
             }
             else {
-                destType = mediaTypes["*/*"];
+                destType = mediaTypes['*/*'];
             }
             if (!destType) {
                 let binaryBody;
@@ -616,7 +565,7 @@ class CommonHttpClient {
                     mediaType,
                     status: response.status,
                     body: binaryBody,
-                    response,
+                    response
                 };
             }
             try {
@@ -625,7 +574,7 @@ class CommonHttpClient {
                     mediaType,
                     status: response.status,
                     body: convertedBody.data,
-                    response,
+                    response
                 };
             }
             catch (e) {
@@ -653,9 +602,7 @@ class CommonHttpClient {
         if (headers === undefined) {
             return {};
         }
-        return Object.fromEntries(Object.entries(headers !== null && headers !== void 0 ? headers : {})
-            .filter((header) => header[1] !== undefined && header[1] !== null)
-            .map(([key, value]) => [key.toLowerCase(), value]));
+        return Object.fromEntries(Object.entries(headers !== null && headers !== void 0 ? headers : {}).filter((header) => header[1] !== undefined && header[1] !== null).map(([key, value]) => [key.toLowerCase(), value]));
     }
     getRequestBody(request) {
         var _a;
@@ -663,9 +610,7 @@ class CommonHttpClient {
             return undefined;
         }
         for (const [key, value] of Object.entries((_a = request.headers) !== null && _a !== void 0 ? _a : {})) {
-            if (key.toLowerCase() === "content-type" &&
-                value &&
-                isJsonMediaType(value)) {
+            if (key.toLowerCase() === 'content-type' && value && isJsonMediaType(value)) {
                 return JSON.stringify(request.body);
             }
         }
@@ -674,9 +619,7 @@ class CommonHttpClient {
     preprocessRequest(request) {
         return __awaiter(this, void 0, void 0, function* () {
             const requestWithHeaders = Object.assign(Object.assign({}, request), { headers: Object.assign(Object.assign({}, this.options.headers), this.cleanupHeaders(request.headers)) });
-            return this.options.preprocessRequest
-                ? this.options.preprocessRequest(requestWithHeaders)
-                : requestWithHeaders;
+            return this.options.preprocessRequest ? this.options.preprocessRequest(requestWithHeaders) : requestWithHeaders;
         });
     }
 }