🔨 chore(breaking): require object for PasteClient#login

Author: casperiv0

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 5.1.0
+
+- Bump dependencies
+- **BREAKING:** `PasteClient#login` now requires an object instead of 2 params.
+  ➡ `const token = await client.login({ name: "user_name", password: "user_password" });`
+
 ## 5.0.0
 
 - Bump dependencies

README.md

@@ -5,26 +5,32 @@
 
 A very simple npm package to interact with the pastebin api.
 
-## Installation
-
-### npm
+**Features**
 
-```bash
-npm i pastebin-api
-```
+- Create pastes with all the available API data
+- Fetch the raw contents of a paste
+- Fetch pastes from the authenticated user via a user login
+- Delete pastes from the authenticated user via a user login
 
-### yarn
+## Installation
 
 ```bash
+# npm
+npm install pastebin-api
+
+# Yarn
 yarn add pastebin-api
+
+# pnpm
+pnpm add pastebin-api
 ```
 
-> **Note**
-> `pastebin-api` requires node.js version 14 or higher.
+> **Note** > `pastebin-api` requires node.js version 14 or higher.
 
 ## Usage
 
 ```js
+// src/main.js
 import { PasteClient, Publicity, ExpireDate } from "pastebin-api";
 // const { PasteClient, Publicity, ExpireDate } = require("pastebin-api").default; // using CommonJS
 

docs/README.md

@@ -73,7 +73,7 @@ console.log(url);
 ```js
 const client = new PasteClient("DEV_API_KEY");
 
-const token = await client.login("user_name", "user_password");
+const token = await client.login({ name: "user_name", password: "user_password" });
 
 // This is the user token that can be used to get all the user's pastes or delete one
 console.log(token);
@@ -94,7 +94,7 @@ console.log(token);
 const client = new PasteClient("DEV_API_KEY");
 
 // Login to get the token
-const token = await client.login("user_name", "user_password");
+const token = await client.login({ name: "user_name", password: "user_password" });
 
 // Get a limit of 1000 pastes from the user
 const pastes = await client.getPastesByUser({
@@ -121,7 +121,7 @@ console.log(pastes);
 const client = new PasteClient("DEV_API_KEY");
 
 // Login to get the token
-const token = await client.login("user_name", "user_password");
+const token = await client.login({ name: "user_name", password: "user_password" });
 
 // Will return a boolean if deleted
 const deleted = await client.deletePasteByKey({
@@ -148,7 +148,7 @@ console.log(deleted);
 const client = new PasteClient("DEV_API_KEY");
 
 // Login to get the token
-const token = await client.login("user_name", "user_password");
+const token = await client.login({ name: "user_name", password: "user_password" });
 
 const data = await client.getRawPasteByKey({
   pasteKey: "paste-key-here",

src/PasteClient.ts

@@ -7,6 +7,7 @@ import type {
   DeletePasteOptions,
   ClientOptions,
   GetRawPasteOptions,
+  LoginOptions,
 } from "./types.js";
 
 const ERROR_PREFIX = "[pastebin-api]:" as const;
@@ -84,7 +85,7 @@ export default class PasteClient {
    * @returns An array of all the user's pastes
    * @see [https://pastebin.com/doc_api#10](https://pastebin.com/doc_api#10)
    */
-  async getPastesByUser(options: GetPastesOptions): Promise<undefined | ParsedPaste[]> {
+  async getPastesByUser(options: GetPastesOptions): Promise<ParsedPaste[]> {
     if (options.limit && (options.limit < 1 || options.limit > 1000)) {
       throw new TypeError(`${ERROR_PREFIX} Limit cannot be lower than 1 or higher than 1000`);
     }
@@ -210,14 +211,14 @@ export default class PasteClient {
    * @returns The user token to use for other API routes
    * @see [https://pastebin.com/doc_api#9](https://pastebin.com/doc_api#9)
    */
-  async login(name: string, password: string): Promise<string> {
+  async login(options: LoginOptions): Promise<string> {
     const res = await fetch(this.loginUrl, {
       method: "POST",
       headers: { "Content-Type": "application/x-www-form-urlencoded" },
       body: this.encode({
         api_dev_key: this.apiKey,
-        api_user_name: name,
-        api_user_password: password,
+        api_user_name: options.name,
+        api_user_password: options.password,
       }),
     });
 

src/types.ts

@@ -335,6 +335,11 @@ export interface DeletePasteOptions {
   pasteKey: string;
 }
 
+export interface LoginOptions {
+  name: string;
+  password: string;
+}
+
 export type GetRawPasteOptions = DeletePasteOptions;
 
 export interface ParsedPaste {

tests/index.test.ts

@@ -18,7 +18,7 @@ if (!USER_NAME || !USER_PASSWORD) {
 const client = new PasteClient({ apiKey: KEY });
 
 async function test() {
-  const token = await client.login(USER_NAME!, USER_PASSWORD!);
+  const token = await client.login({ name: USER_NAME!, password: USER_PASSWORD! });
 
   // const deleted = await client.deletePasteByKey({
   //   pasteKey: "XawZVJdA",