Merge branch 'release/v1' into main

Author: warstrolo

.github/workflows/node.yml

@@ -0,0 +1,43 @@
+# This workflow will do a clean install of node dependencies, cache/restore them, build the source code and run tests across different versions of node
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
+
+name: Node.js CI
+
+on:
+  push:
+    branches: 
+    - main
+    - release/*
+    - devs/*
+  pull_request:
+    branches: 
+    - main
+    - release/*
+  schedule:
+    # * is a special character in YAML so you have to quote this string
+    - cron:  '0 2,14 * * *'
+  release:
+    types: # This configuration does not affect the page_build event above
+      - created
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [12.x, 14.x, 16.x]
+        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v2
+      with:
+        node-version: ${{ matrix.node-version }}
+        cache: 'npm'
+    - run: npm install typescript
+    - run: npm ci
+    - run: npm run build --if-present
+#    - run: npm test

README.md

@@ -1,5 +1,19 @@
 # secutilsfiles
+
 simple utils to crypt / decrypt files with AES
 
+# Usage
+
+`await secutils.files.CryptFile("./text.text", "./text.text.enc", "one")`
+
+`await secutils.files.DecryptFile("./text.text.enc", "./text.text.dec", "one")`
+
+`await secutils.dir.CryptDir("./dir","./dir.enc", "one")`
+
+`await secutils.dir.DecryptDir("./dir.enc","./dir.dec", "one")`
+
+# Building the module :
+
+## Requirements : 
 
-# 
+- typescript v3.X or newer

package-lock.json

@@ -1,25 +1,30 @@
 {
   "name": "secutilsfiles",
-  "version": "1.0.5",
+  "version": "2.0.0",
   "description": "A simple package to crypt and decrypt files",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
-  
+  "type": "module",
+  "keywords": [
+    "aes",
+    "files",
+    "directory",
+    "crypt",
+    "decrypt"
+  ],
   "scripts": {
-    "prepublish": "tsc",
     "start": "tsc && node .",
     "build": "tsc",
     "test": "node test"
   },
-
   "author": "Paul Millet <[email protected]>",
   "license": "MIT",
   "dependencies": {
-    "@types/node": "^16.7.2",
+    "@types/cryptr": "^4.0.1",
+    "@types/node": "^16.7.5",
     "aes256": "^1.1.0",
     "cryptr": "^6.0.2",
-    "dotenv": "^10.0.0",
-    "typescript": "^4.4.2"
+    "dotenv": "^10.0.0"
   },
   "repository": {
     "type": "git",
@@ -30,7 +35,6 @@
   },
   "homepage": "https://github.com/bigopenworld/secutilsfiles/issues",
   "devDependencies": {
-    "@types/cryptr": "^4.0.1",
-    "typescript": "^2.7.2"
+    "typescript": "^3.0.0"
   }
 }

package.json

@@ -0,0 +1,29 @@
+import { files, utils } from "./index.js"
+
+/** DecryptFile function 
+* @param {string} path take the path of the input dir
+* @param {string} dest take the path of the destination dir
+* @param {string} key take the secret key
+* @return {string} Return the key
+*/
+export async function CryptDir(path : string, dest : string, key : string) : Promise<string> {
+  let files_list = utils.readDir(path)
+  ;(await files_list).map((e)=> {
+    files.CryptFile(`${path}/${e}`,`${dest}/${e}`, key)
+  })
+  return key
+}
+
+/** DecryptFile function 
+* @param {string} path take the path of the input dir
+* @param {string} dest take the path of the destination dir
+* @param {string} key take the secret key
+* @return {string} Return the key
+*/
+export async function DecryptDir(path : string, dest : string, key : string) : Promise<string> {
+  let files_list = utils.readDir(path)
+  ;(await files_list).map((e)=> {
+    files.DecryptFile(`${path}/${e}`,`${dest}/${e}`, key)
+  })
+  return key
+}

src/dir.ts

@@ -0,0 +1,50 @@
+// dependency import
+import Cryptr from "cryptr"
+import fs from "fs"
+import { promisify } from "util"
+import * as utils from "./utils.js"
+// define const
+const readfile = promisify(fs.readFile) // promisify the fs.readFile
+const writefile = promisify(fs.writeFile) // promisify the fs.writeFile
+
+/** Read file function
+* @param {string} path take the path
+* @return {Promise<string>} return promise of data
+*/
+export async function readFile(path : string) : Promise<string> {
+  let files : Buffer = await readfile(path)
+  return files.toString()
+}
+
+/** CryptFile function 
+* @param {string} path take the path of the input file
+* @param {string} dest take the path of the destination file
+* @param {string | undefined} key take the key if none specified one will be generated 
+* @return {string} Return the key
+*/
+export async function CryptFile(path : string, dest : string, key? : string) : Promise<string> {
+  let enckey = key
+  if (!enckey) {
+    enckey = utils.RandomString(20)
+  }
+  let crypt = new Cryptr(enckey)
+  const data = await readFile(path)
+  const dataenc = crypt.encrypt(data)
+  await writefile(dest, dataenc)
+  return enckey
+}
+
+/** DecryptFile function 
+* @param {string} path take the path of the input file
+* @param {string} dest take the path of the destination file
+* @param {string} key take the secret key
+* @return {string} Return the key
+*/
+export async function DecryptFile(path : string, dest : string, key : string) : Promise<string> {
+  let enckey = key
+  let crypt = new Cryptr(enckey)
+  const data = await readFile(path)
+  const dataenc = crypt.decrypt(data)
+  await writefile(dest, dataenc)
+  return enckey
+}

src/files.ts

@@ -1,78 +1,7 @@
-// dependency import
-import Cryptr from "cryptr"
-import fs from "fs"
-import  { promisify } from "util"
-
-// Define const
-
-
-const readdir = promisify(fs.readdir) // promisify the fs.readdir 
-const readfile = promisify(fs.readFile) // promisify the fs.readFile
-const writefile = promisify(fs.writeFile) // promisify the fs.writeFile
-const randomChar = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789"
-const randomcharlengh = randomChar.length;
-
-/** Read dir function
-* @param {string} directory take the directory
-* @return {Promise<string[]>} return a promise of files path
-* Will be use when encrypt dir feature will be created
-*/
-export async function readDir(directory : string) : Promise<string[]> {
-  let files = await readdir(directory)
-  return files.map(file => `${directory}/${file}`)
-}
-
-/** Read file function
-* @param {string} path take the path
-* @return {Promise<string>} return promise of data
-*/
-export async function readFile(path : string) : Promise<string> {
-  let files : Buffer = await readfile(path)
-  return files.toString()
-}
-
-/** RandomString function 
-* @param {number} length take the number of element in your string
-* @return {string} Return the random string 
-*/
-export function RandomString(length : number) : string {
-  var result : string = ""
-  for ( var i = 0; i < length; i++ ) {
-    result += randomChar.charAt(Math.floor(Math.random() * randomcharlengh));
-  }
-  return result
-}
-
-/** CryptFile function 
-* @param {string} path take the path of the input file
-* @param {string} dest take the path of the destination file
-* @param {string | undefined} key take the key if none specified one will be generated 
-* @return {string} Return the key
-*/
-export async function CryptFile(path : string, dest : string, key? : string) : Promise<string> {
-  let enckey = key
-  if (!enckey) {
-    enckey = RandomString(20)
-  }
-  let crypt = new Cryptr(enckey)
-  const data = await readFile(path)
-  const dataenc = crypt.encrypt(data)
-  await writefile(dest, dataenc)
-  return enckey
-}
-
-/** DecryptFile function 
-* @param {string} path take the path of the input file
-* @param {string} dest take the path of the destination file
-* @param {string} key take the secret key
-* @return {string} Return the key
-*/
-export async function DecryptFile(path : string, dest : string, key : string) : Promise<string> {
-  let enckey = key
-  let crypt = new Cryptr(enckey)
-  const data = await readFile(path)
-  const dataenc = crypt.decrypt(data)
-  await writefile(dest, dataenc)
-  return enckey
-}
+// import other files
+import * as files from "./files.js"
+import * as utils from "./utils.js"
+import * as dir from "./dir.js"
 
+export {files, utils, dir}
+export default {files, utils, dir}