Files
Shade/scripts/publish-all.ts
Sterister fa770d3063
Some checks failed
Test / test (push) Has been cancelled
feat(files): @shade/files 0.3.0 — E2EE filesystem RPC primitive
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>
2026-05-02 14:00:01 +02:00

171 lines
5.8 KiB
TypeScript

#!/usr/bin/env bun
/**
* Publish all @shade/* packages to the Gitea npm registry.
*
* Expects these env vars:
* GITEA_TOKEN — publish token from Gitea (Settings → Applications)
* GITEA_USER — Gitea username that owns the registry (e.g. "Stian")
*
* Optional:
* DRY_RUN=1 — build tarballs but don't publish
*
* Usage:
* bun run scripts/publish-all.ts
*/
import { readFileSync, writeFileSync, existsSync } from 'fs';
import { join } from 'path';
import { $ } from 'bun';
// Order matters: each package only depends on packages above it. Publishing
// in this order means a consumer fetching mid-publish never sees a manifest
// pointing at an unpublished version.
const PACKAGES = [
'shade-core',
'shade-proto',
'shade-crypto-web',
'shade-storage-sqlite',
'shade-storage-postgres',
'shade-streams',
'shade-transport',
'shade-server',
'shade-transfer',
'shade-files',
'shade-observer',
'shade-sdk',
'shade-widgets',
'shade-cli',
];
const REGISTRY_HOST = 'gt.zyon.no';
const ROOT = join(import.meta.dir, '..');
async function main() {
const token = process.env.GITEA_TOKEN;
const user = process.env.GITEA_USER ?? 'Stian';
const dryRun = process.env.DRY_RUN === '1';
if (!token && !dryRun) {
console.error('GITEA_TOKEN is required (or set DRY_RUN=1)');
process.exit(1);
}
const registryUrl = `https://${REGISTRY_HOST}/api/packages/${user}/npm/`;
console.log(`Target registry: ${registryUrl}`);
console.log(`Dry run: ${dryRun ? 'yes' : 'no'}`);
console.log();
// Write a temporary .npmrc at the root
const npmrcPath = join(ROOT, '.npmrc.publish');
const npmrc = [
`@shade:registry=${registryUrl}`,
dryRun ? '' : `//${REGISTRY_HOST}/api/packages/${user}/npm/:_authToken=${token}`,
].filter(Boolean).join('\n');
writeFileSync(npmrcPath, npmrc);
// Build a name → version map across all workspace packages so we can rewrite
// `workspace:*` (and friends) into concrete `^<version>` specifiers before
// publishing. Without this, the registry stores the literal `workspace:*`
// string in published package.json, which then fails to resolve in any
// consumer (e.g. Dispatch) outside the Shade monorepo.
const versionByName = new Map<string, string>();
for (const pkg of PACKAGES) {
const pkgDir = join(ROOT, 'packages', pkg);
if (!existsSync(join(pkgDir, 'package.json'))) continue;
const json = JSON.parse(readFileSync(join(pkgDir, 'package.json'), 'utf-8'));
versionByName.set(json.name, json.version);
}
let published = 0;
let skipped = 0;
let alreadyPublished = 0;
let failed = 0;
for (const pkg of PACKAGES) {
const pkgDir = join(ROOT, 'packages', pkg);
const pkgJsonPath = join(pkgDir, 'package.json');
if (!existsSync(pkgJsonPath)) {
console.log(`${pkg} — package.json not found, skipping`);
skipped++;
continue;
}
const originalPkgJson = readFileSync(pkgJsonPath, 'utf-8');
const pkgJson = JSON.parse(originalPkgJson);
console.log(`${pkgJson.name}@${pkgJson.version}`);
rewriteWorkspaceSpecs(pkgJson, versionByName);
writeFileSync(pkgJsonPath, `${JSON.stringify(pkgJson, null, 2)}\n`);
try {
if (dryRun) {
await $`cd ${pkgDir} && bun pm pack --dry-run`.quiet();
} else {
await $`cd ${pkgDir} && npm publish --registry=${registryUrl} --userconfig ${npmrcPath}`.quiet();
}
published++;
console.log(`${dryRun ? 'packed' : 'published'}`);
} catch (err) {
const out = `${err instanceof Error ? err.message : String(err)} ${
(err as { stderr?: { toString(): string } }).stderr?.toString() ?? ''
} ${(err as { stdout?: { toString(): string } }).stdout?.toString() ?? ''}`;
// Gitea (and npm) report already-published versions as 409 / EPUBLISHCONFLICT.
// Skip silently rather than failing the whole run — bumping the version
// is the user's explicit decision via `bun run version <new>`.
if (/409|EPUBLISHCONFLICT|already exists|already been published/i.test(out)) {
alreadyPublished++;
console.log(` ⊙ already published — skipping`);
} else {
failed++;
console.error(` ✗ failed: ${(err as Error).message}`);
process.exitCode = 1;
}
} finally {
// Always restore the original package.json so the workspace stays usable
// for `bun install` after publish, regardless of success or failure.
writeFileSync(pkgJsonPath, originalPkgJson);
}
}
// Clean up temp npmrc
try {
await $`rm ${npmrcPath}`.quiet();
} catch {}
console.log();
console.log(
`Done: ${published} ${dryRun ? 'packed' : 'published'}, ${alreadyPublished} already published, ${skipped} skipped, ${failed} failed`,
);
}
/**
* Rewrite `workspace:*` (and `workspace:^`, `workspace:~`, `workspace:<v>`)
* specifiers in dependency sections to concrete `^<version>` specifiers.
* Mutates the passed-in object.
*/
function rewriteWorkspaceSpecs(
pkgJson: Record<string, unknown>,
versionByName: Map<string, string>,
): void {
const sections = ['dependencies', 'peerDependencies', 'optionalDependencies'] as const;
for (const section of sections) {
const deps = pkgJson[section];
if (!deps || typeof deps !== 'object') continue;
for (const [name, spec] of Object.entries(deps as Record<string, string>)) {
if (typeof spec !== 'string' || !spec.startsWith('workspace:')) continue;
const version = versionByName.get(name);
if (!version) {
throw new Error(
`No workspace version known for ${name} (referenced from ${pkgJson.name as string}). ` +
`Add it to PACKAGES or remove the workspace dependency.`,
);
}
(deps as Record<string, string>)[name] = `^${version}`;
}
}
}
main().catch((err) => {
console.error(err);
process.exit(1);
});