@objectstack/spec 2.0.6 → 2.0.7

package/json-schema/api/GraphQLConfig.json

@@ -1547,6 +1547,333 @@
         }
       },
       "additionalProperties": false
+    },
+    "federation": {
+      "description": "GraphQL Federation gateway configuration",
+      "type": "object",
+      "properties": {
+        "enabled": {
+          "default": false,
+          "description": "Enable GraphQL Federation gateway mode",
+          "type": "boolean"
+        },
+        "version": {
+          "default": "v2",
+          "description": "Federation specification version",
+          "type": "string",
+          "enum": [
+            "v1",
+            "v2"
+          ]
+        },
+        "subgraphs": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "name": {
+                "type": "string",
+                "description": "Unique subgraph identifier"
+              },
+              "url": {
+                "type": "string",
+                "description": "Subgraph endpoint URL"
+              },
+              "schemaSource": {
+                "default": "introspection",
+                "description": "How to obtain the subgraph schema",
+                "type": "string",
+                "enum": [
+                  "introspection",
+                  "file",
+                  "registry"
+                ]
+              },
+              "schemaPath": {
+                "description": "Path to schema file (SDL format)",
+                "type": "string"
+              },
+              "entities": {
+                "description": "Entity definitions for this subgraph",
+                "type": "array",
+                "items": {
+                  "type": "object",
+                  "properties": {
+                    "typeName": {
+                      "type": "string",
+                      "description": "GraphQL type name for this entity"
+                    },
+                    "keys": {
+                      "minItems": 1,
+                      "type": "array",
+                      "items": {
+                        "type": "object",
+                        "properties": {
+                          "fields": {
+                            "type": "string",
+                            "description": "Selection set of fields composing the entity key"
+                          },
+                          "resolvable": {
+                            "default": true,
+                            "description": "Whether entities can be resolved from this subgraph",
+                            "type": "boolean"
+                          }
+                        },
+                        "required": [
+                          "fields",
+                          "resolvable"
+                        ],
+                        "additionalProperties": false
+                      },
+                      "description": "Entity key definitions"
+                    },
+                    "externalFields": {
+                      "description": "Fields owned by other subgraphs",
+                      "type": "array",
+                      "items": {
+                        "type": "object",
+                        "properties": {
+                          "field": {
+                            "type": "string",
+                            "description": "Field name marked as external"
+                          },
+                          "ownerSubgraph": {
+                            "description": "Subgraph that owns this field",
+                            "type": "string"
+                          }
+                        },
+                        "required": [
+                          "field"
+                        ],
+                        "additionalProperties": false
+                      }
+                    },
+                    "requires": {
+                      "description": "Required external fields for computed fields",
+                      "type": "array",
+                      "items": {
+                        "type": "object",
+                        "properties": {
+                          "field": {
+                            "type": "string",
+                            "description": "Field with the requirement"
+                          },
+                          "fields": {
+                            "type": "string",
+                            "description": "Selection set of required fields (e.g., \"price weight\")"
+                          }
+                        },
+                        "required": [
+                          "field",
+                          "fields"
+                        ],
+                        "additionalProperties": false
+                      }
+                    },
+                    "provides": {
+                      "description": "Fields provided during resolution",
+                      "type": "array",
+                      "items": {
+                        "type": "object",
+                        "properties": {
+                          "field": {
+                            "type": "string",
+                            "description": "Field that provides additional entity fields"
+                          },
+                          "fields": {
+                            "type": "string",
+                            "description": "Selection set of provided fields (e.g., \"name price\")"
+                          }
+                        },
+                        "required": [
+                          "field",
+                          "fields"
+                        ],
+                        "additionalProperties": false
+                      }
+                    },
+                    "owner": {
+                      "default": false,
+                      "description": "Whether this subgraph is the owner of this entity",
+                      "type": "boolean"
+                    }
+                  },
+                  "required": [
+                    "typeName",
+                    "keys",
+                    "owner"
+                  ],
+                  "additionalProperties": false
+                }
+              },
+              "healthCheck": {
+                "description": "Subgraph health check configuration",
+                "type": "object",
+                "properties": {
+                  "enabled": {
+                    "default": true,
+                    "description": "Enable health checking",
+                    "type": "boolean"
+                  },
+                  "path": {
+                    "default": "/health",
+                    "description": "Health check endpoint path",
+                    "type": "string"
+                  },
+                  "intervalMs": {
+                    "default": 30000,
+                    "description": "Health check interval in milliseconds",
+                    "type": "integer",
+                    "minimum": 1000,
+                    "maximum": 9007199254740991
+                  }
+                },
+                "required": [
+                  "enabled",
+                  "path",
+                  "intervalMs"
+                ],
+                "additionalProperties": false
+              },
+              "forwardHeaders": {
+                "description": "HTTP headers to forward to this subgraph",
+                "type": "array",
+                "items": {
+                  "type": "string"
+                }
+              }
+            },
+            "required": [
+              "name",
+              "url",
+              "schemaSource"
+            ],
+            "additionalProperties": false
+          },
+          "description": "Subgraph configurations"
+        },
+        "serviceDiscovery": {
+          "description": "Service discovery configuration",
+          "type": "object",
+          "properties": {
+            "type": {
+              "default": "static",
+              "description": "Service discovery method",
+              "type": "string",
+              "enum": [
+                "static",
+                "dns",
+                "consul",
+                "kubernetes"
+              ]
+            },
+            "pollIntervalMs": {
+              "description": "Discovery poll interval in milliseconds",
+              "type": "integer",
+              "minimum": 1000,
+              "maximum": 9007199254740991
+            },
+            "namespace": {
+              "description": "Kubernetes namespace for subgraph discovery",
+              "type": "string"
+            }
+          },
+          "required": [
+            "type"
+          ],
+          "additionalProperties": false
+        },
+        "queryPlanning": {
+          "description": "Query planning configuration",
+          "type": "object",
+          "properties": {
+            "strategy": {
+              "default": "parallel",
+              "description": "Query execution strategy across subgraphs",
+              "type": "string",
+              "enum": [
+                "parallel",
+                "sequential",
+                "adaptive"
+              ]
+            },
+            "maxDepth": {
+              "description": "Max query depth in federated execution",
+              "type": "integer",
+              "minimum": 1,
+              "maximum": 9007199254740991
+            },
+            "dryRun": {
+              "default": false,
+              "description": "Log query plans without executing",
+              "type": "boolean"
+            }
+          },
+          "required": [
+            "strategy",
+            "dryRun"
+          ],
+          "additionalProperties": false
+        },
+        "composition": {
+          "description": "Schema composition configuration",
+          "type": "object",
+          "properties": {
+            "conflictResolution": {
+              "default": "error",
+              "description": "Strategy for resolving schema conflicts",
+              "type": "string",
+              "enum": [
+                "error",
+                "first_wins",
+                "last_wins"
+              ]
+            },
+            "validate": {
+              "default": true,
+              "description": "Validate composed supergraph schema",
+              "type": "boolean"
+            }
+          },
+          "required": [
+            "conflictResolution",
+            "validate"
+          ],
+          "additionalProperties": false
+        },
+        "errorHandling": {
+          "description": "Error handling configuration",
+          "type": "object",
+          "properties": {
+            "includeSubgraphName": {
+              "default": false,
+              "description": "Include subgraph name in error responses",
+              "type": "boolean"
+            },
+            "partialErrors": {
+              "default": "propagate",
+              "description": "Behavior when a subgraph returns partial errors",
+              "type": "string",
+              "enum": [
+                "propagate",
+                "nullify",
+                "reject"
+              ]
+            }
+          },
+          "required": [
+            "includeSubgraphName",
+            "partialErrors"
+          ],
+          "additionalProperties": false
+        }
+      },
+      "required": [
+        "enabled",
+        "version",
+        "subgraphs"
+      ],
+      "additionalProperties": false
     }
   },
   "required": [

package/json-schema/api/GraphQLQueryAdapter.json

@@ -0,0 +1,84 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "filterArgName": {
+      "default": "where",
+      "description": "GraphQL filter argument name",
+      "type": "string"
+    },
+    "filterStyle": {
+      "default": "nested",
+      "description": "GraphQL filter nesting style",
+      "type": "string",
+      "enum": [
+        "nested",
+        "flat",
+        "array"
+      ]
+    },
+    "pagination": {
+      "description": "Pagination argument name mappings",
+      "type": "object",
+      "properties": {
+        "limitArg": {
+          "default": "limit",
+          "description": "Page size argument name",
+          "type": "string"
+        },
+        "offsetArg": {
+          "default": "offset",
+          "description": "Offset argument name",
+          "type": "string"
+        },
+        "firstArg": {
+          "default": "first",
+          "description": "Relay \"first\" argument name",
+          "type": "string"
+        },
+        "afterArg": {
+          "default": "after",
+          "description": "Relay \"after\" cursor argument name",
+          "type": "string"
+        }
+      },
+      "required": [
+        "limitArg",
+        "offsetArg",
+        "firstArg",
+        "afterArg"
+      ],
+      "additionalProperties": false
+    },
+    "sorting": {
+      "description": "Sort argument mapping",
+      "type": "object",
+      "properties": {
+        "argName": {
+          "default": "orderBy",
+          "description": "Sort argument name",
+          "type": "string"
+        },
+        "format": {
+          "default": "enum",
+          "description": "Sort argument format",
+          "type": "string",
+          "enum": [
+            "enum",
+            "array"
+          ]
+        }
+      },
+      "required": [
+        "argName",
+        "format"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "required": [
+    "filterArgName",
+    "filterStyle"
+  ],
+  "additionalProperties": false
+}

package/json-schema/api/InstallPackageRequest.json

@@ -388,6 +388,32 @@
                 ],
                 "additionalProperties": false
               }
+            },
+            "commands": {
+              "description": "CLI command contributions",
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "name": {
+                    "type": "string",
+                    "pattern": "^[a-z][a-z0-9-]*$",
+                    "description": "CLI command name"
+                  },
+                  "description": {
+                    "description": "Command description for help text",
+                    "type": "string"
+                  },
+                  "module": {
+                    "description": "Module path exporting Commander.js commands",
+                    "type": "string"
+                  }
+                },
+                "required": [
+                  "name"
+                ],
+                "additionalProperties": false
+              }
             }
           },
           "additionalProperties": false

package/json-schema/api/InstallPackageResponse.json

@@ -391,6 +391,32 @@
                     ],
                     "additionalProperties": false
                   }
+                },
+                "commands": {
+                  "description": "CLI command contributions",
+                  "type": "array",
+                  "items": {
+                    "type": "object",
+                    "properties": {
+                      "name": {
+                        "type": "string",
+                        "pattern": "^[a-z][a-z0-9-]*$",
+                        "description": "CLI command name"
+                      },
+                      "description": {
+                        "description": "Command description for help text",
+                        "type": "string"
+                      },
+                      "module": {
+                        "description": "Module path exporting Commander.js commands",
+                        "type": "string"
+                      }
+                    },
+                    "required": [
+                      "name"
+                    ],
+                    "additionalProperties": false
+                  }
                 }
               },
               "additionalProperties": false

package/json-schema/api/ListPackagesResponse.json

@@ -393,6 +393,32 @@
                       ],
                       "additionalProperties": false
                     }
+                  },
+                  "commands": {
+                    "description": "CLI command contributions",
+                    "type": "array",
+                    "items": {
+                      "type": "object",
+                      "properties": {
+                        "name": {
+                          "type": "string",
+                          "pattern": "^[a-z][a-z0-9-]*$",
+                          "description": "CLI command name"
+                        },
+                        "description": {
+                          "description": "Command description for help text",
+                          "type": "string"
+                        },
+                        "module": {
+                          "description": "Module path exporting Commander.js commands",
+                          "type": "string"
+                        }
+                      },
+                      "required": [
+                        "name"
+                      ],
+                      "additionalProperties": false
+                    }
                   }
                 },
                 "additionalProperties": false

package/json-schema/api/ODataQueryAdapter.json

@@ -0,0 +1,66 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "version": {
+      "default": "v4",
+      "description": "OData version",
+      "type": "string",
+      "enum": [
+        "v2",
+        "v4"
+      ]
+    },
+    "usePrefix": {
+      "default": true,
+      "description": "Use $ prefix for system query options ($filter vs filter)",
+      "type": "boolean"
+    },
+    "stringFunctions": {
+      "description": "Supported OData string functions",
+      "type": "array",
+      "items": {
+        "type": "string",
+        "enum": [
+          "contains",
+          "startswith",
+          "endswith",
+          "tolower",
+          "toupper",
+          "trim",
+          "concat",
+          "substring",
+          "length"
+        ]
+      }
+    },
+    "expand": {
+      "description": "$expand configuration",
+      "type": "object",
+      "properties": {
+        "enabled": {
+          "default": true,
+          "description": "Enable $expand support",
+          "type": "boolean"
+        },
+        "maxDepth": {
+          "default": 3,
+          "description": "Maximum expand depth",
+          "type": "integer",
+          "minimum": 1,
+          "maximum": 9007199254740991
+        }
+      },
+      "required": [
+        "enabled",
+        "maxDepth"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "required": [
+    "version",
+    "usePrefix"
+  ],
+  "additionalProperties": false
+}