@schema-weaver/pg-connector 0.0.0-stage → 2.0.0

package/dist/cjs/cli/commands/db-query.d.ts

@@ -0,0 +1,121 @@
+import { Pool } from 'pg';
+import { DbEntry } from '../../config/db-config';
+import { PermissionChecker } from '../../permissions/checker';
+import type { PermissionLevel } from '../../permissions/types';
+import type { Role } from '../../protocol/envelope';
+/**
+ * Identity recorded for SQL submitted from the local CLI or the `db connect`
+ * REPL. There is no cloud user in this path: the request comes from a process
+ * that already holds the database credentials, so it is recorded under a
+ * distinct actor id rather than being folded into a browser role.
+ */
+export declare const LOCAL_OPERATOR_ID = "local-operator";
+/**
+ * Role the local operator is recorded as.
+ *
+ * The capability matrix is not the control here — the entry's effective
+ * permission level is. A local operator holds the credentials and can always
+ * use `psql` instead; pretending a shell is a lesser role would be theatre. The
+ * audit record keeps the level (`permission_level`) and the actor
+ * (`user_id: 'local-operator'`) so the distinction stays visible.
+ */
+export declare const LOCAL_OPERATOR_ROLE: Role;
+/** Statement timeout applied to every local query. Bounded, never caller-settable. */
+export declare const LOCAL_STATEMENT_TIMEOUT_MS: 30000;
+/** Hard cap on rows returned to the terminal, enforced while rows are fetched. */
+export declare const LOCAL_MAX_ROWS: 10000;
+export declare class LocalPermissionDeniedError extends Error {
+    readonly code: string;
+    constructor(message: string, code: string);
+}
+export declare class LocalAuditUnavailableError extends Error {
+    constructor(message: string);
+}
+export declare class LocalRowCapError extends Error {
+    constructor(message: string);
+}
+export interface LocalQueryResult {
+    rows: LocalRow[];
+    fields: Array<{
+        name: string;
+    }>;
+    rowCount: number | null;
+    command: string;
+}
+/** A result row as produced by node-postgres. */
+export type LocalRow = Record<string, unknown>;
+export interface LocalClient {
+    query(config: string | {
+        text: string;
+        values?: unknown[];
+    }): Promise<LocalQueryResult>;
+    release(): void;
+}
+export interface LocalPool {
+    connect(): Promise<LocalClient>;
+    end(): Promise<void>;
+}
+export type LocalPoolFactory = (entry: DbEntry) => LocalPool | Promise<LocalPool>;
+/** The subset of `AuditSink` the local path depends on. */
+export interface LocalAuditRecorder {
+    logSync(event: Record<string, unknown>): Promise<void>;
+    flush(): Promise<void>;
+}
+export interface LocalSqlDeps {
+    poolFactory: LocalPoolFactory;
+    audit: LocalAuditRecorder;
+    checker: PermissionChecker;
+    /** Effective permission level for this database entry. */
+    permissionLevel: PermissionLevel;
+    /** Advisory cap; defaults to {@link LOCAL_MAX_ROWS}. */
+    maxRows?: number;
+    /** Advisory statement timeout in ms; defaults to {@link LOCAL_STATEMENT_TIMEOUT_MS}. */
+    timeoutMs?: number;
+    /** `true` when the resolved level is `read_only`. */
+    readOnlySession: boolean;
+}
+export interface LocalSqlRequest {
+    entry: DbEntry;
+    sql: string;
+    /** Audit action label. */
+    action: 'query' | 'introspect';
+}
+/**
+ * Classify, authorise, audit, and run a single local statement.
+ *
+ * Order is deliberate and fail-closed:
+ *   1. classify with the PostgreSQL parser
+ *   2. authorise through `PermissionChecker` at the entry's resolved level
+ *   3. append the audit record — mandatory; a failed append refuses execution
+ *   4. apply `statement_timeout`, `lock_timeout` and the read_only posture
+ *   5. execute with a row ceiling that binds during fetch
+ *   6. append the outcome record
+ */
+export declare function executeLocalSql(req: LocalSqlRequest, deps: LocalSqlDeps): Promise<LocalQueryResult>;
+/**
+ * Audit sink for local CLI activity.
+ *
+ * Writes to the same `~/.sw-agent/audit/` chain the daemon uses, so a local
+ * statement and a cloud statement land in one ordered log. The cloud writer is
+ * disabled: nothing in this path transmits anything.
+ */
+export declare function createLocalAuditRecorder(): LocalAuditRecorder;
+export declare function createLocalPermissionChecker(audit: LocalAuditRecorder): PermissionChecker;
+/**
+ * Effective permission level for a database entry: the entry's override if it
+ * has one, otherwise the machine default, otherwise `read_only`.
+ */
+export declare function resolveLocalPermissionLevel(entry: DbEntry): PermissionLevel;
+/**
+ * Build the default dependency set for a database entry.
+ *
+ * `manual` is resolved to `read_only` before the checker runs: the approval flow
+ * requires the browser relay, and a local shell has no way to answer it.
+ */
+export declare function createLocalSqlDeps(entry: DbEntry): LocalSqlDeps;
+/** Narrow a resolved level to what the local path can actually enforce. */
+export declare function localPermissionLevelFor(entry: DbEntry): PermissionLevel;
+export declare function createDbPool(entry: DbEntry): Pool;
+export declare function runDbQuery(args: string[]): Promise<void>;
+export declare function runDbConnect(args: string[]): Promise<void>;
+//# sourceMappingURL=db-query.d.ts.map

package/dist/cjs/cli/commands/db-query.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"db-query.d.ts","sourceRoot":"","sources":["../../../../src/cli/commands/db-query.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,IAAI,EAAc,MAAM,IAAI,CAAC;AACtC,OAAO,EAAe,OAAO,EAAE,MAAM,wBAAwB,CAAC;AAQ9D,OAAO,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AAI9D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAC/D,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,yBAAyB,CAAC;AAcpD;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB,mBAAmB,CAAC;AAElD;;;;;;;;GAQG;AACH,eAAO,MAAM,mBAAmB,EAAE,IAAc,CAAC;AAEjD,sFAAsF;AACtF,eAAO,MAAM,0BAA0B,OAA4B,CAAC;AAEpE,kFAAkF;AAClF,eAAO,MAAM,cAAc,OAA0B,CAAC;AAQtD,qBAAa,0BAA2B,SAAQ,KAAK;aAGjC,IAAI,EAAE,MAAM;gBAD5B,OAAO,EAAE,MAAM,EACC,IAAI,EAAE,MAAM;CAK/B;AAED,qBAAa,0BAA2B,SAAQ,KAAK;gBACvC,OAAO,EAAE,MAAM;CAI5B;AAED,qBAAa,gBAAiB,SAAQ,KAAK;gBAC7B,OAAO,EAAE,MAAM;CAI5B;AAMD,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,QAAQ,EAAE,CAAC;IACjB,MAAM,EAAE,KAAK,CAAC;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAChC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,iDAAiD;AACjD,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAU/C,MAAM,WAAW,WAAW;IAC1B,KAAK,CAAC,MAAM,EAAE,MAAM,GAAG;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,OAAO,EAAE,CAAA;KAAE,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;IACxF,OAAO,IAAI,IAAI,CAAC;CACjB;AAED,MAAM,WAAW,SAAS;IACxB,OAAO,IAAI,OAAO,CAAC,WAAW,CAAC,CAAC;IAChC,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CACtB;AAED,MAAM,MAAM,gBAAgB,GAAG,CAAC,KAAK,EAAE,OAAO,KAAK,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;AAElF,2DAA2D;AAC3D,MAAM,WAAW,kBAAkB;IACjC,OAAO,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACvD,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CACxB;AAED,MAAM,WAAW,YAAY;IAC3B,WAAW,EAAE,gBAAgB,CAAC;IAC9B,KAAK,EAAE,kBAAkB,CAAC;IAC1B,OAAO,EAAE,iBAAiB,CAAC;IAC3B,0DAA0D;IAC1D,eAAe,EAAE,eAAe,CAAC;IACjC,wDAAwD;IACxD,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,wFAAwF;IACxF,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,qDAAqD;IACrD,eAAe,EAAE,OAAO,CAAC;CAC1B;AAED,MAAM,WAAW,eAAe;IAC9B,KAAK,EAAE,OAAO,CAAC;IACf,GAAG,EAAE,MAAM,CAAC;IACZ,0BAA0B;IAC1B,MAAM,EAAE,OAAO,GAAG,YAAY,CAAC;CAChC;AA2QD;;;;;;;;;;GAUG;AACH,wBAAsB,eAAe,CACnC,GAAG,EAAE,eAAe,EACpB,IAAI,EAAE,YAAY,GACjB,OAAO,CAAC,gBAAgB,CAAC,CAqG3B;AAUD;;;;;;GAMG;AACH,wBAAgB,wBAAwB,IAAI,kBAAkB,CAkB7D;AAED,wBAAgB,4BAA4B,CAAC,KAAK,EAAE,kBAAkB,GAAG,iBAAiB,CAgBzF;AAED;;;GAGG;AACH,wBAAgB,2BAA2B,CAAC,KAAK,EAAE,OAAO,GAAG,eAAe,CAU3E;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,OAAO,GAAG,YAAY,CAc/D;AAED,2EAA2E;AAC3E,wBAAgB,uBAAuB,CAAC,KAAK,EAAE,OAAO,GAAG,eAAe,CAGvE;AAED,wBAAgB,YAAY,CAAC,KAAK,EAAE,OAAO,GAAG,IAAI,CA+BjD;AAMD,wBAAsB,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAwH9D;AAUD,wBAAsB,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAsHhE"}