1.1.2

Author: MrRefactoring

.github/workflows/ci.yaml

@@ -26,7 +26,8 @@ jobs:
           echo EMAIL=${{ secrets.EMAIL }} >> .env
           echo API_TOKEN=${{ secrets.API_TOKEN }} >> .env
       - run: npm run build
-      - run: npm test
+      - run: npm run test:unit
+      - run: npm run test:e2e
       - run: npm run lint
         env:
           CI: true

CHANGELOG.md

@@ -1,8 +1,14 @@
 # Changelog
 
+### 1.1.2
+
+- `expand` property added to `Content.getContent` request.
+- `expand` property added to `Content.createContent` request.
+- `Content.updateContent` request body fixed. ([#6](https://github.com/MrRefactoring/confluence.js/issues/6) Thanks [eddiegroves](https://github.com/eddiegroves) for catching)
+
 ### 1.1.1
 
-- `expand` property added to `ContentAttachments.getAttachments`.
+- `expand` property added to `ContentAttachments.getAttachments`. ([#4](https://github.com/MrRefactoring/confluence.js/issues/4) Thanks [eddiegroves](https://github.com/eddiegroves) for catching)
 
 ### 1.1.0
 

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "confluence.js",
-  "version": "1.1.1",
+  "version": "1.1.2",
   "description": "confluence.js is a powerful Node.JS/Browser module that allows you to interact with the Confluence API very easily",
   "main": "out/index.js",
   "types": "out/index.d.ts",
@@ -37,8 +37,8 @@
     "@types/jest": "^26.0.24",
     "@types/oauth": "^0.9.1",
     "@types/sinon": "^10.0.2",
-    "@typescript-eslint/eslint-plugin": "^4.29.0",
-    "@typescript-eslint/parser": "^4.29.0",
+    "@typescript-eslint/eslint-plugin": "^4.29.1",
+    "@typescript-eslint/parser": "^4.29.1",
     "dotenv": "^10.0.0",
     "eslint": "^7.32.0",
     "eslint-config-airbnb-typescript": "^12.3.1",
@@ -57,6 +57,6 @@
     "axios": "^0.21.1",
     "oauth": "^0.9.15",
     "telemetry.confluence.js": "<2",
-    "tslib": "^2.3.0"
+    "tslib": "^2.3.1"
   }
 }

package.json

@@ -45,6 +45,7 @@ export class Content {
         orderby: parameters?.orderby,
         start: parameters?.start,
         limit: parameters?.limit,
+        expand: parameters?.expand,
       },
     };
 
@@ -89,6 +90,7 @@ export class Content {
       method: 'POST',
       params: {
         status: parameters?.status,
+        expand: parameters?.expand,
       },
       data: {
         ...parameters,
@@ -346,7 +348,14 @@ export class Content {
         status: parameters.status,
         conflictPolicy: parameters.conflictPolicy,
       },
-      data: parameters.body,
+      data: {
+        version: parameters.version,
+        title: parameters.title,
+        type: parameters.type,
+        status: parameters.statusBody,
+        ancestors: parameters.ancestors,
+        body: parameters.body,
+      },
     };
 
     return this.client.sendRequest(config, callback, { methodName: 'updateContent' });

src/api/content.ts

@@ -20,7 +20,7 @@ export interface ContentUpdate {
    * The updated status of the content. Note, if you change the status of a page from 'current' to 'draft' and it has an
    * existing draft, the existing draft will be deleted in favor of the updated page.
    */
-  status?: string;
+  status?: 'current' | 'trashed' | 'historical' | 'draft' | string;
   /** The new parent for the content. Only one parent content 'id' can be specified. */
   ancestors?: {
     /** The `id` of the parent content. */

src/api/models/contentUpdate.ts

@@ -4,5 +4,90 @@ export interface CreateContent extends ContentCreate {
   /** Filter the returned content by status. */
   status?: string;
   /** A multi-value parameter indicating which properties of the content to expand. */
-  expand?: string[];
+  expand?: string | string[] | CreateContent.Expand | CreateContent.Expand[];
+}
+
+export namespace CreateContent {
+  export enum Expand {
+    /**
+     * Returns whether the content has attachments, comments, or child pages. Use this if you only need to check whether
+     * the content has children of a particular type.
+     */
+    AllChildTypes = 'childTypes.all',
+    /** Returns whether the content has attachments. */
+    AttachmentChildType = 'childTypes.attachment',
+    /** Returns whether the content has comments. */
+    CommentChildType = 'childTypes.comment',
+    /** Returns whether the content has child pages. */
+    PageChildType = 'childTypes.page',
+    /**
+     * Returns the space that the content is in. This is the same as the information returned by [Get
+     * space](https://developer.atlassian.com/cloud/confluence/rest/api-group-content---attachments/).
+     */
+    Container = 'container',
+    /**
+     * Returns information about the current user in relation to the content, including when they last viewed it,
+     * modified it, contributed to it, or added it as a favorite.
+     */
+    CurrentUserMetadata = 'metadata.currentuser',
+    /** Returns content properties that have been set via the Confluence REST API. */
+    PropertiesMetadata = 'metadata.properties',
+    /** Returns the labels that have been added to the content. */
+    LabelsMetadata = 'metadata.labels',
+    /** This property is only used by Atlassian. */
+    FrontendMetadata = 'metadata.frontend',
+    /** Returns the operations for the content, which are used when setting permissions. */
+    Operations = 'operations',
+    /** Returns pages that are descendants at the level immediately below the content. */
+    PageChildren = 'children.page',
+    /** Returns all attachments for the content. */
+    AttachmentChildren = 'children.attachment',
+    /** Returns all comments on the content. */
+    CommentChildren = 'children.comment',
+    /** Returns the users that have permission to read the content. */
+    ReadUserRestriction = 'restrictions.read.restrictions.user',
+    /**
+     * Returns the groups that have permission to read the content. Note that this may return deleted groups, because
+     * deleting a group doesn't remove associated restrictions.
+     */
+    ReadGroupRestriction = 'restrictions.read.restrictions.group',
+    /** Returns the users that have permission to update the content. */
+    UpdateUserRestriction = 'restrictions.update.restrictions.user',
+    /**
+     * Returns the groups that have permission to update the content. Note that this may return deleted groups because
+     * deleting a group doesn't remove associated restrictions.
+     */
+    UpdateGroupRestriction = 'restrictions.update.restrictions.group',
+    /** Returns the history of the content, including the date it was created. */
+    History = 'history',
+    /** Returns information about the most recent update of the content, including who updated it and when it was updated. */
+    LastUpdated = 'history.lastUpdated',
+    /** Returns information about the update prior to the current content update. */
+    PreviousVersion = 'history.previousVersion',
+    /** Returns all of the users who have contributed to the content. */
+    Contributors = 'history.contributors',
+    /** Returns information about the update after to the current content update. */
+    NextVersion = 'history.nextVersion',
+    /** Returns the parent page, if the content is a page. */
+    Ancestors = 'ancestors',
+    /** Returns the body of the content in different formats, including the editor format, view format, and export format. */
+    Body = 'body',
+    /** Returns information about the most recent update of the content, including who updated it and when it was updated. */
+    Version = 'version',
+    /** Returns pages that are descendants at any level below the content. */
+    PageDescendant = 'descendants.page',
+    /** Returns all attachments for the content, same as `children.attachment`. */
+    AttachmentDescendant = 'descendants.attachment',
+    /** Returns all comments on the content, same as `children.comment`. */
+    CommentDescendant = 'descendants.comment',
+    /**
+     * Returns the space that the content is in. This is the same as the information returned by [Get
+     * space](https://developer.atlassian.com/cloud/confluence/rest/api-group-content---attachments/).
+     */
+    Space = 'space',
+    /** Returns inline comment-specific properties. */
+    InlineProperties = 'extensions.inlineProperties',
+    /** Returns the resolution status of each comment. */
+    Resolution = 'extensions.resolution',
+  }
 }