@pipedream/platform - npm Package Compare versions

Comparing version 1.6.5 to 1.6.6

dist/index.d.ts

@@ -8,2 +8,3 @@ import * as t from "io-ts";
 export { default as sqlProp, } from "./sql-prop";
+export type { ColumnSchema, DbInfo, TableInfo, TableMetadata, TableSchema, } from "./sql-prop";
 export { default as sqlProxy, } from "./sql-proxy";
@@ -10,0 +11,0 @@ export { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL, } from "./constants";

dist/sql-prop.d.ts

 import { JsonPrimitive } from "type-fest";
-export declare type DbSchema = {
-    [tableName: string]: {
-        [columnName: string]: {
-            columnDefault: JsonPrimitive;
-            dataType: string;
-            isNullable: boolean;
-            tableSchema?: string;
-        };
-    };
+import { ExecuteQueryArgs } from "./sql";
+export declare type ColumnSchema = {
+    columnDefault: JsonPrimitive;
+    dataType: string;
+    isNullable: boolean;
+    tableSchema?: string;
 };
-export declare type RowCount = {
-    [tableName: string]: {
-        _rowCount?: number;
-    };
+export declare type TableMetadata = {
+    rowCount?: number;
 };
+export declare type TableSchema = {
+    [columnName: string]: ColumnSchema;
+};
+export declare type TableInfo = {
+    metadata: TableMetadata;
+    schema: TableSchema;
+};
+export declare type DbInfo = {
+    [tableName: string]: TableInfo;
+};
+export declare type SqlProp = {
+    query: string;
+    params?: string[];
+};
 declare const _default: {
     methods: {
         /**
+         * A method that transforms the value of a prop of type `sql` so that it can
+         * be fed to the `executeQuery` method.
+         *
+         * @param sqlProp - The prop of type `sql`
+         * @returns The arguments to be passed to `executeQuery`
+         */
+        executeQueryAdapter(sqlProp: SqlProp): ExecuteQueryArgs;
+        /**
          * A helper method to get the schema of the database. Used by other features
@@ -24,9 +41,9 @@ * (like the `sql` prop) to enrich the code editor and provide the user with
          *
-         * @returns {DbSchema} The schema of the database, which is a
+         * @returns {DbInfo} The schema of the database, which is a
          * JSON-serializable object.
          * @throws {ConfigurationError} If the method is not implemented.
          */
-        getSchema(): DbSchema | RowCount;
+        getSchema(): DbInfo;
     };
 };
 export default _default;

dist/sql-prop.js

@@ -7,2 +7,13 @@ "use strict";
         /**
+         * A method that transforms the value of a prop of type `sql` so that it can
+         * be fed to the `executeQuery` method.
+         *
+         * @param sqlProp - The prop of type `sql`
+         * @returns The arguments to be passed to `executeQuery`
+         */
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
+        executeQueryAdapter(sqlProp) {
+            throw new errors_1.ConfigurationError("executeQueryAdapter not implemented");
+        },
+        /**
          * A helper method to get the schema of the database. Used by other features
@@ -12,3 +23,3 @@ * (like the `sql` prop) to enrich the code editor and provide the user with
          *
-         * @returns {DbSchema} The schema of the database, which is a
+         * @returns {DbInfo} The schema of the database, which is a
          * JSON-serializable object.
@@ -15,0 +26,0 @@ * @throws {ConfigurationError} If the method is not implemented.

dist/sql-proxy.d.ts

@@ -0,1 +1,2 @@
+import { ExecuteQueryArgs } from "./sql";
 export declare type ClientConfiguration = object;
@@ -6,3 +7,2 @@ export declare type ProxyArgs = {
 };
-export declare type ExecuteQueryArgs = object | string;
 export declare type Row = object;
@@ -37,11 +37,4 @@ declare const _default: {
         proxyAdapter(args: ExecuteQueryArgs): ProxyArgs;
-        /**
-         * 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.
-         */
-        executeQueryAdapter(args: ProxyArgs): ExecuteQueryArgs;
     };
 };
 export default _default;

dist/sql-proxy.js

@@ -40,13 +40,3 @@ "use strict";
         },
-        /**
-         * 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/index.ts

@@ -20,2 +20,9 @@ import * as t from "io-ts";
 } from "./sql-prop";
+export type {
+  ColumnSchema,
+  DbInfo,
+  TableInfo,
+  TableMetadata,
+  TableSchema,
+} from "./sql-prop";
 
@@ -22,0 +29,0 @@ export {

lib/sql-prop.ts

 import { ConfigurationError } from "./errors";
 import { JsonPrimitive } from "type-fest";
+import { ExecuteQueryArgs } from "./sql";
 
-export type DbSchema = {
-  [tableName: string]: {
-    [columnName: string]: {
-      columnDefault: JsonPrimitive;
-      dataType: string;
-      isNullable: boolean;
-      tableSchema?: string;
-    };
-  };
+export type ColumnSchema = {
+  columnDefault: JsonPrimitive;
+  dataType: string;
+  isNullable: boolean;
+  tableSchema?: string;
 };
 
-export type RowCount = {
-  [tableName: string]: {
-    _rowCount?: number;
-  };
+export type TableMetadata = {
+  rowCount?: number;
 };
 
+export type TableSchema = {
+  [columnName: string]: ColumnSchema;
+};
+
+export type TableInfo = {
+  metadata: TableMetadata;
+  schema: TableSchema;
+};
+
+export type DbInfo = {
+  [tableName: string]: TableInfo;
+};
+
+export type SqlProp = {
+  query: string;
+  params?: string[];
+};
+
 export default {
   methods: {
     /**
+     * A method that transforms the value of a prop of type `sql` so that it can
+     * be fed to the `executeQuery` method.
+     *
+     * @param sqlProp - The prop of type `sql`
+     * @returns The arguments to be passed to `executeQuery`
+     */
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    executeQueryAdapter(sqlProp: SqlProp): ExecuteQueryArgs {
+      throw new ConfigurationError("executeQueryAdapter not implemented");
+    },
+
+    /**
      * A helper method to get the schema of the database. Used by other features
@@ -28,7 +53,7 @@ * (like the `sql` prop) to enrich the code editor and provide the user with
      *
-     * @returns {DbSchema} The schema of the database, which is a
+     * @returns {DbInfo} The schema of the database, which is a
      * JSON-serializable object.
      * @throws {ConfigurationError} If the method is not implemented.
      */
-    getSchema(): DbSchema | RowCount {
+    getSchema(): DbInfo {
       throw new ConfigurationError("getSchema not implemented");
@@ -35,0 +60,0 @@ },

lib/sql-proxy.ts

 import { ConfigurationError } from "./errors";
+import { ExecuteQueryArgs } from "./sql";
 
@@ -8,3 +9,2 @@ export type ClientConfiguration = object;
 };
-export type ExecuteQueryArgs = object | string;
 export type Row = object;
@@ -50,14 +50,3 @@
     },
-
-    /**
-     * 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.5",
+  "version": "1.6.6",
   "description": "Pipedream platform globals (typing and runtime type checking)",
@@ -15,3 +15,3 @@ "homepage": "https://pipedream.com",
   "dependencies": {
-    "axios": "^1.6.5",
+    "axios": "^1.7.4",
     "fp-ts": "^2.0.2",
@@ -18,0 +18,0 @@ "io-ts": "^2.0.0",

No alert changes

Improved metrics

Total package byte prevSize

57262

increased by1.6%

Number of package files

31

increased by10.71%

Lines of code

1549

increased by2.18%

Dependency changes

• Updatedaxios@^1.7.4