@scalar/api-reference 1.55.3 → 1.57.0

package/dist/helpers/openapi.js

@@ -2,11 +2,6 @@ import { getResolvedRef } from "@scalar/workspace-store/helpers/get-resolved-ref
 import { isObjectSchema } from "@scalar/workspace-store/schemas/v3.1/strict/type-guards";
 //#region src/helpers/openapi.ts
 var isSchemaObject = (value) => typeof value === "object" && value !== null;
-var schemaTypeToString = (schema) => {
-	if (!("type" in schema)) return "";
-	if (typeof schema.type === "string") return schema.type;
-	return Array.isArray(schema.type) ? schema.type.join("|") : "";
-};
 /**
 * Resolves a schema reference from workspace-store to a SchemaObject.
 * Returns undefined when a reference exists but has not been resolved yet.
@@ -15,81 +10,128 @@ function resolveSchemaRef(ref) {
 	if (typeof ref === "object" && ref !== null && "$ref" in ref) return isSchemaObject(ref["$ref-value"]) ? ref["$ref-value"] : void 0;
 	return ref;
 }
-/**
-* Formats a property object into a string.
-*/
-function formatProperty(key, obj) {
-	let output = key;
-	const isRequired = obj.required?.includes(key);
-	output += isRequired ? " REQUIRED " : " optional ";
-	const propRef = obj.properties[key];
-	if (!propRef) return output;
-	const property = resolveSchemaRef(propRef);
-	if (property) {
-		output += schemaTypeToString(property);
-		if ("description" in property && typeof property.description === "string") output += ` ${property.description}`;
-	}
-	return output;
+function pushUnique(target, value) {
+	if (!value) return;
+	if (!target.includes(value)) target.push(value);
 }
 /**
-* Recursively logs the properties of an object.
+* Recursively visits every property of a schema, descending transparently through composition
+* keywords (`oneOf`, `anyOf`, `allOf`) and one level into nested object properties.
+*
+* Composition is treated as transparent — a `oneOf` of two object variants is *the same level* as a
+* single object, just expressed as multiple shapes. Property nesting is capped to keep the index
+* focused on shallow, commonly-searched fields. A visited-set keyed by resolved-schema identity
+* guards against recursive (`Tree → Tree`) schemas.
 */
-function recursiveLogger(obj) {
-	const results = ["Body"];
-	const schema = getResolvedRef(obj?.schema);
-	if (!schema || !isObjectSchema(schema) || !schema.properties) return results;
-	const properties = schema.properties;
-	const schemaWithProps = {
-		properties,
-		required: schema.required
-	};
-	Object.keys(properties).forEach((key) => {
-		if (!obj.schema) return;
-		results.push(formatProperty(key, schemaWithProps));
-		const propRef = properties[key];
-		if (!propRef) return;
+function collectSchemaProperties(schema, options, propertyDepth = 0) {
+	if (!schema || options.visited.has(schema)) return;
+	options.visited.add(schema);
+	[
+		...schema.oneOf ?? [],
+		...schema.anyOf ?? [],
+		...schema.allOf ?? []
+	].forEach((variantRef) => {
+		collectSchemaProperties(resolveSchemaRef(variantRef), options, propertyDepth);
+	});
+	if (isObjectSchema(schema) && schema.properties) Object.entries(schema.properties).forEach(([key, propRef]) => {
 		const property = resolveSchemaRef(propRef);
-		if (property && isObjectSchema(property) && property.properties) {
-			const nestedProperties = property.properties;
-			Object.keys(nestedProperties).forEach((subKey) => {
-				const ref = nestedProperties[subKey];
-				if (!ref) return;
-				const nested = resolveSchemaRef(ref);
-				const typeStr = nested ? schemaTypeToString(nested) : "";
-				results.push(`${subKey} ${typeStr}`);
-			});
-		}
+		options.visit(key, property);
+		if (propertyDepth + 1 < options.maxPropertyDepth) collectSchemaProperties(property, options, propertyDepth + 1);
 	});
-	return results;
 }
 /**
-* Extracts the request body from an operation.
+* Walks the request body schemas of an operation and yields each property schema with its key.
 */
-function extractRequestBody(operation) {
+function forEachRequestBodyProperty(operation, visit) {
 	const content = getResolvedRef(operation?.requestBody)?.content;
-	const contentValue = Object.values(content ?? {});
-	if (contentValue.length === 0) return null;
-	return contentValue.flatMap((media) => recursiveLogger(media));
+	if (!content) return;
+	const visited = /* @__PURE__ */ new Set();
+	Object.values(content).forEach((media) => {
+		collectSchemaProperties(getResolvedRef(getResolvedRef(media)?.schema), {
+			visit,
+			visited,
+			maxPropertyDepth: 2
+		});
+	});
+}
+/**
+* Extracts the names of every parameter on an operation.
+*
+* The returned strings contain only parameter names (e.g. `userId`, `limit`) so they can be indexed
+* as a high-signal field for search. Filter-style metadata like `REQUIRED`, `optional`, `query` and
+* the schema type are intentionally excluded — those tokens dilute fuzzy matches and produce false
+* positives for queries like `query` or `integer`.
+*/
+function extractParameterNames(parameters) {
+	const names = [];
+	parameters.forEach((parameter) => {
+		pushUnique(names, getResolvedRef(parameter)?.name);
+	});
+	return names;
+}
+/**
+* Extracts the descriptions of every parameter on an operation.
+*
+* Kept separate from parameter names so the search index can weight each independently.
+*/
+function extractParameterDescriptions(parameters) {
+	const descriptions = [];
+	parameters.forEach((parameter) => {
+		pushUnique(descriptions, getResolvedRef(parameter)?.description);
+	});
+	return descriptions;
+}
+/**
+* Extracts the names of properties from the request body schema(s) of an operation.
+*
+* Walks every media type and includes both top-level and one level of nested property names so
+* common fields like `email` or `username` surface in search regardless of how the body is shaped.
+*/
+function extractBodyFieldNames(operation) {
+	const names = [];
+	forEachRequestBodyProperty(operation, (key) => {
+		pushUnique(names, key);
+	});
+	return names;
+}
+/**
+* Extracts the descriptions of properties from the request body schema(s) of an operation.
+*/
+function extractBodyDescriptions(operation) {
+	const descriptions = [];
+	forEachRequestBodyProperty(operation, (_key, schema) => {
+		if (schema && "description" in schema && typeof schema.description === "string") pushUnique(descriptions, schema.description);
+	});
+	return descriptions;
 }
 /**
-* Formats a parameter into a searchable string.
+* Extracts the property names of a schema for the search index.
+*
+* Same depth and composition behavior as `extractBodyFieldNames` — descends transparently through
+* `oneOf`/`anyOf`/`allOf`, walks one level into nested object properties, dedupes.
 */
-function formatParameter(param) {
-	const output = [param.name];
-	output.push(param.required ? "REQUIRED" : "optional");
-	output.push(param.in);
-	if ("schema" in param && param.schema) {
-		const schema = getResolvedRef(param.schema);
-		if (schema) output.push(schemaTypeToString(schema));
-	}
-	if (param.description) output.push(param.description);
-	return output.join(" ");
+function extractSchemaFieldNames(schema) {
+	const names = [];
+	collectSchemaProperties(schema, {
+		visit: (key) => pushUnique(names, key),
+		visited: /* @__PURE__ */ new Set(),
+		maxPropertyDepth: 2
+	});
+	return names;
 }
 /**
-* Extracts parameters from an operation into searchable strings.
+* Extracts the property descriptions of a schema for the search index.
 */
-function extractParameters(parameters) {
-	return parameters.map((parameter) => formatParameter(getResolvedRef(parameter)));
+function extractSchemaDescriptions(schema) {
+	const descriptions = [];
+	collectSchemaProperties(schema, {
+		visit: (_key, propertySchema) => {
+			if (propertySchema && "description" in propertySchema && typeof propertySchema.description === "string") pushUnique(descriptions, propertySchema.description);
+		},
+		visited: /* @__PURE__ */ new Set(),
+		maxPropertyDepth: 2
+	});
+	return descriptions;
 }
 /**
 * Deep merge for objects
@@ -128,6 +170,6 @@ function createEmptySpecification(partialSpecification) {
 	return emptySpecification;
 }
 //#endregion
-export { createEmptySpecification, extractParameters, extractRequestBody };
+export { createEmptySpecification, extractBodyDescriptions, extractBodyFieldNames, extractParameterDescriptions, extractParameterNames, extractSchemaDescriptions, extractSchemaFieldNames };
 
 //# sourceMappingURL=openapi.js.map

package/dist/helpers/openapi.js.map

@@ -1 +1 @@
-{"version":3,"file":"openapi.js","names":[],"sources":["../../src/helpers/openapi.ts"],"sourcesContent":["import { getResolvedRef } from '@scalar/workspace-store/helpers/get-resolved-ref'\nimport type { MediaTypeObject } from '@scalar/workspace-store/schemas/v3.1/strict/media-type'\nimport type {\n  OpenApiDocument,\n  OperationObject,\n  ParameterObject,\n  ReferenceType,\n  SchemaObject,\n  SchemaReferenceType,\n} from '@scalar/workspace-store/schemas/v3.1/strict/openapi-document'\nimport { isObjectSchema } from '@scalar/workspace-store/schemas/v3.1/strict/type-guards'\n\n/** Object schema shape with properties, used when logging request body. */\ntype ObjectSchemaWithProperties = {\n  properties: Record<string, SchemaReferenceType<SchemaObject>>\n  required?: string[]\n}\n\nconst isSchemaObject = (value: unknown): value is SchemaObject => typeof value === 'object' && value !== null\n\nconst schemaTypeToString = (schema: SchemaObject): string => {\n  if (!('type' in schema)) {\n    return ''\n  }\n\n  if (typeof schema.type === 'string') {\n    return schema.type\n  }\n\n  return Array.isArray(schema.type) ? schema.type.join('|') : ''\n}\n\n/**\n * Resolves a schema reference from workspace-store to a SchemaObject.\n * Returns undefined when a reference exists but has not been resolved yet.\n */\nfunction resolveSchemaRef(ref: SchemaReferenceType<SchemaObject>): SchemaObject | undefined {\n  if (typeof ref === 'object' && ref !== null && '$ref' in ref) {\n    return isSchemaObject(ref['$ref-value']) ? ref['$ref-value'] : undefined\n  }\n\n  return ref\n}\n\n/**\n * Formats a property object into a string.\n */\nfunction formatProperty(key: string, obj: ObjectSchemaWithProperties): string {\n  let output = key\n  const isRequired = obj.required?.includes(key)\n  output += isRequired ? ' REQUIRED ' : ' optional '\n  const propRef = obj.properties[key]\n  if (!propRef) {\n    return output\n  }\n  const property = resolveSchemaRef(propRef)\n\n  if (property) {\n    output += schemaTypeToString(property)\n\n    if ('description' in property && typeof property.description === 'string') {\n      output += ` ${property.description}`\n    }\n  }\n\n  return output\n}\n\n/**\n * Recursively logs the properties of an object.\n */\nfunction recursiveLogger(obj: MediaTypeObject): string[] {\n  const results: string[] = ['Body']\n  const schema = getResolvedRef(obj?.schema)\n\n  if (!schema || !isObjectSchema(schema) || !schema.properties) {\n    return results\n  }\n\n  const properties = schema.properties\n  const schemaWithProps: ObjectSchemaWithProperties = {\n    properties,\n    required: schema.required,\n  }\n  Object.keys(properties).forEach((key) => {\n    if (!obj.schema) {\n      return\n    }\n\n    results.push(formatProperty(key, schemaWithProps))\n\n    const propRef = properties[key]\n    if (!propRef) {\n      return\n    }\n    const property = resolveSchemaRef(propRef)\n    if (property && isObjectSchema(property) && property.properties) {\n      const nestedProperties = property.properties\n      Object.keys(nestedProperties).forEach((subKey) => {\n        const ref = nestedProperties[subKey]\n        if (!ref) {\n          return\n        }\n        const nested = resolveSchemaRef(ref)\n        const typeStr = nested ? schemaTypeToString(nested) : ''\n        results.push(`${subKey} ${typeStr}`)\n      })\n    }\n  })\n\n  return results\n}\n\n/**\n * Extracts the request body from an operation.\n */\nexport function extractRequestBody(operation: OperationObject): string[] | null {\n  const content = getResolvedRef(operation?.requestBody)?.content\n  const contentValue = Object.values(content ?? {})\n  if (contentValue.length === 0) {\n    // No content found\n    return null\n  }\n\n  return contentValue.flatMap((media) => recursiveLogger(media))\n}\n\n/**\n * Formats a parameter into a searchable string.\n */\nfunction formatParameter(param: ParameterObject): string {\n  const output = [param.name]\n  output.push(param.required ? 'REQUIRED' : 'optional')\n  output.push(param.in)\n\n  if ('schema' in param && param.schema) {\n    const schema = getResolvedRef(param.schema)\n    if (schema) {\n      output.push(schemaTypeToString(schema))\n    }\n  }\n\n  if (param.description) {\n    output.push(param.description)\n  }\n\n  return output.join(' ')\n}\n\n/**\n * Extracts parameters from an operation into searchable strings.\n */\nexport function extractParameters(parameters: ReferenceType<ParameterObject>[]): string[] | null {\n  return parameters.map((parameter) => formatParameter(getResolvedRef(parameter)))\n}\n\n/**\n * Deep merge for objects\n */\nexport function deepMerge(source: Record<any, any>, target: Record<any, any>) {\n  for (const [key, val] of Object.entries(source)) {\n    if (val !== null && typeof val === 'object') {\n      target[key] ??= new val.__proto__.constructor()\n      deepMerge(val, target[key])\n    } else if (typeof val !== 'undefined') {\n      target[key] = val\n    }\n  }\n\n  return target\n}\n\n/**\n * Creates an empty specification object.\n * The returning object has the same structure as a valid OpenAPI specification, but everything is empty.\n */\nexport function createEmptySpecification(partialSpecification?: Partial<OpenApiDocument>) {\n  const emptySpecification = {\n    openapi: '3.1.0',\n    info: {\n      title: '',\n      description: '',\n      termsOfService: '',\n      version: '',\n      license: {\n        name: '',\n        url: '',\n      },\n      contact: {\n        email: '',\n      },\n    },\n    servers: [],\n    tags: [],\n    'x-scalar-original-document-hash': '',\n  }\n\n  if (!partialSpecification) {\n    return emptySpecification as OpenApiDocument\n  }\n\n  deepMerge(partialSpecification, emptySpecification)\n\n  return emptySpecification as OpenApiDocument\n}\n"],"mappings":";;;AAkBA,IAAM,kBAAkB,UAA0C,OAAO,UAAU,YAAY,UAAU;AAEzG,IAAM,sBAAsB,WAAiC;AAC3D,KAAI,EAAE,UAAU,QACd,QAAO;AAGT,KAAI,OAAO,OAAO,SAAS,SACzB,QAAO,OAAO;AAGhB,QAAO,MAAM,QAAQ,OAAO,KAAK,GAAG,OAAO,KAAK,KAAK,IAAI,GAAG;;;;;;AAO9D,SAAS,iBAAiB,KAAkE;AAC1F,KAAI,OAAO,QAAQ,YAAY,QAAQ,QAAQ,UAAU,IACvD,QAAO,eAAe,IAAI,cAAc,GAAG,IAAI,gBAAgB,KAAA;AAGjE,QAAO;;;;;AAMT,SAAS,eAAe,KAAa,KAAyC;CAC5E,IAAI,SAAS;CACb,MAAM,aAAa,IAAI,UAAU,SAAS,IAAI;AAC9C,WAAU,aAAa,eAAe;CACtC,MAAM,UAAU,IAAI,WAAW;AAC/B,KAAI,CAAC,QACH,QAAO;CAET,MAAM,WAAW,iBAAiB,QAAQ;AAE1C,KAAI,UAAU;AACZ,YAAU,mBAAmB,SAAS;AAEtC,MAAI,iBAAiB,YAAY,OAAO,SAAS,gBAAgB,SAC/D,WAAU,IAAI,SAAS;;AAI3B,QAAO;;;;;AAMT,SAAS,gBAAgB,KAAgC;CACvD,MAAM,UAAoB,CAAC,OAAO;CAClC,MAAM,SAAS,eAAe,KAAK,OAAO;AAE1C,KAAI,CAAC,UAAU,CAAC,eAAe,OAAO,IAAI,CAAC,OAAO,WAChD,QAAO;CAGT,MAAM,aAAa,OAAO;CAC1B,MAAM,kBAA8C;EAClD;EACA,UAAU,OAAO;EAClB;AACD,QAAO,KAAK,WAAW,CAAC,SAAS,QAAQ;AACvC,MAAI,CAAC,IAAI,OACP;AAGF,UAAQ,KAAK,eAAe,KAAK,gBAAgB,CAAC;EAElD,MAAM,UAAU,WAAW;AAC3B,MAAI,CAAC,QACH;EAEF,MAAM,WAAW,iBAAiB,QAAQ;AAC1C,MAAI,YAAY,eAAe,SAAS,IAAI,SAAS,YAAY;GAC/D,MAAM,mBAAmB,SAAS;AAClC,UAAO,KAAK,iBAAiB,CAAC,SAAS,WAAW;IAChD,MAAM,MAAM,iBAAiB;AAC7B,QAAI,CAAC,IACH;IAEF,MAAM,SAAS,iBAAiB,IAAI;IACpC,MAAM,UAAU,SAAS,mBAAmB,OAAO,GAAG;AACtD,YAAQ,KAAK,GAAG,OAAO,GAAG,UAAU;KACpC;;GAEJ;AAEF,QAAO;;;;;AAMT,SAAgB,mBAAmB,WAA6C;CAC9E,MAAM,UAAU,eAAe,WAAW,YAAY,EAAE;CACxD,MAAM,eAAe,OAAO,OAAO,WAAW,EAAE,CAAC;AACjD,KAAI,aAAa,WAAW,EAE1B,QAAO;AAGT,QAAO,aAAa,SAAS,UAAU,gBAAgB,MAAM,CAAC;;;;;AAMhE,SAAS,gBAAgB,OAAgC;CACvD,MAAM,SAAS,CAAC,MAAM,KAAK;AAC3B,QAAO,KAAK,MAAM,WAAW,aAAa,WAAW;AACrD,QAAO,KAAK,MAAM,GAAG;AAErB,KAAI,YAAY,SAAS,MAAM,QAAQ;EACrC,MAAM,SAAS,eAAe,MAAM,OAAO;AAC3C,MAAI,OACF,QAAO,KAAK,mBAAmB,OAAO,CAAC;;AAI3C,KAAI,MAAM,YACR,QAAO,KAAK,MAAM,YAAY;AAGhC,QAAO,OAAO,KAAK,IAAI;;;;;AAMzB,SAAgB,kBAAkB,YAA+D;AAC/F,QAAO,WAAW,KAAK,cAAc,gBAAgB,eAAe,UAAU,CAAC,CAAC;;;;;AAMlF,SAAgB,UAAU,QAA0B,QAA0B;AAC5E,MAAK,MAAM,CAAC,KAAK,QAAQ,OAAO,QAAQ,OAAO,CAC7C,KAAI,QAAQ,QAAQ,OAAO,QAAQ,UAAU;AAC3C,SAAO,SAAS,IAAI,IAAI,UAAU,aAAa;AAC/C,YAAU,KAAK,OAAO,KAAK;YAClB,OAAO,QAAQ,YACxB,QAAO,OAAO;AAIlB,QAAO;;;;;;AAOT,SAAgB,yBAAyB,sBAAiD;CACxF,MAAM,qBAAqB;EACzB,SAAS;EACT,MAAM;GACJ,OAAO;GACP,aAAa;GACb,gBAAgB;GAChB,SAAS;GACT,SAAS;IACP,MAAM;IACN,KAAK;IACN;GACD,SAAS,EACP,OAAO,IACR;GACF;EACD,SAAS,EAAE;EACX,MAAM,EAAE;EACR,mCAAmC;EACpC;AAED,KAAI,CAAC,qBACH,QAAO;AAGT,WAAU,sBAAsB,mBAAmB;AAEnD,QAAO"}
+{"version":3,"file":"openapi.js","names":[],"sources":["../../src/helpers/openapi.ts"],"sourcesContent":["import { getResolvedRef } from '@scalar/workspace-store/helpers/get-resolved-ref'\nimport type {\n  MediaTypeObject,\n  OpenApiDocument,\n  OperationObject,\n  ParameterObject,\n  ReferenceType,\n  SchemaObject,\n  SchemaReferenceType,\n} from '@scalar/workspace-store/schemas/v3.1/strict/openapi-document'\nimport { isObjectSchema } from '@scalar/workspace-store/schemas/v3.1/strict/type-guards'\n\nconst isSchemaObject = (value: unknown): value is SchemaObject => typeof value === 'object' && value !== null\n\n/**\n * Resolves a schema reference from workspace-store to a SchemaObject.\n * Returns undefined when a reference exists but has not been resolved yet.\n */\nfunction resolveSchemaRef(ref: SchemaReferenceType<SchemaObject>): SchemaObject | undefined {\n  if (typeof ref === 'object' && ref !== null && '$ref' in ref) {\n    return isSchemaObject(ref['$ref-value']) ? ref['$ref-value'] : undefined\n  }\n\n  return ref\n}\n\nfunction pushUnique(target: string[], value: string | undefined): void {\n  if (!value) {\n    return\n  }\n  if (!target.includes(value)) {\n    target.push(value)\n  }\n}\n\ntype CollectOptions = {\n  visit: (key: string, schema: SchemaObject | undefined) => void\n  visited: Set<SchemaObject>\n  maxPropertyDepth: number\n}\n\n/**\n * Recursively visits every property of a schema, descending transparently through composition\n * keywords (`oneOf`, `anyOf`, `allOf`) and one level into nested object properties.\n *\n * Composition is treated as transparent — a `oneOf` of two object variants is *the same level* as a\n * single object, just expressed as multiple shapes. Property nesting is capped to keep the index\n * focused on shallow, commonly-searched fields. A visited-set keyed by resolved-schema identity\n * guards against recursive (`Tree → Tree`) schemas.\n */\nfunction collectSchemaProperties(schema: SchemaObject | undefined, options: CollectOptions, propertyDepth = 0): void {\n  if (!schema || options.visited.has(schema)) {\n    return\n  }\n  options.visited.add(schema)\n\n  const variants = [...(schema.oneOf ?? []), ...(schema.anyOf ?? []), ...(schema.allOf ?? [])]\n  variants.forEach((variantRef) => {\n    collectSchemaProperties(resolveSchemaRef(variantRef), options, propertyDepth)\n  })\n\n  if (isObjectSchema(schema) && schema.properties) {\n    Object.entries(schema.properties).forEach(([key, propRef]) => {\n      const property = resolveSchemaRef(propRef)\n      options.visit(key, property)\n      if (propertyDepth + 1 < options.maxPropertyDepth) {\n        collectSchemaProperties(property, options, propertyDepth + 1)\n      }\n    })\n  }\n}\n\n/**\n * Walks the request body schemas of an operation and yields each property schema with its key.\n */\nfunction forEachRequestBodyProperty(\n  operation: OperationObject,\n  visit: (key: string, schema: SchemaObject | undefined) => void,\n): void {\n  const content = getResolvedRef(operation?.requestBody)?.content\n  if (!content) {\n    return\n  }\n\n  const visited = new Set<SchemaObject>()\n  Object.values(content).forEach((media) => {\n    const resolvedMedia = getResolvedRef(media) as MediaTypeObject | undefined\n    const schema = getResolvedRef(resolvedMedia?.schema)\n    collectSchemaProperties(schema, { visit, visited, maxPropertyDepth: 2 })\n  })\n}\n\n/**\n * Extracts the names of every parameter on an operation.\n *\n * The returned strings contain only parameter names (e.g. `userId`, `limit`) so they can be indexed\n * as a high-signal field for search. Filter-style metadata like `REQUIRED`, `optional`, `query` and\n * the schema type are intentionally excluded — those tokens dilute fuzzy matches and produce false\n * positives for queries like `query` or `integer`.\n */\nexport function extractParameterNames(parameters: ReferenceType<ParameterObject>[]): string[] {\n  const names: string[] = []\n\n  parameters.forEach((parameter) => {\n    const resolved = getResolvedRef(parameter)\n    pushUnique(names, resolved?.name)\n  })\n\n  return names\n}\n\n/**\n * Extracts the descriptions of every parameter on an operation.\n *\n * Kept separate from parameter names so the search index can weight each independently.\n */\nexport function extractParameterDescriptions(parameters: ReferenceType<ParameterObject>[]): string[] {\n  const descriptions: string[] = []\n\n  parameters.forEach((parameter) => {\n    const resolved = getResolvedRef(parameter)\n    pushUnique(descriptions, resolved?.description)\n  })\n\n  return descriptions\n}\n\n/**\n * Extracts the names of properties from the request body schema(s) of an operation.\n *\n * Walks every media type and includes both top-level and one level of nested property names so\n * common fields like `email` or `username` surface in search regardless of how the body is shaped.\n */\nexport function extractBodyFieldNames(operation: OperationObject): string[] {\n  const names: string[] = []\n\n  forEachRequestBodyProperty(operation, (key) => {\n    pushUnique(names, key)\n  })\n\n  return names\n}\n\n/**\n * Extracts the descriptions of properties from the request body schema(s) of an operation.\n */\nexport function extractBodyDescriptions(operation: OperationObject): string[] {\n  const descriptions: string[] = []\n\n  forEachRequestBodyProperty(operation, (_key, schema) => {\n    if (schema && 'description' in schema && typeof schema.description === 'string') {\n      pushUnique(descriptions, schema.description)\n    }\n  })\n\n  return descriptions\n}\n\n/**\n * Extracts the property names of a schema for the search index.\n *\n * Same depth and composition behavior as `extractBodyFieldNames` — descends transparently through\n * `oneOf`/`anyOf`/`allOf`, walks one level into nested object properties, dedupes.\n */\nexport function extractSchemaFieldNames(schema: SchemaObject | undefined): string[] {\n  const names: string[] = []\n  collectSchemaProperties(schema, {\n    visit: (key) => pushUnique(names, key),\n    visited: new Set<SchemaObject>(),\n    maxPropertyDepth: 2,\n  })\n  return names\n}\n\n/**\n * Extracts the property descriptions of a schema for the search index.\n */\nexport function extractSchemaDescriptions(schema: SchemaObject | undefined): string[] {\n  const descriptions: string[] = []\n  collectSchemaProperties(schema, {\n    visit: (_key, propertySchema) => {\n      if (propertySchema && 'description' in propertySchema && typeof propertySchema.description === 'string') {\n        pushUnique(descriptions, propertySchema.description)\n      }\n    },\n    visited: new Set<SchemaObject>(),\n    maxPropertyDepth: 2,\n  })\n  return descriptions\n}\n\n/**\n * Deep merge for objects\n */\nexport function deepMerge(source: Record<any, any>, target: Record<any, any>) {\n  for (const [key, val] of Object.entries(source)) {\n    if (val !== null && typeof val === 'object') {\n      target[key] ??= new val.__proto__.constructor()\n      deepMerge(val, target[key])\n    } else if (typeof val !== 'undefined') {\n      target[key] = val\n    }\n  }\n\n  return target\n}\n\n/**\n * Creates an empty specification object.\n * The returning object has the same structure as a valid OpenAPI specification, but everything is empty.\n */\nexport function createEmptySpecification(partialSpecification?: Partial<OpenApiDocument>) {\n  const emptySpecification = {\n    openapi: '3.1.0',\n    info: {\n      title: '',\n      description: '',\n      termsOfService: '',\n      version: '',\n      license: {\n        name: '',\n        url: '',\n      },\n      contact: {\n        email: '',\n      },\n    },\n    servers: [],\n    tags: [],\n    'x-scalar-original-document-hash': '',\n  }\n\n  if (!partialSpecification) {\n    return emptySpecification as OpenApiDocument\n  }\n\n  deepMerge(partialSpecification, emptySpecification)\n\n  return emptySpecification as OpenApiDocument\n}\n"],"mappings":";;;AAYA,IAAM,kBAAkB,UAA0C,OAAO,UAAU,YAAY,UAAU;;;;;AAMzG,SAAS,iBAAiB,KAAkE;AAC1F,KAAI,OAAO,QAAQ,YAAY,QAAQ,QAAQ,UAAU,IACvD,QAAO,eAAe,IAAI,cAAc,GAAG,IAAI,gBAAgB,KAAA;AAGjE,QAAO;;AAGT,SAAS,WAAW,QAAkB,OAAiC;AACrE,KAAI,CAAC,MACH;AAEF,KAAI,CAAC,OAAO,SAAS,MAAM,CACzB,QAAO,KAAK,MAAM;;;;;;;;;;;AAmBtB,SAAS,wBAAwB,QAAkC,SAAyB,gBAAgB,GAAS;AACnH,KAAI,CAAC,UAAU,QAAQ,QAAQ,IAAI,OAAO,CACxC;AAEF,SAAQ,QAAQ,IAAI,OAAO;AAEV;EAAC,GAAI,OAAO,SAAS,EAAE;EAAG,GAAI,OAAO,SAAS,EAAE;EAAG,GAAI,OAAO,SAAS,EAAE;EAAE,CACnF,SAAS,eAAe;AAC/B,0BAAwB,iBAAiB,WAAW,EAAE,SAAS,cAAc;GAC7E;AAEF,KAAI,eAAe,OAAO,IAAI,OAAO,WACnC,QAAO,QAAQ,OAAO,WAAW,CAAC,SAAS,CAAC,KAAK,aAAa;EAC5D,MAAM,WAAW,iBAAiB,QAAQ;AAC1C,UAAQ,MAAM,KAAK,SAAS;AAC5B,MAAI,gBAAgB,IAAI,QAAQ,iBAC9B,yBAAwB,UAAU,SAAS,gBAAgB,EAAE;GAE/D;;;;;AAON,SAAS,2BACP,WACA,OACM;CACN,MAAM,UAAU,eAAe,WAAW,YAAY,EAAE;AACxD,KAAI,CAAC,QACH;CAGF,MAAM,0BAAU,IAAI,KAAmB;AACvC,QAAO,OAAO,QAAQ,CAAC,SAAS,UAAU;AAGxC,0BADe,eADO,eAAe,MAAM,EACE,OAAO,EACpB;GAAE;GAAO;GAAS,kBAAkB;GAAG,CAAC;GACxE;;;;;;;;;;AAWJ,SAAgB,sBAAsB,YAAwD;CAC5F,MAAM,QAAkB,EAAE;AAE1B,YAAW,SAAS,cAAc;AAEhC,aAAW,OADM,eAAe,UAAU,EACd,KAAK;GACjC;AAEF,QAAO;;;;;;;AAQT,SAAgB,6BAA6B,YAAwD;CACnG,MAAM,eAAyB,EAAE;AAEjC,YAAW,SAAS,cAAc;AAEhC,aAAW,cADM,eAAe,UAAU,EACP,YAAY;GAC/C;AAEF,QAAO;;;;;;;;AAST,SAAgB,sBAAsB,WAAsC;CAC1E,MAAM,QAAkB,EAAE;AAE1B,4BAA2B,YAAY,QAAQ;AAC7C,aAAW,OAAO,IAAI;GACtB;AAEF,QAAO;;;;;AAMT,SAAgB,wBAAwB,WAAsC;CAC5E,MAAM,eAAyB,EAAE;AAEjC,4BAA2B,YAAY,MAAM,WAAW;AACtD,MAAI,UAAU,iBAAiB,UAAU,OAAO,OAAO,gBAAgB,SACrE,YAAW,cAAc,OAAO,YAAY;GAE9C;AAEF,QAAO;;;;;;;;AAST,SAAgB,wBAAwB,QAA4C;CAClF,MAAM,QAAkB,EAAE;AAC1B,yBAAwB,QAAQ;EAC9B,QAAQ,QAAQ,WAAW,OAAO,IAAI;EACtC,yBAAS,IAAI,KAAmB;EAChC,kBAAkB;EACnB,CAAC;AACF,QAAO;;;;;AAMT,SAAgB,0BAA0B,QAA4C;CACpF,MAAM,eAAyB,EAAE;AACjC,yBAAwB,QAAQ;EAC9B,QAAQ,MAAM,mBAAmB;AAC/B,OAAI,kBAAkB,iBAAiB,kBAAkB,OAAO,eAAe,gBAAgB,SAC7F,YAAW,cAAc,eAAe,YAAY;;EAGxD,yBAAS,IAAI,KAAmB;EAChC,kBAAkB;EACnB,CAAC;AACF,QAAO;;;;;AAMT,SAAgB,UAAU,QAA0B,QAA0B;AAC5E,MAAK,MAAM,CAAC,KAAK,QAAQ,OAAO,QAAQ,OAAO,CAC7C,KAAI,QAAQ,QAAQ,OAAO,QAAQ,UAAU;AAC3C,SAAO,SAAS,IAAI,IAAI,UAAU,aAAa;AAC/C,YAAU,KAAK,OAAO,KAAK;YAClB,OAAO,QAAQ,YACxB,QAAO,OAAO;AAIlB,QAAO;;;;;;AAOT,SAAgB,yBAAyB,sBAAiD;CACxF,MAAM,qBAAqB;EACzB,SAAS;EACT,MAAM;GACJ,OAAO;GACP,aAAa;GACb,gBAAgB;GAChB,SAAS;GACT,SAAS;IACP,MAAM;IACN,KAAK;IACN;GACD,SAAS,EACP,OAAO,IACR;GACF;EACD,SAAS,EAAE;EACX,MAAM,EAAE;EACR,mCAAmC;EACpC;AAED,KAAI,CAAC,qBACH,QAAO;AAGT,WAAU,sBAAsB,mBAAmB;AAEnD,QAAO"}

package/dist/standalone/lib/html-api.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"html-api.d.ts","sourceRoot":"","sources":["../../../src/standalone/lib/html-api.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAEV,mCAAmC,EACnC,kBAAkB,EACnB,MAAM,6BAA6B,CAAA;AASpC;;GAEG;AACH,wBAAgB,kCAAkC,CAAC,GAAG,EAAE,QAAQ,GAAG,mCAAmC,CA+GrG;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,QAAQ,EAAE,aAAa,EAAE,mCAAmC,QAiBnG;AAID,eAAO,MAAM,eAAe,GAAI,KAAK,QAAQ,EAAE,UAAU,OAAO,GAAG,IAAI,mBAatE,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,kBAAkB,EAAE,kBA4HhC,CAAA"}
+{"version":3,"file":"html-api.d.ts","sourceRoot":"","sources":["../../../src/standalone/lib/html-api.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAEV,mCAAmC,EACnC,kBAAkB,EACnB,MAAM,6BAA6B,CAAA;AASpC;;GAEG;AACH,wBAAgB,kCAAkC,CAAC,GAAG,EAAE,QAAQ,GAAG,mCAAmC,CA+GrG;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,QAAQ,EAAE,aAAa,EAAE,mCAAmC,QAiBnG;AAID,eAAO,MAAM,eAAe,GAAI,KAAK,QAAQ,EAAE,UAAU,OAAO,GAAG,IAAI,mBAatE,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,kBAAkB,EAAE,kBAuIhC,CAAA"}

package/dist/standalone/lib/html-api.js

@@ -1,6 +1,6 @@
 import ApiReference_default from "../../components/ApiReference.vue.js";
 import { createApp, createSSRApp, h, reactive } from "vue";
-import "@scalar/types/api-reference";
+import "@scalar/schemas/api-reference";
 import { createHead } from "@unhead/vue/client";
 //#region src/standalone/lib/html-api.ts
 /**
@@ -23,6 +23,11 @@ var createApiReference = (elementOrSelectorOrConfig, optionalConfiguration) => {
 	let app = createReferenceApp(!!optionalConfiguration && !!mountElement && mountElement.children.length > 0);
 	if (optionalConfiguration) if (mountElement) app.mount(mountElement);
 	else console.error("Could not find a mount point for API References:", elementOrSelectorOrConfig);
+	const abortController = new AbortController();
+	const listenerOptions = {
+		capture: false,
+		signal: abortController.signal
+	};
 	/**
 	* Reload the API Reference
 	* @deprecated
@@ -36,9 +41,10 @@ var createApiReference = (elementOrSelectorOrConfig, optionalConfiguration) => {
 		app.unmount();
 		app = createReferenceApp();
 		app.mount(currentElement);
-	}, false);
+	}, listenerOptions);
 	/** Destroy the current API Reference instance */
 	const destroy = () => {
+		abortController.abort();
 		props.configuration = {};
 		app.unmount();
 	};
@@ -49,7 +55,7 @@ var createApiReference = (elementOrSelectorOrConfig, optionalConfiguration) => {
 	document.addEventListener("scalar:destroy-references", () => {
 		console.warn("scalar:destroy-references event has been deprecated, please use scalarInstance.destroy instead.");
 		destroy();
-	}, false);
+	}, listenerOptions);
 	/**
 	* Allow user to update configuration
 	* @deprecated
@@ -57,7 +63,7 @@ var createApiReference = (elementOrSelectorOrConfig, optionalConfiguration) => {
 	document.addEventListener("scalar:update-references-config", (ev) => {
 		console.warn("scalar:update-references-config event has been deprecated, please use scalarInstance.updateConfiguration instead.");
 		if ("detail" in ev) Object.assign(props, ev.detail);
-	}, false);
+	}, listenerOptions);
 	return {
 		app,
 		getConfiguration: () => props.configuration ?? {},

package/dist/standalone/lib/html-api.js.map

@@ -1 +1 @@
-{"version":3,"file":"html-api.js","names":[],"sources":["../../../src/standalone/lib/html-api.ts"],"sourcesContent":["import type {\n  AnyApiReferenceConfiguration,\n  ApiReferenceConfigurationWithSource,\n  CreateApiReference,\n} from '@scalar/types/api-reference'\nimport { apiReferenceConfigurationWithSourceSchema } from '@scalar/types/api-reference'\nimport { createHead } from '@unhead/vue/client'\nimport { createApp, createSSRApp, h, reactive } from 'vue'\n\nimport { default as ApiReference } from '@/components/ApiReference.vue'\n\nconst getSpecScriptTag = (doc: Document) => doc.getElementById('api-reference')\n\n/**\n * Reading the configuration from the data-attributes.\n */\nexport function getConfigurationFromDataAttributes(doc: Document): ApiReferenceConfigurationWithSource {\n  const specElement = doc.querySelector('[data-spec]')\n  const specUrlElement = doc.querySelector('[data-spec-url]')\n  const configurationScriptElement = doc.querySelector('#api-reference[data-configuration]')\n\n  const getConfiguration = () => {\n    // <script data-configuration=\"{ … }\" />\n    if (configurationScriptElement) {\n      const configurationFromElement = configurationScriptElement.getAttribute('data-configuration')\n\n      if (configurationFromElement) {\n        return {\n          _integration: 'html',\n          ...JSON.parse(configurationFromElement.split('&quot;').join('\"')),\n        }\n      }\n    }\n\n    return apiReferenceConfigurationWithSourceSchema.parse({ _integration: 'html' })\n  }\n\n  const getUrl = () => {\n    // Let's first check if the user passed a spec URL in the configuration.\n    if (getConfiguration().url) {\n      return getConfiguration().url\n    }\n\n    if (getConfiguration().spec?.url) {\n      return getConfiguration().spec?.url\n    }\n\n    // <script id=\"api-reference\" data-url=\"/scalar.json\" />\n    const specScriptTag = getSpecScriptTag(doc)\n    if (specScriptTag) {\n      const urlFromScriptTag = specScriptTag.getAttribute('data-url')?.trim()\n\n      if (urlFromScriptTag) {\n        return urlFromScriptTag\n      }\n    }\n\n    // <div data-spec-url=\"/scalar.json\" />\n    if (specUrlElement) {\n      console.warn(\n        '[@scalar/api-reference] The [data-spec-url] HTML API is deprecated. Use the new <script id=\"api-reference\" data-url=\"/scalar.json\" /> API instead.',\n      )\n      const urlFromSpecUrlElement = specUrlElement.getAttribute('data-spec-url')\n\n      if (urlFromSpecUrlElement) {\n        return urlFromSpecUrlElement\n      }\n    }\n\n    return undefined\n  }\n\n  const getContent = (): string | undefined => {\n    // <script id=\"api-reference\" type=\"application/json\">{\"openapi\":\"3.1.0\",\"info\":{\"title\":\"Example\"},\"paths\":{}}</script>\n    const specScriptTag = getSpecScriptTag(doc)\n    if (specScriptTag) {\n      const specFromScriptTag = specScriptTag.innerHTML?.trim()\n\n      if (specFromScriptTag) {\n        return specFromScriptTag\n      }\n    }\n\n    // <div data-spec='{\"openapi\":\"3.1.0\",\"info\":{\"title\":\"Example\"},\"paths\":{}}' />\n    if (specElement) {\n      console.warn(\n        '[@scalar/api-reference] The [data-spec] HTML API is deprecated. Use the new <script id=\"api-reference\" type=\"application/json\">{\"openapi\":\"3.1.0\",\"info\":{\"title\":\"Example\"},\"paths\":{}}</script> API instead.',\n      )\n      const specFromSpecElement = specElement.getAttribute('data-spec')?.trim()\n\n      if (specFromSpecElement) {\n        return specFromSpecElement\n      }\n    }\n\n    return undefined\n  }\n\n  const getProxyUrl = () => {\n    // <script id=\"api-reference\" data-proxy-url=\"https://proxy.scalar.com\">…</script>\n    const specScriptTag = getSpecScriptTag(doc)\n    if (specScriptTag) {\n      const proxyUrl = specScriptTag.getAttribute('data-proxy-url')\n\n      if (proxyUrl) {\n        return proxyUrl.trim()\n      }\n    }\n\n    return undefined\n  }\n\n  // Ensure Reference Props are reactive\n  if (!specUrlElement && !specElement && !getSpecScriptTag(doc)) {\n    // Stay quiet.\n  } else {\n    const urlOrContent = getContent() ? { content: getContent() } : { url: getUrl() }\n\n    return apiReferenceConfigurationWithSourceSchema.parse({\n      _integration: 'html',\n      proxyUrl: getProxyUrl(),\n      ...getConfiguration(),\n      ...urlOrContent,\n    })\n  }\n\n  return apiReferenceConfigurationWithSourceSchema.parse({ _integration: 'html' })\n}\n\n/**\n * Mount the Scalar API Reference on a given document.\n * Read the HTML data-attributes for configuration.\n */\nexport function findDataAttributes(doc: Document, configuration: ApiReferenceConfigurationWithSource) {\n  /** @deprecated Use the new <script id=\"api-reference\" data-url=\"/scalar.json\" /> API instead. */\n  const specElement = doc.querySelector('[data-spec]')\n  /** @deprecated Use the new <script id=\"api-reference\" data-url=\"/scalar.json\" /> API instead. */\n  const specUrlElement = doc.querySelector('[data-spec-url]')\n\n  if (configuration?.darkMode) {\n    doc.body?.classList.add('dark-mode')\n  } else {\n    doc.body?.classList.add('light-mode')\n  }\n\n  const container = createContainer(doc, specElement || specUrlElement)\n\n  if (container) {\n    createApiReference(container, configuration)\n  }\n}\n\n// If it's a script tag, we can't mount the Vue.js app inside that tag.\n// We need to add a new container element before the script tag.\nexport const createContainer = (doc: Document, element?: Element | null) => {\n  let _container: Element | null = null\n\n  const specScriptTag = getSpecScriptTag(doc)\n\n  if (specScriptTag) {\n    _container = doc.createElement('div')\n    specScriptTag?.parentNode?.insertBefore(_container, specScriptTag)\n  } else if (element) {\n    _container = element\n  }\n\n  return _container\n}\n\n/**\n * Create (and mount) a new Scalar API Reference\n *\n * @example createApiReference({ url: '/scalar.json' }).mount('#app')\n * @example createApiReference('#app', { url: '/scalar.json' })\n * @example createApiReference(document.getElementById('app'), { url: '/scalar.json' })\n */\nexport const createApiReference: CreateApiReference = (\n  elementOrSelectorOrConfig,\n  optionalConfiguration?: AnyApiReferenceConfiguration,\n) => {\n  // Create an id prefix for useId so we don't have collisions with other Vue apps\n  const idPrefix = 'scalar-refs'\n\n  const props = reactive<{ configuration: AnyApiReferenceConfiguration }>({\n    // Either the configuration will be the second argument or it MUST be the first (configuration only)\n    configuration: optionalConfiguration ?? (elementOrSelectorOrConfig as AnyApiReferenceConfiguration) ?? {},\n  })\n\n  const createReferenceApp = (isSsr = false) => {\n    const referenceApp = isSsr ? createSSRApp(() => h(ApiReference, props)) : createApp(() => h(ApiReference, props))\n\n    // Meta tags, etc.\n    referenceApp.use(createHead())\n    referenceApp.config.idPrefix = idPrefix\n\n    return referenceApp\n  }\n\n  // If we have an optional config, then we must mount the element immediately (not sure why type is not narrowing)\n  const mountElement = optionalConfiguration\n    ? typeof elementOrSelectorOrConfig === 'string'\n      ? document.querySelector(elementOrSelectorOrConfig)\n      : (elementOrSelectorOrConfig as Element)\n    : null\n\n  // Detect server-rendered content and use createSSRApp for hydration\n  const shouldHydrate = !!optionalConfiguration && !!mountElement && mountElement.children.length > 0\n  let app = createReferenceApp(shouldHydrate)\n\n  if (optionalConfiguration) {\n    if (mountElement) {\n      app.mount(mountElement)\n    } else {\n      console.error('Could not find a mount point for API References:', elementOrSelectorOrConfig)\n    }\n  }\n\n  /**\n   * Reload the API Reference\n   * @deprecated\n   */\n  document.addEventListener(\n    'scalar:reload-references',\n    () => {\n      console.warn(\n        'scalar:reload-references event has been deprecated, please use the scalarInstance.app.mount method instead.',\n      )\n      if (!props.configuration) {\n        return\n      }\n\n      // Snag the current element\n      const currentElement =\n        typeof elementOrSelectorOrConfig === 'string'\n          ? document.querySelector(elementOrSelectorOrConfig)\n          : (elementOrSelectorOrConfig as Element)\n\n      if (!currentElement) {\n        return\n      }\n\n      // Ensure we re-attach the element if it was unmounted\n      if (currentElement && !document.body.contains(currentElement)) {\n        document.body.appendChild(currentElement)\n      }\n\n      // Create a new Vue app instance\n      app.unmount()\n      app = createReferenceApp()\n      app.mount(currentElement)\n    },\n    false,\n  )\n\n  /** Destroy the current API Reference instance */\n  const destroy = () => {\n    props.configuration = {}\n    app.unmount()\n  }\n\n  /**\n   * Allow user to destroy the API Reference\n   * @deprecated\n   */\n  document.addEventListener(\n    'scalar:destroy-references',\n    () => {\n      console.warn('scalar:destroy-references event has been deprecated, please use scalarInstance.destroy instead.')\n      destroy()\n    },\n    false,\n  )\n\n  /**\n   * Allow user to update configuration\n   * @deprecated\n   */\n  document.addEventListener(\n    'scalar:update-references-config',\n    (ev) => {\n      console.warn(\n        'scalar:update-references-config event has been deprecated, please use scalarInstance.updateConfiguration instead.',\n      )\n      if ('detail' in ev) {\n        Object.assign(props, ev.detail)\n      }\n    },\n    false,\n  )\n\n  const instance = {\n    app,\n    getConfiguration: () => props.configuration ?? {},\n    updateConfiguration: (newConfig: AnyApiReferenceConfiguration) => {\n      props.configuration = newConfig\n    },\n    destroy,\n  }\n\n  return instance\n}\n"],"mappings":";;;;;;;;;;;;AAgLA,IAAa,sBACX,2BACA,0BACG;CAEH,MAAM,WAAW;CAEjB,MAAM,QAAQ,SAA0D,EAEtE,eAAe,yBAA0B,6BAA8D,EAAE,EAC1G,CAAC;CAEF,MAAM,sBAAsB,QAAQ,UAAU;EAC5C,MAAM,eAAe,QAAQ,mBAAmB,EAAE,sBAAc,MAAM,CAAC,GAAG,gBAAgB,EAAE,sBAAc,MAAM,CAAC;AAGjH,eAAa,IAAI,YAAY,CAAC;AAC9B,eAAa,OAAO,WAAW;AAE/B,SAAO;;CAIT,MAAM,eAAe,wBACjB,OAAO,8BAA8B,WACnC,SAAS,cAAc,0BAA0B,GAChD,4BACH;CAIJ,IAAI,MAAM,mBADY,CAAC,CAAC,yBAAyB,CAAC,CAAC,gBAAgB,aAAa,SAAS,SAAS,EACvD;AAE3C,KAAI,sBACF,KAAI,aACF,KAAI,MAAM,aAAa;KAEvB,SAAQ,MAAM,oDAAoD,0BAA0B;;;;;AAQhG,UAAS,iBACP,kCACM;AACJ,UAAQ,KACN,8GACD;AACD,MAAI,CAAC,MAAM,cACT;EAIF,MAAM,iBACJ,OAAO,8BAA8B,WACjC,SAAS,cAAc,0BAA0B,GAChD;AAEP,MAAI,CAAC,eACH;AAIF,MAAI,kBAAkB,CAAC,SAAS,KAAK,SAAS,eAAe,CAC3D,UAAS,KAAK,YAAY,eAAe;AAI3C,MAAI,SAAS;AACb,QAAM,oBAAoB;AAC1B,MAAI,MAAM,eAAe;IAE3B,MACD;;CAGD,MAAM,gBAAgB;AACpB,QAAM,gBAAgB,EAAE;AACxB,MAAI,SAAS;;;;;;AAOf,UAAS,iBACP,mCACM;AACJ,UAAQ,KAAK,kGAAkG;AAC/G,WAAS;IAEX,MACD;;;;;AAMD,UAAS,iBACP,oCACC,OAAO;AACN,UAAQ,KACN,oHACD;AACD,MAAI,YAAY,GACd,QAAO,OAAO,OAAO,GAAG,OAAO;IAGnC,MACD;AAWD,QATiB;EACf;EACA,wBAAwB,MAAM,iBAAiB,EAAE;EACjD,sBAAsB,cAA4C;AAChE,SAAM,gBAAgB;;EAExB;EACD"}
+{"version":3,"file":"html-api.js","names":[],"sources":["../../../src/standalone/lib/html-api.ts"],"sourcesContent":["import type {\n  AnyApiReferenceConfiguration,\n  ApiReferenceConfigurationWithSource,\n  CreateApiReference,\n} from '@scalar/types/api-reference'\nimport { apiReferenceConfigurationWithSourceSchema } from '@scalar/schemas/api-reference'\nimport { createHead } from '@unhead/vue/client'\nimport { createApp, createSSRApp, h, reactive } from 'vue'\n\nimport { default as ApiReference } from '@/components/ApiReference.vue'\n\nconst getSpecScriptTag = (doc: Document) => doc.getElementById('api-reference')\n\n/**\n * Reading the configuration from the data-attributes.\n */\nexport function getConfigurationFromDataAttributes(doc: Document): ApiReferenceConfigurationWithSource {\n  const specElement = doc.querySelector('[data-spec]')\n  const specUrlElement = doc.querySelector('[data-spec-url]')\n  const configurationScriptElement = doc.querySelector('#api-reference[data-configuration]')\n\n  const getConfiguration = () => {\n    // <script data-configuration=\"{ … }\" />\n    if (configurationScriptElement) {\n      const configurationFromElement = configurationScriptElement.getAttribute('data-configuration')\n\n      if (configurationFromElement) {\n        return {\n          _integration: 'html',\n          ...JSON.parse(configurationFromElement.split('&quot;').join('\"')),\n        }\n      }\n    }\n\n    return apiReferenceConfigurationWithSourceSchema({ _integration: 'html' })\n  }\n\n  const getUrl = () => {\n    // Let's first check if the user passed a spec URL in the configuration.\n    if (getConfiguration().url) {\n      return getConfiguration().url\n    }\n\n    if (getConfiguration().spec?.url) {\n      return getConfiguration().spec?.url\n    }\n\n    // <script id=\"api-reference\" data-url=\"/scalar.json\" />\n    const specScriptTag = getSpecScriptTag(doc)\n    if (specScriptTag) {\n      const urlFromScriptTag = specScriptTag.getAttribute('data-url')?.trim()\n\n      if (urlFromScriptTag) {\n        return urlFromScriptTag\n      }\n    }\n\n    // <div data-spec-url=\"/scalar.json\" />\n    if (specUrlElement) {\n      console.warn(\n        '[@scalar/api-reference] The [data-spec-url] HTML API is deprecated. Use the new <script id=\"api-reference\" data-url=\"/scalar.json\" /> API instead.',\n      )\n      const urlFromSpecUrlElement = specUrlElement.getAttribute('data-spec-url')\n\n      if (urlFromSpecUrlElement) {\n        return urlFromSpecUrlElement\n      }\n    }\n\n    return undefined\n  }\n\n  const getContent = (): string | undefined => {\n    // <script id=\"api-reference\" type=\"application/json\">{\"openapi\":\"3.1.0\",\"info\":{\"title\":\"Example\"},\"paths\":{}}</script>\n    const specScriptTag = getSpecScriptTag(doc)\n    if (specScriptTag) {\n      const specFromScriptTag = specScriptTag.innerHTML?.trim()\n\n      if (specFromScriptTag) {\n        return specFromScriptTag\n      }\n    }\n\n    // <div data-spec='{\"openapi\":\"3.1.0\",\"info\":{\"title\":\"Example\"},\"paths\":{}}' />\n    if (specElement) {\n      console.warn(\n        '[@scalar/api-reference] The [data-spec] HTML API is deprecated. Use the new <script id=\"api-reference\" type=\"application/json\">{\"openapi\":\"3.1.0\",\"info\":{\"title\":\"Example\"},\"paths\":{}}</script> API instead.',\n      )\n      const specFromSpecElement = specElement.getAttribute('data-spec')?.trim()\n\n      if (specFromSpecElement) {\n        return specFromSpecElement\n      }\n    }\n\n    return undefined\n  }\n\n  const getProxyUrl = () => {\n    // <script id=\"api-reference\" data-proxy-url=\"https://proxy.scalar.com\">…</script>\n    const specScriptTag = getSpecScriptTag(doc)\n    if (specScriptTag) {\n      const proxyUrl = specScriptTag.getAttribute('data-proxy-url')\n\n      if (proxyUrl) {\n        return proxyUrl.trim()\n      }\n    }\n\n    return undefined\n  }\n\n  // Ensure Reference Props are reactive\n  if (!specUrlElement && !specElement && !getSpecScriptTag(doc)) {\n    // Stay quiet.\n  } else {\n    const urlOrContent = getContent() ? { content: getContent() } : { url: getUrl() }\n\n    return apiReferenceConfigurationWithSourceSchema({\n      _integration: 'html',\n      proxyUrl: getProxyUrl(),\n      ...getConfiguration(),\n      ...urlOrContent,\n    })\n  }\n\n  return apiReferenceConfigurationWithSourceSchema({ _integration: 'html' })\n}\n\n/**\n * Mount the Scalar API Reference on a given document.\n * Read the HTML data-attributes for configuration.\n */\nexport function findDataAttributes(doc: Document, configuration: ApiReferenceConfigurationWithSource) {\n  /** @deprecated Use the new <script id=\"api-reference\" data-url=\"/scalar.json\" /> API instead. */\n  const specElement = doc.querySelector('[data-spec]')\n  /** @deprecated Use the new <script id=\"api-reference\" data-url=\"/scalar.json\" /> API instead. */\n  const specUrlElement = doc.querySelector('[data-spec-url]')\n\n  if (configuration?.darkMode) {\n    doc.body?.classList.add('dark-mode')\n  } else {\n    doc.body?.classList.add('light-mode')\n  }\n\n  const container = createContainer(doc, specElement || specUrlElement)\n\n  if (container) {\n    createApiReference(container, configuration)\n  }\n}\n\n// If it's a script tag, we can't mount the Vue.js app inside that tag.\n// We need to add a new container element before the script tag.\nexport const createContainer = (doc: Document, element?: Element | null) => {\n  let _container: Element | null = null\n\n  const specScriptTag = getSpecScriptTag(doc)\n\n  if (specScriptTag) {\n    _container = doc.createElement('div')\n    specScriptTag?.parentNode?.insertBefore(_container, specScriptTag)\n  } else if (element) {\n    _container = element\n  }\n\n  return _container\n}\n\n/**\n * Create (and mount) a new Scalar API Reference\n *\n * @example createApiReference({ url: '/scalar.json' }).mount('#app')\n * @example createApiReference('#app', { url: '/scalar.json' })\n * @example createApiReference(document.getElementById('app'), { url: '/scalar.json' })\n */\nexport const createApiReference: CreateApiReference = (\n  elementOrSelectorOrConfig,\n  optionalConfiguration?: AnyApiReferenceConfiguration,\n) => {\n  // Create an id prefix for useId so we don't have collisions with other Vue apps\n  const idPrefix = 'scalar-refs'\n\n  const props = reactive<{ configuration: AnyApiReferenceConfiguration }>({\n    // Either the configuration will be the second argument or it MUST be the first (configuration only)\n    configuration: optionalConfiguration ?? (elementOrSelectorOrConfig as AnyApiReferenceConfiguration) ?? {},\n  })\n\n  const createReferenceApp = (isSsr = false) => {\n    const referenceApp = isSsr ? createSSRApp(() => h(ApiReference, props)) : createApp(() => h(ApiReference, props))\n\n    // Meta tags, etc.\n    referenceApp.use(createHead())\n    referenceApp.config.idPrefix = idPrefix\n\n    return referenceApp\n  }\n\n  // If we have an optional config, then we must mount the element immediately (not sure why type is not narrowing)\n  const mountElement = optionalConfiguration\n    ? typeof elementOrSelectorOrConfig === 'string'\n      ? document.querySelector(elementOrSelectorOrConfig)\n      : (elementOrSelectorOrConfig as Element)\n    : null\n\n  // Detect server-rendered content and use createSSRApp for hydration\n  const shouldHydrate = !!optionalConfiguration && !!mountElement && mountElement.children.length > 0\n  let app = createReferenceApp(shouldHydrate)\n\n  if (optionalConfiguration) {\n    if (mountElement) {\n      app.mount(mountElement)\n    } else {\n      console.error('Could not find a mount point for API References:', elementOrSelectorOrConfig)\n    }\n  }\n\n  // Tie the deprecated `document` listeners to an AbortController so `destroy`\n  // can remove them all at once. Without this, every `createApiReference()`\n  // call leaks three permanent listeners — visible during Astro view\n  // transitions where each navigation creates a new instance.\n  const abortController = new AbortController()\n  const listenerOptions: AddEventListenerOptions = {\n    capture: false,\n    signal: abortController.signal,\n  }\n\n  /**\n   * Reload the API Reference\n   * @deprecated\n   */\n  document.addEventListener(\n    'scalar:reload-references',\n    () => {\n      console.warn(\n        'scalar:reload-references event has been deprecated, please use the scalarInstance.app.mount method instead.',\n      )\n      if (!props.configuration) {\n        return\n      }\n\n      // Snag the current element\n      const currentElement =\n        typeof elementOrSelectorOrConfig === 'string'\n          ? document.querySelector(elementOrSelectorOrConfig)\n          : (elementOrSelectorOrConfig as Element)\n\n      if (!currentElement) {\n        return\n      }\n\n      // Ensure we re-attach the element if it was unmounted\n      if (currentElement && !document.body.contains(currentElement)) {\n        document.body.appendChild(currentElement)\n      }\n\n      // Create a new Vue app instance\n      app.unmount()\n      app = createReferenceApp()\n      app.mount(currentElement)\n    },\n    listenerOptions,\n  )\n\n  /** Destroy the current API Reference instance */\n  const destroy = () => {\n    abortController.abort()\n    props.configuration = {}\n    app.unmount()\n  }\n\n  /**\n   * Allow user to destroy the API Reference\n   * @deprecated\n   */\n  document.addEventListener(\n    'scalar:destroy-references',\n    () => {\n      console.warn('scalar:destroy-references event has been deprecated, please use scalarInstance.destroy instead.')\n      destroy()\n    },\n    listenerOptions,\n  )\n\n  /**\n   * Allow user to update configuration\n   * @deprecated\n   */\n  document.addEventListener(\n    'scalar:update-references-config',\n    (ev) => {\n      console.warn(\n        'scalar:update-references-config event has been deprecated, please use scalarInstance.updateConfiguration instead.',\n      )\n      if ('detail' in ev) {\n        Object.assign(props, ev.detail)\n      }\n    },\n    listenerOptions,\n  )\n\n  const instance = {\n    app,\n    getConfiguration: () => props.configuration ?? {},\n    updateConfiguration: (newConfig: AnyApiReferenceConfiguration) => {\n      props.configuration = newConfig\n    },\n    destroy,\n  }\n\n  return instance\n}\n"],"mappings":";;;;;;;;;;;;AAgLA,IAAa,sBACX,2BACA,0BACG;CAEH,MAAM,WAAW;CAEjB,MAAM,QAAQ,SAA0D,EAEtE,eAAe,yBAA0B,6BAA8D,EAAE,EAC1G,CAAC;CAEF,MAAM,sBAAsB,QAAQ,UAAU;EAC5C,MAAM,eAAe,QAAQ,mBAAmB,EAAE,sBAAc,MAAM,CAAC,GAAG,gBAAgB,EAAE,sBAAc,MAAM,CAAC;AAGjH,eAAa,IAAI,YAAY,CAAC;AAC9B,eAAa,OAAO,WAAW;AAE/B,SAAO;;CAIT,MAAM,eAAe,wBACjB,OAAO,8BAA8B,WACnC,SAAS,cAAc,0BAA0B,GAChD,4BACH;CAIJ,IAAI,MAAM,mBADY,CAAC,CAAC,yBAAyB,CAAC,CAAC,gBAAgB,aAAa,SAAS,SAAS,EACvD;AAE3C,KAAI,sBACF,KAAI,aACF,KAAI,MAAM,aAAa;KAEvB,SAAQ,MAAM,oDAAoD,0BAA0B;CAQhG,MAAM,kBAAkB,IAAI,iBAAiB;CAC7C,MAAM,kBAA2C;EAC/C,SAAS;EACT,QAAQ,gBAAgB;EACzB;;;;;AAMD,UAAS,iBACP,kCACM;AACJ,UAAQ,KACN,8GACD;AACD,MAAI,CAAC,MAAM,cACT;EAIF,MAAM,iBACJ,OAAO,8BAA8B,WACjC,SAAS,cAAc,0BAA0B,GAChD;AAEP,MAAI,CAAC,eACH;AAIF,MAAI,kBAAkB,CAAC,SAAS,KAAK,SAAS,eAAe,CAC3D,UAAS,KAAK,YAAY,eAAe;AAI3C,MAAI,SAAS;AACb,QAAM,oBAAoB;AAC1B,MAAI,MAAM,eAAe;IAE3B,gBACD;;CAGD,MAAM,gBAAgB;AACpB,kBAAgB,OAAO;AACvB,QAAM,gBAAgB,EAAE;AACxB,MAAI,SAAS;;;;;;AAOf,UAAS,iBACP,mCACM;AACJ,UAAQ,KAAK,kGAAkG;AAC/G,WAAS;IAEX,gBACD;;;;;AAMD,UAAS,iBACP,oCACC,OAAO;AACN,UAAQ,KACN,oHACD;AACD,MAAI,YAAY,GACd,QAAO,OAAO,OAAO,GAAG,OAAO;IAGnC,gBACD;AAWD,QATiB;EACf;EACA,wBAAwB,MAAM,iBAAiB,EAAE;EACjD,sBAAsB,cAA4C;AAChE,SAAM,gBAAgB;;EAExB;EACD"}