Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/benoitsepe/reMarkable-typescript
A typescript reMarkable Cloud API
https://github.com/benoitsepe/reMarkable-typescript
Last synced: 3 months ago
JSON representation
A typescript reMarkable Cloud API
- Host: GitHub
- URL: https://github.com/benoitsepe/reMarkable-typescript
- Owner: benoitsepe
- License: mit
- Created: 2020-01-17T21:19:08.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-09-05T19:06:54.000Z (about 1 year ago)
- Last Synced: 2024-05-21T00:02:35.074Z (6 months ago)
- Language: TypeScript
- Size: 384 KB
- Stars: 95
- Watchers: 3
- Forks: 19
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-reMarkable - reMarkable-typescript - TypeScript API for reMarkable Cloud. (APIs / Cloud API)
README
# reMarkable-typescript
This project was inspired by the work of https://github.com/kevlened/remarkable-node, adding typing and new features like the upload of a document.
Unofficial reMarkable api wrapper for node.js based on [these unofficial docs](https://github.com/splitbrain/ReMarkableAPI/wiki).
This module is typed for TypeScript, but you can still use JavaScript with it.
## Installation
```bash
yarn add remarkable-typescript
# OR
npm install remarkable-typescript
```
Then, go to [reMarkable's website](https://my.remarkable.com/connect/remarkable) to genereate a code to pair your reMarkable. This code is only available 5 minutes.
## Example
```ts
import { Remarkable, ItemResponse } from 'remarkable-typescript';
// const { Remarkable, ItemResponse } = require('remarkable-typescript');
const fs = require('fs');
(async () => {
/*
* Create the reMarkable client
* Params: { deviceToken?: string }
* Returns: client: Remarkable
*/
const client = new Remarkable();
/*
* Register your reMarkable and generate a device token. You must do this first to pair your device if you didn't specify a token. This may take a few seconds to complete. It seems that the deviceToken never expires.
* Params: { code: string }
* Returns: deviceToken: string
*/
const deviceToken = await client.register({ code: 'created code' });
// (optional) skip registration in the future with `new Remarkable({deviceToken})`
console.log(deviceToken);
/*
* (Re)generate a token from the deviceToken. You MUST call this function after creating the client. This token, used to interact with storage, is different from the deviceToken. This function is automatically called in register(). This token expires.
* Params: none
* Returns: token: string
*/
await client.refreshToken();
/*
* List all items, files and folders.
* Params: none
* Returns: ItemResponse[]
*/
const items = await client.getAllItems();
/*
* Get an item by id
* Params: id: string
* Returns: ItemResponse | null
*/
const item = await client.getItemWithId('some uuid');
/*
* Delete an item by is ID and document version
* Params: id: string, version: number
* Returns: success: boolean
*/
await client.deleteItem('some uuid', 1);
const myPDF = fs.readFileSync('./my/PDF/location.pdf');
/*
* Upload a PDF to your reMarkable
* Params: name: string, file: Buffer
* Returns: id: string
*/
const pdfUploadedId = await client.uploadPDF('name of PDF document', ID: '181a124b-bbdf-4fdd-8310-64fa87bc9c7f', pdfFileBuffer, /*optional UUID of parent folder*/);
/*
* Download a ZIP file to your reMarkable (with the annotations)
* Params: id: string
* Returns: Buffer
*/
const zipFile = await client.downloadZip(pdfUploadedId);
/*
* Upload a ZIP file to your reMarkable (must be a supported reMarkable format). You can generate the ID using uuidv4.
* Params: name: string, id: string, zipFile: Buffer
* Returns: id: string
*/
const zipFileId = await client.uploadZip('My document name', ID: 'f831481c-7d2d-4776-922d-36e708d9d680', zipFile);
/*
* Upload an ePub file to your reMarkable (must be a supported reMarkable format). You can generate the ID using uuidv4 or v5. v5 will deterministically generate a uuid based on name and namespace .
* Params: name: string, id: string, epubFileBuffer: Buffer, parent?: string
* Returns: id: string
*/
const epubDocId = await client.uploadEPUB('name of ePub document', ID: '181a124b-bbdf-4fdd-8310-64fa87bc9c7f', epubFileBuffer, /*optional UUID of parent folder*/);
/*
* Create a directory
* Params: name: string, id: string, epubFileBuffer: Buffer, parent?: string
* Returns: id: string
*/
const directoryId = await client.createDirectory('testDir2', id, ID: '702ba145-0a78-4e19-9324-6f8fb3da3c1a', /*optional UUID of parent folder*/);
})();
```
## License
MIT