rmapi-js 14.2.0 → 14.3.0

package/dist/index.d.ts

@@ -86,6 +86,18 @@ export declare class ResponseError extends Error {
     readonly statusText: string;
     constructor(status: number, statusText: string, message: string);
 }
+/** an error that results from the service rejecting a registration */
+export declare class RegisterError extends ResponseError {
+    /** the response body */
+    readonly body: string;
+    constructor(status: number, statusText: string, body: string);
+}
+/** an error that results from the service refusing to issue a session token */
+export declare class AuthError extends ResponseError {
+    /** the response body */
+    readonly body: string;
+    constructor(status: number, statusText: string, body: string);
+}
 /** options for registering with the api */
 export interface RegisterOptions {
     /**
@@ -110,6 +122,7 @@ export interface RegisterOptions {
  * token to use the api.
  *
  * @param code - the eight letter code a user got from `https://my.remarkable.com/device/browser/connect`.
+ * @throws RegisterError if the service rejects the registration
  * @returns the device token necessary for creating an api instace. These never expire so persist as long as necessary.
  */
 export declare function register(code: string, { deviceDesc, uuid, authHost, }?: RegisterOptions): Promise<string>;
@@ -912,6 +925,7 @@ export interface RemarkableOptions extends AuthOptions, RemarkableSessionOptions
  *
  * @param deviceToken - the device token proving this api instance is
  *    registered. Create one with {@link register}.
+ * @throws AuthError if the service refuses to issue a session token
  * @returns the session token returned by the reMarkable service
  */
 export declare function auth(deviceToken: string, { authHost }?: AuthOptions): Promise<string>;

package/dist/index.js

@@ -205,6 +205,24 @@ export class ResponseError extends Error {
         this.statusText = statusText;
     }
 }
+/** an error that results from the service rejecting a registration */
+export class RegisterError extends ResponseError {
+    /** the response body */
+    body;
+    constructor(status, statusText, body) {
+        super(status, statusText, "couldn't register api");
+        this.body = body;
+    }
+}
+/** an error that results from the service refusing to issue a session token */
+export class AuthError extends ResponseError {
+    /** the response body */
+    body;
+    constructor(status, statusText, body) {
+        super(status, statusText, "couldn't fetch auth token");
+        this.body = body;
+    }
+}
 /**
  * register a device and get the token needed to access the api
  *
@@ -213,6 +231,7 @@ export class ResponseError extends Error {
  * token to use the api.
  *
  * @param code - the eight letter code a user got from `https://my.remarkable.com/device/browser/connect`.
+ * @throws RegisterError if the service rejects the registration
  * @returns the device token necessary for creating an api instace. These never expire so persist as long as necessary.
  */
 export async function register(code, { deviceDesc = "browser-chrome", uuid = uuid4(), authHost = AUTH_HOST, } = {}) {
@@ -223,6 +242,7 @@ export async function register(code, { deviceDesc = "browser-chrome", uuid = uui
         method: "POST",
         headers: {
             Authorization: "Bearer",
+            "Content-Type": "application/json",
         },
         body: JSON.stringify({
             code,
@@ -230,11 +250,12 @@ export async function register(code, { deviceDesc = "browser-chrome", uuid = uui
             deviceID: uuid,
         }),
     });
+    const body = await resp.text();
     if (!resp.ok) {
-        throw new ResponseError(resp.status, resp.statusText, "couldn't register api");
+        throw new RegisterError(resp.status, resp.statusText, body);
     }
     else {
-        return await resp.text();
+        return body;
     }
 }
 const tokenClaims = z
@@ -1985,6 +2006,7 @@ function decodeCache(dumped) {
  *
  * @param deviceToken - the device token proving this api instance is
  *    registered. Create one with {@link register}.
+ * @throws AuthError if the service refuses to issue a session token
  * @returns the session token returned by the reMarkable service
  */
 export async function auth(deviceToken, { authHost = AUTH_HOST } = {}) {
@@ -1994,10 +2016,13 @@ export async function auth(deviceToken, { authHost = AUTH_HOST } = {}) {
             Authorization: `Bearer ${deviceToken}`,
         },
     });
+    const body = await resp.text();
     if (!resp.ok) {
-        throw new Error(`couldn't fetch auth token: ${resp.statusText}`);
+        throw new AuthError(resp.status, resp.statusText, body);
+    }
+    else {
+        return body;
     }
-    return await resp.text();
 }
 /**
  * Create an API instance from an existing session token.