confluence.js 1.3.0 → 1.4.1

package/src/api/search.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 Search {
@@ -74,7 +74,7 @@ export class Search {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'searchByCQL' });
+    return this.client.sendRequest(config, callback);
   }
 
   /** @deprecated Will be removed in the next major version. Use `searchUser` instead. */
@@ -93,12 +93,13 @@ export class Search {
   ): Promise<void | T> {
     return this.searchUser(parameters, callback!);
   }
+
   /**
    * Searches for users using user-specific queries from the [Confluence Query Language
    * (CQL)](https://developer.atlassian.com/cloud/confluence/advanced-searching-using-cql/).
    *
    * Note that some user fields may be set to null depending on the user's privacy settings. These are: email,
-   * profilePicture, and displayName.
+   * profilePicture, displayName, and timeZone.
    */
   async searchUser<T = Models.SearchPageResponseSearchResult>(
     parameters: Parameters.SearchUser,
@@ -109,7 +110,7 @@ export class Search {
    * (CQL)](https://developer.atlassian.com/cloud/confluence/advanced-searching-using-cql/).
    *
    * Note that some user fields may be set to null depending on the user's privacy settings. These are: email,
-   * profilePicture, and displayName.
+   * profilePicture, displayName, and timeZone.
    */
   async searchUser<T = Models.SearchPageResponseSearchResult>(
     parameters: Parameters.SearchUser,
@@ -126,9 +127,10 @@ export class Search {
         cql: parameters.cql,
         start: parameters.start,
         limit: parameters.limit,
+        expand: parameters.expand,
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'searchUser' });
+    return this.client.sendRequest(config, callback);
   }
 }

package/src/api/settings.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 Settings {
@@ -43,7 +43,7 @@ export class Settings {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getLookAndFeelSettings' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -81,7 +81,7 @@ export class Settings {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'updateLookAndFeel' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -133,7 +133,7 @@ export class Settings {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'updateLookAndFeelSettings' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -170,7 +170,7 @@ export class Settings {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'resetLookAndFeelSettings' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -205,7 +205,7 @@ export class Settings {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'setLookAndFeelSettings' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -228,6 +228,28 @@ export class Settings {
       method: 'GET',
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getSystemInfo' });
+    return this.client.sendRequest(config, callback);
+  }
+
+  /** Gets Content State settings for a space */
+  async getContentStateSettings<T = Models.ContentStateSettings>(
+    parameters: Parameters.GetContentStateSettings,
+    callback: Callback<T>
+  ): Promise<void>;
+  /** Gets Content State settings for a space */
+  async getContentStateSettings<T = Models.ContentStateSettings>(
+    parameters: Parameters.GetContentStateSettings,
+    callback?: never
+  ): Promise<T>;
+  async getContentStateSettings<T = Models.ContentStateSettings>(
+    parameters: Parameters.GetContentStateSettings,
+    callback?: Callback<T>,
+  ): Promise<void | T> {
+    const config: RequestConfig = {
+      url: `/api/space/${parameters.spaceKey}/state/settings`,
+      method: 'GET',
+    };
+
+    return this.client.sendRequest(config, callback);
   }
 }

package/src/api/space.ts

@@ -1,7 +1,8 @@
 import * as Models from './models';
 import * as Parameters from './parameters';
-import { Client } from '../clients';
 import { Callback } from '../callback';
+import { Client } from '../clients';
+import { paramSerializer } from '../paramSerializer';
 import { RequestConfig } from '../requestConfig';
 
 export class Space {
@@ -31,7 +32,7 @@ export class Space {
       url: '/api/space',
       method: 'GET',
       params: {
-        spaceKey: parameters?.spaceKey?.map((key, index) => index ? `&spaceKey=${key}` : key),
+        spaceKey: paramSerializer('spaceKey', parameters?.spaceKey),
         spaceId: parameters?.spaceId,
         type: parameters?.type,
         status: parameters?.status,
@@ -43,7 +44,7 @@ export class Space {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getSpaces' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -73,7 +74,7 @@ export class Space {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'createSpace' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -110,7 +111,7 @@ export class Space {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'createPrivateSpace' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -129,9 +130,12 @@ export class Space {
     const config: RequestConfig = {
       url: `/api/space/${parameters.spaceKey}`,
       method: 'GET',
+      params: {
+        expand: parameters.expand,
+      },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getSpace' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -165,7 +169,7 @@ export class Space {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'updateSpace' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -193,7 +197,7 @@ export class Space {
       method: 'DELETE',
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'deleteSpace' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -232,7 +236,7 @@ export class Space {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getContentForSpace' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -269,6 +273,6 @@ export class Space {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getContentByTypeForSpace' });
+    return this.client.sendRequest(config, callback);
   }
 }

package/src/api/spacePermissions.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 SpacePermissions {
@@ -61,7 +61,7 @@ export class SpacePermissions {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'addPermissionToSpace' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -103,7 +103,7 @@ export class SpacePermissions {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'addCustomContentPermissions' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -130,6 +130,6 @@ export class SpacePermissions {
       method: 'DELETE',
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'removePermission' });
+    return this.client.sendRequest(config, callback);
   }
 }

package/src/api/spaceProperties.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 SpaceProperties {
@@ -39,7 +39,7 @@ export class SpaceProperties {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getSpaceProperties' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -74,7 +74,7 @@ export class SpaceProperties {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'createSpaceProperty' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -107,7 +107,7 @@ export class SpaceProperties {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getSpaceProperty' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -142,7 +142,7 @@ export class SpaceProperties {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'createSpacePropertyForKey' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -176,7 +176,7 @@ export class SpaceProperties {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'updateSpaceProperty' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -200,6 +200,6 @@ export class SpaceProperties {
       method: 'DELETE',
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'deleteSpaceProperty' });
+    return this.client.sendRequest(config, callback);
   }
 }

package/src/api/spaceSettings.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 SpaceSettings {
@@ -34,7 +34,7 @@ export class SpaceSettings {
       method: 'GET',
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'getSpaceSettings' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -67,6 +67,6 @@ export class SpaceSettings {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'updateSpaceSettings' });
+    return this.client.sendRequest(config, callback);
   }
 }

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,9 +1,9 @@
-import axios, { AxiosInstance } from 'axios';
-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';
@@ -20,7 +20,7 @@ export class BaseClient implements Client {
 
     Object.entries(parameters).forEach(([key, value]) => {
       if (value === null || typeof value === 'undefined') {
-        return undefined;
+        return;
       }
 
       if (Array.isArray(value)) {
@@ -34,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('&');

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

@@ -23,11 +23,13 @@ export namespace Config {
 
   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;
@@ -40,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/index.ts

@@ -2,8 +2,12 @@ export * from './clients';
 export * from './config';
 export * from './requestConfig';
 export * from './callback';
+export * from './pagination';
+export * from './utilityTypes';
 
 export * as Api from './api';
 export * as Server from './server';
 export * as Models from './api/models';
 export * as Parameters from './api/parameters';
+export * as ServerModels from './server/models';
+export * as ServerParameters from './server/parameters';