chore: Merge

javierbrea · javierbrea · commit 144d4edb0a17 · 2025-11-24T10:50:21.000+01:00
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -64,11 +64,19 @@ pnpm nx test:unit child-process-manager
 To run a task in all components, use the following syntax: `pnpm nx run-many <task> --all`. For example, to run the unit tests in all components, use the following command:
 
 ```bash
-pnpm nx run-many test:unit --all
+pnpm nx run-many -t test:unit --all
 ```
 
 This will run the `test:unit` task in all components and also the corresponding dependencies, in the right order, so everything is built and tested correctly.
 
+## Running all checks in all components
+
+To run all checks in all components, use the following command:
+
+```bash
+pnpm check:all
+```
+
 # Branching model
 
 Here you have an schema of the branching model used in this repository:
diff --git a/components/confluence-sync/CHANGELOG.md b/components/confluence-sync/CHANGELOG.md
@@ -11,6 +11,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 #### Deprecated
 #### Removed
 
+## [2.2.0] - 2025-11-24
+
+### Added
+
+* feat: Add apiPrefix option to configure the Confluence API prefix (default: /rest/).
+
 ## [2.1.0] - 2025-10-17
 
 ### Added
diff --git a/components/confluence-sync/README.md b/components/confluence-sync/README.md
@@ -222,6 +222,7 @@ await confluenceSyncPages.sync([
 The main class of the library. It receives a configuration object with the following properties:
 
 * `url`: URL of the Confluence instance.
+* `apiPrefix`: Optional prefix for the Confluence API urls. Default is `/rest/`.
 * `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:
diff --git a/components/confluence-sync/package.json b/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.1.0",
+  "version": "2.2.0",
   "license": "Apache-2.0",
   "author": "Telefónica Innovación Digital",
   "repository": {
diff --git a/components/confluence-sync/src/ConfluenceSyncPages.ts b/components/confluence-sync/src/ConfluenceSyncPages.ts
@@ -59,6 +59,7 @@ export const ConfluenceSyncPages: ConfluenceSyncPagesConstructor = class Conflue
     dryRun,
     syncMode,
     rootPageId,
+    apiPrefix,
   }: ConfluenceSyncPagesConfig) {
     this._logger = new Logger(LOGGER_NAMESPACE, {
       level: logLevel ?? DEFAULT_LOG_LEVEL,
@@ -70,6 +71,7 @@ export const ConfluenceSyncPages: ConfluenceSyncPagesConstructor = class Conflue
       authentication,
       logger: this._logger.namespace("confluence"),
       dryRun,
+      apiPrefix,
     });
     this._syncMode = syncMode ?? SyncModes.TREE;
 
diff --git a/components/confluence-sync/src/ConfluenceSyncPages.types.ts b/components/confluence-sync/src/ConfluenceSyncPages.types.ts
@@ -68,6 +68,8 @@ export interface ConfluenceSyncPagesConfig {
   logLevel?: LogLevel;
   /** Dry run option */
   dryRun?: boolean;
+  /** API Prefix */
+  apiPrefix?: string;
   /** Sync mode */
   syncMode?: SyncModes;
 }
diff --git a/components/confluence-sync/src/confluence/CustomConfluenceClient.ts b/components/confluence-sync/src/confluence/CustomConfluenceClient.ts
@@ -114,10 +114,12 @@ export const CustomConfluenceClient: ConfluenceClientConstructor = class CustomC
           },
         };
 
+    const apiPrefix = config.apiPrefix ?? "/rest/";
+
     this._client = new ConfluenceClient({
       host: config.url,
       authentication,
-      apiPrefix: "/rest/",
+      apiPrefix,
     });
     this._logger = config.logger;
   }
diff --git a/components/confluence-sync/src/confluence/CustomConfluenceClient.types.ts b/components/confluence-sync/src/confluence/CustomConfluenceClient.types.ts
@@ -73,6 +73,8 @@ export interface ConfluenceClientConfig {
   authentication?: ConfluenceClientAuthenticationConfig;
   /** Confluence url */
   url: string;
+  /** API Prefix */
+  apiPrefix?: string;
   /** Confluence space id */
   spaceId: string;
   /** Logger */
diff --git a/components/confluence-sync/test/unit/specs/confluence/CustomConfluenceClient.test.ts b/components/confluence-sync/test/unit/specs/confluence/CustomConfluenceClient.test.ts
@@ -130,6 +130,35 @@ describe("customConfluenceClient class", () => {
           apiPrefix: "/rest/",
         });
       });
+
+      it("should set apiPrefix when provided", () => {
+        const configWithBoth = {
+          spaceId: "foo-space-id",
+          url: "foo-url",
+          personalAccessToken: "foo-token",
+          authentication: {
+            basic: {
+              email: "test@example.com",
+              apiToken: "basic-token",
+            },
+          },
+          logger,
+          apiPrefix: "/foo/",
+        };
+
+        new CustomConfluenceClient(configWithBoth);
+
+        expect(ConfluenceClientConstructor).toHaveBeenCalledWith({
+          host: "foo-url",
+          authentication: {
+            basic: {
+              email: "test@example.com",
+              apiToken: "basic-token",
+            },
+          },
+          apiPrefix: "/foo/",
+        });
+      });
     });
 
     describe("when using basic authentication", () => {
diff --git a/components/markdown-confluence-sync/CHANGELOG.md b/components/markdown-confluence-sync/CHANGELOG.md
@@ -11,14 +11,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 #### Deprecated
 #### Removed
 
+## Unreleased
+
+#### Added
+
 ## [2.3.0] - 2025-11-24
 
 #### Added
 
-* feat: Add code blocks transformation to Confluence code macro format.
+* feat(#65): Add code blocks transformation to Confluence code macro format.
   Code blocks are now converted to Confluence's structured code macro
   with syntax highlighting support. This feature is disabled by default
   and can be enabled via `rehype.codeBlocks` configuration option.
+* feat(#63): Add apiPrefix option to configure the Confluence API prefix (default: /rest/).
 
 ## [2.2.0] - 2025-10-17
 
diff --git a/components/markdown-confluence-sync/README.md b/components/markdown-confluence-sync/README.md
@@ -284,6 +284,7 @@ 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.apiPrefix` | `string` | Optional prefix for the Confluence API urls | `/rest/` |
 | `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. | |
diff --git a/components/markdown-confluence-sync/src/lib/confluence/ConfluenceSync.ts b/components/markdown-confluence-sync/src/lib/confluence/ConfluenceSync.ts
@@ -36,6 +36,8 @@ import type {
   AuthenticationOption,
   RehypeCodeBlocksOptionDefinition,
   RehypeCodeBlocksOption,
+  ApiPrefixOption,
+  ApiPrefixOptionDefinition,
 } from "./ConfluenceSync.types.js";
 import { ConfluencePageTransformer } from "./transformer/ConfluencePageTransformer.js";
 import type { ConfluencePageTransformerInterface } from "./transformer/ConfluencePageTransformer.types.js";
@@ -46,6 +48,12 @@ const urlOption: UrlOptionDefinition = {
   type: "string",
 };
 
+const apiPrefixOption: ApiPrefixOptionDefinition = {
+  name: "apiPrefix",
+  type: "string",
+  default: "/rest/",
+};
+
 const personalAccessTokenOption: PersonalAccessTokenOptionDefinition = {
   name: "personalAccessToken",
   type: "string",
@@ -99,6 +107,7 @@ export const ConfluenceSync: ConfluenceSyncConstructor = class ConfluenceSync
   private _confluencePageTransformer: ConfluencePageTransformerInterface;
   private _confluenceSyncPages: ConfluenceSyncPagesInterface;
   private _urlOption: UrlOption;
+  private _apiPrefixOption: ApiPrefixOption;
   private _personalAccessTokenOption: PersonalAccessTokenOption;
   private _spaceKeyOption: SpaceKeyOption;
   private _rootPageIdOption: RootPageIdOption;
@@ -114,6 +123,9 @@ export const ConfluenceSync: ConfluenceSyncConstructor = class ConfluenceSync
 
   constructor({ config, rehypeConfig, logger, mode }: ConfluenceSyncOptions) {
     this._urlOption = config.addOption(urlOption) as UrlOption;
+    this._apiPrefixOption = config.addOption(
+      apiPrefixOption,
+    ) as ApiPrefixOption;
     this._personalAccessTokenOption = config.addOption(
       personalAccessTokenOption,
     ) as PersonalAccessTokenOption;
@@ -146,6 +158,9 @@ export const ConfluenceSync: ConfluenceSyncConstructor = class ConfluenceSync
   public async sync(confluencePages: ConfluenceSyncPage[]): Promise<void> {
     await this._init();
     this._logger.debug(`confluence.url option is ${this._urlOption.value}`);
+    this._logger.debug(
+      `confluence.apiPrefix option is ${this._apiPrefixOption.value}`,
+    );
     this._logger.debug(
       `confluence.spaceKey option is ${this._spaceKeyOption.value}`,
     );
@@ -210,6 +225,7 @@ export const ConfluenceSync: ConfluenceSyncConstructor = class ConfluenceSync
 
       this._confluenceSyncPages = new ConfluenceSyncPages({
         url: this._urlOption.value,
+        apiPrefix: this._apiPrefixOption.value,
         personalAccessToken: this._personalAccessTokenOption.value,
         authentication: this._authenticationOption.value,
         spaceId: this._spaceKeyOption.value,
diff --git a/components/markdown-confluence-sync/src/lib/confluence/ConfluenceSync.types.ts b/components/markdown-confluence-sync/src/lib/confluence/ConfluenceSync.types.ts
@@ -15,6 +15,7 @@ import type {
 import type { ModeOption } from "../MarkdownConfluenceSync.types";
 
 type UrlOptionValue = string;
+type ApiPrefixOptionValue = string;
 type PersonalAccessTokenOptionValue = string;
 type SpaceKeyOptionValue = string;
 type RootPageIdOptionValue = string;
@@ -32,6 +33,8 @@ declare global {
       confluence?: {
         /** Confluence URL */
         url?: UrlOptionValue;
+        /** Optional prefix for the Confluence API urls. Default is `/rest/`. */
+        apiPrefix?: string;
         /**
          * Confluence personal access token
          * @deprecated Use authentication.oauth2.accessToken instead
@@ -61,6 +64,7 @@ declare global {
 }
 
 export type UrlOptionDefinition = OptionDefinition<UrlOptionValue>;
+export type ApiPrefixOptionDefinition = OptionDefinition<ApiPrefixOptionValue>;
 export type PersonalAccessTokenOptionDefinition =
   OptionDefinition<PersonalAccessTokenOptionValue>;
 export type SpaceKeyOptionDefinition = OptionDefinition<SpaceKeyOptionValue>;
@@ -85,6 +89,7 @@ export type AuthenticationOptionDefinition =
 export type AuthenticationOption =
   OptionInterfaceOfType<ConfluenceClientAuthenticationConfig>;
 export type UrlOption = OptionInterfaceOfType<UrlOptionValue>;
+export type ApiPrefixOption = OptionInterfaceOfType<ApiPrefixOptionValue>;
 export type PersonalAccessTokenOption =
   OptionInterfaceOfType<PersonalAccessTokenOptionValue>;
 export type SpaceKeyOption = OptionInterfaceOfType<SpaceKeyOptionValue>;
diff --git a/components/markdown-confluence-sync/test/component/specs/config.spec.ts b/components/markdown-confluence-sync/test/component/specs/config.spec.ts
@@ -97,6 +97,59 @@ describe("configuration", () => {
       expect(cleanLogs(logs)).toContain(`mode option is flat`);
     });
 
+    it("should set apiPrefix to default value when not provided", async () => {
+      cli = new ChildProcessManager(
+        [
+          getBinaryPathFromFixtureFolder(),
+          "--confluence.url=https://foo-confluence.com",
+          "--confluence.spaceKey=FOO",
+          "--mode=tree",
+          "--confluence.rootPageId=123456",
+          "--confluence.personalAccessToken=abcd1234",
+        ],
+        {
+          cwd: getFixtureFolder("basic"),
+          silent: true,
+        },
+      );
+      const { exitCode, logs } = await cli.run();
+
+      expect(exitCode).toBe(1);
+      expect(cleanLogs(logs)).toEqual(
+        expect.arrayContaining([
+          expect.stringContaining(`confluence.apiPrefix option is /rest/`),
+        ]),
+      );
+    });
+
+    it("should set apiPrefix to given value when provided", async () => {
+      cli = new ChildProcessManager(
+        [
+          getBinaryPathFromFixtureFolder(),
+          "--confluence.url=https://foo-confluence.com",
+          "--confluence.spaceKey=FOO",
+          "--mode=tree",
+          "--confluence.rootPageId=123456",
+          "--confluence.personalAccessToken=abcd1234",
+          "--confluence.apiPrefix=/custom-api/",
+        ],
+        {
+          cwd: getFixtureFolder("basic"),
+          silent: true,
+        },
+      );
+      const { exitCode, logs } = await cli.run();
+
+      expect(exitCode).toBe(1);
+      expect(cleanLogs(logs)).toEqual(
+        expect.arrayContaining([
+          expect.stringContaining(
+            `confluence.apiPrefix option is /custom-api/`,
+          ),
+        ]),
+      );
+    });
+
     it(`should fail and throw log error when mode isn't valid mode`, async () => {
       cli = new ChildProcessManager(
         [getBinaryPathFromFixtureFolder(), "--mode=foo"],
diff --git a/package.json b/package.json
@@ -11,6 +11,7 @@
     "lint": "eslint *.* --no-warn-ignored",
     "lint:staged": "lint-staged",
     "prepare": "husky install",
+    "check:all": "pnpm nx run-many -t check:all --all",
     "check:spell": "cspell *.* .husky/*.* .github/*.*"
   },
   "devDependencies": {

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@telefonica/confluence-sync",`
`3`	`3`	`"description": "Creates/updates/deletes Confluence pages based on a list of objects containing the page contents. Supports nested pages and attachments upload",`
`4`		`- "version": "2.1.0",`
	`4`	`+ "version": "2.2.0",`
`5`	`5`	`"license": "Apache-2.0",`
`6`	`6`	`"author": "Telefónica Innovación Digital",`
`7`	`7`	`"repository": {`
Original file line number	Diff line number	Diff line change
`@@ -68,6 +68,8 @@ export interface ConfluenceSyncPagesConfig {`
`68`	`68`	`logLevel?: LogLevel;`
`69`	`69`	`/** Dry run option */`
`70`	`70`	`dryRun?: boolean;`
	`71`	`+ /** API Prefix */`
	`72`	`+ apiPrefix?: string;`
`71`	`73`	`/** Sync mode */`
`72`	`74`	`syncMode?: SyncModes;`
`73`	`75`	`}`