@grafikr/shopify-typescript 1.0.4 → 1.1.1

package/global/Shopify.ts

@@ -1,31 +1,27 @@
 import ProductJSON from '../type/Product';
 import ProductObject from '../type/object/Product';
+import Image from './modules/Image';
+import CustomerPrivacy from './modules/customerPrivacy';
 
 export default interface Shopify {
-  CountryProvinceSelector: (country_domid: string, province_domid: string, options?: {
+  CountryProvinceSelector?: (country_domid: string, province_domid: string, options?: {
     hideElement: string
   }) => void
-  postLink: (path: string, options?: {
+  postLink?: (path: string, options?: {
     method?: string
     parameters?: object
   }) => void
-  addListener: (target: HTMLElement, eventName: string, callback: CallableFunction) => void
-  setSelectorByValue: (selector: HTMLSelectElement, value: any) => number
-  Image: {
-    switchImage: CallableFunction
-    getSizedImageUrl: (src: string, size: string) => string
-    imageSize: (src: string) => string | null
-    loadImage: (src: string) => void
-    removeProtocol: (url: string) => string
-  }
-  OptionSelectors: (selector: string, config: {
+  addListener?: (target: HTMLElement, eventName: string, callback: CallableFunction) => void
+  setSelectorByValue?: (selector: HTMLSelectElement, value: any) => number
+  Image?: Image
+  OptionSelectors?: (selector: string, config: {
     product: ProductJSON | ProductObject
     onVariantSelected: CallableFunction
     enableHistoryState?: boolean
   }) => void
-  OptionSelectorsFromDOM: FunctionConstructor
+  OptionSelectorsFromDOM?: FunctionConstructor
   loadFeatures: (features: any[], callback: CallableFunction) => void
-  customerPrivacy?: (consented: boolean, callback: CallableFunction) => void
+  customerPrivacy?: CustomerPrivacy
   currency: {
     active: string
     rate: string

package/global/modules/Image.ts

@@ -0,0 +1,7 @@
+export default interface Image {
+  switchImage: CallableFunction
+  getSizedImageUrl: (src: string, size: string) => string
+  imageSize: (src: string) => string | null
+  loadImage: (src: string) => void
+  removeProtocol: (url: string) => string
+}

package/global/modules/customerPrivacy.ts

@@ -0,0 +1,15 @@
+export default interface CustomerPrivacy {
+  getCCPAConsent(): string
+  getRegulation(): string
+  getShopPrefs(): {
+    limit: string[]
+  }
+  getTrackingConsent(): string
+  isRegulationEnforced(): boolean
+  setCCPAConsent(consented: boolean, callback: CallableFunction): void
+  setTrackingConsent(consented: boolean, callback: CallableFunction): void
+  shouldShowCCPABanner(): boolean
+  shouldShowGDPRBanner(): boolean
+  userCanBeTracked(): boolean
+  userDataCanBeSold(): boolean
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafikr/shopify-typescript",
-  "version": "1.0.4",
+  "version": "1.1.1",
   "license": "MIT",
   "scripts": {
     "lint": "node_modules/.bin/eslint . --ext .js,.ts",
@@ -11,7 +11,7 @@
     "@typescript-eslint/parser": "^5.0.0",
     "eslint": "^8.4.0",
     "eslint-config-airbnb-base": "^15.0.0",
-    "eslint-config-airbnb-typescript": "^16.1.0",
+    "eslint-config-airbnb-typescript": "^17.0.0",
     "eslint-plugin-import": "^2.0.0",
     "typescript": "^4.0.0"
   },

package/type/LineItem.ts

@@ -25,13 +25,13 @@ export default interface Item {
   final_price: number
   final_line_price: number
   url: string
-  featured_image: [{
+  featured_image: {
     aspect_ratio: number
     alt: string
     height: number
     url: string
     width: number
-  }]
+  }
   image: string
   handle: string
   requires_shipping: boolean

package/type/object/Variant.ts

@@ -16,7 +16,7 @@ export default interface Variant {
   name: string
   public_title: string | null
   options: string[]
-  price: number | null
+  price: number
   weight: number
   compare_at_price: number | null
   inventory_management: string

package/type/search/Article.ts

@@ -1,7 +1,7 @@
 import Item from './Item';
 import FeaturedImage from './FeaturedImage';
 
-export default interface Article extends Item{
+export default interface Article extends Item {
   author: string
   image: string | null
   published_at: string