@vcp-dev/site-edit-engine 0.4.8 → 0.6.0

package/dist/history/file-history-store.d.ts

@@ -0,0 +1,130 @@
+export type Sha256Digest = `sha256:${string}`;
+export type JsonValue = null | boolean | number | string | JsonValue[] | {
+    [key: string]: JsonValue;
+};
+export interface FileHistoryBlobInput {
+    readonly name: string;
+    readonly data: string | Uint8Array;
+}
+export interface FileHistoryAppendInput {
+    readonly kind: string;
+    readonly manifest: JsonValue;
+    readonly blobs?: ReadonlyArray<FileHistoryBlobInput>;
+}
+export interface FileHistoryBlobRef {
+    readonly name: string;
+    readonly digest: Sha256Digest;
+    readonly sizeBytes: number;
+}
+export interface FileHistoryEntryRecord {
+    readonly id: Sha256Digest;
+    readonly schemaVersion: 1;
+    readonly kind: string;
+    readonly manifest: JsonValue;
+    readonly blobs: ReadonlyArray<FileHistoryBlobRef>;
+}
+export interface FileHistoryIndexSnapshot {
+    readonly schemaVersion: 1;
+    readonly digest: Sha256Digest;
+    readonly entryIds: ReadonlyArray<Sha256Digest>;
+    readonly cursor: number;
+    readonly currentId: Sha256Digest | null;
+    readonly undoIds: ReadonlyArray<Sha256Digest>;
+    readonly redoIds: ReadonlyArray<Sha256Digest>;
+    readonly totalBytes: number;
+}
+export interface FileHistoryStageResult {
+    readonly stageId: string;
+    readonly entryId: Sha256Digest;
+    readonly blobIds: ReadonlyArray<Sha256Digest>;
+}
+export interface FileHistoryIndexTransition {
+    readonly expectedIndexDigest: Sha256Digest;
+    readonly publishedIndexDigest: Sha256Digest;
+    readonly publishedCursor: number;
+    readonly publishedCurrentId: Sha256Digest | null;
+}
+export interface FileHistoryStoreLimits {
+    readonly maxEntries: number;
+    readonly maxSessionBytes: number;
+    readonly maxEntryBytes: number;
+}
+export interface FileHistoryStoreOptions {
+    readonly limits?: Partial<FileHistoryStoreLimits>;
+}
+export interface FileHistoryStageOptions {
+    readonly durableManifest?: boolean;
+}
+export interface FileHistoryStatus {
+    readonly canUndo: boolean;
+    readonly canRedo: boolean;
+    readonly undoDepth: number;
+    readonly redoDepth: number;
+    readonly cursor: number;
+    readonly recoveryRequired: boolean;
+}
+export interface FileHistoryUndoRedoResult {
+    readonly undoIds: ReadonlyArray<Sha256Digest>;
+    readonly redoIds: ReadonlyArray<Sha256Digest>;
+    readonly currentId: Sha256Digest | null;
+}
+export interface FileHistoryTransactionJournalFile {
+    readonly path: string;
+    readonly preDigest: Sha256Digest | null;
+    readonly postDigest: Sha256Digest | null;
+}
+export interface FileHistoryTransactionJournal {
+    readonly schemaVersion: 2;
+    readonly transactionId: string;
+    readonly operationId: string;
+    readonly phase: "prepared" | "files-written" | "history-published";
+    readonly historyTransition: FileHistoryIndexTransition;
+    readonly files: ReadonlyArray<FileHistoryTransactionJournalFile>;
+}
+export interface FileHistoryStore {
+    readonly rootDir: string;
+    readonly recoveryRequired: boolean;
+    stageAppend(input: FileHistoryAppendInput, options?: FileHistoryStageOptions): Promise<FileHistoryStageResult>;
+    discardStage(stageId: string): Promise<void>;
+    previewStagedAppend(entryId: Sha256Digest, expectedIndexDigest?: Sha256Digest): Promise<FileHistoryIndexTransition>;
+    previewCursor(cursor: number, expectedIndexDigest?: Sha256Digest): Promise<FileHistoryIndexTransition>;
+    publishStagedAppend(entryId: Sha256Digest): Promise<FileHistoryIndexSnapshot>;
+    publishStagedAppend(entryId: Sha256Digest, expectedIndexDigest?: Sha256Digest, stageId?: string): Promise<FileHistoryIndexSnapshot>;
+    append(input: FileHistoryAppendInput): Promise<FileHistoryIndexSnapshot>;
+    readEntry(entryId: Sha256Digest): Promise<FileHistoryEntryRecord>;
+    readBlob(blobId: Sha256Digest): Promise<Uint8Array>;
+    readIndex(): Promise<FileHistoryIndexSnapshot>;
+    readStatus(): Promise<FileHistoryStatus>;
+    readUndoRedoIds(): Promise<FileHistoryUndoRedoResult>;
+    setCursor(cursor: number, expectedIndexDigest?: Sha256Digest): Promise<FileHistoryIndexSnapshot>;
+    markRecoveryRequired(reason: string): Promise<void>;
+    clearRecoveryRequired(): Promise<void>;
+    readTransactionJournal(): Promise<FileHistoryTransactionJournal | null>;
+    writeTransactionJournal(journal: FileHistoryTransactionJournal): Promise<void>;
+    clearTransactionJournal(transactionId: string): Promise<void>;
+    cleanupTmp(): Promise<void>;
+    readDocumentVersion?(): Promise<number>;
+    writeDocumentVersion?(version: number): Promise<void>;
+}
+export declare const FILE_HISTORY_DEFAULT_LIMITS: FileHistoryStoreLimits;
+declare const HISTORY_ERROR_CODES: {
+    readonly INVALID_ROOT: "INVALID_ROOT";
+    readonly INVALID_PATH: "INVALID_PATH";
+    readonly INVALID_SCHEMA: "INVALID_SCHEMA";
+    readonly INVALID_JSON: "INVALID_JSON";
+    readonly INDEX_CORRUPT: "INDEX_CORRUPT";
+    readonly ENTRY_CORRUPT: "ENTRY_CORRUPT";
+    readonly BLOB_CORRUPT: "BLOB_CORRUPT";
+    readonly RECOVERY_PENDING: "RECOVERY_PENDING";
+    readonly CAPACITY_EXCEEDED: "CAPACITY_EXCEEDED";
+    readonly NOT_FOUND: "NOT_FOUND";
+};
+export type FileHistoryStoreErrorCode = (typeof HISTORY_ERROR_CODES)[keyof typeof HISTORY_ERROR_CODES];
+export declare class FileHistoryStoreError extends Error {
+    readonly code: FileHistoryStoreErrorCode;
+    constructor(code: FileHistoryStoreErrorCode, message: string, options?: {
+        cause?: unknown;
+    });
+}
+export declare function openFileHistoryStore(rootDir: string, options?: FileHistoryStoreOptions): Promise<FileHistoryStore>;
+export {};

package/dist/history/index.d.ts

@@ -0,0 +1,2 @@
+export { FILE_HISTORY_DEFAULT_LIMITS, FileHistoryStoreError, openFileHistoryStore, } from "./file-history-store.js";
+export type { FileHistoryAppendInput, FileHistoryBlobInput, FileHistoryBlobRef, FileHistoryEntryRecord, FileHistoryIndexSnapshot, FileHistoryIndexTransition, FileHistoryStageResult, FileHistoryStore, FileHistoryStoreErrorCode, FileHistoryStoreLimits, FileHistoryStoreOptions, FileHistoryTransactionJournal, FileHistoryTransactionJournalFile, FileHistoryUndoRedoResult, JsonValue, Sha256Digest, } from "./file-history-store.js";

package/dist/index.d.ts

@@ -1,3 +1,9 @@
 export { createSiteEditEngineRuntime, SnapshotSiteEditEngineRuntime, } from "./runtime.js";
 export { createPreviewSiteEditEngineRuntime, PreviewFileSystemSiteEditEngineRuntime, } from "./preview-runtime.js";
-export type { PreviewSiteEditEngineRuntime, PreviewSiteEditEngineRuntimeOptions, SiteEditProjectFileSystem, SiteEditEngineRoute, SiteEditEngineRuntime, SiteEditEngineRuntimeOptions, SiteEditPlanOperationResult, SiteEditSnapshotFile, } from "./types.js";
+export { createEd25519MutationContextVerifier } from "./mutation-context-verifier.js";
+export { scanSiteEditThemeStyleViolations, SITE_EDIT_RAW_COLOR_LITERAL_RE, } from "./materialization-style-policy.js";
+export type { SiteEditColorMixPolicy, SiteEditThemeStyleScanOptions, SiteEditThemeStyleViolations, } from "./materialization-style-policy.js";
+export type { Ed25519MutationContextVerifierOptions, SiteEditMutationAssertionExpected, SiteEditMutationContextVerifier, SiteEditMutationVerificationFailureCode, SiteEditMutationVerificationResult, } from "./mutation-context-verifier.js";
+export type { PreviewSiteEditEngineRuntime, PreviewSiteEditEngineRuntimeOptions, SiteEditProjectFileSystem, SiteEditEngineRoute, SiteEditEngineHistoryStatus, SiteEditEngineRuntime, SiteEditEngineRuntimeOptions, SiteEditPlanOperationResult, SiteEditSnapshotFile, } from "./types.js";
+export { FileHistoryStoreError, openFileHistoryStore, } from "./history/index.js";
+export type { FileHistoryAppendInput, FileHistoryBlobInput, FileHistoryBlobRef, FileHistoryEntryRecord, FileHistoryIndexSnapshot, FileHistoryIndexTransition, FileHistoryStageResult, FileHistoryStore, FileHistoryStoreErrorCode, FileHistoryStoreLimits, FileHistoryStoreOptions, FileHistoryTransactionJournal, FileHistoryTransactionJournalFile, FileHistoryUndoRedoResult, JsonValue, Sha256Digest, } from "./history/index.js";