@lunora/hyperdrive 1.0.0-alpha.3 → 1.0.0-alpha.30
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 +13 -8
- package/dist/global.d.ts +13 -8
- package/dist/global.mjs +2 -2
- package/dist/index.d.mts +41 -106
- package/dist/index.d.ts +41 -106
- package/dist/index.mjs +1 -0
- package/dist/packem_shared/{postgresDialect-oNhZ58s8.mjs → mysqlDialect-BHz03Grz.mjs} +13 -3
- package/dist/packem_shared/projectSourceRow-DtKuMRIm.mjs +10 -0
- package/dist/packem_shared/types.d-C6SU6Aw3.d.mts +113 -0
- package/dist/packem_shared/types.d-C6SU6Aw3.d.ts +113 -0
- package/package.json +5 -4
- /package/dist/packem_shared/{buildPgExec-DBbCjyq3.mjs → buildMysqlExec-DBbCjyq3.mjs} +0 -0
package/dist/global.d.mts
CHANGED
|
@@ -1,13 +1,18 @@
|
|
|
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-C6SU6Aw3.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
17
|
* Wrap a Postgres row-client (from `@lunora/hyperdrive`'s `fromPostgresJs` /
|
|
13
18
|
* `fromNodePg`) as a {@link SqlExec}. The core already renders `$N` placeholders
|
package/dist/global.d.ts
CHANGED
|
@@ -1,13 +1,18 @@
|
|
|
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-C6SU6Aw3.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
17
|
* Wrap a Postgres row-client (from `@lunora/hyperdrive`'s `fromPostgresJs` /
|
|
13
18
|
* `fromNodePg`) as a {@link SqlExec}. The core already renders `$N` placeholders
|
package/dist/global.mjs
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { createSqlCtxDb } from '@lunora/sql-store';
|
|
2
|
-
import { postgresDialect, mysqlDialect } from './packem_shared/
|
|
3
|
-
import { buildMysqlExec, buildPgExec } from './packem_shared/
|
|
2
|
+
import { postgresDialect, mysqlDialect } from './packem_shared/mysqlDialect-BHz03Grz.mjs';
|
|
3
|
+
import { buildMysqlExec, buildPgExec } from './packem_shared/buildMysqlExec-DBbCjyq3.mjs';
|
|
4
4
|
|
|
5
5
|
const createHyperdriveGlobalCtxDb = ({ engine, exec, ...rest }) => createSqlCtxDb({ ...rest, dialect: engine === "postgres" ? postgresDialect : mysqlDialect, exec });
|
|
6
6
|
const createPostgresGlobalCtxDb = (client, options) => createHyperdriveGlobalCtxDb({ ...options, engine: "postgres", exec: buildPgExec(client) });
|
package/dist/index.d.mts
CHANGED
|
@@ -1,108 +1,4 @@
|
|
|
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
|
-
* @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
|
-
}
|
|
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-C6SU6Aw3.mjs";
|
|
106
2
|
/**
|
|
107
3
|
* Surface a Cloudflare Hyperdrive binding as a connection ready to feed a
|
|
108
4
|
* user-supplied SQL driver.
|
|
@@ -162,4 +58,43 @@ declare const fromNodePg: (client: NodePgLike) => SqlClient;
|
|
|
162
58
|
* contract the postgres.js / node-postgres adapters already honour.
|
|
163
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 };
|
package/dist/index.d.ts
CHANGED
|
@@ -1,108 +1,4 @@
|
|
|
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
|
-
* @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
|
-
}
|
|
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-C6SU6Aw3.js";
|
|
106
2
|
/**
|
|
107
3
|
* Surface a Cloudflare Hyperdrive binding as a connection ready to feed a
|
|
108
4
|
* user-supplied SQL driver.
|
|
@@ -162,4 +58,43 @@ declare const fromNodePg: (client: NodePgLike) => SqlClient;
|
|
|
162
58
|
* contract the postgres.js / node-postgres adapters already honour.
|
|
163
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 };
|
package/dist/index.mjs
CHANGED
|
@@ -67,7 +67,12 @@ const postgresDialect = {
|
|
|
67
67
|
},
|
|
68
68
|
name: "postgres",
|
|
69
69
|
supportsReturning: true,
|
|
70
|
-
|
|
70
|
+
// Restrict to schemas on the effective search_path (excluding the implicit
|
|
71
|
+
// pg_catalog with `false`) so an unqualified name resolves exactly as CREATE
|
|
72
|
+
// TABLE / SELECT would. Without this filter the probe sees same-named tables in
|
|
73
|
+
// OTHER schemas of the same database (a common multi-tenant/multi-env Hyperdrive
|
|
74
|
+
// setup), reporting a companion table that does not exist on the search_path.
|
|
75
|
+
tableExists: (table) => sql`SELECT table_name FROM information_schema.tables WHERE table_schema = ANY (current_schemas(false)) AND table_name = ${table}`
|
|
71
76
|
};
|
|
72
77
|
const mysqlDialect = {
|
|
73
78
|
affectedRows: (result) => result.rowsAffected,
|
|
@@ -88,8 +93,13 @@ const mysqlDialect = {
|
|
|
88
93
|
{ name: "id", type: "VARCHAR(768) PRIMARY KEY" },
|
|
89
94
|
{ name: "_creationTime", type: "DOUBLE NOT NULL" }
|
|
90
95
|
],
|
|
91
|
-
// InnoDB can't index a TEXT/LONGTEXT/BLOB column without a key prefix
|
|
92
|
-
|
|
96
|
+
// InnoDB can't index a TEXT/LONGTEXT/BLOB column without a key prefix. Bound it
|
|
97
|
+
// to 191 chars (191 × 4 = 764 bytes under utf8mb4), matching the rank-companion
|
|
98
|
+
// convention: a flat 768-char prefix is 3072 bytes — exactly InnoDB's whole-index
|
|
99
|
+
// key limit — so ANY composite index containing a string field (e.g.
|
|
100
|
+
// `.index("by_project", ["projectId", "seq"])`) would exceed 3072 and fail CREATE
|
|
101
|
+
// INDEX with ER_TOO_LONG_KEY. 191 leaves room for several columns under the cap.
|
|
102
|
+
indexKeyPrefix: (kind) => MYSQL_PREFIX_INDEX_RE.test(mysqlColumnType(kind)) ? 191 : void 0,
|
|
93
103
|
isUniqueViolation: (error) => {
|
|
94
104
|
const candidate = error;
|
|
95
105
|
return candidate.errno === 1062 || candidate.code === "ER_DUP_ENTRY";
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import { liftSourceId } from '@lunora/do';
|
|
2
|
+
|
|
3
|
+
const projectSourceRow = (row, options = {}) => liftSourceId(row, options);
|
|
4
|
+
const pullSourceRows = async (sql, options) => {
|
|
5
|
+
const { idColumn, map, params, query } = options;
|
|
6
|
+
const rows = await sql.query(query, params);
|
|
7
|
+
return rows.map((row) => projectSourceRow(row, { idColumn, map }));
|
|
8
|
+
};
|
|
9
|
+
|
|
10
|
+
export { projectSourceRow, pullSourceRows };
|
|
@@ -0,0 +1,113 @@
|
|
|
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
|
+
interface NodePgLike {
|
|
93
|
+
query: (text: string, params?: ReadonlyArray<unknown>) => Promise<{
|
|
94
|
+
rows: unknown[];
|
|
95
|
+
}>;
|
|
96
|
+
}
|
|
97
|
+
/**
|
|
98
|
+
* Structural projection of a `postgres` (postgres.js) tagged-template client.
|
|
99
|
+
* The adapter uses the `.unsafe(text, params)` escape hatch so callers keep
|
|
100
|
+
* full control of the parameter list.
|
|
101
|
+
*/
|
|
102
|
+
interface PostgresJsLike {
|
|
103
|
+
unsafe: (text: string, params?: ReadonlyArray<unknown>) => Promise<unknown>;
|
|
104
|
+
}
|
|
105
|
+
/**
|
|
106
|
+
* Structural projection of a `mysql2/promise` connection/pool. `mysql2`'s
|
|
107
|
+
* `execute` resolves to a `[rows, fields]` tuple; the adapter takes the first
|
|
108
|
+
* element as the rows.
|
|
109
|
+
*/
|
|
110
|
+
interface Mysql2Like {
|
|
111
|
+
execute: (text: string, params?: ReadonlyArray<unknown>) => Promise<[unknown, unknown]>;
|
|
112
|
+
}
|
|
113
|
+
export { HyperdriveLike as H, Mysql2Like as M, NodePgLike as N, PostgresJsLike as P, SqlClient as S, HyperdriveConnection as a };
|
|
@@ -0,0 +1,113 @@
|
|
|
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
|
+
interface NodePgLike {
|
|
93
|
+
query: (text: string, params?: ReadonlyArray<unknown>) => Promise<{
|
|
94
|
+
rows: unknown[];
|
|
95
|
+
}>;
|
|
96
|
+
}
|
|
97
|
+
/**
|
|
98
|
+
* Structural projection of a `postgres` (postgres.js) tagged-template client.
|
|
99
|
+
* The adapter uses the `.unsafe(text, params)` escape hatch so callers keep
|
|
100
|
+
* full control of the parameter list.
|
|
101
|
+
*/
|
|
102
|
+
interface PostgresJsLike {
|
|
103
|
+
unsafe: (text: string, params?: ReadonlyArray<unknown>) => Promise<unknown>;
|
|
104
|
+
}
|
|
105
|
+
/**
|
|
106
|
+
* Structural projection of a `mysql2/promise` connection/pool. `mysql2`'s
|
|
107
|
+
* `execute` resolves to a `[rows, fields]` tuple; the adapter takes the first
|
|
108
|
+
* element as the rows.
|
|
109
|
+
*/
|
|
110
|
+
interface Mysql2Like {
|
|
111
|
+
execute: (text: string, params?: ReadonlyArray<unknown>) => Promise<[unknown, unknown]>;
|
|
112
|
+
}
|
|
113
|
+
export { HyperdriveLike as H, Mysql2Like as M, NodePgLike as N, PostgresJsLike as P, SqlClient as S, HyperdriveConnection as a };
|