@mastra/mssql 0.0.0-remove-unused-model-providers-api-20251030210744 → 0.0.0-remove-ai-peer-dep-from-evals-20260105220639

package/README.md

@@ -27,6 +27,7 @@ MSSQLStore supports multiple connection methods:
 import { MSSQLStore } from '@mastra/mssql';
 
 const store = new MSSQLStore({
+  id: 'mssql-storage',
   connectionString:
     'Server=localhost,1433;Database=mastra;User Id=sa;Password=yourPassword;Encrypt=true;TrustServerCertificate=true',
 });
@@ -36,6 +37,7 @@ const store = new MSSQLStore({
 
 ```typescript
 const store = new MSSQLStore({
+  id: 'mssql-storage',
   server: 'localhost',
   port: 1433,
   database: 'mastra',
@@ -49,6 +51,7 @@ const store = new MSSQLStore({
 
 ```typescript
 const store = new MSSQLStore({
+  id: 'mssql-storage',
   connectionString:
     'Server=localhost,1433;Database=mastra;User Id=sa;Password=yourPassword;Encrypt=true;TrustServerCertificate=true',
   schemaName: 'custom_schema', // Use custom schema (default: dbo)
@@ -98,11 +101,15 @@ await store.saveMessages({
 
 // Query threads and messages
 const savedThread = await store.getThreadById({ threadId: 'thread-123' });
-const messages = await store.getMessages({ threadId: 'thread-123' });
+const messages = await store.listMessages({ threadId: 'thread-123' });
 ```
 
 ## Configuration
 
+### Identifier
+
+- `id`: Unique identifier for this store instance (required)
+
 ### Connection Methods
 
 MSSQLStore supports multiple connection methods:
@@ -111,6 +118,7 @@ MSSQLStore supports multiple connection methods:
 
    ```typescript
    {
+     id: 'mssql-storage',
      connectionString: 'Server=localhost,1433;Database=mastra;User Id=sa;Password=yourPassword;Encrypt=true;TrustServerCertificate=true';
    }
    ```
@@ -118,6 +126,7 @@ MSSQLStore supports multiple connection methods:
 2. **Server/Port/Database**
    ```typescript
    {
+     id: 'mssql-storage',
      server: 'localhost',
      port: 1433,
      database: 'mastra',
@@ -161,7 +170,7 @@ MSSQLStore supports multiple connection methods:
   - Rich metadata support
   - Update working memory and metadata independently
 
-- **AI Tracing & Observability**
+- **Tracing & Observability**
   - Trace AI agent execution with spans
   - Query traces with pagination and filtering
   - Batch operations for high-volume tracing
@@ -209,14 +218,13 @@ MSSQLStore supports multiple connection methods:
 - `getThreadById({ threadId })`: Get a thread by ID
 - `updateThread({ id, title, metadata })`: Update thread title and metadata
 - `deleteThread({ threadId })`: Delete a thread and its messages
-- `getThreadsByResourceIdPaginated({ resourceId, page, perPage, orderBy?, sortDirection? })`: Get paginated threads for a resource
+- `listThreadsByResourceId({ resourceId, offset, limit, orderBy? })`: List paginated threads for a resource
 
 ### Messages
 
-- `saveMessages({ messages, format? })`: Save multiple messages with atomic transaction (supports v1 and v2 formats)
-- `getMessages({ threadId, format? })`: Get all messages for a thread
-- `getMessagesById({ messageIds, format? })`: Get messages by their IDs
-- `getMessagesPaginated({ threadId, format?, page?, perPage? })`: Get paginated messages for a thread
+- `saveMessages({ messages })`: Save multiple messages with atomic transaction
+- `listMessagesById({ messageIds })`: Get messages by their IDs
+- `listMessages({ threadId, resourceId?, page?, perPage?, orderBy?, filter? })`: Get paginated messages for a thread with filtering and sorting
 - `updateMessages({ messages })`: Update existing messages with atomic transaction
 - `deleteMessages(messageIds)`: Delete specific messages with atomic transaction
 
@@ -226,15 +234,15 @@ MSSQLStore supports multiple connection methods:
 - `getResourceById({ resourceId })`: Get a resource by ID
 - `updateResource({ resourceId, workingMemory?, metadata? })`: Update resource working memory and metadata
 
-### AI Tracing & Observability
+### Tracing & Observability
 
-- `createAISpan(span)`: Create an AI trace span
-- `updateAISpan({ spanId, traceId, updates })`: Update an existing span
-- `getAITrace(traceId)`: Get complete trace with all spans
-- `getAITracesPaginated({ filters?, pagination? })`: Query traces with pagination and filters
-- `batchCreateAISpans({ records })`: Batch create multiple spans
-- `batchUpdateAISpans({ records })`: Batch update multiple spans
-- `batchDeleteAITraces({ traceIds })`: Batch delete traces
+- `createSpan(span)`: Create a trace span
+- `updateSpan({ spanId, traceId, updates })`: Update an existing span
+- `getTrace(traceId)`: Get complete trace with all spans
+- `getTracesPaginated({ filters?, pagination? })`: Query traces with pagination and filters
+- `batchCreateSpans({ records })`: Batch create multiple spans
+- `batchUpdateSpans({ records })`: Batch update multiple spans
+- `batchDeleteTraces({ traceIds })`: Batch delete traces
 
 ### Index Management
 
@@ -256,10 +264,10 @@ MSSQLStore supports multiple connection methods:
 
 - `saveScore(score)`: Save evaluation score
 - `getScoreById({ id })`: Get score by ID
-- `getScoresByScorerId({ scorerId, pagination, entityId?, entityType?, source? })`: Get scores by scorer
-- `getScoresByRunId({ runId, pagination })`: Get scores for a run
-- `getScoresByEntityId({ entityId, entityType, pagination })`: Get scores for an entity
-- `getScoresBySpan({ traceId, spanId, pagination })`: Get scores for a trace span
+- `listScoresByScorerId({ scorerId, pagination, entityId?, entityType?, source? })`: Get scores by scorer
+- `listScoresByRunId({ runId, pagination })`: Get scores for a run
+- `listScoresByEntityId({ entityId, entityType, pagination })`: Get scores for an entity
+- `listScoresBySpan({ traceId, spanId, pagination })`: Get scores for a trace span
 
 ### Traces (Legacy)
 

package/dist/docs/README.md

@@ -0,0 +1,31 @@
+# @mastra/mssql Documentation
+
+> Embedded documentation for coding agents
+
+## Quick Start
+
+```bash
+# Read the skill overview
+cat docs/SKILL.md
+
+# Get the source map
+cat docs/SOURCE_MAP.json
+
+# Read topic documentation
+cat docs/<topic>/01-overview.md
+```
+
+## Structure
+
+```
+docs/
+├── SKILL.md           # Entry point
+├── README.md          # This file
+├── SOURCE_MAP.json    # Export index
+├── storage/ (1 files)
+```
+
+## Version
+
+Package: @mastra/mssql
+Version: 1.0.0-beta.9

package/dist/docs/SKILL.md

@@ -0,0 +1,32 @@
+---
+name: mastra-mssql-docs
+description: Documentation for @mastra/mssql. Includes links to type definitions and readable implementation code in dist/.
+---
+
+# @mastra/mssql Documentation
+
+> **Version**: 1.0.0-beta.9
+> **Package**: @mastra/mssql
+
+## Quick Navigation
+
+Use SOURCE_MAP.json to find any export:
+
+```bash
+cat docs/SOURCE_MAP.json
+```
+
+Each export maps to:
+- **types**: `.d.ts` file with JSDoc and API signatures
+- **implementation**: `.js` chunk file with readable source
+- **docs**: Conceptual documentation in `docs/`
+
+## Top Exports
+
+
+
+See SOURCE_MAP.json for the complete list.
+
+## Available Topics
+
+- [Storage](storage/) - 1 file(s)

package/dist/docs/SOURCE_MAP.json

@@ -0,0 +1,6 @@
+{
+  "version": "1.0.0-beta.9",
+  "package": "@mastra/mssql",
+  "exports": {},
+  "modules": {}
+}

package/dist/docs/storage/01-reference.md

@@ -0,0 +1,141 @@
+# Storage API Reference
+
+> API reference for storage - 1 entries
+
+
+---
+
+## Reference: MSSQL Storage
+
+> Documentation for the MSSQL storage implementation in Mastra.
+
+The MSSQL storage implementation provides a production-ready storage solution using Microsoft SQL Server databases.
+
+## Installation
+
+```bash
+npm install @mastra/mssql@beta
+```
+
+## Usage
+
+```typescript
+import { MSSQLStore } from "@mastra/mssql";
+
+const storage = new MSSQLStore({
+  id: 'mssql-storage',
+  connectionString: process.env.DATABASE_URL,
+});
+```
+
+## Parameters
+
+## Constructor Examples
+
+You can instantiate `MSSQLStore` in the following ways:
+
+```ts
+import { MSSQLStore } from "@mastra/mssql";
+
+// Using a connection string only
+const store1 = new MSSQLStore({
+  id: 'mssql-storage-1',
+  connectionString: "Server=localhost,1433;Database=mydb;User Id=sa;Password=password;Encrypt=true;TrustServerCertificate=true",
+});
+
+// Using a connection string with a custom schema name
+const store2 = new MSSQLStore({
+  id: 'mssql-storage-2',
+  connectionString: "Server=localhost,1433;Database=mydb;User Id=sa;Password=password;Encrypt=true;TrustServerCertificate=true",
+  schemaName: "custom_schema", // optional
+});
+
+// Using individual connection parameters
+const store4 = new MSSQLStore({
+  id: 'mssql-storage-3',
+  server: "localhost",
+  port: 1433,
+  database: "mydb",
+  user: "user",
+  password: "password",
+});
+
+// Individual parameters with schemaName
+const store5 = new MSSQLStore({
+  id: 'mssql-storage-4',
+  server: "localhost",
+  port: 1433,
+  database: "mydb",
+  user: "user",
+  password: "password",
+  schemaName: "custom_schema", // optional
+});
+```
+
+## Additional Notes
+
+### Schema Management
+
+The storage implementation handles schema creation and updates automatically. It creates the following tables:
+
+- `mastra_workflow_snapshot`: Stores workflow state and execution data
+- `mastra_evals`: Stores evaluation results and metadata
+- `mastra_threads`: Stores conversation threads
+- `mastra_messages`: Stores individual messages
+- `mastra_traces`: Stores telemetry and tracing data
+- `mastra_scorers`: Stores scoring and evaluation data
+- `mastra_resources`: Stores resource working memory data
+
+### Initialization
+
+When you pass storage to the Mastra class, `init()` is called automatically before any storage operation:
+
+```typescript
+import { Mastra } from "@mastra/core";
+import { MSSQLStore } from "@mastra/mssql";
+
+const storage = new MSSQLStore({
+  connectionString: process.env.DATABASE_URL,
+});
+
+const mastra = new Mastra({
+  storage, // init() is called automatically
+});
+```
+
+If you're using storage directly without Mastra, you must call `init()` explicitly to create the tables:
+
+```typescript
+import { MSSQLStore } from "@mastra/mssql";
+
+const storage = new MSSQLStore({
+  id: 'mssql-storage',
+  connectionString: process.env.DATABASE_URL,
+});
+
+// Required when using storage directly
+await storage.init();
+
+// Access domain-specific stores via getStore()
+const memoryStore = await storage.getStore('memory');
+const thread = await memoryStore?.getThreadById({ threadId: "..." });
+```
+
+> **Note:**
+If `init()` is not called, tables won't be created and storage operations will fail silently or throw errors.
+
+### Direct Database and Pool Access
+
+`MSSQLStore` exposes the mssql connection pool as public fields:
+
+```typescript
+store.pool; // mssql connection pool instance
+```
+
+This enables direct queries and custom transaction management. When using these fields:
+
+- You are responsible for proper connection and transaction handling.
+- Closing the store (`store.close()`) will destroy the associated connection pool.
+- Direct access bypasses any additional logic or validation provided by MSSQLStore methods.
+
+This approach is intended for advanced scenarios where low-level access is required.