@scalar/api-reference 1.60.0 → 1.61.0

package/dist/helpers/get-async-api-message-payload-schema.d.ts

@@ -0,0 +1,18 @@
+import type { AsyncApiMessageObject } from '@scalar/types/asyncapi/3.1';
+import type { SchemaObject } from '@scalar/workspace-store/schemas/v3.1/strict/openapi-document';
+/**
+ * Unwraps an AsyncAPI schema-bearing value into the `SchemaObject` shape the shared OpenAPI
+ * `Schema`/`Model` components expect.
+ *
+ * AsyncAPI reuses JSON Schema, but a value may need extra handling:
+ * - The value itself may be a `$ref`; it is resolved to its `$ref-value`.
+ * - A Multi Format Schema Object (`schemaFormat` plus a nested `schema`) is unwrapped to its
+ *   payload, so we render the inner JSON Schema rather than the wrapper.
+ * - Boolean (`true`/`false`) and non-JSON-Schema payloads are skipped.
+ */
+export declare const unwrapAsyncApiSchema: (value: unknown) => SchemaObject | undefined;
+/** Resolves an AsyncAPI message `payload` into the `SchemaObject` the shared Schema component expects. */
+export declare const getAsyncApiMessagePayloadSchema: (message: AsyncApiMessageObject) => SchemaObject | undefined;
+/** Resolves an AsyncAPI message `headers` into the `SchemaObject` the shared Schema component expects. */
+export declare const getAsyncApiMessageHeadersSchema: (message: AsyncApiMessageObject) => SchemaObject | undefined;
+//# sourceMappingURL=get-async-api-message-payload-schema.d.ts.map

package/dist/helpers/get-async-api-message-payload-schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-async-api-message-payload-schema.d.ts","sourceRoot":"","sources":["../../src/helpers/get-async-api-message-payload-schema.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAA;AAEvE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,8DAA8D,CAAA;AAShG;;;;;;;;;GASG;AACH,eAAO,MAAM,oBAAoB,GAAI,OAAO,OAAO,KAAG,YAAY,GAAG,SAYpE,CAAA;AAED,0GAA0G;AAC1G,eAAO,MAAM,+BAA+B,GAAI,SAAS,qBAAqB,KAAG,YAAY,GAAG,SACzD,CAAA;AAEvC,0GAA0G;AAC1G,eAAO,MAAM,+BAA+B,GAAI,SAAS,qBAAqB,KAAG,YAAY,GAAG,SACzD,CAAA"}

package/dist/helpers/get-async-api-message-payload-schema.js

@@ -0,0 +1,33 @@
+import { getResolvedRef } from "@scalar/workspace-store/helpers/get-resolved-ref";
+import { isObject } from "@scalar/helpers/object/is-object";
+//#region src/helpers/get-async-api-message-payload-schema.ts
+/**
+* A resolved schema-bearing value may be a JSON Schema object, a boolean (`true`/`false`)
+* schema, or a Multi Format Schema wrapper, so accept only plain objects and treat them as the
+* `SchemaObject` the shared Schema/Model rendering expects.
+*/
+var isSchemaObject = (value) => isObject(value);
+/**
+* Unwraps an AsyncAPI schema-bearing value into the `SchemaObject` shape the shared OpenAPI
+* `Schema`/`Model` components expect.
+*
+* AsyncAPI reuses JSON Schema, but a value may need extra handling:
+* - The value itself may be a `$ref`; it is resolved to its `$ref-value`.
+* - A Multi Format Schema Object (`schemaFormat` plus a nested `schema`) is unwrapped to its
+*   payload, so we render the inner JSON Schema rather than the wrapper.
+* - Boolean (`true`/`false`) and non-JSON-Schema payloads are skipped.
+*/
+var unwrapAsyncApiSchema = (value) => {
+	if (value === void 0) return;
+	const resolved = getResolvedRef(value);
+	const schema = isObject(resolved) && "schemaFormat" in resolved ? getResolvedRef(resolved.schema) : resolved;
+	return isSchemaObject(schema) ? schema : void 0;
+};
+/** Resolves an AsyncAPI message `payload` into the `SchemaObject` the shared Schema component expects. */
+var getAsyncApiMessagePayloadSchema = (message) => unwrapAsyncApiSchema(message.payload);
+/** Resolves an AsyncAPI message `headers` into the `SchemaObject` the shared Schema component expects. */
+var getAsyncApiMessageHeadersSchema = (message) => unwrapAsyncApiSchema(message.headers);
+//#endregion
+export { getAsyncApiMessageHeadersSchema, getAsyncApiMessagePayloadSchema, unwrapAsyncApiSchema };
+
+//# sourceMappingURL=get-async-api-message-payload-schema.js.map

package/dist/helpers/get-async-api-message-payload-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-async-api-message-payload-schema.js","names":[],"sources":["../../src/helpers/get-async-api-message-payload-schema.ts"],"sourcesContent":["import { isObject } from '@scalar/helpers/object/is-object'\nimport type { AsyncApiMessageObject } from '@scalar/types/asyncapi/3.1'\nimport { getResolvedRef } from '@scalar/workspace-store/helpers/get-resolved-ref'\nimport type { SchemaObject } from '@scalar/workspace-store/schemas/v3.1/strict/openapi-document'\n\n/**\n * A resolved schema-bearing value may be a JSON Schema object, a boolean (`true`/`false`)\n * schema, or a Multi Format Schema wrapper, so accept only plain objects and treat them as the\n * `SchemaObject` the shared Schema/Model rendering expects.\n */\nconst isSchemaObject = (value: unknown): value is SchemaObject => isObject(value)\n\n/**\n * Unwraps an AsyncAPI schema-bearing value into the `SchemaObject` shape the shared OpenAPI\n * `Schema`/`Model` components expect.\n *\n * AsyncAPI reuses JSON Schema, but a value may need extra handling:\n * - The value itself may be a `$ref`; it is resolved to its `$ref-value`.\n * - A Multi Format Schema Object (`schemaFormat` plus a nested `schema`) is unwrapped to its\n *   payload, so we render the inner JSON Schema rather than the wrapper.\n * - Boolean (`true`/`false`) and non-JSON-Schema payloads are skipped.\n */\nexport const unwrapAsyncApiSchema = (value: unknown): SchemaObject | undefined => {\n  if (value === undefined) {\n    return undefined\n  }\n\n  // Resolve the value the same way OpenAPI model rendering does (plain `$ref-value`).\n  const resolved = getResolvedRef(value)\n\n  // Multi Format Schema Objects carry the real schema under `schema`; unwrap to that payload.\n  const schema = isObject(resolved) && 'schemaFormat' in resolved ? getResolvedRef(resolved.schema) : resolved\n\n  return isSchemaObject(schema) ? schema : undefined\n}\n\n/** Resolves an AsyncAPI message `payload` into the `SchemaObject` the shared Schema component expects. */\nexport const getAsyncApiMessagePayloadSchema = (message: AsyncApiMessageObject): SchemaObject | undefined =>\n  unwrapAsyncApiSchema(message.payload)\n\n/** Resolves an AsyncAPI message `headers` into the `SchemaObject` the shared Schema component expects. */\nexport const getAsyncApiMessageHeadersSchema = (message: AsyncApiMessageObject): SchemaObject | undefined =>\n  unwrapAsyncApiSchema(message.headers)\n"],"mappings":";;;;;;;;AAUA,IAAM,kBAAkB,UAA0C,SAAS,MAAM;;;;;;;;;;;AAYjF,IAAa,wBAAwB,UAA6C;AAChF,KAAI,UAAU,KAAA,EACZ;CAIF,MAAM,WAAW,eAAe,MAAM;CAGtC,MAAM,SAAS,SAAS,SAAS,IAAI,kBAAkB,WAAW,eAAe,SAAS,OAAO,GAAG;AAEpG,QAAO,eAAe,OAAO,GAAG,SAAS,KAAA;;;AAI3C,IAAa,mCAAmC,YAC9C,qBAAqB,QAAQ,QAAQ;;AAGvC,IAAa,mCAAmC,YAC9C,qBAAqB,QAAQ,QAAQ"}

package/dist/helpers/get-async-api-model-schema.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"get-async-api-model-schema.d.ts","sourceRoot":"","sources":["../../src/helpers/get-async-api-model-schema.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAA;AAElE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,8DAA8D,CAAA;AAShG;;;;;;;;;;GAUG;AACH,eAAO,MAAM,sBAAsB,GAAI,UAAU,gBAAgB,EAAE,MAAM,MAAM,KAAG,YAAY,GAAG,SAmBhG,CAAA"}
+{"version":3,"file":"get-async-api-model-schema.d.ts","sourceRoot":"","sources":["../../src/helpers/get-async-api-model-schema.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAA;AAElE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,8DAA8D,CAAA;AAIhG;;;;;;;;;;GAUG;AACH,eAAO,MAAM,sBAAsB,GAAI,UAAU,gBAAgB,EAAE,MAAM,MAAM,KAAG,YAAY,GAAG,SAWhG,CAAA"}

package/dist/helpers/get-async-api-model-schema.js

@@ -1,13 +1,7 @@
+import { unwrapAsyncApiSchema } from "./get-async-api-message-payload-schema.js";
 import { getResolvedRef, mergeSiblingReferences } from "@scalar/workspace-store/helpers/get-resolved-ref";
-import { isObject } from "@scalar/helpers/object/is-object";
 //#region src/helpers/get-async-api-model-schema.ts
 /**
-* A resolved `components.schemas` entry may be a JSON Schema object, a boolean (`true`/`false`)
-* schema, or a Multi Format Schema wrapper, so accept only plain objects and treat them as the
-* `SchemaObject` the shared Model rendering and search helpers expect.
-*/
-var isSchemaObject = (value) => isObject(value);
-/**
 * Resolves a named schema from an AsyncAPI document's `components.schemas` into the `SchemaObject`
 * shape the shared OpenAPI Model components and search indexing expect.
 *
@@ -21,10 +15,7 @@ var isSchemaObject = (value) => isObject(value);
 var getAsyncApiModelSchema = (document, name) => {
 	if (!document.components) return;
 	const entry = getResolvedRef(document.components, mergeSiblingReferences).schemas?.[name];
-	if (entry === void 0) return;
-	const resolved = getResolvedRef(entry);
-	const schema = isObject(resolved) && "schemaFormat" in resolved ? getResolvedRef(resolved.schema) : resolved;
-	return isSchemaObject(schema) ? schema : void 0;
+	return unwrapAsyncApiSchema(entry);
 };
 //#endregion
 export { getAsyncApiModelSchema };

package/dist/helpers/get-async-api-model-schema.js.map

@@ -1 +1 @@
-{"version":3,"file":"get-async-api-model-schema.js","names":[],"sources":["../../src/helpers/get-async-api-model-schema.ts"],"sourcesContent":["import { isObject } from '@scalar/helpers/object/is-object'\nimport type { AsyncApiDocument } from '@scalar/types/asyncapi/3.1'\nimport { getResolvedRef, mergeSiblingReferences } from '@scalar/workspace-store/helpers/get-resolved-ref'\nimport type { SchemaObject } from '@scalar/workspace-store/schemas/v3.1/strict/openapi-document'\n\n/**\n * A resolved `components.schemas` entry may be a JSON Schema object, a boolean (`true`/`false`)\n * schema, or a Multi Format Schema wrapper, so accept only plain objects and treat them as the\n * `SchemaObject` the shared Model rendering and search helpers expect.\n */\nconst isSchemaObject = (value: unknown): value is SchemaObject => isObject(value)\n\n/**\n * Resolves a named schema from an AsyncAPI document's `components.schemas` into the `SchemaObject`\n * shape the shared OpenAPI Model components and search indexing expect.\n *\n * AsyncAPI keeps reusable schemas in the same place OpenAPI does, but an entry may need extra handling:\n * - `components` or the schema itself may be a `$ref`; siblings are merged so keys declared alongside\n *   a `$ref` are kept rather than dropped.\n * - A Multi Format Schema Object (`schemaFormat` plus a nested `schema`) is unwrapped to its payload,\n *   so we index and render the inner JSON Schema rather than the wrapper.\n * - Boolean (`true`/`false`) and non-JSON-Schema payloads are skipped.\n */\nexport const getAsyncApiModelSchema = (document: AsyncApiDocument, name: string): SchemaObject | undefined => {\n  if (!document.components) {\n    return undefined\n  }\n\n  // Merge siblings at the components level so schemas declared alongside a `$ref` are kept.\n  const components = getResolvedRef(document.components, mergeSiblingReferences)\n  const entry = components.schemas?.[name]\n  if (entry === undefined) {\n    return undefined\n  }\n\n  // Resolve the schema itself the same way OpenAPI model rendering does (plain `$ref-value`).\n  const resolved = getResolvedRef(entry)\n\n  // Multi Format Schema Objects carry the real schema under `schema`; unwrap to that payload.\n  const schema = isObject(resolved) && 'schemaFormat' in resolved ? getResolvedRef(resolved.schema) : resolved\n\n  return isSchemaObject(schema) ? schema : undefined\n}\n"],"mappings":";;;;;;;;AAUA,IAAM,kBAAkB,UAA0C,SAAS,MAAM;;;;;;;;;;;;AAajF,IAAa,0BAA0B,UAA4B,SAA2C;AAC5G,KAAI,CAAC,SAAS,WACZ;CAKF,MAAM,QADa,eAAe,SAAS,YAAY,uBAAuB,CACrD,UAAU;AACnC,KAAI,UAAU,KAAA,EACZ;CAIF,MAAM,WAAW,eAAe,MAAM;CAGtC,MAAM,SAAS,SAAS,SAAS,IAAI,kBAAkB,WAAW,eAAe,SAAS,OAAO,GAAG;AAEpG,QAAO,eAAe,OAAO,GAAG,SAAS,KAAA"}
+{"version":3,"file":"get-async-api-model-schema.js","names":[],"sources":["../../src/helpers/get-async-api-model-schema.ts"],"sourcesContent":["import type { AsyncApiDocument } from '@scalar/types/asyncapi/3.1'\nimport { getResolvedRef, mergeSiblingReferences } from '@scalar/workspace-store/helpers/get-resolved-ref'\nimport type { SchemaObject } from '@scalar/workspace-store/schemas/v3.1/strict/openapi-document'\n\nimport { unwrapAsyncApiSchema } from './get-async-api-message-payload-schema'\n\n/**\n * Resolves a named schema from an AsyncAPI document's `components.schemas` into the `SchemaObject`\n * shape the shared OpenAPI Model components and search indexing expect.\n *\n * AsyncAPI keeps reusable schemas in the same place OpenAPI does, but an entry may need extra handling:\n * - `components` or the schema itself may be a `$ref`; siblings are merged so keys declared alongside\n *   a `$ref` are kept rather than dropped.\n * - A Multi Format Schema Object (`schemaFormat` plus a nested `schema`) is unwrapped to its payload,\n *   so we index and render the inner JSON Schema rather than the wrapper.\n * - Boolean (`true`/`false`) and non-JSON-Schema payloads are skipped.\n */\nexport const getAsyncApiModelSchema = (document: AsyncApiDocument, name: string): SchemaObject | undefined => {\n  if (!document.components) {\n    return undefined\n  }\n\n  // Merge siblings at the components level so schemas declared alongside a `$ref` are kept.\n  const components = getResolvedRef(document.components, mergeSiblingReferences)\n  const entry = components.schemas?.[name]\n\n  // Resolve `$ref`s and unwrap Multi Format Schema Objects into the plain JSON Schema shape.\n  return unwrapAsyncApiSchema(entry)\n}\n"],"mappings":";;;;;;;;;;;;;;AAiBA,IAAa,0BAA0B,UAA4B,SAA2C;AAC5G,KAAI,CAAC,SAAS,WACZ;CAKF,MAAM,QADa,eAAe,SAAS,YAAY,uBAAuB,CACrD,UAAU;AAGnC,QAAO,qBAAqB,MAAM"}

package/dist/helpers/map-config-plugins.d.ts

@@ -5,9 +5,14 @@ import { type ComputedRef } from 'vue';
 /**
  * Maps API reference configuration callbacks to client plugins.
  *
- * This function transforms the legacy onBeforeRequest and onRequestSent callbacks
- * into the new plugin hook system. The mapping is reactive, so changes to the
- * configuration will automatically update the plugin hooks.
+ * This function transforms the onBeforeRequest, onRequestBuilt, and onRequestSent
+ * callbacks into the new plugin hook system. The mapping is reactive, so changes
+ * to the configuration will automatically update the plugin hooks.
+ *
+ * Note: onRequestBuilt is mapped to the requestBuilt hook so the callback receives
+ * the exact fetch Request that is sent over the wire. Mutating its headers modifies
+ * the outgoing request, and hashing its body produces a hash that matches what the
+ * server receives (a rebuilt multipart body would get a different boundary).
  *
  * Note: onRequestSent is mapped to responseReceived hook. This is not a perfect
  * one-to-one mapping, but it maintains backward compatibility with the old API.

package/dist/helpers/map-config-plugins.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"map-config-plugins.d.ts","sourceRoot":"","sources":["../../src/helpers/map-config-plugins.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAA;AAC7D,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAA;AAE5E,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,2EAA2E,CAAA;AACnH,OAAO,EAAE,KAAK,WAAW,EAAS,MAAM,KAAK,CAAA;AAE7C;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,gBAAgB,GAC3B,QAAQ,WAAW,CAAC,yBAAyB,CAAC,EAC9C,aAAa,WAAW,CAAC,kBAAkB,CAAC,KAC3C,YAAY,EAmDd,CAAA"}
+{"version":3,"file":"map-config-plugins.d.ts","sourceRoot":"","sources":["../../src/helpers/map-config-plugins.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAA;AAC7D,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAA;AAE5E,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,2EAA2E,CAAA;AACnH,OAAO,EAAE,KAAK,WAAW,EAAS,MAAM,KAAK,CAAA;AAE7C;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,gBAAgB,GAC3B,QAAQ,WAAW,CAAC,yBAAyB,CAAC,EAC9C,aAAa,WAAW,CAAC,kBAAkB,CAAC,KAC3C,YAAY,EAuEd,CAAA"}

package/dist/helpers/map-config-plugins.js

@@ -5,9 +5,14 @@ import { buildSafeBodyRequest } from "@scalar/helpers/http/can-method-have-body"
 /**
 * Maps API reference configuration callbacks to client plugins.
 *
-* This function transforms the legacy onBeforeRequest and onRequestSent callbacks
-* into the new plugin hook system. The mapping is reactive, so changes to the
-* configuration will automatically update the plugin hooks.
+* This function transforms the onBeforeRequest, onRequestBuilt, and onRequestSent
+* callbacks into the new plugin hook system. The mapping is reactive, so changes
+* to the configuration will automatically update the plugin hooks.
+*
+* Note: onRequestBuilt is mapped to the requestBuilt hook so the callback receives
+* the exact fetch Request that is sent over the wire. Mutating its headers modifies
+* the outgoing request, and hashing its body produces a hash that matches what the
+* server receives (a rebuilt multipart body would get a different boundary).
 *
 * Note: onRequestSent is mapped to responseReceived hook. This is not a perfect
 * one-to-one mapping, but it maintains backward compatibility with the old API.
@@ -21,9 +26,10 @@ var mapConfigPlugins = (config, environment) => {
 	const plugin = { hooks: {} };
 	watch([
 		() => config.value.onBeforeRequest,
+		() => config.value.onRequestBuilt,
 		() => config.value.onRequestSent,
 		() => environment.value
-	], ([onBeforeRequest, onRequestSent, environment]) => {
+	], ([onBeforeRequest, onRequestBuilt, onRequestSent, environment]) => {
 		const envVariables = getEnvironmentVariables(environment);
 		if (!plugin.hooks) plugin.hooks = {};
 		plugin.hooks.beforeRequest = onBeforeRequest ? async (payload) => {
@@ -42,6 +48,18 @@ var mapConfigPlugins = (config, environment) => {
 			});
 		} : void 0;
 		/**
+		* Maps onRequestBuilt to the requestBuilt hook. The payload request is the
+		* exact fetch Request that will be sent, so header mutations apply and body
+		* hashes match what goes over the wire.
+		*/
+		plugin.hooks.requestBuilt = onRequestBuilt ? async (payload) => {
+			await onRequestBuilt({
+				request: payload.request,
+				requestBuilder: payload.requestBuilder,
+				envVariables
+			});
+		} : void 0;
+		/**
 		* Maps onRequestSent to responseReceived hook.
 		* The old API only passed the URL string, so we extract it from the request.
 		*/

package/dist/helpers/map-config-plugins.js.map

@@ -1 +1 @@
-{"version":3,"file":"map-config-plugins.js","names":[],"sources":["../../src/helpers/map-config-plugins.ts"],"sourcesContent":["import { buildSafeBodyRequest } from '@scalar/helpers/http/can-method-have-body'\nimport type { ClientPlugin } from '@scalar/oas-utils/helpers'\nimport type { ApiReferenceConfiguration } from '@scalar/types/api-reference'\nimport { buildRequest, getEnvironmentVariables } from '@scalar/workspace-store/request-example'\nimport type { XScalarEnvironment } from '@scalar/workspace-store/schemas/extensions/document/x-scalar-environments'\nimport { type ComputedRef, watch } from 'vue'\n\n/**\n * Maps API reference configuration callbacks to client plugins.\n *\n * This function transforms the legacy onBeforeRequest and onRequestSent callbacks\n * into the new plugin hook system. The mapping is reactive, so changes to the\n * configuration will automatically update the plugin hooks.\n *\n * Note: onRequestSent is mapped to responseReceived hook. This is not a perfect\n * one-to-one mapping, but it maintains backward compatibility with the old API.\n * The old callback receives only the URL string, while the new hook receives\n * the full response object.\n *\n * @param config - Reactive configuration object containing optional hook callbacks\n * @returns Array containing a single plugin with the mapped hooks\n */\nexport const mapConfigPlugins = (\n  config: ComputedRef<ApiReferenceConfiguration>,\n  environment: ComputedRef<XScalarEnvironment>,\n): ClientPlugin[] => {\n  // Create a new plugin with the hooks which is going to be updated by the watcher when config changes\n  const plugin: ClientPlugin = { hooks: {} }\n\n  watch(\n    [() => config.value.onBeforeRequest, () => config.value.onRequestSent, () => environment.value],\n    ([onBeforeRequest, onRequestSent, environment]) => {\n      // Get the environment variables for the current environment\n      const envVariables = getEnvironmentVariables(environment)\n\n      // Initialize the hooks object if it doesn't exist\n      if (!plugin.hooks) {\n        plugin.hooks = {}\n      }\n\n      plugin.hooks.beforeRequest = onBeforeRequest\n        ? async (payload) => {\n            const built = buildRequest(payload.requestBuilder, {\n              envVariables,\n              allowMissingRequestServerBase: true,\n            })\n            if (!built.ok) {\n              console.error(\n                '[@scalar/api-reference] onBeforeRequest was not run because the request could not be built:',\n                built.message ?? built.error,\n              )\n              return\n            }\n            await onBeforeRequest({\n              // We need to build the request to get the fetch `Request`\n              request: buildSafeBodyRequest(...built.data.requestPayload),\n              requestBuilder: payload.requestBuilder,\n              envVariables,\n            })\n          }\n        : undefined\n\n      /**\n       * Maps onRequestSent to responseReceived hook.\n       * The old API only passed the URL string, so we extract it from the request.\n       */\n      plugin.hooks.responseReceived = onRequestSent\n        ? (payload) => {\n            onRequestSent(payload.request.url)\n          }\n        : undefined\n    },\n    { immediate: true },\n  )\n\n  return [plugin]\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;AAsBA,IAAa,oBACX,QACA,gBACmB;CAEnB,MAAM,SAAuB,EAAE,OAAO,EAAE,EAAE;AAE1C,OACE;QAAO,OAAO,MAAM;QAAuB,OAAO,MAAM;QAAqB,YAAY;EAAM,GAC9F,CAAC,iBAAiB,eAAe,iBAAiB;EAEjD,MAAM,eAAe,wBAAwB,YAAY;AAGzD,MAAI,CAAC,OAAO,MACV,QAAO,QAAQ,EAAE;AAGnB,SAAO,MAAM,gBAAgB,kBACzB,OAAO,YAAY;GACjB,MAAM,QAAQ,aAAa,QAAQ,gBAAgB;IACjD;IACA,+BAA+B;IAChC,CAAC;AACF,OAAI,CAAC,MAAM,IAAI;AACb,YAAQ,MACN,+FACA,MAAM,WAAW,MAAM,MACxB;AACD;;AAEF,SAAM,gBAAgB;IAEpB,SAAS,qBAAqB,GAAG,MAAM,KAAK,eAAe;IAC3D,gBAAgB,QAAQ;IACxB;IACD,CAAC;MAEJ,KAAA;;;;;AAMJ,SAAO,MAAM,mBAAmB,iBAC3B,YAAY;AACX,iBAAc,QAAQ,QAAQ,IAAI;MAEpC,KAAA;IAEN,EAAE,WAAW,MAAM,CACpB;AAED,QAAO,CAAC,OAAO"}
+{"version":3,"file":"map-config-plugins.js","names":[],"sources":["../../src/helpers/map-config-plugins.ts"],"sourcesContent":["import { buildSafeBodyRequest } from '@scalar/helpers/http/can-method-have-body'\nimport type { ClientPlugin } from '@scalar/oas-utils/helpers'\nimport type { ApiReferenceConfiguration } from '@scalar/types/api-reference'\nimport { buildRequest, getEnvironmentVariables } from '@scalar/workspace-store/request-example'\nimport type { XScalarEnvironment } from '@scalar/workspace-store/schemas/extensions/document/x-scalar-environments'\nimport { type ComputedRef, watch } from 'vue'\n\n/**\n * Maps API reference configuration callbacks to client plugins.\n *\n * This function transforms the onBeforeRequest, onRequestBuilt, and onRequestSent\n * callbacks into the new plugin hook system. The mapping is reactive, so changes\n * to the configuration will automatically update the plugin hooks.\n *\n * Note: onRequestBuilt is mapped to the requestBuilt hook so the callback receives\n * the exact fetch Request that is sent over the wire. Mutating its headers modifies\n * the outgoing request, and hashing its body produces a hash that matches what the\n * server receives (a rebuilt multipart body would get a different boundary).\n *\n * Note: onRequestSent is mapped to responseReceived hook. This is not a perfect\n * one-to-one mapping, but it maintains backward compatibility with the old API.\n * The old callback receives only the URL string, while the new hook receives\n * the full response object.\n *\n * @param config - Reactive configuration object containing optional hook callbacks\n * @returns Array containing a single plugin with the mapped hooks\n */\nexport const mapConfigPlugins = (\n  config: ComputedRef<ApiReferenceConfiguration>,\n  environment: ComputedRef<XScalarEnvironment>,\n): ClientPlugin[] => {\n  // Create a new plugin with the hooks which is going to be updated by the watcher when config changes\n  const plugin: ClientPlugin = { hooks: {} }\n\n  watch(\n    [\n      () => config.value.onBeforeRequest,\n      () => config.value.onRequestBuilt,\n      () => config.value.onRequestSent,\n      () => environment.value,\n    ],\n    ([onBeforeRequest, onRequestBuilt, onRequestSent, environment]) => {\n      // Get the environment variables for the current environment\n      const envVariables = getEnvironmentVariables(environment)\n\n      // Initialize the hooks object if it doesn't exist\n      if (!plugin.hooks) {\n        plugin.hooks = {}\n      }\n\n      plugin.hooks.beforeRequest = onBeforeRequest\n        ? async (payload) => {\n            const built = buildRequest(payload.requestBuilder, {\n              envVariables,\n              allowMissingRequestServerBase: true,\n            })\n            if (!built.ok) {\n              console.error(\n                '[@scalar/api-reference] onBeforeRequest was not run because the request could not be built:',\n                built.message ?? built.error,\n              )\n              return\n            }\n            await onBeforeRequest({\n              // We need to build the request to get the fetch `Request`\n              request: buildSafeBodyRequest(...built.data.requestPayload),\n              requestBuilder: payload.requestBuilder,\n              envVariables,\n            })\n          }\n        : undefined\n\n      /**\n       * Maps onRequestBuilt to the requestBuilt hook. The payload request is the\n       * exact fetch Request that will be sent, so header mutations apply and body\n       * hashes match what goes over the wire.\n       */\n      plugin.hooks.requestBuilt = onRequestBuilt\n        ? async (payload) => {\n            await onRequestBuilt({\n              request: payload.request,\n              requestBuilder: payload.requestBuilder,\n              envVariables,\n            })\n          }\n        : undefined\n\n      /**\n       * Maps onRequestSent to responseReceived hook.\n       * The old API only passed the URL string, so we extract it from the request.\n       */\n      plugin.hooks.responseReceived = onRequestSent\n        ? (payload) => {\n            onRequestSent(payload.request.url)\n          }\n        : undefined\n    },\n    { immediate: true },\n  )\n\n  return [plugin]\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;AA2BA,IAAa,oBACX,QACA,gBACmB;CAEnB,MAAM,SAAuB,EAAE,OAAO,EAAE,EAAE;AAE1C,OACE;QACQ,OAAO,MAAM;QACb,OAAO,MAAM;QACb,OAAO,MAAM;QACb,YAAY;EACnB,GACA,CAAC,iBAAiB,gBAAgB,eAAe,iBAAiB;EAEjE,MAAM,eAAe,wBAAwB,YAAY;AAGzD,MAAI,CAAC,OAAO,MACV,QAAO,QAAQ,EAAE;AAGnB,SAAO,MAAM,gBAAgB,kBACzB,OAAO,YAAY;GACjB,MAAM,QAAQ,aAAa,QAAQ,gBAAgB;IACjD;IACA,+BAA+B;IAChC,CAAC;AACF,OAAI,CAAC,MAAM,IAAI;AACb,YAAQ,MACN,+FACA,MAAM,WAAW,MAAM,MACxB;AACD;;AAEF,SAAM,gBAAgB;IAEpB,SAAS,qBAAqB,GAAG,MAAM,KAAK,eAAe;IAC3D,gBAAgB,QAAQ;IACxB;IACD,CAAC;MAEJ,KAAA;;;;;;AAOJ,SAAO,MAAM,eAAe,iBACxB,OAAO,YAAY;AACjB,SAAM,eAAe;IACnB,SAAS,QAAQ;IACjB,gBAAgB,QAAQ;IACxB;IACD,CAAC;MAEJ,KAAA;;;;;AAMJ,SAAO,MAAM,mBAAmB,iBAC3B,YAAY;AACX,iBAAc,QAAQ,QAAQ,IAAI;MAEpC,KAAA;IAEN,EAAE,WAAW,MAAM,CACpB;AAED,QAAO,CAAC,OAAO"}