@shipengine/elements 0.39.0 → 1.1.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 (102) hide show
  1. package/README.md +15 -0
  2. package/index.cjs +5604 -5930
  3. package/index.js +5601 -5934
  4. package/package.json +14 -13
  5. package/src/components/carrier-icon/carrier-icon.d.ts +13 -0
  6. package/src/components/carrier-icon/index.d.ts +1 -0
  7. package/src/components/carrier-logo/carrier-logo.d.ts +11 -0
  8. package/src/components/carrier-logo/index.d.ts +1 -0
  9. package/src/components/collapsible-panel/collapsible-panel.styles.d.ts +1 -1
  10. package/src/components/display-term/display-term.d.ts +5 -0
  11. package/src/components/display-term/display-term.styles.d.ts +23 -0
  12. package/src/components/display-term/index.d.ts +1 -0
  13. package/src/components/grid-controller/cell-formatted-date.d.ts +4 -0
  14. package/src/components/grid-controller/grid-controller.d.ts +22 -0
  15. package/src/components/grid-controller/grid-controller.styles.d.ts +61 -0
  16. package/src/components/grid-controller/hooks/use-grid.d.ts +43 -0
  17. package/src/components/grid-controller/index.d.ts +2 -0
  18. package/src/components/history/history-card-extension/history-card-extension.styles.d.ts +2 -2
  19. package/src/components/index.d.ts +4 -0
  20. package/src/components/label-layout/label-layout.styles.d.ts +8 -5
  21. package/src/components/loader/loader.styles.d.ts +11 -0
  22. package/src/components/powered-by-shipengine/powered-by-shipengine.styles.d.ts +2 -2
  23. package/src/components/save-status/save-status-styles.d.ts +4 -9
  24. package/src/components/section/section.d.ts +2 -2
  25. package/src/components/templates/connect-carrier/connect-carrier.d.ts +1 -0
  26. package/src/components/templates/connect-carrier/connect-carrier.styles.d.ts +1 -0
  27. package/src/components/templates/connect-carrier/index.d.ts +1 -0
  28. package/src/components/templates/connect-carrier-form/connect-carrier-form.d.ts +4 -0
  29. package/src/components/templates/connect-carrier-form/connect-carrier-form.styles.d.ts +60 -0
  30. package/src/components/templates/connect-carrier-form/index.d.ts +1 -0
  31. package/src/components/templates/display-carrier-terms/display-carrier-terms.d.ts +2 -2
  32. package/src/components/templates/display-carrier-terms/display-carrier-terms.styles.d.ts +25 -0
  33. package/src/components/templates/index.d.ts +2 -6
  34. package/src/components/templates/list-carriers/list-carriers.d.ts +2 -2
  35. package/src/components/templates/rate-form/rate-form.d.ts +2 -2
  36. package/src/components/templates/warehouse-form/warehouse-form.d.ts +2 -2
  37. package/src/elements/account-settings/account-settings.d.ts +47 -36
  38. package/src/elements/configure-shipment/hooks/use-rates-form.d.ts +1 -2
  39. package/src/elements/{onboarding/onboarding.d.ts → connect-carrier/connect-carrier.d.ts} +53 -112
  40. package/src/elements/connect-carrier/index.d.ts +1 -0
  41. package/src/elements/index.d.ts +0 -1
  42. package/src/elements/labels-grid/index.d.ts +1 -0
  43. package/src/elements/labels-grid/labels-grid.d.ts +687 -0
  44. package/src/elements/list-carriers/list-carriers.d.ts +2 -2
  45. package/src/elements/purchase-label/purchase-label.d.ts +57 -12
  46. package/src/elements/view-shipment/view-shipment.d.ts +51 -18
  47. package/src/elements/void-label/void-label.d.ts +52 -36
  48. package/src/features/wallet-history/wallet-history.styles.d.ts +2 -2
  49. package/src/index.d.ts +1 -0
  50. package/src/locales/en/index.d.ts +47 -7
  51. package/src/types/index.d.ts +1 -0
  52. package/src/types/patch.d.ts +13 -0
  53. package/src/utilities/assertions.d.ts +2 -0
  54. package/src/utilities/feature-flags.d.ts +1 -1
  55. package/src/utilities/index.d.ts +1 -0
  56. package/src/workflows/onboarding/components/account-registration-form/account-registration-form-schema.d.ts +10 -0
  57. package/src/workflows/onboarding/components/account-registration-form/account-registration-form.d.ts +4 -0
  58. package/src/workflows/onboarding/components/account-registration-form/index.d.ts +1 -0
  59. package/src/workflows/onboarding/components/account-registration-step/account-registration-step.d.ts +5 -0
  60. package/src/workflows/onboarding/components/account-registration-step/index.d.ts +2 -0
  61. package/src/workflows/onboarding/components/account-registration-step/use-account-registration-step.d.ts +7 -0
  62. package/src/workflows/onboarding/components/carrier-recovery-form/carrier-recovery-form-schema.d.ts +241 -0
  63. package/src/{components/templates → workflows/onboarding/components}/carrier-recovery-form/carrier-recovery-form.d.ts +4 -2
  64. package/src/workflows/onboarding/components/carrier-recovery-form/index.d.ts +1 -0
  65. package/src/workflows/onboarding/components/funding-and-carrier-connection-step/funding-and-carrier-connection-step.d.ts +9 -0
  66. package/src/{components/templates/onboarding/onboarding.styles.d.ts → workflows/onboarding/components/funding-and-carrier-connection-step/funding-and-carrier-connection-step.styles.d.ts} +1 -14
  67. package/src/workflows/onboarding/components/funding-and-carrier-connection-step/index.d.ts +2 -0
  68. package/src/workflows/onboarding/components/funding-and-carrier-connection-step/use-funding-and-carrier-connection-step.d.ts +25 -0
  69. package/src/workflows/onboarding/components/onboarding-wizard/index.d.ts +1 -0
  70. package/src/workflows/onboarding/components/onboarding-wizard/onboarding-wizard.d.ts +27 -0
  71. package/src/workflows/onboarding/components/onboarding-wizard/onboarding-wizard.styles.d.ts +10 -0
  72. package/src/workflows/onboarding/components/ship-from-address-step/index.d.ts +2 -0
  73. package/src/workflows/onboarding/components/ship-from-address-step/ship-from-address-step.d.ts +7 -0
  74. package/src/workflows/onboarding/components/ship-from-address-step/use-ship-from-address-step.d.ts +9 -0
  75. package/src/workflows/onboarding/components/step-header/index.d.ts +1 -0
  76. package/src/workflows/onboarding/components/step-header/step-header.d.ts +5 -0
  77. package/src/workflows/onboarding/components/terms-agreement-form/index.d.ts +1 -0
  78. package/src/workflows/onboarding/components/terms-agreement-form/terms-agreement-form-schema.d.ts +10 -0
  79. package/src/workflows/onboarding/components/terms-agreement-form/terms-agreement-form.d.ts +7 -0
  80. package/src/workflows/onboarding/components/terms-agreement-form/terms-agreement-form.styles.d.ts +24 -0
  81. package/src/workflows/onboarding/components/terms-agreement-step/index.d.ts +1 -0
  82. package/src/workflows/onboarding/components/terms-agreement-step/terms-agreement-step.d.ts +8 -0
  83. package/src/workflows/onboarding/components/terms-agreement-step/terms-agreement-step.styles.d.ts +17 -0
  84. package/src/workflows/onboarding/components/terms-agreement-step/use-terms-agreement-step.d.ts +18 -0
  85. package/src/workflows/onboarding/onboarding.d.ts +804 -0
  86. package/src/components/templates/carrier-recovery-form/carrier-recovery-form-schema.d.ts +0 -241
  87. package/src/components/templates/carrier-recovery-form/index.d.ts +0 -2
  88. package/src/components/templates/carrier-terms-form/carrier-terms-form-schema.d.ts +0 -10
  89. package/src/components/templates/carrier-terms-form/carrier-terms-form.d.ts +0 -6
  90. package/src/components/templates/carrier-terms-form/carrier-terms-form.styles.d.ts +0 -65
  91. package/src/components/templates/carrier-terms-form/index.d.ts +0 -1
  92. package/src/components/templates/landing-page/index.d.ts +0 -1
  93. package/src/components/templates/landing-page/landing-page-form-schema.d.ts +0 -10
  94. package/src/components/templates/landing-page/landing-page-form.d.ts +0 -4
  95. package/src/components/templates/landing-page/landing-page.d.ts +0 -5
  96. package/src/components/templates/onboarding/onboarding.d.ts +0 -42
  97. /package/src/{components/templates/onboarding → workflows}/index.d.ts +0 -0
  98. /package/src/{components/templates/landing-page/landing-page.styles.d.ts → workflows/onboarding/components/account-registration-step/account-registration-step.styles.d.ts} +0 -0
  99. /package/src/{components/templates → workflows/onboarding/components}/carrier-recovery-form/carrier-recovery-form.styles.d.ts +0 -0
  100. /package/src/{components/templates → workflows/onboarding/components}/completion-page/completion-page.d.ts +0 -0
  101. /package/src/{components/templates → workflows/onboarding/components}/completion-page/index.d.ts +0 -0
  102. /package/src/{elements → workflows}/onboarding/index.d.ts +0 -0
@@ -432,7 +432,7 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
432
432
  onboarding: {
433
433
  title: string;
434
434
  inlineTitle: string;
435
- landing: {
435
+ accountRegistration: {
436
436
  action: string;
437
437
  title: string;
438
438
  subtitle: string;
@@ -441,11 +441,11 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
441
441
  partnerMessageLine1: string;
442
442
  messageLine2: string;
443
443
  };
444
- steps: {
445
- register: string;
446
- carriers: string;
447
- addresses: string;
448
- billing: string;
444
+ stepLabel: {
445
+ accountRegistration: string;
446
+ termsAgreement: string;
447
+ shipFromAddress: string;
448
+ fundingAndCarrierConnection: string;
449
449
  };
450
450
  warehouse: {
451
451
  title: string;
@@ -453,13 +453,29 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
453
453
  inlineMessage: string;
454
454
  };
455
455
  success: {
456
- /**
457
- * `features` is a set of feature flags you would like to enable or disable in this component.
458
- */
459
456
  title: string;
460
457
  subtitle: string;
461
458
  action: string;
462
459
  };
460
+ termsAndAgreementLinkText: {
461
+ aHR0cHM6Ly9teWRobC5leHByZXNzLmRobC91cy9lbi9sZWdhbC90ZXJtcy1hbmQtY29uZGl0aW9ucy5odG1s: string;
462
+ "aHR0cHM6Ly93d3cuc3RhbXBzLmNvbS9wcml2YWN5LXBvbGljeQ==": string;
463
+ "aHR0cHM6Ly93d3cuc3RhbXBzLmNvbS9jb25kaXRpb25zLw==": string;
464
+ "aHR0cHM6Ly93d3cudXBzLmNvbS91cy9lbi9zdXBwb3J0L3NoaXBwaW5nLXN1cHBvcnQvc2hpcHBpbmctc3BlY2lhbC1jYXJlLXJlZ3VsYXRlZC1pdGVtcy9wcm9oaWJpdGVkLWl0ZW1zLnBhZ2U=": string;
465
+ aHR0cHM6Ly93d3cudXBzLmNvbS9hc3NldHMvcmVzb3VyY2VzL21lZGlhL2VuX1VTL1VQU19EQVBfVEMucGRm: string;
466
+ "aHR0cHM6Ly93d3cudXBzLmNvbS9hc3NldHMvcmVzb3VyY2VzL21lZGlhL2VuX1VTL1VUQS5wZGY=": string;
467
+ "aHR0cHM6Ly93d3cuZXZyaS5jb20vdGVybXMtYW5kLWNvbmRpdGlvbnM=": string;
468
+ "aHR0cHM6Ly93d3cueW9kZWxkaXJlY3QuY28udWsvY29udGVudC9hYm91dC10ZXJtcw==": string;
469
+ aHR0cHM6Ly93d3cuc2hpcHN0YXRpb24uY29tL3Rlcm1zLXNlcnZpY2UtdW5pdGVkLWtpbmdkb20v: string;
470
+ };
471
+ termsAndAgreementTitles: {
472
+ "WW9kZWwgRGlyZWN0IC0gVGVybXMgYW5kIENvbmRpdGlvbnMgKOKAnFRlcm1z4oCdKQ==": string;
473
+ "RXZyaSBTZW5kIFRlcm1zICYgQ29uZGl0aW9ucw==": string;
474
+ "VGVybXMgb2YgU2VydmljZSBVbml0ZWQgS2luZ2RvbQ==": string;
475
+ }; /**
476
+ * `onBeforeRateSave` is an async/sync callback function that will be invoked before each time a user
477
+ * saves a rate.
478
+ */
463
479
  };
464
480
  "manage-defaults": {
465
481
  label: {
@@ -581,6 +597,7 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
581
597
  cancel: string;
582
598
  close: string;
583
599
  confirm: string;
600
+ connect: string;
584
601
  continue: string;
585
602
  delete: string;
586
603
  edit: string;
@@ -597,6 +614,7 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
597
614
  fields: {
598
615
  name: string;
599
616
  company: string;
617
+ county: string;
600
618
  countryCode: string;
601
619
  addressLine1: string;
602
620
  addressLine2: string;
@@ -609,7 +627,9 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
609
627
  };
610
628
  noResults: string;
611
629
  subFields: {
612
- optional: string;
630
+ optional: string; /**
631
+ * `features` is a set of feature flags you would like to enable or disable in this component.
632
+ */
613
633
  };
614
634
  parserFields: {
615
635
  fullAddress: string;
@@ -644,7 +664,10 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
644
664
  expirationPlaceholder: string;
645
665
  cardNumberPlaceholder: string;
646
666
  };
647
- };
667
+ }; /**
668
+ * `onApplyPreset` is an async/sync callback function that will be invoked each time a `Preset`
669
+ * has been applied to a shipment.
670
+ */
648
671
  carriers: {
649
672
  fields: {
650
673
  agreement: string;
@@ -711,6 +734,7 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
711
734
  autoFundingSettings: string;
712
735
  carrier: string;
713
736
  carriers: string;
737
+ fundingSourceMetadata: string;
714
738
  label: string;
715
739
  salesOrder: string;
716
740
  shipment: string;
@@ -718,7 +742,6 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
718
742
  };
719
743
  unknown: string;
720
744
  noRatesAvailable: string;
721
- saveRateError: string;
722
745
  };
723
746
  errorTypes: {
724
747
  accountStatus: string;
@@ -733,6 +756,11 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
733
756
  unknown: string;
734
757
  validation: string;
735
758
  };
759
+ grid: {
760
+ "row-count_one": string;
761
+ "row-count_other": string;
762
+ rows: string;
763
+ };
736
764
  insuranceProviders: {
737
765
  carrier: string;
738
766
  none: string;
@@ -744,6 +772,7 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
744
772
  carrier: string;
745
773
  carriers: string;
746
774
  connectingCarriers: string;
775
+ creatingFundingSource: string;
747
776
  data: string;
748
777
  importingSalesOrder: string;
749
778
  label: string;
@@ -805,6 +834,14 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
805
834
  platform: string;
806
835
  user: string;
807
836
  };
837
+ terms: {
838
+ fields: {
839
+ agreement: string;
840
+ };
841
+ agreeToTerms: string;
842
+ carriersTitle: string;
843
+ fundingSourceTitle: string;
844
+ };
808
845
  weight: {
809
846
  ounces: string;
810
847
  pounds_one: string;
@@ -820,6 +857,7 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
820
857
  gram: string;
821
858
  kilogram: string;
822
859
  };
860
+ T25seSByZXNpZGVudGlhbCBkZWxpdmVyeSBhZGRyZXNzZXMgYXJlIGFsbG93ZWQgZm9yIFVQUyBHcm91bmQgU2F2ZXIu: string;
823
861
  "VGhlIHNlbGVjdGVkIHNlcnZpY2UgaW5jbHVkZXMgaW5zdXJhbmNlIGZvciBhbiBpbnN1cmVkIGFtb3VudCB1cCB0byAkMTAwLgo=": string;
824
862
  "VGhlIHNlbGVjdGVkIHNlcnZpY2UgaW5jbHVkZXMgaW5zdXJhbmNlIGZvciBhbiBpbnN1cmVkIGFtb3VudCB1cCB0byAkNTAuCg==": string;
825
863
  QSBzaGlwcGluZyBjYXJyaWVyIGVycm9yIG9jY3VycmVkOiBJbnN1ZmZpY2llbnQgYWNjb3VudCBiYWxhbmNlLiBBY2NvdW50IGV4Y2VwdGlvbiBFeGNlcHRpb24gd2l0aCBjb2RlIDB4MDA1NjAxMDE7IG1vZHVsZSA4NiwgY2F0ZWdvcnkgMSwgaXRlbSAx: string;
@@ -831,6 +869,13 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
831
869
  "QSBzaGlwcGluZyBjYXJyaWVyIGVycm9yIG9jY3VycmVkOiBNaXNzaW5nIG9yIGludmFsaWQgc2hpcCB0byBTdGF0ZVByb3ZpbmNlQ29kZQ==": string;
832
870
  "QSBzaGlwcGluZyBjYXJyaWVyIGVycm9yIG9jY3VycmVkOiBJbnZhbGlkIHNvbGQgdG8gc3RhdGUgcHJvdmluY2UgY29kZS4gVmFsaWQgbGVuZ3RoIGlzIDAgdG8gNSBhbHBoYW51bWVyaWM=": string;
833
871
  };
872
+ "connect-carrier": {
873
+ registrationForm: {
874
+ title: string;
875
+ isLoading: string;
876
+ betaWarning: string;
877
+ };
878
+ };
834
879
  "account-settings": {
835
880
  title: string;
836
881
  sections: {
@@ -329,7 +329,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
329
329
  onboarding: {
330
330
  title: string;
331
331
  inlineTitle: string;
332
- landing: {
332
+ accountRegistration: {
333
333
  action: string;
334
334
  title: string;
335
335
  subtitle: string;
@@ -338,11 +338,11 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
338
338
  partnerMessageLine1: string;
339
339
  messageLine2: string;
340
340
  };
341
- steps: {
342
- register: string;
343
- carriers: string;
344
- addresses: string;
345
- billing: string;
341
+ stepLabel: {
342
+ accountRegistration: string;
343
+ termsAgreement: string;
344
+ shipFromAddress: string;
345
+ fundingAndCarrierConnection: string;
346
346
  };
347
347
  warehouse: {
348
348
  title: string;
@@ -354,6 +354,22 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
354
354
  subtitle: string;
355
355
  action: string;
356
356
  };
357
+ termsAndAgreementLinkText: {
358
+ aHR0cHM6Ly9teWRobC5leHByZXNzLmRobC91cy9lbi9sZWdhbC90ZXJtcy1hbmQtY29uZGl0aW9ucy5odG1s: string;
359
+ "aHR0cHM6Ly93d3cuc3RhbXBzLmNvbS9wcml2YWN5LXBvbGljeQ==": string;
360
+ "aHR0cHM6Ly93d3cuc3RhbXBzLmNvbS9jb25kaXRpb25zLw==": string;
361
+ "aHR0cHM6Ly93d3cudXBzLmNvbS91cy9lbi9zdXBwb3J0L3NoaXBwaW5nLXN1cHBvcnQvc2hpcHBpbmctc3BlY2lhbC1jYXJlLXJlZ3VsYXRlZC1pdGVtcy9wcm9oaWJpdGVkLWl0ZW1zLnBhZ2U=": string;
362
+ aHR0cHM6Ly93d3cudXBzLmNvbS9hc3NldHMvcmVzb3VyY2VzL21lZGlhL2VuX1VTL1VQU19EQVBfVEMucGRm: string;
363
+ "aHR0cHM6Ly93d3cudXBzLmNvbS9hc3NldHMvcmVzb3VyY2VzL21lZGlhL2VuX1VTL1VUQS5wZGY=": string;
364
+ "aHR0cHM6Ly93d3cuZXZyaS5jb20vdGVybXMtYW5kLWNvbmRpdGlvbnM=": string;
365
+ "aHR0cHM6Ly93d3cueW9kZWxkaXJlY3QuY28udWsvY29udGVudC9hYm91dC10ZXJtcw==": string;
366
+ aHR0cHM6Ly93d3cuc2hpcHN0YXRpb24uY29tL3Rlcm1zLXNlcnZpY2UtdW5pdGVkLWtpbmdkb20v: string;
367
+ };
368
+ termsAndAgreementTitles: {
369
+ "WW9kZWwgRGlyZWN0IC0gVGVybXMgYW5kIENvbmRpdGlvbnMgKOKAnFRlcm1z4oCdKQ==": string;
370
+ "RXZyaSBTZW5kIFRlcm1zICYgQ29uZGl0aW9ucw==": string;
371
+ "VGVybXMgb2YgU2VydmljZSBVbml0ZWQgS2luZ2RvbQ==": string;
372
+ };
357
373
  };
358
374
  "manage-defaults": {
359
375
  label: {
@@ -481,6 +497,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
481
497
  cancel: string;
482
498
  close: string;
483
499
  confirm: string;
500
+ connect: string;
484
501
  continue: string;
485
502
  delete: string;
486
503
  edit: string;
@@ -497,18 +514,18 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
497
514
  fields: {
498
515
  name: string;
499
516
  company: string;
517
+ county: string;
500
518
  countryCode: string;
501
519
  addressLine1: string;
502
520
  addressLine2: string;
503
521
  cityLocality: string;
504
522
  stateProvince: string;
505
- postalCode: string;
506
- phone: string;
507
- email: string;
508
- /**
523
+ postalCode: string; /**
509
524
  * `onClickPrintLabel` is a callback function that will be invoked when the user clicks the
510
525
  * `Print Label` button.
511
526
  */
527
+ phone: string;
528
+ email: string;
512
529
  addressResidentialIndicator: string;
513
530
  };
514
531
  noResults: string;
@@ -613,14 +630,9 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
613
630
  unableToLoad: {
614
631
  accountSettings: string;
615
632
  autoFundingSettings: string;
616
- carrier: string; /**
617
- * # View Shipment Element Props
618
- *
619
- * - These are the base props that will be passed into the `<ViewShipment />` element.
620
- *
621
- * @see {@link ViewShipment.Element | See the full type that `typeof Element` will return}
622
- */
633
+ carrier: string;
623
634
  carriers: string;
635
+ fundingSourceMetadata: string;
624
636
  label: string;
625
637
  salesOrder: string;
626
638
  shipment: string;
@@ -628,7 +640,6 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
628
640
  };
629
641
  unknown: string;
630
642
  noRatesAvailable: string;
631
- saveRateError: string;
632
643
  };
633
644
  errorTypes: {
634
645
  accountStatus: string;
@@ -643,6 +654,11 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
643
654
  unknown: string;
644
655
  validation: string;
645
656
  };
657
+ grid: {
658
+ "row-count_one": string;
659
+ "row-count_other": string;
660
+ rows: string;
661
+ };
646
662
  insuranceProviders: {
647
663
  carrier: string;
648
664
  none: string;
@@ -654,6 +670,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
654
670
  carrier: string;
655
671
  carriers: string;
656
672
  connectingCarriers: string;
673
+ creatingFundingSource: string;
657
674
  data: string;
658
675
  importingSalesOrder: string;
659
676
  label: string;
@@ -715,6 +732,14 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
715
732
  platform: string;
716
733
  user: string;
717
734
  };
735
+ terms: {
736
+ fields: {
737
+ agreement: string;
738
+ };
739
+ agreeToTerms: string;
740
+ carriersTitle: string;
741
+ fundingSourceTitle: string;
742
+ };
718
743
  weight: {
719
744
  ounces: string;
720
745
  pounds_one: string;
@@ -730,6 +755,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
730
755
  gram: string;
731
756
  kilogram: string;
732
757
  };
758
+ T25seSByZXNpZGVudGlhbCBkZWxpdmVyeSBhZGRyZXNzZXMgYXJlIGFsbG93ZWQgZm9yIFVQUyBHcm91bmQgU2F2ZXIu: string;
733
759
  "VGhlIHNlbGVjdGVkIHNlcnZpY2UgaW5jbHVkZXMgaW5zdXJhbmNlIGZvciBhbiBpbnN1cmVkIGFtb3VudCB1cCB0byAkMTAwLgo=": string;
734
760
  "VGhlIHNlbGVjdGVkIHNlcnZpY2UgaW5jbHVkZXMgaW5zdXJhbmNlIGZvciBhbiBpbnN1cmVkIGFtb3VudCB1cCB0byAkNTAuCg==": string;
735
761
  QSBzaGlwcGluZyBjYXJyaWVyIGVycm9yIG9jY3VycmVkOiBJbnN1ZmZpY2llbnQgYWNjb3VudCBiYWxhbmNlLiBBY2NvdW50IGV4Y2VwdGlvbiBFeGNlcHRpb24gd2l0aCBjb2RlIDB4MDA1NjAxMDE7IG1vZHVsZSA4NiwgY2F0ZWdvcnkgMSwgaXRlbSAx: string;
@@ -741,6 +767,13 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
741
767
  "QSBzaGlwcGluZyBjYXJyaWVyIGVycm9yIG9jY3VycmVkOiBNaXNzaW5nIG9yIGludmFsaWQgc2hpcCB0byBTdGF0ZVByb3ZpbmNlQ29kZQ==": string;
742
768
  "QSBzaGlwcGluZyBjYXJyaWVyIGVycm9yIG9jY3VycmVkOiBJbnZhbGlkIHNvbGQgdG8gc3RhdGUgcHJvdmluY2UgY29kZS4gVmFsaWQgbGVuZ3RoIGlzIDAgdG8gNSBhbHBoYW51bWVyaWM=": string;
743
769
  };
770
+ "connect-carrier": {
771
+ registrationForm: {
772
+ title: string;
773
+ isLoading: string;
774
+ betaWarning: string;
775
+ };
776
+ };
744
777
  "account-settings": {
745
778
  title: string;
746
779
  sections: {
@@ -327,7 +327,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
327
327
  onboarding: {
328
328
  title: string;
329
329
  inlineTitle: string;
330
- landing: {
330
+ accountRegistration: {
331
331
  action: string;
332
332
  title: string;
333
333
  subtitle: string;
@@ -336,15 +336,18 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
336
336
  partnerMessageLine1: string;
337
337
  messageLine2: string;
338
338
  };
339
- steps: {
340
- register: string;
341
- carriers: string;
342
- addresses: string;
343
- billing: string;
339
+ stepLabel: {
340
+ accountRegistration: string;
341
+ termsAgreement: string;
342
+ shipFromAddress: string;
343
+ fundingAndCarrierConnection: string;
344
344
  };
345
345
  warehouse: {
346
346
  title: string;
347
- subtitle: string;
347
+ subtitle: string; /**
348
+ * `onComplete` is a callback function that will be invoked when the request to void a given
349
+ * shipping label is completed.
350
+ */
348
351
  inlineMessage: string;
349
352
  };
350
353
  success: {
@@ -352,6 +355,22 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
352
355
  subtitle: string;
353
356
  action: string;
354
357
  };
358
+ termsAndAgreementLinkText: {
359
+ aHR0cHM6Ly9teWRobC5leHByZXNzLmRobC91cy9lbi9sZWdhbC90ZXJtcy1hbmQtY29uZGl0aW9ucy5odG1s: string;
360
+ "aHR0cHM6Ly93d3cuc3RhbXBzLmNvbS9wcml2YWN5LXBvbGljeQ==": string;
361
+ "aHR0cHM6Ly93d3cuc3RhbXBzLmNvbS9jb25kaXRpb25zLw==": string;
362
+ "aHR0cHM6Ly93d3cudXBzLmNvbS91cy9lbi9zdXBwb3J0L3NoaXBwaW5nLXN1cHBvcnQvc2hpcHBpbmctc3BlY2lhbC1jYXJlLXJlZ3VsYXRlZC1pdGVtcy9wcm9oaWJpdGVkLWl0ZW1zLnBhZ2U=": string;
363
+ aHR0cHM6Ly93d3cudXBzLmNvbS9hc3NldHMvcmVzb3VyY2VzL21lZGlhL2VuX1VTL1VQU19EQVBfVEMucGRm: string;
364
+ "aHR0cHM6Ly93d3cudXBzLmNvbS9hc3NldHMvcmVzb3VyY2VzL21lZGlhL2VuX1VTL1VUQS5wZGY=": string;
365
+ "aHR0cHM6Ly93d3cuZXZyaS5jb20vdGVybXMtYW5kLWNvbmRpdGlvbnM=": string;
366
+ "aHR0cHM6Ly93d3cueW9kZWxkaXJlY3QuY28udWsvY29udGVudC9hYm91dC10ZXJtcw==": string;
367
+ aHR0cHM6Ly93d3cuc2hpcHN0YXRpb24uY29tL3Rlcm1zLXNlcnZpY2UtdW5pdGVkLWtpbmdkb20v: string;
368
+ };
369
+ termsAndAgreementTitles: {
370
+ "WW9kZWwgRGlyZWN0IC0gVGVybXMgYW5kIENvbmRpdGlvbnMgKOKAnFRlcm1z4oCdKQ==": string;
371
+ "RXZyaSBTZW5kIFRlcm1zICYgQ29uZGl0aW9ucw==": string;
372
+ "VGVybXMgb2YgU2VydmljZSBVbml0ZWQgS2luZ2RvbQ==": string;
373
+ };
355
374
  };
356
375
  "manage-defaults": {
357
376
  label: {
@@ -473,6 +492,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
473
492
  cancel: string;
474
493
  close: string;
475
494
  confirm: string;
495
+ connect: string;
476
496
  continue: string;
477
497
  delete: string;
478
498
  edit: string;
@@ -489,11 +509,10 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
489
509
  fields: {
490
510
  name: string;
491
511
  company: string;
512
+ county: string;
492
513
  countryCode: string;
493
514
  addressLine1: string;
494
- addressLine2: string; /**
495
- * `features` is a set of feature flags you would like to enable or disable in this component.
496
- */
515
+ addressLine2: string;
497
516
  cityLocality: string;
498
517
  stateProvince: string;
499
518
  postalCode: string;
@@ -527,31 +546,6 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
527
546
  validated: string;
528
547
  };
529
548
  };
530
- /**
531
- * # Void Label Component
532
- *
533
- * - The `<VoidLabel />` component is used to void a given shipping label. When a label is voided,
534
- * you then get the option to view the associated shipment via the `View Shipment` Element, or
535
- * you can purchase another label for the shipment via the `Purchase Label` Element.
536
- *
537
- * @param ComponentProps The base props that will be passed into the `<VoidLabel />` component.
538
- *
539
- * @returns Element An EmotionJSX.Element that will render the `<VoidLabel />` component
540
- * with all the appropriate wrappers.
541
- *
542
- * @example
543
- * You can see how the `<Component />` is used in the `createElement` function call below.
544
- * ```tsx
545
- * export const Element = alchemy.createElement(Component, ErrorFallback, {
546
- * css: { height: "100%", maxWidth: "800px", minWidth: "440px", width: "100%" },
547
- * resources: { en },
548
- * });
549
- * ```
550
- *
551
- * <br />
552
- *
553
- * @see {@link VoidLabel.Element | The **Element** created to render `<VoidLabel />`}
554
- */
555
549
  billing: {
556
550
  fields: {
557
551
  differentBillingAddress: string;
@@ -630,6 +624,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
630
624
  autoFundingSettings: string;
631
625
  carrier: string;
632
626
  carriers: string;
627
+ fundingSourceMetadata: string;
633
628
  label: string;
634
629
  salesOrder: string;
635
630
  shipment: string;
@@ -637,7 +632,6 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
637
632
  };
638
633
  unknown: string;
639
634
  noRatesAvailable: string;
640
- saveRateError: string;
641
635
  };
642
636
  errorTypes: {
643
637
  accountStatus: string;
@@ -652,6 +646,11 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
652
646
  unknown: string;
653
647
  validation: string;
654
648
  };
649
+ grid: {
650
+ "row-count_one": string;
651
+ "row-count_other": string;
652
+ rows: string;
653
+ };
655
654
  insuranceProviders: {
656
655
  carrier: string;
657
656
  none: string;
@@ -663,6 +662,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
663
662
  carrier: string;
664
663
  carriers: string;
665
664
  connectingCarriers: string;
665
+ creatingFundingSource: string;
666
666
  data: string;
667
667
  importingSalesOrder: string;
668
668
  label: string;
@@ -724,6 +724,14 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
724
724
  platform: string;
725
725
  user: string;
726
726
  };
727
+ terms: {
728
+ fields: {
729
+ agreement: string;
730
+ };
731
+ agreeToTerms: string;
732
+ carriersTitle: string;
733
+ fundingSourceTitle: string;
734
+ };
727
735
  weight: {
728
736
  ounces: string;
729
737
  pounds_one: string;
@@ -739,6 +747,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
739
747
  gram: string;
740
748
  kilogram: string;
741
749
  };
750
+ T25seSByZXNpZGVudGlhbCBkZWxpdmVyeSBhZGRyZXNzZXMgYXJlIGFsbG93ZWQgZm9yIFVQUyBHcm91bmQgU2F2ZXIu: string;
742
751
  "VGhlIHNlbGVjdGVkIHNlcnZpY2UgaW5jbHVkZXMgaW5zdXJhbmNlIGZvciBhbiBpbnN1cmVkIGFtb3VudCB1cCB0byAkMTAwLgo=": string;
743
752
  "VGhlIHNlbGVjdGVkIHNlcnZpY2UgaW5jbHVkZXMgaW5zdXJhbmNlIGZvciBhbiBpbnN1cmVkIGFtb3VudCB1cCB0byAkNTAuCg==": string;
744
753
  QSBzaGlwcGluZyBjYXJyaWVyIGVycm9yIG9jY3VycmVkOiBJbnN1ZmZpY2llbnQgYWNjb3VudCBiYWxhbmNlLiBBY2NvdW50IGV4Y2VwdGlvbiBFeGNlcHRpb24gd2l0aCBjb2RlIDB4MDA1NjAxMDE7IG1vZHVsZSA4NiwgY2F0ZWdvcnkgMSwgaXRlbSAx: string;
@@ -750,6 +759,13 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
750
759
  "QSBzaGlwcGluZyBjYXJyaWVyIGVycm9yIG9jY3VycmVkOiBNaXNzaW5nIG9yIGludmFsaWQgc2hpcCB0byBTdGF0ZVByb3ZpbmNlQ29kZQ==": string;
751
760
  "QSBzaGlwcGluZyBjYXJyaWVyIGVycm9yIG9jY3VycmVkOiBJbnZhbGlkIHNvbGQgdG8gc3RhdGUgcHJvdmluY2UgY29kZS4gVmFsaWQgbGVuZ3RoIGlzIDAgdG8gNSBhbHBoYW51bWVyaWM=": string;
752
761
  };
762
+ "connect-carrier": {
763
+ registrationForm: {
764
+ title: string;
765
+ isLoading: string;
766
+ betaWarning: string;
767
+ };
768
+ };
753
769
  "account-settings": {
754
770
  title: string;
755
771
  sections: {
@@ -29,7 +29,7 @@ export declare const styles: {
29
29
  linkAction: (theme: import("@shipengine/giger-theme/dist/lib/Theme").Theme) => {
30
30
  textAlign: "end";
31
31
  };
32
- pagination: {
32
+ pagination: (theme: import("@shipengine/giger-theme/dist/lib/Theme").Theme) => {
33
33
  "&& button": {
34
34
  background: string;
35
35
  };
@@ -39,7 +39,7 @@ export declare const styles: {
39
39
  textAlign: "center";
40
40
  };
41
41
  skeletonCard: (theme: import("@shipengine/giger-theme/dist/lib/Theme").Theme) => {
42
- backgroundColor: "#e3dfdf1f";
42
+ backgroundColor: string;
43
43
  display: "flex";
44
44
  justifyContent: "space-between";
45
45
  padding: number;
package/src/index.d.ts CHANGED
@@ -6,3 +6,4 @@ export * from "./hooks";
6
6
  export * from "./schemas";
7
7
  export * from "./types";
8
8
  export * from "./utilities";
9
+ export * from "./workflows";
@@ -226,7 +226,7 @@ declare const _default: {
226
226
  onboarding: {
227
227
  title: string;
228
228
  inlineTitle: string;
229
- landing: {
229
+ accountRegistration: {
230
230
  action: string;
231
231
  title: string;
232
232
  subtitle: string;
@@ -235,11 +235,11 @@ declare const _default: {
235
235
  partnerMessageLine1: string;
236
236
  messageLine2: string;
237
237
  };
238
- steps: {
239
- register: string;
240
- carriers: string;
241
- addresses: string;
242
- billing: string;
238
+ stepLabel: {
239
+ accountRegistration: string;
240
+ termsAgreement: string;
241
+ shipFromAddress: string;
242
+ fundingAndCarrierConnection: string;
243
243
  };
244
244
  warehouse: {
245
245
  title: string;
@@ -251,6 +251,22 @@ declare const _default: {
251
251
  subtitle: string;
252
252
  action: string;
253
253
  };
254
+ termsAndAgreementLinkText: {
255
+ aHR0cHM6Ly9teWRobC5leHByZXNzLmRobC91cy9lbi9sZWdhbC90ZXJtcy1hbmQtY29uZGl0aW9ucy5odG1s: string;
256
+ "aHR0cHM6Ly93d3cuc3RhbXBzLmNvbS9wcml2YWN5LXBvbGljeQ==": string;
257
+ "aHR0cHM6Ly93d3cuc3RhbXBzLmNvbS9jb25kaXRpb25zLw==": string;
258
+ "aHR0cHM6Ly93d3cudXBzLmNvbS91cy9lbi9zdXBwb3J0L3NoaXBwaW5nLXN1cHBvcnQvc2hpcHBpbmctc3BlY2lhbC1jYXJlLXJlZ3VsYXRlZC1pdGVtcy9wcm9oaWJpdGVkLWl0ZW1zLnBhZ2U=": string;
259
+ aHR0cHM6Ly93d3cudXBzLmNvbS9hc3NldHMvcmVzb3VyY2VzL21lZGlhL2VuX1VTL1VQU19EQVBfVEMucGRm: string;
260
+ "aHR0cHM6Ly93d3cudXBzLmNvbS9hc3NldHMvcmVzb3VyY2VzL21lZGlhL2VuX1VTL1VUQS5wZGY=": string;
261
+ "aHR0cHM6Ly93d3cuZXZyaS5jb20vdGVybXMtYW5kLWNvbmRpdGlvbnM=": string;
262
+ "aHR0cHM6Ly93d3cueW9kZWxkaXJlY3QuY28udWsvY29udGVudC9hYm91dC10ZXJtcw==": string;
263
+ aHR0cHM6Ly93d3cuc2hpcHN0YXRpb24uY29tL3Rlcm1zLXNlcnZpY2UtdW5pdGVkLWtpbmdkb20v: string;
264
+ };
265
+ termsAndAgreementTitles: {
266
+ "WW9kZWwgRGlyZWN0IC0gVGVybXMgYW5kIENvbmRpdGlvbnMgKOKAnFRlcm1z4oCdKQ==": string;
267
+ "RXZyaSBTZW5kIFRlcm1zICYgQ29uZGl0aW9ucw==": string;
268
+ "VGVybXMgb2YgU2VydmljZSBVbml0ZWQgS2luZ2RvbQ==": string;
269
+ };
254
270
  };
255
271
  "manage-defaults": {
256
272
  label: {
@@ -372,6 +388,7 @@ declare const _default: {
372
388
  cancel: string;
373
389
  close: string;
374
390
  confirm: string;
391
+ connect: string;
375
392
  continue: string;
376
393
  delete: string;
377
394
  edit: string;
@@ -388,6 +405,7 @@ declare const _default: {
388
405
  fields: {
389
406
  name: string;
390
407
  company: string;
408
+ county: string;
391
409
  countryCode: string;
392
410
  addressLine1: string;
393
411
  addressLine2: string;
@@ -502,6 +520,7 @@ declare const _default: {
502
520
  autoFundingSettings: string;
503
521
  carrier: string;
504
522
  carriers: string;
523
+ fundingSourceMetadata: string;
505
524
  label: string;
506
525
  salesOrder: string;
507
526
  shipment: string;
@@ -509,7 +528,6 @@ declare const _default: {
509
528
  };
510
529
  unknown: string;
511
530
  noRatesAvailable: string;
512
- saveRateError: string;
513
531
  };
514
532
  errorTypes: {
515
533
  accountStatus: string;
@@ -524,6 +542,11 @@ declare const _default: {
524
542
  unknown: string;
525
543
  validation: string;
526
544
  };
545
+ grid: {
546
+ "row-count_one": string;
547
+ "row-count_other": string;
548
+ rows: string;
549
+ };
527
550
  insuranceProviders: {
528
551
  carrier: string;
529
552
  none: string;
@@ -535,6 +558,7 @@ declare const _default: {
535
558
  carrier: string;
536
559
  carriers: string;
537
560
  connectingCarriers: string;
561
+ creatingFundingSource: string;
538
562
  data: string;
539
563
  importingSalesOrder: string;
540
564
  label: string;
@@ -596,6 +620,14 @@ declare const _default: {
596
620
  platform: string;
597
621
  user: string;
598
622
  };
623
+ terms: {
624
+ fields: {
625
+ agreement: string;
626
+ };
627
+ agreeToTerms: string;
628
+ carriersTitle: string;
629
+ fundingSourceTitle: string;
630
+ };
599
631
  weight: {
600
632
  ounces: string;
601
633
  pounds_one: string;
@@ -611,6 +643,7 @@ declare const _default: {
611
643
  gram: string;
612
644
  kilogram: string;
613
645
  };
646
+ T25seSByZXNpZGVudGlhbCBkZWxpdmVyeSBhZGRyZXNzZXMgYXJlIGFsbG93ZWQgZm9yIFVQUyBHcm91bmQgU2F2ZXIu: string;
614
647
  "VGhlIHNlbGVjdGVkIHNlcnZpY2UgaW5jbHVkZXMgaW5zdXJhbmNlIGZvciBhbiBpbnN1cmVkIGFtb3VudCB1cCB0byAkMTAwLgo=": string;
615
648
  "VGhlIHNlbGVjdGVkIHNlcnZpY2UgaW5jbHVkZXMgaW5zdXJhbmNlIGZvciBhbiBpbnN1cmVkIGFtb3VudCB1cCB0byAkNTAuCg==": string;
616
649
  QSBzaGlwcGluZyBjYXJyaWVyIGVycm9yIG9jY3VycmVkOiBJbnN1ZmZpY2llbnQgYWNjb3VudCBiYWxhbmNlLiBBY2NvdW50IGV4Y2VwdGlvbiBFeGNlcHRpb24gd2l0aCBjb2RlIDB4MDA1NjAxMDE7IG1vZHVsZSA4NiwgY2F0ZWdvcnkgMSwgaXRlbSAx: string;
@@ -622,6 +655,13 @@ declare const _default: {
622
655
  "QSBzaGlwcGluZyBjYXJyaWVyIGVycm9yIG9jY3VycmVkOiBNaXNzaW5nIG9yIGludmFsaWQgc2hpcCB0byBTdGF0ZVByb3ZpbmNlQ29kZQ==": string;
623
656
  "QSBzaGlwcGluZyBjYXJyaWVyIGVycm9yIG9jY3VycmVkOiBJbnZhbGlkIHNvbGQgdG8gc3RhdGUgcHJvdmluY2UgY29kZS4gVmFsaWQgbGVuZ3RoIGlzIDAgdG8gNSBhbHBoYW51bWVyaWM=": string;
624
657
  };
658
+ "connect-carrier": {
659
+ registrationForm: {
660
+ title: string;
661
+ isLoading: string;
662
+ betaWarning: string;
663
+ };
664
+ };
625
665
  "account-settings": {
626
666
  title: string;
627
667
  sections: {
@@ -1,2 +1,3 @@
1
1
  export * from "./carrier-metadata";
2
+ export * from "./patch";
2
3
  export * from "./shipping-preset";