@standhigher/besttrack-page-extension 0.1.0 → 0.2.1

package/README.md

@@ -6,4 +6,9 @@ host-injected tracking query contract as Ready-to-go. Logo and content are
 JSON-only block props; brand colour, font and radius use the template Theme
 Tokens and may be overridden through PageDocument.theme.
 
-V0.7.0 provides the Ready-to-go built-in template: order query, shipment progress, delivery information and recommendations. Live tracking is injected by the host Runtime; this package never stores credentials or network endpoints in a `PageDocument`.
+V0.7.0 provides the Ready-to-go built-in template: order query, shipment
+progress, delivery information and recommendations. The consumer surface follows
+the Shopify Track Page layout (query card, five-step progress, shipping
+timeline, package contents and product cards) using inline styles and `--pb-*`
+Theme Tokens. Live tracking is injected by the host Runtime; this package never
+stores credentials or network endpoints in a `PageDocument`.

package/dist/index.d.ts

@@ -2,6 +2,51 @@ import * as react from 'react';
 import { ReactNode } from 'react';
 import { PageBuilderExtension, TemplateDefinition } from '@standhigher/puck-page-builder/runtime';
 
+type ReadyToGoOrderItem = {
+    id: string;
+    title: string;
+    quantity: number;
+    imageUrl?: string;
+    description?: string;
+    href?: string;
+};
+type ReadyToGoRecommendation = {
+    id: string;
+    title: string;
+    description: string;
+    imageUrl?: string;
+    href?: string;
+    price?: string;
+};
+type ReadyToGoTrackingStep = {
+    id: string;
+    label: string;
+    state: "complete" | "current" | "upcoming";
+    date?: string;
+    icon?: "check" | "bag" | "truck" | "box";
+};
+type ReadyToGoTrackingEvent = {
+    id: string;
+    title: string;
+    at?: string;
+    detail?: string;
+    state?: "complete" | "current" | "upcoming";
+};
+type ReadyToGoShipment = {
+    id: string;
+    label: string;
+    trackingNumber?: string;
+    status?: string;
+    carrier?: string;
+    latestEvent?: string;
+    updatedAt?: string;
+    deliveryAddress?: string;
+    estimatedDelivery?: string;
+    progress?: ReadyToGoTrackingStep[];
+    events?: ReadyToGoTrackingEvent[];
+    orderItems?: ReadyToGoOrderItem[];
+    recommendations?: ReadyToGoRecommendation[];
+};
 type ReadyToGoTrackingResult = {
     trackingNumber: string;
     status: string;
@@ -9,17 +54,12 @@ type ReadyToGoTrackingResult = {
     latestEvent?: string;
     updatedAt?: string;
     deliveryAddress?: string;
-    orderItems?: Array<{
-        id: string;
-        title: string;
-        quantity: number;
-        imageUrl?: string;
-    }>;
-    recommendations?: Array<{
-        id: string;
-        title: string;
-        description: string;
-    }>;
+    estimatedDelivery?: string;
+    progress?: ReadyToGoTrackingStep[];
+    events?: ReadyToGoTrackingEvent[];
+    orderItems?: ReadyToGoOrderItem[];
+    recommendations?: ReadyToGoRecommendation[];
+    shipments?: ReadyToGoShipment[];
 };
 type ReadyToGoTrackingQuery = (trackingNumber: string) => Promise<ReadyToGoTrackingResult>;
 type ReadyToGoRuntimeState = {
@@ -48,7 +88,6 @@ type BrandedRuntimeProviderProps = {
     children: ReactNode;
     queryTracking: ReadyToGoTrackingQuery;
 };
-/** Keeps one standard tracking result available to every Branded result block. */
 declare function BrandedRuntimeProvider({ children, queryTracking }: BrandedRuntimeProviderProps): react.JSX.Element;
 
 declare function createSalesTemplate(): TemplateDefinition;
@@ -67,4 +106,4 @@ type SalesRuntimeProviderProps = {
 /** The host injects a validated query; Sales never calls a DataSource itself. */
 declare function SalesRuntimeProvider({ children, queryTracking }: SalesRuntimeProviderProps): react.JSX.Element;
 
-export { BrandedRuntimeProvider, type BrandedRuntimeProviderProps, type BrandedRuntimeState, ReadyToGoRuntimeProvider, type ReadyToGoRuntimeProviderProps, type ReadyToGoRuntimeState, type ReadyToGoTrackingQuery, type ReadyToGoTrackingResult, SalesRuntimeProvider, type SalesRuntimeProviderProps, type SalesRuntimeState, bestTrackBrandedExtension, bestTrackPageExtension, bestTrackSalesExtension, createBrandedTemplate, createReadyToGoTemplate, createSalesTemplate };
+export { BrandedRuntimeProvider, type BrandedRuntimeProviderProps, type BrandedRuntimeState, ReadyToGoRuntimeProvider, type ReadyToGoRuntimeProviderProps, type ReadyToGoRuntimeState, type ReadyToGoShipment, type ReadyToGoTrackingEvent, type ReadyToGoTrackingQuery, type ReadyToGoTrackingResult, type ReadyToGoTrackingStep, SalesRuntimeProvider, type SalesRuntimeProviderProps, type SalesRuntimeState, bestTrackBrandedExtension, bestTrackPageExtension, bestTrackSalesExtension, createBrandedTemplate, createReadyToGoTemplate, createSalesTemplate };