@scalar/types 0.7.4 → 0.7.5
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 +6 -0
- package/dist/api-reference/api-client-configuration.d.ts +6 -0
- package/dist/api-reference/api-client-configuration.d.ts.map +1 -1
- package/dist/api-reference/api-reference-configuration.d.ts +6 -0
- package/dist/api-reference/api-reference-configuration.d.ts.map +1 -1
- package/dist/api-reference/base-configuration.d.ts +15 -0
- package/dist/api-reference/base-configuration.d.ts.map +1 -1
- package/dist/api-reference/base-configuration.js +8 -0
- package/dist/api-reference/index.d.ts +1 -0
- package/dist/api-reference/index.d.ts.map +1 -1
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -115,6 +115,12 @@ export declare const apiClientConfigurationSchema: z.ZodObject<{
|
|
|
115
115
|
}, z.core.$strip>>;
|
|
116
116
|
}, z.core.$strip>>>>;
|
|
117
117
|
telemetry: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
|
|
118
|
+
externalUrls: z.ZodPrefault<z.ZodObject<{
|
|
119
|
+
dashboardUrl: z.ZodPrefault<z.ZodString>;
|
|
120
|
+
registryUrl: z.ZodPrefault<z.ZodString>;
|
|
121
|
+
proxyUrl: z.ZodPrefault<z.ZodString>;
|
|
122
|
+
apiBaseUrl: z.ZodPrefault<z.ZodString>;
|
|
123
|
+
}, z.core.$strip>>;
|
|
118
124
|
default: z.ZodCatch<z.ZodOptional<z.ZodDefault<z.ZodBoolean>>>;
|
|
119
125
|
url: z.ZodOptional<z.ZodString>;
|
|
120
126
|
content: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNull, z.ZodRecord<z.ZodString, z.ZodAny>, z.ZodFunction<z.ZodTuple<readonly [], null>, z.ZodRecord<z.ZodString, z.ZodAny>>]>>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"api-client-configuration.d.ts","sourceRoot":"","sources":["../../src/api-reference/api-client-configuration.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AAKxB,eAAO,MAAM,4BAA4B
|
|
1
|
+
{"version":3,"file":"api-client-configuration.d.ts","sourceRoot":"","sources":["../../src/api-reference/api-client-configuration.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AAKxB,eAAO,MAAM,4BAA4B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAAkE,CAAA;AAE3G,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,4BAA4B,CAAC,CAAA"}
|
|
@@ -105,6 +105,12 @@ export declare const apiReferenceConfigurationSchema: z.ZodObject<{
|
|
|
105
105
|
onRequestSent: z.ZodOptional<z.ZodFunction<z.ZodTuple<readonly [z.ZodString], null>, z.ZodVoid>>;
|
|
106
106
|
persistAuth: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
|
|
107
107
|
telemetry: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
|
|
108
|
+
externalUrls: z.ZodPrefault<z.ZodObject<{
|
|
109
|
+
dashboardUrl: z.ZodPrefault<z.ZodString>;
|
|
110
|
+
registryUrl: z.ZodPrefault<z.ZodString>;
|
|
111
|
+
proxyUrl: z.ZodPrefault<z.ZodString>;
|
|
112
|
+
apiBaseUrl: z.ZodPrefault<z.ZodString>;
|
|
113
|
+
}, z.core.$strip>>;
|
|
108
114
|
layout: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodEnum<{
|
|
109
115
|
modern: "modern";
|
|
110
116
|
classic: "classic";
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"api-reference-configuration.d.ts","sourceRoot":"","sources":["../../src/api-reference/api-reference-configuration.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAIrC,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,gCAAgC,CAAA;AAEjF,OAAO,EAAE,KAAK,mBAAmB,EAA6B,MAAM,wBAAwB,CAAA;AAK5F;;;;;;;;;GASG;AACH,eAAO,MAAM,+BAA+B
|
|
1
|
+
{"version":3,"file":"api-reference-configuration.d.ts","sourceRoot":"","sources":["../../src/api-reference/api-reference-configuration.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAIrC,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,gCAAgC,CAAA;AAEjF,OAAO,EAAE,KAAK,mBAAmB,EAA6B,MAAM,wBAAwB,CAAA;AAK5F;;;;;;;;;GASG;AACH,eAAO,MAAM,+BAA+B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;6CAZH,MAAM,GAAG,GAAG,GAAG,OAAO,SAAS,WAAW,KAAK,OAAO,CAAC,QAAQ,CAAC,UAAhE,MAAM,GAAG,GAAG,GAAG,OAAO,SAAS,WAAW,KAAK,OAAO,CAAC,QAAQ,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;sBAoItF,CAAC,CAAC,OAAO,CAAC,CAAC,MAAM,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,GAAG,SAAS,CAAC;cAE/B,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,GAAG,SAAS,CAAC;qBAQnF,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE;QAAE,OAAO,EAAE,OAAO,CAAA;KAAE,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,GAAG,SAAS,CAAC;gBAW1E,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,GAAG,SAAS,CAAC;oBAW5D,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,GAAG,SAAS,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAoM7E,CAAA;AAEF;;;;GAIG;AACH,MAAM,MAAM,4BAA4B,GAAG,IAAI,CAC7C,CAAC,CAAC,KAAK,CAAC,OAAO,+BAA+B,CAAC,EAAE,+BAA+B;AAChF,AADiD,+BAA+B;AAChF,OAAO,GAAG,MAAM,GAAG,gBAAgB,GAAG,aAAa,CACpD,GAAG;IACF,cAAc,CAAC,EAAE,2BAA2B,CAAA;CAC7C,CAAA;AAED;;;;;GAKG;AACH,MAAM,MAAM,yBAAyB,GAAG,4BAA4B,GAAG;IACrE;;;OAGG;IACH,GAAG,CAAC,EAAE,mBAAmB,CAAC,KAAK,CAAC,CAAA;IAChC;;;OAGG;IACH,OAAO,CAAC,EAAE,mBAAmB,CAAC,SAAS,CAAC,CAAA;CACzC,CAAA;AAED,oDAAoD;AAGpD,0CAA0C;AAC1C,eAAO,MAAM,yCAAyC,EAAE,OAAO,CAC7D,IAAI,CAAC,yBAAyB,EAAE,KAAK,GAAG,SAAS,CAAC,GAAG,mBAAmB,CAgExE,CAAA;AAEF;;GAEG;AACH,MAAM,MAAM,mCAAmC,GAAG,IAAI,CACpD,CAAC,CAAC,KAAK,CAAC,OAAO,yCAAyC,CAAC,EAEzD,OAAO,GAAG,MAAM,GAAG,gBAAgB,GAAG,aAAa,CACpD,GAAG;IACF,cAAc,CAAC,EAAE,2BAA2B,CAAA;CAC7C,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,4CAA4C,GAAG,mCAAmC,GAAG;IAC/F,OAAO,EAAE,mBAAmB,EAAE,CAAA;CAC/B,CAAA;AAED,gDAAgD;AAChD,MAAM,MAAM,4BAA4B,GACpC,OAAO,CAAC,mCAAmC,CAAC,GAC5C,OAAO,CAAC,4CAA4C,CAAC,GACrD,OAAO,CAAC,mCAAmC,CAAC,EAAE,GAC9C,OAAO,CAAC,4CAA4C,CAAC,EAAE,CAAA;AAE3D,uEAAuE;AACvE,eAAO,MAAM,0BAA0B,GACrC,QAAQ,4BAA4B,KACnC,MAAM,IAAI,OAAO,CAAC,4CAA4C,CACkC,CAAA"}
|
|
@@ -1,4 +1,12 @@
|
|
|
1
1
|
import z from 'zod';
|
|
2
|
+
declare const externalUrlsSchema: z.ZodObject<{
|
|
3
|
+
dashboardUrl: z.ZodPrefault<z.ZodString>;
|
|
4
|
+
registryUrl: z.ZodPrefault<z.ZodString>;
|
|
5
|
+
proxyUrl: z.ZodPrefault<z.ZodString>;
|
|
6
|
+
apiBaseUrl: z.ZodPrefault<z.ZodString>;
|
|
7
|
+
}, z.core.$strip>;
|
|
8
|
+
/** External service URLs used by Scalar packages */
|
|
9
|
+
export type ExternalUrls = z.output<typeof externalUrlsSchema>;
|
|
2
10
|
export declare const OLD_PROXY_URL = "https://api.scalar.com/request-proxy";
|
|
3
11
|
export declare const NEW_PROXY_URL = "https://proxy.scalar.com";
|
|
4
12
|
/** Shared configuration for the Api Reference and Api Client */
|
|
@@ -120,5 +128,12 @@ export declare const baseConfigurationSchema: z.ZodObject<{
|
|
|
120
128
|
}, z.core.$strip>>;
|
|
121
129
|
}, z.core.$strip>>>>;
|
|
122
130
|
telemetry: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
|
|
131
|
+
externalUrls: z.ZodPrefault<z.ZodObject<{
|
|
132
|
+
dashboardUrl: z.ZodPrefault<z.ZodString>;
|
|
133
|
+
registryUrl: z.ZodPrefault<z.ZodString>;
|
|
134
|
+
proxyUrl: z.ZodPrefault<z.ZodString>;
|
|
135
|
+
apiBaseUrl: z.ZodPrefault<z.ZodString>;
|
|
136
|
+
}, z.core.$strip>>;
|
|
123
137
|
}, z.core.$strip>;
|
|
138
|
+
export {};
|
|
124
139
|
//# sourceMappingURL=base-configuration.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"base-configuration.d.ts","sourceRoot":"","sources":["../../src/api-reference/base-configuration.ts"],"names":[],"mappings":"AAAA,OAAO,CAAC,MAAM,KAAK,CAAA;AAInB,eAAO,MAAM,aAAa,yCAAyC,CAAA;AACnE,eAAO,MAAM,aAAa,6BAA6B,CAAA;AAEvD,gEAAgE;AAChE,eAAO,MAAM,uBAAuB
|
|
1
|
+
{"version":3,"file":"base-configuration.d.ts","sourceRoot":"","sources":["../../src/api-reference/base-configuration.ts"],"names":[],"mappings":"AAAA,OAAO,CAAC,MAAM,KAAK,CAAA;AAInB,QAAA,MAAM,kBAAkB;;;;;iBAKtB,CAAA;AAEF,oDAAoD;AACpD,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,kBAAkB,CAAC,CAAA;AAE9D,eAAO,MAAM,aAAa,yCAAyC,CAAA;AACnE,eAAO,MAAM,aAAa,6BAA6B,CAAA;AAEvD,gEAAgE;AAChE,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAmJlC,CAAA"}
|
|
@@ -1,5 +1,11 @@
|
|
|
1
1
|
import z from 'zod';
|
|
2
2
|
import { apiClientPluginSchema } from './api-client-plugin.js';
|
|
3
|
+
const externalUrlsSchema = z.object({
|
|
4
|
+
dashboardUrl: z.string().prefault('https://dashboard.scalar.com'),
|
|
5
|
+
registryUrl: z.string().prefault('https://registry.scalar.com'),
|
|
6
|
+
proxyUrl: z.string().prefault('https://proxy.scalar.com'),
|
|
7
|
+
apiBaseUrl: z.string().prefault('https://api.scalar.com'),
|
|
8
|
+
});
|
|
3
9
|
export const OLD_PROXY_URL = 'https://api.scalar.com/request-proxy';
|
|
4
10
|
export const NEW_PROXY_URL = 'https://proxy.scalar.com';
|
|
5
11
|
/** Shared configuration for the Api Reference and Api Client */
|
|
@@ -148,4 +154,6 @@ export const baseConfigurationSchema = z.object({
|
|
|
148
154
|
plugins: z.array(apiClientPluginSchema).optional(),
|
|
149
155
|
/** Enables / disables telemetry*/
|
|
150
156
|
telemetry: z.boolean().optional().default(true),
|
|
157
|
+
/** A bunch of external URLs to Scalar's services. */
|
|
158
|
+
externalUrls: externalUrlsSchema.prefault({}),
|
|
151
159
|
});
|
|
@@ -3,6 +3,7 @@ export { type ApiClientPlugin, apiClientPluginSchema, hooksSchema } from './api-
|
|
|
3
3
|
export { type AnyApiReferenceConfiguration, type ApiReferenceConfiguration, type ApiReferenceConfigurationRaw, type ApiReferenceConfigurationWithMultipleSources, type ApiReferenceConfigurationWithSource, apiReferenceConfigurationSchema, apiReferenceConfigurationWithSourceSchema, isConfigurationWithSources, } from './api-reference-configuration.js';
|
|
4
4
|
export type { ApiReferencePlugin, SpecificationExtension, ViewComponent, } from './api-reference-plugin.js';
|
|
5
5
|
export type { AuthenticationConfiguration } from './authentication-configuration.js';
|
|
6
|
+
export type { ExternalUrls } from './base-configuration.js';
|
|
6
7
|
export type { ApiReferenceInstance, CreateApiReference } from './html-api.js';
|
|
7
8
|
export { type HtmlRenderingConfiguration, htmlRenderingConfigurationSchema, } from './html-rendering-configuration.js';
|
|
8
9
|
export { type SourceConfiguration, sourceConfigurationSchema, } from './source-configuration.js';
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/api-reference/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,sBAAsB,EAC3B,4BAA4B,GAC7B,MAAM,4BAA4B,CAAA;AACnC,OAAO,EAAE,KAAK,eAAe,EAAE,qBAAqB,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAA;AAC9F,OAAO,EACL,KAAK,4BAA4B,EACjC,KAAK,yBAAyB,EAC9B,KAAK,4BAA4B,EACjC,KAAK,4CAA4C,EACjD,KAAK,mCAAmC,EACxC,+BAA+B,EAC/B,yCAAyC,EACzC,0BAA0B,GAC3B,MAAM,+BAA+B,CAAA;AACtC,YAAY,EACV,kBAAkB,EAClB,sBAAsB,EACtB,aAAa,GACd,MAAM,wBAAwB,CAAA;AAC/B,YAAY,EAAE,2BAA2B,EAAE,MAAM,gCAAgC,CAAA;AACjF,YAAY,EAAE,oBAAoB,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAA;AAC1E,OAAO,EACL,KAAK,0BAA0B,EAC/B,gCAAgC,GACjC,MAAM,gCAAgC,CAAA;AACvC,OAAO,EACL,KAAK,mBAAmB,EACxB,yBAAyB,GAC1B,MAAM,wBAAwB,CAAA"}
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/api-reference/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,sBAAsB,EAC3B,4BAA4B,GAC7B,MAAM,4BAA4B,CAAA;AACnC,OAAO,EAAE,KAAK,eAAe,EAAE,qBAAqB,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAA;AAC9F,OAAO,EACL,KAAK,4BAA4B,EACjC,KAAK,yBAAyB,EAC9B,KAAK,4BAA4B,EACjC,KAAK,4CAA4C,EACjD,KAAK,mCAAmC,EACxC,+BAA+B,EAC/B,yCAAyC,EACzC,0BAA0B,GAC3B,MAAM,+BAA+B,CAAA;AACtC,YAAY,EACV,kBAAkB,EAClB,sBAAsB,EACtB,aAAa,GACd,MAAM,wBAAwB,CAAA;AAC/B,YAAY,EAAE,2BAA2B,EAAE,MAAM,gCAAgC,CAAA;AACjF,YAAY,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAA;AACxD,YAAY,EAAE,oBAAoB,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAA;AAC1E,OAAO,EACL,KAAK,0BAA0B,EAC/B,gCAAgC,GACjC,MAAM,gCAAgC,CAAA;AACvC,OAAO,EACL,KAAK,mBAAmB,EACxB,yBAAyB,GAC1B,MAAM,wBAAwB,CAAA"}
|