@pipedream/platform - npm Package Compare versions

Comparing version 1.6.3 to 1.6.4

dist/sql-proxy.js

@@ -11,3 +11,3 @@ "use strict";
          *
-         * @returns {ClientConfiguration} - Configuration object for the DB client
+         * @returns The configuration object for the DB client
          */
@@ -18,13 +18,11 @@ getClientConfiguration() {
         /**
-         * Executes a query against the database. This method takes care
-         * of connecting to the database, executing the query, and closing the
+         * Executes a query against the database. This method takes care of
+         * connecting to the database, executing the query, and closing the
          * connection.
          *
-         * @param args The query string or object to be sent to the DB.
-         * SQL query.
-         * @returns {Row[]} - The rows returned by the DB as a result of the
-         * query.
+         * @param args - The query string or object to be sent to the DB. SQL query.
+         * @returns The rows returned by the DB as a result of the query.
          */
         // eslint-disable-next-line @typescript-eslint/no-unused-vars
-        executeQuery(...args) {
+        executeQuery(args) {
             throw new errors_1.ConfigurationError("executeQuery not implemented");
@@ -37,10 +35,20 @@ },
          *
-         * @param args The query string or object to be sent to the DB.
-         * @returns {ProxyArgs} - The adapted query and parameters.
+         * @param args - The query string or object to be sent to the DB.
+         * @returns The adapted query and parameters.
          */
         // eslint-disable-next-line @typescript-eslint/no-unused-vars
-        proxyAdapter(...args) {
+        proxyAdapter(args) {
             throw new errors_1.ConfigurationError("proxyAdapter not implemented");
         },
+        /**
+         * A method that performs the inverse transformation of `proxyAdapter`.
+         *
+         * @param args - The output of `proxyAdapter`.
+         * @returns The query string or object to be sent to the DB.
+         */
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
+        executeQueryAdapter(args) {
+            throw new errors_1.ConfigurationError("executeQueryAdapter not implemented");
+        },
     },
 };

lib/sql-proxy.ts

@@ -8,2 +8,3 @@ import { ConfigurationError } from "./errors";
 };
+export type ExecuteQueryArgs = object | string;
 export type Row = object;
@@ -18,3 +19,3 @@
      *
-     * @returns {ClientConfiguration} - Configuration object for the DB client
+     * @returns The configuration object for the DB client
      */
@@ -26,13 +27,11 @@ getClientConfiguration(): ClientConfiguration {
     /**
-     * Executes a query against the database. This method takes care
-     * of connecting to the database, executing the query, and closing the
+     * Executes a query against the database. This method takes care of
+     * connecting to the database, executing the query, and closing the
      * connection.
      *
-     * @param args The query string or object to be sent to the DB.
-     * SQL query.
-     * @returns {Row[]} - The rows returned by the DB as a result of the
-     * query.
+     * @param args - The query string or object to be sent to the DB. SQL query.
+     * @returns The rows returned by the DB as a result of the query.
      */
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    executeQuery(...args: unknown[]): Row[] {
+    executeQuery(args: ExecuteQueryArgs): Row[] {
       throw new ConfigurationError("executeQuery not implemented");
@@ -46,10 +45,21 @@ },
      *
-     * @param args The query string or object to be sent to the DB.
-     * @returns {ProxyArgs} - The adapted query and parameters.
+     * @param args - The query string or object to be sent to the DB.
+     * @returns The adapted query and parameters.
      */
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    proxyAdapter(...args: unknown[]): ProxyArgs {
+    proxyAdapter(args: ExecuteQueryArgs): ProxyArgs {
       throw new ConfigurationError("proxyAdapter not implemented");
     },
+
+    /**
+     * A method that performs the inverse transformation of `proxyAdapter`.
+     *
+     * @param args - The output of `proxyAdapter`.
+     * @returns The query string or object to be sent to the DB.
+     */
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    executeQueryAdapter(args: ProxyArgs): ExecuteQueryArgs {
+      throw new ConfigurationError("executeQueryAdapter not implemented");
+    },
   },
 };

package.json

 {
   "name": "@pipedream/platform",
-  "version": "1.6.3",
+  "version": "1.6.4",
   "description": "Pipedream platform globals (typing and runtime type checking)",
@@ -5,0 +5,0 @@ "homepage": "https://pipedream.com",

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

48004

increased by1.71%

Lines of code

1273

increased by1.35%

No dependency changes