@jskit-ai/database-runtime-mysql 0.1.4

package/package.descriptor.mjs

@@ -0,0 +1,160 @@
+export default Object.freeze({
+  packageVersion: 1,
+  packageId: "@jskit-ai/database-runtime-mysql",
+  version: "0.1.4",
+  options: {
+    "db-host": {
+      required: false,
+      values: [],
+      defaultValue: "localhost",
+      promptLabel: "Database host",
+      promptHint: "MySQL host (for example 127.0.0.1)"
+    },
+    "db-port": {
+      required: false,
+      values: [],
+      defaultValue: "3306",
+      promptLabel: "Database port",
+      promptHint: "MySQL port (usually 3306)"
+    },
+    "db-name": {
+      required: true,
+      values: [],
+      promptLabel: "Database name",
+      promptHint: "Schema/database name to connect to"
+    },
+    "db-user": {
+      required: true,
+      values: [],
+      promptLabel: "Database user",
+      promptHint: "Database username"
+    },
+    "db-password": {
+      required: true,
+      values: [],
+      inputType: "password",
+      promptLabel: "Database password",
+      promptHint: "Database password"
+    }
+  },
+  dependsOn: [
+    "@jskit-ai/database-runtime"
+  ],
+  capabilities: {
+    provides: [
+      "runtime.database.driver",
+      "runtime.database.driver.mysql"
+    ],
+    requires: [
+      "runtime.database"
+    ]
+  },
+  runtime: {
+    server: {
+      providerEntrypoint: "src/server/providers/DatabaseRuntimeMysqlServiceProvider.js",
+      providers: [
+        {
+          entrypoint: "src/server/providers/DatabaseRuntimeMysqlServiceProvider.js",
+          export: "DatabaseRuntimeMysqlServiceProvider"
+        }
+      ]
+    },
+    client: {
+      providers: []
+    }
+  },
+  metadata: {
+    apiSummary: {
+      surfaces: [
+        {
+          subpath: "./server",
+          summary: "Exports MySQL database runtime provider."
+        },
+        {
+          subpath: "./shared",
+          summary: "Exports MySQL dialect metadata helpers."
+        },
+        {
+          subpath: "./client",
+          summary: "Exports no runtime API today (reserved client entrypoint)."
+        }
+      ],
+      containerTokens: {
+        server: [
+          "runtime.database.driver.mysql"
+        ],
+        client: []
+      }
+    }
+  },
+  mutations: {
+    dependencies: {
+      runtime: {
+        "@jskit-ai/database-runtime": "0.1.4",
+        "mysql2": "^3.11.2"
+      },
+      dev: {}
+    },
+    packageJson: {
+      scripts: {}
+    },
+    procfile: {},
+    files: [],
+    text: [
+      {
+        file: ".env",
+        op: "upsert-env",
+        key: "DB_CLIENT",
+        value: "mysql2",
+        reason: "Configure database client driver for runtime wiring.",
+        category: "runtime-config",
+        id: "database-client-mysql"
+      },
+      {
+        file: ".env",
+        op: "upsert-env",
+        key: "DB_HOST",
+        value: "${option:db-host}",
+        reason: "Configure database host.",
+        category: "runtime-config",
+        id: "database-host"
+      },
+      {
+        file: ".env",
+        op: "upsert-env",
+        key: "DB_PORT",
+        value: "${option:db-port}",
+        reason: "Configure database port.",
+        category: "runtime-config",
+        id: "database-port"
+      },
+      {
+        file: ".env",
+        op: "upsert-env",
+        key: "DB_NAME",
+        value: "${option:db-name}",
+        reason: "Configure database name.",
+        category: "runtime-config",
+        id: "database-name"
+      },
+      {
+        file: ".env",
+        op: "upsert-env",
+        key: "DB_USER",
+        value: "${option:db-user}",
+        reason: "Configure database user.",
+        category: "runtime-config",
+        id: "database-user"
+      },
+      {
+        file: ".env",
+        op: "upsert-env",
+        key: "DB_PASSWORD",
+        value: "${option:db-password}",
+        reason: "Configure database password.",
+        category: "runtime-config",
+        id: "database-password"
+      }
+    ]
+  }
+});

package/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "@jskit-ai/database-runtime-mysql",
+  "version": "0.1.4",
+  "type": "module",
+  "scripts": {
+    "test": "node --test"
+  },
+  "exports": {
+    "./client": "./src/client/index.js",
+    "./server/providers/DatabaseRuntimeMysqlServiceProvider": "./src/server/providers/DatabaseRuntimeMysqlServiceProvider.js",
+    "./shared": "./src/shared/index.js",
+    "./shared/dialect": "./src/shared/dialect.js"
+  },
+  "dependencies": {
+    "@jskit-ai/database-runtime": "0.1.4"
+  }
+}

package/src/client/index.js

@@ -0,0 +1 @@
+export {};

package/src/server/providers/DatabaseRuntimeMysqlServiceProvider.js

@@ -0,0 +1,23 @@
+import * as mysqlDialect from "../../shared/index.js";
+
+const DATABASE_DRIVER_MYSQL_TOKEN = "runtime.database.driver.mysql";
+
+const MYSQL_DATABASE_DRIVER_API = Object.freeze({
+  ...mysqlDialect
+});
+
+class DatabaseRuntimeMysqlServiceProvider {
+  static id = DATABASE_DRIVER_MYSQL_TOKEN;
+
+  register(app) {
+    if (!app || typeof app.singleton !== "function") {
+      throw new Error("DatabaseRuntimeMysqlServiceProvider requires application singleton().");
+    }
+
+    app.singleton(DATABASE_DRIVER_MYSQL_TOKEN, () => MYSQL_DATABASE_DRIVER_API);
+  }
+
+  boot() {}
+}
+
+export { DatabaseRuntimeMysqlServiceProvider };

package/src/shared/dialect.js

@@ -0,0 +1,7 @@
+const DIALECT_ID = "mysql2";
+
+function getDialectId() {
+  return DIALECT_ID;
+}
+
+export { DIALECT_ID, getDialectId };

package/src/shared/index.js

@@ -0,0 +1 @@
+export { DIALECT_ID, getDialectId } from "./dialect.js";

package/test/entrypoints.boundary.test.js

@@ -0,0 +1,32 @@
+import assert from "node:assert/strict";
+import { readFile } from "node:fs/promises";
+import test from "node:test";
+
+import * as clientApi from "../src/client/index.js";
+import * as sharedApi from "../src/shared/index.js";
+import { DatabaseRuntimeMysqlServiceProvider } from "../src/server/providers/DatabaseRuntimeMysqlServiceProvider.js";
+
+test("package exports include explicit shared and provider entrypoints", async () => {
+  const packageJson = JSON.parse(await readFile(new URL("../package.json", import.meta.url), "utf8"));
+  const exportsMap = packageJson && typeof packageJson === "object" ? packageJson.exports : {};
+  assert.equal(exportsMap["./server"], undefined);
+  assert.equal(
+    exportsMap["./server/providers/DatabaseRuntimeMysqlServiceProvider"],
+    "./src/server/providers/DatabaseRuntimeMysqlServiceProvider.js"
+  );
+  assert.equal(exportsMap["./shared"], "./src/shared/index.js");
+});
+
+test("client entrypoint exports no mysql runtime api", () => {
+  assert.deepEqual(Object.keys(clientApi), []);
+});
+
+test("server provider module exports mysql service provider only", () => {
+  assert.equal(typeof DatabaseRuntimeMysqlServiceProvider, "function");
+});
+
+test("shared entrypoint exports mysql dialect helpers", () => {
+  assert.equal(sharedApi.DIALECT_ID, "mysql2");
+  assert.equal(sharedApi.getDialectId(), "mysql2");
+  assert.equal(typeof sharedApi.DatabaseRuntimeMysqlServiceProvider, "undefined");
+});

package/test/providerRuntime.test.js

@@ -0,0 +1,33 @@
+import test from "node:test";
+import assert from "node:assert/strict";
+import { DatabaseRuntimeMysqlServiceProvider } from "../src/server/providers/DatabaseRuntimeMysqlServiceProvider.js";
+
+function createSingletonApp() {
+  const singletons = new Map();
+
+  return {
+    has(token) {
+      return singletons.has(token);
+    },
+    singleton(token, factory) {
+      singletons.set(token, factory(this));
+    },
+    make(token) {
+      if (!singletons.has(token)) {
+        throw new Error(`Token ${String(token)} is not registered.`);
+      }
+      return singletons.get(token);
+    }
+  };
+}
+
+test("DatabaseRuntimeMysqlServiceProvider registers mysql driver api", () => {
+  const app = createSingletonApp();
+  const provider = new DatabaseRuntimeMysqlServiceProvider();
+  provider.register(app);
+
+  assert.equal(app.has("runtime.database.driver.mysql"), true);
+  const api = app.make("runtime.database.driver.mysql");
+  assert.equal(api.DIALECT_ID, "mysql2");
+  assert.equal(api.getDialectId(), "mysql2");
+});