@standhigher/besttrack-page-extension 0.3.0 → 0.5.0

package/dist/validation.d.ts

@@ -0,0 +1,9 @@
+import { PageBuilderExtension } from '@standhigher/puck-page-builder/runtime';
+
+/**
+ * Server-safe contracts for validating persisted documents. They intentionally
+ * omit React fields and renderers so Route Handlers never import client code.
+ */
+declare const bestTrackDocumentValidationExtensions: PageBuilderExtension[];
+
+export { bestTrackDocumentValidationExtensions };

package/dist/validation.js

@@ -0,0 +1,122 @@
+import {
+  isSafeTrackingPageUrl,
+  isShopifyResourceReference,
+  isValidTrackingNumber
+} from "./chunk-KD7KFFFK.js";
+
+// src/validation.ts
+var textField = { field: "besttrack.validation.text", control: "text" };
+var productsField = { field: "besttrack.validation.products", control: "products" };
+var strictUrlField = {
+  field: "besttrack.validation.url",
+  control: "url",
+  validation: { allowRelativeUrl: false, allowedUrlProtocols: ["https:"], allowLocalhost: true }
+};
+function fields(keys, urlKeys = [], resourceKeys = [], productsKeys = []) {
+  return Object.fromEntries(keys.map((key) => [key, productsKeys.includes(key) ? productsField : resourceKeys.includes(key) ? { field: "besttrack.validation.resource" } : urlKeys.includes(key) ? strictUrlField : textField]));
+}
+function block(type, version, keys, variants, validate, urlKeys = [], resourceKeys = [], productsKeys = []) {
+  return {
+    type,
+    version,
+    label: type,
+    category: "BestTrack",
+    targets: ["web"],
+    defaultProps: {},
+    fields: fields(keys, urlKeys, resourceKeys, productsKeys),
+    defaultVariant: variants[0],
+    variants: variants.map((id) => ({ id, label: id })),
+    validate,
+    render: {}
+  };
+}
+function requiredString(props, key, issues, maxLength = 160) {
+  const value = props[key];
+  if (typeof value !== "string" || !value.trim()) issues.push({ path: `props.${key}`, message: "A non-empty value is required." });
+  else if (value.length > maxLength) issues.push({ path: `props.${key}`, message: `Must be at most ${maxLength} characters.` });
+}
+function textProps(keys) {
+  return (props) => {
+    const issues = [];
+    keys.forEach(([key, maxLength]) => requiredString(props, key, issues, maxLength));
+    return issues;
+  };
+}
+function validateSalesQuery(props) {
+  const issues = textProps([["heading", 120], ["submitLabel", 80]])(props);
+  if (typeof props.defaultTrackingNumber !== "string" || !isValidTrackingNumber(props.defaultTrackingNumber)) {
+    issues.push({ path: "props.defaultTrackingNumber", message: "Use 6-64 letters, numbers, hyphens, or underscores. Use a non-sensitive preview placeholder only." });
+  }
+  if (props.heroImageUrl !== void 0 && !isSafeTrackingPageUrl(props.heroImageUrl)) {
+    issues.push({ path: "props.heroImageUrl", message: "Use an HTTPS URL for the merchant-configured hero image." });
+  }
+  return issues;
+}
+function validateCategories(props) {
+  const issues = textProps([["heading", 120]])(props);
+  if (!isShopifyResourceReference(props.collection, "collection")) {
+    issues.push({ path: "props.collection", message: "Select a Shopify collection through an authorized resource integration." });
+  }
+  return issues;
+}
+function validateFeaturedProduct(props) {
+  const issues = textProps([["heading", 120]])(props);
+  if (!isShopifyResourceReference(props.product, "product")) {
+    issues.push({ path: "props.product", message: "Select a Shopify product through an authorized resource integration." });
+  }
+  return issues;
+}
+var readyToGoContracts = [
+  block("besttrack.ready-to-go.query", 1, ["heading", "submitLabel", "defaultTrackingNumber", "defaultOrderNumber", "defaultQueryMode", "trackingTabLabel", "orderTabLabel"], ["default"]),
+  block("besttrack.ready-to-go.progress", 1, [], ["default"]),
+  block("besttrack.ready-to-go.delivery", 1, ["heading", "contentsHeading", "carrierHeading"], ["default", "compact"]),
+  block("besttrack.ready-to-go.recommendations", 1, ["heading", "products"], ["default", "grid"], void 0, [], [], ["products"])
+];
+var brandedContracts = [
+  block("besttrack.branded.announcement", 1, ["message", "href"], ["brand", "minimal"], void 0, ["href"]),
+  block("besttrack.branded.tracking-experience", 1, ["heading", "submitLabel", "trackAnotherLabel", "defaultTrackingNumber", "defaultOrderNumber", "defaultQueryMode", "trackingTabLabel", "orderTabLabel", "shipmentLabels", "heroImageUrl"], ["brand", "compact"], void 0, ["heroImageUrl"]),
+  block("besttrack.branded.query", 1, ["heading", "submitLabel", "defaultTrackingNumber", "defaultOrderNumber", "defaultQueryMode", "trackingTabLabel", "orderTabLabel", "shipmentLabels", "heroImageUrl"], ["brand", "compact"], void 0, ["heroImageUrl"]),
+  block("besttrack.branded.order-items", 1, ["heading"], ["brand", "minimal"]),
+  block("besttrack.branded.recommendations", 1, ["heading", "hideWhenEmpty"], ["brand", "editorial"]),
+  block("besttrack.branded.quick-links", 1, ["heading", "primaryLabel", "primaryHref", "secondaryLabel", "secondaryHref"], ["brand"], void 0, ["primaryHref", "secondaryHref"]),
+  block("besttrack.branded.blog", 1, ["heading", "articleTitle", "excerpt", "articleHref", "linkLabel"], ["brand"], void 0, ["articleHref"])
+];
+var salesContracts = [
+  block("besttrack.sales.announcement", 1, ["message"], ["hero", "commerce", "minimal"], textProps([["message", 280]])),
+  block("besttrack.sales.query", 1, ["heading", "submitLabel", "defaultTrackingNumber", "defaultOrderNumber", "heroImageUrl"], ["hero", "commerce", "compact"], validateSalesQuery, ["heroImageUrl"]),
+  block("besttrack.sales.order-items", 1, ["heading"], ["hero", "commerce"], textProps([["heading", 120]])),
+  block("besttrack.sales.other-tracking", 1, ["heading", "emptyMessage"], ["hero", "commerce"], textProps([["heading", 120], ["emptyMessage", 280]])),
+  block("besttrack.sales.service-cards", 1, ["heading", "firstTitle", "firstDescription", "secondTitle", "secondDescription"], ["hero", "commerce"], textProps([["heading", 120], ["firstTitle", 120], ["firstDescription", 280], ["secondTitle", 120], ["secondDescription", 280]])),
+  block("besttrack.sales.product-categories", 3, ["heading", "collection"], ["hero", "commerce", "grid"], validateCategories, [], ["collection"]),
+  block("besttrack.sales.featured-product", 1, ["heading", "product"], ["hero", "commerce"], validateFeaturedProduct, [], ["product"]),
+  block("besttrack.sales.recommendations", 1, ["heading"], ["hero", "commerce", "grid"], textProps([["heading", 120]]))
+];
+function template(id, version, requiredBlocks) {
+  return {
+    id,
+    version,
+    name: id,
+    target: "web",
+    source: "built-in",
+    requiredBlocks: requiredBlocks.map((contract) => contract.type),
+    create: () => {
+      throw new Error("The validation-only template cannot create a PageDocument.");
+    }
+  };
+}
+function extension(name, contracts, templateVersion, requiredBlocks = contracts) {
+  return Object.freeze({
+    name,
+    version: "0.8.0",
+    blocks: contracts,
+    templates: [template(name, templateVersion, requiredBlocks)]
+  });
+}
+var bestTrackDocumentValidationExtensions = [
+  extension("besttrack.ready-to-go", readyToGoContracts, 1),
+  extension("besttrack.branded", brandedContracts, 1, brandedContracts.filter((contract) => !["besttrack.branded.query", "besttrack.branded.order-items"].includes(contract.type))),
+  extension("besttrack.sales", salesContracts, 3)
+];
+export {
+  bestTrackDocumentValidationExtensions
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@standhigher/besttrack-page-extension",
-  "version": "0.3.0",
+  "version": "0.5.0",
   "description": "BestTrack business extension entry point for @standhigher/puck-page-builder.",
   "type": "module",
   "files": [
@@ -13,10 +13,16 @@
     ".": {
       "types": "./dist/index.d.ts",
       "import": "./dist/index.js"
+    },
+    "./validation": {
+      "types": "./dist/validation.d.ts",
+      "import": "./dist/validation.js"
     }
   },
   "dependencies": {
-    "@standhigher/puck-page-builder": "0.9.0"
+    "embla-carousel-autoplay": "^8.6.0",
+    "embla-carousel-react": "^8.6.0",
+    "@standhigher/puck-page-builder": "0.12.0"
   },
   "devDependencies": {
     "tsup": "^8.5.1",
@@ -26,7 +32,7 @@
     "react": "^18.0.0"
   },
   "scripts": {
-    "build": "tsup src/index.ts --format esm --dts --clean",
+    "build": "tsup src/index.ts src/validation.ts --format esm --dts --clean",
     "typecheck": "tsc --noEmit"
   }
 }