@grafikr/shopify-typescript 1.2.0 → 2.1.0

package/README.md

@@ -7,13 +7,13 @@ This packages adds TypeScript for all Shopify responses and objects.
 You can install the package using Yarn:
 
 ```
-$ yarn install @grafikr/shopify-typescript --save
+$ yarn install @grafikr/shopify-typescript
 ```
 
 ### Usage
 
 ```ts
-import Product from '@grafikr/shopify-typescript/type/Product';
+import type { Product } from '@grafikr/shopify-typescript/type/json/Product';
 
 const func = (data: Product) => {
   ...

package/global/CustomEvents.d.ts

@@ -0,0 +1,38 @@
+export type CustomEvents = {
+  /** The theme editor preview inspector has been activated */
+  'shopify:inspector:activate': undefined;
+
+  /** The theme editor preview inspector has been deactivated */
+  'shopify:inspector:deactivate': undefined;
+
+  /** A section has been added or re-rendered */
+  'shopify:section:load': { sectionId: string };
+
+  /** A section has been deleted or is being re-rendered */
+  'shopify:section:unload': { sectionId: string };
+
+  /** The user has selected the section in the sidebar */
+  'shopify:section:select': {
+    sectionId: string;
+    load: boolean;
+  };
+
+  /** The user has deselected the section in the sidebar.	 */
+  'shopify:section:deselect': { sectionId: string };
+
+  /** A section has been reordered */
+  'shopify:section:reorder': { sectionId: string };
+
+  /** The user has selected the block in the sidebar */
+  'shopify:block:select': {
+    blockId: string;
+    sectionId: string;
+    load: boolean;
+  };
+
+  /** User has deselected the block in the sidebar */
+  'shopify:block:deselect': {
+    blockId: string;
+    sectionId: string;
+  };
+};

package/global/Shopify.d.ts

@@ -0,0 +1,24 @@
+import type { CustomerPrivacy } from './modules/customerPrivacy';
+
+export type Shopify = {
+  loadFeatures: (
+    features: Array<{ name: string; version: string }>,
+    callback: CallableFunction,
+  ) => void;
+  customerPrivacy?: CustomerPrivacy;
+  currency: {
+    active: string;
+    rate: string;
+  };
+  cdnHost: string;
+  country: string;
+  designMode: true | undefined;
+  locale: string;
+  shop: string;
+  recaptchaV3: {
+    siteKey: string;
+  };
+  routes: {
+    root: string;
+  };
+};

package/global/modules/customerPrivacy.d.ts

@@ -0,0 +1,44 @@
+type YesNo = '' | 'yes' | 'no';
+
+export type CustomerPrivacy = {
+  analyticsProcessingAllowed(): boolean;
+  currentVisitorConsent(): {
+    marketing: YesNo;
+    analytics: YesNo;
+    preferences: YesNo;
+    sale_of_data: YesNo;
+    gpc: YesNo;
+  };
+  doesMerchantSupportGranularConsent(): boolean;
+  firstPartyMarketingAllowed(): boolean;
+  getCCPAConsent(): YesNo;
+  getRegulation(): string;
+  getShopPrefs(): { limit: Array<string> };
+  getTrackingConsent(): YesNo;
+  isRegulationEnforced(): boolean;
+  preferencesProcessingAllowed(): boolean;
+  saleOfDataRegion(): boolean;
+  setCCPAConsent(consent: boolean, callback: () => void): void;
+  setTrackingConsent(
+    consent: {
+      analytics?: boolean;
+      marketing?: boolean;
+      preferences?: boolean;
+      sale_of_data?: boolean;
+    },
+    callback: () => void,
+  ): void;
+  shouldShowBanner(): boolean;
+  thirdPartyMarketingAllowed(): boolean;
+
+  /** @deprecated Use consent as an object instead */
+  setTrackingConsent(consent: boolean, callback: () => void): void;
+  /** @deprecated Use saleOfDataRegion instead */
+  shouldShowCCPABanner(): boolean;
+  /** @deprecated Use shouldShowBanner instead */
+  shouldShowGDPRBanner(): boolean;
+  /** @deprecated */
+  userCanBeTracked(): boolean;
+  /** @deprecated */
+  userDataCanBeSold(): boolean;
+};

package/package.json

@@ -1,22 +1,16 @@
 {
   "name": "@grafikr/shopify-typescript",
-  "version": "1.2.0",
+  "version": "2.1.0",
   "license": "MIT",
   "scripts": {
-    "lint": "node_modules/.bin/eslint . --ext .js,.ts",
-    "test": "yarn lint"
+    "format": "yarn prettier . --write"
   },
   "engines": {
     "node": ">=16.0.0"
   },
   "devDependencies": {
-    "@typescript-eslint/eslint-plugin": "^5.0.0",
-    "@typescript-eslint/parser": "^5.0.0",
-    "eslint": "^8.4.0",
-    "eslint-config-airbnb-base": "^15.0.0",
-    "eslint-config-airbnb-typescript": "^17.0.0",
-    "eslint-plugin-import": "^2.0.0",
-    "typescript": "^5.0.2"
+    "prettier": "^3.0.0",
+    "typescript": "^5.0.0"
   },
   "repository": {
     "type": "git",

package/type/endpoints/BrowsingContextSuggestions.d.ts

@@ -0,0 +1,3 @@
+import type { BrowsingContextSuggestions as BrowsingContextSuggestionsType } from '../json/BrowsingContextSuggestions';
+
+export type BrowsingContextSuggestions = BrowsingContextSuggestionsType;

package/type/endpoints/Cart.d.ts

@@ -0,0 +1,22 @@
+import type {
+  Cart as CartType,
+  UpdatedCart as UpdatedCartType,
+  CartError as CartErrorType,
+} from '../json/Cart';
+import type { UpdatedLineItem } from '../json/LineItem';
+
+export type Cart = CartType;
+
+export type CartAdd =
+  | UpdatedLineItem
+  | {
+      items: Array<UpdatedLineItem>;
+    };
+
+export type CartChange = UpdatedCartType;
+
+export type CartClear = CartType;
+
+export type CartUpdate = UpdatedCartType;
+
+export type CartError = CartErrorType;

package/type/endpoints/Collection.d.ts

@@ -0,0 +1,14 @@
+import type { Collection as CollectionType } from '../json/Collection';
+import type { Product as ProductType } from '../json/Product';
+
+export type Collection = {
+  collection: CollectionType;
+};
+
+export type Collections = {
+  collections: Array<CollectionType>;
+};
+
+export type Products = {
+  products: Array<ProductType>;
+};

package/type/endpoints/Page.d.ts

@@ -0,0 +1,9 @@
+import type { Page as PageType } from '../json/Page';
+
+export type Page = {
+  page: PageType;
+};
+
+export type Pages = {
+  pages: Array<PageType>;
+};

package/type/endpoints/Policy.d.ts

@@ -0,0 +1,5 @@
+import type { Policy as PolicyType } from '../json/Policy';
+
+export type Policy = {
+  policy: PolicyType;
+};

package/type/endpoints/Product.d.ts

@@ -0,0 +1,14 @@
+import type { Product as ProductType } from '../json/Product';
+
+export type Product = {
+  product: ProductType;
+};
+
+export type Products = {
+  products: Array<ProductType>; // TODO: Fix types
+};
+
+export type Recommendations = {
+  products: Array<ProductType>;
+  intent: 'related' | 'complementary';
+};

package/type/endpoints/Search.d.ts

@@ -0,0 +1,20 @@
+import type { Article as ArticleType } from '../json/Search/Article';
+import type { Collection as CollectionType } from '../json/Search/Collection';
+import type { Page as PageType } from '../json/Search/Page';
+import type { Product as ProductType } from '../json/Search/Product';
+
+export type Suggest = {
+  resources: {
+    results: {
+      queries?: Array<{
+        url: string;
+        text: string;
+        styled_text: string;
+      }>;
+      articles?: Array<ArticleType>;
+      collections?: Array<CollectionType>;
+      pages?: Array<PageType>;
+      products?: Array<ProductType>;
+    };
+  };
+};

package/type/json/BrowsingContextSuggestions.d.ts

@@ -0,0 +1,25 @@
+export type BrowsingContextSuggestions = {
+  detected_values: {
+    country: {
+      handle: string;
+      name: string;
+    };
+  };
+  suggestions: Array<{
+    parts: {
+      country: {
+        handle: string;
+        name: string;
+        confidence: number;
+        options: Record<string, string>;
+      };
+      language: {
+        handle: string;
+        name: string;
+        confidence: number;
+        options: Record<string, string>;
+      };
+    };
+    confidence: string;
+  }>;
+};

package/type/json/Cart.d.ts

@@ -0,0 +1,33 @@
+import type { LineItem, UpdatedLineItem } from './LineItem';
+import type { DiscountApplication } from './DiscountApplication';
+
+export type Cart = {
+  token: string;
+  note: string | null;
+  attributes: Record<string, any>;
+  original_total_price: number;
+  total_price: number;
+  total_discount: number;
+  total_weight: number;
+  item_count: number;
+  items: Array<LineItem>;
+  requires_shipping: boolean;
+  currency: string;
+  items_subtotal_price: number;
+  cart_level_discount_applications: Array<DiscountApplication>;
+};
+
+export type UpdatedCart = Omit<Cart, 'cart_level_discount_applications'> & {
+  items_added: Array<UpdatedLineItem>;
+  items_removed: Array<UpdatedLineItem>;
+  cart_level_discount_applications: Array<{
+    amount: number;
+    discount_application: DiscountApplication;
+  }>;
+};
+
+export type CartError = {
+  description: string;
+  message: string;
+  status: number;
+};

package/type/json/Collection.d.ts

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

package/type/json/DiscountAllocation.d.ts

@@ -0,0 +1,6 @@
+import type { DiscountApplication } from './DiscountApplication';
+
+export type DiscountAllocation = {
+  amount: number;
+  discount_application: DiscountApplication;
+};

package/type/json/DiscountApplication.d.ts

@@ -0,0 +1,13 @@
+export type DiscountApplication = {
+  type: 'automatic' | 'discount_code' | 'manual' | 'script';
+  key: string;
+  title: string;
+  description: string | null;
+  value: string;
+  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/json/FeaturedImage.d.ts

@@ -0,0 +1,15 @@
+export type FeaturedImage =
+  | {
+      aspect_ratio: number;
+      alt: string;
+      height: number;
+      url: string;
+      width: number;
+    }
+  | {
+      aspect_ratio: null;
+      alt: null;
+      height: null;
+      url: null;
+      width: null;
+    };

package/type/json/Image.d.ts

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

package/type/json/LineItem.d.ts

@@ -0,0 +1,67 @@
+import type { DiscountAllocation } from './DiscountAllocation';
+import type { FeaturedImage } from './FeaturedImage';
+
+export type LineItem = {
+  id: number;
+  properties: Record<string, any>;
+  quantity: number;
+  variant_id: number;
+  key: string;
+  title: string;
+  original_price: number;
+  discounted_price: number;
+  original_line_price: number;
+  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: FeaturedImage;
+  image: string | null;
+  handle: string;
+  requires_shipping: boolean;
+  product_type: string;
+  product_title: string;
+  product_description: string;
+  variant_title: string;
+  variant_options: Array<string>;
+  options_with_values: [
+    {
+      name: string;
+      value: string;
+    },
+  ];
+  line_level_discount_allocations: Array<DiscountAllocation>;
+  line_level_total_discount: number;
+  quantity_rule: {
+    min: number;
+    max: number | null;
+    increment: number;
+  };
+  has_components: boolean;
+
+  // Deprecated values
+  /** @deprecated Use line_level_discount_allocations instead */
+  discounts: [
+    {
+      amount: number;
+      title: string;
+    },
+  ];
+  /** @deprecated Use final_line_price instead */
+  line_price: number;
+  /** @deprecated Use final_price instead */
+  price: number;
+  /** @deprecated Use line_level_total_discount instead */
+  total_discount: number;
+};
+
+export type UpdatedLineItem = LineItem & {
+  untranslated_product_title: string;
+  untranslated_variant_title: string;
+};

package/type/json/Page.d.ts

@@ -0,0 +1,9 @@
+export type Page = {
+  id: number;
+  body_html: string;
+  created_at: string;
+  published_at: string;
+  updated_at: string;
+  handle: string;
+  title: string;
+};

package/type/json/Policy.d.ts

@@ -0,0 +1,7 @@
+export type Policy = {
+  body: string;
+  created_at: string;
+  updated_at: string;
+  handle: string;
+  title: string;
+};

package/type/json/Product.d.ts

@@ -0,0 +1,22 @@
+import type { ProductVariant } from './ProductVariant';
+import type { ProductOption } from './ProductOption';
+import type { ProductImage } from './ProductImage';
+
+export type Product = {
+  id: number;
+  title: string;
+  body_html: string | null;
+  vendor: string;
+  product_type: string;
+  created_at: string;
+  handle: string;
+  updated_at: string;
+  published_at: string;
+  template_suffix: string;
+  published_scope: string;
+  tags: string;
+  variants: Array<ProductVariant>;
+  options: Array<ProductOption>;
+  images: Array<ProductImage>;
+  image: ProductImage;
+};

package/type/json/ProductImage.d.ts

@@ -0,0 +1,10 @@
+import type { Image } from './Image';
+
+export type ProductImage = Image & {
+  product_id: number;
+  position: number;
+  updated_at: string;
+  width: number;
+  height: number;
+  variant_ids: Array<number>;
+};

package/type/json/ProductOption.d.ts

@@ -0,0 +1,7 @@
+export type ProductOption = {
+  id: number;
+  product_id: number;
+  name: string;
+  position: number;
+  values: Array<string>;
+};

package/type/json/ProductVariant.d.ts

@@ -0,0 +1,23 @@
+export type ProductVariant = {
+  id: number;
+  product_id: number;
+  title: string;
+  price: string;
+  sku: string;
+  position: number;
+  compare_at_price: string;
+  fulfillment_service: string;
+  inventory_management: string;
+  option1: string | null;
+  option2: string | null;
+  option3: string | null;
+  created_at: string;
+  updated_at: string;
+  taxable: boolean;
+  barcode: string;
+  grams: number;
+  image_id: number | null;
+  weight: number;
+  weight_unit: 'g' | 'kg';
+  requires_shipping: boolean;
+};

package/type/json/Search/Article.d.ts

@@ -0,0 +1,11 @@
+import type { SearchItem } from './SearchItem';
+import type { FeaturedImage } from '../FeaturedImage';
+
+export type Article = SearchItem & {
+  author: string;
+  image: string | null;
+  published_at: string;
+  summary_html: string;
+  tags: Array<string>;
+  featured_image: FeaturedImage;
+};

package/type/json/Search/Collection.d.ts

@@ -0,0 +1,7 @@
+import type { SearchItem } from './SearchItem';
+import type { FeaturedImage } from '../FeaturedImage';
+
+export type Collection = SearchItem & {
+  published_at: string;
+  featured_image: FeaturedImage;
+};

package/type/json/Search/Page.d.ts

@@ -0,0 +1,6 @@
+import type { SearchItem } from './SearchItem';
+
+export type Page = SearchItem & {
+  author: null;
+  published_at: string;
+};

package/type/json/Search/Product.d.ts

@@ -0,0 +1,18 @@
+import type { FeaturedImage } from '../FeaturedImage';
+import type { SearchItem } from './SearchItem';
+import type { ProductVariant } from './ProductVariant';
+
+export type Product = SearchItem & {
+  available: boolean;
+  compare_at_price_max: string;
+  compare_at_price_min: string;
+  image: string | null;
+  price: string;
+  price_max: string;
+  price_min: string;
+  tags: Array<string>;
+  type: string;
+  variants: Array<ProductVariant>;
+  vendor: string;
+  featured_image: FeaturedImage;
+};

package/type/json/Search/ProductVariant.d.ts

@@ -0,0 +1,12 @@
+import type { FeaturedImage } from '../FeaturedImage';
+
+export type ProductVariant = {
+  available: true;
+  compare_at_price: string | null;
+  id: number;
+  image: string | null;
+  price: string;
+  title: string;
+  url: string;
+  featured_image: FeaturedImage;
+};

package/type/json/Search/SearchItem.d.ts

@@ -0,0 +1,7 @@
+export type SearchItem = {
+  id: number;
+  handle: string;
+  url: string;
+  title: string;
+  body: string;
+};

package/type/liquid/Article.d.ts

@@ -0,0 +1,18 @@
+import type { Image } from './Image';
+
+export type 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/liquid/Collection.d.ts

@@ -0,0 +1,20 @@
+import type { Image } from './Image';
+
+export type 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?: Array<{
+    column: string;
+    relation: string;
+    condition: string;
+  }>;
+  published_scope: string;
+  image?: Image;
+};

package/type/liquid/FeaturedVariantImage.d.ts

@@ -0,0 +1,11 @@
+export type FeaturedVariantImage = {
+  alt: string | null;
+  created_at: string;
+  height: number;
+  id: number;
+  position: number;
+  product_id: number;
+  updated_at: string;
+  variant_ids: Array<number>;
+  width: number;
+};

package/type/liquid/FeaturedVariantMedia.d.ts

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

package/type/liquid/Image.d.ts

@@ -0,0 +1,7 @@
+export type Image = {
+  created_at: string;
+  alt: string | null;
+  width: number;
+  height: number;
+  src: string;
+};