docs: Update docs. Change E2E auth method to test warning

Author: javierbrea

components/confluence-sync/CHANGELOG.md

@@ -11,12 +11,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 #### Deprecated
 #### Removed
 
-## Unreleased
+## [2.1.0] - 2025-10-17
 
 ### Added
 
 * feat: Add authentication options (OAuth2, Basic, JWT). Deprecate personalAccessToken.
 
+### Changed
+
+* chore: Update confluence.js to 2.1.0
+
 ## [2.0.2] - 2025-07-11
 
 ### Fixed

components/confluence-sync/README.md

@@ -44,7 +44,7 @@ This library requires:
 
 * A Confluence instance.
 * The id of the Confluence space where the pages will be created.
-* A personal access token to authenticate. You can create a personal access token following the instructions in the [Atlassian documentation](https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/).
+* Valid authentication credentials to access the Confluence instance. It uses the `confluence.js` library internally, so it supports the [same authentication methods](https://github.com/MrRefactoring/confluence.js?tab=readme-ov-file#authentication) as it.
 
 ### Compatibility
 
@@ -68,7 +68,11 @@ import { ConfluenceSyncPages } from '@telefonica/confluence-sync';
 
 const confluenceSyncPages = new ConfluenceSyncPages({
   url: "https://your.confluence.com",
-  personalAccessToken: "*******",
+  authentication: {
+    oauth2: {
+      accessToken: "your-oauth2-access-token"
+    }
+  },
   spaceId: "your-space-id",
   rootPageId: "12345678"
   logLevel: "debug",
@@ -191,7 +195,11 @@ import { ConfluenceSyncPages, SyncModes } from '@telefonica/confluence-sync';
 
 const confluenceSyncPages = new ConfluenceSyncPages({
   url: "https://my.confluence.es",
-  personalAccessToken: "*******",
+  authentication: {
+    oauth2: {
+      accessToken: "my-oauth2-access-token"
+    }
+  },
   spaceId: "MY-SPACE",
   logLevel: "debug",
   dryRun: false,
@@ -214,7 +222,17 @@ await confluenceSyncPages.sync([
 The main class of the library. It receives a configuration object with the following properties:
 
 * `url`: URL of the Confluence instance.
-* `personalAccessToken`: Personal access token to authenticate in Confluence.
+* `personalAccessToken`: Personal access token to authenticate in Confluence. To be DEPRECATED in future versions. Use the `authentication` property instead.
+* `authentication`: Authentication options to access Confluence. It supports the following methods:
+  * `oauth2`: OAuth2 authentication. It requires:
+    * `accessToken`: Access token to authenticate.
+  * `basic`: Basic authentication.
+    * `email`: Email of the user.
+    * `apiToken`: API token to authenticate.
+  * `jwt`: JWT authentication.
+    * `issuer`: Issuer of the JWT.
+    * `secret`: Secret to sign the JWT.
+    * `expiryTimeSeconds`: Optional expiry time of the JWT in seconds.
 * `spaceId`: Key of the space where the pages will be created.
 * `rootPageId`: ID of the root page under the pages will be created. It only can be missing if the sync mode is `flat` and all the pages provided have an id.
 * `logLevel`: One of `silly`, `debug`, `info`, `warn`, `error` or `silent`. Default is `silent`.

components/confluence-sync/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@telefonica/confluence-sync",
   "description": "Creates/updates/deletes Confluence pages based on a list of objects containing the page contents. Supports nested pages and attachments upload",
-  "version": "2.0.2",
+  "version": "2.1.0",
   "license": "Apache-2.0",
   "author": "Telefónica Innovación Digital",
   "repository": {

components/markdown-confluence-sync/CHANGELOG.md

@@ -11,6 +11,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 #### Deprecated
 #### Removed
 
+## [2.2.0] - 2025-10-17
+
+### Added
+
+* feat: Update confluence-sync to 2.1.0. Add authentication options (OAuth2, Basic, JWT). Deprecate personalAccessToken.
+* feat: Add warning when using the deprecated personalAccessToken option.
+
 ## [2.1.1] - 2025-07-11
 
 ### Fixed

components/markdown-confluence-sync/README.md

@@ -58,8 +58,8 @@ In order to be able to sync the markdown files with Confluence, you need to have
 
 * A [Confluence](https://www.atlassian.com/es/software/confluence) instance.
 * The id of the Confluence space where the pages will be created.
-* A personal access token to authenticate. You can create a personal access token following the instructions in the [Atlassian documentation](https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/).
 * Markdown file or files to be synced with Confluence. It can be as complex as a Docusaurus project docs folder, or as simple as a single README.md file.
+* Valid authentication credentials to access the Confluence instance. It uses the `confluence.js` library internally, so it supports the [same authentication methods](https://github.com/MrRefactoring/confluence.js?tab=readme-ov-file#authentication) as it.
 
 ### Compatibility
 
@@ -144,7 +144,11 @@ module.exports = {
   docsDir: "docs",
   confluence: {
     url: "https://my-confluence.es",
-    personalAccessToken: "*******",
+    authentication: {
+      oauth2: {
+        accessToken: "*******"
+      }
+    },
     spaceKey: "MY-SPACE",
     rootPageId: "my-root-page-id"
   }
@@ -254,7 +258,11 @@ module.exports = {
   filesPattern: "check*.{md,mdx}",
   confluence: {
     url: "https://my-confluence.es",
-    personalAccessToken: "*******",
+    authentication: {
+      oauth2: {
+        accessToken: "*******"
+      }
+    },
     spaceKey: "MY-SPACE",
     rootPageId: "my-root-page-id"
   }
@@ -276,7 +284,17 @@ The namespace for the configuration of this library is `markdown-confluence-sync
 | `filesMetadata` | `array` | Array of objects with the metadata of the files to sync. Each object must have the `path` property with the path of the file. For the rest of properties read the [Configuration per page](#configuration-per-page) section |  |
 | `docsDir` | `string` | Path to the docs directory. | `./docs` |
 | `confluence.url` | `string` | URL of the Confluence instance. | |
-| `confluence.personalAccessToken` | `string` | Personal access token to authenticate against the Confluence instance. | |
+| `confluence.personalAccessToken` | `string` | Deprecated. Personal access token to authenticate against the Confluence instance. | |
+| `confluence.authentication` | `object` | Object containing authentication options to access the Confluence instance. It supports the same methods [as the `confluence.js` library](https://github.com/MrRefactoring/confluence.js?tab=readme-ov-file#authentication). | |
+| `confluence.authentication.oauth2` | `object` | Object containing OAuth2 authentication options. | |
+| `confluence.authentication.oauth2.accessToken` | `string` | Access token for OAuth2 authentication. | |
+| `confluence.authentication.basic` | `object` | Object containing Basic authentication options. | |
+| `confluence.authentication.basic.email` | `string` | Email for Basic authentication. | |
+| `confluence.authentication.basic.apiToken` | `string` | ApiToken for Basic authentication. | |
+| `confluence.authentication.jwt` | `object` | Object containing JWT authentication options. | |
+| `confluence.authentication.jwt.issuer` | `string` | Issuer for JWT authentication. | |
+| `confluence.authentication.jwt.secret` | `string` | Secret for JWT authentication. | |
+| `confluence.authentication.jwt.expiryTimeSeconds` | `number` | Optional expiry time in seconds for JWT authentication. | |
 | `confluence.spaceKey` | `string` | Key of the Confluence space where the pages will be synced. | |
 | `confluence.rootPageId` | `string` | Id of the Confluence parent page where the pages will be synced. | |
 | `confluence.rootPageName` | `string` | Customize Confluence page titles by adding a prefix to all of them for improved organization and clarity | |
@@ -312,7 +330,12 @@ module.exports = {
   ignore: ["docs/no-sync/**"],
   confluence: {
     url: "https://my-confluence.es",
-    personalAccessToken: "*******",
+    authentication: {
+      basic: {
+        email: "<your-email>",
+        apiToken: "<your-api-token>"
+      }
+    },
     spaceKey: "MY-SPACE",
     rootPageId: "my-root-page-id"
   }
@@ -389,7 +412,13 @@ module.exports = {
   ],
   confluence: {
     url: "https://my.confluence.es",
-    personalAccessToken: "*******",
+    authentication: {
+      jwt: {
+        issuer: "my-issuer",
+        secret: "my-secret",
+        expiryTimeSeconds: 300,
+      },
+    },
     spaceKey: "MY-SPACE",
   },
 };
@@ -512,7 +541,12 @@ const markdownConfluenceSync = new MarkdownConfluenceSync({
   docsDir: path.resolve(__dirname, "..", "docs");
   confluence: {
     url: "https://my.confluence.es",
-    personalAccessToken: "*******",
+    authentication: {
+      basic: {
+        email: "<your-email>",
+        apiToken: "<your-api-token>"
+      }
+    },
     spaceKey: "MY-SPACE",
     rootPageId: "my-root-page-id"
   },

components/markdown-confluence-sync/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@telefonica/markdown-confluence-sync",
   "description": "Creates/updates/deletes Confluence pages based on markdown files in a directory. Supports Mermaid diagrams and per-page configuration using frontmatter metadata. Works great with Docusaurus",
-  "version": "2.1.1",
+  "version": "2.2.0",
   "license": "Apache-2.0",
   "author": "Telefónica Innovación Digital",
   "repository": {

components/markdown-confluence-sync/src/lib/confluence/ConfluenceSync.ts

@@ -177,6 +177,12 @@ export const ConfluenceSync: ConfluenceSyncConstructor = class ConfluenceSync
         );
       }
 
+      if (this._personalAccessTokenOption.value) {
+        this._logger.warn(
+          "The 'personalAccessToken' option is deprecated and will be removed in future versions. Please use the 'authentication' option instead.",
+        );
+      }
+
       this._confluencePageTransformer = new ConfluencePageTransformer({
         noticeMessage: this._noticeMessageOption.value,
         noticeTemplate: this._noticeTemplateOption.value,

components/markdown-confluence-sync/test/unit/specs/confluence/ConfluenceSync.test.ts

@@ -109,23 +109,6 @@ describe("confluenceSync", () => {
       );
     });
 
-    it("should fail if the personalAccessToken option is not defined", async () => {
-      // Arrange
-      const confluenceSync = new ConfluenceSync(confluenceSyncOptions);
-      await config.load({
-        ...CONFIG,
-        confluence: {
-          url: "foo",
-        },
-      });
-
-      // Act
-      // Assert
-      await expect(async () => await confluenceSync.sync([])).rejects.toThrow(
-        "Confluence personal access token is required. Please set confluence.personalAccessToken option.",
-      );
-    });
-
     it("should fail if the spaceKey option is not defined", async () => {
       // Arrange
       const confluenceSync = new ConfluenceSync(confluenceSyncOptions);