@shipengine/elements 0.22.0 → 0.23.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shipengine/elements",
-  "version": "0.22.0",
+  "version": "0.23.0",
   "typedoc": {
     "entryPoint": "./src/index.ts",
     "readmeFile": "../../README.md",
@@ -29,8 +29,8 @@
     "@hookform/resolvers": "2.9.1",
     "@packlink/brands": "3.24.0",
     "@packlink/giger-theme": "1.3.1",
-    "@shipengine/alchemy": "0.4.10",
-    "@shipengine/js-api": "0.6.2",
+    "@shipengine/alchemy": "0.4.13",
+    "@shipengine/js-api": "0.7.0",
     "@storybook/manager-api": "7.0.0-rc.1",
     "@storybook/theming": "7.0.0-rc.1",
     "axios": "0.26.1",

package/src/components/field/field.styles.d.ts

@@ -4,4 +4,10 @@ export declare const getOverrideStyles: (theme: Theme) => {
         cursor: string;
         fontWeight: number;
     };
+    "&& input:hover": {
+        cursor: string;
+    };
+    "&&.disabled input:hover": {
+        cursor: string;
+    };
 };

package/src/components/field/rate-card/rate-card.d.ts

@@ -7,5 +7,6 @@ export type RateCardProps = Partial<RateOption> & WithCommonProps<{
     recommended?: boolean;
     selected?: boolean;
     voided?: boolean;
+    voidedAt?: string;
 }>;
-export declare const RateCard: ({ carrierCode, carrierFriendlyName, carrierNickname, children, className, confirmationAmount, deliveryDays, insuranceAmount, isAcknowledged, messages, onClick, onClickAcknowledgement, otherAmount, rateId, recommended, requiresAcknowledgement, selected, serviceCode, serviceType, shippingAmount, taxAmount, voided, }: RateCardProps) => import("@emotion/react/jsx-runtime").JSX.Element;
+export declare const RateCard: ({ carrierCode, carrierFriendlyName, carrierNickname, children, className, confirmationAmount, deliveryDays, insuranceAmount, isAcknowledged, messages, onClick, onClickAcknowledgement, otherAmount, rateId, recommended, requiresAcknowledgement, selected, serviceCode, serviceType, shippingAmount, taxAmount, voided, voidedAt, }: RateCardProps) => import("@emotion/react/jsx-runtime").JSX.Element;

package/src/components/field/rate-card/rate-card.styles.d.ts

@@ -19,3 +19,4 @@ export declare const getFooterListWithMultipleMessagesStyles: (theme: Theme) =>
 export declare const getFooterListItemStyles: (theme: Theme) => SerializedStyles;
 export declare const getAcknowledgmentStyles: (theme: Theme) => SerializedStyles;
 export declare const getCheckboxWrapperStyles: () => SerializedStyles;
+export declare const getTypographyVoidedStyles: () => SerializedStyles;

package/src/components/items-breakdown/items-breakdown.styles.d.ts

@@ -1,3 +1 @@
-import { Theme } from "@packlink/giger-theme";
-export declare const getNumericCellStyle: (theme: Theme) => import("@emotion/utils").SerializedStyles;
-export declare const getTableWrapperStyles: (theme: Theme) => import("@emotion/utils").SerializedStyles;
+export declare const styles: Record<"itemDetail" | "itemName" | "numericCell" | "tableWrapper", import("@emotion/serialize").Interpolation<import("@packlink/giger-theme/dist/lib/Theme").Theme>>;

package/src/elements/configure-shipment/hooks/index.d.ts

@@ -3,3 +3,4 @@ export * from "./use-customs";
 export * from "./use-presets";
 export * from "./use-rates-form";
 export * from "./use-shipment-form";
+export * from "./use-rates-with-cache";

package/src/elements/configure-shipment/hooks/use-rates-form.d.ts

@@ -1,11 +1,11 @@
 import { SE } from "@shipengine/alchemy";
-import { UseRequestRatesProps } from "./use-request-rates";
+import { UseRatesWithCacheProps } from "./use-rates-with-cache";
 export type UseRatesFormProps = {
     onBeforeLabelCreate?: (rate: SE.Rate, shipment: SE.SalesOrderShipment) => Promise<void> | void;
     onLabelCreateFailure?: (rate: SE.Rate, shipment: SE.SalesOrderShipment) => Promise<void> | void;
     onLabelCreateSuccess?: (label: SE.Label, shipment: SE.SalesOrderShipment) => Promise<void> | void;
     onRateSaved?: (shipment: SE.SalesOrderShipment) => Promise<void> | void;
-    onRatesCalculated?: UseRequestRatesProps["onRatesCalculated"];
+    onRatesCalculated?: UseRatesWithCacheProps["onRatesCalculated"];
     onShipmentUpdated?: (shipment: SE.SalesOrderShipment) => Promise<void> | void;
     printLabelLayout?: SE.LabelLayout;
     shipment?: SE.SalesOrderShipment;

package/src/elements/configure-shipment/hooks/use-rates-with-cache.d.ts

@@ -0,0 +1,30 @@
+import { SE } from "@shipengine/alchemy";
+import { UseRequestRatesProps } from "./use-request-rates";
+export type UseRatesWithCacheProps = {
+    onRatesCalculated: UseRequestRatesProps["onRatesCalculated"];
+    shipment?: SE.SalesOrderShipment;
+};
+/**
+ * Since useFormHook doesn't have a "submit if valid and don't paint errors" option,
+ * instead one can use this hook to prefetch previously calculated rates from /v1/shipments/:shipment_id/rates
+ * which this hook will blend into the "real" useRequestRates hook's loading state and response values,
+ * masquerading as a cached value from the real endpoint without having a flash of error hints.
+ *
+ * It also intercepts the resetRates function from useRequestRates to set a flag to ignore this caching.
+ * (this transparently returns the behaviors to the default useRequestRates behavior)
+ */
+export declare const useRatesWithCache: ({ shipment, onRatesCalculated }: UseRatesWithCacheProps) => {
+    ratesCalculating: boolean;
+    ratesErrors: SE.CodedError[] | null;
+    ratesResponse: SE.RateResponse | {
+        created_at: string;
+        errors: SE.CodedError[];
+        invalidRates: SE.Rate[];
+        rate_request_id: string;
+        rates: SE.Rate[];
+        shipment_id: string;
+        status: "error" | "working" | "completed" | "partial";
+    } | undefined;
+    requestRates: (shipment: SE.SalesOrderShipment) => Promise<void>;
+    resetRates: () => void;
+};

package/src/elements/list-carriers/list-carriers.d.ts

@@ -32,9 +32,7 @@ export declare const Element: ({ resources, ...props }: object & {
                     approved: string;
                     rejected: string;
                 };
-                sections: {
-                    salesOrder: string;
-                };
+                voidedOn: string;
             };
             "view-shipment": {
                 actions: {
@@ -572,6 +570,7 @@ export declare const Element: ({ resources, ...props }: object & {
                 QSBzaGlwcGluZyBjYXJyaWVyIGVycm9yIG9jY3VycmVkOiBJbnN1ZmZpY2llbnQgYWNjb3VudCBiYWxhbmNlLiBBY2NvdW50IGV4Y2VwdGlvbiBFeGNlcHRpb24gd2l0aCBjb2RlIDB4MDA1NjAxMDE7IG1vZHVsZSA4NiwgY2F0ZWdvcnkgMSwgaXRlbSAx: string;
                 "QWRkcmVzcyBub3QgZm91bmQ=": string;
                 QSBzaGlwcGluZyBjYXJyaWVyIGVycm9yIG9jY3VycmVkOiBVUFMgd2VpZ2h0IGxpbWl0IHBlciBwYWNrYWdlIGlzIDE1MCBsYnMu: string;
+                UGxlYXNlIGFkZCBhIFN0YW1wcy5jb20gYWNjb3VudCB0byBTaGlwRW5naW5lIGluIG9yZGVyIHRvIGNyZWF0ZSBzaGlwcGluZyBsYWJlbHMu: string;
             };
         };
     } | undefined;

package/src/elements/manage-warehouses/manage-warehouses.d.ts

@@ -36,9 +36,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     approved: string;
                     rejected: string;
                 };
-                sections: {
-                    salesOrder: string;
-                };
+                voidedOn: string;
             };
             "view-shipment": {
                 actions: {
@@ -576,6 +574,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                 QSBzaGlwcGluZyBjYXJyaWVyIGVycm9yIG9jY3VycmVkOiBJbnN1ZmZpY2llbnQgYWNjb3VudCBiYWxhbmNlLiBBY2NvdW50IGV4Y2VwdGlvbiBFeGNlcHRpb24gd2l0aCBjb2RlIDB4MDA1NjAxMDE7IG1vZHVsZSA4NiwgY2F0ZWdvcnkgMSwgaXRlbSAx: string;
                 "QWRkcmVzcyBub3QgZm91bmQ=": string;
                 QSBzaGlwcGluZyBjYXJyaWVyIGVycm9yIG9jY3VycmVkOiBVUFMgd2VpZ2h0IGxpbWl0IHBlciBwYWNrYWdlIGlzIDE1MCBsYnMu: string;
+                UGxlYXNlIGFkZCBhIFN0YW1wcy5jb20gYWNjb3VudCB0byBTaGlwRW5naW5lIGluIG9yZGVyIHRvIGNyZWF0ZSBzaGlwcGluZyBsYWJlbHMu: string;
             };
         };
     } | undefined;

package/src/elements/onboarding/onboarding.d.ts

@@ -35,9 +35,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     approved: string;
                     rejected: string;
                 };
-                sections: {
-                    salesOrder: string;
-                };
+                voidedOn: string;
             };
             "view-shipment": {
                 actions: {
@@ -575,6 +573,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                 QSBzaGlwcGluZyBjYXJyaWVyIGVycm9yIG9jY3VycmVkOiBJbnN1ZmZpY2llbnQgYWNjb3VudCBiYWxhbmNlLiBBY2NvdW50IGV4Y2VwdGlvbiBFeGNlcHRpb24gd2l0aCBjb2RlIDB4MDA1NjAxMDE7IG1vZHVsZSA4NiwgY2F0ZWdvcnkgMSwgaXRlbSAx: string;
                 "QWRkcmVzcyBub3QgZm91bmQ=": string;
                 QSBzaGlwcGluZyBjYXJyaWVyIGVycm9yIG9jY3VycmVkOiBVUFMgd2VpZ2h0IGxpbWl0IHBlciBwYWNrYWdlIGlzIDE1MCBsYnMu: string;
+                UGxlYXNlIGFkZCBhIFN0YW1wcy5jb20gYWNjb3VudCB0byBTaGlwRW5naW5lIGluIG9yZGVyIHRvIGNyZWF0ZSBzaGlwcGluZyBsYWJlbHMu: string;
             };
         };
     } | undefined;

package/src/elements/purchase-label/purchase-label.d.ts

@@ -38,9 +38,7 @@ export declare const Element: ({ resources, ...props }: SalesOrderProps & {
                     approved: string;
                     rejected: string;
                 };
-                sections: {
-                    salesOrder: string;
-                };
+                voidedOn: string;
             };
             "view-shipment": {
                 actions: {
@@ -578,6 +576,7 @@ export declare const Element: ({ resources, ...props }: SalesOrderProps & {
                 QSBzaGlwcGluZyBjYXJyaWVyIGVycm9yIG9jY3VycmVkOiBJbnN1ZmZpY2llbnQgYWNjb3VudCBiYWxhbmNlLiBBY2NvdW50IGV4Y2VwdGlvbiBFeGNlcHRpb24gd2l0aCBjb2RlIDB4MDA1NjAxMDE7IG1vZHVsZSA4NiwgY2F0ZWdvcnkgMSwgaXRlbSAx: string;
                 "QWRkcmVzcyBub3QgZm91bmQ=": string;
                 QSBzaGlwcGluZyBjYXJyaWVyIGVycm9yIG9jY3VycmVkOiBVUFMgd2VpZ2h0IGxpbWl0IHBlciBwYWNrYWdlIGlzIDE1MCBsYnMu: string;
+                UGxlYXNlIGFkZCBhIFN0YW1wcy5jb20gYWNjb3VudCB0byBTaGlwRW5naW5lIGluIG9yZGVyIHRvIGNyZWF0ZSBzaGlwcGluZyBsYWJlbHMu: string;
             };
         };
     } | undefined;

package/src/elements/view-shipment/view-shipment.d.ts

@@ -44,9 +44,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     approved: string;
                     rejected: string;
                 };
-                sections: {
-                    salesOrder: string;
-                };
+                voidedOn: string;
             };
             "view-shipment": {
                 actions: {
@@ -584,6 +582,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                 QSBzaGlwcGluZyBjYXJyaWVyIGVycm9yIG9jY3VycmVkOiBJbnN1ZmZpY2llbnQgYWNjb3VudCBiYWxhbmNlLiBBY2NvdW50IGV4Y2VwdGlvbiBFeGNlcHRpb24gd2l0aCBjb2RlIDB4MDA1NjAxMDE7IG1vZHVsZSA4NiwgY2F0ZWdvcnkgMSwgaXRlbSAx: string;
                 "QWRkcmVzcyBub3QgZm91bmQ=": string;
                 QSBzaGlwcGluZyBjYXJyaWVyIGVycm9yIG9jY3VycmVkOiBVUFMgd2VpZ2h0IGxpbWl0IHBlciBwYWNrYWdlIGlzIDE1MCBsYnMu: string;
+                UGxlYXNlIGFkZCBhIFN0YW1wcy5jb20gYWNjb3VudCB0byBTaGlwRW5naW5lIGluIG9yZGVyIHRvIGNyZWF0ZSBzaGlwcGluZyBsYWJlbHMu: string;
             };
         };
     } | undefined;

package/src/elements/void-label/void-label.d.ts

@@ -39,9 +39,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     approved: string;
                     rejected: string;
                 };
-                sections: {
-                    salesOrder: string;
-                };
+                voidedOn: string;
             };
             "view-shipment": {
                 actions: {
@@ -579,6 +577,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                 QSBzaGlwcGluZyBjYXJyaWVyIGVycm9yIG9jY3VycmVkOiBJbnN1ZmZpY2llbnQgYWNjb3VudCBiYWxhbmNlLiBBY2NvdW50IGV4Y2VwdGlvbiBFeGNlcHRpb24gd2l0aCBjb2RlIDB4MDA1NjAxMDE7IG1vZHVsZSA4NiwgY2F0ZWdvcnkgMSwgaXRlbSAx: string;
                 "QWRkcmVzcyBub3QgZm91bmQ=": string;
                 QSBzaGlwcGluZyBjYXJyaWVyIGVycm9yIG9jY3VycmVkOiBVUFMgd2VpZ2h0IGxpbWl0IHBlciBwYWNrYWdlIGlzIDE1MCBsYnMu: string;
+                UGxlYXNlIGFkZCBhIFN0YW1wcy5jb20gYWNjb3VudCB0byBTaGlwRW5naW5lIGluIG9yZGVyIHRvIGNyZWF0ZSBzaGlwcGluZyBsYWJlbHMu: string;
             };
         };
     } | undefined;

package/src/locales/en/index.d.ts

@@ -28,9 +28,7 @@ declare const _default: {
             approved: string;
             rejected: string;
         };
-        sections: {
-            salesOrder: string;
-        };
+        voidedOn: string;
     };
     "view-shipment": {
         actions: {
@@ -568,6 +566,7 @@ declare const _default: {
         QSBzaGlwcGluZyBjYXJyaWVyIGVycm9yIG9jY3VycmVkOiBJbnN1ZmZpY2llbnQgYWNjb3VudCBiYWxhbmNlLiBBY2NvdW50IGV4Y2VwdGlvbiBFeGNlcHRpb24gd2l0aCBjb2RlIDB4MDA1NjAxMDE7IG1vZHVsZSA4NiwgY2F0ZWdvcnkgMSwgaXRlbSAx: string;
         "QWRkcmVzcyBub3QgZm91bmQ=": string;
         QSBzaGlwcGluZyBjYXJyaWVyIGVycm9yIG9jY3VycmVkOiBVUFMgd2VpZ2h0IGxpbWl0IHBlciBwYWNrYWdlIGlzIDE1MCBsYnMu: string;
+        UGxlYXNlIGFkZCBhIFN0YW1wcy5jb20gYWNjb3VudCB0byBTaGlwRW5naW5lIGluIG9yZGVyIHRvIGNyZWF0ZSBzaGlwcGluZyBsYWJlbHMu: string;
     };
 };
 export default _default;

package/src/mocks/warehouses/handlers.d.ts

@@ -3,6 +3,8 @@ import { SE } from "@shipengine/alchemy";
 export type CreateWarehouseHandlersParams = {
     get?: DeepPartial<SE.Warehouse>;
     list?: [count: number, listParams?: DeepPartial<SE.Warehouse>];
+    suggested?: boolean;
+    validate?: "unverified" | "verified" | "warning" | "error";
 };
 export declare const createWarehouseHandlers: (params?: CreateWarehouseHandlersParams) => {
     database: {

package/src/utilities/date.d.ts

@@ -2,6 +2,10 @@
  * @category Utilities
  */
 export declare const formatDate: (date: string, locale?: string) => string;
+/**
+ * @category Utilities
+ */
+export declare const formatDateDDMMYY: (date: string, locale?: string) => string;
 /**
  * @category Utilities
  */