feat: move essential params out of { config }

Author: MKRhere

README.md

@@ -1,14 +1,135 @@
 # `@telegraf/session`
 
-This package provides official storage adapters for Telegraf v4.12+ sessions.
+This package provides official storage adapters for Telegraf v4.12+ sessions [[see motivation]](#background).
 
-An in-memory session module is bundled with Telegraf. These modules are available here:
+> ⚠️ Very Important!
+>
+> Read one of the following sections before using this module. You're not meant to import the default route!
 
--   [Redis](./docs/redis.md)
--   [MongoDB](./docs/mongodb.md)
--   [SQLite](./docs/sqlite.md)
--   [PostgreSQL](./docs/pg.md)
--   [MySQL / MariaDB](./docs/mysql.md)
+An in-memory session module is bundled with Telegraf. The following modules are available here:
+
+-   [Redis](#redis)
+-   [MongoDB](#mongodb)
+-   [SQLite](#sqlite)
+-   [PostgreSQL](#postgresql)
+-   [MySQL / MariaDB](#mysql--mariadb)
+
+## Redis
+
+Install the official Redis driver alongside this module.
+
+```shell
+npm i @telegraf/session redis
+```
+
+Usage is pretty straightforward:
+
+```TS
+import { Redis } from "@telegraf/session/redis";
+
+const store = Redis({ url: "redis://127.0.0.1:6379" });
+
+const bot = new Telegraf(token, opts);
+bot.use(session({ store }));
+
+// the rest of your bot
+```
+
+## MongoDB
+
+Install the official MongoDB driver alongside this module.
+
+```shell
+npm i @telegraf/session mongodb
+```
+
+Usage is pretty straightforward:
+
+```TS
+import { Mongo } from "@telegraf/session/mongodb";
+
+const store = Mongo({ url: "mongodb://127.0.0.1:27017", database: "telegraf-bot" });
+
+const bot = new Telegraf(token, opts);
+bot.use(session({ store }));
+
+// the rest of your bot
+```
+
+## SQLite
+
+Install the Better-SQLite3 driver and types alongside this module.
+
+```shell
+npm i @telegraf/session kysely better-sqlite3
+npm i --save-dev @types/better-sqlite3
+```
+
+Usage is pretty straightforward:
+
+```TS
+import { SQLite } from "@telegraf/session/sqlite";
+
+const store = SQLite({ filename: "./telegraf-sessions.sqlite" });
+
+const bot = new Telegraf(token, opts);
+bot.use(session({ store }));
+
+// the rest of your bot
+```
+
+## PostgreSQL
+
+Install the 'pg' PostgreSQL driver and types alongside this module.
+
+```shell
+npm i @telegraf/session kysely pg
+npm i --save-dev @types/pg
+```
+
+Usage is pretty straightforward:
+
+```TS
+import { Postgres } from "@telegraf/session/pg";
+
+const store = Postgres({
+	host: "127.0.0.1",
+	database: "telegraf-test",
+	user: "database-user",
+	password: "hunter2",
+});
+
+const bot = new Telegraf(token, opts);
+bot.use(session({ store }));
+
+// the rest of your bot
+```
+
+## MySQL / MariaDB
+
+Install the 'mysql2' MySQL driver alongside this module.
+
+```shell
+npm i @telegraf/session kysely mysql2
+```
+
+Usage is pretty straightforward:
+
+```TS
+import { MySQL } from "@telegraf/session/mysql";
+
+const store = MySQL({
+	host: "127.0.0.1",
+	database: "telegraf-test",
+	user: "database-user",
+	password: "hunter2",
+});
+
+const bot = new Telegraf(token, opts);
+bot.use(session({ store }));
+
+// the rest of your bot
+```
 
 ## Background
 

docs/mongodb.md

@@ -3,14 +3,19 @@ import { createPool, Pool, PoolOptions } from "mysql2";
 import { KyselyStore } from "./kysely";
 
 interface NewPoolOpts {
+	host?: string | undefined;
+	port?: number | undefined;
+	database?: string | undefined;
+	user?: string | undefined;
+	password?: string;
 	/**
 	 * MySQL2 Pool options.
 	 *
 	 * Remember to install the db driver `'mysql2'`.
 	 *
 	 * @see {@link https://github.com/sidorares/node-mysql2#using-connection-pools Node MySQL 2 | Using connection pools}
 	 * */
-	config: PoolOptions;
+	config: Omit<PoolOptions, "host" | "port" | "database" | "user" | "password">;
 	/** Table name to use for sessions. Defaults to "telegraf-sessions". */
 	table?: string;
 	/** Called on fatal connection or setup errors */
@@ -34,7 +39,18 @@ export const MySQL = <Session>(opts: Opts) =>
 		config:
 			"pool" in opts
 				? { dialect: new MysqlDialect({ pool: opts.pool }) }
-				: { dialect: new MysqlDialect({ pool: createPool(opts.config) }) },
+				: {
+						dialect: new MysqlDialect({
+							pool: createPool({
+								host: opts.host,
+								port: opts.port,
+								database: opts.database,
+								user: opts.user,
+								password: opts.password,
+								...opts.config,
+							}),
+						}),
+				  },
 		table: opts.table,
 		onInitError: opts.onInitError,
 	});

docs/mysql.md

@@ -3,14 +3,19 @@ import { Pool, PoolConfig } from "pg";
 import { KyselyStore } from "./kysely";
 
 interface NewPoolOpts {
+	host?: string | undefined;
+	port?: number | undefined;
+	database?: string | undefined;
+	user?: string | undefined;
+	password?: string | (() => string | Promise<string>) | undefined;
 	/**
 	 * Postgres Pool config.
 	 *
 	 * Remember to install the db driver `'pg'`.
 	 *
 	 * @see {@link https://node-postgres.com/apis/pool node-postgres | Pool Options}
 	 * */
-	config: PoolConfig;
+	config: Omit<PoolConfig, "host" | "port" | "database" | "user" | "password">;
 	/** Table name to use for sessions. Defaults to "telegraf-sessions". */
 	table?: string;
 	/** Called on fatal connection or setup errors */
@@ -34,7 +39,18 @@ export const Postgres = <Session>(opts: Opts) =>
 		config:
 			"pool" in opts
 				? { dialect: new PostgresDialect({ pool: opts.pool }) }
-				: { dialect: new PostgresDialect({ pool: new Pool(opts.config) }) },
+				: {
+						dialect: new PostgresDialect({
+							pool: new Pool({
+								host: opts.host,
+								port: opts.port,
+								database: opts.database,
+								user: opts.user,
+								password: opts.password,
+								...opts.config,
+							}),
+						}),
+				  },
 		table: opts.table,
 		onInitError: opts.onInitError,
 	});

docs/pg.md

@@ -5,7 +5,13 @@ import { SessionStore } from "./types";
 type Client = ReturnType<typeof createClient>;
 
 interface NewClientOpts {
-	config: RedisClientOptions;
+	/**
+	 * `redis[s]://[[username][:password]@][host][:port][/db-number]`
+	 *
+	 * See [`redis`](https://www.iana.org/assignments/uri-schemes/prov/redis) and [`rediss`](https://www.iana.org/assignments/uri-schemes/prov/rediss) IANA registration for more details
+	 */
+	url?: string;
+	config: Omit<RedisClientOptions, "url">;
 	/** Prefix to use for session keys. Defaults to "telegraf:". */
 	prefix?: string;
 	/** Called on fatal connection or setup errors */
@@ -25,7 +31,7 @@ export type Opts = NewClientOpts | ExistingClientOpts;
 export const Redis = <Session>(opts: Opts): SessionStore<Session> => {
 	let client: Client;
 	if ("client" in opts) client = opts.client;
-	else client = createClient(opts.config);
+	else client = createClient({ ...opts.config, url: opts.url });
 
 	const connection = client.connect();