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

package/dist/transfer/sftp.js

@@ -0,0 +1,436 @@
+/**
+ * Copyright (c) 2025 Elara AI Pty Ltd
+ * Dual-licensed under AGPL-3.0 and commercial license. See LICENSE for details.
+ */
+/**
+ * SFTP platform functions for East Node IO.
+ *
+ * Provides SFTP (SSH File Transfer Protocol) operations for East programs,
+ * including upload, download, list, and delete operations.
+ *
+ * @packageDocumentation
+ */
+import { East, BlobType, ArrayType, NullType } from "@elaraai/east";
+import { EastError } from "@elaraai/east/internal";
+import SftpClient from "ssh2-sftp-client";
+import { createHandle, getConnection, closeHandle, closeAllHandles } from '../connection/index.js';
+import { SftpConfigType, ConnectionHandleType, StringType, FileInfoType } from "./types.js";
+/**
+ * Connects to an SFTP server.
+ *
+ * Creates a connection to an SFTP server and returns an opaque handle
+ * for use in file transfer operations.
+ *
+ * This is a platform function for the East language, enabling SFTP file transfer
+ * operations in East programs running on Node.js.
+ *
+ * @param config - SFTP connection configuration
+ * @returns Connection handle (opaque string)
+ *
+ * @throws {EastError} When connection fails due to:
+ * - Invalid hostname or port (location: "sftp_connect")
+ * - Authentication failure (location: "sftp_connect")
+ * - Network errors (location: "sftp_connect")
+ * - SSH key errors (location: "sftp_connect")
+ *
+ * @example
+ * ```ts
+ * import { East, StringType, BlobType } from "@elaraai/east";
+ * import { Transfer } from "@elaraai/east-node-io";
+ *
+ * const uploadToSftp = East.function([StringType, BlobType], NullType, ($, filename, data) => {
+ *     const config = $.let({
+ *         host: "sftp.example.com",
+ *         port: 22n,
+ *         username: "user",
+ *         password: East.some("password"),
+ *         privateKey: East.none(),
+ *     });
+ *
+ *     const conn = $.let(Transfer.SFTP.connect(config));
+ *     $(Transfer.SFTP.put(conn, filename, data));
+ *     $(Transfer.SFTP.close(conn));
+ * });
+ *
+ * const compiled = East.compileAsync(uploadToSftp.toIR(), Transfer.SFTP.Implementation);
+ * await compiled("file.txt", fileData);
+ * ```
+ *
+ * @remarks
+ * - Supports password and private key authentication
+ * - Connection is maintained until explicitly closed
+ * - All operations are asynchronous (use East.compileAsync)
+ */
+export const sftp_connect = East.asyncPlatform("sftp_connect", [SftpConfigType], ConnectionHandleType);
+/**
+ * Uploads a file to an SFTP server.
+ *
+ * Uploads binary data to the SFTP server at the specified remote path.
+ * Overwrites existing files with the same path.
+ *
+ * This is a platform function for the East language, enabling SFTP file transfer
+ * operations in East programs running on Node.js.
+ *
+ * @param handle - Connection handle from sftp_connect()
+ * @param remotePath - Remote file path on the SFTP server
+ * @param data - Binary data to upload
+ * @returns Null on success
+ *
+ * @throws {EastError} When upload fails due to:
+ * - Invalid connection handle (location: "sftp_put")
+ * - Permission denied (location: "sftp_put")
+ * - Invalid remote path (location: "sftp_put")
+ * - Network errors (location: "sftp_put")
+ *
+ * @example
+ * ```ts
+ * import { East, StringType, BlobType, NullType, variant } from "@elaraai/east";
+ * import { Transfer } from "@elaraai/east-node-io";
+ *
+ * const uploadFile = East.function([StringType, BlobType], NullType, ($, filename, data) => {
+ *     const config = $.let({
+ *         host: "sftp.example.com",
+ *         port: 22n,
+ *         username: "user",
+ *         password: variant('some', "password"),
+ *         privateKey: variant('none', null),
+ *     });
+ *     const conn = $.let(Transfer.SFTP.connect(config));
+ *     $(Transfer.SFTP.put(conn, `/uploads/${filename}`, data));
+ *     $(Transfer.SFTP.close(conn));
+ *     return $.return(null);
+ * });
+ *
+ * const compiled = East.compileAsync(uploadFile.toIR(), Transfer.SFTP.Implementation);
+ * await compiled("file.txt", fileData);
+ * ```
+ *
+ * @remarks
+ * - Creates parent directories if they don't exist
+ * - Overwrites existing files
+ * - Binary mode transfer
+ */
+export const sftp_put = East.asyncPlatform("sftp_put", [ConnectionHandleType, StringType, BlobType], NullType);
+/**
+ * Downloads a file from an SFTP server.
+ *
+ * Retrieves binary data from the SFTP server at the specified remote path.
+ * Returns the file data as a Blob (Uint8Array).
+ *
+ * This is a platform function for the East language, enabling SFTP file transfer
+ * operations in East programs running on Node.js.
+ *
+ * @param handle - Connection handle from sftp_connect()
+ * @param remotePath - Remote file path on the SFTP server
+ * @returns Binary data as Blob
+ *
+ * @throws {EastError} When download fails due to:
+ * - Invalid connection handle (location: "sftp_get")
+ * - File not found (location: "sftp_get")
+ * - Permission denied (location: "sftp_get")
+ * - Network errors (location: "sftp_get")
+ *
+ * @example
+ * ```ts
+ * import { East, StringType, BlobType, variant } from "@elaraai/east";
+ * import { Transfer } from "@elaraai/east-node-io";
+ *
+ * const downloadFile = East.function([StringType], BlobType, ($, filename) => {
+ *     const config = $.let({
+ *         host: "sftp.example.com",
+ *         port: 22n,
+ *         username: "user",
+ *         password: variant('some', "password"),
+ *         privateKey: variant('none', null),
+ *     });
+ *     const conn = $.let(Transfer.SFTP.connect(config));
+ *     const data = $.let(Transfer.SFTP.get(conn, `/downloads/${filename}`));
+ *     $(Transfer.SFTP.close(conn));
+ *     return $.return(data);
+ * });
+ *
+ * const compiled = East.compileAsync(downloadFile.toIR(), Transfer.SFTP.Implementation);
+ * const fileData = await compiled("file.txt");  // Returns Uint8Array
+ * ```
+ *
+ * @remarks
+ * - Binary mode transfer
+ * - Entire file is loaded into memory
+ */
+export const sftp_get = East.asyncPlatform("sftp_get", [ConnectionHandleType, StringType], BlobType);
+/**
+ * Lists files in an SFTP directory.
+ *
+ * Retrieves a list of files and directories at the specified remote path.
+ * Returns metadata for each file including name, size, and modification time.
+ *
+ * This is a platform function for the East language, enabling SFTP file transfer
+ * operations in East programs running on Node.js.
+ *
+ * @param handle - Connection handle from sftp_connect()
+ * @param remotePath - Remote directory path on the SFTP server
+ * @returns Array of file information metadata
+ *
+ * @throws {EastError} When listing fails due to:
+ * - Invalid connection handle (location: "sftp_list")
+ * - Directory not found (location: "sftp_list")
+ * - Permission denied (location: "sftp_list")
+ * - Network errors (location: "sftp_list")
+ *
+ * @example
+ * ```ts
+ * import { East, StringType, ArrayType, variant } from "@elaraai/east";
+ * import { Transfer } from "@elaraai/east-node-io";
+ *
+ * const listFiles = East.function([StringType], ArrayType(Transfer.SFTP.Types.FileInfo), ($, remotePath) => {
+ *     const config = $.let({
+ *         host: "sftp.example.com",
+ *         port: 22n,
+ *         username: "user",
+ *         password: variant('some', "password"),
+ *         privateKey: variant('none', null),
+ *     });
+ *     const conn = $.let(Transfer.SFTP.connect(config));
+ *     const files = $.let(Transfer.SFTP.list(conn, remotePath));
+ *     $(Transfer.SFTP.close(conn));
+ *     return $.return(files);
+ * });
+ *
+ * const compiled = East.compileAsync(listFiles.toIR(), Transfer.SFTP.Implementation);
+ * const uploads = await compiled("/uploads");  // [{name: "file.txt", size: 1024n, ...}, ...]
+ * ```
+ *
+ * @remarks
+ * - Returns both files and directories
+ * - Use isDirectory field to distinguish between files and directories
+ */
+export const sftp_list = East.asyncPlatform("sftp_list", [ConnectionHandleType, StringType], ArrayType(FileInfoType));
+/**
+ * Deletes a file from an SFTP server.
+ *
+ * Removes a file from the SFTP server at the specified remote path.
+ * Does not delete directories.
+ *
+ * This is a platform function for the East language, enabling SFTP file transfer
+ * operations in East programs running on Node.js.
+ *
+ * @param handle - Connection handle from sftp_connect()
+ * @param remotePath - Remote file path to delete
+ * @returns Null on success
+ *
+ * @throws {EastError} When deletion fails due to:
+ * - Invalid connection handle (location: "sftp_delete")
+ * - File not found (location: "sftp_delete")
+ * - Permission denied (location: "sftp_delete")
+ * - Network errors (location: "sftp_delete")
+ *
+ * @example
+ * ```ts
+ * import { East, StringType, NullType, variant } from "@elaraai/east";
+ * import { Transfer } from "@elaraai/east-node-io";
+ *
+ * const deleteFile = East.function([StringType], NullType, ($, filename) => {
+ *     const config = $.let({
+ *         host: "sftp.example.com",
+ *         port: 22n,
+ *         username: "user",
+ *         password: variant('some', "password"),
+ *         privateKey: variant('none', null),
+ *     });
+ *     const conn = $.let(Transfer.SFTP.connect(config));
+ *     $(Transfer.SFTP.delete(conn, `/uploads/${filename}`));
+ *     $(Transfer.SFTP.close(conn));
+ *     return $.return(null);
+ * });
+ *
+ * const compiled = East.compileAsync(deleteFile.toIR(), Transfer.SFTP.Implementation);
+ * await compiled("old-file.txt");
+ * ```
+ *
+ * @remarks
+ * - Only deletes files, not directories
+ * - Throws error if file doesn't exist
+ */
+export const sftp_delete = East.asyncPlatform("sftp_delete", [ConnectionHandleType, StringType], NullType);
+/**
+ * Closes an SFTP connection.
+ *
+ * Closes the SFTP connection and releases all resources.
+ * The handle becomes invalid after this operation.
+ *
+ * @param handle - Connection handle from sftp_connect()
+ * @returns Null on success
+ *
+ * @throws {EastError} When handle is invalid (location: "sftp_close")
+ *
+ * @example
+ * ```ts
+ * import { East, NullType, variant } from "@elaraai/east";
+ * import { Transfer } from "@elaraai/east-node-io";
+ *
+ * const cleanup = East.function([], NullType, $ => {
+ *     const config = $.let({
+ *         host: "sftp.example.com",
+ *         port: 22n,
+ *         username: "user",
+ *         password: variant('some', "password"),
+ *         privateKey: variant('none', null),
+ *     });
+ *     const conn = $.let(Transfer.SFTP.connect(config));
+ *     // ... do work ...
+ *     $(Transfer.SFTP.close(conn));
+ *     return $.return(null);
+ * });
+ *
+ * const compiled = East.compileAsync(cleanup.toIR(), Transfer.SFTP.Implementation);
+ * await compiled();
+ * ```
+ */
+export const sftp_close = East.asyncPlatform("sftp_close", [ConnectionHandleType], NullType);
+/**
+ * Closes all SFTP connections.
+ *
+ * Closes all active SFTP connections and releases all resources.
+ * Useful for test cleanup to ensure all connections are closed.
+ *
+ * @returns Null on success
+ *
+ * @example
+ * ```ts
+ * import { East, NullType } from "@elaraai/east";
+ * import { Transfer } from "@elaraai/east-node-io";
+ *
+ * const cleanupAll = East.function([], NullType, $ => {
+ *     // ... test code that may have left connections open ...
+ *     $(Transfer.SFTP.closeAll());
+ *     return $.return(null);
+ * });
+ *
+ * const compiled = East.compileAsync(cleanupAll.toIR(), Transfer.SFTP.Implementation);
+ * await compiled();
+ * ```
+ *
+ * @internal
+ */
+export const sftp_close_all = East.asyncPlatform("sftp_close_all", [], NullType);
+/**
+ * Node.js implementation of SFTP platform functions.
+ *
+ * Provides the runtime implementations for SFTP operations using ssh2-sftp-client.
+ * Pass this to East.compileAsync() to enable SFTP functionality.
+ */
+export const SftpImpl = [
+    sftp_connect.implement(async (config) => {
+        try {
+            const client = new SftpClient();
+            const connectConfig = {
+                host: config.host,
+                port: Number(config.port),
+                username: config.username,
+            };
+            // Add password if provided
+            if (config.password?.type === 'some') {
+                connectConfig.password = config.password.value;
+            }
+            // Add private key if provided
+            if (config.privateKey?.type === 'some') {
+                connectConfig.privateKey = config.privateKey.value;
+            }
+            await client.connect(connectConfig);
+            return createHandle(client, async () => {
+                await client.end();
+            });
+        }
+        catch (err) {
+            throw new EastError(`SFTP connection failed: ${err.message}`, {
+                location: { filename: "sftp_connect", line: 0n, column: 0n },
+                cause: err
+            });
+        }
+    }),
+    sftp_put.implement(async (handle, remotePath, data) => {
+        try {
+            const client = getConnection(handle);
+            // Upload from buffer
+            await client.put(Buffer.from(data), remotePath);
+            return null;
+        }
+        catch (err) {
+            throw new EastError(`SFTP upload failed: ${err.message}`, {
+                location: { filename: "sftp_put", line: 0n, column: 0n },
+                cause: err
+            });
+        }
+    }),
+    sftp_get.implement(async (handle, remotePath) => {
+        try {
+            const client = getConnection(handle);
+            // Download to buffer
+            const buffer = await client.get(remotePath);
+            if (Buffer.isBuffer(buffer)) {
+                return new Uint8Array(buffer);
+            }
+            else {
+                throw new Error('Expected buffer, got stream or other type');
+            }
+        }
+        catch (err) {
+            throw new EastError(`SFTP download failed: ${err.message}`, {
+                location: { filename: "sftp_get", line: 0n, column: 0n },
+                cause: err
+            });
+        }
+    }),
+    sftp_list.implement(async (handle, remotePath) => {
+        try {
+            const client = getConnection(handle);
+            const files = await client.list(remotePath);
+            // Convert to East FileInfoType format
+            return files.map((file) => ({
+                name: file.name,
+                path: remotePath + (remotePath.endsWith('/') ? '' : '/') + file.name,
+                size: BigInt(file.size),
+                isDirectory: file.type === 'd',
+                modifiedTime: new Date(file.modifyTime).toISOString(),
+            }));
+        }
+        catch (err) {
+            throw new EastError(`SFTP list failed: ${err.message}`, {
+                location: { filename: "sftp_list", line: 0n, column: 0n },
+                cause: err
+            });
+        }
+    }),
+    sftp_delete.implement(async (handle, remotePath) => {
+        try {
+            const client = getConnection(handle);
+            await client.delete(remotePath);
+            return null;
+        }
+        catch (err) {
+            throw new EastError(`SFTP delete failed: ${err.message}`, {
+                location: { filename: "sftp_delete", line: 0n, column: 0n },
+                cause: err
+            });
+        }
+    }),
+    sftp_close.implement(async (handle) => {
+        try {
+            const client = getConnection(handle);
+            await client.end();
+            closeHandle(handle);
+            return null;
+        }
+        catch (err) {
+            throw new EastError(`SFTP close failed: ${err.message}`, {
+                location: { filename: "sftp_close", line: 0n, column: 0n },
+                cause: err
+            });
+        }
+    }),
+    sftp_close_all.implement(async () => {
+        await closeAllHandles();
+        return null;
+    }),
+];
+//# sourceMappingURL=sftp.js.map

package/dist/transfer/sftp.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sftp.js","sourceRoot":"","sources":["../../src/transfer/sftp.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;;;GAOG;AAEH,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAGpE,OAAO,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AACnD,OAAO,UAAU,MAAM,kBAAkB,CAAC;AAE1C,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACnG,OAAO,EAAE,cAAc,EAAE,oBAAoB,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAE5F;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6CG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,IAAI,CAAC,aAAa,CAAC,cAAc,EAAE,CAAC,cAAc,CAAC,EAAE,oBAAoB,CAAC,CAAC;AAEvG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+CG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG,IAAI,CAAC,aAAa,CAAC,UAAU,EAAE,CAAC,oBAAoB,EAAE,UAAU,EAAE,QAAQ,CAAC,EAAE,QAAQ,CAAC,CAAC;AAE/G;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6CG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG,IAAI,CAAC,aAAa,CAAC,UAAU,EAAE,CAAC,oBAAoB,EAAE,UAAU,CAAC,EAAE,QAAQ,CAAC,CAAC;AAErG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6CG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,IAAI,CAAC,aAAa,CAAC,WAAW,EAAE,CAAC,oBAAoB,EAAE,UAAU,CAAC,EAAE,SAAS,CAAC,YAAY,CAAC,CAAC,CAAC;AAEtH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6CG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,IAAI,CAAC,aAAa,CAAC,aAAa,EAAE,CAAC,oBAAoB,EAAE,UAAU,CAAC,EAAE,QAAQ,CAAC,CAAC;AAE3G;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,IAAI,CAAC,aAAa,CAAC,YAAY,EAAE,CAAC,oBAAoB,CAAC,EAAE,QAAQ,CAAC,CAAC;AAE7F;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,IAAI,CAAC,aAAa,CAAC,gBAAgB,EAAE,EAAE,EAAE,QAAQ,CAAC,CAAC;AAEjF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAuB;IACxC,YAAY,CAAC,SAAS,CAAC,KAAK,EAAE,MAA0C,EAAmB,EAAE;QACzF,IAAI,CAAC;YACD,MAAM,MAAM,GAAG,IAAI,UAAU,EAAE,CAAC;YAEhC,MAAM,aAAa,GAAQ;gBACvB,IAAI,EAAE,MAAM,CAAC,IAAI;gBACjB,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC;gBACzB,QAAQ,EAAE,MAAM,CAAC,QAAQ;aAC5B,CAAC;YAEF,2BAA2B;YAC3B,IAAI,MAAM,CAAC,QAAQ,EAAE,IAAI,KAAK,MAAM,EAAE,CAAC;gBACnC,aAAa,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC;YACnD,CAAC;YAED,8BAA8B;YAC9B,IAAI,MAAM,CAAC,UAAU,EAAE,IAAI,KAAK,MAAM,EAAE,CAAC;gBACrC,aAAa,CAAC,UAAU,GAAG,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC;YACvD,CAAC;YAED,MAAM,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;YAEpC,OAAO,YAAY,CAAC,MAAM,EAAE,KAAK,IAAI,EAAE;gBACnC,MAAM,MAAM,CAAC,GAAG,EAAE,CAAC;YACvB,CAAC,CAAC,CAAC;QACP,CAAC;QAAC,OAAO,GAAQ,EAAE,CAAC;YAChB,MAAM,IAAI,SAAS,CAAC,2BAA2B,GAAG,CAAC,OAAO,EAAE,EAAE;gBAC1D,QAAQ,EAAE,EAAE,QAAQ,EAAE,cAAc,EAAE,IAAI,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE;gBAC5D,KAAK,EAAE,GAAG;aACb,CAAC,CAAC;QACP,CAAC;IACL,CAAC,CAAC;IAEF,QAAQ,CAAC,SAAS,CAAC,KAAK,EACpB,MAAgD,EAChD,UAA0C,EAC1C,IAAkC,EACrB,EAAE;QACf,IAAI,CAAC;YACD,MAAM,MAAM,GAAG,aAAa,CAAa,MAAM,CAAC,CAAC;YAEjD,qBAAqB;YACrB,MAAM,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,UAAU,CAAC,CAAC;YAChD,OAAO,IAAI,CAAC;QAChB,CAAC;QAAC,OAAO,GAAQ,EAAE,CAAC;YAChB,MAAM,IAAI,SAAS,CAAC,uBAAuB,GAAG,CAAC,OAAO,EAAE,EAAE;gBACtD,QAAQ,EAAE,EAAE,QAAQ,EAAE,UAAU,EAAE,IAAI,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE;gBACxD,KAAK,EAAE,GAAG;aACb,CAAC,CAAC;QACP,CAAC;IACL,CAAC,CAAC;IAEF,QAAQ,CAAC,SAAS,CAAC,KAAK,EACpB,MAAgD,EAChD,UAA0C,EACvB,EAAE;QACrB,IAAI,CAAC;YACD,MAAM,MAAM,GAAG,aAAa,CAAa,MAAM,CAAC,CAAC;YAEjD,qBAAqB;YACrB,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;YAE5C,IAAI,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;gBAC1B,OAAO,IAAI,UAAU,CAAC,MAAM,CAAC,CAAC;YAClC,CAAC;iBAAM,CAAC;gBACJ,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAC;YACjE,CAAC;QACL,CAAC;QAAC,OAAO,GAAQ,EAAE,CAAC;YAChB,MAAM,IAAI,SAAS,CAAC,yBAAyB,GAAG,CAAC,OAAO,EAAE,EAAE;gBACxD,QAAQ,EAAE,EAAE,QAAQ,EAAE,UAAU,EAAE,IAAI,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE;gBACxD,KAAK,EAAE,GAAG;aACb,CAAC,CAAC;QACP,CAAC;IACL,CAAC,CAAC;IAEF,SAAS,CAAC,SAAS,CAAC,KAAK,EACrB,MAAgD,EAChD,UAA0C,EAC6B,EAAE;QACzE,IAAI,CAAC;YACD,MAAM,MAAM,GAAG,aAAa,CAAa,MAAM,CAAC,CAAC;YAEjD,MAAM,KAAK,GAAmB,MAAM,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;YAE5D,sCAAsC;YACtC,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,IAAkB,EAAE,EAAE,CAAC,CAAC;gBACtC,IAAI,EAAE,IAAI,CAAC,IAAI;gBACf,IAAI,EAAE,UAAU,GAAG,CAAC,UAAU,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,IAAI;gBACpE,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC;gBACvB,WAAW,EAAE,IAAI,CAAC,IAAI,KAAK,GAAG;gBAC9B,YAAY,EAAE,IAAI,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,WAAW,EAAE;aACxD,CAAC,CAAC,CAAC;QACR,CAAC;QAAC,OAAO,GAAQ,EAAE,CAAC;YAChB,MAAM,IAAI,SAAS,CAAC,qBAAqB,GAAG,CAAC,OAAO,EAAE,EAAE;gBACpD,QAAQ,EAAE,EAAE,QAAQ,EAAE,WAAW,EAAE,IAAI,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE;gBACzD,KAAK,EAAE,GAAG;aACb,CAAC,CAAC;QACP,CAAC;IACL,CAAC,CAAC;IAEF,WAAW,CAAC,SAAS,CAAC,KAAK,EACvB,MAAgD,EAChD,UAA0C,EAC7B,EAAE;QACf,IAAI,CAAC;YACD,MAAM,MAAM,GAAG,aAAa,CAAa,MAAM,CAAC,CAAC;YACjD,MAAM,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;YAChC,OAAO,IAAI,CAAC;QAChB,CAAC;QAAC,OAAO,GAAQ,EAAE,CAAC;YAChB,MAAM,IAAI,SAAS,CAAC,uBAAuB,GAAG,CAAC,OAAO,EAAE,EAAE;gBACtD,QAAQ,EAAE,EAAE,QAAQ,EAAE,aAAa,EAAE,IAAI,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE;gBAC3D,KAAK,EAAE,GAAG;aACb,CAAC,CAAC;QACP,CAAC;IACL,CAAC,CAAC;IAEF,UAAU,CAAC,SAAS,CAAC,KAAK,EAAE,MAAgD,EAAE,EAAE;QAC5E,IAAI,CAAC;YACD,MAAM,MAAM,GAAG,aAAa,CAAa,MAAM,CAAC,CAAC;YACjD,MAAM,MAAM,CAAC,GAAG,EAAE,CAAC;YACnB,WAAW,CAAC,MAAM,CAAC,CAAC;YACpB,OAAO,IAAI,CAAC;QAChB,CAAC;QAAC,OAAO,GAAQ,EAAE,CAAC;YAChB,MAAM,IAAI,SAAS,CAAC,sBAAsB,GAAG,CAAC,OAAO,EAAE,EAAE;gBACrD,QAAQ,EAAE,EAAE,QAAQ,EAAE,YAAY,EAAE,IAAI,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE;gBAC1D,KAAK,EAAE,GAAG;aACb,CAAC,CAAC;QACP,CAAC;IACL,CAAC,CAAC;IAEF,cAAc,CAAC,SAAS,CAAC,KAAK,IAAI,EAAE;QAChC,MAAM,eAAe,EAAE,CAAC;QACxB,OAAO,IAAI,CAAC;IAChB,CAAC,CAAC;CACL,CAAC"}

package/dist/transfer/types.d.ts

@@ -0,0 +1,108 @@
+/**
+ * Copyright (c) 2025 Elara AI Pty Ltd
+ * Dual-licensed under AGPL-3.0 and commercial license. See LICENSE for details.
+ */
+/**
+ * Shared transfer protocol type definitions for East Node IO.
+ *
+ * Provides East type definitions for FTP and SFTP file transfer operations
+ * including configurations and file metadata.
+ *
+ * @packageDocumentation
+ */
+import { StructType, OptionType, StringType, IntegerType, BooleanType } from "@elaraai/east";
+export { StringType } from "@elaraai/east";
+/**
+ * FTP connection configuration.
+ *
+ * Configures connection to an FTP or FTPS (FTP over SSL/TLS) server.
+ */
+export declare const FtpConfigType: StructType<{
+    /**
+     * FTP server hostname or IP address.
+     */
+    host: StringType;
+    /**
+     * FTP server port (typically 21 for FTP, 990 for FTPS).
+     */
+    port: IntegerType;
+    /**
+     * Username for authentication.
+     */
+    user: StringType;
+    /**
+     * Password for authentication.
+     */
+    password: StringType;
+    /**
+     * Use secure FTP (FTPS - FTP over SSL/TLS).
+     */
+    secure: BooleanType;
+}>;
+/**
+ * SFTP connection configuration.
+ *
+ * Configures connection to an SFTP (SSH File Transfer Protocol) server.
+ */
+export declare const SftpConfigType: StructType<{
+    /**
+     * SFTP server hostname or IP address.
+     */
+    host: StringType;
+    /**
+     * SFTP server port (typically 22).
+     */
+    port: IntegerType;
+    /**
+     * Username for authentication.
+     */
+    username: StringType;
+    /**
+     * Password for authentication.
+     * Optional if using private key authentication.
+     */
+    password: OptionType<StringType>;
+    /**
+     * SSH private key for authentication.
+     * Optional if using password authentication.
+     */
+    privateKey: OptionType<StringType>;
+}>;
+/**
+ * File information metadata.
+ *
+ * Represents metadata about a file or directory on an FTP/SFTP server.
+ */
+export declare const FileInfoType: StructType<{
+    /**
+     * File or directory name.
+     */
+    name: StringType;
+    /**
+     * Full path to the file or directory.
+     */
+    path: StringType;
+    /**
+     * File size in bytes (0 for directories).
+     */
+    size: IntegerType;
+    /**
+     * Whether this is a directory (true) or file (false).
+     */
+    isDirectory: BooleanType;
+    /**
+     * Last modified timestamp (ISO 8601 format).
+     */
+    modifiedTime: StringType;
+}>;
+/**
+ * Opaque connection handle type.
+ *
+ * Represents an active FTP or SFTP connection.
+ * Handles are created by connect() functions and used in transfer operations.
+ *
+ * @internal
+ */
+declare const ConnectionHandleType: StringType;
+export { ConnectionHandleType };
+//# sourceMappingURL=types.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/transfer/types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;;;GAOG;AAEH,OAAO,EACH,UAAU,EACV,UAAU,EACV,UAAU,EACV,WAAW,EACX,WAAW,EACd,MAAM,eAAe,CAAC;AAGvB,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAE3C;;;;GAIG;AACH,eAAO,MAAM,aAAa;IACtB;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;EAEL,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,cAAc;IACvB;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;;OAGG;;IAGH;;;OAGG;;EAEL,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,YAAY;IACrB;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;EAEL,CAAC;AAEH;;;;;;;GAOG;AACH,QAAA,MAAM,oBAAoB,YAAa,CAAC;AAGxC,OAAO,EAAE,oBAAoB,EAAE,CAAC"}

package/dist/transfer/types.js

@@ -0,0 +1,110 @@
+/**
+ * Copyright (c) 2025 Elara AI Pty Ltd
+ * Dual-licensed under AGPL-3.0 and commercial license. See LICENSE for details.
+ */
+/**
+ * Shared transfer protocol type definitions for East Node IO.
+ *
+ * Provides East type definitions for FTP and SFTP file transfer operations
+ * including configurations and file metadata.
+ *
+ * @packageDocumentation
+ */
+import { StructType, OptionType, StringType, IntegerType, BooleanType, } from "@elaraai/east";
+// Re-export StringType for use in other transfer modules
+export { StringType } from "@elaraai/east";
+/**
+ * FTP connection configuration.
+ *
+ * Configures connection to an FTP or FTPS (FTP over SSL/TLS) server.
+ */
+export const FtpConfigType = StructType({
+    /**
+     * FTP server hostname or IP address.
+     */
+    host: StringType,
+    /**
+     * FTP server port (typically 21 for FTP, 990 for FTPS).
+     */
+    port: IntegerType,
+    /**
+     * Username for authentication.
+     */
+    user: StringType,
+    /**
+     * Password for authentication.
+     */
+    password: StringType,
+    /**
+     * Use secure FTP (FTPS - FTP over SSL/TLS).
+     */
+    secure: BooleanType,
+});
+/**
+ * SFTP connection configuration.
+ *
+ * Configures connection to an SFTP (SSH File Transfer Protocol) server.
+ */
+export const SftpConfigType = StructType({
+    /**
+     * SFTP server hostname or IP address.
+     */
+    host: StringType,
+    /**
+     * SFTP server port (typically 22).
+     */
+    port: IntegerType,
+    /**
+     * Username for authentication.
+     */
+    username: StringType,
+    /**
+     * Password for authentication.
+     * Optional if using private key authentication.
+     */
+    password: OptionType(StringType),
+    /**
+     * SSH private key for authentication.
+     * Optional if using password authentication.
+     */
+    privateKey: OptionType(StringType),
+});
+/**
+ * File information metadata.
+ *
+ * Represents metadata about a file or directory on an FTP/SFTP server.
+ */
+export const FileInfoType = StructType({
+    /**
+     * File or directory name.
+     */
+    name: StringType,
+    /**
+     * Full path to the file or directory.
+     */
+    path: StringType,
+    /**
+     * File size in bytes (0 for directories).
+     */
+    size: IntegerType,
+    /**
+     * Whether this is a directory (true) or file (false).
+     */
+    isDirectory: BooleanType,
+    /**
+     * Last modified timestamp (ISO 8601 format).
+     */
+    modifiedTime: StringType,
+});
+/**
+ * Opaque connection handle type.
+ *
+ * Represents an active FTP or SFTP connection.
+ * Handles are created by connect() functions and used in transfer operations.
+ *
+ * @internal
+ */
+const ConnectionHandleType = StringType;
+// Export for internal use within transfer module only
+export { ConnectionHandleType };
+//# sourceMappingURL=types.js.map

package/dist/transfer/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/transfer/types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;;;GAOG;AAEH,OAAO,EACH,UAAU,EACV,UAAU,EACV,UAAU,EACV,WAAW,EACX,WAAW,GACd,MAAM,eAAe,CAAC;AAEvB,yDAAyD;AACzD,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAE3C;;;;GAIG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,UAAU,CAAC;IACpC;;OAEG;IACH,IAAI,EAAE,UAAU;IAEhB;;OAEG;IACH,IAAI,EAAE,WAAW;IAEjB;;OAEG;IACH,IAAI,EAAE,UAAU;IAEhB;;OAEG;IACH,QAAQ,EAAE,UAAU;IAEpB;;OAEG;IACH,MAAM,EAAE,WAAW;CACtB,CAAC,CAAC;AAEH;;;;GAIG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,UAAU,CAAC;IACrC;;OAEG;IACH,IAAI,EAAE,UAAU;IAEhB;;OAEG;IACH,IAAI,EAAE,WAAW;IAEjB;;OAEG;IACH,QAAQ,EAAE,UAAU;IAEpB;;;OAGG;IACH,QAAQ,EAAE,UAAU,CAAC,UAAU,CAAC;IAEhC;;;OAGG;IACH,UAAU,EAAE,UAAU,CAAC,UAAU,CAAC;CACrC,CAAC,CAAC;AAEH;;;;GAIG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,UAAU,CAAC;IACnC;;OAEG;IACH,IAAI,EAAE,UAAU;IAEhB;;OAEG;IACH,IAAI,EAAE,UAAU;IAEhB;;OAEG;IACH,IAAI,EAAE,WAAW;IAEjB;;OAEG;IACH,WAAW,EAAE,WAAW;IAExB;;OAEG;IACH,YAAY,EAAE,UAAU;CAC3B,CAAC,CAAC;AAEH;;;;;;;GAOG;AACH,MAAM,oBAAoB,GAAG,UAAU,CAAC;AAExC,sDAAsD;AACtD,OAAO,EAAE,oBAAoB,EAAE,CAAC"}