@scalar/api-client 0.2.0 → 0.2.1

package/src/stores/apiClientStore.ts

@@ -0,0 +1,57 @@
+import { reactive, readonly } from 'vue'
+
+type State = {
+  showApiClient: boolean
+  activeApiClientEndpointId: string
+  activeItem: any
+  snippetType: string
+  activeSidebar: string
+}
+
+function defaultState(): State {
+  return {
+    showApiClient: false,
+    activeApiClientEndpointId: '',
+    activeItem: {},
+    snippetType: 'javascript',
+    activeSidebar: '',
+  }
+}
+
+const state = reactive<State>(defaultState())
+
+function toggleApiClient(item?: any, forceShow = false) {
+  if (forceShow) {
+    state.showApiClient = true
+  } else {
+    state.showApiClient = !state.showApiClient
+  }
+  if (item) {
+    state.activeItem = item
+  }
+}
+
+function hideApiClient() {
+  state.showApiClient = false
+}
+
+function setActiveApiClientEndpointId(id: string) {
+  state.activeApiClientEndpointId = id
+}
+
+function setSnippetType(type: string) {
+  state.snippetType = type
+}
+
+function setActiveSidebar(item: string) {
+  state.activeSidebar = item
+}
+
+export const useApiClientStore = () => ({
+  state: readonly(state),
+  toggleApiClient,
+  setActiveApiClientEndpointId,
+  setSnippetType,
+  setActiveSidebar,
+  hideApiClient,
+})

package/src/stores/index.ts

@@ -0,0 +1,5 @@
+export { useApiClientStore } from './apiClientStore'
+export {
+  useApiClientRequestStore,
+  createEmptyAuthState,
+} from './apiClientRequestStore'

package/src/types.ts

@@ -0,0 +1,181 @@
+export type BasicAuth = {
+  userName: string
+  password: string
+  active: boolean
+}
+
+export type OAuthTwo = {
+  generatedToken: string
+  discoveryURL: string
+  authURL: string
+  accessTokenURL: string
+  clientID: string
+  clientSecret: string
+  scope: string
+  active: boolean
+}
+
+export type Bearer = {
+  token: string
+  active: boolean
+}
+
+export type Digest = {
+  userName: string
+  password: string
+  active: boolean
+}
+
+export type AuthType = 'basic' | 'oauthTwo' | 'bearer' | 'digest' | 'none'
+
+export type AuthState = {
+  type: AuthType
+  basic: BasicAuth
+  oauthTwo: OAuthTwo
+  bearer: Bearer
+  digest: Digest
+}
+
+export type BaseParameter = {
+  name: string
+  value: string | number
+  customClass?: string
+}
+
+export type Header = BaseParameter
+
+export type Query = BaseParameter
+
+export type FormDataItem = BaseParameter
+
+/** Complete request state for a client request */
+export type ClientRequestConfig = {
+  id?: string
+  name: string
+  url: string
+  /** HTTP Request Method */
+  type: string
+  /** Request path */
+  path: string
+  /** Path parameters */
+  parameters: BaseParameter[]
+  /** Query parameters */
+  query: Query[]
+  /** Request headers */
+  headers: Header[]
+  /** Content type matched body */
+  body: string
+  /** Optional form data body */
+  formData?: FormDataItem[]
+}
+
+/** Formatted request for the proxy server */
+export type ProxyPayload = {
+  method: string
+  url: string
+  body: string
+  headers: Header[]
+  auth: Record<string, string>
+  grpc: boolean
+}
+
+/** Client response from the proxy */
+export type ClientResponse = {
+  cookies: Record<string, string>
+  headers: Record<string, string>
+  statusCode: number
+  statusText: string
+  data: string
+  duration: number
+}
+
+export type RequestResult = {
+  request: ClientRequestConfig
+  response: ClientResponse
+  responseId: string
+  sentTime: number
+}
+
+export type Schema = {
+  format: string
+  type: string
+}
+
+export type Parameters = {
+  description?: string
+  in?: string
+  name: string
+  required?: boolean
+  schema?: Schema
+}
+
+export type Security = {
+  api_key?: any[]
+  petstore_auth?: string[]
+}
+
+export type ContentProperties = {
+  [key: string]: {
+    type: string
+    format: string
+    example: string
+    required: string[]
+    description?: string
+    properties?: ContentProperties
+  }
+}
+
+export type ContentSchema = {
+  schema: {
+    type: string
+    required: string[]
+    properties: ContentProperties
+  }
+}
+
+export type ContentType =
+  | 'application/json'
+  | 'application/xml'
+  | 'text/plain'
+  | 'text/html'
+  | 'application/x-www-form-urlencoded'
+  | 'multipart/form-data'
+
+export type Content = {
+  [key in ContentType]: ContentSchema
+}
+
+export type RequestBody = {
+  description: string
+  content: Content
+  required: boolean
+}
+
+export type Response = {
+  description: string
+  content: any
+}
+
+export type Information = {
+  description: string
+  operationId: string
+  parameters: Parameters[]
+  responses: Record<string, Response>
+  security: Security[]
+  requestBody: RequestBody
+  summary: string
+  tags: string[]
+}
+
+export type Operation = {
+  httpVerb: string
+  path: string
+  operationId: string
+  name: string
+  description: string
+  information: Information
+}
+
+export type Server = {
+  url: string
+}