https://github.com/questnetwork/quest-social-js
https://github.com/questnetwork/quest-social-js
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/questnetwork/quest-social-js
- Owner: QuestNetwork
- License: agpl-3.0
- Created: 2020-09-16T00:23:17.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2020-10-25T08:27:57.000Z (over 5 years ago)
- Last Synced: 2025-03-18T05:44:33.928Z (over 1 year ago)
- Language: JavaScript
- Size: 1.21 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Quest Social JS
> A Decentralized Social Protocol for Dolphin and Coral.
## Lead Maintainer
[StationedInTheField](https://github.com/StationedInTheField)
## Description
The Social process for the [Quest Network Operating System](https://github.com/QuestNetwork/quest-os-js) orchestrates, stores and synchronizes configuration data, discovers and shares relevant information about dolphin peers. Uses [IPFS DAGs](https://docs.ipfs.io/concepts/merkle-dag/) for timelines.
See [QD Social TS](https://github.com/QuestNetwork/qd-social-ts) the [Features](https://github.com/QuestNetwork/qd-social-ts#Features) & [Roadmap](https://github.com/QuestNetwork/qd-social-ts#Roadmap)
## Installation & Usage
```
npm install @questnetwork/quest-social-js@0.9.4
```
## API
### profile
#### social.profile.togglePrivacy(profilePubKey = 'NoProfileSelected')
[](https://github.com/QuestNetwork/quest-social-js) [](https://github.com/QuestNetwork/quest-bee-js) [](https://github.com/QuestNetwork/quest-ocean-js)
Toggles your profile's visibility between private and public, not giving a pubKey will automatically select your first profile.
In private mode you have to manually share your profile with everyone you want to see your details. In Public mode all the members of the channels you're in can see your profile.
```javascript
.social.profile.togglePrivacy();
```
#### social.profile.isPublic(socialPubKey = 'NoProfileSelected')
[](https://github.com/QuestNetwork/quest-social-js) [](https://github.com/QuestNetwork/quest-bee-js) [](https://github.com/QuestNetwork/quest-ocean-js)
Checks if a profile has public visibility, not giving a pubKey will automatically select your first profile.
```javascript
if(.social.profile.isPublic(socialPubKey)){
console.log("Hello Universe");
};
```
#### social.profile.isFavorite(socialPubKey)
[](https://github.com/QuestNetwork/quest-social-js) [](https://github.com/QuestNetwork/quest-bee-js) [](https://github.com/QuestNetwork/quest-ocean-js)
Checks if a profile is in our favorites, returns boolean true or false.
```javascript
if(.social.profile.isFavorite(socialPubKey)){
console.log("Hello Universe");
};
```
#### social.profile.isRequestedFavorite(socialPubKey)
[](https://github.com/QuestNetwork/quest-social-js) [](https://github.com/QuestNetwork/quest-bee-js) [](https://github.com/QuestNetwork/quest-ocean-js)
Checks if a profile is a requested favorite, returns boolean true or false.
```javascript
if(.social.profile.isRequestedFavorite(socialPubKey)){
console.log("Hello Universe");
};
```
#### social.profile.search(searchPhrase)
[](https://github.com/QuestNetwork/quest-social-js) [](https://github.com/QuestNetwork/quest-bee-js)
Will automatically search for all social profiles in the peers network where alias, full name or about text match the phrase.
This version of the methos is case sensitive by default, future versions will allow a config object.
Returns an array with the search results and adds the following fields:
```
isFavorite: boolean
isRequestedFavorite: boolean
```
```
let results = .social.search('Bob');
```
### timeline
#### async social.timeline.getReferenceTree(socialPubKey)
[](https://github.com/QuestNetwork/quest-social-js) [](https://github.com/QuestNetwork/quest-bee-js) [](https://github.com/QuestNetwork/quest-ocean-js)
Returns an array with the unresolved timeline of the requested peer.
```javascript
let timeline = await .social.timeline.get(socialPubKey)){
};
```
#### async social.timeline.get(socialPubKey)
[](https://github.com/QuestNetwork/quest-social-js) [](https://github.com/QuestNetwork/quest-bee-js) [](https://github.com/QuestNetwork/quest-ocean-js)
Returns an array with the resolved timeline of the requested peer.
```javascript
let timeline = await .social.timeline.get(socialPubKey)){
```
### post
#### social.timeline.post.delete(qHash)
[](https://github.com/QuestNetwork/quest-social-js) [](https://github.com/QuestNetwork/quest-bee-js) [](https://github.com/QuestNetwork/quest-ocean-js)
Deletes a post by its qHash.
```javascript
async .social.timeline.post.delete(qHash);
```
#### async social.timeline.post.new(postObj = { content: '', socialPubKey:'' })
[](https://github.com/QuestNetwork/quest-social-js) [](https://github.com/QuestNetwork/quest-bee-js) [](https://github.com/QuestNetwork/quest-ocean-js)
Creates a new post on the timeline of the owner of the socialPubKey.
```javascript
.social.timeline.post.new(postObj = { content: '', socialPubKey:'' })
```
#### propagate(latestRef, postObj)
[](https://github.com/QuestNetwork/quest-social-js) [](https://github.com/QuestNetwork/quest-bee-js) [](https://github.com/QuestNetwork/quest-ocean-js)
Propagates the latest timeline ref across channels.
```javascript
async .social.timeline.post.propagate(latestRef, postObj)
```
### agent
#### async social.timeline.agent.sync(pubKey = "all", config = { limit: 5, storagePath: '/archive/social/timeline/transaction' })
[](https://github.com/QuestNetwork/quest-social-js) [](https://github.com/QuestNetwork/quest-bee-js) [](https://github.com/QuestNetwork/quest-ocean-js)
Syncs the timeline for a given pubkey or all cached pubkeys.
```javascript
async .social.timeline.agent.sync(pubKey);
```
#### async social.timeline.agent.groupTimeline(timeline, limit = 0)
[](https://github.com/QuestNetwork/quest-social-js) [](https://github.com/QuestNetwork/quest-bee-js) [](https://github.com/QuestNetwork/quest-ocean-js)
Creates a new post on the timeline of the owner of the socialPubKey.
```javascript
.social.timeline.agent.groupTimeline(timeline, limit = 0)
```
## Support Us
Please consider supporting us, so that we can build a non-profit for this project (ツ)
| Ethereum| Bitcoin |
|---|---|
| `0xBC2A050E7B87610Bc29657e7e7901DdBA6f2D34E` | `bc1qujrqa3s34r5h0exgmmcuf8ejhyydm8wwja4fmq` |
| 
| 
|
## License
GNU AGPLv3