Update to TS SDK v4.4.0 (NDC Spec v0.1.2) (#29)

Author: daniel-chambers

CHANGELOG.md

@@ -9,6 +9,9 @@ Changes to be included in the next upcoming release
 
 - Fixed watch mode not reloading after files with compiler errors are changed [#27](https://github.com/hasura/ndc-nodejs-lambda/pull/27)
 - Fixed functions that are imported then re-exported causing a crash [#28](https://github.com/hasura/ndc-nodejs-lambda/pull/28)
+- Support for NDC Spec v0.1.2 via the NDC TypeScript SDK v4.4.0 ([#29](https://github.com/hasura/ndc-nodejs-lambda/pull/29)).
+  - Built-in scalar types that support equality now define it in the NDC schema.
+  - Built-in scalar types now have an explicit type representation defined in the NDC schema.
 
 ## [1.2.0] - 2024-03-18
 - Improved error messages when unsupported enum types or unions of literal types are found, and allow these types to be used in relaxed types mode ([#17](https://github.com/hasura/ndc-nodejs-lambda/pull/17))

README.md

@@ -6,7 +6,7 @@ The Node.js Lambda connector allows you to expose TypeScript functions as NDC fu
 > Hasura DDN Alpha users should use 0.x versions of the `ndc-lambda-sdk`. v1.x versions of the `ndc-lambda-sdk` support the forthcoming Hasura DDN Beta.
 
 ## How to Use
-First, ensure you have Node.js v18+ installed. Then, create a directory into which you will create your functions using the `hasura-ndc-nodejs-lambda` Yeoman template.
+First, ensure you have Node.js v20+ installed. Then, create a directory into which you will create your functions using the `hasura-ndc-nodejs-lambda` Yeoman template.
 
 ```bash
 mkdir my-functions

connector-definition/template/package.json

@@ -1,7 +1,7 @@
 {
   "private": true,
   "engines": {
-    "node": ">=18"
+    "node": ">=20"
   },
   "scripts": {
     "start": "ndc-lambda-sdk host -f functions.ts serve --configuration ./",

ndc-lambda-sdk/package-lock.json

@@ -30,15 +30,15 @@
     "url": "git+https://github.com/hasura/ndc-nodejs-lambda.git"
   },
   "dependencies": {
-    "@hasura/ndc-sdk-typescript": "^4.2.1",
-    "@tsconfig/node20": "^20.1.2",
+    "@hasura/ndc-sdk-typescript": "^4.4.0",
+    "@tsconfig/node20": "^20.1.3",
     "commander": "^11.1.0",
     "cross-spawn": "^7.0.3",
     "p-limit": "^3.1.0",
-    "ts-api-utils": "^1.0.3",
+    "ts-api-utils": "^1.3.0",
     "ts-node": "^10.9.2",
     "ts-node-dev": "^2.0.0",
-    "typescript": "^5.4.2"
+    "typescript": "^5.4.3"
   },
   "devDependencies": {
     "@types/chai": "^4.3.11",

ndc-lambda-sdk/package.json

@@ -67,7 +67,7 @@ export function createConnector(options: ConnectorOptions): sdk.Connector<Config
 
     getCapabilities: function (configuration: Configuration): sdk.CapabilitiesResponse {
       return {
-        version: "0.1.0",
+        version: "0.1.2",
         capabilities: {
           query: {
             variables: {}

ndc-lambda-sdk/src/connector.ts

@@ -1,5 +1,5 @@
 import * as sdk from "@hasura/ndc-sdk-typescript";
-import { mapObjectValues, unreachable } from "./util";
+import { mapObjectValues, throwError, unreachable } from "./util";
 
 export type FunctionsSchema = {
   functions: FunctionDefinitions
@@ -242,10 +242,19 @@ export function getNdcSchema(functionsSchema: FunctionsSchema): sdk.SchemaRespon
     }
   });
 
-  const scalarTypes = mapObjectValues(functionsSchema.scalarTypes, _scalar_def => {
-    return {
-      aggregate_functions: {},
-      comparison_operators: {},
+  const scalarTypes: Record<string, sdk.ScalarType> = mapObjectValues(functionsSchema.scalarTypes, (scalarDef, scalarTypeName) => {
+    switch (scalarDef.type) {
+      case "built-in":
+        return isTypeNameBuiltInScalar(scalarTypeName)
+          ? convertBuiltInScalarTypeIntoSdkSchemaType(scalarTypeName)
+          : throwError(`built-in scalar type with unexpected name: ${scalarTypeName}`);
+      case "relaxed-type":
+        return {
+          aggregate_functions: {},
+          comparison_operators: {},
+        };
+      default:
+        return unreachable(scalarDef["type"]);
     }
   })
 
@@ -271,6 +280,42 @@ function convertTypeReferenceToSdkType(typeRef: TypeReference): sdk.Type {
   }
 }
 
+function convertBuiltInScalarTypeIntoSdkSchemaType(typeName: BuiltInScalarTypeName): sdk.ScalarType {
+  switch (typeName) {
+    case BuiltInScalarTypeName.String: return {
+      representation: { type: "string" },
+      aggregate_functions: {},
+      comparison_operators: { "_eq": { type: "equal" } },
+    };
+    case BuiltInScalarTypeName.Float: return {
+      representation: { type: "float64" },
+      aggregate_functions: {},
+      comparison_operators: { "_eq": { type: "equal" } },
+    };
+    case BuiltInScalarTypeName.Boolean: return {
+      representation: { type: "boolean" },
+      aggregate_functions: {},
+      comparison_operators: { "_eq": { type: "equal" } },
+    };
+    case BuiltInScalarTypeName.BigInt: return {
+      representation: { type: "int64" }, // NDC doesn't have a good representation for this type as at v0.1.2, so this is the best representation in the meantime
+      aggregate_functions: {},
+      comparison_operators: { "_eq": { type: "equal" } },
+    };
+    case BuiltInScalarTypeName.DateTime: return {
+      representation: { type: "timestamp" },
+      aggregate_functions: {},
+      comparison_operators: { "_eq": { type: "equal" } },
+    };
+    case BuiltInScalarTypeName.JSON: return {
+      representation: { type: "json" },
+      aggregate_functions: {},
+      comparison_operators: {},
+    };
+    default: return unreachable(typeName);
+  }
+}
+
 function convertFunctionDefinitionToSdkSchemaType(function_name: string, definition: FunctionDefinition): sdk.FunctionInfo | sdk.ProcedureInfo {
   const args =
     definition.arguments