feat: add JMAP FileNode file storage backend and file settings
- Implement JMAP FileNode client methods (get, query, list, create, update, destroy, copy) with Stalwart-compatible flat name encoding - Add FileNode/FileNodeFilter types to JMAP type definitions - Create file-store with Zustand for file management state (navigate, upload, delete, rename, move, cut/copy/paste, undo, favorites) - Add folder tree sidebar component for sidebar navigation layout - Add files settings dialog and settings page component with options for view mode, sort, icons, thumbnails, hidden files, folder layout - Update files page and file browser to support JMAP FileNode backend alongside WebDAV, with folder layout switching and settings integration - Add settings tab for files configuration in the settings page - Add translation keys for file settings, calendar subscriptions, identity deletion, contact deletion, email navigation, and reconnection messages across all 8 locales - Change WebDAV file storage to File storage in availability messages - Enhance translations test to verify source-referenced keys exist in the en locale - Fix duplicate JSX attribute in folder-tree-sidebar
This commit is contained in:
Linus Rath
@@ -2,7 +2,8 @@ import fs from 'fs';
|
||||
import path from 'path';
|
||||
import { describe, expect, it } from 'vitest';
|
||||
|
||||
const localesDir = path.resolve(__dirname, '../../locales');
|
||||
const rootDir = path.resolve(__dirname, '../..');
|
||||
const localesDir = path.join(rootDir, 'locales');
|
||||
const referenceLocale = 'en';
|
||||
|
||||
function getLeafKeys(obj: Record<string, unknown>, prefix = ''): string[] {
|
||||
@@ -24,11 +25,74 @@ function loadLocale(locale: string): Record<string, unknown> {
|
||||
return JSON.parse(fs.readFileSync(filePath, 'utf-8'));
|
||||
}
|
||||
|
||||
function resolveKey(obj: Record<string, unknown>, key: string): unknown {
|
||||
return key.split('.').reduce<unknown>((o, p) => (o && typeof o === 'object' ? (o as Record<string, unknown>)[p] : undefined), obj);
|
||||
}
|
||||
|
||||
// Collect source files recursively
|
||||
function getSourceFiles(dir: string): string[] {
|
||||
const results: string[] = [];
|
||||
let entries: fs.Dirent[];
|
||||
try { entries = fs.readdirSync(dir, { withFileTypes: true }); } catch { return results; }
|
||||
for (const entry of entries) {
|
||||
const fullPath = path.join(dir, entry.name);
|
||||
if (entry.isDirectory() && !entry.name.startsWith('.') && entry.name !== 'node_modules' && entry.name !== '__tests__') {
|
||||
results.push(...getSourceFiles(fullPath));
|
||||
} else if (entry.isFile() && /\.(tsx?|jsx?)$/.test(entry.name)) {
|
||||
results.push(fullPath);
|
||||
}
|
||||
}
|
||||
return results;
|
||||
}
|
||||
|
||||
/**
|
||||
* Extract translation keys from source, respecting which variable maps to which namespace.
|
||||
* Handles multiple useTranslations calls per file (even reusing the same variable name
|
||||
* in different functions) by finding, for each t("key") call, the nearest preceding
|
||||
* useTranslations assignment to that variable.
|
||||
*/
|
||||
function extractUsedKeys(filePath: string): string[] {
|
||||
const content = fs.readFileSync(filePath, 'utf-8');
|
||||
const keys: string[] = [];
|
||||
|
||||
// Collect all variable→namespace assignments with their positions
|
||||
const assignRegex = /const\s+(\w+)\s*=\s*useTranslations\(\s*["']([^"']*)["']\s*\)/g;
|
||||
const assignments: { varName: string; namespace: string; index: number }[] = [];
|
||||
let m: RegExpExecArray | null;
|
||||
while ((m = assignRegex.exec(content)) !== null) {
|
||||
assignments.push({ varName: m[1], namespace: m[2], index: m.index });
|
||||
}
|
||||
|
||||
if (assignments.length === 0) return keys;
|
||||
|
||||
// Get unique variable names
|
||||
const varNames = [...new Set(assignments.map((a) => a.varName))];
|
||||
|
||||
// For each variable, find its t("key") calls and resolve namespace by position
|
||||
for (const varName of varNames) {
|
||||
const varAssignments = assignments.filter((a) => a.varName === varName);
|
||||
const callRegex = new RegExp(`\\b${varName}\\(\\s*["']([^"'{}]+)["']`, 'g');
|
||||
while ((m = callRegex.exec(content)) !== null) {
|
||||
const key = m[1];
|
||||
if (key.startsWith('.')) continue;
|
||||
// Find the nearest preceding assignment for this variable
|
||||
const ns = varAssignments
|
||||
.filter((a) => a.index < m!.index)
|
||||
.sort((a, b) => b.index - a.index)[0]?.namespace;
|
||||
if (ns === undefined) continue;
|
||||
keys.push(ns ? `${ns}.${key}` : key);
|
||||
}
|
||||
}
|
||||
|
||||
return [...new Set(keys)];
|
||||
}
|
||||
|
||||
const locales = fs
|
||||
.readdirSync(localesDir)
|
||||
.filter((entry) => fs.statSync(path.join(localesDir, entry)).isDirectory());
|
||||
|
||||
const referenceKeys = getLeafKeys(loadLocale(referenceLocale));
|
||||
const referenceData = loadLocale(referenceLocale);
|
||||
const referenceKeys = getLeafKeys(referenceData);
|
||||
|
||||
describe('translations completeness', () => {
|
||||
it('reference locale (en) should have keys', () => {
|
||||
@@ -52,3 +116,23 @@ describe('translations completeness', () => {
|
||||
expect(extra, `Extra ${extra.length} keys in "${locale}":\n${extra.join('\n')}`).toEqual([]);
|
||||
});
|
||||
});
|
||||
|
||||
describe('translations used in source code exist in en locale', () => {
|
||||
const srcDirs = ['components', 'app', 'hooks', 'lib', 'stores', 'contexts'].map((d) => path.join(rootDir, d));
|
||||
const allFiles = srcDirs.flatMap((d) => getSourceFiles(d));
|
||||
const usedKeys = new Set<string>();
|
||||
for (const f of allFiles) {
|
||||
for (const k of extractUsedKeys(f)) {
|
||||
usedKeys.add(k);
|
||||
}
|
||||
}
|
||||
|
||||
it('all translation keys referenced in source should exist in en locale', () => {
|
||||
const missing = [...usedKeys].sort().filter((key) => resolveKey(referenceData, key) === undefined);
|
||||
|
||||
expect(
|
||||
missing,
|
||||
`${missing.length} translation key(s) used in source code but missing from en locale:\n${missing.join('\n')}`,
|
||||
).toEqual([]);
|
||||
});
|
||||
});
|
||||
|
||||
+264
-1
@@ -1,4 +1,4 @@
|
||||
import type { Email, Mailbox, StateChange, AccountStates, Thread, Identity, EmailAddress, ContactCard, AddressBook, VacationResponse, Calendar, CalendarEvent, CalendarEventFilter } from "./types";
|
||||
import type { Email, Mailbox, StateChange, AccountStates, Thread, Identity, EmailAddress, ContactCard, AddressBook, VacationResponse, Calendar, CalendarEvent, CalendarEventFilter, FileNode, FileNodeFilter } from "./types";
|
||||
import type { SieveScript, SieveCapabilities } from "./sieve-types";
|
||||
import { toWildcardQuery } from "./search-utils";
|
||||
|
||||
@@ -2350,6 +2350,269 @@ export class JMAPClient {
|
||||
return { destroyed, notDestroyed };
|
||||
}
|
||||
|
||||
// ─── JMAP FileNode methods (draft-ietf-jmap-filenode) ───
|
||||
|
||||
supportsFiles(): boolean {
|
||||
return this.hasCapability("urn:ietf:params:jmap:filenode");
|
||||
}
|
||||
|
||||
async probeFileNodeSupport(): Promise<boolean> {
|
||||
// Some servers support FileNode without advertising a specific capability.
|
||||
// Try a minimal FileNode/query to detect support at runtime.
|
||||
if (this.supportsFiles()) return true;
|
||||
if (!this.apiUrl) return false;
|
||||
try {
|
||||
const accountId = this.getFilesAccountId();
|
||||
const response = await this.authenticatedFetch(this.apiUrl, {
|
||||
method: 'POST',
|
||||
headers: { 'Content-Type': 'application/json' },
|
||||
body: JSON.stringify({
|
||||
using: ["urn:ietf:params:jmap:core"],
|
||||
methodCalls: [["FileNode/query", { accountId, filter: {}, limit: 1 }, "probe0"]],
|
||||
}),
|
||||
});
|
||||
if (!response.ok) return false;
|
||||
const data = await response.json();
|
||||
const result = data.methodResponses?.[0];
|
||||
return result && result[0] === "FileNode/query";
|
||||
} catch {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
getFilesAccountId(): string {
|
||||
const filesAccount = this.session?.primaryAccounts?.["urn:ietf:params:jmap:filenode"];
|
||||
return filesAccount || this.accountId;
|
||||
}
|
||||
|
||||
private fileUsing(): string[] {
|
||||
const using = ["urn:ietf:params:jmap:core"];
|
||||
if (this.hasCapability("urn:ietf:params:jmap:filenode")) {
|
||||
using.push("urn:ietf:params:jmap:filenode");
|
||||
}
|
||||
return using;
|
||||
}
|
||||
|
||||
private static FILE_NODE_PROPERTIES = ["id", "parentId", "name", "type", "blobId", "size", "created", "updated"];
|
||||
|
||||
async getFileNodes(ids: string[] | null, properties?: string[]): Promise<FileNode[]> {
|
||||
const accountId = this.getFilesAccountId();
|
||||
const args: Record<string, unknown> = { accountId, ids, properties: properties || JMAPClient.FILE_NODE_PROPERTIES };
|
||||
|
||||
const response = await this.request(
|
||||
[["FileNode/get", args, "fn0"]],
|
||||
this.fileUsing(),
|
||||
);
|
||||
|
||||
const result = response.methodResponses?.[0];
|
||||
if (!result || result[0] === "error") {
|
||||
throw new Error(result?.[1]?.description || "FileNode/get failed");
|
||||
}
|
||||
return (result[1].list || []) as FileNode[];
|
||||
}
|
||||
|
||||
async queryFileNodes(filter: FileNodeFilter, sort?: { property: string; isAscending: boolean }[]): Promise<string[]> {
|
||||
const accountId = this.getFilesAccountId();
|
||||
const args: Record<string, unknown> = { accountId, filter };
|
||||
if (sort) args.sort = sort;
|
||||
|
||||
const response = await this.request(
|
||||
[["FileNode/query", args, "fnq0"]],
|
||||
this.fileUsing(),
|
||||
);
|
||||
|
||||
const result = response.methodResponses?.[0];
|
||||
if (!result || result[0] === "error") {
|
||||
throw new Error(result?.[1]?.description || "FileNode/query failed");
|
||||
}
|
||||
return (result[1].ids || []) as string[];
|
||||
}
|
||||
|
||||
async listFileNodes(parentId: string | null): Promise<FileNode[]> {
|
||||
const accountId = this.getFilesAccountId();
|
||||
const filter: Record<string, unknown> = {};
|
||||
if (parentId !== null) {
|
||||
filter.parentId = parentId;
|
||||
}
|
||||
// When parentId is null (root level), use empty filter to get all nodes.
|
||||
// Stalwart's FileNode/query does not support parentId: null as a filter value.
|
||||
|
||||
const response = await this.request(
|
||||
[
|
||||
["FileNode/query", { accountId, filter }, "fnq0"],
|
||||
["FileNode/get", { accountId, "#ids": { resultOf: "fnq0", name: "FileNode/query", path: "/ids" }, properties: JMAPClient.FILE_NODE_PROPERTIES }, "fng0"],
|
||||
],
|
||||
this.fileUsing(),
|
||||
);
|
||||
|
||||
// Check if query failed first
|
||||
const queryResult = response.methodResponses?.find(r => r[0] === "FileNode/query" || (r[0] === "error" && r[2] === "fnq0"));
|
||||
if (queryResult && queryResult[0] === "error") {
|
||||
console.error('[Files] FileNode/query error:', queryResult[1]);
|
||||
throw new Error(queryResult[1]?.description || "FileNode/query failed");
|
||||
}
|
||||
|
||||
const getResult = response.methodResponses?.find(r => r[0] === "FileNode/get" || (r[0] === "error" && r[2] === "fnq0"));
|
||||
if (!getResult) {
|
||||
console.error('[Files] No FileNode/get response. Full response:', JSON.stringify(response.methodResponses));
|
||||
throw new Error("FileNode list failed - no response");
|
||||
}
|
||||
if (getResult[0] === "error") {
|
||||
console.error('[Files] FileNode/get error:', getResult[1]);
|
||||
throw new Error(getResult[1]?.description || "FileNode list failed");
|
||||
}
|
||||
const nodes = (getResult[1].list || []) as FileNode[];
|
||||
// When listing root, filter client-side to only show root-level items
|
||||
if (parentId === null) {
|
||||
return nodes.filter(n => n.parentId === null);
|
||||
}
|
||||
return nodes;
|
||||
}
|
||||
|
||||
async createFileDirectory(name: string, parentId: string | null): Promise<FileNode> {
|
||||
const accountId = this.getFilesAccountId();
|
||||
|
||||
// Stalwart requires a blobId even for directories — upload an empty blob
|
||||
const emptyBlob = new File([], name, { type: 'application/x-directory' });
|
||||
const { blobId } = await this.uploadBlob(emptyBlob);
|
||||
|
||||
const dirProps: Record<string, unknown> = { name, type: "d", blobId, size: 0 };
|
||||
if (parentId !== null) {
|
||||
dirProps.parentId = parentId;
|
||||
}
|
||||
|
||||
const response = await this.request(
|
||||
[["FileNode/set", {
|
||||
accountId,
|
||||
create: {
|
||||
dir0: dirProps,
|
||||
},
|
||||
}, "fns0"]],
|
||||
this.fileUsing(),
|
||||
);
|
||||
|
||||
const result = response.methodResponses?.[0];
|
||||
if (!result || result[0] === "error") {
|
||||
throw new Error(result?.[1]?.description || "FileNode/set create failed");
|
||||
}
|
||||
const created = result[1].created?.dir0;
|
||||
if (!created) {
|
||||
const err = result[1].notCreated?.dir0;
|
||||
throw new Error(err?.description || "Failed to create directory");
|
||||
}
|
||||
return created as FileNode;
|
||||
}
|
||||
|
||||
async createFileNode(name: string, blobId: string, type: string, size: number, parentId: string | null): Promise<FileNode> {
|
||||
const accountId = this.getFilesAccountId();
|
||||
|
||||
const fileProps: Record<string, unknown> = { name, type, blobId, size };
|
||||
if (parentId !== null) {
|
||||
fileProps.parentId = parentId;
|
||||
}
|
||||
|
||||
const response = await this.request(
|
||||
[["FileNode/set", {
|
||||
accountId,
|
||||
create: {
|
||||
file0: fileProps,
|
||||
},
|
||||
}, "fns0"]],
|
||||
this.fileUsing(),
|
||||
);
|
||||
|
||||
const result = response.methodResponses?.[0];
|
||||
if (!result || result[0] === "error") {
|
||||
throw new Error(result?.[1]?.description || "FileNode/set create failed");
|
||||
}
|
||||
const created = result[1].created?.file0;
|
||||
if (!created) {
|
||||
const err = result[1].notCreated?.file0;
|
||||
throw new Error(err?.description || "Failed to create file node");
|
||||
}
|
||||
return created as FileNode;
|
||||
}
|
||||
|
||||
async updateFileNode(id: string, updates: Partial<Pick<FileNode, 'name' | 'parentId'>>): Promise<void> {
|
||||
const accountId = this.getFilesAccountId();
|
||||
|
||||
const response = await this.request(
|
||||
[["FileNode/set", {
|
||||
accountId,
|
||||
update: { [id]: updates },
|
||||
}, "fns0"]],
|
||||
this.fileUsing(),
|
||||
);
|
||||
|
||||
const result = response.methodResponses?.[0];
|
||||
if (!result || result[0] === "error") {
|
||||
throw new Error(result?.[1]?.description || "FileNode/set update failed");
|
||||
}
|
||||
if (result[1].notUpdated?.[id]) {
|
||||
throw new Error(result[1].notUpdated[id].description || "Failed to update file node");
|
||||
}
|
||||
}
|
||||
|
||||
async destroyFileNodes(ids: string[]): Promise<{ destroyed: string[]; notDestroyed: string[] }> {
|
||||
const accountId = this.getFilesAccountId();
|
||||
|
||||
const response = await this.request(
|
||||
[["FileNode/set", {
|
||||
accountId,
|
||||
destroy: ids,
|
||||
}, "fns0"]],
|
||||
this.fileUsing(),
|
||||
);
|
||||
|
||||
const result = response.methodResponses?.[0];
|
||||
if (!result || result[0] === "error") {
|
||||
throw new Error(result?.[1]?.description || "FileNode/set destroy failed");
|
||||
}
|
||||
return {
|
||||
destroyed: result[1].destroyed || [],
|
||||
notDestroyed: result[1].notDestroyed ? Object.keys(result[1].notDestroyed) : [],
|
||||
};
|
||||
}
|
||||
|
||||
async copyFileNode(id: string, newName: string, parentId: string | null): Promise<FileNode> {
|
||||
// Copy: get original, upload blob reference, create new node
|
||||
const nodes = await this.getFileNodes([id]);
|
||||
if (nodes.length === 0) throw new Error('File node not found');
|
||||
const original = nodes[0];
|
||||
|
||||
const accountId = this.getFilesAccountId();
|
||||
const createProps: Record<string, unknown> = {
|
||||
name: newName,
|
||||
type: original.type,
|
||||
blobId: original.blobId,
|
||||
size: original.size,
|
||||
};
|
||||
if (parentId !== null) {
|
||||
createProps.parentId = parentId;
|
||||
}
|
||||
|
||||
const response = await this.request(
|
||||
[["FileNode/set", {
|
||||
accountId,
|
||||
create: {
|
||||
copy0: createProps,
|
||||
},
|
||||
}, "fns0"]],
|
||||
this.fileUsing(),
|
||||
);
|
||||
|
||||
const result = response.methodResponses?.[0];
|
||||
if (!result || result[0] === "error") {
|
||||
throw new Error(result?.[1]?.description || "FileNode copy failed");
|
||||
}
|
||||
const created = result[1].created?.copy0;
|
||||
if (!created) {
|
||||
const err = result[1].notCreated?.copy0;
|
||||
throw new Error(err?.description || "Failed to copy file node");
|
||||
}
|
||||
return created as FileNode;
|
||||
}
|
||||
|
||||
async downloadBlob(blobId: string, name?: string, type?: string): Promise<void> {
|
||||
const url = this.getBlobDownloadUrl(blobId, name, type);
|
||||
const response = await this.authenticatedFetch(url, {});
|
||||
|
||||
@@ -618,4 +618,23 @@ export interface AccountStates {
|
||||
Mailbox?: string;
|
||||
Thread?: string;
|
||||
};
|
||||
}
|
||||
|
||||
// JMAP FileNode types (draft-ietf-jmap-filenode / Stalwart implementation)
|
||||
|
||||
export interface FileNode {
|
||||
id: string;
|
||||
parentId: string | null;
|
||||
name: string;
|
||||
type: string; // "d" for directory, MIME type for files
|
||||
blobId: string | null;
|
||||
size: number;
|
||||
created: string;
|
||||
updated: string;
|
||||
}
|
||||
|
||||
export interface FileNodeFilter {
|
||||
parentId?: string | null;
|
||||
name?: string;
|
||||
type?: string;
|
||||
}
|
||||
Reference in New Issue
Block a user