use std::fmt::Write;
use std::path::Path;
use scythe_backend::manifest::{BackendManifest, load_manifest};
use scythe_backend::naming::{
enum_type_name, enum_variant_name, fn_name, row_struct_name, to_camel_case, to_pascal_case,
};
use scythe_backend::types::resolve_type;
use scythe_core::analyzer::{AnalyzedQuery, CompositeInfo, EnumInfo};
use scythe_core::errors::{ErrorCode, ScytheError};
use scythe_core::parser::QueryCommand;
use crate::backend_trait::{CodegenBackend, ResolvedColumn, ResolvedParam};
use crate::singularize;
const DEFAULT_MANIFEST_TOML: &str = include_str!("../../manifests/typescript-mysql2.toml");
pub struct TypescriptMysql2Backend {
manifest: BackendManifest,
}
impl TypescriptMysql2Backend {
pub fn new(engine: &str) -> Result<Self, ScytheError> {
match engine {
"mysql" | "mariadb" => {}
_ => {
return Err(ScytheError::new(
ErrorCode::InternalError,
format!(
"typescript-mysql2 only supports MySQL/MariaDB, got engine '{}'",
engine
),
));
}
}
let manifest_path = Path::new("backends/typescript-mysql2/manifest.toml");
let manifest = if manifest_path.exists() {
load_manifest(manifest_path)
.map_err(|e| ScytheError::new(ErrorCode::InternalError, format!("manifest: {e}")))?
} else {
toml::from_str(DEFAULT_MANIFEST_TOML)
.map_err(|e| ScytheError::new(ErrorCode::InternalError, format!("manifest: {e}")))?
};
Ok(Self { manifest })
}
}
impl CodegenBackend for TypescriptMysql2Backend {
fn name(&self) -> &str {
"typescript-mysql2"
}
fn manifest(&self) -> &scythe_backend::manifest::BackendManifest {
&self.manifest
}
fn supported_engines(&self) -> &[&str] {
&["mysql"]
}
fn file_header(&self) -> String {
"/** Auto-generated by scythe. Do not edit. */\n\nimport type { Pool, RowDataPacket } from \"mysql2/promise\";\n"
.to_string()
}
fn generate_row_struct(
&self,
query_name: &str,
columns: &[ResolvedColumn],
) -> Result<String, ScytheError> {
let struct_name = row_struct_name(query_name, &self.manifest.naming);
let mut out = String::new();
let _ = writeln!(out, "/** Row type for {} queries. */", query_name);
let _ = writeln!(
out,
"export interface {} extends RowDataPacket {{",
struct_name
);
for col in columns {
let _ = writeln!(out, "\t{}: {};", col.field_name, col.full_type);
}
let _ = write!(out, "}}");
Ok(out)
}
fn generate_model_struct(
&self,
table_name: &str,
columns: &[ResolvedColumn],
) -> Result<String, ScytheError> {
let singular = singularize(table_name);
let name = to_pascal_case(&singular);
self.generate_row_struct(&name, columns)
}
fn generate_query_fn(
&self,
analyzed: &AnalyzedQuery,
struct_name: &str,
_columns: &[ResolvedColumn],
params: &[ResolvedParam],
) -> Result<String, ScytheError> {
let func_name = fn_name(&analyzed.name, &self.manifest.naming);
let mut out = String::new();
let param_list = params
.iter()
.map(|p| format!("{}: {}", p.field_name, p.full_type))
.collect::<Vec<_>>()
.join(", ");
let sql = super::clean_sql(&analyzed.sql);
let inline_params = if params.is_empty() {
"pool: Pool".to_string()
} else {
format!("pool: Pool, {}", param_list)
};
let write_fn_sig = |out: &mut String, name: &str, params_inline: &str, ret: &str| {
let oneliner = format!(
"export async function {}({}): {} {{",
name, params_inline, ret
);
if oneliner.len() <= 80 {
let _ = writeln!(out, "{}", oneliner);
} else {
let mut parts = vec!["\tpool: Pool".to_string()];
for p in params {
parts.push(format!("\t{}: {}", p.field_name, p.full_type));
}
let _ = writeln!(out, "export async function {}(", name);
for part in &parts {
let _ = writeln!(out, "{},", part);
}
let _ = writeln!(out, "): {} {{", ret);
}
};
let param_array = if params.is_empty() {
String::new()
} else {
let args: Vec<String> = params.iter().map(|p| p.field_name.clone()).collect();
format!(", [{}]", args.join(", "))
};
match &analyzed.command {
QueryCommand::One => {
let _ = writeln!(out, "/** Fetch a single {} or null. */", struct_name);
let ret = format!("Promise<{} | null>", struct_name);
write_fn_sig(&mut out, &func_name, &inline_params, &ret);
let _ = writeln!(
out,
"\tconst [rows] = await pool.execute<{}[]>(",
struct_name
);
let _ = writeln!(out, "\t\t`{}`{},", sql, param_array);
let _ = writeln!(out, "\t);");
let _ = writeln!(out, "\treturn rows[0] ?? null;");
let _ = write!(out, "}}");
}
QueryCommand::Many | QueryCommand::Batch => {
let _ = writeln!(out, "/** Fetch all {} rows. */", struct_name);
let ret = format!("Promise<{}[]>", struct_name);
write_fn_sig(&mut out, &func_name, &inline_params, &ret);
let _ = writeln!(
out,
"\tconst [rows] = await pool.execute<{}[]>(",
struct_name
);
let _ = writeln!(out, "\t\t`{}`{},", sql, param_array);
let _ = writeln!(out, "\t);");
let _ = writeln!(out, "\treturn rows;");
let _ = write!(out, "}}");
}
QueryCommand::Exec => {
let _ = writeln!(out, "/** Execute a query returning no rows. */");
write_fn_sig(&mut out, &func_name, &inline_params, "Promise<void>");
let _ = writeln!(out, "\tawait pool.execute(");
let _ = writeln!(out, "\t\t`{}`{},", sql, param_array);
let _ = writeln!(out, "\t);");
let _ = write!(out, "}}");
}
QueryCommand::ExecResult | QueryCommand::ExecRows => {
let _ = writeln!(
out,
"/** Execute a query and return the number of affected rows. */"
);
write_fn_sig(&mut out, &func_name, &inline_params, "Promise<number>");
let _ = writeln!(out, "\tconst [result] = await pool.execute(");
let _ = writeln!(out, "\t\t`{}`{},", sql, param_array);
let _ = writeln!(out, "\t);");
let _ = writeln!(
out,
"\treturn (result as {{ affectedRows: number }}).affectedRows;"
);
let _ = write!(out, "}}");
}
}
Ok(out)
}
fn generate_enum_def(&self, enum_info: &EnumInfo) -> Result<String, ScytheError> {
let type_name = enum_type_name(&enum_info.sql_name, &self.manifest.naming);
let mut out = String::new();
let _ = writeln!(out, "export enum {} {{", type_name);
for value in &enum_info.values {
let variant = enum_variant_name(value, &self.manifest.naming);
let _ = writeln!(out, "\t{} = \"{}\",", variant, value);
}
let _ = write!(out, "}}");
Ok(out)
}
fn generate_composite_def(&self, composite: &CompositeInfo) -> Result<String, ScytheError> {
let name = to_pascal_case(&composite.sql_name);
let mut out = String::new();
let _ = writeln!(out, "/** Composite type {}. */", composite.sql_name);
let _ = writeln!(out, "export interface {} {{", name);
for field in &composite.fields {
let ts_type = resolve_type(&field.neutral_type, &self.manifest, false)
.map(|t| t.into_owned())
.map_err(|e| {
ScytheError::new(
ErrorCode::InternalError,
format!("composite field type error: {}", e),
)
})?;
let _ = writeln!(out, "\t{}: {};", to_camel_case(&field.name), ts_type);
}
let _ = write!(out, "}}");
Ok(out)
}
}