@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
@@ -36,6 +36,7 @@ export declare const Element: ({ resources, ...props }: object & {
36
36
  resultMessages: {
37
37
  approved: string;
38
38
  rejected: string;
39
+ dpdwallet: string;
39
40
  };
40
41
  refund_process: string;
41
42
  refund_rules: string;
@@ -77,6 +78,38 @@ export declare const Element: ({ resources, ...props }: object & {
77
78
  };
78
79
  noLabels: string;
79
80
  };
81
+ "vat-settings": {
82
+ addNew: string;
83
+ vatNumber: string;
84
+ vatRegistrationTooltip: string;
85
+ vatFormText: string;
86
+ vatFormRegisterLater: string;
87
+ vatNumberInputHint: string;
88
+ vatNumberInputPlaceholder: string;
89
+ verifiedVat: string;
90
+ vatFormErrors: {
91
+ invalidFieldValue: string;
92
+ verificationFailure: string;
93
+ forbidden: string;
94
+ connectionNotSupported: string;
95
+ genericTitle: string;
96
+ genericText: string;
97
+ };
98
+ };
99
+ "shipengine-carriers": {
100
+ title: string;
101
+ headers: {
102
+ accountCarriers: string;
103
+ carriers: string;
104
+ settings: string;
105
+ };
106
+ actions: {
107
+ status: {
108
+ connected: string;
109
+ notConnected: string;
110
+ };
111
+ };
112
+ };
80
113
  "register-wallet": {
81
114
  sections: {
82
115
  setup: {
@@ -92,6 +125,9 @@ export declare const Element: ({ resources, ...props }: object & {
92
125
  addressSubTitle: string;
93
126
  info: string;
94
127
  };
128
+ vatSettings: {
129
+ title: string;
130
+ };
95
131
  carriers: {
96
132
  title: string;
97
133
  subtitle: string;
@@ -218,6 +254,7 @@ export declare const Element: ({ resources, ...props }: object & {
218
254
  rateSavings: string;
219
255
  upsGroundSaverTermsAcknowledgement: string;
220
256
  dhlExpressTermsAcknowledgement: string;
257
+ noRateService: string;
221
258
  };
222
259
  requirements: {
223
260
  noWarehouse: string;
@@ -284,6 +321,8 @@ export declare const Element: ({ resources, ...props }: object & {
284
321
  action: string;
285
322
  };
286
323
  termsAndAgreementLinkText: {
324
+ shipEngineToS: string;
325
+ auctanePrivacyPolicy: string;
287
326
  aHR0cHM6Ly9teWRobC5leHByZXNzLmRobC91cy9lbi9sZWdhbC90ZXJtcy1hbmQtY29uZGl0aW9ucy5odG1s: string;
288
327
  "aHR0cHM6Ly93d3cuc3RhbXBzLmNvbS9wcml2YWN5LXBvbGljeQ==": string;
289
328
  "aHR0cHM6Ly93d3cuc3RhbXBzLmNvbS9jb25kaXRpb25zLw==": string;
@@ -308,42 +347,6 @@ export declare const Element: ({ resources, ...props }: object & {
308
347
  UHVyb2xhdG9yIE1vZGFsaXTDqXMgZXQgY29uZGl0aW9ucyBkZSBzZXJ2aWNl: string;
309
348
  };
310
349
  };
311
- "manage-defaults": {
312
- label: {
313
- title: string;
314
- letter: {
315
- title: string;
316
- description: string;
317
- };
318
- purchase: {
319
- title: string;
320
- description: string;
321
- };
322
- thermal: {
323
- title: string;
324
- description: string;
325
- };
326
- };
327
- status: {
328
- saving: string;
329
- saved: string;
330
- savingFailed: string;
331
- };
332
- units: {
333
- title: string;
334
- dimensions: {
335
- title: string;
336
- standard: string;
337
- metric: string;
338
- };
339
- weight: {
340
- title: string;
341
- standard: string;
342
- g: string;
343
- kg: string;
344
- };
345
- };
346
- };
347
350
  "manage-warehouses": {
348
351
  title: string;
349
352
  addNew: string;
@@ -411,6 +414,42 @@ export declare const Element: ({ resources, ...props }: object & {
411
414
  currentBalance: string;
412
415
  maximumBalanceAmount: string;
413
416
  };
417
+ "manage-defaults": {
418
+ label: {
419
+ title: string;
420
+ letter: {
421
+ title: string;
422
+ description: string;
423
+ };
424
+ purchase: {
425
+ title: string;
426
+ description: string;
427
+ };
428
+ thermal: {
429
+ title: string;
430
+ description: string;
431
+ };
432
+ };
433
+ status: {
434
+ saving: string;
435
+ saved: string;
436
+ savingFailed: string;
437
+ };
438
+ units: {
439
+ title: string;
440
+ dimensions: {
441
+ title: string;
442
+ standard: string;
443
+ metric: string;
444
+ };
445
+ weight: {
446
+ title: string;
447
+ standard: string;
448
+ g: string;
449
+ kg: string;
450
+ };
451
+ };
452
+ };
414
453
  "list-shipments": {
415
454
  title: string;
416
455
  headers: {
@@ -441,18 +480,31 @@ export declare const Element: ({ resources, ...props }: object & {
441
480
  };
442
481
  };
443
482
  };
444
- "shipengine-carriers": {
445
- title: string;
446
- headers: {
447
- accountCarriers: string;
448
- carriers: string;
449
- settings: string;
450
- };
483
+ "connect-carrier": {
451
484
  actions: {
452
- status: {
453
- connected: string;
454
- notConnected: string;
455
- };
485
+ cancel: string;
486
+ carrierSettings: string;
487
+ connectCarriers: string;
488
+ disconnect: string;
489
+ disconnectCarrier: string;
490
+ };
491
+ noCarriersDescription: string;
492
+ registrationForm: {
493
+ error: string;
494
+ title: string;
495
+ betaWarning: string;
496
+ };
497
+ search: string;
498
+ settingsModal: {
499
+ closeDialog: string;
500
+ header: string;
501
+ };
502
+ status: {
503
+ connected: string;
504
+ };
505
+ disconnectDropdown: {
506
+ toastTitle: string;
507
+ toastBody: string;
456
508
  };
457
509
  };
458
510
  common: {
@@ -639,6 +691,7 @@ export declare const Element: ({ resources, ...props }: object & {
639
691
  accountSettings: string;
640
692
  carrier: string;
641
693
  carriers: string;
694
+ carrierServices: string;
642
695
  connectCarrierForm: string;
643
696
  connectingCarriers: string;
644
697
  creatingFundingSource: string;
@@ -741,33 +794,6 @@ export declare const Element: ({ resources, ...props }: object & {
741
794
  "QSBzaGlwcGluZyBjYXJyaWVyIGVycm9yIG9jY3VycmVkOiBNaXNzaW5nIG9yIGludmFsaWQgc2hpcCB0byBTdGF0ZVByb3ZpbmNlQ29kZQ==": string;
742
795
  "QSBzaGlwcGluZyBjYXJyaWVyIGVycm9yIG9jY3VycmVkOiBJbnZhbGlkIHNvbGQgdG8gc3RhdGUgcHJvdmluY2UgY29kZS4gVmFsaWQgbGVuZ3RoIGlzIDAgdG8gNSBhbHBoYW51bWVyaWM=": string;
743
796
  };
744
- "connect-carrier": {
745
- actions: {
746
- cancel: string;
747
- carrierSettings: string;
748
- connectCarriers: string;
749
- disconnect: string;
750
- disconnectCarrier: string;
751
- };
752
- noCarriersDescription: string;
753
- registrationForm: {
754
- error: string;
755
- title: string;
756
- betaWarning: string;
757
- };
758
- search: string;
759
- settingsModal: {
760
- closeDialog: string;
761
- header: string;
762
- };
763
- status: {
764
- connected: string;
765
- };
766
- disconnectDropdown: {
767
- toastTitle: string;
768
- toastBody: string;
769
- };
770
- };
771
797
  "account-settings": {
772
798
  messages: {
773
799
  noFundingSources: string;
@@ -783,6 +809,7 @@ export declare const Element: ({ resources, ...props }: object & {
783
809
  externalCarriers: string;
784
810
  labelLayout: string;
785
811
  unitSettings: string;
812
+ vatSettings: string;
786
813
  };
787
814
  };
788
815
  };
@@ -224,6 +224,7 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
224
224
  resultMessages: {
225
225
  approved: string;
226
226
  rejected: string;
227
+ dpdwallet: string;
227
228
  };
228
229
  refund_process: string;
229
230
  refund_rules: string;
@@ -265,6 +266,38 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
265
266
  };
266
267
  noLabels: string;
267
268
  };
269
+ "vat-settings": {
270
+ addNew: string;
271
+ vatNumber: string;
272
+ vatRegistrationTooltip: string;
273
+ vatFormText: string;
274
+ vatFormRegisterLater: string;
275
+ vatNumberInputHint: string;
276
+ vatNumberInputPlaceholder: string;
277
+ verifiedVat: string;
278
+ vatFormErrors: {
279
+ invalidFieldValue: string;
280
+ verificationFailure: string;
281
+ forbidden: string;
282
+ connectionNotSupported: string;
283
+ genericTitle: string;
284
+ genericText: string;
285
+ };
286
+ };
287
+ "shipengine-carriers": {
288
+ title: string;
289
+ headers: {
290
+ accountCarriers: string;
291
+ carriers: string;
292
+ settings: string;
293
+ };
294
+ actions: {
295
+ status: {
296
+ connected: string;
297
+ notConnected: string;
298
+ };
299
+ };
300
+ };
268
301
  "register-wallet": {
269
302
  sections: {
270
303
  setup: {
@@ -280,6 +313,17 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
280
313
  addressSubTitle: string;
281
314
  info: string;
282
315
  };
316
+ vatSettings: {
317
+ title: string;
318
+ };
319
+ /**
320
+ * # Purchase Label Component Props
321
+ *
322
+ * These are the shared props that will be passed into the `<PurchaseLabel.Element />`, and work
323
+ * for either shipment-based or sales order-based label purchasing.
324
+ *
325
+ * @see {@link PurchaseLabel.Element | This prop types usage in `<PurchaseLabel.Element />`}
326
+ */
283
327
  carriers: {
284
328
  title: string;
285
329
  subtitle: string;
@@ -417,6 +461,7 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
417
461
  rateSavings: string;
418
462
  upsGroundSaverTermsAcknowledgement: string;
419
463
  dhlExpressTermsAcknowledgement: string;
464
+ noRateService: string;
420
465
  };
421
466
  requirements: {
422
467
  noWarehouse: string;
@@ -483,6 +528,8 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
483
528
  action: string;
484
529
  };
485
530
  termsAndAgreementLinkText: {
531
+ shipEngineToS: string;
532
+ auctanePrivacyPolicy: string;
486
533
  aHR0cHM6Ly9teWRobC5leHByZXNzLmRobC91cy9lbi9sZWdhbC90ZXJtcy1hbmQtY29uZGl0aW9ucy5odG1s: string;
487
534
  "aHR0cHM6Ly93d3cuc3RhbXBzLmNvbS9wcml2YWN5LXBvbGljeQ==": string;
488
535
  "aHR0cHM6Ly93d3cuc3RhbXBzLmNvbS9jb25kaXRpb25zLw==": string;
@@ -499,7 +546,10 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
499
546
  };
500
547
  termsAndAgreementTitles: {
501
548
  "WW9kZWwgRGlyZWN0IC0gVGVybXMgYW5kIENvbmRpdGlvbnMgKOKAnFRlcm1z4oCdKQ==": string;
502
- "RXZyaSBTZW5kIFRlcm1zICYgQ29uZGl0aW9ucw==": string;
549
+ "RXZyaSBTZW5kIFRlcm1zICYgQ29uZGl0aW9ucw==": string; /**
550
+ * `onChangeShipmentFormMode` is an async/sync callback function that will be invoked each time
551
+ * the user toggles the `Shipment Form Mode` between `Browse Rates` and `Selected Rate`.
552
+ */
503
553
  "VGVybXMgb2YgU2VydmljZSBVbml0ZWQgS2luZ2RvbQ==": string;
504
554
  RFBEIFN0YW5kYXJkIFRlcm1zIGFuZCBDb25kaXRpb25z: string;
505
555
  "R2xvYmFsUG9zdCBUZXJtcyBhbmQgQ29uZGl0aW9ucw==": string;
@@ -507,42 +557,6 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
507
557
  UHVyb2xhdG9yIE1vZGFsaXTDqXMgZXQgY29uZGl0aW9ucyBkZSBzZXJ2aWNl: string;
508
558
  };
509
559
  };
510
- "manage-defaults": {
511
- label: {
512
- title: string;
513
- letter: {
514
- title: string;
515
- description: string;
516
- };
517
- purchase: {
518
- title: string;
519
- description: string;
520
- };
521
- thermal: {
522
- title: string;
523
- description: string;
524
- };
525
- };
526
- status: {
527
- saving: string;
528
- saved: string;
529
- savingFailed: string;
530
- };
531
- units: {
532
- title: string;
533
- dimensions: {
534
- title: string;
535
- standard: string;
536
- metric: string;
537
- };
538
- weight: {
539
- title: string;
540
- standard: string;
541
- g: string;
542
- kg: string;
543
- };
544
- };
545
- };
546
560
  "manage-warehouses": {
547
561
  title: string;
548
562
  addNew: string;
@@ -610,6 +624,42 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
610
624
  currentBalance: string;
611
625
  maximumBalanceAmount: string;
612
626
  };
627
+ "manage-defaults": {
628
+ label: {
629
+ title: string;
630
+ letter: {
631
+ title: string;
632
+ description: string;
633
+ };
634
+ purchase: {
635
+ title: string;
636
+ description: string;
637
+ };
638
+ thermal: {
639
+ title: string;
640
+ description: string;
641
+ };
642
+ };
643
+ status: {
644
+ saving: string;
645
+ saved: string;
646
+ savingFailed: string;
647
+ };
648
+ units: {
649
+ title: string;
650
+ dimensions: {
651
+ title: string;
652
+ standard: string;
653
+ metric: string;
654
+ };
655
+ weight: {
656
+ title: string;
657
+ standard: string;
658
+ g: string;
659
+ kg: string;
660
+ };
661
+ };
662
+ };
613
663
  "list-shipments": {
614
664
  title: string;
615
665
  headers: {
@@ -640,18 +690,31 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
640
690
  };
641
691
  };
642
692
  };
643
- "shipengine-carriers": {
644
- title: string;
645
- headers: {
646
- accountCarriers: string;
647
- carriers: string;
648
- settings: string;
649
- };
693
+ "connect-carrier": {
650
694
  actions: {
651
- status: {
652
- connected: string;
653
- notConnected: string;
654
- };
695
+ cancel: string;
696
+ carrierSettings: string;
697
+ connectCarriers: string;
698
+ disconnect: string;
699
+ disconnectCarrier: string;
700
+ };
701
+ noCarriersDescription: string;
702
+ registrationForm: {
703
+ error: string;
704
+ title: string;
705
+ betaWarning: string;
706
+ };
707
+ search: string;
708
+ settingsModal: {
709
+ closeDialog: string;
710
+ header: string;
711
+ };
712
+ status: {
713
+ connected: string;
714
+ };
715
+ disconnectDropdown: {
716
+ toastTitle: string;
717
+ toastBody: string;
655
718
  };
656
719
  };
657
720
  common: {
@@ -775,7 +838,10 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
775
838
  };
776
839
  fields: {
777
840
  contentsType: string;
778
- countryOfOrigin: string;
841
+ countryOfOrigin: string; /**
842
+ * `onRateSaved` is an async/sync callback function that will be invoked each time a rate is
843
+ * saved by the user when rate shopping in the host application.
844
+ */
779
845
  description: string;
780
846
  harmonizedTariffCode: string;
781
847
  ifDeliveryFails: string;
@@ -805,7 +871,10 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
805
871
  fundingSourceMetadata: string;
806
872
  label: string;
807
873
  labels: string;
808
- salesOrder: string;
874
+ salesOrder: string; /**
875
+ * `printLabelLayout` is a string that represents the label layout you would like to use when
876
+ * purchasing a label. e.g. `4x6`
877
+ */
809
878
  shipment: string;
810
879
  shipments: string;
811
880
  warehouses: string;
@@ -842,6 +911,7 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
842
911
  accountSettings: string;
843
912
  carrier: string;
844
913
  carriers: string;
914
+ carrierServices: string;
845
915
  connectCarrierForm: string;
846
916
  connectingCarriers: string;
847
917
  creatingFundingSource: string;
@@ -944,33 +1014,6 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
944
1014
  "QSBzaGlwcGluZyBjYXJyaWVyIGVycm9yIG9jY3VycmVkOiBNaXNzaW5nIG9yIGludmFsaWQgc2hpcCB0byBTdGF0ZVByb3ZpbmNlQ29kZQ==": string;
945
1015
  "QSBzaGlwcGluZyBjYXJyaWVyIGVycm9yIG9jY3VycmVkOiBJbnZhbGlkIHNvbGQgdG8gc3RhdGUgcHJvdmluY2UgY29kZS4gVmFsaWQgbGVuZ3RoIGlzIDAgdG8gNSBhbHBoYW51bWVyaWM=": string;
946
1016
  };
947
- "connect-carrier": {
948
- actions: {
949
- cancel: string;
950
- carrierSettings: string;
951
- connectCarriers: string;
952
- disconnect: string;
953
- disconnectCarrier: string;
954
- };
955
- noCarriersDescription: string;
956
- registrationForm: {
957
- error: string;
958
- title: string;
959
- betaWarning: string;
960
- };
961
- search: string;
962
- settingsModal: {
963
- closeDialog: string;
964
- header: string;
965
- };
966
- status: {
967
- connected: string;
968
- };
969
- disconnectDropdown: {
970
- toastTitle: string;
971
- toastBody: string;
972
- };
973
- };
974
1017
  "account-settings": {
975
1018
  messages: {
976
1019
  noFundingSources: string;
@@ -986,6 +1029,7 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
986
1029
  externalCarriers: string;
987
1030
  labelLayout: string;
988
1031
  unitSettings: string;
1032
+ vatSettings: string;
989
1033
  };
990
1034
  };
991
1035
  };