spd-lib 1.2.3 → 1.2.4

package/package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "spd-lib",
+  "version": "1.2.4",
+  "description": "SPD or Secure Packaged Data is a compress PQC protected file format to store sensitive data localy",
+  "main": "dist/index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "prepublishOnly": "node obfuscate.js",
+    "package": "cp package-lock.json ./package/package-lock.json ; cp package.json ./package/package.json ; cp -R node_modules ./package/node_modules ; mkdir -p ./package/dist/ ; cp ./dist/index.js ./package/dist/index.js"
+  },
+  "keywords": [
+    "security",
+    "encryption",
+    "data-storage",
+    "persistent",
+    "crypto",
+    "compression",
+    "file",
+    "nodejs",
+    "libsodium",
+    "zlib"
+  ],
+  "author": "ALS-OPSS",
+  "license": "ISC",
+  "dependencies": {
+    "argon2": "^0.41.1",
+    "high-zip": "^1.0.0",
+    "libsodium-wrappers": "^0.7.15"
+  },
+  "devDependencies": {
+    "javascript-obfuscator": "^4.1.1",
+    "terser": "^5.39.0"
+  }
+}

package/package.json

@@ -1,10 +1,12 @@
 {
   "name": "spd-lib",
-  "version": "1.2.3",
+  "version": "1.2.4",
   "description": "SPD or Secure Packaged Data is a compress PQC protected file format to store sensitive data localy",
   "main": "dist/index.js",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "prepublishOnly": "node obfuscate.js",
+    "package": "cp package-lock.json ./package/package-lock.json ; cp package.json ./package/package.json ; cp -R node_modules ./package/node_modules ; mkdir -p ./package/dist/ ; cp ./dist/index.js ./package/dist/index.js"
   },
   "keywords": [
     "security",
@@ -22,6 +24,7 @@
   "license": "ISC",
   "dependencies": {
     "argon2": "^0.41.1",
+    "high-zip": "^1.0.0",
     "libsodium-wrappers": "^0.7.15"
   },
   "devDependencies": {

package/readme.md

@@ -0,0 +1,137 @@
+# Secure Packaged Data (SPD)
+
+The Secure Packaged Data (SPD) module provides functionality to securely store and retrieve data using encryption, compression, and hashing. This README explains how to use the SPD class and its methods.
+
+## Installation
+
+First, ensure you have Node.js installed. Then, install the required packages:
+
+```sh
+npm install spd-lib
+```
+
+## Usage
+
+Below are the primary functionalities of the SPD class.
+
+### Initialization
+
+Create an instance of the SPD class:
+
+```javascript
+const { SPD } = require('spd-lib');
+
+const spd = new SPD();
+```
+
+### Setting Passcode
+
+Set a passcode for encrypting the data:
+
+```javascript
+await spd.setPassKey('your-passcode');
+```
+
+### Adding Data
+
+Add data to the SPD instance:
+
+```javascript
+await spd.addData('dataName', yourData);
+```
+
+### Saving Data to File
+
+Save the encrypted and compressed data to a file:
+
+```javascript
+spd.saveToFile('path/to/output.spd');
+```
+
+### Loading Data from File
+
+Load the data from an SPD file:
+
+```javascript
+const loadedSPD = await SPD.loadFromFile('path/to/output.spd', 'your-passcode');
+```
+
+### Extracting Data
+
+Extract and decrypt the data from the SPD instance:
+
+```javascript
+const extractedData = await loadedSPD.extractData();
+console.log(extractedData);
+```
+
+## Example
+
+Here is a complete example of how to use the SPD module:
+
+```javascript
+const { SPD } = require('./path/to/spd.js');
+
+(async () => {
+    const spd = new SPD();
+    await spd.setPassKey('your-passcode');
+
+    const myData = {
+        name: "Alice",
+        age: 30,
+        isMember: true,
+        preferences: ["reading", "gaming"]
+    };
+
+    await spd.addData('userData', myData);
+
+    spd.saveToFile('path/to/output.spd');
+
+    const loadedSPD = await SPD.loadFromFile('path/to/output.spd', 'your-passcode');
+    const extractedData = await loadedSPD.extractData();
+
+    console.log(extractedData);
+})();
+```
+
+## Methods
+
+### `async setPassKey(passcode)`
+
+Sets the passcode for encrypting and decrypting data.
+
+- **Parameters**: `passcode` (string) - The passcode to be used.
+
+### `async addData(name, data)`
+
+Adds data to the SPD instance.
+
+- **Parameters**:
+  - `name` (string) - The name of the data.
+  - `data` (any) - The data to be stored.
+
+### `saveToFile(outputPath)`
+
+Saves the encrypted and compressed data to a file.
+
+- **Parameters**: `outputPath` (string) - The path to save the file.
+
+### `static async loadFromFile(spdPath, passcode)`
+
+Loads the SPD data from a file.
+
+- **Parameters**:
+  - `spdPath` (string) - The path to the SPD file.
+  - `passcode` (string) - The passcode to decrypt the data.
+
+- **Returns**: An instance of SPD with the loaded data.
+
+### `async extractData()`
+
+Extracts and decrypts the data from the SPD instance.
+
+- **Returns**: An object with the decrypted data.
+
+## License
+
+This project is licensed under the MIT License.

package/readme.md.gz.lo

@@ -0,0 +1,137 @@
+# Secure Packaged Data (SPD)
+
+The Secure Packaged Data (SPD) module provides functionality to securely store and retrieve data using encryption, compression, and hashing. This README explains how to use the SPD class and its methods.
+
+## Installation
+
+First, ensure you have Node.js installed. Then, install the required packages:
+
+```sh
+npm install spd-lib
+```
+
+## Usage
+
+Below are the primary functionalities of the SPD class.
+
+### Initialization
+
+Create an instance of the SPD class:
+
+```javascript
+const { SPD } = require('spd-lib');
+
+const spd = new SPD();
+```
+
+### Setting Passcode
+
+Set a passcode for encrypting the data:
+
+```javascript
+await spd.setPassKey('your-passcode');
+```
+
+### Adding Data
+
+Add data to the SPD instance:
+
+```javascript
+await spd.addData('dataName', yourData);
+```
+
+### Saving Data to File
+
+Save the encrypted and compressed data to a file:
+
+```javascript
+spd.saveToFile('path/to/output.spd');
+```
+
+### Loading Data from File
+
+Load the data from an SPD file:
+
+```javascript
+const loadedSPD = await SPD.loadFromFile('path/to/output.spd', 'your-passcode');
+```
+
+### Extracting Data
+
+Extract and decrypt the data from the SPD instance:
+
+```javascript
+const extractedData = await loadedSPD.extractData();
+console.log(extractedData);
+```
+
+## Example
+
+Here is a complete example of how to use the SPD module:
+
+```javascript
+const { SPD } = require('./path/to/spd.js');
+
+(async () => {
+    const spd = new SPD();
+    await spd.setPassKey('your-passcode');
+
+    const myData = {
+        name: "Alice",
+        age: 30,
+        isMember: true,
+        preferences: ["reading", "gaming"]
+    };
+
+    await spd.addData('userData', myData);
+
+    spd.saveToFile('path/to/output.spd');
+
+    const loadedSPD = await SPD.loadFromFile('path/to/output.spd', 'your-passcode');
+    const extractedData = await loadedSPD.extractData();
+
+    console.log(extractedData);
+})();
+```
+
+## Methods
+
+### `async setPassKey(passcode)`
+
+Sets the passcode for encrypting and decrypting data.
+
+- **Parameters**: `passcode` (string) - The passcode to be used.
+
+### `async addData(name, data)`
+
+Adds data to the SPD instance.
+
+- **Parameters**:
+  - `name` (string) - The name of the data.
+  - `data` (any) - The data to be stored.
+
+### `saveToFile(outputPath)`
+
+Saves the encrypted and compressed data to a file.
+
+- **Parameters**: `outputPath` (string) - The path to save the file.
+
+### `static async loadFromFile(spdPath, passcode)`
+
+Loads the SPD data from a file.
+
+- **Parameters**:
+  - `spdPath` (string) - The path to the SPD file.
+  - `passcode` (string) - The passcode to decrypt the data.
+
+- **Returns**: An instance of SPD with the loaded data.
+
+### `async extractData()`
+
+Extracts and decrypts the data from the SPD instance.
+
+- **Returns**: An object with the decrypted data.
+
+## License
+
+This project is licensed under the MIT License.