@scalar/workspace-store 0.16.0 → 0.16.2
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/client.d.ts +1 -1
- package/dist/client.d.ts.map +1 -1
- package/dist/client.js +2 -2
- package/dist/client.js.map +2 -2
- package/dist/mutators/index.d.ts +6 -24
- package/dist/mutators/index.d.ts.map +1 -1
- package/dist/mutators/index.js +0 -2
- package/dist/mutators/index.js.map +2 -2
- package/dist/navigation/helpers/traverse-description.d.ts +1 -1
- package/dist/navigation/helpers/traverse-description.d.ts.map +1 -1
- package/dist/navigation/helpers/traverse-description.js.map +1 -1
- package/dist/navigation/helpers/traverse-document.d.ts +2 -182
- package/dist/navigation/helpers/traverse-document.d.ts.map +1 -1
- package/dist/navigation/helpers/traverse-document.js.map +2 -2
- package/dist/navigation/helpers/traverse-paths.d.ts.map +1 -1
- package/dist/navigation/helpers/traverse-paths.js +1 -1
- package/dist/navigation/helpers/traverse-paths.js.map +2 -2
- package/dist/navigation/helpers/traverse-schemas.d.ts +2 -1
- package/dist/navigation/helpers/traverse-schemas.d.ts.map +1 -1
- package/dist/navigation/helpers/traverse-schemas.js.map +2 -2
- package/dist/navigation/helpers/traverse-tags.d.ts +2 -1
- package/dist/navigation/helpers/traverse-tags.d.ts.map +1 -1
- package/dist/navigation/helpers/traverse-tags.js +1 -0
- package/dist/navigation/helpers/traverse-tags.js.map +2 -2
- package/dist/navigation/helpers/traverse-webhooks.d.ts +2 -1
- package/dist/navigation/helpers/traverse-webhooks.d.ts.map +1 -1
- package/dist/navigation/helpers/traverse-webhooks.js +1 -1
- package/dist/navigation/helpers/traverse-webhooks.js.map +2 -2
- package/dist/navigation/types.d.ts +2 -1
- package/dist/navigation/types.d.ts.map +1 -1
- package/dist/schemas/extensions/document/x-internal.d.ts +4 -0
- package/dist/schemas/extensions/document/x-internal.d.ts.map +1 -1
- package/dist/schemas/extensions/document/x-internal.js.map +1 -1
- package/dist/schemas/extensions/document/x-scalar-icon.d.ts +4 -0
- package/dist/schemas/extensions/document/x-scalar-icon.d.ts.map +1 -1
- package/dist/schemas/extensions/document/x-scalar-icon.js.map +1 -1
- package/dist/schemas/extensions/document/x-scalar-ignore.d.ts +4 -0
- package/dist/schemas/extensions/document/x-scalar-ignore.d.ts.map +1 -1
- package/dist/schemas/extensions/document/x-scalar-ignore.js.map +1 -1
- package/dist/schemas/extensions/document/x-scalar-sdk-installation.d.ts +8 -2
- package/dist/schemas/extensions/document/x-scalar-sdk-installation.d.ts.map +1 -1
- package/dist/schemas/extensions/document/x-scalar-sdk-installation.js.map +2 -2
- package/dist/schemas/extensions/document/x-tags.d.ts +3 -0
- package/dist/schemas/extensions/document/x-tags.d.ts.map +1 -1
- package/dist/schemas/extensions/document/x-tags.js.map +1 -1
- package/dist/schemas/extensions/operation/x-badge.d.ts +62 -22
- package/dist/schemas/extensions/operation/x-badge.d.ts.map +1 -1
- package/dist/schemas/extensions/operation/x-badge.js +24 -3
- package/dist/schemas/extensions/operation/x-badge.js.map +2 -2
- package/dist/schemas/extensions/operation/x-code-samples.d.ts +10 -2
- package/dist/schemas/extensions/operation/x-code-samples.d.ts.map +1 -1
- package/dist/schemas/extensions/operation/x-code-samples.js.map +2 -2
- package/dist/schemas/extensions/operation/x-post-response.d.ts +18 -0
- package/dist/schemas/extensions/operation/x-post-response.d.ts.map +1 -1
- package/dist/schemas/extensions/operation/x-post-response.js.map +1 -1
- package/dist/schemas/extensions/operation/x-scalar-stability.d.ts +11 -0
- package/dist/schemas/extensions/operation/x-scalar-stability.d.ts.map +1 -1
- package/dist/schemas/extensions/operation/x-scalar-stability.js.map +1 -1
- package/dist/schemas/extensions/schema/x-additional-properties-name.d.ts +10 -0
- package/dist/schemas/extensions/schema/x-additional-properties-name.d.ts.map +1 -1
- package/dist/schemas/extensions/schema/x-additional-properties-name.js.map +1 -1
- package/dist/schemas/extensions/schema/x-enum-descriptions.d.ts +30 -0
- package/dist/schemas/extensions/schema/x-enum-descriptions.d.ts.map +1 -1
- package/dist/schemas/extensions/schema/x-enum-descriptions.js.map +1 -1
- package/dist/schemas/extensions/schema/x-enum-varnames.d.ts +38 -0
- package/dist/schemas/extensions/schema/x-enum-varnames.d.ts.map +1 -1
- package/dist/schemas/extensions/schema/x-enum-varnames.js.map +1 -1
- package/dist/schemas/extensions/schema/x-variable.d.ts +3 -0
- package/dist/schemas/extensions/schema/x-variable.d.ts.map +1 -1
- package/dist/schemas/extensions/schema/x-variable.js.map +1 -1
- package/dist/schemas/extensions/security/x-default-scopes.d.ts +16 -0
- package/dist/schemas/extensions/security/x-default-scopes.d.ts.map +1 -1
- package/dist/schemas/extensions/security/x-default-scopes.js.map +1 -1
- package/dist/schemas/extensions/security/x-scalar-credentials-location.d.ts +16 -0
- package/dist/schemas/extensions/security/x-scalar-credentials-location.d.ts.map +1 -1
- package/dist/schemas/extensions/security/x-scalar-credentials-location.js.map +1 -1
- package/dist/schemas/extensions/security/x-scalar-security-body.d.ts +15 -1
- package/dist/schemas/extensions/security/x-scalar-security-body.d.ts.map +1 -1
- package/dist/schemas/extensions/security/x-scalar-security-body.js +2 -2
- package/dist/schemas/extensions/security/x-scalar-security-body.js.map +2 -2
- package/dist/schemas/extensions/security/x-scalar-security-query.d.ts +15 -1
- package/dist/schemas/extensions/security/x-scalar-security-query.d.ts.map +1 -1
- package/dist/schemas/extensions/security/x-scalar-security-query.js +2 -2
- package/dist/schemas/extensions/security/x-scalar-security-query.js.map +2 -2
- package/dist/schemas/extensions/security/x-scalar-security-secrets.d.ts +41 -0
- package/dist/schemas/extensions/security/x-scalar-security-secrets.d.ts.map +1 -1
- package/dist/schemas/extensions/security/x-scalar-security-secrets.js.map +2 -2
- package/dist/schemas/extensions/security/x-tokenName.d.ts +12 -1
- package/dist/schemas/extensions/security/x-tokenName.d.ts.map +1 -1
- package/dist/schemas/extensions/security/x-tokenName.js +2 -2
- package/dist/schemas/extensions/security/x-tokenName.js.map +2 -2
- package/dist/schemas/extensions/security/x-use-pkce.d.ts +6 -0
- package/dist/schemas/extensions/security/x-use-pkce.d.ts.map +1 -1
- package/dist/schemas/extensions/security/x-use-pkce.js.map +1 -1
- package/dist/schemas/extensions/tag/x-display-name.d.ts +11 -0
- package/dist/schemas/extensions/tag/x-display-name.d.ts.map +1 -1
- package/dist/schemas/extensions/tag/x-display-name.js.map +1 -1
- package/dist/schemas/extensions/tag/x-tag-groups.d.ts +18 -0
- package/dist/schemas/extensions/tag/x-tag-groups.d.ts.map +1 -1
- package/dist/schemas/extensions/tag/x-tag-groups.js.map +2 -2
- package/dist/schemas/inmemory-workspace.d.ts +57 -54
- package/dist/schemas/inmemory-workspace.d.ts.map +1 -1
- package/dist/schemas/inmemory-workspace.js +4 -1
- package/dist/schemas/inmemory-workspace.js.map +2 -2
- package/dist/schemas/navigation.d.ts +50 -1
- package/dist/schemas/navigation.d.ts.map +1 -1
- package/dist/schemas/navigation.js +5 -9
- package/dist/schemas/navigation.js.map +2 -2
- package/dist/schemas/reference-config/appearance.d.ts +9 -2
- package/dist/schemas/reference-config/appearance.d.ts.map +1 -1
- package/dist/schemas/reference-config/appearance.js.map +2 -2
- package/dist/schemas/reference-config/features.d.ts +11 -2
- package/dist/schemas/reference-config/features.d.ts.map +1 -1
- package/dist/schemas/reference-config/features.js.map +2 -2
- package/dist/schemas/reference-config/index.d.ts +39 -29
- package/dist/schemas/reference-config/index.d.ts.map +1 -1
- package/dist/schemas/reference-config/index.js +5 -5
- package/dist/schemas/reference-config/index.js.map +2 -2
- package/dist/schemas/reference-config/meta.d.ts +8 -2
- package/dist/schemas/reference-config/meta.d.ts.map +1 -1
- package/dist/schemas/reference-config/meta.js.map +2 -2
- package/dist/schemas/reference-config/routing.d.ts +4 -2
- package/dist/schemas/reference-config/routing.d.ts.map +1 -1
- package/dist/schemas/reference-config/routing.js.map +2 -2
- package/dist/schemas/reference-config/settings.d.ts +30 -29
- package/dist/schemas/reference-config/settings.d.ts.map +1 -1
- package/dist/schemas/reference-config/settings.js.map +2 -2
- package/dist/schemas/v3.1/strict/callback.d.ts +4 -0
- package/dist/schemas/v3.1/strict/callback.d.ts.map +1 -1
- package/dist/schemas/v3.1/strict/callback.js +2 -2
- package/dist/schemas/v3.1/strict/callback.js.map +2 -2
- package/dist/schemas/v3.1/strict/client-config-extensions/x-scalar-client-config-cookies.d.ts +19 -3
- package/dist/schemas/v3.1/strict/client-config-extensions/x-scalar-client-config-cookies.d.ts.map +1 -1
- package/dist/schemas/v3.1/strict/client-config-extensions/x-scalar-client-config-cookies.js.map +2 -2
- package/dist/schemas/v3.1/strict/client-config-extensions/x-scalar-client-config-environments.d.ts +10 -4
- package/dist/schemas/v3.1/strict/client-config-extensions/x-scalar-client-config-environments.d.ts.map +1 -1
- package/dist/schemas/v3.1/strict/client-config-extensions/x-scalar-client-config-environments.js.map +2 -2
- package/dist/schemas/v3.1/strict/components.d.ts +34 -0
- package/dist/schemas/v3.1/strict/components.d.ts.map +1 -1
- package/dist/schemas/v3.1/strict/components.js +1 -1
- package/dist/schemas/v3.1/strict/components.js.map +2 -2
- package/dist/schemas/v3.1/strict/contact.d.ts +9 -0
- package/dist/schemas/v3.1/strict/contact.d.ts.map +1 -1
- package/dist/schemas/v3.1/strict/contact.js.map +1 -1
- package/dist/schemas/v3.1/strict/discriminator.d.ts +11 -0
- package/dist/schemas/v3.1/strict/discriminator.d.ts.map +1 -1
- package/dist/schemas/v3.1/strict/discriminator.js.map +1 -1
- package/dist/schemas/v3.1/strict/encoding.d.ts +15 -0
- package/dist/schemas/v3.1/strict/encoding.d.ts.map +1 -1
- package/dist/schemas/v3.1/strict/encoding.js +1 -1
- package/dist/schemas/v3.1/strict/encoding.js.map +2 -2
- package/dist/schemas/v3.1/strict/example.d.ts +15 -0
- package/dist/schemas/v3.1/strict/example.d.ts.map +1 -1
- package/dist/schemas/v3.1/strict/example.js.map +1 -1
- package/dist/schemas/v3.1/strict/external-documentation.d.ts +9 -2
- package/dist/schemas/v3.1/strict/external-documentation.d.ts.map +1 -1
- package/dist/schemas/v3.1/strict/external-documentation.js +3 -3
- package/dist/schemas/v3.1/strict/external-documentation.js.map +2 -2
- package/dist/schemas/v3.1/strict/header.d.ts +41 -0
- package/dist/schemas/v3.1/strict/header.d.ts.map +1 -1
- package/dist/schemas/v3.1/strict/header.js +2 -2
- package/dist/schemas/v3.1/strict/header.js.map +2 -2
- package/dist/schemas/v3.1/strict/info.d.ts +24 -2
- package/dist/schemas/v3.1/strict/info.d.ts.map +1 -1
- package/dist/schemas/v3.1/strict/info.js +7 -5
- package/dist/schemas/v3.1/strict/info.js.map +2 -2
- package/dist/schemas/v3.1/strict/license.d.ts +9 -0
- package/dist/schemas/v3.1/strict/license.d.ts.map +1 -1
- package/dist/schemas/v3.1/strict/license.js.map +1 -1
- package/dist/schemas/v3.1/strict/link.d.ts +22 -0
- package/dist/schemas/v3.1/strict/link.d.ts.map +1 -1
- package/dist/schemas/v3.1/strict/link.js.map +2 -2
- package/dist/schemas/v3.1/strict/media-type.d.ts +19 -0
- package/dist/schemas/v3.1/strict/media-type.d.ts.map +1 -1
- package/dist/schemas/v3.1/strict/media-type.js +2 -2
- package/dist/schemas/v3.1/strict/media-type.js.map +2 -2
- package/dist/schemas/v3.1/strict/oauth-flow.d.ts +36 -5
- package/dist/schemas/v3.1/strict/oauth-flow.d.ts.map +1 -1
- package/dist/schemas/v3.1/strict/oauth-flow.js +13 -7
- package/dist/schemas/v3.1/strict/oauth-flow.js.map +2 -2
- package/dist/schemas/v3.1/strict/oauthflows.d.ts +11 -0
- package/dist/schemas/v3.1/strict/oauthflows.d.ts.map +1 -1
- package/dist/schemas/v3.1/strict/oauthflows.js.map +2 -2
- package/dist/schemas/v3.1/strict/openapi-document.d.ts +819 -932
- package/dist/schemas/v3.1/strict/openapi-document.d.ts.map +1 -1
- package/dist/schemas/v3.1/strict/openapi-document.js +45 -45
- package/dist/schemas/v3.1/strict/openapi-document.js.map +2 -2
- package/dist/schemas/v3.1/strict/operation.d.ts +43 -17
- package/dist/schemas/v3.1/strict/operation.d.ts.map +1 -1
- package/dist/schemas/v3.1/strict/operation.js +1 -3
- package/dist/schemas/v3.1/strict/operation.js.map +2 -2
- package/dist/schemas/v3.1/strict/parameter.d.ts +45 -0
- package/dist/schemas/v3.1/strict/parameter.d.ts.map +1 -1
- package/dist/schemas/v3.1/strict/parameter.js.map +2 -2
- package/dist/schemas/v3.1/strict/path-item.d.ts +38 -0
- package/dist/schemas/v3.1/strict/path-item.d.ts.map +1 -1
- package/dist/schemas/v3.1/strict/path-item.js +1 -1
- package/dist/schemas/v3.1/strict/path-item.js.map +2 -2
- package/dist/schemas/v3.1/strict/paths.d.ts +5 -0
- package/dist/schemas/v3.1/strict/paths.d.ts.map +1 -1
- package/dist/schemas/v3.1/strict/paths.js +1 -1
- package/dist/schemas/v3.1/strict/paths.js.map +2 -2
- package/dist/schemas/v3.1/strict/reference.d.ts +21 -4
- package/dist/schemas/v3.1/strict/reference.d.ts.map +1 -1
- package/dist/schemas/v3.1/strict/reference.js.map +2 -2
- package/dist/schemas/v3.1/strict/request-body.d.ts +10 -0
- package/dist/schemas/v3.1/strict/request-body.d.ts.map +1 -1
- package/dist/schemas/v3.1/strict/request-body.js +1 -1
- package/dist/schemas/v3.1/strict/request-body.js.map +2 -2
- package/dist/schemas/v3.1/strict/response.d.ts +17 -0
- package/dist/schemas/v3.1/strict/response.d.ts.map +1 -1
- package/dist/schemas/v3.1/strict/response.js +1 -1
- package/dist/schemas/v3.1/strict/response.js.map +2 -2
- package/dist/schemas/v3.1/strict/responses.d.ts +12 -0
- package/dist/schemas/v3.1/strict/responses.d.ts.map +1 -1
- package/dist/schemas/v3.1/strict/responses.js +1 -1
- package/dist/schemas/v3.1/strict/responses.js.map +2 -2
- package/dist/schemas/v3.1/strict/schema.d.ts +144 -1
- package/dist/schemas/v3.1/strict/schema.d.ts.map +1 -1
- package/dist/schemas/v3.1/strict/schema.js +40 -60
- package/dist/schemas/v3.1/strict/schema.js.map +2 -2
- package/dist/schemas/v3.1/strict/security-requirement.d.ts +12 -0
- package/dist/schemas/v3.1/strict/security-requirement.d.ts.map +1 -1
- package/dist/schemas/v3.1/strict/security-requirement.js.map +1 -1
- package/dist/schemas/v3.1/strict/security-scheme.d.ts +37 -0
- package/dist/schemas/v3.1/strict/security-scheme.d.ts.map +1 -1
- package/dist/schemas/v3.1/strict/security-scheme.js.map +2 -2
- package/dist/schemas/v3.1/strict/server-variable.d.ts +9 -0
- package/dist/schemas/v3.1/strict/server-variable.d.ts.map +1 -1
- package/dist/schemas/v3.1/strict/server-variable.js.map +1 -1
- package/dist/schemas/v3.1/strict/server.d.ts +10 -0
- package/dist/schemas/v3.1/strict/server.d.ts.map +1 -1
- package/dist/schemas/v3.1/strict/server.js +1 -1
- package/dist/schemas/v3.1/strict/server.js.map +2 -2
- package/dist/schemas/v3.1/strict/tag.d.ts +13 -0
- package/dist/schemas/v3.1/strict/tag.d.ts.map +1 -1
- package/dist/schemas/v3.1/strict/tag.js +1 -1
- package/dist/schemas/v3.1/strict/tag.js.map +2 -2
- package/dist/schemas/v3.1/strict/type-guards.d.ts +1 -1
- package/dist/schemas/v3.1/strict/type-guards.d.ts.map +1 -1
- package/dist/schemas/v3.1/strict/type-guards.js.map +1 -1
- package/dist/schemas/v3.1/strict/xml.d.ts +17 -0
- package/dist/schemas/v3.1/strict/xml.d.ts.map +1 -1
- package/dist/schemas/v3.1/strict/xml.js.map +1 -1
- package/dist/schemas/workspace-specification/config.d.ts +26 -28
- package/dist/schemas/workspace-specification/config.d.ts.map +1 -1
- package/dist/schemas/workspace-specification/config.js.map +2 -2
- package/dist/schemas/workspace-specification/index.d.ts +35 -28
- package/dist/schemas/workspace-specification/index.d.ts.map +1 -1
- package/dist/schemas/workspace-specification/index.js.map +2 -2
- package/dist/schemas/workspace-specification/info.d.ts +4 -0
- package/dist/schemas/workspace-specification/info.d.ts.map +1 -1
- package/dist/schemas/workspace-specification/info.js.map +1 -1
- package/dist/schemas/workspace.d.ts +182 -188
- package/dist/schemas/workspace.d.ts.map +1 -1
- package/dist/schemas/workspace.js +11 -3
- package/dist/schemas/workspace.js.map +2 -2
- package/dist/server.d.ts +6 -5
- package/dist/server.d.ts.map +1 -1
- package/dist/server.js.map +2 -2
- package/package.json +5 -5
- package/dist/mutators/request-example.d.ts +0 -21
- package/dist/mutators/request-example.d.ts.map +0 -1
- package/dist/mutators/request-example.js +0 -55
- package/dist/mutators/request-example.js.map +0 -7
- package/dist/schemas/extensions/security/x-scalar-redirect-uri.d.ts +0 -9
- package/dist/schemas/extensions/security/x-scalar-redirect-uri.d.ts.map +0 -1
- package/dist/schemas/extensions/security/x-scalar-redirect-uri.js +0 -8
- package/dist/schemas/extensions/security/x-scalar-redirect-uri.js.map +0 -7
- package/dist/schemas/v3.1/strict/client-config-extensions/x-scalar-client-config-request-example.d.ts +0 -38
- package/dist/schemas/v3.1/strict/client-config-extensions/x-scalar-client-config-request-example.d.ts.map +0 -1
- package/dist/schemas/v3.1/strict/client-config-extensions/x-scalar-client-config-request-example.js +0 -45
- package/dist/schemas/v3.1/strict/client-config-extensions/x-scalar-client-config-request-example.js.map +0 -7
- package/dist/types.d.ts +0 -18
- package/dist/types.d.ts.map +0 -1
- package/dist/types.js +0 -1
- package/dist/types.js.map +0 -7
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import type { TraversedEntry } from '../../schemas/navigation.js';
|
|
1
2
|
import type { OpenApiDocument } from '../../schemas/v3.1/strict/openapi-document.js';
|
|
2
3
|
import type { DocumentConfiguration } from '../../schemas/workspace-specification/config.js';
|
|
3
4
|
/**
|
|
@@ -10,187 +11,6 @@ import type { DocumentConfiguration } from '../../schemas/workspace-specificatio
|
|
|
10
11
|
* - Optional schema/model documentation
|
|
11
12
|
*/
|
|
12
13
|
export declare const traverseDocument: (document: OpenApiDocument, config?: DocumentConfiguration) => {
|
|
13
|
-
entries:
|
|
14
|
-
id: string;
|
|
15
|
-
title: string;
|
|
16
|
-
} & {
|
|
17
|
-
children?: (({
|
|
18
|
-
id: string;
|
|
19
|
-
title: string;
|
|
20
|
-
} & /*elided*/ any) | ({
|
|
21
|
-
id: string;
|
|
22
|
-
title: string;
|
|
23
|
-
} & {
|
|
24
|
-
children?: (({
|
|
25
|
-
id: string;
|
|
26
|
-
title: string;
|
|
27
|
-
} & /*elided*/ any) | ({
|
|
28
|
-
id: string;
|
|
29
|
-
title: string;
|
|
30
|
-
} & /*elided*/ any) | ({
|
|
31
|
-
id: string;
|
|
32
|
-
title: string;
|
|
33
|
-
} & {
|
|
34
|
-
isDeprecated?: boolean | undefined;
|
|
35
|
-
type: "operation";
|
|
36
|
-
ref: string;
|
|
37
|
-
path: string;
|
|
38
|
-
method: "delete" | "connect" | "get" | "head" | "options" | "patch" | "post" | "put" | "trace";
|
|
39
|
-
}) | ({
|
|
40
|
-
id: string;
|
|
41
|
-
title: string;
|
|
42
|
-
} & {
|
|
43
|
-
type: "model";
|
|
44
|
-
ref: string;
|
|
45
|
-
name: string;
|
|
46
|
-
}) | ({
|
|
47
|
-
id: string;
|
|
48
|
-
title: string;
|
|
49
|
-
} & {
|
|
50
|
-
isDeprecated?: boolean | undefined;
|
|
51
|
-
type: "webhook";
|
|
52
|
-
ref: string;
|
|
53
|
-
method: "delete" | "connect" | "get" | "head" | "options" | "patch" | "post" | "put" | "trace";
|
|
54
|
-
name: string;
|
|
55
|
-
}))[] | undefined;
|
|
56
|
-
description?: string | undefined;
|
|
57
|
-
isWebhooks?: boolean | undefined;
|
|
58
|
-
xKeys?: {
|
|
59
|
-
[x: string]: unknown;
|
|
60
|
-
} | undefined;
|
|
61
|
-
type: "tag";
|
|
62
|
-
name: string;
|
|
63
|
-
isGroup: boolean;
|
|
64
|
-
}) | ({
|
|
65
|
-
id: string;
|
|
66
|
-
title: string;
|
|
67
|
-
} & {
|
|
68
|
-
isDeprecated?: boolean | undefined;
|
|
69
|
-
type: "operation";
|
|
70
|
-
ref: string;
|
|
71
|
-
path: string;
|
|
72
|
-
method: "delete" | "connect" | "get" | "head" | "options" | "patch" | "post" | "put" | "trace";
|
|
73
|
-
}) | ({
|
|
74
|
-
id: string;
|
|
75
|
-
title: string;
|
|
76
|
-
} & {
|
|
77
|
-
type: "model";
|
|
78
|
-
ref: string;
|
|
79
|
-
name: string;
|
|
80
|
-
}) | ({
|
|
81
|
-
id: string;
|
|
82
|
-
title: string;
|
|
83
|
-
} & {
|
|
84
|
-
isDeprecated?: boolean | undefined;
|
|
85
|
-
type: "webhook";
|
|
86
|
-
ref: string;
|
|
87
|
-
method: "delete" | "connect" | "get" | "head" | "options" | "patch" | "post" | "put" | "trace";
|
|
88
|
-
name: string;
|
|
89
|
-
}))[] | undefined;
|
|
90
|
-
type: "text";
|
|
91
|
-
}) | ({
|
|
92
|
-
id: string;
|
|
93
|
-
title: string;
|
|
94
|
-
} & {
|
|
95
|
-
children?: (({
|
|
96
|
-
id: string;
|
|
97
|
-
title: string;
|
|
98
|
-
} & {
|
|
99
|
-
children?: (({
|
|
100
|
-
id: string;
|
|
101
|
-
title: string;
|
|
102
|
-
} & /*elided*/ any) | ({
|
|
103
|
-
id: string;
|
|
104
|
-
title: string;
|
|
105
|
-
} & /*elided*/ any) | ({
|
|
106
|
-
id: string;
|
|
107
|
-
title: string;
|
|
108
|
-
} & {
|
|
109
|
-
isDeprecated?: boolean | undefined;
|
|
110
|
-
type: "operation";
|
|
111
|
-
ref: string;
|
|
112
|
-
path: string;
|
|
113
|
-
method: "delete" | "connect" | "get" | "head" | "options" | "patch" | "post" | "put" | "trace";
|
|
114
|
-
}) | ({
|
|
115
|
-
id: string;
|
|
116
|
-
title: string;
|
|
117
|
-
} & {
|
|
118
|
-
type: "model";
|
|
119
|
-
ref: string;
|
|
120
|
-
name: string;
|
|
121
|
-
}) | ({
|
|
122
|
-
id: string;
|
|
123
|
-
title: string;
|
|
124
|
-
} & {
|
|
125
|
-
isDeprecated?: boolean | undefined;
|
|
126
|
-
type: "webhook";
|
|
127
|
-
ref: string;
|
|
128
|
-
method: "delete" | "connect" | "get" | "head" | "options" | "patch" | "post" | "put" | "trace";
|
|
129
|
-
name: string;
|
|
130
|
-
}))[] | undefined;
|
|
131
|
-
type: "text";
|
|
132
|
-
}) | ({
|
|
133
|
-
id: string;
|
|
134
|
-
title: string;
|
|
135
|
-
} & /*elided*/ any) | ({
|
|
136
|
-
id: string;
|
|
137
|
-
title: string;
|
|
138
|
-
} & {
|
|
139
|
-
isDeprecated?: boolean | undefined;
|
|
140
|
-
type: "operation";
|
|
141
|
-
ref: string;
|
|
142
|
-
path: string;
|
|
143
|
-
method: "delete" | "connect" | "get" | "head" | "options" | "patch" | "post" | "put" | "trace";
|
|
144
|
-
}) | ({
|
|
145
|
-
id: string;
|
|
146
|
-
title: string;
|
|
147
|
-
} & {
|
|
148
|
-
type: "model";
|
|
149
|
-
ref: string;
|
|
150
|
-
name: string;
|
|
151
|
-
}) | ({
|
|
152
|
-
id: string;
|
|
153
|
-
title: string;
|
|
154
|
-
} & {
|
|
155
|
-
isDeprecated?: boolean | undefined;
|
|
156
|
-
type: "webhook";
|
|
157
|
-
ref: string;
|
|
158
|
-
method: "delete" | "connect" | "get" | "head" | "options" | "patch" | "post" | "put" | "trace";
|
|
159
|
-
name: string;
|
|
160
|
-
}))[] | undefined;
|
|
161
|
-
description?: string | undefined;
|
|
162
|
-
isWebhooks?: boolean | undefined;
|
|
163
|
-
xKeys?: {
|
|
164
|
-
[x: string]: unknown;
|
|
165
|
-
} | undefined;
|
|
166
|
-
type: "tag";
|
|
167
|
-
name: string;
|
|
168
|
-
isGroup: boolean;
|
|
169
|
-
}) | ({
|
|
170
|
-
id: string;
|
|
171
|
-
title: string;
|
|
172
|
-
} & {
|
|
173
|
-
isDeprecated?: boolean | undefined;
|
|
174
|
-
type: "operation";
|
|
175
|
-
ref: string;
|
|
176
|
-
path: string;
|
|
177
|
-
method: "delete" | "connect" | "get" | "head" | "options" | "patch" | "post" | "put" | "trace";
|
|
178
|
-
}) | ({
|
|
179
|
-
id: string;
|
|
180
|
-
title: string;
|
|
181
|
-
} & {
|
|
182
|
-
type: "model";
|
|
183
|
-
ref: string;
|
|
184
|
-
name: string;
|
|
185
|
-
}) | ({
|
|
186
|
-
id: string;
|
|
187
|
-
title: string;
|
|
188
|
-
} & {
|
|
189
|
-
isDeprecated?: boolean | undefined;
|
|
190
|
-
type: "webhook";
|
|
191
|
-
ref: string;
|
|
192
|
-
method: "delete" | "connect" | "get" | "head" | "options" | "patch" | "post" | "put" | "trace";
|
|
193
|
-
name: string;
|
|
194
|
-
}))[];
|
|
14
|
+
entries: TraversedEntry[];
|
|
195
15
|
};
|
|
196
16
|
//# sourceMappingURL=traverse-document.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"traverse-document.d.ts","sourceRoot":"","sources":["../../../src/navigation/helpers/traverse-document.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,
|
|
1
|
+
{"version":3,"file":"traverse-document.d.ts","sourceRoot":"","sources":["../../../src/navigation/helpers/traverse-document.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAC1D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,wCAAwC,CAAA;AAC7E,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,0CAA0C,CAAA;AAQrF;;;;;;;;GAQG;AACH,eAAO,MAAM,gBAAgB,GAAI,UAAU,eAAe,EAAE,SAAS,qBAAqB;;CAiDzF,CAAA"}
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"version": 3,
|
|
3
3
|
"sources": ["../../../src/navigation/helpers/traverse-document.ts"],
|
|
4
|
-
"sourcesContent": ["import { getNavigationOptions } from '@/navigation/get-navigation-options'\nimport type { TagsMap } from '@/navigation/types'\nimport type {
|
|
5
|
-
"mappings": "AAAA,SAAS,4BAA4B;
|
|
4
|
+
"sourcesContent": ["import { getNavigationOptions } from '@/navigation/get-navigation-options'\nimport type { TagsMap } from '@/navigation/types'\nimport type { TraversedEntry } from '@/schemas/navigation'\nimport type { OpenApiDocument } from '@/schemas/v3.1/strict/openapi-document'\nimport type { DocumentConfiguration } from '@/schemas/workspace-specification/config'\n\nimport { traverseDescription } from './traverse-description'\nimport { traversePaths } from './traverse-paths'\nimport { traverseSchemas } from './traverse-schemas'\nimport { traverseTags } from './traverse-tags'\nimport { traverseWebhooks } from './traverse-webhooks'\n\n/**\n * Traverses an OpenAPI Document to generate navigation structure and metadata.\n *\n * This function processes the OpenAPI document to create:\n * - A hierarchical navigation structure for the sidebar\n * - A mapping of IDs to titles for mobile header navigation\n * - Tag-based organization of operations and webhooks\n * - Optional schema/model documentation\n */\nexport const traverseDocument = (document: OpenApiDocument, config?: DocumentConfiguration) => {\n const { hideModels, tagsSorter, operationsSorter, getHeadingId, getOperationId, getWebhookId, getModelId, getTagId } =\n getNavigationOptions(config)\n\n /** Map of tags and their entries */\n const tagsMap: TagsMap = new Map(\n document.tags?.map((tag) => [tag.name ?? 'Untitled Tag', { tag, entries: [] }]) ?? [],\n )\n\n const entries: TraversedEntry[] = traverseDescription(document.info?.description, getHeadingId)\n traversePaths(document, tagsMap, getOperationId)\n const untaggedWebhooks = traverseWebhooks(document, tagsMap, getWebhookId)\n const tagsEntries = traverseTags(document, tagsMap, {\n getTagId,\n tagsSorter,\n operationsSorter,\n })\n\n // Add tagged operations, webhooks and tagGroups\n entries.push(...tagsEntries)\n\n // Add untagged webhooks\n if (untaggedWebhooks.length) {\n entries.push({\n type: 'tag',\n id: getWebhookId({ name: '' }),\n title: 'Webhooks',\n name: 'Webhooks',\n children: untaggedWebhooks,\n isGroup: false,\n isWebhooks: true,\n })\n }\n\n // Add models if they are not hidden\n if (!hideModels && document.components?.schemas) {\n const untaggedModels = traverseSchemas(document, tagsMap, getModelId)\n\n if (untaggedModels.length) {\n entries.push({\n type: 'text',\n id: 'models',\n title: 'Models',\n children: untaggedModels,\n })\n }\n }\n\n return { entries }\n}\n"],
|
|
5
|
+
"mappings": "AAAA,SAAS,4BAA4B;AAMrC,SAAS,2BAA2B;AACpC,SAAS,qBAAqB;AAC9B,SAAS,uBAAuB;AAChC,SAAS,oBAAoB;AAC7B,SAAS,wBAAwB;AAW1B,MAAM,mBAAmB,CAAC,UAA2B,WAAmC;AAC7F,QAAM,EAAE,YAAY,YAAY,kBAAkB,cAAc,gBAAgB,cAAc,YAAY,SAAS,IACjH,qBAAqB,MAAM;AAG7B,QAAM,UAAmB,IAAI;AAAA,IAC3B,SAAS,MAAM,IAAI,CAAC,QAAQ,CAAC,IAAI,QAAQ,gBAAgB,EAAE,KAAK,SAAS,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC;AAAA,EACtF;AAEA,QAAM,UAA4B,oBAAoB,SAAS,MAAM,aAAa,YAAY;AAC9F,gBAAc,UAAU,SAAS,cAAc;AAC/C,QAAM,mBAAmB,iBAAiB,UAAU,SAAS,YAAY;AACzE,QAAM,cAAc,aAAa,UAAU,SAAS;AAAA,IAClD;AAAA,IACA;AAAA,IACA;AAAA,EACF,CAAC;AAGD,UAAQ,KAAK,GAAG,WAAW;AAG3B,MAAI,iBAAiB,QAAQ;AAC3B,YAAQ,KAAK;AAAA,MACX,MAAM;AAAA,MACN,IAAI,aAAa,EAAE,MAAM,GAAG,CAAC;AAAA,MAC7B,OAAO;AAAA,MACP,MAAM;AAAA,MACN,UAAU;AAAA,MACV,SAAS;AAAA,MACT,YAAY;AAAA,IACd,CAAC;AAAA,EACH;AAGA,MAAI,CAAC,cAAc,SAAS,YAAY,SAAS;AAC/C,UAAM,iBAAiB,gBAAgB,UAAU,SAAS,UAAU;AAEpE,QAAI,eAAe,QAAQ;AACzB,cAAQ,KAAK;AAAA,QACX,MAAM;AAAA,QACN,IAAI;AAAA,QACJ,OAAO;AAAA,QACP,UAAU;AAAA,MACZ,CAAC;AAAA,IACH;AAAA,EACF;AAEA,SAAO,EAAE,QAAQ;AACnB;",
|
|
6
6
|
"names": []
|
|
7
7
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"traverse-paths.d.ts","sourceRoot":"","sources":["../../../src/navigation/helpers/traverse-paths.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,OAAO,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAA;
|
|
1
|
+
{"version":3,"file":"traverse-paths.d.ts","sourceRoot":"","sources":["../../../src/navigation/helpers/traverse-paths.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,OAAO,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAA;AAGtE,OAAO,KAAK,EAAE,eAAe,EAAE,eAAe,EAAa,MAAM,wCAAwC,CAAA;AAIzG,eAAO,MAAM,qBAAqB,GAAI,WAAW,eAAe,YAE/D,CAAA;AAwCD;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,aAAa,GACxB,SAAS,eAAe;AACxB,oCAAoC;AACpC,SAAS,OAAO,EAChB,gBAAgB,mBAAmB,CAAC,gBAAgB,CAAC,SAkCtD,CAAA"}
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"version": 3,
|
|
3
3
|
"sources": ["../../../src/navigation/helpers/traverse-paths.ts"],
|
|
4
|
-
"sourcesContent": ["import type { HttpMethod } from '@scalar/helpers/http/http-methods'\nimport { isHttpMethod } from '@scalar/helpers/http/is-http-method'\nimport { objectKeys } from '@scalar/helpers/object/object-keys'\nimport { escapeJsonPointer } from '@scalar/json-magic/helpers/escape-json-pointer'\n\nimport { getResolvedRef } from '@/helpers/get-resolved-ref'\nimport type { TagsMap, TraverseSpecOptions } from '@/navigation/types'\nimport { XScalarStabilityValues } from '@/schemas/extensions/operation/x-scalar-stability'\nimport type {\
|
|
5
|
-
"mappings": "AACA,SAAS,oBAAoB;AAC7B,SAAS,kBAAkB;AAC3B,SAAS,yBAAyB;AAElC,SAAS,sBAAsB;AAE/B,SAAS,8BAA8B;
|
|
4
|
+
"sourcesContent": ["import type { HttpMethod } from '@scalar/helpers/http/http-methods'\nimport { isHttpMethod } from '@scalar/helpers/http/is-http-method'\nimport { objectKeys } from '@scalar/helpers/object/object-keys'\nimport { escapeJsonPointer } from '@scalar/json-magic/helpers/escape-json-pointer'\n\nimport { getResolvedRef } from '@/helpers/get-resolved-ref'\nimport type { TagsMap, TraverseSpecOptions } from '@/navigation/types'\nimport { XScalarStabilityValues } from '@/schemas/extensions/operation/x-scalar-stability'\nimport type { TraversedOperation } from '@/schemas/navigation'\nimport type { OpenApiDocument, OperationObject, TagObject } from '@/schemas/v3.1/strict/openapi-document'\n\nimport { getTag } from './get-tag'\n\nexport const isDeprecatedOperation = (operation: OperationObject) => {\n return operation.deprecated || operation['x-scalar-stability'] === XScalarStabilityValues.Deprecated\n}\n\n/**\n * Creates a traversed operation entry from an OpenAPI operation object.\n *\n * @param ref - JSON pointer reference to the operation in the OpenAPI document\n * @param operation - The OpenAPI operation object\n * @param method - HTTP method of the operation\n * @param path - API path of the operation, defaults to 'Unknown'\n * @param tag - Tag object associated with the operation\n * @param entitiesMap - Map to store operation IDs and titles for mobile header navigation\n * @param getOperationId - Function to generate unique IDs for operations\n * @returns A traversed operation entry with ID, title, path, method and reference\n */\nconst createOperationEntry = (\n ref: string,\n operation: OperationObject,\n method: HttpMethod,\n path = 'Unknown',\n tag: TagObject,\n getOperationId: TraverseSpecOptions['getOperationId'],\n): TraversedOperation => {\n const id = getOperationId({ ...operation, method, path }, tag)\n const title = operation.summary?.trim() ? operation.summary : path\n\n const isDeprecated = isDeprecatedOperation(operation)\n\n const entry = {\n id,\n title,\n path,\n method,\n ref,\n type: 'operation',\n isDeprecated,\n } satisfies TraversedOperation\n\n return entry\n}\n\n/**\n * Traverses the paths in an OpenAPI document to build a map of operations organized by tags.\n *\n * This function processes each path and its operations to:\n * - Filter out internal operations (marked with x-internal) and operations to ignore (marked with x-scalar-ignore)\n * - Group operations by their tags\n * - Create a default tag group for untagged operations\n * - Generate unique references and IDs for each operation\n *\n * TODO: filter out internal and scalar-ignore tags\n *\n * @param content - The OpenAPI document to traverse\n * @param tagsDict - Dictionary mapping tag names to their OpenAPI tag objects\n * @param entitiesMap - Map to store operation IDs and titles for mobile header navigation\n * @param getOperationId - Function to generate unique IDs for operations\n * @returns Map of tag names to arrays of traversed operations\n */\nexport const traversePaths = (\n content: OpenApiDocument,\n /** Map of tags and their entries */\n tagsMap: TagsMap,\n getOperationId: TraverseSpecOptions['getOperationId'],\n) => {\n // Traverse paths\n Object.entries(content.paths ?? {}).forEach(([path, pathItemObject]) => {\n const pathKeys = objectKeys(pathItemObject ?? {}).filter((key) => isHttpMethod(key))\n\n pathKeys.forEach((method) => {\n const _operation = pathItemObject?.[method]\n const operation = getResolvedRef(_operation)\n if (!operation) {\n return\n }\n\n // Skip if the operation is internal or scalar-ignore\n if (operation['x-internal'] || operation['x-scalar-ignore'] || !isHttpMethod(method)) {\n return\n }\n\n const ref = `#/paths/${escapeJsonPointer(path)}/${method}`\n\n // Traverse tags\n if (operation.tags?.length) {\n operation.tags.forEach((tagName: string) => {\n const { tag } = getTag(tagsMap, tagName)\n tagsMap.get(tagName)?.entries.push(createOperationEntry(ref, operation, method, path, tag, getOperationId))\n })\n }\n // Add to default tag\n else {\n const { tag } = getTag(tagsMap, 'default')\n tagsMap.get('default')?.entries.push(createOperationEntry(ref, operation, method, path, tag, getOperationId))\n }\n })\n })\n}\n"],
|
|
5
|
+
"mappings": "AACA,SAAS,oBAAoB;AAC7B,SAAS,kBAAkB;AAC3B,SAAS,yBAAyB;AAElC,SAAS,sBAAsB;AAE/B,SAAS,8BAA8B;AAIvC,SAAS,cAAc;AAEhB,MAAM,wBAAwB,CAAC,cAA+B;AACnE,SAAO,UAAU,cAAc,UAAU,oBAAoB,MAAM,uBAAuB;AAC5F;AAcA,MAAM,uBAAuB,CAC3B,KACA,WACA,QACA,OAAO,WACP,KACA,mBACuB;AACvB,QAAM,KAAK,eAAe,EAAE,GAAG,WAAW,QAAQ,KAAK,GAAG,GAAG;AAC7D,QAAM,QAAQ,UAAU,SAAS,KAAK,IAAI,UAAU,UAAU;AAE9D,QAAM,eAAe,sBAAsB,SAAS;AAEpD,QAAM,QAAQ;AAAA,IACZ;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA,MAAM;AAAA,IACN;AAAA,EACF;AAEA,SAAO;AACT;AAmBO,MAAM,gBAAgB,CAC3B,SAEA,SACA,mBACG;AAEH,SAAO,QAAQ,QAAQ,SAAS,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,MAAM,cAAc,MAAM;AACtE,UAAM,WAAW,WAAW,kBAAkB,CAAC,CAAC,EAAE,OAAO,CAAC,QAAQ,aAAa,GAAG,CAAC;AAEnF,aAAS,QAAQ,CAAC,WAAW;AAC3B,YAAM,aAAa,iBAAiB,MAAM;AAC1C,YAAM,YAAY,eAAe,UAAU;AAC3C,UAAI,CAAC,WAAW;AACd;AAAA,MACF;AAGA,UAAI,UAAU,YAAY,KAAK,UAAU,iBAAiB,KAAK,CAAC,aAAa,MAAM,GAAG;AACpF;AAAA,MACF;AAEA,YAAM,MAAM,WAAW,kBAAkB,IAAI,CAAC,IAAI,MAAM;AAGxD,UAAI,UAAU,MAAM,QAAQ;AAC1B,kBAAU,KAAK,QAAQ,CAAC,YAAoB;AAC1C,gBAAM,EAAE,IAAI,IAAI,OAAO,SAAS,OAAO;AACvC,kBAAQ,IAAI,OAAO,GAAG,QAAQ,KAAK,qBAAqB,KAAK,WAAW,QAAQ,MAAM,KAAK,cAAc,CAAC;AAAA,QAC5G,CAAC;AAAA,MACH,OAEK;AACH,cAAM,EAAE,IAAI,IAAI,OAAO,SAAS,SAAS;AACzC,gBAAQ,IAAI,SAAS,GAAG,QAAQ,KAAK,qBAAqB,KAAK,WAAW,QAAQ,MAAM,KAAK,cAAc,CAAC;AAAA,MAC9G;AAAA,IACF,CAAC;AAAA,EACH,CAAC;AACH;",
|
|
6
6
|
"names": []
|
|
7
7
|
}
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import type { TagsMap, TraverseSpecOptions } from '../../navigation/types.js';
|
|
2
|
-
import type {
|
|
2
|
+
import type { TraversedSchema } from '../../schemas/navigation.js';
|
|
3
|
+
import type { OpenApiDocument } from '../../schemas/v3.1/strict/openapi-document.js';
|
|
3
4
|
/** Traverses the schemas in an OpenAPI document to build an array of model entries.
|
|
4
5
|
*
|
|
5
6
|
* This function processes each schema in components.schemas to:
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"traverse-schemas.d.ts","sourceRoot":"","sources":["../../../src/navigation/helpers/traverse-schemas.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,OAAO,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAA;AACtE,OAAO,KAAK,EAAE,eAAe,
|
|
1
|
+
{"version":3,"file":"traverse-schemas.d.ts","sourceRoot":"","sources":["../../../src/navigation/helpers/traverse-schemas.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,OAAO,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAA;AACtE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AAC3D,OAAO,KAAK,EAAE,eAAe,EAA2B,MAAM,wCAAwC,CAAA;AAmCtG;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,eAAe,GAC1B,SAAS,eAAe;AACxB,wCAAwC;AACxC,SAAS,OAAO,EAChB,YAAY,mBAAmB,CAAC,YAAY,CAAC,KAC5C,eAAe,EA4BjB,CAAA"}
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"version": 3,
|
|
3
3
|
"sources": ["../../../src/navigation/helpers/traverse-schemas.ts"],
|
|
4
|
-
"sourcesContent": ["import { getResolvedRef } from '@/helpers/get-resolved-ref'\nimport { getTag } from '@/navigation/helpers/get-tag'\nimport type { TagsMap, TraverseSpecOptions } from '@/navigation/types'\nimport type { OpenApiDocument, SchemaObject, TagObject
|
|
5
|
-
"mappings": "AAAA,SAAS,sBAAsB;AAC/B,SAAS,cAAc;
|
|
4
|
+
"sourcesContent": ["import { getResolvedRef } from '@/helpers/get-resolved-ref'\nimport { getTag } from '@/navigation/helpers/get-tag'\nimport type { TagsMap, TraverseSpecOptions } from '@/navigation/types'\nimport type { TraversedSchema } from '@/schemas/navigation'\nimport type { OpenApiDocument, SchemaObject, TagObject } from '@/schemas/v3.1/strict/openapi-document'\n\n/** Creates a traversed schema entry from an OpenAPI schema object.\n *\n * @param ref - JSON pointer reference to the schema in the OpenAPI document\n * @param name - Name of the schema, defaults to 'Unknown'\n * @param entriesMap - Map to store schema IDs and titles for mobile header navigation\n * @param getModelId - Function to generate unique IDs for schemas\n * @returns A traversed schema entry with ID, title, name and reference\n */\nconst createSchemaEntry = (\n ref: string,\n name = 'Unknown',\n getModelId: TraverseSpecOptions['getModelId'],\n tag?: TagObject,\n _schema?: SchemaObject,\n): TraversedSchema => {\n const id = getModelId({ name }, tag)\n const schema = getResolvedRef(_schema)\n\n // Use schema.title if available, otherwise fall back to name\n // @see https://json-schema.org/draft/2020-12/json-schema-core#section-4.3.5\n const title = (schema && 'title' in schema && (schema.title as string)) || name\n\n const entry = {\n id,\n title,\n name,\n ref,\n type: 'model',\n } satisfies TraversedSchema\n\n return entry\n}\n\n/** Traverses the schemas in an OpenAPI document to build an array of model entries.\n *\n * This function processes each schema in components.schemas to:\n * - Filter out internal schemas (marked with x-internal) and schemas to ignore (marked with x-scalar-ignore)\n * - Create model entries with unique references and IDs\n * - Store model IDs and titles for mobile header navigation\n *\n * @param content - The OpenAPI document to traverse\n * @param entitiesMap - Map to store schema IDs and titles for mobile header navigation\n * @param getModelId - Function to generate unique IDs for schemas\n * @returns Array of traversed schema entries\n */\nexport const traverseSchemas = (\n content: OpenApiDocument,\n /** Map of tagNames and their entries */\n tagsMap: TagsMap,\n getModelId: TraverseSpecOptions['getModelId'],\n): TraversedSchema[] => {\n const schemas = content.components?.schemas ?? {}\n const untagged: TraversedSchema[] = []\n\n // biome-ignore lint/suspicious/useGuardForIn: we do have an if statement after de-ref\n for (const name in schemas) {\n const schema = getResolvedRef(schemas[name])\n\n if (schema?.['x-internal'] || schema?.['x-scalar-ignore'] || !Object.hasOwn(schemas, name)) {\n continue\n }\n\n const ref = `#/components/schemas/${name}`\n\n // Add to tags\n if (schema?.['x-tags']) {\n schema['x-tags'].forEach((tagName: string) => {\n const { tag } = getTag(tagsMap, tagName)\n tagsMap.get(tagName)?.entries.push(createSchemaEntry(ref, name, getModelId, tag))\n })\n }\n // Add to untagged\n else {\n untagged.push(createSchemaEntry(ref, name, getModelId, undefined, getResolvedRef(schemas[name])))\n }\n }\n\n return untagged\n}\n"],
|
|
5
|
+
"mappings": "AAAA,SAAS,sBAAsB;AAC/B,SAAS,cAAc;AAavB,MAAM,oBAAoB,CACxB,KACA,OAAO,WACP,YACA,KACA,YACoB;AACpB,QAAM,KAAK,WAAW,EAAE,KAAK,GAAG,GAAG;AACnC,QAAM,SAAS,eAAe,OAAO;AAIrC,QAAM,QAAS,UAAU,WAAW,UAAW,OAAO,SAAqB;AAE3E,QAAM,QAAQ;AAAA,IACZ;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA,MAAM;AAAA,EACR;AAEA,SAAO;AACT;AAcO,MAAM,kBAAkB,CAC7B,SAEA,SACA,eACsB;AACtB,QAAM,UAAU,QAAQ,YAAY,WAAW,CAAC;AAChD,QAAM,WAA8B,CAAC;AAGrC,aAAW,QAAQ,SAAS;AAC1B,UAAM,SAAS,eAAe,QAAQ,IAAI,CAAC;AAE3C,QAAI,SAAS,YAAY,KAAK,SAAS,iBAAiB,KAAK,CAAC,OAAO,OAAO,SAAS,IAAI,GAAG;AAC1F;AAAA,IACF;AAEA,UAAM,MAAM,wBAAwB,IAAI;AAGxC,QAAI,SAAS,QAAQ,GAAG;AACtB,aAAO,QAAQ,EAAE,QAAQ,CAAC,YAAoB;AAC5C,cAAM,EAAE,IAAI,IAAI,OAAO,SAAS,OAAO;AACvC,gBAAQ,IAAI,OAAO,GAAG,QAAQ,KAAK,kBAAkB,KAAK,MAAM,YAAY,GAAG,CAAC;AAAA,MAClF,CAAC;AAAA,IACH,OAEK;AACH,eAAS,KAAK,kBAAkB,KAAK,MAAM,YAAY,QAAW,eAAe,QAAQ,IAAI,CAAC,CAAC,CAAC;AAAA,IAClG;AAAA,EACF;AAEA,SAAO;AACT;",
|
|
6
6
|
"names": []
|
|
7
7
|
}
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import type { TagsMap, TraverseSpecOptions } from '../../navigation/types.js';
|
|
2
|
-
import type {
|
|
2
|
+
import type { TraversedEntry } from '../../schemas/navigation.js';
|
|
3
|
+
import type { OpenApiDocument } from '../../schemas/v3.1/strict/openapi-document.js';
|
|
3
4
|
type Options = Pick<TraverseSpecOptions, 'getTagId' | 'tagsSorter' | 'operationsSorter'>;
|
|
4
5
|
/**
|
|
5
6
|
* Traverses the tags map to create navigation entries, handling both grouped and ungrouped tags.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"traverse-tags.d.ts","sourceRoot":"","sources":["../../../src/navigation/helpers/traverse-tags.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,OAAO,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAA;AACtE,OAAO,KAAK,EAAE,
|
|
1
|
+
{"version":3,"file":"traverse-tags.d.ts","sourceRoot":"","sources":["../../../src/navigation/helpers/traverse-tags.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,OAAO,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAA;AACtE,OAAO,KAAK,EAAE,cAAc,EAAgB,MAAM,sBAAsB,CAAA;AACxE,OAAO,KAAK,EAAE,eAAe,EAAa,MAAM,wCAAwC,CAAA;AAIxF,KAAK,OAAO,GAAG,IAAI,CAAC,mBAAmB,EAAE,UAAU,GAAG,YAAY,GAAG,kBAAkB,CAAC,CAAA;AA4HxF;;;;;;;;GAQG;AACH,eAAO,MAAM,YAAY,GACvB,SAAS,eAAe;AACxB,oCAAoC;AACpC,SAAS,OAAO,EAChB,4CAA4C,OAAO,KAClD,cAAc,EAyBhB,CAAA"}
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"version": 3,
|
|
3
3
|
"sources": ["../../../src/navigation/helpers/traverse-tags.ts"],
|
|
4
|
-
"sourcesContent": ["import { getXKeysFromObject } from '@/navigation/helpers/get-x-keys'\nimport type { TagsMap, TraverseSpecOptions } from '@/navigation/types'\nimport type {
|
|
5
|
-
"mappings": "AAAA,SAAS,0BAA0B;
|
|
4
|
+
"sourcesContent": ["import { getXKeysFromObject } from '@/navigation/helpers/get-x-keys'\nimport type { TagsMap, TraverseSpecOptions } from '@/navigation/types'\nimport type { TraversedEntry, TraversedTag } from '@/schemas/navigation'\nimport type { OpenApiDocument, TagObject } from '@/schemas/v3.1/strict/openapi-document'\n\nimport { getTag } from './get-tag'\n\ntype Options = Pick<TraverseSpecOptions, 'getTagId' | 'tagsSorter' | 'operationsSorter'>\n\n/** Creates a traversed tag entry from an OpenAPI tag object.\n *\n * @param tag - The OpenAPI tag object\n * @param entriesMap - Map to store tag IDs and titles for mobile header navigation\n * @param getTagId - Function to generate unique IDs for tags\n * @param children - Array of child entries (operations, webhooks, etc.)\n * @param isGroup - Whether this tag represents a group of tags\n * @returns A traversed tag entry with ID, title, name and children\n */\nconst createTagEntry = (\n tag: TagObject,\n getTagId: TraverseSpecOptions['getTagId'],\n children: TraversedEntry[],\n isGroup = false,\n): TraversedTag => {\n const id = getTagId(tag)\n const title = tag['x-displayName'] ?? tag.name ?? 'Untitled Tag'\n\n const entry = {\n id,\n title,\n name: tag.name || title,\n description: tag.description,\n children,\n isGroup,\n isWebhooks: false,\n type: 'tag',\n xKeys: getXKeysFromObject(tag),\n } satisfies TraversedTag\n\n return entry\n}\n\n/** Sorts and processes tags to create a hierarchical structure of tag entries.\n *\n * This function handles:\n * - Sorting tags alphabetically or using a custom sort function\n * - Ensuring the default tag appears last\n * - Sorting operations within tags by title, method, or custom function\n * - Filtering out internal and ignored tags\n * - Creating tag entries with their associated operations\n *\n * @param _keys - Array of tag keys to process\n * @param tagsMap - Map of tags and their entries\n * @param tagsDict - Dictionary of OpenAPI tags by name\n * @param titlesMap - Map of titles for the mobile header\n * @param options - Sorting and ID generation options\n * @returns Array of processed and sorted tag entries\n */\n/** Sorts tags and returns entries */\nconst getSortedTagEntries = (\n _keys: string[],\n /** Map of tags and their entries */\n tagsMap: TagsMap,\n { getTagId, tagsSorter, operationsSorter }: Options,\n) => {\n // Ensure that default is last if it exists\n const hasDefault = _keys.includes('default')\n const keys = hasDefault ? _keys.filter((key) => key !== 'default') : _keys\n\n // Alpha sort\n if (tagsSorter === 'alpha') {\n keys.sort((a, b) => {\n const nameA = getTag(tagsMap, a).tag['x-displayName'] || a || 'Untitled Tag'\n const nameB = getTag(tagsMap, b).tag['x-displayName'] || b || 'Untitled Tag'\n return nameA.localeCompare(nameB)\n })\n }\n // Custom sort\n else if (typeof tagsSorter === 'function') {\n keys.sort((a, b) => tagsSorter(getTag(tagsMap, a).tag, getTag(tagsMap, b).tag))\n }\n\n if (hasDefault) {\n keys.push('default')\n }\n\n /**\n * Process each tag and its entries:\n * - Skip internal and ignored tags\n * - Sort operations within tags\n * - Create tag entries with sorted operations\n */\n return keys.flatMap((key) => {\n const { tag, entries } = getTag(tagsMap, key)\n\n // Skip if the tag is internal or scalar-ignore\n if (tag['x-internal'] || tag['x-scalar-ignore']) {\n return []\n }\n\n // Alpha sort\n if (operationsSorter === 'alpha') {\n entries.sort((a, b) => (a.type === 'operation' && b.type === 'operation' ? a.title.localeCompare(b.title) : 0))\n }\n // Method sort\n else if (operationsSorter === 'method') {\n entries.sort((a, b) => (a.type === 'operation' && b.type === 'operation' ? a.method.localeCompare(b.method) : 0))\n }\n // Custom sort\n else if (typeof operationsSorter === 'function') {\n entries.sort((a, b) => {\n // Guard against tags\n if (!(a.type === 'operation' || a.type === 'webhook') || !(b.type === 'operation' || b.type === 'webhook')) {\n return 0\n }\n\n // Handle webhooks as well as operations\n const pathA = a.type === 'operation' ? a.path : a.name\n const pathB = b.type === 'operation' ? b.path : b.name\n\n return operationsSorter(\n { method: a.method, path: pathA, ref: a.ref, httpVerb: a.method },\n { method: b.method, path: pathB, ref: b.ref, httpVerb: b.method },\n )\n })\n }\n\n return entries.length ? createTagEntry(tag, getTagId, entries) : []\n })\n}\n\n/**\n * Traverses the tags map to create navigation entries, handling both grouped and ungrouped tags.\n *\n * This function processes the OpenAPI document's tags to:\n * - Handle tag groups if specified via x-tagGroups\n * - Sort tags and their operations according to provided sorters\n * - Create navigation entries for each tag or tag group\n * - Flatten default tag entries if it's the only tag present\n */\nexport const traverseTags = (\n content: OpenApiDocument,\n /** Map of tags and their entries */\n tagsMap: TagsMap,\n { getTagId, tagsSorter, operationsSorter }: Options,\n): TraversedEntry[] => {\n // x-tagGroups\n if (content['x-tagGroups']) {\n const tagGroups = content['x-tagGroups']\n\n return tagGroups.flatMap((tagGroup) => {\n const entries = getSortedTagEntries(tagGroup.tags ?? [], tagsMap, {\n getTagId,\n tagsSorter,\n operationsSorter,\n })\n return entries.length ? createTagEntry(tagGroup, getTagId, entries, true) : []\n })\n }\n\n // Ungrouped regular tags\n const keys = Array.from(tagsMap.keys())\n const tags = getSortedTagEntries(keys, tagsMap, { getTagId, tagsSorter, operationsSorter })\n\n // Flatten if we only have default tag\n if (tags.length === 1 && tags[0]?.title === 'default') {\n return tags[0]?.children ?? []\n }\n\n return tags\n}\n"],
|
|
5
|
+
"mappings": "AAAA,SAAS,0BAA0B;AAKnC,SAAS,cAAc;AAavB,MAAM,iBAAiB,CACrB,KACA,UACA,UACA,UAAU,UACO;AACjB,QAAM,KAAK,SAAS,GAAG;AACvB,QAAM,QAAQ,IAAI,eAAe,KAAK,IAAI,QAAQ;AAElD,QAAM,QAAQ;AAAA,IACZ;AAAA,IACA;AAAA,IACA,MAAM,IAAI,QAAQ;AAAA,IAClB,aAAa,IAAI;AAAA,IACjB;AAAA,IACA;AAAA,IACA,YAAY;AAAA,IACZ,MAAM;AAAA,IACN,OAAO,mBAAmB,GAAG;AAAA,EAC/B;AAEA,SAAO;AACT;AAmBA,MAAM,sBAAsB,CAC1B,OAEA,SACA,EAAE,UAAU,YAAY,iBAAiB,MACtC;AAEH,QAAM,aAAa,MAAM,SAAS,SAAS;AAC3C,QAAM,OAAO,aAAa,MAAM,OAAO,CAAC,QAAQ,QAAQ,SAAS,IAAI;AAGrE,MAAI,eAAe,SAAS;AAC1B,SAAK,KAAK,CAAC,GAAG,MAAM;AAClB,YAAM,QAAQ,OAAO,SAAS,CAAC,EAAE,IAAI,eAAe,KAAK,KAAK;AAC9D,YAAM,QAAQ,OAAO,SAAS,CAAC,EAAE,IAAI,eAAe,KAAK,KAAK;AAC9D,aAAO,MAAM,cAAc,KAAK;AAAA,IAClC,CAAC;AAAA,EACH,WAES,OAAO,eAAe,YAAY;AACzC,SAAK,KAAK,CAAC,GAAG,MAAM,WAAW,OAAO,SAAS,CAAC,EAAE,KAAK,OAAO,SAAS,CAAC,EAAE,GAAG,CAAC;AAAA,EAChF;AAEA,MAAI,YAAY;AACd,SAAK,KAAK,SAAS;AAAA,EACrB;AAQA,SAAO,KAAK,QAAQ,CAAC,QAAQ;AAC3B,UAAM,EAAE,KAAK,QAAQ,IAAI,OAAO,SAAS,GAAG;AAG5C,QAAI,IAAI,YAAY,KAAK,IAAI,iBAAiB,GAAG;AAC/C,aAAO,CAAC;AAAA,IACV;AAGA,QAAI,qBAAqB,SAAS;AAChC,cAAQ,KAAK,CAAC,GAAG,MAAO,EAAE,SAAS,eAAe,EAAE,SAAS,cAAc,EAAE,MAAM,cAAc,EAAE,KAAK,IAAI,CAAE;AAAA,IAChH,WAES,qBAAqB,UAAU;AACtC,cAAQ,KAAK,CAAC,GAAG,MAAO,EAAE,SAAS,eAAe,EAAE,SAAS,cAAc,EAAE,OAAO,cAAc,EAAE,MAAM,IAAI,CAAE;AAAA,IAClH,WAES,OAAO,qBAAqB,YAAY;AAC/C,cAAQ,KAAK,CAAC,GAAG,MAAM;AAErB,YAAI,EAAE,EAAE,SAAS,eAAe,EAAE,SAAS,cAAc,EAAE,EAAE,SAAS,eAAe,EAAE,SAAS,YAAY;AAC1G,iBAAO;AAAA,QACT;AAGA,cAAM,QAAQ,EAAE,SAAS,cAAc,EAAE,OAAO,EAAE;AAClD,cAAM,QAAQ,EAAE,SAAS,cAAc,EAAE,OAAO,EAAE;AAElD,eAAO;AAAA,UACL,EAAE,QAAQ,EAAE,QAAQ,MAAM,OAAO,KAAK,EAAE,KAAK,UAAU,EAAE,OAAO;AAAA,UAChE,EAAE,QAAQ,EAAE,QAAQ,MAAM,OAAO,KAAK,EAAE,KAAK,UAAU,EAAE,OAAO;AAAA,QAClE;AAAA,MACF,CAAC;AAAA,IACH;AAEA,WAAO,QAAQ,SAAS,eAAe,KAAK,UAAU,OAAO,IAAI,CAAC;AAAA,EACpE,CAAC;AACH;AAWO,MAAM,eAAe,CAC1B,SAEA,SACA,EAAE,UAAU,YAAY,iBAAiB,MACpB;AAErB,MAAI,QAAQ,aAAa,GAAG;AAC1B,UAAM,YAAY,QAAQ,aAAa;AAEvC,WAAO,UAAU,QAAQ,CAAC,aAAa;AACrC,YAAM,UAAU,oBAAoB,SAAS,QAAQ,CAAC,GAAG,SAAS;AAAA,QAChE;AAAA,QACA;AAAA,QACA;AAAA,MACF,CAAC;AACD,aAAO,QAAQ,SAAS,eAAe,UAAU,UAAU,SAAS,IAAI,IAAI,CAAC;AAAA,IAC/E,CAAC;AAAA,EACH;AAGA,QAAM,OAAO,MAAM,KAAK,QAAQ,KAAK,CAAC;AACtC,QAAM,OAAO,oBAAoB,MAAM,SAAS,EAAE,UAAU,YAAY,iBAAiB,CAAC;AAG1F,MAAI,KAAK,WAAW,KAAK,KAAK,CAAC,GAAG,UAAU,WAAW;AACrD,WAAO,KAAK,CAAC,GAAG,YAAY,CAAC;AAAA,EAC/B;AAEA,SAAO;AACT;",
|
|
6
6
|
"names": []
|
|
7
7
|
}
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import type { TagsMap, TraverseSpecOptions } from '../../navigation/types.js';
|
|
2
|
-
import type {
|
|
2
|
+
import type { TraversedWebhook } from '../../schemas/navigation.js';
|
|
3
|
+
import type { OpenApiDocument } from '../../schemas/v3.1/strict/openapi-document.js';
|
|
3
4
|
/** Traverses the webhooks in an OpenAPI document to build an array of webhook entries.
|
|
4
5
|
*
|
|
5
6
|
* This function processes each webhook in the document to:
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"traverse-webhooks.d.ts","sourceRoot":"","sources":["../../../src/navigation/helpers/traverse-webhooks.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,OAAO,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAA;AACtE,OAAO,KAAK,EAAE,
|
|
1
|
+
{"version":3,"file":"traverse-webhooks.d.ts","sourceRoot":"","sources":["../../../src/navigation/helpers/traverse-webhooks.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,OAAO,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAA;AACtE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAA;AAC5D,OAAO,KAAK,EAAE,eAAe,EAAa,MAAM,wCAAwC,CAAA;AAuCxF;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,gBAAgB,GAC3B,SAAS,eAAe;AACxB,6CAA6C;AAC7C,SAAS,OAAO,EAChB,cAAc,mBAAmB,CAAC,cAAc,CAAC,KAChD,gBAAgB,EAyDlB,CAAA"}
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"version": 3,
|
|
3
3
|
"sources": ["../../../src/navigation/helpers/traverse-webhooks.ts"],
|
|
4
|
-
"sourcesContent": ["import type { HttpMethod } from '@scalar/helpers/http/http-methods'\nimport { isHttpMethod } from '@scalar/helpers/http/is-http-method'\nimport { objectKeys } from '@scalar/helpers/object/object-keys'\n\nimport { getResolvedRef } from '@/helpers/get-resolved-ref'\nimport { isDeprecatedOperation } from '@/navigation/helpers/traverse-paths'\nimport type { TagsMap, TraverseSpecOptions } from '@/navigation/types'\nimport type { OpenApiDocument, TagObject
|
|
5
|
-
"mappings": "AACA,SAAS,oBAAoB;AAC7B,SAAS,kBAAkB;AAE3B,SAAS,sBAAsB;AAC/B,SAAS,6BAA6B;
|
|
4
|
+
"sourcesContent": ["import type { HttpMethod } from '@scalar/helpers/http/http-methods'\nimport { isHttpMethod } from '@scalar/helpers/http/is-http-method'\nimport { objectKeys } from '@scalar/helpers/object/object-keys'\n\nimport { getResolvedRef } from '@/helpers/get-resolved-ref'\nimport { isDeprecatedOperation } from '@/navigation/helpers/traverse-paths'\nimport type { TagsMap, TraverseSpecOptions } from '@/navigation/types'\nimport type { TraversedWebhook } from '@/schemas/navigation'\nimport type { OpenApiDocument, TagObject } from '@/schemas/v3.1/strict/openapi-document'\n\nimport { getTag } from './get-tag'\n\n/** Creates a traversed webhook entry from an OpenAPI webhook object.\n *\n * @param ref - JSON pointer reference to the webhook in the OpenAPI document\n * @param method - HTTP method of the webhook\n * @param name - Name of the webhook, defaults to 'Unknown'\n * @param title - Title of the webhook, defaults to 'Unknown'\n * @param entitiesMap - Map to store webhook IDs and titles for mobile header navigation\n * @param getWebhookId - Function to generate unique IDs for webhooks\n * @param tag - Optional tag object associated with the webhook\n * @returns A traversed webhook entry with ID, title, name, method and reference\n */\nconst createWebhookEntry = (\n ref: string,\n method: HttpMethod,\n name = 'Unknown',\n title = 'Unknown',\n getWebhookId: TraverseSpecOptions['getWebhookId'],\n tag?: TagObject,\n isDeprecated?: boolean,\n): TraversedWebhook => {\n const id = getWebhookId({ name, method }, tag)\n\n const entry = {\n id,\n title,\n name,\n ref,\n method: method,\n type: 'webhook',\n isDeprecated,\n } satisfies TraversedWebhook\n\n return entry\n}\n\n/** Traverses the webhooks in an OpenAPI document to build an array of webhook entries.\n *\n * This function processes each webhook in the document to:\n * - Filter out internal webhooks (marked with x-internal) and webhooks to ignore (marked with x-scalar-ignore)\n * - Group webhooks by their tags\n * - Create webhook entries with unique references and IDs\n * - Store webhook IDs and titles for mobile header navigation\n *\n * @param content - The OpenAPI document to traverse\n * @param tagsMap - Map of tag names to arrays of traversed entries from operations\n * @param tagsDict - Dictionary mapping tag names to their OpenAPI tag objects\n * @param entitiesMap - Map to store webhook IDs and titles for mobile header navigation\n * @param getWebhookId - Function to generate unique IDs for webhooks\n * @returns Array of untagged webhook entries\n */\nexport const traverseWebhooks = (\n content: OpenApiDocument,\n /** The tag map from from traversing paths */\n tagsMap: TagsMap,\n getWebhookId: TraverseSpecOptions['getWebhookId'],\n): TraversedWebhook[] => {\n const untagged: TraversedWebhook[] = []\n\n // Traverse webhooks\n Object.entries(content.webhooks ?? {}).forEach(([name, pathItemObject]) => {\n const pathKeys = objectKeys(pathItemObject ?? {}).filter((key) => isHttpMethod(key))\n\n pathKeys.forEach((method) => {\n const _operation = pathItemObject?.[method]\n const operation = getResolvedRef(_operation)\n if (!operation) {\n return\n }\n\n // Skip if the operation is internal or scalar-ignore\n if (operation['x-internal'] || operation['x-scalar-ignore']) {\n return\n }\n\n const ref = `#/webhooks/${name}/${method}`\n\n if (operation.tags?.length) {\n operation.tags.forEach((tagName: string) => {\n const { tag } = getTag(tagsMap, tagName)\n tagsMap\n .get(tagName)\n ?.entries.push(\n createWebhookEntry(\n ref,\n method,\n name,\n operation.summary ?? name,\n getWebhookId,\n tag,\n isDeprecatedOperation(operation),\n ),\n )\n })\n }\n // Add to untagged\n else {\n untagged.push(\n createWebhookEntry(\n ref,\n method,\n name,\n operation.summary ?? name,\n getWebhookId,\n undefined,\n isDeprecatedOperation(operation),\n ),\n )\n }\n })\n })\n\n return untagged\n}\n"],
|
|
5
|
+
"mappings": "AACA,SAAS,oBAAoB;AAC7B,SAAS,kBAAkB;AAE3B,SAAS,sBAAsB;AAC/B,SAAS,6BAA6B;AAKtC,SAAS,cAAc;AAavB,MAAM,qBAAqB,CACzB,KACA,QACA,OAAO,WACP,QAAQ,WACR,cACA,KACA,iBACqB;AACrB,QAAM,KAAK,aAAa,EAAE,MAAM,OAAO,GAAG,GAAG;AAE7C,QAAM,QAAQ;AAAA,IACZ;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA,MAAM;AAAA,IACN;AAAA,EACF;AAEA,SAAO;AACT;AAiBO,MAAM,mBAAmB,CAC9B,SAEA,SACA,iBACuB;AACvB,QAAM,WAA+B,CAAC;AAGtC,SAAO,QAAQ,QAAQ,YAAY,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,MAAM,cAAc,MAAM;AACzE,UAAM,WAAW,WAAW,kBAAkB,CAAC,CAAC,EAAE,OAAO,CAAC,QAAQ,aAAa,GAAG,CAAC;AAEnF,aAAS,QAAQ,CAAC,WAAW;AAC3B,YAAM,aAAa,iBAAiB,MAAM;AAC1C,YAAM,YAAY,eAAe,UAAU;AAC3C,UAAI,CAAC,WAAW;AACd;AAAA,MACF;AAGA,UAAI,UAAU,YAAY,KAAK,UAAU,iBAAiB,GAAG;AAC3D;AAAA,MACF;AAEA,YAAM,MAAM,cAAc,IAAI,IAAI,MAAM;AAExC,UAAI,UAAU,MAAM,QAAQ;AAC1B,kBAAU,KAAK,QAAQ,CAAC,YAAoB;AAC1C,gBAAM,EAAE,IAAI,IAAI,OAAO,SAAS,OAAO;AACvC,kBACG,IAAI,OAAO,GACV,QAAQ;AAAA,YACR;AAAA,cACE;AAAA,cACA;AAAA,cACA;AAAA,cACA,UAAU,WAAW;AAAA,cACrB;AAAA,cACA;AAAA,cACA,sBAAsB,SAAS;AAAA,YACjC;AAAA,UACF;AAAA,QACJ,CAAC;AAAA,MACH,OAEK;AACH,iBAAS;AAAA,UACP;AAAA,YACE;AAAA,YACA;AAAA,YACA;AAAA,YACA,UAAU,WAAW;AAAA,YACrB;AAAA,YACA;AAAA,YACA,sBAAsB,SAAS;AAAA,UACjC;AAAA,QACF;AAAA,MACF;AAAA,IACF,CAAC;AAAA,EACH,CAAC;AAED,SAAO;AACT;",
|
|
6
6
|
"names": []
|
|
7
7
|
}
|
|
@@ -1,4 +1,5 @@
|
|
|
1
|
-
import type {
|
|
1
|
+
import type { TraversedEntry } from '../schemas/navigation.js';
|
|
2
|
+
import type { OperationObject, TagObject } from '../schemas/v3.1/strict/openapi-document.js';
|
|
2
3
|
/** Map of tagNames and their entries */
|
|
3
4
|
export type TagsMap = Map<string, {
|
|
4
5
|
tag: TagObject;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/navigation/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/navigation/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAC1D,OAAO,KAAK,EAAE,eAAe,EAAE,SAAS,EAAE,MAAM,wCAAwC,CAAA;AACxF,wCAAwC;AACxC,MAAM,MAAM,OAAO,GAAG,GAAG,CAAC,MAAM,EAAE;IAAE,GAAG,EAAE,SAAS,CAAC;IAAC,OAAO,EAAE,cAAc,EAAE,CAAA;CAAE,CAAC,CAAA;AAEhF,KAAK,kBAAkB,GAAG;IACxB,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;IACZ,GAAG,EAAE,MAAM,CAAA;IACX,qCAAqC;IACrC,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAED;;;;;;GAMG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,2FAA2F;IAC3F,UAAU,CAAC,EAAE,OAAO,GAAG,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,SAAS,KAAK,MAAM,CAAC,CAAA;IAE/D,sGAAsG;IACtG,gBAAgB,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,CAAC,CAAC,CAAC,EAAE,kBAAkB,EAAE,CAAC,EAAE,kBAAkB,KAAK,MAAM,CAAC,CAAA;IAElG,wDAAwD;IACxD,UAAU,EAAE,OAAO,CAAA;IAEnB,4DAA4D;IAC5D,YAAY,EAAE,CAAC,OAAO,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,KAAK,MAAM,CAAA;IAElF,qDAAqD;IACrD,cAAc,EAAE,CACd,SAAS,EAAE;QACT,IAAI,EAAE,MAAM,CAAA;QACZ,MAAM,EAAE,MAAM,CAAA;KACf,GAAG,eAAe,EACnB,SAAS,EAAE,SAAS,KACjB,MAAM,CAAA;IAEX,mDAAmD;IACnD,YAAY,EAAE,CACZ,OAAO,EAAE;QACP,IAAI,EAAE,MAAM,CAAA;QACZ,MAAM,CAAC,EAAE,MAAM,CAAA;KAChB,EACD,SAAS,CAAC,EAAE,SAAS,KAClB,MAAM,CAAA;IAEX,yDAAyD;IACzD,UAAU,EAAE,CACV,KAAK,EAAE;QACL,IAAI,CAAC,EAAE,MAAM,CAAA;KACd,EACD,SAAS,CAAC,EAAE,SAAS,KAClB,MAAM,CAAA;IAEX,+CAA+C;IAC/C,QAAQ,EAAE,CAAC,GAAG,EAAE,SAAS,KAAK,MAAM,CAAA;CACrC,CAAA;AAED,MAAM,MAAM,OAAO,GAAG;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAA;CAAE,CAAA"}
|
|
@@ -1,4 +1,8 @@
|
|
|
1
1
|
export declare const XInternalSchema: import("@scalar/typebox").TObject<{
|
|
2
2
|
'x-internal': import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
3
3
|
}>;
|
|
4
|
+
export type XInternal = {
|
|
5
|
+
/** Extension to mark an entity as internal */
|
|
6
|
+
'x-internal'?: boolean;
|
|
7
|
+
};
|
|
4
8
|
//# sourceMappingURL=x-internal.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"x-internal.d.ts","sourceRoot":"","sources":["../../../../src/schemas/extensions/document/x-internal.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,eAAe;;EAE1B,CAAA"}
|
|
1
|
+
{"version":3,"file":"x-internal.d.ts","sourceRoot":"","sources":["../../../../src/schemas/extensions/document/x-internal.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,eAAe;;EAE1B,CAAA;AAEF,MAAM,MAAM,SAAS,GAAG;IACtB,8CAA8C;IAC9C,YAAY,CAAC,EAAE,OAAO,CAAA;CACvB,CAAA"}
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"version": 3,
|
|
3
3
|
"sources": ["../../../../src/schemas/extensions/document/x-internal.ts"],
|
|
4
|
-
"sourcesContent": ["import { Type } from '@scalar/typebox'\n\nexport const XInternalSchema = Type.Object({\n 'x-internal': Type.Optional(Type.Boolean()),\n})\n"],
|
|
4
|
+
"sourcesContent": ["import { Type } from '@scalar/typebox'\n\nexport const XInternalSchema = Type.Object({\n 'x-internal': Type.Optional(Type.Boolean()),\n})\n\nexport type XInternal = {\n /** Extension to mark an entity as internal */\n 'x-internal'?: boolean\n}\n"],
|
|
5
5
|
"mappings": "AAAA,SAAS,YAAY;AAEd,MAAM,kBAAkB,KAAK,OAAO;AAAA,EACzC,cAAc,KAAK,SAAS,KAAK,QAAQ,CAAC;AAC5C,CAAC;",
|
|
6
6
|
"names": []
|
|
7
7
|
}
|
|
@@ -1,4 +1,8 @@
|
|
|
1
1
|
export declare const XScalarIconSchema: import("@scalar/typebox").TObject<{
|
|
2
2
|
'x-scalar-icon': import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
3
3
|
}>;
|
|
4
|
+
export type XScalarIcon = {
|
|
5
|
+
/** A custom icon representing the collection */
|
|
6
|
+
'x-scalar-icon'?: string;
|
|
7
|
+
};
|
|
4
8
|
//# sourceMappingURL=x-scalar-icon.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"x-scalar-icon.d.ts","sourceRoot":"","sources":["../../../../src/schemas/extensions/document/x-scalar-icon.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,iBAAiB;;EAE5B,CAAA"}
|
|
1
|
+
{"version":3,"file":"x-scalar-icon.d.ts","sourceRoot":"","sources":["../../../../src/schemas/extensions/document/x-scalar-icon.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,iBAAiB;;EAE5B,CAAA;AAEF,MAAM,MAAM,WAAW,GAAG;IACxB,gDAAgD;IAChD,eAAe,CAAC,EAAE,MAAM,CAAA;CACzB,CAAA"}
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"version": 3,
|
|
3
3
|
"sources": ["../../../../src/schemas/extensions/document/x-scalar-icon.ts"],
|
|
4
|
-
"sourcesContent": ["import { Type } from '@scalar/typebox'\n\nexport const XScalarIconSchema = Type.Object({\n 'x-scalar-icon': Type.Optional(Type.String()),\n})\n"],
|
|
4
|
+
"sourcesContent": ["import { Type } from '@scalar/typebox'\n\nexport const XScalarIconSchema = Type.Object({\n 'x-scalar-icon': Type.Optional(Type.String()),\n})\n\nexport type XScalarIcon = {\n /** A custom icon representing the collection */\n 'x-scalar-icon'?: string\n}\n"],
|
|
5
5
|
"mappings": "AAAA,SAAS,YAAY;AAEd,MAAM,oBAAoB,KAAK,OAAO;AAAA,EAC3C,iBAAiB,KAAK,SAAS,KAAK,OAAO,CAAC;AAC9C,CAAC;",
|
|
6
6
|
"names": []
|
|
7
7
|
}
|
|
@@ -1,4 +1,8 @@
|
|
|
1
1
|
export declare const XScalarIgnoreSchema: import("@scalar/typebox").TObject<{
|
|
2
2
|
'x-scalar-ignore': import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
3
3
|
}>;
|
|
4
|
+
export type XScalarIgnore = {
|
|
5
|
+
/** Interal extension to mark an entity as ignored */
|
|
6
|
+
'x-scalar-ignore'?: boolean;
|
|
7
|
+
};
|
|
4
8
|
//# sourceMappingURL=x-scalar-ignore.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"x-scalar-ignore.d.ts","sourceRoot":"","sources":["../../../../src/schemas/extensions/document/x-scalar-ignore.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,mBAAmB;;EAE9B,CAAA"}
|
|
1
|
+
{"version":3,"file":"x-scalar-ignore.d.ts","sourceRoot":"","sources":["../../../../src/schemas/extensions/document/x-scalar-ignore.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,mBAAmB;;EAE9B,CAAA;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,qDAAqD;IACrD,iBAAiB,CAAC,EAAE,OAAO,CAAA;CAC5B,CAAA"}
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"version": 3,
|
|
3
3
|
"sources": ["../../../../src/schemas/extensions/document/x-scalar-ignore.ts"],
|
|
4
|
-
"sourcesContent": ["import { Type } from '@scalar/typebox'\n\nexport const XScalarIgnoreSchema = Type.Object({\n 'x-scalar-ignore': Type.Optional(Type.Boolean()),\n})\n"],
|
|
4
|
+
"sourcesContent": ["import { Type } from '@scalar/typebox'\n\nexport const XScalarIgnoreSchema = Type.Object({\n 'x-scalar-ignore': Type.Optional(Type.Boolean()),\n})\n\nexport type XScalarIgnore = {\n /** Interal extension to mark an entity as ignored */\n 'x-scalar-ignore'?: boolean\n}\n"],
|
|
5
5
|
"mappings": "AAAA,SAAS,YAAY;AAEd,MAAM,sBAAsB,KAAK,OAAO;AAAA,EAC7C,mBAAmB,KAAK,SAAS,KAAK,QAAQ,CAAC;AACjD,CAAC;",
|
|
6
6
|
"names": []
|
|
7
7
|
}
|
|
@@ -1,4 +1,3 @@
|
|
|
1
|
-
import type { Static } from '@scalar/typebox';
|
|
2
1
|
export declare const XScalarSdkInstallationSchema: import("@scalar/typebox").TObject<{
|
|
3
2
|
'x-scalar-sdk-installation': import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TObject<{
|
|
4
3
|
lang: import("@scalar/typebox").TString;
|
|
@@ -6,5 +5,12 @@ export declare const XScalarSdkInstallationSchema: import("@scalar/typebox").TOb
|
|
|
6
5
|
description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
7
6
|
}>>>;
|
|
8
7
|
}>;
|
|
9
|
-
export type XScalarSdkInstallation =
|
|
8
|
+
export type XScalarSdkInstallation = {
|
|
9
|
+
/** Scalar SDK installation information. */
|
|
10
|
+
'x-scalar-sdk-installation'?: {
|
|
11
|
+
lang: string;
|
|
12
|
+
source?: string;
|
|
13
|
+
description?: string;
|
|
14
|
+
}[];
|
|
15
|
+
};
|
|
10
16
|
//# sourceMappingURL=x-scalar-sdk-installation.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"x-scalar-sdk-installation.d.ts","sourceRoot":"","sources":["../../../../src/schemas/extensions/document/x-scalar-sdk-installation.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"x-scalar-sdk-installation.d.ts","sourceRoot":"","sources":["../../../../src/schemas/extensions/document/x-scalar-sdk-installation.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,4BAA4B;;;;;;EAUvC,CAAA;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACnC,2CAA2C;IAC3C,2BAA2B,CAAC,EAAE;QAC5B,IAAI,EAAE,MAAM,CAAA;QACZ,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,WAAW,CAAC,EAAE,MAAM,CAAA;KACrB,EAAE,CAAA;CACJ,CAAA"}
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"version": 3,
|
|
3
3
|
"sources": ["../../../../src/schemas/extensions/document/x-scalar-sdk-installation.ts"],
|
|
4
|
-
"sourcesContent": ["import
|
|
5
|
-
"mappings": "
|
|
4
|
+
"sourcesContent": ["import { Type } from '@scalar/typebox'\n\nexport const XScalarSdkInstallationSchema = Type.Object({\n 'x-scalar-sdk-installation': Type.Optional(\n Type.Array(\n Type.Object({\n lang: Type.String(),\n source: Type.Optional(Type.String()),\n description: Type.Optional(Type.String()),\n }),\n ),\n ),\n})\n\nexport type XScalarSdkInstallation = {\n /** Scalar SDK installation information. */\n 'x-scalar-sdk-installation'?: {\n lang: string\n source?: string\n description?: string\n }[]\n}\n"],
|
|
5
|
+
"mappings": "AAAA,SAAS,YAAY;AAEd,MAAM,+BAA+B,KAAK,OAAO;AAAA,EACtD,6BAA6B,KAAK;AAAA,IAChC,KAAK;AAAA,MACH,KAAK,OAAO;AAAA,QACV,MAAM,KAAK,OAAO;AAAA,QAClB,QAAQ,KAAK,SAAS,KAAK,OAAO,CAAC;AAAA,QACnC,aAAa,KAAK,SAAS,KAAK,OAAO,CAAC;AAAA,MAC1C,CAAC;AAAA,IACH;AAAA,EACF;AACF,CAAC;",
|
|
6
6
|
"names": []
|
|
7
7
|
}
|
|
@@ -1,4 +1,7 @@
|
|
|
1
1
|
export declare const XTags: import("@scalar/typebox").TObject<{
|
|
2
2
|
'x-tags': import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TString>>;
|
|
3
3
|
}>;
|
|
4
|
+
export type XTags = {
|
|
5
|
+
'x-tags'?: string[];
|
|
6
|
+
};
|
|
4
7
|
//# sourceMappingURL=x-tags.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"x-tags.d.ts","sourceRoot":"","sources":["../../../../src/schemas/extensions/document/x-tags.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,KAAK;;EAEhB,CAAA"}
|
|
1
|
+
{"version":3,"file":"x-tags.d.ts","sourceRoot":"","sources":["../../../../src/schemas/extensions/document/x-tags.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,KAAK;;EAEhB,CAAA;AAEF,MAAM,MAAM,KAAK,GAAG;IAClB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;CACpB,CAAA"}
|