this.me 2.9.51 → 3.0.0

package/notes/Summary.md

@@ -1,125 +0,0 @@
-# this.me — Identity System
-
-## ✨ Summary
-`this.me` is a decentralized identity system designed to allow users to manage their own identities locally, with optional validation by external authorities such as Cleaker. It combines privacy, user control, and secure interoperability.
-
-
-## 🔐 Identity Model Comparison
-| **Model**            | **Where your identity lives** | **Local signing** | **Real freedom**        |
-|----------------------|-------------------------------|-------------------|--------------------------|
-| Web2 (Facebook, etc) | On their servers              | ❌                | ❌                       |
-| Web3 (wallets)       | In extensions or apps         | ✅                | 🟡 (fragmented)          |
-| `this.me`            | In your OS `.this/me/`        | ✅✅              | ✅✅✅                   |
-
----
-
-## 🔍 Core Principles
-1. **Freedom to Declare**
-   Anyone can generate a `.me` identity locally without external approval.
-2. **Trusted Endorsements**
-   Authorities (e.g., Cleaker) can endorse `.me` identities without controlling them.
-3. **Local Ownership**
-   All sensitive data (including private keys) stays on the user's machine.
-
----
-## 📁 File Structure
-* `~/.this/me/username.me.json` — Encrypted identity file
-* `.me` includes:
-
-  * `username`
-  * `publicKey`, `privateKey` (encrypted)
-  * `attributes`, `relationships`, `reactions`, `properties`, `relationships`
-  * `endorsements`
-
----
-
-## 🔎 Identity Lifecycle
-
-### 1. Create Identity
-```bash
-me create jabellae
-# Prompts for hash (e.g. 4242)
-# Generates encrypted .me file
-```
-
-### 2. Register/Endorse with Authority
-```bash
-me endorse --with cleaker
-# Signs and shares publicKey with Cleaker
-```
-
-### 3. Verify Identity
-```bash
-me verify --with cleaker
-# Validates signature and authority endorsement
-```
-
-### 4. Migrate Across Devices
-```bash
-me restore --from-seed
-# Or use encrypted backup file + hash
-```
-
-### 5. Rotate Keys
-```bash
-me rotate
-# Generates new key pair, requires re-endorsement
-```
-
----
-
-## 🔐 Cryptographic Model
-* Identity is unlocked using a user-defined `hash` (password).
-* This hash decrypts the local `.me` file.
-* The identity includes:
-
-  * A **key pair** (public/private) for signing and verification.
-  * Optional **endorsements** signed by Cleaker or other authorities.
-
----
-
-## 🛡️ Security Model
-* No private key ever leaves the local `.me` file.
-* Endorsements are public and verifiable using the public key.
-* If compromised, user can rotate keys and notify authorities.
-
----
-
-## 🌐 Multi-Device Support
-* `.me` can be restored using a seed phrase or backup.
-* New devices can be authorized using signatures from old devices.
-
----
-
-## ⚖️ Responsibilities
-
-* **this.me**
-  * Local file management, encryption, signing.
-  * CLI + API for usage.
-
-* **Cleaker / Authorities**
-
-  * Store trusted records of `username` + `publicKey`
-  * Provide validation/endorsement services.
-
----
-
-## 🌍 Future Use Cases
-* Digital signature of documents
-* Smart contract interaction
-* Federated profiles with trust anchors
-* Group identity and shared contexts (`me && you && them in context/friends`)
-
----
-
-## 📖 Glossary
-* `hash`: A password-like string used to unlock `.me`
-* `endorsement`: Signature from a recognized authority on the identity
-* `publicKey/privateKey`: Cryptographic key pair for identity signing
-* `Cleaker`: Example identity authority ledger
-
----
-
-**Author:** suiGn / neurons.me
-**License:** MIT
-**Project:** [this.me](https://www.npmjs.com/package/this.me)

package/notes/The Problem: Decentralized Yet Trustworthy.md

@@ -1,13 +0,0 @@
-The Problem: Decentralized Yet Trustworthy
-Identity, by its nature, is both personal and relational. On the one hand, we want the freedom to define ourselves without external constraints. On the other, our identities must often be validated by trusted authorities to engage in meaningful transactions, whether signing a digital contract or interacting with a service.
-
-Traditional centralized systems — such as social media platforms, government IDs, or corporate logins — often prioritize control over freedom. These systems require users to surrender their data and identities to be recognized. While decentralized technologies like blockchains have emerged to challenge this model, they introduce their own complexities and limitations, such as over-reliance on cryptographic keys or lack of intuitive identity frameworks.
-
-The question arises:How can we create an identity system that respects personal sovereignty while ensuring trust and usability in a networked world?
-
-Enter This.me: A New Paradigm for Identity
-This.me offers a framework for identity creation and interaction that revolves around two core principles:
-
-1. Freedom to Declare: Anyone can create a `.me` instance and define their identity without external permissions. This identity exists as a standalone object, enabling users to interact in a purely self-declared state.
-
-2. Trust Anchors: When needed, central authorities or networks, such as Cleaker, can validate the identity. These authorities provide the infrastructure for authentication, signing, and verification without compromising the user’s control over their identity.

package/notes/Understanding me && you && himContext.md

@@ -1,11 +0,0 @@
-This structure implies:
-
-1. Logical Grouping of Entities: me && you && him represents a logical grouping, where each entity is included as part of a broader relationship.
-
-2. Contextual Scoping: Context/mexicans provides a scope within which this relationship exists, giving meaning to the relationship without establishing a strict hierarchy among me, you, and him.
-
-3. Dynamic Meaning: The meaning can change based on context. For example:
-
-• me && you && himContext/mexicans could mean a group of entities (me, you, him) sharing a “Mexican” attribute.
-
-Context/friends might represent the same group within a “friends” context, applying different attributes or significance.

package/notes/hot_encoding.md

@@ -1,44 +0,0 @@
-### Neural Networks - **One-Hot Encoding**
---------
-To represent the combinations of **“me, you, him, her, it, us, them”** in a neural network, we need to convert the elements into a suitable format for neural network processing, such as one-hot encoding, and design a neural network architecture that can process these inputs.
-
-Here’s a step-by-step approach to achieve this:
-1.	**One-Hot Encoding:** Convert each element (“me”, “you”, “him”, “her”, “it”, “us”, “them”) into a one-hot encoded vector.
-2.	**Combination Representation:** Create input vectors for each combination by combining the one-hot encoded vectors.
-3.	**Neural Network Design:** Design a simple neural network to process these input vectors.
-
-#### Step 1: One-Hot Encoding
-One-hot encoding represents each element as a binary vector with a single high (1) value and the rest low (0). For the elements “me”, “you”, “him”, “her”, “it”, “us”, “them”, we can assign the following one-hot encoded vectors:
-
-```js
-// Create Me instances
-const meInstance = new Me('me');
-const youInstance = new Me('you');
-const himInstance = new Me('him');
-const herInstance = new Me('her');
-const itInstance = new Me('it');
-const usInstance = new Me('us');
-const themInstance = new Me('them');
-
-// One-hot encoding representation
-const subjects = {
-  'me': [1, 0, 0, 0, 0, 0, 0],
-  'you': [0, 1, 0, 0, 0, 0, 0],
-  'him': [0, 0, 1, 0, 0, 0, 0],
-  'her': [0, 0, 0, 1, 0, 0, 0],
-  'it': [0, 0, 0, 0, 1, 0, 0],
-  'us': [0, 0, 0, 0, 0, 1, 0],
-  'them': [0, 0, 0, 0, 0, 0, 1]
-};
-```
-
-#### Step 2: Combination Representation
-For each combination, we can create an input vector by combining the one-hot encoded vectors of its elements. For example:
-Combination “me, you” would be represented as the sum of the one-hot vectors for “me” and “you”:
-
-```
-[1, 0, 0, 0, 0, 0, 0] + [0, 1, 0, 0, 0, 0, 0] = [1, 1, 0, 0, 0, 0, 0]
-```
----
-### Me Deviation Formula
-**How Spread Out the data Points are around the .me?**

package/src/example.js

@@ -1,25 +0,0 @@
-//this.me/src/example.js
-import Me from './me.js';
-import chalk from 'chalk';
-// Create a new Me instance
-let me = new Me('suign');
-// Add attributes to the identity
-me.be({ fullName: "Jose", lastName: "Abella" });
-me.be({ xy: "z" });
-console.log(me);
-// Examplconsole.log(me.identity());e with another instance
-let anotherMe = new Me('anotherUser');
-anotherMe.be({ nickname: "hero", favoriteColor: "blue" });
-console.log(anotherMe);
-// Create a new Me instance with dynamic property name
-let user = 'suign';
-let users = {};
-users[user] = new Me(user);
-// Add attributes to the identity
-users[user].be({ fullName: "ZZZ", lastName: "WWW" });
-users[user].be({ xy: "axax" });
-console.log(users[user]);
-
-console.log(users);
-
-

package/src/me.js

@@ -1,148 +0,0 @@
-// src/me.js
-import fs from 'fs';
-import path from 'path';
-import crypto from 'crypto';
-import os from 'os';
-
-const ROOT_DIR = path.join(os.homedir(), '.this', 'me');
-
-class Me {
-  constructor(username) {
-    this.username = username;
-    this.filePath = path.join(ROOT_DIR, `${username}.me`); // encrypted .me file path
-    this.unlocked = false; // will become true after decrypting with correct hash
-    this.data = null; // holds decrypted data (identity, keys, attributes, etc.)
-  }
-
-  /**
-   * Encrypt and write the current `this.data` to disk.
-   */
-  save(hash) {
-    if (!this.data) throw new Error('No data to save');
-    const iv = crypto.randomBytes(16);
-    const key = crypto.createHash('sha256').update(hash).digest();
-    const cipher = crypto.createCipheriv('aes-256-cbc', key, iv);
-    const encrypted = Buffer.concat([
-      iv,
-      cipher.update(JSON.stringify(this.data)),
-      cipher.final()
-    ]);
-    fs.writeFileSync(this.filePath, encrypted);
-  }
-
-  /**
-   * Unlock the .me file by decrypting it using the provided hash.
-   */
-  unlock(hash) {
-    const fileBuffer = fs.readFileSync(this.filePath);
-    const iv = fileBuffer.slice(0, 16);
-    const encryptedData = fileBuffer.slice(16);
-    const key = crypto.createHash('sha256').update(hash).digest();
-    try {
-      const decipher = crypto.createDecipheriv('aes-256-cbc', key, iv);
-      const decrypted = Buffer.concat([
-        decipher.update(encryptedData),
-        decipher.final()
-      ]);
-      this.data = JSON.parse(decrypted.toString('utf-8'));
-      this.unlocked = true;
-      return true;
-    } catch (err) {
-      return false; // incorrect hash or corrupted file
-    }
-  }
-
-  /**
-   * Locks the session by wiping in-memory data.
-   */
-  lock() {
-    this.data = null;
-    this.unlocked = false;
-  }
-
- /**
-   * Create a new identity file for the given username.
-   * Called only if it doesn't already exist.
-   */
- static create(username, hash) {
-  const me = new Me(username);
-  if (fs.existsSync(me.filePath)) {
-    throw new Error('Identity already exists');
-  }
-
-  // Generate keys or initial structure
-  me.data = {
-    identity: {
-      username,
-      publicKey: 'publicKeyPlaceholder', // later generate real keypair
-      privateKey: 'privateKeyPlaceholder'
-    },
-    attributes: {},
-    relationships: [],
-    reactions: [],
-    endorsements: []
-  };
-
-  me.save(hash);
-  return me;
-}
-
-  /**
-   * Create a new identity file for the given username.
-   * Called only if it doesn't already exist.
-   */
-  static create(username, hash) {
-    const me = new Me(username);
-    if (fs.existsSync(me.filePath)) {
-      throw new Error('Identity already exists');
-    }
-
-    // Generate keys or initial structure
-    me.data = {
-      identity: {
-        username,
-        publicKey: 'publicKeyPlaceholder', // later generate real keypair
-        privateKey: 'privateKeyPlaceholder'
-      },
-      attributes: {},
-      relationships: [],
-      reactions: [],
-      endorsements: []
-    };
-
-    me.save(hash);
-    return me;
-  }
-
-  /**
-   * Load and decrypt an existing identity.
-   */
-  static load(username, hash) {
-    const me = new Me(username);
-    const success = me.unlock(hash);
-    if (!success) throw new Error('Invalid hash or corrupted file');
-    return me;
-  }
-  /**
-   * Add an endorsement (external signature asserting trust in this identity).
-   */
-  addEndorsement(endorsement) {
-    if (!this.unlocked) throw new Error('Identity is locked');
-    this.data.endorsements.push(endorsement);
-  }
-
-  /**
-   * Example: add an attribute to this.me (like `.be("artist")`).
-   */
-  be(key, value) {
-    if (!this.unlocked) throw new Error('Identity is locked');
-    this.data.attributes[key] = value;
-  }
-
-  getAttributes() {
-    if (!this.unlocked) throw new Error('Identity is locked');
-    return this.data.attributes;
-  }
-}
-
-export default Me;

package/src/methods/attributes.js

@@ -1,79 +0,0 @@
- // Attributes methods
- /**
- * @module Attributes
- * @description Methods to manage attributes for the `Me` class, with key-vaue pairs.
- */
-/**
-   * @description Adds or updates an attribute for the `me` instance.
-   * 
-   * This method allows you to dynamically add or update descriptive attributes 
-   * for the `me` instance. Attributes are stored as key-value pairs, where:
-   * - The **key** represents the name of the attribute (e.g., "name", "age", "location").
-   * - The **value** represents the data associated with that attribute (e.g., "Sui Gn", 30, "Earth").
-   * 
-   * You can add as many key-value pairs as you want, giving you the flexibility to describe 
-   * the `me` instance with plain data. The attributes are stored in an object, and each call 
-   * to `be` either adds a new attribute or updates an existing one if the key already exists.
-   * 
-   * This approach ensures that the `me` instance can evolve and be customized over time 
-   * with additional or modified attributes as needed.
-   * 
-   * @param {string} key - The attribute key (e.g., "name").
-   * @param {string|number|boolean|Object} value - The attribute value associated with the key. 
-   *   This can be any data type (e.g., string, number, boolean, or even a nested object).
-   * 
-   * @example
-   * // Adding a single attribute
-   * me.be("name", "Sui Gn");
-   * console.log(me.getAttributes()); // { name: "Sui Gn" }
-   * 
-   * // Adding multiple attributes
-   * me.be("age", 30);
-   * me.be("location", "Earth");
-   * console.log(me.getAttributes()); 
-   * // Output: { name: "Sui Gn", age: 30, location: "Earth" }
-   * 
-   * // Updating an existing attribute
-   * me.be("name", "John Doe");
-   * console.log(me.getAttributes()); 
-   * // Output: { name: "John Doe", age: 30, location: "Earth" }
-   * 
-   * // Using complex data types
-   * me.be("preferences", { theme: "dark", language: "en" });
-   * console.log(me.getAttributes());
-   * // Output: { name: "John Doe", age: 30, location: "Earth", preferences: { theme: "dark", language: "en" } }
-   */
-export function be(attributes, key, value) {
-    if (!key || typeof key !== 'string') {
-        throw new Error('Invalid key for attribute');
-    }
-    attributes[key] = value;
-  }
-  /**
-     * @description Retrieves all attributes associated with the `me` instance.
-     * 
-     * This method provides access to the current set of attributes stored in the `me` instance 
-     * as an object containing key-value pairs. Each key represents the name of an attribute, 
-     * and its corresponding value represents the data stored for that attribute.
-     * 
-     * You can either:
-     * - Retrieve all attributes at once as a single object.
-     * - Access specific attributes directly using their keys.
-     * 
-     * @returns {Object} An object containing all the key-value pairs representing 
-     * the attributes of the `me` instance.
-     * 
-     * @example
-     * // Retrieving all attributes
-     * console.log(me.getAttributes()); 
-     * // Output: { name: "Sui Gn", age: 30, location: "Earth" }
-     * 
-     * // Accessing specific attributes by their key
-     * const attributes = me.getAttributes();
-     * console.log(attributes.name); // "Sui Gn"
-     * console.log(attributes.age); // 30
-     * console.log(attributes.location); // "Earth"
-     */
-  export function getAttributes(attributes) {
-    return attributes;
-  }

package/src/methods/identity.js

@@ -1,31 +0,0 @@
-/**
- * @module Identity
- * @description Methods to manage identity for the `Me` class.
- */
-
-/**
- * Sets up the identity for a `Me` instance.
- * @function
- * @param {string} username - The username to set for the identity.
- * @returns {Object} The identity object containing the username.
- * 
- * @example
- * const identity = setup("suiGn");
- * console.log(identity); // { username: "suiGn" }
- */
-export function setup(username) {
-  return { username };
-}
-
-/**
-* Retrieves the username (identity) of the `Me` instance.
-* @function
-* @param {Object} identity - The identity object of the `Me` instance.
-* @returns {Object} The `Me` username identity object.
-* 
-* @example
-* console.log(getMe({ username: "suiGn" })); // { username: "suiGn" }
-*/
-export function getMe(identity) {
-  return identity;
-}

package/src/methods/properties.js

@@ -1,73 +0,0 @@
-// this.me/src/methods/properties.js
-/**
- * @module Properties
- * @description Methods to manage properties for the `Me` class.
- */
-
-/**
- * Validates a property before adding it.
- * @function
- * @param {Object} property - The property to validate.
- * @throws {Error} If the property is invalid.
- */
-function validateProperty(property) {
-  if (!property || typeof property !== 'object') {
-    throw new Error('Invalid property: Must be a non-null object.');
-  }
-}
-
-/**
- * Adds a property to the identity.
- * @function
- * @param {Array} properties - The properties array to update.
- * @param {Object} property - The property to add (e.g., { type: "ETH", address: "0x123..." }).
- */
-function addProperty(properties, property) {
-  validateProperty(property);
-  properties.push(property);
-}
-
-/**
- * Retrieves all properties for the identity.
- * @function
- * @param {Array} properties - The properties array to retrieve from.
- * @returns {Array} The properties array.
- */
-function getProperties(properties) {
-  return [...properties]; // Return a shallow copy to prevent mutation outside
-}
-
-/**
- * Removes a property from the identity.
- * @function
- * @param {Array} properties - The properties array to update.
- * @param {Object} property - The property to remove.
- */
-function removeProperty(properties, property) {
-  validateProperty(property);
-  const index = properties.findIndex(p => JSON.stringify(p) === JSON.stringify(property));
-  if (index !== -1) properties.splice(index, 1);
-}
-
-/**
- * Checks if a specific property exists.
- * @function
- * @param {Array} properties - The properties array.
- * @param {Object} property - The property to check.
- * @returns {boolean} True if the property exists, otherwise false.
- */
-function hasProperty(properties, property) {
-  validateProperty(property);
-  return properties.some(p => JSON.stringify(p) === JSON.stringify(property));
-}
-
-// Named exports
-export { addProperty, getProperties, removeProperty, hasProperty };
-
-// Default export (optional for easier import as an object)
-export default {
-  addProperty,
-  getProperties,
-  removeProperty,
-  hasProperty
-};

package/src/methods/reactions.js

@@ -1,31 +0,0 @@
-//this.me/src/methods/reactions.js
-/**
- * @module Reactions
- * @description Methods to manage reactions for the `Me` class.
- */
-/**
- * Add a reaction to a target.
- * @function
- * @param {Array} reactions - The reactions array to update.
- * @param {string} type - The type of reaction (e.g., "like", "comment").
- * @param {string} target - The target of the reaction (e.g., "PostID").
- * @param {string} [content=null] - Additional content for the reaction (e.g., a comment).
- * @throws {Error} If the type or target is invalid.
- */
-export function react(reactions, type, target, content = null) {
-    if (!type || !target) {
-      throw new Error('Invalid reaction parameters');
-    }
-    reactions.push({ type, target, content, timestamp: new Date() });
-  }
-  
-  /**
-   * Retrieve all reactions for the identity.
-   * @function
-   * @param {Array} reactions - The reactions array to retrieve from.
-   * @returns {Array} The reactions array.
-   * @instance
-   */
-  export function getReactions(reactions) {
-    return reactions;
-  }

package/src/methods/relationships.js

@@ -1,26 +0,0 @@
-/**
- * @module Relationships
- * @description Manages user relationships.
- */
-
-// Function to add a relationship
-export function addRelationship(relationships, relationship) {
-  if (!relationship || !relationship.type || !relationship.username) {
-    throw new Error('Invalid relationship object. Must include type and username.');
-  }
-
-  relationships.push(relationship);
-}
-
-// Function to retrieve relationships
-export function getRelationships(relationships, type = null) {
-  if (type) {
-    return relationships.filter(rel => rel.type === type);
-  }
-  return relationships;
-}
-
-// Function to initialize relationships for a user
-export function createRelationships() {
-  return [];
-}

package/src/scripts/setup.js

@@ -1,19 +0,0 @@
-// setup.js
-import { mkdirSync, existsSync } from 'fs';
-import { homedir } from 'os';
-import path from 'path';
-const root = path.join(homedir(), '.this');
-const mePath = path.join(root, 'me');
-if (!existsSync(root)) {
-  mkdirSync(root);
-  console.log('✅ Created ~/.this root directory');
-} else {
-  console.log('✅ ~/.this root directory already exists');
-}
-
-if (!existsSync(mePath)) {
-  mkdirSync(mePath);
-  console.log('✅ Created ~/.this/me directory');
-} else {
-  console.log('✅ ~/.this/me directory already exists');
-}

package/src/scripts/setup_validation.js

@@ -1,31 +0,0 @@
-import { existsSync, mkdirSync } from 'fs';
-import { homedir } from 'os';
-import path from 'path';
-
-const root = path.join(homedir(), '.this');
-const mePath = path.join(root, 'me');
-
-export function validateSetup() {
-  let updated = false;
-
-  if (!existsSync(root)) {
-    mkdirSync(root);
-    console.log('✅ Created ~/.this root directory');
-    updated = true;
-  }
-
-  if (!existsSync(mePath)) {
-    mkdirSync(mePath);
-    console.log('✅ Created ~/.this/me directory');
-    updated = true;
-  }
-
-  if (!updated) {
-    console.log('.me >> init.');
-  }
-}
-
-// Run directly if script is executed as entry point
-if (import.meta.url === `file://${process.argv[1]}`) {
-  validateSetup();
-}