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>
109 lines
3.6 KiB
TypeScript
109 lines
3.6 KiB
TypeScript
/**
|
|
* Alice — the file CLIENT. Demonstrates the typed `@shade/files` API:
|
|
*
|
|
* bun run examples/08-files-browser/alice-cli.ts list /
|
|
* bun run examples/08-files-browser/alice-cli.ts mkdir /docs
|
|
* bun run examples/08-files-browser/alice-cli.ts upload ./README.md /docs/readme.md
|
|
* bun run examples/08-files-browser/alice-cli.ts download /docs/readme.md ./out.md
|
|
* bun run examples/08-files-browser/alice-cli.ts stat /docs/readme.md
|
|
* bun run examples/08-files-browser/alice-cli.ts delete /docs/readme.md
|
|
*/
|
|
import { readFile, writeFile, stat as fsstat } from 'node:fs/promises';
|
|
import { createShade } from '@shade/sdk';
|
|
|
|
const PREKEY = 'http://localhost:9992';
|
|
const ALICE_BASE_URL = 'http://localhost:9993';
|
|
const BOB_BASE_URL = 'http://localhost:9994';
|
|
|
|
const alice = await createShade({ prekeyServer: PREKEY, address: 'alice' });
|
|
alice.configureTransfers({
|
|
resolveBaseUrl: async (peer) => {
|
|
if (peer === 'bob') return BOB_BASE_URL;
|
|
throw new Error(`alice: unknown peer ${peer}`);
|
|
},
|
|
});
|
|
const app = await alice.transferRoute();
|
|
Bun.serve({ port: 9993, fetch: app.fetch });
|
|
|
|
const fs = await alice.files.client('bob', { defaultTimeoutMs: 30_000 });
|
|
|
|
const [cmd, ...args] = process.argv.slice(2);
|
|
try {
|
|
switch (cmd) {
|
|
case 'list': {
|
|
const path = args[0] ?? '/';
|
|
const result = await fs.list(path);
|
|
for (const e of result.entries) {
|
|
console.log(`${e.kind === 'dir' ? 'd' : '-'} ${String(e.size).padStart(10)} ${e.name}`);
|
|
}
|
|
break;
|
|
}
|
|
case 'stat': {
|
|
const path = args[0]!;
|
|
const e = await fs.stat(path);
|
|
console.log(JSON.stringify(e, null, 2));
|
|
break;
|
|
}
|
|
case 'mkdir': {
|
|
const path = args[0]!;
|
|
const r = await fs.mkdir(path, { recursive: true });
|
|
console.log(`created ${r.entry.name}`);
|
|
break;
|
|
}
|
|
case 'delete': {
|
|
const path = args[0]!;
|
|
const r = await fs.delete(path, { recursive: true });
|
|
console.log(`deleted ${r.deletedCount} entrie(s)`);
|
|
break;
|
|
}
|
|
case 'upload': {
|
|
const localPath = args[0]!;
|
|
const remotePath = args[1]!;
|
|
const bytes = new Uint8Array(await readFile(localPath));
|
|
const s = await fsstat(localPath);
|
|
console.log(`uploading ${s.size} bytes → ${remotePath}`);
|
|
const r = await fs.write(remotePath, bytes, { overwrite: true });
|
|
console.log(`done — remote size: ${r.entry.size}`);
|
|
break;
|
|
}
|
|
case 'download': {
|
|
const remotePath = args[0]!;
|
|
const localPath = args[1]!;
|
|
const result = await fs.read(remotePath);
|
|
if (result.kind === 'inline') {
|
|
await writeFile(localPath, result.bytes);
|
|
console.log(`downloaded ${result.bytes.byteLength} bytes (inline) sha256=${result.sha256}`);
|
|
} else {
|
|
const reader = result.stream.getReader();
|
|
const chunks: Uint8Array[] = [];
|
|
let total = 0;
|
|
while (true) {
|
|
const { value, done } = await reader.read();
|
|
if (done) break;
|
|
if (value !== undefined) {
|
|
chunks.push(value);
|
|
total += value.byteLength;
|
|
}
|
|
}
|
|
reader.releaseLock();
|
|
const out = new Uint8Array(total);
|
|
let offset = 0;
|
|
for (const c of chunks) {
|
|
out.set(c, offset);
|
|
offset += c.byteLength;
|
|
}
|
|
await writeFile(localPath, out);
|
|
await result.done();
|
|
console.log(`downloaded ${total} bytes (streamed) sha256=${result.sha256}`);
|
|
}
|
|
break;
|
|
}
|
|
default:
|
|
console.error('Usage: alice-cli.ts <list|stat|mkdir|delete|upload|download> [args...]');
|
|
process.exit(1);
|
|
}
|
|
} finally {
|
|
await alice.shutdown();
|
|
process.exit(0);
|
|
}
|