@shopify/shopify-app-remix 4.0.1 → 4.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -5,8 +5,15 @@
5
5
  [![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE.md)
6
6
  [![npm version](https://badge.fury.io/js/%40shopify%2Fshopify-app-remix.svg)](https://badge.fury.io/js/%40shopify%2Fshopify-app-remix)
7
7
 
8
- This package makes it easy to use [Remix](https://remix.run/) to build Shopify apps.
9
- It builds on the `@shopify/shopify-api` package and exposes a `shopifyApp` function. You can use `shopifyApp` to configure your app and then authenticate requests from Shopify.
8
+ This package makes it easy to use [Remix](https://remix.run/) to build Shopify apps.
9
+
10
+ ## Upgrade to React Router
11
+
12
+ You should only use this Remix package if you have an existing Remix app and have not yet upgraded.
13
+
14
+ If you are building a new Shopify app you should use React Router and not Remix. Please see the [Quick start guide for React Router](https://github.com/Shopify/shopify-app-template-react-router?tab=readme-ov-file#quick-start).
15
+
16
+ If you already have a Remix app, you should upgrade to React Router. Please see the [Upgrading to React Router guide](https://github.com/Shopify/shopify-app-template-react-router/wiki/Upgrading-from-Remix).
10
17
 
11
18
  Visit the [`shopify.dev` documentation](https://shopify.dev/docs/api/shopify-app-remix) for more details on the Remix app package.
12
19
 
@@ -75,7 +82,7 @@ SHOPIFY_API_SECRET="[Copy from partners dashboard]"
75
82
  SHOPIFY_APP_URL="[The tunnel URL you are using to run your app]"
76
83
  ```
77
84
 
78
- `shopifyApp` needs to reserve a [splat route](https://remix.run/docs/en/main/guides/routing#splats) for auth.
85
+ `shopifyApp` needs to reserve a [splat route](https://v2.remix.run/docs/file-conventions/routes#splat-routes) for auth.
79
86
  It should export a loader that uses `shopifyApp` to authenticate:
80
87
 
81
88
  ```ts
@@ -1,6 +1,6 @@
1
1
  'use strict';
2
2
 
3
- const SHOPIFY_REMIX_LIBRARY_VERSION = '4.0.1';
3
+ const SHOPIFY_REMIX_LIBRARY_VERSION = '4.0.2';
4
4
 
5
5
  exports.SHOPIFY_REMIX_LIBRARY_VERSION = SHOPIFY_REMIX_LIBRARY_VERSION;
6
6
  //# sourceMappingURL=version.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"version.js","sources":["../../../../src/server/version.ts"],"sourcesContent":["export const SHOPIFY_REMIX_LIBRARY_VERSION = '4.0.1';\n"],"names":[],"mappings":";;AAAO,MAAM,6BAA6B,GAAG;;;;"}
1
+ {"version":3,"file":"version.js","sources":["../../../../src/server/version.ts"],"sourcesContent":["export const SHOPIFY_REMIX_LIBRARY_VERSION = '4.0.2';\n"],"names":[],"mappings":";;AAAO,MAAM,6BAA6B,GAAG;;;;"}
@@ -1,4 +1,4 @@
1
- const SHOPIFY_REMIX_LIBRARY_VERSION = '4.0.1';
1
+ const SHOPIFY_REMIX_LIBRARY_VERSION = '4.0.2';
2
2
 
3
3
  export { SHOPIFY_REMIX_LIBRARY_VERSION };
4
4
  //# sourceMappingURL=version.mjs.map
@@ -1 +1 @@
1
- {"version":3,"file":"version.mjs","sources":["../../../../src/server/version.ts"],"sourcesContent":["export const SHOPIFY_REMIX_LIBRARY_VERSION = '4.0.1';\n"],"names":[],"mappings":"AAAO,MAAM,6BAA6B,GAAG;;;;"}
1
+ {"version":3,"file":"version.mjs","sources":["../../../../src/server/version.ts"],"sourcesContent":["export const SHOPIFY_REMIX_LIBRARY_VERSION = '4.0.2';\n"],"names":[],"mappings":"AAAO,MAAM,6BAA6B,GAAG;;;;"}
@@ -1,2 +1,2 @@
1
- export declare const SHOPIFY_REMIX_LIBRARY_VERSION = "4.0.1";
1
+ export declare const SHOPIFY_REMIX_LIBRARY_VERSION = "4.0.2";
2
2
  //# sourceMappingURL=version.d.ts.map