@rechargeapps/storefront-client 0.0.14

package/dist/index.d.ts

@@ -0,0 +1,419 @@
+declare type Method = 'get' | 'post' | 'put' | 'delete';
+declare type Request = <T>(method: Method, url: string, options?: RequestOptions) => Promise<T>;
+interface GetRequestOptions {
+    id?: string;
+    query?: unknown;
+}
+interface CRUDRequestOptions {
+    id?: string;
+    data?: unknown;
+}
+/** Custom headers we use within our storefront client */
+interface CustomHeaders {
+    ['X-Recharge-App']?: 'storefront-client';
+}
+/** We only support headers with an object syntax */
+declare type RequestHeaders = Record<string, string> & CustomHeaders;
+interface RequestOptionsHeaders {
+    headers?: RequestHeaders;
+}
+declare type RequestOptions = GetRequestOptions & CRUDRequestOptions & RequestOptionsHeaders;
+
+interface BundleSelection {
+    collectionId: string;
+    externalProductId: string;
+    externalVariantId: string;
+    quantity: number;
+}
+interface Bundle {
+    externalVariantId: string;
+    externalProductId: string;
+    selections: BundleSelection[];
+}
+
+/** HEXA, RGBA, HSLA */
+declare type ColorString = string;
+/** HTML String */
+declare type HTMLString = string;
+/** ISO 8601 date time */
+declare type IsoDateString = string;
+
+declare type FirstOption = 'onetime' | 'autodeliver';
+declare type IntervalUnit = 'day' | 'week' | 'month';
+declare type PriceAdjustmentsType = 'percentage';
+declare type StorefrontPurchaseOption = 'subscription_and_onetime' | 'subscription_only' | 'onetime_only' | 'inactive';
+interface BundleTranslations {
+    cpb_add: string;
+    cpb_add_items_to_continue: string;
+    cpb_add_more_items: string;
+    cpb_apply_filters: string;
+    cpb_cancel: string;
+    cpb_clear_all_filters: string;
+    cpb_contents_for: string;
+    cpb_day: string;
+    cpb_filters: string;
+    cpb_frequency: string;
+    cpb_frequency_values: string;
+    cpb_items_selected: string;
+    cpb_items_selected_filters: string;
+    cpb_month: string;
+    cpb_remove: string;
+    cpb_remove_items_to_continue: string;
+    cpb_remove_some_items: string;
+    cpb_save_button_text: string;
+    cpb_saved_message: string;
+    cpb_saving_message: string;
+    cpb_select_bundle_contents: string;
+    cpb_select_your_contents_to_continue_message_modal: string;
+    cpb_select_your_contents_to_continue_title_modal: string;
+    cpb_selection_count_alert: string;
+    cpb_update_bundle_contents: string;
+    cpb_week: string;
+    cpb_your: string;
+    cpb_your_next_order: string;
+    pdp_add: string;
+    pdp_add_items_to_continue: string;
+    'pdp_add_one-off_extras': string;
+    'pdp_add_one-off_extras_description': string;
+    'pdp_add_repeating_add-ons': string;
+    'pdp_add_repeating_add-ons_description': string;
+    pdp_add_to_cart: string;
+    pdp_add_to_cart_alert: string;
+    pdp_add_to_cart_extras: string;
+    pdp_add_to_cart_failed: string;
+    pdp_apply_filters: string;
+    pdp_back: string;
+    pdp_bundle_contents: string;
+    pdp_cancel: string;
+    pdp_choose_items: string;
+    pdp_choose_items_alert: string;
+    pdp_choose_maximum: string;
+    pdp_choose_range: string;
+    pdp_clear_all_filters: string;
+    pdp_day: string;
+    pdp_filters: string;
+    pdp_frequency: string;
+    pdp_frequency_value: string;
+    pdp_items_selected: string;
+    pdp_items_selected_filters: string;
+    pdp_max_per_item_reached_alert: string;
+    pdp_month: string;
+    pdp_next: string;
+    'pdp_one-off_extras': string;
+    pdp_only_once: string;
+    pdp_order_summary: string;
+    pdp_plan_changed_alert: string;
+    pdp_proceed_to_cart: string;
+    pdp_product_added: string;
+    pdp_regular_delivery: string;
+    pdp_remove: string;
+    pdp_remove_items_alert: string;
+    pdp_remove_items_to_continue: string;
+    'pdp_repeating_add-ons': string;
+    pdp_selection_completed_alert: string;
+    pdp_selection_count_alert: string;
+    pdp_sold_out: string;
+    pdp_subscribe: string;
+    pdp_total: string;
+    pdp_update_your_selections_to_continue: string;
+    pdp_week: string;
+}
+interface Translations {
+    days: string;
+    week: string;
+    weeks: string;
+    month: string;
+    months: string;
+}
+declare type WidgetTemplateType = 'radio' | 'checkbox' | 'button_group' | 'radio_group';
+declare type WidgetIconColor = '#191D48' | 'white' | 'black' | '#ffffff';
+/****************** 2020-12 **********************/
+interface CDNProductResource {
+    product: CDNProductRaw;
+    meta: {
+        version: '2020-12';
+    };
+}
+interface CDNProductKeyObject {
+    [key: string]: CDNProduct;
+}
+interface CDNProductsAndSettingsResource {
+    products: {
+        [key: string]: CDNProductRaw;
+    }[];
+    widget_settings: CDNWidgetSettingsRaw;
+    store_settings: CDNStoreSettings;
+    meta?: {
+        status: string;
+        message: string;
+    };
+}
+interface CDNSellingPlan {
+    order_interval_frequency: string | number;
+    created_at?: IsoDateString;
+    order_interval_unit_type: IntervalUnit;
+    updated_at?: IsoDateString;
+    id: number;
+    selling_plan_id: number;
+    selling_plan_name: string;
+    price_adjustments_value_type: PriceAdjustmentsType;
+    price_adjustments_value: number;
+}
+interface CDNSellingPlanGroup {
+    selling_plan_group_id: string | number;
+    selling_plans: CDNSellingPlan[];
+    subscription_product_id: number;
+}
+interface CDNSubscriptionOption {
+    storefront_purchase_options: StorefrontPurchaseOption;
+    updated_at: IsoDateString;
+    is_prepaid?: boolean;
+}
+interface CDNSellingPlanAllocations {
+    selling_plan_group_id: string | number;
+    selling_plan_id: number;
+    discounted_price: string;
+}
+interface CDNPrices {
+    compare_at_price: string | null;
+    unit_price: string;
+    discounted_price: string;
+    zero_decimal_currency: boolean;
+}
+interface CDNVariantOptionValue {
+    id: number;
+    label: string;
+}
+interface CDNVariant {
+    id: number;
+    option_values: CDNVariantOptionValue[];
+    prices: CDNPrices;
+    selling_plan_allocations: CDNSellingPlanAllocations[];
+}
+interface CDNProductOptionValue {
+    id?: number | null;
+    label: string;
+    position: number;
+}
+interface CDNProductOption {
+    id: number;
+    name: string;
+    position: number;
+    values: CDNProductOptionValue[];
+}
+interface CDNProductRaw {
+    id: number | null;
+    bundle_product?: CDNBundleSettings | null;
+    external_product_id: number;
+    in_recharge: boolean;
+    options: CDNProductOption[];
+    variants: CDNVariant[];
+    subscription_options: CDNSubscriptionOption;
+    selling_plan_groups: CDNSellingPlanGroup[];
+}
+interface CDNProduct extends CDNProductRaw {
+    /** @deprecated */
+    isSubscriptionOnly: boolean;
+    is_subscription_only: boolean;
+}
+interface CDNProductAndSettings {
+    product: CDNProduct;
+    widget_settings: CDNWidgetSettings;
+    store_settings: CDNStoreSettings;
+    /** @deprecated */
+    widgetSettings: CDNWidgetSettings;
+    /** @deprecated */
+    storeSettings: CDNStoreSettings;
+}
+interface CDNProductsAndSettings {
+    products: CDNProductKeyObject[];
+    widget_settings: CDNWidgetSettings;
+    store_settings: CDNStoreSettings;
+}
+interface CDNBaseWidgetSettings {
+    active_color: ColorString;
+    auto_inject?: boolean;
+    background_color: ColorString;
+    bundle_translations?: BundleTranslations;
+    delivery_dropdown_label: string;
+    display_on: string[];
+    first_option: FirstOption;
+    font_color: ColorString;
+    form_type: string;
+    how_it_works: HTMLString;
+    learnmore_url: string;
+    learnmore_verbiage: string;
+    onetime_message: string;
+    popup_background_color: ColorString;
+    popup_link_color: ColorString;
+    popup_text_color: ColorString;
+    poweredby_url: string;
+    published: boolean;
+    select_subscription_first: boolean;
+    show_learnmore: boolean;
+    show_poweredby: boolean;
+    show_subscription_details: boolean;
+    show_subscription_details_icon: boolean;
+    sub_and_save_ext_label: string;
+    subscribe_message: string;
+    subscribe_without_discount_message: string;
+    subscription_details_verbiage: string;
+    translations: Translations;
+    widget_charge_every: string;
+    widget_deliver_every: string;
+    widget_icon: WidgetIconColor;
+    widget_template_type: WidgetTemplateType;
+}
+declare type CDNExcludedWidgetSettings = 'display_on' | 'first_option';
+interface CDNWidgetSettings extends Omit<CDNBaseWidgetSettings, CDNExcludedWidgetSettings> {
+    /** @deprecated */
+    autoInject: boolean;
+    /** @deprecated */
+    validPages: string[];
+    /** @deprecated */
+    isSubscriptionFirst: boolean;
+    auto_inject: boolean;
+    valid_pages: string[];
+    is_subscription_first: boolean;
+}
+declare type CDNWidgetSettingsRaw = {
+    [key in keyof CDNBaseWidgetSettings]: string;
+};
+interface CDNWidgetSettingsResource {
+    widget_settings: CDNWidgetSettingsRaw;
+    meta: {
+        version: string;
+    };
+}
+interface CDNStoreSettings {
+    store_currency: {
+        currency_code: string;
+        currency_symbol: string;
+        decimal_separator: string;
+        thousands_separator: string;
+        currency_symbol_location: string;
+        zero_decimal_currency?: boolean;
+    };
+}
+/****************** 2021-08 **********************/
+/**************** Bundles ****************/
+interface CDNBundleStepOption {
+    content: string;
+    defaultImage: string;
+}
+interface CDNBundleStep {
+    data?: {
+        optionsMeta: {
+            [key: string]: CDNBundleStepOption;
+        };
+    };
+    disable: boolean;
+    index: string;
+    name: string;
+    title: string;
+    type: 'variantSelector' | 'all-collections' | 'addons' | 'summary' | 'cross-sells';
+}
+interface CDNBundleLayoutSettings {
+    addToCartCallback: {
+        type: 'none';
+        value: string;
+    };
+    addons: {
+        collectionHandle: string;
+        collectionId: string;
+        enabled: boolean;
+    };
+    collapsibleSections: boolean;
+    crossSells: {
+        collectionId: string;
+        enabled: boolean;
+        collectionHandle: string;
+    };
+    defaultFrequency: string;
+    defaultVariantId: string;
+    description: string;
+    filters: any[];
+    learnMoreModal: boolean;
+    published: boolean;
+    showVariants: boolean;
+    template: 'one-page' | 'multi-step';
+    templateSettings: {
+        onePage: {
+            frequencySelector: 'dropdown';
+        };
+        multiStep?: {
+            steps: CDNBundleStep[];
+            optionImages: string;
+        };
+    };
+    title: string;
+    visibility: {
+        portal: boolean;
+        signup: boolean;
+    };
+}
+interface CDNBundleVariantOptionSource {
+    id: number;
+    collection_id: string;
+    quantity_max: number | null;
+    quantity_min: number | null;
+}
+interface CDNBundleVariantSelectionDefault {
+    id: number;
+    quantity: number;
+    external_variant_id: string;
+}
+interface CDNBundleVariant {
+    enabled: boolean;
+    external_variant_id: string;
+    id: number;
+    items_count: number;
+    option_sources: CDNBundleVariantOptionSource[];
+    selection_defaults?: CDNBundleVariantSelectionDefault[];
+}
+interface CDNBundleSettings {
+    customization_window_disabled_message: string | null;
+    customization_window?: number;
+    default_bundle_variant_id?: number;
+    description: string | null;
+    external_product_id: string;
+    id: number;
+    is_customizable?: boolean;
+    layout_settings: CDNBundleLayoutSettings;
+    layout_settings_version: '2021-11';
+    max_quantity_per_variant: number | null;
+    reset_box_contents?: boolean;
+    variants: CDNBundleVariant[];
+}
+
+declare type StorefrontEnvironment = 'stage' | 'prod';
+interface StorefrontOptions {
+    storeIdentifier: string;
+    environment: StorefrontEnvironment;
+}
+
+declare const getProduct: (externalProductId: string | number) => Promise<CDNProduct>;
+declare const getStoreSettings: () => Promise<CDNStoreSettings>;
+declare const getWidgetSettings: () => Promise<CDNWidgetSettings>;
+declare const getProductsAndSettings: () => Promise<CDNProductsAndSettings>;
+declare const getProducts: () => Promise<CDNProductKeyObject[]>;
+declare const getProductAndSettings: (externalProductId: string | number) => Promise<CDNProductAndSettings>;
+declare const getBundleSettings: (externalProductId: string | number) => Promise<CDNBundleSettings | null | undefined>;
+declare const resetCache: () => void;
+
+declare const getBundleId: (bundle: Bundle) => Promise<string>;
+declare const validateBundle: (bundle: Bundle) => Promise<boolean>;
+
+interface InitOptions extends Omit<StorefrontOptions, 'environment'> {
+    /** This is only for internal use. Sets the environment where data is fetched from. */
+    environment?: StorefrontOptions['environment'];
+}
+declare const api: {
+    get<T>(url: string, requestOptions?: GetRequestOptions): Promise<T>;
+    post<T_1>(url: string, requestOptions?: CRUDRequestOptions): Promise<T_1>;
+    put<T_2>(url: string, requestOptions?: CRUDRequestOptions): Promise<T_2>;
+    delete<T_3>(url: string, requestOptions?: CRUDRequestOptions): Promise<T_3>;
+};
+declare function initRecharge(opt: InitOptions): void;
+
+export { Bundle, BundleSelection, BundleTranslations, CDNBaseWidgetSettings, CDNBundleLayoutSettings, CDNBundleSettings, CDNBundleStep, CDNBundleStepOption, CDNBundleVariant, CDNBundleVariantOptionSource, CDNBundleVariantSelectionDefault, CDNPrices, CDNProduct, CDNProductAndSettings, CDNProductKeyObject, CDNProductOption, CDNProductOptionValue, CDNProductRaw, CDNProductResource, CDNProductsAndSettings, CDNProductsAndSettingsResource, CDNSellingPlan, CDNSellingPlanAllocations, CDNSellingPlanGroup, CDNStoreSettings, CDNSubscriptionOption, CDNVariant, CDNVariantOptionValue, CDNWidgetSettings, CDNWidgetSettingsRaw, CDNWidgetSettingsResource, CRUDRequestOptions, FirstOption, GetRequestOptions, InitOptions, IntervalUnit, Method, PriceAdjustmentsType, Request, RequestHeaders, RequestOptions, RequestOptionsHeaders, StorefrontEnvironment, StorefrontOptions, StorefrontPurchaseOption, Translations, WidgetIconColor, WidgetTemplateType, api, getBundleId, getBundleSettings, getProduct, getProductAndSettings, getProducts, getProductsAndSettings, getStoreSettings, getWidgetSettings, initRecharge, resetCache, validateBundle };