@lunora/hyperdrive 1.0.0-alpha.15 → 1.0.0-alpha.151
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/LICENSE.md +6 -0
- package/README.md +58 -6
- package/dist/global.d.mts +136 -46
- package/dist/global.d.ts +136 -46
- package/dist/global.mjs +1 -9
- package/dist/index.d.mts +124 -175
- package/dist/index.d.ts +124 -175
- package/dist/index.mjs +1 -2
- package/dist/packem_shared/buildMysqlExec-BTmXrDGL.mjs +1 -0
- package/dist/packem_shared/createHyperdrive-DEXMfGd0.mjs +1 -0
- package/dist/packem_shared/createPgVectorIndex-CSNnG065.mjs +1 -0
- package/dist/packem_shared/mysqlDialect-WuCGPd2_.mjs +1 -0
- package/dist/packem_shared/projectSourceRow-DN8ywPRl.mjs +1 -0
- package/dist/packem_shared/types.d-DpWhWTrT.d.mts +150 -0
- package/dist/packem_shared/types.d-DpWhWTrT.d.ts +150 -0
- package/package.json +5 -3
- package/dist/packem_shared/buildMysqlExec-DBbCjyq3.mjs +0 -23
- package/dist/packem_shared/createHyperdrive-DD8GoDZo.mjs +0 -36
- package/dist/packem_shared/mysqlDialect-oNhZ58s8.mjs +0 -102
- package/dist/packem_shared/projectSourceRow-DtKuMRIm.mjs +0 -10
package/dist/index.d.ts
CHANGED
|
@@ -1,180 +1,81 @@
|
|
|
1
|
+
import { H as HyperdriveLike, a as HyperdriveConnection, M as Mysql2Like, S as SqlClient, N as NodePgLike, P as PostgresJsLike } from "./packem_shared/types.d-DpWhWTrT.js";
|
|
1
2
|
/**
|
|
2
|
-
*
|
|
3
|
-
*
|
|
4
|
-
*
|
|
5
|
-
* deliberately
|
|
6
|
-
*
|
|
7
|
-
* `
|
|
8
|
-
*
|
|
9
|
-
*
|
|
10
|
-
*
|
|
11
|
-
*
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
*
|
|
17
|
-
*
|
|
18
|
-
*
|
|
19
|
-
*
|
|
20
|
-
*
|
|
21
|
-
*
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
/**
|
|
38
|
-
* The connection config surfaced by {@link import("./create-hyperdrive").createHyperdrive | createHyperdrive}: the raw
|
|
39
|
-
* `connectionString` plus the discrete parts, ready to hand to a driver.
|
|
40
|
-
*/
|
|
41
|
-
interface HyperdriveConnection {
|
|
42
|
-
/** Database name. */
|
|
43
|
-
database: string;
|
|
44
|
-
/** Host (Hyperdrive's local proxy). */
|
|
45
|
-
host: string;
|
|
46
|
-
/** Password. */
|
|
47
|
-
password: string;
|
|
48
|
-
/** Port. */
|
|
49
|
-
port: number;
|
|
50
|
-
/** User. */
|
|
51
|
-
user: string;
|
|
52
|
-
}
|
|
53
|
-
/**
|
|
54
|
-
* The driver-agnostic SQL surface bound to `ctx.sql` on **`ActionCtx` only**.
|
|
55
|
-
*
|
|
56
|
-
* This is the exact type the generated ctx imports as
|
|
57
|
-
* `import("@lunora/hyperdrive").SqlClient`. Keep the name and shape stable — the
|
|
58
|
-
* codegen ctx wiring (Phase 1) depends on it.
|
|
59
|
-
*
|
|
60
|
-
* It is intentionally minimal — a single parameterised `query` — so it maps onto
|
|
61
|
-
* `postgres` (postgres.js), `pg` (node-postgres) and `mysql2` alike via the
|
|
62
|
-
* {@link import("./create-hyperdrive").fromPostgresJs | fromPostgresJs} /
|
|
63
|
-
* {@link import("./create-hyperdrive").fromNodePg | fromNodePg} /
|
|
64
|
-
* {@link import("./create-hyperdrive").fromMysql2 | fromMysql2} adapters. Use
|
|
65
|
-
* positional placeholders that match your driver (`$1, $2` for Postgres, `?` for
|
|
66
|
-
* MySQL); the package does not rewrite SQL.
|
|
67
|
-
*
|
|
68
|
-
* Reminder (also on the emitted JSDoc): non-deterministic, action-only,
|
|
69
|
-
* non-reactive — writes here are not tracked by Lunora live queries.
|
|
70
|
-
*/
|
|
71
|
-
interface SqlClient {
|
|
72
|
-
/**
|
|
73
|
-
* Run a parameterised SQL statement and return the result rows.
|
|
74
|
-
* @param text SQL text with driver-native positional placeholders.
|
|
75
|
-
* @param params Bound parameter values, positionally matched to `text`.
|
|
76
|
-
* @returns The rows the statement produced (empty for non-`SELECT`s that
|
|
77
|
-
* return no rows).
|
|
78
|
-
*/
|
|
79
|
-
query: <Row = Record<string, unknown>>(text: string, params?: ReadonlyArray<unknown>) => Promise<Row[]>;
|
|
80
|
-
}
|
|
81
|
-
/**
|
|
82
|
-
* Structural projection of a `pg` (node-postgres) `Client`/`Pool`. Only the
|
|
83
|
-
* `query` method `fromNodePg` calls is required, kept structural for testing.
|
|
84
|
-
*/
|
|
85
|
-
interface NodePgLike {
|
|
86
|
-
query: (text: string, params?: ReadonlyArray<unknown>) => Promise<{
|
|
87
|
-
rows: unknown[];
|
|
88
|
-
}>;
|
|
89
|
-
}
|
|
90
|
-
/**
|
|
91
|
-
* Structural projection of a `postgres` (postgres.js) tagged-template client.
|
|
92
|
-
* The adapter uses the `.unsafe(text, params)` escape hatch so callers keep
|
|
93
|
-
* full control of the parameter list.
|
|
94
|
-
*/
|
|
95
|
-
interface PostgresJsLike {
|
|
96
|
-
unsafe: (text: string, params?: ReadonlyArray<unknown>) => Promise<unknown>;
|
|
97
|
-
}
|
|
98
|
-
/**
|
|
99
|
-
* Structural projection of a `mysql2/promise` connection/pool. `mysql2`'s
|
|
100
|
-
* `execute` resolves to a `[rows, fields]` tuple; the adapter takes the first
|
|
101
|
-
* element as the rows.
|
|
102
|
-
*/
|
|
103
|
-
interface Mysql2Like {
|
|
104
|
-
execute: (text: string, params?: ReadonlyArray<unknown>) => Promise<[unknown, unknown]>;
|
|
105
|
-
}
|
|
106
|
-
/**
|
|
107
|
-
* Surface a Cloudflare Hyperdrive binding as a connection ready to feed a
|
|
108
|
-
* user-supplied SQL driver.
|
|
109
|
-
*
|
|
110
|
-
* `@lunora/hyperdrive` deliberately **bundles no driver** — `postgres`, `pg` and
|
|
111
|
-
* `mysql2` are heavy and the choice is the user's (they are `optional`
|
|
112
|
-
* `peerDependencies`, never `dependencies`). This factory's only job is to lift
|
|
113
|
-
* the binding's connection details out; the user constructs their own driver
|
|
114
|
-
* from `connectionString` and wraps it with one of the {@link fromPostgresJs} /
|
|
115
|
-
* {@link fromNodePg} / {@link fromMysql2} adapters to get a {@link SqlClient}.
|
|
116
|
-
* @example
|
|
117
|
-
* ```ts
|
|
118
|
-
* import { createHyperdrive, fromPostgresJs } from "@lunora/hyperdrive";
|
|
119
|
-
* import postgres from "postgres";
|
|
120
|
-
*
|
|
121
|
-
* // inside an action (never a query/mutation):
|
|
122
|
-
* const { connectionString } = createHyperdrive(env.HYPERDRIVE);
|
|
123
|
-
* ctx.sql = fromPostgresJs(postgres(connectionString));
|
|
124
|
-
* const rows = await ctx.sql.query("select id from users where org = $1", [orgId]);
|
|
125
|
-
* ```
|
|
126
|
-
* @remarks
|
|
127
|
-
* Hyperdrive talks to an **external** database Lunora has no visibility into.
|
|
128
|
-
* Queries through `ctx.sql` are non-deterministic (action-only — enforced by the
|
|
129
|
-
* `hyperdrive_outside_action` advisor lint) and external writes are NOT tracked
|
|
130
|
-
* by Lunora live queries: subscriptions will not re-run when external rows
|
|
131
|
-
* change. Use Hyperdrive to *integrate* an existing DB from an action; if you
|
|
132
|
-
* want that data to be reactive, write a projection of it into a `defineSchema`
|
|
133
|
-
* DO/D1 table.
|
|
134
|
-
* @param binding The `env.HYPERDRIVE` binding (or a structural double).
|
|
135
|
-
* @returns The raw `connectionString` plus the discrete connection parts.
|
|
136
|
-
*/
|
|
3
|
+
* Surface a Cloudflare Hyperdrive binding as a connection ready to feed a
|
|
4
|
+
* user-supplied SQL driver.
|
|
5
|
+
*
|
|
6
|
+
* `@lunora/hyperdrive` deliberately **bundles no driver** — `postgres`, `pg` and
|
|
7
|
+
* `mysql2` are heavy and the choice is the user's (they are `optional`
|
|
8
|
+
* `peerDependencies`, never `dependencies`). This factory's only job is to lift
|
|
9
|
+
* the binding's connection details out; the user constructs their own driver
|
|
10
|
+
* from `connectionString` and wraps it with one of the {@link fromPostgresJs} /
|
|
11
|
+
* {@link fromNodePg} / {@link fromMysql2} adapters to get a {@link SqlClient}.
|
|
12
|
+
* @example
|
|
13
|
+
* ```ts
|
|
14
|
+
* import { createHyperdrive, fromPostgresJs } from "@lunora/hyperdrive";
|
|
15
|
+
* import postgres from "postgres";
|
|
16
|
+
*
|
|
17
|
+
* // Wire the client once, on the app builder — called per shard construction,
|
|
18
|
+
* // not per request. `ctx.sql` is emitted `readonly`; it is never assigned.
|
|
19
|
+
* const app = defineApp<Env>()
|
|
20
|
+
* .shard((env) => env.SHARD)
|
|
21
|
+
* .hyperdrive((env) => fromPostgresJs(postgres(createHyperdrive(env.HYPERDRIVE).connectionString)))
|
|
22
|
+
* .build();
|
|
23
|
+
*
|
|
24
|
+
* // Then, inside an action (never a query/mutation):
|
|
25
|
+
* const rows = await ctx.sql.query("select id from users where org = $1", [orgId]);
|
|
26
|
+
* ```
|
|
27
|
+
* @remarks
|
|
28
|
+
* Hyperdrive talks to an **external** database Lunora has no visibility into.
|
|
29
|
+
* Queries through `ctx.sql` are non-deterministic (action-only — enforced by the
|
|
30
|
+
* `hyperdrive_outside_action` advisor lint) and external writes are NOT tracked
|
|
31
|
+
* by Lunora live queries: subscriptions will not re-run when external rows
|
|
32
|
+
* change. Use Hyperdrive to *integrate* an existing DB from an action; if you
|
|
33
|
+
* want that data to be reactive, write a projection of it into a `defineSchema`
|
|
34
|
+
* DO/D1 table.
|
|
35
|
+
* @param binding The `env.HYPERDRIVE` binding (or a structural double).
|
|
36
|
+
* @returns The raw `connectionString` plus the discrete connection parts.
|
|
37
|
+
*/
|
|
137
38
|
declare const createHyperdrive: (binding: HyperdriveLike) => {
|
|
138
39
|
config: HyperdriveConnection;
|
|
139
40
|
connectionString: string;
|
|
140
41
|
};
|
|
141
42
|
/**
|
|
142
|
-
* Wrap a `postgres` (postgres.js) client as a {@link SqlClient}.
|
|
143
|
-
*
|
|
144
|
-
* Uses the driver's `.unsafe(text, params)` escape hatch so the caller supplies
|
|
145
|
-
* a plain SQL string with `$1, $2, …` placeholders and a positional params
|
|
146
|
-
* array. postgres.js's `.unsafe` resolves to a row array.
|
|
147
|
-
*/
|
|
43
|
+
* Wrap a `postgres` (postgres.js) client as a {@link SqlClient}.
|
|
44
|
+
*
|
|
45
|
+
* Uses the driver's `.unsafe(text, params)` escape hatch so the caller supplies
|
|
46
|
+
* a plain SQL string with `$1, $2, …` placeholders and a positional params
|
|
47
|
+
* array. postgres.js's `.unsafe` resolves to a row array.
|
|
48
|
+
*/
|
|
148
49
|
declare const fromPostgresJs: (client: PostgresJsLike) => SqlClient;
|
|
149
50
|
/**
|
|
150
|
-
* Wrap a `pg` (node-postgres) `Client` or `Pool` as a {@link SqlClient}.
|
|
151
|
-
*
|
|
152
|
-
* node-postgres returns a result object whose `rows` field holds the row array.
|
|
153
|
-
*/
|
|
51
|
+
* Wrap a `pg` (node-postgres) `Client` or `Pool` as a {@link SqlClient}.
|
|
52
|
+
*
|
|
53
|
+
* node-postgres returns a result object whose `rows` field holds the row array.
|
|
54
|
+
*/
|
|
154
55
|
declare const fromNodePg: (client: NodePgLike) => SqlClient;
|
|
155
56
|
/**
|
|
156
|
-
* Wrap a `mysql2/promise` connection or pool as a {@link SqlClient}.
|
|
157
|
-
*
|
|
158
|
-
* Use `?` placeholders (MySQL positional syntax). `mysql2`'s `execute` resolves
|
|
159
|
-
* to a `[rows, fields]` tuple; the adapter returns the first element. For a
|
|
160
|
-
* non-`SELECT` (DML), `mysql2` yields a `ResultSetHeader` object rather than a
|
|
161
|
-
* row array, so the adapter normalises that to `[]` — matching the empty-array
|
|
162
|
-
* contract the postgres.js / node-postgres adapters already honour.
|
|
163
|
-
*/
|
|
57
|
+
* Wrap a `mysql2/promise` connection or pool as a {@link SqlClient}.
|
|
58
|
+
*
|
|
59
|
+
* Use `?` placeholders (MySQL positional syntax). `mysql2`'s `execute` resolves
|
|
60
|
+
* to a `[rows, fields]` tuple; the adapter returns the first element. For a
|
|
61
|
+
* non-`SELECT` (DML), `mysql2` yields a `ResultSetHeader` object rather than a
|
|
62
|
+
* row array, so the adapter normalises that to `[]` — matching the empty-array
|
|
63
|
+
* contract the postgres.js / node-postgres adapters already honour.
|
|
64
|
+
*/
|
|
164
65
|
declare const fromMysql2: (connection: Mysql2Like) => SqlClient;
|
|
165
66
|
/** How an external row maps to a Lunora document. */
|
|
166
67
|
interface ProjectOptions {
|
|
167
68
|
/**
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
69
|
+
* Column whose value becomes the Lunora `_id` (stringified). Defaults to `"id"`.
|
|
70
|
+
* With no `map`, this column is dropped from the document body (it lives on as
|
|
71
|
+
* `_id`); with a `map`, the mapper owns the body and `_id` is added from here.
|
|
72
|
+
*/
|
|
172
73
|
idColumn?: string;
|
|
173
74
|
/**
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
75
|
+
* Transform an external row into the stored document body. Omit for the default:
|
|
76
|
+
* every selected column except `idColumn` is copied verbatim. The returned object
|
|
77
|
+
* must not include `_id` — it is set from `idColumn`.
|
|
78
|
+
*/
|
|
178
79
|
map?: (row: Record<string, unknown>) => Record<string, unknown>;
|
|
179
80
|
}
|
|
180
81
|
/** Options for {@link pullSourceRows}: the parameterised tenant query plus the row projection. */
|
|
@@ -185,20 +86,68 @@ interface PullSourceOptions extends ProjectOptions {
|
|
|
185
86
|
query: string;
|
|
186
87
|
}
|
|
187
88
|
/**
|
|
188
|
-
* Project one external row to a Lunora document: lift `idColumn` to a stringified
|
|
189
|
-
* `_id`, then either apply `map` or copy every other column verbatim. Throws when
|
|
190
|
-
* the id column is missing/nullish so a misconfigured query fails loudly rather than
|
|
191
|
-
* materializing rows under an `"undefined"` id.
|
|
192
|
-
*
|
|
193
|
-
* Delegates to `@lunora/
|
|
194
|
-
* `.source()` poll loop also uses — so the manual bridge and the codegen path can
|
|
195
|
-
* never diverge in their missing-id handling.
|
|
196
|
-
*/
|
|
89
|
+
* Project one external row to a Lunora document: lift `idColumn` to a stringified
|
|
90
|
+
* `_id`, then either apply `map` or copy every other column verbatim. Throws when
|
|
91
|
+
* the id column is missing/nullish so a misconfigured query fails loudly rather than
|
|
92
|
+
* materializing rows under an `"undefined"` id.
|
|
93
|
+
*
|
|
94
|
+
* Delegates to `@lunora/shard-engine`'s `liftSourceId` — the single id-lift the declarative
|
|
95
|
+
* `.source()` poll loop also uses — so the manual bridge and the codegen path can
|
|
96
|
+
* never diverge in their missing-id handling.
|
|
97
|
+
*/
|
|
197
98
|
declare const projectSourceRow: (row: Record<string, unknown>, options?: ProjectOptions) => Record<string, unknown>;
|
|
198
99
|
/**
|
|
199
|
-
* Run a parameterised tenant query against Hyperdrive and project every row to a
|
|
200
|
-
* Lunora document ready to hand to `materializeExternalRows`. Call this inside an
|
|
201
|
-
* **action** (where `ctx.sql` lives); pass the result to a mutation for the write.
|
|
202
|
-
*/
|
|
100
|
+
* Run a parameterised tenant query against Hyperdrive and project every row to a
|
|
101
|
+
* Lunora document ready to hand to `materializeExternalRows`. Call this inside an
|
|
102
|
+
* **action** (where `ctx.sql` lives); pass the result to a mutation for the write.
|
|
103
|
+
*/
|
|
203
104
|
declare const pullSourceRows: (sql: SqlClient, options: PullSourceOptions) => Promise<Record<string, unknown>[]>;
|
|
204
|
-
export { type HyperdriveConnection, type HyperdriveLike, type Mysql2Like, type NodePgLike, type PostgresJsLike, type ProjectOptions, type PullSourceOptions, type SqlClient,
|
|
105
|
+
export { type HyperdriveConnection, type HyperdriveLike, type Mysql2Like, type NodePgLike, type PostgresJsLike, type ProjectOptions, type PullSourceOptions, type SqlClient,
|
|
106
|
+
/**
|
|
107
|
+
* `@lunora/hyperdrive` — bring-your-own Postgres/MySQL for Lunora via Cloudflare
|
|
108
|
+
* Hyperdrive.
|
|
109
|
+
*
|
|
110
|
+
* Surfaces a Hyperdrive binding's connection string and a driver-agnostic
|
|
111
|
+
* {@link import("./types").SqlClient | SqlClient} bound to `ctx.sql` on
|
|
112
|
+
* **`ActionCtx` only**. External SQL is non-deterministic (action-only) and
|
|
113
|
+
* non-reactive (live queries do not track external writes) — integrate an
|
|
114
|
+
* existing DB, do not replace the Lunora data layer. See the README and
|
|
115
|
+
* {@link import("./create-hyperdrive").createHyperdrive | createHyperdrive} JSDoc.
|
|
116
|
+
*/
|
|
117
|
+
createHyperdrive,
|
|
118
|
+
/**
|
|
119
|
+
* `@lunora/hyperdrive` — bring-your-own Postgres/MySQL for Lunora via Cloudflare
|
|
120
|
+
* Hyperdrive.
|
|
121
|
+
*
|
|
122
|
+
* Surfaces a Hyperdrive binding's connection string and a driver-agnostic
|
|
123
|
+
* {@link import("./types").SqlClient | SqlClient} bound to `ctx.sql` on
|
|
124
|
+
* **`ActionCtx` only**. External SQL is non-deterministic (action-only) and
|
|
125
|
+
* non-reactive (live queries do not track external writes) — integrate an
|
|
126
|
+
* existing DB, do not replace the Lunora data layer. See the README and
|
|
127
|
+
* {@link import("./create-hyperdrive").createHyperdrive | createHyperdrive} JSDoc.
|
|
128
|
+
*/
|
|
129
|
+
fromMysql2,
|
|
130
|
+
/**
|
|
131
|
+
* `@lunora/hyperdrive` — bring-your-own Postgres/MySQL for Lunora via Cloudflare
|
|
132
|
+
* Hyperdrive.
|
|
133
|
+
*
|
|
134
|
+
* Surfaces a Hyperdrive binding's connection string and a driver-agnostic
|
|
135
|
+
* {@link import("./types").SqlClient | SqlClient} bound to `ctx.sql` on
|
|
136
|
+
* **`ActionCtx` only**. External SQL is non-deterministic (action-only) and
|
|
137
|
+
* non-reactive (live queries do not track external writes) — integrate an
|
|
138
|
+
* existing DB, do not replace the Lunora data layer. See the README and
|
|
139
|
+
* {@link import("./create-hyperdrive").createHyperdrive | createHyperdrive} JSDoc.
|
|
140
|
+
*/
|
|
141
|
+
fromNodePg,
|
|
142
|
+
/**
|
|
143
|
+
* `@lunora/hyperdrive` — bring-your-own Postgres/MySQL for Lunora via Cloudflare
|
|
144
|
+
* Hyperdrive.
|
|
145
|
+
*
|
|
146
|
+
* Surfaces a Hyperdrive binding's connection string and a driver-agnostic
|
|
147
|
+
* {@link import("./types").SqlClient | SqlClient} bound to `ctx.sql` on
|
|
148
|
+
* **`ActionCtx` only**. External SQL is non-deterministic (action-only) and
|
|
149
|
+
* non-reactive (live queries do not track external writes) — integrate an
|
|
150
|
+
* existing DB, do not replace the Lunora data layer. See the README and
|
|
151
|
+
* {@link import("./create-hyperdrive").createHyperdrive | createHyperdrive} JSDoc.
|
|
152
|
+
*/
|
|
153
|
+
fromPostgresJs, projectSourceRow, pullSourceRows };
|
package/dist/index.mjs
CHANGED
|
@@ -1,2 +1 @@
|
|
|
1
|
-
|
|
2
|
-
export { projectSourceRow, pullSourceRows } from './packem_shared/projectSourceRow-DtKuMRIm.mjs';
|
|
1
|
+
import{createHyperdrive as e,fromMysql2 as f,fromNodePg as m,fromPostgresJs as p}from"./packem_shared/createHyperdrive-DEXMfGd0.mjs";import{projectSourceRow as t,pullSourceRows as c}from"./packem_shared/projectSourceRow-DN8ywPRl.mjs";export{e as createHyperdrive,f as fromMysql2,m as fromNodePg,p as fromPostgresJs,t as projectSourceRow,c as pullSourceRows};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
import{LunoraError as o}from"@lunora/errors";const n=2,s=new WeakSet,i=t=>{const e=t.config?.clientFlags;if(typeof e=="number")return e;const r=t.pool?.config?.connectionConfig?.clientFlags;return typeof r=="number"?r:void 0},c=t=>{const e=i(t);if(e===void 0){if(s.has(t))return;s.add(t),console.warn('@lunora/hyperdrive: could not determine whether this MySQL connection negotiated CLIENT_FOUND_ROWS (the driver exposes no flag introspection). If it was NOT created with the `CLIENT_FOUND_ROWS` flag (mysql2: `createPool({ flags: ["FOUND_ROWS"] })`), an idempotent patch/replace that rewrites identical values may report 0 affectedRows and raise a spurious OCC ConflictError.');return}if((e&n)===0)throw new o("INTERNAL",'@lunora/hyperdrive: this MySQL connection was not created with the `CLIENT_FOUND_ROWS` flag (mysql2: `createPool({ flags: ["FOUND_ROWS"] })`). Without it, `affectedRows` counts changed (not matched) rows, so an idempotent patch/replace that rewrites identical values reports 0 and the OCC guard raises a spurious conflict.')},u=t=>({all:(e,r)=>t.query(e,r),batch:async e=>{await Promise.all(e.map(r=>t.query(r.sql,r.params)))},run:async(e,r)=>(await t.query(e,r),{rowsAffected:0})}),d=t=>(c(t),{all:async(e,r)=>{const[a]=await t.execute(e,r);return Array.isArray(a)?a:[]},batch:async e=>{await Promise.all(e.map(r=>t.execute(r.sql,r.params)))},run:async(e,r)=>{const[a]=await t.execute(e,r);return{rowsAffected:a.affectedRows??0}}});export{d as buildMysqlExec,u as buildPgExec};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
const o=r=>({config:{database:r.database,host:r.host,password:r.password,port:r.port,user:r.user},connectionString:r.connectionString}),a=r=>({query:async(t,s=[])=>await r.unsafe(t,s)}),c=r=>({query:async(t,s=[])=>(await r.query(t,s)).rows}),n=r=>({query:async(t,s=[])=>{const[e]=await r.execute(t,s);return Array.isArray(e)?e:[]}});export{o as createHyperdrive,n as fromMysql2,c as fromNodePg,a as fromPostgresJs};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
const x=t=>/^[A-Z_]\w*$/i.test(t);const F=new Set(["42P06","42P07","23505","42710"]),X=t=>typeof t=="object"&&t!==null&&"code"in t&&typeof t.code=="string"&&F.has(t.code),P=5,v="__vec_",L="__ann_",y={cosine:{operator:"<=>",operatorClass:"vector_cosine_ops",score:t=>1-t},"dot-product":{operator:"<#>",operatorClass:"vector_ip_ops",score:t=>t},euclidean:{operator:"<->",operatorClass:"vector_l2_ops",score:t=>t}},J=63,A=J-v.length-L.length-Math.max(...Object.values(y).map(t=>t.operatorClass.length)),C=t=>`[${[...t].join(",")}]`,R=t=>{const c=Object.getPrototypeOf(t);return c===null||c===Object.prototype},D=t=>t.constructor?.name??"non-plain object",U=(t,c)=>{const o=(e,r)=>{throw new TypeError(`@lunora/hyperdrive: pgvector index "${c}" supports equality metadata filters only, but "${r}" ${e}. Pre-compute it into an equality-shaped metadata field, or keep this index on Vectorize.`)},l=(e,r)=>{(e===void 0||typeof e=="function"||typeof e=="symbol")&&o(`has a value at "${r}" that JSON cannot represent, which would widen the filter to match every row`,r),typeof e=="number"&&!Number.isFinite(e)&&o(`has a non-finite number at "${r}", which JSON turns into null`,r),typeof e=="bigint"&&o(`has a bigint at "${r}", which JSON cannot serialise`,r)},m=(e,r)=>{if(l(e,r),Array.isArray(e)){for(const[p,E]of e.entries())m(E,`${r}[${String(p)}]`);return}if(!(typeof e!="object"||e===null)){R(e)||o(`is a ${D(e)}, whose fields JSON does not preserve`,r);for(const[p,E]of Object.entries(e))p.startsWith("$")&&o("uses a comparison operator",r),m(E,`${r}.${p}`)}};R(t)||o(`is a ${D(t)}, whose fields JSON does not preserve`,"filter");for(const[e,r]of Object.entries(t))e.startsWith("$")&&o("uses a comparison operator",e),e.includes(".")&&o("uses Vectorize's dot-addressed nested syntax, which JSONB containment cannot express",e),m(r,e)},B=t=>{if(!x(t))throw new TypeError(`@lunora/hyperdrive: pgvector \`name\` must be a bare SQL identifier (letters, digits, underscore; not starting with a digit) — got "${t}"`);if(t.length>A)throw new TypeError(`@lunora/hyperdrive: pgvector \`name\` must be at most ${String(A)} characters — got "${t}" (${String(t.length)}). Postgres truncates identifiers at 63 bytes and this index derives longer names from it.`);return t},W=t=>{const{client:c,dimensions:o,metric:l="cosine",name:m}=t,e=`${v}${B(m)}`;if(!Object.hasOwn(y,l))throw new TypeError(`@lunora/hyperdrive: pgvector index "${m}" got an unknown metric "${l}" — expected cosine, euclidean, or dot-product`);const{operator:r,operatorClass:p,score:E}=y[l];if(!Number.isInteger(o)||o<=0)throw new TypeError(`@lunora/hyperdrive: pgvector index "${m}" needs a positive integer \`dimensions\` — got ${String(o)}`);if(o>2e3)throw new TypeError(`@lunora/hyperdrive: pgvector index "${m}" declares ${String(o)} dimensions, over the HNSW limit of ${String(2e3)}. Reduce the embedding width (Vectorize itself tops out at 1536), or keep this index on Vectorize.`);let O=0;const N=()=>(O+=1,`${e}:${String(O)}`);let T;const $=async()=>(T??=(async()=>{for(const n of["CREATE EXTENSION IF NOT EXISTS vector",`CREATE TABLE IF NOT EXISTS "${e}" (id text PRIMARY KEY, namespace text, embedding vector(${String(o)}) NOT NULL, metadata jsonb)`,`CREATE INDEX IF NOT EXISTS "${e}${L}${p}" ON "${e}" USING hnsw (embedding ${p})`,`CREATE INDEX IF NOT EXISTS "${e}__ns" ON "${e}" (namespace)`,`CREATE INDEX IF NOT EXISTS "${e}__meta" ON "${e}" USING gin (metadata)`])try{await c.query(n)}catch(a){if(!X(a))throw a}})().catch(n=>{throw T=void 0,n}),T),w=async(n,a)=>{if(n.length===0)return{mutationId:N()};await $();const s=[...new Map(n.map(i=>[i.id,i])).values()],g=[],u=i=>`$${String(g.push(i))}`,h=s.map(i=>`(${u(i.id)}, ${u(i.namespace??null)}, ${u(C(i.values))}::vector, ${u(i.metadata===void 0?null:JSON.stringify(i.metadata))}::jsonb)`);return await c.query(`INSERT INTO "${e}" (id, namespace, embedding, metadata) VALUES ${h.join(", ")} ${a}`,g),{mutationId:N()}};return{async deleteByIds(n){return n.length===0?{count:0,mutationId:N()}:(await $(),{count:(await c.query(`DELETE FROM "${e}" WHERE id = ANY($1::text[]) RETURNING id`,[[...n]])).length,mutationId:N()})},async describe(){await $();const[n]=await c.query(`SELECT count(*) AS count FROM "${e}"`);return{dimensions:o,vectorsCount:Number(n?.count??0)}},async getByIds(n){return n.length===0?[]:(await $(),(await c.query(`SELECT id, namespace, metadata, embedding::text AS embedding FROM "${e}" WHERE id = ANY($1::text[])`,[[...n]])).map(s=>({id:s.id,...s.metadata===null?{}:{metadata:s.metadata},...s.namespace===null?{}:{namespace:s.namespace},values:JSON.parse(s.embedding)})))},async insert(n){return w(n,"ON CONFLICT (id) DO NOTHING")},async query(n,a){const s=a?.topK??P;if(!Number.isInteger(s)||s<=0)throw new TypeError(`@lunora/hyperdrive: pgvector index "${m}" needs a positive integer \`topK\` — got ${String(s)}`);a?.filter!==void 0&&U(a.filter,m),await $();const g=a?.returnValues===!0,u=a?.returnMetadata??"none",h=u!=="none"&&u!==!1,i=[],f=d=>`$${String(i.push(d))}`,b=`embedding ${r} ${f(C(n))}::vector`,S=[];a?.namespace!==void 0&&S.push(`namespace = ${f(a.namespace)}`),a?.filter!==void 0&&Object.keys(a.filter).length>0&&S.push(`metadata @> ${f(JSON.stringify(a.filter))}::jsonb`);const I=["id","namespace",`${b} AS distance`];h&&I.push("metadata"),g&&I.push("embedding::text AS embedding");const M=S.length>0?`(SELECT * FROM "${e}" WHERE ${S.join(" AND ")})`:`"${e}"`,j=S.length>0?`WITH filtered AS MATERIALIZED ${M} SELECT ${I.join(", ")} FROM filtered ORDER BY ${b} LIMIT ${f(s)}`:`SELECT ${I.join(", ")} FROM "${e}" ORDER BY ${b} LIMIT ${f(s)}`,_=(await c.query(j,i)).map(d=>({id:d.id,...h&&d.metadata!==null&&d.metadata!==void 0?{metadata:d.metadata}:{},...d.namespace===null?{}:{namespace:d.namespace},score:E(Number(d.distance)),...g&&d.embedding!==void 0?{values:JSON.parse(d.embedding)}:{}}));return{count:_.length,matches:_}},async upsert(n){return w(n,"ON CONFLICT (id) DO UPDATE SET embedding = EXCLUDED.embedding, namespace = EXCLUDED.namespace, metadata = EXCLUDED.metadata")}}};export{W as createPgVectorIndex};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
import{sql as t}from"drizzle-orm";const r="__id__",n="__vector__",o=e=>t`${t.identifier(e)}.${t.identifier(n)}`,m=e=>t`to_tsvector('simple', ${e})`,c=e=>t`to_tsquery('simple', ${e.map((a,i)=>i===e.length-1?`${a}:*`:a).join(" & ")})`,T=/duplicate key value violates unique constraint/iu,u="utf8mb4_0900_bin",s=e=>`${e} COLLATE ${u}`,E=(e,a)=>{if(a?.unique===!0)switch(e){case"bigint":case"boolean":case"date":case"number":case"timestamp":break;case"bytes":return"VARBINARY(768)";default:return s("VARCHAR(768)")}switch(e){case"bigint":return s("VARCHAR(64)");case"boolean":return"TINYINT";case"bytes":return"LONGBLOB";case"date":case"number":case"timestamp":return"DOUBLE";default:return s("LONGTEXT")}},R=/TEXT|BLOB/u,I={companionTypes:{autoincrementPrimaryKey:"BIGSERIAL PRIMARY KEY",integer:"INTEGER",key:"TEXT",real:"DOUBLE PRECISION",text:"TEXT"},columnType:e=>{switch(e){case"boolean":return"INTEGER";case"bytes":return"BYTEA";case"date":case"number":case"timestamp":return"DOUBLE PRECISION";default:return"TEXT"}},frameworkColumns:()=>[{name:"id",type:"TEXT PRIMARY KEY"},{name:"_creationTime",type:"DOUBLE PRECISION NOT NULL"}],isUniqueViolation:e=>{const{code:a}=e;return a==="23505"||e instanceof Error&&T.test(e.message)},maxTableColumns:1600,name:"postgres",searchBackfillHint:"call backfillSqlSearchIndexes from @lunora/sql-store with the store's exec from a host-side admin path",supportsFts5:!1,nativeTextSearch:{createCompanion:(e,a)=>t`CREATE TABLE IF NOT EXISTS ${t.identifier(e)} (${t.identifier(r)} ${t.raw(a)} PRIMARY KEY, ${t.identifier(n)} tsvector)`,createIndexes:e=>[t`CREATE INDEX IF NOT EXISTS ${t.identifier(`${e}__gin`)} ON ${t.identifier(e)} USING GIN (${t.identifier(n)})`],indexDocument:(e,a,i,l)=>t`INSERT INTO ${t.identifier(e)} (${t.identifier(r)}, ${t.identifier(n)}) SELECT ${a}, ${m(i)} WHERE ${l} ON CONFLICT (${t.identifier(r)}) DO UPDATE SET ${t.identifier(n)} = EXCLUDED.${t.identifier(n)}`,matches:(e,a)=>t`${o(e)} @@ ${c(a)}`,rank:(e,a)=>t`ts_rank_cd(${o(e)}, ${c(a)})`},supportsReturning:!0,textPatternOperatorClass:"text_pattern_ops",tableExists:e=>t`SELECT table_name FROM information_schema.tables WHERE table_schema = ANY (current_schemas(false)) AND table_name = ${e}`},_={affectedRows:e=>e.rowsAffected,companionTypes:{autoincrementPrimaryKey:"BIGINT AUTO_INCREMENT PRIMARY KEY",integer:"INTEGER",key:s("VARCHAR(768)"),real:"DOUBLE",text:s("LONGTEXT")},columnType:E,frameworkColumns:()=>[{name:"id",type:`${s("VARCHAR(768)")} PRIMARY KEY`},{name:"_creationTime",type:"DOUBLE NOT NULL"}],indexKeyPrefix:e=>R.test(E(e))?191:void 0,isUniqueViolation:e=>{const a=e;return a.errno===1062||a.code==="ER_DUP_ENTRY"},maxTableColumns:4096,name:"mysql",searchBackfillHint:"call backfillSqlSearchIndexes from @lunora/sql-store with the store's exec from a host-side admin path",supportsFts5:!1,supportsReturning:!1,tableExists:e=>t`SELECT table_name FROM information_schema.tables WHERE table_schema = DATABASE() AND table_name = ${e}`};export{_ as mysqlDialect,I as postgresDialect};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
import{liftSourceId as a}from"@lunora/shard-engine";const n=(o,r={})=>a(o,r),w=async(o,r)=>{const{idColumn:t,map:c,params:s,query:e}=r;return(await o.query(e,s)).map(u=>n(u,{idColumn:t,map:c}))};export{n as projectSourceRow,w as pullSourceRows};
|
|
@@ -0,0 +1,150 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Public types for `@lunora/hyperdrive`.
|
|
3
|
+
*
|
|
4
|
+
* Hyperdrive points at a database **Lunora does not own**. Everything here is
|
|
5
|
+
* deliberately structural (no hard dependency on `@cloudflare/workers-types` or
|
|
6
|
+
* any SQL driver) so unit tests can pass plain-object doubles, exactly like the
|
|
7
|
+
* `D1DatabaseLike` projection in `@lunora/d1`.
|
|
8
|
+
*
|
|
9
|
+
* The hard constraint, restated wherever this surface is used: Hyperdrive
|
|
10
|
+
* queries are **non-deterministic** (forbidden in `query`/`mutation`, allowed
|
|
11
|
+
* only in `action`s — see the `hyperdrive_outside_action` advisor lint), and
|
|
12
|
+
* external writes are **invisible to Lunora live queries** — a subscription will
|
|
13
|
+
* NOT re-run when an external Postgres/MySQL row changes.
|
|
14
|
+
*/
|
|
15
|
+
/**
|
|
16
|
+
* Structural projection of the Cloudflare `Hyperdrive` binding (`env.HYPERDRIVE`).
|
|
17
|
+
*
|
|
18
|
+
* Mirrors the fields of the real `Hyperdrive` from `@cloudflare/workers-types`
|
|
19
|
+
* but stays structural so a unit test can pass a plain object. At runtime only
|
|
20
|
+
* `connectionString` is needed to construct a driver; the discrete connection
|
|
21
|
+
* parts are surfaced for drivers that prefer a config object over a DSN.
|
|
22
|
+
*/
|
|
23
|
+
interface HyperdriveLike {
|
|
24
|
+
/** A connection string Hyperdrive routes through its pooled, cached edge connection. */
|
|
25
|
+
connectionString: string;
|
|
26
|
+
/** Database name component of the connection. */
|
|
27
|
+
database: string;
|
|
28
|
+
/** Host Hyperdrive presents to the driver (the local proxy, not your origin DB). */
|
|
29
|
+
host: string;
|
|
30
|
+
/** Password component of the connection. */
|
|
31
|
+
password: string;
|
|
32
|
+
/** Port Hyperdrive presents to the driver. */
|
|
33
|
+
port: number;
|
|
34
|
+
/** User component of the connection. */
|
|
35
|
+
user: string;
|
|
36
|
+
}
|
|
37
|
+
/**
|
|
38
|
+
* The connection config surfaced by {@link import("./create-hyperdrive").createHyperdrive | createHyperdrive}: the raw
|
|
39
|
+
* `connectionString` plus the discrete parts, ready to hand to a driver.
|
|
40
|
+
*/
|
|
41
|
+
interface HyperdriveConnection {
|
|
42
|
+
/** Database name. */
|
|
43
|
+
database: string;
|
|
44
|
+
/** Host (Hyperdrive's local proxy). */
|
|
45
|
+
host: string;
|
|
46
|
+
/** Password. */
|
|
47
|
+
password: string;
|
|
48
|
+
/** Port. */
|
|
49
|
+
port: number;
|
|
50
|
+
/** User. */
|
|
51
|
+
user: string;
|
|
52
|
+
}
|
|
53
|
+
/**
|
|
54
|
+
* The driver-agnostic SQL surface bound to `ctx.sql` on **`ActionCtx` only**.
|
|
55
|
+
*
|
|
56
|
+
* This is the exact type the generated ctx imports as
|
|
57
|
+
* `import("@lunora/hyperdrive").SqlClient`. Keep the name and shape stable — the
|
|
58
|
+
* codegen ctx wiring (Phase 1) depends on it.
|
|
59
|
+
*
|
|
60
|
+
* It is intentionally minimal — a single parameterised `query` — so it maps onto
|
|
61
|
+
* `postgres` (postgres.js), `pg` (node-postgres) and `mysql2` alike via the
|
|
62
|
+
* {@link import("./create-hyperdrive").fromPostgresJs | fromPostgresJs} /
|
|
63
|
+
* {@link import("./create-hyperdrive").fromNodePg | fromNodePg} /
|
|
64
|
+
* {@link import("./create-hyperdrive").fromMysql2 | fromMysql2} adapters. Use
|
|
65
|
+
* positional placeholders that match your driver (`$1, $2` for Postgres, `?` for
|
|
66
|
+
* MySQL); the package does not rewrite SQL.
|
|
67
|
+
*
|
|
68
|
+
* Reminder (also on the emitted JSDoc): non-deterministic, action-only,
|
|
69
|
+
* non-reactive — writes here are not tracked by Lunora live queries.
|
|
70
|
+
*/
|
|
71
|
+
interface SqlClient {
|
|
72
|
+
/**
|
|
73
|
+
* Run a parameterised SQL statement and return the result rows.
|
|
74
|
+
*
|
|
75
|
+
* SECURITY: `text` is executed verbatim — the package never rewrites or
|
|
76
|
+
* escapes it. NEVER interpolate untrusted/user input into `text`; put every
|
|
77
|
+
* value in `params` and reference it with a positional placeholder (`$1`/`?`).
|
|
78
|
+
* Building `text` by string-concatenating request data is a SQL-injection
|
|
79
|
+
* sink against your own Postgres/MySQL. Identifiers (table/column names) can't
|
|
80
|
+
* be parameterised — allowlist them against a fixed set, don't interpolate.
|
|
81
|
+
* @param text SQL text with driver-native positional placeholders.
|
|
82
|
+
* @param params Bound parameter values, positionally matched to `text`.
|
|
83
|
+
* @returns The rows the statement produced (empty for non-`SELECT`s that
|
|
84
|
+
* return no rows).
|
|
85
|
+
*/
|
|
86
|
+
query: <Row = Record<string, unknown>>(text: string, params?: ReadonlyArray<unknown>) => Promise<Row[]>;
|
|
87
|
+
}
|
|
88
|
+
/**
|
|
89
|
+
* Structural projection of a `pg` (node-postgres) `Client`/`Pool`. Only the
|
|
90
|
+
* `query` method `fromNodePg` calls is required, kept structural for testing.
|
|
91
|
+
*
|
|
92
|
+
* Method syntax, not an arrow property — see {@link PostgresJsLike}.
|
|
93
|
+
*/
|
|
94
|
+
interface NodePgLike {
|
|
95
|
+
query(this: void, text: string, params?: ReadonlyArray<unknown>): Promise<{
|
|
96
|
+
rows: unknown[];
|
|
97
|
+
}>;
|
|
98
|
+
}
|
|
99
|
+
/**
|
|
100
|
+
* Structural projection of a `postgres` (postgres.js) tagged-template client.
|
|
101
|
+
* The adapter uses the `.unsafe(text, params)` escape hatch so callers keep
|
|
102
|
+
* full control of the parameter list.
|
|
103
|
+
*
|
|
104
|
+
* **`unsafe` is declared with METHOD syntax, and that is load-bearing.** Under
|
|
105
|
+
* `strictFunctionTypes` an arrow PROPERTY is checked contravariantly in its
|
|
106
|
+
* parameters, so a driver whose `unsafe` takes a MUTABLE array — which real
|
|
107
|
+
* postgres.js does (`parameters?: ParameterOrJSON<never>[]`) — is not assignable
|
|
108
|
+
* to one declared `params?: ReadonlyArray<unknown>`. As an arrow property this
|
|
109
|
+
* projection could therefore never accept the package it projects: every
|
|
110
|
+
* consumer got
|
|
111
|
+
* `TS2345: Argument of type 'Sql<{}>' is not assignable to parameter of type
|
|
112
|
+
* 'PostgresJsLike'`, and this repo's own test reached for
|
|
113
|
+
* `as unknown as PostgresJsLike` to get past it. Method syntax is checked
|
|
114
|
+
* bivariantly, which is what a structural projection of someone else's type
|
|
115
|
+
* needs — `readonly unknown[]` and postgres.js's mutable array relate in one
|
|
116
|
+
* direction, which is all bivariance asks for.
|
|
117
|
+
*/
|
|
118
|
+
interface PostgresJsLike {
|
|
119
|
+
unsafe(this: void, text: string, params?: ReadonlyArray<unknown>): Promise<unknown>;
|
|
120
|
+
}
|
|
121
|
+
/**
|
|
122
|
+
* Structural projection of a `mysql2/promise` connection/pool. `mysql2`'s
|
|
123
|
+
* `execute` resolves to a `[rows, fields]` tuple; the adapter takes the first
|
|
124
|
+
* element as the rows.
|
|
125
|
+
*
|
|
126
|
+
* Method syntax, not an arrow property — see {@link PostgresJsLike} — but here
|
|
127
|
+
* that is necessary and NOT sufficient, which is why `params` is `unknown`.
|
|
128
|
+
*
|
|
129
|
+
* mysql2 types its second argument as a single `ExecuteValues`: a union of
|
|
130
|
+
* scalars, `ExecuteValues[]` and `{ [key: string]: ExecuteValues }`. Declared
|
|
131
|
+
* `params?: ReadonlyArray<unknown>` this projection could never accept the
|
|
132
|
+
* driver it projects — bivariance needs the two parameter types to relate in
|
|
133
|
+
* ONE direction and they relate in neither (`readonly unknown[] | undefined` is
|
|
134
|
+
* not an `ExecuteValues`, and a `string` is not an array).
|
|
135
|
+
*
|
|
136
|
+
* `unknown` is the narrowest supertype of `ExecuteValues` that does not restate
|
|
137
|
+
* mysql2's union here. Restating it would be the vacuous shim all over again —
|
|
138
|
+
* a local copy that drifts from the package it mirrors and makes the gate pass
|
|
139
|
+
* while a consumer fails.
|
|
140
|
+
*
|
|
141
|
+
* The looseness is confined to the INPUT position: this types the driver a
|
|
142
|
+
* caller hands to `fromMysql2`, not what anyone passes to
|
|
143
|
+
* {@link SqlClient.query}, which still declares `ReadonlyArray<unknown>`. Every
|
|
144
|
+
* call site in this package forwards an array, and the driver validates the
|
|
145
|
+
* values at runtime regardless.
|
|
146
|
+
*/
|
|
147
|
+
interface Mysql2Like {
|
|
148
|
+
execute(this: void, text: string, params?: unknown): Promise<[unknown, unknown]>;
|
|
149
|
+
}
|
|
150
|
+
export { HyperdriveLike as H, Mysql2Like as M, NodePgLike as N, PostgresJsLike as P, SqlClient as S, HyperdriveConnection as a };
|