feat: Add getOpenapiSchema

Author: razor-x

generate-routes.ts

@@ -144,7 +144,7 @@ const createEndpoint = (
   routePath: string,
   endpointPath: string,
 ): Endpoint => {
-  if (!isOpenApiPath(endpointPath)) {
+  if (!isOpenapiPath(endpointPath)) {
     throw new Error(`Did not find ${endpointPath} in OpenAPI spec`)
   }
   const spec = openapi.paths[endpointPath]
@@ -174,7 +174,7 @@ const deriveResource = (
     return endpointResources[endpointPath] ?? null
   }
 
-  if (isOpenApiPath(endpointPath)) {
+  if (isOpenapiPath(endpointPath)) {
     const spec = openapi.paths[endpointPath]
     const methodKey = method.toLowerCase()
 
@@ -213,7 +213,7 @@ const isEndpointResource = (
   key: string,
 ): key is keyof typeof endpointResources => key in endpointResources
 
-const isOpenApiPath = (key: string): key is keyof typeof openapi.paths =>
+const isOpenapiPath = (key: string): key is keyof typeof openapi.paths =>
   key in openapi.paths
 
 const isEndpointUnderRoute = (

package-lock.json

@@ -118,6 +118,7 @@
     "eslint-plugin-unused-imports": "^3.0.0",
     "execa": "^8.0.1",
     "landlubber": "^1.0.0",
+    "nock": "^13.4.0",
     "node-fetch": "^3.3.2",
     "prettier": "^3.0.0",
     "tsc-alias": "^1.8.2",

package.json

@@ -1,5 +1,6 @@
 export { SeamHttpInvalidTokenError } from './auth.js'
 export * from './error-interceptor.js'
+export * from './openapi.js'
 export * from './options.js'
 export {
   isSeamActionAttemptError,

src/lib/seam/connect/index.ts

@@ -0,0 +1,17 @@
+import type { openapi } from '@seamapi/types/connect'
+
+import { createClient } from './client.js'
+import { defaultEndpoint, sdkHeaders } from './parse-options.js'
+
+export const getOpenapiSchema = async (
+  endpoint = defaultEndpoint,
+): Promise<typeof openapi> => {
+  const client = createClient({
+    axiosOptions: {
+      baseURL: endpoint,
+      headers: sdkHeaders,
+    },
+  })
+  const { data } = await client.get<typeof openapi>('/openapi.json')
+  return data
+}

src/lib/seam/connect/openapi.ts

@@ -11,9 +11,9 @@ import {
   type SeamHttpRequestOptions,
 } from './options.js'
 
-const defaultEndpoint = 'https://connect.getseam.com'
+export const defaultEndpoint = 'https://connect.getseam.com'
 
-const sdkHeaders = {
+export const sdkHeaders = {
   'seam-sdk-name': 'seamapi/javascript-http',
   'seam-sdk-version': version,
 }

src/lib/seam/connect/parse-options.ts

@@ -0,0 +1,17 @@
+import { getOpenapiSchema } from '@seamapi/http/connect'
+import { openapi } from '@seamapi/types/connect'
+import test from 'ava'
+import { getTestServer } from 'fixtures/seam/connect/api.js'
+import nock from 'nock'
+
+
+test('SeamHttp: getOpenapiSchema returns data', async (t) => {
+  const { endpoint } = await getTestServer(t)
+
+  // UPSTREAM: Must use nock since fake-seam-connect returns 404 for /openapi.json.
+  // https://github.com/seamapi/fake-seam-connect/issues/132
+  nock(endpoint).get('/openapi.json').reply(200, openapi)
+
+  const data = await getOpenapiSchema(endpoint)
+  t.truthy(data.info.title)
+})