@objectstack/spec 0.1.0 → 0.1.2

package/json-schema/Action.json

@@ -0,0 +1,162 @@
+{
+  "$ref": "#/definitions/Action",
+  "definitions": {
+    "Action": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string",
+          "pattern": "^[a-z_][a-z0-9_]*$",
+          "description": "Machine name (snake_case)"
+        },
+        "label": {
+          "type": "string",
+          "description": "Display label"
+        },
+        "icon": {
+          "type": "string",
+          "description": "Icon name"
+        },
+        "locations": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "enum": [
+              "list_toolbar",
+              "list_item",
+              "record_header",
+              "record_more",
+              "record_related",
+              "global_nav"
+            ]
+          },
+          "description": "Locations where this action is visible"
+        },
+        "location": {},
+        "type": {
+          "type": "string",
+          "enum": [
+            "script",
+            "url",
+            "modal",
+            "flow",
+            "api"
+          ],
+          "default": "script",
+          "description": "Action functionality type"
+        },
+        "target": {
+          "type": "string",
+          "description": "URL, Script Name, Flow ID, or API Endpoint"
+        },
+        "execute": {
+          "type": "string",
+          "description": "Legacy execution logic"
+        },
+        "params": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "name": {
+                "type": "string"
+              },
+              "label": {
+                "type": "string"
+              },
+              "type": {
+                "type": "string",
+                "enum": [
+                  "text",
+                  "textarea",
+                  "email",
+                  "url",
+                  "phone",
+                  "password",
+                  "markdown",
+                  "html",
+                  "richtext",
+                  "number",
+                  "currency",
+                  "percent",
+                  "date",
+                  "datetime",
+                  "time",
+                  "boolean",
+                  "select",
+                  "lookup",
+                  "master_detail",
+                  "image",
+                  "file",
+                  "avatar",
+                  "formula",
+                  "summary",
+                  "autonumber",
+                  "location",
+                  "address",
+                  "code",
+                  "color",
+                  "rating",
+                  "signature"
+                ]
+              },
+              "required": {
+                "type": "boolean",
+                "default": false
+              },
+              "options": {
+                "type": "array",
+                "items": {
+                  "type": "object",
+                  "properties": {
+                    "label": {
+                      "type": "string"
+                    },
+                    "value": {
+                      "type": "string"
+                    }
+                  },
+                  "required": [
+                    "label",
+                    "value"
+                  ],
+                  "additionalProperties": false
+                }
+              }
+            },
+            "required": [
+              "name",
+              "label",
+              "type"
+            ],
+            "additionalProperties": false
+          },
+          "description": "Input parameters required from user"
+        },
+        "confirmText": {
+          "type": "string",
+          "description": "Confirmation message before execution"
+        },
+        "successMessage": {
+          "type": "string",
+          "description": "Success message to show after execution"
+        },
+        "refreshAfter": {
+          "type": "boolean",
+          "default": false,
+          "description": "Refresh view after execution"
+        },
+        "visible": {
+          "type": "string",
+          "description": "Formula returning boolean"
+        }
+      },
+      "required": [
+        "name",
+        "label"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/ActionParam.json

@@ -0,0 +1,82 @@
+{
+  "$ref": "#/definitions/ActionParam",
+  "definitions": {
+    "ActionParam": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string"
+        },
+        "label": {
+          "type": "string"
+        },
+        "type": {
+          "type": "string",
+          "enum": [
+            "text",
+            "textarea",
+            "email",
+            "url",
+            "phone",
+            "password",
+            "markdown",
+            "html",
+            "richtext",
+            "number",
+            "currency",
+            "percent",
+            "date",
+            "datetime",
+            "time",
+            "boolean",
+            "select",
+            "lookup",
+            "master_detail",
+            "image",
+            "file",
+            "avatar",
+            "formula",
+            "summary",
+            "autonumber",
+            "location",
+            "address",
+            "code",
+            "color",
+            "rating",
+            "signature"
+          ]
+        },
+        "required": {
+          "type": "boolean",
+          "default": false
+        },
+        "options": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "label": {
+                "type": "string"
+              },
+              "value": {
+                "type": "string"
+              }
+            },
+            "required": [
+              "label",
+              "value"
+            ],
+            "additionalProperties": false
+          }
+        }
+      },
+      "required": [
+        "name",
+        "label",
+        "type"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/Address.json

@@ -0,0 +1,40 @@
+{
+  "$ref": "#/definitions/Address",
+  "definitions": {
+    "Address": {
+      "type": "object",
+      "properties": {
+        "street": {
+          "type": "string",
+          "description": "Street address"
+        },
+        "city": {
+          "type": "string",
+          "description": "City name"
+        },
+        "state": {
+          "type": "string",
+          "description": "State/Province"
+        },
+        "postalCode": {
+          "type": "string",
+          "description": "Postal/ZIP code"
+        },
+        "country": {
+          "type": "string",
+          "description": "Country name or code"
+        },
+        "countryCode": {
+          "type": "string",
+          "description": "ISO country code (e.g., US, GB)"
+        },
+        "formatted": {
+          "type": "string",
+          "description": "Formatted address string"
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/Agent.json

@@ -0,0 +1,140 @@
+{
+  "$ref": "#/definitions/Agent",
+  "definitions": {
+    "Agent": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string",
+          "pattern": "^[a-z_][a-z0-9_]*$",
+          "description": "Agent unique identifier"
+        },
+        "label": {
+          "type": "string",
+          "description": "Agent display name"
+        },
+        "avatar": {
+          "type": "string"
+        },
+        "role": {
+          "type": "string",
+          "description": "The persona/role (e.g. \"Senior Support Engineer\")"
+        },
+        "instructions": {
+          "type": "string",
+          "description": "System Prompt / Prime Directives"
+        },
+        "model": {
+          "type": "object",
+          "properties": {
+            "provider": {
+              "type": "string",
+              "enum": [
+                "openai",
+                "azure_openai",
+                "anthropic",
+                "local"
+              ],
+              "default": "openai"
+            },
+            "model": {
+              "type": "string",
+              "description": "Model name (e.g. gpt-4, claude-3-opus)"
+            },
+            "temperature": {
+              "type": "number",
+              "minimum": 0,
+              "maximum": 2,
+              "default": 0.7
+            },
+            "maxTokens": {
+              "type": "number"
+            },
+            "topP": {
+              "type": "number"
+            }
+          },
+          "required": [
+            "model"
+          ],
+          "additionalProperties": false
+        },
+        "tools": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "type": {
+                "type": "string",
+                "enum": [
+                  "action",
+                  "flow",
+                  "query",
+                  "vector_search"
+                ]
+              },
+              "name": {
+                "type": "string",
+                "description": "Reference name (Action Name, Flow Name)"
+              },
+              "description": {
+                "type": "string",
+                "description": "Override description for the LLM"
+              }
+            },
+            "required": [
+              "type",
+              "name"
+            ],
+            "additionalProperties": false
+          },
+          "description": "Available tools"
+        },
+        "knowledge": {
+          "type": "object",
+          "properties": {
+            "topics": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              },
+              "description": "Topics/Tags to recruit knowledge from"
+            },
+            "indexes": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              },
+              "description": "Vector Store Indexes"
+            }
+          },
+          "required": [
+            "topics",
+            "indexes"
+          ],
+          "additionalProperties": false,
+          "description": "RAG access"
+        },
+        "active": {
+          "type": "boolean",
+          "default": true
+        },
+        "access": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "Who can chat with this agent"
+        }
+      },
+      "required": [
+        "name",
+        "label",
+        "role",
+        "instructions"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/AggregationFunction.json

@@ -0,0 +1,19 @@
+{
+  "$ref": "#/definitions/AggregationFunction",
+  "definitions": {
+    "AggregationFunction": {
+      "type": "string",
+      "enum": [
+        "count",
+        "sum",
+        "avg",
+        "min",
+        "max",
+        "count_distinct",
+        "array_agg",
+        "string_agg"
+      ]
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/AggregationNode.json

@@ -0,0 +1,42 @@
+{
+  "$ref": "#/definitions/AggregationNode",
+  "definitions": {
+    "AggregationNode": {
+      "type": "object",
+      "properties": {
+        "function": {
+          "type": "string",
+          "enum": [
+            "count",
+            "sum",
+            "avg",
+            "min",
+            "max",
+            "count_distinct",
+            "array_agg",
+            "string_agg"
+          ],
+          "description": "Aggregation function"
+        },
+        "field": {
+          "type": "string",
+          "description": "Field to aggregate (optional for COUNT(*))"
+        },
+        "alias": {
+          "type": "string",
+          "description": "Result column alias"
+        },
+        "distinct": {
+          "type": "boolean",
+          "description": "Apply DISTINCT before aggregation"
+        }
+      },
+      "required": [
+        "function",
+        "alias"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/Animation.json

@@ -0,0 +1,56 @@
+{
+  "$ref": "#/definitions/Animation",
+  "definitions": {
+    "Animation": {
+      "type": "object",
+      "properties": {
+        "duration": {
+          "type": "object",
+          "properties": {
+            "fast": {
+              "type": "string",
+              "description": "Fast animation (e.g., 150ms)"
+            },
+            "base": {
+              "type": "string",
+              "description": "Base animation (e.g., 300ms)"
+            },
+            "slow": {
+              "type": "string",
+              "description": "Slow animation (e.g., 500ms)"
+            }
+          },
+          "additionalProperties": false
+        },
+        "timing": {
+          "type": "object",
+          "properties": {
+            "linear": {
+              "type": "string",
+              "description": "Linear timing function"
+            },
+            "ease": {
+              "type": "string",
+              "description": "Ease timing function"
+            },
+            "easeIn": {
+              "type": "string",
+              "description": "Ease-in timing function"
+            },
+            "easeOut": {
+              "type": "string",
+              "description": "Ease-out timing function"
+            },
+            "easeInOut": {
+              "type": "string",
+              "description": "Ease-in-out timing function"
+            }
+          },
+          "additionalProperties": false
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/ApiCapabilities.json

@@ -0,0 +1,28 @@
+{
+  "$ref": "#/definitions/ApiCapabilities",
+  "definitions": {
+    "ApiCapabilities": {
+      "type": "object",
+      "properties": {
+        "graphql": {
+          "type": "boolean",
+          "default": false
+        },
+        "search": {
+          "type": "boolean",
+          "default": false
+        },
+        "websockets": {
+          "type": "boolean",
+          "default": false
+        },
+        "files": {
+          "type": "boolean",
+          "default": true
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}