@props-labs/mesh-os 0.1.7

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 [2023] [Taranjeet Singh]
+
+   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.

package/README.md

@@ -0,0 +1,258 @@
+![MeshOS Banner](./assets/meshos-banner.png)
+
+> [!WARNING]
+> This is the **experimental TypeScript version** of MeshOS. For the stable Python implementation, please visit [Props-Labs/mesh-os](https://github.com/Props-Labs/mesh-os).
+>
+> The TypeScript version is under active development and APIs may change frequently. For production use, we recommend using the Python version.
+
+# MeshOS
+
+**The Memory & Knowledge Engine for Multi-Agent Systems**
+
+MeshOS is a **developer-first framework** for building **multi-agent AI-driven operations** with structured memory, knowledge retrieval, and real-time collaboration. Unlike generic memory stores, MeshOS is purpose-built for:
+
+- **Autonomous Agents & Teams** – Agents and humans evolve a shared memory over time.
+- **Graph-Based Memory** – Track relationships, dependencies, and evolving knowledge.
+- **Fast Semantic Search** – Vector-based retrieval with **pgvector**.
+- **Event-Driven Execution** – Automate workflows based on evolving context.
+- **Versioned Knowledge** – Track updates, past decisions, and historical context.
+- **Open & Portable** – Runs on **PostgreSQL + Hasura** with no vendor lock-in.
+
+## Why MeshOS?
+
+Most frameworks give you a **blob of memories**—MeshOS gives you **structured, evolving intelligence** with deep relationships and versioning.
+
+| Feature                      | MeshOS | Mem0 / Letta / Zep |
+| ---------------------------- | ------ | ------------------ |
+| **Multi-Agent Memory**       | ✅ Yes  | ❌ No               |
+| **Structured Taxonomy**      | ✅ Yes  | ❌ No               |
+| **Versioned Knowledge**      | ✅ Yes  | ❌ No               |
+| **Graph-Based Relationships** | ✅ Yes  | ❌ No               |
+| **Semantic & Vector Search**  | ✅ Yes  | ✅ Partial          |
+| **Event-Driven Execution**  | ✅ Yes  | ❌ No               |
+| **Open-Source & Portable**   | ✅ Yes  | ✅ Partial          |
+
+### **Who is MeshOS for?**
+
+✅ **Builders of AI-powered operations** – Structured memory and decision-making for AI-driven systems.  
+✅ **Multi-agent system developers** – AI agents that need to store, process, and evolve shared knowledge.  
+✅ **Developers & engineers** – Wanting an **open-source, PostgreSQL-powered framework** with no lock-in.  
+
+---
+
+```mermaid
+flowchart LR
+    %% Main System
+    subgraph MeshOS[MeshOS System]
+        direction LR
+
+        %% Taxonomy Details
+        subgraph Taxonomy[Memory Classification]
+            direction TB
+            
+            subgraph DataTypes[Data Types]
+                direction LR
+                knowledge[Knowledge Type]
+                activity[Activity Type]
+                decision[Decision Type]
+                media[Media Type]
+            end
+
+            subgraph Subtypes[Example Subtypes]
+                direction LR
+                k_types[Research/Mission/Vision]
+                a_types[Conversations/Logs/Events]
+                d_types[Policies/Strategies]
+                m_types[Documents/Images]
+
+                knowledge --> k_types
+                activity --> a_types
+                decision --> d_types
+                media --> m_types
+            end
+
+            subgraph Relations[Edge Types]
+                direction LR
+                basic[related_to/version_of]
+                semantic[influences/depends_on]
+                temporal[follows_up/precedes]
+            end
+        end
+
+        %% Memory Operations
+        subgraph MemoryEngine[Memory Operations]
+            direction LR
+            rememberAction[Store/Remember]
+            recallAction[Search/Recall]
+            linkAction[Link Memories]
+            versioning[Version Control]
+
+            rememberAction --> recallAction
+            recallAction --> linkAction
+            linkAction --> versioning
+        end
+    end
+
+    %% Organization & Agents
+    subgraph Organization[Organization & Agents]
+        direction TB
+
+        %% Company Memory
+        subgraph CompanyMemory[Company-Wide Memory]
+            direction LR
+            corpVision[Company Vision]
+            corpMission[Company Mission]
+            corpData[Knowledge Base]
+        end
+
+        %% Agents
+        subgraph Agent1[Research Agent]
+            a1Mem[Research Memories]
+        end
+
+        subgraph Agent2[Service Agent]
+            a2Mem[Service Memories]
+        end
+    end
+
+    %% System Connections
+    Taxonomy --> MemoryEngine
+    MemoryEngine --> Organization
+
+    %% Memory Connections
+    corpVision -.->|influences| a1Mem
+    corpMission -.->|guides| a2Mem
+    a1Mem -.->|shares| a2Mem
+    a2Mem -.->|feedback| corpData
+    a1Mem -.->|versions| corpData
+
+    %% Styling
+    classDef system fill:#dfeff9,stroke:#333,stroke-width:1.5px
+    classDef engine fill:#fcf8e3,stroke:#333
+    classDef taxonomy fill:#e7f5e9,stroke:#333
+    classDef types fill:#f8f4ff,stroke:#333
+    classDef org fill:#f4f4f4,stroke:#333
+
+    class MeshOS system
+    class MemoryEngine engine
+    class Taxonomy,DataTypes,Subtypes,Relations taxonomy
+    class Organization org
+```
+
+---
+
+## Getting Started
+
+### Install & Create a New Instance
+```bash
+# Install the CLI tool
+npm install -g @props-labs/mesh-os
+
+# Create and start a new project
+mesh-os init my-project && cd my-project
+mesh-os up
+```
+
+## Usage
+```typescript
+import { MeshOS } from '@props-labs/mesh-os';
+import dotenv from 'dotenv';
+
+// Load environment variables
+dotenv.config();
+
+// Initialize MeshOS
+const client = new MeshOS({
+  url: process.env.HASURA_URL || 'http://localhost:8080',
+  apiKey: process.env.HASURA_ADMIN_SECRET || 'meshos',
+  openaiApiKey: process.env.OPENAI_API_KEY
+});
+
+// Register an agent with a slug
+const agent = await client.registerAgent(
+  'AI_Explorer',
+  'An agent for exploring data',
+  { role: 'explorer' },
+  'ai-explorer'
+);
+
+// Store structured knowledge
+const memory = await client.remember(
+  'The Moon has water ice.',
+  agent.id,
+  {
+    type: 'knowledge',
+    subtype: 'fact',
+    tags: ['astronomy', 'moon'],
+    version: 1
+  }
+);
+
+// Retrieve similar knowledge
+const results = await client.recall('Tell me about the Moon.', {
+  agentId: agent.id,
+  limit: 5,
+  threshold: 0.7
+});
+```
+
+---
+
+## 🏗️ Core Features
+
+✅ **Memory for Multi-Agent Systems** – Let agents store, retrieve, and link structured knowledge.  
+✅ **Fast Semantic Search** – pgvector-powered similarity matching across all memories.  
+✅ **Graph-Based Knowledge** – Build evolving relationships between facts, ideas, and actions.  
+✅ **Versioning Built-In** – Track updates, past decisions, and context shifts.  
+✅ **Event-Driven Execution** – Automate workflows based on new knowledge.  
+✅ **Open & Portable** – Runs anywhere PostgreSQL does. No black-box infrastructure.  
+
+---
+
+## 🔗 Structured Taxonomy & Memory Graph
+
+MeshOS **enforces structured knowledge** with **memory classification** and **versioning**:
+
+| **Memory Type** | **Examples**                                 |
+| --------------- | -------------------------------------------- |
+| **Knowledge**   | Research reports, datasets, concepts        |
+| **Activity**    | Agent workflows, logs, system events        |
+| **Decision**    | Policy updates, business strategy           |
+| **Media**       | Documents, images, AI-generated content     |
+
+Memories **evolve** over time, with full versioning and relationship tracking.
+
+---
+
+## 🛠️ Development & Configuration
+
+### **Configuration**
+```ini
+# Required
+OPENAI_API_KEY=your_api_key_here
+
+# Optional (defaults shown)
+POSTGRES_PASSWORD=mysecretpassword
+HASURA_ADMIN_SECRET=meshos
+POSTGRES_PORT=5432
+HASURA_PORT=8080
+HASURA_ENABLE_CONSOLE=true
+```
+
+### **Development**
+```bash
+git clone https://github.com/props-labs/mesh-os.git
+cd mesh-os
+pnpm install
+pnpm build
+pnpm test
+```
+
+### **Contributing**
+Contributions are welcome! Please submit a Pull Request.
+
+---
+
+## ⚖️ License
+This project is licensed under the MIT License – see [LICENSE](./LICENSE) for details.
+

package/dist/core/client.d.ts

@@ -0,0 +1,142 @@
+import { EdgeType, type EdgeMetadata, type MemoryMetadata } from './taxonomy';
+/**
+ * An agent in the system.
+ */
+export interface Agent {
+    id: string;
+    name: string;
+    description: string;
+    metadata: Record<string, unknown>;
+    status: string;
+    slug?: string;
+}
+/**
+ * A memory stored in the system.
+ */
+export interface Memory {
+    id: string;
+    agentId: string;
+    content: string;
+    metadata: MemoryMetadata;
+    embedding: number[];
+    createdAt: string;
+    updatedAt: string;
+    similarity?: number;
+}
+/**
+ * A connection between two memories.
+ */
+export interface MemoryEdge {
+    id: string;
+    sourceMemory: string;
+    targetMemory: string;
+    relationship: EdgeType;
+    weight: number;
+    createdAt: string;
+    metadata: EdgeMetadata;
+}
+/**
+ * GraphQL error class.
+ */
+export declare class GraphQLError extends Error {
+    constructor(message: string);
+}
+/**
+ * Invalid slug error class.
+ */
+export declare class InvalidSlugError extends Error {
+    constructor(message: string);
+}
+/**
+ * MeshOS client configuration.
+ */
+export interface MeshOSConfig {
+    url?: string;
+    apiKey?: string;
+    openaiApiKey?: string;
+}
+/**
+ * MeshOS client for interacting with the system.
+ */
+export declare class MeshOS {
+    private url;
+    private headers;
+    private openai;
+    constructor(config?: MeshOSConfig);
+    private validateSlug;
+    /**
+     * Execute a GraphQL query.
+     */
+    private executeQuery;
+    /**
+     * Create an embedding for the given text.
+     */
+    private createEmbedding;
+    /**
+     * Register a new agent in the system.
+     */
+    registerAgent(name: string, description: string, metadata?: Record<string, unknown>, slug?: string): Promise<Agent>;
+    /**
+     * Get agent details by slug.
+     */
+    getAgentBySlug(slug: string): Promise<Agent | null>;
+    /**
+     * Unregister an agent and remove all their memories.
+     */
+    unregisterAgent(agentId: string): Promise<boolean>;
+    /**
+     * Get agent details by ID.
+     */
+    getAgent(agentId: string): Promise<Agent | null>;
+    /**
+     * Store a new memory.
+     */
+    remember(content: string, agentId: string, metadata?: Partial<MemoryMetadata>): Promise<Memory>;
+    /**
+     * Delete a specific memory.
+     */
+    forget(memoryId: string): Promise<boolean>;
+    /**
+     * Create a link between two memories.
+     */
+    linkMemories(sourceMemoryId: string, targetMemoryId: string, relationship: EdgeType, weight?: number, metadata?: Partial<EdgeMetadata>): Promise<MemoryEdge>;
+    /**
+     * Remove links between two memories.
+     */
+    unlinkMemories(sourceMemoryId: string, targetMemoryId: string, relationship?: string): Promise<boolean>;
+    /**
+     * Update a memory and optionally create a version edge to the previous version.
+     */
+    updateMemory(memoryId: string, content: string, metadata?: Partial<MemoryMetadata>, createVersionEdge?: boolean): Promise<Memory>;
+    /**
+     * Get memories connected to the given memory.
+     */
+    getConnectedMemories(memoryId: string, relationship?: string, maxDepth?: number): Promise<Array<{
+        source_id: string;
+        target_id: string;
+        relationship: string;
+        weight: number;
+        depth: number;
+    }>>;
+    /**
+     * Generate semantic variations of the query.
+     */
+    private expandQuery;
+    /**
+     * Search memories by semantic similarity.
+     */
+    recall(options: {
+        query: string;
+        agentId?: string;
+        limit?: number;
+        threshold?: number;
+        minResults?: number;
+        adaptiveThreshold?: boolean;
+        useSemanticExpansion?: boolean;
+        filters?: Record<string, unknown>;
+    }): Promise<Memory[]>;
+    /**
+     * Internal method to perform recall with a specific threshold.
+     */
+    private recallWithThreshold;
+}