ssh-client-wrapper 2.13.2 → 2.14.0

package/lib/index.d.ts

@@ -0,0 +1,61 @@
+declare module "ssh-client-wrapper" {
+  type HostInfo = {
+    host: string;
+    user: string;
+    port?: number;
+    password?: string | (() => string);
+    passphrase?: string | (() => string);
+    keyFile?: string;
+    noStrictHostKeyChecking?: boolean;
+    ControlPersist?: number;
+    ConnectTimeout?: number;
+    maxRetry?: number;
+    retryDuration?: number;
+    rcfile?: string;
+    prependCmd?: string;
+    sshOpt?: string[];
+  };
+
+  class SshClientWrapper {
+    constructor(hostInfo: HostInfo);
+    exec(
+      cmd: string,
+      timeout?: number,
+      outputCallback?: (data: string) => void,
+      rcfile?: string,
+      prependCmd?: string
+    ): Promise<number>;
+    execAndGetOutput(
+      cmd: string,
+      timeout?: number,
+      rcfile?: string,
+      prependCmd?: string
+    ): Promise<{ output: string[]; rt: number }>;
+    ls(
+      target: string,
+      lsOpt?: string[],
+      timeout?: number
+    ): Promise<string[] | number>;
+    expect(
+      cmd: string,
+      expects: [string, string][],
+      timeout?: number
+    ): Promise<number>;
+    send(
+      src: string[],
+      dst: string,
+      opt?: string[],
+      timeout?: number
+    ): Promise<void>;
+    recv(
+      src: string[],
+      dst: string,
+      opt?: string[],
+      timeout?: number
+    ): Promise<void>;
+    canConnect(timeout?: number): Promise<boolean>;
+    disconnect(): Promise<void>;
+  }
+
+  export default SshClientWrapper;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ssh-client-wrapper",
-  "version": "2.13.2",
+  "version": "2.14.0",
   "description": "wrapper library for open ssh client and rsync",
   "keywords": [
     "ssh",
@@ -13,6 +13,7 @@
   ],
   "type": "module",
   "main": "lib/index.js",
+  "types": "lib/index.d.ts",
   "scripts": {
     "mocha": "mocha --recursive test",
     "lint": "eslint --fix ./",

package/.dockerignore

@@ -1,2 +0,0 @@
-node_modules
-run_test_all.sh

package/.github/dependabot.yml

@@ -1,11 +0,0 @@
-# To get started with Dependabot version updates, you'll need to specify which
-# package ecosystems to update and where the package manifests are located.
-# Please see the documentation for all configuration options:
-# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
-
-version: 2
-updates:
-  - package-ecosystem: "" # See documentation for possible values
-    directory: "/" # Location of package manifests
-    schedule:
-      interval: "weekly"

package/.github/workflows/coverage_report.yml

@@ -1,24 +0,0 @@
-name: report coverage data to code climate
-on:
-  push:
-    branches:
-      - main
-jobs:
-  test:
-    uses: ./.github/workflows/run_test.yml
-  coverage:
-    needs:
-      - test
-    name: coverage report
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - uses: actions/download-artifact@v4
-        with:
-          name: code-coverage-report
-      - uses: paambaati/codeclimate-action@v5.0.0
-        env:
-          CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
-        with:
-          coverageLocations: "coverage-report.lcov:lcov"
-          debug: true

package/.github/workflows/release.yml

@@ -1,29 +0,0 @@
-name: Release and Publish
-
-on:
-  push:
-    branches:
-      - main
-
-jobs:
-  test:
-    uses: ./.github/workflows/run_test.yml
-
-  release:
-    needs: test
-    runs-on: ubuntu-latest
-    permissions:
-      contents: write
-      issues: write
-      pull-requests: write
-    steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-node@v4
-        with:
-          node-version: 20
-      - run: npm ci
-      - name: Semantic Release
-        uses: cycjimmy/semantic-release-action@v4
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

package/.github/workflows/run_test.yml

@@ -1,40 +0,0 @@
-name: run UT
-on:
-  pull_request:
-    branches:
-      - main
-  workflow_call:
-concurrency:
-  group: ${{ github.workflow }}-${{ github.ref }}
-  cancel-in-progress: true
-jobs:
-  test:
-    services:
-      testbed:
-        image: naoso5/test-sshd
-        ports:
-          - 10022:22
-    env:
-      TEST_USER: testuser
-      TEST_PW: passw0rd
-      TEST_PORT: 10022
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        node-version: [16.x, 18.x, 20.x, 22.x]
-    steps:
-      - uses: actions/checkout@v4
-      - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v4
-        with:
-          node-version: ${{ matrix.node-version }}
-      - run: npm ci
-      - run: npm run test
-      - run: npm run coverage
-        if: matrix.node-version == '22.x'
-      - uses: actions/upload-artifact@v4
-        if: matrix.node-version == '22.x'
-        with:
-          name: code-coverage-report
-          path: coverage-report.lcov
-          retention-days: 1

package/.husky/_pre-commit

@@ -1 +0,0 @@
-npx lint-staged

package/.husky/pre-commit

@@ -1 +0,0 @@
-npx lint-staged

package/.releaserc.json

@@ -1,16 +0,0 @@
-{
-  "branches": ["main"],
-  "plugins": [
-    "@semantic-release/commit-analyzer",
-    "@semantic-release/release-notes-generator",
-    "@semantic-release/changelog",
-    ["@semantic-release/npm", {
-      "npmPublish": true
-    }],
-    ["@semantic-release/git", {
-      "assets": ["package.json", "package-lock.json", "CHANGELOG.md"],
-      "message": "chore(release): ${nextRelease.version} [skip ci]\\n\\n${nextRelease.notes}"
-    }],
-    "@semantic-release/github"
-  ]
-}

package/CHANGELOG.md

@@ -1,27 +0,0 @@
-## [2.13.2](https://github.com/so5/ssh-client-wrapper/compare/v2.13.1...v2.13.2) (2025-11-04)
-
-
-### Bug Fixes
-
-* upgrade debug from 4.4.1 to 4.4.3 ([787706c](https://github.com/so5/ssh-client-wrapper/commit/787706ce2ee5f1144e1d5ccb2e11b06c498df0dd))
-
-## [2.13.1](https://github.com/so5/ssh-client-wrapper/compare/v2.13.0...v2.13.1) (2025-08-20)
-
-
-### Bug Fixes
-
-* Update Code Climate workflow trigger ([7cf0a93](https://github.com/so5/ssh-client-wrapper/commit/7cf0a93913ceef762c267cb3a947c176479ce068))
-
-# [2.13.0](https://github.com/so5/ssh-client-wrapper/compare/v2.12.4...v2.13.0) (2025-08-20)
-
-
-### Bug Fixes
-
-* upgrade debug from 4.4.0 to 4.4.1 ([35f966a](https://github.com/so5/ssh-client-wrapper/commit/35f966a7212d6bb9677964688bb94ae06f869ada))
-
-
-### Features
-
-* Improve DX and automate releases ([805f2ea](https://github.com/so5/ssh-client-wrapper/commit/805f2ea7756f6ad61238a4a21d86575a17e748d9))
-* Rewrite in ESM ([c5a95c1](https://github.com/so5/ssh-client-wrapper/commit/c5a95c18401e7b373249d3707609f2a9576f7400))
-* Rewrite in ESM ([71ed6f5](https://github.com/so5/ssh-client-wrapper/commit/71ed6f56af43cac1471cbf4a4ed3016f7e55ab4d))

package/Dockerfile

@@ -1,7 +0,0 @@
-# syntax=docker/dockerfile:1
-FROM --platform=linux/amd64 node:20-bookworm-slim
-
-WORKDIR /work/ssh-client-wrapper
-RUN apt-get update && apt -y install ssh rsync bzip2 python3 g++ build-essential
-COPY ./ ./
-RUN npm install

package/Dockerfile-bullseye

@@ -1,7 +0,0 @@
-# syntax=docker/dockerfile:1
-FROM --platform=linux/amd64 node:20-bookworm-slim
-
-WORKDIR /work/ssh-client-wrapper
-RUN apt-get update && apt -y install ssh rsync bzip2 python3 g++ build-essential
-COPY ./ ./
-RUN npm install

package/Dockerfile-buster

@@ -1,7 +0,0 @@
-# syntax=docker/dockerfile:1
-FROM --platform=linux/amd64 node:20-bookworm-slim
-
-WORKDIR /work/ssh-client-wrapper
-RUN apt-get update && apt -y install ssh rsync bzip2 python3 g++ build-essential
-COPY ./ ./
-RUN npm install

package/compose.yml

@@ -1,36 +0,0 @@
-services:
-  testbed:
-    image: naoso5/test-sshd
-    ports:
-      - "4100:22"
-    container_name: testbed
-  tester:
-    build:
-      context: .
-      dockerfile: Dockerfile
-    environment:
-      TEST_USER: testuser
-      TEST_PW: passw0rd
-      TEST_HOST: testbed
-    working_dir: /work/ssh-client-wrapper
-    command: bash -c "mkdir /root/.ssh 2>/dev/null; npm run mocha"
-  tester-bullseye:
-    build:
-      context: .
-      dockerfile: Dockerfile-bullseye
-    environment:
-      TEST_USER: testuser
-      TEST_PW: passw0rd
-      TEST_HOST: testbed
-    working_dir: /work/ssh-client-wrapper
-    command: bash -c "mkdir /root/.ssh 2>/dev/null;  npm run mocha"
-  tester-buster:
-    build:
-      context: .
-      dockerfile: Dockerfile-buster
-    environment:
-      TEST_USER: testuser
-      TEST_PW: passw0rd
-      TEST_HOST: testbed
-    working_dir: /work/ssh-client-wrapper
-    command: bash -c "mkdir /root/.ssh 2>/dev/null;  npm run mocha"

package/eslint.config.mjs

@@ -1,181 +0,0 @@
-import js from "@eslint/js";
-import globals from "globals";
-import stylistic from "@stylistic/eslint-plugin";
-import jsdoc from "eslint-plugin-jsdoc";
-import eslintPluginChaiFriendly from "eslint-plugin-chai-friendly";
-import eslintPluginChaiExpect from "eslint-plugin-chai-expect";
-
-const styleRules = {
-  "arrow-body-style": ["error", "always"],
-  "@stylistic/arrow-spacing": [
-    "error",
-    {
-      after: false,
-      before: false
-    }],
-  "@stylistic/comma-dangle": [
-    "error",
-    "never"
-  ],
-  "@stylistic/spaced-comment": [
-    "error",
-    "never"
-  ],
-  "@stylistic/lines-around-comment": [
-    "error",
-    {
-      beforeBlockComment: true,
-      afterBlockComment: false,
-      beforeLineComment: false,
-      afterLineComment: false,
-      allowBlockStart: true
-    }
-  ],
-  "@stylistic/lines-between-class-members": [
-    "error",
-    "always",
-    {
-      exceptAfterSingleLine: true
-    }
-  ],
-  "@stylistic/newline-per-chained-call": [
-    "error",
-    {
-      ignoreChainWithDepth: 2
-    }
-  ],
-  "@stylistic/padded-blocks": [
-    "error",
-    "never"
-  ],
-  "@stylistic/brace-style": [
-    "error",
-    "1tbs",
-    {
-      allowSingleLine: true
-    }
-  ],
-  "@stylistic/padding-line-between-statements": [
-    "error",
-    {
-      blankLine: "any",
-      prev: [
-        "const",
-        "let",
-        "var"
-      ],
-      next: "*"
-    },
-    {
-      blankLine: "always",
-      prev: "*",
-      next: [
-        "class",
-        "do",
-        "for",
-        "function",
-        "switch",
-        "try",
-        "while"
-      ]
-    },
-    {
-      blankLine: "any",
-      prev: [
-        "const",
-        "let",
-        "var",
-        "for",
-        "while",
-        "do",
-        "block-like",
-        "multiline-block-like"
-      ],
-      next: [
-        "block-like",
-        "do",
-        "for",
-        "multiline-block-like",
-        "switch",
-        "try",
-        "while"
-      ]
-    }
-  ],
-  "@stylistic/quotes": [
-    "error",
-    "double"
-  ],
-  "@stylistic/semi": [
-    "error",
-    "always"
-  ]
-};
-
-const jsdocRules = {
-  "jsdoc/require-jsdoc": ["warn", { enableFixer: false }],
-  "jsdoc/require-param": ["warn", { enableFixer: false }],
-  "jsdoc/require-param-description": "warn",
-  "jsdoc/require-param-name": "warn",
-  "jsdoc/require-param-type": "warn",
-  "jsdoc/require-hyphen-before-param-description": [
-    "warn",
-    "always"
-  ],
-  "jsdoc/require-returns": "warn",
-  "jsdoc/require-returns-check": "error"
-};
-
-export default [
-  // Global configuration
-  {
-    ignores: ["coverage-report.lcov", "node_modules/"]
-  },
-  js.configs.recommended,
-  {
-    plugins: {
-      "@stylistic": stylistic
-    }
-  },
-  // Lib configuration
-  {
-    files: ["lib/**/*.js"],
-    plugins: {
-      jsdoc
-    },
-    languageOptions: {
-      ecmaVersion: "latest",
-      sourceType: "module",
-      globals: {
-        ...globals.es2021,
-        ...globals.node
-      }
-    },
-    rules: {
-      ...styleRules,
-      ...jsdocRules
-    }
-  },
-  // Test configuration
-  {
-    files: ["test/**/*.js"],
-    plugins: {
-      "chai-friendly": eslintPluginChaiFriendly,
-      "chai-expect": eslintPluginChaiExpect
-    },
-    languageOptions: {
-      ecmaVersion: "latest",
-      sourceType: "module",
-      globals: {
-        ...globals.es2021,
-        ...globals.node,
-        ...globals.mocha
-      }
-    },
-    rules: {
-      ...styleRules,
-      "no-unused-expressions": "off",
-      "chai-friendly/no-unused-expressions": "error"
-    }
-  }
-];

package/run_test_all.sh

@@ -1,18 +0,0 @@
-#!/bin/bash
-function cleanup(){
-  docker compose down
-}
-trap cleanup EXIT
-set -e -o pipefail
-
-./run_test_local.sh keep
-
-docker compose run --build --rm tester
-echo test on latest ubuntu success
-
-docker compose run --build --rm tester-bullseye
-echo test on bullseye success
-
-docker compose run --build --rm tester-buster
-echo test on buster success
-docker compose down

package/run_test_local.sh

@@ -1,13 +0,0 @@
-#!/bin/bash
-docker compose up testbed -d
-export TEST_HOST=localhost
-export TEST_USER=testuser
-export TEST_PW=passw0rd
-export TEST_PORT=4100
-ssh-keygen -R '[localhost]:4100'
-
-npm run test
-echo local test success
-if [ x${1} != xkeep ];then
-  docker compose down
-fi

package/test/getSshOption.js

@@ -1,49 +0,0 @@
-process.on("unhandledRejection", console.dir);
-
-//setup test framework
-import * as chai from "chai";
-import { expect } from "chai";
-import chaiAsPromised from "chai-as-promised";
-chai.use(chaiAsPromised);
-
-//testee
-import { getSshOption } from "../lib/util.js";
-
-describe("test for getSshOption", ()=>{
-  const defaultValues = {
-    host: "testHostName",
-    ControlPersist: 180,
-    maxRetry: 3,
-    retryDuration: 1000
-  };
-  it("should return minimum ssh option array", ()=>{
-    const sshOpts = getSshOption(defaultValues);
-    expect(sshOpts).to.be.an("array");
-    expect(sshOpts).to.have.lengthOf(4);
-    expect(sshOpts[0]).to.equal(defaultValues.host);
-    expect(sshOpts[1]).to.equal("-oControlMaster=auto");
-    expect(sshOpts[2]).to.equal("-oControlPath=~/.ssh/ssh-client-wrapper-%r@%h:%p");
-    expect(sshOpts[3]).to.equal("-oControlPersist=180");
-  });
-  it("should change ControlPath by ControlPersistDir", ()=>{
-    const hostInfo = { ...defaultValues };
-    hostInfo.ControlPersistDir = "/tmp";
-    const sshOpts = getSshOption(hostInfo);
-    expect(sshOpts).to.be.an("array");
-    expect(sshOpts).to.have.lengthOf(4);
-    expect(sshOpts[0]).to.equal(defaultValues.host);
-    expect(sshOpts[1]).to.equal("-oControlMaster=auto");
-    expect(sshOpts[2]).to.equal("-oControlPath=/tmp/ssh-client-wrapper-%r@%h:%p");
-    expect(sshOpts[3]).to.equal("-oControlPersist=180");
-  });
-  it("should change ControlPath by Environment variable", ()=>{
-    process.env.SSH_CONTROL_PERSIST_DIR = "/tmp";
-    const sshOpts = getSshOption(defaultValues);
-    expect(sshOpts).to.be.an("array");
-    expect(sshOpts).to.have.lengthOf(4);
-    expect(sshOpts[0]).to.equal(defaultValues.host);
-    expect(sshOpts[1]).to.equal("-oControlMaster=auto");
-    expect(sshOpts[2]).to.equal("-oControlPath=/tmp/ssh-client-wrapper-%r@%h:%p");
-    expect(sshOpts[3]).to.equal("-oControlPersist=180");
-  });
-});