confluence.js 1.3.1 → 1.4.0

package/src/api/models/spaceWatchArray.ts

@@ -1,5 +1,5 @@
-import { SpaceWatch } from './spaceWatch';
 import { GenericLinks } from './genericLinks';
+import { SpaceWatch } from './spaceWatch';
 
 export interface SpaceWatchArray {
   results: SpaceWatch[];

package/src/api/models/themeArray.ts

@@ -1,5 +1,5 @@
-import { ThemeNoLinks } from './themeNoLinks';
 import { GenericLinks } from './genericLinks';
+import { ThemeNoLinks } from './themeNoLinks';
 
 export interface ThemeArray {
   results: ThemeNoLinks[];

package/src/api/models/user.ts

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

package/src/api/models/userAnonymous.ts

@@ -1,6 +1,6 @@
+import { GenericLinks } from './genericLinks';
 import { Icon } from './icon';
 import { OperationCheckResult } from './operationCheckResult';
-import { GenericLinks } from './genericLinks';
 
 export interface UserAnonymous {
   type: string;

package/src/api/models/userProperty.ts

@@ -0,0 +1,14 @@
+import { GenericLinks } from './genericLinks';
+
+export interface UserProperty {
+  key: string;
+  /** The value of the content property. */
+  value: {};
+  /** A unique identifier for the user property */
+  id: string;
+  /** Datetime when the property was last modified such as `2022-02-01T12:00:00.111Z` */
+  lastModifiedDate: string;
+  /** Datetime when the property was created such as `2022-01-01T12:00:00.111Z` */
+  createdDate: string;
+  Links?: GenericLinks;
+}

package/src/api/models/userPropertyCreate.ts

@@ -0,0 +1,4 @@
+export interface UserPropertyCreate {
+  /** The value of the user property. */
+  value: {};
+}

package/src/api/models/userPropertyKeyArray.ts

@@ -0,0 +1,11 @@
+import { GenericLinks } from './genericLinks';
+
+export interface UserPropertyKeyArray {
+  results: {
+    key?: string;
+  }[];
+  start?: number;
+  limit?: number;
+  size?: number;
+  Links?: GenericLinks;
+}

package/src/api/models/userPropertyUpdate.ts

@@ -0,0 +1,4 @@
+export interface UserPropertyUpdate {
+  /** The value of the user property. */
+  value: {};
+}

package/src/api/models/usersUserKeys.ts

@@ -1,5 +1,5 @@
-import { User } from './user';
 import { GenericLinks } from './genericLinks';
+import { User } from './user';
 
 export interface UsersUserKeys {
   users: User[];

package/src/api/models/version.ts

@@ -1,7 +1,7 @@
-import { User } from './user';
 import { Content } from './content';
-import { UsersUserKeys } from './usersUserKeys';
 import { GenericLinks } from './genericLinks';
+import { User } from './user';
+import { UsersUserKeys } from './usersUserKeys';
 
 export interface Version {
   by: User;

package/src/api/models/versionArray.ts

@@ -1,5 +1,5 @@
-import { Version } from './version';
 import { GenericLinks } from './genericLinks';
+import { Version } from './version';
 
 export interface VersionArray {
   results: Version[];

package/src/api/models/watchArray.ts

@@ -1,5 +1,5 @@
-import { Watch } from './watch';
 import { GenericLinks } from './genericLinks';
+import { Watch } from './watch';
 
 export interface WatchArray {
   results: Watch[];

package/src/api/parameters/createUserProperty.ts

@@ -0,0 +1,11 @@
+import { UserPropertyCreate } from '../models';
+
+export interface CreateUserProperty extends UserPropertyCreate {
+  /**
+   * The account ID of the user. The accountId uniquely identifies the user across all Atlassian products. For
+   * example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192
+   */
+  userId: string;
+  /** The key of the user property. */
+  key: string;
+}

package/src/api/parameters/deletePageTree.ts

@@ -0,0 +1,4 @@
+export interface DeletePageTree {
+  /** The ID of the content which forms root of the page tree, to be deleted. */
+  id: string;
+}

package/src/api/parameters/deleteUserProperty.ts

@@ -0,0 +1,9 @@
+export interface DeleteUserProperty {
+  /**
+   * The account ID of the user. The accountId uniquely identifies the user across all Atlassian products. For
+   * example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192
+   */
+  userId: string;
+  /** The key of the user property. */
+  key: string;
+}

package/src/api/parameters/getAvailableContentStates.ts

@@ -0,0 +1,4 @@
+export interface GetAvailableContentStates {
+  /** Id of content to get available states for */
+  contentId: string;
+}

package/src/api/parameters/getContentState.ts

@@ -0,0 +1,6 @@
+export interface GetContentState {
+  /** The Id of the page whose content state is of interest. */
+  contentId: string;
+  /** Set designation=DRAFT or designation=PUBLISHED. */
+  designation?: string;
+}

package/src/api/parameters/getContentStateLastUpdated.ts

@@ -0,0 +1,4 @@
+export interface GetContentStateLastUpdated {
+  /** Id of Content to get information for */
+  contentId: string;
+}

package/src/api/parameters/getContentStateSettings.ts

@@ -0,0 +1,4 @@
+export interface GetContentStateSettings {
+  /** SpaceKey */
+  spaceKey: string;
+}

package/src/api/parameters/getGroupMembersByGroupId.ts

@@ -5,4 +5,9 @@ export interface GetGroupMembersByGroupId {
   start?: number;
   /** The maximum number of users to return per page. Note, this may be restricted by fixed system limits. */
   limit?: number;
+  /**
+   * Whether to include total size parameter in the results. Note, fetching total size property is an expensive
+   * operation; use it if your use case needs this value.
+   */
+  shouldReturnTotalSize?: boolean;
 }

package/src/api/parameters/getMembersByQueryParam.ts

@@ -8,4 +8,9 @@ export interface GetMembersByQueryParam {
    * say if the limit parameter exceeds 200, this API will return a maximum of 200 users per page.
    */
   limit?: number;
+  /**
+   * Whether to include total size parameter in the results. Note, fetching total size property is an expensive
+   * operation; use it if your use case needs this value.
+   */
+  shouldReturnTotalSize?: boolean;
 }

package/src/api/parameters/getSpaces.ts

@@ -21,7 +21,37 @@ export interface GetSpaces {
    */
   favouriteUserKey?: string;
   /** A multi-value parameter indicating which properties of the content to expand. */
-  expand?: string[];
+  expand?:
+  | 'settings'
+  | 'metadata'
+  | 'metadata.labels'
+  | 'operations'
+  | 'lookAndFeel'
+  | 'permissions'
+  | 'icon'
+  | 'description'
+  | 'description.plain'
+  | 'description.view'
+  | 'theme'
+  | 'homepage'
+  | 'history'
+  | (
+    | 'settings'
+    | 'metadata'
+    | 'metadata.labels'
+    | 'operations'
+    | 'lookAndFeel'
+    | 'permissions'
+    | 'icon'
+    | 'description'
+    | 'description.plain'
+    | 'description.view'
+    | 'theme'
+    | 'homepage'
+    | 'history'
+  )[]
+  | string
+  | string[];
   /** The starting index of the returned spaces. */
   start?: number;
   /** The maximum number of spaces to return per page. Note, this may be restricted by fixed system limits. */

package/src/api/parameters/getUserProperties.ts

@@ -0,0 +1,8 @@
+export interface GetUserProperties {
+  /** The account ID of the user to be queried for its properties. */
+  userId: string;
+  /** The starting index of the returned properties. */
+  start?: number;
+  /** The maximum number of properties to return per page. Note, this may be restricted by fixed system limits. */
+  limit?: number;
+}

package/src/api/parameters/getUserProperty.ts

@@ -0,0 +1,6 @@
+export interface GetUserProperty {
+  /** The account ID of the user to be queried for its properties. */
+  userId: string;
+  /** The key of the user property. */
+  key: string;
+}

package/src/api/parameters/index.ts

@@ -30,15 +30,18 @@ export * from './createRelationship';
 export * from './createSpace';
 export * from './createSpaceProperty';
 export * from './createSpacePropertyForKey';
+export * from './createUserProperty';
 export * from './delete';
 export * from './deleteContent';
 export * from './deleteContentProperty';
 export * from './deleteContentVersion';
 export * from './deleteLabelFromSpace';
+export * from './deletePageTree';
 export * from './deleteRelationship';
 export * from './deleteRestrictions';
 export * from './deleteSpace';
 export * from './deleteSpaceProperty';
+export * from './deleteUserProperty';
 export * from './descendantsOfType';
 export * from './downloadAttachment';
 export * from './exportAuditRecords';
@@ -49,6 +52,7 @@ export * from './getAnonymousUser';
 export * from './getAttachments';
 export * from './getAuditRecords';
 export * from './getAuditRecordsForTimePeriod';
+export * from './getAvailableContentStates';
 export * from './getBlueprintTemplates';
 export * from './getBulkUserLookup';
 export * from './getBulkUserMigration';
@@ -64,6 +68,9 @@ export * from './getContentProperties';
 export * from './getContentProperty';
 export * from './getContentRestrictionStatusForGroup';
 export * from './getContentRestrictionStatusForUser';
+export * from './getContentState';
+export * from './getContentStateLastUpdated';
+export * from './getContentStateSettings';
 export * from './getContentTemplate';
 export * from './getContentTemplates';
 export * from './getContentVersion';
@@ -105,6 +112,8 @@ export * from './getTasks';
 export * from './getTheme';
 export * from './getThemes';
 export * from './getUser';
+export * from './getUserProperties';
+export * from './getUserProperty';
 export * from './getViewers';
 export * from './getViews';
 export * from './getWatchersForSpace';
@@ -117,6 +126,7 @@ export * from './permissionCheck';
 export * from './publishLegacyDraft';
 export * from './publishSharedDraft';
 export * from './registerModules';
+export * from './removeContentState';
 export * from './removeContentWatcher';
 export * from './removeGroup';
 export * from './removeGroupById';
@@ -140,6 +150,7 @@ export * from './searchContentByCQL';
 export * from './searchGroups';
 export * from './searchTasks';
 export * from './searchUser';
+export * from './setContentState';
 export * from './setLookAndFeelSettings';
 export * from './setRetentionPeriod';
 export * from './setSpaceTheme';
@@ -155,4 +166,5 @@ export * from './updateSpace';
 export * from './updateSpaceProperty';
 export * from './updateSpaceSettings';
 export * from './updateTaskById';
+export * from './updateUserProperty';
 export * from './userSearch';

package/src/api/parameters/removeContentState.ts

@@ -0,0 +1,4 @@
+export interface RemoveContentState {
+  /** The Id of the content whose content state is to be set. */
+  contentId: string;
+}

package/src/api/parameters/searchGroups.ts

@@ -5,4 +5,9 @@ export interface SearchGroups {
   start?: number;
   /** The maximum number of groups to return per page. Note, this is restricted to a maximum limit of 200 groups. */
   limit?: number;
+  /**
+   * Whether to include total size parameter in the results. Note, fetching total size property is an expensive
+   * operation; use it if your use case needs this value.
+   */
+  shouldReturnTotalSize?: boolean;
 }

package/src/api/parameters/setContentState.ts

@@ -0,0 +1,8 @@
+export interface SetContentState {
+  /** The Id of the content whose content state is to be set. */
+  contentId: string;
+  /** The Id of the content */
+  contentStateId?: number;
+  name?: string;
+  color?: string;
+}

package/src/api/parameters/updateUserProperty.ts

@@ -0,0 +1,11 @@
+import { UserPropertyUpdate } from '../models';
+
+export interface UpdateUserProperty extends UserPropertyUpdate {
+  /**
+   * The account ID of the user. The accountId uniquely identifies the user across all Atlassian products. For
+   * example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192
+   */
+  userId: string;
+  /** The key of the user property. */
+  key: string;
+}

package/src/api/relation.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 Relation {

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 {

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 {
@@ -230,4 +230,26 @@ export class Settings {
 
     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) => `spaceKey=${key}`).join('&'),
+        spaceKey: paramSerializer('spaceKey', parameters?.spaceKey),
         spaceId: parameters?.spaceId,
         type: parameters?.type,
         status: parameters?.status,
@@ -129,6 +130,9 @@ export class Space {
     const config: RequestConfig = {
       url: `/api/space/${parameters.spaceKey}`,
       method: 'GET',
+      params: {
+        expand: parameters.expand,
+      },
     };
 
     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 {

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 {

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 {

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 {

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 {

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 {
@@ -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> {

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';

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/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 {