meadow-connection-mysql 1.0.18 → 1.0.20

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 MySQL
 
+> **[Read the Meadow-Connection-Mysql Documentation](https://fable-retold.github.io/meadow-connection-mysql/)** - interactive docs with the full API reference.
+
 A MySQL connection pool provider for the Meadow ORM. Wraps [mysql2](https://github.com/sidorares/node-mysql2) as a Fable service, providing connection pooling with named placeholders, auto-connect support, and DDL generation from Meadow table schemas.
 
-[![Build Status](https://github.com/stevenvelozo/meadow-connection-mysql/workflows/Meadow-Connection-MySQL/badge.svg)](https://github.com/stevenvelozo/meadow-connection-mysql/actions)
-[![npm version](https://badge.fury.io/js/meadow-connection-mysql.svg)](https://badge.fury.io/js/meadow-connection-mysql)
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[meadow-connection-mysql on npm](https://www.npmjs.com/package/meadow-connection-mysql) | [MIT License](LICENSE)
 
 ---
 
@@ -167,13 +167,13 @@ Generate a `DROP TABLE IF EXISTS` SQL statement for the given table name.
 
 Meadow Connection MySQL 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-mssql](https://github.com/stevenvelozo/meadow-connection-mssql) -- MSSQL 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-mssql](https://github.com/fable-retold/meadow-connection-mssql) -- MSSQL 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
 
@@ -191,9 +191,9 @@ npm run coverage
 
 ## Related Packages
 
-- [meadow](https://github.com/stevenvelozo/meadow) -- Data access and ORM
-- [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-rocksdb](https://github.com/fable-retold/meadow-connection-rocksdb) -- RocksDB connection provider
+- [fable](https://github.com/fable-retold/fable) -- Application services framework
 
 ## License
 
@@ -201,4 +201,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

@@ -176,5 +176,5 @@ Meadow Connection MySQL sits between the Meadow ORM layer and the MySQL server.
 - [Architecture](architecture.md) -- Design, data flow, and component responsibilities
 - [Schema & Table Creation](schema.md) -- Generate MySQL 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-mysql",
+	"Name": "Meadow Connection Mysql",
+	"Tagline": "MySQL and MariaDB pooled 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-mysql-filled-light\">\n\t\t\t\t<path d=\"M 24 2\n\t\tH 72\n\t\tQ 94 2 94 24\n\t\tV 72\n\t\tQ 94 94 72 94\n\t\tH 24\n\t\tQ 2 94 2 72\n\t\tV 24\n\t\tQ 2 2 24 2 Z\"/>\n\t\t\t</clipPath>\n\t\t</defs>\n\t\t<path d=\"M 24 2\n\t\tH 72\n\t\tQ 94 2 94 24\n\t\tV 72\n\t\tQ 94 94 72 94\n\t\tH 24\n\t\tQ 2 94 2 72\n\t\tV 24\n\t\tQ 2 2 24 2 Z\" fill=\"#b46a2e\"/>\n\t\t<g clip-path=\"url(#frame-meadow-connection-mysql-filled-light)\"><path d=\"M 16 70 L 48 30 L 80 70 Z\" fill=\"rgba(255,255,255,0.18)\"/>\n\t\t\t\t\t<path d=\"M 24 80 L 48 52 L 72 80 Z\" fill=\"#50c7cc\" opacity=\"0.9\"/></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=\"700\"\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-mysql-light\">\n\t\t\t\t<path d=\"M 24 2\n\t\tH 72\n\t\tQ 94 2 94 24\n\t\tV 72\n\t\tQ 94 94 72 94\n\t\tH 24\n\t\tQ 2 94 2 72\n\t\tV 24\n\t\tQ 2 2 24 2 Z\"/>\n\t\t\t</clipPath>\n\t\t</defs>\n\t\t<path d=\"M 24 2\n\t\tH 72\n\t\tQ 94 2 94 24\n\t\tV 72\n\t\tQ 94 94 72 94\n\t\tH 24\n\t\tQ 2 94 2 72\n\t\tV 24\n\t\tQ 2 2 24 2 Z\" fill=\"#b46a2e\"/>\n\t\t<g clip-path=\"url(#fav-meadow-connection-mysql-light)\"><path d=\"M 16 70 L 48 30 L 80 70 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-mysql-dark\">\n\t\t\t\t<path d=\"M 24 2\n\t\tH 72\n\t\tQ 94 2 94 24\n\t\tV 72\n\t\tQ 94 94 72 94\n\t\tH 24\n\t\tQ 2 94 2 72\n\t\tV 24\n\t\tQ 2 2 24 2 Z\"/>\n\t\t\t</clipPath>\n\t\t</defs>\n\t\t<path d=\"M 24 2\n\t\tH 72\n\t\tQ 94 2 94 24\n\t\tV 72\n\t\tQ 94 94 72 94\n\t\tH 24\n\t\tQ 2 94 2 72\n\t\tV 24\n\t\tQ 2 2 24 2 Z\" fill=\"#d2996b\"/>\n\t\t<g clip-path=\"url(#fav-meadow-connection-mysql-dark)\"><path d=\"M 16 70 L 48 30 L 80 70 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": "#b46a2e",
+		"Secondary": "#50c7cc",
+		"PrimaryLight": "#b46a2e",
+		"PrimaryDark": "#d2996b",
+		"SecondaryLight": "#50c7cc",
+		"SecondaryDark": "#9bdadc"
+	}
+}

package/docs/_cover.md

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

package/docs/_sidebar.md

@@ -21,11 +21,11 @@
 
 - Retold Ecosystem
 
-  - [Meadow](/meadow/meadow/)
-  - [FoxHound](/meadow/foxhound/)
-  - [Stricture](/meadow/stricture/)
-  - [Meadow Endpoints](/meadow/meadow-endpoints/)
-  - [Meadow Connection MSSQL](/meadow/meadow-connection-mssql/)
-  - [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 MSSQL](https://fable-retold.github.io/meadow-connection-mssql/)
+  - [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-mysql)
+- [GitHub](https://github.com/fable-retold/meadow-connection-mysql)

package/docs/_version.json

@@ -1,7 +1,7 @@
 {
 	"Name": "meadow-connection-mysql",
-	"Version": "1.0.15",
+	"Version": "1.0.19",
 	"Description": "Meadow MySQL Plugin",
-	"GeneratedAt": "2026-04-10T17:20:46.154Z",
-	"GitCommit": "191dc1a"
+	"GeneratedAt": "2026-05-26T21:12:29.527Z",
+	"GitCommit": "ea910fe"
 }

package/docs/api/reference.md

@@ -6,7 +6,7 @@ Complete method and property documentation for `MeadowConnectionMySQL`.
 
 ## Class: MeadowConnectionMySQL
 
-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 libMeadowConnectionMySQL = require('meadow-connection-mysql');

package/docs/architecture.md

@@ -6,35 +6,8 @@ Meadow Connection MySQL bridges the Meadow data access layer and the MySQL datab
 
 ## System Architecture
 
-```mermaid
-graph TB
-	subgraph Application
-		A[Application Code]
-		B[Meadow ORM]
-		C[FoxHound Query DSL]
-	end
-
-	subgraph MeadowConnectionMySQL["Meadow Connection MySQL"]
-		D[MeadowConnectionMySQL Service]
-		E[Configuration Coercion]
-		F[mysql2 Connection Pool]
-	end
-
-	subgraph Database["MySQL Server"]
-		G[MySQL / MariaDB]
-	end
-
-	A -->|doCreate / doRead / doUpdate / doDelete| B
-	B -->|setProvider MySQL| C
-	C -->|SQL + Parameters| D
-	D -->|Settings| E
-	E -->|Coerced Config| F
-	F -->|TCP Connections| G
-
-	style MeadowConnectionMySQL 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-mysql/docs -->
+![System Architecture](diagrams/system-architecture.svg)
 
 ---
 
@@ -53,36 +26,8 @@ The core class, extending `FableServiceProviderBase`. It manages the lifecycle o
 
 The constructor translates between two naming conventions:
 
-```mermaid
-graph LR
-	subgraph Meadow Style
-		A1["Server"]
-		A2["Port"]
-		A3["User"]
-		A4["Password"]
-		A5["Database"]
-		A6["ConnectionPoolLimit"]
-	end
-
-	subgraph mysql2 Native
-		B1["host"]
-		B2["port"]
-		B3["user"]
-		B4["password"]
-		B5["database"]
-		B6["connectionLimit"]
-	end
-
-	A1 --> B1
-	A2 --> B2
-	A3 --> B3
-	A4 --> B4
-	A5 --> B5
-	A6 --> B6
-
-	style Meadow Style fill:#f5f0e8,stroke:#423D37
-	style mysql2 Native fill:#e8f4f8,stroke:#2E7D74
-```
+<!-- bespoke diagram: edit diagrams/configuration-coercion.mmd or .hints.json, then: npx pict-renderer-graph build modules/meadow/meadow-connection-mysql/docs -->
+![Configuration Coercion](diagrams/configuration-coercion.svg)
 
 The Meadow-style format is the standard convention used across Retold modules. The camelCase format is what mysql2 expects natively. Both are accepted -- the constructor detects which format is present and coerces as needed.
 
@@ -99,38 +44,8 @@ The underlying pool managed by [mysql2](https://github.com/sidorares/node-mysql2
 
 ## Connection Lifecycle
 
-```mermaid
-sequenceDiagram
-	participant App as Application
-	participant Fable as Fable Instance
-	participant MCS as MeadowConnectionMySQL
-	participant Pool as mysql2 Pool
-	participant MySQL as MySQL Server
-
-	App->>Fable: new libFable(config)
-	App->>Fable: addServiceType('MeadowMySQLProvider', ...)
-	App->>Fable: instantiateServiceProvider('MeadowMySQLProvider')
-	Fable->>MCS: constructor(fable, manifest, hash)
-	MCS->>MCS: Coerce config (PascalCase -> camelCase)
-	MCS->>MCS: Force namedPlaceholders = true
-
-	alt Auto-Connect Enabled
-		MCS->>MCS: connect()
-		MCS->>Pool: mysql2.createPool(settings)
-		Pool->>MySQL: Establish TCP connections
-		MCS-->>MCS: connected = true
-	end
-
-	App->>MCS: connect() or connectAsync()
-	MCS->>Pool: mysql2.createPool(settings)
-	Pool->>MySQL: Establish TCP connections
-	MCS-->>App: Pool ready (callback or sync)
-
-	App->>Pool: pool.query(sql, params, callback)
-	Pool->>MySQL: Execute query
-	MySQL-->>Pool: Result set
-	Pool-->>App: (error, rows, fields)
-```
+<!-- bespoke diagram: edit diagrams/connection-lifecycle.mmd or .hints.json, then: npx pict-renderer-graph build modules/meadow/meadow-connection-mysql/docs -->
+![Connection Lifecycle](diagrams/connection-lifecycle.svg)
 
 ---
 
@@ -142,23 +57,8 @@ Settings flow through a priority chain:
 2. **Fable settings** -- If no per-instance `MySQL` object is present, the constructor reads `fable.settings.MySQL` and builds the config from PascalCase properties.
 3. **Auto-connect flag** -- Checked in both per-instance options and Fable settings. If `MeadowConnectionMySQLAutoConnect` is true in either location, `connect()` is called during construction.
 
-```mermaid
-flowchart TD
-	A[Constructor Called] --> B{options.MySQL exists?}
-	B -->|Yes| C[Use options.MySQL directly]
-	B -->|No| D{fable.settings.MySQL exists?}
-	D -->|Yes| E[Build config from fable.settings]
-	D -->|No| F[No MySQL config available]
-	C --> G{Has PascalCase props?}
-	G -->|Yes| H[Coerce to camelCase]
-	G -->|No| I[Use as-is]
-	H --> J[Force namedPlaceholders = true]
-	I --> J
-	E --> J
-	J --> K{AutoConnect enabled?}
-	K -->|Yes| L[Call connect immediately]
-	K -->|No| M[Wait for explicit connect call]
-```
+<!-- bespoke diagram: edit diagrams/configuration-pipeline.mmd or .hints.json, then: npx pict-renderer-graph build modules/meadow/meadow-connection-mysql/docs -->
+![Configuration Pipeline](diagrams/configuration-pipeline.svg)
 
 ---
 
@@ -166,23 +66,8 @@ flowchart TD
 
 The `generateCreateTableStatement()` method walks a Meadow table schema and produces MySQL DDL:
 
-```mermaid
-flowchart LR
-	A[Meadow Table Schema] --> B[Walk Columns Array]
-	B --> C{DataType?}
-	C -->|ID| D["INT UNSIGNED NOT NULL AUTO_INCREMENT"]
-	C -->|GUID| E["CHAR(Size) DEFAULT '0xDe'"]
-	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["CHAR(Size) NOT NULL DEFAULT ''"]
-	C -->|Text| J["TEXT"]
-	C -->|DateTime| K["DATETIME"]
-	C -->|Boolean| L["TINYINT NOT NULL DEFAULT '0'"]
-	D --> M[Set PRIMARY KEY]
-	F --> M
-	M --> N["CREATE TABLE IF NOT EXISTS ... utf8mb4"]
-```
+<!-- bespoke diagram: edit diagrams/ddl-generation-flow.mmd or .hints.json, then: npx pict-renderer-graph build modules/meadow/meadow-connection-mysql/docs -->
+![DDL Generation Flow](diagrams/ddl-generation-flow.svg)
 
 The `ID` and `ForeignKey` types designate the column as the primary key. The table is always created with `DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci`.
 
@@ -194,15 +79,8 @@ The service includes guards against common connection issues:
 
 ### Double-Connect Prevention
 
-```mermaid
-flowchart TD
-	A[connect called] --> B{Pool already exists?}
-	B -->|Yes| C[Log error with cleansed settings]
-	C --> D[Skip -- no new pool created]
-	B -->|No| E[Create mysql2 pool]
-	E --> F[Set connected = true]
-	F --> G[Log connection details]
-```
+<!-- bespoke diagram: edit diagrams/double-connect-prevention.mmd or .hints.json, then: npx pict-renderer-graph build modules/meadow/meadow-connection-mysql/docs -->
+![Double-Connect Prevention](diagrams/double-connect-prevention.svg)
 
 If `connect()` is called when a pool already exists, the method logs an error with the connection settings (password masked as `*****************`) and returns without creating a second pool. This prevents connection leaks from accidental double-initialization.
 
@@ -220,26 +98,8 @@ The `connectAsync()` method wraps `connect()` in a try-catch:
 
 When a Meadow entity sets its provider to `'MySQL'`, queries follow this path:
 
-```mermaid
-sequenceDiagram
-	participant App as Application
-	participant Meadow as Meadow Entity
-	participant FH as FoxHound
-	participant Provider as Meadow-Provider-MySQL
-	participant MCS as MeadowConnectionMySQL
-	participant Pool as mysql2 Pool
-
-	App->>Meadow: doReads(query, callback)
-	Meadow->>FH: Build SQL query
-	FH-->>Meadow: SQL string + parameters
-	Meadow->>Provider: Execute read
-	Provider->>MCS: Get pool reference
-	MCS-->>Provider: mysql2 pool
-	Provider->>Pool: pool.query(sql, params)
-	Pool-->>Provider: Result rows
-	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-mysql/docs -->
+![Meadow Integration](diagrams/meadow-integration.svg)
 
 The connection pool is shared across all Meadow entities in the application. Each entity resolves the pool through the Fable service registry, so there is a single pool regardless of how many entity types are in use.