@contentrain/query 5.0.0 → 5.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.
Files changed (2) hide show
  1. package/README.md +9 -2
  2. package/package.json +15 -8
package/README.md CHANGED
@@ -1,8 +1,11 @@
1
1
  # `@contentrain/query`
2
2
 
3
- Type-safe generated query SDK for Contentrain.
3
+ [![npm version](https://img.shields.io/npm/v/%40contentrain%2Fquery?label=%40contentrain%2Fquery)](https://www.npmjs.com/package/@contentrain/query)
4
+ [![GitHub source](https://img.shields.io/badge/source-Contentrain%2Fai-181717?logo=github)](https://github.com/Contentrain/ai/tree/main/packages/sdk/js)
4
5
 
5
- Contentrain stores content in a git-backed `.contentrain/` directory. This package turns that content model into a generated JS/TS client with:
6
+ **Optional** type-safe generated query SDK for Contentrain.
7
+
8
+ Contentrain stores content as plain JSON and Markdown in a git-backed `.contentrain/` directory. Any platform that reads JSON can consume this content directly. This package adds a TypeScript convenience layer that turns content models into a generated JS/TS client with:
6
9
 
7
10
  - exact TypeScript types from your models
8
11
  - zero-dependency query runtime
@@ -241,6 +244,10 @@ pnpm exec oxlint packages/sdk/js/src packages/sdk/js/tests
241
244
  - `@contentrain/types` — shared schema and model definitions
242
245
  - `@contentrain/rules` — agent rules and prompts
243
246
 
247
+ ## 📚 Documentation
248
+
249
+ Full documentation at **[ai.contentrain.io/packages/sdk](https://ai.contentrain.io/packages/sdk)**.
250
+
244
251
  ## 📄 License
245
252
 
246
253
  MIT
package/package.json CHANGED
@@ -1,17 +1,17 @@
1
1
  {
2
2
  "name": "@contentrain/query",
3
- "version": "5.0.0",
3
+ "version": "5.0.2",
4
4
  "license": "MIT",
5
- "description": "Type-safe content query SDK for Contentrain — universal JS/TS",
5
+ "description": "Optional type-safe query SDK for Contentrain — generated TypeScript client for platform-independent JSON content",
6
6
  "type": "module",
7
7
  "repository": {
8
8
  "type": "git",
9
- "url": "git+https://github.com/contentrain/contentrain-ai.git",
9
+ "url": "git+https://github.com/Contentrain/ai.git",
10
10
  "directory": "packages/sdk/js"
11
11
  },
12
- "homepage": "https://github.com/contentrain/contentrain-ai/tree/main/packages/sdk/js",
12
+ "homepage": "https://github.com/Contentrain/ai/tree/main/packages/sdk/js",
13
13
  "bugs": {
14
- "url": "https://github.com/contentrain/contentrain-ai/issues"
14
+ "url": "https://github.com/Contentrain/ai/issues"
15
15
  },
16
16
  "keywords": [
17
17
  "contentrain",
@@ -20,8 +20,15 @@
20
20
  "typescript",
21
21
  "content",
22
22
  "i18n",
23
- "vite",
24
- "nextjs"
23
+ "generated-client",
24
+ "platform-independent",
25
+ "json",
26
+ "vue",
27
+ "react",
28
+ "nuxt",
29
+ "nextjs",
30
+ "astro",
31
+ "sveltekit"
25
32
  ],
26
33
  "publishConfig": {
27
34
  "access": "public"
@@ -50,7 +57,7 @@
50
57
  "dist"
51
58
  ],
52
59
  "dependencies": {
53
- "@contentrain/types": "0.1.0"
60
+ "@contentrain/types": "0.2.0"
54
61
  },
55
62
  "devDependencies": {
56
63
  "@types/node": "^22.0.0",