@vadimcomanescu/nadicode-design-system 2.0.7 → 2.0.8

package/contracts/public-surface-registry.schema.json

@@ -0,0 +1,227 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://vadimcomanescu.dev/schemas/public-surface-registry.schema.json",
+  "title": "Seed Public Surface Registry",
+  "description": "Single source of truth for the package public API contract.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "schemaVersion",
+    "entries"
+  ],
+  "properties": {
+    "schemaVersion": {
+      "type": "string",
+      "pattern": "^\\d+\\.\\d+\\.\\d+$",
+      "description": "Semantic version for this registry schema payload."
+    },
+    "entries": {
+      "type": "array",
+      "minItems": 1,
+      "items": {
+        "$ref": "#/$defs/entry"
+      }
+    }
+  },
+  "$defs": {
+    "entry": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "subpath",
+        "canonicalExport",
+        "sourceFile",
+        "sourceSymbol",
+        "category",
+        "tier",
+        "stability",
+        "propsSchemaRef",
+        "description"
+      ],
+      "properties": {
+        "subpath": {
+          "type": "string",
+          "minLength": 1,
+          "description": "Package export subpath. Use \".\" for the root export."
+        },
+        "canonicalExport": {
+          "type": "string",
+          "minLength": 1,
+          "description": "Canonical symbol consumers import from the subpath."
+        },
+        "sourceFile": {
+          "type": "string",
+          "minLength": 1,
+          "description": "Repository-relative source file path for the canonical symbol."
+        },
+        "sourceSymbol": {
+          "type": "string",
+          "minLength": 1,
+          "description": "Exported symbol name in the source file."
+        },
+        "category": {
+          "type": "string",
+          "enum": [
+            "blocks",
+            "components",
+            "helpers",
+            "tokens",
+            "page-kits"
+          ]
+        },
+        "tier": {
+          "type": "string",
+          "enum": [
+            "stable",
+            "demo-only",
+            "internal"
+          ]
+        },
+        "stability": {
+          "type": "string",
+          "enum": [
+            "stable",
+            "experimental",
+            "deprecated"
+          ]
+        },
+        "propsSchemaRef": {
+          "type": [
+            "string",
+            "null"
+          ],
+          "description": "Path to props schema file or null for non-prop exports."
+        },
+        "description": {
+          "type": "string",
+          "minLength": 1
+        },
+        "pageKitContract": {
+          "$ref": "#/$defs/pageKitContract"
+        },
+        "deprecation": {
+          "$ref": "#/$defs/deprecation"
+        },
+        "examples": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "minLength": 1
+          }
+        }
+      }
+    },
+    "deprecation": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "since",
+        "removalVersion",
+        "replacement"
+      ],
+      "properties": {
+        "since": {
+          "type": "string",
+          "pattern": "^\\d+\\.\\d+\\.\\d+$",
+          "description": "Package version that first marked this export as deprecated."
+        },
+        "removalVersion": {
+          "type": "string",
+          "pattern": "^\\d+\\.\\d+\\.\\d+$",
+          "description": "Package version at which this export will be removed."
+        },
+        "replacement": {
+          "type": ["string", "null"],
+          "description": "Subpath of the replacement export, or null if no direct replacement exists."
+        }
+      }
+    },
+    "pageKitContract": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "supportedStates",
+        "shellAssumptions",
+        "shellDependencies",
+        "composedStableSubpaths",
+        "ownershipBoundaries"
+      ],
+      "properties": {
+        "supportedStates": {
+          "type": "array",
+          "minItems": 1,
+          "items": {
+            "type": "string",
+            "minLength": 1
+          }
+        },
+        "shellAssumptions": {
+          "type": "array",
+          "minItems": 1,
+          "items": {
+            "type": "string",
+            "minLength": 1
+          }
+        },
+        "shellDependencies": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "pattern": "^\\./"
+          }
+        },
+        "composedStableSubpaths": {
+          "type": "array",
+          "minItems": 1,
+          "items": {
+            "type": "string",
+            "pattern": "^\\./"
+          }
+        },
+        "forbiddenComponents": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "pattern": "^\\./"
+          },
+          "description": "Subpaths that must NEVER be imported alongside this page-kit. Prevents cross-domain contamination."
+        },
+        "ownershipBoundaries": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "seedOwned",
+            "consumerOwned",
+            "forbiddenRuntimeConcerns"
+          ],
+          "properties": {
+            "seedOwned": {
+              "type": "array",
+              "minItems": 1,
+              "items": {
+                "type": "string",
+                "minLength": 1
+              }
+            },
+            "consumerOwned": {
+              "type": "array",
+              "minItems": 1,
+              "items": {
+                "type": "string",
+                "minLength": 1
+              }
+            },
+            "forbiddenRuntimeConcerns": {
+              "type": "array",
+              "minItems": 1,
+              "items": {
+                "type": "string",
+                "minLength": 1
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+}