rmapi-js 14.0.0 → 14.2.0

package/dist/raw.js

@@ -66,14 +66,14 @@ const tag = z
     name: z.string(),
     timestamp: z.number(),
 })
-    .passthrough();
+    .loose();
 const pageTag = z
     .object({
     name: z.string(),
     pageId: z.string(),
     timestamp: z.number(),
 })
-    .passthrough();
+    .loose();
 const documentMetadata = z
     .object({
     authors: z.array(z.string()).optional(),
@@ -81,53 +81,51 @@ const documentMetadata = z
     publicationDate: z.string().optional(),
     publisher: z.string().optional(),
 })
-    .passthrough();
+    .loose();
 const cPagePage = z
     .object({
     id: z.string(),
-    idx: z.object({ timestamp: z.string(), value: z.string() }).passthrough(),
+    idx: z.object({ timestamp: z.string(), value: z.string() }).loose(),
     template: z
         .object({ timestamp: z.string(), value: z.string() })
-        .passthrough()
+        .loose()
         .optional(),
     redir: z
         .object({ timestamp: z.string(), value: z.number().int() })
-        .passthrough()
+        .loose()
         .optional(),
     scrollTime: z
         .object({
         timestamp: z.string(),
-        value: z.string().datetime({ offset: true }),
+        value: z.iso.datetime({ offset: true }),
     })
-        .passthrough()
+        .loose()
         .optional(),
     verticalScroll: z
         .object({ timestamp: z.string(), value: z.number() })
-        .passthrough()
+        .loose()
         .optional(),
     deleted: z
         .object({ timestamp: z.string(), value: z.number().int() })
-        .passthrough()
+        .loose()
         .optional(),
     modifed: z.string().optional(),
 })
-    .passthrough();
+    .loose();
 const cPages = z
     .object({
-    lastOpened: z
-        .object({ timestamp: z.string(), value: z.string() })
-        .passthrough(),
+    lastOpened: z.object({ timestamp: z.string(), value: z.string() }).loose(),
     original: z
         .object({ timestamp: z.string(), value: z.number().int() })
-        .passthrough(),
+        .loose(),
     pages: z.array(cPagePage),
     uuids: z
         .array(z
         .object({ first: z.string(), second: z.number().int().nonnegative() })
-        .passthrough())
+        .loose())
         .nullable(),
 })
-    .passthrough();
+    .loose();
 const collectionContent = z
     .object({
     tags: z.array(tag).optional(),
@@ -162,7 +160,7 @@ const documentContentOptional = {
     formatVersion: z.number().int().nonnegative().optional(),
     keyboardMetadata: z
         .object({ count: z.number().int().nonnegative(), timestamp: z.number() })
-        .passthrough()
+        .loose()
         .optional(),
     lastOpenedPage: z.number().int().optional(),
     margins: z.number().int().nonnegative().optional(),
@@ -183,7 +181,7 @@ const documentContentOptional = {
         m32: z.number().optional(),
         m33: z.number().optional(),
     })
-        .passthrough()
+        .loose()
         .optional(),
     viewBackgroundFilter: z.enum(["off", "fullpage"]).optional(),
     zoomMode: z
@@ -192,13 +190,13 @@ const documentContentOptional = {
 };
 const commonDocumentContent = z
     .object({ ...documentContentRequired, ...documentContentOptional })
-    .passthrough();
+    .loose();
 const documentContent = commonDocumentContent
     .extend({ tags: z.array(tag).optional() })
-    .passthrough();
+    .loose();
 const legacyDocumentContent = commonDocumentContent
     .extend({ tags: z.array(z.string()).optional() })
-    .passthrough();
+    .loose();
 const templateContent = z
     .object({
     id: z.string().optional(),
@@ -216,7 +214,7 @@ const templateContent = z
     items: z.array(z.unknown()),
     formatVersion: z.number().int().nonnegative().optional(),
 })
-    .passthrough();
+    .loose();
 // content payloads aren't discriminable (legacy/modern differ only by tags
 // element type), so this is an ordered union: the first matching variant wins
 const content = z.union([
@@ -242,17 +240,17 @@ const highlightsFile = z
             width: z.number(),
             height: z.number(),
         })
-            .passthrough()),
+            .loose()),
     })
-        .passthrough())),
+        .loose())),
 })
-    .passthrough();
+    .loose();
 const pageMetadataReg = /\/[^/]+-metadata\.json$/;
 const pageMetadata = z
     .object({
-    layers: z.array(z.object({ name: z.string() }).passthrough()),
+    layers: z.array(z.object({ name: z.string() }).loose()),
 })
-    .passthrough();
+    .loose();
 const metadata = z
     .object({
     lastModified: z.string().optional(),
@@ -271,7 +269,7 @@ const metadata = z
     new: z.boolean().optional(),
     source: z.string().optional(),
 })
-    .passthrough();
+    .loose();
 /** parse and validate the json text of a `.metadata` file */
 export function parseMetadata(text) {
     const loaded = JSON.parse(text);
@@ -282,20 +280,20 @@ const updatedRootHash = z
     hash: z.string(),
     generation: z.number(),
 })
-    .passthrough();
+    .loose();
 const rootHash = z
     .object({
     hash: z.string(),
     generation: z.number(),
     schemaVersion: z.number().int().nonnegative(),
 })
-    .passthrough();
+    .loose();
 const nativeItemRef = z
     .object({
     docID: z.string(),
     hash: z.string(),
 })
-    .passthrough();
+    .loose();
 async function digest(buff) {
     const digest = await crypto.subtle.digest("SHA-256", 
     // NOTE this is type hinted wrong, but it does work correctly on a uint8 view
@@ -389,6 +387,7 @@ function parseRawEntryLine(line) {
  */
 export class RawRemarkable {
     #authedFetch;
+    #authedSocket;
     #rawHost;
     #uploadHost;
     /**
@@ -402,8 +401,9 @@ export class RawRemarkable {
      */
     #cache;
     #maxCachedBytes;
-    constructor(authedFetch, cache, rawHost, uploadHost, maxCachedBytes) {
+    constructor(authedFetch, authedSocket, cache, rawHost, uploadHost, maxCachedBytes) {
         this.#authedFetch = authedFetch;
+        this.#authedSocket = authedSocket;
         this.#cache = cache;
         this.#rawHost = rawHost;
         this.#uploadHost = uploadHost;
@@ -867,6 +867,22 @@ export class RawRemarkable {
         const { docID, hash } = nativeItemRef.parse(loaded);
         return { id: docID, hash };
     }
+    /**
+     * open the websocket reMarkable pushes notifications to
+     *
+     * The server drops the socket every few minutes, so anything long lived has
+     * to reopen it. {@link RemarkableApi.listen | `listen`} does that, and parses
+     * the sync notifications out of what arrives.
+     *
+     * reMarkable authorizes the handshake with a header, which node and bun can
+     * attach but a browser's `WebSocket` can't, so this is server side only.
+     *
+     * @returns the connecting socket
+     */
+    notifications() {
+        const host = this.#rawHost.replace(/^http/, "ws");
+        return this.#authedSocket(`${host}/notifications/ws/json/1`);
+    }
     /**
      * dump the current cache to a string to preserve between session
      *