@shipengine/elements-sdk 0.9.0 → 1.0.0

package/elements-root.d.ts

@@ -0,0 +1,23 @@
+import { ISidePanelDefaultHeaderProps, SidePanelProps } from "@shipengine/giger";
+import { ElementsProviderProps } from "@shipengine/elements";
+export type SidePanelHeaderProps = ISidePanelDefaultHeaderProps & {
+    title: string;
+};
+export type SidePanelSDKProps = Omit<SidePanelProps, "isOpen">;
+export type ElementsEvent = {
+    Element: any;
+    props: any;
+    container?: Element;
+    id: string;
+    sidePanelHeaderProps?: SidePanelHeaderProps;
+    sidePanelProps?: SidePanelSDKProps;
+};
+export type UnmountElementsEvent = {
+    id: string;
+};
+export type UpdateElementsEvent = Pick<ElementsEvent, "props" | "id">;
+export type ElementsRegistry = Record<string, Omit<ElementsEvent, "id">>;
+export declare const MOUNT_ELEMENTS_EVENT = "se.lmnt.mountElement";
+export declare const UNMOUNT_ELEMENTS_EVENT = "se.lmnt.unmountElement";
+export declare const UPDATE_ELEMENTS_EVENT = "se.lmnt.updateElement";
+export declare const ElementsRoot: (providerProps: Omit<ElementsProviderProps, "children">) => import("@emotion/react/jsx-runtime").JSX.Element;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shipengine/elements-sdk",
-  "version": "0.9.0",
+  "version": "1.0.0",
   "types": "./public-sdk.d.ts",
   "module": "shipengine-elements-sdk.mjs",
   "peerDependencies": {

package/public-sdk.d.ts

@@ -1,50 +1,129 @@
-import { ISidePanelDefaultHeaderProps, SidePanelProps } from "@shipengine/giger";
-import { AlchemyProviderProps } from "@shipengine/alchemy";
-import * as JsApi from "@shipengine/js-api";
-import { AccountSettings, ExternalCarriers, Onboarding, PurchaseLabel, PurchaseLabelWorkflow, ViewShipment, VoidLabel, ConnectCarrier } from "@shipengine/elements";
-type SidePanelHeaderProps = ISidePanelDefaultHeaderProps & {
-    title: string;
+import { ShipEngineElement } from "./shipengine-element";
+import { ShipEngineAPIConfig } from "@shipengine/js-api";
+import { SidePanelHeaderProps, SidePanelSDKProps } from "./elements-root";
+import { ElementsProviderProps, PurchaseLabel, AccountSettings, LabelWorkflow, ConnectExternalCarrier, Onboarding, ShipmentSummary, VoidLabel, ManageExternalCarriers } from "@shipengine/elements";
+export type ElementsSDKOptions = Omit<ElementsProviderProps, "getToken" | "children" | "container">;
+export type ElementProps = {
+    accountSettings: AccountSettings.ComponentProps;
+    carrierServices: {};
+    connectExternalCarrier: ConnectExternalCarrier.ComponentProps;
+    labelLayout: {};
+    labelWorkFlow: LabelWorkflow.LabelWorkflowProps;
+    manageCarriers: {};
+    manageExternalCarriers: ManageExternalCarriers.ComponentProps;
+    manageFunding: {};
+    manageWarehouses: {};
+    onboarding: Onboarding.ComponentProps;
+    paymentMethodSettings: {};
+    purchaseLabel: PurchaseLabel.PurchaseLabelCommonProps;
+    shipmentSummary: ShipmentSummary.ComponentProps;
+    transactionHistory: {};
+    unitSettings: {};
+    voidLabel: VoidLabel.ComponentProps;
 };
-type SidePanelSDKProps = Omit<SidePanelProps, "isOpen">;
-type ElementsSDKOptions = Omit<AlchemyProviderProps, "getToken" | "children">;
+export type AvailableElements = keyof ElementProps;
 export declare class ElementsSDK {
     #private;
-    getClient(token: string, config: JsApi.ShipEngineAPIConfig): {
+    constructor(getToken: ElementsProviderProps["getToken"], options?: ElementsSDKOptions, container?: HTMLElement | string);
+    getClient(token: string, config: ShipEngineAPIConfig): {
         readonly token: never;
-        readonly accountSettings: Omit<JsApi.AccountSettingsAPI, "client">;
+        readonly accountSettings: Omit<import("@shipengine/js-api").AccountSettingsAPI, "client">;
         readonly accountBillingPlan: Omit<import("@shipengine/js-api/account-billing-plan").AccountBillingPlanAPI, "client">;
-        readonly addresses: Omit<JsApi.AddressesAPI, "client">;
-        readonly carriers: Omit<JsApi.CarriersAPI, "client">;
-        readonly connections: Omit<JsApi.ConnectionsAPI, "client">;
-        readonly customPackages: Omit<JsApi.CustomPackagesAPI, "client">;
-        readonly fundingSources: Omit<JsApi.FundingSourcesAPI, "client">;
-        readonly insurance: Omit<JsApi.InsuranceAPI, "client">;
-        readonly labels: Omit<JsApi.LabelsAPI, "client">;
-        readonly orderSources: Omit<JsApi.OrderSourcesAPI, "client">;
-        readonly rateCards: Omit<JsApi.RateCardsAPI, "client">;
-        readonly rates: Omit<JsApi.RatesAPI, "client">;
-        readonly salesOrderShipments: Omit<JsApi.SalesOrderShipmentsAPI, "client">;
-        readonly salesOrders: Omit<JsApi.SalesOrdersAPI, "client">;
-        readonly servicePoints: Omit<JsApi.ServicePointsAPI, "client">;
-        readonly shipments: Omit<JsApi.ShipmentsAPI, "client">;
-        readonly themes: Omit<JsApi.ThemesAPI, "client">;
-        readonly warehouses: Omit<JsApi.WarehousesAPI, "client">;
-        readonly shippingRules: Omit<JsApi.ShippingRulesAPI, "client">;
-        readonly webhooks: Omit<JsApi.WebhooksAPI, "client">;
-        readonly sellers: Omit<JsApi.SellersAPI, "client">;
+        readonly addresses: Omit<import("@shipengine/js-api").AddressesAPI, "client">;
+        readonly carriers: Omit<import("@shipengine/js-api").CarriersAPI, "client">;
+        readonly connections: Omit<import("@shipengine/js-api").ConnectionsAPI, "client">;
+        readonly customPackages: Omit<import("@shipengine/js-api").CustomPackagesAPI, "client">;
+        readonly fundingSources: Omit<import("@shipengine/js-api").FundingSourcesAPI, "client">;
+        readonly insurance: Omit<import("@shipengine/js-api").InsuranceAPI, "client">;
+        readonly labels: Omit<import("@shipengine/js-api").LabelsAPI, "client">;
+        readonly orderSources: Omit<import("@shipengine/js-api").OrderSourcesAPI, "client">;
+        readonly rateCards: Omit<import("@shipengine/js-api").RateCardsAPI, "client">;
+        readonly rates: Omit<import("@shipengine/js-api").RatesAPI, "client">;
+        readonly salesOrderShipments: Omit<import("@shipengine/js-api").SalesOrderShipmentsAPI, "client">;
+        readonly salesOrders: Omit<import("@shipengine/js-api").SalesOrdersAPI, "client">;
+        readonly servicePoints: Omit<import("@shipengine/js-api").ServicePointsAPI, "client">;
+        readonly shipments: Omit<import("@shipengine/js-api").ShipmentsAPI, "client">;
+        readonly themes: Omit<import("@shipengine/js-api").ThemesAPI, "client">;
+        readonly warehouses: Omit<import("@shipengine/js-api").WarehousesAPI, "client">;
+        readonly shippingRules: Omit<import("@shipengine/js-api").ShippingRulesAPI, "client">;
+        readonly webhooks: Omit<import("@shipengine/js-api").WebhooksAPI, "client">;
+        readonly sellers: Omit<import("@shipengine/js-api").SellersAPI, "client">;
     };
-    constructor(getToken: AlchemyProviderProps["getToken"], options?: ElementsSDKOptions);
-    unmount(): void;
-    closeSidePanel(): void;
-    connectExternalCarrier(props: ConnectCarrier.ComponentProps, sidePanelProps: SidePanelSDKProps, sidePanelHeaderProps: SidePanelHeaderProps): void;
-    manageAccountSettings(props: AccountSettings.ComponentProps, sidePanelProps: SidePanelSDKProps, sidePanelHeaderProps: SidePanelHeaderProps): void;
-    manageExternalCarriers(props: ExternalCarriers.ComponentProps, sidePanelProps: SidePanelSDKProps, sidePanelHeaderProps: SidePanelHeaderProps): void;
-    onboardUser(props: Onboarding.ComponentProps, sidePanelProps: SidePanelSDKProps, sidePanelHeaderProps: SidePanelHeaderProps): void;
-    purchaseLabel(props: PurchaseLabel.ComponentProps, sidePanelProps: SidePanelSDKProps, sidePanelHeaderProps: SidePanelHeaderProps): void;
-    purchaseLabelWorkflow(props: PurchaseLabelWorkflow.PurchaseLabelWorkflowProps, sidePanelProps: SidePanelSDKProps, sidePanelHeaderProps: SidePanelHeaderProps): void;
-    viewShipment(props: ViewShipment.ComponentProps, sidePanelProps: SidePanelSDKProps, sidePanelHeaderProps: SidePanelHeaderProps): void;
-    voidLabel(props: VoidLabel.ComponentProps & {
-        labelId: string;
-    }, sidePanelProps: SidePanelSDKProps, sidePanelHeaderProps: SidePanelHeaderProps): void;
+    create<Key extends AvailableElements>(type: AvailableElements, props?: any): ShipEngineElement<ElementProps[Key]>;
+    destroy(): void;
+    /**
+     * @deprecated since SDK version 2.0
+     *
+     * Please use the create method and render the Element using the renderInSidePanel method
+     */
+    closeSidePanel(type: AvailableElements): void;
+    /**
+     * @deprecated since SDK version 2.0
+     *
+     * Please use the create method and render the Element using the renderInSidePanel method
+     */
+    manageAccountSettings(props: {
+        elementProps: ElementProps["accountSettings"];
+        sidePanelProps: SidePanelSDKProps;
+        sidePanelHeaderProps: SidePanelHeaderProps;
+    }): void;
+    /**
+     * @deprecated since SDK version 2.0
+     *
+     * Please use the create method and render the Element using the renderInSidePanel method
+     */
+    manageExternalCarriers(props: {
+        sidePanelProps: SidePanelSDKProps;
+        sidePanelHeaderProps: SidePanelHeaderProps;
+    }): void;
+    /**
+     * @deprecated since SDK version 2.0
+     *
+     * Please use the create method and render the Element using the renderInSidePanel method
+     */
+    onboardUser(props: {
+        elementProps: ElementProps["onboarding"];
+        sidePanelHeaderProps?: SidePanelHeaderProps;
+        sidePanelProps?: SidePanelSDKProps;
+    }): void;
+    /**
+     * @deprecated since SDK version 2.0
+     *
+     * Please use the create method and render the Element using the renderInSidePanel method
+     */
+    labelWorkflow(props: {
+        elementProps: ElementProps["labelWorkFlow"];
+        sidePanelHeaderProps?: SidePanelHeaderProps;
+        sidePanelProps?: SidePanelSDKProps;
+    }): void;
+    /**
+     * @deprecated since SDK version 2.0
+     *
+     * Please use the create method and render the Element using the renderInSidePanel method
+     */
+    purchaseLabel(props: {
+        elementProps: ElementProps["purchaseLabel"];
+        sidePanelHeaderProps?: SidePanelHeaderProps;
+        sidePanelProps?: SidePanelSDKProps;
+    }): void;
+    /**
+     * @deprecated since SDK version 2.0
+     *
+     * Please use the create method and render the Element using the renderInSidePanel method
+     */
+    shipmentSummary(props: {
+        elementProps: ElementProps["shipmentSummary"];
+        sidePanelHeaderProps?: SidePanelHeaderProps;
+        sidePanelProps?: SidePanelSDKProps;
+    }): void;
+    /**
+     * @deprecated since SDK version 2.0
+     *
+     * Please use the create method and render the Element using the renderInSidePanel method
+     */
+    voidLabel(props: {
+        elementProps: ElementProps["voidLabel"];
+        sidePanelHeaderProps?: SidePanelHeaderProps;
+        sidePanelProps?: SidePanelSDKProps;
+    }): void;
 }
-export {};

package/shipengine-element.d.ts

@@ -0,0 +1,14 @@
+import { SidePanelHeaderProps, SidePanelSDKProps } from "./elements-root";
+export declare class ShipEngineElement<Props> {
+    #private;
+    constructor(component: any, id?: string, props?: Props);
+    mount(node: HTMLElement | string, props?: Props): void;
+    unmount(): void;
+    update(props: Props): void;
+    renderSidePanel({ elementProps, sidePanelHeaderProps, sidePanelProps, }: {
+        elementProps?: Props;
+        sidePanelHeaderProps?: SidePanelHeaderProps;
+        sidePanelProps?: SidePanelSDKProps;
+    }): void;
+    closeSidePanel(): void;
+}