@scalar/workspace-store 0.53.0 → 0.54.1
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 +38 -0
- package/dist/entities/auth/schema.d.ts +265 -5
- package/dist/entities/auth/schema.d.ts.map +1 -1
- package/dist/events/definitions/meta.d.ts +5 -3
- package/dist/events/definitions/meta.d.ts.map +1 -1
- package/dist/events/definitions/server.d.ts +21 -0
- package/dist/events/definitions/server.d.ts.map +1 -1
- package/dist/events/definitions/workspace.d.ts +7 -3
- package/dist/events/definitions/workspace.d.ts.map +1 -1
- package/dist/mutators/index.d.ts +4 -0
- package/dist/mutators/index.d.ts.map +1 -1
- package/dist/mutators/server.d.ts +26 -0
- package/dist/mutators/server.d.ts.map +1 -1
- package/dist/mutators/server.js +44 -1
- package/dist/request-example/builder/body/build-request-body.d.ts.map +1 -1
- package/dist/request-example/builder/body/build-request-body.js +32 -1
- package/dist/request-example/builder/body/serialize-form-property.d.ts +23 -0
- package/dist/request-example/builder/body/serialize-form-property.d.ts.map +1 -0
- package/dist/request-example/builder/body/serialize-form-property.js +101 -0
- package/dist/request-example/builder/header/de-serialize-parameter.d.ts +4 -1
- package/dist/request-example/builder/header/de-serialize-parameter.d.ts.map +1 -1
- package/dist/request-example/builder/header/de-serialize-parameter.js +19 -13
- package/dist/request-example/builder/index.d.ts +1 -0
- package/dist/request-example/builder/index.d.ts.map +1 -1
- package/dist/request-example/builder/index.js +1 -0
- package/dist/request-example/context/security/extract-security-scheme-secrets.d.ts +1 -1
- package/dist/request-example/context/security/extract-security-scheme-secrets.d.ts.map +1 -1
- package/dist/request-example/context/security/extract-security-scheme-secrets.js +12 -8
- package/dist/request-example/context/security/merge-security.d.ts +1 -1
- package/dist/request-example/context/security/merge-security.d.ts.map +1 -1
- package/dist/request-example/context/security/merge-security.js +2 -2
- package/dist/request-example/index.d.ts +1 -1
- package/dist/request-example/index.d.ts.map +1 -1
- package/dist/request-example/index.js +1 -1
- package/dist/schemas/extensions/document/x-scalar-sdk-installation.d.ts +1 -3
- package/dist/schemas/extensions/document/x-scalar-sdk-installation.d.ts.map +1 -1
- package/dist/schemas/extensions/document/x-scalar-sdk-installation.js +0 -2
- package/dist/schemas/extensions/operation/index.d.ts +1 -1
- package/dist/schemas/extensions/operation/index.d.ts.map +1 -1
- package/dist/schemas/extensions/operation/x-code-samples.d.ts +71 -0
- package/dist/schemas/extensions/operation/x-code-samples.d.ts.map +1 -1
- package/dist/schemas/extensions/operation/x-code-samples.js +50 -7
- package/dist/schemas/reference-config/index.d.ts +53 -1
- package/dist/schemas/reference-config/index.d.ts.map +1 -1
- package/dist/schemas/reference-config/settings.d.ts +53 -1
- package/dist/schemas/reference-config/settings.d.ts.map +1 -1
- package/dist/schemas/v3.1/openapi/index.d.ts +0 -1
- package/dist/schemas/v3.1/openapi/index.d.ts.map +1 -1
- package/dist/schemas/v3.1/strict/info.d.ts +0 -1
- package/dist/schemas/v3.1/strict/info.d.ts.map +1 -1
- package/dist/schemas/v3.1/strict/openapi-document.d.ts +1855 -35
- package/dist/schemas/v3.1/strict/openapi-document.d.ts.map +1 -1
- package/dist/schemas/v3.1/strict/operation.d.ts +25 -0
- package/dist/schemas/v3.1/strict/operation.d.ts.map +1 -1
- package/dist/schemas/v3.1/strict/schema.d.ts +128 -0
- package/dist/schemas/v3.1/strict/schema.d.ts.map +1 -1
- package/dist/schemas/v3.1/strict/schema.js +16 -0
- package/dist/schemas/workspace-specification/index.d.ts +1 -1
- package/dist/schemas/workspace.d.ts +2 -3
- package/dist/schemas/workspace.d.ts.map +1 -1
- package/dist/schemas/workspace.js +5 -1
- package/package.json +8 -8
|
@@ -14,7 +14,7 @@ const SECRET_TO_INPUT_FIELD_MAP = {
|
|
|
14
14
|
'x-scalar-secret-auth-url': 'authorizationUrl',
|
|
15
15
|
'x-scalar-secret-token-url': 'tokenUrl',
|
|
16
16
|
};
|
|
17
|
-
const mergeFlowSecrets = (properties, configSecrets, authStoreSecrets = {}) => Object.fromEntries(properties.map((property) => {
|
|
17
|
+
const mergeFlowSecrets = (properties, configSecrets, authStoreSecrets = {}, oauth2RedirectUri) => Object.fromEntries(properties.map((property) => {
|
|
18
18
|
// Redirect URI is the only OAuth secret where an explicit empty value from
|
|
19
19
|
// store must be preserved. Other secrets use falsy fallback behavior for backwards-compatibility
|
|
20
20
|
// with config defaults when the casted auth store value is an empty string.
|
|
@@ -23,8 +23,12 @@ const mergeFlowSecrets = (properties, configSecrets, authStoreSecrets = {}) => O
|
|
|
23
23
|
const configInputValue = typeof configSecrets[SECRET_TO_INPUT_FIELD_MAP[property]] === 'string'
|
|
24
24
|
? configSecrets[SECRET_TO_INPUT_FIELD_MAP[property]]
|
|
25
25
|
: undefined;
|
|
26
|
+
// oauth2RedirectUri (top-level config option) is used as a global fallback for the redirect URI,
|
|
27
|
+
// applied only when neither the auth store nor per-scheme config have a value. This ensures
|
|
28
|
+
// the configured redirect URI persists when switching between documents with the same OAuth config,
|
|
29
|
+
// because each document starts with no stored redirect URI (authStoreValue === undefined).
|
|
26
30
|
const value = property === 'x-scalar-secret-redirect-uri'
|
|
27
|
-
? (authStoreValue ?? configValue ?? configInputValue ?? '')
|
|
31
|
+
? (authStoreValue ?? configValue ?? configInputValue ?? oauth2RedirectUri ?? '')
|
|
28
32
|
: authStoreValue || configValue || configInputValue || '';
|
|
29
33
|
return [property, value];
|
|
30
34
|
}));
|
|
@@ -44,7 +48,7 @@ const extractCredentialsLocation = (configSecrets, authStoreSecrets = {}) => {
|
|
|
44
48
|
* Extract flow secrets and selected scopes for OAuth-like flows.
|
|
45
49
|
* Reused by both oauth2 and openIdConnect security schemes.
|
|
46
50
|
*/
|
|
47
|
-
const extractOAuthFlowSecrets = (flows, storeSecrets) => {
|
|
51
|
+
const extractOAuthFlowSecrets = (flows, storeSecrets, oauth2RedirectUri) => {
|
|
48
52
|
const selectedScopes = new Set();
|
|
49
53
|
const extractedFlows = objectEntries(flows ?? {}).reduce((acc, [key, flow]) => {
|
|
50
54
|
if (!isObject(flow)) {
|
|
@@ -64,7 +68,7 @@ const extractOAuthFlowSecrets = (flows, storeSecrets) => {
|
|
|
64
68
|
'x-scalar-secret-redirect-uri',
|
|
65
69
|
'x-scalar-secret-token',
|
|
66
70
|
'x-scalar-secret-auth-url',
|
|
67
|
-
], flow, storeSecrets?.implicit),
|
|
71
|
+
], flow, storeSecrets?.implicit, oauth2RedirectUri),
|
|
68
72
|
...extractRefreshTokenSecret(storeSecrets?.implicit),
|
|
69
73
|
};
|
|
70
74
|
}
|
|
@@ -109,7 +113,7 @@ const extractOAuthFlowSecrets = (flows, storeSecrets) => {
|
|
|
109
113
|
'x-scalar-secret-token',
|
|
110
114
|
'x-scalar-secret-auth-url',
|
|
111
115
|
'x-scalar-secret-token-url',
|
|
112
|
-
], flow, storeSecrets?.authorizationCode),
|
|
116
|
+
], flow, storeSecrets?.authorizationCode, oauth2RedirectUri),
|
|
113
117
|
...extractCredentialsLocation(flow, storeSecrets?.authorizationCode),
|
|
114
118
|
...extractRefreshTokenSecret(storeSecrets?.authorizationCode),
|
|
115
119
|
};
|
|
@@ -121,7 +125,7 @@ const extractOAuthFlowSecrets = (flows, storeSecrets) => {
|
|
|
121
125
|
/** Extract the secrets from the config and the auth store */
|
|
122
126
|
export const extractSecuritySchemeSecrets = (
|
|
123
127
|
// Include the config fields
|
|
124
|
-
scheme, authStore, name, documentSlug) => {
|
|
128
|
+
scheme, authStore, name, documentSlug, oauth2RedirectUri) => {
|
|
125
129
|
const secrets = authStore.getAuthSecrets(documentSlug, name);
|
|
126
130
|
// Handle API Key security schemes
|
|
127
131
|
if (scheme.type === 'apiKey') {
|
|
@@ -144,7 +148,7 @@ scheme, authStore, name, documentSlug) => {
|
|
|
144
148
|
// Handle OAuth2 security schemes and all supported flows
|
|
145
149
|
if (scheme.type === 'oauth2') {
|
|
146
150
|
const storeSecrets = secrets?.type === 'oauth2' ? secrets : undefined;
|
|
147
|
-
const extracted = extractOAuthFlowSecrets(scheme.flows, storeSecrets);
|
|
151
|
+
const extracted = extractOAuthFlowSecrets(scheme.flows, storeSecrets, oauth2RedirectUri);
|
|
148
152
|
const configuredDefaultScopes = Array.isArray(scheme['x-default-scopes'])
|
|
149
153
|
? scheme['x-default-scopes'].filter((scope) => typeof scope === 'string')
|
|
150
154
|
: [];
|
|
@@ -163,7 +167,7 @@ scheme, authStore, name, documentSlug) => {
|
|
|
163
167
|
password: storeSecrets?.password,
|
|
164
168
|
clientCredentials: storeSecrets?.clientCredentials,
|
|
165
169
|
authorizationCode: storeSecrets?.authorizationCode,
|
|
166
|
-
}, storeSecrets);
|
|
170
|
+
}, storeSecrets, oauth2RedirectUri);
|
|
167
171
|
return {
|
|
168
172
|
...scheme,
|
|
169
173
|
...(objectEntries(extracted.flows).length ? { flows: extracted.flows } : {}),
|
|
@@ -5,5 +5,5 @@ import type { SecuritySchemeObjectSecret } from '../../../request-example/builde
|
|
|
5
5
|
/** Document security merged with the config security schemes */
|
|
6
6
|
export type MergedSecuritySchemes = Record<string, SecuritySchemeObjectSecret>;
|
|
7
7
|
/** Merge the authentication config with the document security schemes + the auth store secrets */
|
|
8
|
-
export declare const mergeSecurity: (documentSecuritySchemes: ComponentsObject["securitySchemes"], configSecuritySchemes: AuthenticationConfiguration["securitySchemes"], authStore: AuthStore, documentName: string) => MergedSecuritySchemes;
|
|
8
|
+
export declare const mergeSecurity: (documentSecuritySchemes: ComponentsObject["securitySchemes"], configSecuritySchemes: AuthenticationConfiguration["securitySchemes"], authStore: AuthStore, documentName: string, oauth2RedirectUri?: string) => MergedSecuritySchemes;
|
|
9
9
|
//# sourceMappingURL=merge-security.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"merge-security.d.ts","sourceRoot":"","sources":["../../../../src/request-example/context/security/merge-security.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,6BAA6B,CAAA;AAC9E,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,uCAAuC,CAAA;AAKtE,OAAO,EACL,KAAK,gBAAgB,EAGtB,MAAM,8DAA8D,CAAA;AAErE,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,iDAAiD,CAAA;AAIjG,gEAAgE;AAChE,MAAM,MAAM,qBAAqB,GAAG,MAAM,CAAC,MAAM,EAAE,0BAA0B,CAAC,CAAA;AAE9E,kGAAkG;AAClG,eAAO,MAAM,aAAa,GACxB,yBAAyB,gBAAgB,CAAC,iBAAiB,CAAM,EACjE,uBAAuB,2BAA2B,CAAC,iBAAiB,CAAM,EAC1E,WAAW,SAAS,EACpB,cAAc,MAAM,
|
|
1
|
+
{"version":3,"file":"merge-security.d.ts","sourceRoot":"","sources":["../../../../src/request-example/context/security/merge-security.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,6BAA6B,CAAA;AAC9E,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,uCAAuC,CAAA;AAKtE,OAAO,EACL,KAAK,gBAAgB,EAGtB,MAAM,8DAA8D,CAAA;AAErE,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,iDAAiD,CAAA;AAIjG,gEAAgE;AAChE,MAAM,MAAM,qBAAqB,GAAG,MAAM,CAAC,MAAM,EAAE,0BAA0B,CAAC,CAAA;AAE9E,kGAAkG;AAClG,eAAO,MAAM,aAAa,GACxB,yBAAyB,gBAAgB,CAAC,iBAAiB,CAAM,EACjE,uBAAuB,2BAA2B,CAAC,iBAAiB,CAAM,EAC1E,WAAW,SAAS,EACpB,cAAc,MAAM,EACpB,oBAAoB,MAAM,KACzB,qBA2BF,CAAA"}
|
|
@@ -6,7 +6,7 @@ import { coerceValue } from '@scalar/workspace-store/schemas/typebox-coerce';
|
|
|
6
6
|
import { SecuritySchemeObjectSchema, } from '@scalar/workspace-store/schemas/v3.1/strict/openapi-document';
|
|
7
7
|
import { extractSecuritySchemeSecrets } from './extract-security-scheme-secrets.js';
|
|
8
8
|
/** Merge the authentication config with the document security schemes + the auth store secrets */
|
|
9
|
-
export const mergeSecurity = (documentSecuritySchemes = {}, configSecuritySchemes = {}, authStore, documentName) => {
|
|
9
|
+
export const mergeSecurity = (documentSecuritySchemes = {}, configSecuritySchemes = {}, authStore, documentName, oauth2RedirectUri) => {
|
|
10
10
|
/** Resolve any refs in the document security schemes */
|
|
11
11
|
const resolvedDocumentSecuritySchemes = objectEntries(documentSecuritySchemes).reduce((acc, [key, value]) => {
|
|
12
12
|
const resolved = deepClone(getResolvedRef(value));
|
|
@@ -23,7 +23,7 @@ export const mergeSecurity = (documentSecuritySchemes = {}, configSecurityScheme
|
|
|
23
23
|
const coerced = coerceValue(SecuritySchemeObjectSchema, value);
|
|
24
24
|
// We then overwrite it back with the original value to keep any other fields like description, etc.
|
|
25
25
|
const merged = { ...coerced, ...value };
|
|
26
|
-
acc[name] = extractSecuritySchemeSecrets(merged, authStore, name, documentName);
|
|
26
|
+
acc[name] = extractSecuritySchemeSecrets(merged, authStore, name, documentName, oauth2RedirectUri);
|
|
27
27
|
return acc;
|
|
28
28
|
}, {});
|
|
29
29
|
};
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
export type { ApiKeyObjectSecret, BuildRequestData, BuildRequestFailureCode, BuildRequestResult, HttpObjectSecret, OAuth2ObjectSecret, OAuthFlowAuthorizationCodeSecret, OAuthFlowClientCredentialsSecret, OAuthFlowImplicitSecret, OAuthFlowPasswordSecret, OAuthFlowsObjectSecret, OpenIdConnectObjectSecret, RequestPayload, ResolveRequestFactoryUrlError, ResolveRequestFactoryUrlResult, SecuritySchemeObjectSecret, } from './builder/index.js';
|
|
2
|
-
export { BUILD_REQUEST_FAILED, INVALID_REQUEST_FACTORY_URL, MISSING_REQUEST_SERVER_BASE, type RequestFactory, buildRequest, buildRequestSecurity, deSerializeParameter, filterGlobalCookie, getEnvironmentVariables, getExample, getExampleFromBody, getExampleFromSchema, getResolvedUrl, getSelectedBodyContentType, getServerVariables, requestFactory, resolveExecutableRequestUrl, resolveRequestFactoryUrl, serializeContentValue, serializeDeepObjectStyle, serializeFormStyle, serializeFormStyleForCookies, serializePipeDelimitedStyle, serializeSimpleStyle, serializeSpaceDelimitedStyle, } from './builder/index.js';
|
|
2
|
+
export { BUILD_REQUEST_FAILED, INVALID_REQUEST_FACTORY_URL, MISSING_REQUEST_SERVER_BASE, type RequestFactory, type SerializedFormProperty, buildRequest, buildRequestSecurity, deSerializeParameter, filterGlobalCookie, getEnvironmentVariables, getExample, getExampleFromBody, getExampleFromSchema, getResolvedUrl, getSelectedBodyContentType, getServerVariables, requestFactory, resolveExecutableRequestUrl, resolveRequestFactoryUrl, serializeContentValue, serializeDeepObjectStyle, serializeFormPropertyWithEncoding, serializeFormStyle, serializeFormStyleForCookies, serializePipeDelimitedStyle, serializeSimpleStyle, serializeSpaceDelimitedStyle, } from './builder/index.js';
|
|
3
3
|
export type { MergedSecuritySchemes } from './context/index.js';
|
|
4
4
|
export { type BuildRequestExampleContext, combineParams, filterDisabledDefaultHeaders, getActiveEnvironment, getActiveProxyUrl, getDefaultHeaders, getRequestExampleContext, getSecurityRequirements, getSecuritySchemes, getSelectedSecurity, getSelectedServer, getServers, isAuthOptional, mergeSecurity, restoreConventionalDefaultHeaderNames, restoreConventionalHeaderName, } from './context/index.js';
|
|
5
5
|
export { CONTEXT_FUNCTION_NAMES, type ContextFunctionEntry, type ContextFunctionName, POPULAR_CONTEXT_FUNCTION_KEYS, contextFunctions, getContextFunctionComment, isContextFunctionName, } from './functions.js';
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/request-example/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,kBAAkB,EAClB,gBAAgB,EAChB,uBAAuB,EACvB,kBAAkB,EAClB,gBAAgB,EAChB,kBAAkB,EAClB,gCAAgC,EAChC,gCAAgC,EAChC,uBAAuB,EACvB,uBAAuB,EACvB,sBAAsB,EACtB,yBAAyB,EACzB,cAAc,EACd,6BAA6B,EAC7B,8BAA8B,EAC9B,0BAA0B,GAC3B,MAAM,WAAW,CAAA;AAClB,OAAO,EACL,oBAAoB,EACpB,2BAA2B,EAC3B,2BAA2B,EAC3B,KAAK,cAAc,EACnB,YAAY,EACZ,oBAAoB,EACpB,oBAAoB,EACpB,kBAAkB,EAClB,uBAAuB,EACvB,UAAU,EACV,kBAAkB,EAClB,oBAAoB,EACpB,cAAc,EACd,0BAA0B,EAC1B,kBAAkB,EAClB,cAAc,EACd,2BAA2B,EAC3B,wBAAwB,EACxB,qBAAqB,EACrB,wBAAwB,EACxB,kBAAkB,EAClB,4BAA4B,EAC5B,2BAA2B,EAC3B,oBAAoB,EACpB,4BAA4B,GAC7B,MAAM,WAAW,CAAA;AAClB,YAAY,EAAE,qBAAqB,EAAE,MAAM,WAAW,CAAA;AACtD,OAAO,EACL,KAAK,0BAA0B,EAC/B,aAAa,EACb,4BAA4B,EAC5B,oBAAoB,EACpB,iBAAiB,EACjB,iBAAiB,EACjB,wBAAwB,EACxB,uBAAuB,EACvB,kBAAkB,EAClB,mBAAmB,EACnB,iBAAiB,EACjB,UAAU,EACV,cAAc,EACd,aAAa,EACb,qCAAqC,EACrC,6BAA6B,GAC9B,MAAM,WAAW,CAAA;AAClB,OAAO,EACL,sBAAsB,EACtB,KAAK,oBAAoB,EACzB,KAAK,mBAAmB,EACxB,6BAA6B,EAC7B,gBAAgB,EAChB,yBAAyB,EACzB,qBAAqB,GACtB,MAAM,aAAa,CAAA;AACpB,OAAO,EAAE,8BAA8B,EAAE,MAAM,kBAAkB,CAAA;AACjE,YAAY,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAA"}
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/request-example/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,kBAAkB,EAClB,gBAAgB,EAChB,uBAAuB,EACvB,kBAAkB,EAClB,gBAAgB,EAChB,kBAAkB,EAClB,gCAAgC,EAChC,gCAAgC,EAChC,uBAAuB,EACvB,uBAAuB,EACvB,sBAAsB,EACtB,yBAAyB,EACzB,cAAc,EACd,6BAA6B,EAC7B,8BAA8B,EAC9B,0BAA0B,GAC3B,MAAM,WAAW,CAAA;AAClB,OAAO,EACL,oBAAoB,EACpB,2BAA2B,EAC3B,2BAA2B,EAC3B,KAAK,cAAc,EACnB,KAAK,sBAAsB,EAC3B,YAAY,EACZ,oBAAoB,EACpB,oBAAoB,EACpB,kBAAkB,EAClB,uBAAuB,EACvB,UAAU,EACV,kBAAkB,EAClB,oBAAoB,EACpB,cAAc,EACd,0BAA0B,EAC1B,kBAAkB,EAClB,cAAc,EACd,2BAA2B,EAC3B,wBAAwB,EACxB,qBAAqB,EACrB,wBAAwB,EACxB,iCAAiC,EACjC,kBAAkB,EAClB,4BAA4B,EAC5B,2BAA2B,EAC3B,oBAAoB,EACpB,4BAA4B,GAC7B,MAAM,WAAW,CAAA;AAClB,YAAY,EAAE,qBAAqB,EAAE,MAAM,WAAW,CAAA;AACtD,OAAO,EACL,KAAK,0BAA0B,EAC/B,aAAa,EACb,4BAA4B,EAC5B,oBAAoB,EACpB,iBAAiB,EACjB,iBAAiB,EACjB,wBAAwB,EACxB,uBAAuB,EACvB,kBAAkB,EAClB,mBAAmB,EACnB,iBAAiB,EACjB,UAAU,EACV,cAAc,EACd,aAAa,EACb,qCAAqC,EACrC,6BAA6B,GAC9B,MAAM,WAAW,CAAA;AAClB,OAAO,EACL,sBAAsB,EACtB,KAAK,oBAAoB,EACzB,KAAK,mBAAmB,EACxB,6BAA6B,EAC7B,gBAAgB,EAChB,yBAAyB,EACzB,qBAAqB,GACtB,MAAM,aAAa,CAAA;AACpB,OAAO,EAAE,8BAA8B,EAAE,MAAM,kBAAkB,CAAA;AACjE,YAAY,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAA"}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
export { BUILD_REQUEST_FAILED, INVALID_REQUEST_FACTORY_URL, MISSING_REQUEST_SERVER_BASE, buildRequest, buildRequestSecurity, deSerializeParameter, filterGlobalCookie, getEnvironmentVariables, getExample, getExampleFromBody, getExampleFromSchema, getResolvedUrl, getSelectedBodyContentType, getServerVariables, requestFactory, resolveExecutableRequestUrl, resolveRequestFactoryUrl, serializeContentValue, serializeDeepObjectStyle, serializeFormStyle, serializeFormStyleForCookies, serializePipeDelimitedStyle, serializeSimpleStyle, serializeSpaceDelimitedStyle, } from './builder/index.js';
|
|
1
|
+
export { BUILD_REQUEST_FAILED, INVALID_REQUEST_FACTORY_URL, MISSING_REQUEST_SERVER_BASE, buildRequest, buildRequestSecurity, deSerializeParameter, filterGlobalCookie, getEnvironmentVariables, getExample, getExampleFromBody, getExampleFromSchema, getResolvedUrl, getSelectedBodyContentType, getServerVariables, requestFactory, resolveExecutableRequestUrl, resolveRequestFactoryUrl, serializeContentValue, serializeDeepObjectStyle, serializeFormPropertyWithEncoding, serializeFormStyle, serializeFormStyleForCookies, serializePipeDelimitedStyle, serializeSimpleStyle, serializeSpaceDelimitedStyle, } from './builder/index.js';
|
|
2
2
|
export { combineParams, filterDisabledDefaultHeaders, getActiveEnvironment, getActiveProxyUrl, getDefaultHeaders, getRequestExampleContext, getSecurityRequirements, getSecuritySchemes, getSelectedSecurity, getSelectedServer, getServers, isAuthOptional, mergeSecurity, restoreConventionalDefaultHeaderNames, restoreConventionalHeaderName, } from './context/index.js';
|
|
3
3
|
export { CONTEXT_FUNCTION_NAMES, POPULAR_CONTEXT_FUNCTION_KEYS, contextFunctions, getContextFunctionComment, isContextFunctionName, } from './functions.js';
|
|
4
4
|
export { createVariablesStoreForRequest } from './variable-store/index.js';
|
|
@@ -1,7 +1,6 @@
|
|
|
1
1
|
export declare const XScalarSdkInstallationSchema: import("@scalar/typebox").TObject<{
|
|
2
2
|
'x-scalar-sdk-installation': import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TObject<{
|
|
3
3
|
lang: import("@scalar/typebox").TString;
|
|
4
|
-
source: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
5
4
|
description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
6
5
|
}>>>;
|
|
7
6
|
}>;
|
|
@@ -9,14 +8,13 @@ export type XScalarSdkInstallation = {
|
|
|
9
8
|
/** Scalar SDK installation information. */
|
|
10
9
|
'x-scalar-sdk-installation'?: {
|
|
11
10
|
lang: string;
|
|
12
|
-
|
|
11
|
+
/** Installation instructions in Markdown (supports fenced code blocks). */
|
|
13
12
|
description?: string;
|
|
14
13
|
}[];
|
|
15
14
|
};
|
|
16
15
|
export declare const XScalarSdkInstallation: import("@scalar/validation").ObjectSchema<{
|
|
17
16
|
'x-scalar-sdk-installation': import("@scalar/validation").OptionalSchema<import("@scalar/validation").ArraySchema<import("@scalar/validation").ObjectSchema<{
|
|
18
17
|
lang: import("@scalar/validation").StringSchema;
|
|
19
|
-
source: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
20
18
|
description: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
21
19
|
}>>>;
|
|
22
20
|
}>;
|
|
@@ -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":"AAQA,eAAO,MAAM,4BAA4B;;;;;EAEvC,CAAA;AAaF,MAAM,MAAM,sBAAsB,GAAG;IACnC,2CAA2C;IAC3C,2BAA2B,CAAC,EAAE;QAC5B,IAAI,EAAE,MAAM,CAAA;QACZ,2EAA2E;QAC3E,WAAW,CAAC,EAAE,MAAM,CAAA;KACrB,EAAE,CAAA;CACJ,CAAA;AAED,eAAO,MAAM,sBAAsB;;;;;EAYlC,CAAA"}
|
|
@@ -2,7 +2,6 @@ import { Type } from '@scalar/typebox';
|
|
|
2
2
|
import { array, object, optional, string } from '@scalar/validation';
|
|
3
3
|
const XScalarSdkInstallationItemSchema = Type.Object({
|
|
4
4
|
lang: Type.String(),
|
|
5
|
-
source: Type.Optional(Type.String()),
|
|
6
5
|
description: Type.Optional(Type.String()),
|
|
7
6
|
});
|
|
8
7
|
export const XScalarSdkInstallationSchema = Type.Object({
|
|
@@ -10,7 +9,6 @@ export const XScalarSdkInstallationSchema = Type.Object({
|
|
|
10
9
|
});
|
|
11
10
|
const XScalarSdkInstallationItem = object({
|
|
12
11
|
lang: string(),
|
|
13
|
-
source: optional(string()),
|
|
14
12
|
description: optional(string()),
|
|
15
13
|
}, {
|
|
16
14
|
typeName: 'XScalarSdkInstallationItem',
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
export { type XBadge, XBadgeSchema, type XBadges, XBadgesSchema, } from './x-badge.js';
|
|
2
|
-
export { type XCodeSample, type XCodeSamples, XCodeSamplesSchema, } from './x-code-samples.js';
|
|
2
|
+
export { type XCodeSample, type XCodeSamples, XCodeSamplesSchema, type XLanguageExample, type XReadmeCodeSample, } from './x-code-samples.js';
|
|
3
3
|
export { type XScalarSelectedContentType, XScalarSelectedContentTypeSchema, } from './x-scalar-selected-content-type.js';
|
|
4
4
|
export { XScalarStabilitySchema, XScalarStabilityValues, } from './x-scalar-stability.js';
|
|
5
5
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/schemas/extensions/operation/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,MAAM,EACX,YAAY,EACZ,KAAK,OAAO,EACZ,aAAa,GACd,MAAM,WAAW,CAAA;AAClB,OAAO,EACL,KAAK,WAAW,EAChB,KAAK,YAAY,EACjB,kBAAkB,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/schemas/extensions/operation/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,MAAM,EACX,YAAY,EACZ,KAAK,OAAO,EACZ,aAAa,GACd,MAAM,WAAW,CAAA;AAClB,OAAO,EACL,KAAK,WAAW,EAChB,KAAK,YAAY,EACjB,kBAAkB,EAClB,KAAK,gBAAgB,EACrB,KAAK,iBAAiB,GACvB,MAAM,kBAAkB,CAAA;AACzB,OAAO,EACL,KAAK,0BAA0B,EAC/B,gCAAgC,GACjC,MAAM,kCAAkC,CAAA;AACzC,OAAO,EACL,sBAAsB,EACtB,sBAAsB,GACvB,MAAM,sBAAsB,CAAA"}
|
|
@@ -14,12 +14,51 @@ export declare const XCodeSamplesSchema: import("@scalar/typebox").TObject<{
|
|
|
14
14
|
label: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
15
15
|
source: import("@scalar/typebox").TString;
|
|
16
16
|
}>>>;
|
|
17
|
+
'x-readme': import("@scalar/typebox").TOptional<import("@scalar/typebox").TObject<{
|
|
18
|
+
'code-samples': import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TObject<{
|
|
19
|
+
language: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
20
|
+
code: import("@scalar/typebox").TString;
|
|
21
|
+
name: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
22
|
+
install: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
23
|
+
correspondingExample: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
24
|
+
}>>>;
|
|
25
|
+
'samples-languages': import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TString>>;
|
|
26
|
+
}>>;
|
|
27
|
+
'x-stainless-snippets': import("@scalar/typebox").TOptional<import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TString>>;
|
|
28
|
+
'x-stainless-examples': import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TObject<{
|
|
29
|
+
title: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
30
|
+
request: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TString>>;
|
|
31
|
+
response: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
|
|
32
|
+
}>, import("@scalar/typebox").TArray<import("@scalar/typebox").TObject<{
|
|
33
|
+
title: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
34
|
+
request: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TString>>;
|
|
35
|
+
response: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
|
|
36
|
+
}>>]>>;
|
|
37
|
+
'x-scalar-examples': import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TObject<{
|
|
38
|
+
lang: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
39
|
+
label: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
40
|
+
source: import("@scalar/typebox").TString;
|
|
41
|
+
}>>>;
|
|
17
42
|
}>;
|
|
18
43
|
export type XCodeSample = {
|
|
19
44
|
lang?: string;
|
|
20
45
|
label?: string;
|
|
21
46
|
source: string;
|
|
22
47
|
};
|
|
48
|
+
/** A single ReadMe custom code sample. */
|
|
49
|
+
export type XReadmeCodeSample = {
|
|
50
|
+
language?: string;
|
|
51
|
+
code: string;
|
|
52
|
+
name?: string;
|
|
53
|
+
install?: string;
|
|
54
|
+
correspondingExample?: string;
|
|
55
|
+
};
|
|
56
|
+
/** Per-language request snippets with an optional title and response. */
|
|
57
|
+
export type XLanguageExample = {
|
|
58
|
+
title?: string;
|
|
59
|
+
request?: Record<string, string>;
|
|
60
|
+
response?: unknown;
|
|
61
|
+
};
|
|
23
62
|
export declare const XCodeSample: import("@scalar/validation").ObjectSchema<{
|
|
24
63
|
lang: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
25
64
|
label: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
@@ -29,6 +68,13 @@ export type XCodeSamples = {
|
|
|
29
68
|
'x-codeSamples'?: XCodeSample[];
|
|
30
69
|
'x-code-samples'?: XCodeSample[];
|
|
31
70
|
'x-custom-examples'?: XCodeSample[];
|
|
71
|
+
'x-readme'?: {
|
|
72
|
+
'code-samples'?: XReadmeCodeSample[];
|
|
73
|
+
'samples-languages'?: string[];
|
|
74
|
+
};
|
|
75
|
+
'x-stainless-snippets'?: Record<string, string>;
|
|
76
|
+
'x-stainless-examples'?: XLanguageExample | XLanguageExample[];
|
|
77
|
+
'x-scalar-examples'?: XCodeSample[];
|
|
32
78
|
};
|
|
33
79
|
export declare const XCodeSamples: import("@scalar/validation").ObjectSchema<{
|
|
34
80
|
'x-codeSamples': import("@scalar/validation").OptionalSchema<import("@scalar/validation").ArraySchema<import("@scalar/validation").ObjectSchema<{
|
|
@@ -46,5 +92,30 @@ export declare const XCodeSamples: import("@scalar/validation").ObjectSchema<{
|
|
|
46
92
|
label: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
47
93
|
source: import("@scalar/validation").StringSchema;
|
|
48
94
|
}>>>;
|
|
95
|
+
'x-readme': import("@scalar/validation").OptionalSchema<import("@scalar/validation").ObjectSchema<{
|
|
96
|
+
'code-samples': import("@scalar/validation").OptionalSchema<import("@scalar/validation").ArraySchema<import("@scalar/validation").ObjectSchema<{
|
|
97
|
+
language: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
98
|
+
code: import("@scalar/validation").StringSchema;
|
|
99
|
+
name: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
100
|
+
install: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
101
|
+
correspondingExample: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
102
|
+
}>>>;
|
|
103
|
+
'samples-languages': import("@scalar/validation").OptionalSchema<import("@scalar/validation").ArraySchema<import("@scalar/validation").StringSchema>>;
|
|
104
|
+
}>>;
|
|
105
|
+
'x-stainless-snippets': import("@scalar/validation").OptionalSchema<import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").StringSchema>>;
|
|
106
|
+
'x-stainless-examples': import("@scalar/validation").OptionalSchema<import("@scalar/validation").UnionSchema<readonly [import("@scalar/validation").ObjectSchema<{
|
|
107
|
+
title: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
108
|
+
request: import("@scalar/validation").OptionalSchema<import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").StringSchema>>;
|
|
109
|
+
response: import("@scalar/validation").OptionalSchema<import("@scalar/validation").UnknownSchema>;
|
|
110
|
+
}>, import("@scalar/validation").ArraySchema<import("@scalar/validation").ObjectSchema<{
|
|
111
|
+
title: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
112
|
+
request: import("@scalar/validation").OptionalSchema<import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").StringSchema>>;
|
|
113
|
+
response: import("@scalar/validation").OptionalSchema<import("@scalar/validation").UnknownSchema>;
|
|
114
|
+
}>>]>>;
|
|
115
|
+
'x-scalar-examples': import("@scalar/validation").OptionalSchema<import("@scalar/validation").ArraySchema<import("@scalar/validation").ObjectSchema<{
|
|
116
|
+
lang: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
117
|
+
label: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
118
|
+
source: import("@scalar/validation").StringSchema;
|
|
119
|
+
}>>>;
|
|
49
120
|
}>;
|
|
50
121
|
//# sourceMappingURL=x-code-samples.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"x-code-samples.d.ts","sourceRoot":"","sources":["../../../../src/schemas/extensions/operation/x-code-samples.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"x-code-samples.d.ts","sourceRoot":"","sources":["../../../../src/schemas/extensions/operation/x-code-samples.ts"],"names":[],"mappings":"AAqCA,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAQ7B,CAAA;AAEF,MAAM,MAAM,WAAW,GAAG;IACxB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,MAAM,CAAA;CACf,CAAA;AAED,0CAA0C;AAC1C,MAAM,MAAM,iBAAiB,GAAG;IAC9B,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,oBAAoB,CAAC,EAAE,MAAM,CAAA;CAC9B,CAAA;AAED,yEAAyE;AACzE,MAAM,MAAM,gBAAgB,GAAG;IAC7B,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAChC,QAAQ,CAAC,EAAE,OAAO,CAAA;CACnB,CAAA;AAED,eAAO,MAAM,WAAW;;;;EAItB,CAAA;AAuBF,MAAM,MAAM,YAAY,GAAG;IACzB,eAAe,CAAC,EAAE,WAAW,EAAE,CAAA;IAC/B,gBAAgB,CAAC,EAAE,WAAW,EAAE,CAAA;IAChC,mBAAmB,CAAC,EAAE,WAAW,EAAE,CAAA;IACnC,UAAU,CAAC,EAAE;QACX,cAAc,CAAC,EAAE,iBAAiB,EAAE,CAAA;QACpC,mBAAmB,CAAC,EAAE,MAAM,EAAE,CAAA;KAC/B,CAAA;IACD,sBAAsB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC/C,sBAAsB,CAAC,EAAE,gBAAgB,GAAG,gBAAgB,EAAE,CAAA;IAC9D,mBAAmB,CAAC,EAAE,WAAW,EAAE,CAAA;CACpC,CAAA;AAED,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAQvB,CAAA"}
|
|
@@ -1,28 +1,71 @@
|
|
|
1
1
|
import { Type } from '@scalar/typebox';
|
|
2
|
-
import { array, object, optional, string } from '@scalar/validation';
|
|
2
|
+
import { array, object, optional, record, string, union, unknown } from '@scalar/validation';
|
|
3
3
|
const XCodeSampleSchema = Type.Object({
|
|
4
4
|
lang: Type.Optional(Type.String()),
|
|
5
5
|
label: Type.Optional(Type.String()),
|
|
6
6
|
source: Type.String(),
|
|
7
7
|
});
|
|
8
|
+
/** A single ReadMe custom code sample (`x-readme.code-samples`). */
|
|
9
|
+
const XReadmeCodeSampleSchema = Type.Object({
|
|
10
|
+
language: Type.Optional(Type.String()),
|
|
11
|
+
code: Type.String(),
|
|
12
|
+
name: Type.Optional(Type.String()),
|
|
13
|
+
install: Type.Optional(Type.String()),
|
|
14
|
+
correspondingExample: Type.Optional(Type.String()),
|
|
15
|
+
});
|
|
16
|
+
/** ReadMe extension object. Only `code-samples` carries source code. */
|
|
17
|
+
const XReadmeSchema = Type.Object({
|
|
18
|
+
'code-samples': Type.Optional(Type.Array(XReadmeCodeSampleSchema)),
|
|
19
|
+
'samples-languages': Type.Optional(Type.Array(Type.String())),
|
|
20
|
+
});
|
|
21
|
+
/**
|
|
22
|
+
* A Stainless/Scalar example: per-language request snippets, with an optional
|
|
23
|
+
* title and response. Matches the shape of `x-stainless-examples`.
|
|
24
|
+
*/
|
|
25
|
+
const XLanguageExampleSchema = Type.Object({
|
|
26
|
+
title: Type.Optional(Type.String()),
|
|
27
|
+
request: Type.Optional(Type.Record(Type.String(), Type.String())),
|
|
28
|
+
response: Type.Optional(Type.Unknown()),
|
|
29
|
+
});
|
|
30
|
+
/** A single example or an array of examples. */
|
|
31
|
+
const XLanguageExamplesSchema = Type.Union([XLanguageExampleSchema, Type.Array(XLanguageExampleSchema)]);
|
|
8
32
|
export const XCodeSamplesSchema = Type.Object({
|
|
9
33
|
'x-codeSamples': Type.Optional(Type.Array(XCodeSampleSchema)),
|
|
10
34
|
'x-code-samples': Type.Optional(Type.Array(XCodeSampleSchema)),
|
|
11
35
|
'x-custom-examples': Type.Optional(Type.Array(XCodeSampleSchema)),
|
|
36
|
+
'x-readme': Type.Optional(XReadmeSchema),
|
|
37
|
+
'x-stainless-snippets': Type.Optional(Type.Record(Type.String(), Type.String())),
|
|
38
|
+
'x-stainless-examples': Type.Optional(XLanguageExamplesSchema),
|
|
39
|
+
'x-scalar-examples': Type.Optional(Type.Array(XCodeSampleSchema)),
|
|
12
40
|
});
|
|
13
41
|
export const XCodeSample = object({
|
|
14
42
|
lang: optional(string()),
|
|
15
43
|
label: optional(string()),
|
|
16
44
|
source: string(),
|
|
17
|
-
}, {
|
|
18
|
-
typeName: 'XCodeSample',
|
|
19
|
-
typeComment: 'A single code sample for documentation or examples',
|
|
20
45
|
});
|
|
46
|
+
const XReadmeCodeSample = object({
|
|
47
|
+
language: optional(string()),
|
|
48
|
+
code: string(),
|
|
49
|
+
name: optional(string()),
|
|
50
|
+
install: optional(string()),
|
|
51
|
+
correspondingExample: optional(string()),
|
|
52
|
+
});
|
|
53
|
+
const XReadme = object({
|
|
54
|
+
'code-samples': optional(array(XReadmeCodeSample)),
|
|
55
|
+
'samples-languages': optional(array(string())),
|
|
56
|
+
});
|
|
57
|
+
const XLanguageExample = object({
|
|
58
|
+
title: optional(string()),
|
|
59
|
+
request: optional(record(string(), string())),
|
|
60
|
+
response: optional(unknown()),
|
|
61
|
+
});
|
|
62
|
+
const XLanguageExamples = union([XLanguageExample, array(XLanguageExample)]);
|
|
21
63
|
export const XCodeSamples = object({
|
|
22
64
|
'x-codeSamples': optional(array(XCodeSample)),
|
|
23
65
|
'x-code-samples': optional(array(XCodeSample)),
|
|
24
66
|
'x-custom-examples': optional(array(XCodeSample)),
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
67
|
+
'x-readme': optional(XReadme),
|
|
68
|
+
'x-stainless-snippets': optional(record(string(), string())),
|
|
69
|
+
'x-stainless-examples': optional(XLanguageExamples),
|
|
70
|
+
'x-scalar-examples': optional(array(XCodeSample)),
|
|
28
71
|
});
|
|
@@ -308,6 +308,31 @@ export declare const ReferenceConfigSchema: import("@scalar/typebox").TObject<{
|
|
|
308
308
|
label: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
309
309
|
source: import("@scalar/typebox").TString;
|
|
310
310
|
}>>>;
|
|
311
|
+
'x-readme': import("@scalar/typebox").TOptional<import("@scalar/typebox").TObject<{
|
|
312
|
+
'code-samples': import("@scalar/typebox").TOptional<TArray<import("@scalar/typebox").TObject<{
|
|
313
|
+
language: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
314
|
+
code: import("@scalar/typebox").TString;
|
|
315
|
+
name: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
316
|
+
install: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
317
|
+
correspondingExample: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
318
|
+
}>>>;
|
|
319
|
+
'samples-languages': import("@scalar/typebox").TOptional<TArray<import("@scalar/typebox").TString>>;
|
|
320
|
+
}>>;
|
|
321
|
+
'x-stainless-snippets': import("@scalar/typebox").TOptional<import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TString>>;
|
|
322
|
+
'x-stainless-examples': import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TObject<{
|
|
323
|
+
title: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
324
|
+
request: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TString>>;
|
|
325
|
+
response: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
|
|
326
|
+
}>, TArray<import("@scalar/typebox").TObject<{
|
|
327
|
+
title: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
328
|
+
request: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TString>>;
|
|
329
|
+
response: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
|
|
330
|
+
}>>]>>;
|
|
331
|
+
'x-scalar-examples': import("@scalar/typebox").TOptional<TArray<import("@scalar/typebox").TObject<{
|
|
332
|
+
lang: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
333
|
+
label: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
334
|
+
source: import("@scalar/typebox").TString;
|
|
335
|
+
}>>>;
|
|
311
336
|
}>, import("@scalar/typebox").TObject<{
|
|
312
337
|
'x-scalar-stability': import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[TLiteral<"deprecated">, TLiteral<"experimental">, TLiteral<"stable">]>>;
|
|
313
338
|
}>, import("@scalar/typebox").TObject<{
|
|
@@ -328,6 +353,10 @@ export declare const ReferenceConfigSchema: import("@scalar/typebox").TObject<{
|
|
|
328
353
|
SchemaObject: import("@scalar/typebox").TUnion<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
329
354
|
__scalar_: import("@scalar/typebox").TString;
|
|
330
355
|
}>, import("@scalar/typebox").TObject<{
|
|
356
|
+
$id: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
357
|
+
$anchor: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
358
|
+
$dynamicAnchor: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
359
|
+
$dynamicRef: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
331
360
|
name: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
332
361
|
title: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
333
362
|
description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
@@ -417,6 +446,10 @@ export declare const ReferenceConfigSchema: import("@scalar/typebox").TObject<{
|
|
|
417
446
|
}>]>]>, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
418
447
|
type: import("@scalar/typebox").TUnion<[TLiteral<"null">, TLiteral<"boolean">]>;
|
|
419
448
|
}>, import("@scalar/typebox").TObject<{
|
|
449
|
+
$id: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
450
|
+
$anchor: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
451
|
+
$dynamicAnchor: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
452
|
+
$dynamicRef: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
420
453
|
name: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
421
454
|
title: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
422
455
|
description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
@@ -513,6 +546,10 @@ export declare const ReferenceConfigSchema: import("@scalar/typebox").TObject<{
|
|
|
513
546
|
minimum: import("@scalar/typebox").TOptional<import("@scalar/typebox").TNumber>;
|
|
514
547
|
exclusiveMinimum: import("@scalar/typebox").TOptional<import("@scalar/typebox").TNumber>;
|
|
515
548
|
}>]>, import("@scalar/typebox").TObject<{
|
|
549
|
+
$id: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
550
|
+
$anchor: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
551
|
+
$dynamicAnchor: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
552
|
+
$dynamicRef: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
516
553
|
name: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
517
554
|
title: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
518
555
|
description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
@@ -607,6 +644,10 @@ export declare const ReferenceConfigSchema: import("@scalar/typebox").TObject<{
|
|
|
607
644
|
minLength: import("@scalar/typebox").TOptional<import("@scalar/typebox").TInteger>;
|
|
608
645
|
pattern: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
609
646
|
}>]>, import("@scalar/typebox").TObject<{
|
|
647
|
+
$id: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
648
|
+
$anchor: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
649
|
+
$dynamicAnchor: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
650
|
+
$dynamicRef: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
610
651
|
name: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
611
652
|
title: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
612
653
|
description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
@@ -740,6 +781,10 @@ export declare const ReferenceConfigSchema: import("@scalar/typebox").TObject<{
|
|
|
740
781
|
'$ref-value': import("@scalar/typebox").TUnknown;
|
|
741
782
|
}>]>]>>;
|
|
742
783
|
}>]>, import("@scalar/typebox").TObject<{
|
|
784
|
+
$id: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
785
|
+
$anchor: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
786
|
+
$dynamicAnchor: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
787
|
+
$dynamicRef: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
743
788
|
name: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
744
789
|
title: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
745
790
|
description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
@@ -853,6 +898,10 @@ export declare const ReferenceConfigSchema: import("@scalar/typebox").TObject<{
|
|
|
853
898
|
'$ref-value': import("@scalar/typebox").TUnknown;
|
|
854
899
|
}>]>]>>>;
|
|
855
900
|
}>]>, import("@scalar/typebox").TObject<{
|
|
901
|
+
$id: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
902
|
+
$anchor: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
903
|
+
$dynamicAnchor: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
904
|
+
$dynamicRef: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
856
905
|
name: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
857
906
|
title: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
858
907
|
description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
@@ -1021,6 +1070,10 @@ export declare const ReferenceConfigSchema: import("@scalar/typebox").TObject<{
|
|
|
1021
1070
|
'$ref-value': import("@scalar/typebox").TUnknown;
|
|
1022
1071
|
}>]>]>>;
|
|
1023
1072
|
}>]>, import("@scalar/typebox").TObject<{
|
|
1073
|
+
$id: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
1074
|
+
$anchor: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
1075
|
+
$dynamicAnchor: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
1076
|
+
$dynamicRef: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
1024
1077
|
name: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
1025
1078
|
title: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
1026
1079
|
description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
@@ -1203,7 +1256,6 @@ export declare const ReferenceConfigSchema: import("@scalar/typebox").TObject<{
|
|
|
1203
1256
|
}>, import("@scalar/typebox").TObject<{
|
|
1204
1257
|
'x-scalar-sdk-installation': import("@scalar/typebox").TOptional<TArray<import("@scalar/typebox").TObject<{
|
|
1205
1258
|
lang: import("@scalar/typebox").TString;
|
|
1206
|
-
source: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
1207
1259
|
description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
1208
1260
|
}>>>;
|
|
1209
1261
|
}>]>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/schemas/reference-config/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,MAAM,EAAE,KAAK,QAAQ,EAAQ,MAAM,iBAAiB,CAAA;AAClE,OAAO,EAA2C,KAAK,gBAAgB,EAAE,MAAM,wBAAwB,CAAA;AACvG,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,WAAW,CAAA;AAE7C,OAAO,EAAE,KAAK,UAAU,EAAuC,MAAM,cAAc,CAAA;AACnF,OAAO,EAAE,KAAK,QAAQ,EAAmC,MAAM,YAAY,CAAA;AAC3E,OAAO,EAAE,KAAK,IAAI,EAA2B,MAAM,QAAQ,CAAA;AAC3D,OAAO,EAAE,KAAK,OAAO,EAAiC,MAAM,WAAW,CAAA;AACvE,OAAO,EAAE,KAAK,QAAQ,EAAmC,MAAM,YAAY,CAAA;AAE3E;;;;GAIG;AACH,eAAO,MAAM,qBAAqB
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/schemas/reference-config/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,MAAM,EAAE,KAAK,QAAQ,EAAQ,MAAM,iBAAiB,CAAA;AAClE,OAAO,EAA2C,KAAK,gBAAgB,EAAE,MAAM,wBAAwB,CAAA;AACvG,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,WAAW,CAAA;AAE7C,OAAO,EAAE,KAAK,UAAU,EAAuC,MAAM,cAAc,CAAA;AACnF,OAAO,EAAE,KAAK,QAAQ,EAAmC,MAAM,YAAY,CAAA;AAC3E,OAAO,EAAE,KAAK,IAAI,EAA2B,MAAM,QAAQ,CAAA;AAC3D,OAAO,EAAE,KAAK,OAAO,EAAiC,MAAM,WAAW,CAAA;AACvE,OAAO,EAAE,KAAK,QAAQ,EAAmC,MAAM,YAAY,CAAA;AAE3E;;;;GAIG;AACH,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAqBjC,CAAA;AAED,MAAM,MAAM,eAAe,GAAG;IAC5B,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,QAAQ,CAAC,EAAE,QAAQ,CAAA;IACnB,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,UAAU,CAAC,EAAE,UAAU,CAAA;IACvB,QAAQ,CAAC,EAAE,QAAQ,CAAA;IACnB,IAAI,CAAC,EAAE,IAAI,CAAA;IACX,WAAW,CAAC,EAAE,gBAAgB,CAAA;CAC/B,CAAA;AAED,eAAO,MAAM,sBAAsB,EAAE,YAAY,CAAC,eAAe,CAgChE,CAAA"}
|