meadow-connection-mssql 1.0.23 → 1.0.24

package/CONTRIBUTING.md

@@ -47,4 +47,4 @@ When in doubt, match what the surrounding code does.
 
 ## Repository Structure
 
-Each module is its own git repository. The [retold](https://github.com/stevenvelozo/retold) repository tracks module organization but does not contain module source code. Direct your pull request to the specific module repository where your change belongs.
+Each module is its own git repository. The [retold](https://github.com/fable-retold/retold) repository tracks module organization but does not contain module source code. Direct your pull request to the specific module repository where your change belongs.

package/README.md

@@ -1,10 +1,10 @@
 # Meadow Connection MSSQL
 
+> **[Read the Meadow-Connection-Mssql Documentation](https://fable-retold.github.io/meadow-connection-mssql/)** - interactive docs with the full API reference.
+
 A Microsoft SQL Server connection provider for the Meadow ORM. Wraps [mssql](https://github.com/tediousjs/node-mssql) (Tedious) as a Fable service, providing connection pooling with configurable timeouts, prepared statements, and DDL generation from Meadow table schemas.
 
-[![Build Status](https://github.com/stevenvelozo/meadow-connection-mssql/workflows/Meadow-Connection-MSSQL/badge.svg)](https://github.com/stevenvelozo/meadow-connection-mssql/actions)
-[![npm version](https://badge.fury.io/js/meadow-connection-mssql.svg)](https://badge.fury.io/js/meadow-connection-mssql)
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[meadow-connection-mssql on npm](https://www.npmjs.com/package/meadow-connection-mssql) | [MIT License](LICENSE)
 
 ---
 
@@ -172,13 +172,13 @@ Generate a safe `DROP TABLE` statement using `IF OBJECT_ID` to check existence b
 
 Meadow Connection MSSQL is a database connector for the Meadow data access layer:
 
-- [meadow](https://github.com/stevenvelozo/meadow) -- ORM and data access framework
-- [foxhound](https://github.com/stevenvelozo/foxhound) -- Query DSL used by Meadow
-- [stricture](https://github.com/stevenvelozo/stricture) -- Schema definition tool
-- [meadow-endpoints](https://github.com/stevenvelozo/meadow-endpoints) -- RESTful endpoint generation
-- [meadow-connection-mysql](https://github.com/stevenvelozo/meadow-connection-mysql) -- MySQL connector
-- [meadow-connection-sqlite](https://github.com/stevenvelozo/meadow-connection-sqlite) -- SQLite connector
-- [fable](https://github.com/stevenvelozo/fable) -- Application services framework
+- [meadow](https://github.com/fable-retold/meadow) -- ORM and data access framework
+- [foxhound](https://github.com/fable-retold/foxhound) -- Query DSL used by Meadow
+- [stricture](https://github.com/fable-retold/stricture) -- Schema definition tool
+- [meadow-endpoints](https://github.com/fable-retold/meadow-endpoints) -- RESTful endpoint generation
+- [meadow-connection-mysql](https://github.com/fable-retold/meadow-connection-mysql) -- MySQL connector
+- [meadow-connection-sqlite](https://github.com/fable-retold/meadow-connection-sqlite) -- SQLite connector
+- [fable](https://github.com/fable-retold/fable) -- Application services framework
 
 ## Testing
 
@@ -196,10 +196,10 @@ npm run coverage
 
 ## Related Packages
 
-- [meadow](https://github.com/stevenvelozo/meadow) -- Data access and ORM
-- [meadow-connection-mysql](https://github.com/stevenvelozo/meadow-connection-mysql) -- MySQL connection provider
-- [meadow-connection-rocksdb](https://github.com/stevenvelozo/meadow-connection-rocksdb) -- RocksDB connection provider
-- [fable](https://github.com/stevenvelozo/fable) -- Application services framework
+- [meadow](https://github.com/fable-retold/meadow) -- Data access and ORM
+- [meadow-connection-mysql](https://github.com/fable-retold/meadow-connection-mysql) -- MySQL connection provider
+- [meadow-connection-rocksdb](https://github.com/fable-retold/meadow-connection-rocksdb) -- RocksDB connection provider
+- [fable](https://github.com/fable-retold/fable) -- Application services framework
 
 ## License
 
@@ -207,4 +207,4 @@ MIT
 
 ## Contributing
 
-Pull requests are welcome. For details on our code of conduct, contribution process, and testing requirements, see the [Retold Contributing Guide](https://github.com/stevenvelozo/retold/blob/main/docs/contributing.md).
+Pull requests are welcome. For details on our code of conduct, contribution process, and testing requirements, see the [Retold Contributing Guide](https://github.com/fable-retold/retold/blob/main/docs/contributing.md).

package/docs/README.md

@@ -155,5 +155,5 @@ Meadow Connection MSSQL sits between the Meadow ORM layer and the SQL Server. It
 - [Architecture](architecture.md) -- Design, data flow, and component responsibilities
 - [Schema & Table Creation](schema.md) -- Generate MSSQL tables from Meadow schemas
 - [API Reference](api/reference.md) -- Complete method and property documentation
-- [Meadow](/meadow/meadow/) -- The data access layer
-- [FoxHound](/meadow/foxhound/) -- Query DSL used by Meadow
+- [Meadow](https://fable-retold.github.io/meadow/) -- The data access layer
+- [FoxHound](https://fable-retold.github.io/foxhound/) -- Query DSL used by Meadow

package/docs/_brand.json

@@ -0,0 +1,18 @@
+{
+	"Hash": "meadow-connection-mssql",
+	"Name": "Meadow Connection Mssql",
+	"Tagline": "Microsoft SQL Server connection provider for Meadow",
+	"Palette": "mix",
+	"Icon": "<svg xmlns=\"http://www.w3.org/2000/svg\" viewBox=\"0 0 96 96\" width=\"96\" height=\"96\">\n\t\t<defs>\n\t\t\t<clipPath id=\"frame-meadow-connection-mssql-filled-light\">\n\t\t\t\t<path d=\"M 2 48\n\t\t\tC 2 18.0222416, 18.0222416 2, 48 2\n\t\t\tC 77.9777584 2, 94 18.0222416, 94 48\n\t\t\tC 94 77.9777584, 77.9777584 94, 48 94\n\t\t\tC 18.0222416 94, 2 77.9777584, 2 48 Z\"/>\n\t\t\t</clipPath>\n\t\t</defs>\n\t\t<path d=\"M 2 48\n\t\t\tC 2 18.0222416, 18.0222416 2, 48 2\n\t\t\tC 77.9777584 2, 94 18.0222416, 94 48\n\t\t\tC 94 77.9777584, 77.9777584 94, 48 94\n\t\t\tC 18.0222416 94, 2 77.9777584, 2 48 Z\" fill=\"#283bde\"/>\n\t\t<g clip-path=\"url(#frame-meadow-connection-mssql-filled-light)\"><path d=\"M 48.00,12.00 L 79.18,30.00 L 79.18,66.00 L 48.00,84.00 L 16.82,66.00 L 16.82,30.00 Z\" fill=\"rgba(255,255,255,0.18)\"/>\n\t\t\t\t\t<circle cx=\"48\" cy=\"48\" r=\"24\" fill=\"#e87e37\"/></g>\n\t\t<text x=\"48\" y=\"50\" text-anchor=\"middle\" dominant-baseline=\"central\"\n\t\t\tfont-family=\"-apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, sans-serif\"\n\t\t\tfont-size=\"28\" font-weight=\"600\"\n\t\t\tfill=\"#ffffff\" letter-spacing=\"-1\">MCM</text>\n\t</svg>",
+	"IconType": "svg",
+	"Favicon": "<svg xmlns=\"http://www.w3.org/2000/svg\" viewBox=\"0 0 96 96\" width=\"96\" height=\"96\">\n\t\t<defs>\n\t\t\t<clipPath id=\"fav-meadow-connection-mssql-light\">\n\t\t\t\t<path d=\"M 2 48\n\t\t\tC 2 18.0222416, 18.0222416 2, 48 2\n\t\t\tC 77.9777584 2, 94 18.0222416, 94 48\n\t\t\tC 94 77.9777584, 77.9777584 94, 48 94\n\t\t\tC 18.0222416 94, 2 77.9777584, 2 48 Z\"/>\n\t\t\t</clipPath>\n\t\t</defs>\n\t\t<path d=\"M 2 48\n\t\t\tC 2 18.0222416, 18.0222416 2, 48 2\n\t\t\tC 77.9777584 2, 94 18.0222416, 94 48\n\t\t\tC 94 77.9777584, 77.9777584 94, 48 94\n\t\t\tC 18.0222416 94, 2 77.9777584, 2 48 Z\" fill=\"#283bde\"/>\n\t\t<g clip-path=\"url(#fav-meadow-connection-mssql-light)\"><path d=\"M 48.00,12.00 L 79.18,30.00 L 79.18,66.00 L 48.00,84.00 L 16.82,66.00 L 16.82,30.00 Z\" fill=\"rgba(255,255,255,0.22)\"/></g>\n\t\t<text x=\"48\" y=\"50\" text-anchor=\"middle\" dominant-baseline=\"central\"\n\t\t\tfont-family=\"-apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, sans-serif\"\n\t\t\tfont-size=\"60\" font-weight=\"800\"\n\t\t\tfill=\"#ffffff\" letter-spacing=\"-1\">M</text>\n\t</svg>",
+	"FaviconDark": "<svg xmlns=\"http://www.w3.org/2000/svg\" viewBox=\"0 0 96 96\" width=\"96\" height=\"96\">\n\t\t<defs>\n\t\t\t<clipPath id=\"fav-meadow-connection-mssql-dark\">\n\t\t\t\t<path d=\"M 2 48\n\t\t\tC 2 18.0222416, 18.0222416 2, 48 2\n\t\t\tC 77.9777584 2, 94 18.0222416, 94 48\n\t\t\tC 94 77.9777584, 77.9777584 94, 48 94\n\t\t\tC 18.0222416 94, 2 77.9777584, 2 48 Z\"/>\n\t\t\t</clipPath>\n\t\t</defs>\n\t\t<path d=\"M 2 48\n\t\t\tC 2 18.0222416, 18.0222416 2, 48 2\n\t\t\tC 77.9777584 2, 94 18.0222416, 94 48\n\t\t\tC 94 77.9777584, 77.9777584 94, 48 94\n\t\t\tC 18.0222416 94, 2 77.9777584, 2 48 Z\" fill=\"#7d88e6\"/>\n\t\t<g clip-path=\"url(#fav-meadow-connection-mssql-dark)\"><path d=\"M 48.00,12.00 L 79.18,30.00 L 79.18,66.00 L 48.00,84.00 L 16.82,66.00 L 16.82,30.00 Z\" fill=\"rgba(255,255,255,0.22)\"/></g>\n\t\t<text x=\"48\" y=\"50\" text-anchor=\"middle\" dominant-baseline=\"central\"\n\t\t\tfont-family=\"-apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, sans-serif\"\n\t\t\tfont-size=\"60\" font-weight=\"800\"\n\t\t\tfill=\"#101418\" letter-spacing=\"-1\">M</text>\n\t</svg>",
+	"Colors": {
+		"Primary": "#283bde",
+		"Secondary": "#e87e37",
+		"PrimaryLight": "#283bde",
+		"PrimaryDark": "#7d88e6",
+		"SecondaryLight": "#e87e37",
+		"SecondaryDark": "#eeb48e"
+	}
+}

package/docs/_cover.md

@@ -16,4 +16,4 @@ A wrapper around the [mssql](https://github.com/tediousjs/node-mssql) npm packag
 [Architecture](architecture.md)
 [Schema & Tables](schema.md)
 [API Reference](api/reference.md)
-[GitHub](https://github.com/stevenvelozo/meadow-connection-mssql)
+[GitHub](https://github.com/fable-retold/meadow-connection-mssql)

package/docs/_sidebar.md

@@ -23,11 +23,11 @@
 
 - Retold Ecosystem
 
-  - [Meadow](/meadow/meadow/)
-  - [FoxHound](/meadow/foxhound/)
-  - [Stricture](/meadow/stricture/)
-  - [Meadow Endpoints](/meadow/meadow-endpoints/)
-  - [Meadow Connection MySQL](/meadow/meadow-connection-mysql/)
-  - [Meadow Connection SQLite](/meadow/meadow-connection-sqlite/)
-  - [Meadow Connection RocksDB](/meadow/meadow-connection-rocksdb/)
-  - [Fable](/fable/fable/)
+  - [Meadow](https://fable-retold.github.io/meadow/)
+  - [FoxHound](https://fable-retold.github.io/foxhound/)
+  - [Stricture](https://fable-retold.github.io/stricture/)
+  - [Meadow Endpoints](https://fable-retold.github.io/meadow-endpoints/)
+  - [Meadow Connection MySQL](https://fable-retold.github.io/meadow-connection-mysql/)
+  - [Meadow Connection SQLite](https://fable-retold.github.io/meadow-connection-sqlite/)
+  - [Meadow Connection RocksDB](https://fable-retold.github.io/meadow-connection-rocksdb/)
+  - [Fable](https://fable-retold.github.io/fable/)

package/docs/_topbar.md

@@ -5,4 +5,4 @@
 - [Architecture](architecture.md)
 - [Schema & Tables](schema.md)
 - [API Reference](api/reference.md)
-- [GitHub](https://github.com/stevenvelozo/meadow-connection-mssql)
+- [GitHub](https://github.com/fable-retold/meadow-connection-mssql)

package/docs/_version.json

@@ -1,7 +1,7 @@
 {
 	"Name": "meadow-connection-mssql",
-	"Version": "1.0.16",
+	"Version": "1.0.23",
 	"Description": "Meadow MSSQL Plugin",
-	"GeneratedAt": "2026-04-10T17:20:38.742Z",
-	"GitCommit": "5443f5e"
+	"GeneratedAt": "2026-05-26T21:12:28.990Z",
+	"GitCommit": "52c4490"
 }

package/docs/api/reference.md

@@ -6,7 +6,7 @@ Complete method and property documentation for `MeadowConnectionMSSQL`.
 
 ## Class: MeadowConnectionMSSQL
 
-Extends `FableServiceProviderBase` from [fable-serviceproviderbase](https://github.com/stevenvelozo/fable-serviceproviderbase).
+Extends `FableServiceProviderBase` from [fable-serviceproviderbase](https://fable-retold.github.io/fable-serviceproviderbase/).
 
 ```javascript
 const libMeadowConnectionMSSQL = require('meadow-connection-mssql');

package/docs/architecture.md

@@ -6,39 +6,8 @@ Meadow Connection MSSQL bridges the Meadow data access layer and Microsoft SQL S
 
 ## System Architecture
 
-```mermaid
-graph TB
-	subgraph Application
-		A[Application Code]
-		B[Meadow ORM]
-		C[FoxHound Query DSL]
-	end
-
-	subgraph MeadowConnectionMSSQL["Meadow Connection MSSQL"]
-		D[MeadowConnectionMSSQL Service]
-		E[PreparedStatement Factory]
-		F[MSSQL Type Constants]
-		G[mssql Connection Pool]
-	end
-
-	subgraph Database["SQL Server"]
-		H[Microsoft SQL Server]
-	end
-
-	A -->|doCreate / doRead / doUpdate / doDelete| B
-	B -->|setProvider MSSQL| C
-	C -->|SQL + Parameters| D
-	D -->|Prepared Statements| E
-	D -->|Type Definitions| F
-	E --> G
-	F --> G
-	D --> G
-	G -->|TDS Protocol| H
-
-	style MeadowConnectionMSSQL fill:#e8f4f8,stroke:#2E7D74,stroke-width:2px
-	style Application fill:#f5f0e8,stroke:#423D37,stroke-width:1px
-	style Database fill:#fef3e2,stroke:#c97a2e,stroke-width:1px
-```
+<!-- bespoke diagram: edit diagrams/system-architecture.mmd or .hints.json, then: npx pict-renderer-graph build modules/meadow/meadow-connection-mssql/docs -->
+![System Architecture](diagrams/system-architecture.svg)
 
 ---
 
@@ -72,36 +41,8 @@ The `MSSQL` getter exposes the raw `mssql` npm package, giving access to SQL Ser
 
 ## Connection Lifecycle
 
-```mermaid
-sequenceDiagram
-	participant App as Application
-	participant Fable as Fable Instance
-	participant MCS as MeadowConnectionMSSQL
-	participant Pool as mssql Pool
-	participant SQL as SQL Server
-
-	App->>Fable: new libFable(config)
-	App->>Fable: addServiceType('MeadowMSSQLProvider', ...)
-	App->>Fable: instantiateServiceProvider('MeadowMSSQLProvider')
-	Fable->>MCS: constructor(fable, manifest, hash)
-	MCS->>MCS: Copy MSSQL settings from fable.settings
-	MCS->>MCS: Default port to 1433
-	MCS-->>MCS: connected = false
-
-	App->>MCS: connectAsync(callback)
-	MCS->>Pool: mssql.connect(settings)
-	Note over Pool,SQL: Promise-based TDS handshake
-	Pool->>SQL: Establish TCP + TDS connection
-	SQL-->>Pool: Connected
-	Pool-->>MCS: Connection pool ready
-	MCS-->>MCS: connected = true
-	MCS-->>App: callback(null, pool)
-
-	App->>Pool: pool.query(sql)
-	Pool->>SQL: Execute query (TDS)
-	SQL-->>Pool: Result set
-	Pool-->>App: Promise resolves with { recordset }
-```
+<!-- bespoke diagram: edit diagrams/connection-lifecycle.mmd or .hints.json, then: npx pict-renderer-graph build modules/meadow/meadow-connection-mssql/docs -->
+![Connection Lifecycle](diagrams/connection-lifecycle.svg)
 
 ---
 
@@ -109,25 +50,8 @@ sequenceDiagram
 
 MSSQL supports two distinct query patterns:
 
-```mermaid
-flowchart LR
-	subgraph Direct["Direct Query (pool.query)"]
-		A1[SQL String] --> B1[pool.query]
-		B1 --> C1[Promise]
-		C1 --> D1[result.recordset]
-	end
-
-	subgraph Prepared["Prepared Statement"]
-		A2[SQL Template] --> B2[ps.prepare]
-		B2 --> C2[ps.input types]
-		C2 --> D2[ps.execute params]
-		D2 --> E2[result.recordset]
-		E2 --> F2[ps.unprepare]
-	end
-
-	style Direct fill:#e8f4f8,stroke:#2E7D74
-	style Prepared fill:#f5f0e8,stroke:#423D37
-```
+<!-- bespoke diagram: edit diagrams/query-execution-models.mmd or .hints.json, then: npx pict-renderer-graph build modules/meadow/meadow-connection-mssql/docs -->
+![Query Execution Models](diagrams/query-execution-models.svg)
 
 ### Direct Query
 
@@ -158,25 +82,8 @@ Meadow's MSSQL provider uses prepared statements for all CRUD operations.
 
 ## Connection Settings Flow
 
-```mermaid
-flowchart TD
-	A[Constructor Called] --> B{fable.settings.MSSQL exists?}
-	B -->|Yes| C[Copy server, port, user, password, database]
-	B -->|No| D[No MSSQL config available]
-	C --> E{port provided?}
-	E -->|Yes| F[Use provided port]
-	E -->|No| G[Default to 1433]
-	F --> H[Store in this.options]
-	G --> H
-
-	H --> I[connectAsync called]
-	I --> J[Build connection settings]
-	J --> K[Add hardcoded pool/timeout settings]
-	K --> L[mssql.connect with Promise]
-	L --> M{Connection success?}
-	M -->|Yes| N[Set connected = true]
-	M -->|No| O[Pass error to callback]
-```
+<!-- bespoke diagram: edit diagrams/connection-settings-flow.mmd or .hints.json, then: npx pict-renderer-graph build modules/meadow/meadow-connection-mssql/docs -->
+![Connection Settings Flow](diagrams/connection-settings-flow.svg)
 
 ### Hardcoded Pool Settings
 
@@ -198,29 +105,8 @@ These settings are applied internally and are not currently configurable via Fab
 
 The `generateCreateTableStatement()` method walks a Meadow table schema and produces MSSQL DDL:
 
-```mermaid
-flowchart LR
-	A[Meadow Table Schema] --> B[Walk Columns Array]
-	B --> C{DataType?}
-	C -->|ID| D["INT NOT NULL IDENTITY PRIMARY KEY"]
-	C -->|GUID| E["VARCHAR(254) DEFAULT '000...'"]
-	C -->|ForeignKey| F["INT UNSIGNED NOT NULL DEFAULT 0"]
-	C -->|Numeric| G["INT NOT NULL DEFAULT 0"]
-	C -->|Decimal| H["DECIMAL(Size)"]
-	C -->|String| I["VARCHAR(Size) DEFAULT ''"]
-	C -->|Text| J["TEXT"]
-	C -->|DateTime| K["DATETIME"]
-	C -->|Boolean| L["TINYINT DEFAULT 0"]
-	D --> M["CREATE TABLE [dbo].[TableName] (...)"]
-	E --> M
-	F --> M
-	G --> M
-	H --> M
-	I --> M
-	J --> M
-	K --> M
-	L --> M
-```
+<!-- bespoke diagram: edit diagrams/ddl-generation-flow.mmd or .hints.json, then: npx pict-renderer-graph build modules/meadow/meadow-connection-mssql/docs -->
+![DDL Generation Flow](diagrams/ddl-generation-flow.svg)
 
 ### MSSQL DDL Conventions
 
@@ -235,22 +121,8 @@ flowchart LR
 
 ## Connection Safety
 
-```mermaid
-flowchart TD
-	A[connectAsync called] --> B{Callback provided?}
-	B -->|No| C[Log error, create no-op callback]
-	B -->|Yes| D{Pool already exists?}
-	C --> D
-	D -->|Yes| E[Log error with cleansed settings]
-	E --> F[Return existing pool via callback]
-	D -->|No| G[Log connection details]
-	G --> H[mssql.connect with Promise]
-	H --> I{Success?}
-	I -->|Yes| J[Set pool and connected = true]
-	J --> K[Return pool via callback]
-	I -->|No| L[Log error]
-	L --> M[Return error via callback]
-```
+<!-- bespoke diagram: edit diagrams/connection-safety.mmd or .hints.json, then: npx pict-renderer-graph build modules/meadow/meadow-connection-mssql/docs -->
+![Connection Safety](diagrams/connection-safety.svg)
 
 ### Password Protection
 
@@ -264,33 +136,8 @@ flowchart TD
 
 When a Meadow entity sets its provider to `'MSSQL'`, queries follow this path:
 
-```mermaid
-sequenceDiagram
-	participant App as Application
-	participant Meadow as Meadow Entity
-	participant FH as FoxHound
-	participant Provider as Meadow-Provider-MSSQL
-	participant MCS as MeadowConnectionMSSQL
-	participant PS as PreparedStatement
-	participant Pool as mssql Pool
-
-	App->>Meadow: doReads(query, callback)
-	Meadow->>FH: Build SQL query
-	FH-->>Meadow: SQL string + parameters
-	Meadow->>Provider: Execute read
-	Provider->>MCS: Get preparedStatement
-	MCS-->>Provider: New mssql.PreparedStatement
-	Provider->>PS: input(name, type) for each param
-	Provider->>PS: prepare(sql)
-	PS->>Pool: Prepare on pool
-	Provider->>PS: execute(params)
-	PS->>Pool: Execute prepared query
-	Pool-->>PS: Result recordset
-	PS-->>Provider: result.recordset
-	Provider->>PS: unprepare()
-	Provider-->>Meadow: Marshalled records
-	Meadow-->>App: callback(error, query, records)
-```
+<!-- bespoke diagram: edit diagrams/meadow-integration.mmd or .hints.json, then: npx pict-renderer-graph build modules/meadow/meadow-connection-mssql/docs -->
+![Meadow Integration](diagrams/meadow-integration.svg)
 
 The MSSQL provider uses prepared statements for all operations, with `SCOPE_IDENTITY()` for retrieving auto-generated IDs after inserts.