@objectstack/spec 0.1.0 → 0.1.2

package/json-schema/Mapping.json

@@ -0,0 +1,598 @@
+{
+  "$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"
+            },
+            "aggregations": {
+              "type": "array",
+              "items": {
+                "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
+              },
+              "description": "Aggregation functions (GROUP BY)"
+            },
+            "windowFunctions": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "function": {
+                    "type": "string",
+                    "enum": [
+                      "row_number",
+                      "rank",
+                      "dense_rank",
+                      "percent_rank",
+                      "lag",
+                      "lead",
+                      "first_value",
+                      "last_value",
+                      "sum",
+                      "avg",
+                      "count",
+                      "min",
+                      "max"
+                    ],
+                    "description": "Window function name"
+                  },
+                  "field": {
+                    "type": "string",
+                    "description": "Field to operate on (for aggregate window functions)"
+                  },
+                  "alias": {
+                    "type": "string",
+                    "description": "Result column alias"
+                  },
+                  "over": {
+                    "type": "object",
+                    "properties": {
+                      "partitionBy": {
+                        "type": "array",
+                        "items": {
+                          "type": "string"
+                        },
+                        "description": "PARTITION BY fields"
+                      },
+                      "orderBy": {
+                        "type": "array",
+                        "items": {
+                          "type": "object",
+                          "properties": {
+                            "field": {
+                              "type": "string"
+                            },
+                            "order": {
+                              "type": "string",
+                              "enum": [
+                                "asc",
+                                "desc"
+                              ],
+                              "default": "asc"
+                            }
+                          },
+                          "required": [
+                            "field"
+                          ],
+                          "additionalProperties": false
+                        },
+                        "description": "ORDER BY specification"
+                      },
+                      "frame": {
+                        "type": "object",
+                        "properties": {
+                          "type": {
+                            "type": "string",
+                            "enum": [
+                              "rows",
+                              "range"
+                            ]
+                          },
+                          "start": {
+                            "type": "string",
+                            "description": "Frame start (e.g., \"UNBOUNDED PRECEDING\", \"1 PRECEDING\")"
+                          },
+                          "end": {
+                            "type": "string",
+                            "description": "Frame end (e.g., \"CURRENT ROW\", \"1 FOLLOWING\")"
+                          }
+                        },
+                        "additionalProperties": false,
+                        "description": "Window frame specification"
+                      }
+                    },
+                    "additionalProperties": false,
+                    "description": "Window specification (OVER clause)"
+                  }
+                },
+                "required": [
+                  "function",
+                  "alias",
+                  "over"
+                ],
+                "additionalProperties": false
+              },
+              "description": "Window functions with OVER clause"
+            },
+            "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"
+            },
+            "joins": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "type": {
+                    "type": "string",
+                    "enum": [
+                      "inner",
+                      "left",
+                      "right",
+                      "full"
+                    ],
+                    "description": "Join type"
+                  },
+                  "object": {
+                    "type": "string",
+                    "description": "Object/table to join"
+                  },
+                  "alias": {
+                    "type": "string",
+                    "description": "Table alias"
+                  },
+                  "on": {
+                    "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"
+                            },
+                            {
+                              "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": "Join condition"
+                  },
+                  "subquery": {
+                    "description": "Subquery instead of object"
+                  }
+                },
+                "required": [
+                  "type",
+                  "object",
+                  "on"
+                ],
+                "additionalProperties": false
+              },
+              "description": "Table joins"
+            },
+            "groupBy": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              },
+              "description": "GROUP BY fields"
+            },
+            "having": {
+              "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": "HAVING clause for aggregation filtering"
+            },
+            "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"
+            },
+            "distinct": {
+              "type": "boolean",
+              "description": "SELECT DISTINCT flag"
+            }
+          },
+          "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#"
+}

package/json-schema/MetricType.json

@@ -0,0 +1,14 @@
+{
+  "$ref": "#/definitions/MetricType",
+  "definitions": {
+    "MetricType": {
+      "type": "string",
+      "enum": [
+        "boolean",
+        "counter",
+        "gauge"
+      ]
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/ModificationResult.json

@@ -0,0 +1,46 @@
+{
+  "$ref": "#/definitions/ModificationResult",
+  "definitions": {
+    "ModificationResult": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string",
+          "description": "Record ID if processed"
+        },
+        "success": {
+          "type": "boolean"
+        },
+        "errors": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "code": {
+                "type": "string",
+                "description": "Error code (e.g. validation_error)"
+              },
+              "message": {
+                "type": "string",
+                "description": "Readable error message"
+              },
+              "details": {
+                "description": "Additional error context (e.g. field validation errors)"
+              }
+            },
+            "required": [
+              "code",
+              "message"
+            ],
+            "additionalProperties": false
+          }
+        }
+      },
+      "required": [
+        "success"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}