updates per QA

Author: michelle0927

components/shopify/actions/create-metafield/create-metafield.mjs

@@ -1,15 +1,28 @@
-import common from "../common/metafield-actions.mjs";
+import shopify from "../../shopify.app.mjs";
 import constants from "../common/constants.mjs";
 
 export default {
-  ...common,
   key: "shopify-create-metafield",
   name: "Create Metafield",
-  description: "Creates a metafield belonging to a resource. [See the documentation](https://shopify.dev/docs/api/admin-graphql/unstable/mutations/metafieldsSet)",
+  description: "Creates a metafield belonging to a resource. [See the documentation](https://shopify.dev/docs/api/admin-graphql/latest/mutations/metafieldDefinitionCreate)",
   version: "0.0.11",
   type: "action",
   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",
@@ -25,36 +38,30 @@ export default {
       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),
-      reloadProps: true,
     },
-  },
-  async additionalProps() {
-    const props = await this.getOwnerIdProp(this.ownerResource);
-
-    if (this.type) {
-      props.value = {
-        type: "string",
-        label: "Value",
-        description: "The data to store in the metafield",
-      };
-    }
-
-    return props;
+    pin: {
+      type: "boolean",
+      label: "Pin",
+      description: "Whether to pin the metafield definition",
+      default: false,
+      optional: true,
+    },
   },
   async run({ $ }) {
     const response = await this.shopify.createMetafield({
-      metafields: {
+      definition: {
+        ownerType: this.ownerResource,
+        name: this.name,
+        namespace: this.namespace,
         key: this.key,
         type: this.type,
-        value: this.value,
-        namespace: this.namespace,
-        ownerId: this.ownerId,
+        pin: this.pin,
       },
     });
-    if (response.metafieldsSet.userErrors.length > 0) {
-      throw new Error(response.metafieldsSet.userErrors[0].message);
+    if (response.metafieldDefinitionCreate.userErrors.length > 0) {
+      throw new Error(response.metafieldDefinitionCreate.userErrors[0].message);
     }
-    $.export("$summary", `Created metafield for object with ID ${this.ownerId}`);
+    $.export("$summary", `Created metafield ${this.name} for object type ${this.type}`);
     return response;
   },
 };

components/shopify/actions/create-product-variant/create-product-variant.mjs

@@ -1,6 +1,8 @@
 import shopify from "../../shopify.app.mjs";
 import utils from "../../common/utils.mjs";
-import { MAX_LIMIT } from "../../common/constants.mjs";
+import {
+  MAX_LIMIT, WEIGHT_UNITS,
+} from "../../common/constants.mjs";
 import { ConfigurationError } from "@pipedream/platform";
 
 export default {
@@ -74,12 +76,7 @@ export default {
       label: "Weight Unit",
       description: "The unit of measurement that applies to the product variant's weight. If you don't specify a value for weight_unit, then the shop's default unit of measurement is applied.",
       optional: true,
-      options: [
-        "g",
-        "kg",
-        "oz",
-        "lb",
-      ],
+      options: WEIGHT_UNITS,
     },
     metafields: {
       propDefinition: [
@@ -112,6 +109,10 @@ export default {
       throw new ConfigurationError("Must enter LocationId to set the available quantity");
     }
 
+    if ((this.weightUnit && !this.weight) || (!this.weightUnit && this.weight)) {
+      throw new ConfigurationError("Must enter both Weight and Weight Unit to set weight");
+    }
+
     const response = await this.shopify.createProductVariants({
       productId: this.productId,
       variants: [
@@ -125,7 +126,7 @@ export default {
             measurement: (this.weightUnit || this.weight) && {
               weight: {
                 unit: this.weightUnit,
-                value: this.weight,
+                value: +this.weight,
               },
             },
           },

components/shopify/actions/get-metaobjects/get-metaobjects.mjs

@@ -16,11 +16,12 @@ export default {
         shopify,
         "metaobjectType",
       ],
+      withLabel: true,
     },
   },
   async run({ $ }) {
     const response = await this.shopify.listMetaobjects({
-      type: this.type,
+      type: this.type.label,
       first: MAX_LIMIT,
     });
 

components/shopify/actions/search-product-variant/search-product-variant.mjs

@@ -110,13 +110,20 @@ export default {
         });
       }
 
-      const title = response.productVariants
-        ? response.productVariants.nodes[0].title
-        : response.productVariant.title;
-      const id = response.productVariants
-        ? response.productVariants.nodes[0].id
-        : response.productVariant.id;
-      $.export("$summary", `Found product variant \`${title}\` with ID \`${id}\``);
+      const variant = response?.productVariants?.nodes?.length
+        ? response.productVariants.nodes[0]
+        : response?.productVariant
+          ? response.productVariant
+          : {};
+
+      const title = variant?.title;
+      const id = variant?.id;
+
+      if (title && id) {
+        $.export("$summary", `Found product variant \`${title}\` with ID \`${id}\``);
+      } else {
+        $.export("$summary", "No product variant found");
+      }
       return response;
     } catch (err) {
       if (!this.createIfNotFound) {

components/shopify/actions/search-products/search-products.mjs

@@ -29,6 +29,8 @@ export default {
         "productId",
       ],
       type: "string[]",
+      label: "Product IDs",
+      description: "Select multiple Product IDs or provide Product IDs as a JSON array. For example: `{{ [\"gid://shopify/Product/1\", \"gid://shopify/Product/2\"] }}`",
       optional: true,
     },
     collectionId: {
@@ -61,6 +63,7 @@ export default {
         shopify,
         "sortKey",
       ],
+      description: "The key to sort the results by. Keys `RELEVANCE` and `INVENTORY_TOTAL` not for use with `Collection ID`.",
       options: PRODUCT_SORT_KEY,
     },
     reverse: {
@@ -92,7 +95,7 @@ export default {
     const query = queryArray.length
       ? queryArray.join(" AND ")
       : undefined;
-
+    console.log(query);
     let products = await this.shopify.getPaginated({
       resourceFn: this.shopify.listProducts,
       resourceKeys: [

components/shopify/actions/update-product-variant/update-product-variant.mjs

@@ -1,6 +1,9 @@
 import shopify from "../../shopify.app.mjs";
 import utils from "../../common/utils.mjs";
-import { MAX_LIMIT } from "../../common/constants.mjs";
+import {
+  MAX_LIMIT, WEIGHT_UNITS,
+} from "../../common/constants.mjs";
+import { ConfigurationError } from "@pipedream/platform";
 
 export default {
   key: "shopify-update-product-variant",
@@ -70,12 +73,7 @@ export default {
       label: "Weight Unit",
       description: "The unit of measurement that applies to the product variant's weight. If you don't specify a value for weight_unit, then the shop's default unit of measurement is applied.",
       optional: true,
-      options: [
-        "g",
-        "kg",
-        "oz",
-        "lb",
-      ],
+      options: WEIGHT_UNITS,
     },
     metafields: {
       propDefinition: [
@@ -104,6 +102,10 @@ export default {
     },
   },
   async run({ $ }) {
+    if ((this.weightUnit && !this.weight) || (!this.weightUnit && this.weight)) {
+      throw new ConfigurationError("Must enter both Weight and Weight Unit to set weight");
+    }
+
     const response = await this.shopify.updateProductVariant({
       productId: this.productId,
       variants: [
@@ -118,7 +120,7 @@ export default {
             measurement: (this.weightUnit || this.weight) && {
               weight: {
                 unit: this.weightUnit,
-                value: this.weight,
+                value: +this.weight,
               },
             },
           },

components/shopify/common/constants.mjs

@@ -52,6 +52,13 @@ const COLLECTION_RULE_RELATIONS = [
   "STARTS_WITH",
 ];
 
+const WEIGHT_UNITS = [
+  "KILOGRAMS",
+  "GRAMS",
+  "POUNDS",
+  "OUNCES",
+];
+
 const INVENTORY_ADJUSTMENT_REASONS = [
   {
     value: "correction",
@@ -131,5 +138,6 @@ export {
   COLLECTION_SORT_KEY,
   COLLECTION_RULE_COLUMNS,
   COLLECTION_RULE_RELATIONS,
+  WEIGHT_UNITS,
   INVENTORY_ADJUSTMENT_REASONS,
 };

components/shopify/common/mutations.mjs

@@ -173,7 +173,7 @@ const CREATE_PRODUCT = `
   }
 `;
 
-const CREATE_METAFIELD = `
+const SET_METAFIELD = `
   mutation MetafieldsSet($metafields: [MetafieldsSetInput!]!) {
       metafieldsSet(metafields: $metafields) {
         metafields {
@@ -191,6 +191,21 @@ const CREATE_METAFIELD = `
     }
 `;
 
+const CREATE_METAFIELD = `
+  mutation CreateMetafieldDefinition($definition: MetafieldDefinitionInput!) {
+      metafieldDefinitionCreate(definition: $definition) {
+        createdDefinition {
+          id
+          name
+        }
+        userErrors {
+          field
+          message
+        }
+      }
+    }
+`;
+
 const CREATE_METAOBJECT = `
   mutation metaobjectCreate($metaobject: MetaobjectCreateInput!) {
     metaobjectCreate(metaobject: $metaobject) {
@@ -429,6 +444,7 @@ export default {
   CREATE_PAGE,
   CREATE_PRODUCT,
   CREATE_PRODUCT_VARIANTS,
+  SET_METAFIELD,
   CREATE_METAFIELD,
   CREATE_METAOBJECT,
   UPDATE_METAFIELD,

components/shopify/shopify.app.mjs

@@ -427,6 +427,9 @@ export default {
     createMetafield(variables) {
       return this._makeGraphQlRequest(mutations.CREATE_METAFIELD, variables);
     },
+    setMetafield(variables) {
+      return this._makeGraphQlRequest(mutations.SET_METAFIELD, variables);
+    },
     updateMetafield(variables) {
       return this._makeGraphQlRequest(mutations.UPDATE_METAFIELD, variables);
     },

components/shopify/sources/collection-updated/collection-updated.mjs

@@ -15,7 +15,7 @@ export default {
       return "COLLECTIONS_UPDATE";
     },
     generateMeta(collection) {
-      const ts = Date.parse(collection.updatedAt);
+      const ts = Date.parse(collection.updated_at);
       return {
         id: `${collection.id}${ts}`,
         summary: `Collection Updated: ${collection.title}`,