soul-cli 0.9.3 → 0.11.0
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/.github/pull_request_template.md +8 -0
- package/.github/workflows/ci.yml +2 -0
- package/.github/workflows/pr-title.yml +27 -0
- package/.github/workflows/release.yml +44 -0
- package/.release-please-manifest.json +3 -0
- package/AGENTS.md +31 -0
- package/CHANGELOG.md +47 -0
- package/CLAUDE.md +1 -0
- package/README.md +6 -5
- package/ROADMAP.md +83 -25
- package/SECURITY.md +19 -0
- package/docs/api/rows-examples.md +10 -2
- package/package.json +10 -10
- package/release-please-config.json +10 -0
- package/src/controllers/rows.js +115 -92
- package/src/controllers/rows.query.test.js +369 -0
- package/src/index.js +8 -0
- package/src/schemas/rows.js +4 -1
- package/src/server.js +2 -3
- package/src/services/rowService.js +12 -6
- package/src/services/rowService.test.js +37 -0
- package/src/swagger/swagger.json +20 -2
- package/src/tests/index.js +1 -1
- package/src/utils/query.js +285 -0
- package/src/utils/query.test.js +147 -0
- package/src/utils/sql.js +24 -0
- package/src/utils/sql.test.js +14 -0
- package/src/websocket.js +3 -2
- package/.github/workflows/npm-publish.yml +0 -36
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
## What and why
|
|
2
|
+
|
|
3
|
+
<!-- Short description of the change. -->
|
|
4
|
+
|
|
5
|
+
> **PR title must follow [Conventional Commits](https://www.conventionalcommits.org):** `feat: ...` (minor), `fix: ...` / `perf: ...` (patch), `feat!: ...` (breaking), or `docs:` / `chore:` / `ci:` / `test:` / `refactor:` (no release). The title becomes the commit on `main` and decides the next version.
|
|
6
|
+
|
|
7
|
+
- [ ] Tests added or updated
|
|
8
|
+
- [ ] Docs / `.env.sample` updated if behavior or config changed
|
package/.github/workflows/ci.yml
CHANGED
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# release-please reads the squash-merge commit, which is the PR title.
|
|
2
|
+
name: PR title
|
|
3
|
+
|
|
4
|
+
on:
|
|
5
|
+
pull_request_target:
|
|
6
|
+
types: [opened, edited, synchronize, reopened]
|
|
7
|
+
|
|
8
|
+
permissions:
|
|
9
|
+
pull-requests: read
|
|
10
|
+
|
|
11
|
+
jobs:
|
|
12
|
+
conventional-title:
|
|
13
|
+
runs-on: ubuntu-latest
|
|
14
|
+
steps:
|
|
15
|
+
- uses: amannn/action-semantic-pull-request@v5
|
|
16
|
+
env:
|
|
17
|
+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
18
|
+
with:
|
|
19
|
+
types: |
|
|
20
|
+
feat
|
|
21
|
+
fix
|
|
22
|
+
perf
|
|
23
|
+
docs
|
|
24
|
+
chore
|
|
25
|
+
ci
|
|
26
|
+
test
|
|
27
|
+
refactor
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
# Publishes to npm via Trusted Publishing (OIDC), no npm token involved.
|
|
2
|
+
# The Trusted Publisher on npmjs.com must point at workflow file `release.yml`.
|
|
3
|
+
# Publishing lives here because releases created with GITHUB_TOKEN don't
|
|
4
|
+
# trigger other workflows.
|
|
5
|
+
|
|
6
|
+
name: Release
|
|
7
|
+
|
|
8
|
+
on:
|
|
9
|
+
push:
|
|
10
|
+
branches: [main]
|
|
11
|
+
|
|
12
|
+
permissions:
|
|
13
|
+
contents: write
|
|
14
|
+
pull-requests: write
|
|
15
|
+
id-token: write
|
|
16
|
+
|
|
17
|
+
jobs:
|
|
18
|
+
release-please:
|
|
19
|
+
runs-on: ubuntu-latest
|
|
20
|
+
outputs:
|
|
21
|
+
release_created: ${{ steps.release.outputs.release_created }}
|
|
22
|
+
tag_name: ${{ steps.release.outputs.tag_name }}
|
|
23
|
+
steps:
|
|
24
|
+
- id: release
|
|
25
|
+
uses: googleapis/release-please-action@v4
|
|
26
|
+
|
|
27
|
+
publish-npm:
|
|
28
|
+
needs: release-please
|
|
29
|
+
if: needs.release-please.outputs.release_created == 'true'
|
|
30
|
+
runs-on: ubuntu-latest
|
|
31
|
+
steps:
|
|
32
|
+
- uses: actions/checkout@v4
|
|
33
|
+
with:
|
|
34
|
+
ref: ${{ needs.release-please.outputs.tag_name }}
|
|
35
|
+
- uses: actions/setup-node@v4
|
|
36
|
+
with:
|
|
37
|
+
node-version: 24
|
|
38
|
+
registry-url: https://registry.npmjs.org/
|
|
39
|
+
|
|
40
|
+
# Trusted Publishing needs npm CLI >=11.5.1
|
|
41
|
+
- run: npm install -g npm@latest
|
|
42
|
+
- run: npm ci
|
|
43
|
+
- run: npm test
|
|
44
|
+
- run: npm publish
|
package/AGENTS.md
ADDED
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# Soul
|
|
2
|
+
|
|
3
|
+
SQLite REST and realtime (WebSocket) server. Published to npm as `soul-cli` (CLI: `soul`). Node 22/24/26, CommonJS, Express 5, better-sqlite3.
|
|
4
|
+
|
|
5
|
+
## Commands
|
|
6
|
+
|
|
7
|
+
- `npm run dev` — regenerate swagger, run with nodemon
|
|
8
|
+
- `npm test` — jest (needs no setup; env vars are set in the script)
|
|
9
|
+
- `npm run test:coverage` — enforces thresholds in `package.json` (`jest.coverageThreshold`)
|
|
10
|
+
- `npm run lint` / `npm run format` — eslint / prettier
|
|
11
|
+
- `npm run swagger-autogen` — regenerates `src/swagger/swagger.json`; commit it when routes change
|
|
12
|
+
- `scripts/dev.sh` — local instance with a ready superuser
|
|
13
|
+
|
|
14
|
+
A husky pre-commit hook runs the full test suite and lint-staged.
|
|
15
|
+
|
|
16
|
+
## Layout (`src/`)
|
|
17
|
+
|
|
18
|
+
Request flow: `routes/` → `middlewares/` (+ `schemas/` Joi validation) → `controllers/` → `services/` → `db/`.
|
|
19
|
+
|
|
20
|
+
- `controllers/auth/` — users, roles, tokens
|
|
21
|
+
- `extensions.js` — user-provided extensions (`docs/extensions-examples.md`)
|
|
22
|
+
- `websocket.js` — realtime; `cli.js` / `commands.js` — CLI
|
|
23
|
+
- `config/` — env-driven config; new env vars go in `.env.sample` and `README.md`
|
|
24
|
+
- Tests live next to the code as `*.test.js`; shared helpers in `src/tests/`
|
|
25
|
+
|
|
26
|
+
## Conventions
|
|
27
|
+
|
|
28
|
+
- Single quotes, 2-space indent, prettier-formatted. Few comments.
|
|
29
|
+
- Add or update tests with every change; keep coverage above the thresholds.
|
|
30
|
+
- Commits and PR titles use conventional prefixes: `feat:`, `fix:`, `perf:`, `docs:`, `chore:`, `ci:`, `test:`, `refactor:`. Breaking changes use `feat!:` or a `BREAKING CHANGE:` footer. These drive the version bump; `pr-title.yml` checks PR titles (squash-merge commit message).
|
|
31
|
+
- Don't edit `version` in `package.json` by hand. release-please opens a release PR from merged commits; merging it tags, creates the GitHub Release and publishes to npm (`.github/workflows/release.yml`). Force a version with a `Release-As: x.y.z` commit footer.
|
package/CHANGELOG.md
ADDED
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
## [0.11.0](https://github.com/thevahidal/soul/compare/soul-cli-v0.10.0...soul-cli-v0.11.0) (2026-11-16)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Features
|
|
7
|
+
|
|
8
|
+
* add distinct, group/aggregate, new filter operators, OR groups and NOT to rows query ([95b70e4](https://github.com/thevahidal/soul/commit/95b70e4984fca5377b71b41e6736afb13a65083f))
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
### Bug Fixes
|
|
12
|
+
|
|
13
|
+
* reject repeated query params in row query helpers ([41f1cce](https://github.com/thevahidal/soul/commit/41f1cce2dc6d1a4467018612e31b285fe540c924))
|
|
14
|
+
|
|
15
|
+
## [0.10.0](https://github.com/thevahidal/soul/compare/soul-cli-v0.9.4...soul-cli-v0.10.0) (2026-11-16)
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
### Features
|
|
19
|
+
|
|
20
|
+
* add global error handling, graceful shutdown, WebSocket auth, CORS/helmet ([e8c6c7b](https://github.com/thevahidal/soul/commit/e8c6c7b2bfe5f671974c785107cb652e62843d14))
|
|
21
|
+
* **core/cli:** Added `-S` flag ([654c1f5](https://github.com/thevahidal/soul/commit/654c1f598ed288e2d58c2284697d962f57c615ba))
|
|
22
|
+
* **core:** Integrated soul-studio ([60f240f](https://github.com/thevahidal/soul/commit/60f240f6a695ccf9e322a892f1d2ee6606eaee40))
|
|
23
|
+
* expose foreign key info on GET /api/tables/:name ([b3eff42](https://github.com/thevahidal/soul/commit/b3eff42c471c36f6927ceaceade17e2d1ff8a4f0))
|
|
24
|
+
* harden extensions with multi-file loading, opt-in auth, generic methods ([e832b94](https://github.com/thevahidal/soul/commit/e832b9460292710f8cfed6e0bec35b77fa846d6d))
|
|
25
|
+
* make auth cookie SameSite/Secure configurable ([1a9ac43](https://github.com/thevahidal/soul/commit/1a9ac432aae6ce63a70b246664ebc568c18943b4))
|
|
26
|
+
* **npm-publish:** Added proper ci, build, publish procedure ([82cf9d4](https://github.com/thevahidal/soul/commit/82cf9d42230dfa0ee78d17f3ef4cb3f78922d021))
|
|
27
|
+
* **npm-publish:** Added proper ci, build, publish procedure ([553b7be](https://github.com/thevahidal/soul/commit/553b7be19915afd3e95d95452a527cb9c8225ffd))
|
|
28
|
+
|
|
29
|
+
|
|
30
|
+
### Bug Fixes
|
|
31
|
+
|
|
32
|
+
* **ci:** drop Node 20 from engines/CI matrix, unsupported by better-sqlite3 13 ([35b63ed](https://github.com/thevahidal/soul/commit/35b63ed49a3d649eece7cda8cc1ae6c267445f39))
|
|
33
|
+
* **core:** Fixed Soul Studio startup misconfiguration ([2b39777](https://github.com/thevahidal/soul/commit/2b3977759b78fb2c3a3a86991273f843931bfa7e))
|
|
34
|
+
* correct _users_roles unique constraint to (user_id, role_id) ([021c058](https://github.com/thevahidal/soul/commit/021c058ee825db17d9e9c844b936dbd0fad4f3a7))
|
|
35
|
+
* correct _users_roles unique constraint to (user_id, role_id) ([c06b403](https://github.com/thevahidal/soul/commit/c06b4039e600176e96400ce21ef0d2a6f12a3ea4))
|
|
36
|
+
* don't reject requests over an unrelated cookie the browser sends ([a99a329](https://github.com/thevahidal/soul/commit/a99a3296d8acd15edc8760a01d644fe3627241b7))
|
|
37
|
+
* give every JWT a unique jti to prevent cross-session revocation ([27f920e](https://github.com/thevahidal/soul/commit/27f920ea3a0c076bea1d1fa79fce68c5c52ba70c))
|
|
38
|
+
* keep yargs on 17 (v18 is ESM-only, breaks Jest on Node 22) ([a908687](https://github.com/thevahidal/soul/commit/a90868725282e2f2906a8a1102e0212baac7ad71))
|
|
39
|
+
* mount Studio at root and filter by path, not app.use('/studio', ...) ([acb66d9](https://github.com/thevahidal/soul/commit/acb66d911b355847c9bb59e4b52605f1da748135))
|
|
40
|
+
* mount Studio at root and filter by path, not app.use('/studio', ...) ([8f1b2fa](https://github.com/thevahidal/soul/commit/8f1b2fac7d80e1584fb375770c3072dd12c7972c))
|
|
41
|
+
* **npm-publish:** Removed `needs` key ([51a64cf](https://github.com/thevahidal/soul/commit/51a64cf103ccf0b89d175573ecf89923ad9d43cc))
|
|
42
|
+
* **npm-publish:** Removed `needs` key ([cdef494](https://github.com/thevahidal/soul/commit/cdef4943ba4dcb5ba0b10f99b6ca7ada3efe023c))
|
|
43
|
+
* **security:** address CodeQL findings on workflow permissions and PRAGMA/DROP ([97ae630](https://github.com/thevahidal/soul/commit/97ae6305be0ddd866a0ab3f7e6abdf6569464409))
|
|
44
|
+
* **security:** close SQL injection surface, validate identifiers against schema ([efeb8d1](https://github.com/thevahidal/soul/commit/efeb8d1152a0f0d8bfbf4c0dfd705aa4aae56fa7))
|
|
45
|
+
* **security:** eliminate PRAGMA identifier interpolation via table-valued functions ([aca2756](https://github.com/thevahidal/soul/commit/aca27566094d677a622edf5f41c8fe129cd4c8d3))
|
|
46
|
+
* unblock npm install, fix startup race, and rate-limit config bug ([e3b4f16](https://github.com/thevahidal/soul/commit/e3b4f16ac84fe697606085c9726b42a7c102df16))
|
|
47
|
+
* updatesuperuser crashes when setting --is_superuser via SQLite bind ([f5c3038](https://github.com/thevahidal/soul/commit/f5c30389d3e701314998229a2dee19e1232d855b))
|
package/CLAUDE.md
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
@AGENTS.md
|
package/README.md
CHANGED
|
@@ -12,14 +12,14 @@
|
|
|
12
12
|
|
|
13
13
|
### Docker
|
|
14
14
|
|
|
15
|
-
> This is a convenient way to run Soul without worrying about your local Node.js version. Soul requires Node.js `22.x`, `
|
|
15
|
+
> This is a convenient way to run Soul without worrying about your local Node.js version. Soul requires Node.js `22.x`, `24.x`, or `26.x` (see `engines` in `package.json`) since its [better-sqlite3](https://github.com/WiseLibs/better-sqlite3) dependency requires Node 22 or newer.
|
|
16
16
|
|
|
17
17
|
Using the following Dockerfile:
|
|
18
18
|
|
|
19
19
|
<details>
|
|
20
20
|
<summary>Dockerfile</summary>
|
|
21
|
-
|
|
22
|
-
|
|
21
|
+
|
|
22
|
+
```nginx
|
|
23
23
|
# node:22-alpine amd64
|
|
24
24
|
FROM node@sha256:76789712cd1ae89a1225eac9077010d68987a423588042dac30446f502f1858c AS node
|
|
25
25
|
|
|
@@ -39,7 +39,8 @@ COPY . .
|
|
|
39
39
|
|
|
40
40
|
CMD [ "npm", "start" ]
|
|
41
41
|
|
|
42
|
-
|
|
42
|
+
```
|
|
43
|
+
|
|
43
44
|
</details>
|
|
44
45
|
|
|
45
46
|
You can proceed [to building the application](https://docs.docker.com/get-started/workshop/02_our_app/#build-the-apps-image).
|
|
@@ -48,7 +49,7 @@ You can proceed [to building the application](https://docs.docker.com/get-starte
|
|
|
48
49
|
|
|
49
50
|
```bash
|
|
50
51
|
npm install -g soul-cli
|
|
51
|
-
|
|
52
|
+
```
|
|
52
53
|
|
|
53
54
|
### 1. Running Soul
|
|
54
55
|
|
package/ROADMAP.md
CHANGED
|
@@ -63,22 +63,41 @@ realtime API removes that entire failure surface.
|
|
|
63
63
|
|
|
64
64
|
## Roadmap
|
|
65
65
|
|
|
66
|
-
Ordered by
|
|
66
|
+
Ordered by importance / leverage. Each item should be scoped and planned
|
|
67
67
|
properly (via `/plan` or similar) when picked up — this is direction, not
|
|
68
68
|
a detailed spec.
|
|
69
69
|
|
|
70
|
-
### 1.
|
|
70
|
+
### 1. Query capabilities
|
|
71
71
|
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
72
|
+
Small, user-requested, and everything downstream (MCP `query_rows`, Studio)
|
|
73
|
+
inherits it, so do it first. Every identifier stays allowlist-validated via
|
|
74
|
+
`src/utils/sql.js`; values stay `?`-bound.
|
|
75
|
+
|
|
76
|
+
- `_distinct=col1,col2` → `SELECT DISTINCT`.
|
|
77
|
+
- `_group_by=col` + `_aggregate=count,sum:price,avg:price,min:x,max:x`
|
|
78
|
+
(aggregate function is an allowlist, like `operators`). Optional
|
|
79
|
+
`having`-style filters on aggregates later. Keep `getCount` correct for
|
|
80
|
+
pagination totals.
|
|
81
|
+
- More filter operators: `like`/`contains`/`startswith`, `between`,
|
|
82
|
+
`not in`, and OR groups (today all filters are ANDed).
|
|
83
|
+
- Multi-column `_ordering`.
|
|
84
|
+
- Make `_filters` parsing robust to values containing `,` and `:`.
|
|
85
|
+
|
|
86
|
+
Workaround until then: SQLite views are already queryable through the rows
|
|
87
|
+
API (`assertValidTableName` accepts views), so a view with `GROUP BY` works.
|
|
88
|
+
|
|
89
|
+
### 2. MCP server
|
|
90
|
+
|
|
91
|
+
Highest signal for where Soul's actual users increasingly are. Expose the
|
|
92
|
+
already-hardened service layer as MCP tools so agents (Claude Code, Cursor,
|
|
93
|
+
etc.) can attach to a Soul-backed DB directly instead of hand-rolling HTTP
|
|
94
|
+
calls.
|
|
76
95
|
|
|
77
96
|
Tools to expose (mirroring existing REST semantics):
|
|
78
97
|
|
|
79
98
|
- `list_tables`, `get_schema`
|
|
80
99
|
- `query_rows` (reuse the existing `_filters`/`_search`/`_ordering`/
|
|
81
|
-
`_schema`/`_extend` semantics from `rows.js
|
|
100
|
+
`_schema`/`_extend` semantics from `rows.js`, plus item 1)
|
|
82
101
|
- `insert_row`, `update_row`, `delete_row`
|
|
83
102
|
- `create_table` (JSON schema in, same shape as the existing REST
|
|
84
103
|
`POST /tables`)
|
|
@@ -89,18 +108,24 @@ logic needed, just a transport layer. Open question to resolve when
|
|
|
89
108
|
starting: ship as a separate package, or a mode on the existing CLI
|
|
90
109
|
(e.g. `soul --mcp`)?
|
|
91
110
|
|
|
92
|
-
###
|
|
111
|
+
### 3. Row-level permissions
|
|
93
112
|
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
113
|
+
Permissions today are per table and per verb only. Most real apps need
|
|
114
|
+
"users only see/edit their own rows" (e.g. a `user_id = :current_user`
|
|
115
|
+
rule per table/verb). Biggest gap between "works" and "production-ready"
|
|
116
|
+
for multi-user apps, and the natural foundation for item 4.
|
|
98
117
|
|
|
99
|
-
|
|
100
|
-
filter/ordering/table-name payloads) as both a visible regression guard
|
|
101
|
-
and something to point to.
|
|
118
|
+
### 4. Scoped agent credentials
|
|
102
119
|
|
|
103
|
-
|
|
120
|
+
Package the existing per-table CRUD permission/role system (see
|
|
121
|
+
`authService.hasTablePermission`) as a named feature: give an agent a key
|
|
122
|
+
that can only read/write specific tables. Likely needs a lighter API-key
|
|
123
|
+
auth mode alongside the current username/password + JWT flow, scoped at
|
|
124
|
+
key-creation time to specific tables/verbs (and rows, once item 3 lands).
|
|
125
|
+
Addresses a real, currently annoying problem in agentic products
|
|
126
|
+
(over-broad tool access).
|
|
127
|
+
|
|
128
|
+
### 5. Schema evolution (LLM-native schema workflows)
|
|
104
129
|
|
|
105
130
|
Soul's `createTable` API already takes a JSON schema description rather
|
|
106
131
|
than raw DDL — lean into that explicitly ("describe your schema, don't
|
|
@@ -109,7 +134,38 @@ endpoint) so an agent can iterate on a schema across a conversation
|
|
|
109
134
|
instead of only create-once. Consider migration history/versioning if
|
|
110
135
|
this sees real use.
|
|
111
136
|
|
|
112
|
-
###
|
|
137
|
+
### 6. Write-path hardening
|
|
138
|
+
|
|
139
|
+
- `bulkWrite` is a single `INSERT ... VALUES`; large batches will hit
|
|
140
|
+
SQLite's bound-variable limit. Chunk inside a transaction.
|
|
141
|
+
- Bulk update/delete by filter.
|
|
142
|
+
- Upsert (`ON CONFLICT`).
|
|
143
|
+
- Multi-operation transactions.
|
|
144
|
+
|
|
145
|
+
### 7. Production operations
|
|
146
|
+
|
|
147
|
+
- Health/readiness endpoint and basic metrics.
|
|
148
|
+
- Backup story documented in `docs/self-hosting.md` (e.g. Litestream).
|
|
149
|
+
- Structured logging and deployment guidance (Docker, reverse proxy).
|
|
150
|
+
|
|
151
|
+
### 8. Auth completeness
|
|
152
|
+
|
|
153
|
+
Audit `docs/auth.md` against what real apps need and fill gaps: password
|
|
154
|
+
reset, email verification, API keys (overlaps item 4), optional OAuth.
|
|
155
|
+
Verify what exists before scoping.
|
|
156
|
+
|
|
157
|
+
### 9. Make the safety properties part of the pitch
|
|
158
|
+
|
|
159
|
+
Write up the specific bug classes found and fixed in the hardening pass
|
|
160
|
+
(injection via unvalidated identifiers, the WS auth gap, the rate-limit
|
|
161
|
+
bug) as the actual argument for "safe to let an agent drive this." The
|
|
162
|
+
regression tests added during that work are the receipts.
|
|
163
|
+
|
|
164
|
+
Consider: an ongoing adversarial/fuzz test suite (random or LLM-generated
|
|
165
|
+
filter/ordering/table-name payloads) as both a visible regression guard
|
|
166
|
+
and something to point to. Extend it to the new query params from item 1.
|
|
167
|
+
|
|
168
|
+
### 10. Soul Studio v1 — scoped, not full-featured
|
|
113
169
|
|
|
114
170
|
Target workflow: agent writes to the DB via Soul, human opens Studio to
|
|
115
171
|
inspect and correct it. Not a general-purpose admin framework.
|
|
@@ -118,16 +174,18 @@ Needs: table/row browser, inline edit, respecting the same permission
|
|
|
118
174
|
model as the API. Explicitly **not** in scope for v1: dashboards, complex
|
|
119
175
|
relation UIs, anything Retool-shaped — get the core loop solid first.
|
|
120
176
|
|
|
121
|
-
###
|
|
177
|
+
### 11. Search and pagination
|
|
122
178
|
|
|
123
|
-
|
|
124
|
-
`
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
179
|
+
- Full-text search via FTS5 instead of `LIKE` across every column in
|
|
180
|
+
`_search`.
|
|
181
|
+
- Cursor (keyset) pagination; offset pagination gets slow on deep pages.
|
|
182
|
+
|
|
183
|
+
### 12. File storage
|
|
184
|
+
|
|
185
|
+
Attach files to rows (local disk first, S3-compatible later). Not needed
|
|
186
|
+
for the agent-backend niche, so lowest priority.
|
|
129
187
|
|
|
130
|
-
###
|
|
188
|
+
### Cheap wins (do anytime, alongside the above)
|
|
131
189
|
|
|
132
190
|
- Ship an `llms.txt`.
|
|
133
191
|
- Explicitly point agents at the already-generated OpenAPI/Swagger spec
|
package/SECURITY.md
ADDED
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# Security Policy
|
|
2
|
+
|
|
3
|
+
## Supported Versions
|
|
4
|
+
|
|
5
|
+
Only the latest release receives security fixes.
|
|
6
|
+
|
|
7
|
+
| Version | Supported |
|
|
8
|
+
| -------- | ------------------ |
|
|
9
|
+
| 0.9.x | :white_check_mark: |
|
|
10
|
+
| < 0.9 | :x: |
|
|
11
|
+
|
|
12
|
+
## Reporting a Vulnerability
|
|
13
|
+
|
|
14
|
+
Please do not open a public issue. Report it privately through GitHub:
|
|
15
|
+
https://github.com/thevahidal/soul/security/advisories/new
|
|
16
|
+
|
|
17
|
+
You can expect an initial response within a few days. If the report is accepted,
|
|
18
|
+
we will work on a fix and publish it in a new release with credit to the reporter
|
|
19
|
+
(if wanted). If it is declined, we will explain why.
|
|
@@ -32,11 +32,19 @@ Response
|
|
|
32
32
|
- `_page` e.g. `?_page=2`, to get the second page of results.
|
|
33
33
|
- `_limit` e.g. `?_limit=20`, to get 20 results per page.
|
|
34
34
|
- `_search` e.g. `?_search=rock`, to search across all fields.
|
|
35
|
-
- `_ordering` e.g. `?_ordering=-Title`, to order rows by title descending, or without `-` to sort ascending, e.g. `?_ordering=Title
|
|
35
|
+
- `_ordering` e.g. `?_ordering=-Title`, to order rows by title descending, or without `-` to sort ascending, e.g. `?_ordering=Title`. Use commas to order by several columns, e.g. `?_ordering=ArtistId,-Title`.
|
|
36
36
|
- `_schema` e.g. `?_schema=Title,ArtistId`, to get only the Title and ArtistId columns.
|
|
37
37
|
- `_extend` e.g. `?_extend=ArtistId`, to get the Artist object related to the Album.
|
|
38
|
+
- `_distinct` e.g. `?_distinct=ArtistId`, to get the unique values of a column (or unique combinations, e.g. `?_distinct=ArtistId,Title`). Can't be combined with `_schema`, `_extend`, `_group_by` or `_aggregate`.
|
|
39
|
+
- `_group_by` and `_aggregate` e.g. `?_group_by=ArtistId&_aggregate=count,max:Milliseconds`, to group rows and aggregate them. Aggregates are `count`, `count:col`, `sum:col`, `avg:col`, `min:col`, `max:col` and are returned as `count`, `max_Milliseconds`, ... `_aggregate` alone returns a single row. `_filters` apply before grouping, `_ordering` can use a grouped column or an aggregate name (e.g. `-count`), and `total` is the number of groups.
|
|
38
40
|
- `_filters` e.g. `?_filters=ArtistId:[1,2,3],Title:Rock`, to get only the rows where the ArtistId can be 1,2 or 3 and the Title is Rock.
|
|
39
|
-
NOTE: If you want to use comparison operators in the filter, you can use these operators after the field: `__eq, __neq, __lt, __gt, __lte, __gte, __null, __notnull` . For example, you can use `/invoices/rows?_filters=InvoiceId__neq:1,Total__gte:5,BillingPostalCode__notnull`
|
|
41
|
+
NOTE: If you want to use comparison operators in the filter, you can use these operators after the field: `__eq, __neq, __lt, __gt, __lte, __gte, __null, __notnull, __like, __contains, __startswith, __between, __in, __notin` . For example, you can use `/invoices/rows?_filters=InvoiceId__neq:1,Total__gte:5,BillingPostalCode__notnull`
|
|
42
|
+
|
|
43
|
+
- `__like:A%` uses SQL `LIKE` wildcards; `__contains:rock` and `__startswith:Rock` match literally.
|
|
44
|
+
- `__between:[1,10]` is inclusive. `__in:[1,2]` and `__notin:[1,2]` take a list.
|
|
45
|
+
- Wrap a value in double quotes to use `,` `:` `|` `(` `)` in it, e.g. `Title:"Rock, Paper"`; write `""` for a literal quote. Quotes only count when the closing quote ends the value.
|
|
46
|
+
- An OR group is written in parentheses: `(Total__gt:5|BillingPostalCode__null),Country:USA`. Groups and other filters are ANDed.
|
|
47
|
+
- `!` negates a filter or a group: `!Country:USA`, `!(Total__gt:5|Total__null)`. Like `__neq`, a negated filter skips rows where the column is NULL.
|
|
40
48
|
|
|
41
49
|
Example with query params
|
|
42
50
|
|
package/package.json
CHANGED
|
@@ -1,20 +1,20 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "soul-cli",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.11.0",
|
|
4
4
|
"description": "A SQLite REST and Realtime server",
|
|
5
5
|
"main": "src/server.js",
|
|
6
6
|
"bin": {
|
|
7
7
|
"soul": "./src/server.js"
|
|
8
8
|
},
|
|
9
9
|
"engines": {
|
|
10
|
-
"node": "22.x ||
|
|
10
|
+
"node": "22.x || 24.x || 26.x"
|
|
11
11
|
},
|
|
12
12
|
"scripts": {
|
|
13
13
|
"start": "node src/server.js",
|
|
14
14
|
"dev": "npm run swagger-autogen && cross-env NO_CLI=true nodemon src/server.js",
|
|
15
15
|
"cli": "nodemon src/server.js --database foobar.db",
|
|
16
16
|
"swagger-autogen": "cross-env NO_CLI=true node src/swagger/index.js",
|
|
17
|
-
"test": "cross-env CI=true NODE_ENV=test NO_CLI=true DB=test.db CORE_PORT=8001 AUTH=true TOKEN_SECRET=test-only-ci-secret-0123456789 INITIAL_USER_USERNAME=admin INITIAL_USER_PASSWORD=Str0ngTestPw!1 jest --testTimeout=10000 --runInBand --forceExit",
|
|
17
|
+
"test": "cross-env NODE_OPTIONS=--experimental-vm-modules CI=true NODE_ENV=test NO_CLI=true DB=test.db CORE_PORT=8001 AUTH=true TOKEN_SECRET=test-only-ci-secret-0123456789 INITIAL_USER_USERNAME=admin INITIAL_USER_PASSWORD=Str0ngTestPw!1 jest --testTimeout=10000 --runInBand --forceExit",
|
|
18
18
|
"test:coverage": "npm test -- --coverage --coverageProvider=v8",
|
|
19
19
|
"prepare": "husky",
|
|
20
20
|
"lint": "eslint . --fix --max-warnings=0",
|
|
@@ -33,23 +33,23 @@
|
|
|
33
33
|
"dependencies": {
|
|
34
34
|
"bcrypt": "^6.0.0",
|
|
35
35
|
"better-sqlite3": "^13.0.3",
|
|
36
|
-
"body-parser": "^
|
|
36
|
+
"body-parser": "^2.4.0",
|
|
37
37
|
"check-password-strength": "^2.0.7",
|
|
38
|
-
"cookie": "^0.
|
|
38
|
+
"cookie": "^2.0.2",
|
|
39
39
|
"cookie-parser": "^1.4.6",
|
|
40
40
|
"cors": "^2.8.5",
|
|
41
41
|
"dotenv": "^17.4.2",
|
|
42
42
|
"express": "^5.1.0",
|
|
43
|
-
"express-rate-limit": "^8.
|
|
43
|
+
"express-rate-limit": "^8.7.4",
|
|
44
44
|
"express-winston": "^4.2.0",
|
|
45
45
|
"helmet": "^8.3.0",
|
|
46
46
|
"joi": "^18.2.3",
|
|
47
47
|
"jsonwebtoken": "^9.0.3",
|
|
48
48
|
"soul-studio": "^0.0.3",
|
|
49
|
-
"swagger-ui-express": "^
|
|
49
|
+
"swagger-ui-express": "^5.0.1",
|
|
50
50
|
"winston": "^3.19.0",
|
|
51
51
|
"ws": "^8.21.3",
|
|
52
|
-
"yargs": "^17.7.
|
|
52
|
+
"yargs": "^17.7.3"
|
|
53
53
|
},
|
|
54
54
|
"devDependencies": {
|
|
55
55
|
"@eslint/js": "^10.0.1",
|
|
@@ -61,8 +61,8 @@
|
|
|
61
61
|
"jest": "^30.4.2",
|
|
62
62
|
"lint-staged": "^17.3.0",
|
|
63
63
|
"nodemon": "^3.1.3",
|
|
64
|
-
"prettier": "3.
|
|
65
|
-
"supertest": "^7.
|
|
64
|
+
"prettier": "3.9.6",
|
|
65
|
+
"supertest": "^7.3.2",
|
|
66
66
|
"swagger-autogen": "^2.23.1"
|
|
67
67
|
},
|
|
68
68
|
"jest": {
|