@trojanbox-vcp-test/site-edit-engine 0.1.0 → 0.2.0

package/dist/runtime-sync.d.ts

@@ -12,24 +12,24 @@ export type SiteEditRuntimeAttributes = {
     readonly [key in keyof typeof SITE_EDIT_RUNTIME_ATTRIBUTES]: string;
 };
 export type SiteEditRenderDocumentDiff = {
-    added_keys: string[];
-    removed_keys: string[];
-    retained_keys: string[];
+    addedKeys: string[];
+    removedKeys: string[];
+    retainedKeys: string[];
     changed_parentKeys: string[];
-    changed_child_order_keys: string[];
+    changedChildOrderKeys: string[];
 };
 export type SiteEditRuntimeElementSnapshot = {
     key: string;
     instance_index?: number;
     instance_count?: number;
-    tag_name: string;
-    source_kind?: string;
+    tagName: string;
+    sourceKind?: string;
     componentName?: string;
     sourceFile?: string;
     parentKey?: string;
     text_preview?: string;
     attributes: Record<string, string>;
-    runtime_flags: {
+    runtimeFlags: {
         editable: boolean;
         movable: boolean;
         removable: boolean;
@@ -64,7 +64,7 @@ export type SiteEditRuntimeReadyInput = {
     next_document: SiteEditRenderDocument;
     request?: SiteEditOperationRequest;
     result: SiteEditOperationResult;
-    selected_key?: string | null;
+    selectedKey?: string | null;
     timeout_ms?: number;
 };
 export declare function diffSiteEditRenderDocuments(previous_document: SiteEditRenderDocument, next_document: SiteEditRenderDocument): SiteEditRenderDocumentDiff;

package/dist/runtime.d.ts

@@ -155,39 +155,6 @@ export declare class SnapshotSiteEditEngineRuntime implements SiteEditEngineRunt
         } | undefined;
         componentSemantic?: Record<string, unknown> | undefined;
     };
-    getObjectStyleDetail(key: string, routeId?: string): {
-        key: string;
-        styleSource?: {
-            kind: "class-name-source";
-            className: string;
-            sourceKind: "missing" | "static-attribute" | "static-expression" | "dynamic-expression";
-            editable: boolean;
-            operationBoundary: ("update-text" | "remove-node" | "insert-child" | "move-node" | "replace-rich-text-content" | "insert-rich-text-block" | "remove-rich-text-block" | "set-media-field" | "set-component-slot-content" | "set-object-field" | "insert-object-field" | "remove-object-field" | "update-array-item" | "insert-array-item" | "remove-array-item" | "move-array-item" | "replace-conditional-expression" | "set-conditional-branch-content" | "set-jsx-prop" | "remove-jsx-prop" | "set-class-name" | "add-class-token" | "remove-class-token" | "set-style-property" | "set-style-properties" | "set-css-module-class" | "set-directive" | "remove-directive" | "set-route-export" | "set-metadata-field" | "set-generate-metadata")[];
-            sourcePath?: string | undefined;
-            diagnostics?: {
-                code: "missing-class-name" | "dynamic-binding" | "non-string-binding";
-                message: string;
-            }[] | undefined;
-        } | undefined;
-        styleModel?: Record<string, unknown> | {
-            kind: "css-style-model";
-            properties: {
-                property: "display" | "position" | "top" | "right" | "bottom" | "left" | "zIndex" | "flexDirection" | "flexWrap" | "flexGrow" | "flexShrink" | "flexBasis" | "order" | "gridTemplateColumns" | "gridTemplateRows" | "columns" | "gridColumn" | "gridRow" | "gap" | "gapX" | "gapY" | "spaceX" | "spaceY" | "alignItems" | "justifyContent" | "marginTop" | "marginRight" | "marginBottom" | "marginLeft" | "paddingTop" | "paddingRight" | "paddingBottom" | "paddingLeft" | "width" | "height" | "minWidth" | "minHeight" | "maxWidth" | "maxHeight" | "overflow" | "fontFamily" | "fontSize" | "fontWeight" | "lineHeight" | "letterSpacing" | "textAlign" | "textTransform" | "textDecoration" | "textOverflow" | "textIndent" | "writingMode" | "whiteSpace" | "wordBreak" | "lineClamp" | "fontVariantNumeric" | "screenReaderOnly" | "color" | "backgroundColor" | "backgroundImage" | "borderStyle" | "borderWidth" | "borderRadius" | "borderColor" | "objectFit" | "objectPosition" | "aspectRatio" | "opacity" | "boxShadow" | "transform" | "transformOrigin" | "transitionProperty" | "transitionDuration" | "transitionTimingFunction" | "animation" | "pointerEvents" | "cursor" | "userSelect" | "fontStyle" | "textUnderlineOffset" | "scrollMarginTop" | "alignSelf" | "flex" | "outlineStyle" | "resize" | "ringWidth" | "ringColor" | "backdropFilter" | "overscrollBehavior" | "divideWidth" | "divideColor";
-                value: string | number | boolean | null;
-                editable: boolean;
-                resolvedValue?: string | number | boolean | null | undefined;
-                breakpoint?: "sm" | "md" | "lg" | "xl" | "2xl" | undefined;
-                state?: "hover" | "active" | "focus" | "disabled" | undefined;
-                variants?: string[] | undefined;
-                options?: (string | number)[] | undefined;
-                diagnostics?: {
-                    code: string;
-                    message: string;
-                }[] | undefined;
-                operationBoundary?: ("update-text" | "remove-node" | "insert-child" | "move-node" | "replace-rich-text-content" | "insert-rich-text-block" | "remove-rich-text-block" | "set-media-field" | "set-component-slot-content" | "set-object-field" | "insert-object-field" | "remove-object-field" | "update-array-item" | "insert-array-item" | "remove-array-item" | "move-array-item" | "replace-conditional-expression" | "set-conditional-branch-content" | "set-jsx-prop" | "remove-jsx-prop" | "set-class-name" | "add-class-token" | "remove-class-token" | "set-style-property" | "set-style-properties" | "set-css-module-class" | "set-directive" | "remove-directive" | "set-route-export" | "set-metadata-field" | "set-generate-metadata")[] | undefined;
-            }[];
-        } | undefined;
-    };
     getObjectContentDetail(key: string, routeId?: string): {
         key: string;
         contentModel?: Record<string, unknown> | undefined;
@@ -238,100 +205,7 @@ export declare class SnapshotSiteEditEngineRuntime implements SiteEditEngineRunt
             message: string;
         }[];
     };
-    setClassNameSource(request: Parameters<SiteEditEngineRuntime["setClassNameSource"]>[0]): Promise<{
-        ok: true;
-        source: {
-            key: string;
-            routeId: string;
-            filePath: string;
-            componentName: string;
-            sourceKind: "missing" | "expression" | "stringLiteral";
-            attrRaw: string | null;
-            valueRaw: string | null;
-            attrRange: {
-                start: number;
-                end: number;
-                startLine?: number | undefined;
-                startColumn?: number | undefined;
-                endLine?: number | undefined;
-                endColumn?: number | undefined;
-            } | null;
-            valueRange: {
-                start: number;
-                end: number;
-                startLine?: number | undefined;
-                startColumn?: number | undefined;
-                endLine?: number | undefined;
-                endColumn?: number | undefined;
-            } | null;
-            openingElementRange: {
-                start: number;
-                end: number;
-                startLine?: number | undefined;
-                startColumn?: number | undefined;
-                endLine?: number | undefined;
-                endColumn?: number | undefined;
-            };
-            version: {
-                documentVersion: number;
-                contentHash: string;
-                parserVersion: string;
-            };
-            diagnostics: {
-                code: "missing-class-name" | "unsupported-attribute-name" | "source-locator-warning" | "invalid-new-attr" | "version-conflict" | "write-failed";
-                message: string;
-            }[];
-        };
-    } | {
-        ok: false;
-        reason: "node_not_found" | "document_version_stale" | "file_hash_mismatch" | "range_mismatch" | "old_attr_mismatch" | "invalid_new_attr" | "unsupported_target" | "write_failed";
-        diagnostics: {
-            code: "missing-class-name" | "unsupported-attribute-name" | "source-locator-warning" | "invalid-new-attr" | "version-conflict" | "write-failed";
-            message: string;
-        }[];
-        current?: {
-            key: string;
-            routeId: string;
-            filePath: string;
-            componentName: string;
-            sourceKind: "missing" | "expression" | "stringLiteral";
-            attrRaw: string | null;
-            valueRaw: string | null;
-            attrRange: {
-                start: number;
-                end: number;
-                startLine?: number | undefined;
-                startColumn?: number | undefined;
-                endLine?: number | undefined;
-                endColumn?: number | undefined;
-            } | null;
-            valueRange: {
-                start: number;
-                end: number;
-                startLine?: number | undefined;
-                startColumn?: number | undefined;
-                endLine?: number | undefined;
-                endColumn?: number | undefined;
-            } | null;
-            openingElementRange: {
-                start: number;
-                end: number;
-                startLine?: number | undefined;
-                startColumn?: number | undefined;
-                endLine?: number | undefined;
-                endColumn?: number | undefined;
-            };
-            version: {
-                documentVersion: number;
-                contentHash: string;
-                parserVersion: string;
-            };
-            diagnostics: {
-                code: "missing-class-name" | "unsupported-attribute-name" | "source-locator-warning" | "invalid-new-attr" | "version-conflict" | "write-failed";
-                message: string;
-            }[];
-        } | undefined;
-    }>;
+    setClassNameSource(request: Parameters<SiteEditEngineRuntime["setClassNameSource"]>[0]): Promise<import("@trojanbox-vcp-test/contracts").SiteEditSetClassNameSourceResult>;
     planOperation(request: Parameters<SiteEditEngineRuntime["planOperation"]>[0]): Promise<SiteEditPlanOperationResult>;
     dispose(): void;
     private createEngine;

package/dist/site-edit-instrumentation.d.ts

@@ -10,7 +10,7 @@ export type SiteEditInstrumentedElement = {
     tag: string;
     componentName: string;
     sourceFile: string;
-    source_kind: "jsx" | "component-call";
+    sourceKind: "jsx" | "component-call";
 };
 export type SiteEditInstrumentationResult = {
     code: string;

package/dist/source-watcher.js

@@ -1,150 +1 @@
-import fs from "node:fs";
-import path from "node:path";
-const defaultWatchDirs = [
-    "app",
-    "src/app",
-    "components",
-    "src/components",
-    "lib",
-    "src/lib",
-];
-const sourceFilePattern = /\.(?:tsx|ts|jsx|js|mjs|cjs|css|scss|sass)$/;
-const ignoredPathPattern = /^(?:\.next|node_modules|\.git)(?:\/|$)/;
-export class SiteEditSourceWatcher {
-    constructor(options) {
-        this.options = options;
-        this.watchers = [];
-        this.fileMtimes = new Map();
-        this.pollingTimer = null;
-        this.isPolling = false;
-    }
-    start() {
-        for (const relativeDirectory of this.getWatchDirs()) {
-            const baseDir = path.join(this.options.projectRoot, relativeDirectory);
-            if (!fs.existsSync(baseDir)) {
-                continue;
-            }
-            if (this.registerWatcher(baseDir, true)) {
-                continue;
-            }
-            for (const nestedDir of collectSubdirectories(baseDir)) {
-                this.registerWatcher(nestedDir, false);
-            }
-        }
-        this.scanFiles();
-        this.pollingTimer = setInterval(() => this.poll(), this.options.interval_ms ?? 1_000);
-        return () => this.stop();
-    }
-    stop() {
-        if (this.pollingTimer) {
-            clearInterval(this.pollingTimer);
-            this.pollingTimer = null;
-        }
-        for (const watcher of this.watchers) {
-            watcher.close();
-        }
-        this.watchers.length = 0;
-    }
-    getWatchDirs() {
-        return this.options.watch_dirs?.length
-            ? this.options.watch_dirs
-            : defaultWatchDirs;
-    }
-    registerWatcher(baseDir, recursive) {
-        try {
-            const watcher = fs.watch(baseDir, { recursive }, (_eventType, filename) => {
-                const changedFile = normalizeChangedFile(this.options.projectRoot, baseDir, filename);
-                if (changedFile) {
-                    this.options.on_change(changedFile);
-                }
-            });
-            this.watchers.push(watcher);
-            return true;
-        }
-        catch {
-            return false;
-        }
-    }
-    poll() {
-        if (this.isPolling) {
-            return;
-        }
-        this.isPolling = true;
-        try {
-            this.scanFiles();
-        }
-        finally {
-            this.isPolling = false;
-        }
-    }
-    scanFiles() {
-        for (const relativeDirectory of this.getWatchDirs()) {
-            const baseDir = path.join(this.options.projectRoot, relativeDirectory);
-            if (!fs.existsSync(baseDir)) {
-                continue;
-            }
-            for (const absoluteFile of collectWatchedFiles(this.options.projectRoot, baseDir)) {
-                try {
-                    const stat = fs.statSync(absoluteFile);
-                    const relativeFile = toProjectRelativePath(this.options.projectRoot, absoluteFile);
-                    const previousMtime = this.fileMtimes.get(relativeFile);
-                    if (previousMtime !== undefined && previousMtime !== stat.mtimeMs) {
-                        this.options.on_change(relativeFile);
-                    }
-                    this.fileMtimes.set(relativeFile, stat.mtimeMs);
-                }
-                catch {
-                    // Files can disappear while Next is recompiling; the next scan settles state.
-                }
-            }
-        }
-    }
-}
-function collectSubdirectories(baseDir) {
-    const directories = [baseDir];
-    for (const entry of fs.readdirSync(baseDir, { withFileTypes: true })) {
-        if (!entry.isDirectory() ||
-            entry.name.startsWith(".") ||
-            entry.name === "node_modules") {
-            continue;
-        }
-        directories.push(...collectSubdirectories(path.join(baseDir, entry.name)));
-    }
-    return directories;
-}
-function collectWatchedFiles(projectRoot, baseDir) {
-    const files = [];
-    for (const entry of fs.readdirSync(baseDir, { withFileTypes: true })) {
-        const absolutePath = path.join(baseDir, entry.name);
-        if (entry.isDirectory()) {
-            if (entry.name.startsWith(".") || entry.name === "node_modules") {
-                continue;
-            }
-            files.push(...collectWatchedFiles(projectRoot, absolutePath));
-            continue;
-        }
-        const relativeFile = toProjectRelativePath(projectRoot, absolutePath);
-        if (!ignoredPathPattern.test(relativeFile) &&
-            sourceFilePattern.test(relativeFile)) {
-            files.push(absolutePath);
-        }
-    }
-    return files;
-}
-function normalizeChangedFile(projectRoot, baseDir, filename) {
-    if (!filename) {
-        return null;
-    }
-    const absoluteFile = path.join(baseDir, filename.toString());
-    const relativeFile = toProjectRelativePath(projectRoot, absoluteFile);
-    if (!relativeFile ||
-        relativeFile.startsWith("..") ||
-        ignoredPathPattern.test(relativeFile) ||
-        !sourceFilePattern.test(relativeFile)) {
-        return null;
-    }
-    return relativeFile;
-}
-function toProjectRelativePath(projectRoot, absoluteFile) {
-    return path.relative(projectRoot, absoluteFile).replace(/\\/g, "/");
-}
+import r from"node:fs";import c from"node:path";var g=["app","src/app","components","src/components","lib","src/lib"],u=/\.(?:tsx|ts|jsx|js|mjs|cjs|css|scss|sass)$/,f=/^(?:\.next|node_modules|\.git)(?:\/|$)/,a=class{constructor(t){this.options=t,this.watchers=[],this.fileMtimes=new Map,this.pollingTimer=null,this.isPolling=!1}start(){for(let t of this.getWatchDirs()){let s=c.join(this.options.projectRoot,t);if(r.existsSync(s)&&!this.registerWatcher(s,!0))for(let i of p(s))this.registerWatcher(i,!1)}return this.scanFiles(),this.pollingTimer=setInterval(()=>this.poll(),this.options.interval_ms??1e3),()=>this.stop()}stop(){this.pollingTimer&&(clearInterval(this.pollingTimer),this.pollingTimer=null);for(let t of this.watchers)t.close();this.watchers.length=0}getWatchDirs(){return this.options.watch_dirs?.length?this.options.watch_dirs:g}registerWatcher(t,s){try{let i=r.watch(t,{recursive:s},(e,n)=>{let l=d(this.options.projectRoot,t,n);l&&this.options.on_change(l)});return this.watchers.push(i),!0}catch{return!1}}poll(){if(!this.isPolling){this.isPolling=!0;try{this.scanFiles()}finally{this.isPolling=!1}}}scanFiles(){for(let t of this.getWatchDirs()){let s=c.join(this.options.projectRoot,t);if(r.existsSync(s))for(let i of m(this.options.projectRoot,s))try{let e=r.statSync(i),n=h(this.options.projectRoot,i),l=this.fileMtimes.get(n);l!==void 0&&l!==e.mtimeMs&&this.options.on_change(n),this.fileMtimes.set(n,e.mtimeMs)}catch{}}}};function p(o){let t=[o];for(let s of r.readdirSync(o,{withFileTypes:!0}))!s.isDirectory()||s.name.startsWith(".")||s.name==="node_modules"||t.push(...p(c.join(o,s.name)));return t}function m(o,t){let s=[];for(let i of r.readdirSync(t,{withFileTypes:!0})){let e=c.join(t,i.name);if(i.isDirectory()){if(i.name.startsWith(".")||i.name==="node_modules")continue;s.push(...m(o,e));continue}let n=h(o,e);!f.test(n)&&u.test(n)&&s.push(e)}return s}function d(o,t,s){if(!s)return null;let i=c.join(t,s.toString()),e=h(o,i);return!e||e.startsWith("..")||f.test(e)||!u.test(e)?null:e}function h(o,t){return c.relative(o,t).replace(/\\/g,"/")}export{a as SiteEditSourceWatcher};

package/dist/types.d.ts

@@ -1,4 +1,4 @@
-import type { SiteEditEvent, SiteEditGetClassNameSourceResult, SiteEditObjectCapabilities, SiteEditObjectContentDetail, SiteEditObjectEditContext, SiteEditObjectMediaDetail, SiteEditObjectStyleDetail, SiteEditObjectSummary, SiteEditOperationRequest, SiteEditOperationResult, SiteEditPatchPlan, SiteEditRenderDocument, SiteEditSetClassNameSourceRequest, SiteEditSetClassNameSourceResult } from "@trojanbox-vcp-test/contracts";
+import type { SiteEditCommandSuccess, SiteEditEvent, SiteEditGetClassNameSourceCommandResult, SiteEditGetClassNameSourceResult, SiteEditObjectCapabilities, SiteEditObjectContentDetail, SiteEditObjectEditContext, SiteEditObjectMediaDetail, SiteEditObjectSummary, SiteEditOperationCommandResult, SiteEditOperationRequest, SiteEditPatchPlan, SiteEditRenderDocument, SiteEditSetClassNameSourceRequest, SiteEditSetClassNameSourceResult } from "@trojanbox-vcp-test/contracts";
 import type { SiteEditProjectFileSystem } from "./public-file-system.js";
 export type { SiteEditProjectFileSystem } from "./public-file-system.js";
 export interface SiteEditSnapshotFile {
@@ -19,7 +19,7 @@ export interface SiteEditEngineRuntimeOptions {
     dev?: boolean;
 }
 export interface SiteEditPlanOperationResult {
-    result: SiteEditOperationResult;
+    result: SiteEditOperationCommandResult;
     patchPlan?: SiteEditPatchPlan;
 }
 export interface SiteEditEngineRuntime {
@@ -29,7 +29,6 @@ export interface SiteEditEngineRuntime {
     getObjectCapabilities(key: string, routeId?: string): SiteEditObjectCapabilities;
     getObjectSummary(key: string, routeId?: string): SiteEditObjectSummary;
     getObjectEditContext(key: string, routeId?: string): SiteEditObjectEditContext;
-    getObjectStyleDetail(key: string, routeId?: string): SiteEditObjectStyleDetail;
     getObjectContentDetail(key: string, routeId?: string): SiteEditObjectContentDetail;
     getObjectMediaDetail(key: string, routeId?: string): SiteEditObjectMediaDetail;
     getClassNameSource(key: string, routeId?: string): SiteEditGetClassNameSourceResult;
@@ -50,18 +49,17 @@ export interface PreviewSiteEditEngineRuntime {
     readonly status: "idle" | "building" | "ready" | "error" | "disposed";
     registerRoute(routeId: string, entryFile: string): void;
     setActiveRoute(routeId: string): Promise<void>;
-    getDocument(routeId: string): SiteEditRenderDocument;
-    getObjectCapabilities(key: string, routeId?: string): SiteEditObjectCapabilities;
-    getObjectSummary(key: string, routeId?: string): SiteEditObjectSummary;
-    getObjectEditContext(key: string, routeId?: string): SiteEditObjectEditContext;
-    getObjectStyleDetail(key: string, routeId?: string): SiteEditObjectStyleDetail;
-    getObjectContentDetail(key: string, routeId?: string): SiteEditObjectContentDetail;
-    getObjectMediaDetail(key: string, routeId?: string): SiteEditObjectMediaDetail;
-    getClassNameSource(key: string, routeId?: string): SiteEditGetClassNameSourceResult;
+    getDocument(routeId: string): SiteEditCommandSuccess<SiteEditRenderDocument>;
+    getObjectCapabilities(key: string, routeId?: string): SiteEditCommandSuccess<SiteEditObjectCapabilities>;
+    getObjectSummary(key: string, routeId?: string): SiteEditCommandSuccess<SiteEditObjectSummary>;
+    getObjectEditContext(key: string, routeId?: string): SiteEditCommandSuccess<SiteEditObjectEditContext>;
+    getObjectContentDetail(key: string, routeId?: string): SiteEditCommandSuccess<SiteEditObjectContentDetail>;
+    getObjectMediaDetail(key: string, routeId?: string): SiteEditCommandSuccess<SiteEditObjectMediaDetail>;
+    getClassNameSource(key: string, routeId?: string): SiteEditGetClassNameSourceCommandResult;
     setClassNameSource(request: SiteEditSetClassNameSourceRequest): Promise<SiteEditSetClassNameSourceResult>;
-    executeOperation(request: SiteEditOperationRequest): Promise<SiteEditOperationResult>;
-    undo(): Promise<SiteEditOperationResult>;
-    redo(): Promise<SiteEditOperationResult>;
+    executeOperation(request: SiteEditOperationRequest): Promise<SiteEditOperationCommandResult>;
+    undo(): Promise<SiteEditOperationCommandResult>;
+    redo(): Promise<SiteEditOperationCommandResult>;
     notifyFileChanged(file: string): void;
     subscribe(listener: (event: SiteEditEvent) => void): () => void;
     dispose(): void;