@decaf-ts/integrations 0.7.0 → 0.8.0

package/lib/types/sftp/core/index.d.mts

@@ -0,0 +1 @@
+export * from "./SftpSource.d.mts";

package/lib/types/sftp/index.d.cts

@@ -0,0 +1,3 @@
+export * from "./ssh2/Ssh2SftpService.d.cts";
+export * from "./aws/AwsSftpService.d.cts";
+export * from "./core/SftpSource.d.cts";

package/lib/types/sftp/index.d.mts

@@ -0,0 +1,3 @@
+export * from "./ssh2/Ssh2SftpService.d.mts";
+export * from "./aws/AwsSftpService.d.mts";
+export * from "./core/SftpSource.d.mts";

package/lib/types/sftp/ssh2/Ssh2SftpService.d.cts

@@ -0,0 +1,47 @@
+import { type ContextualArgs, type MaybeContextualArg } from "@decaf-ts/core";
+import { SftpSource, type SftpFileEntry, type SftpFileResult, type SftpSourceConfig } from "../core/SftpSource.d.cts";
+export interface Ssh2SftpConfig extends SftpSourceConfig {
+    provider: "ssh2";
+    readyTimeout?: number;
+}
+interface Ssh2Client {
+    connect(config: unknown): void;
+    on(event: "ready", cb: () => void): void;
+    on(event: "error", cb: (err: Error) => void): void;
+    sftp(cb: (err: Error | null, sftp: Ssh2SftpHandle) => void): void;
+    end(): void;
+}
+interface Ssh2SftpHandle {
+    readdir(dir: string, cb: (err: Error | null, list: Array<{
+        filename: string;
+        attrs: {
+            size: number;
+            mtime: number;
+            mode: number;
+        };
+    }>) => void): void;
+    stat(path: string, cb: (err: Error | null, stat: {
+        size: number;
+        mtime: number;
+        mode: number;
+    }) => void): void;
+    open(path: string, flags: string, cb: (err: Error | null, handle: Buffer) => void): void;
+    read(handle: Buffer, buffer: Buffer, offset: number, length: number, position: number, cb: (err: Error | null, bytesRead: number, buffer: Buffer) => void): void;
+    close(handle: Buffer, cb: (err: Error | null) => void): void;
+    unlink(path: string, cb: (err: Error | null) => void): void;
+    end(cb?: () => void): void;
+}
+export declare class Ssh2SftpService extends SftpSource<Ssh2Client, Ssh2SftpConfig> {
+    private sftp?;
+    constructor();
+    initialize(...args: ContextualArgs<any>): Promise<{
+        config: Ssh2SftpConfig;
+        client: Ssh2Client;
+    }>;
+    list(remoteDir?: string, ...args: MaybeContextualArg<any>): Promise<SftpFileEntry[]>;
+    fetch(remotePath: string, ...args: MaybeContextualArg<any>): Promise<SftpFileResult>;
+    delete(remotePath: string, ...args: MaybeContextualArg<any>): Promise<void>;
+    close(...args: MaybeContextualArg<any>): Promise<void>;
+    private requireSftp;
+}
+export {};

package/lib/types/sftp/ssh2/Ssh2SftpService.d.mts

@@ -0,0 +1,47 @@
+import { type ContextualArgs, type MaybeContextualArg } from "@decaf-ts/core";
+import { SftpSource, type SftpFileEntry, type SftpFileResult, type SftpSourceConfig } from "../core/SftpSource.d.mts";
+export interface Ssh2SftpConfig extends SftpSourceConfig {
+    provider: "ssh2";
+    readyTimeout?: number;
+}
+interface Ssh2Client {
+    connect(config: unknown): void;
+    on(event: "ready", cb: () => void): void;
+    on(event: "error", cb: (err: Error) => void): void;
+    sftp(cb: (err: Error | null, sftp: Ssh2SftpHandle) => void): void;
+    end(): void;
+}
+interface Ssh2SftpHandle {
+    readdir(dir: string, cb: (err: Error | null, list: Array<{
+        filename: string;
+        attrs: {
+            size: number;
+            mtime: number;
+            mode: number;
+        };
+    }>) => void): void;
+    stat(path: string, cb: (err: Error | null, stat: {
+        size: number;
+        mtime: number;
+        mode: number;
+    }) => void): void;
+    open(path: string, flags: string, cb: (err: Error | null, handle: Buffer) => void): void;
+    read(handle: Buffer, buffer: Buffer, offset: number, length: number, position: number, cb: (err: Error | null, bytesRead: number, buffer: Buffer) => void): void;
+    close(handle: Buffer, cb: (err: Error | null) => void): void;
+    unlink(path: string, cb: (err: Error | null) => void): void;
+    end(cb?: () => void): void;
+}
+export declare class Ssh2SftpService extends SftpSource<Ssh2Client, Ssh2SftpConfig> {
+    private sftp?;
+    constructor();
+    initialize(...args: ContextualArgs<any>): Promise<{
+        config: Ssh2SftpConfig;
+        client: Ssh2Client;
+    }>;
+    list(remoteDir?: string, ...args: MaybeContextualArg<any>): Promise<SftpFileEntry[]>;
+    fetch(remotePath: string, ...args: MaybeContextualArg<any>): Promise<SftpFileResult>;
+    delete(remotePath: string, ...args: MaybeContextualArg<any>): Promise<void>;
+    close(...args: MaybeContextualArg<any>): Promise<void>;
+    private requireSftp;
+}
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@decaf-ts/integrations",
-  "version": "0.7.0",
+  "version": "0.8.0",
   "type": "module",
   "main": "lib/index.js",
   "types": "lib/index.d.mts",
@@ -269,6 +269,17 @@
       },
       "default": "./lib/esm/graph/index.js"
     },
+    "./sftp": {
+      "import": {
+        "types": "./lib/types/sftp/index.d.mts",
+        "default": "./lib/esm/sftp/index.js"
+      },
+      "require": {
+        "types": "./lib/types/sftp/index.d.cts",
+        "default": "./lib/cjs/sftp/index.cjs"
+      },
+      "default": "./lib/esm/sftp/index.js"
+    },
     "./graph/shared": {
       "import": {
         "types": "./lib/types/graph/shared/index.d.mts",
@@ -340,7 +351,7 @@
     "lint": "eslint .",
     "lint-fix": "eslint --fix .",
     "prepare-pr": "npm run lint-fix && npm run build:prod && npm run coverage && npm run docs",
-    "prepare-release": "npm run lint-fix && npm run build:prod",
+    "prepare-release": "npm run lint-fix && npm run build:prod && npm run docs",
     "release": "./bin/tag-release.sh",
     "clean-publish": "npx clean-publish",
     "drawings": "for FILE in workdocs/drawings/*.drawio; do echo \"converting $FILE to image...\" && docker run --rm -v $(pwd):/data rlespinasse/drawio-export --format png $FILE; done && cp -rf workdocs/drawings/export/* workdocs/resources/",
@@ -430,6 +441,7 @@
     "hashicorp-vault": "^0.1.0",
     "keycloak-admin": "^24.0.5",
     "kubo-rpc-client": "^7.1.0",
-    "onelogin-node": "^0.1.0"
+    "onelogin-node": "^0.1.0",
+    "ssh2": "^1.16.0"
   }
 }