feat: Dynamically determine endpoint resources (#87)

* Use x-fern-sdk-return-value to dynamically determine endpoint resources

* ci: Format code

* ci: Format code

* Move the declaration of openapiResponseKeyProp

* Update seamapi/types

* ci: Generate code

* Add /access_codes/simulate and /noise_sensors/simulate to routePathSubresources

* ci: Generate code

* Remove deriveResourceFromSchema

* ci: Generate code

* Use resource deriving func only for GET response schemas

---------

Co-authored-by: Seam Bot <[email protected]>

Author: andrii-balitskyi

generate-routes.ts

@@ -31,8 +31,11 @@ async function main(): Promise<void> {
   ])
 }
 
+const openapiResponseKeyProp = 'x-fern-sdk-return-value'
+
 const routePaths = [
   '/access_codes',
+  '/access_codes/simulate',
   '/access_codes/unmanaged',
   '/acs',
   '/acs/access_groups',
@@ -54,6 +57,7 @@ const routePaths = [
   '/networks',
   '/noise_sensors',
   '/noise_sensors/noise_thresholds',
+  '/noise_sensors/simulate',
   '/phones',
   '/phones/simulate',
   '/thermostats',
@@ -67,7 +71,7 @@ const routePaths = [
 const routePathSubresources: Partial<
   Record<(typeof routePaths)[number], string[]>
 > = {
-  '/access_codes': ['unmanaged'],
+  '/access_codes': ['unmanaged', 'simulate'],
   '/acs': [
     'access_groups',
     'credential_pools',
@@ -79,41 +83,11 @@ const routePathSubresources: Partial<
   ],
   '/phones': ['simulate'],
   '/devices': ['unmanaged', 'simulate'],
-  '/noise_sensors': ['noise_thresholds'],
+  '/noise_sensors': ['noise_thresholds', 'simulate'],
   '/thermostats': ['climate_setting_schedules'],
   '/user_identities': ['enrollment_automations'],
 }
 
-const ignoredEndpointPaths = [
-  '/access_codes/simulate/create_unmanaged_access_code',
-  '/connect_webviews/view',
-  '/health',
-  '/health/get_health',
-  '/health/get_service_health',
-  '/health/service/[service_name]',
-  '/noise_sensors/simulate/trigger_noise_threshold',
-  '/workspaces/reset_sandbox',
-] as const
-
-const endpointResources: Partial<
-  Record<
-    keyof typeof openapi.paths,
-    null | 'action_attempt' | 'noise_threshold'
-  >
-> = {
-  // Set all ignored endpoints null to simplify code generation.
-  ...ignoredEndpointPaths.reduce((acc, cur) => ({ ...acc, [cur]: null }), {}),
-
-  // These endpoints return a deprecated action attempt or resource.
-  '/access_codes/delete': null,
-  '/access_codes/unmanaged/delete': null,
-  '/access_codes/update': null,
-  '/noise_sensors/noise_thresholds/create': 'noise_threshold',
-  '/noise_sensors/noise_thresholds/delete': null,
-  '/noise_sensors/noise_thresholds/update': null,
-  '/thermostats/climate_setting_schedules/update': null,
-} as const
-
 interface Route {
   namespace: string
   endpoints: Endpoint[]
@@ -139,14 +113,10 @@ interface ClassMeta {
 const createRoutes = (): Route[] => {
   const paths = Object.keys(openapi.paths)
 
-  const unmatchedEndpointPaths = paths
-    .filter(
-      (path) =>
-        !routePaths.some((routePath) => isEndpointUnderRoute(path, routePath)),
-    )
-    .filter(
-      (path) => !(ignoredEndpointPaths as unknown as string[]).includes(path),
-    )
+  const unmatchedEndpointPaths = paths.filter(
+    (path) =>
+      !routePaths.some((routePath) => isEndpointUnderRoute(path, routePath)),
+  )
 
   if (unmatchedEndpointPaths.length > 0) {
     throw new Error(
@@ -206,28 +176,28 @@ const deriveResource = (
   endpointPath: string,
   method: Method,
 ): string | null => {
-  if (isEndpointResource(endpointPath)) {
-    return endpointResources[endpointPath] ?? null
-  }
-
   if (isOpenapiPath(endpointPath)) {
     const spec = openapi.paths[endpointPath]
     const methodKey = method.toLowerCase()
 
     if (methodKey === 'post' && 'post' in spec) {
-      const response = spec.post.responses[200]
-      if (!('content' in response)) return null
-      return deriveResourceFromSchema(
-        response.content['application/json']?.schema?.properties ?? {},
-      )
+      const postSpec = spec.post
+      const openapiEndpointResource =
+        openapiResponseKeyProp in postSpec
+          ? postSpec[openapiResponseKeyProp]
+          : null
+
+      return openapiEndpointResource
     }
 
     if (methodKey === 'get' && 'get' in spec) {
       const response = spec.get.responses[200]
+
       if (!('content' in response)) {
         throw new Error(`Missing resource for ${method} ${endpointPath}`)
       }
-      return deriveResourceFromSchema(
+
+      return deriveResourceFromSchemaForGetRequest(
         response.content['application/json']?.schema?.properties ?? {},
       )
     }
@@ -236,7 +206,9 @@ const deriveResource = (
   throw new Error(`Could not derive resource for ${method} ${endpointPath}`)
 }
 
-const deriveResourceFromSchema = (properties: object): string | null =>
+const deriveResourceFromSchemaForGetRequest = (
+  properties: object,
+): string | null =>
   Object.keys(properties).filter((key) => key !== 'ok')[0] ?? null
 
 const deriveSemanticMethod = (methods: string[]): Method => {
@@ -248,10 +220,6 @@ const deriveSemanticMethod = (methods: string[]): Method => {
   throw new Error(`Could not find valid method in ${methods.join(', ')}`)
 }
 
-const isEndpointResource = (
-  key: string,
-): key is keyof typeof endpointResources => key in endpointResources
-
 const isOpenapiPath = (key: string): key is keyof typeof openapi.paths =>
   key in openapi.paths