npm - @lightspeed/crane - Versions diffs - 1.3.1 → 1.3.3 - Mend

@lightspeed/crane 1.3.1 → 1.3.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (22) hide show

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@lightspeed/crane",
-  "version": "1.3.1",
+  "version": "1.3.3",
   "type": "module",
   "bin": "bin/crane.js",
   "main": "./dist/app.mjs",
@@ -62,7 +62,7 @@
   },
   "dependencies": {
     "@jridgewell/sourcemap-codec": "^1.4.15",
-    "@lightspeed/eslint-config-crane": "1.1.1",
+    "@lightspeed/eslint-config-crane": "1.1.2",
     "@types/prompts": "^2.4.2",
     "@vitejs/plugin-vue": "^4.1.0",
     "adm-zip": "^0.5.16",
@@ -72,7 +72,7 @@
     "axios-concurrency": "^1.0.4",
     "cac": "^6.7.14",
     "cli-progress": "^3.12.0",
-    "eslint": "9.22.0",
+    "eslint": "^9.33.0",
     "fs-extra": "^11.1.1",
     "glob": "^9.3.5",
     "jsonpath-plus": "^10.3.0",

package/template/_gitignore CHANGED Viewed

@@ -9,6 +9,7 @@ lerna-debug.log*
 node_modules
 dist
+preview
 dist-ssr
 *.local
 crane.config.json

package/template/preview/sections/preview.html CHANGED Viewed

@@ -109,6 +109,8 @@
     // Render the showcase
     renderShowcase(sectionName, showcaseId);
+    fetch(`${window.location.origin}/chosen-section/${sectionName}`)
+      .catch(console.error);
   });
   // Restore saved showcase or render first available

package/template/preview/vite.config.js CHANGED Viewed

@@ -1,9 +1,11 @@
-import { defineConfig } from 'vite';
+import {defineConfig} from 'vite';
+import path from "path";
+import fs from "fs";
 export default defineConfig({
   root: '.',
   server: {
-    fs: { strict: false },
+    fs: {strict: false},
   },
   plugins: [
     {
@@ -19,13 +21,53 @@ export default defineConfig({
     {
       name: 'no-vite-cache',
       configureServer(server) {
-        // invalidate caches so that after build when user refreshes the page, the latest .mjs files are fetched
+        // use process.cwd() for analytics path
+        const analyticsDir = path.resolve(process.cwd(), 'preview', 'shared')
+        const analyticsFile = path.resolve(analyticsDir, 'analytics.json')
+        // ensure analytics folder & file exist
+        fs.mkdirSync(analyticsDir, {recursive: true})
+        if (!fs.existsSync(analyticsFile)) {
+          fs.writeFileSync(analyticsFile, JSON.stringify({}, null, 2), 'utf-8')
+        }
+        // helper to bump and persist counter for a given section
+        function bumpSectionCount(section) {
+          const raw = fs.readFileSync(analyticsFile, 'utf-8')
+          const data = JSON.parse(raw)
+          const next = (data[section] || 0) + 1
+          data[section] = next
+          fs.writeFileSync(analyticsFile, JSON.stringify(data, null, 2), 'utf-8')
+          return next
+        }
         server.middlewares.use((req, res, next) => {
-          if (req.url?.includes('/sections/')) {
-            server.moduleGraph.invalidateAll();
+            const url = req.url || ''
+            // cache-bust for any /sections/ URL
+            if (url.includes('/sections/')) {
+              server.moduleGraph.invalidateAll()
+              return next()
+            }
+            if (url.startsWith('/chosen-section')) {
+              // extract "sectionName" from "/chosen-section/<sectionName>"
+              const sectionName = req.url.replace(/\/$/, '').split('/').filter(Boolean).pop()
+              const newCount = bumpSectionCount(sectionName)
+              res.statusCode = 200
+              res.setHeader('Content-Type', 'application/json')
+              return res.end(JSON.stringify({
+                section: sectionName,
+                count: newCount
+              }))
+            }
+            // all other requests
+            next()
           }
-          next();
-        });
+        );
       },
     },
   ],

package/template/reference/templates/reference-template-apparel/configuration.ts ADDED Viewed

@@ -0,0 +1,22 @@
+export default {
+  metadata: {
+    name: 'Reference Template — Apparel',
+    description: 'This is a reference template geared towards apparel merchants to aid development and act as a starting point for your custom template.',
+    preview_url: 'https://reference-template-apparel.company.site/',
+    cover_image: {
+      set: {
+        ORIGINAL: {
+          url: 'reference_template_apparel_cover_image.jpg',
+        },
+      },
+    },
+  },
+  header: {
+    type: 'default',
+    id: 'header',
+  },
+  footer: {
+    type: 'default',
+    id: 'footer',
+  },
+};

package/template/reference/templates/reference-template-apparel/pages/catalog.ts ADDED Viewed

@@ -0,0 +1,10 @@
+import { StorePageConfiguration } from '@lightspeed/crane';
+export default {
+  sections: [
+    {
+      type: 'store',
+      id: undefined,
+    },
+  ],
+} satisfies StorePageConfiguration;

package/template/reference/templates/reference-template-apparel/pages/category.ts ADDED Viewed

@@ -0,0 +1,10 @@
+import { StorePageConfiguration } from '@lightspeed/crane';
+export default {
+  sections: [
+    {
+      type: 'store',
+      id: undefined,
+    },
+  ],
+} satisfies StorePageConfiguration;

package/template/reference/templates/reference-template-apparel/pages/home.ts ADDED Viewed

@@ -0,0 +1,24 @@
+export default {
+  sections: [
+    {
+      type: 'custom',
+      id: 'intro-slider',
+      showcase_id: '1',
+    },
+    {
+      type: 'custom',
+      id: 'tag-lines',
+      showcase_id: '1',
+    },
+    {
+      type: 'custom',
+      id: 'about-us',
+      showcase_id: '1',
+    },
+    {
+      type: 'custom',
+      id: 'example-section',
+      showcase_id: '1',
+    },
+  ],
+};

package/template/reference/templates/reference-template-apparel/pages/product.ts ADDED Viewed

@@ -0,0 +1,10 @@
+import { StorePageConfiguration } from '@lightspeed/crane';
+export default {
+  sections: [
+    {
+      type: 'store',
+      id: undefined,
+    },
+  ],
+} satisfies StorePageConfiguration;

package/template/reference/templates/reference-template-bike/configuration.ts ADDED Viewed

@@ -0,0 +1,22 @@
+export default {
+  metadata: {
+    name: 'Reference Template — Bike',
+    description: 'This is a reference template geared towards bike shops to aid development and act as a starting point for your custom template.',
+    preview_url: 'https://reference-template-bike.company.site/',
+    cover_image: {
+      set: {
+        ORIGINAL: {
+          url: 'reference_template_bike_cover_image.jpg',
+        },
+      },
+    },
+  },
+  header: {
+    type: 'default',
+    id: 'header',
+  },
+  footer: {
+    type: 'default',
+    id: 'footer',
+  },
+};

package/template/reference/templates/reference-template-bike/pages/catalog.ts ADDED Viewed

@@ -0,0 +1,10 @@
+import { StorePageConfiguration } from '@lightspeed/crane';
+export default {
+  sections: [
+    {
+      type: 'store',
+      id: undefined,
+    },
+  ],
+} satisfies StorePageConfiguration;

package/template/reference/templates/reference-template-bike/pages/category.ts ADDED Viewed

@@ -0,0 +1,10 @@
+import { StorePageConfiguration } from '@lightspeed/crane';
+export default {
+  sections: [
+    {
+      type: 'store',
+      id: undefined,
+    },
+  ],
+} satisfies StorePageConfiguration;

package/template/reference/templates/reference-template-bike/pages/home.ts ADDED Viewed

@@ -0,0 +1,24 @@
+export default {
+  sections: [
+    {
+      type: 'custom',
+      id: 'intro-slider',
+      showcase_id: '2',
+    },
+    {
+      type: 'custom',
+      id: 'example-section',
+      showcase_id: '3',
+    },
+    {
+      type: 'custom',
+      id: 'tag-lines',
+      showcase_id: '2',
+    },
+    {
+      type: 'custom',
+      id: 'about-us',
+      showcase_id: '2',
+    },
+  ],
+};

package/template/reference/templates/reference-template-bike/pages/product.ts ADDED Viewed

@@ -0,0 +1,10 @@
+import { StorePageConfiguration } from '@lightspeed/crane';
+export default {
+  sections: [
+    {
+      type: 'store',
+      id: undefined,
+    },
+  ],
+} satisfies StorePageConfiguration;

package/template/reference/templates/reference-template-apparel.ts DELETED Viewed

@@ -1,44 +0,0 @@
-export default {
-  metadata: {
-    name: 'Reference Template — Apparel',
-    description: 'This is a reference template geared towards apparel merchants to aid development and act as a starting point for your custom template.',
-    preview_url: 'https://reference-template-apparel.company.site/',
-    cover_image: {
-      set: {
-        ORIGINAL: {
-          url: 'reference_template_apparel_cover_image.jpg',
-        },
-      },
-    },
-  },
-  sections: [
-    {
-      type: 'default',
-      id: 'header',
-    },
-    {
-      type: 'custom',
-      id: 'intro-slider',
-      showcase_id: '1',
-    },
-    {
-      type: 'custom',
-      id: 'tag-lines',
-      showcase_id: '1',
-    },
-    {
-      type: 'custom',
-      id: 'about-us',
-      showcase_id: '1',
-    },
-    {
-      type: 'custom',
-      id: 'example-section',
-      showcase_id: '1',
-    },
-    {
-      type: 'default',
-      id: 'footer',
-    },
-  ],
-};

package/template/reference/templates/reference-template-bike.ts DELETED Viewed

@@ -1,44 +0,0 @@
-export default {
-  metadata: {
-    name: 'Reference Template — Bike',
-    description: 'This is a reference template geared towards bike shops to aid development and act as a starting point for your custom template.',
-    preview_url: 'https://reference-template-bike.company.site/',
-    cover_image: {
-      set: {
-        ORIGINAL: {
-          url: 'reference_template_bike_cover_image.jpg',
-        },
-      },
-    },
-  },
-  sections: [
-    {
-      type: 'default',
-      id: 'header',
-    },
-    {
-      type: 'custom',
-      id: 'intro-slider',
-      showcase_id: '2',
-    },
-    {
-      type: 'custom',
-      id: 'example-section',
-      showcase_id: '3',
-    },
-    {
-      type: 'custom',
-      id: 'tag-lines',
-      showcase_id: '2',
-    },
-    {
-      type: 'custom',
-      id: 'about-us',
-      showcase_id: '2',
-    },
-    {
-      type: 'default',
-      id: 'footer',
-    },
-  ],
-};

package/template/templates/assets/template_cover_image.png DELETED Viewed

Binary file

package/template/templates/template.ts DELETED Viewed

@@ -1,198 +0,0 @@
-export default {
-  metadata: {
-    name: 'Example Template :: Standard Preset',
-    description: 'Standard Preset for the Example template',
-    preview_url: 'https://template_preview.company.site',
-    cover_image: {
-      set: {
-        ORIGINAL: {
-          url: 'template_cover_image.png',
-        },
-      },
-    },
-  },
-  sections: [
-    {
-      type: 'default',
-      id: 'header',
-    },
-    {
-      type: 'default',
-      id: 'slider',
-      showcase_id: '001',
-    },
-    {
-      type: 'custom',
-      id: 'example-section',
-      showcase_id: '1',
-    },
-    {
-      type: 'custom',
-      id: 'example-section',
-      showcase_overrides: {
-        content: {
-          section_title: {
-            type: 'INPUTBOX',
-            text: '$label.template_standard_showcase_1.section_title.text',
-          },
-          images: {
-            type: 'DECK',
-            cards: [
-              {
-                settings: {
-                  image_text: {
-                    type: 'TEXTAREA',
-                    text: '$label.showcase_2.image_text_1.text',
-                  },
-                  image_content: {
-                    type: 'IMAGE',
-                    imageData: {
-                      set: {
-                        MOBILE_WEBP_LOW_RES: {
-                          url: 'new_tshirts_collection_mobile_low.jpeg',
-                        },
-                        MOBILE_WEBP_HI_RES: {
-                          url: 'new_tshirts_collection_mobile_high.jpeg',
-                        },
-                        WEBP_LOW_RES: {
-                          url: 'new_tshirts_collection_pc_low.jpeg',
-                        },
-                        WEBP_HI_2X_RES: {
-                          url: 'new_tshirts_collection_pc_high.jpeg',
-                        },
-                      },
-                      borderInfo: {},
-                    },
-                  },
-                  image_link: {
-                    type: 'INPUTBOX',
-                    text: '$label.showcase_2.image_link_1.text',
-                  },
-                },
-              },
-              {
-                settings: {
-                  image_text: {
-                    type: 'TEXTAREA',
-                    text: '$label.showcase_2.image_text_2.text',
-                  },
-                  image_content: {
-                    type: 'IMAGE',
-                    imageData: {
-                      set: {
-                        MOBILE_WEBP_LOW_RES: {
-                          url: 'autumn_looks_mobile_low.jpeg',
-                        },
-                        MOBILE_WEBP_HI_RES: {
-                          url: 'autumn_looks_mobile_high.jpeg',
-                        },
-                        WEBP_LOW_RES: {
-                          url: 'autumn_looks_pc_low.jpeg',
-                        },
-                        WEBP_HI_2X_RES: {
-                          url: 'autumn_looks_pc_high.jpeg',
-                        },
-                      },
-                      borderInfo: {},
-                    },
-                  },
-                },
-              },
-              {
-                settings: {
-                  image_text: {
-                    type: 'TEXTAREA',
-                    text: '$label.showcase_2.image_text_3.text',
-                  },
-                  image_content: {
-                    type: 'IMAGE',
-                    imageData: {
-                      set: {
-                        MOBILE_WEBP_LOW_RES: {
-                          url: 'bianka_wardrobe_mobile_low.jpeg',
-                        },
-                        MOBILE_WEBP_HI_RES: {
-                          url: 'bianka_wardrobe_mobile_high.jpeg',
-                        },
-                        WEBP_LOW_RES: {
-                          url: 'bianka_wardrobe_pc_low.jpeg',
-                        },
-                        WEBP_HI_2X_RES: {
-                          url: 'bianka_wardrobe_pc_high.jpeg',
-                        },
-                      },
-                      borderInfo: {},
-                    },
-                  },
-                },
-              },
-              {
-                settings: {
-                  image_text: {
-                    type: 'TEXTAREA',
-                    text: '$label.showcase_2.image_text_4.text',
-                  },
-                  image_content: {
-                    type: 'IMAGE',
-                    imageData: {
-                      set: {
-                        MOBILE_WEBP_LOW_RES: {
-                          url: 'story_of_jane_mobile_low.jpeg',
-                        },
-                        MOBILE_WEBP_HI_RES: {
-                          url: 'story_of_jane_mobile_high.jpeg',
-                        },
-                        WEBP_LOW_RES: {
-                          url: 'story_of_jane_pc_low.jpeg',
-                        },
-                        WEBP_HI_2X_RES: {
-                          url: 'story_of_jane_pc_high.jpeg',
-                        },
-                      },
-                      borderInfo: {},
-                    },
-                  },
-                },
-              },
-            ],
-          },
-        },
-        design: {
-          section_title: {
-            type: 'TEXT',
-            font: 'global.fontFamily.body',
-            size: 42,
-            bold: true,
-            italic: true,
-            color: '#222',
-          },
-          image_text: {
-            type: 'TEXT',
-            size: 22,
-            bold: false,
-            italic: true,
-          },
-          background: {
-            type: 'BACKGROUND',
-            style: 'COLOR',
-            color: 'global.color.background',
-          },
-          image_content: {
-            type: 'IMAGE',
-            overlay: 'GRADIENT',
-            color: ['#FFFFFF', '#CCCCCC'],
-          },
-        },
-        layoutId: 'Caption_Under_Image',
-        blockName: '$label.showcase_2.blockName',
-      },
-    },
-    {
-      type: 'default',
-      id: 'footer',
-    },
-  ],
-};