@volter/twin-standard 1.0.61 → 1.0.63

package/dist/src/create-pack.d.ts

@@ -26,7 +26,7 @@ export declare function packIndexFile(dir: string, vendor: string): string;
  *  itself: "Other wires"), or, for a unit whose spec is a proto, the gRPC seam over the schema derive-pack generated
  *  (src/generated/proto.gen.json, imported by its literal path). `--init` writes the plain one, `--index` the gRPC one once
  *  the unit's proto is derived. */
-export declare function serverFile(vendor: string, grpc: boolean): string;
+export declare function serverFile(vendor: string, grpc: boolean, wire?: boolean): string;
 /** A pack's tsconfig.json, a fixed file: what the grade's typecheck (soundness) compiles, the pack and its lanes. */
 export declare const TSCONFIG: string;
 /** The fixed files of a new pack, by path, for a vendor: what nobody should write by hand. */

package/dist/src/create-pack.js

@@ -336,10 +336,15 @@ export function packIndexFile(dir, vendor) {
  *  itself: "Other wires"), or, for a unit whose spec is a proto, the gRPC seam over the schema derive-pack generated
  *  (src/generated/proto.gen.json, imported by its literal path). `--init` writes the plain one, `--index` the gRPC one once
  *  the unit's proto is derived. */
-export function serverFile(vendor, grpc) {
+export function serverFile(vendor, grpc, wire = false) {
     const Name = pascal(vendor);
     const head = `// FETCH-FIRST (runtime contract R12b): a fixed file, the kernel's serve seam around the pack's fetch (./fetch.ts).\n`;
     const signature = `export async function create${Name}TwinServer(options: PackFetchOptions & { port?: number } = {}): Promise<{ port: number; stop: () => void }> {\n`;
+    if (grpc && wire) {
+        // a unit with a wire of its own beside its API (./stream.ts: the PlanetScale twin's MySQL protocol) serves it on a side
+        // port, `wirePort`, which the manifest's sidePorts declares
+        return `${head}import { grpc, serveStream, type PackFetchOptions } from '@volter/world-core';\nimport schema from './generated/proto.gen.json' with { type: 'json' };\nimport { create${Name}Fetch } from './fetch.ts';\nimport { create${Name}TwinStream } from './stream.ts';\n\nexport async function create${Name}TwinServer(options: PackFetchOptions & { port?: number; wirePort?: number } = {}): Promise<{ port: number; wirePort: number; stop: () => void }> {\n  const fetch = create${Name}Fetch(options);\n  // the vendor speaks gRPC (its manifest's \`grpc\`): HTTP/2 and HTTP/1 on one port, each rpc through the fetch\n  const server = await grpc.serveGrpc({ ...(options.port ? { port: options.port } : {}), fetch: async (r) => fetch(r), schema: schema as unknown as Parameters<typeof grpc.serveGrpc>[0]['schema'] });\n  // the unit's own wire beside its API, on its side port (the manifest's sidePorts: \`wirePort\`)\n  const wire = await serveStream({ port: options.wirePort ?? 0, stream: create${Name}TwinStream(options) });\n  return { port: server.port, wirePort: wire.port, stop: () => { wire.stop(); server.stop(); } };\n}\n`;
+    }
     if (grpc) {
         return `${head}import { grpc, type PackFetchOptions } from '@volter/world-core';\nimport schema from './generated/proto.gen.json' with { type: 'json' };\nimport { create${Name}Fetch } from './fetch.ts';\n\n${signature}  const fetch = create${Name}Fetch(options);\n  // the vendor speaks gRPC (its manifest's \`grpc\`): HTTP/2 and HTTP/1 on one port, each rpc through the fetch\n  return grpc.serveGrpc({ ...(options.port ? { port: options.port } : {}), fetch: async (r) => fetch(r), schema: schema as unknown as Parameters<typeof grpc.serveGrpc>[0]['schema'] });\n}\n`;
     }
@@ -541,7 +546,7 @@ export async function createPack(args) {
             // a unit whose spec is a proto (derive-pack generated its schema) is served over gRPC: its serve seam in that form,
             // the one form a unit takes after --init (a server.ts of a wire of the pack's own, SMTP's, is never written over)
             if (!lanesOnly && existsSync(join(dir, 'src', 'generated', 'proto.gen.json'))) {
-                writeFileSync(join(dir, 'src', 'server.ts'), serverFile(vendor, true));
+                writeFileSync(join(dir, 'src', 'server.ts'), serverFile(vendor, true, existsSync(join(dir, 'src', 'stream.ts'))));
                 console.log(`create-pack: wrote ${join(dir, 'src', 'server.ts')}`);
             }
         }

package/dist/src/walk/behavior-journey.js

@@ -8,7 +8,7 @@ import { attributionName } from "../verdict.js";
 // score-pack walks the life through it twice, on two fresh roots, and compares what they answer.
 //
 // The caller names the pack repository first (usePacks).
-import { redis } from '@volter/world-core';
+import { mysql, redis } from '@volter/world-core';
 import { gzipSync } from 'node:zlib';
 import { parse, visit } from 'graphql';
 import { existsSync, readdirSync, readFileSync } from 'node:fs';
@@ -16,7 +16,7 @@ import { join } from 'node:path';
 import { databaseSession, getActiveWorldStore, MemoryBlobStore, MemoryWorldStore, setActiveBlobStore, setActiveWorldStore, setDeliveryObserver, setInProcessTwins } from '@volter/world-core/runtime';
 import { createHostTable } from '@volter/world-core/host-routing';
 import packFactsDocument from '@volter/world-core/generated/pack-facts.json' with { type: 'json' };
-import { isResp, at, captureAt, echoFailures, expandFills, expectFailures, fill, fillJson, formBody, isGit, isLine, isSql, isSocket, isWait, jwtAuthorization, oauth1Authorization, presignedPath, sigv4Headers, waitMs } from "./journey-kit.js";
+import { isMysql, isResp, at, captureAt, echoFailures, expandFills, expectFailures, fill, fillJson, formBody, isGit, isLine, isSql, isSocket, isWait, jwtAuthorization, oauth1Authorization, presignedPath, sigv4Headers, waitMs } from "./journey-kit.js";
 import { lanesOf, lineShape, shapeChecker } from "./shape.js";
 import { xmlMembers } from "./xml-view.js";
 /** The pack repository the walk finds a vendor's pack in, set by the caller before its first walk. */
@@ -472,6 +472,79 @@ export async function walk(journey, root, collect, opts) {
             opts.hooks?.after?.(step, step.connection, answered, collect.slice(before));
         }
     };
+    // A MySQL step speaks the pack's MySQL wire as an application's driver does (@volter/world-core/mysql's client), on the
+    // same byte-stream adapter the owned TCP listener serves.
+    const mysqlConnections = new Map();
+    const mysqlStep = async (step) => {
+        const before = collect.length;
+        let answered = { status: 0, body: undefined };
+        const link = step.link ?? 'mysql';
+        opts.hooks?.before?.(step, link, step.mysql ?? '(sign in)');
+        try {
+            let body;
+            if (step.signIn) {
+                if (!served?.stream)
+                    streams ??= await vendorStream(packsDir(), journey.vendor);
+                const factory = served?.stream ?? streams?.(root, {});
+                if (!factory)
+                    throw new Error(`no create<Name>TwinStream adapter enrolled for ${journey.vendor}`);
+                let out = [];
+                const conn = factory({ write: (b) => { out.push(...b); }, end: () => { } }, '127.0.0.1');
+                await conn.settled();
+                const greeting = Uint8Array.from(out);
+                out = [];
+                const exchange = async (bytes) => { conn.data(bytes); await conn.settled(); const got = Uint8Array.from(out); out = []; return got; };
+                const signed = await mysql.mysqlSignIn(exchange, greeting, fill(step.signIn.user, captured), fill(step.signIn.password, captured), step.signIn.database ? fill(step.signIn.database, captured) : null);
+                if ('error' in signed)
+                    body = { ...signed.error };
+                else
+                    mysqlConnections.set(link, { exchange, close: () => conn.close() });
+            }
+            if (!body && step.mysql !== undefined) {
+                const c = mysqlConnections.get(link);
+                if (!c)
+                    throw new Error(`no MySQL connection "${link}" is open`);
+                const sql = fill(step.mysql, captured);
+                const result = step.values ? await mysql.mysqlExecute(c.exchange, sql, step.values.map((v) => (v === null ? null : fill(v, captured)))) : await mysql.mysqlQuery(c.exchange, sql);
+                body = 'error' in result ? { ...result.error }
+                    : 'columns' in result ? { columns: result.columns.map((col) => col.name), rows: result.rows.map((row) => Object.fromEntries(result.columns.map((col, i) => [col.name, row[i] ?? null]))) }
+                        : { ...result };
+            }
+            body ??= { signedIn: true };
+            const errno = typeof body.errno === 'number' ? body.errno : undefined;
+            answered = { status: errno ?? 0, body };
+            if (opts.verbose)
+                console.log(`  ${String(errno ?? 'OK').padEnd(4)} ${link.padEnd(6)} ${(step.mysql ?? '(sign in)').slice(0, 70).padEnd(70)} ${step.name}`);
+            if (step.refused !== undefined ? errno !== step.refused : errno !== undefined) {
+                collect.push({ step: step.name, beat: 'STATUS', detail: errno !== undefined ? `MySQL refused it: ${errno} ${String(body.message)}${step.refused ? ` (wanted ${step.refused})` : ''}` : `MySQL completed it, wanted ${step.refused}` });
+                return;
+            }
+            for (const [name, dot] of Object.entries(step.capture ?? {})) {
+                const value = captureAt(body, dot);
+                if (value === undefined || value === null)
+                    collect.push({ step: step.name, beat: 'CAPTURE', detail: `nothing at "${dot}" in the answer to capture as {${name}}` });
+                else
+                    remember(name, value);
+            }
+            try {
+                for (const detail of expectFailures(step.expect ?? [], body, captured))
+                    collect.push({ step: step.name, beat: 'EXPECT', detail });
+            }
+            catch (e) {
+                collect.push({ step: step.name, beat: 'CAPTURE', detail: e.message });
+            }
+            if (step.close) {
+                mysqlConnections.get(link)?.close();
+                mysqlConnections.delete(link);
+            }
+        }
+        catch (e) {
+            collect.push({ step: step.name, beat: 'MYSQL', detail: e.message });
+        }
+        finally {
+            opts.hooks?.after?.(step, link, answered, collect.slice(before));
+        }
+    };
     // A git step is a git client's clone or push on the pack's smart-HTTP plane (packages/twin-standard/src/walk/git-client.ts); its answer is
     // checked as a request's is (status, captures, expectations).
     const gitStep = async (step) => {
@@ -824,6 +897,10 @@ export async function walk(journey, root, collect, opts) {
     try {
         for (const step of journey.steps) {
             stepNow = step.name;
+            if (isMysql(step)) {
+                await mysqlStep(step);
+                continue;
+            }
             if (isResp(step)) {
                 await respStep(step);
                 continue;

package/dist/src/walk/journey-kit.d.ts

@@ -226,7 +226,29 @@ export type Journey = {
     }) => boolean;
     steps: Step[];
 };
-export type Step = JourneyStep | WaitStep | LineStep | GitStep | SocketStep | SqlStep | RespStep;
+export type Step = JourneyStep | WaitStep | LineStep | GitStep | SocketStep | SqlStep | RespStep | MysqlStep;
+/** A step on a MySQL wire (the kernel's @volter/world-core/mysql, a pack's `create<Name>TwinStream`), spoken as an
+ *  application's driver speaks it. `signIn` opens a named connection (`link`, `mysql` by default) with a user and
+ *  password (mysql_native_password); `mysql` sends a statement on it: a text query, or a prepared statement when
+ *  `values` binds its `?` placeholders (binary parameters and rows, as Prisma sends one). Its answer is the rows, each
+ *  its columns by name in MySQL's text format (`rows`, `columns`), or `{ affectedRows, insertId }`, or MySQL's refusal
+ *  `{ errno, sqlstate, message }`, which fails the step unless `refused` names its errno. */
+export type MysqlStep = {
+    name: string;
+    mysql?: string;
+    values?: Array<string | null>;
+    link?: string;
+    signIn?: {
+        user: string;
+        password: string;
+        database?: string;
+    };
+    close?: boolean;
+    refused?: number;
+    capture?: JourneyStep['capture'];
+    expect?: JourneyStep['expect'];
+};
+export declare const isMysql: (step: Step) => step is MysqlStep;
 /** A typed request/reply stream step. `resp` is one command or a pipeline of commands, on a named connection.
  * Captures and expectations see `{ replies, last, error }`; binary arguments use `{ base64 }`.
  * `read` drains pushes or a blocking command's answer without sending bytes. */

package/dist/src/walk/journey-kit.js

@@ -197,6 +197,7 @@ export function expandFills(journey) {
     });
     return steps.some((x, i) => x !== journey.steps[i]) ? { ...journey, steps } : journey;
 }
+export const isMysql = (step) => 'mysql' in step || 'signIn' in step;
 export const isResp = (step) => 'connection' in step;
 export const isLine = (step) => 'on' in step;
 export const isSocket = (step) => 'socket' in step;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@volter/twin-standard",
-  "version": "1.0.61",
+  "version": "1.0.63",
   "description": "The Protocol 3 standard for Volter twin packs: the criteria a pack is graded by, the grader, the gate a pack repository and the twin catalog run on every change and submission, and the spec derivation the grade checks against. Pin a version: every place a pack is judged judges by that standard.",
   "keywords": [
     "twin",
@@ -75,7 +75,7 @@
     "yaml": "2.9.0"
   },
   "peerDependencies": {
-    "@volter/world-core": "3.0.69",
+    "@volter/world-core": "3.0.71",
     "@volter/world-runtime": "*",
     "playwright": "^1.63.0"
   },

package/src/create-pack.ts

@@ -324,10 +324,15 @@ export function packIndexFile(dir: string, vendor: string): string {
  *  itself: "Other wires"), or, for a unit whose spec is a proto, the gRPC seam over the schema derive-pack generated
  *  (src/generated/proto.gen.json, imported by its literal path). `--init` writes the plain one, `--index` the gRPC one once
  *  the unit's proto is derived. */
-export function serverFile(vendor: string, grpc: boolean): string {
+export function serverFile(vendor: string, grpc: boolean, wire = false): string {
   const Name = pascal(vendor);
   const head = `// FETCH-FIRST (runtime contract R12b): a fixed file, the kernel's serve seam around the pack's fetch (./fetch.ts).\n`;
   const signature = `export async function create${Name}TwinServer(options: PackFetchOptions & { port?: number } = {}): Promise<{ port: number; stop: () => void }> {\n`;
+  if (grpc && wire) {
+    // a unit with a wire of its own beside its API (./stream.ts: the PlanetScale twin's MySQL protocol) serves it on a side
+    // port, `wirePort`, which the manifest's sidePorts declares
+    return `${head}import { grpc, serveStream, type PackFetchOptions } from '@volter/world-core';\nimport schema from './generated/proto.gen.json' with { type: 'json' };\nimport { create${Name}Fetch } from './fetch.ts';\nimport { create${Name}TwinStream } from './stream.ts';\n\nexport async function create${Name}TwinServer(options: PackFetchOptions & { port?: number; wirePort?: number } = {}): Promise<{ port: number; wirePort: number; stop: () => void }> {\n  const fetch = create${Name}Fetch(options);\n  // the vendor speaks gRPC (its manifest's \`grpc\`): HTTP/2 and HTTP/1 on one port, each rpc through the fetch\n  const server = await grpc.serveGrpc({ ...(options.port ? { port: options.port } : {}), fetch: async (r) => fetch(r), schema: schema as unknown as Parameters<typeof grpc.serveGrpc>[0]['schema'] });\n  // the unit's own wire beside its API, on its side port (the manifest's sidePorts: \`wirePort\`)\n  const wire = await serveStream({ port: options.wirePort ?? 0, stream: create${Name}TwinStream(options) });\n  return { port: server.port, wirePort: wire.port, stop: () => { wire.stop(); server.stop(); } };\n}\n`;
+  }
   if (grpc) {
     return `${head}import { grpc, type PackFetchOptions } from '@volter/world-core';\nimport schema from './generated/proto.gen.json' with { type: 'json' };\nimport { create${Name}Fetch } from './fetch.ts';\n\n${signature}  const fetch = create${Name}Fetch(options);\n  // the vendor speaks gRPC (its manifest's \`grpc\`): HTTP/2 and HTTP/1 on one port, each rpc through the fetch\n  return grpc.serveGrpc({ ...(options.port ? { port: options.port } : {}), fetch: async (r) => fetch(r), schema: schema as unknown as Parameters<typeof grpc.serveGrpc>[0]['schema'] });\n}\n`;
   }
@@ -499,7 +504,7 @@ export async function createPack(args: string[]): Promise<void> {
       // a unit whose spec is a proto (derive-pack generated its schema) is served over gRPC: its serve seam in that form,
       // the one form a unit takes after --init (a server.ts of a wire of the pack's own, SMTP's, is never written over)
       if (!lanesOnly && existsSync(join(dir, 'src', 'generated', 'proto.gen.json'))) {
-        writeFileSync(join(dir, 'src', 'server.ts'), serverFile(vendor, true));
+        writeFileSync(join(dir, 'src', 'server.ts'), serverFile(vendor, true, existsSync(join(dir, 'src', 'stream.ts'))));
         console.log(`create-pack: wrote ${join(dir, 'src', 'server.ts')}`);
       }
     }

package/src/walk/behavior-journey.ts

@@ -9,7 +9,7 @@ import { attributionName } from '../verdict.ts';
 //
 // The caller names the pack repository first (usePacks).
 
-import { redis } from '@volter/world-core';
+import { mysql, redis } from '@volter/world-core';
 import { gzipSync } from 'node:zlib';
 import { parse, visit } from 'graphql';
 import { existsSync, readdirSync, readFileSync } from 'node:fs';
@@ -17,7 +17,7 @@ import { join } from 'node:path';
 import { databaseSession, type DatabaseSession, getActiveWorldStore, MemoryBlobStore, MemoryWorldStore, setActiveBlobStore, setActiveWorldStore, setDeliveryObserver, setInProcessTwins, type InProcessTwin, type TwinStream, type TwinStreamConnection } from '@volter/world-core/runtime';
 import { createHostTable, type HostFacts } from '@volter/world-core/host-routing';
 import packFactsDocument from '@volter/world-core/generated/pack-facts.json' with { type: 'json' };
-import { type Captured, type GitStep, type Journey, type JourneyStep, type LineStep, type SocketStep, type SqlStep, type RespStep, isResp, at, captureAt, echoFailures, expandFills, expectFailures, fill, fillJson, formBody, isGit, isLine, isSql, isSocket, isWait, jwtAuthorization, oauth1Authorization, presignedPath, sigv4Headers, waitMs } from './journey-kit.ts';
+import { type Captured, type GitStep, type Journey, type JourneyStep, type LineStep, type SocketStep, type SqlStep, type RespStep, type MysqlStep, isMysql, isResp, at, captureAt, echoFailures, expandFills, expectFailures, fill, fillJson, formBody, isGit, isLine, isSql, isSocket, isWait, jwtAuthorization, oauth1Authorization, presignedPath, sigv4Headers, waitMs } from './journey-kit.ts';
 import { lanesOf, lineShape, shapeChecker, type LineConnection, type ShapeChecker } from './shape.ts';
 import { xmlMembers } from './xml-view.ts';
 
@@ -369,6 +369,50 @@ export async function walk(journey: Journey, root: string, collect: Failure[], o
     finally { opts.hooks?.after?.(step, step.connection, answered, collect.slice(before)); }
   };
 
+  // A MySQL step speaks the pack's MySQL wire as an application's driver does (@volter/world-core/mysql's client), on the
+  // same byte-stream adapter the owned TCP listener serves.
+  const mysqlConnections = new Map<string, { exchange: mysql.MysqlExchange; close: () => void }>();
+  const mysqlStep = async (step: MysqlStep): Promise<void> => {
+    const before = collect.length; let answered: { status: number; body: unknown } = { status: 0, body: undefined };
+    const link = step.link ?? 'mysql';
+    opts.hooks?.before?.(step as never, link, step.mysql ?? '(sign in)');
+    try {
+      let body: Record<string, unknown> | undefined;
+      if (step.signIn) {
+        if (!served?.stream) streams ??= await vendorStream(packsDir(), journey.vendor);
+        const factory = served?.stream ?? streams?.(root, {}); if (!factory) throw new Error(`no create<Name>TwinStream adapter enrolled for ${journey.vendor}`);
+        let out: number[] = [];
+        const conn = factory({ write: (b) => { out.push(...b); }, end: () => {} }, '127.0.0.1');
+        await conn.settled();
+        const greeting = Uint8Array.from(out); out = [];
+        const exchange: mysql.MysqlExchange = async (bytes) => { conn.data(bytes); await conn.settled(); const got = Uint8Array.from(out); out = []; return got; };
+        const signed = await mysql.mysqlSignIn(exchange, greeting, fill(step.signIn.user, captured), fill(step.signIn.password, captured), step.signIn.database ? fill(step.signIn.database, captured) : null);
+        if ('error' in signed) body = { ...signed.error }; else mysqlConnections.set(link, { exchange, close: () => conn.close() });
+      }
+      if (!body && step.mysql !== undefined) {
+        const c = mysqlConnections.get(link); if (!c) throw new Error(`no MySQL connection "${link}" is open`);
+        const sql = fill(step.mysql, captured);
+        const result = step.values ? await mysql.mysqlExecute(c.exchange, sql, step.values.map((v) => (v === null ? null : fill(v, captured)))) : await mysql.mysqlQuery(c.exchange, sql);
+        body = 'error' in result ? { ...result.error }
+          : 'columns' in result ? { columns: result.columns.map((col) => col.name), rows: result.rows.map((row) => Object.fromEntries(result.columns.map((col, i) => [col.name, row[i] ?? null]))) }
+          : { ...result };
+      }
+      body ??= { signedIn: true };
+      const errno = typeof body.errno === 'number' ? body.errno : undefined;
+      answered = { status: errno ?? 0, body };
+      if (opts.verbose) console.log(`  ${String(errno ?? 'OK').padEnd(4)} ${link.padEnd(6)} ${(step.mysql ?? '(sign in)').slice(0, 70).padEnd(70)} ${step.name}`);
+      if (step.refused !== undefined ? errno !== step.refused : errno !== undefined) {
+        collect.push({ step: step.name, beat: 'STATUS', detail: errno !== undefined ? `MySQL refused it: ${errno} ${String(body.message)}${step.refused ? ` (wanted ${step.refused})` : ''}` : `MySQL completed it, wanted ${step.refused}` });
+        return;
+      }
+      for (const [name, dot] of Object.entries(step.capture ?? {})) { const value = captureAt(body, dot); if (value === undefined || value === null) collect.push({ step: step.name, beat: 'CAPTURE', detail: `nothing at "${dot}" in the answer to capture as {${name}}` }); else remember(name, value); }
+      try { for (const detail of expectFailures(step.expect ?? [], body, captured)) collect.push({ step: step.name, beat: 'EXPECT', detail }); }
+      catch (e) { collect.push({ step: step.name, beat: 'CAPTURE', detail: (e as Error).message }); }
+      if (step.close) { mysqlConnections.get(link)?.close(); mysqlConnections.delete(link); }
+    } catch (e) { collect.push({ step: step.name, beat: 'MYSQL', detail: (e as Error).message }); }
+    finally { opts.hooks?.after?.(step as never, link, answered, collect.slice(before)); }
+  };
+
   // A git step is a git client's clone or push on the pack's smart-HTTP plane (packages/twin-standard/src/walk/git-client.ts); its answer is
   // checked as a request's is (status, captures, expectations).
   const gitStep = async (step: GitStep): Promise<void> => {
@@ -602,6 +646,7 @@ export async function walk(journey: Journey, root: string, collect: Failure[], o
   try {
   for (const step of journey.steps) {
     stepNow = step.name;
+    if (isMysql(step)) { await mysqlStep(step); continue; }
     if (isResp(step)) { await respStep(step); continue; }
     if (isLine(step)) { await speak(step); continue; }
     if (isGit(step)) { await gitStep(step); continue; }

package/src/walk/journey-kit.ts

@@ -327,7 +327,20 @@ export type Journey = {
   steps: Step[];
 };
 
-export type Step = JourneyStep | WaitStep | LineStep | GitStep | SocketStep | SqlStep | RespStep;
+export type Step = JourneyStep | WaitStep | LineStep | GitStep | SocketStep | SqlStep | RespStep | MysqlStep;
+
+/** A step on a MySQL wire (the kernel's @volter/world-core/mysql, a pack's `create<Name>TwinStream`), spoken as an
+ *  application's driver speaks it. `signIn` opens a named connection (`link`, `mysql` by default) with a user and
+ *  password (mysql_native_password); `mysql` sends a statement on it: a text query, or a prepared statement when
+ *  `values` binds its `?` placeholders (binary parameters and rows, as Prisma sends one). Its answer is the rows, each
+ *  its columns by name in MySQL's text format (`rows`, `columns`), or `{ affectedRows, insertId }`, or MySQL's refusal
+ *  `{ errno, sqlstate, message }`, which fails the step unless `refused` names its errno. */
+export type MysqlStep = {
+  name: string; mysql?: string; values?: Array<string | null>; link?: string;
+  signIn?: { user: string; password: string; database?: string }; close?: boolean;
+  refused?: number; capture?: JourneyStep['capture']; expect?: JourneyStep['expect'];
+};
+export const isMysql = (step: Step): step is MysqlStep => 'mysql' in step || 'signIn' in step;
 
 /** A typed request/reply stream step. `resp` is one command or a pipeline of commands, on a named connection.
  * Captures and expectations see `{ replies, last, error }`; binary arguments use `{ base64 }`.