microfed 0.0.10 → 0.0.12

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/AUTHENTICATION.md +2 -2
  2. package/PROFILE.md +12 -12
  3. package/UTILS.md +2 -2
  4. package/package.json +1 -1
package/AUTHENTICATION.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  The Authentication Module is designed to offer a flexible and extensible authentication system for the ActivityPub-based inbox, ensuring secure and reliable access for users.
4
4
 
5
- ## Key Features
5
+ ## 🗝️ Key Features
6
6
 
7
7
  The Authentication Module provides the following capabilities:
8
8
 
@@ -11,6 +11,6 @@ The Authentication Module provides the following capabilities:
11
11
  - **Delegated authentication support**, such as OAuth and OIDC, providing the ability to incorporate third-party authentication services when necessary or desired.
12
12
  - **Integration with enterprise authentication systems**, allowing seamless authentication experiences for users within organizational environments.
13
13
 
14
- ## Extensibility and Adaptability
14
+ ## 🔧 Extensibility and Adaptability
15
15
 
16
16
  The Authentication Module has been designed with extensibility and adaptability in mind. It allows for the easy addition of different authentication modules as needed, ensuring that the system remains flexible and accommodating to various use cases and scenarios. This design philosophy ensures that the Authentication Module can evolve and adapt to changing requirements and security landscapes, providing a robust and future-proof authentication solution for your ActivityPub-based inbox.
package/PROFILE.md CHANGED
@@ -1,16 +1,16 @@
1
- # Microfed Profile
1
+ # 📝 Microfed Profile
2
2
 
3
3
  Microfed Profile is a module within the Microfed framework responsible for handling user profiles and their interactions with the fediverse using ActivityPub and WebFinger protocols. This document outlines the core design of the Microfed Profile module.
4
4
 
5
5
  ## Table of Contents
6
6
 
7
- - [Profile Components](#profile-components)
8
- - [ActivityPub Profile Integration](#activitypub-profile-integration)
9
- - [WebFinger Integration](#webfinger-integration)
10
- - [API Interface](#api-interface)
11
- - [Error Handling and Logging](#error-handling-and-logging)
7
+ - [🧩 Profile Components](#profile-components)
8
+ - [🌐 ActivityPub Profile Integration](#activitypub-profile-integration)
9
+ - [🔎 WebFinger Integration](#webfinger-integration)
10
+ - [🗄️ API Interface](#api-interface)
11
+ - [🔍 Error Handling and Logging](#error-handling-and-logging)
12
12
 
13
- ## Profile Components
13
+ ## 🧩 Profile Components
14
14
 
15
15
  Microfed Profile comprises the following components:
16
16
 
@@ -19,7 +19,7 @@ Microfed Profile comprises the following components:
19
19
  3. **WebFinger Adapter**: Offers utility functions to discover and resolve user profiles using WebFinger protocol.
20
20
  4. **Profile API**: Exposes an API for interacting with profiles, including fetching, updating, and managing connections.
21
21
 
22
- ## ActivityPub Profile Integration
22
+ ## 🌐 ActivityPub Profile Integration
23
23
 
24
24
  Microfed Profile integrates with ActivityPub using the ActivityPub Profile Adapter component. The adapter offers the following functionality:
25
25
 
@@ -27,14 +27,14 @@ Microfed Profile integrates with ActivityPub using the ActivityPub Profile Adapt
27
27
  2. **Parsing and Serialization**: Provides utility functions to parse and serialize ActivityPub profile data from/to JSON-LD format.
28
28
  3. **Profile Interaction**: Implements methods for interacting with profiles according to the ActivityPub specification, such as fetching profile data, updating profile attributes, and managing connections (followers, following, etc.).
29
29
 
30
- ## WebFinger Integration
30
+ ## 🔎 WebFinger Integration
31
31
 
32
32
  Microfed Profile integrates with the WebFinger protocol using the WebFinger Adapter component. This adapter provides the following functionality:
33
33
 
34
34
  1. **Profile Discovery**: Offers methods to discover user profiles based on their WebFinger identifiers (e.g., user@example.com).
35
35
  2. **Profile Resolution**: Implements methods to resolve WebFinger identifiers to actual profile URLs, making it easier to interact with profiles across different platforms.
36
36
 
37
- ## API Interface
37
+ ## 🗄️ API Interface
38
38
 
39
39
  Microfed Profile exposes a simple and intuitive API interface for developers to interact with user profiles and their related ActivityPub and WebFinger functionality. The API includes methods for:
40
40
 
@@ -42,7 +42,7 @@ Microfed Profile exposes a simple and intuitive API interface for developers to
42
42
  2. **ActivityPub Interaction**: Fetching and updating ActivityPub profiles, and managing connections (followers, following, etc.).
43
43
  3. **WebFinger Interaction**: Discovering and resolving user profiles using WebFinger identifiers.
44
44
 
45
- ## Error Handling and Logging
45
+ ## 🔍 Error Handling and Logging
46
46
 
47
47
  Microfed Profile provides robust error handling and logging to ensure that any issues or errors are properly reported and logged. This system includes:
48
48
 
@@ -52,4 +52,4 @@ Microfed Profile provides robust error handling and logging to ensure that any i
52
52
 
53
53
  ---
54
54
 
55
- Microfed Profile is an essential module within the Microfed framework, providing seamless integration with ActivityPub and WebFinger protocols for managing user profiles. By handling the core functionality of profiles, Microfed Profile allows developers to build decentralized applications that leverage the power of microservices and the fediverse.
55
+ Microfed Profile is an essential module within the Microfed framework, providing seamless integration with ActivityPub and WebFinger protocols for managing user profiles. By handling the core functionality of profiles, Microfed Profile allows developers to build decentralized applications that leverage the power of microservices and the fediverse.
package/UTILS.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  The Utils Module is designed to provide a collection of utility functions and tools that support and enhance the functionality of the Microfed system, including the Profile, Inbox, Outbox, and Authentication modules.
4
4
 
5
- ## Key Features
5
+ ## 🌟 Key Features
6
6
 
7
7
  The Utils Module offers the following essential utilities and tools:
8
8
 
@@ -13,7 +13,7 @@ The Utils Module offers the following essential utilities and tools:
13
13
  - **Message formatting and parsing**, delivering support for transforming and interpreting messages in different formats, such as JSON, JSON-LD, and others.
14
14
  - **Compatibility and integration tools**, enabling seamless interoperability between various components, modules, and third-party systems.
15
15
 
16
- ## Modularity and Reusability
16
+ ## 🔩 Modularity and Reusability
17
17
 
18
18
  The Utils Module is built with modularity and reusability in mind. Each utility function and tool is designed to be easily accessible and adaptable, allowing developers to quickly integrate them into their projects without any hassle. This design approach ensures that the Utils Module remains a valuable resource for the Microfed ecosystem, providing essential support and enhancing the functionality of the core modules.
19
19
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "microfed",
3
- "version": "0.0.10",
3
+ "version": "0.0.12",
4
4
  "description": "microfed",
5
5
  "main": "index.js",
6
6
  "scripts": {