@lunora/sql-store 1.0.0-alpha.3 → 1.0.0-alpha.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,4 +1,38 @@
1
- # @lunora/sql-store
1
+ <!-- START_PACKAGE_OG_IMAGE_PLACEHOLDER -->
2
+
3
+ <a href="https://www.anolilab.com/open-source" align="center">
4
+
5
+ <img src="__assets__/package-og.svg" alt="sql-store" />
6
+
7
+ </a>
8
+
9
+ <h3 align="center">Internal dialect-parameterized SQL store core for Lunora .global() backends (D1, PlanetScale)</h3>
10
+
11
+ <!-- END_PACKAGE_OG_IMAGE_PLACEHOLDER -->
12
+
13
+ <br />
14
+
15
+ <div align="center">
16
+
17
+ [![typescript-image][typescript-badge]][typescript-url]
18
+ [![FSL-1.1-Apache-2.0 licence][license-badge]][license]
19
+ [![npm version][npm-version-badge]][npm-version]
20
+ [![npm downloads][npm-downloads-badge]][npm-downloads]
21
+ [![PRs Welcome][prs-welcome-badge]][prs-welcome]
22
+
23
+ </div>
24
+
25
+ ---
26
+
27
+ <div align="center">
28
+ <p>
29
+ <sup>
30
+ Daniel Bannert's open source work is supported by the community on <a href="https://github.com/sponsors/prisis">GitHub Sponsors</a>
31
+ </sup>
32
+ </p>
33
+ </div>
34
+
35
+ ---
2
36
 
3
37
  **Internal.** The dialect-parameterized SQL store core shared by Lunora's
4
38
  `.global()` table backends. One ORM implementation (`createSqlCtxDb`) drives any
@@ -11,6 +45,8 @@ SQL engine:
11
45
  You do not depend on this package directly. Depend on `@lunora/d1` or
12
46
  `@lunora/hyperdrive`, which supply the concrete dialect and wrap the core.
13
47
 
48
+ Part of the [Lunora](https://github.com/anolilab/lunora) framework — a type-safe, real-time backend on Cloudflare Workers + Durable Objects with a Vite-first DX.
49
+
14
50
  ## How it works
15
51
 
16
52
  The core builds every statement as a composable **drizzle `SQL`** and renders it
@@ -57,3 +93,46 @@ seam from the root); consumers import everything from the root `@lunora/sql-stor
57
93
  Writing a new engine adapter means supplying a `SqlDialect` value (see
58
94
  [`@lunora/d1`](../d1)'s `sqliteDialect` for the reference) and an `exec` that
59
95
  satisfies `SqlExec`/`SqlCtxExec`, then calling `createSqlCtxDb`.
96
+
97
+ ## Related
98
+
99
+ - [`@lunora/d1`](https://www.npmjs.com/package/@lunora/d1) — SQLite/D1 dialect and `exec` wrapping this core.
100
+ - [`@lunora/hyperdrive`](https://www.npmjs.com/package/@lunora/hyperdrive) — Postgres/MySQL dialect over Cloudflare Hyperdrive.
101
+ - [`@lunora/do`](https://www.npmjs.com/package/@lunora/do) — the shard store whose `broadcast` hook drives live queries.
102
+
103
+ ## Supported Node.js Versions
104
+
105
+ Libraries in this ecosystem make the best effort to track [Node.js' release schedule](https://github.com/nodejs/release#release-schedule).
106
+ Here's [a post on why we think this is important](https://medium.com/the-node-js-collection/maintainers-should-consider-following-node-js-release-schedule-ab08ed4de71a).
107
+
108
+ ## Contributing
109
+
110
+ If you would like to help take a look at the [list of issues](https://github.com/anolilab/lunora/issues) and check our [Contributing](https://github.com/anolilab/lunora/blob/alpha/.github/CONTRIBUTING.md) guidelines.
111
+
112
+ > **Note:** please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
113
+
114
+ ## Credits
115
+
116
+ - [Daniel Bannert](https://github.com/prisis)
117
+ - [All Contributors](https://github.com/anolilab/lunora/graphs/contributors)
118
+
119
+ ## Made with ❤️ at Anolilab
120
+
121
+ This is an open source project and will always remain free to use. If you think it's cool, please star it 🌟. [Anolilab](https://www.anolilab.com/open-source) is a Development and AI Studio. Contact us at [hello@anolilab.com](mailto:hello@anolilab.com) if you need any help with these technologies or just want to say hi!
122
+
123
+ ## License
124
+
125
+ The Lunora sql-store package is open-sourced software licensed under the [FSL-1.1-Apache-2.0][license].
126
+
127
+ <!-- badges -->
128
+
129
+ [license-badge]: https://img.shields.io/badge/license-FSL--1.1--Apache--2.0-blue.svg?style=for-the-badge
130
+ [license]: https://github.com/anolilab/lunora/blob/alpha/LICENSE.md
131
+ [npm-version-badge]: https://img.shields.io/npm/v/@lunora/sql-store?style=for-the-badge
132
+ [npm-version]: https://www.npmjs.com/package/@lunora/sql-store
133
+ [npm-downloads-badge]: https://img.shields.io/npm/dm/@lunora/sql-store?style=for-the-badge
134
+ [npm-downloads]: https://www.npmjs.com/package/@lunora/sql-store
135
+ [prs-welcome-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=for-the-badge
136
+ [prs-welcome]: https://github.com/anolilab/lunora/blob/alpha/.github/CONTRIBUTING.md
137
+ [typescript-badge]: https://img.shields.io/badge/Typescript-294E80.svg?style=for-the-badge&logo=typescript
138
+ [typescript-url]: https://www.typescriptlang.org/