set allowrelaxedtypes to true for all apis (#85)

Author: m-Bilal

changelog.md

@@ -2,6 +2,8 @@
 
 ## Unreleased
 
+- Set `allowrelaxedtypes` annotation for every function (API) ([#85](https://github.com/hasura/ndc-open-api-lambda/pull/85)) 
+
 - Fix param parsing of `anyOf`, `allOf` and `oneOf` ([#83](https://github.com/hasura/ndc-open-api-lambda/pull/83))
 
 

src/app/generator/functions-ts-generator.ts

@@ -24,10 +24,15 @@ export async function generateFunctionsTsCode(
       description: routeTypes.getDescription(route.route),
       request: routeTypes.getFormattedRouteName(route.route),
       isGetRequest: routeTypes.isGetRequest(route.route),
-      requiresRelaxedTypeAnnotation: requiresRelaxedTypeAnnotation(
-        route.params,
-        route.returnType,
-      ),
+
+      // set requiresRelaxedTypeAnnotation to `true` for everything for now becuase it does not cause issues with types that don't need it
+      requiresRelaxedTypeAnnotation: true,
+
+      // previous implementation
+      // requiresRelaxedTypeAnnotation: requiresRelaxedTypeAnnotation(
+      //   route.params,
+      //   route.returnType,
+      // ),
     });
 
     const namespace = routeTypes.getNamespace(route.route);

tests/test-data/golden-files/1password

@@ -45,6 +45,7 @@ export async function getActivityGetApiActivity(
 /**
  * Get state of the server and its dependencies.
  * @request GET :/health
+ * @allowrelaxedtypes
  * @readonly
  */
 export async function getHealthGetServerHealth(
@@ -70,6 +71,7 @@ export async function getHealthGetServerHealth(
 /**
  * Ping the server for liveness
  * @request GET :/heartbeat
+ * @allowrelaxedtypes
  * @readonly
  */
 export async function getHeartbeatGetHeartbeat(
@@ -90,6 +92,7 @@ export async function getHeartbeatGetHeartbeat(
 /**
  * Query server for exposed Prometheus metrics
  * @request GET :/metrics
+ * @allowrelaxedtypes
  * @readonly
  */
 export async function getMetricsGetPrometheusMetrics(
@@ -215,6 +218,7 @@ export async function postVaultsCreateVaultItem(
 /**
  * Delete an Item
  * @request DELETE :/vaults/{vaultUuid}/items/{itemUuid}
+ * @allowrelaxedtypes
  */
 export async function deleteVaultsDeleteVaultItem(
   /** The UUID of the Vault the item is in */
@@ -325,6 +329,7 @@ export async function putVaultsUpdateVaultItem(
 /**
  * Get all the files inside an Item
  * @request GET :/vaults/{vaultUuid}/items/{itemUuid}/files
+ * @allowrelaxedtypes
  * @readonly
  */
 export async function getVaultsGetItemFiles(
@@ -356,6 +361,7 @@ export async function getVaultsGetItemFiles(
 /**
  * Get the details of a File
  * @request GET :/vaults/{vaultUuid}/items/{itemUuid}/files/{fileUuid}
+ * @allowrelaxedtypes
  * @readonly
  */
 export async function getVaultsGetDetailsOfFileById(
@@ -390,6 +396,7 @@ export async function getVaultsGetDetailsOfFileById(
 /**
  * Get the content of a File
  * @request GET :/vaults/{vaultUuid}/items/{itemUuid}/files/{fileUuid}/content
+ * @allowrelaxedtypes
  * @readonly
  */
 export async function getVaultsDownloadFileById(

tests/test-data/golden-files/acko-insurance

@@ -8,6 +8,7 @@ const api = new Api({
 /**
  * Insurance Policy - Car
  * @request POST :/cripc/certificate
+ * @allowrelaxedtypes
  */
 export async function postCripcCripc(
   /** Request body */
@@ -52,6 +53,7 @@ export async function postCripcCripc(
 /**
  * Insurance Policy - Health
  * @request POST :/hlipc/certificate
+ * @allowrelaxedtypes
  */
 export async function postHlipcHlipc(
   /** Request body */
@@ -96,6 +98,7 @@ export async function postHlipcHlipc(
 /**
  * Insurance Policy - Two Wheeler
  * @request POST :/twipc/certificate
+ * @allowrelaxedtypes
  */
 export async function postTwipcTwipc(
   /** Request body */