@scalar/api-reference 0.1.3 → 0.1.5

package/src/hooks/useSwaggerParser.ts

@@ -1,79 +0,0 @@
-import { useWebWorker } from '@vueuse/core'
-import { nextTick, ref, watch } from 'vue'
-
-import { transformToJson } from '../helpers/transformToJson'
-
-const { data, post } = useWebWorker('/web-worker.js')
-
-const parserResult = ref<Record<any, any>>()
-const parserError = ref<string>('')
-const parserReady = ref(true)
-
-type ErrorObject = { error: string }
-
-/**
- * Takes the content of a swagger file and asynchronously calls the given callback with the result.
- */
-export const useSwaggerParser = () => {
-  const parseSwaggerFile = async (
-    value: string,
-    callback: (result: Record<any, any>) => void,
-  ) => {
-    const jsonValue = transformToJson(value)
-
-    // Send data to WASM parser.
-    const triggeredAction = watch(data, (result: string | ErrorObject) => {
-      // Skip if the value is empty.
-      if (typeof result === 'string' && result === '') {
-        return
-      }
-
-      // Check if the parser had an error.
-      if (typeof result === 'object') {
-        console.warn('[parseSwaggerFile] ERROR:', result.error)
-        parserError.value = result.error
-        return
-      }
-
-      // Something with the Parser went really wrong.
-      if (typeof result === 'undefined') {
-        console.error('[parseSwaggerFile] ERROR: result is undefined')
-        parserError.value =
-          'Something went wrong. The parser failed to parse the content.'
-        return
-      }
-
-      // Execute the given callback.
-      const content = JSON.parse(result)
-
-      // Check if content is empty.
-      if (!content) {
-        return
-      }
-
-      parserError.value = ''
-      parserResult.value = content
-      callback(content)
-
-      // Don’t watch `data` anymore.
-      triggeredAction()
-    })
-
-    post(jsonValue)
-
-    if (parserReady.value) {
-      return
-    }
-
-    await nextTick()
-
-    parserReady.value = true
-  }
-
-  return {
-    parseSwaggerFile,
-    parserResult,
-    parserError,
-    parserReady,
-  }
-}

package/src/index.ts

@@ -1,6 +0,0 @@
-export { default as ApiClientModal } from './components/ApiClientModal.vue'
-export { default as ApiReference } from './components/ApiReference.vue'
-export { default as Sidebar } from './components/Sidebar.vue'
-export { default as RenderedReference } from './components/Content/Content.vue'
-
-export * from './types'

package/src/stores/template.ts

@@ -1,66 +0,0 @@
-/**
- * TODO: This is a copy of projects/web/src/stores/template.ts
- */
-import { type TargetId, availableTargets } from 'httpsnippet-lite'
-import { reactive, readonly } from 'vue'
-
-import { objectMerge } from '../helpers/objectMerge'
-import { setItemFactory, toggleItemFactory } from './utility'
-
-export enum NavState {
-  Guide = 'Guide',
-  Reference = 'Reference',
-}
-
-type TemplateState = {
-  isDark: boolean
-  showSideBar: boolean
-  showSearch: boolean
-  activeNavState: NavState
-  collapsedSidebarItems: Partial<Record<string, boolean>>
-  preferredLanguage: TargetId | 'axios' | 'laravel'
-}
-
-const defaultTemplateState = (): TemplateState => ({
-  isDark: false,
-  showSearch: false,
-  showSideBar: true,
-  activeNavState: NavState.Guide,
-  collapsedSidebarItems: {},
-  preferredLanguage: 'shell',
-})
-
-const state = reactive<TemplateState>(defaultTemplateState())
-
-function resetState() {
-  objectMerge(state, defaultTemplateState())
-}
-
-function toggleCollapsedSidebarItem(key: string) {
-  state.collapsedSidebarItems[key] = !state.collapsedSidebarItems[key] ?? true
-}
-
-function setCollapsedSidebarItem(key: string, value: boolean) {
-  state.collapsedSidebarItems[key] = value
-}
-
-// getLanguageTitleByKey('javascript') => 'JavaScript'
-function getLanguageTitleByKey(language: TargetId | 'axios' | 'laravel') {
-  if (language === 'axios') {
-    return 'JavaScript (Axios)'
-  } else if (language === 'laravel') {
-    return 'PHP (Laravel)'
-  }
-
-  return availableTargets().find((target) => language === target.key)?.title
-}
-
-export const useTemplateStore = () => ({
-  state: readonly(state),
-  resetState,
-  setItem: setItemFactory(state),
-  toggleItem: toggleItemFactory(state),
-  toggleCollapsedSidebarItem,
-  setCollapsedSidebarItem,
-  getLanguageTitleByKey,
-})

package/src/stores/utility.ts

@@ -1,23 +0,0 @@
-/**
- * TODO: This is a copy of projects/web/src/stores/utility.ts
- */
-export type KeyOfType<T, V> = keyof {
-  [P in keyof T as T[P] extends V ? P : never]: any
-}
-
-/** Generic set item for a given store state */
-export function setItemFactory<State extends object>(state: State) {
-  return function setItem<K extends keyof State>(key: K, value: State[K]) {
-    state[key] = value
-  }
-}
-
-export function toggleItemFactory<State extends object>(state: State) {
-  return function toggleItem(key: KeyOfType<State, boolean>) {
-    if (typeof state[key] === 'boolean') {
-      // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-      // @ts-ignore
-      state[key] = !state[key]
-    }
-  }
-}

package/src/types.ts

@@ -1,151 +0,0 @@
-export type ReferenceProps = {
-  documentName?: string
-  token?: string
-  username?: string
-  isEditable?: boolean
-  showSidebar?: boolean
-  footerBelowSidebar?: boolean
-}
-
-export type Security = {
-  api_key?: any[]
-  petstore_auth?: string[]
-}
-export type Schema = {
-  format: string
-  type: string
-}
-
-export type Parameters = {
-  description?: string
-  in?: string
-  name: string
-  required?: boolean
-  schema?: Schema
-}
-
-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 TransformedOperation = Operation & {
-  responses: Record<
-    string,
-    Response & {
-      headers: Record<
-        string,
-        {
-          description: string
-          schema: {
-            type: string
-            format?: string
-          }
-        }
-      >
-    }
-  >
-}
-
-export type Tag = {
-  name: string
-  description: string
-  operations: TransformedOperation[]
-}
-export type Parameter = {
-  name: string
-  required: boolean
-  displayType: string
-  description: 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 Contact = {
-  email: string
-}
-
-export type License = {
-  name: string
-  url: string
-}
-
-export type Info = {
-  title: string
-  description: string
-  termsOfService: string
-  contact: Contact
-  license: License
-  version: string
-}
-
-export type ExternalDocs = {
-  description: string
-  url: string
-}
-
-export type Server = {
-  url: string
-}
-
-export type Spec = {
-  tags: Tag[]
-  info: Info
-  externalDocs: ExternalDocs
-  servers: Server[]
-}

package/tsconfig.build.json

@@ -1,11 +0,0 @@
-{
-  "extends": "./tsconfig.json",
-  "exclude": ["dist", "test", "vite.config.ts", "**/*.test.ts"],
-  "compilerOptions": {
-    "skipLibCheck": true,
-    "declaration": true,
-    "declarationMap": true,
-    "emitDeclarationOnly": true,
-    "outDir": "dist/"
-  }
-}

package/tsconfig.json

@@ -1,20 +0,0 @@
-{
-  "compilerOptions": {
-    "baseUrl": ".",
-    "target": "ES2022" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,
-    "module": "ESNext" /* Specify what module code is generated. */,
-    "moduleResolution": "Node",
-    "resolveJsonModule": true,
-    "isolatedModules": true,
-    "esModuleInterop": true /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */,
-    "forceConsistentCasingInFileNames": true /* Ensure that casing is correct in imports. */,
-    "strict": true /* Enable all strict type-checking options. */,
-    "strictNullChecks": true,
-    "types": ["vite/client"]
-  },
-  "include": ["src", "src/declarations"],
-  "exclude": ["dist", "vite.config.ts", "node_modules"],
-  "ts-node": {
-    "require": ["tsconfig-paths/register"]
-  }
-}

package/vite.config.ts

@@ -1,28 +0,0 @@
-import vue from '@vitejs/plugin-vue'
-import { defineConfig } from 'vite'
-
-export default defineConfig({
-  plugins: [vue()],
-  build: {
-    cssCodeSplit: true,
-    minify: false,
-    lib: {
-      entry: ['src/index.ts', 'src/assets/css/variables.css'],
-      name: '@scalar/api-reference',
-      fileName: 'index',
-      formats: ['es'],
-    },
-    rollupOptions: {
-      external: ['vue'],
-      output: {
-        assetFileNames: (assetInfo) => {
-          if (assetInfo.name === 'index.css') {
-            return 'style.css'
-          }
-
-          return assetInfo.name ?? 'default'
-        },
-      },
-    },
-  },
-})