@scalar/schemas 0.3.0 → 0.3.2

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # @scalar/schemas
 
+## 0.3.2
+
+### Patch Changes
+
+- [#9313](https://github.com/scalar/scalar/pull/9313): feat: add AsyncAPI connection URL builder and server list helpers
+
+## 0.3.1
+
+### Patch Changes
+
+- [#9311](https://github.com/scalar/scalar/pull/9311): feat: add typed AsyncAPI WebSocket binding schema
+  - Add `asyncApiWsBindingObject` for `bindings.ws` with `method`, `query`, `headers`, and `bindingVersion`
+  - Add `asyncApiSchemaObjectOrReference` (Schema Object | Reference Object) for WebSocket binding fields that exclude Multi Format Schema Object
+  - Regenerate `@scalar/types/asyncapi/3.1` types
+
 ## 0.3.0
 
 ### Minor Changes

package/dist/asyncapi/3.1/asyncapi-object.d.ts

@@ -46,5 +46,7 @@ export declare const asyncApiObjectSchema: import("@scalar/validation").Intersec
         conflictCheckedAgainstHash: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
         hasConflict: import("@scalar/validation").OptionalSchema<import("@scalar/validation").BooleanSchema>;
     }>>;
+}>, import("@scalar/validation").ObjectSchema<{
+    'x-scalar-selected-server': import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
 }>]>]>;
 //# sourceMappingURL=asyncapi-object.d.ts.map

package/dist/asyncapi/3.1/asyncapi-object.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"asyncapi-object.d.ts","sourceRoot":"","sources":["../../../src/asyncapi/3.1/asyncapi-object.ts"],"names":[],"mappings":"AA8DA;;;;GAIG;AACH,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MAG/B,CAAA"}
+{"version":3,"file":"asyncapi-object.d.ts","sourceRoot":"","sources":["../../../src/asyncapi/3.1/asyncapi-object.ts"],"names":[],"mappings":"AAgEA;;;;GAIG;AACH,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MAG/B,CAAA"}

package/dist/asyncapi/3.1/asyncapi-object.js

@@ -1,5 +1,6 @@
 import { intersection, object, optional, string } from '@scalar/validation';
 import { XOriginalAasVersion, XScalarIsDirty, XScalarNavigation, XScalarOriginalDocumentHash, XScalarOriginalSourceUrl, XScalarRegistryMeta, XScalarWatchMode, } from '../../extensions/document/index.js';
+import { XScalarSelectedServer } from '../../extensions/server/index.js';
 import { asyncApiChannelsObject } from './channel.js';
 import { asyncApiComponentsObject } from './components.js';
 import { asyncApiInfoObject } from './info.js';
@@ -14,6 +15,7 @@ const asyncApiExtensions = intersection([
     XScalarIsDirty,
     XScalarWatchMode,
     XScalarRegistryMeta,
+    XScalarSelectedServer,
 ], {
     typeName: 'AsyncApiExtensions',
     typeComment: 'AsyncAPI document-level Scalar extensions shared with workspace tooling.',

package/dist/asyncapi/3.1/bindings.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"bindings.d.ts","sourceRoot":"","sources":["../../../src/asyncapi/3.1/bindings.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,MAAM,EAA6B,MAAM,oBAAoB,CAAA;AA+C3E,eAAO,MAAM,4BAA4B,mEAGxC,CAAA;AAED,eAAO,MAAM,6BAA6B,mEAGzC,CAAA;AAED,eAAO,MAAM,+BAA+B,mEAG3C,CAAA;AAED,eAAO,MAAM,6BAA6B,mEAGzC,CAAA"}
+{"version":3,"file":"bindings.d.ts","sourceRoot":"","sources":["../../../src/asyncapi/3.1/bindings.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,MAAM,EAA6B,MAAM,oBAAoB,CAAA;AAiD3E,eAAO,MAAM,4BAA4B,mEAGxC,CAAA;AAED,eAAO,MAAM,6BAA6B,mEAGzC,CAAA;AAED,eAAO,MAAM,+BAA+B,mEAG3C,CAAA;AAED,eAAO,MAAM,6BAA6B,mEAGzC,CAAA"}

package/dist/asyncapi/3.1/bindings.js

@@ -1,4 +1,5 @@
 import { object, optional, unknown } from '@scalar/validation';
+import { asyncApiWsBindingObject } from './ws-binding.js';
 /**
  * Protocol keys listed for binding objects in AsyncAPI 3.1.0. Values are
  * protocol-specific; we accept any JSON-compatible structure.
@@ -31,7 +32,7 @@ const optionalBindingPayload = () => optional(unknown({
 const bindingObjectProperties = () => {
     const properties = {};
     for (const key of ASYNCAPI_3_1_BINDING_PROTOCOL_KEYS) {
-        properties[key] = optionalBindingPayload();
+        properties[key] = key === 'ws' ? optional(asyncApiWsBindingObject) : optionalBindingPayload();
     }
     return properties;
 };

package/dist/asyncapi/3.1/index.d.ts

@@ -18,9 +18,10 @@ export { asyncApiOperationTraitObject } from './operation-trait.js';
 export { asyncApiParameterObject } from './parameter.js';
 export { asyncApiParametersObject } from './parameters.js';
 export { type MaybeRefFn, asyncApiReferenceObject, asyncApiResolvedReference, recursiveRef, } from './reference.js';
-export { asyncApiMultiFormatSchemaObject, asyncApiSchemaPayload } from './schema-payload.js';
+export { asyncApiMultiFormatSchemaObject, asyncApiSchemaObjectOrReference, asyncApiSchemaPayload, } from './schema-payload.js';
 export { asyncApiSecuritySchemeObject } from './security-scheme.js';
 export { asyncApiServerObject, asyncApiServersObject } from './server.js';
 export { asyncApiServerVariableObject } from './server-variable.js';
 export { asyncApiTagObject, asyncApiTagsObject } from './tag.js';
+export { asyncApiWsBindingObject } from './ws-binding.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/asyncapi/3.1/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/asyncapi/3.1/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,mBAAmB,CAAA;AACxD,OAAO,EACL,6BAA6B,EAC7B,6BAA6B,EAC7B,+BAA+B,EAC/B,4BAA4B,GAC7B,MAAM,YAAY,CAAA;AACnB,OAAO,EAAE,qBAAqB,EAAE,sBAAsB,EAAE,MAAM,WAAW,CAAA;AACzE,OAAO,EAAE,wBAAwB,EAAE,MAAM,cAAc,CAAA;AACvD,OAAO,EAAE,qBAAqB,EAAE,MAAM,WAAW,CAAA;AACjD,OAAO,EAAE,2BAA2B,EAAE,MAAM,kBAAkB,CAAA;AAC9D,OAAO,EAAE,mCAAmC,EAAE,MAAM,0BAA0B,CAAA;AAC9E,OAAO,EAAE,kBAAkB,EAAE,MAAM,QAAQ,CAAA;AAC3C,OAAO,EAAE,qBAAqB,EAAE,MAAM,WAAW,CAAA;AACjD,OAAO,EAAE,qBAAqB,EAAE,sBAAsB,EAAE,MAAM,WAAW,CAAA;AACzE,OAAO,EAAE,4BAA4B,EAAE,MAAM,mBAAmB,CAAA;AAChE,OAAO,EAAE,0BAA0B,EAAE,MAAM,iBAAiB,CAAA;AAC5D,OAAO,EAAE,uBAAuB,EAAE,wBAAwB,EAAE,MAAM,SAAS,CAAA;AAC3E,OAAO,EAAE,uBAAuB,EAAE,wBAAwB,EAAE,MAAM,aAAa,CAAA;AAC/E,OAAO,EAAE,4BAA4B,EAAE,MAAM,mBAAmB,CAAA;AAChE,OAAO,EAAE,mCAAmC,EAAE,MAAM,2BAA2B,CAAA;AAC/E,OAAO,EAAE,4BAA4B,EAAE,MAAM,mBAAmB,CAAA;AAChE,OAAO,EAAE,uBAAuB,EAAE,MAAM,aAAa,CAAA;AACrD,OAAO,EAAE,wBAAwB,EAAE,MAAM,cAAc,CAAA;AACvD,OAAO,EACL,KAAK,UAAU,EACf,uBAAuB,EACvB,yBAAyB,EACzB,YAAY,GACb,MAAM,aAAa,CAAA;AACpB,OAAO,EAAE,+BAA+B,EAAE,qBAAqB,EAAE,MAAM,kBAAkB,CAAA;AACzF,OAAO,EAAE,4BAA4B,EAAE,MAAM,mBAAmB,CAAA;AAChE,OAAO,EAAE,oBAAoB,EAAE,qBAAqB,EAAE,MAAM,UAAU,CAAA;AACtE,OAAO,EAAE,4BAA4B,EAAE,MAAM,mBAAmB,CAAA;AAChE,OAAO,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,MAAM,OAAO,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/asyncapi/3.1/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,mBAAmB,CAAA;AACxD,OAAO,EACL,6BAA6B,EAC7B,6BAA6B,EAC7B,+BAA+B,EAC/B,4BAA4B,GAC7B,MAAM,YAAY,CAAA;AACnB,OAAO,EAAE,qBAAqB,EAAE,sBAAsB,EAAE,MAAM,WAAW,CAAA;AACzE,OAAO,EAAE,wBAAwB,EAAE,MAAM,cAAc,CAAA;AACvD,OAAO,EAAE,qBAAqB,EAAE,MAAM,WAAW,CAAA;AACjD,OAAO,EAAE,2BAA2B,EAAE,MAAM,kBAAkB,CAAA;AAC9D,OAAO,EAAE,mCAAmC,EAAE,MAAM,0BAA0B,CAAA;AAC9E,OAAO,EAAE,kBAAkB,EAAE,MAAM,QAAQ,CAAA;AAC3C,OAAO,EAAE,qBAAqB,EAAE,MAAM,WAAW,CAAA;AACjD,OAAO,EAAE,qBAAqB,EAAE,sBAAsB,EAAE,MAAM,WAAW,CAAA;AACzE,OAAO,EAAE,4BAA4B,EAAE,MAAM,mBAAmB,CAAA;AAChE,OAAO,EAAE,0BAA0B,EAAE,MAAM,iBAAiB,CAAA;AAC5D,OAAO,EAAE,uBAAuB,EAAE,wBAAwB,EAAE,MAAM,SAAS,CAAA;AAC3E,OAAO,EAAE,uBAAuB,EAAE,wBAAwB,EAAE,MAAM,aAAa,CAAA;AAC/E,OAAO,EAAE,4BAA4B,EAAE,MAAM,mBAAmB,CAAA;AAChE,OAAO,EAAE,mCAAmC,EAAE,MAAM,2BAA2B,CAAA;AAC/E,OAAO,EAAE,4BAA4B,EAAE,MAAM,mBAAmB,CAAA;AAChE,OAAO,EAAE,uBAAuB,EAAE,MAAM,aAAa,CAAA;AACrD,OAAO,EAAE,wBAAwB,EAAE,MAAM,cAAc,CAAA;AACvD,OAAO,EACL,KAAK,UAAU,EACf,uBAAuB,EACvB,yBAAyB,EACzB,YAAY,GACb,MAAM,aAAa,CAAA;AACpB,OAAO,EACL,+BAA+B,EAC/B,+BAA+B,EAC/B,qBAAqB,GACtB,MAAM,kBAAkB,CAAA;AACzB,OAAO,EAAE,4BAA4B,EAAE,MAAM,mBAAmB,CAAA;AAChE,OAAO,EAAE,oBAAoB,EAAE,qBAAqB,EAAE,MAAM,UAAU,CAAA;AACtE,OAAO,EAAE,4BAA4B,EAAE,MAAM,mBAAmB,CAAA;AAChE,OAAO,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,MAAM,OAAO,CAAA;AAC7D,OAAO,EAAE,uBAAuB,EAAE,MAAM,cAAc,CAAA"}

package/dist/asyncapi/3.1/index.js

@@ -18,8 +18,9 @@ export { asyncApiOperationTraitObject } from './operation-trait.js';
 export { asyncApiParameterObject } from './parameter.js';
 export { asyncApiParametersObject } from './parameters.js';
 export { asyncApiReferenceObject, asyncApiResolvedReference, recursiveRef, } from './reference.js';
-export { asyncApiMultiFormatSchemaObject, asyncApiSchemaPayload } from './schema-payload.js';
+export { asyncApiMultiFormatSchemaObject, asyncApiSchemaObjectOrReference, asyncApiSchemaPayload, } from './schema-payload.js';
 export { asyncApiSecuritySchemeObject } from './security-scheme.js';
 export { asyncApiServerObject, asyncApiServersObject } from './server.js';
 export { asyncApiServerVariableObject } from './server-variable.js';
 export { asyncApiTagObject, asyncApiTagsObject } from './tag.js';
+export { asyncApiWsBindingObject } from './ws-binding.js';

package/dist/asyncapi/3.1/schema-payload.d.ts

@@ -2,6 +2,8 @@ export declare const asyncApiMultiFormatSchemaObject: import("@scalar/validation
     schemaFormat: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
     schema: import("@scalar/validation").UnknownSchema;
 }>;
+/** Schema Object | Reference Object */
+export declare const asyncApiSchemaObjectOrReference: import("@scalar/validation").Schema;
 /** Multi Format Schema Object | Schema Object | Reference Object */
 export declare const asyncApiSchemaPayload: import("@scalar/validation").Schema;
 //# sourceMappingURL=schema-payload.d.ts.map

package/dist/asyncapi/3.1/schema-payload.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"schema-payload.d.ts","sourceRoot":"","sources":["../../../src/asyncapi/3.1/schema-payload.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,+BAA+B;;;EAa3C,CAAA;AAcD,oEAAoE;AACpE,eAAO,MAAM,qBAAqB,qCAIjC,CAAA"}
+{"version":3,"file":"schema-payload.d.ts","sourceRoot":"","sources":["../../../src/asyncapi/3.1/schema-payload.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,+BAA+B;;;EAa3C,CAAA;AAcD,uCAAuC;AACvC,eAAO,MAAM,+BAA+B,qCAAwC,CAAA;AAEpF,oEAAoE;AACpE,eAAO,MAAM,qBAAqB,qCAIjC,CAAA"}

package/dist/asyncapi/3.1/schema-payload.js

@@ -16,6 +16,8 @@ const asyncApiSchemaJsonShape = union([
         typeComment: 'JSON Schema Draft 07 compatible schema (boolean true/false or object); see AsyncAPI Schema Object.',
     }),
 ], { typeName: 'AsyncApiSchemaJsonShape' });
+/** Schema Object | Reference Object */
+export const asyncApiSchemaObjectOrReference = recursiveRef(asyncApiSchemaJsonShape);
 /** Multi Format Schema Object | Schema Object | Reference Object */
 export const asyncApiSchemaPayload = recursiveRef(union([asyncApiMultiFormatSchemaObject, asyncApiSchemaJsonShape], {
     typeName: 'AsyncApiMultiFormatSchemaOrSchemaObject',

package/dist/asyncapi/3.1/ws-binding.d.ts

@@ -0,0 +1,12 @@
+/**
+ * AsyncAPI WebSocket binding (channel / operation / server).
+ *
+ * @see https://github.com/asyncapi/bindings/tree/master/websockets
+ */
+export declare const asyncApiWsBindingObject: import("@scalar/validation").ObjectSchema<{
+    method: import("@scalar/validation").OptionalSchema<import("@scalar/validation").UnionSchema<readonly [import("@scalar/validation").LiteralSchema<"GET">, import("@scalar/validation").LiteralSchema<"POST">]>>;
+    query: import("@scalar/validation").OptionalSchema<import("@scalar/validation").Schema>;
+    headers: import("@scalar/validation").OptionalSchema<import("@scalar/validation").Schema>;
+    bindingVersion: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
+}>;
+//# sourceMappingURL=ws-binding.d.ts.map

package/dist/asyncapi/3.1/ws-binding.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ws-binding.d.ts","sourceRoot":"","sources":["../../../src/asyncapi/3.1/ws-binding.ts"],"names":[],"mappings":"AAIA;;;;GAIG;AACH,eAAO,MAAM,uBAAuB;;;;;EAyBnC,CAAA"}

package/dist/asyncapi/3.1/ws-binding.js

@@ -0,0 +1,24 @@
+import { literal, object, optional, string, union } from '@scalar/validation';
+import { asyncApiSchemaObjectOrReference } from './schema-payload.js';
+/**
+ * AsyncAPI WebSocket binding (channel / operation / server).
+ *
+ * @see https://github.com/asyncapi/bindings/tree/master/websockets
+ */
+export const asyncApiWsBindingObject = object({
+    method: optional(union([literal('GET'), literal('POST')], {
+        typeComment: 'HTTP method used when establishing the WebSocket connection (typically GET).',
+    })),
+    query: optional(asyncApiSchemaObjectOrReference, {
+        typeComment: 'Schema Object describing WebSocket handshake query parameters (type object with properties). May be a Reference Object.',
+    }),
+    headers: optional(asyncApiSchemaObjectOrReference, {
+        typeComment: 'Schema Object describing HTTP headers sent during the WebSocket handshake (type object with properties). May be a Reference Object.',
+    }),
+    bindingVersion: optional(string({
+        typeComment: 'Version of the WebSocket binding. When omitted, "latest" is assumed per the binding spec.',
+    })),
+}, {
+    typeName: 'AsyncApiWsBindingObject',
+    typeComment: 'AsyncAPI WebSocket binding for handshake method, query, and headers.',
+});

package/dist/extensions/server/x-scalar-selected-server.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"x-scalar-selected-server.d.ts","sourceRoot":"","sources":["../../../src/extensions/server/x-scalar-selected-server.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,qBAAqB;;EAWjC,CAAA"}
+{"version":3,"file":"x-scalar-selected-server.d.ts","sourceRoot":"","sources":["../../../src/extensions/server/x-scalar-selected-server.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,qBAAqB;;EAmBjC,CAAA"}

package/dist/extensions/server/x-scalar-selected-server.js

@@ -1,10 +1,12 @@
 import { object, optional, string } from '@scalar/validation';
 import { typeCommentWithExample } from '../type-comment.js';
 export const XScalarSelectedServer = object({
-    'x-scalar-selected-server': optional(string({ typeComment: 'The URL of the currently selected server' })),
+    'x-scalar-selected-server': optional(string({
+        typeComment: 'The currently selected server. For OpenAPI documents this is the server URL; for AsyncAPI documents this is the server name (key in `document.servers`).',
+    })),
 }, {
     typeName: 'XScalarSelectedServer',
-    typeComment: typeCommentWithExample('The URL of the currently selected server for this API description.', {
+    typeComment: typeCommentWithExample('The currently selected server for this API description. For OpenAPI documents the value is the server URL; for AsyncAPI documents the value is the server name (key in `document.servers`).', {
         language: 'yaml',
         body: 'x-scalar-selected-server: https://api.example.com',
     }),

package/package.json

@@ -14,7 +14,7 @@
     "schemas",
     "scalar"
   ],
-  "version": "0.3.0",
+  "version": "0.3.2",
   "engines": {
     "node": ">=22"
   },
@@ -41,12 +41,12 @@
     "CHANGELOG.md"
   ],
   "dependencies": {
-    "@scalar/validation": "0.6.0",
-    "@scalar/helpers": "0.8.0"
+    "@scalar/helpers": "0.8.0",
+    "@scalar/validation": "0.6.0"
   },
   "devDependencies": {
     "vitest": "4.1.0",
-    "@scalar/types": "0.12.0"
+    "@scalar/types": "0.12.2"
   },
   "scripts": {
     "build": "tsc -p tsconfig.build.json && tsc-alias -p tsconfig.build.json",