ClientCommon

lib/deno_postgres_interop.dart

@@ -13,7 +13,6 @@ export 'src/pool.dart';
 export 'src/pool_client.dart';
 export 'src/query.dart';
 export 'src/query_client.dart';
-export 'src/query_object.dart' show QueryArguments;
 export 'src/query_object_result.dart';
 export 'src/query_result.dart';
 export 'src/tls_options.dart';

lib/src/client_common.dart

@@ -0,0 +1,102 @@
+import 'package:deno_postgres_interop/src/query_array_result.dart';
+import 'package:deno_postgres_interop/src/query_object_options.dart';
+import 'package:deno_postgres_interop/src/query_object_result.dart';
+import 'package:deno_postgres_interop/src/util.dart';
+
+/// [deno-postgres@v0.17.0/QueryArguments](https://deno.land/x/postgres@v0.17.0/query/query.ts?s=QueryArguments).
+typedef QueryArguments = Object;
+
+/// This class hosts common interops for clients.
+class ClientCommon {
+  /// [deno-postgres@v0.17.0/Transaction/queryArray](https://deno.land/x/postgres@v0.17.0/mod.ts?s=Transaction#method_queryArray_0).
+  /// [deno-postgres@v0.17.0/QueryClient/queryArray](https://deno.land/x/postgres@v0.17.0/mod.ts?s=QueryClient#method_queryArray_0).
+  static Future<QueryArrayResult<T>> queryArray<T extends List<dynamic>>(
+    Object queryable,
+    String query, [
+    QueryArguments? arguments,
+  ]) =>
+      _query('queryArray', queryable, query, arguments);
+
+  /// [deno-postgres@v0.17.0/Transaction/queryArray](https://deno.land/x/postgres@v0.17.0/mod.ts?s=Transaction#method_queryArray_1).
+  /// [deno-postgres@v0.17.0/QueryClient/queryArray](https://deno.land/x/postgres@v0.17.0/mod.ts?s=QueryClient#method_queryArray_1).
+  static Future<QueryArrayResult<T>>
+      queryArrayWithOptions<T extends List<dynamic>>(
+    Object queryable,
+    QueryObjectOptions config,
+  ) =>
+          callFutureMethod(queryable, 'queryArray', [config]);
+
+  // This one won't be implemented because it doesn't make much sense for dart,
+  // the query here is of type TemplateStringsArray which is used in
+  // [tagged templates](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Template_literals#tagged_templates).
+  //
+  // [related issue](https://github.com/dart-lang/language/issues/1988).
+  //
+  // queryArray<T extends Array<unknown>>(
+  //   strings: TemplateStringsArray,
+  //   ...args: unknown[],
+  // ): Promise<QueryArrayResult<T>>
+  // https://deno.land/x/postgres@v0.17.0/mod.ts?s=QueryClient#method_queryArray_2
+
+  /// [deno-postgres@v0.17.0/Transaction/queryObject](https://deno.land/x/postgres@v0.17.0/mod.ts?s=Transaction#method_queryObject_0).
+  /// [deno-postgres@v0.17.0/QueryClient/queryObject](https://deno.land/x/postgres@v0.17.0/mod.ts?s=QueryClient#method_queryObject_0).
+  static Future<QueryObjectResult<T>> queryObject<T>(
+    Object queryable,
+    String query, [
+    QueryArguments? arguments,
+  ]) =>
+      _query('queryObject', queryable, query, arguments);
+
+  /// [deno-postgres@v0.17.0/Transaction/queryObject](https://deno.land/x/postgres@v0.17.0/mod.ts?s=Transaction#method_queryObject_1).
+  /// [deno-postgres@v0.17.0/QueryClient/queryObject](https://deno.land/x/postgres@v0.17.0/mod.ts?s=QueryClient#method_queryObject_1).
+  static Future<QueryObjectResult<T>> queryObjectWithOptions<T>(
+    Object queryable,
+    QueryObjectOptions config,
+  ) =>
+      callFutureMethod(queryable, 'queryObject', [config]);
+
+  // This one won't be implemented because it doesn't make much sense for dart,
+  // the query here is of type TemplateStringsArray which is used in
+  // [tagged templates](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Template_literals#tagged_templates).
+  //
+  // [related issue](https://github.com/dart-lang/language/issues/1988).
+  //
+  // [deno-postgres@v0.17.0/QueryClient/queryObject](https://deno.land/x/postgres@v0.17.0/mod.ts?s=QueryClient#method_queryObject_2).
+  // Future<QueryObjectResult<T>> queryObjectWithOptions<T>(
+  //   List<String> query,
+  //   List args,
+  // ) =>
+  //     throw UnimplementedError();
+
+  static Future<T> _query<T>(
+    String function,
+    Object queryable,
+    String query, [
+    QueryArguments? arguments,
+  ]) {
+    _assertQueryArgumentsOrNull(arguments);
+
+    return callFutureMethod(
+      queryable,
+      function,
+      [
+        query,
+        if (arguments != null) arguments,
+      ],
+    );
+  }
+}
+
+void _assertQueryArgumentsOrNull(QueryArguments? arguments) {
+  final isCorrectType = arguments is List ||
+      arguments is Map<String, dynamic> ||
+      arguments == null;
+
+  if (!isCorrectType) {
+    throw ArgumentError.value(
+      arguments,
+      'arguments',
+      'Accepted types are List<any> and Map<String, any>.',
+    );
+  }
+}

lib/src/query.dart

@@ -1,8 +1,8 @@
 import 'dart:js_interop';
 import 'dart:js_util';
 
+import 'package:deno_postgres_interop/src/client_common.dart';
 import 'package:deno_postgres_interop/src/encoded_arg.dart';
-import 'package:deno_postgres_interop/src/query_object.dart';
 import 'package:deno_postgres_interop/src/query_object_options.dart';
 import 'package:deno_postgres_interop/src/result_type.dart';
 

lib/src/query_array_result.dart

@@ -0,0 +1,14 @@
+import 'dart:js_interop';
+
+import 'package:deno_postgres_interop/src/query.dart';
+import 'package:deno_postgres_interop/src/query_result.dart';
+
+/// [deno-postgres@v0.17.0/QueryArrayResult](https://deno.land/x/postgres@v0.17.0/query/query.ts?s=QueryArrayResult).
+@JS()
+class QueryArrayResult<T extends List<dynamic>> extends QueryResult {
+  /// [deno-postgres@v0.17.0/QueryArrayResult/rows](https://deno.land/x/postgres@v0.17.0/query/query.ts?s=QueryArrayResult#prop_rows).
+  external List<T> get rows;
+
+  /// [deno-postgres@v0.17.0/QueryResult/constructor](https://deno.land/x/postgres@v0.17.0/query/query.ts?s=QueryResult#ctor_0).
+  external factory QueryArrayResult(Query query);
+}

lib/src/query_client.dart

@@ -1,7 +1,9 @@
 import 'dart:js_interop';
 import 'dart:js_util';
 
-import 'package:deno_postgres_interop/src/query_object.dart';
+import 'package:deno_postgres_interop/src/client_common.dart';
+import 'package:deno_postgres_interop/src/query_array_result.dart';
+import 'package:deno_postgres_interop/src/query_object_options.dart';
 import 'package:deno_postgres_interop/src/query_object_result.dart';
 import 'package:deno_postgres_interop/src/transaction.dart';
 import 'package:deno_postgres_interop/src/transaction_options.dart';
@@ -46,10 +48,29 @@ extension QueryClientProps on QueryClient {
     return result;
   }
 
+  /// [deno-postgres@v0.17.0/QueryClient/queryArray](https://deno.land/x/postgres@v0.17.0/mod.ts?s=QueryClient#method_queryArray_0).
+  Future<QueryArrayResult<T>> queryArray<T extends List<dynamic>>(
+    String query, [
+    QueryArguments? args,
+  ]) =>
+      ClientCommon.queryArray(this, query, args);
+
+  /// [deno-postgres@v0.17.0/QueryClient/queryArray](https://deno.land/x/postgres@v0.17.0/mod.ts?s=QueryClient#method_queryArray_1).
+  Future<QueryArrayResult<T>> queryArrayWithOptions<T extends List<dynamic>>(
+    QueryObjectOptions config,
+  ) =>
+      ClientCommon.queryArrayWithOptions(this, config);
+
   /// [deno-postgres@v0.17.0/QueryClient/queryObject](https://deno.land/x/postgres@v0.17.0/mod.ts?s=QueryClient#method_queryObject_0).
   Future<QueryObjectResult<T>> queryObject<T>(
     String query, [
     QueryArguments? arguments,
   ]) =>
-      queryObjectCommon(this, query, arguments);
+      ClientCommon.queryObject(this, query, arguments);
+
+  /// [deno-postgres@v0.17.0/QueryClient/queryObject](https://deno.land/x/postgres@v0.17.0/mod.ts?s=QueryClient#method_queryObject_1).
+  Future<QueryObjectResult<T>> queryObjectWithOptions<T>(
+    QueryObjectOptions config,
+  ) =>
+      ClientCommon.queryObjectWithOptions(this, config);
 }

lib/src/query_object_options.dart

@@ -3,13 +3,13 @@ import 'dart:js_util';
 
 import 'package:deno_postgres_interop/src/query_options.dart';
 
-/// [deno-postgres@v0.17.0/QueryObjectOptions](https://deno.land/x/postgres@v0.17.0/query/query.ts?s=QueryObjectOptions).
+/// [deno-postgres@v0.17.0/QueryObjectOptions](https://deno.land/x/postgres@v0.17.0/mod.ts?s=QueryObjectOptions).
 @JS()
 class QueryObjectOptions extends QueryOptions {
-  /// [deno-postgres@v0.17.0/QueryObjectOptions/fields](https://deno.land/x/postgres@v0.17.0/query/query.ts?s=QueryObjectOptions#prop_fields).
+  /// [deno-postgres@v0.17.0/QueryObjectOptions/fields](https://deno.land/x/postgres@v0.17.0/mod.ts?s=QueryClient#prop_fields).
   external List<String>? get fields;
 
-  /// [deno-postgres@v0.17.0/QueryObjectOptions](https://deno.land/x/postgres@v0.17.0/query/query.ts?s=QueryObjectOptions).
+  /// [deno-postgres@v0.17.0/QueryObjectOptions](https://deno.land/x/postgres@v0.17.0/query/mod.ts?s=QueryObjectOptions).
   factory QueryObjectOptions({List<String>? fields, bool? isCamelCase}) =>
       jsify(
         {
@@ -19,8 +19,8 @@ class QueryObjectOptions extends QueryOptions {
       ) as QueryObjectOptions;
 }
 
-/// [deno-postgres@v0.17.0/QueryObjectOptions](https://deno.land/x/postgres@v0.17.0/query/query.ts?s=QueryObjectOptions).
+/// [deno-postgres@v0.17.0/QueryObjectOptions](https://deno.land/x/postgres@v0.17.0/mod.ts?s=QueryObjectOptions).
 extension QueryObjectOptionsProps on QueryObjectOptions {
-  /// [deno-postgres@v0.17.0/QueryObjectOptions/camelcase](https://deno.land/x/postgres@v0.17.0/query/query.ts?s=QueryObjectOptions#prop_camelcase).
+  /// [deno-postgres@v0.17.0/QueryObjectOptions/camelcase](https://deno.land/x/postgres@v0.17.0/mod.ts?s=QueryClient#prop_camelcase).
   bool? get isCamelCase => getProperty(this, 'camelcase');
 }

lib/src/query_options.dart

@@ -1,7 +1,7 @@
 import 'dart:js_interop';
 import 'dart:js_util';
 
-import 'package:deno_postgres_interop/deno_postgres_interop.dart';
+import 'package:deno_postgres_interop/src/client_common.dart';
 import 'package:deno_postgres_interop/src/encoded_arg.dart';
 
 /// [deno-postgres@v0.17.0/QueryOptions](https://deno.land/x/postgres@v0.17.0/query/query.ts?s=QueryOptions).

lib/src/result_type.dart

@@ -1,4 +1,4 @@
-/// [postgres@v0.17.0/ResultType](https://deno.land/x/postgres@v0.17.0/query/query.ts?s=ResultType).
+/// [deno-postgres@v0.17.0/ResultType](https://deno.land/x/postgres@v0.17.0/query/query.ts?s=ResultType).
 enum ResultType {
   /// array.
   array,

lib/src/transaction.dart

@@ -1,6 +1,8 @@
 import 'dart:js_interop';
 
-import 'package:deno_postgres_interop/src/query_object.dart';
+import 'package:deno_postgres_interop/src/client_common.dart';
+import 'package:deno_postgres_interop/src/query_array_result.dart';
+import 'package:deno_postgres_interop/src/query_object_options.dart';
 import 'package:deno_postgres_interop/src/query_object_result.dart';
 import 'package:deno_postgres_interop/src/util.dart';
 
@@ -16,10 +18,29 @@ extension TransactionProps on Transaction {
   /// [deno-postgres@v0.17.0/Transaction/commit](https://deno.land/x/postgres@v0.17.0/mod.ts?s=Transaction#method_commit_0).
   Future<void> commit() => callFutureMethod(this, 'commit');
 
+  /// [deno-postgres@v0.17.0/Transaction/queryArray](https://deno.land/x/postgres@v0.17.0/mod.ts?s=Transaction#method_queryArray_0).
+  Future<QueryArrayResult<T>> queryArray<T extends List<dynamic>>(
+    String query, [
+    QueryArguments? args,
+  ]) =>
+      ClientCommon.queryArray(this, query, args);
+
+  /// [deno-postgres@v0.17.0/Transaction/queryArray](https://deno.land/x/postgres@v0.17.0/mod.ts?s=Transaction#method_queryArray_1).
+  Future<QueryArrayResult<T>> queryArrayWithOptions<T extends List<dynamic>>(
+    QueryObjectOptions config,
+  ) =>
+      ClientCommon.queryArrayWithOptions(this, config);
+
   /// [deno-postgres@v0.17.0/Transaction/queryObject](https://deno.land/x/postgres@v0.17.0/mod.ts?s=Transaction#method_queryObject_0).
   Future<QueryObjectResult<T>> queryObject<T>(
     String query, [
     QueryArguments? arguments,
   ]) =>
-      queryObjectCommon(this, query, arguments);
+      ClientCommon.queryObject(this, query, arguments);
+
+  /// [deno-postgres@v0.17.0/Transaction/queryObject](https://deno.land/x/postgres@v0.17.0/mod.ts?s=Transaction#method_queryObject_1).
+  Future<QueryObjectResult<T>> queryObjectWithOptions<T>(
+    QueryObjectOptions config,
+  ) =>
+      ClientCommon.queryObjectWithOptions(this, config);
 }