confluence.js 1.2.2 → 1.4.0

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # Changelog
 
+- Analytics API added.
+- ContentContentState API added.
+- `deletePageTree` method added to `Experimental`.
+- `getUserProperties` method added to `Experimental`.
+- `getUserProperty` method added to `Experimental`.
+- `createUserProperty` method added to `Experimental`.
+- `updateUserProperty` method added to `Experimental`.
+- `deleteUserProperty` method added to `Experimental`.
+- `getContentStateSettings` method added to `Settings`.
+- Another small changes.
+- Personal Access token authentication added.
+
+### 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,14 +18,12 @@ 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)
     - [OAuth 2.0](#oauth-20httpsdeveloperatlassiancomcloudconfluenceoauth-2-3lo-apps)
     - [JWT](#jwthttpsdeveloperatlassiancomcloudconfluenceunderstanding-jwt)
+    - [Personal access token](#personal-access-token)
   - [Your first request and using algorithm](#your-first-request-and-using-algorithm)
 - [Decreasing Webpack bundle size](#decreasing-webpack-bundle-size)
 - [Take a look at our other products](#take-a-look-at-our-other-products)
@@ -47,60 +45,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
@@ -179,6 +123,19 @@ const client = new ConfluenceClient({
 });
 ```
 
+##### [Personal access token](https://confluence.atlassian.com/enterprise/using-personal-access-tokens-1026032365.html)
+
+```typescript
+import { ConfluenceClient } from 'confluence.js';
+
+const client = new ConfluenceClient({
+  host: 'https://your-domain.atlassian.net',
+  authentication: {
+    personalAccessToken: 'secrectPAT',
+  },
+});
+```
+
 #### Your first request and using algorithm
 
 ```typescript
@@ -278,6 +235,7 @@ client.<group>.<methodName>(parametersObject);
 
 Available groups:
 
+- [analytics](https://developer.atlassian.com/cloud/confluence/rest/api-group-analytics/)
 - [audit](https://developer.atlassian.com/cloud/confluence/rest/api-group-audit)
 - [content](https://developer.atlassian.com/cloud/confluence/rest/api-group-content/)
 - [contentAttachments](https://developer.atlassian.com/cloud/confluence/rest/api-group-content---attachments/#api-group-content---attachments)

package/out/api/analytics.d.ts

@@ -0,0 +1,16 @@
+import * as Models from './models';
+import * as Parameters from './parameters';
+import { Callback } from '../callback';
+import { Client } from '../clients';
+export declare class Analytics {
+    private client;
+    constructor(client: Client);
+    /** Get the total number of views a piece of content has. */
+    getViews<T = Models.GetViews>(parameters: Parameters.GetViews, callback: Callback<T>): Promise<void>;
+    /** Get the total number of views a piece of content has. */
+    getViews<T = Models.GetViews>(parameters: Parameters.GetViews, callback?: never): Promise<T>;
+    /** Get the total number of distinct viewers a piece of content has. */
+    getViewers<T = Models.GetViewers>(parameters: Parameters.GetViewers, callback: Callback<T>): Promise<void>;
+    /** Get the total number of distinct viewers a piece of content has. */
+    getViewers<T = Models.GetViewers>(parameters: Parameters.GetViewers, callback?: never): Promise<T>;
+}

package/out/api/analytics.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Analytics = void 0;
+const tslib_1 = require("tslib");
+class Analytics {
+    constructor(client) {
+        this.client = client;
+    }
+    getViews(parameters, callback) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            const config = {
+                url: `/api/analytics/content/${parameters.contentId}/views`,
+                method: 'GET',
+                params: {
+                    fromDate: parameters.fromDate,
+                },
+            };
+            return this.client.sendRequest(config, callback);
+        });
+    }
+    getViewers(parameters, callback) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            const config = {
+                url: `/api/analytics/content/${parameters.contentId}/viewers`,
+                method: 'GET',
+                params: {
+                    fromDate: parameters.fromDate,
+                },
+            };
+            return this.client.sendRequest(config, callback);
+        });
+    }
+}
+exports.Analytics = Analytics;

package/out/api/audit.d.ts

@@ -1,7 +1,7 @@
 import * as Models from './models';
 import * as Parameters from './parameters';
-import { Client } from '../clients';
 import { Callback } from '../callback';
+import { Client } from '../clients';
 export declare class Audit {
     private client;
     constructor(client: Client);

package/out/api/audit.js

@@ -7,7 +7,7 @@ class Audit {
         this.client = client;
     }
     getAuditRecords(parameters, callback) {
-        return (0, tslib_1.__awaiter)(this, void 0, void 0, function* () {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
             const config = {
                 url: '/api/audit',
                 method: 'GET',
@@ -19,11 +19,11 @@ class Audit {
                     limit: parameters === null || parameters === void 0 ? void 0 : parameters.limit,
                 },
             };
-            return this.client.sendRequest(config, callback, { methodName: 'getAuditRecords' });
+            return this.client.sendRequest(config, callback);
         });
     }
     createAuditRecord(parameters, callback) {
-        return (0, tslib_1.__awaiter)(this, void 0, void 0, function* () {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
             const config = {
                 url: '/api/audit',
                 method: 'POST',
@@ -40,11 +40,11 @@ class Audit {
                     associatedObjects: parameters === null || parameters === void 0 ? void 0 : parameters.associatedObjects,
                 },
             };
-            return this.client.sendRequest(config, callback, { methodName: 'createAuditRecord' });
+            return this.client.sendRequest(config, callback);
         });
     }
     exportAuditRecords(parameters, callback) {
-        return (0, tslib_1.__awaiter)(this, void 0, void 0, function* () {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
             const config = {
                 url: '/api/audit/export',
                 method: 'GET',
@@ -55,20 +55,20 @@ class Audit {
                     format: parameters === null || parameters === void 0 ? void 0 : parameters.format,
                 },
             };
-            return this.client.sendRequest(config, callback, { methodName: 'exportAuditRecords' });
+            return this.client.sendRequest(config, callback);
         });
     }
     getRetentionPeriod(callback) {
-        return (0, tslib_1.__awaiter)(this, void 0, void 0, function* () {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
             const config = {
                 url: '/api/audit/retention',
                 method: 'GET',
             };
-            return this.client.sendRequest(config, callback, { methodName: 'getRetentionPeriod' });
+            return this.client.sendRequest(config, callback);
         });
     }
     setRetentionPeriod(parameters, callback) {
-        return (0, tslib_1.__awaiter)(this, void 0, void 0, function* () {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
             const config = {
                 url: '/api/audit/retention',
                 method: 'PUT',
@@ -77,11 +77,11 @@ class Audit {
                     units: parameters === null || parameters === void 0 ? void 0 : parameters.units,
                 },
             };
-            return this.client.sendRequest(config, callback, { methodName: 'setRetentionPeriod' });
+            return this.client.sendRequest(config, callback);
         });
     }
     getAuditRecordsForTimePeriod(parameters, callback) {
-        return (0, tslib_1.__awaiter)(this, void 0, void 0, function* () {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
             const config = {
                 url: '/api/audit/since',
                 method: 'GET',
@@ -93,7 +93,7 @@ class Audit {
                     limit: parameters === null || parameters === void 0 ? void 0 : parameters.limit,
                 },
             };
-            return this.client.sendRequest(config, callback, { methodName: 'getAuditRecordsForTimePeriod' });
+            return this.client.sendRequest(config, callback);
         });
     }
 }

package/out/api/content.d.ts

@@ -1,7 +1,7 @@
 import * as Models from './models';
 import * as Parameters from './parameters';
-import { Client } from '../clients';
 import { Callback } from '../callback';
+import { Client } from '../clients';
 export declare class Content {
     private client;
     constructor(client: Client);

package/out/api/content.js

@@ -7,7 +7,7 @@ class Content {
         this.client = client;
     }
     getContent(parameters, callback) {
-        return (0, tslib_1.__awaiter)(this, void 0, void 0, function* () {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
             const config = {
                 url: '/api/content',
                 method: 'GET',
@@ -24,11 +24,11 @@ class Content {
                     expand: parameters === null || parameters === void 0 ? void 0 : parameters.expand,
                 },
             };
-            return this.client.sendRequest(config, callback, { methodName: 'getContent' });
+            return this.client.sendRequest(config, callback);
         });
     }
     createContent(parameters, callback) {
-        return (0, tslib_1.__awaiter)(this, void 0, void 0, function* () {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
             const config = {
                 url: '/api/content',
                 method: 'POST',
@@ -38,11 +38,11 @@ class Content {
                 },
                 data: Object.assign(Object.assign({}, parameters), { status: undefined, expand: undefined }),
             };
-            return this.client.sendRequest(config, callback, { methodName: 'createContent' });
+            return this.client.sendRequest(config, callback);
         });
     }
     archivePages(parameters, callback) {
-        return (0, tslib_1.__awaiter)(this, void 0, void 0, function* () {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
             const config = {
                 url: '/api/content/archive',
                 method: 'POST',
@@ -50,11 +50,11 @@ class Content {
                     pages: parameters.pages,
                 },
             };
-            return this.client.sendRequest(config, callback, { methodName: 'archivePages' });
+            return this.client.sendRequest(config, callback);
         });
     }
     publishLegacyDraft(parameters, callback) {
-        return (0, tslib_1.__awaiter)(this, void 0, void 0, function* () {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
             const config = {
                 url: `/api/content/blueprint/instance/${parameters.draftId}`,
                 method: 'POST',
@@ -63,11 +63,11 @@ class Content {
                 },
                 data: Object.assign(Object.assign({}, parameters), { version: parameters.version, title: parameters.title, type: parameters.type, status: parameters.bodyStatus, space: parameters.space, ancestors: parameters.ancestors }),
             };
-            return this.client.sendRequest(config, callback, { methodName: 'publishLegacyDraft' });
+            return this.client.sendRequest(config, callback);
         });
     }
     publishSharedDraft(parameters, callback) {
-        return (0, tslib_1.__awaiter)(this, void 0, void 0, function* () {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
             const config = {
                 url: `/api/content/blueprint/instance/${parameters.draftId}`,
                 method: 'PUT',
@@ -76,11 +76,11 @@ class Content {
                 },
                 data: Object.assign(Object.assign({}, parameters), { version: parameters.version, title: parameters.title, type: parameters.type, status: parameters.bodyStatus, space: parameters.space, ancestors: parameters.ancestors }),
             };
-            return this.client.sendRequest(config, callback, { methodName: 'publishSharedDraft' });
+            return this.client.sendRequest(config, callback);
         });
     }
     searchContentByCQL(parameters, callback) {
-        return (0, tslib_1.__awaiter)(this, void 0, void 0, function* () {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
             const config = {
                 url: '/api/content/search',
                 method: 'GET',
@@ -91,11 +91,11 @@ class Content {
                     limit: parameters.limit,
                 },
             };
-            return this.client.sendRequest(config, callback, { methodName: 'searchContentByCQL' });
+            return this.client.sendRequest(config, callback);
         });
     }
     getContentById(parameters, callback) {
-        return (0, tslib_1.__awaiter)(this, void 0, void 0, function* () {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
             const config = {
                 url: `/api/content/${parameters.id}`,
                 method: 'GET',
@@ -107,11 +107,11 @@ class Content {
                     expand: parameters.expand,
                 },
             };
-            return this.client.sendRequest(config, callback, { methodName: 'getContentById' });
+            return this.client.sendRequest(config, callback);
         });
     }
     updateContent(parameters, callback) {
-        return (0, tslib_1.__awaiter)(this, void 0, void 0, function* () {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
             const config = {
                 url: `/api/content/${parameters.id}`,
                 method: 'PUT',
@@ -128,11 +128,11 @@ class Content {
                     body: parameters.body,
                 },
             };
-            return this.client.sendRequest(config, callback, { methodName: 'updateContent' });
+            return this.client.sendRequest(config, callback);
         });
     }
     deleteContent(parameters, callback) {
-        return (0, tslib_1.__awaiter)(this, void 0, void 0, function* () {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
             const config = {
                 url: `/api/content/${parameters.id}`,
                 method: 'DELETE',
@@ -140,11 +140,11 @@ class Content {
                     status: parameters.status,
                 },
             };
-            return this.client.sendRequest(config, callback, { methodName: 'deleteContent' });
+            return this.client.sendRequest(config, callback);
         });
     }
     getHistoryForContent(parameters, callback) {
-        return (0, tslib_1.__awaiter)(this, void 0, void 0, function* () {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
             const config = {
                 url: `/api/content/${parameters.id}/history`,
                 method: 'GET',
@@ -152,7 +152,7 @@ class Content {
                     expand: parameters.expand,
                 },
             };
-            return this.client.sendRequest(config, callback, { methodName: 'getHistoryForContent' });
+            return this.client.sendRequest(config, callback);
         });
     }
 }

package/out/api/contentAttachments.d.ts

@@ -1,7 +1,7 @@
 import * as Models from './models';
 import * as Parameters from './parameters';
-import { Client } from '../clients';
 import { Callback } from '../callback';
+import { Client } from '../clients';
 export declare class ContentAttachments {
     private client;
     constructor(client: Client);
@@ -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

@@ -7,7 +7,7 @@ class ContentAttachments {
         this.client = client;
     }
     getAttachments(parameters, callback) {
-        return (0, tslib_1.__awaiter)(this, void 0, void 0, function* () {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
             const config = {
                 url: `/api/content/${parameters.id}/child/attachment`,
                 method: 'GET',
@@ -19,11 +19,11 @@ class ContentAttachments {
                     expand: parameters.expand,
                 },
             };
-            return this.client.sendRequest(config, callback, { methodName: 'getAttachments' });
+            return this.client.sendRequest(config, callback);
         });
     }
     createAttachments(parameters, callback) {
-        return (0, tslib_1.__awaiter)(this, void 0, void 0, function* () {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
             const config = {
                 url: `/api/content/${parameters.id}/child/attachment`,
                 method: 'POST',
@@ -32,11 +32,11 @@ class ContentAttachments {
                 },
                 data: Object.assign(Object.assign({}, parameters), { id: undefined, status: undefined }),
             };
-            return this.client.sendRequest(config, callback, { methodName: 'createAttachments' });
+            return this.client.sendRequest(config, callback);
         });
     }
     createOrUpdateAttachments(parameters, callback) {
-        return (0, tslib_1.__awaiter)(this, void 0, void 0, function* () {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
             const config = {
                 url: `/api/content/${parameters.id}/child/attachment`,
                 method: 'PUT',
@@ -45,39 +45,40 @@ class ContentAttachments {
                 },
                 data: Object.assign(Object.assign({}, parameters), { id: undefined, status: undefined }),
             };
-            return this.client.sendRequest(config, callback, { methodName: 'createOrUpdateAttachments' });
+            return this.client.sendRequest(config, callback);
         });
     }
     updateAttachmentProperties(parameters, callback) {
-        return (0, tslib_1.__awaiter)(this, void 0, void 0, function* () {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
             const config = {
                 url: `/api/content/${parameters.id}/child/attachment/${parameters.attachmentId}`,
                 method: 'PUT',
                 data: parameters.body,
             };
-            return this.client.sendRequest(config, callback, { methodName: 'updateAttachmentProperties' });
+            return this.client.sendRequest(config, callback);
         });
     }
     updateAttachmentData(parameters, callback) {
-        return (0, tslib_1.__awaiter)(this, void 0, void 0, function* () {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
             const config = {
                 url: `/api/content/${parameters.id}/child/attachment/${parameters.attachmentId}/data`,
                 method: 'POST',
                 data: Object.assign(Object.assign({}, parameters), { id: undefined, attachmentId: undefined }),
             };
-            return this.client.sendRequest(config, callback, { methodName: 'updateAttachmentData' });
+            return this.client.sendRequest(config, callback);
         });
     }
     downloadAttachment(parameters, callback) {
-        return (0, tslib_1.__awaiter)(this, void 0, void 0, function* () {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
             const config = {
                 url: `/api/content/${parameters.id}/child/attachment/${parameters.attachmentId}/download`,
                 method: 'GET',
+                responseType: 'arraybuffer',
                 params: {
                     version: parameters.version,
                 },
             };
-            return this.client.sendRequest(config, callback, { methodName: 'downloadAttachment' });
+            return this.client.sendRequest(config, callback);
         });
     }
 }

package/out/api/contentBody.d.ts

@@ -1,7 +1,7 @@
 import * as Models from './models';
 import * as Parameters from './parameters';
-import { Client } from '../clients';
 import { Callback } from '../callback';
+import { Client } from '../clients';
 export declare class ContentBody {
     private client;
     constructor(client: Client);

package/out/api/contentBody.js

@@ -7,7 +7,7 @@ class ContentBody {
         this.client = client;
     }
     convertContentBody(parameters, callback) {
-        return (0, tslib_1.__awaiter)(this, void 0, void 0, function* () {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
             const config = {
                 url: `/api/contentbody/convert/${parameters.to}`,
                 method: 'POST',
@@ -21,7 +21,7 @@ class ContentBody {
                     representation: parameters.representation,
                 },
             };
-            return this.client.sendRequest(config, callback, { methodName: 'convertContentBody' });
+            return this.client.sendRequest(config, callback);
         });
     }
 }

package/out/api/contentChildrenAndDescendants.d.ts

@@ -1,7 +1,7 @@
 import * as Models from './models';
 import * as Parameters from './parameters';
-import { Client } from '../clients';
 import { Callback } from '../callback';
+import { Client } from '../clients';
 export declare class ContentChildrenAndDescendants {
     private client;
     constructor(client: Client);
@@ -188,7 +188,7 @@ export declare class ContentChildrenAndDescendants {
      * of renaming page titles during the copy; for example, search and replace can be used in conjunction to rewrite the
      * copied page titles.
      */
-    copyPageHierarchy<T = unknown>(parameters: Parameters.CopyPageHierarchy, callback: Callback<T>): Promise<void>;
+    copyPageHierarchy<T = Models.LongTask>(parameters: Parameters.CopyPageHierarchy, callback: Callback<T>): Promise<void>;
     /**
      * Copy page hierarchy allows the copying of an entire hierarchy of pages and their associated properties, permissions
      * and attachments. The id path parameter refers to the content id of the page to copy, and the new parent of this
@@ -196,7 +196,7 @@ export declare class ContentChildrenAndDescendants {
      * of renaming page titles during the copy; for example, search and replace can be used in conjunction to rewrite the
      * copied page titles.
      */
-    copyPageHierarchy<T = unknown>(parameters: Parameters.CopyPageHierarchy, callback?: never): Promise<T>;
+    copyPageHierarchy<T = Models.LongTask>(parameters: Parameters.CopyPageHierarchy, callback?: never): Promise<T>;
     /**
      * Copies a single page and its associated properties, permissions, attachments, and custom contents. The `id` path
      * parameter refers to the content ID of the page to copy. The target of the page to be copied is defined using the