@scalar/api-client 0.5.1 → 0.5.2

package/src/fixtures/httpStatusCodes.ts

@@ -1,259 +0,0 @@
-export type HttpStatusCode = {
-  name: string
-  url: string
-}
-
-export type HttpStatusCodes = Record<string, HttpStatusCode>
-
-export const httpStatusCodes: HttpStatusCodes = {
-  100: {
-    name: 'Continue',
-    url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/100',
-  },
-  101: {
-    name: 'Switching Protocols',
-    url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/101',
-  },
-  102: {
-    name: 'Processing',
-    url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/102',
-  },
-  103: {
-    name: 'Early Hints',
-    url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/103',
-  },
-  200: {
-    name: 'OK',
-    url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200',
-  },
-  201: {
-    name: 'Created',
-    url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/201',
-  },
-  202: {
-    name: 'Accepted',
-    url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/202',
-  },
-  203: {
-    name: 'Non-Authoritative Information',
-    url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/203',
-  },
-  204: {
-    name: 'No Content',
-    url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/204',
-  },
-  205: {
-    name: 'Reset Content',
-    url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/205',
-  },
-  206: {
-    name: 'Partial Content',
-    url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/206',
-  },
-  207: {
-    name: 'Multi-Status',
-    url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/207',
-  },
-  208: {
-    name: 'Already Reported',
-    url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/208',
-  },
-  226: {
-    name: 'IM Used',
-    url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/226',
-  },
-  300: {
-    name: 'Multiple Choices',
-    url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/300',
-  },
-  301: {
-    name: 'Moved Permanently',
-    url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/301',
-  },
-  302: {
-    name: 'Found',
-    url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/302',
-  },
-  303: {
-    name: 'See Other',
-    url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/303',
-  },
-  304: {
-    name: 'Not Modified',
-    url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/304',
-  },
-  305: {
-    name: 'Use Proxy',
-    url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/305',
-  },
-  306: {
-    name: '(Unused)',
-    url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/306',
-  },
-  307: {
-    name: 'Temporary Redirect',
-    url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/307',
-  },
-  308: {
-    name: 'Permanent Redirect',
-    url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/308',
-  },
-  400: {
-    name: 'Bad Request',
-    url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/400',
-  },
-  401: {
-    name: 'Unauthorized',
-    url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/401',
-  },
-  402: {
-    name: 'Payment Required',
-    url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/402',
-  },
-  403: {
-    name: 'Forbidden',
-    url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/403',
-  },
-  404: {
-    name: 'Not Found',
-    url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/404',
-  },
-  405: {
-    name: 'Method Not Allowed',
-    url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/405',
-  },
-  406: {
-    name: 'Not Acceptable',
-    url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/406',
-  },
-  407: {
-    name: 'Proxy Authentication Required',
-    url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/407',
-  },
-  408: {
-    name: 'Request Timeout',
-    url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408',
-  },
-  409: {
-    name: 'Conflict',
-    url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/409',
-  },
-  410: {
-    name: 'Gone',
-    url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/410',
-  },
-  411: {
-    name: 'Length Required',
-    url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/411',
-  },
-  412: {
-    name: 'Precondition Failed',
-    url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/412',
-  },
-  413: {
-    name: 'Content Too Large',
-    url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/413',
-  },
-  414: {
-    name: 'URI Too Long',
-    url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/414',
-  },
-  415: {
-    name: 'Unsupported Media Type',
-    url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/415',
-  },
-  416: {
-    name: 'Range Not Satisfiable',
-    url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/416',
-  },
-  417: {
-    name: 'Expectation Failed',
-    url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/417',
-  },
-  421: {
-    name: 'Misdirected Request',
-    url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/421',
-  },
-  422: {
-    name: 'Unprocessable Content',
-    url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/422',
-  },
-  423: {
-    name: 'Locked',
-    url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/423',
-  },
-  424: {
-    name: 'Failed Dependency',
-    url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/424',
-  },
-  425: {
-    name: 'Too Early',
-    url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/425',
-  },
-  426: {
-    name: 'Upgrade Required',
-    url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/426',
-  },
-  428: {
-    name: 'Precondition Required',
-    url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/428',
-  },
-  429: {
-    name: 'Too Many Requests',
-    url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429',
-  },
-  431: {
-    name: 'Request Header Fields Too Large',
-    url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/431',
-  },
-  451: {
-    name: 'Unavailable For Legal Reasons',
-    url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/451',
-  },
-  500: {
-    name: 'Internal Server Error',
-    url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500',
-  },
-  501: {
-    name: 'Not Implemented',
-    url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/501',
-  },
-  502: {
-    name: 'Bad Gateway',
-    url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/502',
-  },
-  503: {
-    name: 'Service Unavailable',
-    url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/503',
-  },
-  504: {
-    name: 'Gateway Timeout',
-    url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/504',
-  },
-  505: {
-    name: 'HTTP Version Not Supported',
-    url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/505',
-  },
-  506: {
-    name: 'Variant Also Negotiates',
-    url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/506',
-  },
-  507: {
-    name: 'Insufficient Storage',
-    url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/507',
-  },
-  508: {
-    name: 'Loop Detected',
-    url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/508',
-  },
-  510: {
-    name: 'Not Extended',
-    url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/510',
-  },
-  511: {
-    name: 'Network Authentication Required',
-    url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/511',
-  },
-}
-
-export default httpStatusCodes

package/src/fixtures/index.ts

@@ -1,6 +0,0 @@
-export { httpHeaders, type HttpHeader } from './httpHeaders'
-export {
-  default as httpStatusCodes,
-  type HttpStatusCode,
-  type HttpStatusCodes,
-} from './httpStatusCodes'

package/src/helpers/concatenateUrlAndPath.test.ts

@@ -1,27 +0,0 @@
-import { describe, expect, it } from 'vitest'
-
-import { concatenateUrlAndPath } from './'
-
-describe('concatenateUrlAndPath', () => {
-  it('trims a slash from the URL', async () => {
-    expect(concatenateUrlAndPath('http://127.0.0.1/', 'foobar')).toBe(
-      'http://127.0.0.1/foobar',
-    )
-  })
-
-  it('adds a slash between url and path', async () => {
-    expect(concatenateUrlAndPath('http://127.0.0.1', 'foobar')).toBe(
-      'http://127.0.0.1/foobar',
-    )
-  })
-
-  it('trims a slash from the path', async () => {
-    expect(concatenateUrlAndPath('http://127.0.0.1', '/foobar')).toBe(
-      'http://127.0.0.1/foobar',
-    )
-  })
-
-  it('works without a path', async () => {
-    expect(concatenateUrlAndPath('http://127.0.0.1')).toBe('http://127.0.0.1')
-  })
-})

package/src/helpers/concatenateUrlAndPath.ts

@@ -1,13 +0,0 @@
-/**
- * Make sure the URL and path are concatenated correctly.
- */
-export const concatenateUrlAndPath = (url: string, path?: string) => {
-  if (typeof path !== 'string' || !path.length) {
-    return url
-  }
-
-  const urlWithSlash = url.endsWith('/') ? url : `${url}/`
-  const pathWithoutSlash = path.startsWith('/') ? path.slice(1) : path
-
-  return [urlWithSlash, pathWithoutSlash].join('')
-}

package/src/helpers/createPlaceholderRequest.ts

@@ -1,16 +0,0 @@
-import type { ClientRequestConfig } from '../types'
-
-/**
- * Generate a new placeholder request
- */
-export const createPlaceholderRequest = (): ClientRequestConfig => ({
-  name: '',
-  url: '',
-  type: 'GET',
-  path: '',
-  parameters: [],
-  headers: [],
-  query: [],
-  body: '',
-  formData: [],
-})

package/src/helpers/generateParameters.ts

@@ -1,19 +0,0 @@
-import type { BaseParameter, Parameters } from '../types'
-
-/**
- * Generate parameters for the request from the parameters in the swagger file
- */
-export function generateParameters(parameters: Parameters[]) {
-  const params: BaseParameter[] = []
-  parameters.forEach((parameter: Parameters) => {
-    const param: BaseParameter = {
-      name: parameter.name,
-      value: '',
-      customClass: parameter.required ? 'required-parameter' : '',
-    }
-    param.value = ''
-    params.push(param)
-  })
-
-  return params
-}

package/src/helpers/generateRequest.ts

@@ -1,26 +0,0 @@
-import { type ParamMap } from '../hooks/useOperation'
-import type { ClientRequestConfig, Operation, Server } from '../types'
-import { generateParameters } from './generateParameters'
-
-/**
- * Generate parameters for the request
- */
-export function generateRequest(
-  operation: Operation,
-  parameterMap: ParamMap,
-  server: Server,
-): ClientRequestConfig {
-  const item = {
-    id: operation.operationId,
-    name: operation.name,
-    type: operation.httpVerb,
-    path: operation.path,
-    parameters: generateParameters(parameterMap.path),
-    query: generateParameters(parameterMap.query),
-    headers: generateParameters(parameterMap.header),
-    url: server.url,
-    body: '',
-  }
-
-  return item
-}

package/src/helpers/index.ts

@@ -1,10 +0,0 @@
-export { concatenateUrlAndPath } from './concatenateUrlAndPath'
-export { createPlaceholderRequest } from './createPlaceholderRequest'
-export { generateParameters } from './generateParameters'
-export { generateRequest } from './generateRequest'
-export { mapFromArray } from './mapFromArray'
-export { normalizePath } from './normalizePath'
-export { normalizeRequestMethod } from './normalizeRequestMethod'
-export { normalizeUrl } from './normalizeUrl'
-export { replaceVariables } from './replaceVariables'
-export { sendRequest } from './sendRequest'

package/src/helpers/mapFromArray.ts

@@ -1,16 +0,0 @@
-/**
- * A utility function to convert an array of objects to an object of objects.
- */
-export function mapFromArray<
-  T extends Record<string, unknown>,
-  K extends keyof T & string,
-  V extends keyof T & string,
->(arr: T[], key: K, valueKey: V) {
-  const obj: Record<string, T[V]> = {}
-
-  arr.forEach((entry) => {
-    obj[entry[key] as string] = entry[valueKey]
-  })
-
-  return obj
-}

package/src/helpers/normalizePath.test.ts

@@ -1,17 +0,0 @@
-import { describe, expect, it } from 'vitest'
-
-import { normalizePath } from './'
-
-describe('normalizePath', () => {
-  it('keeps a path as is', async () => {
-    expect(normalizePath('foobar')).toBe('foobar')
-  })
-
-  it('removes slash', async () => {
-    expect(normalizePath('/foobar')).toBe('foobar')
-  })
-
-  it('trims whitespace', async () => {
-    expect(normalizePath('foobar ')).toBe('foobar')
-  })
-})

package/src/helpers/normalizePath.ts

@@ -1,16 +0,0 @@
-/**
- * Normalizes a path by removing leading slashes.
- */
-export const normalizePath = (path?: string) => {
-  if (typeof path !== 'string') {
-    return ''
-  }
-
-  let normalizedPath = path.trim()
-
-  if (normalizedPath.startsWith('/')) {
-    normalizedPath = normalizedPath.slice(1)
-  }
-
-  return normalizedPath
-}

package/src/helpers/normalizeRequestMethod.test.ts

@@ -1,29 +0,0 @@
-import { describe, expect, it } from 'vitest'
-
-import { normalizeRequestMethod } from './'
-
-describe('normalizeRequestMethod', () => {
-  it('returns a valid request method', async () => {
-    expect(normalizeRequestMethod('GET')).toBe('GET')
-  })
-
-  it('makes method uppercase', async () => {
-    expect(normalizeRequestMethod('get')).toBe('GET')
-  })
-
-  it('return uppercase POST', async () => {
-    expect(normalizeRequestMethod('post')).toBe('POST')
-  })
-
-  it('trims whitespace', async () => {
-    expect(normalizeRequestMethod('post ')).toBe('POST')
-  })
-
-  it('uses GET as the default', async () => {
-    expect(normalizeRequestMethod()).toBe('GET')
-  })
-
-  it('ignores invalid request methods', async () => {
-    expect(normalizeRequestMethod('fantasy')).toBe('GET')
-  })
-})

package/src/helpers/normalizeRequestMethod.ts

@@ -1,43 +0,0 @@
-const defaultRequestMethod = 'GET'
-
-const validRequestMethods = [
-  'GET',
-  'POST',
-  'PUT',
-  'HEAD',
-  'DELETE',
-  'PATCH',
-  'OPTIONS',
-  'CONNECT',
-  'TRACE',
-]
-
-/**
- * Get a normalized request method (e.g. GET, POST, etc.)
- */
-export const normalizeRequestMethod = (method?: string) => {
-  // Make sure it’s a string
-  if (typeof method !== 'string') {
-    console.warn(
-      `[sendRequest] Request method is not a string. Using ${defaultRequestMethod} as the default.`,
-    )
-
-    return defaultRequestMethod
-  }
-
-  // Normalize the string
-  const normalizedMethod = method.trim().toUpperCase()
-
-  // Make sure it’s a valid request method
-  const isValidRequestMethod = validRequestMethods.includes(normalizedMethod)
-
-  if (!isValidRequestMethod) {
-    console.warn(
-      `[sendRequest] ${method} is not a valid request method. Using ${defaultRequestMethod} as the default.`,
-    )
-
-    return defaultRequestMethod
-  }
-
-  return normalizedMethod
-}

package/src/helpers/normalizeUrl.test.ts

@@ -1,25 +0,0 @@
-import { describe, expect, it } from 'vitest'
-
-import { normalizeUrl } from './'
-
-describe('normalizeUrl', () => {
-  it('keeps URLs as is', async () => {
-    expect(normalizeUrl('http://127.0.0.1')).toBe('http://127.0.0.1')
-  })
-
-  it('keeps slashes', async () => {
-    expect(normalizeUrl('http://127.0.0.1/')).toBe('http://127.0.0.1/')
-  })
-
-  it('makes URLs lowercase', async () => {
-    expect(normalizeUrl('http://EXAMPLE.COM')).toBe('http://example.com')
-  })
-
-  it('adds http://', async () => {
-    expect(normalizeUrl('example.com')).toBe('http://example.com')
-  })
-
-  it('trims whitespace', async () => {
-    expect(normalizeUrl('http://example.com ')).toBe('http://example.com')
-  })
-})

package/src/helpers/normalizeUrl.ts

@@ -1,24 +0,0 @@
-/**
- * Normalizes a URL by trimming it and adding http:// as the default prefix.
- */
-export const normalizeUrl = (url?: string) => {
-  if (typeof url !== 'string') {
-    console.warn(
-      `[sendRequest] URL is not a string. Using an empty string as the default.`,
-    )
-
-    return ''
-  }
-
-  let normalizedUrl = url.trim().toLowerCase()
-
-  if (!normalizedUrl.startsWith('http')) {
-    console.warn(
-      `[sendRequest] URL does not start with http. Adding http:// as the default prefix.`,
-    )
-
-    normalizedUrl = `http://${normalizedUrl}`
-  }
-
-  return normalizedUrl
-}

package/src/helpers/replaceVariables.test.ts

@@ -1,13 +0,0 @@
-import { describe, expect, it } from 'vitest'
-
-import { replaceVariables } from './'
-
-describe('replaceVariables', () => {
-  it('replaces variables', async () => {
-    expect(
-      replaceVariables('http://{baseUrl}/foobar', {
-        baseUrl: 'example.com',
-      }),
-    ).toBe('http://example.com/foobar')
-  })
-})

package/src/helpers/replaceVariables.ts

@@ -1,11 +0,0 @@
-/**
- * Replaces variables in a url with the values provided.
- */
-export const replaceVariables = (
-  url: string,
-  variables: Record<string, string | number>,
-) => {
-  return Object.entries(variables).reduce((acc, [key, value]) => {
-    return acc.replace(`{${key}}`, value.toString())
-  }, url)
-}

package/src/helpers/sendRequest.test.ts

@@ -1,50 +0,0 @@
-import { createEchoServer } from '@scalar/echo-server'
-import { describe, expect, it } from 'vitest'
-
-import { sendRequest } from './sendRequest'
-
-const createEchoServerOnAnyPort = (): { address: string; port: number } => {
-  const { listen } = createEchoServer()
-  const instance = listen(0)
-
-  return instance.address()
-}
-
-describe('sendRequest', () => {
-  it('sends requests', async () => {
-    const { port } = createEchoServerOnAnyPort()
-
-    const request = {
-      url: `http://127.0.0.1:${port}`,
-    }
-
-    const result = await sendRequest(request)
-
-    expect(result?.response).toContain({
-      method: 'GET',
-      path: '/',
-    })
-  })
-
-  it('replaces variables', async () => {
-    const { port } = createEchoServerOnAnyPort()
-
-    const request = {
-      url: `http://127.0.0.1:${port}`,
-      path: '{path}',
-      parameters: [
-        {
-          name: 'path',
-          value: 'example',
-        },
-      ],
-    }
-
-    const result = await sendRequest(request)
-
-    expect(result?.response).toContain({
-      method: 'GET',
-      path: '/example',
-    })
-  })
-})