@yorkie-js/sdk 0.6.39 → 0.6.40

package/dist/yorkie-js-sdk.d.ts

@@ -9,6 +9,7 @@ import { PartialMessage } from '@bufbuild/protobuf';
 import { PlainMessage } from '@bufbuild/protobuf';
 import { proto3 } from '@bufbuild/protobuf';
 import { Rule } from '@yorkie-js/schema';
+import { Timestamp } from '@bufbuild/protobuf';
 
 /**
  * `ActorID` is used to identify who is making changes to the document.
@@ -1083,6 +1084,22 @@ export declare class Client {
      * `getCondition` returns the condition of this client.
      */
     getCondition(condition: ClientCondition): boolean;
+    /**
+     * `createRevision` creates a new revision for the given document.
+     */
+    createRevision<R, P extends Indexable>(doc: Document_2<R, P>, label: string, description?: string): Promise<RevisionSummary>;
+    /**
+     * `listRevisions` lists all revisions for the given document.
+     */
+    listRevisions<R, P extends Indexable>(doc: Document_2<R, P>, options?: {
+        pageSize?: number;
+        offset?: number;
+        isForward?: boolean;
+    }): Promise<Array<RevisionSummary>>;
+    /**
+     * `restoreRevision` restores the document to the given revision.
+     */
+    restoreRevision<R, P extends Indexable>(doc: Document_2<R, P>, revisionId: string): Promise<void>;
     /**
      * `broadcast` broadcasts the given payload to the given topic.
      */
@@ -1274,6 +1291,7 @@ export declare const converter: {
     versionVectorToHex: typeof versionVectorToHex;
     hexToVersionVector: typeof hexToVersionVector;
     fromSchemaRules: typeof fromSchemaRules;
+    toRevisionSummary: typeof toRevisionSummary;
 };
 
 /**
@@ -4861,6 +4879,69 @@ declare type RemoveOpInfo_2 = {
  */
 declare type ResourceStatus = 'detached' | 'attached' | 'removed';
 
+/**
+ * `RevisionSummary` represents a document revision for version management.
+ * It stores a snapshot of document content at a specific point in time,
+ * enabling features like rollback, audit, and version history tracking.
+ */
+export declare interface RevisionSummary {
+    /**
+     * `id` is the unique identifier of the revision.
+     */
+    id: string;
+    /**
+     * `label` is a user-friendly name for this revision.
+     */
+    label: string;
+    /**
+     * `description` is a detailed explanation of this revision.
+     */
+    description: string;
+    /**
+     * `snapshot` is the serialized document content (JSON format) at this revision point.
+     * This contains only the pure data without CRDT metadata.
+     */
+    snapshot: string;
+    /**
+     * `createdAt` is the time when this revision was created.
+     */
+    createdAt: Date;
+}
+
+/**
+ * @generated from message yorkie.v1.RevisionSummary
+ */
+declare class RevisionSummary_2 extends Message<RevisionSummary_2> {
+    /**
+     * @generated from field: string id = 1;
+     */
+    id: string;
+    /**
+     * @generated from field: string label = 2;
+     */
+    label: string;
+    /**
+     * @generated from field: string description = 3;
+     */
+    description: string;
+    /**
+     * @generated from field: string snapshot = 4;
+     */
+    snapshot: string;
+    /**
+     * @generated from field: google.protobuf.Timestamp created_at = 5;
+     */
+    createdAt?: Timestamp;
+    constructor(data?: PartialMessage<RevisionSummary_2>);
+    static readonly runtime: typeof proto3;
+    static readonly typeName = "yorkie.v1.RevisionSummary";
+    static readonly fields: FieldList;
+    static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): RevisionSummary_2;
+    static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): RevisionSummary_2;
+    static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): RevisionSummary_2;
+    static equals(a: RevisionSummary_2 | PlainMessage<RevisionSummary_2> | undefined, b: RevisionSummary_2 | PlainMessage<RevisionSummary_2> | undefined): boolean;
+}
+
 /**
  * `RGATreeSplit` is a block-based list with improved index-based lookup in RGA.
  * The difference from RGATreeList is that it has data on a block basis to
@@ -6071,6 +6152,11 @@ declare enum TokenType {
  */
 declare function toOperation(operation: Operation): Operation_2;
 
+/**
+ * `toRevisionSummary` converts a protobuf RevisionSummary to a RevisionSummary.
+ */
+declare function toRevisionSummary(pbRevision: RevisionSummary_2): RevisionSummary;
+
 /**
  * `toTreeNodes` converts the given model to Protobuf format.
  */