ui.shipaid.com 0.3.26 → 0.3.28

package/dist-types/common/shopify/types/ShopifyCart.d.ts

@@ -1,28 +1,29 @@
-export interface ShopifyCart {
-    /** Should be the lowest common denomination */
-    total_price: number;
-    item_count: number;
-    items?: ShopifyCartItem[];
-}
-export interface ShopifyCartItem {
-    id: number;
-    index: number;
-    position: number;
-    quantity: number;
-    variant_id: number;
-    key: string;
-    sku: string;
-    /** Should be the lowest common denomination */
-    final_line_price: number;
-}
-export interface FeaturedImage {
-    aspect_ratio: number;
-    alt: string;
-    height: number;
-    url: string;
-    width: number;
-}
-export interface OptionsWithValues {
-    name: string;
-    value: string;
-}
+export interface ShopifyCart {
+    /** Should be the lowest common denomination */
+    total_price: number;
+    item_count: number;
+    items?: ShopifyCartItem[];
+}
+export interface ShopifyCartItem {
+    id: number;
+    index: number;
+    position: number;
+    quantity: number;
+    variant_id: number;
+    key: string;
+    sku: string;
+    /** Should be the lowest common denomination */
+    final_line_price: number;
+    selling_plan_allocation?: any;
+}
+export interface FeaturedImage {
+    aspect_ratio: number;
+    alt: string;
+    height: number;
+    url: string;
+    width: number;
+}
+export interface OptionsWithValues {
+    name: string;
+    value: string;
+}

package/dist-types/common/shopify/types/ShopifyProduct.d.ts

@@ -1,7 +1,7 @@
-export interface ShopifyProduct {
-    variants?: ShopifyProductVariant[];
-}
-export interface ShopifyProductVariant {
-    id: number;
-    price: string;
-}
+export interface ShopifyProduct {
+    variants?: ShopifyProductVariant[];
+}
+export interface ShopifyProductVariant {
+    id: number;
+    price: string;
+}

package/dist-types/common/types/ShipAid.d.ts

@@ -1,53 +1,53 @@
-export interface ProtectionSettingsProductVariant {
-    id?: string;
-    sku?: string;
-    price?: string;
-    title?: string;
-    selectedOptions?: Array<{
-        name?: string;
-        value?: string;
-    }>;
-}
-export interface ProtectionSettingsProduct {
-    id?: string;
-    title?: string;
-    options?: Array<{
-        name: string;
-        value: string;
-    }>;
-    variants?: {
-        edges?: Array<{
-            node?: ProtectionSettingsProductVariant;
-        }>;
-    };
-}
-export interface ProtectionSettings {
-    product?: ProtectionSettingsProduct;
-}
-export interface ProtectionSettingsPercentage {
-    protectionType: 'PERCENTAGE';
-    percentage: number;
-    minimumFee: number;
-}
-export interface ProtectionSettingsFixed {
-    protectionType: 'FIXED';
-    defaultFee?: number;
-    rules?: Array<{
-        fee?: number;
-        rangeLower?: number;
-        rangeUpper?: number;
-    }>;
-}
-export interface ShipAidStore {
-    store: string;
-    currency: string;
-    widgetAutoOptIn?: boolean;
-    widgetPollProtection?: boolean;
-    widgetShowCart?: boolean;
-    excludedProductSkus?: string[];
-    excludedProductsVariantsId?: string[];
-    excludedCustomersIdsAutoOptIn?: string[] | null;
-    planActive: boolean;
-    protectionSettings: ProtectionSettingsFixed | ProtectionSettingsPercentage;
-    widgetConfigurations: any;
-}
+export interface ProtectionSettingsProductVariant {
+    id?: string;
+    sku?: string;
+    price?: string;
+    title?: string;
+    selectedOptions?: Array<{
+        name?: string;
+        value?: string;
+    }>;
+}
+export interface ProtectionSettingsProduct {
+    id?: string;
+    title?: string;
+    options?: Array<{
+        name: string;
+        value: string;
+    }>;
+    variants?: {
+        edges?: Array<{
+            node?: ProtectionSettingsProductVariant;
+        }>;
+    };
+}
+export interface ProtectionSettings {
+    product?: ProtectionSettingsProduct;
+}
+export interface ProtectionSettingsPercentage {
+    protectionType: 'PERCENTAGE';
+    percentage: number;
+    minimumFee: number;
+}
+export interface ProtectionSettingsFixed {
+    protectionType: 'FIXED';
+    defaultFee?: number;
+    rules?: Array<{
+        fee?: number;
+        rangeLower?: number;
+        rangeUpper?: number;
+    }>;
+}
+export interface ShipAidStore {
+    store: string;
+    currency: string;
+    widgetAutoOptIn?: boolean;
+    widgetPollProtection?: boolean;
+    widgetShowCart?: boolean;
+    excludedProductSkus?: string[];
+    excludedProductsVariantsId?: string[];
+    excludedCustomersIdsAutoOptIn?: string[] | null;
+    planActive: boolean;
+    protectionSettings: ProtectionSettingsFixed | ProtectionSettingsPercentage;
+    widgetConfigurations: any;
+}

package/dist-types/widget/src/assets/icons.d.ts

@@ -1,8 +1,8 @@
-export declare const CheckmarkIcon: import("lit").TemplateResult<1>;
-export declare const ShipAidLogo: import("lit").TemplateResult<1>;
-export declare const ShipAidLogoText: import("lit").TemplateResult<1>;
-export declare const ShipAidLogoPopUp: import("lit").TemplateResult<1>;
-export declare const CheckmarkRibbon: import("lit").TemplateResult<1>;
-export declare const MapIcon: import("lit").TemplateResult<1>;
-export declare const BoxIcon: import("lit").TemplateResult<1>;
-export declare const BellIcon: import("lit").TemplateResult<1>;
+export declare const CheckmarkIcon: import("lit").TemplateResult<1>;
+export declare const ShipAidLogo: import("lit").TemplateResult<1>;
+export declare const ShipAidLogoText: import("lit").TemplateResult<1>;
+export declare const ShipAidLogoPopUp: import("lit").TemplateResult<1>;
+export declare const CheckmarkRibbon: import("lit").TemplateResult<1>;
+export declare const MapIcon: import("lit").TemplateResult<1>;
+export declare const BoxIcon: import("lit").TemplateResult<1>;
+export declare const BellIcon: import("lit").TemplateResult<1>;

package/dist-types/widget/src/assets/learn-more-styles.d.ts

@@ -1,2 +1,2 @@
-declare const styles: import("lit").CSSResult;
-export default styles;
+declare const styles: import("lit").CSSResult;
+export default styles;

package/dist-types/widget/src/assets/styles.d.ts

@@ -1,2 +1,2 @@
-declare const _default: import("lit").CSSResult;
-export default _default;
+declare const _default: import("lit").CSSResult;
+export default _default;

package/dist-types/widget/src/components/learn-more-popup.d.ts

@@ -1,8 +1,8 @@
-import { LitElement } from 'lit';
-declare class LearnMorePopup extends LitElement {
-    static styles: import("lit").CSSResult;
-    active: boolean;
-    handleClosePopup(): void;
-    render(): import("lit").TemplateResult<1>;
-}
-export default LearnMorePopup;
+import { LitElement } from 'lit';
+declare class LearnMorePopup extends LitElement {
+    static styles: import("lit").CSSResult;
+    active: boolean;
+    handleClosePopup(): void;
+    render(): import("lit").TemplateResult<1>;
+}
+export default LearnMorePopup;

package/dist-types/widget/src/shipaid-widget.d.ts

@@ -1,108 +1,111 @@
-import { LitElement, PropertyValues } from 'lit';
-import './components/learn-more-popup';
-import type { ShopifyCart } from '../types/shopify';
-/**
- * ShipAid Widget.
- *
- * @description When the <shipaid-widget> element is added to page, it will render this element,
- * allowing a customer to add ShipAid protection to cart (and remove).
- *
- */
-export declare class ShipAidWidget extends LitElement {
-    static styles: import("lit").CSSResult;
-    disablePolling: boolean;
-    disableActions: boolean;
-    pollingInterval: number;
-    disableRefresh: boolean;
-    refreshCart: boolean;
-    persistPopup: boolean;
-    defaultToggleButton: boolean;
-    lang: string;
-    currency: undefined;
-    customerId: undefined;
-    /** API Proxy pathname */
-    private _apiEndpoint;
-    /** The current store domain */
-    private _storeDomain;
-    /** The current store data object from the ShipAid API */
-    private _store;
-    /** The current cart data object from the Shopify API */
-    private _cart;
-    /** The current protection product data object from the Shopify API */
-    private _protectionProduct;
-    /** When the cart was last updated */
-    private _cartLastUpdated;
-    /** Whether we have finished the initial setup */
-    private _hasFinishedSetup;
-    /** Can be used to hide all widget content */
-    private _shouldShowWidget;
-    /** Whether the ShipAid protection product is currently added to the cart */
-    private _hasProtectionInCart;
-    /** The protection item from the Shopify cart */
-    private _protectionCartItem;
-    /** The protection variant that will be used */
-    private _protectionVariant;
-    hasLoadedStrings: boolean;
-    intervalId: number;
-    protected shouldUpdate(props: PropertyValues): boolean;
-    protected shouldPersistPopup(): "learn-more" | null;
-    protected setPopupKey(): void;
-    /**
-     * Internal state
-     */
-    private _state;
-    /**
-     * Internal popup state
-     */
-    private _popup;
-    /** Getter to check if we should refresh the page or not */
-    get shouldRefreshOnUpdate(): boolean;
-    /** Getter to check whether to show the widget or not */
-    get planActive(): boolean;
-    private _currencyFormat;
-    /** Emit events */
-    private _dispatchEvent;
-    private _handleRefreshCart;
-    /** Handle cart or page refreshes */
-    private _handleRefresh;
-    /** Given the current order, it calculates the protection total according to the store protection settings. */
-    calculateProtectionTotal(cart?: ShopifyCart): Promise<number>;
-    /**
-     * Given the current order, it finds the relevant protection product variant, and adds it to cart.
-     * This should be run whenever the cart updates, or it is manually triggered.
-     */
-    private _findProtectionVariant;
-    /** Update State */
-    private _setState;
-    /** Updates the current protection status, calling the relevant add/remove function. */
-    private _updateProtection;
-    /** General fetch function, which handles error responses, and returns JSON responses. */
-    private _fetch;
-    /** Fetches store info from the ShipAid public API. */
-    private _fetchShipAidData;
-    /** Fetch current cart from the Shopify ajax API */
-    private _fetchCart;
-    /** Fetch current product from the Shopify ajax API */
-    private _fetchProduct;
-    /** Whether the cart currently contains Shipping protection from ShipAid. */
-    hasProtection(): boolean;
-    /** Update the internal cart, which will trigger any protection fee updates */
-    updateCart(cart?: ShopifyCart): Promise<void>;
-    /** Add ShipAid shipping protection. */
-    addProtection(): Promise<void>;
-    /** Remove ShipAid shipping protection. */
-    removeProtection(): Promise<void>;
-    /** Try adding ShipAid shipping protection during polling if applicable */
-    attemptAddProtection(): Promise<void>;
-    handleMultipleProtectionVariants(): Promise<void>;
-    /** Templates */
-    learnMorePopupTemplate(): import("lit").TemplateResult<1>;
-    promptTemplate(): import("lit").TemplateResult<1>;
-    connectedCallback(): Promise<void>;
-    protected render(): import("lit").TemplateResult<1>;
-}
-declare global {
-    interface HTMLElementTagNameMap {
-        'shipaid-widget': ShipAidWidget;
-    }
-}
+import { LitElement, PropertyValues } from 'lit';
+import './components/learn-more-popup';
+import type { ShopifyCart } from '../types/shopify';
+/**
+ * ShipAid Widget.
+ *
+ * @description When the <shipaid-widget> element is added to page, it will render this element,
+ * allowing a customer to add ShipAid protection to cart (and remove).
+ *
+ */
+export declare class ShipAidWidget extends LitElement {
+    static styles: import("lit").CSSResult;
+    disablePolling: boolean;
+    disableActions: boolean;
+    pollingInterval: number;
+    disableRefresh: boolean;
+    refreshCart: boolean;
+    persistPopup: boolean;
+    defaultToggleButton: boolean;
+    lang: string;
+    currency: undefined;
+    customerId: undefined;
+    supportSubscriptions: boolean;
+    /** API Proxy pathname */
+    private _apiEndpoint;
+    /** The current store domain */
+    private _storeDomain;
+    /** The current store data object from the ShipAid API */
+    private _store;
+    /** The current cart data object from the Shopify API */
+    private _cart;
+    /** The current protection product data object from the Shopify API */
+    private _protectionProduct;
+    /** When the cart was last updated */
+    private _cartLastUpdated;
+    /** Whether we have finished the initial setup */
+    private _hasFinishedSetup;
+    /** Can be used to hide all widget content */
+    private _shouldShowWidget;
+    /** Whether the ShipAid protection product is currently added to the cart */
+    private _hasProtectionInCart;
+    /** The protection item from the Shopify cart */
+    private _protectionCartItem;
+    /** The protection variant that will be used */
+    private _protectionVariant;
+    hasLoadedStrings: boolean;
+    intervalId: number;
+    protected shouldUpdate(props: PropertyValues): boolean;
+    protected shouldPersistPopup(): "learn-more" | null;
+    protected setPopupKey(): void;
+    /**
+     * Internal state
+     */
+    private _state;
+    /**
+     * Internal popup state
+     */
+    private _popup;
+    /** Getter to check if we should refresh the page or not */
+    get shouldRefreshOnUpdate(): boolean;
+    /** Getter to check whether to show the widget or not */
+    get planActive(): boolean;
+    private _currencyFormat;
+    /** Emit events */
+    private _dispatchEvent;
+    private _handleRefreshCart;
+    /** Handle cart or page refreshes */
+    private _handleRefresh;
+    /** Given the current order, it calculates the protection total according to the store protection settings. */
+    calculateProtectionTotal(cart?: ShopifyCart): Promise<number>;
+    /**
+     * Given the current order, it finds the relevant protection product variant, and adds it to cart.
+     * This should be run whenever the cart updates, or it is manually triggered.
+     */
+    private _findProtectionVariant;
+    /** Update State */
+    private _setState;
+    /** Updates the current protection status, calling the relevant add/remove function. */
+    private _updateProtection;
+    /** General fetch function, which handles error responses, and returns JSON responses. */
+    private _fetch;
+    /** Fetches store info from the ShipAid public API. */
+    private _fetchShipAidData;
+    /** Fetches store info from the ShipAid public API. */
+    private _fetchSellingPlanFromVariant;
+    /** Fetch current cart from the Shopify ajax API */
+    private _fetchCart;
+    /** Fetch current product from the Shopify ajax API */
+    private _fetchProduct;
+    /** Whether the cart currently contains Shipping protection from ShipAid. */
+    hasProtection(): boolean;
+    /** Update the internal cart, which will trigger any protection fee updates */
+    updateCart(cart?: ShopifyCart): Promise<void>;
+    /** Add ShipAid shipping protection. */
+    addProtection(): Promise<void>;
+    /** Remove ShipAid shipping protection. */
+    removeProtection(): Promise<void>;
+    /** Try adding ShipAid shipping protection during polling if applicable */
+    attemptAddProtection(): Promise<void>;
+    handleMultipleProtectionVariants(): Promise<void>;
+    /** Templates */
+    learnMorePopupTemplate(): import("lit").TemplateResult<1>;
+    promptTemplate(): import("lit").TemplateResult<1>;
+    connectedCallback(): Promise<void>;
+    protected render(): import("lit").TemplateResult<1>;
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        'shipaid-widget': ShipAidWidget;
+    }
+}

package/dist-types/widget/types/shipaid.d.ts

@@ -1,10 +1,10 @@
-import { ShipAidStore } from '../../common/types/ShipAid';
-export interface ShipAidStoreQuery {
-    data: null | {
-        store: ShipAidStore;
-    };
-    errors?: {
-        message: string;
-    }[];
-}
-export { ShipAidStore };
+import { ShipAidStore } from '../../common/types/ShipAid';
+export interface ShipAidStoreQuery {
+    data: null | {
+        store: ShipAidStore;
+    };
+    errors?: {
+        message: string;
+    }[];
+}
+export { ShipAidStore };

package/dist-types/widget/types/shopify.d.ts

@@ -1,28 +1,29 @@
-import { ShopifyProduct } from '../../common/shopify/types/ShopifyProduct';
-export * from '../../common/shopify/types/ShopifyCart';
-export * from '../../common/shopify/types/ShopifyProduct';
-declare global {
-    interface Window {
-        Shopify?: {
-            shop?: string;
-            locale?: string;
-            designMode?: boolean;
-            currency?: {
-                active?: string;
-            };
-            Checkout?: Record<string, string> & {
-                apiHost?: string;
-            };
-        };
-    }
-}
-export interface ShopifyCartAddPayload {
-    id: number | string;
-    quantity?: number;
-}
-export interface ShopifyCartUpdatePayload {
-    updates: Record<string | number, number>;
-}
-export interface ShopifyProductResponse {
-    product: ShopifyProduct;
-}
+import { ShopifyProduct } from '../../common/shopify/types/ShopifyProduct';
+export * from '../../common/shopify/types/ShopifyCart';
+export * from '../../common/shopify/types/ShopifyProduct';
+declare global {
+    interface Window {
+        Shopify?: {
+            shop?: string;
+            locale?: string;
+            designMode?: boolean;
+            currency?: {
+                active?: string;
+            };
+            Checkout?: Record<string, string> & {
+                apiHost?: string;
+            };
+        };
+    }
+}
+export interface ShopifyCartAddPayload {
+    id: number | string;
+    quantity?: number;
+    selling_plan?: number | string | null;
+}
+export interface ShopifyCartUpdatePayload {
+    updates: Record<string | number, number>;
+}
+export interface ShopifyProductResponse {
+    product: ShopifyProduct;
+}

package/dist-types/widget/types/widget.d.ts

@@ -1,13 +1,13 @@
-export declare enum Events {
-    LOADED = "shipaid-loaded",
-    STATUS_UPDATE = "shipaid-protection-status"
-}
-export interface State {
-    loading: boolean;
-    success: boolean | null;
-    error: boolean | string | null;
-}
-export interface FetchHelper {
-    get: <Data>(url: string) => Promise<Data>;
-    post: <Data>(url: string, body: unknown) => Promise<Data>;
-}
+export declare enum Events {
+    LOADED = "shipaid-loaded",
+    STATUS_UPDATE = "shipaid-protection-status"
+}
+export interface State {
+    loading: boolean;
+    success: boolean | null;
+    error: boolean | string | null;
+}
+export interface FetchHelper {
+    get: <Data>(url: string) => Promise<Data>;
+    post: <Data>(url: string, body: unknown) => Promise<Data>;
+}

package/package.json

@@ -1,43 +1,43 @@
-{
-  "name": "ui.shipaid.com",
-  "private": false,
-  "version": "0.3.26",
-  "type": "module",
-  "main": "dist/widget.umd.js",
-  "unpkg": "dist/widget.iife.js",
-  "module": "dist/widget.es.js",
-  "exports": {
-    ".": "./dist/widget.es.js"
-  },
-  "types": "dist-types/src/shipaid-widget.d.ts",
-  "files": [
-    "dist-types",
-    "dist"
-  ],
-  "scripts": {
-    "develop": "vite",
-    "build": "tsc && node build",
-    "lint": "eslint . --ext=ts --fix"
-  },
-  "dependencies": {
-    "@lit-labs/task": "^2.0.0",
-    "lit": "^2.6.1",
-    "lit-element-effect": "^1.0.2",
-    "lit-translate": "^2.0.1"
-  },
-  "devDependencies": {
-    "@typescript-eslint/eslint-plugin": "^5.49.0",
-    "@typescript-eslint/parser": "^5.49.0",
-    "eslint": "^8.32.0",
-    "eslint-config-standard": "^17.0.0",
-    "eslint-plugin-html": "^7.1.0",
-    "eslint-plugin-import": "^2.27.5",
-    "eslint-plugin-lit": "^1.8.2",
-    "eslint-plugin-lit-a11y": "^2.3.0",
-    "eslint-plugin-n": "^15.6.1",
-    "eslint-plugin-promise": "^6.1.1",
-    "terser": "^5.16.1",
-    "typescript": "^4.9.4",
-    "vite": "^4.0.4"
-  }
-}
+{
+  "name": "ui.shipaid.com",
+  "private": false,
+  "version": "0.3.28",
+  "type": "module",
+  "main": "dist/widget.umd.js",
+  "unpkg": "dist/widget.iife.js",
+  "module": "dist/widget.es.js",
+  "exports": {
+    ".": "./dist/widget.es.js"
+  },
+  "types": "dist-types/src/shipaid-widget.d.ts",
+  "files": [
+    "dist-types",
+    "dist"
+  ],
+  "scripts": {
+    "develop": "vite",
+    "build": "tsc && node build",
+    "lint": "eslint . --ext=ts --fix"
+  },
+  "dependencies": {
+    "@lit-labs/task": "^2.0.0",
+    "lit": "^2.6.1",
+    "lit-element-effect": "^1.0.2",
+    "lit-translate": "^2.0.1"
+  },
+  "devDependencies": {
+    "@typescript-eslint/eslint-plugin": "^5.49.0",
+    "@typescript-eslint/parser": "^5.49.0",
+    "eslint": "^8.32.0",
+    "eslint-config-standard": "^17.0.0",
+    "eslint-plugin-html": "^7.1.0",
+    "eslint-plugin-import": "^2.27.5",
+    "eslint-plugin-lit": "^1.8.2",
+    "eslint-plugin-lit-a11y": "^2.3.0",
+    "eslint-plugin-n": "^15.6.1",
+    "eslint-plugin-promise": "^6.1.1",
+    "terser": "^5.16.1",
+    "typescript": "^4.9.4",
+    "vite": "^4.0.4"
+  }
+}