@anker-in/lib 1.0.0-beta.6 → 1.1.0

package/src/shopify/fetchers/remove-cart-lines.ts

@@ -0,0 +1,31 @@
+import { Cart, MutationCartLinesRemoveArgs } from '../gql'
+import { removeCartItemsMutation } from '../mutations/remove-cart-items'
+import type { Cart as ExportCart } from '../types/cart'
+import { ShopifyFetcher } from '../types/fetcher'
+import { fetchGraphqlApi } from '../utils/fetch-graphql-api'
+import { normalizeCart } from '../utils/normalize'
+
+/**
+ * Removes cart lines from the Shopify API.
+ *
+ * @param options - The options for removing cart lines.
+ * @param config - The store configuration.
+ * @returns The normalized cart after removing the cart lines, or undefined if the operation fails.
+ */
+export const removeCartLines: ShopifyFetcher<ExportCart | undefined, MutationCartLinesRemoveArgs> = async function ({
+  options,
+  config,
+}) {
+  const { data } = await fetchGraphqlApi<{ cartLinesRemove: { cart: Cart } }, MutationCartLinesRemoveArgs>({
+    query: removeCartItemsMutation,
+    variables: options,
+    config,
+  })
+
+  if (data?.cartLinesRemove?.cart) {
+    const normalizedCart = normalizeCart(data.cartLinesRemove.cart, '')
+    return normalizedCart
+  } else {
+    return undefined
+  }
+}

package/src/shopify/fetchers/update-cart-attributes.ts

@@ -0,0 +1,29 @@
+import { Cart, MutationCartAttributesUpdateArgs } from '../gql'
+import type { Cart as ExportCart } from '../types/cart'
+import { ShopifyFetcher } from '../types/fetcher'
+import { fetchGraphqlApi } from '../utils/fetch-graphql-api'
+import { normalizeCart } from '../utils/normalize'
+import { updateCartAttributesMutation } from '../mutations/update-cart-attributes'
+
+/**
+ * Updates the attributes of a cart.
+ *
+ * @param options - The options for updating the cart attributes.
+ * @param config - The store configuration.
+ * @returns The updated cart or undefined if the update was unsuccessful.
+ */
+export const updateCartAttributes: ShopifyFetcher<ExportCart | undefined, MutationCartAttributesUpdateArgs> =
+  async function ({ options, config }) {
+    const { data } = await fetchGraphqlApi<{ cartAttributesUpdate: { cart: Cart } }, MutationCartAttributesUpdateArgs>({
+      query: updateCartAttributesMutation,
+      variables: options,
+      config,
+    })
+
+    if (data?.cartAttributesUpdate?.cart) {
+      const normalizedCart = normalizeCart(data.cartAttributesUpdate.cart, '')
+      return normalizedCart
+    } else {
+      return undefined
+    }
+  }

package/src/shopify/fetchers/update-cart-buyer-identity.ts

@@ -0,0 +1,32 @@
+import { Cart, MutationCartBuyerIdentityUpdateArgs } from '../gql'
+import type { Cart as ExportCart } from '../types/cart'
+import { ShopifyFetcher } from '../types/fetcher'
+import { fetchGraphqlApi } from '../utils/fetch-graphql-api'
+import { normalizeCart } from '../utils/normalize'
+import { updateCartBuyerIdentityMutation } from '../mutations/update-cart-buyer-identity'
+
+/**
+ * Updates the buyer identity of a cart.
+ *
+ * @param options - The options for updating the cart buyer identity.
+ * @param config - The store configuration.
+ * @returns The updated cart or undefined if the update was unsuccessful.
+ */
+export const updateCartBuyerIdentity: ShopifyFetcher<ExportCart | undefined, MutationCartBuyerIdentityUpdateArgs> =
+  async function ({ options, config }) {
+    const { data } = await fetchGraphqlApi<
+      { cartBuyerIdentityUpdate: { cart: Cart } },
+      MutationCartBuyerIdentityUpdateArgs
+    >({
+      query: updateCartBuyerIdentityMutation,
+      variables: options,
+      config,
+    })
+
+    if (data?.cartBuyerIdentityUpdate?.cart) {
+      const normalizedCart = normalizeCart(data.cartBuyerIdentityUpdate.cart, '')
+      return normalizedCart
+    } else {
+      return undefined
+    }
+  }

package/src/shopify/fetchers/update-cart-codes.ts

@@ -0,0 +1,32 @@
+import { Cart, MutationCartDiscountCodesUpdateArgs } from '../gql'
+import type { Cart as ExportCart } from '../types/cart'
+import { ShopifyFetcher } from '../types/fetcher'
+import { fetchGraphqlApi } from '../utils/fetch-graphql-api'
+import { normalizeCart } from '../utils/normalize'
+import { updateCartDiscountCodeMutation } from '../mutations/update-cart-discount-code'
+
+/**
+ * Updates the discount codes for a cart in the Shopify API.
+ *
+ * @param options - The options for updating the cart discount codes.
+ * @param config - The store configuration.
+ * @returns The updated cart or undefined if the update was unsuccessful.
+ */
+export const updateCartCodes: ShopifyFetcher<ExportCart | undefined, MutationCartDiscountCodesUpdateArgs> =
+  async function ({ options, config }) {
+    const { data } = await fetchGraphqlApi<
+      {
+        cartDiscountCodesUpdate: { cart: Cart }
+      },
+      MutationCartDiscountCodesUpdateArgs
+    >({
+      query: updateCartDiscountCodeMutation,
+      variables: options,
+      config,
+    })
+    if (data.cartDiscountCodesUpdate.cart) {
+      return normalizeCart(data.cartDiscountCodesUpdate.cart, '')
+    } else {
+      return undefined
+    }
+  }

package/src/shopify/fetchers/update-cart-lines.ts

@@ -0,0 +1,42 @@
+import { Cart, MutationCartLinesUpdateArgs } from '../gql'
+import type { Cart as ExportCart } from '../types/cart'
+import { ShopifyFetcher } from '../types/fetcher'
+import { fetchGraphqlApi } from '../utils/fetch-graphql-api'
+import { normalizeCart } from '../utils/normalize'
+import { updateCartLinesMutation } from '../mutations/update-cart-items'
+
+/**
+ * Updates the cart lines in the Shopify API.
+ *
+ * @param options - The options for updating the cart lines.
+ * @param config - The store configuration.
+ * @returns The updated cart or undefined if the update was unsuccessful.
+ */
+export const updateCartLines: ShopifyFetcher<ExportCart | undefined, MutationCartLinesUpdateArgs> = async function ({
+  options,
+  config,
+}) {
+  const { data } = await fetchGraphqlApi<
+    { cartLinesUpdate: { cart: Cart; userErrors?: any } },
+    MutationCartLinesUpdateArgs
+  >({
+    query: updateCartLinesMutation,
+    variables: options,
+    config,
+  })
+
+  if (data?.cartLinesUpdate?.userErrors?.length) {
+    const errors = data.cartLinesUpdate?.userErrors
+    const quantityError = errors.find((error: any) => error.field?.includes('quantity'))
+    if (quantityError) {
+      return Promise.reject(quantityError)
+    }
+  }
+
+  if (data?.cartLinesUpdate?.cart) {
+    const normalizedCart = normalizeCart(data.cartLinesUpdate.cart, '')
+    return normalizedCart
+  } else {
+    return undefined
+  }
+}

package/src/shopify/fragments/article.ts

@@ -0,0 +1,51 @@
+export const articleFragment = /* GraphQL */ `
+  fragment article on Article {
+    id
+    handle
+    title
+    seo {
+      ...seo
+    }
+    image {
+      ...image
+    }
+    tags
+    publishedAt
+    content
+    contentHtml
+    excerpt
+    excerptHtml
+    authorV2 {
+      bio
+      email
+      firstName
+      lastName
+      name
+    }
+  }
+`
+
+export const articleWithoutContentFragment = /* GraphQL */ `
+  fragment article on Article {
+    id
+    handle
+    title
+    seo {
+      ...seo
+    }
+    image {
+      ...image
+    }
+    tags
+    publishedAt
+    excerpt
+    excerptHtml
+    authorV2 {
+      bio
+      email
+      firstName
+      lastName
+      name
+    }
+  }
+`

package/src/shopify/fragments/blog.ts

@@ -0,0 +1,10 @@
+export const blogFragment = /* GraphQL */ `
+  fragment blog on Blog {
+    id
+    handle
+    title
+    seo {
+      ...seo
+    }
+  }
+`

package/src/shopify/fragments/cart.ts

@@ -0,0 +1,193 @@
+import { imageFragment } from './image'
+import { metafieldFragment } from './metafields'
+import { productFragment } from './product'
+import { seoFragment } from './seo'
+
+export const cartFragment = /* GraphQL */ `
+  fragment cart on Cart {
+    id
+    totalQuantity
+    updatedAt
+    createdAt
+    checkoutUrl
+    note
+    attributes {
+      key
+      value
+    }
+    cost {
+      checkoutChargeAmount {
+        amount
+        currencyCode
+      }
+      subtotalAmount {
+        amount
+        currencyCode
+      }
+      totalAmount {
+        amount
+        currencyCode
+      }
+      totalTaxAmount {
+        amount
+        currencyCode
+      }
+      totalDutyAmount {
+        amount
+        currencyCode
+      }
+      totalAmountEstimated
+      totalTaxAmountEstimated
+      totalDutyAmountEstimated
+      subtotalAmountEstimated
+    }
+    buyerIdentity {
+      email
+      customer {
+        email
+        id
+      }
+      deliveryAddressPreferences {
+        ... on MailingAddress {
+          address1
+          address2
+          city
+          country
+          zip
+        }
+      }
+    }
+    discountCodes {
+      applicable
+      code
+    }
+    discountAllocations {
+      ... on CartCodeDiscountAllocation {
+        code
+        discountedAmount {
+          amount
+          currencyCode
+        }
+      }
+      ... on CartAutomaticDiscountAllocation {
+        title
+        discountedAmount {
+          amount
+          currencyCode
+        }
+      }
+      ... on CartCustomDiscountAllocation {
+        title
+        discountedAmount {
+          amount
+          currencyCode
+        }
+      }
+    }
+    deliveryGroups(first: 10) {
+      nodes {
+        deliveryAddress {
+          address1
+          address2
+          city
+          country
+          zip
+        }
+      }
+    }
+    lines(first: 100) {
+      edges {
+        node {
+          id
+          quantity
+          discountAllocations {
+            ... on CartCodeDiscountAllocation {
+              code
+              discountedAmount {
+                amount
+                currencyCode
+              }
+            }
+            ... on CartAutomaticDiscountAllocation {
+              title
+              discountedAmount {
+                amount
+                currencyCode
+              }
+            }
+            ... on CartCustomDiscountAllocation {
+              title
+              discountedAmount {
+                amount
+                currencyCode
+              }
+            }
+          }
+          attributes {
+            key
+            value
+          }
+          cost {
+            amountPerQuantity {
+              amount
+              currencyCode
+            }
+            compareAtAmountPerQuantity {
+              amount
+              currencyCode
+            }
+            subtotalAmount {
+              amount
+              currencyCode
+            }
+            totalAmount {
+              amount
+              currencyCode
+            }
+          }
+          merchandise {
+            ... on ProductVariant {
+              id
+              sku
+              title
+              quantityAvailable
+              currentlyNotInStock
+              availableForSale
+              barcode
+              weight
+              selectedOptions {
+                name
+                value
+              }
+              image {
+                ...image
+              }
+              price {
+                amount
+                currencyCode
+              }
+              compareAtPrice {
+                amount
+                currencyCode
+              }
+              metafields(identifiers: $variantMetafieldIdentifiers) {
+                ...metafield
+              }
+              product {
+                ...product
+                metafields(identifiers: $productMetafieldIdentifiers) {
+                  ...metafield
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+    totalQuantity
+  }
+  ${productFragment}
+  ${seoFragment}
+  ${imageFragment}
+  ${metafieldFragment}
+`

package/src/shopify/fragments/collection.ts

@@ -0,0 +1,15 @@
+export const collectionFragment = /* GraphQL */ `
+  fragment collection on Collection {
+    id
+    handle
+    title
+    description
+    descriptionHtml
+    seo {
+      ...seo
+    }
+    image {
+      ...image
+    }
+  }
+`

package/src/shopify/fragments/image.ts

@@ -0,0 +1,8 @@
+export const imageFragment = /* GraphQL */ `
+  fragment image on Image {
+    url
+    altText
+    width
+    height
+  }
+`

package/src/shopify/fragments/index.ts

@@ -0,0 +1,11 @@
+export * from './article'
+export * from './blog'
+export * from './collection'
+export * from './cart'
+export * from './image'
+export * from './metafields'
+export * from './page-info'
+export * from './product'
+export * from './seo'
+export * from './variant'
+export * from './page'

package/src/shopify/fragments/metafields.ts

@@ -0,0 +1,17 @@
+export const metafieldFragment = /* GraphQL */ `
+  fragment metafield on Metafield {
+    value
+    type
+    description
+    namespace
+    key
+  }
+`
+
+export const metafieldFragmentStr = `
+  value
+  type
+  description
+  namespace
+  key
+`

package/src/shopify/fragments/page-info.ts

@@ -0,0 +1,8 @@
+export const pageInfoFragment = /* GraphQL */ `
+  fragment pageInfo on PageInfo {
+    hasNextPage
+    hasPreviousPage
+    startCursor
+    endCursor
+  }
+`

package/src/shopify/fragments/page.ts

@@ -0,0 +1,12 @@
+export const pageFragment = /* GraphQL */ `
+  fragment page on Page {
+    title
+    handle
+    body
+    bodySummary
+    seo {
+      title
+      description
+    }
+  }
+`

package/src/shopify/fragments/product.ts

@@ -0,0 +1,71 @@
+export const productFragment = /* GraphQL */ `
+  fragment product on Product {
+    id
+    handle
+    availableForSale
+    title
+    description
+    descriptionHtml
+    options {
+      id
+      name
+      values
+    }
+    productType
+    priceRange {
+      maxVariantPrice {
+        amount
+        currencyCode
+      }
+      minVariantPrice {
+        amount
+        currencyCode
+      }
+    }
+    compareAtPriceRange {
+      minVariantPrice {
+        amount
+        currencyCode
+      }
+    }
+    featuredImage {
+      ...image
+    }
+    images(first: 250) {
+      nodes {
+        ...image
+      }
+    }
+    media(first: 250) {
+      nodes {
+        id
+        mediaContentType
+        presentation {
+          id
+        }
+        ... on Video {
+          id
+          sources {
+            format
+            height
+            mimeType
+            url
+            width
+          }
+        }
+        ... on MediaImage {
+          id
+          image {
+            altText
+            url
+          }
+        }
+      }
+    }
+    seo {
+      ...seo
+    }
+    tags
+    updatedAt
+  }
+`

package/src/shopify/fragments/seo.ts

@@ -0,0 +1,6 @@
+export const seoFragment = /* GraphQL */ `
+  fragment seo on SEO {
+    description
+    title
+  }
+`

package/src/shopify/fragments/variant.ts

@@ -0,0 +1,29 @@
+export const variantFragment = /* GraphQL */ `
+  fragment variant on ProductVariant {
+    id
+    sku
+    title
+    requiresShipping
+    quantityAvailable
+    currentlyNotInStock
+    availableForSale
+    barcode
+    quantityAvailable
+    weight
+    selectedOptions {
+      name
+      value
+    }
+    image {
+      ...image
+    }
+    price {
+      amount
+      currencyCode
+    }
+    compareAtPrice {
+      amount
+      currencyCode
+    }
+  }
+`

package/src/shopify/gql/fragment-masking.ts

@@ -0,0 +1,85 @@
+import {
+  ResultOf,
+  DocumentTypeDecoration,
+  TypedDocumentNode,
+} from '@graphql-typed-document-node/core'
+import { FragmentDefinitionNode } from 'graphql'
+import { Incremental } from './graphql'
+
+export type FragmentType<
+  TDocumentType extends DocumentTypeDecoration<any, any>
+> = TDocumentType extends DocumentTypeDecoration<infer TType, any>
+  ? [TType] extends [{ ' $fragmentName'?: infer TKey }]
+    ? TKey extends string
+      ? { ' $fragmentRefs'?: { [key in TKey]: TType } }
+      : never
+    : never
+  : never
+
+// return non-nullable if `fragmentType` is non-nullable
+export function useFragment<TType>(
+  _documentNode: DocumentTypeDecoration<TType, any>,
+  fragmentType: FragmentType<DocumentTypeDecoration<TType, any>>
+): TType
+// return nullable if `fragmentType` is nullable
+export function useFragment<TType>(
+  _documentNode: DocumentTypeDecoration<TType, any>,
+  fragmentType:
+    | FragmentType<DocumentTypeDecoration<TType, any>>
+    | null
+    | undefined
+): TType | null | undefined
+// return array of non-nullable if `fragmentType` is array of non-nullable
+export function useFragment<TType>(
+  _documentNode: DocumentTypeDecoration<TType, any>,
+  fragmentType: ReadonlyArray<FragmentType<DocumentTypeDecoration<TType, any>>>
+): ReadonlyArray<TType>
+// return array of nullable if `fragmentType` is array of nullable
+export function useFragment<TType>(
+  _documentNode: DocumentTypeDecoration<TType, any>,
+  fragmentType:
+    | ReadonlyArray<FragmentType<DocumentTypeDecoration<TType, any>>>
+    | null
+    | undefined
+): ReadonlyArray<TType> | null | undefined
+export function useFragment<TType>(
+  _documentNode: DocumentTypeDecoration<TType, any>,
+  fragmentType:
+    | FragmentType<DocumentTypeDecoration<TType, any>>
+    | ReadonlyArray<FragmentType<DocumentTypeDecoration<TType, any>>>
+    | null
+    | undefined
+): TType | ReadonlyArray<TType> | null | undefined {
+  return fragmentType as any
+}
+
+export function makeFragmentData<
+  F extends DocumentTypeDecoration<any, any>,
+  FT extends ResultOf<F>
+>(data: FT, _fragment: F): FragmentType<F> {
+  return data as FragmentType<F>
+}
+export function isFragmentReady<TQuery, TFrag>(
+  queryNode: DocumentTypeDecoration<TQuery, any>,
+  fragmentNode: TypedDocumentNode<TFrag>,
+  data:
+    | FragmentType<TypedDocumentNode<Incremental<TFrag>, any>>
+    | null
+    | undefined
+): data is FragmentType<typeof fragmentNode> {
+  const deferredFields = (
+    queryNode as {
+      __meta__?: { deferredFields: Record<string, (keyof TFrag)[]> }
+    }
+  ).__meta__?.deferredFields
+
+  if (!deferredFields) return true
+
+  const fragDef = fragmentNode.definitions[0] as
+    | FragmentDefinitionNode
+    | undefined
+  const fragName = fragDef?.name?.value
+
+  const fields = (fragName && deferredFields[fragName]) || []
+  return fields.length > 0 && fields.every((field) => data && field in data)
+}