@mxf-dev/core 1.0.0

package/dist/models/mcpTool.js

@@ -0,0 +1,175 @@
+/**
+ * Copyright 2024 Brad Anderson
+ *
+ * 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.
+ *
+ * @author Brad Anderson <BradA1878@pm.me>
+ * @repository https://github.com/mxf-dev/mxf
+ * @documentation https://mxf-dev.github.io/mxf/
+ */
+/**
+ * MCP Tool Model
+ *
+ * Represents a Model Context Protocol (MCP) tool that can be registered and executed
+ * within the Model Exchange Framework.
+ */
+import mongoose, { Schema } from 'mongoose';
+import { createStrictValidator } from '../utils/validation.js';
+// Create validator for the MCP tool model
+const validate = createStrictValidator('McpToolModel');
+/**
+ * MCP Tool schema
+ */
+const McpToolSchema = new Schema({
+    // Basic tool information
+    name: {
+        type: String,
+        required: true,
+        index: true
+    },
+    description: {
+        type: String,
+        required: true
+    },
+    // Tool configuration
+    inputSchema: {
+        type: Schema.Types.Mixed,
+        required: true
+    },
+    enabled: {
+        type: Boolean,
+        default: true,
+        index: true
+    },
+    // Tool parameters
+    parameters: {
+        type: Schema.Types.Mixed,
+        default: []
+    },
+    // Tracking information
+    providerId: {
+        type: String,
+        required: true,
+        index: true
+    },
+    channelId: {
+        type: String,
+        required: false,
+        default: '',
+        index: true
+    },
+    // Additional data
+    metadata: {
+        type: Schema.Types.Mixed,
+        default: {}
+    },
+    // Timestamps
+    createdAt: {
+        type: Date,
+        default: Date.now
+    },
+    updatedAt: {
+        type: Date,
+        default: Date.now
+    }
+});
+// Create compound indexes for better query performance
+McpToolSchema.index({ channelId: 1, enabled: 1 });
+McpToolSchema.index({ providerId: 1, enabled: 1 });
+// Create unique compound index to prevent duplicate tools
+McpToolSchema.index({ name: 1, providerId: 1, channelId: 1 }, { unique: true });
+// Pre-save hook to update the updatedAt field
+McpToolSchema.pre('save', function (next) {
+    this.updatedAt = new Date();
+    next();
+});
+// Create the model
+export const McpTool = mongoose.model('McpTool', McpToolSchema);
+/**
+ * Create a new MCP tool in the database
+ * @param toolData The tool data to save
+ * @returns Promise resolving to the created tool
+ */
+export const createMcpTool = async (toolData) => {
+    validate.assertIsObject(toolData);
+    validate.assertIsNonEmptyString(toolData.name);
+    // Description can be empty but must be a string if provided
+    if (toolData.description !== undefined && typeof toolData.description !== 'string') {
+        throw new Error('[McpToolModel] Description must be a string if provided');
+    }
+    validate.assertIsObject(toolData.inputSchema);
+    validate.assertIsNonEmptyString(toolData.providerId);
+    // ChannelId can be empty but must be a string
+    if (toolData.channelId !== undefined && typeof toolData.channelId !== 'string') {
+        throw new Error('[McpToolModel] ChannelId must be a string if provided');
+    }
+    const tool = await McpTool.findOneAndUpdate({ name: toolData.name, providerId: toolData.providerId, channelId: toolData.channelId }, { $setOnInsert: toolData }, { new: true, upsert: true });
+    return tool;
+};
+/**
+ * Find an MCP tool by name
+ * @param name Name of the tool to find
+ * @returns Promise resolving to the found tool or null
+ */
+export const findMcpToolByName = async (name) => {
+    validate.assertIsNonEmptyString(name);
+    return await McpTool.findOne({ name });
+};
+/**
+ * Find MCP tools by channel ID
+ * @param channelId Channel ID to filter by
+ * @param enabledOnly Whether to return only enabled tools
+ * @returns Promise resolving to an array of found tools
+ */
+export const findMcpToolsByChannelId = async (channelId, enabledOnly = true) => {
+    validate.assertIsNonEmptyString(channelId);
+    const query = { channelId };
+    if (enabledOnly) {
+        query.enabled = true;
+    }
+    return await McpTool.find(query);
+};
+/**
+ * List all MCP tools
+ * @param enabledOnly Whether to return only enabled tools
+ * @returns Promise resolving to an array of all tools
+ */
+export const listAllMcpTools = async (enabledOnly = true) => {
+    const query = {};
+    if (enabledOnly) {
+        query.enabled = true;
+    }
+    return await McpTool.find(query);
+};
+/**
+ * Update an MCP tool
+ * @param name Name of the tool to update
+ * @param updates Updates to apply to the tool
+ * @returns Promise resolving to the updated tool or null if not found
+ */
+export const updateMcpTool = async (name, updates) => {
+    validate.assertIsNonEmptyString(name);
+    validate.assertIsObject(updates);
+    return await McpTool.findOneAndUpdate({ name }, { ...updates, updatedAt: new Date() }, { new: true });
+};
+/**
+ * Delete an MCP tool
+ * @param name Name of the tool to delete
+ * @returns Promise resolving to true if deleted, false if not found
+ */
+export const deleteMcpTool = async (name) => {
+    validate.assertIsNonEmptyString(name);
+    const result = await McpTool.deleteOne({ name });
+    return result.deletedCount > 0;
+};
+//# sourceMappingURL=mcpTool.js.map

package/dist/models/mcpTool.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mcpTool.js","sourceRoot":"","sources":["../../src/models/mcpTool.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAEH;;;;;GAKG;AAEH,OAAO,QAAQ,EAAE,EAAY,MAAM,EAAE,MAAM,UAAU,CAAC;AACtD,OAAO,EAAE,qBAAqB,EAAE,MAAM,wBAAwB,CAAC;AAE/D,0CAA0C;AAC1C,MAAM,QAAQ,GAAG,qBAAqB,CAAC,cAAc,CAAC,CAAC;AAwCvD;;GAEG;AACH,MAAM,aAAa,GAAG,IAAI,MAAM,CAAW;IACvC,yBAAyB;IACzB,IAAI,EAAE;QACF,IAAI,EAAE,MAAM;QACZ,QAAQ,EAAE,IAAI;QACd,KAAK,EAAE,IAAI;KACd;IACD,WAAW,EAAE;QACT,IAAI,EAAE,MAAM;QACZ,QAAQ,EAAE,IAAI;KACjB;IAED,qBAAqB;IACrB,WAAW,EAAE;QACT,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,KAAK;QACxB,QAAQ,EAAE,IAAI;KACjB;IACD,OAAO,EAAE;QACL,IAAI,EAAE,OAAO;QACb,OAAO,EAAE,IAAI;QACb,KAAK,EAAE,IAAI;KACd;IAED,kBAAkB;IAClB,UAAU,EAAE;QACR,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,KAAK;QACxB,OAAO,EAAE,EAAE;KACd;IAED,uBAAuB;IACvB,UAAU,EAAE;QACR,IAAI,EAAE,MAAM;QACZ,QAAQ,EAAE,IAAI;QACd,KAAK,EAAE,IAAI;KACd;IACD,SAAS,EAAE;QACP,IAAI,EAAE,MAAM;QACZ,QAAQ,EAAE,KAAK;QACf,OAAO,EAAE,EAAE;QACX,KAAK,EAAE,IAAI;KACd;IAED,kBAAkB;IAClB,QAAQ,EAAE;QACN,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,KAAK;QACxB,OAAO,EAAE,EAAE;KACd;IAED,aAAa;IACb,SAAS,EAAE;QACP,IAAI,EAAE,IAAI;QACV,OAAO,EAAE,IAAI,CAAC,GAAG;KACpB;IACD,SAAS,EAAE;QACP,IAAI,EAAE,IAAI;QACV,OAAO,EAAE,IAAI,CAAC,GAAG;KACpB;CACJ,CAAC,CAAC;AAEH,uDAAuD;AACvD,aAAa,CAAC,KAAK,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC,CAAC;AAClD,aAAa,CAAC,KAAK,CAAC,EAAE,UAAU,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC,CAAC;AAEnD,0DAA0D;AAC1D,aAAa,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,UAAU,EAAE,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;AAEhF,8CAA8C;AAC9C,aAAa,CAAC,GAAG,CAAC,MAAM,EAAE,UAAS,IAAI;IACnC,IAAI,CAAC,SAAS,GAAG,IAAI,IAAI,EAAE,CAAC;IAC5B,IAAI,EAAE,CAAC;AACX,CAAC,CAAC,CAAC;AAEH,mBAAmB;AACnB,MAAM,CAAC,MAAM,OAAO,GAAG,QAAQ,CAAC,KAAK,CAAW,SAAS,EAAE,aAAa,CAAC,CAAC;AAE1E;;;;GAIG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,KAAK,EAAE,QAAwC,EAAqB,EAAE;IAC/F,QAAQ,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;IAClC,QAAQ,CAAC,sBAAsB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IAE/C,4DAA4D;IAC5D,IAAI,QAAQ,CAAC,WAAW,KAAK,SAAS,IAAI,OAAO,QAAQ,CAAC,WAAW,KAAK,QAAQ,EAAE,CAAC;QACjF,MAAM,IAAI,KAAK,CAAC,yDAAyD,CAAC,CAAC;IAC/E,CAAC;IAED,QAAQ,CAAC,cAAc,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;IAC9C,QAAQ,CAAC,sBAAsB,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;IAErD,8CAA8C;IAC9C,IAAI,QAAQ,CAAC,SAAS,KAAK,SAAS,IAAI,OAAO,QAAQ,CAAC,SAAS,KAAK,QAAQ,EAAE,CAAC;QAC7E,MAAM,IAAI,KAAK,CAAC,uDAAuD,CAAC,CAAC;IAC7E,CAAC;IAED,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,gBAAgB,CACvC,EAAE,IAAI,EAAE,QAAQ,CAAC,IAAI,EAAE,UAAU,EAAE,QAAQ,CAAC,UAAU,EAAE,SAAS,EAAE,QAAQ,CAAC,SAAS,EAAE,EACvF,EAAE,YAAY,EAAE,QAAQ,EAAE,EAC1B,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,CAC9B,CAAC;IACF,OAAO,IAAI,CAAC;AAChB,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,KAAK,EAAE,IAAY,EAA4B,EAAE;IAC9E,QAAQ,CAAC,sBAAsB,CAAC,IAAI,CAAC,CAAC;IACtC,OAAO,MAAM,OAAO,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC;AAC3C,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,KAAK,EACxC,SAAiB,EACjB,WAAW,GAAG,IAAI,EACC,EAAE;IACrB,QAAQ,CAAC,sBAAsB,CAAC,SAAS,CAAC,CAAC;IAE3C,MAAM,KAAK,GAAQ,EAAE,SAAS,EAAE,CAAC;IACjC,IAAI,WAAW,EAAE,CAAC;QACd,KAAK,CAAC,OAAO,GAAG,IAAI,CAAC;IACzB,CAAC;IAED,OAAO,MAAM,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AACrC,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,KAAK,EAAE,WAAW,GAAG,IAAI,EAAuB,EAAE;IAC7E,MAAM,KAAK,GAAQ,EAAE,CAAC;IACtB,IAAI,WAAW,EAAE,CAAC;QACd,KAAK,CAAC,OAAO,GAAG,IAAI,CAAC;IACzB,CAAC;IAED,OAAO,MAAM,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AACrC,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,KAAK,EAC9B,IAAY,EACZ,OAA0B,EACF,EAAE;IAC1B,QAAQ,CAAC,sBAAsB,CAAC,IAAI,CAAC,CAAC;IACtC,QAAQ,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;IAEjC,OAAO,MAAM,OAAO,CAAC,gBAAgB,CACjC,EAAE,IAAI,EAAE,EACR,EAAE,GAAG,OAAO,EAAE,SAAS,EAAE,IAAI,IAAI,EAAE,EAAE,EACrC,EAAE,GAAG,EAAE,IAAI,EAAE,CAChB,CAAC;AACN,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,KAAK,EAAE,IAAY,EAAoB,EAAE;IAClE,QAAQ,CAAC,sBAAsB,CAAC,IAAI,CAAC,CAAC;IAEtC,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC;IACjD,OAAO,MAAM,CAAC,YAAY,GAAG,CAAC,CAAC;AACnC,CAAC,CAAC"}

package/dist/models/mcpToolExecution.d.ts

@@ -0,0 +1,77 @@
+/**
+ * Copyright 2024 Brad Anderson
+ *
+ * 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.
+ *
+ * @author Brad Anderson <BradA1878@pm.me>
+ * @repository https://github.com/mxf-dev/mxf
+ * @documentation https://mxf-dev.github.io/mxf/
+ */
+/**
+ * MCP Tool Execution Model
+ *
+ * Records all MCP tool executions for auditing, analytics, and dashboard display.
+ * This tracks both internal MXF tools and external MCP server tools.
+ */
+import mongoose, { Document } from 'mongoose';
+/**
+ * Status of a tool execution
+ */
+export type McpToolExecutionStatus = 'pending' | 'running' | 'completed' | 'failed' | 'timeout';
+/**
+ * Source type for tool execution
+ */
+export type McpToolSource = 'internal' | 'external' | 'client-internal' | 'client-external';
+/**
+ * MCP Tool Execution interface
+ */
+export interface IMcpToolExecution extends Document {
+    /** Unique request ID for tracking */
+    requestId: string;
+    /** Name of the tool being executed */
+    toolName: string;
+    /** Source of the tool: internal (MXF) or external (MCP server) */
+    source: McpToolSource;
+    /** Server ID for external tools */
+    serverId?: string;
+    /** Agent that initiated the tool call */
+    agentId?: string;
+    /** Channel context for the execution */
+    channelId?: string;
+    /** Input parameters passed to the tool */
+    parameters: Record<string, any>;
+    /** Result returned by the tool (if successful) */
+    result?: any;
+    /** Error message (if failed) */
+    errorMessage?: string;
+    /** Error code (if failed) */
+    errorCode?: string;
+    /** Execution status */
+    status: McpToolExecutionStatus;
+    /** When the execution started */
+    startedAt: Date;
+    /** When the execution completed */
+    completedAt?: Date;
+    /** Duration in milliseconds */
+    durationMs?: number;
+    /** Additional metadata */
+    metadata?: Record<string, any>;
+    /** Category of the tool */
+    category?: string;
+}
+export declare const McpToolExecution: mongoose.Model<IMcpToolExecution, {}, {}, {}, mongoose.Document<unknown, {}, IMcpToolExecution> & IMcpToolExecution & Required<{
+    _id: unknown;
+}> & {
+    __v: number;
+}, any>;
+//# sourceMappingURL=mcpToolExecution.d.ts.map

package/dist/models/mcpToolExecution.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mcpToolExecution.d.ts","sourceRoot":"","sources":["../../src/models/mcpToolExecution.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAEH;;;;;GAKG;AAEH,OAAO,QAAQ,EAAE,EAAE,QAAQ,EAAU,MAAM,UAAU,CAAC;AAEtD;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,SAAS,GAAG,SAAS,GAAG,WAAW,GAAG,QAAQ,GAAG,SAAS,CAAC;AAEhG;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,UAAU,GAAG,UAAU,GAAG,iBAAiB,GAAG,iBAAiB,CAAC;AAE5F;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,QAAQ;IAC/C,qCAAqC;IACrC,SAAS,EAAE,MAAM,CAAC;IAClB,sCAAsC;IACtC,QAAQ,EAAE,MAAM,CAAC;IACjB,kEAAkE;IAClE,MAAM,EAAE,aAAa,CAAC;IACtB,mCAAmC;IACnC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,yCAAyC;IACzC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,wCAAwC;IACxC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,0CAA0C;IAC1C,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAChC,kDAAkD;IAClD,MAAM,CAAC,EAAE,GAAG,CAAC;IACb,gCAAgC;IAChC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,6BAA6B;IAC7B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,uBAAuB;IACvB,MAAM,EAAE,sBAAsB,CAAC;IAC/B,iCAAiC;IACjC,SAAS,EAAE,IAAI,CAAC;IAChB,mCAAmC;IACnC,WAAW,CAAC,EAAE,IAAI,CAAC;IACnB,+BAA+B;IAC/B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,0BAA0B;IAC1B,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC/B,2BAA2B;IAC3B,QAAQ,CAAC,EAAE,MAAM,CAAC;CACrB;AAsFD,eAAO,MAAM,gBAAgB;;;;OAAgF,CAAC"}

package/dist/models/mcpToolExecution.js

@@ -0,0 +1,110 @@
+/**
+ * Copyright 2024 Brad Anderson
+ *
+ * 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.
+ *
+ * @author Brad Anderson <BradA1878@pm.me>
+ * @repository https://github.com/mxf-dev/mxf
+ * @documentation https://mxf-dev.github.io/mxf/
+ */
+/**
+ * MCP Tool Execution Model
+ *
+ * Records all MCP tool executions for auditing, analytics, and dashboard display.
+ * This tracks both internal MXF tools and external MCP server tools.
+ */
+import mongoose, { Schema } from 'mongoose';
+/**
+ * MCP Tool Execution schema
+ */
+const McpToolExecutionSchema = new Schema({
+    requestId: {
+        type: String,
+        required: true,
+        unique: true,
+        index: true
+    },
+    toolName: {
+        type: String,
+        required: true,
+        index: true
+    },
+    source: {
+        type: String,
+        enum: ['internal', 'external', 'client-internal', 'client-external'],
+        required: true,
+        index: true
+    },
+    serverId: {
+        type: String,
+        index: true
+    },
+    agentId: {
+        type: String,
+        index: true
+    },
+    channelId: {
+        type: String,
+        index: true
+    },
+    parameters: {
+        type: Schema.Types.Mixed,
+        required: true,
+        default: {}
+    },
+    result: {
+        type: Schema.Types.Mixed
+    },
+    errorMessage: {
+        type: String
+    },
+    errorCode: {
+        type: String
+    },
+    status: {
+        type: String,
+        enum: ['pending', 'running', 'completed', 'failed', 'timeout'],
+        required: true,
+        default: 'pending',
+        index: true
+    },
+    startedAt: {
+        type: Date,
+        required: true,
+        default: Date.now,
+        index: true
+    },
+    completedAt: {
+        type: Date
+    },
+    durationMs: {
+        type: Number
+    },
+    metadata: {
+        type: Schema.Types.Mixed
+    },
+    category: {
+        type: String,
+        index: true
+    }
+}, {
+    timestamps: true
+});
+// Compound indexes for common queries
+McpToolExecutionSchema.index({ status: 1, startedAt: -1 });
+McpToolExecutionSchema.index({ toolName: 1, startedAt: -1 });
+McpToolExecutionSchema.index({ agentId: 1, startedAt: -1 });
+McpToolExecutionSchema.index({ channelId: 1, startedAt: -1 });
+// Create the model
+export const McpToolExecution = mongoose.model('McpToolExecution', McpToolExecutionSchema);
+//# sourceMappingURL=mcpToolExecution.js.map

package/dist/models/mcpToolExecution.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mcpToolExecution.js","sourceRoot":"","sources":["../../src/models/mcpToolExecution.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAEH;;;;;GAKG;AAEH,OAAO,QAAQ,EAAE,EAAY,MAAM,EAAE,MAAM,UAAU,CAAC;AAkDtD;;GAEG;AACH,MAAM,sBAAsB,GAAG,IAAI,MAAM,CAAoB;IACzD,SAAS,EAAE;QACP,IAAI,EAAE,MAAM;QACZ,QAAQ,EAAE,IAAI;QACd,MAAM,EAAE,IAAI;QACZ,KAAK,EAAE,IAAI;KACd;IACD,QAAQ,EAAE;QACN,IAAI,EAAE,MAAM;QACZ,QAAQ,EAAE,IAAI;QACd,KAAK,EAAE,IAAI;KACd;IACD,MAAM,EAAE;QACJ,IAAI,EAAE,MAAM;QACZ,IAAI,EAAE,CAAC,UAAU,EAAE,UAAU,EAAE,iBAAiB,EAAE,iBAAiB,CAAC;QACpE,QAAQ,EAAE,IAAI;QACd,KAAK,EAAE,IAAI;KACd;IACD,QAAQ,EAAE;QACN,IAAI,EAAE,MAAM;QACZ,KAAK,EAAE,IAAI;KACd;IACD,OAAO,EAAE;QACL,IAAI,EAAE,MAAM;QACZ,KAAK,EAAE,IAAI;KACd;IACD,SAAS,EAAE;QACP,IAAI,EAAE,MAAM;QACZ,KAAK,EAAE,IAAI;KACd;IACD,UAAU,EAAE;QACR,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,KAAK;QACxB,QAAQ,EAAE,IAAI;QACd,OAAO,EAAE,EAAE;KACd;IACD,MAAM,EAAE;QACJ,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,KAAK;KAC3B;IACD,YAAY,EAAE;QACV,IAAI,EAAE,MAAM;KACf;IACD,SAAS,EAAE;QACP,IAAI,EAAE,MAAM;KACf;IACD,MAAM,EAAE;QACJ,IAAI,EAAE,MAAM;QACZ,IAAI,EAAE,CAAC,SAAS,EAAE,SAAS,EAAE,WAAW,EAAE,QAAQ,EAAE,SAAS,CAAC;QAC9D,QAAQ,EAAE,IAAI;QACd,OAAO,EAAE,SAAS;QAClB,KAAK,EAAE,IAAI;KACd;IACD,SAAS,EAAE;QACP,IAAI,EAAE,IAAI;QACV,QAAQ,EAAE,IAAI;QACd,OAAO,EAAE,IAAI,CAAC,GAAG;QACjB,KAAK,EAAE,IAAI;KACd;IACD,WAAW,EAAE;QACT,IAAI,EAAE,IAAI;KACb;IACD,UAAU,EAAE;QACR,IAAI,EAAE,MAAM;KACf;IACD,QAAQ,EAAE;QACN,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,KAAK;KAC3B;IACD,QAAQ,EAAE;QACN,IAAI,EAAE,MAAM;QACZ,KAAK,EAAE,IAAI;KACd;CACJ,EAAE;IACC,UAAU,EAAE,IAAI;CACnB,CAAC,CAAC;AAEH,sCAAsC;AACtC,sBAAsB,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;AAC3D,sBAAsB,CAAC,KAAK,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;AAC7D,sBAAsB,CAAC,KAAK,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;AAC5D,sBAAsB,CAAC,KAAK,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;AAE9D,mBAAmB;AACnB,MAAM,CAAC,MAAM,gBAAgB,GAAG,QAAQ,CAAC,KAAK,CAAoB,kBAAkB,EAAE,sBAAsB,CAAC,CAAC"}

package/dist/models/memory.d.ts

@@ -0,0 +1,47 @@
+/**
+ * Copyright 2024 Brad Anderson
+ *
+ * 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.
+ *
+ * @author Brad Anderson <BradA1878@pm.me>
+ * @repository https://github.com/mxf-dev/mxf
+ * @documentation https://mxf-dev.github.io/mxf/
+ */
+/**
+ * Memory Models
+ *
+ * This file contains Mongoose schemas and models for the Memory System.
+ * These models define the database structure for different memory types.
+ */
+import mongoose, { Model } from 'mongoose';
+import { IAgentMemory, IChannelMemory, IRelationshipMemory, MemoryScope } from '../types/MemoryTypes.js';
+import { MemoryUtilitySubdocument } from '../types/MemoryUtilityTypes.js';
+export interface AgentMemoryDocument extends Omit<mongoose.Document, 'id'>, IAgentMemory {
+    utility?: MemoryUtilitySubdocument;
+}
+export interface ChannelMemoryDocument extends Omit<mongoose.Document, 'id'>, IChannelMemory {
+    utility?: MemoryUtilitySubdocument;
+}
+export interface RelationshipMemoryDocument extends Omit<mongoose.Document, 'id'>, IRelationshipMemory {
+    utility?: MemoryUtilitySubdocument;
+}
+export declare const AgentMemory: Model<AgentMemoryDocument>;
+export declare const ChannelMemory: Model<ChannelMemoryDocument>;
+export declare const RelationshipMemory: Model<RelationshipMemoryDocument>;
+/**
+ * Helper function to create a memory model instance based on scope
+ * @param scope Memory scope
+ * @returns The corresponding memory model
+ */
+export declare const getMemoryModelByScope: (scope: MemoryScope) => Model<any>;
+//# sourceMappingURL=memory.d.ts.map

package/dist/models/memory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"memory.d.ts","sourceRoot":"","sources":["../../src/models/memory.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAEH;;;;;GAKG;AAEH,OAAO,QAAQ,EAAE,EAAoB,KAAK,EAAE,MAAM,UAAU,CAAC;AAG7D,OAAO,EACH,YAAY,EACZ,cAAc,EACd,mBAAmB,EACnB,WAAW,EAEd,MAAM,yBAAyB,CAAC;AACjC,OAAO,EACH,wBAAwB,EAI3B,MAAM,gCAAgC,CAAC;AAuNxC,MAAM,WAAW,mBAAoB,SAAQ,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,IAAI,CAAC,EAAE,YAAY;IACpF,OAAO,CAAC,EAAE,wBAAwB,CAAC;CACtC;AACD,MAAM,WAAW,qBAAsB,SAAQ,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,IAAI,CAAC,EAAE,cAAc;IACxF,OAAO,CAAC,EAAE,wBAAwB,CAAC;CACtC;AACD,MAAM,WAAW,0BAA2B,SAAQ,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,IAAI,CAAC,EAAE,mBAAmB;IAClG,OAAO,CAAC,EAAE,wBAAwB,CAAC;CACtC;AAmBD,eAAO,MAAM,WAAW,EAAE,KAAK,CAAC,mBAAmB,CACqD,CAAC;AAEzG,eAAO,MAAM,aAAa,EAAE,KAAK,CAAC,qBAAqB,CACyD,CAAC;AAEjH,eAAO,MAAM,kBAAkB,EAAE,KAAK,CAAC,0BAA0B,CACmE,CAAC;AAErI;;;;GAIG;AACH,eAAO,MAAM,qBAAqB,GAAI,OAAO,WAAW,KAAG,KAAK,CAAC,GAAG,CAWnE,CAAC"}

package/dist/models/memory.js

@@ -0,0 +1,251 @@
+/**
+ * Copyright 2024 Brad Anderson
+ *
+ * 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.
+ *
+ * @author Brad Anderson <BradA1878@pm.me>
+ * @repository https://github.com/mxf-dev/mxf
+ * @documentation https://mxf-dev.github.io/mxf/
+ */
+/**
+ * Memory Models
+ *
+ * This file contains Mongoose schemas and models for the Memory System.
+ * These models define the database structure for different memory types.
+ */
+import mongoose, { Schema } from 'mongoose';
+import { v4 as uuidv4 } from 'uuid';
+import { MemoryScope, MemoryPersistenceLevel } from '../types/MemoryTypes.js';
+/**
+ * Base Memory Schema with common fields for all memory types
+ */
+const baseMemorySchema = new Schema({
+    // Unique identifier
+    id: {
+        type: String,
+        required: true,
+        unique: true,
+        default: () => uuidv4()
+    },
+    // Creation timestamp
+    createdAt: {
+        type: Date,
+        default: Date.now
+    },
+    // Last update timestamp
+    updatedAt: {
+        type: Date,
+        default: Date.now
+    },
+    // Persistence level (temporary or persistent)
+    persistenceLevel: {
+        type: String,
+        enum: Object.values(MemoryPersistenceLevel),
+        default: MemoryPersistenceLevel.PERSISTENT
+    },
+    // Free-form notes as JSON object
+    notes: {
+        type: Schema.Types.Mixed,
+        default: {}
+    },
+    // Custom data as JSON object
+    customData: {
+        type: Schema.Types.Mixed,
+        default: {}
+    },
+    // Memory Utility Learning System (MULS) subdocument
+    // Tracks Q-values for utility-based retrieval
+    utility: {
+        type: new Schema({
+            // Current Q-value (0-1 range, default 0.5)
+            qValue: {
+                type: Number,
+                default: 0.5,
+                min: 0,
+                max: 1
+            },
+            // History of Q-value updates for convergence analysis
+            qValueHistory: [{
+                    value: { type: Number, required: true },
+                    reward: { type: Number, required: true },
+                    timestamp: { type: Date, default: Date.now },
+                    taskId: { type: String },
+                    phase: { type: String }
+                }],
+            // Total number of times this memory was retrieved
+            retrievalCount: {
+                type: Number,
+                default: 0
+            },
+            // Number of successful task completions where this memory was used
+            successCount: {
+                type: Number,
+                default: 0
+            },
+            // Number of failed task completions where this memory was used
+            failureCount: {
+                type: Number,
+                default: 0
+            },
+            // Timestamp of last reward update
+            lastRewardAt: {
+                type: Date,
+                default: Date.now
+            },
+            // How the Q-value was initially set
+            initializedFrom: {
+                type: String,
+                enum: ['default', 'surprise', 'transfer', 'manual'],
+                default: 'default'
+            }
+        }, { _id: false }),
+        default: () => ({
+            qValue: 0.5,
+            qValueHistory: [],
+            retrievalCount: 0,
+            successCount: 0,
+            failureCount: 0,
+            lastRewardAt: new Date(),
+            initializedFrom: 'default'
+        })
+    }
+}, {
+    timestamps: true,
+    strict: false, // Allow for flexible schema evolution
+    id: false, // Don't create default MongoDB _id field
+    toJSON: {
+        transform: (doc, ret) => {
+            delete ret._id; // Remove MongoDB _id when converting to JSON
+            return ret;
+        }
+    }
+});
+/**
+ * Agent Memory Schema
+ */
+const agentMemorySchema = new Schema({
+    // Reference to Agent ID
+    agentId: {
+        type: String,
+        required: true,
+        index: true
+    },
+    // Conversation history
+    conversationHistory: {
+        type: [Schema.Types.Mixed],
+        default: []
+    }
+});
+/**
+ * Channel Memory Schema
+ */
+const channelMemorySchema = new Schema({
+    // Reference to Channel ID
+    channelId: {
+        type: String,
+        required: true,
+        index: true
+    },
+    // Shared state visible to all agents in the channel
+    sharedState: {
+        type: Schema.Types.Mixed,
+        default: {}
+    },
+    // Conversation history
+    conversationHistory: {
+        type: [Schema.Types.Mixed],
+        default: []
+    }
+});
+/**
+ * Relationship Memory Schema
+ */
+const relationshipMemorySchema = new Schema({
+    // First Agent ID
+    agentId1: {
+        type: String,
+        required: true
+    },
+    // Second Agent ID
+    agentId2: {
+        type: String,
+        required: true
+    },
+    // Optional Channel ID where the relationship exists
+    channelId: {
+        type: String
+    },
+    // Interaction history between agents
+    interactionHistory: {
+        type: [Schema.Types.Mixed],
+        default: []
+    }
+});
+// Create compound index for relationship memory
+relationshipMemorySchema.index({ agentId1: 1, agentId2: 1, channelId: 1 }, { unique: true });
+// Complete memory models by combining base and specific schemas
+const AgentMemorySchema = new Schema({
+    ...baseMemorySchema.obj,
+    ...agentMemorySchema.obj
+});
+const ChannelMemorySchema = new Schema({
+    ...baseMemorySchema.obj,
+    ...channelMemorySchema.obj
+});
+const RelationshipMemorySchema = new Schema({
+    ...baseMemorySchema.obj,
+    ...relationshipMemorySchema.obj
+});
+// Create indexes for Q-value queries (MULS optimization)
+// Index for sorting by Q-value descending (top performers)
+AgentMemorySchema.index({ 'utility.qValue': -1 });
+// Compound index for agent-scoped Q-value queries
+AgentMemorySchema.index({ agentId: 1, 'utility.qValue': -1 });
+ChannelMemorySchema.index({ 'utility.qValue': -1 });
+ChannelMemorySchema.index({ channelId: 1, 'utility.qValue': -1 });
+RelationshipMemorySchema.index({ 'utility.qValue': -1 });
+// Pre-save hooks
+AgentMemorySchema.pre('save', function (next) {
+    this.updatedAt = new Date();
+    next();
+});
+ChannelMemorySchema.pre('save', function (next) {
+    this.updatedAt = new Date();
+    next();
+});
+RelationshipMemorySchema.pre('save', function (next) {
+    this.updatedAt = new Date();
+    next();
+});
+// Create the Mongoose models
+export const AgentMemory = mongoose.models.AgentMemory || mongoose.model('AgentMemory', AgentMemorySchema);
+export const ChannelMemory = mongoose.models.ChannelMemory || mongoose.model('ChannelMemory', ChannelMemorySchema);
+export const RelationshipMemory = mongoose.models.RelationshipMemory || mongoose.model('RelationshipMemory', RelationshipMemorySchema);
+/**
+ * Helper function to create a memory model instance based on scope
+ * @param scope Memory scope
+ * @returns The corresponding memory model
+ */
+export const getMemoryModelByScope = (scope) => {
+    switch (scope) {
+        case MemoryScope.AGENT:
+            return AgentMemory;
+        case MemoryScope.CHANNEL:
+            return ChannelMemory;
+        case MemoryScope.RELATIONSHIP:
+            return RelationshipMemory;
+        default:
+            throw new Error(`Invalid memory scope: ${scope}`);
+    }
+};
+//# sourceMappingURL=memory.js.map