confluence.js 1.2.2 → 1.4.0

package/src/api/template.ts

@@ -1,7 +1,7 @@
 import * as Models from './models';
 import * as Parameters from './parameters';
-import { Client } from '../clients';
 import { Callback } from '../callback';
+import { Client } from '../clients';
 import { RequestConfig } from '../requestConfig';
 
 export class Template {
@@ -44,7 +44,7 @@ export class Template {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'createContentTemplate' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -85,7 +85,7 @@ export class Template {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'updateContentTemplate' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -133,7 +133,7 @@ export class Template {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getBlueprintTemplates' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -171,7 +171,7 @@ export class Template {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getContentTemplates' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -205,7 +205,7 @@ export class Template {
       method: 'GET',
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getContentTemplate' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -242,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

@@ -1,7 +1,7 @@
 import * as Models from './models';
 import * as Parameters from './parameters';
-import { Client } from '../clients';
 import { Callback } from '../callback';
+import { Client } from '../clients';
 import { RequestConfig } from '../requestConfig';
 
 export class Themes {
@@ -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

@@ -1,7 +1,7 @@
 import * as Models from './models';
 import * as Parameters from './parameters';
-import { Client } from '../clients';
 import { Callback } from '../callback';
+import { Client } from '../clients';
 import { RequestConfig } from '../requestConfig';
 
 export class Users {
@@ -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);
   }
 
   /**
@@ -119,7 +119,7 @@ export class Users {
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
    * ('Can use' global permission).
    */
-  async getGroupMembershipsForUser<T = Models.GroupArray>(
+  async getGroupMembershipsForUser<T = Models.GroupArrayWithLinks>(
     parameters: Parameters.GetGroupMembershipsForUser,
     callback: Callback<T>
   ): Promise<void>;
@@ -129,11 +129,11 @@ export class Users {
    * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
    * ('Can use' global permission).
    */
-  async getGroupMembershipsForUser<T = Models.GroupArray>(
+  async getGroupMembershipsForUser<T = Models.GroupArrayWithLinks>(
     parameters: Parameters.GetGroupMembershipsForUser,
     callback?: never
   ): Promise<T>;
-  async getGroupMembershipsForUser<T = Models.GroupArray>(
+  async getGroupMembershipsForUser<T = Models.GroupArrayWithLinks>(
     parameters: Parameters.GetGroupMembershipsForUser,
     callback?: Callback<T>,
   ): Promise<void | T> {
@@ -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,30 +1,26 @@
-import axios, { AxiosInstance } from 'axios';
-import { Authentication, Telemetry, TelemetryClient } from 'telemetry.confluence.js';
-import type { Client } from './client';
+import { AuthenticationService } from '../services/authenticationService';
 import type { Callback } from '../callback';
+import type { Client } from './client';
 import type { Config } from '../config';
-import { AuthenticationService } from '../services/authenticationService';
 import type { RequestConfig } from '../requestConfig';
+import axios, { AxiosInstance } from 'axios';
 
 const ATLASSIAN_TOKEN_CHECK_FLAG = 'X-Atlassian-Token';
 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.2',
-      libVersionHash: 'bda9643ac6601722a28f238714274da4',
-      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,
@@ -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/clients/confluenceClient.ts

@@ -1,11 +1,13 @@
 import { BaseClient } from './baseClient';
 import {
+  Analytics,
   Audit,
   Content,
   ContentAttachments,
   ContentBody,
   ContentChildrenAndDescendants,
   ContentComments,
+  ContentContentState,
   ContentLabels,
   ContentMacroBody,
   ContentPermissions,
@@ -32,12 +34,14 @@ import {
 } from '../api';
 
 export class ConfluenceClient extends BaseClient {
+  analytics = new Analytics(this);
   audit = new Audit(this);
   content = new Content(this);
   contentAttachments = new ContentAttachments(this);
   contentBody = new ContentBody(this);
   contentChildrenAndDescendants = new ContentChildrenAndDescendants(this);
   contentComments = new ContentComments(this);
+  contentContentState = new ContentContentState(this);
   contentLabels = new ContentLabels(this);
   contentMacroBody = new ContentMacroBody(this);
   contentPermissions = new ContentPermissions(this);

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,15 +18,18 @@ 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;
+  }, UtilityTypes.XOR<{
+    personalAccessToken: Authentication.PersonalAccessToken;
   }, UtilityTypes.XOR<{
     basic: Authentication.Basic;
   }, {
     oauth2: Authentication.OAuth2;
-  }>>;
+  }>>>;
 
   export interface Middlewares {
     onError?: Config.Middlewares.OnErrorHandler;
@@ -39,10 +42,12 @@ export namespace Config {
   }
 
   export namespace Authentication {
+    export type PersonalAccessToken = string;
+
     export type JWT = {
       /** The key from the app descriptor. */
       issuer: string;
-      /** The sharedsecret key received during the app installation handshake */
+      /** The shared secret key received during the app installation handshake */
       secret: string;
       /** Token expiry time (default 3 minutes after issuing) */
       expiryTimeSeconds?: number;

package/src/paramSerializer.ts

@@ -0,0 +1,15 @@
+export function paramSerializer(key: string, values?: string | string[]) {
+  if (typeof values === 'string') {
+    return () => `${key}=${values}`;
+  }
+
+  if (!values) {
+    return undefined;
+  }
+
+  if (!values.length) {
+    return '';
+  }
+
+  return () => values.map((value) => `${key}=${value}`).join('&');
+}

package/src/server/audit.ts

@@ -1,9 +1,9 @@
 import * as Models from './models';
 import * as Parameters from './parameters';
-import { Client } from '../clients';
 import { Callback } from '../callback';
-import { RequestConfig } from '../requestConfig';
+import { Client } from '../clients';
 import { Pagination } from '../pagination';
+import { RequestConfig } from '../requestConfig';
 
 export class Audit {
   constructor(private client: Client) {}

package/src/server/content.ts

@@ -1,9 +1,9 @@
 import * as Models from './models';
 import * as Parameters from './parameters';
-import { Client } from '../clients';
 import { Callback } from '../callback';
-import { RequestConfig } from '../requestConfig';
+import { Client } from '../clients';
 import { Pagination } from '../pagination';
+import { RequestConfig } from '../requestConfig';
 
 export class Content {
   constructor(private client: Client) {}

package/src/server/contentBody.ts

@@ -1,7 +1,7 @@
 import * as Models from './models';
 import * as Parameters from './parameters';
-import { Client } from '../clients';
 import { Callback } from '../callback';
+import { Client } from '../clients';
 import { RequestConfig } from '../requestConfig';
 
 export class ContentBody {

package/src/server/group.ts

@@ -1,9 +1,9 @@
 import * as Models from './models';
 import * as Parameters from './parameters';
-import { Client } from '../clients';
 import { Callback } from '../callback';
-import { RequestConfig } from '../requestConfig';
+import { Client } from '../clients';
 import { Pagination } from '../pagination';
+import { RequestConfig } from '../requestConfig';
 
 export class Group {
   constructor(private client: Client) {}

package/src/server/longTask.ts

@@ -1,9 +1,9 @@
 import * as Models from './models';
 import * as Parameters from './parameters';
-import { Client } from '../clients';
 import { Callback } from '../callback';
-import { RequestConfig } from '../requestConfig';
+import { Client } from '../clients';
 import { Pagination } from '../pagination';
+import { RequestConfig } from '../requestConfig';
 
 export class LongTask {
   constructor(private client: Client) {}

package/src/server/models/content.ts

@@ -1,12 +1,12 @@
-import { Space } from './space';
-import { ContentHistory } from './contentHistory';
-import { Version } from './version';
-import { OperationCheckResult } from './operationCheckResult';
-import { ContentChildren } from './contentChildren';
-import { ContentChildType } from './contentChildType';
 import { Container } from './container';
 import { ContentBody } from './contentBody';
+import { ContentChildren } from './contentChildren';
+import { ContentChildType } from './contentChildType';
+import { ContentHistory } from './contentHistory';
 import { ContentRestriction } from './contentRestriction';
+import { OperationCheckResult } from './operationCheckResult';
+import { Space } from './space';
+import { Version } from './version';
 
 /** Base object for all content types. */
 export interface Content {

package/src/server/models/contentChildren.ts

@@ -1,5 +1,5 @@
-import { Pagination } from '../../pagination';
 import { Content } from './content';
+import { Pagination } from '../../pagination';
 
 export interface ContentChildren {
   attachment?: Pagination<Content>;

package/src/server/models/contentHistory.ts

@@ -1,6 +1,6 @@
-import { Version } from './version';
-import { UsersUserKeys } from './usersUserKeys';
 import { User } from './user';
+import { UsersUserKeys } from './usersUserKeys';
+import { Version } from './version';
 
 export interface ContentHistory {
   latest: boolean;

package/src/server/models/contentLookAndFeel.ts

@@ -1,5 +1,5 @@
-import { ScreenLookAndFeel } from './screenLookAndFeel';
 import { ContainerLookAndFeel } from './containerLookAndFeel';
+import { ScreenLookAndFeel } from './screenLookAndFeel';
 
 export interface ContentLookAndFeel {
   screen: ScreenLookAndFeel;

package/src/server/models/contentRestriction.ts

@@ -1,6 +1,6 @@
-import { UserArray } from './userArray';
-import { GroupArray } from './groupArray';
 import { Content } from './content';
+import { GroupArray } from './groupArray';
+import { UserArray } from './userArray';
 
 export interface ContentRestriction {
   operation: string;

package/src/server/models/lookAndFeel.ts

@@ -1,6 +1,6 @@
-import { MenusLookAndFeel } from './menusLookAndFeel';
-import { HeaderLookAndFeel } from './headerLookAndFeel';
 import { ContentLookAndFeel } from './contentLookAndFeel';
+import { HeaderLookAndFeel } from './headerLookAndFeel';
+import { MenusLookAndFeel } from './menusLookAndFeel';
 
 export interface LookAndFeel {
   headings: {

package/src/server/models/searchResult.ts

@@ -1,6 +1,6 @@
-import { Content } from './content';
-import { ContainerSummary } from './containerSummary';
 import { Breadcrumb } from './breadcrumb';
+import { ContainerSummary } from './containerSummary';
+import { Content } from './content';
 
 export interface SearchResult {
   content: Content;

package/src/server/models/space.ts

@@ -1,12 +1,12 @@
-import { Icon } from './icon';
-import { SpaceDescription } from './spaceDescription';
 import { Content } from './content';
+import { Icon } from './icon';
 import { LabelArray } from './labelArray';
+import { LookAndFeel } from './lookAndFeel';
 import { OperationCheckResult } from './operationCheckResult';
+import { SpaceDescription } from './spaceDescription';
 import { SpacePermission } from './spacePermission';
 import { SpaceSettings } from './spaceSettings';
 import { Theme } from './theme';
-import { LookAndFeel } from './lookAndFeel';
 
 export interface Space {
   id: number;

package/src/server/models/spacePermission.ts

@@ -1,6 +1,6 @@
-import { User } from './user';
 import { Group } from './group';
 import { OperationCheckResult } from './operationCheckResult';
+import { User } from './user';
 
 /**
  * This object represents a permission for given space. Permissions consist of* at least one operation object with an

package/src/server/models/user.ts

@@ -1,7 +1,7 @@
 import { Icon } from './icon';
 import { OperationCheckResult } from './operationCheckResult';
-import { UserDetails } from './userDetails';
 import { Space } from './space';
+import { UserDetails } from './userDetails';
 
 export interface User {
   type: string;

package/src/server/models/version.ts

@@ -1,5 +1,5 @@
-import { User } from './user';
 import { Content } from './content';
+import { User } from './user';
 import { UsersUserKeys } from './usersUserKeys';
 
 export interface Version {

package/src/server/search.ts

@@ -1,9 +1,9 @@
 import * as Models from './models';
 import * as Parameters from './parameters';
-import { Client } from '../clients';
 import { Callback } from '../callback';
-import { RequestConfig } from '../requestConfig';
+import { Client } from '../clients';
 import { Pagination } from '../pagination';
+import { RequestConfig } from '../requestConfig';
 
 export class Search {
   constructor(private client: Client) {}