@objectstack/spec 2.0.5 → 2.0.7

package/json-schema/ui/KeyboardNavigationConfig.json

@@ -0,0 +1,194 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "shortcuts": {
+      "description": "Registered keyboard shortcuts",
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "key": {
+            "type": "string",
+            "description": "Key combination (e.g., \"Ctrl+S\", \"Alt+N\", \"Escape\")"
+          },
+          "action": {
+            "type": "string",
+            "description": "Action identifier to invoke when shortcut is triggered"
+          },
+          "description": {
+            "description": "Human-readable description of what the shortcut does",
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "object",
+                "properties": {
+                  "key": {
+                    "type": "string",
+                    "description": "Translation key (e.g., \"views.task_list.label\")"
+                  },
+                  "defaultValue": {
+                    "description": "Fallback value when translation key is not found",
+                    "type": "string"
+                  },
+                  "params": {
+                    "description": "Interpolation parameters (e.g., { count: 5 })",
+                    "type": "object",
+                    "propertyNames": {
+                      "type": "string"
+                    },
+                    "additionalProperties": {}
+                  }
+                },
+                "required": [
+                  "key"
+                ],
+                "additionalProperties": false
+              }
+            ]
+          },
+          "scope": {
+            "default": "global",
+            "description": "Scope in which this shortcut is active",
+            "type": "string",
+            "enum": [
+              "global",
+              "view",
+              "form",
+              "modal",
+              "list"
+            ]
+          }
+        },
+        "required": [
+          "key",
+          "action",
+          "scope"
+        ],
+        "additionalProperties": false,
+        "description": "Keyboard shortcut binding"
+      }
+    },
+    "focusManagement": {
+      "description": "Focus and tab order management",
+      "type": "object",
+      "properties": {
+        "tabOrder": {
+          "default": "auto",
+          "description": "Tab order strategy: auto (DOM order) or manual (explicit tabIndex)",
+          "type": "string",
+          "enum": [
+            "auto",
+            "manual"
+          ]
+        },
+        "skipLinks": {
+          "default": false,
+          "description": "Provide skip-to-content navigation links",
+          "type": "boolean"
+        },
+        "focusVisible": {
+          "default": true,
+          "description": "Show visible focus indicators for keyboard users",
+          "type": "boolean"
+        },
+        "focusTrap": {
+          "description": "Focus trap settings",
+          "type": "object",
+          "properties": {
+            "enabled": {
+              "default": false,
+              "description": "Enable focus trapping within this container",
+              "type": "boolean"
+            },
+            "initialFocus": {
+              "description": "CSS selector for the element to focus on activation",
+              "type": "string"
+            },
+            "returnFocus": {
+              "default": true,
+              "description": "Return focus to trigger element on deactivation",
+              "type": "boolean"
+            },
+            "escapeDeactivates": {
+              "default": true,
+              "description": "Allow Escape key to deactivate the focus trap",
+              "type": "boolean"
+            }
+          },
+          "required": [
+            "enabled",
+            "returnFocus",
+            "escapeDeactivates"
+          ],
+          "additionalProperties": false
+        },
+        "arrowNavigation": {
+          "default": false,
+          "description": "Enable arrow key navigation between focusable items",
+          "type": "boolean"
+        }
+      },
+      "required": [
+        "tabOrder",
+        "skipLinks",
+        "focusVisible",
+        "arrowNavigation"
+      ],
+      "additionalProperties": false
+    },
+    "rovingTabindex": {
+      "default": false,
+      "description": "Enable roving tabindex pattern for composite widgets",
+      "type": "boolean"
+    },
+    "ariaLabel": {
+      "description": "Accessible label for screen readers (WAI-ARIA aria-label)",
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "object",
+          "properties": {
+            "key": {
+              "type": "string",
+              "description": "Translation key (e.g., \"views.task_list.label\")"
+            },
+            "defaultValue": {
+              "description": "Fallback value when translation key is not found",
+              "type": "string"
+            },
+            "params": {
+              "description": "Interpolation parameters (e.g., { count: 5 })",
+              "type": "object",
+              "propertyNames": {
+                "type": "string"
+              },
+              "additionalProperties": {}
+            }
+          },
+          "required": [
+            "key"
+          ],
+          "additionalProperties": false
+        }
+      ]
+    },
+    "ariaDescribedBy": {
+      "description": "ID of element providing additional description (WAI-ARIA aria-describedby)",
+      "type": "string"
+    },
+    "role": {
+      "description": "WAI-ARIA role attribute (e.g., \"dialog\", \"navigation\", \"alert\")",
+      "type": "string"
+    }
+  },
+  "required": [
+    "rovingTabindex"
+  ],
+  "additionalProperties": false,
+  "description": "Keyboard navigation and shortcut configuration"
+}

package/json-schema/ui/KeyboardShortcut.json

@@ -0,0 +1,66 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "key": {
+      "type": "string",
+      "description": "Key combination (e.g., \"Ctrl+S\", \"Alt+N\", \"Escape\")"
+    },
+    "action": {
+      "type": "string",
+      "description": "Action identifier to invoke when shortcut is triggered"
+    },
+    "description": {
+      "description": "Human-readable description of what the shortcut does",
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "object",
+          "properties": {
+            "key": {
+              "type": "string",
+              "description": "Translation key (e.g., \"views.task_list.label\")"
+            },
+            "defaultValue": {
+              "description": "Fallback value when translation key is not found",
+              "type": "string"
+            },
+            "params": {
+              "description": "Interpolation parameters (e.g., { count: 5 })",
+              "type": "object",
+              "propertyNames": {
+                "type": "string"
+              },
+              "additionalProperties": {}
+            }
+          },
+          "required": [
+            "key"
+          ],
+          "additionalProperties": false
+        }
+      ]
+    },
+    "scope": {
+      "default": "global",
+      "description": "Scope in which this shortcut is active",
+      "type": "string",
+      "enum": [
+        "global",
+        "view",
+        "form",
+        "modal",
+        "list"
+      ]
+    }
+  },
+  "required": [
+    "key",
+    "action",
+    "scope"
+  ],
+  "additionalProperties": false,
+  "description": "Keyboard shortcut binding"
+}

package/json-schema/ui/ListColumn.json

@@ -8,7 +8,36 @@
     },
     "label": {
       "description": "Display label override",
-      "type": "string"
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "object",
+          "properties": {
+            "key": {
+              "type": "string",
+              "description": "Translation key (e.g., \"views.task_list.label\")"
+            },
+            "defaultValue": {
+              "description": "Fallback value when translation key is not found",
+              "type": "string"
+            },
+            "params": {
+              "description": "Interpolation parameters (e.g., { count: 5 })",
+              "type": "object",
+              "propertyNames": {
+                "type": "string"
+              },
+              "additionalProperties": {}
+            }
+          },
+          "required": [
+            "key"
+          ],
+          "additionalProperties": false
+        }
+      ]
     },
     "width": {
       "description": "Column width in pixels",
@@ -44,6 +73,31 @@
       "description": "Renderer type override (e.g., \"currency\", \"date\")",
       "type": "string"
     },
+    "pinned": {
+      "description": "Pin/freeze column to left or right side",
+      "type": "string",
+      "enum": [
+        "left",
+        "right"
+      ]
+    },
+    "summary": {
+      "description": "Footer aggregation function for this column",
+      "type": "string",
+      "enum": [
+        "none",
+        "count",
+        "count_empty",
+        "count_filled",
+        "count_unique",
+        "percent_empty",
+        "percent_filled",
+        "sum",
+        "avg",
+        "min",
+        "max"
+      ]
+    },
     "link": {
       "description": "Functions as the primary navigation link (triggers View navigation)",
       "type": "boolean"