@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
@@ -0,0 +1,804 @@
1
+ /// <reference types="react" />
2
+ import { OnboardingWizardProps } from "./components/onboarding-wizard";
3
+ /**
4
+ * # Onboarding Component Props
5
+ *
6
+ * - These are the base props that will be passed into the `<Onboarding />` component.
7
+ *
8
+ * @see {@link Onboarding.Component | This prop types usage in the `<Onboarding />` component}
9
+ */
10
+ export type ComponentProps = {
11
+ /** If provided, the address form will be pre-filled */
12
+ defaultShipFromAddress?: OnboardingWizardProps["defaultShipFromAddress"];
13
+ /** Flags to selectively enable / disable features. */
14
+ features?: OnboardingWizardProps["features"];
15
+ /** Invoked when the onboarding process is completed. */
16
+ onComplete: () => void;
17
+ /** The partner responsible for the currently onboarding seller. This is typically the name of the entity that owns the host application. */
18
+ partnerName?: OnboardingWizardProps["partnerName"];
19
+ };
20
+ /**
21
+ * # Onboarding Component
22
+ *
23
+ * - The `<Onboarding />` component is used to onboard a new user to the ShipEngine platform. This
24
+ * component will allow the user to create a warehouse, register a carrier, and create a funding
25
+ * source for their account. This is everything a user needs to begin fulfilling their shipments
26
+ * using the ShipEngine Platform.
27
+ *
28
+ * @param ComponentProps The base props that will be passed into the `<Onboarding />` component.
29
+ *
30
+ * @returns Element An EmotionJSX.Element that will render the `<Onboarding />` component
31
+ * with all the appropriate wrappers.
32
+ *
33
+ * @example
34
+ * You can see how the `<Component />` is used in the `createElement` function call below.
35
+ * ```tsx
36
+ * export const Element = alchemy.createElement(Component, ErrorFallback, {
37
+ * css: {
38
+ * height: "100%",
39
+ * maxWidth: "800px",
40
+ * minWidth: "440px",
41
+ * overflow: "auto",
42
+ * scrollbarGutter: "stable both-edges",
43
+ * width: "100%",
44
+ * },
45
+ * resources: { en },
46
+ * });
47
+ * ```
48
+ *
49
+ * <br />
50
+ *
51
+ * @see {@link Onboarding.Element | The **Element** created to render `<Onboarding />`}
52
+ */
53
+ export declare const Component: ({ defaultShipFromAddress, features, onComplete, partnerName, }: ComponentProps) => import("@emotion/react/jsx-runtime").JSX.Element;
54
+ /**
55
+ * # Registered Onboarding Element
56
+ *
57
+ * - This is the registered `<Onboarding />` element that will be used to render the
58
+ * `<Onboarding.Element />` component.
59
+ *
60
+ * @param ElementProps The props, callbacks, and resources necessary to render
61
+ * the `<Onboarding.Element />` component.
62
+ *
63
+ * @example
64
+ * The `<Component />` is the source JSX that is rendered when you make use of the `Onboarding`
65
+ * Element directly. Here is a brief example of how you would use it within your application.
66
+ * ```tsx
67
+ * <Onboarding.Element
68
+ * onCompleteOnboarding={() => console.log('Onboarding Complete!')}
69
+ * />
70
+ * ```
71
+ *
72
+ * <br />
73
+ *
74
+ * @see {@link Onboarding.ComponentProps | The **props** that can be passed into the `<Onboarding.Element />` component}
75
+ */
76
+ export declare const Element: ({ resources, ...props }: ComponentProps & {
77
+ resources?: {
78
+ en: {
79
+ "wallet-history": {
80
+ actions: {
81
+ downloadCsv: string;
82
+ chooseDate: string;
83
+ };
84
+ dateRange: string;
85
+ historyOptions: {
86
+ custom: string;
87
+ last30days: string;
88
+ thisMonth: string;
89
+ lastMonth: string;
90
+ };
91
+ };
92
+ "void-label": {
93
+ title: string;
94
+ actions: {
95
+ complete: string;
96
+ confirmVoid: string;
97
+ viewShipment: string;
98
+ };
99
+ errorMessages: {
100
+ labelIdRequired: string;
101
+ };
102
+ resultMessages: {
103
+ approved: string;
104
+ rejected: string;
105
+ };
106
+ refund_process: string;
107
+ refund_rules: string;
108
+ resultTitles: {
109
+ approved: string;
110
+ rejected: string;
111
+ };
112
+ voidedOn: string;
113
+ };
114
+ "view-shipment": {
115
+ title: string;
116
+ actions: {
117
+ buyAnotherLabel: string;
118
+ hideItems: string;
119
+ printForms: string;
120
+ printLabel: string;
121
+ schedulePickup: string;
122
+ showItems: string;
123
+ void: string;
124
+ };
125
+ fields: {
126
+ dimensions: string;
127
+ estimatedShipping: string;
128
+ items: string;
129
+ orderDate: string;
130
+ orderValue: string;
131
+ requestedShipping: string;
132
+ shipDate: string;
133
+ shipTo: string;
134
+ warehouse: string;
135
+ weight: string;
136
+ insuredValue: string;
137
+ deliveryConfirmation: string; /** The partner responsible for the currently onboarding seller. This is typically the name of the entity that owns the host application. */
138
+ };
139
+ highVolumeForms: string;
140
+ multipleShippingServices: string;
141
+ sections: {
142
+ labels: string;
143
+ };
144
+ noLabels: string;
145
+ };
146
+ "register-wallet": {
147
+ sections: {
148
+ setup: {
149
+ title: string;
150
+ subtitle: string;
151
+ descriptionTitle: string;
152
+ description: string;
153
+ };
154
+ billing: {
155
+ title: string;
156
+ cardSubTitle: string;
157
+ addressSubTitle: string;
158
+ /** If provided, the address form will be pre-filled */
159
+ info: string;
160
+ };
161
+ carriers: {
162
+ title: string;
163
+ subtitle: string;
164
+ };
165
+ notifications: {
166
+ error: {
167
+ title: string; /** The partner responsible for the currently onboarding seller. This is typically the name of the entity that owns the host application. */
168
+ };
169
+ info: {
170
+ title: string;
171
+ description: string;
172
+ };
173
+ poBox: {
174
+ title: string;
175
+ description: string;
176
+ };
177
+ carrier: {
178
+ title: string;
179
+ confirmAddress: string;
180
+ description: string;
181
+ };
182
+ blackBox: {
183
+ description: string;
184
+ };
185
+ };
186
+ };
187
+ settings: {
188
+ title: string;
189
+ billing: {
190
+ title: string;
191
+ subtitleCard: string;
192
+ subtitleBilling: string;
193
+ };
194
+ };
195
+ };
196
+ "register-carrier": {
197
+ formTitle: string;
198
+ agreeToTerms: string;
199
+ };
200
+ "purchase-label": {
201
+ title: string;
202
+ actions: {
203
+ calculateRates_one: string;
204
+ calculateRates_other: string;
205
+ hideItems: string;
206
+ purchaseLabel: string;
207
+ purchaseNow: string;
208
+ showItems: string;
209
+ showMoreRates: string;
210
+ showFewerRates: string;
211
+ saveRate: string;
212
+ };
213
+ balance: {
214
+ currentBalance: string;
215
+ insufficientBalanceCTA: string;
216
+ };
217
+ cta: {
218
+ addPackageDetails: string;
219
+ };
220
+ errorMessages: {
221
+ customsItemsRequired: string;
222
+ invalidAddress: string;
223
+ noRates: string;
224
+ salesOrderNotLoaded: string;
225
+ unsupportedAddress: string;
226
+ saveRateFailedMessage: string;
227
+ saveRateFailedTitle: string;
228
+ };
229
+ errorTypes: {
230
+ results: string;
231
+ };
232
+ fields: {
233
+ "requires-additional-handling": string;
234
+ addOns: string;
235
+ contentDescription: string;
236
+ confirmation: string;
237
+ dimensions: {
238
+ length: string;
239
+ width: string;
240
+ height: string;
241
+ };
242
+ dimensionsGroup: string;
243
+ estimatedShipping: string;
244
+ insurance: string;
245
+ insuranceProvider: string;
246
+ insuredValue: string;
247
+ items: string;
248
+ orderDate: string;
249
+ orderValue: string;
250
+ packageCode: string;
251
+ requestedShipping: string;
252
+ shipDate: string;
253
+ service: string;
254
+ shipTo: string;
255
+ addShipToAddress: string;
256
+ warehouse: string;
257
+ weight: {
258
+ whole: string;
259
+ fractional: string;
260
+ };
261
+ weightGroup: string;
262
+ today: string;
263
+ };
264
+ hints: {
265
+ contentDescription: string;
266
+ };
267
+ loading: {
268
+ calculatingRates: string;
269
+ };
270
+ modes: {
271
+ browseRates: string;
272
+ selectService: string;
273
+ };
274
+ multipleShippingServices: string;
275
+ schemaErrors: {
276
+ shipFromUnitedStatesOnly: string;
277
+ shipFromAddressRequired: string;
278
+ needToAcknowledge: string;
279
+ };
280
+ rates: {
281
+ uspsMediaMailAcknowledgement: string;
282
+ uspsFirstClassMailAcknowledgement_leof: string;
283
+ rateSavings: string;
284
+ upsGroundSaverTermsAcknowledgement: string;
285
+ dhlExpressTermsAcknowledgement: string;
286
+ };
287
+ requirements: {
288
+ noWarehouse: string;
289
+ noCarrier: string;
290
+ noWarehouseOrCarrier: string;
291
+ };
292
+ shipToAddressFormFields: string;
293
+ sections: {
294
+ customsForm: string;
295
+ shipment: string;
296
+ rate_one: string;
297
+ rate_other: string;
298
+ payment: string;
299
+ };
300
+ };
301
+ "payment-method": {
302
+ title: string;
303
+ };
304
+ onboarding: {
305
+ title: string;
306
+ inlineTitle: string;
307
+ accountRegistration: {
308
+ action: string;
309
+ title: string;
310
+ subtitle: string;
311
+ welcome: string;
312
+ messageLine1: string;
313
+ partnerMessageLine1: string;
314
+ messageLine2: string; /** Flags to selectively enable / disable features. */
315
+ };
316
+ stepLabel: {
317
+ accountRegistration: string;
318
+ termsAgreement: string;
319
+ shipFromAddress: string;
320
+ fundingAndCarrierConnection: string;
321
+ };
322
+ warehouse: {
323
+ title: string;
324
+ subtitle: string;
325
+ inlineMessage: string;
326
+ };
327
+ success: {
328
+ title: string;
329
+ subtitle: string;
330
+ action: string;
331
+ };
332
+ termsAndAgreementLinkText: {
333
+ aHR0cHM6Ly9teWRobC5leHByZXNzLmRobC91cy9lbi9sZWdhbC90ZXJtcy1hbmQtY29uZGl0aW9ucy5odG1s: string;
334
+ "aHR0cHM6Ly93d3cuc3RhbXBzLmNvbS9wcml2YWN5LXBvbGljeQ==": string;
335
+ "aHR0cHM6Ly93d3cuc3RhbXBzLmNvbS9jb25kaXRpb25zLw==": string;
336
+ "aHR0cHM6Ly93d3cudXBzLmNvbS91cy9lbi9zdXBwb3J0L3NoaXBwaW5nLXN1cHBvcnQvc2hpcHBpbmctc3BlY2lhbC1jYXJlLXJlZ3VsYXRlZC1pdGVtcy9wcm9oaWJpdGVkLWl0ZW1zLnBhZ2U=": string;
337
+ aHR0cHM6Ly93d3cudXBzLmNvbS9hc3NldHMvcmVzb3VyY2VzL21lZGlhL2VuX1VTL1VQU19EQVBfVEMucGRm: string;
338
+ "aHR0cHM6Ly93d3cudXBzLmNvbS9hc3NldHMvcmVzb3VyY2VzL21lZGlhL2VuX1VTL1VUQS5wZGY=": string;
339
+ "aHR0cHM6Ly93d3cuZXZyaS5jb20vdGVybXMtYW5kLWNvbmRpdGlvbnM=": string;
340
+ "aHR0cHM6Ly93d3cueW9kZWxkaXJlY3QuY28udWsvY29udGVudC9hYm91dC10ZXJtcw==": string;
341
+ aHR0cHM6Ly93d3cuc2hpcHN0YXRpb24uY29tL3Rlcm1zLXNlcnZpY2UtdW5pdGVkLWtpbmdkb20v: string;
342
+ };
343
+ termsAndAgreementTitles: {
344
+ "WW9kZWwgRGlyZWN0IC0gVGVybXMgYW5kIENvbmRpdGlvbnMgKOKAnFRlcm1z4oCdKQ==": string;
345
+ "RXZyaSBTZW5kIFRlcm1zICYgQ29uZGl0aW9ucw==": string;
346
+ "VGVybXMgb2YgU2VydmljZSBVbml0ZWQgS2luZ2RvbQ==": string;
347
+ };
348
+ };
349
+ "manage-defaults": {
350
+ label: {
351
+ title: string;
352
+ letter: {
353
+ title: string;
354
+ description: string;
355
+ };
356
+ purchase: {
357
+ title: string;
358
+ description: string;
359
+ };
360
+ thermal: {
361
+ title: string;
362
+ description: string;
363
+ };
364
+ };
365
+ status: {
366
+ saving: string;
367
+ saved: string;
368
+ savingFailed: string;
369
+ };
370
+ units: {
371
+ title: string;
372
+ dimensions: {
373
+ title: string;
374
+ standard: string; /** Invoked when the onboarding process is completed. */
375
+ metric: string;
376
+ };
377
+ weight: {
378
+ title: string; /** The partner responsible for the currently onboarding seller. This is typically the name of the entity that owns the host application. */
379
+ standard: string;
380
+ g: string;
381
+ kg: string;
382
+ };
383
+ };
384
+ };
385
+ "manage-warehouses": {
386
+ title: string;
387
+ addNew: string;
388
+ editWarehouse: string;
389
+ contactName: string;
390
+ default: string;
391
+ isDefault: string;
392
+ locationName: string;
393
+ residentialAddress: string;
394
+ returnTo: string;
395
+ returnToAddressIsDifferent: string;
396
+ setDefault: string;
397
+ shipFrom: string;
398
+ };
399
+ "manage-funding": {
400
+ actions: {
401
+ addFunds: string;
402
+ addFundsAndPurchase: string;
403
+ addNow: string;
404
+ saveRule: string;
405
+ };
406
+ autoFunding: {
407
+ edit: string;
408
+ editSettings: string;
409
+ error: {
410
+ title: string;
411
+ message: string;
412
+ };
413
+ isEnabledCTA: string;
414
+ isEnabled: string;
415
+ isLoading: string;
416
+ lowBalancePurchaseThreshold: string;
417
+ maximumPurchasesPerDay: string;
418
+ purchaseAmount: string;
419
+ readSettings: string;
420
+ };
421
+ addFunds: {
422
+ custom: string;
423
+ error: {
424
+ title: string;
425
+ message: string;
426
+ };
427
+ isLoading: string;
428
+ labels: {
429
+ amount: string;
430
+ };
431
+ minimumPurchaseAmount: string;
432
+ other: string;
433
+ };
434
+ fundAndPurchase: {
435
+ finalBalance: string;
436
+ insufficientFunds: string;
437
+ insufficientFundsTitle: string;
438
+ negativeBalance: string;
439
+ negativeBalanceTitle: string;
440
+ newBalance: string;
441
+ };
442
+ errors: {
443
+ balanceUnknown: string;
444
+ unableToFindBalance: string;
445
+ };
446
+ currentBalance: string;
447
+ maximumBalanceAmount: string;
448
+ };
449
+ "list-carriers": {
450
+ title: string;
451
+ headers: {
452
+ accountCarriers: string;
453
+ carriers: string;
454
+ settings: string;
455
+ };
456
+ actions: {
457
+ status: {
458
+ connected: string;
459
+ notConnected: string;
460
+ };
461
+ };
462
+ };
463
+ common: {
464
+ actions: {
465
+ add: string;
466
+ cancel: string;
467
+ close: string;
468
+ confirm: string;
469
+ connect: string;
470
+ continue: string;
471
+ delete: string;
472
+ edit: string;
473
+ /**
474
+ * # Onboarding Component Props
475
+ *
476
+ * - These are the base props that will be passed into the `<Onboarding />` component.
477
+ *
478
+ * @see {@link Onboarding.Component | This prop types usage in the `<Onboarding />` component}
479
+ */
480
+ hide: string;
481
+ parse: string;
482
+ purchase: string;
483
+ remove: string;
484
+ save: string;
485
+ skipForNow: string;
486
+ submit: string;
487
+ tryAgain: string;
488
+ };
489
+ address: {
490
+ fields: {
491
+ name: string;
492
+ company: string;
493
+ county: string;
494
+ countryCode: string;
495
+ addressLine1: string;
496
+ addressLine2: string;
497
+ cityLocality: string;
498
+ stateProvince: string;
499
+ postalCode: string;
500
+ phone: string; /** The partner responsible for the currently onboarding seller. This is typically the name of the entity that owns the host application. */
501
+ email: string;
502
+ addressResidentialIndicator: string;
503
+ };
504
+ noResults: string;
505
+ subFields: {
506
+ optional: string;
507
+ };
508
+ /**
509
+ * # Onboarding Component
510
+ *
511
+ * - The `<Onboarding />` component is used to onboard a new user to the ShipEngine platform. This
512
+ * component will allow the user to create a warehouse, register a carrier, and create a funding
513
+ * source for their account. This is everything a user needs to begin fulfilling their shipments
514
+ * using the ShipEngine Platform.
515
+ *
516
+ * @param ComponentProps The base props that will be passed into the `<Onboarding />` component.
517
+ *
518
+ * @returns Element An EmotionJSX.Element that will render the `<Onboarding />` component
519
+ * with all the appropriate wrappers.
520
+ *
521
+ * @example
522
+ * You can see how the `<Component />` is used in the `createElement` function call below.
523
+ * ```tsx
524
+ * export const Element = alchemy.createElement(Component, ErrorFallback, {
525
+ * css: {
526
+ * height: "100%",
527
+ * maxWidth: "800px",
528
+ * minWidth: "440px",
529
+ * overflow: "auto",
530
+ * scrollbarGutter: "stable both-edges",
531
+ * width: "100%",
532
+ * },
533
+ * resources: { en },
534
+ * });
535
+ * ```
536
+ *
537
+ * <br />
538
+ *
539
+ * @see {@link Onboarding.Element | The **Element** created to render `<Onboarding />`}
540
+ */
541
+ parserFields: {
542
+ fullAddress: string;
543
+ };
544
+ paste: string;
545
+ preference: {
546
+ confirm: string;
547
+ addressNotValidated: string;
548
+ modified: string;
549
+ title: string;
550
+ originalAddress: string;
551
+ matchedAddress: string;
552
+ unableToValidate: string;
553
+ use: {
554
+ originalAddress: string;
555
+ matchedAddress: string;
556
+ };
557
+ };
558
+ validation: {
559
+ notValidated: string;
560
+ validated: string;
561
+ };
562
+ };
563
+ billing: {
564
+ fields: {
565
+ differentBillingAddress: string;
566
+ name: string;
567
+ cardNumber: string;
568
+ expiration: string;
569
+ cvv: string;
570
+ cvvPlaceholder: string;
571
+ expirationPlaceholder: string;
572
+ cardNumberPlaceholder: string;
573
+ };
574
+ };
575
+ carriers: {
576
+ fields: {
577
+ agreement: string;
578
+ };
579
+ terms: {
580
+ agreeToTerms: string;
581
+ title: string;
582
+ };
583
+ };
584
+ charsetWarnings: {
585
+ name: {
586
+ message: string;
587
+ };
588
+ address: {
589
+ message: string;
590
+ title: string;
591
+ };
592
+ };
593
+ confirmationTypes: {
594
+ adultSignature: string;
595
+ delivery: string;
596
+ deliveryMailed: string;
597
+ directSignature: string;
598
+ none: string;
599
+ signature: string;
600
+ verbalConfirmation: string;
601
+ };
602
+ customs: {
603
+ addDeclaration: string;
604
+ contents: {
605
+ documents: string;
606
+ gift: string;
607
+ merchandise: string;
608
+ returnedGoods: string;
609
+ sample: string;
610
+ };
611
+ declarations: string;
612
+ each: string;
613
+ fields: {
614
+ contentsType: string;
615
+ countryOfOrigin: string;
616
+ description: string;
617
+ harmonizedTariffCode: string;
618
+ ifDeliveryFails: string;
619
+ quantity: string;
620
+ sku: string;
621
+ value: string;
622
+ valueQuantity: string;
623
+ };
624
+ nonDelivery: {
625
+ returnToSender: string;
626
+ treatAsAbandoned: string;
627
+ };
628
+ removeAllDeclarations: string;
629
+ total: string;
630
+ };
631
+ errorMessages: {
632
+ invalidNameOrCompany: string;
633
+ parsingFailure: string;
634
+ incompleteLabelPurchaseRequirements: string;
635
+ shipmentCancelled: string;
636
+ unableToLoad: {
637
+ accountSettings: string;
638
+ autoFundingSettings: string;
639
+ carrier: string;
640
+ carriers: string;
641
+ fundingSourceMetadata: string;
642
+ label: string;
643
+ salesOrder: string;
644
+ shipment: string;
645
+ warehouses: string;
646
+ };
647
+ unknown: string;
648
+ noRatesAvailable: string;
649
+ };
650
+ errorTypes: {
651
+ accountStatus: string;
652
+ businessRules: string;
653
+ integrations: string;
654
+ purchase: string;
655
+ rateInvalid: string;
656
+ saveRate: string;
657
+ security: string;
658
+ shipmentStatus: string;
659
+ system: string;
660
+ unknown: string;
661
+ validation: string;
662
+ };
663
+ grid: {
664
+ "row-count_one": string;
665
+ "row-count_other": string;
666
+ rows: string;
667
+ };
668
+ insuranceProviders: {
669
+ carrier: string;
670
+ none: string;
671
+ shipsurance: string;
672
+ thirdParty: string;
673
+ };
674
+ loading: {
675
+ accountSettings: string;
676
+ carrier: string;
677
+ carriers: string;
678
+ connectingCarriers: string;
679
+ creatingFundingSource: string;
680
+ data: string;
681
+ importingSalesOrder: string;
682
+ label: string;
683
+ onboarding: string;
684
+ salesOrder: string;
685
+ shipment: string;
686
+ warehouses: string;
687
+ };
688
+ months: {
689
+ january: string;
690
+ february: string;
691
+ march: string;
692
+ april: string;
693
+ may: string;
694
+ june: string;
695
+ july: string;
696
+ august: string;
697
+ september: string;
698
+ october: string;
699
+ november: string;
700
+ december: string;
701
+ };
702
+ packageCategories: {
703
+ customPackages: string;
704
+ };
705
+ packageCodes: {
706
+ package: string;
707
+ };
708
+ "powered-by": string;
709
+ schema: {
710
+ optionalLabel: string;
711
+ };
712
+ required: string;
713
+ schemaErrors: {
714
+ notAValidPhoneNumber: string;
715
+ mustAgreeToTerms: string;
716
+ group: {
717
+ allMeasurementsOrNone: string;
718
+ };
719
+ invalidAddressName: string;
720
+ invalidAddressNameStrict: string;
721
+ invalidAddressPoBox: string;
722
+ invalidCreditCardType: string;
723
+ invalidExpirationDate: string;
724
+ invalidPostalCode: string;
725
+ invalidStateProvince: string;
726
+ invalidString: string;
727
+ nonnegative: string;
728
+ nonnegativeList: string;
729
+ positive: string;
730
+ positiveList: string;
731
+ required: string;
732
+ requiredList: string;
733
+ tooFewCharacters: string;
734
+ tooManyCharacters: string;
735
+ };
736
+ shippingPresets: {
737
+ apply: string;
738
+ platform: string;
739
+ user: string;
740
+ };
741
+ terms: {
742
+ fields: {
743
+ agreement: string;
744
+ };
745
+ agreeToTerms: string;
746
+ carriersTitle: string;
747
+ fundingSourceTitle: string;
748
+ };
749
+ weight: {
750
+ ounces: string;
751
+ pounds_one: string;
752
+ pounds_other: string;
753
+ kilogram: string;
754
+ gram: string;
755
+ };
756
+ units: {
757
+ inch: string;
758
+ lbs: string;
759
+ oz: string;
760
+ centimeter: string;
761
+ gram: string;
762
+ kilogram: string;
763
+ };
764
+ T25seSByZXNpZGVudGlhbCBkZWxpdmVyeSBhZGRyZXNzZXMgYXJlIGFsbG93ZWQgZm9yIFVQUyBHcm91bmQgU2F2ZXIu: string;
765
+ "VGhlIHNlbGVjdGVkIHNlcnZpY2UgaW5jbHVkZXMgaW5zdXJhbmNlIGZvciBhbiBpbnN1cmVkIGFtb3VudCB1cCB0byAkMTAwLgo=": string;
766
+ "VGhlIHNlbGVjdGVkIHNlcnZpY2UgaW5jbHVkZXMgaW5zdXJhbmNlIGZvciBhbiBpbnN1cmVkIGFtb3VudCB1cCB0byAkNTAuCg==": string;
767
+ QSBzaGlwcGluZyBjYXJyaWVyIGVycm9yIG9jY3VycmVkOiBJbnN1ZmZpY2llbnQgYWNjb3VudCBiYWxhbmNlLiBBY2NvdW50IGV4Y2VwdGlvbiBFeGNlcHRpb24gd2l0aCBjb2RlIDB4MDA1NjAxMDE7IG1vZHVsZSA4NiwgY2F0ZWdvcnkgMSwgaXRlbSAx: string;
768
+ "QWRkcmVzcyBub3QgZm91bmQ=": string;
769
+ QSBzaGlwcGluZyBjYXJyaWVyIGVycm9yIG9jY3VycmVkOiBVUFMgd2VpZ2h0IGxpbWl0IHBlciBwYWNrYWdlIGlzIDE1MCBsYnMu: string;
770
+ UGxlYXNlIGFkZCBhIFN0YW1wcy5jb20gYWNjb3VudCB0byBTaGlwRW5naW5lIGluIG9yZGVyIHRvIGNyZWF0ZSBzaGlwcGluZyBsYWJlbHMu: string;
771
+ QSBzaGlwcGluZyBlcnJvciBvY2N1cnJlZDogTWlzc2luZyBvciBpbnZhbGlkIHNoaXBwZXIgbnVtYmVy: string;
772
+ QSBzaGlwcGluZyBjYXJyaWVyIGVycm9yIG9jY3VycmVkOiBNaXNzaW5nIG9yIGludmFsaWQgc2hpcHBlciBuYW1l: string;
773
+ "QSBzaGlwcGluZyBjYXJyaWVyIGVycm9yIG9jY3VycmVkOiBNaXNzaW5nIG9yIGludmFsaWQgc2hpcCB0byBTdGF0ZVByb3ZpbmNlQ29kZQ==": string;
774
+ "QSBzaGlwcGluZyBjYXJyaWVyIGVycm9yIG9jY3VycmVkOiBJbnZhbGlkIHNvbGQgdG8gc3RhdGUgcHJvdmluY2UgY29kZS4gVmFsaWQgbGVuZ3RoIGlzIDAgdG8gNSBhbHBoYW51bWVyaWM=": string;
775
+ };
776
+ "connect-carrier": {
777
+ registrationForm: {
778
+ title: string;
779
+ isLoading: string;
780
+ betaWarning: string;
781
+ };
782
+ };
783
+ "account-settings": {
784
+ title: string;
785
+ sections: {
786
+ accountBalance: string;
787
+ paymentMethod: string;
788
+ transactionHistory: string;
789
+ adjustmentHistory: string;
790
+ warehouses: string;
791
+ carriers: string;
792
+ labelLayout: string;
793
+ unitSettings: string;
794
+ };
795
+ };
796
+ };
797
+ } | undefined;
798
+ }) => import("@emotion/react/jsx-runtime").JSX.Element;
799
+ /**
800
+ * # Onboarding Element Props
801
+ *
802
+ * @see {@link Onboarding.Element | See the full type that `typeof Element` will return}
803
+ */
804
+ export type ElementProps = React.ComponentProps<typeof Element>;