@scalar/schemas 0.2.0 → 0.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +19 -0
- package/dist/api-reference/api-reference-configuration.d.ts +18 -16
- package/dist/api-reference/api-reference-configuration.d.ts.map +1 -1
- package/dist/api-reference/api-reference-configuration.js +11 -1
- package/dist/api-reference/base-configuration.d.ts +6 -6
- package/dist/api-reference/source-configuration.d.ts +2 -2
- package/dist/api-reference/source-configuration.d.ts.map +1 -1
- package/dist/asyncapi/3.1/asyncapi-object.d.ts +50 -0
- package/dist/asyncapi/3.1/asyncapi-object.d.ts.map +1 -0
- package/dist/asyncapi/3.1/asyncapi-object.js +48 -0
- package/dist/asyncapi/3.1/bindings.d.ts +6 -0
- package/dist/asyncapi/3.1/bindings.d.ts.map +1 -0
- package/dist/asyncapi/3.1/bindings.js +42 -0
- package/dist/asyncapi/3.1/channel.d.ts +4 -0
- package/dist/asyncapi/3.1/channel.d.ts.map +1 -0
- package/dist/asyncapi/3.1/channel.js +29 -0
- package/dist/asyncapi/3.1/components.d.ts +22 -0
- package/dist/asyncapi/3.1/components.d.ts.map +1 -0
- package/dist/asyncapi/3.1/components.js +44 -0
- package/dist/asyncapi/3.1/contact.d.ts +6 -0
- package/dist/asyncapi/3.1/contact.d.ts.map +1 -0
- package/dist/asyncapi/3.1/contact.js +8 -0
- package/dist/asyncapi/3.1/correlation-id.d.ts +3 -0
- package/dist/asyncapi/3.1/correlation-id.d.ts.map +1 -0
- package/dist/asyncapi/3.1/correlation-id.js +11 -0
- package/dist/asyncapi/3.1/external-documentation.d.ts +3 -0
- package/dist/asyncapi/3.1/external-documentation.d.ts.map +1 -0
- package/dist/asyncapi/3.1/external-documentation.js +11 -0
- package/dist/asyncapi/3.1/index.d.ts +26 -0
- package/dist/asyncapi/3.1/index.d.ts.map +1 -0
- package/dist/asyncapi/3.1/index.js +25 -0
- package/dist/asyncapi/3.1/info.d.ts +15 -0
- package/dist/asyncapi/3.1/info.d.ts.map +1 -0
- package/dist/asyncapi/3.1/info.js +19 -0
- package/dist/asyncapi/3.1/license.d.ts +3 -0
- package/dist/asyncapi/3.1/license.d.ts.map +1 -0
- package/dist/asyncapi/3.1/license.js +9 -0
- package/dist/asyncapi/3.1/message-example.d.ts +7 -0
- package/dist/asyncapi/3.1/message-example.d.ts.map +1 -0
- package/dist/asyncapi/3.1/message-example.js +9 -0
- package/dist/asyncapi/3.1/message-trait.d.ts +3 -0
- package/dist/asyncapi/3.1/message-trait.d.ts.map +1 -0
- package/dist/asyncapi/3.1/message-trait.js +26 -0
- package/dist/asyncapi/3.1/message.d.ts +4 -0
- package/dist/asyncapi/3.1/message.d.ts.map +1 -0
- package/dist/asyncapi/3.1/message.js +33 -0
- package/dist/asyncapi/3.1/oauth.d.ts +13 -0
- package/dist/asyncapi/3.1/oauth.d.ts.map +1 -0
- package/dist/asyncapi/3.1/oauth.js +22 -0
- package/dist/asyncapi/3.1/operation-reply-address.d.ts +3 -0
- package/dist/asyncapi/3.1/operation-reply-address.d.ts.map +1 -0
- package/dist/asyncapi/3.1/operation-reply-address.js +11 -0
- package/dist/asyncapi/3.1/operation-reply.d.ts +3 -0
- package/dist/asyncapi/3.1/operation-reply.d.ts.map +1 -0
- package/dist/asyncapi/3.1/operation-reply.js +13 -0
- package/dist/asyncapi/3.1/operation-trait.d.ts +3 -0
- package/dist/asyncapi/3.1/operation-trait.d.ts.map +1 -0
- package/dist/asyncapi/3.1/operation-trait.js +20 -0
- package/dist/asyncapi/3.1/operation.d.ts +4 -0
- package/dist/asyncapi/3.1/operation.d.ts.map +1 -0
- package/dist/asyncapi/3.1/operation.js +37 -0
- package/dist/asyncapi/3.1/parameter.d.ts +3 -0
- package/dist/asyncapi/3.1/parameter.d.ts.map +1 -0
- package/dist/asyncapi/3.1/parameter.js +14 -0
- package/dist/asyncapi/3.1/parameters.d.ts +2 -0
- package/dist/asyncapi/3.1/parameters.d.ts.map +1 -0
- package/dist/asyncapi/3.1/parameters.js +6 -0
- package/dist/asyncapi/3.1/reference.d.ts +25 -0
- package/dist/asyncapi/3.1/reference.d.ts.map +1 -0
- package/dist/asyncapi/3.1/reference.js +25 -0
- package/dist/asyncapi/3.1/schema-payload.d.ts +7 -0
- package/dist/asyncapi/3.1/schema-payload.d.ts.map +1 -0
- package/dist/asyncapi/3.1/schema-payload.js +22 -0
- package/dist/asyncapi/3.1/security-scheme.d.ts +3 -0
- package/dist/asyncapi/3.1/security-scheme.d.ts.map +1 -0
- package/dist/asyncapi/3.1/security-scheme.js +39 -0
- package/dist/asyncapi/3.1/server-variable.d.ts +3 -0
- package/dist/asyncapi/3.1/server-variable.d.ts.map +1 -0
- package/dist/asyncapi/3.1/server-variable.js +13 -0
- package/dist/asyncapi/3.1/server.d.ts +4 -0
- package/dist/asyncapi/3.1/server.d.ts.map +1 -0
- package/dist/asyncapi/3.1/server.js +36 -0
- package/dist/asyncapi/3.1/tag.d.ts +4 -0
- package/dist/asyncapi/3.1/tag.d.ts.map +1 -0
- package/dist/asyncapi/3.1/tag.js +15 -0
- package/dist/extensions/document/index.d.ts +21 -0
- package/dist/extensions/document/index.d.ts.map +1 -0
- package/dist/extensions/document/index.js +20 -0
- package/dist/extensions/document/x-internal.d.ts +4 -0
- package/dist/extensions/document/x-internal.d.ts.map +1 -0
- package/dist/extensions/document/x-internal.js +11 -0
- package/dist/extensions/document/x-original-aas-version.d.ts +4 -0
- package/dist/extensions/document/x-original-aas-version.d.ts.map +1 -0
- package/dist/extensions/document/x-original-aas-version.js +8 -0
- package/dist/extensions/document/x-original-oas-version.d.ts +4 -0
- package/dist/extensions/document/x-original-oas-version.d.ts.map +1 -0
- package/dist/extensions/document/x-original-oas-version.js +8 -0
- package/dist/extensions/document/x-scalar-environments.d.ts +34 -0
- package/dist/extensions/document/x-scalar-environments.d.ts.map +1 -0
- package/dist/extensions/document/x-scalar-environments.js +41 -0
- package/dist/extensions/document/x-scalar-icon.d.ts +4 -0
- package/dist/extensions/document/x-scalar-icon.d.ts.map +1 -0
- package/dist/extensions/document/x-scalar-icon.js +11 -0
- package/dist/extensions/document/x-scalar-ignore.d.ts +5 -0
- package/dist/extensions/document/x-scalar-ignore.d.ts.map +1 -0
- package/dist/extensions/document/x-scalar-ignore.js +12 -0
- package/dist/extensions/document/x-scalar-is-dirty.d.ts +4 -0
- package/dist/extensions/document/x-scalar-is-dirty.d.ts.map +1 -0
- package/dist/extensions/document/x-scalar-is-dirty.js +13 -0
- package/dist/extensions/document/x-scalar-navigation.d.ts +4 -0
- package/dist/extensions/document/x-scalar-navigation.d.ts.map +1 -0
- package/dist/extensions/document/x-scalar-navigation.js +9 -0
- package/dist/extensions/document/x-scalar-original-document-hash.d.ts +4 -0
- package/dist/extensions/document/x-scalar-original-document-hash.d.ts.map +1 -0
- package/dist/extensions/document/x-scalar-original-document-hash.js +10 -0
- package/dist/extensions/document/x-scalar-original-source-url.d.ts +4 -0
- package/dist/extensions/document/x-scalar-original-source-url.d.ts.map +1 -0
- package/dist/extensions/document/x-scalar-original-source-url.js +8 -0
- package/dist/extensions/document/x-scalar-registry-meta.d.ts +11 -0
- package/dist/extensions/document/x-scalar-registry-meta.d.ts.map +1 -0
- package/dist/extensions/document/x-scalar-registry-meta.js +31 -0
- package/dist/extensions/document/x-scalar-sdk-installation.d.ts +8 -0
- package/dist/extensions/document/x-scalar-sdk-installation.d.ts.map +1 -0
- package/dist/extensions/document/x-scalar-sdk-installation.js +23 -0
- package/dist/extensions/document/x-scalar-watch-mode.d.ts +4 -0
- package/dist/extensions/document/x-scalar-watch-mode.d.ts.map +1 -0
- package/dist/extensions/document/x-scalar-watch-mode.js +8 -0
- package/dist/extensions/document/x-tags.d.ts +4 -0
- package/dist/extensions/document/x-tags.d.ts.map +1 -0
- package/dist/extensions/document/x-tags.js +15 -0
- package/dist/extensions/example/index.d.ts +7 -0
- package/dist/extensions/example/index.d.ts.map +1 -0
- package/dist/extensions/example/index.js +6 -0
- package/dist/extensions/example/x-disabled.d.ts +17 -0
- package/dist/extensions/example/x-disabled.d.ts.map +1 -0
- package/dist/extensions/example/x-disabled.js +23 -0
- package/dist/extensions/general/index.d.ts +12 -0
- package/dist/extensions/general/index.d.ts.map +1 -0
- package/dist/extensions/general/index.js +11 -0
- package/dist/extensions/general/x-post-response.d.ts +19 -0
- package/dist/extensions/general/x-post-response.d.ts.map +1 -0
- package/dist/extensions/general/x-post-response.js +31 -0
- package/dist/extensions/general/x-pre-request.d.ts +19 -0
- package/dist/extensions/general/x-pre-request.d.ts.map +1 -0
- package/dist/extensions/general/x-pre-request.js +30 -0
- package/dist/extensions/general/x-scalar-active-environment.d.ts +5 -0
- package/dist/extensions/general/x-scalar-active-environment.d.ts.map +1 -0
- package/dist/extensions/general/x-scalar-active-environment.js +12 -0
- package/dist/extensions/general/x-scalar-cookies.d.ts +17 -0
- package/dist/extensions/general/x-scalar-cookies.d.ts.map +1 -0
- package/dist/extensions/general/x-scalar-cookies.js +26 -0
- package/dist/extensions/general/x-scalar-order.d.ts +4 -0
- package/dist/extensions/general/x-scalar-order.d.ts.map +1 -0
- package/dist/extensions/general/x-scalar-order.js +16 -0
- package/dist/extensions/operation/index.d.ts +13 -0
- package/dist/extensions/operation/index.d.ts.map +1 -0
- package/dist/extensions/operation/index.js +12 -0
- package/dist/extensions/operation/x-badge.d.ts +38 -0
- package/dist/extensions/operation/x-badge.d.ts.map +1 -0
- package/dist/extensions/operation/x-badge.js +60 -0
- package/dist/extensions/operation/x-code-samples.d.ts +23 -0
- package/dist/extensions/operation/x-code-samples.d.ts.map +1 -0
- package/dist/extensions/operation/x-code-samples.js +24 -0
- package/dist/extensions/operation/x-draft-examples.d.ts +4 -0
- package/dist/extensions/operation/x-draft-examples.d.ts.map +1 -0
- package/dist/extensions/operation/x-draft-examples.js +15 -0
- package/dist/extensions/operation/x-scalar-disable-parameters.d.ts +8 -0
- package/dist/extensions/operation/x-scalar-disable-parameters.d.ts.map +1 -0
- package/dist/extensions/operation/x-scalar-disable-parameters.js +74 -0
- package/dist/extensions/operation/x-scalar-selected-content-type.d.ts +10 -0
- package/dist/extensions/operation/x-scalar-selected-content-type.d.ts.map +1 -0
- package/dist/extensions/operation/x-scalar-selected-content-type.js +21 -0
- package/dist/extensions/operation/x-scalar-stability.d.ts +9 -0
- package/dist/extensions/operation/x-scalar-stability.d.ts.map +1 -0
- package/dist/extensions/operation/x-scalar-stability.js +18 -0
- package/dist/extensions/parameter/index.d.ts +8 -0
- package/dist/extensions/parameter/index.d.ts.map +1 -0
- package/dist/extensions/parameter/index.js +7 -0
- package/dist/extensions/parameter/x-global.d.ts +13 -0
- package/dist/extensions/parameter/x-global.d.ts.map +1 -0
- package/dist/extensions/parameter/x-global.js +22 -0
- package/dist/extensions/schema/index.d.ts +12 -0
- package/dist/extensions/schema/index.d.ts.map +1 -0
- package/dist/extensions/schema/index.js +11 -0
- package/dist/extensions/schema/x-additional-properties-name.d.ts +10 -0
- package/dist/extensions/schema/x-additional-properties-name.d.ts.map +1 -0
- package/dist/extensions/schema/x-additional-properties-name.js +19 -0
- package/dist/extensions/schema/x-enum-descriptions.d.ts +20 -0
- package/dist/extensions/schema/x-enum-descriptions.d.ts.map +1 -0
- package/dist/extensions/schema/x-enum-descriptions.js +33 -0
- package/dist/extensions/schema/x-enum-varnames.d.ts +22 -0
- package/dist/extensions/schema/x-enum-varnames.d.ts.map +1 -0
- package/dist/extensions/schema/x-enum-varnames.js +34 -0
- package/dist/extensions/schema/x-examples.d.ts +4 -0
- package/dist/extensions/schema/x-examples.d.ts.map +1 -0
- package/dist/extensions/schema/x-examples.js +16 -0
- package/dist/extensions/schema/x-variable.d.ts +4 -0
- package/dist/extensions/schema/x-variable.d.ts.map +1 -0
- package/dist/extensions/schema/x-variable.js +11 -0
- package/dist/extensions/security/index.d.ts +14 -0
- package/dist/extensions/security/index.d.ts.map +1 -0
- package/dist/extensions/security/index.js +13 -0
- package/dist/extensions/security/x-default-scopes.d.ts +14 -0
- package/dist/extensions/security/x-default-scopes.d.ts.map +1 -0
- package/dist/extensions/security/x-default-scopes.js +23 -0
- package/dist/extensions/security/x-scalar-credentials-location.d.ts +17 -0
- package/dist/extensions/security/x-scalar-credentials-location.d.ts.map +1 -0
- package/dist/extensions/security/x-scalar-credentials-location.js +26 -0
- package/dist/extensions/security/x-scalar-security-body.d.ts +14 -0
- package/dist/extensions/security/x-scalar-security-body.d.ts.map +1 -0
- package/dist/extensions/security/x-scalar-security-body.js +25 -0
- package/dist/extensions/security/x-scalar-security-query.d.ts +14 -0
- package/dist/extensions/security/x-scalar-security-query.d.ts.map +1 -0
- package/dist/extensions/security/x-scalar-security-query.js +25 -0
- package/dist/extensions/security/x-scalar-security-secrets.d.ts +26 -0
- package/dist/extensions/security/x-scalar-security-secrets.d.ts.map +1 -0
- package/dist/extensions/security/x-scalar-security-secrets.js +57 -0
- package/dist/extensions/security/x-tokenName.d.ts +12 -0
- package/dist/extensions/security/x-tokenName.d.ts.map +1 -0
- package/dist/extensions/security/x-tokenName.js +21 -0
- package/dist/extensions/security/x-use-pkce.d.ts +7 -0
- package/dist/extensions/security/x-use-pkce.d.ts.map +1 -0
- package/dist/extensions/security/x-use-pkce.js +13 -0
- package/dist/extensions/server/index.d.ts +7 -0
- package/dist/extensions/server/index.d.ts.map +1 -0
- package/dist/extensions/server/index.js +6 -0
- package/dist/extensions/server/x-scalar-selected-server.d.ts +4 -0
- package/dist/extensions/server/x-scalar-selected-server.d.ts.map +1 -0
- package/dist/extensions/server/x-scalar-selected-server.js +11 -0
- package/dist/extensions/tag/index.d.ts +8 -0
- package/dist/extensions/tag/index.d.ts.map +1 -0
- package/dist/extensions/tag/index.js +7 -0
- package/dist/extensions/tag/x-display-name.d.ts +12 -0
- package/dist/extensions/tag/x-display-name.d.ts.map +1 -0
- package/dist/extensions/tag/x-display-name.js +21 -0
- package/dist/extensions/tag/x-tag-groups.d.ts +20 -0
- package/dist/extensions/tag/x-tag-groups.d.ts.map +1 -0
- package/dist/extensions/tag/x-tag-groups.js +33 -0
- package/dist/extensions/type-comment.d.ts +17 -0
- package/dist/extensions/type-comment.d.ts.map +1 -0
- package/dist/extensions/type-comment.js +14 -0
- package/dist/extensions/workspace/index.d.ts +9 -0
- package/dist/extensions/workspace/index.d.ts.map +1 -0
- package/dist/extensions/workspace/index.js +8 -0
- package/dist/extensions/workspace/x-scalar-active-proxy.d.ts +14 -0
- package/dist/extensions/workspace/x-scalar-active-proxy.d.ts.map +1 -0
- package/dist/extensions/workspace/x-scalar-active-proxy.js +23 -0
- package/dist/extensions/workspace/x-scalar-tabs.d.ts +20 -0
- package/dist/extensions/workspace/x-scalar-tabs.d.ts.map +1 -0
- package/dist/extensions/workspace/x-scalar-tabs.js +33 -0
- package/dist/general/bundler-extensions.d.ts +5 -0
- package/dist/general/bundler-extensions.d.ts.map +1 -0
- package/dist/general/bundler-extensions.js +9 -0
- package/dist/openapi/3.1/callback.d.ts +2 -0
- package/dist/openapi/3.1/callback.d.ts.map +1 -0
- package/dist/openapi/3.1/callback.js +6 -0
- package/dist/openapi/3.1/components.d.ts +36 -0
- package/dist/openapi/3.1/components.d.ts.map +1 -0
- package/dist/openapi/3.1/components.js +24 -0
- package/dist/openapi/3.1/contact.d.ts +6 -0
- package/dist/openapi/3.1/contact.d.ts.map +1 -0
- package/dist/openapi/3.1/contact.js +8 -0
- package/dist/openapi/3.1/discriminator.d.ts +5 -0
- package/dist/openapi/3.1/discriminator.d.ts.map +1 -0
- package/dist/openapi/3.1/discriminator.js +9 -0
- package/dist/openapi/3.1/document.d.ts +201 -0
- package/dist/openapi/3.1/document.d.ts.map +1 -0
- package/dist/openapi/3.1/document.js +67 -0
- package/dist/openapi/3.1/example.d.ts +9 -0
- package/dist/openapi/3.1/example.d.ts.map +1 -0
- package/dist/openapi/3.1/example.js +17 -0
- package/dist/openapi/3.1/external-docs.d.ts +5 -0
- package/dist/openapi/3.1/external-docs.d.ts.map +1 -0
- package/dist/openapi/3.1/external-docs.js +9 -0
- package/dist/openapi/3.1/index.d.ts +25 -0
- package/dist/openapi/3.1/index.d.ts.map +1 -0
- package/dist/openapi/3.1/index.js +24 -0
- package/dist/openapi/3.1/info.d.ts +24 -0
- package/dist/openapi/3.1/info.d.ts.map +1 -0
- package/dist/openapi/3.1/info.js +20 -0
- package/dist/openapi/3.1/license.d.ts +6 -0
- package/dist/openapi/3.1/license.d.ts.map +1 -0
- package/dist/openapi/3.1/license.js +10 -0
- package/dist/openapi/3.1/link.d.ts +17 -0
- package/dist/openapi/3.1/link.d.ts.map +1 -0
- package/dist/openapi/3.1/link.js +21 -0
- package/dist/openapi/3.1/media-type.d.ts +16 -0
- package/dist/openapi/3.1/media-type.d.ts.map +1 -0
- package/dist/openapi/3.1/media-type.js +49 -0
- package/dist/openapi/3.1/operation.d.ts +68 -0
- package/dist/openapi/3.1/operation.d.ts.map +1 -0
- package/dist/openapi/3.1/operation.js +48 -0
- package/dist/openapi/3.1/parameter.d.ts +44 -0
- package/dist/openapi/3.1/parameter.d.ts.map +1 -0
- package/dist/openapi/3.1/parameter.js +76 -0
- package/dist/openapi/3.1/path-item.d.ts +25 -0
- package/dist/openapi/3.1/path-item.d.ts.map +1 -0
- package/dist/openapi/3.1/path-item.js +27 -0
- package/dist/openapi/3.1/reference.d.ts +16 -0
- package/dist/openapi/3.1/reference.d.ts.map +1 -0
- package/dist/openapi/3.1/reference.js +34 -0
- package/dist/openapi/3.1/request-body.d.ts +16 -0
- package/dist/openapi/3.1/request-body.d.ts.map +1 -0
- package/dist/openapi/3.1/request-body.js +16 -0
- package/dist/openapi/3.1/response.d.ts +16 -0
- package/dist/openapi/3.1/response.d.ts.map +1 -0
- package/dist/openapi/3.1/response.js +15 -0
- package/dist/openapi/3.1/schema.d.ts +3 -0
- package/dist/openapi/3.1/schema.d.ts.map +1 -0
- package/dist/openapi/3.1/schema.js +100 -0
- package/dist/openapi/3.1/security-requirement.d.ts +2 -0
- package/dist/openapi/3.1/security-requirement.d.ts.map +1 -0
- package/dist/openapi/3.1/security-requirement.js +5 -0
- package/dist/openapi/3.1/security-schemes.d.ts +96 -0
- package/dist/openapi/3.1/security-schemes.d.ts.map +1 -0
- package/dist/openapi/3.1/security-schemes.js +107 -0
- package/dist/openapi/3.1/server-variable.d.ts +6 -0
- package/dist/openapi/3.1/server-variable.d.ts.map +1 -0
- package/dist/openapi/3.1/server-variable.js +12 -0
- package/dist/openapi/3.1/server.d.ts +10 -0
- package/dist/openapi/3.1/server.d.ts.map +1 -0
- package/dist/openapi/3.1/server.js +13 -0
- package/dist/openapi/3.1/tag.d.ts +17 -0
- package/dist/openapi/3.1/tag.d.ts.map +1 -0
- package/dist/openapi/3.1/tag.js +18 -0
- package/dist/openapi/3.1/xml.d.ts +8 -0
- package/dist/openapi/3.1/xml.d.ts.map +1 -0
- package/dist/openapi/3.1/xml.js +16 -0
- package/package.json +16 -4
- package/LICENSE +0 -21
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,24 @@
|
|
|
1
1
|
# @scalar/schemas
|
|
2
2
|
|
|
3
|
+
## 0.3.0
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- [#9264](https://github.com/scalar/scalar/pull/9264): feat: add AsyncAPI 3.1 validation schemas and `@scalar/schemas/asyncapi/3.1` export
|
|
8
|
+
- [#9297](https://github.com/scalar/scalar/pull/9297): feat: add asyncapi extensions
|
|
9
|
+
|
|
10
|
+
### Patch Changes
|
|
11
|
+
|
|
12
|
+
- [#9295](https://github.com/scalar/scalar/pull/9295): refactor: flatten AsyncAPI 3.1 schemas and validate resolved references
|
|
13
|
+
- Remove per-schema `create*` factories; export flat schemas using `recursiveRef` directly
|
|
14
|
+
- Add `asyncApiResolvedReference` for reference-only fields (`operation.channel`, `channel.servers`, `operation.reply`, and similar) so `$ref-value` is always validated
|
|
15
|
+
- Export `asyncApiObjectSchema` directly and use it for generated `AsyncApiDocument` types
|
|
16
|
+
|
|
17
|
+
- [#9299](https://github.com/scalar/scalar/pull/9299): refactor: flatten and split OpenAPI 3.1 schemas into separate files
|
|
18
|
+
- [#9169](https://github.com/scalar/scalar/pull/9169): feat: add `customFetch` to the api-reference configuration and forward it to the API client so requests (including "Test Request" calls) use the custom fetch — enabling things like `credentials: 'include'`. The previous `fetch` option is deprecated and migrated automatically with a console warning.
|
|
19
|
+
- [#9294](https://github.com/scalar/scalar/pull/9294): refactor: move the schemas to the schemas folder and generate the types from schemas
|
|
20
|
+
- [#9292](https://github.com/scalar/scalar/pull/9292): refactor: move extensions to the schema package
|
|
21
|
+
|
|
3
22
|
## 0.2.0
|
|
4
23
|
|
|
5
24
|
### Minor Changes
|
|
@@ -6,14 +6,14 @@ export declare const apiReferenceConfigurationSchema: import("@scalar/validation
|
|
|
6
6
|
hideClientButton: import("@scalar/validation").BooleanSchema;
|
|
7
7
|
proxyUrl: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
8
8
|
oauth2RedirectUri: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
9
|
-
searchHotKey: import("@scalar/validation").OptionalSchema<import("@scalar/validation").UnionSchema<
|
|
9
|
+
searchHotKey: import("@scalar/validation").OptionalSchema<import("@scalar/validation").UnionSchema<readonly [import("@scalar/validation").LiteralSchema<"a">, import("@scalar/validation").LiteralSchema<"b">, import("@scalar/validation").LiteralSchema<"c">, import("@scalar/validation").LiteralSchema<"d">, import("@scalar/validation").LiteralSchema<"e">, import("@scalar/validation").LiteralSchema<"f">, import("@scalar/validation").LiteralSchema<"g">, import("@scalar/validation").LiteralSchema<"h">, import("@scalar/validation").LiteralSchema<"i">, import("@scalar/validation").LiteralSchema<"j">, import("@scalar/validation").LiteralSchema<"k">, import("@scalar/validation").LiteralSchema<"l">, import("@scalar/validation").LiteralSchema<"m">, import("@scalar/validation").LiteralSchema<"n">, import("@scalar/validation").LiteralSchema<"o">, import("@scalar/validation").LiteralSchema<"p">, import("@scalar/validation").LiteralSchema<"q">, import("@scalar/validation").LiteralSchema<"r">, import("@scalar/validation").LiteralSchema<"s">, import("@scalar/validation").LiteralSchema<"t">, import("@scalar/validation").LiteralSchema<"u">, import("@scalar/validation").LiteralSchema<"v">, import("@scalar/validation").LiteralSchema<"w">, import("@scalar/validation").LiteralSchema<"x">, import("@scalar/validation").LiteralSchema<"y">, import("@scalar/validation").LiteralSchema<"z">]>>;
|
|
10
10
|
servers: import("@scalar/validation").OptionalSchema<import("@scalar/validation").ArraySchema<import("@scalar/validation").AnySchema>>;
|
|
11
11
|
showSidebar: import("@scalar/validation").BooleanSchema;
|
|
12
|
-
showDeveloperTools: import("@scalar/validation").UnionSchema<
|
|
13
|
-
showToolbar: import("@scalar/validation").UnionSchema<
|
|
14
|
-
operationTitleSource: import("@scalar/validation").UnionSchema<
|
|
15
|
-
theme: import("@scalar/validation").UnionSchema<
|
|
16
|
-
_integration: import("@scalar/validation").OptionalSchema<import("@scalar/validation").UnionSchema<
|
|
12
|
+
showDeveloperTools: import("@scalar/validation").UnionSchema<readonly [import("@scalar/validation").LiteralSchema<"localhost">, import("@scalar/validation").LiteralSchema<"always">, import("@scalar/validation").LiteralSchema<"never">]>;
|
|
13
|
+
showToolbar: import("@scalar/validation").UnionSchema<readonly [import("@scalar/validation").LiteralSchema<"localhost">, import("@scalar/validation").LiteralSchema<"always">, import("@scalar/validation").LiteralSchema<"never">]>;
|
|
14
|
+
operationTitleSource: import("@scalar/validation").UnionSchema<readonly [import("@scalar/validation").LiteralSchema<"summary">, import("@scalar/validation").LiteralSchema<"path">]>;
|
|
15
|
+
theme: import("@scalar/validation").UnionSchema<readonly [import("@scalar/validation").LiteralSchema<"default">, import("@scalar/validation").LiteralSchema<"alternate">, import("@scalar/validation").LiteralSchema<"moon">, import("@scalar/validation").LiteralSchema<"purple">, import("@scalar/validation").LiteralSchema<"solarized">, import("@scalar/validation").LiteralSchema<"bluePlanet">, import("@scalar/validation").LiteralSchema<"deepSpace">, import("@scalar/validation").LiteralSchema<"saturn">, import("@scalar/validation").LiteralSchema<"kepler">, import("@scalar/validation").LiteralSchema<"elysiajs">, import("@scalar/validation").LiteralSchema<"fastify">, import("@scalar/validation").LiteralSchema<"mars">, import("@scalar/validation").LiteralSchema<"laserwave">, import("@scalar/validation").LiteralSchema<"none">]>;
|
|
16
|
+
_integration: import("@scalar/validation").OptionalSchema<import("@scalar/validation").UnionSchema<readonly [import("@scalar/validation").LiteralSchema<"adonisjs">, import("@scalar/validation").LiteralSchema<"astro">, import("@scalar/validation").LiteralSchema<"docusaurus">, import("@scalar/validation").LiteralSchema<"dotnet">, import("@scalar/validation").LiteralSchema<"elysiajs">, import("@scalar/validation").LiteralSchema<"express">, import("@scalar/validation").LiteralSchema<"fastapi">, import("@scalar/validation").LiteralSchema<"fastify">, import("@scalar/validation").LiteralSchema<"go">, import("@scalar/validation").LiteralSchema<"hono">, import("@scalar/validation").LiteralSchema<"html">, import("@scalar/validation").LiteralSchema<"laravel">, import("@scalar/validation").LiteralSchema<"litestar">, import("@scalar/validation").LiteralSchema<"nestjs">, import("@scalar/validation").LiteralSchema<"nextjs">, import("@scalar/validation").LiteralSchema<"nitro">, import("@scalar/validation").LiteralSchema<"nuxt">, import("@scalar/validation").LiteralSchema<"platformatic">, import("@scalar/validation").LiteralSchema<"react">, import("@scalar/validation").LiteralSchema<"rust">, import("@scalar/validation").LiteralSchema<"svelte">, import("@scalar/validation").LiteralSchema<"vue">, import("@scalar/validation").NullableSchema]>>;
|
|
17
17
|
onRequestSent: import("@scalar/validation").OptionalSchema<import("@scalar/validation").FunctionSchema<(input: string) => void>>;
|
|
18
18
|
persistAuth: import("@scalar/validation").BooleanSchema;
|
|
19
19
|
telemetry: import("@scalar/validation").BooleanSchema;
|
|
@@ -26,12 +26,12 @@ export declare const apiReferenceConfigurationSchema: import("@scalar/validation
|
|
|
26
26
|
}>, import("@scalar/validation").ObjectSchema<{
|
|
27
27
|
default: import("@scalar/validation").BooleanSchema;
|
|
28
28
|
url: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
29
|
-
content: import("@scalar/validation").OptionalSchema<import("@scalar/validation").UnionSchema<
|
|
29
|
+
content: import("@scalar/validation").OptionalSchema<import("@scalar/validation").UnionSchema<readonly [import("@scalar/validation").StringSchema, import("@scalar/validation").NullableSchema, import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").AnySchema>, import("@scalar/validation").FunctionSchema<() => string | any>]>>;
|
|
30
30
|
title: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
31
31
|
slug: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
32
32
|
spec: import("@scalar/validation").OptionalSchema<import("@scalar/validation").ObjectSchema<{
|
|
33
33
|
url: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
34
|
-
content: import("@scalar/validation").OptionalSchema<import("@scalar/validation").UnionSchema<
|
|
34
|
+
content: import("@scalar/validation").OptionalSchema<import("@scalar/validation").UnionSchema<readonly [import("@scalar/validation").StringSchema, import("@scalar/validation").NullableSchema, import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").AnySchema>, import("@scalar/validation").FunctionSchema<() => string | any>]>>;
|
|
35
35
|
}>>;
|
|
36
36
|
agent: import("@scalar/validation").OptionalSchema<import("@scalar/validation").ObjectSchema<{
|
|
37
37
|
key: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
@@ -39,9 +39,10 @@ export declare const apiReferenceConfigurationSchema: import("@scalar/validation
|
|
|
39
39
|
hideAddApi: import("@scalar/validation").OptionalSchema<import("@scalar/validation").BooleanSchema>;
|
|
40
40
|
}>>;
|
|
41
41
|
}>, import("@scalar/validation").ObjectSchema<{
|
|
42
|
-
layout: import("@scalar/validation").UnionSchema<
|
|
42
|
+
layout: import("@scalar/validation").UnionSchema<readonly [import("@scalar/validation").LiteralSchema<"modern">, import("@scalar/validation").LiteralSchema<"classic">]>;
|
|
43
43
|
proxy: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
44
44
|
fetch: import("@scalar/validation").OptionalSchema<import("@scalar/validation").FunctionSchema<typeof fetch>>;
|
|
45
|
+
customFetch: import("@scalar/validation").OptionalSchema<import("@scalar/validation").FunctionSchema<typeof fetch>>;
|
|
45
46
|
plugins: import("@scalar/validation").OptionalSchema<import("@scalar/validation").ArraySchema<import("@scalar/validation").FunctionSchema<() => {
|
|
46
47
|
name: string;
|
|
47
48
|
extensions: import("@scalar/validation").Static<import("@scalar/validation").ObjectSchema<{
|
|
@@ -70,17 +71,17 @@ export declare const apiReferenceConfigurationSchema: import("@scalar/validation
|
|
|
70
71
|
isEditable: import("@scalar/validation").BooleanSchema;
|
|
71
72
|
isLoading: import("@scalar/validation").BooleanSchema;
|
|
72
73
|
hideModels: import("@scalar/validation").BooleanSchema;
|
|
73
|
-
documentDownloadType: import("@scalar/validation").UnionSchema<
|
|
74
|
+
documentDownloadType: import("@scalar/validation").UnionSchema<readonly [import("@scalar/validation").LiteralSchema<"both">, import("@scalar/validation").LiteralSchema<"yaml">, import("@scalar/validation").LiteralSchema<"json">, import("@scalar/validation").LiteralSchema<"direct">, import("@scalar/validation").LiteralSchema<"none">]>;
|
|
74
75
|
hideDownloadButton: import("@scalar/validation").OptionalSchema<import("@scalar/validation").BooleanSchema>;
|
|
75
76
|
hideTestRequestButton: import("@scalar/validation").BooleanSchema;
|
|
76
77
|
hideSearch: import("@scalar/validation").BooleanSchema;
|
|
77
78
|
showOperationId: import("@scalar/validation").BooleanSchema;
|
|
78
79
|
darkMode: import("@scalar/validation").OptionalSchema<import("@scalar/validation").BooleanSchema>;
|
|
79
|
-
forceDarkModeState: import("@scalar/validation").OptionalSchema<import("@scalar/validation").UnionSchema<
|
|
80
|
+
forceDarkModeState: import("@scalar/validation").OptionalSchema<import("@scalar/validation").UnionSchema<readonly [import("@scalar/validation").LiteralSchema<"dark">, import("@scalar/validation").LiteralSchema<"light">]>>;
|
|
80
81
|
hideDarkModeToggle: import("@scalar/validation").BooleanSchema;
|
|
81
82
|
metaData: import("@scalar/validation").OptionalSchema<import("@scalar/validation").AnySchema>;
|
|
82
83
|
favicon: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
83
|
-
hiddenClients: import("@scalar/validation").OptionalSchema<import("@scalar/validation").UnionSchema<
|
|
84
|
+
hiddenClients: import("@scalar/validation").OptionalSchema<import("@scalar/validation").UnionSchema<readonly [import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").UnionSchema<readonly [import("@scalar/validation").BooleanSchema, import("@scalar/validation").ArraySchema<import("@scalar/validation").StringSchema>]>>, import("@scalar/validation").ArraySchema<import("@scalar/validation").StringSchema>, import("@scalar/validation").LiteralSchema<true>]>>;
|
|
84
85
|
defaultHttpClient: import("@scalar/validation").OptionalSchema<import("@scalar/validation").ObjectSchema<{
|
|
85
86
|
targetKey: import("@scalar/validation").StringSchema;
|
|
86
87
|
clientKey: import("@scalar/validation").StringSchema;
|
|
@@ -130,9 +131,9 @@ export declare const apiReferenceConfigurationSchema: import("@scalar/validation
|
|
|
130
131
|
defaultOpenAllTags: import("@scalar/validation").BooleanSchema;
|
|
131
132
|
expandAllModelSections: import("@scalar/validation").BooleanSchema;
|
|
132
133
|
expandAllResponses: import("@scalar/validation").BooleanSchema;
|
|
133
|
-
tagsSorter: import("@scalar/validation").OptionalSchema<import("@scalar/validation").UnionSchema<
|
|
134
|
-
operationsSorter: import("@scalar/validation").OptionalSchema<import("@scalar/validation").UnionSchema<
|
|
135
|
-
orderSchemaPropertiesBy: import("@scalar/validation").UnionSchema<
|
|
134
|
+
tagsSorter: import("@scalar/validation").OptionalSchema<import("@scalar/validation").UnionSchema<readonly [import("@scalar/validation").LiteralSchema<"alpha">, import("@scalar/validation").FunctionSchema<(a: any, b: any) => number>]>>;
|
|
135
|
+
operationsSorter: import("@scalar/validation").OptionalSchema<import("@scalar/validation").UnionSchema<readonly [import("@scalar/validation").LiteralSchema<"alpha">, import("@scalar/validation").LiteralSchema<"method">, import("@scalar/validation").FunctionSchema<(a: any, b: any) => number>]>>;
|
|
136
|
+
orderSchemaPropertiesBy: import("@scalar/validation").UnionSchema<readonly [import("@scalar/validation").LiteralSchema<"alpha">, import("@scalar/validation").LiteralSchema<"preserve">]>;
|
|
136
137
|
orderRequiredPropertiesFirst: import("@scalar/validation").BooleanSchema;
|
|
137
138
|
}>]>;
|
|
138
139
|
export declare const apiReferenceConfigurationWithSourceSchema: (rawInput: unknown) => {
|
|
@@ -197,6 +198,7 @@ export declare const apiReferenceConfigurationWithSourceSchema: (rawInput: unkno
|
|
|
197
198
|
} & {
|
|
198
199
|
proxy?: string | undefined;
|
|
199
200
|
fetch?: typeof fetch | undefined;
|
|
201
|
+
customFetch?: typeof fetch | undefined;
|
|
200
202
|
plugins?: (() => {
|
|
201
203
|
name: string;
|
|
202
204
|
extensions: import("@scalar/validation").Static<import("@scalar/validation").ObjectSchema<{
|
|
@@ -227,7 +229,7 @@ export declare const apiReferenceConfigurationWithSourceSchema: (rawInput: unkno
|
|
|
227
229
|
forceDarkModeState?: "dark" | "light" | undefined;
|
|
228
230
|
metaData?: any;
|
|
229
231
|
favicon?: string | undefined;
|
|
230
|
-
hiddenClients?: true |
|
|
232
|
+
hiddenClients?: true | Record<string, boolean | string[]> | string[] | undefined;
|
|
231
233
|
defaultHttpClient?: {
|
|
232
234
|
targetKey: string;
|
|
233
235
|
clientKey: string;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"api-reference-configuration.d.ts","sourceRoot":"","sources":["../../src/api-reference/api-reference-configuration.ts"],"names":[],"mappings":"AAoBA,eAAO,MAAM,+BAA+B
|
|
1
|
+
{"version":3,"file":"api-reference-configuration.d.ts","sourceRoot":"","sources":["../../src/api-reference/api-reference-configuration.ts"],"names":[],"mappings":"AAoBA,eAAO,MAAM,+BAA+B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kHAyFN,MAAM,KAAK,IAAI;oHAGb,MAAM,KAAK,IAAI;oHAGf,IAAI;6GAGX,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI;qHAKhD;QACN,OAAO,EAAE,OAAO,CAAA;QAChB,cAAc,EAAE,OAAO,CAAA;QACvB,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;KACrC,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI;gHAOE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI;mHAG5B,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI;;;;;;;;;yHA4BzB;QAAE,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,KAAK,MAAM;uHAG9B;QAAE,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,KAAK,MAAM;qHAG9B;QAAE,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,KAAK,MAAM;2HAIpD;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,WAAW,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,KAAK,MAAM;yHAKvD;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,KAAK,MAAM;8GAGvD,MAAM,KAAK,MAAM,GAAG,IAAI,GAAG,SAAS;;;;;;oNA0Bb,GAAG,KAAK,GAAG,KAAK,MAAM;gRAGG,GAAG,KAAK,GAAG,KAAK,MAAM;;;IAWtG,CAAA;AAKF,eAAO,MAAM,yCAAyC,GAAI,UAAU,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;4BAvHrC,MAAM,KAAK,IAAI;8BAGb,MAAM,KAAK,IAAI;8BAGf,IAAI;uBAGX,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI;+BAKhD;QACN,OAAO,EAAE,OAAO,CAAA;QAChB,cAAc,EAAE,OAAO,CAAA;QACvB,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;KACrC,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI;0BAOE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI;6BAG5B,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI;;;;;;;;;mCA4BzB;QAAE,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,KAAK,MAAM;iCAG9B;QAAE,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,KAAK,MAAM;+BAG9B;QAAE,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,KAAK,MAAM;qCAIpD;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,WAAW,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,KAAK,MAAM;mCAKvD;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,KAAK,MAAM;wBAGvD,MAAM,KAAK,MAAM,GAAG,IAAI,GAAG,SAAS;gCA0Bb,GAAG,KAAK,GAAG,KAAK,MAAM;iDAGG,GAAG,KAAK,GAAG,KAAK,MAAM;CAqFvG,CAAA"}
|
|
@@ -13,7 +13,10 @@ export const apiReferenceConfigurationSchema = intersection([
|
|
|
13
13
|
typeComment: '@deprecated Use proxyUrl instead',
|
|
14
14
|
}),
|
|
15
15
|
fetch: optional(fn(), {
|
|
16
|
-
typeComment: '
|
|
16
|
+
typeComment: '@deprecated Use `customFetch` instead.',
|
|
17
|
+
}),
|
|
18
|
+
customFetch: optional(fn(), {
|
|
19
|
+
typeComment: "Custom fetch function used both when loading the OpenAPI document and when sending requests from the API client. Can be used to add custom headers, attach credentials (for example `credentials: 'include'`), handle auth, etc.",
|
|
17
20
|
}),
|
|
18
21
|
plugins: optional(array(apiReferencePluginSchema), {
|
|
19
22
|
typeComment: 'Plugins for the API reference',
|
|
@@ -193,6 +196,13 @@ export const apiReferenceConfigurationWithSourceSchema = (rawInput) => {
|
|
|
193
196
|
}
|
|
194
197
|
delete input.proxy;
|
|
195
198
|
}
|
|
199
|
+
if (input.fetch) {
|
|
200
|
+
console.warn(`[DEPRECATED] You're using the deprecated 'fetch' attribute. Use 'customFetch' instead.`);
|
|
201
|
+
if (!input.customFetch) {
|
|
202
|
+
input.customFetch = input.fetch;
|
|
203
|
+
}
|
|
204
|
+
delete input.fetch;
|
|
205
|
+
}
|
|
196
206
|
if (input.proxyUrl === OLD_PROXY_URL) {
|
|
197
207
|
console.warn(`[DEPRECATED] Warning: configuration.proxyUrl points to our old proxy (${OLD_PROXY_URL}).`);
|
|
198
208
|
console.warn(`[DEPRECATED] We are overwriting the value and use the new proxy URL (${NEW_PROXY_URL}) instead.`);
|
|
@@ -6,14 +6,14 @@ export declare const baseConfigurationSchema: import("@scalar/validation").Objec
|
|
|
6
6
|
hideClientButton: import("@scalar/validation").BooleanSchema;
|
|
7
7
|
proxyUrl: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
8
8
|
oauth2RedirectUri: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
9
|
-
searchHotKey: import("@scalar/validation").OptionalSchema<import("@scalar/validation").UnionSchema<
|
|
9
|
+
searchHotKey: import("@scalar/validation").OptionalSchema<import("@scalar/validation").UnionSchema<readonly [import("@scalar/validation").LiteralSchema<"a">, import("@scalar/validation").LiteralSchema<"b">, import("@scalar/validation").LiteralSchema<"c">, import("@scalar/validation").LiteralSchema<"d">, import("@scalar/validation").LiteralSchema<"e">, import("@scalar/validation").LiteralSchema<"f">, import("@scalar/validation").LiteralSchema<"g">, import("@scalar/validation").LiteralSchema<"h">, import("@scalar/validation").LiteralSchema<"i">, import("@scalar/validation").LiteralSchema<"j">, import("@scalar/validation").LiteralSchema<"k">, import("@scalar/validation").LiteralSchema<"l">, import("@scalar/validation").LiteralSchema<"m">, import("@scalar/validation").LiteralSchema<"n">, import("@scalar/validation").LiteralSchema<"o">, import("@scalar/validation").LiteralSchema<"p">, import("@scalar/validation").LiteralSchema<"q">, import("@scalar/validation").LiteralSchema<"r">, import("@scalar/validation").LiteralSchema<"s">, import("@scalar/validation").LiteralSchema<"t">, import("@scalar/validation").LiteralSchema<"u">, import("@scalar/validation").LiteralSchema<"v">, import("@scalar/validation").LiteralSchema<"w">, import("@scalar/validation").LiteralSchema<"x">, import("@scalar/validation").LiteralSchema<"y">, import("@scalar/validation").LiteralSchema<"z">]>>;
|
|
10
10
|
servers: import("@scalar/validation").OptionalSchema<import("@scalar/validation").ArraySchema<import("@scalar/validation").AnySchema>>;
|
|
11
11
|
showSidebar: import("@scalar/validation").BooleanSchema;
|
|
12
|
-
showDeveloperTools: import("@scalar/validation").UnionSchema<
|
|
13
|
-
showToolbar: import("@scalar/validation").UnionSchema<
|
|
14
|
-
operationTitleSource: import("@scalar/validation").UnionSchema<
|
|
15
|
-
theme: import("@scalar/validation").UnionSchema<
|
|
16
|
-
_integration: import("@scalar/validation").OptionalSchema<import("@scalar/validation").UnionSchema<
|
|
12
|
+
showDeveloperTools: import("@scalar/validation").UnionSchema<readonly [import("@scalar/validation").LiteralSchema<"localhost">, import("@scalar/validation").LiteralSchema<"always">, import("@scalar/validation").LiteralSchema<"never">]>;
|
|
13
|
+
showToolbar: import("@scalar/validation").UnionSchema<readonly [import("@scalar/validation").LiteralSchema<"localhost">, import("@scalar/validation").LiteralSchema<"always">, import("@scalar/validation").LiteralSchema<"never">]>;
|
|
14
|
+
operationTitleSource: import("@scalar/validation").UnionSchema<readonly [import("@scalar/validation").LiteralSchema<"summary">, import("@scalar/validation").LiteralSchema<"path">]>;
|
|
15
|
+
theme: import("@scalar/validation").UnionSchema<readonly [import("@scalar/validation").LiteralSchema<"default">, import("@scalar/validation").LiteralSchema<"alternate">, import("@scalar/validation").LiteralSchema<"moon">, import("@scalar/validation").LiteralSchema<"purple">, import("@scalar/validation").LiteralSchema<"solarized">, import("@scalar/validation").LiteralSchema<"bluePlanet">, import("@scalar/validation").LiteralSchema<"deepSpace">, import("@scalar/validation").LiteralSchema<"saturn">, import("@scalar/validation").LiteralSchema<"kepler">, import("@scalar/validation").LiteralSchema<"elysiajs">, import("@scalar/validation").LiteralSchema<"fastify">, import("@scalar/validation").LiteralSchema<"mars">, import("@scalar/validation").LiteralSchema<"laserwave">, import("@scalar/validation").LiteralSchema<"none">]>;
|
|
16
|
+
_integration: import("@scalar/validation").OptionalSchema<import("@scalar/validation").UnionSchema<readonly [import("@scalar/validation").LiteralSchema<"adonisjs">, import("@scalar/validation").LiteralSchema<"astro">, import("@scalar/validation").LiteralSchema<"docusaurus">, import("@scalar/validation").LiteralSchema<"dotnet">, import("@scalar/validation").LiteralSchema<"elysiajs">, import("@scalar/validation").LiteralSchema<"express">, import("@scalar/validation").LiteralSchema<"fastapi">, import("@scalar/validation").LiteralSchema<"fastify">, import("@scalar/validation").LiteralSchema<"go">, import("@scalar/validation").LiteralSchema<"hono">, import("@scalar/validation").LiteralSchema<"html">, import("@scalar/validation").LiteralSchema<"laravel">, import("@scalar/validation").LiteralSchema<"litestar">, import("@scalar/validation").LiteralSchema<"nestjs">, import("@scalar/validation").LiteralSchema<"nextjs">, import("@scalar/validation").LiteralSchema<"nitro">, import("@scalar/validation").LiteralSchema<"nuxt">, import("@scalar/validation").LiteralSchema<"platformatic">, import("@scalar/validation").LiteralSchema<"react">, import("@scalar/validation").LiteralSchema<"rust">, import("@scalar/validation").LiteralSchema<"svelte">, import("@scalar/validation").LiteralSchema<"vue">, import("@scalar/validation").NullableSchema]>>;
|
|
17
17
|
onRequestSent: import("@scalar/validation").OptionalSchema<import("@scalar/validation").FunctionSchema<(input: string) => void>>;
|
|
18
18
|
persistAuth: import("@scalar/validation").BooleanSchema;
|
|
19
19
|
telemetry: import("@scalar/validation").BooleanSchema;
|
|
@@ -6,12 +6,12 @@
|
|
|
6
6
|
export declare const sourceConfigurationSchema: import("@scalar/validation").ObjectSchema<{
|
|
7
7
|
default: import("@scalar/validation").BooleanSchema;
|
|
8
8
|
url: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
9
|
-
content: import("@scalar/validation").OptionalSchema<import("@scalar/validation").UnionSchema<
|
|
9
|
+
content: import("@scalar/validation").OptionalSchema<import("@scalar/validation").UnionSchema<readonly [import("@scalar/validation").StringSchema, import("@scalar/validation").NullableSchema, import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").AnySchema>, import("@scalar/validation").FunctionSchema<() => string | any>]>>;
|
|
10
10
|
title: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
11
11
|
slug: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
12
12
|
spec: import("@scalar/validation").OptionalSchema<import("@scalar/validation").ObjectSchema<{
|
|
13
13
|
url: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
14
|
-
content: import("@scalar/validation").OptionalSchema<import("@scalar/validation").UnionSchema<
|
|
14
|
+
content: import("@scalar/validation").OptionalSchema<import("@scalar/validation").UnionSchema<readonly [import("@scalar/validation").StringSchema, import("@scalar/validation").NullableSchema, import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").AnySchema>, import("@scalar/validation").FunctionSchema<() => string | any>]>>;
|
|
15
15
|
}>>;
|
|
16
16
|
agent: import("@scalar/validation").OptionalSchema<import("@scalar/validation").ObjectSchema<{
|
|
17
17
|
key: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"source-configuration.d.ts","sourceRoot":"","sources":["../../src/api-reference/source-configuration.ts"],"names":[],"mappings":"AAYA;;;;GAIG;AACH,eAAO,MAAM,yBAAyB;;;
|
|
1
|
+
{"version":3,"file":"source-configuration.d.ts","sourceRoot":"","sources":["../../src/api-reference/source-configuration.ts"],"names":[],"mappings":"AAYA;;;;GAIG;AACH,eAAO,MAAM,yBAAyB;;;oXAP+C,MAAM,GAAG,GAAG;;;;;wXAAZ,MAAM,GAAG,GAAG;;;;;;;EA8C/F,CAAA"}
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Root AsyncAPI 3.1.0 document (the A2S / AsyncAPI Object).
|
|
3
|
+
*
|
|
4
|
+
* @see https://www.asyncapi.com/docs/reference/specification/v3.1.0#A2SObject
|
|
5
|
+
*/
|
|
6
|
+
export declare const asyncApiObjectSchema: import("@scalar/validation").IntersectionSchema<readonly [import("@scalar/validation").ObjectSchema<{
|
|
7
|
+
asyncapi: import("@scalar/validation").StringSchema;
|
|
8
|
+
id: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
9
|
+
info: import("@scalar/validation").ObjectSchema<{
|
|
10
|
+
title: import("@scalar/validation").StringSchema;
|
|
11
|
+
version: import("@scalar/validation").StringSchema;
|
|
12
|
+
description: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
13
|
+
termsOfService: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
14
|
+
contact: import("@scalar/validation").OptionalSchema<import("@scalar/validation").ObjectSchema<{
|
|
15
|
+
name: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
16
|
+
url: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
17
|
+
email: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
18
|
+
}>>;
|
|
19
|
+
license: import("@scalar/validation").OptionalSchema<import("@scalar/validation").Schema>;
|
|
20
|
+
tags: import("@scalar/validation").OptionalSchema<import("@scalar/validation").ArraySchema<import("@scalar/validation").Schema>>;
|
|
21
|
+
externalDocs: import("@scalar/validation").OptionalSchema<import("@scalar/validation").Schema>;
|
|
22
|
+
}>;
|
|
23
|
+
servers: import("@scalar/validation").OptionalSchema<import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").Schema>>;
|
|
24
|
+
defaultContentType: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
25
|
+
channels: import("@scalar/validation").OptionalSchema<import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").LazySchema<() => import("@scalar/validation").Schema>>>;
|
|
26
|
+
operations: import("@scalar/validation").OptionalSchema<import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").LazySchema<() => import("@scalar/validation").Schema>>>;
|
|
27
|
+
components: import("@scalar/validation").OptionalSchema<import("@scalar/validation").Schema>;
|
|
28
|
+
}>, import("@scalar/validation").IntersectionSchema<readonly [import("@scalar/validation").ObjectSchema<{
|
|
29
|
+
'x-original-aas-version': import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
30
|
+
}>, import("@scalar/validation").ObjectSchema<{
|
|
31
|
+
'x-scalar-navigation': import("@scalar/validation").OptionalSchema<import("@scalar/validation").AnySchema>;
|
|
32
|
+
}>, import("@scalar/validation").ObjectSchema<{
|
|
33
|
+
'x-scalar-original-source-url': import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
34
|
+
}>, import("@scalar/validation").ObjectSchema<{
|
|
35
|
+
'x-scalar-original-document-hash': import("@scalar/validation").StringSchema;
|
|
36
|
+
}>, import("@scalar/validation").ObjectSchema<{
|
|
37
|
+
'x-scalar-is-dirty': import("@scalar/validation").OptionalSchema<import("@scalar/validation").BooleanSchema>;
|
|
38
|
+
}>, import("@scalar/validation").ObjectSchema<{
|
|
39
|
+
'x-scalar-watch-mode': import("@scalar/validation").OptionalSchema<import("@scalar/validation").BooleanSchema>;
|
|
40
|
+
}>, import("@scalar/validation").ObjectSchema<{
|
|
41
|
+
'x-scalar-registry-meta': import("@scalar/validation").OptionalSchema<import("@scalar/validation").ObjectSchema<{
|
|
42
|
+
namespace: import("@scalar/validation").StringSchema;
|
|
43
|
+
slug: import("@scalar/validation").StringSchema;
|
|
44
|
+
version: import("@scalar/validation").StringSchema;
|
|
45
|
+
commitHash: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
46
|
+
conflictCheckedAgainstHash: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
47
|
+
hasConflict: import("@scalar/validation").OptionalSchema<import("@scalar/validation").BooleanSchema>;
|
|
48
|
+
}>>;
|
|
49
|
+
}>]>]>;
|
|
50
|
+
//# sourceMappingURL=asyncapi-object.d.ts.map
|
|
@@ -0,0 +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"}
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
import { intersection, object, optional, string } from '@scalar/validation';
|
|
2
|
+
import { XOriginalAasVersion, XScalarIsDirty, XScalarNavigation, XScalarOriginalDocumentHash, XScalarOriginalSourceUrl, XScalarRegistryMeta, XScalarWatchMode, } from '../../extensions/document/index.js';
|
|
3
|
+
import { asyncApiChannelsObject } from './channel.js';
|
|
4
|
+
import { asyncApiComponentsObject } from './components.js';
|
|
5
|
+
import { asyncApiInfoObject } from './info.js';
|
|
6
|
+
import { asyncApiOperationsObject } from './operation.js';
|
|
7
|
+
import { recursiveRef } from './reference.js';
|
|
8
|
+
import { asyncApiServersObject } from './server.js';
|
|
9
|
+
const asyncApiExtensions = intersection([
|
|
10
|
+
XOriginalAasVersion,
|
|
11
|
+
XScalarNavigation,
|
|
12
|
+
XScalarOriginalSourceUrl,
|
|
13
|
+
XScalarOriginalDocumentHash,
|
|
14
|
+
XScalarIsDirty,
|
|
15
|
+
XScalarWatchMode,
|
|
16
|
+
XScalarRegistryMeta,
|
|
17
|
+
], {
|
|
18
|
+
typeName: 'AsyncApiExtensions',
|
|
19
|
+
typeComment: 'AsyncAPI document-level Scalar extensions shared with workspace tooling.',
|
|
20
|
+
});
|
|
21
|
+
const asyncApiDocumentCore = object({
|
|
22
|
+
asyncapi: string({
|
|
23
|
+
typeComment: 'REQUIRED. AsyncAPI Specification version (major.minor.patch). Patch MAY include a hyphen suffix.',
|
|
24
|
+
}),
|
|
25
|
+
id: optional(string({
|
|
26
|
+
typeComment: 'Identifier of the application the AsyncAPI document is defining (URI, RFC3986).',
|
|
27
|
+
})),
|
|
28
|
+
info: asyncApiInfoObject,
|
|
29
|
+
servers: optional(asyncApiServersObject),
|
|
30
|
+
defaultContentType: optional(string({
|
|
31
|
+
typeComment: 'Default content type when encoding/decoding a message payload (for example application/json).',
|
|
32
|
+
})),
|
|
33
|
+
channels: optional(asyncApiChannelsObject),
|
|
34
|
+
operations: optional(asyncApiOperationsObject),
|
|
35
|
+
components: optional(recursiveRef(asyncApiComponentsObject)),
|
|
36
|
+
}, {
|
|
37
|
+
typeName: 'AsyncApiDocumentCore',
|
|
38
|
+
typeComment: 'Root AsyncAPI 3.1.0 document combining resource listing and API declaration.',
|
|
39
|
+
});
|
|
40
|
+
/**
|
|
41
|
+
* Root AsyncAPI 3.1.0 document (the A2S / AsyncAPI Object).
|
|
42
|
+
*
|
|
43
|
+
* @see https://www.asyncapi.com/docs/reference/specification/v3.1.0#A2SObject
|
|
44
|
+
*/
|
|
45
|
+
export const asyncApiObjectSchema = intersection([asyncApiDocumentCore, asyncApiExtensions], {
|
|
46
|
+
typeName: 'AsyncApiObject',
|
|
47
|
+
typeComment: 'Root AsyncAPI 3.1.0 document including Scalar workspace extensions (AsyncApiExtensionsSchema).',
|
|
48
|
+
});
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
import { type Schema } from '@scalar/validation';
|
|
2
|
+
export declare const asyncApiServerBindingsObject: import("@scalar/validation").ObjectSchema<Record<string, Schema>>;
|
|
3
|
+
export declare const asyncApiChannelBindingsObject: import("@scalar/validation").ObjectSchema<Record<string, Schema>>;
|
|
4
|
+
export declare const asyncApiOperationBindingsObject: import("@scalar/validation").ObjectSchema<Record<string, Schema>>;
|
|
5
|
+
export declare const asyncApiMessageBindingsObject: import("@scalar/validation").ObjectSchema<Record<string, Schema>>;
|
|
6
|
+
//# sourceMappingURL=bindings.d.ts.map
|
|
@@ -0,0 +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"}
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
import { object, optional, unknown } from '@scalar/validation';
|
|
2
|
+
/**
|
|
3
|
+
* Protocol keys listed for binding objects in AsyncAPI 3.1.0. Values are
|
|
4
|
+
* protocol-specific; we accept any JSON-compatible structure.
|
|
5
|
+
*/
|
|
6
|
+
const ASYNCAPI_3_1_BINDING_PROTOCOL_KEYS = [
|
|
7
|
+
'http',
|
|
8
|
+
'ws',
|
|
9
|
+
'kafka',
|
|
10
|
+
'anypointmq',
|
|
11
|
+
'amqp',
|
|
12
|
+
'amqp1',
|
|
13
|
+
'mqtt',
|
|
14
|
+
'mqtt5',
|
|
15
|
+
'nats',
|
|
16
|
+
'jms',
|
|
17
|
+
'sns',
|
|
18
|
+
'solace',
|
|
19
|
+
'sqs',
|
|
20
|
+
'stomp',
|
|
21
|
+
'redis',
|
|
22
|
+
'mercure',
|
|
23
|
+
'ibmmq',
|
|
24
|
+
'googlepubsub',
|
|
25
|
+
'pulsar',
|
|
26
|
+
'ros2',
|
|
27
|
+
];
|
|
28
|
+
const optionalBindingPayload = () => optional(unknown({
|
|
29
|
+
typeComment: 'Protocol-specific binding definition (see AsyncAPI protocol bindings).',
|
|
30
|
+
}));
|
|
31
|
+
const bindingObjectProperties = () => {
|
|
32
|
+
const properties = {};
|
|
33
|
+
for (const key of ASYNCAPI_3_1_BINDING_PROTOCOL_KEYS) {
|
|
34
|
+
properties[key] = optionalBindingPayload();
|
|
35
|
+
}
|
|
36
|
+
return properties;
|
|
37
|
+
};
|
|
38
|
+
const makeBindingsObject = (typeName, typeComment) => object(bindingObjectProperties(), { typeName, typeComment });
|
|
39
|
+
export const asyncApiServerBindingsObject = makeBindingsObject('AsyncApiServerBindingsObject', 'Map describing protocol-specific definitions for a server (AsyncAPI 3.1.0).');
|
|
40
|
+
export const asyncApiChannelBindingsObject = makeBindingsObject('AsyncApiChannelBindingsObject', 'Map describing protocol-specific definitions for a channel (AsyncAPI 3.1.0).');
|
|
41
|
+
export const asyncApiOperationBindingsObject = makeBindingsObject('AsyncApiOperationBindingsObject', 'Map describing protocol-specific definitions for an operation (AsyncAPI 3.1.0).');
|
|
42
|
+
export const asyncApiMessageBindingsObject = makeBindingsObject('AsyncApiMessageBindingsObject', 'Map describing protocol-specific definitions for a message (AsyncAPI 3.1.0).');
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
/** Channel Object | Reference Object */
|
|
2
|
+
export declare const asyncApiChannelObject: import("@scalar/validation").LazySchema<() => import("@scalar/validation").Schema>;
|
|
3
|
+
export declare const asyncApiChannelsObject: import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").LazySchema<() => import("@scalar/validation").Schema>>;
|
|
4
|
+
//# sourceMappingURL=channel.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"channel.d.ts","sourceRoot":"","sources":["../../../src/asyncapi/3.1/channel.ts"],"names":[],"mappings":"AAUA,wCAAwC;AACxC,eAAO,MAAM,qBAAqB,oFA4BjC,CAAA;AAED,eAAO,MAAM,sBAAsB,0KAGjC,CAAA"}
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
import { array, lazy, nullable, object, optional, record, string, union } from '@scalar/validation';
|
|
2
|
+
import { asyncApiChannelBindingsObject } from './bindings.js';
|
|
3
|
+
import { asyncApiExternalDocumentationObject } from './external-documentation.js';
|
|
4
|
+
import { asyncApiMessagesObject } from './message.js';
|
|
5
|
+
import { asyncApiParametersObject } from './parameters.js';
|
|
6
|
+
import { asyncApiResolvedReference, recursiveRef } from './reference.js';
|
|
7
|
+
import { asyncApiServerObject } from './server.js';
|
|
8
|
+
import { asyncApiTagsObject } from './tag.js';
|
|
9
|
+
/** Channel Object | Reference Object */
|
|
10
|
+
export const asyncApiChannelObject = lazy(() => recursiveRef(object({
|
|
11
|
+
address: optional(union([string(), nullable()], { typeComment: 'Channel address or null when unknown.' })),
|
|
12
|
+
messages: optional(asyncApiMessagesObject),
|
|
13
|
+
title: optional(string({ typeComment: 'A human-friendly title for the channel.' })),
|
|
14
|
+
summary: optional(string({ typeComment: 'A short summary of the channel.' })),
|
|
15
|
+
description: optional(string({
|
|
16
|
+
typeComment: 'An optional description of this channel. CommonMark syntax MAY be used for rich text representation.',
|
|
17
|
+
})),
|
|
18
|
+
servers: optional(array(asyncApiResolvedReference(asyncApiServerObject), {
|
|
19
|
+
typeComment: 'References to Server definitions where this channel is available (Reference Objects only in the raw document).',
|
|
20
|
+
})),
|
|
21
|
+
parameters: optional(asyncApiParametersObject),
|
|
22
|
+
tags: optional(asyncApiTagsObject),
|
|
23
|
+
externalDocs: optional(asyncApiExternalDocumentationObject),
|
|
24
|
+
bindings: optional(recursiveRef(asyncApiChannelBindingsObject)),
|
|
25
|
+
}, { typeName: 'AsyncApiChannelObject' })));
|
|
26
|
+
export const asyncApiChannelsObject = record(string(), asyncApiChannelObject, {
|
|
27
|
+
typeName: 'AsyncApiChannelsObject',
|
|
28
|
+
typeComment: 'Map of channelId to Channel Object or Reference Object.',
|
|
29
|
+
});
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
export declare const asyncApiComponentsObject: import("@scalar/validation").LazySchema<() => import("@scalar/validation").ObjectSchema<{
|
|
2
|
+
schemas: import("@scalar/validation").OptionalSchema<import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").Schema>>;
|
|
3
|
+
servers: import("@scalar/validation").OptionalSchema<import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").Schema>>;
|
|
4
|
+
channels: import("@scalar/validation").OptionalSchema<import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").LazySchema<() => import("@scalar/validation").Schema>>>;
|
|
5
|
+
operations: import("@scalar/validation").OptionalSchema<import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").LazySchema<() => import("@scalar/validation").Schema>>>;
|
|
6
|
+
messages: import("@scalar/validation").OptionalSchema<import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").LazySchema<() => import("@scalar/validation").Schema>>>;
|
|
7
|
+
securitySchemes: import("@scalar/validation").OptionalSchema<import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").Schema>>;
|
|
8
|
+
serverVariables: import("@scalar/validation").OptionalSchema<import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").Schema>>;
|
|
9
|
+
parameters: import("@scalar/validation").OptionalSchema<import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").Schema>>;
|
|
10
|
+
correlationIds: import("@scalar/validation").OptionalSchema<import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").Schema>>;
|
|
11
|
+
replies: import("@scalar/validation").OptionalSchema<import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").LazySchema<() => import("@scalar/validation").Schema>>>;
|
|
12
|
+
replyAddresses: import("@scalar/validation").OptionalSchema<import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").Schema>>;
|
|
13
|
+
externalDocs: import("@scalar/validation").OptionalSchema<import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").Schema>>;
|
|
14
|
+
tags: import("@scalar/validation").OptionalSchema<import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").Schema>>;
|
|
15
|
+
operationTraits: import("@scalar/validation").OptionalSchema<import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").Schema>>;
|
|
16
|
+
messageTraits: import("@scalar/validation").OptionalSchema<import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").Schema>>;
|
|
17
|
+
serverBindings: import("@scalar/validation").OptionalSchema<import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").Schema>>;
|
|
18
|
+
channelBindings: import("@scalar/validation").OptionalSchema<import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").Schema>>;
|
|
19
|
+
operationBindings: import("@scalar/validation").OptionalSchema<import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").Schema>>;
|
|
20
|
+
messageBindings: import("@scalar/validation").OptionalSchema<import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").Schema>>;
|
|
21
|
+
}>>;
|
|
22
|
+
//# sourceMappingURL=components.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"components.d.ts","sourceRoot":"","sources":["../../../src/asyncapi/3.1/components.ts"],"names":[],"mappings":"AAyBA,eAAO,MAAM,wBAAwB;;;;;;;;;;;;;;;;;;;;GAgCpC,CAAA"}
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
import { lazy, object, optional, record, string } from '@scalar/validation';
|
|
2
|
+
import { asyncApiChannelBindingsObject, asyncApiMessageBindingsObject, asyncApiOperationBindingsObject, asyncApiServerBindingsObject, } from './bindings.js';
|
|
3
|
+
import { asyncApiChannelObject } from './channel.js';
|
|
4
|
+
import { asyncApiCorrelationIdObject } from './correlation-id.js';
|
|
5
|
+
import { asyncApiExternalDocumentationObject } from './external-documentation.js';
|
|
6
|
+
import { asyncApiMessageObject } from './message.js';
|
|
7
|
+
import { asyncApiMessageTraitObject } from './message-trait.js';
|
|
8
|
+
import { asyncApiOperationObject } from './operation.js';
|
|
9
|
+
import { asyncApiOperationReplyObject } from './operation-reply.js';
|
|
10
|
+
import { asyncApiOperationReplyAddressObject } from './operation-reply-address.js';
|
|
11
|
+
import { asyncApiOperationTraitObject } from './operation-trait.js';
|
|
12
|
+
import { asyncApiParameterObject } from './parameter.js';
|
|
13
|
+
import { recursiveRef } from './reference.js';
|
|
14
|
+
import { asyncApiSchemaPayload } from './schema-payload.js';
|
|
15
|
+
import { asyncApiSecuritySchemeObject } from './security-scheme.js';
|
|
16
|
+
import { asyncApiServerObject } from './server.js';
|
|
17
|
+
import { asyncApiServerVariableObject } from './server-variable.js';
|
|
18
|
+
import { asyncApiTagObject } from './tag.js';
|
|
19
|
+
export const asyncApiComponentsObject = lazy(() => object({
|
|
20
|
+
schemas: optional(record(string(), asyncApiSchemaPayload, {
|
|
21
|
+
typeComment: 'Reusable Multi Format Schema, Schema Object, or Reference Object.',
|
|
22
|
+
})),
|
|
23
|
+
servers: optional(record(string(), asyncApiServerObject)),
|
|
24
|
+
channels: optional(record(string(), asyncApiChannelObject)),
|
|
25
|
+
operations: optional(record(string(), asyncApiOperationObject)),
|
|
26
|
+
messages: optional(record(string(), asyncApiMessageObject)),
|
|
27
|
+
securitySchemes: optional(record(string(), asyncApiSecuritySchemeObject)),
|
|
28
|
+
serverVariables: optional(record(string(), asyncApiServerVariableObject)),
|
|
29
|
+
parameters: optional(record(string(), asyncApiParameterObject)),
|
|
30
|
+
correlationIds: optional(record(string(), asyncApiCorrelationIdObject)),
|
|
31
|
+
replies: optional(record(string(), asyncApiOperationReplyObject)),
|
|
32
|
+
replyAddresses: optional(record(string(), asyncApiOperationReplyAddressObject)),
|
|
33
|
+
externalDocs: optional(record(string(), asyncApiExternalDocumentationObject)),
|
|
34
|
+
tags: optional(record(string(), asyncApiTagObject)),
|
|
35
|
+
operationTraits: optional(record(string(), asyncApiOperationTraitObject)),
|
|
36
|
+
messageTraits: optional(record(string(), asyncApiMessageTraitObject)),
|
|
37
|
+
serverBindings: optional(record(string(), recursiveRef(asyncApiServerBindingsObject))),
|
|
38
|
+
channelBindings: optional(record(string(), recursiveRef(asyncApiChannelBindingsObject))),
|
|
39
|
+
operationBindings: optional(record(string(), recursiveRef(asyncApiOperationBindingsObject))),
|
|
40
|
+
messageBindings: optional(record(string(), recursiveRef(asyncApiMessageBindingsObject))),
|
|
41
|
+
}, {
|
|
42
|
+
typeName: 'AsyncApiComponentsObject',
|
|
43
|
+
typeComment: 'Reusable objects. Definitions here have no effect unless referenced from outside components.',
|
|
44
|
+
}));
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
export declare const asyncApiContactObject: import("@scalar/validation").ObjectSchema<{
|
|
2
|
+
name: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
3
|
+
url: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
4
|
+
email: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
5
|
+
}>;
|
|
6
|
+
//# sourceMappingURL=contact.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"contact.d.ts","sourceRoot":"","sources":["../../../src/asyncapi/3.1/contact.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,qBAAqB;;;;EAWjC,CAAA"}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import { object, optional, string } from '@scalar/validation';
|
|
2
|
+
export const asyncApiContactObject = object({
|
|
3
|
+
name: optional(string({ typeComment: 'The identifying name of the contact person/organization.' })),
|
|
4
|
+
url: optional(string({
|
|
5
|
+
typeComment: 'The URL pointing to the contact information. This MUST be in the form of an absolute URL.',
|
|
6
|
+
})),
|
|
7
|
+
email: optional(string({ typeComment: 'The email address of the contact person/organization.' })),
|
|
8
|
+
}, { typeName: 'AsyncApiContactObject' });
|