spooder 4.5.13 → 4.6.0

package/README.md

@@ -1471,18 +1471,18 @@ const db = await mysql.createConnection({
 > [!IMPORTANT]
 > MySQL requires the optional dependency `mysql2` to be installed - this is not automatically installed with spooder. This will be replaced when bun:sql supports MySQL natively.
 
-Database initiation and schema updating can be streamlined with the `db_init_schema_DRIVER` functions. The following examples are equivalent to the above ones.
+Database initiation and schema updating can be streamlined with the `db_init_DRIVER` functions. The following examples are equivalent to the above ones.
 
 ```ts
 // sqlite example
-import { db_init_schema_sqlite } from 'spooder';
-const db = await db_init_schema_sqlite('./database.sqlite', './schema');
+import { db_init_sqlite } from 'spooder';
+const db = await db_init_sqlite('./database.sqlite', './schema');
 ```
 
 ```ts
 // mysql example
-import { db_init_schema_mysql } from 'spooder';
-const db = await db_init_schema_mysql({
+import { db_init_mysql } from 'spooder';
+const db = await db_init_mysql({
 	// connection options
 	// see https://github.com/mysqljs/mysql#connection-options
 }, './schema');
@@ -1490,14 +1490,14 @@ const db = await db_init_schema_mysql({
 
 ### Pooling
 
-MySQL supports connection pooling. spooder allows you to create a connection pool instead of a single connection.
+Providing `true` to the `pool` parameter of `db_init_mysql` will return a connection pool instead of a single connection.
 
 ```ts
-import { db_init_schema_mysql_pool } from 'spooder';
-const pool = await db_init_schema_mysql_pool({
+import { db_init_mysql } from 'spooder';
+const pool = await db_init_mysql({
 	// connection options
 	connectionLimit: 10
-});
+}, './schema', true);
 
 const connection = await pool.getConnection();
 ```

package/bun.lock

@@ -12,13 +12,13 @@
     },
   },
   "packages": {
-    "@types/bun": ["@types/bun@1.2.11", "", { "dependencies": { "bun-types": "1.2.11" } }, "sha512-ZLbbI91EmmGwlWTRWuV6J19IUiUC5YQ3TCEuSHI3usIP75kuoA8/0PVF+LTrbEnVc8JIhpElWOxv1ocI1fJBbw=="],
+    "@types/bun": ["@types/bun@1.2.12", "", { "dependencies": { "bun-types": "1.2.12" } }, "sha512-lY/GQTXDGsolT/TiH72p1tuyUORuRrdV7VwOTOjDOt8uTBJQOJc5zz3ufwwDl0VBaoxotSk4LdP0hhjLJ6ypIQ=="],
 
-    "@types/node": ["@types/node@22.15.3", "", { "dependencies": { "undici-types": "~6.21.0" } }, "sha512-lX7HFZeHf4QG/J7tBZqrCAXwz9J5RD56Y6MpP0eJkka8p+K0RY/yBTW7CYFJ4VGCclxqOLKmiGP5juQc6MKgcw=="],
+    "@types/node": ["@types/node@22.15.12", "", { "dependencies": { "undici-types": "~6.21.0" } }, "sha512-K0fpC/ZVeb8G9rm7bH7vI0KAec4XHEhBam616nVJCV51bKzJ6oA3luG4WdKoaztxe70QaNjS/xBmcDLmr4PiGw=="],
 
     "aws-ssl-profiles": ["aws-ssl-profiles@1.1.2", "", {}, "sha512-NZKeq9AfyQvEeNlN0zSYAaWrmBffJh3IELMZfRpJVWgrpEbtEpnjvzqBPf+mxoI287JohRDoa+/nsfqqiZmF6g=="],
 
-    "bun-types": ["bun-types@1.2.11", "", { "dependencies": { "@types/node": "*" } }, "sha512-dbkp5Lo8HDrXkLrONm6bk+yiiYQSntvFUzQp0v3pzTAsXk6FtgVMjdQ+lzFNVAmQFUkPQZ3WMZqH5tTo+Dp/IA=="],
+    "bun-types": ["bun-types@1.2.12", "", { "dependencies": { "@types/node": "*" } }, "sha512-tvWMx5vPqbRXgE8WUZI94iS1xAYs8bkqESR9cxBB1Wi+urvfTrF1uzuDgBHFAdO0+d2lmsbG3HmeKMvUyj6pWA=="],
 
     "denque": ["denque@2.1.0", "", {}, "sha512-HVQE3AAb/pxF8fQAoiqpvg9i3evqug3hoiwakOyZAwJm+6vZehbkYXZ0l4JxS+I3QxM97v5aaRNhj8v5oBhekw=="],
 

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "spooder",
 	"type": "module",
-	"version": "4.5.13",
+	"version": "4.6.0",
 	"exports": {
 		".": {
 			"bun": "./src/api.ts",

package/src/api.ts

@@ -449,15 +449,18 @@ export async function db_update_schema_mysql(db: mysql_types.Connection, schema_
 	await db.commit();
 }
 
-export async function db_init_schema_sqlite(db_path: string, schema_dir: string): Promise<Database> {
+export async function db_init_sqlite(db_path: string, schema_dir?: string): Promise<Database> {
 	const db = new Database(db_path, { create: true });
-	await db_update_schema_sqlite(db, schema_dir);
+
+	if (schema_dir !== undefined)
+		await db_update_schema_sqlite(db, schema_dir);
+
 	return db;
 }
 
-async function _db_init_schema_mysql(db_info: mysql_types.ConnectionOptions, schema_dir: string, pool = false): Promise<mysql_types.Pool | mysql_types.Connection> {
+export async function db_init_mysql<T extends boolean = false>(db_info: mysql_types.ConnectionOptions, schema_dir?: string, pool: T = false as T): Promise<T extends true ? mysql_types.Pool : mysql_types.Connection> {
 	if (mysql === undefined)
-		throw new Error('{db_init_schema_mysql} cannot be called without optional dependency {mysql2} installed');
+		throw new Error('db_init_mysql cannot be called without optional dependency {mysql2} installed');
 
 	// required for parsing multiple statements from schema files
 	db_info.multipleStatements = true;
@@ -466,26 +469,22 @@ async function _db_init_schema_mysql(db_info: mysql_types.ConnectionOptions, sch
 		const pool = mysql.createPool(db_info);
 		const connection = await pool.getConnection();
 
-		await db_update_schema_mysql(connection, schema_dir);
+		if (schema_dir !== undefined)
+			await db_update_schema_mysql(connection, schema_dir);
+
 		connection.release();
 
-		return pool;
+		return pool as any;
 	} else {
 		const connection = await mysql.createConnection(db_info);
-		await db_update_schema_mysql(connection, schema_dir);
+
+		if (schema_dir !== undefined)
+			await db_update_schema_mysql(connection, schema_dir);
 		
-		return connection;
+		return connection as any;
 	}
 }
 
-export async function db_init_schema_mysql_pool(db_info: mysql_types.ConnectionOptions, schema_dir: string): Promise<mysql_types.Pool> {
-	return await _db_init_schema_mysql(db_info, schema_dir, true) as mysql_types.Pool;
-}
-
-export async function db_init_schema_mysql(db_info: mysql_types.ConnectionOptions, schema_dir: string): Promise<mysql_types.Connection> {
-	return await _db_init_schema_mysql(db_info, schema_dir, false) as mysql_types.Connection;
-}
-
 export type CookieOptions = {
 	same_site?: 'Strict' | 'Lax' | 'None',
 	secure?: boolean,