@vtex/faststore 0.0.10 → 0.0.11

package/dist/matter/order-invoice-download/order-invoice-download.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"order-invoice-download.js","names":[],"sources":["../../../src/matter/order-invoice-download/order-invoice-download.tsx"],"sourcesContent":["'use client';\n\nimport { type ContentValue, defineComponent, defineContentType, type MessageLocaleProp } from '@vtex/fs-core';\nimport { type ComponentPropsWithRef, type Ref, useRef } from 'react';\nimport {\n  DialogBackdrop,\n  DialogClose,\n  DialogDescription,\n  DialogPopup,\n  DialogPortal,\n  DialogRoot,\n  DialogTitle,\n  DialogTrigger,\n  DialogViewport,\n} from '../../particles/dialog/dialog.js';\nimport { useMessageFormatter } from '../../sdk/i18n/use-message-formatter.js';\nimport { resolveNavigableHref } from '../../utils/safe-href.js';\n\nconst fragment = /* GraphQL */ `\n  fragment OrderInvoiceDownloadData on Query {\n    customerOrder(id: $orderId) {\n      progress {\n        cancelled\n      }\n      invoices {\n        url\n        issuedAt\n        kind\n      }\n    }\n  }\n`;\n\nexport const OrderInvoiceDownloadContent = defineContentType({\n  id: 'order-invoice-download',\n  title: 'Order Invoice Download',\n  description: 'The download control and each invoice entry on the order page.',\n  schema: {\n    type: 'object',\n    additionalProperties: false,\n    properties: {\n      downloadLabel: {\n        type: 'string',\n        title: 'Download label',\n        format: 'icu-message',\n        messageSource: 'Download invoice',\n      },\n      entryLabel: {\n        type: 'string',\n        title: 'Entry label',\n        format: 'icu-message',\n        messageSource: 'Invoice {n} of {total}',\n        messageArguments: {\n          type: 'object',\n          properties: { n: { type: 'integer' }, total: { type: 'integer' } },\n        },\n        messageExample: { n: 1, total: 2 },\n      },\n      description: {\n        type: 'string',\n        title: 'Description',\n        format: 'icu-message',\n        messageSource: 'This order was invoiced in parts. Choose the invoice to download.',\n      },\n      closeLabel: {\n        type: 'string',\n        title: 'Close label',\n        format: 'icu-message',\n        messageSource: 'Close',\n      },\n    },\n  },\n});\n\nexport type OrderInvoiceDownloadContentValue = ContentValue<typeof OrderInvoiceDownloadContent>;\n\nexport type OrderInvoiceDownloadInvoice = {\n  url: string;\n  issuedAt: string | null;\n  kind: 'SALE' | 'RETURN';\n};\n\nexport type OrderInvoiceDownloadData = {\n  progress: { cancelled: boolean };\n  invoices: OrderInvoiceDownloadInvoice[];\n} | null;\n\nexport type OrderInvoiceDownloadProps = MessageLocaleProp &\n  Readonly<{\n    $data?: OrderInvoiceDownloadData | null;\n    $content?: OrderInvoiceDownloadContentValue;\n    className?: string;\n    ref?: Ref<HTMLDivElement>;\n  }>;\n\nexport const OrderInvoiceDownloadDefinition = defineComponent<OrderInvoiceDownloadProps>({\n  name: 'OrderInvoiceDownload',\n  importPath: '@vtex/faststore/components',\n  component: OrderInvoiceDownload,\n  content: OrderInvoiceDownloadContent,\n  fragment,\n  fetchStrategy: 'static',\n  skeleton: OrderInvoiceDownloadSkeleton,\n  editor: { label: 'Order Invoice Download', category: 'action' },\n  schema: {},\n  guideline:\n    'Offers every invoice file the order read kept. One file navigates to the merchant address. Several open a dialog that stays open after a choice. Renders nothing when the order is cancelled or no file remains. Labels are content messages. It does not choose its place on the page.',\n});\n\nfunction openAddress(url: string) {\n  globalThis.location.assign(url);\n}\n\nexport function OrderInvoiceDownloadSkeleton({ className, ...props }: ComponentPropsWithRef<'div'>) {\n  return <div {...props} className={className} data-fs-order-invoice-download-skeleton=\"\" aria-hidden=\"true\" />;\n}\n\nexport function OrderInvoiceDownload({ $data, $content, className, ref }: OrderInvoiceDownloadProps) {\n  const portalRoot = useRef<HTMLDivElement>(null);\n  const messages = useMessageFormatter(OrderInvoiceDownloadContent, $content);\n\n  function setRoot(node: HTMLDivElement | null) {\n    portalRoot.current = node;\n    if (typeof ref === 'function') {\n      ref(node);\n      return;\n    }\n    if (ref) {\n      ref.current = node;\n    }\n  }\n\n  if (!$data || $data.progress.cancelled || $data.invoices.length === 0) {\n    return null;\n  }\n\n  const downloadLabel = messages.format('downloadLabel');\n  const description = messages.format('description');\n  const closeLabel = messages.format('closeLabel');\n  const invoices = $data.invoices.flatMap((invoice) => {\n    const destination = resolveNavigableHref(invoice.url);\n    return destination.safe ? [{ ...invoice, url: destination.href }] : [];\n  });\n  if (invoices.length === 0) return null;\n  const [only] = invoices;\n\n  if (invoices.length === 1 && only) {\n    return (\n      <div ref={ref} className={className} data-fs-order-invoice-download=\"\">\n        <button type=\"button\" data-fs-order-invoice-download-control=\"\" onClick={() => openAddress(only.url)}>\n          {downloadLabel}\n        </button>\n      </div>\n    );\n  }\n\n  return (\n    <div ref={setRoot} className={className} data-fs-order-invoice-download=\"\">\n      <DialogRoot>\n        <DialogTrigger data-fs-order-invoice-download-control=\"\">{downloadLabel}</DialogTrigger>\n        <DialogPortal container={portalRoot}>\n          <DialogBackdrop />\n          <DialogViewport>\n            <DialogPopup>\n              <div data-fs-order-invoice-download-header=\"\">\n                <DialogTitle>{downloadLabel}</DialogTitle>\n                <DialogClose aria-label={closeLabel}>\n                  <span data-fs-order-invoice-download-dismiss=\"\" aria-hidden=\"true\">\n                    ×\n                  </span>\n                </DialogClose>\n              </div>\n              <DialogDescription>{description}</DialogDescription>\n              <ul data-fs-order-invoice-download-list=\"\">\n                {invoices.map((invoice, index) => (\n                  <li key={`${invoice.url}:${index}`}>\n                    <button\n                      type=\"button\"\n                      data-fs-order-invoice-download-entry=\"\"\n                      onClick={() => openAddress(invoice.url)}\n                    >\n                      {messages.format('entryLabel', { n: index + 1, total: invoices.length })}\n                    </button>\n                  </li>\n                ))}\n              </ul>\n            </DialogPopup>\n          </DialogViewport>\n        </DialogPortal>\n      </DialogRoot>\n    </div>\n  );\n}\n"],"mappings":";;;;;;;;;;AAkBA,MAAM,WAAyB;;;;;;;;;;;;;;AAe/B,MAAa,8BAA8B,kBAAkB;CAC3D,IAAI;CACJ,OAAO;CACP,aAAa;CACb,QAAQ;EACN,MAAM;EACN,sBAAsB;EACtB,YAAY;GACV,eAAe;IACb,MAAM;IACN,OAAO;IACP,QAAQ;IACR,eAAe;GACjB;GACA,YAAY;IACV,MAAM;IACN,OAAO;IACP,QAAQ;IACR,eAAe;IACf,kBAAkB;KAChB,MAAM;KACN,YAAY;MAAE,GAAG,EAAE,MAAM,UAAU;MAAG,OAAO,EAAE,MAAM,UAAU;KAAE;IACnE;IACA,gBAAgB;KAAE,GAAG;KAAG,OAAO;IAAE;GACnC;GACA,aAAa;IACX,MAAM;IACN,OAAO;IACP,QAAQ;IACR,eAAe;GACjB;GACA,YAAY;IACV,MAAM;IACN,OAAO;IACP,QAAQ;IACR,eAAe;GACjB;EACF;CACF;AACF,CAAC;AAuBD,MAAa,iCAAiC,gBAA2C;CACvF,MAAM;CACN,YAAY;CACZ,WAAW;CACX,SAAS;CACT;CACA,eAAe;CACf,UAAU;CACV,QAAQ;EAAE,OAAO;EAA0B,UAAU;CAAS;CAC9D,QAAQ,CAAC;CACT,WACE;AACJ,CAAC;AAED,SAAS,YAAY,KAAa;CAChC,WAAW,SAAS,OAAO,GAAG;AAChC;AAEA,SAAgB,6BAA6B,EAAE,WAAW,GAAG,SAAuC;CAClG,OAAO,oBAAC,OAAD;EAAK,GAAI;EAAkB;EAAW,2CAAwC;EAAG,eAAY;CAAQ,CAAA;AAC9G;AAEA,SAAgB,qBAAqB,EAAE,OAAO,UAAU,WAAW,OAAkC;CACnG,MAAM,aAAa,OAAuB,IAAI;CAC9C,MAAM,WAAW,oBAAoB,6BAA6B,QAAQ;CAE1E,SAAS,QAAQ,MAA6B;EAC5C,WAAW,UAAU;EACrB,IAAI,OAAO,QAAQ,YAAY;GAC7B,IAAI,IAAI;GACR;EACF;EACA,IAAI,KACF,IAAI,UAAU;CAElB;CAEA,IAAI,CAAC,SAAS,MAAM,SAAS,aAAa,MAAM,SAAS,WAAW,GAClE,OAAO;CAGT,MAAM,gBAAgB,SAAS,OAAO,eAAe;CACrD,MAAM,cAAc,SAAS,OAAO,aAAa;CACjD,MAAM,aAAa,SAAS,OAAO,YAAY;CAC/C,MAAM,WAAW,MAAM,SAAS,SAAS,YAAY;EACnD,MAAM,cAAc,qBAAqB,QAAQ,GAAG;EACpD,OAAO,YAAY,OAAO,CAAC;GAAE,GAAG;GAAS,KAAK,YAAY;EAAK,CAAC,IAAI,CAAC;CACvE,CAAC;CACD,IAAI,SAAS,WAAW,GAAG,OAAO;CAClC,MAAM,CAAC,QAAQ;CAEf,IAAI,SAAS,WAAW,KAAK,MAC3B,OACE,oBAAC,OAAD;EAAU;EAAgB;EAAW,kCAA+B;EAClE,UAAA,oBAAC,UAAD;GAAQ,MAAK;GAAS,0CAAuC;GAAG,eAAe,YAAY,KAAK,GAAG;GAChG,UAAA;EACK,CAAA;CACL,CAAA;CAIT,OACE,oBAAC,OAAD;EAAK,KAAK;EAAoB;EAAW,kCAA+B;EACtE,UAAA,qBAAC,YAAD,EAAA,UAAA,CACE,oBAAC,eAAD;GAAe,0CAAuC;GAAI,UAAA;EAA6B,CAAA,GACvF,qBAAC,cAAD;GAAc,WAAW;GAAzB,UAAA,CACE,oBAAC,gBAAD,CAAiB,CAAA,GACjB,oBAAC,gBAAD,EAAA,UACE,qBAAC,aAAD,EAAA,UAAA;IACE,qBAAC,OAAD;KAAK,yCAAsC;KAA3C,UAAA,CACE,oBAAC,aAAD,EAAA,UAAc,cAA2B,CAAA,GACzC,oBAAC,aAAD;MAAa,cAAY;MACvB,UAAA,oBAAC,QAAD;OAAM,0CAAuC;OAAG,eAAY;OAAO,UAAA;MAE7D,CAAA;KACK,CAAA,CACV;;IACL,oBAAC,mBAAD,EAAA,UAAoB,YAA+B,CAAA;IACnD,oBAAC,MAAD;KAAI,uCAAoC;KACrC,UAAA,SAAS,KAAK,SAAS,UACtB,oBAAC,MAAD,EAAA,UACE,oBAAC,UAAD;MACE,MAAK;MACL,wCAAqC;MACrC,eAAe,YAAY,QAAQ,GAAG;MAErC,UAAA,SAAS,OAAO,cAAc;OAAE,GAAG,QAAQ;OAAG,OAAO,SAAS;MAAO,CAAC;KACjE,CAAA,EACN,GARK,GAAG,QAAQ,IAAI,GAAG,OAQvB,CACL;IACC,CAAA;GACO,EAAA,CAAA,EACC,CAAA,CACJ;EACJ,CAAA,CAAA,EAAA,CAAA;CACT,CAAA;AAET"}

package/dist/matter/order-list/order-list.d.ts

@@ -1,4 +1,4 @@
-import { ContentValue } from "../../core/dist/define-content-type.js";
+import { ContentValue, MessageLocaleProp } from "../../core/dist/define-content-type.js";
 import { ComponentDefinition } from "../../core/dist/define-component.js";
 import "../../core/dist/index.js";
 import { PageRef } from "../../sdk/navigation/types.js";
@@ -8,7 +8,7 @@ import { ComponentPropsWithRef, Ref } from "react";
 export declare const OrderListContent: {
   readonly id: "order-list";
   readonly title: "Order List";
-  readonly description: "The count, empty, error, and advance sentences for the orders list.";
+  readonly description: "The count, empty, error, and advance sentences for the orders list, its column headers, and its row status labels.";
   readonly schema: {
     readonly type: "object";
     readonly additionalProperties: false;
@@ -16,62 +16,221 @@ export declare const OrderListContent: {
       readonly label: {
         readonly type: "string";
         readonly title: "Accessible name";
+        readonly description: "Accessible name of the list region.";
+        readonly format: "icu-message";
+        readonly messageSource: "Orders";
       };
       readonly count: {
         readonly type: "string";
         readonly title: "Count";
+        readonly format: "icu-message";
+        readonly messageSource: "{count} of {total}";
+        readonly messageArguments: {
+          readonly type: "object";
+          readonly properties: {
+            readonly count: {
+              readonly type: "integer";
+            };
+            readonly total: {
+              readonly type: "integer";
+            };
+          };
+        };
+        readonly messageExample: {
+          readonly count: 25;
+          readonly total: 40;
+        };
       };
       readonly countIncomplete: {
         readonly type: "string";
         readonly title: "Incomplete count";
+        readonly format: "icu-message";
+        readonly messageSource: "{count} of {total}, count incomplete";
+        readonly messageArguments: {
+          readonly type: "object";
+          readonly properties: {
+            readonly count: {
+              readonly type: "integer";
+            };
+            readonly total: {
+              readonly type: "integer";
+            };
+          };
+        };
+        readonly messageExample: {
+          readonly count: 25;
+          readonly total: 40;
+        };
       };
       readonly emptyAccount: {
         readonly type: "string";
         readonly title: "Empty account";
+        readonly format: "icu-message";
+        readonly messageSource: "You have no orders yet";
       };
       readonly emptyView: {
         readonly type: "string";
         readonly title: "Empty view";
+        readonly format: "icu-message";
+        readonly messageSource: "No orders in this view";
       };
       readonly emptySearch: {
         readonly type: "string";
         readonly title: "Empty search";
+        readonly format: "icu-message";
+        readonly messageSource: "No orders match this search";
       };
       readonly pastEnd: {
         readonly type: "string";
         readonly title: "Past the end";
+        readonly format: "icu-message";
+        readonly messageSource: "This page has no orders";
       };
       readonly walkStopped: {
         readonly type: "string";
         readonly title: "Walk stopped";
+        readonly format: "icu-message";
+        readonly messageSource: "More orders may exist";
       };
       readonly error: {
         readonly type: "string";
         readonly title: "Error";
+        readonly format: "icu-message";
+        readonly messageSource: "Could not load orders";
       };
       readonly retry: {
         readonly type: "string";
         readonly title: "Retry";
+        readonly format: "icu-message";
+        readonly messageSource: "Try again";
       };
       readonly next: {
         readonly type: "string";
         readonly title: "Next page";
+        readonly format: "icu-message";
+        readonly messageSource: "Next page";
       };
       readonly loadMore: {
         readonly type: "string";
         readonly title: "Load more";
+        readonly format: "icu-message";
+        readonly messageSource: "Load more";
       };
       readonly firstPage: {
         readonly type: "string";
         readonly title: "First page";
+        readonly format: "icu-message";
+        readonly messageSource: "First page";
       };
       readonly clear: {
         readonly type: "string";
         readonly title: "Clear search";
+        readonly format: "icu-message";
+        readonly messageSource: "Clear search";
       };
       readonly startShopping: {
         readonly type: "string";
         readonly title: "Start shopping";
+        readonly format: "icu-message";
+        readonly messageSource: "Start shopping";
+      };
+      readonly columnId: {
+        readonly type: "string";
+        readonly title: "Order column";
+        readonly description: "Header of the order id column.";
+        readonly format: "icu-message";
+        readonly messageSource: "Order";
+      };
+      readonly columnPlaced: {
+        readonly type: "string";
+        readonly title: "Placed column";
+        readonly description: "Header of the placed date column.";
+        readonly format: "icu-message";
+        readonly messageSource: "Placed";
+      };
+      readonly columnTotal: {
+        readonly type: "string";
+        readonly title: "Total column";
+        readonly description: "Header of the total column.";
+        readonly format: "icu-message";
+        readonly messageSource: "Total";
+      };
+      readonly columnItems: {
+        readonly type: "string";
+        readonly title: "Items column";
+        readonly description: "Header of the items column.";
+        readonly format: "icu-message";
+        readonly messageSource: "Items";
+      };
+      readonly columnStatus: {
+        readonly type: "string";
+        readonly title: "Status column";
+        readonly description: "Header of the status column.";
+        readonly format: "icu-message";
+        readonly messageSource: "Status";
+      };
+      readonly columnEstimate: {
+        readonly type: "string";
+        readonly title: "Estimate column";
+        readonly description: "Header of the delivery estimate column.";
+        readonly format: "icu-message";
+        readonly messageSource: "Estimate";
+      };
+      readonly statusInProgress: {
+        readonly type: "string";
+        readonly title: "In progress";
+        readonly description: "Row status.";
+        readonly format: "icu-message";
+        readonly messageSource: "In progress";
+      };
+      readonly statusCancellationRequested: {
+        readonly type: "string";
+        readonly title: "Cancellation requested";
+        readonly description: "Row status.";
+        readonly format: "icu-message";
+        readonly messageSource: "Cancellation requested";
+      };
+      readonly statusCancelled: {
+        readonly type: "string";
+        readonly title: "Cancelled";
+        readonly description: "Row status.";
+        readonly format: "icu-message";
+        readonly messageSource: "Canceled";
+      };
+      readonly statusDelivered: {
+        readonly type: "string";
+        readonly title: "Delivered";
+        readonly description: "Row status.";
+        readonly format: "icu-message";
+        readonly messageSource: "Delivered";
+      };
+      readonly statusShipped: {
+        readonly type: "string";
+        readonly title: "Shipped";
+        readonly description: "Row status.";
+        readonly format: "icu-message";
+        readonly messageSource: "Shipped";
+      };
+      readonly statusReadyForPickup: {
+        readonly type: "string";
+        readonly title: "Ready for pickup";
+        readonly description: "Row status.";
+        readonly format: "icu-message";
+        readonly messageSource: "Ready for pickup";
+      };
+      readonly statusCollected: {
+        readonly type: "string";
+        readonly title: "Collected";
+        readonly description: "Row status.";
+        readonly format: "icu-message";
+        readonly messageSource: "Collected";
+      };
+      readonly statusPlaceholder: {
+        readonly type: "string";
+        readonly title: "Status unavailable";
+        readonly description: "Row status when the order has none.";
+        readonly format: "icu-message";
+        readonly messageSource: "Status unavailable";
       };
     };
   };
@@ -89,9 +248,7 @@ export type OrderListData = {
   totalCount: number;
   totalIncomplete: boolean;
 };
-export type OrderListProps = Readonly<{
-  /** Accessible name of the list region. */
-  label?: string;
+export type OrderListProps = MessageLocaleProp & Readonly<{
   advance?: OrderListAdvance;
   /** Link offered when the account has no orders. */
   startShoppingHref?: PageRef | string;
@@ -102,20 +259,8 @@ export type OrderListProps = Readonly<{
   className?: string;
   ref?: Ref<HTMLElement>;
 }>;
-export declare const OrderListDefinition: ComponentDefinition<Readonly<{
-  /** Accessible name of the list region. */
-  label?: string;
-  advance?: OrderListAdvance;
-  /** Link offered when the account has no orders. */
-  startShoppingHref?: PageRef | string;
-  /** The order page each row links to; the row fills `orderId`, or appends it to a string path. */
-  orderHref?: PageRef | string;
-  $content?: OrderListContentValue;
-  $data?: OrderListData | null;
-  className?: string;
-  ref?: Ref<HTMLElement>;
-}>>;
+export declare const OrderListDefinition: ComponentDefinition<OrderListProps>;
 export declare function OrderListSkeleton({ className, ...props }: ComponentPropsWithRef<'div'>): import("react/jsx-runtime").JSX.Element;
-export declare function OrderList({ label, advance, startShoppingHref, orderHref, $content, $data, className, ref }: OrderListProps): import("react/jsx-runtime").JSX.Element;
+export declare function OrderList({ advance, startShoppingHref, orderHref, $content, $locale, $data, className, ref }: OrderListProps): import("react/jsx-runtime").JSX.Element;
 //#endregion
 //# sourceMappingURL=order-list.d.ts.map