@cms0/cms0 0.2.19 → 0.2.21
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 +11 -0
- package/dist/cjs/custom-types/registry.cjs +6 -0
- package/dist/cjs/descriptor-sidecar.cjs +5 -0
- package/dist/cjs/index.cjs +425 -70
- package/dist/cjs/libs/cli/browser-sidecar.cjs +30 -0
- package/dist/cjs/libs/cli/config-loader.cjs +45 -4
- package/dist/cjs/libs/cli/publisher.cjs +24 -11
- package/dist/cjs/schema-descriptors.cjs +49 -0
- package/dist/esm/custom-types/registry.js +6 -0
- package/dist/esm/descriptor-sidecar.js +5 -1
- package/dist/esm/index.js +427 -72
- package/dist/esm/libs/cli/browser-sidecar.js +30 -0
- package/dist/esm/libs/cli/config-loader.js +45 -4
- package/dist/esm/libs/cli/publisher.js +24 -11
- package/dist/esm/schema-descriptors.js +48 -1
- package/dist/types/custom-types/index.d.ts +2 -1
- package/dist/types/custom-types/index.d.ts.map +1 -1
- package/dist/types/custom-types/registry.d.ts.map +1 -1
- package/dist/types/descriptor-sidecar.d.ts +2 -1
- package/dist/types/descriptor-sidecar.d.ts.map +1 -1
- package/dist/types/index.d.ts +131 -7
- package/dist/types/index.d.ts.map +1 -1
- package/dist/types/libs/cli/browser-sidecar.d.ts.map +1 -1
- package/dist/types/libs/cli/config-loader.d.ts.map +1 -1
- package/dist/types/libs/cli/publisher.d.ts.map +1 -1
- package/dist/types/schema-descriptors.d.ts +2 -0
- package/dist/types/schema-descriptors.d.ts.map +1 -1
- package/package.json +13 -9
- package/dist/cjs/index-old-1.cjs +0 -866
- package/dist/cjs/index-old.cjs +0 -1016
- package/dist/cjs/libs/cli/descriptor-builder.cjs +0 -273
- package/dist/cjs/utils/index.cjs +0 -2
- package/dist/esm/index-old-1.js +0 -862
- package/dist/esm/index-old.js +0 -1012
- package/dist/esm/libs/cli/descriptor-builder.js +0 -268
- package/dist/esm/utils/index.js +0 -1
- package/dist/types/index-old-1.d.ts +0 -175
- package/dist/types/index-old-1.d.ts.map +0 -1
- package/dist/types/index-old.d.ts +0 -151
- package/dist/types/index-old.d.ts.map +0 -1
- package/dist/types/libs/cli/descriptor-builder.d.ts +0 -5
- package/dist/types/libs/cli/descriptor-builder.d.ts.map +0 -1
- package/dist/types/utils/index.d.ts +0 -2
- package/dist/types/utils/index.d.ts.map +0 -1
package/README.md
CHANGED
|
@@ -33,6 +33,10 @@ const page = await data.homePage();
|
|
|
33
33
|
const metadata = toNextMetadata<Metadata>(page.seo, { locale: "en" });
|
|
34
34
|
```
|
|
35
35
|
|
|
36
|
+
`VITE_CMS0_API_BASEURL` should point at the content runtime root, for example
|
|
37
|
+
`http://localhost:3000/api/content` for self-hosted or
|
|
38
|
+
`http://localhost:3001/api/content/stage` for a website environment path.
|
|
39
|
+
|
|
36
40
|
## Accessor Options
|
|
37
41
|
|
|
38
42
|
All root/model accessors accept options:
|
|
@@ -43,12 +47,19 @@ await data.homePage({
|
|
|
43
47
|
locale: "en",
|
|
44
48
|
fields: ["heroImage", "seo.openGraph.images"],
|
|
45
49
|
exclude: ["seo.jsonLd"],
|
|
50
|
+
graph: {
|
|
51
|
+
pageSize: "full",
|
|
52
|
+
paths: {
|
|
53
|
+
"seo.openGraph.images": { pageSize: 50 },
|
|
54
|
+
},
|
|
55
|
+
},
|
|
46
56
|
query: { raw: 1 },
|
|
47
57
|
});
|
|
48
58
|
```
|
|
49
59
|
|
|
50
60
|
- `fields`: recursive include projection (supports nested paths like `a.b.c`).
|
|
51
61
|
- `exclude`: recursive remove projection (also supports nested paths).
|
|
62
|
+
- `graph`: resolved graph read controls. Global `page`, `pageSize`, `orderBy`, `orderDir`, and `search` apply recursively to graph-backed arrays. The SDK defaults graph `pageSize` to `"full"` for resolved root reads. Use `graph.paths` for dot-path overrides.
|
|
52
63
|
- `query`: passthrough query params to API.
|
|
53
64
|
|
|
54
65
|
## Custom Types
|
|
@@ -13,6 +13,12 @@ const primitive = (type) => ({
|
|
|
13
13
|
const fileFieldDescriptors = {
|
|
14
14
|
name: primitive("string"),
|
|
15
15
|
filename: primitive("string"),
|
|
16
|
+
storageKey: {
|
|
17
|
+
kind: "primitive",
|
|
18
|
+
type: "string",
|
|
19
|
+
optional: true,
|
|
20
|
+
nullable: false,
|
|
21
|
+
},
|
|
16
22
|
extension: primitive("string"),
|
|
17
23
|
mimeType: primitive("string"),
|
|
18
24
|
size: primitive("number"),
|
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.getCms0DescriptorSidecarPort = getCms0DescriptorSidecarPort;
|
|
4
4
|
exports.getCms0DescriptorSidecarUrl = getCms0DescriptorSidecarUrl;
|
|
5
|
+
exports.getCms0DescriptorSidecarEventsUrl = getCms0DescriptorSidecarEventsUrl;
|
|
5
6
|
exports.hashCms0SidecarSeed = hashCms0SidecarSeed;
|
|
6
7
|
function hashCms0SidecarSeed(seed) {
|
|
7
8
|
let hash = 5381;
|
|
@@ -18,3 +19,7 @@ function getCms0DescriptorSidecarUrl(baseUrl, apiKey) {
|
|
|
18
19
|
const port = getCms0DescriptorSidecarPort(baseUrl, apiKey);
|
|
19
20
|
return `http://127.0.0.1:${port}/schema-descriptor`;
|
|
20
21
|
}
|
|
22
|
+
function getCms0DescriptorSidecarEventsUrl(baseUrl, apiKey) {
|
|
23
|
+
const port = getCms0DescriptorSidecarPort(baseUrl, apiKey);
|
|
24
|
+
return `http://127.0.0.1:${port}/schema-events`;
|
|
25
|
+
}
|