@saptools/cf-hana 0.2.2 → 0.3.1

package/dist/index.d.ts

@@ -124,6 +124,12 @@ declare function cfHanaBackupRoot(saptoolsRoot?: string): string;
 declare function buildWriteBackupPlan(sql: string, params?: readonly SqlParam[]): WriteBackupPlan | undefined;
 declare function writeSqlBackup(input: SqlBackupWriteInput, options?: SqlBackupWriteOptions): Promise<SqlBackupRecord>;
 
+interface CatalogObjectInfo {
+    readonly schema: string;
+    readonly name: string;
+    readonly type: "TABLE" | "VIEW";
+}
+
 interface DriverExecResult {
     readonly rows: readonly Record<string, SqlParam>[];
     readonly columns: readonly QueryResultColumn[];
@@ -265,6 +271,8 @@ declare class HanaClient {
     listSchemas(): Promise<readonly string[]>;
     /** List the tables in a schema. */
     listTables(schema: string): Promise<readonly TableInfo[]>;
+    /** List table and view names in a schema for typo suggestions. */
+    listCatalogObjects(schema: string): Promise<readonly CatalogObjectInfo[]>;
     /** List the columns of a table. */
     listColumns(schema: string, table: string): Promise<readonly ColumnInfo[]>;
     /** Return the HANA execution plan for a statement. */
@@ -320,6 +328,7 @@ interface CfHanaErrorOptions {
 }
 interface QueryErrorOptions extends CfHanaErrorOptions {
     readonly sqlState?: string;
+    readonly databaseCode?: number;
 }
 /** Base error for every failure surfaced by `@saptools/cf-hana`. */
 declare class CfHanaError extends Error {
@@ -333,6 +342,7 @@ declare class CredentialsNotFoundError extends CfHanaError {
 /** A SQL statement failed on the HANA server. */
 declare class QueryError extends CfHanaError {
     readonly sqlState: string | undefined;
+    readonly databaseCode: number | undefined;
     constructor(message: string, options?: QueryErrorOptions);
 }
 /** A write/DDL statement was issued on a read-only client. */
@@ -346,4 +356,4 @@ declare class DestructiveStatementError extends CfHanaError {
 /** Narrow an unknown thrown value to a human-readable message. */
 declare function errorMessage(error: unknown): string;
 
-export { type BuiltStatement, CfHanaError, type CfHanaErrorCode, type ColumnInfo, type ConnectOptions, type CredentialSource, CredentialsNotFoundError, type DbUserRole, DestructiveStatementError, type DriverConnectParams, type DriverConnection, type DriverExecResult, HanaClient, type HanaClientInfo, type HanaDriver, type OutputFormat, type PoolOptions, QueryError, type QueryOptions, type QueryResult, type QueryResultColumn, type QueryRow, ReadOnlyViolationError, type SelectSpec, type SqlBackupRecord, type SqlBackupWriteInput, type SqlBackupWriteOptions, type SqlParam, type StatementKind, type TableInfo, Transaction, type WriteBackupOperation, type WriteBackupPlan, buildCount, buildDelete, buildInsert, buildSelect, buildUpdate, buildWriteBackupPlan, cfHanaBackupRoot, connect, createDriver, errorMessage, formatCsv, formatJson, formatResult, formatTable, query, withConnection, writeSqlBackup };
+export { type BuiltStatement, type CatalogObjectInfo, CfHanaError, type CfHanaErrorCode, type ColumnInfo, type ConnectOptions, type CredentialSource, CredentialsNotFoundError, type DbUserRole, DestructiveStatementError, type DriverConnectParams, type DriverConnection, type DriverExecResult, HanaClient, type HanaClientInfo, type HanaDriver, type OutputFormat, type PoolOptions, QueryError, type QueryOptions, type QueryResult, type QueryResultColumn, type QueryRow, ReadOnlyViolationError, type SelectSpec, type SqlBackupRecord, type SqlBackupWriteInput, type SqlBackupWriteOptions, type SqlParam, type StatementKind, type TableInfo, Transaction, type WriteBackupOperation, type WriteBackupPlan, buildCount, buildDelete, buildInsert, buildSelect, buildUpdate, buildWriteBackupPlan, cfHanaBackupRoot, connect, createDriver, errorMessage, formatCsv, formatJson, formatResult, formatTable, query, withConnection, writeSqlBackup };

package/dist/index.js

@@ -23,12 +23,36 @@ var CredentialsNotFoundError = class extends CfHanaError {
 };
 var QueryError = class extends CfHanaError {
   sqlState;
+  databaseCode;
   constructor(message, options) {
     super("QUERY", message, options);
     this.name = "QueryError";
     this.sqlState = options?.sqlState;
+    this.databaseCode = options?.databaseCode;
   }
 };
+function isDatabaseErrorShape(error) {
+  return typeof error === "object" && error !== null && "code" in error;
+}
+function safeDatabaseCode(value) {
+  if (typeof value === "number" && Number.isSafeInteger(value)) {
+    return value;
+  }
+  if (typeof value !== "string" || !/^\d+$/.test(value)) {
+    return void 0;
+  }
+  const parsed = Number(value);
+  return Number.isSafeInteger(parsed) ? parsed : void 0;
+}
+function databaseCode(error) {
+  if (error instanceof QueryError) {
+    return error.databaseCode ?? databaseCode(error.cause);
+  }
+  if (isDatabaseErrorShape(error)) {
+    return safeDatabaseCode(error.code);
+  }
+  return void 0;
+}
 var ReadOnlyViolationError = class extends CfHanaError {
   constructor(message, options) {
     super("READ_ONLY_VIOLATION", message, options);
@@ -48,8 +72,17 @@ function errorMessage(error) {
   return String(error);
 }
 
+// src/lob.ts
+var TEXT_LOB_TYPES = /* @__PURE__ */ new Set(["CLOB", "NCLOB"]);
+function normalizeTypeName(typeName2) {
+  return typeName2?.trim().toUpperCase() ?? "";
+}
+function isTextLobType(typeName2) {
+  return TEXT_LOB_TYPES.has(normalizeTypeName(typeName2));
+}
+
 // src/format.ts
-function cellText(value, nullText) {
+function cellText(value, nullText, column) {
   if (value === null) {
     return nullText;
   }
@@ -57,14 +90,14 @@ function cellText(value, nullText) {
     return value.toISOString();
   }
   if (Buffer.isBuffer(value)) {
-    return `0x${value.toString("hex")}`;
+    return isTextLobType(column?.typeName) ? value.toString("utf8") : `0x${value.toString("hex")}`;
   }
   if (typeof value === "boolean") {
     return value ? "true" : "false";
   }
   return typeof value === "number" ? value.toString() : value;
 }
-function serializeCell(value) {
+function serializeCell(value, column) {
   if (value === null) {
     return null;
   }
@@ -72,7 +105,7 @@ function serializeCell(value) {
     return value.toISOString();
   }
   if (Buffer.isBuffer(value)) {
-    return `0x${value.toString("hex")}`;
+    return isTextLobType(column?.typeName) ? value.toString("utf8") : `0x${value.toString("hex")}`;
   }
   return value;
 }
@@ -88,7 +121,7 @@ function formatTable(result) {
   }
   const headers = result.columns.map((column) => column.name);
   const rows = result.rows.map(
-    (row) => result.columns.map((column) => cellText(row[column.name] ?? null, "NULL"))
+    (row) => result.columns.map((column) => cellText(row[column.name] ?? null, "NULL", column))
   );
   const widths = headers.map((header, index) => {
     const widest = rows.reduce(
@@ -106,7 +139,8 @@ function formatJson(result) {
   const rows = result.rows.map((row) => {
     const serialized = {};
     for (const [key, value] of Object.entries(row)) {
-      serialized[key] = serializeCell(value);
+      const column = result.columns.find((item) => item.name === key);
+      serialized[key] = serializeCell(value, column);
     }
     return serialized;
   });
@@ -117,7 +151,7 @@ function formatCsv(result) {
   const lines = [headers.map((header) => csvEscape(header)).join(",")];
   for (const row of result.rows) {
     lines.push(
-      result.columns.map((column) => csvEscape(cellText(row[column.name] ?? null, ""))).join(",")
+      result.columns.map((column) => csvEscape(cellText(row[column.name] ?? null, "", column))).join(",")
     );
   }
   return lines.join("\r\n");
@@ -562,6 +596,18 @@ async function listTables(connection, schema) {
     rowCount: void 0
   }));
 }
+async function listCatalogObjects(connection, schema) {
+  const result = await connection.query(
+    "SELECT SCHEMA_NAME, TABLE_NAME AS OBJECT_NAME, 'TABLE' AS OBJECT_TYPE FROM SYS.TABLES WHERE SCHEMA_NAME = ? UNION ALL SELECT SCHEMA_NAME, VIEW_NAME AS OBJECT_NAME, 'VIEW' AS OBJECT_TYPE FROM SYS.VIEWS WHERE SCHEMA_NAME = ? ORDER BY OBJECT_NAME",
+    [schema, schema],
+    { autoLimit: false }
+  );
+  return result.rows.map((row) => ({
+    schema: row.SCHEMA_NAME,
+    name: row.OBJECT_NAME,
+    type: row.OBJECT_TYPE
+  }));
+}
 async function listColumns(connection, schema, table) {
   const result = await connection.query(
     "SELECT COLUMN_NAME, DATA_TYPE_NAME, LENGTH, SCALE, IS_NULLABLE, POSITION FROM SYS.TABLE_COLUMNS WHERE SCHEMA_NAME = ? AND TABLE_NAME = ? ORDER BY POSITION",
@@ -579,7 +625,7 @@ async function listColumns(connection, schema, table) {
 }
 
 // src/config.ts
-var CLI_VERSION = "0.2.1";
+var CLI_VERSION = "0.3.1";
 var ENV_PREFIX = "CF_HANA";
 var DEFAULT_QUERY_TIMEOUT_MS = 3e4;
 var DEFAULT_CONNECT_TIMEOUT_MS = 3e4;
@@ -1037,12 +1083,88 @@ function toConnectionTarget(binding, role) {
 
 // src/driver/fake.ts
 import { appendFile } from "fs/promises";
+var catalogFailureInjected = false;
+function catalogObjects() {
+  return [
+    { SCHEMA_NAME: "APP_SCHEMA", OBJECT_NAME: "EXISTING_TABLE", OBJECT_TYPE: "TABLE" },
+    { SCHEMA_NAME: "APP_SCHEMA", OBJECT_NAME: "MISSING_TABLE_FIXED", OBJECT_TYPE: "TABLE" },
+    { SCHEMA_NAME: "APP_SCHEMA", OBJECT_NAME: "MISSING_TABLE_VIEW", OBJECT_TYPE: "VIEW" },
+    { SCHEMA_NAME: "APP_SCHEMA", OBJECT_NAME: "STATUS_ITEMS", OBJECT_TYPE: "TABLE" },
+    { SCHEMA_NAME: "APP_SCHEMA", OBJECT_NAME: "CORE_AUTH_SCOPE", OBJECT_TYPE: "TABLE" }
+  ];
+}
+function tableColumns() {
+  return [
+    { COLUMN_NAME: "ID", DATA_TYPE_NAME: "INTEGER", LENGTH: null, SCALE: null, IS_NULLABLE: "FALSE", POSITION: 1 },
+    { COLUMN_NAME: "IS_ACTIVE", DATA_TYPE_NAME: "BOOLEAN", LENGTH: null, SCALE: null, IS_NULLABLE: "TRUE", POSITION: 2 },
+    { COLUMN_NAME: "SCOPE_NAME", DATA_TYPE_NAME: "NVARCHAR", LENGTH: 255, SCALE: null, IS_NULLABLE: "TRUE", POSITION: 3 }
+  ];
+}
 function fakeExec(sql) {
   const kind = classifyStatement(sql);
   const forcedFailure = readEnv(envName("FAKE_FAIL_STATEMENT"))?.toLowerCase();
   if (forcedFailure === kind) {
     throw new Error(`fake driver forced ${kind.toUpperCase()} failure`);
   }
+  const upperSql = sql.toUpperCase();
+  if (upperSql.includes("SYS.TABLES") && upperSql.includes("SYS.VIEWS")) {
+    if (readEnv(envName("FAKE_FAIL_CATALOG_ONCE")) === "1" && !catalogFailureInjected) {
+      catalogFailureInjected = true;
+      throw new QueryError("fake transient catalog metadata failure");
+    }
+    return {
+      rows: catalogObjects(),
+      columns: [
+        { name: "SCHEMA_NAME", typeName: "NVARCHAR" },
+        { name: "OBJECT_NAME", typeName: "NVARCHAR" },
+        { name: "OBJECT_TYPE", typeName: "NVARCHAR" }
+      ],
+      affectedRows: 0
+    };
+  }
+  if (upperSql.includes("SYS.TABLE_COLUMNS")) {
+    return {
+      rows: tableColumns(),
+      columns: [
+        { name: "COLUMN_NAME", typeName: "NVARCHAR" },
+        { name: "DATA_TYPE_NAME", typeName: "NVARCHAR" },
+        { name: "LENGTH", typeName: "INTEGER" },
+        { name: "SCALE", typeName: "INTEGER" },
+        { name: "IS_NULLABLE", typeName: "NVARCHAR" },
+        { name: "POSITION", typeName: "INTEGER" }
+      ],
+      affectedRows: 0
+    };
+  }
+  if (upperSql.includes("MISSING_TABLE") || upperSql.includes("MISSING_TABLES")) {
+    throw new QueryError("invalid table name: MISSING_TABLE", { sqlState: "42S02" });
+  }
+  if (upperSql.includes("ISACTIVE")) {
+    throw new QueryError("invalid column name: ISACTIVE: line 1 col 8 (at pos 7)", { databaseCode: 260 });
+  }
+  if (upperSql.includes("LOB_ORDER_ERROR")) {
+    throw new QueryError("inconsistent datatype: LOB type is not allowed in ORDER BY clause", { databaseCode: 266 });
+  }
+  if (upperSql.includes("LOB_GROUP_ERROR")) {
+    throw new QueryError("inconsistent datatype: LOB type is not allowed in GROUP BY clause", { databaseCode: 274 });
+  }
+  if (sql.toUpperCase().includes("LOB_FIXTURE")) {
+    return {
+      rows: [
+        {
+          LOG_CONTENT: Buffer.from("Example log entry", "utf8"),
+          CLOB_CONTENT: Buffer.from("Clob log entry", "utf8"),
+          PAYLOAD: Buffer.from([0, 1, 2, 255])
+        }
+      ],
+      columns: [
+        { name: "LOG_CONTENT", typeName: "NCLOB" },
+        { name: "CLOB_CONTENT", typeName: "CLOB" },
+        { name: "PAYLOAD", typeName: "BLOB" }
+      ],
+      affectedRows: 0
+    };
+  }
   if (sql.toUpperCase().includes("DUMMY")) {
     return {
       rows: [{ "1": 1 }],
@@ -1150,7 +1272,12 @@ function extractSqlState(error) {
 }
 function toQueryError(error) {
   const sqlState = extractSqlState(error);
-  return sqlState === void 0 ? new QueryError(error.message, { cause: error }) : new QueryError(error.message, { cause: error, sqlState });
+  const code = databaseCode(error);
+  return new QueryError(error.message, {
+    cause: error,
+    ...sqlState === void 0 ? {} : { sqlState },
+    ...code === void 0 ? {} : { databaseCode: code }
+  });
 }
 function toColumns(metadata) {
   if (metadata === void 0) {
@@ -2042,6 +2169,10 @@ var HanaClient = class _HanaClient {
   async listTables(schema) {
     return await this.pool.withConnection((connection) => listTables(connection, schema));
   }
+  /** List table and view names in a schema for typo suggestions. */
+  async listCatalogObjects(schema) {
+    return await this.pool.withConnection((connection) => listCatalogObjects(connection, schema));
+  }
   /** List the columns of a table. */
   async listColumns(schema, table) {
     return await this.pool.withConnection(