me2em-protocol-monorepo 0.5.0-alpha.1

package/CODE_OF_CONDUCT.md

@@ -0,0 +1,73 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in the Me2em community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment:
+
+✅ Using welcoming and inclusive language  
+✅ Being respectful of differing viewpoints and experiences  
+✅ Gracefully accepting constructive criticism  
+✅ Focusing on what is best for the community  
+✅ Showing empathy towards other community members  
+
+Examples of unacceptable behavior:
+
+❌ The use of sexualized language or imagery, and sexual attention or advances  
+❌ Trolling, insulting or derogatory comments, and personal or political attacks  
+❌ Public or private harassment  
+❌ Publishing others' private information without explicit permission  
+❌ Other conduct which could reasonably be considered inappropriate in a professional setting  
+
+## Enforcement Responsibilities
+
+Community leaders (maintainers) are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies within all community spaces (GitHub, discussions, chat), and also applies when an individual is officially representing the community in public spaces (conferences, social media).
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at `hello@me2em.com`. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional.  
+**Consequence**: Private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+**Community Impact**: A violation through a single incident or series of actions.  
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.  
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period.
+
+### 4. Permanent Ban
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.  
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1, available at [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at [https://www.contributor-covenant.org/faq][FAQ]. Translations are available at [https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

package/CONTRIBUTING.md

@@ -0,0 +1,145 @@
+# Contributing to me2em-protocol
+
+Thank you for your interest in contributing to Me2em! This document outlines how to contribute to the protocol reference implementation, our architecture, and release processes.
+
+## 🗂️ Project Structure & Architecture
+
+This repository is a `pnpm` workspace monorepo containing the core cryptographic primitives of the Me2em protocol. 
+
+> **Note:** The main marketing website, blog, and high-level guides are hosted in a **separate repository**: [`me2em-org/me2em-website`](https://github.com/me2em-org/me2em-website) (built with Astro). This repository is strictly for the protocol implementation and its API reference.
+
+```text
+me2em-protocol/
+├── packages/
+│   └── core/               # Core primitives: Identity, Handle, Session (@me2em/core)
+├── docs/                   # Generated TypeDoc output (auto-deployed, do not edit manually)
+├── package.json            # Root workspace configuration
+├── typedoc.json            # TypeDoc configuration for API reference generation
+└── CONTRIBUTING.md         # This file
+```
+
+## 🚀 Getting Started
+
+### Prerequisites
+- Node.js 18+ 
+- pnpm 9+ (We strictly use `pnpm`, not `npm` or `yarn`)
+
+### Local Development Setup
+```bash
+# 1. Clone the repository
+git clone https://github.com/me2em-org/me2em-protocol.git
+cd me2em-protocol
+
+# 2. Install dependencies for all workspace packages
+pnpm install
+
+# 3. Build the core package
+pnpm run build
+
+# 4. Run tests
+pnpm run test
+
+# 5. Generate documentation locally (optional, for preview)
+pnpm run build-docs
+# You can then view it by opening `docs/index.html` or running `npx serve docs`
+```
+
+## 📦 Publishing to npm
+
+Publishing is done manually to ensure strict version control. **Always use `pnpm`, never `npm`**, to maintain lockfile consistency.
+
+1. **Authenticate with pnpm registry:**
+   Ensure you are logged in. If not, run:
+   ```bash
+   pnpm login
+   ```
+2. **Update versions manually:** You must update the `"version"` field in **two** places to keep the workspace in sync:
+   - `package.json` (root)
+   - `packages/core/package.json`
+3. **Commit the version bump:**
+   ```bash
+   git add package.json packages/core/package.json
+   git commit -m "chore: bump version to X.Y.Z"
+   git push origin main
+   ```
+4. **Publish the package:**
+   Run the publish command specifically for the core package:
+   ```bash
+   pnpm publish --filter @me2em/core --access public
+   ```
+   *(Alternatively, from within the `packages/core` directory, you can run `pnpm publish --access public`)*
+
+## 📝 Documentation Pipeline
+
+We do not maintain a separate documentation repository or use heavy frameworks like Docusaurus for the API reference. 
+
+- **Source of Truth:** All API documentation is written as [JSDoc/TSDoc](https://tsdoc.org/) comments directly in the TypeScript source files (`packages/core/src/**/*.ts`).
+- **Automation:** The root `package.json` contains a `"build-docs": "typedoc"` script. 
+- **Deployment:** This repository is connected to **Cloudflare Pages**. On every `git push` to the `main` branch, Cloudflare automatically runs `pnpm install && pnpm run build-docs` and deploys the resulting `./docs` folder to **[docs.me2em.com](https://docs.me2em.com)**.
+
+**Rule for contributors:** If you add or modify public methods, classes, or interfaces, you **must** add or update the corresponding JSDoc comments. 
+
+## 🐛 Reporting Issues
+
+Before creating a new issue:
+1. Search [existing issues](https://github.com/me2em-org/me2em-protocol/issues).
+2. Check if it's already fixed in the `main` branch.
+3. Use the appropriate [issue template](.github/ISSUE_TEMPLATE/).
+
+⚠️ **For security vulnerabilities:** See [SECURITY.md](SECURITY.md). Do not disclose publicly.
+
+## 💡 Proposing Changes
+
+**Small fixes (typos, docs, minor bug fixes):**
+1. Fork the repository.
+2. Create a branch: `fix/short-description`.
+3. Make your changes and run `pnpm test`.
+4. Submit a Pull Request.
+
+**New features or breaking changes:**
+1. Open a [Discussion](https://github.com/me2em-org/me2em-protocol/discussions) first.
+2. Describe the problem, proposed solution, and alternatives.
+3. Wait for feedback from maintainers. If approved, implement and submit a PR.
+
+## 📐 Coding Standards
+
+### TypeScript/JavaScript
+- Follow the project's ESLint configuration.
+- Use strict mode. Avoid `any` types.
+- Write comprehensive JSDoc for all public APIs.
+- Aim for 100% type coverage for new code.
+
+### Commits
+- Use [Conventional Commits](https://www.conventionalcommits.org/).
+- Example: `feat(core): add handle derivation with metadata` or `fix(crypto): resolve edge case in hkdf`.
+
+## 🔐 Cryptography Guidelines
+
+Me2em is a security-critical project. When working with crypto:
+
+✅ **Do:**
+- Use established, audited libraries (e.g., `@noble/ed25519`, `@noble/hashes`, Web Crypto API).
+- Add property-based tests for cryptographic functions.
+- Document security assumptions and threat models in code comments.
+
+❌ **Don't:**
+- Implement your own cryptographic primitives.
+- Hardcode secrets, private keys, or test seeds in the source code.
+- Change key derivation parameters (like HKDF info/salt) without consensus and thorough review.
+
+## 🧪 Testing
+
+- New features require new tests.
+- Bug fixes should include a regression test.
+- Aim for >90% coverage in `packages/core`.
+- Run coverage locally: `pnpm run test:coverage`
+
+## 🤝 Review Process
+
+1. PR created → GitHub Actions CI runs automatically (lint, typecheck, test).
+2. Maintainer reviews within 3-5 business days.
+3. Address feedback by pushing updates to the same branch.
+4. Once approved, the PR is merged by a maintainer.
+
+---
+🙏 **Thank You!** Your contributions make Me2em better, more secure, and more accessible for everyone. Welcome to the community! 🎉

package/GOVERNANCE.md

@@ -0,0 +1,132 @@
+# Governance Model: Me2em Ecosystem
+
+> This document describes how decisions are made in the Me2em open-source project.
+
+**Version**: 1.0  
+**Last Updated**: May 2026  
+**Scope**: All repositories under `github.com/me2em-org`
+
+---
+
+## 🎯 Philosophy
+
+Me2em is built on three principles:
+
+1. **Privacy by Design**: Technical decisions must prioritize user privacy and cryptographic security.
+2. **Open Collaboration**: Anyone can contribute; merit is earned through quality work, not affiliation.
+3. **Decentralized Trust**: The protocol should enable trustless interactions; governance should reflect that.
+
+---
+
+## 👥 Roles
+
+### 👤 Contributor
+Anyone who submits code, docs, issues, or feedback.
+
+**Rights**:
+- Comment on issues and PRs
+- Propose features via Discussions
+- Submit pull requests
+
+**Path to next role**: 3+ merged PRs with positive reviews.
+
+### 🔧 Maintainer
+Trusted contributors with write access to specific repositories.
+
+**Responsibilities**:
+- Review and merge PRs in their area
+- Triage issues and label appropriately
+- Help onboard new contributors
+- Uphold code quality and security standards
+
+**How to become**:
+1. Be an active Contributor (3+ merged PRs)
+2. Receive nomination from an existing Maintainer
+3. Approval by ≥2 Core Team members
+4. 2-week no-objection period
+
+**Current Maintainers**: [List in `MAINTAINERS.md`]
+
+### 🧭 Core Team
+Strategic decision-makers for the protocol and ecosystem.
+
+**Responsibilities**:
+- Approve breaking changes to the protocol spec
+- Resolve maintainer disputes
+- Manage security disclosures and releases
+- Represent Me2em in external partnerships
+
+**How to become**:
+1. Be a Maintainer for ≥6 months
+2. Demonstrate deep protocol understanding
+3. Nomination by ≥2 Core Team members
+4. Supermajority vote (≥75%) of existing Core Team
+
+**Current Core Team**: [List in `CORE_TEAM.md`]
+
+### 🗳️ Community Advisory Council (Planned)
+Representative body for broader community input (post-v1.0).
+
+---
+
+## 🗳️ Decision-Making
+
+### Technical Decisions (within a repo)
+- **Process**: RFC via GitHub Discussion → Implementation PR → Maintainer review → Merge
+- **Consensus**: Lazy consensus (no objections after 5 business days)
+- **Tie-breaker**: Repo Maintainer(s)
+
+### Protocol Specification Changes
+- **Process**: Me2em Improvement Proposal (MIP) → Core Team review → Community comment period (14 days) → Core Team vote
+- **Threshold**: ≥2/3 Core Team approval
+- **Documentation**: All MIPs archived in `specs/MIPs/`
+
+### Governance Changes
+- **Process**: Proposal in Discussions → Core Team draft → Community comment (30 days) → Core Team supermajority (≥75%)
+- **Ratification**: Published as `GOVERNANCE-vX.md`
+
+### Security Decisions
+- **Process**: Private discussion among Core Team + security reporter → Fix → Coordinated disclosure
+- **Emergency**: Core Team may act unilaterally for critical vulnerabilities, with post-mortem
+
+---
+
+## 🔄 Conflict Resolution
+
+1. **Direct discussion**: Parties attempt to resolve informally
+2. **Maintainer mediation**: Neutral Maintainer facilitates
+3. **Core Team escalation**: Final decision by Core Team vote
+4. **Community fork**: As last resort, community may fork (per Apache 2.0 license)
+
+---
+
+## 📊 Transparency
+
+- All non-sensitive discussions happen in public (GitHub Issues/Discussions)
+- Meeting notes (Core Team) published within 7 days
+- Financial decisions (if any) documented in `TRANSPARENCY.md`
+- Security incidents: post-mortem published after resolution
+
+---
+
+## 🚀 Roadmap Input
+
+Anyone can propose roadmap items via:
+- GitHub Discussions: `category:roadmap`
+- Annual community survey (planned)
+
+Core Team prioritizes based on:
+1. Security & stability
+2. Community demand (👍 reactions, use-case validation)
+3. Technical feasibility
+4. Alignment with Me2em philosophy
+
+---
+
+## 📜 Amendments
+
+This document may be amended following the "Governance Changes" process above.
+
+---
+
+*Part of the Me2em ecosystem: [github.com/me2em-org](https://github.com/me2em-org) | Contact: hello@me2em.com*

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.