@pipedream/wordpress_org 0.3.8 → 0.4.1

package/README.md

@@ -1,32 +1,11 @@
 # Overview
 
-WordPress API can help you create a variety of different projects with greater
-efficiency and functionality. Whether it’s developing and creating a custom
-WordPress site, creating an API for a product, or developing a plugin for a
-program, the WordPress API offers more possibilities than ever to customize and
-enhance your online experience. Here are a few examples of things you can build
-using the WordPress API:
+The WordPress.org API offers a wide range of capabilities for content management, theme and plugin information, and community engagement. With Pipedream, you can harness this API to create automated workflows that react to events in WordPress, sync content across platforms, or even manage your site's appearance and functionality programmatically. Whether you're looking to streamline your publishing process, enhance user interaction, or keep everything in sync, the WordPress.org API on Pipedream offers a powerful toolset to craft custom solutions.
 
-- Custom WordPress Sites: With WordPress API, you can create specialized and
-  customized sites that fit your exact needs and vision. From e-commerce stores
-  to magazine websites and anything else imaginable, WordPress API can help you
-  create and customize a website that’s tailored to your exact needs.
-- Product API: If you’re a developer and you have products that require an API,
-  WordPress API can help you easily create one. You can create a custom API
-  that helps you manage your products and make them available to other
-  applications and websites.
-- Plugin Creation: If you need a plugin for something you’re developing, the
-  WordPress API can help you create something tailored to your exact needs.
-  From custom shortcodes to mini programs and full-fledged plugins, the
-  WordPress API has what you need.
-- Widgets: Widgets are small pieces of code that you can use on your website to
-  display different types of content. You can use the WordPress API to create
-  custom widgets that help you display plugins, videos, images, and more.
-- Custom Social Network Platforms: The WordPress API offers more possibilities
-  than ever to create custom social network platforms. With access to the API,
-  you can create specialized networks for your website, unfettered by
-  third-party restrictions.
-- Mobile Applications:Do you need to create a mobile application that interacts
-  with your website? The WordPress API can provide the tools and features you
-  need to create a smooth and seamless integration between your website and
-  your app.
+# Example Use Cases
+
+- **Automated Content Syndication**: Publish new WordPress posts automatically to social media platforms like Twitter or Facebook. Whenever you push a new post, Pipedream can capture this event and send out tweets or posts with links back to your article, driving traffic and engagement.
+
+- **Dynamic Content Updates**: Update content across multiple WordPress sites in response to a single trigger. For instance, when you update a post on your main site, Pipedream can propagate these changes to other WordPress sites you manage, ensuring content consistency.
+
+- **Scheduled Theme Changes**: Swap WordPress themes based on time or specific triggers, such as holidays or promotional events. With Pipedream, you can schedule these changes in advance, so your site reflects the right mood or branding at just the right time.

package/actions/create-post/create-post.mjs

@@ -1,10 +1,11 @@
 import wordpress from "../../wordpress_org.app.mjs";
+import utils from "../../common/utils.mjs";
 
 export default {
   key: "wordpress_org-create-post",
   name: "Create Post",
   description: "Creates a post. [See the documentation](https://developer.wordpress.org/rest-api/reference/posts/#create-a-post)",
-  version: "0.0.3",
+  version: "0.0.4",
   type: "action",
   props: {
     wordpress,
@@ -50,6 +51,18 @@ export default {
         "commentStatus",
       ],
     },
+    meta: {
+      propDefinition: [
+        wordpress,
+        "meta",
+      ],
+    },
+    media: {
+      propDefinition: [
+        wordpress,
+        "media",
+      ],
+    },
   },
   async run({ $ }) {
     const params = {
@@ -60,6 +73,8 @@ export default {
       categories: this.categories,
       excerpt: this.excerpt,
       comment_status: this.commentStatus,
+      meta: utils.parseObj(this.meta),
+      featured_media: this.media,
     };
 
     const resp = await this.wordpress.createPost(params);

package/actions/create-user/create-user.mjs

@@ -4,7 +4,7 @@ export default {
   key: "wordpress_org-create-user",
   name: "Create User",
   description: "Creates a user. [See the documentation](https://developer.wordpress.org/rest-api/reference/users/#create-a-user)",
-  version: "0.0.4",
+  version: "0.0.5",
   type: "action",
   props: {
     wordpress,

package/actions/get-user/get-user.mjs

@@ -4,7 +4,7 @@ export default {
   key: "wordpress_org-get-user",
   name: "Get User",
   description: "Retrieves information for a user. [See the documentation](https://developer.wordpress.org/rest-api/reference/users/#retrieve-a-user-2)",
-  version: "0.0.2",
+  version: "0.0.3",
   type: "action",
   props: {
     wordpress,

package/actions/search-posts/search-posts.mjs

@@ -4,7 +4,7 @@ export default {
   key: "wordpress_org-search-posts",
   name: "Search Posts",
   description: "Searches for specific posts. [See the documentation](https://developer.wordpress.org/rest-api/reference/posts/#list-posts)",
-  version: "0.0.3",
+  version: "0.0.4",
   type: "action",
   props: {
     wordpress,

package/actions/update-post/update-post.mjs

@@ -1,10 +1,11 @@
 import wordpress from "../../wordpress_org.app.mjs";
+import utils from "../../common/utils.mjs";
 
 export default {
   key: "wordpress_org-update-post",
   name: "Update Post",
   description: "Updates a post specified by its ID. [See the documentation](https://developer.wordpress.org/rest-api/reference/posts/#update-a-post)",
-  version: "0.0.3",
+  version: "0.0.4",
   type: "action",
   props: {
     wordpress,
@@ -58,6 +59,18 @@ export default {
         "commentStatus",
       ],
     },
+    meta: {
+      propDefinition: [
+        wordpress,
+        "meta",
+      ],
+    },
+    media: {
+      propDefinition: [
+        wordpress,
+        "media",
+      ],
+    },
   },
   async run({ $ }) {
     const params = {
@@ -68,6 +81,8 @@ export default {
       categories: this.categories,
       excerpt: this.excerpt,
       comment_status: this.commentStatus,
+      meta: utils.parseObj(this.meta),
+      featured_media: this.media,
     };
 
     const resp = await this.wordpress.updatePost(this.post, params);

package/actions/update-user/update-user.mjs

@@ -5,7 +5,7 @@ export default {
   key: "wordpress_org-update-user",
   name: "Update User",
   description: "Updates the information of a user. [See the documentation](https://developer.wordpress.org/rest-api/reference/users/#update-a-user-2)",
-  version: "0.0.2",
+  version: "0.0.3",
   type: "action",
   props: {
     wordpress,

package/actions/upload-media/upload-media.mjs

@@ -0,0 +1,55 @@
+import wordpress from "../../wordpress_org.app.mjs";
+import utils from "../../common/utils.mjs";
+import { getFileStream } from "@pipedream/platform";
+
+export default {
+  key: "wordpress_org-upload-media",
+  name: "Upload Media",
+  description: "Upload a media item to your WordPress media library. Returns a media ID to be used in creating or updating posts.[See the documentation](https://www.npmjs.com/package/wpapi#uploading-media)",
+  version: "0.0.2",
+  type: "action",
+  props: {
+    wordpress,
+    filePath: {
+      type: "string",
+      label: "File Path or URL",
+      description: "Provide either a file URL or a path to a file in the /tmp directory (for example, /tmp/myFile.pdf).",
+    },
+    title: {
+      propDefinition: [
+        wordpress,
+        "title",
+      ],
+      description: "Title of the media item",
+      optional: true,
+    },
+    altText: {
+      type: "string",
+      label: "Alt Text",
+      description: "Alternative text to display when media is not displayed",
+      optional: true,
+    },
+    description: {
+      propDefinition: [
+        wordpress,
+        "description",
+      ],
+      description: "Description of the media item",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const content = await getFileStream(this.filePath);
+
+    const params = utils.cleanObj({
+      title: this.title,
+      alt_text: this.altText,
+      description: this.description,
+    });
+    const response = await this.wordpress.createMedia(content, params);
+
+    $.export("$summary", "Successfully uploaded media.");
+
+    return response;
+  },
+};

package/common/utils.mjs

@@ -0,0 +1,22 @@
+export default {
+  parseObj(obj) {
+    return !obj
+      ? undefined
+      : typeof obj === "string"
+        ? JSON.parse(obj)
+        : obj;
+  },
+  cleanObj(o) {
+    for (var k in o || {}) {
+      if (typeof o[k] === "undefined") {
+        delete o[k];
+      }
+    }
+    return o;
+  },
+  getFilePath(path) {
+    return path.includes("tmp/")
+      ? path
+      : `/tmp/${path}`;
+  },
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/wordpress_org",
-  "version": "0.3.8",
+  "version": "0.4.1",
   "description": "Pipedream Wordpress.org Components",
   "main": "wordpress_org.app.mjs",
   "keywords": [
@@ -10,6 +10,7 @@
   "homepage": "https://pipedream.com/apps/wordpress_org",
   "author": "Pipedream <support@pipedream.com> (https://pipedream.com/)",
   "dependencies": {
+    "@pipedream/platform": "^3.1.0",
     "lodash.pickby": "^4.6.0",
     "wpapi": "^1.2.2"
   },

package/wordpress_org.app.mjs

@@ -61,7 +61,7 @@ export default {
     email: {
       type: "string",
       label: "Email",
-      description: "  The email address for the user",
+      description: "The email address for the user",
     },
     url: {
       type: "string",
@@ -150,6 +150,25 @@ export default {
         }));
       },
     },
+    media: {
+      type: "string",
+      label: "Featured Media",
+      description: "Identifier of an uploaded media item",
+      optional: true,
+      async options({ page }) {
+        const media = await this.listMedia(page + 1);
+        return media.map((item) => ({
+          label: item?.title?.rendered || item.id,
+          value: item.id,
+        }));
+      },
+    },
+    meta: {
+      type: "object",
+      label: "Meta",
+      description: "Metafields for the post. Note: Metafield keys must be registered in your Wordpress instance.",
+      optional: true,
+    },
   },
   methods: {
     async getClient() {
@@ -232,5 +251,16 @@ export default {
       const wp = await this.getClient();
       return wp.users().create(params);
     },
+    async createMedia(file, params) {
+      const wp = await this.getClient();
+      return wp.media()
+        .file(file)
+        .create(params);
+    },
+    async listMedia(page) {
+      const wp = await this.getClient();
+      return wp.media().perPage(PER_PAGE)
+        .page(page);
+    },
   },
 };