instapaper-ts 1.0.0 → 1.1.2

package/README.md

@@ -0,0 +1,68 @@
+# instapaper-ts
+
+`instapaper-ts` is an type-safe client for [Instapaper](https://instapaper.com).
+
+Supports all available endpoints from the [Full Developer API](https://www.instapaper.com/api)!
+
+---
+
+## Installation
+
+```sh
+npm install --save-dev instapaper-ts
+```
+
+## Usage
+
+```ts
+import { Instapaper } from "instapaper-ts";
+
+const instapaper = new Instapaper(CONSUMER_KEY, CONSUMER_SECRET);
+
+instapaper.setCredentials(USERNAME, PASSWORD);
+
+const bookmarks = await instapaper.bookmarks.list({ limit: 50 });
+
+console.log(bookmarks);
+```
+
+## Methods
+
+See [Full API](https://www.instapaper.com/api) documentation for expected parameters and return types.
+
+### Authentication
+
+- setCredentials
+- verifyCredentials
+
+### Bookmarks
+
+- list
+- updateReadProgress
+- add
+- delete
+- star
+- unstar
+- archive
+- unarchive
+- move
+- getText
+
+### Folders
+
+- list
+- add
+- delete
+- setOrder
+
+### Highlights
+
+- list
+- add
+- delete
+
+---
+
+## Terms of Use
+
+Please read the full Instapaper [Terms of Use](https://www.instapaper.com/api/terms) before using this library.

package/dist/index.d.ts

@@ -1,3 +1,5 @@
+import OAuth from 'oauth-1.0a';
+
 type User = {
     type: "user";
     user_id: number;
@@ -85,11 +87,18 @@ declare class Instapaper {
     private username?;
     private password?;
     private token?;
-    constructor(consumerKey: string, consumerSecret: string);
-    setCredentials: (username: string, password: string) => void;
+    constructor({ consumerKey, consumerSecret, username, password, token, }: {
+        consumerKey: string;
+        consumerSecret: string;
+        username?: string;
+        password?: string;
+        token?: OAuth.Token;
+    });
     private makeRequest;
     private getAccessToken;
     private request;
+    setCredentials: (username: string, password: string) => void;
+    verifyCredentials: () => Promise<[User]>;
     bookmarks: {
         list: (params?: ListParams) => Promise<(Bookmark | Folder | User | Error | Meta)[]>;
         updateReadProgress: (params: UpdateReadProgressParams) => Promise<[Bookmark]>;

package/dist/index.js

@@ -9,7 +9,13 @@ var Instapaper = class {
   username;
   password;
   token;
-  constructor(consumerKey, consumerSecret) {
+  constructor({
+    consumerKey,
+    consumerSecret,
+    username,
+    password,
+    token
+  }) {
     this.oauth = new OAuth({
       consumer: {
         key: consumerKey,
@@ -18,12 +24,11 @@ var Instapaper = class {
       signature_method: "HMAC-SHA1",
       hash_function: (base_string, key) => crypto.createHmac("sha1", key).update(base_string).digest("base64")
     });
-  }
-  setCredentials = (username, password) => {
     this.username = username;
     this.password = password;
-  };
-  makeRequest = async (url, method = "POST", params = {}, token) => {
+    this.token = token;
+  }
+  makeRequest = async (url, params = {}, token) => {
     const form = new URLSearchParams();
     for (const [key, val] of Object.entries(params)) {
       form.append(key, String(val));
@@ -32,14 +37,14 @@ var Instapaper = class {
       this.oauth.authorize(
         {
           url,
-          method,
+          method: "POST",
           data: params
         },
         token
       )
     );
     const response = await fetch(url, {
-      method,
+      method: "POST",
       headers: new Headers({ ...headers }),
       body: form
     });
@@ -64,11 +69,7 @@ var Instapaper = class {
       x_auth_password: this.password,
       x_auth_mode: "client_auth"
     };
-    const responseText = await this.makeRequest(
-      this.authUrl,
-      "POST",
-      params
-    );
+    const responseText = await this.makeRequest(this.authUrl, params);
     const data = new URLSearchParams(responseText);
     const key = data.get("oauth_token");
     const secret = data.get("oauth_token_secret");
@@ -84,8 +85,13 @@ var Instapaper = class {
       this.token = await this.getAccessToken();
     }
     const url = this.baseUrl + endpoint;
-    return this.makeRequest(url, "POST", params, this.token);
+    return this.makeRequest(url, params, this.token);
+  };
+  setCredentials = (username, password) => {
+    this.username = username;
+    this.password = password;
   };
+  verifyCredentials = () => this.request("/1/account/verify_credentials");
   bookmarks = {
     list: (params = {}) => this.request(
       "/1/bookmarks/list",

package/package.json

@@ -1,37 +1,37 @@
 {
-	"name": "instapaper-ts",
-	"version": "1.0.0",
-	"type": "module",
-	"description": "A type-safe API client for Instapaper.",
-	"main": "dist/index.js",
-	"types": "dist/index.d.ts",
-	"files": [
-		"/dist"
-	],
-	"scripts": {
-		"build": "tsup",
-		"dev": "tsup --watch"
-	},
-	"keywords": [
-		"instapaper",
-		"read",
-		"later",
-		"typescript",
-		"library"
-	],
-	"author": "Ben Silverman (bensilverman.co.uk)",
-	"homepage": "https://github.com/benslv/instapaper-ts",
-	"bugs": {
-		"url": "https://github.com/benslv/instapaper-ts/issues"
-	},
-	"license": "MIT",
-	"packageManager": "pnpm@10.4.1",
-	"dependencies": {
-		"oauth-1.0a": "^2.2.6"
-	},
-	"devDependencies": {
-		"@types/node": "^22.13.5",
-		"tsup": "^8.4.0",
-		"typescript": "^5.8.2"
-	}
+  "name": "instapaper-ts",
+  "version": "1.1.2",
+  "type": "module",
+  "description": "A type-safe API client for Instapaper.",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "/dist"
+  ],
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch"
+  },
+  "keywords": [
+    "instapaper",
+    "read",
+    "later",
+    "typescript",
+    "library"
+  ],
+  "author": "Ben Silverman (bensilverman.co.uk)",
+  "homepage": "https://github.com/benslv/instapaper-ts",
+  "bugs": {
+    "url": "https://github.com/benslv/instapaper-ts/issues"
+  },
+  "license": "MIT",
+  "packageManager": "pnpm@10.4.1",
+  "dependencies": {
+    "oauth-1.0a": "^2.2.6"
+  },
+  "devDependencies": {
+    "@types/node": "^22.13.5",
+    "tsup": "^8.4.0",
+    "typescript": "^5.8.2"
+  }
 }