@spooky-sync/query-builder 0.0.1-canary.26 → 0.0.1-canary.29
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/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@spooky-sync/query-builder",
|
|
3
|
-
"version": "0.0.1-canary.
|
|
3
|
+
"version": "0.0.1-canary.29",
|
|
4
4
|
"description": "Type-safe query builder for SurrealDB with relationship support",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"module": "dist/index.mjs",
|
|
@@ -31,7 +31,7 @@
|
|
|
31
31
|
"license": "MIT",
|
|
32
32
|
"repository": {
|
|
33
33
|
"type": "git",
|
|
34
|
-
"url": "https://github.com/mono424/
|
|
34
|
+
"url": "https://github.com/mono424/sp00ky.git",
|
|
35
35
|
"directory": "packages/query-builder"
|
|
36
36
|
},
|
|
37
37
|
"publishConfig": {
|
|
@@ -1,22 +1,22 @@
|
|
|
1
1
|
---
|
|
2
|
-
name:
|
|
2
|
+
name: sp00ky-query-builder
|
|
3
3
|
description: >-
|
|
4
|
-
Type-safe query builder for SurrealDB used by the
|
|
4
|
+
Type-safe query builder for SurrealDB used by the Sp00ky framework. Use when
|
|
5
5
|
defining schemas (SchemaStructure), building queries with QueryBuilder, handling
|
|
6
|
-
relationships (one/many cardinality), or working with
|
|
6
|
+
relationships (one/many cardinality), or working with Sp00ky type helpers like
|
|
7
7
|
TableNames, GetTable, TableModel, and QueryResult.
|
|
8
8
|
metadata:
|
|
9
|
-
author:
|
|
9
|
+
author: sp00ky-sync
|
|
10
10
|
version: "0.0.1"
|
|
11
11
|
---
|
|
12
12
|
|
|
13
|
-
#
|
|
13
|
+
# Sp00ky Query Builder
|
|
14
14
|
|
|
15
|
-
`@spooky-sync/query-builder` provides the type-safe schema definition format and query builder used throughout the
|
|
15
|
+
`@spooky-sync/query-builder` provides the type-safe schema definition format and query builder used throughout the Sp00ky framework.
|
|
16
16
|
|
|
17
17
|
## Schema Definition
|
|
18
18
|
|
|
19
|
-
|
|
19
|
+
Sp00ky schemas are defined as `const` objects satisfying `SchemaStructure`. They are typically generated by the Sp00ky CLI (`spooky generate`), but can be written by hand.
|
|
20
20
|
|
|
21
21
|
```typescript
|
|
22
22
|
import type { SchemaStructure } from '@spooky-sync/query-builder';
|
|
@@ -122,7 +122,7 @@ Cardinality is inferred from the schema. For `'one'` relationships, the result i
|
|
|
122
122
|
|
|
123
123
|
## Backend Schema
|
|
124
124
|
|
|
125
|
-
The `backends` field in `SchemaStructure` defines available HTTP backends, their outbox tables, and typed routes. This is generated by `spooky generate` from your `
|
|
125
|
+
The `backends` field in `SchemaStructure` defines available HTTP backends, their outbox tables, and typed routes. This is generated by `spooky generate` from your `sp00ky.yml` config and OpenAPI spec.
|
|
126
126
|
|
|
127
127
|
### Schema Structure
|
|
128
128
|
|
|
@@ -149,7 +149,7 @@ export interface HTTPBackendRouteArgsDefinition {
|
|
|
149
149
|
|
|
150
150
|
### Generated Example
|
|
151
151
|
|
|
152
|
-
Given a `
|
|
152
|
+
Given a `sp00ky.yml` with an `api` backend and an OpenAPI spec defining a `/spookify` route with an `id` parameter, `spooky generate` produces:
|
|
153
153
|
|
|
154
154
|
```typescript
|
|
155
155
|
export const schema = {
|
|
File without changes
|