microfed 0.0.9 → 0.0.11

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/CORE.md +10 -10
  2. package/DESIGN.md +13 -13
  3. package/PROFILE.md +12 -12
  4. package/package.json +1 -1
package/CORE.md CHANGED
@@ -1,15 +1,15 @@
1
- # Microfed Core
1
+ # 🧩 Microfed Core
2
2
 
3
3
  Microfed Core is the central module that manages communication between different components of the Microfed framework and provides utility functions. This document outlines the core design of Microfed Core, focusing on its integration with ActivityPub.
4
4
 
5
5
  ## Table of Contents
6
6
 
7
- - [Core Components](#core-components)
8
- - [ActivityPub Integration](#activitypub-integration)
9
- - [API Interface](#api-interface)
10
- - [Error Handling and Logging](#error-handling-and-logging)
7
+ - [🔧 Core Components](#core-components)
8
+ - [🌐 ActivityPub Integration](#activitypub-integration)
9
+ - [🗄️ API Interface](#api-interface)
10
+ - [🔍 Error Handling and Logging](#error-handling-and-logging)
11
11
 
12
- ## Core Components
12
+ ## 🔧 Core Components
13
13
 
14
14
  Microfed Core comprises the following components:
15
15
 
@@ -18,7 +18,7 @@ Microfed Core comprises the following components:
18
18
  3. **ActivityPub Adapter**: Provides a set of utility functions and classes to interact with ActivityPub, parse and serialize data, and manage ActivityPub objects.
19
19
  4. **Networking**: Handles networking tasks, such as HTTP requests, WebSocket connections, and peer-to-peer communication.
20
20
 
21
- ## ActivityPub Integration
21
+ ## 🌐 ActivityPub Integration
22
22
 
23
23
  Microfed Core integrates with ActivityPub using the ActivityPub Adapter component. The adapter offers the following functionality:
24
24
 
@@ -27,7 +27,7 @@ Microfed Core integrates with ActivityPub using the ActivityPub Adapter componen
27
27
  3. **Activity Handling**: Implements methods for processing incoming and outgoing activities, such as Create, Update, Delete, Follow, and Like, according to the ActivityPub specification.
28
28
  4. **ActivityPub API**: Offers an API for interacting with ActivityPub services, such as fetching and updating Actor profiles, sending activities, and managing followers and following collections.
29
29
 
30
- ## API Interface
30
+ ## 🗄️ API Interface
31
31
 
32
32
  Microfed Core exposes a simple and intuitive API interface for developers to interact with the framework and its modules. The API includes methods for:
33
33
 
@@ -35,7 +35,7 @@ Microfed Core exposes a simple and intuitive API interface for developers to int
35
35
  2. **ActivityPub Interaction**: Sending and receiving ActivityPub activities, managing Actor profiles, and handling collections.
36
36
  3. **Utility Functions**: Accessing common utility functions, such as data validation, conversion, and formatting.
37
37
 
38
- ## Error Handling and Logging
38
+ ## 🔍 Error Handling and Logging
39
39
 
40
40
  Microfed Core provides a robust error handling and logging system to ensure that any issues or errors are properly reported and logged. This system includes:
41
41
 
@@ -45,4 +45,4 @@ Microfed Core provides a robust error handling and logging system to ensure that
45
45
 
46
46
  ---
47
47
 
48
- Microfed Core is the backbone of the Microfed framework, providing seamless integration with ActivityPub and managing communication between its components. By handling the core functionality, Microfed Core allows developers to focus on building innovative and decentralized applications that leverage the power of microservices and the fediverse.
48
+ Microfed Core is the backbone of the Microfed framework, providing seamless integration with ActivityPub and managing communication between its components. By handling the core functionality, Microfed Core allows developers to focus on building innovative and decentralized applications that leverage the power of microservices and the fediverse.
package/DESIGN.md CHANGED
@@ -17,20 +17,20 @@ This document provides a high-level overview of Microfed's design, outlining the
17
17
 
18
18
  ## Table of Contents
19
19
 
20
- - [Microfed Core](#microfed-core)
21
- - [Profile Module](#profile-module)
22
- - [Inbox Module](#inbox-module)
23
- - [Outbox Module](#outbox-module)
24
- - [Authentication Module](#authentication-module)
25
- - [Utility Functions](#utility-functions)
20
+ - [🧩 Microfed Core](#microfed-core)
21
+ - [👥 Profile Module](#profile-module)
22
+ - [📥 Inbox Module](#inbox-module)
23
+ - [📤 Outbox Module](#outbox-module)
24
+ - [🔐 Authentication Module](#authentication-module)
25
+ - [🛠️ Utility Functions](#utility-functions)
26
26
 
27
- ## Microfed Core
27
+ ## 🧩 Microfed Core
28
28
 
29
29
  The Microfed Core serves as the central module that manages communication between different components and provides utility functions.
30
30
 
31
31
  [Core Design](./CORE.md)
32
32
 
33
- ## Profile Module
33
+ ## 👥 Profile Module
34
34
 
35
35
  The Profile Module consists of the following features:
36
36
 
@@ -41,7 +41,7 @@ The Profile Module consists of the following features:
41
41
 
42
42
  [Profile Design](./PROFILE.md)
43
43
 
44
- ## Inbox Module
44
+ ## 📥 Inbox Module
45
45
 
46
46
  The Inbox Module is designed to offer the following functionality:
47
47
 
@@ -51,7 +51,7 @@ The Inbox Module is designed to offer the following functionality:
51
51
 
52
52
  [Inbox Design](./INBOX.md)
53
53
 
54
- ## Outbox Module
54
+ ## 📤 Outbox Module
55
55
 
56
56
  The Outbox Module includes the following capabilities:
57
57
 
@@ -61,7 +61,7 @@ The Outbox Module includes the following capabilities:
61
61
 
62
62
  [Outbox Design](./OUTBOX.md)
63
63
 
64
- ## Authentication Module
64
+ ## 🔐 Authentication Module
65
65
 
66
66
  The Authentication Module provides a flexible and extensible authentication system:
67
67
 
@@ -72,7 +72,7 @@ The Authentication Module provides a flexible and extensible authentication syst
72
72
 
73
73
  [Authentication Design](./AUTHENTICATION.md)
74
74
 
75
- ## Utility Functions
75
+ ## 🛠️ Utility Functions
76
76
 
77
77
  The Utility Functions module offers various general-purpose functions, such as data validation, conversion, and formatting.
78
78
 
@@ -80,4 +80,4 @@ The Utility Functions module offers various general-purpose functions, such as d
80
80
 
81
81
  ---
82
82
 
83
- With its modular and extensible design, Microfed provides a robust and flexible foundation for developing decentralized applications that harness the power of microservices and the fediverse. By combining these technologies, Microfed empowers developers to create innovative, secure, and scalable applications for the decentralized web.
83
+ With its modular and extensible design, Microfed provides a robust and flexible foundation for developing decentralized applications that harness the power of microservices and the fediverse. By combining these technologies, Microfed empowers developers to create innovative, secure, and scalable applications for the decentralized web.
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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "microfed",
3
- "version": "0.0.9",
3
+ "version": "0.0.11",
4
4
  "description": "microfed",
5
5
  "main": "index.js",
6
6
  "scripts": {