@telecrypt-io/storage 0.5.27 → 0.5.29

package/README.md

@@ -4,6 +4,10 @@
 
 End-to-end encrypted file storage and sharing, built on Matrix.
 
+The current public TeleCrypt architecture, responsibilities, and product limits are authoritative at
+[telecrypt.io/llms.txt](https://telecrypt.io/llms.txt). This README documents this SDK's package API
+and development workflow.
+
 Files are encrypted on the client before upload. The server stores only opaque ciphertext and
 never holds the decryption keys. Shared vaults let multiple people add and read files, and a
 Recovery Key restores your files on a new device — even if you lose the original.
@@ -15,7 +19,7 @@ is maintained in its own repository.
 ## Install
 
 ```bash
-npm install @telecrypt-io/storage@0.5.10
+npm install @telecrypt-io/storage@0.5.28
 ```
 
 This gives you the `TeleCryptIOStorage` library and its browser-safe `core` API.
@@ -35,8 +39,8 @@ const vault = await core.createVault(storage, "Photos");
 await core.uploadFile(storage, vault.id, "cat.jpg", bytes, "image/jpeg");
 ```
 
-The recommended constructors configure the Matrix client with the SDK's bounded, manual-redirect
-transport and finite request deadline. The public `new TeleCryptIOStorage(client)` constructor is
+The recommended constructors configure the Matrix client with the SDK's manual-redirect transport
+and finite request deadline. The public `new TeleCryptIOStorage(client)` constructor is
 an advanced escape hatch: it does not rewrite matrix-js-sdk internals. Callers using it must build
 the client through matrix-js-sdk's supported `createClient` options (`fetchFn` and
 `localTimeoutMs`) and remain responsible for the safety of other Matrix SDK requests. SDK methods
@@ -51,7 +55,7 @@ provides no server-side room-creation idempotency key.
 
 The SDK owns the browser authorization-code PKCE context in `sessionStorage` and provides device-code,
 discovery, dynamic registration, identity confirmation, and refresh helpers. OAuth metadata, token
-scopes, Matrix user/device identities, redirects, and response bodies are validated and bounded before
+scopes, Matrix user/device identities, redirects, and complete response bodies are validated before
 they are returned. Network-bound helpers accept `AbortSignal` where cancellation is meaningful; token
 refresh uses a public client and persists the resulting token pair through the caller's callback.
 
@@ -107,13 +111,23 @@ Synapse without that extension cannot provide the SDK deletion contract.
 
 ```bash
 npm ci --ignore-scripts --no-fund --no-audit
+npm run test:unit      # unit-only checks; does not start Podman
 npm run synapse:up     # disposable local Synapse/MAS fixture
-npm test
-npm run synapse:down
-# For a complete reset, use ./throwaway_synapse/down.sh --wipe.
+npm test               # full SDK suite, including fixture-backed functional tests
 ```
 
-Tests run against a real local Synapse/MAS fixture in Podman, never against a production server.
+The full suite uses the real local Synapse/MAS/Postgres fixture in Podman at `localhost:8008`, never
+a production server. This is the shared fixture for the SDK, CLI, and Web functional/e2e suites;
+start it from this checkout and reuse it for the sibling repositories. Unit tests may use mocks for
+isolated boundaries, but they do not replace the real-stack checks.
+
+If setup or tests fail, preserve the fixture and its diagnostics; do not run
+`npm run synapse:down` before the private Harness investigation is complete. The fixture scripts do
+not provide that workflow; follow the [Harness operator workflow](https://github.com/TeleCrypt-io/Harness/blob/main/docs/release.md#required-stage-first-sequence)
+for the canonical ordering and stopping boundary.
+
+After a successful run, use `npm run synapse:down` for scoped teardown. Use
+`./throwaway_synapse/down.sh --wipe` only when a complete fixture reset is explicitly required.
 
 See [RELEASING.md](./RELEASING.md) for the guarded npm release procedure.
 

package/dist/TeleCryptIOStorage.d.ts

@@ -1,4 +1,4 @@
-import { MatrixClient } from "matrix-js-sdk";
+import { MatrixClient, MatrixEvent } from "matrix-js-sdk";
 import type { CryptoCallbacks } from "matrix-js-sdk/lib/crypto-api/index.js";
 import type { TokenRefreshFunction } from "matrix-js-sdk/lib/http-api/index.js";
 import type { RecoveryStatus } from "./core/types.js";
@@ -36,9 +36,7 @@ export interface FileBranch {
         info: Record<string, unknown>;
         httpUrl: string;
     }>;
-    getFileEvent(): Promise<{
-        getContent: () => Record<string, unknown>;
-    }>;
+    getFileEvent(): Promise<Pick<MatrixEvent, "getContent" | "getTs" | "isDecryptionFailure">>;
     getVersionHistory(): Promise<FileBranch[]>;
     createNewVersion(name: string, encryptedContents: ArrayBuffer | Uint8Array, info: Record<string, unknown>, additionalContent?: Record<string, unknown>): Promise<{
         event_id: string;
@@ -132,6 +130,12 @@ export interface MatrixRequestOptions {
     /** Internal Matrix SDK spelling used by `authedRequest`. */
     abortSignal?: AbortSignal;
 }
+export interface FileEventMetadata {
+    mimetype: string | null;
+    size: number | null;
+}
+/** Reads the event-owned metadata shared by details and download operations. */
+export declare function readFileEventMetadata(content: unknown): FileEventMetadata;
 /**
  * Serializes all tree mutations for one MatrixClient. A single queue is
  * intentional: separate per-room locks can deadlock when a parent mutation
@@ -285,12 +289,6 @@ export declare class TeleCryptIOStorage {
         role: string;
         membership: string;
     }[]>;
-    /**
-     * Returns the homeserver's complete joined-room inventory. Local sync room
-     * lists can be truncated by initialSyncLimit and are not an authoritative
-     * basis for deletion safety.
-     */
-    listJoinedRoomIds(options?: MatrixRequestOptions): Promise<string[]>;
     /** Reads one room membership from the homeserver, not the lagging local sync store. */
     getRoomMembership(roomId: string, userId?: string | null, options?: MatrixRequestOptions): Promise<string | null>;
     uploadFile(tree: TreeSpace, name: string, data: ArrayBuffer, mimetype: string, signal?: AbortSignal): Promise<string>;