@shipengine/elements 0.23.1 → 0.25.0

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

@@ -29,6 +29,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                 };
             };
             "void-label": {
+                title: string;
                 actions: {
                     complete: string;
                     confirmVoid: string;
@@ -47,6 +48,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                 voidedOn: string;
             };
             "view-shipment": {
+                title: string;
                 actions: {
                     buyAnotherLabel: string;
                     hideItems: string;
@@ -126,6 +128,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                 agreeToTerms: string;
             };
             "purchase-label": {
+                title: string;
                 actions: {
                     calculateRates_one: string;
                     calculateRates_other: string;
@@ -183,6 +186,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                         fractional: string;
                     };
                     weightGroup: string;
+                    today: string;
                 };
                 hints: {
                     contentDescription: string;
@@ -195,10 +199,6 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     selectService: string;
                 };
                 multipleShippingServices: string;
-                recommendedRates: {
-                    recommended: string;
-                    stayInformed: string;
-                };
                 schemaErrors: {
                     shipFromUnitedStatesOnly: string;
                     shipFromAddressRequired: string;
@@ -206,6 +206,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                 };
                 rates: {
                     uspsMediaMailAcknowledgement: string;
+                    uspsFirstClassMailAcknowledgement_leof: string;
                 };
                 shipToAddressFormFields: string;
                 sections: {
@@ -216,6 +217,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                 };
             };
             onboarding: {
+                title: string;
                 inlineTitle: string;
                 landing: {
                     action: string;
@@ -274,6 +276,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                 };
             };
             "manage-warehouses": {
+                title: string;
                 addNew: string;
                 editWarehouse: string;
                 contactName: string;
@@ -337,6 +340,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                 maximumBalanceAmount: string;
             };
             "list-carriers": {
+                title: string;
                 headers: {
                     accountCarriers: string;
                     carriers: string;
@@ -479,6 +483,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     invalidNameOrCompany: string;
                     noWarehouses: string;
                     unableToLoad: {
+                        accountSettings: string;
                         autoFundingSettings: string;
                         carrier: string;
                         carriers: string;
@@ -507,6 +512,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     thirdParty: string;
                 };
                 loading: {
+                    accountSettings: string;
                     carrier: string;
                     carriers: string;
                     data: string;

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

@@ -24,6 +24,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                 };
             };
             "void-label": {
+                title: string;
                 actions: {
                     complete: string;
                     confirmVoid: string;
@@ -42,6 +43,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                 voidedOn: string;
             };
             "view-shipment": {
+                title: string;
                 actions: {
                     buyAnotherLabel: string;
                     hideItems: string;
@@ -121,6 +123,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                 agreeToTerms: string;
             };
             "purchase-label": {
+                title: string;
                 actions: {
                     calculateRates_one: string;
                     calculateRates_other: string;
@@ -178,6 +181,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                         fractional: string;
                     };
                     weightGroup: string;
+                    today: string;
                 };
                 hints: {
                     contentDescription: string;
@@ -190,10 +194,6 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     selectService: string;
                 };
                 multipleShippingServices: string;
-                recommendedRates: {
-                    recommended: string;
-                    stayInformed: string;
-                };
                 schemaErrors: {
                     shipFromUnitedStatesOnly: string;
                     shipFromAddressRequired: string;
@@ -201,6 +201,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                 };
                 rates: {
                     uspsMediaMailAcknowledgement: string;
+                    uspsFirstClassMailAcknowledgement_leof: string;
                 };
                 shipToAddressFormFields: string;
                 sections: {
@@ -211,6 +212,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                 };
             };
             onboarding: {
+                title: string;
                 inlineTitle: string;
                 landing: {
                     action: string;
@@ -269,6 +271,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                 };
             };
             "manage-warehouses": {
+                title: string;
                 addNew: string;
                 editWarehouse: string;
                 contactName: string;
@@ -332,6 +335,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                 maximumBalanceAmount: string;
             };
             "list-carriers": {
+                title: string;
                 headers: {
                     accountCarriers: string;
                     carriers: string;
@@ -474,6 +478,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     invalidNameOrCompany: string;
                     noWarehouses: string;
                     unableToLoad: {
+                        accountSettings: string;
                         autoFundingSettings: string;
                         carrier: string;
                         carriers: string;
@@ -502,6 +507,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     thirdParty: string;
                 };
                 loading: {
+                    accountSettings: string;
                     carrier: string;
                     carriers: string;
                     data: string;

package/src/factories/shipengine/wallet-history.d.ts

@@ -12,3 +12,55 @@ export declare const walletTransactionFactory: Factory<SE.WalletTransaction, any
  * @category Factories
  */
 export declare const walletHistoryFactory: (currentPage?: number, count?: number) => Factory<SE.WalletTransactionHistory, any, SE.WalletTransactionHistory>;
+export type WalletAdjustment = {
+    actualShipment: TransactionShipment;
+    adjustment: TransactionCost;
+    adjustmentId: string;
+    originalShipment: TransactionShipment;
+    trackingNumber: string;
+    transactionId: string;
+};
+type TransactionShipment = {
+    dimensions: {
+        height: number;
+        length: number;
+        unit: string;
+        width: number;
+    };
+    insuranceCost: TransactionCost;
+    packageCode: string;
+    rateDetails: TransactionRateDetail[];
+    serviceCode: string;
+    shipFrom: TransactionShipDestination;
+    shipmentCost: TransactionCost;
+    shipTo: TransactionShipDestination;
+    weight: {
+        unit: string;
+        value: number;
+    };
+};
+type TransactionShipDestination = {
+    addressLine1: string;
+    addressLine2: string;
+    addressResidentialIndicator: "yes" | "no";
+    cityLocality: string;
+    companyName: string;
+    countryCode: string;
+    name: string;
+    phone: string;
+    postalCode: string;
+    stateProvince: string;
+};
+type TransactionRateDetail = {
+    amount: TransactionCost;
+    carrierBillingCode: string;
+    carrierDescription: string;
+    carrierMemo: string | null;
+    rateDetailType: string;
+};
+type TransactionCost = {
+    amount: number;
+    currency: string;
+};
+export declare const walletAdjustmentFactory: Factory<WalletAdjustment, any, WalletAdjustment>;
+export {};

package/src/features/wallet-history/wallet-history.styles.d.ts

@@ -1 +1,81 @@
-export declare const styles: Record<"action" | "displayStateContainer" | "emptyStateContainer" | "gridContainer" | "linkAction" | "pagination" | "skeletonCard" | "skeletonCardColumnLeft" | "skeletonCardColumnRight" | "skeletonCardList" | "skeletonCardLogo" | "skeletonPagination", import("@emotion/serialize").Interpolation<import("@packlink/giger-theme/dist/lib/Theme").Theme>>;
+export declare const styles: {
+    action: (theme: import("@packlink/giger-theme/dist/lib/Theme").Theme) => {
+        minWidth: number;
+        placeContent: "center";
+        width: number;
+    };
+    displayStateContainer: (theme: import("@packlink/giger-theme/dist/lib/Theme").Theme) => {
+        "& > *:not(:last-child)::after": {
+            borderBottom: string;
+            content: "\"\"";
+            display: "block";
+            width: string;
+        };
+        border: string;
+        display: "flex";
+        flexDirection: "column";
+        listStyle: "none";
+    };
+    emptyStateContainer: (theme: import("@packlink/giger-theme/dist/lib/Theme").Theme) => {
+        backgroundColor: string;
+        padding: number;
+        textAlign: "center";
+    };
+    gridContainer: (theme: import("@packlink/giger-theme/dist/lib/Theme").Theme) => {
+        display: "flex";
+        justifyContent: "space-between";
+        placeItems: "center";
+    };
+    linkAction: (theme: import("@packlink/giger-theme/dist/lib/Theme").Theme) => {
+        textAlign: "end";
+    };
+    pagination: {
+        "&& button": {
+            background: string;
+        };
+        "&& button[aria-current='step']": {
+            background: string;
+        };
+        textAlign: "center";
+    };
+    skeletonCard: (theme: import("@packlink/giger-theme/dist/lib/Theme").Theme) => {
+        backgroundColor: "#e3dfdf1f";
+        display: "flex";
+        justifyContent: "space-between";
+        padding: number;
+    };
+    skeletonCardColumnLeft: {
+        display: "flex";
+        flexDirection: "column";
+        justifyContent: "space-between";
+    };
+    skeletonCardColumnRight: (theme: import("@packlink/giger-theme/dist/lib/Theme").Theme) => {
+        alignItems: "flex-end";
+        display: "flex";
+        flexDirection: "column";
+        justifyContent: "space-between";
+        rowGap: number;
+    };
+    skeletonCardList: (theme: import("@packlink/giger-theme/dist/lib/Theme").Theme) => {
+        display: "flex";
+        flexDirection: "column";
+        rowGap: number;
+    };
+    skeletonCardLogo: (theme: import("@packlink/giger-theme/dist/lib/Theme").Theme) => {
+        alignItems: "center";
+        columnGap: number;
+        display: "flex";
+    };
+    skeletonCardTransactionRow: (theme: import("@packlink/giger-theme/dist/lib/Theme").Theme) => {
+        columnGap: string;
+        display: "flex";
+    };
+    skeletonPagination: (theme: import("@packlink/giger-theme/dist/lib/Theme").Theme) => {
+        alignItems: "center";
+        display: "flex";
+        justifyContent: "space-between";
+        marginLeft: string;
+        marginRight: string;
+        maxWidth: string;
+    };
+};

package/src/hooks/options/use-rate-options.d.ts

@@ -2,20 +2,7 @@ import { SE } from "@shipengine/alchemy";
 export type RateOption = Omit<SE.Rate, "warningMessages"> & {
     balance?: number;
     messages: string[];
-    recommended?: boolean;
     requiresAcknowledgement?: boolean;
     requiresFundedAmount?: boolean;
 };
-type RateRecommendation = {
-    carrierCode: string;
-    ignoreIfPresent?: string;
-    serviceCode: string;
-    tagline?: string;
-    walleted: boolean;
-};
-type RateRecommendations = {
-    domestic: RateRecommendation;
-    international: RateRecommendation;
-};
-export declare const useRateOptions: (rates?: SE.Rate[], carriers?: SE.Carrier[], shipment?: SE.SalesOrderShipment, enableGlobalPostFiltering?: boolean, rateRecommendations?: RateRecommendations) => RateOption[];
-export {};
+export declare const useRateOptions: (rates?: SE.Rate[], carriers?: SE.Carrier[], shipment?: SE.SalesOrderShipment, enableGlobalPostFiltering?: boolean) => RateOption[];

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

@@ -13,6 +13,7 @@ declare const _default: {
         };
     };
     "void-label": {
+        title: string;
         actions: {
             complete: string;
             confirmVoid: string;
@@ -31,6 +32,7 @@ declare const _default: {
         voidedOn: string;
     };
     "view-shipment": {
+        title: string;
         actions: {
             buyAnotherLabel: string;
             hideItems: string;
@@ -110,6 +112,7 @@ declare const _default: {
         agreeToTerms: string;
     };
     "purchase-label": {
+        title: string;
         actions: {
             calculateRates_one: string;
             calculateRates_other: string;
@@ -167,6 +170,7 @@ declare const _default: {
                 fractional: string;
             };
             weightGroup: string;
+            today: string;
         };
         hints: {
             contentDescription: string;
@@ -179,10 +183,6 @@ declare const _default: {
             selectService: string;
         };
         multipleShippingServices: string;
-        recommendedRates: {
-            recommended: string;
-            stayInformed: string;
-        };
         schemaErrors: {
             shipFromUnitedStatesOnly: string;
             shipFromAddressRequired: string;
@@ -190,6 +190,7 @@ declare const _default: {
         };
         rates: {
             uspsMediaMailAcknowledgement: string;
+            uspsFirstClassMailAcknowledgement_leof: string;
         };
         shipToAddressFormFields: string;
         sections: {
@@ -200,6 +201,7 @@ declare const _default: {
         };
     };
     onboarding: {
+        title: string;
         inlineTitle: string;
         landing: {
             action: string;
@@ -258,6 +260,7 @@ declare const _default: {
         };
     };
     "manage-warehouses": {
+        title: string;
         addNew: string;
         editWarehouse: string;
         contactName: string;
@@ -321,6 +324,7 @@ declare const _default: {
         maximumBalanceAmount: string;
     };
     "list-carriers": {
+        title: string;
         headers: {
             accountCarriers: string;
             carriers: string;
@@ -463,6 +467,7 @@ declare const _default: {
             invalidNameOrCompany: string;
             noWarehouses: string;
             unableToLoad: {
+                accountSettings: string;
                 autoFundingSettings: string;
                 carrier: string;
                 carriers: string;
@@ -491,6 +496,7 @@ declare const _default: {
             thirdParty: string;
         };
         loading: {
+            accountSettings: string;
             carrier: string;
             carriers: string;
             data: string;

package/src/mocks/account-settings/handlers.d.ts

@@ -0,0 +1,8 @@
+export declare const createAccountSettingsHandlers: () => {
+    database: {
+        default_label_layout: string;
+        dimensions_unit: string;
+        weight_unit: string;
+    };
+    handlers: import("msw").RestHandler<import("msw/lib/glossary-de6278a9").M<import("msw/lib/glossary-de6278a9").h>>[];
+};

package/src/mocks/account-settings/index.d.ts

@@ -0,0 +1 @@
+export * from "./handlers";

package/src/mocks/index.d.ts

@@ -1,2 +1,3 @@
 export * from "./carriers";
 export * from "./warehouses";
+export * from "./account-settings";

package/src/public-sdk.d.ts

@@ -0,0 +1,38 @@
+import { DialogProps, ISidePanelDefaultHeaderProps, SidePanelProps } from "@packlink/giger";
+import { AlchemyProps } from "@shipengine/alchemy";
+import * as JsApi from "@shipengine/js-api";
+import { ManageWarehouses, Onboarding, PurchaseLabel, ViewShipment, VoidLabel } from "./elements";
+type DialogSDKProps = Omit<DialogProps, "isOpen">;
+type SidePanelSDKProps = Omit<SidePanelProps, "isOpen">;
+type ElementsSDKOptions = Omit<AlchemyProps, "getToken" | "children">;
+export declare class ElementsSDK {
+    #private;
+    getClient(token: string, config: JsApi.ShipEngineAPIConfig): {
+        readonly token: never;
+        readonly accountSettings: Omit<JsApi.AccountSettingsAPI, "client">;
+        readonly addresses: Omit<JsApi.AddressesAPI, "client">;
+        readonly carriers: Omit<JsApi.CarriersAPI, "client">;
+        readonly customPackages: Omit<JsApi.CustomPackagesAPI, "client">;
+        readonly insurance: Omit<JsApi.InsuranceAPI, "client">;
+        readonly labels: Omit<JsApi.LabelsAPI, "client">;
+        readonly orderSources: Omit<JsApi.OrderSourcesAPI, "client">;
+        readonly rates: Omit<JsApi.RatesAPI, "client">;
+        readonly salesOrderShipments: Omit<JsApi.SalesOrderShipmentsAPI, "client">;
+        readonly salesOrders: Omit<JsApi.SalesOrdersAPI, "client">;
+        readonly shipments: Omit<JsApi.ShipmentsAPI, "client">;
+        readonly warehouses: Omit<JsApi.WarehousesAPI, "client">;
+    };
+    constructor(getToken: AlchemyProps["getToken"], options?: ElementsSDKOptions);
+    unmount(): void;
+    closeDialog(): void;
+    closeSidePanel(): void;
+    onboardUser(props: Onboarding.ComponentProps, dialogProps: DialogSDKProps): void;
+    purchaseLabel(props: PurchaseLabel.ComponentProps, sidePanelProps: SidePanelSDKProps, sidePanelHeaderProps: ISidePanelDefaultHeaderProps): void;
+    listCarriers(dialogProps: DialogSDKProps): void;
+    manageWarehouses(props: ManageWarehouses.ComponentProps, dialogProps: DialogSDKProps): void;
+    viewShipment(props: ViewShipment.ComponentProps, dialogProps: DialogSDKProps): void;
+    voidLabel(props: VoidLabel.ComponentProps & {
+        labelId: string;
+    }, dialogProps: DialogSDKProps): void;
+}
+export {};

package/src/utilities/rates.d.ts

@@ -1,5 +1,5 @@
 import { SE } from "@shipengine/alchemy";
-export declare const getRateRequiresAcknowledgement: (serviceCode: string) => boolean;
+export declare const getRateRequiresAcknowledgement: (serviceCode: string, packageType: string) => boolean;
 export declare const getTotalRateAmount: (rateCosts?: {
     confirmationAmount?: SE.Money;
     insuranceAmount?: SE.Money;

package/src/utilities/styles.d.ts

@@ -1,18 +1,39 @@
 import { Interpolation } from "@emotion/serialize";
 import { Theme } from "@packlink/giger-theme";
 /**
- * Creates a Record of Emotion styles.
+ * The verbose typing is necessary to get around TypeScript's limitations on contextual inference
+ * with generics. https://stackoverflow.com/questions/75999792/ide-autocompletion-broken-with-typescript-mapped-type-conditionals
+ */
+type GetterKey = `get${Capitalize<string>}`;
+type GetterFunction = (...args: any[]) => Interpolation<Theme>;
+type LowerLetters = "a" | "b" | "c" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "n" | "o" | "p" | "q" | "r" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z";
+type Letters = LowerLetters | Uppercase<LowerLetters>;
+type NotG = Exclude<Letters, "g">;
+type NotGE = `g${Exclude<Letters, "e">}`;
+type NotGET = `ge${Exclude<Letters, "t">}`;
+type NotGETUP = `get${Uncapitalize<string>}`;
+type NotGetterKey = NotG | NotGE | NotGET | NotGETUP;
+type StylesConstraint = Record<GetterKey, GetterFunction> & Record<`${NotGetterKey}${string}`, Interpolation<Theme>>;
+/**
+ * Creates a Record of Emotion styles; eliminating the need to explicitly type styles
+ * while remaining fully typesafe w/ autocomplete.
  *
- * Values may be any variant that a `css` prop can accept (a CSSObject, SerializedStyles, a FunctionInterpolation with theme, etc).
+ * Keys prefixed with `get` are assumed to be getters and support arbitrary props.
  *
- * Eliminates the need to explicitly type styles (while remaining fully typed w/ autocomplete).
+ * Values may be any variant of `Interpolation` that the `css` prop can accept:
+ * a `CSSObject`, `SerializedStyles`, a `FunctionInterpolation` with theme, etc.
  *
  * @example
  * ```
  * const styles = createStyles({
- *   container: (theme) => ({ backgroundColor: theme.colors.primary }),
- *   icon: { color: 'red' },
+ *   basicObject: { color: "red" },
+ *   withTheme: (theme) => ({ backgroundColor: theme.palette.primary.main }),
+ *
+ *   getWithArbitraryPropsAndTheme: (disabled?: boolean) => (theme) => ({
+ *     color: theme.palette[disabled ? 'primary' : 'gray'].main,
+ *   }),
  * });
  * ```
  */
-export declare const createStyles: <T extends string>(styles: Record<T, Interpolation<Theme>>) => Record<T, Interpolation<Theme>>;
+export declare const createStyles: <T extends StylesConstraint>(styles: T) => T;
+export {};

package/vite.config.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("vite").UserConfigExport;
+export default _default;