confluence.js 1.3.1 → 1.4.0

package/out/services/authenticationService/authentications/index.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
-(0, tslib_1.__exportStar)(require("./createBasicAuthenticationToken"), exports);
-(0, tslib_1.__exportStar)(require("./createJWTAuthentication"), exports);
-(0, tslib_1.__exportStar)(require("./createOAuth2AuthenticationToken"), exports);
+tslib_1.__exportStar(require("./createBasicAuthenticationToken"), exports);
+tslib_1.__exportStar(require("./createJWTAuthentication"), exports);
+tslib_1.__exportStar(require("./createOAuth2AuthenticationToken"), exports);
+tslib_1.__exportStar(require("./createPATAuthenticationToken"), exports);

package/out/services/authenticationService/index.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
-(0, tslib_1.__exportStar)(require("./authenticationService"), exports);
+tslib_1.__exportStar(require("./authenticationService"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "confluence.js",
-  "version": "1.3.1",
+  "version": "1.4.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,16 +12,21 @@
     "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 --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",
     "lint": "eslint src --ext .ts",
-    "lint:fix": "npm run lint -- --fix"
+    "lint:fix": "npm run lint -- --fix",
+    "test:unit": "ava --timeout=2m tests/unit",
+    "test:e2e": "ava --timeout=2m --fail-fast --no-worker-threads -c 1 -s tests/e2e/**/*.test.ts"
   },
-  "jest": {
-    "preset": "ts-jest",
-    "testEnvironment": "node"
+  "ava": {
+    "extensions": [
+      "ts"
+    ],
+    "require": [
+      "ts-node/register",
+      "dotenv/config"
+    ]
   },
   "keywords": [
     "confluence",
@@ -34,29 +39,28 @@
   ],
   "devDependencies": {
     "@types/express": "^4.17.13",
-    "@types/jest": "^27.0.3",
     "@types/oauth": "^0.9.1",
-    "@types/sinon": "^10.0.6",
-    "@typescript-eslint/eslint-plugin": "^5.6.0",
-    "@typescript-eslint/parser": "^5.6.0",
-    "dotenv": "^10.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.4.4",
-    "prettier": "^2.5.1",
-    "prettier-plugin-jsdoc": "^0.3.30",
-    "sinon": "^12.0.1",
-    "ts-jest": "^27.1.1",
-    "typedoc": "^0.22.10",
-    "typedoc-plugin-extras": "^2.2.1",
-    "typescript": "^4.5.3"
+    "@types/sinon": "^10.0.11",
+    "@typescript-eslint/eslint-plugin": "^5.17.0",
+    "@typescript-eslint/parser": "^5.17.0",
+    "ava": "^4.1.0",
+    "dotenv": "^16.0.0",
+    "eslint": "^8.12.0",
+    "eslint-config-airbnb": "^19.0.4",
+    "eslint-config-airbnb-typescript": "^16.2.0",
+    "eslint-import-resolver-typescript": "^2.7.0",
+    "eslint-plugin-import": "^2.25.4",
+    "prettier": "^2.6.1",
+    "prettier-plugin-jsdoc": "^0.3.36",
+    "sinon": "^13.0.1",
+    "ts-node": "^10.7.0",
+    "typedoc": "^0.22.13",
+    "typedoc-plugin-extras": "^2.2.3",
+    "typescript": "^4.6.3"
   },
   "dependencies": {
     "atlassian-jwt": "^2.0.2",
-    "axios": "^0.24.0",
+    "axios": "^0.26.1",
     "oauth": "^0.9.15",
     "tslib": "^2.3.1"
   }

package/src/api/analytics.ts

@@ -0,0 +1,44 @@
+import * as Models from './models';
+import * as Parameters from './parameters';
+import { Callback } from '../callback';
+import { Client } from '../clients';
+import { RequestConfig } from '../requestConfig';
+
+export class Analytics {
+  constructor(private client: Client) {}
+
+  /** Get the total number of views a piece of content has. */
+  async getViews<T = Models.GetViews>(parameters: Parameters.GetViews, callback: Callback<T>): Promise<void>;
+  /** Get the total number of views a piece of content has. */
+  async getViews<T = Models.GetViews>(parameters: Parameters.GetViews, callback?: never): Promise<T>;
+  async getViews<T = Models.GetViews>(parameters: Parameters.GetViews, callback?: Callback<T>): Promise<void | T> {
+    const config: RequestConfig = {
+      url: `/api/analytics/content/${parameters.contentId}/views`,
+      method: 'GET',
+      params: {
+        fromDate: parameters.fromDate,
+      },
+    };
+
+    return this.client.sendRequest(config, callback);
+  }
+
+  /** Get the total number of distinct viewers a piece of content has. */
+  async getViewers<T = Models.GetViewers>(parameters: Parameters.GetViewers, callback: Callback<T>): Promise<void>;
+  /** Get the total number of distinct viewers a piece of content has. */
+  async getViewers<T = Models.GetViewers>(parameters: Parameters.GetViewers, callback?: never): Promise<T>;
+  async getViewers<T = Models.GetViewers>(
+    parameters: Parameters.GetViewers,
+    callback?: Callback<T>,
+  ): Promise<void | T> {
+    const config: RequestConfig = {
+      url: `/api/analytics/content/${parameters.contentId}/viewers`,
+      method: 'GET',
+      params: {
+        fromDate: parameters.fromDate,
+      },
+    };
+
+    return this.client.sendRequest(config, callback);
+  }
+}

package/src/api/audit.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';
 import { RequestConfig } from '../requestConfig';
 
 export class Audit {

package/src/api/content.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';
 import { RequestConfig } from '../requestConfig';
 
 export class Content {

package/src/api/contentAttachments.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';
 import { RequestConfig } from '../requestConfig';
 
 export class ContentAttachments {

package/src/api/contentBody.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';
 import { RequestConfig } from '../requestConfig';
 
 export class ContentBody {

package/src/api/contentChildrenAndDescendants.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';
 import { RequestConfig } from '../requestConfig';
 
 export class ContentChildrenAndDescendants {
@@ -302,7 +302,10 @@ export 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.
    */
-  async copyPageHierarchy<T = unknown>(parameters: Parameters.CopyPageHierarchy, callback: Callback<T>): Promise<void>;
+  async 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
@@ -310,8 +313,8 @@ export 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.
    */
-  async copyPageHierarchy<T = unknown>(parameters: Parameters.CopyPageHierarchy, callback?: never): Promise<T>;
-  async copyPageHierarchy<T = unknown>(
+  async copyPageHierarchy<T = Models.LongTask>(parameters: Parameters.CopyPageHierarchy, callback?: never): Promise<T>;
+  async copyPageHierarchy<T = Models.LongTask>(
     parameters: Parameters.CopyPageHierarchy,
     callback?: Callback<T>,
   ): Promise<void | T> {
@@ -324,6 +327,7 @@ export class ContentChildrenAndDescendants {
         copyProperties: parameters.copyProperties,
         copyLabels: parameters.copyLabels,
         copyCustomContents: parameters.copyCustomContents,
+        copyDescendants: parameters.copyDescendants,
         destinationPageId: parameters.destinationPageId,
         titleOptions: parameters.titleOptions,
       },

package/src/api/contentComments.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';
 import { RequestConfig } from '../requestConfig';
 
 export class ContentComments {

package/src/api/contentContentState.ts

@@ -0,0 +1,157 @@
+import * as Models from './models';
+import * as Parameters from './parameters';
+import { Callback } from '../callback';
+import { Client } from '../clients';
+import { RequestConfig } from '../requestConfig';
+
+export class ContentContentState {
+  constructor(private client: Client) {}
+
+  /**
+   * Gets the current page status of the draft or published version of content. To specify the draft version, set the
+   * parameter status to PUBLISHED, otherwise DRAFT.
+   */
+  async getContentState<T = Models.ContentStateContainer>(
+    parameters: Parameters.GetContentState,
+    callback: Callback<T>
+  ): Promise<void>;
+  /**
+   * Gets the current page status of the draft or published version of content. To specify the draft version, set the
+   * parameter status to PUBLISHED, otherwise DRAFT.
+   */
+  async getContentState<T = Models.ContentStateContainer>(
+    parameters: Parameters.GetContentState,
+    callback?: never
+  ): Promise<T>;
+  async getContentState<T = Models.ContentStateContainer>(
+    parameters: Parameters.GetContentState,
+    callback?: Callback<T>,
+  ): Promise<void | T> {
+    const config: RequestConfig = {
+      url: `/api/content/${parameters.contentId}/state`,
+      method: 'GET',
+      params: {
+        designation: parameters.designation,
+      },
+    };
+
+    return this.client.sendRequest(config, callback);
+  }
+
+  /**
+   * Sets the content state of the content specified and creates a new version (publishes the content without changing
+   * the body) of the content with the new status. The desired type of status must be allowed. There are space suggested
+   * statuses and custom statuses. To specify the desired new status, one can use the id of the status or the name and
+   * color of the status. If contentStateId is defined, then name and color are ignored. If contentStateId is not
+   * defined, name and color will be used if provided. Firstly, we will determine if a status of this name and color
+   * exists, and if it does, that this status is used. If it does not exist, and custom statuses are allowed, a custom
+   * status with this name and color will be created. Color can be specified in traditional english colors (teal,
+   * magenta, lavender, etc.) or as a hex string ex: #0ff0Fd.
+   */
+  async setContentState<T = Models.ContentStateContainer>(
+    parameters: Parameters.SetContentState,
+    callback: Callback<T>
+  ): Promise<void>;
+  /**
+   * Sets the content state of the content specified and creates a new version (publishes the content without changing
+   * the body) of the content with the new status. The desired type of status must be allowed. There are space suggested
+   * statuses and custom statuses. To specify the desired new status, one can use the id of the status or the name and
+   * color of the status. If contentStateId is defined, then name and color are ignored. If contentStateId is not
+   * defined, name and color will be used if provided. Firstly, we will determine if a status of this name and color
+   * exists, and if it does, that this status is used. If it does not exist, and custom statuses are allowed, a custom
+   * status with this name and color will be created. Color can be specified in traditional english colors (teal,
+   * magenta, lavender, etc.) or as a hex string ex: #0ff0Fd.
+   */
+  async setContentState<T = Models.ContentStateContainer>(
+    parameters: Parameters.SetContentState,
+    callback?: never
+  ): Promise<T>;
+  async setContentState<T = Models.ContentStateContainer>(
+    parameters: Parameters.SetContentState,
+    callback?: Callback<T>,
+  ): Promise<void | T> {
+    const config: RequestConfig = {
+      url: `/api/content/${parameters.contentId}/state`,
+      method: 'PUT',
+      params: {
+        contentStateId: parameters.contentStateId,
+        name: parameters.name,
+        color: parameters.color,
+      },
+    };
+
+    return this.client.sendRequest(config, callback);
+  }
+
+  /**
+   * Removes the content state of the content specified and creates a new version (publishes the content without
+   * changing the body) of the content with the new status.
+   */
+  async removeContentState<T = Models.ContentStateContainer>(
+    parameters: Parameters.RemoveContentState,
+    callback: Callback<T>
+  ): Promise<void>;
+  /**
+   * Removes the content state of the content specified and creates a new version (publishes the content without
+   * changing the body) of the content with the new status.
+   */
+  async removeContentState<T = Models.ContentStateContainer>(
+    parameters: Parameters.RemoveContentState,
+    callback?: never
+  ): Promise<T>;
+  async removeContentState<T = Models.ContentStateContainer>(
+    parameters: Parameters.RemoveContentState,
+    callback?: Callback<T>,
+  ): Promise<void | T> {
+    const config: RequestConfig = {
+      url: `/api/content/${parameters.contentId}/state`,
+      method: 'DELETE',
+    };
+
+    return this.client.sendRequest(config, callback);
+  }
+
+  /** Gets a Global Timestamp of the last time the content state was updated */
+  async getContentStateLastUpdated<T = unknown>(
+    parameters: Parameters.GetContentStateLastUpdated,
+    callback: Callback<T>
+  ): Promise<void>;
+  /** Gets a Global Timestamp of the last time the content state was updated */
+  async getContentStateLastUpdated<T = unknown>(
+    parameters: Parameters.GetContentStateLastUpdated,
+    callback?: never
+  ): Promise<T>;
+  async getContentStateLastUpdated<T = unknown>(
+    parameters: Parameters.GetContentStateLastUpdated,
+    callback?: Callback<T>,
+  ): Promise<void | T> {
+    const config: RequestConfig = {
+      url: `/api/content/${parameters.contentId}/state/last-updated`,
+      method: 'GET',
+    };
+
+    return this.client.sendRequest(config, callback);
+  }
+
+  /** Gets content states that are available for the content to be set as. */
+  async getAvailableContentStates<T = Models.AvailableContentStates>(
+    parameters: Parameters.GetAvailableContentStates,
+    callback: Callback<T>
+  ): Promise<void>;
+  /** Gets content states that are available for the content to be set as. */
+  async getAvailableContentStates<T = Models.AvailableContentStates>(
+    parameters: Parameters.GetAvailableContentStates,
+    callback?: never
+  ): Promise<T>;
+  async getAvailableContentStates<T = Models.AvailableContentStates>(
+    parameters: Parameters.GetAvailableContentStates,
+    callback?: Callback<T>,
+  ): Promise<void | T> {
+    const config: RequestConfig = {
+      url: `/api/content/${parameters.contentId}/state/available-states`,
+      method: 'GET',
+    };
+
+    return this.client.sendRequest(config, callback);
+  }
+}

package/src/api/contentLabels.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';
 import { RequestConfig } from '../requestConfig';
 
 export class ContentLabels {

package/src/api/contentMacroBody.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';
 import { RequestConfig } from '../requestConfig';
 
 export class ContentMacroBody {

package/src/api/contentPermissions.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';
 import { RequestConfig } from '../requestConfig';
 
 export class ContentPermissions {

package/src/api/contentProperties.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';
 import { RequestConfig } from '../requestConfig';
 
 export class ContentProperties {

package/src/api/contentRestrictions.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';
 import { RequestConfig } from '../requestConfig';
 
 export class ContentRestrictions {

package/src/api/contentVersions.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';
 import { RequestConfig } from '../requestConfig';
 
 export class ContentVersions {

package/src/api/contentWatches.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';
 import { RequestConfig } from '../requestConfig';
 
 export class ContentWatches {

package/src/api/dynamicModules.ts

@@ -1,6 +1,6 @@
 import * as Parameters from './parameters';
-import { Client } from '../clients';
 import { Callback } from '../callback';
+import { Client } from '../clients';
 import { RequestConfig } from '../requestConfig';
 
 export class DynamicModules {