@scalar/api-reference 1.62.4 → 1.62.6

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # @scalar/api-reference
 
+## 1.62.6
+
+### Patch Changes
+
+- [#9618](https://github.com/scalar/scalar/pull/9618): Render document-wide authentication for AsyncAPI documents. The introduction now shows the same Authentication selector used for OpenAPI, populated from `components.securitySchemes`, with requirements derived from the union of every server's `security` (AsyncAPI has no root-level `security`). When some servers require auth and others accept unauthenticated connections, a no-auth option is offered too. Schemes shared with OpenAPI (`http`, `oauth2`, `openIdConnect`, `apiKey`) get full input UI, and AsyncAPI OAuth2 `availableScopes` are mapped onto OpenAPI `scopes` so the scope list renders. Broker-specific types still appear in the selector but have no dedicated input yet. The selector is now fully interactive for AsyncAPI (selecting schemes, entering credentials, editing scopes) because the auth mutators accept AsyncAPI documents. Operation/channel-level auth is intentionally left for a follow-up.
+- [#9618](https://github.com/scalar/scalar/pull/9618): Name the actual document type in the "security scheme is missing a type" warning. When a scheme has no recognizable type, the auth selector previously always told users to check their "OpenAPI document", even for AsyncAPI documents. The warning now reflects the document it belongs to (e.g. "AsyncAPI") via a new optional `documentType` prop on the auth selector block, defaulting to `openapi`. Schemes that carry a valid but unsupported type (such as AsyncAPI broker types like `userPassword` or `scramSha256`) now show a dedicated "not supported yet" message naming the type, instead of the misleading "missing a type" warning.
+- [#9679](https://github.com/scalar/scalar/pull/9679): Fix the plugin `auth` accessor reading from the wrong store. It now reads from the client store — the same store the reference-side Authentication panel writes credentials into — so plugins see the secrets and selected security schemes the user actually entered instead of an empty state.
+
+## 1.62.5
+
+### Patch Changes
+
+- [#9671](https://github.com/scalar/scalar/pull/9671): Add a `canDeleteSchemes` prop to the auth selector so the delete (trash) affordance can be hidden. It defaults to `true` (unchanged for the API client, where schemes are editable) and the API reference now passes `false`, since its schemes come from the rendered document and cannot be removed there.
+- [#9646](https://github.com/scalar/scalar/pull/9646): Fix deep links to response properties. Response property anchors now carry a `responses` marker so the target operation is found and scrolled to on a fresh load, and response properties are linkable even when `expandAllResponses` is off (a deep link expands the collapsed response and scrolls the property into view).
+- [#9631](https://github.com/scalar/scalar/pull/9631): Hide the protocol and server filters in the classic layout for AsyncAPI documents
+- [#9639](https://github.com/scalar/scalar/pull/9639): Add a read-only accessor for the global authentication state to the plugin API. Plugin lifecycle hooks (`onInit`, `onConfigChange`) now receive an `auth` accessor alongside `config`, and the plugin manager exposes `getAuthState()` for view components. Plugins can read stored secrets and the selected security schemes via `auth.export()`, `auth.getAuthSecrets(documentName, schemeName)`, and `auth.getAuthSelectedSchemas(payload)` without being able to mutate auth.
+- [#9664](https://github.com/scalar/scalar/pull/9664): fix: keep base allOf properties when merging oneOf/anyOf branches
+
+  When a schema used `allOf` to factor out shared object properties next to a `oneOf`/`anyOf`, each branch's own `properties`/`required` overwrote the shared base fields instead of being combined with them. The base fields now stay visible alongside each branch's own fields.
+
 ## 1.62.4
 
 ## 1.62.3

package/README.md

@@ -8,6 +8,20 @@
 
 Interactive API Reference from OpenAPI/Swagger Documents [Try our Demo](https://docs.scalar.com/swagger-editor)
 
+---
+
+Scalar is an open-source API platform for teams who want beautiful developer interfaces without vendor lock-in.
+
+- **[API References](https://scalar.com/products/api-references/getting-started)** — Interactive API documentation from OpenAPI and AsyncAPI specs.
+- **[Docs](https://scalar.com/products/docs/getting-started)** — Write in Markdown/MDX, generate API references, sync with two-way Git.
+- **[SDKs](https://scalar.com/products/sdks/getting-started)** — Type-safe client libraries in TypeScript, Python, Go, PHP, Java, and Ruby.
+- **[MCP Servers](https://scalar.com/products/agent/getting-started)** — Generate secure MCP servers from your API spec.
+- **[API Client](https://scalar.com/products/api-client/getting-started)** — Open-source, offline-first Postman alternative built on OpenAPI.
+
+20M+ monthly npm installs · 15,500+ GitHub stars · MIT licensed · [scalar.com](https://scalar.com)
+
+---
+
 [![Screenshot of an API Reference](https://github.com/scalar/scalar/assets/6201407/d8beb5e1-bf64-4589-8cb0-992ba79215a8)](https://docs.scalar.com/swagger-editor)
 
 ### CDN

package/dist/blocks/scalar-info-block/components/SpecificationVersion.vue.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SpecificationVersion.vue.d.ts","sourceRoot":"","sources":["../../../../src/blocks/scalar-info-block/components/SpecificationVersion.vue"],"names":[],"mappings":"AA2BA,KAAK,WAAW,GAAG;IACjB,oEAAoE;IACpE,YAAY,CAAC,EAAE,SAAS,GAAG,UAAU,CAAA;IACrC,2FAA2F;IAC3F,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB,CAAC;AA+CF,QAAA,MAAM,YAAY,kSAEhB,CAAC;wBACkB,OAAO,YAAY;AAAxC,wBAAyC"}
+{"version":3,"file":"SpecificationVersion.vue.d.ts","sourceRoot":"","sources":["../../../../src/blocks/scalar-info-block/components/SpecificationVersion.vue"],"names":[],"mappings":"AA2BA,KAAK,WAAW,GAAG;IACjB,oEAAoE;IACpE,YAAY,CAAC,EAAE,SAAS,GAAG,UAAU,CAAA;IACrC,2FAA2F;IAC3F,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB,CAAC;AA6CF,QAAA,MAAM,YAAY,kSAEhB,CAAC;wBACkB,OAAO,YAAY;AAAxC,wBAAyC"}

package/dist/blocks/scalar-info-block/components/SpecificationVersion.vue.js.map

@@ -1 +1 @@
-{"version":3,"file":"SpecificationVersion.vue.js","names":[],"sources":["../../../../src/blocks/scalar-info-block/components/SpecificationVersion.vue"],"sourcesContent":["<script setup lang=\"ts\">\nimport { computed } from 'vue'\n\nimport { Badge } from '@/components/Badge'\n\nconst { documentType = 'openapi', version } = defineProps<{\n  /** The kind of document being described. Drives the badge label. */\n  documentType?: 'openapi' | 'asyncapi'\n  /** The original specification version (e.g. \"3.1.0\" for OpenAPI, \"3.0.0\" for AsyncAPI). */\n  version?: string\n}>()\n\nconst label = computed(() =>\n  documentType === 'asyncapi' ? 'AsyncAPI' : 'OpenAPI',\n)\n</script>\n\n<template>\n  <Badge v-if=\"version\">{{ label }} {{ version }}</Badge>\n</template>\n"],"mappings":""}
+{"version":3,"file":"SpecificationVersion.vue.js","names":[],"sources":["../../../../src/blocks/scalar-info-block/components/SpecificationVersion.vue"],"sourcesContent":["<script setup lang=\"ts\">\nimport { getDocumentTypeLabel } from '@scalar/workspace-store/schemas/type-guards'\nimport { computed } from 'vue'\n\nimport { Badge } from '@/components/Badge'\n\nconst { documentType = 'openapi', version } = defineProps<{\n  /** The kind of document being described. Drives the badge label. */\n  documentType?: 'openapi' | 'asyncapi'\n  /** The original specification version (e.g. \"3.1.0\" for OpenAPI, \"3.0.0\" for AsyncAPI). */\n  version?: string\n}>()\n\nconst label = computed(() => getDocumentTypeLabel(documentType))\n</script>\n\n<template>\n  <Badge v-if=\"version\">{{ label }} {{ version }}</Badge>\n</template>\n"],"mappings":""}

package/dist/blocks/scalar-info-block/components/SpecificationVersion.vue.script.js

@@ -1,5 +1,6 @@
 import Badge_default from "../../../components/Badge/Badge.vue.js";
 import { computed, createBlock, createCommentVNode, createTextVNode, defineComponent, openBlock, toDisplayString, unref, withCtx } from "vue";
+import { getDocumentTypeLabel } from "@scalar/workspace-store/schemas/type-guards";
 //#region src/blocks/scalar-info-block/components/SpecificationVersion.vue?vue&type=script&setup=true&lang.ts
 var SpecificationVersion_vue_vue_type_script_setup_true_lang_default = /* @__PURE__ */ defineComponent({
 	__name: "SpecificationVersion",
@@ -8,7 +9,7 @@ var SpecificationVersion_vue_vue_type_script_setup_true_lang_default = /* @__PUR
 		version: {}
 	},
 	setup(__props) {
-		const label = computed(() => __props.documentType === "asyncapi" ? "AsyncAPI" : "OpenAPI");
+		const label = computed(() => getDocumentTypeLabel(__props.documentType));
 		return (_ctx, _cache) => {
 			return __props.version ? (openBlock(), createBlock(unref(Badge_default), { key: 0 }, {
 				default: withCtx(() => [createTextVNode(toDisplayString(label.value) + " " + toDisplayString(__props.version), 1)]),

package/dist/blocks/scalar-info-block/components/SpecificationVersion.vue.script.js.map

@@ -1 +1 @@
-{"version":3,"file":"SpecificationVersion.vue.script.js","names":[],"sources":["../../../../src/blocks/scalar-info-block/components/SpecificationVersion.vue"],"sourcesContent":["<script setup lang=\"ts\">\nimport { computed } from 'vue'\n\nimport { Badge } from '@/components/Badge'\n\nconst { documentType = 'openapi', version } = defineProps<{\n  /** The kind of document being described. Drives the badge label. */\n  documentType?: 'openapi' | 'asyncapi'\n  /** The original specification version (e.g. \"3.1.0\" for OpenAPI, \"3.0.0\" for AsyncAPI). */\n  version?: string\n}>()\n\nconst label = computed(() =>\n  documentType === 'asyncapi' ? 'AsyncAPI' : 'OpenAPI',\n)\n</script>\n\n<template>\n  <Badge v-if=\"version\">{{ label }} {{ version }}</Badge>\n</template>\n"],"mappings":";;;;;;;;;;EAYA,MAAM,QAAQ,eACZ,QAAA,iBAAiB,aAAa,aAAa,UAC7C;;UAIe,QAAA,WAAA,WAAA,EAAb,YAAuD,MAAA,cAAA,EAAA,EAAA,KAAA,GAAA,EAAA;2BAAtB,CAAA,gBAAA,gBAAR,MAAA,MAAK,GAAG,MAAC,gBAAG,QAAA,QAAO,EAAA,EAAA,CAAA,CAAA"}
+{"version":3,"file":"SpecificationVersion.vue.script.js","names":[],"sources":["../../../../src/blocks/scalar-info-block/components/SpecificationVersion.vue"],"sourcesContent":["<script setup lang=\"ts\">\nimport { getDocumentTypeLabel } from '@scalar/workspace-store/schemas/type-guards'\nimport { computed } from 'vue'\n\nimport { Badge } from '@/components/Badge'\n\nconst { documentType = 'openapi', version } = defineProps<{\n  /** The kind of document being described. Drives the badge label. */\n  documentType?: 'openapi' | 'asyncapi'\n  /** The original specification version (e.g. \"3.1.0\" for OpenAPI, \"3.0.0\" for AsyncAPI). */\n  version?: string\n}>()\n\nconst label = computed(() => getDocumentTypeLabel(documentType))\n</script>\n\n<template>\n  <Badge v-if=\"version\">{{ label }} {{ version }}</Badge>\n</template>\n"],"mappings":";;;;;;;;;;;EAaA,MAAM,QAAQ,eAAe,qBAAqB,QAAA,aAAa,CAAA;;UAIhD,QAAA,WAAA,WAAA,EAAb,YAAuD,MAAA,cAAA,EAAA,EAAA,KAAA,GAAA,EAAA;2BAAtB,CAAA,gBAAA,gBAAR,MAAA,MAAK,GAAG,MAAC,gBAAG,QAAA,QAAO,EAAA,EAAA,CAAA,CAAA"}