@shipengine/elements 1.6.0 → 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.
Files changed (61) hide show
  1. package/index.cjs +1286 -1130
  2. package/index.js +1283 -1130
  3. package/package.json +1 -1
  4. package/src/components/collapsible-panel/collapsible-panel.d.ts +6 -1
  5. package/src/components/collapsible-panel/collapsible-panel.styles.d.ts +1 -1
  6. package/src/components/field/rate-card/cost-breakdown/cost-breakdown.d.ts +1 -1
  7. package/src/components/templates/address-form/address-schema.d.ts +2 -0
  8. package/src/components/templates/index.d.ts +1 -1
  9. package/src/components/templates/rate-form/rate-form.d.ts +2 -1
  10. package/src/components/templates/wallet-form/wallet-schema.d.ts +46 -2
  11. package/src/elements/external-carriers/external-carriers.d.ts +7 -5
  12. package/src/elements/index.d.ts +2 -1
  13. package/src/elements/label-layout/label-layout-element.d.ts +7 -1
  14. package/src/elements/labels-grid/labels-grid.d.ts +7 -1
  15. package/src/elements/manage-funding/manage-funding-element.d.ts +7 -1
  16. package/src/elements/manage-warehouses/manage-warehouses.d.ts +10 -44
  17. package/src/elements/payment-method-settings/payment-method-settings-element.d.ts +7 -1
  18. package/src/elements/purchase-label/purchase-label.d.ts +11 -5
  19. package/src/elements/shipengine-carriers/index.d.ts +1 -0
  20. package/src/elements/{list-carriers/list-carriers.d.ts → shipengine-carriers/shipengine-carriers.d.ts} +46 -37
  21. package/src/elements/shipments-grid/shipments-grid.d.ts +7 -1
  22. package/src/elements/theme-creator/theme-creator.d.ts +7 -1
  23. package/src/elements/unit-settings/unit-settings-element.d.ts +7 -1
  24. package/src/elements/view-shipment/view-shipment.d.ts +17 -13
  25. package/src/elements/void-label/void-label.d.ts +16 -11
  26. package/src/elements/wallet-history/wallet-history-element.d.ts +7 -1
  27. package/src/features/index.d.ts +1 -1
  28. package/src/features/label-layout/label-layout.d.ts +6 -1
  29. package/src/features/label-layout/use-label-layout.d.ts +3 -3
  30. package/src/features/manage-warehouses/index.d.ts +1 -0
  31. package/src/features/manage-warehouses/manage-warehouses.d.ts +16 -1
  32. package/src/features/manage-warehouses/use-manage-warehouses.d.ts +15 -0
  33. package/src/features/shipengine-carriers/hooks/use-carrier-metadata.d.ts +13 -0
  34. package/src/features/shipengine-carriers/index.d.ts +1 -0
  35. package/src/features/shipengine-carriers/shipengine-carriers-row/index.d.ts +1 -0
  36. package/src/features/{list-carriers/list-carriers-row/list-carriers-row.d.ts → shipengine-carriers/shipengine-carriers-row/shipengine-carriers-row.d.ts} +2 -2
  37. package/src/features/shipengine-carriers/shipengine-carriers.d.ts +10 -0
  38. package/src/features/unit-settings/index.d.ts +1 -0
  39. package/src/features/unit-settings/unit-settings.d.ts +9 -1
  40. package/src/features/unit-settings/use-unit-settings.d.ts +10 -0
  41. package/src/locales/en/index.d.ts +7 -1
  42. package/src/types/carrier-metadata.d.ts +3 -0
  43. package/src/utilities/feature-flags.d.ts +5 -2
  44. package/src/workflows/account-settings/account-settings.d.ts +14 -11
  45. package/src/workflows/account-settings/use-get-panel-props.d.ts +7 -1
  46. package/src/workflows/connect-carrier/connect-carrier.d.ts +7 -1
  47. package/src/workflows/manage-wallet-workflow/index.d.ts +1 -0
  48. package/src/workflows/manage-wallet-workflow/manage-wallet-workflow.d.ts +828 -0
  49. package/src/workflows/manage-wallet-workflow/use-get-wallet-panel-props.d.ts +4 -0
  50. package/src/workflows/onboarding/components/onboarding-wizard/onboarding-wizard.d.ts +2 -2
  51. package/src/workflows/onboarding/components/terms-agreement-form/terms-agreement-form.d.ts +2 -1
  52. package/src/workflows/onboarding/onboarding.d.ts +11 -6
  53. package/src/elements/list-carriers/index.d.ts +0 -1
  54. package/src/features/list-carriers/hooks/use-carrier-metadata.d.ts +0 -10
  55. package/src/features/list-carriers/index.d.ts +0 -1
  56. package/src/features/list-carriers/list-carriers-row/index.d.ts +0 -1
  57. package/src/features/list-carriers/list-carriers.d.ts +0 -9
  58. /package/src/features/{list-carriers → shipengine-carriers}/hooks/index.d.ts +0 -0
  59. /package/src/features/{list-carriers → shipengine-carriers}/hooks/use-list-connected-carriers.d.ts +0 -0
  60. /package/src/features/{list-carriers/list-carriers-row/list-carriers-row.styles.d.ts → shipengine-carriers/shipengine-carriers-row/shipengine-carriers-row.styles.d.ts} +0 -0
  61. /package/src/features/{list-carriers/list-carriers.styles.d.ts → shipengine-carriers/shipengine-carriers.styles.d.ts} +0 -0
@@ -0,0 +1,4 @@
1
+ import { CollapsiblePanelProps } from "../../components";
2
+ export declare const useGetWalletPanelProps: () => {
3
+ getWalletPanelProps: (setting: string) => CollapsiblePanelProps;
4
+ };
@@ -1,5 +1,5 @@
1
1
  import { SE } from "@shipengine/alchemy";
2
- import { ListCarriersFeatures } from "../../../../features";
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 = ListCarriersFeatures & {
16
+ export type OnboardingWizardFeatures = ShipEngineCarriersFeatures & {
17
17
  presentation: {
18
18
  poweredByShipEngine?: boolean;
19
19
  };
@@ -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
- * onCompleteOnboarding={() => console.log('Onboarding Complete!')}
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; /** The partner responsible for the currently onboarding seller. This is typically the name of the entity that owns the host application. */
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; /** The partner responsible for the currently onboarding seller. This is typically the name of the entity that owns the host application. */
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;
@@ -367,6 +368,8 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
367
368
  aHR0cHM6Ly93d3cuc2hpcHN0YXRpb24uY29tL3Rlcm1zLXNlcnZpY2UtdW5pdGVkLWtpbmdkb20v: string;
368
369
  "aHR0cHM6Ly93d3cuZHBkLmNvLnVrL3N0YW5kYXJkX3Rlcm1zX2FuZF9jb25kaXRpb25zLmpzcA==": string;
369
370
  aHR0cHM6Ly93d3cuZ29nbG9iYWxwb3N0LmNvbS9jb25kaXRpb25z: string;
371
+ aHR0cHM6Ly93d3cucHVyb2xhdG9yLmNvbS9mci9tb2RhbGl0ZXMtZXQtY29uZGl0aW9ucy1kZS1zZXJ2aWNl: string;
372
+ aHR0cHM6Ly93d3cucHVyb2xhdG9yLmNvbS9lbi90ZXJtcy1hbmQtY29uZGl0aW9ucy1zZXJ2aWNl: string;
370
373
  };
371
374
  termsAndAgreementTitles: {
372
375
  "WW9kZWwgRGlyZWN0IC0gVGVybXMgYW5kIENvbmRpdGlvbnMgKOKAnFRlcm1z4oCdKQ==": string;
@@ -374,6 +377,8 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
374
377
  "VGVybXMgb2YgU2VydmljZSBVbml0ZWQgS2luZ2RvbQ==": string;
375
378
  RFBEIFN0YW5kYXJkIFRlcm1zIGFuZCBDb25kaXRpb25z: string;
376
379
  "R2xvYmFsUG9zdCBUZXJtcyBhbmQgQ29uZGl0aW9ucw==": string;
380
+ "UHVyb2xhdG9yIFRlcm1zIGFuZCBDb25kaXRpb25zIG9mIFNlcnZpY2U=": string;
381
+ UHVyb2xhdG9yIE1vZGFsaXTDqXMgZXQgY29uZGl0aW9ucyBkZSBzZXJ2aWNl: string;
377
382
  };
378
383
  };
379
384
  "manage-defaults": {
@@ -515,7 +520,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
515
520
  };
516
521
  };
517
522
  };
518
- "list-carriers": {
523
+ "shipengine-carriers": {
519
524
  title: string;
520
525
  headers: {
521
526
  accountCarriers: string;
@@ -1 +0,0 @@
1
- export * as ListCarriers from "./list-carriers";
@@ -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[];
@@ -1 +0,0 @@
1
- export * from "./list-carriers";
@@ -1 +0,0 @@
1
- export * from "./list-carriers-row";
@@ -1,9 +0,0 @@
1
- export type ListCarriersFeatures = {
2
- carriers: {
3
- enabledCarriers: ("stamps_com" | "ups_walleted" | "ups" | "dhl_express_walleted" | "dhl_express_worldwide" | "hermes" | "yodel_walleted" | "dpdwallet" | "globalpost")[];
4
- };
5
- };
6
- export type ListCarriersProps = {
7
- features?: ListCarriersFeatures;
8
- };
9
- export declare const ListCarriers: ({ features, }: ListCarriersProps) => import("@emotion/react/jsx-runtime").JSX.Element;