fix metafield actions

michelle0927 · michelle0927 · commit bf832a011378 · 2025-03-14T14:04:46.000-04:00
diff --git a/components/shopify_developer_app/actions/common/metafield-actions.mjs b/components/shopify_developer_app/actions/common/metafield-actions.mjs
@@ -98,7 +98,7 @@ export default {
           },
         },
         customer: {
-          ...shopify.propDefinition.customerId,
+          ...shopify.propDefinitions.customerId,
           options: async ({ prevContext }) => {
             return this.shopify.getPropOptions({
               resourceFn: this.shopify.listCustomers,
diff --git a/components/shopify_developer_app/actions/create-metafield/create-metafield.mjs b/components/shopify_developer_app/actions/create-metafield/create-metafield.mjs
@@ -1,13 +1,11 @@
 import metafieldActions from "../common/metafield-actions.mjs";
 import common from "@pipedream/shopify/actions/create-metafield/create-metafield.mjs";
 import shopify from "../../shopify_developer_app.app.mjs";
-
-import { adjustPropDefinitions } from "../../common/utils.mjs";
+import constants from "../common/constants.mjs";
 
 const {
   name, description, type, ...others
 } = common;
-const props = adjustPropDefinitions(others.props, shopify);
 
 export default {
   ...others,
@@ -18,8 +16,43 @@ export default {
   type,
   props: {
     shopify,
-    ...props,
-    ...common.props,
+    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,
diff --git a/components/shopify_developer_app/actions/delete-metafield/delete-metafield.mjs b/components/shopify_developer_app/actions/delete-metafield/delete-metafield.mjs
@@ -2,12 +2,9 @@ import metafieldActions from "../common/metafield-actions.mjs";
 import common from "@pipedream/shopify/actions/delete-metafield/delete-metafield.mjs";
 import shopify from "../../shopify_developer_app.app.mjs";
 
-import { adjustPropDefinitions } from "../../common/utils.mjs";
-
 const {
   name, description, type, ...others
 } = common;
-const props = adjustPropDefinitions(others.props, shopify);
 
 export default {
   ...others,
@@ -18,11 +15,38 @@ export default {
   type,
   props: {
     shopify,
-    ...props,
-    ...common.props,
+    ...metafieldActions.props,
   },
   methods: {
     ...metafieldActions.methods,
-    ...common.methods,
+  },
+  async additionalProps() {
+    const props = await this.getOwnerIdProp(this.ownerResource); console.log(props);
+
+    if (props.ownerId) {
+      props.ownerId = {
+        ...props.ownerId,
+        reloadProps: true,
+      };
+    }
+
+    if (this.ownerResource && this.ownerId) {
+      props.metafieldId = {
+        type: "string",
+        label: "Metafield ID",
+        description: "The metafield to update",
+        options: async () => {
+          const metafields = await this.listMetafields(this.ownerResource, this.ownerId);
+          return metafields?.map(({
+            id: value, key: label,
+          }) => ({
+            value,
+            label,
+          })) || [];
+        },
+      };
+    }
+
+    return props;
   },
 };
diff --git a/components/shopify_developer_app/actions/get-metafields/get-metafields.mjs b/components/shopify_developer_app/actions/get-metafields/get-metafields.mjs
@@ -2,20 +2,50 @@ import metafieldActions from "../common/metafield-actions.mjs";
 import common from "@pipedream/shopify/actions/get-metafields/get-metafields.mjs";
 import shopify from "../../shopify_developer_app.app.mjs";
 
+const {
+  name, description, type,
+} = common;
+
 export default {
-  ...common,
   key: "shopify_developer_app-get-metafields",
-  name: "Get Metafields",
-  description: "Retrieves a list of metafields that belong to a resource. [See the documentation](https://shopify.dev/docs/api/admin-graphql/unstable/queries/metafields)",
   version: "0.0.6",
-  type: "action",
+  name,
+  description,
+  type,
   props: {
     shopify,
     ...metafieldActions.props,
-    ...common.props,
+    namespace: {
+      type: "string[]",
+      label: "Namespace",
+      description: "Filter results by namespace",
+      optional: true,
+    },
+    key: {
+      type: "string[]",
+      label: "Key",
+      description: "Filter results by key",
+      optional: true,
+    },
   },
   methods: {
     ...metafieldActions.methods,
-    ...common.methods,
+  },
+  async additionalProps() {
+    return this.getOwnerIdProp(this.ownerResource);
+  },
+  async run({ $ }) {
+    let response = await this.listMetafields(this.ownerResource, this.ownerId);
+
+    if (this.namespace?.length > 0) {
+      response = response.filter((field) => this.namespace.includes(field.namespace));
+    }
+
+    if (this.key?.length > 0) {
+      response = response.filter((field) => this.key.includes(field.key));
+    }
+
+    $.export("$summary", `Found ${response.length} metafield(s) for object with ID ${this.ownerId}`);
+    return response;
   },
 };
diff --git a/components/shopify_developer_app/actions/update-metafield/update-metafield.mjs b/components/shopify_developer_app/actions/update-metafield/update-metafield.mjs
@@ -2,12 +2,9 @@ import metafieldActions from "../common/metafield-actions.mjs";
 import common from "@pipedream/shopify/actions/update-metafield/update-metafield.mjs";
 import shopify from "../../shopify_developer_app.app.mjs";
 
-import { adjustPropDefinitions } from "../../common/utils.mjs";
-
 const {
   name, description, type, ...others
 } = common;
-const props = adjustPropDefinitions(others.props, shopify);
 
 export default {
   ...others,
@@ -18,8 +15,7 @@ export default {
   type,
   props: {
     shopify,
-    ...props,
-    ...common.props,
+    ...metafieldActions.props,
   },
   async additionalProps() {
     const props = await this.getOwnerIdProp(this.ownerResource);
@@ -39,7 +35,6 @@ export default {
   },
   methods: {
     ...metafieldActions.methods,
-    ...common.methods,
     async getOwnerIdProp(ownerResource) {
       const resources = {
         product: shopify.propDefinitions.productId,
@@ -62,7 +57,7 @@ export default {
 
       const props = {};
 
-      if (ownerResource === "variants" || ownerResource === "product_image") {
+      if (ownerResource === "variants") {
         props.productId = resources.product;
       }
       if (ownerResource === "article") {
diff --git a/components/shopify_developer_app/common/queries.mjs b/components/shopify_developer_app/common/queries.mjs
@@ -109,7 +109,7 @@ const LIST_ORDERS = `
       nodes {
         id
         updatedAt
-        metafields (first: $first) {
+        metafields (first: $first, after: $after) {
           nodes {
             id
             key
@@ -119,6 +119,9 @@ const LIST_ORDERS = `
           }
         }
       }
+      pageInfo {
+        endCursor
+      }
     }
   }
 `;
@@ -128,7 +131,7 @@ const LIST_DRAFT_ORDERS = `
     draftOrders(first: $first, after: $after) {
       nodes {
         id
-        metafields (first: $first) {
+        metafields (first: $first, after: $after) {
           nodes {
             id
             key
@@ -138,6 +141,9 @@ const LIST_DRAFT_ORDERS = `
           }
         }
       }
+      pageInfo {
+        endCursor
+      }
     }
   }
 `;
@@ -148,7 +154,7 @@ const LIST_CUSTOMERS = `
       nodes {
         id
         displayName
-        metafields (first: $first) {
+        metafields (first: $first, after: $after) {
           nodes {
             id
             key
@@ -158,6 +164,9 @@ const LIST_CUSTOMERS = `
           }
         }
       }
+      pageInfo {
+        endCursor
+      }
     }
   }
 `;
diff --git a/components/shopify_developer_app/shopify_developer_app.app.mjs b/components/shopify_developer_app/shopify_developer_app.app.mjs
@@ -2,12 +2,14 @@ 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",
@@ -111,6 +113,7 @@ export default {
         shopName: this.getShopId(),
         accessToken: this.$auth.access_token,
         autoLimit: true,
+        apiVersion: API_VERSION,
       });
     },
     getOrder(variables) {

Original file line number	Diff line number	Diff line change
@@ -109,7 +109,7 @@ const LIST_ORDERS = `
`109`	`109`	`nodes {`
`110`	`110`	`id`
`111`	`111`	`updatedAt`
`112`		`- metafields (first: $first) {`
	`112`	`+ metafields (first: $first, after: $after) {`
`113`	`113`	`nodes {`
`114`	`114`	`id`
`115`	`115`	`key`
@@ -119,6 +119,9 @@ const LIST_ORDERS = `
`119`	`119`	`}`
`120`	`120`	`}`
`121`	`121`	`}`
	`122`	`+ pageInfo {`
	`123`	`+ endCursor`
	`124`	`+ }`
`122`	`125`	`}`
`123`	`126`	`}`
`124`	`127`	`;
@@ -128,7 +131,7 @@ const LIST_DRAFT_ORDERS = `
`128`	`131`	`draftOrders(first: $first, after: $after) {`
`129`	`132`	`nodes {`
`130`	`133`	`id`
`131`		`- metafields (first: $first) {`
	`134`	`+ metafields (first: $first, after: $after) {`
`132`	`135`	`nodes {`
`133`	`136`	`id`
`134`	`137`	`key`
@@ -138,6 +141,9 @@ const LIST_DRAFT_ORDERS = `
`138`	`141`	`}`
`139`	`142`	`}`
`140`	`143`	`}`
	`144`	`+ pageInfo {`
	`145`	`+ endCursor`
	`146`	`+ }`
`141`	`147`	`}`
`142`	`148`	`}`
`143`	`149`	`;
@@ -148,7 +154,7 @@ const LIST_CUSTOMERS = `
`148`	`154`	`nodes {`
`149`	`155`	`id`
`150`	`156`	`displayName`
`151`		`- metafields (first: $first) {`
	`157`	`+ metafields (first: $first, after: $after) {`
`152`	`158`	`nodes {`
`153`	`159`	`id`
`154`	`160`	`key`
@@ -158,6 +164,9 @@ const LIST_CUSTOMERS = `
`158`	`164`	`}`
`159`	`165`	`}`
`160`	`166`	`}`
	`167`	`+ pageInfo {`
	`168`	`+ endCursor`
	`169`	`+ }`
`161`	`170`	`}`
`162`	`171`	`}`
`163`	`172`	`;