rmapi-js 5.0.0 → 6.0.0

package/README.md

@@ -1,135 +1,77 @@
-rmapi-js
-========
-[![build](https://github.com/erikbrinkman/rmapi-js/actions/workflows/node.js.yml/badge.svg)](https://github.com/erikbrinkman/rmapi-js/actions/workflows/node.js.yml)
+# rmapi-js
+
+[![build](https://github.com/erikbrinkman/rmapi-js/actions/workflows/build.yml/badge.svg)](https://github.com/erikbrinkman/rmapi-js/actions/workflows/build.yml)
 [![docs](https://img.shields.io/badge/docs-docs-blue)](https://erikbrinkman.github.io/rmapi-js/modules.html)
 [![npm](https://img.shields.io/npm/v/rmapi-js)](https://www.npmjs.com/package/rmapi-js)
 [![license](https://img.shields.io/github/license/erikbrinkman/rmapi-js)](LICENSE)
 
-JavaScript implementation of the reMarkable 1.5 api. This implementation is
-built around web standards for fetch and crypto, but can easily be patched to
-work for node. It should also be pretty easy to customize to work with
+JavaScript implementation of the reMarkable api. This implementation is built
+around web standards for fetch, but can easily be patched to work for node. It
+should also be pretty easy to customize to work with
 [rmfakecloud](https://github.com/ddvk/rmfakecloud), although that might take a
-little bit of extra plumbing. At the current time it's only partially complete,
-but has the backbone to be flushed out more.
+little bit of extra plumbing.
 
-This implementation is based off of [`rmapi`](https://github.com/juruen/rmapi),
-but aims to be a little simpler. Currently this does no direct handling of the
-document tree or syncing efficiently with the cloud, although that support can
-be build on top of this library. To make those calls efficient, it will be
-helpful to supply a custom cache.
+reMarkable keep updating their API, makig it hard to keep all features
+functioning. The current version is based on the api used by reMarkables web uploader and file viewer. While this api works for moving and uploading, it doesn't support more fine-grained access to document configuration, or downloading.
 
-API
----
+## API
 
 Before using this API it's necessary to have some rudimentary understanding of
 how the API works.
 
-All data is stored via its sha256 hash. This includes raw files and
-"collections", which have a special format listing all of their `Entry`s by
-hash and id. Each document or folder is a collection of it's constituant files,
-which inclue metadata about the object.  All documents and folders are in the
-root collection, and there's a versioned hash which indicates the hash of the
-root collection. The root hash version is it's "generation".
+All data is stored via its sha256 hash. This includes raw files ("documents")
+and folders ("collections"). The hash indicates the full current state to manage simultaneous edits. Most entries or edits will take an input hash, and return an output hash. Additionally, every entry has an id, which is a uuid4, and remains constantant over the lifetime of the file. There are two special ids, "" (the empty string) which corresponds to the root collection, e.g. the default location for all files, and "trash", which is the trash.
 
-Usage
------
+## Usage
 
 To explore files in the cloud, you need to first register your api and persist
-the token. Then you can use `getEntries` to explore entries of different file
+the token. Then you can use `listFiles` to explore entries of different file
 collections.
+
 ```ts
 import { register, remarkable } from "rmapi-js";
 
-const code = "..."  // eight letter code from https://my.remarkable.com/device/desktop/connect
-const token = await register(code)
-// persist token
+const code = "..."; // eight letter code from https://my.remarkable.com/device/desktop/connect
+const token = await register(code);
+// persist token so you don't have to register again
 const api = await remarkable(token);
-const [root] = await api.getRootHash();
-const fileEntries = await api.getEntries(root);
-for (const entry of fileEntries) {
-  const children = await api.getEntries(entry.hash);
-  for (const { hash, documentId } of children) {
-    if (documentId.endsWith(".metadata")) {
-      const meta = api.getMetadata(hash);
-      // get metadata for entry
-      console.log(meta);
-    }
-  }
-}
+const fileEntries = await api.listFiles();
 ```
 
-To upload an epub, simply call upload with the appropriate name and buffer.
+To upload an epub or pdf, simply call upload with the appropriate name and buffer.
+
 ```ts
 import { remarkable } from "rmapi-js";
 
 const api = await remarkable(...);
-await api.putEpub("document name", epubBuffer);
+await api.uploadEpub("name", buffer);
+await api.uploadPdf("name", buffer);
 ```
 
-Note that to actually update the reMarkable to display it, the root hash will
-also need to be updated, see method documentation for more info.
-
 ### Node
 
-This uses web standards by default, so using within node takes a little more effort.
-
-You need import the node crypto library and assign it to globals
-```js
-import { webcrypto } from "crypto";
-global.crypto = webcrypto;
-```
-
-or optionally pass it into the constructor
-```js
-import { webcrypto } from "crypto";
-const api = await remarkable(token, { digest: webcrypto.subtle.digest });
-```
-
-You also need to have a globally defined fetch. There are several ways to
-accomplish this. In node 17.5 or higher you can enable global fetch with 
+This uses web standards by default, so using within node takes a little more effort. You also need to have a globally defined fetch. There are several ways to
+accomplish this. In node 17.5 or higher you can enable global fetch with
 `node --experimental-fetch`
 
 You can also rely on `"node-fetch"` which is compliant enough
+
 ```js
 import fetch from "node-fetch";
 global.fetch = fetch;
 ```
+
 or
+
 ```js
 import fetch from "node-fetch";
 const api = await remarkable(token, { fetch });
 ```
 
-### Newer API
-
-Recently I discovered the API the the Read on Remarkable extension uses, which
-bypasses the syncing and fetching of the root hash. These APIs are pretty
-limited but can be an easy first step.
-
-```js
-import { remarkable } from "rmapi-js";
-
-const api = await remarkable(...);
-// all the files and folders stored on the reMarkable, no roothash necessary
-const entries = await api.getEntriesMetadata();
-// upload epubs and pdfs without root hash
-// NOTE pdfs aren't currently working as expected
-// NOTE epub options aren't supported
-await api.uploadEpub("name", buffer);
-await api.uploadPdf("name", buffer);
-```
-
+### Gotchas
 
-Design
-------
+By default, all calls try to do their best to verify that the input and output matches what I expect. However, since I reverse-engineered this, some of it could be wrong. If you ever run into a `ValidationError` and know you want whatever data is returned, simply pass `{ verify: false }` in the options to that API, and that should temporarily remove the blocker. However note that in instances like this, the typescript types will be wrong.
 
-Building a full syncing version of the remarkable filesystem from the cloud API
-is a project in and of itself, so I opted to only implement the primative calls
-which should still be possible to compose into advanced functionality.
+## Contributing
 
-In order to make this as easily cross platform as possible, web standards were
-chosen as the basis since they enjoy relative adoption in node. However, node
-has middling support of webstreams and since none of the reading or writing is
-that intensive or doesn't already require the whole file in memory, we opted to
-process strings or ArrayBuffers ignoring Readable and WriteableStreams for the
-time being.
+Thie current API provides high level limited access. I'd love to reverse engineer what the apps use so this can one again tweak document settings as well as download files. Any help doing this or suggesting approaches would be grealy appreciated!