rmapi-js 4.0.0 → 5.0.0

package/dist/index.d.ts

@@ -234,7 +234,7 @@ export interface CacheLike {
 /** stripped down version of subtle crypto */
 export interface SubtleCryptoLike {
     /** a digest function */
-    digest(algorithm: "SHA-256", data: ArrayBuffer): Promise<ArrayBuffer>;
+    digest(algorithm: "SHA-256", data: BufferSource): Promise<ArrayBuffer>;
 }
 /** an error that results from a failed request */
 export declare class ResponseError extends Error {
@@ -343,6 +343,16 @@ export interface PutPdfOptions {
     /** the tool to have enabled by default */
     lastTool?: string;
 }
+/** options for getting responses */
+export interface GetOptions {
+    /**
+     * whether to verify the types of the response
+     *
+     * Omitting will make the results always work, but they might nit return
+     * accurate types anymore.
+     */
+    verify?: boolean | undefined;
+}
 /**
  * the api for accessing remarkable functions
  */
@@ -397,7 +407,7 @@ export interface RemarkableApi {
      */
     getJson(hash: string): Promise<unknown>;
     /** get metadata from hash */
-    getMetadata(hash: string): Promise<Metadata>;
+    getMetadata(hash: string, opts?: GetOptions): Promise<Metadata>;
     /**
      * get entries from a collection hash
      *
@@ -569,7 +579,7 @@ export interface RemarkableApi {
      * @remarks this uses a newer api, that returns metadata associated with all
      * entries and their hash and documentId.
      */
-    getEntriesMetadata(): Promise<MetadataEntry[]>;
+    getEntriesMetadata(opts?: GetOptions): Promise<MetadataEntry[]>;
     /**
      * upload an epub
      *
@@ -585,7 +595,7 @@ export interface RemarkableApi {
      * @param visibleName - the name to show for the uploaded epub
      * @param buffer - the epub contents
      */
-    uploadEpub(visibleName: string, buffer: ArrayBuffer): Promise<UploadEntry>;
+    uploadEpub(visibleName: string, buffer: ArrayBuffer, opts?: GetOptions): Promise<UploadEntry>;
     /**
      * upload a pdf
      *
@@ -605,7 +615,7 @@ export interface RemarkableApi {
      * @param buffer - the epub contents
      * @experimental
      */
-    uploadPdf(visibleName: string, buffer: ArrayBuffer): Promise<UploadEntry>;
+    uploadPdf(visibleName: string, buffer: ArrayBuffer, opts?: GetOptions): Promise<UploadEntry>;
     /**
      * get the current state of the cache for persisting
      *

package/dist/index.js

@@ -52,6 +52,7 @@ const GENERATION_HEADER = "x-goog-generation";
 const GENERATION_RACE_HEADER = "x-goog-if-generation-match";
 const CONTENT_LENGTH_RANGE_HEADER = "x-goog-content-length-range";
 /** tool options */
+/* eslint-disable spellcheck/spell-checker */
 export const builtinTools = [
     "Ballpoint",
     "Ballpointv2",
@@ -74,7 +75,9 @@ export const builtinTools = [
     "SolidPen",
     "ZoomTool",
 ];
+/* eslint-enable spellcheck/spell-checker */
 /** font name options */
+/* eslint-disable spellcheck/spell-checker */
 export const builtinFontNames = [
     "Maison Neue",
     "EB Garamond",
@@ -83,6 +86,7 @@ export const builtinFontNames = [
     "Noto Mono",
     "Noto Sans UI",
 ];
+/* eslint-enable spellcheck/spell-checker */
 /** text scale options */
 export const builtinTextScales = {
     /** the smallest */
@@ -550,10 +554,10 @@ class Remarkable {
         entries.sort((a, b) => a.documentId.localeCompare(b.documentId));
         const hashes = concatBuffers(entries.map((ent) => fromHex(ent.hash)));
         const digest = await this.#subtle.digest("SHA-256", hashes);
-        const hash = toHex(digest);
+        const hash = toHex(new Uint8Array(digest));
         const entryContents = entries.map(formatEntry).join("");
         const contents = `${SCHEMA_VERSION}\n${entryContents}`;
-        const buffer = enc.encode(contents);
+        const buffer = enc.encode(contents).buffer;
         await this.#putHash(hash, buffer);
         return {
             hash,
@@ -566,7 +570,7 @@ class Remarkable {
     /** put a raw buffer in the cloud */
     async putBuffer(documentId, buffer) {
         const digest = await this.#subtle.digest("SHA-256", buffer);
-        const hash = toHex(digest);
+        const hash = toHex(new Uint8Array(digest));
         await this.#putHash(hash, buffer);
         return {
             hash,
@@ -579,7 +583,8 @@ class Remarkable {
     /** put text in the cloud */
     async putText(documentId, contents) {
         const enc = new TextEncoder();
-        return await this.putBuffer(documentId, enc.encode(contents));
+        const encoded = enc.encode(contents).buffer;
+        return await this.putBuffer(documentId, encoded);
     }
     /** put json in the cloud */
     async putJson(documentId, contents) {
@@ -770,7 +775,7 @@ class Remarkable {
         return await this.#tryPutRootEntries(gen, rootEntries, sync);
     }
     /** get entries and metadata for all files */
-    async getEntriesMetadata({ verify = true, } = {}) {
+    async getEntriesMetadata({ verify = true } = {}) {
         const resp = await this.#authedFetch(`${this.#syncHost}/doc/v2/files`, {
             method: "GET",
             headers: {

package/dist/index.spec.d.ts

@@ -0,0 +1 @@
+export {};