@objectstack/spec 0.1.0 → 0.1.2

package/json-schema/AuthProtocol.json

@@ -0,0 +1,17 @@
+{
+  "$ref": "#/definitions/AuthProtocol",
+  "definitions": {
+    "AuthProtocol": {
+      "type": "string",
+      "enum": [
+        "oidc",
+        "saml",
+        "ldap",
+        "oauth2",
+        "local",
+        "mock"
+      ]
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/AuthProvider.json

@@ -0,0 +1,171 @@
+{
+  "$ref": "#/definitions/AuthProvider",
+  "definitions": {
+    "AuthProvider": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string",
+          "pattern": "^[a-z_][a-z0-9_]*$",
+          "description": "Provider ID"
+        },
+        "label": {
+          "type": "string",
+          "description": "Button Label (e.g. \"Login with Okta\")"
+        },
+        "type": {
+          "type": "string",
+          "enum": [
+            "oidc",
+            "saml",
+            "ldap",
+            "oauth2",
+            "local",
+            "mock"
+          ]
+        },
+        "config": {
+          "anyOf": [
+            {
+              "type": "object",
+              "properties": {
+                "issuer": {
+                  "type": "string",
+                  "format": "uri",
+                  "description": "OIDC Issuer URL (.well-known/openid-configuration)"
+                },
+                "clientId": {
+                  "type": "string"
+                },
+                "clientSecret": {
+                  "type": "string"
+                },
+                "scopes": {
+                  "type": "array",
+                  "items": {
+                    "type": "string"
+                  },
+                  "default": [
+                    "openid",
+                    "profile",
+                    "email"
+                  ]
+                },
+                "attributeMapping": {
+                  "type": "object",
+                  "additionalProperties": {
+                    "type": "string"
+                  },
+                  "description": "Map IdP claims to User fields"
+                }
+              },
+              "required": [
+                "issuer",
+                "clientId",
+                "clientSecret"
+              ],
+              "additionalProperties": false
+            },
+            {
+              "type": "object",
+              "properties": {
+                "entryPoint": {
+                  "type": "string",
+                  "format": "uri",
+                  "description": "IdP SSO URL"
+                },
+                "cert": {
+                  "type": "string",
+                  "description": "IdP Public Certificate"
+                },
+                "issuer": {
+                  "type": "string",
+                  "description": "Entity ID of the IdP"
+                },
+                "signatureAlgorithm": {
+                  "type": "string",
+                  "enum": [
+                    "sha256",
+                    "sha512"
+                  ],
+                  "default": "sha256"
+                },
+                "attributeMapping": {
+                  "type": "object",
+                  "additionalProperties": {
+                    "type": "string"
+                  }
+                }
+              },
+              "required": [
+                "entryPoint",
+                "cert",
+                "issuer"
+              ],
+              "additionalProperties": false
+            },
+            {
+              "type": "object",
+              "properties": {
+                "url": {
+                  "type": "string",
+                  "format": "uri",
+                  "description": "LDAP Server URL (ldap:// or ldaps://)"
+                },
+                "bindDn": {
+                  "type": "string"
+                },
+                "bindCredentials": {
+                  "type": "string"
+                },
+                "searchBase": {
+                  "type": "string"
+                },
+                "searchFilter": {
+                  "type": "string"
+                },
+                "groupSearchBase": {
+                  "type": "string"
+                }
+              },
+              "required": [
+                "url",
+                "bindDn",
+                "bindCredentials",
+                "searchBase",
+                "searchFilter"
+              ],
+              "additionalProperties": false
+            },
+            {
+              "type": "object",
+              "additionalProperties": {}
+            }
+          ],
+          "description": "Provider specific configuration"
+        },
+        "icon": {
+          "type": "string",
+          "description": "Icon URL or helper class"
+        },
+        "active": {
+          "type": "boolean",
+          "default": true
+        },
+        "registrationEnabled": {
+          "type": "boolean",
+          "default": false,
+          "description": "Allow new users to sign up via this provider"
+        }
+      },
+      "required": [
+        "name",
+        "label",
+        "type",
+        "config"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/BaseResponse.json

@@ -0,0 +1,63 @@
+{
+  "$ref": "#/definitions/BaseResponse",
+  "definitions": {
+    "BaseResponse": {
+      "type": "object",
+      "properties": {
+        "success": {
+          "type": "boolean",
+          "description": "Operation success status"
+        },
+        "error": {
+          "type": "object",
+          "properties": {
+            "code": {
+              "type": "string",
+              "description": "Error code (e.g. validation_error)"
+            },
+            "message": {
+              "type": "string",
+              "description": "Readable error message"
+            },
+            "details": {
+              "description": "Additional error context (e.g. field validation errors)"
+            }
+          },
+          "required": [
+            "code",
+            "message"
+          ],
+          "additionalProperties": false,
+          "description": "Error details if success is false"
+        },
+        "meta": {
+          "type": "object",
+          "properties": {
+            "timestamp": {
+              "type": "string"
+            },
+            "duration": {
+              "type": "number"
+            },
+            "requestId": {
+              "type": "string"
+            },
+            "traceId": {
+              "type": "string"
+            }
+          },
+          "required": [
+            "timestamp"
+          ],
+          "additionalProperties": false,
+          "description": "Response metadata"
+        }
+      },
+      "required": [
+        "success"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/BorderRadius.json

@@ -0,0 +1,44 @@
+{
+  "$ref": "#/definitions/BorderRadius",
+  "definitions": {
+    "BorderRadius": {
+      "type": "object",
+      "properties": {
+        "none": {
+          "type": "string",
+          "description": "No border radius (0)"
+        },
+        "sm": {
+          "type": "string",
+          "description": "Small border radius (e.g., 0.125rem)"
+        },
+        "base": {
+          "type": "string",
+          "description": "Base border radius (e.g., 0.25rem)"
+        },
+        "md": {
+          "type": "string",
+          "description": "Medium border radius (e.g., 0.375rem)"
+        },
+        "lg": {
+          "type": "string",
+          "description": "Large border radius (e.g., 0.5rem)"
+        },
+        "xl": {
+          "type": "string",
+          "description": "Extra large border radius (e.g., 0.75rem)"
+        },
+        "2xl": {
+          "type": "string",
+          "description": "2X large border radius (e.g., 1rem)"
+        },
+        "full": {
+          "type": "string",
+          "description": "Full border radius (50%)"
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/Breakpoints.json

@@ -0,0 +1,36 @@
+{
+  "$ref": "#/definitions/Breakpoints",
+  "definitions": {
+    "Breakpoints": {
+      "type": "object",
+      "properties": {
+        "xs": {
+          "type": "string",
+          "description": "Extra small breakpoint (e.g., 480px)"
+        },
+        "sm": {
+          "type": "string",
+          "description": "Small breakpoint (e.g., 640px)"
+        },
+        "md": {
+          "type": "string",
+          "description": "Medium breakpoint (e.g., 768px)"
+        },
+        "lg": {
+          "type": "string",
+          "description": "Large breakpoint (e.g., 1024px)"
+        },
+        "xl": {
+          "type": "string",
+          "description": "Extra large breakpoint (e.g., 1280px)"
+        },
+        "2xl": {
+          "type": "string",
+          "description": "2X large breakpoint (e.g., 1536px)"
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/BulkRequest.json

@@ -0,0 +1,29 @@
+{
+  "$ref": "#/definitions/BulkRequest",
+  "definitions": {
+    "BulkRequest": {
+      "type": "object",
+      "properties": {
+        "records": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "additionalProperties": {},
+            "description": "Key-value map of record data"
+          },
+          "description": "Array of records to process"
+        },
+        "allOrNone": {
+          "type": "boolean",
+          "default": true,
+          "description": "If true, rollback entire transaction on any failure"
+        }
+      },
+      "required": [
+        "records"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/BulkResponse.json

@@ -0,0 +1,108 @@
+{
+  "$ref": "#/definitions/BulkResponse",
+  "definitions": {
+    "BulkResponse": {
+      "type": "object",
+      "properties": {
+        "success": {
+          "type": "boolean",
+          "description": "Operation success status"
+        },
+        "error": {
+          "type": "object",
+          "properties": {
+            "code": {
+              "type": "string",
+              "description": "Error code (e.g. validation_error)"
+            },
+            "message": {
+              "type": "string",
+              "description": "Readable error message"
+            },
+            "details": {
+              "description": "Additional error context (e.g. field validation errors)"
+            }
+          },
+          "required": [
+            "code",
+            "message"
+          ],
+          "additionalProperties": false,
+          "description": "Error details if success is false"
+        },
+        "meta": {
+          "type": "object",
+          "properties": {
+            "timestamp": {
+              "type": "string"
+            },
+            "duration": {
+              "type": "number"
+            },
+            "requestId": {
+              "type": "string"
+            },
+            "traceId": {
+              "type": "string"
+            }
+          },
+          "required": [
+            "timestamp"
+          ],
+          "additionalProperties": false,
+          "description": "Response metadata"
+        },
+        "data": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "id": {
+                "type": "string",
+                "description": "Record ID if processed"
+              },
+              "success": {
+                "type": "boolean"
+              },
+              "errors": {
+                "type": "array",
+                "items": {
+                  "type": "object",
+                  "properties": {
+                    "code": {
+                      "type": "string",
+                      "description": "Error code (e.g. validation_error)"
+                    },
+                    "message": {
+                      "type": "string",
+                      "description": "Readable error message"
+                    },
+                    "details": {
+                      "description": "Additional error context (e.g. field validation errors)"
+                    }
+                  },
+                  "required": [
+                    "code",
+                    "message"
+                  ],
+                  "additionalProperties": false
+                }
+              }
+            },
+            "required": [
+              "success"
+            ],
+            "additionalProperties": false
+          },
+          "description": "Results for each item in the batch"
+        }
+      },
+      "required": [
+        "success",
+        "data"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/CalendarConfig.json

@@ -0,0 +1,28 @@
+{
+  "$ref": "#/definitions/CalendarConfig",
+  "definitions": {
+    "CalendarConfig": {
+      "type": "object",
+      "properties": {
+        "startDateField": {
+          "type": "string"
+        },
+        "endDateField": {
+          "type": "string"
+        },
+        "titleField": {
+          "type": "string"
+        },
+        "colorField": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "startDateField",
+        "titleField"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/ChartType.json

@@ -0,0 +1,19 @@
+{
+  "$ref": "#/definitions/ChartType",
+  "definitions": {
+    "ChartType": {
+      "type": "string",
+      "enum": [
+        "metric",
+        "bar",
+        "line",
+        "pie",
+        "donut",
+        "funnel",
+        "table",
+        "text"
+      ]
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/ColorPalette.json

@@ -0,0 +1,83 @@
+{
+  "$ref": "#/definitions/ColorPalette",
+  "definitions": {
+    "ColorPalette": {
+      "type": "object",
+      "properties": {
+        "primary": {
+          "type": "string",
+          "description": "Primary brand color (hex, rgb, or hsl)"
+        },
+        "secondary": {
+          "type": "string",
+          "description": "Secondary brand color"
+        },
+        "accent": {
+          "type": "string",
+          "description": "Accent color for highlights"
+        },
+        "success": {
+          "type": "string",
+          "description": "Success state color (default: green)"
+        },
+        "warning": {
+          "type": "string",
+          "description": "Warning state color (default: yellow)"
+        },
+        "error": {
+          "type": "string",
+          "description": "Error state color (default: red)"
+        },
+        "info": {
+          "type": "string",
+          "description": "Info state color (default: blue)"
+        },
+        "background": {
+          "type": "string",
+          "description": "Background color"
+        },
+        "surface": {
+          "type": "string",
+          "description": "Surface/card background color"
+        },
+        "text": {
+          "type": "string",
+          "description": "Primary text color"
+        },
+        "textSecondary": {
+          "type": "string",
+          "description": "Secondary text color"
+        },
+        "border": {
+          "type": "string",
+          "description": "Border color"
+        },
+        "disabled": {
+          "type": "string",
+          "description": "Disabled state color"
+        },
+        "primaryLight": {
+          "type": "string",
+          "description": "Lighter shade of primary"
+        },
+        "primaryDark": {
+          "type": "string",
+          "description": "Darker shade of primary"
+        },
+        "secondaryLight": {
+          "type": "string",
+          "description": "Lighter shade of secondary"
+        },
+        "secondaryDark": {
+          "type": "string",
+          "description": "Darker shade of secondary"
+        }
+      },
+      "required": [
+        "primary"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}