@scalar/types 0.0.1

package/CHANGELOG.md

@@ -0,0 +1,9 @@
+# @scalar/types
+
+## 0.0.1
+
+### Patch Changes
+
+- 78db8f5: feat: use new @scalar/types package
+- Updated dependencies [78db8f5]
+  - @scalar/themes@0.9.25

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023-present Scalar
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@scalar/types",
+  "description": "Types to work with Scalar packages",
+  "license": "MIT",
+  "author": "Scalar (https://github.com/scalar)",
+  "homepage": "https://github.com/scalar/scalar",
+  "bugs": "https://github.com/scalar/scalar/issues/new/choose",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/scalar/scalar.git",
+    "directory": "packages/types"
+  },
+  "keywords": [
+    "typescript",
+    "types",
+    "scalar",
+    "references"
+  ],
+  "version": "0.0.1",
+  "engines": {
+    "node": ">=18"
+  },
+  "type": "module",
+  "exports": {
+    "./legacy": "./src/legacy/index.ts",
+    "./utils": "./src/utils/index.ts"
+  },
+  "files": [
+    "src",
+    "CHANGELOG.md"
+  ],
+  "dependencies": {
+    "@unhead/schema": "^1.9.5",
+    "@scalar/openapi-types": "0.0.1",
+    "@scalar/themes": "0.9.25"
+  },
+  "scripts": {
+    "lint:check": "eslint .",
+    "lint:fix": "eslint .  --fix",
+    "types:check": "tsc --noEmit --skipLibCheck --composite false"
+  }
+}

package/src/external/httpsnippet-lite.ts

@@ -0,0 +1,168 @@
+/**
+ * These types are copied from httpsnippet-lite to reduce depenedencies
+ */
+
+export type Param = {
+  /** name of a posted parameter. */
+  name: string
+  /** value of a posted parameter or content of a posted file */
+  value?: string | undefined
+  /** name of a posted file. */
+  fileName?: string | undefined
+  /** content type of a posted file. */
+  contentType?: string | undefined
+  /**  A comment provided by the user or the application */
+  comment?: string | undefined
+}
+
+export type PostDataCommon = {
+  /** Mime type of posted data. */
+  mimeType: string
+  /**  A comment provided by the user or the application */
+  comment?: string | undefined
+}
+
+type PostDataBase = PostDataCommon & {
+  text?: string
+  params?: Param[]
+}
+
+export type Cookie = {
+  /** The name of the cookie. */
+  name: string
+  /** The cookie value. */
+  value: string
+  /** The path pertaining to the cookie. */
+  path?: string | undefined
+  /** The host of the cookie. */
+  domain?: string | undefined
+  /**
+   * Cookie expiration time.
+   * (ISO 8601 - `YYYY-MM-DDThh:mm:ss.sTZD`,
+   * e.g. `2009-07-24T19:20:30.123+02:00`).
+   */
+  expires?: string | undefined
+  /** Set to true if the cookie is HTTP only, false otherwise. */
+  httpOnly?: boolean | undefined
+  /** True if the cookie was transmitted over ssl, false otherwise. */
+  secure?: boolean | undefined
+  /**  A comment provided by the user or the application */
+  comment?: string | undefined
+}
+
+/**
+ * This object represents a headers (used in `request` and `response` objects).
+ *
+ * http://www.softwareishard.com/blog/har-12-spec/#headers
+ */
+export type Header = {
+  name: string
+  value: string
+  /**  A comment provided by the user or the application */
+  comment?: string | undefined
+}
+/**
+ * This object represents a parameter & value parsed from a query string,
+ * if any (embedded in `request` object).
+ *
+ * http://www.softwareishard.com/blog/har-12-spec/#queryString
+ */
+export type QueryString = {
+  name: string
+  value: string
+  /**  A comment provided by the user or the application */
+  comment?: string | undefined
+}
+
+/**
+ * Post data with `params` specified.
+ */
+export type PostDataParams = {
+  /**
+   * List of posted parameters (in case of URL encoded parameters).
+   */
+  params: Param[]
+
+  /**
+   * _`params` and `text` fields are mutually exclusive._
+   */
+  text?: never | undefined
+}
+
+/**
+ * Post data with `text` specified.
+ */
+export type PostDataText = {
+  /**
+   * Plain text posted data
+   */
+  text: string
+
+  /**
+   * _`params` and `text` fields are mutually exclusive._
+   */
+  params?: never | undefined
+}
+
+/**
+ * This object describes posted data, if any (embedded in `request` object).
+ *
+ * http://www.softwareishard.com/blog/har-12-spec/#postData
+ */
+export type PostData = PostDataCommon & (PostDataParams | PostDataText)
+
+export type Request = {
+  /** Request method (`GET`, `POST`, ...). */
+  method: string
+  /** Absolute URL of the request (fragments are not included). */
+  url: string
+  /** Request HTTP Version. */
+  httpVersion: string
+  /** List of cookie objects. */
+  cookies: Cookie[]
+  /** List of header objects. */
+  headers: Header[]
+  /** List of query parameter objects. */
+  queryString: QueryString[]
+  /** Posted data info. */
+  postData?: PostData | undefined
+  /**
+   * Total number of bytes from the start of the HTTP request message until
+   * (and including) the double CRLF before the body.
+   *
+   * Set to `-1` if the info is not available.
+   */
+  headersSize: number
+  /**
+   * Size of the request body (POST data payload) in bytes.
+   *
+   * Set to `-1` if the info is not available.
+   */
+  bodySize: number
+  /**  A comment provided by the user or the application */
+  comment?: string | undefined
+}
+
+export type HarRequest = Omit<Request, 'postData'> & {
+  postData?: PostDataBase
+}
+
+export type TargetId =
+  | 'c'
+  | 'clojure'
+  | 'csharp'
+  | 'go'
+  | 'http'
+  | 'java'
+  | 'javascript'
+  | 'kotlin'
+  | 'node'
+  | 'objc'
+  | 'ocaml'
+  | 'php'
+  | 'powershell'
+  | 'python'
+  | 'r'
+  | 'ruby'
+  | 'shell'
+  | 'swift'

package/src/external/index.ts

@@ -0,0 +1 @@
+export * from './httpsnippet-lite'

package/src/legacy/index.ts

@@ -0,0 +1 @@
+export * from './reference-config'

package/src/legacy/reference-config.ts

@@ -0,0 +1,417 @@
+import type { OpenAPIV2, OpenAPIV3, OpenAPIV3_1 } from '@scalar/openapi-types'
+import type { ThemeId } from '@scalar/themes'
+import type { UseSeoMetaInput } from '@unhead/schema'
+
+import type { HarRequest, TargetId } from '../external'
+
+/**
+ * This re-export is needed due to a typescript issue
+ * @see https://github.com/microsoft/TypeScript/issues/42873
+ */
+export type { OpenAPIV2, OpenAPIV3, OpenAPIV3_1 } from '@scalar/openapi-types'
+
+export type ClientInfo = {
+  key: string
+  title: string
+  link: string
+  description: string
+}
+
+export type TargetInfo = {
+  key: TargetId
+  title: string
+  extname: `.${string}` | null
+  default: string
+}
+
+export type HiddenClients =
+  // Just hide all
+  | true
+  // Exclude whole targets or just specific clients
+  | Partial<Record<TargetInfo['key'], boolean | ClientInfo['key'][]>>
+  // Backwards compatibility with the previous behavior ['fetch', 'xhr']
+  | ClientInfo['key'][]
+
+type HttpClientState = { targetKey: TargetId; clientKey: string }
+
+export type PathRouting = {
+  basePath: string
+}
+
+export type ReferenceConfiguration = {
+  /** A string to use one of the color presets */
+  theme?: ThemeId
+  /** The layout to use for the references */
+  layout?: 'modern' | 'classic'
+  /** The Swagger/OpenAPI spec to render */
+  spec?: SpecConfiguration
+  /** URL to a request proxy for the API client */
+  proxy?: string
+  /** Whether the spec input should show */
+  isEditable?: boolean
+  /** Whether to show the sidebar */
+  showSidebar?: boolean
+  /**
+   * Whether to show models in the sidebar, search, and content.
+   *
+   * @default false
+   */
+  hideModels?: boolean
+  /**
+   * Whether to show the "Download OpenAPI Specification" button
+   *
+   * @default false
+   */
+  hideDownloadButton?: boolean
+  /** Whether dark mode is on or off initially (light mode) */
+  darkMode?: boolean
+  /** forceDarkModeState makes it always this state no matter what*/
+  forceDarkModeState?: 'dark' | 'light'
+  /** Whether to show the dark mode toggle */
+  hideDarkModeToggle?: boolean
+  /** Key used with CTRL/CMD to open the search modal (defaults to 'k' e.g. CMD+k) */
+  searchHotKey?:
+    | 'a'
+    | 'b'
+    | 'c'
+    | 'd'
+    | 'e'
+    | 'f'
+    | 'g'
+    | 'h'
+    | 'i'
+    | 'j'
+    | 'k'
+    | 'l'
+    | 'm'
+    | 'n'
+    | 'o'
+    | 'p'
+    | 'q'
+    | 'r'
+    | 's'
+    | 't'
+    | 'u'
+    | 'v'
+    | 'w'
+    | 'x'
+    | 'y'
+    | 'z'
+  /**
+   * If used, passed data will be added to the HTML header
+   * @see https://unhead.unjs.io/usage/composables/use-seo-meta
+   */
+  metaData?: UseSeoMetaInput
+  /**
+   * List of httpsnippet clients to hide from the clients menu
+   * By default hides Unirest, pass `[]` to show all clients
+   */
+  hiddenClients?: HiddenClients
+  /** Determine the HTTP client that’s selected by default */
+  defaultHttpClient?: HttpClientState
+  /** Custom CSS to be added to the page */
+  customCss?: string
+  /** onSpecUpdate is fired on spec/swagger content change */
+  onSpecUpdate?: (spec: string) => void
+  /** Prefill authentication */
+  authentication?: Partial<AuthenticationState>
+  /**
+   * Route using paths instead of hashes, your server MUST support this
+   * for example vue router needs a catch all so any subpaths are included
+   *
+   * @example
+   * '/standalone-api-reference/:custom(.*)?'
+   *
+   * @experimental
+   * @default undefined
+   */
+  pathRouting?: PathRouting
+  /**
+   * The baseServerURL is used when the spec servers are relative paths and we are using SSR.
+   * On the client we can grab the window.location.origin but on the server we need
+   * to use this prop.
+   *
+   * @default undefined
+   * @example 'http://localhost:3000'
+   */
+  baseServerURL?: string
+  /**
+   * List of servers to override the openapi spec servers
+   *
+   * @default undefined
+   * @example [{ url: 'https://api.scalar.com', description: 'Production server' }]
+   */
+  servers?: Server[]
+  /**
+   * We’re using Inter and JetBrains Mono as the default fonts. If you want to use your own fonts, set this to false.
+   *
+   * @default true
+   */
+  withDefaultFonts?: boolean
+  /**
+   * By default we only open the relevant tag based on the url, however if you want all the tags open by default then set this configuration option :)
+   *
+   * @default false
+   */
+  defaultOpenAllTags?: boolean
+  /**
+   * Sort tags alphabetically or with a custom sort function
+   */
+  tagsSorter?: 'alpha' | ((a: Tag, b: Tag) => number)
+}
+
+export type Server = OpenAPIV3.ServerObject | OpenAPIV3_1.ServerObject
+
+export type BaseParameter = {
+  name: string
+  description?: string | null
+  value: string | number | Record<string, any>
+  required?: boolean
+  enabled: boolean
+}
+
+type OptionalCharset = string | null
+
+export type ContentType =
+  | `application/json${OptionalCharset}`
+  | `application/xml${OptionalCharset}`
+  | `text/plain${OptionalCharset}`
+  | `text/html${OptionalCharset}`
+  | `application/octet-stream${OptionalCharset}`
+  | `application/x-www-form-urlencoded${OptionalCharset}`
+  | `multipart/form-data${OptionalCharset}`
+
+export type Cookie = {
+  name: string
+  value: string
+}
+
+export type CustomRequestExample = {
+  lang: string
+  label: string
+  source: string
+}
+
+export type HarRequestWithPath = HarRequest & {
+  path: string
+}
+
+export type Header = {
+  name: string
+  value: string
+}
+
+export type Information = {
+  'description'?: string
+  'operationId'?: string | number
+  'parameters'?: Parameters[]
+  'responses'?: Record<string, ScalarResponse>
+  'security'?: OpenAPIV3.SecurityRequirementObject[]
+  'requestBody'?: RequestBody
+  'summary'?: string
+  'tags'?: string[]
+  'deprecated'?: boolean
+  /**
+   * Scalar
+   */
+  'x-custom-examples'?: CustomRequestExample[]
+  /**
+   * Redocly, current
+   */
+  'x-codeSamples'?: CustomRequestExample[]
+  /**
+   * Redocly, deprecated
+   */
+  'x-code-samples'?: CustomRequestExample[]
+}
+
+export type Operation = {
+  httpVerb:
+    | 'GET'
+    | 'HEAD'
+    | 'PATCH'
+    | 'POST'
+    | 'PUT'
+    | 'TRACE'
+    | 'CONNECT'
+    | 'DELETE'
+    | 'OPTIONS'
+  path: string
+  operationId?: string
+  name?: string
+  description?: string
+  information?: Information
+}
+export type Parameters = {
+  // Fixed Fields
+  name: string
+  in?: string
+  description?: string
+  required?: boolean
+  deprecated?: boolean
+  allowEmptyValue?: boolean
+  // Other
+  style?: 'form' | 'simple'
+  explode?: boolean
+  allowReserved?: boolean
+  schema?: Schema
+  example?: any
+  examples?: Map<string, any>
+  content?: RequestBodyMimeTypes
+}
+
+export type Query = {
+  name: string
+  value: string
+}
+
+// Create a mapped type to ensure keys are a subset of ContentType
+export type RequestBodyMimeTypes = {
+  [K in ContentType]?: {
+    schema?: any
+    example?: any
+    examples?: any
+  }
+}
+
+export type ScalarResponse = {
+  description: string
+  content: any
+}
+
+export type RequestBody = {
+  description?: string
+  required?: boolean
+  content?: RequestBodyMimeTypes
+}
+
+/** For providing a OAS spec object or url to be fetched */
+export type SpecConfiguration = {
+  /** URL to a Swagger/OpenAPI file */
+  url?: string
+  /** Swagger/Open API spec */
+  content?: string | Record<string, any> | (() => Record<string, any>)
+}
+
+export type Schema = {
+  type: string
+  name?: string
+  example?: any
+  default?: any
+  format?: string
+  description?: string
+  properties?: Record<string, Schema>
+}
+
+export type TransformedOperation = Operation & {
+  pathParameters?: Parameters[]
+}
+
+export type CollapsedSidebarItems = Record<string, boolean>
+
+export type AuthenticationState = {
+  customSecurity: boolean
+  preferredSecurityScheme: string | null
+  securitySchemes?:
+    | OpenAPIV2.SecurityDefinitionsObject
+    | OpenAPIV3.ComponentsObject['securitySchemes']
+    | OpenAPIV3_1.ComponentsObject['securitySchemes']
+  http: {
+    basic: {
+      username: string
+      password: string
+    }
+    bearer: {
+      token: string
+    }
+  }
+  apiKey: {
+    token: string
+  }
+  oAuth2: {
+    clientId: string
+    scopes: string[]
+    accessToken: string
+    state: string
+    username: string
+    password: string
+  }
+}
+
+export type Heading = {
+  depth: number
+  value: string
+  slug?: string
+}
+
+export type CodeBlockSSRKey = `components-scalar-code-block${number}`
+export type DescriptionSectionSSRKey =
+  `components-Content-Introduction-Description-sections${number}`
+export type ExampleRequestSSRKey =
+  `components-Content-Operation-Example-Request${number}`
+
+export type ScalarState = {
+  'hash'?: string
+  'useGlobalStore-authentication'?: AuthenticationState
+  'useSidebarContent-collapsedSidebarItems'?: CollapsedSidebarItems
+  [key: CodeBlockSSRKey]: string
+  [key: DescriptionSectionSSRKey]: {
+    heading: Heading
+    content: string
+  }[]
+  [key: ExampleRequestSSRKey]: string
+}
+
+export type SSRState = {
+  payload: {
+    data: ScalarState
+  }
+  url: string
+}
+
+export type Tag = {
+  'name': string
+  'description': string
+  'operations': TransformedOperation[]
+  'x-displayName'?: string
+}
+
+export type TagGroup = {
+  name: string
+  tags: string[]
+}
+
+export type Definitions = OpenAPIV2.DefinitionsObject
+
+export type Webhooks = Record<
+  string,
+  Record<
+    OpenAPIV3_1.HttpMethods,
+    TransformedOperation & {
+      'x-internal'?: boolean
+    }
+  >
+>
+
+export type Spec = {
+  'tags'?: Tag[]
+  'info':
+    | Partial<OpenAPIV2.Document['info']>
+    | Partial<OpenAPIV3.Document['info']>
+    | Partial<OpenAPIV3_1.Document['info']>
+  'host'?: OpenAPIV2.Document['host']
+  'basePath'?: OpenAPIV2.Document['basePath']
+  'schemes'?: OpenAPIV2.Document['schemes']
+  'externalDocs'?: {
+    url: string
+    description?: string
+  }
+  'servers'?: OpenAPIV3.Document['servers'] | OpenAPIV3_1.Document['servers']
+  'components'?: OpenAPIV3.ComponentsObject | OpenAPIV3_1.ComponentsObject
+  'webhooks'?: Webhooks
+  'definitions'?: Definitions
+  'swagger'?: OpenAPIV2.Document['swagger']
+  'openapi'?: OpenAPIV3.Document['openapi'] | OpenAPIV3_1.Document['openapi']
+  'x-tagGroups'?: TagGroup[]
+  'security'?: OpenAPIV3.SecurityRequirementObject[]
+}

package/src/utils/index.ts

@@ -0,0 +1 @@
+export * from './utility-types'

package/src/utils/utility-types.ts

@@ -0,0 +1,4 @@
+/**
+ * When the object values are unknown
+ */
+export type UnknownObject = Record<string, unknown>