diff --git a/.editorconfig b/.editorconfig
deleted file mode 100644
index 11ebf4e4e4..0000000000
--- a/.editorconfig
+++ /dev/null
@@ -1,23 +0,0 @@
-root = true
-
-[*]
-indent_style = space
-indent_size = 2
-tab_width = 4
-end_of_line = lf
-charset = utf-8
-trim_trailing_whitespace = true
-insert_final_newline = true
-
-[*.md]
-trim_trailing_whitespace = false
-
-[*.js]
-quote_type = single
-
-[{*.c,*.cc,*.h,*.hh,*.cpp,*.hpp,*.m,*.mm,*.mpp,*.js,*.java,*.go,*.rs,*.php,*.ng,*.jsx,*.ts,*.d,*.cs,*.swift}]
-curly_bracket_next_line = false
-spaces_around_operators = true
-spaces_around_brackets = outside
-# close enough to 1TB
-indent_brace_style = K&R
diff --git a/.env.example b/.env.example
new file mode 100644
index 0000000000..bd952c5310
--- /dev/null
+++ b/.env.example
@@ -0,0 +1,3 @@
+SHOPIFY_STOREFRONT_ACCESS_TOKEN=
+SHOPIFY_STORE_DOMAIN=
+SHOPIFY_REVALIDATION_TOKEN=
diff --git a/.eslintrc.js b/.eslintrc.js
new file mode 100644
index 0000000000..b3e65ae8c4
--- /dev/null
+++ b/.eslintrc.js
@@ -0,0 +1,23 @@
+module.exports = {
+ extends: ['next', 'prettier'],
+ plugins: ['unicorn'],
+ rules: {
+ 'no-unused-vars': [
+ 'error',
+ {
+ args: 'after-used',
+ caughtErrors: 'none',
+ ignoreRestSiblings: true,
+ vars: 'all'
+ }
+ ],
+ 'prefer-const': 'error',
+ 'react-hooks/exhaustive-deps': 'error',
+ 'unicorn/filename-case': [
+ 'error',
+ {
+ case: 'kebabCase'
+ }
+ ]
+ }
+};
diff --git a/.github/ISSUE_TEMPLATE/1.core_bug_report.yml b/.github/ISSUE_TEMPLATE/1.core_bug_report.yml
deleted file mode 100644
index 6d3848884e..0000000000
--- a/.github/ISSUE_TEMPLATE/1.core_bug_report.yml
+++ /dev/null
@@ -1,55 +0,0 @@
-name: Core package Bug Report
-description: Create a bug report for the Next.js commerce core package
-labels: 'template: core bug'
-body:
- - type: markdown
- attributes:
- value: Thanks for taking the time to file a bug report! Please fill out this form as completely as possible.
- - type: checkboxes
- attributes:
- label: Verify latest commit
- description: `main` is the latest version of Next.js Commerce.
- options:
- - label: I verified that the issue exists on `main`
- required: true
- - type: textarea
- attributes:
- label: Provide environment information
- description: Please run `npx --no-install next info` in the root directory of your project and paste the results.
- validations:
- required: true
- - type: input
- attributes:
- label: What browser are you using? (if relevant)
- description: 'Please specify the exact version. For example: Chrome 100.0.4878.0'
- - type: input
- attributes:
- label: How are you deploying your application? (if relevant)
- description: 'For example: next start, next export, Vercel, Other platform'
- - type: textarea
- attributes:
- label: Describe the Bug
- description: A clear and concise description of what the bug is.
- validations:
- required: true
- - type: textarea
- attributes:
- label: Expected Behavior
- description: A clear and concise description of what you expected to happen.
- validations:
- required: true
- - type: textarea
- attributes:
- label: To Reproduce
- description: Steps to reproduce the behavior, please provide a clear code snippets that always reproduces the issue or a GitHub repository. Screenshots can be provided in the issue body below.
- validations:
- required: true
- - type: markdown
- attributes:
- value: Before posting the issue go through the steps you've written down to make sure the steps provided are detailed and clear.
- - type: markdown
- attributes:
- value: Contributors should be able to follow the steps provided in order to reproduce the bug.
- - type: markdown
- attributes:
- value: These steps are used to add integration tests to ensure the same issue does not happen again. Thanks in advance!
diff --git a/.github/ISSUE_TEMPLATE/2.provider_bug_report.yml b/.github/ISSUE_TEMPLATE/2.provider_bug_report.yml
deleted file mode 100644
index a600c3781d..0000000000
--- a/.github/ISSUE_TEMPLATE/2.provider_bug_report.yml
+++ /dev/null
@@ -1,59 +0,0 @@
-name: Provider package Bug Report
-description: Create a bug report for the Next.js commerce core package
-labels: 'template: provider bug'
-body:
- - type: markdown
- attributes:
- value: Thanks for taking the time to file a bug report! Please fill out this form as completely as possible.
- - type: checkboxes
- attributes:
- label: Verify latest commit
- description: `main` is the latest version of Next.js Commerce.
- options:
- - label: I verified that the issue exists on `main`
- required: true
- - type: textarea
- attributes:
- label: Provide environment information
- description: Please run `npx --no-install next info` in the root directory of your project and paste the results.
- validations:
- required: true
- - type: input
- attributes:
- label: What Provider are you using?
- description: 'Please specify the provider package name. For example: `bigcommerce`'
- - type: input
- attributes:
- label: What browser are you using? (if relevant)
- description: 'Please specify the exact version. For example: Chrome 100.0.4878.0'
- - type: input
- attributes:
- label: How are you deploying your application? (if relevant)
- description: 'For example: next start, next export, Vercel, Other platform'
- - type: textarea
- attributes:
- label: Describe the Bug
- description: A clear and concise description of what the bug is.
- validations:
- required: true
- - type: textarea
- attributes:
- label: Expected Behavior
- description: A clear and concise description of what you expected to happen.
- validations:
- required: true
- - type: textarea
- attributes:
- label: To Reproduce
- description: Steps to reproduce the behavior, please provide a clear code snippets that always reproduces the issue or a GitHub repository. Screenshots can be provided in the issue body below.
- validations:
- required: true
- - type: markdown
- attributes:
- value: Before posting the issue go through the steps you've written down to make sure the steps provided are detailed and clear.
- - type: markdown
- attributes:
- value: Contributors should be able to follow the steps provided in order to reproduce the bug.
- - type: markdown
- attributes:
- value: These steps are used to add integration tests to ensure the same issue does not happen again. Thanks in advance!
diff --git a/.github/ISSUE_TEMPLATE/3.feature_request.yml b/.github/ISSUE_TEMPLATE/3.feature_request.yml
deleted file mode 100644
index 2655aff44d..0000000000
--- a/.github/ISSUE_TEMPLATE/3.feature_request.yml
+++ /dev/null
@@ -1,28 +0,0 @@
-name: Feature Request
-description: Create a feature request for the Next.js core
-labels: 'template: story'
-body:
- - type: markdown
- attributes:
- value: Thanks for taking the time to file a feature request! Please fill out this form as completely as possible.
- - type: markdown
- attributes:
- value: 'Feature requests will be converted to the GitHub Discussions "Ideas" section.'
- - type: textarea
- attributes:
- label: Describe the feature you'd like to request
- description: A clear and concise description of what you want and what your use case is.
- validations:
- required: true
- - type: textarea
- attributes:
- label: Describe the solution you'd like
- description: A clear and concise description of what you want to happen.
- validations:
- required: true
- - type: textarea
- attributes:
- label: Describe alternatives you've considered
- description: A clear and concise description of any alternative solutions or features you've considered.
- validations:
- required: true
diff --git a/.github/ISSUE_TEMPLATE/4.docs_request.yml b/.github/ISSUE_TEMPLATE/4.docs_request.yml
deleted file mode 100644
index 72acd89ace..0000000000
--- a/.github/ISSUE_TEMPLATE/4.docs_request.yml
+++ /dev/null
@@ -1,18 +0,0 @@
-name: 'Docs Request for an Update or Improvement'
-description: A request to update or improve Next.js Commerce documentation
-title: 'Docs: '
-labels:
- - 'template: documentation'
-body:
- - type: textarea
- attributes:
- label: What is the improvement or update you wish to see?
- description: 'Example: I would like to see more examples of how to use hooks.'
- validations:
- required: true
- - type: textarea
- attributes:
- label: Is there any context that might help us understand?
- description: A clear description of any added context that might help us understand.
- validations:
- required: true
\ No newline at end of file
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
deleted file mode 100644
index dcefd31c5e..0000000000
--- a/.github/ISSUE_TEMPLATE/config.yml
+++ /dev/null
@@ -1,5 +0,0 @@
-blank_issues_enabled: false
-contact_links:
- - name: Ask a question
- url: https://github.com/vercel/commerce/discussions
- about: Ask questions and discuss with other community members
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
new file mode 100644
index 0000000000..b18fd29357
--- /dev/null
+++ b/.github/dependabot.yml
@@ -0,0 +1,6 @@
+version: 2
+updates:
+ - package-ecosystem: 'github-actions'
+ directory: '/'
+ schedule:
+ interval: 'weekly'
diff --git a/.github/workflows/e2e.yml b/.github/workflows/e2e.yml
new file mode 100644
index 0000000000..a52b961a23
--- /dev/null
+++ b/.github/workflows/e2e.yml
@@ -0,0 +1,49 @@
+name: e2e
+on:
+ schedule:
+ # Runs "at 09:00 and 15:00, Monday through Friday" (see https://crontab.guru)
+ - cron: '0 9,15 * * 1-5'
+jobs:
+ e2e:
+ runs-on: ubuntu-latest
+ steps:
+ - name: Cancel running workflows
+ uses: styfle/cancel-workflow-action@0.11.0
+ with:
+ access_token: ${{ github.token }}
+ - name: Checkout repo
+ uses: actions/checkout@v3
+ - name: Set node version
+ uses: actions/setup-node@v3
+ with:
+ node-version-file: '.nvmrc'
+ - name: Set pnpm version
+ uses: pnpm/action-setup@v2
+ with:
+ run_install: false
+ version: 7
+ - name: Cache node_modules
+ id: node-modules-cache
+ uses: actions/cache@v3
+ with:
+ path: '**/node_modules'
+ key: node-modules-cache-${{ hashFiles('**/pnpm-lock.yaml') }}
+ - name: Install dependencies
+ if: steps.node-modules-cache.outputs.cache-hit != 'true'
+ run: pnpm install
+ - name: Get playwright version
+ run: echo "PLAYWRIGHT_VERSION=$(node -e "console.log(require('./node_modules/@playwright/test/package.json').version)")" >> $GITHUB_ENV
+ - name: Cache playwright
+ uses: actions/cache@v3
+ id: playwright-cache
+ with:
+ path: '~/.cache/ms-playwright'
+ key: playwright-cache-${{ env.PLAYWRIGHT_VERSION }}
+ - name: Install playwright browsers
+ if: steps.playwright-cache.outputs.cache-hit != 'true'
+ run: npx playwright install --with-deps
+ - name: Install playwright browser dependencies
+ if: steps.playwright-cache.outputs.cache-hit == 'true'
+ run: npx playwright install-deps
+ - name: Run tests
+ run: pnpm test:e2e
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
new file mode 100644
index 0000000000..f9d940bec4
--- /dev/null
+++ b/.github/workflows/test.yml
@@ -0,0 +1,32 @@
+name: test
+on: pull_request
+jobs:
+ test:
+ runs-on: ubuntu-latest
+ steps:
+ - name: Cancel running workflows
+ uses: styfle/cancel-workflow-action@0.11.0
+ with:
+ access_token: ${{ github.token }}
+ - name: Checkout repo
+ uses: actions/checkout@v3
+ - name: Set node version
+ uses: actions/setup-node@v3
+ with:
+ node-version-file: '.nvmrc'
+ - name: Set pnpm version
+ uses: pnpm/action-setup@v2
+ with:
+ run_install: false
+ version: 7
+ - name: Cache node_modules
+ id: node-modules-cache
+ uses: actions/cache@v3
+ with:
+ path: '**/node_modules'
+ key: node-modules-cache-${{ hashFiles('**/pnpm-lock.yaml') }}
+ - name: Install dependencies
+ if: steps.node-modules-cache.outputs.cache-hit != 'true'
+ run: pnpm install
+ - name: Run tests
+ run: pnpm test
diff --git a/.gitignore b/.gitignore
index 10295bcccf..0298027e4f 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,39 +1,38 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
# dependencies
-node_modules
-.pnp
+/node_modules
+/.pnp
.pnp.js
-.pnpm-debug.log
# testing
-coverage
+/coverage
+.playwright
# next.js
-.next
-out
+/.next/
+/out/
# production
-build
-dist
+/build
# misc
.DS_Store
*.pem
-.idea
# debug
npm-debug.log*
yarn-debug.log*
yarn-error.log*
+.pnpm-debug.log*
# local env files
-.env
-.env.local
-.env.development.local
-.env.test.local
-.env.production.local
+.env*
+!.env.example
# vercel
.vercel
-# Turborepo
-.turbo
+# typescript
+*.tsbuildinfo
+next-env.d.ts
diff --git a/.nvmrc b/.nvmrc
new file mode 100644
index 0000000000..b6a7d89c68
--- /dev/null
+++ b/.nvmrc
@@ -0,0 +1 @@
+16
diff --git a/.prettierignore b/.prettierignore
index 1c8b279ce8..71df57cbc4 100644
--- a/.prettierignore
+++ b/.prettierignore
@@ -1,5 +1,3 @@
-# Every package defines its prettier config
-node_modules
-dist
+.vercel
.next
-public
+pnpm-lock.yaml
diff --git a/.prettierrc b/.prettierrc
deleted file mode 100644
index e1076edfa8..0000000000
--- a/.prettierrc
+++ /dev/null
@@ -1,6 +0,0 @@
-{
- "semi": false,
- "singleQuote": true,
- "tabWidth": 2,
- "useTabs": false
-}
diff --git a/.vscode/extensions.json b/.vscode/extensions.json
deleted file mode 100644
index 60907f7fdd..0000000000
--- a/.vscode/extensions.json
+++ /dev/null
@@ -1,8 +0,0 @@
-{
- "recommendations": [
- "esbenp.prettier-vscode",
- "csstools.postcss",
- "bradlc.vscode-tailwindcss",
- "ms-vscode.vscode-typescript-next"
- ]
-}
diff --git a/.vscode/launch.json b/.vscode/launch.json
new file mode 100644
index 0000000000..448434dd01
--- /dev/null
+++ b/.vscode/launch.json
@@ -0,0 +1,28 @@
+{
+ "version": "0.2.0",
+ "configurations": [
+ {
+ "name": "Next.js: debug server-side",
+ "type": "node-terminal",
+ "request": "launch",
+ "command": "pnpm dev"
+ },
+ {
+ "name": "Next.js: debug client-side",
+ "type": "chrome",
+ "request": "launch",
+ "url": "http://localhost:3000"
+ },
+ {
+ "name": "Next.js: debug full stack",
+ "type": "node-terminal",
+ "request": "launch",
+ "command": "pnpm dev",
+ "serverReadyAction": {
+ "pattern": "started server on .+, url: (https?://.+)",
+ "uriFormat": "%s",
+ "action": "debugWithChrome"
+ }
+ }
+ ]
+}
diff --git a/.vscode/settings.json b/.vscode/settings.json
index 9bf4d12b52..3ffeeffd70 100644
--- a/.vscode/settings.json
+++ b/.vscode/settings.json
@@ -1,4 +1,9 @@
{
- "editor.defaultFormatter": "esbenp.prettier-vscode",
- "editor.formatOnSave": true
+ "typescript.tsdk": "node_modules/.pnpm/typescript@4.9.5/node_modules/typescript/lib",
+ "typescript.enablePromptUseWorkspaceTsdk": true,
+ "editor.codeActionsOnSave": {
+ "source.fixAll": true,
+ "source.organizeImports": true,
+ "source.sortMembers": true
+ }
}
diff --git a/README.md b/README.md
index 2bb8b55252..8a8fa68a69 100644
--- a/README.md
+++ b/README.md
@@ -1,199 +1,31 @@
-[](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fvercel%2Fcommerce&project-name=commerce&repo-name=commerce&demo-title=Next.js%20Commerce&demo-description=An%20all-in-one%20starter%20kit%20for%20high-performance%20e-commerce%20sites.&demo-url=https%3A%2F%2Fdemo.vercel.store&demo-image=https%3A%2F%2Fbigcommerce-demo-asset-ksvtgfvnd.vercel.app%2Fbigcommerce.png&integration-ids=oac_MuWZiE4jtmQ2ejZQaQ7ncuDT,oac_9HSKtXld74NG0srzdxSiBGty&skippable-integrations=1&root-directory=site&build-command=cd%20..%20%26%26%20yarn%20build)
+[](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fvercel%2Fcommerce&project-name=commerce&repo-name=commerce&demo-title=Next.js%20Commerce&demo-url=https%3A%2F%2Fdemo.vercel.store&demo-image=https%3A%2F%2Fbigcommerce-demo-asset-ksvtgfvnd.vercel.app%2Fbigcommerce.png&env=SHOPIFY_STOREFRONT_ACCESS_TOKEN,SHOPIFY_STORE_DOMAIN,SHOPIFY_REVALIDATION_TOKEN)
# Next.js Commerce
-The all-in-one starter kit for high-performance e-commerce sites. With a few clicks, Next.js developers can clone, deploy and fully customize their own store.
-Start right now at [nextjs.org/commerce](https://nextjs.org/commerce)
+Next.js 13 and App Router-ready ecommerce template, built with Shopify and Tailwind CSS.
-Demo live at: [demo.vercel.store](https://demo.vercel.store/)
+We will be shortly updating the demo at [demo.vercel.store](https://demo.vercel.store/) with this new version.
-- Shopify Demo: https://shopify.vercel.store/
-- Swell Demo: https://swell.vercel.store/
-- BigCommerce Demo: https://bigcommerce.vercel.store/
-- Vendure Demo: https://vendure.vercel.store
-- Saleor Demo: https://saleor.vercel.store/
-- Ordercloud Demo: https://ordercloud.vercel.store/
-- Spree Demo: https://spree.vercel.store/
-- Kibo Commerce Demo: https://kibocommerce.vercel.store/
-- Commerce.js Demo: https://commercejs.vercel.store/
-- SalesForce Cloud Commerce Demo: https://salesforce-cloud-commerce.vercel.store/
-
-## Run minimal version locally
-
-> To run a minimal version of Next.js Commerce you can start with the default local provider `@vercel/commerce-local` that has all features disabled (cart, auth) and uses static files for the backend
-
-```bash
-pnpm install & pnpm build # run these commands in the root folder of the mono repo
-pnpm dev # run this command in the site folder
-```
-
-> If you encounter any problems while installing and running for the first time, please see the Troubleshoot section
+Looking for Next.js Commerce v1? [View the release notes](https://github.com/vercel/commerce/releases/tag/v1).
## Features
-- Performant by default
-- SEO Ready
-- Internationalization
-- Responsive
-- UI Components
-- Theming
-- Standardized Data Hooks
-- Integrations - Integrate seamlessly with the most common ecommerce platforms.
-- Dark Mode Support
-
-## Integrations
-
-Next.js Commerce integrates out-of-the-box with BigCommerce, Shopify, Swell, Saleor, Vendure, Spree and Commerce.js. We plan to support all major ecommerce backends.
-
-## Considerations
-
-- `packages/commerce` contains all types, helpers and functions to be used as a base to build a new **provider**.
-- **Providers** live under `packages`'s root folder and they will extend Next.js Commerce types and functionality (`packages/commerce`).
-- We have a **Features API** to ensure feature parity between the UI and the Provider. The UI should update accordingly and no extra code should be bundled. All extra configuration for features will live under `features` in `commerce.config.json` and if needed it can also be accessed programmatically.
-- Each **provider** should add its corresponding `next.config.js` and `commerce.config.json` adding specific data related to the provider. For example in the case of BigCommerce, the images CDN and additional API routes.
-
-## Configuration
-
-### How to change providers
-
-Open `site/.env.local` and change the value of `COMMERCE_PROVIDER` to the provider you would like to use, then set the environment variables for that provider (use `site/.env.template` as the base).
-
-The setup for Shopify would look like this for example:
-
-```
-COMMERCE_PROVIDER=@vercel/commerce-shopify
-NEXT_PUBLIC_SHOPIFY_STOREFRONT_ACCESS_TOKEN=xxxxxxxxxxxxxxxxxxxxxxxxxxxx
-NEXT_PUBLIC_SHOPIFY_STORE_DOMAIN=xxxxxxx.myshopify.com
-```
-
-### Features
-
-Every provider defines the features that it supports under `packages/{provider}/src/commerce.config.json`
-
-#### Features Available
-
-The following features can be enabled or disabled. This means that the UI will remove all code related to the feature.
-For example: turning `cart` off will disable Cart capabilities.
-
-- cart
-- search
-- wishlist
-- customerAuth
-- customCheckout
+- Next.js App Router
+- Optimized for SEO
+- Styling with Tailwind CSS
+- Checkout/Cart with Shopify
+- Themeing with System (Light/Dark Mode) Support
-#### How to turn Features on and off
-
-> NOTE: The selected provider should support the feature that you are toggling. (This means that you can't turn wishlist on if the provider doesn't support this functionality out of the box)
-
-- Open `site/commerce.config.json`
-- You'll see a config file like this:
- ```json
- {
- "features": {
- "wishlist": false,
- "customCheckout": true
- }
- }
- ```
-- Turn `wishlist` on by setting `wishlist` to `true`.
-- Run the app and the wishlist functionality should be back on.
-
-### How to create a new provider
-
-Follow our docs for [Adding a new Commerce Provider](packages/commerce/new-provider.md).
-
-If you succeeded building a provider, submit a PR with a valid demo and we'll review it asap.
-
-## Contribute
-
-Our commitment to Open Source can be found [here](https://vercel.com/oss).
-
-1. [Fork](https://help.github.com/articles/fork-a-repo/) this repository to your own GitHub account and then [clone](https://help.github.com/articles/cloning-a-repository/) it to your local device.
-2. Create a new branch `git checkout -b MY_BRANCH_NAME`
-3. Install the dependencies: `pnpm install`
-4. Build the packages: `pnpm build`
-5. Duplicate `site/.env.template` and rename it to `site/.env.local`
-6. Add proper store values to `site/.env.local`
-7. Run `cd site` & `pnpm dev` to watch for code changes
-8. Run `pnpm turbo run build` to check the build after your changes
-
-## Work in progress
-
-We're using Github Projects to keep track of issues in progress and todo's. Here is our [Board](https://github.com/vercel/commerce/projects/1)
-
-People actively working on this project: @okbel, @lfades, @dominiksipowicz, @gbibeaul.
-
-## Troubleshoot
-
-
-I already own a BigCommerce store. What should I do?
-
-First thing you do is: set your environment variables
-
-
-.env.local
-
-```sh
-BIGCOMMERCE_STOREFRONT_API_URL=<>
-BIGCOMMERCE_STOREFRONT_API_TOKEN=<>
-BIGCOMMERCE_STORE_API_URL=<>
-BIGCOMMERCE_STORE_API_TOKEN=<>
-BIGCOMMERCE_STORE_API_CLIENT_ID=<>
-BIGCOMMERCE_CHANNEL_ID=<>
-```
-
-If your project was started with a "Deploy with Vercel" button, you can use Vercel's CLI to retrieve these credentials.
+## Running Locally
1. Install Vercel CLI: `npm i -g vercel`
2. Link local instance with Vercel and Github accounts (creates .vercel file): `vercel link`
3. Download your environment variables: `vercel env pull .env.local`
-Next, you're free to customize the starter. More updates coming soon. Stay tuned..
-
-
-
-
-BigCommerce shows a Coming Soon page and requests a Preview Code
-
-After Email confirmation, Checkout should be manually enabled through BigCommerce platform. Look for "Review & test your store" section through BigCommerce's dashboard.
-
-
-BigCommerce team has been notified and they plan to add more details about this subject.
-
-
-
-When run locally I get `Error: Cannot find module '...@vercel/commerce/dist/config'`
```bash
-commerce/site
-❯ yarn dev
-yarn run v1.22.17
-$ next dev
-ready - started server on 0.0.0.0:3000, url: http://localhost:3000
-info - Loaded env from /commerce/site/.env.local
-error - Failed to load next.config.js, see more info here https://nextjs.org/docs/messages/next-config-error
-Error: Cannot find module '/Users/dom/work/vercel/commerce/node_modules/@vercel/commerce/dist/config.cjs'
- at createEsmNotFoundErr (node:internal/modules/cjs/loader:960:15)
- at finalizeEsmResolution (node:internal/modules/cjs/loader:953:15)
- at resolveExports (node:internal/modules/cjs/loader:482:14)
- at Function.Module._findPath (node:internal/modules/cjs/loader:522:31)
- at Function.Module._resolveFilename (node:internal/modules/cjs/loader:919:27)
- at Function.mod._resolveFilename (/Users/dom/work/vercel/commerce/node_modules/next/dist/build/webpack/require-hook.js:179:28)
- at Function.Module._load (node:internal/modules/cjs/loader:778:27)
- at Module.require (node:internal/modules/cjs/loader:1005:19)
- at require (node:internal/modules/cjs/helpers:102:18)
- at Object. (/Users/dom/work/vercel/commerce/site/commerce-config.js:9:14) {
- code: 'MODULE_NOT_FOUND',
- path: '/Users/dom/work/vercel/commerce/node_modules/@vercel/commerce/package.json'
-}
-error Command failed with exit code 1.
-info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.
+pnpm install
+pnpm dev
```
-The error usually occurs when running `pnpm dev` inside of the `/site/` folder after installing a fresh repository.
-
-In order to fix this, run `pnpm build` in the monorepo root folder first.
-
-> Using `pnpm dev` from the root is recommended for developing, which will run watch mode on all packages.
-
-
+Your app should now be running on [localhost:3000](http://localhost:3000/).
diff --git a/app/[page]/layout.tsx b/app/[page]/layout.tsx
new file mode 100644
index 0000000000..3339a5b1ad
--- /dev/null
+++ b/app/[page]/layout.tsx
@@ -0,0 +1,16 @@
+import Footer from 'components/layout/footer';
+import { Suspense } from 'react';
+
+export default function Layout({ children }: { children: React.ReactNode }) {
+ return (
+
+
+ );
+}
diff --git a/components/product/variant-selector.tsx b/components/product/variant-selector.tsx
new file mode 100644
index 0000000000..520818516f
--- /dev/null
+++ b/components/product/variant-selector.tsx
@@ -0,0 +1,135 @@
+'use client';
+
+import clsx from 'clsx';
+import { ProductOption, ProductVariant } from 'lib/shopify/types';
+import { createUrl } from 'lib/utils';
+import Link from 'next/link';
+import { usePathname, useRouter, useSearchParams } from 'next/navigation';
+
+type ParamsMap = {
+ [key: string]: string; // ie. { color: 'Red', size: 'Large', ... }
+};
+
+type OptimizedVariant = {
+ id: string;
+ availableForSale: boolean;
+ params: URLSearchParams;
+ [key: string]: string | boolean | URLSearchParams; // ie. { color: 'Red', size: 'Large', ... }
+};
+
+export function VariantSelector({
+ options,
+ variants
+}: {
+ options: ProductOption[];
+ variants: ProductVariant[];
+}) {
+ const pathname = usePathname();
+ const currentParams = useSearchParams();
+ const router = useRouter();
+ const hasNoOptionsOrJustOneOption =
+ !options.length || (options.length === 1 && options[0]?.values.length === 1);
+
+ if (hasNoOptionsOrJustOneOption) {
+ return null;
+ }
+
+ // Discard any unexpected options or values from url and create params map.
+ const paramsMap: ParamsMap = Object.fromEntries(
+ Array.from(currentParams.entries()).filter(([key, value]) =>
+ options.find((option) => option.name.toLowerCase() === key && option.values.includes(value))
+ )
+ );
+
+ // Optimize variants for easier lookups.
+ const optimizedVariants: OptimizedVariant[] = variants.map((variant) => {
+ const optimized: OptimizedVariant = {
+ id: variant.id,
+ availableForSale: variant.availableForSale,
+ params: new URLSearchParams()
+ };
+
+ variant.selectedOptions.forEach((selectedOption) => {
+ const name = selectedOption.name.toLowerCase();
+ const value = selectedOption.value;
+
+ optimized[name] = value;
+ optimized.params.set(name, value);
+ });
+
+ return optimized;
+ });
+
+ // Find the first variant that is:
+ //
+ // 1. Available for sale
+ // 2. Matches all options specified in the url (note that this
+ // could be a partial match if some options are missing from the url).
+ //
+ // If no match (full or partial) is found, use the first variant that is
+ // available for sale.
+ const selectedVariant: OptimizedVariant | undefined =
+ optimizedVariants.find(
+ (variant) =>
+ variant.availableForSale &&
+ Object.entries(paramsMap).every(([key, value]) => variant[key] === value)
+ ) || optimizedVariants.find((variant) => variant.availableForSale);
+
+ const selectedVariantParams = new URLSearchParams(selectedVariant?.params);
+ const currentUrl = createUrl(pathname, currentParams);
+ const selectedVariantUrl = createUrl(pathname, selectedVariantParams);
+
+ if (currentUrl !== selectedVariantUrl) {
+ router.replace(selectedVariantUrl);
+ }
+
+ return options.map((option) => (
+
+
{option.name}
+
+ {option.values.map((value) => {
+ // Base option params on selected variant params.
+ const optionParams = new URLSearchParams(selectedVariantParams);
+ // Update the params using the current option to reflect how the url would change.
+ optionParams.set(option.name.toLowerCase(), value);
+
+ const optionUrl = createUrl(pathname, optionParams);
+
+ // The option is active if it in the url params.
+ const isActive = selectedVariantParams.get(option.name.toLowerCase()) === value;
+
+ // The option is available for sale if it fully matches the variant in the option's url params.
+ // It's super important to note that this is the options params, *not* the selected variant's params.
+ // This is the "magic" that will cross check possible future variant combinations and preemptively
+ // disable combinations that are not possible.
+ const isAvailableForSale = optimizedVariants.find((a) =>
+ Array.from(optionParams.entries()).every(([key, value]) => a[key] === value)
+ )?.availableForSale;
+
+ const DynamicTag = isAvailableForSale ? Link : 'p';
+
+ return (
+
+ {value}
+
+ );
+ })}
+
+
+ ));
+}
diff --git a/components/prose.tsx b/components/prose.tsx
new file mode 100644
index 0000000000..2445ee588a
--- /dev/null
+++ b/components/prose.tsx
@@ -0,0 +1,21 @@
+import clsx from 'clsx';
+import type { FunctionComponent } from 'react';
+
+interface TextProps {
+ html: string;
+ className?: string;
+}
+
+const Prose: FunctionComponent = ({ html, className }) => {
+ return (
+
+ );
+};
+
+export default Prose;
diff --git a/e2e/cart.spec.ts b/e2e/cart.spec.ts
new file mode 100644
index 0000000000..f7775ac1cc
--- /dev/null
+++ b/e2e/cart.spec.ts
@@ -0,0 +1,73 @@
+import { test, expect } from '@playwright/test';
+
+const regex = (text: string) => new RegExp(text, 'gim');
+
+test('should be able to open and close cart', async ({ page }) => {
+ let cart;
+
+ await page.goto('/');
+
+ await page.getByTestId('open-cart').click();
+ cart = await page.getByTestId('cart');
+ await expect(cart).toBeVisible();
+ await expect(cart).toHaveText(regex('your cart is empty'));
+
+ await page.getByTestId('close-cart').click();
+ cart = await page.getByTestId('cart');
+ await expect(cart).toBeHidden();
+});
+
+test('should be able to add item to cart, without selecting a variant, assuming first variant', async ({
+ page
+}) => {
+ await page.goto('/');
+ await page.getByTestId('homepage-products').locator('a').first().click();
+
+ const productName = await page.getByTestId('product-name').first().innerText();
+ const firstVariant = await page.getByTestId('variant').first().innerText();
+
+ await page.getByRole('button', { name: regex('add to cart') }).click();
+
+ const cart = await page.getByTestId('cart');
+
+ await expect(cart).toBeVisible();
+
+ const cartItems = await page.getByTestId('cart-item').all();
+ let isItemInCart = false;
+
+ for (const item of cartItems) {
+ const cartProductName = await item.getByTestId('cart-product-name').innerText();
+ const cartProductVariant = await item.getByTestId('cart-product-variant').innerText();
+
+ if (cartProductName === productName && cartProductVariant === firstVariant) {
+ isItemInCart = true;
+ break;
+ }
+ }
+
+ await expect(isItemInCart).toBe(true);
+});
+
+test('should be able to add item to cart by selecting a variant', async ({ page }) => {
+ await page.goto('/');
+ await page.getByTestId('homepage-products').locator('a').first().click();
+
+ const selectedProductName = await page.getByTestId('product-name').first().innerText();
+ const secondVariant = await page.getByTestId('variant').nth(1);
+
+ await secondVariant.click();
+ const selectedProductVariant = await page.getByTestId('selected-variant').innerText();
+
+ await page.getByRole('button', { name: regex('add to cart') }).click();
+
+ const cart = await page.getByTestId('cart');
+
+ await expect(cart).toBeVisible();
+
+ const cartItem = await page.getByTestId('cart-item').first();
+ const cartItemProductName = await cartItem.getByTestId('cart-product-name').innerText();
+ const cartItemProductVariant = await cartItem.getByTestId('cart-product-variant').innerText();
+
+ await expect(cartItemProductName).toBe(selectedProductName);
+ await expect(cartItemProductVariant).toBe(selectedProductVariant);
+});
diff --git a/e2e/mobile-menu.spec.ts b/e2e/mobile-menu.spec.ts
new file mode 100644
index 0000000000..0765f4d19b
--- /dev/null
+++ b/e2e/mobile-menu.spec.ts
@@ -0,0 +1,16 @@
+import { test, expect } from '@playwright/test';
+
+test.use({ viewport: { width: 600, height: 900 } });
+test('should be able to open and close mobile menu', async ({ page }) => {
+ let mobileMenu;
+
+ await page.goto('/');
+
+ await page.getByTestId('open-mobile-menu').click();
+ mobileMenu = await page.getByTestId('mobile-menu');
+ await expect(mobileMenu).toBeVisible();
+
+ await page.getByTestId('close-mobile-menu').click();
+ mobileMenu = await page.getByTestId('mobile-menu');
+ await expect(mobileMenu).toBeHidden();
+});
diff --git a/lib/constants.tsx b/lib/constants.tsx
new file mode 100644
index 0000000000..b76bf19aa6
--- /dev/null
+++ b/lib/constants.tsx
@@ -0,0 +1,28 @@
+export type SortFilterItem = {
+ title: string;
+ slug: string | null;
+ sortKey: 'RELEVANCE' | 'BEST_SELLING' | 'CREATED_AT' | 'PRICE';
+ reverse: boolean;
+};
+
+export const defaultSort: SortFilterItem = {
+ title: 'Relevance',
+ slug: null,
+ sortKey: 'RELEVANCE',
+ reverse: false
+};
+
+export const sorting: SortFilterItem[] = [
+ defaultSort,
+ { title: 'Trending', slug: 'trending-desc', sortKey: 'BEST_SELLING', reverse: false }, // asc
+ { title: 'Latest arrivals', slug: 'latest-desc', sortKey: 'CREATED_AT', reverse: true },
+ { title: 'Price: Low to high', slug: 'price-asc', sortKey: 'PRICE', reverse: false }, // asc
+ { title: 'Price: High to low', slug: 'price-desc', sortKey: 'PRICE', reverse: true }
+];
+
+export const HIDDEN_PRODUCT_TAG = 'nextjs-frontend-hidden';
+export const DEFAULT_OPTION = 'Default Title';
+export const SITE_NAME = 'Vercel Store';
+export const SITE_CREATOR = '@vercel';
+export const SITE_CREATOR_URL = 'https://vercel.com';
+export const SHOPIFY_GRAPHQL_API_ENDPOINT = '/api/2023-01/graphql.json';
diff --git a/lib/shopify/fragments/cart.ts b/lib/shopify/fragments/cart.ts
new file mode 100644
index 0000000000..c072160c71
--- /dev/null
+++ b/lib/shopify/fragments/cart.ts
@@ -0,0 +1,49 @@
+import productFragment from './product';
+
+const cartFragment = /* GraphQL */ `
+ fragment cart on Cart {
+ id
+ checkoutUrl
+ cost {
+ subtotalAmount {
+ amount
+ currencyCode
+ }
+ totalAmount {
+ amount
+ currencyCode
+ }
+ totalTaxAmount {
+ amount
+ currencyCode
+ }
+ }
+ lines(first: 100) {
+ edges {
+ node {
+ id
+ quantity
+ cost {
+ totalAmount {
+ amount
+ currencyCode
+ }
+ }
+ merchandise {
+ ... on ProductVariant {
+ id
+ title
+ product {
+ ...product
+ }
+ }
+ }
+ }
+ }
+ }
+ totalQuantity
+ }
+ ${productFragment}
+`;
+
+export default cartFragment;
diff --git a/lib/shopify/fragments/image.ts b/lib/shopify/fragments/image.ts
new file mode 100644
index 0000000000..5d002f1756
--- /dev/null
+++ b/lib/shopify/fragments/image.ts
@@ -0,0 +1,10 @@
+const imageFragment = /* GraphQL */ `
+ fragment image on Image {
+ url
+ altText
+ width
+ height
+ }
+`;
+
+export default imageFragment;
diff --git a/lib/shopify/fragments/product.ts b/lib/shopify/fragments/product.ts
new file mode 100644
index 0000000000..b66ef05e71
--- /dev/null
+++ b/lib/shopify/fragments/product.ts
@@ -0,0 +1,63 @@
+import imageFragment from './image';
+import seoFragment from './seo';
+
+const productFragment = /* GraphQL */ `
+ fragment product on Product {
+ id
+ handle
+ availableForSale
+ title
+ description
+ descriptionHtml
+ options {
+ id
+ name
+ values
+ }
+ priceRange {
+ maxVariantPrice {
+ amount
+ currencyCode
+ }
+ minVariantPrice {
+ amount
+ currencyCode
+ }
+ }
+ variants(first: 250) {
+ edges {
+ node {
+ id
+ title
+ availableForSale
+ selectedOptions {
+ name
+ value
+ }
+ price {
+ amount
+ currencyCode
+ }
+ }
+ }
+ }
+ featuredImage {
+ ...image
+ }
+ images(first: 20) {
+ edges {
+ node {
+ ...image
+ }
+ }
+ }
+ seo {
+ ...seo
+ }
+ tags
+ }
+ ${imageFragment}
+ ${seoFragment}
+`;
+
+export default productFragment;
diff --git a/lib/shopify/fragments/seo.ts b/lib/shopify/fragments/seo.ts
new file mode 100644
index 0000000000..2d4786c4ff
--- /dev/null
+++ b/lib/shopify/fragments/seo.ts
@@ -0,0 +1,8 @@
+const seoFragment = /* GraphQL */ `
+ fragment seo on SEO {
+ description
+ title
+ }
+`;
+
+export default seoFragment;
diff --git a/lib/shopify/index.ts b/lib/shopify/index.ts
new file mode 100644
index 0000000000..49655aa9e7
--- /dev/null
+++ b/lib/shopify/index.ts
@@ -0,0 +1,361 @@
+import { HIDDEN_PRODUCT_TAG, SHOPIFY_GRAPHQL_API_ENDPOINT } from 'lib/constants';
+import { isShopifyError } from 'lib/type-guards';
+import {
+ addToCartMutation,
+ createCartMutation,
+ editCartItemsMutation,
+ removeFromCartMutation
+} from './mutations/cart';
+import { getCartQuery } from './queries/cart';
+import {
+ getCollectionProductsQuery,
+ getCollectionQuery,
+ getCollectionsQuery
+} from './queries/collection';
+import { getMenuQuery } from './queries/menu';
+import { getPageQuery } from './queries/page';
+import {
+ getProductQuery,
+ getProductRecommendationsQuery,
+ getProductsQuery
+} from './queries/product';
+import {
+ Cart,
+ Collection,
+ Connection,
+ Menu,
+ Page,
+ Product,
+ ShopifyAddToCartOperation,
+ ShopifyCart,
+ ShopifyCartOperation,
+ ShopifyCollection,
+ ShopifyCollectionOperation,
+ ShopifyCollectionProductsOperation,
+ ShopifyCollectionsOperation,
+ ShopifyCreateCartOperation,
+ ShopifyMenuOperation,
+ ShopifyPageOperation,
+ ShopifyProduct,
+ ShopifyProductOperation,
+ ShopifyProductRecommendationsOperation,
+ ShopifyProductsOperation,
+ ShopifyRemoveFromCartOperation,
+ ShopifyUpdateCartOperation
+} from './types';
+
+const domain = process.env.SHOPIFY_STORE_DOMAIN!;
+const endpoint = process.env.SHOPIFY_STORE_DOMAIN! + SHOPIFY_GRAPHQL_API_ENDPOINT;
+const key = process.env.SHOPIFY_STOREFRONT_ACCESS_TOKEN!;
+
+type ExtractVariables = T extends { variables: object } ? T['variables'] : never;
+
+export async function shopifyFetch({
+ query,
+ variables,
+ headers,
+ cache = 'force-cache'
+}: {
+ query: string;
+ variables?: ExtractVariables;
+ headers?: HeadersInit;
+ cache?: RequestCache;
+}): Promise<{ status: number; body: T } | never> {
+ try {
+ const result = await fetch(endpoint, {
+ method: 'POST',
+ headers: {
+ 'Content-Type': 'application/json',
+ 'X-Shopify-Storefront-Access-Token': key,
+ ...headers
+ },
+ body: JSON.stringify({
+ ...(query && { query }),
+ ...(variables && { variables })
+ }),
+ cache,
+ next: { revalidate: 900 } // 15 minutes
+ });
+
+ const body = await result.json();
+
+ if (body.errors) {
+ throw body.errors[0];
+ }
+
+ return {
+ status: result.status,
+ body
+ };
+ } catch (e) {
+ if (isShopifyError(e)) {
+ throw {
+ status: e.status || 500,
+ message: e.message,
+ query
+ };
+ }
+
+ throw {
+ error: e,
+ query
+ };
+ }
+}
+
+const removeEdgesAndNodes = (array: Connection) => {
+ return array.edges.map((edge) => edge?.node);
+};
+
+const reshapeCart = (cart: ShopifyCart): Cart => {
+ if (!cart.cost?.totalTaxAmount) {
+ cart.cost.totalTaxAmount = {
+ amount: '0.0',
+ currencyCode: 'USD'
+ };
+ }
+
+ return {
+ ...cart,
+ lines: removeEdgesAndNodes(cart.lines)
+ };
+};
+
+const reshapeCollection = (collection: ShopifyCollection): Collection | undefined => {
+ if (!collection) {
+ return undefined;
+ }
+
+ return {
+ ...collection,
+ path: `/search/${collection.handle}`
+ };
+};
+
+const reshapeCollections = (collections: ShopifyCollection[]) => {
+ const reshapedCollections = [];
+
+ for (const collection of collections) {
+ if (collection) {
+ const reshapedCollection = reshapeCollection(collection);
+
+ if (reshapedCollection) {
+ reshapedCollections.push(reshapedCollection);
+ }
+ }
+ }
+
+ return reshapedCollections;
+};
+
+const reshapeProduct = (product: ShopifyProduct, filterHiddenProducts: boolean = true) => {
+ if (!product || (filterHiddenProducts && product.tags.includes(HIDDEN_PRODUCT_TAG))) {
+ return undefined;
+ }
+
+ const { images, variants, ...rest } = product;
+
+ return {
+ ...rest,
+ images: removeEdgesAndNodes(images),
+ variants: removeEdgesAndNodes(variants)
+ };
+};
+
+const reshapeProducts = (products: ShopifyProduct[]) => {
+ const reshapedProducts = [];
+
+ for (const product of products) {
+ if (product) {
+ const reshapedProduct = reshapeProduct(product);
+
+ if (reshapedProduct) {
+ reshapedProducts.push(reshapedProduct);
+ }
+ }
+ }
+
+ return reshapedProducts;
+};
+
+export async function createCart(): Promise {
+ const res = await shopifyFetch({
+ query: createCartMutation,
+ cache: 'no-store'
+ });
+
+ return reshapeCart(res.body.data.cartCreate.cart);
+}
+
+export async function addToCart(
+ cartId: string,
+ lines: { merchandiseId: string; quantity: number }[]
+): Promise {
+ const res = await shopifyFetch({
+ query: addToCartMutation,
+ variables: {
+ cartId,
+ lines
+ },
+ cache: 'no-store'
+ });
+ return reshapeCart(res.body.data.cartLinesAdd.cart);
+}
+
+export async function removeFromCart(cartId: string, lineIds: string[]): Promise {
+ const res = await shopifyFetch({
+ query: removeFromCartMutation,
+ variables: {
+ cartId,
+ lineIds
+ },
+ cache: 'no-store'
+ });
+
+ return reshapeCart(res.body.data.cartLinesRemove.cart);
+}
+
+export async function updateCart(
+ cartId: string,
+ lines: { id: string; merchandiseId: string; quantity: number }[]
+): Promise {
+ const res = await shopifyFetch({
+ query: editCartItemsMutation,
+ variables: {
+ cartId,
+ lines
+ },
+ cache: 'no-store'
+ });
+
+ return reshapeCart(res.body.data.cartLinesUpdate.cart);
+}
+
+export async function getCart(cartId: string): Promise {
+ const res = await shopifyFetch({
+ query: getCartQuery,
+ variables: { cartId },
+ cache: 'no-store'
+ });
+
+ if (!res.body.data.cart) {
+ return null;
+ }
+
+ return reshapeCart(res.body.data.cart);
+}
+
+export async function getCollection(handle: string): Promise {
+ const res = await shopifyFetch({
+ query: getCollectionQuery,
+ variables: {
+ handle
+ }
+ });
+
+ return reshapeCollection(res.body.data.collection);
+}
+
+export async function getCollectionProducts(handle: string, limit?: number): Promise {
+ const res = await shopifyFetch({
+ query: getCollectionProductsQuery,
+ variables: {
+ handle,
+ first: limit
+ }
+ });
+
+ return reshapeProducts(removeEdgesAndNodes(res.body.data.collection.products));
+}
+
+export async function getCollections(): Promise {
+ const res = await shopifyFetch({ query: getCollectionsQuery });
+ const shopifyCollections = removeEdgesAndNodes(res.body?.data?.collections);
+ const collections = [
+ {
+ handle: '',
+ title: 'All',
+ description: 'All products',
+ seo: {
+ title: 'All',
+ description: 'All products'
+ },
+ path: '/search'
+ },
+ // Filter out the `hidden` collections.
+ // Collections that start with `hidden-*` need to be hidden on the search page.
+ ...reshapeCollections(shopifyCollections).filter(
+ (collection) => !collection.handle.startsWith('hidden')
+ )
+ ];
+
+ return collections;
+}
+
+export async function getMenu(handle: string): Promise {
+ const res = await shopifyFetch({
+ query: getMenuQuery,
+ variables: {
+ handle
+ }
+ });
+
+ return (
+ res.body?.data?.menu?.items.map((item: { title: string; url: string }) => ({
+ title: item.title,
+ path: item.url.replace(domain, '').replace('/collections', '/search').replace('/pages', '')
+ })) || []
+ );
+}
+
+export async function getPage(handle: string): Promise {
+ const res = await shopifyFetch({
+ query: getPageQuery,
+ variables: { handle }
+ });
+
+ return res.body.data.pageByHandle;
+}
+
+export async function getProduct(handle: string): Promise {
+ const res = await shopifyFetch({
+ query: getProductQuery,
+ variables: {
+ handle
+ }
+ });
+
+ return reshapeProduct(res.body.data.product, false);
+}
+
+export async function getProductRecommendations(productId: string): Promise {
+ const res = await shopifyFetch({
+ query: getProductRecommendationsQuery,
+ variables: {
+ productId
+ }
+ });
+
+ return reshapeProducts(res.body.data.productRecommendations);
+}
+
+export async function getProducts({
+ query,
+ reverse,
+ sortKey
+}: {
+ query?: string;
+ reverse?: boolean;
+ sortKey?: string;
+}): Promise {
+ const res = await shopifyFetch({
+ query: getProductsQuery,
+ variables: {
+ query,
+ reverse,
+ sortKey
+ }
+ });
+
+ return reshapeProducts(removeEdgesAndNodes(res.body.data.products));
+}
diff --git a/lib/shopify/mutations/cart.ts b/lib/shopify/mutations/cart.ts
new file mode 100644
index 0000000000..4cc1b5ac68
--- /dev/null
+++ b/lib/shopify/mutations/cart.ts
@@ -0,0 +1,45 @@
+import cartFragment from '../fragments/cart';
+
+export const addToCartMutation = /* GraphQL */ `
+ mutation addToCart($cartId: ID!, $lines: [CartLineInput!]!) {
+ cartLinesAdd(cartId: $cartId, lines: $lines) {
+ cart {
+ ...cart
+ }
+ }
+ }
+ ${cartFragment}
+`;
+
+export const createCartMutation = /* GraphQL */ `
+ mutation createCart($lineItems: [CartLineInput!]) {
+ cartCreate(input: { lines: $lineItems }) {
+ cart {
+ ...cart
+ }
+ }
+ }
+ ${cartFragment}
+`;
+
+export const editCartItemsMutation = /* GraphQL */ `
+ mutation editCartItems($cartId: ID!, $lines: [CartLineUpdateInput!]!) {
+ cartLinesUpdate(cartId: $cartId, lines: $lines) {
+ cart {
+ ...cart
+ }
+ }
+ }
+ ${cartFragment}
+`;
+
+export const removeFromCartMutation = /* GraphQL */ `
+ mutation removeFromCart($cartId: ID!, $lineIds: [ID!]!) {
+ cartLinesRemove(cartId: $cartId, lineIds: $lineIds) {
+ cart {
+ ...cart
+ }
+ }
+ }
+ ${cartFragment}
+`;
diff --git a/lib/shopify/queries/cart.ts b/lib/shopify/queries/cart.ts
new file mode 100644
index 0000000000..044e47f668
--- /dev/null
+++ b/lib/shopify/queries/cart.ts
@@ -0,0 +1,10 @@
+import cartFragment from '../fragments/cart';
+
+export const getCartQuery = /* GraphQL */ `
+ query getCart($cartId: ID!) {
+ cart(id: $cartId) {
+ ...cart
+ }
+ }
+ ${cartFragment}
+`;
diff --git a/lib/shopify/queries/collection.ts b/lib/shopify/queries/collection.ts
new file mode 100644
index 0000000000..8df815992e
--- /dev/null
+++ b/lib/shopify/queries/collection.ts
@@ -0,0 +1,51 @@
+import productFragment from '../fragments/product';
+import seoFragment from '../fragments/seo';
+
+const collectionFragment = /* GraphQL */ `
+ fragment collection on Collection {
+ handle
+ title
+ description
+ seo {
+ ...seo
+ }
+ }
+ ${seoFragment}
+`;
+
+export const getCollectionQuery = /* GraphQL */ `
+ query getCollection($handle: String!) {
+ collection(handle: $handle) {
+ ...collection
+ }
+ }
+ ${collectionFragment}
+`;
+
+export const getCollectionsQuery = /* GraphQL */ `
+ query getCollections {
+ collections(first: 100, sortKey: TITLE) {
+ edges {
+ node {
+ ...collection
+ }
+ }
+ }
+ }
+ ${collectionFragment}
+`;
+
+export const getCollectionProductsQuery = /* GraphQL */ `
+ query getCollectionProducts($handle: String!, $first: Int = 100) {
+ collection(handle: $handle) {
+ products(first: $first) {
+ edges {
+ node {
+ ...product
+ }
+ }
+ }
+ }
+ }
+ ${productFragment}
+`;
diff --git a/lib/shopify/queries/menu.ts b/lib/shopify/queries/menu.ts
new file mode 100644
index 0000000000..d05b099496
--- /dev/null
+++ b/lib/shopify/queries/menu.ts
@@ -0,0 +1,10 @@
+export const getMenuQuery = /* GraphQL */ `
+ query getMenu($handle: String!) {
+ menu(handle: $handle) {
+ items {
+ title
+ url
+ }
+ }
+ }
+`;
diff --git a/lib/shopify/queries/page.ts b/lib/shopify/queries/page.ts
new file mode 100644
index 0000000000..34ec27d283
--- /dev/null
+++ b/lib/shopify/queries/page.ts
@@ -0,0 +1,21 @@
+import seoFragment from '../fragments/seo';
+
+export const getPageQuery = /* GraphQL */ `
+ query getPage($handle: String!) {
+ pageByHandle(handle: $handle) {
+ id
+ ... on Page {
+ title
+ handle
+ body
+ bodySummary
+ seo {
+ ...seo
+ }
+ createdAt
+ updatedAt
+ }
+ }
+ }
+ ${seoFragment}
+`;
diff --git a/lib/shopify/queries/product.ts b/lib/shopify/queries/product.ts
new file mode 100644
index 0000000000..d3f12bd0f7
--- /dev/null
+++ b/lib/shopify/queries/product.ts
@@ -0,0 +1,32 @@
+import productFragment from '../fragments/product';
+
+export const getProductQuery = /* GraphQL */ `
+ query getProduct($handle: String!) {
+ product(handle: $handle) {
+ ...product
+ }
+ }
+ ${productFragment}
+`;
+
+export const getProductsQuery = /* GraphQL */ `
+ query getProducts($sortKey: ProductSortKeys, $reverse: Boolean, $query: String) {
+ products(sortKey: $sortKey, reverse: $reverse, query: $query, first: 100) {
+ edges {
+ node {
+ ...product
+ }
+ }
+ }
+ }
+ ${productFragment}
+`;
+
+export const getProductRecommendationsQuery = /* GraphQL */ `
+ query getProductRecommendations($productId: ID!) {
+ productRecommendations(productId: $productId) {
+ ...product
+ }
+ }
+ ${productFragment}
+`;
diff --git a/lib/shopify/types.ts b/lib/shopify/types.ts
new file mode 100644
index 0000000000..e0e7d27d8c
--- /dev/null
+++ b/lib/shopify/types.ts
@@ -0,0 +1,258 @@
+export type Maybe = T | null;
+
+export type Connection = {
+ edges: Array>;
+};
+
+export type Edge = {
+ node: T;
+};
+
+export type Cart = Omit & {
+ lines: CartItem[];
+};
+
+export type CartItem = {
+ id: string;
+ quantity: number;
+ cost: {
+ totalAmount: Money;
+ };
+ merchandise: {
+ id: string;
+ title: string;
+ product: Product;
+ };
+};
+
+export type Collection = ShopifyCollection & {
+ path: string;
+};
+
+export type Image = {
+ url: string;
+ altText: string;
+ width: number;
+ height: number;
+};
+
+export type Menu = {
+ title: string;
+ path: string;
+};
+
+export type Money = {
+ amount: string;
+ currencyCode: string;
+};
+
+export type Page = {
+ id: string;
+ title: string;
+ handle: string;
+ body: string;
+ bodySummary: string;
+ seo?: SEO;
+ createdAt: string;
+ updatedAt: string;
+};
+
+export type Product = Omit & {
+ variants: ProductVariant[];
+ images: Image[];
+};
+
+export type ProductOption = {
+ id: string;
+ name: string;
+ values: string[];
+};
+
+export type ProductVariant = {
+ id: string;
+ title: string;
+ availableForSale: boolean;
+ selectedOptions: {
+ name: string;
+ value: string;
+ }[];
+ price: Money;
+};
+
+export type SEO = {
+ title: string;
+ description: string;
+};
+
+export type ShopifyCart = {
+ id: string;
+ checkoutUrl: string;
+ cost: {
+ subtotalAmount: Money;
+ totalAmount: Money;
+ totalTaxAmount: Money;
+ };
+ lines: Connection;
+ totalQuantity: number;
+};
+
+export type ShopifyCollection = {
+ handle: string;
+ title: string;
+ description: string;
+ seo: SEO;
+};
+
+export type ShopifyProduct = {
+ id: string;
+ handle: string;
+ availableForSale: boolean;
+ title: string;
+ description: string;
+ descriptionHtml: string;
+ options: ProductOption[];
+ priceRange: {
+ maxVariantPrice: Money;
+ minVariantPrice: Money;
+ };
+ variants: Connection;
+ featuredImage: Image;
+ images: Connection;
+ seo: SEO;
+ tags: string[];
+};
+
+export type ShopifyCartOperation = {
+ data: {
+ cart: ShopifyCart;
+ };
+ variables: {
+ cartId: string;
+ };
+};
+
+export type ShopifyCreateCartOperation = {
+ data: { cartCreate: { cart: ShopifyCart } };
+};
+
+export type ShopifyAddToCartOperation = {
+ data: {
+ cartLinesAdd: {
+ cart: ShopifyCart;
+ };
+ };
+ variables: {
+ cartId: string;
+ lines: {
+ merchandiseId: string;
+ quantity: number;
+ }[];
+ };
+};
+
+export type ShopifyRemoveFromCartOperation = {
+ data: {
+ cartLinesRemove: {
+ cart: ShopifyCart;
+ };
+ };
+ variables: {
+ cartId: string;
+ lineIds: string[];
+ };
+};
+
+export type ShopifyUpdateCartOperation = {
+ data: {
+ cartLinesUpdate: {
+ cart: ShopifyCart;
+ };
+ };
+ variables: {
+ cartId: string;
+ lines: {
+ id: string;
+ merchandiseId: string;
+ quantity: number;
+ }[];
+ };
+};
+
+export type ShopifyCollectionOperation = {
+ data: {
+ collection: ShopifyCollection;
+ };
+ variables: {
+ handle: string;
+ };
+};
+
+export type ShopifyCollectionProductsOperation = {
+ data: {
+ collection: {
+ products: Connection;
+ };
+ };
+ variables: {
+ handle: string;
+ first?: number;
+ };
+};
+
+export type ShopifyCollectionsOperation = {
+ data: {
+ collections: Connection;
+ };
+};
+
+export type ShopifyMenuOperation = {
+ data: {
+ menu?: {
+ items: {
+ title: string;
+ url: string;
+ }[];
+ };
+ };
+ variables: {
+ handle: string;
+ };
+};
+
+export type ShopifyPageOperation = {
+ data: { pageByHandle: Page };
+ variables: { handle: string };
+};
+
+export type ShopifyPagesOperation = {
+ data: {
+ pages: Connection;
+ };
+};
+
+export type ShopifyProductOperation = {
+ data: { product: ShopifyProduct };
+ variables: {
+ handle: string;
+ };
+};
+
+export type ShopifyProductRecommendationsOperation = {
+ data: {
+ productRecommendations: ShopifyProduct[];
+ };
+ variables: {
+ productId: string;
+ };
+};
+
+export type ShopifyProductsOperation = {
+ data: {
+ products: Connection;
+ };
+ variables: {
+ query?: string;
+ reverse?: boolean;
+ sortKey?: string;
+ };
+};
diff --git a/lib/type-guards.ts b/lib/type-guards.ts
new file mode 100644
index 0000000000..1b7e7af5a9
--- /dev/null
+++ b/lib/type-guards.ts
@@ -0,0 +1,26 @@
+export interface ShopifyErrorLike {
+ status: number;
+ message: Error;
+}
+
+export const isObject = (object: unknown): object is Record => {
+ return typeof object === 'object' && object !== null && !Array.isArray(object);
+};
+
+export const isShopifyError = (error: unknown): error is ShopifyErrorLike => {
+ if (!isObject(error)) return false;
+
+ if (error instanceof Error) return true;
+
+ return findError(error);
+};
+
+function findError(error: T): boolean {
+ if (Object.prototype.toString.call(error) === '[object Error]') {
+ return true;
+ }
+
+ const prototype = Object.getPrototypeOf(error) as T | null;
+
+ return prototype === null ? false : findError(prototype);
+}
diff --git a/lib/utils.ts b/lib/utils.ts
new file mode 100644
index 0000000000..e45a0df860
--- /dev/null
+++ b/lib/utils.ts
@@ -0,0 +1,6 @@
+export const createUrl = (pathname: string, params: URLSearchParams) => {
+ const paramsString = params.toString();
+ const queryString = `${paramsString.length ? '?' : ''}${paramsString}`;
+
+ return `${pathname}${queryString}`;
+};
diff --git a/license.md b/license.md
index fa5d39b621..7ee04f58c5 100644
--- a/license.md
+++ b/license.md
@@ -1,6 +1,6 @@
The MIT License (MIT)
-Copyright (c) 2020 Vercel, Inc.
+Copyright (c) 2023 Vercel, Inc.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
diff --git a/next.config.js b/next.config.js
new file mode 100644
index 0000000000..86482bb291
--- /dev/null
+++ b/next.config.js
@@ -0,0 +1,20 @@
+/** @type {import('next').NextConfig} */
+module.exports = {
+ eslint: {
+ // Disabling on production builds because we're running checks on PRs via GitHub Actions.
+ ignoreDuringBuilds: true
+ },
+ experimental: {
+ appDir: true
+ },
+ images: {
+ formats: ['image/avif', 'image/webp'],
+ remotePatterns: [
+ {
+ protocol: 'https',
+ hostname: 'cdn.shopify.com',
+ pathname: '/s/files/**'
+ }
+ ]
+ }
+};
diff --git a/package.json b/package.json
index d6873ba9e1..7f89571365 100644
--- a/package.json
+++ b/package.json
@@ -1,23 +1,54 @@
{
- "name": "commerce",
- "license": "MIT",
"private": true,
+ "engines": {
+ "node": ">=16",
+ "pnpm": ">=7"
+ },
"scripts": {
- "build": "turbo run build --filter=next-commerce...",
- "dev": "turbo run dev",
- "start": "turbo run start",
- "types": "turbo run types",
- "prettier-fix": "prettier --write ."
+ "dev": "next dev",
+ "build": "next build",
+ "start": "next start",
+ "lint": "next lint",
+ "lint-staged": "lint-staged",
+ "prettier": "prettier --write --ignore-unknown .",
+ "prettier:check": "prettier --check --ignore-unknown .",
+ "test": "pnpm lint && pnpm prettier:check",
+ "test:e2e": "playwright test"
},
- "devDependencies": {
- "husky": "^8.0.1",
- "prettier": "^2.7.1",
- "turbo": "^1.4.6"
+ "git": {
+ "pre-commit": "lint-staged"
},
- "husky": {
- "hooks": {
- "pre-commit": "turbo run lint"
- }
+ "lint-staged": {
+ "*": "prettier --write --ignore-unknown"
},
- "packageManager": "pnpm@7.5.0"
+ "dependencies": {
+ "@headlessui/react": "^1.7.10",
+ "@vercel/og": "^0.1.0",
+ "clsx": "^1.2.1",
+ "framer-motion": "^8.4.0",
+ "is-empty-iterable": "^3.0.0",
+ "next": "13.3.1-canary.7",
+ "react": "18.2.0",
+ "react-cookie": "^4.1.1",
+ "react-dom": "18.2.0"
+ },
+ "devDependencies": {
+ "@playwright/test": "^1.31.2",
+ "@tailwindcss/typography": "^0.5.9",
+ "@types/node": "18.13.0",
+ "@types/react": "18.0.27",
+ "@types/react-dom": "18.0.10",
+ "@vercel/git-hooks": "^1.0.0",
+ "autoprefixer": "^10.4.13",
+ "eslint": "^8.35.0",
+ "eslint-config-next": "^13.2.1",
+ "eslint-config-prettier": "^8.6.0",
+ "eslint-plugin-unicorn": "^45.0.2",
+ "lint-staged": "^13.1.1",
+ "postcss": "^8.4.21",
+ "prettier": "^2.8.4",
+ "prettier-plugin-tailwindcss": "^0.2.2",
+ "tailwindcss": "^3.2.6",
+ "typescript": "4.9.5"
+ }
}
diff --git a/packages/bigcommerce/.env.template b/packages/bigcommerce/.env.template
deleted file mode 100644
index b5d12f5702..0000000000
--- a/packages/bigcommerce/.env.template
+++ /dev/null
@@ -1,8 +0,0 @@
-COMMERCE_PROVIDER=@vercel/commerce-bigcommerce
-
-BIGCOMMERCE_STOREFRONT_API_URL=
-BIGCOMMERCE_STOREFRONT_API_TOKEN=
-BIGCOMMERCE_STORE_API_URL=
-BIGCOMMERCE_STORE_API_TOKEN=
-BIGCOMMERCE_STORE_API_CLIENT_ID=
-BIGCOMMERCE_CHANNEL_ID=
diff --git a/packages/bigcommerce/.prettierignore b/packages/bigcommerce/.prettierignore
deleted file mode 100644
index f06235c460..0000000000
--- a/packages/bigcommerce/.prettierignore
+++ /dev/null
@@ -1,2 +0,0 @@
-node_modules
-dist
diff --git a/packages/bigcommerce/.prettierrc b/packages/bigcommerce/.prettierrc
deleted file mode 100644
index e1076edfa8..0000000000
--- a/packages/bigcommerce/.prettierrc
+++ /dev/null
@@ -1,6 +0,0 @@
-{
- "semi": false,
- "singleQuote": true,
- "tabWidth": 2,
- "useTabs": false
-}
diff --git a/packages/bigcommerce/README.md b/packages/bigcommerce/README.md
deleted file mode 100644
index 1e8c6cb087..0000000000
--- a/packages/bigcommerce/README.md
+++ /dev/null
@@ -1,59 +0,0 @@
-# Bigcommerce Provider
-
-**Demo:** https://bigcommerce.demo.vercel.store/
-
-With the deploy button below you'll be able to have a [BigCommerce](https://www.bigcommerce.com/) account and a store that works with this starter:
-
-[](https://vercel.com/new/git/external?repository-url=https%3A%2F%2Fgithub.com%2Fvercel%2Fcommerce&project-name=commerce&repo-name=commerce&demo-title=Next.js%20Commerce&demo-description=An%20all-in-one%20starter%20kit%20for%20high-performance%20e-commerce%20sites.&demo-url=https%3A%2F%2Fdemo.vercel.store&demo-image=https%3A%2F%2Fbigcommerce-demo-asset-ksvtgfvnd.vercel.app%2Fbigcommerce.png&integration-ids=oac_MuWZiE4jtmQ2ejZQaQ7ncuDT)
-
-If you already have a BigCommerce account and want to use your current store, then copy the `.env.template` file in this directory to `.env.local` in the main directory (which will be ignored by Git):
-
-```bash
-cp packages/bigcommerce/.env.template .env.local
-```
-
-Then, set the environment variables in `.env.local` to match the ones from your store.
-
-## Contribute
-
-Our commitment to Open Source can be found [here](https://vercel.com/oss).
-
-If you find an issue with the provider or want a new feature, feel free to open a PR or [create a new issue](https://github.com/vercel/commerce/issues).
-
-## Troubleshoot
-
-
-I already own a BigCommerce store. What should I do?
-
-First thing you do is: set your environment variables
-
-
-.env.local
-
-```sh
-BIGCOMMERCE_STOREFRONT_API_URL=<>
-BIGCOMMERCE_STOREFRONT_API_TOKEN=<>
-BIGCOMMERCE_STORE_API_URL=<>
-BIGCOMMERCE_STORE_API_TOKEN=<>
-BIGCOMMERCE_STORE_API_CLIENT_ID=<>
-BIGCOMMERCE_CHANNEL_ID=<>
-```
-
-If your project was started with a "Deploy with Vercel" button, you can use Vercel's CLI to retrieve these credentials.
-
-1. Install Vercel CLI: `npm i -g vercel`
-2. Link local instance with Vercel and Github accounts (creates .vercel file): `vercel link`
-3. Download your environment variables: `vercel env pull .env.local`
-
-Next, you're free to customize the starter. More updates coming soon. Stay tuned.
-
-
-
-
-BigCommerce shows a Coming Soon page and requests a Preview Code
-
-After Email confirmation, Checkout should be manually enabled through BigCommerce platform. Look for "Review & test your store" section through BigCommerce's dashboard.
-
-
-BigCommerce team has been notified and they plan to add more detailed about this subject.
-
diff --git a/packages/bigcommerce/codegen.json b/packages/bigcommerce/codegen.json
deleted file mode 100644
index 7346508f75..0000000000
--- a/packages/bigcommerce/codegen.json
+++ /dev/null
@@ -1,27 +0,0 @@
-{
- "schema": {
- "https://buybutton.store/graphql": {
- "headers": {
- "Authorization": "Bearer xzy"
- }
- }
- },
- "documents": [
- {
- "./src/api/**/*.ts": {
- "noRequire": true
- }
- }
- ],
- "generates": {
- "./schema.d.ts": {
- "plugins": ["typescript", "typescript-operations"]
- },
- "./schema.graphql": {
- "plugins": ["schema-ast"]
- }
- },
- "hooks": {
- "afterAllFileWrite": ["prettier --write"]
- }
-}
diff --git a/packages/bigcommerce/package.json b/packages/bigcommerce/package.json
deleted file mode 100644
index 08972a67f0..0000000000
--- a/packages/bigcommerce/package.json
+++ /dev/null
@@ -1,90 +0,0 @@
-{
- "name": "@vercel/commerce-bigcommerce",
- "version": "0.0.1",
- "license": "MIT",
- "scripts": {
- "release": "taskr release",
- "build": "taskr build",
- "dev": "taskr",
- "types": "tsc --emitDeclarationOnly",
- "generate:definitions": "node scripts/generate-definitions.js"
- },
- "sideEffects": false,
- "type": "module",
- "exports": {
- ".": "./dist/index.js",
- "./*": [
- "./dist/*.js",
- "./dist/*/index.js"
- ],
- "./next.config": "./dist/next.config.cjs"
- },
- "typesVersions": {
- "*": {
- "*": [
- "src/*",
- "src/*/index"
- ],
- "next.config": [
- "dist/next.config.d.cts"
- ]
- }
- },
- "files": [
- "dist"
- ],
- "publishConfig": {
- "typesVersions": {
- "*": {
- "*": [
- "dist/*.d.ts",
- "dist/*/index.d.ts"
- ],
- "config": [
- "dist/next.config.d.cts"
- ]
- }
- }
- },
- "dependencies": {
- "@cfworker/uuid": "^1.12.4",
- "@tsndr/cloudflare-worker-jwt": "^2.1.0",
- "@vercel/commerce": "workspace:*",
- "cookie": "^0.4.1",
- "immutability-helper": "^3.1.1",
- "js-cookie": "^3.0.1",
- "jsonwebtoken": "^8.5.1",
- "lodash.debounce": "^4.0.8",
- "uuidv4": "^6.2.13"
- },
- "peerDependencies": {
- "next": "^13",
- "react": "^18",
- "react-dom": "^18"
- },
- "devDependencies": {
- "@taskr/clear": "^1.1.0",
- "@taskr/esnext": "^1.1.0",
- "@taskr/watch": "^1.1.0",
- "@types/cookie": "^0.4.1",
- "@types/jsonwebtoken": "^8.5.7",
- "@types/lodash.debounce": "^4.0.6",
- "@types/node": "^17.0.8",
- "@types/node-fetch": "^2.6.2",
- "@types/react": "^18.0.14",
- "lint-staged": "^12.1.7",
- "next": "^13.0.6",
- "prettier": "^2.5.1",
- "react": "^18.2.0",
- "react-dom": "^18.2.0",
- "taskr": "^1.1.0",
- "taskr-swc": "^0.0.1",
- "typescript": "^4.7.4"
- },
- "lint-staged": {
- "**/*.{js,jsx,ts,tsx,json}": [
- "prettier --write",
- "git add"
- ]
- }
-}
diff --git a/packages/bigcommerce/schema.d.ts b/packages/bigcommerce/schema.d.ts
deleted file mode 100644
index 04824e2638..0000000000
--- a/packages/bigcommerce/schema.d.ts
+++ /dev/null
@@ -1,2064 +0,0 @@
-export type Maybe = T | null
-export type Exact = {
- [K in keyof T]: T[K]
-}
-/** All built-in and custom scalars, mapped to their actual values */
-export type Scalars = {
- ID: string
- String: string
- Boolean: boolean
- Int: number
- Float: number
- DateTime: any
- /** The `BigDecimal` scalar type represents signed fractional values with arbitrary precision. */
- BigDecimal: any
- /** The `Long` scalar type represents non-fractional signed whole numeric values. Long can represent values between -(2^63) and 2^63 - 1. */
- Long: any
-}
-
-/** Login result */
-export type LoginResult = {
- __typename?: 'LoginResult'
- /** The result of a login */
- result: Scalars['String']
-}
-
-/** Logout result */
-export type LogoutResult = {
- __typename?: 'LogoutResult'
- /** The result of a logout */
- result: Scalars['String']
-}
-
-export type Mutation = {
- __typename?: 'Mutation'
- login: LoginResult
- logout: LogoutResult
-}
-
-export type MutationLoginArgs = {
- email: Scalars['String']
- password: Scalars['String']
-}
-
-/** Aggregated */
-export type Aggregated = {
- __typename?: 'Aggregated'
- /** Number of available products in stock. This can be 'null' if inventory is not set orif the store's Inventory Settings disable displaying stock levels on the storefront. */
- availableToSell: Scalars['Long']
- /** Indicates a threshold low-stock level. This can be 'null' if the inventory warning level is not set or if the store's Inventory Settings disable displaying stock levels on the storefront. */
- warningLevel: Scalars['Int']
-}
-
-/** Aggregated Product Inventory */
-export type AggregatedInventory = {
- __typename?: 'AggregatedInventory'
- /** Number of available products in stock. This can be 'null' if inventory is not set orif the store's Inventory Settings disable displaying stock levels on the storefront. */
- availableToSell: Scalars['Int']
- /** Indicates a threshold low-stock level. This can be 'null' if the inventory warning level is not set or if the store's Inventory Settings disable displaying stock levels on the storefront. */
- warningLevel: Scalars['Int']
-}
-
-/** Brand */
-export type Brand = Node & {
- __typename?: 'Brand'
- /** The ID of an object */
- id: Scalars['ID']
- /** Id of the brand. */
- entityId: Scalars['Int']
- /** Name of the brand. */
- name: Scalars['String']
- /** Default image for brand. */
- defaultImage?: Maybe
- /** Page title for the brand. */
- pageTitle: Scalars['String']
- /** Meta description for the brand. */
- metaDesc: Scalars['String']
- /** Meta keywords for the brand. */
- metaKeywords: Array
- /** Search keywords for the brand. */
- searchKeywords: Array
- /** Path for the brand page. */
- path: Scalars['String']
- products: ProductConnection
- /** Metafield data related to a brand. */
- metafields: MetafieldConnection
-}
-
-/** Brand */
-export type BrandProductsArgs = {
- before?: Maybe
- after?: Maybe
- first?: Maybe
- last?: Maybe
-}
-
-/** Brand */
-export type BrandMetafieldsArgs = {
- namespace: Scalars['String']
- keys?: Maybe>
- before?: Maybe
- after?: Maybe
- first?: Maybe
- last?: Maybe
-}
-
-/** A connection to a list of items. */
-export type BrandConnection = {
- __typename?: 'BrandConnection'
- /** Information to aid in pagination. */
- pageInfo: PageInfo
- /** A list of edges. */
- edges?: Maybe>>
-}
-
-/** An edge in a connection. */
-export type BrandEdge = {
- __typename?: 'BrandEdge'
- /** The item at the end of the edge. */
- node: Brand
- /** A cursor for use in pagination. */
- cursor: Scalars['String']
-}
-
-/** Breadcrumb */
-export type Breadcrumb = {
- __typename?: 'Breadcrumb'
- /** Category id. */
- entityId: Scalars['Int']
- /** Name of the category. */
- name: Scalars['String']
-}
-
-/** A connection to a list of items. */
-export type BreadcrumbConnection = {
- __typename?: 'BreadcrumbConnection'
- /** Information to aid in pagination. */
- pageInfo: PageInfo
- /** A list of edges. */
- edges?: Maybe>>
-}
-
-/** An edge in a connection. */
-export type BreadcrumbEdge = {
- __typename?: 'BreadcrumbEdge'
- /** The item at the end of the edge. */
- node: Breadcrumb
- /** A cursor for use in pagination. */
- cursor: Scalars['String']
-}
-
-/** Bulk pricing tier that sets a fixed price for the product or variant. */
-export type BulkPricingFixedPriceDiscount = BulkPricingTier & {
- __typename?: 'BulkPricingFixedPriceDiscount'
- /** This price will override the current product price. */
- price: Scalars['BigDecimal']
- /** Minimum item quantity that applies to this bulk pricing tier. */
- minimumQuantity: Scalars['Int']
- /** Maximum item quantity that applies to this bulk pricing tier - if not defined then the tier does not have an upper bound. */
- maximumQuantity?: Maybe
-}
-
-/** Bulk pricing tier that reduces the price of the product or variant by a percentage. */
-export type BulkPricingPercentageDiscount = BulkPricingTier & {
- __typename?: 'BulkPricingPercentageDiscount'
- /** The percentage that will be removed from the product price. */
- percentOff: Scalars['BigDecimal']
- /** Minimum item quantity that applies to this bulk pricing tier. */
- minimumQuantity: Scalars['Int']
- /** Maximum item quantity that applies to this bulk pricing tier - if not defined then the tier does not have an upper bound. */
- maximumQuantity?: Maybe
-}
-
-/** Bulk pricing tier that will subtract an amount from the price of the product or variant. */
-export type BulkPricingRelativePriceDiscount = BulkPricingTier & {
- __typename?: 'BulkPricingRelativePriceDiscount'
- /** The price of the product/variant will be reduced by this priceAdjustment. */
- priceAdjustment: Scalars['BigDecimal']
- /** Minimum item quantity that applies to this bulk pricing tier. */
- minimumQuantity: Scalars['Int']
- /** Maximum item quantity that applies to this bulk pricing tier - if not defined then the tier does not have an upper bound. */
- maximumQuantity?: Maybe
-}
-
-/** A set of bulk pricing tiers that define price discounts which apply when purchasing specified quantities of a product or variant. */
-export type BulkPricingTier = {
- /** Minimum item quantity that applies to this bulk pricing tier. */
- minimumQuantity: Scalars['Int']
- /** Maximum item quantity that applies to this bulk pricing tier - if not defined then the tier does not have an upper bound. */
- maximumQuantity?: Maybe
-}
-
-/** Product Option */
-export type CatalogProductOption = {
- /** Unique ID for the option. */
- entityId: Scalars['Int']
- /** Display name for the option. */
- displayName: Scalars['String']
- /** One of the option values is required to be selected for the checkout. */
- isRequired: Scalars['Boolean']
-}
-
-/** Product Option Value */
-export type CatalogProductOptionValue = {
- /** Unique ID for the option value. */
- entityId: Scalars['Int']
- /** Label for the option value. */
- label: Scalars['String']
- /** Indicates whether this value is the chosen default selected value. */
- isDefault: Scalars['Boolean']
-}
-
-/** Category */
-export type Category = Node & {
- __typename?: 'Category'
- /** The ID of an object */
- id: Scalars['ID']
- /** Unique ID for the category. */
- entityId: Scalars['Int']
- /** Category name. */
- name: Scalars['String']
- /** Category path. */
- path: Scalars['String']
- /** Default image for the category. */
- defaultImage?: Maybe
- /** Category description. */
- description: Scalars['String']
- /** Category breadcrumbs. */
- breadcrumbs: BreadcrumbConnection
- products: ProductConnection
- /** Metafield data related to a category. */
- metafields: MetafieldConnection
-}
-
-/** Category */
-export type CategoryBreadcrumbsArgs = {
- depth: Scalars['Int']
- before?: Maybe
- after?: Maybe
- first?: Maybe
- last?: Maybe
-}
-
-/** Category */
-export type CategoryProductsArgs = {
- before?: Maybe
- after?: Maybe
- first?: Maybe
- last?: Maybe
-}
-
-/** Category */
-export type CategoryMetafieldsArgs = {
- namespace: Scalars['String']
- keys?: Maybe>
- before?: Maybe
- after?: Maybe
- first?: Maybe
- last?: Maybe
-}
-
-/** A connection to a list of items. */
-export type CategoryConnection = {
- __typename?: 'CategoryConnection'
- /** Information to aid in pagination. */
- pageInfo: PageInfo
- /** A list of edges. */
- edges?: Maybe>>
-}
-
-/** An edge in a connection. */
-export type CategoryEdge = {
- __typename?: 'CategoryEdge'
- /** The item at the end of the edge. */
- node: Category
- /** A cursor for use in pagination. */
- cursor: Scalars['String']
-}
-
-/** An item in a tree of categories. */
-export type CategoryTreeItem = {
- __typename?: 'CategoryTreeItem'
- /** The id category. */
- entityId: Scalars['Int']
- /** The name of category. */
- name: Scalars['String']
- /** Path assigned to this category */
- path: Scalars['String']
- /** The description of this category. */
- description: Scalars['String']
- /** The number of products in this category. */
- productCount: Scalars['Int']
- /** Subcategories of this category */
- children: Array
-}
-
-/** A simple yes/no question represented by a checkbox. */
-export type CheckboxOption = CatalogProductOption & {
- __typename?: 'CheckboxOption'
- /** Indicates the default checked status. */
- checkedByDefault: Scalars['Boolean']
- /** Unique ID for the option. */
- entityId: Scalars['Int']
- /** Display name for the option. */
- displayName: Scalars['String']
- /** One of the option values is required to be selected for the checkout. */
- isRequired: Scalars['Boolean']
-}
-
-/** Contact field */
-export type ContactField = {
- __typename?: 'ContactField'
- /** Store address line. */
- address: Scalars['String']
- /** Store country. */
- country: Scalars['String']
- /** Store address type. */
- addressType: Scalars['String']
- /** Store email. */
- email: Scalars['String']
- /** Store phone number. */
- phone: Scalars['String']
-}
-
-/** Custom field */
-export type CustomField = {
- __typename?: 'CustomField'
- /** Custom field id. */
- entityId: Scalars['Int']
- /** Name of the custom field. */
- name: Scalars['String']
- /** Value of the custom field. */
- value: Scalars['String']
-}
-
-/** A connection to a list of items. */
-export type CustomFieldConnection = {
- __typename?: 'CustomFieldConnection'
- /** Information to aid in pagination. */
- pageInfo: PageInfo
- /** A list of edges. */
- edges?: Maybe>>
-}
-
-/** An edge in a connection. */
-export type CustomFieldEdge = {
- __typename?: 'CustomFieldEdge'
- /** The item at the end of the edge. */
- node: CustomField
- /** A cursor for use in pagination. */
- cursor: Scalars['String']
-}
-
-/** A customer that shops on a store */
-export type Customer = {
- __typename?: 'Customer'
- /** The ID of the customer. */
- entityId: Scalars['Int']
- /** The company name of the customer. */
- company: Scalars['String']
- /** The customer group id of the customer. */
- customerGroupId: Scalars['Int']
- /** The email address of the customer. */
- email: Scalars['String']
- /** The first name of the customer. */
- firstName: Scalars['String']
- /** The last name of the customer. */
- lastName: Scalars['String']
- /** The notes of the customer. */
- notes: Scalars['String']
- /** The phone number of the customer. */
- phone: Scalars['String']
- /** The tax exempt category of the customer. */
- taxExemptCategory: Scalars['String']
- /** Customer addresses count. */
- addressCount: Scalars['Int']
- /** Customer attributes count. */
- attributeCount: Scalars['Int']
- /** Customer store credit. */
- storeCredit: Array
- /** Customer attributes. */
- attributes: CustomerAttributes
-}
-
-/** A custom, store-specific attribute for a customer */
-export type CustomerAttribute = {
- __typename?: 'CustomerAttribute'
- /** The ID of the custom customer attribute */
- entityId: Scalars['Int']
- /** The value of the custom customer attribute */
- value?: Maybe
- /** The name of the custom customer attribute */
- name: Scalars['String']
-}
-
-/** Custom, store-specific customer attributes */
-export type CustomerAttributes = {
- __typename?: 'CustomerAttributes'
- attribute: CustomerAttribute
-}
-
-/** Custom, store-specific customer attributes */
-export type CustomerAttributesAttributeArgs = {
- entityId: Scalars['Int']
-}
-
-/** A calendar for allowing selection of a date. */
-export type DateFieldOption = CatalogProductOption & {
- __typename?: 'DateFieldOption'
- /** Unique ID for the option. */
- entityId: Scalars['Int']
- /** Display name for the option. */
- displayName: Scalars['String']
- /** One of the option values is required to be selected for the checkout. */
- isRequired: Scalars['Boolean']
-}
-
-/** Date Time Extended */
-export type DateTimeExtended = {
- __typename?: 'DateTimeExtended'
- /** ISO-8601 formatted date in UTC */
- utc: Scalars['DateTime']
-}
-
-/** Display field */
-export type DisplayField = {
- __typename?: 'DisplayField'
- /** Short date format. */
- shortDateFormat: Scalars['String']
- /** Extended date format. */
- extendedDateFormat: Scalars['String']
-}
-
-/** A form allowing selection and uploading of a file from the user's local computer. */
-export type FileUploadFieldOption = CatalogProductOption & {
- __typename?: 'FileUploadFieldOption'
- /** Unique ID for the option. */
- entityId: Scalars['Int']
- /** Display name for the option. */
- displayName: Scalars['String']
- /** One of the option values is required to be selected for the checkout. */
- isRequired: Scalars['Boolean']
-}
-
-/** Image */
-export type Image = {
- __typename?: 'Image'
- /** Absolute path to image using store CDN. */
- url: Scalars['String']
- /** Absolute path to original image using store CDN. */
- urlOriginal: Scalars['String']
- /** Text description of an image that can be used for SEO and/or accessibility purposes. */
- altText: Scalars['String']
- /** Indicates whether this is the primary image. */
- isDefault: Scalars['Boolean']
-}
-
-/** Image */
-export type ImageUrlArgs = {
- width: Scalars['Int']
- height?: Maybe
-}
-
-/** A connection to a list of items. */
-export type ImageConnection = {
- __typename?: 'ImageConnection'
- /** Information to aid in pagination. */
- pageInfo: PageInfo
- /** A list of edges. */
- edges?: Maybe>>
-}
-
-/** An edge in a connection. */
-export type ImageEdge = {
- __typename?: 'ImageEdge'
- /** The item at the end of the edge. */
- node: Image
- /** A cursor for use in pagination. */
- cursor: Scalars['String']
-}
-
-/** An inventory */
-export type Inventory = {
- __typename?: 'Inventory'
- /** Locations */
- locations: LocationConnection
-}
-
-/** An inventory */
-export type InventoryLocationsArgs = {
- entityIds?: Maybe>
- codes?: Maybe>
- typeIds?: Maybe>
- before?: Maybe
- after?: Maybe
- first?: Maybe
- last?: Maybe
-}
-
-/** Inventory By Locations */
-export type InventoryByLocations = {
- __typename?: 'InventoryByLocations'
- /** Location id. */
- locationEntityId: Scalars['Long']
- /** Number of available products in stock. */
- availableToSell: Scalars['Long']
- /** Indicates a threshold low-stock level. */
- warningLevel: Scalars['Int']
- /** Indicates whether this product is in stock. */
- isInStock: Scalars['Boolean']
-}
-
-/** A connection to a list of items. */
-export type LocationConnection = {
- __typename?: 'LocationConnection'
- /** Information to aid in pagination. */
- pageInfo: PageInfo
- /** A list of edges. */
- edges?: Maybe>>
-}
-
-/** An edge in a connection. */
-export type LocationEdge = {
- __typename?: 'LocationEdge'
- /** The item at the end of the edge. */
- node: InventoryByLocations
- /** A cursor for use in pagination. */
- cursor: Scalars['String']
-}
-
-/** Logo field */
-export type LogoField = {
- __typename?: 'LogoField'
- /** Logo title. */
- title: Scalars['String']
- /** Store logo image. */
- image: Image
-}
-
-/** Measurement */
-export type Measurement = {
- __typename?: 'Measurement'
- /** Unformatted weight measurement value. */
- value: Scalars['Float']
- /** Unit of measurement. */
- unit: Scalars['String']
-}
-
-/** A connection to a list of items. */
-export type MetafieldConnection = {
- __typename?: 'MetafieldConnection'
- /** Information to aid in pagination. */
- pageInfo: PageInfo
- /** A list of edges. */
- edges?: Maybe>>
-}
-
-/** An edge in a connection. */
-export type MetafieldEdge = {
- __typename?: 'MetafieldEdge'
- /** The item at the end of the edge. */
- node: Metafields
- /** A cursor for use in pagination. */
- cursor: Scalars['String']
-}
-
-/** Key/Value pairs of data attached tied to a resource entity (product, brand, category, etc.) */
-export type Metafields = {
- __typename?: 'Metafields'
- /** The ID of an object */
- id: Scalars['ID']
- /** The ID of the metafield when referencing via our backend API. */
- entityId: Scalars['Int']
- /** A label for identifying a metafield data value. */
- key: Scalars['String']
- /** A metafield value. */
- value: Scalars['String']
-}
-
-/** A money object - includes currency code and a money amount */
-export type Money = {
- __typename?: 'Money'
- /** Currency code of the current money. */
- currencyCode: Scalars['String']
- /** The amount of money. */
- value: Scalars['BigDecimal']
-}
-
-/** A min and max pair of money objects */
-export type MoneyRange = {
- __typename?: 'MoneyRange'
- /** Minimum money object. */
- min: Money
- /** Maximum money object. */
- max: Money
-}
-
-/** A multi-line text input field, aka a text box. */
-export type MultiLineTextFieldOption = CatalogProductOption & {
- __typename?: 'MultiLineTextFieldOption'
- /** Unique ID for the option. */
- entityId: Scalars['Int']
- /** Display name for the option. */
- displayName: Scalars['String']
- /** One of the option values is required to be selected for the checkout. */
- isRequired: Scalars['Boolean']
-}
-
-/** An option type that has a fixed list of values. */
-export type MultipleChoiceOption = CatalogProductOption & {
- __typename?: 'MultipleChoiceOption'
- /** The chosen display style for this multiple choice option. */
- displayStyle: Scalars['String']
- /** List of option values. */
- values: ProductOptionValueConnection
- /** Unique ID for the option. */
- entityId: Scalars['Int']
- /** Display name for the option. */
- displayName: Scalars['String']
- /** One of the option values is required to be selected for the checkout. */
- isRequired: Scalars['Boolean']
-}
-
-/** An option type that has a fixed list of values. */
-export type MultipleChoiceOptionValuesArgs = {
- before?: Maybe
- after?: Maybe
- first?: Maybe
- last?: Maybe
-}
-
-/** A simple multiple choice value comprised of an id and a label. */
-export type MultipleChoiceOptionValue = CatalogProductOptionValue & {
- __typename?: 'MultipleChoiceOptionValue'
- /** Unique ID for the option value. */
- entityId: Scalars['Int']
- /** Label for the option value. */
- label: Scalars['String']
- /** Indicates whether this value is the chosen default selected value. */
- isDefault: Scalars['Boolean']
-}
-
-/** An object with an ID */
-export type Node = {
- /** The id of the object. */
- id: Scalars['ID']
-}
-
-/** A single line text input field that only accepts numbers. */
-export type NumberFieldOption = CatalogProductOption & {
- __typename?: 'NumberFieldOption'
- /** Unique ID for the option. */
- entityId: Scalars['Int']
- /** Display name for the option. */
- displayName: Scalars['String']
- /** One of the option values is required to be selected for the checkout. */
- isRequired: Scalars['Boolean']
-}
-
-/** A connection to a list of items. */
-export type OptionConnection = {
- __typename?: 'OptionConnection'
- /** Information to aid in pagination. */
- pageInfo: PageInfo
- /** A list of edges. */
- edges?: Maybe>>
-}
-
-/** An edge in a connection. */
-export type OptionEdge = {
- __typename?: 'OptionEdge'
- /** The item at the end of the edge. */
- node: ProductOption
- /** A cursor for use in pagination. */
- cursor: Scalars['String']
-}
-
-/** A connection to a list of items. */
-export type OptionValueConnection = {
- __typename?: 'OptionValueConnection'
- /** Information to aid in pagination. */
- pageInfo: PageInfo
- /** A list of edges. */
- edges?: Maybe>>
-}
-
-/** An edge in a connection. */
-export type OptionValueEdge = {
- __typename?: 'OptionValueEdge'
- /** The item at the end of the edge. */
- node: ProductOptionValue
- /** A cursor for use in pagination. */
- cursor: Scalars['String']
-}
-
-export type OptionValueId = {
- optionEntityId: Scalars['Int']
- valueEntityId: Scalars['Int']
-}
-
-/** Information about pagination in a connection. */
-export type PageInfo = {
- __typename?: 'PageInfo'
- /** When paginating forwards, are there more items? */
- hasNextPage: Scalars['Boolean']
- /** When paginating backwards, are there more items? */
- hasPreviousPage: Scalars['Boolean']
- /** When paginating backwards, the cursor to continue. */
- startCursor?: Maybe
- /** When paginating forwards, the cursor to continue. */
- endCursor?: Maybe
-}
-
-/** The min and max range of prices that apply to this product. */
-export type PriceRanges = {
- __typename?: 'PriceRanges'
- /** Product price min/max range. */
- priceRange: MoneyRange
- /** Product retail price min/max range. */
- retailPriceRange?: Maybe
-}
-
-/** The various prices that can be set on a product. */
-export type Prices = {
- __typename?: 'Prices'
- /** Calculated price of the product. */
- price: Money
- /** Sale price of the product. */
- salePrice?: Maybe
- /** Original price of the product. */
- basePrice?: Maybe
- /** Retail price of the product. */
- retailPrice?: Maybe
- /** Minimum advertised price of the product. */
- mapPrice?: Maybe
- /** Product price min/max range. */
- priceRange: MoneyRange
- /** Product retail price min/max range. */
- retailPriceRange?: Maybe
- /** The difference between the retail price (MSRP) and the current price, which can be presented to the shopper as their savings. */
- saved?: Maybe
- /** List of bulk pricing tiers applicable to a product or variant. */
- bulkPricing: Array
-}
-
-/** Product */
-export type Product = Node & {
- __typename?: 'Product'
- /** The ID of an object */
- id: Scalars['ID']
- /** Id of the product. */
- entityId: Scalars['Int']
- /** Default product variant when no options are selected. */
- sku: Scalars['String']
- /** Relative URL path to product page. */
- path: Scalars['String']
- /** Name of the product. */
- name: Scalars['String']
- /** Description of the product. */
- description: Scalars['String']
- /** Description of the product in plain text. */
- plainTextDescription: Scalars['String']
- /** Warranty information of the product. */
- warranty: Scalars['String']
- /** Minimum purchasable quantity for this product in a single order. */
- minPurchaseQuantity?: Maybe
- /** Maximum purchasable quantity for this product in a single order. */
- maxPurchaseQuantity?: Maybe
- /** Absolute URL path for adding a product to cart. */
- addToCartUrl: Scalars['String']
- /** Absolute URL path for adding a product to customer's wishlist. */
- addToWishlistUrl: Scalars['String']
- /** Prices object determined by supplied product ID, variant ID, and selected option IDs. */
- prices?: Maybe
- /**
- * The minimum and maximum price of this product based on variant pricing and/or modifier price rules.
- * @deprecated Use priceRanges inside prices node instead.
- */
- priceRanges?: Maybe
- /** Weight of the product. */
- weight?: Maybe
- /** Height of the product. */
- height?: Maybe
- /** Width of the product. */
- width?: Maybe
- /** Depth of the product. */
- depth?: Maybe
- /** Product options. */
- options: OptionConnection
- /** Product options. */
- productOptions: ProductOptionConnection
- /** Summary of the product reviews, includes the total number of reviews submitted and summation of the ratings on the reviews (ratings range from 0-5 per review). */
- reviewSummary: Reviews
- /** Type of product, ex: physical, digital */
- type: Scalars['String']
- /**
- * The availability state of the product.
- * @deprecated Use status inside availabilityV2 instead.
- */
- availability: Scalars['String']
- /**
- * A few words telling the customer how long it will normally take to ship this product, such as 'Usually ships in 24 hours'.
- * @deprecated Use description inside availabilityV2 instead.
- */
- availabilityDescription: Scalars['String']
- /** The availability state of the product. */
- availabilityV2: ProductAvailability
- /** List of categories associated with the product. */
- categories: CategoryConnection
- /** Brand associated with the product. */
- brand?: Maybe
- /** Variants associated with the product. */
- variants: VariantConnection
- /** Custom fields of the product. */
- customFields: CustomFieldConnection
- /** A list of the images for a product. */
- images: ImageConnection
- /** Default image for a product. */
- defaultImage?: Maybe
- /** Related products for this product. */
- relatedProducts: RelatedProductsConnection
- /** Inventory information of the product. */
- inventory: ProductInventory
- /** Metafield data related to a product. */
- metafields: MetafieldConnection
- /**
- * Product creation date
- * @deprecated Alpha version. Do not use in production.
- */
- createdAt: DateTimeExtended
-}
-
-/** Product */
-export type ProductPlainTextDescriptionArgs = {
- characterLimit?: Maybe
-}
-
-/** Product */
-export type ProductPricesArgs = {
- includeTax?: Maybe
- currencyCode?: Maybe
-}
-
-/** Product */
-export type ProductPriceRangesArgs = {
- includeTax?: Maybe
-}
-
-/** Product */
-export type ProductOptionsArgs = {
- before?: Maybe
- after?: Maybe
- first?: Maybe
- last?: Maybe
-}
-
-/** Product */
-export type ProductProductOptionsArgs = {
- before?: Maybe
- after?: Maybe
- first?: Maybe
- last?: Maybe
-}
-
-/** Product */
-export type ProductCategoriesArgs = {
- before?: Maybe
- after?: Maybe
- first?: Maybe
- last?: Maybe
-}
-
-/** Product */
-export type ProductVariantsArgs = {
- before?: Maybe
- after?: Maybe
- first?: Maybe
- last?: Maybe
- entityIds?: Maybe>
- optionValueIds?: Maybe>
-}
-
-/** Product */
-export type ProductCustomFieldsArgs = {
- names?: Maybe>
- before?: Maybe
- after?: Maybe
- first?: Maybe
- last?: Maybe
-}
-
-/** Product */
-export type ProductImagesArgs = {
- before?: Maybe
- after?: Maybe
- first?: Maybe
- last?: Maybe
-}
-
-/** Product */
-export type ProductRelatedProductsArgs = {
- before?: Maybe
- after?: Maybe
- first?: Maybe
- last?: Maybe
-}
-
-/** Product */
-export type ProductMetafieldsArgs = {
- namespace: Scalars['String']
- keys?: Maybe>
- before?: Maybe
- after?: Maybe
- first?: Maybe
- last?: Maybe
-}
-
-/** Product availability */
-export type ProductAvailability = {
- /** The availability state of the product. */
- status: ProductAvailabilityStatus
- /** A few words telling the customer how long it will normally take to ship this product, such as 'Usually ships in 24 hours'. */
- description: Scalars['String']
-}
-
-/** Product availability status */
-export enum ProductAvailabilityStatus {
- Available = 'Available',
- Preorder = 'Preorder',
- Unavailable = 'Unavailable',
-}
-
-/** Available Product */
-export type ProductAvailable = ProductAvailability & {
- __typename?: 'ProductAvailable'
- /** The availability state of the product. */
- status: ProductAvailabilityStatus
- /** A few words telling the customer how long it will normally take to ship this product, such as 'Usually ships in 24 hours'. */
- description: Scalars['String']
-}
-
-/** A connection to a list of items. */
-export type ProductConnection = {
- __typename?: 'ProductConnection'
- /** Information to aid in pagination. */
- pageInfo: PageInfo
- /** A list of edges. */
- edges?: Maybe>>
-}
-
-/** An edge in a connection. */
-export type ProductEdge = {
- __typename?: 'ProductEdge'
- /** The item at the end of the edge. */
- node: Product
- /** A cursor for use in pagination. */
- cursor: Scalars['String']
-}
-
-/** Product Inventory Information */
-export type ProductInventory = {
- __typename?: 'ProductInventory'
- /** Indicates whether this product is in stock. */
- isInStock: Scalars['Boolean']
- /** Indicates whether this product's inventory is being tracked on variant level. If true, you may wish to check the variants node to understand the true inventory of each individual variant, rather than relying on this product-level aggregate to understand how many items may be added to cart. */
- hasVariantInventory: Scalars['Boolean']
- /** Aggregated product inventory information. This data may not be available if not set or if the store's Inventory Settings have disabled displaying stock levels on the storefront. */
- aggregated?: Maybe
-}
-
-/** Product Option */
-export type ProductOption = {
- __typename?: 'ProductOption'
- /** Unique ID for the option. */
- entityId: Scalars['Int']
- /** Display name for the option. */
- displayName: Scalars['String']
- /** One of the option values is required to be selected for the checkout. */
- isRequired: Scalars['Boolean']
- /** Option values. */
- values: OptionValueConnection
-}
-
-/** Product Option */
-export type ProductOptionValuesArgs = {
- before?: Maybe
- after?: Maybe
- first?: Maybe
- last?: Maybe
-}
-
-/** A connection to a list of items. */
-export type ProductOptionConnection = {
- __typename?: 'ProductOptionConnection'
- /** Information to aid in pagination. */
- pageInfo: PageInfo
- /** A list of edges. */
- edges?: Maybe>>
-}
-
-/** An edge in a connection. */
-export type ProductOptionEdge = {
- __typename?: 'ProductOptionEdge'
- /** The item at the end of the edge. */
- node: CatalogProductOption
- /** A cursor for use in pagination. */
- cursor: Scalars['String']
-}
-
-/** Product Option Value */
-export type ProductOptionValue = {
- __typename?: 'ProductOptionValue'
- /** Unique ID for the option value. */
- entityId: Scalars['Int']
- /** Label for the option value. */
- label: Scalars['String']
-}
-
-/** A connection to a list of items. */
-export type ProductOptionValueConnection = {
- __typename?: 'ProductOptionValueConnection'
- /** Information to aid in pagination. */
- pageInfo: PageInfo
- /** A list of edges. */
- edges?: Maybe>>
-}
-
-/** An edge in a connection. */
-export type ProductOptionValueEdge = {
- __typename?: 'ProductOptionValueEdge'
- /** The item at the end of the edge. */
- node: CatalogProductOptionValue
- /** A cursor for use in pagination. */
- cursor: Scalars['String']
-}
-
-/** A Product PickList Value - a product to be mapped to the base product if selected. */
-export type ProductPickListOptionValue = CatalogProductOptionValue & {
- __typename?: 'ProductPickListOptionValue'
- /** The ID of the product associated with this option value. */
- productId: Scalars['Int']
- /** Unique ID for the option value. */
- entityId: Scalars['Int']
- /** Label for the option value. */
- label: Scalars['String']
- /** Indicates whether this value is the chosen default selected value. */
- isDefault: Scalars['Boolean']
-}
-
-/** PreOrder Product */
-export type ProductPreOrder = ProductAvailability & {
- __typename?: 'ProductPreOrder'
- /** The message to be shown in the store when a product is put into the pre-order availability state, e.g. "Expected release date is %%DATE%%" */
- message?: Maybe
- /** Product release date */
- willBeReleasedAt?: Maybe
- /** The availability state of the product. */
- status: ProductAvailabilityStatus
- /** A few words telling the customer how long it will normally take to ship this product, such as 'Usually ships in 24 hours'. */
- description: Scalars['String']
-}
-
-/** Unavailable Product */
-export type ProductUnavailable = ProductAvailability & {
- __typename?: 'ProductUnavailable'
- /** The message to be shown in the store when "Call for pricing" is enabled for this product, e.g. "Contact us at 555-5555" */
- message?: Maybe
- /** The availability state of the product. */
- status: ProductAvailabilityStatus
- /** A few words telling the customer how long it will normally take to ship this product, such as 'Usually ships in 24 hours'. */
- description: Scalars['String']
-}
-
-export type Query = {
- __typename?: 'Query'
- site: Site
- /** The currently logged in customer. */
- customer?: Maybe
- /** Fetches an object given its ID */
- node?: Maybe
- /** @deprecated Alpha version. Do not use in production. */
- inventory: Inventory
-}
-
-export type QueryNodeArgs = {
- id: Scalars['ID']
-}
-
-/** A connection to a list of items. */
-export type RelatedProductsConnection = {
- __typename?: 'RelatedProductsConnection'
- /** Information to aid in pagination. */
- pageInfo: PageInfo
- /** A list of edges. */
- edges?: Maybe>>
-}
-
-/** An edge in a connection. */
-export type RelatedProductsEdge = {
- __typename?: 'RelatedProductsEdge'
- /** The item at the end of the edge. */
- node: Product
- /** A cursor for use in pagination. */
- cursor: Scalars['String']
-}
-
-/** Review Rating Summary */
-export type Reviews = {
- __typename?: 'Reviews'
- /** Total number of reviews on product. */
- numberOfReviews: Scalars['Int']
- /** Summation of rating scores from each review. */
- summationOfRatings: Scalars['Int']
-}
-
-/** route */
-export type Route = {
- __typename?: 'Route'
- /** node */
- node?: Maybe
-}
-
-/** Store settings information from the control panel. */
-export type Settings = {
- __typename?: 'Settings'
- /** The name of the store. */
- storeName: Scalars['String']
- /** The hash of the store. */
- storeHash: Scalars['String']
- /** The current store status. */
- status: StorefrontStatusType
- /** Logo information for the store. */
- logo: LogoField
- /** Contact information for the store. */
- contact?: Maybe
- /** Store urls. */
- url: UrlField
- /** Store display format information. */
- display: DisplayField
- /** Channel ID. */
- channelId: Scalars['Long']
-}
-
-/** A site */
-export type Site = {
- __typename?: 'Site'
- categoryTree: Array
- /** Details of the brand. */
- brands: BrandConnection
- /** Details of the products. */
- products: ProductConnection
- /** Details of the newest products. */
- newestProducts: ProductConnection
- /** Details of the best selling products. */
- bestSellingProducts: ProductConnection
- /** Details of the featured products. */
- featuredProducts: ProductConnection
- /** A single product object with variant pricing overlay capabilities. */
- product?: Maybe
- /** Route for a node */
- route: Route
- /** Store settings. */
- settings?: Maybe
-}
-
-/** A site */
-export type SiteBrandsArgs = {
- before?: Maybe
- after?: Maybe
- first?: Maybe
- last?: Maybe
- productEntityIds?: Maybe>
-}
-
-/** A site */
-export type SiteProductsArgs = {
- before?: Maybe
- after?: Maybe
- first?: Maybe
- last?: Maybe
- ids?: Maybe>
- entityIds?: Maybe>
-}
-
-/** A site */
-export type SiteNewestProductsArgs = {
- before?: Maybe
- after?: Maybe
- first?: Maybe
- last?: Maybe
-}
-
-/** A site */
-export type SiteBestSellingProductsArgs = {
- before?: Maybe
- after?: Maybe
- first?: Maybe
- last?: Maybe
-}
-
-/** A site */
-export type SiteFeaturedProductsArgs = {
- before?: Maybe
- after?: Maybe
- first?: Maybe
- last?: Maybe
-}
-
-/** A site */
-export type SiteProductArgs = {
- id?: Maybe
- entityId?: Maybe
- variantEntityId?: Maybe
- optionValueIds?: Maybe>
- sku?: Maybe
-}
-
-/** A site */
-export type SiteRouteArgs = {
- path: Scalars['String']
-}
-
-/** Storefront Mode */
-export enum StorefrontStatusType {
- Launched = 'LAUNCHED',
- Maintenance = 'MAINTENANCE',
- PreLaunch = 'PRE_LAUNCH',
- Hibernation = 'HIBERNATION',
-}
-
-/** A swatch option value - swatch values can be associated with a list of hexidecimal colors or an image. */
-export type SwatchOptionValue = CatalogProductOptionValue & {
- __typename?: 'SwatchOptionValue'
- /** List of up to 3 hex encoded colors to associate with a swatch value. */
- hexColors: Array
- /** Absolute path of a swatch texture image. */
- imageUrl?: Maybe
- /** Unique ID for the option value. */
- entityId: Scalars['Int']
- /** Label for the option value. */
- label: Scalars['String']
- /** Indicates whether this value is the chosen default selected value. */
- isDefault: Scalars['Boolean']
-}
-
-/** A swatch option value - swatch values can be associated with a list of hexidecimal colors or an image. */
-export type SwatchOptionValueImageUrlArgs = {
- width: Scalars['Int']
- height?: Maybe
-}
-
-/** A single line text input field. */
-export type TextFieldOption = CatalogProductOption & {
- __typename?: 'TextFieldOption'
- /** Unique ID for the option. */
- entityId: Scalars['Int']
- /** Display name for the option. */
- displayName: Scalars['String']
- /** One of the option values is required to be selected for the checkout. */
- isRequired: Scalars['Boolean']
-}
-
-/** Url field */
-export type UrlField = {
- __typename?: 'UrlField'
- /** Store url. */
- vanityUrl: Scalars['String']
- /** CDN url to fetch assets. */
- cdnUrl: Scalars['String']
-}
-
-/** Variant */
-export type Variant = Node & {
- __typename?: 'Variant'
- /** The ID of an object */
- id: Scalars['ID']
- /** Id of the variant. */
- entityId: Scalars['Int']
- /** Sku of the variant. */
- sku: Scalars['String']
- /** The variant's weight. If a weight was not explicitly specified on the variant, this will be the product's weight. */
- weight?: Maybe
- /** The variant's height. If a height was not explicitly specified on the variant, this will be the product's height. */
- height?: Maybe
- /** The variant's width. If a width was not explicitly specified on the variant, this will be the product's width. */
- width?: Maybe
- /** The variant's depth. If a depth was not explicitly specified on the variant, this will be the product's depth. */
- depth?: Maybe
- /** The options which define a variant. */
- options: OptionConnection
- /** Product options that compose this variant. */
- productOptions: ProductOptionConnection
- /** Default image for a variant. */
- defaultImage?: Maybe
- /** Variant prices */
- prices?: Maybe
- /** Variant inventory */
- inventory?: Maybe
- /** Metafield data related to a variant. */
- metafields: MetafieldConnection
-}
-
-/** Variant */
-export type VariantOptionsArgs = {
- before?: Maybe
- after?: Maybe
- first?: Maybe
- last?: Maybe
-}
-
-/** Variant */
-export type VariantProductOptionsArgs = {
- before?: Maybe
- after?: Maybe
- first?: Maybe
- last?: Maybe
-}
-
-/** Variant */
-export type VariantPricesArgs = {
- includeTax?: Maybe
- currencyCode?: Maybe
-}
-
-/** Variant */
-export type VariantMetafieldsArgs = {
- namespace: Scalars['String']
- keys?: Maybe>
- before?: Maybe
- after?: Maybe
- first?: Maybe
- last?: Maybe
-}
-
-/** A connection to a list of items. */
-export type VariantConnection = {
- __typename?: 'VariantConnection'
- /** Information to aid in pagination. */
- pageInfo: PageInfo
- /** A list of edges. */
- edges?: Maybe>>
-}
-
-/** An edge in a connection. */
-export type VariantEdge = {
- __typename?: 'VariantEdge'
- /** The item at the end of the edge. */
- node: Variant
- /** A cursor for use in pagination. */
- cursor: Scalars['String']
-}
-
-/** Variant Inventory */
-export type VariantInventory = {
- __typename?: 'VariantInventory'
- /** Aggregated product variant inventory information. This data may not be available if not set or if the store's Inventory Settings have disabled displaying stock levels on the storefront. */
- aggregated?: Maybe
- /** Indicates whether this product is in stock. */
- isInStock: Scalars['Boolean']
- /** Inventory by locations. */
- byLocation?: Maybe
-}
-
-/** Variant Inventory */
-export type VariantInventoryByLocationArgs = {
- locationEntityIds?: Maybe>
- before?: Maybe
- after?: Maybe
- first?: Maybe
- last?: Maybe
-}
-
-/** Please select a currency */
-export enum CurrencyCode {
- Adp = 'ADP',
- Aed = 'AED',
- Afa = 'AFA',
- Afn = 'AFN',
- Alk = 'ALK',
- All = 'ALL',
- Amd = 'AMD',
- Ang = 'ANG',
- Aoa = 'AOA',
- Aok = 'AOK',
- Aon = 'AON',
- Aor = 'AOR',
- Ara = 'ARA',
- Arl = 'ARL',
- Arm = 'ARM',
- Arp = 'ARP',
- Ars = 'ARS',
- Ats = 'ATS',
- Aud = 'AUD',
- Awg = 'AWG',
- Azm = 'AZM',
- Azn = 'AZN',
- Bad = 'BAD',
- Bam = 'BAM',
- Ban = 'BAN',
- Bbd = 'BBD',
- Bdt = 'BDT',
- Bec = 'BEC',
- Bef = 'BEF',
- Bel = 'BEL',
- Bgl = 'BGL',
- Bgm = 'BGM',
- Bgn = 'BGN',
- Bgo = 'BGO',
- Bhd = 'BHD',
- Bif = 'BIF',
- Bmd = 'BMD',
- Bnd = 'BND',
- Bob = 'BOB',
- Bol = 'BOL',
- Bop = 'BOP',
- Bov = 'BOV',
- Brb = 'BRB',
- Brc = 'BRC',
- Bre = 'BRE',
- Brl = 'BRL',
- Brn = 'BRN',
- Brr = 'BRR',
- Brz = 'BRZ',
- Bsd = 'BSD',
- Btn = 'BTN',
- Buk = 'BUK',
- Bwp = 'BWP',
- Byb = 'BYB',
- Byr = 'BYR',
- Bzd = 'BZD',
- Cad = 'CAD',
- Cdf = 'CDF',
- Che = 'CHE',
- Chf = 'CHF',
- Chw = 'CHW',
- Cle = 'CLE',
- Clf = 'CLF',
- Clp = 'CLP',
- Cnx = 'CNX',
- Cny = 'CNY',
- Cop = 'COP',
- Cou = 'COU',
- Crc = 'CRC',
- Csd = 'CSD',
- Csk = 'CSK',
- Cve = 'CVE',
- Cyp = 'CYP',
- Czk = 'CZK',
- Ddm = 'DDM',
- Dem = 'DEM',
- Djf = 'DJF',
- Dkk = 'DKK',
- Dop = 'DOP',
- Dzd = 'DZD',
- Ecs = 'ECS',
- Ecv = 'ECV',
- Eek = 'EEK',
- Egp = 'EGP',
- Ern = 'ERN',
- Esa = 'ESA',
- Esb = 'ESB',
- Esp = 'ESP',
- Etb = 'ETB',
- Eur = 'EUR',
- Fim = 'FIM',
- Fjd = 'FJD',
- Fkp = 'FKP',
- Frf = 'FRF',
- Gbp = 'GBP',
- Gek = 'GEK',
- Gel = 'GEL',
- Ghc = 'GHC',
- Ghs = 'GHS',
- Gip = 'GIP',
- Gmd = 'GMD',
- Gnf = 'GNF',
- Gns = 'GNS',
- Gqe = 'GQE',
- Grd = 'GRD',
- Gtq = 'GTQ',
- Gwe = 'GWE',
- Gwp = 'GWP',
- Gyd = 'GYD',
- Hkd = 'HKD',
- Hnl = 'HNL',
- Hrd = 'HRD',
- Hrk = 'HRK',
- Htg = 'HTG',
- Huf = 'HUF',
- Idr = 'IDR',
- Iep = 'IEP',
- Ilp = 'ILP',
- Ilr = 'ILR',
- Ils = 'ILS',
- Inr = 'INR',
- Iqd = 'IQD',
- Isj = 'ISJ',
- Isk = 'ISK',
- Itl = 'ITL',
- Jmd = 'JMD',
- Jod = 'JOD',
- Jpy = 'JPY',
- Kes = 'KES',
- Kgs = 'KGS',
- Khr = 'KHR',
- Kmf = 'KMF',
- Krh = 'KRH',
- Kro = 'KRO',
- Krw = 'KRW',
- Kwd = 'KWD',
- Kyd = 'KYD',
- Kzt = 'KZT',
- Lak = 'LAK',
- Lbp = 'LBP',
- Lkr = 'LKR',
- Lrd = 'LRD',
- Lsl = 'LSL',
- Ltl = 'LTL',
- Ltt = 'LTT',
- Luc = 'LUC',
- Luf = 'LUF',
- Lul = 'LUL',
- Lvl = 'LVL',
- Lvr = 'LVR',
- Lyd = 'LYD',
- Mad = 'MAD',
- Maf = 'MAF',
- Mcf = 'MCF',
- Mdc = 'MDC',
- Mdl = 'MDL',
- Mga = 'MGA',
- Mgf = 'MGF',
- Mkd = 'MKD',
- Mkn = 'MKN',
- Mlf = 'MLF',
- Mmk = 'MMK',
- Mnt = 'MNT',
- Mop = 'MOP',
- Mro = 'MRO',
- Mtl = 'MTL',
- Mtp = 'MTP',
- Mur = 'MUR',
- Mvp = 'MVP',
- Mvr = 'MVR',
- Mwk = 'MWK',
- Mxn = 'MXN',
- Mxp = 'MXP',
- Mxv = 'MXV',
- Myr = 'MYR',
- Mze = 'MZE',
- Mzm = 'MZM',
- Mzn = 'MZN',
- Nad = 'NAD',
- Ngn = 'NGN',
- Nic = 'NIC',
- Nio = 'NIO',
- Nlg = 'NLG',
- Nok = 'NOK',
- Npr = 'NPR',
- Nzd = 'NZD',
- Omr = 'OMR',
- Pab = 'PAB',
- Pei = 'PEI',
- Pen = 'PEN',
- Pes = 'PES',
- Pgk = 'PGK',
- Php = 'PHP',
- Pkr = 'PKR',
- Pln = 'PLN',
- Plz = 'PLZ',
- Pte = 'PTE',
- Pyg = 'PYG',
- Qar = 'QAR',
- Rhd = 'RHD',
- Rol = 'ROL',
- Ron = 'RON',
- Rsd = 'RSD',
- Rub = 'RUB',
- Rur = 'RUR',
- Rwf = 'RWF',
- Sar = 'SAR',
- Sbd = 'SBD',
- Scr = 'SCR',
- Sdd = 'SDD',
- Sdg = 'SDG',
- Sdp = 'SDP',
- Sek = 'SEK',
- Sgd = 'SGD',
- Shp = 'SHP',
- Sit = 'SIT',
- Skk = 'SKK',
- Sll = 'SLL',
- Sos = 'SOS',
- Srd = 'SRD',
- Srg = 'SRG',
- Ssp = 'SSP',
- Std = 'STD',
- Sur = 'SUR',
- Svc = 'SVC',
- Syp = 'SYP',
- Szl = 'SZL',
- Thb = 'THB',
- Tjr = 'TJR',
- Tjs = 'TJS',
- Tmm = 'TMM',
- Tmt = 'TMT',
- Tnd = 'TND',
- Top = 'TOP',
- Tpe = 'TPE',
- Trl = 'TRL',
- Try = 'TRY',
- Ttd = 'TTD',
- Twd = 'TWD',
- Tzs = 'TZS',
- Uah = 'UAH',
- Uak = 'UAK',
- Ugs = 'UGS',
- Ugx = 'UGX',
- Usd = 'USD',
- Usn = 'USN',
- Uss = 'USS',
- Uyi = 'UYI',
- Uyp = 'UYP',
- Uyu = 'UYU',
- Uzs = 'UZS',
- Veb = 'VEB',
- Vef = 'VEF',
- Vnd = 'VND',
- Vnn = 'VNN',
- Vuv = 'VUV',
- Wst = 'WST',
- Xaf = 'XAF',
- Xcd = 'XCD',
- Xeu = 'XEU',
- Xfo = 'XFO',
- Xfu = 'XFU',
- Xof = 'XOF',
- Xpf = 'XPF',
- Xre = 'XRE',
- Ydd = 'YDD',
- Yer = 'YER',
- Yud = 'YUD',
- Yum = 'YUM',
- Yun = 'YUN',
- Yur = 'YUR',
- Zal = 'ZAL',
- Zar = 'ZAR',
- Zmk = 'ZMK',
- Zmw = 'ZMW',
- Zrn = 'ZRN',
- Zrz = 'ZRZ',
- Zwd = 'ZWD',
- Zwl = 'ZWL',
- Zwr = 'ZWR',
-}
-
-export type GetLoggedInCustomerQueryVariables = Exact<{ [key: string]: never }>
-
-export type GetLoggedInCustomerQuery = { __typename?: 'Query' } & {
- customer?: Maybe<
- { __typename?: 'Customer' } & Pick<
- Customer,
- | 'entityId'
- | 'firstName'
- | 'lastName'
- | 'email'
- | 'company'
- | 'customerGroupId'
- | 'notes'
- | 'phone'
- | 'addressCount'
- | 'attributeCount'
- > & {
- storeCredit: Array<
- { __typename?: 'Money' } & Pick
- >
- }
- >
-}
-
-export type CategoryTreeItemFragment = {
- __typename?: 'CategoryTreeItem'
-} & Pick<
- CategoryTreeItem,
- 'entityId' | 'name' | 'path' | 'description' | 'productCount'
->
-
-export type ProductPricesFragment = { __typename?: 'Prices' } & {
- price: { __typename?: 'Money' } & Pick