@pipedream/shopify_developer_app 0.6.4 → 0.7.1

package/shopify_developer_app.app.mjs

@@ -1,10 +1,111 @@
-import commonApp from "@pipedream/shopify/common-app.mjs";
+import commonApp from "@pipedream/shopify";
 import Shopify from "shopify-api-node";
+import queries from "./common/queries.mjs";
+import mutations from "./common/mutations.mjs";
+import { API_VERSION } from "@pipedream/shopify/common/constants.mjs";
 
 export default {
   ...commonApp,
   type: "app",
   app: "shopify_developer_app",
+  propDefinitions: {
+    ...commonApp.propDefinitions,
+    orderId: {
+      type: "string",
+      label: "Order ID",
+      description: "The identifier of an order",
+      async options({ prevContext }) {
+        return this.getPropOptions({
+          resourceFn: this.listOrders,
+          resourceKeys: [
+            "orders",
+          ],
+          labelKey: "id",
+          prevContext,
+        });
+      },
+    },
+    customerId: {
+      type: "string",
+      label: "Customer ID",
+      description: "The identifier of a customer",
+      async options({ prevContext }) {
+        return this.getPropOptions({
+          resourceFn: this.listCustomers,
+          resourceKeys: [
+            "customers",
+          ],
+          labelKey: "displayName",
+          prevContext,
+        });
+      },
+    },
+    firstName: {
+      type: "string",
+      label: "First Name",
+      description: "The customer's first name",
+      optional: true,
+    },
+    lastName: {
+      type: "string",
+      label: "Last Name",
+      description: "The customer's last name",
+      optional: true,
+    },
+    email: {
+      type: "string",
+      label: "Email",
+      description: "The unique email address of the customer",
+    },
+    phone: {
+      type: "string",
+      label: "Phone Number",
+      description: "The unique phone number (E.164 format) for this customer. Check out [Shopify Customer API](https://shopify.dev/api/admin-rest/2022-01/resources/customer#[post]/admin/api/#{api_version}/customers.json_examples) for more details on valid formats",
+      optional: true,
+    },
+    address: {
+      type: "string",
+      label: "Street Address",
+      description: "The customer's mailing address",
+      optional: true,
+    },
+    company: {
+      type: "string",
+      label: "Company",
+      description: "The customer's company",
+      optional: true,
+    },
+    city: {
+      type: "string",
+      label: "City",
+      description: "The customer's city, town, or village",
+      optional: true,
+    },
+    province: {
+      type: "string",
+      label: "Province",
+      description: "The customer's region name. Typically a province, a state, or a prefecture",
+      optional: true,
+    },
+    country: {
+      type: "string",
+      label: "Country",
+      description: "The customer's country",
+      optional: true,
+    },
+    zip: {
+      type: "string",
+      label: "Zip Code",
+      description: "The customer's postal code",
+      optional: true,
+    },
+    metafields: {
+      type: "string[]",
+      label: "Metafields",
+      description: "An array of objects, each one representing a metafield. If adding a new metafield, the object should contain `key`, `value`, `type`, and `namespace`. Example: `{{ [{ \"key\": \"new\", \"value\": \"newvalue\", \"type\": \"single_line_text_field\", \"namespace\": \"global\" }] }}`. To update an existing metafield, use the `id` and `value`. Example: `{{ [{ \"id\": \"28408051400984\", \"value\": \"updatedvalue\" }] }}`",
+      optional: true,
+    },
+  },
   methods: {
     ...commonApp.methods,
     getShopifyInstance() {
@@ -12,7 +113,35 @@ export default {
         shopName: this.getShopId(),
         accessToken: this.$auth.access_token,
         autoLimit: true,
+        apiVersion: API_VERSION,
       });
     },
+    getOrder(variables) {
+      return this._makeGraphQlRequest(queries.GET_ORDER, variables);
+    },
+    getDraftOrder(variables) {
+      return this._makeGraphQlRequest(queries.GET_DRAFT_ORDER, variables);
+    },
+    getCustomer(variables) {
+      return this._makeGraphQlRequest(queries.GET_CUSTOMER, variables);
+    },
+    listOrders(variables) {
+      return this._makeGraphQlRequest(queries.LIST_ORDERS, variables);
+    },
+    listDraftOrders(variables) {
+      return this._makeGraphQlRequest(queries.LIST_DRAFT_ORDERS, variables);
+    },
+    listCustomers(variables) {
+      return this._makeGraphQlRequest(queries.LIST_CUSTOMERS, variables);
+    },
+    createOrder(variables) {
+      return this._makeGraphQlRequest(mutations.CREATE_ORDER, variables);
+    },
+    createCustomer(variables) {
+      return this._makeGraphQlRequest(mutations.CREATE_CUSTOMER, variables);
+    },
+    updateCustomer(variables) {
+      return this._makeGraphQlRequest(mutations.UPDATE_CUSTOMER, variables);
+    },
   },
 };

package/sources/common/webhook.mjs

@@ -12,17 +12,25 @@ export default {
   },
   hooks: {
     async activate() {
-      const { result: webhook } = await this.app.createWebhook({
-        address: this.http.endpoint,
-        topic: this.getTopic(),
-        metafield_namespaces: this.metafieldNamespaces,
-        private_metafield_namespaces: this.privateMetafieldNamespaces,
-      });
-      this.setWebhookId(webhook.id);
+      const { webhookSubscriptionCreate: { webhookSubscription: { id } } }
+        = await this.app.createWebhook({
+          topic: this.getTopic(),
+          webhookSubscription: {
+            callbackUrl: this.http.endpoint,
+            format: "JSON",
+            metafieldNamespaces: [
+              ...(this.metafieldNamespaces || []),
+              ...(this.privateMetafieldNamespaces || []),
+            ],
+          },
+        });
+      this.setWebhookId(id);
     },
     async deactivate() {
       const webhookId = this.getWebhookId();
-      await this.app.deleteWebhook(webhookId);
+      if (webhookId) {
+        await this.app.deleteWebhook(webhookId);
+      }
     },
   },
   methods: {
@@ -45,7 +53,7 @@ export default {
         shopId,
       ] = domain.split(constants.DOMAIN_SUFFIX);
       return this.app.getShopId() === shopId
-        && this.getTopic() === topic;
+        && constants.EVENT_TOPIC[this.getTopic()] === topic;
     },
     checkMetaFields({
       metafields = [], private_metafields: privateMetafields = [],

package/sources/new-abandoned-cart/new-abandoned-cart.mjs

@@ -1,16 +1,22 @@
 import shopify from "../../shopify_developer_app.app.mjs";
-import common from "@pipedream/shopify/sources/new-abandoned-cart/common.mjs";
+import common from "@pipedream/shopify/sources/new-abandoned-cart/new-abandoned-cart.mjs";
+
+import { adjustPropDefinitions } from "../../common/utils.mjs";
+
+const {
+  name, description, type, ...others
+} = common;
+const props = adjustPropDefinitions(others.props, shopify);
 
 export default {
-  ...common,
+  ...others,
   key: "shopify_developer_app-new-abandoned-cart",
-  name: "New Abandoned Cart",
-  type: "source",
-  description: "Emit new event each time a user abandons their cart.",
-  version: "0.0.5",
-  dedupe: "unique",
+  version: "0.0.7",
+  name,
+  description,
+  type,
   props: {
     shopify,
-    ...common.props,
+    ...props,
   },
 };

package/sources/new-article/new-article.mjs

@@ -1,16 +1,22 @@
 import shopify from "../../shopify_developer_app.app.mjs";
-import common from "@pipedream/shopify/sources/new-article/common.mjs";
+import common from "@pipedream/shopify/sources/new-article/new-article.mjs";
+
+import { adjustPropDefinitions } from "../../common/utils.mjs";
+
+const {
+  name, description, type, ...others
+} = common;
+const props = adjustPropDefinitions(others.props, shopify);
 
 export default {
-  ...common,
+  ...others,
   key: "shopify_developer_app-new-article",
-  name: "New Article",
-  type: "source",
-  description: "Emit new event for each new article in a blog.",
-  version: "0.0.4",
-  dedupe: "unique",
+  version: "0.0.6",
+  name,
+  description,
+  type,
   props: {
-    shopify,
-    ...common.props,
+    app: shopify,
+    ...props,
   },
 };

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

@@ -1,4 +1,3 @@
-import constants from "../common/constants.mjs";
 import common from "../common/webhook-metafields.mjs";
 
 export default {
@@ -7,18 +6,18 @@ export default {
   name: "New Cancelled Order (Instant)",
   type: "source",
   description: "Emit new event each time a new order is cancelled.",
-  version: "0.0.8",
+  version: "0.0.10",
   dedupe: "unique",
   methods: {
     ...common.methods,
     getTopic() {
-      return constants.EVENT_TOPIC.ORDERS_CANCELLED;
+      return "ORDERS_CANCELLED";
     },
     generateMeta(resource) {
       const ts = Date.parse(resource.updated_at);
       return {
         id: ts,
-        summary: `Order Cancelled ${resource.id}.`,
+        summary: `Order Cancelled ${resource.id}`,
         ts,
       };
     },

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

@@ -1,4 +1,3 @@
-import constants from "../common/constants.mjs";
 import common from "../common/webhook-metafields.mjs";
 
 export default {
@@ -7,18 +6,18 @@ export default {
   name: "New Customer Created (Instant)",
   type: "source",
   description: "Emit new event for each new customer added to a store.",
-  version: "0.0.8",
+  version: "0.0.10",
   dedupe: "unique",
   methods: {
     ...common.methods,
     getTopic() {
-      return constants.EVENT_TOPIC.CUSTOMERS_CREATE;
+      return "CUSTOMERS_CREATE";
     },
     generateMeta(resource) {
       const ts = Date.parse(resource.created_at);
       return {
         id: resource.id,
-        summary: `New Customer ${resource.id}.`,
+        summary: `New Customer ${resource.id}`,
         ts,
       };
     },

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

@@ -1,4 +1,3 @@
-import constants from "../common/constants.mjs";
 import common from "../common/webhook-metafields.mjs";
 
 export default {
@@ -7,18 +6,18 @@ 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.8",
+  version: "0.0.10",
   dedupe: "unique",
   methods: {
     ...common.methods,
     getTopic() {
-      return constants.EVENT_TOPIC.DRAFT_ORDERS_CREATE;
+      return "DRAFT_ORDERS_CREATE";
     },
     generateMeta(resource) {
       const ts = Date.parse(resource.created_at);
       return {
         id: resource.id,
-        summary: `New Draft Order ${resource.id}.`,
+        summary: `New Draft Order ${resource.id}`,
         ts,
       };
     },

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

@@ -1,5 +1,5 @@
-import constants from "../common/constants.mjs";
 import common from "../common/webhook-metafields.mjs";
+import constants from "../common/constants.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.9",
+  version: "0.0.11",
   dedupe: "unique",
   props: {
     ...common.props,
@@ -15,7 +15,13 @@ export default {
       type: "string",
       label: "Event Topic",
       description: "Event topic that triggers the webhook.",
-      options: constants.EVENT_TOPICS,
+      options: Object.entries(constants.EVENT_TOPIC).map(([
+        key,
+        value,
+      ]) => ({
+        value: key,
+        label: value,
+      })),
     },
   },
   methods: {
@@ -27,7 +33,7 @@ export default {
       const ts = Date.now();
       return {
         id: ts,
-        summary: `New Event Emitted at ${new Date(ts)}.`,
+        summary: `New Event Emitted at ${new Date(ts)}`,
         ts,
       };
     },

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

@@ -1,4 +1,3 @@
-import constants from "../common/constants.mjs";
 import common from "../common/webhook-metafields.mjs";
 
 export default {
@@ -7,18 +6,18 @@ export default {
   name: "New Fulfillment Event (Instant)",
   type: "source",
   description: "Emit new event for each new fulfillment event for a store.",
-  version: "0.0.6",
+  version: "0.0.8",
   dedupe: "unique",
   methods: {
     ...common.methods,
     getTopic() {
-      return constants.EVENT_TOPIC.FULFILLMENT_EVENTS_CREATE;
+      return "FULFILLMENT_EVENTS_CREATE";
     },
     generateMeta(resource) {
       const ts = Date.parse(resource.updated_at);
       return {
         id: ts,
-        summary: `New Fulfillment Event ${resource.id}.`,
+        summary: `New Fulfillment Event ${resource.id}`,
         ts,
       };
     },

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

@@ -1,4 +1,3 @@
-import constants from "../common/constants.mjs";
 import common from "../common/webhook-metafields.mjs";
 
 export default {
@@ -7,29 +6,20 @@ export default {
   name: "New Order Created (Instant)",
   type: "source",
   description: "Emit new event for each new order submitted to a store.",
-  version: "0.0.8",
+  version: "0.0.10",
   dedupe: "unique",
   methods: {
     ...common.methods,
     getTopic() {
-      return constants.EVENT_TOPIC.ORDERS_CREATE;
+      return "ORDERS_CREATE";
     },
     generateMeta(resource) {
       const ts = Date.parse(resource.created_at);
       return {
         id: resource.id,
-        summary: `New Order ${resource.id}.`,
+        summary: `New Order ${resource.id}`,
         ts,
       };
     },
   },
-  hooks: {
-    ...common.hooks,
-    async deploy() {
-      let results = await this.app.getOrders("any", false, null, null, "any", 5, 1);
-      for (const order of results) {
-        this.$emit(order, this.generateMeta(order));
-      }
-    },
-  },
 };

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

@@ -1,4 +1,3 @@
-import constants from "../common/constants.mjs";
 import common from "../common/webhook-metafields.mjs";
 
 export default {
@@ -7,18 +6,18 @@ export default {
   name: "New Order Fulfilled (Instant)",
   type: "source",
   description: "Emit new event whenever an order is fulfilled.",
-  version: "0.0.5",
+  version: "0.0.7",
   dedupe: "unique",
   methods: {
     ...common.methods,
     getTopic() {
-      return constants.EVENT_TOPIC.ORDERS_FULFILLED;
+      return "ORDERS_FULFILLED";
     },
     generateMeta(resource) {
       const ts = Date.parse(resource.updated_at);
       return {
         id: ts,
-        summary: `New Fulfilled Order ${resource.id}.`,
+        summary: `New Fulfilled Order ${resource.id}`,
         ts,
       };
     },

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

@@ -1,16 +1,22 @@
 import shopify from "../../shopify_developer_app.app.mjs";
-import common from "@pipedream/shopify/sources/new-page/common.mjs";
+import common from "@pipedream/shopify/sources/new-page/new-page.mjs";
+
+import { adjustPropDefinitions } from "../../common/utils.mjs";
+
+const {
+  name, description, type, ...others
+} = common;
+const props = adjustPropDefinitions(others.props, shopify);
 
 export default {
-  ...common,
+  ...others,
   key: "shopify_developer_app-new-page",
-  name: "New Page",
-  type: "source",
-  description: "Emit new event for each new page published.",
-  version: "0.0.4",
-  dedupe: "unique",
+  version: "0.0.6",
+  name,
+  description,
+  type,
   props: {
-    shopify,
-    ...common.props,
+    app: shopify,
+    ...props,
   },
 };

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

@@ -1,4 +1,3 @@
-import constants from "../common/constants.mjs";
 import common from "../common/webhook-metafields.mjs";
 
 export default {
@@ -7,18 +6,18 @@ export default {
   name: "New Paid Order (Instant)",
   type: "source",
   description: "Emit new event each time a new order is paid.",
-  version: "0.0.8",
+  version: "0.0.10",
   dedupe: "unique",
   methods: {
     ...common.methods,
     getTopic() {
-      return constants.EVENT_TOPIC.ORDERS_PAID;
+      return "ORDERS_PAID";
     },
     generateMeta(resource) {
       const ts = Date.parse(resource.updated_at);
       return {
         id: ts,
-        summary: `Order Paid ${resource.id}.`,
+        summary: `Order Paid ${resource.id}`,
         ts,
       };
     },

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

@@ -1,4 +1,3 @@
-import constants from "../common/constants.mjs";
 import common from "../common/webhook-metafields.mjs";
 
 export default {
@@ -7,18 +6,18 @@ export default {
   name: "New Product Created (Instant)",
   type: "source",
   description: "Emit new event for each product added to a store.",
-  version: "0.0.8",
+  version: "0.0.10",
   dedupe: "unique",
   methods: {
     ...common.methods,
     getTopic() {
-      return constants.EVENT_TOPIC.PRODUCTS_CREATE;
+      return "PRODUCTS_CREATE";
     },
     generateMeta(resource) {
       const ts = Date.parse(resource.created_at);
       return {
         id: resource.id,
-        summary: `New Product ${resource.id}.`,
+        summary: `New Product ${resource.id}`,
         ts,
       };
     },

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

@@ -1,4 +1,3 @@
-import constants from "../common/constants.mjs";
 import common from "../common/webhook-metafields.mjs";
 
 export default {
@@ -6,7 +5,7 @@ export default {
   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.6",
+  version: "0.0.8",
   type: "source",
   dedupe: "unique",
   props: {
@@ -27,11 +26,11 @@ export default {
   methods: {
     ...common.methods,
     getTopic() {
-      return constants.EVENT_TOPIC.PRODUCTS_UPDATE;
+      return "PRODUCTS_UPDATE";
     },
     isRelevant(resource) {
       let relevant = true;
-      if (this.productType && resource.product_type !== this.productType) {
+      if (this.productType && resource.productType !== this.productType) {
         relevant = false;
       }
       if (this.tags?.length) {

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

@@ -1,4 +1,3 @@
-import constants from "../common/constants.mjs";
 import common from "../common/webhook.mjs";
 
 export default {
@@ -6,13 +5,13 @@ export default {
   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.5",
+  version: "0.0.7",
   type: "source",
   dedupe: "unique",
   methods: {
     ...common.methods,
     getTopic() {
-      return constants.EVENT_TOPIC.REFUNDS_CREATE;
+      return "REFUNDS_CREATE";
     },
     generateMeta(resource) {
       const ts = Date.parse(resource.created_at);

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

@@ -1,4 +1,3 @@
-import constants from "../common/constants.mjs";
 import common from "../common/webhook-metafields.mjs";
 
 export default {
@@ -7,18 +6,18 @@ export default {
   name: "New Updated Customer (Instant)",
   type: "source",
   description: "Emit new event each time a customer's information is updated.",
-  version: "0.0.8",
+  version: "0.0.10",
   dedupe: "unique",
   methods: {
     ...common.methods,
     getTopic() {
-      return constants.EVENT_TOPIC.CUSTOMERS_UPDATE;
+      return "CUSTOMERS_UPDATE";
     },
     generateMeta(resource) {
       const ts = Date.parse(resource.updated_at);
       return {
         id: ts,
-        summary: `Customer Updated ${resource.id}.`,
+        summary: `Customer Updated ${resource.id}`,
         ts,
       };
     },

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

@@ -1,4 +1,3 @@
-import constants from "../common/constants.mjs";
 import common from "../common/webhook-metafields.mjs";
 
 export default {
@@ -7,18 +6,18 @@ export default {
   name: "New Updated Order (Instant)",
   type: "source",
   description: "Emit new event each time an order is updated.",
-  version: "0.0.8",
+  version: "0.0.10",
   dedupe: "unique",
   methods: {
     ...common.methods,
     getTopic() {
-      return constants.EVENT_TOPIC.ORDERS_UPDATED;
+      return "ORDERS_UPDATED";
     },
     generateMeta(resource) {
       const ts = Date.parse(resource.updated_at);
       return {
         id: ts,
-        summary: `Order Updated ${resource.id}.`,
+        summary: `Order Updated ${resource.id}`,
         ts,
       };
     },