@mxf-dev/core 1.0.0 → 2.0.0

package/src/events/event-definitions/AnalyticsEvents.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  *
  * @author Brad Anderson <BradA1878@pm.me>
- * @repository https://github.com/mxf-dev/mxf
+ * @repository https://github.com/BradA1878/model-exchange-framework
  * @documentation https://mxf-dev.github.io/mxf/
  */
 

package/src/events/event-definitions/BulkEvents.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  *
  * @author Brad Anderson <BradA1878@pm.me>
- * @repository https://github.com/mxf-dev/mxf
+ * @repository https://github.com/BradA1878/model-exchange-framework
  * @documentation https://mxf-dev.github.io/mxf/
  */
 

package/src/events/event-definitions/ChannelEvents.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  *
  * @author Brad Anderson <BradA1878@pm.me>
- * @repository https://github.com/mxf-dev/mxf
+ * @repository https://github.com/BradA1878/model-exchange-framework
  * @documentation https://mxf-dev.github.io/mxf/
  */
 

package/src/events/event-definitions/CodeExecutionEvents.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  *
  * @author Brad Anderson <BradA1878@pm.me>
- * @repository https://github.com/mxf-dev/mxf
+ * @repository https://github.com/BradA1878/model-exchange-framework
  * @documentation https://mxf-dev.github.io/mxf/
  */
 

package/src/events/event-definitions/CompactionEvents.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  *
  * @author Brad Anderson <BradA1878@pm.me>
- * @repository https://github.com/mxf-dev/mxf
+ * @repository https://github.com/BradA1878/model-exchange-framework
  * @documentation https://mxf-dev.github.io/mxf/
  */
 

package/src/events/event-definitions/ConfigEvents.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  *
  * @author Brad Anderson <BradA1878@pm.me>
- * @repository https://github.com/mxf-dev/mxf
+ * @repository https://github.com/BradA1878/model-exchange-framework
  * @documentation https://mxf-dev.github.io/mxf/
  */
 

package/src/events/event-definitions/ControlLoopEvents.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  *
  * @author Brad Anderson <BradA1878@pm.me>
- * @repository https://github.com/mxf-dev/mxf
+ * @repository https://github.com/BradA1878/model-exchange-framework
  * @documentation https://mxf-dev.github.io/mxf/
  */
 

package/src/events/event-definitions/DagEvents.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  *
  * @author Brad Anderson <BradA1878@pm.me>
- * @repository https://github.com/mxf-dev/mxf
+ * @repository https://github.com/BradA1878/model-exchange-framework
  * @documentation https://mxf-dev.github.io/mxf/
  */
 

package/src/events/event-definitions/HeartbeatEvents.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  *
  * @author Brad Anderson <BradA1878@pm.me>
- * @repository https://github.com/mxf-dev/mxf
+ * @repository https://github.com/BradA1878/model-exchange-framework
  * @documentation https://mxf-dev.github.io/mxf/
  */
 

package/src/events/event-definitions/InferenceParameterEvents.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  *
  * @author Brad Anderson <BradA1878@pm.me>
- * @repository https://github.com/mxf-dev/mxf
+ * @repository https://github.com/BradA1878/model-exchange-framework
  * @documentation https://mxf-dev.github.io/mxf/
  */
 

package/src/events/event-definitions/KeyEvents.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  *
  * @author Brad Anderson <BradA1878@pm.me>
- * @repository https://github.com/mxf-dev/mxf
+ * @repository https://github.com/BradA1878/model-exchange-framework
  * @documentation https://mxf-dev.github.io/mxf/
  */
 

package/src/events/event-definitions/KnowledgeGraphEvents.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  *
  * @author Brad Anderson <BradA1878@pm.me>
- * @repository https://github.com/mxf-dev/mxf
+ * @repository https://github.com/BradA1878/model-exchange-framework
  * @documentation https://mxf-dev.github.io/mxf/
  */
 

package/src/events/event-definitions/LlmBudgetEvents.ts

@@ -0,0 +1,74 @@
+/**
+ * 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/BradA1878/model-exchange-framework
+ * @documentation https://mxf-dev.github.io/mxf/
+ */
+
+/**
+ * LLM Budget Events
+ *
+ * Emitted as SystemLLM spend approaches and crosses its daily ceiling. SystemLLM runs on
+ * Claude Opus and had no absolute spend cap — only per-channel and global cooldowns — so
+ * a busy or looping channel could run up real cost with nothing to stop it. These events
+ * make that spend observable, and the EXCEEDED event marks the point where SystemLLM
+ * calls start being refused.
+ */
+
+import { AgentId, ChannelId } from '../../types/ChannelContext.js';
+
+/**
+ * Events emitted as SystemLLM spend approaches and crosses the daily ceiling.
+ */
+export const LlmBudgetEvents = {
+    /** Spend crossed the warning threshold. SystemLLM is still running. */
+    WARNING: 'llm:budget:warning',
+    /** Spend reached the daily ceiling. SystemLLM calls are refused until reset. */
+    EXCEEDED: 'llm:budget:exceeded',
+    /** A new budget day started and spend went back to zero. */
+    RESET: 'llm:budget:reset'
+} as const;
+
+/**
+ * Spend figures carried by every budget event.
+ */
+export interface LlmBudgetEventData {
+    /** Money spent so far in the current budget day, in USD. */
+    spentUsd: number;
+    /** The daily ceiling, in USD. */
+    limitUsd: number;
+    /** Fraction of the ceiling used (spentUsd / limitUsd). */
+    utilization: number;
+    /** Start of the current budget day, as an ISO timestamp. */
+    periodStart: string;
+    /** Model whose call triggered the event, when there was one. */
+    model?: string;
+}
+
+/**
+ * Payload types for LLM budget events.
+ */
+export interface LlmBudgetPayloads {
+    'llm:budget:warning': LlmBudgetEventData;
+    'llm:budget:exceeded': LlmBudgetEventData;
+    'llm:budget:reset': LlmBudgetEventData;
+}
+
+/** Actor recorded on budget events. Spend is a property of the server, not an agent. */
+export const LLM_BUDGET_ACTOR_ID = 'system-llm-budget' as AgentId;
+
+/** Channel recorded on budget events. The ceiling is global, not per channel. */
+export const LLM_BUDGET_CHANNEL_ID = 'global' as ChannelId;

package/src/events/event-definitions/LlmEvents.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  *
  * @author Brad Anderson <BradA1878@pm.me>
- * @repository https://github.com/mxf-dev/mxf
+ * @repository https://github.com/BradA1878/model-exchange-framework
  * @documentation https://mxf-dev.github.io/mxf/
  */
 

package/src/events/event-definitions/McpEvents.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  *
  * @author Brad Anderson <BradA1878@pm.me>
- * @repository https://github.com/mxf-dev/mxf
+ * @repository https://github.com/BradA1878/model-exchange-framework
  * @documentation https://mxf-dev.github.io/mxf/
  */
 

package/src/events/event-definitions/MeilisearchEvents.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  *
  * @author Brad Anderson <BradA1878@pm.me>
- * @repository https://github.com/mxf-dev/mxf
+ * @repository https://github.com/BradA1878/model-exchange-framework
  * @documentation https://mxf-dev.github.io/mxf/
  */
 

package/src/events/event-definitions/MemoryEvents.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  *
  * @author Brad Anderson <BradA1878@pm.me>
- * @repository https://github.com/mxf-dev/mxf
+ * @repository https://github.com/BradA1878/model-exchange-framework
  * @documentation https://mxf-dev.github.io/mxf/
  */
 

package/src/events/event-definitions/MemoryUtilityEvents.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  *
  * @author Brad Anderson <BradA1878@pm.me>
- * @repository https://github.com/mxf-dev/mxf
+ * @repository https://github.com/BradA1878/model-exchange-framework
  * @documentation https://mxf-dev.github.io/mxf/
  */
 

package/src/events/event-definitions/MessageEvents.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  *
  * @author Brad Anderson <BradA1878@pm.me>
- * @repository https://github.com/mxf-dev/mxf
+ * @repository https://github.com/BradA1878/model-exchange-framework
  * @documentation https://mxf-dev.github.io/mxf/
  */
 

package/src/events/event-definitions/MxpEvents.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  *
  * @author Brad Anderson <BradA1878@pm.me>
- * @repository https://github.com/mxf-dev/mxf
+ * @repository https://github.com/BradA1878/model-exchange-framework
  * @documentation https://mxf-dev.github.io/mxf/
  */
 

package/src/events/event-definitions/OrparEvents.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  *
  * @author Brad Anderson <BradA1878@pm.me>
- * @repository https://github.com/mxf-dev/mxf
+ * @repository https://github.com/BradA1878/model-exchange-framework
  * @documentation https://mxf-dev.github.io/mxf/
  */
 

package/src/events/event-definitions/OrparMemoryEvents.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  *
  * @author Brad Anderson <BradA1878@pm.me>
- * @repository https://github.com/mxf-dev/mxf
+ * @repository https://github.com/BradA1878/model-exchange-framework
  * @documentation https://mxf-dev.github.io/mxf/
  */
 

package/src/events/event-definitions/PlanEvents.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  *
  * @author Brad Anderson <BradA1878@pm.me>
- * @repository https://github.com/mxf-dev/mxf
+ * @repository https://github.com/BradA1878/model-exchange-framework
  * @documentation https://mxf-dev.github.io/mxf/
  */
 

package/src/events/event-definitions/ProgressEvents.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  *
  * @author Brad Anderson <BradA1878@pm.me>
- * @repository https://github.com/mxf-dev/mxf
+ * @repository https://github.com/BradA1878/model-exchange-framework
  * @documentation https://mxf-dev.github.io/mxf/
  */
 

package/src/events/event-definitions/ShellExecutionEvents.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  *
  * @author Brad Anderson <BradA1878@pm.me>
- * @repository https://github.com/mxf-dev/mxf
+ * @repository https://github.com/BradA1878/model-exchange-framework
  * @documentation https://mxf-dev.github.io/mxf/
  */
 

package/src/events/event-definitions/SystemEvents.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  *
  * @author Brad Anderson <BradA1878@pm.me>
- * @repository https://github.com/mxf-dev/mxf
+ * @repository https://github.com/BradA1878/model-exchange-framework
  * @documentation https://mxf-dev.github.io/mxf/
  */
 

package/src/events/event-definitions/TaskEvents.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  *
  * @author Brad Anderson <BradA1878@pm.me>
- * @repository https://github.com/mxf-dev/mxf
+ * @repository https://github.com/BradA1878/model-exchange-framework
  * @documentation https://mxf-dev.github.io/mxf/
  */
 

package/src/events/event-definitions/TensorFlowEvents.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  *
  * @author Brad Anderson <BradA1878@pm.me>
- * @repository https://github.com/mxf-dev/mxf
+ * @repository https://github.com/BradA1878/model-exchange-framework
  * @documentation https://mxf-dev.github.io/mxf/
  */
 

package/src/events/event-definitions/UserInputEvents.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  *
  * @author Brad Anderson <BradA1878@pm.me>
- * @repository https://github.com/mxf-dev/mxf
+ * @repository https://github.com/BradA1878/model-exchange-framework
  * @documentation https://mxf-dev.github.io/mxf/
  */
 

package/src/events/event-definitions/WorkflowEvents.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  *
  * @author Brad Anderson <BradA1878@pm.me>
- * @repository https://github.com/mxf-dev/mxf
+ * @repository https://github.com/BradA1878/model-exchange-framework
  * @documentation https://mxf-dev.github.io/mxf/
  */
 

package/src/interfaces/AgentContext.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  *
  * @author Brad Anderson <BradA1878@pm.me>
- * @repository https://github.com/mxf-dev/mxf
+ * @repository https://github.com/BradA1878/model-exchange-framework
  * @documentation https://mxf-dev.github.io/mxf/
  */
 

package/src/interfaces/AgentInterfaces.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  *
  * @author Brad Anderson <BradA1878@pm.me>
- * @repository https://github.com/mxf-dev/mxf
+ * @repository https://github.com/BradA1878/model-exchange-framework
  * @documentation https://mxf-dev.github.io/mxf/
  */
 
@@ -28,9 +28,16 @@
 /**
  * LLM Reasoning configuration interface
  * Supports both OpenAI/ChatGPT style (effort) and Anthropic/Claude style (max_tokens)
+ *
+ * enabled has three states:
+ * - true: request reasoning (with effort or maxTokens)
+ * - false: explicitly disable reasoning — required for models that reason by
+ *   default (GLM 5.x, Qwen, DeepSeek), where omitting the parameter leaves
+ *   thinking on and it consumes the completion token budget
+ * - undefined: send nothing and use the provider's default for the model
  */
 export interface LlmReasoningConfig {
-    enabled?: boolean;                    // Enable reasoning with default "medium" effort
+    enabled?: boolean;                    // true: enable reasoning, false: explicit off-switch, undefined: provider default
     effort?: 'low' | 'medium' | 'high';  // OpenAI/ChatGPT style: effort level (20%, 50%, 80% of max_tokens)
     maxTokens?: number;                   // Anthropic/Claude style: direct token allocation for reasoning
     exclude?: boolean;                    // If true, reasoning used internally but not returned in response

package/src/interfaces/Channel.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  *
  * @author Brad Anderson <BradA1878@pm.me>
- * @repository https://github.com/mxf-dev/mxf
+ * @repository https://github.com/BradA1878/model-exchange-framework
  * @documentation https://mxf-dev.github.io/mxf/
  */
 

package/src/interfaces/ChannelConfig.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  *
  * @author Brad Anderson <BradA1878@pm.me>
- * @repository https://github.com/mxf-dev/mxf
+ * @repository https://github.com/BradA1878/model-exchange-framework
  * @documentation https://mxf-dev.github.io/mxf/
  */
 

package/src/interfaces/ChannelConnectionConfig.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  *
  * @author Brad Anderson <BradA1878@pm.me>
- * @repository https://github.com/mxf-dev/mxf
+ * @repository https://github.com/BradA1878/model-exchange-framework
  * @documentation https://mxf-dev.github.io/mxf/
  */
 

package/src/interfaces/ChannelInfo.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  *
  * @author Brad Anderson <BradA1878@pm.me>
- * @repository https://github.com/mxf-dev/mxf
+ * @repository https://github.com/BradA1878/model-exchange-framework
  * @documentation https://mxf-dev.github.io/mxf/
  */
 

package/src/interfaces/ConversationMessage.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  *
  * @author Brad Anderson <BradA1878@pm.me>
- * @repository https://github.com/mxf-dev/mxf
+ * @repository https://github.com/BradA1878/model-exchange-framework
  * @documentation https://mxf-dev.github.io/mxf/
  */
 

package/src/interfaces/ILlmTopicExtractor.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  *
  * @author Brad Anderson <BradA1878@pm.me>
- * @repository https://github.com/mxf-dev/mxf
+ * @repository https://github.com/BradA1878/model-exchange-framework
  * @documentation https://mxf-dev.github.io/mxf/
  */
 

package/src/interfaces/IMemoryPersistence.ts

@@ -0,0 +1,51 @@
+/**
+ * Memory persistence contract.
+ *
+ * MemoryService lives in @mxf-dev/core but the concrete persistence implementation
+ * lives in the server (it owns the Mongoose connection). Core must not import from
+ * src/**, so the server injects its implementation into MemoryService at boot.
+ *
+ * This interface is that injection point. It exists so the dependency is typed:
+ * MemoryService previously held the persistence service as `any`, which allowed a
+ * call to `updateAgentMemoryUtility?.()` — a method that was never implemented — to
+ * compile and then silently no-op forever, discarding every learned Q-value. Typing
+ * the contract turns that class of mistake into a compile error.
+ */
+
+import { Observable } from 'rxjs';
+import { IAgentMemory, IChannelMemory } from '../types/MemoryTypes.js';
+import { MemoryUtilitySubdocument } from '../types/MemoryUtilityTypes.js';
+
+export interface IMemoryPersistence {
+    /** Load an agent's memory document. */
+    getAgentMemory(agentId: string): Observable<IAgentMemory>;
+
+    /** Persist an agent's memory document. */
+    saveAgentMemory(memory: IAgentMemory): Observable<IAgentMemory>;
+
+    /** Persist a channel's memory document. */
+    saveChannelMemory(memory: IChannelMemory): Observable<IChannelMemory>;
+
+    /**
+     * Persist the MULS utility subdocument for a single memory.
+     *
+     * Called by QValueManager's persistence callback whenever a Q-value changes, and
+     * again when a dirty cache entry is evicted. Must throw on failure — a silent
+     * failure here means the system reports learning it did not retain.
+     */
+    updateAgentMemoryUtility(
+        memoryId: string,
+        utility: Partial<MemoryUtilitySubdocument>
+    ): Promise<void>;
+
+    /**
+     * Load utility subdocuments for a batch of memories.
+     *
+     * Used to hydrate the Q-value cache on retrieval so learning survives a restart.
+     * Memories with no stored utility are simply absent from the returned map; the
+     * caller falls back to the configured default Q-value for those.
+     */
+    getAgentMemoryUtilities(
+        memoryIds: string[]
+    ): Promise<Map<string, MemoryUtilitySubdocument>>;
+}

package/src/interfaces/SocketServiceInterface.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  *
  * @author Brad Anderson <BradA1878@pm.me>
- * @repository https://github.com/mxf-dev/mxf
+ * @repository https://github.com/BradA1878/model-exchange-framework
  * @documentation https://mxf-dev.github.io/mxf/
  */
 

package/src/interfaces/TaskInterfaces.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  *
  * @author Brad Anderson <BradA1878@pm.me>
- * @repository https://github.com/mxf-dev/mxf
+ * @repository https://github.com/BradA1878/model-exchange-framework
  * @documentation https://mxf-dev.github.io/mxf/
  */