@aprovan/patchwork-compiler 0.1.0 → 0.1.2-dev.1a732c5

package/dist/index.d.ts

@@ -6,19 +6,13 @@ interface VirtualFile {
     content: string;
     language?: string;
     note?: string;
+    encoding?: "utf8" | "base64";
 }
 interface VirtualProject {
     id: string;
     entry: string;
     files: Map<string, VirtualFile>;
 }
-interface StorageBackend {
-    get(path: string): Promise<string | null>;
-    put(path: string, content: string): Promise<void>;
-    delete(path: string): Promise<void>;
-    list(prefix?: string): Promise<string[]>;
-    exists(path: string): Promise<boolean>;
-}
 
 /**
  * Core types for the Patchwork compiler
@@ -142,6 +136,12 @@ interface CompilerOptions {
     cdnBaseUrl?: string;
     /** Base URL for widget imports (default: same as cdnBaseUrl). Used for transforming imports in widget code. */
     widgetCdnBaseUrl?: string;
+    /**
+     * URL overrides for bundled assets/packages.
+     * Keys are asset identifiers (e.g., 'esbuild-wasm/esbuild.wasm'), values are local URLs.
+     * Use this to bundle assets locally for offline support or improved performance.
+     */
+    urlOverrides?: Record<string, string>;
 }
 interface Compiler {
     /** Pre-load an image package */
@@ -545,68 +545,151 @@ interface VFSPluginOptions {
 }
 declare function vfsPlugin(project: VirtualProject, options?: VFSPluginOptions): Plugin;
 
-declare function createProjectFromFiles(files: VirtualFile[], id?: `${string}-${string}-${string}-${string}-${string}`): VirtualProject;
-declare function resolveEntry(files: Map<string, VirtualFile>): string;
-declare function detectMainFile(language?: string): string;
-declare function createSingleFileProject(content: string, entry?: string, id?: string): VirtualProject;
-
-declare class VFSStore {
-    private backend;
-    private root;
-    constructor(backend: StorageBackend, root?: string);
-    private key;
-    getFile(path: string): Promise<VirtualFile | null>;
-    putFile(file: VirtualFile): Promise<void>;
-    deleteFile(path: string): Promise<void>;
-    listFiles(prefix?: string): Promise<string[]>;
-    loadProject(id: string): Promise<VirtualProject | null>;
-    saveProject(project: VirtualProject): Promise<void>;
+/**
+ * File statistics matching Node.js fs.Stats subset
+ */
+interface FileStats {
+    size: number;
+    mtime: Date;
+    isFile(): boolean;
+    isDirectory(): boolean;
+}
+/**
+ * Directory entry matching Node.js fs.Dirent
+ */
+interface DirEntry {
+    name: string;
+    isFile(): boolean;
+    isDirectory(): boolean;
+}
+type WatchEventType = "create" | "update" | "delete";
+type WatchCallback = (event: WatchEventType, path: string) => void;
+/**
+ * FSProvider - Node.js fs/promises compatible interface
+ * All paths are relative to provider root
+ */
+interface FSProvider {
+    readFile(path: string, encoding?: "utf8" | "base64"): Promise<string>;
+    writeFile(path: string, content: string): Promise<void>;
+    unlink(path: string): Promise<void>;
+    stat(path: string): Promise<FileStats>;
+    mkdir(path: string, options?: {
+        recursive?: boolean;
+    }): Promise<void>;
+    readdir(path: string): Promise<DirEntry[]>;
+    rmdir(path: string, options?: {
+        recursive?: boolean;
+    }): Promise<void>;
+    exists(path: string): Promise<boolean>;
+    watch?(path: string, callback: WatchCallback): () => void;
 }
+/**
+ * Change record for sync operations
+ */
+interface ChangeRecord {
+    path: string;
+    type: WatchEventType;
+    mtime: Date;
+    checksum?: string;
+}
+type ConflictStrategy = "local-wins" | "remote-wins" | "newest-wins" | "manual";
+interface SyncResult {
+    pushed: number;
+    pulled: number;
+    conflicts: ConflictRecord[];
+}
+interface ConflictRecord {
+    path: string;
+    localMtime: Date;
+    remoteMtime: Date;
+    resolved?: "local" | "remote";
+}
+type SyncStatus = "idle" | "syncing" | "error";
+type SyncEventType = "change" | "conflict" | "error" | "status";
+type SyncEventCallback<T = unknown> = (data: T) => void;
 
-declare class IndexedDBBackend implements StorageBackend {
+declare class IndexedDBBackend implements FSProvider {
     private prefix;
     constructor(prefix?: string);
     private key;
-    get(path: string): Promise<string | null>;
-    put(path: string, content: string): Promise<void>;
-    delete(path: string): Promise<void>;
-    list(prefix?: string): Promise<string[]>;
+    readFile(path: string): Promise<string>;
+    writeFile(path: string, content: string): Promise<void>;
+    unlink(path: string): Promise<void>;
+    stat(path: string): Promise<FileStats>;
+    mkdir(path: string, options?: {
+        recursive?: boolean;
+    }): Promise<void>;
+    readdir(path: string): Promise<DirEntry[]>;
+    rmdir(path: string, options?: {
+        recursive?: boolean;
+    }): Promise<void>;
     exists(path: string): Promise<boolean>;
+    private dirExists;
 }
 
-interface LocalFSConfig {
+interface HttpBackendConfig {
     baseUrl: string;
 }
-declare class LocalFSBackend implements StorageBackend {
+/**
+ * HTTP-based FSProvider for connecting to remote servers (e.g., stitchery)
+ */
+declare class HttpBackend implements FSProvider {
     private config;
-    constructor(config: LocalFSConfig);
-    get(path: string): Promise<string | null>;
-    put(path: string, content: string): Promise<void>;
-    delete(path: string): Promise<void>;
-    list(prefix?: string): Promise<string[]>;
+    constructor(config: HttpBackendConfig);
+    readFile(path: string): Promise<string>;
+    writeFile(path: string, content: string): Promise<void>;
+    unlink(path: string): Promise<void>;
+    stat(path: string): Promise<FileStats>;
+    mkdir(path: string, options?: {
+        recursive?: boolean;
+    }): Promise<void>;
+    readdir(path: string): Promise<DirEntry[]>;
+    rmdir(path: string, options?: {
+        recursive?: boolean;
+    }): Promise<void>;
     exists(path: string): Promise<boolean>;
+    watch(path: string, callback: WatchCallback): () => void;
+    private startWatch;
+    private url;
 }
 
-interface S3Config {
-    bucket: string;
-    region: string;
-    prefix?: string;
-    credentials?: {
-        accessKeyId: string;
-        secretAccessKey: string;
-    };
+declare function createProjectFromFiles(files: VirtualFile[], id?: string): VirtualProject;
+declare function resolveEntry(files: Map<string, VirtualFile>): string;
+declare function detectMainFile(language?: string): string;
+declare function createSingleFileProject(content: string, entry?: string, id?: string): VirtualProject;
+
+interface VFSStoreOptions {
+    root?: string;
+    sync?: boolean;
+    conflictStrategy?: ConflictStrategy;
+    autoSyncIntervalMs?: number;
 }
-declare class S3Backend implements StorageBackend {
-    private config;
-    constructor(config: S3Config);
-    private get baseUrl();
-    private key;
-    get(path: string): Promise<string | null>;
-    put(path: string, content: string): Promise<void>;
-    delete(path: string): Promise<void>;
-    list(prefix?: string): Promise<string[]>;
+declare class VFSStore {
+    private provider;
+    private local?;
+    private syncEngine?;
+    private root;
+    constructor(provider: FSProvider, options?: VFSStoreOptions);
+    readFile(path: string, encoding?: "utf8" | "base64"): Promise<string>;
+    writeFile(path: string, content: string): Promise<void>;
+    unlink(path: string): Promise<void>;
+    stat(path: string): Promise<FileStats>;
+    mkdir(path: string, options?: {
+        recursive?: boolean;
+    }): Promise<void>;
+    readdir(path: string): Promise<DirEntry[]>;
+    rmdir(path: string, options?: {
+        recursive?: boolean;
+    }): Promise<void>;
     exists(path: string): Promise<boolean>;
-    private parseListResponse;
+    listFiles(prefix?: string): Promise<string[]>;
+    loadProject(id: string): Promise<VirtualProject | null>;
+    saveProject(project: VirtualProject): Promise<void>;
+    watch(path: string, callback: WatchCallback): () => void;
+    sync(): Promise<SyncResult>;
+    on<T extends SyncEventType>(event: T, callback: SyncEventCallback<T extends "change" ? ChangeRecord : T extends "conflict" ? ConflictRecord : T extends "error" ? Error : SyncStatus>): () => void;
+    private remotePath;
+    private walkFiles;
 }
 
 /**
@@ -749,4 +832,4 @@ declare function createIframeServiceProxy(): ServiceProxy;
  */
 declare function generateIframeBridgeScript(services: string[]): string;
 
-export { type BridgeMessage, type BridgeMessageType, type CdnTransformOptions, type CompileOptions, CompileOptionsSchema, type CompiledWidget, type Compiler, type CompilerOptions, DEFAULT_CLI_IMAGE_CONFIG, DEFAULT_IMAGE_CONFIG, DEV_SANDBOX, EsbuildConfigSchema, type GlobalInterfaceDefinition, type ImageConfig$1 as ImageConfig, ImageConfigSchema, type ImageMountFn, ImageRegistry, IndexedDBBackend, type InputSpec, InputSpecSchema, type LoadedImage, LocalFSBackend, type LocalFSConfig, type Manifest$1 as Manifest, ManifestSchema, type MountMode, MountModeSchema, type MountOptions, MountOptionsSchema, type MountedWidget, ParentBridge, type Platform, PlatformSchema, S3Backend, type S3Config, type ServiceCallHandler, type ServiceCallPayload, type ServiceProxy, type ServiceResultPayload, type StorageBackend, type VFSPluginOptions, VFSStore, type VirtualFile, type VirtualProject, cdnTransformPlugin, createCompiler, createFieldAccessProxy, createHttpServiceProxy, createIframeServiceProxy, createImageRegistry, createProjectFromFiles, createSingleFileProject, detectMainFile, disposeIframeBridge, extractNamespaces, fetchPackageJson, generateIframeBridgeScript, generateImportMap, generateNamespaceGlobals, getCdnBaseUrl, getImageRegistry, injectNamespaceGlobals, loadImage, mountEmbedded, mountIframe, parseImageConfig, parseImageSpec, parseManifest, reloadEmbedded, reloadIframe, removeNamespaceGlobals, resolveEntry, safeParseImageConfig, safeParseManifest, setCdnBaseUrl, vfsPlugin };
+export { type BridgeMessage, type BridgeMessageType, type CdnTransformOptions, type ChangeRecord, type CompileOptions, CompileOptionsSchema, type CompiledWidget, type Compiler, type CompilerOptions, DEFAULT_CLI_IMAGE_CONFIG, DEFAULT_IMAGE_CONFIG, DEV_SANDBOX, EsbuildConfigSchema, type GlobalInterfaceDefinition, HttpBackend, type HttpBackendConfig, type ImageConfig$1 as ImageConfig, ImageConfigSchema, type ImageMountFn, ImageRegistry, IndexedDBBackend, type InputSpec, InputSpecSchema, type LoadedImage, type Manifest$1 as Manifest, ManifestSchema, type MountMode, MountModeSchema, type MountOptions, MountOptionsSchema, type MountedWidget, ParentBridge, type Platform, PlatformSchema, type ServiceCallHandler, type ServiceCallPayload, type ServiceProxy, type ServiceResultPayload, type VFSPluginOptions, VFSStore, type VFSStoreOptions, type VirtualFile, type VirtualProject, type WatchCallback, type WatchEventType, cdnTransformPlugin, createCompiler, createFieldAccessProxy, createHttpServiceProxy, createIframeServiceProxy, createImageRegistry, createProjectFromFiles, createSingleFileProject, detectMainFile, disposeIframeBridge, extractNamespaces, fetchPackageJson, generateIframeBridgeScript, generateImportMap, generateNamespaceGlobals, getCdnBaseUrl, getImageRegistry, injectNamespaceGlobals, loadImage, mountEmbedded, mountIframe, parseImageConfig, parseImageSpec, parseManifest, reloadEmbedded, reloadIframe, removeNamespaceGlobals, resolveEntry, safeParseImageConfig, safeParseManifest, setCdnBaseUrl, vfsPlugin };