confluence.js 1.6.2 → 1.7.0

package/src/api/users.ts

@@ -52,7 +52,7 @@ export class Users {
    */
   async getAnonymousUser<T = Models.UserAnonymous>(
     parameters: Parameters.GetAnonymousUser | undefined,
-    callback: Callback<T>
+    callback: Callback<T>,
   ): Promise<void>;
   /**
    * Returns information about how anonymous users are represented, like the profile picture and display name.
@@ -62,7 +62,7 @@ export class Users {
    */
   async getAnonymousUser<T = Models.UserAnonymous>(
     parameters?: Parameters.GetAnonymousUser,
-    callback?: never
+    callback?: never,
   ): Promise<T>;
   async getAnonymousUser<T = Models.UserAnonymous>(
     parameters?: Parameters.GetAnonymousUser,
@@ -88,7 +88,7 @@ export class Users {
    */
   async getCurrentUser<T = Models.User>(
     parameters: Parameters.GetCurrentUser | undefined,
-    callback: Callback<T>
+    callback: Callback<T>,
   ): Promise<void>;
   /**
    * Returns the currently logged-in user. This includes information about the user, like the display name, userKey,
@@ -121,7 +121,7 @@ export class Users {
    */
   async getGroupMembershipsForUser<T = Models.GroupArrayWithLinks>(
     parameters: Parameters.GetGroupMembershipsForUser,
-    callback: Callback<T>
+    callback: Callback<T>,
   ): Promise<void>;
   /**
    * Returns the groups that a user is a member of.
@@ -131,7 +131,7 @@ export class Users {
    */
   async getGroupMembershipsForUser<T = Models.GroupArrayWithLinks>(
     parameters: Parameters.GetGroupMembershipsForUser,
-    callback?: never
+    callback?: never,
   ): Promise<T>;
   async getGroupMembershipsForUser<T = Models.GroupArrayWithLinks>(
     parameters: Parameters.GetGroupMembershipsForUser,
@@ -160,7 +160,7 @@ export class Users {
    */
   async getBulkUserLookup<T = Models.BulkUserLookupArray>(
     parameters: Parameters.GetBulkUserLookup,
-    callback: Callback<T>
+    callback: Callback<T>,
   ): Promise<void>;
   /**
    * Returns user details for the ids provided in request.
@@ -170,7 +170,7 @@ export class Users {
    */
   async getBulkUserLookup<T = Models.BulkUserLookupArray>(
     parameters: Parameters.GetBulkUserLookup,
-    callback?: never
+    callback?: never,
   ): Promise<T>;
   async getBulkUserLookup<T = Models.BulkUserLookupArray>(
     parameters: Parameters.GetBulkUserLookup,
@@ -198,7 +198,7 @@ export class Users {
    */
   async getPrivacyUnsafeUserEmail<T = Models.AccountIdEmailRecord>(
     parameters: Parameters.GetPrivacyUnsafeUserEmail,
-    callback: Callback<T>
+    callback: Callback<T>,
   ): Promise<void>;
   /**
    * Returns a user's email address. This API is only available to apps approved by Atlassian, according to these
@@ -209,7 +209,7 @@ export class Users {
    */
   async getPrivacyUnsafeUserEmail<T = Models.AccountIdEmailRecord>(
     parameters: Parameters.GetPrivacyUnsafeUserEmail,
-    callback?: never
+    callback?: never,
   ): Promise<T>;
   async getPrivacyUnsafeUserEmail<T = Models.AccountIdEmailRecord>(
     parameters: Parameters.GetPrivacyUnsafeUserEmail,
@@ -238,7 +238,7 @@ export class Users {
    */
   async getPrivacyUnsafeUserEmailBulk<T = Models.AccountIdEmailRecordArray>(
     parameters: Parameters.GetPrivacyUnsafeUserEmailBulk,
-    callback: Callback<T>
+    callback: Callback<T>,
   ): Promise<void>;
   /**
    * Returns user email addresses for a set of accountIds. This API is only available to apps approved by Atlassian,
@@ -252,7 +252,7 @@ export class Users {
    */
   async getPrivacyUnsafeUserEmailBulk<T = Models.AccountIdEmailRecordArray>(
     parameters: Parameters.GetPrivacyUnsafeUserEmailBulk,
-    callback?: never
+    callback?: never,
   ): Promise<T>;
   async getPrivacyUnsafeUserEmailBulk<T = Models.AccountIdEmailRecordArray>(
     parameters: Parameters.GetPrivacyUnsafeUserEmailBulk,
@@ -278,7 +278,7 @@ export class Users {
    */
   async getBulkUserMigration<T = Models.MigratedUserArray>(
     parameters: Parameters.GetBulkUserMigration,
-    callback: Callback<T>
+    callback: Callback<T>,
   ): Promise<void>;
   /**
    * Returns the accountIds for the users specified in the key or username parameters. Note that multiple key and
@@ -289,7 +289,7 @@ export class Users {
    */
   async getBulkUserMigration<T = Models.MigratedUserArray>(
     parameters: Parameters.GetBulkUserMigration,
-    callback?: never
+    callback?: never,
   ): Promise<T>;
   async getBulkUserMigration<T = Models.MigratedUserArray>(
     parameters: Parameters.GetBulkUserMigration,

package/src/clients/baseClient.ts

@@ -11,9 +11,9 @@ const ATLASSIAN_TOKEN_CHECK_NOCHECK_VALUE = 'no-check';
 export class BaseClient implements Client {
   #instance: AxiosInstance | undefined;
 
-  protected urlSuffix = '/wiki/rest/';
-
-  constructor(protected readonly config: Config) {}
+  constructor(protected readonly config: Config) {
+    this.config.apiPrefix = this.config.apiPrefix || '/wiki/rest/';
+  }
 
   protected paramSerializer(parameters: Record<string, any>): string {
     const parts: string[] = [];
@@ -72,7 +72,7 @@ export class BaseClient implements Client {
     this.#instance = axios.create({
       paramsSerializer: this.paramSerializer.bind(this),
       ...this.config.baseRequestConfig,
-      baseURL: `${this.config.host}${this.urlSuffix}`,
+      baseURL: `${this.config.host}${this.config.apiPrefix}`,
       headers: this.removeUndefinedProperties({
         [ATLASSIAN_TOKEN_CHECK_FLAG]: this.config.noCheckAtlassianToken
           ? ATLASSIAN_TOKEN_CHECK_NOCHECK_VALUE

package/src/clients/confluenceClient.ts

@@ -1,4 +1,5 @@
 import { BaseClient } from './baseClient';
+import { Config } from '../config';
 import {
   Analytics,
   Audit,
@@ -35,6 +36,13 @@ import {
 } from '../api';
 
 export class ConfluenceClient extends BaseClient {
+  constructor(config: Config) {
+    super({
+      ...config,
+      apiPrefix: config.apiPrefix ?? '/wiki/rest',
+    });
+  }
+
   analytics = new Analytics(this);
   audit = new Audit(this);
   content = new Content(this);

package/src/clients/serverClient.ts

@@ -1,8 +1,14 @@
 import { BaseClient } from './baseClient';
+import { Config } from '../config';
 import { Audit, Content, ContentBody, Group, LongTask, Search, Space, User } from '../server';
 
 export class ServerClient extends BaseClient {
-  urlSuffix = '/';
+  constructor(config: Config) {
+    super({
+      ...config,
+      apiPrefix: config.apiPrefix ?? '/',
+    });
+  }
 
   audit = new Audit(this);
   content = new Content(this);

package/src/config.ts

@@ -9,12 +9,12 @@ export interface Config {
   middlewares?: Config.Middlewares;
   /** @deprecated Disabled. Will be removed in the next major version. */
   telemetry?: Config.Telemetry;
-  /**
-   * Adds `'X-Atlassian-Token': 'no-check'` to each request header
-   */
+  /** Adds `'X-Atlassian-Token': 'no-check'` to each request header */
   noCheckAtlassianToken?: boolean;
   /** Enable new API error handling. `false` by default. */
   newErrorHandling?: boolean;
+  /** Prefix for all API routes. */
+  apiPrefix?: string;
 }
 
 export namespace Config {
@@ -23,15 +23,20 @@ export namespace Config {
   /** @deprecated Disabled. Will be removed in the next major version. */
   export type Telemetry = boolean | any;
 
-  export type Authentication = UtilityTypes.XOR<{
+  export type Authentication = UtilityTypes.XOR4<
+  {
     jwt: Authentication.JWT;
-  }, UtilityTypes.XOR<{
+  },
+  {
     personalAccessToken: Authentication.PersonalAccessToken;
-  }, UtilityTypes.XOR<{
+  },
+  {
     basic: Authentication.Basic;
-  }, {
+  },
+  {
     oauth2: Authentication.OAuth2;
-  }>>>;
+  }
+  >;
 
   export interface Middlewares {
     onError?: Config.Middlewares.OnErrorHandler;
@@ -55,13 +60,16 @@ export namespace Config {
       expiryTimeSeconds?: number;
     };
 
-    export type Basic = UtilityTypes.XOR<{
+    export type Basic = UtilityTypes.XOR<
+    {
       email: string;
       apiToken: string;
-    }, {
+    },
+    {
       username: string;
       password: string;
-    }>;
+    }
+    >;
 
     export type OAuth2 = {
       accessToken: string;

package/src/server/audit.ts

@@ -11,12 +11,12 @@ export class Audit {
   /** Fetch a paginated list of AuditRecord instances dating back to a certain time */
   async getAuditRecords<T = Pagination<Models.AuditRecord>>(
     parameters: Parameters.GetAuditRecords | undefined,
-    callback: Callback<T>
+    callback: Callback<T>,
   ): Promise<void>;
   /** Fetch a paginated list of AuditRecord instances dating back to a certain time */
   async getAuditRecords<T = Pagination<Models.AuditRecord>>(
     parameters?: Parameters.GetAuditRecords,
-    callback?: never
+    callback?: never,
   ): Promise<T>;
   async getAuditRecords<T = Pagination<Models.AuditRecord>>(
     parameters?: Parameters.GetAuditRecords,
@@ -40,12 +40,12 @@ export class Audit {
   /** Creates a record in the audit log. */
   async createAuditRecord<T = Models.AuditRecord>(
     parameters: Parameters.CreateAuditRecord,
-    callback: Callback<T>
+    callback: Callback<T>,
   ): Promise<void>;
   /** Creates a record in the audit log. */
   async createAuditRecord<T = Models.AuditRecord>(
     parameters: Parameters.CreateAuditRecord,
-    callback?: never
+    callback?: never,
   ): Promise<T>;
   async createAuditRecord<T = Models.AuditRecord>(
     parameters: Parameters.CreateAuditRecord,
@@ -74,7 +74,7 @@ export class Audit {
   /** Exports audit records as a CSV file or ZIP file. */
   async exportAuditRecords<T = ArrayBuffer>(
     parameters: Parameters.ExportAuditRecords | undefined,
-    callback: Callback<T>
+    callback: Callback<T>,
   ): Promise<void>;
   /** Exports audit records as a CSV file or ZIP file. */
   async exportAuditRecords<T = ArrayBuffer>(parameters?: Parameters.ExportAuditRecords, callback?: never): Promise<T>;
@@ -112,12 +112,12 @@ export class Audit {
   /** Set the retention period to a new value. Can throw ServiceException if the retention period is too long */
   async setRetentionPeriod<T = Models.RetentionPeriod>(
     parameters: Models.RetentionPeriod,
-    callback: Callback<T>
+    callback: Callback<T>,
   ): Promise<void>;
   /** Set the retention period to a new value. Can throw ServiceException if the retention period is too long */
   async setRetentionPeriod<T = Models.RetentionPeriod>(
     parameters: Models.RetentionPeriod,
-    callback?: never
+    callback?: never,
   ): Promise<T>;
   async setRetentionPeriod<T = Models.RetentionPeriod>(
     parameters: Models.RetentionPeriod,
@@ -138,12 +138,12 @@ export class Audit {
   /** Fetch a paginated list of AuditRecord instances dating back to a certain time */
   async getAuditRecordsForTimePeriod<T = Pagination<Models.AuditRecord>>(
     parameters: Parameters.GetAuditRecordsSince | undefined,
-    callback: Callback<T>
+    callback: Callback<T>,
   ): Promise<void>;
   /** Fetch a paginated list of AuditRecord instances dating back to a certain time */
   async getAuditRecordsForTimePeriod<T = Pagination<Models.AuditRecord>>(
     parameters?: Parameters.GetAuditRecordsSince,
-    callback?: never
+    callback?: never,
   ): Promise<T>;
   async getAuditRecordsForTimePeriod<T = Pagination<Models.AuditRecord>>(
     parameters?: Parameters.GetAuditRecordsSince,