@jay-framework/editor-protocol 0.6.9 → 0.7.0

package/dist/index.d.ts

@@ -12,10 +12,12 @@ interface PublishMessage extends BaseMessage<PublishResponse> {
         route: string;
         jayHtml: string;
         name: string;
+        contract?: string;
     }[];
     components?: {
         jayHtml: string;
         name: string;
+        contract?: string;
     }[];
 }
 type PublishPage = PublishMessage['pages'][number];
@@ -34,6 +36,7 @@ interface PublishResponse extends BaseResponse {
     status: {
         success: boolean;
         filePath?: string;
+        contractPath?: string;
         error?: string;
     }[];
 }
@@ -87,7 +90,7 @@ interface PortDiscoveryResponse {
     port: number;
 }
 
-declare function createPublishMessage(pages: PublishMessage['pages']): PublishMessage;
+declare function createPublishMessage(pages?: PublishMessage['pages'], components?: PublishMessage['components']): PublishMessage;
 declare function createSaveImageMessage(imageId: string, imageData: string): SaveImageMessage;
 declare function createHasImageMessage(imageId: string): HasImageMessage;
 declare function createPublishResponse(status: PublishResponse['status']): PublishResponse;

package/dist/index.js

@@ -1,7 +1,8 @@
-function createPublishMessage(pages) {
+function createPublishMessage(pages, components) {
   return {
     type: "publish",
-    pages
+    pages,
+    components
   };
 }
 function createSaveImageMessage(imageId, imageData) {

package/package.json

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

package/readme.md

@@ -30,7 +30,15 @@ import {
 
 // Use in editor applications
 const editor: EditorProtocol = {
-  publish: async (params) => ({ status: [{ success: true, filePath: '/test.jay-html' }] }),
+  publish: async (params) => ({
+    status: [
+      {
+        success: true,
+        filePath: '/test.jay-html',
+        contractPath: '/test.jay-contract', // Optional contract file path
+      },
+    ],
+  }),
   saveImage: async (params) => ({ success: true, imageUrl: '/assets/image.png' }),
   hasImage: async (params) => ({ exists: true, imageUrl: '/assets/image.png' }),
 };
@@ -43,10 +51,36 @@ const server: DevServerProtocol = {
 };
 
 // Create messages using constructors
-const publishMessage = createPublishMessage([
+const pages = [
   { route: '/home', jayHtml: '<div>Home</div>', name: 'Home' },
-]);
-
+  {
+    route: '/about',
+    jayHtml: '<div>{title}</div>',
+    name: 'About',
+    contract: `name: About
+tags:
+  - tag: title
+    type: data
+    dataType: string
+    required: true`,
+  },
+];
+
+const components = [
+  { jayHtml: '<button>Click me</button>', name: 'Button' },
+  {
+    jayHtml: '<div>{count}</div>',
+    name: 'Counter',
+    contract: `name: Counter
+tags:
+  - tag: count
+    type: data
+    dataType: number
+    required: true`,
+  },
+];
+
+const publishMessage = createPublishMessage(pages, components);
 const protocolMessage = createProtocolMessage(publishMessage);
 ```
 
@@ -54,7 +88,7 @@ const protocolMessage = createProtocolMessage(publishMessage);
 
 ### Message Constructors
 
-- `createPublishMessage(pages)` - Creates a publish message
+- `createPublishMessage(pages?, components?)` - Creates a publish message with optional pages and components
 - `createSaveImageMessage(imageId, imageData)` - Creates a save image message
 - `createHasImageMessage(imageId)` - Creates a has image message
 - `createProtocolMessage(payload)` - Creates a protocol message wrapper with auto-generated timestamp-based ID
@@ -70,7 +104,14 @@ const protocolMessage = createProtocolMessage(publishMessage);
 
 ### Publish
 
-Publishes jay-html files to the dev server at specified routes.
+Publishes jay-html files and optional jay-contract files to the dev server. Pages are published at specified routes, while components are published to the components directory.
+
+**Features:**
+
+- **Pages**: Published as `page.jay-html` and optional `page.jay-contract` files
+- **Components**: Published as `{name}.jay-html` and optional `{name}.jay-contract` files
+- **Contract Support**: Optional contract content for headless components
+- **Backward Compatibility**: Contract publishing is optional and doesn't break existing workflows
 
 ### Save Image
 
@@ -79,3 +120,29 @@ Saves base64 image data to the dev server's public assets.
 ### Has Image
 
 Checks if an image with the given ID already exists on the server.
+
+## Contract Publishing
+
+Contract files enable headless component support by defining the component's data interface and refs structure. When publishing components or pages, you can optionally include contract content:
+
+```typescript
+// Publishing a headless component with contract
+const component = {
+  jayHtml: '<div><span>{count}</span><button ref="increment">+</button></div>',
+  name: 'Counter',
+  contract: `name: Counter
+tags:
+  - tag: count
+    type: data
+    dataType: number
+    required: true
+  - tag: increment
+    type: interactive
+    elementType: HTMLButtonElement
+    description: Button to increment the counter`,
+};
+
+const message = createPublishMessage(undefined, [component]);
+```
+
+The contract file will be saved alongside the jay-html file and can be referenced in other components using the `contract` attribute in jay-headless imports.