@objectstack/spec 0.9.0 → 0.9.2

package/dist/ai/plugin-development.zod.js

@@ -0,0 +1,576 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PluginRecommendationSchema = exports.PluginRecommendationRequestSchema = exports.PluginCompositionResultSchema = exports.PluginCompositionRequestSchema = exports.AICodeReviewResultSchema = exports.PluginScaffoldingTemplateSchema = exports.GeneratedCodeSchema = exports.CodeGenerationRequestSchema = void 0;
+const zod_1 = require("zod");
+/**
+ * # AI-Driven Plugin Development Protocol
+ *
+ * Defines protocols for AI-powered plugin development including:
+ * - Natural language to code generation
+ * - Intelligent code scaffolding
+ * - Automated testing and validation
+ * - AI-powered code review and optimization
+ * - Plugin composition and recommendation
+ */
+/**
+ * Code Generation Request
+ * Request for AI to generate plugin code
+ */
+exports.CodeGenerationRequestSchema = zod_1.z.object({
+    /**
+     * Natural language description of desired functionality
+     */
+    description: zod_1.z.string().describe('What the plugin should do'),
+    /**
+     * Plugin type to generate
+     */
+    pluginType: zod_1.z.enum([
+        'driver', // Data driver plugin
+        'app', // Application plugin
+        'widget', // UI widget
+        'integration', // External integration
+        'automation', // Automation/workflow
+        'analytics', // Analytics plugin
+        'ai-agent', // AI agent plugin
+        'custom', // Custom plugin type
+    ]),
+    /**
+     * Output format for generated code
+     */
+    outputFormat: zod_1.z.enum([
+        'source-code', // Generate TypeScript/JavaScript source code
+        'low-code-schema', // Generate ObjectStack JSON/YAML schema definitions
+        'dsl', // Generate domain-specific language definitions
+    ]).default('source-code')
+        .describe('Format of the generated output'),
+    /**
+     * Target programming language (for source-code format)
+     */
+    language: zod_1.z.enum(['typescript', 'javascript', 'python']).default('typescript'),
+    /**
+     * Framework preferences
+     */
+    framework: zod_1.z.object({
+        runtime: zod_1.z.enum(['node', 'browser', 'edge', 'universal']).optional(),
+        uiFramework: zod_1.z.enum(['react', 'vue', 'svelte', 'none']).optional(),
+        testing: zod_1.z.enum(['vitest', 'jest', 'mocha', 'none']).optional(),
+    }).optional(),
+    /**
+     * Required capabilities
+     */
+    capabilities: zod_1.z.array(zod_1.z.string()).optional().describe('Protocol IDs to implement'),
+    /**
+     * Dependencies
+     */
+    dependencies: zod_1.z.array(zod_1.z.string()).optional().describe('Required plugin IDs'),
+    /**
+     * Example usage (helps AI understand intent)
+     */
+    examples: zod_1.z.array(zod_1.z.object({
+        input: zod_1.z.string(),
+        expectedOutput: zod_1.z.string(),
+        description: zod_1.z.string().optional(),
+    })).optional(),
+    /**
+     * Code style preferences (for source-code format)
+     */
+    style: zod_1.z.object({
+        indentation: zod_1.z.enum(['tab', '2spaces', '4spaces']).default('2spaces'),
+        quotes: zod_1.z.enum(['single', 'double']).default('single'),
+        semicolons: zod_1.z.boolean().default(true),
+        trailingComma: zod_1.z.boolean().default(true),
+    }).optional(),
+    /**
+     * Low-code schema preferences (for low-code-schema format)
+     */
+    schemaOptions: zod_1.z.object({
+        /**
+         * Schema format
+         */
+        format: zod_1.z.enum(['json', 'yaml', 'typescript']).default('typescript')
+            .describe('Output schema format'),
+        /**
+         * Include example data
+         */
+        includeExamples: zod_1.z.boolean().default(true),
+        /**
+         * Validation strictness
+         */
+        strictValidation: zod_1.z.boolean().default(true),
+        /**
+         * Generate UI definitions
+         */
+        generateUI: zod_1.z.boolean().default(true)
+            .describe('Generate view, dashboard, and page definitions'),
+        /**
+         * Generate data models
+         */
+        generateDataModels: zod_1.z.boolean().default(true)
+            .describe('Generate object and field definitions'),
+    }).optional(),
+    /**
+     * Additional context
+     */
+    context: zod_1.z.object({
+        /**
+         * Existing code to extend
+         */
+        existingCode: zod_1.z.string().optional(),
+        /**
+         * Related documentation URLs
+         */
+        documentationUrls: zod_1.z.array(zod_1.z.string()).optional(),
+        /**
+         * Similar plugins for reference
+         */
+        referencePlugins: zod_1.z.array(zod_1.z.string()).optional(),
+    }).optional(),
+    /**
+     * Generation options
+     */
+    options: zod_1.z.object({
+        /**
+         * Include tests
+         */
+        generateTests: zod_1.z.boolean().default(true),
+        /**
+         * Include documentation
+         */
+        generateDocs: zod_1.z.boolean().default(true),
+        /**
+         * Include examples
+         */
+        generateExamples: zod_1.z.boolean().default(true),
+        /**
+         * Code coverage target
+         */
+        targetCoverage: zod_1.z.number().min(0).max(100).default(80),
+        /**
+         * Optimization level
+         */
+        optimizationLevel: zod_1.z.enum(['none', 'basic', 'aggressive']).default('basic'),
+    }).optional(),
+});
+/**
+ * Generated Code
+ * Result of code generation
+ */
+exports.GeneratedCodeSchema = zod_1.z.object({
+    /**
+     * Output format used
+     */
+    outputFormat: zod_1.z.enum(['source-code', 'low-code-schema', 'dsl']),
+    /**
+     * Main plugin code (for source-code format)
+     */
+    code: zod_1.z.string().optional(),
+    /**
+     * Language used (for source-code format)
+     */
+    language: zod_1.z.string().optional(),
+    /**
+     * Low-code schema definitions (for low-code-schema format)
+     */
+    schemas: zod_1.z.array(zod_1.z.object({
+        type: zod_1.z.enum(['object', 'view', 'dashboard', 'app', 'workflow', 'api', 'page']),
+        path: zod_1.z.string().describe('File path for the schema'),
+        content: zod_1.z.string().describe('Schema content (JSON/YAML/TypeScript)'),
+        description: zod_1.z.string().optional(),
+    })).optional()
+        .describe('Generated low-code schema files'),
+    /**
+     * File structure
+     */
+    files: zod_1.z.array(zod_1.z.object({
+        path: zod_1.z.string(),
+        content: zod_1.z.string(),
+        description: zod_1.z.string().optional(),
+    })),
+    /**
+     * Generated tests
+     */
+    tests: zod_1.z.array(zod_1.z.object({
+        path: zod_1.z.string(),
+        content: zod_1.z.string(),
+        coverage: zod_1.z.number().min(0).max(100).optional(),
+    })).optional(),
+    /**
+     * Documentation
+     */
+    documentation: zod_1.z.object({
+        readme: zod_1.z.string().optional(),
+        api: zod_1.z.string().optional(),
+        usage: zod_1.z.string().optional(),
+    }).optional(),
+    /**
+     * Package metadata
+     */
+    package: zod_1.z.object({
+        name: zod_1.z.string(),
+        version: zod_1.z.string(),
+        dependencies: zod_1.z.record(zod_1.z.string(), zod_1.z.string()).optional(),
+        devDependencies: zod_1.z.record(zod_1.z.string(), zod_1.z.string()).optional(),
+    }).optional(),
+    /**
+     * Quality metrics
+     */
+    quality: zod_1.z.object({
+        complexity: zod_1.z.number().optional().describe('Cyclomatic complexity'),
+        maintainability: zod_1.z.number().min(0).max(100).optional(),
+        testCoverage: zod_1.z.number().min(0).max(100).optional(),
+        lintScore: zod_1.z.number().min(0).max(100).optional(),
+    }).optional(),
+    /**
+     * AI confidence score
+     */
+    confidence: zod_1.z.number().min(0).max(100).describe('AI confidence in generated code'),
+    /**
+     * Suggestions for improvement
+     */
+    suggestions: zod_1.z.array(zod_1.z.string()).optional(),
+    /**
+     * Warnings or caveats
+     */
+    warnings: zod_1.z.array(zod_1.z.string()).optional(),
+});
+/**
+ * Plugin Scaffolding Template
+ * Template for plugin structure
+ */
+exports.PluginScaffoldingTemplateSchema = zod_1.z.object({
+    /**
+     * Template identifier
+     */
+    id: zod_1.z.string(),
+    /**
+     * Template name
+     */
+    name: zod_1.z.string(),
+    /**
+     * Description
+     */
+    description: zod_1.z.string(),
+    /**
+     * Plugin type
+     */
+    pluginType: zod_1.z.string(),
+    /**
+     * File structure
+     */
+    structure: zod_1.z.array(zod_1.z.object({
+        type: zod_1.z.enum(['file', 'directory']),
+        path: zod_1.z.string(),
+        template: zod_1.z.string().optional().describe('Template content with variables'),
+        optional: zod_1.z.boolean().default(false),
+    })),
+    /**
+     * Variables to be filled
+     */
+    variables: zod_1.z.array(zod_1.z.object({
+        name: zod_1.z.string(),
+        description: zod_1.z.string(),
+        type: zod_1.z.enum(['string', 'number', 'boolean', 'array', 'object']),
+        required: zod_1.z.boolean().default(true),
+        default: zod_1.z.any().optional(),
+        validation: zod_1.z.string().optional().describe('Validation regex or rule'),
+    })),
+    /**
+     * Post-scaffold scripts
+     */
+    scripts: zod_1.z.array(zod_1.z.object({
+        name: zod_1.z.string(),
+        command: zod_1.z.string(),
+        description: zod_1.z.string().optional(),
+        optional: zod_1.z.boolean().default(false),
+    })).optional(),
+});
+/**
+ * AI Code Review Result
+ * Result of AI-powered code review
+ */
+exports.AICodeReviewResultSchema = zod_1.z.object({
+    /**
+     * Overall assessment
+     */
+    assessment: zod_1.z.enum(['excellent', 'good', 'acceptable', 'needs-improvement', 'poor']),
+    /**
+     * Overall score (0-100)
+     */
+    score: zod_1.z.number().min(0).max(100),
+    /**
+     * Issues found
+     */
+    issues: zod_1.z.array(zod_1.z.object({
+        severity: zod_1.z.enum(['critical', 'error', 'warning', 'info', 'style']),
+        category: zod_1.z.enum([
+            'bug',
+            'security',
+            'performance',
+            'maintainability',
+            'style',
+            'documentation',
+            'testing',
+            'type-safety',
+            'best-practice',
+        ]),
+        file: zod_1.z.string(),
+        line: zod_1.z.number().int().optional(),
+        column: zod_1.z.number().int().optional(),
+        message: zod_1.z.string(),
+        suggestion: zod_1.z.string().optional(),
+        autoFixable: zod_1.z.boolean().default(false),
+        autoFix: zod_1.z.string().optional().describe('Automated fix code'),
+    })),
+    /**
+     * Positive highlights
+     */
+    highlights: zod_1.z.array(zod_1.z.object({
+        category: zod_1.z.string(),
+        description: zod_1.z.string(),
+        file: zod_1.z.string().optional(),
+    })).optional(),
+    /**
+     * Quality metrics
+     */
+    metrics: zod_1.z.object({
+        complexity: zod_1.z.number().optional(),
+        maintainability: zod_1.z.number().min(0).max(100).optional(),
+        testCoverage: zod_1.z.number().min(0).max(100).optional(),
+        duplicateCode: zod_1.z.number().min(0).max(100).optional(),
+        technicalDebt: zod_1.z.string().optional().describe('Estimated technical debt'),
+    }).optional(),
+    /**
+     * Recommendations
+     */
+    recommendations: zod_1.z.array(zod_1.z.object({
+        priority: zod_1.z.enum(['high', 'medium', 'low']),
+        title: zod_1.z.string(),
+        description: zod_1.z.string(),
+        effort: zod_1.z.enum(['trivial', 'small', 'medium', 'large']).optional(),
+    })),
+    /**
+     * Security analysis
+     */
+    security: zod_1.z.object({
+        vulnerabilities: zod_1.z.array(zod_1.z.object({
+            severity: zod_1.z.enum(['critical', 'high', 'medium', 'low']),
+            type: zod_1.z.string(),
+            description: zod_1.z.string(),
+            remediation: zod_1.z.string().optional(),
+        })).optional(),
+        score: zod_1.z.number().min(0).max(100).optional(),
+    }).optional(),
+});
+/**
+ * Plugin Composition Request
+ * Request for AI to compose multiple plugins together
+ */
+exports.PluginCompositionRequestSchema = zod_1.z.object({
+    /**
+     * Desired outcome
+     */
+    goal: zod_1.z.string().describe('What should the composed plugins achieve'),
+    /**
+     * Available plugins
+     */
+    availablePlugins: zod_1.z.array(zod_1.z.object({
+        pluginId: zod_1.z.string(),
+        version: zod_1.z.string(),
+        capabilities: zod_1.z.array(zod_1.z.string()).optional(),
+        description: zod_1.z.string().optional(),
+    })),
+    /**
+     * Constraints
+     */
+    constraints: zod_1.z.object({
+        /**
+         * Maximum plugins to use
+         */
+        maxPlugins: zod_1.z.number().int().min(1).optional(),
+        /**
+         * Required plugins
+         */
+        requiredPlugins: zod_1.z.array(zod_1.z.string()).optional(),
+        /**
+         * Excluded plugins
+         */
+        excludedPlugins: zod_1.z.array(zod_1.z.string()).optional(),
+        /**
+         * Performance requirements
+         */
+        performance: zod_1.z.object({
+            maxLatency: zod_1.z.number().optional().describe('Maximum latency in ms'),
+            maxMemory: zod_1.z.number().optional().describe('Maximum memory in bytes'),
+        }).optional(),
+    }).optional(),
+    /**
+     * Optimization criteria
+     */
+    optimize: zod_1.z.enum([
+        'performance',
+        'reliability',
+        'simplicity',
+        'cost',
+        'security',
+    ]).optional(),
+});
+/**
+ * Plugin Composition Result
+ * AI-generated plugin composition
+ */
+exports.PluginCompositionResultSchema = zod_1.z.object({
+    /**
+     * Selected plugins
+     */
+    plugins: zod_1.z.array(zod_1.z.object({
+        pluginId: zod_1.z.string(),
+        version: zod_1.z.string(),
+        role: zod_1.z.string().describe('Role in the composition'),
+        configuration: zod_1.z.record(zod_1.z.string(), zod_1.z.any()).optional(),
+    })),
+    /**
+     * Integration code
+     */
+    integration: zod_1.z.object({
+        /**
+         * Glue code to connect plugins
+         */
+        code: zod_1.z.string(),
+        /**
+         * Configuration
+         */
+        config: zod_1.z.record(zod_1.z.string(), zod_1.z.any()).optional(),
+        /**
+         * Initialization order
+         */
+        initOrder: zod_1.z.array(zod_1.z.string()),
+    }),
+    /**
+     * Data flow diagram
+     */
+    dataFlow: zod_1.z.array(zod_1.z.object({
+        from: zod_1.z.string(),
+        to: zod_1.z.string(),
+        data: zod_1.z.string().describe('Data type or description'),
+    })),
+    /**
+     * Expected performance
+     */
+    performance: zod_1.z.object({
+        estimatedLatency: zod_1.z.number().optional().describe('Estimated latency in ms'),
+        estimatedMemory: zod_1.z.number().optional().describe('Estimated memory in bytes'),
+    }).optional(),
+    /**
+     * Confidence score
+     */
+    confidence: zod_1.z.number().min(0).max(100),
+    /**
+     * Alternative compositions
+     */
+    alternatives: zod_1.z.array(zod_1.z.object({
+        description: zod_1.z.string(),
+        plugins: zod_1.z.array(zod_1.z.string()),
+        tradeoffs: zod_1.z.string(),
+    })).optional(),
+    /**
+     * Warnings and considerations
+     */
+    warnings: zod_1.z.array(zod_1.z.string()).optional(),
+});
+/**
+ * Plugin Recommendation Request
+ * Request for plugin recommendations
+ */
+exports.PluginRecommendationRequestSchema = zod_1.z.object({
+    /**
+     * User context
+     */
+    context: zod_1.z.object({
+        /**
+         * Current plugins installed
+         */
+        installedPlugins: zod_1.z.array(zod_1.z.string()).optional(),
+        /**
+         * User's industry
+         */
+        industry: zod_1.z.string().optional(),
+        /**
+         * Use cases
+         */
+        useCases: zod_1.z.array(zod_1.z.string()).optional(),
+        /**
+         * Team size
+         */
+        teamSize: zod_1.z.number().int().optional(),
+        /**
+         * Budget constraints
+         */
+        budget: zod_1.z.enum(['free', 'low', 'medium', 'high', 'unlimited']).optional(),
+    }),
+    /**
+     * Recommendation criteria
+     */
+    criteria: zod_1.z.object({
+        /**
+         * Prioritize by
+         */
+        prioritize: zod_1.z.enum([
+            'popularity',
+            'rating',
+            'compatibility',
+            'features',
+            'cost',
+            'support',
+        ]).optional(),
+        /**
+         * Only certified plugins
+         */
+        certifiedOnly: zod_1.z.boolean().default(false),
+        /**
+         * Minimum rating
+         */
+        minRating: zod_1.z.number().min(0).max(5).optional(),
+        /**
+         * Maximum results
+         */
+        maxResults: zod_1.z.number().int().min(1).max(50).default(10),
+    }).optional(),
+});
+/**
+ * Plugin Recommendation
+ * AI-generated plugin recommendation
+ */
+exports.PluginRecommendationSchema = zod_1.z.object({
+    /**
+     * Recommended plugins
+     */
+    recommendations: zod_1.z.array(zod_1.z.object({
+        pluginId: zod_1.z.string(),
+        name: zod_1.z.string(),
+        description: zod_1.z.string(),
+        score: zod_1.z.number().min(0).max(100).describe('Relevance score'),
+        reasons: zod_1.z.array(zod_1.z.string()).describe('Why this plugin is recommended'),
+        benefits: zod_1.z.array(zod_1.z.string()),
+        considerations: zod_1.z.array(zod_1.z.string()).optional(),
+        alternatives: zod_1.z.array(zod_1.z.string()).optional(),
+        estimatedValue: zod_1.z.string().optional().describe('Expected value/ROI'),
+    })),
+    /**
+     * Recommended combinations
+     */
+    combinations: zod_1.z.array(zod_1.z.object({
+        plugins: zod_1.z.array(zod_1.z.string()),
+        description: zod_1.z.string(),
+        synergies: zod_1.z.array(zod_1.z.string()).describe('How these plugins work well together'),
+        totalScore: zod_1.z.number().min(0).max(100),
+    })).optional(),
+    /**
+     * Learning path
+     */
+    learningPath: zod_1.z.array(zod_1.z.object({
+        step: zod_1.z.number().int(),
+        plugin: zod_1.z.string(),
+        reason: zod_1.z.string(),
+        resources: zod_1.z.array(zod_1.z.string()).optional(),
+    })).optional(),
+});