@grafikr/shopify-typescript 0.0.2 → 1.0.2

package/README.md

@@ -0,0 +1,23 @@
+# Shopify TypeScript
+
+This packages adds TypeScript for all Shopify responses and objects.
+
+### Installation
+
+You can install the package using Yarn:
+
+```
+$ yarn install @grafikr/shopify-typescript --save
+```
+
+### Usage
+
+```ts
+import Product from '@grafikr/shopify-typescript/type/Product';
+
+const func = (data: Product) => {
+  ...
+};
+```
+
+You can have a look in the repository under `global` and `type` folder, to find types you can use.

package/global/Shopify.ts

@@ -0,0 +1,31 @@
+import ProductJSON from '../type/Product';
+import ProductObject from '../type/object/Product';
+
+export default interface Shopify {
+  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: {
+    product: ProductJSON | ProductObject
+    onVariantSelected: CallableFunction
+    enableHistoryState: boolean
+  }) => void
+  OptionSelectorsFromDOM: FunctionConstructor
+  loadFeatures: (features: any[], callback: CallableFunction) => void
+  customerPrivacy?: (consented: boolean, callback: CallableFunction) => void
+  currency: {
+    active: string
+    rate: string
+  }
+  cdnHost: 'cdn.shopify.com'
+  country: string
+  locale: string
+  formatMoney: (price: string | number, format: string) => string
+  money_format: string
+  shop: string
+  designMode: true | undefined
+}

package/package.json

@@ -1,9 +1,10 @@
 {
   "name": "@grafikr/shopify-typescript",
-  "version": "0.0.2",
+  "version": "1.0.2",
   "license": "MIT",
   "scripts": {
-    "lint": "node_modules/.bin/eslint . --ext .js,.ts"
+    "lint": "node_modules/.bin/eslint . --ext .js,.ts",
+    "test": "yarn lint"
   },
   "devDependencies": {
     "@typescript-eslint/eslint-plugin": "^5.0.0",
@@ -19,7 +20,7 @@
     "url": "https://github.com/grafikr/shopify-typescript.git"
   },
   "files": [
-    "globals",
-    "types"
+    "global",
+    "type"
   ]
 }

package/type/Cart.ts

@@ -0,0 +1,18 @@
+import LineItem from './LineItem';
+import DiscountApplication from './DiscountApplication';
+
+export default interface Cart {
+  token: string
+  note: string | null
+  attributes: { [key: string]: string | boolean } | null
+  original_total_price: number
+  total_price: number
+  total_discount: number
+  total_weight: number
+  item_count: number
+  items: LineItem[]
+  requires_shipping: boolean
+  currency: string
+  items_subtotal_price: number
+  cart_level_discount_applications: DiscountApplication[]
+}

package/type/Collection.ts

@@ -0,0 +1,12 @@
+import Image from './Image';
+
+export default interface Collection {
+  id: number
+  title: string
+  handle: string
+  description: string
+  published_at: string
+  updated_at: string
+  image: Image | null
+  products_count: number
+}

package/type/DiscountAllocations.ts

@@ -0,0 +1,6 @@
+import DiscountApplication from './DiscountApplication';
+
+export default interface DiscountAllocations {
+  amount: number
+  discount_application: DiscountApplication
+}

package/type/DiscountApplication.ts

@@ -0,0 +1,13 @@
+export default interface DiscountApplication {
+  type: 'automatic' | 'discount_code' | 'manual' | 'script'
+  key: string
+  title: string
+  description: string | null
+  value: number
+  created_at: string
+  value_type: 'fixed_amount' | 'percentage'
+  allocation_method: 'across' | 'each' | 'one'
+  target_selection: 'all' | 'entitled' | 'explicit'
+  target_type: 'line_item' | 'shipping_line'
+  total_allocated_amount: number
+}

package/type/Image.ts

@@ -0,0 +1,6 @@
+export default interface Image {
+  id: number
+  created_at: string
+  src: string
+  alt: string | null
+}

package/type/LineItem.ts

@@ -0,0 +1,49 @@
+export default interface Item {
+  id: number
+  properties: { [key: string]: string | boolean } | null
+  quantity: number
+  variant_id: number
+  key: string
+  title: string
+  price: number
+  original_price: number
+  discounted_price: number
+  line_price: number
+  original_line_price: number
+  total_discount: number
+  discounts: [{
+    amount: number
+    title: string
+  }]
+  sku: string
+  grams: number
+  vendor: string
+  taxable: boolean
+  product_id: number
+  product_has_only_default_variant: boolean
+  gift_card: boolean
+  final_price: number
+  final_line_price: number
+  url: string
+  featured_image: [{
+    aspect_ratio: number
+    alt: string
+    height: number
+    url: string
+    width: number
+  }]
+  image: string
+  handle: string
+  requires_shipping: boolean
+  product_type: string
+  product_title: string
+  product_description: string
+  variant_title: string
+  variant_options: string[]
+  options_with_values: [{
+    name: string
+    value: string
+  }]
+  line_level_discount_allocations: any[]
+  line_level_total_discount: number
+}

package/{types → type}/Product.ts

@@ -1,6 +1,6 @@
 import Variant from './Variant';
 import Option from './Option';
-import Image from './Image';
+import ProductImage from './ProductImage';
 
 export default interface Product {
   id: number
@@ -17,6 +17,6 @@ export default interface Product {
   tags: string
   variants: Variant[]
   options: Option[]
-  images: Image[]
-  image: Image
+  images: ProductImage[]
+  image: ProductImage
 }

package/type/ProductImage.ts

@@ -0,0 +1,10 @@
+import Image from './Image';
+
+export default interface ProductImage extends Image {
+  product_id: number
+  position: number
+  updated_at: string
+  width: number
+  height: number
+  variant_ids: number[]
+}

package/type/object/Article.ts

@@ -0,0 +1,18 @@
+import Image from './Image';
+
+export default interface Article {
+  id: number
+  title: string
+  created_at: string
+  body_html: string
+  blog_id: number
+  author: string
+  user_id: number
+  published_at: string
+  updated_at: string
+  summary_html: string
+  template_suffix: string
+  handle: string
+  tags: string
+  image: Image
+}

package/type/object/Collection.ts

@@ -0,0 +1,17 @@
+import Image from './Image';
+import Rule from './Rule';
+
+export default interface Collection {
+  id: number
+  handle: string
+  title: string
+  updated_at: string
+  body_html: string
+  published_at: string
+  sort_order: string
+  template_suffix: string
+  disjunctive?: boolean
+  rules?: Rule[]
+  published_scope: string
+  image?: Image
+}

package/type/object/FeaturedMedia.ts

@@ -0,0 +1,8 @@
+import PreviewImage from './PreviewImage';
+
+export default interface FeaturedMedia {
+  alt: string | null
+  id: number
+  position: number
+  preview_image: PreviewImage
+}

package/{types → type/object}/Image.ts

@@ -1,12 +1,7 @@
 export default interface Image {
-  id: number
-  product_id: number
-  position: number
   created_at: string
-  updated_at: string
   alt: string | null
   width: number
   height: number
   src: string
-  variant_ids: number[]
 }

package/type/object/Media.ts

@@ -0,0 +1,13 @@
+import PreviewImage from './PreviewImage';
+
+export default interface Media {
+  alt: string | null
+  id: number
+  position: number
+  preview_image: PreviewImage
+  aspect_ratio: number
+  height: number
+  media_type: string
+  src: string
+  width: number
+}

package/type/object/PreviewImage.ts

@@ -0,0 +1,6 @@
+export default interface PreviewImage {
+  aspect_ratio: number
+  height: number
+  width: number
+  src: string
+}

package/type/object/Product.ts

@@ -0,0 +1,29 @@
+import Variant from './Variant';
+import Media from './Media';
+
+export default interface Product {
+  id: number
+  title: string
+  handle: string
+  description: string
+  published_at: string
+  created_at: string
+  vendor: string
+  type: string
+  tags: string[]
+  price: number
+  price_min: number
+  price_max: number
+  available: boolean
+  price_varies: boolean
+  compare_at_price: string | null
+  compare_at_price_min: number
+  compare_at_price_max: number
+  compare_at_price_varies: boolean
+  variants: Variant[]
+  images: string[]
+  featured_image: string | null
+  options: string[]
+  media: Media[]
+  content: string
+}

package/type/object/Rule.ts

@@ -0,0 +1,5 @@
+export default interface Rule {
+  column: string
+  relation: string
+  condition: string
+}

package/type/object/Variant.ts

@@ -0,0 +1,24 @@
+import FeaturedImage from '../search/FeaturedImage';
+import FeaturedMedia from './FeaturedMedia';
+
+export default interface Variant {
+  id: number
+  title: string
+  option1: string | null
+  option2: string | null
+  option3: string | null
+  sku: string | null
+  requires_shipping: boolean
+  taxable: boolean
+  featured_image?: FeaturedImage
+  featured_media?: FeaturedMedia
+  available: boolean
+  name: string
+  public_title: string | null
+  options: string[]
+  price: number | null
+  weight: number
+  compare_at_price: number | null
+  inventory_management: string
+  barcode: string | null
+}

package/type/search/Article.ts

@@ -0,0 +1,12 @@
+import Item from './Item';
+import FeaturedImage from './FeaturedImage';
+
+export default interface Article extends Item{
+  author: string
+  image: string | null
+  published_at: string
+  summary_html: string
+  tags: string[]
+  title: string
+  featured_image: FeaturedImage
+}

package/type/search/Collection.ts

@@ -0,0 +1,7 @@
+import Item from './Item';
+import FeaturedImage from './FeaturedImage';
+
+export default interface Collection extends Item {
+  published_at: string
+  featured_image: FeaturedImage
+}

package/type/search/FeaturedImage.ts

@@ -0,0 +1,7 @@
+export default interface FeaturedImage {
+  alt: string | null
+  aspect_ratio: number | null
+  height: number | null
+  url: string | null
+  width: number | null
+}

package/type/search/Item.ts

@@ -0,0 +1,7 @@
+export default interface Item {
+  id: number
+  handle: string
+  url: string
+  title: string
+  body: string
+}

package/type/search/Page.ts

@@ -0,0 +1,6 @@
+import Item from './Item';
+
+export default interface Page extends Item {
+  author: null
+  published_at: string
+}

package/type/search/Product.ts

@@ -0,0 +1,17 @@
+import Item from './Item';
+import FeaturedImage from './FeaturedImage';
+
+export default interface Product extends Item {
+  available: boolean
+  compare_at_price_max: string
+  compare_at_price_min: string
+  image: string | null
+  price: string
+  price_max: string
+  price_min: string
+  tags: string[]
+  type: string
+  variants: []
+  vendor: string
+  featured_image: FeaturedImage
+}

package/type/search/Result.ts

@@ -0,0 +1,13 @@
+import Collection from './Collection';
+import Page from './Page';
+import Product from './Product';
+
+export default interface Result {
+  resources: {
+    results: {
+      collections?: Collection[]
+      pages?: Page[]
+      products?: Product[]
+    }
+  }
+}

package/globals/Shopify.ts

@@ -1,28 +0,0 @@
-import Product from '../types/Product';
-
-export {};
-
-declare global {
-  const Shopify: {
-    Image: {
-      getSizedImageUrl: CallableFunction
-      imageSize: CallableFunction
-      loadImage: CallableFunction
-      removeProtocol: CallableFunction
-      switchImage: CallableFunction
-    }
-    OptionSelectors: (selector: string, config: {
-      product: Product
-      onVariantSelected: CallableFunction
-      enableHistoryState: boolean
-    }) => void
-    OptionSelectorsFromDOM: FunctionConstructor
-    currency: {
-      active: string
-      rate: string
-    }
-    formatMoney: (price: string | number, format: string) => string
-    money_format: string
-    shop: string
-  };
-}