@pipedream/shopify_developer_app 0.2.5 → 0.4.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/shopify_developer_app",
-  "version": "0.2.5",
+  "version": "0.4.0",
   "description": "Pipedream Shopify (Developer App) Components",
   "main": "shopify_developer_app.app.mjs",
   "keywords": [
@@ -13,7 +13,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@pipedream/platform": "^1.5.1",
+    "@pipedream/platform": "^3.0.0",
     "shopify-api-node": "^3.12.5"
   }
 }

package/sources/common/webhook-metafields.mjs

@@ -0,0 +1,20 @@
+import common from "./webhook.mjs";
+
+export default {
+  ...common,
+  props: {
+    ...common.props,
+    metafieldNamespaces: {
+      type: "string[]",
+      label: "Metafield Namespaces",
+      description: "Array of namespaces for any metafields that should be included with each webhook. Metafield definitions can be found in your store's Settings -> Custom Data. Select a metafield to view its namespace under \"Namespace and key\". For example, if the value is `custom.test_metafield`, the namespace is `custom`.",
+      optional: true,
+    },
+    privateMetafieldNamespaces: {
+      type: "string[]",
+      label: "Private Metafield Namespaces",
+      description: "Array of namespaces for any private metafields that should be included with each webhook. Metafield definitions can be found in your store's Settings -> Custom Data. Select a metafield to view its namespace under \"Namespace and key\". For example, if the value is `custom.test_metafield`, the namespace is `custom`.",
+      optional: true,
+    },
+  },
+};

package/sources/common/webhook.mjs

@@ -9,18 +9,6 @@ export default {
       type: "$.interface.http",
       customResponse: true,
     },
-    metafieldNamespaces: {
-      type: "string[]",
-      label: "Metafield Namespaces",
-      description: "Array of namespaces for any metafields that should be included with each webhook",
-      optional: true,
-    },
-    privateMetafieldNamespaces: {
-      type: "string[]",
-      label: "Private Metafield Namespaces",
-      description: "Array of namespaces for any private metafields that should be included with each webhook",
-      optional: true,
-    },
   },
   hooks: {
     async activate() {
@@ -59,6 +47,39 @@ export default {
       return this.app.getShopId() === shopId
         && this.getTopic() === topic;
     },
+    checkMetaFields({
+      metafields = [], private_metafields: privateMetafields = [],
+    } = {}) {
+      let validateMetafield = true;
+      let validatePrivateMetafield = true;
+      if (this.metafieldNamespaces?.length) {
+        validateMetafield = false;
+        for (const metafieldNamespace of this.metafieldNamespaces) {
+          for (const metafieldObj of metafields) {
+            if (metafieldObj.namespace === metafieldNamespace) {
+              validateMetafield = true;
+              break;
+            }
+          }
+          if (validateMetafield) break;
+        }
+      }
+
+      if (this.privateMetafieldNamespaces?.length) {
+        validatePrivateMetafield = false;
+        for (const privateMetafieldNamespace of this.privateMetafieldNamespaces) {
+          for (const privateMetafieldObj of privateMetafields) {
+            if (privateMetafieldObj.namespace === privateMetafieldNamespace) {
+              validatePrivateMetafield = true;
+              break;
+            }
+          }
+          if (validatePrivateMetafield) break;
+        }
+      }
+
+      return validateMetafield && validatePrivateMetafield;
+    },
     isRelevant() {
       return true;
     },
@@ -89,7 +110,7 @@ export default {
       status: 200,
     });
 
-    if (this.isRelevant(resource)) {
+    if (this.isRelevant(resource) && this.checkMetaFields(resource)) {
       this.$emit(resource, this.generateMeta(resource));
     }
   },

package/sources/new-cancelled-order/new-cancelled-order.mjs

@@ -1,5 +1,5 @@
-import common from "../common/webhook.mjs";
 import constants from "../common/constants.mjs";
+import common from "../common/webhook-metafields.mjs";
 
 export default {
   ...common,
@@ -7,7 +7,7 @@ export default {
   name: "New Cancelled Order (Instant)",
   type: "source",
   description: "Emit new event each time a new order is cancelled.",
-  version: "0.0.2",
+  version: "0.0.4",
   dedupe: "unique",
   methods: {
     ...common.methods,

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

@@ -1,5 +1,5 @@
-import common from "../common/webhook.mjs";
 import constants from "../common/constants.mjs";
+import common from "../common/webhook-metafields.mjs";
 
 export default {
   ...common,
@@ -7,7 +7,7 @@ export default {
   name: "New Customer Created (Instant)",
   type: "source",
   description: "Emit new event for each new customer added to a store.",
-  version: "0.0.2",
+  version: "0.0.4",
   dedupe: "unique",
   methods: {
     ...common.methods,

package/sources/new-draft-order/new-draft-order.mjs

@@ -1,5 +1,5 @@
-import common from "../common/webhook.mjs";
 import constants from "../common/constants.mjs";
+import common from "../common/webhook-metafields.mjs";
 
 export default {
   ...common,
@@ -7,7 +7,7 @@ export default {
   name: "New Draft Order (Instant)",
   type: "source",
   description: "Emit new event for each new draft order submitted to a store.",
-  version: "0.0.2",
+  version: "0.0.4",
   dedupe: "unique",
   methods: {
     ...common.methods,

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

@@ -1,5 +1,5 @@
-import common from "../common/webhook.mjs";
 import constants from "../common/constants.mjs";
+import common from "../common/webhook-metafields.mjs";
 
 export default {
   ...common,
@@ -7,7 +7,7 @@ export default {
   name: "New Event Emitted (Instant)",
   type: "source",
   description: "Emit new event for each new Shopify event.",
-  version: "0.0.2",
+  version: "0.0.4",
   dedupe: "unique",
   props: {
     ...common.props,

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

@@ -1,5 +1,5 @@
-import common from "../common/webhook.mjs";
 import constants from "../common/constants.mjs";
+import common from "../common/webhook-metafields.mjs";
 
 export default {
   ...common,
@@ -7,7 +7,7 @@ export default {
   name: "New Order Created (Instant)",
   type: "source",
   description: "Emit new event for each new order submitted to a store.",
-  version: "0.0.2",
+  version: "0.0.4",
   dedupe: "unique",
   methods: {
     ...common.methods,

package/sources/new-paid-order/new-paid-order.mjs

@@ -1,5 +1,5 @@
-import common from "../common/webhook.mjs";
 import constants from "../common/constants.mjs";
+import common from "../common/webhook-metafields.mjs";
 
 export default {
   ...common,
@@ -7,7 +7,7 @@ export default {
   name: "New Paid Order (Instant)",
   type: "source",
   description: "Emit new event each time a new order is paid.",
-  version: "0.0.2",
+  version: "0.0.4",
   dedupe: "unique",
   methods: {
     ...common.methods,

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

@@ -1,5 +1,5 @@
-import common from "../common/webhook.mjs";
 import constants from "../common/constants.mjs";
+import common from "../common/webhook-metafields.mjs";
 
 export default {
   ...common,
@@ -7,7 +7,7 @@ export default {
   name: "New Product Created (Instant)",
   type: "source",
   description: "Emit new event for each product added to a store.",
-  version: "0.0.2",
+  version: "0.0.4",
   dedupe: "unique",
   methods: {
     ...common.methods,

package/sources/new-product-updated/new-product-updated.mjs

@@ -0,0 +1,55 @@
+import constants from "../common/constants.mjs";
+import common from "../common/webhook-metafields.mjs";
+
+export default {
+  ...common,
+  key: "shopify_developer_app-new-product-updated",
+  name: "New Product Updated (Instant)",
+  description: "Emit new event for each product updated in a store.",
+  version: "0.0.2",
+  type: "source",
+  dedupe: "unique",
+  props: {
+    ...common.props,
+    productType: {
+      type: "string",
+      label: "Product Type",
+      description: "Filter results by product type",
+      optional: true,
+    },
+    tags: {
+      type: "string[]",
+      label: "Tags",
+      description: "Filter results by product tag(s)",
+      optional: true,
+    },
+  },
+  methods: {
+    ...common.methods,
+    getTopic() {
+      return constants.EVENT_TOPIC.PRODUCTS_UPDATE;
+    },
+    isRelevant(resource) {
+      let relevant = true;
+      if (this.productType && resource.product_type !== this.productType) {
+        relevant = false;
+      }
+      if (this.tags?.length) {
+        this.tags.forEach((tag) => {
+          if (!resource.tags?.includes(tag)) {
+            relevant = false;
+          }
+        });
+      }
+      return relevant;
+    },
+    generateMeta(resource) {
+      const ts = Date.parse(resource.updated_at);
+      return {
+        id: `${resource.id}-${ts}`,
+        summary: `Product Updated ${resource.id}`,
+        ts,
+      };
+    },
+  },
+};

package/sources/new-product-updated/test-event.mjs

@@ -0,0 +1,64 @@
+export default {
+  "admin_graphql_api_id": "gid://shopify/Product/8416570474776",
+  "body_html": null,
+  "created_at": "2023-06-30T13:38:03-04:00",
+  "handle": "best-product-ever",
+  "id": 8416570474776,
+  "product_type": "",
+  "published_at": "2023-06-30T13:38:03-04:00",
+  "template_suffix": null,
+  "title": "product",
+  "updated_at": "2024-06-18T14:37:58-04:00",
+  "vendor": "Testing",
+  "status": "active",
+  "published_scope": "web",
+  "tags": "abc, def",
+  "variants": [
+    {
+      "admin_graphql_api_id": "gid://shopify/ProductVariant/45612961333528",
+      "barcode": null,
+      "compare_at_price": null,
+      "created_at": "2023-06-30T13:38:03-04:00",
+      "fulfillment_service": "manual",
+      "id": 45612961333528,
+      "inventory_management": null,
+      "inventory_policy": "deny",
+      "position": 1,
+      "price": "0.00",
+      "product_id": 8416570474776,
+      "sku": "",
+      "taxable": true,
+      "title": "Default Title",
+      "updated_at": "2023-10-27T10:08:17-04:00",
+      "option1": "Default Title",
+      "option2": null,
+      "option3": null,
+      "grams": 0,
+      "image_id": null,
+      "weight": 0,
+      "weight_unit": "lb",
+      "inventory_item_id": 47661178487064,
+      "inventory_quantity": 0,
+      "old_inventory_quantity": 0,
+      "requires_shipping": true
+    },
+  ],
+  "options": [
+    {
+      "name": "Title",
+      "id": 10664239726872,
+      "product_id": 8416570474776,
+      "position": 1,
+      "values": [
+        "Default Title",
+      ]
+    }
+  ],
+  "images": [],
+  "image": null,
+  "variant_ids": [
+    {
+      "id": 45612961333528
+    }
+  ]
+}

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

@@ -0,0 +1,26 @@
+import constants from "../common/constants.mjs";
+import common from "../common/webhook.mjs";
+
+export default {
+  ...common,
+  key: "shopify_developer_app-new-refund-created",
+  name: "New Refund Created (Instant)",
+  description: "Emit new event when a new refund is created.",
+  version: "0.0.1",
+  type: "source",
+  dedupe: "unique",
+  methods: {
+    ...common.methods,
+    getTopic() {
+      return constants.EVENT_TOPIC.REFUNDS_CREATE;
+    },
+    generateMeta(resource) {
+      const ts = Date.parse(resource.created_at);
+      return {
+        id: `${resource.id}-${ts}`,
+        summary: `Refund Created ${resource.id}`,
+        ts,
+      };
+    },
+  },
+};

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

@@ -0,0 +1,155 @@
+export default {
+  "id": 1002961240349,
+  "order_id": 6273085767965,
+  "created_at": "2024-08-20T11:19:18-04:00",
+  "note": "",
+  "user_id": 90630848797,
+  "processed_at": "2024-08-20T11:19:18-04:00",
+  "restock": true,
+  "duties": [],
+  "total_duties_set": {
+    "shop_money": {
+      "amount": "0",
+      "currency_code": "VND"
+    },
+    "presentment_money": {
+      "amount": "0",
+      "currency_code": "VND"
+    }
+  },
+  "return": null,
+  "refund_shipping_lines": [],
+  "admin_graphql_api_id": "gid://shopify/Refund/1002961240349",
+  "order_adjustments": [],
+  "refund_line_items": [
+    {
+      "id": 665556615453,
+      "quantity": 1,
+      "line_item_id": 16014782595357,
+      "location_id": 76683084061,
+      "restock_type": "cancel",
+      "subtotal": 20,
+      "total_tax": 0,
+      "subtotal_set": {
+        "shop_money": {
+          "amount": "20",
+          "currency_code": "VND"
+        },
+        "presentment_money": {
+          "amount": "20",
+          "currency_code": "VND"
+        }
+      },
+      "total_tax_set": {
+        "shop_money": {
+          "amount": "0",
+          "currency_code": "VND"
+        },
+        "presentment_money": {
+          "amount": "0",
+          "currency_code": "VND"
+        }
+      },
+      "line_item": {
+        "id": 16014782595357,
+        "variant_id": 44392954495261,
+        "title": "T-shirt 1",
+        "quantity": 1,
+        "sku": "",
+        "variant_title": "Pipedream1003",
+        "vendor": "Pipedream0930",
+        "fulfillment_service": "manual",
+        "product_id": 8137104785693,
+        "requires_shipping": true,
+        "taxable": false,
+        "gift_card": false,
+        "name": "T-shirt 1 - Pipedream1003",
+        "variant_inventory_management": "shopify",
+        "properties": [],
+        "product_exists": true,
+        "fulfillable_quantity": 0,
+        "grams": 0,
+        "price": "20",
+        "total_discount": "0",
+        "fulfillment_status": null,
+        "price_set": {
+          "shop_money": {
+            "amount": "20",
+            "currency_code": "VND"
+          },
+          "presentment_money": {
+            "amount": "20",
+            "currency_code": "VND"
+          }
+        },
+        "total_discount_set": {
+          "shop_money": {
+            "amount": "0",
+            "currency_code": "VND"
+          },
+          "presentment_money": {
+            "amount": "0",
+            "currency_code": "VND"
+          }
+        },
+        "discount_allocations": [],
+        "duties": [],
+        "admin_graphql_api_id": "gid://shopify/LineItem/16014782595357",
+        "tax_lines": [
+          {
+            "title": "VAT",
+            "price": "0",
+            "rate": 0.1,
+            "channel_liable": false,
+            "price_set": {
+              "shop_money": {
+                "amount": "0",
+                "currency_code": "VND"
+              },
+              "presentment_money": {
+                "amount": "0",
+                "currency_code": "VND"
+              }
+            }
+          }
+        ]
+      }
+    }
+  ],
+  "transactions": [
+    {
+      "id": 7582534205725,
+      "order_id": 6273085767965,
+      "kind": "refund",
+      "gateway": "manual",
+      "status": "success",
+      "message": "Refunded 20.00 from manual gateway",
+      "created_at": "2024-08-20T11:19:18-04:00",
+      "test": false,
+      "authorization": null,
+      "location_id": null,
+      "user_id": 90630848797,
+      "parent_id": 7582533648669,
+      "processed_at": "2024-08-20T11:19:18-04:00",
+      "device_id": null,
+      "error_code": null,
+      "source_name": "1830279",
+      "receipt": {},
+      "amount": "20",
+      "currency": "VND",
+      "payment_id": "#1031.2",
+      "total_unsettled_set": {
+        "presentment_money": {
+          "amount": "0.0",
+          "currency": "VND"
+        },
+        "shop_money": {
+          "amount": "0.0",
+          "currency": "VND"
+        }
+      },
+      "manual_payment_gateway": true,
+      "admin_graphql_api_id": "gid://shopify/OrderTransaction/7582534205725"
+    }
+  ]
+}

package/sources/new-shipment/new-shipment.mjs

@@ -1,5 +1,5 @@
-import common from "../common/webhook.mjs";
 import constants from "../common/constants.mjs";
+import common from "../common/webhook-metafields.mjs";
 
 export default {
   ...common,
@@ -7,7 +7,7 @@ export default {
   name: "New Shipment (Instant)",
   type: "source",
   description: "Emit new event for each new fulfillment event for a store.",
-  version: "0.0.2",
+  version: "0.0.4",
   dedupe: "unique",
   methods: {
     ...common.methods,

package/sources/new-updated-customer/new-updated-customer.mjs

@@ -1,5 +1,5 @@
-import common from "../common/webhook.mjs";
 import constants from "../common/constants.mjs";
+import common from "../common/webhook-metafields.mjs";
 
 export default {
   ...common,
@@ -7,7 +7,7 @@ export default {
   name: "New Updated Customer (Instant)",
   type: "source",
   description: "Emit new event each time a customer's information is updated.",
-  version: "0.0.2",
+  version: "0.0.4",
   dedupe: "unique",
   methods: {
     ...common.methods,

package/sources/new-updated-order/new-updated-order.mjs

@@ -1,5 +1,5 @@
-import common from "../common/webhook.mjs";
 import constants from "../common/constants.mjs";
+import common from "../common/webhook-metafields.mjs";
 
 export default {
   ...common,
@@ -7,7 +7,7 @@ export default {
   name: "New Updated Order (Instant)",
   type: "source",
   description: "Emit new event each time an order is updated.",
-  version: "0.0.2",
+  version: "0.0.4",
   dedupe: "unique",
   methods: {
     ...common.methods,