@scalar/workspace-store 0.56.1 → 0.57.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.
Files changed (120) hide show
  1. package/CHANGELOG.md +10 -0
  2. package/dist/entities/auth/schema.d.ts +220 -20
  3. package/dist/entities/auth/schema.d.ts.map +1 -1
  4. package/dist/schemas/reference-config/index.d.ts +28 -4
  5. package/dist/schemas/reference-config/index.d.ts.map +1 -1
  6. package/dist/schemas/reference-config/settings.d.ts +28 -4
  7. package/dist/schemas/reference-config/settings.d.ts.map +1 -1
  8. package/dist/schemas/v3.1/strict/oauth-flow.d.ts +19 -1
  9. package/dist/schemas/v3.1/strict/oauth-flow.d.ts.map +1 -1
  10. package/dist/schemas/v3.1/strict/oauth-flow.js +6 -1
  11. package/dist/schemas/v3.1/strict/oauthflows.d.ts +16 -0
  12. package/dist/schemas/v3.1/strict/oauthflows.d.ts.map +1 -1
  13. package/dist/schemas/v3.1/strict/openapi-document.d.ts +980 -140
  14. package/dist/schemas/v3.1/strict/openapi-document.d.ts.map +1 -1
  15. package/dist/schemas/v3.1/strict/security-scheme.d.ts +14 -5
  16. package/dist/schemas/v3.1/strict/security-scheme.d.ts.map +1 -1
  17. package/dist/schemas/v3.1/strict/security-scheme.js +5 -2
  18. package/dist/schemas/v3.2/openapi/index.d.ts +144 -0
  19. package/dist/schemas/v3.2/openapi/index.d.ts.map +1 -0
  20. package/dist/schemas/v3.2/openapi/index.js +713 -0
  21. package/dist/schemas/v3.2/openapi/reference.d.ts +4 -0
  22. package/dist/schemas/v3.2/openapi/reference.d.ts.map +1 -0
  23. package/dist/schemas/v3.2/openapi/reference.js +29 -0
  24. package/dist/schemas/v3.2/strict/callback.d.ts +15 -0
  25. package/dist/schemas/v3.2/strict/callback.d.ts.map +1 -0
  26. package/dist/schemas/v3.2/strict/callback.js +6 -0
  27. package/dist/schemas/v3.2/strict/components.d.ts +173 -0
  28. package/dist/schemas/v3.2/strict/components.d.ts.map +1 -0
  29. package/dist/schemas/v3.2/strict/components.js +29 -0
  30. package/dist/schemas/v3.2/strict/contact.d.ts +19 -0
  31. package/dist/schemas/v3.2/strict/contact.d.ts.map +1 -0
  32. package/dist/schemas/v3.2/strict/contact.js +10 -0
  33. package/dist/schemas/v3.2/strict/discriminator.d.ts +27 -0
  34. package/dist/schemas/v3.2/strict/discriminator.d.ts.map +1 -0
  35. package/dist/schemas/v3.2/strict/discriminator.js +14 -0
  36. package/dist/schemas/v3.2/strict/encoding.d.ts +62 -0
  37. package/dist/schemas/v3.2/strict/encoding.d.ts.map +1 -0
  38. package/dist/schemas/v3.2/strict/encoding.js +33 -0
  39. package/dist/schemas/v3.2/strict/example.d.ts +50 -0
  40. package/dist/schemas/v3.2/strict/example.d.ts.map +1 -0
  41. package/dist/schemas/v3.2/strict/example.js +22 -0
  42. package/dist/schemas/v3.2/strict/external-documentation.d.ts +15 -0
  43. package/dist/schemas/v3.2/strict/external-documentation.d.ts.map +1 -0
  44. package/dist/schemas/v3.2/strict/external-documentation.js +8 -0
  45. package/dist/schemas/v3.2/strict/header.d.ts +97 -0
  46. package/dist/schemas/v3.2/strict/header.d.ts.map +1 -0
  47. package/dist/schemas/v3.2/strict/header.js +39 -0
  48. package/dist/schemas/v3.2/strict/info.d.ts +54 -0
  49. package/dist/schemas/v3.2/strict/info.d.ts.map +1 -0
  50. package/dist/schemas/v3.2/strict/info.js +24 -0
  51. package/dist/schemas/v3.2/strict/license.d.ts +19 -0
  52. package/dist/schemas/v3.2/strict/license.d.ts.map +1 -0
  53. package/dist/schemas/v3.2/strict/license.js +10 -0
  54. package/dist/schemas/v3.2/strict/link.d.ts +44 -0
  55. package/dist/schemas/v3.2/strict/link.d.ts.map +1 -0
  56. package/dist/schemas/v3.2/strict/link.js +23 -0
  57. package/dist/schemas/v3.2/strict/media-type.d.ts +78 -0
  58. package/dist/schemas/v3.2/strict/media-type.d.ts.map +1 -0
  59. package/dist/schemas/v3.2/strict/media-type.js +26 -0
  60. package/dist/schemas/v3.2/strict/oauth-flow.d.ts +159 -0
  61. package/dist/schemas/v3.2/strict/oauth-flow.d.ts.map +1 -0
  62. package/dist/schemas/v3.2/strict/oauth-flow.js +44 -0
  63. package/dist/schemas/v3.2/strict/oauthflows.d.ts +116 -0
  64. package/dist/schemas/v3.2/strict/oauthflows.d.ts.map +1 -0
  65. package/dist/schemas/v3.2/strict/oauthflows.js +17 -0
  66. package/dist/schemas/v3.2/strict/openapi-document.d.ts +64576 -0
  67. package/dist/schemas/v3.2/strict/openapi-document.d.ts.map +1 -0
  68. package/dist/schemas/v3.2/strict/openapi-document.js +154 -0
  69. package/dist/schemas/v3.2/strict/operation.d.ts +165 -0
  70. package/dist/schemas/v3.2/strict/operation.d.ts.map +1 -0
  71. package/dist/schemas/v3.2/strict/operation.js +40 -0
  72. package/dist/schemas/v3.2/strict/parameter.d.ts +142 -0
  73. package/dist/schemas/v3.2/strict/parameter.d.ts.map +1 -0
  74. package/dist/schemas/v3.2/strict/parameter.js +58 -0
  75. package/dist/schemas/v3.2/strict/path-item.d.ts +189 -0
  76. package/dist/schemas/v3.2/strict/path-item.d.ts.map +1 -0
  77. package/dist/schemas/v3.2/strict/path-item.js +41 -0
  78. package/dist/schemas/v3.2/strict/paths.d.ts +20 -0
  79. package/dist/schemas/v3.2/strict/paths.d.ts.map +1 -0
  80. package/dist/schemas/v3.2/strict/paths.js +9 -0
  81. package/dist/schemas/v3.2/strict/ref-definitions.d.ts +76 -0
  82. package/dist/schemas/v3.2/strict/ref-definitions.d.ts.map +1 -0
  83. package/dist/schemas/v3.2/strict/ref-definitions.js +80 -0
  84. package/dist/schemas/v3.2/strict/reference.d.ts +63 -0
  85. package/dist/schemas/v3.2/strict/reference.d.ts.map +1 -0
  86. package/dist/schemas/v3.2/strict/reference.js +23 -0
  87. package/dist/schemas/v3.2/strict/request-body.d.ts +23 -0
  88. package/dist/schemas/v3.2/strict/request-body.d.ts.map +1 -0
  89. package/dist/schemas/v3.2/strict/request-body.js +13 -0
  90. package/dist/schemas/v3.2/strict/response.d.ts +50 -0
  91. package/dist/schemas/v3.2/strict/response.d.ts.map +1 -0
  92. package/dist/schemas/v3.2/strict/response.js +15 -0
  93. package/dist/schemas/v3.2/strict/responses.d.ts +32 -0
  94. package/dist/schemas/v3.2/strict/responses.d.ts.map +1 -0
  95. package/dist/schemas/v3.2/strict/responses.js +13 -0
  96. package/dist/schemas/v3.2/strict/schema.d.ts +1330 -0
  97. package/dist/schemas/v3.2/strict/schema.d.ts.map +1 -0
  98. package/dist/schemas/v3.2/strict/schema.js +205 -0
  99. package/dist/schemas/v3.2/strict/security-requirement.d.ts +23 -0
  100. package/dist/schemas/v3.2/strict/security-requirement.d.ts.map +1 -0
  101. package/dist/schemas/v3.2/strict/security-requirement.js +13 -0
  102. package/dist/schemas/v3.2/strict/security-scheme.d.ts +95 -0
  103. package/dist/schemas/v3.2/strict/security-scheme.d.ts.map +1 -0
  104. package/dist/schemas/v3.2/strict/security-scheme.js +46 -0
  105. package/dist/schemas/v3.2/strict/server-variable.d.ts +19 -0
  106. package/dist/schemas/v3.2/strict/server-variable.d.ts.map +1 -0
  107. package/dist/schemas/v3.2/strict/server-variable.js +10 -0
  108. package/dist/schemas/v3.2/strict/server.d.ts +24 -0
  109. package/dist/schemas/v3.2/strict/server.d.ts.map +1 -0
  110. package/dist/schemas/v3.2/strict/server.js +13 -0
  111. package/dist/schemas/v3.2/strict/tag.d.ts +44 -0
  112. package/dist/schemas/v3.2/strict/tag.d.ts.map +1 -0
  113. package/dist/schemas/v3.2/strict/tag.js +22 -0
  114. package/dist/schemas/v3.2/strict/type-guards.d.ts +24 -0
  115. package/dist/schemas/v3.2/strict/type-guards.d.ts.map +1 -0
  116. package/dist/schemas/v3.2/strict/type-guards.js +25 -0
  117. package/dist/schemas/v3.2/strict/xml.d.ts +39 -0
  118. package/dist/schemas/v3.2/strict/xml.d.ts.map +1 -0
  119. package/dist/schemas/v3.2/strict/xml.js +26 -0
  120. package/package.json +4 -4
@@ -0,0 +1,159 @@
1
+ import { type XScalarCredentialsLocation } from '../../../schemas/extensions/security/x-scalar-credentials-location.js';
2
+ import { type XScalarSecurityBody } from '../../../schemas/extensions/security/x-scalar-security-body.js';
3
+ import { type XScalarSecurityQuery } from '../../../schemas/extensions/security/x-scalar-security-query.js';
4
+ import { type XScalarAuthUrl, type XScalarTokenUrl } from '../../../schemas/extensions/security/x-scalar-security-secrets.js';
5
+ import { type XTokenName } from '../../../schemas/extensions/security/x-tokenName.js';
6
+ import { type XusePkce } from '../../../schemas/extensions/security/x-use-pkce.js';
7
+ /** Common properties used across all OAuth flows */
8
+ type OAuthFlowCommon = {
9
+ /** The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. */
10
+ refreshUrl: string;
11
+ /** REQUIRED. The available scopes for the OAuth2 security scheme. A map between the scope name and a short description for it. The map MAY be empty. */
12
+ scopes: Record<string, string>;
13
+ } & XScalarSecurityQuery & XScalarSecurityBody & XTokenName & XScalarTokenUrl & XScalarAuthUrl;
14
+ /** Configuration for the OAuth Implicit flow */
15
+ export declare const OAuthFlowImplicitSchema: import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
16
+ /** The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. */
17
+ refreshUrl: import("@scalar/typebox").TString;
18
+ /** REQUIRED. The available scopes for the OAuth2 security scheme. A map between the scope name and a short description for it. The map MAY be empty. */
19
+ scopes: import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TString>;
20
+ }>, import("@scalar/typebox").TObject<{
21
+ 'x-scalar-security-query': import("@scalar/typebox").TOptional<import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TString>>;
22
+ }>, import("@scalar/typebox").TObject<{
23
+ 'x-scalar-security-body': import("@scalar/typebox").TOptional<import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TString>>;
24
+ }>, import("@scalar/typebox").TObject<{
25
+ 'x-tokenName': import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
26
+ }>, import("@scalar/typebox").TObject<{
27
+ 'x-scalar-secret-auth-url': import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
28
+ }>, import("@scalar/typebox").TObject<{
29
+ 'x-scalar-secret-token-url': import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
30
+ }>]>, import("@scalar/typebox").TObject<{
31
+ /** REQUIRED. The authorization URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. */
32
+ authorizationUrl: import("@scalar/typebox").TString;
33
+ }>]>;
34
+ /** Configuration for the OAuth Implicit flow */
35
+ export type OAuthFlowImplicit = OAuthFlowCommon & {
36
+ /** REQUIRED. The authorization URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. */
37
+ authorizationUrl: string;
38
+ };
39
+ /** Configuration for the OAuth Resource Owner Password flow */
40
+ export declare const OAuthFlowPasswordSchema: import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
41
+ /** The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. */
42
+ refreshUrl: import("@scalar/typebox").TString;
43
+ /** REQUIRED. The available scopes for the OAuth2 security scheme. A map between the scope name and a short description for it. The map MAY be empty. */
44
+ scopes: import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TString>;
45
+ }>, import("@scalar/typebox").TObject<{
46
+ 'x-scalar-security-query': import("@scalar/typebox").TOptional<import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TString>>;
47
+ }>, import("@scalar/typebox").TObject<{
48
+ 'x-scalar-security-body': import("@scalar/typebox").TOptional<import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TString>>;
49
+ }>, import("@scalar/typebox").TObject<{
50
+ 'x-tokenName': import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
51
+ }>, import("@scalar/typebox").TObject<{
52
+ 'x-scalar-secret-auth-url': import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
53
+ }>, import("@scalar/typebox").TObject<{
54
+ 'x-scalar-secret-token-url': import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
55
+ }>]>, import("@scalar/typebox").TObject<{
56
+ /** REQUIRED. The token URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. */
57
+ tokenUrl: import("@scalar/typebox").TString;
58
+ }>, import("@scalar/typebox").TObject<{
59
+ 'x-scalar-credentials-location': import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"header">, import("@scalar/typebox").TLiteral<"body">]>>;
60
+ }>]>;
61
+ /** Configuration for the OAuth Resource Owner Password flow */
62
+ export type OAuthFlowPassword = OAuthFlowCommon & {
63
+ /** REQUIRED. The token URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. */
64
+ tokenUrl: string;
65
+ } & XScalarCredentialsLocation;
66
+ /** Configuration for the OAuth Client Credentials flow. Previously called application in OpenAPI 2.0. */
67
+ export declare const OAuthFlowClientCredentialsSchema: import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
68
+ /** The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. */
69
+ refreshUrl: import("@scalar/typebox").TString;
70
+ /** REQUIRED. The available scopes for the OAuth2 security scheme. A map between the scope name and a short description for it. The map MAY be empty. */
71
+ scopes: import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TString>;
72
+ }>, import("@scalar/typebox").TObject<{
73
+ 'x-scalar-security-query': import("@scalar/typebox").TOptional<import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TString>>;
74
+ }>, import("@scalar/typebox").TObject<{
75
+ 'x-scalar-security-body': import("@scalar/typebox").TOptional<import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TString>>;
76
+ }>, import("@scalar/typebox").TObject<{
77
+ 'x-tokenName': import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
78
+ }>, import("@scalar/typebox").TObject<{
79
+ 'x-scalar-secret-auth-url': import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
80
+ }>, import("@scalar/typebox").TObject<{
81
+ 'x-scalar-secret-token-url': import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
82
+ }>]>, import("@scalar/typebox").TObject<{
83
+ /** REQUIRED. The token URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. */
84
+ tokenUrl: import("@scalar/typebox").TString;
85
+ }>, import("@scalar/typebox").TObject<{
86
+ 'x-scalar-credentials-location': import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"header">, import("@scalar/typebox").TLiteral<"body">]>>;
87
+ }>]>;
88
+ /** Configuration for the OAuth Client Credentials flow. Previously called application in OpenAPI 2.0. */
89
+ export type OAuthFlowClientCredentials = OAuthFlowCommon & {
90
+ /** REQUIRED. The token URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. */
91
+ tokenUrl: string;
92
+ } & XScalarCredentialsLocation;
93
+ /** Configuration for the OAuth Authorization Code flow. Previously called accessCode in OpenAPI 2.0. */
94
+ export declare const OAuthFlowAuthorizationCodeSchema: import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
95
+ /** The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. */
96
+ refreshUrl: import("@scalar/typebox").TString;
97
+ /** REQUIRED. The available scopes for the OAuth2 security scheme. A map between the scope name and a short description for it. The map MAY be empty. */
98
+ scopes: import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TString>;
99
+ }>, import("@scalar/typebox").TObject<{
100
+ 'x-scalar-security-query': import("@scalar/typebox").TOptional<import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TString>>;
101
+ }>, import("@scalar/typebox").TObject<{
102
+ 'x-scalar-security-body': import("@scalar/typebox").TOptional<import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TString>>;
103
+ }>, import("@scalar/typebox").TObject<{
104
+ 'x-tokenName': import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
105
+ }>, import("@scalar/typebox").TObject<{
106
+ 'x-scalar-secret-auth-url': import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
107
+ }>, import("@scalar/typebox").TObject<{
108
+ 'x-scalar-secret-token-url': import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
109
+ }>]>, import("@scalar/typebox").TObject<{
110
+ /** REQUIRED. The authorization URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. */
111
+ authorizationUrl: import("@scalar/typebox").TString;
112
+ /** REQUIRED. The token URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. */
113
+ tokenUrl: import("@scalar/typebox").TString;
114
+ }>, import("@scalar/typebox").TObject<{
115
+ 'x-usePkce': import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"SHA-256">, import("@scalar/typebox").TLiteral<"plain">, import("@scalar/typebox").TLiteral<"no">]>;
116
+ }>, import("@scalar/typebox").TObject<{
117
+ 'x-scalar-credentials-location': import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"header">, import("@scalar/typebox").TLiteral<"body">]>>;
118
+ }>]>;
119
+ /** Configuration for the OAuth Authorization Code flow. Previously called accessCode in OpenAPI 2.0. */
120
+ export type OAuthFlowAuthorizationCode = OAuthFlowCommon & {
121
+ /** REQUIRED. The authorization URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. */
122
+ authorizationUrl: string;
123
+ /** REQUIRED. The token URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. */
124
+ tokenUrl: string;
125
+ } & XusePkce & XScalarCredentialsLocation;
126
+ /** Configuration for the OAuth Device Authorization flow. Added in OpenAPI 3.2. */
127
+ export declare const OAuthFlowDeviceAuthorizationSchema: import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
128
+ /** The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. */
129
+ refreshUrl: import("@scalar/typebox").TString;
130
+ /** REQUIRED. The available scopes for the OAuth2 security scheme. A map between the scope name and a short description for it. The map MAY be empty. */
131
+ scopes: import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TString>;
132
+ }>, import("@scalar/typebox").TObject<{
133
+ 'x-scalar-security-query': import("@scalar/typebox").TOptional<import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TString>>;
134
+ }>, import("@scalar/typebox").TObject<{
135
+ 'x-scalar-security-body': import("@scalar/typebox").TOptional<import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TString>>;
136
+ }>, import("@scalar/typebox").TObject<{
137
+ 'x-tokenName': import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
138
+ }>, import("@scalar/typebox").TObject<{
139
+ 'x-scalar-secret-auth-url': import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
140
+ }>, import("@scalar/typebox").TObject<{
141
+ 'x-scalar-secret-token-url': import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
142
+ }>]>, import("@scalar/typebox").TObject<{
143
+ /** REQUIRED. The device authorization URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. Added in OpenAPI 3.2. */
144
+ deviceAuthorizationUrl: import("@scalar/typebox").TString;
145
+ /** REQUIRED. The token URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. Added in OpenAPI 3.2. */
146
+ tokenUrl: import("@scalar/typebox").TString;
147
+ }>, import("@scalar/typebox").TObject<{
148
+ 'x-scalar-credentials-location': import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"header">, import("@scalar/typebox").TLiteral<"body">]>>;
149
+ }>]>;
150
+ /** Configuration for the OAuth Device Authorization flow. Added in OpenAPI 3.2. */
151
+ export type OAuthFlowDeviceAuthorization = OAuthFlowCommon & {
152
+ /** REQUIRED. The device authorization URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. Added in OpenAPI 3.2. */
153
+ deviceAuthorizationUrl: string;
154
+ /** REQUIRED. The token URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. Added in OpenAPI 3.2. */
155
+ tokenUrl: string;
156
+ } & XScalarCredentialsLocation;
157
+ export type OAuthFlow = OAuthFlowImplicit | OAuthFlowPassword | OAuthFlowClientCredentials | OAuthFlowAuthorizationCode | OAuthFlowDeviceAuthorization;
158
+ export {};
159
+ //# sourceMappingURL=oauth-flow.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"oauth-flow.d.ts","sourceRoot":"","sources":["../../../../src/schemas/v3.2/strict/oauth-flow.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,KAAK,0BAA0B,EAEhC,MAAM,6DAA6D,CAAA;AACpE,OAAO,EACL,KAAK,mBAAmB,EAEzB,MAAM,sDAAsD,CAAA;AAC7D,OAAO,EACL,KAAK,oBAAoB,EAE1B,MAAM,uDAAuD,CAAA;AAC9D,OAAO,EACL,KAAK,cAAc,EAEnB,KAAK,eAAe,EAErB,MAAM,yDAAyD,CAAA;AAChE,OAAO,EAAE,KAAK,UAAU,EAAoB,MAAM,2CAA2C,CAAA;AAC7F,OAAO,EAAE,KAAK,QAAQ,EAAkB,MAAM,0CAA0C,CAAA;AAiBxF,oDAAoD;AACpD,KAAK,eAAe,GAAG;IACrB,uIAAuI;IACvI,UAAU,EAAE,MAAM,CAAA;IAClB,wJAAwJ;IACxJ,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CAC/B,GAAG,oBAAoB,GACtB,mBAAmB,GACnB,UAAU,GACV,eAAe,GACf,cAAc,CAAA;AAEhB,gDAAgD;AAChD,eAAO,MAAM,uBAAuB;IAzBhC,uIAAuI;;IAEvI,wJAAwJ;;;;;;;;;;;;;IA0BxJ,gJAAgJ;;IAGnJ,CAAA;AAED,gDAAgD;AAChD,MAAM,MAAM,iBAAiB,GAAG,eAAe,GAAG;IAChD,gJAAgJ;IAChJ,gBAAgB,EAAE,MAAM,CAAA;CACzB,CAAA;AAED,+DAA+D;AAC/D,eAAO,MAAM,uBAAuB;IAxChC,uIAAuI;;IAEvI,wJAAwJ;;;;;;;;;;;;;IAyCxJ,wIAAwI;;;;IAI3I,CAAA;AAED,+DAA+D;AAC/D,MAAM,MAAM,iBAAiB,GAAG,eAAe,GAAG;IAChD,wIAAwI;IACxI,QAAQ,EAAE,MAAM,CAAA;CACjB,GAAG,0BAA0B,CAAA;AAE9B,yGAAyG;AACzG,eAAO,MAAM,gCAAgC;IAxDzC,uIAAuI;;IAEvI,wJAAwJ;;;;;;;;;;;;;IAyDxJ,wIAAwI;;;;IAI3I,CAAA;AAED,yGAAyG;AACzG,MAAM,MAAM,0BAA0B,GAAG,eAAe,GAAG;IACzD,wIAAwI;IACxI,QAAQ,EAAE,MAAM,CAAA;CACjB,GAAG,0BAA0B,CAAA;AAE9B,wGAAwG;AACxG,eAAO,MAAM,gCAAgC;IAxEzC,uIAAuI;;IAEvI,wJAAwJ;;;;;;;;;;;;;IAyExJ,gJAAgJ;;IAEhJ,wIAAwI;;;;;;IAK3I,CAAA;AAED,wGAAwG;AACxG,MAAM,MAAM,0BAA0B,GAAG,eAAe,GAAG;IACzD,gJAAgJ;IAChJ,gBAAgB,EAAE,MAAM,CAAA;IACxB,wIAAwI;IACxI,QAAQ,EAAE,MAAM,CAAA;CACjB,GAAG,QAAQ,GACV,0BAA0B,CAAA;AAE5B,mFAAmF;AACnF,eAAO,MAAM,kCAAkC;IA9F3C,uIAAuI;;IAEvI,wJAAwJ;;;;;;;;;;;;;IA+FxJ,6KAA6K;;IAE7K,8JAA8J;;;;IAIjK,CAAA;AAED,mFAAmF;AACnF,MAAM,MAAM,4BAA4B,GAAG,eAAe,GAAG;IAC3D,6KAA6K;IAC7K,sBAAsB,EAAE,MAAM,CAAA;IAC9B,8JAA8J;IAC9J,QAAQ,EAAE,MAAM,CAAA;CACjB,GAAG,0BAA0B,CAAA;AAE9B,MAAM,MAAM,SAAS,GACjB,iBAAiB,GACjB,iBAAiB,GACjB,0BAA0B,GAC1B,0BAA0B,GAC1B,4BAA4B,CAAA"}
@@ -0,0 +1,44 @@
1
+ import { Type } from '@scalar/typebox';
2
+ import { compose } from '../../../schemas/compose.js';
3
+ import { XScalarCredentialsLocationSchema, } from '../../../schemas/extensions/security/x-scalar-credentials-location.js';
4
+ import { XScalarSecurityBodySchema, } from '../../../schemas/extensions/security/x-scalar-security-body.js';
5
+ import { XScalarSecurityQuerySchema, } from '../../../schemas/extensions/security/x-scalar-security-query.js';
6
+ import { XScalarAuthUrlSchema, XScalarTokenUrlSchema, } from '../../../schemas/extensions/security/x-scalar-security-secrets.js';
7
+ import { XTokenNameSchema } from '../../../schemas/extensions/security/x-tokenName.js';
8
+ import { XusePkceSchema } from '../../../schemas/extensions/security/x-use-pkce.js';
9
+ /** Common properties used across all OAuth flows */
10
+ const OAuthFlowCommonSchema = compose(Type.Object({
11
+ /** The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. */
12
+ refreshUrl: Type.String(),
13
+ /** REQUIRED. The available scopes for the OAuth2 security scheme. A map between the scope name and a short description for it. The map MAY be empty. */
14
+ scopes: Type.Record(Type.String(), Type.String()),
15
+ }), XScalarSecurityQuerySchema, XScalarSecurityBodySchema, XTokenNameSchema, XScalarAuthUrlSchema, XScalarTokenUrlSchema);
16
+ /** Configuration for the OAuth Implicit flow */
17
+ export const OAuthFlowImplicitSchema = compose(OAuthFlowCommonSchema, Type.Object({
18
+ /** REQUIRED. The authorization URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. */
19
+ authorizationUrl: Type.String(),
20
+ }));
21
+ /** Configuration for the OAuth Resource Owner Password flow */
22
+ export const OAuthFlowPasswordSchema = compose(OAuthFlowCommonSchema, Type.Object({
23
+ /** REQUIRED. The token URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. */
24
+ tokenUrl: Type.String(),
25
+ }), XScalarCredentialsLocationSchema);
26
+ /** Configuration for the OAuth Client Credentials flow. Previously called application in OpenAPI 2.0. */
27
+ export const OAuthFlowClientCredentialsSchema = compose(OAuthFlowCommonSchema, Type.Object({
28
+ /** REQUIRED. The token URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. */
29
+ tokenUrl: Type.String(),
30
+ }), XScalarCredentialsLocationSchema);
31
+ /** Configuration for the OAuth Authorization Code flow. Previously called accessCode in OpenAPI 2.0. */
32
+ export const OAuthFlowAuthorizationCodeSchema = compose(OAuthFlowCommonSchema, Type.Object({
33
+ /** REQUIRED. The authorization URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. */
34
+ authorizationUrl: Type.String(),
35
+ /** REQUIRED. The token URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. */
36
+ tokenUrl: Type.String(),
37
+ }), XusePkceSchema, XScalarCredentialsLocationSchema);
38
+ /** Configuration for the OAuth Device Authorization flow. Added in OpenAPI 3.2. */
39
+ export const OAuthFlowDeviceAuthorizationSchema = compose(OAuthFlowCommonSchema, Type.Object({
40
+ /** REQUIRED. The device authorization URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. Added in OpenAPI 3.2. */
41
+ deviceAuthorizationUrl: Type.String(),
42
+ /** REQUIRED. The token URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. Added in OpenAPI 3.2. */
43
+ tokenUrl: Type.String(),
44
+ }), XScalarCredentialsLocationSchema);
@@ -0,0 +1,116 @@
1
+ import { type OAuthFlowAuthorizationCode, type OAuthFlowClientCredentials, type OAuthFlowDeviceAuthorization, type OAuthFlowImplicit, type OAuthFlowPassword } from './oauth-flow.js';
2
+ /**
3
+ * Allows configuration of the supported OAuth Flows.
4
+ */
5
+ export declare const OAuthFlowsObjectSchemaDefinition: import("@scalar/typebox").TObject<{
6
+ /** Configuration for the OAuth Implicit flow */
7
+ implicit: import("@scalar/typebox").TOptional<import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
8
+ refreshUrl: import("@scalar/typebox").TString;
9
+ scopes: import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TString>;
10
+ }>, import("@scalar/typebox").TObject<{
11
+ 'x-scalar-security-query': import("@scalar/typebox").TOptional<import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TString>>;
12
+ }>, import("@scalar/typebox").TObject<{
13
+ 'x-scalar-security-body': import("@scalar/typebox").TOptional<import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TString>>;
14
+ }>, import("@scalar/typebox").TObject<{
15
+ 'x-tokenName': import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
16
+ }>, import("@scalar/typebox").TObject<{
17
+ 'x-scalar-secret-auth-url': import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
18
+ }>, import("@scalar/typebox").TObject<{
19
+ 'x-scalar-secret-token-url': import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
20
+ }>]>, import("@scalar/typebox").TObject<{
21
+ authorizationUrl: import("@scalar/typebox").TString;
22
+ }>]>>;
23
+ /** Configuration for the OAuth Resource Owner Password flow */
24
+ password: import("@scalar/typebox").TOptional<import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
25
+ refreshUrl: import("@scalar/typebox").TString;
26
+ scopes: import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TString>;
27
+ }>, import("@scalar/typebox").TObject<{
28
+ 'x-scalar-security-query': import("@scalar/typebox").TOptional<import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TString>>;
29
+ }>, import("@scalar/typebox").TObject<{
30
+ 'x-scalar-security-body': import("@scalar/typebox").TOptional<import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TString>>;
31
+ }>, import("@scalar/typebox").TObject<{
32
+ 'x-tokenName': import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
33
+ }>, import("@scalar/typebox").TObject<{
34
+ 'x-scalar-secret-auth-url': import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
35
+ }>, import("@scalar/typebox").TObject<{
36
+ 'x-scalar-secret-token-url': import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
37
+ }>]>, import("@scalar/typebox").TObject<{
38
+ tokenUrl: import("@scalar/typebox").TString;
39
+ }>, import("@scalar/typebox").TObject<{
40
+ 'x-scalar-credentials-location': import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"header">, import("@scalar/typebox").TLiteral<"body">]>>;
41
+ }>]>>;
42
+ /** Configuration for the OAuth Client Credentials flow. Previously called application in OpenAPI 2.0. */
43
+ clientCredentials: import("@scalar/typebox").TOptional<import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
44
+ refreshUrl: import("@scalar/typebox").TString;
45
+ scopes: import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TString>;
46
+ }>, import("@scalar/typebox").TObject<{
47
+ 'x-scalar-security-query': import("@scalar/typebox").TOptional<import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TString>>;
48
+ }>, import("@scalar/typebox").TObject<{
49
+ 'x-scalar-security-body': import("@scalar/typebox").TOptional<import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TString>>;
50
+ }>, import("@scalar/typebox").TObject<{
51
+ 'x-tokenName': import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
52
+ }>, import("@scalar/typebox").TObject<{
53
+ 'x-scalar-secret-auth-url': import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
54
+ }>, import("@scalar/typebox").TObject<{
55
+ 'x-scalar-secret-token-url': import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
56
+ }>]>, import("@scalar/typebox").TObject<{
57
+ tokenUrl: import("@scalar/typebox").TString;
58
+ }>, import("@scalar/typebox").TObject<{
59
+ 'x-scalar-credentials-location': import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"header">, import("@scalar/typebox").TLiteral<"body">]>>;
60
+ }>]>>;
61
+ /** Configuration for the OAuth Authorization Code flow. Previously called accessCode in OpenAPI 2.0. */
62
+ authorizationCode: import("@scalar/typebox").TOptional<import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
63
+ refreshUrl: import("@scalar/typebox").TString;
64
+ scopes: import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TString>;
65
+ }>, import("@scalar/typebox").TObject<{
66
+ 'x-scalar-security-query': import("@scalar/typebox").TOptional<import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TString>>;
67
+ }>, import("@scalar/typebox").TObject<{
68
+ 'x-scalar-security-body': import("@scalar/typebox").TOptional<import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TString>>;
69
+ }>, import("@scalar/typebox").TObject<{
70
+ 'x-tokenName': import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
71
+ }>, import("@scalar/typebox").TObject<{
72
+ 'x-scalar-secret-auth-url': import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
73
+ }>, import("@scalar/typebox").TObject<{
74
+ 'x-scalar-secret-token-url': import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
75
+ }>]>, import("@scalar/typebox").TObject<{
76
+ authorizationUrl: import("@scalar/typebox").TString;
77
+ tokenUrl: import("@scalar/typebox").TString;
78
+ }>, import("@scalar/typebox").TObject<{
79
+ 'x-usePkce': import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"SHA-256">, import("@scalar/typebox").TLiteral<"plain">, import("@scalar/typebox").TLiteral<"no">]>;
80
+ }>, import("@scalar/typebox").TObject<{
81
+ 'x-scalar-credentials-location': import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"header">, import("@scalar/typebox").TLiteral<"body">]>>;
82
+ }>]>>;
83
+ /** Configuration for the OAuth Device Authorization flow. Added in OpenAPI 3.2. */
84
+ deviceAuthorization: import("@scalar/typebox").TOptional<import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
85
+ refreshUrl: import("@scalar/typebox").TString;
86
+ scopes: import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TString>;
87
+ }>, import("@scalar/typebox").TObject<{
88
+ 'x-scalar-security-query': import("@scalar/typebox").TOptional<import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TString>>;
89
+ }>, import("@scalar/typebox").TObject<{
90
+ 'x-scalar-security-body': import("@scalar/typebox").TOptional<import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TString>>;
91
+ }>, import("@scalar/typebox").TObject<{
92
+ 'x-tokenName': import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
93
+ }>, import("@scalar/typebox").TObject<{
94
+ 'x-scalar-secret-auth-url': import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
95
+ }>, import("@scalar/typebox").TObject<{
96
+ 'x-scalar-secret-token-url': import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
97
+ }>]>, import("@scalar/typebox").TObject<{
98
+ deviceAuthorizationUrl: import("@scalar/typebox").TString;
99
+ tokenUrl: import("@scalar/typebox").TString;
100
+ }>, import("@scalar/typebox").TObject<{
101
+ 'x-scalar-credentials-location': import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"header">, import("@scalar/typebox").TLiteral<"body">]>>;
102
+ }>]>>;
103
+ }>;
104
+ export type OAuthFlowsObject = {
105
+ /** Configuration for the OAuth Implicit flow */
106
+ implicit?: OAuthFlowImplicit;
107
+ /** Configuration for the OAuth Resource Owner Password flow */
108
+ password?: OAuthFlowPassword;
109
+ /** Configuration for the OAuth Client Credentials flow. Previously called application in OpenAPI 2.0. */
110
+ clientCredentials?: OAuthFlowClientCredentials;
111
+ /** Configuration for the OAuth Authorization Code flow. Previously called accessCode in OpenAPI 2.0. */
112
+ authorizationCode?: OAuthFlowAuthorizationCode;
113
+ /** Configuration for the OAuth Device Authorization flow. Added in OpenAPI 3.2. */
114
+ deviceAuthorization?: OAuthFlowDeviceAuthorization;
115
+ };
116
+ //# sourceMappingURL=oauthflows.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"oauthflows.d.ts","sourceRoot":"","sources":["../../../../src/schemas/v3.2/strict/oauthflows.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,KAAK,0BAA0B,EAE/B,KAAK,0BAA0B,EAE/B,KAAK,4BAA4B,EAEjC,KAAK,iBAAiB,EAEtB,KAAK,iBAAiB,EAEvB,MAAM,cAAc,CAAA;AAErB;;GAEG;AACH,eAAO,MAAM,gCAAgC;IAC3C,gDAAgD;;;;;;;;;;;;;;;;;IAEhD,+DAA+D;;;;;;;;;;;;;;;;;;;IAE/D,yGAAyG;;;;;;;;;;;;;;;;;;;IAEzG,wGAAwG;;;;;;;;;;;;;;;;;;;;;;IAExG,mFAAmF;;;;;;;;;;;;;;;;;;;;EAEnF,CAAA;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,gDAAgD;IAChD,QAAQ,CAAC,EAAE,iBAAiB,CAAA;IAC5B,+DAA+D;IAC/D,QAAQ,CAAC,EAAE,iBAAiB,CAAA;IAC5B,yGAAyG;IACzG,iBAAiB,CAAC,EAAE,0BAA0B,CAAA;IAC9C,wGAAwG;IACxG,iBAAiB,CAAC,EAAE,0BAA0B,CAAA;IAC9C,mFAAmF;IACnF,mBAAmB,CAAC,EAAE,4BAA4B,CAAA;CACnD,CAAA"}
@@ -0,0 +1,17 @@
1
+ import { Type } from '@scalar/typebox';
2
+ import { OAuthFlowAuthorizationCodeSchema, OAuthFlowClientCredentialsSchema, OAuthFlowDeviceAuthorizationSchema, OAuthFlowImplicitSchema, OAuthFlowPasswordSchema, } from './oauth-flow.js';
3
+ /**
4
+ * Allows configuration of the supported OAuth Flows.
5
+ */
6
+ export const OAuthFlowsObjectSchemaDefinition = Type.Object({
7
+ /** Configuration for the OAuth Implicit flow */
8
+ implicit: Type.Optional(OAuthFlowImplicitSchema),
9
+ /** Configuration for the OAuth Resource Owner Password flow */
10
+ password: Type.Optional(OAuthFlowPasswordSchema),
11
+ /** Configuration for the OAuth Client Credentials flow. Previously called application in OpenAPI 2.0. */
12
+ clientCredentials: Type.Optional(OAuthFlowClientCredentialsSchema),
13
+ /** Configuration for the OAuth Authorization Code flow. Previously called accessCode in OpenAPI 2.0. */
14
+ authorizationCode: Type.Optional(OAuthFlowAuthorizationCodeSchema),
15
+ /** Configuration for the OAuth Device Authorization flow. Added in OpenAPI 3.2. */
16
+ deviceAuthorization: Type.Optional(OAuthFlowDeviceAuthorizationSchema),
17
+ });