@objectstack/spec 0.6.1 → 0.7.1

package/json-schema/hub/PluginRegistryEntry.json

@@ -0,0 +1,833 @@
+{
+  "$ref": "#/definitions/PluginRegistryEntry",
+  "definitions": {
+    "PluginRegistryEntry": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string",
+          "pattern": "^([a-z][a-z0-9]*\\.)+[a-z][a-z0-9-]+$",
+          "description": "Plugin identifier (reverse domain notation)"
+        },
+        "version": {
+          "type": "string",
+          "pattern": "^\\d+\\.\\d+\\.\\d+$"
+        },
+        "name": {
+          "type": "string"
+        },
+        "description": {
+          "type": "string"
+        },
+        "readme": {
+          "type": "string"
+        },
+        "category": {
+          "type": "string",
+          "enum": [
+            "data",
+            "integration",
+            "ui",
+            "analytics",
+            "security",
+            "automation",
+            "ai",
+            "utility",
+            "driver",
+            "gateway",
+            "adapter"
+          ]
+        },
+        "tags": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "vendor": {
+          "type": "object",
+          "properties": {
+            "id": {
+              "type": "string",
+              "pattern": "^[a-z][a-z0-9]*(\\.[a-z][a-z0-9]*)+$",
+              "description": "Vendor identifier (reverse domain)"
+            },
+            "name": {
+              "type": "string"
+            },
+            "website": {
+              "type": "string",
+              "format": "uri"
+            },
+            "email": {
+              "type": "string",
+              "format": "email"
+            },
+            "verified": {
+              "type": "boolean",
+              "default": false,
+              "description": "Whether vendor is verified by ObjectStack"
+            },
+            "trustLevel": {
+              "type": "string",
+              "enum": [
+                "official",
+                "verified",
+                "community",
+                "unverified"
+              ],
+              "default": "unverified"
+            }
+          },
+          "required": [
+            "id",
+            "name"
+          ],
+          "additionalProperties": false
+        },
+        "capabilities": {
+          "type": "object",
+          "properties": {
+            "implements": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "protocol": {
+                    "type": "object",
+                    "properties": {
+                      "id": {
+                        "type": "string",
+                        "pattern": "^([a-z][a-z0-9]*\\.)+protocol\\.[a-z][a-z0-9._]*\\.v\\d+$",
+                        "description": "Unique protocol identifier (e.g., com.objectstack.protocol.storage.v1)"
+                      },
+                      "label": {
+                        "type": "string"
+                      },
+                      "version": {
+                        "type": "object",
+                        "properties": {
+                          "major": {
+                            "type": "integer",
+                            "minimum": 0
+                          },
+                          "minor": {
+                            "type": "integer",
+                            "minimum": 0
+                          },
+                          "patch": {
+                            "type": "integer",
+                            "minimum": 0
+                          }
+                        },
+                        "required": [
+                          "major",
+                          "minor",
+                          "patch"
+                        ],
+                        "additionalProperties": false,
+                        "description": "Semantic version of the protocol"
+                      },
+                      "specification": {
+                        "type": "string",
+                        "description": "URL or path to protocol specification"
+                      },
+                      "description": {
+                        "type": "string"
+                      }
+                    },
+                    "required": [
+                      "id",
+                      "label",
+                      "version"
+                    ],
+                    "additionalProperties": false
+                  },
+                  "conformance": {
+                    "type": "string",
+                    "enum": [
+                      "full",
+                      "partial",
+                      "experimental",
+                      "deprecated"
+                    ],
+                    "description": "Level of protocol conformance",
+                    "default": "full"
+                  },
+                  "implementedFeatures": {
+                    "type": "array",
+                    "items": {
+                      "type": "string"
+                    },
+                    "description": "List of implemented feature names"
+                  },
+                  "features": {
+                    "type": "array",
+                    "items": {
+                      "type": "object",
+                      "properties": {
+                        "name": {
+                          "type": "string",
+                          "description": "Feature identifier within the protocol"
+                        },
+                        "enabled": {
+                          "type": "boolean",
+                          "default": true
+                        },
+                        "description": {
+                          "type": "string"
+                        },
+                        "sinceVersion": {
+                          "type": "string",
+                          "description": "Version when this feature was added"
+                        },
+                        "deprecatedSince": {
+                          "type": "string",
+                          "description": "Version when deprecated"
+                        }
+                      },
+                      "required": [
+                        "name"
+                      ],
+                      "additionalProperties": false
+                    }
+                  },
+                  "metadata": {
+                    "type": "object",
+                    "additionalProperties": {}
+                  },
+                  "certified": {
+                    "type": "boolean",
+                    "default": false,
+                    "description": "Has passed official conformance tests"
+                  },
+                  "certificationDate": {
+                    "type": "string",
+                    "format": "date-time"
+                  }
+                },
+                "required": [
+                  "protocol"
+                ],
+                "additionalProperties": false
+              },
+              "description": "List of protocols this plugin conforms to"
+            },
+            "provides": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "id": {
+                    "type": "string",
+                    "pattern": "^([a-z][a-z0-9]*\\.)+interface\\.[a-z][a-z0-9._]+$",
+                    "description": "Unique interface identifier"
+                  },
+                  "name": {
+                    "type": "string"
+                  },
+                  "description": {
+                    "type": "string"
+                  },
+                  "version": {
+                    "type": "object",
+                    "properties": {
+                      "major": {
+                        "type": "integer",
+                        "minimum": 0
+                      },
+                      "minor": {
+                        "type": "integer",
+                        "minimum": 0
+                      },
+                      "patch": {
+                        "type": "integer",
+                        "minimum": 0
+                      }
+                    },
+                    "required": [
+                      "major",
+                      "minor",
+                      "patch"
+                    ],
+                    "additionalProperties": false,
+                    "description": "Semantic version of the protocol"
+                  },
+                  "methods": {
+                    "type": "array",
+                    "items": {
+                      "type": "object",
+                      "properties": {
+                        "name": {
+                          "type": "string",
+                          "description": "Method name"
+                        },
+                        "description": {
+                          "type": "string"
+                        },
+                        "parameters": {
+                          "type": "array",
+                          "items": {
+                            "type": "object",
+                            "properties": {
+                              "name": {
+                                "type": "string"
+                              },
+                              "type": {
+                                "type": "string",
+                                "description": "Type notation (e.g., string, number, User)"
+                              },
+                              "required": {
+                                "type": "boolean",
+                                "default": true
+                              },
+                              "description": {
+                                "type": "string"
+                              }
+                            },
+                            "required": [
+                              "name",
+                              "type"
+                            ],
+                            "additionalProperties": false
+                          }
+                        },
+                        "returnType": {
+                          "type": "string",
+                          "description": "Return value type"
+                        },
+                        "async": {
+                          "type": "boolean",
+                          "default": false,
+                          "description": "Whether method returns a Promise"
+                        }
+                      },
+                      "required": [
+                        "name"
+                      ],
+                      "additionalProperties": false
+                    }
+                  },
+                  "events": {
+                    "type": "array",
+                    "items": {
+                      "type": "object",
+                      "properties": {
+                        "name": {
+                          "type": "string",
+                          "description": "Event name"
+                        },
+                        "description": {
+                          "type": "string"
+                        },
+                        "payload": {
+                          "type": "string",
+                          "description": "Event payload type"
+                        }
+                      },
+                      "required": [
+                        "name"
+                      ],
+                      "additionalProperties": false
+                    }
+                  },
+                  "stability": {
+                    "type": "string",
+                    "enum": [
+                      "stable",
+                      "beta",
+                      "alpha",
+                      "experimental"
+                    ],
+                    "default": "stable"
+                  }
+                },
+                "required": [
+                  "id",
+                  "name",
+                  "version",
+                  "methods"
+                ],
+                "additionalProperties": false
+              },
+              "description": "Services/APIs this plugin offers to others"
+            },
+            "requires": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "pluginId": {
+                    "type": "string",
+                    "pattern": "^([a-z][a-z0-9]*\\.)+[a-z][a-z0-9-]+$",
+                    "description": "Required plugin identifier"
+                  },
+                  "version": {
+                    "type": "string",
+                    "description": "Semantic version constraint"
+                  },
+                  "optional": {
+                    "type": "boolean",
+                    "default": false
+                  },
+                  "reason": {
+                    "type": "string"
+                  },
+                  "requiredCapabilities": {
+                    "type": "array",
+                    "items": {
+                      "type": "string"
+                    },
+                    "description": "Protocol IDs the dependency must support"
+                  }
+                },
+                "required": [
+                  "pluginId",
+                  "version"
+                ],
+                "additionalProperties": false
+              },
+              "description": "Required plugins and their capabilities"
+            },
+            "extensionPoints": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "id": {
+                    "type": "string",
+                    "pattern": "^([a-z][a-z0-9]*\\.)+extension\\.[a-z][a-z0-9._]+$",
+                    "description": "Unique extension point identifier"
+                  },
+                  "name": {
+                    "type": "string"
+                  },
+                  "description": {
+                    "type": "string"
+                  },
+                  "type": {
+                    "type": "string",
+                    "enum": [
+                      "action",
+                      "hook",
+                      "widget",
+                      "provider",
+                      "transformer",
+                      "validator",
+                      "decorator"
+                    ]
+                  },
+                  "contract": {
+                    "type": "object",
+                    "properties": {
+                      "input": {
+                        "type": "string",
+                        "description": "Input type/schema"
+                      },
+                      "output": {
+                        "type": "string",
+                        "description": "Output type/schema"
+                      },
+                      "signature": {
+                        "type": "string",
+                        "description": "Function signature if applicable"
+                      }
+                    },
+                    "additionalProperties": false
+                  },
+                  "cardinality": {
+                    "type": "string",
+                    "enum": [
+                      "single",
+                      "multiple"
+                    ],
+                    "default": "multiple",
+                    "description": "Whether multiple extensions can register to this point"
+                  }
+                },
+                "required": [
+                  "id",
+                  "name",
+                  "type"
+                ],
+                "additionalProperties": false
+              },
+              "description": "Points where other plugins can extend this plugin"
+            },
+            "extensions": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "targetPluginId": {
+                    "type": "string",
+                    "description": "Plugin ID being extended"
+                  },
+                  "extensionPointId": {
+                    "type": "string",
+                    "description": "Extension point identifier"
+                  },
+                  "implementation": {
+                    "type": "string",
+                    "description": "Path to implementation module"
+                  },
+                  "priority": {
+                    "type": "integer",
+                    "default": 100,
+                    "description": "Registration priority (lower = higher priority)"
+                  }
+                },
+                "required": [
+                  "targetPluginId",
+                  "extensionPointId",
+                  "implementation"
+                ],
+                "additionalProperties": false
+              },
+              "description": "Extensions contributed to other plugins"
+            }
+          },
+          "additionalProperties": false
+        },
+        "compatibility": {
+          "type": "object",
+          "properties": {
+            "minObjectStackVersion": {
+              "type": "string"
+            },
+            "maxObjectStackVersion": {
+              "type": "string"
+            },
+            "nodeVersion": {
+              "type": "string"
+            },
+            "platforms": {
+              "type": "array",
+              "items": {
+                "type": "string",
+                "enum": [
+                  "linux",
+                  "darwin",
+                  "win32",
+                  "browser"
+                ]
+              }
+            }
+          },
+          "additionalProperties": false
+        },
+        "links": {
+          "type": "object",
+          "properties": {
+            "homepage": {
+              "type": "string",
+              "format": "uri"
+            },
+            "repository": {
+              "type": "string",
+              "format": "uri"
+            },
+            "documentation": {
+              "type": "string",
+              "format": "uri"
+            },
+            "bugs": {
+              "type": "string",
+              "format": "uri"
+            },
+            "changelog": {
+              "type": "string",
+              "format": "uri"
+            }
+          },
+          "additionalProperties": false
+        },
+        "media": {
+          "type": "object",
+          "properties": {
+            "icon": {
+              "type": "string",
+              "format": "uri"
+            },
+            "logo": {
+              "type": "string",
+              "format": "uri"
+            },
+            "screenshots": {
+              "type": "array",
+              "items": {
+                "type": "string",
+                "format": "uri"
+              }
+            },
+            "video": {
+              "type": "string",
+              "format": "uri"
+            }
+          },
+          "additionalProperties": false
+        },
+        "quality": {
+          "type": "object",
+          "properties": {
+            "testCoverage": {
+              "type": "number",
+              "minimum": 0,
+              "maximum": 100
+            },
+            "documentationScore": {
+              "type": "number",
+              "minimum": 0,
+              "maximum": 100
+            },
+            "codeQuality": {
+              "type": "number",
+              "minimum": 0,
+              "maximum": 100
+            },
+            "securityScan": {
+              "type": "object",
+              "properties": {
+                "lastScanDate": {
+                  "type": "string",
+                  "format": "date-time"
+                },
+                "vulnerabilities": {
+                  "type": "object",
+                  "properties": {
+                    "critical": {
+                      "type": "integer",
+                      "minimum": 0,
+                      "default": 0
+                    },
+                    "high": {
+                      "type": "integer",
+                      "minimum": 0,
+                      "default": 0
+                    },
+                    "medium": {
+                      "type": "integer",
+                      "minimum": 0,
+                      "default": 0
+                    },
+                    "low": {
+                      "type": "integer",
+                      "minimum": 0,
+                      "default": 0
+                    }
+                  },
+                  "additionalProperties": false
+                },
+                "passed": {
+                  "type": "boolean",
+                  "default": false
+                }
+              },
+              "additionalProperties": false
+            },
+            "conformanceTests": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "protocolId": {
+                    "type": "string",
+                    "description": "Protocol being tested"
+                  },
+                  "passed": {
+                    "type": "boolean"
+                  },
+                  "totalTests": {
+                    "type": "integer",
+                    "minimum": 0
+                  },
+                  "passedTests": {
+                    "type": "integer",
+                    "minimum": 0
+                  },
+                  "lastRunDate": {
+                    "type": "string",
+                    "format": "date-time"
+                  }
+                },
+                "required": [
+                  "protocolId",
+                  "passed",
+                  "totalTests",
+                  "passedTests"
+                ],
+                "additionalProperties": false
+              }
+            }
+          },
+          "additionalProperties": false
+        },
+        "statistics": {
+          "type": "object",
+          "properties": {
+            "downloads": {
+              "type": "integer",
+              "minimum": 0,
+              "default": 0
+            },
+            "downloadsLastMonth": {
+              "type": "integer",
+              "minimum": 0,
+              "default": 0
+            },
+            "activeInstallations": {
+              "type": "integer",
+              "minimum": 0,
+              "default": 0
+            },
+            "ratings": {
+              "type": "object",
+              "properties": {
+                "average": {
+                  "type": "number",
+                  "minimum": 0,
+                  "maximum": 5,
+                  "default": 0
+                },
+                "count": {
+                  "type": "integer",
+                  "minimum": 0,
+                  "default": 0
+                },
+                "distribution": {
+                  "type": "object",
+                  "properties": {
+                    "1": {
+                      "type": "integer",
+                      "minimum": 0,
+                      "default": 0
+                    },
+                    "2": {
+                      "type": "integer",
+                      "minimum": 0,
+                      "default": 0
+                    },
+                    "3": {
+                      "type": "integer",
+                      "minimum": 0,
+                      "default": 0
+                    },
+                    "4": {
+                      "type": "integer",
+                      "minimum": 0,
+                      "default": 0
+                    },
+                    "5": {
+                      "type": "integer",
+                      "minimum": 0,
+                      "default": 0
+                    }
+                  },
+                  "additionalProperties": false
+                }
+              },
+              "additionalProperties": false
+            },
+            "stars": {
+              "type": "integer",
+              "minimum": 0
+            },
+            "dependents": {
+              "type": "integer",
+              "minimum": 0,
+              "default": 0
+            }
+          },
+          "additionalProperties": false
+        },
+        "license": {
+          "type": "string",
+          "description": "SPDX license identifier"
+        },
+        "pricing": {
+          "type": "object",
+          "properties": {
+            "model": {
+              "type": "string",
+              "enum": [
+                "free",
+                "freemium",
+                "paid",
+                "enterprise"
+              ]
+            },
+            "price": {
+              "type": "number",
+              "minimum": 0
+            },
+            "currency": {
+              "type": "string",
+              "default": "USD"
+            },
+            "billingPeriod": {
+              "type": "string",
+              "enum": [
+                "one-time",
+                "monthly",
+                "yearly"
+              ]
+            }
+          },
+          "required": [
+            "model"
+          ],
+          "additionalProperties": false
+        },
+        "publishedAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "updatedAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "deprecated": {
+          "type": "boolean",
+          "default": false
+        },
+        "deprecationMessage": {
+          "type": "string"
+        },
+        "replacedBy": {
+          "type": "string",
+          "description": "Plugin ID that replaces this one"
+        },
+        "flags": {
+          "type": "object",
+          "properties": {
+            "experimental": {
+              "type": "boolean",
+              "default": false
+            },
+            "beta": {
+              "type": "boolean",
+              "default": false
+            },
+            "featured": {
+              "type": "boolean",
+              "default": false
+            },
+            "verified": {
+              "type": "boolean",
+              "default": false
+            }
+          },
+          "additionalProperties": false
+        }
+      },
+      "required": [
+        "id",
+        "version",
+        "name",
+        "vendor"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}