@elaraai/east-node-io 0.0.1-beta.0 → 0.0.1-beta.2

package/dist/sql/types.d.ts

@@ -0,0 +1,205 @@
+/**
+ * Copyright (c) 2025 Elara AI Pty Ltd
+ * Dual-licensed under AGPL-3.0 and commercial license. See LICENSE for details.
+ */
+/**
+ * Shared SQL type definitions for East Node IO.
+ *
+ * Provides East type definitions for SQL database operations including
+ * connection configurations, query parameters, and result types.
+ *
+ * @packageDocumentation
+ */
+import { StructType, VariantType, OptionType, ArrayType, DictType, StringType, IntegerType, BooleanType } from "@elaraai/east";
+export { StringType } from "@elaraai/east";
+/**
+ * SQLite database connection configuration.
+ *
+ * Configures a connection to a SQLite database file or in-memory database.
+ */
+export declare const SqliteConfigType: StructType<{
+    /**
+     * Path to the SQLite database file.
+     * Use ":memory:" for in-memory database.
+     */
+    path: StringType;
+    /**
+     * Open database in read-only mode.
+     * Optional, defaults to false (read-write).
+     */
+    readOnly: OptionType<BooleanType>;
+    /**
+     * Use in-memory database.
+     * Optional, defaults to false.
+     */
+    memory: OptionType<BooleanType>;
+}>;
+/**
+ * PostgreSQL database connection configuration.
+ *
+ * Configures a connection pool to a PostgreSQL database server.
+ */
+export declare const PostgresConfigType: StructType<{
+    /** PostgreSQL server hostname or IP address */
+    host: StringType;
+    /** PostgreSQL server port (typically 5432) */
+    port: IntegerType;
+    /** Database name to connect to */
+    database: StringType;
+    /** Username for authentication */
+    user: StringType;
+    /** Password for authentication */
+    password: StringType;
+    /**
+     * Enable SSL/TLS connection.
+     * Optional, defaults to false.
+     */
+    ssl: OptionType<BooleanType>;
+    /**
+     * Maximum number of connections in the pool.
+     * Optional, defaults to 10.
+     */
+    maxConnections: OptionType<IntegerType>;
+}>;
+/**
+ * MySQL database connection configuration.
+ *
+ * Configures a connection pool to a MySQL database server.
+ */
+export declare const MySqlConfigType: StructType<{
+    /** MySQL server hostname or IP address */
+    host: StringType;
+    /** MySQL server port (typically 3306) */
+    port: IntegerType;
+    /** Database name to connect to */
+    database: StringType;
+    /** Username for authentication */
+    user: StringType;
+    /** Password for authentication */
+    password: StringType;
+    /**
+     * Enable SSL/TLS connection.
+     * Optional, defaults to false.
+     */
+    ssl: OptionType<BooleanType>;
+    /**
+     * Maximum number of connections in the pool.
+     * Optional, defaults to 10.
+     */
+    maxConnections: OptionType<IntegerType>;
+}>;
+/**
+ * SQL query parameter value type.
+ *
+ * Represents a typed value that can be used as a parameter in SQL queries.
+ * Supports all common SQL types with proper type safety.
+ *
+ * @remarks
+ * Use East.variant() to create parameter values:
+ * - `East.variant("string", "text")`
+ * - `East.variant("int", 42n)`
+ * - `East.variant("float", 3.14)`
+ * - `East.variant("bool", true)`
+ * - `East.variant("null", {})`
+ * - `East.variant("blob", new Uint8Array([1, 2, 3]))`
+ */
+export declare const SqlParameterType: VariantType<{
+    Null: import("@elaraai/east").NullType;
+    Boolean: BooleanType;
+    Integer: IntegerType;
+    Float: import("@elaraai/east").FloatType;
+    String: StringType;
+    DateTime: import("@elaraai/east").DateTimeType;
+    Blob: import("@elaraai/east").BlobType;
+}>;
+/**
+ * Array of SQL query parameters.
+ *
+ * Used to pass parameters to parameterized SQL queries.
+ */
+export declare const SqlParametersType: ArrayType<VariantType<{
+    Null: import("@elaraai/east").NullType;
+    Boolean: BooleanType;
+    Integer: IntegerType;
+    Float: import("@elaraai/east").FloatType;
+    String: StringType;
+    DateTime: import("@elaraai/east").DateTimeType;
+    Blob: import("@elaraai/east").BlobType;
+}>>;
+/**
+ * SQL query result row.
+ *
+ * Represents a single row from a query result as a dictionary mapping
+ * column names to typed values.
+ */
+export declare const SqlRowType: DictType<StringType, VariantType<{
+    Null: import("@elaraai/east").NullType;
+    Boolean: BooleanType;
+    Integer: IntegerType;
+    Float: import("@elaraai/east").FloatType;
+    String: StringType;
+    DateTime: import("@elaraai/east").DateTimeType;
+    Blob: import("@elaraai/east").BlobType;
+}>>;
+/**
+ * SQL query execution result.
+ *
+ * A variant type representing different query result types:
+ * - `select`: Results from SELECT queries with rows
+ * - `insert`: Results from INSERT with affected rows and optional last insert ID
+ * - `update`: Results from UPDATE with affected rows
+ * - `delete`: Results from DELETE with affected rows
+ *
+ * @remarks
+ * Using variants allows type-safe handling of different query types.
+ */
+export declare const SqlResultType: VariantType<{
+    /**
+     * SELECT query result with rows.
+     */
+    select: StructType<{
+        /** Array of rows returned by the query */
+        rows: ArrayType<DictType<StringType, VariantType<{
+            Null: import("@elaraai/east").NullType;
+            Boolean: BooleanType;
+            Integer: IntegerType;
+            Float: import("@elaraai/east").FloatType;
+            String: StringType;
+            DateTime: import("@elaraai/east").DateTimeType;
+            Blob: import("@elaraai/east").BlobType;
+        }>>>;
+    }>;
+    /**
+     * INSERT query result with metadata.
+     */
+    insert: StructType<{
+        /** Number of rows inserted */
+        rowsAffected: IntegerType;
+        /** Last inserted row ID (database-specific, may be None) */
+        lastInsertId: OptionType<IntegerType>;
+    }>;
+    /**
+     * UPDATE query result with metadata.
+     */
+    update: StructType<{
+        /** Number of rows updated */
+        rowsAffected: IntegerType;
+    }>;
+    /**
+     * DELETE query result with metadata.
+     */
+    delete: StructType<{
+        /** Number of rows deleted */
+        rowsAffected: IntegerType;
+    }>;
+}>;
+/**
+ * Opaque connection handle type.
+ *
+ * Represents an active database connection.
+ * Handles are created by connect() functions and used in query operations.
+ *
+ * @internal
+ */
+export declare const ConnectionHandleType: StringType;
+//# sourceMappingURL=types.d.ts.map

package/dist/sql/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/sql/types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;;;GAOG;AAEH,OAAO,EACH,UAAU,EACV,WAAW,EACX,UAAU,EACV,SAAS,EACT,QAAQ,EACR,UAAU,EACV,WAAW,EACX,WAAW,EACd,MAAM,eAAe,CAAC;AAIvB,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAE3C;;;;GAIG;AACH,eAAO,MAAM,gBAAgB;IACzB;;;OAGG;;IAGH;;;OAGG;;IAGH;;;OAGG;;EAEL,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,kBAAkB;IAC3B,+CAA+C;;IAG/C,8CAA8C;;IAG9C,kCAAkC;;IAGlC,kCAAkC;;IAGlC,kCAAkC;;IAGlC;;;OAGG;;IAGH;;;OAGG;;EAEL,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,eAAe;IACxB,0CAA0C;;IAG1C,yCAAyC;;IAGzC,kCAAkC;;IAGlC,kCAAkC;;IAGlC,kCAAkC;;IAGlC;;;OAGG;;IAGH;;;OAGG;;EAEL,CAAC;AAEH;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,gBAAgB;;;;;;;;EAAmB,CAAC;AAEjD;;;;GAIG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;GAA8B,CAAC;AAE7D;;;;;GAKG;AACH,eAAO,MAAM,UAAU;;;;;;;;GAAyC,CAAC;AAEjE;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,aAAa;IACtB;;OAEG;;QAEC,0CAA0C;;;;;;;;;;;IAI9C;;OAEG;;QAEC,8BAA8B;;QAE9B,4DAA4D;;;IAIhE;;OAEG;;QAEC,6BAA6B;;;IAIjC;;OAEG;;QAEC,6BAA6B;;;EAGnC,CAAC;AAEH;;;;;;;GAOG;AACH,eAAO,MAAM,oBAAoB,YAAa,CAAC"}

package/dist/sql/types.js

@@ -0,0 +1,175 @@
+/**
+ * Copyright (c) 2025 Elara AI Pty Ltd
+ * Dual-licensed under AGPL-3.0 and commercial license. See LICENSE for details.
+ */
+/**
+ * Shared SQL type definitions for East Node IO.
+ *
+ * Provides East type definitions for SQL database operations including
+ * connection configurations, query parameters, and result types.
+ *
+ * @packageDocumentation
+ */
+import { StructType, VariantType, OptionType, ArrayType, DictType, StringType, IntegerType, BooleanType, } from "@elaraai/east";
+import { LiteralValueType } from "@elaraai/east/internal";
+// Re-export StringType for use in other SQL modules
+export { StringType } from "@elaraai/east";
+/**
+ * SQLite database connection configuration.
+ *
+ * Configures a connection to a SQLite database file or in-memory database.
+ */
+export const SqliteConfigType = StructType({
+    /**
+     * Path to the SQLite database file.
+     * Use ":memory:" for in-memory database.
+     */
+    path: StringType,
+    /**
+     * Open database in read-only mode.
+     * Optional, defaults to false (read-write).
+     */
+    readOnly: OptionType(BooleanType),
+    /**
+     * Use in-memory database.
+     * Optional, defaults to false.
+     */
+    memory: OptionType(BooleanType),
+});
+/**
+ * PostgreSQL database connection configuration.
+ *
+ * Configures a connection pool to a PostgreSQL database server.
+ */
+export const PostgresConfigType = StructType({
+    /** PostgreSQL server hostname or IP address */
+    host: StringType,
+    /** PostgreSQL server port (typically 5432) */
+    port: IntegerType,
+    /** Database name to connect to */
+    database: StringType,
+    /** Username for authentication */
+    user: StringType,
+    /** Password for authentication */
+    password: StringType,
+    /**
+     * Enable SSL/TLS connection.
+     * Optional, defaults to false.
+     */
+    ssl: OptionType(BooleanType),
+    /**
+     * Maximum number of connections in the pool.
+     * Optional, defaults to 10.
+     */
+    maxConnections: OptionType(IntegerType),
+});
+/**
+ * MySQL database connection configuration.
+ *
+ * Configures a connection pool to a MySQL database server.
+ */
+export const MySqlConfigType = StructType({
+    /** MySQL server hostname or IP address */
+    host: StringType,
+    /** MySQL server port (typically 3306) */
+    port: IntegerType,
+    /** Database name to connect to */
+    database: StringType,
+    /** Username for authentication */
+    user: StringType,
+    /** Password for authentication */
+    password: StringType,
+    /**
+     * Enable SSL/TLS connection.
+     * Optional, defaults to false.
+     */
+    ssl: OptionType(BooleanType),
+    /**
+     * Maximum number of connections in the pool.
+     * Optional, defaults to 10.
+     */
+    maxConnections: OptionType(IntegerType),
+});
+/**
+ * SQL query parameter value type.
+ *
+ * Represents a typed value that can be used as a parameter in SQL queries.
+ * Supports all common SQL types with proper type safety.
+ *
+ * @remarks
+ * Use East.variant() to create parameter values:
+ * - `East.variant("string", "text")`
+ * - `East.variant("int", 42n)`
+ * - `East.variant("float", 3.14)`
+ * - `East.variant("bool", true)`
+ * - `East.variant("null", {})`
+ * - `East.variant("blob", new Uint8Array([1, 2, 3]))`
+ */
+export const SqlParameterType = LiteralValueType;
+/**
+ * Array of SQL query parameters.
+ *
+ * Used to pass parameters to parameterized SQL queries.
+ */
+export const SqlParametersType = ArrayType(SqlParameterType);
+/**
+ * SQL query result row.
+ *
+ * Represents a single row from a query result as a dictionary mapping
+ * column names to typed values.
+ */
+export const SqlRowType = DictType(StringType, SqlParameterType);
+/**
+ * SQL query execution result.
+ *
+ * A variant type representing different query result types:
+ * - `select`: Results from SELECT queries with rows
+ * - `insert`: Results from INSERT with affected rows and optional last insert ID
+ * - `update`: Results from UPDATE with affected rows
+ * - `delete`: Results from DELETE with affected rows
+ *
+ * @remarks
+ * Using variants allows type-safe handling of different query types.
+ */
+export const SqlResultType = VariantType({
+    /**
+     * SELECT query result with rows.
+     */
+    select: StructType({
+        /** Array of rows returned by the query */
+        rows: ArrayType(SqlRowType),
+    }),
+    /**
+     * INSERT query result with metadata.
+     */
+    insert: StructType({
+        /** Number of rows inserted */
+        rowsAffected: IntegerType,
+        /** Last inserted row ID (database-specific, may be None) */
+        lastInsertId: OptionType(IntegerType),
+    }),
+    /**
+     * UPDATE query result with metadata.
+     */
+    update: StructType({
+        /** Number of rows updated */
+        rowsAffected: IntegerType,
+    }),
+    /**
+     * DELETE query result with metadata.
+     */
+    delete: StructType({
+        /** Number of rows deleted */
+        rowsAffected: IntegerType,
+    }),
+});
+/**
+ * Opaque connection handle type.
+ *
+ * Represents an active database connection.
+ * Handles are created by connect() functions and used in query operations.
+ *
+ * @internal
+ */
+export const ConnectionHandleType = StringType;
+//# sourceMappingURL=types.js.map

package/dist/sql/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/sql/types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;;;GAOG;AAEH,OAAO,EACH,UAAU,EACV,WAAW,EACX,UAAU,EACV,SAAS,EACT,QAAQ,EACR,UAAU,EACV,WAAW,EACX,WAAW,GACd,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAE1D,oDAAoD;AACpD,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAE3C;;;;GAIG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,UAAU,CAAC;IACvC;;;OAGG;IACH,IAAI,EAAE,UAAU;IAEhB;;;OAGG;IACH,QAAQ,EAAE,UAAU,CAAC,WAAW,CAAC;IAEjC;;;OAGG;IACH,MAAM,EAAE,UAAU,CAAC,WAAW,CAAC;CAClC,CAAC,CAAC;AAEH;;;;GAIG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,UAAU,CAAC;IACzC,+CAA+C;IAC/C,IAAI,EAAE,UAAU;IAEhB,8CAA8C;IAC9C,IAAI,EAAE,WAAW;IAEjB,kCAAkC;IAClC,QAAQ,EAAE,UAAU;IAEpB,kCAAkC;IAClC,IAAI,EAAE,UAAU;IAEhB,kCAAkC;IAClC,QAAQ,EAAE,UAAU;IAEpB;;;OAGG;IACH,GAAG,EAAE,UAAU,CAAC,WAAW,CAAC;IAE5B;;;OAGG;IACH,cAAc,EAAE,UAAU,CAAC,WAAW,CAAC;CAC1C,CAAC,CAAC;AAEH;;;;GAIG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,UAAU,CAAC;IACtC,0CAA0C;IAC1C,IAAI,EAAE,UAAU;IAEhB,yCAAyC;IACzC,IAAI,EAAE,WAAW;IAEjB,kCAAkC;IAClC,QAAQ,EAAE,UAAU;IAEpB,kCAAkC;IAClC,IAAI,EAAE,UAAU;IAEhB,kCAAkC;IAClC,QAAQ,EAAE,UAAU;IAEpB;;;OAGG;IACH,GAAG,EAAE,UAAU,CAAC,WAAW,CAAC;IAE5B;;;OAGG;IACH,cAAc,EAAE,UAAU,CAAC,WAAW,CAAC;CAC1C,CAAC,CAAC;AAEH;;;;;;;;;;;;;;GAcG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,gBAAgB,CAAC;AAEjD;;;;GAIG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,SAAS,CAAC,gBAAgB,CAAC,CAAC;AAE7D;;;;;GAKG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,QAAQ,CAAC,UAAU,EAAE,gBAAgB,CAAC,CAAC;AAEjE;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,WAAW,CAAC;IACrC;;OAEG;IACH,MAAM,EAAE,UAAU,CAAC;QACf,0CAA0C;QAC1C,IAAI,EAAE,SAAS,CAAC,UAAU,CAAC;KAC9B,CAAC;IAEF;;OAEG;IACH,MAAM,EAAE,UAAU,CAAC;QACf,8BAA8B;QAC9B,YAAY,EAAE,WAAW;QACzB,4DAA4D;QAC5D,YAAY,EAAE,UAAU,CAAC,WAAW,CAAC;KACxC,CAAC;IAEF;;OAEG;IACH,MAAM,EAAE,UAAU,CAAC;QACf,6BAA6B;QAC7B,YAAY,EAAE,WAAW;KAC5B,CAAC;IAEF;;OAEG;IACH,MAAM,EAAE,UAAU,CAAC;QACf,6BAA6B;QAC7B,YAAY,EAAE,WAAW;KAC5B,CAAC;CACL,CAAC,CAAC;AAEH;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,UAAU,CAAC"}