arky-sdk 0.11.0 → 0.11.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 +21 -4
- package/dist/admin.cjs.map +1 -1
- package/dist/admin.js.map +1 -1
- package/dist/index.cjs +3 -5
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +3 -5
- package/dist/index.js.map +1 -1
- package/dist/storefront.cjs +2 -4
- package/dist/storefront.cjs.map +1 -1
- package/dist/storefront.js +2 -4
- package/dist/storefront.js.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -10,14 +10,19 @@ npm install arky-sdk
|
|
|
10
10
|
|
|
11
11
|
## Storefront quick start
|
|
12
12
|
|
|
13
|
+
The current browser contract is `arky-sdk@0.11.2`. Pin that exact version during the coordinated
|
|
14
|
+
prelaunch cutover so the Server, App, and storefront route/header contracts move together:
|
|
15
|
+
|
|
16
|
+
```bash
|
|
17
|
+
npm install --save-exact arky-sdk@0.11.2
|
|
18
|
+
```
|
|
19
|
+
|
|
13
20
|
Copy the Store publishable key from Developer and initialize one client:
|
|
14
21
|
|
|
15
22
|
```typescript
|
|
16
23
|
import { initialize } from "arky-sdk";
|
|
17
24
|
|
|
18
|
-
export const arky = initialize(
|
|
19
|
-
import.meta.env.PUBLIC_ARKY_PUBLISHABLE_KEY,
|
|
20
|
-
);
|
|
25
|
+
export const arky = initialize(import.meta.env.PUBLIC_ARKY_PUBLISHABLE_KEY);
|
|
21
26
|
```
|
|
22
27
|
|
|
23
28
|
`initialize` is synchronous. It makes no request and creates no visitor. Production requests use `https://api.arky.io` by default.
|
|
@@ -198,7 +203,8 @@ Authorization: Bearer arky_vst_...
|
|
|
198
203
|
```
|
|
199
204
|
|
|
200
205
|
For cart recovery, `cart.get({ id, token })` sends the recovery credential as
|
|
201
|
-
`X-Arky-Cart-Token`. It is never placed in the request URL or body
|
|
206
|
+
`X-Arky-Cart-Token`. It is never placed in the request URL or body, and the corresponding response
|
|
207
|
+
is private and non-cacheable.
|
|
202
208
|
|
|
203
209
|
Locale and market headers are omitted when no explicit context is set, allowing the server to use Store defaults.
|
|
204
210
|
|
|
@@ -259,6 +265,17 @@ type StorefrontCart = StorefrontDto<Cart>;
|
|
|
259
265
|
|
|
260
266
|
Storefront request types intentionally contain no Store routing ID. Admin request types remain Store-explicit.
|
|
261
267
|
|
|
268
|
+
## Verification
|
|
269
|
+
|
|
270
|
+
Run the complete SDK package contract with one command:
|
|
271
|
+
|
|
272
|
+
```bash
|
|
273
|
+
npm test
|
|
274
|
+
```
|
|
275
|
+
|
|
276
|
+
It builds the distributable package and runs every SDK contract case. Consumer compatibility is
|
|
277
|
+
then owned by App and each storefront's `npm test` against the same immutable Server image digest.
|
|
278
|
+
|
|
262
279
|
## Adding an endpoint
|
|
263
280
|
|
|
264
281
|
When adding SDK methods:
|