microfed 0.0.7 → 0.0.9

package/AUTHENTICATION.md

@@ -0,0 +1,16 @@
+# 🛡️ Authentication Module
+
+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.
+
+## Key Features
+
+The Authentication Module provides the following capabilities:
+
+- A **base authentication class**, which serves as a foundation for implementing different authentication methods to cater to various needs and requirements.
+- **Support for PKI-based strong authentication**, ensuring a high level of security for user access and communication.
+- **Delegated authentication support**, such as OAuth and OIDC, providing the ability to incorporate third-party authentication services when necessary or desired.
+- **Integration with enterprise authentication systems**, allowing seamless authentication experiences for users within organizational environments.
+
+## Extensibility and Adaptability
+
+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/DESIGN.md

@@ -28,6 +28,8 @@ This document provides a high-level overview of Microfed's design, outlining the
 
 The Microfed Core serves as the central module that manages communication between different components and provides utility functions.
 
+[Core Design](./CORE.md)
+
 ## Profile Module
 
 The Profile Module consists of the following features:
@@ -47,6 +49,8 @@ The Inbox Module is designed to offer the following functionality:
 - Methods for filtering messages based on user preferences.
 - Support for Activity Pub JSON compatibility and message signatures.
 
+[Inbox Design](./INBOX.md)
+
 ## Outbox Module
 
 The Outbox Module includes the following capabilities:
@@ -55,6 +59,8 @@ The Outbox Module includes the following capabilities:
 - Methods for storing private keys and signing outgoing messages.
 - Support for routing messages to appropriate endpoints.
 
+[Outbox Design](./OUTBOX.md)
+
 ## Authentication Module
 
 The Authentication Module provides a flexible and extensible authentication system:
@@ -64,10 +70,14 @@ The Authentication Module provides a flexible and extensible authentication syst
 - Support for delegated authentication (e.g., OAuth, OIDC) if needed.
 - Integration with enterprise authentication systems.
 
+[Authentication Design](./AUTHENTICATION.md)
+
 ## Utility Functions
 
 The Utility Functions module offers various general-purpose functions, such as data validation, conversion, and formatting.
 
+[Utility Design](./UTILS.md)
+
 ---
 
 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/README.md

@@ -63,14 +63,20 @@ The Profile can be self-hosted, or part of a multi user service.  It should be a
 
 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.
 
+[Inbox Design](./INBOX.md)
+
 # 📤 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.
 
+[Outbox Design](./OUTBOX.md)
+
 # 🔐 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. 
 
+[Authentication Design](./AUTHENTICATION.md)
+
 # ⚖️ License
 
 - MIT

package/UTILS.md

@@ -0,0 +1,20 @@
+# 🛠️ Utils Module
+
+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.
+
+## Key Features
+
+The Utils Module offers the following essential utilities and tools:
+
+- **Data validation and sanitization**, ensuring that user data is correct, secure, and free from malicious input.
+- **Error handling and logging**, providing a structured approach to manage exceptions and log crucial information for debugging and maintenance purposes.
+- **Cryptography and security helpers**, offering a collection of tools for managing encryption, decryption, signing, and verification tasks.
+- **Networking and protocol utilities**, assisting with the handling of various networking tasks and protocol-specific operations.
+- **Message formatting and parsing**, delivering support for transforming and interpreting messages in different formats, such as JSON, JSON-LD, and others.
+- **Compatibility and integration tools**, enabling seamless interoperability between various components, modules, and third-party systems.
+
+## Modularity and Reusability
+
+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.
+
+By offering a comprehensive set of utilities, the Utils Module empowers developers to focus on implementing the unique features and requirements of their specific projects, knowing that they have a reliable set of tools to support their work. This ultimately leads to more efficient development cycles and higher-quality end products.

package/package.json

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