swell-js 3.19.2 → 3.19.3

package/dist/{api-896f20cf.js → api-f858ecd2.js}

@@ -23,7 +23,7 @@ const options = {
 };
 
 const api = {
-  version: '3.19.2',
+  version: '3.19.3',
   options,
   request,
 

package/dist/api.js

@@ -1,4 +1,4 @@
-export { a as default } from './api-896f20cf.js';
+export { a as default } from './api-f858ecd2.js';
 import './card-31d20d88.js';
 import './index-bee7164f.js';
 import 'qs';

package/dist/index.js

@@ -1,4 +1,4 @@
-export { a as default } from './api-896f20cf.js';
+export { a as default } from './api-f858ecd2.js';
 import './card-31d20d88.js';
 import './index-bee7164f.js';
 import 'qs';

package/dist/swell.cjs.js

@@ -7655,7 +7655,7 @@ const options = {
 };
 
 const api = {
-  version: '3.19.2',
+  version: '3.19.3',
   options,
   request,
 

package/dist/swell.umd.min.js

@@ -12128,7 +12128,7 @@
 	  previewContent: null
 	};
 	const api = {
-	  version: "3.19.2",
+	  version: "3.19.3",
 	  options,
 	  request,
 	  init(store, key, opt = {}) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "swell-js",
-  "version": "3.19.2",
+  "version": "3.19.3",
   "description": "Swell JS library for client-side stores",
   "engines": {
     "node": ">=14.19.1",
@@ -16,7 +16,8 @@
   "browser": "./dist/swell.umd.min.js",
   "types": "./types/index.d.ts",
   "files": [
-    "dist"
+    "dist",
+    "types"
   ],
   "dependencies": {
     "deepmerge": "4.2.2",

package/types/account/camel.d.ts

@@ -0,0 +1,12 @@
+import { SnakeToCamelCase } from '..';
+import { PasswordTokenInputSnake, AccountSnake, AddressSnake } from './snake';
+
+export type PasswordTokenInputCamel = {
+  [K in keyof PasswordTokenInputSnake as SnakeToCamelCase<K>]: PasswordTokenInputSnake[K];
+};
+export type AccountCamel = {
+  [K in keyof AccountSnake as SnakeToCamelCase<K>]: AccountSnake[K];
+};
+export type AddressCamel = {
+  [K in keyof AddressSnake as SnakeToCamelCase<K>]: AddressSnake[K];
+};

package/types/account/index.d.ts

@@ -0,0 +1,8 @@
+import { AccountSnake, AddressSnake, PasswordTokenInputSnake } from './snake';
+import { AccountCamel, AddressCamel, PasswordTokenInputCamel } from './camel';
+
+interface PasswordTokenInput
+  extends PasswordTokenInputSnake,
+    PasswordTokenInputCamel {}
+interface Account extends AccountSnake, AccountCamel {}
+interface Address extends AddressSnake, AddressCamel {}

package/types/account/snake.d.ts

@@ -0,0 +1,51 @@
+import { BaseModel } from '..';
+import { Subscription } from '../subscription';
+import { Card } from '../card';
+import { Order } from '../order';
+
+interface PasswordTokenInputSnake {
+  password_token?: string;
+}
+
+interface AccountSnake extends BaseModel {
+  addresses?: AddressSnake[];
+  balance?: number;
+  billing?: AddressSnake;
+  cards?: Card[];
+  date_first_order?: string;
+  date_last_order?: string;
+  email?: string;
+  email_optin?: boolean;
+  first_name?: string;
+  group?: string;
+  last_name?: string;
+  metadata?: object;
+  name?: string;
+  orders?: Order[];
+  order_count?: number;
+  order_value?: number;
+  password?: string;
+  password_reset_url?: string;
+  phone?: string;
+  shipping?: AddressSnake;
+  subscriptions?: Subscription[];
+  type?: string;
+  vat_number?: string;
+}
+
+interface AddressSnake extends BaseModel {
+  active?: boolean;
+  address1: string;
+  address2?: string;
+  city?: string;
+  company?: string;
+  country?: string;
+  fingerprint?: string;
+  first_name?: string;
+  last_name?: string;
+  name?: string;
+  parent_id?: string;
+  phone?: string;
+  state?: string;
+  zip?: string;
+}

package/types/attribute/camel.d.ts

@@ -0,0 +1,6 @@
+import { SnakeToCamelCase } from '..';
+import { AttributeSnake } from './snake';
+
+export type AttributeCamel = {
+  [K in keyof AttributeSnake as SnakeToCamelCase<K>]: AttributeSnake[K];
+};

package/types/attribute/index.d.ts

@@ -0,0 +1,4 @@
+import { AttributeCamel } from './camel';
+import { AttributeSnake } from './snake';
+
+export interface Attribute extends AttributeCamel, AttributeSnake {}

package/types/attribute/snake.d.ts

@@ -0,0 +1,37 @@
+import { BaseModel } from '..';
+import { Product } from '../product';
+
+export interface AttributeSnake extends BaseModel {
+  default?: string | null | number | boolean | object;
+  filterable?: boolean;
+  localized?: boolean;
+  multi?: boolean;
+  name?: string;
+  products?: Product[];
+  required?: boolean;
+  searchable?: boolean;
+  type?:
+    | 'asset'
+    | 'boolean'
+    | 'checkbox'
+    | 'collection'
+    | 'date'
+    | 'currency'
+    | 'dropdown'
+    | 'field_group'
+    | 'file'
+    | 'icon'
+    | 'image'
+    | 'long_text'
+    | 'lookup'
+    | 'number'
+    | 'radio'
+    | 'select'
+    | 'short_text'
+    | 'tags'
+    | 'text'
+    | 'textarea';
+  values?: string[];
+  variant?: boolean;
+  visible?: boolean;
+}

package/types/card/camel.d.ts

@@ -0,0 +1,12 @@
+import { SnakeToCamelCase } from '..';
+import { CardSnake, InputCreateTokenSnake, TokenResponseSnake } from './snake';
+
+export type CardCamel = {
+  [K in keyof CardSnake as SnakeToCamelCase<K>]: CardSnake[K];
+};
+export type InputCreateTokenCamel = {
+  [K in keyof InputCreateTokenSnake as SnakeToCamelCase<K>]: InputCreateTokenSnake[K];
+};
+export type TokenResponseCamel = {
+  [K in keyof TokenResponseSnake as SnakeToCamelCase<K>]: TokenResponseSnake[K];
+};

package/types/card/index.d.ts

@@ -0,0 +1,8 @@
+import { CardSnake, InputCreateTokenSnake, TokenResponseSnake } from './snake';
+import { CardCamel, InputCreateTokenCamel, TokenResponseCamel } from './camel';
+
+interface InputCreateToken
+  extends InputCreateTokenSnake,
+    InputCreateTokenCamel {}
+interface TokenResponse extends TokenResponseSnake, TokenResponseCamel {}
+interface Card extends CardCamel, CardSnake {}

package/types/card/snake.d.ts

@@ -0,0 +1,40 @@
+import { BaseModel } from '..';
+import { Account } from '../account';
+
+interface InputCreateTokenSnake {
+  account_id?: string;
+  billing?: object; // TODO: Add billing
+  cvc?: number;
+  exp_month?: number;
+  exp_year?: number;
+  number?: string;
+}
+
+interface TokenResponseSnake {
+  address_check?: 'pass' | 'failed' | 'checked' | 'unchecked';
+  brand?: string;
+  cvc_check?: 'pass' | 'failed' | 'checked' | 'unchecked';
+  exp_month?: number;
+  exp_year?: number;
+  last4?: string;
+  token?: string;
+  zip_check?: 'pass' | 'failed' | 'checked' | 'unchecked';
+}
+
+interface CardSnake extends BaseModel {
+  active?: boolean;
+  address_check?: 'unchecked' | 'pass' | 'fail';
+  billing?: object; // TODO: Create Billing Interface
+  brand?: string;
+  cvc_check?: 'unchecked' | 'pass' | 'fail';
+  exp_month?: number;
+  exp_year?: number;
+  fingerprint?: string;
+  gateway?: string;
+  last4?: string;
+  parent?: Account;
+  parent_id?: string;
+  test?: boolean;
+  token: string;
+  zip_check?: 'unchecked' | 'pass' | 'fail';
+}

package/types/cart/camel.d.ts

@@ -0,0 +1,9 @@
+import { SnakeToCamelCase } from '..';
+import { CartSnake, CartItemSnake } from './snake';
+
+export type CartCamel = {
+  [K in keyof CartSnake as SnakeToCamelCase<K>]: CartSnake[K];
+};
+export type CartItemCamel = {
+  [K in keyof CartItemSnake as SnakeToCamelCase<K>]: CartItemSnake[K];
+};

package/types/cart/index.d.ts

@@ -0,0 +1,5 @@
+import { CartSnake, CartItemSnake } from './snake';
+import { CartCamel, CartItemCamel } from './camel';
+
+export interface Cart extends CartSnake, CartCamel {}
+export interface CartItem extends CartItemSnake, CartItemCamel {}

package/types/cart/snake.d.ts

@@ -0,0 +1,112 @@
+import { BaseModel, Discount, Tax } from '../index';
+import { Product, Variant } from '../product';
+import { Subscription } from '../subscription';
+import { Account } from '../account';
+import { Order } from '../order';
+
+interface CartItemSnake extends BaseModel {
+  bundle_items?: [object];
+  delivery?: 'shipment' | 'subscription' | 'giftcard' | null;
+  description?: string;
+  discount_each?: number;
+  discount_total?: number;
+  discounts?: [Discount];
+  metadata?: object;
+  options?: [object]; // TODO: Add Options Variant
+  orig_price?: number;
+  price?: number;
+  price_total?: number;
+  product_id?: string;
+  product_name?: string;
+  product?: Product;
+  quantity?: number;
+  shipment_location?: string;
+  shipment_weight?: number;
+  subscription_interval?: string;
+  subscription_interval_count?: number;
+  subscription_trial_days?: number;
+  subscription_paid?: boolean;
+  tax_each?: number;
+  tax_total?: number;
+  taxes?: [Tax];
+  trial_price_total?: number;
+  variant_id?: string;
+  variant?: Variant;
+}
+
+interface CartSnake extends BaseModel {
+  abandoned?: boolean;
+  abandoned_notifications?: number;
+  account?: Account;
+  account_credit_amount?: number;
+  account_credit_applied?: boolean;
+  account_id?: string;
+  account_info_saved?: boolean;
+  account_logged_in?: boolean;
+  active?: boolean;
+  billing?: object; // TODO: Billing Object
+  checkout_id?: string;
+  checkout_url?: string;
+  comments?: string;
+  coupon?: object; // TODO: Create Coupon Object
+  coupon_code?: string;
+  coupon_id?: string;
+  currency?: string;
+  currency_rate?: number;
+  date_abandoned?: string;
+  date_abandoned_next?: string;
+  date_webhook_first_failed?: string;
+  date_webhook_last_succeeded?: string;
+  discount_total?: number;
+  discounts?: [object]; // TODO: Add discount object
+  display_currency?: string;
+  display_locale?: string;
+  gift?: boolean;
+  gift_message?: string;
+  giftcard_delivery?: boolean;
+  giftcard_total?: number;
+  giftcards?: [object]; // TODO: Add gift card object
+  grand_total?: number;
+  guest?: boolean;
+  item_discount?: number;
+  item_quantity?: number;
+  item_shipment_weight?: number;
+  item_tax?: number;
+  item_tax_included?: boolean;
+  items?: [CartItemSnake];
+  metadata?: object;
+  notes?: string;
+  number?: string;
+  order?: Order;
+  order_id?: string;
+  orig_price?: number;
+  promotion_ids?: [string]; // TODO: Create a special type for this?
+  promotions?: [object]; // TODO: Create Promotion Object
+  purchase_link_ids?: [string];
+  purchase_links?: [object]; // TODO : Create Purchase Links
+  purchase_links_errors?: [object];
+  recovered?: boolean;
+  schedule?: object;
+  shipment_delivery?: boolean;
+  shipment_discount?: number;
+  shipment_price?: number;
+  shipment_rating?: object; // TODO: Create Shipment Rating
+  shipment_tax?: number;
+  shipment_tax_included?: boolean;
+  shipment_total?: number;
+  shipping?: object; // TODO: Create Shipping Object
+  status?: 'active' | 'converted' | 'abandoned' | 'recovered';
+  sub_total?: number;
+  subscription?: Subscription;
+  subscription_delivery?: boolean;
+  subscription_id?: string;
+  target_order?: Order;
+  target_order_id?: string;
+  tax_included_total?: number;
+  tax_total?: number;
+  taxes?: [Tax];
+  taxes_fixed?: boolean;
+  webhook_attempts_failed?: number;
+  webhook_response?: string;
+  webhook_status?: number;
+}

package/types/category/camel.d.ts

@@ -0,0 +1,6 @@
+import { SnakeToCamelCase } from '..';
+import { CategorySnake } from './snake';
+
+export type CategoryCamel = {
+  [K in keyof CategorySnake as SnakeToCamelCase<K>]: CategorySnake[K];
+};

package/types/category/index.d.ts

@@ -0,0 +1,4 @@
+import { CategorySnake } from './snake';
+import { CategoryCamel } from './camel';
+
+export interface Category extends CategorySnake, CategoryCamel {}

package/types/category/snake.d.ts

@@ -0,0 +1,24 @@
+import { BaseModel } from '..';
+import { Image, Product } from '../product';
+
+interface CategorySnake extends BaseModel {
+  active?: boolean;
+  children?: CategorySnake[];
+  demo?: boolean;
+  description: string;
+  image?: Image;
+  images?: Image[];
+  meta_description?: string;
+  meta_keywords?: string;
+  meta_title?: string;
+  name: string;
+  parent_id?: string;
+  parent?: CategorySnake;
+  products?: Product[];
+  products_indexed?: Product[];
+  slug: string;
+  sort?: number;
+  sorting?: string;
+  top?: CategorySnake;
+  top_id?: string;
+}

package/types/content/camel.d.ts

@@ -0,0 +1,9 @@
+import { SnakeToCamelCase } from '..';
+import { ContentSnake, ContentSectionSnake } from './snake';
+
+export type ContentCamel = {
+  [K in keyof ContentSnake as SnakeToCamelCase<K>]: ContentSnake[K];
+};
+export type ContentSectionCamel = {
+  [K in keyof ContentSectionSnake as SnakeToCamelCase<K>]: ContentSectionSnake[K];
+};

package/types/content/index.d.ts

@@ -0,0 +1,7 @@
+import { ContentSnake, ContentSectionSnake } from './snake';
+import { ContentCamel, ContentSectionCamel } from './camel';
+
+export interface Content extends ContentSnake, ContentCamel {}
+export interface ContentSection
+  extends ContentSectionSnake,
+    ContentSectionCamel {}

package/types/content/snake.d.ts

@@ -0,0 +1,16 @@
+import { BaseModel } from '..';
+
+interface ContentSectionSnake {
+  id: string;
+  type: string;
+  [otherAttr: string]: string | number | boolean | null;
+}
+interface ContentSnake extends BaseModel {
+  content?: string;
+  meta_description?: string | null;
+  name?: string;
+  published?: boolean;
+  redirect?: string | null;
+  slug?: string;
+  sections?: ContentSectionSnake[];
+}

package/types/currency/camel.d.ts

@@ -0,0 +1,16 @@
+import { SnakeToCamelCase } from '..';
+import {
+  FormatInputSnake,
+  SelectCurrencyReturnSnake,
+  EnabledCurrencySnake,
+} from './snake';
+
+export type FormatInputCamel = {
+  [K in keyof FormatInputSnake as SnakeToCamelCase<K>]: FormatInputSnake[K];
+};
+export type SelectCurrencyReturnCamel = {
+  [K in keyof SelectCurrencyReturnSnake as SnakeToCamelCase<K>]: SelectCurrencyReturnSnake[K];
+};
+export type EnabledCurrencyCamel = {
+  [K in keyof EnabledCurrencySnake as SnakeToCamelCase<K>]: EnabledCurrencySnake[K];
+};

package/types/currency/index.d.ts

@@ -0,0 +1,18 @@
+import {
+  SelectCurrencyReturnSnake,
+  EnabledCurrencySnake,
+  FormatInputSnake,
+} from './snake';
+import {
+  SelectCurrencyReturnCamel,
+  EnabledCurrencyCamel,
+  FormatInputCamel,
+} from './camel';
+
+export interface SelectCurrencyReturn
+  extends SelectCurrencyReturnSnake,
+    SelectCurrencyReturnCamel {}
+export interface EnabledCurrency
+  extends EnabledCurrencySnake,
+    EnabledCurrencyCamel {}
+export interface FormatInput extends FormatInputSnake, FormatInputCamel {}

package/types/currency/snake.d.ts

@@ -0,0 +1,22 @@
+export interface FormatInputSnake {
+  code: string;
+  decimals: number;
+  locale: string;
+  rate: number;
+}
+
+export interface EnabledCurrencySnake {
+  code: string;
+  decimals: number;
+  name: string;
+  rate: number;
+  symbol: string;
+  type: string;
+}
+
+export interface SelectCurrencyReturnSnake {
+  account_id?: string;
+  cart_id?: string;
+  currency: string;
+  public_key?: string;
+}