@shipengine/elements 0.11.1 → 0.13.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 (242) hide show
  1. package/components/accordion/accordion.d.ts +12 -0
  2. package/components/accordion/accordion.styles.d.ts +7 -0
  3. package/components/accordion/index.d.ts +1 -0
  4. package/components/button-group/button-group.d.ts +7 -0
  5. package/components/button-group/index.d.ts +1 -0
  6. package/components/cube/cube.d.ts +5 -0
  7. package/components/cube/index.d.ts +1 -0
  8. package/components/disclosure/disclosure.d.ts +9 -0
  9. package/components/disclosure/disclosure.styles.d.ts +1 -0
  10. package/components/disclosure/index.d.ts +1 -0
  11. package/components/error-boundary/error-boundary.d.ts +31 -0
  12. package/components/error-boundary/index.d.ts +1 -0
  13. package/components/field/checkbox-input/checkbox-input.d.ts +6 -0
  14. package/components/field/checkbox-input/index.d.ts +1 -0
  15. package/components/field/create-field-controller.d.ts +23 -0
  16. package/components/field/date-picker/date-picker.d.ts +7 -0
  17. package/components/field/date-picker/date-picker.styles.d.ts +3 -0
  18. package/components/field/date-picker/index.d.ts +1 -0
  19. package/components/field/field.styles.d.ts +7 -0
  20. package/components/field/fields.d.ts +11 -0
  21. package/components/field/index.d.ts +1 -0
  22. package/components/field/input-group/index.d.ts +1 -0
  23. package/components/field/input-group/input-group.d.ts +13 -0
  24. package/components/field/input-group/input-group.styles.d.ts +2 -0
  25. package/components/field/money-input/hooks/index.d.ts +1 -0
  26. package/components/field/money-input/hooks/use-utils.d.ts +6 -0
  27. package/components/field/money-input/index.d.ts +1 -0
  28. package/components/field/money-input/money-input-styles.d.ts +2 -0
  29. package/components/field/money-input/money-input.d.ts +30 -0
  30. package/components/field/number-input/index.d.ts +1 -0
  31. package/components/field/number-input/number-input.d.ts +10 -0
  32. package/components/field/rate-card/cost-breakdown/cost-breakdown.d.ts +11 -0
  33. package/components/field/rate-card/cost-breakdown/cost-breakdown.styles.d.ts +6 -0
  34. package/components/field/rate-card/cost-breakdown/index.d.ts +1 -0
  35. package/components/field/rate-card/index.d.ts +1 -0
  36. package/components/field/rate-card/rate-card.d.ts +12 -0
  37. package/components/field/rate-card/rate-card.styles.d.ts +21 -0
  38. package/components/field/rate-select/index.d.ts +1 -0
  39. package/components/field/rate-select/rate-select.d.ts +11 -0
  40. package/components/field/rate-select/rate-select.styles.d.ts +3 -0
  41. package/components/field/select/index.d.ts +1 -0
  42. package/components/field/select/select.d.ts +20 -0
  43. package/components/field/submit-button/index.d.ts +1 -0
  44. package/components/field/submit-button/submit-button.d.ts +13 -0
  45. package/components/field/switch/index.d.ts +1 -0
  46. package/components/field/switch/switch.d.ts +9 -0
  47. package/components/field/text-area/index.d.ts +1 -0
  48. package/components/field/text-area/text-area.d.ts +3 -0
  49. package/components/field/text-input/index.d.ts +1 -0
  50. package/components/field/text-input/text-input.d.ts +3 -0
  51. package/components/field-label/field-label.d.ts +9 -0
  52. package/components/field-label/index.d.ts +1 -0
  53. package/components/index.d.ts +11 -4
  54. package/components/items-breakdown/index.d.ts +1 -0
  55. package/components/items-breakdown/items-breakdown.d.ts +14 -0
  56. package/components/items-breakdown/items-breakdown.styles.d.ts +3 -0
  57. package/components/loader/index.d.ts +1 -0
  58. package/components/loader/loader.d.ts +2 -0
  59. package/components/organisms/auto-funding-form/auto-funding-form.d.ts +15 -0
  60. package/components/organisms/auto-funding-form/auto-funding-schema.d.ts +53 -0
  61. package/components/organisms/auto-funding-form/index.d.ts +1 -0
  62. package/components/organisms/index.d.ts +2 -0
  63. package/components/organisms/manual-funding-form/index.d.ts +1 -0
  64. package/components/organisms/manual-funding-form/manual-funding-form.d.ts +14 -0
  65. package/components/organisms/manual-funding-form/manual-funding-schema.d.ts +27 -0
  66. package/components/portal/index.d.ts +1 -0
  67. package/components/portal/portal.d.ts +13 -0
  68. package/components/preset-descriptor/index.d.ts +1 -0
  69. package/components/preset-descriptor/preset-descriptor.d.ts +2 -0
  70. package/components/preset-descriptor/preset-descriptor.styles.d.ts +6 -0
  71. package/components/settings-card/index.d.ts +1 -0
  72. package/components/settings-card/settings-card.d.ts +11 -0
  73. package/components/settings-card/settings-card.styles.d.ts +6 -0
  74. package/components/spacer/index.d.ts +1 -0
  75. package/components/spacer/spacer.d.ts +6 -0
  76. package/components/templates/add-carriers/add-carriers.d.ts +5 -0
  77. package/components/templates/add-carriers/index.d.ts +1 -0
  78. package/components/templates/address-display/address-display.d.ts +9 -0
  79. package/components/templates/address-display/index.d.ts +1 -0
  80. package/components/templates/address-form/address-form.d.ts +18 -0
  81. package/components/templates/address-form/address-schema.d.ts +250 -0
  82. package/components/templates/address-form/index.d.ts +2 -0
  83. package/components/templates/address-parser/address-parser-schema.d.ts +10 -0
  84. package/components/templates/address-parser/address-parser.d.ts +13 -0
  85. package/components/templates/address-parser/index.d.ts +2 -0
  86. package/components/templates/address-preference-display/address-preference-display.d.ts +16 -0
  87. package/components/templates/address-preference-display/index.d.ts +1 -0
  88. package/components/templates/agreement-form/agreement-form-schema.d.ts +10 -0
  89. package/components/templates/agreement-form/agreement-form.d.ts +8 -0
  90. package/components/templates/agreement-form/agreement-form.styles.d.ts +1 -0
  91. package/components/templates/agreement-form/index.d.ts +1 -0
  92. package/components/templates/billing-form/billing-form-stories.d.ts +6 -0
  93. package/components/templates/billing-form/billing-form.d.ts +9 -0
  94. package/components/templates/billing-form/billing-schema.d.ts +76 -0
  95. package/components/templates/billing-form/index.d.ts +2 -0
  96. package/components/templates/customs-item-form/customs-item-form-schema.d.ts +80 -0
  97. package/components/templates/customs-item-form/customs-item-form.d.ts +14 -0
  98. package/components/templates/customs-item-form/index.d.ts +2 -0
  99. package/components/templates/customs-items-display/customs-items-display.d.ts +7 -0
  100. package/components/templates/customs-items-display/customs-items-display.styles.d.ts +6 -0
  101. package/components/templates/customs-items-display/index.d.ts +1 -0
  102. package/components/templates/funding-methods/funding-methods.d.ts +10 -0
  103. package/components/templates/funding-methods/index.d.ts +1 -0
  104. package/components/templates/index.d.ts +16 -0
  105. package/components/templates/label/index.d.ts +1 -0
  106. package/components/templates/label/label.d.ts +12 -0
  107. package/components/templates/manage-warehouses/index.d.ts +1 -0
  108. package/components/templates/manage-warehouses/manage-warehouses.d.ts +5 -0
  109. package/components/templates/rate-form/index.d.ts +1 -0
  110. package/components/templates/rate-form/rate-form.d.ts +21 -0
  111. package/components/templates/rate-form/rate-schema.d.ts +30 -0
  112. package/components/templates/register-wallet/index.d.ts +1 -0
  113. package/components/templates/register-wallet/register-wallet.d.ts +3 -0
  114. package/components/templates/register-wallet/register-wallet.styles.d.ts +6 -0
  115. package/components/templates/sales-order/sales-order.d.ts +8 -0
  116. package/components/templates/shipment/shipment.d.ts +17 -0
  117. package/components/templates/shipment-form/index.d.ts +1 -0
  118. package/components/templates/shipment-form/shipment-form.d.ts +51 -0
  119. package/components/templates/shipment-form/shipment-schema.d.ts +943 -0
  120. package/components/templates/void-label/void-label.d.ts +9 -0
  121. package/components/templates/warehouse-display/index.d.ts +1 -0
  122. package/components/templates/warehouse-display/warehouse-display.d.ts +6 -0
  123. package/constants/index.d.ts +1 -0
  124. package/constants/shipengine/address.d.ts +39 -0
  125. package/constants/shipengine/index.d.ts +1 -0
  126. package/elements/add-carriers.d.ts +1 -0
  127. package/elements/components/add-carriers/add-carriers.d.ts +8 -0
  128. package/elements/components/add-carriers/index.d.ts +1 -0
  129. package/{components → elements/components}/configure-shipment/configure-shipment.d.ts +5 -4
  130. package/{components → elements/components}/configure-shipment/hooks/use-address.d.ts +4 -2
  131. package/{components → elements/components}/configure-shipment/hooks/use-presets.d.ts +1 -1
  132. package/{components → elements/components}/configure-shipment/hooks/use-shipment-form.d.ts +6 -5
  133. package/elements/components/index.d.ts +8 -0
  134. package/elements/components/manage-funding/index.d.ts +1 -0
  135. package/elements/components/manage-funding/manage-funding.d.ts +2 -0
  136. package/elements/components/manage-warehouses/index.d.ts +1 -0
  137. package/elements/components/manage-warehouses/manage-warehouses.d.ts +2 -0
  138. package/elements/components/register-wallet/index.d.ts +1 -0
  139. package/elements/components/register-wallet/register-wallet.d.ts +9 -0
  140. package/elements/components/sales-order/index.d.ts +1 -0
  141. package/{components → elements/components}/sales-order/sales-order.d.ts +3 -2
  142. package/elements/components/shipment/index.d.ts +1 -0
  143. package/{components → elements/components}/shipment/shipment.d.ts +1 -1
  144. package/elements/components/void-label/index.d.ts +1 -0
  145. package/elements/index.d.ts +7 -0
  146. package/elements/manage-funding.d.ts +1 -0
  147. package/elements/manage-warehouses.d.ts +1 -0
  148. package/elements/register-wallet.d.ts +1 -0
  149. package/extensions/index.d.ts +1 -0
  150. package/extensions/zod.d.ts +18 -0
  151. package/factories/index.d.ts +2 -0
  152. package/factories/shipengine/address.d.ts +28 -0
  153. package/factories/shipengine/carrier.d.ts +10 -0
  154. package/factories/shipengine/index.d.ts +12 -0
  155. package/factories/shipengine/label.d.ts +10 -0
  156. package/factories/shipengine/money.d.ts +9 -0
  157. package/factories/shipengine/order-source.d.ts +11 -0
  158. package/factories/shipengine/package.d.ts +9 -0
  159. package/factories/shipengine/resource.d.ts +10 -0
  160. package/factories/shipengine/sales-order.d.ts +16 -0
  161. package/factories/shipengine/service.d.ts +9 -0
  162. package/factories/shipengine/shipment.d.ts +38 -0
  163. package/factories/shipengine/warehouse.d.ts +6 -0
  164. package/factories/shipengine/weight.d.ts +15 -0
  165. package/factories/utils.d.ts +3 -0
  166. package/hooks/index.d.ts +7 -0
  167. package/hooks/options/index.d.ts +12 -0
  168. package/hooks/options/use-confirmation-options.d.ts +5 -0
  169. package/hooks/options/use-country-code-options.d.ts +4 -0
  170. package/hooks/options/use-customs-contents-options.d.ts +5 -0
  171. package/hooks/options/use-customs-non-delivery-options.d.ts +5 -0
  172. package/hooks/options/use-expiration-month-options.d.ts +4 -0
  173. package/hooks/options/use-insurance-provider-options.d.ts +10 -0
  174. package/hooks/options/use-package-options.d.ts +3 -0
  175. package/hooks/options/use-rate-options.d.ts +21 -0
  176. package/hooks/options/use-service-code-options.d.ts +3 -0
  177. package/hooks/options/use-shipping-presets-options.d.ts +19 -0
  178. package/hooks/options/use-state-code-options.d.ts +4 -0
  179. package/hooks/options/use-warehouse-options.d.ts +5 -0
  180. package/hooks/use-carrier-metadata.d.ts +6 -0
  181. package/hooks/use-elements.d.ts +36 -0
  182. package/hooks/use-nested-form.d.ts +22 -0
  183. package/hooks/use-page-layout.d.ts +11 -0
  184. package/hooks/use-root-portal.d.ts +19 -0
  185. package/hooks/use-run-once-on-true.d.ts +7 -0
  186. package/index.cjs +24035 -14817
  187. package/index.d.ts +12 -3
  188. package/index.js +24343 -15279
  189. package/locales/en/index.d.ts +386 -0
  190. package/locales/index.d.ts +1 -0
  191. package/package.json +24 -5
  192. package/providers/giger-provider.d.ts +8 -0
  193. package/providers/index.d.ts +1 -0
  194. package/register.d.ts +19 -0
  195. package/schemas/index.d.ts +1 -0
  196. package/schemas/shipengine/address.d.ts +17 -0
  197. package/schemas/shipengine/index.d.ts +3 -0
  198. package/schemas/shipengine/money.d.ts +15 -0
  199. package/schemas/shipengine/phone.d.ts +10 -0
  200. package/testing/index.d.ts +2 -0
  201. package/testing/render.d.ts +1 -0
  202. package/testing/swr.d.ts +15 -0
  203. package/types/carrier-metadata.d.ts +7 -0
  204. package/types/index.d.ts +2 -0
  205. package/types/shipping-preset/index.d.ts +1 -0
  206. package/types/shipping-preset/shipping-preset.d.ts +17 -0
  207. package/utilities/create-dictionary.d.ts +4 -0
  208. package/utilities/date.d.ts +24 -0
  209. package/utilities/error.d.ts +4 -0
  210. package/utilities/form-logger.d.ts +16 -0
  211. package/utilities/index.d.ts +11 -0
  212. package/utilities/money.d.ts +4 -0
  213. package/utilities/predicates/index.d.ts +1 -0
  214. package/utilities/predicates/isString.d.ts +1 -0
  215. package/utilities/rates.d.ts +9 -0
  216. package/utilities/shipengine/address.d.ts +21 -0
  217. package/utilities/shipengine/carrier.d.ts +1 -0
  218. package/utilities/shipengine/dimensions.d.ts +10 -0
  219. package/utilities/shipengine/index.d.ts +7 -0
  220. package/utilities/shipengine/package.d.ts +4 -0
  221. package/utilities/shipengine/sales-order.d.ts +13 -0
  222. package/utilities/shipengine/shipment.d.ts +13 -0
  223. package/utilities/shipengine/weight.d.ts +13 -0
  224. package/utilities/string.d.ts +1 -0
  225. package/utilities/styles.d.ts +18 -0
  226. package/utilities/validation.d.ts +10 -0
  227. /package/components/{sales-order → templates/sales-order}/index.d.ts +0 -0
  228. /package/components/{shipment → templates/shipment}/index.d.ts +0 -0
  229. /package/components/{void-label → templates/void-label}/index.d.ts +0 -0
  230. /package/{components → elements/components}/configure-shipment/hooks/index.d.ts +0 -0
  231. /package/{components → elements/components}/configure-shipment/hooks/use-customs.d.ts +0 -0
  232. /package/{components → elements/components}/configure-shipment/hooks/use-rates-form.d.ts +0 -0
  233. /package/{components → elements/components}/configure-shipment/hooks/use-request-rates.d.ts +0 -0
  234. /package/{components → elements/components}/configure-shipment/index.d.ts +0 -0
  235. /package/{components → elements/components}/sales-order/hooks/index.d.ts +0 -0
  236. /package/{components → elements/components}/sales-order/hooks/use-configure-shipment.d.ts +0 -0
  237. /package/{components → elements/components}/sales-order/hooks/use-import-sales-order.d.ts +0 -0
  238. /package/{components → elements/components}/sales-order/hooks/use-pending-shipment.d.ts +0 -0
  239. /package/{components → elements/components}/void-label/void-label.d.ts +0 -0
  240. /package/{purchase-label.d.ts → elements/purchase-label.d.ts} +0 -0
  241. /package/{view-shipment.d.ts → elements/view-shipment.d.ts} +0 -0
  242. /package/{void-label.d.ts → elements/void-label.d.ts} +0 -0
@@ -0,0 +1,21 @@
1
+ import * as SE from "@shipengine/types";
2
+ /**
3
+ * @category Utilities
4
+ */
5
+ export declare const isDomesticAddress: (address: Pick<SE.Address, "countryCode">) => boolean | undefined;
6
+ /**
7
+ * @category Utilities
8
+ */
9
+ export declare const isMilitaryAddress: (address: SE.Address) => boolean;
10
+ /**
11
+ * @category Utilities
12
+ */
13
+ export declare const isUnitedStatesTerritory: (address: SE.Address) => boolean;
14
+ /**
15
+ * @category Utilities
16
+ */
17
+ export declare const isPoBox: (addressLine: string) => boolean;
18
+ /**
19
+ * @category Utilities
20
+ */
21
+ export declare const isPoBoxAddress: (address: SE.Address) => boolean;
@@ -0,0 +1 @@
1
+ export declare const isUspsCarrier: (carrierCode: string) => boolean;
@@ -0,0 +1,10 @@
1
+ import * as SE from "@shipengine/types";
2
+ type ConvertDimensionsOptions = {
3
+ allowAllZeroes?: boolean;
4
+ };
5
+ /**
6
+ * @category Utilities
7
+ */
8
+ export declare function convertDimensions(dimensions: SE.Dimensions): SE.DimensionsWithUnit;
9
+ export declare function convertDimensions(dimensions: SE.DimensionsWithUnit, options?: ConvertDimensionsOptions): SE.Dimensions;
10
+ export {};
@@ -0,0 +1,7 @@
1
+ export * from "./address";
2
+ export * from "./carrier";
3
+ export * from "./dimensions";
4
+ export * from "./sales-order";
5
+ export * from "./shipment";
6
+ export * from "./weight";
7
+ export * from "./package";
@@ -0,0 +1,4 @@
1
+ /**
2
+ * @category Utilities
3
+ */
4
+ export declare const isFlatRatePackageCode: (packageCode: string | null | undefined) => boolean;
@@ -0,0 +1,13 @@
1
+ import * as SE from "@shipengine/types";
2
+ /**
3
+ * @category Utilities
4
+ */
5
+ export declare const getCustomsFromSalesOrder: (salesOrder: SE.SalesOrder, warehouse: SE.Warehouse) => SE.Customs;
6
+ /**
7
+ * @category Utilities
8
+ */
9
+ export declare const getIsCustomsRequiredForSalesOrder: ({ shipTo }: SE.SalesOrder, { originAddress }: SE.Warehouse) => boolean;
10
+ /**
11
+ * @category Utilities
12
+ */
13
+ export declare const getRequestedServices: (salesOrder: SE.SalesOrder | undefined) => string[];
@@ -0,0 +1,13 @@
1
+ import * as SE from "@shipengine/types";
2
+ /**
3
+ * @category Utilities
4
+ */
5
+ export declare const getIsInternationalShipment: ({ shipFrom, shipTo }: SE.SalesOrderShipment) => boolean;
6
+ /**
7
+ * @category Utilities
8
+ */
9
+ export declare const getIsCustomsRequiredForShipment: ({ shipFrom, shipTo }: SE.SalesOrderShipment) => boolean;
10
+ /**
11
+ * @category Utilities
12
+ */
13
+ export declare const getPendingShipment: (shipments?: SE.SalesOrderShipment[]) => SE.SalesOrderShipment | undefined;
@@ -0,0 +1,13 @@
1
+ import * as SE from "@shipengine/types";
2
+ /**
3
+ * @category Utilities
4
+ */
5
+ export declare function convertWeight(weight: SE.WeightWithUnit): SE.FractionalWeight;
6
+ export declare function convertWeight(weight: SE.FractionalWeight): SE.WeightWithUnit;
7
+ /**
8
+ * @category Utilities
9
+ */
10
+ export declare function formatFractionalWeight(weight: {
11
+ whole?: number | null;
12
+ fractional?: number | null;
13
+ } | undefined | null): SE.FractionalWeight;
@@ -0,0 +1 @@
1
+ export declare const capitalizeFirstLetter: (str: string) => string;
@@ -0,0 +1,18 @@
1
+ import { Interpolation } from "@emotion/serialize";
2
+ import { Theme } from "@packlink/brands";
3
+ /**
4
+ * Creates a Record of Emotion styles.
5
+ *
6
+ * Values may be any variant that a `css` prop can accept (a CSSObject, SerializedStyles, a FunctionInterpolation with theme, etc).
7
+ *
8
+ * Eliminates the need to explicitly type styles (while remaining fully typed w/ autocomplete).
9
+ *
10
+ * @example
11
+ * ```
12
+ * const styles = createStyles({
13
+ * container: (theme) => ({ backgroundColor: theme.colors.primary }),
14
+ * icon: { color: 'red' },
15
+ * });
16
+ * ```
17
+ */
18
+ export declare const createStyles: <T extends string>(styles: Record<T, Interpolation<Theme>>) => Record<T, Interpolation<Theme>>;
@@ -0,0 +1,10 @@
1
+ import { z } from "zod";
2
+ import { Resolver } from "@hookform/resolvers/zod";
3
+ /**
4
+ * @category Utilities
5
+ */
6
+ export declare const errorMap: z.ZodErrorMap;
7
+ /**
8
+ * @category Utilities
9
+ */
10
+ export declare const validationResolver: <T extends z.ZodType<any, any, any>>(schema: T) => ReturnType<Resolver>;
File without changes