@pipedream/shopify_developer_app 0.6.3 → 0.7.0

package/actions/update-page/update-page.mjs

@@ -1,33 +1,22 @@
-import app from "../../common/rest-admin.mjs";
-import common from "@pipedream/shopify/actions/update-page/common.mjs";
+import shopify from "../../shopify_developer_app.app.mjs";
+import common from "@pipedream/shopify/actions/update-page/update-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-update-page",
-  name: "Update Page",
-  description: "Update an existing page. [See The Documentation](https://shopify.dev/docs/api/admin-rest/2023-04/resources/page#put-pages-page-id)",
-  version: "0.0.6",
-  type: "action",
+  version: "0.0.7",
+  name,
+  description,
+  type,
   props: {
-    app,
-    pageId: {
-      propDefinition: [
-        app,
-        "pageId",
-      ],
-    },
-    title: {
-      description: "The title of the page.",
-      propDefinition: [
-        app,
-        "title",
-      ],
-    },
-    bodyHtml: {
-      propDefinition: [
-        app,
-        "bodyHtml",
-      ],
-    },
+    shopify,
+    ...props,
   },
 };

package/actions/update-product/update-product.mjs

@@ -1,14 +1,13 @@
 import shopify from "../../shopify_developer_app.app.mjs";
-import metafieldActions from "../common/metafield-actions.mjs";
-import common from "@pipedream/shopify/actions/update-product/common.mjs";
+import common from "../common/metafield-actions.mjs";
+import utils from "@pipedream/shopify/common/utils.mjs";
 
 export default {
   ...common,
-  ...metafieldActions,
   key: "shopify_developer_app-update-product",
   name: "Update Product",
-  description: "Update an existing product. [See the docs](https://shopify.dev/api/admin-rest/2022-01/resources/product#[put]/admin/api/2022-01/products/{product_id}.json)",
-  version: "0.0.5",
+  description: "Update an existing product. [See the documentation](https://shopify.dev/docs/api/admin-graphql/latest/mutations/productupdate)",
+  version: "0.0.6",
   type: "action",
   props: {
     shopify,
@@ -19,59 +18,64 @@ export default {
       ],
     },
     title: {
-      propDefinition: [
-        shopify,
-        "title",
-      ],
+      type: "string",
+      label: "Title",
+      description: "Title of the new product",
       optional: true,
     },
     productDescription: {
-      propDefinition: [
-        shopify,
-        "productDescription",
-      ],
+      type: "string",
+      label: "Product Description",
+      description: "A description of the product. Supports HTML formatting. Example: `<strong>Good snowboard!</strong>`",
+      optional: true,
     },
     vendor: {
-      propDefinition: [
-        shopify,
-        "vendor",
-      ],
+      type: "string",
+      label: "Vendor",
+      description: "The name of the product's vendor",
+      optional: true,
     },
     productType: {
-      propDefinition: [
-        shopify,
-        "productType",
-      ],
+      type: "string",
+      label: "Product Type",
+      description: "A categorization for the product used for filtering and searching products",
+      optional: true,
     },
     status: {
-      propDefinition: [
-        shopify,
-        "status",
+      type: "string",
+      label: "Status",
+      description: "The status of the product. `active`: The product is ready to sell and is available to customers on the online store, sales channels, and apps. By default, existing products are set to active. `archived`: The product is no longer being sold and isn't available to customers on sales channels and apps. `draft`: The product isn't ready to sell and is unavailable to customers on sales channels and apps. By default, duplicated and unarchived products are set to draft",
+      optional: true,
+      options: [
+        "ACTIVE",
+        "ARCHIVED",
+        "DRAFT",
       ],
     },
     images: {
-      propDefinition: [
-        shopify,
-        "images",
-      ],
+      type: "string[]",
+      label: "Images",
+      description: "A list of URLs of images to associate with the new product",
+      optional: true,
     },
     options: {
-      propDefinition: [
-        shopify,
-        "options",
-      ],
+      type: "string[]",
+      label: "Options",
+      description: "The custom product properties. For example, Size, Color, and Material. Each product can have up to 3 options and each option value can be up to 255 characters. Product variants are made of up combinations of option values. Options cannot be created without values. To create new options, a variant with an associated option value also needs to be created. Example: `[{\"name\":\"Color\",\"values\":[{\"name\": \"Blue\"},{\"name\": \"Black\"}]},{\"name\":\"Size\",\"values\":[{\"name\": \"155\"},{\"name\": \"159\"}]}]`",
+      optional: true,
     },
     variants: {
-      propDefinition: [
-        shopify,
-        "variants",
-      ],
+      type: "string[]",
+      label: "Product Variants",
+      description: "An array of product variants, each representing a different version of the product. The position property is read-only. The position of variants is indicated by the order in which they are listed. Example: `[{\"option1\":\"First\",\"price\":\"10.00\",\"sku\":\"123\"},{\"option1\":\"Second\",\"price\":\"20.00\",\"sku\":\"123\"}]`",
+      optional: true,
     },
     tags: {
       propDefinition: [
         shopify,
         "tags",
       ],
+      optional: true,
     },
     metafields: {
       propDefinition: [
@@ -79,6 +83,61 @@ export default {
         "metafields",
       ],
     },
-    ...common.props,
+    handle: {
+      type: "string",
+      label: "Handle",
+      description: "A unique human-friendly string for the product that serves as the URL handle. Automatically generated from the product's title.",
+      optional: true,
+    },
+    seoTitle: {
+      type: "string",
+      label: "SEO Title",
+      description: "The product title used for search engine optimization",
+      optional: true,
+    },
+    seoDescription: {
+      type: "string",
+      label: "SEO Description",
+      description: "The product description used for search engine optimization",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const metafields = await this.createMetafieldsArray(this.metafields, this.productId, "product");
+
+    const variants = [];
+    const variantsArray = this.shopify.parseArrayOfJSONStrings(this.variants);
+    for (const variant of variantsArray) {
+      if (variant.metafields) {
+        const variantMetafields = await this.createMetafieldsArray(variant.metafields, variant.id, "variants");
+        variants.push({
+          ...variant,
+          metafields: variantMetafields,
+        });
+        continue;
+      }
+      variants.push(variant);
+    }
+
+    const response = await this.shopify.updateProduct({
+      input: {
+        title: this.title,
+        descriptionHtml: this.productDescription,
+        vendor: this.vendor,
+        productType: this.productType,
+        status: this.status,
+        images: utils.parseJson(this.images),
+        options: utils.parseJson(this.options),
+        variants,
+        tags: this.tags,
+        metafields,
+        metafields_global_title_tag: this.seoTitle,
+        metafields_global_description_tag: this.seoDescription,
+        handle: this.handle,
+      },
+    });
+
+    $.export("$summary", `Updated product \`${response.title}\` with id \`${response.id}\``);
+    return response;
   },
 };

package/actions/update-product-variant/update-product-variant.mjs

@@ -1,79 +1,22 @@
 import shopify from "../../shopify_developer_app.app.mjs";
-import metafieldActions from "../common/metafield-actions.mjs";
-import common from "@pipedream/shopify/actions/update-product-variant/common.mjs";
+import common from "@pipedream/shopify/actions/update-product-variant/update-product-variant.mjs";
+
+import { adjustPropDefinitions } from "../../common/utils.mjs";
+
+const {
+  name, description, type, ...others
+} = common;
+const props = adjustPropDefinitions(others.props, shopify);
 
 export default {
-  ...common,
-  ...metafieldActions,
+  ...others,
   key: "shopify_developer_app-update-product-variant",
-  name: "Update Product Variant",
-  description: "Update an existing product variant. [See the docs](https://shopify.dev/api/admin-rest/2022-01/resources/product-variant#[put]/admin/api/2022-01/variants/{variant_id}.json)",
-  version: "0.0.6",
-  type: "action",
+  version: "0.0.7",
+  name,
+  description,
+  type,
   props: {
     shopify,
-    productId: {
-      propDefinition: [
-        shopify,
-        "productId",
-      ],
-    },
-    productVariantId: {
-      propDefinition: [
-        shopify,
-        "productVariantId",
-        (c) => c,
-      ],
-      description: `${shopify.propDefinitions.productVariantId.description}
-        Option displayed here as the title of the product variant`,
-    },
-    option: {
-      propDefinition: [
-        shopify,
-        "option",
-      ],
-      optional: true,
-    },
-    price: {
-      propDefinition: [
-        shopify,
-        "price",
-      ],
-      description: "The price of the product variant",
-    },
-    imageId: {
-      propDefinition: [
-        shopify,
-        "imageId",
-        (c) => c,
-      ],
-    },
-    metafields: {
-      propDefinition: [
-        shopify,
-        "metafields",
-      ],
-    },
-    sku: {
-      propDefinition: [
-        shopify,
-        "sku",
-      ],
-    },
-    countryCodeOfOrigin: {
-      propDefinition: [
-        shopify,
-        "country",
-      ],
-      description: "The country code [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of where the item came from",
-    },
-    locationId: {
-      propDefinition: [
-        shopify,
-        "locationId",
-      ],
-      optional: true,
-    },
-    ...common.props,
+    ...props,
   },
 };

package/common/mutations.mjs

@@ -0,0 +1,124 @@
+const CREATE_ORDER = `
+ mutation OrderCreate($order: OrderCreateOrderInput!, $options: OrderCreateOptionsInput) {
+      orderCreate(order: $order, options: $options) {
+        userErrors {
+          field
+          message
+        }
+        order {
+          id
+          totalTaxSet {
+            shopMoney {
+              amount
+              currencyCode
+            }
+          }
+          lineItems(first: 5) {
+            nodes {
+              variant {
+                id
+              }
+              id
+              title
+              quantity
+              taxLines {
+                title
+                rate
+                priceSet {
+                  shopMoney {
+                    amount
+                    currencyCode
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+`;
+
+const CREATE_CUSTOMER = `
+  mutation customerCreate($input: CustomerInput!) {
+      customerCreate(input: $input) {
+        userErrors {
+          field
+          message
+        }
+        customer {
+          id
+          email
+          phone
+          taxExempt
+          firstName
+          lastName
+          amountSpent {
+            amount
+            currencyCode
+          }
+          smsMarketingConsent {
+            marketingState
+            marketingOptInLevel
+            consentUpdatedAt
+          }
+        }
+      }
+    }
+`;
+
+const UPDATE_CUSTOMER = `
+  mutation updateCustomerMetafields($input: CustomerInput!) {
+    customerUpdate(input: $input) {
+      customer {
+        id
+        email
+        firstName
+        lastName
+        metafields(first: 3) {
+          edges {
+            node {
+              id
+              namespace
+              key
+              value
+            }
+          }
+        }
+      }
+      userErrors {
+        message
+        field
+      }
+    }
+  }
+`;
+
+const UPDATE_PRODUCT = `
+  mutation UpdateProductWithNewMedia($input: ProductInput!, $media: [CreateMediaInput!]) {
+      productUpdate(input: $input, media: $media) {
+        product {
+          id
+          media(first: 10) {
+            nodes {
+              alt
+              mediaContentType
+              preview {
+                status
+              }
+            }
+          }
+        }
+        userErrors {
+          field
+          message
+        }
+      }
+    }
+`;
+
+export default {
+  CREATE_ORDER,
+  CREATE_CUSTOMER,
+  UPDATE_CUSTOMER,
+  UPDATE_PRODUCT,
+};

package/common/queries.mjs

@@ -0,0 +1,181 @@
+const GET_ORDER = `
+  query SuggestedRefund($id: ID!, $refundLineItems: [RefundLineItemInput!], $first: Int, $after: String) {
+    order(id: $id) {
+      id
+      metafields (first: $first, after: $after) {
+        nodes {
+          id
+          key
+          namespace
+          value
+          type
+        }
+        pageInfo {
+          endCursor
+        }
+      }
+      suggestedRefund(refundLineItems: $refundLineItems) {
+        subtotalSet {
+          shopMoney {
+            amount
+            currencyCode
+          }
+          presentmentMoney {
+            amount
+            currencyCode
+          }
+        }
+        refundLineItems {
+          lineItem {
+            id
+          }
+          quantity
+        }
+      }
+    }
+  }
+`;
+
+const GET_CUSTOMER = `
+  query ($id: ID!, $first: Int, $after: String) {
+    customer(id: $id) {
+      id
+      firstName
+      lastName
+      email
+      phone
+      numberOfOrders
+      amountSpent {
+        amount
+        currencyCode
+      }
+      createdAt
+      updatedAt
+      note
+      verifiedEmail
+      validEmailAddress
+      tags
+      lifetimeDuration
+      defaultAddress {
+        formattedArea
+        address1
+      }
+      addresses {
+        address1
+      }
+      image {
+        src
+      }
+      canDelete
+      metafields (first: $first, after: $after) {
+        nodes {
+          id
+          key
+          namespace
+          value
+          type
+        }
+        pageInfo {
+          endCursor
+        }
+      }
+    }
+  }
+`;
+
+const GET_DRAFT_ORDER = `
+  query ($id: ID!, $first: Int, $after: String) {
+    draftOrder(id: $id) {
+      name
+      metafields (first: $first, after: $after) {
+        nodes {
+          id
+          key
+          namespace
+          value
+          type
+        }
+        pageInfo {
+          endCursor
+        }
+      }
+    }
+  }
+`;
+
+const LIST_ORDERS = `
+  query ($first: Int, $after: String, $reverse: Boolean){
+    orders(first: $first, after: $after, reverse: $reverse) {
+      nodes {
+        id
+        updatedAt
+        metafields (first: $first, after: $after) {
+          nodes {
+            id
+            key
+            namespace
+            value
+            type
+          }
+        }
+      }
+      pageInfo {
+        endCursor
+      }
+    }
+  }
+`;
+
+const LIST_DRAFT_ORDERS = `
+  query ($first: Int, $after: String){
+    draftOrders(first: $first, after: $after) {
+      nodes {
+        id
+        metafields (first: $first, after: $after) {
+          nodes {
+            id
+            key
+            namespace
+            value
+            type
+          }
+        }
+      }
+      pageInfo {
+        endCursor
+      }
+    }
+  }
+`;
+
+const LIST_CUSTOMERS = `
+  query ($first: Int, $after: String, $query: String) {
+    customers(first: $first, after: $after, query: $query) {
+      nodes {
+        id
+        displayName
+        metafields (first: $first, after: $after) {
+          nodes {
+            id
+            key
+            namespace
+            value
+            type
+          }
+        }
+      }
+      pageInfo {
+        endCursor
+      }
+    }
+  }
+`;
+
+export default {
+  GET_ORDER,
+  GET_CUSTOMER,
+  GET_DRAFT_ORDER,
+  LIST_ORDERS,
+  LIST_DRAFT_ORDERS,
+  LIST_CUSTOMERS,
+};

package/common/utils.mjs

@@ -0,0 +1,40 @@
+export function adjustPropDefinitions(props, app) {
+  return Object.fromEntries(
+    Object.entries(props).map(([
+      key,
+      prop,
+    ]) => {
+      if (typeof prop === "string") return [
+        key,
+        prop,
+      ];
+      const {
+        propDefinition, ...otherValues
+      } = prop;
+      if (propDefinition) {
+        const [
+          , ...otherDefs
+        ] = propDefinition;
+        return [
+          key,
+          {
+            propDefinition: [
+              app,
+              ...otherDefs,
+            ],
+            ...otherValues,
+          },
+        ];
+      }
+      return [
+        key,
+        otherValues.type === "app"
+          ? null
+          : otherValues,
+      ];
+    })
+      .filter(([
+        , value,
+      ]) => value),
+  );
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/shopify_developer_app",
-  "version": "0.6.3",
+  "version": "0.7.0",
   "description": "Pipedream Shopify (Developer App) Components",
   "main": "shopify_developer_app.app.mjs",
   "keywords": [
@@ -14,7 +14,7 @@
   },
   "dependencies": {
     "@pipedream/platform": "^3.0.3",
-    "@pipedream/shopify": "^0.6.8",
+    "@pipedream/shopify": "^0.7.0",
     "shopify-api-node": "^3.14.2"
   }
 }