@vtex/faststore 0.0.7 → 0.0.8

package/dist/content-types.json

@@ -313,6 +313,21 @@
       }
     }
   },
+  "order-details-back": {
+    "id": "order-details-back",
+    "title": "Order Details Back",
+    "description": "The link back to the order list.",
+    "schema": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "label": {
+          "type": "string",
+          "title": "Label"
+        }
+      }
+    }
+  },
   "payment-methods": {
     "id": "payment-methods",
     "title": "Payment Methods",
@@ -721,6 +736,514 @@
       }
     }
   },
+  "order-cancel": {
+    "id": "order-cancel",
+    "title": "Order Cancel",
+    "description": "Confirmation copy and the optional cancellation reasons for one order.",
+    "schema": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "trigger": {
+          "type": "string",
+          "title": "Trigger",
+          "default": "Cancel order"
+        },
+        "title": {
+          "type": "string",
+          "title": "Title",
+          "default": "Cancel this order?"
+        },
+        "description": {
+          "type": "string",
+          "title": "Description",
+          "default": "This cannot be undone."
+        },
+        "confirm": {
+          "type": "string",
+          "title": "Confirm",
+          "default": "Cancel order"
+        },
+        "dismiss": {
+          "type": "string",
+          "title": "Dismiss",
+          "default": "Keep order"
+        },
+        "other": {
+          "type": "string",
+          "title": "Other",
+          "default": "Other"
+        },
+        "otherField": {
+          "type": "string",
+          "title": "Other field",
+          "default": "Reason"
+        },
+        "success": {
+          "type": "string",
+          "title": "Success",
+          "default": "Your order was cancelled."
+        },
+        "failure": {
+          "type": "string",
+          "title": "Failure",
+          "default": "Unable to cancel the order. Please try again."
+        },
+        "dismissMessage": {
+          "type": "string",
+          "title": "Dismiss message",
+          "default": "Dismiss"
+        },
+        "reasons": {
+          "type": "array",
+          "title": "Reasons",
+          "items": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+              "label"
+            ],
+            "properties": {
+              "label": {
+                "type": "string",
+                "title": "Label",
+                "minLength": 1
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "order-delivery-address": {
+    "id": "order-delivery-address",
+    "title": "Order Delivery Address",
+    "description": "The labels above a delivery address and above a pickup store address.",
+    "schema": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "deliveryLabel": {
+          "type": "string",
+          "title": "Delivery address label"
+        },
+        "storeLabel": {
+          "type": "string",
+          "title": "Store address label"
+        }
+      }
+    }
+  },
+  "order-delivery-group": {
+    "id": "order-delivery-group",
+    "title": "Order Delivery Group",
+    "description": "The labels of a delivery group. The item-count sentences keep {count}: one for a single item, the other for the rest.",
+    "schema": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "label": {
+          "type": "string",
+          "title": "Accessible name"
+        },
+        "delivery": {
+          "type": "string",
+          "title": "Delivery"
+        },
+        "pickup": {
+          "type": "string",
+          "title": "Pickup"
+        },
+        "estimate": {
+          "type": "string",
+          "title": "Estimated delivery"
+        },
+        "itemsOne": {
+          "type": "string",
+          "title": "One item",
+          "description": "Keep the placeholder {count}."
+        },
+        "itemsOther": {
+          "type": "string",
+          "title": "Many items",
+          "description": "Keep the placeholder {count}."
+        },
+        "subtotal": {
+          "type": "string",
+          "title": "Subtotal"
+        },
+        "quantity": {
+          "type": "string",
+          "title": "Quantity"
+        },
+        "unitPrice": {
+          "type": "string",
+          "title": "Unit price"
+        },
+        "listPrice": {
+          "type": "string",
+          "title": "List price"
+        },
+        "total": {
+          "type": "string",
+          "title": "Total"
+        },
+        "tax": {
+          "type": "string",
+          "title": "Tax"
+        }
+      }
+    }
+  },
+  "order-details-header": {
+    "id": "order-details-header",
+    "title": "Order Details Header",
+    "description": "The prefix, the copy action, and the status sentences on the order page.",
+    "schema": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "prefix": {
+          "type": "string",
+          "title": "Prefix"
+        },
+        "copyLabel": {
+          "type": "string",
+          "title": "Copy label"
+        },
+        "copyAccessibleName": {
+          "type": "string",
+          "title": "Copy accessible name"
+        },
+        "copyCopied": {
+          "type": "string",
+          "title": "Copied"
+        },
+        "copyFailure": {
+          "type": "string",
+          "title": "Copy failure"
+        },
+        "copyDismiss": {
+          "type": "string",
+          "title": "Dismiss copy"
+        },
+        "statusInProgress": {
+          "type": "string",
+          "title": "In progress"
+        },
+        "statusCancellationRequested": {
+          "type": "string",
+          "title": "Cancellation requested"
+        },
+        "statusCancelled": {
+          "type": "string",
+          "title": "Cancelled"
+        },
+        "statusDelivered": {
+          "type": "string",
+          "title": "Delivered"
+        },
+        "statusShipped": {
+          "type": "string",
+          "title": "Shipped"
+        },
+        "statusReadyForPickup": {
+          "type": "string",
+          "title": "Ready for pickup"
+        },
+        "statusCollected": {
+          "type": "string",
+          "title": "Collected"
+        },
+        "statusPlaceholder": {
+          "type": "string",
+          "title": "Status unavailable"
+        }
+      }
+    }
+  },
+  "order-list": {
+    "id": "order-list",
+    "title": "Order List",
+    "description": "The count, empty, error, and advance sentences for the orders list.",
+    "schema": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "label": {
+          "type": "string",
+          "title": "Accessible name"
+        },
+        "count": {
+          "type": "string",
+          "title": "Count"
+        },
+        "countIncomplete": {
+          "type": "string",
+          "title": "Incomplete count"
+        },
+        "emptyAccount": {
+          "type": "string",
+          "title": "Empty account"
+        },
+        "emptyView": {
+          "type": "string",
+          "title": "Empty view"
+        },
+        "emptySearch": {
+          "type": "string",
+          "title": "Empty search"
+        },
+        "pastEnd": {
+          "type": "string",
+          "title": "Past the end"
+        },
+        "walkStopped": {
+          "type": "string",
+          "title": "Walk stopped"
+        },
+        "error": {
+          "type": "string",
+          "title": "Error"
+        },
+        "retry": {
+          "type": "string",
+          "title": "Retry"
+        },
+        "next": {
+          "type": "string",
+          "title": "Next page"
+        },
+        "loadMore": {
+          "type": "string",
+          "title": "Load more"
+        },
+        "firstPage": {
+          "type": "string",
+          "title": "First page"
+        },
+        "clear": {
+          "type": "string",
+          "title": "Clear search"
+        },
+        "startShopping": {
+          "type": "string",
+          "title": "Start shopping"
+        }
+      }
+    }
+  },
+  "order-list-search": {
+    "id": "order-list-search",
+    "title": "Order List Search",
+    "description": "The order-number label, the placed-date labels, and the invalid-range message.",
+    "schema": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "label": {
+          "type": "string",
+          "title": "Order number"
+        },
+        "from": {
+          "type": "string",
+          "title": "Placed from"
+        },
+        "to": {
+          "type": "string",
+          "title": "Placed to"
+        },
+        "submit": {
+          "type": "string",
+          "title": "Search"
+        },
+        "clear": {
+          "type": "string",
+          "title": "Clear search"
+        },
+        "invalidRange": {
+          "type": "string",
+          "title": "Invalid range"
+        }
+      }
+    }
+  },
+  "order-list-views": {
+    "id": "order-list-views",
+    "title": "Order List Views",
+    "description": "The names of the four order views and the accessible name of the switch.",
+    "schema": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "label": {
+          "type": "string",
+          "title": "Accessible name"
+        },
+        "all": {
+          "type": "string",
+          "title": "All orders"
+        },
+        "ongoing": {
+          "type": "string",
+          "title": "Ongoing"
+        },
+        "completed": {
+          "type": "string",
+          "title": "Completed"
+        },
+        "cancelled": {
+          "type": "string",
+          "title": "Cancelled"
+        }
+      }
+    }
+  },
+  "order-payment": {
+    "id": "order-payment",
+    "title": "Order Payment",
+    "description": "The heading, the bank-invoice name, and the fixed labels of the payment section. The installment line keeps {count} and {amount}.",
+    "schema": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "heading": {
+          "type": "string",
+          "title": "Heading"
+        },
+        "bankInvoiceName": {
+          "type": "string",
+          "title": "Bank invoice name"
+        },
+        "empty": {
+          "type": "string",
+          "title": "Empty"
+        },
+        "methodPlaceholder": {
+          "type": "string",
+          "title": "Method unavailable"
+        },
+        "installments": {
+          "type": "string",
+          "title": "Installments",
+          "description": "Keep the placeholders {count} and {amount}."
+        },
+        "redemptionCode": {
+          "type": "string",
+          "title": "Gift card code"
+        },
+        "bankInvoiceNumber": {
+          "type": "string",
+          "title": "Bank invoice number"
+        },
+        "bankInvoicePrint": {
+          "type": "string",
+          "title": "Print bank invoice"
+        }
+      }
+    }
+  },
+  "order-placed-date": {
+    "id": "order-placed-date",
+    "title": "Order Placed Date",
+    "description": "The label beside the date the order was placed.",
+    "schema": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "label": {
+          "type": "string",
+          "title": "Label"
+        }
+      }
+    }
+  },
+  "order-progress": {
+    "id": "order-progress",
+    "title": "Order Progress",
+    "description": "The stage names, the state sentences, and the accessible name of the progress list.",
+    "schema": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "label": {
+          "type": "string",
+          "title": "Accessible name"
+        },
+        "placed": {
+          "type": "string",
+          "title": "Order placed"
+        },
+        "payment": {
+          "type": "string",
+          "title": "Payment"
+        },
+        "processing": {
+          "type": "string",
+          "title": "Processing"
+        },
+        "shipping": {
+          "type": "string",
+          "title": "Shipping"
+        },
+        "stateDone": {
+          "type": "string",
+          "title": "Completed"
+        },
+        "stateCurrent": {
+          "type": "string",
+          "title": "In progress"
+        },
+        "statePending": {
+          "type": "string",
+          "title": "Not started"
+        }
+      }
+    }
+  },
+  "order-summary": {
+    "id": "order-summary",
+    "title": "Order Summary",
+    "description": "The heading and the labels of the known total lines. An unknown total id keeps the name the API sent.",
+    "schema": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "heading": {
+          "type": "string",
+          "title": "Heading"
+        },
+        "items": {
+          "type": "string",
+          "title": "Items"
+        },
+        "shipping": {
+          "type": "string",
+          "title": "Shipping"
+        },
+        "discounts": {
+          "type": "string",
+          "title": "Discounts"
+        },
+        "tax": {
+          "type": "string",
+          "title": "Tax"
+        },
+        "change": {
+          "type": "string",
+          "title": "Change"
+        },
+        "interest": {
+          "type": "string",
+          "title": "Interest"
+        },
+        "grandTotal": {
+          "type": "string",
+          "title": "Total"
+        }
+      }
+    }
+  },
   "product-shelf": {
     "id": "product-shelf",
     "title": "Product Shelf",

package/dist/core/dist/define-component.d.ts

@@ -9,7 +9,7 @@ export interface EditorMetadata {
   description?: string;
   icon?: string;
 }
-export type PropType = 'string' | 'number' | 'boolean' | 'object' | 'array' | readonly string[];
+export type PropType = 'string' | 'number' | 'boolean' | 'object' | 'array' | 'link' | readonly string[];
 export type PropSchemaField = {
   /**
    * Prop type keyword. The catalog wire value `"icon"` is a sukima convention (collected at
@@ -23,6 +23,11 @@ export type PropSchemaField = {
    */
   items?: readonly string[];
   default?: unknown;
+  /**
+   * The route params the component supplies when it navigates, honored only when `type === 'link'`
+   * (e.g. `{ type: 'link', default: { standard: 'order-placed' }, fills: ['orderGroup'] }`).
+   */
+  fills?: readonly string[];
   label?: string;
 };
 export type PropSchema = Record<string, PropSchemaField>;

package/dist/docs/account-access-gate.md

@@ -21,7 +21,7 @@ The image is the source of truth for layout, and this component is not in any la
 
 - On an individual account section, to repeat the rule → the layout already made it. A second gate is a second decision to keep in agreement with the first.
 - To show or hide a subtree by session state, with nothing else riding on it → use `SessionGuard`, which is the declarative show/hide. This component navigates, remembers, and is meant to own a whole page.
-- On the `/login` route → that route is [[sign-in-redirect]], and this component redirects *to* it. Gating it closes a loop the shopper cannot leave.
+- On the sign-in page → that page is [[sign-in-redirect]], and this component redirects *to* it. Gating it closes a loop the shopper cannot leave.
 - To decide whether a shopper may read *this particular order* or *that address* → the gate answers "is anyone signed in", never "is this record theirs". Record-level authorization belongs to the resolver.
 
 ---
@@ -64,7 +64,7 @@ Content model (`account-access-gate`) fields, edited in the CMS — the same fou
 
 **`identified` counts as signed out.** A shopper the platform recognizes but has not authenticated cannot reach their account, which is the same reading [[account-entry-point]] applies to its own label.
 
-**A visitor who arrived signed out is sent, not told.** The redirect replaces the history entry rather than pushing one, carrying the page they were trying to reach as the return, query string included — so back from the platform's login reaches the page they were reading rather than the first page of it, and never bounces off the gate again.
+**A visitor who arrived signed out is sent, not told.** The redirect replaces the history entry rather than pushing one, carrying the page they were trying to reach as the return, query string included, as a logical path the sign-in page prefixes on the way back — so back from the platform's login reaches the page they were reading rather than the first page of it, and never bounces off the gate again.
 
 **A session that ended mid-visit is told, not sent.** Past a redirect there is no surface left to say anything on, so the gate keeps the page and renders the notice with a sign-in link the shopper may take. This is a deliberate departure from "redirect whenever signed out", and it applies only when the gate has already rendered the account for this shopper.
 
@@ -113,7 +113,7 @@ Bound to a CMS entry, the element authors no messages at all — the entry suppl
 
 - **`AccountGate`, `AuthGuard`, `RequireLogin`, `ProtectedRoute`.** The correct name is `AccountAccessGate`.
 - **Repeating it per account section.** It belongs once in the layout, wrapping the body. Two gates are two decisions that can disagree.
-- **Putting [[sign-in-redirect]] under it.** The gate redirects to `/login`; a gated `/login` redirects to itself.
+- **Putting [[sign-in-redirect]] under it.** The gate redirects to the sign-in page `{ standard: 'sign-in' }`; a gated sign-in page redirects to itself.
 - **Placing it outside `SessionRoot`.** It declares `requiresContext: 'session'` and has nothing to read without one.
 - **Reaching for `SessionGuard when={['loggedIn']}` instead.** That expresses one of the five outcomes. It cannot redirect, cannot carry a return, cannot tell an arrival from an expiry, and renders nothing while the session is still resolving.
 - **Expecting it to redirect an expired session.** It renders a notice on purpose — see above.
@@ -148,6 +148,6 @@ Styling the gate's swatch reaches the loading part and both notices, which is us
 
 ## Related
 
-- [[sign-in-redirect]] — the `/login` route this component sends a signed-out visitor to, and which reads back the return this one encoded. Never place it under the gate.
+- [[sign-in-redirect]] — the sign-in page this component sends a signed-out visitor to, and which reads back the return this one encoded. Never place it under the gate.
 - [[account-entry-point]] — the header control that offers sign-in to a shopper who chose to go there. It asks; this one insists.
 - [[session]] — the context both read. `SessionGuard`, in the same group, is the declarative show/hide for a subtree with no navigation, no memory, and no loading state of its own.