openuispec 0.1.0

package/schema/flow.schema.json

@@ -0,0 +1,164 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://openuispec.org/schema/flow.schema.json",
+  "title": "OpenUISpec Flow",
+  "description": "Navigation flow \u2014 a single root key (flow name) mapping to the flow definition",
+  "type": "object",
+  "minProperties": 1,
+  "maxProperties": 1,
+  "additionalProperties": {
+    "$ref": "https://openuispec.org/schema/flow.schema.json#/$defs/flow_def"
+  },
+  "$defs": {
+    "flow_def": {
+      "type": "object",
+      "description": "A navigation flow definition",
+      "properties": {
+        "semantic": {
+          "type": "string"
+        },
+        "status": {
+          "type": "string",
+          "enum": [
+            "stub",
+            "draft",
+            "ready"
+          ]
+        },
+        "params": {
+          "$ref": "https://openuispec.org/schema/defs/data-binding.schema.json#/$defs/params_map"
+        },
+        "entry": {
+          "type": "string",
+          "description": "Entry screen step name"
+        },
+        "screens": {
+          "type": "object",
+          "description": "Map of step names to screen definitions",
+          "additionalProperties": {
+            "$ref": "https://openuispec.org/schema/flow.schema.json#/$defs/flow_screen"
+          }
+        },
+        "platform_hints": {
+          "type": "object",
+          "description": "Per-platform presentation hints",
+          "properties": {
+            "ios": {
+              "$ref": "https://openuispec.org/schema/flow.schema.json#/$defs/platform_hint"
+            },
+            "android": {
+              "$ref": "https://openuispec.org/schema/flow.schema.json#/$defs/platform_hint"
+            },
+            "web": {
+              "$ref": "https://openuispec.org/schema/flow.schema.json#/$defs/platform_hint"
+            }
+          },
+          "additionalProperties": false
+        }
+      },
+      "required": [
+        "semantic",
+        "entry",
+        "screens"
+      ],
+      "additionalProperties": false
+    },
+    "flow_screen": {
+      "type": "object",
+      "description": "A screen step within a flow \u2014 either references an external screen or defines one inline",
+      "properties": {
+        "screen": {
+          "type": "string",
+          "description": "Reference to an external screen file"
+        },
+        "screen_inline": {
+          "$ref": "https://openuispec.org/schema/flow.schema.json#/$defs/inline_screen_def"
+        },
+        "transitions": {
+          "type": "object",
+          "description": "Map of transition names to transition definitions",
+          "additionalProperties": {
+            "$ref": "https://openuispec.org/schema/flow.schema.json#/$defs/transition_def"
+          }
+        }
+      },
+      "additionalProperties": false
+    },
+    "inline_screen_def": {
+      "type": "object",
+      "description": "An inline screen definition within a flow (same shape as screen_def)",
+      "properties": {
+        "semantic": {
+          "type": "string"
+        },
+        "status": {
+          "type": "string"
+        },
+        "params": {
+          "$ref": "https://openuispec.org/schema/defs/data-binding.schema.json#/$defs/params_map"
+        },
+        "data": {
+          "$ref": "https://openuispec.org/schema/defs/data-binding.schema.json#/$defs/data_map"
+        },
+        "state": {
+          "$ref": "https://openuispec.org/schema/defs/data-binding.schema.json#/$defs/state_map"
+        },
+        "layout": {
+          "$ref": "https://openuispec.org/schema/screen.schema.json#/$defs/layout_def"
+        },
+        "surfaces": {
+          "type": "object",
+          "additionalProperties": {
+            "$ref": "https://openuispec.org/schema/screen.schema.json#/$defs/surface_def"
+          }
+        }
+      },
+      "required": [
+        "semantic",
+        "layout"
+      ],
+      "additionalProperties": false
+    },
+    "transition_def": {
+      "type": "object",
+      "properties": {
+        "to": {
+          "type": "string",
+          "description": "Target step name"
+        },
+        "animation": {
+          "type": "string"
+        },
+        "feedback": {
+          "type": "object",
+          "additionalProperties": true
+        }
+      },
+      "required": [
+        "to"
+      ],
+      "additionalProperties": false
+    },
+    "platform_hint": {
+      "type": "object",
+      "properties": {
+        "presentation": {
+          "type": "string"
+        },
+        "detents": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "fullscreen": {
+          "type": "boolean"
+        },
+        "size": {
+          "type": "string"
+        }
+      },
+      "additionalProperties": true
+    }
+  }
+}

package/schema/locale.schema.json

@@ -0,0 +1,26 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://openuispec.org/schema/locale.schema.json",
+  "title": "OpenUISpec Locale",
+  "description": "Locale file with $locale, $direction, and translation key-value pairs (ICU MessageFormat)",
+  "type": "object",
+  "required": ["$locale", "$direction"],
+  "properties": {
+    "$locale": {
+      "type": "string",
+      "description": "Locale identifier (e.g. 'en', 'fr', 'ar')"
+    },
+    "$direction": {
+      "type": "string",
+      "enum": ["ltr", "rtl"],
+      "description": "Text direction"
+    }
+  },
+  "patternProperties": {
+    "^[a-zA-Z_][a-zA-Z0-9_.]*$": {
+      "type": "string",
+      "description": "Translation string (ICU MessageFormat)"
+    }
+  },
+  "additionalProperties": false
+}

package/schema/openuispec.schema.json

@@ -0,0 +1,287 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://openuispec.org/schema/openuispec.schema.json",
+  "title": "OpenUISpec Root Manifest",
+  "description": "Root manifest file (openuispec.yaml) defining project, includes, generation, data model, and API",
+  "type": "object",
+  "required": [
+    "spec_version",
+    "project",
+    "includes"
+  ],
+  "additionalProperties": false,
+  "properties": {
+    "spec_version": {
+      "type": "string",
+      "description": "OpenUISpec version (e.g. '0.1')"
+    },
+    "project": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string"
+        },
+        "description": {
+          "type": "string"
+        },
+        "icon": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "name"
+      ],
+      "additionalProperties": false
+    },
+    "includes": {
+      "type": "object",
+      "description": "Paths to spec component directories",
+      "properties": {
+        "tokens": {
+          "type": "string"
+        },
+        "contracts": {
+          "type": "string"
+        },
+        "screens": {
+          "type": "string"
+        },
+        "flows": {
+          "type": "string"
+        },
+        "platform": {
+          "type": "string"
+        },
+        "locales": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "tokens",
+        "contracts",
+        "screens",
+        "flows",
+        "platform",
+        "locales"
+      ],
+      "additionalProperties": false
+    },
+    "i18n": {
+      "type": "object",
+      "description": "Internationalization configuration",
+      "properties": {
+        "default_locale": {
+          "type": "string"
+        },
+        "supported_locales": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "fallback_strategy": {
+          "type": "string",
+          "enum": [
+            "default",
+            "key",
+            "empty"
+          ]
+        }
+      },
+      "required": [
+        "default_locale",
+        "supported_locales"
+      ],
+      "additionalProperties": false
+    },
+    "generation": {
+      "type": "object",
+      "description": "Code generation targets and output format",
+      "properties": {
+        "targets": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "output_format": {
+          "type": "object",
+          "description": "Per-target generation config",
+          "additionalProperties": {
+            "type": "object",
+            "properties": {
+              "language": {
+                "type": "string"
+              },
+              "framework": {
+                "type": "string"
+              },
+              "min_version": {
+                "type": "string"
+              },
+              "min_sdk": {
+                "type": "integer"
+              },
+              "bundler": {
+                "type": "string"
+              }
+            },
+            "additionalProperties": true
+          }
+        }
+      },
+      "required": [
+        "targets"
+      ],
+      "additionalProperties": false
+    },
+    "formatters": {
+      "type": "object",
+      "description": "Custom formatter definitions for format expressions",
+      "additionalProperties": {
+        "$ref": "https://openuispec.org/schema/openuispec.schema.json#/$defs/formatter_def"
+      }
+    },
+    "mappers": {
+      "type": "object",
+      "description": "Key-value mapping definitions",
+      "additionalProperties": {
+        "type": "object",
+        "additionalProperties": {
+          "type": "string"
+        }
+      }
+    },
+    "data_model": {
+      "type": "object",
+      "description": "Application data model definitions",
+      "additionalProperties": {
+        "$ref": "https://openuispec.org/schema/openuispec.schema.json#/$defs/model_def"
+      }
+    },
+    "custom_contracts": {
+      "type": "array",
+      "description": "Paths to custom contract definition files (x_ prefixed)",
+      "items": {
+        "type": "string"
+      }
+    },
+    "api": {
+      "type": "object",
+      "description": "API endpoint definitions",
+      "properties": {
+        "base_url": {
+          "type": "string"
+        },
+        "auth": {
+          "type": "string"
+        },
+        "endpoints": {
+          "type": "object",
+          "description": "Grouped API endpoints",
+          "additionalProperties": {
+            "type": "object",
+            "additionalProperties": {
+              "$ref": "https://openuispec.org/schema/openuispec.schema.json#/$defs/endpoint_def"
+            }
+          }
+        }
+      },
+      "required": [
+        "base_url",
+        "endpoints"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$defs": {
+    "formatter_def": {
+      "type": "object",
+      "properties": {
+        "input": {
+          "type": "string"
+        },
+        "output": {
+          "type": "string"
+        },
+        "mapping": {
+          "type": "object",
+          "additionalProperties": {
+            "type": "string"
+          }
+        }
+      },
+      "required": [
+        "input",
+        "output",
+        "mapping"
+      ],
+      "additionalProperties": false
+    },
+    "model_def": {
+      "type": "object",
+      "description": "Data model \u2014 map of field names to field definitions",
+      "additionalProperties": {
+        "$ref": "https://openuispec.org/schema/openuispec.schema.json#/$defs/field_def"
+      }
+    },
+    "field_def": {
+      "type": "object",
+      "properties": {
+        "type": {
+          "type": "string"
+        },
+        "format": {
+          "type": "string"
+        },
+        "required": {
+          "type": "boolean"
+        },
+        "max_length": {
+          "type": "integer"
+        },
+        "default": {},
+        "values": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        }
+      },
+      "required": [
+        "type"
+      ],
+      "additionalProperties": false
+    },
+    "endpoint_def": {
+      "type": "object",
+      "properties": {
+        "method": {
+          "type": "string",
+          "enum": [
+            "GET",
+            "POST",
+            "PUT",
+            "PATCH",
+            "DELETE"
+          ]
+        },
+        "path": {
+          "type": "string"
+        },
+        "params": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "body": {}
+      },
+      "required": [
+        "method",
+        "path"
+      ],
+      "additionalProperties": false
+    }
+  }
+}

package/schema/platform.schema.json

@@ -0,0 +1,95 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://openuispec.org/schema/platform.schema.json",
+  "title": "OpenUISpec Platform Adaptation",
+  "description": "Platform-specific overrides, behaviors, and generation config. Root key is the platform name.",
+  "type": "object",
+  "minProperties": 1,
+  "maxProperties": 1,
+  "additionalProperties": {
+    "$ref": "https://openuispec.org/schema/platform.schema.json#/$defs/platform_def"
+  },
+  "$defs": {
+    "platform_def": {
+      "type": "object",
+      "description": "Platform adaptation definition",
+      "properties": {
+        "framework": {
+          "type": "string",
+          "description": "UI framework (swiftui, compose, react)"
+        },
+        "language": {
+          "type": "string",
+          "description": "Programming language"
+        },
+        "min_version": {
+          "type": "string",
+          "description": "Minimum framework/OS version (iOS)"
+        },
+        "min_sdk": {
+          "type": "integer",
+          "description": "Minimum SDK version (Android)"
+        },
+        "target_sdk": {
+          "type": "integer",
+          "description": "Target SDK version (Android)"
+        },
+        "overrides": {
+          "type": "object",
+          "description": "Per-contract-family overrides",
+          "additionalProperties": {
+            "type": "object",
+            "description": "Variant-level overrides for a contract family",
+            "additionalProperties": true
+          }
+        },
+        "behaviors": {
+          "type": "object",
+          "description": "Platform-specific behaviors and capabilities",
+          "additionalProperties": true
+        },
+        "generation": {
+          "type": "object",
+          "description": "Code generation configuration",
+          "properties": {
+            "imports": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            },
+            "dependencies": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            },
+            "architecture": {
+              "type": "string"
+            },
+            "naming": {
+              "type": "string"
+            },
+            "bundler": {
+              "type": "string"
+            },
+            "css": {
+              "type": "string"
+            },
+            "routing": {
+              "type": "string"
+            },
+            "state": {
+              "type": "string"
+            }
+          },
+          "additionalProperties": true
+        }
+      },
+      "required": [
+        "framework"
+      ],
+      "additionalProperties": false
+    }
+  }
+}