confluence.js 1.2.2 → 1.3.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+### 1.3.0
+
+- Telemetry removed (deprecated)
+- Fixed bug with spaceKeys in `client.space.getSpaces` ([#14](https://github.com/MrRefactoring/confluence.js/issues/14) Thanks [David Sanchez](https://github.com/emulienfou) for catching)
+- Fixed bug with attachment download ([#15](https://github.com/MrRefactoring/confluence.js/issues/15) Thanks [Martin Reinhardt](https://github.com/hypery2k) for catching)
+
 ### 1.2.2
 
 - JSDOC improvements

package/README.md

@@ -18,9 +18,6 @@ Usability, consistency, and performance are key focuses of confluence.js, and it
 ## Table of contents
 
 - [Installation](#installation)
-- [Telemetry information collection agreement](#telemetry-information-collection-agreement)
-  - [Customizing telemetry collection data example](#customizing-telemetry-collection-data-example)
-  - [Disabling telemetry collection example](#disabling-telemetry-collection-example)
 - [Usage](#usage)
   - [Authentication](#authentication)
     - [Basic](#basic-authenticationhttpsdeveloperatlassiancomcloudconfluencebasic-auth-for-rest-apis)
@@ -47,60 +44,6 @@ Install with the yarn:
 yarn add confluence.js
 ```
 
-## Telemetry information collecting agreement
-
-The use of this library may collect, record and transmit data
-about the operation of the library and related data, as well
-as potentially personal data, including ip address from which
-the request is made, user agent from the device from which the
-request is made, version of the library used, version of the
-telemetry sending library, name of the invoked method, authorization
-type information (can be configured), base configuration request
-usage information, callback information, onResponse middleware usage
-information, onError middleware usage information, queries usage
-information, body usage information in request, headers usage
-information in request, HTTP response code (can be configured),
-request start date and time and response receipt date and time
-(can be configured), No check atlassian token flag enabling information.
-
-The type and amount of data may vary with the version of the libraries and can be changed at any time without notice.
-
-Telemetry data collection is enabled by default.
-
-The following tracking parameters can be configured:
-
-- Authentication type
-- Request status code
-- Request timings
-
-#### Customizing telemetry collecting data example
-
-```typescript
-import { Config } from 'confluence.js';
-
-const config: Config = {
-  host: 'https://your-domain.atlassian.net',
-  telemetry: {
-    allowedToPassAuthenticationType: false,  // true by default
-    allowedToPassRequestStatusCode: true,  // true by default
-    allowedToPassRequestTimings: false,  // true by default
-  },
-};
-```
-
-If you want to disable telemetry, set the `telemetry` field to `false`.
-
-#### Disabling telemetry collection example
-
-```typescript
-import { Config } from 'confluence.js';
-
-const config: Config = {
-  host: 'https://your-domain.atlassian.net',
-  telemetry: false, // Telemetry will not be collected
-};
-```
-
 ## Usage
 
 #### Authentication

package/out/api/contentAttachments.d.ts

@@ -244,7 +244,7 @@ export declare class ContentAttachments {
      */
     updateAttachmentData<T = Models.Content>(parameters: Parameters.UpdateAttachmentData, callback?: never): Promise<T>;
     /** Redirects the client to a URL that serves an attachment's binary data. */
-    downloadAttachment<T = unknown>(parameters: Parameters.DownloadAttachment, callback: Callback<T>): Promise<void>;
+    downloadAttachment<T = ArrayBuffer>(parameters: Parameters.DownloadAttachment, callback: Callback<T>): Promise<void>;
     /** Redirects the client to a URL that serves an attachment's binary data. */
-    downloadAttachment<T = unknown>(parameters: Parameters.DownloadAttachment, callback?: never): Promise<T>;
+    downloadAttachment<T = ArrayBuffer>(parameters: Parameters.DownloadAttachment, callback?: never): Promise<T>;
 }

package/out/api/contentAttachments.js

@@ -73,6 +73,7 @@ class ContentAttachments {
             const config = {
                 url: `/api/content/${parameters.id}/child/attachment/${parameters.attachmentId}/download`,
                 method: 'GET',
+                responseType: 'arraybuffer',
                 params: {
                     version: parameters.version,
                 },

package/out/api/space.js

@@ -7,12 +7,13 @@ class Space {
         this.client = client;
     }
     getSpaces(parameters, callback) {
+        var _a;
         return (0, tslib_1.__awaiter)(this, void 0, void 0, function* () {
             const config = {
                 url: '/api/space',
                 method: 'GET',
                 params: {
-                    spaceKey: parameters === null || parameters === void 0 ? void 0 : parameters.spaceKey,
+                    spaceKey: (_a = parameters === null || parameters === void 0 ? void 0 : parameters.spaceKey) === null || _a === void 0 ? void 0 : _a.map((key, index) => index ? `&spaceKey=${key}` : key),
                     spaceId: parameters === null || parameters === void 0 ? void 0 : parameters.spaceId,
                     type: parameters === null || parameters === void 0 ? void 0 : parameters.type,
                     status: parameters === null || parameters === void 0 ? void 0 : parameters.status,

package/out/clients/baseClient.d.ts

@@ -1,4 +1,3 @@
-import { Telemetry } from 'telemetry.confluence.js';
 import type { Client } from './client';
 import type { Callback } from '../callback';
 import type { Config } from '../config';
@@ -6,14 +5,12 @@ import type { RequestConfig } from '../requestConfig';
 export declare class BaseClient implements Client {
     #private;
     protected readonly config: Config;
-    private telemetryClient;
     protected urlSuffix: string;
     constructor(config: Config);
     protected paramSerializer(parameters: Record<string, any>): string;
     protected encode(value: string): string;
     protected removeUndefinedProperties(obj: Record<string, any>): Record<string, any>;
     private get instance();
-    sendRequest<T>(requestConfig: RequestConfig, callback: never, telemetryData?: Partial<Telemetry>): Promise<T>;
-    sendRequest<T>(requestConfig: RequestConfig, callback: Callback<T>, telemetryData?: Partial<Telemetry>): Promise<void>;
-    private get authenticationType();
+    sendRequest<T>(requestConfig: RequestConfig, callback: never, telemetryData?: any): Promise<T>;
+    sendRequest<T>(requestConfig: RequestConfig, callback: Callback<T>, telemetryData?: any): Promise<void>;
 }

package/out/clients/baseClient.js

@@ -4,7 +4,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.BaseClient = void 0;
 const tslib_1 = require("tslib");
 const axios_1 = require("axios");
-const telemetry_confluence_js_1 = require("telemetry.confluence.js");
 const authenticationService_1 = require("../services/authenticationService");
 const ATLASSIAN_TOKEN_CHECK_FLAG = 'X-Atlassian-Token';
 const ATLASSIAN_TOKEN_CHECK_NOCHECK_VALUE = 'no-check';
@@ -13,7 +12,6 @@ class BaseClient {
         this.config = config;
         _BaseClient_instance.set(this, void 0);
         this.urlSuffix = '/wiki/rest/';
-        this.telemetryClient = new telemetry_confluence_js_1.TelemetryClient(config.telemetry);
     }
     paramSerializer(parameters) {
         const parts = [];
@@ -60,11 +58,9 @@ class BaseClient {
         (0, tslib_1.__classPrivateFieldSet)(this, _BaseClient_instance, axios_1.default.create(Object.assign(Object.assign({ paramsSerializer: this.paramSerializer.bind(this) }, this.config.baseRequestConfig), { baseURL: `${this.config.host}${this.urlSuffix}`, headers: this.removeUndefinedProperties(Object.assign({ [ATLASSIAN_TOKEN_CHECK_FLAG]: this.config.noCheckAtlassianToken ? ATLASSIAN_TOKEN_CHECK_NOCHECK_VALUE : undefined }, (_a = this.config.baseRequestConfig) === null || _a === void 0 ? void 0 : _a.headers)) })), "f");
         return (0, tslib_1.__classPrivateFieldGet)(this, _BaseClient_instance, "f");
     }
-    sendRequest(requestConfig, callback, telemetryData) {
-        var _a, _b, _c, _d, _e, _f, _g, _h;
+    sendRequest(requestConfig, callback) {
+        var _a, _b, _c, _d;
         return (0, tslib_1.__awaiter)(this, void 0, void 0, function* () {
-            const startDateTime = new Date();
-            const telemetry = Object.assign({ authentication: this.authenticationType, baseRequestConfigUsed: !!this.config.baseRequestConfig, bodyExists: !!requestConfig.data, callbackUsed: !!callback, headersExists: !!requestConfig.headers, libVersion: '1.2.2', libVersionHash: 'bda9643ac6601722a28f238714274da4', methodName: (telemetryData === null || telemetryData === void 0 ? void 0 : telemetryData.methodName) || 'sendRequest', onErrorMiddlewareUsed: !!((_a = this.config.middlewares) === null || _a === void 0 ? void 0 : _a.onError), onResponseMiddlewareUsed: !!((_b = this.config.middlewares) === null || _b === void 0 ? void 0 : _b.onResponse), queryExists: !!requestConfig.params, requestEndTime: new Date(), requestStartTime: startDateTime, requestStatusCode: 0, noCheckAtlassianToken: !!this.config.noCheckAtlassianToken }, telemetryData);
             try {
                 const modifiedRequestConfig = Object.assign(Object.assign({}, requestConfig), { headers: this.removeUndefinedProperties(Object.assign({ Authorization: yield authenticationService_1.AuthenticationService.getAuthenticationToken(this.config.authentication, {
                             baseURL: this.config.host,
@@ -75,8 +71,7 @@ class BaseClient {
                 const callbackResponseHandler = callback && ((data) => callback(null, data));
                 const defaultResponseHandler = (data) => data;
                 const responseHandler = callbackResponseHandler !== null && callbackResponseHandler !== void 0 ? callbackResponseHandler : defaultResponseHandler;
-                (_d = (_c = this.config.middlewares) === null || _c === void 0 ? void 0 : _c.onResponse) === null || _d === void 0 ? void 0 : _d.call(_c, response.data);
-                telemetry.requestStatusCode = response.status;
+                (_b = (_a = this.config.middlewares) === null || _a === void 0 ? void 0 : _a.onResponse) === null || _b === void 0 ? void 0 : _b.call(_a, response.data);
                 return responseHandler(response.data);
             }
             catch (e) {
@@ -85,32 +80,11 @@ class BaseClient {
                     throw error;
                 };
                 const errorHandler = callbackErrorHandler !== null && callbackErrorHandler !== void 0 ? callbackErrorHandler : defaultErrorHandler;
-                (_f = (_e = this.config.middlewares) === null || _e === void 0 ? void 0 : _e.onError) === null || _f === void 0 ? void 0 : _f.call(_e, e);
-                telemetry.requestStatusCode = e.isAxiosError ? (_h = (_g = e.response) === null || _g === void 0 ? void 0 : _g.status) !== null && _h !== void 0 ? _h : 0 : 418;
+                (_d = (_c = this.config.middlewares) === null || _c === void 0 ? void 0 : _c.onError) === null || _d === void 0 ? void 0 : _d.call(_c, e);
                 return errorHandler(e);
             }
-            finally {
-                telemetry.requestEndTime = new Date();
-                this.telemetryClient.sendTelemetry(telemetry);
-            }
         });
     }
-    get authenticationType() {
-        const { authentication } = this.config;
-        if (!authentication) {
-            return telemetry_confluence_js_1.Authentication.None;
-        }
-        if (authentication.basic) {
-            return telemetry_confluence_js_1.Authentication.Basic;
-        }
-        if (authentication.oauth2) {
-            return telemetry_confluence_js_1.Authentication.OAuth2;
-        }
-        if (authentication.jwt) {
-            return telemetry_confluence_js_1.Authentication.JWT;
-        }
-        return telemetry_confluence_js_1.Authentication.NA;
-    }
 }
 exports.BaseClient = BaseClient;
 _BaseClient_instance = new WeakMap();

package/out/clients/client.d.ts

@@ -1,7 +1,6 @@
-import type { Telemetry } from 'telemetry.confluence.js';
 import type { Callback } from '../callback';
 import type { RequestConfig } from '../requestConfig';
 export interface Client {
-    sendRequest<T>(requestConfig: RequestConfig, callback?: never, telemetryData?: Partial<Telemetry>): Promise<T>;
-    sendRequest<T>(requestConfig: RequestConfig, callback?: Callback<T>, telemetryData?: Partial<Telemetry>): Promise<void>;
+    sendRequest<T>(requestConfig: RequestConfig, callback?: never, telemetryData?: any): Promise<T>;
+    sendRequest<T>(requestConfig: RequestConfig, callback?: Callback<T>, telemetryData?: any): Promise<void>;
 }

package/out/config.d.ts

@@ -1,5 +1,4 @@
 import { AxiosError } from 'axios';
-import type { TelemetryConfig } from 'telemetry.confluence.js';
 import type { RequestConfig } from './requestConfig';
 import type { UtilityTypes } from './utilityTypes';
 export interface Config {
@@ -7,6 +6,7 @@ export interface Config {
     baseRequestConfig?: Config.BaseRequestConfig;
     authentication?: Config.Authentication;
     middlewares?: Config.Middlewares;
+    /** @deprecated Disabled. Will be removed in the next major version. */
     telemetry?: Config.Telemetry;
     /**
      * Adds `'X-Atlassian-Token': 'no-check'` to each request header
@@ -16,7 +16,8 @@ export interface Config {
 export declare namespace Config {
     type BaseRequestConfig = RequestConfig;
     type Error = AxiosError;
-    type Telemetry = boolean | TelemetryConfig;
+    /** @deprecated Disabled. Will be removed in the next major version. */
+    type Telemetry = boolean | any;
     type Authentication = UtilityTypes.XOR<{
         jwt: Authentication.JWT;
     }, UtilityTypes.XOR<{

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "confluence.js",
-  "version": "1.2.2",
+  "version": "1.3.0",
   "description": "confluence.js is a powerful Node.JS/Browser module that allows you to interact with the Confluence API very easily",
   "author": "Vladislav Tupikin <mrrefactoring@yandex.ru>",
   "license": "MIT",
@@ -12,7 +12,7 @@
     "build": "tsc",
     "prepublishOnly": "npm run build && npm run test && npm run lint",
     "test": "npm run test:unit && npm run test:e2e",
-    "test:unit": "jest tests/unit",
+    "test:unit": "jest tests/unit --verbose",
     "test:e2e": "jest tests/e2e --setupFiles=./tests/setup.ts --runInBand",
     "prettier": "prettier --write src/**/*.ts",
     "doc": "typedoc --name \"Confluence.js - Cloud and Server API library\" --out docs ./src/index.ts --plugin typedoc-plugin-extras --footerDate --footerTime --footerTypedocVersion --favicon https://svgshare.com/i/bVi.svg",
@@ -37,20 +37,20 @@
     "@types/jest": "^27.0.3",
     "@types/oauth": "^0.9.1",
     "@types/sinon": "^10.0.6",
-    "@typescript-eslint/eslint-plugin": "^5.4.0",
-    "@typescript-eslint/parser": "^5.4.0",
+    "@typescript-eslint/eslint-plugin": "^5.6.0",
+    "@typescript-eslint/parser": "^5.6.0",
     "dotenv": "^10.0.0",
-    "eslint": "^8.2.0",
-    "eslint-config-airbnb": "^19.0.0",
-    "eslint-config-airbnb-typescript": "^16.0.0",
+    "eslint": "^8.4.1",
+    "eslint-config-airbnb": "^19.0.2",
+    "eslint-config-airbnb-typescript": "^16.1.0",
     "eslint-import-resolver-typescript": "^2.5.0",
     "eslint-plugin-import": "^2.25.3",
-    "jest": "^27.3.1",
-    "prettier": "^2.4.1",
+    "jest": "^27.4.3",
+    "prettier": "^2.5.1",
     "prettier-plugin-jsdoc": "^0.3.30",
     "sinon": "^12.0.1",
-    "ts-jest": "^27.0.7",
-    "typedoc": "^0.22.9",
+    "ts-jest": "^27.1.1",
+    "typedoc": "^0.22.10",
     "typedoc-plugin-extras": "^2.2.1",
     "typescript": "^4.5.2"
   },
@@ -58,7 +58,6 @@
     "atlassian-jwt": "^2.0.2",
     "axios": "^0.24.0",
     "oauth": "^0.9.15",
-    "telemetry.confluence.js": "<2",
     "tslib": "^2.3.1"
   }
 }

package/src/api/contentAttachments.ts

@@ -362,19 +362,20 @@ export class ContentAttachments {
   }
 
   /** Redirects the client to a URL that serves an attachment's binary data. */
-  async downloadAttachment<T = unknown>(
+  async downloadAttachment<T = ArrayBuffer>(
     parameters: Parameters.DownloadAttachment,
     callback: Callback<T>
   ): Promise<void>;
   /** Redirects the client to a URL that serves an attachment's binary data. */
-  async downloadAttachment<T = unknown>(parameters: Parameters.DownloadAttachment, callback?: never): Promise<T>;
-  async downloadAttachment<T = unknown>(
+  async downloadAttachment<T = ArrayBuffer>(parameters: Parameters.DownloadAttachment, callback?: never): Promise<T>;
+  async downloadAttachment<T = ArrayBuffer>(
     parameters: Parameters.DownloadAttachment,
     callback?: Callback<T>,
   ): Promise<void | T> {
     const config: RequestConfig = {
       url: `/api/content/${parameters.id}/child/attachment/${parameters.attachmentId}/download`,
       method: 'GET',
+      responseType: 'arraybuffer',
       params: {
         version: parameters.version,
       },

package/src/api/space.ts

@@ -31,7 +31,7 @@ export class Space {
       url: '/api/space',
       method: 'GET',
       params: {
-        spaceKey: parameters?.spaceKey,
+        spaceKey: parameters?.spaceKey?.map((key, index) => index ? `&spaceKey=${key}` : key),
         spaceId: parameters?.spaceId,
         type: parameters?.type,
         status: parameters?.status,

package/src/clients/baseClient.ts

@@ -1,5 +1,4 @@
 import axios, { AxiosInstance } from 'axios';
-import { Authentication, Telemetry, TelemetryClient } from 'telemetry.confluence.js';
 import type { Client } from './client';
 import type { Callback } from '../callback';
 import type { Config } from '../config';
@@ -11,13 +10,10 @@ const ATLASSIAN_TOKEN_CHECK_NOCHECK_VALUE = 'no-check';
 
 export class BaseClient implements Client {
   #instance: AxiosInstance | undefined;
-  private telemetryClient: TelemetryClient;
 
   protected urlSuffix = '/wiki/rest/';
 
-  constructor(protected readonly config: Config) {
-    this.telemetryClient = new TelemetryClient(config.telemetry);
-  }
+  constructor(protected readonly config: Config) {}
 
   protected paramSerializer(parameters: Record<string, any>): string {
     const parts: string[] = [];
@@ -82,38 +78,16 @@ export class BaseClient implements Client {
     return this.#instance;
   }
 
-  async sendRequest<T>(requestConfig: RequestConfig, callback: never, telemetryData?: Partial<Telemetry>): Promise<T>;
+  async sendRequest<T>(requestConfig: RequestConfig, callback: never, telemetryData?: any): Promise<T>;
   async sendRequest<T>(
     requestConfig: RequestConfig,
     callback: Callback<T>,
-    telemetryData?: Partial<Telemetry>
+    telemetryData?: any,
   ): Promise<void>;
   async sendRequest<T>(
     requestConfig: RequestConfig,
     callback: Callback<T> | never,
-    telemetryData?: Partial<Telemetry>,
   ): Promise<void | T> {
-    const startDateTime = new Date();
-
-    const telemetry: Telemetry = {
-      authentication: this.authenticationType,
-      baseRequestConfigUsed: !!this.config.baseRequestConfig,
-      bodyExists: !!requestConfig.data,
-      callbackUsed: !!callback,
-      headersExists: !!requestConfig.headers,
-      libVersion: '1.2.2',
-      libVersionHash: 'bda9643ac6601722a28f238714274da4',
-      methodName: telemetryData?.methodName || 'sendRequest',
-      onErrorMiddlewareUsed: !!this.config.middlewares?.onError,
-      onResponseMiddlewareUsed: !!this.config.middlewares?.onResponse,
-      queryExists: !!requestConfig.params,
-      requestEndTime: new Date(),
-      requestStartTime: startDateTime,
-      requestStatusCode: 0,
-      noCheckAtlassianToken: !!this.config.noCheckAtlassianToken,
-      ...telemetryData,
-    };
-
     try {
       const modifiedRequestConfig = {
         ...requestConfig,
@@ -136,8 +110,6 @@ export class BaseClient implements Client {
 
       this.config.middlewares?.onResponse?.(response.data);
 
-      telemetry.requestStatusCode = response.status;
-
       return responseHandler(response.data);
     } catch (e: any) {
       const callbackErrorHandler = callback && ((error: Config.Error) => callback(error));
@@ -149,35 +121,7 @@ export class BaseClient implements Client {
 
       this.config.middlewares?.onError?.(e);
 
-      telemetry.requestStatusCode = e.isAxiosError ? e.response?.status ?? 0 : 418;
-
       return errorHandler(e);
-    } finally {
-      telemetry.requestEndTime = new Date();
-
-      this.telemetryClient.sendTelemetry(telemetry);
-    }
-  }
-
-  private get authenticationType(): Authentication {
-    const { authentication } = this.config;
-
-    if (!authentication) {
-      return Authentication.None;
-    }
-
-    if (authentication.basic) {
-      return Authentication.Basic;
-    }
-
-    if (authentication.oauth2) {
-      return Authentication.OAuth2;
-    }
-
-    if (authentication.jwt) {
-      return Authentication.JWT;
     }
-
-    return Authentication.NA;
   }
 }

package/src/clients/client.ts

@@ -1,12 +1,11 @@
-import type { Telemetry } from 'telemetry.confluence.js';
 import type { Callback } from '../callback';
 import type { RequestConfig } from '../requestConfig';
 
 export interface Client {
-  sendRequest<T>(requestConfig: RequestConfig, callback?: never, telemetryData?: Partial<Telemetry>): Promise<T>;
+  sendRequest<T>(requestConfig: RequestConfig, callback?: never, telemetryData?: any): Promise<T>;
   sendRequest<T>(
     requestConfig: RequestConfig,
     callback?: Callback<T>,
-    telemetryData?: Partial<Telemetry>
+    telemetryData?: any,
   ): Promise<void>;
 }

package/src/config.ts

@@ -1,5 +1,4 @@
 import { AxiosError } from 'axios';
-import type { TelemetryConfig } from 'telemetry.confluence.js';
 import type { RequestConfig } from './requestConfig';
 import type { UtilityTypes } from './utilityTypes';
 
@@ -8,6 +7,7 @@ export interface Config {
   baseRequestConfig?: Config.BaseRequestConfig;
   authentication?: Config.Authentication;
   middlewares?: Config.Middlewares;
+  /** @deprecated Disabled. Will be removed in the next major version. */
   telemetry?: Config.Telemetry;
   /**
    * Adds `'X-Atlassian-Token': 'no-check'` to each request header
@@ -18,7 +18,8 @@ export interface Config {
 export namespace Config {
   export type BaseRequestConfig = RequestConfig;
   export type Error = AxiosError;
-  export type Telemetry = boolean | TelemetryConfig;
+  /** @deprecated Disabled. Will be removed in the next major version. */
+  export type Telemetry = boolean | any;
 
   export type Authentication = UtilityTypes.XOR<{
     jwt: Authentication.JWT;