feat(files): @shade/files 0.3.0 — E2EE filesystem RPC primitive
Some checks failed
Test / test (push) Has been cancelled

M-Files-1..6 land the full files-RPC layer + everything 0.3.0 needs to
ship. Apps keep their own UI; this layer ships the typed RPC, the
streams bridge for content I/O, and production hooks (rate limit,
retention, fingerprint gate, metrics).

@shade/files (NEW)
- Standard ops: list/stat/mkdir/delete/move/read/write/getThumbnail with
  Zod-validated wire schemas + clean user-handler types.
- Custom ops: typed via TypeScript declaration merging on CustomOpsMap
  + per-op Zod schemas; client.custom('app.foo', {...}) is fully typed.
- Content I/O: inline (≤ 256 KiB plaintext) base64-in-RPC; streams
  (> 256 KiB) ride @shade/transfer via userMetadata.shadeFilesWriteId
  / shadeFilesReadStreamId correlation. Server-side TransformStream
  bridges accept inbound transfers immediately (engine rejects chunks
  that arrive before accept) and park the readable for the matching
  RPC.
- Directory ops: walk(path, opts) async-iterable depth-first walker;
  uploadDirectory()/downloadDirectory() with bounded concurrency pool
  (default 4, cap 16), aggregated progress, abort.
- Production hooks (callback-based, vendor-neutral): rate-limit (op +
  byte), idempotency cache (LRU + TTL + in-flight de-dupe), path
  policy (traversal + percent-decode hardening), fingerprint gate
  (required/optional/reject), pluggable Ed25519 sig verification with
  ±5 min replay window, onMetric sink (standard names).
- React hooks (subpath @shade/files/react): ShadeFilesProvider,
  useShadeFiles, useFileList, useFileTransfer/Upload/Download.
- Shade.files.serve(handler) + Shade.files.client(peer) high-level
  entrypoint in @shade/sdk; lazy + memoized; one handler per Shade.

Wire format bump
- @shade/proto wire VERSION 0x01 → 0x02. Length prefixes changed from
  u16 to u32. The previous u16 silently truncated payloads above
  64 KiB — a hard correctness ceiling that blocked inline file ops
  up to 256 KiB. Wire-incompatible with 0.2.x peers; new sessions
  only. Cross-platform Kotlin port (android/shade-android) updated to
  match; test-vectors/wire-format.json regenerated.

Concurrency safety
- ShadeSessionManager.encrypt/.decrypt now run under per-peer mutex.
  Concurrent decryptions of the same peer raced ratchet state
  (manifested as sporadic "Failed to decrypt — wrong key or tampered
  data" under load — surfaced once concurrent uploadDirectory pumped
  many writes in flight). Encrypt was already serialized via
  Shade.send's encryptChains; decrypt is now serialized at the
  manager layer too.

@shade/streams extension
- StreamMetadata.userMetadata?: Record<string, string> for
  application-level key/value pairs that round-trip verbatim through
  stream-init plaintext. Used by @shade/files for write/read
  correlation; available to any consumer.

@shade/sdk extension
- Shade.files getter (lazy + memoized).
- BackgroundHooks.onPruneFiles + periodic timer (default 5 min) +
  BackgroundTasks.setHook(name, fn) for runtime hook registration.

Bundles in-flight 0.2.0 work
- packages/shade-streams/, packages/shade-transfer/, related
  shade-sdk streams-bridge + shade-widgets transfer hooks were
  uncommitted prior to this session. Including them keeps the
  workspace consistent at 0.3.0 since @shade/files depends on them.

Tests
- 74 new tests in @shade/files (572 → 646 workspace pass; 0 fail;
  3× stable). Coverage spans unit (inline-threshold + concurrency),
  integration (read-write inline + streams up to 1 MiB, walk +
  upload/download directory, custom-op, metrics, SDK namespace
  end-to-end), and security (tampered-envelope sig verification,
  replay window, fingerprint gate, rate-limit + quota).

Release artifacts
- All packages bumped to 0.3.0 via scripts/bump-version.ts.
- scripts/publish-all.ts PACKAGES updated with shade-files in
  topological order (after shade-transfer, before shade-sdk).
- bun run publish:dry clean (14 packed, 0 failed).
- examples/08-files-browser/ — three-process CLI demo (prekey + Bob
  server + Alice CLI) covering list/stat/mkdir/delete/upload/download.
- docs/files.md — full API + design doc.
- CHANGELOG.md 0.3.0 entry.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
2026-05-02 14:00:01 +02:00
parent 7e0f7320a9
commit fa770d3063
198 changed files with 20412 additions and 256 deletions

View File

@@ -0,0 +1,124 @@
import { ValidationError } from '@shade/core';
import type { TransferInput } from '../types.js';
export interface NormalizedInput {
/** Total plaintext bytes when known. `undefined` for indeterminate streams. */
size: number | undefined;
name?: string;
contentType?: string;
/** Read bytes [start, end). End is exclusive. Must be supported when `size` is known. */
read(start: number, end: number): Promise<Uint8Array>;
/** Sequential reader for unknown-size inputs. Returns `null` at end-of-stream. */
readNext(maxBytes: number): Promise<Uint8Array | null>;
/** Whether the source supports random `read(start, end)` access. */
readonly randomAccess: boolean;
/** Free any underlying resources (no-op when nothing to release). */
close(): Promise<void>;
}
/**
* Normalize any of the supported `TransferInput` shapes into a uniform
* reader. Determines size eagerly when possible.
*/
export async function normalizeInput(input: TransferInput): Promise<NormalizedInput> {
if (input instanceof Uint8Array) return fromUint8Array(input);
if (typeof Blob !== 'undefined' && input instanceof Blob) return fromBlob(input);
if (isReadableStream(input)) return fromReadableStream(input);
throw new ValidationError('Unsupported TransferInput', 'input');
}
function fromUint8Array(buf: Uint8Array): NormalizedInput {
return {
size: buf.length,
randomAccess: true,
async read(start, end) {
return buf.slice(start, end);
},
async readNext() {
throw new Error('readNext is not supported on random-access inputs');
},
async close() {
/* nothing to release */
},
};
}
function fromBlob(blob: Blob): NormalizedInput {
// Blob.slice / Blob.arrayBuffer are not in `lib: ["ES2022"]`. We cast
// through `unknown` to avoid pulling in the full DOM lib.
const blobLike = blob as unknown as {
size: number;
slice(start: number, end: number): { arrayBuffer(): Promise<ArrayBuffer> };
arrayBuffer(): Promise<ArrayBuffer>;
};
const out: NormalizedInput = {
size: blobLike.size,
randomAccess: true,
async read(start, end) {
const slice = blobLike.slice(start, end);
const ab = await slice.arrayBuffer();
return new Uint8Array(ab);
},
async readNext() {
throw new Error('readNext is not supported on random-access inputs');
},
async close() {
/* nothing to release */
},
};
// File extends Blob with name/type
const f = blob as Blob & { name?: string; type?: string };
if (typeof f.name === 'string') out.name = f.name;
if (typeof f.type === 'string' && f.type.length > 0) out.contentType = f.type;
return out;
}
function fromReadableStream(stream: ReadableStream<Uint8Array>): NormalizedInput {
const reader = stream.getReader();
let pending: Uint8Array = new Uint8Array(0);
let done = false;
return {
size: undefined,
randomAccess: false,
async read() {
throw new Error('Random access not supported for ReadableStream input');
},
async readNext(maxBytes) {
while (pending.length < maxBytes && !done) {
const r = await reader.read();
if (r.done) {
done = true;
break;
}
pending = concat(pending, r.value as Uint8Array);
}
if (pending.length === 0 && done) return null;
const out = pending.subarray(0, Math.min(maxBytes, pending.length));
pending = pending.subarray(out.length);
return out;
},
async close() {
try {
await reader.cancel();
} catch {
/* already closed */
}
},
};
}
function isReadableStream(x: unknown): x is ReadableStream<Uint8Array> {
return (
typeof x === 'object' &&
x !== null &&
typeof (x as { getReader?: unknown }).getReader === 'function'
);
}
function concat(a: Uint8Array, b: Uint8Array): Uint8Array {
const out = new Uint8Array(a.length + b.length);
out.set(a, 0);
out.set(b, a.length);
return out as Uint8Array;
}

View File

@@ -0,0 +1,88 @@
/**
* Bounded async FIFO. The producer awaits when the queue is full; the
* consumer awaits when the queue is empty. Used by the upload orchestrator
* to pace per-lane chunk dispatch without unbounded memory growth.
*/
export class BoundedAsyncQueue<T> {
private items: T[] = [];
private waiters: Array<(value: IteratorResult<T>) => void> = [];
private spaceWaiters: Array<() => void> = [];
private closed = false;
private aborted = false;
private abortReason: unknown = null;
constructor(private readonly capacity: number) {
if (capacity < 1) throw new Error(`capacity must be >= 1`);
}
/** Push an item. Awaits if the queue is at capacity. */
async push(item: T): Promise<void> {
if (this.aborted) throw this.abortReason;
if (this.closed) throw new Error('queue closed');
while (this.items.length >= this.capacity) {
await new Promise<void>((resolve) => this.spaceWaiters.push(resolve));
if (this.aborted) throw this.abortReason;
if (this.closed) throw new Error('queue closed mid-push');
}
this.items.push(item);
const waiter = this.waiters.shift();
if (waiter !== undefined) {
const next = this.items.shift()!;
waiter({ value: next, done: false });
this.notifySpace();
}
}
/** Returns next item or `{done: true}` when closed and drained. */
async next(): Promise<IteratorResult<T>> {
if (this.aborted) throw this.abortReason;
if (this.items.length > 0) {
const value = this.items.shift()!;
this.notifySpace();
return { value, done: false };
}
if (this.closed) return { value: undefined as never, done: true };
return new Promise<IteratorResult<T>>((resolve) => {
this.waiters.push(resolve);
});
}
/** Mark the queue as closed; subsequent `next()` calls drain remaining items. */
close(): void {
if (this.closed) return;
this.closed = true;
for (const waiter of this.waiters) {
waiter({ value: undefined as never, done: true });
}
this.waiters = [];
}
abort(reason: unknown): void {
if (this.aborted) return;
this.aborted = true;
this.abortReason = reason;
this.closed = true;
for (const w of this.spaceWaiters) w();
this.spaceWaiters = [];
for (const w of this.waiters) {
// Reject pending consumers via a thrown abort; consumers handle.
// We can't reject here because the next() returns IteratorResult, not a rejected promise.
// So instead, re-resolve as `done`; consumers check `aborted` separately.
w({ value: undefined as never, done: true });
}
this.waiters = [];
}
get size(): number {
return this.items.length;
}
get isClosed(): boolean {
return this.closed;
}
private notifySpace(): void {
const waiter = this.spaceWaiters.shift();
if (waiter !== undefined) waiter();
}
}