Skip to content

Commit 773c879

Browse files
authored
Use latest version for templates and docs (#642)
1 parent 2dc4fba commit 773c879

15 files changed

Lines changed: 33 additions & 102 deletions

File tree

.github/workflows/post-release.yml

Lines changed: 0 additions & 20 deletions
This file was deleted.

docs/bun.lock

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
"@radix-ui/react-separator": "1.1.7",
1818
"@radix-ui/react-slot": "1.2.3",
1919
"@radix-ui/react-tooltip": "1.2.7",
20-
"blade": "3.29.6",
20+
"blade": "3.29.8",
2121
"@tabler/icons-react": "3.34.0",
2222
"class-variance-authority": "0.7.1",
2323
"clsx": "2.1.1",

packages/blade-cli/README.md

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,10 @@
1-
# RONIN CLI
1+
# Blade CLI
22

33
[![tests](https://img.shields.io/github/actions/workflow/status/ronin-co/cli/validate.yml?label=tests)](https://github.com/ronin-co/cli/actions/workflows/validate.yml)
44
[![code coverage](https://img.shields.io/codecov/c/github/ronin-co/cli)](https://codecov.io/github/ronin-co/cli)
55
[![install size](https://packagephobia.com/badge?p=blade-cli)](https://packagephobia.com/result?p=blade-cli)
66

7-
This package exposes the `blade` command, which you can run from your terminal to interact with [RONIN](https://ronin.co).
8-
9-
## Setup
10-
11-
You don't need to install this package explicitly, as it is already included in the [RONIN client](https://github.com/ronin-co/client).
12-
13-
However, we would be excited to welcome your feature suggestions or bug fixes for the RONIN CLI. Read on to learn more about how to suggest changes.
7+
This package exposes the `blade` command.
148

159
## Contributing
1610

packages/blade-client/README.md

Lines changed: 1 addition & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -4,33 +4,7 @@
44
[![code coverage](https://img.shields.io/codecov/c/github/ronin-co/client)](https://codecov.io/github/ronin-co/client)
55
[![install size](https://packagephobia.com/badge?p=blade-client)](https://packagephobia.com/result?p=blade-client)
66

7-
This package allows for querying data from [RONIN](https://ronin.co) with ease.
8-
9-
## Setup
10-
11-
First, install the [package](https://www.npmjs.com/package/blade-client) with a package manager of your choice:
12-
13-
```bash
14-
# Bun
15-
bun add blade-client
16-
17-
# npm
18-
npm install blade-client
19-
```
20-
21-
Next, create a new app token on the [RONIN dashboard](http://ronin.co) (under "Apps" in the sidebar), and add it as a environment variable named `RONIN_TOKEN` to your project.
22-
23-
Afterward, you can start invoking RONIN from anywhere in your code:
24-
25-
```typescript
26-
importgetfrom 'blade-client';
27-
28-
const posts = await get.posts();
29-
```
30-
31-
That's it! 🎉
32-
33-
You can now start inserting records with the [RONIN query syntax](https://ronin.co/docs/queries), or add them on the [RONIN dashboard](http://ronin.co). Everything you can do with the RONIN client, you can also do on the dashboard (creating records, retrieving them, filtering them, updating them, etc).
7+
This package allows for querying data with ease.
348

359
## Contributing
3610

packages/blade-client/package.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,6 @@
5656
"author": "ronin",
5757
"license": "Apache-2.0",
5858
"repository": "ronin-co/client",
59-
"homepage": "https://ronin.co/docs/typescript-client",
6059
"engines": {
6160
"node": ">=18.17.0"
6261
},

packages/blade-client/tests/integration/triggers.test.ts

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ describe('triggers', () => {
1717
accounts: {
1818
with: {
1919
email: {
20-
endingWith: 'ronin.co',
20+
endingWith: 'example.com',
2121
},
2222
},
2323
},
@@ -53,7 +53,7 @@ describe('triggers', () => {
5353
if (multipleRecords) {
5454
query.with = {
5555
email: {
56-
endingWith: '@ronin.co',
56+
endingWith: '@example.com',
5757
},
5858
};
5959
} else {
@@ -87,10 +87,10 @@ describe('triggers', () => {
8787

8888
await factory.get.accounts();
8989
// Make sure the email address of all resolved accounts ends with the
90-
// `@ronin.co` domain name.
90+
// `@example.com` domain name.
9191
expect(mockStatements?.[0]).toMatchObject({
9292
sql: 'SELECT "id", "ronin.createdAt", "ronin.createdBy", "ronin.updatedAt", "ronin.updatedBy", "handle", "email" FROM "accounts" WHERE "email" LIKE ?1',
93-
params: ['%@ronin.co'],
93+
params: ['%@example.com'],
9494
});
9595
});
9696

@@ -139,7 +139,7 @@ describe('triggers', () => {
139139
if (multipleRecords) {
140140
query.with = {
141141
email: {
142-
endingWith: '@ronin.co',
142+
endingWith: '@example.com',
143143
},
144144
};
145145
} else {
@@ -173,14 +173,14 @@ describe('triggers', () => {
173173
});
174174

175175
await factory.get.accounts.with({
176-
email: { endingWith: '@ronin.co' },
176+
email: { endingWith: '@example.com' },
177177
});
178178

179179
// Make sure the email address of all resolved accounts ends with the
180-
// `@ronin.co` domain name.
180+
// `@example.com` domain name.
181181
expect(mockStatements?.[0]).toMatchObject({
182182
sql: 'SELECT "id", "ronin.createdAt", "ronin.createdBy", "ronin.updatedAt", "ronin.updatedBy", "handle", "email" FROM "accounts" WHERE "email" LIKE ?1',
183-
params: ['%@ronin.co'],
183+
params: ['%@example.com'],
184184
});
185185
});
186186

@@ -537,21 +537,21 @@ describe('triggers', () => {
537537
'ronin.createdBy': '1234',
538538
'ronin.updatedAt': '2024-04-16T15:02:12.710Z',
539539
'ronin.updatedBy': '1234',
540-
email: 'prev@ronin.co',
540+
email: 'prev@example.com',
541541
},
542542
{
543543
id: '2',
544544
'ronin.createdAt': '2024-04-16T15:02:12.710Z',
545545
'ronin.createdBy': '1234',
546546
'ronin.updatedAt': '2024-04-16T15:02:12.710Z',
547547
'ronin.updatedBy': '1234',
548-
email: 'prev@ronin.co',
548+
email: 'prev@example.com',
549549
},
550550
];
551551

552552
const nextAccounts = previousAccounts.map((account) => ({
553553
...account,
554-
email: 'test@ronin.co',
554+
email: 'test@example.com',
555555
}));
556556

557557
const { set } = createSyntaxFactory({
@@ -581,26 +581,26 @@ describe('triggers', () => {
581581
const accounts = (await set.accounts({
582582
with: {
583583
email: {
584-
endingWith: '@ronin.co',
584+
endingWith: '@example.com',
585585
},
586586
},
587587
to: {
588-
email: 'test@ronin.co',
588+
email: 'test@example.com',
589589
},
590590
})) as unknown as Array<Record<string, unknown>>;
591591

592592
// Make sure all accounts were updated successfully.
593-
expect(accounts.every(({ email }) => email === 'test@ronin.co')).toBe(true);
593+
expect(accounts.every(({ email }) => email === 'test@example.com')).toBe(true);
594594

595595
// Make sure `finalQuery` matches the initial query.
596596
expect(finalQuery).toMatchObject({
597597
with: {
598598
email: {
599-
endingWith: '@ronin.co',
599+
endingWith: '@example.com',
600600
},
601601
},
602602
to: {
603-
email: 'test@ronin.co',
603+
email: 'test@example.com',
604604
},
605605
});
606606

packages/blade-compiler/README.md

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,10 @@
1-
# RONIN Compiler
1+
# Blade Compiler
22

33
[![tests](https://img.shields.io/github/actions/workflow/status/ronin-co/compiler/validate.yml?label=tests)](https://github.com/ronin-co/compiler/actions/workflows/validate.yml)
44
[![code coverage](https://img.shields.io/codecov/c/github/ronin-co/compiler)](https://codecov.io/github/ronin-co/compiler)
55
[![install size](https://packagephobia.com/badge?p=blade-compiler)](https://packagephobia.com/result?p=blade-compiler)
66

7-
This package compiles [RONIN queries](https://ronin.co/docs/queries) to [SQLite](https://www.sqlite.org) statements.
8-
9-
## Setup
10-
11-
You don't need to install this package explicitly, as it is already included in the [RONIN client](https://github.com/ronin-co/client).
12-
13-
However, we would be excited to welcome your feature suggestions or bug fixes for the RONIN compiler. Read on to learn more about how to suggest changes.
7+
This package compiles [Blade queries](https://blade.im/queries) to [SQLite](https://www.sqlite.org) statements.
148

159
## Contributing
1610

packages/blade-syntax/README.md

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,10 @@
1-
# RONIN Syntax
1+
# Blade Syntax
22

33
[![tests](https://img.shields.io/github/actions/workflow/status/ronin-co/syntax/validate.yml?label=tests)](https://github.com/ronin-co/syntax/actions/workflows/validate.yml)
44
[![code coverage](https://img.shields.io/codecov/c/github/ronin-co/syntax)](https://codecov.io/github/ronin-co/syntax)
55
[![install size](https://packagephobia.com/badge?p=blade-syntax)](https://packagephobia.com/result?p=blade-syntax)
66

7-
This package makes it possible to define [RONIN](https://ronin.co) queries and schemas in TypeScript code.
8-
9-
## Setup
10-
11-
You don't need to install this package explicitly, as it is already included in the [RONIN client](https://github.com/ronin-co/client).
12-
13-
However, we would be excited to welcome your feature suggestions or bug fixes for the RONIN schema. Read on to learn more about how to suggest changes.
7+
This package makes it possible to define [Blade](https://blade.im) queries and schemas in TypeScript code.
148

159
## Contributing
1610

packages/blade/README.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,6 @@ A [React](https://react.dev) framework for building instant web apps.
1818
- **Automatic REST API** (Blade auto-generates a REST API at `/api` for you, for models that you want to expose)
1919
- **Zero Config Deployments** (Vercel, Cloudflare, containers, and more)
2020

21-
Blade works most efficiently when using SQLite databases provided by [RONIN](https://ronin.co). You can also use any other data source, however you will see performance drawbacks if that data source isn't globally fast (replicated).
22-
23-
The first and currently largest known implementation of Blade is the UI of [RONIN](https://ronin.co), which has been implemented with Blade since its inception.
24-
2521
## Considerations
2622

2723
Blade purposefully does not (and likely won't ever) comply with the official specification for React Server Components, because it provides different solutions to the problems that RSC aims to solve.

0 commit comments

Comments
 (0)