@scalar/oas-utils 0.2.140 → 0.2.141

package/dist/entities/spec/request-examples.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../src/entities/spec/request-examples.ts"],
+  "sourcesContent": ["import { schemaModel } from '@/helpers/schema-model'\nimport { getServerVariableExamples } from '@/spec-getters/get-server-variable-examples'\nimport { keysOf } from '@scalar/object-utils/arrays'\nimport { type ENTITY_BRANDS, nanoidSchema } from '@scalar/types/utils'\nimport { z } from 'zod'\n\nimport { isDefined } from '@/helpers/is-defined'\nimport { getObjectKeys } from '@/helpers/object'\n\nimport { getRequestBodyFromOperation } from '@/spec-getters/get-request-body-from-operation'\nimport type { RequestParameter, ParameterContent } from './parameters'\nimport type { Request } from './requests'\nimport type { Server } from './server'\n\n// ---------------------------------------------------------------------------\n// Example Parameters\n\n/**\n * TODO: Deprecate this.\n *\n * The request schema should be stored in the request and any\n * parameters should be validated against that\n */\nexport const requestExampleParametersSchema = z\n  .object({\n    key: z.string().default(''),\n    value: z.coerce.string().default(''),\n    enabled: z.boolean().default(true),\n    file: z.any().optional(),\n    description: z.string().optional(),\n    required: z.boolean().optional(),\n    enum: z.array(z.string()).optional(),\n    examples: z.array(z.any()).optional(),\n    type: z\n      .union([\n        // 'string'\n        z.string(),\n        // ['string', 'null']\n        z.array(z.string()),\n      ])\n      .optional(),\n    format: z.string().optional(),\n    minimum: z.number().optional(),\n    maximum: z.number().optional(),\n    default: z.any().optional(),\n    nullable: z.boolean().optional(),\n  })\n  // set nullable: to true if type is ['string', 'null']\n  .transform((_data) => {\n    const data = { ..._data }\n\n    // type: ['string', 'null'] -> nullable: true\n    if (Array.isArray(data.type) && data.type.includes('null')) {\n      data.nullable = true\n    }\n\n    // Hey, if it's just one value and 'null', we can make it a string and ditch the 'null'.\n    if (Array.isArray(data.type) && data.type.length === 2 && data.type.includes('null')) {\n      data.type = data.type.find((item) => item !== 'null')\n    }\n\n    return data\n  })\n\n/** Convert the array of parameters to an object keyed by the parameter name */\nexport const parameterArrayToObject = (params: RequestExampleParameter[]) =>\n  params.reduce<Record<string, string>>((map, param) => {\n    map[param.key] = param.value\n    return map\n  }, {})\n\n/** Request examples - formerly known as instances - are \"children\" of requests */\nexport type RequestExampleParameter = z.infer<typeof requestExampleParametersSchema>\n\nexport const xScalarFileValueSchema = z\n  .object({\n    url: z.string(),\n    base64: z.string().optional(),\n  })\n  .nullable()\n\n/**\n * When files are required for an example we provide the options\n * to provide a public URL or a base64 encoded string\n */\nexport type XScalarFileValue = z.infer<typeof xScalarFileValueSchema>\n\n/**\n * Schema for the OAS serialization of request example parameters\n *\n * File values can be optionally fetched on import OR inserted as a base64 encoded string\n */\nexport const xScalarFormDataValue = z.union([\n  z.object({\n    type: z.literal('string'),\n    value: z.string(),\n  }),\n  z.object({\n    type: z.literal('file'),\n    file: xScalarFileValueSchema,\n  }),\n])\n\nexport type XScalarFormDataValue = z.infer<typeof xScalarFormDataValue>\n\n// ---------------------------------------------------------------------------\n// Example Body\n\n/**\n * Possible encodings for example request bodies when using text formats\n *\n * TODO: This list may not be comprehensive enough\n */\nexport const exampleRequestBodyEncoding = ['json', 'text', 'html', 'javascript', 'xml', 'yaml', 'edn'] as const\n\nexport type BodyEncoding = (typeof exampleRequestBodyEncoding)[number]\n\nexport const exampleBodyMime = [\n  'application/json',\n  'text/plain',\n  'text/html',\n  'application/javascript',\n  'application/xml',\n  'application/yaml',\n  'application/edn',\n  'application/octet-stream',\n  'application/x-www-form-urlencoded',\n  'multipart/form-data',\n  /** Used for direct files */\n  'binary',\n] as const\n\nexport type BodyMime = (typeof exampleBodyMime)[number]\n\nconst contentMapping: Record<BodyEncoding, BodyMime> = {\n  json: 'application/json',\n  text: 'text/plain',\n  html: 'text/html',\n  javascript: 'application/javascript',\n  xml: 'application/xml',\n  yaml: 'application/yaml',\n  edn: 'application/edn',\n} as const\n\n/**\n * TODO: Migrate away from this layout to the format used in the extension\n *\n * If a user changes the encoding of the body we expect the content to change as well\n */\nexport const exampleRequestBodySchema = z.object({\n  raw: z\n    .object({\n      encoding: z.enum(exampleRequestBodyEncoding),\n      value: z.string().default(''),\n      mimeType: z.string().optional(),\n    })\n    .optional(),\n  formData: z\n    .object({\n      encoding: z.union([z.literal('form-data'), z.literal('urlencoded')]).default('form-data'),\n      value: requestExampleParametersSchema.array().default([]),\n    })\n    .optional(),\n  binary: z.instanceof(Blob).optional(),\n  activeBody: z.union([z.literal('raw'), z.literal('formData'), z.literal('binary')]).default('raw'),\n})\n\nexport type ExampleRequestBody = z.infer<typeof exampleRequestBodySchema>\n\n/** Schema for the OAS serialization of request example bodies */\nexport const xScalarExampleBodySchema = z.object({\n  encoding: z.enum(exampleBodyMime),\n  /**\n   * Body content as an object with a separately specified encoding or a simple pre-encoded string value\n   *\n   * Ideally we would convert any objects into the proper encoding on import\n   */\n  content: z.union([z.record(z.string(), z.any()), z.string()]),\n  /** When the encoding is `binary` this will be used to link to the file */\n  file: xScalarFileValueSchema.optional(),\n})\n\nexport type XScalarExampleBody = z.infer<typeof xScalarExampleBodySchema>\n\n// ---------------------------------------------------------------------------\n// Example Schema\n\nexport const requestExampleSchema = z.object({\n  uid: nanoidSchema.brand<ENTITY_BRANDS['EXAMPLE']>(),\n  type: z.literal('requestExample').optional().default('requestExample'),\n  requestUid: z.string().brand<ENTITY_BRANDS['OPERATION']>().optional(),\n  name: z.string().optional().default('Name'),\n  body: exampleRequestBodySchema.optional().default({}),\n  parameters: z\n    .object({\n      path: requestExampleParametersSchema.array().default([]),\n      query: requestExampleParametersSchema.array().default([]),\n      headers: requestExampleParametersSchema.array().default([{ key: 'Accept', value: '*/*', enabled: true }]),\n      cookies: requestExampleParametersSchema.array().default([]),\n    })\n    .optional()\n    .default({}),\n  /** TODO: Should this be deprecated? */\n  serverVariables: z.record(z.string(), z.array(z.string())).optional(),\n})\n\nexport type RequestExample = z.infer<typeof requestExampleSchema>\n\n/** For OAS serialization we just store the simple key/value pairs */\nconst xScalarExampleParameterSchema = z.record(z.string(), z.string()).optional()\n\n/** Schema for the OAS serialization of request examples */\nexport const xScalarExampleSchema = z.object({\n  /** TODO: Should this be required? */\n  name: z.string().optional(),\n  body: xScalarExampleBodySchema.optional(),\n  parameters: z.object({\n    path: xScalarExampleParameterSchema,\n    query: xScalarExampleParameterSchema,\n    headers: xScalarExampleParameterSchema,\n    cookies: xScalarExampleParameterSchema,\n  }),\n})\n\nexport type XScalarExample = z.infer<typeof xScalarExampleSchema>\n\n/**\n * Convert a request example to the xScalar serialized format\n *\n * TODO: The base format should be migrated to align MUCH closer to the serialized format\n */\nexport function convertExampleToXScalar(example: RequestExample) {\n  const active = example.body?.activeBody\n\n  const xScalarBody: XScalarExampleBody = {\n    encoding: 'text/plain',\n    content: '',\n  }\n\n  if (example.body?.activeBody === 'binary') {\n    xScalarBody.encoding = 'binary'\n    // TODO: Need to allow users to set these properties\n    xScalarBody.file = null\n  }\n\n  if (active === 'formData' && example.body?.[active]) {\n    const body = example.body[active]\n    xScalarBody.encoding = body.encoding === 'form-data' ? 'multipart/form-data' : 'application/x-www-form-urlencoded'\n\n    // TODO: Need to allow users to set these properties\n    xScalarBody.content = body.value.reduce<Record<string, XScalarFormDataValue>>((map, param) => {\n      /** TODO: We need to ensure only file or value is set */\n      map[param.key] = param.file\n        ? {\n            type: 'file',\n            file: null,\n          }\n        : {\n            type: 'string',\n            value: param.value,\n          }\n      return map\n    }, {})\n  }\n\n  if (example.body?.activeBody === 'raw') {\n    xScalarBody.encoding = contentMapping[example.body.raw?.encoding ?? 'text'] ?? 'text/plain'\n\n    xScalarBody.content = example.body.raw?.value ?? ''\n  }\n\n  const parameters: XScalarExample['parameters'] = {}\n\n  keysOf(example.parameters ?? {}).forEach((key) => {\n    if (example.parameters?.[key].length) {\n      parameters[key] = parameterArrayToObject(example.parameters[key])\n    }\n  })\n\n  return xScalarExampleSchema.parse({\n    /** Only add the body if we have content or the body should be a file */\n    body: xScalarBody.content || xScalarBody.encoding === 'binary' ? xScalarBody : undefined,\n    parameters,\n  })\n}\n\n// ---------------------------------------------------------------------------\n// Example Helpers\n\n/** Create new instance parameter from a request parameter */\nexport function createParamInstance(param: RequestParameter) {\n  const schema = param.schema as any\n\n  const firstExample = (() => {\n    if (param.examples && !Array.isArray(param.examples) && getObjectKeys(param.examples).length > 0) {\n      const exampleValues = Object.entries(param.examples).map(([_, example]) => {\n        // returns the external value if it exists\n        if (example.externalValue) {\n          return example.externalValue\n        }\n\n        // returns the value if it exists and is defined\n        // e.g. { examples: { foo: { value: 'bar' } } } would return ['bar']\n        return example.value\n      })\n\n      // returns the first example as selected value along other examples\n      return { value: exampleValues[0], examples: exampleValues }\n    }\n\n    // param example e.g. { example: 'foo' }\n    if (isDefined(param.example)) {\n      return { value: param.example }\n    }\n\n    // param examples e.g. { examples: ['foo', 'bar'] }\n    if (Array.isArray(param.examples) && param.examples.length > 0) {\n      return { value: param.examples[0] }\n    }\n\n    // schema example e.g. { example: 'foo' } while being discouraged\n    // see https://spec.openapis.org/oas/v3.1.1.html#fixed-fields-20\n    if (isDefined(schema?.example)) {\n      return { value: schema.example }\n    }\n\n    // schema examples e.g. { examples: ['foo', 'bar'] }\n    if (Array.isArray(schema?.examples) && schema.examples.length > 0) {\n      // For boolean type, default to false when using schema examples\n      if (schema?.type === 'boolean') {\n        return { value: schema.default ?? false }\n      }\n      return { value: schema.examples[0] }\n    }\n\n    // content examples e.g. { content: { 'application/json': { examples: { foo: { value: 'bar' } } } } }\n    if (param.content) {\n      const firstContentType = getObjectKeys(param.content)[0]\n      if (firstContentType) {\n        const content = (param.content as ParameterContent)[firstContentType]\n        if (content?.examples) {\n          const firstExampleKey = Object.keys(content.examples)[0]\n          if (firstExampleKey) {\n            const example = content.examples[firstExampleKey]\n            if (isDefined(example?.value)) {\n              return { value: example.value }\n            }\n          }\n        }\n        // content example e.g. { example: 'foo' }\n        if (isDefined(content?.example)) {\n          return { value: content.example }\n        }\n      }\n    }\n\n    return null\n  })() as null | { value: any; examples?: string[] }\n\n  /**\n   * TODO:\n   * - Need better value defaulting here\n   * - Need to handle non-string parameters much better\n   * - Need to handle unions/array values for schema\n   */\n  const value = String(firstExample?.value ?? schema?.default ?? '')\n\n  // Handle non-string enums and enums within items for array types\n  const parseEnum = (() => {\n    if (schema?.enum && schema?.type !== 'string') {\n      return schema.enum?.map(String)\n    }\n\n    if (schema?.items?.enum && schema?.type === 'array') {\n      return schema.items.enum.map(String)\n    }\n\n    return schema?.enum\n  })()\n\n  // Handle parameter examples\n  const examples =\n    firstExample?.examples ||\n    (schema?.examples && schema?.type !== 'string' ? schema.examples?.map(String) : schema?.examples)\n\n  // safe parse the example\n  const example = schemaModel(\n    {\n      ...schema,\n      key: param.name,\n      value,\n      description: param.description,\n      required: param.required,\n      /** Initialized all required properties to enabled */\n      enabled: !!param.required,\n      enum: parseEnum,\n      examples,\n    },\n    requestExampleParametersSchema,\n    false,\n  )\n\n  if (!example) {\n    console.warn(`Example at ${param.name} is invalid.`)\n    return requestExampleParametersSchema.parse({})\n  }\n\n  return example\n}\n\n/**\n * Create new request example from a request\n * Iterates the name of the example if provided\n */\nexport function createExampleFromRequest(request: Request, name: string, server?: Server): RequestExample {\n  // ---------------------------------------------------------------------------\n  // Populate all parameters with an example value\n  const parameters: Record<'path' | 'cookie' | 'header' | 'query' | 'headers', RequestExampleParameter[]> = {\n    path: [],\n    query: [],\n    cookie: [],\n    // deprecated TODO: add zod transform to remove\n    header: [],\n    headers: [{ key: 'Accept', value: '*/*', enabled: true }],\n  }\n\n  // Populated the separated params\n  request.parameters?.forEach((p) => parameters[p.in].push(createParamInstance(p)))\n\n  // TODO: add zod transform to remove header and only support headers\n  if (parameters.header.length > 0) {\n    parameters.headers = parameters.header\n    parameters.header = []\n  }\n\n  // Get content type header\n  const contentTypeHeader = parameters.headers.find((h) => h.key.toLowerCase() === 'content-type')\n\n  // ---------------------------------------------------------------------------\n  // Handle request body defaulting for various content type encodings\n  const body: ExampleRequestBody = {\n    activeBody: 'raw',\n  }\n\n  // If we have a request body or a content type header\n  if (request.requestBody || contentTypeHeader?.value) {\n    const requestBody = getRequestBodyFromOperation({\n      path: request.path,\n      information: {\n        requestBody: request.requestBody,\n      },\n    })\n\n    const contentType = request.requestBody ? requestBody?.mimeType : contentTypeHeader?.value\n\n    // Handle JSON and JSON-like mimetypes\n    if (contentType?.includes('/json') || contentType?.endsWith('+json')) {\n      body.activeBody = 'raw'\n      body.raw = {\n        encoding: 'json',\n        mimeType: contentType,\n        value: requestBody?.text ?? JSON.stringify({}),\n      }\n    }\n\n    if (contentType === 'application/xml') {\n      body.activeBody = 'raw'\n      body.raw = {\n        encoding: 'xml',\n        value: requestBody?.text ?? '',\n      }\n    }\n\n    /**\n     *  TODO: Are we loading example files from somewhere based on the spec?\n     *  How are we handling the body values\n     */\n    if (contentType === 'application/octet-stream') {\n      body.activeBody = 'binary'\n      body.binary = undefined\n    }\n\n    if (contentType === 'application/x-www-form-urlencoded' || contentType === 'multipart/form-data') {\n      body.activeBody = 'formData'\n      body.formData = {\n        encoding: contentType === 'application/x-www-form-urlencoded' ? 'urlencoded' : 'form-data',\n        value: (requestBody?.params || []).map((param) => ({\n          key: param.name,\n          value: param.value || '',\n          enabled: true,\n        })),\n      }\n    }\n\n    // Add the content-type header if it doesn't exist\n    if (requestBody?.mimeType && !contentTypeHeader) {\n      parameters.headers.push({\n        key: 'Content-Type',\n        value: requestBody.mimeType,\n        enabled: true,\n      })\n    }\n  }\n\n  const serverVariables = server ? getServerVariableExamples(server) : {}\n\n  // safe parse the example\n  const example = schemaModel(\n    {\n      requestUid: request.uid,\n      parameters,\n      name,\n      body,\n      serverVariables,\n    },\n    requestExampleSchema,\n    false,\n  )\n\n  if (!example) {\n    console.warn(`Example at ${request.uid} is invalid.`)\n    return requestExampleSchema.parse({})\n  }\n  return example\n}\n"],
+  "mappings": "AAAA,SAAS,mBAAmB;AAC5B,SAAS,iCAAiC;AAC1C,SAAS,cAAc;AACvB,SAA6B,oBAAoB;AACjD,SAAS,SAAS;AAElB,SAAS,iBAAiB;AAC1B,SAAS,qBAAqB;AAE9B,SAAS,mCAAmC;AAcrC,MAAM,iCAAiC,EAC3C,OAAO;AAAA,EACN,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE;AAAA,EAC1B,OAAO,EAAE,OAAO,OAAO,EAAE,QAAQ,EAAE;AAAA,EACnC,SAAS,EAAE,QAAQ,EAAE,QAAQ,IAAI;AAAA,EACjC,MAAM,EAAE,IAAI,EAAE,SAAS;AAAA,EACvB,aAAa,EAAE,OAAO,EAAE,SAAS;AAAA,EACjC,UAAU,EAAE,QAAQ,EAAE,SAAS;AAAA,EAC/B,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,SAAS;AAAA,EACnC,UAAU,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,SAAS;AAAA,EACpC,MAAM,EACH,MAAM;AAAA;AAAA,IAEL,EAAE,OAAO;AAAA;AAAA,IAET,EAAE,MAAM,EAAE,OAAO,CAAC;AAAA,EACpB,CAAC,EACA,SAAS;AAAA,EACZ,QAAQ,EAAE,OAAO,EAAE,SAAS;AAAA,EAC5B,SAAS,EAAE,OAAO,EAAE,SAAS;AAAA,EAC7B,SAAS,EAAE,OAAO,EAAE,SAAS;AAAA,EAC7B,SAAS,EAAE,IAAI,EAAE,SAAS;AAAA,EAC1B,UAAU,EAAE,QAAQ,EAAE,SAAS;AACjC,CAAC,EAEA,UAAU,CAAC,UAAU;AACpB,QAAM,OAAO,EAAE,GAAG,MAAM;AAGxB,MAAI,MAAM,QAAQ,KAAK,IAAI,KAAK,KAAK,KAAK,SAAS,MAAM,GAAG;AAC1D,SAAK,WAAW;AAAA,EAClB;AAGA,MAAI,MAAM,QAAQ,KAAK,IAAI,KAAK,KAAK,KAAK,WAAW,KAAK,KAAK,KAAK,SAAS,MAAM,GAAG;AACpF,SAAK,OAAO,KAAK,KAAK,KAAK,CAAC,SAAS,SAAS,MAAM;AAAA,EACtD;AAEA,SAAO;AACT,CAAC;AAGI,MAAM,yBAAyB,CAAC,WACrC,OAAO,OAA+B,CAAC,KAAK,UAAU;AACpD,MAAI,MAAM,GAAG,IAAI,MAAM;AACvB,SAAO;AACT,GAAG,CAAC,CAAC;AAKA,MAAM,yBAAyB,EACnC,OAAO;AAAA,EACN,KAAK,EAAE,OAAO;AAAA,EACd,QAAQ,EAAE,OAAO,EAAE,SAAS;AAC9B,CAAC,EACA,SAAS;AAaL,MAAM,uBAAuB,EAAE,MAAM;AAAA,EAC1C,EAAE,OAAO;AAAA,IACP,MAAM,EAAE,QAAQ,QAAQ;AAAA,IACxB,OAAO,EAAE,OAAO;AAAA,EAClB,CAAC;AAAA,EACD,EAAE,OAAO;AAAA,IACP,MAAM,EAAE,QAAQ,MAAM;AAAA,IACtB,MAAM;AAAA,EACR,CAAC;AACH,CAAC;AAYM,MAAM,6BAA6B,CAAC,QAAQ,QAAQ,QAAQ,cAAc,OAAO,QAAQ,KAAK;AAI9F,MAAM,kBAAkB;AAAA,EAC7B;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA;AAAA,EAEA;AACF;AAIA,MAAM,iBAAiD;AAAA,EACrD,MAAM;AAAA,EACN,MAAM;AAAA,EACN,MAAM;AAAA,EACN,YAAY;AAAA,EACZ,KAAK;AAAA,EACL,MAAM;AAAA,EACN,KAAK;AACP;AAOO,MAAM,2BAA2B,EAAE,OAAO;AAAA,EAC/C,KAAK,EACF,OAAO;AAAA,IACN,UAAU,EAAE,KAAK,0BAA0B;AAAA,IAC3C,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE;AAAA,IAC5B,UAAU,EAAE,OAAO,EAAE,SAAS;AAAA,EAChC,CAAC,EACA,SAAS;AAAA,EACZ,UAAU,EACP,OAAO;AAAA,IACN,UAAU,EAAE,MAAM,CAAC,EAAE,QAAQ,WAAW,GAAG,EAAE,QAAQ,YAAY,CAAC,CAAC,EAAE,QAAQ,WAAW;AAAA,IACxF,OAAO,+BAA+B,MAAM,EAAE,QAAQ,CAAC,CAAC;AAAA,EAC1D,CAAC,EACA,SAAS;AAAA,EACZ,QAAQ,EAAE,WAAW,IAAI,EAAE,SAAS;AAAA,EACpC,YAAY,EAAE,MAAM,CAAC,EAAE,QAAQ,KAAK,GAAG,EAAE,QAAQ,UAAU,GAAG,EAAE,QAAQ,QAAQ,CAAC,CAAC,EAAE,QAAQ,KAAK;AACnG,CAAC;AAKM,MAAM,2BAA2B,EAAE,OAAO;AAAA,EAC/C,UAAU,EAAE,KAAK,eAAe;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMhC,SAAS,EAAE,MAAM,CAAC,EAAE,OAAO,EAAE,OAAO,GAAG,EAAE,IAAI,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;AAAA;AAAA,EAE5D,MAAM,uBAAuB,SAAS;AACxC,CAAC;AAOM,MAAM,uBAAuB,EAAE,OAAO;AAAA,EAC3C,KAAK,aAAa,MAAgC;AAAA,EAClD,MAAM,EAAE,QAAQ,gBAAgB,EAAE,SAAS,EAAE,QAAQ,gBAAgB;AAAA,EACrE,YAAY,EAAE,OAAO,EAAE,MAAkC,EAAE,SAAS;AAAA,EACpE,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,QAAQ,MAAM;AAAA,EAC1C,MAAM,yBAAyB,SAAS,EAAE,QAAQ,CAAC,CAAC;AAAA,EACpD,YAAY,EACT,OAAO;AAAA,IACN,MAAM,+BAA+B,MAAM,EAAE,QAAQ,CAAC,CAAC;AAAA,IACvD,OAAO,+BAA+B,MAAM,EAAE,QAAQ,CAAC,CAAC;AAAA,IACxD,SAAS,+BAA+B,MAAM,EAAE,QAAQ,CAAC,EAAE,KAAK,UAAU,OAAO,OAAO,SAAS,KAAK,CAAC,CAAC;AAAA,IACxG,SAAS,+BAA+B,MAAM,EAAE,QAAQ,CAAC,CAAC;AAAA,EAC5D,CAAC,EACA,SAAS,EACT,QAAQ,CAAC,CAAC;AAAA;AAAA,EAEb,iBAAiB,EAAE,OAAO,EAAE,OAAO,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC,EAAE,SAAS;AACtE,CAAC;AAKD,MAAM,gCAAgC,EAAE,OAAO,EAAE,OAAO,GAAG,EAAE,OAAO,CAAC,EAAE,SAAS;AAGzE,MAAM,uBAAuB,EAAE,OAAO;AAAA;AAAA,EAE3C,MAAM,EAAE,OAAO,EAAE,SAAS;AAAA,EAC1B,MAAM,yBAAyB,SAAS;AAAA,EACxC,YAAY,EAAE,OAAO;AAAA,IACnB,MAAM;AAAA,IACN,OAAO;AAAA,IACP,SAAS;AAAA,IACT,SAAS;AAAA,EACX,CAAC;AACH,CAAC;AASM,SAAS,wBAAwB,SAAyB;AAC/D,QAAM,SAAS,QAAQ,MAAM;AAE7B,QAAM,cAAkC;AAAA,IACtC,UAAU;AAAA,IACV,SAAS;AAAA,EACX;AAEA,MAAI,QAAQ,MAAM,eAAe,UAAU;AACzC,gBAAY,WAAW;AAEvB,gBAAY,OAAO;AAAA,EACrB;AAEA,MAAI,WAAW,cAAc,QAAQ,OAAO,MAAM,GAAG;AACnD,UAAM,OAAO,QAAQ,KAAK,MAAM;AAChC,gBAAY,WAAW,KAAK,aAAa,cAAc,wBAAwB;AAG/E,gBAAY,UAAU,KAAK,MAAM,OAA6C,CAAC,KAAK,UAAU;AAE5F,UAAI,MAAM,GAAG,IAAI,MAAM,OACnB;AAAA,QACE,MAAM;AAAA,QACN,MAAM;AAAA,MACR,IACA;AAAA,QACE,MAAM;AAAA,QACN,OAAO,MAAM;AAAA,MACf;AACJ,aAAO;AAAA,IACT,GAAG,CAAC,CAAC;AAAA,EACP;AAEA,MAAI,QAAQ,MAAM,eAAe,OAAO;AACtC,gBAAY,WAAW,eAAe,QAAQ,KAAK,KAAK,YAAY,MAAM,KAAK;AAE/E,gBAAY,UAAU,QAAQ,KAAK,KAAK,SAAS;AAAA,EACnD;AAEA,QAAM,aAA2C,CAAC;AAElD,SAAO,QAAQ,cAAc,CAAC,CAAC,EAAE,QAAQ,CAAC,QAAQ;AAChD,QAAI,QAAQ,aAAa,GAAG,EAAE,QAAQ;AACpC,iBAAW,GAAG,IAAI,uBAAuB,QAAQ,WAAW,GAAG,CAAC;AAAA,IAClE;AAAA,EACF,CAAC;AAED,SAAO,qBAAqB,MAAM;AAAA;AAAA,IAEhC,MAAM,YAAY,WAAW,YAAY,aAAa,WAAW,cAAc;AAAA,IAC/E;AAAA,EACF,CAAC;AACH;AAMO,SAAS,oBAAoB,OAAyB;AAC3D,QAAM,SAAS,MAAM;AAErB,QAAM,gBAAgB,MAAM;AAC1B,QAAI,MAAM,YAAY,CAAC,MAAM,QAAQ,MAAM,QAAQ,KAAK,cAAc,MAAM,QAAQ,EAAE,SAAS,GAAG;AAChG,YAAM,gBAAgB,OAAO,QAAQ,MAAM,QAAQ,EAAE,IAAI,CAAC,CAAC,GAAGA,QAAO,MAAM;AAEzE,YAAIA,SAAQ,eAAe;AACzB,iBAAOA,SAAQ;AAAA,QACjB;AAIA,eAAOA,SAAQ;AAAA,MACjB,CAAC;AAGD,aAAO,EAAE,OAAO,cAAc,CAAC,GAAG,UAAU,cAAc;AAAA,IAC5D;AAGA,QAAI,UAAU,MAAM,OAAO,GAAG;AAC5B,aAAO,EAAE,OAAO,MAAM,QAAQ;AAAA,IAChC;AAGA,QAAI,MAAM,QAAQ,MAAM,QAAQ,KAAK,MAAM,SAAS,SAAS,GAAG;AAC9D,aAAO,EAAE,OAAO,MAAM,SAAS,CAAC,EAAE;AAAA,IACpC;AAIA,QAAI,UAAU,QAAQ,OAAO,GAAG;AAC9B,aAAO,EAAE,OAAO,OAAO,QAAQ;AAAA,IACjC;AAGA,QAAI,MAAM,QAAQ,QAAQ,QAAQ,KAAK,OAAO,SAAS,SAAS,GAAG;AAEjE,UAAI,QAAQ,SAAS,WAAW;AAC9B,eAAO,EAAE,OAAO,OAAO,WAAW,MAAM;AAAA,MAC1C;AACA,aAAO,EAAE,OAAO,OAAO,SAAS,CAAC,EAAE;AAAA,IACrC;AAGA,QAAI,MAAM,SAAS;AACjB,YAAM,mBAAmB,cAAc,MAAM,OAAO,EAAE,CAAC;AACvD,UAAI,kBAAkB;AACpB,cAAM,UAAW,MAAM,QAA6B,gBAAgB;AACpE,YAAI,SAAS,UAAU;AACrB,gBAAM,kBAAkB,OAAO,KAAK,QAAQ,QAAQ,EAAE,CAAC;AACvD,cAAI,iBAAiB;AACnB,kBAAMA,WAAU,QAAQ,SAAS,eAAe;AAChD,gBAAI,UAAUA,UAAS,KAAK,GAAG;AAC7B,qBAAO,EAAE,OAAOA,SAAQ,MAAM;AAAA,YAChC;AAAA,UACF;AAAA,QACF;AAEA,YAAI,UAAU,SAAS,OAAO,GAAG;AAC/B,iBAAO,EAAE,OAAO,QAAQ,QAAQ;AAAA,QAClC;AAAA,MACF;AAAA,IACF;AAEA,WAAO;AAAA,EACT,GAAG;AAQH,QAAM,QAAQ,OAAO,cAAc,SAAS,QAAQ,WAAW,EAAE;AAGjE,QAAM,aAAa,MAAM;AACvB,QAAI,QAAQ,QAAQ,QAAQ,SAAS,UAAU;AAC7C,aAAO,OAAO,MAAM,IAAI,MAAM;AAAA,IAChC;AAEA,QAAI,QAAQ,OAAO,QAAQ,QAAQ,SAAS,SAAS;AACnD,aAAO,OAAO,MAAM,KAAK,IAAI,MAAM;AAAA,IACrC;AAEA,WAAO,QAAQ;AAAA,EACjB,GAAG;AAGH,QAAM,WACJ,cAAc,aACb,QAAQ,YAAY,QAAQ,SAAS,WAAW,OAAO,UAAU,IAAI,MAAM,IAAI,QAAQ;AAG1F,QAAM,UAAU;AAAA,IACd;AAAA,MACE,GAAG;AAAA,MACH,KAAK,MAAM;AAAA,MACX;AAAA,MACA,aAAa,MAAM;AAAA,MACnB,UAAU,MAAM;AAAA;AAAA,MAEhB,SAAS,CAAC,CAAC,MAAM;AAAA,MACjB,MAAM;AAAA,MACN;AAAA,IACF;AAAA,IACA;AAAA,IACA;AAAA,EACF;AAEA,MAAI,CAAC,SAAS;AACZ,YAAQ,KAAK,cAAc,MAAM,IAAI,cAAc;AACnD,WAAO,+BAA+B,MAAM,CAAC,CAAC;AAAA,EAChD;AAEA,SAAO;AACT;AAMO,SAAS,yBAAyB,SAAkB,MAAc,QAAiC;AAGxG,QAAM,aAAoG;AAAA,IACxG,MAAM,CAAC;AAAA,IACP,OAAO,CAAC;AAAA,IACR,QAAQ,CAAC;AAAA;AAAA,IAET,QAAQ,CAAC;AAAA,IACT,SAAS,CAAC,EAAE,KAAK,UAAU,OAAO,OAAO,SAAS,KAAK,CAAC;AAAA,EAC1D;AAGA,UAAQ,YAAY,QAAQ,CAAC,MAAM,WAAW,EAAE,EAAE,EAAE,KAAK,oBAAoB,CAAC,CAAC,CAAC;AAGhF,MAAI,WAAW,OAAO,SAAS,GAAG;AAChC,eAAW,UAAU,WAAW;AAChC,eAAW,SAAS,CAAC;AAAA,EACvB;AAGA,QAAM,oBAAoB,WAAW,QAAQ,KAAK,CAAC,MAAM,EAAE,IAAI,YAAY,MAAM,cAAc;AAI/F,QAAM,OAA2B;AAAA,IAC/B,YAAY;AAAA,EACd;AAGA,MAAI,QAAQ,eAAe,mBAAmB,OAAO;AACnD,UAAM,cAAc,4BAA4B;AAAA,MAC9C,MAAM,QAAQ;AAAA,MACd,aAAa;AAAA,QACX,aAAa,QAAQ;AAAA,MACvB;AAAA,IACF,CAAC;AAED,UAAM,cAAc,QAAQ,cAAc,aAAa,WAAW,mBAAmB;AAGrF,QAAI,aAAa,SAAS,OAAO,KAAK,aAAa,SAAS,OAAO,GAAG;AACpE,WAAK,aAAa;AAClB,WAAK,MAAM;AAAA,QACT,UAAU;AAAA,QACV,UAAU;AAAA,QACV,OAAO,aAAa,QAAQ,KAAK,UAAU,CAAC,CAAC;AAAA,MAC/C;AAAA,IACF;AAEA,QAAI,gBAAgB,mBAAmB;AACrC,WAAK,aAAa;AAClB,WAAK,MAAM;AAAA,QACT,UAAU;AAAA,QACV,OAAO,aAAa,QAAQ;AAAA,MAC9B;AAAA,IACF;AAMA,QAAI,gBAAgB,4BAA4B;AAC9C,WAAK,aAAa;AAClB,WAAK,SAAS;AAAA,IAChB;AAEA,QAAI,gBAAgB,uCAAuC,gBAAgB,uBAAuB;AAChG,WAAK,aAAa;AAClB,WAAK,WAAW;AAAA,QACd,UAAU,gBAAgB,sCAAsC,eAAe;AAAA,QAC/E,QAAQ,aAAa,UAAU,CAAC,GAAG,IAAI,CAAC,WAAW;AAAA,UACjD,KAAK,MAAM;AAAA,UACX,OAAO,MAAM,SAAS;AAAA,UACtB,SAAS;AAAA,QACX,EAAE;AAAA,MACJ;AAAA,IACF;AAGA,QAAI,aAAa,YAAY,CAAC,mBAAmB;AAC/C,iBAAW,QAAQ,KAAK;AAAA,QACtB,KAAK;AAAA,QACL,OAAO,YAAY;AAAA,QACnB,SAAS;AAAA,MACX,CAAC;AAAA,IACH;AAAA,EACF;AAEA,QAAM,kBAAkB,SAAS,0BAA0B,MAAM,IAAI,CAAC;AAGtE,QAAM,UAAU;AAAA,IACd;AAAA,MACE,YAAY,QAAQ;AAAA,MACpB;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACF;AAAA,IACA;AAAA,IACA;AAAA,EACF;AAEA,MAAI,CAAC,SAAS;AACZ,YAAQ,KAAK,cAAc,QAAQ,GAAG,cAAc;AACpD,WAAO,qBAAqB,MAAM,CAAC,CAAC;AAAA,EACtC;AACA,SAAO;AACT;",
+  "names": ["example"]
+}

package/dist/entities/spec/requests.d.ts

@@ -1,6 +1,6 @@
 import { z } from 'zod';
 import { XScalarStability } from '@scalar/types';
-import { type RequestExample } from './request-examples.ts';
+import { type RequestExample } from './request-examples.js';
 export declare const requestMethods: readonly ["connect", "delete", "get", "head", "options", "patch", "post", "put", "trace"];
 export type RequestMethod = (typeof requestMethods)[number];
 /** A single set of populated values for a sent request */
@@ -537,11 +537,11 @@ export declare const requestSchema: z.ZodObject<z.objectUtil.extendShape<z.objec
     }>, "many">>>;
     'x-code-samples': z.ZodCatch<z.ZodOptional<z.ZodArray<z.ZodObject<{
         lang: z.ZodCatch<z.ZodOptional<z.ZodString>>;
-        label: z.ZodCatch<z.ZodOptional<z.ZodString>>;
+        label: z.ZodCatch<z.ZodOptional<z.ZodString /** Time in ms the request took */>>;
         source: z.ZodString;
     }, "strip", z.ZodTypeAny, {
         source: string;
-        label?: string | undefined;
+        label? /** The response method */: string | undefined;
         lang?: string | undefined;
     }, {
         source: string;
@@ -549,14 +549,12 @@ export declare const requestSchema: z.ZodObject<z.objectUtil.extendShape<z.objec
         lang?: unknown;
     }>, "many">>>;
     'x-custom-examples': z.ZodCatch<z.ZodOptional<z.ZodArray<z.ZodObject<{
-        lang: z.ZodCatch<
+        lang: 
         /** A stream reader for a streamable response body */
-        z.ZodOptional<z.ZodString>>;
+        z.ZodCatch<z.ZodOptional<z.ZodString>>;
         label: z.ZodCatch<z.ZodOptional<z.ZodString>>;
         source: z.ZodString;
-    }, "strip", z.
-    /** A single request/response set to save to the history stack */
-    ZodTypeAny, {
+    }, "strip", z.ZodTypeAny, {
         source: string;
         label?: string | undefined;
         lang?: string | undefined;

package/dist/entities/spec/requests.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"requests.d.ts","sourceRoot":"","sources":["../../../src/entities/spec/requests.ts"],"names":[],"mappings":"AAEA,OAAO,EAAkB,CAAC,EAAE,MAAM,KAAK,CAAA;AAGvC,OAAO,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAA;AAGhD,OAAO,EAAE,KAAK,cAAc,EAAwB,MAAM,uBAAuB,CAAA;AAGjF,eAAO,MAAM,cAAc,2FAA4F,CAAA;AAEvH,MAAM,MAAM,aAAa,GAAG,CAAC,OAAO,cAAc,CAAC,CAAC,MAAM,CAAC,CAAA;AAE3D,0DAA0D;AAC1D,MAAM,MAAM,gBAAgB,GAAG,IAAI,CAAC,QAAQ,EAAE,SAAS,CAAC,GAAG;IACzD,iEAAiE;IACjE,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC/B,wCAAwC;IACxC,gBAAgB,EAAE,MAAM,EAAE,CAAA;IAC1B,kCAAkC;IAClC,QAAQ,EAAE,MAAM,CAAA;IAChB,0BAA0B;IAC1B,MAAM,EAAE,MAAM,CAAA;IACd,0BAA0B;IAC1B,MAAM,EAAE,aAAa,CAAA;IACrB,uBAAuB;IACvB,IAAI,EAAE,MAAM,CAAA;CACb,GAAG,CACE;IACE,wBAAwB;IACxB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IACnB,iCAAiC;IACjC,IAAI,EAAE,MAAM,CAAA;CACb,GACD;IACE,qDAAqD;IACrD,MAAM,EAAE,2BAA2B,CAAC,UAAU,CAAC,CAAA;CAChD,CACJ,CAAA;AAEH,iEAAiE;AACjE,MAAM,MAAM,YAAY,GAAG;IACzB,OAAO,EAAE,cAAc,CAAA;IACvB,QAAQ,EAAE,gBAAgB,CAAA;IAC1B,SAAS,EAAE,MAAM,CAAA;CAClB,CAAA;AAMD,2CAA2C;AAC3C,eAAO,MAAM,gBAAgB;IAC3B;;;;;OAKG;;IAEH,kDAAkD;;IAElD,mHAAmH;;IAEnH;;;;OAIG;;IAEH;;;;;;OAMG;;IAEH;;;;;OAKG;;IAEH;;OAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAEH;;OAEG;;;;;;;;;;;;;;;;;;IAGH,uBAAuB;;IAEvB,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAEvB,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAGtB,CAAA;AAyCF,8CAA8C;AAC9C,eAAO,MAAM,aAAa;IA1FxB;;;;;OAKG;;IAEH,kDAAkD;;IAElD,mHAAmH;;IAEnH;;;;OAIG;;IAEH;;;;;;OAMG;;IAEH;;;;;OAKG;;IAEH;;OAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAEH;;OAEG;;;;;;;;;;;;;;;;;;IAGH,uBAAuB;;IAEvB,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAEvB,sBAAsB;;;;qBA5FJ,EAAG,QAAQ,CAAC,EAAE,WAAW,CAAC,EAAE,QAAQ,CAAE,EAAC,SAAS;cAClE,EAAG,QAAQ,CAAC,EAAE,WAAW,CAAC,EAAE,SAAS;eAAkB,EAAG,QAE5D,CAAC,EAAE,WAAW,CAAC,EAAE,SAAS;gBAAmB,EAAG,SAAS;gBAAiB,EAAI,UAAS;;aAEhF,CAAC;YAAkC,CAAC;;;aAEO,CAAC;YACpC,CAAC;;sBACV,EAAG,QAAQ,CAAC,EAAE,WAAW,CAAE,EAAC,QAAQ,CAAC,EAAE,SAAS;cACpD,EAAG,QAAQ,CAAC,EAAE,WAAW,CAAC,EAAE,SACzB;eAAkB,EAAG,QAAQ,CAAC,EAAE,WAChC,CAAC,EAAE,SAAS;gBACV,EAAI,SAAQ;gBACjB,EAAA,UAAU;;aAEP,CAAC;YACiB,CAAC;;;aAGX,CAAC;YAIN,CADC;;yBAGD,EAAA,QADK,CAAC,EAAE,WAAW,CAAC,EAAE,QAAQ,CAAC,EAC/B,SAAA;cACF,EAAA,QACA;QACE,qDAAqD;QACrD,EAAA,WADI,CAAE,EAAC,SAAS;eAAkB,EAAG,QAAQ,CAAC,EAAE,WACnD,CAAG,EAAA,SAAS;gBAAmB,EAAG,SAAS;gBAE9C;IAEF,iEAAiE;IACjE,UADS;;aAAyC,CAAC;YAChC,CAAC;;;aAGhB,CAAC;YAGA,CAAC;;;;;;;IAiFJ,eAAe;;IAEf,qBAAqB;;IAErB,kDAAkD;;IAElD,oCAAoC;;IAEpC,uDAAuD;;IAEvD,+DAA+D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EASlC,CAAA;AAE/B,MAAM,MAAM,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,CAAA;AACnD,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,CAAA"}
+{"version":3,"file":"requests.d.ts","sourceRoot":"","sources":["../../../src/entities/spec/requests.ts"],"names":[],"mappings":"AAEA,OAAO,EAAkB,CAAC,EAAE,MAAM,KAAK,CAAA;AAGvC,OAAO,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAA;AAGhD,OAAO,EAAE,KAAK,cAAc,EAAwB,MAAM,oBAAoB,CAAA;AAG9E,eAAO,MAAM,cAAc,2FAA4F,CAAA;AAEvH,MAAM,MAAM,aAAa,GAAG,CAAC,OAAO,cAAc,CAAC,CAAC,MAAM,CAAC,CAAA;AAE3D,0DAA0D;AAC1D,MAAM,MAAM,gBAAgB,GAAG,IAAI,CAAC,QAAQ,EAAE,SAAS,CAAC,GAAG;IACzD,iEAAiE;IACjE,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC/B,wCAAwC;IACxC,gBAAgB,EAAE,MAAM,EAAE,CAAA;IAC1B,kCAAkC;IAClC,QAAQ,EAAE,MAAM,CAAA;IAChB,0BAA0B;IAC1B,MAAM,EAAE,MAAM,CAAA;IACd,0BAA0B;IAC1B,MAAM,EAAE,aAAa,CAAA;IACrB,uBAAuB;IACvB,IAAI,EAAE,MAAM,CAAA;CACb,GAAG,CACE;IACE,wBAAwB;IACxB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IACnB,iCAAiC;IACjC,IAAI,EAAE,MAAM,CAAA;CACb,GACD;IACE,qDAAqD;IACrD,MAAM,EAAE,2BAA2B,CAAC,UAAU,CAAC,CAAA;CAChD,CACJ,CAAA;AAEH,iEAAiE;AACjE,MAAM,MAAM,YAAY,GAAG;IACzB,OAAO,EAAE,cAAc,CAAA;IACvB,QAAQ,EAAE,gBAAgB,CAAA;IAC1B,SAAS,EAAE,MAAM,CAAA;CAClB,CAAA;AAMD,2CAA2C;AAC3C,eAAO,MAAM,gBAAgB;IAC3B;;;;;OAKG;;IAEH,kDAAkD;;IAElD,mHAAmH;;IAEnH;;;;OAIG;;IAEH;;;;;;OAMG;;IAEH;;;;;OAKG;;IAEH;;OAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAEH;;OAEG;;;;;;;;;;;;;;;;;;IAGH,uBAAuB;;IAEvB,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAEvB,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAGtB,CAAA;AAyCF,8CAA8C;AAC9C,eAAO,MAAM,aAAa;IA1FxB;;;;;OAKG;;IAEH,kDAAkD;;IAElD,mHAAmH;;IAEnH;;;;OAIG;;IAEH;;;;;;OAMG;;IAEH;;;;;OAKG;;IAEH;;OAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAEH;;OAEG;;;;;;;;;;;;;;;;;;IAGH,uBAAuB;;IAEvB,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAEvB,sBAAsB;;;;qBA5FE,EAAI,QAAO,CAAC,EAAE,WAAW,CAAE,EAAC,QAAQ,CAAC,EAAE,SAAS;cAC/D,EAAG,QAAQ,CAAC,EAAE,WAAW,CAAC,EAAG,SAAQ;eAE/C,EAAG,QAAQ,CAAC,EAAE,WAAW,CAAE,EAAE,SAAQ;gBAAmB,EAAG,SAAS;gBAAkB,EAAE,UAAU;;aAEhF,CAAC;YAAkC,CAAC;;;aAGpD,CAAC;YAAuB,CAAC;;sBACV,EAAG,QAAQ,CAAC,EAAG,WAAU,CAAC,EAAG,QAAO,CAAC,EAAE,SAAS;cACpD,EAAG,QAAQ,CAAC,EAAE,WACvB,CAAC,EAAE,SAAS;eAAkB,EAAG,QACnC,CAAC,EAAE,WAAW,CAAC,EAAE,SACpB,CAAE,kCAAkC;gBAAjB,EAAG,SAAS;gBACnB,EAAE,UACT;;aAGH,CADD,CAAC,0BAA0B;YACtB,CAAC;;;aAIH,CAAC;YACe,CAAC;;yBAEP,EAAG,QAAQ,CAAC,EAAE,WAAW,CAAC,EAChC,QAAA,CAAC,EAAE,SAAS;;QAGZ,qDAAqD;QACrD,EAAA,QADE,CAAE,EAAE,WAAU,CAAC,EAAG,SAAQ;eAAkB,EAAG,QACtD,CAAK,EAAA,WAAS,CAAC,EAAE,SAAS;gBAAmB,EAAG,SAC/C;gBAGI,EAAG,UAAU;;aAA0C,CAAA;YAE7D,CAAC;;;aAEa,CAAC;YAGA,CAAC;;;;;;;IAiFhB,eAAe;;IAEf,qBAAqB;;IAErB,kDAAkD;;IAElD,oCAAoC;;IAEpC,uDAAuD;;IAEvD,+DAA+D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EASlC,CAAA;AAE/B,MAAM,MAAM,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,CAAA;AACnD,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,CAAA"}

package/dist/entities/spec/requests.js

@@ -1,108 +1,87 @@
-import { selectedSecuritySchemeUidSchema } from '../shared/utility.js';
-import { nanoidSchema } from '@scalar/types/utils';
-import { z } from 'zod';
-import { XCodeSamplesSchema } from '@scalar/openapi-types/schemas/extensions';
-import { XScalarStability } from '@scalar/types';
-import { oasSecurityRequirementSchema } from '@scalar/types/entities';
-import { oasParameterSchema } from './parameters.js';
-import { xScalarExampleSchema } from './request-examples.js';
-import { oasExternalDocumentationSchema } from './spec-objects.js';
-
-const requestMethods = ['connect', 'delete', 'get', 'head', 'options', 'patch', 'post', 'put', 'trace'];
+import { selectedSecuritySchemeUidSchema } from "../../entities/shared/utility.js";
+import { nanoidSchema } from "@scalar/types/utils";
+import { z } from "zod";
+import { XCodeSamplesSchema } from "@scalar/openapi-types/schemas/extensions";
+import { XScalarStability } from "@scalar/types";
+import { oasSecurityRequirementSchema } from "@scalar/types/entities";
+import { oasParameterSchema } from "./parameters.js";
+import { xScalarExampleSchema } from "./request-examples.js";
+import { oasExternalDocumentationSchema } from "./spec-objects.js";
+const requestMethods = ["connect", "delete", "get", "head", "options", "patch", "post", "put", "trace"];
 const requestBodySchema = z.any();
-/** Open API Compliant Request Validator */
 const oasRequestSchema = z.object({
-    /**
-     * A list of tags for API documentation control. Tags can be used for logical
-     * grouping of operations by resources or any other qualifier.
-     *
-     * These tags are the openapi spec tag names, not uids
-     */
-    'tags': z.string().array().optional(),
-    /** A short summary of what the operation does. */
-    'summary': z.string().optional(),
-    /** A verbose explanation of the operation behavior. CommonMark syntax MAY be used for rich text representation. */
-    'description': z.string().optional(),
-    /**
-     * 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 bin common programming naming conventions./
-     */
-    'operationId': z.string().optional(),
-    /**
-     * 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. To make security optional, an empty
-     * security requirement ({}) can be included in the array.
-     */
-    'security': z.array(oasSecurityRequirementSchema).optional(),
-    /**
-     * 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': requestBodySchema.optional(),
-    /**
-     * Request parameters
-     */
-    'parameters': oasParameterSchema.array().optional(),
-    /**
-     * External documentation object
-     */
-    'externalDocs': oasExternalDocumentationSchema.optional(),
-    'deprecated': z.boolean().optional(),
-    /** Response formats */
-    'responses': z.record(z.string(), z.any()).optional(),
-    /** xScalar examples */
-    'x-scalar-examples': z.record(z.string(), xScalarExampleSchema).optional(),
-    /** Hide operations */
-    'x-internal': z.boolean().optional(),
-    'x-scalar-ignore': z.boolean().optional(),
+  /**
+   * A list of tags for API documentation control. Tags can be used for logical
+   * grouping of operations by resources or any other qualifier.
+   *
+   * These tags are the openapi spec tag names, not uids
+   */
+  "tags": z.string().array().optional(),
+  /** A short summary of what the operation does. */
+  "summary": z.string().optional(),
+  /** A verbose explanation of the operation behavior. CommonMark syntax MAY be used for rich text representation. */
+  "description": z.string().optional(),
+  /**
+   * 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 bin common programming naming conventions./
+   */
+  "operationId": z.string().optional(),
+  /**
+   * 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. To make security optional, an empty
+   * security requirement ({}) can be included in the array.
+   */
+  "security": z.array(oasSecurityRequirementSchema).optional(),
+  /**
+   * 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": requestBodySchema.optional(),
+  /**
+   * Request parameters
+   */
+  "parameters": oasParameterSchema.array().optional(),
+  /**
+   * External documentation object
+   */
+  "externalDocs": oasExternalDocumentationSchema.optional(),
+  "deprecated": z.boolean().optional(),
+  /** Response formats */
+  "responses": z.record(z.string(), z.any()).optional(),
+  /** xScalar examples */
+  "x-scalar-examples": z.record(z.string(), xScalarExampleSchema).optional(),
+  /** Hide operations */
+  "x-internal": z.boolean().optional(),
+  "x-scalar-ignore": z.boolean().optional()
 });
-/**
- * An OpenAPI extension to indicate the stability of the operation
- *
- * @example
- * ```yaml
- * x-scalar-stability: deprecated
- * ```
- */
 const ScalarStabilitySchema = z.object({
-    'x-scalar-stability': z
-        .enum([XScalarStability.Deprecated, XScalarStability.Experimental, XScalarStability.Stable])
-        .optional()
-        .catch(undefined),
+  "x-scalar-stability": z.enum([XScalarStability.Deprecated, XScalarStability.Experimental, XScalarStability.Stable]).optional().catch(void 0)
 });
-/**
- * Extended properties added to the spec definition for client usage
- *
- * WARNING: DO NOT ADD PROPERTIES THAT SHARE A NAME WITH OAS OPERATION ENTITIES
- *
- * This object is directly converted to a spec operation during saving
- */
 const extendedRequestSchema = z.object({
-    type: z.literal('request').optional().default('request'),
-    uid: nanoidSchema.brand(),
-    /** Path Key */
-    path: z.string().optional().default(''),
-    /** Request Method */
-    method: z.enum(requestMethods).default('get'),
-    /** List of server UIDs specific to the request */
-    servers: z.string().brand().array().default([]),
-    /** The currently selected server */
-    selectedServerUid: z.string().brand().optional().nullable().default(null),
-    /** List of example UIDs associated with the request */
-    examples: z.string().brand().array().default([]),
-    /** List of security scheme UIDs associated with the request */
-    selectedSecuritySchemeUids: selectedSecuritySchemeUidSchema,
+  type: z.literal("request").optional().default("request"),
+  uid: nanoidSchema.brand(),
+  /** Path Key */
+  path: z.string().optional().default(""),
+  /** Request Method */
+  method: z.enum(requestMethods).default("get"),
+  /** List of server UIDs specific to the request */
+  servers: z.string().brand().array().default([]),
+  /** The currently selected server */
+  selectedServerUid: z.string().brand().optional().nullable().default(null),
+  /** List of example UIDs associated with the request */
+  examples: z.string().brand().array().default([]),
+  /** List of security scheme UIDs associated with the request */
+  selectedSecuritySchemeUids: selectedSecuritySchemeUidSchema
 });
-/** Unified request schema for client usage */
-const requestSchema = oasRequestSchema
-    .omit({ 'x-scalar-examples': true })
-    .merge(XCodeSamplesSchema)
-    .merge(ScalarStabilitySchema)
-    .merge(extendedRequestSchema);
-
-export { oasRequestSchema, requestMethods, requestSchema };
+const requestSchema = oasRequestSchema.omit({ "x-scalar-examples": true }).merge(XCodeSamplesSchema).merge(ScalarStabilitySchema).merge(extendedRequestSchema);
+export {
+  oasRequestSchema,
+  requestMethods,
+  requestSchema
+};
+//# sourceMappingURL=requests.js.map

package/dist/entities/spec/requests.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../src/entities/spec/requests.ts"],
+  "sourcesContent": ["import { selectedSecuritySchemeUidSchema } from '@/entities/shared/utility'\nimport { type ENTITY_BRANDS, nanoidSchema } from '@scalar/types/utils'\nimport { type ZodSchema, z } from 'zod'\n\nimport { XCodeSamplesSchema } from '@scalar/openapi-types/schemas/extensions'\nimport { XScalarStability } from '@scalar/types'\nimport { oasSecurityRequirementSchema } from '@scalar/types/entities'\nimport { oasParameterSchema } from './parameters'\nimport { type RequestExample, xScalarExampleSchema } from './request-examples'\nimport { oasExternalDocumentationSchema } from './spec-objects'\n\nexport const requestMethods = ['connect', 'delete', 'get', 'head', 'options', 'patch', 'post', 'put', 'trace'] as const\n\nexport type RequestMethod = (typeof requestMethods)[number]\n\n/** A single set of populated values for a sent request */\nexport type ResponseInstance = Omit<Response, 'headers'> & {\n  /** Store headers as an object to match what we had with axios */\n  headers: Record<string, string>\n  /** Keys of headers which set cookies */\n  cookieHeaderKeys: string[]\n  /** Time in ms the request took */\n  duration: number\n  /** The response status */\n  status: number\n  /** The response method */\n  method: RequestMethod\n  /** The request path */\n  path: string\n} & (\n    | {\n        /** The response data */\n        data: string | Blob\n        /** The response size in bytes */\n        size: number\n      }\n    | {\n        /** A stream reader for a streamable response body */\n        reader: ReadableStreamDefaultReader<Uint8Array>\n      }\n  )\n\n/** A single request/response set to save to the history stack */\nexport type RequestEvent = {\n  request: RequestExample\n  response: ResponseInstance\n  timestamp: number\n}\n\n// TODO: Type body definitions\ntype RequestBody = object\nconst requestBodySchema = z.any() satisfies ZodSchema<RequestBody>\n\n/** Open API Compliant Request Validator */\nexport const oasRequestSchema = z.object({\n  /**\n   * A list of tags for API documentation control. Tags can be used for logical\n   * grouping of operations by resources or any other qualifier.\n   *\n   * These tags are the openapi spec tag names, not uids\n   */\n  'tags': z.string().array().optional(),\n  /** A short summary of what the operation does. */\n  'summary': z.string().optional(),\n  /** A verbose explanation of the operation behavior. CommonMark syntax MAY be used for rich text representation. */\n  'description': z.string().optional(),\n  /**\n   * Unique string used to identify the operation. The id MUST be unique among all operations described in the API.\n   * The operationId value is case-sensitive. Tools and libraries MAY use the operationId to uniquely identify an\n   * operation, therefore, it is RECOMMENDED to follow bin common programming naming conventions./\n   */\n  'operationId': z.string().optional(),\n  /**\n   * A declaration of which security mechanisms can be used across the API. The list of\n   * values includes alternative security requirement objects that can be used. Only\n   * one of the security requirement objects need to be satisfied to authorize a request.\n   * Individual operations can override this definition. To make security optional, an empty\n   * security requirement ({}) can be included in the array.\n   */\n  'security': z.array(oasSecurityRequirementSchema).optional(),\n  /**\n   * The request body applicable for this operation. The requestBody is fully supported in HTTP methods where the\n   * HTTP 1.1 specification [RFC7231] has explicitly defined semantics for request bodies. In other cases where the\n   * HTTP spec is vague (such as GET, HEAD and DELETE), requestBody is permitted but does not have well-defined\n   * semantics and SHOULD be avoided if possible.\n   */\n  'requestBody': requestBodySchema.optional(),\n  /**\n   * Request parameters\n   */\n  'parameters': oasParameterSchema.array().optional(),\n  /**\n   * External documentation object\n   */\n  'externalDocs': oasExternalDocumentationSchema.optional(),\n  'deprecated': z.boolean().optional(),\n  /** Response formats */\n  'responses': z.record(z.string(), z.any()).optional(),\n  /** xScalar examples */\n  'x-scalar-examples': z.record(z.string(), xScalarExampleSchema).optional(),\n  /** Hide operations */\n  'x-internal': z.boolean().optional(),\n  'x-scalar-ignore': z.boolean().optional(),\n})\n\n/**\n * An OpenAPI extension to indicate the stability of the operation\n *\n * @example\n * ```yaml\n * x-scalar-stability: deprecated\n * ```\n */\nconst ScalarStabilitySchema = z.object({\n  'x-scalar-stability': z\n    .enum([XScalarStability.Deprecated, XScalarStability.Experimental, XScalarStability.Stable])\n    .optional()\n    .catch(undefined),\n})\n\n/**\n * Extended properties added to the spec definition for client usage\n *\n * WARNING: DO NOT ADD PROPERTIES THAT SHARE A NAME WITH OAS OPERATION ENTITIES\n *\n * This object is directly converted to a spec operation during saving\n */\nconst extendedRequestSchema = z.object({\n  type: z.literal('request').optional().default('request'),\n  uid: nanoidSchema.brand<ENTITY_BRANDS['OPERATION']>(),\n  /** Path Key */\n  path: z.string().optional().default(''),\n  /** Request Method */\n  method: z.enum(requestMethods).default('get'),\n  /** List of server UIDs specific to the request */\n  servers: z.string().brand<ENTITY_BRANDS['SERVER']>().array().default([]),\n  /** The currently selected server */\n  selectedServerUid: z.string().brand<ENTITY_BRANDS['SERVER']>().optional().nullable().default(null),\n  /** List of example UIDs associated with the request */\n  examples: z.string().brand<ENTITY_BRANDS['EXAMPLE']>().array().default([]),\n  /** List of security scheme UIDs associated with the request */\n  selectedSecuritySchemeUids: selectedSecuritySchemeUidSchema,\n})\n\n/** Unified request schema for client usage */\nexport const requestSchema = oasRequestSchema\n  .omit({ 'x-scalar-examples': true })\n  .merge(XCodeSamplesSchema)\n  .merge(ScalarStabilitySchema)\n  .merge(extendedRequestSchema)\n\nexport type Request = z.infer<typeof requestSchema>\nexport type RequestPayload = z.input<typeof requestSchema>\n"],
+  "mappings": "AAAA,SAAS,uCAAuC;AAChD,SAA6B,oBAAoB;AACjD,SAAyB,SAAS;AAElC,SAAS,0BAA0B;AACnC,SAAS,wBAAwB;AACjC,SAAS,oCAAoC;AAC7C,SAAS,0BAA0B;AACnC,SAA8B,4BAA4B;AAC1D,SAAS,sCAAsC;AAExC,MAAM,iBAAiB,CAAC,WAAW,UAAU,OAAO,QAAQ,WAAW,SAAS,QAAQ,OAAO,OAAO;AAwC7G,MAAM,oBAAoB,EAAE,IAAI;AAGzB,MAAM,mBAAmB,EAAE,OAAO;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOvC,QAAQ,EAAE,OAAO,EAAE,MAAM,EAAE,SAAS;AAAA;AAAA,EAEpC,WAAW,EAAE,OAAO,EAAE,SAAS;AAAA;AAAA,EAE/B,eAAe,EAAE,OAAO,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMnC,eAAe,EAAE,OAAO,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQnC,YAAY,EAAE,MAAM,4BAA4B,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAO3D,eAAe,kBAAkB,SAAS;AAAA;AAAA;AAAA;AAAA,EAI1C,cAAc,mBAAmB,MAAM,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA,EAIlD,gBAAgB,+BAA+B,SAAS;AAAA,EACxD,cAAc,EAAE,QAAQ,EAAE,SAAS;AAAA;AAAA,EAEnC,aAAa,EAAE,OAAO,EAAE,OAAO,GAAG,EAAE,IAAI,CAAC,EAAE,SAAS;AAAA;AAAA,EAEpD,qBAAqB,EAAE,OAAO,EAAE,OAAO,GAAG,oBAAoB,EAAE,SAAS;AAAA;AAAA,EAEzE,cAAc,EAAE,QAAQ,EAAE,SAAS;AAAA,EACnC,mBAAmB,EAAE,QAAQ,EAAE,SAAS;AAC1C,CAAC;AAUD,MAAM,wBAAwB,EAAE,OAAO;AAAA,EACrC,sBAAsB,EACnB,KAAK,CAAC,iBAAiB,YAAY,iBAAiB,cAAc,iBAAiB,MAAM,CAAC,EAC1F,SAAS,EACT,MAAM,MAAS;AACpB,CAAC;AASD,MAAM,wBAAwB,EAAE,OAAO;AAAA,EACrC,MAAM,EAAE,QAAQ,SAAS,EAAE,SAAS,EAAE,QAAQ,SAAS;AAAA,EACvD,KAAK,aAAa,MAAkC;AAAA;AAAA,EAEpD,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE;AAAA;AAAA,EAEtC,QAAQ,EAAE,KAAK,cAAc,EAAE,QAAQ,KAAK;AAAA;AAAA,EAE5C,SAAS,EAAE,OAAO,EAAE,MAA+B,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;AAAA;AAAA,EAEvE,mBAAmB,EAAE,OAAO,EAAE,MAA+B,EAAE,SAAS,EAAE,SAAS,EAAE,QAAQ,IAAI;AAAA;AAAA,EAEjG,UAAU,EAAE,OAAO,EAAE,MAAgC,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;AAAA;AAAA,EAEzE,4BAA4B;AAC9B,CAAC;AAGM,MAAM,gBAAgB,iBAC1B,KAAK,EAAE,qBAAqB,KAAK,CAAC,EAClC,MAAM,kBAAkB,EACxB,MAAM,qBAAqB,EAC3B,MAAM,qBAAqB;",
+  "names": []
+}

package/dist/entities/spec/server.js

@@ -1,70 +1,54 @@
-import { nanoidSchema } from '@scalar/types/utils';
-import { z } from 'zod';
-
-/**
- * Server Variable Object
- *
- * An object representing a Server Variable for server URL template substitution.
- *
- * @see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.1.md#server-variable-object
- */
+import { nanoidSchema } from "@scalar/types/utils";
+import { z } from "zod";
 const oasServerVariableSchema = z.object({
-    /**
-     * An enumeration of string values to be used if the substitution options are from a limited set. The array MUST NOT be empty.
-     */
-    enum: z.array(z.string()).optional(),
-    /**
-     * REQUIRED. The default value to use for substitution, which SHALL be sent if an alternate value is not supplied.
-     * Note this behavior is different than the Schema Object's treatment of default values, because in those cases
-     * parameter values are optional. If the enum is defined, the value MUST exist in the enum's values.
-     */
-    default: z.string().optional(),
-    /**
-     * An optional description for the server variable. CommonMark syntax MAY be used for rich text representation.
-     */
-    description: z.string().optional(),
+  /**
+   * An enumeration of string values to be used if the substitution options are from a limited set. The array MUST NOT be empty.
+   */
+  enum: z.array(z.string()).optional(),
+  /**
+   * REQUIRED. The default value to use for substitution, which SHALL be sent if an alternate value is not supplied.
+   * Note this behavior is different than the Schema Object's treatment of default values, because in those cases
+   * parameter values are optional. If the enum is defined, the value MUST exist in the enum's values.
+   */
+  default: z.string().optional(),
+  /**
+   * An optional description for the server variable. CommonMark syntax MAY be used for rich text representation.
+   */
+  description: z.string().optional()
 });
-/** Extended schema for server variables */
-const extendedServerVariableSchema = oasServerVariableSchema
-    .extend({
-    /** The value of the variable */
-    value: z.string().optional(),
-})
-    .refine((data) => {
-    // Set default to the first enum value if invalid
-    if (Array.isArray(data.enum) && !data.enum.includes(data.default ?? '') && data.enum.length > 0) {
-        data.default = data.enum[0];
-    }
-    if (Array.isArray(data.enum) && data.enum.length === 0) {
-        delete data.enum;
-    }
-    // Always return true since we’ve modified the data to be valid
-    return true;
+const extendedServerVariableSchema = oasServerVariableSchema.extend({
+  /** The value of the variable */
+  value: z.string().optional()
+}).refine((data) => {
+  if (Array.isArray(data.enum) && !data.enum.includes(data.default ?? "") && data.enum.length > 0) {
+    data.default = data.enum[0];
+  }
+  if (Array.isArray(data.enum) && data.enum.length === 0) {
+    delete data.enum;
+  }
+  return true;
 });
-/**
- * Server Object
- *
- * An object representing a Server.
- *
- * @see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.1.md#server-object
- */
 const oasServerSchema = z.object({
-    /**
-     * REQUIRED. A URL to the target host. This URL supports Server Variables and MAY be relative, to indicate that
-     * the host location is relative to the location where the OpenAPI document is being served. Variable substitutions
-     * will be made when a variable is named in {brackets}.
-     */
-    url: z.string(),
-    /**
-     * An optional string describing the host designated by the URL. CommonMark syntax MAY be used for rich text
-     * representation.
-     */
-    description: z.string().optional(),
-    /** A map between a variable name and its value. The value is used for substitution in the server's URL template. */
-    variables: z.record(z.string(), extendedServerVariableSchema).optional(),
+  /**
+   * REQUIRED. A URL to the target host. This URL supports Server Variables and MAY be relative, to indicate that
+   * the host location is relative to the location where the OpenAPI document is being served. Variable substitutions
+   * will be made when a variable is named in {brackets}.
+   */
+  url: z.string(),
+  /**
+   * An optional string describing the host designated by the URL. CommonMark syntax MAY be used for rich text
+   * representation.
+   */
+  description: z.string().optional(),
+  /** A map between a variable name and its value. The value is used for substitution in the server's URL template. */
+  variables: z.record(z.string(), extendedServerVariableSchema).optional()
 });
 const serverSchema = oasServerSchema.extend({
-    uid: nanoidSchema.brand(),
+  uid: nanoidSchema.brand()
 });
-
-export { oasServerSchema, oasServerVariableSchema, serverSchema };
+export {
+  oasServerSchema,
+  oasServerVariableSchema,
+  serverSchema
+};
+//# sourceMappingURL=server.js.map

package/dist/entities/spec/server.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../src/entities/spec/server.ts"],
+  "sourcesContent": ["import { type ENTITY_BRANDS, nanoidSchema } from '@scalar/types/utils'\nimport { z } from 'zod'\n\n/**\n * Server Variable Object\n *\n * An object representing a Server Variable for server URL template substitution.\n *\n * @see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.1.md#server-variable-object\n */\nexport const oasServerVariableSchema = z.object({\n  /**\n   * An enumeration of string values to be used if the substitution options are from a limited set. The array MUST NOT be empty.\n   */\n  enum: z.array(z.string()).optional(),\n  /**\n   * REQUIRED. The default value to use for substitution, which SHALL be sent if an alternate value is not supplied.\n   * Note this behavior is different than the Schema Object's treatment of default values, because in those cases\n   * parameter values are optional. If the enum is defined, the value MUST exist in the enum's values.\n   */\n  default: z.string().optional(),\n  /**\n   * An optional description for the server variable. CommonMark syntax MAY be used for rich text representation.\n   */\n  description: z.string().optional(),\n})\n\n/** Extended schema for server variables */\nconst extendedServerVariableSchema = oasServerVariableSchema\n  .extend({\n    /** The value of the variable */\n    value: z.string().optional(),\n  })\n  .refine((data) => {\n    // Set default to the first enum value if invalid\n    if (Array.isArray(data.enum) && !data.enum.includes(data.default ?? '') && data.enum.length > 0) {\n      data.default = data.enum[0]\n    }\n\n    if (Array.isArray(data.enum) && data.enum.length === 0) {\n      delete data.enum\n    }\n\n    // Always return true since we\u2019ve modified the data to be valid\n    return true\n  })\n\n/**\n * Server Object\n *\n * An object representing a Server.\n *\n * @see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.1.md#server-object\n */\nexport const oasServerSchema = z.object({\n  /**\n   * REQUIRED. A URL to the target host. This URL supports Server Variables and MAY be relative, to indicate that\n   * the host location is relative to the location where the OpenAPI document is being served. Variable substitutions\n   * will be made when a variable is named in {brackets}.\n   */\n  url: z.string(),\n  /**\n   * An optional string describing the host designated by the URL. CommonMark syntax MAY be used for rich text\n   * representation.\n   */\n  description: z.string().optional(),\n  /** A map between a variable name and its value. The value is used for substitution in the server's URL template. */\n  variables: z.record(z.string(), extendedServerVariableSchema).optional(),\n})\n\nexport const serverSchema = oasServerSchema.extend({\n  uid: nanoidSchema.brand<ENTITY_BRANDS['SERVER']>(),\n})\n\nexport type Server = z.infer<typeof serverSchema>\nexport type ServerPayload = z.input<typeof serverSchema>\n"],
+  "mappings": "AAAA,SAA6B,oBAAoB;AACjD,SAAS,SAAS;AASX,MAAM,0BAA0B,EAAE,OAAO;AAAA;AAAA;AAAA;AAAA,EAI9C,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMnC,SAAS,EAAE,OAAO,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA,EAI7B,aAAa,EAAE,OAAO,EAAE,SAAS;AACnC,CAAC;AAGD,MAAM,+BAA+B,wBAClC,OAAO;AAAA;AAAA,EAEN,OAAO,EAAE,OAAO,EAAE,SAAS;AAC7B,CAAC,EACA,OAAO,CAAC,SAAS;AAEhB,MAAI,MAAM,QAAQ,KAAK,IAAI,KAAK,CAAC,KAAK,KAAK,SAAS,KAAK,WAAW,EAAE,KAAK,KAAK,KAAK,SAAS,GAAG;AAC/F,SAAK,UAAU,KAAK,KAAK,CAAC;AAAA,EAC5B;AAEA,MAAI,MAAM,QAAQ,KAAK,IAAI,KAAK,KAAK,KAAK,WAAW,GAAG;AACtD,WAAO,KAAK;AAAA,EACd;AAGA,SAAO;AACT,CAAC;AASI,MAAM,kBAAkB,EAAE,OAAO;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMtC,KAAK,EAAE,OAAO;AAAA;AAAA;AAAA;AAAA;AAAA,EAKd,aAAa,EAAE,OAAO,EAAE,SAAS;AAAA;AAAA,EAEjC,WAAW,EAAE,OAAO,EAAE,OAAO,GAAG,4BAA4B,EAAE,SAAS;AACzE,CAAC;AAEM,MAAM,eAAe,gBAAgB,OAAO;AAAA,EACjD,KAAK,aAAa,MAA+B;AACnD,CAAC;",
+  "names": []
+}

package/dist/entities/spec/server.test.js

@@ -0,0 +1,120 @@
+import { describe, expect, it } from "vitest";
+import { serverSchema } from "./server.js";
+describe("serverSchema", () => {
+  it("validates valid server object", () => {
+    const server = { url: "https://api.example.com" };
+    expect(serverSchema.parse(server)).toMatchObject(server);
+  });
+  it("validates server with description", () => {
+    const server = {
+      url: "https://api.example.com",
+      description: "Production API"
+    };
+    expect(serverSchema.parse(server)).toMatchObject(server);
+  });
+  it("validates server with variables", () => {
+    const server = {
+      url: "https://{username}.example.com",
+      variables: {
+        username: {
+          default: "demo"
+        }
+      }
+    };
+    expect(serverSchema.parse(server)).toMatchObject(server);
+  });
+  it("validates server with enum variables", () => {
+    const server = {
+      url: "https://{environment}.example.com",
+      variables: {
+        environment: {
+          enum: ["dev", "staging", "prod"],
+          default: "dev",
+          description: "Environment selection"
+        },
+        username: {
+          // invalid enum
+          enum: [],
+          default: "demo",
+          description: "Username selection"
+        },
+        version: {
+          enum: ["v1", "v2"],
+          description: "Version selection"
+        }
+      }
+    };
+    expect(serverSchema.parse(server)).toStrictEqual({
+      uid: expect.any(String),
+      url: "https://{environment}.example.com",
+      variables: {
+        environment: {
+          enum: ["dev", "staging", "prod"],
+          // kept
+          default: "dev",
+          description: "Environment selection"
+        },
+        username: {
+          // enum omitted
+          default: "demo",
+          description: "Username selection"
+        },
+        version: {
+          enum: ["v1", "v2"],
+          // added
+          default: "v1",
+          description: "Version selection"
+        }
+      }
+    });
+  });
+  it("fails when URL is missing", () => {
+    const server = {};
+    expect(() => serverSchema.parse(server)).toThrow();
+  });
+  it("fails when variable default is not in enum", () => {
+    const server = {
+      url: "https://{environment}.example.com",
+      variables: {
+        environment: {
+          enum: ["dev", "staging", "prod"],
+          default: "invalid",
+          description: "Environment selection"
+        }
+      }
+    };
+    expect(serverSchema.parse(server)).toMatchObject({
+      url: "https://{environment}.example.com",
+      variables: {
+        environment: {
+          enum: ["dev", "staging", "prod"],
+          default: "dev",
+          description: "Environment selection"
+        }
+      }
+    });
+  });
+  it("validates server with relative URL", () => {
+    const server = {
+      url: "/api/v1",
+      description: "Relative URL"
+    };
+    expect(serverSchema.parse(server)).toMatchObject(server);
+  });
+  it("validates server with multiple variables", () => {
+    const server = {
+      url: "https://{username}.{domain}.com",
+      variables: {
+        username: {
+          default: "demo"
+        },
+        domain: {
+          enum: ["example", "test"],
+          default: "example"
+        }
+      }
+    };
+    expect(serverSchema.parse(server)).toMatchObject(server);
+  });
+});
+//# sourceMappingURL=server.test.js.map

package/dist/entities/spec/server.test.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../src/entities/spec/server.test.ts"],
+  "sourcesContent": ["import { describe, expect, it } from 'vitest'\n\nimport { serverSchema } from './server'\n\ndescribe('serverSchema', () => {\n  it('validates valid server object', () => {\n    const server = { url: 'https://api.example.com' }\n    expect(serverSchema.parse(server)).toMatchObject(server)\n  })\n\n  it('validates server with description', () => {\n    const server = {\n      url: 'https://api.example.com',\n      description: 'Production API',\n    }\n    expect(serverSchema.parse(server)).toMatchObject(server)\n  })\n\n  it('validates server with variables', () => {\n    const server = {\n      url: 'https://{username}.example.com',\n      variables: {\n        username: {\n          default: 'demo',\n        },\n      },\n    }\n    expect(serverSchema.parse(server)).toMatchObject(server)\n  })\n\n  it('validates server with enum variables', () => {\n    const server = {\n      url: 'https://{environment}.example.com',\n      variables: {\n        environment: {\n          enum: ['dev', 'staging', 'prod'],\n          default: 'dev',\n          description: 'Environment selection',\n        },\n        username: {\n          // invalid enum\n          enum: [],\n          default: 'demo',\n          description: 'Username selection',\n        },\n        version: {\n          enum: ['v1', 'v2'],\n          description: 'Version selection',\n        },\n      },\n    }\n\n    expect(serverSchema.parse(server)).toStrictEqual({\n      uid: expect.any(String),\n      url: 'https://{environment}.example.com',\n      variables: {\n        environment: {\n          enum: ['dev', 'staging', 'prod'],\n          // kept\n          default: 'dev',\n          description: 'Environment selection',\n        },\n        username: {\n          // enum omitted\n          default: 'demo',\n          description: 'Username selection',\n        },\n        version: {\n          enum: ['v1', 'v2'],\n          // added\n          default: 'v1',\n          description: 'Version selection',\n        },\n      },\n    })\n  })\n\n  it('fails when URL is missing', () => {\n    const server = {}\n    expect(() => serverSchema.parse(server)).toThrow()\n  })\n\n  it('fails when variable default is not in enum', () => {\n    const server = {\n      url: 'https://{environment}.example.com',\n      variables: {\n        environment: {\n          enum: ['dev', 'staging', 'prod'],\n          default: 'invalid',\n          description: 'Environment selection',\n        },\n      },\n    }\n\n    expect(serverSchema.parse(server)).toMatchObject({\n      url: 'https://{environment}.example.com',\n      variables: {\n        environment: {\n          enum: ['dev', 'staging', 'prod'],\n          default: 'dev',\n          description: 'Environment selection',\n        },\n      },\n    })\n  })\n\n  it('validates server with relative URL', () => {\n    const server = {\n      url: '/api/v1',\n      description: 'Relative URL',\n    }\n    expect(serverSchema.parse(server)).toMatchObject(server)\n  })\n\n  it('validates server with multiple variables', () => {\n    const server = {\n      url: 'https://{username}.{domain}.com',\n      variables: {\n        username: {\n          default: 'demo',\n        },\n        domain: {\n          enum: ['example', 'test'],\n          default: 'example',\n        },\n      },\n    }\n    expect(serverSchema.parse(server)).toMatchObject(server)\n  })\n})\n"],
+  "mappings": "AAAA,SAAS,UAAU,QAAQ,UAAU;AAErC,SAAS,oBAAoB;AAE7B,SAAS,gBAAgB,MAAM;AAC7B,KAAG,iCAAiC,MAAM;AACxC,UAAM,SAAS,EAAE,KAAK,0BAA0B;AAChD,WAAO,aAAa,MAAM,MAAM,CAAC,EAAE,cAAc,MAAM;AAAA,EACzD,CAAC;AAED,KAAG,qCAAqC,MAAM;AAC5C,UAAM,SAAS;AAAA,MACb,KAAK;AAAA,MACL,aAAa;AAAA,IACf;AACA,WAAO,aAAa,MAAM,MAAM,CAAC,EAAE,cAAc,MAAM;AAAA,EACzD,CAAC;AAED,KAAG,mCAAmC,MAAM;AAC1C,UAAM,SAAS;AAAA,MACb,KAAK;AAAA,MACL,WAAW;AAAA,QACT,UAAU;AAAA,UACR,SAAS;AAAA,QACX;AAAA,MACF;AAAA,IACF;AACA,WAAO,aAAa,MAAM,MAAM,CAAC,EAAE,cAAc,MAAM;AAAA,EACzD,CAAC;AAED,KAAG,wCAAwC,MAAM;AAC/C,UAAM,SAAS;AAAA,MACb,KAAK;AAAA,MACL,WAAW;AAAA,QACT,aAAa;AAAA,UACX,MAAM,CAAC,OAAO,WAAW,MAAM;AAAA,UAC/B,SAAS;AAAA,UACT,aAAa;AAAA,QACf;AAAA,QACA,UAAU;AAAA;AAAA,UAER,MAAM,CAAC;AAAA,UACP,SAAS;AAAA,UACT,aAAa;AAAA,QACf;AAAA,QACA,SAAS;AAAA,UACP,MAAM,CAAC,MAAM,IAAI;AAAA,UACjB,aAAa;AAAA,QACf;AAAA,MACF;AAAA,IACF;AAEA,WAAO,aAAa,MAAM,MAAM,CAAC,EAAE,cAAc;AAAA,MAC/C,KAAK,OAAO,IAAI,MAAM;AAAA,MACtB,KAAK;AAAA,MACL,WAAW;AAAA,QACT,aAAa;AAAA,UACX,MAAM,CAAC,OAAO,WAAW,MAAM;AAAA;AAAA,UAE/B,SAAS;AAAA,UACT,aAAa;AAAA,QACf;AAAA,QACA,UAAU;AAAA;AAAA,UAER,SAAS;AAAA,UACT,aAAa;AAAA,QACf;AAAA,QACA,SAAS;AAAA,UACP,MAAM,CAAC,MAAM,IAAI;AAAA;AAAA,UAEjB,SAAS;AAAA,UACT,aAAa;AAAA,QACf;AAAA,MACF;AAAA,IACF,CAAC;AAAA,EACH,CAAC;AAED,KAAG,6BAA6B,MAAM;AACpC,UAAM,SAAS,CAAC;AAChB,WAAO,MAAM,aAAa,MAAM,MAAM,CAAC,EAAE,QAAQ;AAAA,EACnD,CAAC;AAED,KAAG,8CAA8C,MAAM;AACrD,UAAM,SAAS;AAAA,MACb,KAAK;AAAA,MACL,WAAW;AAAA,QACT,aAAa;AAAA,UACX,MAAM,CAAC,OAAO,WAAW,MAAM;AAAA,UAC/B,SAAS;AAAA,UACT,aAAa;AAAA,QACf;AAAA,MACF;AAAA,IACF;AAEA,WAAO,aAAa,MAAM,MAAM,CAAC,EAAE,cAAc;AAAA,MAC/C,KAAK;AAAA,MACL,WAAW;AAAA,QACT,aAAa;AAAA,UACX,MAAM,CAAC,OAAO,WAAW,MAAM;AAAA,UAC/B,SAAS;AAAA,UACT,aAAa;AAAA,QACf;AAAA,MACF;AAAA,IACF,CAAC;AAAA,EACH,CAAC;AAED,KAAG,sCAAsC,MAAM;AAC7C,UAAM,SAAS;AAAA,MACb,KAAK;AAAA,MACL,aAAa;AAAA,IACf;AACA,WAAO,aAAa,MAAM,MAAM,CAAC,EAAE,cAAc,MAAM;AAAA,EACzD,CAAC;AAED,KAAG,4CAA4C,MAAM;AACnD,UAAM,SAAS;AAAA,MACb,KAAK;AAAA,MACL,WAAW;AAAA,QACT,UAAU;AAAA,UACR,SAAS;AAAA,QACX;AAAA,QACA,QAAQ;AAAA,UACN,MAAM,CAAC,WAAW,MAAM;AAAA,UACxB,SAAS;AAAA,QACX;AAAA,MACF;AAAA,IACF;AACA,WAAO,aAAa,MAAM,MAAM,CAAC,EAAE,cAAc,MAAM;AAAA,EACzD,CAAC;AACH,CAAC;",
+  "names": []
+}