@scalar/blocks 0.1.0

package/dist/code-example/helpers/operation-to-har/process-parameters.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"process-parameters.js","names":[],"sources":["../../../../src/code-example/helpers/operation-to-har/process-parameters.ts"],"sourcesContent":["import { getResolvedRef } from '@scalar/workspace-store/helpers/get-resolved-ref'\nimport {\n  deSerializeParameter,\n  getExample,\n  getExampleFromSchema,\n  isParamDisabled,\n  serializeContentValue,\n  serializeDeepObjectStyle,\n  serializeFormStyle,\n  serializeFormStyleForCookies,\n  serializePipeDelimitedStyle,\n  serializeSimpleStyle,\n  serializeSpaceDelimitedStyle,\n} from '@scalar/workspace-store/request-example'\nimport type { OperationObject, ParameterObject } from '@scalar/workspace-store/schemas/v3.1/strict/openapi-document'\nimport type { Request as HarRequest } from 'har-format'\n\ntype ProcessedParameters = {\n  url: string\n  headers: HarRequest['headers']\n  queryString: HarRequest['queryString']\n  cookies: HarRequest['cookies']\n}\n\n/** Ensures we don't have any references in the parameters */\nconst deReferenceParams = (params: OperationObject['parameters']): ParameterObject[] =>\n  (params ?? []).map((param) => getResolvedRef(param))\n\n/** Whether the parameter allows reserved characters (from param or schema). */\nconst isAllowReserved = (param: ParameterObject): boolean => {\n  if ('allowReserved' in param && param.allowReserved !== undefined) {\n    return param.allowReserved\n  }\n  if ('schema' in param && param.schema && typeof param.schema === 'object' && 'allowReserved' in param.schema) {\n    return (param.schema as { allowReserved?: boolean }).allowReserved === true\n  }\n  return false\n}\n\n/** URL encode a value if allowReserved is not set to true. */\nconst encodeQueryValue = (value: string, param: ParameterObject): string => {\n  if (isAllowReserved(param)) {\n    return value\n  }\n  return encodeURIComponent(value)\n}\n\n/**\n * Get the style and explode values for a parameter according to OpenAPI 3.1.1 specification.\n * Handles defaults and validation for parameter location restrictions.\n */\nconst getParameterStyleAndExplode = (param: ParameterObject): { style: string; explode: boolean } => {\n  // Headers only support 'simple' style\n  if (param.in === 'header') {\n    const explode = 'explode' in param && param.explode !== undefined ? param.explode : false\n    return { style: 'simple', explode }\n  }\n\n  // Cookies only support 'form' style\n  if (param.in === 'cookie') {\n    const explode = 'explode' in param && param.explode !== undefined ? param.explode : true\n    return { style: 'form', explode }\n  }\n\n  const defaultStyle = {\n    path: 'simple',\n    query: 'form',\n    header: 'simple',\n    cookie: 'form',\n  }[param.in]\n\n  // Use provided style or default based on location\n  const style = 'style' in param && param.style ? param.style : defaultStyle\n\n  // Determine explode value: use provided value or default based on style\n  const explode = 'explode' in param && param.explode !== undefined ? param.explode : style === 'form'\n\n  return { style, explode }\n}\n\n/**\n * Extract the value for a parameter from example data or schema.\n * Prioritizes example data over schema examples.\n * Returns null if the parameter is disabled so we can skip it.\n */\nconst getParameterValue = (\n  param: ParameterObject,\n  example: string | undefined,\n  contentType: string | undefined,\n  defaultDisabled: boolean,\n): unknown => {\n  // Try to get value from example first\n  const exampleValue = getExample(param, example, contentType)\n\n  // If the parameter is disabled, return undefined so we can skip it.\n  if (isParamDisabled(param, exampleValue, defaultDisabled)) {\n    return undefined\n  }\n\n  // If the example value is set, return it.\n  if (exampleValue?.value !== undefined) {\n    return deSerializeParameter(exampleValue.value, param)\n  }\n\n  // Fall back to schema example if available\n  if (!('schema' in param) || !param.schema) {\n    return undefined\n  }\n\n  const options = param.in === 'path' ? { emptyString: `{${param.name}}` } : {}\n  return getExampleFromSchema(getResolvedRef(param.schema), options)\n}\n\n/**\n * Process OpenAPI parameters and return the updated properties.\n * Handles path, query, and header parameters with various styles and explode options.\n *\n * @see https://spec.openapis.org/oas/latest.html#style-values\n */\nexport const processParameters = ({\n  harRequest,\n  parameters,\n  example,\n  defaultDisabled,\n}: {\n  harRequest: HarRequest\n  parameters: OperationObject['parameters']\n  /** The name of the example to use */\n  example?: string | undefined\n  /** Whether to disable parameters by default. */\n  defaultDisabled: boolean\n}): ProcessedParameters => {\n  // Create copies of the arrays to avoid modifying the input\n  const newHeaders = [...harRequest.headers]\n  const newQueryString = [...harRequest.queryString]\n  let newUrl = harRequest.url\n\n  // Filter out references\n  const deReferencedParams = deReferenceParams(parameters)\n\n  for (const param of deReferencedParams) {\n    if (!param.in || !param.name) {\n      continue\n    }\n\n    const paramValue = getParameterValue(param, example, undefined, defaultDisabled)\n    if (paramValue === undefined) {\n      continue\n    }\n\n    const { style, explode } = getParameterStyleAndExplode(param)\n\n    switch (param.in) {\n      case 'path': {\n        newUrl = processPathParameters(newUrl, param, paramValue, style, explode)\n        break\n      }\n\n      case 'query': {\n        // Content type parameters should be serialized according to the parameter's own content type\n        if ('content' in param && param.content) {\n          // We grab the first for now but eventually we should support selecting the content type per parameter\n          const paramContentType = Object.keys(param.content)[0] ?? 'application/json'\n          const serializedValue = serializeContentValue(paramValue, paramContentType)\n          newQueryString.push({ name: param.name, value: encodeQueryValue(serializedValue, param) })\n          break\n        }\n\n        // Handle query parameters\n        switch (style) {\n          case 'form': {\n            const serialized = serializeFormStyle(paramValue, explode)\n\n            // If serialized is an array of key-value pairs (exploded object or array)\n            if (Array.isArray(serialized)) {\n              for (const entry of serialized) {\n                const key = entry.key || param.name\n                newQueryString.push({ name: key, value: encodeQueryValue(String(entry.value), param) })\n              }\n            }\n            // Otherwise, convert to string\n            else {\n              newQueryString.push({ name: param.name, value: encodeQueryValue(String(serialized), param) })\n            }\n            break\n          }\n          case 'spaceDelimited': {\n            const serialized = serializeSpaceDelimitedStyle(paramValue)\n            newQueryString.push({ name: param.name, value: encodeQueryValue(serialized, param) })\n            break\n          }\n          case 'pipeDelimited': {\n            const serialized = serializePipeDelimitedStyle(paramValue)\n            newQueryString.push({ name: param.name, value: encodeQueryValue(serialized, param) })\n            break\n          }\n          case 'deepObject': {\n            // OAS marks deepObject-on-array and deepObject+explode:false as undefined.\n            // Mirror process-body: fall back to form/explode:true for arrays and always\n            // invoke the serializer for objects so authors get useful output instead of\n            // a silently-dropped parameter.\n            if (Array.isArray(paramValue)) {\n              const serialized = serializeFormStyle(paramValue, true)\n              if (Array.isArray(serialized)) {\n                for (const entry of serialized) {\n                  const key = entry.key || param.name\n                  newQueryString.push({ name: key, value: encodeQueryValue(String(entry.value), param) })\n                }\n              } else {\n                newQueryString.push({ name: param.name, value: encodeQueryValue(String(serialized), param) })\n              }\n            } else {\n              const entries = serializeDeepObjectStyle(param.name, paramValue)\n              for (const entry of entries) {\n                newQueryString.push({ name: entry.key, value: encodeQueryValue(entry.value, param) })\n              }\n            }\n            break\n          }\n\n          // Default to form style\n          default:\n            newQueryString.push({ name: param.name, value: encodeQueryValue(String(paramValue), param) })\n        }\n        break\n      }\n\n      // Headers only support 'simple' style according to OpenAPI 3.1.1\n      // For arrays, simple style always produces comma-separated values regardless of explode\n      // The explode parameter only affects object serialization\n      case 'header': {\n        const serialized = serializeSimpleStyle(paramValue, explode)\n        newHeaders.push({ name: param.name, value: String(serialized) })\n        break\n      }\n\n      // Cookies only support 'form' style according to OpenAPI 3.1.1\n      case 'cookie': {\n        const serialized = serializeFormStyleForCookies(paramValue, explode)\n\n        // If serialized is an array of key-value pairs (exploded object or array)\n        if (Array.isArray(serialized)) {\n          for (const entry of serialized) {\n            const key = entry.key || param.name\n            const value = entry.value === null ? 'null' : String(entry.value)\n            harRequest.cookies.push({ name: key, value })\n          }\n        }\n        // Otherwise, convert to string\n        else {\n          const value = serialized === null ? 'null' : String(serialized)\n          harRequest.cookies.push({ name: param.name, value })\n        }\n        break\n      }\n    }\n  }\n\n  return {\n    url: newUrl,\n    headers: newHeaders,\n    queryString: newQueryString,\n    cookies: harRequest.cookies,\n  }\n}\n\n/**\n * Process path parameters according to OpenAPI specification.\n * Handles matrix, label, and simple styles with explode options.\n *\n * @param url - The URL to process\n * @param param - The parameter object\n * @param paramValue - The value of the parameter\n * @param style - The style of the parameter (matrix, label, simple)\n * @param explode - Whether to explode the parameter\n * @returns The updated URL with processed path parameters\n */\nconst processPathParameters = (\n  url: string,\n  param: ParameterObject,\n  paramValue: unknown,\n  style: string,\n  explode: boolean,\n): string => {\n  switch (style) {\n    case 'matrix': {\n      if (explode) {\n        // Matrix explode array: ;color=blue;color=black;color=brown\n        if (Array.isArray(paramValue)) {\n          const values = (paramValue as unknown[]).map((v) => `${param.name}=${v}`).join(';')\n          return url.replace(`{;${param.name}}`, `;${values}`)\n        }\n\n        // Matrix explode object: ;R=100;G=200;B=150\n        if (typeof paramValue === 'object' && paramValue !== null) {\n          const values = Object.entries(paramValue as Record<string, unknown>)\n            .map(([k, v]) => `${k}=${v}`)\n            .join(';')\n          return url.replace(`{;${param.name}}`, `;${values}`)\n        }\n\n        // Matrix explode primitive: ;color=blue\n        return url.replace(`{;${param.name}}`, `;${param.name}=${paramValue}`)\n      }\n\n      // Matrix no explode array: ;color=blue,black,brown\n      if (Array.isArray(paramValue)) {\n        return url.replace(`{;${param.name}}`, `;${param.name}=${(paramValue as unknown[]).join(',')}`)\n      }\n\n      // Matrix no explode object: ;color=R,100,G,200,B,150\n      if (typeof paramValue === 'object' && paramValue !== null) {\n        const values = Object.entries(paramValue as Record<string, unknown>)\n          .map(([k, v]) => `${k},${v}`)\n          .join(',')\n        return url.replace(`{;${param.name}}`, `;${param.name}=${values}`)\n      }\n\n      // Matrix no explode primitive: ;color=blue\n      return url.replace(`{;${param.name}}`, `;${param.name}=${paramValue}`)\n    }\n    case 'label': {\n      if (explode) {\n        // Label explode array: .blue.black.brown\n        if (Array.isArray(paramValue)) {\n          return url.replace(`{.${param.name}}`, `.${(paramValue as unknown[]).join('.')}`)\n        }\n\n        // Label explode object: .R=100.G=200.B=150\n        if (typeof paramValue === 'object' && paramValue !== null) {\n          const values = Object.entries(paramValue as Record<string, unknown>)\n            .map(([k, v]) => `${k}=${v}`)\n            .join('.')\n\n          return url.replace(`{.${param.name}}`, `.${values}`)\n        }\n\n        // Label explode primitive: .blue\n        return url.replace(`{.${param.name}}`, `.${paramValue}`)\n      }\n\n      // Label no explode array: .blue,black,brown\n      if (Array.isArray(paramValue)) {\n        return url.replace(`{.${param.name}}`, `.${(paramValue as unknown[]).join(',')}`)\n      }\n\n      // Label no explode object: .R,100,G,200,B,150\n      if (typeof paramValue === 'object' && paramValue !== null) {\n        const values = Object.entries(paramValue as Record<string, unknown>)\n          .map(([k, v]) => `${k},${v}`)\n          .join(',')\n\n        return url.replace(`{.${param.name}}`, `.${values}`)\n      }\n\n      // Label no explode primitive: .blue\n      return url.replace(`{.${param.name}}`, `.${paramValue}`)\n    }\n\n    case 'simple': {\n      const serialized = serializeSimpleStyle(paramValue, explode)\n      return url.replace(`{${param.name}}`, String(serialized))\n    }\n\n    // Default to simple style\n    default:\n      return url.replace(`{${param.name}}`, String(paramValue))\n  }\n}\n"],"mappings":";;;AAyBA,IAAM,KAAqB,OACxB,KAAU,EAAE,EAAE,KAAK,MAAU,EAAe,EAAM,CAAC,EAGhD,KAAmB,MACnB,mBAAmB,KAAS,EAAM,kBAAkB,KAAA,IAC/C,EAAM,gBAEX,YAAY,KAAS,EAAM,UAAU,OAAO,EAAM,UAAW,YAAY,mBAAmB,EAAM,SAC5F,EAAM,OAAuC,kBAAkB,KAElE,IAIH,KAAoB,GAAe,MACnC,EAAgB,EAAM,GACjB,IAEF,mBAAmB,EAAM,EAO5B,KAA+B,MAAgE;AAEnG,KAAI,EAAM,OAAO,SAEf,QAAO;EAAE,OAAO;EAAU,SADV,aAAa,KAAS,EAAM,YAAY,KAAA,IAAY,EAAM,UAAU;EACjD;AAIrC,KAAI,EAAM,OAAO,SAEf,QAAO;EAAE,OAAO;EAAQ,SADR,aAAa,KAAS,EAAM,YAAY,KAAA,IAAY,EAAM,UAAU;EACnD;CAGnC,IAAM,IAAe;EACnB,MAAM;EACN,OAAO;EACP,QAAQ;EACR,QAAQ;EACT,CAAC,EAAM,KAGF,IAAQ,WAAW,KAAS,EAAM,QAAQ,EAAM,QAAQ;AAK9D,QAAO;EAAE;EAAO,SAFA,aAAa,KAAS,EAAM,YAAY,KAAA,IAAY,EAAM,UAAU,MAAU;EAErE;GAQrB,KACJ,GACA,GACA,GACA,MACY;CAEZ,IAAM,IAAe,EAAW,GAAO,GAAS,EAAY;AAG5D,KAAI,EAAgB,GAAO,GAAc,EAAgB,CACvD;AAIF,KAAI,GAAc,UAAU,KAAA,EAC1B,QAAO,EAAqB,EAAa,OAAO,EAAM;AAIxD,KAAI,EAAE,YAAY,MAAU,CAAC,EAAM,OACjC;CAGF,IAAM,IAAU,EAAM,OAAO,SAAS,EAAE,aAAa,IAAI,EAAM,KAAK,IAAI,GAAG,EAAE;AAC7E,QAAO,EAAqB,EAAe,EAAM,OAAO,EAAE,EAAQ;GASvD,KAAqB,EAChC,eACA,eACA,YACA,yBAQyB;CAEzB,IAAM,IAAa,CAAC,GAAG,EAAW,QAAQ,EACpC,IAAiB,CAAC,GAAG,EAAW,YAAY,EAC9C,IAAS,EAAW,KAGlB,IAAqB,EAAkB,EAAW;AAExD,MAAK,IAAM,KAAS,GAAoB;AACtC,MAAI,CAAC,EAAM,MAAM,CAAC,EAAM,KACtB;EAGF,IAAM,IAAa,EAAkB,GAAO,GAAS,KAAA,GAAW,EAAgB;AAChF,MAAI,MAAe,KAAA,EACjB;EAGF,IAAM,EAAE,UAAO,eAAY,EAA4B,EAAM;AAE7D,UAAQ,EAAM,IAAd;GACE,KAAK;AACH,QAAS,EAAsB,GAAQ,GAAO,GAAY,GAAO,EAAQ;AACzE;GAGF,KAAK;AAEH,QAAI,aAAa,KAAS,EAAM,SAAS;KAGvC,IAAM,IAAkB,EAAsB,GADrB,OAAO,KAAK,EAAM,QAAQ,CAAC,MAAM,mBACiB;AAC3E,OAAe,KAAK;MAAE,MAAM,EAAM;MAAM,OAAO,EAAiB,GAAiB,EAAM;MAAE,CAAC;AAC1F;;AAIF,YAAQ,GAAR;KACE,KAAK,QAAQ;MACX,IAAM,IAAa,EAAmB,GAAY,EAAQ;AAG1D,UAAI,MAAM,QAAQ,EAAW,CAC3B,MAAK,IAAM,KAAS,GAAY;OAC9B,IAAM,IAAM,EAAM,OAAO,EAAM;AAC/B,SAAe,KAAK;QAAE,MAAM;QAAK,OAAO,EAAiB,OAAO,EAAM,MAAM,EAAE,EAAM;QAAE,CAAC;;UAKzF,GAAe,KAAK;OAAE,MAAM,EAAM;OAAM,OAAO,EAAiB,OAAO,EAAW,EAAE,EAAM;OAAE,CAAC;AAE/F;;KAEF,KAAK,kBAAkB;MACrB,IAAM,IAAa,EAA6B,EAAW;AAC3D,QAAe,KAAK;OAAE,MAAM,EAAM;OAAM,OAAO,EAAiB,GAAY,EAAM;OAAE,CAAC;AACrF;;KAEF,KAAK,iBAAiB;MACpB,IAAM,IAAa,EAA4B,EAAW;AAC1D,QAAe,KAAK;OAAE,MAAM,EAAM;OAAM,OAAO,EAAiB,GAAY,EAAM;OAAE,CAAC;AACrF;;KAEF,KAAK;AAKH,UAAI,MAAM,QAAQ,EAAW,EAAE;OAC7B,IAAM,IAAa,EAAmB,GAAY,GAAK;AACvD,WAAI,MAAM,QAAQ,EAAW,CAC3B,MAAK,IAAM,KAAS,GAAY;QAC9B,IAAM,IAAM,EAAM,OAAO,EAAM;AAC/B,UAAe,KAAK;SAAE,MAAM;SAAK,OAAO,EAAiB,OAAO,EAAM,MAAM,EAAE,EAAM;SAAE,CAAC;;WAGzF,GAAe,KAAK;QAAE,MAAM,EAAM;QAAM,OAAO,EAAiB,OAAO,EAAW,EAAE,EAAM;QAAE,CAAC;aAE1F;OACL,IAAM,IAAU,EAAyB,EAAM,MAAM,EAAW;AAChE,YAAK,IAAM,KAAS,EAClB,GAAe,KAAK;QAAE,MAAM,EAAM;QAAK,OAAO,EAAiB,EAAM,OAAO,EAAM;QAAE,CAAC;;AAGzF;KAIF,QACE,GAAe,KAAK;MAAE,MAAM,EAAM;MAAM,OAAO,EAAiB,OAAO,EAAW,EAAE,EAAM;MAAE,CAAC;;AAEjG;GAMF,KAAK,UAAU;IACb,IAAM,IAAa,EAAqB,GAAY,EAAQ;AAC5D,MAAW,KAAK;KAAE,MAAM,EAAM;KAAM,OAAO,OAAO,EAAW;KAAE,CAAC;AAChE;;GAIF,KAAK,UAAU;IACb,IAAM,IAAa,EAA6B,GAAY,EAAQ;AAGpE,QAAI,MAAM,QAAQ,EAAW,CAC3B,MAAK,IAAM,KAAS,GAAY;KAC9B,IAAM,IAAM,EAAM,OAAO,EAAM,MACzB,IAAQ,EAAM,UAAU,OAAO,SAAS,OAAO,EAAM,MAAM;AACjE,OAAW,QAAQ,KAAK;MAAE,MAAM;MAAK;MAAO,CAAC;;SAI5C;KACH,IAAM,IAAQ,MAAe,OAAO,SAAS,OAAO,EAAW;AAC/D,OAAW,QAAQ,KAAK;MAAE,MAAM,EAAM;MAAM;MAAO,CAAC;;AAEtD;;;;AAKN,QAAO;EACL,KAAK;EACL,SAAS;EACT,aAAa;EACb,SAAS,EAAW;EACrB;GAcG,KACJ,GACA,GACA,GACA,GACA,MACW;AACX,SAAQ,GAAR;EACE,KAAK;AACH,OAAI,GAAS;AAEX,QAAI,MAAM,QAAQ,EAAW,EAAE;KAC7B,IAAM,IAAU,EAAyB,KAAK,MAAM,GAAG,EAAM,KAAK,GAAG,IAAI,CAAC,KAAK,IAAI;AACnF,YAAO,EAAI,QAAQ,KAAK,EAAM,KAAK,IAAI,IAAI,IAAS;;AAItD,QAAI,OAAO,KAAe,YAAY,GAAqB;KACzD,IAAM,IAAS,OAAO,QAAQ,EAAsC,CACjE,KAAK,CAAC,GAAG,OAAO,GAAG,EAAE,GAAG,IAAI,CAC5B,KAAK,IAAI;AACZ,YAAO,EAAI,QAAQ,KAAK,EAAM,KAAK,IAAI,IAAI,IAAS;;AAItD,WAAO,EAAI,QAAQ,KAAK,EAAM,KAAK,IAAI,IAAI,EAAM,KAAK,GAAG,IAAa;;AAIxE,OAAI,MAAM,QAAQ,EAAW,CAC3B,QAAO,EAAI,QAAQ,KAAK,EAAM,KAAK,IAAI,IAAI,EAAM,KAAK,GAAI,EAAyB,KAAK,IAAI,GAAG;AAIjG,OAAI,OAAO,KAAe,YAAY,GAAqB;IACzD,IAAM,IAAS,OAAO,QAAQ,EAAsC,CACjE,KAAK,CAAC,GAAG,OAAO,GAAG,EAAE,GAAG,IAAI,CAC5B,KAAK,IAAI;AACZ,WAAO,EAAI,QAAQ,KAAK,EAAM,KAAK,IAAI,IAAI,EAAM,KAAK,GAAG,IAAS;;AAIpE,UAAO,EAAI,QAAQ,KAAK,EAAM,KAAK,IAAI,IAAI,EAAM,KAAK,GAAG,IAAa;EAExE,KAAK;AACH,OAAI,GAAS;AAEX,QAAI,MAAM,QAAQ,EAAW,CAC3B,QAAO,EAAI,QAAQ,KAAK,EAAM,KAAK,IAAI,IAAK,EAAyB,KAAK,IAAI,GAAG;AAInF,QAAI,OAAO,KAAe,YAAY,GAAqB;KACzD,IAAM,IAAS,OAAO,QAAQ,EAAsC,CACjE,KAAK,CAAC,GAAG,OAAO,GAAG,EAAE,GAAG,IAAI,CAC5B,KAAK,IAAI;AAEZ,YAAO,EAAI,QAAQ,KAAK,EAAM,KAAK,IAAI,IAAI,IAAS;;AAItD,WAAO,EAAI,QAAQ,KAAK,EAAM,KAAK,IAAI,IAAI,IAAa;;AAI1D,OAAI,MAAM,QAAQ,EAAW,CAC3B,QAAO,EAAI,QAAQ,KAAK,EAAM,KAAK,IAAI,IAAK,EAAyB,KAAK,IAAI,GAAG;AAInF,OAAI,OAAO,KAAe,YAAY,GAAqB;IACzD,IAAM,IAAS,OAAO,QAAQ,EAAsC,CACjE,KAAK,CAAC,GAAG,OAAO,GAAG,EAAE,GAAG,IAAI,CAC5B,KAAK,IAAI;AAEZ,WAAO,EAAI,QAAQ,KAAK,EAAM,KAAK,IAAI,IAAI,IAAS;;AAItD,UAAO,EAAI,QAAQ,KAAK,EAAM,KAAK,IAAI,IAAI,IAAa;EAG1D,KAAK,UAAU;GACb,IAAM,IAAa,EAAqB,GAAY,EAAQ;AAC5D,UAAO,EAAI,QAAQ,IAAI,EAAM,KAAK,IAAI,OAAO,EAAW,CAAC;;EAI3D,QACE,QAAO,EAAI,QAAQ,IAAI,EAAM,KAAK,IAAI,OAAO,EAAW,CAAC"}

package/dist/code-example/helpers/operation-to-har/process-security-schemes.d.ts

@@ -0,0 +1,15 @@
+import type { SecuritySchemeObjectSecret } from '@scalar/workspace-store/request-example';
+import type { Request as HarRequest } from 'har-format';
+type ProcessedSecuritySchemesReturn = {
+    headers: HarRequest['headers'];
+    queryString: HarRequest['queryString'];
+    cookies: HarRequest['cookies'];
+};
+/**
+ * Process security schemes into whichever parameters they are applicable to
+ *
+ * TODO: we probably want to be able to disable YOUR_SECRET_TOKEN placeholder text + or allow it to be customzied
+ */
+export declare const processSecuritySchemes: (securitySchemes: SecuritySchemeObjectSecret[]) => ProcessedSecuritySchemesReturn;
+export {};
+//# sourceMappingURL=process-security-schemes.d.ts.map

package/dist/code-example/helpers/operation-to-har/process-security-schemes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"process-security-schemes.d.ts","sourceRoot":"","sources":["../../../../src/code-example/helpers/operation-to-har/process-security-schemes.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,yCAAyC,CAAA;AACzF,OAAO,KAAK,EAAE,OAAO,IAAI,UAAU,EAAE,MAAM,YAAY,CAAA;AAGvD,KAAK,8BAA8B,GAAG;IACpC,OAAO,EAAE,UAAU,CAAC,SAAS,CAAC,CAAA;IAC9B,WAAW,EAAE,UAAU,CAAC,aAAa,CAAC,CAAA;IACtC,OAAO,EAAE,UAAU,CAAC,SAAS,CAAC,CAAA;CAC/B,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,sBAAsB,GACjC,iBAAiB,0BAA0B,EAAE,KAC5C,8BA2EF,CAAA"}

package/dist/code-example/helpers/operation-to-har/process-security-schemes.js

@@ -0,0 +1,59 @@
+import { encode as e } from "js-base64";
+//#region src/code-example/helpers/operation-to-har/process-security-schemes.ts
+var t = (t) => {
+	let n = {
+		headers: [],
+		queryString: [],
+		cookies: []
+	};
+	for (let r of t) {
+		if (r.type === "apiKey") {
+			let e = r["x-scalar-secret-token"] || "YOUR_SECRET_TOKEN";
+			if (!r.name) continue;
+			let t = {
+				name: r.name,
+				value: e
+			};
+			switch (r.in) {
+				case "header":
+					n.headers.push(t);
+					break;
+				case "query":
+					n.queryString.push(t);
+					break;
+				case "cookie":
+					n.cookies.push(t);
+					break;
+			}
+			continue;
+		}
+		if (r.type === "http") {
+			if (r.scheme === "basic") {
+				let t = `${r["x-scalar-secret-username"] || ""}:${r["x-scalar-secret-password"] || ""}`, i = t === ":" ? "username:password" : e(t);
+				n.headers.push({
+					name: "Authorization",
+					value: `Basic ${i}`
+				});
+			} else if (r.scheme === "bearer") {
+				let e = r["x-scalar-secret-token"] || "YOUR_SECRET_TOKEN";
+				n.headers.push({
+					name: "Authorization",
+					value: `Bearer ${e}`
+				});
+			}
+			continue;
+		}
+		if (r.type === "oauth2" && r.flows) {
+			let e = Object.values(r.flows).find((e) => e["x-scalar-secret-token"])?.["x-scalar-secret-token"] || "YOUR_SECRET_TOKEN";
+			n.headers.push({
+				name: "Authorization",
+				value: `Bearer ${e}`
+			});
+		}
+	}
+	return n;
+};
+//#endregion
+export { t as processSecuritySchemes };
+
+//# sourceMappingURL=process-security-schemes.js.map

package/dist/code-example/helpers/operation-to-har/process-security-schemes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"process-security-schemes.js","names":[],"sources":["../../../../src/code-example/helpers/operation-to-har/process-security-schemes.ts"],"sourcesContent":["import type { SecuritySchemeObjectSecret } from '@scalar/workspace-store/request-example'\nimport type { Request as HarRequest } from 'har-format'\nimport { encode } from 'js-base64'\n\ntype ProcessedSecuritySchemesReturn = {\n  headers: HarRequest['headers']\n  queryString: HarRequest['queryString']\n  cookies: HarRequest['cookies']\n}\n\n/**\n * Process security schemes into whichever parameters they are applicable to\n *\n * TODO: we probably want to be able to disable YOUR_SECRET_TOKEN placeholder text + or allow it to be customzied\n */\nexport const processSecuritySchemes = (\n  securitySchemes: SecuritySchemeObjectSecret[],\n): ProcessedSecuritySchemesReturn => {\n  const result: ProcessedSecuritySchemesReturn = {\n    headers: [],\n    queryString: [],\n    cookies: [],\n  }\n\n  for (const scheme of securitySchemes) {\n    // Handle apiKey type\n    if (scheme.type === 'apiKey') {\n      const value = scheme['x-scalar-secret-token'] || 'YOUR_SECRET_TOKEN'\n      if (!scheme.name) {\n        continue\n      }\n\n      const param = { name: scheme.name, value }\n\n      switch (scheme.in) {\n        case 'header':\n          result.headers.push(param)\n          break\n        case 'query':\n          result.queryString.push(param)\n          break\n        case 'cookie':\n          result.cookies.push(param)\n          break\n      }\n      continue\n    }\n\n    // Handle http type\n    if (scheme.type === 'http') {\n      if (scheme.scheme === 'basic') {\n        const username = scheme['x-scalar-secret-username'] || ''\n        const password = scheme['x-scalar-secret-password'] || ''\n\n        // The snippet is documentation, so we always show an Authorization header. When both\n        // fields are empty we render a readable `username:password` placeholder, mirroring the\n        // `YOUR_SECRET_TOKEN` placeholder used by the other schemes. (The real request omits the\n        // header entirely in that case — see buildRequestSecurity.)\n        const value = `${username}:${password}`\n        const auth = value === ':' ? 'username:password' : encode(value)\n\n        result.headers.push({\n          name: 'Authorization',\n          value: `Basic ${auth}`,\n        })\n      } else if (scheme.scheme === 'bearer') {\n        const token = scheme['x-scalar-secret-token'] || 'YOUR_SECRET_TOKEN'\n\n        result.headers.push({\n          name: 'Authorization',\n          value: `Bearer ${token}`,\n        })\n      }\n      continue\n    }\n\n    // Handle oauth2 type\n    if (scheme.type === 'oauth2' && scheme.flows) {\n      const flows = Object.values(scheme.flows)\n\n      // Find the first flow with a token\n      const flow = flows.find((f) => f['x-scalar-secret-token'])\n      const token = flow?.['x-scalar-secret-token'] || 'YOUR_SECRET_TOKEN'\n\n      result.headers.push({\n        name: 'Authorization',\n        value: `Bearer ${token}`,\n      })\n    }\n  }\n\n  return result\n}\n"],"mappings":";;AAeA,IAAa,KACX,MACmC;CACnC,IAAM,IAAyC;EAC7C,SAAS,EAAE;EACX,aAAa,EAAE;EACf,SAAS,EAAE;EACZ;AAED,MAAK,IAAM,KAAU,GAAiB;AAEpC,MAAI,EAAO,SAAS,UAAU;GAC5B,IAAM,IAAQ,EAAO,4BAA4B;AACjD,OAAI,CAAC,EAAO,KACV;GAGF,IAAM,IAAQ;IAAE,MAAM,EAAO;IAAM;IAAO;AAE1C,WAAQ,EAAO,IAAf;IACE,KAAK;AACH,OAAO,QAAQ,KAAK,EAAM;AAC1B;IACF,KAAK;AACH,OAAO,YAAY,KAAK,EAAM;AAC9B;IACF,KAAK;AACH,OAAO,QAAQ,KAAK,EAAM;AAC1B;;AAEJ;;AAIF,MAAI,EAAO,SAAS,QAAQ;AAC1B,OAAI,EAAO,WAAW,SAAS;IAQ7B,IAAM,IAAQ,GAPG,EAAO,+BAA+B,GAO7B,GANT,EAAO,+BAA+B,MAOjD,IAAO,MAAU,MAAM,sBAAsB,EAAO,EAAM;AAEhE,MAAO,QAAQ,KAAK;KAClB,MAAM;KACN,OAAO,SAAS;KACjB,CAAC;cACO,EAAO,WAAW,UAAU;IACrC,IAAM,IAAQ,EAAO,4BAA4B;AAEjD,MAAO,QAAQ,KAAK;KAClB,MAAM;KACN,OAAO,UAAU;KAClB,CAAC;;AAEJ;;AAIF,MAAI,EAAO,SAAS,YAAY,EAAO,OAAO;GAK5C,IAAM,IAJQ,OAAO,OAAO,EAAO,MAAM,CAGtB,MAAM,MAAM,EAAE,yBAAyB,GACrC,4BAA4B;AAEjD,KAAO,QAAQ,KAAK;IAClB,MAAM;IACN,OAAO,UAAU;IAClB,CAAC;;;AAIN,QAAO"}

package/dist/code-example/helpers/operation-to-har/process-server-url.d.ts

@@ -0,0 +1,6 @@
+import type { ServerObject } from '@scalar/workspace-store/schemas/v3.1/strict/openapi-document';
+/**
+ * Processes a server URL by replacing variables with their default values and merging with the path
+ */
+export declare const processServerUrl: (server: ServerObject | null, path: string) => string;
+//# sourceMappingURL=process-server-url.d.ts.map

package/dist/code-example/helpers/operation-to-har/process-server-url.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"process-server-url.d.ts","sourceRoot":"","sources":["../../../../src/code-example/helpers/operation-to-har/process-server-url.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,8DAA8D,CAAA;AAEhG;;GAEG;AACH,eAAO,MAAM,gBAAgB,GAAI,QAAQ,YAAY,GAAG,IAAI,EAAE,MAAM,MAAM,KAAG,MA4B5E,CAAA"}

package/dist/code-example/helpers/operation-to-har/process-server-url.js

@@ -0,0 +1,12 @@
+import { replaceVariables as e } from "@scalar/helpers/regex/replace-variables";
+import { mergeUrls as t } from "@scalar/helpers/url/merge-urls";
+//#region src/code-example/helpers/operation-to-har/process-server-url.ts
+var n = (n, r) => {
+	if (!n?.url) return r;
+	let i = n.url;
+	return n.variables ? t(e(i, Object.entries(n.variables).reduce((e, [t, n]) => (n.default !== void 0 && (e[t] = n.default), e), {})), r) : t(i, r);
+};
+//#endregion
+export { n as processServerUrl };
+
+//# sourceMappingURL=process-server-url.js.map

package/dist/code-example/helpers/operation-to-har/process-server-url.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"process-server-url.js","names":[],"sources":["../../../../src/code-example/helpers/operation-to-har/process-server-url.ts"],"sourcesContent":["import { replaceVariables } from '@scalar/helpers/regex/replace-variables'\nimport { mergeUrls } from '@scalar/helpers/url/merge-urls'\nimport type { ServerObject } from '@scalar/workspace-store/schemas/v3.1/strict/openapi-document'\n\n/**\n * Processes a server URL by replacing variables with their default values and merging with the path\n */\nexport const processServerUrl = (server: ServerObject | null, path: string): string => {\n  if (!server?.url) {\n    return path\n  }\n  const serverUrl = server.url\n\n  // Replace server variables with their default values\n  if (server.variables) {\n    const variables = Object.entries(server.variables)\n\n    // Extract default values from server variables\n    const defaultValues = variables.reduce(\n      (defaults, [variableName, variableConfig]) => {\n        if (variableConfig.default !== undefined) {\n          defaults[variableName] = variableConfig.default\n        }\n        return defaults\n      },\n      {} as Record<string, string | number>,\n    )\n\n    // Replace variables in the server URL with their default values\n    const serverUrlWithVars = replaceVariables(serverUrl, defaultValues)\n\n    return mergeUrls(serverUrlWithVars, path)\n  }\n\n  return mergeUrls(serverUrl, path)\n}\n"],"mappings":";;;AAOA,IAAa,KAAoB,GAA6B,MAAyB;AACrF,KAAI,CAAC,GAAQ,IACX,QAAO;CAET,IAAM,IAAY,EAAO;AAuBzB,QApBI,EAAO,YAiBF,EAFmB,EAAiB,GAdzB,OAAO,QAAQ,EAAO,UAAU,CAGlB,QAC7B,GAAU,CAAC,GAAc,QACpB,EAAe,YAAY,KAAA,MAC7B,EAAS,KAAgB,EAAe,UAEnC,IAET,EAAE,CACH,CAGmE,EAEhC,EAAK,GAGpC,EAAU,GAAW,EAAK"}

package/dist/code-example/index.d.ts

@@ -0,0 +1,17 @@
+export { getResolvedRefDeep } from '@scalar/workspace-store/helpers/get-resolved-ref-deep';
+export type { CodeExampleProps } from './components/CodeExample.vue';
+export { default as CodeExample } from './components/CodeExample.vue';
+export { default as ExamplePicker } from './components/ExamplePicker.vue';
+export { default as HttpMethod } from './components/HttpMethod.vue';
+export { filterClientsByQuery } from './helpers/filter-clients-by-query';
+export { DEFAULT_CLIENT, type SelectedClientId, findClient, isClient, isSelectedClient } from './helpers/find-client';
+export { generateClientOptions, getCustomClientIds } from './helpers/generate-client-options';
+export { generateCodeSnippet } from './helpers/generate-code-snippet';
+export { getClients } from './helpers/get-clients';
+export { getCustomCodeSamples } from './helpers/get-custom-code-samples';
+export { getSecrets } from './helpers/get-secrets';
+export type { OperationToHarProps } from './helpers/operation-to-har/operation-to-har';
+export { operationToHar } from './helpers/operation-to-har/operation-to-har';
+export { type CreateCodeExampleOptions, createCodeExample } from './mount';
+export type { ClientOption, ClientOptionGroup, CustomClientOption, CustomClientOptionGroup } from './types';
+//# sourceMappingURL=index.d.ts.map

package/dist/code-example/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/code-example/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,kBAAkB,EAAE,MAAM,uDAAuD,CAAA;AAE1F,YAAY,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAA;AACpE,OAAO,EAAE,OAAO,IAAI,WAAW,EAAE,MAAM,8BAA8B,CAAA;AACrE,OAAO,EAAE,OAAO,IAAI,aAAa,EAAE,MAAM,gCAAgC,CAAA;AACzE,OAAO,EAAE,OAAO,IAAI,UAAU,EAAE,MAAM,6BAA6B,CAAA;AACnE,OAAO,EAAE,oBAAoB,EAAE,MAAM,mCAAmC,CAAA;AACxE,OAAO,EAAE,cAAc,EAAE,KAAK,gBAAgB,EAAE,UAAU,EAAE,QAAQ,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;AACrH,OAAO,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,MAAM,mCAAmC,CAAA;AAC7F,OAAO,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAA;AACrE,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAA;AAClD,OAAO,EAAE,oBAAoB,EAAE,MAAM,mCAAmC,CAAA;AACxE,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAA;AAClD,YAAY,EAAE,mBAAmB,EAAE,MAAM,6CAA6C,CAAA;AACtF,OAAO,EAAE,cAAc,EAAE,MAAM,6CAA6C,CAAA;AAC5E,OAAO,EAAE,KAAK,wBAAwB,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAA;AAC1E,YAAY,EAAE,YAAY,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,uBAAuB,EAAE,MAAM,SAAS,CAAA"}

package/dist/code-example/index.js

@@ -0,0 +1,14 @@
+import { filterClientsByQuery as e } from "./helpers/filter-clients-by-query.js";
+import { DEFAULT_CLIENT as t, findClient as n, isClient as r, isSelectedClient as i } from "./helpers/find-client.js";
+import { generateClientOptions as a, getCustomClientIds as o } from "./helpers/generate-client-options.js";
+import { operationToHar as s } from "./helpers/operation-to-har/operation-to-har.js";
+import { generateCodeSnippet as c } from "./helpers/generate-code-snippet.js";
+import { getCustomCodeSamples as l } from "./helpers/get-custom-code-samples.js";
+import { getClients as u } from "./helpers/get-clients.js";
+import { getSecrets as d } from "./helpers/get-secrets.js";
+import f from "./components/ExamplePicker.vue.js";
+import p from "./components/HttpMethod.vue.js";
+import m from "./components/CodeExample.vue.js";
+import { createCodeExample as h } from "./mount.js";
+import { getResolvedRefDeep as g } from "@scalar/workspace-store/helpers/get-resolved-ref-deep";
+export { m as CodeExample, t as DEFAULT_CLIENT, f as ExamplePicker, p as HttpMethod, h as createCodeExample, e as filterClientsByQuery, n as findClient, a as generateClientOptions, c as generateCodeSnippet, u as getClients, o as getCustomClientIds, l as getCustomCodeSamples, g as getResolvedRefDeep, d as getSecrets, r as isClient, i as isSelectedClient, s as operationToHar };

package/dist/code-example/mount.d.ts

@@ -0,0 +1,51 @@
+import type { HttpMethod } from '@scalar/helpers/http/http-methods';
+import type { AvailableClients } from '@scalar/snippetz';
+import type { WorkspaceStore } from '@scalar/workspace-store/client';
+import type { SecuritySchemeObjectSecret } from '@scalar/workspace-store/request-example';
+import type { ServerObject } from '@scalar/workspace-store/schemas/v3.1/strict/openapi-document';
+export type CreateCodeExampleOptions = {
+    /** Workspace store that holds the OpenAPI document(s) to render from. */
+    store: WorkspaceStore;
+    /** Path of the operation to render, e.g. '/users/{id}'. */
+    path: string;
+    /** HTTP method of the operation to render. */
+    method: HttpMethod;
+    /** Pre-selected client ID, e.g. 'shell/curl'. */
+    selectedClient?: AvailableClients[number];
+    /**
+     * Server object override used to build the example request.
+     *
+     * When omitted, the server is derived from the active document (operation,
+     * then path item, then document level), mirroring the API reference. Pass
+     * `null` to force "no server".
+     */
+    selectedServer?: ServerObject | null;
+    /**
+     * Pre-selected example key for parameters and the request body.
+     *
+     * The store is the source of truth once an example is picked, so
+     * `x-scalar-default-example` wins over this initial seed and the selection
+     * round-trips through the store like the client selection does.
+     */
+    selectedExample?: string;
+    /** Security schemes applicable to the operation. */
+    securitySchemes?: SecuritySchemeObjectSecret[];
+    /**
+     * Force a color mode on the rendered block.
+     *
+     * When omitted, the block inherits the ambient theme of the host page.
+     * Pass `true` for dark mode or `false` for light mode.
+     */
+    darkMode?: boolean;
+};
+/**
+ * Mount the CodeExample block to a DOM element without Vue.
+ *
+ * The consumer creates and controls their own workspace store,
+ * then passes it in along with the path and method to render.
+ */
+export declare const createCodeExample: (el: HTMLElement | string, options: CreateCodeExampleOptions) => {
+    app: import("vue").App<Element>;
+    destroy: () => void;
+};
+//# sourceMappingURL=mount.d.ts.map

package/dist/code-example/mount.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mount.d.ts","sourceRoot":"","sources":["../../src/code-example/mount.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mCAAmC,CAAA;AACnE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAA;AACxD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAA;AAKpE,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,yCAAyC,CAAA;AACzF,OAAO,KAAK,EAAmB,YAAY,EAAE,MAAM,8DAA8D,CAAA;AAMjH,MAAM,MAAM,wBAAwB,GAAG;IACrC,yEAAyE;IACzE,KAAK,EAAE,cAAc,CAAA;IACrB,2DAA2D;IAC3D,IAAI,EAAE,MAAM,CAAA;IACZ,8CAA8C;IAC9C,MAAM,EAAE,UAAU,CAAA;IAClB,iDAAiD;IACjD,cAAc,CAAC,EAAE,gBAAgB,CAAC,MAAM,CAAC,CAAA;IACzC;;;;;;OAMG;IACH,cAAc,CAAC,EAAE,YAAY,GAAG,IAAI,CAAA;IACpC;;;;;;OAMG;IACH,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,oDAAoD;IACpD,eAAe,CAAC,EAAE,0BAA0B,EAAE,CAAA;IAC9C;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;CACnB,CAAA;AAWD;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB,GAAI,IAAI,WAAW,GAAG,MAAM,EAAE,SAAS,wBAAwB;;;CAqI5F,CAAA"}

package/dist/code-example/mount.js

@@ -0,0 +1,61 @@
+import { generateClientOptions as e } from "./helpers/generate-client-options.js";
+import t from "./components/CodeExample.vue.js";
+import { createApp as n, h as r, reactive as i } from "vue";
+import { createWorkspaceEventBus as a } from "@scalar/workspace-store/events";
+import { getResolvedRef as o } from "@scalar/workspace-store/helpers/get-resolved-ref";
+import { ScalarTeleportRoot as s } from "@scalar/components/teleport";
+import { getFirstServer as c } from "@scalar/workspace-store/helpers/get-first-server";
+import { generateClientMutators as l } from "@scalar/workspace-store/mutators";
+//#region src/code-example/mount.ts
+var u = (e) => ["scalar-app", e === !0 ? "dark-mode" : e === !1 ? "light-mode" : ""].filter(Boolean).join(" "), d = (d, f) => {
+	let p = typeof d == "string" ? document.querySelector(d) : d;
+	if (!p) throw Error(`Element not found: ${d}`);
+	let m = a(), h = e(), g = l(f.store), _ = m.on("workspace:update:selected-client", (e) => g.workspace().workspace.updateSelectedClient(e)), v = m.on("workspace:update:selected-example", (e) => g.workspace().workspace.updateSelectedExample(e)), y = () => {
+		let e = f.store.workspace.activeDocument;
+		if (!e || !("paths" in e)) return;
+		let t = o(e.paths?.[f.path]), n = o(t?.[f.method]);
+		if (n) return {
+			operation: n,
+			server: c(n.servers ?? null, t?.servers ?? null, e.servers ?? null)
+		};
+	};
+	if (!y()) throw Error(`Operation not found: ${f.method.toUpperCase()} ${f.path}`);
+	let b, x = () => {
+		let e = y();
+		return e && (b = e), e ?? b;
+	}, S = i({
+		get operation() {
+			return x().operation;
+		},
+		get method() {
+			return f.method;
+		},
+		get path() {
+			return f.path;
+		},
+		clientOptions: h,
+		eventBus: m,
+		get securitySchemes() {
+			return f.securitySchemes ?? [];
+		},
+		get selectedClient() {
+			return f.store.workspace["x-scalar-default-client"] ?? f.selectedClient;
+		},
+		get selectedExample() {
+			return f.store.workspace["x-scalar-default-example"] ?? f.selectedExample;
+		},
+		get selectedServer() {
+			return f.selectedServer === void 0 ? x().server : f.selectedServer;
+		}
+	}), C = () => r("span", { class: "font-code text-c-2 min-w-0 truncate" }, f.path), w = n(() => r("div", { class: u(f.darkMode) }, [r(s, null, { default: () => r(t, S, { header: C }) })]));
+	return w.mount(p), {
+		app: w,
+		destroy: () => {
+			_(), v(), w.unmount();
+		}
+	};
+};
+//#endregion
+export { d as createCodeExample };
+
+//# sourceMappingURL=mount.js.map

package/dist/code-example/mount.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mount.js","names":[],"sources":["../../src/code-example/mount.ts"],"sourcesContent":["import { ScalarTeleportRoot } from '@scalar/components/teleport'\nimport type { HttpMethod } from '@scalar/helpers/http/http-methods'\nimport type { AvailableClients } from '@scalar/snippetz'\nimport type { WorkspaceStore } from '@scalar/workspace-store/client'\nimport { createWorkspaceEventBus } from '@scalar/workspace-store/events'\nimport { getFirstServer } from '@scalar/workspace-store/helpers/get-first-server'\nimport { getResolvedRef } from '@scalar/workspace-store/helpers/get-resolved-ref'\nimport { generateClientMutators } from '@scalar/workspace-store/mutators'\nimport type { SecuritySchemeObjectSecret } from '@scalar/workspace-store/request-example'\nimport type { OperationObject, ServerObject } from '@scalar/workspace-store/schemas/v3.1/strict/openapi-document'\nimport { createApp, h, reactive } from 'vue'\n\nimport CodeExample, { type CodeExampleProps } from './components/CodeExample.vue'\nimport { generateClientOptions } from './helpers/generate-client-options'\n\nexport type CreateCodeExampleOptions = {\n  /** Workspace store that holds the OpenAPI document(s) to render from. */\n  store: WorkspaceStore\n  /** Path of the operation to render, e.g. '/users/{id}'. */\n  path: string\n  /** HTTP method of the operation to render. */\n  method: HttpMethod\n  /** Pre-selected client ID, e.g. 'shell/curl'. */\n  selectedClient?: AvailableClients[number]\n  /**\n   * Server object override used to build the example request.\n   *\n   * When omitted, the server is derived from the active document (operation,\n   * then path item, then document level), mirroring the API reference. Pass\n   * `null` to force \"no server\".\n   */\n  selectedServer?: ServerObject | null\n  /**\n   * Pre-selected example key for parameters and the request body.\n   *\n   * The store is the source of truth once an example is picked, so\n   * `x-scalar-default-example` wins over this initial seed and the selection\n   * round-trips through the store like the client selection does.\n   */\n  selectedExample?: string\n  /** Security schemes applicable to the operation. */\n  securitySchemes?: SecuritySchemeObjectSecret[]\n  /**\n   * Force a color mode on the rendered block.\n   *\n   * When omitted, the block inherits the ambient theme of the host page.\n   * Pass `true` for dark mode or `false` for light mode.\n   */\n  darkMode?: boolean\n}\n\n/**\n * Builds the wrapper classes for the mounted block.\n *\n * The `.scalar-app` class scopes the Tailwind utilities, and the optional\n * color-mode class lets consumers pin the block to dark or light.\n */\nconst getWrapperClass = (darkMode: boolean | undefined): string =>\n  ['scalar-app', darkMode === true ? 'dark-mode' : darkMode === false ? 'light-mode' : ''].filter(Boolean).join(' ')\n\n/**\n * Mount the CodeExample block to a DOM element without Vue.\n *\n * The consumer creates and controls their own workspace store,\n * then passes it in along with the path and method to render.\n */\nexport const createCodeExample = (el: HTMLElement | string, options: CreateCodeExampleOptions) => {\n  const element = typeof el === 'string' ? document.querySelector(el) : el\n  if (!element) {\n    throw new Error(`Element not found: ${el}`)\n  }\n\n  const eventBus = createWorkspaceEventBus()\n  const clientOptions = generateClientOptions()\n\n  // Persist client changes back to the store. The block emits\n  // `workspace:update:selected-client` on its private bus when the user picks a\n  // client; without this subscription the choice would never reach the store\n  // and `x-scalar-default-client` (the source of truth read below) would stay\n  // stale, so the selection would not survive a re-render or be shared with\n  // other blocks reading from the same store.\n  const mutators = generateClientMutators(options.store)\n  const unsubscribeClient = eventBus.on('workspace:update:selected-client', (payload) =>\n    mutators.workspace().workspace.updateSelectedClient(payload),\n  )\n\n  // Persist example changes back to the store as well, mirroring the client\n  // round-trip above. The block emits `workspace:update:selected-example` when\n  // the user picks an example; without this the choice would never reach\n  // `x-scalar-default-example` (read below) and would neither survive a\n  // re-render nor sync to other blocks reading from the same store.\n  const unsubscribeExample = eventBus.on('workspace:update:selected-example', (payload) =>\n    mutators.workspace().workspace.updateSelectedExample(payload),\n  )\n\n  type OperationContext = { operation: OperationObject; server: ServerObject | null }\n\n  /**\n   * Resolve the operation and its effective server from the active document.\n   *\n   * The server is resolved from the same document the operation came from\n   * (operation, then path item, then document level), so a snippet never pairs\n   * an operation with a server URL from a different spec.\n   */\n  const resolveContext = (): OperationContext | undefined => {\n    // The active document may be an AsyncAPI document, which has no `paths`.\n    const activeDocument = options.store.workspace.activeDocument\n    if (!activeDocument || !('paths' in activeDocument)) {\n      return undefined\n    }\n    const pathItem = getResolvedRef(activeDocument.paths?.[options.path])\n    const operation = getResolvedRef(pathItem?.[options.method])\n    if (!operation) {\n      return undefined\n    }\n    const server = getFirstServer(operation.servers ?? null, pathItem?.servers ?? null, activeDocument.servers ?? null)\n    return { operation, server }\n  }\n\n  // Fail loudly if the path and method do not point at an operation in the store,\n  // mirroring the \"element not found\" guard above.\n  if (!resolveContext()) {\n    throw new Error(`Operation not found: ${options.method.toUpperCase()} ${options.path}`)\n  }\n\n  // Remember the last context that resolved so a transient miss (e.g. the active\n  // document is swapped to one without this path or method after mount) keeps\n  // rendering the previous operation, paired with the server it actually came\n  // from, instead of feeding `undefined` to the block.\n  let lastContext: OperationContext | undefined\n\n  /** Current operation + server, falling back to the last good resolution on a transient miss. */\n  const currentContext = (): OperationContext => {\n    const context = resolveContext()\n    if (context) {\n      lastContext = context\n    }\n    return (context ?? lastContext) as OperationContext\n  }\n\n  // Props are getters so the block tracks the reactive store (active document,\n  // `x-scalar-default-client`, `x-scalar-default-example`) live. Change the\n  // client, example, or server through the store to drive re-renders.\n  const props = reactive<CodeExampleProps>({\n    get operation(): OperationObject {\n      return currentContext().operation\n    },\n    get method() {\n      return options.method\n    },\n    get path() {\n      return options.path\n    },\n    clientOptions,\n    eventBus,\n    get securitySchemes() {\n      return options.securitySchemes ?? []\n    },\n    get selectedClient() {\n      // The store is the source of truth once the user picks a client, so it\n      // wins over the initial `options.selectedClient` seed and the selection\n      // round-trips through the subscription above.\n      return options.store.workspace['x-scalar-default-client'] ?? options.selectedClient\n    },\n    get selectedExample() {\n      // Same as the client: the store wins over the initial seed so the example\n      // selection survives re-renders and syncs across blocks.\n      return options.store.workspace['x-scalar-default-example'] ?? options.selectedExample\n    },\n    get selectedServer() {\n      // An explicit option wins (including an explicit `null` for \"no server\");\n      // otherwise derive it from the same document the operation resolved from.\n      return options.selectedServer !== undefined ? options.selectedServer : currentContext().server\n    },\n  })\n\n  // Render the operation path in the header by default. The reference renders\n  // this via the `#header` slot too, so the standalone block matches its look.\n  const renderHeader = () => h('span', { class: 'font-code text-c-2 min-w-0 truncate' }, options.path)\n\n  // Wrap the block in its own teleport root so floating UI (the client picker\n  // popover) renders inside the themed `.scalar-app` wrapper instead of escaping\n  // to `body`, where it would miss the color-mode variables and lose its styling.\n  const app = createApp(() =>\n    h('div', { class: getWrapperClass(options.darkMode) }, [\n      h(ScalarTeleportRoot, null, { default: () => h(CodeExample, props, { header: renderHeader }) }),\n    ]),\n  )\n\n  app.mount(element)\n\n  return {\n    app,\n    destroy: () => {\n      unsubscribeClient()\n      unsubscribeExample()\n      app.unmount()\n    },\n  }\n}\n"],"mappings":";;;;;;;;;AAyDA,IAAM,KAAmB,MACvB,CAAC,cAAc,MAAa,KAAO,cAAc,MAAa,KAAQ,eAAe,GAAG,CAAC,OAAO,QAAQ,CAAC,KAAK,IAAI,EAQvG,KAAqB,GAA0B,MAAsC;CAChG,IAAM,IAAU,OAAO,KAAO,WAAW,SAAS,cAAc,EAAG,GAAG;AACtE,KAAI,CAAC,EACH,OAAU,MAAM,sBAAsB,IAAK;CAG7C,IAAM,IAAW,GAAyB,EACpC,IAAgB,GAAuB,EAQvC,IAAW,EAAuB,EAAQ,MAAM,EAChD,IAAoB,EAAS,GAAG,qCAAqC,MACzE,EAAS,WAAW,CAAC,UAAU,qBAAqB,EAAQ,CAC7D,EAOK,IAAqB,EAAS,GAAG,sCAAsC,MAC3E,EAAS,WAAW,CAAC,UAAU,sBAAsB,EAAQ,CAC9D,EAWK,UAAqD;EAEzD,IAAM,IAAiB,EAAQ,MAAM,UAAU;AAC/C,MAAI,CAAC,KAAkB,EAAE,WAAW,GAClC;EAEF,IAAM,IAAW,EAAe,EAAe,QAAQ,EAAQ,MAAM,EAC/D,IAAY,EAAe,IAAW,EAAQ,QAAQ;AACvD,QAIL,QAAO;GAAE;GAAW,QADL,EAAe,EAAU,WAAW,MAAM,GAAU,WAAW,MAAM,EAAe,WAAW,KAAK;GACvF;;AAK9B,KAAI,CAAC,GAAgB,CACnB,OAAU,MAAM,wBAAwB,EAAQ,OAAO,aAAa,CAAC,GAAG,EAAQ,OAAO;CAOzF,IAAI,GAGE,UAAyC;EAC7C,IAAM,IAAU,GAAgB;AAIhC,SAHI,MACF,IAAc,IAER,KAAW;IAMf,IAAQ,EAA2B;EACvC,IAAI,YAA6B;AAC/B,UAAO,GAAgB,CAAC;;EAE1B,IAAI,SAAS;AACX,UAAO,EAAQ;;EAEjB,IAAI,OAAO;AACT,UAAO,EAAQ;;EAEjB;EACA;EACA,IAAI,kBAAkB;AACpB,UAAO,EAAQ,mBAAmB,EAAE;;EAEtC,IAAI,iBAAiB;AAInB,UAAO,EAAQ,MAAM,UAAU,8BAA8B,EAAQ;;EAEvE,IAAI,kBAAkB;AAGpB,UAAO,EAAQ,MAAM,UAAU,+BAA+B,EAAQ;;EAExE,IAAI,iBAAiB;AAGnB,UAAO,EAAQ,mBAAmB,KAAA,IAAqC,GAAgB,CAAC,SAA1C,EAAQ;;EAEzD,CAAC,EAII,UAAqB,EAAE,QAAQ,EAAE,OAAO,uCAAuC,EAAE,EAAQ,KAAK,EAK9F,IAAM,QACV,EAAE,OAAO,EAAE,OAAO,EAAgB,EAAQ,SAAS,EAAE,EAAE,CACrD,EAAE,GAAoB,MAAM,EAAE,eAAe,EAAE,GAAa,GAAO,EAAE,QAAQ,GAAc,CAAC,EAAE,CAAC,CAChG,CAAC,CACH;AAID,QAFA,EAAI,MAAM,EAAQ,EAEX;EACL;EACA,eAAe;AAGb,GAFA,GAAmB,EACnB,GAAoB,EACpB,EAAI,SAAS;;EAEhB"}

package/dist/code-example/test-utils.d.ts

@@ -0,0 +1,4 @@
+import type { WorkspaceEventBus } from '@scalar/workspace-store/events';
+/** Mock event bus for all your testing needs */
+export declare const mockEventBus: WorkspaceEventBus;
+//# sourceMappingURL=test-utils.d.ts.map

package/dist/code-example/test-utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"test-utils.d.ts","sourceRoot":"","sources":["../../src/code-example/test-utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,gCAAgC,CAAA;AAGvE,gDAAgD;AAChD,eAAO,MAAM,YAAY,EAQT,iBAAiB,CAAA"}

package/dist/code-example/types.d.ts

@@ -0,0 +1,46 @@
+import type { ScalarComboboxOption, ScalarComboboxOptionGroup } from '@scalar/components/combobox';
+import type { AvailableClients, ClientId, TargetId } from '@scalar/snippetz';
+/**
+ * Represents a client option in the request example block.
+ * Extends the base combobox option with language-specific information
+ * for generating code examples in different programming languages.
+ */
+export type ClientOption = ScalarComboboxOption & {
+    /** A more specific ID */
+    id: AvailableClients[number];
+    /** Programming language or tool for code generation (e.g., 'javascript', 'python', 'curl') */
+    lang: TargetId | 'curl' | 'plaintext';
+    /** Title shows when the client is selected in the dropdown */
+    title: string;
+    /** Target key for the client, differs from the lang due to the curl thing */
+    targetKey: TargetId;
+    /** Title of the target */
+    targetTitle: string;
+    /** Client key for the client */
+    clientKey: ClientId<TargetId>;
+};
+/**
+ * Augments the base combobox option group with ClientOptions
+ */
+export type ClientOptionGroup = ScalarComboboxOptionGroup<ClientOption> & {
+    /** Key of the group */
+    key: TargetId;
+};
+/** Better type safety when we have custom clients in the selector */
+export type CustomClientOption = ScalarComboboxOption & {
+    /** A custom ID */
+    id: `custom/${string}`;
+    /** Programming language or tool for code generation (e.g., 'javascript', 'python', 'curl') */
+    lang: TargetId | 'curl' | 'plaintext';
+    /** Title shows when the client is selected in the dropdown */
+    title: string;
+    /** Client key for the client */
+    clientKey: 'custom';
+};
+export type CustomOrDefaultClientOption = ClientOption | CustomClientOption;
+/** Augments the base combobox option group with CustomClientOptions */
+export type CustomClientOptionGroup = ScalarComboboxOptionGroup<CustomOrDefaultClientOption> & {
+    /** Key of the group */
+    key: 'custom' | TargetId;
+};
+//# sourceMappingURL=types.d.ts.map

package/dist/code-example/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/code-example/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAA;AAClG,OAAO,KAAK,EAAE,gBAAgB,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAA;AAE5E;;;;GAIG;AACH,MAAM,MAAM,YAAY,GAAG,oBAAoB,GAAG;IAChD,yBAAyB;IACzB,EAAE,EAAE,gBAAgB,CAAC,MAAM,CAAC,CAAA;IAC5B,8FAA8F;IAC9F,IAAI,EAAE,QAAQ,GAAG,MAAM,GAAG,WAAW,CAAA;IACrC,8DAA8D;IAC9D,KAAK,EAAE,MAAM,CAAA;IACb,6EAA6E;IAC7E,SAAS,EAAE,QAAQ,CAAA;IACnB,0BAA0B;IAC1B,WAAW,EAAE,MAAM,CAAA;IACnB,gCAAgC;IAChC,SAAS,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAAA;CAC9B,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,yBAAyB,CAAC,YAAY,CAAC,GAAG;IACxE,uBAAuB;IACvB,GAAG,EAAE,QAAQ,CAAA;CACd,CAAA;AAED,qEAAqE;AACrE,MAAM,MAAM,kBAAkB,GAAG,oBAAoB,GAAG;IACtD,kBAAkB;IAClB,EAAE,EAAE,UAAU,MAAM,EAAE,CAAA;IACtB,8FAA8F;IAC9F,IAAI,EAAE,QAAQ,GAAG,MAAM,GAAG,WAAW,CAAA;IACrC,8DAA8D;IAC9D,KAAK,EAAE,MAAM,CAAA;IACb,gCAAgC;IAChC,SAAS,EAAE,QAAQ,CAAA;CACpB,CAAA;AAED,MAAM,MAAM,2BAA2B,GAAG,YAAY,GAAG,kBAAkB,CAAA;AAE3E,uEAAuE;AACvE,MAAM,MAAM,uBAAuB,GAAG,yBAAyB,CAAC,2BAA2B,CAAC,GAAG;IAC7F,uBAAuB;IACvB,GAAG,EAAE,QAAQ,GAAG,QAAQ,CAAA;CACzB,CAAA"}

package/dist/constants.d.ts

@@ -0,0 +1,3 @@
+/** The version number taken from the package.json. Consumers can override at build time via define (e.g. OVERRIDE_PACKAGE_VERSION: JSON.stringify('1.2.3')). */
+export declare const APP_VERSION: string;
+//# sourceMappingURL=constants.d.ts.map

package/dist/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,gKAAgK;AAChK,eAAO,MAAM,WAAW,QAA+F,CAAA"}

package/dist/constants.js

@@ -0,0 +1,6 @@
+//#region src/constants.ts
+var e = typeof OVERRIDE_PACKAGE_VERSION < "u" ? OVERRIDE_PACKAGE_VERSION : "0.1.0";
+//#endregion
+export { e as APP_VERSION };
+
+//# sourceMappingURL=constants.js.map

package/dist/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","names":[],"sources":["../src/constants.ts"],"sourcesContent":["/** The version number taken from the package.json. Consumers can override at build time via define (e.g. OVERRIDE_PACKAGE_VERSION: JSON.stringify('1.2.3')). */\nexport const APP_VERSION = typeof OVERRIDE_PACKAGE_VERSION !== 'undefined' ? OVERRIDE_PACKAGE_VERSION : PACKAGE_VERSION\n"],"mappings":";AACA,IAAa,IAAc,OAAO,2BAA6B,MAAc,2BAAA"}