@objectstack/spec 0.9.0 → 0.9.2

package/dist/hub/marketplace-enhanced.zod.js

@@ -0,0 +1,728 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PluginRevenueSharingSchema = exports.PluginInstallationStatusSchema = exports.PluginInstallationRequestSchema = exports.PluginSearchQuerySchema = exports.PluginMarketplaceListingSchema = exports.PluginLicenseSchema = exports.PluginCertificationSchema = exports.MarketplaceQualityMetricsSchema = exports.PluginRatingSchema = exports.PluginTagSchema = exports.PluginCategorySchema = exports.RegistryConfigSchema = exports.RegistryUpstreamSchema = exports.RegistrySyncPolicySchema = void 0;
+const zod_1 = require("zod");
+const plugin_security_advanced_zod_1 = require("../system/plugin-security-advanced.zod");
+const plugin_versioning_zod_1 = require("../system/plugin-versioning.zod");
+/**
+ * # Enhanced Plugin Registry and Marketplace Protocol
+ *
+ * Comprehensive protocol for plugin discovery, distribution, installation,
+ * and lifecycle management in a centralized marketplace.
+ *
+ * Features:
+ * - Plugin discovery and search
+ * - Rating and review system
+ * - Quality scoring and certification
+ * - Automated installation and updates
+ * - License management
+ * - Revenue sharing for plugin developers
+ * - Registry federation for hybrid cloud deployments
+ */
+/**
+ * Registry Sync Policy
+ * Defines how registries synchronize with upstreams
+ */
+exports.RegistrySyncPolicySchema = zod_1.z.enum([
+    'manual', // Manual synchronization only
+    'auto', // Automatic synchronization
+    'proxy', // Proxy requests to upstream without caching
+]).describe('Registry synchronization strategy');
+/**
+ * Registry Upstream Configuration
+ * Configuration for upstream registry connection
+ */
+exports.RegistryUpstreamSchema = zod_1.z.object({
+    /**
+     * Upstream registry URL
+     */
+    url: zod_1.z.string().url()
+        .describe('Upstream registry endpoint'),
+    /**
+     * Synchronization policy
+     */
+    syncPolicy: exports.RegistrySyncPolicySchema.default('auto'),
+    /**
+     * Sync interval in seconds (for auto sync)
+     */
+    syncInterval: zod_1.z.number().int().min(60).optional()
+        .describe('Auto-sync interval in seconds'),
+    /**
+     * Authentication credentials
+     */
+    auth: zod_1.z.object({
+        type: zod_1.z.enum(['none', 'basic', 'bearer', 'api-key', 'oauth2']).default('none'),
+        username: zod_1.z.string().optional(),
+        password: zod_1.z.string().optional(),
+        token: zod_1.z.string().optional(),
+        apiKey: zod_1.z.string().optional(),
+    }).optional(),
+    /**
+     * TLS/SSL configuration
+     */
+    tls: zod_1.z.object({
+        enabled: zod_1.z.boolean().default(true),
+        verifyCertificate: zod_1.z.boolean().default(true),
+        certificate: zod_1.z.string().optional(),
+        privateKey: zod_1.z.string().optional(),
+    }).optional(),
+    /**
+     * Timeout settings
+     */
+    timeout: zod_1.z.number().int().min(1000).default(30000)
+        .describe('Request timeout in milliseconds'),
+    /**
+     * Retry configuration
+     */
+    retry: zod_1.z.object({
+        maxAttempts: zod_1.z.number().int().min(0).default(3),
+        backoff: zod_1.z.enum(['fixed', 'linear', 'exponential']).default('exponential'),
+    }).optional(),
+});
+/**
+ * Registry Configuration
+ * Complete registry configuration supporting federation
+ */
+exports.RegistryConfigSchema = zod_1.z.object({
+    /**
+     * Registry type
+     */
+    type: zod_1.z.enum([
+        'public', // Public marketplace (e.g., plugins.objectstack.com)
+        'private', // Private enterprise registry
+        'hybrid', // Hybrid with upstream federation
+    ]).describe('Registry deployment type'),
+    /**
+     * Upstream registries (for hybrid/private registries)
+     */
+    upstream: zod_1.z.array(exports.RegistryUpstreamSchema).optional()
+        .describe('Upstream registries to sync from or proxy to'),
+    /**
+     * Scopes managed by this registry
+     */
+    scope: zod_1.z.array(zod_1.z.string()).optional()
+        .describe('npm-style scopes managed by this registry (e.g., @my-corp, @enterprise)'),
+    /**
+     * Default scope for new plugins
+     */
+    defaultScope: zod_1.z.string().optional()
+        .describe('Default scope prefix for new plugins'),
+    /**
+     * Registry storage configuration
+     */
+    storage: zod_1.z.object({
+        /**
+         * Storage backend type
+         */
+        backend: zod_1.z.enum(['local', 's3', 'gcs', 'azure-blob', 'oss']).default('local'),
+        /**
+         * Storage path or bucket name
+         */
+        path: zod_1.z.string().optional(),
+        /**
+         * Credentials
+         */
+        credentials: zod_1.z.record(zod_1.z.string(), zod_1.z.any()).optional(),
+    }).optional(),
+    /**
+     * Registry visibility
+     */
+    visibility: zod_1.z.enum(['public', 'private', 'internal']).default('private')
+        .describe('Who can access this registry'),
+    /**
+     * Access control
+     */
+    accessControl: zod_1.z.object({
+        /**
+         * Require authentication for read
+         */
+        requireAuthForRead: zod_1.z.boolean().default(false),
+        /**
+         * Require authentication for write
+         */
+        requireAuthForWrite: zod_1.z.boolean().default(true),
+        /**
+         * Allowed users/teams
+         */
+        allowedPrincipals: zod_1.z.array(zod_1.z.string()).optional(),
+    }).optional(),
+    /**
+     * Caching configuration
+     */
+    cache: zod_1.z.object({
+        enabled: zod_1.z.boolean().default(true),
+        ttl: zod_1.z.number().int().min(0).default(3600)
+            .describe('Cache TTL in seconds'),
+        maxSize: zod_1.z.number().int().optional()
+            .describe('Maximum cache size in bytes'),
+    }).optional(),
+    /**
+     * Mirroring configuration (for high availability)
+     */
+    mirrors: zod_1.z.array(zod_1.z.object({
+        url: zod_1.z.string().url(),
+        priority: zod_1.z.number().int().min(1).default(1),
+    })).optional()
+        .describe('Mirror registries for redundancy'),
+});
+/**
+ * Plugin Category
+ * Categorization for better discovery
+ */
+exports.PluginCategorySchema = zod_1.z.enum([
+    'data-integration', // Data connectors and integrations
+    'analytics', // Analytics and BI tools
+    'ai-ml', // AI and machine learning
+    'automation', // Workflow automation
+    'communication', // Communication tools
+    'crm', // CRM extensions
+    'erp', // ERP extensions
+    'productivity', // Productivity tools
+    'security', // Security tools
+    'ui-components', // UI widgets and components
+    'utilities', // Utility plugins
+    'developer-tools', // Development tools
+    'other', // Other categories
+]).describe('Plugin category for classification');
+/**
+ * Plugin Tag
+ * Flexible tagging for discovery
+ */
+exports.PluginTagSchema = zod_1.z.object({
+    name: zod_1.z.string().describe('Tag name'),
+    category: zod_1.z.enum(['feature', 'technology', 'industry', 'custom']).optional(),
+});
+/**
+ * Plugin Rating
+ * User rating for a plugin
+ */
+exports.PluginRatingSchema = zod_1.z.object({
+    /**
+     * User who rated
+     */
+    userId: zod_1.z.string(),
+    /**
+     * Rating value (1-5 stars)
+     */
+    rating: zod_1.z.number().min(1).max(5),
+    /**
+     * Optional review text
+     */
+    review: zod_1.z.string().optional(),
+    /**
+     * Rating timestamp
+     */
+    timestamp: zod_1.z.string().datetime(),
+    /**
+     * Verified purchase
+     */
+    verifiedPurchase: zod_1.z.boolean().default(false),
+    /**
+     * Helpful votes
+     */
+    helpfulVotes: zod_1.z.number().int().min(0).default(0),
+});
+/**
+ * Plugin Quality Metrics (Marketplace)
+ * Objective quality measurements for marketplace listing
+ */
+exports.MarketplaceQualityMetricsSchema = zod_1.z.object({
+    /**
+     * Code quality score (0-100)
+     */
+    codeQuality: zod_1.z.number().min(0).max(100).optional(),
+    /**
+     * Test coverage percentage
+     */
+    testCoverage: zod_1.z.number().min(0).max(100).optional(),
+    /**
+     * Documentation completeness (0-100)
+     */
+    documentation: zod_1.z.number().min(0).max(100).optional(),
+    /**
+     * Performance score (0-100)
+     */
+    performance: zod_1.z.number().min(0).max(100).optional(),
+    /**
+     * Security score (0-100)
+     */
+    security: zod_1.z.number().min(0).max(100).optional(),
+    /**
+     * Maintainability index
+     */
+    maintainability: zod_1.z.number().min(0).max(100).optional(),
+    /**
+     * Number of open issues
+     */
+    openIssues: zod_1.z.number().int().min(0).optional(),
+    /**
+     * Average issue resolution time (hours)
+     */
+    avgIssueResolutionTime: zod_1.z.number().optional(),
+    /**
+     * Update frequency (days)
+     */
+    updateFrequency: zod_1.z.number().optional(),
+    /**
+     * Last update date
+     */
+    lastUpdated: zod_1.z.string().datetime().optional(),
+});
+/**
+ * Plugin Certification
+ * Official certification status
+ */
+exports.PluginCertificationSchema = zod_1.z.object({
+    /**
+     * Certification level
+     */
+    level: zod_1.z.enum([
+        'verified', // Identity verified
+        'tested', // Passed basic tests
+        'certified', // Full certification
+        'enterprise', // Enterprise-grade certification
+        'partner', // Official partner
+    ]),
+    /**
+     * Certification date
+     */
+    certifiedDate: zod_1.z.string().datetime(),
+    /**
+     * Expiry date
+     */
+    expiryDate: zod_1.z.string().datetime().optional(),
+    /**
+     * Certification authority
+     */
+    authority: zod_1.z.string(),
+    /**
+     * Certificate ID
+     */
+    certificateId: zod_1.z.string().optional(),
+    /**
+     * Badge URL
+     */
+    badgeUrl: zod_1.z.string().url().optional(),
+});
+/**
+ * Plugin License
+ * Licensing information
+ */
+exports.PluginLicenseSchema = zod_1.z.object({
+    /**
+     * License type
+     */
+    type: zod_1.z.enum([
+        'free', // Free to use
+        'open-source', // Open source license
+        'freemium', // Free with premium features
+        'trial', // Trial period
+        'subscription', // Subscription-based
+        'perpetual', // One-time purchase
+        'enterprise', // Enterprise licensing
+        'custom', // Custom licensing
+    ]),
+    /**
+     * SPDX license identifier
+     */
+    spdxId: zod_1.z.string().optional().describe('SPDX license identifier (e.g., MIT, Apache-2.0)'),
+    /**
+     * License text or URL
+     */
+    licenseText: zod_1.z.string().optional(),
+    /**
+     * License URL
+     */
+    licenseUrl: zod_1.z.string().url().optional(),
+    /**
+     * Commercial use allowed
+     */
+    commercialUse: zod_1.z.boolean().default(true),
+    /**
+     * Attribution required
+     */
+    attributionRequired: zod_1.z.boolean().default(false),
+    /**
+     * Pricing information
+     */
+    pricing: zod_1.z.object({
+        /**
+         * Free tier available
+         */
+        freeTier: zod_1.z.boolean().default(false),
+        /**
+         * Trial period (days)
+         */
+        trialDays: zod_1.z.number().int().min(0).optional(),
+        /**
+         * Pricing model
+         */
+        model: zod_1.z.enum(['free', 'per-user', 'per-tenant', 'usage-based', 'flat-rate']).optional(),
+        /**
+         * Price per unit (in cents)
+         */
+        pricePerUnit: zod_1.z.number().int().min(0).optional(),
+        /**
+         * Billing period
+         */
+        billingPeriod: zod_1.z.enum(['monthly', 'annually', 'one-time']).optional(),
+        /**
+         * Currency
+         */
+        currency: zod_1.z.string().default('USD'),
+    }).optional(),
+});
+/**
+ * Plugin Marketplace Listing
+ * Complete marketplace information for a plugin
+ */
+exports.PluginMarketplaceListingSchema = zod_1.z.object({
+    /**
+     * Plugin identifier
+     */
+    pluginId: zod_1.z.string(),
+    /**
+     * Display name
+     */
+    name: zod_1.z.string(),
+    /**
+     * Short description (for listings)
+     */
+    shortDescription: zod_1.z.string().max(200),
+    /**
+     * Full description (supports markdown)
+     */
+    description: zod_1.z.string(),
+    /**
+     * Author/publisher information
+     */
+    publisher: zod_1.z.object({
+        id: zod_1.z.string(),
+        name: zod_1.z.string(),
+        website: zod_1.z.string().url().optional(),
+        email: zod_1.z.string().email().optional(),
+        verified: zod_1.z.boolean().default(false),
+    }),
+    /**
+     * Categories
+     */
+    categories: zod_1.z.array(exports.PluginCategorySchema),
+    /**
+     * Tags
+     */
+    tags: zod_1.z.array(exports.PluginTagSchema).optional(),
+    /**
+     * Version information
+     */
+    versions: zod_1.z.array(plugin_versioning_zod_1.PluginVersionMetadataSchema),
+    /**
+     * Latest stable version
+     */
+    latestVersion: zod_1.z.string(),
+    /**
+     * Icon URL
+     */
+    icon: zod_1.z.string().url().optional(),
+    /**
+     * Screenshots
+     */
+    screenshots: zod_1.z.array(zod_1.z.object({
+        url: zod_1.z.string().url(),
+        caption: zod_1.z.string().optional(),
+        thumbnail: zod_1.z.string().url().optional(),
+    })).optional(),
+    /**
+     * Demo/video URL
+     */
+    demoUrl: zod_1.z.string().url().optional(),
+    /**
+     * Documentation URL
+     */
+    documentationUrl: zod_1.z.string().url().optional(),
+    /**
+     * Source code URL
+     */
+    sourceUrl: zod_1.z.string().url().optional(),
+    /**
+     * License
+     */
+    license: exports.PluginLicenseSchema,
+    /**
+     * Ratings
+     */
+    ratings: zod_1.z.object({
+        average: zod_1.z.number().min(0).max(5),
+        count: zod_1.z.number().int().min(0),
+        distribution: zod_1.z.object({
+            '1': zod_1.z.number().int().min(0),
+            '2': zod_1.z.number().int().min(0),
+            '3': zod_1.z.number().int().min(0),
+            '4': zod_1.z.number().int().min(0),
+            '5': zod_1.z.number().int().min(0),
+        }),
+        reviews: zod_1.z.array(exports.PluginRatingSchema).optional(),
+    }).optional(),
+    /**
+     * Quality metrics
+     */
+    quality: exports.MarketplaceQualityMetricsSchema.optional(),
+    /**
+     * Certification
+     */
+    certification: exports.PluginCertificationSchema.optional(),
+    /**
+     * Security information
+     */
+    security: plugin_security_advanced_zod_1.PluginSecurityManifestSchema.optional(),
+    /**
+     * Statistics
+     */
+    statistics: zod_1.z.object({
+        downloads: zod_1.z.number().int().min(0),
+        activeInstallations: zod_1.z.number().int().min(0),
+        views: zod_1.z.number().int().min(0).optional(),
+        favorites: zod_1.z.number().int().min(0).optional(),
+    }),
+    /**
+     * Support information
+     */
+    support: zod_1.z.object({
+        email: zod_1.z.string().email().optional(),
+        url: zod_1.z.string().url().optional(),
+        forum: zod_1.z.string().url().optional(),
+        chat: zod_1.z.string().url().optional(),
+        phone: zod_1.z.string().optional(),
+        responseTime: zod_1.z.string().optional().describe('Expected response time'),
+        sla: zod_1.z.string().url().optional().describe('SLA document URL'),
+    }).optional(),
+    /**
+     * Marketplace metadata
+     */
+    marketplace: zod_1.z.object({
+        /**
+         * Featured plugin
+         */
+        featured: zod_1.z.boolean().default(false),
+        /**
+         * Editor's choice
+         */
+        editorsChoice: zod_1.z.boolean().default(false),
+        /**
+         * New release
+         */
+        newRelease: zod_1.z.boolean().default(false),
+        /**
+         * Trending
+         */
+        trending: zod_1.z.boolean().default(false),
+        /**
+         * Rank in category
+         */
+        categoryRank: zod_1.z.number().int().min(1).optional(),
+        /**
+         * Overall rank
+         */
+        overallRank: zod_1.z.number().int().min(1).optional(),
+    }).optional(),
+    /**
+     * First published date
+     */
+    publishedDate: zod_1.z.string().datetime(),
+    /**
+     * Last updated date
+     */
+    lastUpdated: zod_1.z.string().datetime(),
+});
+/**
+ * Plugin Search Query
+ * Search and filter criteria
+ */
+exports.PluginSearchQuerySchema = zod_1.z.object({
+    /**
+     * Search text
+     */
+    query: zod_1.z.string().optional(),
+    /**
+     * Filter by category
+     */
+    category: exports.PluginCategorySchema.optional(),
+    /**
+     * Filter by tags
+     */
+    tags: zod_1.z.array(zod_1.z.string()).optional(),
+    /**
+     * Filter by license type
+     */
+    licenseType: zod_1.z.array(zod_1.z.string()).optional(),
+    /**
+     * Minimum rating
+     */
+    minRating: zod_1.z.number().min(0).max(5).optional(),
+    /**
+     * Minimum quality score
+     */
+    minQualityScore: zod_1.z.number().min(0).max(100).optional(),
+    /**
+     * Certification required
+     */
+    certifiedOnly: zod_1.z.boolean().optional(),
+    /**
+     * Free plugins only
+     */
+    freeOnly: zod_1.z.boolean().optional(),
+    /**
+     * Sort by
+     */
+    sortBy: zod_1.z.enum([
+        'relevance',
+        'popularity',
+        'rating',
+        'downloads',
+        'newest',
+        'updated',
+        'name',
+    ]).optional(),
+    /**
+     * Sort order
+     */
+    sortOrder: zod_1.z.enum(['asc', 'desc']).default('desc'),
+    /**
+     * Pagination
+     */
+    page: zod_1.z.number().int().min(1).default(1),
+    pageSize: zod_1.z.number().int().min(1).max(100).default(20),
+});
+/**
+ * Plugin Installation Request
+ * Request to install a plugin
+ */
+exports.PluginInstallationRequestSchema = zod_1.z.object({
+    /**
+     * Plugin identifier
+     */
+    pluginId: zod_1.z.string(),
+    /**
+     * Version to install
+     */
+    version: zod_1.z.string().optional().describe('If not specified, latest stable version'),
+    /**
+     * Installation configuration
+     */
+    config: zod_1.z.record(zod_1.z.string(), zod_1.z.any()).optional(),
+    /**
+     * Accept license
+     */
+    acceptLicense: zod_1.z.boolean().default(false),
+    /**
+     * Grant permissions
+     */
+    grantPermissions: zod_1.z.array(zod_1.z.string()).optional(),
+    /**
+     * Enable automatically
+     */
+    autoEnable: zod_1.z.boolean().default(true),
+    /**
+     * Installation scope
+     */
+    scope: zod_1.z.enum(['global', 'tenant', 'user']).default('global'),
+    /**
+     * Tenant ID (if scope is tenant)
+     */
+    tenantId: zod_1.z.string().optional(),
+});
+/**
+ * Plugin Installation Status
+ * Status of plugin installation
+ */
+exports.PluginInstallationStatusSchema = zod_1.z.object({
+    /**
+     * Installation ID
+     */
+    installationId: zod_1.z.string(),
+    /**
+     * Plugin ID
+     */
+    pluginId: zod_1.z.string(),
+    /**
+     * Version installed
+     */
+    version: zod_1.z.string(),
+    /**
+     * Installation status
+     */
+    status: zod_1.z.enum([
+        'pending',
+        'downloading',
+        'verifying',
+        'installing',
+        'configuring',
+        'completed',
+        'failed',
+        'rollback',
+    ]),
+    /**
+     * Progress percentage
+     */
+    progress: zod_1.z.number().min(0).max(100).optional(),
+    /**
+     * Status message
+     */
+    message: zod_1.z.string().optional(),
+    /**
+     * Error details (if failed)
+     */
+    error: zod_1.z.object({
+        code: zod_1.z.string(),
+        message: zod_1.z.string(),
+        details: zod_1.z.any().optional(),
+    }).optional(),
+    /**
+     * Started timestamp
+     */
+    startedAt: zod_1.z.string().datetime(),
+    /**
+     * Completed timestamp
+     */
+    completedAt: zod_1.z.string().datetime().optional(),
+});
+/**
+ * Plugin Revenue Sharing
+ * Revenue sharing configuration for paid plugins
+ */
+exports.PluginRevenueSharingSchema = zod_1.z.object({
+    /**
+     * Plugin ID
+     */
+    pluginId: zod_1.z.string(),
+    /**
+     * Developer share percentage
+     */
+    developerShare: zod_1.z.number().min(0).max(100).describe('Percentage going to developer'),
+    /**
+     * Platform share percentage
+     */
+    platformShare: zod_1.z.number().min(0).max(100).describe('Percentage going to platform'),
+    /**
+     * Payment schedule
+     */
+    paymentSchedule: zod_1.z.enum(['monthly', 'quarterly', 'annually']).default('monthly'),
+    /**
+     * Minimum payout threshold (in cents)
+     */
+    minimumPayout: zod_1.z.number().int().min(0).default(10000).describe('Minimum $100 default'),
+    /**
+     * Payment method
+     */
+    paymentMethod: zod_1.z.object({
+        type: zod_1.z.enum(['bank-transfer', 'paypal', 'stripe', 'other']),
+        details: zod_1.z.record(zod_1.z.string(), zod_1.z.any()).optional(),
+    }),
+    /**
+     * Tax information
+     */
+    taxInfo: zod_1.z.object({
+        taxId: zod_1.z.string().optional(),
+        country: zod_1.z.string(),
+        taxExempt: zod_1.z.boolean().default(false),
+    }).optional(),
+});