@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,10 @@
1
+ export declare const styles: {
2
+ container: (theme: import("@shipengine/giger-theme/dist/lib/Theme").Theme) => {
3
+ padding: number;
4
+ };
5
+ step: {
6
+ "& > span:last-child": {
7
+ position: "static";
8
+ };
9
+ };
10
+ };
@@ -0,0 +1,2 @@
1
+ export * from "./ship-from-address-step";
2
+ export * from "./use-ship-from-address-step";
@@ -0,0 +1,7 @@
1
+ import { SE } from "@shipengine/alchemy";
2
+ import { WarehousePayload } from "../../../../components/templates/manage-warehouses";
3
+ export type ShipFromAddressStepProps = {
4
+ defaultShipFromAddress?: Pick<SE.Warehouse, "name" | "isDefault" | "originAddress" | "returnAddress">;
5
+ onSubmit: (payload: WarehousePayload) => Promise<void>;
6
+ };
7
+ export declare const ShipFromAddressStep: ({ defaultShipFromAddress, onSubmit, }: ShipFromAddressStepProps) => import("@emotion/react/jsx-runtime").JSX.Element;
@@ -0,0 +1,9 @@
1
+ import { WarehousePayload } from "../../../../components/templates/manage-warehouses";
2
+ export type UseShipFromAddressStepProps = {
3
+ onStepComplete: () => void;
4
+ };
5
+ export declare const useShipFromAddressStep: ({ onStepComplete }: UseShipFromAddressStepProps) => {
6
+ defaultWarehouse: import("@shipengine/alchemy").Warehouse | undefined;
7
+ handleSubmitShipFromAddress: (payload: WarehousePayload) => Promise<void>;
8
+ isLoadingWarehouses: boolean;
9
+ };
@@ -0,0 +1 @@
1
+ export * from "./step-header";
@@ -0,0 +1,5 @@
1
+ export type StepHeaderProps = {
2
+ subtitle: string;
3
+ title: string;
4
+ };
5
+ export declare const StepHeader: ({ title, subtitle }: StepHeaderProps) => import("@emotion/react/jsx-runtime").JSX.Element;
@@ -0,0 +1 @@
1
+ export * from "./terms-agreement-form";
@@ -0,0 +1,10 @@
1
+ import { z } from "zod";
2
+ export declare const termsAgreementFormSchema: z.ZodObject<{
3
+ agreement: z.ZodLiteral<boolean>;
4
+ }, "strip", z.ZodTypeAny, {
5
+ agreement: boolean;
6
+ }, {
7
+ agreement: boolean;
8
+ }>;
9
+ export type TermsAgreementFormFields = z.input<typeof termsAgreementFormSchema>;
10
+ export type TermsAgreementFormPayload = z.output<typeof termsAgreementFormSchema>;
@@ -0,0 +1,7 @@
1
+ import { MetadataRequiredTermWithLinks } from "../../../../types";
2
+ export type TermsAgreementFormProps = {
3
+ carrierTerms: MetadataRequiredTermWithLinks[];
4
+ fundingSourceTerms: MetadataRequiredTermWithLinks[];
5
+ onSubmit: (agreement: boolean) => void;
6
+ };
7
+ export declare const TermsAgreementForm: ({ carrierTerms, fundingSourceTerms, onSubmit, }: TermsAgreementFormProps) => import("@emotion/react/jsx-runtime").JSX.Element;
@@ -0,0 +1,24 @@
1
+ export declare const styles: {
2
+ closeButton: (theme: import("@shipengine/giger-theme/dist/lib/Theme").Theme) => {
3
+ marginRight: number;
4
+ };
5
+ container: {
6
+ alignItems: "center";
7
+ display: "flex";
8
+ flexDirection: "column";
9
+ justifyContent: "center";
10
+ };
11
+ expanderLink: (theme: import("@shipengine/giger-theme/dist/lib/Theme").Theme) => {
12
+ alignItems: "center";
13
+ display: "inline-flex";
14
+ fontWeight: number;
15
+ };
16
+ termsWell: (theme: import("@shipengine/giger-theme/dist/lib/Theme").Theme) => {
17
+ backgroundColor: string;
18
+ marginBottom: number;
19
+ padding: string;
20
+ };
21
+ termTypeDivider: (theme: import("@shipengine/giger-theme/dist/lib/Theme").Theme) => {
22
+ margin: string;
23
+ };
24
+ };
@@ -0,0 +1 @@
1
+ export * from "./terms-agreement-step";
@@ -0,0 +1,8 @@
1
+ import { MetadataRequiredTermWithLinks } from "../../../../types";
2
+ export type TermsAgreementStepProps = {
3
+ carrierCodes: string[];
4
+ carrierTerms: MetadataRequiredTermWithLinks[];
5
+ fundingSourceTerms: MetadataRequiredTermWithLinks[];
6
+ onSubmit: (agreement: boolean) => void;
7
+ };
8
+ export declare const TermsAgreementStep: ({ carrierCodes, carrierTerms, fundingSourceTerms, onSubmit, }: TermsAgreementStepProps) => import("@emotion/react/jsx-runtime").JSX.Element;
@@ -0,0 +1,17 @@
1
+ export declare const styles: {
2
+ carrierLogos: (theme: import("@shipengine/giger-theme/dist/lib/Theme").Theme) => {
3
+ display: "flex";
4
+ flexDirection: "row";
5
+ gap: number;
6
+ justifyContent: "center";
7
+ padding: string;
8
+ };
9
+ container: (theme: import("@shipengine/giger-theme/dist/lib/Theme").Theme) => {
10
+ alignItems: "center";
11
+ display: "flex";
12
+ flexDirection: "column";
13
+ paddingBottom: number;
14
+ paddingTop: number;
15
+ textAlign: "center";
16
+ };
17
+ };
@@ -0,0 +1,18 @@
1
+ import { MetadataRequiredTermWithLinks } from "../../../../types";
2
+ export type UseTermsAgreementStepProps = {
3
+ enabledCarriers: string[];
4
+ onStepComplete: () => void;
5
+ };
6
+ export declare const useTermsAgreementStep: ({ enabledCarriers, onStepComplete, }: UseTermsAgreementStepProps) => {
7
+ carrierCodes: string[] | undefined;
8
+ carrierProfiles: {
9
+ capabilities: import("@shipengine/alchemy").MetadataCapability[] | null;
10
+ carrierCode: string;
11
+ registrationRequirements: import("@shipengine/alchemy").MetadataRegistrationRequirement[];
12
+ requiredTerms: import("@shipengine/alchemy").MetadataRequiredTerm[];
13
+ }[] | undefined;
14
+ carrierTerms: MetadataRequiredTermWithLinks[] | undefined;
15
+ fundingSourceMetadata: import("@tanstack/react-query").UseQueryResult<import("@shipengine/alchemy").MetadataResponse, import("@shipengine/alchemy").CodedError[]>;
16
+ fundingSourceTerms: MetadataRequiredTermWithLinks[] | undefined;
17
+ handleSubmitTermsAgreement: () => void;
18
+ };