@everfur/sdk 0.12.1 → 0.14.0

package/dist/web/shop/index.d.cts

@@ -0,0 +1,59 @@
+import { ReactNode } from 'react';
+import { O as OmsClient, S as ShopPet, a as ShopPaymentsPort, b as ShopPackageSource, c as ShopCopy, d as ShopV3Copy, e as ShopRoute, f as ShopCardHandoff, g as ShopCardReturn, h as ShopProfileName } from '../../idempotency.d-HF6fyRt2.cjs';
+export { i as OmsCartLine, j as OmsClientConfig, k as OmsConsumerAuth, l as OmsError, m as OmsGetToken, n as OmsPlanOperation, o as OmsResult, p as SHOP_COPY, q as SHOP_COPY_PLACEHOLDERS, r as SHOP_V3_COPY, s as SHOP_V3_COPY_PLACEHOLDERS, t as ShopPackage, u as ShopPackageLine, v as ShopPaymentStepResult, w as ShopTabName, x as StripeJsLike, y as StripeJsPaymentsOptions, U as UNAVAILABLE_PACKAGE_SOURCE, z as createOmsClient, A as createOmsPackageSource, B as createStripeJsPayments, C as isOmsRefusal, D as isOmsRetryable, E as isOmsUnavailable, F as newIdempotencyKey, G as shopCopy, H as shopV3Copy } from '../../idempotency.d-HF6fyRt2.cjs';
+import '../../config.d-DJ4mvf_w.cjs';
+import '../../EverfurError.d-8NHtlgzA.cjs';
+import '../../EverfurResult.d-BFH-3s6E.cjs';
+
+interface EverfurShopProps {
+    /** `createOmsClient({ baseUrl, auth: { kind: 'everfur_consumer', getToken } })`. */
+    readonly client: OmsClient;
+    /** The member's pets, for names on lines and choices. */
+    readonly pets?: readonly ShopPet[];
+    /** The host's Stripe.js step (`createStripeJsPayments(stripe)`). Without it, card steps are not offered. */
+    readonly payments?: ShopPaymentsPort | null;
+    /** Default: the OMS plan review routes. */
+    readonly packageSource?: ShopPackageSource;
+    /** The host's words, and the real lines for the `[copy:shop.*]` placeholders. */
+    readonly copy?: Partial<ShopCopy>;
+    /** The host's words for the cart, checkout, order placed, orders and order pages (`SHOP_V3_COPY`), and their placeholders. */
+    readonly v3Copy?: Partial<ShopV3Copy>;
+    /** The page to show. */
+    readonly route: ShopRoute;
+    readonly onRouteChange: (route: ShopRoute) => void;
+    readonly hrefFor: (route: ShopRoute) => string;
+    /** The host's Online Vet booking page, for an Rx product with no prescription. */
+    readonly bookVisitHref?: string | null;
+    /**
+     * Saving a card: send the member to the hosted setup page (`client.startCardSetupSession`) and leave the page.
+     * Without it (and without `payments`), card steps are not offered.
+     */
+    readonly cardHandoff?: ShopCardHandoff | null;
+    /**
+     * A card step that came back through your URL (the setup page's `oms_card`, the 3-D Secure page's
+     * `oms_card_action`). Pass it with `route` on that step's page (`card`, or the order's `order`): the shop shows its
+     * line there once per object. Keep the same object, or pass `null` once it is read.
+     */
+    readonly cardReturn?: ShopCardReturn | null;
+    /** Called once when the shop is not available to this member (shop-config 404). */
+    readonly onUnavailable?: () => void;
+    /**
+     * Saves the owner's first and last name on their Everfur account; resolve true once saved. When a checkout is
+     * refused because the account has no name (OMS 422 `client_name_missing`, which the pharmacy needs), the shop asks
+     * for it in place, calls this, then places the order again.
+     */
+    readonly saveProfileName?: (name: ShopProfileName) => Promise<boolean>;
+    /** Without `saveProfileName`: that same refusal offers a button that calls this (open your own name editor). */
+    readonly onProfileNameRequired?: () => void;
+    /** The order page's "Get help with this order" (open your support for that order). Without it, the link is not drawn. */
+    readonly onOrderHelp?: ((orderId: string) => void) | null;
+    /**
+     * Keeps the cart in this tab's session storage under a key of yours (the member's id, say), so it outlives a
+     * full-page card step. Without it, the cart lives only while the page does.
+     */
+    readonly cartStorageKey?: string | null;
+    readonly hostClassName?: string;
+}
+declare function EverfurShop(props: EverfurShopProps): ReactNode;
+
+export { EverfurShop, type EverfurShopProps, OmsClient, ShopCardHandoff, ShopCardReturn, ShopCopy, ShopPackageSource, ShopPaymentsPort, ShopPet, ShopProfileName, ShopRoute, ShopV3Copy };

package/dist/web/shop/index.d.ts

@@ -0,0 +1,59 @@
+import { ReactNode } from 'react';
+import { O as OmsClient, S as ShopPet, a as ShopPaymentsPort, b as ShopPackageSource, c as ShopCopy, d as ShopV3Copy, e as ShopRoute, f as ShopCardHandoff, g as ShopCardReturn, h as ShopProfileName } from '../../idempotency.d-DXb1BN2A.js';
+export { i as OmsCartLine, j as OmsClientConfig, k as OmsConsumerAuth, l as OmsError, m as OmsGetToken, n as OmsPlanOperation, o as OmsResult, p as SHOP_COPY, q as SHOP_COPY_PLACEHOLDERS, r as SHOP_V3_COPY, s as SHOP_V3_COPY_PLACEHOLDERS, t as ShopPackage, u as ShopPackageLine, v as ShopPaymentStepResult, w as ShopTabName, x as StripeJsLike, y as StripeJsPaymentsOptions, U as UNAVAILABLE_PACKAGE_SOURCE, z as createOmsClient, A as createOmsPackageSource, B as createStripeJsPayments, C as isOmsRefusal, D as isOmsRetryable, E as isOmsUnavailable, F as newIdempotencyKey, G as shopCopy, H as shopV3Copy } from '../../idempotency.d-DXb1BN2A.js';
+import '../../config.d-MX7IKP2f.js';
+import '../../EverfurError.d-8NHtlgzA.js';
+import '../../EverfurResult.d-D_-254ZY.js';
+
+interface EverfurShopProps {
+    /** `createOmsClient({ baseUrl, auth: { kind: 'everfur_consumer', getToken } })`. */
+    readonly client: OmsClient;
+    /** The member's pets, for names on lines and choices. */
+    readonly pets?: readonly ShopPet[];
+    /** The host's Stripe.js step (`createStripeJsPayments(stripe)`). Without it, card steps are not offered. */
+    readonly payments?: ShopPaymentsPort | null;
+    /** Default: the OMS plan review routes. */
+    readonly packageSource?: ShopPackageSource;
+    /** The host's words, and the real lines for the `[copy:shop.*]` placeholders. */
+    readonly copy?: Partial<ShopCopy>;
+    /** The host's words for the cart, checkout, order placed, orders and order pages (`SHOP_V3_COPY`), and their placeholders. */
+    readonly v3Copy?: Partial<ShopV3Copy>;
+    /** The page to show. */
+    readonly route: ShopRoute;
+    readonly onRouteChange: (route: ShopRoute) => void;
+    readonly hrefFor: (route: ShopRoute) => string;
+    /** The host's Online Vet booking page, for an Rx product with no prescription. */
+    readonly bookVisitHref?: string | null;
+    /**
+     * Saving a card: send the member to the hosted setup page (`client.startCardSetupSession`) and leave the page.
+     * Without it (and without `payments`), card steps are not offered.
+     */
+    readonly cardHandoff?: ShopCardHandoff | null;
+    /**
+     * A card step that came back through your URL (the setup page's `oms_card`, the 3-D Secure page's
+     * `oms_card_action`). Pass it with `route` on that step's page (`card`, or the order's `order`): the shop shows its
+     * line there once per object. Keep the same object, or pass `null` once it is read.
+     */
+    readonly cardReturn?: ShopCardReturn | null;
+    /** Called once when the shop is not available to this member (shop-config 404). */
+    readonly onUnavailable?: () => void;
+    /**
+     * Saves the owner's first and last name on their Everfur account; resolve true once saved. When a checkout is
+     * refused because the account has no name (OMS 422 `client_name_missing`, which the pharmacy needs), the shop asks
+     * for it in place, calls this, then places the order again.
+     */
+    readonly saveProfileName?: (name: ShopProfileName) => Promise<boolean>;
+    /** Without `saveProfileName`: that same refusal offers a button that calls this (open your own name editor). */
+    readonly onProfileNameRequired?: () => void;
+    /** The order page's "Get help with this order" (open your support for that order). Without it, the link is not drawn. */
+    readonly onOrderHelp?: ((orderId: string) => void) | null;
+    /**
+     * Keeps the cart in this tab's session storage under a key of yours (the member's id, say), so it outlives a
+     * full-page card step. Without it, the cart lives only while the page does.
+     */
+    readonly cartStorageKey?: string | null;
+    readonly hostClassName?: string;
+}
+declare function EverfurShop(props: EverfurShopProps): ReactNode;
+
+export { EverfurShop, type EverfurShopProps, OmsClient, ShopCardHandoff, ShopCardReturn, ShopCopy, ShopPackageSource, ShopPaymentsPort, ShopPet, ShopProfileName, ShopRoute, ShopV3Copy };