@vcp-dev/site-edit-engine 0.6.11 → 0.7.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (14) hide show
  1. package/README.md +5 -2
  2. package/dist/index.d.ts +2 -0
  3. package/dist/index.js +11 -11
  4. package/dist/internal/protocol/capability.d.ts +2 -0
  5. package/dist/internal/protocol/event.d.ts +8 -4
  6. package/dist/internal/protocol/operation.d.ts +3 -1
  7. package/dist/internal/protocol/render.d.ts +4 -1
  8. package/dist/next-app-router.d.ts +2 -1
  9. package/dist/next-app-router.js +1 -1
  10. package/dist/page-template-managed-source.d.ts +59 -0
  11. package/dist/preview-runtime.d.ts +295 -22
  12. package/dist/runtime.d.ts +44 -15
  13. package/dist/types.d.ts +32 -22
  14. package/package.json +2 -2
package/dist/types.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import type { SiteEditCommandSuccess, SiteEditEvent, SiteEditGetClassNameSourceCommandResult, SiteEditGetClassNameSourceResult, SiteEditClassNameSourceStyleContext, SiteEditObjectEditContext, SiteEditOperationCommandResult, SiteEditMutationContext, SiteEditOperationRequest, SiteEditPatchPlan, SiteEditRenderDocument, SiteEditResolveSourceLocationInput, SiteEditSourceFileResponse, SiteEditSourceLocation, SiteEditSourceTreeResponse } from "@vcp-dev/contracts";
1
+ import type { SiteEditCommandSuccess, SiteEditEvent, SiteEditGetClassNameSourceCommandResult, SiteEditGetClassNameSourceResult, SiteEditClassNameSourceStyleContext, SiteEditCompositionSelector, SiteEditCompositionContext, SiteEditObjectEditContext, SiteEditOperationCommandResult, SiteEditMutationContext, SiteEditOperationRequest, SiteEditPatchPlan, SiteEditRenderDocument, SiteEditResolveSourceLocationInput, SiteEditSourceFileResponse, SiteEditSourceLocation, SiteEditSourceTreeResponse } from "@vcp-dev/contracts";
2
2
  import type { SiteEditProjectFileSystem } from "./public-file-system.js";
3
3
  import type { FileHistoryStore } from "./history/file-history-store.js";
4
4
  export type { SiteEditProjectFileSystem } from "./public-file-system.js";
@@ -11,17 +11,23 @@ export interface SiteEditEngineRoute {
11
11
  routeId: string;
12
12
  entryFile: string;
13
13
  }
14
+ export interface SiteEditEngineComposition {
15
+ context: SiteEditCompositionContext;
16
+ entryFile: string;
17
+ }
14
18
  export interface SiteEditEngineRuntimeOptions {
15
19
  tenantId?: string;
16
20
  siteId: string;
17
21
  snapshotId: string;
18
22
  files: SiteEditSnapshotFile[];
19
- routes: SiteEditEngineRoute[];
23
+ compositions: readonly SiteEditEngineComposition[];
20
24
  onEvent?: (event: SiteEditEvent) => void;
21
25
  dev?: boolean;
22
26
  historyStore?: FileHistoryStore;
23
- /** Aligns opaque page-composition keys with an existing live runtime. */
24
- initialDocumentVersion?: number;
27
+ initialDocumentVersions?: readonly {
28
+ composition: SiteEditCompositionContext;
29
+ version: number;
30
+ }[];
25
31
  }
26
32
  export interface SiteEditPlanOperationResult {
27
33
  result: SiteEditOperationCommandResult;
@@ -36,14 +42,15 @@ export interface SiteEditEngineHistoryStatus {
36
42
  }
37
43
  export interface SiteEditEngineRuntime {
38
44
  readonly status: "idle" | "building" | "ready" | "disposed";
39
- setActiveRoute(routeId: string): Promise<void>;
40
- getDocument(routeId: string): SiteEditRenderDocument;
41
- getStyleContext(routeId: string): SiteEditClassNameSourceStyleContext | null;
42
- getObjectEditContext(key: string, routeId?: string): SiteEditObjectEditContext;
43
- getClassNameSource(key: string, routeId?: string): SiteEditGetClassNameSourceResult;
44
- getSourceTree(): Promise<SiteEditSourceTreeResponse>;
45
+ initializeComposition(composition: SiteEditCompositionSelector): Promise<void>;
46
+ getDocument(composition: SiteEditCompositionSelector): SiteEditRenderDocument;
47
+ getStyleContext(composition: SiteEditCompositionSelector): SiteEditClassNameSourceStyleContext | null;
48
+ getObjectEditContext(key: string, composition: SiteEditCompositionSelector): SiteEditObjectEditContext;
49
+ getClassNameSource(key: string, composition: SiteEditCompositionSelector): SiteEditGetClassNameSourceResult;
50
+ getSourceTree(composition: SiteEditCompositionSelector): Promise<SiteEditSourceTreeResponse>;
45
51
  getSourceFile(input: {
46
52
  path: string;
53
+ composition: SiteEditCompositionSelector;
47
54
  }): Promise<SiteEditSourceFileResponse>;
48
55
  resolveSourceLocation(input: SiteEditResolveSourceLocationInput): SiteEditSourceLocation;
49
56
  planOperation(request: SiteEditOperationRequest): Promise<SiteEditPlanOperationResult>;
@@ -54,30 +61,33 @@ export interface PreviewSiteEditEngineRuntimeOptions {
54
61
  siteId: string;
55
62
  snapshotId: string;
56
63
  projectRoot: string;
57
- routes: SiteEditEngineRoute[];
64
+ compositions: readonly SiteEditEngineComposition[];
58
65
  onEvent?: (event: SiteEditEvent) => void;
59
66
  dev?: boolean;
60
67
  fileSystem?: SiteEditProjectFileSystem;
61
68
  historyStore?: FileHistoryStore;
62
- /** Preserves monotonic document versions when a Bridge swaps runtimes. */
63
- initialDocumentVersion?: number;
69
+ initialDocumentVersions?: readonly {
70
+ composition: SiteEditCompositionContext;
71
+ version: number;
72
+ }[];
64
73
  }
65
74
  export interface PreviewSiteEditEngineRuntime {
66
75
  readonly status: "idle" | "building" | "ready" | "error" | "disposed";
67
- registerRoute(routeId: string, entryFile: string): void;
68
- unregisterRoute(routeId: string): void;
69
- setActiveRoute(routeId: string): Promise<void>;
70
- getDocument(routeId: string): SiteEditCommandSuccess<SiteEditRenderDocument>;
71
- getStyleContext(routeId: string): SiteEditCommandSuccess<SiteEditClassNameSourceStyleContext | null>;
76
+ initializeComposition(composition: SiteEditCompositionSelector): Promise<void>;
77
+ registerComposition(composition: SiteEditCompositionContext, entryFile: string): void;
78
+ unregisterComposition(composition: SiteEditCompositionSelector): void;
79
+ getDocument(composition: SiteEditCompositionSelector): SiteEditCommandSuccess<SiteEditRenderDocument>;
80
+ getStyleContext(composition: SiteEditCompositionSelector): SiteEditCommandSuccess<SiteEditClassNameSourceStyleContext | null>;
72
81
  getHistoryStatus(): Promise<SiteEditCommandSuccess<SiteEditEngineHistoryStatus>>;
73
- getObjectEditContext(key: string, routeId?: string): SiteEditCommandSuccess<SiteEditObjectEditContext>;
74
- getClassNameSource(key: string, routeId?: string): SiteEditGetClassNameSourceCommandResult;
75
- getSourceTree(): Promise<SiteEditCommandSuccess<SiteEditSourceTreeResponse>>;
82
+ getObjectEditContext(key: string, composition: SiteEditCompositionSelector): SiteEditCommandSuccess<SiteEditObjectEditContext>;
83
+ getClassNameSource(key: string, composition: SiteEditCompositionSelector): SiteEditGetClassNameSourceCommandResult;
84
+ getSourceTree(composition: SiteEditCompositionSelector): Promise<SiteEditCommandSuccess<SiteEditSourceTreeResponse>>;
76
85
  getSourceFile(input: {
77
86
  path: string;
87
+ composition: SiteEditCompositionSelector;
78
88
  }): Promise<SiteEditCommandSuccess<SiteEditSourceFileResponse>>;
79
89
  resolveSourceLocation(input: SiteEditResolveSourceLocationInput): SiteEditCommandSuccess<SiteEditSourceLocation>;
80
- refreshSourceForKey(key: string, routeId?: string): Promise<void>;
90
+ refreshSourceForKey(key: string, composition: SiteEditCompositionSelector): Promise<void>;
81
91
  executeOperation(request: SiteEditOperationRequest, mutationContext?: SiteEditMutationContext): Promise<SiteEditOperationCommandResult>;
82
92
  undo(mutationContext?: SiteEditMutationContext): Promise<SiteEditOperationCommandResult>;
83
93
  redo(mutationContext?: SiteEditMutationContext): Promise<SiteEditOperationCommandResult>;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@vcp-dev/site-edit-engine",
3
- "version": "0.6.11",
3
+ "version": "0.7.1",
4
4
  "type": "module",
5
5
  "license": "UNLICENSED",
6
6
  "repository": {
@@ -60,7 +60,7 @@
60
60
  "@babel/parser": "^7.29.3",
61
61
  "@babel/traverse": "^7.29.0",
62
62
  "@babel/types": "^7.29.0",
63
- "@vcp-dev/contracts": "0.6.11",
63
+ "@vcp-dev/contracts": "0.7.1",
64
64
  "yaml": "^2.9.0"
65
65
  },
66
66
  "devDependencies": {