@hyperframes/share 0.0.0-stage → 0.9.22

package/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by the Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding any notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2026 HeyGen, Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,3 +1,52 @@
-# Temporary Holding Version
+# @hyperframes/share
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Node-only sharing kernel for Desktop, the CLI and local Studio's server. All hosts use the same review project, link settings, video versions and persisted retry state. This package does not render videos, sign users in, or define plan policy.
+
+```js
+import {
+  bindShareHost,
+  reviewClient,
+  signedInRequest,
+  projectFingerprint,
+  shareForReview,
+  addVersion,
+  reviewStatus,
+  reviewVersion,
+} from "@hyperframes/share";
+
+bindShareHost({
+  normalize: realpathSync,
+  channelSite: "https://hyperframes.dev",
+  signinSites: ["https://hyperframes.dev"],
+  reviewUploadOrigins: ["https://review-bucket.s3.us-east-1.amazonaws.com"],
+  signedInRequest,
+  projectFingerprint,
+  latestExportFile, // (dir) => { path, fingerprint, id } | null
+  ffBinary, // ('ffprobe') => executable path
+});
+const client = reviewClient({ access, signedInEmail });
+const share = await shareForReview({ projectPath, title, client, audience: "public" });
+await addVersion({ projectPath, title, client, onProgress });
+const [current, version] = await Promise.all([
+  reviewStatus({ projectPath, client }),
+  reviewVersion(projectPath),
+]);
+```
+
+`access(refusedToken?)` returns `{ token, heygen, heygenApi, owner }` or null. It is read for every request. A refused bearer is passed back so the host can refresh it. `heygen` is the review API base. A host can inject its own `signedInRequest` to retain network tracing. `execFile` can likewise be injected to retain native process policy.
+
+Video uploads require exact storage origins from trusted host configuration. Set `reviewUploadOrigins` on the host or supply a comma-separated `HYPERFRAMES_REVIEW_UPLOAD_ORIGINS` environment variable. Configure the bucket-specific HTTPS origins used by the signer. Use URL origins without paths, trailing slashes, or wildcards. Local tests can explicitly allow an HTTP origin on `127.0.0.1`. An empty list refuses every video upload.
+
+Before first registration the host must obtain explicit audience consent and prepare a current MP4. `shareForReview` registers/enables the link; it does not imply playable media. Await `addVersion`, then check the server project/latest ready version before reporting success. `addFirstVersion` starts background work and is for long-lived hosts only. `open: () => boolean` on `addVersion` bounds the polling lifetime without discarding the saved operation. `filesForExport(projectPath, renderedFingerprint)` optionally supplies an already-synced matching snapshot. Omit it for ordinary video sharing.
+
+`reviewClient` exposes workspace capabilities, project listing/removal, grants, revision-checked access changes and export operations. `setReviewAccess`, `turnOffReviewLink`, and `removeReviewProject` retain the Desktop behavior. Enabling a revoked link produces a new URL. Disabling keeps the project and comments; removal is a separate operation.
+
+Hosts can sync a renamed project with `client.updateTitle(id, { title, expected_title })`. An optional `fromReview` hook on `addVersion` supplies feedback attribution after sign-in on each send. Pass the same hook to `recheckHeld` or `refreshReviewExport` to clear the recorded activity when a pending version becomes ready.
+
+Identity remains in the project’s generated review.json metadata (or the existing backend-specific filename); pending export requests remain in the generated review-export.json metadata. No bearer is stored there. A copied folder must deliberately reset sharing identity when creating a new project; a renamed folder retains it. A malformed/unreadable record fails instead of silently registering a new project. The error identifies the metadata file and asks the owner to restore a backup or contact support to reconnect the existing share; deleting the file can discard recovery state or consume another slot.
+
+Metadata mutations and version uploads use separate cross-process locks under `.hyperframes`. Locks normally publish complete owner metadata with a hard link. Volumes that reject hard links use exclusive file creation instead; contenders wait while the owner metadata is written. An interrupted empty/malformed fallback lock is not automatically stolen. A lock is reclaimed only when the same machine proves its owner process is dead; live, foreign-machine and malformed locks are not stolen. Interrupted upload operations resume with their saved idempotency keys. Concurrent identical uploads re-read the completed version under the lock and do not create another version.
+
+`snapshotProject` skips symlinks by default, retaining Desktop watcher, change-set and saved-render compatibility; `snapshotFiles` also skips symlink entries. Set `followSymlinks: true` for a link-aware full snapshot. The CLI-facing `projectFingerprint` opts into following linked media (with cycle detection), so edited linked files invalidate its cached render. Both comparisons ignore HTML ID stamps. Export/history metadata, caches, hidden folders and installed packages are excluded. Hosts must record the fingerprint of the actual rendered source and must not relabel an old render with a newer fingerprint.
+
+Public type exports include `ShareHost`, `ReviewClient`, `ReviewShare`, `VersionRequest`, and `Wire`, plus `@hyperframes/share/types/reviewWire` and `types/share`. Per-module entry points preserve Desktop imports during adoption.

package/dist/appOwnedPaths.d.mts

@@ -0,0 +1,6 @@
+/** A file the film can never load, so no change report counts it: the app's own folders, anything hidden
+ * (a dot file or folder: .git, .DS_Store), installed packages, and temporary editor or download files.
+ * @param {string} relativePath */
+export function isOutsideFilm(relativePath: string): boolean;
+export const APP_OWNED_DIRS: string[];
+export function isAppOwned(relativePath: string): boolean;

package/dist/fromReview.d.mts

@@ -0,0 +1,15 @@
+/** @typedef {{ read: (dir: string) => Promise<"yes" | "no" | null>,
+ *   published: (dir: string, since: number) => Promise<void>, now: () => number }} FromReview */
+/** @param {FromReview} host @param {string} dir */
+export function readFromReview(host: FromReview, dir: string): Promise<{
+    value?: "yes" | "no" | undefined;
+    since: number;
+}>;
+/** Clear activity through the start of the successful share, keeping anything recorded later.
+ * @param {FromReview | null} host @param {string} dir @param {number | undefined} since */
+export function sharedFromReview(host: FromReview | null, dir: string, since: number | undefined): Promise<void>;
+export type FromReview = {
+    read: (dir: string) => Promise<"yes" | "no" | null>;
+    published: (dir: string, since: number) => Promise<void>;
+    now: () => number;
+};

package/dist/grantRefusal.d.mts

@@ -0,0 +1,8 @@
+/** Definitive refusals are per-call data, not the project's mutable last-issue lookup.
+ * @param {unknown} error */
+export function rejectedGrantRequest(error: unknown): boolean;
+/** An explicit wire protocol survives Electron's Error-only serialization and the browser bridge.
+ * @param {string} reason @param {string} message */
+export function grantRefusalMessage(reason: string, message: string): string;
+/** @param {unknown} error */
+export function decodeGrantRefusal(error: unknown): unknown;

package/dist/host.d.mts

@@ -0,0 +1,29 @@
+export function bindShareHost(part: Partial<ShareHost>): undefined;
+/** @type {ShareHost["normalize"]} */
+export const normalize: ShareHost["normalize"];
+/** @type {ShareHost["assertOpenProject"]} */
+export const assertOpenProject: ShareHost["assertOpenProject"];
+/** @type {ShareHost["resolveOpenProjectByPath"]} */
+export const resolveOpenProjectByPath: ShareHost["resolveOpenProjectByPath"];
+/** @type {ShareHost["listOpenProjects"]} */
+export const listOpenProjects: ShareHost["listOpenProjects"];
+/** @type {ShareHost["homeName"]} */
+export const homeName: ShareHost["homeName"];
+/** @type {ShareHost["uploadWithProgress"]} */
+export const uploadWithProgress: ShareHost["uploadWithProgress"];
+/** @type {ShareHost["signedInRequest"]} */
+export const signedInRequest: ShareHost["signedInRequest"];
+/** @type {ShareHost["latestExportFile"]} */
+export const latestExportFile: ShareHost["latestExportFile"];
+export function reviewUploadOrigins(): readonly string[];
+/** @type {ShareHost["projectFingerprint"]} */
+export const projectFingerprint: ShareHost["projectFingerprint"];
+/** @type {ShareHost["ffBinary"]} */
+export const ffBinary: ShareHost["ffBinary"];
+export function channelSite(): string;
+export function signinSites(): string[];
+export function runFile(file: string, args: string[]): import("node:child_process").PromiseWithChild<{
+    stdout: string;
+    stderr: string;
+}>;
+export type ShareHost = import("./hosts.js").ShareHost;

package/dist/hosts.d.ts

@@ -0,0 +1,39 @@
+import type { SignedInDeps, signedInRequest } from "./signedInRequest.mjs";
+
+/** What sharing a project and its review link take from the host's main process (host.mjs bindShareHost). The
+ * network and the person's session stay the host's: every review call goes through its signed-in request and every
+ * archive through its uploader. */
+export interface ShareHost {
+  execFile: typeof import("node:child_process").execFile;
+  /** The key every open-project lookup uses: the real path. */
+  normalize(path: string): string;
+  /** The open project's normalized path; refuses a project that is not open. */
+  assertOpenProject(path: string): string;
+  /** The open project at `path`, or null when it is not open. */
+  resolveOpenProjectByPath(path: string): { id: string; dir: string } | null;
+  /** All open projects, for invalidating removed review identities. */
+  listOpenProjects(): Array<{ dir: string }>;
+  /** The name the host shows for a project. */
+  homeName(path: string, folder?: string): string;
+  /** PUTs an archive through the host's network, hearing each chunk sent; answers the HTTP status. */
+  uploadWithProgress(
+    url: URL,
+    headers: Record<string, string>,
+    archive: Uint8Array,
+    onSent: (sent: number) => void,
+  ): Promise<number>;
+  /** Requests to HeyGen's sign-in host as the signed-in person, traced as the host traces its API calls. */
+  signedInRequest(deps: Omit<SignedInDeps, "trace">): ReturnType<typeof signedInRequest>;
+  /** The newest finished export recorded in the project's renders folder whose file is still there. */
+  latestExportFile(dir: string): { path: string; fingerprint?: string; id: string } | null;
+  /** Trusted video upload origins configured by the host independently of the review API response. */
+  reviewUploadOrigins?: readonly string[];
+  /** The project as change detection sees it, as one hash. */
+  projectFingerprint(dir: string): Promise<string>;
+  /** The path of the host's FFmpeg tool `name`. */
+  ffBinary(name: "ffprobe"): string;
+  /** The sign-in site of the host's own channel, whose review record keeps the original name. */
+  channelSite: string;
+  /** Every sign-in site the host can sign in on. */
+  signinSites: string[];
+}

package/dist/index.d.mts

@@ -0,0 +1,21 @@
+export { firstReviewAudience } from "./reviewAudience.mjs";
+export { versionSentence } from "./reviewVersionSentences.mjs";
+export { shareOpenCalls } from "./reviewOpenCalls.mjs";
+export { bindShareHost } from "./host.mjs";
+export type ShareHost = import("./hosts.js").ShareHost;
+export type ReviewClient = import("./reviewClient.mjs").ReviewClient;
+export type ReviewShare = import("./types/share.js").ReviewShare;
+export type VersionRequest = import("./reviewExport.mjs").VersionRequest;
+export type Wire = typeof import("./types/reviewWire.js");
+export type AccessMode = import("./types/share.js").AccessMode;
+export type ReviewExportProgress = import("./types/share.js").ReviewExportProgress;
+export { setReviewSite, takenDown, listSpaces, reviewSpaces, shown, ownerOf, projectLine, oneAtATime, changeShare, reviewProjectId, localReviewProjects, reviewRecord, reviewRecordPath, reviewSwitchPath, onRebound, rebindRecord, setAsideReview, shareAnew, readShare, reviewStatus, shareForReview, setReviewAccess, turnOffReviewLink, reviewSentence, markReviewRemoved, removeLocalReview, removeReviewProject, reviewDestination } from "./reviewShare.mjs";
+export { factsOf, reviewVersion, addVersion, recheckHeld, refreshReviewExport, addFirstVersion, versionFacts, versionOnPage, markFiles, pendingReviewExport } from "./reviewExport.mjs";
+export { ReviewFailed, SHARING_REFUSALS, reviewClient } from "./reviewClient.mjs";
+export { filesStateOf, reviewFiles } from "./reviewFiles.mjs";
+export { switchOperationId, retryOldLink, oldLinkOf, changeSpace, resumeSpaceChange, switchSentence } from "./reviewSwitch.mjs";
+export { fileSha256Base64, putFile } from "./reviewUpload.mjs";
+export { linkStateOf, reviewLinkStates } from "./reviewLinkStates.mjs";
+export { AccountUnreachable, UNREACHABLE, readOrUnreachable, orIfUnreachable, signedInRequest } from "./signedInRequest.mjs";
+export { HF_ID_ATTRIBUTE, contentKey, snapshotProject, snapshotFingerprint, snapshotFiles, diffChangedFiles, projectFingerprint } from "./projectSnapshot.mjs";
+export { ShareBusyError, withProjectShareLock } from "./projectLock.mjs";

package/dist/projectLock.d.mts

@@ -0,0 +1,17 @@
+/** @template T @param {string} projectPath @param {"review" | "export"} lane @param {() => Promise<T>} run
+ * @param {{ timeoutMs?: number, signal?: AbortSignal }} [options] @returns {Promise<T>} */
+export function withProjectShareLock<T>(projectPath: string, lane: "review" | "export", run: () => Promise<T>, { timeoutMs, signal }?: {
+    timeoutMs?: number;
+    signal?: AbortSignal;
+}): Promise<T>;
+export class ShareBusyError extends Error {
+    /** @param {string} path */
+    constructor(path: string);
+    reason: string;
+    lockPath: string;
+}
+export type Owner = {
+    token: string;
+    pid: number;
+    hostname: string;
+};

package/dist/projectSnapshot.d.mts

@@ -0,0 +1,20 @@
+/** @param {string} html */
+export function contentKey(html: string): string;
+/** @typedef {Map<string, unknown>} Snapshot */
+/** @param {string} dir @param {{ byContent?: boolean, followSymlinks?: boolean }} [options] @returns {Promise<Snapshot>} */
+export function snapshotProject(dir: string, { byContent, followSymlinks }?: {
+    byContent?: boolean;
+    followSymlinks?: boolean;
+}): Promise<Snapshot>;
+/** What an export's sidecar records of the project, from a snapshot already taken.
+ * @param {Snapshot} snapshot */
+export function snapshotFingerprint(snapshot: Snapshot): string;
+/** Just these project files, keyed as snapshotProject keys them (undefined: not a file the snapshot holds); null when
+ * one is a folder, which only a whole snapshot covers. @param {string} dir @param {Iterable<string>} files
+ * @returns {Promise<Map<string, unknown> | null>} */
+export function snapshotFiles(dir: string, files: Iterable<string>): Promise<Map<string, unknown> | null>;
+/** @param {Snapshot} before @param {Snapshot} after */
+export function diffChangedFiles(before: Snapshot, after: Snapshot): string[];
+export const HF_ID_ATTRIBUTE: RegExp;
+export function projectFingerprint(projectPath: string): Promise<string>;
+export type Snapshot = Map<string, unknown>;

package/dist/reviewAudience.d.mts

@@ -0,0 +1,3 @@
+/** @param {import("./types/reviewWire.js").ReviewEntitlements | null | undefined} entitlements
+ * @param {import("./types/share.js").AccessMode | undefined} chosen */
+export function firstReviewAudience(entitlements: import("./types/reviewWire.js").ReviewEntitlements | null | undefined, chosen: import("./types/share.js").AccessMode | undefined): import("./types/share.js").AccessMode;

package/dist/reviewClient.d.mts

@@ -0,0 +1,122 @@
+/** @param {{ access: import("./types/access.js").ApiAccess, fetchImpl?: typeof fetch,
+ *   signedInEmail?: () => Promise<string | null> }} deps */
+export function reviewClient({ access, fetchImpl, signedInEmail }: {
+    access: import("./types/access.js").ApiAccess;
+    fetchImpl?: typeof fetch;
+    signedInEmail?: () => Promise<string | null>;
+}): {
+    /** Accept, dismiss, reopen or resolve a thread. @param {string} id @param {string} rootId
+     * @param {{ action: import("./types/review.js").ReviewAction, expected_status_revision: number }} body */
+    setStatus: (id: string, rootId: string, body: {
+        action: import("./types/review.js").ReviewAction;
+        expected_status_revision: number;
+    }) => Promise<any>;
+    /** @param {string} id @param {string} rootId
+     * @param {{ client_operation_id: string, body: string, attachment_ids: string[] }} body */
+    reply: (id: string, rootId: string, body: {
+        client_operation_id: string;
+        body: string;
+        attachment_ids: string[];
+    }) => Promise<any>;
+    /** @param {string} id @param {{ title: string, expected_title: string }} body
+     * @returns {Promise<{title: string}>} */
+    updateTitle: (id: string, body: {
+        title: string;
+        expected_title: string;
+    }) => Promise<{
+        title: string;
+    }>;
+    /** @param {string} spaceId @param {string | null} [cursor] @returns
+     * {Promise<import("./types/reviewWire.js").ManagedReviewPage>} */
+    listProjects: (spaceId: string, cursor?: string | null) => Promise<import("./types/reviewWire.js").ManagedReviewPage>;
+    /** @param {string} id @returns {Promise<null>} */
+    removeProject: (id: string) => Promise<null>;
+    /** @param {string} id @returns {Promise<{items: import("./types/reviewWire.js").AccessGrantDTO[]}>} */
+    grants: (id: string) => Promise<{
+        items: import("./types/reviewWire.js").AccessGrantDTO[];
+    }>;
+    createGrant: (id: string, body: import("./types/reviewWire.js").CreateGrantRequest) => Promise<import("./types/reviewWire.js").AccessGrantDTO>;
+    /** @param {string} id @param {string} grantId @param {{role: import("./types/reviewWire.js").AccessGrantDTO["role"],
+     * expected_revision: number}} body @returns {Promise<import("./types/reviewWire.js").AccessGrantDTO>} */
+    updateGrant: (id: string, grantId: string, body: {
+        role: import("./types/reviewWire.js").AccessGrantDTO["role"];
+        expected_revision: number;
+    }) => Promise<import("./types/reviewWire.js").AccessGrantDTO>;
+    /** @param {string} id @param {string} grantId @returns {Promise<null>} */
+    revokeGrant: (id: string, grantId: string) => Promise<null>;
+    openSummary: (token: string, versionId: string | null) => Promise<import("./types/shareOpen.js").OpenSummaryDTO>;
+    versionFiles: (token: string, versionId: string) => Promise<import("./types/shareOpen.js").VersionFilesDTO>;
+    fileUrls: (token: string, versionId: string, continuation: string, sha256s: string[]) => Promise<import("./types/shareOpen.js").FileUrlsDTO>;
+    logCopy: (token: string, versionId: string, handoffId: string | null) => Promise<null>;
+    /** The signed-in account's email, null when unknown; the record keeps it as the project's owner. */
+    signedInEmail: () => Promise<string | null>;
+    /** The spaces this account can share into, personal first.
+     * @returns {Promise<import("./types/reviewWire.js").SpaceDTO[]>} */
+    spaces: () => Promise<import("./types/reviewWire.js").SpaceDTO[]>;
+    /** The server's per-account flags on review-spaces, each on only for `true`: `hyperframes-review-version-sharing`
+     * and `hyperframes-review-share-files`. One read answers both.
+     * @returns {Promise<{ versionSharing: boolean, shareFiles: boolean }>} */
+    reviewFlags: () => Promise<{
+        versionSharing: boolean;
+        shareFiles: boolean;
+    }>;
+    /** Registers into `spaceId`; without one the server uses the caller's default space.
+     * @param {import("./types/reviewWire.js").RegisterProjectRequest} body @param {string | null} [spaceId]
+     * @returns {Promise<ProjectDTO>} */
+    register: (body: import("./types/reviewWire.js").RegisterProjectRequest, spaceId?: string | null) => Promise<ProjectDTO>;
+    /** @param {string} id @returns {Promise<ShareDTO>} */
+    share: (id: string) => Promise<ShareDTO>;
+    /** @param {string} id @param {import("./types/reviewWire.js").UpdateProjectShareRequest} body
+     * @returns {Promise<ShareDTO>} */
+    updateShare: (id: string, body: import("./types/reviewWire.js").UpdateProjectShareRequest) => Promise<ShareDTO>;
+    /** @param {string} id @param {import("./types/reviewWire.js").ProjectOperationRequest} body @returns {Promise<ShareDTO>} */
+    linkOn: (id: string, body: import("./types/reviewWire.js").ProjectOperationRequest) => Promise<ShareDTO>;
+    /** @param {string} id @returns {Promise<null>} */
+    linkOff: (id: string) => Promise<null>;
+    /** @param {string} id @returns {Promise<ProjectDTO>} */
+    project: (id: string) => Promise<ProjectDTO>;
+    /** One page of the project's comments, every state. @param {string} id @param {URLSearchParams} query
+     * @returns {Promise<import("./types/reviewWire.js").FeedbackPage>} */
+    feedback: (id: string, query: URLSearchParams) => Promise<import("./types/reviewWire.js").FeedbackPage>;
+    /** A new version from a local MP4. A body factory runs after sign-in on each attempt.
+     * @param {string} id @param {ExportRequest | (() => Promise<ExportRequest>)} body @returns {Promise<ExportDTO>} */
+    createExport: (id: string, body: ExportRequest | (() => Promise<ExportRequest>)) => Promise<ExportDTO>;
+    /** @param {string} id @param {string} videoId @returns {Promise<ExportDTO>} */
+    readExport: (id: string, videoId: string) => Promise<ExportDTO>;
+    /** The upload is in storage: start processing. @param {string} id @param {string} videoId
+     * @returns {Promise<ExportDTO>} */
+    completeExport: (id: string, videoId: string) => Promise<ExportDTO>;
+    /** Attaches the synced snapshot to a version that has none; the same one again is a no-op, another is refused
+     * with 409 `snapshot_already_attached`. @param {string} id @param {string} versionId
+     * @param {import("./types/reviewWire.js").SnapshotRef} snapshot @returns {Promise<unknown>} */
+    attachSnapshot: (id: string, versionId: string, snapshot: import("./types/reviewWire.js").SnapshotRef) => Promise<unknown>;
+};
+/** A refused or failed call: the HTTP status (0 when the server was never reached) and the server's reason. */
+export class ReviewFailed extends Error {
+    /** @param {number} status @param {string} reason @param {number} [currentRevision] @param {number} [retryAfterMs]
+     * @param {import("./types/reviewWire.js").ErrorEnvelope["data"]} [details] */
+    constructor(status: number, reason: string, currentRevision?: number, retryAfterMs?: number, details?: import("./types/reviewWire.js").ErrorEnvelope["data"]);
+    status: number;
+    reason: string;
+    currentRevision: number | undefined;
+    retryAfterMs: number | undefined;
+    details: {
+        reason: string;
+        current_revision?: number;
+        space?: {
+            name: string;
+            kind: "team";
+        };
+        workspace_id?: string;
+        project_limit?: number;
+        projects_used_up_to_limit?: number;
+        requested_feature?: string;
+    } | undefined;
+}
+/** The server's own "no" to the sharing read: signed out, not allowed, or no such route. */
+export const SHARING_REFUSALS: number[];
+export type ReviewClient = ReturnType<typeof reviewClient>;
+export type ExportRequest = import("./types/reviewWire.js").ExportRequest;
+export type ShareDTO = import("./types/reviewWire.js").ShareDTO;
+export type ProjectDTO = import("./types/reviewWire.js").ProjectDTO;
+export type ExportDTO = import("./types/reviewWire.js").ExportDTO;