open-index/open-npm huggingface dataset:
npm package: @sumor/ssh-tools
Description: SSH connections and tools that are simple, easy to use, and scalable.
Author: Sumor Cloud Ltd
Latest version: 1.0.7

# ssh-tools

SSH connections and tools that are simple, easy to use, and scalable.

[![CI](https://github.com/sumor-cloud/ssh-tools/actions/workflows/ci.yml/badge.svg)](https://github.com/sumor-cloud/ssh-tools/actions/workflows/ci.yml)
[![Test](https://github.com/sumor-cloud/ssh-tools/actions/workflows/ut.yml/badge.svg)](https://github.com/sumor-cloud/ssh-tools/actions/workflows/ut.yml)
[![Coverage](https://github.com/sumor-cloud/ssh-tools/actions/workflows/coverage.yml/badge.svg)](https://github.com/sumor-cloud/ssh-tools/actions/workflows/coverage.yml)
[![Audit](https://github.com/sumor-cloud/ssh-tools/actions/workflows/audit.yml/badge.svg)](https://github.com/sumor-cloud/ssh-tools/actions/workflows/audit.yml)

## Installation

```bash
npm install ssh-tools --save
```

## Prerequisites

### Node.JS version

Require Node.JS version 18.x or above

## Usage

### SSH Connection

```javascript
const SSH = require('@sumor/ssh-tools')
const ssh = SSH({
  // fake server details, replace with your own
  host: '62.16.12.88',
  iHost: '172.11.200.330',
  port: 22,
  username: 'root',
  password: 'password'
})

await ssh.connect()
await ssh.disconnect()
```

### SSH Command

```javascript
const SSH = require('@sumor/ssh-tools')
const ssh = SSH(server)

await ssh.connect()
try {
  const result = await ssh.exec('ls -la')
  console.log(result)
  await ssh.disconnect()
} catch (error) {
  await ssh.disconnect() // don't forget to disconnect if error occurs
  throw error
}
```

### More examples

Please check the [Unit Test](https://github.com/sumor-cloud/ssh-tools/tree/main/test)
npm package: @sumor/storage
Description: It can connect to various storage services, such as Aliyun OSS
Author: Sumor Cloud Ltd
Latest version: 1.0.4

# storage

A [Sumor Cloud](https://sumor.cloud) Tool.  
[More Documentation](https://sumor.cloud/storage)

This is a lightweight storage library for Node.JS.
It can connect to various storage services, such as Aliyun OSS

[![CI](https://github.com/sumor-cloud/storage/actions/workflows/ci.yml/badge.svg)](https://github.com/sumor-cloud/storage/actions/workflows/ci.yml)
[![Test](https://github.com/sumor-cloud/storage/actions/workflows/ut.yml/badge.svg)](https://github.com/sumor-cloud/storage/actions/workflows/ut.yml)
[![Coverage](https://github.com/sumor-cloud/storage/actions/workflows/coverage.yml/badge.svg)](https://github.com/sumor-cloud/storage/actions/workflows/coverage.yml)
[![Audit](https://github.com/sumor-cloud/storage/actions/workflows/audit.yml/badge.svg)](https://github.com/sumor-cloud/storage/actions/workflows/audit.yml)

## Installation

```bash
npm i @sumor/storage --save
```

## Prerequisites

### Node.JS version

Require Node.JS version 18.x or above

### require Node.JS ES module

As this package is written in ES module,
please change the following code in your `package.json` file:

```json
{
  "type": "module"
}
```

## Usage

### Import

```js
import { Storage } from '@sumor/storage'

const storage = new Storage(config)
```

### Config format

example for aliyun OSS

```json
{
  "type": "aliyunOSS",
  "accessKeyId": "xxxx",
  "accessKeySecret": "xxx",
  "region": "oss-us-west-1",
  "bucket": "sumor-cloud"
}
```

### Put

put content support text, buffer, stream

```js
import { Storage } from '@sumor/storage'

const storage = new Storage(config)

const filename = 'demo.txt'
const content = 'Hello World'

const result = await storage.put(filename, content)
```

### Get

```js
import { Storage } from '@sumor/storage'

const storage = new Storage(config)

const filename = 'demo.txt'

const result = await storage.get(filename)
```

### Delete

```js
import { Storage } from '@sumor/storage'

const storage = new Storage(config)

const filename = 'demo.txt'

const result = await storage.delete(filename)
```
npm package: @sumor/token-middleware
Description: A token middleware for ExpressJS.
Author: Sumor Cloud Ltd
Latest version: 1.1.0

# token-middleware

A [Sumor Cloud](https://sumor.cloud) Tool.  
[More Documentation](https://sumor.cloud/token-middleware)

A token middleware for ExpressJS.

[![CI](https://github.com/sumor-cloud/token-middleware/actions/workflows/ci.yml/badge.svg)](https://github.com/sumor-cloud/token-middleware/actions/workflows/ci.yml)
[![Test](https://github.com/sumor-cloud/token-middleware/actions/workflows/ut.yml/badge.svg)](https://github.com/sumor-cloud/token-middleware/actions/workflows/ut.yml)
[![Coverage](https://github.com/sumor-cloud/token-middleware/actions/workflows/coverage.yml/badge.svg)](https://github.com/sumor-cloud/token-middleware/actions/workflows/coverage.yml)
[![Audit](https://github.com/sumor-cloud/token-middleware/actions/workflows/audit.yml/badge.svg)](https://github.com/sumor-cloud/token-middleware/actions/workflows/audit.yml)

## Installation

```bash
npm i @sumor/token-middleware --save
```

## Prerequisites

### Node.JS version

Require Node.JS version 18.x or above

### require Node.JS ES module

As this package is written in ES module,
please change the following code in your `package.json` file:

```json
{
  "type": "module"
}
```

## Usage

### Add token middleware to ExpressJS App

```javascript
import express from 'express'
import tokenMiddleware from '@sumor/token-middleware'

const app = express()
app.use(tokenMiddleware)

// load token
app.use(async (req, res, next) => {
  const tokenId = req.token.id
  const tokenInfo = await fetchToken(tokenId)
  req.token.user = tokenInfo.user
  req.token.data = tokenInfo.data
  req.token.permission = tokenInfo.permission
  next()
})

// set token
app.get('/login', async (req, res) => {
  const username = req.query.username
  const password = req.query.password
  req.token.id = await createToken(username, password)
  // it will automatic add token to response header cookie 't'
  res.send('Login Success')
})

// use token
app.get('/api', (req, res) => {
  // check permission
  req.token.check('AUTH1')

  res.send('Hello World')
})
```

### permission check

```javascript
// get permission
req.token.permission = {
  AUTH1: ['READ', 'WRITE'],
  AUTH2: ['READ']
}
const hasAuth1 = req.token.has('AUTH1') // true
const hasAuth2 = req.token.has('AUTH2') // true
const hasAuth3 = req.token.has('AUTH3') // false

const hasAuth1Read = req.token.has('AUTH1', 'READ') // true
const hasAuth1Write = req.token.has('AUTH1', 'WRITE') // true
const hasAuth2Read = req.token.has('AUTH2', 'READ') // true
const hasAuth2Write = req.token.has('AUTH2', 'WRITE') // false

// check permission
req.token.check('AUTH1') // pass
req.token.check('AUTH2') // pass
req.token.check('AUTH3') // throw Error PERMISSION_DENIED Permission denied: AUTH3
req.token.check('AUTH1', 'READ') // pass
req.token.check('AUTH1', 'WRITE') // pass
req.token.check('AUTH2', 'READ') // pass
req.token.check('AUTH2', 'WRITE') // throw Error PERMISSION_DENIED Permission denied: AUTH2=WRITE
```