@objectstack/spec 2.0.5 → 2.0.7

package/json-schema/ui/Notification.json

@@ -0,0 +1,232 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "type": {
+      "default": "toast",
+      "description": "Notification presentation style",
+      "type": "string",
+      "enum": [
+        "toast",
+        "snackbar",
+        "banner",
+        "alert",
+        "inline"
+      ]
+    },
+    "severity": {
+      "default": "info",
+      "description": "Notification severity level",
+      "type": "string",
+      "enum": [
+        "info",
+        "success",
+        "warning",
+        "error"
+      ]
+    },
+    "title": {
+      "description": "Notification title",
+      "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
+        }
+      ]
+    },
+    "message": {
+      "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
+        }
+      ],
+      "description": "Notification message body"
+    },
+    "icon": {
+      "description": "Icon name override",
+      "type": "string"
+    },
+    "duration": {
+      "description": "Auto-dismiss duration in ms, omit for persistent",
+      "type": "number"
+    },
+    "dismissible": {
+      "default": true,
+      "description": "Allow user to dismiss the notification",
+      "type": "boolean"
+    },
+    "actions": {
+      "description": "Action buttons",
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "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
+              }
+            ],
+            "description": "Action button label"
+          },
+          "action": {
+            "type": "string",
+            "description": "Action identifier to execute"
+          },
+          "variant": {
+            "default": "primary",
+            "description": "Button variant style",
+            "type": "string",
+            "enum": [
+              "primary",
+              "secondary",
+              "link"
+            ]
+          }
+        },
+        "required": [
+          "label",
+          "action",
+          "variant"
+        ],
+        "additionalProperties": false,
+        "description": "Notification action button"
+      }
+    },
+    "position": {
+      "description": "Override default position",
+      "type": "string",
+      "enum": [
+        "top_left",
+        "top_center",
+        "top_right",
+        "bottom_left",
+        "bottom_center",
+        "bottom_right"
+      ]
+    },
+    "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": [
+    "type",
+    "severity",
+    "message",
+    "dismissible"
+  ],
+  "additionalProperties": false,
+  "description": "Notification instance definition"
+}

package/json-schema/ui/NotificationAction.json

@@ -0,0 +1,60 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "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
+        }
+      ],
+      "description": "Action button label"
+    },
+    "action": {
+      "type": "string",
+      "description": "Action identifier to execute"
+    },
+    "variant": {
+      "default": "primary",
+      "description": "Button variant style",
+      "type": "string",
+      "enum": [
+        "primary",
+        "secondary",
+        "link"
+      ]
+    }
+  },
+  "required": [
+    "label",
+    "action",
+    "variant"
+  ],
+  "additionalProperties": false,
+  "description": "Notification action button"
+}

package/json-schema/ui/NotificationConfig.json

@@ -0,0 +1,52 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "defaultPosition": {
+      "default": "top_right",
+      "description": "Default screen position for notifications",
+      "type": "string",
+      "enum": [
+        "top_left",
+        "top_center",
+        "top_right",
+        "bottom_left",
+        "bottom_center",
+        "bottom_right"
+      ]
+    },
+    "defaultDuration": {
+      "default": 5000,
+      "description": "Default auto-dismiss duration in ms",
+      "type": "number"
+    },
+    "maxVisible": {
+      "default": 5,
+      "description": "Maximum number of notifications visible at once",
+      "type": "number"
+    },
+    "stackDirection": {
+      "default": "down",
+      "description": "Stack direction for multiple notifications",
+      "type": "string",
+      "enum": [
+        "up",
+        "down"
+      ]
+    },
+    "pauseOnHover": {
+      "default": true,
+      "description": "Pause auto-dismiss timer on hover",
+      "type": "boolean"
+    }
+  },
+  "required": [
+    "defaultPosition",
+    "defaultDuration",
+    "maxVisible",
+    "stackDirection",
+    "pauseOnHover"
+  ],
+  "additionalProperties": false,
+  "description": "Global notification system configuration"
+}

package/json-schema/ui/NotificationPosition.json

@@ -0,0 +1,13 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "string",
+  "enum": [
+    "top_left",
+    "top_center",
+    "top_right",
+    "bottom_left",
+    "bottom_center",
+    "bottom_right"
+  ],
+  "description": "Screen position for notification placement"
+}

package/json-schema/ui/NotificationSeverity.json

@@ -0,0 +1,11 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "string",
+  "enum": [
+    "info",
+    "success",
+    "warning",
+    "error"
+  ],
+  "description": "Notification severity level"
+}

package/json-schema/ui/NotificationType.json

@@ -0,0 +1,12 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "string",
+  "enum": [
+    "toast",
+    "snackbar",
+    "banner",
+    "alert",
+    "inline"
+  ],
+  "description": "Notification presentation style"
+}

package/json-schema/ui/NumberFormat.json

@@ -0,0 +1,42 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "style": {
+      "default": "decimal",
+      "description": "Number formatting style",
+      "type": "string",
+      "enum": [
+        "decimal",
+        "currency",
+        "percent",
+        "unit"
+      ]
+    },
+    "currency": {
+      "description": "ISO 4217 currency code (e.g., \"USD\", \"EUR\")",
+      "type": "string"
+    },
+    "unit": {
+      "description": "Unit for unit formatting (e.g., \"kilometer\", \"liter\")",
+      "type": "string"
+    },
+    "minimumFractionDigits": {
+      "description": "Minimum number of fraction digits",
+      "type": "number"
+    },
+    "maximumFractionDigits": {
+      "description": "Maximum number of fraction digits",
+      "type": "number"
+    },
+    "useGrouping": {
+      "description": "Whether to use grouping separators (e.g., 1,000)",
+      "type": "boolean"
+    }
+  },
+  "required": [
+    "style"
+  ],
+  "additionalProperties": false,
+  "description": "Number formatting rules"
+}

package/json-schema/ui/ObjectNavItem.json

@@ -9,7 +9,36 @@
       "description": "Unique identifier for this navigation item (lowercase snake_case)"
     },
     "label": {
-      "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
+        }
+      ],
       "description": "Display proper label"
     },
     "icon": {

package/json-schema/ui/OfflineCacheConfig.json

@@ -0,0 +1,40 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "maxSize": {
+      "description": "Maximum cache size in bytes",
+      "type": "number"
+    },
+    "ttl": {
+      "description": "Time-to-live for cached entries in milliseconds",
+      "type": "number"
+    },
+    "persistStorage": {
+      "default": "indexeddb",
+      "description": "Storage backend",
+      "type": "string",
+      "enum": [
+        "indexeddb",
+        "localstorage",
+        "sqlite"
+      ]
+    },
+    "evictionPolicy": {
+      "default": "lru",
+      "description": "Cache eviction policy when full",
+      "type": "string",
+      "enum": [
+        "lru",
+        "lfu",
+        "fifo"
+      ]
+    }
+  },
+  "required": [
+    "persistStorage",
+    "evictionPolicy"
+  ],
+  "additionalProperties": false,
+  "description": "Client-side offline cache configuration"
+}

package/json-schema/ui/OfflineConfig.json

@@ -0,0 +1,157 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "enabled": {
+      "default": false,
+      "description": "Enable offline support",
+      "type": "boolean"
+    },
+    "strategy": {
+      "default": "network_first",
+      "description": "Default offline fetch strategy",
+      "type": "string",
+      "enum": [
+        "cache_first",
+        "network_first",
+        "stale_while_revalidate",
+        "network_only",
+        "cache_only"
+      ]
+    },
+    "cache": {
+      "description": "Cache settings for offline data",
+      "type": "object",
+      "properties": {
+        "maxSize": {
+          "description": "Maximum cache size in bytes",
+          "type": "number"
+        },
+        "ttl": {
+          "description": "Time-to-live for cached entries in milliseconds",
+          "type": "number"
+        },
+        "persistStorage": {
+          "default": "indexeddb",
+          "description": "Storage backend",
+          "type": "string",
+          "enum": [
+            "indexeddb",
+            "localstorage",
+            "sqlite"
+          ]
+        },
+        "evictionPolicy": {
+          "default": "lru",
+          "description": "Cache eviction policy when full",
+          "type": "string",
+          "enum": [
+            "lru",
+            "lfu",
+            "fifo"
+          ]
+        }
+      },
+      "required": [
+        "persistStorage",
+        "evictionPolicy"
+      ],
+      "additionalProperties": false
+    },
+    "sync": {
+      "description": "Sync settings for offline mutations",
+      "type": "object",
+      "properties": {
+        "strategy": {
+          "default": "network_first",
+          "description": "Sync fetch strategy",
+          "type": "string",
+          "enum": [
+            "cache_first",
+            "network_first",
+            "stale_while_revalidate",
+            "network_only",
+            "cache_only"
+          ]
+        },
+        "conflictResolution": {
+          "default": "last_write_wins",
+          "description": "Conflict resolution policy",
+          "type": "string",
+          "enum": [
+            "client_wins",
+            "server_wins",
+            "manual",
+            "last_write_wins"
+          ]
+        },
+        "retryInterval": {
+          "description": "Retry interval in milliseconds between sync attempts",
+          "type": "number"
+        },
+        "maxRetries": {
+          "description": "Maximum number of sync retry attempts",
+          "type": "number"
+        },
+        "batchSize": {
+          "description": "Number of mutations to sync per batch",
+          "type": "number"
+        }
+      },
+      "required": [
+        "strategy",
+        "conflictResolution"
+      ],
+      "additionalProperties": false
+    },
+    "offlineIndicator": {
+      "default": true,
+      "description": "Show a visual indicator when offline",
+      "type": "boolean"
+    },
+    "offlineMessage": {
+      "description": "Customizable offline status message shown to users",
+      "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
+        }
+      ]
+    },
+    "queueMaxSize": {
+      "description": "Maximum number of queued offline mutations",
+      "type": "number"
+    }
+  },
+  "required": [
+    "enabled",
+    "strategy",
+    "offlineIndicator"
+  ],
+  "additionalProperties": false,
+  "description": "Offline support configuration"
+}

package/json-schema/ui/OfflineStrategy.json

@@ -0,0 +1,12 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "string",
+  "enum": [
+    "cache_first",
+    "network_first",
+    "stale_while_revalidate",
+    "network_only",
+    "cache_only"
+  ],
+  "description": "Data fetching strategy for offline/online transitions"
+}