Compare commits

...

45 Commits

Author SHA1 Message Date
Giordano Ricci
bbbd773c3f Merge pull request #1299 from garden-co/changeset-release/main
Version Packages
2025-01-29 16:53:17 +00:00
github-actions[bot]
7d5f4e5881 Version Packages 2025-01-29 16:40:51 +00:00
Giordano Ricci
29c44538dc Merge pull request #1298 from garden-co/gio/is-it-really-me
Change isMe to indicate whether an account is the currently active account
2025-01-29 16:39:46 +00:00
Giordano Ricci
198f995b21 update changeset 2025-01-29 16:31:33 +00:00
Giordano Ricci
1be017d69d make isMe indicate whether an account is the currently active one, add isLocalNodeOwner to reproduce previous behavior 2025-01-29 16:20:14 +00:00
Benjamin S. Leveritt
5574be699b Merge pull request #1290 from garden-co/jazz-682-update-nix-flake-to-node-22
Chore: Update nix flake for node22
2025-01-27 15:25:16 +00:00
Benjamin S. Leveritt
b3142cb8ed Chore: Update nix flake for node22 2025-01-27 15:02:20 +00:00
Benjamin S. Leveritt
cb08d9d1a3 Merge pull request #1240 from garden-co/jazz-662-add-llmstxt
Adds LLMs.txt generator
2025-01-27 14:55:10 +00:00
Guido D'Orsi
4d01cbae03 Merge pull request #1288 from garden-co/sync-tests-improvements
Improve sync tests and add some utils to track the messages exchanges
2025-01-27 15:47:03 +01:00
Guido D'Orsi
13f6389559 chore: format text 2025-01-27 15:38:34 +01:00
Guido D'Orsi
f6ea9bcc50 test: remove flaky test 2025-01-27 15:37:02 +01:00
Guido D'Orsi
f6f2766eac test: cover the initial messages exchanges 2025-01-27 15:35:35 +01:00
Guido D'Orsi
f8f63bface test: simplify sync tests with the test sync pattern 2025-01-27 15:35:34 +01:00
Guido D'Orsi
5ec561fec4 Merge pull request #1281 from garden-co/changeset-release/main
Version Packages
2025-01-27 11:07:35 +01:00
github-actions[bot]
277787cbd2 Version Packages 2025-01-27 10:03:17 +00:00
Guido D'Orsi
dda4336721 Merge pull request #1252 from garden-co/fix-ts-symbol-error
fix(typescript): replace private symbols with prefixed strings
2025-01-27 11:01:37 +01:00
Guido D'Orsi
064d19b48c chore: move jazz-react-core version up to 0.9.19 2025-01-27 09:27:18 +01:00
Guido D'Orsi
3ea269f4d8 chore: package json formatting 2025-01-27 09:27:00 +01:00
Guido D'Orsi
c4b8befe27 Merge pull request #1278 from garden-co/changeset-release/main
Version Packages
2025-01-27 09:21:29 +01:00
Guido D'Orsi
06f667ef2a Merge pull request #1280 from doingandlearning/patch-2
Update README.md
2025-01-27 09:21:16 +01:00
github-actions[bot]
bac3cc7bf8 Version Packages 2025-01-27 08:17:07 +00:00
Guido D'Orsi
6ad0a9f886 chore: changeset 2025-01-27 09:15:44 +01:00
Kevin Cunningham
9b12932b66 Update README.md 2025-01-26 09:10:49 +00:00
Guido D'Orsi
82bb0d51d9 Merge pull request #1277 from garden-co/changeset-release/main
Version Packages
2025-01-25 20:27:12 +01:00
Guido D'Orsi
39dede92e8 Merge pull request #1273 from garden-co/fix/remove-npm-create
Remove npm create jazz-app from instructions
2025-01-25 20:27:00 +01:00
github-actions[bot]
84f4e6e48d Version Packages 2025-01-25 19:22:29 +00:00
Guido D'Orsi
e629dea585 fix: remove internal imports to cojson 2025-01-25 20:21:22 +01:00
Guido D'Orsi
2faf22ffff chore: changeset 2025-01-25 18:45:43 +01:00
Guido D'Orsi
2273505a13 Merge pull request #1276 from anchpop/@anchpop/remove-inspector-vite
fix(jazz-inspector): export typescript types and remove unneeded vite build step
2025-01-25 18:45:30 +01:00
Andre Popovitch
19eb29d831 fix(jazz-inspector): export typescript types and remove unneeded vite build step 2025-01-26 00:04:00 +09:00
Andre Popovitch
738c4c2bd7 fix(jazz-inspector): Add files entry to package.json so dist is included in published releases 2025-01-25 23:37:27 +09:00
Guido D'Orsi
64e2273475 Merge pull request #1274 from garden-co/changeset-release/main
Version Packages
2025-01-25 11:20:10 +01:00
github-actions[bot]
5a85c89154 Version Packages 2025-01-25 10:18:09 +00:00
Guido D'Orsi
8898b10e89 chore: changeset 2025-01-25 11:16:54 +01:00
Andre Popovitch
dc2d4e25f7 Remove npm create for examples 2025-01-25 18:09:52 +08:00
Trisha Lim
9275c4f6c0 Remove npm create jazz-app from instructions 2025-01-25 18:07:48 +08:00
Benjamin S. Leveritt
4dab70eea3 Adds docs to llms-full 2025-01-24 10:51:32 +00:00
Guido D'Orsi
b01cc1fe9d fix(typescript): fix type error on ItemsSym 2025-01-23 19:21:29 +01:00
Benjamin S. Leveritt
68e9c85d8f Adds docs to llms.txt 2025-01-23 16:44:44 +00:00
Benjamin S. Leveritt
1b124ff5c7 Changes extension for use in nodeJS 2025-01-23 16:44:29 +00:00
Benjamin S. Leveritt
ab2645765d Generates two llms.txt, listing and full 2025-01-23 15:13:45 +00:00
Benjamin S. Leveritt
2dec852ce2 Adds API ref links to methods 2025-01-23 13:14:19 +00:00
Benjamin S. Leveritt
8cb09379f4 Adds ids for methods 2025-01-23 13:13:41 +00:00
Benjamin S. Leveritt
9fb2e61e01 Extracts more information 2025-01-23 11:39:52 +00:00
Benjamin S. Leveritt
794927cac3 Adds LLMs.txt generator 2025-01-22 17:09:29 +00:00
141 changed files with 2667 additions and 782 deletions

View File

@@ -1,5 +1,43 @@
# chat-rn-clerk
## 1.0.62
### Patch Changes
- Updated dependencies [1be017d]
- jazz-tools@0.9.21
- jazz-react-native@0.9.21
- jazz-react-native-auth-clerk@0.9.21
- jazz-react-native-media-images@0.9.21
## 1.0.61
### Patch Changes
- Updated dependencies [b01cc1f]
- jazz-tools@0.9.20
- jazz-react-native@0.9.20
- jazz-react-native-auth-clerk@0.9.20
- jazz-react-native-media-images@0.9.20
## 1.0.60
### Patch Changes
- jazz-react-native@0.9.19
- jazz-react-native-auth-clerk@0.9.19
- jazz-tools@0.9.19
- jazz-react-native-media-images@0.9.19
## 1.0.59
### Patch Changes
- jazz-react-native@0.9.18
- jazz-react-native-auth-clerk@0.9.18
- jazz-tools@0.9.18
- jazz-react-native-media-images@0.9.18
## 1.0.58
### Patch Changes

View File

@@ -1,7 +1,7 @@
{
"name": "chat-rn-clerk",
"main": "index.js",
"version": "1.0.58",
"version": "1.0.62",
"scripts": {
"build": "expo export -p ios",
"start": "expo start",

View File

@@ -1,5 +1,35 @@
# chat-rn
## 1.0.59
### Patch Changes
- Updated dependencies [1be017d]
- jazz-tools@0.9.21
- jazz-react-native@0.9.21
## 1.0.58
### Patch Changes
- Updated dependencies [b01cc1f]
- jazz-tools@0.9.20
- jazz-react-native@0.9.20
## 1.0.57
### Patch Changes
- jazz-react-native@0.9.19
- jazz-tools@0.9.19
## 1.0.56
### Patch Changes
- jazz-react-native@0.9.18
- jazz-tools@0.9.18
## 1.0.55
### Patch Changes

View File

@@ -1,6 +1,6 @@
{
"name": "chat-rn",
"version": "1.0.55",
"version": "1.0.59",
"main": "index.js",
"scripts": {
"build": "expo export -p ios",

View File

@@ -1,5 +1,39 @@
# chat-vue
## 0.0.46
### Patch Changes
- Updated dependencies [1be017d]
- jazz-tools@0.9.21
- jazz-browser@0.9.21
- jazz-vue@0.9.21
## 0.0.45
### Patch Changes
- Updated dependencies [b01cc1f]
- jazz-tools@0.9.20
- jazz-browser@0.9.20
- jazz-vue@0.9.20
## 0.0.44
### Patch Changes
- jazz-browser@0.9.19
- jazz-tools@0.9.19
- jazz-vue@0.9.19
## 0.0.43
### Patch Changes
- jazz-browser@0.9.18
- jazz-tools@0.9.18
- jazz-vue@0.9.18
## 0.0.42
### Patch Changes

View File

@@ -11,10 +11,6 @@ You can either
Create a new Jazz project, and use this example as a template.
```bash
npm create jazz-app@latest --example chat-vue --project-name chat-vue
```
or
```bash
npx create-jazz-app@latest --example chat-vue --project-name chat-vue
```

View File

@@ -1,6 +1,6 @@
{
"name": "chat-vue",
"version": "0.0.42",
"version": "0.0.46",
"private": true,
"type": "module",
"scripts": {

View File

@@ -1,5 +1,39 @@
# jazz-example-chat
## 0.0.142
### Patch Changes
- Updated dependencies [1be017d]
- jazz-tools@0.9.21
- jazz-browser-media-images@0.9.21
- jazz-react@0.9.21
## 0.0.141
### Patch Changes
- Updated dependencies [b01cc1f]
- jazz-tools@0.9.20
- jazz-browser-media-images@0.9.20
- jazz-react@0.9.20
## 0.0.140
### Patch Changes
- jazz-react@0.9.19
- jazz-tools@0.9.19
- jazz-browser-media-images@0.9.19
## 0.0.139
### Patch Changes
- jazz-react@0.9.18
- jazz-tools@0.9.18
- jazz-browser-media-images@0.9.18
## 0.0.138
### Patch Changes

View File

@@ -13,10 +13,6 @@ You can either
Create a new Jazz project, and use this example as a template.
```bash
npm create jazz-app@latest --example chat --project-name chat
```
or
```bash
npx create-jazz-app@latest --example chat --project-name chat
```

View File

@@ -1,7 +1,7 @@
{
"name": "jazz-example-chat",
"private": true,
"version": "0.0.138",
"version": "0.0.142",
"type": "module",
"scripts": {
"dev": "vite",

View File

@@ -1,5 +1,39 @@
# minimal-auth-clerk
## 0.0.41
### Patch Changes
- Updated dependencies [1be017d]
- jazz-tools@0.9.21
- jazz-react@0.9.21
- jazz-react-auth-clerk@0.9.21
## 0.0.40
### Patch Changes
- Updated dependencies [b01cc1f]
- jazz-tools@0.9.20
- jazz-react@0.9.20
- jazz-react-auth-clerk@0.9.20
## 0.0.39
### Patch Changes
- jazz-react@0.9.19
- jazz-react-auth-clerk@0.9.19
- jazz-tools@0.9.19
## 0.0.38
### Patch Changes
- jazz-react@0.9.18
- jazz-react-auth-clerk@0.9.18
- jazz-tools@0.9.18
## 0.0.37
### Patch Changes

View File

@@ -15,10 +15,6 @@ You can either
Create a new Jazz project, and use this example as a template.
```bash
npm create jazz-app@latest --example clerk --project-name clerk
```
or
```bash
npx create-jazz-app@latest --example clerk --project-name clerk
```

View File

@@ -1,7 +1,7 @@
{
"name": "clerk",
"private": true,
"version": "0.0.37",
"version": "0.0.41",
"type": "module",
"scripts": {
"dev": "vite",
@@ -13,7 +13,7 @@
"dependencies": {
"@clerk/clerk-react": "^5.4.1",
"jazz-react": "workspace:*",
"jazz-react-auth-clerk": "workspace:0.9.17",
"jazz-react-auth-clerk": "workspace:0.9.21",
"jazz-tools": "workspace:*",
"react": "^18.3.1",
"react-dom": "^18.3.1"

View File

@@ -1,5 +1,35 @@
# file-share-svelte
## 0.0.26
### Patch Changes
- Updated dependencies [1be017d]
- jazz-tools@0.9.21
- jazz-svelte@0.9.21
## 0.0.25
### Patch Changes
- Updated dependencies [b01cc1f]
- jazz-tools@0.9.20
- jazz-svelte@0.9.20
## 0.0.24
### Patch Changes
- jazz-svelte@0.9.19
- jazz-tools@0.9.19
## 0.0.23
### Patch Changes
- jazz-svelte@0.9.18
- jazz-tools@0.9.18
## 0.0.22
### Patch Changes

View File

@@ -1,6 +1,6 @@
{
"name": "file-share-svelte",
"version": "0.0.22",
"version": "0.0.26",
"private": true,
"type": "module",
"scripts": {

View File

@@ -1,5 +1,39 @@
# form
## 0.0.37
### Patch Changes
- Updated dependencies [1be017d]
- jazz-tools@0.9.21
- jazz-browser-media-images@0.9.21
- jazz-react@0.9.21
## 0.0.36
### Patch Changes
- Updated dependencies [b01cc1f]
- jazz-tools@0.9.20
- jazz-browser-media-images@0.9.20
- jazz-react@0.9.20
## 0.0.35
### Patch Changes
- jazz-react@0.9.19
- jazz-tools@0.9.19
- jazz-browser-media-images@0.9.19
## 0.0.34
### Patch Changes
- jazz-react@0.9.18
- jazz-tools@0.9.18
- jazz-browser-media-images@0.9.18
## 0.0.33
### Patch Changes

View File

@@ -28,10 +28,6 @@ You can either
Create a new Jazz project, and use this example as a template.
```bash
npm create jazz-app@latest --example form --project-name form
```
or
```bash
npx create-jazz-app@latest --example form --project-name form
```

View File

@@ -1,7 +1,7 @@
{
"name": "form",
"private": true,
"version": "0.0.33",
"version": "0.0.37",
"type": "module",
"scripts": {
"dev": "vite",

View File

@@ -1,5 +1,39 @@
# image-upload
## 0.0.39
### Patch Changes
- Updated dependencies [1be017d]
- jazz-tools@0.9.21
- jazz-browser-media-images@0.9.21
- jazz-react@0.9.21
## 0.0.38
### Patch Changes
- Updated dependencies [b01cc1f]
- jazz-tools@0.9.20
- jazz-browser-media-images@0.9.20
- jazz-react@0.9.20
## 0.0.37
### Patch Changes
- jazz-react@0.9.19
- jazz-tools@0.9.19
- jazz-browser-media-images@0.9.19
## 0.0.36
### Patch Changes
- jazz-react@0.9.18
- jazz-tools@0.9.18
- jazz-browser-media-images@0.9.18
## 0.0.35
### Patch Changes

View File

@@ -15,10 +15,6 @@ You can either
Create a new Jazz project, and use this example as a template.
```bash
npm create jazz-app@latest --example image-upload --project-name image-upload
```
or
```bash
npx create-jazz-app@latest --example image-upload --project-name image-upload
```

View File

@@ -1,7 +1,7 @@
{
"name": "image-upload",
"private": true,
"version": "0.0.35",
"version": "0.0.39",
"type": "module",
"scripts": {
"dev": "vite",

View File

@@ -1,5 +1,21 @@
# jazz-example-inspector
## 0.0.100
### Patch Changes
- Updated dependencies [6ad0a9f]
- cojson@0.9.19
- cojson-transport-ws@0.9.19
## 0.0.99
### Patch Changes
- Updated dependencies [8898b10]
- cojson@0.9.18
- cojson-transport-ws@0.9.18
## 0.0.98
### Patch Changes

View File

@@ -1,7 +1,7 @@
{
"name": "jazz-inspector-app",
"private": true,
"version": "0.0.98",
"version": "0.0.100",
"type": "module",
"scripts": {
"dev": "vite",
@@ -16,8 +16,8 @@
"@radix-ui/react-toast": "^1.1.4",
"class-variance-authority": "^0.7.0",
"clsx": "^2.0.0",
"cojson": "workspace:0.9.13",
"cojson-transport-ws": "workspace:0.9.13",
"cojson": "workspace:0.9.19",
"cojson-transport-ws": "workspace:0.9.19",
"hash-slash": "workspace:0.2.1",
"lucide-react": "^0.274.0",
"qrcode": "^1.5.3",

View File

@@ -1,5 +1,46 @@
# jazz-example-musicplayer
## 0.0.63
### Patch Changes
- Updated dependencies [1be017d]
- jazz-tools@0.9.21
- jazz-inspector@0.9.22
- jazz-react@0.9.21
## 0.0.62
### Patch Changes
- Updated dependencies [b01cc1f]
- jazz-tools@0.9.20
- jazz-inspector@0.9.21
- jazz-react@0.9.20
## 0.0.61
### Patch Changes
- jazz-inspector@0.9.20
- jazz-react@0.9.19
- jazz-tools@0.9.19
## 0.0.60
### Patch Changes
- Updated dependencies [2faf22f]
- jazz-inspector@0.9.19
## 0.0.59
### Patch Changes
- jazz-inspector@0.9.18
- jazz-react@0.9.18
- jazz-tools@0.9.18
## 0.0.58
### Patch Changes

View File

@@ -13,10 +13,6 @@ You can either
Create a new Jazz project, and use this example as a template.
```bash
npm create jazz-app@latest --example music-player --project-name music-player
```
or
```bash
npx create-jazz-app@latest --example music-player --project-name music-player
```

View File

@@ -1,7 +1,7 @@
{
"name": "jazz-example-music-player",
"private": true,
"version": "0.0.58",
"version": "0.0.63",
"type": "module",
"scripts": {
"dev": "vite",
@@ -18,8 +18,8 @@
"@radix-ui/react-toast": "^1.1.4",
"class-variance-authority": "^0.7.0",
"clsx": "^2.0.0",
"jazz-react": "workspace:0.9.17",
"jazz-tools": "workspace:0.9.17",
"jazz-react": "workspace:0.9.21",
"jazz-tools": "workspace:0.9.21",
"jazz-inspector": "workspace:*",
"lucide-react": "^0.274.0",
"react": "^18.3.1",

View File

@@ -1,5 +1,39 @@
# jazz-example-onboarding
## 0.0.43
### Patch Changes
- Updated dependencies [1be017d]
- jazz-tools@0.9.21
- jazz-browser-media-images@0.9.21
- jazz-react@0.9.21
## 0.0.42
### Patch Changes
- Updated dependencies [b01cc1f]
- jazz-tools@0.9.20
- jazz-browser-media-images@0.9.20
- jazz-react@0.9.20
## 0.0.41
### Patch Changes
- jazz-react@0.9.19
- jazz-tools@0.9.19
- jazz-browser-media-images@0.9.19
## 0.0.40
### Patch Changes
- jazz-react@0.9.18
- jazz-tools@0.9.18
- jazz-browser-media-images@0.9.18
## 0.0.39
### Patch Changes

View File

@@ -11,10 +11,6 @@ You can either
Create a new Jazz project, and use this example as a template.
```bash
npm create jazz-app@latest --example onboarding --project-name onboarding
```
or
```bash
npx create-jazz-app@latest --example onboarding --project-name onboarding
```

View File

@@ -1,7 +1,7 @@
{
"name": "jazz-example-onboarding",
"private": true,
"version": "0.0.39",
"version": "0.0.43",
"type": "module",
"scripts": {
"dev": "vite",

View File

@@ -1,5 +1,35 @@
# organization
## 0.0.35
### Patch Changes
- Updated dependencies [1be017d]
- jazz-tools@0.9.21
- jazz-react@0.9.21
## 0.0.34
### Patch Changes
- Updated dependencies [b01cc1f]
- jazz-tools@0.9.20
- jazz-react@0.9.20
## 0.0.33
### Patch Changes
- jazz-react@0.9.19
- jazz-tools@0.9.19
## 0.0.32
### Patch Changes
- jazz-react@0.9.18
- jazz-tools@0.9.18
## 0.0.31
### Patch Changes

View File

@@ -16,10 +16,6 @@ You can either
Create a new Jazz project, and use this example as a template.
```bash
npm create jazz-app@latest --example organization --project-name organization
```
or
```bash
npx create-jazz-app@latest --example organization --project-name organization
```

View File

@@ -1,7 +1,7 @@
{
"name": "organization",
"private": true,
"version": "0.0.31",
"version": "0.0.35",
"type": "module",
"scripts": {
"dev": "vite",

View File

@@ -1,5 +1,29 @@
# passkey-svelte
## 0.0.30
### Patch Changes
- jazz-svelte@0.9.21
## 0.0.29
### Patch Changes
- jazz-svelte@0.9.20
## 0.0.28
### Patch Changes
- jazz-svelte@0.9.19
## 0.0.27
### Patch Changes
- jazz-svelte@0.9.18
## 0.0.26
### Patch Changes

View File

@@ -21,10 +21,6 @@ You can either
Create a new Jazz project, and use this example as a template.
```bash
npm create jazz-app@latest --example passkey-svelte --project-name passkey-svelte
```
or
```bash
npx create-jazz-app@latest --example passkey-svelte --project-name passkey-svelte
```

View File

@@ -1,6 +1,6 @@
{
"name": "passkey-svelte",
"version": "0.0.26",
"version": "0.0.30",
"type": "module",
"private": true,
"scripts": {

View File

@@ -1,5 +1,35 @@
# minimal-auth-passkey
## 0.0.40
### Patch Changes
- Updated dependencies [1be017d]
- jazz-tools@0.9.21
- jazz-react@0.9.21
## 0.0.39
### Patch Changes
- Updated dependencies [b01cc1f]
- jazz-tools@0.9.20
- jazz-react@0.9.20
## 0.0.38
### Patch Changes
- jazz-react@0.9.19
- jazz-tools@0.9.19
## 0.0.37
### Patch Changes
- jazz-react@0.9.18
- jazz-tools@0.9.18
## 0.0.36
### Patch Changes

View File

@@ -15,10 +15,6 @@ You can either
Create a new Jazz project, and use this example as a template.
```bash
npm create jazz-app@latest --example passkey --project-name passkey
```
or
```bash
npx create-jazz-app@latest --example passkey --project-name passkey
```

View File

@@ -1,7 +1,7 @@
{
"name": "passkey",
"private": true,
"version": "0.0.36",
"version": "0.0.40",
"type": "module",
"scripts": {
"dev": "vite",

View File

@@ -1,5 +1,35 @@
# jazz-password-manager
## 0.0.61
### Patch Changes
- Updated dependencies [1be017d]
- jazz-tools@0.9.21
- jazz-react@0.9.21
## 0.0.60
### Patch Changes
- Updated dependencies [b01cc1f]
- jazz-tools@0.9.20
- jazz-react@0.9.20
## 0.0.59
### Patch Changes
- jazz-react@0.9.19
- jazz-tools@0.9.19
## 0.0.58
### Patch Changes
- jazz-react@0.9.18
- jazz-tools@0.9.18
## 0.0.57
### Patch Changes

View File

@@ -15,10 +15,6 @@ You can either
Create a new Jazz project, and use this example as a template.
```bash
npm create jazz-app@latest --example password-manager --project-name password-manager
```
or
```bash
npx create-jazz-app@latest --example password-manager --project-name password-manager
```

View File

@@ -1,7 +1,7 @@
{
"name": "jazz-password-manager",
"private": true,
"version": "0.0.57",
"version": "0.0.61",
"type": "module",
"scripts": {
"dev": "vite",
@@ -12,8 +12,8 @@
"clean-install": "rm -rf node_modules pnpm-lock.yaml && pnpm install"
},
"dependencies": {
"jazz-react": "workspace:0.9.17",
"jazz-tools": "workspace:0.9.17",
"jazz-react": "workspace:0.9.21",
"jazz-tools": "workspace:0.9.21",
"react": "^18.3.1",
"react-dom": "^18.3.1",
"react-hook-form": "^7.41.5",

View File

@@ -1,5 +1,39 @@
# jazz-example-pets
## 0.0.159
### Patch Changes
- Updated dependencies [1be017d]
- jazz-tools@0.9.21
- jazz-browser-media-images@0.9.21
- jazz-react@0.9.21
## 0.0.158
### Patch Changes
- Updated dependencies [b01cc1f]
- jazz-tools@0.9.20
- jazz-browser-media-images@0.9.20
- jazz-react@0.9.20
## 0.0.157
### Patch Changes
- jazz-react@0.9.19
- jazz-tools@0.9.19
- jazz-browser-media-images@0.9.19
## 0.0.156
### Patch Changes
- jazz-react@0.9.18
- jazz-tools@0.9.18
- jazz-browser-media-images@0.9.18
## 0.0.155
### Patch Changes

View File

@@ -13,10 +13,6 @@ You can either
Create a new Jazz project, and use this example as a template.
```bash
npm create jazz-app@latest --example pets --project-name pets
```
or
```bash
npx create-jazz-app@latest --example pets --project-name pets
```

View File

@@ -1,7 +1,7 @@
{
"name": "jazz-example-pets",
"private": true,
"version": "0.0.155",
"version": "0.0.159",
"type": "module",
"scripts": {
"dev": "vite",
@@ -19,9 +19,9 @@
"@radix-ui/react-toast": "^1.1.4",
"class-variance-authority": "^0.7.0",
"clsx": "^2.0.0",
"jazz-browser-media-images": "workspace:0.9.17",
"jazz-react": "workspace:0.9.17",
"jazz-tools": "workspace:0.9.17",
"jazz-browser-media-images": "workspace:0.9.21",
"jazz-react": "workspace:0.9.21",
"jazz-tools": "workspace:0.9.21",
"lucide-react": "^0.274.0",
"qrcode": "^1.5.3",
"react": "^18.3.1",
@@ -41,7 +41,7 @@
"@vitejs/plugin-react-swc": "^3.3.2",
"autoprefixer": "^10.4.20",
"is-ci": "^3.0.1",
"jazz-run": "workspace:0.9.17",
"jazz-run": "workspace:0.9.21",
"postcss": "^8.4.27",
"tailwindcss": "^3.4.15",
"typescript": "~5.6.2",

View File

@@ -1,5 +1,39 @@
# reactions
## 0.0.39
### Patch Changes
- Updated dependencies [1be017d]
- jazz-tools@0.9.21
- jazz-browser-media-images@0.9.21
- jazz-react@0.9.21
## 0.0.38
### Patch Changes
- Updated dependencies [b01cc1f]
- jazz-tools@0.9.20
- jazz-browser-media-images@0.9.20
- jazz-react@0.9.20
## 0.0.37
### Patch Changes
- jazz-react@0.9.19
- jazz-tools@0.9.19
- jazz-browser-media-images@0.9.19
## 0.0.36
### Patch Changes
- jazz-react@0.9.18
- jazz-tools@0.9.18
- jazz-browser-media-images@0.9.18
## 0.0.35
### Patch Changes

View File

@@ -13,10 +13,6 @@ You can either
Create a new Jazz project, and use this example as a template.
```bash
npm create jazz-app@latest --example reactions --project-name reactions
```
or
```bash
npx create-jazz-app@latest --example reactions --project-name reactions
```

View File

@@ -1,7 +1,7 @@
{
"name": "reactions",
"private": true,
"version": "0.0.35",
"version": "0.0.39",
"type": "module",
"scripts": {
"dev": "vite",

View File

@@ -1,5 +1,39 @@
# todo-vue
## 0.0.44
### Patch Changes
- Updated dependencies [1be017d]
- jazz-tools@0.9.21
- jazz-browser@0.9.21
- jazz-vue@0.9.21
## 0.0.43
### Patch Changes
- Updated dependencies [b01cc1f]
- jazz-tools@0.9.20
- jazz-browser@0.9.20
- jazz-vue@0.9.20
## 0.0.42
### Patch Changes
- jazz-browser@0.9.19
- jazz-tools@0.9.19
- jazz-vue@0.9.19
## 0.0.41
### Patch Changes
- jazz-browser@0.9.18
- jazz-tools@0.9.18
- jazz-vue@0.9.18
## 0.0.40
### Patch Changes

View File

@@ -11,10 +11,6 @@ You can either
Create a new Jazz project, and use this example as a template.
```bash
npm create jazz-app@latest --example todo-vue --project-name todo-vue
```
or
```bash
npx create-jazz-app@latest --example todo-vue --project-name todo-vue
```

View File

@@ -1,6 +1,6 @@
{
"name": "todo-vue",
"version": "0.0.40",
"version": "0.0.44",
"private": true,
"type": "module",
"scripts": {

View File

@@ -1,5 +1,35 @@
# jazz-example-todo
## 0.0.158
### Patch Changes
- Updated dependencies [1be017d]
- jazz-tools@0.9.21
- jazz-react@0.9.21
## 0.0.157
### Patch Changes
- Updated dependencies [b01cc1f]
- jazz-tools@0.9.20
- jazz-react@0.9.20
## 0.0.156
### Patch Changes
- jazz-react@0.9.19
- jazz-tools@0.9.19
## 0.0.155
### Patch Changes
- jazz-react@0.9.18
- jazz-tools@0.9.18
## 0.0.154
### Patch Changes

View File

@@ -13,10 +13,6 @@ You can either
Create a new Jazz project, and use this example as a template.
```bash
npm create jazz-app@latest --example todo --project-name todo
```
or
```bash
npx create-jazz-app@latest --example todo --project-name todo
```

View File

@@ -1,7 +1,7 @@
{
"name": "jazz-example-todo",
"private": true,
"version": "0.0.154",
"version": "0.0.158",
"type": "module",
"scripts": {
"dev": "vite",
@@ -16,8 +16,8 @@
"@radix-ui/react-toast": "^1.1.4",
"class-variance-authority": "^0.7.0",
"clsx": "^2.0.0",
"jazz-react": "workspace:0.9.17",
"jazz-tools": "workspace:0.9.17",
"jazz-react": "workspace:0.9.21",
"jazz-tools": "workspace:0.9.21",
"lucide-react": "^0.274.0",
"qrcode": "^1.5.3",
"react": "^18.3.1",

View File

@@ -1,5 +1,35 @@
# version-history
## 0.0.36
### Patch Changes
- Updated dependencies [1be017d]
- jazz-tools@0.9.21
- jazz-react@0.9.21
## 0.0.35
### Patch Changes
- Updated dependencies [b01cc1f]
- jazz-tools@0.9.20
- jazz-react@0.9.20
## 0.0.34
### Patch Changes
- jazz-react@0.9.19
- jazz-tools@0.9.19
## 0.0.33
### Patch Changes
- jazz-react@0.9.18
- jazz-tools@0.9.18
## 0.0.32
### Patch Changes

View File

@@ -13,10 +13,6 @@ You can either
Create a new Jazz project, and use this example as a template.
```bash
npm create jazz-app@latest --example version-history --project-name version-history
```
or
```bash
npx create-jazz-app@latest --example version-history --project-name version-history
```

View File

@@ -1,7 +1,7 @@
{
"name": "version-history",
"private": true,
"version": "0.0.32",
"version": "0.0.36",
"type": "module",
"scripts": {
"dev": "vite",

12
flake.lock generated
View File

@@ -5,11 +5,11 @@
"systems": "systems"
},
"locked": {
"lastModified": 1726560853,
"narHash": "sha256-X6rJYSESBVr3hBoH0WbKE5KvhPU5bloyZ2L4K60/fPQ=",
"lastModified": 1731533236,
"narHash": "sha256-l0KFg5HjrsfsO/JpG+r7fRrqm12kzFHyUHqHCVpMMbI=",
"owner": "numtide",
"repo": "flake-utils",
"rev": "c1dfcf08411b08f6b8615f7d8971a2bfa81d5e8a",
"rev": "11707dc2f618dd54ca8739b309ec4fc024de578b",
"type": "github"
},
"original": {
@@ -20,11 +20,11 @@
},
"nixpkgs": {
"locked": {
"lastModified": 1730785428,
"narHash": "sha256-Zwl8YgTVJTEum+L+0zVAWvXAGbWAuXHax3KzuejaDyo=",
"lastModified": 1737885589,
"narHash": "sha256-Zf0hSrtzaM1DEz8//+Xs51k/wdSajticVrATqDrfQjg=",
"owner": "nixos",
"repo": "nixpkgs",
"rev": "4aa36568d413aca0ea84a1684d2d46f55dbabad7",
"rev": "852ff1d9e153d8875a83602e03fdef8a63f0ecf8",
"type": "github"
},
"original": {

View File

@@ -18,12 +18,15 @@
buildInputs = with pkgs; [
nodejs_22
nodePackages.pnpm
git
];
shellHook = ''
echo ""
echo "Welcome to the Jazz development environment!"
echo "Run 'pnpm install' to install the dependencies."
echo ""
'';
};
});
}
}

View File

@@ -40,3 +40,6 @@ codeSamples
.turbo
.env
# LLM docs
public/llms*.txt

View File

@@ -1,7 +1,7 @@
import DocsLayout from "@/app/docs/[framework]/(others)/layout";
import { TableOfContents } from "@/components/docs/TableOfContents";
import ComingSoonPage from "@/components/docs/coming-soon.mdx";
import { docNavigationItems } from "@/lib/docNavigationItems";
import { docNavigationItems } from "@/lib/docNavigationItems.js";
import { Framework, frameworks } from "@/lib/framework";
import type { Toc } from "@stefanprobst/rehype-extract-toc";
import { Prose } from "gcmp-design-system/src/app/components/molecules/Prose";

View File

@@ -8,14 +8,6 @@ The Jazz docs are currently heavily work in progress, sorry about that!
Run the following command to create a new Jazz project from one of our example apps:
<CodeGroup>
```sh
npm create jazz-app@latest
```
</CodeGroup>
or
<CodeGroup>
```sh
npx create-jazz-app@latest
@@ -47,7 +39,20 @@ Sync and persist your data by setting up a [sync and storage infrastructure](/do
Learn how to structure your data using [collaborative values](/docs/schemas/covalues).
## API Reference
Many of the packages provided are documented in the [API Reference](/api-reference).
## LLM Docs
We support the [llms.txt](https://llmstxt.org/) convention for making documentation available to large language models and the applications that make use of them.
We currently have:
- [/llms.txt](/llms.txt) - A overview listing of the available packages and their documentation
- [/llms-full.txt](/llms-full.txt) - Full documentation for our packages
## Get support
If you have any questions or need assistance, please don't hesitate to reach out to us on [Discord](https://discord.gg/utDMjHYg42).
We would love to help you get started.
We would love to help you get started.

View File

@@ -3,7 +3,7 @@
import { SideNav } from "@/components/SideNav";
import { SideNavHeader } from "@/components/SideNavHeader";
import { FrameworkSelect } from "@/components/docs/FrameworkSelect";
import { docNavigationItems } from "@/lib/docNavigationItems";
import { docNavigationItems } from "@/lib/docNavigationItems.js";
import { useFramework } from "@/lib/use-framework";
import { clsx } from "clsx";

View File

@@ -156,8 +156,14 @@ export function FnDecl({
doc: ReactNode;
example: ReactNode;
}) {
// Extract the method name from the signature (everything before the first parenthesis or type parameter)
const methodName = signature.match(/^[^(<]+/)?.[0];
return (
<div className="text-sm flex flex-col gap-3 my-2 p-3 rounded bg-stone-50 dark:bg-stone-925">
<div
id={methodName}
className="text-sm flex flex-col gap-3 my-2 p-3 rounded bg-stone-50 dark:bg-stone-925"
>
<div className="flex flex-col gap-2">
<div>
{<Highlight>{signature + ":"}</Highlight>}{" "}

View File

@@ -0,0 +1,511 @@
import { promises as fs } from "fs";
import path from "path";
import { Deserializer, ReflectionKind } from "typedoc";
import { DOC_SECTIONS, PACKAGES } from "./utils/config.mjs";
import {
getPackageDescription,
loadTypedocFiles,
writeDocsFile,
} from "./utils/index.mjs";
function formatType(type) {
if (!type) return "unknown";
// Handle type aliases and references
if (type.type === "reference") {
const name = type.package ? `${type.package}.${type.name}` : type.name;
return (
name +
(type.typeArguments
? `<${type.typeArguments.map(formatType).join(", ")}>`
: "")
);
}
// Handle union types
if (type.type === "union") {
return type.types.map(formatType).join(" | ");
}
// Handle array types
if (type.type === "array") {
return `${formatType(type.elementType)}[]`;
}
// Handle basic types
if (type.type === "intrinsic" || type.type === "literal") {
return typeof type.value !== "undefined"
? JSON.stringify(type.value)
: type.name;
}
// Handle tuple types
if (type.type === "tuple") {
return `[${type.elements.map(formatType).join(", ")}]`;
}
// Handle intersection types
if (type.type === "intersection") {
return type.types.map(formatType).join(" & ");
}
// Handle template literal types
if (type.type === "template-literal") {
return `\`${type.head}${type.tail.map((t) => `\${${formatType(t[0])}}${t[1]}`).join("")}\``;
}
// Handle reflection types (object types and function types)
if (type.type === "reflection") {
if (type.declaration.signatures) {
const sig = type.declaration.signatures[0];
const params =
sig.parameters
?.map(
(p) =>
`${p.name}${p.flags?.isOptional ? "?" : ""}: ${formatType(p.type)}`,
)
.join(", ") || "";
return `(${params}) => ${formatType(sig.type)}`;
}
if (type.declaration.children) {
return (
"{ " +
type.declaration.children
.map((child) => {
const optional = child.flags?.isOptional ? "?" : "";
return `${child.name}${optional}: ${formatType(child.type)}`;
})
.join("; ") +
" }"
);
}
}
// Handle query types
if (type.type === "query") {
return `typeof ${formatType(type.queryType)}`;
}
// Handle conditional types
if (type.type === "conditional") {
return `${formatType(type.checkType)} extends ${formatType(type.extendsType)} ? ${formatType(type.trueType)} : ${formatType(type.falseType)}`;
}
// Handle index access types
if (type.type === "indexedAccess") {
return `${formatType(type.objectType)}[${formatType(type.indexType)}]`;
}
// Handle mapped types
if (type.type === "mapped") {
const readonly = type.readonlyModifier === "+" ? "readonly " : "";
const optional = type.optionalModifier === "+" ? "?" : "";
return `{ ${readonly}[${type.parameter} in ${formatType(type.parameterType)}]${optional}: ${formatType(type.templateType)} }`;
}
// Handle type operators
if (type.type === "typeOperator") {
return `${type.operator} ${formatType(type.target)}`;
}
// Handle predicate types
if (type.type === "predicate") {
return `${type.name} is ${formatType(type.targetType)}`;
}
// Handle inferred types
if (type.type === "inferred") {
return `infer ${type.name}`;
}
// Handle rest types
if (type.type === "rest") {
return `...${formatType(type.elementType)}`;
}
// Handle unknown types with more detail
if (type.toString) {
return type.toString();
}
return "unknown";
}
function formatComment(comment) {
if (!comment) return "";
let text =
comment.summary
?.map((part) => part.text)
.join("")
.trim() || "";
// Add parameter descriptions if available
if (comment.blockTags) {
const params = comment.blockTags
.filter((tag) => tag.tag === "@param")
.map((tag) => {
const paramName = tag.param;
let description = "";
let codeExample = "";
tag.content.forEach((part) => {
if (part.kind === "code") {
// Don't wrap in code blocks since examples are already wrapped
codeExample += "\n" + part.text + "\n";
} else {
description += part.text;
}
});
return `- ${paramName}: ${description.trim()}${codeExample}`;
});
if (params.length > 0) {
text += "\n\nParameters:\n" + params.join("\n");
}
// Add remarks if available
const remarks = comment.blockTags
.filter((tag) => tag.tag === "@remarks")
.map((tag) =>
tag.content
.map((part) => part.text)
.join("")
.trim(),
);
if (remarks.length > 0) {
text += "\n\nRemarks:\n" + remarks.join("\n");
}
// Add examples
const examples = comment.blockTags
.filter((tag) => tag.tag === "@example")
.map((tag) =>
tag.content
.map((part) => {
if (part.kind === "code") {
// Don't wrap in code blocks since examples are already wrapped
return "\n" + part.text + "\n";
}
return part.text;
})
.join("")
.trim(),
);
if (examples.length > 0) {
text += "\n\nExamples:\n" + examples.join("\n");
}
}
return text;
}
async function readMdxContent(url) {
try {
// Special case for the introduction
if (url === "/docs") {
const introPath = path.join(
process.cwd(),
"components/docs/docs-intro.mdx",
);
try {
const content = await fs.readFile(introPath, "utf8");
// Remove imports and exports
return content
.replace(/^import[^\n]*\n/gm, "")
.replace(/export const metadata[^;]*;/, "")
.trim();
} catch (err) {
if (err.code !== "ENOENT") throw err;
}
}
// Convert URL to file path
// Remove leading slash and 'docs' from URL
const relativePath = url.replace(/^\/docs\/?/, "");
// Base directory for docs
const baseDir = path.join(process.cwd(), "app/docs/[framework]/[...slug]");
// If it's a directory, try to read all framework variants
const fullPath = path.join(baseDir, relativePath);
try {
const stats = await fs.stat(fullPath);
if (stats.isDirectory()) {
// Read all MDX files in the directory
const files = await fs.readdir(fullPath);
const mdxFiles = files.filter((f) => f.endsWith(".mdx"));
if (mdxFiles.length === 0) return null;
// Combine content from all framework variants
const contents = await Promise.all(
mdxFiles.map(async (file) => {
const content = await fs.readFile(
path.join(fullPath, file),
"utf8",
);
// Remove imports and exports
const cleanContent = content
.replace(/^import[^\n]*\n/gm, "")
.replace(/export const metadata[^;]*;/, "")
.trim();
return `### ${path.basename(file, ".mdx")} Implementation\n\n${cleanContent}`;
}),
);
return contents.join("\n\n---\n\n");
}
} catch (err) {
if (err.code !== "ENOENT") throw err;
}
// Try as a single MDX file
const mdxPath = fullPath + ".mdx";
try {
const content = await fs.readFile(mdxPath, "utf8");
// Remove imports and exports
return content
.replace(/^import[^\n]*\n/gm, "")
.replace(/export const metadata[^;]*;/, "")
.trim();
} catch (err) {
if (err.code !== "ENOENT") throw err;
}
console.warn(`Could not find MDX content for ${url} at ${fullPath}`);
return null;
} catch (error) {
console.warn(`Error reading MDX content for ${url}:`, error);
return null;
}
}
async function generateDetailedDocs(docs) {
const output = [];
const deserializer = new Deserializer();
// Project title
output.push("# Jazz\n");
// Documentation sections with full content
output.push("## Documentation\n");
for (const section of DOC_SECTIONS) {
output.push(`### ${section.title}\n`);
for (const page of section.pages) {
output.push(`#### ${page.title}\n`);
const content = await readMdxContent(page.url);
console.log(content);
if (content) {
// If the content contains framework-specific implementations, they're already properly formatted
// Otherwise, just add the content directly
output.push(content + "\n");
}
output.push("\n");
}
}
// API Reference by package
output.push("## API Reference\n\n");
// for (const [packageName, packageDocs] of Object.entries(docs)) {
// const project = deserializer.reviveProject(packageDocs, packageName);
// // Add package heading with description
// output.push(`### ${packageName}\n`);
// output.push(`${getPackageDescription(packageName)}\n\n`);
// output.push(
// `[API Reference](https://jazz.tools/api-reference/${packageName})\n\n`,
// );
// // Process each category
// project.categories?.forEach((category) => {
// output.push(`#### ${category.title}\n`);
// category.children.forEach((child) => {
// // Add name, kind, and API reference link
// const apiLink = `[API Reference](https://jazz.tools/api-reference/${packageName}#${child.name})`;
// output.push(
// `##### ${child.name} (${ReflectionKind[child.kind]}) ${apiLink}\n`,
// );
// // Add description if available
// const description = formatComment(child.comment);
// if (description) {
// output.push(`${description}\n`);
// }
// output.push("\n");
// // Add properties for classes/interfaces
// if (child.children) {
// output.push("Properties:\n");
// // Group overloaded methods by name
// const methodGroups = new Map();
// child.children.forEach((prop) => {
// if (prop.signatures?.length > 0) {
// const existing = methodGroups.get(prop.name) || [];
// methodGroups.set(prop.name, [...existing, prop]);
// }
// });
// child.children.forEach((prop) => {
// // Skip if this is an overloaded method that we'll handle later
// if (
// prop.signatures?.length > 0 &&
// methodGroups.get(prop.name)?.length > 1
// ) {
// return;
// }
// const type = formatType(prop.type);
// const description = formatComment(prop.comment);
// // Output the property name and type, but skip the type for methods since we'll show signatures
// if (prop.signatures?.length > 0) {
// output.push(
// `- ${prop.name}${description ? ` - ${description}` : ""}\n`,
// );
// } else {
// output.push(
// `- ${prop.name}: ${type}${description ? ` - ${description}` : ""}\n`,
// );
// }
// // Handle method signatures with proper indentation
// if (prop.signatures) {
// prop.signatures.forEach((sig) => {
// const params = sig.parameters
// ?.map((p) => {
// const paramType = formatType(p.type);
// return `${p.name}: ${paramType}`;
// })
// .join(", ");
// output.push(
// ` Method signature: \`(${params || ""}) => ${formatType(sig.type)}\`\n`,
// );
// // Add API reference URL for the method
// output.push(
// ` [API Reference](https://jazz.tools/api-reference/${packageName}#${child.name}.${prop.name})\n`,
// );
// const methodDesc = formatComment(sig.comment);
// if (methodDesc) {
// // Indent each line of the description
// const indentedDesc = methodDesc
// .split("\n")
// .map((line) => ` ${line}`)
// .join("\n");
// output.push(`${indentedDesc}\n`);
// }
// });
// }
// });
// // Handle overloaded methods
// methodGroups.forEach((props, name) => {
// if (props.length <= 1) return;
// const firstProp = props[0];
// const description = formatComment(firstProp.comment);
// output.push(`- ${name}${description ? ` - ${description}` : ""}\n`);
// // Combine all signatures with proper indentation
// const allSignatures = props.flatMap((p) => p.signatures || []);
// allSignatures.forEach((sig) => {
// const params = sig.parameters
// ?.map((p) => {
// const paramType = formatType(p.type);
// return `${p.name}: ${paramType}`;
// })
// .join(", ");
// output.push(
// ` Method signature: \`(${params || ""}) => ${formatType(sig.type)}\`\n`,
// );
// // Add API reference URL for the overloaded method
// output.push(
// ` [API Reference](https://jazz.tools/api-reference/${packageName}#${child.name}.${name})\n`,
// );
// const methodDesc = formatComment(sig.comment);
// if (methodDesc) {
// // Indent each line of the description
// const indentedDesc = methodDesc
// .split("\n")
// .map((line) => ` ${line}`)
// .join("\n");
// output.push(`${indentedDesc}\n`);
// }
// });
// });
// }
// // Add signatures for functions/methods
// if (child.signatures) {
// child.signatures.forEach((sig) => {
// const params = sig.parameters
// ?.map((p) => {
// const type = formatType(p.type);
// const desc = formatComment(p.comment);
// return `${p.name}: ${type}${desc ? ` - ${desc}` : ""}`;
// })
// .join(", ");
// output.push(`Signature: ${child.name}(${params || ""})`);
// if (sig.type) {
// output.push(`Returns: ${formatType(sig.type)}`);
// if (sig.comment?.returns) {
// output.push(
// `Return description: ${sig.comment.returns
// .map((part) => part.text)
// .join("")
// .trim()}`,
// );
// }
// }
// const sigComment = formatComment(sig.comment);
// if (sigComment) {
// output.push(`\n${sigComment}`);
// }
// output.push("\n");
// });
// }
// output.push("\n");
// });
// });
// }
// Optional section for additional resources
output.push("## Resources\n\n");
output.push(
"- [Documentation](https://jazz.tools/docs): Detailed documentation about Jazz\n",
);
output.push(
"- [Examples](https://jazz.tools/examples): Code examples and tutorials\n",
);
await writeDocsFile("llms-full.txt", output.join("\n"));
}
// Main execution
async function main() {
console.log("Generating detailed LLM docs...");
const docs = await loadTypedocFiles();
await generateDetailedDocs(docs);
}
main().catch(console.error);

View File

@@ -0,0 +1,80 @@
import { Deserializer } from "typedoc";
import { DOC_SECTIONS, PACKAGES } from "./utils/config.mjs";
import {
cleanDescription,
loadTypedocFiles,
writeDocsFile,
} from "./utils/index.mjs";
async function generateConciseDocs(docs) {
const output = [];
const deserializer = new Deserializer();
// Project title
output.push("# Jazz\n");
// Documentation sections
output.push("## Documentation\n");
DOC_SECTIONS.forEach((section) => {
output.push(`### ${section.title}\n`);
section.pages.forEach((page) => {
output.push(`- [${page.title}](https://jazz.tools${page.url})\n`);
});
output.push("\n");
});
// API Reference by package
for (const [packageName, packageDocs] of Object.entries(docs)) {
const project = deserializer.reviveProject(packageDocs, packageName);
// Add package heading
output.push(`## ${packageName}\n`);
// Process each category and its exports with direct links
if (project.categories) {
const seen = new Set(); // Track seen names to avoid duplicates
project.categories.forEach((category) => {
category.children.forEach((child) => {
if (seen.has(child.name)) return;
seen.add(child.name);
// Get and clean up description
let description = child.comment?.summary
? cleanDescription(child.comment.summary)
: "";
// Truncate description if it's too long
if (description && description.length > 150) {
description = description.substring(0, 147) + "...";
}
// Create the line without wrapping
output.push(
`- [${child.name}](https://jazz.tools/api-reference/${packageName}#${child.name})${description ? `: ${description}` : ""}\n`,
);
});
});
output.push("\n");
}
}
// Optional section for additional resources
output.push("## Optional\n");
output.push(
"- [Documentation](https://jazz.tools/docs): Detailed documentation about Jazz\n",
);
output.push(
"- [Examples](https://jazz.tools/examples): Code examples and tutorials\n",
);
await writeDocsFile("llms.txt", output.join(""));
}
// Main execution
async function main() {
console.log("Generating concise LLM docs...");
const docs = await loadTypedocFiles();
await generateConciseDocs(docs);
}
main().catch(console.error);

View File

@@ -1,21 +1,7 @@
import { Application } from "typedoc";
import { PACKAGES } from "./utils/config.mjs";
for (const { packageName, entryPoint, tsconfig, typedocOptions } of [
{
packageName: "jazz-tools",
entryPoint: "exports.ts",
},
{
packageName: "jazz-react",
entryPoint: "index.ts",
typedocOptions: {
skipErrorChecking: true, // TODO: remove this. Temporary workaround
},
},
{ packageName: "jazz-browser" },
{ packageName: "jazz-browser-media-images" },
{ packageName: "jazz-nodejs" },
]) {
for (const { packageName, entryPoint, tsconfig, typedocOptions } of PACKAGES) {
const app = await Application.bootstrapWithPlugins({
entryPoints: [
`../../packages/${packageName}/src/${entryPoint || "index.ts"}`,

View File

@@ -0,0 +1,47 @@
import { docNavigationItems } from "../../lib/docNavigationItems.js";
// Transform docNavigationItems into the format we need
function transformNavItems() {
return docNavigationItems
.map((section) => ({
title: section.name,
pages: section.items
.filter((item) => item.done !== 0) // Skip not-yet-written docs
.map((item) => ({
title: item.name,
url: item.href,
})),
}))
.filter((section) => section.pages.length > 0); // Only include sections with pages
}
export const DOC_SECTIONS = transformNavItems();
export const PACKAGES = [
{
packageName: "jazz-tools",
entryPoint: "exports.ts",
description:
"The base implementation for Jazz, a framework for distributed state. Provides a high-level API around the CoJSON protocol.",
},
{
packageName: "jazz-react",
entryPoint: "index.ts",
description: "React bindings for Jazz, a framework for distributed state.",
typedocOptions: {
skipErrorChecking: true, // TODO: remove this. Temporary workaround
},
},
{
packageName: "jazz-browser",
description: "Browser (Vanilla JavaScript) bindings for Jazz",
},
{
packageName: "jazz-browser-media-images",
description: "Image handling utilities for Jazz in the browser",
},
{
packageName: "jazz-nodejs",
description: "NodeJS/Bun server worker bindings for Jazz",
},
];

View File

@@ -0,0 +1,58 @@
import path from "path";
import fs from "fs/promises";
import { PACKAGES } from "./config.mjs";
// Common configuration
export const PACKAGE_DESCRIPTIONS = {
"jazz-tools":
"The base implementation for Jazz, a framework for distributed state. Provides a high-level API around the CoJSON protocol.",
"jazz-react": "React bindings for Jazz, a framework for distributed state.",
"jazz-browser": "Browser (Vanilla JavaScript) bindings for Jazz",
"jazz-browser-media-images":
"Image handling utilities for Jazz in the browser",
"jazz-nodejs": "NodeJS/Bun server worker bindings for Jazz",
};
// Helper functions
export async function loadTypedocFiles() {
const docs = {};
for (const { packageName } of PACKAGES) {
docs[packageName] = JSON.parse(
await fs.readFile(
path.join(process.cwd(), "typedoc", packageName + ".json"),
"utf-8",
),
);
}
return docs;
}
export function getPackageDescription(packageName) {
const pkg = PACKAGES.find((p) => p.packageName === packageName);
return pkg?.description || "";
}
export function cleanDescription(description) {
if (!description) return "";
return (
description
.map((part) => part.text)
.join(" ")
.trim()
// Remove code blocks
.replace(/```[\s\S]*?```/g, "")
// Remove line breaks and extra spaces
.replace(/\s+/g, " ")
// Clean up backticks
.replace(/\`/g, "'")
);
}
export async function writeDocsFile(filename, content) {
await fs.writeFile(
path.join(process.cwd(), "public", filename),
content,
"utf8",
);
console.log(`Documentation generated at 'public/${filename}'`);
}

View File

@@ -5,11 +5,15 @@
"type": "module",
"scripts": {
"dev": "NODE_OPTIONS=--max-old-space-size=8192 next dev",
"build:generate-docs": "node genDocs.mjs --build",
"build:generate-docs": "pnpm run generate:docs && pnpm run generate:llm-docs:all",
"build": "next build",
"start": "next start",
"format-and-lint": "biome check .",
"format-and-lint:fix": "biome check . --write"
"format-and-lint:fix": "biome check . --write",
"generate:docs": "node generate-docs/typedocs.mjs --build",
"generate:llm-docs:all": "pnpm run generate:llm-docs:concise && pnpm run generate:llm-docs:full",
"generate:llm-docs:concise": "node generate-docs/llms.mjs",
"generate:llm-docs:full": "node generate-docs/llms-full.mjs"
},
"packageManager": "pnpm@9.14.0",
"dependencies": {

View File

@@ -27,7 +27,8 @@
"**/*.ts",
"**/*.tsx",
".next/types/**/*.ts",
"mdx.d.ts"
"mdx.d.ts",
"lib/docNavigationItems.js"
],
"exclude": ["node_modules"]
}

View File

@@ -1,5 +1,21 @@
# cojson-storage-indexeddb
## 0.9.19
### Patch Changes
- Updated dependencies [6ad0a9f]
- cojson@0.9.19
- cojson-storage@0.9.19
## 0.9.18
### Patch Changes
- Updated dependencies [8898b10]
- cojson@0.9.18
- cojson-storage@0.9.18
## 0.9.13
### Patch Changes

View File

@@ -1,6 +1,6 @@
{
"name": "cojson-storage-indexeddb",
"version": "0.9.13",
"version": "0.9.19",
"main": "dist/index.js",
"type": "module",
"types": "src/index.ts",

View File

@@ -1,5 +1,21 @@
# cojson-storage-sqlite
## 0.8.58
### Patch Changes
- Updated dependencies [6ad0a9f]
- cojson@0.9.19
- cojson-storage@0.9.19
## 0.8.57
### Patch Changes
- Updated dependencies [8898b10]
- cojson@0.9.18
- cojson-storage@0.9.18
## 0.8.56
### Patch Changes

View File

@@ -1,7 +1,7 @@
{
"name": "cojson-storage-rn-sqlite",
"type": "module",
"version": "0.8.56",
"version": "0.8.58",
"main": "dist/index.js",
"types": "src/index.ts",
"license": "MIT",

View File

@@ -1,5 +1,21 @@
# cojson-storage-sqlite
## 0.9.19
### Patch Changes
- Updated dependencies [6ad0a9f]
- cojson@0.9.19
- cojson-storage@0.9.19
## 0.9.18
### Patch Changes
- Updated dependencies [8898b10]
- cojson@0.9.18
- cojson-storage@0.9.18
## 0.9.13
### Patch Changes

View File

@@ -1,13 +1,13 @@
{
"name": "cojson-storage-sqlite",
"type": "module",
"version": "0.9.13",
"version": "0.9.19",
"main": "dist/index.js",
"types": "src/index.ts",
"license": "MIT",
"dependencies": {
"better-sqlite3": "^11.7.0",
"cojson": "workspace:0.9.13",
"cojson": "workspace:0.9.19",
"cojson-storage": "workspace:*"
},
"devDependencies": {

View File

@@ -1,5 +1,19 @@
# cojson-storage
## 0.9.19
### Patch Changes
- Updated dependencies [6ad0a9f]
- cojson@0.9.19
## 0.9.18
### Patch Changes
- Updated dependencies [8898b10]
- cojson@0.9.18
## 0.9.13
### Patch Changes

View File

@@ -1,6 +1,6 @@
{
"name": "cojson-storage",
"version": "0.9.13",
"version": "0.9.19",
"main": "dist/index.js",
"type": "module",
"types": "src/index.ts",

View File

@@ -1,5 +1,19 @@
# cojson-transport-nodejs-ws
## 0.9.19
### Patch Changes
- Updated dependencies [6ad0a9f]
- cojson@0.9.19
## 0.9.18
### Patch Changes
- Updated dependencies [8898b10]
- cojson@0.9.18
## 0.9.13
### Patch Changes

View File

@@ -1,12 +1,12 @@
{
"name": "cojson-transport-ws",
"type": "module",
"version": "0.9.13",
"version": "0.9.19",
"main": "dist/index.js",
"types": "src/index.ts",
"license": "MIT",
"dependencies": {
"cojson": "workspace:0.9.13",
"cojson": "workspace:0.9.19",
"typescript": "~5.6.2"
},
"scripts": {

View File

@@ -1,5 +1,17 @@
# cojson
## 0.9.19
### Patch Changes
- 6ad0a9f: Export Json types
## 0.9.18
### Patch Changes
- 8898b10: Export AccountRole type
## 0.9.13
### Patch Changes

View File

@@ -24,7 +24,7 @@
},
"type": "module",
"license": "MIT",
"version": "0.9.13",
"version": "0.9.19",
"devDependencies": {
"@opentelemetry/sdk-metrics": "^1.29.0",
"@types/jest": "^29.5.3",

View File

@@ -17,6 +17,8 @@ import { OpID, RawCoList } from "./coValues/coList.js";
import { RawCoMap } from "./coValues/coMap.js";
import { RawCoPlainText, stringifyOpID } from "./coValues/coPlainText.js";
import {
BinaryStreamItem,
BinaryStreamStart,
CoStreamItem,
RawBinaryCoStream,
RawCoStream,
@@ -57,7 +59,7 @@ import type {
import type { InviteSecret } from "./coValues/group.js";
import type { AgentSecret } from "./crypto/crypto.js";
import type { AgentID, RawCoID, SessionID } from "./ids.js";
import type { JsonValue } from "./jsonValue.js";
import type { JsonObject, JsonValue } from "./jsonValue.js";
import type * as Media from "./media.js";
import { disablePermissionErrors } from "./permissions.js";
import type {
@@ -128,6 +130,7 @@ export {
ControlledAgent,
RawControlledAccount,
MAX_RECOMMENDED_TX_SIZE,
JsonObject,
JsonValue,
Peer,
BinaryStreamInfo,
@@ -143,6 +146,8 @@ export {
RawCoPlainText,
stringifyOpID,
logger,
base64URLtoBytes,
bytesToBase64url,
};
export type {
@@ -157,6 +162,8 @@ export type {
CoValueUniqueness,
Stringified,
CoStreamItem,
BinaryStreamItem,
BinaryStreamStart,
OpID,
AccountRole,
};

View File

@@ -1,43 +1,36 @@
import { describe, expect, onTestFinished, test, vi } from "vitest";
import { beforeEach, describe, expect, onTestFinished, test, vi } from "vitest";
import {
GlobalSyncStateListenerCallback,
PeerSyncStateListenerCallback,
} from "../SyncStateManager.js";
import { accountHeaderForInitialAgentSecret } from "../coValues/account.js";
import { connectedPeers } from "../streamUtils.js";
import { emptyKnownState } from "../sync.js";
import {
blockMessageTypeOnOutgoingPeer,
connectNodeToSyncServer,
createTestNode,
createTwoConnectedNodes,
loadCoValueOrFail,
setupSyncServer,
waitFor,
} from "./testUtils.js";
let jazzCloud = setupSyncServer();
beforeEach(async () => {
jazzCloud = setupSyncServer();
});
describe("SyncStateManager", () => {
test("subscribeToUpdates receives updates when peer state changes", async () => {
// Setup nodes
const client = createTestNode();
const jazzCloud = createTestNode();
const { nodeToServerPeer } = connectNodeToSyncServer(client);
// Create test data
const group = client.createGroup();
const map = group.createMap();
map.set("key1", "value1", "trusting");
// Connect nodes
const [clientAsPeer, jazzCloudAsPeer] = connectedPeers(
"clientConnection",
"jazzCloudConnection",
{
peer1role: "client",
peer2role: "server",
},
);
client.syncManager.addPeer(jazzCloudAsPeer);
jazzCloud.syncManager.addPeer(clientAsPeer);
const subscriptionManager = client.syncManager.syncState;
const updateSpy: GlobalSyncStateListenerCallback = vi.fn();
@@ -46,21 +39,21 @@ describe("SyncStateManager", () => {
await client.syncManager.actuallySyncCoValue(map.core);
expect(updateSpy).toHaveBeenCalledWith(
"jazzCloudConnection",
nodeToServerPeer.id,
emptyKnownState(map.core.id),
{ uploaded: false },
);
await waitFor(() => {
return subscriptionManager.getCurrentSyncState(
"jazzCloudConnection",
nodeToServerPeer.id,
map.core.id,
).uploaded;
});
expect(updateSpy).toHaveBeenCalledWith(
"jazzCloudConnection",
client.syncManager.peers["jazzCloudConnection"]!.knownStates.get(
nodeToServerPeer.id,
client.syncManager.peers[nodeToServerPeer.id]!.knownStates.get(
map.core.id,
)!,
{ uploaded: true },
@@ -73,42 +66,30 @@ describe("SyncStateManager", () => {
test("subscribeToPeerUpdates receives updates only for specific peer", async () => {
// Setup nodes
const client = createTestNode();
const jazzCloud = createTestNode();
const { nodeToServerPeer } = connectNodeToSyncServer(client);
// Create test data
const group = client.createGroup();
const map = group.createMap();
map.set("key1", "value1", "trusting");
// Connect nodes
const [clientAsPeer, jazzCloudAsPeer] = connectedPeers(
"clientConnection",
"jazzCloudConnection",
{
peer1role: "client",
peer2role: "server",
},
);
const [clientStoragePeer] = connectedPeers("clientStorage", "unusedPeer", {
peer1role: "client",
peer2role: "server",
});
client.syncManager.addPeer(jazzCloudAsPeer);
client.syncManager.addPeer(clientStoragePeer);
jazzCloud.syncManager.addPeer(clientAsPeer);
const subscriptionManager = client.syncManager.syncState;
const updateToJazzCloudSpy: PeerSyncStateListenerCallback = vi.fn();
const updateToStorageSpy: PeerSyncStateListenerCallback = vi.fn();
const unsubscribe1 = subscriptionManager.subscribeToPeerUpdates(
"jazzCloudConnection",
nodeToServerPeer.id,
updateToJazzCloudSpy,
);
const unsubscribe2 = subscriptionManager.subscribeToPeerUpdates(
"clientStorage",
clientStoragePeer.id,
updateToStorageSpy,
);
@@ -126,13 +107,13 @@ describe("SyncStateManager", () => {
await waitFor(() => {
return subscriptionManager.getCurrentSyncState(
"jazzCloudConnection",
nodeToServerPeer.id,
map.core.id,
).uploaded;
});
expect(updateToJazzCloudSpy).toHaveBeenLastCalledWith(
client.syncManager.peers["jazzCloudConnection"]!.knownStates.get(
client.syncManager.peers[nodeToServerPeer.id]!.knownStates.get(
map.core.id,
)!,
{ uploaded: true },
@@ -147,80 +128,50 @@ describe("SyncStateManager", () => {
test("getIsCoValueFullyUploadedIntoPeer returns correct status", async () => {
// Setup nodes
const client = createTestNode();
const jazzCloud = createTestNode();
const { nodeToServerPeer } = connectNodeToSyncServer(client);
// Create test data
const group = client.createGroup();
const map = group.createMap();
map.set("key1", "value1", "trusting");
// Connect nodes
const [clientAsPeer, jazzCloudAsPeer] = connectedPeers(
"clientConnection",
"jazzCloudConnection",
{
peer1role: "client",
peer2role: "server",
},
);
client.syncManager.addPeer(jazzCloudAsPeer);
jazzCloud.syncManager.addPeer(clientAsPeer);
await client.syncManager.actuallySyncCoValue(map.core);
const subscriptionManager = client.syncManager.syncState;
expect(
subscriptionManager.getCurrentSyncState(
"jazzCloudConnection",
map.core.id,
).uploaded,
subscriptionManager.getCurrentSyncState(nodeToServerPeer.id, map.core.id)
.uploaded,
).toBe(false);
await waitFor(() => {
return subscriptionManager.getCurrentSyncState(
"jazzCloudConnection",
nodeToServerPeer.id,
map.core.id,
).uploaded;
});
expect(
subscriptionManager.getCurrentSyncState(
"jazzCloudConnection",
map.core.id,
).uploaded,
subscriptionManager.getCurrentSyncState(nodeToServerPeer.id, map.core.id)
.uploaded,
).toBe(true);
});
test("unsubscribe stops receiving updates", async () => {
// Setup nodes
const client = createTestNode();
const jazzCloud = createTestNode();
const { nodeToServerPeer } = connectNodeToSyncServer(client);
// Create test data
const group = client.createGroup();
const map = group.createMap();
map.set("key1", "value1", "trusting");
// Connect nodes
const [clientAsPeer, jazzCloudAsPeer] = connectedPeers(
"clientConnection",
"jazzCloudConnection",
{
peer1role: "client",
peer2role: "server",
},
);
client.syncManager.addPeer(jazzCloudAsPeer);
jazzCloud.syncManager.addPeer(clientAsPeer);
const subscriptionManager = client.syncManager.syncState;
const anyUpdateSpy = vi.fn();
const unsubscribe1 = subscriptionManager.subscribeToUpdates(anyUpdateSpy);
const unsubscribe2 = subscriptionManager.subscribeToPeerUpdates(
"jazzCloudConnection",
nodeToServerPeer.id,
anyUpdateSpy,
);
@@ -233,7 +184,7 @@ describe("SyncStateManager", () => {
await waitFor(() => {
return subscriptionManager.getCurrentSyncState(
"jazzCloudConnection",
nodeToServerPeer.id,
map.core.id,
).uploaded;
});
@@ -243,22 +194,21 @@ describe("SyncStateManager", () => {
test("getCurrentSyncState should return the correct state", async () => {
// Setup nodes
const clientNode = createTestNode();
const serverNode = jazzCloud;
const {
node1: clientNode,
node2: serverNode,
node1ToNode2Peer: clientToServerPeer,
node2ToNode1Peer: serverToClientPeer,
} = await createTwoConnectedNodes("client", "server");
nodeToServerPeer: clientToServerPeer,
serverToNodePeer: serverToClientPeer,
} = connectNodeToSyncServer(clientNode);
// Create test data
const group = clientNode.node.createGroup();
const group = clientNode.createGroup();
const map = group.createMap();
map.set("key1", "value1", "trusting");
group.addMember("everyone", "writer");
// Initially should not be synced
expect(
clientNode.node.syncManager.syncState.getCurrentSyncState(
clientNode.syncManager.syncState.getCurrentSyncState(
clientToServerPeer.id,
map.core.id,
),
@@ -268,13 +218,13 @@ describe("SyncStateManager", () => {
await map.core.waitForSync();
expect(
clientNode.node.syncManager.syncState.getCurrentSyncState(
clientNode.syncManager.syncState.getCurrentSyncState(
clientToServerPeer.id,
map.core.id,
),
).toEqual({ uploaded: true });
const mapOnServer = await loadCoValueOrFail(serverNode.node, map.id);
const mapOnServer = await loadCoValueOrFail(serverNode, map.id);
// Block the content messages so the client won't fully sync immediately
const outgoing = blockMessageTypeOnOutgoingPeer(
@@ -285,14 +235,14 @@ describe("SyncStateManager", () => {
mapOnServer.set("key2", "value2", "trusting");
expect(
clientNode.node.syncManager.syncState.getCurrentSyncState(
clientNode.syncManager.syncState.getCurrentSyncState(
clientToServerPeer.id,
map.core.id,
),
).toEqual({ uploaded: true });
expect(
serverNode.node.syncManager.syncState.getCurrentSyncState(
serverNode.syncManager.syncState.getCurrentSyncState(
serverToClientPeer.id,
map.core.id,
),
@@ -304,14 +254,14 @@ describe("SyncStateManager", () => {
await mapOnServer.core.waitForSync();
expect(
clientNode.node.syncManager.syncState.getCurrentSyncState(
clientNode.syncManager.syncState.getCurrentSyncState(
clientToServerPeer.id,
map.core.id,
),
).toEqual({ uploaded: true });
expect(
serverNode.node.syncManager.syncState.getCurrentSyncState(
serverNode.syncManager.syncState.getCurrentSyncState(
serverToClientPeer.id,
map.core.id,
),

View File

@@ -1,4 +1,4 @@
import { afterEach, describe, expect, test, vi } from "vitest";
import { afterEach, beforeEach, describe, expect, test, vi } from "vitest";
import { expectMap } from "../coValue.js";
import type { CoValueHeader } from "../coValueCore.js";
import type { RawAccountID } from "../coValues/account.js";
@@ -12,17 +12,27 @@ import { connectedPeers, newQueuePair } from "../streamUtils.js";
import type { SyncMessage } from "../sync.js";
import {
blockMessageTypeOnOutgoingPeer,
connectNodeToSyncServer,
connectTwoPeers,
createConnectedTestAgentNode,
createConnectedTestNode,
createTestMetricReader,
createTestNode,
loadCoValueOrFail,
randomAnonymousAccountAndSessionID,
setupSyncServer,
tearDownTestMetricReader,
waitFor,
} from "./testUtils.js";
const Crypto = await WasmCrypto.create();
let jazzCloud = setupSyncServer();
beforeEach(async () => {
jazzCloud = setupSyncServer();
});
test("Node replies with initial tx and header to empty subscribe", async () => {
const [admin, session] = randomAnonymousAccountAndSessionID();
const node = new LocalNode(admin, session, Crypto);
@@ -861,111 +871,34 @@ test.skip("When loading a coValue on one node, the server node it is requested f
});
test("Can sync a coValue through a server to another client", async () => {
const [admin, session] = randomAnonymousAccountAndSessionID();
const client1 = new LocalNode(admin, session, Crypto);
const { node: client1 } = await createConnectedTestNode();
const group = client1.createGroup();
const map = group.createMap();
map.set("hello", "world", "trusting");
const [serverUser, serverSession] = randomAnonymousAccountAndSessionID();
const { node: client2 } = await createConnectedTestNode();
const server = new LocalNode(serverUser, serverSession, Crypto);
const mapOnClient2 = await loadCoValueOrFail(client2, map.id);
const [serverAsPeerForClient1, client1AsPeer] = connectedPeers(
"serverFor1",
"client1",
{
peer1role: "server",
peer2role: "client",
// trace: true,
},
);
client1.syncManager.addPeer(serverAsPeerForClient1);
server.syncManager.addPeer(client1AsPeer);
const client2 = new LocalNode(
admin,
Crypto.newRandomSessionID(admin.id),
Crypto,
);
const [serverAsPeerForClient2, client2AsPeer] = connectedPeers(
"serverFor2",
"client2",
{
peer1role: "server",
peer2role: "client",
// trace: true,
},
);
client2.syncManager.addPeer(serverAsPeerForClient2);
server.syncManager.addPeer(client2AsPeer);
const mapOnClient2 = await client2.loadCoValueCore(map.core.id);
if (mapOnClient2 === "unavailable") {
throw new Error("Map is unavailable");
}
expect(expectMap(mapOnClient2.getCurrentContent()).get("hello")).toEqual(
"world",
);
expect(mapOnClient2.get("hello")).toEqual("world");
});
test("Can sync a coValue with private transactions through a server to another client", async () => {
const [admin, session] = randomAnonymousAccountAndSessionID();
const client1 = new LocalNode(admin, session, Crypto);
const { node: client1 } = await createConnectedTestNode();
const group = client1.createGroup();
const map = group.createMap();
map.set("hello", "world", "private");
group.addMember("everyone", "reader");
const [serverUser, serverSession] = randomAnonymousAccountAndSessionID();
const { node: client2 } = await createConnectedTestNode();
const server = new LocalNode(serverUser, serverSession, Crypto);
const mapOnClient2 = await loadCoValueOrFail(client2, map.id);
const [serverAsPeer, client1AsPeer] = connectedPeers("server", "client1", {
// trace: true,
peer1role: "server",
peer2role: "client",
});
client1.syncManager.addPeer(serverAsPeer);
server.syncManager.addPeer(client1AsPeer);
const client2 = new LocalNode(
admin,
client1.crypto.newRandomSessionID(admin.id),
Crypto,
);
const [serverAsOtherPeer, client2AsPeer] = connectedPeers(
"server",
"client2",
{
// trace: true,
peer1role: "server",
peer2role: "client",
},
);
client2.syncManager.addPeer(serverAsOtherPeer);
server.syncManager.addPeer(client2AsPeer);
const mapOnClient2 = await client2.loadCoValueCore(map.core.id);
if (mapOnClient2 === "unavailable") {
throw new Error("Map is unavailable");
}
expect(expectMap(mapOnClient2.getCurrentContent()).get("hello")).toEqual(
"world",
);
expect(mapOnClient2.get("hello")).toEqual("world");
});
test.skip("When a peer's incoming/readable stream closes, we remove the peer", async () => {
@@ -1023,111 +956,32 @@ test.skip("When a peer's incoming/readable stream closes, we remove the peer", a
*/
});
test.skip("When a peer's outgoing/writable stream closes, we remove the peer", async () => {
/*
const [admin, session] = randomAnonymousAccountAndSessionID();
const node = new LocalNode(admin, session, Crypto);
const group = node.createGroup();
const [inRx] = await Effect.runPromise(newStreamPair());
const [outRx, outTx] = await Effect.runPromise(newStreamPair());
node.syncManager.addPeer({
id: "test",
incoming: inRx,
outgoing: outTx,
role: "server",
});
// expect(yield* Queue.take(outRxQ)).toMatchObject({
// action: "load",
// id: admin.id,
// });
expect(yield * Queue.take(outRxQ)).toMatchObject({
action: "load",
id: group.core.id,
});
const map = group.createMap();
const mapSubscribeMsg = await reader.read();
expect(mapSubscribeMsg.value).toEqual({
action: "load",
...map.core.knownState(),
} satisfies SyncMessage);
// expect(yield* Queue.take(outRxQ)).toMatchObject(admContEx(admin.id));
expect(yield * Queue.take(outRxQ)).toMatchObject(groupContentEx(group));
const mapContentMsg = await reader.read();
expect(mapContentMsg.value).toEqual({
action: "content",
id: map.core.id,
header: map.core.header,
new: {},
} satisfies SyncMessage);
reader.releaseLock();
await outRx.cancel();
map.set("hello", "world", "trusting");
await new Promise((resolve) => setTimeout(resolve, 100));
expect(node.syncManager.peers["test"]).toBeUndefined();
*/
});
test("If we start loading a coValue before connecting to a peer that has it, it will load it once we connect", async () => {
const [admin, session] = randomAnonymousAccountAndSessionID();
const node1 = new LocalNode(admin, session, Crypto);
const { node: node1 } = await createConnectedTestNode();
const group = node1.createGroup();
const map = group.createMap();
map.set("hello", "world", "trusting");
const node2 = new LocalNode(
admin,
Crypto.newRandomSessionID(admin.id),
Crypto,
);
const node2 = createTestNode();
const [node1asPeer, node2asPeer] = connectedPeers("peer1", "peer2", {
peer1role: "server",
peer2role: "client",
// trace: true,
});
node1.syncManager.addPeer(node2asPeer);
const mapOnNode2Promise = node2.loadCoValueCore(map.core.id);
const mapOnNode2Promise = loadCoValueOrFail(node2, map.id);
expect(node2.coValuesStore.get(map.core.id).state.type).toEqual("unknown");
node2.syncManager.addPeer(node1asPeer);
connectNodeToSyncServer(node2);
const mapOnNode2 = await mapOnNode2Promise;
if (mapOnNode2 === "unavailable") {
throw new Error("Map is unavailable");
}
expect(expectMap(mapOnNode2.getCurrentContent()).get("hello")).toEqual(
"world",
);
expect(mapOnNode2.get("hello")).toEqual("world");
});
test("should keep the peer state when the peer closes", async () => {
const {
client,
jazzCloud,
jazzCloudConnectionAsPeer,
connectionWithClientAsPeer,
} = createTwoConnectedNodes();
const client = createTestNode();
const { nodeToServerPeer, serverToNodePeer } =
connectNodeToSyncServer(client);
const group = jazzCloud.createGroup();
const map = group.createMap();
@@ -1136,25 +990,23 @@ test("should keep the peer state when the peer closes", async () => {
await client.loadCoValueCore(map.core.id);
const syncManager = client.syncManager;
const peerState = syncManager.peers[jazzCloudConnectionAsPeer.id];
const peerState = syncManager.peers[nodeToServerPeer.id];
// @ts-expect-error Simulating a peer closing, leveraging the direct connection between the client/server peers
await connectionWithClientAsPeer.outgoing.push("Disconnected");
await serverToNodePeer.outgoing.push("Disconnected");
await waitFor(() => peerState?.closed);
expect(syncManager.peers[jazzCloudConnectionAsPeer.id]).not.toBeUndefined();
expect(syncManager.peers[nodeToServerPeer.id]).not.toBeUndefined();
});
test("should delete the peer state when the peer closes if deletePeerStateOnClose is true", async () => {
const {
client,
jazzCloud,
jazzCloudConnectionAsPeer,
connectionWithClientAsPeer,
} = createTwoConnectedNodes();
const client = createTestNode();
jazzCloudConnectionAsPeer.deletePeerStateOnClose = true;
const { nodeToServerPeer, serverToNodePeer } =
connectNodeToSyncServer(client);
nodeToServerPeer.deletePeerStateOnClose = true;
const group = jazzCloud.createGroup();
const map = group.createMap();
@@ -1164,14 +1016,14 @@ test("should delete the peer state when the peer closes if deletePeerStateOnClos
const syncManager = client.syncManager;
const peerState = syncManager.peers[jazzCloudConnectionAsPeer.id];
const peerState = syncManager.peers[nodeToServerPeer.id];
// @ts-expect-error Simulating a peer closing, leveraging the direct connection between the client/server peers
await connectionWithClientAsPeer.outgoing.push("Disconnected");
await serverToNodePeer.outgoing.push("Disconnected");
await waitFor(() => peerState?.closed);
expect(syncManager.peers[jazzCloudConnectionAsPeer.id]).toBeUndefined();
expect(syncManager.peers[nodeToServerPeer.id]).toBeUndefined();
});
describe("sync - extra tests", () => {
@@ -1624,29 +1476,6 @@ describe("sync - extra tests", () => {
});
});
function createTwoConnectedNodes() {
// Setup nodes
const client = createTestNode();
const jazzCloud = createTestNode();
// Connect nodes initially
const [connectionWithClientAsPeer, jazzCloudConnectionAsPeer] =
connectedPeers("connectionWithClient", "jazzCloudConnection", {
peer1role: "client",
peer2role: "server",
});
client.syncManager.addPeer(jazzCloudConnectionAsPeer);
jazzCloud.syncManager.addPeer(connectionWithClientAsPeer);
return {
client,
jazzCloud,
connectionWithClientAsPeer,
jazzCloudConnectionAsPeer,
};
}
test("a value created on one node can be loaded on anotehr node even if not directly connected", async () => {
const userA = createTestNode();
const userB = createTestNode();
@@ -1671,7 +1500,7 @@ test("a value created on one node can be loaded on anotehr node even if not dire
describe("SyncManager - knownStates vs optimisticKnownStates", () => {
test("knownStates and optimisticKnownStates are the same when the coValue is fully synced", async () => {
const { client, jazzCloud } = createTwoConnectedNodes();
const { node: client } = await createConnectedTestNode();
// Create test data
const group = client.createGroup();
@@ -1683,9 +1512,8 @@ describe("SyncManager - knownStates vs optimisticKnownStates", () => {
// Wait for the full sync to complete
await mapOnClient.core.waitForSync();
const peerStateClient = client.syncManager.peers["jazzCloudConnection"]!;
const peerStateJazzCloud =
jazzCloud.syncManager.peers["connectionWithClient"]!;
const peerStateClient = client.syncManager.getPeers()[0]!;
const peerStateJazzCloud = jazzCloud.syncManager.getPeers()[0]!;
// The optimisticKnownStates should be the same as the knownStates after the full sync is complete
expect(
@@ -1699,7 +1527,7 @@ describe("SyncManager - knownStates vs optimisticKnownStates", () => {
});
test("optimisticKnownStates is updated as new transactions are sent, while knownStates only when the updates are acknowledged", async () => {
const { client, jazzCloudConnectionAsPeer } = createTwoConnectedNodes();
const { node: client, nodeToServerPeer } = await createConnectedTestNode();
// Create test data and sync the first change
// We want that both the nodes know about the coValue so we can test
@@ -1717,7 +1545,7 @@ describe("SyncManager - knownStates vs optimisticKnownStates", () => {
// while knownStates is only updated when we receive the "known" messages
// that are acknowledging the receipt of the content messages
const outgoing = blockMessageTypeOnOutgoingPeer(
jazzCloudConnectionAsPeer,
nodeToServerPeer,
"content",
);
@@ -1725,8 +1553,7 @@ describe("SyncManager - knownStates vs optimisticKnownStates", () => {
await client.syncManager.actuallySyncCoValue(map.core);
const peerState = client.syncManager.peers["jazzCloudConnection"]!;
const peerState = client.syncManager.peers[nodeToServerPeer.id]!;
expect(peerState.optimisticKnownStates.get(map.core.id)).not.toEqual(
peerState.knownStates.get(map.core.id),
);
@@ -1747,7 +1574,7 @@ describe("SyncManager - knownStates vs optimisticKnownStates", () => {
describe("SyncManager.addPeer", () => {
test("new peer gets a copy of previous peer's knownStates when replacing it", async () => {
const { client } = createTwoConnectedNodes();
const { node: client } = await createConnectedTestNode();
// Create test data
const group = client.createGroup();
@@ -1759,26 +1586,24 @@ describe("SyncManager.addPeer", () => {
// Wait for initial sync
await map.core.waitForSync();
const firstPeerState = client.syncManager.getPeers()[0]!;
// Store the initial known states
const initialKnownStates =
client.syncManager.peers["jazzCloudConnection"]!.knownStates;
const initialKnownStates = firstPeerState.knownStates;
// Create new connection with same ID
const [jazzCloudConnectionAsPeer2] = connectedPeers(
"jazzCloudConnection",
"unusedPeer",
{
peer1role: "server",
peer2role: "client",
},
);
const [secondPeer] = connectedPeers(firstPeerState.id, "unusedPeer", {
peer1role: "server",
peer2role: "client",
});
// Add new peer with same ID
client.syncManager.addPeer(jazzCloudConnectionAsPeer2);
client.syncManager.addPeer(secondPeer);
const newPeerState = client.syncManager.getPeers()[0]!;
// Verify that the new peer has a copy of the previous known states
const newPeerKnownStates =
client.syncManager.peers["jazzCloudConnection"]!.knownStates;
const newPeerKnownStates = newPeerState.knownStates;
expect(newPeerKnownStates).not.toBe(initialKnownStates); // Should be a different instance
expect(newPeerKnownStates.get(map.core.id)).toEqual(
@@ -1787,7 +1612,7 @@ describe("SyncManager.addPeer", () => {
});
test("new peer with new ID starts with empty knownStates", async () => {
const { client } = createTwoConnectedNodes();
const { node: client } = await createConnectedTestNode();
// Create test data
const group = client.createGroup();
@@ -1815,23 +1640,19 @@ describe("SyncManager.addPeer", () => {
});
test("when adding a peer with the same ID as a previous peer, the previous peer is closed", async () => {
const { client } = createTwoConnectedNodes();
const { node: client } = await createConnectedTestNode();
// Store reference to first peer
const firstPeer = client.syncManager.peers["jazzCloudConnection"]!;
const firstPeer = client.syncManager.getPeers()[0]!;
const closeSpy = vi.spyOn(firstPeer, "gracefulShutdown");
// Create and add replacement peer
const [jazzCloudConnectionAsPeer2] = connectedPeers(
"jazzCloudConnection",
"unusedPeer",
{
peer1role: "server",
peer2role: "client",
},
);
const [secondPeer] = connectedPeers(firstPeer.id, "unusedPeer", {
peer1role: "server",
peer2role: "client",
});
client.syncManager.addPeer(jazzCloudConnectionAsPeer2);
client.syncManager.addPeer(secondPeer);
// Verify thet the first peer had ben closed correctly
expect(closeSpy).toHaveBeenCalled();
@@ -1839,25 +1660,21 @@ describe("SyncManager.addPeer", () => {
});
test("when adding a peer with the same ID as a previous peer and the previous peer is closed, do not attempt to close it again", async () => {
const { client } = createTwoConnectedNodes();
const { node: client } = await createConnectedTestNode();
// Store reference to first peer
const firstPeer = client.syncManager.peers["jazzCloudConnection"]!;
const firstPeer = client.syncManager.getPeers()[0]!;
firstPeer.gracefulShutdown();
const closeSpy = vi.spyOn(firstPeer, "gracefulShutdown");
// Create and add replacement peer
const [jazzCloudConnectionAsPeer2] = connectedPeers(
"jazzCloudConnection",
"unusedPeer",
{
peer1role: "server",
peer2role: "client",
},
);
const [secondPeer] = connectedPeers(firstPeer.id, "unusedPeer", {
peer1role: "server",
peer2role: "client",
});
client.syncManager.addPeer(jazzCloudConnectionAsPeer2);
client.syncManager.addPeer(secondPeer);
// Verify thet the first peer had not been closed again
expect(closeSpy).not.toHaveBeenCalled();
@@ -1865,24 +1682,15 @@ describe("SyncManager.addPeer", () => {
});
test("when adding a server peer the local coValues should be sent to it", async () => {
// Setup nodes
const client = createTestNode();
const jazzCloud = createTestNode();
// Connect nodes initially
const [connectionWithClientAsPeer, jazzCloudConnectionAsPeer] =
connectedPeers("connectionWithClient", "jazzCloudConnection", {
peer1role: "client",
peer2role: "server",
});
jazzCloud.syncManager.addPeer(connectionWithClientAsPeer);
const { node: client, addServerPeer } = await createConnectedTestNode({
connected: false,
});
const group = client.createGroup();
const map = group.createMap();
map.set("key1", "value1", "trusting");
client.syncManager.addPeer(jazzCloudConnectionAsPeer);
addServerPeer();
await map.core.waitForSync();
@@ -1892,18 +1700,8 @@ describe("SyncManager.addPeer", () => {
describe("loadCoValueCore with retry", () => {
test("should load the value if available on the server", async () => {
const { client, jazzCloud } = createTwoConnectedNodes();
const anotherClient = createTestNode();
const [
connectionWithAnotherClientAsPeer,
jazzCloudConnectionAsPeerForAnotherClient,
] = connectedPeers("connectionWithAnotherClient", "jazzCloudConnection", {
peer1role: "client",
peer2role: "server",
});
jazzCloud.syncManager.addPeer(connectionWithAnotherClientAsPeer);
const { node: client } = await createConnectedTestNode();
const { node: anotherClient } = await createConnectedTestNode();
const group = anotherClient.createGroup();
const map = group.createMap();
@@ -1911,25 +1709,12 @@ describe("loadCoValueCore with retry", () => {
const promise = client.loadCoValueCore(map.id);
anotherClient.syncManager.addPeer(
jazzCloudConnectionAsPeerForAnotherClient,
);
await expect(promise).resolves.not.toBe("unavailable");
});
test("should handle correctly two subsequent loads", async () => {
const { client, jazzCloud } = createTwoConnectedNodes();
const anotherClient = createTestNode();
const [
connectionWithAnotherClientAsPeer,
jazzCloudConnectionAsPeerForAnotherClient,
] = connectedPeers("connectionWithAnotherClient", "jazzCloudConnection", {
peer1role: "client",
peer2role: "server",
});
jazzCloud.syncManager.addPeer(connectionWithAnotherClientAsPeer);
const { node: client } = await createConnectedTestNode();
const { node: anotherClient } = await createConnectedTestNode();
const group = anotherClient.createGroup();
const map = group.createMap();
@@ -1938,10 +1723,6 @@ describe("loadCoValueCore with retry", () => {
const promise1 = client.loadCoValueCore(map.id);
const promise2 = client.loadCoValueCore(map.id);
anotherClient.syncManager.addPeer(
jazzCloudConnectionAsPeerForAnotherClient,
);
await expect(promise1).resolves.not.toBe("unavailable");
await expect(promise2).resolves.not.toBe("unavailable");
});
@@ -1949,8 +1730,7 @@ describe("loadCoValueCore with retry", () => {
describe("waitForSyncWithPeer", () => {
test("should resolve when the coValue is fully uploaded into the peer", async () => {
const { client, jazzCloudConnectionAsPeer: peer } =
createTwoConnectedNodes();
const { node: client } = await createConnectedTestNode();
// Create test data
const group = client.createGroup();
@@ -1959,21 +1739,32 @@ describe("waitForSyncWithPeer", () => {
await client.syncManager.actuallySyncCoValue(map.core);
const peer = client.syncManager.getPeers()[0];
if (!peer) {
throw new Error("No peer found");
}
await expect(
client.syncManager.waitForSyncWithPeer(peer.id, map.core.id, 100),
).resolves.toBe(true);
});
test("should not resolve when the coValue is not synced", async () => {
const { client, jazzCloudConnectionAsPeer: peer } =
createTwoConnectedNodes();
const { node: client } = await createConnectedTestNode();
const peer = client.syncManager.getPeers()[0];
if (!peer) {
throw new Error("No peer found");
}
// Create test data
const group = client.createGroup();
const map = group.createMap();
map.set("key1", "value1", "trusting");
vi.spyOn(peer.outgoing, "push").mockImplementation(async () => {
vi.spyOn(peer, "pushOutgoingMessage").mockImplementation(async () => {
return Promise.resolve();
});
@@ -1986,7 +1777,7 @@ describe("waitForSyncWithPeer", () => {
});
test("Should not crash when syncing an unknown coValue type", async () => {
const { client, jazzCloud } = createTwoConnectedNodes();
const { node: client } = await createConnectedTestNode();
const coValue = client.createCoValue({
type: "ooops" as any,
@@ -1997,8 +1788,10 @@ test("Should not crash when syncing an unknown coValue type", async () => {
await coValue.waitForSync();
const { node: anotherClient } = await createConnectedTestNode();
const coValueOnTheOtherNode = await loadCoValueOrFail(
jazzCloud,
anotherClient,
coValue.getCurrentContent().id,
);
expect(coValueOnTheOtherNode.id).toBe(coValue.id);
@@ -2092,6 +1885,163 @@ describe("metrics", () => {
});
});
describe("sync protocol", () => {
test("should have the correct messages exchanged between client and server", async () => {
// Creating the account from agent to simplify the messages exchange
const { node: client, messages } = await createConnectedTestAgentNode();
const group = client.createGroup();
const map = group.createMap();
map.set("hello", "world", "trusting");
const mapOnJazzCloud = await loadCoValueOrFail(jazzCloud, map.id);
expect(mapOnJazzCloud.get("hello")).toEqual("world");
expect(messages).toEqual([
{
from: "client",
msg: {
action: "load",
header: true,
id: group.id,
sessions: {
[client.currentSessionID]: 3,
},
},
},
{
from: "server",
msg: {
action: "load",
header: false,
id: group.id,
sessions: {},
},
},
{
from: "client",
msg: {
action: "load",
header: true,
id: map.id,
sessions: {
[client.currentSessionID]: 1,
},
},
},
{
from: "server",
msg: {
action: "load",
header: false,
id: map.id,
sessions: {},
},
},
{
from: "client",
msg: {
action: "content",
header: {
createdAt: expect.any(String),
meta: null,
ruleset: {
initialAdmin: client.account.id,
type: "group",
},
type: "comap",
uniqueness: expect.any(String),
},
id: group.id,
new: {
[client.currentSessionID]: {
after: 0,
lastSignature: expect.any(String),
newTransactions: expect.any(Array),
},
},
priority: 0,
},
},
{
from: "client",
msg: {
action: "content",
header: {
createdAt: expect.any(String),
meta: null,
ruleset: {
group: group.id,
type: "ownedByGroup",
},
type: "comap",
uniqueness: expect.any(String),
},
id: map.id,
new: {
[client.currentSessionID]: {
after: 0,
lastSignature: expect.any(String),
newTransactions: expect.any(Array),
},
},
priority: 3,
},
},
{
from: "server",
msg: {
action: "known",
header: true,
id: group.id,
sessions: {
[client.currentSessionID]: 3,
},
},
},
{
// TODO: This is a redundant message, we should remove it
from: "client",
msg: {
action: "content",
header: {
createdAt: expect.any(String),
meta: null,
ruleset: {
group: group.id,
type: "ownedByGroup",
},
type: "comap",
uniqueness: expect.any(String),
},
id: map.id,
new: {
[client.currentSessionID]: {
after: 0,
lastSignature: expect.any(String),
newTransactions: expect.any(Array),
},
},
priority: 3,
},
},
{
// TODO: This is a redundant message, we should remove it
from: "server",
msg: {
action: "known",
asDependencyOf: undefined,
header: true,
id: group.id,
sessions: {
[client.currentSessionID]: 3,
},
},
},
]);
});
});
function groupContentEx(group: RawGroup) {
return {
action: "content",
@@ -2099,27 +2049,9 @@ function groupContentEx(group: RawGroup) {
};
}
function _admContEx(adminID: RawAccountID) {
return {
action: "content",
id: adminID,
};
}
function groupStateEx(group: RawGroup) {
return {
action: "known",
id: group.core.id,
};
}
function _admStateEx(adminID: RawAccountID) {
return {
action: "known",
id: adminID,
};
}
function sleep(ms: number) {
return new Promise((resolve) => setTimeout(resolve, ms));
}

View File

@@ -17,6 +17,12 @@ import { expectGroup } from "../typeUtils/expectGroup.js";
const Crypto = await WasmCrypto.create();
const syncServer: {
current: undefined | LocalNode;
} = {
current: undefined,
};
export function randomAnonymousAccountAndSessionID(): [
ControlledAgent,
SessionID,
@@ -33,25 +39,6 @@ export function createTestNode() {
return new LocalNode(admin, session, Crypto);
}
export function connectTwoPeers(
a: LocalNode,
b: LocalNode,
aRole: "client" | "server",
bRole: "client" | "server",
) {
const [aAsPeer, bAsPeer] = connectedPeers(
"peer:" + a.account.id,
"peer:" + b.account.id,
{
peer1role: aRole,
peer2role: bRole,
},
);
a.syncManager.addPeer(bAsPeer);
b.syncManager.addPeer(aAsPeer);
}
export async function createTwoConnectedNodes(
node1Role: Peer["role"],
node2Role: Peer["role"],
@@ -149,6 +136,25 @@ export async function createThreeConnectedNodes(
};
}
export function connectTwoPeers(
a: LocalNode,
b: LocalNode,
aRole: "client" | "server",
bRole: "client" | "server",
) {
const [aAsPeer, bAsPeer] = connectedPeers(
"peer:" + a.account.id,
"peer:" + b.account.id,
{
peer1role: aRole,
peer2role: bRole,
},
);
a.syncManager.addPeer(bAsPeer);
b.syncManager.addPeer(aAsPeer);
}
export function newGroup() {
const [admin, sessionID] = randomAnonymousAccountAndSessionID();
@@ -368,3 +374,90 @@ export function createTestMetricReader() {
export function tearDownTestMetricReader() {
metrics.disable();
}
export function setupSyncServer() {
syncServer.current = createTestNode();
return syncServer.current;
}
export async function createConnectedTestAgentNode(opts = { connected: true }) {
if (!syncServer.current) {
throw new Error("Sync server not initialized");
}
const [admin, session] = randomAnonymousAccountAndSessionID();
const node = new LocalNode(admin, session, Crypto);
const { nodeToServerPeer, serverToNodePeer, messages, addServerPeer } =
connectNodeToSyncServer(node, opts.connected);
return { node, nodeToServerPeer, serverToNodePeer, messages, addServerPeer };
}
export async function createConnectedTestNode(opts = { connected: true }) {
if (!syncServer.current) {
throw new Error("Sync server not initialized");
}
const ctx = await LocalNode.withNewlyCreatedAccount({
peersToLoadFrom: [],
crypto: Crypto,
creationProps: { name: "Client" },
});
const { nodeToServerPeer, serverToNodePeer, messages, addServerPeer } =
connectNodeToSyncServer(ctx.node, opts.connected);
return {
node: ctx.node,
accountID: ctx.accountID,
nodeToServerPeer,
serverToNodePeer,
messages,
addServerPeer,
};
}
export function connectNodeToSyncServer(node: LocalNode, connected = true) {
if (!syncServer.current) {
throw new Error("Sync server not initialized");
}
const [nodeToServerPeer, serverToNodePeer] = connectedPeers(
syncServer.current.account.id,
node.account.id,
{
peer1role: "server",
peer2role: "client",
},
);
const messages: {
from: "client" | "server";
msg: SyncMessage;
}[] = [];
const serverPush = serverToNodePeer.outgoing.push;
serverToNodePeer.outgoing.push = (msg) => {
messages.push({ from: "server", msg });
return serverPush.call(serverToNodePeer.outgoing, msg);
};
const clientPush = nodeToServerPeer.outgoing.push;
nodeToServerPeer.outgoing.push = (msg) => {
messages.push({ from: "client", msg });
return clientPush.call(nodeToServerPeer.outgoing, msg);
};
syncServer.current.syncManager.addPeer(serverToNodePeer);
if (connected) {
node.syncManager.addPeer(nodeToServerPeer);
}
return {
nodeToServerPeer,
serverToNodePeer,
messages,
addServerPeer: () => node.syncManager.addPeer(nodeToServerPeer),
};
}

View File

@@ -17,13 +17,6 @@ You can create a new Jazz app in two ways:
### Interactive mode
Simply run:
```bash
npm create jazz-app@latest
```
or
```bash
npx create-jazz-app@latest
```
@@ -38,7 +31,7 @@ Then follow the interactive prompts to select your:
Or specify all options directly:
```bash
npm create jazz-app@latest -- --starter react-demo-auth --project-name my-app --package-manager npm
npx create-jazz-app@latest --starter react-demo-auth --project-name my-app --package-manager npm
```
### Start with an example app

View File

@@ -1,5 +1,39 @@
# jazz-browser-media-images
## 0.9.21
### Patch Changes
- Updated dependencies [1be017d]
- jazz-tools@0.9.21
- jazz-browser@0.9.21
## 0.9.20
### Patch Changes
- Updated dependencies [b01cc1f]
- jazz-tools@0.9.20
- jazz-browser@0.9.20
## 0.9.19
### Patch Changes
- Updated dependencies [6ad0a9f]
- cojson@0.9.19
- jazz-browser@0.9.19
- jazz-tools@0.9.19
## 0.9.18
### Patch Changes
- Updated dependencies [8898b10]
- cojson@0.9.18
- jazz-browser@0.9.18
- jazz-tools@0.9.18
## 0.9.17
### Patch Changes

View File

@@ -1,14 +1,14 @@
{
"name": "jazz-browser-auth-clerk",
"version": "0.9.17",
"version": "0.9.21",
"type": "module",
"main": "dist/index.js",
"types": "src/index.ts",
"license": "MIT",
"dependencies": {
"cojson": "workspace:0.9.13",
"jazz-browser": "workspace:0.9.17",
"jazz-tools": "workspace:0.9.17"
"cojson": "workspace:0.9.19",
"jazz-browser": "workspace:0.9.21",
"jazz-tools": "workspace:0.9.21"
},
"scripts": {
"format-and-lint": "biome check .",

View File

@@ -1,5 +1,35 @@
# jazz-browser-media-images
## 0.9.21
### Patch Changes
- Updated dependencies [1be017d]
- jazz-tools@0.9.21
- jazz-browser@0.9.21
## 0.9.20
### Patch Changes
- Updated dependencies [b01cc1f]
- jazz-tools@0.9.20
- jazz-browser@0.9.20
## 0.9.19
### Patch Changes
- jazz-browser@0.9.19
- jazz-tools@0.9.19
## 0.9.18
### Patch Changes
- jazz-browser@0.9.18
- jazz-tools@0.9.18
## 0.9.17
### Patch Changes

View File

@@ -1,6 +1,6 @@
{
"name": "jazz-browser-media-images",
"version": "0.9.17",
"version": "0.9.21",
"type": "module",
"main": "dist/index.js",
"types": "src/index.ts",
@@ -8,8 +8,8 @@
"dependencies": {
"@types/image-blob-reduce": "^4.1.1",
"image-blob-reduce": "^4.1.0",
"jazz-browser": "workspace:0.9.17",
"jazz-tools": "workspace:0.9.17",
"jazz-browser": "workspace:0.9.21",
"jazz-tools": "workspace:0.9.21",
"pica": "^9.0.1",
"typescript": "~5.6.2"
},

View File

@@ -1,59 +0,0 @@
// @vitest-environment happy-dom
import { createJazzTestAccount, setActiveAccount } from "jazz-tools/testing";
import { beforeEach, describe, expect, it, vi } from "vitest";
import { createImage } from "../index.js";
beforeEach(async () => {
const account = await createJazzTestAccount();
setActiveAccount(account);
});
vi.mock("pica", () => {
return {
default: vi.fn().mockImplementation(() => ({
resize: vi.fn().mockResolvedValue({}),
})),
};
});
const originalWidth = 400;
const originalHeight = 300;
// Mock ImageBlobReduce
vi.mock("image-blob-reduce", () => {
return {
default: vi.fn().mockImplementation(() => ({
toCanvas: vi.fn().mockImplementation(async () => ({
toDataURL: () => "data:image/png;base64,mockedBase64Data",
})),
toBlob: vi.fn().mockImplementation(async (blob, { max }) => {
// Return a new blob with mock dimensions based on max size
return new Blob(["reduced-image-data"], { type: "image/jpeg" });
}),
after: vi.fn().mockImplementation((event, callback) => {
// Simulate the _blob_to_image callback with mock dimensions
callback({
image: { width: originalWidth, height: originalHeight },
orientation: 1,
});
}),
})),
};
});
describe("createImage", () => {
it("should create an image definition with correct dimensions", async () => {
// Create a test blob that simulates a 400x300 image
const blob = new Blob(["fake-image-data"], { type: "image/jpeg" });
Object.defineProperty(blob, "size", { value: 1024 * 50 }); // 50KB
const imageDefinition = await createImage(blob);
expect(imageDefinition.originalSize).toEqual([
originalWidth,
originalHeight,
]);
expect(imageDefinition.placeholderDataURL).toBeDefined();
});
});

View File

@@ -1,5 +1,39 @@
# jazz-browser
## 0.9.21
### Patch Changes
- Updated dependencies [1be017d]
- jazz-tools@0.9.21
## 0.9.20
### Patch Changes
- Updated dependencies [b01cc1f]
- jazz-tools@0.9.20
## 0.9.19
### Patch Changes
- Updated dependencies [6ad0a9f]
- cojson@0.9.19
- cojson-storage-indexeddb@0.9.19
- cojson-transport-ws@0.9.19
- jazz-tools@0.9.19
## 0.9.18
### Patch Changes
- Updated dependencies [8898b10]
- cojson@0.9.18
- cojson-storage-indexeddb@0.9.18
- cojson-transport-ws@0.9.18
- jazz-tools@0.9.18
## 0.9.17
### Patch Changes

View File

@@ -1,16 +1,16 @@
{
"name": "jazz-browser",
"version": "0.9.17",
"version": "0.9.21",
"type": "module",
"main": "dist/index.js",
"types": "src/index.ts",
"license": "MIT",
"dependencies": {
"@scure/bip39": "^1.3.0",
"cojson": "workspace:0.9.13",
"cojson-storage-indexeddb": "workspace:0.9.13",
"cojson-transport-ws": "workspace:0.9.13",
"jazz-tools": "workspace:0.9.17",
"cojson": "workspace:0.9.19",
"cojson-storage-indexeddb": "workspace:0.9.19",
"cojson-transport-ws": "workspace:0.9.19",
"jazz-tools": "workspace:0.9.21",
"typescript": "~5.6.2"
},
"scripts": {

View File

@@ -1,5 +1,45 @@
# jazz-inspector
## 0.9.22
### Patch Changes
- Updated dependencies [1be017d]
- jazz-tools@0.9.21
- jazz-react-core@0.9.21
## 0.9.21
### Patch Changes
- Updated dependencies [b01cc1f]
- jazz-tools@0.9.20
- jazz-react-core@0.9.20
## 0.9.20
### Patch Changes
- Updated dependencies [6ad0a9f]
- cojson@0.9.19
- jazz-react-core@0.8.60
- jazz-tools@0.9.19
## 0.9.19
### Patch Changes
- 2faf22f: Fix published files config
## 0.9.18
### Patch Changes
- Updated dependencies [8898b10]
- cojson@0.9.18
- jazz-react-core@0.8.59
- jazz-tools@0.9.18
## 0.9.17
### Patch Changes

View File

@@ -1,12 +1,16 @@
{
"name": "jazz-inspector",
"version": "0.9.17",
"version": "0.9.22",
"type": "module",
"main": "./dist/jazz-inspector.js",
"types": "./src/app.tsx",
"main": "./dist/app.js",
"types": "./dist/app.d.ts",
"files": [
"dist/**",
"src"
],
"scripts": {
"dev": "vite build --watch",
"build": "tsc && vite build",
"build": "rm -rf ./dist && tsc --sourceMap --outDir dist",
"format-and-lint": "biome check .",
"format-and-lint:fix": "biome check . --write",
"preview": "vite preview"

View File

@@ -1 +1 @@
export { JazzInspector } from "./viewer/new-app.tsx";
export { JazzInspector } from "./viewer/new-app.js";

View File

@@ -1,5 +1,5 @@
import React from "react";
import { PageInfo } from "./types.ts";
import { PageInfo } from "./types.js";
interface BreadcrumbsProps {
path: PageInfo[];

View File

@@ -5,16 +5,12 @@ import {
RawCoStream,
RawCoValue,
} from "cojson";
import { base64URLtoBytes } from "cojson/src/base64url.ts";
import {
BinaryStreamItem,
BinaryStreamStart,
CoStreamItem,
} from "cojson/src/coValues/coStream.ts";
import type { JsonObject, JsonValue } from "cojson/src/jsonValue.ts";
import { base64URLtoBytes } from "cojson";
import { BinaryStreamItem, BinaryStreamStart, CoStreamItem } from "cojson";
import type { JsonObject, JsonValue } from "cojson";
import { useEffect, useState } from "react";
import { PageInfo } from "./types.ts";
import { AccountOrGroupPreview } from "./value-renderer.tsx";
import { PageInfo } from "./types.js";
import { AccountOrGroupPreview } from "./value-renderer.js";
// typeguard for BinaryStreamStart
function isBinaryStreamStart(item: unknown): item is BinaryStreamStart {

Some files were not shown because too many files have changed in this diff Show More