Gathering detailed insights and metrics for react-shopify-hooks
Gathering detailed insights and metrics for react-shopify-hooks
Collection of React hooks for interacting with the Shopify API
Installations
npm install react-shopify-hooksDeveloper Guide
BETA
Typescript
No
Module System
CommonJS
Releases
Unable to fetch releases
Languages
1
JavaScript
JavaScript (100%)
Developer
angeloashmore
Download Statistics
Total Downloads
2,831
Last Day
1
Last Week
3
Last Month
17
Last Year
261
GitHub Statistics
12 Stars
48 Commits
3 Forks
2 Watchers
3 Branches
1 Contributors
Updated on Feb 19, 2024
Bundle Size
227.16 kB
Minified
58.34 kB
Minified + Gzipped
Maintainers
1
Package Meta Information
Latest Version
0.3.2
Package Id
react-shopify-hooks@0.3.2
Unpacked Size
183.47 kB
Size
26.54 kB
File Count
14
Total Downloads
Cumulative downloads
Total Downloads
2,831
Last Day
0%
1
Compared to previous day
Last Week
-62.5%
3
Compared to previous week
Last Month
-22.7%
17
Compared to previous month
Last Year
25.5%
261
Compared to previous year
Weekly Downloads
Monthly Downloads
Yearly Downloads
Peer Dependencies
1
Dev Dependencies
24
@babel/core@babel/plugin-transform-runtime@babel/preset-env@babel/preset-react@commitlint/cli@commitlint/config-conventionalapollo-link-schemababel-corebabel-jestbabel-plugin-lodashgraphql-cligraphql-configgraphql-toolshuskyjestjest-transform-graphqlprettierreactreact-domreact-hooks-testing-libraryrimrafrolluprollup-plugin-babelstandard-version
react-shopify-hooks
Collection of React hooks for interacting with the Shopify API.
Status
Planning. Work on implemtation.
Install
1npm install --save react-shopify-hooks
API
ShopifyProvider
1<ShopifyProvider 2 shopName="your-shop-name" 3 storefrontAccessToken="your-access-token" 4> 5 {children} 6</ShopifyProvider>
Context provider for all Shopify hooks. Must be used at the root of your app.
useShopifyProduct
const { product, error } = useShopifyProduct(productId)
-
product
All product data for the provided product ID -
error
Error message if fetching product data failed
useShopifyProductVariant
const { productVariant, error } = useShopifyProductVariant(productId, productVariantId)
Fetches product variant data. Note that the parent product's ID is necessary.
Return Values
-
productVariant
All product variant data for the provided product variant ID -
error
Error message if fetching product variant data failed
useShopifyCustomerAccessToken
const { create, renew, delete } = useShopifyCustomerAccessToken()
Manages customer access token creation, renewal, and deletion.
Return Values
Object with the following properties.
-
create(email, password)
Create a new customer access token. Returns the token. -
renew(customerAccessToken)
Renew the customer access token. Returns the renewed token. -
delete(customerAccessToken)
Permanently delete the customer access token.
useShopifyCheckout
const { checkout, actions, error } = useShopifyCheckout(checkoutId?)
Fetches a checkout using the provided checkout ID and provides actions for that checkout.
If no checkout ID is provided, all actions except createCheckout will fail.
Example
1const ApplyDiscountButton = ({ discountCode }) => { 2 const { 3 actions: { discountCodeApply }, 4 } = useShopifyCheckout(myCheckoutId) 5 6 return ( 7 <button onClick={() => discountCodeApply(discountCode)}> 8 Instant savings! 9 </button> 10 ) 11}
Return Values
Object with the following properties.
-
checkout
All checkout data. Data updates on successful actions. -
actions
Collection of functions related to the product variant-
createCheckout()
Create a new checkout. Returns the checkout ID. -
attributesUpdate(attributes)
Update the checkout attributes. -
customerAssociate(customerAccessToken)
Associate the checkout to a customer. -
customerDisassociate()
Disssociate the checkout from any customer. -
discountCodeApply(code)
Apply a discount code to the checkout. -
discountCodeRemove()
Remove any discount code from the checkout. -
emailUpdate(email)
Update the checkout's email address. -
giftCardsAppend(codes)
Append gift card codes to the checkout. -
giftCardRemove(code)
Remove the gift card code from the checkout. -
lineItemsReplace(lineItems)
Replace the checkout line items. -
shippingAddressUpdate(address)
Update the checkout's shipping address. -
shippingLineUpdate(handle)
Update the checkout's shipping line.
-
-
error
Error message if fetching checkout data failed.
useShopifyCustomer
const { customer, actions, error } = useShopifyCustomer(customerAccessToken?)
Fetches a customer using the provided customer access token and provides actions for that customer.
If no customer access token is provided, all actions except createCustomer,
activateCustomer, recoverCustomer, resetCustomer, and
resetCustomerByUrl will fail.
Return Values
-
customer
All customer data for the provided customer access token. -
actions
Collection of functions related to the customer.-
createCustomer(email, password)
Create a new customer. -
activateCustomer(customerId, activationToken, password)
Activate a customer using the provided customer Id, activation token, and password. -
recoverCustomer(email)
Send a reset password email to the customer. -
resetCustomer(resetToken, password)
Reset a customer's password with the provided reset token and password. -
resetCustomerByUrl(resetUrl, password)
Reset a customer's password with the provided reset URL and password. -
addressCreate(address)
Add an address to the customer. -
addressDelete(addressId)
Delete a customer's address using the address ID. -
addressUpdate(id, address)
Update a customer's address using the address ID. -
addressDefaultAddressUpdate(addressId)
Set a default address for the customer. -
updateCustomer(attributes)
Update a customer's attributes.
-
-
error
Error message if fetching customer data failed
No vulnerabilities found.
Reason
no binaries found in the repo
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
Found 0/30 approved changesets -- score normalized to 0
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
license file not detected
Details
- Warn: project does not have a license file
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'master'
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 3 are checked with a SAST tool
Reason
89 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8
- Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
- Warn: Project is vulnerable to: GHSA-6chw-6frg-f759
- Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw
- Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
- Warn: Project is vulnerable to: GHSA-fwr7-v2mv-hh25
- Warn: Project is vulnerable to: GHSA-qwcr-r2fm-qrc7
- Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw
- Warn: Project is vulnerable to: GHSA-cwfw-4gq5-mrqx
- Warn: Project is vulnerable to: GHSA-g95f-p29q-9xw4
- Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
- Warn: Project is vulnerable to: GHSA-w8qv-6jwh-64r5
- Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x
- Warn: Project is vulnerable to: GHSA-7gc6-qh9x-w6h8
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
- Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq
- Warn: Project is vulnerable to: GHSA-h6ch-v84p-w6p9
- Warn: Project is vulnerable to: GHSA-ff7x-qrg7-qggm
- Warn: Project is vulnerable to: GHSA-rv95-896h-c2vc
- Warn: Project is vulnerable to: GHSA-qw6h-vgh9-j6wx
- Warn: Project is vulnerable to: GHSA-pfrx-2q88-qq97
- Warn: Project is vulnerable to: GHSA-4852-vrh7-28rf
- Warn: Project is vulnerable to: GHSA-q42p-pg8m-cqh6
- Warn: Project is vulnerable to: GHSA-w457-6q6x-cgp9
- Warn: Project is vulnerable to: GHSA-62gr-4qp9-h98f
- Warn: Project is vulnerable to: GHSA-f52g-6jhx-586p
- Warn: Project is vulnerable to: GHSA-2cf5-4w76-r9qv
- Warn: Project is vulnerable to: GHSA-3cqr-58rm-57f8
- Warn: Project is vulnerable to: GHSA-g9r4-xpmj-mj65
- Warn: Project is vulnerable to: GHSA-q2c6-c6pm-g3gh
- Warn: Project is vulnerable to: GHSA-765h-qjxv-5f44
- Warn: Project is vulnerable to: GHSA-f2jv-r9rf-7988
- Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj
- Warn: Project is vulnerable to: GHSA-pc5p-h8pf-mvwp
- Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37
- Warn: Project is vulnerable to: GHSA-2pr6-76vf-7546
- Warn: Project is vulnerable to: GHSA-8j8c-7jfh-h6hx
- Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
- Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
- Warn: Project is vulnerable to: GHSA-8cf7-32gw-wr33
- Warn: Project is vulnerable to: GHSA-hjrf-2m68-5959
- Warn: Project is vulnerable to: GHSA-qwph-4952-7xr6
- Warn: Project is vulnerable to: GHSA-6c8f-qphg-qjgp
- Warn: Project is vulnerable to: GHSA-jf85-cpcp-j695
- Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw
- Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9
- Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
- Warn: Project is vulnerable to: GHSA-4xc9-xhrj-v574
- Warn: Project is vulnerable to: GHSA-x5rq-j2xg-h7qm
- Warn: Project is vulnerable to: GHSA-4xcv-9jjx-gfj3
- Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
- Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
- Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m
- Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h
- Warn: Project is vulnerable to: GHSA-fhjf-83wg-r2j9
- Warn: Project is vulnerable to: GHSA-r683-j2x4-v87g
- Warn: Project is vulnerable to: GHSA-w7rc-rwvf-8q5r
- Warn: Project is vulnerable to: GHSA-5fw9-fq32-wv5p
- Warn: Project is vulnerable to: GHSA-28xh-wpgr-7fm8
- Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
- Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j
- Warn: Project is vulnerable to: GHSA-rhx6-c78j-4q9w
- Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
- Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
- Warn: Project is vulnerable to: GHSA-gcx4-mw62-g8wm
- Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
- Warn: Project is vulnerable to: GHSA-m6fv-jmcg-4jfg
- Warn: Project is vulnerable to: GHSA-cm22-4g7w-348p
- Warn: Project is vulnerable to: GHSA-4g88-fppr-53pp
- Warn: Project is vulnerable to: GHSA-4jqc-8m5r-9rpr
- Warn: Project is vulnerable to: GHSA-7xcx-6wjh-7xp2
- Warn: Project is vulnerable to: GHSA-38h8-x697-gh8q
- Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9
- Warn: Project is vulnerable to: GHSA-r628-mhmh-qjhw
- Warn: Project is vulnerable to: GHSA-9r2w-394v-53qc
- Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh
- Warn: Project is vulnerable to: GHSA-qq89-hq3f-393p
- Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
- Warn: Project is vulnerable to: GHSA-jgrx-mgxx-jf9v
- Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
- Warn: Project is vulnerable to: GHSA-7p7h-4mm5-852v
- Warn: Project is vulnerable to: GHSA-38fc-wpqx-33j7
- Warn: Project is vulnerable to: GHSA-v4rh-8p82-6h5w
- Warn: Project is vulnerable to: GHSA-qgmg-gppg-76g5
- Warn: Project is vulnerable to: GHSA-6fc8-4gx4-v693
- Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
- Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh
- Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp
Score
1.3
/10
Last Scanned on 2025-06-30
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More