@pipedream/shopify_developer_app 0.6.4 → 0.7.0

package/actions/add-product-to-custom-collection/add-product-to-custom-collection.mjs

@@ -1,32 +1,22 @@
 import shopify from "../../shopify_developer_app.app.mjs";
-import common from "@pipedream/shopify/actions/add-product-to-custom-collection/common.mjs";
+import common from "@pipedream/shopify/actions/add-product-to-custom-collection/add-product-to-custom-collection.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-add-product-to-custom-collection",
-  name: "Add Products to Custom Collections",
-  description: "Adds a product or products to a custom collection or collections. [See the docs](https://shopify.dev/docs/api/admin-rest/2023-01/resources/collect#post-collects)",
-  version: "0.0.4",
-  type: "action",
+  version: "0.0.5",
+  name,
+  description,
+  type,
   props: {
     shopify,
-    productIds: {
-      propDefinition: [
-        shopify,
-        "productId",
-      ],
-      type: "string[]",
-      label: "Product IDs",
-    },
-    collectionIds: {
-      propDefinition: [
-        shopify,
-        "collectionId",
-      ],
-      type: "string[]",
-      label: "Collection IDs",
-      description: "IDs of the collections that the product will be added to",
-      optional: false,
-    },
+    ...props,
   },
 };

package/actions/add-tags/add-tags.mjs

@@ -1,15 +1,22 @@
 import shopify from "../../shopify_developer_app.app.mjs";
-import common from "@pipedream/shopify/actions/add-tags/common.mjs";
+import common from "@pipedream/shopify/actions/add-tags/add-tags.mjs";
+
+import { adjustPropDefinitions } from "../../common/utils.mjs";
+
+const {
+  name, description, type, ...others
+} = common;
+const props = adjustPropDefinitions(others.props, shopify);
 
 export default {
-  ...common,
-  name: "Add Tags",
-  version: "0.0.4",
+  ...others,
   key: "shopify_developer_app-add-tags",
-  description: "Add tags. [See the documentation](https://shopify.dev/api/admin-graphql/2022-07/mutations/tagsadd)",
-  type: "action",
+  version: "0.0.5",
+  name,
+  description,
+  type,
   props: {
     shopify,
-    ...common.props,
+    ...props,
   },
 };

package/actions/common/constants.mjs

@@ -0,0 +1,86 @@
+const RESOURCE_TYPES = [
+  {
+    label: "Blog",
+    value: "blog",
+  },
+  {
+    label: "Collection",
+    value: "collection",
+  },
+  {
+    label: "Customer",
+    value: "customer",
+  },
+  {
+    label: "Draft Order",
+    value: "draftOrder",
+  },
+  {
+    label: "Page",
+    value: "page",
+  },
+  {
+    label: "Product",
+    value: "product",
+  },
+  {
+    label: "Product Variant",
+    value: "variants",
+  },
+  {
+    label: "Article",
+    value: "article",
+  },
+  {
+    label: "Order",
+    value: "order",
+  },
+];
+
+const METAFIELD_TYPES = {
+  "boolean": "boolean",
+  "collection_reference": "string",
+  "color": "string",
+  "date": "string",
+  "date_time": "string",
+  "dimension": "object",
+  "file_reference": "string",
+  "json": "object",
+  "metaobject_reference": "string",
+  "mixed_reference": "string",
+  "money": "object",
+  "multi_line_text_field": "string",
+  "number_decimal": "string",
+  "number_integer": "integer",
+  "page_reference": "string",
+  "product_reference": "string",
+  "rating": "object",
+  "single_line_text_field": "string",
+  "url": "string",
+  "variant_reference": "string",
+  "volume": "object",
+  "weight": "object",
+  "list.collection_reference": "string[]",
+  "list.color": "string[]",
+  "list.date": "string[]",
+  "list.date_time": "string[]",
+  "list.dimension": "string[]",
+  "list.file_reference": "string[]",
+  "list.metaobject_reference": "string[]",
+  "list.mixed_reference": "string[]",
+  "list.number_integer": "string[]",
+  "list.number_decimal": "string[]",
+  "list.page_reference": "string[]",
+  "list.product_reference": "string[]",
+  "list.rating": "string[]",
+  "list.single_line_text_field": "string[]",
+  "list.url": "string[]",
+  "list.variant_reference": "string[]",
+  "list.volume": "string[]",
+  "list.weight": "string[]",
+};
+
+export default {
+  RESOURCE_TYPES,
+  METAFIELD_TYPES,
+};

package/actions/common/metafield-actions.mjs

@@ -1,10 +1,271 @@
 import shopify from "../../shopify_developer_app.app.mjs";
-import metafieldActions from "@pipedream/shopify/actions/common/metafield-actions.mjs";
+import constants from "./constants.mjs";
+import utils from "@pipedream/shopify/common/utils.mjs";
+import { MAX_LIMIT } from "@pipedream/shopify/common/constants.mjs";
 
 export default {
-  ...metafieldActions,
   props: {
-    ...metafieldActions.props,
     shopify,
+    ownerResource: {
+      type: "string",
+      label: "Resource Type",
+      description: "Filter by the resource type on which the metafield is attached to",
+      options: constants.RESOURCE_TYPES,
+      reloadProps: true,
+    },
+  },
+  methods: {
+    async getOwnerIdProp(ownerResource) {
+      const resources = {
+        product: {
+          ...shopify.propDefinitions.productId,
+          options: async ({ prevContext }) => {
+            return this.shopify.getPropOptions({
+              resourceFn: this.shopify.listProducts,
+              resourceKeys: [
+                "products",
+              ],
+              prevContext,
+            });
+          },
+        },
+        variants: {
+          ...shopify.propDefinitions.productVariantId,
+          options: async ({ prevContext }) => {
+            return this.shopify.getPropOptions({
+              resourceFn: this.shopify.listProductVariants,
+              resourceKeys: [
+                "productVariants",
+              ],
+              variables: {
+                query: `product_id:${this.productId.split("/").pop()}`,
+              },
+              prevContext,
+            });
+          },
+        },
+        collection: {
+          ...shopify.propDefinitions.collectionId,
+          options: async ({ prevContext }) => {
+            return this.shopify.getPropOptions({
+              resourceFn: this.shopify.listCollections,
+              resourceKeys: [
+                "collections",
+              ],
+              prevContext,
+            });
+          },
+          optional: false,
+        },
+        blog: {
+          ...shopify.propDefinitions.blogId,
+          options: async ({ prevContext }) => {
+            return this.shopify.getPropOptions({
+              resourceFn: this.shopify.listBlogs,
+              resourceKeys: [
+                "blogs",
+              ],
+              prevContext,
+            });
+          },
+        },
+        article: {
+          ...shopify.propDefinitions.articleId,
+          options: async ({ prevContext }) => {
+            return this.shopify.getPropOptions({
+              resourceFn: this.shopify.listBlogArticles,
+              resourceKeys: [
+                "blog",
+                "articles",
+              ],
+              variables: {
+                id: this.blogId,
+              },
+              prevContext,
+            });
+          },
+        },
+        page: {
+          ...shopify.propDefinitions.pageId,
+          options: async ({ prevContext }) => {
+            return this.shopify.getPropOptions({
+              resourceFn: this.shopify.listPages,
+              resourceKeys: [
+                "pages",
+              ],
+              prevContext,
+            });
+          },
+        },
+        customer: {
+          ...shopify.propDefinitions.customerId,
+          options: async ({ prevContext }) => {
+            return this.shopify.getPropOptions({
+              resourceFn: this.shopify.listCustomers,
+              resourceKeys: [
+                "customers",
+              ],
+              labelKey: "displayName",
+              prevContext,
+            });
+          },
+        },
+        draftOrder: {
+          type: "string",
+          label: "Draft Order ID",
+          description: "The identifier of a draft order",
+          options: async ({ prevContext }) => {
+            return this.shopify.getPropOptions({
+              resourceFn: this.shopify.listDraftOrders,
+              resourceKeys: [
+                "draftOrders",
+              ],
+              labelKey: "id",
+              prevContext,
+            });
+          },
+        },
+        order: {
+          ...shopify.propDefinitions.orderId,
+          options: async ({ prevContext }) => {
+            return this.shopify.getPropOptions({
+              resourceFn: this.shopify.listOrders,
+              resourceKeys: [
+                "orders",
+              ],
+              labelKey: "id",
+              prevContext,
+            });
+          },
+        },
+      };
+
+      const props = {};
+
+      if (ownerResource === "variants") {
+        props.productId = resources.product;
+      }
+
+      if (ownerResource === "article") {
+        props.blogId = resources.blog;
+      }
+
+      return {
+        ...props,
+        ownerId: resources[ownerResource],
+      };
+    },
+    async getMetafields({
+      resourceFn, resourceKeys = [], variables,
+    }) {
+      let results = await resourceFn(variables);
+      for (const key of resourceKeys) {
+        results = results[key];
+      }
+      return results.metafields.nodes;
+    },
+    async listMetafields(ownerResource, ownerId) {
+      const variables = {
+        id: ownerId,
+        first: MAX_LIMIT,
+      };
+      let resourceFn, resourceKeys;
+      if (ownerResource === "product") {
+        resourceFn = this.shopify.getProduct;
+        resourceKeys = [
+          "product",
+        ];
+      }
+      if (ownerResource === "variants") {
+        resourceFn = this.shopify.getProductVariant;
+        resourceKeys = [
+          "productVariant",
+        ];
+      }
+      if (ownerResource === "collection") {
+        resourceFn = this.shopify.getCollection;
+        resourceKeys = [
+          "collection",
+        ];
+      }
+      if (ownerResource === "blog") {
+        resourceFn = this.shopify.getBlog;
+        resourceKeys = [
+          "blog",
+        ];
+      }
+      if (ownerResource === "article") {
+        resourceFn = this.shopify.getArticle;
+        resourceKeys = [
+          "article",
+        ];
+      }
+      if (ownerResource === "page") {
+        resourceFn = this.shopify.getPage;
+        resourceKeys = [
+          "page",
+        ];
+      }
+      if (ownerResource === "customer") {
+        resourceFn = this.shopify.getCustomer;
+        resourceKeys = [
+          "customer",
+        ];
+      }
+      if (ownerResource === "draftOrder") {
+        resourceFn = this.shopify.getDraftOrder;
+        resourceKeys = [
+          "draftOrder",
+        ];
+      }
+      if (ownerResource === "order") {
+        resourceFn = this.shopify.getOrder;
+        resourceKeys = [
+          "order",
+        ];
+      }
+
+      return this.getMetafields({
+        resourceFn,
+        resourceKeys,
+        variables,
+      });
+    },
+    async getMetafieldIdByKey(key, namespace, ownerId, ownerResource) {
+      const results = await this.listMetafields(ownerResource, ownerId);
+
+      const metafield = results?.filter(
+        (field) => field.key === key && field.namespace === namespace,
+      );
+      if (!metafield || metafield.length === 0) {
+        return false;
+      }
+      return metafield[0].id;
+    },
+    async createMetafieldsArray(metafieldsOriginal, ownerId, ownerResource) {
+      if (!metafieldsOriginal) {
+        return;
+      }
+      const metafields = [];
+      const metafieldsArray = utils.parseJson(metafieldsOriginal);
+      for (const meta of metafieldsArray) {
+        if (meta.id) {
+          metafields.push(meta);
+          continue;
+        }
+        const metafieldId = await this.getMetafieldIdByKey(
+          meta.key, meta.namespace, ownerId, ownerResource,
+        );
+        if (!metafieldId) {
+          metafields.push(meta);
+          continue;
+        }
+        metafields.push({
+          id: `${metafieldId}`,
+          value: meta.value,
+        });
+      }
+      return metafields;
+    },
   },
 };

package/actions/create-article/create-article.mjs

@@ -1,34 +1,22 @@
-import app from "../../common/rest-admin.mjs";
-import common from "@pipedream/shopify/actions/create-article/common.mjs";
+import shopify from "../../shopify_developer_app.app.mjs";
+import common from "@pipedream/shopify/actions/create-article/create-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-create-article",
-  name: "Create Article",
-  description: "Create a new blog article. [See The Documentation](https://shopify.dev/docs/api/admin-rest/2023-04/resources/article#post-blogs-blog-id-articles)",
-  version: "0.0.6",
-  type: "action",
+  version: "0.0.7",
+  name,
+  description,
+  type,
   props: {
-    app,
-    blogId: {
-      propDefinition: [
-        app,
-        "blogId",
-      ],
-    },
-    title: {
-      description: "The title of the article.",
-      propDefinition: [
-        app,
-        "title",
-      ],
-    },
-    bodyHtml: {
-      description: "The text content of the article, complete with HTML markup.",
-      propDefinition: [
-        app,
-        "bodyHtml",
-      ],
-    },
+    shopify,
+    ...props,
   },
 };

package/actions/create-blog/create-blog.mjs

@@ -1,21 +1,22 @@
-import app from "../../common/rest-admin.mjs";
-import common from "@pipedream/shopify/actions/create-blog/common.mjs";
+import shopify from "../../shopify_developer_app.app.mjs";
+import common from "@pipedream/shopify/actions/create-blog/create-blog.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-create-blog",
-  name: "Create Blog",
-  description: "Create a new blog. [See The Documentation](https://shopify.dev/docs/api/admin-rest/2023-04/resources/blog#post-blogs)",
-  version: "0.0.6",
-  type: "action",
+  version: "0.0.7",
+  name,
+  description,
+  type,
   props: {
-    app,
-    title: {
-      description: "The title of the blog.",
-      propDefinition: [
-        app,
-        "title",
-      ],
-    },
+    shopify,
+    ...props,
   },
 };

package/actions/create-custom-collection/create-custom-collection.mjs

@@ -1,36 +1,22 @@
 import shopify from "../../shopify_developer_app.app.mjs";
-import common from "@pipedream/shopify/actions/create-custom-collection/common.mjs";
+import common from "@pipedream/shopify/actions/create-custom-collection/create-custom-collection.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-create-custom-collection",
-  name: "Create Custom Collection",
-  description: "Create a new custom collection. [See the documentation](https://shopify.dev/docs/api/admin-rest/2023-01/resources/customcollection#post-custom-collections)",
-  version: "0.0.4",
-  type: "action",
+  version: "0.0.5",
+  name,
+  description,
+  type,
   props: {
     shopify,
-    title: {
-      propDefinition: [
-        shopify,
-        "title",
-      ],
-      description: "The name of the custom collection",
-    },
-    products: {
-      propDefinition: [
-        shopify,
-        "productId",
-      ],
-      type: "string[]",
-      optional: true,
-    },
-    metafields: {
-      propDefinition: [
-        shopify,
-        "metafields",
-      ],
-    },
-    ...common.props,
+    ...props,
   },
 };

package/actions/create-customer/create-customer.mjs

@@ -1,12 +1,10 @@
 import shopify from "../../shopify_developer_app.app.mjs";
-import common from "@pipedream/shopify/actions/create-customer/common.mjs";
 
 export default {
-  ...common,
   key: "shopify_developer_app-create-customer",
   name: "Create Customer",
-  description: "Create a new customer. [See the documentation](https://shopify.dev/api/admin-rest/2022-01/resources/customer#[post]/admin/api/2022-01/customers.json)",
-  version: "0.0.4",
+  description: "Create a new customer. [See the documentation](https://shopify.dev/docs/api/admin-graphql/latest/mutations/customercreate)",
+  version: "0.0.5",
   type: "action",
   props: {
     shopify,
@@ -70,6 +68,27 @@ export default {
         "zip",
       ],
     },
-    ...common.props,
+  },
+  async run({ $ }) {
+    const response = await this.shopify.createCustomer({
+      input: {
+        firstName: this.firstName,
+        lastName: this.lastName,
+        email: this.email,
+        phone: this.phone,
+        addresses: [
+          {
+            address1: this.address,
+            company: this.company,
+            city: this.city,
+            province: this.province,
+            country: this.country,
+            zip: this.zip,
+          },
+        ],
+      },
+    });
+    $.export("$summary", `Created new customer with ID \`${response.customerCreate.customer.id}\``);
+    return response;
   },
 };

package/actions/create-metafield/create-metafield.mjs

@@ -1,16 +1,58 @@
 import metafieldActions from "../common/metafield-actions.mjs";
-import common from "@pipedream/shopify/actions/create-metafield/common.mjs";
+import common from "@pipedream/shopify/actions/create-metafield/create-metafield.mjs";
+import shopify from "../../shopify_developer_app.app.mjs";
+import constants from "../common/constants.mjs";
+
+const {
+  name, description, type, ...others
+} = common;
 
 export default {
-  ...common,
+  ...others,
   key: "shopify_developer_app-create-metafield",
-  name: "Create Metafield",
-  description: "Creates a metafield belonging to a resource. [See the docs](https://shopify.dev/api/admin-rest/2023-01/resources/metafield#post-blogs-blog-id-metafields)",
-  version: "0.0.5",
-  type: "action",
+  version: "0.0.6",
+  name,
+  description,
+  type,
   props: {
-    ...metafieldActions.props,
-    ...common.props,
+    shopify,
+    ownerResource: {
+      type: "string",
+      label: "Resource Type",
+      description: "Filter by the resource type on which the metafield is attached to",
+      options: constants.RESOURCE_TYPES.map((type) => ({
+        ...type,
+        value: type.value.toUpperCase(),
+      })),
+    },
+    name: {
+      type: "string",
+      label: "Name",
+      description: "The human-readable name for the metafield definition",
+    },
+    namespace: {
+      type: "string",
+      label: "Namespace",
+      description: "A container for a group of metafields. Grouping metafields within a namespace prevents your metafields from conflicting with other metafields with the same key name. Must have between 3-255 characters.",
+    },
+    key: {
+      type: "string",
+      label: "Key",
+      description: "The key of the metafield. Keys can be up to 64 characters long and can contain alphanumeric characters, hyphens, underscores, and periods.",
+    },
+    type: {
+      type: "string",
+      label: "Type",
+      description: "The type of data that the metafield stores in the `value` field. Refer to the list of [supported types](https://shopify.dev/apps/custom-data/metafields/types).",
+      options: Object.keys(constants.METAFIELD_TYPES),
+    },
+    pin: {
+      type: "boolean",
+      label: "Pin",
+      description: "Whether to pin the metafield definition",
+      default: false,
+      optional: true,
+    },
   },
   methods: {
     ...metafieldActions.methods,