@objectstack/spec 0.1.0 → 0.1.1

package/json-schema/KanbanConfig.json

@@ -0,0 +1,31 @@
+{
+  "$ref": "#/definitions/KanbanConfig",
+  "definitions": {
+    "KanbanConfig": {
+      "type": "object",
+      "properties": {
+        "groupByField": {
+          "type": "string",
+          "description": "Field to group columns by (usually status/select)"
+        },
+        "summarizeField": {
+          "type": "string",
+          "description": "Field to sum at top of column (e.g. amount)"
+        },
+        "columns": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "Fields to show on cards"
+        }
+      },
+      "required": [
+        "groupByField",
+        "columns"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/LDAPConfig.json

@@ -0,0 +1,39 @@
+{
+  "$ref": "#/definitions/LDAPConfig",
+  "definitions": {
+    "LDAPConfig": {
+      "type": "object",
+      "properties": {
+        "url": {
+          "type": "string",
+          "format": "uri",
+          "description": "LDAP Server URL (ldap:// or ldaps://)"
+        },
+        "bindDn": {
+          "type": "string"
+        },
+        "bindCredentials": {
+          "type": "string"
+        },
+        "searchBase": {
+          "type": "string"
+        },
+        "searchFilter": {
+          "type": "string"
+        },
+        "groupSearchBase": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "url",
+        "bindDn",
+        "bindCredentials",
+        "searchBase",
+        "searchFilter"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/License.json

@@ -0,0 +1,57 @@
+{
+  "$ref": "#/definitions/License",
+  "definitions": {
+    "License": {
+      "type": "object",
+      "properties": {
+        "tenantId": {
+          "type": "string"
+        },
+        "planCode": {
+          "type": "string"
+        },
+        "issuedAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "expiresAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "status": {
+          "type": "string",
+          "enum": [
+            "active",
+            "expired",
+            "suspended",
+            "trial"
+          ]
+        },
+        "customFeatures": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "customLimits": {
+          "type": "object",
+          "additionalProperties": {
+            "type": "number"
+          }
+        },
+        "signature": {
+          "type": "string",
+          "description": "Cryptographic signature of the license"
+        }
+      },
+      "required": [
+        "tenantId",
+        "planCode",
+        "issuedAt",
+        "status"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/ListView.json

@@ -0,0 +1,153 @@
+{
+  "$ref": "#/definitions/ListView",
+  "definitions": {
+    "ListView": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string"
+        },
+        "label": {
+          "type": "string"
+        },
+        "type": {
+          "type": "string",
+          "enum": [
+            "grid",
+            "kanban",
+            "calendar",
+            "gantt",
+            "map"
+          ],
+          "default": "grid"
+        },
+        "columns": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "Fields to display as columns"
+        },
+        "filter": {
+          "type": "array",
+          "description": "Filter criteria (JSON Rules)"
+        },
+        "sort": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "field": {
+                    "type": "string"
+                  },
+                  "order": {
+                    "type": "string",
+                    "enum": [
+                      "asc",
+                      "desc"
+                    ]
+                  }
+                },
+                "required": [
+                  "field",
+                  "order"
+                ],
+                "additionalProperties": false
+              }
+            }
+          ]
+        },
+        "searchableFields": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "Fields enabled for search"
+        },
+        "kanban": {
+          "type": "object",
+          "properties": {
+            "groupByField": {
+              "type": "string",
+              "description": "Field to group columns by (usually status/select)"
+            },
+            "summarizeField": {
+              "type": "string",
+              "description": "Field to sum at top of column (e.g. amount)"
+            },
+            "columns": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              },
+              "description": "Fields to show on cards"
+            }
+          },
+          "required": [
+            "groupByField",
+            "columns"
+          ],
+          "additionalProperties": false
+        },
+        "calendar": {
+          "type": "object",
+          "properties": {
+            "startDateField": {
+              "type": "string"
+            },
+            "endDateField": {
+              "type": "string"
+            },
+            "titleField": {
+              "type": "string"
+            },
+            "colorField": {
+              "type": "string"
+            }
+          },
+          "required": [
+            "startDateField",
+            "titleField"
+          ],
+          "additionalProperties": false
+        },
+        "gantt": {
+          "type": "object",
+          "properties": {
+            "startDateField": {
+              "type": "string"
+            },
+            "endDateField": {
+              "type": "string"
+            },
+            "titleField": {
+              "type": "string"
+            },
+            "progressField": {
+              "type": "string"
+            },
+            "dependenciesField": {
+              "type": "string"
+            }
+          },
+          "required": [
+            "startDateField",
+            "endDateField",
+            "titleField"
+          ],
+          "additionalProperties": false
+        }
+      },
+      "required": [
+        "columns"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/Locale.json

@@ -0,0 +1,10 @@
+{
+  "$ref": "#/definitions/Locale",
+  "definitions": {
+    "Locale": {
+      "type": "string",
+      "description": "BCP-47 Language Tag (e.g. en-US, zh-CN)"
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/LogicOperator.json

@@ -0,0 +1,14 @@
+{
+  "$ref": "#/definitions/LogicOperator",
+  "definitions": {
+    "LogicOperator": {
+      "type": "string",
+      "enum": [
+        "and",
+        "or",
+        "not"
+      ]
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/Manifest.json

@@ -0,0 +1,90 @@
+{
+  "$ref": "#/definitions/Manifest",
+  "definitions": {
+    "Manifest": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string",
+          "description": "Unique package identifier (reverse domain style)"
+        },
+        "version": {
+          "type": "string",
+          "pattern": "^\\d+\\.\\d+\\.\\d+$",
+          "description": "Package version (semantic versioning)"
+        },
+        "type": {
+          "type": "string",
+          "enum": [
+            "app",
+            "plugin",
+            "driver",
+            "module"
+          ],
+          "description": "Type of package"
+        },
+        "name": {
+          "type": "string",
+          "description": "Human-readable package name"
+        },
+        "description": {
+          "type": "string",
+          "description": "Package description"
+        },
+        "permissions": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "Array of required permission strings"
+        },
+        "menus": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "label": {
+                "type": "string",
+                "description": "Display label for the menu item"
+              },
+              "path": {
+                "type": "string",
+                "description": "Navigation path (route) for the menu item"
+              },
+              "icon": {
+                "type": "string",
+                "description": "Optional icon identifier for the menu item"
+              }
+            },
+            "required": [
+              "label",
+              "path"
+            ],
+            "additionalProperties": false
+          },
+          "description": "Navigation menu structure"
+        },
+        "objects": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "Glob patterns for ObjectQL schemas files"
+        },
+        "extensions": {
+          "type": "object",
+          "additionalProperties": {},
+          "description": "Extension points and contributions"
+        }
+      },
+      "required": [
+        "id",
+        "version",
+        "type",
+        "name"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/Mapping.json

@@ -0,0 +1,270 @@
+{
+  "$ref": "#/definitions/Mapping",
+  "definitions": {
+    "Mapping": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string",
+          "pattern": "^[a-z_][a-z0-9_]*$"
+        },
+        "label": {
+          "type": "string"
+        },
+        "sourceFormat": {
+          "type": "string",
+          "enum": [
+            "csv",
+            "json",
+            "xml",
+            "sql"
+          ],
+          "default": "csv"
+        },
+        "targetObject": {
+          "type": "string",
+          "description": "Target Object Name"
+        },
+        "fieldMapping": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "source": {
+                "anyOf": [
+                  {
+                    "type": "string"
+                  },
+                  {
+                    "type": "array",
+                    "items": {
+                      "type": "string"
+                    }
+                  }
+                ],
+                "description": "Source column header(s)"
+              },
+              "target": {
+                "anyOf": [
+                  {
+                    "type": "string"
+                  },
+                  {
+                    "type": "array",
+                    "items": {
+                      "type": "string"
+                    }
+                  }
+                ],
+                "description": "Target object field(s)"
+              },
+              "transform": {
+                "type": "string",
+                "enum": [
+                  "none",
+                  "constant",
+                  "lookup",
+                  "split",
+                  "join",
+                  "javascript",
+                  "map"
+                ],
+                "default": "none"
+              },
+              "params": {
+                "type": "object",
+                "properties": {
+                  "value": {},
+                  "object": {
+                    "type": "string"
+                  },
+                  "fromField": {
+                    "type": "string"
+                  },
+                  "toField": {
+                    "type": "string"
+                  },
+                  "autoCreate": {
+                    "type": "boolean"
+                  },
+                  "valueMap": {
+                    "type": "object",
+                    "additionalProperties": {}
+                  },
+                  "separator": {
+                    "type": "string"
+                  }
+                },
+                "additionalProperties": false
+              }
+            },
+            "required": [
+              "source",
+              "target"
+            ],
+            "additionalProperties": false
+          }
+        },
+        "mode": {
+          "type": "string",
+          "enum": [
+            "insert",
+            "update",
+            "upsert"
+          ],
+          "default": "insert"
+        },
+        "upsertKey": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "Fields to match for upsert (e.g. email)"
+        },
+        "extractQuery": {
+          "type": "object",
+          "properties": {
+            "object": {
+              "type": "string",
+              "description": "Object name (e.g. account)"
+            },
+            "fields": {
+              "type": "array",
+              "items": {
+                "anyOf": [
+                  {
+                    "type": "string"
+                  },
+                  {
+                    "type": "object",
+                    "properties": {
+                      "field": {
+                        "type": "string"
+                      },
+                      "fields": {
+                        "type": "array",
+                        "items": {}
+                      },
+                      "alias": {
+                        "type": "string"
+                      }
+                    },
+                    "required": [
+                      "field"
+                    ],
+                    "additionalProperties": false
+                  }
+                ]
+              },
+              "description": "Fields to retrieve"
+            },
+            "filters": {
+              "anyOf": [
+                {
+                  "type": "array",
+                  "minItems": 3,
+                  "maxItems": 3,
+                  "items": [
+                    {
+                      "type": "string"
+                    },
+                    {
+                      "type": "string",
+                      "enum": [
+                        "=",
+                        "!=",
+                        "<>",
+                        ">",
+                        ">=",
+                        "<",
+                        "<=",
+                        "startswith",
+                        "contains",
+                        "notcontains",
+                        "between",
+                        "in",
+                        "notin",
+                        "is_null",
+                        "is_not_null"
+                      ]
+                    },
+                    {}
+                  ]
+                },
+                {
+                  "type": "array",
+                  "items": {
+                    "anyOf": [
+                      {
+                        "type": "string"
+                      },
+                      {}
+                    ]
+                  }
+                }
+              ],
+              "description": "Filtering criteria"
+            },
+            "sort": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "field": {
+                    "type": "string"
+                  },
+                  "order": {
+                    "type": "string",
+                    "enum": [
+                      "asc",
+                      "desc"
+                    ],
+                    "default": "asc"
+                  }
+                },
+                "required": [
+                  "field"
+                ],
+                "additionalProperties": false
+              },
+              "description": "Sorting instructions"
+            },
+            "top": {
+              "type": "number",
+              "description": "Limit results"
+            },
+            "skip": {
+              "type": "number",
+              "description": "Offset results"
+            }
+          },
+          "required": [
+            "object"
+          ],
+          "additionalProperties": false,
+          "description": "Query to run for export only"
+        },
+        "errorPolicy": {
+          "type": "string",
+          "enum": [
+            "skip",
+            "abort",
+            "retry"
+          ],
+          "default": "skip"
+        },
+        "batchSize": {
+          "type": "number",
+          "default": 1000
+        }
+      },
+      "required": [
+        "name",
+        "targetObject",
+        "fieldMapping"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/MenuItem.json

@@ -0,0 +1,28 @@
+{
+  "$ref": "#/definitions/MenuItem",
+  "definitions": {
+    "MenuItem": {
+      "type": "object",
+      "properties": {
+        "label": {
+          "type": "string",
+          "description": "Display label for the menu item"
+        },
+        "path": {
+          "type": "string",
+          "description": "Navigation path (route) for the menu item"
+        },
+        "icon": {
+          "type": "string",
+          "description": "Optional icon identifier for the menu item"
+        }
+      },
+      "required": [
+        "label",
+        "path"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}