chore: merge dev to main#21

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sanny-io merged 2 commits into from
Feb 3, 2026
Merged

chore: merge dev to main #21

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d7fcd3a
chore: convert from monorepo (#19)
sanny-io Feb 3, 2026
024ae1a
fix: id field not being mapped (#20)
sanny-io Feb 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .coderabbit.yaml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json
language: "en-US"
language: 'en-US'
early_access: false
reviews:
profile: "assertive"
profile: 'assertive'
request_changes_workflow: false
high_level_summary: true
poem: false
Expand All@@ -13,4 +13,4 @@ reviews:
enabled: true
drafts: false
chat:
auto_reply: true
auto_reply: true
4 changes: 2 additions & 2 deletions .devcontainer/docker-compose.yaml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -30,7 +30,7 @@ services:
volumes:
- redis-data:/data
healthcheck:
test: ["CMD-SHELL", "redis-cli ping | grep PONG"]
test: ['CMD-SHELL', 'redis-cli ping | grep PONG']
interval: 5s
timeout: 5s
retries: 5
Expand All@@ -45,4 +45,4 @@ services:
ports:
- 5540:5540
volumes:
- redis-insight:/data
- redis-insight:/data
4 changes: 2 additions & 2 deletions .github/workflows/build-and-test.yaml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,7 @@ jobs:
- name: Check out repository code
uses: actions/checkout@v5

- name: Install system dependencies
- name: Install system dependencies
run: |
apt-get update
apt-get install -y unzip
Expand All@@ -35,4 +35,4 @@ jobs:
- name: Test
env:
REDIS_URL: redis://redis:6379
run: bun run test
run: bun run test
9 changes: 3 additions & 6 deletions .github/workflows/publish-package.yaml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -22,7 +22,7 @@ jobs:
- name: Check out repository code
uses: actions/checkout@v5

- name: Install system dependencies
- name: Install system dependencies
run: |
apt-get update
apt-get install -y unzip
Expand All@@ -41,15 +41,12 @@ jobs:
REDIS_URL: redis://redis:6379
run: bun run test

- name: Copy extra files
run: cp ./README.md ./LICENSE ./packages/cache

- name: Publish package to NPM
env:
NPM_CONFIG_TOKEN: ${{ secrets.NPM_CONFIG_TOKEN }}
run: cd ./packages/cache && bun publish --tolerate-republish --access public
run: bun publish --tolerate-republish --access public

- name: Publish package to GitHub
env:
NPM_CONFIG_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: cd ./packages/cache && bun publish --tolerate-republish --access public --registry https://npm.pkg.github.com
run: bun publish --tolerate-republish --access public --registry https://npm.pkg.github.com
0 packages/cache/.npmignore → .npmignore
View file
Open in desktop
File renamed without changes.
6 changes: 3 additions & 3 deletions .oxfmtrc.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,7 @@
"insertFinalNewline": true,
"jsxSingleQuote": true,
"trailingComma": "all",
"ignorePatterns": [
"ignorePatterns": [
"**/dist/*",
"**/.next/*",
"**/.turbo/*",
Expand All@@ -21,5 +21,5 @@
"apps/next/src/app/(payload)/*",
"apps/start/.wrangler/*",
"apps/start/src/routeTree.gen.ts"
],
}
]
}
22 changes: 5 additions & 17 deletions .oxlintrc.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
{
"$schema": "./node_modules/oxlint/configuration_schema.json",
"plugins": [
"typescript",
"react"
],
"plugins": ["typescript", "react"],
"categories": {
"correctness": "warn",
"pedantic": "warn",
Expand DownExpand Up@@ -105,9 +102,7 @@
],
"overrides": [
{
"files": [
"**/*.{js,mjs,cjs,ts,mts,cts,jsx,tsx}"
],
"files": ["**/*.{js,mjs,cjs,ts,mts,cts,jsx,tsx}"],
"rules": {
"for-direction": "error",
"no-async-promise-executor": "error",
Expand DownExpand Up@@ -165,9 +160,7 @@
}
},
{
"files": [
"**/*.{js,mjs,cjs,ts,mts,cts,jsx,tsx}"
],
"files": ["**/*.{js,mjs,cjs,ts,mts,cts,jsx,tsx}"],
"env": {
"browser": true,
"commonjs": true,
Expand All@@ -176,12 +169,7 @@
}
},
{
"files": [
"**/*.ts",
"**/*.tsx",
"**/*.mts",
"**/*.cts"
],
"files": ["**/*.ts", "**/*.tsx", "**/*.mts", "**/*.cts"],
"rules": {
"no-class-assign": "off",
"no-const-assign": "off",
Expand All@@ -202,4 +190,4 @@
}
}
]
}
}
2 changes: 1 addition & 1 deletion .vscode/extensions.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,4 +8,4 @@
"vitest.explorer",
"zenstack.zenstack-v3"
]
}
}
2 changes: 1 addition & 1 deletion .vscode/settings.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,5 +4,5 @@
"typescript.experimental.useTsgo": true,
"[javascript][javascriptreact][typescript][typescriptreact][json][jsonc]": {
"editor.defaultFormatter": "oxc.oxc-vscode"
},
}
}
33 changes: 18 additions & 15 deletions README.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,8 @@
ZenStack Cache
</h1>

Reduce response times and database load with query-level caching integrated with the ZenStack ORM.
Reduce response times and database load with query-level caching integrated with the ZenStack ORM.

</div>

<div align="center">
Expand All@@ -19,7 +20,7 @@
<a href="https://discord.gg/2PaRSu7X">
<img alt="Join the ZenStack Cache channel" src="https://img.shields.io/discord/1035538056146595961">
</a>
<a href="https://github.com/visualbravo/zenstack-cache/blob/76a2de03245c26841b04525dd8b424a8799d654c/LICENSE">
<a href="https://github.com/visualbravo/zenstack-cache/blob/dev/LICENSE">
<img alt="License: MIT" src="https://img.shields.io/badge/license-MIT-green">
</a>

Expand All@@ -29,17 +30,18 @@
</div>

## Features
* 🌐 **Redis Cache:** A central cache to scale across different systems.
* 🖥️ **Memory Cache:** A simple cache when scale is not a concern.
* 🛟 **Type-safety:** The caching options appear in the intellisense for all read queries.
* 🏷️ **Tag-based Invalidation:** Easily invalidate multiple related cache entries.

- 🌐 **Redis Cache:** A central cache to scale across different systems.
- 🖥️ **Memory Cache:** A simple cache when scale is not a concern.
- 🛟 **Type-safety:** The caching options appear in the intellisense for all read queries.
- 🏷️ **Tag-based Invalidation:** Easily invalidate multiple related cache entries.

## Requirements

* ZenStack (version >= `3.3.0`)
* Node.js (version >= `20.0.0`)
* Redis (version >= `7.0.0`)
* ℹ️ Only if you intend to use the `RedisCacheProvider`
- ZenStack (version >= `3.3.0`)
- Node.js (version >= `20.0.0`)
- Redis (version >= `7.0.0`)
- ℹ️ Only if you intend to use the `RedisCacheProvider`

## Installation

Expand DownExpand Up@@ -115,21 +117,22 @@ After performing a query, you can check where the result came from.
const publishedPostsStatus = client.$cache.status // 'hit' | 'miss' | 'stale'
```

* `hit` - a cache entry in the `ttl` window was found, and the database was not queried.
* `miss` - a cache entry was not found, and the database was queried.
* `stale` - a cache entry in the `swr` window was found, and the database was queried in the background to revalidate it.
- `hit` - a cache entry in the `ttl` window was found, and the database was not queried.
- `miss` - a cache entry was not found, and the database was queried.
- `stale` - a cache entry in the `swr` window was found, and the database was queried in the background to revalidate it.

## Revalidation

If the result was stale, you can choose to await its revalidation.

```typescript
const revalidatedPublishedPosts = await client.$cache.revalidation as Post[]
```

## Cache Options

* `ttl` reduces response times and database load by serving cached results.
* `swr` reduces response times by serving cached results, but does not reduce database load because it performs a revalidation in the background after each request.
- `ttl` reduces response times and database load by serving cached results.
- `swr` reduces response times by serving cached results, but does not reduce database load because it performs a revalidation in the background after each request.

> [!NOTE]
> The total TTL of a cache entry is equal to its `ttl` + `swr`. The `ttl` window comes first, followed by the `swr` window. You can combine the two options to best suit the needs of your application.
Expand Down
61 changes: 11 additions & 50 deletions bun.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
chore: merge dev to main#21

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

sanny-io
merged 2 commits into

from

Feb 3, 2026
 Merged


chore: merge dev to main
#21
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
d7fcd3a

chore: convert from monorepo (#19)


sanny-io Feb 3, 2026
024ae1a

fix: id field not being mapped (#20)


sanny-io Feb 3, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


6 changes: 3 additions & 3 deletions
.coderabbit.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json
language: "en-US"
language: 'en-US'
early_access: false
reviews:
 profile: "assertive"
 profile: 'assertive'
 request_changes_workflow: false
 high_level_summary: true
 poem: false
Expand All@@ -13,4 +13,4 @@ reviews:
 enabled: true
 drafts: false
chat:
 auto_reply: true
 auto_reply: true

4 changes: 2 additions & 2 deletions
.devcontainer/docker-compose.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,7 +30,7 @@ services:
 volumes:
 - redis-data:/data
 healthcheck:
 test: ["CMD-SHELL", "redis-cli ping | grep PONG"]
 test: ['CMD-SHELL', 'redis-cli ping | grep PONG']
 interval: 5s
 timeout: 5s
 retries: 5
Expand All@@ -45,4 +45,4 @@ services:
 ports:
 - 5540:5540
 volumes:
 - redis-insight:/data
 - redis-insight:/data

4 changes: 2 additions & 2 deletions
.github/workflows/build-and-test.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,7 @@ jobs:
 - name: Check out repository code
 uses: actions/checkout@v5

 - name: Install system dependencies
 - name: Install system dependencies
 run: |
 apt-get update
 apt-get install -y unzip
Expand All@@ -35,4 +35,4 @@ jobs:
 - name: Test
 env:
 REDIS_URL: redis://redis:6379
 run: bun run test
 run: bun run test

9 changes: 3 additions & 6 deletions
.github/workflows/publish-package.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,7 +22,7 @@ jobs:
 - name: Check out repository code
 uses: actions/checkout@v5

 - name: Install system dependencies
 - name: Install system dependencies
 run: |
 apt-get update
 apt-get install -y unzip
Expand All@@ -41,15 +41,12 @@ jobs:
 REDIS_URL: redis://redis:6379
 run: bun run test

 - name: Copy extra files
 run: cp ./README.md ./LICENSE ./packages/cache

 - name: Publish package to NPM
 env:
 NPM_CONFIG_TOKEN: ${{ secrets.NPM_CONFIG_TOKEN }}
 run: cd ./packages/cache && bun publish --tolerate-republish --access public
 run: bun publish --tolerate-republish --access public

 - name: Publish package to GitHub
 env:
 NPM_CONFIG_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 run: cd ./packages/cache && bun publish --tolerate-republish --access public --registry https://npm.pkg.github.com
 run: bun publish --tolerate-republish --access public --registry https://npm.pkg.github.com

0
packages/cache/.npmignore → .npmignore

View file


Open in desktop


File renamed without changes.


6 changes: 3 additions & 3 deletions
.oxfmtrc.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,7 @@
 "insertFinalNewline": true,
 "jsxSingleQuote": true,
 "trailingComma": "all",
"ignorePatterns": [
 "ignorePatterns": [
 "**/dist/*",
 "**/.next/*",
 "**/.turbo/*",
Expand All@@ -21,5 +21,5 @@
 "apps/next/src/app/(payload)/*",
 "apps/start/.wrangler/*",
 "apps/start/src/routeTree.gen.ts"
 ],
}
 ]
}

22 changes: 5 additions & 17 deletions
.oxlintrc.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
{
 "$schema": "./node_modules/oxlint/configuration_schema.json",
 "plugins": [
 "typescript",
 "react"
 ],
 "plugins": ["typescript", "react"],
 "categories": {
 "correctness": "warn",
 "pedantic": "warn",
Expand DownExpand Up@@ -105,9 +102,7 @@
 ],
 "overrides": [
 {
 "files": [
 "**/*.{js,mjs,cjs,ts,mts,cts,jsx,tsx}"
 ],
 "files": ["**/*.{js,mjs,cjs,ts,mts,cts,jsx,tsx}"],
 "rules": {
 "for-direction": "error",
 "no-async-promise-executor": "error",
Expand DownExpand Up@@ -165,9 +160,7 @@
 }
 },
 {
 "files": [
 "**/*.{js,mjs,cjs,ts,mts,cts,jsx,tsx}"
 ],
 "files": ["**/*.{js,mjs,cjs,ts,mts,cts,jsx,tsx}"],
 "env": {
 "browser": true,
 "commonjs": true,
Expand All@@ -176,12 +169,7 @@
 }
 },
 {
 "files": [
 "**/*.ts",
 "**/*.tsx",
 "**/*.mts",
 "**/*.cts"
 ],
 "files": ["**/*.ts", "**/*.tsx", "**/*.mts", "**/*.cts"],
 "rules": {
 "no-class-assign": "off",
 "no-const-assign": "off",
Expand All@@ -202,4 +190,4 @@
 }
 }
 ]
}
}

2 changes: 1 addition & 1 deletion
.vscode/extensions.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,4 +8,4 @@
 "vitest.explorer",
 "zenstack.zenstack-v3"
 ]
}
}

2 changes: 1 addition & 1 deletion
.vscode/settings.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,5 +4,5 @@
 "typescript.experimental.useTsgo": true,
 "[javascript][javascriptreact][typescript][typescriptreact][json][jsonc]": {
 "editor.defaultFormatter": "oxc.oxc-vscode"
 },
 }
}

33 changes: 18 additions & 15 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,8 @@
 ZenStack Cache
 </h1>

 Reduce response times and database load with query-level caching integrated with the ZenStack ORM.
Reduce response times and database load with query-level caching integrated with the ZenStack ORM.

</div>

<div align="center">
Expand All@@ -19,7 +20,7 @@
 <a href="https://discord.gg/2PaRSu7X">
 <img alt="Join the ZenStack Cache channel" src="https://img.shields.io/discord/1035538056146595961">
 </a>
 <a href="https://github.com/visualbravo/zenstack-cache/blob/76a2de03245c26841b04525dd8b424a8799d654c/LICENSE">
 <a href="https://github.com/visualbravo/zenstack-cache/blob/dev/LICENSE">
 <img alt="License: MIT" src="https://img.shields.io/badge/license-MIT-green">
 </a>

Expand All@@ -29,17 +30,18 @@
</div>

## Features
* 🌐 **Redis Cache:** A central cache to scale across different systems.
* 🖥️ **Memory Cache:** A simple cache when scale is not a concern.
* 🛟 **Type-safety:** The caching options appear in the intellisense for all read queries.
* 🏷️ **Tag-based Invalidation:** Easily invalidate multiple related cache entries.

- 🌐 **Redis Cache:** A central cache to scale across different systems.
- 🖥️ **Memory Cache:** A simple cache when scale is not a concern.
- 🛟 **Type-safety:** The caching options appear in the intellisense for all read queries.
- 🏷️ **Tag-based Invalidation:** Easily invalidate multiple related cache entries.

## Requirements

* ZenStack (version >= `3.3.0`)
* Node.js (version >= `20.0.0`)
* Redis (version >= `7.0.0`)
* ℹ️ Only if you intend to use the `RedisCacheProvider`
- ZenStack (version >= `3.3.0`)
- Node.js (version >= `20.0.0`)
- Redis (version >= `7.0.0`)
- ℹ️ Only if you intend to use the `RedisCacheProvider`

## Installation

Expand DownExpand Up@@ -115,21 +117,22 @@ After performing a query, you can check where the result came from.
const publishedPostsStatus = client.$cache.status // 'hit' | 'miss' | 'stale'
```

* `hit` - a cache entry in the `ttl` window was found, and the database was not queried.
* `miss` - a cache entry was not found, and the database was queried.
* `stale` - a cache entry in the `swr` window was found, and the database was queried in the background to revalidate it.
- `hit` - a cache entry in the `ttl` window was found, and the database was not queried.
- `miss` - a cache entry was not found, and the database was queried.
- `stale` - a cache entry in the `swr` window was found, and the database was queried in the background to revalidate it.

## Revalidation

If the result was stale, you can choose to await its revalidation.

```typescript
const revalidatedPublishedPosts = await client.$cache.revalidation as Post[]
```

## Cache Options

* `ttl` reduces response times and database load by serving cached results.
* `swr` reduces response times by serving cached results, but does not reduce database load because it performs a revalidation in the background after each request.
- `ttl` reduces response times and database load by serving cached results.
- `swr` reduces response times by serving cached results, but does not reduce database load because it performs a revalidation in the background after each request.

> [!NOTE]
> The total TTL of a cache entry is equal to its `ttl` + `swr`. The `ttl` window comes first, followed by the `swr` window. You can combine the two options to best suit the needs of your application.
Expand Down

61 changes: 11 additions & 50 deletions
bun.lock

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
chore: merge dev to main#21

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

sanny-io
merged 2 commits into

from

Feb 3, 2026
 Merged


chore: merge dev to main
#21
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
d7fcd3a

chore: convert from monorepo (#19)


sanny-io Feb 3, 2026
024ae1a

fix: id field not being mapped (#20)


sanny-io Feb 3, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


6 changes: 3 additions & 3 deletions
.coderabbit.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json
language: "en-US"
language: 'en-US'
early_access: false
reviews:
 profile: "assertive"
 profile: 'assertive'
 request_changes_workflow: false
 high_level_summary: true
 poem: false
Expand All@@ -13,4 +13,4 @@ reviews:
 enabled: true
 drafts: false
chat:
 auto_reply: true
 auto_reply: true

4 changes: 2 additions & 2 deletions
.devcontainer/docker-compose.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,7 +30,7 @@ services:
 volumes:
 - redis-data:/data
 healthcheck:
 test: ["CMD-SHELL", "redis-cli ping | grep PONG"]
 test: ['CMD-SHELL', 'redis-cli ping | grep PONG']
 interval: 5s
 timeout: 5s
 retries: 5
Expand All@@ -45,4 +45,4 @@ services:
 ports:
 - 5540:5540
 volumes:
 - redis-insight:/data
 - redis-insight:/data

4 changes: 2 additions & 2 deletions
.github/workflows/build-and-test.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,7 @@ jobs:
 - name: Check out repository code
 uses: actions/checkout@v5

 - name: Install system dependencies
 - name: Install system dependencies
 run: |
 apt-get update
 apt-get install -y unzip
Expand All@@ -35,4 +35,4 @@ jobs:
 - name: Test
 env:
 REDIS_URL: redis://redis:6379
 run: bun run test
 run: bun run test

9 changes: 3 additions & 6 deletions
.github/workflows/publish-package.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,7 +22,7 @@ jobs:
 - name: Check out repository code
 uses: actions/checkout@v5

 - name: Install system dependencies
 - name: Install system dependencies
 run: |
 apt-get update
 apt-get install -y unzip
Expand All@@ -41,15 +41,12 @@ jobs:
 REDIS_URL: redis://redis:6379
 run: bun run test

 - name: Copy extra files
 run: cp ./README.md ./LICENSE ./packages/cache

 - name: Publish package to NPM
 env:
 NPM_CONFIG_TOKEN: ${{ secrets.NPM_CONFIG_TOKEN }}
 run: cd ./packages/cache && bun publish --tolerate-republish --access public
 run: bun publish --tolerate-republish --access public

 - name: Publish package to GitHub
 env:
 NPM_CONFIG_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 run: cd ./packages/cache && bun publish --tolerate-republish --access public --registry https://npm.pkg.github.com
 run: bun publish --tolerate-republish --access public --registry https://npm.pkg.github.com

0
packages/cache/.npmignore → .npmignore

View file


Open in desktop


File renamed without changes.


6 changes: 3 additions & 3 deletions
.oxfmtrc.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,7 @@
 "insertFinalNewline": true,
 "jsxSingleQuote": true,
 "trailingComma": "all",
"ignorePatterns": [
 "ignorePatterns": [
 "**/dist/*",
 "**/.next/*",
 "**/.turbo/*",
Expand All@@ -21,5 +21,5 @@
 "apps/next/src/app/(payload)/*",
 "apps/start/.wrangler/*",
 "apps/start/src/routeTree.gen.ts"
 ],
}
 ]
}

22 changes: 5 additions & 17 deletions
.oxlintrc.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
{
 "$schema": "./node_modules/oxlint/configuration_schema.json",
 "plugins": [
 "typescript",
 "react"
 ],
 "plugins": ["typescript", "react"],
 "categories": {
 "correctness": "warn",
 "pedantic": "warn",
Expand DownExpand Up@@ -105,9 +102,7 @@
 ],
 "overrides": [
 {
 "files": [
 "**/*.{js,mjs,cjs,ts,mts,cts,jsx,tsx}"
 ],
 "files": ["**/*.{js,mjs,cjs,ts,mts,cts,jsx,tsx}"],
 "rules": {
 "for-direction": "error",
 "no-async-promise-executor": "error",
Expand DownExpand Up@@ -165,9 +160,7 @@
 }
 },
 {
 "files": [
 "**/*.{js,mjs,cjs,ts,mts,cts,jsx,tsx}"
 ],
 "files": ["**/*.{js,mjs,cjs,ts,mts,cts,jsx,tsx}"],
 "env": {
 "browser": true,
 "commonjs": true,
Expand All@@ -176,12 +169,7 @@
 }
 },
 {
 "files": [
 "**/*.ts",
 "**/*.tsx",
 "**/*.mts",
 "**/*.cts"
 ],
 "files": ["**/*.ts", "**/*.tsx", "**/*.mts", "**/*.cts"],
 "rules": {
 "no-class-assign": "off",
 "no-const-assign": "off",
Expand All@@ -202,4 +190,4 @@
 }
 }
 ]
}
}

2 changes: 1 addition & 1 deletion
.vscode/extensions.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,4 +8,4 @@
 "vitest.explorer",
 "zenstack.zenstack-v3"
 ]
}
}

2 changes: 1 addition & 1 deletion
.vscode/settings.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,5 +4,5 @@
 "typescript.experimental.useTsgo": true,
 "[javascript][javascriptreact][typescript][typescriptreact][json][jsonc]": {
 "editor.defaultFormatter": "oxc.oxc-vscode"
 },
 }
}

33 changes: 18 additions & 15 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,8 @@
 ZenStack Cache
 </h1>

 Reduce response times and database load with query-level caching integrated with the ZenStack ORM.
Reduce response times and database load with query-level caching integrated with the ZenStack ORM.

</div>

<div align="center">
Expand All@@ -19,7 +20,7 @@
 <a href="https://discord.gg/2PaRSu7X">
 <img alt="Join the ZenStack Cache channel" src="https://img.shields.io/discord/1035538056146595961">
 </a>
 <a href="https://github.com/visualbravo/zenstack-cache/blob/76a2de03245c26841b04525dd8b424a8799d654c/LICENSE">
 <a href="https://github.com/visualbravo/zenstack-cache/blob/dev/LICENSE">
 <img alt="License: MIT" src="https://img.shields.io/badge/license-MIT-green">
 </a>

Expand All@@ -29,17 +30,18 @@
</div>

## Features
* 🌐 **Redis Cache:** A central cache to scale across different systems.
* 🖥️ **Memory Cache:** A simple cache when scale is not a concern.
* 🛟 **Type-safety:** The caching options appear in the intellisense for all read queries.
* 🏷️ **Tag-based Invalidation:** Easily invalidate multiple related cache entries.

- 🌐 **Redis Cache:** A central cache to scale across different systems.
- 🖥️ **Memory Cache:** A simple cache when scale is not a concern.
- 🛟 **Type-safety:** The caching options appear in the intellisense for all read queries.
- 🏷️ **Tag-based Invalidation:** Easily invalidate multiple related cache entries.

## Requirements

* ZenStack (version >= `3.3.0`)
* Node.js (version >= `20.0.0`)
* Redis (version >= `7.0.0`)
* ℹ️ Only if you intend to use the `RedisCacheProvider`
- ZenStack (version >= `3.3.0`)
- Node.js (version >= `20.0.0`)
- Redis (version >= `7.0.0`)
- ℹ️ Only if you intend to use the `RedisCacheProvider`

## Installation

Expand DownExpand Up@@ -115,21 +117,22 @@ After performing a query, you can check where the result came from.
const publishedPostsStatus = client.$cache.status // 'hit' | 'miss' | 'stale'
```

* `hit` - a cache entry in the `ttl` window was found, and the database was not queried.
* `miss` - a cache entry was not found, and the database was queried.
* `stale` - a cache entry in the `swr` window was found, and the database was queried in the background to revalidate it.
- `hit` - a cache entry in the `ttl` window was found, and the database was not queried.
- `miss` - a cache entry was not found, and the database was queried.
- `stale` - a cache entry in the `swr` window was found, and the database was queried in the background to revalidate it.

## Revalidation

If the result was stale, you can choose to await its revalidation.

```typescript
const revalidatedPublishedPosts = await client.$cache.revalidation as Post[]
```

## Cache Options

* `ttl` reduces response times and database load by serving cached results.
* `swr` reduces response times by serving cached results, but does not reduce database load because it performs a revalidation in the background after each request.
- `ttl` reduces response times and database load by serving cached results.
- `swr` reduces response times by serving cached results, but does not reduce database load because it performs a revalidation in the background after each request.

> [!NOTE]
> The total TTL of a cache entry is equal to its `ttl` + `swr`. The `ttl` window comes first, followed by the `swr` window. You can combine the two options to best suit the needs of your application.
Expand Down

61 changes: 11 additions & 50 deletions
bun.lock

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
chore: merge dev to main#21

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

sanny-io
merged 2 commits into

from

Feb 3, 2026
 Merged


chore: merge dev to main
#21
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
d7fcd3a

chore: convert from monorepo (#19)


sanny-io Feb 3, 2026
024ae1a

fix: id field not being mapped (#20)


sanny-io Feb 3, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


6 changes: 3 additions & 3 deletions
.coderabbit.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json
language: "en-US"
language: 'en-US'
early_access: false
reviews:
 profile: "assertive"
 profile: 'assertive'
 request_changes_workflow: false
 high_level_summary: true
 poem: false
Expand All@@ -13,4 +13,4 @@ reviews:
 enabled: true
 drafts: false
chat:
 auto_reply: true
 auto_reply: true

4 changes: 2 additions & 2 deletions
.devcontainer/docker-compose.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,7 +30,7 @@ services:
 volumes:
 - redis-data:/data
 healthcheck:
 test: ["CMD-SHELL", "redis-cli ping | grep PONG"]
 test: ['CMD-SHELL', 'redis-cli ping | grep PONG']
 interval: 5s
 timeout: 5s
 retries: 5
Expand All@@ -45,4 +45,4 @@ services:
 ports:
 - 5540:5540
 volumes:
 - redis-insight:/data
 - redis-insight:/data

4 changes: 2 additions & 2 deletions
.github/workflows/build-and-test.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,7 @@ jobs:
 - name: Check out repository code
 uses: actions/checkout@v5

 - name: Install system dependencies
 - name: Install system dependencies
 run: |
 apt-get update
 apt-get install -y unzip
Expand All@@ -35,4 +35,4 @@ jobs:
 - name: Test
 env:
 REDIS_URL: redis://redis:6379
 run: bun run test
 run: bun run test

9 changes: 3 additions & 6 deletions
.github/workflows/publish-package.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,7 +22,7 @@ jobs:
 - name: Check out repository code
 uses: actions/checkout@v5

 - name: Install system dependencies
 - name: Install system dependencies
 run: |
 apt-get update
 apt-get install -y unzip
Expand All@@ -41,15 +41,12 @@ jobs:
 REDIS_URL: redis://redis:6379
 run: bun run test

 - name: Copy extra files
 run: cp ./README.md ./LICENSE ./packages/cache

 - name: Publish package to NPM
 env:
 NPM_CONFIG_TOKEN: ${{ secrets.NPM_CONFIG_TOKEN }}
 run: cd ./packages/cache && bun publish --tolerate-republish --access public
 run: bun publish --tolerate-republish --access public

 - name: Publish package to GitHub
 env:
 NPM_CONFIG_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 run: cd ./packages/cache && bun publish --tolerate-republish --access public --registry https://npm.pkg.github.com
 run: bun publish --tolerate-republish --access public --registry https://npm.pkg.github.com

0
packages/cache/.npmignore → .npmignore

View file


Open in desktop


File renamed without changes.


6 changes: 3 additions & 3 deletions
.oxfmtrc.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,7 @@
 "insertFinalNewline": true,
 "jsxSingleQuote": true,
 "trailingComma": "all",
"ignorePatterns": [
 "ignorePatterns": [
 "**/dist/*",
 "**/.next/*",
 "**/.turbo/*",
Expand All@@ -21,5 +21,5 @@
 "apps/next/src/app/(payload)/*",
 "apps/start/.wrangler/*",
 "apps/start/src/routeTree.gen.ts"
 ],
}
 ]
}

22 changes: 5 additions & 17 deletions
.oxlintrc.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
{
 "$schema": "./node_modules/oxlint/configuration_schema.json",
 "plugins": [
 "typescript",
 "react"
 ],
 "plugins": ["typescript", "react"],
 "categories": {
 "correctness": "warn",
 "pedantic": "warn",
Expand DownExpand Up@@ -105,9 +102,7 @@
 ],
 "overrides": [
 {
 "files": [
 "**/*.{js,mjs,cjs,ts,mts,cts,jsx,tsx}"
 ],
 "files": ["**/*.{js,mjs,cjs,ts,mts,cts,jsx,tsx}"],
 "rules": {
 "for-direction": "error",
 "no-async-promise-executor": "error",
Expand DownExpand Up@@ -165,9 +160,7 @@
 }
 },
 {
 "files": [
 "**/*.{js,mjs,cjs,ts,mts,cts,jsx,tsx}"
 ],
 "files": ["**/*.{js,mjs,cjs,ts,mts,cts,jsx,tsx}"],
 "env": {
 "browser": true,
 "commonjs": true,
Expand All@@ -176,12 +169,7 @@
 }
 },
 {
 "files": [
 "**/*.ts",
 "**/*.tsx",
 "**/*.mts",
 "**/*.cts"
 ],
 "files": ["**/*.ts", "**/*.tsx", "**/*.mts", "**/*.cts"],
 "rules": {
 "no-class-assign": "off",
 "no-const-assign": "off",
Expand All@@ -202,4 +190,4 @@
 }
 }
 ]
}
}

2 changes: 1 addition & 1 deletion
.vscode/extensions.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,4 +8,4 @@
 "vitest.explorer",
 "zenstack.zenstack-v3"
 ]
}
}

2 changes: 1 addition & 1 deletion
.vscode/settings.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,5 +4,5 @@
 "typescript.experimental.useTsgo": true,
 "[javascript][javascriptreact][typescript][typescriptreact][json][jsonc]": {
 "editor.defaultFormatter": "oxc.oxc-vscode"
 },
 }
}

33 changes: 18 additions & 15 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,8 @@
 ZenStack Cache
 </h1>

 Reduce response times and database load with query-level caching integrated with the ZenStack ORM.
Reduce response times and database load with query-level caching integrated with the ZenStack ORM.

</div>

<div align="center">
Expand All@@ -19,7 +20,7 @@
 <a href="https://discord.gg/2PaRSu7X">
 <img alt="Join the ZenStack Cache channel" src="https://img.shields.io/discord/1035538056146595961">
 </a>
 <a href="https://github.com/visualbravo/zenstack-cache/blob/76a2de03245c26841b04525dd8b424a8799d654c/LICENSE">
 <a href="https://github.com/visualbravo/zenstack-cache/blob/dev/LICENSE">
 <img alt="License: MIT" src="https://img.shields.io/badge/license-MIT-green">
 </a>

Expand All@@ -29,17 +30,18 @@
</div>

## Features
* 🌐 **Redis Cache:** A central cache to scale across different systems.
* 🖥️ **Memory Cache:** A simple cache when scale is not a concern.
* 🛟 **Type-safety:** The caching options appear in the intellisense for all read queries.
* 🏷️ **Tag-based Invalidation:** Easily invalidate multiple related cache entries.

- 🌐 **Redis Cache:** A central cache to scale across different systems.
- 🖥️ **Memory Cache:** A simple cache when scale is not a concern.
- 🛟 **Type-safety:** The caching options appear in the intellisense for all read queries.
- 🏷️ **Tag-based Invalidation:** Easily invalidate multiple related cache entries.

## Requirements

* ZenStack (version >= `3.3.0`)
* Node.js (version >= `20.0.0`)
* Redis (version >= `7.0.0`)
* ℹ️ Only if you intend to use the `RedisCacheProvider`
- ZenStack (version >= `3.3.0`)
- Node.js (version >= `20.0.0`)
- Redis (version >= `7.0.0`)
- ℹ️ Only if you intend to use the `RedisCacheProvider`

## Installation

Expand DownExpand Up@@ -115,21 +117,22 @@ After performing a query, you can check where the result came from.
const publishedPostsStatus = client.$cache.status // 'hit' | 'miss' | 'stale'
```

* `hit` - a cache entry in the `ttl` window was found, and the database was not queried.
* `miss` - a cache entry was not found, and the database was queried.
* `stale` - a cache entry in the `swr` window was found, and the database was queried in the background to revalidate it.
- `hit` - a cache entry in the `ttl` window was found, and the database was not queried.
- `miss` - a cache entry was not found, and the database was queried.
- `stale` - a cache entry in the `swr` window was found, and the database was queried in the background to revalidate it.

## Revalidation

If the result was stale, you can choose to await its revalidation.

```typescript
const revalidatedPublishedPosts = await client.$cache.revalidation as Post[]
```

## Cache Options

* `ttl` reduces response times and database load by serving cached results.
* `swr` reduces response times by serving cached results, but does not reduce database load because it performs a revalidation in the background after each request.
- `ttl` reduces response times and database load by serving cached results.
- `swr` reduces response times by serving cached results, but does not reduce database load because it performs a revalidation in the background after each request.

> [!NOTE]
> The total TTL of a cache entry is equal to its `ttl` + `swr`. The `ttl` window comes first, followed by the `swr` window. You can combine the two options to best suit the needs of your application.
Expand Down

61 changes: 11 additions & 50 deletions
bun.lock

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
chore: merge dev to main#21

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

sanny-io
merged 2 commits into

from

Feb 3, 2026
 Merged


chore: merge dev to main
#21
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
d7fcd3a

chore: convert from monorepo (#19)


sanny-io Feb 3, 2026
024ae1a

fix: id field not being mapped (#20)


sanny-io Feb 3, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


6 changes: 3 additions & 3 deletions
.coderabbit.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json
language: "en-US"
language: 'en-US'
early_access: false
reviews:
 profile: "assertive"
 profile: 'assertive'
 request_changes_workflow: false
 high_level_summary: true
 poem: false
Expand All@@ -13,4 +13,4 @@ reviews:
 enabled: true
 drafts: false
chat:
 auto_reply: true
 auto_reply: true

4 changes: 2 additions & 2 deletions
.devcontainer/docker-compose.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,7 +30,7 @@ services:
 volumes:
 - redis-data:/data
 healthcheck:
 test: ["CMD-SHELL", "redis-cli ping | grep PONG"]
 test: ['CMD-SHELL', 'redis-cli ping | grep PONG']
 interval: 5s
 timeout: 5s
 retries: 5
Expand All@@ -45,4 +45,4 @@ services:
 ports:
 - 5540:5540
 volumes:
 - redis-insight:/data
 - redis-insight:/data

4 changes: 2 additions & 2 deletions
.github/workflows/build-and-test.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,7 @@ jobs:
 - name: Check out repository code
 uses: actions/checkout@v5

 - name: Install system dependencies
 - name: Install system dependencies
 run: |
 apt-get update
 apt-get install -y unzip
Expand All@@ -35,4 +35,4 @@ jobs:
 - name: Test
 env:
 REDIS_URL: redis://redis:6379
 run: bun run test
 run: bun run test

9 changes: 3 additions & 6 deletions
.github/workflows/publish-package.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,7 +22,7 @@ jobs:
 - name: Check out repository code
 uses: actions/checkout@v5

 - name: Install system dependencies
 - name: Install system dependencies
 run: |
 apt-get update
 apt-get install -y unzip
Expand All@@ -41,15 +41,12 @@ jobs:
 REDIS_URL: redis://redis:6379
 run: bun run test

 - name: Copy extra files
 run: cp ./README.md ./LICENSE ./packages/cache

 - name: Publish package to NPM
 env:
 NPM_CONFIG_TOKEN: ${{ secrets.NPM_CONFIG_TOKEN }}
 run: cd ./packages/cache && bun publish --tolerate-republish --access public
 run: bun publish --tolerate-republish --access public

 - name: Publish package to GitHub
 env:
 NPM_CONFIG_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 run: cd ./packages/cache && bun publish --tolerate-republish --access public --registry https://npm.pkg.github.com
 run: bun publish --tolerate-republish --access public --registry https://npm.pkg.github.com

0
packages/cache/.npmignore → .npmignore

View file


Open in desktop


File renamed without changes.


6 changes: 3 additions & 3 deletions
.oxfmtrc.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,7 @@
 "insertFinalNewline": true,
 "jsxSingleQuote": true,
 "trailingComma": "all",
"ignorePatterns": [
 "ignorePatterns": [
 "**/dist/*",
 "**/.next/*",
 "**/.turbo/*",
Expand All@@ -21,5 +21,5 @@
 "apps/next/src/app/(payload)/*",
 "apps/start/.wrangler/*",
 "apps/start/src/routeTree.gen.ts"
 ],
}
 ]
}

22 changes: 5 additions & 17 deletions
.oxlintrc.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
{
 "$schema": "./node_modules/oxlint/configuration_schema.json",
 "plugins": [
 "typescript",
 "react"
 ],
 "plugins": ["typescript", "react"],
 "categories": {
 "correctness": "warn",
 "pedantic": "warn",
Expand DownExpand Up@@ -105,9 +102,7 @@
 ],
 "overrides": [
 {
 "files": [
 "**/*.{js,mjs,cjs,ts,mts,cts,jsx,tsx}"
 ],
 "files": ["**/*.{js,mjs,cjs,ts,mts,cts,jsx,tsx}"],
 "rules": {
 "for-direction": "error",
 "no-async-promise-executor": "error",
Expand DownExpand Up@@ -165,9 +160,7 @@
 }
 },
 {
 "files": [
 "**/*.{js,mjs,cjs,ts,mts,cts,jsx,tsx}"
 ],
 "files": ["**/*.{js,mjs,cjs,ts,mts,cts,jsx,tsx}"],
 "env": {
 "browser": true,
 "commonjs": true,
Expand All@@ -176,12 +169,7 @@
 }
 },
 {
 "files": [
 "**/*.ts",
 "**/*.tsx",
 "**/*.mts",
 "**/*.cts"
 ],
 "files": ["**/*.ts", "**/*.tsx", "**/*.mts", "**/*.cts"],
 "rules": {
 "no-class-assign": "off",
 "no-const-assign": "off",
Expand All@@ -202,4 +190,4 @@
 }
 }
 ]
}
}

2 changes: 1 addition & 1 deletion
.vscode/extensions.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,4 +8,4 @@
 "vitest.explorer",
 "zenstack.zenstack-v3"
 ]
}
}

2 changes: 1 addition & 1 deletion
.vscode/settings.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,5 +4,5 @@
 "typescript.experimental.useTsgo": true,
 "[javascript][javascriptreact][typescript][typescriptreact][json][jsonc]": {
 "editor.defaultFormatter": "oxc.oxc-vscode"
 },
 }
}

33 changes: 18 additions & 15 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,8 @@
 ZenStack Cache
 </h1>

 Reduce response times and database load with query-level caching integrated with the ZenStack ORM.
Reduce response times and database load with query-level caching integrated with the ZenStack ORM.

</div>

<div align="center">
Expand All@@ -19,7 +20,7 @@
 <a href="https://discord.gg/2PaRSu7X">
 <img alt="Join the ZenStack Cache channel" src="https://img.shields.io/discord/1035538056146595961">
 </a>
 <a href="https://github.com/visualbravo/zenstack-cache/blob/76a2de03245c26841b04525dd8b424a8799d654c/LICENSE">
 <a href="https://github.com/visualbravo/zenstack-cache/blob/dev/LICENSE">
 <img alt="License: MIT" src="https://img.shields.io/badge/license-MIT-green">
 </a>

Expand All@@ -29,17 +30,18 @@
</div>

## Features
* 🌐 **Redis Cache:** A central cache to scale across different systems.
* 🖥️ **Memory Cache:** A simple cache when scale is not a concern.
* 🛟 **Type-safety:** The caching options appear in the intellisense for all read queries.
* 🏷️ **Tag-based Invalidation:** Easily invalidate multiple related cache entries.

- 🌐 **Redis Cache:** A central cache to scale across different systems.
- 🖥️ **Memory Cache:** A simple cache when scale is not a concern.
- 🛟 **Type-safety:** The caching options appear in the intellisense for all read queries.
- 🏷️ **Tag-based Invalidation:** Easily invalidate multiple related cache entries.

## Requirements

* ZenStack (version >= `3.3.0`)
* Node.js (version >= `20.0.0`)
* Redis (version >= `7.0.0`)
* ℹ️ Only if you intend to use the `RedisCacheProvider`
- ZenStack (version >= `3.3.0`)
- Node.js (version >= `20.0.0`)
- Redis (version >= `7.0.0`)
- ℹ️ Only if you intend to use the `RedisCacheProvider`

## Installation

Expand DownExpand Up@@ -115,21 +117,22 @@ After performing a query, you can check where the result came from.
const publishedPostsStatus = client.$cache.status // 'hit' | 'miss' | 'stale'
```

* `hit` - a cache entry in the `ttl` window was found, and the database was not queried.
* `miss` - a cache entry was not found, and the database was queried.
* `stale` - a cache entry in the `swr` window was found, and the database was queried in the background to revalidate it.
- `hit` - a cache entry in the `ttl` window was found, and the database was not queried.
- `miss` - a cache entry was not found, and the database was queried.
- `stale` - a cache entry in the `swr` window was found, and the database was queried in the background to revalidate it.

## Revalidation

If the result was stale, you can choose to await its revalidation.

```typescript
const revalidatedPublishedPosts = await client.$cache.revalidation as Post[]
```

## Cache Options

* `ttl` reduces response times and database load by serving cached results.
* `swr` reduces response times by serving cached results, but does not reduce database load because it performs a revalidation in the background after each request.
- `ttl` reduces response times and database load by serving cached results.
- `swr` reduces response times by serving cached results, but does not reduce database load because it performs a revalidation in the background after each request.

> [!NOTE]
> The total TTL of a cache entry is equal to its `ttl` + `swr`. The `ttl` window comes first, followed by the `swr` window. You can combine the two options to best suit the needs of your application.
Expand Down

61 changes: 11 additions & 50 deletions
bun.lock

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
chore: merge dev to main#21

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

sanny-io
merged 2 commits into

from

Feb 3, 2026
 Merged


chore: merge dev to main
#21
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
d7fcd3a

chore: convert from monorepo (#19)


sanny-io Feb 3, 2026
024ae1a

fix: id field not being mapped (#20)


sanny-io Feb 3, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


6 changes: 3 additions & 3 deletions
.coderabbit.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json
language: "en-US"
language: 'en-US'
early_access: false
reviews:
 profile: "assertive"
 profile: 'assertive'
 request_changes_workflow: false
 high_level_summary: true
 poem: false
Expand All@@ -13,4 +13,4 @@ reviews:
 enabled: true
 drafts: false
chat:
 auto_reply: true
 auto_reply: true

4 changes: 2 additions & 2 deletions
.devcontainer/docker-compose.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,7 +30,7 @@ services:
 volumes:
 - redis-data:/data
 healthcheck:
 test: ["CMD-SHELL", "redis-cli ping | grep PONG"]
 test: ['CMD-SHELL', 'redis-cli ping | grep PONG']
 interval: 5s
 timeout: 5s
 retries: 5
Expand All@@ -45,4 +45,4 @@ services:
 ports:
 - 5540:5540
 volumes:
 - redis-insight:/data
 - redis-insight:/data

4 changes: 2 additions & 2 deletions
.github/workflows/build-and-test.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,7 @@ jobs:
 - name: Check out repository code
 uses: actions/checkout@v5

 - name: Install system dependencies
 - name: Install system dependencies
 run: |
 apt-get update
 apt-get install -y unzip
Expand All@@ -35,4 +35,4 @@ jobs:
 - name: Test
 env:
 REDIS_URL: redis://redis:6379
 run: bun run test
 run: bun run test

9 changes: 3 additions & 6 deletions
.github/workflows/publish-package.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,7 +22,7 @@ jobs:
 - name: Check out repository code
 uses: actions/checkout@v5

 - name: Install system dependencies
 - name: Install system dependencies
 run: |
 apt-get update
 apt-get install -y unzip
Expand All@@ -41,15 +41,12 @@ jobs:
 REDIS_URL: redis://redis:6379
 run: bun run test

 - name: Copy extra files
 run: cp ./README.md ./LICENSE ./packages/cache

 - name: Publish package to NPM
 env:
 NPM_CONFIG_TOKEN: ${{ secrets.NPM_CONFIG_TOKEN }}
 run: cd ./packages/cache && bun publish --tolerate-republish --access public
 run: bun publish --tolerate-republish --access public

 - name: Publish package to GitHub
 env:
 NPM_CONFIG_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 run: cd ./packages/cache && bun publish --tolerate-republish --access public --registry https://npm.pkg.github.com
 run: bun publish --tolerate-republish --access public --registry https://npm.pkg.github.com

0
packages/cache/.npmignore → .npmignore

View file


Open in desktop


File renamed without changes.


6 changes: 3 additions & 3 deletions
.oxfmtrc.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,7 @@
 "insertFinalNewline": true,
 "jsxSingleQuote": true,
 "trailingComma": "all",
"ignorePatterns": [
 "ignorePatterns": [
 "**/dist/*",
 "**/.next/*",
 "**/.turbo/*",
Expand All@@ -21,5 +21,5 @@
 "apps/next/src/app/(payload)/*",
 "apps/start/.wrangler/*",
 "apps/start/src/routeTree.gen.ts"
 ],
}
 ]
}

22 changes: 5 additions & 17 deletions
.oxlintrc.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
{
 "$schema": "./node_modules/oxlint/configuration_schema.json",
 "plugins": [
 "typescript",
 "react"
 ],
 "plugins": ["typescript", "react"],
 "categories": {
 "correctness": "warn",
 "pedantic": "warn",
Expand DownExpand Up@@ -105,9 +102,7 @@
 ],
 "overrides": [
 {
 "files": [
 "**/*.{js,mjs,cjs,ts,mts,cts,jsx,tsx}"
 ],
 "files": ["**/*.{js,mjs,cjs,ts,mts,cts,jsx,tsx}"],
 "rules": {
 "for-direction": "error",
 "no-async-promise-executor": "error",
Expand DownExpand Up@@ -165,9 +160,7 @@
 }
 },
 {
 "files": [
 "**/*.{js,mjs,cjs,ts,mts,cts,jsx,tsx}"
 ],
 "files": ["**/*.{js,mjs,cjs,ts,mts,cts,jsx,tsx}"],
 "env": {
 "browser": true,
 "commonjs": true,
Expand All@@ -176,12 +169,7 @@
 }
 },
 {
 "files": [
 "**/*.ts",
 "**/*.tsx",
 "**/*.mts",
 "**/*.cts"
 ],
 "files": ["**/*.ts", "**/*.tsx", "**/*.mts", "**/*.cts"],
 "rules": {
 "no-class-assign": "off",
 "no-const-assign": "off",
Expand All@@ -202,4 +190,4 @@
 }
 }
 ]
}
}

2 changes: 1 addition & 1 deletion
.vscode/extensions.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,4 +8,4 @@
 "vitest.explorer",
 "zenstack.zenstack-v3"
 ]
}
}

2 changes: 1 addition & 1 deletion
.vscode/settings.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,5 +4,5 @@
 "typescript.experimental.useTsgo": true,
 "[javascript][javascriptreact][typescript][typescriptreact][json][jsonc]": {
 "editor.defaultFormatter": "oxc.oxc-vscode"
 },
 }
}

33 changes: 18 additions & 15 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,8 @@
 ZenStack Cache
 </h1>

 Reduce response times and database load with query-level caching integrated with the ZenStack ORM.
Reduce response times and database load with query-level caching integrated with the ZenStack ORM.

</div>

<div align="center">
Expand All@@ -19,7 +20,7 @@
 <a href="https://discord.gg/2PaRSu7X">
 <img alt="Join the ZenStack Cache channel" src="https://img.shields.io/discord/1035538056146595961">
 </a>
 <a href="https://github.com/visualbravo/zenstack-cache/blob/76a2de03245c26841b04525dd8b424a8799d654c/LICENSE">
 <a href="https://github.com/visualbravo/zenstack-cache/blob/dev/LICENSE">
 <img alt="License: MIT" src="https://img.shields.io/badge/license-MIT-green">
 </a>

Expand All@@ -29,17 +30,18 @@
</div>

## Features
* 🌐 **Redis Cache:** A central cache to scale across different systems.
* 🖥️ **Memory Cache:** A simple cache when scale is not a concern.
* 🛟 **Type-safety:** The caching options appear in the intellisense for all read queries.
* 🏷️ **Tag-based Invalidation:** Easily invalidate multiple related cache entries.

- 🌐 **Redis Cache:** A central cache to scale across different systems.
- 🖥️ **Memory Cache:** A simple cache when scale is not a concern.
- 🛟 **Type-safety:** The caching options appear in the intellisense for all read queries.
- 🏷️ **Tag-based Invalidation:** Easily invalidate multiple related cache entries.

## Requirements

* ZenStack (version >= `3.3.0`)
* Node.js (version >= `20.0.0`)
* Redis (version >= `7.0.0`)
* ℹ️ Only if you intend to use the `RedisCacheProvider`
- ZenStack (version >= `3.3.0`)
- Node.js (version >= `20.0.0`)
- Redis (version >= `7.0.0`)
- ℹ️ Only if you intend to use the `RedisCacheProvider`

## Installation

Expand DownExpand Up@@ -115,21 +117,22 @@ After performing a query, you can check where the result came from.
const publishedPostsStatus = client.$cache.status // 'hit' | 'miss' | 'stale'
```

* `hit` - a cache entry in the `ttl` window was found, and the database was not queried.
* `miss` - a cache entry was not found, and the database was queried.
* `stale` - a cache entry in the `swr` window was found, and the database was queried in the background to revalidate it.
- `hit` - a cache entry in the `ttl` window was found, and the database was not queried.
- `miss` - a cache entry was not found, and the database was queried.
- `stale` - a cache entry in the `swr` window was found, and the database was queried in the background to revalidate it.

## Revalidation

If the result was stale, you can choose to await its revalidation.

```typescript
const revalidatedPublishedPosts = await client.$cache.revalidation as Post[]
```

## Cache Options

* `ttl` reduces response times and database load by serving cached results.
* `swr` reduces response times by serving cached results, but does not reduce database load because it performs a revalidation in the background after each request.
- `ttl` reduces response times and database load by serving cached results.
- `swr` reduces response times by serving cached results, but does not reduce database load because it performs a revalidation in the background after each request.

> [!NOTE]
> The total TTL of a cache entry is equal to its `ttl` + `swr`. The `ttl` window comes first, followed by the `swr` window. You can combine the two options to best suit the needs of your application.
Expand Down

61 changes: 11 additions & 50 deletions
bun.lock

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
chore: merge dev to main#21

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

sanny-io
merged 2 commits into

from

Feb 3, 2026
 Merged


chore: merge dev to main
#21
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
d7fcd3a

chore: convert from monorepo (#19)


sanny-io Feb 3, 2026
024ae1a

fix: id field not being mapped (#20)


sanny-io Feb 3, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


6 changes: 3 additions & 3 deletions
.coderabbit.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json
language: "en-US"
language: 'en-US'
early_access: false
reviews:
 profile: "assertive"
 profile: 'assertive'
 request_changes_workflow: false
 high_level_summary: true
 poem: false
Expand All@@ -13,4 +13,4 @@ reviews:
 enabled: true
 drafts: false
chat:
 auto_reply: true
 auto_reply: true

4 changes: 2 additions & 2 deletions
.devcontainer/docker-compose.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,7 +30,7 @@ services:
 volumes:
 - redis-data:/data
 healthcheck:
 test: ["CMD-SHELL", "redis-cli ping | grep PONG"]
 test: ['CMD-SHELL', 'redis-cli ping | grep PONG']
 interval: 5s
 timeout: 5s
 retries: 5
Expand All@@ -45,4 +45,4 @@ services:
 ports:
 - 5540:5540
 volumes:
 - redis-insight:/data
 - redis-insight:/data

4 changes: 2 additions & 2 deletions
.github/workflows/build-and-test.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,7 @@ jobs:
 - name: Check out repository code
 uses: actions/checkout@v5

 - name: Install system dependencies
 - name: Install system dependencies
 run: |
 apt-get update
 apt-get install -y unzip
Expand All@@ -35,4 +35,4 @@ jobs:
 - name: Test
 env:
 REDIS_URL: redis://redis:6379
 run: bun run test
 run: bun run test

9 changes: 3 additions & 6 deletions
.github/workflows/publish-package.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,7 +22,7 @@ jobs:
 - name: Check out repository code
 uses: actions/checkout@v5

 - name: Install system dependencies
 - name: Install system dependencies
 run: |
 apt-get update
 apt-get install -y unzip
Expand All@@ -41,15 +41,12 @@ jobs:
 REDIS_URL: redis://redis:6379
 run: bun run test

 - name: Copy extra files
 run: cp ./README.md ./LICENSE ./packages/cache

 - name: Publish package to NPM
 env:
 NPM_CONFIG_TOKEN: ${{ secrets.NPM_CONFIG_TOKEN }}
 run: cd ./packages/cache && bun publish --tolerate-republish --access public
 run: bun publish --tolerate-republish --access public

 - name: Publish package to GitHub
 env:
 NPM_CONFIG_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 run: cd ./packages/cache && bun publish --tolerate-republish --access public --registry https://npm.pkg.github.com
 run: bun publish --tolerate-republish --access public --registry https://npm.pkg.github.com

0
packages/cache/.npmignore → .npmignore

View file


Open in desktop


File renamed without changes.


6 changes: 3 additions & 3 deletions
.oxfmtrc.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,7 @@
 "insertFinalNewline": true,
 "jsxSingleQuote": true,
 "trailingComma": "all",
"ignorePatterns": [
 "ignorePatterns": [
 "**/dist/*",
 "**/.next/*",
 "**/.turbo/*",
Expand All@@ -21,5 +21,5 @@
 "apps/next/src/app/(payload)/*",
 "apps/start/.wrangler/*",
 "apps/start/src/routeTree.gen.ts"
 ],
}
 ]
}

22 changes: 5 additions & 17 deletions
.oxlintrc.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
{
 "$schema": "./node_modules/oxlint/configuration_schema.json",
 "plugins": [
 "typescript",
 "react"
 ],
 "plugins": ["typescript", "react"],
 "categories": {
 "correctness": "warn",
 "pedantic": "warn",
Expand DownExpand Up@@ -105,9 +102,7 @@
 ],
 "overrides": [
 {
 "files": [
 "**/*.{js,mjs,cjs,ts,mts,cts,jsx,tsx}"
 ],
 "files": ["**/*.{js,mjs,cjs,ts,mts,cts,jsx,tsx}"],
 "rules": {
 "for-direction": "error",
 "no-async-promise-executor": "error",
Expand DownExpand Up@@ -165,9 +160,7 @@
 }
 },
 {
 "files": [
 "**/*.{js,mjs,cjs,ts,mts,cts,jsx,tsx}"
 ],
 "files": ["**/*.{js,mjs,cjs,ts,mts,cts,jsx,tsx}"],
 "env": {
 "browser": true,
 "commonjs": true,
Expand All@@ -176,12 +169,7 @@
 }
 },
 {
 "files": [
 "**/*.ts",
 "**/*.tsx",
 "**/*.mts",
 "**/*.cts"
 ],
 "files": ["**/*.ts", "**/*.tsx", "**/*.mts", "**/*.cts"],
 "rules": {
 "no-class-assign": "off",
 "no-const-assign": "off",
Expand All@@ -202,4 +190,4 @@
 }
 }
 ]
}
}

2 changes: 1 addition & 1 deletion
.vscode/extensions.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,4 +8,4 @@
 "vitest.explorer",
 "zenstack.zenstack-v3"
 ]
}
}

2 changes: 1 addition & 1 deletion
.vscode/settings.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,5 +4,5 @@
 "typescript.experimental.useTsgo": true,
 "[javascript][javascriptreact][typescript][typescriptreact][json][jsonc]": {
 "editor.defaultFormatter": "oxc.oxc-vscode"
 },
 }
}

33 changes: 18 additions & 15 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,8 @@
 ZenStack Cache
 </h1>

 Reduce response times and database load with query-level caching integrated with the ZenStack ORM.
Reduce response times and database load with query-level caching integrated with the ZenStack ORM.

</div>

<div align="center">
Expand All@@ -19,7 +20,7 @@
 <a href="https://discord.gg/2PaRSu7X">
 <img alt="Join the ZenStack Cache channel" src="https://img.shields.io/discord/1035538056146595961">
 </a>
 <a href="https://github.com/visualbravo/zenstack-cache/blob/76a2de03245c26841b04525dd8b424a8799d654c/LICENSE">
 <a href="https://github.com/visualbravo/zenstack-cache/blob/dev/LICENSE">
 <img alt="License: MIT" src="https://img.shields.io/badge/license-MIT-green">
 </a>

Expand All@@ -29,17 +30,18 @@
</div>

## Features
* 🌐 **Redis Cache:** A central cache to scale across different systems.
* 🖥️ **Memory Cache:** A simple cache when scale is not a concern.
* 🛟 **Type-safety:** The caching options appear in the intellisense for all read queries.
* 🏷️ **Tag-based Invalidation:** Easily invalidate multiple related cache entries.

- 🌐 **Redis Cache:** A central cache to scale across different systems.
- 🖥️ **Memory Cache:** A simple cache when scale is not a concern.
- 🛟 **Type-safety:** The caching options appear in the intellisense for all read queries.
- 🏷️ **Tag-based Invalidation:** Easily invalidate multiple related cache entries.

## Requirements

* ZenStack (version >= `3.3.0`)
* Node.js (version >= `20.0.0`)
* Redis (version >= `7.0.0`)
* ℹ️ Only if you intend to use the `RedisCacheProvider`
- ZenStack (version >= `3.3.0`)
- Node.js (version >= `20.0.0`)
- Redis (version >= `7.0.0`)
- ℹ️ Only if you intend to use the `RedisCacheProvider`

## Installation

Expand DownExpand Up@@ -115,21 +117,22 @@ After performing a query, you can check where the result came from.
const publishedPostsStatus = client.$cache.status // 'hit' | 'miss' | 'stale'
```

* `hit` - a cache entry in the `ttl` window was found, and the database was not queried.
* `miss` - a cache entry was not found, and the database was queried.
* `stale` - a cache entry in the `swr` window was found, and the database was queried in the background to revalidate it.
- `hit` - a cache entry in the `ttl` window was found, and the database was not queried.
- `miss` - a cache entry was not found, and the database was queried.
- `stale` - a cache entry in the `swr` window was found, and the database was queried in the background to revalidate it.

## Revalidation

If the result was stale, you can choose to await its revalidation.

```typescript
const revalidatedPublishedPosts = await client.$cache.revalidation as Post[]
```

## Cache Options

* `ttl` reduces response times and database load by serving cached results.
* `swr` reduces response times by serving cached results, but does not reduce database load because it performs a revalidation in the background after each request.
- `ttl` reduces response times and database load by serving cached results.
- `swr` reduces response times by serving cached results, but does not reduce database load because it performs a revalidation in the background after each request.

> [!NOTE]
> The total TTL of a cache entry is equal to its `ttl` + `swr`. The `ttl` window comes first, followed by the `swr` window. You can combine the two options to best suit the needs of your application.
Expand Down

61 changes: 11 additions & 50 deletions
bun.lock

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
chore: merge dev to main#21

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

sanny-io
merged 2 commits into

from

Feb 3, 2026
 Merged


chore: merge dev to main
#21
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
d7fcd3a

chore: convert from monorepo (#19)


sanny-io Feb 3, 2026
024ae1a

fix: id field not being mapped (#20)


sanny-io Feb 3, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


6 changes: 3 additions & 3 deletions
.coderabbit.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json
language: "en-US"
language: 'en-US'
early_access: false
reviews:
 profile: "assertive"
 profile: 'assertive'
 request_changes_workflow: false
 high_level_summary: true
 poem: false
Expand All@@ -13,4 +13,4 @@ reviews:
 enabled: true
 drafts: false
chat:
 auto_reply: true
 auto_reply: true

4 changes: 2 additions & 2 deletions
.devcontainer/docker-compose.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,7 +30,7 @@ services:
 volumes:
 - redis-data:/data
 healthcheck:
 test: ["CMD-SHELL", "redis-cli ping | grep PONG"]
 test: ['CMD-SHELL', 'redis-cli ping | grep PONG']
 interval: 5s
 timeout: 5s
 retries: 5
Expand All@@ -45,4 +45,4 @@ services:
 ports:
 - 5540:5540
 volumes:
 - redis-insight:/data
 - redis-insight:/data

4 changes: 2 additions & 2 deletions
.github/workflows/build-and-test.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,7 @@ jobs:
 - name: Check out repository code
 uses: actions/checkout@v5

 - name: Install system dependencies
 - name: Install system dependencies
 run: |
 apt-get update
 apt-get install -y unzip
Expand All@@ -35,4 +35,4 @@ jobs:
 - name: Test
 env:
 REDIS_URL: redis://redis:6379
 run: bun run test
 run: bun run test

9 changes: 3 additions & 6 deletions
.github/workflows/publish-package.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,7 +22,7 @@ jobs:
 - name: Check out repository code
 uses: actions/checkout@v5

 - name: Install system dependencies
 - name: Install system dependencies
 run: |
 apt-get update
 apt-get install -y unzip
Expand All@@ -41,15 +41,12 @@ jobs:
 REDIS_URL: redis://redis:6379
 run: bun run test

 - name: Copy extra files
 run: cp ./README.md ./LICENSE ./packages/cache

 - name: Publish package to NPM
 env:
 NPM_CONFIG_TOKEN: ${{ secrets.NPM_CONFIG_TOKEN }}
 run: cd ./packages/cache && bun publish --tolerate-republish --access public
 run: bun publish --tolerate-republish --access public

 - name: Publish package to GitHub
 env:
 NPM_CONFIG_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 run: cd ./packages/cache && bun publish --tolerate-republish --access public --registry https://npm.pkg.github.com
 run: bun publish --tolerate-republish --access public --registry https://npm.pkg.github.com

0
packages/cache/.npmignore → .npmignore

View file


Open in desktop


File renamed without changes.


6 changes: 3 additions & 3 deletions
.oxfmtrc.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,7 @@
 "insertFinalNewline": true,
 "jsxSingleQuote": true,
 "trailingComma": "all",
"ignorePatterns": [
 "ignorePatterns": [
 "**/dist/*",
 "**/.next/*",
 "**/.turbo/*",
Expand All@@ -21,5 +21,5 @@
 "apps/next/src/app/(payload)/*",
 "apps/start/.wrangler/*",
 "apps/start/src/routeTree.gen.ts"
 ],
}
 ]
}

22 changes: 5 additions & 17 deletions
.oxlintrc.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
{
 "$schema": "./node_modules/oxlint/configuration_schema.json",
 "plugins": [
 "typescript",
 "react"
 ],
 "plugins": ["typescript", "react"],
 "categories": {
 "correctness": "warn",
 "pedantic": "warn",
Expand DownExpand Up@@ -105,9 +102,7 @@
 ],
 "overrides": [
 {
 "files": [
 "**/*.{js,mjs,cjs,ts,mts,cts,jsx,tsx}"
 ],
 "files": ["**/*.{js,mjs,cjs,ts,mts,cts,jsx,tsx}"],
 "rules": {
 "for-direction": "error",
 "no-async-promise-executor": "error",
Expand DownExpand Up@@ -165,9 +160,7 @@
 }
 },
 {
 "files": [
 "**/*.{js,mjs,cjs,ts,mts,cts,jsx,tsx}"
 ],
 "files": ["**/*.{js,mjs,cjs,ts,mts,cts,jsx,tsx}"],
 "env": {
 "browser": true,
 "commonjs": true,
Expand All@@ -176,12 +169,7 @@
 }
 },
 {
 "files": [
 "**/*.ts",
 "**/*.tsx",
 "**/*.mts",
 "**/*.cts"
 ],
 "files": ["**/*.ts", "**/*.tsx", "**/*.mts", "**/*.cts"],
 "rules": {
 "no-class-assign": "off",
 "no-const-assign": "off",
Expand All@@ -202,4 +190,4 @@
 }
 }
 ]
}
}

2 changes: 1 addition & 1 deletion
.vscode/extensions.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,4 +8,4 @@
 "vitest.explorer",
 "zenstack.zenstack-v3"
 ]
}
}

2 changes: 1 addition & 1 deletion
.vscode/settings.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,5 +4,5 @@
 "typescript.experimental.useTsgo": true,
 "[javascript][javascriptreact][typescript][typescriptreact][json][jsonc]": {
 "editor.defaultFormatter": "oxc.oxc-vscode"
 },
 }
}

33 changes: 18 additions & 15 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,8 @@
 ZenStack Cache
 </h1>

 Reduce response times and database load with query-level caching integrated with the ZenStack ORM.
Reduce response times and database load with query-level caching integrated with the ZenStack ORM.

</div>

<div align="center">
Expand All@@ -19,7 +20,7 @@
 <a href="https://discord.gg/2PaRSu7X">
 <img alt="Join the ZenStack Cache channel" src="https://img.shields.io/discord/1035538056146595961">
 </a>
 <a href="https://github.com/visualbravo/zenstack-cache/blob/76a2de03245c26841b04525dd8b424a8799d654c/LICENSE">
 <a href="https://github.com/visualbravo/zenstack-cache/blob/dev/LICENSE">
 <img alt="License: MIT" src="https://img.shields.io/badge/license-MIT-green">
 </a>

Expand All@@ -29,17 +30,18 @@
</div>

## Features
* 🌐 **Redis Cache:** A central cache to scale across different systems.
* 🖥️ **Memory Cache:** A simple cache when scale is not a concern.
* 🛟 **Type-safety:** The caching options appear in the intellisense for all read queries.
* 🏷️ **Tag-based Invalidation:** Easily invalidate multiple related cache entries.

- 🌐 **Redis Cache:** A central cache to scale across different systems.
- 🖥️ **Memory Cache:** A simple cache when scale is not a concern.
- 🛟 **Type-safety:** The caching options appear in the intellisense for all read queries.
- 🏷️ **Tag-based Invalidation:** Easily invalidate multiple related cache entries.

## Requirements

* ZenStack (version >= `3.3.0`)
* Node.js (version >= `20.0.0`)
* Redis (version >= `7.0.0`)
* ℹ️ Only if you intend to use the `RedisCacheProvider`
- ZenStack (version >= `3.3.0`)
- Node.js (version >= `20.0.0`)
- Redis (version >= `7.0.0`)
- ℹ️ Only if you intend to use the `RedisCacheProvider`

## Installation

Expand DownExpand Up@@ -115,21 +117,22 @@ After performing a query, you can check where the result came from.
const publishedPostsStatus = client.$cache.status // 'hit' | 'miss' | 'stale'
```

* `hit` - a cache entry in the `ttl` window was found, and the database was not queried.
* `miss` - a cache entry was not found, and the database was queried.
* `stale` - a cache entry in the `swr` window was found, and the database was queried in the background to revalidate it.
- `hit` - a cache entry in the `ttl` window was found, and the database was not queried.
- `miss` - a cache entry was not found, and the database was queried.
- `stale` - a cache entry in the `swr` window was found, and the database was queried in the background to revalidate it.

## Revalidation

If the result was stale, you can choose to await its revalidation.

```typescript
const revalidatedPublishedPosts = await client.$cache.revalidation as Post[]
```

## Cache Options

* `ttl` reduces response times and database load by serving cached results.
* `swr` reduces response times by serving cached results, but does not reduce database load because it performs a revalidation in the background after each request.
- `ttl` reduces response times and database load by serving cached results.
- `swr` reduces response times by serving cached results, but does not reduce database load because it performs a revalidation in the background after each request.

> [!NOTE]
> The total TTL of a cache entry is equal to its `ttl` + `swr`. The `ttl` window comes first, followed by the `swr` window. You can combine the two options to best suit the needs of your application.
Expand Down

61 changes: 11 additions & 50 deletions
bun.lock

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading