@lunora/hyperdrive 1.0.0-alpha.4 → 1.0.0-alpha.41
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/__assets__/package-og.svg +1 -1
- package/dist/global.d.mts +45 -44
- package/dist/global.d.ts +45 -44
- package/dist/global.mjs +1 -9
- package/dist/index.d.mts +89 -154
- package/dist/index.d.ts +89 -154
- package/dist/index.mjs +1 -1
- package/dist/packem_shared/buildMysqlExec-uTTy5Tv3.mjs +1 -0
- package/dist/packem_shared/createHyperdrive-DCe1WINF.mjs +1 -0
- package/dist/packem_shared/mysqlDialect-Cgs6NC98.mjs +1 -0
- package/dist/packem_shared/projectSourceRow-BjF0PLdx.mjs +1 -0
- package/dist/packem_shared/types.d-DE1NYxyA.d.mts +113 -0
- package/dist/packem_shared/types.d-DE1NYxyA.d.ts +113 -0
- package/package.json +5 -4
- 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/global.d.mts
CHANGED
|
@@ -1,46 +1,51 @@
|
|
|
1
1
|
import { DatabaseWriterLike } from '@lunora/do';
|
|
2
2
|
import { SqlExec, SqlDialect, SqlCtxDbOptions } from '@lunora/sql-store';
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
}
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
3
|
+
import { M as Mysql2Like, S as SqlClient } from "./packem_shared/types.d-DE1NYxyA.mjs";
|
|
4
|
+
/**
|
|
5
|
+
* Minimal row-returning client (e.g. `@lunora/hyperdrive`'s `fromPostgresJs`/`fromNodePg`
|
|
6
|
+
* result). Aliases {@link SqlClient} — the exec-facing name is kept so call sites read
|
|
7
|
+
* intent, but the shape is the single source of truth in `./types` (no drift).
|
|
8
|
+
*/
|
|
9
|
+
type RowClient = SqlClient;
|
|
10
|
+
/**
|
|
11
|
+
* Minimal `mysql2/promise` connection/pool surface — `execute` resolves to
|
|
12
|
+
* `[rows | ResultSetHeader, fields]`. Aliases {@link Mysql2Like} so the /global entry's
|
|
13
|
+
* driver surface can never drift from the main entry's.
|
|
14
|
+
*/
|
|
15
|
+
type Mysql2Execute = Mysql2Like;
|
|
11
16
|
/**
|
|
12
|
-
* Wrap a Postgres row-client (from `@lunora/hyperdrive`'s `fromPostgresJs` /
|
|
13
|
-
* `fromNodePg`) as a {@link SqlExec}. The core already renders `$N` placeholders
|
|
14
|
-
* for Postgres, so `all`/`run` forward verbatim. Postgres uses `RETURNING` for
|
|
15
|
-
* OCC (read via `all`), so `run` reports no affected-row count.
|
|
16
|
-
*/
|
|
17
|
+
* Wrap a Postgres row-client (from `@lunora/hyperdrive`'s `fromPostgresJs` /
|
|
18
|
+
* `fromNodePg`) as a {@link SqlExec}. The core already renders `$N` placeholders
|
|
19
|
+
* for Postgres, so `all`/`run` forward verbatim. Postgres uses `RETURNING` for
|
|
20
|
+
* OCC (read via `all`), so `run` reports no affected-row count.
|
|
21
|
+
*/
|
|
17
22
|
declare const buildPgExec: (client: RowClient) => SqlExec;
|
|
18
23
|
/**
|
|
19
|
-
* Wrap a `mysql2/promise` connection/pool as a {@link SqlExec}. The core already
|
|
20
|
-
* renders backtick identifiers and `?` placeholders for MySQL, so `all`/`run`
|
|
21
|
-
* forward verbatim. MySQL has no `RETURNING`, so `run` surfaces `affectedRows`
|
|
22
|
-
* for the store's affected-rows OCC guard.
|
|
23
|
-
*
|
|
24
|
-
* **The connection MUST be created with the `CLIENT_FOUND_ROWS` flag**
|
|
25
|
-
* (mysql2: `createPool({ flags: ["FOUND_ROWS"] })`). Without it, `affectedRows`
|
|
26
|
-
* counts *changed* rows, so an idempotent `patch`/`replace` that re-writes the
|
|
27
|
-
* same values reports 0 and the OCC guard raises a spurious conflict.
|
|
28
|
-
*/
|
|
24
|
+
* Wrap a `mysql2/promise` connection/pool as a {@link SqlExec}. The core already
|
|
25
|
+
* renders backtick identifiers and `?` placeholders for MySQL, so `all`/`run`
|
|
26
|
+
* forward verbatim. MySQL has no `RETURNING`, so `run` surfaces `affectedRows`
|
|
27
|
+
* for the store's affected-rows OCC guard.
|
|
28
|
+
*
|
|
29
|
+
* **The connection MUST be created with the `CLIENT_FOUND_ROWS` flag**
|
|
30
|
+
* (mysql2: `createPool({ flags: ["FOUND_ROWS"] })`). Without it, `affectedRows`
|
|
31
|
+
* counts *changed* rows, so an idempotent `patch`/`replace` that re-writes the
|
|
32
|
+
* same values reports 0 and the OCC guard raises a spurious conflict.
|
|
33
|
+
*/
|
|
29
34
|
declare const buildMysqlExec: (connection: Mysql2Execute) => SqlExec;
|
|
30
35
|
/**
|
|
31
|
-
* **Postgres** dialect. Differs from SQLite only in column types
|
|
32
|
-
* (`DOUBLE PRECISION`/`BYTEA`/`BIGSERIAL`), the `information_schema` catalog
|
|
33
|
-
* probe, and unique-violation detection (SQLSTATE `23505`).
|
|
34
|
-
*/
|
|
36
|
+
* **Postgres** dialect. Differs from SQLite only in column types
|
|
37
|
+
* (`DOUBLE PRECISION`/`BYTEA`/`BIGSERIAL`), the `information_schema` catalog
|
|
38
|
+
* probe, and unique-violation detection (SQLSTATE `23505`).
|
|
39
|
+
*/
|
|
35
40
|
declare const postgresDialect: SqlDialect;
|
|
36
41
|
/**
|
|
37
|
-
* **MySQL** dialect. Diverges in: **no `RETURNING`** (the store's OCC falls back
|
|
38
|
-
* to affected-rows — which requires the connection's `CLIENT_FOUND_ROWS` flag so
|
|
39
|
-
* a no-op update still reports a matched row, see `buildMysqlExec`); bounded
|
|
40
|
-
* `VARCHAR` keys (TEXT can't be a primary key / unindexed); a TEXT/BLOB index key
|
|
41
|
-
* prefix; and `ER_DUP_ENTRY` (errno 1062) unique violations. (Drizzle's MySQL
|
|
42
|
-
* dialect supplies the backtick identifiers + `ON DUPLICATE KEY` upserts.)
|
|
43
|
-
*/
|
|
42
|
+
* **MySQL** dialect. Diverges in: **no `RETURNING`** (the store's OCC falls back
|
|
43
|
+
* to affected-rows — which requires the connection's `CLIENT_FOUND_ROWS` flag so
|
|
44
|
+
* a no-op update still reports a matched row, see `buildMysqlExec`); bounded
|
|
45
|
+
* `VARCHAR` keys (TEXT can't be a primary key / unindexed); a TEXT/BLOB index key
|
|
46
|
+
* prefix; and `ER_DUP_ENTRY` (errno 1062) unique violations. (Drizzle's MySQL
|
|
47
|
+
* dialect supplies the backtick identifiers + `ON DUPLICATE KEY` upserts.)
|
|
48
|
+
*/
|
|
44
49
|
declare const mysqlDialect: SqlDialect;
|
|
45
50
|
/** Which engine a Hyperdrive-backed `.global()` store targets. */
|
|
46
51
|
type HyperdriveEngine = "mysql" | "postgres";
|
|
@@ -52,16 +57,12 @@ interface CreateHyperdriveGlobalCtxDbOptions extends Omit<SqlCtxDbOptions, "dial
|
|
|
52
57
|
exec: SqlExec;
|
|
53
58
|
}
|
|
54
59
|
/**
|
|
55
|
-
* Build a reactive `.global()` writer backed by a Hyperdrive-reachable
|
|
56
|
-
* Postgres/MySQL database. Pass a built {@link SqlExec} (via {@link buildPgExec}/
|
|
57
|
-
* {@link buildMysqlExec}) and the matching `engine`; everything else mirrors the
|
|
58
|
-
* D1 store options.
|
|
59
|
-
*/
|
|
60
|
-
declare const createHyperdriveGlobalCtxDb: ({
|
|
61
|
-
engine,
|
|
62
|
-
exec,
|
|
63
|
-
...rest
|
|
64
|
-
}: CreateHyperdriveGlobalCtxDbOptions) => DatabaseWriterLike;
|
|
60
|
+
* Build a reactive `.global()` writer backed by a Hyperdrive-reachable
|
|
61
|
+
* Postgres/MySQL database. Pass a built {@link SqlExec} (via {@link buildPgExec}/
|
|
62
|
+
* {@link buildMysqlExec}) and the matching `engine`; everything else mirrors the
|
|
63
|
+
* D1 store options.
|
|
64
|
+
*/
|
|
65
|
+
declare const createHyperdriveGlobalCtxDb: ({ engine, exec, ...rest }: CreateHyperdriveGlobalCtxDbOptions) => DatabaseWriterLike;
|
|
65
66
|
/** Convenience: a **Postgres** `.global()` writer from a row-client (postgres.js/pg over Hyperdrive). */
|
|
66
67
|
declare const createPostgresGlobalCtxDb: (client: RowClient, options: Omit<CreateHyperdriveGlobalCtxDbOptions, "engine" | "exec">) => DatabaseWriterLike;
|
|
67
68
|
/** Convenience: a **MySQL** `.global()` writer from a `mysql2/promise` connection/pool (created with `flags: ["FOUND_ROWS"]`). */
|
package/dist/global.d.ts
CHANGED
|
@@ -1,46 +1,51 @@
|
|
|
1
1
|
import { DatabaseWriterLike } from '@lunora/do';
|
|
2
2
|
import { SqlExec, SqlDialect, SqlCtxDbOptions } from '@lunora/sql-store';
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
}
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
3
|
+
import { M as Mysql2Like, S as SqlClient } from "./packem_shared/types.d-DE1NYxyA.js";
|
|
4
|
+
/**
|
|
5
|
+
* Minimal row-returning client (e.g. `@lunora/hyperdrive`'s `fromPostgresJs`/`fromNodePg`
|
|
6
|
+
* result). Aliases {@link SqlClient} — the exec-facing name is kept so call sites read
|
|
7
|
+
* intent, but the shape is the single source of truth in `./types` (no drift).
|
|
8
|
+
*/
|
|
9
|
+
type RowClient = SqlClient;
|
|
10
|
+
/**
|
|
11
|
+
* Minimal `mysql2/promise` connection/pool surface — `execute` resolves to
|
|
12
|
+
* `[rows | ResultSetHeader, fields]`. Aliases {@link Mysql2Like} so the /global entry's
|
|
13
|
+
* driver surface can never drift from the main entry's.
|
|
14
|
+
*/
|
|
15
|
+
type Mysql2Execute = Mysql2Like;
|
|
11
16
|
/**
|
|
12
|
-
* Wrap a Postgres row-client (from `@lunora/hyperdrive`'s `fromPostgresJs` /
|
|
13
|
-
* `fromNodePg`) as a {@link SqlExec}. The core already renders `$N` placeholders
|
|
14
|
-
* for Postgres, so `all`/`run` forward verbatim. Postgres uses `RETURNING` for
|
|
15
|
-
* OCC (read via `all`), so `run` reports no affected-row count.
|
|
16
|
-
*/
|
|
17
|
+
* Wrap a Postgres row-client (from `@lunora/hyperdrive`'s `fromPostgresJs` /
|
|
18
|
+
* `fromNodePg`) as a {@link SqlExec}. The core already renders `$N` placeholders
|
|
19
|
+
* for Postgres, so `all`/`run` forward verbatim. Postgres uses `RETURNING` for
|
|
20
|
+
* OCC (read via `all`), so `run` reports no affected-row count.
|
|
21
|
+
*/
|
|
17
22
|
declare const buildPgExec: (client: RowClient) => SqlExec;
|
|
18
23
|
/**
|
|
19
|
-
* Wrap a `mysql2/promise` connection/pool as a {@link SqlExec}. The core already
|
|
20
|
-
* renders backtick identifiers and `?` placeholders for MySQL, so `all`/`run`
|
|
21
|
-
* forward verbatim. MySQL has no `RETURNING`, so `run` surfaces `affectedRows`
|
|
22
|
-
* for the store's affected-rows OCC guard.
|
|
23
|
-
*
|
|
24
|
-
* **The connection MUST be created with the `CLIENT_FOUND_ROWS` flag**
|
|
25
|
-
* (mysql2: `createPool({ flags: ["FOUND_ROWS"] })`). Without it, `affectedRows`
|
|
26
|
-
* counts *changed* rows, so an idempotent `patch`/`replace` that re-writes the
|
|
27
|
-
* same values reports 0 and the OCC guard raises a spurious conflict.
|
|
28
|
-
*/
|
|
24
|
+
* Wrap a `mysql2/promise` connection/pool as a {@link SqlExec}. The core already
|
|
25
|
+
* renders backtick identifiers and `?` placeholders for MySQL, so `all`/`run`
|
|
26
|
+
* forward verbatim. MySQL has no `RETURNING`, so `run` surfaces `affectedRows`
|
|
27
|
+
* for the store's affected-rows OCC guard.
|
|
28
|
+
*
|
|
29
|
+
* **The connection MUST be created with the `CLIENT_FOUND_ROWS` flag**
|
|
30
|
+
* (mysql2: `createPool({ flags: ["FOUND_ROWS"] })`). Without it, `affectedRows`
|
|
31
|
+
* counts *changed* rows, so an idempotent `patch`/`replace` that re-writes the
|
|
32
|
+
* same values reports 0 and the OCC guard raises a spurious conflict.
|
|
33
|
+
*/
|
|
29
34
|
declare const buildMysqlExec: (connection: Mysql2Execute) => SqlExec;
|
|
30
35
|
/**
|
|
31
|
-
* **Postgres** dialect. Differs from SQLite only in column types
|
|
32
|
-
* (`DOUBLE PRECISION`/`BYTEA`/`BIGSERIAL`), the `information_schema` catalog
|
|
33
|
-
* probe, and unique-violation detection (SQLSTATE `23505`).
|
|
34
|
-
*/
|
|
36
|
+
* **Postgres** dialect. Differs from SQLite only in column types
|
|
37
|
+
* (`DOUBLE PRECISION`/`BYTEA`/`BIGSERIAL`), the `information_schema` catalog
|
|
38
|
+
* probe, and unique-violation detection (SQLSTATE `23505`).
|
|
39
|
+
*/
|
|
35
40
|
declare const postgresDialect: SqlDialect;
|
|
36
41
|
/**
|
|
37
|
-
* **MySQL** dialect. Diverges in: **no `RETURNING`** (the store's OCC falls back
|
|
38
|
-
* to affected-rows — which requires the connection's `CLIENT_FOUND_ROWS` flag so
|
|
39
|
-
* a no-op update still reports a matched row, see `buildMysqlExec`); bounded
|
|
40
|
-
* `VARCHAR` keys (TEXT can't be a primary key / unindexed); a TEXT/BLOB index key
|
|
41
|
-
* prefix; and `ER_DUP_ENTRY` (errno 1062) unique violations. (Drizzle's MySQL
|
|
42
|
-
* dialect supplies the backtick identifiers + `ON DUPLICATE KEY` upserts.)
|
|
43
|
-
*/
|
|
42
|
+
* **MySQL** dialect. Diverges in: **no `RETURNING`** (the store's OCC falls back
|
|
43
|
+
* to affected-rows — which requires the connection's `CLIENT_FOUND_ROWS` flag so
|
|
44
|
+
* a no-op update still reports a matched row, see `buildMysqlExec`); bounded
|
|
45
|
+
* `VARCHAR` keys (TEXT can't be a primary key / unindexed); a TEXT/BLOB index key
|
|
46
|
+
* prefix; and `ER_DUP_ENTRY` (errno 1062) unique violations. (Drizzle's MySQL
|
|
47
|
+
* dialect supplies the backtick identifiers + `ON DUPLICATE KEY` upserts.)
|
|
48
|
+
*/
|
|
44
49
|
declare const mysqlDialect: SqlDialect;
|
|
45
50
|
/** Which engine a Hyperdrive-backed `.global()` store targets. */
|
|
46
51
|
type HyperdriveEngine = "mysql" | "postgres";
|
|
@@ -52,16 +57,12 @@ interface CreateHyperdriveGlobalCtxDbOptions extends Omit<SqlCtxDbOptions, "dial
|
|
|
52
57
|
exec: SqlExec;
|
|
53
58
|
}
|
|
54
59
|
/**
|
|
55
|
-
* Build a reactive `.global()` writer backed by a Hyperdrive-reachable
|
|
56
|
-
* Postgres/MySQL database. Pass a built {@link SqlExec} (via {@link buildPgExec}/
|
|
57
|
-
* {@link buildMysqlExec}) and the matching `engine`; everything else mirrors the
|
|
58
|
-
* D1 store options.
|
|
59
|
-
*/
|
|
60
|
-
declare const createHyperdriveGlobalCtxDb: ({
|
|
61
|
-
engine,
|
|
62
|
-
exec,
|
|
63
|
-
...rest
|
|
64
|
-
}: CreateHyperdriveGlobalCtxDbOptions) => DatabaseWriterLike;
|
|
60
|
+
* Build a reactive `.global()` writer backed by a Hyperdrive-reachable
|
|
61
|
+
* Postgres/MySQL database. Pass a built {@link SqlExec} (via {@link buildPgExec}/
|
|
62
|
+
* {@link buildMysqlExec}) and the matching `engine`; everything else mirrors the
|
|
63
|
+
* D1 store options.
|
|
64
|
+
*/
|
|
65
|
+
declare const createHyperdriveGlobalCtxDb: ({ engine, exec, ...rest }: CreateHyperdriveGlobalCtxDbOptions) => DatabaseWriterLike;
|
|
65
66
|
/** Convenience: a **Postgres** `.global()` writer from a row-client (postgres.js/pg over Hyperdrive). */
|
|
66
67
|
declare const createPostgresGlobalCtxDb: (client: RowClient, options: Omit<CreateHyperdriveGlobalCtxDbOptions, "engine" | "exec">) => DatabaseWriterLike;
|
|
67
68
|
/** Convenience: a **MySQL** `.global()` writer from a `mysql2/promise` connection/pool (created with `flags: ["FOUND_ROWS"]`). */
|
package/dist/global.mjs
CHANGED
|
@@ -1,9 +1 @@
|
|
|
1
|
-
import
|
|
2
|
-
import { postgresDialect, mysqlDialect } from './packem_shared/mysqlDialect-oNhZ58s8.mjs';
|
|
3
|
-
import { buildMysqlExec, buildPgExec } from './packem_shared/buildMysqlExec-DBbCjyq3.mjs';
|
|
4
|
-
|
|
5
|
-
const createHyperdriveGlobalCtxDb = ({ engine, exec, ...rest }) => createSqlCtxDb({ ...rest, dialect: engine === "postgres" ? postgresDialect : mysqlDialect, exec });
|
|
6
|
-
const createPostgresGlobalCtxDb = (client, options) => createHyperdriveGlobalCtxDb({ ...options, engine: "postgres", exec: buildPgExec(client) });
|
|
7
|
-
const createMysqlGlobalCtxDb = (connection, options) => createHyperdriveGlobalCtxDb({ ...options, engine: "mysql", exec: buildMysqlExec(connection) });
|
|
8
|
-
|
|
9
|
-
export { buildMysqlExec, buildPgExec, createHyperdriveGlobalCtxDb, createMysqlGlobalCtxDb, createPostgresGlobalCtxDb, mysqlDialect, postgresDialect };
|
|
1
|
+
import{createSqlCtxDb as o}from"@lunora/sql-store";import{postgresDialect as c,mysqlDialect as s}from"./packem_shared/mysqlDialect-Cgs6NC98.mjs";import{buildMysqlExec as i,buildPgExec as x}from"./packem_shared/buildMysqlExec-uTTy5Tv3.mjs";const r=({engine:e,exec:t,...l})=>o({...l,dialect:e==="postgres"?c:s,exec:t}),m=(e,t)=>r({...t,engine:"postgres",exec:x(e)}),p=(e,t)=>r({...t,engine:"mysql",exec:i(e)});export{i as buildMysqlExec,x as buildPgExec,r as createHyperdriveGlobalCtxDb,p as createMysqlGlobalCtxDb,m as createPostgresGlobalCtxDb,s as mysqlDialect,c as postgresDialect};
|
package/dist/index.d.mts
CHANGED
|
@@ -1,165 +1,100 @@
|
|
|
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-DE1NYxyA.mjs";
|
|
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
|
-
/** 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
|
-
* @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
|
+
* // inside an action (never a query/mutation):
|
|
18
|
+
* const { connectionString } = createHyperdrive(env.HYPERDRIVE);
|
|
19
|
+
* ctx.sql = fromPostgresJs(postgres(connectionString));
|
|
20
|
+
* const rows = await ctx.sql.query("select id from users where org = $1", [orgId]);
|
|
21
|
+
* ```
|
|
22
|
+
* @remarks
|
|
23
|
+
* Hyperdrive talks to an **external** database Lunora has no visibility into.
|
|
24
|
+
* Queries through `ctx.sql` are non-deterministic (action-only — enforced by the
|
|
25
|
+
* `hyperdrive_outside_action` advisor lint) and external writes are NOT tracked
|
|
26
|
+
* by Lunora live queries: subscriptions will not re-run when external rows
|
|
27
|
+
* change. Use Hyperdrive to *integrate* an existing DB from an action; if you
|
|
28
|
+
* want that data to be reactive, write a projection of it into a `defineSchema`
|
|
29
|
+
* DO/D1 table.
|
|
30
|
+
* @param binding The `env.HYPERDRIVE` binding (or a structural double).
|
|
31
|
+
* @returns The raw `connectionString` plus the discrete connection parts.
|
|
32
|
+
*/
|
|
137
33
|
declare const createHyperdrive: (binding: HyperdriveLike) => {
|
|
138
34
|
config: HyperdriveConnection;
|
|
139
35
|
connectionString: string;
|
|
140
36
|
};
|
|
141
37
|
/**
|
|
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
|
-
*/
|
|
38
|
+
* Wrap a `postgres` (postgres.js) client as a {@link SqlClient}.
|
|
39
|
+
*
|
|
40
|
+
* Uses the driver's `.unsafe(text, params)` escape hatch so the caller supplies
|
|
41
|
+
* a plain SQL string with `$1, $2, …` placeholders and a positional params
|
|
42
|
+
* array. postgres.js's `.unsafe` resolves to a row array.
|
|
43
|
+
*/
|
|
148
44
|
declare const fromPostgresJs: (client: PostgresJsLike) => SqlClient;
|
|
149
45
|
/**
|
|
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
|
-
*/
|
|
46
|
+
* Wrap a `pg` (node-postgres) `Client` or `Pool` as a {@link SqlClient}.
|
|
47
|
+
*
|
|
48
|
+
* node-postgres returns a result object whose `rows` field holds the row array.
|
|
49
|
+
*/
|
|
154
50
|
declare const fromNodePg: (client: NodePgLike) => SqlClient;
|
|
155
51
|
/**
|
|
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
|
-
*/
|
|
52
|
+
* Wrap a `mysql2/promise` connection or pool as a {@link SqlClient}.
|
|
53
|
+
*
|
|
54
|
+
* Use `?` placeholders (MySQL positional syntax). `mysql2`'s `execute` resolves
|
|
55
|
+
* to a `[rows, fields]` tuple; the adapter returns the first element. For a
|
|
56
|
+
* non-`SELECT` (DML), `mysql2` yields a `ResultSetHeader` object rather than a
|
|
57
|
+
* row array, so the adapter normalises that to `[]` — matching the empty-array
|
|
58
|
+
* contract the postgres.js / node-postgres adapters already honour.
|
|
59
|
+
*/
|
|
164
60
|
declare const fromMysql2: (connection: Mysql2Like) => SqlClient;
|
|
165
|
-
|
|
61
|
+
/** How an external row maps to a Lunora document. */
|
|
62
|
+
interface ProjectOptions {
|
|
63
|
+
/**
|
|
64
|
+
* Column whose value becomes the Lunora `_id` (stringified). Defaults to `"id"`.
|
|
65
|
+
* With no `map`, this column is dropped from the document body (it lives on as
|
|
66
|
+
* `_id`); with a `map`, the mapper owns the body and `_id` is added from here.
|
|
67
|
+
*/
|
|
68
|
+
idColumn?: string;
|
|
69
|
+
/**
|
|
70
|
+
* Transform an external row into the stored document body. Omit for the default:
|
|
71
|
+
* every selected column except `idColumn` is copied verbatim. The returned object
|
|
72
|
+
* must not include `_id` — it is set from `idColumn`.
|
|
73
|
+
*/
|
|
74
|
+
map?: (row: Record<string, unknown>) => Record<string, unknown>;
|
|
75
|
+
}
|
|
76
|
+
/** Options for {@link pullSourceRows}: the parameterised tenant query plus the row projection. */
|
|
77
|
+
interface PullSourceOptions extends ProjectOptions {
|
|
78
|
+
/** Bound parameter values, positionally matched to `query` (the tenant scope binds here). */
|
|
79
|
+
params?: ReadonlyArray<unknown>;
|
|
80
|
+
/** The full tenant-membership query with driver-native placeholders (`$1` / `?`). */
|
|
81
|
+
query: string;
|
|
82
|
+
}
|
|
83
|
+
/**
|
|
84
|
+
* Project one external row to a Lunora document: lift `idColumn` to a stringified
|
|
85
|
+
* `_id`, then either apply `map` or copy every other column verbatim. Throws when
|
|
86
|
+
* the id column is missing/nullish so a misconfigured query fails loudly rather than
|
|
87
|
+
* materializing rows under an `"undefined"` id.
|
|
88
|
+
*
|
|
89
|
+
* Delegates to `@lunora/do`'s `liftSourceId` — the single id-lift the declarative
|
|
90
|
+
* `.source()` poll loop also uses — so the manual bridge and the codegen path can
|
|
91
|
+
* never diverge in their missing-id handling.
|
|
92
|
+
*/
|
|
93
|
+
declare const projectSourceRow: (row: Record<string, unknown>, options?: ProjectOptions) => Record<string, unknown>;
|
|
94
|
+
/**
|
|
95
|
+
* Run a parameterised tenant query against Hyperdrive and project every row to a
|
|
96
|
+
* Lunora document ready to hand to `materializeExternalRows`. Call this inside an
|
|
97
|
+
* **action** (where `ctx.sql` lives); pass the result to a mutation for the write.
|
|
98
|
+
*/
|
|
99
|
+
declare const pullSourceRows: (sql: SqlClient, options: PullSourceOptions) => Promise<Record<string, unknown>[]>;
|
|
100
|
+
export { type HyperdriveConnection, type HyperdriveLike, type Mysql2Like, type NodePgLike, type PostgresJsLike, type ProjectOptions, type PullSourceOptions, type SqlClient, createHyperdrive, fromMysql2, fromNodePg, fromPostgresJs, projectSourceRow, pullSourceRows };
|