@jay-framework/editor-protocol 0.6.0

package/dist/index.cjs

@@ -0,0 +1,72 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+function createPublishMessage(pages) {
+  return {
+    type: "publish",
+    pages
+  };
+}
+function createSaveImageMessage(imageId, imageData) {
+  return {
+    type: "saveImage",
+    imageId,
+    imageData
+  };
+}
+function createHasImageMessage(imageId) {
+  return {
+    type: "hasImage",
+    imageId
+  };
+}
+function createPublishResponse(status) {
+  return {
+    type: "publish",
+    success: status.every((s) => s.success),
+    status
+  };
+}
+function createSaveImageResponse(success, imageUrl, error) {
+  return {
+    type: "saveImage",
+    success,
+    imageUrl,
+    error
+  };
+}
+function createHasImageResponse(exists, imageUrl) {
+  return {
+    type: "hasImage",
+    success: true,
+    exists,
+    imageUrl
+  };
+}
+let messageIdCounter = 0;
+function generateMessageId() {
+  const timestamp = Date.now();
+  const counter = ++messageIdCounter;
+  return `${timestamp}-${counter}`;
+}
+function createProtocolMessage(payload) {
+  return {
+    id: generateMessageId(),
+    timestamp: Date.now(),
+    payload
+  };
+}
+function createProtocolResponse(id, payload) {
+  return {
+    id,
+    timestamp: Date.now(),
+    payload
+  };
+}
+exports.createHasImageMessage = createHasImageMessage;
+exports.createHasImageResponse = createHasImageResponse;
+exports.createProtocolMessage = createProtocolMessage;
+exports.createProtocolResponse = createProtocolResponse;
+exports.createPublishMessage = createPublishMessage;
+exports.createPublishResponse = createPublishResponse;
+exports.createSaveImageMessage = createSaveImageMessage;
+exports.createSaveImageResponse = createSaveImageResponse;

package/dist/index.d.ts

@@ -0,0 +1,90 @@
+interface BaseMessage<TResponse extends BaseResponse = BaseResponse> {
+    type: string;
+}
+interface BaseResponse {
+    type: string;
+    success: boolean;
+    error?: string;
+}
+interface PublishMessage extends BaseMessage<PublishResponse> {
+    type: 'publish';
+    pages: {
+        route: string;
+        jayHtml: string;
+        name: string;
+    }[];
+}
+interface SaveImageMessage extends BaseMessage<SaveImageResponse> {
+    type: 'saveImage';
+    imageId: string;
+    imageData: string;
+}
+interface HasImageMessage extends BaseMessage<HasImageResponse> {
+    type: 'hasImage';
+    imageId: string;
+}
+interface PublishResponse extends BaseResponse {
+    type: 'publish';
+    status: {
+        success: boolean;
+        filePath?: string;
+        error?: string;
+    }[];
+}
+interface SaveImageResponse extends BaseResponse {
+    type: 'saveImage';
+    success: boolean;
+    imageUrl?: string;
+    error?: string;
+}
+interface HasImageResponse extends BaseResponse {
+    type: 'hasImage';
+    exists: boolean;
+    imageUrl?: string;
+}
+interface ProtocolMessage {
+    id: string;
+    timestamp: number;
+    payload: PublishMessage | SaveImageMessage | HasImageMessage;
+}
+interface ProtocolResponse {
+    id: string;
+    timestamp: number;
+    payload: PublishResponse | SaveImageResponse | HasImageResponse;
+}
+interface EditorProtocol {
+    publish(params: PublishMessage): Promise<PublishResponse>;
+    saveImage(params: SaveImageMessage): Promise<SaveImageResponse>;
+    hasImage(params: HasImageMessage): Promise<HasImageResponse>;
+}
+interface DevServerProtocol {
+    onPublish(callback: EditorProtocol['publish']): void;
+    onSaveImage(callback: EditorProtocol['saveImage']): void;
+    onHasImage(callback: EditorProtocol['hasImage']): void;
+}
+
+interface EditorConfig {
+    id?: string;
+    name?: string;
+    portRanges: {
+        http: [number, number];
+        editor: [number, number];
+    };
+}
+type ConnectionState = 'disconnected' | 'connecting' | 'connected' | 'error';
+interface PortDiscoveryResponse {
+    status: 'init' | 'configured';
+    id?: string;
+    port: number;
+}
+
+declare function createPublishMessage(pages: PublishMessage['pages']): PublishMessage;
+declare function createSaveImageMessage(imageId: string, imageData: string): SaveImageMessage;
+declare function createHasImageMessage(imageId: string): HasImageMessage;
+declare function createPublishResponse(status: PublishResponse['status']): PublishResponse;
+declare function createSaveImageResponse(success: boolean, imageUrl?: string, error?: string): SaveImageResponse;
+declare function createHasImageResponse(exists: boolean, imageUrl?: string): HasImageResponse;
+declare function createProtocolMessage(payload: PublishMessage | SaveImageMessage | HasImageMessage): ProtocolMessage;
+declare function createProtocolResponse(id: string, payload: PublishResponse | SaveImageResponse | HasImageResponse): ProtocolResponse;
+
+export { type BaseMessage, type BaseResponse, type ConnectionState, type DevServerProtocol, type EditorConfig, type EditorProtocol, type HasImageMessage, type HasImageResponse, type PortDiscoveryResponse, type ProtocolMessage, type ProtocolResponse, type PublishMessage, type PublishResponse, type SaveImageMessage, type SaveImageResponse, createHasImageMessage, createHasImageResponse, createProtocolMessage, createProtocolResponse, createPublishMessage, createPublishResponse, createSaveImageMessage, createSaveImageResponse };

package/dist/index.js

@@ -0,0 +1,72 @@
+function createPublishMessage(pages) {
+  return {
+    type: "publish",
+    pages
+  };
+}
+function createSaveImageMessage(imageId, imageData) {
+  return {
+    type: "saveImage",
+    imageId,
+    imageData
+  };
+}
+function createHasImageMessage(imageId) {
+  return {
+    type: "hasImage",
+    imageId
+  };
+}
+function createPublishResponse(status) {
+  return {
+    type: "publish",
+    success: status.every((s) => s.success),
+    status
+  };
+}
+function createSaveImageResponse(success, imageUrl, error) {
+  return {
+    type: "saveImage",
+    success,
+    imageUrl,
+    error
+  };
+}
+function createHasImageResponse(exists, imageUrl) {
+  return {
+    type: "hasImage",
+    success: true,
+    exists,
+    imageUrl
+  };
+}
+let messageIdCounter = 0;
+function generateMessageId() {
+  const timestamp = Date.now();
+  const counter = ++messageIdCounter;
+  return `${timestamp}-${counter}`;
+}
+function createProtocolMessage(payload) {
+  return {
+    id: generateMessageId(),
+    timestamp: Date.now(),
+    payload
+  };
+}
+function createProtocolResponse(id, payload) {
+  return {
+    id,
+    timestamp: Date.now(),
+    payload
+  };
+}
+export {
+  createHasImageMessage,
+  createHasImageResponse,
+  createProtocolMessage,
+  createProtocolResponse,
+  createPublishMessage,
+  createPublishResponse,
+  createSaveImageMessage,
+  createSaveImageResponse
+};

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "@jay-framework/editor-protocol",
+  "version": "0.6.0",
+  "type": "module",
+  "license": "Apache-2.0",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "files": [
+    "dist",
+    "readme.md"
+  ],
+  "scripts": {
+    "build": "npm run build:js && npm run build:types",
+    "build:watch": "npm run build:js -- --watch & npm run build:types -- --watch",
+    "build:js": "vite build",
+    "build:types": "tsup lib/index.ts --dts-only --format esm",
+    "build:check-types": "tsc",
+    "clean": "rimraf dist",
+    "confirm": "npm run clean && npm run build && npm run build:check-types && npm run test",
+    "test": ":",
+    "test:watch": ":"
+  },
+  "devDependencies": {
+    "@jay-framework/dev-environment": "^0.6.0",
+    "@jay-framework/jay-cli": "^0.6.0",
+    "@types/node": "^22.15.21",
+    "rimraf": "^5.0.5",
+    "tsup": "^8.0.1",
+    "typescript": "^5.3.3",
+    "vite": "^5.0.11",
+    "vitest": "^1.2.1"
+  }
+}

package/readme.md

@@ -0,0 +1,81 @@
+# @jay-framework/editor-protocol
+
+Shared TypeScript interfaces and types for the Jay editor integration protocol.
+
+## Overview
+
+This package provides the shared protocol definitions for communication between editor applications and Jay dev servers. It includes:
+
+- `EditorProtocol` - Interface for editor-side operations
+- `DevServerProtocol` - Interface for dev server-side handlers
+- Message format types for WebSocket communication
+- Configuration and connection state types
+- Constructor functions for creating messages and responses
+
+## Usage
+
+```typescript
+import type {
+  EditorProtocol,
+  DevServerProtocol,
+  EditorConfig,
+} from '@jay-framework/editor-protocol';
+
+import {
+  createPublishMessage,
+  createSaveImageMessage,
+  createHasImageMessage,
+  createProtocolMessage,
+} from '@jay-framework/editor-protocol';
+
+// Use in editor applications
+const editor: EditorProtocol = {
+  publish: async (params) => ({ status: [{ success: true, filePath: '/test.jay-html' }] }),
+  saveImage: async (params) => ({ success: true, imageUrl: '/assets/image.png' }),
+  hasImage: async (params) => ({ exists: true, imageUrl: '/assets/image.png' }),
+};
+
+// Use in dev servers
+const server: DevServerProtocol = {
+  onPublish: (callback) => {},
+  onSaveImage: (callback) => {},
+  onHasImage: (callback) => {},
+};
+
+// Create messages using constructors
+const publishMessage = createPublishMessage([
+  { route: '/home', jayHtml: '<div>Home</div>', name: 'Home' },
+]);
+
+const protocolMessage = createProtocolMessage(publishMessage);
+```
+
+## Constructor Functions
+
+### Message Constructors
+
+- `createPublishMessage(pages)` - Creates a publish message
+- `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
+
+### Response Constructors
+
+- `createPublishResponse(status)` - Creates a publish response
+- `createSaveImageResponse(success, imageUrl?, error?)` - Creates a save image response
+- `createHasImageResponse(exists, imageUrl?)` - Creates a has image response
+- `createProtocolResponse(id, payload)` - Creates a protocol response wrapper with timestamp
+
+## Protocol Operations
+
+### Publish
+
+Publishes jay-html files to the dev server at specified routes.
+
+### Save Image
+
+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.