Spark JS

type AccountSectionId = 
  | "spark-slot-my-account"
  | "recent-activity"
  | "shopping-lists"
  | "favourites"
  | "financials"
  | "my-details"
  | "reports"
  | "address-book"
  | "company-users";

type CustomAccountDetailLinkType = "email" | "phone" | "sms" | "website";

type SparkLayerOptions = {
  sparkDomain: "app.sparklayer.io" | "test.app.sparklayer.io";
  platform: "base" | "bigcommerce" | "shopify" | "wix" | "woocommerce" | "magento";
  siteId: string;
  rootUrl: string;
  accountRedirect: {
     urlRegex?: RegExp;
     goTo?: string;
  };
  cartRedirect: {
     urlRegex?: RegExp;
     goTo?: string;
  };
  wordpressSiteUrl?: string;
  accountButtonSelectors: string;
  logoutButtonSelectors: string;
  cartButtonSelectors: string;
  loginButtonSelectors: string;
  display: DisplayOptions;
  termsAndConditionsLink: string;
  language: string;
  locale: string | null;
  translations: Translations;
  showTranslations: boolean;
  checkoutCustomElements: CheckoutElementConfig[];
  paymentMethodsOrder: PaymentMethodName[];
  saveToAddressBookDefault: boolean;
  productLink: string;
  customAccountDetails: {
     title: string;
     value: string | number;
     displayText?: string;
     type?: CustomAccountDetailLinkType;
  }[];
  onCheckoutValidation: Promise<
     | {
     message: string;
   }[]
    | null>;
  onCartUpdate: Promise<void>;
  onCartLoad: Promise<void>;
  preCartUpdateListener: Promise<Partial<UpdateCart>>;
  onReady?: Promise<void>;
  onLoad?: Promise<void>;
  onLogout?: Promise<void>;
  shopify?: {
     useAppProxy?: boolean;
  };
  bigcommerce?: {
     appClientId?: string;
  };
  auth: {
     user?: string;
     token?: string;
  };
  authLogoutUri: string | null;
  analytics?: AnalyticsOptions;
  igniteCheckoutContext?: Record<string, unknown>;
};

onCheckoutValidation(cart, cartUiState): Promise<
  | {
  message: string;
}[]
| null>;

onCartUpdate(cart, results): Promise<void>;

onCartLoad(cart): Promise<void>;

preCartUpdateListener(input): Promise<Partial<UpdateCart>>;

optional onReady(spark): Promise<void>;

optional onLoad(spark): Promise<void>;

optional onLogout(): Promise<void>;

type Spark = {
  options: SparkLayerOptions;
  switchImpersonatingCustomer: Promise<UserData | null>;
  refreshGlobalData: Promise<UserData | null>;
  getActiveCustomerVerificationToken: Promise<string | null>;
  getProduct: Promise<Product>;
  getProductBySlug: Promise<Product>;
  getVariant: Promise<ProductVariant>;
  getPriceForProduct: Promise<SimplifiedProductPrice>;
  calculatePricingForVariantData: ProductVariantPricing;
  isLoggedIn: Promise<boolean>;
  updateCart: Promise<CartResults[] | null>;
  externalClearBasket: Promise<void>;
  getPackSizeForVariant: Promise<number>;
  getRrpPriceForVariant: Promise<{
     rrp: number | null;
     currencyCode: string | null;
  }>;
  getPricingForVariant: Promise<{
     price: number | null;
     rrp: number | null;
     rrpCurrencyCode: string | null;
     priceBreaks: VariantPriceBreak[];
     currencyCode: string;
  }>;
  calculatePricingForVariant: Promise<ProductVariantPricing>;
  getCart: Promise<Cart | null>;
  uploadFile: Promise<string>;
  fetch: Promise<FetchResponse<ResponseOf<Q>, ErrorOf<Q>>>;
  getCartCache: Cart | null;
  openDrawer: void;
  closeDrawer: void;
};

switchImpersonatingCustomer(customerId): Promise<UserData | null>;

refreshGlobalData(): Promise<UserData | null>;

getActiveCustomerVerificationToken(): Promise<string | null>;

getProduct(parentProductId): Promise<Product>;

getProductBySlug(slug): Promise<Product>;

getVariant(parentProductId, variantSku): Promise<ProductVariant>;

getPriceForProduct(parentProductId): Promise<SimplifiedProductPrice>;

calculatePricingForVariantData(
   variant, 
   qty, 
   qtyAcrossVariants?
): ProductVariantPricing;

isLoggedIn(): Promise<boolean>;

updateCart(
   input, 
   cartSuccessHandledLocally?, 
   cartErrorsHandledLocally?
): Promise<CartResults[] | null>;

externalClearBasket(): Promise<void>;

getPackSizeForVariant(parentProductId, variantSku): Promise<number>;

getRrpPriceForVariant(parentProductId, variantSku): Promise<{
  rrp: number | null;
  currencyCode: string | null;
}>;

getPricingForVariant(parentProductId, variantSku): Promise<{
  price: number | null;
  rrp: number | null;
  rrpCurrencyCode: string | null;
  priceBreaks: VariantPriceBreak[];
  currencyCode: string;
}>;

calculatePricingForVariant(
   parentProductId, 
   variantSku, 
   qty, 
   qtyAcrossVariants
): Promise<ProductVariantPricing>;

getCart(): Promise<Cart | null>;

uploadFile(fileName, fileData): Promise<string>;

fetch<Q>(
   query, 
   variables?, 
   useImpersonatingCustomer?, 
   bypassAppProxy?
): Promise<FetchResponse<ResponseOf<Q>, ErrorOf<Q>>>;

getCartCache(): Cart | null;

openDrawer(initialTab?): void;

closeDrawer(): void;