store-s3-aws 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Arbi Syarifudin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,96 @@
+# wwebjs-aws-s3
+A remote authentication plugin for [whatsapp-web.js](https://wwebjs.dev/). Use the AWS S3 to keep your WhatsApp MultiDevice session data safe and secure.
+
+![GitHub license](https://img.shields.io/github/license/arbisyarifudin/wwebjs-aws-s3.svg) [![npm version](https://badge.fury.io/js/wwebjs-aws-s3.svg)](https://badge.fury.io/js/wwebjs-aws-s3)
+[![npm downloads](https://img.shields.io/npm/dm/wwebjs-aws-s3.svg)](https://npm-stat.com/charts.html?package=wwebjs-aws-s3)
+![GitHub issues](https://img.shields.io/github/issues/arbisyarifudin/wwebjs-aws-s3.svg)
+
+## Quick Links
+
+* [Whatsapp-web JS](https://wwebjs.dev/guide/authentication.html)
+* [GitHub](https://github.com/arbisyarifudin/wwebjs-aws-s3)
+* [npm](https://www.npmjs.com/package/wwebjs-aws-s3)
+
+## Installation
+
+The module is now available on npm! `npm i wwebjs-aws-s3`
+
+## DEBUG mode
+
+To see detailed logs about object health, set the environment variable STORE_DEBUG to "true".
+
+```bash
+# linux
+$ export STORE_DEBUG=true
+
+# windows
+$ SET STORE_DEBUG=true
+```
+
+## Example usage
+
+```js
+const { Client, RemoteAuth } = require('whatsapp-web.js');
+const { AwsS3Store } = require('wwebjs-aws-s3');
+const { S3Client, PutObjectCommand, HeadObjectCommand, GetObjectCommand, DeleteObjectCommand } = require('@aws-sdk/client-s3');
+
+
+const s3 = new S3Client({
+  region: 'AWS_REGION',
+  credentials: {
+    accessKeyId: 'AWS_ACCESS_KEY_ID',
+    secretAccessKey: 'AWS_SECRET_ACCESS_KEY'
+  }
+});
+
+const putObjectCommand = PutObjectCommand; 
+const headObjectCommand = HeadObjectCommand;
+const getObjectCommand = GetObjectCommand;
+const deleteObjectCommand = DeleteObjectCommand; 
+
+const store = new AwsS3Store({
+  bucketName: 'example-bucket',
+  remoteDataPath: 'example/path/',
+  s3Client: s3,
+  putObjectCommand,
+  headObjectCommand,
+  getObjectCommand,
+  deleteObjectCommand
+});
+
+
+const client = new Client({
+    authStrategy: new RemoteAuth({
+        clientId: 'yourSessionName',
+        dataPath: './.wwebjs_auth',
+        store: store,
+        backupSyncIntervalMs: 600000
+    })
+});
+
+client.on('qr', (qr) => {
+    // Generate and scan this code with your phone
+    console.log('QR RECEIVED', qr);
+    qrcode.generate(qr, { small: true });
+});
+
+client.on('ready', () => {
+    console.log('Client is ready!');
+});
+
+client.on('message', msg => {
+    if (msg.body == '!ping') {
+        msg.reply('pong');
+    }
+});
+
+client.initialize();
+```
+
+## Delete Remote Session
+
+How to force delete a specific remote session on the Database:
+
+```js
+await store.delete({session: 'yourSessionName'});
+```

package/example/index.js

@@ -0,0 +1,10 @@
+const AwsS3Store = require('../src/AwsS3Store'); 
+require('dotenv').config();
+
+const store = new AwsS3Store({
+    bucketName: 'whatsapp-remote-sessions',
+    remoteDataPath: 'sessions',
+    clientConfig: {region: 'sa-east-1'}
+});
+
+store.save({session: "123"})

package/example/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "example",
+  "version": "1.0.0",
+  "description": "Example project for wwebjs remote auth with AWS S3",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": "arbisyarifudin",
+  "license": "ISC",
+  "dependencies": {
+    "@aws-sdk/client-s3": "^3.369.0",
+    "dotenv": "^16.4.7",
+    "qrcode-terminal": "^0.12.0",
+    "whatsapp-web.js": "^1.21.0"
+  }
+}

package/index.d.ts

@@ -0,0 +1 @@
+export const AwsS3Store: typeof import("./src/AwsS3Store");

package/index.js

@@ -0,0 +1,5 @@
+'use strict';
+
+module.exports = {
+    AwsS3Store: require('./src/AwsS3Store')
+};

package/package.json

@@ -0,0 +1,19 @@
+{
+  "name": "store-s3-aws",
+  "version": "1.0.0",
+  "description": "Lib to store files in AWS S3",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [
+    "files",
+    "aws",
+    "s3"
+  ],
+  "license": "ISC",
+  "dependencies": {
+    "@aws-sdk/client-s3": "^3.777.0",
+    "@aws-sdk/lib-storage": "^3.779.0"
+  }
+}