1.4.1 RC (#22)

* telemetry data removed from endpoints

* #14 bugfix

* deps update and lint fixes

* 1.4.0

* Update CHANGELOG.md

* changlog fixed

* docs fixes

* 1.4.1 dependencies updated

.npmignore

@@ -5,7 +5,7 @@ tests/
 
 .editorconfig
 .eslintrc
-tsconfig.tests.json
+tsconfig.lint.json
 .DS_Store
 .env
 .env.example

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+### 1.4.1
+
+- Dependencies updated.
+
+### 1.4.0
+
 - Analytics API added.
 - ContentContentState API added.
 - `deletePageTree` method added to `Experimental`.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "confluence.js",
-  "version": "1.4.0",
+  "version": "1.4.1",
   "description": "confluence.js is a powerful Node.JS/Browser module that allows you to interact with the Confluence API very easily",
   "author": "Vladislav Tupikin <[email protected]>",
   "license": "MIT",
@@ -16,17 +16,20 @@
     "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",
-    "test:unit": "ava --timeout=2m tests/unit",
+    "test:unit": "ava tests/unit",
     "test:e2e": "ava --timeout=2m --fail-fast --no-worker-threads -c 1 -s tests/e2e/**/*.test.ts"
   },
   "ava": {
     "extensions": [
       "ts"
     ],
     "require": [
-      "ts-node/register",
+      "@swc-node/register",
       "dotenv/config"
-    ]
+    ],
+    "environmentVariables": {
+      "SWC_NODE_PROJECT": "./tsconfig.lint.json"
+    }
   },
   "keywords": [
     "confluence",
@@ -38,30 +41,30 @@
     "atlassian"
   ],
   "devDependencies": {
+    "@swc-node/register": "^1.4.2",
     "@types/express": "^4.17.13",
     "@types/oauth": "^0.9.1",
     "@types/sinon": "^10.0.11",
-    "@typescript-eslint/eslint-plugin": "^5.17.0",
-    "@typescript-eslint/parser": "^5.17.0",
-    "ava": "^4.1.0",
+    "@typescript-eslint/eslint-plugin": "^5.21.0",
+    "@typescript-eslint/parser": "^5.21.0",
+    "ava": "^4.2.0",
     "dotenv": "^16.0.0",
-    "eslint": "^8.12.0",
+    "eslint": "^8.14.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",
+    "eslint-config-airbnb-typescript": "^17.0.0",
+    "eslint-import-resolver-typescript": "^2.7.1",
+    "eslint-plugin-import": "^2.26.0",
+    "prettier": "^2.6.2",
+    "prettier-plugin-jsdoc": "^0.3.38",
+    "sinon": "^13.0.2",
+    "typedoc": "^0.22.15",
     "typedoc-plugin-extras": "^2.2.3",
     "typescript": "^4.6.3"
   },
   "dependencies": {
     "atlassian-jwt": "^2.0.2",
-    "axios": "^0.26.1",
+    "axios": "^0.27.0",
     "oauth": "^0.9.15",
-    "tslib": "^2.3.1"
+    "tslib": "^2.4.0"
   }
 }

src/api/content.ts

@@ -113,7 +113,7 @@ export class Content {
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Archive' permission for each of the pages
    * in the corresponding space it belongs to.
    */
-  async archivePages<T = unknown>(
+  async archivePages<T = Models.LongTask>(
     parameters: Parameters.ArchivePages,
     callback: Callback<T>
   ): Promise<void>;
@@ -128,8 +128,8 @@ export class Content {
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Archive' permission for each of the pages
    * in the corresponding space it belongs to.
    */
-  async archivePages<T = unknown>(parameters: Parameters.ArchivePages, callback?: never): Promise<T>;
-  async archivePages<T = unknown>(parameters: Parameters.ArchivePages, callback?: Callback<T>): Promise<void | T> {
+  async archivePages<T = Models.LongTask>(parameters: Parameters.ArchivePages, callback?: never): Promise<T>;
+  async archivePages<T = Models.LongTask>(parameters: Parameters.ArchivePages, callback?: Callback<T>): Promise<void | T> {
     const config: RequestConfig = {
       url: '/api/content/archive',
       method: 'POST',
@@ -377,7 +377,7 @@ export class Content {
    * - If the content's type is `comment` or `attachment`, it will be deleted permanently without being trashed.
    *
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Delete' permission for the space that the
-   * content is in, and permission to edit the content.
+   * content is in.
    */
   async deleteContent<T = void>(parameters: Parameters.DeleteContent, callback: Callback<T>): Promise<void>;
   /**
@@ -389,7 +389,7 @@ export class Content {
    * - If the content's type is `comment` or `attachment`, it will be deleted permanently without being trashed.
    *
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Delete' permission for the space that the
-   * content is in, and permission to edit the content.
+   * content is in.
    */
   async deleteContent<T = void>(parameters: Parameters.DeleteContent, callback?: never): Promise<T>;
   async deleteContent<T = void>(parameters: Parameters.DeleteContent, callback?: Callback<T>): Promise<void | T> {

src/api/models/index.ts

@@ -8,6 +8,7 @@ export * from './attachmentUpdate';
 export * from './auditRecord';
 export * from './auditRecordArray';
 export * from './auditRecordCreate';
+export * from './appDescriptor';
 export * from './blueprintTemplate';
 export * from './blueprintTemplateArray';
 export * from './breadcrumb';
@@ -85,6 +86,7 @@ export * from './labeledContentPageResponse';
 export * from './contentStateSettings';
 export * from './labeledContentType';
 export * from './longTask';
+export * from './contentState';
 export * from './userPropertyCreate';
 export * from './userPropertyUpdate';
 export * from './contentStateContainer';
@@ -100,6 +102,7 @@ export * from './lookAndFeelSettings';
 export * from './lookAndFeelUpdated';
 export * from './macroInstance';
 export * from './menusLookAndFeel';
+export * from './lifecycle';
 export * from './message';
 export * from './migratedUser';
 export * from './migratedUserArray';

src/index.ts

@@ -2,8 +2,12 @@ export * from './clients';
 export * from './config';
 export * from './requestConfig';
 export * from './callback';
+export * from './pagination';
+export * from './utilityTypes';
 
 export * as Api from './api';
 export * as Server from './server';
 export * as Models from './api/models';
 export * as Parameters from './api/parameters';
+export * as ServerModels from './server/models';
+export * as ServerParameters from './server/parameters';

src/utilityTypes.ts

@@ -1,6 +1,6 @@
 export namespace UtilityTypes {
   /** Mark some properties which only the former including as optional and set the value to never */
-  type Without<T, U> = { [P in Exclude<keyof T, keyof U>]?: never };
+  export type Without<T, U> = { [P in Exclude<keyof T, keyof U>]?: never };
 
   /** get the XOR type which could make 2 types exclude each other */
   export type XOR<T, U> = T | U extends object ? (Without<T, U> & U) | (Without<U, T> & T) : T | U;

tsconfig.json

@@ -4,6 +4,7 @@
     "module": "CommonJS",
     "outDir": "out",
     "strict": true,
+    "sourceMap": true,
     "declaration": true,
     "importHelpers": true,
     "forceConsistentCasingInFileNames": true

tsconfig.lint.json

@@ -3,5 +3,6 @@
   "include": [
     "src",
     "tests"
-  ]
+  ],
+  "exclude": []
 }