@objectstack/spec 0.6.1 → 0.7.1

package/json-schema/integration/WebhookConfig.json

@@ -0,0 +1,201 @@
+{
+  "$ref": "#/definitions/WebhookConfig",
+  "definitions": {
+    "WebhookConfig": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string",
+          "minLength": 2,
+          "pattern": "^[a-z][a-z0-9_]*$",
+          "description": "Webhook unique name (lowercase snake_case)"
+        },
+        "label": {
+          "type": "string",
+          "description": "Human-readable webhook label"
+        },
+        "object": {
+          "type": "string",
+          "description": "Object to listen to (optional for manual webhooks)"
+        },
+        "triggers": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "enum": [
+              "create",
+              "update",
+              "delete",
+              "undelete",
+              "api"
+            ]
+          },
+          "description": "Events that trigger execution"
+        },
+        "url": {
+          "type": "string",
+          "format": "uri",
+          "description": "External webhook endpoint URL"
+        },
+        "method": {
+          "type": "string",
+          "enum": [
+            "GET",
+            "POST",
+            "PUT",
+            "PATCH",
+            "DELETE"
+          ],
+          "default": "POST",
+          "description": "HTTP method"
+        },
+        "headers": {
+          "type": "object",
+          "additionalProperties": {
+            "type": "string"
+          },
+          "description": "Custom HTTP headers"
+        },
+        "body": {
+          "description": "Request body payload (if not using default record data)"
+        },
+        "payloadFields": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "Fields to include. Empty = All"
+        },
+        "includeSession": {
+          "type": "boolean",
+          "default": false,
+          "description": "Include user session info"
+        },
+        "authentication": {
+          "type": "object",
+          "properties": {
+            "type": {
+              "type": "string",
+              "enum": [
+                "none",
+                "bearer",
+                "basic",
+                "api-key"
+              ],
+              "description": "Authentication type"
+            },
+            "credentials": {
+              "type": "object",
+              "additionalProperties": {
+                "type": "string"
+              },
+              "description": "Authentication credentials"
+            }
+          },
+          "required": [
+            "type"
+          ],
+          "additionalProperties": false,
+          "description": "Authentication configuration"
+        },
+        "retryPolicy": {
+          "type": "object",
+          "properties": {
+            "maxRetries": {
+              "type": "integer",
+              "minimum": 0,
+              "maximum": 10,
+              "default": 3,
+              "description": "Maximum retry attempts"
+            },
+            "backoffStrategy": {
+              "type": "string",
+              "enum": [
+                "exponential",
+                "linear",
+                "fixed"
+              ],
+              "default": "exponential",
+              "description": "Backoff strategy"
+            },
+            "initialDelayMs": {
+              "type": "integer",
+              "minimum": 100,
+              "default": 1000,
+              "description": "Initial retry delay in milliseconds"
+            },
+            "maxDelayMs": {
+              "type": "integer",
+              "minimum": 1000,
+              "default": 60000,
+              "description": "Maximum retry delay in milliseconds"
+            }
+          },
+          "additionalProperties": false,
+          "description": "Retry policy configuration"
+        },
+        "timeoutMs": {
+          "type": "integer",
+          "minimum": 1000,
+          "maximum": 300000,
+          "default": 30000,
+          "description": "Request timeout in milliseconds"
+        },
+        "secret": {
+          "type": "string",
+          "description": "Signing secret for HMAC signature verification"
+        },
+        "isActive": {
+          "type": "boolean",
+          "default": true,
+          "description": "Whether webhook is active"
+        },
+        "description": {
+          "type": "string",
+          "description": "Webhook description"
+        },
+        "tags": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "Tags for organization"
+        },
+        "events": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "enum": [
+              "record.created",
+              "record.updated",
+              "record.deleted",
+              "sync.started",
+              "sync.completed",
+              "sync.failed",
+              "auth.expired",
+              "rate_limit.exceeded"
+            ],
+            "description": "Webhook event type"
+          },
+          "description": "Connector events to subscribe to"
+        },
+        "signatureAlgorithm": {
+          "type": "string",
+          "enum": [
+            "hmac_sha256",
+            "hmac_sha512",
+            "none"
+          ],
+          "description": "Webhook signature algorithm",
+          "default": "hmac_sha256"
+        }
+      },
+      "required": [
+        "name",
+        "url"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/integration/WebhookEvent.json

@@ -0,0 +1,20 @@
+{
+  "$ref": "#/definitions/WebhookEvent",
+  "definitions": {
+    "WebhookEvent": {
+      "type": "string",
+      "enum": [
+        "record.created",
+        "record.updated",
+        "record.deleted",
+        "sync.started",
+        "sync.completed",
+        "sync.failed",
+        "auth.expired",
+        "rate_limit.exceeded"
+      ],
+      "description": "Webhook event type"
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/integration/WebhookSignatureAlgorithm.json

@@ -0,0 +1,15 @@
+{
+  "$ref": "#/definitions/WebhookSignatureAlgorithm",
+  "definitions": {
+    "WebhookSignatureAlgorithm": {
+      "type": "string",
+      "enum": [
+        "hmac_sha256",
+        "hmac_sha512",
+        "none"
+      ],
+      "description": "Webhook signature algorithm"
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/permission/PermissionSet.json

@@ -100,6 +100,86 @@
             "type": "string"
           },
           "description": "System level capabilities"
+        },
+        "rowLevelSecurity": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "name": {
+                "type": "string",
+                "pattern": "^[a-z_][a-z0-9_]*$",
+                "description": "Policy unique identifier (snake_case)"
+              },
+              "label": {
+                "type": "string",
+                "description": "Human-readable policy label"
+              },
+              "description": {
+                "type": "string",
+                "description": "Policy description and business justification"
+              },
+              "object": {
+                "type": "string",
+                "description": "Target object name"
+              },
+              "operation": {
+                "type": "string",
+                "enum": [
+                  "select",
+                  "insert",
+                  "update",
+                  "delete",
+                  "all"
+                ],
+                "description": "Database operation this policy applies to"
+              },
+              "using": {
+                "type": "string",
+                "description": "Filter condition for SELECT/UPDATE/DELETE (PostgreSQL SQL WHERE clause syntax with parameterized context variables). Optional for INSERT-only policies."
+              },
+              "check": {
+                "type": "string",
+                "description": "Validation condition for INSERT/UPDATE (defaults to USING clause if not specified - enforced at application level)"
+              },
+              "roles": {
+                "type": "array",
+                "items": {
+                  "type": "string"
+                },
+                "description": "Roles this policy applies to (omit for all roles)"
+              },
+              "enabled": {
+                "type": "boolean",
+                "default": true,
+                "description": "Whether this policy is active"
+              },
+              "priority": {
+                "type": "integer",
+                "default": 0,
+                "description": "Policy evaluation priority (higher = evaluated first)"
+              },
+              "tags": {
+                "type": "array",
+                "items": {
+                  "type": "string"
+                },
+                "description": "Policy categorization tags"
+              }
+            },
+            "required": [
+              "name",
+              "object",
+              "operation"
+            ],
+            "additionalProperties": false
+          },
+          "description": "Row-level security policies (see rls.zod.ts for full spec)"
+        },
+        "contextVariables": {
+          "type": "object",
+          "additionalProperties": {},
+          "description": "Context variables for RLS evaluation"
         }
       },
       "required": [

package/json-schema/shared/CorsConfig.json

@@ -0,0 +1,57 @@
+{
+  "$ref": "#/definitions/CorsConfig",
+  "definitions": {
+    "CorsConfig": {
+      "type": "object",
+      "properties": {
+        "enabled": {
+          "type": "boolean",
+          "default": true,
+          "description": "Enable CORS"
+        },
+        "origins": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            }
+          ],
+          "default": "*",
+          "description": "Allowed origins (* for all)"
+        },
+        "methods": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "enum": [
+              "GET",
+              "POST",
+              "PUT",
+              "DELETE",
+              "PATCH",
+              "HEAD",
+              "OPTIONS"
+            ]
+          },
+          "description": "Allowed HTTP methods"
+        },
+        "credentials": {
+          "type": "boolean",
+          "default": false,
+          "description": "Allow credentials (cookies, authorization headers)"
+        },
+        "maxAge": {
+          "type": "integer",
+          "description": "Preflight cache duration in seconds"
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/shared/FieldMapping.json

@@ -0,0 +1,142 @@
+{
+  "$ref": "#/definitions/FieldMapping",
+  "definitions": {
+    "FieldMapping": {
+      "type": "object",
+      "properties": {
+        "source": {
+          "type": "string",
+          "description": "Source field name"
+        },
+        "target": {
+          "type": "string",
+          "description": "Target field name"
+        },
+        "transform": {
+          "anyOf": [
+            {
+              "type": "object",
+              "properties": {
+                "type": {
+                  "type": "string",
+                  "const": "constant"
+                },
+                "value": {
+                  "description": "Constant value to use"
+                }
+              },
+              "required": [
+                "type"
+              ],
+              "additionalProperties": false,
+              "description": "Set a constant value"
+            },
+            {
+              "type": "object",
+              "properties": {
+                "type": {
+                  "type": "string",
+                  "const": "cast"
+                },
+                "targetType": {
+                  "type": "string",
+                  "enum": [
+                    "string",
+                    "number",
+                    "boolean",
+                    "date"
+                  ],
+                  "description": "Target data type"
+                }
+              },
+              "required": [
+                "type",
+                "targetType"
+              ],
+              "additionalProperties": false,
+              "description": "Cast to a specific data type"
+            },
+            {
+              "type": "object",
+              "properties": {
+                "type": {
+                  "type": "string",
+                  "const": "lookup"
+                },
+                "table": {
+                  "type": "string",
+                  "description": "Lookup table name"
+                },
+                "keyField": {
+                  "type": "string",
+                  "description": "Field to match on"
+                },
+                "valueField": {
+                  "type": "string",
+                  "description": "Field to retrieve"
+                }
+              },
+              "required": [
+                "type",
+                "table",
+                "keyField",
+                "valueField"
+              ],
+              "additionalProperties": false,
+              "description": "Lookup value from another table"
+            },
+            {
+              "type": "object",
+              "properties": {
+                "type": {
+                  "type": "string",
+                  "const": "javascript"
+                },
+                "expression": {
+                  "type": "string",
+                  "description": "JavaScript expression (e.g., \"value.toUpperCase()\")"
+                }
+              },
+              "required": [
+                "type",
+                "expression"
+              ],
+              "additionalProperties": false,
+              "description": "Custom JavaScript transformation"
+            },
+            {
+              "type": "object",
+              "properties": {
+                "type": {
+                  "type": "string",
+                  "const": "map"
+                },
+                "mappings": {
+                  "type": "object",
+                  "additionalProperties": {},
+                  "description": "Value mappings (e.g., {\"Active\": \"active\"})"
+                }
+              },
+              "required": [
+                "type",
+                "mappings"
+              ],
+              "additionalProperties": false,
+              "description": "Map values using a dictionary"
+            }
+          ],
+          "description": "Transformation to apply"
+        },
+        "defaultValue": {
+          "description": "Default if source is null/undefined"
+        }
+      },
+      "required": [
+        "source",
+        "target"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/shared/HttpMethod.json

@@ -0,0 +1,18 @@
+{
+  "$ref": "#/definitions/HttpMethod",
+  "definitions": {
+    "HttpMethod": {
+      "type": "string",
+      "enum": [
+        "GET",
+        "POST",
+        "PUT",
+        "DELETE",
+        "PATCH",
+        "HEAD",
+        "OPTIONS"
+      ]
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/shared/RateLimitConfig.json

@@ -0,0 +1,27 @@
+{
+  "$ref": "#/definitions/RateLimitConfig",
+  "definitions": {
+    "RateLimitConfig": {
+      "type": "object",
+      "properties": {
+        "enabled": {
+          "type": "boolean",
+          "default": false,
+          "description": "Enable rate limiting"
+        },
+        "windowMs": {
+          "type": "integer",
+          "default": 60000,
+          "description": "Time window in milliseconds"
+        },
+        "maxRequests": {
+          "type": "integer",
+          "default": 100,
+          "description": "Max requests per window"
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/shared/StaticMount.json

@@ -0,0 +1,28 @@
+{
+  "$ref": "#/definitions/StaticMount",
+  "definitions": {
+    "StaticMount": {
+      "type": "object",
+      "properties": {
+        "path": {
+          "type": "string",
+          "description": "URL path to serve from"
+        },
+        "directory": {
+          "type": "string",
+          "description": "Physical directory to serve"
+        },
+        "cacheControl": {
+          "type": "string",
+          "description": "Cache-Control header value"
+        }
+      },
+      "required": [
+        "path",
+        "directory"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}