@pipedream/confluence_data_center 0.0.1 → 0.1.0

package/actions/create-content/create-content.mjs

@@ -0,0 +1,89 @@
+import confluenceDataCenter from "../../confluence_data_center.app.mjs";
+import { parseObjectEntries } from "../../common/utils.mjs";
+
+export default {
+  key: "confluence_data_center-create-content",
+  name: "Create Content",
+  description: "Creates a new page or blogpost in Confluence Data Center. [See the documentation](https://developer.atlassian.com/server/confluence/rest/v1022/api-group-content-resource/#api-rest-api-content-post)",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
+  props: {
+    confluenceDataCenter,
+    type: {
+      propDefinition: [
+        confluenceDataCenter,
+        "type",
+      ],
+    },
+    title: {
+      propDefinition: [
+        confluenceDataCenter,
+        "title",
+      ],
+    },
+    status: {
+      propDefinition: [
+        confluenceDataCenter,
+        "status",
+      ],
+    },
+    spaceKey: {
+      propDefinition: [
+        confluenceDataCenter,
+        "spaceKey",
+      ],
+    },
+    position: {
+      propDefinition: [
+        confluenceDataCenter,
+        "position",
+      ],
+    },
+    body: {
+      propDefinition: [
+        confluenceDataCenter,
+        "body",
+      ],
+    },
+    metadata: {
+      propDefinition: [
+        confluenceDataCenter,
+        "metadata",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const response = await this.confluenceDataCenter.createContent({
+      $,
+      data: {
+        type: this.type,
+        title: this.title,
+        status: this.status,
+        space: this.spaceKey
+          ? {
+            key: this.spaceKey,
+          }
+          : undefined,
+        position: this.position,
+        body: this.body
+          ? {
+            storage: {
+              value: this.body,
+              representation: "storage",
+            },
+          }
+          : undefined,
+        metadata: this.metadata
+          ? parseObjectEntries(this.metadata)
+          : undefined,
+      },
+    });
+    $.export("$summary", `Successfully created content with ID: ${response.id}`);
+    return response;
+  },
+};

package/actions/delete-content/delete-content.mjs

@@ -0,0 +1,40 @@
+import confluenceDataCenter from "../../confluence_data_center.app.mjs";
+
+export default {
+  key: "confluence_data_center-delete-content",
+  name: "Delete Content",
+  description: "Deletes a page or blogpost in Confluence Data Center. [See the documentation](https://developer.atlassian.com/server/confluence/rest/v1022/api-group-content-resource/#api-rest-api-content-id-delete)",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: true,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
+  props: {
+    confluenceDataCenter,
+    type: {
+      propDefinition: [
+        confluenceDataCenter,
+        "type",
+      ],
+    },
+    contentId: {
+      propDefinition: [
+        confluenceDataCenter,
+        "contentId",
+        ({ type }) => ({
+          type,
+        }),
+      ],
+    },
+  },
+  async run({ $ }) {
+    const response = await this.confluenceDataCenter.deleteContent({
+      $,
+      id: this.contentId,
+    });
+    $.export("$summary", `Successfully deleted content with ID: ${this.contentId}`);
+    return response;
+  },
+};

package/actions/get-page-by-id/get-page-by-id.mjs

@@ -0,0 +1,33 @@
+import confluenceDataCenter from "../../confluence_data_center.app.mjs";
+
+export default {
+  key: "confluence_data_center-get-page-by-id",
+  name: "Get Page by ID",
+  description: "Retrieve a page by its ID. [See the documentation](https://developer.atlassian.com/server/confluence/rest/v1022/api-group-content-resource/#api-rest-api-content-id-get)",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  props: {
+    confluenceDataCenter,
+    pageId: {
+      propDefinition: [
+        confluenceDataCenter,
+        "contentId",
+      ],
+      label: "Page ID",
+      description: "Select a page or provide its ID",
+    },
+  },
+  async run({ $ }) {
+    const response = await this.confluenceDataCenter.getContentById({
+      $,
+      id: this.pageId,
+    });
+    $.export("$summary", `Successfully retrieved page with ID: ${this.pageId}`);
+    return response;
+  },
+};

package/actions/get-pages/get-pages.mjs

@@ -0,0 +1,50 @@
+import confluenceDataCenter from "../../confluence_data_center.app.mjs";
+
+export default {
+  key: "confluence_data_center-get-pages",
+  name: "Get Pages",
+  description: "Retrieve a list of pages in Confluence Data Center. [See the documentation](https://developer.atlassian.com/server/confluence/rest/v1022/api-group-content-resource/#api-rest-api-content-get)",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  props: {
+    confluenceDataCenter,
+    spaceKey: {
+      propDefinition: [
+        confluenceDataCenter,
+        "spaceKey",
+      ],
+      optional: true,
+    },
+    limit: {
+      propDefinition: [
+        confluenceDataCenter,
+        "limit",
+      ],
+    },
+    start: {
+      propDefinition: [
+        confluenceDataCenter,
+        "start",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const response = await this.confluenceDataCenter.listContent({
+      $,
+      params: {
+        spaceKey: this.spaceKey,
+        limit: this.limit,
+        start: this.start,
+      },
+    });
+    $.export("$summary", `Successfully retrieved ${response.results.length} page${response.results.length === 1
+      ? ""
+      : "s"}`);
+    return response;
+  },
+};

package/actions/search-content/search-content.mjs

@@ -0,0 +1,48 @@
+import confluenceDataCenter from "../../confluence_data_center.app.mjs";
+
+export default {
+  key: "confluence_data_center-search-content",
+  name: "Search Content",
+  description: "Search for content in Confluence Data Center. [See the documentation](https://developer.atlassian.com/server/confluence/rest/v1022/api-group-content-resource/#api-rest-api-content-search-get)",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  props: {
+    confluenceDataCenter,
+    cql: {
+      type: "string",
+      label: "CQL",
+      description: "The CQL query to be used for the search. See [Advanced Searching using CQL](https://developer.atlassian.com/server/confluence/advanced-searching-using-cql/) for instructions on how to build a CQL query.",
+    },
+    limit: {
+      propDefinition: [
+        confluenceDataCenter,
+        "limit",
+      ],
+    },
+    start: {
+      propDefinition: [
+        confluenceDataCenter,
+        "start",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const response = await this.confluenceDataCenter.searchContent({
+      $,
+      params: {
+        cql: this.cql,
+        limit: this.limit,
+        start: this.start,
+      },
+    });
+    $.export("$summary", `Successfully found ${response.results.length} result${response.results.length === 1
+      ? ""
+      : "s"}`);
+    return response;
+  },
+};

package/actions/update-content/update-content.mjs

@@ -0,0 +1,89 @@
+import confluenceDataCenter from "../../confluence_data_center.app.mjs";
+import { parseObjectEntries } from "../../common/utils.mjs";
+
+export default {
+  key: "confluence_data_center-update-content",
+  name: "Update Content",
+  description: "Updates a page or blogpost in Confluence Data Center. [See the documentation](https://developer.atlassian.com/server/confluence/rest/v1022/api-group-content-resource/#api-rest-api-content-contentid-put)",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: true,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
+  props: {
+    confluenceDataCenter,
+    type: {
+      propDefinition: [
+        confluenceDataCenter,
+        "type",
+      ],
+    },
+    contentId: {
+      propDefinition: [
+        confluenceDataCenter,
+        "contentId",
+        ({ type }) => ({
+          type,
+        }),
+      ],
+    },
+    title: {
+      propDefinition: [
+        confluenceDataCenter,
+        "title",
+      ],
+    },
+    position: {
+      propDefinition: [
+        confluenceDataCenter,
+        "position",
+      ],
+    },
+    body: {
+      propDefinition: [
+        confluenceDataCenter,
+        "body",
+      ],
+    },
+    metadata: {
+      propDefinition: [
+        confluenceDataCenter,
+        "metadata",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const { version: { number } } = await this.confluenceDataCenter.getContentById({
+      $,
+      id: this.contentId,
+    });
+    const version = number + 1;
+    const response = await this.confluenceDataCenter.updateContent({
+      $,
+      id: this.contentId,
+      data: {
+        type: this.type,
+        title: this.title,
+        position: this.position,
+        body: this.body
+          ? {
+            storage: {
+              value: this.body,
+              representation: "storage",
+            },
+          }
+          : undefined,
+        metadata: this.metadata
+          ? parseObjectEntries(this.metadata)
+          : undefined,
+        version: {
+          number: version,
+        },
+      },
+    });
+    $.export("$summary", `Successfully updated content with ID: ${this.contentId}`);
+    return response;
+  },
+};

package/common/utils.mjs

@@ -0,0 +1,33 @@
+import { ConfigurationError } from "@pipedream/platform";
+
+function optionalParseAsJSON(value) {
+  if (typeof value !== "string") {
+    return value;
+  }
+
+  try {
+    return JSON.parse(value);
+  } catch (e) {
+    return value;
+  }
+}
+
+export function parseObjectEntries(obj = {}) {
+  if (typeof obj === "string") {
+    try {
+      obj = JSON.parse(obj);
+    } catch (e) {
+      throw new ConfigurationError(`Invalid JSON string provided: ${e.message}`);
+    }
+  }
+
+  return Object.fromEntries(
+    Object.entries(obj || {}).map(([
+      key,
+      value,
+    ]) => [
+      key,
+      optionalParseAsJSON(value),
+    ]),
+  );
+}

package/confluence_data_center.app.mjs

@@ -1,11 +1,190 @@
+import { axios } from "@pipedream/platform";
+const DEFAULT_LIMIT = 50;
+
 export default {
   type: "app",
   app: "confluence_data_center",
-  propDefinitions: {},
+  propDefinitions: {
+    spaceKey: {
+      type: "string",
+      label: "Space Key",
+      description: "Select a space or provide its key",
+      async options({ page }) {
+        const { results } = await this.listSpaces({
+          params: {
+            limit: DEFAULT_LIMIT,
+            start: page * DEFAULT_LIMIT,
+          },
+        });
+        return results?.map(({
+          key: value, name: label,
+        }) => ({
+          value,
+          label,
+        })) || [];
+      },
+    },
+    contentId: {
+      type: "string",
+      label: "Content ID",
+      description: "Select a page or blogpost or provide its ID",
+      async options({
+        page, type,
+      }) {
+        const { results } = await this.listContent({
+          params: {
+            type,
+            limit: DEFAULT_LIMIT,
+            start: page * DEFAULT_LIMIT,
+          },
+        });
+        return results?.map(({
+          id: value, title: label,
+        }) => ({
+          value,
+          label,
+        })) || [];
+      },
+    },
+    type: {
+      type: "string",
+      label: "Type",
+      description: "The type of the content",
+      async options() {
+        return [
+          "page",
+          "blogpost",
+        ];
+      },
+    },
+    title: {
+      type: "string",
+      label: "Title",
+      description: "The title of the content",
+    },
+    status: {
+      type: "string",
+      label: "Status",
+      description: "The status of the content",
+      optional: true,
+      options: [
+        "current",
+        "draft",
+      ],
+    },
+    position: {
+      type: "integer",
+      label: "Position",
+      description: "The position of the content",
+      optional: true,
+    },
+    body: {
+      type: "string",
+      label: "Body",
+      description: "The body content of the content",
+      optional: true,
+    },
+    metadata: {
+      type: "object",
+      label: "Metadata",
+      description: "The metadata of the content",
+      optional: true,
+    },
+    limit: {
+      type: "integer",
+      label: "Limit",
+      description: "Maximum number of results to return",
+      optional: true,
+      default: 100,
+    },
+    start: {
+      type: "integer",
+      label: "Start",
+      description: "Start index of the results to return",
+      optional: true,
+    },
+  },
   methods: {
-    // this.$auth contains connected account data
-    authKeys() {
-      console.log(Object.keys(this.$auth));
+    _baseUrl() {
+      return `${this.$auth.api_url}/rest/api`;
+    },
+    _makeRequest({
+      $ = this, path, ...opts
+    }) {
+      return axios($, {
+        url: `${this._baseUrl()}${path}`,
+        headers: {
+          "Authorization": `Bearer ${this.$auth.personal_access_token}`,
+        },
+        ...opts,
+      });
+    },
+    createWebhook(opts = {}) {
+      return this._makeRequest({
+        path: "/webhooks",
+        method: "POST",
+        ...opts,
+      });
+    },
+    deleteWebhook({
+      hookId, ...opts
+    }) {
+      return this._makeRequest({
+        path: `/webhooks/${hookId}`,
+        method: "DELETE",
+        ...opts,
+      });
+    },
+    getContentById({
+      id, ...opts
+    }) {
+      return this._makeRequest({
+        path: `/content/${id}`,
+        ...opts,
+      });
+    },
+    listSpaces(opts = {}) {
+      return this._makeRequest({
+        path: "/space",
+        ...opts,
+      });
+    },
+    listContent(opts = {}) {
+      return this._makeRequest({
+        path: "/content",
+        ...opts,
+      });
+    },
+    searchContent(opts = {}) {
+      return this._makeRequest({
+        path: "/content/search",
+        ...opts,
+      });
+    },
+    createContent(opts = {}) {
+      return this._makeRequest({
+        path: "/content",
+        method: "POST",
+        ...opts,
+      });
+    },
+    updateContent({
+      id, ...opts
+    }) {
+      return this._makeRequest({
+        path: `/content/${id}`,
+        method: "PUT",
+        ...opts,
+      });
+    },
+    deleteContent({
+      id, ...opts
+    }) {
+      return this._makeRequest({
+        path: `/content/${id}`,
+        method: "DELETE",
+        ...opts,
+      });
     },
   },
-};
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/confluence_data_center",
-  "version": "0.0.1",
+  "version": "0.1.0",
   "description": "Pipedream Confluence Data Center Components",
   "main": "confluence_data_center.app.mjs",
   "keywords": [
@@ -11,5 +11,8 @@
   "author": "Pipedream <support@pipedream.com> (https://pipedream.com/)",
   "publishConfig": {
     "access": "public"
+  },
+  "dependencies": {
+    "@pipedream/platform": "^3.1.1"
   }
 }

package/sources/blogpost-updated/blogpost-updated.mjs

@@ -0,0 +1,21 @@
+import common from "../common/base-webhook.mjs";
+import sampleEmit from "./test-event.mjs";
+
+export default {
+  ...common,
+  key: "confluence_data_center-blogpost-updated",
+  name: "Blogpost Updated (Instant)",
+  description: "Emit new event when a blogpost is updated in Confluence Data Center.",
+  version: "0.0.1",
+  type: "source",
+  dedupe: "unique",
+  methods: {
+    ...common.methods,
+    getEvents() {
+      return [
+        "blog_updated",
+      ];
+    },
+  },
+  sampleEmit,
+};

package/sources/blogpost-updated/test-event.mjs

@@ -0,0 +1,8 @@
+export default {
+  "timestamp": 1768245930653,
+  "event": "blog_updated",
+  "userKey": "ff8081819ba46873019ba46aefbb0000",
+  "blog": {
+    "id": 1015811
+  }
+}

package/sources/common/base-webhook.mjs

@@ -0,0 +1,69 @@
+import confluenceDataCenter from "../../confluence_data_center.app.mjs";
+import { ConfigurationError } from "@pipedream/platform";
+
+export default {
+  props: {
+    confluenceDataCenter,
+    db: "$.service.db",
+    http: {
+      type: "$.interface.http",
+      customResponse: true,
+    },
+    name: {
+      type: "string",
+      label: "Webhook Name",
+      description: "The name of the webhook to identify in Confluence Data Center",
+    },
+  },
+  hooks: {
+    async activate() {
+      const response = await this.confluenceDataCenter.createWebhook({
+        data: {
+          name: this.name,
+          url: this.http.endpoint,
+          events: this.getEvents(),
+        },
+      });
+      this._setHookId(response.id);
+    },
+    async deactivate() {
+      const hookId = this._getHookId();
+      if (hookId) {
+        await this.confluenceDataCenter.deleteWebhook({
+          hookId,
+        });
+      }
+    },
+  },
+  methods: {
+    _setHookId(hookId) {
+      this.db.set("hookId", hookId);
+    },
+    _getHookId() {
+      return this.db.get("hookId");
+    },
+    generateMeta(body) {
+      return {
+        id: body.timestamp,
+        summary: `New ${body.event} event`,
+        ts: body.timestamp,
+      };
+    },
+    getEvents() {
+      throw new ConfigurationError("getEvents is not implemented");
+    },
+  },
+  async run(event) {
+    this.http.respond({
+      status: 200,
+    });
+
+    const { body } = event;
+
+    if (!body) {
+      return;
+    }
+
+    this.$emit(body, this.generateMeta(body));
+  },
+};

package/sources/common/events.mjs

@@ -0,0 +1,45 @@
+export default [
+  "attachment_created",
+  "attachment_removed",
+  "attachment_restored",
+  "attachment_trashed",
+  "attachment_updated",
+  "blog_created",
+  "blog_removed",
+  "blog_restored",
+  "blog_trashed",
+  "blog_updated",
+  "blueprint_page_created",
+  "comment_created",
+  "comment_removed",
+  "comment_updated",
+  "content_created",
+  "content_restored",
+  "content_trashed",
+  "content_updated",
+  "content_permissions_updated",
+  "group_created",
+  "group_removed",
+  "label_added",
+  "label_created",
+  "label_deleted",
+  "label_removed",
+  "page_children_reordered",
+  "page_created",
+  "page_moved",
+  "page_removed",
+  "page_restored",
+  "page_trashed",
+  "page_updated",
+  "space_created",
+  "space_logo_updated",
+  "space_permissions_updated",
+  "space_removed",
+  "space_updated",
+  "theme_enabled",
+  "user_created",
+  "user_deactivated",
+  "user_followed",
+  "user_reactivated",
+  "user_removed",
+];

package/sources/new-blogpost-created/new-blogpost-created.mjs

@@ -0,0 +1,21 @@
+import common from "../common/base-webhook.mjs";
+import sampleEmit from "./test-event.mjs";
+
+export default {
+  ...common,
+  key: "confluence_data_center-new-blogpost-created",
+  name: "New Blogpost Created (Instant)",
+  description: "Emit new event when a new blogpost is created in Confluence Data Center.",
+  version: "0.0.1",
+  type: "source",
+  dedupe: "unique",
+  methods: {
+    ...common.methods,
+    getEvents() {
+      return [
+        "blog_created",
+      ];
+    },
+  },
+  sampleEmit,
+};

package/sources/new-blogpost-created/test-event.mjs

@@ -0,0 +1,8 @@
+export default {
+  "timestamp": 1768245776689,
+  "event": "blog_created",
+  "userKey": "ff8081819ba46873019ba46aefbb0000",
+  "blog": {
+    "id": 1015813
+  }
+}

package/sources/new-page-created/new-page-created.mjs

@@ -0,0 +1,21 @@
+import common from "../common/base-webhook.mjs";
+import sampleEmit from "./test-event.mjs";
+
+export default {
+  ...common,
+  key: "confluence_data_center-new-page-created",
+  name: "New Page Created (Instant)",
+  description: "Emit new event when a new page is created in Confluence Data Center.",
+  version: "0.0.1",
+  type: "source",
+  dedupe: "unique",
+  methods: {
+    ...common.methods,
+    getEvents() {
+      return [
+        "page_created",
+      ];
+    },
+  },
+  sampleEmit,
+};

package/sources/new-page-created/test-event.mjs

@@ -0,0 +1,8 @@
+export default {
+  "timestamp": 1768241233603,
+  "event": "page_created",
+  "userKey": "ff8081819ba46873019ba46aefbb0000",
+  "page": {
+    "id": 1015810
+  }
+}

package/sources/new-webhook-event/new-webhook-event.mjs

@@ -0,0 +1,27 @@
+import common from "../common/base-webhook.mjs";
+import events from "../common/events.mjs";
+
+export default {
+  ...common,
+  key: "confluence_data_center-new-webhook-event",
+  name: "New Webhook Event (Instant)",
+  description: "Emit new event when a webhook event is received from Confluence Data Center.",
+  version: "0.0.1",
+  type: "source",
+  dedupe: "unique",
+  props: {
+    ...common.props,
+    events: {
+      type: "string[]",
+      label: "Events",
+      description: "The events to listen for",
+      options: events,
+    },
+  },
+  methods: {
+    ...common.methods,
+    getEvents() {
+      return this.events;
+    },
+  },
+};

package/sources/page-updated/page-updated.mjs

@@ -0,0 +1,21 @@
+import common from "../common/base-webhook.mjs";
+import sampleEmit from "./test-event.mjs";
+
+export default {
+  ...common,
+  key: "confluence_data_center-page-updated",
+  name: "Page Updated (Instant)",
+  description: "Emit new event when a page is updated in Confluence Data Center.",
+  version: "0.0.1",
+  type: "source",
+  dedupe: "unique",
+  methods: {
+    ...common.methods,
+    getEvents() {
+      return [
+        "page_updated",
+      ];
+    },
+  },
+  sampleEmit,
+};

package/sources/page-updated/test-event.mjs

@@ -0,0 +1,9 @@
+export default {
+  "timestamp": 1768246501113,
+  "event": "page_updated",
+  "userKey": "ff8081819ba46873019ba46aefbb0000",
+  "page": {
+    "id": 1015809
+  },
+  "updateTrigger": "edit_page"
+}