@nesso-how/formats 0.1.0-alpha.20 → 0.1.0-alpha.22

package/README.md

@@ -0,0 +1,22 @@
+# @nesso-how/formats
+
+JSON serialize/deserialize for [Nesso](https://nesso.how) graph files.
+
+## Install
+
+```bash
+npm install @nesso-how/formats
+```
+
+## Usage
+
+```ts
+import { serializeGraph, deserializeGraph } from "@nesso-how/formats";
+
+const json = serializeGraph({ name: "My graph", nodes, edges });
+const file = deserializeGraph(json);
+```
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -1,6 +1,10 @@
 import type { Node, Edge } from '@xyflow/react';
 import type { ConceptNodeData, GraphDisplaySettings } from '@nesso-how/types';
 export interface NessoGraphFile {
+    /** Internal graph id (desktop sync); omitted in manual exports. */
+    id?: string;
+    /** Last save time (Unix ms); desktop sync metadata. */
+    updatedAt?: number;
     name: string;
     nodes: Node<ConceptNodeData>[];
     edges: Edge[];
@@ -8,3 +12,7 @@ export interface NessoGraphFile {
 }
 export declare function serializeGraph(file: NessoGraphFile): string;
 export declare function deserializeGraph(json: string): NessoGraphFile;
+/** Strip personal FSRS / review history for shareable graph export. Keeps text, elaboration, layout. */
+export declare function nodesForGraphShareExport(nodes: Node<ConceptNodeData>[]): Node<ConceptNodeData>[];
+/** Reset review fields on import so shared files never restore someone else's scheduling. */
+export declare function nodesFromGraphShareImport(nodes: Node<ConceptNodeData>[]): Node<ConceptNodeData>[];

package/dist/index.js

@@ -1,3 +1,4 @@
+import { defaultConceptReviewFields } from '@nesso-how/types';
 export function serializeGraph(file) {
     return JSON.stringify(file, null, 2);
 }
@@ -11,3 +12,22 @@ export function deserializeGraph(json) {
     }
     return data;
 }
+/** Strip personal FSRS / review history for shareable graph export. Keeps text, elaboration, layout. */
+export function nodesForGraphShareExport(nodes) {
+    const review = defaultConceptReviewFields();
+    return nodes.map(node => {
+        const { text, elaboration } = node.data ?? { text: '' };
+        return {
+            ...node,
+            data: {
+                text: text ?? '',
+                ...(elaboration ? { elaboration } : {}),
+                ...review,
+            },
+        };
+    });
+}
+/** Reset review fields on import so shared files never restore someone else's scheduling. */
+export function nodesFromGraphShareImport(nodes) {
+    return nodesForGraphShareExport(nodes);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nesso-how/formats",
-  "version": "0.1.0-alpha.20",
+  "version": "0.1.0-alpha.22",
   "description": "Nesso graph serialization formats — JSON serialize/deserialize",
   "license": "MIT",
   "type": "module",
@@ -15,7 +15,7 @@
   },
   "dependencies": {
     "@xyflow/react": "^12.6.4",
-    "@nesso-how/types": "0.1.0-alpha.20"
+    "@nesso-how/types": "0.1.0-alpha.22"
   },
   "devDependencies": {
     "typescript": "~5.8.3"

package/src/index.ts

@@ -1,8 +1,13 @@
 // SPDX-License-Identifier: MIT
 import type { Node, Edge } from '@xyflow/react'
 import type { ConceptNodeData, GraphDisplaySettings } from '@nesso-how/types'
+import { defaultConceptReviewFields } from '@nesso-how/types'
 
 export interface NessoGraphFile {
+  /** Internal graph id (desktop sync); omitted in manual exports. */
+  id?: string
+  /** Last save time (Unix ms); desktop sync metadata. */
+  updatedAt?: number
   name: string
   nodes: Node<ConceptNodeData>[]
   edges: Edge[]
@@ -25,3 +30,28 @@ export function deserializeGraph(json: string): NessoGraphFile {
   }
   return data as NessoGraphFile
 }
+
+/** Strip personal FSRS / review history for shareable graph export. Keeps text, elaboration, layout. */
+export function nodesForGraphShareExport(
+  nodes: Node<ConceptNodeData>[],
+): Node<ConceptNodeData>[] {
+  const review = defaultConceptReviewFields()
+  return nodes.map(node => {
+    const { text, elaboration } = node.data ?? { text: '' }
+    return {
+      ...node,
+      data: {
+        text: text ?? '',
+        ...(elaboration ? { elaboration } : {}),
+        ...review,
+      },
+    }
+  })
+}
+
+/** Reset review fields on import so shared files never restore someone else's scheduling. */
+export function nodesFromGraphShareImport(
+  nodes: Node<ConceptNodeData>[],
+): Node<ConceptNodeData>[] {
+  return nodesForGraphShareExport(nodes)
+}