fca-smart-shankar 10.9.1 → 12.0.0

package/README.md

@@ -1,53 +1,199 @@
-[![Socket Badge](https://www.npmjs.com/package/fca-smart-shankar)](https://www.npmjs.com/package/fca-smart-shankar)
+This repo is a fork from main repo and will usually have new features bundled faster than main repo (and maybe bundle some bugs, too).
 
-# The following are not allowed here and a little note:
+# Shankar Facebook Chat API
 
-🎆
+Facebook now has an official API for chat bots [here](https://developers.facebook.com/docs/messenger-platform).
 
-## Important !
+This API is the only way to automate chat functionalities on a user account. We do this by emulating the browser. This means doing the exact same GET/POST requests and tricking Facebook into thinking we're accessing the website normally. Because we're doing it this way, this API won't work with an auth token but requires the credentials of a Facebook account.
 
-<img width="517" alt="Reason" src="https://i.imgur.com/IEwl35Q.gif">
-This project is no longer being developed because the project owner lacks high security capabilities, leading to potential security vulnerabilities. Therefore, the project will be permanently suspended.
+_Disclaimer_: We are not responsible if your account gets banned for spammy activities such as sending lots of messages to people you don't know, sending messages very quickly, sending spammy looking URLs, logging in and out very quickly... Be responsible Facebook citizens.
 
-Special Thanks: 
-![image](https://github.com/SHANKAR-PROJECT/fca-smart-shankar)
+See [below](#projects-using-this-api) for projects using this API.
 
-## Important !
+## Install
+If you just want to use fca-disme, you should use this command:
+```bash
+npm install fca-smart-shankar 
+```
+It will download `fca-smart-shankar` from NPM repositories
 
-This package require NodeJS 14.17.0 to work properly.
+### Bleeding edge
+If you want to use bleeding edge (directly from github) to test new features or submit bug report, this is the command for you:
+```bash
+npm install fca-smart-shankar 
+```
 
-## Notification !
+## Testing your bots
+If you want to test your bots without creating another account on Facebook, you can use [Facebook Whitehat Accounts](https://www.facebook.com/whitehat/accounts/).
 
-Original Project(Deprecated): https://github.com/SHANKAR-PROJECT/fca-smart-shankar
+## Example Usage
+```javascript
+const login = require("fca-smart-shankar");
 
+// Create simple echo bot
+login({email: "FB_EMAIL", password: "FB_PASSWORD"}, (err, api) => {
+    if(err) return console.error(err);
 
-SHANKAR-PROJECT(22/11/2024)
+    api.listen((err, message) => {
+        api.sendMessage(message.body, message.threadID);
+    });
+});
+```
 
-## Support For : 
+Result:
 
-+ Support English, India !,
-+ All bot if using listenMqtt first.
+<img width="517" alt="screen shot 2016-11-04 at 14 36 00" src="https://cloud.githubusercontent.com/assets/4534692/20023545/f8c24130-a29d-11e6-9ef7-47568bdbc1f2.png">
 
-# Api Cho ChatBot Messenger
 
-```bash
-npm i fca-smart-shankar
+## Documentation
+
+You can see it [here](DOCS.md).
+
+## Main Functionality
+
+### Sending a message
+#### api.sendMessage(message, threadID[, callback][, messageID])
+
+Various types of message can be sent:
+* *Regular:* set field `body` to the desired message as a string.
+* *Sticker:* set a field `sticker` to the desired sticker ID.
+* *File or image:* Set field `attachment` to a readable stream or an array of readable streams.
+* *URL:* set a field `url` to the desired URL.
+* *Emoji:* set field `emoji` to the desired emoji as a string and set field `emojiSize` with size of the emoji (`small`, `medium`, `large`)
+
+Note that a message can only be a regular message (which can be empty) and optionally one of the following: a sticker, an attachment or a url.
+
+__Tip__: to find your own ID, you can look inside the cookies. The `userID` is under the name `c_user`.
+
+__Example (Basic Message)__
+```js
+const login = require("fca-smart-shankar");
+
+login({email: "FB_EMAIL", password: "FB_PASSWORD"}, (err, api) => {
+    if(err) return console.error(err);
+
+    var yourID = "000000000000000";
+    var msg = "Hey!";
+    api.sendMessage(msg, yourID);
+});
 ```
-or
-```bash
-npm install fca-smart-shankar
+
+__Example (File upload)__
+```js
+const login = require("fca-smart-shankar");
+
+login({email: "FB_EMAIL", password: "FB_PASSWORD"}, (err, api) => {
+    if(err) return console.error(err);
+
+    // Note this example uploads an image called image.jpg
+    var yourID = "000000000000000";
+    var msg = {
+        body: "Hey!",
+        attachment: fs.createReadStream(__dirname + '/image.jpg')
+    }
+    api.sendMessage(msg, yourID);
+});
 ```
 
-```bash
-npm install fca-smart-shankard@latest
+------------------------------------
+### Saving session.
+
+To avoid logging in every time you should save AppState (cookies etc.) to a file, then you can use it without having password in your scripts.
+
+__Example__
+
+```js
+const fs = require("fs");
+const login = require("fca-smart-shankar");
+
+var credentials = {email: "FB_EMAIL", password: "FB_PASSWORD"};
+
+login(credentials, (err, api) => {
+    if(err) return console.error(err);
+
+    fs.writeFileSync('appstate.json', JSON.stringify(api.getAppState()));
+});
 ```
-and
-```bash
-npm i fca-smart-shankar@latest
+
+Alternative: Use [c3c-fbstate](https://github.com/c3cbot/c3c-fbstate) to get fbstate.json (appstate.json)
+
+------------------------------------
+
+### Listening to a chat
+#### api.listen(callback)
+
+Listen watches for messages sent in a chat. By default this won't receive events (joining/leaving a chat, title change etc…) but it can be activated with `api.setOptions({listenEvents: true})`. This will by default ignore messages sent by the current account, you can enable listening to your own messages with `api.setOptions({selfListen: true})`.
+
+__Example__
+
+```js
+const fs = require("fs");
+const login = require("fca-smart-shankar");
+
+// Simple echo bot. It will repeat everything that you say.
+// Will stop when you say '/stop'
+login({appState: JSON.parse(fs.readFileSync('appstate.json', 'utf8'))}, (err, api) => {
+    if(err) return console.error(err);
+
+    api.setOptions({listenEvents: true});
+
+    var stopListening = api.listenMqtt((err, event) => {
+        if(err) return console.error(err);
+
+        api.markAsRead(event.threadID, (err) => {
+            if(err) console.error(err);
+        });
+
+        switch(event.type) {
+            case "message":
+                if(event.body === '/stop') {
+                    api.sendMessage("Goodbye…", event.threadID);
+                    return stopListening();
+                }
+                api.sendMessage("TEST BOT: " + event.body, event.threadID);
+                break;
+            case "event":
+                console.log(event);
+                break;
+        }
+    });
+});
 ```
 
-## SHANKAR PROJECT
+## FAQS
+
+1. How do I run tests?
+> For tests, create a `test-config.json` file that resembles `example-config.json` and put it in the `test` directory. From the root >directory, run `npm test`.
+
+2. Why doesn't `sendMessage` always work when I'm logged in as a page?
+> Pages can't start conversations with users directly; this is to prevent pages from spamming users.
+
+3. What do I do when `login` doesn't work?
+> First check that you can login to Facebook using the website. If login approvals are enabled, you might be logging in incorrectly. For how to handle login approvals, read our docs on [`login`](DOCS.md#login).
+
+4. How can I avoid logging in every time?  Can I log into a previous session?
+> We support caching everything relevant for you to bypass login. `api.getAppState()` returns an object that you can save and pass into login as `{appState: mySavedAppState}` instead of the credentials object.  If this fails, your session has expired.
+
+5. Do you support sending messages as a page?
+> Yes, set the pageID option on login (this doesn't work if you set it using api.setOptions, it affects the login process).
+> ```js
+> login(credentials, {pageID: "000000000000000"}, (err, api) => { … }
+> ```
+
+6. I'm getting some crazy weird syntax error like `SyntaxError: Unexpected token [`!!!
+> Please try to update your version of node.js before submitting an issue of this nature.  We like to use new language features.
+
+7. I don't want all of these logging messages!
+> You can use `api.setOptions` to silence the logging. You get the `api` object from `login` (see example above). Do
+> ```js
+> api.setOptions({
+>     logLevel: "silent"
+> });
+> ```
 
-## FACEBOOK 
+<a name="projects-using-this-api"></a>
+## Projects using this API:
 
-FACEBOOK => [Link](https://www.facebook.com/shankar.suman.98622733?mibextid=JRoKGi)
+- [c3c](https://github.com/lequanglam/c3c) - A bot that can be customizable using plugins. Support Facebook & Discord.
+- [SMART-SHANKAR-BOT](https://github.com/SHANKAR-PROJECT/SMART-SHANKAR-BOT) - A simple Facebook Messenger Bot made by Smart Shankar.
+-