@activepieces/piece-sftp 0.1.2 → 0.1.4

package/package.json

@@ -1,16 +1,17 @@
 {
   "name": "@activepieces/piece-sftp",
-  "version": "0.1.2",
+  "version": "0.1.4",
   "dependencies": {
     "@sinclair/typebox": "^0.26.3",
     "axios": "1.4.0",
     "dayjs": "^1.11.8",
+    "is-base64": "^1.1.0",
     "nanoid": "^3.3.4",
     "semver": "7.5.3",
     "ssh2-sftp-client": "^9.1.0",
-    "@activepieces/pieces-common": "0.2.1",
-    "@activepieces/pieces-framework": "0.6.6",
-    "@activepieces/shared": "0.5.11",
+    "@activepieces/pieces-common": "0.2.2",
+    "@activepieces/pieces-framework": "0.6.10",
+    "@activepieces/shared": "0.6.4",
     "tslib": "1.14.1"
   },
   "main": "./src/index.js",

package/src/index.js

@@ -1,44 +1,70 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.sftp = exports.sftpAuth = void 0;
+const tslib_1 = require("tslib");
 const pieces_framework_1 = require("@activepieces/pieces-framework");
 const create_file_1 = require("./lib/actions/create-file");
 const new_modified_file_1 = require("./lib/triggers/new-modified-file");
+const ssh2_sftp_client_1 = tslib_1.__importDefault(require("ssh2-sftp-client"));
+const read_file_1 = require("./lib/actions/read-file");
 exports.sftpAuth = pieces_framework_1.PieceAuth.CustomAuth({
-    displayName: 'Authentication',
     description: 'Enter the authentication details',
     props: {
         host: pieces_framework_1.Property.ShortText({
             displayName: 'Host',
             description: 'The host of the SFTP server',
-            required: true,
+            required: true
         }),
         port: pieces_framework_1.Property.Number({
             displayName: 'Port',
             description: 'The port of the SFTP server',
             required: true,
-            defaultValue: 22,
+            defaultValue: 22
         }),
         username: pieces_framework_1.Property.ShortText({
             displayName: 'Username',
             description: 'The username of the SFTP server',
-            required: true,
+            required: true
         }),
         password: pieces_framework_1.PieceAuth.SecretText({
             displayName: 'Password',
             description: 'The password of the SFTP server',
-            required: true,
-        }),
+            required: true
+        })
     },
+    validate: ({ auth }) => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
+        const { host, port, username, password } = auth;
+        const sftp = new ssh2_sftp_client_1.default();
+        try {
+            yield sftp.connect({
+                host,
+                port,
+                username,
+                password
+            });
+            return {
+                valid: true
+            };
+        }
+        catch (err) {
+            return {
+                valid: false,
+                error: 'Connection failed. Please check your credentials and try again.'
+            };
+        }
+        finally {
+            yield sftp.end();
+        }
+    }),
     required: true
 });
 exports.sftp = (0, pieces_framework_1.createPiece)({
-    displayName: "SFTP",
-    minimumSupportedRelease: '0.5.0',
-    logoUrl: "https://cdn.activepieces.com/pieces/sftp.svg",
-    authors: ["Abdallah-Alwarawreh"],
+    displayName: 'SFTP',
+    minimumSupportedRelease: '0.7.1',
+    logoUrl: 'https://cdn.activepieces.com/pieces/sftp.svg',
+    authors: ['Abdallah-Alwarawreh', 'abuaboud'],
     auth: exports.sftpAuth,
-    actions: [create_file_1.createFile],
-    triggers: [new_modified_file_1.newOrModifiedFile],
+    actions: [create_file_1.createFile, read_file_1.readFileContent],
+    triggers: [new_modified_file_1.newOrModifiedFile]
 });
 //# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../packages/pieces/sftp/src/index.ts"],"names":[],"mappings":";;;AACA,qEAAkF;AAClF,2DAAuD;AACvD,wEAAqE;AAExD,QAAA,QAAQ,GAAG,4BAAS,CAAC,UAAU,CAAC;IAC3C,WAAW,EAAE,gBAAgB;IAC7B,WAAW,EAAE,kCAAkC;IAC/C,KAAK,EAAE;QACL,IAAI,EAAE,2BAAQ,CAAC,SAAS,CAAC;YACvB,WAAW,EAAE,MAAM;YACnB,WAAW,EAAE,6BAA6B;YAC1C,QAAQ,EAAE,IAAI;SACf,CAAC;QACF,IAAI,EAAE,2BAAQ,CAAC,MAAM,CAAC;YACpB,WAAW,EAAE,MAAM;YACnB,WAAW,EAAE,6BAA6B;YAC1C,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,EAAE;SACjB,CAAC;QACF,QAAQ,EAAE,2BAAQ,CAAC,SAAS,CAAC;YAC3B,WAAW,EAAE,UAAU;YACvB,WAAW,EAAE,iCAAiC;YAC9C,QAAQ,EAAE,IAAI;SACf,CAAC;QACF,QAAQ,EAAE,4BAAS,CAAC,UAAU,CAAC;YAC7B,WAAW,EAAE,UAAU;YACvB,WAAW,EAAE,iCAAiC;YAC9C,QAAQ,EAAE,IAAI;SACf,CAAC;KACH;IACD,QAAQ,EAAE,IAAI;CACf,CAAC,CAAA;AAEW,QAAA,IAAI,GAAG,IAAA,8BAAW,EAAC;IAC9B,WAAW,EAAE,MAAM;IACnB,uBAAuB,EAAE,OAAO;IAChC,OAAO,EAAE,8CAA8C;IACvD,OAAO,EAAE,CAAC,qBAAqB,CAAC;IAChC,IAAI,EAAE,gBAAQ;IACd,OAAO,EAAE,CAAC,wBAAU,CAAC;IACrB,QAAQ,EAAE,CAAC,qCAAiB,CAAC;CAC9B,CAAC,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../packages/pieces/sftp/src/index.ts"],"names":[],"mappings":";;;;AAAA,qEAIwC;AACxC,2DAAuD;AACvD,wEAAqE;AACrE,gFAAsC;AACtC,uDAA0D;AAC7C,QAAA,QAAQ,GAAG,4BAAS,CAAC,UAAU,CAAC;IAC3C,WAAW,EAAE,kCAAkC;IAC/C,KAAK,EAAE;QACL,IAAI,EAAE,2BAAQ,CAAC,SAAS,CAAC;YACvB,WAAW,EAAE,MAAM;YACnB,WAAW,EAAE,6BAA6B;YAC1C,QAAQ,EAAE,IAAI;SACf,CAAC;QACF,IAAI,EAAE,2BAAQ,CAAC,MAAM,CAAC;YACpB,WAAW,EAAE,MAAM;YACnB,WAAW,EAAE,6BAA6B;YAC1C,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,EAAE;SACjB,CAAC;QACF,QAAQ,EAAE,2BAAQ,CAAC,SAAS,CAAC;YAC3B,WAAW,EAAE,UAAU;YACvB,WAAW,EAAE,iCAAiC;YAC9C,QAAQ,EAAE,IAAI;SACf,CAAC;QACF,QAAQ,EAAE,4BAAS,CAAC,UAAU,CAAC;YAC7B,WAAW,EAAE,UAAU;YACvB,WAAW,EAAE,iCAAiC;YAC9C,QAAQ,EAAE,IAAI;SACf,CAAC;KACH;IACD,QAAQ,EAAE,CAAO,EAAE,IAAI,EAAE,EAAE,EAAE;QAC3B,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC;QAChD,MAAM,IAAI,GAAG,IAAI,0BAAM,EAAE,CAAC;QAE1B,IAAI;YACF,MAAM,IAAI,CAAC,OAAO,CAAC;gBACjB,IAAI;gBACJ,IAAI;gBACJ,QAAQ;gBACR,QAAQ;aACT,CAAC,CAAC;YACH,OAAO;gBACL,KAAK,EAAE,IAAI;aACZ,CAAC;SACH;QAAC,OAAO,GAAG,EAAE;YACZ,OAAO;gBACL,KAAK,EAAE,KAAK;gBACZ,KAAK,EAAE,iEAAiE;aACzE,CAAC;SACH;gBAAS;YACR,MAAM,IAAI,CAAC,GAAG,EAAE,CAAC;SAClB;IACH,CAAC,CAAA;IACD,QAAQ,EAAE,IAAI;CACf,CAAC,CAAC;AAEU,QAAA,IAAI,GAAG,IAAA,8BAAW,EAAC;IAC9B,WAAW,EAAE,MAAM;IACnB,uBAAuB,EAAE,OAAO;IAChC,OAAO,EAAE,8CAA8C;IACvD,OAAO,EAAE,CAAC,qBAAqB,EAAE,UAAU,CAAC;IAC5C,IAAI,EAAE,gBAAQ;IACd,OAAO,EAAE,CAAC,wBAAU,EAAE,2BAAe,CAAC;IACtC,QAAQ,EAAE,CAAC,qCAAiB,CAAC;CAC9B,CAAC,CAAC"}

package/src/lib/actions/create-file.js

@@ -8,17 +8,15 @@ const __1 = require("../..");
 exports.createFile = (0, pieces_framework_1.createAction)({
     auth: __1.sftpAuth,
     name: 'create_file',
-    displayName: 'Create new file',
+    displayName: 'Create File from Text',
     description: 'Create a new file in the given path',
     props: {
         fileName: pieces_framework_1.Property.ShortText({
             displayName: 'File Path',
-            description: 'The name of the file to create',
             required: true,
         }),
         fileContent: pieces_framework_1.Property.LongText({
             displayName: 'File content',
-            description: 'The content of the file to create',
             required: true,
         })
     },
@@ -38,6 +36,14 @@ exports.createFile = (0, pieces_framework_1.createAction)({
                     username,
                     password
                 });
+                const remotePathExists = yield sftp.exists(fileName);
+                if (!remotePathExists) {
+                    // Extract the directory path from the fileName
+                    const remoteDirectory = fileName.substring(0, fileName.lastIndexOf('/'));
+                    // Create the directory if it doesn't exist
+                    yield sftp.mkdir(remoteDirectory, true); // The second argument 'true' makes the function create all intermediate directories
+                    // You can also check if the directory was successfully created and handle any potential errors here
+                }
                 yield sftp.put(Buffer.from(fileContent), fileName);
                 yield sftp.end();
                 return {

package/src/lib/actions/create-file.js.map

@@ -1 +1 @@
-{"version":3,"file":"create-file.js","sourceRoot":"","sources":["../../../../../../../packages/pieces/sftp/src/lib/actions/create-file.ts"],"names":[],"mappings":";;;;AAAA,qEAAwE;AACxE,gFAAqC;AACrC,6BAAiC;AAEpB,QAAA,UAAU,GAAG,IAAA,+BAAY,EAAC;IACnC,IAAI,EAAE,YAAQ;IACd,IAAI,EAAE,aAAa;IACnB,WAAW,EAAE,iBAAiB;IAC9B,WAAW,EAAE,qCAAqC;IAClD,KAAK,EAAE;QACH,QAAQ,EAAE,2BAAQ,CAAC,SAAS,CAAC;YACzB,WAAW,EAAE,WAAW;YACxB,WAAW,EAAE,gCAAgC;YAC7C,QAAQ,EAAE,IAAI;SACjB,CAAC;QACF,WAAW,EAAE,2BAAQ,CAAC,QAAQ,CAAC;YAC3B,WAAW,EAAE,cAAc;YAC3B,WAAW,EAAE,mCAAmC;YAChD,QAAQ,EAAE,IAAI;SACjB,CAAC;KACL;IACK,GAAG,CAAC,OAAO;;YACb,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC;YAC/B,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC;YAC/B,MAAM,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC;YACvC,MAAM,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC;YACvC,MAAM,QAAQ,GAAG,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC,CAAA;YAC/C,MAAM,WAAW,GAAG,OAAO,CAAC,UAAU,CAAC,aAAa,CAAC,CAAA;YACrD,MAAM,IAAI,GAAG,IAAI,0BAAM,EAAE,CAAC;YAE1B,IAAI;gBACA,MAAM,IAAI,CAAC,OAAO,CAAC;oBACf,IAAI;oBACJ,IAAI;oBACJ,QAAQ;oBACR,QAAQ;iBACX,CAAC,CAAC;gBAEH,MAAM,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,QAAQ,CAAC,CAAC;gBACnD,MAAM,IAAI,CAAC,GAAG,EAAE,CAAC;gBAEjB,OAAO;oBACH,MAAM,EAAE,SAAS;iBACpB,CAAA;aACJ;YAAC,OAAO,GAAG,EAAE;gBACV,OAAO;oBACH,MAAM,EAAE,OAAO;oBACf,KAAK,EAAE,GAAG;iBACb,CAAA;aACJ;QACL,CAAC;KAAA;CACJ,CAAC,CAAC"}
+{"version":3,"file":"create-file.js","sourceRoot":"","sources":["../../../../../../../packages/pieces/sftp/src/lib/actions/create-file.ts"],"names":[],"mappings":";;;;AAAA,qEAAwE;AACxE,gFAAqC;AACrC,6BAAiC;AAEpB,QAAA,UAAU,GAAG,IAAA,+BAAY,EAAC;IACnC,IAAI,EAAE,YAAQ;IACd,IAAI,EAAE,aAAa;IACnB,WAAW,EAAE,uBAAuB;IACpC,WAAW,EAAE,qCAAqC;IAClD,KAAK,EAAE;QACH,QAAQ,EAAE,2BAAQ,CAAC,SAAS,CAAC;YACzB,WAAW,EAAE,WAAW;YACxB,QAAQ,EAAE,IAAI;SACjB,CAAC;QACF,WAAW,EAAE,2BAAQ,CAAC,QAAQ,CAAC;YAC3B,WAAW,EAAE,cAAc;YAC3B,QAAQ,EAAE,IAAI;SACjB,CAAC;KACL;IACK,GAAG,CAAC,OAAO;;YACb,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC;YAC/B,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC;YAC/B,MAAM,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC;YACvC,MAAM,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC;YACvC,MAAM,QAAQ,GAAG,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC,CAAA;YAC/C,MAAM,WAAW,GAAG,OAAO,CAAC,UAAU,CAAC,aAAa,CAAC,CAAA;YACrD,MAAM,IAAI,GAAG,IAAI,0BAAM,EAAE,CAAC;YAE1B,IAAI;gBACA,MAAM,IAAI,CAAC,OAAO,CAAC;oBACf,IAAI;oBACJ,IAAI;oBACJ,QAAQ;oBACR,QAAQ;iBACX,CAAC,CAAC;gBAEH,MAAM,gBAAgB,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;gBACrD,IAAI,CAAC,gBAAgB,EAAE;oBACnB,+CAA+C;oBAC/C,MAAM,eAAe,GAAG,QAAQ,CAAC,SAAS,CAAC,CAAC,EAAE,QAAQ,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC;oBAEzE,2CAA2C;oBAC3C,MAAM,IAAI,CAAC,KAAK,CAAC,eAAe,EAAE,IAAI,CAAC,CAAC,CAAC,oFAAoF;oBAE7H,oGAAoG;iBACvG;gBAED,MAAM,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,QAAQ,CAAC,CAAC;gBACnD,MAAM,IAAI,CAAC,GAAG,EAAE,CAAC;gBAEjB,OAAO;oBACH,MAAM,EAAE,SAAS;iBACpB,CAAA;aACJ;YAAC,OAAO,GAAG,EAAE;gBACV,OAAO;oBACH,MAAM,EAAE,OAAO;oBACf,KAAK,EAAE,GAAG;iBACb,CAAA;aACJ;QACL,CAAC;KAAA;CACJ,CAAC,CAAC"}

package/src/lib/actions/read-file.d.ts

@@ -0,0 +1,9 @@
+export declare const readFileContent: import("@activepieces/pieces-framework").IAction<import("@activepieces/pieces-framework").CustomAuthProperty<true, {
+    host: import("@activepieces/pieces-framework").ShortTextProperty<true>;
+    port: import("@activepieces/pieces-framework").NumberProperty<true>;
+    username: import("@activepieces/pieces-framework").ShortTextProperty<true>;
+    password: import("@activepieces/pieces-framework").SecretTextProperty<true>;
+}>, {
+    filePath: import("@activepieces/pieces-framework").ShortTextProperty<true>;
+    outputFormat: import("@activepieces/pieces-framework").StaticDropdownProperty<string, true>;
+}>;

package/src/lib/actions/read-file.js

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.readFileContent = void 0;
+const tslib_1 = require("tslib");
+const index_1 = require("../../index");
+const pieces_framework_1 = require("@activepieces/pieces-framework");
+const ssh2_sftp_client_1 = tslib_1.__importDefault(require("ssh2-sftp-client"));
+exports.readFileContent = (0, pieces_framework_1.createAction)({
+    auth: index_1.sftpAuth,
+    name: 'read_file_content',
+    displayName: 'Read File Content',
+    description: 'Read the content of a file',
+    props: {
+        filePath: pieces_framework_1.Property.ShortText({
+            displayName: 'File Path',
+            required: true
+        }),
+        outputFormat: pieces_framework_1.Property.StaticDropdown({
+            displayName: 'Output Format',
+            required: true,
+            defaultValue: 'base64',
+            options: {
+                options: [
+                    {
+                        value: 'Text',
+                        label: 'utf8'
+                    },
+                    {
+                        value: 'base64',
+                        label: 'Base64'
+                    }
+                ]
+            }
+        })
+    },
+    run(context) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            const { host, port, username, password } = context.auth;
+            const filePath = context.propsValue['filePath'];
+            const sftp = new ssh2_sftp_client_1.default();
+            yield sftp.connect({
+                host,
+                port,
+                username,
+                password,
+                readyTimeout: 15000
+            });
+            const fileContent = yield sftp.get(filePath);
+            yield sftp.end();
+            return {
+                base64: fileContent.toString(context.propsValue.outputFormat === 'base64' ? 'base64' : 'utf8')
+            };
+        });
+    }
+});
+//# sourceMappingURL=read-file.js.map

package/src/lib/actions/read-file.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"read-file.js","sourceRoot":"","sources":["../../../../../../../packages/pieces/sftp/src/lib/actions/read-file.ts"],"names":[],"mappings":";;;;AAAA,uCAAuC;AACvC,qEAAwE;AACxE,gFAAsC;AAEzB,QAAA,eAAe,GAAG,IAAA,+BAAY,EAAC;IAC1C,IAAI,EAAE,gBAAQ;IACd,IAAI,EAAE,mBAAmB;IACzB,WAAW,EAAE,mBAAmB;IAChC,WAAW,EAAE,4BAA4B;IACzC,KAAK,EAAE;QACL,QAAQ,EAAE,2BAAQ,CAAC,SAAS,CAAC;YAC3B,WAAW,EAAE,WAAW;YACxB,QAAQ,EAAE,IAAI;SACf,CAAC;QACF,YAAY,EAAE,2BAAQ,CAAC,cAAc,CAAC;YACpC,WAAW,EAAE,eAAe;YAC5B,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,QAAQ;YACtB,OAAO,EAAE;gBACP,OAAO,EAAE;oBACP;wBACE,KAAK,EAAE,MAAM;wBACb,KAAK,EAAE,MAAM;qBACd;oBACD;wBACE,KAAK,EAAE,QAAQ;wBACf,KAAK,EAAE,QAAQ;qBAChB;iBACF;aACF;SACF,CAAC;KACH;IACK,GAAG,CAAC,OAAO;;YACf,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;YACxD,MAAM,QAAQ,GAAG,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;YAChD,MAAM,IAAI,GAAG,IAAI,0BAAM,EAAE,CAAC;YAE1B,MAAM,IAAI,CAAC,OAAO,CAAC;gBACjB,IAAI;gBACJ,IAAI;gBACJ,QAAQ;gBACR,QAAQ;gBACR,YAAY,EAAE,KAAK;aACpB,CAAC,CAAC;YAEH,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;YAC7C,MAAM,IAAI,CAAC,GAAG,EAAE,CAAC;YAEjB,OAAO;gBACL,MAAM,EAAE,WAAW,CAAC,QAAQ,CAAC,OAAO,CAAC,UAAU,CAAC,YAAY,KAAK,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC;aAC/F,CAAC;QACJ,CAAC;KAAA;CACF,CAAC,CAAC"}