@solar-angular/builder 1.0.0

package/builders.json

@@ -0,0 +1,10 @@
+{
+  "$schema": "../../../node_modules/@angular-devkit/architect/src/builders-schema.json",
+  "builders": {
+    "deploy": {
+      "implementation": "./deploy/builder",
+      "schema": "./deploy/schema.json",
+      "description": "Deploy application"
+    }
+  }
+}

package/deploy/builder.d.ts

@@ -0,0 +1,3 @@
+import { Schema } from './interface';
+declare const _default: import("@angular-devkit/architect/src/internal").Builder<Schema & import("@angular-devkit/core").JsonObject>;
+export default _default;

package/deploy/builder.js

@@ -0,0 +1,181 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const architect_1 = require("@angular-devkit/architect");
+const core_1 = require("@angular-devkit/core");
+const node_1 = require("@angular-devkit/core/node");
+const options_1 = require("@angular/build/src/builders/application/options");
+const load_esm_1 = require("@angular/cli/src/utilities/load-esm");
+const dotenv = require("dotenv");
+const fs = require("fs/promises");
+const path = require("node:path");
+const ora_1 = require("ora");
+async function askUsername() {
+    const { default: inquirer } = await (0, load_esm_1.loadEsmModule)('inquirer');
+    const { username } = await inquirer.prompt([
+        {
+            type: 'input',
+            name: 'username',
+            message: 'Please enter remote username',
+        }
+    ]);
+    return username;
+}
+async function askPassword() {
+    const { default: inquirer } = await (0, load_esm_1.loadEsmModule)('inquirer');
+    const { password } = await inquirer.prompt([{
+            type: 'password',
+            name: 'password',
+            message: 'Please enter remote password',
+            mask: '*'
+        }]);
+    return password;
+}
+function createSpinner(text) {
+    return (0, ora_1.default)({
+        text,
+        // The below 2 options are needed because otherwise CTRL+C will be delayed
+        // when the underlying process is sync.
+        hideCursor: false,
+        discardStdin: false,
+        isEnabled: true,
+    });
+}
+async function callWebhook(options, app, env) {
+    const https = await Promise.resolve().then(() => require('https'));
+    const os = await Promise.resolve().then(() => require('os'));
+    const { hostname, pathname, search } = new URL(options.webhook);
+    const { username } = os.userInfo();
+    const size = await getDirectorySize(options.localPath);
+    const body = JSON.stringify({
+        msgtype: 'markdown',
+        markdown: {
+            title: 'App deployment event',
+            text: [
+                `**App deployment event**`,
+                `***`,
+                `**app**: ${app}`,
+                `**env**: ${env}`,
+                `**usr**: ${username}`,
+                `**siz**: ${size.toFixed(3)} MB`
+            ].join('  \n ')
+        }
+    });
+    return new Promise((resolve, reject) => {
+        const request = https.request({
+            method: 'POST',
+            host: hostname,
+            path: pathname + search,
+            headers: {
+                'Content-Type': 'application/json'
+            }
+        }, response => {
+            // The below is needed as otherwise the response will never close which will cause the CLI not to terminate.
+            // eslint-disable-next-line @typescript-eslint/no-empty-function
+            response.on('data', () => { });
+            if (response.statusCode !== 200 && response.statusCode !== 204) {
+                reject(new Error(`Webhook calling failed with status code: ${response.statusCode}.`));
+            }
+            else {
+                resolve();
+            }
+        });
+        request.on('error', reject);
+        request.write(body);
+        request.end();
+    });
+}
+async function uninstallRemoteApp(sftp, remotePath) {
+    const list = await sftp.list(remotePath);
+    for (const info of list) {
+        if (info.type === 'd') {
+            await sftp.rmdir(`${remotePath}/${info.name}`, true);
+        }
+        else {
+            await sftp.delete(`${remotePath}/${info.name}`);
+        }
+    }
+}
+async function getDefaultConfigurationName(target, workspaceRoot) {
+    const { workspace } = await core_1.workspaces.readWorkspace(workspaceRoot + '/angular.json', core_1.workspaces.createWorkspaceHost(new node_1.NodeJsSyncHost()));
+    return workspace.projects.get(target.project).targets.get(target.target).defaultConfiguration;
+}
+async function getDirectorySize(dirPath) {
+    let totalSize = 0;
+    async function readDirRecursive(currentPath) {
+        for (const file of await fs.readdir(currentPath)) {
+            const filePath = path.join(currentPath, file);
+            const stats = await fs.stat(filePath);
+            if (stats.isDirectory()) {
+                await readDirRecursive(filePath);
+            }
+            else {
+                totalSize += stats.size;
+            }
+        }
+    }
+    await readDirRecursive(dirPath);
+    return totalSize / (1024 * 1024); // MB
+}
+exports.default = (0, architect_1.createBuilder)(async (options, context) => {
+    const target = context.target;
+    const env = target.configuration || await getDefaultConfigurationName(target, context.workspaceRoot);
+    const processEnv = {};
+    dotenv.config({
+        path: path.resolve(process.cwd(), `.env.${env}`),
+        processEnv: processEnv
+    });
+    options.username ||= processEnv.NG_DEPLOY_USERNAME;
+    options.password ||= processEnv.NG_DEPLOY_PASSWORD;
+    options.webhook ||= processEnv.NG_DEPLOY_WEBHOOK;
+    if (!options.username) {
+        options.username = await askUsername();
+    }
+    if (!options.password) {
+        options.password = await askPassword();
+    }
+    const buildTarget = {
+        project: target.project,
+        target: 'build',
+        configuration: target.configuration
+    };
+    // build
+    if (!options.skipBuild) {
+        const build = await context.scheduleTarget(buildTarget);
+        await build.result;
+        // next line
+        console.log('');
+    }
+    let spinner = createSpinner('Establishing remote connection...').start();
+    const SftpClient = await Promise.resolve().then(() => require('ssh2-sftp-client'));
+    const sftp = new SftpClient();
+    try {
+        await sftp.connect(options);
+        spinner.succeed('Successfully connected to remote.').stop();
+        spinner = createSpinner('Uninstalling old application on remote...').start();
+        await uninstallRemoteApp(sftp, options.remotePath);
+        spinner.succeed('The old application uninstall completed.').stop();
+        spinner = createSpinner('Deploying new application to remote...').start();
+        if (!options.localPath) {
+            const { outputOptions } = await (0, options_1.normalizeOptions)(context, buildTarget.project, await context.getTargetOptions(buildTarget));
+            options.localPath = `${outputOptions.base}/${outputOptions.browser}`;
+        }
+        await sftp.uploadDir(options.localPath, options.remotePath, {
+            useFastput: true
+        });
+        spinner.succeed('Application deployment completed.');
+        if (options.webhook) {
+            callWebhook(options, target.project, env);
+        }
+    }
+    catch (error) {
+        spinner.fail('Application deployment failed.');
+        console.error(error);
+        return { success: false };
+    }
+    finally {
+        sftp.end();
+        spinner.stop();
+    }
+    return { success: true };
+});
+//# sourceMappingURL=builder.js.map

package/deploy/builder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"builder.js","sourceRoot":"","sources":["../../../../packages/builder/src/deploy/builder.ts"],"names":[],"mappings":";;AAAA,yDAAiG;AACjG,+CAAkD;AAClD,oDAA2D;AAC3D,6EAAsH;AACtH,kEAAoE;AACpE,iCAAiC;AACjC,kCAAkC;AAClC,kCAAkC;AAClC,6BAAsB;AAItB,KAAK,UAAU,WAAW;IACxB,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,MAAM,IAAA,wBAAa,EAA4B,UAAU,CAAC,CAAC;IACzF,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,QAAQ,CAAC,MAAM,CAAC;QACzC;YACE,IAAI,EAAE,OAAO;YACb,IAAI,EAAE,UAAU;YAChB,OAAO,EAAE,8BAA8B;SACxC;KACF,CAAC,CAAC;IACH,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,KAAK,UAAU,WAAW;IACxB,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,MAAM,IAAA,wBAAa,EAA4B,UAAU,CAAC,CAAC;IACzF,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,QAAQ,CAAC,MAAM,CAAC,CAAC;YAC1C,IAAI,EAAE,UAAU;YAChB,IAAI,EAAE,UAAU;YAChB,OAAO,EAAE,8BAA8B;YACvC,IAAI,EAAE,GAAG;SACV,CAAC,CAAC,CAAC;IACJ,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,SAAS,aAAa,CAAC,IAAa;IAClC,OAAO,IAAA,aAAG,EAAC;QACT,IAAI;QACJ,0EAA0E;QAC1E,uCAAuC;QACvC,UAAU,EAAE,KAAK;QACjB,YAAY,EAAE,KAAK;QACnB,SAAS,EAAE,IAAI;KAChB,CAAC,CAAC;AACL,CAAC;AAED,KAAK,UAAU,WAAW,CAAC,OAAe,EAAE,GAAW,EAAE,GAAW;IAClE,MAAM,KAAK,GAAG,2CAAa,OAAO,EAAC,CAAC;IACpC,MAAM,EAAE,GAAG,2CAAa,IAAI,EAAC,CAAC;IAC9B,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,OAAQ,CAAC,CAAC;IACjE,MAAM,EAAE,QAAQ,EAAE,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC;IACnC,MAAM,IAAI,GAAG,MAAM,gBAAgB,CAAC,OAAO,CAAC,SAAU,CAAC,CAAC;IACxD,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC;QAC1B,OAAO,EAAE,UAAU;QACnB,QAAQ,EAAE;YACR,KAAK,EAAE,sBAAsB;YAC7B,IAAI,EAAE;gBACJ,0BAA0B;gBAC1B,KAAK;gBACL,YAAY,GAAG,EAAE;gBACjB,YAAY,GAAG,EAAE;gBACjB,YAAY,QAAQ,EAAE;gBACtB,YAAY,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK;aACjC,CAAC,IAAI,CAAC,OAAO,CAAC;SAChB;KACF,CAAC,CAAC;IAEH,OAAO,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QAC3C,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,CAC3B;YACE,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,QAAQ,GAAG,MAAM;YACvB,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;aACnC;SACF,EACD,QAAQ,CAAC,EAAE;YACT,4GAA4G;YAC5G,gEAAgE;YAChE,QAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;YAE/B,IAAI,QAAQ,CAAC,UAAU,KAAK,GAAG,IAAI,QAAQ,CAAC,UAAU,KAAK,GAAG,EAAE,CAAC;gBAC/D,MAAM,CACJ,IAAI,KAAK,CAAC,4CAA4C,QAAQ,CAAC,UAAU,GAAG,CAAC,CAC9E,CAAC;YACJ,CAAC;iBAAM,CAAC;gBACN,OAAO,EAAE,CAAC;YACZ,CAAC;QACH,CAAC,CACF,CAAC;QACF,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QAC5B,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACpB,OAAO,CAAC,GAAG,EAAE,CAAC;IAChB,CAAC,CAAC,CAAC;AACL,CAAC;AAED,KAAK,UAAU,kBAAkB,CAAC,IAAgB,EAAE,UAAkB;IACpE,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IAEzC,KAAK,MAAM,IAAI,IAAI,IAAI,EAAE,CAAC;QACxB,IAAI,IAAI,CAAC,IAAI,KAAK,GAAG,EAAE,CAAC;YACtB,MAAM,IAAI,CAAC,KAAK,CAAC,GAAG,UAAU,IAAI,IAAI,CAAC,IAAI,EAAE,EAAE,IAAI,CAAC,CAAC;QACvD,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,UAAU,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;QAClD,CAAC;IACH,CAAC;AACH,CAAC;AAED,KAAK,UAAU,2BAA2B,CAAC,MAAc,EAAE,aAAqB;IAC9E,MAAM,EAAE,SAAS,EAAE,GAAG,MAAM,iBAAU,CAAC,aAAa,CAClD,aAAa,GAAG,eAAe,EAC/B,iBAAU,CAAC,mBAAmB,CAAC,IAAI,qBAAc,EAAE,CAAC,CACrD,CAAC;IAEF,OAAO,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,OAAO,CAAE,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,CAAE,CAAC,oBAAqB,CAAC;AACnG,CAAC;AAED,KAAK,UAAU,gBAAgB,CAAC,OAAe;IAC7C,IAAI,SAAS,GAAG,CAAC,CAAC;IAElB,KAAK,UAAU,gBAAgB,CAAC,WAAmB;QACjD,KAAK,MAAM,IAAI,IAAI,MAAM,EAAE,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC;YACjD,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;YAC9C,MAAM,KAAK,GAAG,MAAM,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAEtC,IAAI,KAAK,CAAC,WAAW,EAAE,EAAE,CAAC;gBACxB,MAAM,gBAAgB,CAAC,QAAQ,CAAC,CAAC;YACnC,CAAC;iBAAM,CAAC;gBACN,SAAS,IAAI,KAAK,CAAC,IAAI,CAAC;YAC1B,CAAC;QACH,CAAC;IACH,CAAC;IAED,MAAM,gBAAgB,CAAC,OAAO,CAAC,CAAC;IAChC,OAAO,SAAS,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC,KAAK;AACzC,CAAC;AAED,kBAAe,IAAA,yBAAa,EAC1B,KAAK,EAAE,OAAe,EAAE,OAAuB,EAA0B,EAAE;IACzE,MAAM,MAAM,GAAG,OAAO,CAAC,MAAO,CAAC;IAC/B,MAAM,GAAG,GAAG,MAAM,CAAC,aAAa,IAAI,MAAM,2BAA2B,CAAC,MAAM,EAAE,OAAO,CAAC,aAAa,CAAC,CAAC;IACrG,MAAM,UAAU,GAAc,EAAE,CAAC;IAEjC,MAAM,CAAC,MAAM,CAAC;QACZ,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,QAAQ,GAAG,EAAE,CAAC;QAChD,UAAU,EAAE,UAAoC;KACjD,CAAC,CAAC;IAEH,OAAO,CAAC,QAAQ,KAAK,UAAU,CAAC,kBAAkB,CAAC;IACnD,OAAO,CAAC,QAAQ,KAAK,UAAU,CAAC,kBAAkB,CAAC;IACnD,OAAO,CAAC,OAAO,KAAK,UAAU,CAAC,iBAAiB,CAAC;IAEjD,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;QACtB,OAAO,CAAC,QAAQ,GAAG,MAAM,WAAW,EAAE,CAAC;IACzC,CAAC;IAED,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;QACtB,OAAO,CAAC,QAAQ,GAAG,MAAM,WAAW,EAAE,CAAC;IACzC,CAAC;IAED,MAAM,WAAW,GAAW;QAC1B,OAAO,EAAE,MAAM,CAAC,OAAO;QACvB,MAAM,EAAE,OAAO;QACf,aAAa,EAAE,MAAM,CAAC,aAAc;KACrC,CAAC;IAEF,QAAQ;IACR,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC;QACvB,MAAM,KAAK,GAAG,MAAM,OAAO,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;QACxD,MAAM,KAAK,CAAC,MAAM,CAAC;QACnB,YAAY;QACZ,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IAClB,CAAC;IAED,IAAI,OAAO,GAAG,aAAa,CAAC,mCAAmC,CAAC,CAAC,KAAK,EAAE,CAAC;IAEzE,MAAM,UAAU,GAAG,2CAAa,kBAAkB,EAAC,CAAC;IACpD,MAAM,IAAI,GAAG,IAAI,UAAU,EAAE,CAAC;IAE9B,IAAI,CAAC;QACH,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAE5B,OAAO,CAAC,OAAO,CAAC,mCAAmC,CAAC,CAAC,IAAI,EAAE,CAAC;QAE5D,OAAO,GAAG,aAAa,CAAC,2CAA2C,CAAC,CAAC,KAAK,EAAE,CAAC;QAE7E,MAAM,kBAAkB,CAAC,IAAI,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC;QAEnD,OAAO,CAAC,OAAO,CAAC,0CAA0C,CAAC,CAAC,IAAI,EAAE,CAAC;QAEnE,OAAO,GAAG,aAAa,CAAC,wCAAwC,CAAC,CAAC,KAAK,EAAE,CAAC;QAE1E,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC;YACvB,MAAM,EAAE,aAAa,EAAE,GAAG,MAAM,IAAA,0BAAgB,EAC9C,OAAO,EACP,WAAW,CAAC,OAAO,EACnB,MAAM,OAAO,CAAC,gBAAgB,CAAC,WAAW,CAAiD,CAC5F,CAAC;YACF,OAAO,CAAC,SAAS,GAAG,GAAG,aAAa,CAAC,IAAI,IAAI,aAAa,CAAC,OAAO,EAAE,CAAC;QACvE,CAAC;QAED,MAAM,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,SAAU,EAAE,OAAO,CAAC,UAAU,EAAE;YAC3D,UAAU,EAAE,IAAI;SACjB,CAAC,CAAC;QAEH,OAAO,CAAC,OAAO,CAAC,mCAAmC,CAAC,CAAC;QAErD,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;YACpB,WAAW,CAAC,OAAO,EAAE,MAAM,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;QAC5C,CAAC;IACH,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,CAAC,IAAI,CAAC,gCAAgC,CAAC,CAAC;QAC/C,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAErB,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;IAC5B,CAAC;YAAS,CAAC;QACT,IAAI,CAAC,GAAG,EAAE,CAAC;QACX,OAAO,CAAC,IAAI,EAAE,CAAC;IACjB,CAAC;IAED,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;AAC3B,CAAC,CACF,CAAC"}

package/deploy/interface.d.ts

@@ -0,0 +1,15 @@
+export interface Schema {
+    host: string;
+    port: number;
+    username?: string;
+    password?: string;
+    remotePath: string;
+    localPath?: string;
+    skipBuild?: boolean;
+    webhook?: string;
+}
+export interface DeployEnv {
+    NG_DEPLOY_USERNAME?: string;
+    NG_DEPLOY_PASSWORD?: string;
+    NG_DEPLOY_WEBHOOK?: string;
+}

package/deploy/interface.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=interface.js.map

package/deploy/interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"interface.js","sourceRoot":"","sources":["../../../../packages/builder/src/deploy/interface.ts"],"names":[],"mappings":""}

package/deploy/schema.json

@@ -0,0 +1,36 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "Schema",
+  "title": "schema",
+  "description": "Deployment of Angular applications to remote",
+  "properties": {
+    "host": {
+      "type": "string",
+      "description": "Remote host address"
+    },
+    "port": {
+      "type": "number",
+      "default": 22,
+      "description": "Remote host port"
+    },
+    "username": {
+      "type": "string"
+    },
+    "remotePath": {
+      "type": "string",
+      "default": "./"
+    },
+    "localPath": {
+      "type": "string"
+    },
+    "password": {
+      "type": "string"
+    },
+    "skipBuild": {
+      "type": "boolean"
+    },
+    "webhook": {
+      "type": "string"
+    }
+  }
+}

package/index.d.ts

@@ -0,0 +1,2 @@
+declare const _default: undefined;
+export default _default;

package/index.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = void 0;
+//# sourceMappingURL=index.js.map

package/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../packages/builder/src/index.ts"],"names":[],"mappings":";;AAAA,kBAAe,KAAK,CAAC,CAAC"}

package/package.json

@@ -0,0 +1,22 @@
+{
+  "name": "@solar-angular/builder",
+  "version": "1.0.0",
+  "type": "commonjs",
+  "builders": "./builders.json",
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "tslib": "^2.3.0",
+    "inquirer": "^12.0.0",
+    "ssh2-sftp-client": "^9.0.0",
+    "dotenv": "^16.4.0",
+    "ora": "^8.1.0"
+  },
+  "devDependencies": {
+    "@types/ssh2-sftp-client": "^9.0.0",
+    "@angular-devkit/architect": "^0.1802"
+  },
+  "types": "./index.d.ts",
+  "main": "./index.js"
+}