@lunora/hyperdrive 1.0.0-alpha.4 → 1.0.0-alpha.40

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/dist/index.d.ts 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.js";
1
2
  /**
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
- }
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
- export { type HyperdriveConnection, type HyperdriveLike, type Mysql2Like, type NodePgLike, type PostgresJsLike, type SqlClient, createHyperdrive, fromMysql2, fromNodePg, fromPostgresJs };
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
@@ -1 +1,2 @@
1
1
  export { createHyperdrive, fromMysql2, fromNodePg, fromPostgresJs } from './packem_shared/createHyperdrive-DD8GoDZo.mjs';
2
+ export { projectSourceRow, pullSourceRows } from './packem_shared/projectSourceRow-DtKuMRIm.mjs';
@@ -67,7 +67,12 @@ const postgresDialect = {
67
67
  },
68
68
  name: "postgres",
69
69
  supportsReturning: true,
70
- tableExists: (table) => sql`SELECT table_name FROM information_schema.tables WHERE table_name = ${table}`
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; bound it to 768 chars.
92
- indexKeyPrefix: (kind) => MYSQL_PREFIX_INDEX_RE.test(mysqlColumnType(kind)) ? 768 : void 0,
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 };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@lunora/hyperdrive",
3
- "version": "1.0.0-alpha.4",
3
+ "version": "1.0.0-alpha.40",
4
4
  "description": "Bring-your-own Postgres/MySQL for Lunora via Cloudflare Hyperdrive: a driver-agnostic, action-only ctx.sql",
5
5
  "keywords": [
6
6
  "cloudflare",
@@ -25,7 +25,7 @@
25
25
  "directory": "packages/hyperdrive"
26
26
  },
27
27
  "files": [
28
- "dist",
28
+ "./dist",
29
29
  "README.md",
30
30
  "LICENSE.md",
31
31
  "__assets__"
@@ -50,8 +50,9 @@
50
50
  "access": "public"
51
51
  },
52
52
  "dependencies": {
53
- "@lunora/do": "1.0.0-alpha.4",
54
- "@lunora/sql-store": "1.0.0-alpha.4",
53
+ "@lunora/do": "1.0.0-alpha.44",
54
+ "@lunora/errors": "1.0.0-alpha.8",
55
+ "@lunora/sql-store": "1.0.0-alpha.41",
55
56
  "drizzle-orm": "^0.45.2"
56
57
  },
57
58
  "peerDependencies": {