Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Deprecation notices, migration guide and existing queries. #987

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
Open

Deprecation notices, migration guide and existing queries. #987

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
d809e6f
Deprecation: readme notice, jsdocs notice, migration guide
scottdixon May 17, 2024
c1fbba2
Equivalent queries
scottdixon May 20, 2024
c28cb1e
Remove changelog link
scottdixon Aug 26, 2024
4397b71
Remove changelog link
scottdixon Aug 26, 2024
d4c2e81
Remove changelog link
scottdixon Aug 26, 2024
853f552
Remove changelog link
scottdixon Aug 26, 2024
64816f9
Clarify existing queries
scottdixon Sep 26, 2024
2fbd0cb
Remove changelog link
scottdixon Sep 28, 2024
f76f21f
Update queries link
scottdixon Oct 1, 2024
0fa65e3
Update queries link
scottdixon Oct 1, 2024
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
9 changes: 5 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
# [Shopify](https://www.shopify.com) JavaScript Buy SDK
![Build](https://github.com/shopify/js-buy-sdk/actions/workflows/ci.yml/badge.svg)
> # Deprecation Notice
> The JS Buy SDK has been deprecated. We recommend migrating to the new [Storefront API Client](https://github.com/Shopify/shopify-app-js/tree/main/packages/api-clients/storefront-api-client#readme) by following the [migration guide](./migration-guide).

**Note**: For help with migrating from v0 of JS Buy SDK to v1 check out the
[Migration Guide](https://github.com/Shopify/js-buy-sdk/blob/main/tutorials/MIGRATION_GUIDE.md).
---

# Shopify JavaScript Buy SDK

The JS Buy SDK is a lightweight library that allows you to build ecommerce into
any website. It's based on Shopify's [Storefront API](https://help.shopify.com/api/storefront-api/getting-started)
Expand Down
34 changes: 30 additions & 4 deletions docs/CheckoutResource.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,39 @@
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
<style>
/* Hide the deprecation notice on the home page so we don't double up */
body.home blockquote:nth-of-type(1), body.home hr:nth-of-type(1) {
display: none;
}
/* Tidy headings */
section h1 {
margin-left: 0;
}
#deprecation-notice {
background-color: #fff9e3;
border: 1px solid #ff9900;
border-radius: 5px;
color: #333;
margin: 20px;
padding: 10px 20px;
font-family: Arial;
}
</style>
</head>

<body>
<body class="class: checkoutresource">



<div id="main">
<div id="deprecation-notice">
<strong>The JS Buy SDK has been deprecated.</strong> For more information, please see the <a href="https://github.com/Shopify/js-buy-sdk/blob/main/migration-guide" target="_blank">migration guide</a>.
</div>

<h1 class="page-title">Class: CheckoutResource</h1>

<h1 class="page-title">Class: CheckoutResource</h1>




Expand Down Expand Up @@ -3026,13 +3052,13 @@ <h5>Example</h5>
</div>

<nav>
<h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="ImageHelpers.html">ImageHelpers</a></li><li><a href="ProductHelpers.html">ProductHelpers</a></li></ul><h3>Classes</h3><ul><li><a href="CheckoutResource.html">CheckoutResource</a></li><li><a href="Client.html">Client</a></li><li><a href="CollectionResource.html">CollectionResource</a></li><li><a href="Config.html">Config</a></li><li><a href="ImageResource.html">ImageResource</a></li><li><a href="ProductResource.html">ProductResource</a></li><li><a href="ShopResource.html">ShopResource</a></li></ul><h3>Tutorials</h3><ul><li><a href="tutorial-MIGRATION_GUIDE.html">MIGRATION_GUIDE</a></li></ul>
<h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="ImageHelpers.html">ImageHelpers</a></li><li><a href="ProductHelpers.html">ProductHelpers</a></li></ul><h3>Classes</h3><ul><li><a href="CheckoutResource.html">CheckoutResource</a></li><li><a href="Client.html">Client</a></li><li><a href="CollectionResource.html">CollectionResource</a></li><li><a href="Config.html">Config</a></li><li><a href="ImageResource.html">ImageResource</a></li><li><a href="ProductResource.html">ProductResource</a></li><li><a href="ShopResource.html">ShopResource</a></li></ul>
</nav>

<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Wed May 01 2024 10:19:56 GMT-0400 (Eastern Daylight Time)
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Tue Aug 27 2024 09:18:02 GMT+1000 (Australian Eastern Standard Time)
</footer>

<script> prettyPrint(); </script>
Expand Down
34 changes: 30 additions & 4 deletions docs/Client.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,39 @@
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
<style>
/* Hide the deprecation notice on the home page so we don't double up */
body.home blockquote:nth-of-type(1), body.home hr:nth-of-type(1) {
display: none;
}
/* Tidy headings */
section h1 {
margin-left: 0;
}
#deprecation-notice {
background-color: #fff9e3;
border: 1px solid #ff9900;
border-radius: 5px;
color: #333;
margin: 20px;
padding: 10px 20px;
font-family: Arial;
}
</style>
</head>

<body>
<body class="class: client">



<div id="main">
<div id="deprecation-notice">
<strong>The JS Buy SDK has been deprecated.</strong> For more information, please see the <a href="https://github.com/Shopify/js-buy-sdk/blob/main/migration-guide" target="_blank">migration guide</a>.
</div>

<h1 class="page-title">Class: Client</h1>

<h1 class="page-title">Class: Client</h1>




Expand Down Expand Up @@ -621,13 +647,13 @@ <h5>Example</h5>
</div>

<nav>
<h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="ImageHelpers.html">ImageHelpers</a></li><li><a href="ProductHelpers.html">ProductHelpers</a></li></ul><h3>Classes</h3><ul><li><a href="CheckoutResource.html">CheckoutResource</a></li><li><a href="Client.html">Client</a></li><li><a href="CollectionResource.html">CollectionResource</a></li><li><a href="Config.html">Config</a></li><li><a href="ImageResource.html">ImageResource</a></li><li><a href="ProductResource.html">ProductResource</a></li><li><a href="ShopResource.html">ShopResource</a></li></ul><h3>Tutorials</h3><ul><li><a href="tutorial-MIGRATION_GUIDE.html">MIGRATION_GUIDE</a></li></ul>
<h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="ImageHelpers.html">ImageHelpers</a></li><li><a href="ProductHelpers.html">ProductHelpers</a></li></ul><h3>Classes</h3><ul><li><a href="CheckoutResource.html">CheckoutResource</a></li><li><a href="Client.html">Client</a></li><li><a href="CollectionResource.html">CollectionResource</a></li><li><a href="Config.html">Config</a></li><li><a href="ImageResource.html">ImageResource</a></li><li><a href="ProductResource.html">ProductResource</a></li><li><a href="ShopResource.html">ShopResource</a></li></ul>
</nav>

<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Wed May 01 2024 10:19:56 GMT-0400 (Eastern Daylight Time)
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Tue Aug 27 2024 09:18:02 GMT+1000 (Australian Eastern Standard Time)
</footer>

<script> prettyPrint(); </script>
Expand Down
34 changes: 30 additions & 4 deletions docs/CollectionResource.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,39 @@
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
<style>
/* Hide the deprecation notice on the home page so we don't double up */
body.home blockquote:nth-of-type(1), body.home hr:nth-of-type(1) {
display: none;
}
/* Tidy headings */
section h1 {
margin-left: 0;
}
#deprecation-notice {
background-color: #fff9e3;
border: 1px solid #ff9900;
border-radius: 5px;
color: #333;
margin: 20px;
padding: 10px 20px;
font-family: Arial;
}
</style>
</head>

<body>
<body class="class: collectionresource">



<div id="main">
<div id="deprecation-notice">
<strong>The JS Buy SDK has been deprecated.</strong> For more information, please see the <a href="https://github.com/Shopify/js-buy-sdk/blob/main/migration-guide" target="_blank">migration guide</a>.
</div>

<h1 class="page-title">Class: CollectionResource</h1>

<h1 class="page-title">Class: CollectionResource</h1>




Expand Down Expand Up @@ -1272,13 +1298,13 @@ <h5>Example</h5>
</div>

<nav>
<h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="ImageHelpers.html">ImageHelpers</a></li><li><a href="ProductHelpers.html">ProductHelpers</a></li></ul><h3>Classes</h3><ul><li><a href="CheckoutResource.html">CheckoutResource</a></li><li><a href="Client.html">Client</a></li><li><a href="CollectionResource.html">CollectionResource</a></li><li><a href="Config.html">Config</a></li><li><a href="ImageResource.html">ImageResource</a></li><li><a href="ProductResource.html">ProductResource</a></li><li><a href="ShopResource.html">ShopResource</a></li></ul><h3>Tutorials</h3><ul><li><a href="tutorial-MIGRATION_GUIDE.html">MIGRATION_GUIDE</a></li></ul>
<h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="ImageHelpers.html">ImageHelpers</a></li><li><a href="ProductHelpers.html">ProductHelpers</a></li></ul><h3>Classes</h3><ul><li><a href="CheckoutResource.html">CheckoutResource</a></li><li><a href="Client.html">Client</a></li><li><a href="CollectionResource.html">CollectionResource</a></li><li><a href="Config.html">Config</a></li><li><a href="ImageResource.html">ImageResource</a></li><li><a href="ProductResource.html">ProductResource</a></li><li><a href="ShopResource.html">ShopResource</a></li></ul>
</nav>

<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Wed May 01 2024 10:19:56 GMT-0400 (Eastern Daylight Time)
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Tue Aug 27 2024 09:18:02 GMT+1000 (Australian Eastern Standard Time)
</footer>

<script> prettyPrint(); </script>
Expand Down
34 changes: 30 additions & 4 deletions docs/Config.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,39 @@
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
<style>
/* Hide the deprecation notice on the home page so we don't double up */
body.home blockquote:nth-of-type(1), body.home hr:nth-of-type(1) {
display: none;
}
/* Tidy headings */
section h1 {
margin-left: 0;
}
#deprecation-notice {
background-color: #fff9e3;
border: 1px solid #ff9900;
border-radius: 5px;
color: #333;
margin: 20px;
padding: 10px 20px;
font-family: Arial;
}
</style>
</head>

<body>
<body class="class: config">



<div id="main">
<div id="deprecation-notice">
<strong>The JS Buy SDK has been deprecated.</strong> For more information, please see the <a href="https://github.com/Shopify/js-buy-sdk/blob/main/migration-guide" target="_blank">migration guide</a>.
</div>

<h1 class="page-title">Class: Config</h1>

<h1 class="page-title">Class: Config</h1>




Expand Down Expand Up @@ -276,13 +302,13 @@ <h6>Properties</h6>
</div>

<nav>
<h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="ImageHelpers.html">ImageHelpers</a></li><li><a href="ProductHelpers.html">ProductHelpers</a></li></ul><h3>Classes</h3><ul><li><a href="CheckoutResource.html">CheckoutResource</a></li><li><a href="Client.html">Client</a></li><li><a href="CollectionResource.html">CollectionResource</a></li><li><a href="Config.html">Config</a></li><li><a href="ImageResource.html">ImageResource</a></li><li><a href="ProductResource.html">ProductResource</a></li><li><a href="ShopResource.html">ShopResource</a></li></ul><h3>Tutorials</h3><ul><li><a href="tutorial-MIGRATION_GUIDE.html">MIGRATION_GUIDE</a></li></ul>
<h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="ImageHelpers.html">ImageHelpers</a></li><li><a href="ProductHelpers.html">ProductHelpers</a></li></ul><h3>Classes</h3><ul><li><a href="CheckoutResource.html">CheckoutResource</a></li><li><a href="Client.html">Client</a></li><li><a href="CollectionResource.html">CollectionResource</a></li><li><a href="Config.html">Config</a></li><li><a href="ImageResource.html">ImageResource</a></li><li><a href="ProductResource.html">ProductResource</a></li><li><a href="ShopResource.html">ShopResource</a></li></ul>
</nav>

<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Wed May 01 2024 10:19:56 GMT-0400 (Eastern Daylight Time)
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Tue Aug 27 2024 09:18:02 GMT+1000 (Australian Eastern Standard Time)
</footer>

<script> prettyPrint(); </script>
Expand Down
34 changes: 30 additions & 4 deletions docs/ImageHelpers.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,39 @@
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
<style>
/* Hide the deprecation notice on the home page so we don't double up */
body.home blockquote:nth-of-type(1), body.home hr:nth-of-type(1) {
display: none;
}
/* Tidy headings */
section h1 {
margin-left: 0;
}
#deprecation-notice {
background-color: #fff9e3;
border: 1px solid #ff9900;
border-radius: 5px;
color: #333;
margin: 20px;
padding: 10px 20px;
font-family: Arial;
}
</style>
</head>

<body>
<body class="namespace: imagehelpers">



<div id="main">
<div id="deprecation-notice">
<strong>The JS Buy SDK has been deprecated.</strong> For more information, please see the <a href="https://github.com/Shopify/js-buy-sdk/blob/main/migration-guide" target="_blank">migration guide</a>.
</div>

<h1 class="page-title">Namespace: ImageHelpers</h1>

<h1 class="page-title">Namespace: ImageHelpers</h1>




Expand Down Expand Up @@ -379,13 +405,13 @@ <h5>Example</h5>
</div>

<nav>
<h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="ImageHelpers.html">ImageHelpers</a></li><li><a href="ProductHelpers.html">ProductHelpers</a></li></ul><h3>Classes</h3><ul><li><a href="CheckoutResource.html">CheckoutResource</a></li><li><a href="Client.html">Client</a></li><li><a href="CollectionResource.html">CollectionResource</a></li><li><a href="Config.html">Config</a></li><li><a href="ImageResource.html">ImageResource</a></li><li><a href="ProductResource.html">ProductResource</a></li><li><a href="ShopResource.html">ShopResource</a></li></ul><h3>Tutorials</h3><ul><li><a href="tutorial-MIGRATION_GUIDE.html">MIGRATION_GUIDE</a></li></ul>
<h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="ImageHelpers.html">ImageHelpers</a></li><li><a href="ProductHelpers.html">ProductHelpers</a></li></ul><h3>Classes</h3><ul><li><a href="CheckoutResource.html">CheckoutResource</a></li><li><a href="Client.html">Client</a></li><li><a href="CollectionResource.html">CollectionResource</a></li><li><a href="Config.html">Config</a></li><li><a href="ImageResource.html">ImageResource</a></li><li><a href="ProductResource.html">ProductResource</a></li><li><a href="ShopResource.html">ShopResource</a></li></ul>
</nav>

<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Wed May 01 2024 10:19:56 GMT-0400 (Eastern Daylight Time)
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Tue Aug 27 2024 09:18:02 GMT+1000 (Australian Eastern Standard Time)
</footer>

<script> prettyPrint(); </script>
Expand Down
34 changes: 30 additions & 4 deletions docs/ImageResource.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,39 @@
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
<style>
/* Hide the deprecation notice on the home page so we don't double up */
body.home blockquote:nth-of-type(1), body.home hr:nth-of-type(1) {
display: none;
}
/* Tidy headings */
section h1 {
margin-left: 0;
}
#deprecation-notice {
background-color: #fff9e3;
border: 1px solid #ff9900;
border-radius: 5px;
color: #333;
margin: 20px;
padding: 10px 20px;
font-family: Arial;
}
</style>
</head>

<body>
<body class="class: imageresource">



<div id="main">
<div id="deprecation-notice">
<strong>The JS Buy SDK has been deprecated.</strong> For more information, please see the <a href="https://github.com/Shopify/js-buy-sdk/blob/main/migration-guide" target="_blank">migration guide</a>.
</div>

<h1 class="page-title">Class: ImageResource</h1>

<h1 class="page-title">Class: ImageResource</h1>




Expand Down Expand Up @@ -155,13 +181,13 @@ <h4 class="name" id="ImageResource"><span class="type-signature"></span>new Imag
</div>

<nav>
<h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="ImageHelpers.html">ImageHelpers</a></li><li><a href="ProductHelpers.html">ProductHelpers</a></li></ul><h3>Classes</h3><ul><li><a href="CheckoutResource.html">CheckoutResource</a></li><li><a href="Client.html">Client</a></li><li><a href="CollectionResource.html">CollectionResource</a></li><li><a href="Config.html">Config</a></li><li><a href="ImageResource.html">ImageResource</a></li><li><a href="ProductResource.html">ProductResource</a></li><li><a href="ShopResource.html">ShopResource</a></li></ul><h3>Tutorials</h3><ul><li><a href="tutorial-MIGRATION_GUIDE.html">MIGRATION_GUIDE</a></li></ul>
<h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="ImageHelpers.html">ImageHelpers</a></li><li><a href="ProductHelpers.html">ProductHelpers</a></li></ul><h3>Classes</h3><ul><li><a href="CheckoutResource.html">CheckoutResource</a></li><li><a href="Client.html">Client</a></li><li><a href="CollectionResource.html">CollectionResource</a></li><li><a href="Config.html">Config</a></li><li><a href="ImageResource.html">ImageResource</a></li><li><a href="ProductResource.html">ProductResource</a></li><li><a href="ShopResource.html">ShopResource</a></li></ul>
</nav>

<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Wed May 01 2024 10:19:56 GMT-0400 (Eastern Daylight Time)
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Tue Aug 27 2024 09:18:02 GMT+1000 (Australian Eastern Standard Time)
</footer>

<script> prettyPrint(); </script>
Expand Down
Loading
Loading