confluence.js 1.5.2 → 1.5.3

package/src/server/contentBody.ts

@@ -11,16 +11,11 @@ export class ContentBody {
    * Converts between content body representations. Not all representations can be converted to/from other formats.
    * Supported conversions:
    *
-   * - Storageview,export_view,styled_view,editor
+   * - Storageview, export_view, styled_view, editor
    * - Editorstorage
    * - ViewNone
    * - Export_viewNone
    * - Styled_viewNone
-   *
-   * @example
-   *   Example request URI(s):
-   *
-   *   - http://example.com/rest/api/contentbody/convert/view
    */
   async convertContentBody<T = Models.ContentBody>(
     parameters: Parameters.ConvertContentBody,
@@ -30,16 +25,11 @@ export class ContentBody {
    * Converts between content body representations. Not all representations can be converted to/from other formats.
    * Supported conversions:
    *
-   * - Storageview,export_view,styled_view,editor
+   * - Storageview, export_view, styled_view, editor
    * - Editorstorage
    * - ViewNone
    * - Export_viewNone
    * - Styled_viewNone
-   *
-   * @example
-   *   Example request URI(s):
-   *
-   *   - http://example.com/rest/api/contentbody/convert/view
    */
   async convertContentBody<T = Models.ContentBody>(
     parameters: Parameters.ConvertContentBody,
@@ -58,6 +48,7 @@ export class ContentBody {
         view: parameters.view,
         export_view: parameters.exportView,
         styled_view: parameters.styledView,
+        expand: parameters.expand,
       },
       data: {
         ...parameters,
@@ -70,6 +61,6 @@ export class ContentBody {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'server.convertContentBody' });
+    return this.client.sendRequest(config, callback);
   }
 }

package/src/server/group.ts

@@ -29,7 +29,7 @@ export class Group {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'server.getGroups' });
+    return this.client.sendRequest(config, callback);
   }
 
   /** Get the user group with the group name */
@@ -45,7 +45,7 @@ export class Group {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'server.getGroup' });
+    return this.client.sendRequest(config, callback);
   }
 
   /** Get a paginated collection of users in the given group */
@@ -69,6 +69,6 @@ export class Group {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'server.getMembers' });
+    return this.client.sendRequest(config, callback);
   }
 }

package/src/server/longTask.ts

@@ -29,7 +29,7 @@ export class LongTask {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'server.getTasks' });
+    return this.client.sendRequest(config, callback);
   }
 
   /** Returns information about a long-running task. */
@@ -45,6 +45,6 @@ export class LongTask {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'server.getTask' });
+    return this.client.sendRequest(config, callback);
   }
 }

package/src/server/parameters/convertContentBody.ts

@@ -1,4 +1,5 @@
 export interface ConvertContentBody {
+  /** The name of the target format for the content body. */
   to: string;
 
   storage?: any;
@@ -7,5 +8,41 @@ export interface ConvertContentBody {
   exportView?: any;
   styledView?: any;
 
+  /**
+   * A multi-value parameter indicating which properties of the content to expand. Expands are dependent on the to
+   * conversion format and may be irrelevant for certain conversions (e.g. macroRenderedOutput is redundant when
+   * converting to view format).
+   *
+   * - `webresource` returns JS and CSS resources necessary for displaying nested content in `view` format
+   * - `webresource.superbatch.uris.js` returns all common JS dependencies
+   * - `webresource.superbatch.uris.css` returns all common CSS dependencies
+   * - `webresource.uris.js` returns JS dependencies specific to conversion
+   * - `webresource.uris.css` returns CSS dependencies specific to conversion
+   * - `embeddedContent` returns metadata for nested content (e.g. page included using page include macro)
+   * - `mediaToken` returns JWT token for retrieving attachment data from Media API
+   * - `macroRenderedOutput` additionally converts body to view format
+   */
+  expand?:
+  | 'webresource'
+  | 'webresource.superbatch.uris.js'
+  | 'webresource.superbatch.uris.css'
+  | 'webresource.uris.js'
+  | 'webresource.uris.css'
+  | 'embeddedContent'
+  | 'mediaToken'
+  | 'macroRenderedOutput'
+  | (
+    | 'webresource'
+    | 'webresource.superbatch.uris.js'
+    | 'webresource.superbatch.uris.css'
+    | 'webresource.uris.js'
+    | 'webresource.uris.css'
+    | 'embeddedContent'
+    | 'mediaToken'
+    | 'macroRenderedOutput'
+  )[]
+  | string
+  | string[];
+
   [key: string]: any;
 }

package/src/server/search.ts

@@ -8,32 +8,12 @@ import { RequestConfig } from '../requestConfig';
 export class Search {
   constructor(private client: Client) {}
 
-  /**
-   * Search for entities in Confluence using the Confluence Query Language (CQL)
-   *
-   * @example
-   *   For example :
-   *
-   *   Example request URI(s):
-   *
-   *   - http://localhost:8080/confluence/rest/api/search?cql=creator=currentUser()&type%20in%20(space,page,user)&cqlcontext={%22spaceKey%22:%22TST%22,%22contentId%22:%2255%22}
-   *   - http://localhost:8080/confluence/rest/api/search?cql=siteSearch~'example'%20AND%20label=docs&expand=content.space,space.homepage&limit=10
-   */
+  /** Search for entities in Confluence using the Confluence Query Language (CQL) */
   async search<T = Pagination<Models.SearchResult>>(
     parameters: Parameters.SearchContent | undefined,
     callback: Callback<T>
   ): Promise<void>;
-  /**
-   * Search for entities in Confluence using the Confluence Query Language (CQL)
-   *
-   * @example
-   *   For example :
-   *
-   *   Example request URI(s):
-   *
-   *   - http://localhost:8080/confluence/rest/api/search?cql=creator=currentUser()&type%20in%20(space,page,user)&cqlcontext={%22spaceKey%22:%22TST%22,%22contentId%22:%2255%22}
-   *   - http://localhost:8080/confluence/rest/api/search?cql=siteSearch~'example'%20AND%20label=docs&expand=content.space,space.homepage&limit=10
-   */
+  /** Search for entities in Confluence using the Confluence Query Language (CQL) */
   async search<T = Pagination<Models.SearchResult>>(
     parameters?: Parameters.SearchContent,
     callback?: never
@@ -56,6 +36,6 @@ export class Search {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'server.search' });
+    return this.client.sendRequest(config, callback);
   }
 }

package/src/server/space.ts

@@ -8,24 +8,12 @@ import { RequestConfig } from '../requestConfig';
 export class Space {
   constructor(private client: Client) {}
 
-  /**
-   * Returns information about a number of spaces.
-   *
-   * Example request URI(s):
-   *
-   * - http://example.com/rest/api/space?spaceKey=TST&spaceKey=ds
-   */
+  /** Returns information about a number of spaces. */
   async getSpaces<T = Pagination<Models.Space>>(
     parameters: Parameters.GetSpaces | undefined,
     callback: Callback<T>
   ): Promise<void>;
-  /**
-   * Returns information about a number of spaces.
-   *
-   * Example request URI(s):
-   *
-   * - http://example.com/rest/api/space?spaceKey=TST&spaceKey=ds
-   */
+  /** Returns information about a number of spaces. */
   async getSpaces<T = Pagination<Models.Space>>(parameters?: Parameters.GetSpaces, callback?: never): Promise<T>;
   async getSpaces<T = Pagination<Models.Space>>(
     parameters?: Parameters.GetSpaces,
@@ -46,7 +34,7 @@ export class Space {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'server.getSpaces' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -73,7 +61,7 @@ export class Space {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'server.createSpace' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -105,26 +93,12 @@ export class Space {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'server.createPrivateSpace' });
+    return this.client.sendRequest(config, callback);
   }
 
-  /**
-   * Returns information about a space.
-   *
-   * @example
-   *   Example request URI(s):
-   *
-   *   - http://example.com/rest/api/space/TST?expand=description
-   */
+  /** Returns information about a space. */
   async getSpace<T = Models.Space>(parameters: Parameters.GetSpace, callback: Callback<T>): Promise<void>;
-  /**
-   * Returns information about a space.
-   *
-   * @example
-   *   Example request URI(s):
-   *
-   *   - http://example.com/rest/api/space/TST?expand=description
-   */
+  /** Returns information about a space. */
   async getSpace<T = Models.Space>(parameters: Parameters.GetSpace, callback?: never): Promise<T>;
   async getSpace<T = Models.Space>(parameters: Parameters.GetSpace, callback?: Callback<T>): Promise<void | T> {
     const config: RequestConfig = {
@@ -135,7 +109,7 @@ export class Space {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'server.getSpace' });
+    return this.client.sendRequest(config, callback);
   }
 
   /** Updates a Space. Currently only the Space name, description and homepage can be updated. */
@@ -153,7 +127,7 @@ export class Space {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'server.updateSpace' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -179,29 +153,15 @@ export class Space {
       method: 'DELETE',
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'server.deleteSpace' });
+    return this.client.sendRequest(config, callback);
   }
 
-  /**
-   * Returns the content in this given space
-   *
-   * @example
-   *   Example request URI(s):
-   *
-   *   - http://example.com/rest/api/space/TEST/content?expand=history
-   */
+  /** Returns the content in this given space */
   async getContentForSpace<T = Pagination<Models.Content>>(
     parameters: Parameters.GetContentForSpace,
     callback: Callback<T>
   ): Promise<void>;
-  /**
-   * Returns the content in this given space
-   *
-   * @example
-   *   Example request URI(s):
-   *
-   *   - http://example.com/rest/api/space/TEST/content?expand=history
-   */
+  /** Returns the content in this given space */
   async getContentForSpace<T = Pagination<Models.Content>>(
     parameters: Parameters.GetContentForSpace,
     callback?: never
@@ -221,29 +181,15 @@ export class Space {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'server.getContentForSpace' });
+    return this.client.sendRequest(config, callback);
   }
 
-  /**
-   * Returns the content in this given space with the given type
-   *
-   * @example
-   *   Example request URI(s):
-   *
-   *   - http://example.com/rest/api/space/TEST/content/page?expand=history
-   */
+  /** Returns the content in this given space with the given type */
   async getContentByType<T = Pagination<Models.Content>>(
     parameters: Parameters.GetContentByType,
     callback: Callback<T>
   ): Promise<void>;
-  /**
-   * Returns the content in this given space with the given type
-   *
-   * @example
-   *   Example request URI(s):
-   *
-   *   - http://example.com/rest/api/space/TEST/content/page?expand=history
-   */
+  /** Returns the content in this given space with the given type */
   async getContentByType<T = Pagination<Models.Content>>(
     parameters: Parameters.GetContentByType,
     callback?: never
@@ -263,29 +209,15 @@ export class Space {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'server.getContentByType' });
+    return this.client.sendRequest(config, callback);
   }
 
-  /**
-   * Returns a paginated list of space properties.
-   *
-   * @example
-   *   Example request URI:
-   *
-   *   - http://example.com/rest/experimental/space/TST/property?expand=space,version
-   */
+  /** Returns a paginated list of space properties. */
   async getSpaceProperties<T = Pagination<Models.SpaceProperty>>(
     parameters: Parameters.GetSpaceProperties,
     callback: Callback<T>
   ): Promise<void>;
-  /**
-   * Returns a paginated list of space properties.
-   *
-   * @example
-   *   Example request URI:
-   *
-   *   - http://example.com/rest/experimental/space/TST/property?expand=space,version
-   */
+  /** Returns a paginated list of space properties. */
   async getSpaceProperties<T = Pagination<Models.SpaceProperty>>(
     parameters: Parameters.GetSpaceProperties,
     callback?: never
@@ -304,7 +236,7 @@ export class Space {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'server.getSpaceProperties' });
+    return this.client.sendRequest(config, callback);
   }
 
   /** Creates a new space property. */
@@ -330,29 +262,15 @@ export class Space {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'server.createSpaceProperty' });
+    return this.client.sendRequest(config, callback);
   }
 
-  /**
-   * Returns a paginated list of space properties.
-   *
-   * @example
-   *   Example request URI:
-   *
-   *   - http://example.com/rest/experimental/space/TST/property?expand=space,version
-   */
+  /** Returns a paginated list of space properties. */
   async getSpaceProperty<T = Models.SpaceProperty>(
     parameters: Parameters.GetSpaceProperty,
     callback: Callback<T>
   ): Promise<void>;
-  /**
-   * Returns a paginated list of space properties.
-   *
-   * @example
-   *   Example request URI:
-   *
-   *   - http://example.com/rest/experimental/space/TST/property?expand=space,version
-   */
+  /** Returns a paginated list of space properties. */
   async getSpaceProperty<T = Models.SpaceProperty>(
     parameters: Parameters.GetSpaceProperty,
     callback?: never
@@ -369,7 +287,7 @@ export class Space {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'server.getSpaceProperty' });
+    return this.client.sendRequest(config, callback);
   }
 
   /** Creates a new space property. */
@@ -394,7 +312,7 @@ export class Space {
       },
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'server.createSpacePropertyForKey' });
+    return this.client.sendRequest(config, callback);
   }
 
   /**
@@ -424,7 +342,7 @@ export class Space {
       method: 'PUT',
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'server.updateSpaceProperty' });
+    return this.client.sendRequest(config, callback);
   }
 
   /** Deletes a space property. */
@@ -440,6 +358,6 @@ export class Space {
       method: 'DELETE',
     };
 
-    return this.client.sendRequest(config, callback, { methodName: 'server.deleteSpaceProperty' });
+    return this.client.sendRequest(config, callback);
   }
 }