Skip to content
This repository was archived by the owner on Oct 20, 2026. It is now read-only.
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
72 commits
Select commit Hold shift + click to select a range
c907358
Bug Fix Round and Updates (#719)
okbel Mar 24, 2022
5c0e1ab
Import config with POSIX path (#728)
markuslewin Apr 13, 2022
3c3a6a7
chore(docs): update .env.template provider names (#721)
Shaffan Apr 13, 2022
bba8429
Initial commit
vanguyen28 Apr 6, 2022
e3ad683
Initial api integration
vanguyen28 Apr 13, 2022
0065566
Add get-all-products operator
vanguyen28 Apr 14, 2022
2701b30
Modify env template
vanguyen28 Apr 18, 2022
ce31d86
Finish get-all-products operators
vanguyen28 Apr 18, 2022
f1e0c95
chore: add prettier vscode settings (#735)
dominiksipowicz Apr 19, 2022
31a283a
docs(core): how to run locally (#716)
dominiksipowicz Apr 19, 2022
8eda86a
Add get-site-info operator
vanguyen28 Apr 20, 2022
29b0e06
Add get-all-pages operator
vanguyen28 Apr 20, 2022
5de4e77
Add get-page operator
vanguyen28 Apr 21, 2022
049c7f4
Add dummy endpoints
vanguyen28 Apr 21, 2022
b9e5f90
SFCC provider (#727)
dominiksipowicz Apr 20, 2022
4ce5bc3
issue templates (#733)
dominiksipowicz Apr 20, 2022
0a46c31
Add opencommerce dependencies
vanguyen28 Apr 21, 2022
79b6590
Update api endpoint
vanguyen28 Apr 21, 2022
2401a42
Add use-search hooks
vanguyen28 Apr 25, 2022
f37244c
chore: add prettier vscode settings (#735)
dominiksipowicz Apr 19, 2022
b008f63
SFCC provider (#727)
dominiksipowicz Apr 20, 2022
999dae2
Remove console log
vanguyen28 Apr 26, 2022
f5f8d7b
Fix some broken types
vanguyen28 Apr 26, 2022
50f99e9
Merge branch 'main' of https://github.com/reactioncommerce/commerce i…
vanguyen28 Apr 26, 2022
1b2904a
Add cart endpoints/handlers
vanguyen28 Apr 27, 2022
7d1b542
Complete use-cart hook
vanguyen28 Apr 28, 2022
2a32beb
Fix typescript errors & normalize cart
vanguyen28 Apr 28, 2022
735b0ed
Small refactor
vanguyen28 Apr 29, 2022
054ac1d
Modify env for supporting image optimization
vanguyen28 Apr 29, 2022
dd3efaa
Fix undefined _id
vanguyen28 Apr 29, 2022
4c4f49c
Update add multiple variant items logic
vanguyen28 May 3, 2022
3743982
Merge branch 'main' of https://github.com/reactioncommerce/commerce i…
vanguyen28 May 3, 2022
fc05c0b
Fix typescript
vanguyen28 May 3, 2022
1090294
Fix typescript issue
vanguyen28 May 3, 2022
94a145b
Add custome checkout function
vanguyen28 May 8, 2022
55cb764
Merge branch 'main' of https://github.com/reactioncommerce/commerce i…
vanguyen28 May 10, 2022
250e03f
Add README file
vanguyen28 May 10, 2022
50109be
Add default value for checkout fields
vanguyen28 May 11, 2022
8d19c79
Custom Navigation
vanguyen28 May 15, 2022
0e160cc
Remove unused function
vanguyen28 May 15, 2022
0f199bb
Remove console.log
vanguyen28 May 15, 2022
80f2b72
Use example payment method plugin for demo site
vanguyen28 May 16, 2022
9bbd1b2
Update README file
vanguyen28 May 16, 2022
630b4ba
Polish checkout view
vanguyen28 May 17, 2022
d6b47ca
Fix typing
vanguyen28 May 17, 2022
66bffe9
Merge branch 'main' of https://github.com/reactioncommerce/commerce i…
vanguyen28 May 18, 2022
c909152
Update dependency
vanguyen28 May 18, 2022
237a207
Minor fixes for checkout view
vanguyen28 May 18, 2022
499b33d
Update new commerce provider info
vanguyen28 May 18, 2022
3bf6ba1
Change API endpoint
vanguyen28 May 19, 2022
401d662
Update Readme
vanguyen28 May 19, 2022
faae6a1
Add Open Commerce Provider
vanguyen28 May 19, 2022
67b2629
Fix build failed on local package
vanguyen28 May 19, 2022
a29bb6f
Merge pull request #5 from reactioncommerce/open-commerce
vanguyen28 May 19, 2022
cd145b0
Fix failed build for local package
vanguyen28 May 19, 2022
2baf172
Merge pull request #6 from reactioncommerce/fix-failed-build
vanguyen28 May 19, 2022
a84e526
Fix typing error
vanguyen28 May 19, 2022
1cfca94
Merge pull request #7 from reactioncommerce/fix-failed-build
vanguyen28 May 19, 2022
eca79f8
Normalize custom navigation url (#8)
vanguyen28 May 31, 2022
c92eac4
Fix build failed for all providers (#9)
vanguyen28 May 31, 2022
1f2634a
Merge remote-tracking branch 'upstream/main'
vanguyen28 Mar 8, 2023
611a18b
Fix/opencommerce provider (#10)
vanguyen28 Mar 9, 2023
12f9e5c
fix missing dependency
vanguyen28 Mar 9, 2023
672de88
fix pnpm-lock file
vanguyen28 Mar 9, 2023
7184db6
add lodash dependency
vanguyen28 Mar 9, 2023
1fefa1c
add js-cookie
vanguyen28 Mar 9, 2023
1de2d25
add types for js-cookie
vanguyen28 Mar 9, 2023
381d4a9
add missing types to site
vanguyen28 Mar 9, 2023
c2fa21c
some minor fixes to other providers
vanguyen28 Mar 10, 2023
ea7714d
fix build failed in vendor
vanguyen28 Mar 10, 2023
2fd671e
fix typescript
vanguyen28 Mar 10, 2023
1b20512
update readme
vanguyen28 Mar 10, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"editor.defaultFormatter": "esbenp.prettier-vscode",
"editor.formatOnSave": true
}
}
16 changes: 2 additions & 14 deletions packages/bigcommerce/src/checkout/use-checkout.tsx
Original file line number Diff line number Diff line change
@@ -1,14 +1,2 @@
import { SWRHook } from '@vercel/commerce/utils/types'
import useCheckout, { UseCheckout } from '@vercel/commerce/checkout/use-checkout'

export default useCheckout as UseCheckout<typeof handler>

export const handler: SWRHook<any> = {
fetchOptions: {
query: '',
},
async fetcher({ input, options, fetch }) {},
useHook:
({ useData }) =>
async (input) => ({}),
}
export * from '@vercel/commerce/checkout/use-checkout'
export { default } from '@vercel/commerce/checkout/use-checkout'
2 changes: 2 additions & 0 deletions packages/bigcommerce/src/checkout/use-submit-checkout.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
export * from '@vercel/commerce/checkout/use-submit-checkout'
export { default } from '@vercel/commerce/checkout/use-submit-checkout'
2 changes: 2 additions & 0 deletions packages/bigcommerce/src/customer/address/use-update-item.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
export * from '@vercel/commerce/customer/address/use-update-item'
export { default } from '@vercel/commerce/customer/address/use-update-item'
3 changes: 2 additions & 1 deletion packages/commerce/new-provider.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@ A commerce provider is a headless e-commerce platform that integrates with the [
- Kibo Commerce ([packages/kibocommerce](../kibocommerce))
- Commerce.js ([packages/commercejs](../commercejs))
- SFCC - SalesForce Cloud Commerce ([packages/sfcc](../sfcc))

- Mailchimp Open Commerce ([packages/opencommerce](../opencommerce))
-
Adding a commerce provider means adding a new folder in `packages` with a folder structure like the next one:

- `src`
Expand Down
14 changes: 14 additions & 0 deletions packages/commerce/src/types/checkout.ts
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,20 @@ export interface Checkout {
* List of items in the checkout.
*/
lineItems?: LineItem[]

/**
* List of available shipping methods
*/
shippingMethods?: {
id: string
fee: string
name: string
}[]

/**
* The unique identifier of the shipping method that the customer has selected.
*/
selectedShippingMethodId?: string
}

export interface CheckoutBody {
Expand Down
3 changes: 3 additions & 0 deletions packages/commerce/src/types/site.ts
Original file line number Diff line number Diff line change
Expand Up @@ -40,12 +40,15 @@ export interface Brand {
path: string
}

export type Navigation = any

/**
* Operation to get site information. This includes categories and brands.
*/
export type GetSiteInfoOperation = {
data: {
categories: Category[]
brands: Brand[]
navigation?: Navigation[]
}
}
2 changes: 2 additions & 0 deletions packages/commercejs/src/customer/address/use-update-item.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
export * from '@vercel/commerce/customer/address/use-update-item'
export { default } from '@vercel/commerce/customer/address/use-update-item'
16 changes: 2 additions & 14 deletions packages/kibocommerce/src/checkout/use-checkout.tsx
Original file line number Diff line number Diff line change
@@ -1,14 +1,2 @@
import { SWRHook } from '@vercel/commerce/utils/types'
import useCheckout, { UseCheckout } from '@vercel/commerce/checkout/use-checkout'

export default useCheckout as UseCheckout<typeof handler>

export const handler: SWRHook<any> = {
fetchOptions: {
query: '',
},
async fetcher({ input, options, fetch }) {},
useHook:
({ useData }) =>
async (input) => ({}),
}
export * from '@vercel/commerce/checkout/use-checkout'
export { default } from '@vercel/commerce/checkout/use-checkout'
2 changes: 2 additions & 0 deletions packages/kibocommerce/src/checkout/use-submit-checkout.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
export * from '@vercel/commerce/checkout/use-submit-checkout'
export { default } from '@vercel/commerce/checkout/use-submit-checkout'
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
export * from '@vercel/commerce/customer/address/use-update-item'
export { default } from '@vercel/commerce/customer/address/use-update-item'
2 changes: 2 additions & 0 deletions packages/local/src/checkout/use-submit-checkout.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
export * from '@vercel/commerce/checkout/use-submit-checkout'
export { default } from '@vercel/commerce/checkout/use-submit-checkout'
2 changes: 2 additions & 0 deletions packages/local/src/customer/address/use-update-item.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
export * from '@vercel/commerce/customer/address/use-update-item'
export { default } from '@vercel/commerce/customer/address/use-update-item'
4 changes: 4 additions & 0 deletions packages/opencommerce/.env.template
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
COMMERCE_PROVIDER=@vercel/commerce-opencommerce

NEXT_PUBLIC_OPENCOMMERCE_API_URL=
NEXT_PUBLIC_OPENCOMMERCE_IMAGE_DOMAIN=
2 changes: 2 additions & 0 deletions packages/opencommerce/.prettierignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
node_modules
dist
6 changes: 6 additions & 0 deletions packages/opencommerce/.prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"semi": false,
"singleQuote": true,
"tabWidth": 2,
"useTabs": false
}
53 changes: 53 additions & 0 deletions packages/opencommerce/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
## Open Commerce Provider

**Preview:** https://commerce-pinkcloudvnn.vercel.app/

We are using this admin interface for demo: https://admin.open-commerce.io/
Storefront API URL: https://api.open-commerce.io/graphql

## Available Features

- Cart
- Search
- Custom Checkout
- Custom Navigation

## Steps to get started:

1. Duplicate `site/.env.template` and rename it to `site/.env.local`
2. Setup env variables related to open commerce provider, something looks like this:

```
COMMERCE_PROVIDER=@vercel/commerce-opencommerce
NEXT_PUBLIC_OPENCOMMERCE_API_URL=http://api.open-commerce.io/graphql
NEXT_PUBLIC_OPENCOMMERCE_IMAGE_DOMAIN=api.open-commerce.io
```

3. Run `pnpm install` and `cd site & pnpm dev` in the root folder

### Troubleshoot

https://github.com/reactioncommerce/commerce#troubleshoot

For more information about the repository, check out the README file here: https://github.com/reactioncommerce/commerce

## Custom Checkouts

The demo site use [Example Payment Plugin](https://github.com/reactioncommerce/api-plugin-payments-example) for processing payments. To make the checkout flow works as expected, some prerequisite steps need to be handled:

- Add and enable at least one flat-rate shipping option in the admin setting page. By default, we select the first shipping option to create the order
- Enable the `IOU Example` payment method in the admin setting page
- Fill in all the required fields in the `Add Shipping Address` step in the storefront
- After processing checkout, check the orders page in the admin interface to confirm the order has been successfully created

We can also use `Stripe` as the default payment method by following steps:

- Add and enable at least one flat-rate shipping option in the admin setting page. By default, we select the first shipping option to create the order
- Enable the `Stripe (SCA)` payment method in the admin setting page
- Add `OPENCOMMERCE_STRIPE_PUBLIC_API_KEY` env variable to the `site/.env.local` file
- Add `STRIPE_API_KEY` env variable to reaction API `.env` file with the private API key from Stripe
- Modify the `submit-checkout` api endpoint to include additional steps for Stripe payment (eg: create/confirm payment intent, pass payment intent id to placeOrder request body,...).

## Custom Navigation

By default NextJS only display two categories/tags of products in the navbar. This feature enables us to show the organized categories/tags as navigation in the admin to our storefront. Also we can leverage this feature to show URLs that are not relative to the shop (eg: admin page, documentation page, ...). This feature is enabled by default, we can turn it off anytime by modify the value in the `commerce.config.json` file.
22 changes: 22 additions & 0 deletions packages/opencommerce/codegen.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
{
"overwrite": true,
"schema": "http://api.open-commerce.io/graphql",
"documents": [
{
"./src/api/**/*.ts": {
"noRequire": true
}
}
],
"generates": {
"./schema.d.ts": {
"plugins": ["typescript", "typescript-operations"]
},
"./schema.graphql": {
"plugins": ["schema-ast"]
}
},
"hooks": {
"afterAllFileWrite": ["prettier --write"]
}
}
1 change: 1 addition & 0 deletions packages/opencommerce/global.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
declare module '@components/checkout/context'
86 changes: 86 additions & 0 deletions packages/opencommerce/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
{
"name": "@vercel/commerce-opencommerce",
"version": "0.0.1",
"license": "MIT",
"scripts": {
"release": "taskr release",
"build": "taskr build",
"dev": "taskr",
"types": "tsc --emitDeclarationOnly",
"prettier-fix": "prettier --write .",
"generate": "graphql-codegen --config codegen.json"
},
"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"
],
"next.config": [
"dist/next.config.d.cts"
]
}
}
},
"dependencies": {
"@vercel/commerce": "workspace:*",
"cookie": "^0.4.1",
"lodash.debounce": "^4.0.8",
"js-cookie": "^3.0.1"
},
"peerDependencies": {
"next": "^13",
"react": "^18",
"react-dom": "^18"
},
"devDependencies": {
"@graphql-codegen/cli": "2.7.0",
"@graphql-codegen/schema-ast": "^2.4.1",
"@graphql-codegen/typescript": "^2.6.0",
"@graphql-codegen/typescript-operations": "^2.4.3",
"@taskr/clear": "^1.1.0",
"@taskr/esnext": "^1.1.0",
"@taskr/watch": "^1.1.0",
"@types/lodash.debounce": "^4.0.6",
"@types/node": "^18.0.3",
"@types/react": "^18.0.14",
"@types/cookie": "^0.4.1",
"@types/js-cookie": "^3.0.1",
"prettier": "^2.7.1",
"react-dom": "^18.2.0",
"taskr": "^1.1.0",
"taskr-swc": "workspace:*",
"typescript": "^4.7.4"
},
"lint-staged": {
"**/*.{js,jsx,ts,tsx,json}": [
"prettier --write",
"git add"
]
}
}
Loading