@shipengine/elements 1.5.1 → 1.7.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/index.cjs +14782 -14386
- package/index.js +14797 -14413
- package/package.json +5 -7
- package/src/components/address-preference-context/address-preference-context.d.ts +2 -1
- package/src/components/auto-funding-form/auto-funding-form.styles.d.ts +4 -8
- package/src/components/collapsible-panel/collapsible-panel.d.ts +6 -1
- package/src/components/collapsible-panel/collapsible-panel.styles.d.ts +1 -1
- package/src/components/date-range-select/date-range-select.d.ts +1 -2
- package/src/components/field/create-field-controller.d.ts +2 -1
- package/src/components/field/date-picker/date-picker.d.ts +2 -6
- package/src/components/field/rate-card/cost-breakdown/cost-breakdown.d.ts +1 -1
- package/src/components/field/rate-card/rate-card.d.ts +3 -1
- package/src/components/field/rate-card/rate-card.styles.d.ts +1 -0
- package/src/components/field-label/field-label.d.ts +2 -1
- package/src/components/history/history-card/history-card.d.ts +5 -2
- package/src/components/index.d.ts +5 -2
- package/src/components/service-point-display/service-point-display.d.ts +1 -1
- package/src/components/service-point-display/service-point-display.styles.d.ts +8 -0
- package/src/components/templates/address-display/address-display.d.ts +2 -1
- package/src/components/templates/address-form/address-schema.d.ts +2 -0
- package/src/components/templates/connected-carrier-list/connected-carrier-row/connected-carrier-row.styles.d.ts +17 -0
- package/src/components/templates/index.d.ts +1 -4
- package/src/components/templates/label/label.styles.d.ts +0 -6
- package/src/components/templates/product-form/product-form-schema.d.ts +0 -12
- package/src/components/templates/pudo-rate-tabs/pudo-rate-tabs.d.ts +6 -1
- package/src/components/templates/rate-form/rate-form.d.ts +4 -2
- package/src/components/templates/rate-form/rate-form.styles.d.ts +2 -4
- package/src/components/templates/shipment-form/shipment-schema.d.ts +0 -50
- package/src/components/templates/wallet-form/wallet-schema.d.ts +46 -2
- package/src/components/{templates/warehouse-form → warehouse-form}/warehouse-form.d.ts +1 -1
- package/src/elements/external-carriers/external-carriers.d.ts +819 -9
- package/src/elements/index.d.ts +7 -3
- package/src/elements/label-layout/index.d.ts +1 -0
- package/src/elements/label-layout/label-layout-element.d.ts +791 -0
- package/src/elements/labels-grid/labels-grid.d.ts +16 -2
- package/src/elements/manage-funding/index.d.ts +1 -0
- package/src/elements/manage-funding/manage-funding-element.d.ts +791 -0
- package/src/elements/manage-warehouses/manage-warehouses.d.ts +791 -21
- package/src/elements/payment-method-settings/index.d.ts +1 -0
- package/src/elements/payment-method-settings/payment-method-settings-element.d.ts +791 -0
- package/src/elements/{configure-shipment → purchase-label}/configure-shipment.d.ts +1 -12
- package/src/elements/purchase-label/hooks/index.d.ts +8 -0
- package/src/elements/purchase-label/hooks/use-configure-shipment.d.ts +1 -1
- package/src/elements/{configure-shipment → purchase-label}/hooks/use-rates-form.d.ts +1 -1
- package/src/elements/{configure-shipment → purchase-label}/hooks/use-rates-with-cache.d.ts +1 -1
- package/src/elements/{configure-shipment → purchase-label}/hooks/use-request-preferred-rates.d.ts +1 -1
- package/src/elements/{configure-shipment → purchase-label}/hooks/use-request-rates.d.ts +2 -1
- package/src/elements/purchase-label/purchase-label.d.ts +36 -50
- package/src/elements/shipengine-carriers/index.d.ts +1 -0
- package/src/elements/shipengine-carriers/shipengine-carriers.d.ts +854 -0
- package/src/elements/shipments-grid/shipments-grid.d.ts +16 -2
- package/src/elements/theme-creator/theme-creator.d.ts +16 -2
- package/src/elements/unit-settings/index.d.ts +1 -0
- package/src/elements/unit-settings/unit-settings-element.d.ts +791 -0
- package/src/elements/view-shipment/view-shipment.d.ts +29 -15
- package/src/elements/void-label/void-label.d.ts +25 -12
- package/src/elements/wallet-history/index.d.ts +1 -0
- package/src/elements/wallet-history/wallet-history-element.d.ts +791 -0
- package/src/features/external-carriers/external-carriers.d.ts +10 -0
- package/src/features/external-carriers/index.d.ts +1 -0
- package/src/features/index.d.ts +7 -0
- package/src/features/label-layout/index.d.ts +2 -0
- package/src/features/label-layout/label-layout.d.ts +7 -0
- package/src/features/label-layout/use-label-layout.d.ts +7 -0
- package/src/features/manage-funding/manage-funding.d.ts +16 -0
- package/src/features/manage-warehouses/index.d.ts +2 -0
- package/src/features/manage-warehouses/manage-warehouses.d.ts +16 -0
- package/src/features/manage-warehouses/use-manage-warehouses.d.ts +15 -0
- package/src/features/shipengine-carriers/hooks/index.d.ts +2 -0
- package/src/features/shipengine-carriers/hooks/use-carrier-metadata.d.ts +13 -0
- package/src/features/shipengine-carriers/index.d.ts +1 -0
- package/src/features/shipengine-carriers/shipengine-carriers-row/index.d.ts +1 -0
- package/src/features/shipengine-carriers/shipengine-carriers-row/shipengine-carriers-row.d.ts +9 -0
- package/src/features/shipengine-carriers/shipengine-carriers.d.ts +10 -0
- package/src/features/unit-settings/index.d.ts +2 -0
- package/src/features/unit-settings/unit-settings.d.ts +9 -0
- package/src/features/unit-settings/use-unit-settings.d.ts +10 -0
- package/src/features/wallet-history/wallet-history.styles.d.ts +10 -10
- package/src/hooks/index.d.ts +0 -1
- package/src/hooks/options/use-rate-options.d.ts +1 -1
- package/src/locales/en/index.d.ts +16 -2
- package/src/types/carrier-metadata.d.ts +3 -0
- package/src/types/index.d.ts +1 -0
- package/src/types/preferred-rates.d.ts +13 -0
- package/src/utilities/date.d.ts +2 -1
- package/src/utilities/feature-flags.d.ts +5 -2
- package/src/utilities/index.d.ts +1 -0
- package/src/utilities/tracking-status-formatter.d.ts +1 -0
- package/src/{elements → workflows}/account-settings/account-settings.d.ts +25 -58
- package/src/workflows/account-settings/use-get-panel-props.d.ts +10 -0
- package/src/{elements → workflows}/connect-carrier/connect-carrier.d.ts +16 -2
- package/src/workflows/index.d.ts +3 -0
- package/src/workflows/manage-wallet-workflow/index.d.ts +1 -0
- package/src/workflows/manage-wallet-workflow/manage-wallet-workflow.d.ts +828 -0
- package/src/workflows/manage-wallet-workflow/use-get-wallet-panel-props.d.ts +4 -0
- package/src/workflows/onboarding/components/onboarding-wizard/onboarding-wizard.d.ts +2 -2
- package/src/workflows/onboarding/components/ship-from-address-step/ship-from-address-step.d.ts +1 -1
- package/src/workflows/onboarding/components/ship-from-address-step/use-ship-from-address-step.d.ts +1 -1
- package/src/workflows/onboarding/components/terms-agreement-form/terms-agreement-form.d.ts +2 -1
- package/src/workflows/onboarding/onboarding.d.ts +21 -8
- package/src/workflows/purchase-label-workflow/index.d.ts +1 -0
- package/src/{elements/shipengine-workflow/label-workflow.d.ts → workflows/purchase-label-workflow/purchase-label-workflow.d.ts} +19 -21
- package/src/components/date-range-select/date-range-select.styles.d.ts +0 -7
- package/src/components/field/date-picker/date-picker.styles.d.ts +0 -3
- package/src/components/label-layout/index.d.ts +0 -3
- package/src/components/label-layout/label-layout-purchase.d.ts +0 -5
- package/src/components/label-layout/label-layout-settings.d.ts +0 -7
- package/src/components/label-layout/label-layout.d.ts +0 -9
- package/src/components/manage-funding/manage-funding.d.ts +0 -35
- package/src/components/templates/account-settings/account-settings.d.ts +0 -10
- package/src/components/templates/account-settings/index.d.ts +0 -1
- package/src/components/templates/list-carriers/index.d.ts +0 -1
- package/src/components/templates/list-carriers/list-carriers.d.ts +0 -16
- package/src/components/templates/list-carriers-row/index.d.ts +0 -1
- package/src/components/templates/list-carriers-row/list-carriers-row.d.ts +0 -9
- package/src/components/templates/manage-warehouses/index.d.ts +0 -1
- package/src/components/templates/manage-warehouses/manage-warehouses.d.ts +0 -11
- package/src/components/unit-settings/index.d.ts +0 -1
- package/src/components/unit-settings/unit-settings.d.ts +0 -6
- package/src/elements/configure-shipment/hooks/index.d.ts +0 -8
- package/src/elements/configure-shipment/index.d.ts +0 -1
- package/src/elements/list-carriers/index.d.ts +0 -1
- package/src/elements/list-carriers/list-carriers.d.ts +0 -36
- package/src/elements/shipengine-workflow/index.d.ts +0 -1
- package/src/hooks/use-carrier-metadata.d.ts +0 -10
- /package/src/components/{templates/edit-billing-form → edit-billing-form}/edit-billing-form.d.ts +0 -0
- /package/src/components/{templates/edit-billing-form → edit-billing-form}/edit-billing-form.styles.d.ts +0 -0
- /package/src/components/{templates/edit-billing-form → edit-billing-form}/index.d.ts +0 -0
- /package/src/components/{templates/wallet-card → wallet-card}/index.d.ts +0 -0
- /package/src/components/{templates/wallet-card → wallet-card}/wallet-card.d.ts +0 -0
- /package/src/components/{templates/wallet-card → wallet-card}/wallet-card.styles.d.ts +0 -0
- /package/src/components/{templates/warehouse-form → warehouse-form}/index.d.ts +0 -0
- /package/src/components/{templates/warehouse-form → warehouse-form}/warehouse-form-schema.d.ts +0 -0
- /package/src/elements/{configure-shipment → purchase-label}/hooks/use-address.d.ts +0 -0
- /package/src/elements/{configure-shipment → purchase-label}/hooks/use-customs.d.ts +0 -0
- /package/src/elements/{configure-shipment → purchase-label}/hooks/use-presets.d.ts +0 -0
- /package/src/elements/{configure-shipment → purchase-label}/hooks/use-shipment-form.d.ts +0 -0
- /package/src/{components → features}/label-layout/label-layout.styles.d.ts +0 -0
- /package/src/{components → features}/manage-funding/index.d.ts +0 -0
- /package/src/{components/templates → features}/manage-warehouses/manage-warehouse.styles.d.ts +0 -0
- /package/src/{components/templates → features/manage-warehouses}/warehouse-display/index.d.ts +0 -0
- /package/src/{components/templates → features/manage-warehouses}/warehouse-display/warehouse-display.d.ts +0 -0
- /package/src/{components → features}/payment-method-settings/index.d.ts +0 -0
- /package/src/{components → features}/payment-method-settings/payment-method-settings.d.ts +0 -0
- /package/src/{elements/list-carriers → features/shipengine-carriers}/hooks/use-list-connected-carriers.d.ts +0 -0
- /package/src/{components/templates/list-carriers-row/list-carriers-row.styles.d.ts → features/shipengine-carriers/shipengine-carriers-row/shipengine-carriers-row.styles.d.ts} +0 -0
- /package/src/{components/templates/list-carriers/list-carriers.styles.d.ts → features/shipengine-carriers/shipengine-carriers.styles.d.ts} +0 -0
- /package/src/{elements → workflows}/account-settings/index.d.ts +0 -0
- /package/src/{elements → workflows}/connect-carrier/index.d.ts +0 -0
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { SE } from "@shipengine/alchemy";
|
|
2
|
-
import {
|
|
2
|
+
import { ShipEngineCarriersFeatures } from "../../../../features";
|
|
3
3
|
import { ShipFromAddressStepProps } from "../ship-from-address-step";
|
|
4
4
|
export type ValidateWarehouse = {
|
|
5
5
|
type: "warehouse";
|
|
@@ -13,7 +13,7 @@ export type ValidateBilling = {
|
|
|
13
13
|
type: "billing";
|
|
14
14
|
};
|
|
15
15
|
export type ValidateAddress = ValidateWarehouse | ValidateBilling;
|
|
16
|
-
export type OnboardingWizardFeatures =
|
|
16
|
+
export type OnboardingWizardFeatures = ShipEngineCarriersFeatures & {
|
|
17
17
|
presentation: {
|
|
18
18
|
poweredByShipEngine?: boolean;
|
|
19
19
|
};
|
package/src/workflows/onboarding/components/ship-from-address-step/ship-from-address-step.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { SE } from "@shipengine/alchemy";
|
|
2
|
-
import { WarehousePayload } from "../../../../components
|
|
2
|
+
import { WarehousePayload } from "../../../../components";
|
|
3
3
|
export type ShipFromAddressStepProps = {
|
|
4
4
|
defaultShipFromAddress?: Pick<SE.Warehouse, "name" | "isDefault" | "originAddress" | "returnAddress">;
|
|
5
5
|
onSubmit: (payload: WarehousePayload) => Promise<void>;
|
|
@@ -2,6 +2,7 @@ import { MetadataRequiredTermWithLinks } from "../../../../types";
|
|
|
2
2
|
export type TermsAgreementFormProps = {
|
|
3
3
|
carrierTerms: MetadataRequiredTermWithLinks[];
|
|
4
4
|
fundingSourceTerms: MetadataRequiredTermWithLinks[];
|
|
5
|
+
hideTerms: boolean;
|
|
5
6
|
onSubmit: (agreement: boolean) => void;
|
|
6
7
|
};
|
|
7
|
-
export declare const TermsAgreementForm: ({ carrierTerms, fundingSourceTerms, onSubmit, }: TermsAgreementFormProps) => import("@emotion/react/jsx-runtime").JSX.Element;
|
|
8
|
+
export declare const TermsAgreementForm: ({ carrierTerms, fundingSourceTerms, hideTerms, onSubmit, }: TermsAgreementFormProps) => import("@emotion/react/jsx-runtime").JSX.Element;
|
|
@@ -65,7 +65,7 @@ export declare const Component: ({ defaultShipFromAddress, features, onComplete,
|
|
|
65
65
|
* Element directly. Here is a brief example of how you would use it within your application.
|
|
66
66
|
* ```tsx
|
|
67
67
|
* <Onboarding.Element
|
|
68
|
-
*
|
|
68
|
+
* onComplete={() => console.log('Onboarding Complete!')}
|
|
69
69
|
* />
|
|
70
70
|
* ```
|
|
71
71
|
*
|
|
@@ -140,8 +140,8 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
|
|
|
140
140
|
shipTo: string;
|
|
141
141
|
warehouse: string;
|
|
142
142
|
weight: string;
|
|
143
|
-
insuredValue: string;
|
|
144
|
-
deliveryConfirmation: string;
|
|
143
|
+
insuredValue: string; /** Invoked when the onboarding process is completed. */
|
|
144
|
+
deliveryConfirmation: string;
|
|
145
145
|
};
|
|
146
146
|
highVolumeForms: string;
|
|
147
147
|
multipleShippingServices: string;
|
|
@@ -155,6 +155,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
|
|
|
155
155
|
setup: {
|
|
156
156
|
title: string;
|
|
157
157
|
subtitle: string;
|
|
158
|
+
hiddenTermsSubtitle: string;
|
|
158
159
|
descriptionTitle: string;
|
|
159
160
|
description: string;
|
|
160
161
|
};
|
|
@@ -162,7 +163,6 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
|
|
|
162
163
|
title: string;
|
|
163
164
|
cardSubTitle: string;
|
|
164
165
|
addressSubTitle: string;
|
|
165
|
-
/** If provided, the address form will be pre-filled */
|
|
166
166
|
info: string;
|
|
167
167
|
};
|
|
168
168
|
carriers: {
|
|
@@ -171,7 +171,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
|
|
|
171
171
|
};
|
|
172
172
|
notifications: {
|
|
173
173
|
error: {
|
|
174
|
-
title: string;
|
|
174
|
+
title: string;
|
|
175
175
|
};
|
|
176
176
|
info: {
|
|
177
177
|
title: string;
|
|
@@ -285,6 +285,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
|
|
|
285
285
|
needToAcknowledge: string;
|
|
286
286
|
};
|
|
287
287
|
rates: {
|
|
288
|
+
requestedShippingNotification: string;
|
|
288
289
|
uspsMediaMailAcknowledgement: string;
|
|
289
290
|
uspsFirstClassMailAcknowledgement_leof: string;
|
|
290
291
|
rateSavings: string;
|
|
@@ -309,7 +310,8 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
|
|
|
309
310
|
nextOpeningDay: string;
|
|
310
311
|
until: string;
|
|
311
312
|
selected: string;
|
|
312
|
-
|
|
313
|
+
select: string;
|
|
314
|
+
today: string;
|
|
313
315
|
viewMap: string;
|
|
314
316
|
otherLocations: string;
|
|
315
317
|
noServicePointsFound: string;
|
|
@@ -365,12 +367,18 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
|
|
|
365
367
|
"aHR0cHM6Ly93d3cueW9kZWxkaXJlY3QuY28udWsvY29udGVudC9hYm91dC10ZXJtcw==": string;
|
|
366
368
|
aHR0cHM6Ly93d3cuc2hpcHN0YXRpb24uY29tL3Rlcm1zLXNlcnZpY2UtdW5pdGVkLWtpbmdkb20v: string;
|
|
367
369
|
"aHR0cHM6Ly93d3cuZHBkLmNvLnVrL3N0YW5kYXJkX3Rlcm1zX2FuZF9jb25kaXRpb25zLmpzcA==": string;
|
|
370
|
+
aHR0cHM6Ly93d3cuZ29nbG9iYWxwb3N0LmNvbS9jb25kaXRpb25z: string;
|
|
371
|
+
aHR0cHM6Ly93d3cucHVyb2xhdG9yLmNvbS9mci9tb2RhbGl0ZXMtZXQtY29uZGl0aW9ucy1kZS1zZXJ2aWNl: string;
|
|
372
|
+
aHR0cHM6Ly93d3cucHVyb2xhdG9yLmNvbS9lbi90ZXJtcy1hbmQtY29uZGl0aW9ucy1zZXJ2aWNl: string;
|
|
368
373
|
};
|
|
369
374
|
termsAndAgreementTitles: {
|
|
370
375
|
"WW9kZWwgRGlyZWN0IC0gVGVybXMgYW5kIENvbmRpdGlvbnMgKOKAnFRlcm1z4oCdKQ==": string;
|
|
371
376
|
"RXZyaSBTZW5kIFRlcm1zICYgQ29uZGl0aW9ucw==": string;
|
|
372
377
|
"VGVybXMgb2YgU2VydmljZSBVbml0ZWQgS2luZ2RvbQ==": string;
|
|
373
378
|
RFBEIFN0YW5kYXJkIFRlcm1zIGFuZCBDb25kaXRpb25z: string;
|
|
379
|
+
"R2xvYmFsUG9zdCBUZXJtcyBhbmQgQ29uZGl0aW9ucw==": string;
|
|
380
|
+
"UHVyb2xhdG9yIFRlcm1zIGFuZCBDb25kaXRpb25zIG9mIFNlcnZpY2U=": string;
|
|
381
|
+
UHVyb2xhdG9yIE1vZGFsaXTDqXMgZXQgY29uZGl0aW9ucyBkZSBzZXJ2aWNl: string;
|
|
374
382
|
};
|
|
375
383
|
};
|
|
376
384
|
"manage-defaults": {
|
|
@@ -512,7 +520,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
|
|
|
512
520
|
};
|
|
513
521
|
};
|
|
514
522
|
};
|
|
515
|
-
"
|
|
523
|
+
"shipengine-carriers": {
|
|
516
524
|
title: string;
|
|
517
525
|
headers: {
|
|
518
526
|
accountCarriers: string;
|
|
@@ -855,6 +863,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
|
|
|
855
863
|
"connect-carrier": {
|
|
856
864
|
actions: {
|
|
857
865
|
cancel: string;
|
|
866
|
+
carrierSettings: string;
|
|
858
867
|
connectCarriers: string;
|
|
859
868
|
disconnect: string;
|
|
860
869
|
disconnectCarrier: string;
|
|
@@ -862,7 +871,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
|
|
|
862
871
|
noCarriersDescription: string;
|
|
863
872
|
registrationForm: {
|
|
864
873
|
error: string;
|
|
865
|
-
title: string;
|
|
874
|
+
title: string;
|
|
866
875
|
betaWarning: string;
|
|
867
876
|
};
|
|
868
877
|
search: string;
|
|
@@ -873,6 +882,10 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
|
|
|
873
882
|
status: {
|
|
874
883
|
connected: string;
|
|
875
884
|
};
|
|
885
|
+
disconnectDropdown: {
|
|
886
|
+
toastTitle: string;
|
|
887
|
+
toastBody: string;
|
|
888
|
+
};
|
|
876
889
|
};
|
|
877
890
|
"account-settings": {
|
|
878
891
|
messages: {
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * as PurchaseLabelWorkflow from "./purchase-label-workflow";
|
|
@@ -1,18 +1,16 @@
|
|
|
1
|
-
|
|
1
|
+
/// <reference types="react" />
|
|
2
2
|
import { Shipment } from "@shipengine/js-api";
|
|
3
|
-
import { PurchaseLabel } from "
|
|
4
|
-
import { ViewShipment } from "../view-shipment";
|
|
5
|
-
import { VoidLabel } from "../void-label";
|
|
3
|
+
import { PurchaseLabel, ViewShipment, VoidLabel } from "../../elements";
|
|
6
4
|
/**
|
|
7
5
|
* @internal
|
|
8
6
|
*
|
|
9
7
|
* # Label Workflow Props
|
|
10
8
|
*
|
|
11
|
-
* - These are the base props that will be passed into the `<
|
|
9
|
+
* - These are the base props that will be passed into the `<PurchaseLabelWorkflow />` component.
|
|
12
10
|
*
|
|
13
|
-
* @see {@link
|
|
11
|
+
* @see {@link PurchaseLabelWorkflow.Element | The `<PurchaseLabelWorkflow.Element />` component}
|
|
14
12
|
*/
|
|
15
|
-
export type
|
|
13
|
+
export type PurchaseLabelWorkflowProps = {
|
|
16
14
|
/**
|
|
17
15
|
* `callbacks` is an optional set of callbacks that will be invoked at various points in the
|
|
18
16
|
* label purchasing workflow.
|
|
@@ -66,7 +64,7 @@ export type LabelWorkflowProps = {
|
|
|
66
64
|
* setLabelId,
|
|
67
65
|
* setShipmentId,
|
|
68
66
|
* setIsVoidingLabel,
|
|
69
|
-
* } =
|
|
67
|
+
* } = usePurchaseLabelWorkflow({
|
|
70
68
|
* _labelId,
|
|
71
69
|
* _multiplexedId,
|
|
72
70
|
* });
|
|
@@ -74,9 +72,9 @@ export type LabelWorkflowProps = {
|
|
|
74
72
|
*
|
|
75
73
|
* <br />
|
|
76
74
|
*
|
|
77
|
-
* @see {@link
|
|
75
|
+
* @see {@link PurchaseLabelWorkflow.Element | The `<PurchaseLabelWorkflow.Element />` component using this hook}
|
|
78
76
|
*/
|
|
79
|
-
export declare const
|
|
77
|
+
export declare const usePurchaseLabelWorkflow: ({ _multiplexedId, _labelId, }: {
|
|
80
78
|
_callbacks?: {
|
|
81
79
|
/**
|
|
82
80
|
* `onLabelCreateSuccess` is an optional callback function that will be invoked when a label
|
|
@@ -116,9 +114,9 @@ export declare const useLabelWorkflow: ({ _multiplexedId, _labelId, }: {
|
|
|
116
114
|
} | {
|
|
117
115
|
oneOff: true;
|
|
118
116
|
};
|
|
119
|
-
setIsVoidingLabel:
|
|
120
|
-
setLabelId: (nextLabelId:
|
|
121
|
-
setMultiplexedId:
|
|
117
|
+
setIsVoidingLabel: import("react").Dispatch<import("react").SetStateAction<boolean>>;
|
|
118
|
+
setLabelId: (nextLabelId: PurchaseLabelWorkflowProps["labelId"]) => void;
|
|
119
|
+
setMultiplexedId: import("react").Dispatch<import("react").SetStateAction<({
|
|
122
120
|
orderSourceCode: string;
|
|
123
121
|
} & ({
|
|
124
122
|
externalOrderNumber: string;
|
|
@@ -131,7 +129,7 @@ export declare const useLabelWorkflow: ({ _multiplexedId, _labelId, }: {
|
|
|
131
129
|
} | {
|
|
132
130
|
oneOff: true;
|
|
133
131
|
}>>;
|
|
134
|
-
setShipmentId:
|
|
132
|
+
setShipmentId: import("react").Dispatch<import("react").SetStateAction<string | undefined>>;
|
|
135
133
|
shipmentId: string | undefined;
|
|
136
134
|
};
|
|
137
135
|
/**
|
|
@@ -139,17 +137,17 @@ export declare const useLabelWorkflow: ({ _multiplexedId, _labelId, }: {
|
|
|
139
137
|
*
|
|
140
138
|
* # Label Workflow Element
|
|
141
139
|
*
|
|
142
|
-
* - The `<
|
|
140
|
+
* - The `<PurchaseLabelWorkflow.Element />` component is a composition of the PurchaseLabel, ViewShipment,
|
|
143
141
|
* and VoidLabel elements that allows users to purchase a label, view the shipment details, and optionally void their shipping label.
|
|
144
142
|
*
|
|
145
|
-
* @param
|
|
143
|
+
* @param PurchaseLabelWorkflowProps The props necessary to render the `<PurchaseLabelWorkflow.Element />` for shipment
|
|
146
144
|
* based or sales order based label purchasing.
|
|
147
145
|
*
|
|
148
|
-
* @returns Element A React Element that will render the `<
|
|
146
|
+
* @returns Element A React Element that will render the `<PurchaseLabelWorkflow />` component.
|
|
149
147
|
*
|
|
150
148
|
* @example
|
|
151
149
|
* ```tsx
|
|
152
|
-
* <
|
|
150
|
+
* <PurchaseLabelWorkflow
|
|
153
151
|
* {...elementProps}
|
|
154
152
|
* callbacks={{ onLabelCreateSuccess }}
|
|
155
153
|
* multiplexedId={elementIdProps}
|
|
@@ -158,7 +156,7 @@ export declare const useLabelWorkflow: ({ _multiplexedId, _labelId, }: {
|
|
|
158
156
|
*
|
|
159
157
|
* <br />
|
|
160
158
|
*
|
|
161
|
-
* @see {@link
|
|
162
|
-
* @see {@link
|
|
159
|
+
* @see {@link PurchaseLabelWorkflowProps | The props that are passed into the `<PurchaseLabelWorkflow />` component}
|
|
160
|
+
* @see {@link PurchaseLabelWorkflow.usePurchaseLabelWorkflow | The `hook` that is used to manage the state of the `<PurchaseLabelWorkflow />` component}
|
|
163
161
|
*/
|
|
164
|
-
export declare const Element: ({ multiplexedId: _multiplexedId, labelId: _labelId, features: propFeatures, callbacks, }:
|
|
162
|
+
export declare const Element: ({ multiplexedId: _multiplexedId, labelId: _labelId, features: propFeatures, callbacks, }: PurchaseLabelWorkflowProps) => import("@emotion/react/jsx-runtime").JSX.Element;
|
|
@@ -1,5 +0,0 @@
|
|
|
1
|
-
import { SE } from "@shipengine/alchemy";
|
|
2
|
-
export type LabelLayoutPurchaseProps = {
|
|
3
|
-
onChange: (layout: SE.LabelLayout) => void;
|
|
4
|
-
};
|
|
5
|
-
export declare const LabelLayoutPurchase: ({ onChange }: LabelLayoutPurchaseProps) => import("@emotion/react/jsx-runtime").JSX.Element;
|
|
@@ -1,7 +0,0 @@
|
|
|
1
|
-
import { SE } from "@shipengine/alchemy";
|
|
2
|
-
export type LabelLayoutSettingsProps = {
|
|
3
|
-
errors: SE.CodedError[] | null;
|
|
4
|
-
isSaving: boolean;
|
|
5
|
-
onChange: (layout: SE.LabelLayout) => void;
|
|
6
|
-
};
|
|
7
|
-
export declare const LabelLayoutSettings: ({ errors, isSaving, onChange }: LabelLayoutSettingsProps) => import("@emotion/react/jsx-runtime").JSX.Element;
|
|
@@ -1,9 +0,0 @@
|
|
|
1
|
-
export type LabelLayoutProps = {
|
|
2
|
-
display: "settings" | "purchase";
|
|
3
|
-
};
|
|
4
|
-
/**
|
|
5
|
-
* @namespace LabelLayout
|
|
6
|
-
*
|
|
7
|
-
* # Label Layout Component
|
|
8
|
-
*/
|
|
9
|
-
export declare const LabelLayout: ({ display }: LabelLayoutProps) => import("@emotion/react/jsx-runtime").JSX.Element;
|
|
@@ -1,35 +0,0 @@
|
|
|
1
|
-
import { SE } from "@shipengine/alchemy";
|
|
2
|
-
/**
|
|
3
|
-
# Manage Funding Props
|
|
4
|
-
*
|
|
5
|
-
* - These are the base props that will be passed into the `<ManageFunding />` component.
|
|
6
|
-
*
|
|
7
|
-
* @see {@link ManageFunding | The `<ManageFunding />` component}
|
|
8
|
-
*/
|
|
9
|
-
export type ManageFundingProps = {
|
|
10
|
-
/**
|
|
11
|
-
* `carrierId` is the unique identifier for the carrier provider you wish to manage funding for.
|
|
12
|
-
*/
|
|
13
|
-
carrierId: string;
|
|
14
|
-
/**
|
|
15
|
-
* Currency to be used for the input's placeholders
|
|
16
|
-
*/
|
|
17
|
-
currency: SE.Currency;
|
|
18
|
-
};
|
|
19
|
-
/**
|
|
20
|
-
* @namespace ManageFunding
|
|
21
|
-
*
|
|
22
|
-
* # Manage Funding Component
|
|
23
|
-
*
|
|
24
|
-
* - The `<ManageFunding />` component is used to manage funding rules and add funds to a carrier
|
|
25
|
-
* account, and is composed in the `<AccountSettings />` component.
|
|
26
|
-
*
|
|
27
|
-
* @param ManageFundingProps The base props that will be passed into the `<ManageFunding />` component.
|
|
28
|
-
*
|
|
29
|
-
* @returns Element A React element that renders the `<ManageFunding />` component allowing users
|
|
30
|
-
* manage funding rules and add funds to their carrier accounts.
|
|
31
|
-
*
|
|
32
|
-
* @see {@link ManageFundingProps | The props that are passed into the `<ManageFunding />` component}
|
|
33
|
-
* @see {@link AccountSettings.Element | The `<AccountSettings />` component renders the `<ManageFunding />` component}
|
|
34
|
-
*/
|
|
35
|
-
export declare const ManageFunding: ({ carrierId, currency }: ManageFundingProps) => import("@emotion/react/jsx-runtime").JSX.Element;
|
|
@@ -1,10 +0,0 @@
|
|
|
1
|
-
import { SE } from "@shipengine/alchemy";
|
|
2
|
-
import { ConnectCarrierFeatures } from "../../../elements/connect-carrier/connect-carrier";
|
|
3
|
-
import { ListCarriersFeatures } from "../list-carriers";
|
|
4
|
-
export type AccountSettingsFeatures = ListCarriersFeatures & ConnectCarrierFeatures;
|
|
5
|
-
export type AccountSettingsProps = {
|
|
6
|
-
carriers?: SE.Carrier[];
|
|
7
|
-
currency: SE.Currency;
|
|
8
|
-
features?: AccountSettingsFeatures;
|
|
9
|
-
};
|
|
10
|
-
export declare const AccountSettings: ({ features, carriers, currency, ...rest }: AccountSettingsProps) => import("@emotion/react/jsx-runtime").JSX.Element;
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export * from "./account-settings";
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export * from "./list-carriers";
|
|
@@ -1,16 +0,0 @@
|
|
|
1
|
-
import { CarrierConnection, CodedError } from "@shipengine/alchemy";
|
|
2
|
-
import { ConnectedCarrierMetadata } from "../../../elements/list-carriers/hooks/use-list-connected-carriers";
|
|
3
|
-
export type ListCarriersFeatures = {
|
|
4
|
-
carriers: {
|
|
5
|
-
enabledCarriers: ("stamps_com" | "ups_walleted" | "ups" | "dhl_express_walleted" | "dhl_express_worldwide" | "hermes" | "yodel_walleted" | "dpdwallet")[];
|
|
6
|
-
};
|
|
7
|
-
};
|
|
8
|
-
export type ListCarriersProps = {
|
|
9
|
-
carriers?: ConnectedCarrierMetadata[];
|
|
10
|
-
errors?: CodedError[] | null;
|
|
11
|
-
features?: ListCarriersFeatures;
|
|
12
|
-
isLoading?: boolean;
|
|
13
|
-
onRegisterCarrier: (payload: CarrierConnection) => Promise<void>;
|
|
14
|
-
registerCarrierErrors?: CodedError[] | null;
|
|
15
|
-
};
|
|
16
|
-
export declare const ListCarriers: ({ carriers, errors, features, isLoading, onRegisterCarrier, registerCarrierErrors, }: ListCarriersProps) => import("@emotion/react/jsx-runtime").JSX.Element;
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export * from "./list-carriers-row";
|
|
@@ -1,9 +0,0 @@
|
|
|
1
|
-
import { CodedError } from "@shipengine/alchemy";
|
|
2
|
-
import { ConnectedCarrierMetadata } from "../../../elements/list-carriers/hooks/use-list-connected-carriers";
|
|
3
|
-
import { AddCarrierFormPayload } from "../add-carrier-form";
|
|
4
|
-
export type ListCarriersRowProps = {
|
|
5
|
-
connectedCarrier: ConnectedCarrierMetadata;
|
|
6
|
-
registerCarrier: (payload?: AddCarrierFormPayload) => Promise<void>;
|
|
7
|
-
registerCarrierErrors?: CodedError[] | null;
|
|
8
|
-
};
|
|
9
|
-
export declare const ListCarriersRow: ({ connectedCarrier: { carrier, isConnected }, registerCarrier, registerCarrierErrors, }: ListCarriersRowProps) => import("@emotion/react/jsx-runtime").JSX.Element;
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export * from "./manage-warehouses";
|
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
import { SE } from "@shipengine/alchemy";
|
|
2
|
-
export type WarehousePayload = Partial<SE.Warehouse> & Pick<SE.Warehouse, "name" | "originAddress" | "isDefault">;
|
|
3
|
-
export type ManageWarehousesProps = {
|
|
4
|
-
errors?: SE.CodedError[];
|
|
5
|
-
onAdd: (payload: WarehousePayload) => Promise<void>;
|
|
6
|
-
onDelete: (warehouseId: string) => Promise<void>;
|
|
7
|
-
onEdit: (payload: WarehousePayload, warehouseId: string) => Promise<void>;
|
|
8
|
-
onSetDefault: (warehouse: Partial<SE.Warehouse>, warehouseId: string) => Promise<void>;
|
|
9
|
-
warehouses: SE.Warehouse[];
|
|
10
|
-
};
|
|
11
|
-
export declare const ManageWarehouses: ({ errors, onAdd, onDelete, onEdit, onSetDefault, warehouses, }: ManageWarehousesProps) => import("@emotion/react/jsx-runtime").JSX.Element;
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export * from "./unit-settings";
|
|
@@ -1,8 +0,0 @@
|
|
|
1
|
-
export * from "./use-address";
|
|
2
|
-
export * from "./use-customs";
|
|
3
|
-
export * from "./use-presets";
|
|
4
|
-
export * from "./use-rates-form";
|
|
5
|
-
export * from "./use-shipment-form";
|
|
6
|
-
export * from "./use-rates-with-cache";
|
|
7
|
-
export * from "./use-request-rates";
|
|
8
|
-
export * from "./use-request-preferred-rates";
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export * from "./configure-shipment";
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export * as ListCarriers from "./list-carriers";
|
|
@@ -1,36 +0,0 @@
|
|
|
1
|
-
import { ListCarriersFeatures } from "../../components/templates/list-carriers";
|
|
2
|
-
/**
|
|
3
|
-
* # List-Carriers Props
|
|
4
|
-
*
|
|
5
|
-
* @see {@link ListCarriers.Component | The `<List-Carriers />` component}
|
|
6
|
-
*/
|
|
7
|
-
export type ComponentProps = {
|
|
8
|
-
/**
|
|
9
|
-
* `features` is a set of feature flags you would like to enable or disable in this component.
|
|
10
|
-
*/
|
|
11
|
-
features?: ListCarriersFeatures;
|
|
12
|
-
};
|
|
13
|
-
/**
|
|
14
|
-
* # List-Carriers Component
|
|
15
|
-
*
|
|
16
|
-
* @param ComponentProps The base props that will be passed into the `<List-Carriers />` component.
|
|
17
|
-
*
|
|
18
|
-
* @returns Element A React element that renders the `<List-Carriers />` component allowing users
|
|
19
|
-
* to view a list of carriers that are connected to their ShipEngine account. This component is
|
|
20
|
-
* composed in the `<AccountSettings />` Element.
|
|
21
|
-
*
|
|
22
|
-
* @example
|
|
23
|
-
* ```tsx
|
|
24
|
-
* (() => {
|
|
25
|
-
* const features = useFeatures("Global");
|
|
26
|
-
*
|
|
27
|
-
* return <ListCarriers.Component features={features} />;
|
|
28
|
-
* })();
|
|
29
|
-
* ```
|
|
30
|
-
*
|
|
31
|
-
* <br />
|
|
32
|
-
*
|
|
33
|
-
* @see {@link ListCarriers.ComponentProps | The props that are passed into the `<List-Carriers />` component}
|
|
34
|
-
* @see {@link AccountSettings.Element | The `<AccountSettings />` component renders the `<List-Carriers />` component}
|
|
35
|
-
*/
|
|
36
|
-
export declare const Component: ({ features }: ComponentProps) => import("@emotion/react/jsx-runtime").JSX.Element;
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export * as LabelWorkflow from "./label-workflow";
|
|
@@ -1,10 +0,0 @@
|
|
|
1
|
-
import { CarrierConnection } from "@shipengine/alchemy";
|
|
2
|
-
import { CarrierMetadata } from "../types";
|
|
3
|
-
/**
|
|
4
|
-
* @internal
|
|
5
|
-
*
|
|
6
|
-
* # Carrier Metadata Hook
|
|
7
|
-
*
|
|
8
|
-
* @category Hooks
|
|
9
|
-
*/
|
|
10
|
-
export declare const useCarrierMetadata: (carrierCodes?: CarrierConnection["carrierCode"][]) => CarrierMetadata[];
|
/package/src/components/{templates/edit-billing-form → edit-billing-form}/edit-billing-form.d.ts
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
/package/src/components/{templates/warehouse-form → warehouse-form}/warehouse-form-schema.d.ts
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
/package/src/{components/templates → features}/manage-warehouses/manage-warehouse.styles.d.ts
RENAMED
|
File without changes
|
/package/src/{components/templates → features/manage-warehouses}/warehouse-display/index.d.ts
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|