Merge pull request #243 from gadget-inc/riley/product-tagger-1-7

update product tagger template to v1.7, polaris web components, react router

Author: rdraward

shopify/product-tagger-public-template/.gitignore

@@ -0,0 +1,11 @@
+.gadget/
+node_modules/
+**/.DS_Store
+.react-router/
+
+# Shopify
+extensions/**/dist
+extensions/**/node_modules
+extensions/**/generated
+.env.*
+.shopify/

shopify/product-tagger-public-template/README.md

@@ -0,0 +1,29 @@
+# Product Tagger
+
+Product Tagger lets merchants define approved keywords and automatically applies them as Shopify product tags when those keywords appear in a product's description.
+
+## Setup
+
+1. Connect the app to Shopifand install it on a development store in Gadget: **Settings** > **Plugins** > **Shopify** > **Connect a Shopify app**
+2. Open the embedded app in Shopify Admin and add one or more allowed keywords.
+3. Create or update a Shopify product whose description includes one of those keywords.
+4. After the Shopify product webhook runs, the matching keywords should appear on the product as tags.
+
+## How it works
+
+- Merchants manage approved keywords in the embedded app UI.
+- Keywords are stored per shop using the `allowedTag` model.
+- Shopify product create and update actions call [`api/models/shopifyProduct/utils.ts`](/Users/gadget/Projects/templates/shopify/product-tagger-public-template/api/models/shopifyProduct/utils.ts).
+- The helper strips HTML from the product description, extracts candidate words, and queries only matching `allowedTag` records for the current shop.
+- Matching keywords are merged with the product's existing tags and written back to Shopify with `api.enqueue(shopify.graphql, ...)` so the write can be retried safely in the background.
+
+This keeps the app's behavior simple while avoiding a full scan of every allowed tag on each Shopify product webhook.
+
+## Key files
+
+- [`shopify.app.toml`](/Users/gadget/Projects/templates/shopify/product-tagger-public-template/shopify.app.toml): Shopify app configuration and scopes
+- [`web/routes/_app._index.tsx`](/Users/gadget/Projects/templates/shopify/product-tagger-public-template/web/routes/_app._index.tsx): Embedded app UI for managing allowed tags
+- [`api/models/allowedTag/schema.gadget.ts`](/Users/gadget/Projects/templates/shopify/product-tagger-public-template/api/models/allowedTag/schema.gadget.ts): Merchant-defined keyword model
+- [`api/models/shopifyProduct/actions/create.ts`](/Users/gadget/Projects/templates/shopify/product-tagger-public-template/api/models/shopifyProduct/actions/create.ts): Trigger for new Shopify products
+- [`api/models/shopifyProduct/actions/update.ts`](/Users/gadget/Projects/templates/shopify/product-tagger-public-template/api/models/shopifyProduct/actions/update.ts): Trigger for product description changes
+- [`api/models/shopifyProduct/utils.ts`](/Users/gadget/Projects/templates/shopify/product-tagger-public-template/api/models/shopifyProduct/utils.ts): Keyword matching and Shopify tag application logic

shopify/product-tagger-public-template/accessControl/filters/allowedTag/allowedTag.gelly

@@ -0,0 +1,3 @@
+filter ($session: Session) on AllowedTag [
+  where shopId == $session.shopId
+]

shopify/product-tagger-public-template/accessControl/filters/shopify/shopifyGdprRequest.gelly

@@ -0,0 +1,3 @@
+filter ($session: Session) on ShopifyGdprRequest [
+  where shopId == $session.shopId
+]

shopify/product-tagger-public-template/accessControl/filters/shopify/shopifyProduct.gelly

@@ -0,0 +1,3 @@
+filter ($session: Session) on ShopifyProduct [
+  where shopId == $session.shopId
+]

shopify/product-tagger-public-template/accessControl/filters/shopify/shopifyShop.gelly

@@ -0,0 +1,3 @@
+filter ($session: Session) on ShopifyShop [
+  where id == $session.shopId
+]

shopify/product-tagger-public-template/accessControl/filters/shopify/shopifySync.gelly

@@ -0,0 +1,3 @@
+filter ($session: Session) on ShopifySync [
+  where shopId == $session.shopId
+]

shopify/product-tagger-public-template/accessControl/permissions.gadget.ts

@@ -0,0 +1,74 @@
+import type { GadgetPermissions } from "gadget-server";
+
+/**
+ * This metadata describes the access control configuration available in your application.
+ * Grants that are not defined here are set to false by default.
+ *
+ * View and edit your roles and permissions in the Gadget editor at https://product-tagger-public-template.gadget.app/edit/settings/permissions
+ */
+export const permissions: GadgetPermissions = {
+  type: "gadget/permissions/v1",
+  roles: {
+    "shopify-app-users": {
+      storageKey: "Role-Shopify-App",
+      models: {
+        allowedTag: {
+          read: {
+            filter:
+              "accessControl/filters/allowedTag/allowedTag.gelly",
+          },
+          actions: {
+            create: true,
+            delete: true,
+          },
+        },
+        shopifyGdprRequest: {
+          read: {
+            filter:
+              "accessControl/filters/shopify/shopifyGdprRequest.gelly",
+          },
+          actions: {
+            create: true,
+            update: true,
+          },
+        },
+        shopifyProduct: {
+          read: {
+            filter:
+              "accessControl/filters/shopify/shopifyProduct.gelly",
+          },
+          actions: {
+            create: true,
+            delete: true,
+            update: true,
+          },
+        },
+        shopifyShop: {
+          read: {
+            filter: "accessControl/filters/shopify/shopifyShop.gelly",
+          },
+          actions: {
+            install: true,
+            reinstall: true,
+            uninstall: true,
+            update: true,
+          },
+        },
+        shopifySync: {
+          read: {
+            filter: "accessControl/filters/shopify/shopifySync.gelly",
+          },
+          actions: {
+            abort: true,
+            complete: true,
+            error: true,
+            run: true,
+          },
+        },
+      },
+    },
+    unauthenticated: {
+      storageKey: "unauthenticated",
+    },
+  },
+};

shopify/product-tagger-public-template/api/models/allowedTag/actions/create.ts

@@ -0,0 +1,11 @@
+import { applyParams, save, ActionOptions, preventCrossShopDataAccess } from "gadget-server";
+
+export const run: ActionRun = async ({ params, record, logger, api, connections }) => {
+  applyParams(params, record);
+  await preventCrossShopDataAccess(params, record);
+  await save(record);
+};
+
+export const options: ActionOptions = {
+  actionType: "create",
+};

shopify/product-tagger-public-template/api/models/allowedTag/actions/delete.ts

@@ -0,0 +1,10 @@
+import { deleteRecord, ActionOptions, preventCrossShopDataAccess } from "gadget-server";
+
+export const run: ActionRun = async ({ params, record, logger, api, connections }) => {
+  await preventCrossShopDataAccess(params, record);
+  await deleteRecord(record);
+};
+
+export const options: ActionOptions = {
+  actionType: "delete",
+};