@graffy/pg 0.16.21-alpha.1 → 0.17.0

package/index.cjs

@@ -3,6 +3,7 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
 const common = require("@graffy/common");
 const debug = require("debug");
 const pg$1 = require("pg");
+const sqlFormatter = require("sql-formatter");
 class Sql {
   constructor(rawStrings, rawValues) {
     if (rawStrings.length - 1 !== rawValues.length) {
@@ -84,14 +85,14 @@ function formatSql(sql2) {
   const values = sql2.values.slice(0);
   const output = [];
   while (strings.length) {
-    output.push(strings.shift().replace(/\s+/g, " "));
+    output.push(strings.shift());
     if (!values.length) break;
     const value = values.shift();
     output.push(
       typeof value === "number" ? value.toString() : typeof value === "object" ? `'${JSON.stringify(value)}'` : `'${value}'`
     );
   }
-  return output.join("").trim();
+  return sqlFormatter.format(output.join(""), { language: "postgresql" });
 }
 const getJsonBuildTrusted = (variadic) => {
   const args = join(
@@ -171,23 +172,23 @@ const getSelectCols = (options, projection = null) => {
       sqls.push(
         sql`jsonb_build_object(${join(subSqls, ", ")}) AS "${raw(key)}"`
       );
-    }
-    if (key[0] === "$") continue;
-    if (typeof projection[key] === "object") {
-      const optimisedJsonBuild = getOptimisedJsonBuild(
-        projection[key],
-        [],
-        key,
-        options
-      );
-      sqls.push(
-        sql`jsonb_build_object(${join(optimisedJsonBuild, ", ")}) AS "${raw(key)}"`
-      );
     } else {
-      sqls.push(sql`"${raw(key)}"`);
+      if (typeof projection[key] === "object") {
+        const optimisedJsonBuild = getOptimisedJsonBuild(
+          projection[key],
+          [],
+          key,
+          options
+        );
+        sqls.push(
+          sql`jsonb_build_object(${join(optimisedJsonBuild, ", ")}) AS "${raw(key)}"`
+        );
+      } else {
+        sqls.push(sql`"${raw(key)}"`);
+      }
     }
   }
-  return sqls.length ? join(sqls, ", ") : sql`TRUE AS "$"`;
+  return join(sqls, ", ");
 };
 function vertexSql(array, nullValue) {
   return sql`array[${join(
@@ -826,9 +827,9 @@ class Db {
       common.merge(results, wrappedGraph);
     };
     const explainArgs = async (args, projection) => {
-      const { $analyze, ...qArgs } = args.$explain;
+      const { analyze, $explain: qArgs } = args;
       const qSql = selectByArgs(qArgs, null, tableOptions);
-      const sql$1 = sql`EXPLAIN (${$analyze ? sql`ANALYZE, BUFFERS, TIMING, ` : sql``}COSTS, VERBOSE, FORMAT JSON) ${qSql}`;
+      const sql$1 = sql`EXPLAIN (${analyze ? sql`ANALYZE, BUFFERS, TIMING, ` : sql``}COSTS, VERBOSE, FORMAT JSON) ${qSql}`;
       const result = await this.readSql(sql$1, tableOptions);
       const wrappedGraph = common.encodeGraph(
         common.wrapObject(

package/index.mjs

@@ -1,6 +1,7 @@
 import { isEmpty, isPlainObject, encodePath, unwrap, decodeArgs, decodeQuery, finalize, wrap, isRange, cmp, decodeGraph, mergeObject, wrapObject, merge, encodeGraph, remove } from "@graffy/common";
 import debug from "debug";
 import pg$1 from "pg";
+import { format } from "sql-formatter";
 class Sql {
   constructor(rawStrings, rawValues) {
     if (rawStrings.length - 1 !== rawValues.length) {
@@ -82,14 +83,14 @@ function formatSql(sql2) {
   const values = sql2.values.slice(0);
   const output = [];
   while (strings.length) {
-    output.push(strings.shift().replace(/\s+/g, " "));
+    output.push(strings.shift());
     if (!values.length) break;
     const value = values.shift();
     output.push(
       typeof value === "number" ? value.toString() : typeof value === "object" ? `'${JSON.stringify(value)}'` : `'${value}'`
     );
   }
-  return output.join("").trim();
+  return format(output.join(""), { language: "postgresql" });
 }
 const getJsonBuildTrusted = (variadic) => {
   const args = join(
@@ -169,23 +170,23 @@ const getSelectCols = (options, projection = null) => {
       sqls.push(
         sql`jsonb_build_object(${join(subSqls, ", ")}) AS "${raw(key)}"`
       );
-    }
-    if (key[0] === "$") continue;
-    if (typeof projection[key] === "object") {
-      const optimisedJsonBuild = getOptimisedJsonBuild(
-        projection[key],
-        [],
-        key,
-        options
-      );
-      sqls.push(
-        sql`jsonb_build_object(${join(optimisedJsonBuild, ", ")}) AS "${raw(key)}"`
-      );
     } else {
-      sqls.push(sql`"${raw(key)}"`);
+      if (typeof projection[key] === "object") {
+        const optimisedJsonBuild = getOptimisedJsonBuild(
+          projection[key],
+          [],
+          key,
+          options
+        );
+        sqls.push(
+          sql`jsonb_build_object(${join(optimisedJsonBuild, ", ")}) AS "${raw(key)}"`
+        );
+      } else {
+        sqls.push(sql`"${raw(key)}"`);
+      }
     }
   }
-  return sqls.length ? join(sqls, ", ") : sql`TRUE AS "$"`;
+  return join(sqls, ", ");
 };
 function vertexSql(array, nullValue) {
   return sql`array[${join(
@@ -722,7 +723,7 @@ class Db {
     const cubeOid = Number.parseInt(((_b = (_a = tableOptions == null ? void 0 : tableOptions.schema) == null ? void 0 : _a.typeOids) == null ? void 0 : _b.cube) || "0") || null;
     try {
       sql2.types = {
-        getTypeParser: (oid, format) => {
+        getTypeParser: (oid, format2) => {
           if (oid === types.builtins.INT8) {
             return (value) => Number.parseInt(value, 10);
           }
@@ -734,7 +735,7 @@ class Db {
               return array.length > 1 ? array : array[0];
             };
           }
-          return types.getTypeParser(oid, format);
+          return types.getTypeParser(oid, format2);
         }
       };
       return await this.client.query(sql2);
@@ -824,9 +825,9 @@ class Db {
       merge(results, wrappedGraph);
     };
     const explainArgs = async (args, projection) => {
-      const { $analyze, ...qArgs } = args.$explain;
+      const { analyze, $explain: qArgs } = args;
       const qSql = selectByArgs(qArgs, null, tableOptions);
-      const sql$1 = sql`EXPLAIN (${$analyze ? sql`ANALYZE, BUFFERS, TIMING, ` : sql``}COSTS, VERBOSE, FORMAT JSON) ${qSql}`;
+      const sql$1 = sql`EXPLAIN (${analyze ? sql`ANALYZE, BUFFERS, TIMING, ` : sql``}COSTS, VERBOSE, FORMAT JSON) ${qSql}`;
       const result = await this.readSql(sql$1, tableOptions);
       const wrappedGraph = encodeGraph(
         wrapObject(

package/package.json

@@ -2,7 +2,7 @@
   "name": "@graffy/pg",
   "description": "The standard Postgres module for Graffy. Each instance this module mounts a Postgres table as a Graffy subtree.",
   "author": "aravind (https://github.com/aravindet)",
-  "version": "0.16.21-alpha.1",
+  "version": "0.17.0",
   "main": "./index.cjs",
   "exports": {
     "import": "./index.mjs",
@@ -16,8 +16,9 @@
   },
   "license": "Apache-2.0",
   "dependencies": {
-    "@graffy/common": "0.16.21-alpha.1",
-    "debug": "^4.3.3"
+    "@graffy/common": "0.17.0",
+    "debug": "^4.3.3",
+    "sql-formatter": "^15.6.2"
   },
   "peerDependencies": {
     "pg": "^8.0.0"

package/types/sql/format.d.ts

@@ -1 +1,5 @@
-export default function formatSql(sql: any): string;
+/**
+ * @param {import('sql-template-tag').Sql} sql
+ * @returns {string}
+ */
+export default function formatSql(sql: import("sql-template-tag").Sql): string;