@shipengine/react-api 0.23.3 → 1.0.0-next.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shipengine/react-api",
-  "version": "0.23.3",
+  "version": "1.0.0-next.0",
   "main": "./index.js",
   "types": "./index.d.ts",
   "exports": {
@@ -14,11 +14,5 @@
     "entryPoint": "./src/index.ts",
     "readmeFile": "./README.md",
     "tsconfig": "./tsconfig.lib.json"
-  },
-  "peerDependencies": {
-    "@shipengine/js-api": "0.x",
-    "react": "18.x",
-    "react-dom": "18.x",
-    "react-query": "3.x"
   }
-}
+}

package/shipengine-api-react/src/hooks/index.d.ts

@@ -0,0 +1,32 @@
+export * from "./use-add-funds";
+export * from "./use-calculate-rates";
+export * from "./use-update-auto-funding";
+export * from "./use-connect-carrier";
+export * from "./use-create-label";
+export * from "./use-create-sales-order-shipment";
+export * from "./use-create-warehouse";
+export * from "./use-delete-warehouse";
+export * from "./use-get-auto-funding-configuration";
+export * from "./use-get-carrier-by-id";
+export * from "./use-get-insurance-account";
+export * from "./use-get-label";
+export * from "./use-get-account-settings";
+export * from "./use-get-wallet-transaction-history";
+export * from "./use-get-sales-order";
+export * from "./use-get-sales-order-shipment";
+export * from "./use-list-carriers";
+export * from "./use-list-labels";
+export * from "./use-list-order-sources";
+export * from "./use-list-custom-package-types";
+export * from "./use-list-sales-orders";
+export * from "./use-list-sales-order-shipments";
+export * from "./use-list-warehouses";
+export * from "./use-notify-sales-order";
+export * from "./use-parse-address";
+export * from "./use-refresh-order-source";
+export * from "./use-update-billing";
+export * from "./use-update-sales-order-shipment";
+export * from "./use-update-warehouse";
+export * from "./use-validate-addresses";
+export * from "./use-void-label";
+export * from "./use-get-shipment";

package/{hooks/account-settings → shipengine-api-react/src/hooks}/use-get-account-settings.d.ts

@@ -3,4 +3,4 @@
  *
  * @see [https://github.com/ShipEngine/shipengine-api-definition/pull/58/files#diff-775a1c7e38ec7549a98ad8c00e18cb9fc5b4c87ddeb1d496ca3525f48c7381e0
  */
-export declare const useGetAccountSettings: () => import("react-query").UseQueryResult<import("@shipengine/js-api").AccountSettings, import("@shipengine/js-api").CodedError[]>;
+export declare const useGetAccountSettings: () => import("react-query").UseQueryResult<import("@shipengine/js-api").Settings, import("@shipengine/js-api").CodedError[]>;

package/shipengine-api-react/src/hooks/use-get-shipment.d.ts

@@ -0,0 +1,6 @@
+/**
+ * @category ShipEngine API Hooks
+ *
+ * @see [ShipEngine Developer Docs](https://www.shipengine.com/docs/reference/list-orders/)
+ */
+export declare const useGetShipment: (shipmentId: string) => import("react-query").UseQueryResult<import("@shipengine/js-api").SalesOrderShipment, import("@shipengine/js-api").CodedError[]>;

package/shipengine-api-react/src/hooks/use-get-wallet-transaction-history.d.ts

@@ -0,0 +1,5 @@
+import { WalletTransactionHistory } from "@shipengine/js-api";
+/**
+ * @category ShipEngine API Hooks
+ */
+export declare const useGetWalletTransactionHistory: () => WalletTransactionHistory;

package/shipengine-api-react/src/hooks/use-list-warehouses.d.ts

@@ -0,0 +1,7 @@
+/**
+ * @category ShipEngine API Hooks
+ *
+ * @see [ShipEngine Developer Docs](https://www.shipengine.com/docs/reference/list-warehouses/)
+ * @see [ShipEngine API Reference](https://shipengine.github.io/shipengine-openapi/#operation/list_warehouses)
+ */
+export declare const useListWarehouses: () => import("react-query").UseQueryResult<import("@shipengine/js-api").Warehouse[], import("@shipengine/js-api").CodedError[]>;

package/shipengine-api-react/src/hooks/use-shipengine.d.ts

@@ -0,0 +1 @@
+export declare const useShipEngine: () => import("../providers").ShipEngineContextValue;

package/shipengine-api-react/src/hooks/use-update-billing.d.ts

@@ -0,0 +1,8 @@
+import { SE } from "@shipengine/js-api";
+/**
+ * @category ShipEngine API Hooks
+ */
+export declare const useUpdateBilling: () => import("react-query").UseMutationResult<{}, SE.CodedError[], {
+    address: SE.Address;
+    creditCard: SE.CreditCard;
+}, unknown>;

package/{index.d.ts → shipengine-api-react/src/index.d.ts}

@@ -1,4 +1,3 @@
 export * from "./hooks";
 export * from "./providers";
 export * from "./utilities";
-export * from "@shipengine/js-api";

package/{providers → shipengine-api-react/src/providers}/shipengine.d.ts

@@ -4,10 +4,9 @@ export interface ShipEngineContextValue {
     client: ShipEngineAPI;
 }
 export declare const ShipEngineContext: import("react").Context<ShipEngineContextValue | undefined>;
-export type ShipEngineProps = {
+export type ShipEngineProviderProps = {
     children: React.ReactNode;
     getToken: () => Promise<string> | string;
     headers?: AxiosRequestHeaders;
 } & ShipEngineAPIConfig;
-export declare const ShipEngine: ({ baseURL, children, headers, getToken }: ShipEngineProps) => JSX.Element;
-export declare const useShipEngine: () => ShipEngineContextValue;
+export declare const ShipEngineProvider: ({ baseURL, children, headers, getToken, }: ShipEngineProviderProps) => JSX.Element;

package/hooks/account-settings/index.d.ts

@@ -1,2 +0,0 @@
-export * from "./use-get-account-settings";
-export * from "./use-update-account-settings";

package/hooks/account-settings/use-update-account-settings.d.ts

@@ -1,5 +0,0 @@
-import { SE } from "@shipengine/js-api";
-/**
- * @category ShipEngine API Hooks
- *  */
-export declare const useUpdateAccountSettings: () => import("react-query").UseMutationResult<SE.AccountSettings, SE.CodedError[], Partial<SE.AccountSettings>, unknown>;

package/hooks/addresses/index.d.ts

@@ -1,2 +0,0 @@
-export * from "./use-parse-address";
-export * from "./use-validate-addresses";

package/hooks/carriers/index.d.ts

@@ -1,12 +0,0 @@
-export * from "./use-add-funds";
-export * from "./use-connect-carrier";
-export * from "./use-get-auto-funding-configuration";
-export * from "./use-get-carrier-by-id";
-export * from "./use-get-countries-by-carrier";
-export * from "./use-get-currencies-by-carrier";
-export * from "./use-get-package-rating-group-by-carrier";
-export * from "./use-get-services-by-carrier";
-export * from "./use-get-wallet-history";
-export * from "./use-list-carriers";
-export * from "./use-update-auto-funding";
-export * from "./use-get-zones-by-carrier";

package/hooks/carriers/use-get-countries-by-carrier.d.ts

@@ -1,5 +0,0 @@
-/**
- * @category ShipEngine API Hooks
- *
- */
-export declare const useGetCountriesByCarrier: (carrierId?: string) => import("react-query").UseQueryResult<string[], import("@shipengine/js-api").CodedError[]>;

package/hooks/carriers/use-get-currencies-by-carrier.d.ts

@@ -1,5 +0,0 @@
-/**
- * @category ShipEngine API Hooks
- *
- */
-export declare const useGetCurrenciesByCarrier: (carrierId?: string) => import("react-query").UseQueryResult<import("@shipengine/js-api").Currency[], import("@shipengine/js-api").CodedError[]>;

package/hooks/carriers/use-get-package-rating-group-by-carrier.d.ts

@@ -1,5 +0,0 @@
-/**
- * @category ShipEngine API Hooks
- *
- */
-export declare const useGetPackageRatingGroupByCarrier: (carrierId?: string) => import("react-query").UseQueryResult<import("@shipengine/js-api").PackageRatingType[], import("@shipengine/js-api").CodedError[]>;

package/hooks/carriers/use-get-services-by-carrier.d.ts

@@ -1,7 +0,0 @@
-/**
- * @category ShipEngine API Hooks
- *
- * @see [ShipEngine Developer Docs](https://www.shipengine.com/docs/reference/list-carrier-services/)
- * @see [ShipEngine API Reference](https://shipengine.github.io/shipengine-openapi/#operation/list_carrier_services)
- */
-export declare const useGetServicesByCarrier: (carrierId?: string) => import("react-query").UseQueryResult<import("@shipengine/js-api").CarrierService[], import("@shipengine/js-api").CodedError[]>;

package/hooks/carriers/use-get-wallet-history.d.ts

@@ -1,10 +0,0 @@
-/**
- * @category ShipEngine API Hooks
- *
- * @see https://react-query-v3.tanstack.com/guides/paginated-queries
- */
-export declare const useGetWalletHistory: ({ enabled, page, range, }: {
-    enabled: boolean;
-    page: number;
-    range: [Date, Date];
-}) => import("react-query").UseQueryResult<import("@shipengine/js-api").WalletTransactionHistory, import("@shipengine/js-api").CodedError[]>;

package/hooks/carriers/use-get-zones-by-carrier.d.ts

@@ -1,4 +0,0 @@
-/**
- * @category ShipEngine API Hooks
- */
-export declare const useGetZonesByCarrier: (carrierId?: string) => import("react-query").UseQueryResult<import("@shipengine/js-api").CarrierZone[], import("@shipengine/js-api").CodedError[]>;

package/hooks/custom-packages/index.d.ts

@@ -1 +0,0 @@
-export * from "./use-list-custom-package-types";

package/hooks/funding-sources/index.d.ts

@@ -1,6 +0,0 @@
-export * from "./use-create-funding-source";
-export * from "./use-funding-sources-add-funds";
-export * from "./use-get-funding-source-by-id";
-export * from "./use-list-funding-sources";
-export * from "./use-register-carrier";
-export * from "./use-update-funding-source";

package/hooks/funding-sources/use-create-funding-source.d.ts

@@ -1,7 +0,0 @@
-import { SE } from "@shipengine/js-api";
-/**
- * @category ShipEngine API Hooks
- *  */
-export declare const useCreateFundingSource: () => import("react-query").UseMutationResult<{
-    fundingSource: SE.FundingSource;
-}, SE.CodedError[], SE.CreateFundingSource, unknown>;

package/hooks/funding-sources/use-funding-sources-add-funds.d.ts

@@ -1,7 +0,0 @@
-import { SE } from "@shipengine/js-api";
-/**
- * @category ShipEngine API Hooks
- *
- * @see [ShipEngine API Reference](https://auctane.atlassian.net/wiki/spaces/~6272e3473d0b58006947a648/pages/3628370266/ShipEngine+Funding+Sources+API#PUT-v1/funding_sources/%7Bfunding_source_id%7D/add_funds)
- */
-export declare const useFundingSourcesAddFunds: (fundingSourceId: string) => import("react-query").UseMutationResult<SE.AddFundsResponse, SE.CodedError[], SE.Money, unknown>;

package/hooks/funding-sources/use-get-funding-source-by-id.d.ts

@@ -1,4 +0,0 @@
-/**
- * @category ShipEngine API Hooks
- */
-export declare const useGetFundingSourceById: (fundingSourceId: string) => import("react-query").UseQueryResult<import("@shipengine/js-api").FundingSource, import("@shipengine/js-api").CodedError[]>;

package/hooks/funding-sources/use-list-funding-sources.d.ts

@@ -1,4 +0,0 @@
-/**
- * @category ShipEngine API Hooks
- */
-export declare const useListFundingSources: () => import("react-query").UseQueryResult<import("@shipengine/js-api").FundingSource[], import("@shipengine/js-api").CodedError[]>;

package/hooks/funding-sources/use-register-carrier.d.ts

@@ -1,5 +0,0 @@
-import { SE } from "@shipengine/js-api";
-/**
- * @category ShipEngine API Hooks
- *  */
-export declare const useRegisterCarrier: () => import("react-query").UseMutationResult<SE.CarrierRegistrationResponse, SE.CodedError[], SE.CarrierRegistration, unknown>;

package/hooks/funding-sources/use-update-funding-source.d.ts

@@ -1,12 +0,0 @@
-import { SE } from "@shipengine/js-api";
-export type UpdateFundingSourceData = {
-    billingInfo: SE.FundingSourceAddress;
-    creditCardInfo: SE.CreditCardInfo;
-    fundingSourceId: string;
-};
-/**
- * @category ShipEngine API Hooks
- *  */
-export declare const useUpdateFundingSource: () => import("react-query").UseMutationResult<{
-    fundingSource: SE.FundingSource;
-}, SE.CodedError[], UpdateFundingSourceData, unknown>;

package/hooks/index.d.ts

@@ -1,15 +0,0 @@
-export * from "./account-settings";
-export * from "./addresses";
-export * from "./carriers";
-export * from "./custom-packages";
-export * from "./funding-sources";
-export * from "./insurance";
-export * from "./labels";
-export * from "./order-sources";
-export * from "./rate-cards";
-export * from "./rates";
-export * from "./sales-orders";
-export * from "./sales-orders-shipment";
-export * from "./shipments";
-export * from "./warehouses";
-export * from "./rate-cards";

package/hooks/insurance/index.d.ts

@@ -1 +0,0 @@
-export * from "./use-get-insurance-account";

package/hooks/labels/index.d.ts

@@ -1,4 +0,0 @@
-export * from "./use-create-label";
-export * from "./use-get-label";
-export * from "./use-list-labels";
-export * from "./use-void-label";

package/hooks/order-sources/index.d.ts

@@ -1,2 +0,0 @@
-export * from "./use-list-order-sources";
-export * from "./use-refresh-order-source";

package/hooks/rate-cards/index.d.ts

@@ -1,8 +0,0 @@
-export * from "./use-create-rate-card";
-export * from "./use-download-rate-card";
-export * from "./use-get-rate-card-by-id";
-export * from "./use-list-rate-cards";
-export * from "./use-publish-rate-card";
-export * from "./use-update-rate-card";
-export * from "./use-upload-rate-card";
-export * from "./use-delete-rate-card";

package/hooks/rate-cards/use-create-rate-card.d.ts

@@ -1,6 +0,0 @@
-import { RateCardInput } from "@shipengine/js-api";
-/**
- * @category ShipEngine API Hooks
- *
- */
-export declare const useCreateRateCard: () => import("react-query").UseMutationResult<import("@shipengine/js-api").RateCard, import("@shipengine/js-api").CodedError[], RateCardInput, unknown>;

package/hooks/rate-cards/use-delete-rate-card.d.ts

@@ -1,4 +0,0 @@
-/**
- * @category ShipEngine API Hooks
- */
-export declare const useDeleteRateCard: () => import("react-query").UseMutationResult<any, import("@shipengine/js-api").CodedError[], string, unknown>;

package/hooks/rate-cards/use-download-rate-card.d.ts

@@ -1,5 +0,0 @@
-/**
- * @category ShipEngine API Hooks
- *
- */
-export declare const useDownloadRateCard: (rateCardId: string) => import("react-query").UseQueryResult<import("axios").AxiosResponse<Blob, any>, import("@shipengine/js-api").CodedError[]>;

package/hooks/rate-cards/use-get-rate-card-by-id.d.ts

@@ -1,5 +0,0 @@
-/**
- * @category ShipEngine API Hooks
- *
- */
-export declare const useGetRateCardById: (rateCardId: string) => import("react-query").UseQueryResult<import("@shipengine/js-api").RateCard, import("@shipengine/js-api").CodedError[]>;

package/hooks/rate-cards/use-list-rate-cards.d.ts

@@ -1,5 +0,0 @@
-/**
- * @category ShipEngine API Hooks
- *
- */
-export declare const useListRateCards: (carrierIds: string[]) => import("react-query").UseQueryResult<import("@shipengine/js-api").RateCard[], import("@shipengine/js-api").CodedError[]>;

package/hooks/rate-cards/use-publish-rate-card.d.ts

@@ -1,5 +0,0 @@
-/**
- * @category ShipEngine API Hooks
- *
- */
-export declare const usePublishRateCard: () => import("react-query").UseMutationResult<import("axios").AxiosResponse<any, any>, import("@shipengine/js-api").CodedError[], string, unknown>;

package/hooks/rate-cards/use-update-rate-card.d.ts

@@ -1,6 +0,0 @@
-import { RateCard } from "@shipengine/js-api";
-/**
- * @category ShipEngine API Hooks
- *
- */
-export declare const useUpdateRateCard: () => import("react-query").UseMutationResult<RateCard, import("@shipengine/js-api").CodedError[], RateCard, unknown>;

package/hooks/rate-cards/use-upload-rate-card.d.ts

@@ -1,9 +0,0 @@
-export type UploadRateCardData = {
-    file: File;
-    rateCardId: string;
-};
-/**
- * @category ShipEngine API Hooks
- *
- */
-export declare const useUploadRateCard: () => import("react-query").UseMutationResult<import("@shipengine/js-api").RateCard, import("@shipengine/js-api").CodedError[], UploadRateCardData, unknown>;

package/hooks/rates/index.d.ts

@@ -1 +0,0 @@
-export * from "./use-calculate-rates";

package/hooks/sales-orders/index.d.ts

@@ -1,3 +0,0 @@
-export * from "./use-get-sales-order";
-export * from "./use-list-sales-orders";
-export * from "./use-notify-sales-order";

package/hooks/sales-orders-shipment/index.d.ts

@@ -1,4 +0,0 @@
-export * from "./use-create-sales-order-shipment";
-export * from "./use-get-sales-order-shipment";
-export * from "./use-list-sales-order-shipments";
-export * from "./use-update-sales-order-shipment";

package/hooks/shipments/index.d.ts

@@ -1,4 +0,0 @@
-export * from "./use-create-shipment";
-export * from "./use-get-shipment-rates";
-export * from "./use-get-shipment";
-export * from "./use-list-shipments";

package/hooks/shipments/use-create-shipment.d.ts

@@ -1,10 +0,0 @@
-import { SE } from "@shipengine/js-api";
-export type CreateShipmentData = {
-    warehouseId: string;
-} & Partial<Omit<SE.Shipment, "items">>;
-/**
- * @category ShipEngine API Hooks
- *
- * @see [ShipEngine Developer Docs](https://shipengine.github.io/shipengine-openapi/#operation/create_shipments)
- */
-export declare const useCreateShipment: () => import("react-query").UseMutationResult<import("@shipengine/js-api").CreateShipmentResult, SE.CodedError[], CreateShipmentData, unknown>;

package/hooks/shipments/use-get-shipment-rates.d.ts

@@ -1,6 +0,0 @@
-/**
- * @category ShipEngine API Hooks
- *
- * @see [ShipEngine Developer Docs](https://shipengine.github.io/shipengine-openapi/#operation/list_shipment_rates)
- */
-export declare const useGetShipmentRates: (shipmentId?: string, createdAtStart?: string) => import("react-query").UseQueryResult<import("@shipengine/js-api").ShipmentRateResponse, import("@shipengine/js-api").CodedError[]>;

package/hooks/shipments/use-get-shipment.d.ts

@@ -1,6 +0,0 @@
-/**
- * @category ShipEngine API Hooks
- *
- * @see [ShipEngine Developer Docs](https://www.shipengine.com/docs/reference/list-orders/)
- */
-export declare const useGetShipment: (shipmentId?: string) => import("react-query").UseQueryResult<import("@shipengine/js-api").SalesOrderShipment, import("@shipengine/js-api").CodedError[]>;

package/hooks/shipments/use-list-shipments.d.ts

@@ -1,7 +0,0 @@
-import { ListShipmentOptions } from "@shipengine/js-api";
-/**
- * @category ShipEngine API Hooks
- */
-export declare const useListShipments: (_params?: ListShipmentOptions & {
-    enabled?: boolean;
-}) => import("react-query").UseQueryResult<import("@shipengine/js-api").ListShipmentResult, import("@shipengine/js-api").CodedError[]>;

package/hooks/warehouses/index.d.ts

@@ -1,4 +0,0 @@
-export * from "./use-create-warehouse";
-export * from "./use-delete-warehouse";
-export * from "./use-list-warehouses";
-export * from "./use-update-warehouse";

package/hooks/warehouses/use-list-warehouses.d.ts

@@ -1,10 +0,0 @@
-export type ListWarehouseOptions = {
-    enabled?: boolean;
-};
-/**
- * @category ShipEngine API Hooks
- *
- * @see [ShipEngine Developer Docs](https://www.shipengine.com/docs/reference/list-warehouses/)
- * @see [ShipEngine API Reference](https://shipengine.github.io/shipengine-openapi/#operation/list_warehouses)
- */
-export declare const useListWarehouses: (options?: ListWarehouseOptions) => import("react-query").UseQueryResult<import("@shipengine/js-api").Warehouse[], import("@shipengine/js-api").CodedError[]>;