@objectstack/spec 0.6.0 → 0.7.1

package/json-schema/hub/PluginSearchFilters.json

@@ -0,0 +1,91 @@
+{
+  "$ref": "#/definitions/PluginSearchFilters",
+  "definitions": {
+    "PluginSearchFilters": {
+      "type": "object",
+      "properties": {
+        "query": {
+          "type": "string"
+        },
+        "category": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "tags": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "trustLevel": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "enum": [
+              "official",
+              "verified",
+              "community",
+              "unverified"
+            ]
+          }
+        },
+        "implementsProtocols": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "pricingModel": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "enum": [
+              "free",
+              "freemium",
+              "paid",
+              "enterprise"
+            ]
+          }
+        },
+        "minRating": {
+          "type": "number",
+          "minimum": 0,
+          "maximum": 5
+        },
+        "sortBy": {
+          "type": "string",
+          "enum": [
+            "relevance",
+            "downloads",
+            "rating",
+            "updated",
+            "name"
+          ]
+        },
+        "sortOrder": {
+          "type": "string",
+          "enum": [
+            "asc",
+            "desc"
+          ],
+          "default": "desc"
+        },
+        "page": {
+          "type": "integer",
+          "minimum": 1,
+          "default": 1
+        },
+        "limit": {
+          "type": "integer",
+          "minimum": 1,
+          "maximum": 100,
+          "default": 20
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/hub/PluginStatistics.json

@@ -0,0 +1,84 @@
+{
+  "$ref": "#/definitions/PluginStatistics",
+  "definitions": {
+    "PluginStatistics": {
+      "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
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/hub/PluginVendor.json

@@ -0,0 +1,47 @@
+{
+  "$ref": "#/definitions/PluginVendor",
+  "definitions": {
+    "PluginVendor": {
+      "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
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/integration/AckMode.json

@@ -0,0 +1,15 @@
+{
+  "$ref": "#/definitions/AckMode",
+  "definitions": {
+    "AckMode": {
+      "type": "string",
+      "enum": [
+        "auto",
+        "manual",
+        "client"
+      ],
+      "description": "Message acknowledgment mode"
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/integration/ApiVersionConfig.json

@@ -0,0 +1,32 @@
+{
+  "$ref": "#/definitions/ApiVersionConfig",
+  "definitions": {
+    "ApiVersionConfig": {
+      "type": "object",
+      "properties": {
+        "version": {
+          "type": "string",
+          "description": "API version (e.g., \"v2\", \"2023-10-01\")"
+        },
+        "isDefault": {
+          "type": "boolean",
+          "default": false,
+          "description": "Is this the default version"
+        },
+        "deprecationDate": {
+          "type": "string",
+          "description": "API version deprecation date (ISO 8601)"
+        },
+        "sunsetDate": {
+          "type": "string",
+          "description": "API version sunset date (ISO 8601)"
+        }
+      },
+      "required": [
+        "version"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/integration/Authentication.json

@@ -0,0 +1,269 @@
+{
+  "$ref": "#/definitions/Authentication",
+  "definitions": {
+    "Authentication": {
+      "anyOf": [
+        {
+          "type": "object",
+          "properties": {
+            "type": {
+              "type": "string",
+              "const": "oauth2",
+              "description": "Authentication type"
+            },
+            "authorizationUrl": {
+              "type": "string",
+              "format": "uri",
+              "description": "OAuth2 authorization endpoint"
+            },
+            "tokenUrl": {
+              "type": "string",
+              "format": "uri",
+              "description": "OAuth2 token endpoint"
+            },
+            "clientId": {
+              "type": "string",
+              "description": "OAuth2 client ID"
+            },
+            "clientSecret": {
+              "type": "string",
+              "description": "OAuth2 client secret (typically from ENV)"
+            },
+            "scopes": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              },
+              "description": "Requested OAuth2 scopes"
+            },
+            "redirectUri": {
+              "type": "string",
+              "format": "uri",
+              "description": "OAuth2 redirect URI"
+            },
+            "refreshToken": {
+              "type": "string",
+              "description": "Refresh token for token renewal"
+            },
+            "tokenExpiry": {
+              "type": "number",
+              "description": "Token expiry timestamp"
+            }
+          },
+          "required": [
+            "type",
+            "authorizationUrl",
+            "tokenUrl",
+            "clientId",
+            "clientSecret"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "type": {
+              "type": "string",
+              "const": "api-key",
+              "description": "Authentication type"
+            },
+            "key": {
+              "type": "string",
+              "description": "API key value"
+            },
+            "headerName": {
+              "type": "string",
+              "default": "X-API-Key",
+              "description": "HTTP header name for API key"
+            },
+            "paramName": {
+              "type": "string",
+              "description": "Query parameter name (alternative to header)"
+            }
+          },
+          "required": [
+            "type",
+            "key"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "type": {
+              "type": "string",
+              "const": "basic",
+              "description": "Authentication type"
+            },
+            "username": {
+              "type": "string",
+              "description": "Username"
+            },
+            "password": {
+              "type": "string",
+              "description": "Password (typically from ENV)"
+            }
+          },
+          "required": [
+            "type",
+            "username",
+            "password"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "type": {
+              "type": "string",
+              "const": "bearer",
+              "description": "Authentication type"
+            },
+            "token": {
+              "type": "string",
+              "description": "Bearer token"
+            }
+          },
+          "required": [
+            "type",
+            "token"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "type": {
+              "type": "string",
+              "const": "jwt",
+              "description": "Authentication type"
+            },
+            "token": {
+              "type": "string",
+              "description": "Pre-generated JWT token"
+            },
+            "secretKey": {
+              "type": "string",
+              "description": "Secret key for JWT signing"
+            },
+            "algorithm": {
+              "type": "string",
+              "enum": [
+                "HS256",
+                "HS384",
+                "HS512",
+                "RS256",
+                "RS384",
+                "RS512",
+                "ES256",
+                "ES384",
+                "ES512"
+              ],
+              "default": "HS256",
+              "description": "JWT signing algorithm"
+            },
+            "issuer": {
+              "type": "string",
+              "description": "JWT issuer claim"
+            },
+            "audience": {
+              "type": "string",
+              "description": "JWT audience claim"
+            },
+            "subject": {
+              "type": "string",
+              "description": "JWT subject claim"
+            },
+            "expiresIn": {
+              "type": "number",
+              "default": 3600,
+              "description": "Token expiry in seconds"
+            },
+            "claims": {
+              "type": "object",
+              "additionalProperties": {},
+              "description": "Additional JWT claims"
+            }
+          },
+          "required": [
+            "type"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "type": {
+              "type": "string",
+              "const": "saml",
+              "description": "Authentication type"
+            },
+            "entryPoint": {
+              "type": "string",
+              "format": "uri",
+              "description": "SAML IdP entry point URL"
+            },
+            "issuer": {
+              "type": "string",
+              "description": "SAML service provider issuer"
+            },
+            "certificate": {
+              "type": "string",
+              "description": "SAML IdP certificate (X.509)"
+            },
+            "privateKey": {
+              "type": "string",
+              "description": "SAML service provider private key"
+            },
+            "callbackUrl": {
+              "type": "string",
+              "format": "uri",
+              "description": "SAML assertion consumer service URL"
+            },
+            "signatureAlgorithm": {
+              "type": "string",
+              "enum": [
+                "sha1",
+                "sha256",
+                "sha512"
+              ],
+              "default": "sha256",
+              "description": "SAML signature algorithm"
+            },
+            "wantAssertionsSigned": {
+              "type": "boolean",
+              "default": true,
+              "description": "Require signed SAML assertions"
+            },
+            "identifierFormat": {
+              "type": "string",
+              "description": "SAML NameID format"
+            }
+          },
+          "required": [
+            "type",
+            "entryPoint",
+            "issuer",
+            "certificate"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "type": {
+              "type": "string",
+              "const": "none",
+              "description": "No authentication required"
+            }
+          },
+          "required": [
+            "type"
+          ],
+          "additionalProperties": false
+        }
+      ]
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/integration/CdcConfig.json

@@ -0,0 +1,55 @@
+{
+  "$ref": "#/definitions/CdcConfig",
+  "definitions": {
+    "CdcConfig": {
+      "type": "object",
+      "properties": {
+        "enabled": {
+          "type": "boolean",
+          "default": false,
+          "description": "Enable CDC"
+        },
+        "method": {
+          "type": "string",
+          "enum": [
+            "log_based",
+            "trigger_based",
+            "query_based",
+            "custom"
+          ],
+          "description": "CDC method"
+        },
+        "slotName": {
+          "type": "string",
+          "description": "Replication slot name (for log-based CDC)"
+        },
+        "publicationName": {
+          "type": "string",
+          "description": "Publication name (for PostgreSQL)"
+        },
+        "startPosition": {
+          "type": "string",
+          "description": "Starting position/LSN for CDC stream"
+        },
+        "batchSize": {
+          "type": "number",
+          "minimum": 1,
+          "maximum": 10000,
+          "default": 1000,
+          "description": "CDC batch size"
+        },
+        "pollIntervalMs": {
+          "type": "number",
+          "minimum": 100,
+          "default": 1000,
+          "description": "CDC polling interval in ms"
+        }
+      },
+      "required": [
+        "method"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/integration/ConflictResolution.json

@@ -0,0 +1,16 @@
+{
+  "$ref": "#/definitions/ConflictResolution",
+  "definitions": {
+    "ConflictResolution": {
+      "type": "string",
+      "enum": [
+        "source_wins",
+        "target_wins",
+        "latest_wins",
+        "manual"
+      ],
+      "description": "Conflict resolution strategy"
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}