microfed 0.0.4 → 0.0.6

package/CORE.md

@@ -0,0 +1,48 @@
+# Microfed Core
+
+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.
+
+## Table of Contents
+
+- [Core Components](#core-components)
+- [ActivityPub Integration](#activitypub-integration)
+- [API Interface](#api-interface)
+- [Error Handling and Logging](#error-handling-and-logging)
+
+## Core Components
+
+Microfed Core comprises the following components:
+
+1. **Configuration Management**: Handles settings and configuration for the framework, including user preferences, application settings, and module configurations.
+2. **Module Loader**: Manages the loading, initialization, and communication between Microfed modules, such as the Profile, Inbox, Outbox, and Authentication modules.
+3. **ActivityPub Adapter**: Provides a set of utility functions and classes to interact with ActivityPub, parse and serialize data, and manage ActivityPub objects.
+4. **Networking**: Handles networking tasks, such as HTTP requests, WebSocket connections, and peer-to-peer communication.
+
+## ActivityPub Integration
+
+Microfed Core integrates with ActivityPub using the ActivityPub Adapter component. The adapter offers the following functionality:
+
+1. **ActivityPub Objects**: Defines classes for ActivityPub objects, such as Activities, Actors, and Objects, including methods to manipulate and interact with these objects.
+2. **Parsing and Serialization**: Provides utility functions to parse and serialize ActivityPub objects from/to JSON-LD format.
+3. **Activity Handling**: Implements methods for processing incoming and outgoing activities, such as Create, Update, Delete, Follow, and Like, according to the ActivityPub specification.
+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.
+
+## API Interface
+
+Microfed Core exposes a simple and intuitive API interface for developers to interact with the framework and its modules. The API includes methods for:
+
+1. **Module Management**: Registering, initializing, and accessing Microfed modules.
+2. **ActivityPub Interaction**: Sending and receiving ActivityPub activities, managing Actor profiles, and handling collections.
+3. **Utility Functions**: Accessing common utility functions, such as data validation, conversion, and formatting.
+
+## Error Handling and Logging
+
+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:
+
+1. **Error Classes**: Custom error classes for different types of errors that can occur within Microfed Core and its modules.
+2. **Error Reporting**: Methods for reporting errors to the user or developer, with context-specific information and suggestions for resolving the issue.
+3. **Logging**: A flexible logging system that supports different log levels, log formats, and log destinations (e.g., console, file, or remote server).
+
+---
+
+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

@@ -0,0 +1,73 @@
+# Microfed: Design Overview
+
+<div align="center">
+  <img src="https://microfed.org/images/microfed.jpg" />
+  <h1><a href="https://microfed.org/">Microfed</a></h1>
+</div>
+
+<div align="center">  
+<i>Micro Services Meets the Fediverse</i>
+</div>
+
+---
+
+Microfed is a modular and extensible JavaScript framework that aims to bring together microservices and the fediverse, enabling the creation of decentralized applications that leverage the power of both worlds.
+
+This document provides a high-level overview of Microfed's design, outlining the core modules and their functionality.
+
+## Table of Contents
+
+- [Microfed Core](#microfed-core)
+- [Profile Module](#profile-module)
+- [Inbox Module](#inbox-module)
+- [Outbox Module](#outbox-module)
+- [Authentication Module](#authentication-module)
+- [Utility Functions](#utility-functions)
+
+## Microfed Core
+
+The Microfed Core serves as the central module that manages communication between different components and provides utility functions.
+
+## Profile Module
+
+The Profile Module consists of the following features:
+
+- A class representing a user profile, including attributes, public keys, connections, and endpoints.
+- Methods for parsing and serializing profile data from/to JSON-LD format.
+- Support for self-hosted and multi-user services.
+- Compatibility with mobile devices and browsers.
+
+[Profile Design](./PROFILE.md)
+
+## Inbox Module
+
+The Inbox Module is designed to offer the following functionality:
+
+- A class representing a user's inbox, which stores incoming messages in JSON format.
+- Methods for filtering messages based on user preferences.
+- Support for Activity Pub JSON compatibility and message signatures.
+
+## Outbox Module
+
+The Outbox Module includes the following capabilities:
+
+- A class representing a user's outbox, which sends messages to other inboxes.
+- Methods for storing private keys and signing outgoing messages.
+- Support for routing messages to appropriate endpoints.
+
+## Authentication Module
+
+The Authentication Module provides a flexible and extensible authentication system:
+
+- A base authentication class, which can be extended for different authentication methods.
+- Support for PKI-based strong authentication.
+- Support for delegated authentication (e.g., OAuth, OIDC) if needed.
+- Integration with enterprise authentication systems.
+
+## Utility Functions
+
+The Utility Functions module offers various general-purpose functions, such as data validation, conversion, and formatting.
+
+---
+
+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/INBOX.md

@@ -0,0 +1,33 @@
+# 📥 Inbox Module
+
+The Inbox Module is an essential component of the Microfed project, focusing on the management of incoming messages and filtering based on user preferences. It seamlessly integrates with the ActivityPub protocol, ensuring a smooth user experience.
+
+## Overview
+
+The Inbox Module provides a comprehensive solution for handling a user's inbox in a Microfed environment, offering a range of features, including:
+
+- A dedicated class representing a user's inbox
+- Storage of incoming messages in JSON format
+- Message filtering based on user preferences
+- Compatibility with ActivityPub JSON
+- Support for message signatures to verify authenticity
+
+## 📩 User Inbox Class
+
+At the heart of the Inbox Module lies a class specifically designed to represent a user's inbox. This class manages the storage, retrieval, and processing of incoming messages in JSON format, ensuring that users can easily interact with their inboxes in a consistent and structured manner.
+
+## 🔎 Message Filtering
+
+The Inbox Module provides methods for filtering incoming messages based on user-defined preferences. This functionality allows users to have greater control over the messages they receive, enabling them to focus on the content that truly matters to them.
+
+## 🌐 ActivityPub JSON Compatibility
+
+To ensure seamless integration with the fediverse, the Inbox Module has been designed to be compatible with the ActivityPub JSON format. This compatibility guarantees that messages from other users within the fediverse are correctly processed and displayed within the user's inbox.
+
+## 🔏 Message Signatures
+
+In today's digital world, security and authenticity are of paramount importance. The Inbox Module supports message signatures, allowing users to verify the authenticity of incoming messages. This feature helps to protect users from potential phishing attempts or other malicious activities.
+
+---
+
+The Inbox Module has been meticulously crafted to offer an exceptional user experience when interacting with the Microfed environment. Its powerful features and seamless integration with ActivityPub make it an indispensable part of the Microfed ecosystem.

package/PROFILE.md

@@ -0,0 +1,55 @@
+# Microfed Profile
+
+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.
+
+## Table of Contents
+
+- [Profile Components](#profile-components)
+- [ActivityPub Profile Integration](#activitypub-profile-integration)
+- [WebFinger Integration](#webfinger-integration)
+- [API Interface](#api-interface)
+- [Error Handling and Logging](#error-handling-and-logging)
+
+## Profile Components
+
+Microfed Profile comprises the following components:
+
+1. **Profile Manager**: Handles the creation, updating, and retrieval of user profiles, as well as profile data management.
+2. **ActivityPub Profile Adapter**: Provides utility functions and classes to interact with ActivityPub profiles, parse and serialize profile data, and manage ActivityPub objects related to profiles.
+3. **WebFinger Adapter**: Offers utility functions to discover and resolve user profiles using WebFinger protocol.
+4. **Profile API**: Exposes an API for interacting with profiles, including fetching, updating, and managing connections.
+
+## ActivityPub Profile Integration
+
+Microfed Profile integrates with ActivityPub using the ActivityPub Profile Adapter component. The adapter offers the following functionality:
+
+1. **Profile Objects**: Defines classes for ActivityPub profiles, including methods to manipulate and interact with profile data.
+2. **Parsing and Serialization**: Provides utility functions to parse and serialize ActivityPub profile data from/to JSON-LD format.
+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.).
+
+## WebFinger Integration
+
+Microfed Profile integrates with the WebFinger protocol using the WebFinger Adapter component. This adapter provides the following functionality:
+
+1. **Profile Discovery**: Offers methods to discover user profiles based on their WebFinger identifiers (e.g., user@example.com).
+2. **Profile Resolution**: Implements methods to resolve WebFinger identifiers to actual profile URLs, making it easier to interact with profiles across different platforms.
+
+## API Interface
+
+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:
+
+1. **Profile Management**: Creating, updating, and retrieving user profiles.
+2. **ActivityPub Interaction**: Fetching and updating ActivityPub profiles, and managing connections (followers, following, etc.).
+3. **WebFinger Interaction**: Discovering and resolving user profiles using WebFinger identifiers.
+
+## Error Handling and Logging
+
+Microfed Profile provides robust error handling and logging to ensure that any issues or errors are properly reported and logged. This system includes:
+
+1. **Error Classes**: Custom error classes for different types of errors that can occur within the Microfed Profile module.
+2. **Error Reporting**: Methods for reporting errors to the user or developer, with context-specific information and suggestions for resolving the issue.
+3. **Logging**: A flexible logging system that supports different log levels, log formats, and log destinations (e.g., console, file, or remote server).
+
+---
+
+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/README.md

@@ -20,11 +20,15 @@
 [![npm](https://img.shields.io/npm/dw/microfed.svg)](https://npmjs.com/package/microfed)
 [![Github Stars](https://img.shields.io/github/stars/micro-fed/microfed.org.svg)](https://github.com/micro-fed/microfed.org/)
   
-# Introduction
+# ⚡️ Introduction
 
-Tthis project is still at concept stage and aims to brain storm the intersection of micro servcies and the fediverse
+This project is still at concept stage and aims to brainstorm the intersection of [micro services](https://en.wikipedia.org/wiki/Microservices) and the [fediverse](https://en.wikipedia.org/wiki/Fediverse).
 
-The idea is that each component of a fediverse server can be composed from smaller services
+# 🎨 Design
+
+Microfed follows a modular design approach, ensuring flexibility and maintainability. The high-level design focuses on the interaction between microservices and the fediverse.
+
+The idea is that each component of a fediverse server can be composed from smaller services.
 
 These include:
 - [Profile](#Profile)
@@ -32,36 +36,41 @@ These include:
 - [Outbox](#Outbox)
 - [Authentication](#Authentication)
 
-# Profile
+[Design Documentation](./DESIGN.md)
+
+
+# ✍️ Profile
+
+Your Profile page is the starting point for microfed services.  It will generally be an HTTP page, but the data should be agnostic to HTTP or any other protocol so that it can live in a database, or run over a P2P network.
 
-Your profile page is the starting point for microfed services.  It will generally be an HTTP page, but the data should be agnostic to HTTP or any other protocol so that it can live in a database, or run over a P2P network.
+The Profile will be in HTML, with the data in in JSON(-LD).  It will contain:
 
-The profile will be in HTML, with the data in in JSON(-LD).  It will contain:
+  ✓ The Profile page  
+  ✓ The User / Actor / Agent  
+  ✓ Attributes about the User  
+  ✓ Ability to store a public key  
+  ✓ A list of connections (friends, knows, followers etc.)  
+  ✓ Endpoint for Inbox  
+  ✓ Endpoint for Outbox  
+  ✓ Authentictation endpoints  
+  ✓ Arbitrary fields specified by the user  
 
-- The profile page
-- The User / Actor / Agent
-- Attributes about the User
-- Ability to store a public key
-- A list of connections (friends, knows, followers etc.)
-- Endpoint for inbox
-- Endpoint for outbox
-- Authentictation endpoints
-- Arbitrary fields specified by the user
+The Profile can be self-hosted, or part of a multi user service.  It should be able to run on a mobile device, or in the browser.
 
-The Profile can be self hosted, or part of a multi user service.  It should be able to run on a mobile device, or in the browser.
+[Profile Design](./PROFILE.md)
 
-# Inbox
+# 📬 Inbox
 
-The Inbox should be a place where people can send messages in JSON.  The micro service can filter out messages based on user preferences.  The message format should be as far as possible compatible with Activity Pub JSON.  Signatures can be used to verify the authenticity of a message
+The Inbox should be a place where people can send messages in JSON.  The micro service can filter out messages based on user preferences.  The message format should be as far as possible compatible with Activity Pub JSON.  Signatures can be used to verify the authenticity of a message.
 
-# Outbox
+# 📤 Outbox
 
-The outbox is a service that allows messages to be sent to other inboxes.  It should also have to ability to store a private key on behalf of a user, in order to sign outgoing messages.  It should be able to route messages to the right endpoints.
+The Outbox is a service that allows messages to be sent to other inboxes.  It should also have to ability to store a private key on behalf of a user, in order to sign outgoing messages.  It should be able to route messages to the right endpoints.
 
-# Authentication
+# 🔐 Authentication
 
-Initially, strong authentication via PKI will be supported.  Delegated authenticaiton, such as OAuth and OIDC may be considered desirable.  A loosely coupled authentication suite will allow the user to add different authentication modules.  This could also work with enterprise authentication. 
+Initially, strong authentication via PKI will be supported.  Delegated authentication, such as OAuth and OIDC may be considered desirable.  A loosely coupled authentication suite will allow the user to add different authentication modules.  This could also work with enterprise authentication. 
 
-# License
+# ⚖️ License
 
 - MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "microfed",
-  "version": "0.0.4",
+  "version": "0.0.6",
   "description": "microfed",
   "main": "index.js",
   "scripts": {