@jay-framework/editor-protocol 0.15.5 → 0.16.0

package/dist/index.d.ts

@@ -125,8 +125,67 @@ interface ImportResponse<TVendorDoc> extends BaseResponse {
     type: 'import';
     vendorDoc?: TVendorDoc;
 }
-type EditorProtocolMessageTypes<TVendorDoc> = PublishMessage | SaveImageMessage | HasImageMessage | GetProjectInfoMessage | ExportMessage<TVendorDoc> | ImportMessage<TVendorDoc>;
-type EditorProtocolResponseTypes<TVendorDoc> = PublishResponse | SaveImageResponse | HasImageResponse | GetProjectInfoResponse | ExportResponse | ImportResponse<TVendorDoc>;
+interface FreezeEntry {
+    id: string;
+    name?: string;
+    /** The concrete URL path (e.g., /products/kitan) */
+    route: string;
+    /** The route pattern (e.g., /products/kitan{/:category}) */
+    routePattern?: string;
+    createdAt: string;
+}
+interface ListRoutesMessage extends BaseMessage<ListRoutesResponse> {
+    type: 'listRoutes';
+}
+interface ListRoutesResponse extends BaseResponse {
+    type: 'listRoutes';
+    routes: Array<{
+        path: string;
+        jayHtmlPath: string;
+    }>;
+}
+interface ListFreezesMessage extends BaseMessage<ListFreezesResponse> {
+    type: 'listFreezes';
+    route: string;
+}
+interface ListFreezesResponse extends BaseResponse {
+    type: 'listFreezes';
+    freezes: FreezeEntry[];
+}
+interface RenameFreezeMessage extends BaseMessage<RenameFreezeResponse> {
+    type: 'renameFreeze';
+    id: string;
+    name: string;
+}
+interface RenameFreezeResponse extends BaseResponse {
+    type: 'renameFreeze';
+}
+interface DeleteFreezeMessage extends BaseMessage<DeleteFreezeResponse> {
+    type: 'deleteFreeze';
+    id: string;
+}
+interface DeleteFreezeResponse extends BaseResponse {
+    type: 'deleteFreeze';
+}
+interface LoadRouteParamsMessage extends BaseMessage<LoadRouteParamsResponse> {
+    type: 'loadRouteParams';
+    /** Route path, e.g. "/products/kitan/[[category]]" */
+    route: string;
+}
+/** Initial response acknowledging the request. Param batches arrive as events. */
+interface LoadRouteParamsResponse extends BaseResponse {
+    type: 'loadRouteParams';
+}
+/** Streamed event: a batch of params from the loadParams generator */
+interface RouteParamsBatchEvent {
+    type: 'routeParamsBatch';
+    route: string;
+    params: Record<string, string>[];
+    /** true if more batches may follow, false if this is the last */
+    hasMore: boolean;
+}
+type EditorProtocolMessageTypes<TVendorDoc> = PublishMessage | SaveImageMessage | HasImageMessage | GetProjectInfoMessage | ExportMessage<TVendorDoc> | ImportMessage<TVendorDoc> | ListRoutesMessage | ListFreezesMessage | RenameFreezeMessage | DeleteFreezeMessage | LoadRouteParamsMessage;
+type EditorProtocolResponseTypes<TVendorDoc> = PublishResponse | SaveImageResponse | HasImageResponse | GetProjectInfoResponse | ExportResponse | ImportResponse<TVendorDoc> | ListRoutesResponse | ListFreezesResponse | RenameFreezeResponse | DeleteFreezeResponse | LoadRouteParamsResponse;
 interface ProtocolMessage<TVendorDoc> {
     id: string;
     timestamp: number;
@@ -144,6 +203,11 @@ interface EditorProtocol {
     getProjectInfo(params: GetProjectInfoMessage): Promise<GetProjectInfoResponse>;
     export<TVendorDoc>(params: ExportMessage<TVendorDoc>): Promise<ExportResponse>;
     import<TVendorDoc>(params: ImportMessage<TVendorDoc>): Promise<ImportResponse<TVendorDoc>>;
+    listRoutes(params: ListRoutesMessage): Promise<ListRoutesResponse>;
+    listFreezes(params: ListFreezesMessage): Promise<ListFreezesResponse>;
+    renameFreeze(params: RenameFreezeMessage): Promise<RenameFreezeResponse>;
+    deleteFreeze(params: DeleteFreezeMessage): Promise<DeleteFreezeResponse>;
+    loadRouteParams(params: LoadRouteParamsMessage): Promise<LoadRouteParamsResponse>;
 }
 interface DevServerProtocol {
     onPublish(callback: EditorProtocol['publish']): void;
@@ -152,6 +216,15 @@ interface DevServerProtocol {
     onGetProjectInfo(callback: EditorProtocol['getProjectInfo']): void;
     onExport(callback: EditorProtocol['export']): void;
     onImport(callback: EditorProtocol['import']): void;
+    onListRoutes(callback: EditorProtocol['listRoutes']): void;
+    onListFreezes(callback: EditorProtocol['listFreezes']): void;
+    onRenameFreeze(callback: EditorProtocol['renameFreeze']): void;
+    onDeleteFreeze(callback: EditorProtocol['deleteFreeze']): void;
+    /** Emit freeze-changed event to all connected clients */
+    emitFreezeChanged(): void;
+    onLoadRouteParams(callback: EditorProtocol['loadRouteParams']): void;
+    /** Emit a batch of params to all connected clients */
+    emitRouteParamsBatch(event: RouteParamsBatchEvent): void;
 }
 
 interface EditorConfig {
@@ -319,4 +392,4 @@ type FigmaVendorDocument = {
     [key: string]: any;
 };
 
-export { type BaseMessage, type BaseResponse, type ConnectionState, type Contract, type ContractTag, type DevServerProtocol, type EditorConfig, type EditorProtocol, type EditorProtocolMessageTypes, type EditorProtocolResponseTypes, type ExportMessage, type ExportResponse, type FigmaVendorDocument, type GetProjectInfoMessage, type GetProjectInfoResponse, type HasImageMessage, type HasImageResponse, type ImportMessage, type ImportResponse, type Plugin, type PortDiscoveryResponse, type ProjectComponent, type ProjectInfo, type ProjectPage, type ProtocolMessage, type ProtocolResponse, type PublishComponent, type PublishMessage, type PublishPage, type PublishResponse, type PublishStatus, type SaveImageMessage, type SaveImageResponse, createExportMessage, createExportResponse, createGetProjectInfoMessage, createGetProjectInfoResponse, createHasImageMessage, createHasImageResponse, createImportMessage, createImportResponse, createProtocolMessage, createProtocolResponse, createPublishMessage, createPublishResponse, createSaveImageMessage, createSaveImageResponse };
+export { type BaseMessage, type BaseResponse, type ConnectionState, type Contract, type ContractTag, type DeleteFreezeMessage, type DeleteFreezeResponse, type DevServerProtocol, type EditorConfig, type EditorProtocol, type EditorProtocolMessageTypes, type EditorProtocolResponseTypes, type ExportMessage, type ExportResponse, type FigmaVendorDocument, type FreezeEntry, type GetProjectInfoMessage, type GetProjectInfoResponse, type HasImageMessage, type HasImageResponse, type ImportMessage, type ImportResponse, type ListFreezesMessage, type ListFreezesResponse, type ListRoutesMessage, type ListRoutesResponse, type LoadRouteParamsMessage, type LoadRouteParamsResponse, type Plugin, type PortDiscoveryResponse, type ProjectComponent, type ProjectInfo, type ProjectPage, type ProtocolMessage, type ProtocolResponse, type PublishComponent, type PublishMessage, type PublishPage, type PublishResponse, type PublishStatus, type RenameFreezeMessage, type RenameFreezeResponse, type RouteParamsBatchEvent, type SaveImageMessage, type SaveImageResponse, createExportMessage, createExportResponse, createGetProjectInfoMessage, createGetProjectInfoResponse, createHasImageMessage, createHasImageResponse, createImportMessage, createImportResponse, createProtocolMessage, createProtocolResponse, createPublishMessage, createPublishResponse, createSaveImageMessage, createSaveImageResponse };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jay-framework/editor-protocol",
-  "version": "0.15.5",
+  "version": "0.16.0",
   "type": "module",
   "license": "Apache-2.0",
   "main": "dist/index.js",
@@ -24,11 +24,11 @@
     "test:watch": ":"
   },
   "dependencies": {
-    "@jay-framework/compiler-shared": "^0.15.5"
+    "@jay-framework/compiler-shared": "^0.16.0"
   },
   "devDependencies": {
-    "@jay-framework/dev-environment": "^0.15.5",
-    "@jay-framework/jay-cli": "^0.15.5",
+    "@jay-framework/dev-environment": "^0.16.0",
+    "@jay-framework/jay-cli": "^0.16.0",
     "@types/node": "^22.15.21",
     "rimraf": "^5.0.5",
     "tsup": "^8.0.1",