Merge pull request #144 from gadget-inc/devaoc/new-tagger

Product tagger rewrite

Author: DevAOC

.github/workflows/product-tagger-template.yaml renamed to .github/workflows/product-tagger-public-remix-ssr.yaml

@@ -3,7 +3,7 @@ name: Product Tagger Deployment
 on:
   push:
     paths:
-      - "shopify/product-tagger-template/**"
+      - "shopify/product-tagger-public-remix-ssr/**"
     branches:
       - main
   workflow_dispatch:
@@ -15,7 +15,7 @@ jobs:
       - name: Checkout the current repository
         uses: actions/checkout@v4
       - name: Push to development environment
-        run: npx ggt push --app=product-tagger-template --env=development --force --allow-unknown-directory
-        working-directory: shopify/product-tagger-template/
+        run: npx ggt push --app=product-tagger-public-remix-ssr --env=development --force --allow-unknown-directory
+        working-directory: shopify/product-tagger-public-remix-ssr/
         env:
-          GGT_TOKEN: ${{ secrets.PRODUCT_TAGGER_DEPLOY_TOKEN }}
+          GGT_TOKEN: ${{ secrets.PRODUCT_TAGGER_PUBLIC_REMIX_SSR_TOKEN }}

shopify/product-tagger-public-remix-ssr/.github/README.md

@@ -0,0 +1,12 @@
+# Product Tagger
+
+A Shopify app built with Gadget that helps merchants efficiently manage and organize their product tags. This application provides an intuitive interface for controlling which tags can be applied to products, streamlining the tagging process and maintaining consistency across your product catalog.
+
+[![Fork template](https://img.shields.io/badge/Fork%20template-%233A0CFF?style=for-the-badge)](https://app.gadget.dev/auth/fork?domain=product-tagger-public-remix-ssr.gadget.app)
+
+## Features
+
+- **Tag Management**: Create and manage a curated list of allowed product tags
+- **Shopify Integration**: Seamlessly integrates with Shopify's API for real-time product data
+- **User-Friendly Interface**: Built with Remix for a modern, responsive frontend experience
+- **Organization Tools**: Help merchants maintain consistent and organized product categorization

shopify/product-tagger-public-remix-ssr/.gitignore

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

shopify/product-tagger-template/.template/config.json renamed to shopify/product-tagger-public-remix-ssr/.template/config.json

@@ -1,91 +1,62 @@
 {
   "version": "v1",
-  "setup": "Setup.md",
-  "introduction": "Intro.md",
+  "webflow": {
+    "title": "Automated Product Tagger",
+    "description": "Automate tagging products within a Shopify store inventory. This app tracks keywords within product descriptions and creates a tag for each keyword found.",
+    "content": "webflow/content.md",
+    "mainImage": "webflow/tagger.png",
+    "wistiaId": "udboa27dyt",
+    "features": {
+      "shopify": true,
+      "frontend": true,
+      "models": true,
+      "actions": true
+    }
+  },
   "featuredModels": {
     "allowedTag": {
       "description": "Stores the tag keyword and the shop it is associated with.",
-      "featuredFields": [
-        "keyword",
-        "shop"
-      ]
+      "featuredFields": ["keyword", "shop"]
     },
     "shopifyProduct": {
       "description": "Synchronizes and stores product data from connected Shopify stores.",
-      "featuredFields": [
-        "title",
-        "body",
-        "tags"
-      ]
-    },
-    "shopifyShop": {
-      "description": "Keeps track of Shopify shops that your app has been installed on.",
-      "featuredFields": [
-        "name",
-        "syncs",
-        "shopOwner"
-      ]
+      "featuredFields": ["body", "tags"]
     }
   },
   "featuredActions": {
     "shopifyProduct": {
       "create": {
-        "description": "Reacts to Shopify's product/create events and copies the product data in your database, and then calls `applyTags()` defined in `shopifyProduct/utils.js`",
-        "tags": [
-          "edited"
-        ]
+        "description": "Reacts to Shopify's product/create events and copies the product data in your database, and then calls `applyTags` defined in `shopifyProduct/utils.js` (if the product description has changed).",
+        "tags": ["edited"]
       },
       "update": {
-        "description": "Reacts to Shopify's product/update events and copies the product data in your database, and then calls `applyTags()` defined in `shopifyProduct/utils.js`",
-        "tags": [
-          "edited"
-        ]
-      },
-      "utils.js": {
-        "description": "Matches incoming product descriptions against keywords stored in the `allowedTag` model, and then updates the products in Shopify with any matching tags.",
-        "tags": [
-          "added"
-        ]
+        "description": "Reacts to Shopify's product/update events and copies the product data in your database, and then calls `applyTags` defined in `shopifyProduct/utils.js` (if the product description has changed).",
+        "tags": ["edited"]
       }
     }
   },
+  "featuredBackends": {
+    "api/models/shopifyProduct/utils.ts": {
+      "description": "Matches incoming product descriptions against keywords stored in the `allowedTag` model, and then updates the products in Shopify with any matching tags.",
+      "tags": ["added"]
+    }
+  },
   "featuredAccessControls": {
     "shopify-app-users": {
       "allowedTag": {
-        "description": "This means you can add `allowedTags` from the authenticated admin view.",
-        "featuredFilters": {
-          "allowedTag/filters/tenancy.gelly": {
-            "description": "has been added so that merchants are only able to read tags for their store."
-          }
-        }
+        "description": "This means you can add `allowedTags` from the authenticated admin view."
       }
     }
   },
   "featuredFrontends": {
-    "components/App.jsx": {
-      "description": "Handles routing for the frontend pages.",
-      "tags": [
-        "edited"
-      ]
-    },
-    "routes/index.jsx": {
+    "web/routes/_app._index.tsx": {
       "description": "Displays an embedded Shopify Admin UI that allows merchants to add or manage their keyword list.",
-      "tags": [
-        "edited"
-      ]
+      "tags": ["edited"]
     }
   },
-  "webflow": {
-    "title": "Automated Product Tagger",
-    "description": "Automate tagging products within a Shopify store inventory. This app tracks keywords within product descriptions and creates a tag for each keyword found.",
-    "content": "webflow/content.md",
-    "mainImage": "webflow/tagger.webp",
-    "wistiaId": "udboa27dyt",
-    "features": {
-      "shopify": true,
-      "frontend": true,
-      "models": true,
-      "actions": true
+  "featuredGlobalActions": {
+    "api/actions/writeToShopify.ts": {
+      "description": "Is used to write to Shopify. In this particular application it writes tags on the product resource."
     }
   }
-}
+}

shopify/product-tagger-public-remix-ssr/.template/docs/introduction.md

@@ -0,0 +1,5 @@
+# Product Tagger
+
+Core Purpose: This app allows Shopify merchants to create and manage a curated list of "allowed tags" that can be applied to their products. Rather than letting merchants use any random tags, it provides a controlled tagging system where only pre-approved keywords can be used as product tags.
+
+Key Functionality: Merchants can define a set of approved keywords through the `allowedTag` model (each tag must be unique per shop). The app syncs with their Shopify product catalog automatically, giving them visibility into their products within the app interface. The `writeToShopify` action is used to write tag data back to Shopify, applying the approved tags to products based on merchant selections and product description. The product tagging operation is performed automatically when the product description is changed.

shopify/product-tagger-public-remix-ssr/.template/webflow/content.md

@@ -0,0 +1,5 @@
+- Automatically tag new products as they're added to the Shopify inventory.
+- Easily manage and categorize products updated or added in bulk.
+- Structures unorganized product data uploaded to Shopify.
+- Tenancy enforced: App data will be unique to the store it is installed on.
+- Ready-to-Use: No need to start from scratch – equipped with a Shopify connection, data models, backend logic, and a keyword management frontend.

shopify/product-tagger-public-remix-ssr/.template/webflow/tagger.png

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

shopify/product-tagger-public-remix-ssr/accessControl/filters/allowedTag/tenancy.gelly

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

shopify/product-tagger-public-remix-ssr/accessControl/filters/shopify/shopifyGdprRequest.gelly

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