@nemphi/sdk 0.2.4643 → 0.2.4682

package/dist/index.d.ts

@@ -1478,6 +1478,19 @@ export type LiveDocumentPlace = {
     folder_id?: string;
 };
 /** A tag on a document: put there by a person (`manual`) or by Clef (`auto`). */
+/** One kept version of a live document; `state` only when one version is read. */
+export interface LiveDocumentVersion {
+    id: string;
+    seq: number;
+    /** A name given by hand; null for a version known by its time. */
+    name: string | null;
+    /** Kept on its own while people edited. */
+    auto: boolean;
+    author_name: string;
+    created_at: string;
+    /** The whole Yjs state as one base64 update. */
+    state?: string;
+}
 export interface LiveDocumentTag {
     id: string;
     name: string;
@@ -1496,14 +1509,16 @@ export interface LiveDocument {
     tags: LiveDocumentTag[];
     created_at: string;
     updated_at: string;
+    /** When it went to the trash; null while it is on a shelf. */
+    trashed_at: string | null;
 }
 /**
  * Which documents `listLiveDocuments` answers: one shelf (the caller's
- * own, other members' shared with them, or the team space), one folder or
- * the shelf's top level, one tag.
+ * own, other members' shared with them, or the team space) or the trash,
+ * one folder or the shelf's top level, one tag.
  */
 export interface LiveDocumentFilter {
-    view?: LiveDocumentSpace | "shared";
+    view?: LiveDocumentSpace | "shared" | "trash";
     folder_id?: string;
     top_level?: boolean;
     tag?: string;
@@ -1544,6 +1559,8 @@ export interface LiveDocumentState {
     kind: LiveDocumentKind;
     state: string;
     seq: number;
+    /** Set while the document is in the trash, where it opens read-only. */
+    trashed_at: string | null;
 }
 /**
  * A picture stored with a live document. `id` is the bytes' hash and
@@ -8099,6 +8116,17 @@ export interface NemphiClient {
     createLiveDocument(title: string, kind?: LiveDocumentKind, place?: LiveDocumentPlace): Promise<LiveDocument>;
     /** Files a document in a folder (empty: the top level) or moves it to another space. */
     moveLiveDocument(id: string, place: LiveDocumentPlace): Promise<LiveDocument>;
+    renameLiveDocument(id: string, title: string): Promise<LiveDocument>;
+    /** A copy of the document's content as a new document of the caller's own. */
+    copyLiveDocument(id: string, title?: string): Promise<LiveDocument>;
+    /** Moves a document to the trash; it opens read-only until restored. */
+    trashLiveDocument(id: string): Promise<LiveDocument>;
+    restoreLiveDocument(id: string): Promise<LiveDocument>;
+    /** Deletes a trashed document for good. */
+    deleteLiveDocument(id: string): Promise<{
+        id: string;
+        deleted: boolean;
+    }>;
     listLiveDocumentShares(id: string): Promise<LiveDocumentShares>;
     shareLiveDocument(id: string, userId: string): Promise<LiveDocumentShares>;
     unshareLiveDocument(id: string, userId: string): Promise<LiveDocumentShares>;
@@ -8125,6 +8153,16 @@ export interface NemphiClient {
     pushLiveDocumentUpdate(id: string, update: string): Promise<{
         seq: number;
     }>;
+    /** A document's version history, newest first, without the states. */
+    listLiveDocumentVersions(id: string): Promise<{
+        versions: LiveDocumentVersion[];
+    }>;
+    /** Keeps the document as it is now as a version, named when `name` is not empty. */
+    createLiveDocumentVersion(id: string, name: string): Promise<LiveDocumentVersion>;
+    /** One version with its state. */
+    getLiveDocumentVersion(id: string, versionId: string): Promise<LiveDocumentVersion>;
+    /** Names a version; an empty name takes the name off. */
+    renameLiveDocumentVersion(id: string, versionId: string, name: string): Promise<void>;
     /** Stores a PNG, JPEG, WebP or GIF (10 MiB at most) with a live document. */
     uploadLiveDocumentAsset(id: string, file: Blob, opts?: {
         filename?: string;