rmapi-js 12.0.0 → 12.0.2

package/dist/index.d.ts

@@ -11,7 +11,7 @@ export interface EntryCommon extends ItemRef {
     /** the visible display name of this entry */
     visibleName: string;
     /** the last modified timestamp */
-    lastModified: string;
+    lastModified?: string;
     /** true if the entry is starred in most ui elements */
     pinned: boolean;
     /**

package/dist/raw.d.ts

@@ -329,6 +329,8 @@ export interface LegacyDocumentContent extends CommonDocumentContent {
  * metadata about it.
  */
 export interface TemplateContent {
+    /** the template's own id, when present */
+    id?: string;
     /** the template name */
     name: string;
     /** the template's author */
@@ -338,7 +340,7 @@ export interface TemplateContent {
     /** category names this template belongs to (eg: "Planning", "Productivity") */
     categories: string[];
     /** labels associated with this template (eg: "Project management") */
-    labels: string[];
+    labels?: string[];
     /** the orientation of this template */
     orientation: "portrait" | "landscape";
     /** semantic version for this template */
@@ -351,10 +353,15 @@ export interface TemplateContent {
      * - `rm2`: reMarkable 2
      * - `rmPP`: reMarkable Paper Pro
      */
-    supportedScreens: ("rm2" | "rmPP")[];
-    /** constant values used by the commands in `items` */
+    supportedScreens?: ("rm2" | "rmPP")[];
+    /**
+     * named constants used by the `items` DSL
+     *
+     * A value is either a literal number or an expression string that references
+     * other constants and `templateWidth`, e.g. `"templateWidth - (offsetX * 2)"`.
+     */
     constants?: {
-        [name: string]: number;
+        [name: string]: number | string;
     }[];
     /** the template definition, an SVG-like DSL in JSON */
     items: object[];
@@ -370,17 +377,17 @@ export interface Metadata {
     /** creation time, a string of the epoch timestamp */
     createdTime?: string;
     /** [speculative] true if the item has been actually deleted */
-    deleted?: boolean;
+    deleted?: boolean | null;
     /** the last modify time, the string of the epoch timestamp */
-    lastModified: string;
+    lastModified?: string;
     /** the last opened epoch timestamp, isn't defined for CollectionType */
     lastOpened?: string;
     /** the last page opened, isn't defined for CollectionType, starts at 0*/
     lastOpenedPage?: number;
     /** [speculative] true if the metadata has been modified */
-    metadatamodified?: boolean;
+    metadatamodified?: boolean | null;
     /** [speculative] true if the item has been modified */
-    modified?: boolean;
+    modified?: boolean | null;
     /**
      * the id of the parent collection
      *
@@ -391,7 +398,7 @@ export interface Metadata {
     /** true of the item is starred */
     pinned: boolean;
     /** [unknown] */
-    synced?: boolean;
+    synced?: boolean | null;
     /**
      * the type of item this corresponds to
      *

package/dist/raw.js

@@ -174,19 +174,22 @@ const legacyDocumentContent = commonDocumentContent
     .passthrough();
 const templateContent = z
     .object({
+    id: z.string().optional(),
     name: z.string(),
     author: z.string(),
     iconData: z.string(),
     categories: z.array(z.string()),
-    labels: z.array(z.string()),
+    labels: z.array(z.string()).optional(),
     orientation: z.enum(["portrait", "landscape"]),
     templateVersion: z.string(),
-    supportedScreens: z.array(z.enum(["rm2", "rmPP"])),
-    constants: z.array(z.record(z.string(), z.number().int())).optional(),
+    supportedScreens: z.array(z.enum(["rm2", "rmPP"])).optional(),
+    constants: z
+        .array(z.record(z.string(), z.union([z.number(), z.string()])))
+        .optional(),
     items: z.array(z.unknown()),
     formatVersion: z.number().int().nonnegative().optional(),
 })
-    .strict();
+    .passthrough();
 // 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([
@@ -198,7 +201,7 @@ const content = z.union([
 ]);
 const metadata = z
     .object({
-    lastModified: z.string(),
+    lastModified: z.string().optional(),
     parent: z.string(),
     pinned: z.boolean(),
     type: z.enum(["DocumentType", "CollectionType", "TemplateType"]),
@@ -206,10 +209,10 @@ const metadata = z
     lastOpened: z.string().optional(),
     lastOpenedPage: z.number().int().optional(),
     createdTime: z.string().optional(),
-    deleted: z.boolean().optional(),
-    metadatamodified: z.boolean().optional(),
-    modified: z.boolean().optional(),
-    synced: z.boolean().optional(),
+    deleted: z.boolean().nullish(),
+    metadatamodified: z.boolean().nullish(),
+    modified: z.boolean().nullish(),
+    synced: z.boolean().nullish(),
     version: z.number().int().nonnegative().optional(),
     new: z.boolean().optional(),
     source: z.string().optional(),