@shopify/shopify-api 12.1.1 → 12.1.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 +27 -5
- package/dist/cjs/adapters/cf-worker/index.js +4 -0
- package/dist/cjs/adapters/cf-worker/index.js.map +1 -1
- package/dist/cjs/adapters/web-api/index.js +4 -0
- package/dist/cjs/adapters/web-api/index.js.map +1 -1
- package/dist/cjs/lib/version.js +1 -1
- package/dist/cjs/lib/version.js.map +1 -1
- package/dist/cjs/tsconfig.build.tsbuildinfo +1 -1
- package/dist/esm/adapters/cf-worker/index.mjs +4 -0
- package/dist/esm/adapters/cf-worker/index.mjs.map +1 -1
- package/dist/esm/adapters/web-api/index.mjs +4 -0
- package/dist/esm/adapters/web-api/index.mjs.map +1 -1
- package/dist/esm/lib/version.mjs +1 -1
- package/dist/esm/lib/version.mjs.map +1 -1
- package/dist/esm/tsconfig.build.tsbuildinfo +1 -1
- package/dist/ts/adapters/cf-worker/index.d.ts +1 -1
- package/dist/ts/adapters/cf-worker/index.d.ts.map +1 -1
- package/dist/ts/adapters/web-api/index.d.ts +1 -1
- package/dist/ts/adapters/web-api/index.d.ts.map +1 -1
- package/dist/ts/lib/version.d.ts +1 -1
- package/dist/ts/tsconfig.build.tsbuildinfo +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -51,12 +51,32 @@ The first thing you need to import is the adapter for your app's runtime. This w
|
|
|
51
51
|
import '@shopify/shopify-api/adapters/node';
|
|
52
52
|
```
|
|
53
53
|
|
|
54
|
+
> **Note** Some bundlers may aggressively tree-shake the adapter imports in production builds. If you encounter a "Missing adapter implementation" error, you can use the exported constant to ensure the adapter is loaded:
|
|
55
|
+
>
|
|
56
|
+
> ```ts
|
|
57
|
+
> import { nodeAdapterInitialized } from '@shopify/shopify-api/adapters/node';
|
|
58
|
+
> // Optional: Check the adapter loaded successfully
|
|
59
|
+
> if (!nodeAdapterInitialized) {
|
|
60
|
+
> throw new Error('Failed to initialize Node.js adapter');
|
|
61
|
+
> }
|
|
62
|
+
> ```
|
|
63
|
+
|
|
54
64
|
</div><div>CloudFlare Worker
|
|
55
65
|
|
|
56
66
|
```ts
|
|
57
67
|
import '@shopify/shopify-api/adapters/cf-worker';
|
|
58
68
|
```
|
|
59
69
|
|
|
70
|
+
> **Note** Some bundlers may aggressively tree-shake the adapter imports in production builds. If you encounter a "Missing adapter implementation" error, you can use the exported constant to ensure the adapter is loaded:
|
|
71
|
+
>
|
|
72
|
+
> ```ts
|
|
73
|
+
> import { cfWorkerAdapterInitialized } from '@shopify/shopify-api/adapters/cf-worker';
|
|
74
|
+
> // Optional: Check the adapter loaded successfully
|
|
75
|
+
> if (!cfWorkerAdapterInitialized) {
|
|
76
|
+
> throw new Error('Failed to initialize Cloudflare Worker adapter');
|
|
77
|
+
> }
|
|
78
|
+
> ```
|
|
79
|
+
|
|
60
80
|
</div>
|
|
61
81
|
</div><div>Generic runtimes that implement the <a href="https://developer.mozilla.org/en-US/docs/Web/API">Web API</a>
|
|
62
82
|
|
|
@@ -64,18 +84,20 @@ import '@shopify/shopify-api/adapters/cf-worker';
|
|
|
64
84
|
import '@shopify/shopify-api/adapters/web-api';
|
|
65
85
|
```
|
|
66
86
|
|
|
67
|
-
</div>
|
|
68
|
-
|
|
69
87
|
> **Note** Some bundlers may aggressively tree-shake the adapter imports in production builds. If you encounter a "Missing adapter implementation" error, you can use the exported constant to ensure the adapter is loaded:
|
|
70
88
|
>
|
|
71
89
|
> ```ts
|
|
72
|
-
> import {
|
|
90
|
+
> import { webApiAdapterInitialized } from '@shopify/shopify-api/adapters/web-api';
|
|
73
91
|
> // Optional: Check the adapter loaded successfully
|
|
74
|
-
> if (!
|
|
75
|
-
> throw new Error('Failed to initialize
|
|
92
|
+
> if (!webApiAdapterInitialized) {
|
|
93
|
+
> throw new Error('Failed to initialize web API adapter');
|
|
76
94
|
> }
|
|
77
95
|
> ```
|
|
78
96
|
|
|
97
|
+
</div>
|
|
98
|
+
|
|
99
|
+
|
|
100
|
+
|
|
79
101
|
Next, configure the library - you'll need some values in advance:
|
|
80
102
|
|
|
81
103
|
- Your app's API key from [Partners dashboard](https://www.shopify.com/partners) (also called `Client ID`)
|
|
@@ -10,4 +10,8 @@ index.setAbstractConvertRequestFunc(adapter.webApiConvertRequest);
|
|
|
10
10
|
index.setAbstractConvertResponseFunc(adapter.webApiConvertResponse);
|
|
11
11
|
index.setAbstractConvertHeadersFunc(adapter.webApiConvertHeaders);
|
|
12
12
|
runtimeString.setAbstractRuntimeString(adapter$1.workerRuntimeString);
|
|
13
|
+
// Export a marker to prevent tree-shaking
|
|
14
|
+
const cfWorkerAdapterInitialized = true;
|
|
15
|
+
|
|
16
|
+
exports.cfWorkerAdapterInitialized = cfWorkerAdapterInitialized;
|
|
13
17
|
//# sourceMappingURL=index.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sources":["../../../../../../adapters/cf-worker/index.ts"],"sourcesContent":["import {\n setAbstractFetchFunc,\n setAbstractConvertRequestFunc,\n setAbstractConvertResponseFunc,\n setAbstractConvertHeadersFunc,\n setAbstractRuntimeString,\n} from '../../runtime';\nimport {\n webApiConvertHeaders,\n webApiConvertRequest,\n webApiConvertResponse,\n} from '../web-api/adapter';\n\nimport {workerRuntimeString} from './adapter';\n\nsetAbstractFetchFunc(fetch);\nsetAbstractConvertRequestFunc(webApiConvertRequest);\nsetAbstractConvertResponseFunc(webApiConvertResponse);\nsetAbstractConvertHeadersFunc(webApiConvertHeaders);\nsetAbstractRuntimeString(workerRuntimeString);\n"],"names":["setAbstractFetchFunc","setAbstractConvertRequestFunc","webApiConvertRequest","setAbstractConvertResponseFunc","webApiConvertResponse","setAbstractConvertHeadersFunc","webApiConvertHeaders","setAbstractRuntimeString","workerRuntimeString"],"mappings":";;;;;;;AAeAA,0BAAoB,CAAC,KAAK,CAAC;AAC3BC,mCAA6B,CAACC,4BAAoB,CAAC;AACnDC,oCAA8B,CAACC,6BAAqB,CAAC;AACrDC,mCAA6B,CAACC,4BAAoB,CAAC;AACnDC,sCAAwB,CAACC,6BAAmB,CAAC
|
|
1
|
+
{"version":3,"file":"index.js","sources":["../../../../../../adapters/cf-worker/index.ts"],"sourcesContent":["import {\n setAbstractFetchFunc,\n setAbstractConvertRequestFunc,\n setAbstractConvertResponseFunc,\n setAbstractConvertHeadersFunc,\n setAbstractRuntimeString,\n} from '../../runtime';\nimport {\n webApiConvertHeaders,\n webApiConvertRequest,\n webApiConvertResponse,\n} from '../web-api/adapter';\n\nimport {workerRuntimeString} from './adapter';\n\nsetAbstractFetchFunc(fetch);\nsetAbstractConvertRequestFunc(webApiConvertRequest);\nsetAbstractConvertResponseFunc(webApiConvertResponse);\nsetAbstractConvertHeadersFunc(webApiConvertHeaders);\nsetAbstractRuntimeString(workerRuntimeString);\n\n// Export a marker to prevent tree-shaking\nexport const cfWorkerAdapterInitialized = true;\n"],"names":["setAbstractFetchFunc","setAbstractConvertRequestFunc","webApiConvertRequest","setAbstractConvertResponseFunc","webApiConvertResponse","setAbstractConvertHeadersFunc","webApiConvertHeaders","setAbstractRuntimeString","workerRuntimeString"],"mappings":";;;;;;;AAeAA,0BAAoB,CAAC,KAAK,CAAC;AAC3BC,mCAA6B,CAACC,4BAAoB,CAAC;AACnDC,oCAA8B,CAACC,6BAAqB,CAAC;AACrDC,mCAA6B,CAACC,4BAAoB,CAAC;AACnDC,sCAAwB,CAACC,6BAAmB,CAAC;AAE7C;AACO,MAAM,0BAA0B,GAAG;;;;"}
|
|
@@ -9,4 +9,8 @@ index.setAbstractConvertRequestFunc(adapter.webApiConvertRequest);
|
|
|
9
9
|
index.setAbstractConvertResponseFunc(adapter.webApiConvertResponse);
|
|
10
10
|
index.setAbstractConvertHeadersFunc(adapter.webApiConvertHeaders);
|
|
11
11
|
runtimeString.setAbstractRuntimeString(adapter.webApiRuntimeString);
|
|
12
|
+
// Export a marker to prevent tree-shaking
|
|
13
|
+
const webApiAdapterInitialized = true;
|
|
14
|
+
|
|
15
|
+
exports.webApiAdapterInitialized = webApiAdapterInitialized;
|
|
12
16
|
//# sourceMappingURL=index.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sources":["../../../../../../adapters/web-api/index.ts"],"sourcesContent":["import {\n setAbstractFetchFunc,\n setAbstractConvertRequestFunc,\n setAbstractConvertResponseFunc,\n setAbstractConvertHeadersFunc,\n setAbstractRuntimeString,\n} from '../../runtime';\n\nimport {\n webApiConvertHeaders,\n webApiConvertRequest,\n webApiConvertResponse,\n webApiRuntimeString,\n} from './adapter';\n\nsetAbstractFetchFunc(fetch);\nsetAbstractConvertRequestFunc(webApiConvertRequest);\nsetAbstractConvertResponseFunc(webApiConvertResponse);\nsetAbstractConvertHeadersFunc(webApiConvertHeaders);\nsetAbstractRuntimeString(webApiRuntimeString);\n"],"names":["setAbstractFetchFunc","setAbstractConvertRequestFunc","webApiConvertRequest","setAbstractConvertResponseFunc","webApiConvertResponse","setAbstractConvertHeadersFunc","webApiConvertHeaders","setAbstractRuntimeString","webApiRuntimeString"],"mappings":";;;;;;AAeAA,0BAAoB,CAAC,KAAK,CAAC;AAC3BC,mCAA6B,CAACC,4BAAoB,CAAC;AACnDC,oCAA8B,CAACC,6BAAqB,CAAC;AACrDC,mCAA6B,CAACC,4BAAoB,CAAC;AACnDC,sCAAwB,CAACC,2BAAmB,CAAC
|
|
1
|
+
{"version":3,"file":"index.js","sources":["../../../../../../adapters/web-api/index.ts"],"sourcesContent":["import {\n setAbstractFetchFunc,\n setAbstractConvertRequestFunc,\n setAbstractConvertResponseFunc,\n setAbstractConvertHeadersFunc,\n setAbstractRuntimeString,\n} from '../../runtime';\n\nimport {\n webApiConvertHeaders,\n webApiConvertRequest,\n webApiConvertResponse,\n webApiRuntimeString,\n} from './adapter';\n\nsetAbstractFetchFunc(fetch);\nsetAbstractConvertRequestFunc(webApiConvertRequest);\nsetAbstractConvertResponseFunc(webApiConvertResponse);\nsetAbstractConvertHeadersFunc(webApiConvertHeaders);\nsetAbstractRuntimeString(webApiRuntimeString);\n\n// Export a marker to prevent tree-shaking\nexport const webApiAdapterInitialized = true;\n"],"names":["setAbstractFetchFunc","setAbstractConvertRequestFunc","webApiConvertRequest","setAbstractConvertResponseFunc","webApiConvertResponse","setAbstractConvertHeadersFunc","webApiConvertHeaders","setAbstractRuntimeString","webApiRuntimeString"],"mappings":";;;;;;AAeAA,0BAAoB,CAAC,KAAK,CAAC;AAC3BC,mCAA6B,CAACC,4BAAoB,CAAC;AACnDC,oCAA8B,CAACC,6BAAqB,CAAC;AACrDC,mCAA6B,CAACC,4BAAoB,CAAC;AACnDC,sCAAwB,CAACC,2BAAmB,CAAC;AAE7C;AACO,MAAM,wBAAwB,GAAG;;;;"}
|
package/dist/cjs/lib/version.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"version.js","sources":["../../../../../lib/version.ts"],"sourcesContent":["export const SHOPIFY_API_LIBRARY_VERSION = '12.1.
|
|
1
|
+
{"version":3,"file":"version.js","sources":["../../../../../lib/version.ts"],"sourcesContent":["export const SHOPIFY_API_LIBRARY_VERSION = '12.1.2';\n"],"names":[],"mappings":";;AAAO,MAAM,2BAA2B,GAAG;;;;"}
|