confluence.js 1.2.0 → 1.3.1

package/src/api/template.ts

@@ -44,14 +44,14 @@ export class Template {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'createContentTemplate' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
    * Updates a content template. Note, blueprint templates cannot be updated via the REST API.
    *
-   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space to create a
-   * space template or 'Confluence Administrator' global permission to create a global template.
+   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space to update a
+   * space template or 'Confluence Administrator' global permission to update a global template.
    */
   async updateContentTemplate<T = Models.ContentTemplate>(
     parameters: Parameters.UpdateContentTemplate | undefined,
@@ -60,8 +60,8 @@ export class Template {
   /**
    * Updates a content template. Note, blueprint templates cannot be updated via the REST API.
    *
-   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space to create a
-   * space template or 'Confluence Administrator' global permission to create a global template.
+   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space to update a
+   * space template or 'Confluence Administrator' global permission to update a global template.
    */
   async updateContentTemplate<T = Models.ContentTemplate>(
     parameters?: Parameters.UpdateContentTemplate,
@@ -85,7 +85,7 @@ export class Template {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'updateContentTemplate' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -95,8 +95,9 @@ export class Template {
    * Note, all global blueprints are inherited by each space. Space blueprints can be customised without affecting the
    * global blueprints.
    *
-   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
-   * ('Can use' global permission).
+   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space to view
+   * blueprints for the space and permission to access the Confluence site ('Can use' global permission) to view global
+   * blueprints.
    */
   async getBlueprintTemplates<T = Models.BlueprintTemplateArray>(
     parameters: Parameters.GetBlueprintTemplates | undefined,
@@ -109,8 +110,9 @@ export class Template {
    * Note, all global blueprints are inherited by each space. Space blueprints can be customised without affecting the
    * global blueprints.
    *
-   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
-   * ('Can use' global permission).
+   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space to view
+   * blueprints for the space and permission to access the Confluence site ('Can use' global permission) to view global
+   * blueprints.
    */
   async getBlueprintTemplates<T = Models.BlueprintTemplateArray>(
     parameters?: Parameters.GetBlueprintTemplates,
@@ -131,14 +133,14 @@ export class Template {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getBlueprintTemplates' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
    * Returns all content templates. Use this method to retrieve all global content templates or all content templates in a space.
    *
-   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space to view
-   * space templates and 'Confluence Administrator' global permission to view global templates.
+   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space to view
+   * space templates and permission to access the Confluence site ('Can use' global permission) to view global templates.
    */
   async getContentTemplates<T = Models.ContentTemplateArray>(
     parameters: Parameters.GetContentTemplates | undefined,
@@ -147,8 +149,8 @@ export class Template {
   /**
    * Returns all content templates. Use this method to retrieve all global content templates or all content templates in a space.
    *
-   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space to view
-   * space templates and 'Confluence Administrator' global permission to view global templates.
+   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space to view
+   * space templates and permission to access the Confluence site ('Can use' global permission) to view global templates.
    */
   async getContentTemplates<T = Models.ContentTemplateArray>(
     parameters?: Parameters.GetContentTemplates,
@@ -169,15 +171,15 @@ export class Template {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getContentTemplates' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
    * Returns a content template. This includes information about template, like the name, the space or blueprint that
    * the template is in, the body of the template, and more.
    *
-   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space to view
-   * space templates and 'Confluence Administrator' global permission to view global templates.
+   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space to view
+   * space templates and permission to access the Confluence site ('Can use' global permission) to view global templates.
    */
   async getContentTemplate<T = Models.ContentTemplate>(
     parameters: Parameters.GetContentTemplate,
@@ -187,8 +189,8 @@ export class Template {
    * Returns a content template. This includes information about template, like the name, the space or blueprint that
    * the template is in, the body of the template, and more.
    *
-   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space to view
-   * space templates and 'Confluence Administrator' global permission to view global templates.
+   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space to view
+   * space templates and permission to access the Confluence site ('Can use' global permission) to view global templates.
    */
   async getContentTemplate<T = Models.ContentTemplate>(
     parameters: Parameters.GetContentTemplate,
@@ -203,7 +205,7 @@ export class Template {
       method: 'GET',
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getContentTemplate' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -215,6 +217,9 @@ export class Template {
    * - If the template is a modified global-level blueprint template, it reverts to the default global-level blueprint template.
    *
    * Note, unmodified blueprint templates cannot be deleted.
+   *
+   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space to delete a
+   * space template or 'Confluence Administrator' global permission to delete a global template.
    */
   async removeTemplate<T = void>(parameters: Parameters.RemoveTemplate, callback: Callback<T>): Promise<void>;
   /**
@@ -226,6 +231,9 @@ export class Template {
    * - If the template is a modified global-level blueprint template, it reverts to the default global-level blueprint template.
    *
    * Note, unmodified blueprint templates cannot be deleted.
+   *
+   * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space to delete a
+   * space template or 'Confluence Administrator' global permission to delete a global template.
    */
   async removeTemplate<T = void>(parameters: Parameters.RemoveTemplate, callback?: never): Promise<T>;
   async removeTemplate<T = void>(parameters: Parameters.RemoveTemplate, callback?: Callback<T>): Promise<void | T> {
@@ -234,6 +242,6 @@ export class Template {
       method: 'DELETE',
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'removeTemplate' });
+    return this.client.sendRequest(config, callback);
   }
 }

package/src/api/themes.ts

@@ -32,7 +32,7 @@ export class Themes {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getThemes' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -53,7 +53,7 @@ export class Themes {
       method: 'GET',
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getGlobalTheme' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -74,7 +74,7 @@ export class Themes {
       method: 'GET',
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getTheme' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -100,7 +100,7 @@ export class Themes {
       method: 'GET',
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getSpaceTheme' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -129,7 +129,7 @@ export class Themes {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'setSpaceTheme' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -150,6 +150,6 @@ export class Themes {
       method: 'DELETE',
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'resetSpaceTheme' });
+    return this.client.sendRequest(config, callback);
   }
 }

package/src/api/users.ts

@@ -41,7 +41,7 @@ export class Users {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getUser' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -76,7 +76,7 @@ export class Users {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getAnonymousUser' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -110,7 +110,7 @@ export class Users {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getCurrentUser' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -149,7 +149,7 @@ export class Users {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getGroupMembershipsForUser' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -186,7 +186,7 @@ export class Users {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getBulkUserLookup' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -223,7 +223,7 @@ export class Users {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getPrivacyUnsafeUserEmail' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -266,7 +266,7 @@ export class Users {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getPrivacyUnsafeUserEmailBulk' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -306,6 +306,6 @@ export class Users {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getBulkUserMigration' });
+    return this.client.sendRequest(config, callback);
   }
 }

package/src/clients/baseClient.ts

@@ -1,5 +1,4 @@
 import axios, { AxiosInstance } from 'axios';
-import { Authentication, Telemetry, TelemetryClient } from 'telemetry.confluence.js';
 import type { Client } from './client';
 import type { Callback } from '../callback';
 import type { Config } from '../config';
@@ -11,20 +10,17 @@ const ATLASSIAN_TOKEN_CHECK_NOCHECK_VALUE = 'no-check';
 
 export class BaseClient implements Client {
   #instance: AxiosInstance | undefined;
-  private telemetryClient: TelemetryClient;
 
   protected urlSuffix = '/wiki/rest/';
 
-  constructor(protected readonly config: Config) {
-    this.telemetryClient = new TelemetryClient(config.telemetry);
-  }
+  constructor(protected readonly config: Config) {}
 
   protected paramSerializer(parameters: Record<string, any>): string {
     const parts: string[] = [];
 
     Object.entries(parameters).forEach(([key, value]) => {
       if (value === null || typeof value === 'undefined') {
-        return undefined;
+        return;
       }
 
       if (Array.isArray(value)) {
@@ -38,11 +34,15 @@ export class BaseClient implements Client {
       } else if (value !== null && typeof value === 'object') {
         // eslint-disable-next-line no-param-reassign
         value = JSON.stringify(value);
+      } else if (value instanceof Function) {
+        const part = value();
+
+        return part && parts.push(part);
       }
 
       parts.push(`${this.encode(key)}=${this.encode(value)}`);
 
-      return undefined;
+      return;
     });
 
     return parts.join('&');
@@ -82,38 +82,16 @@ export class BaseClient implements Client {
     return this.#instance;
   }
 
-  async sendRequest<T>(requestConfig: RequestConfig, callback: never, telemetryData?: Partial<Telemetry>): Promise<T>;
+  async sendRequest<T>(requestConfig: RequestConfig, callback: never, telemetryData?: any): Promise<T>;
   async sendRequest<T>(
     requestConfig: RequestConfig,
     callback: Callback<T>,
-    telemetryData?: Partial<Telemetry>
+    telemetryData?: any,
   ): Promise<void>;
   async sendRequest<T>(
     requestConfig: RequestConfig,
     callback: Callback<T> | never,
-    telemetryData?: Partial<Telemetry>,
   ): Promise<void | T> {
-    const startDateTime = new Date();
-
-    const telemetry: Telemetry = {
-      authentication: this.authenticationType,
-      baseRequestConfigUsed: !!this.config.baseRequestConfig,
-      bodyExists: !!requestConfig.data,
-      callbackUsed: !!callback,
-      headersExists: !!requestConfig.headers,
-      libVersion: '1.2.0',
-      libVersionHash: '0ba4439ee9a46d9d9f14c60f88f45f87',
-      methodName: telemetryData?.methodName || 'sendRequest',
-      onErrorMiddlewareUsed: !!this.config.middlewares?.onError,
-      onResponseMiddlewareUsed: !!this.config.middlewares?.onResponse,
-      queryExists: !!requestConfig.params,
-      requestEndTime: new Date(),
-      requestStartTime: startDateTime,
-      requestStatusCode: 0,
-      noCheckAtlassianToken: !!this.config.noCheckAtlassianToken,
-      ...telemetryData,
-    };
-
     try {
       const modifiedRequestConfig = {
         ...requestConfig,
@@ -127,7 +105,7 @@ export class BaseClient implements Client {
         }),
       };
 
-      const response = await this.instance.request(modifiedRequestConfig);
+      const response = await this.instance.request<T>(modifiedRequestConfig);
 
       const callbackResponseHandler = callback && ((data: T): void => callback(null, data));
       const defaultResponseHandler = (data: T): T => data;
@@ -136,8 +114,6 @@ export class BaseClient implements Client {
 
       this.config.middlewares?.onResponse?.(response.data);
 
-      telemetry.requestStatusCode = response.status;
-
       return responseHandler(response.data);
     } catch (e: any) {
       const callbackErrorHandler = callback && ((error: Config.Error) => callback(error));
@@ -149,35 +125,7 @@ export class BaseClient implements Client {
 
       this.config.middlewares?.onError?.(e);
 
-      telemetry.requestStatusCode = e.isAxiosError ? e.response?.status ?? 0 : 418;
-
       return errorHandler(e);
-    } finally {
-      telemetry.requestEndTime = new Date();
-
-      this.telemetryClient.sendTelemetry(telemetry);
     }
   }
-
-  private get authenticationType(): Authentication {
-    const { authentication } = this.config;
-
-    if (!authentication) {
-      return Authentication.None;
-    }
-
-    if (authentication.basic) {
-      return Authentication.Basic;
-    }
-
-    if (authentication.oauth2) {
-      return Authentication.OAuth2;
-    }
-
-    if (authentication.jwt) {
-      return Authentication.JWT;
-    }
-
-    return Authentication.NA;
-  }
 }

package/src/clients/client.ts

@@ -1,12 +1,11 @@
-import type { Telemetry } from 'telemetry.confluence.js';
 import type { Callback } from '../callback';
 import type { RequestConfig } from '../requestConfig';
 
 export interface Client {
-  sendRequest<T>(requestConfig: RequestConfig, callback?: never, telemetryData?: Partial<Telemetry>): Promise<T>;
+  sendRequest<T>(requestConfig: RequestConfig, callback?: never, telemetryData?: any): Promise<T>;
   sendRequest<T>(
     requestConfig: RequestConfig,
     callback?: Callback<T>,
-    telemetryData?: Partial<Telemetry>
+    telemetryData?: any,
   ): Promise<void>;
 }

package/src/config.ts

@@ -1,5 +1,4 @@
 import { AxiosError } from 'axios';
-import type { TelemetryConfig } from 'telemetry.confluence.js';
 import type { RequestConfig } from './requestConfig';
 import type { UtilityTypes } from './utilityTypes';
 
@@ -8,6 +7,7 @@ export interface Config {
   baseRequestConfig?: Config.BaseRequestConfig;
   authentication?: Config.Authentication;
   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
@@ -18,7 +18,8 @@ export interface Config {
 export namespace Config {
   export type BaseRequestConfig = RequestConfig;
   export type Error = AxiosError;
-  export type Telemetry = boolean | TelemetryConfig;
+  /** @deprecated Disabled. Will be removed in the next major version. */
+  export type Telemetry = boolean | any;
 
   export type Authentication = UtilityTypes.XOR<{
     jwt: Authentication.JWT;

package/src/index.ts

@@ -4,5 +4,6 @@ export * from './requestConfig';
 export * from './callback';
 
 export * as Api from './api';
+export * as Server from './server';
 export * as Models from './api/models';
 export * as Parameters from './api/parameters';

package/tsconfig.json

@@ -5,7 +5,8 @@
     "outDir": "out",
     "strict": true,
     "declaration": true,
-    "importHelpers": true
+    "importHelpers": true,
+    "forceConsistentCasingInFileNames": true
   },
   "exclude": [
     "node_modules",