@shipengine/elements 0.23.1 → 0.24.0

package/src/locales/en/index.d.ts

@@ -13,6 +13,7 @@ declare const _default: {
         };
     };
     "void-label": {
+        title: string;
         actions: {
             complete: string;
             confirmVoid: string;
@@ -31,6 +32,7 @@ declare const _default: {
         voidedOn: string;
     };
     "view-shipment": {
+        title: string;
         actions: {
             buyAnotherLabel: string;
             hideItems: string;
@@ -110,6 +112,7 @@ declare const _default: {
         agreeToTerms: string;
     };
     "purchase-label": {
+        title: string;
         actions: {
             calculateRates_one: string;
             calculateRates_other: string;
@@ -167,6 +170,7 @@ declare const _default: {
                 fractional: string;
             };
             weightGroup: string;
+            today: string;
         };
         hints: {
             contentDescription: string;
@@ -179,10 +183,6 @@ declare const _default: {
             selectService: string;
         };
         multipleShippingServices: string;
-        recommendedRates: {
-            recommended: string;
-            stayInformed: string;
-        };
         schemaErrors: {
             shipFromUnitedStatesOnly: string;
             shipFromAddressRequired: string;
@@ -200,6 +200,7 @@ declare const _default: {
         };
     };
     onboarding: {
+        title: string;
         inlineTitle: string;
         landing: {
             action: string;
@@ -258,6 +259,7 @@ declare const _default: {
         };
     };
     "manage-warehouses": {
+        title: string;
         addNew: string;
         editWarehouse: string;
         contactName: string;
@@ -321,6 +323,7 @@ declare const _default: {
         maximumBalanceAmount: string;
     };
     "list-carriers": {
+        title: string;
         headers: {
             accountCarriers: string;
             carriers: string;

package/src/public-sdk.d.ts

@@ -0,0 +1,38 @@
+import { DialogProps, ISidePanelDefaultHeaderProps, SidePanelProps } from "@packlink/giger";
+import { AlchemyProps } from "@shipengine/alchemy";
+import * as JsApi from "@shipengine/js-api";
+import { ManageWarehouses, Onboarding, PurchaseLabel, ViewShipment, VoidLabel } from "./elements";
+type DialogSDKProps = Omit<DialogProps, "isOpen">;
+type SidePanelSDKProps = Omit<SidePanelProps, "isOpen">;
+type ElementsSDKOptions = Omit<AlchemyProps, "getToken" | "children">;
+export declare class ElementsSDK {
+    #private;
+    getClient(token: string, config: JsApi.ShipEngineAPIConfig): {
+        readonly token: never;
+        readonly accountSettings: Omit<JsApi.AccountSettingsAPI, "client">;
+        readonly addresses: Omit<JsApi.AddressesAPI, "client">;
+        readonly carriers: Omit<JsApi.CarriersAPI, "client">;
+        readonly customPackages: Omit<JsApi.CustomPackagesAPI, "client">;
+        readonly insurance: Omit<JsApi.InsuranceAPI, "client">;
+        readonly labels: Omit<JsApi.LabelsAPI, "client">;
+        readonly orderSources: Omit<JsApi.OrderSourcesAPI, "client">;
+        readonly rates: Omit<JsApi.RatesAPI, "client">;
+        readonly salesOrderShipments: Omit<JsApi.SalesOrderShipmentsAPI, "client">;
+        readonly salesOrders: Omit<JsApi.SalesOrdersAPI, "client">;
+        readonly shipments: Omit<JsApi.ShipmentsAPI, "client">;
+        readonly warehouses: Omit<JsApi.WarehousesAPI, "client">;
+    };
+    constructor(getToken: AlchemyProps["getToken"], options?: ElementsSDKOptions);
+    unmount(): void;
+    closeDialog(): void;
+    closeSidePanel(): void;
+    onboardUser(props: Onboarding.ComponentProps, dialogProps: DialogSDKProps): void;
+    purchaseLabel(props: PurchaseLabel.ComponentProps, sidePanelProps: SidePanelSDKProps, sidePanelHeaderProps: ISidePanelDefaultHeaderProps): void;
+    listCarriers(dialogProps: DialogSDKProps): void;
+    manageWarehouses(props: ManageWarehouses.ComponentProps, dialogProps: DialogSDKProps): void;
+    viewShipment(props: ViewShipment.ComponentProps, dialogProps: DialogSDKProps): void;
+    voidLabel(props: VoidLabel.ComponentProps & {
+        labelId: string;
+    }, dialogProps: DialogSDKProps): void;
+}
+export {};

package/src/utilities/styles.d.ts

@@ -1,18 +1,39 @@
 import { Interpolation } from "@emotion/serialize";
 import { Theme } from "@packlink/giger-theme";
 /**
- * Creates a Record of Emotion styles.
+ * The verbose typing is necessary to get around TypeScript's limitations on contextual inference
+ * with generics. https://stackoverflow.com/questions/75999792/ide-autocompletion-broken-with-typescript-mapped-type-conditionals
+ */
+type GetterKey = `get${Capitalize<string>}`;
+type GetterFunction = (...args: any[]) => Interpolation<Theme>;
+type LowerLetters = "a" | "b" | "c" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "n" | "o" | "p" | "q" | "r" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z";
+type Letters = LowerLetters | Uppercase<LowerLetters>;
+type NotG = Exclude<Letters, "g">;
+type NotGE = `g${Exclude<Letters, "e">}`;
+type NotGET = `ge${Exclude<Letters, "t">}`;
+type NotGETUP = `get${Uncapitalize<string>}`;
+type NotGetterKey = NotG | NotGE | NotGET | NotGETUP;
+type StylesConstraint = Record<GetterKey, GetterFunction> & Record<`${NotGetterKey}${string}`, Interpolation<Theme>>;
+/**
+ * Creates a Record of Emotion styles; eliminating the need to explicitly type styles
+ * while remaining fully typesafe w/ autocomplete.
  *
- * Values may be any variant that a `css` prop can accept (a CSSObject, SerializedStyles, a FunctionInterpolation with theme, etc).
+ * Keys prefixed with `get` are assumed to be getters and support arbitrary props.
  *
- * Eliminates the need to explicitly type styles (while remaining fully typed w/ autocomplete).
+ * Values may be any variant of `Interpolation` that the `css` prop can accept:
+ * a `CSSObject`, `SerializedStyles`, a `FunctionInterpolation` with theme, etc.
  *
  * @example
  * ```
  * const styles = createStyles({
- *   container: (theme) => ({ backgroundColor: theme.colors.primary }),
- *   icon: { color: 'red' },
+ *   basicObject: { color: "red" },
+ *   withTheme: (theme) => ({ backgroundColor: theme.palette.primary.main }),
+ *
+ *   getWithArbitraryPropsAndTheme: (disabled?: boolean) => (theme) => ({
+ *     color: theme.palette[disabled ? 'primary' : 'gray'].main,
+ *   }),
  * });
  * ```
  */
-export declare const createStyles: <T extends string>(styles: Record<T, Interpolation<Theme>>) => Record<T, Interpolation<Theme>>;
+export declare const createStyles: <T extends StylesConstraint>(styles: T) => T;
+export {};