@sonic-commerce/storefront-types 0.36.0 → 0.37.0
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 +7 -0
- package/dist/index.d.ts +1 -1
- package/dist/schema.d.ts +3 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -116,6 +116,13 @@ const { data } = await api.GET("/carts/{id}", { params: { path: { id } } });
|
|
|
116
116
|
const cart = data?.data as Cart | undefined; // shipping_total present
|
|
117
117
|
```
|
|
118
118
|
|
|
119
|
+
### Product descriptions
|
|
120
|
+
|
|
121
|
+
`description` is a plain-text summary (max 500 characters). `body`, on the
|
|
122
|
+
product detail response only, is the detailed description as structured JSON —
|
|
123
|
+
see "Product descriptions" in the integrator's guide for the node types. Render
|
|
124
|
+
it as elements and text, never through `innerHTML`.
|
|
125
|
+
|
|
119
126
|
## Versioning
|
|
120
127
|
|
|
121
128
|
The package version tracks the API version: each version describes the `/v1`
|
package/dist/index.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
// Generated by scripts/build.mjs from app/openapi/public-api.json — do not edit.
|
|
2
|
-
// Spec version 0.
|
|
2
|
+
// Spec version 0.37.0, 59 named schemas.
|
|
3
3
|
|
|
4
4
|
export type { paths, components, operations } from "./schema";
|
|
5
5
|
import type { components } from "./schema";
|
package/dist/schema.d.ts
CHANGED
|
@@ -3666,6 +3666,9 @@ export interface components {
|
|
|
3666
3666
|
thumbnail_sizes?: components["schemas"]["ImageSizes"] | null;
|
|
3667
3667
|
created_at?: string;
|
|
3668
3668
|
updated_at?: string;
|
|
3669
|
+
body?: {
|
|
3670
|
+
[key: string]: unknown;
|
|
3671
|
+
}[] | null;
|
|
3669
3672
|
variants?: components["schemas"]["ProductVariant"][];
|
|
3670
3673
|
options?: components["schemas"]["ProductOption"][];
|
|
3671
3674
|
categories?: components["schemas"]["ProductCategory"][];
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@sonic-commerce/storefront-types",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.37.0",
|
|
4
4
|
"description": "TypeScript types for the Sonic Commerce storefront API (/v1).",
|
|
5
5
|
"keywords": ["sonic-commerce", "openapi", "types", "storefront"],
|
|
6
6
|
"license": "UNLICENSED",
|