rmapi-js 10.2.0 → 11.0.0

package/dist/error.d.ts

@@ -0,0 +1,14 @@
+/** an error that results from a failed request */
+export declare class ValidationError extends Error {
+    /** the response status number */
+    readonly field: string;
+    /** the response status text */
+    readonly regex: RegExp;
+    constructor(field: string, regex: RegExp, message: string);
+}
+/** an error that results while supplying a hash not found in the entries of the root hash */
+export declare class HashNotFoundError extends Error {
+    /** the hash that couldn't be found */
+    readonly hash: string;
+    constructor(hash: string);
+}

package/dist/error.js

@@ -0,0 +1,21 @@
+/** an error that results from a failed request */
+export class ValidationError extends Error {
+    /** the response status number */
+    field;
+    /** the response status text */
+    regex;
+    constructor(field, regex, message) {
+        super(message);
+        this.field = field;
+        this.regex = regex;
+    }
+}
+/** an error that results while supplying a hash not found in the entries of the root hash */
+export class HashNotFoundError extends Error {
+    /** the hash that couldn't be found */
+    hash;
+    constructor(hash) {
+        super(`'${hash}' not found in the root hash`);
+        this.hash = hash;
+    }
+}

package/dist/index.js

@@ -61,9 +61,6 @@ export { HashNotFoundError, ValidationError } from "./error.js";
 const AUTH_HOST = "https://webapp-prod.cloud.remarkable.engineering";
 const RAW_HOST = "https://eu.tectonic.remarkable.com";
 const UPLOAD_HOST = "https://internal.cloud.remarkable.com";
-// ------------ //
-// Request Info //
-// ------------ //
 // The section has all the types that are stored in the remarkable cloud.
 const idReg = /^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}||trash)$/;
 /** An error that gets thrown when the backend while trying to update
@@ -339,7 +336,6 @@ class Remarkable {
         const [[contentEntry, uploadContent], [metadataEntry, uploadMetadata], [pagedataEntry, uploadPagedata], [fileEntry, uploadFile], [rootHash, generation, schemaVersion],] = await Promise.all([
             this.raw.putContent(`${id}.content`, content),
             this.raw.putMetadata(`${id}.metadata`, metadata),
-            // eslint-disable-next-line spellcheck/spell-checker
             this.raw.putText(`${id}.pagedata`, "\n"),
             this.raw.putFile(`${id}.${fileType}`, buffer),
             this.#getRootHash(refresh),

package/dist/lru.d.ts

@@ -0,0 +1,8 @@
+export declare class LruCache extends Map<string, string | null> {
+    #private;
+    constructor(maxSize: number, entries?: Iterable<[string, string | null]>);
+    get(key: string): string | null | undefined;
+    set(key: string, value: string | null): this;
+    delete(key: string): boolean;
+    clear(): void;
+}

package/dist/lru.js

@@ -0,0 +1,64 @@
+export class LruCache extends Map {
+    #maxSize;
+    #currentSize = 0;
+    constructor(maxSize, entries = []) {
+        super();
+        this.#maxSize = maxSize;
+        for (const [key, value] of entries) {
+            this.set(key, value);
+        }
+    }
+    get(key) {
+        const res = super.get(key);
+        if (res !== undefined) {
+            // update order so key is most recent
+            super.delete(key);
+            super.set(key, res);
+        }
+        return res;
+    }
+    set(key, value) {
+        const existing = super.get(key);
+        if (existing === undefined) {
+            this.#currentSize += key.length; // adding a new key
+        }
+        else if (existing !== null) {
+            this.#currentSize -= existing.length; // removing old value
+        }
+        if (value !== null) {
+            this.#currentSize += value.length;
+        }
+        // delete existing value
+        super.delete(key);
+        // evict down to desired size
+        let entry;
+        while (this.#currentSize > this.#maxSize &&
+            (entry = this.entries().next().value)) {
+            const [oldestKey, oldestValue] = entry;
+            super.delete(oldestKey);
+            this.#currentSize -= oldestKey.length;
+            if (oldestValue !== null) {
+                this.#currentSize -= oldestValue.length;
+            }
+        }
+        // finally insert new key and return
+        super.set(key, value);
+        return this;
+    }
+    delete(key) {
+        const value = super.get(key);
+        if (value === undefined) {
+            return false;
+        }
+        super.delete(key);
+        if (value !== null) {
+            this.#currentSize -= value.length;
+        }
+        this.#currentSize -= key.length;
+        return true;
+    }
+    clear() {
+        super.clear();
+        this.#currentSize = 0;
+    }
+}

package/dist/raw.d.ts

@@ -1,4 +1,3 @@
-import "core-js/proposals/array-buffer-base64";
 /** request types */
 export type RequestMethod = "POST" | "GET" | "PUT" | "DELETE" | "PATCH" | "OPTIONS";
 /** the supported upload mime types */

package/dist/raw.js

@@ -2,7 +2,6 @@ import CRC32C from "crc-32/crc32c";
 import { z } from "zod";
 import { ValidationError } from "./error.js";
 import { concatArrays } from "./utils.js";
-import "core-js/proposals/array-buffer-base64";
 const hashReg = /^[0-9a-f]{64}$/;
 const tag = z
     .object({
@@ -127,7 +126,6 @@ const documentContentOptional = {
     })
         .passthrough()
         .optional(),
-    // eslint-disable-next-line spellcheck/spell-checker
     viewBackgroundFilter: z.enum(["off", "fullpage"]).optional(),
     zoomMode: z
         .enum(["bestFit", "customFit", "fitToHeight", "fitToWidth"])
@@ -380,7 +378,6 @@ export class RawRemarkable {
                 body: bytes,
                 headers: {
                     "rm-filename": fileName,
-                    // eslint-disable-next-line spellcheck/spell-checker
                     "x-goog-hash": `crc32c=${crcHash}`,
                 },
             });