@eyeglass/types 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,93 @@
+export type InteractionStatus = 'idle' | 'pending' | 'fixing' | 'success' | 'failed';
+export interface SemanticSnapshot {
+    role: string;
+    name: string;
+    tagName: string;
+    id?: string;
+    className?: string;
+    dataAttributes?: Record<string, string>;
+    framework: {
+        name: 'react' | 'vue' | 'svelte' | 'vanilla';
+        componentName?: string;
+        filePath?: string;
+        lineNumber?: number;
+        props?: Record<string, unknown>;
+        ancestry?: string[];
+    };
+    a11y: {
+        label: string | null;
+        description: string | null;
+        disabled: boolean;
+        expanded?: boolean;
+        checked?: boolean | 'mixed';
+        hidden: boolean;
+    };
+    geometry: {
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+        visible: boolean;
+    };
+    styles: {
+        display: string;
+        position: string;
+        flexDirection?: string;
+        gridTemplate?: string;
+        padding: string;
+        margin: string;
+        color: string;
+        backgroundColor: string;
+        fontFamily: string;
+        zIndex: string;
+    };
+    timestamp: number;
+    url: string;
+}
+export interface FocusPayload {
+    interactionId: string;
+    snapshot?: SemanticSnapshot;
+    snapshots?: SemanticSnapshot[];
+    userNote: string;
+}
+export type ActivityEventType = 'status' | 'thought' | 'question' | 'action';
+export interface BaseActivityEvent {
+    interactionId: string;
+    timestamp: number;
+}
+export interface StatusEvent extends BaseActivityEvent {
+    type: 'status';
+    status: InteractionStatus;
+    message?: string;
+}
+export interface ThoughtEvent extends BaseActivityEvent {
+    type: 'thought';
+    content: string;
+}
+export interface QuestionEvent extends BaseActivityEvent {
+    type: 'question';
+    questionId: string;
+    question: string;
+    options: Array<{
+        id: string;
+        label: string;
+    }>;
+}
+export interface AnswerPayload {
+    interactionId: string;
+    questionId: string;
+    answerId: string;
+    answerLabel: string;
+}
+export interface ActionEvent extends BaseActivityEvent {
+    type: 'action';
+    action: 'reading' | 'writing' | 'searching' | 'thinking';
+    target: string;
+    complete?: boolean;
+}
+export type ActivityEvent = StatusEvent | ThoughtEvent | QuestionEvent | ActionEvent;
+export interface StatusUpdate {
+    interactionId: string;
+    status: InteractionStatus;
+    agentMessage?: string;
+}

package/dist/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/index.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/index.test.js

@@ -0,0 +1,221 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const vitest_1 = require("vitest");
+(0, vitest_1.describe)('@eyeglass/types', () => {
+    (0, vitest_1.describe)('InteractionStatus', () => {
+        (0, vitest_1.it)('should allow valid status values', () => {
+            const statuses = ['idle', 'pending', 'fixing', 'success', 'failed'];
+            (0, vitest_1.expect)(statuses).toHaveLength(5);
+        });
+    });
+    (0, vitest_1.describe)('SemanticSnapshot', () => {
+        (0, vitest_1.it)('should conform to the expected shape', () => {
+            const snapshot = {
+                role: 'button',
+                name: 'Submit',
+                tagName: 'button',
+                framework: {
+                    name: 'react',
+                    componentName: 'SubmitButton',
+                    filePath: 'src/components/SubmitButton.tsx',
+                    lineNumber: 42,
+                },
+                a11y: {
+                    label: 'Submit form',
+                    description: null,
+                    disabled: false,
+                    hidden: false,
+                },
+                geometry: {
+                    x: 100,
+                    y: 200,
+                    width: 120,
+                    height: 40,
+                    visible: true,
+                },
+                styles: {
+                    display: 'inline-flex',
+                    position: 'relative',
+                    padding: '8px 16px',
+                    margin: '0px',
+                    color: 'rgb(255, 255, 255)',
+                    backgroundColor: 'rgb(59, 130, 246)',
+                    fontFamily: 'Inter, sans-serif',
+                    zIndex: 'auto',
+                },
+                timestamp: Date.now(),
+                url: 'http://localhost:3000/',
+            };
+            (0, vitest_1.expect)(snapshot.role).toBe('button');
+            (0, vitest_1.expect)(snapshot.framework.name).toBe('react');
+            (0, vitest_1.expect)(snapshot.a11y.disabled).toBe(false);
+            (0, vitest_1.expect)(snapshot.geometry.visible).toBe(true);
+        });
+        (0, vitest_1.it)('should support optional fields', () => {
+            const snapshot = {
+                role: 'generic',
+                name: '',
+                tagName: 'div',
+                id: 'my-div',
+                className: 'container main',
+                dataAttributes: { 'data-testid': 'main-container' },
+                framework: {
+                    name: 'vanilla',
+                },
+                a11y: {
+                    label: null,
+                    description: null,
+                    disabled: false,
+                    expanded: true,
+                    checked: 'mixed',
+                    hidden: false,
+                },
+                geometry: {
+                    x: 0,
+                    y: 0,
+                    width: 800,
+                    height: 600,
+                    visible: true,
+                },
+                styles: {
+                    display: 'block',
+                    position: 'static',
+                    padding: '0px',
+                    margin: '0px',
+                    color: 'rgb(0, 0, 0)',
+                    backgroundColor: 'rgba(0, 0, 0, 0)',
+                    fontFamily: 'system-ui',
+                    zIndex: 'auto',
+                },
+                timestamp: Date.now(),
+                url: 'http://localhost:3000/',
+            };
+            (0, vitest_1.expect)(snapshot.id).toBe('my-div');
+            (0, vitest_1.expect)(snapshot.className).toBe('container main');
+            (0, vitest_1.expect)(snapshot.dataAttributes).toEqual({ 'data-testid': 'main-container' });
+            (0, vitest_1.expect)(snapshot.a11y.expanded).toBe(true);
+            (0, vitest_1.expect)(snapshot.a11y.checked).toBe('mixed');
+        });
+    });
+    (0, vitest_1.describe)('FocusPayload', () => {
+        (0, vitest_1.it)('should support single snapshot (backwards compat)', () => {
+            const payload = {
+                interactionId: 'abc-123',
+                snapshot: {
+                    role: 'button',
+                    name: 'Click me',
+                    tagName: 'button',
+                    framework: { name: 'react' },
+                    a11y: { label: null, description: null, disabled: false, hidden: false },
+                    geometry: { x: 0, y: 0, width: 100, height: 40, visible: true },
+                    styles: {
+                        display: 'block',
+                        position: 'static',
+                        padding: '0px',
+                        margin: '0px',
+                        color: 'black',
+                        backgroundColor: 'white',
+                        fontFamily: 'Arial',
+                        zIndex: 'auto',
+                    },
+                    timestamp: Date.now(),
+                    url: 'http://localhost/',
+                },
+                userNote: 'Make this blue',
+            };
+            (0, vitest_1.expect)(payload.snapshot).toBeDefined();
+            (0, vitest_1.expect)(payload.snapshots).toBeUndefined();
+        });
+        (0, vitest_1.it)('should support multiple snapshots (multi-select)', () => {
+            const baseSnapshot = {
+                role: 'button',
+                name: '',
+                tagName: 'button',
+                framework: { name: 'react' },
+                a11y: { label: null, description: null, disabled: false, hidden: false },
+                geometry: { x: 0, y: 0, width: 100, height: 40, visible: true },
+                styles: {
+                    display: 'block',
+                    position: 'static',
+                    padding: '0px',
+                    margin: '0px',
+                    color: 'black',
+                    backgroundColor: 'white',
+                    fontFamily: 'Arial',
+                    zIndex: 'auto',
+                },
+                timestamp: Date.now(),
+                url: 'http://localhost/',
+            };
+            const payload = {
+                interactionId: 'abc-123',
+                snapshots: [
+                    { ...baseSnapshot, name: 'Button 1' },
+                    { ...baseSnapshot, name: 'Button 2' },
+                ],
+                userNote: 'Style these buttons consistently',
+            };
+            (0, vitest_1.expect)(payload.snapshots).toHaveLength(2);
+            (0, vitest_1.expect)(payload.snapshot).toBeUndefined();
+        });
+    });
+    (0, vitest_1.describe)('ActivityEvent types', () => {
+        (0, vitest_1.it)('should create valid StatusEvent', () => {
+            const event = {
+                type: 'status',
+                interactionId: 'abc-123',
+                status: 'fixing',
+                message: 'Working on it...',
+                timestamp: Date.now(),
+            };
+            (0, vitest_1.expect)(event.type).toBe('status');
+            (0, vitest_1.expect)(event.status).toBe('fixing');
+        });
+        (0, vitest_1.it)('should create valid ThoughtEvent', () => {
+            const event = {
+                type: 'thought',
+                interactionId: 'abc-123',
+                content: 'I need to change the background color',
+                timestamp: Date.now(),
+            };
+            (0, vitest_1.expect)(event.type).toBe('thought');
+            (0, vitest_1.expect)(event.content).toContain('background color');
+        });
+        (0, vitest_1.it)('should create valid QuestionEvent', () => {
+            const event = {
+                type: 'question',
+                interactionId: 'abc-123',
+                questionId: 'q-1',
+                question: 'Which shade of blue?',
+                options: [
+                    { id: 'light', label: 'Light blue' },
+                    { id: 'dark', label: 'Dark blue' },
+                ],
+                timestamp: Date.now(),
+            };
+            (0, vitest_1.expect)(event.type).toBe('question');
+            (0, vitest_1.expect)(event.options).toHaveLength(2);
+        });
+        (0, vitest_1.it)('should create valid ActionEvent', () => {
+            const event = {
+                type: 'action',
+                interactionId: 'abc-123',
+                action: 'writing',
+                target: 'src/components/Button.tsx',
+                complete: false,
+                timestamp: Date.now(),
+            };
+            (0, vitest_1.expect)(event.type).toBe('action');
+            (0, vitest_1.expect)(event.action).toBe('writing');
+        });
+        (0, vitest_1.it)('should allow ActivityEvent union', () => {
+            const events = [
+                { type: 'status', interactionId: 'a', status: 'idle', timestamp: 1 },
+                { type: 'thought', interactionId: 'a', content: 'thinking', timestamp: 2 },
+                { type: 'question', interactionId: 'a', questionId: 'q', question: '?', options: [], timestamp: 3 },
+                { type: 'action', interactionId: 'a', action: 'reading', target: 'file.ts', timestamp: 4 },
+            ];
+            (0, vitest_1.expect)(events).toHaveLength(4);
+        });
+    });
+});

package/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "@eyeglass/types",
+  "version": "0.1.0",
+  "description": "Shared TypeScript types for Eyeglass",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "test": "vitest run --project node --testNamePattern types",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "eyeglass",
+    "types",
+    "typescript"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/donutboyband/eyeglass.git",
+    "directory": "packages/types"
+  },
+  "devDependencies": {
+    "typescript": "^5.3.0"
+  }
+}