@shipengine/elements 1.7.0 → 1.8.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 (57) hide show
  1. package/index.cjs +15309 -14863
  2. package/index.js +15310 -14867
  3. package/package.json +3 -3
  4. package/src/components/collapsible-panel/collapsible-panel.styles.d.ts +2 -3
  5. package/src/components/display-term/display-term.d.ts +2 -2
  6. package/src/components/display-term/display-term.styles.d.ts +2 -0
  7. package/src/components/index.d.ts +6 -5
  8. package/src/components/templates/wallet-form/wallet-form.d.ts +3 -1
  9. package/src/components/templates/wallet-form/wallet-form.styles.d.ts +3 -0
  10. package/src/components/vat-form/index.d.ts +1 -0
  11. package/src/components/vat-form/vat-form-schema.d.ts +10 -0
  12. package/src/components/vat-form/vat-form.d.ts +6 -0
  13. package/src/components/vat-form/vat-form.styles.d.ts +9 -0
  14. package/src/elements/external-carriers/external-carriers.d.ts +124 -97
  15. package/src/elements/label-layout/label-layout-element.d.ts +101 -74
  16. package/src/elements/labels-grid/labels-grid.d.ts +101 -74
  17. package/src/elements/manage-funding/manage-funding-element.d.ts +101 -74
  18. package/src/elements/manage-warehouses/manage-warehouses.d.ts +101 -74
  19. package/src/elements/payment-method-settings/payment-method-settings-element.d.ts +101 -74
  20. package/src/elements/purchase-label/purchase-label.d.ts +121 -77
  21. package/src/elements/shipengine-carriers/shipengine-carriers.d.ts +124 -97
  22. package/src/elements/shipments-grid/shipments-grid.d.ts +101 -74
  23. package/src/elements/theme-creator/theme-creator.d.ts +101 -74
  24. package/src/elements/unit-settings/unit-settings-element.d.ts +101 -74
  25. package/src/elements/vat-settings/index.d.ts +1 -0
  26. package/src/elements/vat-settings/vat-settings-element.d.ts +818 -0
  27. package/src/elements/view-shipment/view-shipment.d.ts +111 -83
  28. package/src/elements/void-label/components/message/message.d.ts +3 -2
  29. package/src/elements/void-label/void-label.d.ts +128 -92
  30. package/src/elements/wallet-history/wallet-history-element.d.ts +101 -74
  31. package/src/features/index.d.ts +5 -4
  32. package/src/features/unit-settings/unit-settings.d.ts +2 -2
  33. package/src/features/unit-settings/use-unit-settings.d.ts +1 -1
  34. package/src/features/vat-settings/index.d.ts +2 -0
  35. package/src/features/vat-settings/use-vat-settings.d.ts +8 -0
  36. package/src/features/vat-settings/vat-settings.d.ts +9 -0
  37. package/src/features/vat-settings/vat-settings.styles.d.ts +29 -0
  38. package/src/hooks/index.d.ts +3 -3
  39. package/src/locales/en/index.d.ts +101 -74
  40. package/src/types/patch.d.ts +1 -12
  41. package/src/utilities/feature-flags.d.ts +10 -0
  42. package/src/utilities/shipengine/index.d.ts +1 -0
  43. package/src/utilities/shipengine/shipment.d.ts +11 -0
  44. package/src/workflows/account-settings/account-settings.d.ts +104 -79
  45. package/src/workflows/connect-carrier/connect-carrier.d.ts +101 -74
  46. package/src/workflows/manage-wallet-workflow/manage-wallet-workflow.d.ts +106 -78
  47. package/src/workflows/onboarding/components/account-registration-form/account-registration-form-schema.d.ts +3 -0
  48. package/src/workflows/onboarding/components/funding-and-carrier-connection-step/funding-and-carrier-connection-step.d.ts +3 -1
  49. package/src/workflows/onboarding/components/funding-and-carrier-connection-step/use-funding-and-carrier-connection-step.d.ts +2 -2
  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 +3 -4
  52. package/src/workflows/onboarding/components/terms-agreement-form/terms-agreement-form.styles.d.ts +6 -7
  53. package/src/workflows/onboarding/components/terms-agreement-step/terms-agreement-step.d.ts +3 -4
  54. package/src/workflows/onboarding/components/terms-agreement-step/terms-agreement-step.styles.d.ts +3 -0
  55. package/src/workflows/onboarding/components/terms-agreement-step/use-terms-agreement-step.d.ts +7 -7
  56. package/src/workflows/onboarding/onboarding.d.ts +101 -74
  57. package/vite.config.d.ts +1 -1
@@ -71,6 +71,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
71
71
  resultMessages: {
72
72
  approved: string;
73
73
  rejected: string;
74
+ dpdwallet: string;
74
75
  };
75
76
  refund_process: string;
76
77
  refund_rules: string;
@@ -112,6 +113,38 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
112
113
  };
113
114
  noLabels: string;
114
115
  };
116
+ "vat-settings": {
117
+ addNew: string;
118
+ vatNumber: string;
119
+ vatRegistrationTooltip: string;
120
+ vatFormText: string;
121
+ vatFormRegisterLater: string;
122
+ vatNumberInputHint: string;
123
+ vatNumberInputPlaceholder: string;
124
+ verifiedVat: string;
125
+ vatFormErrors: {
126
+ invalidFieldValue: string;
127
+ verificationFailure: string;
128
+ forbidden: string;
129
+ connectionNotSupported: string;
130
+ genericTitle: string;
131
+ genericText: string;
132
+ };
133
+ };
134
+ "shipengine-carriers": {
135
+ title: string;
136
+ headers: {
137
+ accountCarriers: string;
138
+ carriers: string;
139
+ settings: string;
140
+ };
141
+ actions: {
142
+ status: {
143
+ connected: string;
144
+ notConnected: string;
145
+ };
146
+ };
147
+ };
115
148
  "register-wallet": {
116
149
  sections: {
117
150
  setup: {
@@ -127,6 +160,9 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
127
160
  addressSubTitle: string;
128
161
  info: string;
129
162
  };
163
+ vatSettings: {
164
+ title: string;
165
+ };
130
166
  carriers: {
131
167
  title: string;
132
168
  subtitle: string;
@@ -253,6 +289,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
253
289
  rateSavings: string;
254
290
  upsGroundSaverTermsAcknowledgement: string;
255
291
  dhlExpressTermsAcknowledgement: string;
292
+ noRateService: string;
256
293
  };
257
294
  requirements: {
258
295
  noWarehouse: string;
@@ -319,6 +356,8 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
319
356
  action: string;
320
357
  };
321
358
  termsAndAgreementLinkText: {
359
+ shipEngineToS: string;
360
+ auctanePrivacyPolicy: string;
322
361
  aHR0cHM6Ly9teWRobC5leHByZXNzLmRobC91cy9lbi9sZWdhbC90ZXJtcy1hbmQtY29uZGl0aW9ucy5odG1s: string;
323
362
  "aHR0cHM6Ly93d3cuc3RhbXBzLmNvbS9wcml2YWN5LXBvbGljeQ==": string;
324
363
  "aHR0cHM6Ly93d3cuc3RhbXBzLmNvbS9jb25kaXRpb25zLw==": string;
@@ -343,42 +382,6 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
343
382
  UHVyb2xhdG9yIE1vZGFsaXTDqXMgZXQgY29uZGl0aW9ucyBkZSBzZXJ2aWNl: string;
344
383
  };
345
384
  };
346
- "manage-defaults": {
347
- label: {
348
- title: string;
349
- letter: {
350
- title: string;
351
- description: string;
352
- };
353
- purchase: {
354
- title: string;
355
- description: string;
356
- };
357
- thermal: {
358
- title: string;
359
- description: string;
360
- };
361
- };
362
- status: {
363
- saving: string;
364
- saved: string;
365
- savingFailed: string;
366
- };
367
- units: {
368
- title: string;
369
- dimensions: {
370
- title: string;
371
- standard: string;
372
- metric: string;
373
- };
374
- weight: {
375
- title: string;
376
- standard: string;
377
- g: string;
378
- kg: string;
379
- };
380
- };
381
- };
382
385
  "manage-warehouses": {
383
386
  title: string;
384
387
  addNew: string;
@@ -451,6 +454,42 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
451
454
  currentBalance: string;
452
455
  maximumBalanceAmount: string;
453
456
  };
457
+ "manage-defaults": {
458
+ label: {
459
+ title: string;
460
+ letter: {
461
+ title: string;
462
+ description: string;
463
+ };
464
+ purchase: {
465
+ title: string;
466
+ description: string;
467
+ };
468
+ thermal: {
469
+ title: string;
470
+ description: string;
471
+ };
472
+ };
473
+ status: {
474
+ saving: string;
475
+ saved: string;
476
+ savingFailed: string;
477
+ };
478
+ units: {
479
+ title: string;
480
+ dimensions: {
481
+ title: string;
482
+ standard: string;
483
+ metric: string;
484
+ };
485
+ weight: {
486
+ title: string;
487
+ standard: string;
488
+ g: string;
489
+ kg: string;
490
+ };
491
+ };
492
+ };
454
493
  "list-shipments": {
455
494
  title: string;
456
495
  headers: {
@@ -481,18 +520,54 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
481
520
  };
482
521
  };
483
522
  };
484
- "shipengine-carriers": {
485
- title: string;
486
- headers: {
487
- accountCarriers: string;
488
- carriers: string;
489
- settings: string;
490
- };
523
+ "connect-carrier": {
491
524
  actions: {
492
- status: {
493
- connected: string;
494
- notConnected: string;
495
- };
525
+ cancel: string;
526
+ carrierSettings: string;
527
+ connectCarriers: string;
528
+ disconnect: string;
529
+ disconnectCarrier: string;
530
+ };
531
+ noCarriersDescription: string;
532
+ registrationForm: {
533
+ error: string;
534
+ title: string;
535
+ /**
536
+ * # ShipEngine-Carriers Element
537
+ *
538
+ * @param ComponentProps The base props that will be passed into the `<ShipEngine-Carriers />` component.
539
+ *
540
+ * @returns Element A React element that renders the `<ShipEngine-Carriers />` component allowing users
541
+ * to view a list of carriers that are connected to their ShipEngine account. This component is
542
+ * composed in the `<AccountSettings />` Element.
543
+ *
544
+ * @example
545
+ * ```tsx
546
+ * (() => {
547
+ * const features = useFeatures("Global");
548
+ *
549
+ * return <ShipEngineCarriers.Element features={features} />;
550
+ * })();
551
+ * ```
552
+ *
553
+ * <br />
554
+ *
555
+ * @see {@link ShipEngineCarriers.ComponentProps | The props that are passed into the `<ShipEngine-Carriers />` component}
556
+ * @see {@link AccountSettings.Element | The `<AccountSettings />` component renders the `<ShipEngine-Carriers />` component}
557
+ */
558
+ betaWarning: string;
559
+ };
560
+ search: string;
561
+ settingsModal: {
562
+ closeDialog: string;
563
+ header: string;
564
+ };
565
+ status: {
566
+ connected: string;
567
+ };
568
+ disconnectDropdown: {
569
+ toastTitle: string;
570
+ toastBody: string;
496
571
  };
497
572
  };
498
573
  common: {
@@ -679,6 +754,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
679
754
  accountSettings: string;
680
755
  carrier: string;
681
756
  carriers: string;
757
+ carrierServices: string;
682
758
  connectCarrierForm: string;
683
759
  connectingCarriers: string;
684
760
  creatingFundingSource: string;
@@ -781,56 +857,6 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
781
857
  "QSBzaGlwcGluZyBjYXJyaWVyIGVycm9yIG9jY3VycmVkOiBNaXNzaW5nIG9yIGludmFsaWQgc2hpcCB0byBTdGF0ZVByb3ZpbmNlQ29kZQ==": string;
782
858
  "QSBzaGlwcGluZyBjYXJyaWVyIGVycm9yIG9jY3VycmVkOiBJbnZhbGlkIHNvbGQgdG8gc3RhdGUgcHJvdmluY2UgY29kZS4gVmFsaWQgbGVuZ3RoIGlzIDAgdG8gNSBhbHBoYW51bWVyaWM=": string;
783
859
  };
784
- "connect-carrier": {
785
- actions: {
786
- cancel: string;
787
- carrierSettings: string;
788
- connectCarriers: string;
789
- disconnect: string;
790
- disconnectCarrier: string;
791
- };
792
- noCarriersDescription: string;
793
- registrationForm: {
794
- error: string;
795
- title: string;
796
- /**
797
- * # ShipEngine-Carriers Element
798
- *
799
- * @param ComponentProps The base props that will be passed into the `<ShipEngine-Carriers />` component.
800
- *
801
- * @returns Element A React element that renders the `<ShipEngine-Carriers />` component allowing users
802
- * to view a list of carriers that are connected to their ShipEngine account. This component is
803
- * composed in the `<AccountSettings />` Element.
804
- *
805
- * @example
806
- * ```tsx
807
- * (() => {
808
- * const features = useFeatures("Global");
809
- *
810
- * return <ShipEngineCarriers.Element features={features} />;
811
- * })();
812
- * ```
813
- *
814
- * <br />
815
- *
816
- * @see {@link ShipEngineCarriers.ComponentProps | The props that are passed into the `<ShipEngine-Carriers />` component}
817
- * @see {@link AccountSettings.Element | The `<AccountSettings />` component renders the `<ShipEngine-Carriers />` component}
818
- */
819
- betaWarning: string;
820
- };
821
- search: string;
822
- settingsModal: {
823
- closeDialog: string;
824
- header: string;
825
- };
826
- status: {
827
- connected: string;
828
- };
829
- disconnectDropdown: {
830
- toastTitle: string;
831
- toastBody: string;
832
- };
833
- };
834
860
  "account-settings": {
835
861
  messages: {
836
862
  noFundingSources: string;
@@ -846,6 +872,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
846
872
  externalCarriers: string;
847
873
  labelLayout: string;
848
874
  unitSettings: string;
875
+ vatSettings: string;
849
876
  };
850
877
  };
851
878
  };
@@ -39,6 +39,7 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
39
39
  resultMessages: {
40
40
  approved: string;
41
41
  rejected: string;
42
+ dpdwallet: string;
42
43
  };
43
44
  refund_process: string;
44
45
  refund_rules: string;
@@ -80,6 +81,38 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
80
81
  };
81
82
  noLabels: string;
82
83
  };
84
+ "vat-settings": {
85
+ addNew: string;
86
+ vatNumber: string;
87
+ vatRegistrationTooltip: string;
88
+ vatFormText: string;
89
+ vatFormRegisterLater: string;
90
+ vatNumberInputHint: string;
91
+ vatNumberInputPlaceholder: string;
92
+ verifiedVat: string;
93
+ vatFormErrors: {
94
+ invalidFieldValue: string;
95
+ verificationFailure: string;
96
+ forbidden: string;
97
+ connectionNotSupported: string;
98
+ genericTitle: string;
99
+ genericText: string;
100
+ };
101
+ };
102
+ "shipengine-carriers": {
103
+ title: string;
104
+ headers: {
105
+ accountCarriers: string;
106
+ carriers: string;
107
+ settings: string;
108
+ };
109
+ actions: {
110
+ status: {
111
+ connected: string;
112
+ notConnected: string;
113
+ };
114
+ };
115
+ };
83
116
  "register-wallet": {
84
117
  sections: {
85
118
  setup: {
@@ -95,6 +128,9 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
95
128
  addressSubTitle: string;
96
129
  info: string;
97
130
  };
131
+ vatSettings: {
132
+ title: string;
133
+ };
98
134
  carriers: {
99
135
  title: string;
100
136
  subtitle: string;
@@ -221,6 +257,7 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
221
257
  rateSavings: string;
222
258
  upsGroundSaverTermsAcknowledgement: string;
223
259
  dhlExpressTermsAcknowledgement: string;
260
+ noRateService: string;
224
261
  };
225
262
  requirements: {
226
263
  noWarehouse: string;
@@ -287,6 +324,8 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
287
324
  action: string;
288
325
  };
289
326
  termsAndAgreementLinkText: {
327
+ shipEngineToS: string;
328
+ auctanePrivacyPolicy: string;
290
329
  aHR0cHM6Ly9teWRobC5leHByZXNzLmRobC91cy9lbi9sZWdhbC90ZXJtcy1hbmQtY29uZGl0aW9ucy5odG1s: string;
291
330
  "aHR0cHM6Ly93d3cuc3RhbXBzLmNvbS9wcml2YWN5LXBvbGljeQ==": string;
292
331
  "aHR0cHM6Ly93d3cuc3RhbXBzLmNvbS9jb25kaXRpb25zLw==": string;
@@ -311,42 +350,6 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
311
350
  UHVyb2xhdG9yIE1vZGFsaXTDqXMgZXQgY29uZGl0aW9ucyBkZSBzZXJ2aWNl: string;
312
351
  };
313
352
  };
314
- "manage-defaults": {
315
- label: {
316
- title: string;
317
- letter: {
318
- title: string;
319
- description: string;
320
- };
321
- purchase: {
322
- title: string;
323
- description: string;
324
- };
325
- thermal: {
326
- title: string;
327
- description: string;
328
- };
329
- };
330
- status: {
331
- saving: string;
332
- saved: string;
333
- savingFailed: string;
334
- };
335
- units: {
336
- title: string;
337
- dimensions: {
338
- title: string;
339
- standard: string;
340
- metric: string;
341
- };
342
- weight: {
343
- title: string;
344
- standard: string;
345
- g: string;
346
- kg: string;
347
- };
348
- };
349
- };
350
353
  "manage-warehouses": {
351
354
  title: string;
352
355
  addNew: string;
@@ -414,6 +417,42 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
414
417
  currentBalance: string;
415
418
  maximumBalanceAmount: string;
416
419
  };
420
+ "manage-defaults": {
421
+ label: {
422
+ title: string;
423
+ letter: {
424
+ title: string;
425
+ description: string;
426
+ };
427
+ purchase: {
428
+ title: string;
429
+ description: string;
430
+ };
431
+ thermal: {
432
+ title: string;
433
+ description: string;
434
+ };
435
+ };
436
+ status: {
437
+ saving: string;
438
+ saved: string;
439
+ savingFailed: string;
440
+ };
441
+ units: {
442
+ title: string;
443
+ dimensions: {
444
+ title: string;
445
+ standard: string;
446
+ metric: string;
447
+ };
448
+ weight: {
449
+ title: string;
450
+ standard: string;
451
+ g: string;
452
+ kg: string;
453
+ };
454
+ };
455
+ };
417
456
  "list-shipments": {
418
457
  title: string;
419
458
  headers: {
@@ -444,18 +483,31 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
444
483
  };
445
484
  };
446
485
  };
447
- "shipengine-carriers": {
448
- title: string;
449
- headers: {
450
- accountCarriers: string;
451
- carriers: string;
452
- settings: string;
453
- };
486
+ "connect-carrier": {
454
487
  actions: {
455
- status: {
456
- connected: string;
457
- notConnected: string;
458
- };
488
+ cancel: string;
489
+ carrierSettings: string;
490
+ connectCarriers: string;
491
+ disconnect: string;
492
+ disconnectCarrier: string;
493
+ };
494
+ noCarriersDescription: string;
495
+ registrationForm: {
496
+ error: string;
497
+ title: string;
498
+ betaWarning: string;
499
+ };
500
+ search: string;
501
+ settingsModal: {
502
+ closeDialog: string;
503
+ header: string;
504
+ };
505
+ status: {
506
+ connected: string;
507
+ };
508
+ disconnectDropdown: {
509
+ toastTitle: string;
510
+ toastBody: string;
459
511
  };
460
512
  };
461
513
  common: {
@@ -642,6 +694,7 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
642
694
  accountSettings: string;
643
695
  carrier: string;
644
696
  carriers: string;
697
+ carrierServices: string;
645
698
  connectCarrierForm: string;
646
699
  connectingCarriers: string;
647
700
  creatingFundingSource: string;
@@ -744,33 +797,6 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
744
797
  "QSBzaGlwcGluZyBjYXJyaWVyIGVycm9yIG9jY3VycmVkOiBNaXNzaW5nIG9yIGludmFsaWQgc2hpcCB0byBTdGF0ZVByb3ZpbmNlQ29kZQ==": string;
745
798
  "QSBzaGlwcGluZyBjYXJyaWVyIGVycm9yIG9jY3VycmVkOiBJbnZhbGlkIHNvbGQgdG8gc3RhdGUgcHJvdmluY2UgY29kZS4gVmFsaWQgbGVuZ3RoIGlzIDAgdG8gNSBhbHBoYW51bWVyaWM=": string;
746
799
  };
747
- "connect-carrier": {
748
- actions: {
749
- cancel: string;
750
- carrierSettings: string;
751
- connectCarriers: string;
752
- disconnect: string;
753
- disconnectCarrier: string;
754
- };
755
- noCarriersDescription: string;
756
- registrationForm: {
757
- error: string;
758
- title: string;
759
- betaWarning: string;
760
- };
761
- search: string;
762
- settingsModal: {
763
- closeDialog: string;
764
- header: string;
765
- };
766
- status: {
767
- connected: string;
768
- };
769
- disconnectDropdown: {
770
- toastTitle: string;
771
- toastBody: string;
772
- };
773
- };
774
800
  "account-settings": {
775
801
  messages: {
776
802
  noFundingSources: string;
@@ -786,6 +812,7 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
786
812
  externalCarriers: string;
787
813
  labelLayout: string;
788
814
  unitSettings: string;
815
+ vatSettings: string;
789
816
  };
790
817
  };
791
818
  };