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

@@ -1,6 +1,6 @@
{
"name": "@shade/transport",
"version": "0.1.0",
"version": "0.3.0",
"type": "module",
"main": "src/index.ts",
"types": "src/index.ts",

View File

@@ -1,5 +1,5 @@
import type { PreKeyBundle, OneTimePreKey, CryptoProvider } from '@shade/core';
import { fromBase64, NetworkError } from '@shade/core';
import { NetworkError } from '@shade/core';
/**
* HTTP transport client for the Shade Prekey Server.
@@ -27,7 +27,9 @@ export class ShadeFetchTransport {
constructor(options: { baseUrl: string; crypto: CryptoProvider; signingPrivateKey?: Uint8Array }) {
this.baseUrl = options.baseUrl;
this.crypto = options.crypto;
this.signingPrivateKey = options.signingPrivateKey;
if (options.signingPrivateKey !== undefined) {
this.signingPrivateKey = options.signingPrivateKey;
}
}
private headers(): Record<string, string> {
@@ -94,8 +96,14 @@ export class ShadeFetchTransport {
});
if (!res.ok) throw new NetworkError(`Fetch bundle failed: ${res.status}`, res.status);
const data = await res.json();
return {
const data = (await res.json()) as {
registrationId?: number;
identitySigningKey: string;
identityDHKey: string;
signedPreKey: { keyId: number; publicKey: string; signature: string };
oneTimePreKey?: { keyId: number; publicKey: string };
};
const bundle: PreKeyBundle = {
registrationId: data.registrationId ?? 0,
identitySigningKey: fromB64(data.identitySigningKey),
identityDHKey: fromB64(data.identityDHKey),
@@ -104,13 +112,14 @@ export class ShadeFetchTransport {
publicKey: fromB64(data.signedPreKey.publicKey),
signature: fromB64(data.signedPreKey.signature),
},
oneTimePreKey: data.oneTimePreKey
? {
keyId: data.oneTimePreKey.keyId,
publicKey: fromB64(data.oneTimePreKey.publicKey),
}
: undefined,
};
if (data.oneTimePreKey) {
bundle.oneTimePreKey = {
keyId: data.oneTimePreKey.keyId,
publicKey: fromB64(data.oneTimePreKey.publicKey),
};
}
return bundle;
}
/** Upload additional one-time prekeys (signed) */
@@ -133,7 +142,7 @@ export class ShadeFetchTransport {
body: JSON.stringify(signed),
});
if (!res.ok) throw new NetworkError(`Replenish failed: ${res.status}`, res.status);
const data = await res.json();
const data = (await res.json()) as { remaining: number };
return data.remaining;
}
@@ -143,7 +152,7 @@ export class ShadeFetchTransport {
headers: this.headers(),
});
if (!res.ok) throw new NetworkError(`Count failed: ${res.status}`, res.status);
const data = await res.json();
const data = (await res.json()) as { count: number };
return data.count;
}

View File

@@ -1,4 +1,4 @@
import type { ShadeSessionManager, ShadeEnvelope, RatchetMessage } from '@shade/core';
import type { ShadeSessionManager } from '@shade/core';
import { encodeEnvelope, decodeEnvelope } from '@shade/proto';
/**
@@ -40,8 +40,10 @@ export class ShadeWebSocket {
const envelope = await this.manager.encrypt(this.peerAddress, plaintext);
const bytes = encodeEnvelope(envelope);
// Send as binary
this.ws.send(bytes);
// Send as binary. Cast through BufferSource to satisfy
// Uint8Array<ArrayBufferLike> vs Uint8Array<ArrayBuffer> mismatch under
// strict TS configurations (5.7+).
this.ws.send(bytes as unknown as ArrayBuffer);
}
/** Register a handler for decrypted incoming messages */