@scalar/workspace-store 0.3.1 → 0.4.0

package/src/helpers/json-path-utils.ts

@@ -1,38 +0,0 @@
-/**
- * Parses a JSON Pointer string into an array of path segments
- *
- * @example
- * ```ts
- * parseJsonPointer('#/components/schemas/User')
- *
- * ['components', 'schemas', 'User']
- * ```
- */
-export function parseJsonPointer(pointer: string): string[] {
-  return (
-    pointer
-      // Split on '/'
-      .split('/')
-      // Remove the leading '#' if present
-      .filter((segment, index) => (index !== 0 || segment !== '#') && segment)
-  )
-}
-
-/**
- * Retrieves a nested value from the source document using a path array
- *
- * @example
- * ```ts
- * getValueByPath(document, ['components', 'schemas', 'User'])
- *
- * { id: '123', name: 'John Doe' }
- * ```
- */
-export function getValueByPath(obj: any, pointer: string[]): unknown {
-  return pointer.reduce((acc, part) => {
-    if (acc === undefined || acc === null) {
-      return undefined
-    }
-    return acc[part]
-  }, obj)
-}

package/src/helpers/proxy.test.ts

@@ -1,61 +0,0 @@
-import { createMagicProxy } from '@/helpers/proxy'
-import { describe, expect, test } from 'vitest'
-
-describe('createMagicProxy', () => {
-  test('should correctly proxy internal refs', () => {
-    const input = {
-      a: 'hello',
-      b: {
-        '$ref': '#/a',
-      },
-    }
-
-    const result = createMagicProxy(input)
-
-    expect(result.b).toBe('hello')
-  })
-
-  test('should correctly proxy deep nested refs', () => {
-    const input = {
-      a: {
-        b: {
-          c: {
-            d: {
-              prop: 'hello',
-            },
-            e: {
-              '$ref': '#/a/b/c/d',
-            },
-          },
-        },
-      },
-    }
-
-    const result = createMagicProxy(input) as any
-    expect(result.a.b.c.e.prop).toBe('hello')
-  })
-
-  test('should correctly proxy multi refs', () => {
-    const input = {
-      a: {
-        b: {
-          c: {
-            prop: 'hello',
-          },
-        },
-      },
-      e: {
-        f: {
-          $ref: '#/a/b/c/prop',
-        },
-      },
-      d: {
-        $ref: '#/e/f',
-      },
-    }
-
-    const result = createMagicProxy(input)
-
-    expect(result.d).toBe('hello')
-  })
-})

package/src/helpers/proxy.ts

@@ -1,213 +0,0 @@
-import { isReactive, toRaw } from 'vue'
-import { getValueByPath, parseJsonPointer } from './json-path-utils'
-import { isLocalRef, isObject } from './general'
-import type { UnknownObject } from './general'
-
-export const TARGET_SYMBOL = Symbol('target')
-
-/**
- * Creates a proxy handler that automatically resolves JSON references ($ref) in an object.
- * The handler intercepts property access, assignment, and property enumeration to automatically
- * resolve any $ref references to their target values in the source document.
- *
- * @param sourceDocument - The source document containing the reference targets
- * @param resolvedProxyCache - Optional cache to store resolved proxies and prevent duplicate proxies
- * @returns A proxy handler that automatically resolves $ref references
- */
-function createProxyHandler(
-  sourceDocument: UnknownObject,
-  resolvedProxyCache?: WeakMap<object, UnknownObject>,
-): ProxyHandler<UnknownObject> {
-  return {
-    get(target, property, receiver) {
-      if (property === TARGET_SYMBOL) {
-        return target
-      }
-
-      if (property === '__isProxy') {
-        return true
-      }
-
-      const value = Reflect.get(target, property, receiver)
-
-      /**
-       * Recursively resolves nested references in an object.
-       * If the value is not an object, returns it as is.
-       * If the value has a $ref property:
-       *   - For local references: resolves the reference and continues resolving nested refs
-       *   - For all other objects: creates a proxy for lazy resolution
-       */
-      const deepResolveNestedRefs = (value: unknown) => {
-        if (!isObject(value)) {
-          return value
-        }
-
-        if ('$ref' in value) {
-          const ref = value.$ref as string
-
-          if (isLocalRef(ref)) {
-            const referencePath = parseJsonPointer(ref)
-            const resolvedValue = getValueByPath(sourceDocument, referencePath)
-
-            return deepResolveNestedRefs(resolvedValue)
-          }
-        }
-
-        return createMagicProxy(value, sourceDocument, resolvedProxyCache)
-      }
-
-      return deepResolveNestedRefs(value)
-    },
-
-    set(target: UnknownObject, property: string, newValue: unknown, receiver: UnknownObject) {
-      const rawTarget = isReactive(target) ? toRaw(target) : target
-      const currentValue = rawTarget[property]
-
-      if (
-        isObject(currentValue) &&
-        '$ref' in currentValue &&
-        typeof currentValue.$ref === 'string' &&
-        isLocalRef(currentValue.$ref)
-      ) {
-        const referencePath = parseJsonPointer(currentValue.$ref)
-        const targetObject = getValueByPath(sourceDocument, referencePath.slice(0, -1)) as UnknownObject
-        const lastPathSegment = referencePath[referencePath.length - 1]
-
-        if (targetObject && lastPathSegment) {
-          targetObject[lastPathSegment] = newValue
-        }
-      } else {
-        Reflect.set(rawTarget, property, newValue, receiver)
-      }
-      return true
-    },
-
-    has(target: UnknownObject, key: string) {
-      if (typeof key === 'string' && key !== '$ref' && typeof target.$ref === 'string' && isLocalRef(target.$ref)) {
-        const referencePath = parseJsonPointer(target['$ref'])
-        const resolvedValue = getValueByPath(sourceDocument, referencePath) as UnknownObject
-
-        return resolvedValue ? key in resolvedValue : false
-      }
-
-      return key in target
-    },
-
-    ownKeys(target: UnknownObject) {
-      if ('$ref' in target && typeof target.$ref === 'string' && isLocalRef(target.$ref)) {
-        const referencePath = parseJsonPointer(target['$ref'])
-        const resolvedValue = getValueByPath(sourceDocument, referencePath)
-
-        return resolvedValue ? Reflect.ownKeys(resolvedValue) : []
-      }
-
-      return Reflect.ownKeys(target)
-    },
-
-    getOwnPropertyDescriptor(target: UnknownObject, key: string) {
-      if ('$ref' in target && key !== '$ref' && typeof target.$ref === 'string' && isLocalRef(target.$ref)) {
-        const referencePath = parseJsonPointer(target['$ref'])
-        const resolvedValue = getValueByPath(sourceDocument, referencePath)
-
-        if (resolvedValue) {
-          return Object.getOwnPropertyDescriptor(resolvedValue, key)
-        }
-      }
-
-      return Object.getOwnPropertyDescriptor(target, key)
-    },
-  }
-}
-
-/**
- * Creates a proxy that automatically resolves JSON references ($ref) in an object.
- * The proxy intercepts property access and automatically resolves any $ref references
- * to their target values in the source document.
- *
- * @param targetObject - The object to create a proxy for
- * @param sourceDocument - The source document containing the reference targets (defaults to targetObject)
- * @param resolvedProxyCache - Optional cache to store resolved proxies and prevent duplicate proxies
- * @returns A proxy that automatically resolves $ref references
- *
- * @example
- * // Basic usage with local references
- * const doc = {
- *   components: {
- *     schemas: {
- *       User: { type: 'object', properties: { name: { type: 'string' } } }
- *     }
- *   },
- *   paths: {
- *     '/users': {
- *       get: {
- *         responses: {
- *           200: {
- *             content: {
- *               'application/json': {
- *                 schema: { $ref: '#/components/schemas/User' }
- *               }
- *             }
- *           }
- *         }
- *       }
- *     }
- *   }
- * }
- *
- * const proxy = createMagicProxy(doc)
- * // Accessing the schema will automatically resolve the $ref
- * console.log(proxy.paths['/users'].get.responses[200].content['application/json'].schema)
- * // Output: { type: 'object', properties: { name: { type: 'string' } } }
- *
- * @example
- * // Using with a cache to prevent duplicate proxies
- * const cache = new WeakMap()
- * const proxy1 = createMagicProxy(doc, doc, cache)
- * const proxy2 = createMagicProxy(doc, doc, cache)
- * // proxy1 and proxy2 are the same instance due to caching
- * console.log(proxy1 === proxy2) // true
- */
-export function createMagicProxy<T extends UnknownObject>(
-  targetObject: T,
-  sourceDocument: T = targetObject,
-  resolvedProxyCache?: WeakMap<object, T>,
-): T {
-  if (!isObject(targetObject)) {
-    return targetObject
-  }
-
-  const rawTarget = isReactive(targetObject) ? toRaw(targetObject) : targetObject
-
-  // check for cached results
-  if (resolvedProxyCache?.has(rawTarget)) {
-    const cachedValue = resolvedProxyCache.get(rawTarget)
-
-    if (cachedValue) {
-      return cachedValue
-    }
-  }
-
-  // Create a handler with the correct context
-  const handler = createProxyHandler(sourceDocument, resolvedProxyCache)
-  const proxy = new Proxy<T>(rawTarget, handler)
-
-  if (resolvedProxyCache) {
-    resolvedProxyCache.set(rawTarget, proxy)
-  }
-
-  return proxy
-}
-
-/**
- * Gets the raw (non-proxied) version of an object created by createMagicProxy.
- * This is useful when you need to access the original object without the magic proxy wrapper.
- *
- * @param obj - The magic proxy object to get the raw version of
- * @returns The raw version of the object
- * @example
- * const proxy = createMagicProxy({ foo: { $ref: '#/bar' } })
- * const raw = getRaw(proxy) // { foo: { $ref: '#/bar' } }
- */
-export function getRaw(obj: UnknownObject) {
-  return (obj as { [TARGET_SYMBOL]: UnknownObject })[TARGET_SYMBOL]
-}

package/src/schemas/callback.ts

@@ -1,13 +0,0 @@
-import { Type } from '@sinclair/typebox'
-import { PathItemObject } from './path-item'
-
-/**
- * A map of possible out-of band callbacks related to the parent operation. Each value in the map is a Path Item Object that describes a set of requests that may be initiated by the API provider and the expected responses. The key value used to identify the Path Item Object is an expression, evaluated at runtime, that identifies a URL to use for the callback operation.
- *
- * To describe incoming requests from the API provider independent from another API call, use the webhooks field.
- */
-export const CallbackObject = Type.Record(
-  Type.String(),
-  /** A Path Item Object used to define a callback request and expected responses. A complete example is available. */
-  PathItemObject,
-)

package/src/schemas/components.ts

@@ -1,36 +0,0 @@
-import { Type } from '@sinclair/typebox'
-import { SchemaObject } from './schema'
-import { ResponseObject } from './response'
-import { ReferenceObject } from './reference'
-import { ParameterObject } from './parameter'
-import { ExampleObject } from './example'
-import { RequestBodyObject } from './request-body'
-import { SecuritySchemeObject } from './security-scheme'
-import { LinkObject } from './link'
-import { CallbackObject } from './callback'
-import { PathItemObject } from './path-item'
-import { HeaderObject } from './header'
-
-/** Holds a set of reusable objects for different aspects of the OAS. All objects defined within the Components Object will have no effect on the API unless they are explicitly referenced from outside the Components Object. */
-export const ComponentsObject = Type.Object({
-  /** An object to hold reusable Schema Objects. */
-  schemas: Type.Optional(Type.Record(Type.String(), SchemaObject)),
-  /** An object to hold reusable Response Objects. */
-  responses: Type.Optional(Type.Record(Type.String(), Type.Union([ResponseObject, ReferenceObject]))),
-  /** An object to hold reusable Parameter Objects. */
-  parameters: Type.Optional(Type.Record(Type.String(), Type.Union([ParameterObject, ReferenceObject]))),
-  /** An object to hold reusable Example Objects. */
-  examples: Type.Optional(Type.Record(Type.String(), Type.Union([ExampleObject, ReferenceObject]))),
-  /** An object to hold reusable Request Body Objects. */
-  requestBodies: Type.Optional(Type.Record(Type.String(), Type.Union([RequestBodyObject, ReferenceObject]))),
-  /** An object to hold reusable Header Objects. */
-  headers: Type.Optional(Type.Record(Type.String(), Type.Union([HeaderObject, ReferenceObject]))),
-  /** An object to hold reusable Security Scheme Objects. */
-  securitySchemes: Type.Optional(Type.Record(Type.String(), Type.Union([SecuritySchemeObject, ReferenceObject]))),
-  /** An object to hold reusable Link Objects. */
-  links: Type.Optional(Type.Record(Type.String(), Type.Union([LinkObject, ReferenceObject]))),
-  /** An object to hold reusable Callback Objects. */
-  callbacks: Type.Optional(Type.Record(Type.String(), Type.Union([CallbackObject, ReferenceObject]))),
-  /** An object to hold reusable Path Item Objects. */
-  pathItems: Type.Optional(Type.Record(Type.String(), PathItemObject)),
-})

package/src/schemas/contact.ts

@@ -1,11 +0,0 @@
-import { Type } from '@sinclair/typebox'
-
-/** Contact information for the exposed API. */
-export const ContactObject = Type.Object({
-  /** The identifying name of the contact person/organization. */
-  name: Type.Optional(Type.String()),
-  /** The URI for the contact information. This MUST be in the form of a URI. */
-  url: Type.Optional(Type.String()),
-  /** The email address of the contact person/organization. This MUST be in the form of an email address. */
-  email: Type.Optional(Type.String()),
-})

package/src/schemas/discriminator.ts

@@ -1,13 +0,0 @@
-import { Type } from '@sinclair/typebox'
-
-/**
- * When request bodies or response payloads may be one of a number of different schemas, a Discriminator Object gives a hint about the expected schema of the document. This hint can be used to aid in serialization, deserialization, and validation. The Discriminator Object does this by implicitly or explicitly associating the possible values of a named property with alternative schemas.
- *
- * Note that discriminator MUST NOT change the validation outcome of the schema.
- */
-export const DiscriminatorObject = Type.Object({
-  /** REQUIRED. The name of the property in the payload that will hold the discriminating value. This property SHOULD be required in the payload schema, as the behavior when the property is absent is undefined. */
-  propertyName: Type.String(),
-  /** An object to hold mappings between payload values and schema names or URI references. */
-  mapping: Type.Optional(Type.Record(Type.String(), Type.String())),
-})

package/src/schemas/encoding.ts

@@ -1,17 +0,0 @@
-import { Type } from '@sinclair/typebox'
-import { HeaderObject } from './header'
-import { ReferenceObject } from './reference'
-
-/**
- * A single encoding definition applied to a single schema property. See Appendix B for a discussion of converting values of various types to string representations.
- *
- * Properties are correlated with multipart parts using the name parameter of Content-Disposition: form-data, and with application/x-www-form-urlencoded using the query string parameter names. In both cases, their order is implementation-defined.
- *
- * See Appendix E for a detailed examination of percent-encoding concerns for form media types.
- */
-export const EncodingObject = Type.Object({
-  /** The Content-Type for encoding a specific property. The value is a comma-separated list, each element of which is either a specific media type (e.g. image/png) or a wildcard media type (e.g. image/*). Default value depends on the property type as shown in the table below. */
-  contentType: Type.Optional(Type.String()),
-  /** A map allowing additional information to be provided as headers. Content-Type is described separately and SHALL be ignored in this section. This field SHALL be ignored if the request body media type is not a multipart. */
-  headers: Type.Optional(Type.Record(Type.String(), Type.Union([HeaderObject, ReferenceObject]))),
-})

package/src/schemas/example.ts

@@ -1,17 +0,0 @@
-import { Type } from '@sinclair/typebox'
-
-/**
- * An object grouping an internal or external example value with basic summary and description metadata. This object is typically used in fields named examples (plural), and is a referenceable alternative to older example (singular) fields that do not support referencing or metadata.
- *
- * Examples allow demonstration of the usage of properties, parameters and objects within OpenAPI.
- */
-export const ExampleObject = Type.Object({
-  /** Short description for the example. */
-  summary: Type.Optional(Type.String()),
-  /** Long description for the example. CommonMark syntax MAY be used for rich text representation. */
-  description: Type.Optional(Type.String()),
-  /** Embedded literal example. The value field and externalValue field are mutually exclusive. To represent examples of media types that cannot naturally represented in JSON or YAML, use a string value to contain the example, escaping where necessary. */
-  value: Type.Optional(Type.Any()),
-  /** A URI that identifies the literal example. This provides the capability to reference examples that cannot easily be included in JSON or YAML documents. The value field and externalValue field are mutually exclusive. See the rules for resolving Relative References. */
-  externalValue: Type.Optional(Type.String()),
-})

package/src/schemas/external-documentation.ts

@@ -1,9 +0,0 @@
-import { Type } from '@sinclair/typebox'
-
-/** Allows referencing an external resource for extended documentation. */
-export const ExternalDocumentationObject = Type.Object({
-  /** A description of the target documentation. CommonMark syntax MAY be used for rich text representation. */
-  description: Type.Optional(Type.String()),
-  /** REQUIRED. The URI for the target documentation. This MUST be in the form of a URI. */
-  url: Type.String(),
-})

package/src/schemas/header.ts

@@ -1,19 +0,0 @@
-import { Type } from '@sinclair/typebox'
-
-/**
- * Describes a single header for HTTP responses and for individual parts in multipart representations; see the relevant Response Object and Encoding Object documentation for restrictions on which headers can be described.
- *
- * The Header Object follows the structure of the Parameter Object, including determining its serialization strategy based on whether schema or content is present, with the following changes:
- *
- *    - name MUST NOT be specified, it is given in the corresponding headers map.
- *    - in MUST NOT be specified, it is implicitly in header.
- *    - All traits that are affected by the location MUST be applicable to a location of header (for example, style). This means that allowEmptyValue and allowReserved MUST NOT be used, and style, if used, MUST be limited to "simple".
- */
-export const HeaderObject = Type.Object({
-  /** A brief description of the header. This could contain examples of use. CommonMark syntax MAY be used for rich text representation. */
-  description: Type.Optional(Type.String()),
-  /** Determines whether this header is mandatory. The default value is false. */
-  required: Type.Optional(Type.Boolean()),
-  /** Specifies that the header is deprecated and SHOULD be transitioned out of usage. Default value is false. */
-  deprecated: Type.Optional(Type.Boolean()),
-})

package/src/schemas/info.ts

@@ -1,23 +0,0 @@
-import { Type } from '@sinclair/typebox'
-import { ContactObject } from './contact'
-import { LicenseObject } from './license'
-
-/**
- * The object provides metadata about the API. The metadata MAY be used by the clients if needed, and MAY be presented in editing or documentation generation tools for convenience.
- */
-export const InfoObject = Type.Object({
-  /** REQUIRED. The title of the API. */
-  title: Type.String({ default: 'API' }),
-  /** A short summary of the API. */
-  summary: Type.Optional(Type.String()),
-  /** A description of the API. CommonMark syntax MAY be used for rich text representation. */
-  description: Type.Optional(Type.String()),
-  /** A URI for the Terms of Service for the API. This MUST be in the form of a URI. */
-  termsOfService: Type.Optional(Type.String()),
-  /** The contact information for the exposed API. */
-  contact: Type.Optional(ContactObject),
-  /** The license information for the exposed API. */
-  license: Type.Optional(LicenseObject),
-  /** REQUIRED. The version of the OpenAPI Document (which is distinct from the OpenAPI Specification version or the version of the API being described or the version of the OpenAPI Description). */
-  version: Type.String(),
-})

package/src/schemas/license.ts

@@ -1,11 +0,0 @@
-import { Type } from '@sinclair/typebox'
-
-/** The license information for the exposed API. */
-export const LicenseObject = Type.Object({
-  /** REQUIRED. The license name used for the API. */
-  name: Type.Optional(Type.String()),
-  /** An SPDX license expression for the API. The identifier field is mutually exclusive of the url field. */
-  identifier: Type.Optional(Type.String()),
-  /** A URI for the license used for the API. This MUST be in the form of a URI. The url field is mutually exclusive of the identifier field. */
-  url: Type.Optional(Type.String()),
-})

package/src/schemas/link.ts

@@ -1,24 +0,0 @@
-import { Type } from '@sinclair/typebox'
-import { ServerObject } from './server'
-
-/**
- * The Link Object represents a possible design-time link for a response. The presence of a link does not guarantee the caller's ability to successfully invoke it, rather it provides a known relationship and traversal mechanism between responses and other operations.
- *
- * Unlike dynamic links (i.e. links provided in the response payload), the OAS linking mechanism does not require link information in the runtime response.
- *
- * For computing links and providing instructions to execute them, a runtime expression is used for accessing values in an operation and using them as parameters while invoking the linked operation.
- */
-export const LinkObject = Type.Object({
-  /** A URI reference to an OAS operation. This field is mutually exclusive of the operationId field, and MUST point to an Operation Object. Relative operationRef values MAY be used to locate an existing Operation Object in the OpenAPI Description. */
-  operationRef: Type.Optional(Type.String()),
-  /** The name of an existing, resolvable OAS operation, as defined with a unique operationId. This field is mutually exclusive of the operationRef field. */
-  operationId: Type.Optional(Type.String()),
-  /** A map representing parameters to pass to an operation as specified with operationId or identified via operationRef. The key is the parameter name to be used (optionally qualified with the parameter location, e.g. path.id for an id parameter in the path), whereas the value can be a constant or an expression to be evaluated and passed to the linked operation. */
-  parameters: Type.Optional(Type.Record(Type.String(), Type.Any())),
-  /** A literal value or {expression} to use as a request body when calling the target operation. */
-  requestBody: Type.Optional(Type.Any()),
-  /** A description of the link. CommonMark syntax MAY be used for rich text representation. */
-  description: Type.Optional(Type.String()),
-  /** A server object to be used by the target operation. */
-  server: Type.Optional(ServerObject),
-})

package/src/schemas/media-type.ts

@@ -1,21 +0,0 @@
-import { Type } from '@sinclair/typebox'
-import { ExampleObject } from './example'
-import { ReferenceObject } from './reference'
-import { EncodingObject } from './encoding'
-import { SchemaObject } from './schema'
-
-/**
- * Each Media Type Object provides schema and examples for the media type identified by its key.
- *
- * When example or examples are provided, the example SHOULD match the specified schema and be in the correct format as specified by the media type and its encoding. The example and examples fields are mutually exclusive, and if either is present it SHALL override any example in the schema. See Working With Examples for further guidance regarding the different ways of specifying examples, including non-JSON/YAML values.
- */
-export const MediaTypeObject = Type.Object({
-  /** The schema defining the content of the request, response, parameter, or header. */
-  schema: Type.Optional(SchemaObject),
-  /** Example of the media type */
-  example: Type.Optional(Type.Any()),
-  /** Examples of the media type */
-  examples: Type.Optional(Type.Record(Type.String(), Type.Union([ExampleObject, ReferenceObject]))),
-  /** A map between a property name and its encoding information. The key, being the property name, MUST exist in the schema as a property. The encoding field SHALL only apply to Request Body Objects, and only when the media type is multipart or application/x-www-form-urlencoded. If no Encoding Object is provided for a property, the behavior is determined by the default values documented for the Encoding Object. */
-  encoding: Type.Optional(Type.Record(Type.String(), EncodingObject)),
-})

package/src/schemas/oauth-flow.ts

@@ -1,13 +0,0 @@
-import { Type } from '@sinclair/typebox'
-
-/** Configuration details for a supported OAuth Flow */
-export const OAuthFlowObject = Type.Object({
-  /** REQUIRED. The authorization URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. */
-  authorizationUrl: Type.String(),
-  /** REQUIRED. The token URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. */
-  tokenUrl: Type.String(),
-  /** The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. */
-  refreshUrl: Type.Optional(Type.String()),
-  /** REQUIRED. The available scopes for the OAuth2 security scheme. A map between the scope name and a short description for it. The map MAY be empty. */
-  scopes: Type.Record(Type.String(), Type.String()),
-})

package/src/schemas/oauthflows.ts

@@ -1,16 +0,0 @@
-import { Type } from '@sinclair/typebox'
-import { OAuthFlowObject } from './oauth-flow'
-
-/**
- * Allows configuration of the supported OAuth Flows.
- */
-export const OAuthFlowsObject = Type.Object({
-  /** Configuration for the OAuth Implicit flow */
-  implicit: Type.Optional(OAuthFlowObject),
-  /** Configuration for the OAuth Resource Owner Password flow */
-  password: Type.Optional(OAuthFlowObject),
-  /** Configuration for the OAuth Client Credentials flow. Previously called application in OpenAPI 2.0. */
-  clientCredentials: Type.Optional(OAuthFlowObject),
-  /** Configuration for the OAuth Authorization Code flow. Previously called accessCode in OpenAPI 2.0. */
-  authorizationCode: Type.Optional(OAuthFlowObject),
-})

package/src/schemas/openapi-document.ts

@@ -1,34 +0,0 @@
-import { Type, type Static } from '@sinclair/typebox'
-import { InfoObject } from './info'
-import { ServerObject } from './server'
-import { PathsObject } from './paths'
-import { PathItemObject } from './path-item'
-import { ComponentsObject } from './components'
-import { SecurityRequirementObject } from './security-requirement'
-import { TagObject } from './tag'
-import { ExternalDocumentationObject } from './external-documentation'
-
-export const OpenAPIDocumentSchema = Type.Object({
-  /** REQUIRED. This string MUST be the version number of the OpenAPI Specification that the OpenAPI Document uses. The openapi field SHOULD be used by tooling to interpret the OpenAPI Document. This is not related to the API info.version string. */
-  openapi: Type.String(),
-  /** REQUIRED. Provides metadata about the API. The metadata MAY be used by tooling as required. */
-  info: InfoObject,
-  /** The default value for the $schema keyword within Schema Objects contained within this OAS document. This MUST be in the form of a URI. */
-  jsonSchemaDialect: Type.Optional(Type.String()),
-  /** An array of Server Objects, which provide connectivity information to a target server. If the servers field is not provided, or is an empty array, the default value would be a Server Object with a url value of /. */
-  servers: Type.Optional(Type.Array(ServerObject)),
-  /** The available paths and operations for the API. */
-  paths: Type.Optional(PathsObject),
-  /** The incoming webhooks that MAY be received as part of this API and that the API consumer MAY choose to implement. Closely related to the callbacks feature, this section describes requests initiated other than by an API call, for example by an out of band registration. The key name is a unique string to refer to each webhook, while the (optionally referenced) Path Item Object describes a request that may be initiated by the API provider and the expected responses. An example is available. */
-  webhooks: Type.Optional(Type.Record(Type.String(), PathItemObject)),
-  /** An element to hold various Objects for the OpenAPI Description. */
-  components: Type.Optional(ComponentsObject),
-  /** A declaration of which security mechanisms can be used across the API. The list of values includes alternative Security Requirement Objects that can be used. Only one of the Security Requirement Objects need to be satisfied to authorize a request. Individual operations can override this definition. The list can be incomplete, up to being empty or absent. To make security explicitly optional, an empty security requirement ({}) can be included in the array. */
-  security: Type.Optional(Type.Array(SecurityRequirementObject)),
-  /** A list of tags used by the OpenAPI Description with additional metadata. The order of the tags can be used to reflect on their order by the parsing tools. Not all tags that are used by the Operation Object must be declared. The tags that are not declared MAY be organized randomly or based on the tools' logic. Each tag name in the list MUST be unique. */
-  tags: Type.Optional(Type.Array(TagObject)),
-  /** Additional external documentation. */
-  externalDocs: Type.Optional(ExternalDocumentationObject),
-})
-
-export type OpenApiDocument = Static<typeof OpenAPIDocumentSchema>

package/src/schemas/operation-without-callback.ts

@@ -1,37 +0,0 @@
-import { Type } from '@sinclair/typebox'
-import { ExternalDocumentationObject } from './external-documentation'
-import { ParameterObject } from './parameter'
-import { ReferenceObject } from './reference'
-import { RequestBodyObject } from './request-body'
-import { ResponsesObject } from './responses'
-import { SecurityRequirementObject } from './security-requirement'
-import { ServerObject } from './server'
-
-/** Describes a single API operation on a path. */
-export const OperationObjectWithoutCallback = Type.Union([
-  Type.Object({
-    /** A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier. */
-    tags: Type.Optional(Type.Array(Type.String())),
-    /** A short summary of what the operation does. */
-    summary: Type.Optional(Type.String()),
-    /** A verbose explanation of the operation behavior. CommonMark syntax MAY be used for rich text representation. */
-    description: Type.Optional(Type.String()),
-    /** Additional external documentation for this operation. */
-    externalDocs: Type.Optional(ExternalDocumentationObject),
-    /** Unique string used to identify the operation. The id MUST be unique among all operations described in the API. The operationId value is case-sensitive. Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is RECOMMENDED to follow common programming naming conventions. */
-    operationId: Type.Optional(Type.String()),
-    /** A list of parameters that are applicable for this operation. If a parameter is already defined at the Path Item, the new definition will override it but can never remove it. The list MUST NOT include duplicated parameters. A unique parameter is defined by a combination of a name and location. The list can use the Reference Object to link to parameters that are defined in the OpenAPI Object's components.parameters. */
-    parameters: Type.Optional(Type.Array(Type.Union([ParameterObject, ReferenceObject]))),
-    /** The request body applicable for this operation. The requestBody is fully supported in HTTP methods where the HTTP 1.1 specification RFC7231 has explicitly defined semantics for request bodies. In other cases where the HTTP spec is vague (such as GET, HEAD and DELETE), requestBody is permitted but does not have well-defined semantics and SHOULD be avoided if possible. */
-    requestBody: Type.Optional(Type.Union([RequestBodyObject, ReferenceObject])),
-    /** The list of possible responses as they are returned from executing this operation. */
-    responses: Type.Optional(ResponsesObject),
-    /** Declares this operation to be deprecated. Consumers SHOULD refrain from usage of the declared operation. Default value is false. */
-    deprecated: Type.Optional(Type.Boolean()),
-    /** A declaration of which security mechanisms can be used for this operation. The list of values includes alternative Security Requirement Objects that can be used. Only one of the Security Requirement Objects need to be satisfied to authorize a request. To make security optional, an empty security requirement ({}) can be included in the array. This definition overrides any declared top-level security. To remove a top-level security declaration, an empty array can be used. */
-    security: Type.Optional(Type.Array(SecurityRequirementObject)),
-    /** An alternative servers array to service this operation. If a servers array is specified at the Path Item Object or OpenAPI Object level, it will be overridden by this value. */
-    servers: Type.Optional(Type.Array(ServerObject)),
-  }),
-  ReferenceObject,
-])