@ooraini/pgquic 0.1.0 → 0.2.0

package/README.md

@@ -2,6 +2,8 @@
 
 Connect to PostgreSQL from the browser over WebTransport.
 
+## npm
+
 ```sh
 npm install @ooraini/pgquic
 ```
@@ -11,7 +13,6 @@ import { Pool, PgWebTransport } from "@ooraini/pgquic";
 
 const transport = new PgWebTransport({
   url: "https://db.example.com/v1/session",
-  token: () => getAccessToken(),
 });
 
 const pool = new Pool({
@@ -26,4 +27,47 @@ const pool = new Pool({
 const result = await pool.query("select now()");
 ```
 
-The package requires a [pgquic gateway](https://github.com/ooraini/pgquic). See the repository for gateway configuration and deployment.
+For the gateway's generated certificate, supply its logged base64 `certificate_sha256` value through `serverCertificateHashes` as shown below.
+
+## HTML
+
+The package is a self-contained ES module and can be imported without a build step:
+
+```html
+<script type="module">
+  import {
+    Pool,
+    PgWebTransport,
+  } from "https://cdn.jsdelivr.net/npm/@ooraini/pgquic@0.2.0/dist/index.js";
+
+  const hash = "PASTE_CERTIFICATE_SHA256_FROM_PGQUIC_LOG";
+  const transport = new PgWebTransport({
+    url: "https://localhost:4433/v1/session",
+    serverCertificateHashes: [{
+      algorithm: "sha-256",
+      value: Uint8Array.from(atob(hash), (c) => c.charCodeAt(0)),
+    }],
+  });
+
+  const pool = new Pool({
+    transport,
+    user: "app_user",
+    password: "password",
+    database: "app",
+    ssl: false,
+    enableChannelBinding: false,
+  });
+
+  const result = await pool.query("select now()");
+</script>
+```
+
+Use `<script type="module">`; the package does not expose a global for classic scripts.
+
+Both approaches require a [pgquic gateway](https://github.com/ooraini/pgquic). The host CLI reaches PostgreSQL at `127.0.0.1:5432` by default. A gateway container is also available:
+
+```sh
+docker pull ghcr.io/ooraini/pgquic-gateway:0.2.0
+```
+
+See the repository for gateway configuration and deployment.

package/dist/index.d.ts

@@ -1,14 +1,12 @@
-import { ClientConfig, PoolConfig } from 'pg';
+import { Client as Client$1, ClientConfig, PoolConfig, Pool as Pool$1 } from 'pg';
 import { EventEmitter } from 'events';
 
-type TokenProvider = string | (() => string | Promise<string>);
 interface CertificateHash {
     algorithm: "sha-256";
     value: BufferSource;
 }
 interface PgWebTransportOptions {
     url: string;
-    token?: TokenProvider;
     serverCertificateHashes?: CertificateHash[];
     maxConnections?: number;
     highWaterMark?: number;
@@ -111,12 +109,16 @@ interface PgquicPoolConfig extends PoolConfig {
     enableChannelBinding?: boolean;
 }
 declare const Client_base: any;
+interface Client extends Client$1 {
+}
 declare class Client extends Client_base {
     constructor(config: PgquicClientConfig);
 }
 declare const Pool_base: any;
+interface Pool extends Pool$1 {
+}
 declare class Pool extends Pool_base {
     constructor(config: PgquicPoolConfig);
 }
 
-export { Client, PgWebTransport, type PgWebTransportOptions, PgWebTransportSocket, type PgquicClientConfig, type PgquicPoolConfig, Pool, type TokenProvider, type TransportState };
+export { Client, PgWebTransport, type PgWebTransportOptions, PgWebTransportSocket, type PgquicClientConfig, type PgquicPoolConfig, Pool, type TransportState };

package/dist/index.js

@@ -6956,8 +6956,8 @@ init_inject();
 // src/framing.ts
 init_inject();
 var import_buffer3 = __toESM(require_buffer(), 1);
-function encodeControl(token) {
-  const payload = import_buffer3.Buffer.from(JSON.stringify({ version: 1, token }), "utf8");
+function encodeControl() {
+  const payload = import_buffer3.Buffer.from(JSON.stringify({ version: 1 }), "utf8");
   const result = import_buffer3.Buffer.allocUnsafe(4 + payload.length);
   result.writeUInt32BE(payload.length, 0);
   payload.copy(result, 4);
@@ -7077,11 +7077,10 @@ var PgWebTransport = class extends EventTarget {
       const control = await session.createBidirectionalStream();
       const writer = control.writable.getWriter();
       const reader = control.readable.getReader();
-      const token = typeof this.options.token === "function" ? await this.options.token() : this.options.token ?? "";
-      await writer.write(encodeControl(token));
+      await writer.write(encodeControl());
       const welcome = await readControl(reader);
       if (!welcome.ok)
-        throw new Error(welcome.error || "pgquic authentication failed");
+        throw new Error(welcome.error || "pgquic control handshake failed");
       writer.releaseLock();
       reader.releaseLock();
       this.session = session;