@porulle/adapter-shopify 0.77.1 → 0.78.0

package/dist/catalog.d.ts

@@ -8,9 +8,9 @@ import type { ShopifyGraphqlTarget } from "./graphql.js";
  * single-query ceiling while halving the number of calls a large catalogue takes.
  */
 export declare const CATALOG_PAGE_PRODUCTS = 50;
-export declare const CATALOG_PAGE_QUERY = "query PorulleCatalogPage($first: Int!, $after: String) {\n  shop { currencyCode }\n  products(first: $first, after: $after, sortKey: ID) { pageInfo { hasNextPage endCursor } nodes { \n  legacyResourceId title handle status descriptionHtml vendor productType tags onlineStoreUrl\n  category { name }\n  options { name position optionValues { name } }\n  media(first: 20) { nodes { id alt mediaContentType ... on MediaImage { image { url } } } }\n  variants(first: 25) { pageInfo { hasNextPage endCursor } nodes { \n  legacyResourceId sku price compareAtPrice inventoryQuantity\n  barcodes(first: 1) { nodes { value } }\n  selectedOptions { name value }\n  media(first: 1) { nodes { id } }\n  inventoryItem { legacyResourceId measurement { weight { unit value } } } } } } }\n}";
+export declare const CATALOG_PAGE_QUERY = "query PorulleCatalogPage($first: Int!, $after: String) {\n  shop { currencyCode }\n  products(first: $first, after: $after, sortKey: ID) { pageInfo { hasNextPage endCursor } nodes { \n  legacyResourceId title handle status descriptionHtml vendor productType tags onlineStoreUrl\n  category { id name }\n  options { name position optionValues { name } }\n  media(first: 20) { nodes { id alt mediaContentType ... on MediaImage { image { url } } } }\n  variants(first: 25) { pageInfo { hasNextPage endCursor } nodes { \n  legacyResourceId sku price compareAtPrice inventoryQuantity\n  barcodes(first: 1) { nodes { value } }\n  selectedOptions { name value }\n  media(first: 1) { nodes { id } }\n  inventoryItem { legacyResourceId measurement { weight { unit value } } } } } } }\n}";
 export declare const VARIANTS_PAGE_QUERY = "query PorulleProductVariants($id: ID!, $after: String) {\n  product(id: $id) { variants(first: 250, after: $after) { pageInfo { hasNextPage endCursor } nodes { \n  legacyResourceId sku price compareAtPrice inventoryQuantity\n  barcodes(first: 1) { nodes { value } }\n  selectedOptions { name value }\n  media(first: 1) { nodes { id } }\n  inventoryItem { legacyResourceId measurement { weight { unit value } } } } } }\n}";
-export declare const CATALOG_ITEMS_QUERY = "query PorulleCatalogItems($ids: [ID!]!) {\n  shop { currencyCode }\n  nodes(ids: $ids) { ... on Product { \n  legacyResourceId title handle status descriptionHtml vendor productType tags onlineStoreUrl\n  category { name }\n  options { name position optionValues { name } }\n  media(first: 20) { nodes { id alt mediaContentType ... on MediaImage { image { url } } } }\n  variants(first: 25) { pageInfo { hasNextPage endCursor } nodes { \n  legacyResourceId sku price compareAtPrice inventoryQuantity\n  barcodes(first: 1) { nodes { value } }\n  selectedOptions { name value }\n  media(first: 1) { nodes { id } }\n  inventoryItem { legacyResourceId measurement { weight { unit value } } } } } } }\n}";
+export declare const CATALOG_ITEMS_QUERY = "query PorulleCatalogItems($ids: [ID!]!) {\n  shop { currencyCode }\n  nodes(ids: $ids) { ... on Product { \n  legacyResourceId title handle status descriptionHtml vendor productType tags onlineStoreUrl\n  category { id name }\n  options { name position optionValues { name } }\n  media(first: 20) { nodes { id alt mediaContentType ... on MediaImage { image { url } } } }\n  variants(first: 25) { pageInfo { hasNextPage endCursor } nodes { \n  legacyResourceId sku price compareAtPrice inventoryQuantity\n  barcodes(first: 1) { nodes { value } }\n  selectedOptions { name value }\n  media(first: 1) { nodes { id } }\n  inventoryItem { legacyResourceId measurement { weight { unit value } } } } } } }\n}";
 declare const variantSchema: z.ZodObject<{
     legacyResourceId: z.ZodString;
     sku: z.ZodNullable<z.ZodString>;
@@ -53,6 +53,7 @@ declare const productSchema: z.ZodObject<{
     tags: z.ZodArray<z.ZodString>;
     onlineStoreUrl: z.ZodNullable<z.ZodString>;
     category: z.ZodNullable<z.ZodObject<{
+        id: z.ZodString;
         name: z.ZodString;
     }, z.core.$strip>>;
     options: z.ZodArray<z.ZodObject<{
@@ -130,6 +131,7 @@ export declare const catalogPageSchema: z.ZodObject<{
             tags: z.ZodArray<z.ZodString>;
             onlineStoreUrl: z.ZodNullable<z.ZodString>;
             category: z.ZodNullable<z.ZodObject<{
+                id: z.ZodString;
                 name: z.ZodString;
             }, z.core.$strip>>;
             options: z.ZodArray<z.ZodObject<{

package/dist/catalog.js

@@ -20,7 +20,7 @@ const VARIANT_FIELDS = `
   inventoryItem { legacyResourceId measurement { weight { unit value } } }`;
 const PRODUCT_FIELDS = `
   legacyResourceId title handle status descriptionHtml vendor productType tags onlineStoreUrl
-  category { name }
+  category { id name }
   options { name position optionValues { name } }
   media(first: ${MEDIA_PER_PRODUCT}) { nodes { id alt mediaContentType ... on MediaImage { image { url } } } }
   variants(first: ${VARIANTS_WITH_PRODUCT}) { pageInfo { hasNextPage endCursor } nodes { ${VARIANT_FIELDS} } }`;
@@ -61,7 +61,7 @@ const productSchema = z.object({
     productType: z.string(),
     tags: z.array(z.string()),
     onlineStoreUrl: z.string().nullable(),
-    category: z.object({ name: z.string() }).nullable(),
+    category: z.object({ id: z.string(), name: z.string() }).nullable(),
     options: z.array(z.object({ name: z.string(), position: z.number(), optionValues: z.array(z.object({ name: z.string() })) })),
     media: z.object({
         nodes: z.array(z.object({
@@ -119,10 +119,18 @@ function catalogStatus(status) {
 function slugify(value) {
     return value.toLowerCase().trim().replace(/[^a-z0-9]+/g, "-").replace(/^-+|-+$/g, "");
 }
+/** `gid://shopify/TaxonomyCategory/aa-1-4` → `aa-1-4`, the Standard Product Taxonomy's own id. */
+function taxonomyCategoryId(gid) {
+    const id = gid.slice(gid.lastIndexOf("/") + 1);
+    return /^[a-z]{2}(-\d+)*$/.test(id) ? id : undefined;
+}
 export function toCatalogItem(product, variants, currency) {
     const images = product.media.nodes.flatMap((media) => (media.mediaContentType === "IMAGE" && media.image ? [{ id: media.id, url: media.image.url, alt: media.alt }] : []));
     const category = product.productType ? slugify(product.productType) : product.category ? slugify(product.category.name) : "";
     const storefrontUrl = product.onlineStoreUrl;
+    // The merchant's (or Shopify's) Standard Product Taxonomy category, as Shopify's own id. A
+    // platform that classifies against the same taxonomy reads it instead of guessing from text.
+    const shopifyCategory = product.category ? taxonomyCategoryId(product.category.id) : undefined;
     return {
         externalId: product.legacyResourceId,
         slug: product.handle,
@@ -164,6 +172,7 @@ export function toCatalogItem(product, variants, currency) {
         // Only Shopify's own answer. Null means the product is not on the Online Store channel; a URL
         // assembled from the handle would be a guess that 404s on any shop with a custom route.
         ...(storefrontUrl ? { storefrontUrl } : {}),
+        ...(shopifyCategory ? { metadata: { shopifyTaxonomyCategoryId: shopifyCategory } } : {}),
     };
 }
 /** Every variant of `product`: the ones read with it, then the rest a page at a time. */