@shipengine/elements 2.26.4 → 2.27.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 (200) hide show
  1. package/dist/cjs/assets/xcover/logo.svg.cjs +44 -0
  2. package/dist/cjs/components/field/rate-select/rate-card/rate-attribute-item/index.cjs +7 -0
  3. package/dist/cjs/components/field/rate-select/rate-card/rate-attribute-item/rate-attribute-item.cjs +56 -0
  4. package/dist/cjs/components/field/rate-select/rate-card/rate-attribute-item/rate-attribute-item.styles.cjs +27 -0
  5. package/dist/cjs/components/field/rate-select/rate-card/rate-card.cjs +52 -42
  6. package/dist/cjs/components/field/rate-select/rate-card/rate-card.styles.cjs +4 -0
  7. package/dist/cjs/components/field/rate-select/rate-select.cjs +80 -49
  8. package/dist/cjs/components/forms/register-funding-source-insurance-form/register-funding-source-insurance-form.cjs +1 -1
  9. package/dist/cjs/components/shipment-not-found-error/shipment-not-found-error.cjs +2 -17
  10. package/dist/cjs/components/suspend-purchase/suspend-purchase.cjs +3 -3
  11. package/dist/cjs/data/insurance-provider-metadatas.json.cjs +10 -4
  12. package/dist/cjs/elements/customs-form/customs-form-element.cjs +294 -0
  13. package/dist/cjs/elements/customs-form/customs-form-element.stories.cjs +243 -0
  14. package/dist/cjs/elements/customs-form/customs-form-schema.cjs +59 -0
  15. package/dist/cjs/elements/customs-form/customs-form-types.cjs +63 -0
  16. package/dist/cjs/elements/customs-form/index.cjs +10 -0
  17. package/dist/cjs/elements/index.cjs +5 -0
  18. package/dist/cjs/elements/manage-carriers/manage-carriers.cjs +1 -1
  19. package/dist/cjs/elements/purchase-label/components/customs-forms/tax-ids/tax-ids.cjs +1 -1
  20. package/dist/cjs/elements/purchase-label/components/index.cjs +2 -0
  21. package/dist/cjs/elements/purchase-label/components/rate-form/rate-view.cjs +1 -1
  22. package/dist/cjs/elements/purchase-label/components/shipment-form/shipment-form.cjs +4 -3
  23. package/dist/cjs/elements/purchase-label/hooks/use-filter-visible-rate-options/use-filter-visible-rate-options.cjs +35 -11
  24. package/dist/cjs/elements/purchase-label/hooks/use-insurance-provider-options.cjs +2 -2
  25. package/dist/cjs/elements/purchase-label/purchase-label.cjs +1 -7
  26. package/dist/cjs/factories/shipengine/address.cjs +114 -0
  27. package/dist/cjs/factories/shipengine/money.cjs +21 -0
  28. package/dist/cjs/factories/shipengine/order-source.cjs +37 -0
  29. package/dist/cjs/factories/shipengine/package.cjs +41 -0
  30. package/dist/cjs/factories/shipengine/resource.cjs +23 -0
  31. package/dist/cjs/factories/shipengine/shipment.cjs +176 -0
  32. package/dist/cjs/factories/shipengine/weight.cjs +44 -0
  33. package/dist/cjs/factories/utils.cjs +19 -0
  34. package/dist/cjs/features/manage-carriers/hooks/use-list-funding-source-carriers.cjs +4 -6
  35. package/dist/cjs/features/manage-carriers/manage-carriers.cjs +8 -6
  36. package/dist/cjs/hooks/use-configure-shipment.cjs +3 -80
  37. package/dist/cjs/hooks/use-get-funding-source-insurance-provider.cjs +7 -7
  38. package/dist/cjs/hooks/use-manage-funding-source-insurance.cjs +15 -23
  39. package/dist/cjs/index.cjs +5 -0
  40. package/dist/cjs/locales/en/common.json.cjs +2 -2
  41. package/dist/cjs/locales/en/purchase-label.json.cjs +9 -8
  42. package/dist/cjs/package.json.cjs +1 -1
  43. package/dist/cjs/utilities/feature-flags/feature-flags.cjs +1 -0
  44. package/dist/cjs/utilities/shipengine/carrier.cjs +4 -0
  45. package/dist/cjs/utilities/shipengine/index.cjs +3 -0
  46. package/dist/cjs/utilities/shipengine/insurance.cjs +63 -0
  47. package/dist/cjs/workflows/label-workflow/label-workflow.cjs +2 -26
  48. package/dist/cjs/workflows/onboarding/components/confirmation-and-submission-step/use-confirmation-and-submission-step.cjs +9 -9
  49. package/dist/cjs/workflows/onboarding/components/terms-agreement-form/terms-agreement-form.cjs +3 -2
  50. package/dist/cjs/workflows/onboarding/components/terms-agreement-step/terms-agreement-step.cjs +8 -6
  51. package/dist/cjs/workflows/onboarding/components/terms-agreement-step/use-terms-agreement-step.cjs +4 -19
  52. package/dist/esm/assets/xcover/logo.svg.js +23 -0
  53. package/dist/esm/components/field/rate-select/rate-card/rate-attribute-item/index.js +1 -0
  54. package/dist/esm/components/field/rate-select/rate-card/rate-attribute-item/rate-attribute-item.js +54 -0
  55. package/dist/esm/components/field/rate-select/rate-card/rate-attribute-item/rate-attribute-item.styles.js +25 -0
  56. package/dist/esm/components/field/rate-select/rate-card/rate-card.js +52 -42
  57. package/dist/esm/components/field/rate-select/rate-card/rate-card.styles.js +4 -0
  58. package/dist/esm/components/field/rate-select/rate-select.js +80 -49
  59. package/dist/esm/components/forms/register-funding-source-insurance-form/register-funding-source-insurance-form.js +1 -1
  60. package/dist/esm/components/shipment-not-found-error/shipment-not-found-error.js +2 -17
  61. package/dist/esm/components/suspend-purchase/suspend-purchase.js +3 -3
  62. package/dist/esm/data/insurance-provider-metadatas.json.js +9 -4
  63. package/dist/esm/elements/customs-form/customs-form-element.js +291 -0
  64. package/dist/esm/elements/customs-form/customs-form-element.stories.js +232 -0
  65. package/dist/esm/elements/customs-form/customs-form-schema.js +56 -0
  66. package/dist/esm/elements/customs-form/customs-form-types.js +60 -0
  67. package/dist/esm/elements/customs-form/index.js +3 -0
  68. package/dist/esm/elements/index.js +3 -0
  69. package/dist/esm/elements/manage-carriers/manage-carriers.js +1 -1
  70. package/dist/esm/elements/purchase-label/components/customs-forms/tax-ids/tax-ids.js +1 -1
  71. package/dist/esm/elements/purchase-label/components/index.js +1 -0
  72. package/dist/esm/elements/purchase-label/components/rate-form/rate-view.js +1 -1
  73. package/dist/esm/elements/purchase-label/components/shipment-form/shipment-form.js +4 -3
  74. package/dist/esm/elements/purchase-label/hooks/use-filter-visible-rate-options/use-filter-visible-rate-options.js +35 -11
  75. package/dist/esm/elements/purchase-label/hooks/use-insurance-provider-options.js +2 -2
  76. package/dist/esm/elements/purchase-label/purchase-label.js +1 -7
  77. package/dist/esm/elements-provider/elements-context-provider.js +1 -1
  78. package/dist/esm/factories/shipengine/address.js +111 -0
  79. package/dist/esm/factories/shipengine/money.js +19 -0
  80. package/dist/esm/factories/shipengine/order-source.js +34 -0
  81. package/dist/esm/factories/shipengine/package.js +39 -0
  82. package/dist/esm/factories/shipengine/resource.js +21 -0
  83. package/dist/esm/factories/shipengine/shipment.js +168 -0
  84. package/dist/esm/factories/shipengine/weight.js +40 -0
  85. package/dist/esm/factories/utils.js +15 -0
  86. package/dist/esm/features/manage-carriers/hooks/use-list-funding-source-carriers.js +5 -7
  87. package/dist/esm/features/manage-carriers/manage-carriers.js +8 -6
  88. package/dist/esm/hooks/use-configure-shipment.js +3 -80
  89. package/dist/esm/hooks/use-get-funding-source-insurance-provider.js +7 -7
  90. package/dist/esm/hooks/use-manage-funding-source-insurance.js +15 -23
  91. package/dist/esm/index.js +3 -0
  92. package/dist/esm/locales/en/common.json.js +2 -2
  93. package/dist/esm/locales/en/purchase-label.json.js +9 -8
  94. package/dist/esm/package.json.js +1 -1
  95. package/dist/esm/utilities/feature-flags/feature-flags.js +1 -0
  96. package/dist/esm/utilities/shipengine/carrier.js +4 -0
  97. package/dist/esm/utilities/shipengine/index.js +1 -1
  98. package/dist/esm/utilities/shipengine/insurance.js +61 -1
  99. package/dist/esm/workflows/label-workflow/label-workflow.js +2 -26
  100. package/dist/esm/workflows/onboarding/components/confirmation-and-submission-step/use-confirmation-and-submission-step.js +9 -9
  101. package/dist/esm/workflows/onboarding/components/terms-agreement-form/terms-agreement-form.js +3 -2
  102. package/dist/esm/workflows/onboarding/components/terms-agreement-step/terms-agreement-step.js +8 -6
  103. package/dist/esm/workflows/onboarding/components/terms-agreement-step/use-terms-agreement-step.js +5 -20
  104. package/dist/types/components/field/rate-select/rate-card/rate-attribute-item/index.d.ts +2 -0
  105. package/dist/types/components/field/rate-select/rate-card/rate-attribute-item/index.d.ts.map +1 -0
  106. package/dist/types/components/field/rate-select/rate-card/rate-attribute-item/rate-attribute-item.d.ts +8 -0
  107. package/dist/types/components/field/rate-select/rate-card/rate-attribute-item/rate-attribute-item.d.ts.map +1 -0
  108. package/dist/types/components/field/rate-select/rate-card/rate-attribute-item/rate-attribute-item.styles.d.ts +22 -0
  109. package/dist/types/components/field/rate-select/rate-card/rate-attribute-item/rate-attribute-item.styles.d.ts.map +1 -0
  110. package/dist/types/components/field/rate-select/rate-card/rate-card.d.ts +3 -2
  111. package/dist/types/components/field/rate-select/rate-card/rate-card.d.ts.map +1 -1
  112. package/dist/types/components/field/rate-select/rate-card/rate-card.styles.d.ts +4 -0
  113. package/dist/types/components/field/rate-select/rate-card/rate-card.styles.d.ts.map +1 -1
  114. package/dist/types/components/field/rate-select/rate-select.d.ts.map +1 -1
  115. package/dist/types/components/forms/register-funding-source-insurance-form/register-funding-source-insurance-form.d.ts.map +1 -1
  116. package/dist/types/components/shipment-not-found-error/shipment-not-found-error.d.ts +2 -3
  117. package/dist/types/components/shipment-not-found-error/shipment-not-found-error.d.ts.map +1 -1
  118. package/dist/types/components/suspend-purchase/suspend-purchase.d.ts +2 -3
  119. package/dist/types/components/suspend-purchase/suspend-purchase.d.ts.map +1 -1
  120. package/dist/types/elements/customs-form/customs-form-element.d.ts +1219 -0
  121. package/dist/types/elements/customs-form/customs-form-element.d.ts.map +1 -0
  122. package/dist/types/elements/customs-form/customs-form-element.stories.d.ts +12 -0
  123. package/dist/types/elements/customs-form/customs-form-element.stories.d.ts.map +1 -0
  124. package/dist/types/elements/customs-form/customs-form-schema.d.ts +398 -0
  125. package/dist/types/elements/customs-form/customs-form-schema.d.ts.map +1 -0
  126. package/dist/types/elements/customs-form/customs-form-types.d.ts +139 -0
  127. package/dist/types/elements/customs-form/customs-form-types.d.ts.map +1 -0
  128. package/dist/types/elements/customs-form/index.d.ts +4 -0
  129. package/dist/types/elements/customs-form/index.d.ts.map +1 -0
  130. package/dist/types/elements/index.d.ts +1 -0
  131. package/dist/types/elements/index.d.ts.map +1 -1
  132. package/dist/types/elements/labels-grid/labels-grid.d.ts +9 -8
  133. package/dist/types/elements/labels-grid/labels-grid.d.ts.map +1 -1
  134. package/dist/types/elements/manage-carriers/manage-carriers.d.ts +9 -8
  135. package/dist/types/elements/manage-carriers/manage-carriers.d.ts.map +1 -1
  136. package/dist/types/elements/manage-external-carriers/manage-external-carriers.d.ts +9 -8
  137. package/dist/types/elements/manage-external-carriers/manage-external-carriers.d.ts.map +1 -1
  138. package/dist/types/elements/manage-funding/manage-funding-element.d.ts +9 -8
  139. package/dist/types/elements/manage-funding/manage-funding-element.d.ts.map +1 -1
  140. package/dist/types/elements/manage-warehouses/manage-warehouses.d.ts +9 -8
  141. package/dist/types/elements/manage-warehouses/manage-warehouses.d.ts.map +1 -1
  142. package/dist/types/elements/payment-method-settings/payment-method-settings-element.d.ts +9 -8
  143. package/dist/types/elements/payment-method-settings/payment-method-settings-element.d.ts.map +1 -1
  144. package/dist/types/elements/purchase-label/components/index.d.ts +1 -0
  145. package/dist/types/elements/purchase-label/components/index.d.ts.map +1 -1
  146. package/dist/types/elements/purchase-label/components/shipment-form/shipment-form.d.ts.map +1 -1
  147. package/dist/types/elements/purchase-label/hooks/use-filter-visible-rate-options/use-filter-visible-rate-options.d.ts +5 -1
  148. package/dist/types/elements/purchase-label/hooks/use-filter-visible-rate-options/use-filter-visible-rate-options.d.ts.map +1 -1
  149. package/dist/types/elements/purchase-label/hooks/use-insurance-provider-options.d.ts.map +1 -1
  150. package/dist/types/elements/purchase-label/purchase-label.d.ts +9 -8
  151. package/dist/types/elements/purchase-label/purchase-label.d.ts.map +1 -1
  152. package/dist/types/elements/select-label-layout/select-label-layout-element.d.ts +9 -8
  153. package/dist/types/elements/select-label-layout/select-label-layout-element.d.ts.map +1 -1
  154. package/dist/types/elements/shipment-summary/shipment-summary.d.ts +9 -8
  155. package/dist/types/elements/shipment-summary/shipment-summary.d.ts.map +1 -1
  156. package/dist/types/elements/shipments-grid/shipments-grid.d.ts +9 -8
  157. package/dist/types/elements/shipments-grid/shipments-grid.d.ts.map +1 -1
  158. package/dist/types/elements/theme-creator/theme-creator.d.ts +9 -8
  159. package/dist/types/elements/theme-creator/theme-creator.d.ts.map +1 -1
  160. package/dist/types/elements/transaction-history/transaction-history-element.d.ts +9 -8
  161. package/dist/types/elements/transaction-history/transaction-history-element.d.ts.map +1 -1
  162. package/dist/types/elements/unit-settings/unit-settings-element.d.ts +9 -8
  163. package/dist/types/elements/unit-settings/unit-settings-element.d.ts.map +1 -1
  164. package/dist/types/elements/vat-settings/vat-settings-element.d.ts +9 -8
  165. package/dist/types/elements/vat-settings/vat-settings-element.d.ts.map +1 -1
  166. package/dist/types/elements/void-label/void-label.d.ts +9 -8
  167. package/dist/types/elements/void-label/void-label.d.ts.map +1 -1
  168. package/dist/types/features/manage-carriers/hooks/use-list-funding-source-carriers.d.ts.map +1 -1
  169. package/dist/types/features/manage-carriers/manage-carriers.d.ts.map +1 -1
  170. package/dist/types/hooks/use-configure-shipment.d.ts.map +1 -1
  171. package/dist/types/hooks/use-get-funding-source-insurance-provider.d.ts.map +1 -1
  172. package/dist/types/hooks/use-manage-funding-source-insurance.d.ts +3 -4
  173. package/dist/types/hooks/use-manage-funding-source-insurance.d.ts.map +1 -1
  174. package/dist/types/locales/en/index.d.ts +9 -8
  175. package/dist/types/locales/en/index.d.ts.map +1 -1
  176. package/dist/types/types/insurance-metadata.d.ts +1 -1
  177. package/dist/types/types/insurance-metadata.d.ts.map +1 -1
  178. package/dist/types/types/rates.d.ts +1 -0
  179. package/dist/types/types/rates.d.ts.map +1 -1
  180. package/dist/types/utilities/feature-flags/feature-flags.d.ts.map +1 -1
  181. package/dist/types/utilities/feature-flags/types.d.ts +4 -0
  182. package/dist/types/utilities/feature-flags/types.d.ts.map +1 -1
  183. package/dist/types/utilities/shipengine/carrier.d.ts.map +1 -1
  184. package/dist/types/utilities/shipengine/insurance.d.ts +31 -0
  185. package/dist/types/utilities/shipengine/insurance.d.ts.map +1 -1
  186. package/dist/types/workflows/account-settings/account-settings.d.ts +9 -8
  187. package/dist/types/workflows/account-settings/account-settings.d.ts.map +1 -1
  188. package/dist/types/workflows/carrier-services/carrier-services.d.ts +9 -8
  189. package/dist/types/workflows/carrier-services/carrier-services.d.ts.map +1 -1
  190. package/dist/types/workflows/connect-external-carrier/connect-external-carrier.d.ts +9 -8
  191. package/dist/types/workflows/connect-external-carrier/connect-external-carrier.d.ts.map +1 -1
  192. package/dist/types/workflows/label-workflow/label-workflow.d.ts +9 -8
  193. package/dist/types/workflows/label-workflow/label-workflow.d.ts.map +1 -1
  194. package/dist/types/workflows/onboarding/components/confirmation-and-submission-step/use-confirmation-and-submission-step.d.ts.map +1 -1
  195. package/dist/types/workflows/onboarding/components/terms-agreement-step/terms-agreement-step.d.ts.map +1 -1
  196. package/dist/types/workflows/onboarding/components/terms-agreement-step/use-terms-agreement-step.d.ts +1 -5
  197. package/dist/types/workflows/onboarding/components/terms-agreement-step/use-terms-agreement-step.d.ts.map +1 -1
  198. package/dist/types/workflows/onboarding/onboarding.d.ts +9 -8
  199. package/dist/types/workflows/onboarding/onboarding.d.ts.map +1 -1
  200. package/package.json +3 -3
@@ -0,0 +1 @@
1
+ {"version":3,"file":"customs-form-element.d.ts","sourceRoot":"","sources":["../../../../src/elements/customs-form/customs-form-element.tsx"],"names":[],"mappings":"AAiBA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAG7D;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,eAAO,MAAM,SAAS;qJAUnB,gBAAgB;;CAwPlB,CAAC;AAIF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,eAAO,MAAM,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;sDAGlB,CAAC;AAEH;;;;GAIG;AACH,MAAM,MAAM,YAAY,GAAG,KAAK,CAAC,cAAc,CAAC,OAAO,OAAO,CAAC,CAAC"}
@@ -0,0 +1,12 @@
1
+ import type { Meta } from "@storybook/react";
2
+ import type { CustomsFormProps } from "./customs-form-types";
3
+ declare const _default: Meta<CustomsFormProps>;
4
+ export default _default;
5
+ export declare const Default: import("@storybook/core/csf").AnnotatedStoryFn<import("@storybook/react").ReactRenderer, CustomsFormProps>;
6
+ export declare const DomesticShipment: import("@storybook/core/csf").AnnotatedStoryFn<import("@storybook/react").ReactRenderer, CustomsFormProps>;
7
+ export declare const CanadaDeliveredDuty: import("@storybook/core/csf").AnnotatedStoryFn<import("@storybook/react").ReactRenderer, CustomsFormProps>;
8
+ export declare const WithWindsorFramework: import("@storybook/core/csf").AnnotatedStoryFn<import("@storybook/react").ReactRenderer, CustomsFormProps>;
9
+ export declare const WithExistingProducts: import("@storybook/core/csf").AnnotatedStoryFn<import("@storybook/react").ReactRenderer, CustomsFormProps>;
10
+ export declare const InteractiveExample: import("@storybook/core/csf").AnnotatedStoryFn<import("@storybook/react").ReactRenderer, CustomsFormProps>;
11
+ export declare const WithoutButtons: import("@storybook/core/csf").AnnotatedStoryFn<import("@storybook/react").ReactRenderer, CustomsFormProps>;
12
+ //# sourceMappingURL=customs-form-element.stories.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"customs-form-element.stories.d.ts","sourceRoot":"","sources":["../../../../src/elements/customs-form/customs-form-element.stories.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAW,MAAM,kBAAkB,CAAC;AAMtD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;wBAkDxD,IAAI,CAAC,gBAAgB,CAAC;AA/C3B,wBA+C4B;AA8B5B,eAAO,MAAM,OAAO,4GAAoB,CAAC;AAUzC,eAAO,MAAM,gBAAgB,4GAAoB,CAAC;AASlD,eAAO,MAAM,mBAAmB,4GAAoB,CAAC;AAwCrD,eAAO,MAAM,oBAAoB,4GAAoB,CAAC;AAyCtD,eAAO,MAAM,oBAAoB,4GAAoB,CAAC;AA6BtD,eAAO,MAAM,kBAAkB,4GAAoB,CAAC;AAuBpD,eAAO,MAAM,cAAc,4GAAoB,CAAC"}
@@ -0,0 +1,398 @@
1
+ import { SE } from "@shipengine/react-api";
2
+ import { CanadaDeliveredDutyOptions } from "@types";
3
+ import { z } from "zod";
4
+ type GetCustomsFormSchemaOptions = {
5
+ isCustomsRequired?: boolean;
6
+ requiresWindsorFramework?: boolean;
7
+ };
8
+ /**
9
+ * Creates a Zod schema for customs form data
10
+ */
11
+ export declare const getCustomsFormSchema: ({ isCustomsRequired, requiresWindsorFramework, }?: GetCustomsFormSchemaOptions) => z.ZodObject<{
12
+ customs: z.ZodObject<{
13
+ contents: z.ZodNativeEnum<typeof SE.CustomsContentsType>;
14
+ nonDelivery: z.ZodNativeEnum<typeof SE.CustomsNonDeliveryType>;
15
+ }, "strip", z.ZodTypeAny, {
16
+ contents: SE.CustomsContentsType;
17
+ nonDelivery: SE.CustomsNonDeliveryType;
18
+ }, {
19
+ contents: SE.CustomsContentsType;
20
+ nonDelivery: SE.CustomsNonDeliveryType;
21
+ }>;
22
+ products: z.ZodArray<z.ZodObject<{
23
+ countryOfOrigin: z.ZodEffects<z.ZodOptional<z.ZodNullable<z.ZodString>>, string | undefined, string | null | undefined>;
24
+ description: z.ZodEffects<z.ZodOptional<z.ZodNullable<z.ZodString>>, string | undefined, string | null | undefined>;
25
+ harmonizedTariffCode: z.ZodEffects<z.ZodOptional<z.ZodNullable<z.ZodString>>, string | undefined, string | null | undefined>;
26
+ quantity: z.ZodNumber;
27
+ value: z.ZodObject<{
28
+ amount: z.ZodNumber;
29
+ currency: z.ZodNativeEnum<typeof SE.Currency>;
30
+ }, "strip", z.ZodTypeAny, {
31
+ amount: number;
32
+ currency: SE.Currency;
33
+ }, {
34
+ amount: number;
35
+ currency: SE.Currency;
36
+ }>;
37
+ }, "strip", z.ZodTypeAny, {
38
+ value: {
39
+ amount: number;
40
+ currency: SE.Currency;
41
+ };
42
+ quantity: number;
43
+ countryOfOrigin?: string | undefined;
44
+ description?: string | undefined;
45
+ harmonizedTariffCode?: string | undefined;
46
+ }, {
47
+ value: {
48
+ amount: number;
49
+ currency: SE.Currency;
50
+ };
51
+ quantity: number;
52
+ countryOfOrigin?: string | null | undefined;
53
+ description?: string | null | undefined;
54
+ harmonizedTariffCode?: string | null | undefined;
55
+ }>, "many"> | z.ZodOptional<z.ZodArray<z.ZodObject<{
56
+ countryOfOrigin: z.ZodEffects<z.ZodOptional<z.ZodNullable<z.ZodString>>, string | undefined, string | null | undefined>;
57
+ description: z.ZodEffects<z.ZodOptional<z.ZodNullable<z.ZodString>>, string | undefined, string | null | undefined>;
58
+ harmonizedTariffCode: z.ZodEffects<z.ZodOptional<z.ZodNullable<z.ZodString>>, string | undefined, string | null | undefined>;
59
+ quantity: z.ZodNumber;
60
+ value: z.ZodObject<{
61
+ amount: z.ZodNumber;
62
+ currency: z.ZodNativeEnum<typeof SE.Currency>;
63
+ }, "strip", z.ZodTypeAny, {
64
+ amount: number;
65
+ currency: SE.Currency;
66
+ }, {
67
+ amount: number;
68
+ currency: SE.Currency;
69
+ }>;
70
+ }, "strip", z.ZodTypeAny, {
71
+ value: {
72
+ amount: number;
73
+ currency: SE.Currency;
74
+ };
75
+ quantity: number;
76
+ countryOfOrigin?: string | undefined;
77
+ description?: string | undefined;
78
+ harmonizedTariffCode?: string | undefined;
79
+ }, {
80
+ value: {
81
+ amount: number;
82
+ currency: SE.Currency;
83
+ };
84
+ quantity: number;
85
+ countryOfOrigin?: string | null | undefined;
86
+ description?: string | null | undefined;
87
+ harmonizedTariffCode?: string | null | undefined;
88
+ }>, "many">>;
89
+ taxIdentifiers: z.ZodOptional<z.ZodArray<z.ZodAny, "many">>;
90
+ advancedOptions: z.ZodOptional<z.ZodObject<{
91
+ canadaDeliveredDuty: z.ZodOptional<z.ZodNullable<z.ZodNativeEnum<typeof CanadaDeliveredDutyOptions>>>;
92
+ windsorFrameworkDetails: z.ZodObject<{
93
+ movementIndicator: z.ZodNativeEnum<typeof SE.MovementIndicator>;
94
+ notAtRisk: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
95
+ }, "strip", z.ZodTypeAny, {
96
+ movementIndicator: SE.MovementIndicator;
97
+ notAtRisk: boolean;
98
+ }, {
99
+ movementIndicator: SE.MovementIndicator;
100
+ notAtRisk?: boolean | undefined;
101
+ }> | z.ZodOptional<z.ZodObject<{
102
+ movementIndicator: z.ZodNativeEnum<typeof SE.MovementIndicator>;
103
+ notAtRisk: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
104
+ }, "strip", z.ZodTypeAny, {
105
+ movementIndicator: SE.MovementIndicator;
106
+ notAtRisk: boolean;
107
+ }, {
108
+ movementIndicator: SE.MovementIndicator;
109
+ notAtRisk?: boolean | undefined;
110
+ }>>;
111
+ }, "strip", z.ZodTypeAny, {
112
+ canadaDeliveredDuty?: CanadaDeliveredDutyOptions | null | undefined;
113
+ windsorFrameworkDetails?: {
114
+ movementIndicator: SE.MovementIndicator;
115
+ notAtRisk: boolean;
116
+ } | {
117
+ movementIndicator: SE.MovementIndicator;
118
+ notAtRisk: boolean;
119
+ } | undefined;
120
+ }, {
121
+ canadaDeliveredDuty?: CanadaDeliveredDutyOptions | null | undefined;
122
+ windsorFrameworkDetails?: {
123
+ movementIndicator: SE.MovementIndicator;
124
+ notAtRisk?: boolean | undefined;
125
+ } | {
126
+ movementIndicator: SE.MovementIndicator;
127
+ notAtRisk?: boolean | undefined;
128
+ } | undefined;
129
+ }>>;
130
+ }, "strip", z.ZodTypeAny, {
131
+ customs: {
132
+ contents: SE.CustomsContentsType;
133
+ nonDelivery: SE.CustomsNonDeliveryType;
134
+ };
135
+ products?: {
136
+ value: {
137
+ amount: number;
138
+ currency: SE.Currency;
139
+ };
140
+ quantity: number;
141
+ countryOfOrigin?: string | undefined;
142
+ description?: string | undefined;
143
+ harmonizedTariffCode?: string | undefined;
144
+ }[] | {
145
+ value: {
146
+ amount: number;
147
+ currency: SE.Currency;
148
+ };
149
+ quantity: number;
150
+ countryOfOrigin?: string | undefined;
151
+ description?: string | undefined;
152
+ harmonizedTariffCode?: string | undefined;
153
+ }[] | undefined;
154
+ taxIdentifiers?: any[] | undefined;
155
+ advancedOptions?: {
156
+ canadaDeliveredDuty?: CanadaDeliveredDutyOptions | null | undefined;
157
+ windsorFrameworkDetails?: {
158
+ movementIndicator: SE.MovementIndicator;
159
+ notAtRisk: boolean;
160
+ } | {
161
+ movementIndicator: SE.MovementIndicator;
162
+ notAtRisk: boolean;
163
+ } | undefined;
164
+ } | undefined;
165
+ }, {
166
+ customs: {
167
+ contents: SE.CustomsContentsType;
168
+ nonDelivery: SE.CustomsNonDeliveryType;
169
+ };
170
+ products?: {
171
+ value: {
172
+ amount: number;
173
+ currency: SE.Currency;
174
+ };
175
+ quantity: number;
176
+ countryOfOrigin?: string | null | undefined;
177
+ description?: string | null | undefined;
178
+ harmonizedTariffCode?: string | null | undefined;
179
+ }[] | {
180
+ value: {
181
+ amount: number;
182
+ currency: SE.Currency;
183
+ };
184
+ quantity: number;
185
+ countryOfOrigin?: string | null | undefined;
186
+ description?: string | null | undefined;
187
+ harmonizedTariffCode?: string | null | undefined;
188
+ }[] | undefined;
189
+ taxIdentifiers?: any[] | undefined;
190
+ advancedOptions?: {
191
+ canadaDeliveredDuty?: CanadaDeliveredDutyOptions | null | undefined;
192
+ windsorFrameworkDetails?: {
193
+ movementIndicator: SE.MovementIndicator;
194
+ notAtRisk?: boolean | undefined;
195
+ } | {
196
+ movementIndicator: SE.MovementIndicator;
197
+ notAtRisk?: boolean | undefined;
198
+ } | undefined;
199
+ } | undefined;
200
+ }>;
201
+ type CustomsFormSchema = ReturnType<typeof getCustomsFormSchema>;
202
+ export type CustomsFormFields = z.input<CustomsFormSchema>;
203
+ export type CustomsFormPayload = z.output<CustomsFormSchema>;
204
+ /**
205
+ * Default schema for customs forms
206
+ */
207
+ export declare const defaultCustomsFormSchema: z.ZodObject<{
208
+ customs: z.ZodObject<{
209
+ contents: z.ZodNativeEnum<typeof SE.CustomsContentsType>;
210
+ nonDelivery: z.ZodNativeEnum<typeof SE.CustomsNonDeliveryType>;
211
+ }, "strip", z.ZodTypeAny, {
212
+ contents: SE.CustomsContentsType;
213
+ nonDelivery: SE.CustomsNonDeliveryType;
214
+ }, {
215
+ contents: SE.CustomsContentsType;
216
+ nonDelivery: SE.CustomsNonDeliveryType;
217
+ }>;
218
+ products: z.ZodArray<z.ZodObject<{
219
+ countryOfOrigin: z.ZodEffects<z.ZodOptional<z.ZodNullable<z.ZodString>>, string | undefined, string | null | undefined>;
220
+ description: z.ZodEffects<z.ZodOptional<z.ZodNullable<z.ZodString>>, string | undefined, string | null | undefined>;
221
+ harmonizedTariffCode: z.ZodEffects<z.ZodOptional<z.ZodNullable<z.ZodString>>, string | undefined, string | null | undefined>;
222
+ quantity: z.ZodNumber;
223
+ value: z.ZodObject<{
224
+ amount: z.ZodNumber;
225
+ currency: z.ZodNativeEnum<typeof SE.Currency>;
226
+ }, "strip", z.ZodTypeAny, {
227
+ amount: number;
228
+ currency: SE.Currency;
229
+ }, {
230
+ amount: number;
231
+ currency: SE.Currency;
232
+ }>;
233
+ }, "strip", z.ZodTypeAny, {
234
+ value: {
235
+ amount: number;
236
+ currency: SE.Currency;
237
+ };
238
+ quantity: number;
239
+ countryOfOrigin?: string | undefined;
240
+ description?: string | undefined;
241
+ harmonizedTariffCode?: string | undefined;
242
+ }, {
243
+ value: {
244
+ amount: number;
245
+ currency: SE.Currency;
246
+ };
247
+ quantity: number;
248
+ countryOfOrigin?: string | null | undefined;
249
+ description?: string | null | undefined;
250
+ harmonizedTariffCode?: string | null | undefined;
251
+ }>, "many"> | z.ZodOptional<z.ZodArray<z.ZodObject<{
252
+ countryOfOrigin: z.ZodEffects<z.ZodOptional<z.ZodNullable<z.ZodString>>, string | undefined, string | null | undefined>;
253
+ description: z.ZodEffects<z.ZodOptional<z.ZodNullable<z.ZodString>>, string | undefined, string | null | undefined>;
254
+ harmonizedTariffCode: z.ZodEffects<z.ZodOptional<z.ZodNullable<z.ZodString>>, string | undefined, string | null | undefined>;
255
+ quantity: z.ZodNumber;
256
+ value: z.ZodObject<{
257
+ amount: z.ZodNumber;
258
+ currency: z.ZodNativeEnum<typeof SE.Currency>;
259
+ }, "strip", z.ZodTypeAny, {
260
+ amount: number;
261
+ currency: SE.Currency;
262
+ }, {
263
+ amount: number;
264
+ currency: SE.Currency;
265
+ }>;
266
+ }, "strip", z.ZodTypeAny, {
267
+ value: {
268
+ amount: number;
269
+ currency: SE.Currency;
270
+ };
271
+ quantity: number;
272
+ countryOfOrigin?: string | undefined;
273
+ description?: string | undefined;
274
+ harmonizedTariffCode?: string | undefined;
275
+ }, {
276
+ value: {
277
+ amount: number;
278
+ currency: SE.Currency;
279
+ };
280
+ quantity: number;
281
+ countryOfOrigin?: string | null | undefined;
282
+ description?: string | null | undefined;
283
+ harmonizedTariffCode?: string | null | undefined;
284
+ }>, "many">>;
285
+ taxIdentifiers: z.ZodOptional<z.ZodArray<z.ZodAny, "many">>;
286
+ advancedOptions: z.ZodOptional<z.ZodObject<{
287
+ canadaDeliveredDuty: z.ZodOptional<z.ZodNullable<z.ZodNativeEnum<typeof CanadaDeliveredDutyOptions>>>;
288
+ windsorFrameworkDetails: z.ZodObject<{
289
+ movementIndicator: z.ZodNativeEnum<typeof SE.MovementIndicator>;
290
+ notAtRisk: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
291
+ }, "strip", z.ZodTypeAny, {
292
+ movementIndicator: SE.MovementIndicator;
293
+ notAtRisk: boolean;
294
+ }, {
295
+ movementIndicator: SE.MovementIndicator;
296
+ notAtRisk?: boolean | undefined;
297
+ }> | z.ZodOptional<z.ZodObject<{
298
+ movementIndicator: z.ZodNativeEnum<typeof SE.MovementIndicator>;
299
+ notAtRisk: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
300
+ }, "strip", z.ZodTypeAny, {
301
+ movementIndicator: SE.MovementIndicator;
302
+ notAtRisk: boolean;
303
+ }, {
304
+ movementIndicator: SE.MovementIndicator;
305
+ notAtRisk?: boolean | undefined;
306
+ }>>;
307
+ }, "strip", z.ZodTypeAny, {
308
+ canadaDeliveredDuty?: CanadaDeliveredDutyOptions | null | undefined;
309
+ windsorFrameworkDetails?: {
310
+ movementIndicator: SE.MovementIndicator;
311
+ notAtRisk: boolean;
312
+ } | {
313
+ movementIndicator: SE.MovementIndicator;
314
+ notAtRisk: boolean;
315
+ } | undefined;
316
+ }, {
317
+ canadaDeliveredDuty?: CanadaDeliveredDutyOptions | null | undefined;
318
+ windsorFrameworkDetails?: {
319
+ movementIndicator: SE.MovementIndicator;
320
+ notAtRisk?: boolean | undefined;
321
+ } | {
322
+ movementIndicator: SE.MovementIndicator;
323
+ notAtRisk?: boolean | undefined;
324
+ } | undefined;
325
+ }>>;
326
+ }, "strip", z.ZodTypeAny, {
327
+ customs: {
328
+ contents: SE.CustomsContentsType;
329
+ nonDelivery: SE.CustomsNonDeliveryType;
330
+ };
331
+ products?: {
332
+ value: {
333
+ amount: number;
334
+ currency: SE.Currency;
335
+ };
336
+ quantity: number;
337
+ countryOfOrigin?: string | undefined;
338
+ description?: string | undefined;
339
+ harmonizedTariffCode?: string | undefined;
340
+ }[] | {
341
+ value: {
342
+ amount: number;
343
+ currency: SE.Currency;
344
+ };
345
+ quantity: number;
346
+ countryOfOrigin?: string | undefined;
347
+ description?: string | undefined;
348
+ harmonizedTariffCode?: string | undefined;
349
+ }[] | undefined;
350
+ taxIdentifiers?: any[] | undefined;
351
+ advancedOptions?: {
352
+ canadaDeliveredDuty?: CanadaDeliveredDutyOptions | null | undefined;
353
+ windsorFrameworkDetails?: {
354
+ movementIndicator: SE.MovementIndicator;
355
+ notAtRisk: boolean;
356
+ } | {
357
+ movementIndicator: SE.MovementIndicator;
358
+ notAtRisk: boolean;
359
+ } | undefined;
360
+ } | undefined;
361
+ }, {
362
+ customs: {
363
+ contents: SE.CustomsContentsType;
364
+ nonDelivery: SE.CustomsNonDeliveryType;
365
+ };
366
+ products?: {
367
+ value: {
368
+ amount: number;
369
+ currency: SE.Currency;
370
+ };
371
+ quantity: number;
372
+ countryOfOrigin?: string | null | undefined;
373
+ description?: string | null | undefined;
374
+ harmonizedTariffCode?: string | null | undefined;
375
+ }[] | {
376
+ value: {
377
+ amount: number;
378
+ currency: SE.Currency;
379
+ };
380
+ quantity: number;
381
+ countryOfOrigin?: string | null | undefined;
382
+ description?: string | null | undefined;
383
+ harmonizedTariffCode?: string | null | undefined;
384
+ }[] | undefined;
385
+ taxIdentifiers?: any[] | undefined;
386
+ advancedOptions?: {
387
+ canadaDeliveredDuty?: CanadaDeliveredDutyOptions | null | undefined;
388
+ windsorFrameworkDetails?: {
389
+ movementIndicator: SE.MovementIndicator;
390
+ notAtRisk?: boolean | undefined;
391
+ } | {
392
+ movementIndicator: SE.MovementIndicator;
393
+ notAtRisk?: boolean | undefined;
394
+ } | undefined;
395
+ } | undefined;
396
+ }>;
397
+ export {};
398
+ //# sourceMappingURL=customs-form-schema.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"customs-form-schema.d.ts","sourceRoot":"","sources":["../../../../src/elements/customs-form/customs-form-schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,EAAE,MAAM,uBAAuB,CAAC;AAC3C,OAAO,EAAE,0BAA0B,EAAE,MAAM,QAAQ,CAAC;AACpD,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAOxB,KAAK,2BAA2B,GAAG;IACjC,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,wBAAwB,CAAC,EAAE,OAAO,CAAC;CACpC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,oBAAoB,GAAI,mDAGlC,2BAAgC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAiDlC,CAAC;AAEF,KAAK,iBAAiB,GAAG,UAAU,CAAC,OAAO,oBAAoB,CAAC,CAAC;AACjE,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;AAC3D,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC;AAE7D;;GAEG;AACH,eAAO,MAAM,wBAAwB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAGnC,CAAC"}
@@ -0,0 +1,139 @@
1
+ import { SE } from "@shipengine/react-api";
2
+ import { CanadaDeliveredDutyOptions } from "@types";
3
+ import type { HarmonizedTariffCode } from "@types";
4
+ /**
5
+ * # Customs Form Data
6
+ *
7
+ * - Customs form data structure that maps directly to `SalesOrderShipment` fields.
8
+ * This allows the form data to be destructured into a `SalesOrderShipment` for updates.
9
+ *
10
+ * @see {@link CustomsForm.Element | This type is used in the `<CustomsForm.Element />` component}
11
+ */
12
+ export interface CustomsFormData {
13
+ /**
14
+ * The contents and non-delivery options for the customs form
15
+ */
16
+ customs: {
17
+ /**
18
+ * The type of contents in the shipment (e.g., MERCHANDISE, GIFT, DOCUMENTS, etc.)
19
+ */
20
+ contents: SE.CustomsContentsType;
21
+ /**
22
+ * What to do with the package if it cannot be delivered (e.g., RETURN_TO_SENDER, TREAT_AS_ABANDONED)
23
+ */
24
+ nonDelivery: SE.CustomsNonDeliveryType;
25
+ };
26
+ /**
27
+ * Array of products/items included in the shipment
28
+ */
29
+ products: SE.Product[];
30
+ /**
31
+ * Optional tax identifiers for the shipment (e.g., VAT, EORI numbers)
32
+ */
33
+ taxIdentifiers?: SE.TaxIdentifier[];
34
+ /**
35
+ * Advanced customs options
36
+ */
37
+ advancedOptions?: {
38
+ /**
39
+ * Canada Delivered Duty Paid (DDP) option - specifies who pays duties/taxes at the border
40
+ */
41
+ canadaDeliveredDuty?: CanadaDeliveredDutyOptions | null;
42
+ /**
43
+ * Windsor Framework details for UK-EU shipments post-Brexit
44
+ */
45
+ windsorFrameworkDetails?: {
46
+ /**
47
+ * Movement indicator for Windsor Framework compliance
48
+ */
49
+ movementIndicator: SE.MovementIndicator;
50
+ /**
51
+ * Whether goods are "not at risk" of moving into the EU
52
+ */
53
+ notAtRisk?: boolean;
54
+ };
55
+ };
56
+ }
57
+ /**
58
+ * # Customs Form Element Component Props
59
+ *
60
+ * - These are the props that will be passed into the `<CustomsForm />` component.
61
+ *
62
+ * @see {@link CustomsForm.Component | This prop types usage in `<CustomsForm />` component}
63
+ */
64
+ export interface CustomsFormProps {
65
+ /**
66
+ * The shipment data to populate the customs form with. This should be a `SalesOrderShipment`
67
+ * object that contains the shipment details, addresses, and any existing customs information.
68
+ */
69
+ shipment: SE.SalesOrderShipment;
70
+ /**
71
+ * Enable Windsor Framework features for UK to Northern Ireland shipments post-Brexit.
72
+ * When enabled, additional fields for Windsor Framework compliance will be shown.
73
+ */
74
+ betaEnableWindsorFramework?: boolean;
75
+ /**
76
+ * The currency to use for monetary values in the customs form (e.g., product values).
77
+ * This should match the currency of the shipment.
78
+ */
79
+ currency: SE.Currency;
80
+ /**
81
+ * An array of Harmonized Tariff System (HTS) codes to populate the HS Code dropdown
82
+ * in the product form. These codes classify goods for international trade.
83
+ */
84
+ harmonizedTariffCodes?: HarmonizedTariffCode[];
85
+ /**
86
+ * `onModify` is a callback function that will be invoked each time the customs form data
87
+ * changes. This allows you to track form modifications in real-time.
88
+ */
89
+ onModify?: (formData: CustomsFormData) => void;
90
+ /**
91
+ * `onSubmit` is an async/sync callback function that will be invoked when the form is
92
+ * submitted. This is optional - if not provided, the form will not show a submit button.
93
+ */
94
+ onSubmit?: (formData: CustomsFormData) => Promise<void> | void;
95
+ /**
96
+ * `onCancel` is a callback function that will be invoked when the user clicks the cancel button.
97
+ * This is optional - if not provided, the cancel button will not be shown.
98
+ */
99
+ onCancel?: () => void;
100
+ /**
101
+ * Optional CSS class name to apply to the root element for custom styling
102
+ */
103
+ className?: string;
104
+ /**
105
+ * Optional data-testid attribute for testing purposes
106
+ */
107
+ "data-testid"?: string;
108
+ }
109
+ /**
110
+ * Extracts customs form data from a `SalesOrderShipment` object.
111
+ *
112
+ * - This utility function transforms a `SalesOrderShipment` (or `Shipment`) into the `CustomsFormData`
113
+ * structure used by the `CustomsForm`. It extracts products from the first package and gathers
114
+ * all relevant customs information into a flat structure.
115
+ *
116
+ * @param shipment - The `SalesOrderShipment` to extract customs data from
117
+ * @returns CustomsFormData object containing customs information
118
+ *
119
+ * @example
120
+ * ```tsx
121
+ * const customsData = extractCustomsFormData(shipment);
122
+ * ```
123
+ *
124
+ * @see {@link CustomsFormData | The structure of the returned data}
125
+ */
126
+ export declare const extractCustomsFormData: (shipment: SE.SalesOrderShipment) => CustomsFormData;
127
+ /**
128
+ * Returns default values for a new customs form.
129
+ *
130
+ * - Use this utility function when you need to initialize a customs form with sensible defaults
131
+ * before any shipment data is available. Sets MERCHANDISE as contents type and RETURN_TO_SENDER
132
+ * as the non-delivery option.
133
+ *
134
+ * @returns CustomsFormData object with default values
135
+ *
136
+ * @see {@link CustomsFormData | The structure of the returned data}
137
+ */
138
+ export declare const getDefaultCustomsFormValues: () => CustomsFormData;
139
+ //# sourceMappingURL=customs-form-types.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"customs-form-types.d.ts","sourceRoot":"","sources":["../../../../src/elements/customs-form/customs-form-types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,EAAE,MAAM,uBAAuB,CAAC;AAC3C,OAAO,EAAE,0BAA0B,EAAE,MAAM,QAAQ,CAAC;AACpD,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,QAAQ,CAAC;AAEnD;;;;;;;GAOG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,OAAO,EAAE;QACP;;WAEG;QACH,QAAQ,EAAE,EAAE,CAAC,mBAAmB,CAAC;QACjC;;WAEG;QACH,WAAW,EAAE,EAAE,CAAC,sBAAsB,CAAC;KACxC,CAAC;IACF;;OAEG;IACH,QAAQ,EAAE,EAAE,CAAC,OAAO,EAAE,CAAC;IACvB;;OAEG;IACH,cAAc,CAAC,EAAE,EAAE,CAAC,aAAa,EAAE,CAAC;IACpC;;OAEG;IACH,eAAe,CAAC,EAAE;QAChB;;WAEG;QACH,mBAAmB,CAAC,EAAE,0BAA0B,GAAG,IAAI,CAAC;QACxD;;WAEG;QACH,uBAAuB,CAAC,EAAE;YACxB;;eAEG;YACH,iBAAiB,EAAE,EAAE,CAAC,iBAAiB,CAAC;YACxC;;eAEG;YACH,SAAS,CAAC,EAAE,OAAO,CAAC;SACrB,CAAC;KACH,CAAC;CACH;AAED;;;;;;GAMG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;;OAGG;IACH,QAAQ,EAAE,EAAE,CAAC,kBAAkB,CAAC;IAEhC;;;OAGG;IACH,0BAA0B,CAAC,EAAE,OAAO,CAAC;IAErC;;;OAGG;IACH,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC;IAEtB;;;OAGG;IACH,qBAAqB,CAAC,EAAE,oBAAoB,EAAE,CAAC;IAE/C;;;OAGG;IACH,QAAQ,CAAC,EAAE,CAAC,QAAQ,EAAE,eAAe,KAAK,IAAI,CAAC;IAE/C;;;OAGG;IACH,QAAQ,CAAC,EAAE,CAAC,QAAQ,EAAE,eAAe,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;IAE/D;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,IAAI,CAAC;IAEtB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,sBAAsB,GAAI,UAAU,EAAE,CAAC,kBAAkB,KAAG,eAqBxE,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,2BAA2B,QAAO,eAS7C,CAAC"}
@@ -0,0 +1,4 @@
1
+ export * as CustomsForm from "./customs-form-element";
2
+ export type { CustomsFormData, CustomsFormProps } from "./customs-form-types";
3
+ export { extractCustomsFormData, getDefaultCustomsFormValues } from "./customs-form-types";
4
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/elements/customs-form/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,WAAW,MAAM,wBAAwB,CAAC;AACtD,YAAY,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAC9E,OAAO,EAAE,sBAAsB,EAAE,2BAA2B,EAAE,MAAM,sBAAsB,CAAC"}
@@ -14,4 +14,5 @@ export * from "./payment-method-settings";
14
14
  export * from "./select-label-layout";
15
15
  export * from "../workflows/carrier-services";
16
16
  export * from "./transaction-history";
17
+ export * from "./customs-form";
17
18
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/elements/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAC;AAClC,cAAc,qBAAqB,CAAC;AACpC,cAAc,kBAAkB,CAAC;AACjC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,eAAe,CAAC;AAC9B,cAAc,kBAAkB,CAAC;AACjC,cAAc,iBAAiB,CAAC;AAChC,cAAc,oBAAoB,CAAC;AACnC,cAAc,cAAc,CAAC;AAC7B,cAAc,iBAAiB,CAAC;AAChC,cAAc,kBAAkB,CAAC;AACjC,cAAc,uBAAuB,CAAC;AACtC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,uBAAuB,CAAC;AACtC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,uBAAuB,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/elements/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAC;AAClC,cAAc,qBAAqB,CAAC;AACpC,cAAc,kBAAkB,CAAC;AACjC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,eAAe,CAAC;AAC9B,cAAc,kBAAkB,CAAC;AACjC,cAAc,iBAAiB,CAAC;AAChC,cAAc,oBAAoB,CAAC;AACnC,cAAc,cAAc,CAAC;AAC7B,cAAc,iBAAiB,CAAC;AAChC,cAAc,kBAAkB,CAAC;AACjC,cAAc,uBAAuB,CAAC;AACtC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,uBAAuB,CAAC;AACtC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,uBAAuB,CAAC;AACtC,cAAc,gBAAgB,CAAC"}
@@ -339,13 +339,6 @@ export declare const Element: ({ resources, ...props }: LabelsGridProps & import
339
339
  saveRateFailedMessage: string;
340
340
  saveRateFailedTitle: string;
341
341
  };
342
- identifierTypes: {
343
- externalOrderId: string;
344
- externalOrderNumber: string;
345
- externalShipmentId: string;
346
- salesOrderId: string;
347
- shipmentId: string;
348
- };
349
342
  errorTypes: {
350
343
  results: string;
351
344
  };
@@ -408,6 +401,14 @@ export declare const Element: ({ resources, ...props }: LabelsGridProps & import
408
401
  upsGroundSaverTermsAcknowledgement: string;
409
402
  dhlExpressTermsAcknowledgement: string;
410
403
  noRateService: string;
404
+ rateAttributes: {
405
+ bestValue: string;
406
+ cheapest: string;
407
+ fastest: string;
408
+ bestValueTooltip: string;
409
+ cheapestTooltip: string;
410
+ fastestTooltip: string;
411
+ };
411
412
  };
412
413
  windsorFramework: {
413
414
  movementIndicator: string;
@@ -1035,7 +1036,7 @@ export declare const Element: ({ resources, ...props }: LabelsGridProps & import
1035
1036
  parcelguard: string;
1036
1037
  shipsurance: string;
1037
1038
  thirdParty: string;
1038
- x_cover: string;
1039
+ xCover: string;
1039
1040
  };
1040
1041
  loading: {
1041
1042
  accountSettings: string;
@@ -1 +1 @@
1
- {"version":3,"file":"labels-grid.d.ts","sourceRoot":"","sources":["../../../../src/elements/labels-grid/labels-grid.tsx"],"names":[],"mappings":"AAiBA,OAAO,KAAK,EAAgB,EAAE,EAAE,MAAM,uBAAuB,CAAC;AAC9D,OAAO,KAAK,EAGV,kBAAkB,EACnB,MAAM,0BAA0B,CAAC;AAWlC,MAAM,MAAM,eAAe,GAAG;IAC5B;;;OAGG;IACH,QAAQ,CAAC,EAAE,kBAAkB,CAAC;IAC9B;;;OAGG;IACH,WAAW,CAAC,EAAE,EAAE,CAAC,WAAW,CAAC;IAC7B;;;OAGG;IACH,sBAAsB,CAAC,EAAE,CAAC,eAAe,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC;IAC5D;;;OAGG;IACH,yBAAyB,CAAC,EAAE,CAAC,kBAAkB,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC;IAClE;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,IAAI,CAAC;IAC/B;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,IAAI,CAAC;IAC/B;;;OAGG;IACH,qBAAqB,CAAC,EAAE,CAAC,cAAc,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC;IAC1D;;;OAGG;IACH,qBAAqB,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,KAAK,IAAI,CAAC;IAC/F;;;OAGG;IACH,kBAAkB,CAAC,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,IAAI,CAAC;IAC/C;;;OAGG;IACH,gBAAgB,CAAC,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,IAAI,CAAC;IAC7C;;OAEG;IACH,UAAU,CAAC,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,IAAI,CAAC;IACvC;;OAEG;IACH,sBAAsB,CAAC,EAAE,MAAM,IAAI,CAAC;CACrC,CAAC;AAEF,MAAM,MAAM,KAAK,GAAG,EAAE,CAAC,KAAK,GAAG;IAAE,WAAW,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI,CAAA;CAAE,CAAC;AAgB1E,eAAO,MAAM,SAAS,GAAI,6OAavB,eAAe,qDAqgBjB,CAAC;AAEF,eAAO,MAAM,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;sDAGlB,CAAC;AAEH,MAAM,MAAM,YAAY,GAAG,KAAK,CAAC,cAAc,CAAC,OAAO,OAAO,CAAC,CAAC"}
1
+ {"version":3,"file":"labels-grid.d.ts","sourceRoot":"","sources":["../../../../src/elements/labels-grid/labels-grid.tsx"],"names":[],"mappings":"AAiBA,OAAO,KAAK,EAAgB,EAAE,EAAE,MAAM,uBAAuB,CAAC;AAC9D,OAAO,KAAK,EAGV,kBAAkB,EACnB,MAAM,0BAA0B,CAAC;AAWlC,MAAM,MAAM,eAAe,GAAG;IAC5B;;;OAGG;IACH,QAAQ,CAAC,EAAE,kBAAkB,CAAC;IAC9B;;;OAGG;IACH,WAAW,CAAC,EAAE,EAAE,CAAC,WAAW,CAAC;IAC7B;;;OAGG;IACH,sBAAsB,CAAC,EAAE,CAAC,eAAe,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC;IAC5D;;;OAGG;IACH,yBAAyB,CAAC,EAAE,CAAC,kBAAkB,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC;IAClE;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,IAAI,CAAC;IAC/B;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,IAAI,CAAC;IAC/B;;;OAGG;IACH,qBAAqB,CAAC,EAAE,CAAC,cAAc,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC;IAC1D;;;OAGG;IACH,qBAAqB,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,KAAK,IAAI,CAAC;IAC/F;;;OAGG;IACH,kBAAkB,CAAC,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,IAAI,CAAC;IAC/C;;;OAGG;IACH,gBAAgB,CAAC,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,IAAI,CAAC;IAC7C;;OAEG;IACH,UAAU,CAAC,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,IAAI,CAAC;IACvC;;OAEG;IACH,sBAAsB,CAAC,EAAE,MAAM,IAAI,CAAC;CACrC,CAAC;AAEF,MAAM,MAAM,KAAK,GAAG,EAAE,CAAC,KAAK,GAAG;IAAE,WAAW,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI,CAAA;CAAE,CAAC;AAgB1E,eAAO,MAAM,SAAS,GAAI,6OAavB,eAAe,qDAqgBjB,CAAC;AAEF,eAAO,MAAM,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;sDAGlB,CAAC;AAEH,MAAM,MAAM,YAAY,GAAG,KAAK,CAAC,cAAc,CAAC,OAAO,OAAO,CAAC,CAAC"}