@mnemosyne_os/affine-reader 0.1.0 → 0.1.2

package/LICENSE-AFFiNE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022-present TOEVERYTHING PTE. LTD. and its affiliates.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/NOTICE.md

@@ -3,7 +3,10 @@
 ## AFFiNE — `src/vendor/affine/`
 
 Copyright (c) 2022-present TOEVERYTHING PTE. LTD. and its affiliates.
-Licensed under the **MIT License**.
+Licensed under the **MIT License**, whose full text ships beside this file as
+[`LICENSE-AFFiNE`](./LICENSE-AFFiNE). The MIT License asks that the copyright
+notice **and the permission notice** travel with the code, so both are included
+verbatim rather than merely referenced.
 
 | | |
 |---|---|

package/README.md

@@ -46,7 +46,8 @@ answers** — nothing to read versus AFFiNE not installed. Both are reported.
 
 ### Bring your own SQLite
 
-`openNodeSqlite` uses Node's built-in `node:sqlite`, which needs **Node ≥ 22.5**.
+`openNodeSqlite` uses Node's built-in `node:sqlite`, which runs without a flag from
+**Node 22.13** and **23.4** onward. It exists from 22.5 behind `--experimental-sqlite`.
 Electron 31 ships Node 20 and has none, so a host passes its own adapter:
 
 ```ts
@@ -61,7 +62,8 @@ readWorkspace({ prepare: (sql) => raw.prepare(sql), close: () => raw.close() });
 
 | | |
 |---|---|
-| Location | `<app-data>/AFFiNE/<workspaces\|userspaces>/<peer>/<id>/storage.db` |
+| Location | `<app-data>/AFFiNE*/<workspaces\|userspaces>/<peer>/<id>/storage.db` |
+| Channels | every one you have installed. AFFiNE's build names the folder `AFFiNE` for a stable release and `AFFiNE-canary`, `AFFiNE-beta`, `AFFiNE-internal` otherwise, and most of their releases are canary |
 | Schema | nbstore `v2` (`snapshots` + `updates` + `blobs`), and the legacy `v1` shape |
 | Content | Yjs history replayed into a document, rendered by AFFiNE's own MIT parser |
 

package/dist/cli.d.ts

@@ -8,7 +8,9 @@
  * actually live) before a byte is read, and nothing is ever written back into
  * AFFiNE's directory.
  *
- * ⚠️ Needs Node >= 22.5 for `node:sqlite`. It says so rather than failing with
- * an opaque module error.
+ * ⚠️ Needs `node:sqlite` without a flag, which means Node >= 22.13 (or >= 23.4).
+ * The module landed in 22.5 behind `--experimental-sqlite` and was unflagged in
+ * 22.13.0 / 23.4.0, so "22.5" as the boundary is wrong and produces a message
+ * that contradicts itself on 22.11: "needs >= 22.5, this is v22.11".
  */
 export declare function runCli(argv?: string[]): number;

package/dist/cli.js

@@ -9,8 +9,10 @@
  * actually live) before a byte is read, and nothing is ever written back into
  * AFFiNE's directory.
  *
- * ⚠️ Needs Node >= 22.5 for `node:sqlite`. It says so rather than failing with
- * an opaque module error.
+ * ⚠️ Needs `node:sqlite` without a flag, which means Node >= 22.13 (or >= 23.4).
+ * The module landed in 22.5 behind `--experimental-sqlite` and was unflagged in
+ * 22.13.0 / 23.4.0, so "22.5" as the boundary is wrong and produces a message
+ * that contradicts itself on 22.11: "needs >= 22.5, this is v22.11".
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.runCli = runCli;
@@ -29,7 +31,11 @@ function runCli(argv = process.argv.slice(2)) {
         return outDir ? 0 : 2;
     }
     if (!(0, nodeSqlite_1.hasNodeSqlite)()) {
-        console.error(`This tool needs Node >= 22.5 (for node:sqlite); this is ${process.version}.`);
+        // Says what is missing and what to do, rather than a version rule the running
+        // version can appear to satisfy.
+        console.error(`node:sqlite is not available in this runtime (${process.version}).`);
+        console.error('Use Node 22.13+ or 23.4+, where it needs no flag.');
+        console.error('On Node 22.5 to 22.12 it exists behind --experimental-sqlite.');
         return 1;
     }
     const dataDir = (0, locate_1.affineDataDir)();

package/dist/exportMarkdown.d.ts

@@ -37,6 +37,7 @@ export declare function fileNameFor(title: string, docId: string): string;
 export declare function workspaceFolderName(ref: {
     id: string;
     peer: string;
+    channel?: string;
 }): string;
 /**
  * Read `db` and write one Markdown file per doc into `outDir`.

package/dist/exportMarkdown.js

@@ -41,7 +41,12 @@ function fileNameFor(title, docId) {
  * doors cannot resolve the same workspace to two different directories.
  */
 function workspaceFolderName(ref) {
-    return `affine-${slugify(ref.peer, 'peer')}-${slugify(ref.id, 'id')}`;
+    // The channel joins the name for the same reason the peer did: a stable install
+    // and a canary one can both hold a workspace with this id. The stable channel
+    // adds nothing, so its folders keep the plain shape.
+    const channel = ref.channel && ref.channel !== 'AFFiNE' ? ref.channel.replace(/^AFFiNE-/, '') : '';
+    const parts = ['affine', channel && slugify(channel, 'channel'), slugify(ref.peer, 'peer'), slugify(ref.id, 'id')];
+    return parts.filter(Boolean).join('-');
 }
 function blobFileName(key, mime) {
     const ext = (mime.split('/')[1] ?? 'bin').replace('+xml', '').replace(/[^a-z0-9]/gi, '');

package/dist/index.d.ts

@@ -7,7 +7,7 @@
  *
  * ⛔ READ ONLY, in every direction. Two processes writing one CRDT corrupt it.
  */
-export { affineDataDir, findWorkspaces } from './locate';
+export { affineDataDir, affineDataDirs, findWorkspaces } from './locate';
 export { SIDECAR_SUFFIXES, stageDatabase } from './stage';
 export type { StagedDatabase } from './stage';
 export { detectSchema, forEachBlob, loadDoc, readBlobIndex, readDocIndex, readWorkspace, readWorkspaceId, } from './read';

package/dist/index.js

@@ -9,9 +9,10 @@
  * ⛔ READ ONLY, in every direction. Two processes writing one CRDT corrupt it.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.openNodeSqlite = exports.hasNodeSqlite = exports.workspaceFolderName = exports.slugify = exports.fileNameFor = exports.exportWorkspace = exports.readWorkspaceId = exports.readWorkspace = exports.readDocIndex = exports.readBlobIndex = exports.loadDoc = exports.forEachBlob = exports.detectSchema = exports.stageDatabase = exports.SIDECAR_SUFFIXES = exports.findWorkspaces = exports.affineDataDir = void 0;
+exports.openNodeSqlite = exports.hasNodeSqlite = exports.workspaceFolderName = exports.slugify = exports.fileNameFor = exports.exportWorkspace = exports.readWorkspaceId = exports.readWorkspace = exports.readDocIndex = exports.readBlobIndex = exports.loadDoc = exports.forEachBlob = exports.detectSchema = exports.stageDatabase = exports.SIDECAR_SUFFIXES = exports.findWorkspaces = exports.affineDataDirs = exports.affineDataDir = void 0;
 var locate_1 = require("./locate");
 Object.defineProperty(exports, "affineDataDir", { enumerable: true, get: function () { return locate_1.affineDataDir; } });
+Object.defineProperty(exports, "affineDataDirs", { enumerable: true, get: function () { return locate_1.affineDataDirs; } });
 Object.defineProperty(exports, "findWorkspaces", { enumerable: true, get: function () { return locate_1.findWorkspaces; } });
 var stage_1 = require("./stage");
 Object.defineProperty(exports, "SIDECAR_SUFFIXES", { enumerable: true, get: function () { return stage_1.SIDECAR_SUFFIXES; } });

package/dist/locate.d.ts

@@ -12,7 +12,20 @@
  * available. `layout` says which one a ref came from so a caller can tell them apart.
  */
 import type { WorkspaceRef } from './types';
-/** Root of AFFiNE's application data, or null when the app was never installed here. */
+/**
+ * Every AFFiNE data directory on this machine, one per release channel.
+ *
+ * 🚨 There is more than one, and missing that is how this tool tells someone who
+ * clearly has AFFiNE installed that they do not. Their build script sets
+ * `productName = stableBuild ? 'AFFiNE' : 'AFFiNE-<buildType>'`, so a canary,
+ * beta or internal build keeps its workspaces in `AFFiNE-canary` and friends.
+ * Most of AFFiNE's own releases are canary, so that is not an edge case.
+ */
+export declare function affineDataDirs(env?: NodeJS.ProcessEnv, platform?: NodeJS.Platform): string[];
+/**
+ * The stable channel's data directory, or the first channel found, or null when
+ * AFFiNE was never installed here. Kept for callers that want one path to show.
+ */
 export declare function affineDataDir(env?: NodeJS.ProcessEnv, platform?: NodeJS.Platform): string | null;
 /**
  * Every workspace reachable on this machine. Never throws for a missing AFFiNE —

package/dist/locate.js

@@ -13,23 +13,47 @@
  * available. `layout` says which one a ref came from so a caller can tell them apart.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.affineDataDirs = affineDataDirs;
 exports.affineDataDir = affineDataDir;
 exports.findWorkspaces = findWorkspaces;
 const node_fs_1 = require("node:fs");
 const node_path_1 = require("node:path");
 const SPACE_DIRS = ['workspaces', 'userspaces'];
-/** Root of AFFiNE's application data, or null when the app was never installed here. */
-function affineDataDir(env = process.env, platform = process.platform) {
+/** Where Electron puts application data for this platform. */
+function appDataRoot(env, platform) {
     const home = env.HOME ?? env.USERPROFILE ?? '';
     const base = platform === 'win32'
         ? env.APPDATA
         : platform === 'darwin'
             ? home && (0, node_path_1.join)(home, 'Library', 'Application Support')
             : (env.XDG_CONFIG_HOME ?? (home && (0, node_path_1.join)(home, '.config')));
+    return base || null;
+}
+/**
+ * Every AFFiNE data directory on this machine, one per release channel.
+ *
+ * 🚨 There is more than one, and missing that is how this tool tells someone who
+ * clearly has AFFiNE installed that they do not. Their build script sets
+ * `productName = stableBuild ? 'AFFiNE' : 'AFFiNE-<buildType>'`, so a canary,
+ * beta or internal build keeps its workspaces in `AFFiNE-canary` and friends.
+ * Most of AFFiNE's own releases are canary, so that is not an edge case.
+ */
+function affineDataDirs(env = process.env, platform = process.platform) {
+    const base = appDataRoot(env, platform);
     if (!base)
-        return null;
-    const dir = (0, node_path_1.join)(base, 'AFFiNE');
-    return (0, node_fs_1.existsSync)(dir) ? dir : null;
+        return [];
+    return safeReaddir(base)
+        .filter((name) => name === 'AFFiNE' || name.startsWith('AFFiNE-'))
+        .map((name) => (0, node_path_1.join)(base, name))
+        .filter(isDir)
+        .sort((a, b) => a.length - b.length); // stable channel first, it is the shortest
+}
+/**
+ * The stable channel's data directory, or the first channel found, or null when
+ * AFFiNE was never installed here. Kept for callers that want one path to show.
+ */
+function affineDataDir(env = process.env, platform = process.platform) {
+    return affineDataDirs(env, platform)[0] ?? null;
 }
 function isDir(path) {
     try {
@@ -48,29 +72,34 @@ function isDir(path) {
  * is installed at all. The two are different answers and callers need both.
  */
 function findWorkspaces(opts = {}) {
-    const dataDir = opts.dataDir === undefined ? affineDataDir() : opts.dataDir;
-    if (!dataDir || !isDir(dataDir))
-        return [];
+    // Every channel by default (AFFiNE, AFFiNE-canary, AFFiNE-beta …); one directory
+    // when a caller names it, which is what the tests do.
+    const dataDirs = opts.dataDir === undefined ? affineDataDirs() : opts.dataDir ? [opts.dataDir] : [];
     const found = [];
-    for (const kindDir of SPACE_DIRS) {
-        const kind = kindDir === 'workspaces' ? 'workspace' : 'userspace';
-        const root = (0, node_path_1.join)(dataDir, kindDir);
-        if (!isDir(root))
+    for (const dataDir of dataDirs) {
+        if (!isDir(dataDir))
             continue;
-        for (const entry of safeReaddir(root)) {
-            const entryPath = (0, node_path_1.join)(root, entry);
-            if (!isDir(entryPath))
-                continue;
-            // v1 put storage.db directly under the workspace id; v2 inserted a <peer> level.
-            const v1Db = (0, node_path_1.join)(entryPath, 'storage.db');
-            if ((0, node_fs_1.existsSync)(v1Db)) {
-                found.push({ id: entry, peer: 'local', kind, dbPath: v1Db, layout: 'v1' });
+        const channel = (0, node_path_1.basename)(dataDir);
+        for (const kindDir of SPACE_DIRS) {
+            const kind = kindDir === 'workspaces' ? 'workspace' : 'userspace';
+            const root = (0, node_path_1.join)(dataDir, kindDir);
+            if (!isDir(root))
                 continue;
-            }
-            for (const workspaceId of safeReaddir(entryPath)) {
-                const dbPath = (0, node_path_1.join)(entryPath, workspaceId, 'storage.db');
-                if ((0, node_fs_1.existsSync)(dbPath))
-                    found.push({ id: workspaceId, peer: entry, kind, dbPath, layout: 'v2' });
+            for (const entry of safeReaddir(root)) {
+                const entryPath = (0, node_path_1.join)(root, entry);
+                if (!isDir(entryPath))
+                    continue;
+                // v1 put storage.db directly under the workspace id; v2 inserted a <peer> level.
+                const v1Db = (0, node_path_1.join)(entryPath, 'storage.db');
+                if ((0, node_fs_1.existsSync)(v1Db)) {
+                    found.push({ id: entry, peer: 'local', kind, dbPath: v1Db, layout: 'v1', channel });
+                    continue;
+                }
+                for (const workspaceId of safeReaddir(entryPath)) {
+                    const dbPath = (0, node_path_1.join)(entryPath, workspaceId, 'storage.db');
+                    if ((0, node_fs_1.existsSync)(dbPath))
+                        found.push({ id: workspaceId, peer: entry, kind, dbPath, layout: 'v2', channel });
+                }
             }
         }
     }

package/dist/nodeSqlite.d.ts

@@ -1,10 +1,11 @@
 /**
  * A read-only SQLite adapter backed by Node's built-in `node:sqlite`.
  *
- * ⚠️ `node:sqlite` landed in Node 22.5. Electron 31 ships Node 20, so the app CANNOT
- * use this one — it passes an adapter over its own better-sqlite3. This exists for
- * scripts and tests, and it says so when the runtime cannot provide it instead of
- * failing with an opaque module error.
+ * ⚠️ `node:sqlite` landed in Node 22.5 behind `--experimental-sqlite` and was
+ * unflagged in 22.13.0 / 23.4.0, so the usable floor is 22.13. Electron 31 ships
+ * Node 20 and has none of it, which is why the app passes an adapter over its own
+ * better-sqlite3. This exists for scripts and tests, and it says what is missing
+ * instead of failing with an opaque module error.
  */
 import type { SqliteOpener } from './types';
 /** True when this runtime can provide `node:sqlite`. */

package/dist/nodeSqlite.js

@@ -2,10 +2,11 @@
 /**
  * A read-only SQLite adapter backed by Node's built-in `node:sqlite`.
  *
- * ⚠️ `node:sqlite` landed in Node 22.5. Electron 31 ships Node 20, so the app CANNOT
- * use this one — it passes an adapter over its own better-sqlite3. This exists for
- * scripts and tests, and it says so when the runtime cannot provide it instead of
- * failing with an opaque module error.
+ * ⚠️ `node:sqlite` landed in Node 22.5 behind `--experimental-sqlite` and was
+ * unflagged in 22.13.0 / 23.4.0, so the usable floor is 22.13. Electron 31 ships
+ * Node 20 and has none of it, which is why the app passes an adapter over its own
+ * better-sqlite3. This exists for scripts and tests, and it says what is missing
+ * instead of failing with an opaque module error.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.openNodeSqlite = void 0;
@@ -37,8 +38,8 @@ const openNodeSqlite = (path) => {
         mod = (0, node_module_1.createRequire)(__filename)('node:sqlite');
     }
     catch (error) {
-        throw new Error('node:sqlite is unavailable in this runtime (it needs Node >= 22.5; Electron 31 ships Node 20). ' +
-            'Pass your own SqliteOpener instead. Cause: ' +
+        throw new Error('node:sqlite is unavailable in this runtime (unflagged from Node 22.13 and 23.4; ' +
+            'Electron 31 ships Node 20). Pass your own SqliteOpener instead. Cause: ' +
             (error instanceof Error ? error.message : String(error)));
     }
     const db = new mod.DatabaseSync(path);

package/dist/types.d.ts

@@ -30,6 +30,12 @@ export interface WorkspaceRef {
     /** Absolute path to `storage.db`. */
     dbPath: string;
     layout: AffineSchema;
+    /**
+     * Which AFFiNE build this workspace belongs to: `AFFiNE` for a stable install,
+     * `AFFiNE-canary`, `AFFiNE-beta`, `AFFiNE-internal` for the other channels.
+     * Someone can have several installed at once, each with its own workspaces.
+     */
+    channel: string;
 }
 export interface AffineDoc {
     id: string;

package/package.json

@@ -1,14 +1,13 @@
 {
   "name": "@mnemosyne_os/affine-reader",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Read a local AFFiNE workspace (SQLite + Yjs) and render its documents to Markdown. No BlockSuite at runtime, no native module, read-only.",
   "license": "MIT",
   "author": "Tony Trochet <tony@xpacegems.com> (https://xpacegems.com)",
   "homepage": "https://mnemosyne-os.io",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/Mnemosyne-OS/Mnemosyne-Neural-OS.git",
-    "directory": "packages/affine-reader"
+    "url": "git+https://github.com/Mnemosyne-OS/Mnemosyne-Neural-OS.git"
   },
   "bugs": {
     "url": "https://github.com/Mnemosyne-OS/Mnemosyne-Neural-OS/issues"
@@ -39,7 +38,8 @@
     "dist",
     "README.md",
     "NOTICE.md",
-    "LICENSE"
+    "LICENSE",
+    "LICENSE-AFFiNE"
   ],
   "sideEffects": false,
   "publishConfig": {