https://github.com/networld-to/fediverse-helper

Typescript/Javascript library that provides useful API calls and utility function to interact with the Fediverse
https://github.com/networld-to/fediverse-helper

activitypub fediverse javascript typescript webfinger

Last synced: about 2 months ago
JSON representation

Typescript/Javascript library that provides useful API calls and utility function to interact with the Fediverse

• Host: GitHub
• URL: https://github.com/networld-to/fediverse-helper
• Owner: networld-to
• Created: 2023-03-20T01:29:47.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-01-28T17:19:35.000Z (11 months ago)
• Last Synced: 2024-04-13T14:06:07.566Z (9 months ago)
• Topics: activitypub, fediverse, javascript, typescript, webfinger
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/@networld-to/fediverse-helper
• Size: 49.8 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Fediverse Helper

Typescript/Javascript library that provides basic API calls and utility functions

that are useful to interact with ActivityPub-based Fediverse instances. It

supports also related protocols and specifications such as Webfinger.

## Getting Started

```sh

# Not yet published

$ yarn add @networld-to/fediverse-helper

```

See the following usage example to get started.

```js

import FediverseAccount from '@networld-to/fediverse-helper';

const fediAccount = new FediverseAccount('@[email protected]');

console.log(fediProfile.getInstanceHost());

fediProfile.getAccountInfo(this.email).then((profile) => {

  console.log(profile);

});

```

## Functionality

The FediverseAccount class accepts the fediverse handle as input parameter

during the instantiation. Everything else is derived from it by making the

right calls and parsing the right data.

| Function         | Params                                 | Output                 | Caching                |

| ---------------- | -------------------------------------- | ---------------------- | ---------------------- |

| getInstanceHost  | None                                   | fediverseHost (String) | Not needed, local call |

| getWebfingerInfo | forceFetch: boolean = false (optional) | webfingerInfo (Object) | Yes                    |

| getInstanceInfo  | forceFetch: boolean = false (optional) | instanceInfo (Object)  | Yes                    |

| getAccountInfo   | forceFetch: boolean = false (optional) | accountInfo (Object)   | Yes                    |

| getOutboxPosts   | None                                   | posts (\[Object\])     | No                     |

The getHandleHost is an internal helper function that splits the fediverse

handle into two parts and returns the hostname of it. For the instance host

use the getInstanceHost function. The fediverse handle may only be an alias

to the real instance.

## Developers

```sh

# To run ./client/main.js after compiling the library (see ./dist output)

$ yarn run client @[email protected]

```

Alternatively run the steps manually.

```sh

# Make your changes in files under ./src/

$ yarn build

# see output under ./dist

# Change code under ./client/main.js and run it

$ node ./client/main.js @[email protected]

```