Support for ndc-spec v0.1.4 (#33)

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 5.1.0
+- Updated to support [v0.1.4 of the NDC Spec](https://hasura.github.io/ndc-spec/specification/changelog.html#014) ([#33](https://github.com/hasura/ndc-sdk-typescript/pull/33))
+  - Support for [aggregates](https://hasura.github.io/ndc-spec/specification/queries/aggregates.html) over nested fields
+
 ## 5.0.0
 - Updated to support [v0.1.3 of the NDC Spec](https://hasura.github.io/ndc-spec/specification/changelog.html#013) ([#32](https://github.com/hasura/ndc-sdk-typescript/pull/32))
   - Breaking change: new `nested_fields` property on `QueryCapabilities`; set it to `{}` to retain previous v0.1.2 semantics and not support new v0.1.3 capabilities.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hasura/ndc-sdk-typescript",
-  "version": "5.0.0",
+  "version": "5.1.0",
   "description": "",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",

src/schema/schema.generated.json

@@ -89,9 +89,6 @@
     "QueryCapabilities": {
       "title": "Query Capabilities",
       "type": "object",
-      "required": [
-        "nested_fields"
-      ],
       "properties": {
         "aggregates": {
           "description": "Does the connector support aggregate queries",
@@ -128,6 +125,7 @@
         },
         "nested_fields": {
           "description": "Does the connector support nested fields",
+          "default": {},
           "allOf": [
             {
               "$ref": "#/definitions/NestedFieldCapabilities"
@@ -165,6 +163,17 @@
               "type": "null"
             }
           ]
+        },
+        "aggregates": {
+          "description": "Does the connector support aggregating values within nested fields",
+          "anyOf": [
+            {
+              "$ref": "#/definitions/LeafCapability"
+            },
+            {
+              "type": "null"
+            }
+          ]
         }
       }
     },
@@ -1182,6 +1191,16 @@
               "description": "The column to apply the count aggregate function to",
               "type": "string"
             },
+            "field_path": {
+              "description": "Path to a nested field within an object column",
+              "type": [
+                "array",
+                "null"
+              ],
+              "items": {
+                "type": "string"
+              }
+            },
             "distinct": {
               "description": "Whether or not only distinct items should be counted",
               "type": "boolean"
@@ -1206,6 +1225,16 @@
               "description": "The column to apply the aggregation function to",
               "type": "string"
             },
+            "field_path": {
+              "description": "Path to a nested field within an object column",
+              "type": [
+                "array",
+                "null"
+              ],
+              "items": {
+                "type": "string"
+              }
+            },
             "function": {
               "description": "Single column aggregate function name.",
               "type": "string"
@@ -1544,6 +1573,16 @@
               "description": "The column to apply the aggregation function to",
               "type": "string"
             },
+            "field_path": {
+              "description": "Path to a nested field within an object column",
+              "type": [
+                "array",
+                "null"
+              ],
+              "items": {
+                "type": "string"
+              }
+            },
             "function": {
               "description": "Single column aggregate function name.",
               "type": "string"

src/schema/schema.generated.ts

@@ -131,6 +131,10 @@ export type Aggregate =
        * The column to apply the count aggregate function to
        */
       column: string;
+      /**
+       * Path to a nested field within an object column
+       */
+      field_path?: string[] | null;
       /**
        * Whether or not only distinct items should be counted
        */
@@ -142,6 +146,10 @@ export type Aggregate =
        * The column to apply the aggregation function to
        */
       column: string;
+      /**
+       * Path to a nested field within an object column
+       */
+      field_path?: string[] | null;
       /**
        * Single column aggregate function name.
        */
@@ -222,6 +230,10 @@ export type OrderByTarget =
        * The column to apply the aggregation function to
        */
       column: string;
+      /**
+       * Path to a nested field within an object column
+       */
+      field_path?: string[] | null;
       /**
        * Single column aggregate function name.
        */
@@ -398,7 +410,7 @@ export interface QueryCapabilities {
   /**
    * Does the connector support nested fields
    */
-  nested_fields: NestedFieldCapabilities;
+  nested_fields?: NestedFieldCapabilities;
 }
 /**
  * A unit value to indicate a particular leaf capability is supported. This is an empty struct to allow for future sub-capabilities.
@@ -413,6 +425,10 @@ export interface NestedFieldCapabilities {
    * Does the connector support ordering by values of nested fields
    */
   order_by?: LeafCapability | null;
+  /**
+   * Does the connector support aggregating values within nested fields
+   */
+  aggregates?: LeafCapability | null;
 }
 export interface MutationCapabilities {
   /**

typegen/Cargo.toml

@@ -6,7 +6,7 @@ edition = "2021"
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
-ndc-models = { git = "http://github.com/hasura/ndc-spec.git", tag = "v0.1.3" }
+ndc-models = { git = "http://github.com/hasura/ndc-spec.git", tag = "v0.1.4" }
 schemars = "0.8.15"
 serde = "^1.0"
 serde_json = "1.0.107"