@scalar/types
Version:
Types to work with Scalar packages
551 lines • 25.9 kB
TypeScript
import { z } from 'zod';
declare const openApiExtensionSchema: z.ZodObject<{
name: z.ZodString;
component: z.ZodUnknown;
renderer: z.ZodOptional<z.ZodUnknown>;
}, z.core.$strip>;
declare const viewComponentSchema: z.ZodObject<{
component: z.ZodUnknown;
renderer: z.ZodOptional<z.ZodUnknown>;
props: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
}, z.core.$strip>;
declare const lifecycleHooksSchema: z.ZodObject<{
onInit: z.ZodOptional<z.ZodFunction<z.ZodTuple<readonly [z.ZodObject<{
config: z.ZodObject<{
title: z.ZodOptional<z.ZodOptional<z.ZodString>>;
slug: z.ZodOptional<z.ZodOptional<z.ZodString>>;
authentication: z.ZodOptional<z.ZodOptional<z.ZodAny>>;
baseServerURL: z.ZodOptional<z.ZodOptional<z.ZodString>>;
hideClientButton: z.ZodOptional<z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>>;
proxyUrl: z.ZodOptional<z.ZodOptional<z.ZodString>>;
oauth2RedirectUri: z.ZodOptional<z.ZodOptional<z.ZodString>>;
searchHotKey: z.ZodOptional<z.ZodOptional<z.ZodEnum<{
a: "a";
b: "b";
c: "c";
d: "d";
e: "e";
f: "f";
g: "g";
h: "h";
i: "i";
j: "j";
k: "k";
l: "l";
m: "m";
n: "n";
o: "o";
p: "p";
q: "q";
r: "r";
s: "s";
t: "t";
u: "u";
v: "v";
w: "w";
x: "x";
y: "y";
z: "z";
}>>>;
servers: z.ZodOptional<z.ZodOptional<z.ZodArray<z.ZodAny>>>;
showSidebar: z.ZodOptional<z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>>;
showDeveloperTools: z.ZodOptional<z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodEnum<{
localhost: "localhost";
always: "always";
never: "never";
}>>>>>;
showToolbar: z.ZodOptional<z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodEnum<{
localhost: "localhost";
always: "always";
never: "never";
}>>>>>;
operationTitleSource: z.ZodOptional<z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodEnum<{
summary: "summary";
path: "path";
}>>>>>;
theme: z.ZodOptional<z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodEnum<{
default: "default";
alternate: "alternate";
moon: "moon";
purple: "purple";
solarized: "solarized";
bluePlanet: "bluePlanet";
deepSpace: "deepSpace";
saturn: "saturn";
kepler: "kepler";
elysiajs: "elysiajs";
fastify: "fastify";
mars: "mars";
laserwave: "laserwave";
none: "none";
}>>>>>;
_integration: z.ZodOptional<z.ZodOptional<z.ZodNullable<z.ZodEnum<{
elysiajs: "elysiajs";
fastify: "fastify";
adonisjs: "adonisjs";
astro: "astro";
docusaurus: "docusaurus";
dotnet: "dotnet";
express: "express";
fastapi: "fastapi";
go: "go";
hono: "hono";
html: "html";
laravel: "laravel";
litestar: "litestar";
nestjs: "nestjs";
nextjs: "nextjs";
nitro: "nitro";
nuxt: "nuxt";
platformatic: "platformatic";
react: "react";
rust: "rust";
svelte: "svelte";
vue: "vue";
}>>>>;
onRequestSent: z.ZodOptional<z.ZodOptional<z.ZodFunction<z.ZodTuple<readonly [z.ZodString], null>, z.ZodVoid>>>;
persistAuth: z.ZodOptional<z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>>;
plugins: z.ZodOptional<z.ZodOptional<z.ZodArray<z.ZodFunction<z.ZodTuple<readonly [], null>, z.ZodObject<{
name: z.ZodString;
views: z.ZodOptional<z.ZodObject<{
'request.section': z.ZodOptional<z.ZodArray<z.ZodObject<{
title: z.ZodOptional<z.ZodString>;
component: z.ZodUnknown;
props: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
}, z.core.$strip>>>;
'response.section': z.ZodOptional<z.ZodArray<z.ZodObject<{
title: z.ZodOptional<z.ZodString>;
component: z.ZodUnknown;
props: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
}, z.core.$strip>>>;
}, z.core.$strip>>;
hooks: z.ZodOptional<z.ZodObject<{
onBeforeRequest: z.ZodOptional<z.ZodFunction<z.ZodTuple<readonly [z.ZodObject<{
request: z.ZodAny;
}, z.core.$strip>], null>, z.core.$ZodFunctionOut>>;
onResponseReceived: z.ZodOptional<z.ZodFunction<z.ZodTuple<readonly [z.ZodObject<{
response: z.ZodCustom<Response, Response>;
operation: z.ZodRecord<z.ZodString, z.ZodAny>;
}, z.core.$strip>], null>, z.core.$ZodFunctionOut>>;
}, z.core.$strip>>;
}, z.core.$strip>>>>>;
telemetry: z.ZodOptional<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
externalUrls: z.ZodOptional<z.ZodPrefault<z.ZodObject<{
dashboardUrl: z.ZodPrefault<z.ZodString>;
registryUrl: z.ZodPrefault<z.ZodString>;
proxyUrl: z.ZodPrefault<z.ZodString>;
apiBaseUrl: z.ZodPrefault<z.ZodString>;
}, z.core.$strip>>>;
}, z.core.$strip>;
}, z.core.$strip>], null>, z.core.$ZodFunctionOut>>;
onConfigChange: z.ZodOptional<z.ZodFunction<z.ZodTuple<readonly [z.ZodObject<{
config: z.ZodObject<{
title: z.ZodOptional<z.ZodOptional<z.ZodString>>;
slug: z.ZodOptional<z.ZodOptional<z.ZodString>>;
authentication: z.ZodOptional<z.ZodOptional<z.ZodAny>>;
baseServerURL: z.ZodOptional<z.ZodOptional<z.ZodString>>;
hideClientButton: z.ZodOptional<z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>>;
proxyUrl: z.ZodOptional<z.ZodOptional<z.ZodString>>;
oauth2RedirectUri: z.ZodOptional<z.ZodOptional<z.ZodString>>;
searchHotKey: z.ZodOptional<z.ZodOptional<z.ZodEnum<{
a: "a";
b: "b";
c: "c";
d: "d";
e: "e";
f: "f";
g: "g";
h: "h";
i: "i";
j: "j";
k: "k";
l: "l";
m: "m";
n: "n";
o: "o";
p: "p";
q: "q";
r: "r";
s: "s";
t: "t";
u: "u";
v: "v";
w: "w";
x: "x";
y: "y";
z: "z";
}>>>;
servers: z.ZodOptional<z.ZodOptional<z.ZodArray<z.ZodAny>>>;
showSidebar: z.ZodOptional<z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>>;
showDeveloperTools: z.ZodOptional<z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodEnum<{
localhost: "localhost";
always: "always";
never: "never";
}>>>>>;
showToolbar: z.ZodOptional<z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodEnum<{
localhost: "localhost";
always: "always";
never: "never";
}>>>>>;
operationTitleSource: z.ZodOptional<z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodEnum<{
summary: "summary";
path: "path";
}>>>>>;
theme: z.ZodOptional<z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodEnum<{
default: "default";
alternate: "alternate";
moon: "moon";
purple: "purple";
solarized: "solarized";
bluePlanet: "bluePlanet";
deepSpace: "deepSpace";
saturn: "saturn";
kepler: "kepler";
elysiajs: "elysiajs";
fastify: "fastify";
mars: "mars";
laserwave: "laserwave";
none: "none";
}>>>>>;
_integration: z.ZodOptional<z.ZodOptional<z.ZodNullable<z.ZodEnum<{
elysiajs: "elysiajs";
fastify: "fastify";
adonisjs: "adonisjs";
astro: "astro";
docusaurus: "docusaurus";
dotnet: "dotnet";
express: "express";
fastapi: "fastapi";
go: "go";
hono: "hono";
html: "html";
laravel: "laravel";
litestar: "litestar";
nestjs: "nestjs";
nextjs: "nextjs";
nitro: "nitro";
nuxt: "nuxt";
platformatic: "platformatic";
react: "react";
rust: "rust";
svelte: "svelte";
vue: "vue";
}>>>>;
onRequestSent: z.ZodOptional<z.ZodOptional<z.ZodFunction<z.ZodTuple<readonly [z.ZodString], null>, z.ZodVoid>>>;
persistAuth: z.ZodOptional<z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>>;
plugins: z.ZodOptional<z.ZodOptional<z.ZodArray<z.ZodFunction<z.ZodTuple<readonly [], null>, z.ZodObject<{
name: z.ZodString;
views: z.ZodOptional<z.ZodObject<{
'request.section': z.ZodOptional<z.ZodArray<z.ZodObject<{
title: z.ZodOptional<z.ZodString>;
component: z.ZodUnknown;
props: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
}, z.core.$strip>>>;
'response.section': z.ZodOptional<z.ZodArray<z.ZodObject<{
title: z.ZodOptional<z.ZodString>;
component: z.ZodUnknown;
props: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
}, z.core.$strip>>>;
}, z.core.$strip>>;
hooks: z.ZodOptional<z.ZodObject<{
onBeforeRequest: z.ZodOptional<z.ZodFunction<z.ZodTuple<readonly [z.ZodObject<{
request: z.ZodAny;
}, z.core.$strip>], null>, z.core.$ZodFunctionOut>>;
onResponseReceived: z.ZodOptional<z.ZodFunction<z.ZodTuple<readonly [z.ZodObject<{
response: z.ZodCustom<Response, Response>;
operation: z.ZodRecord<z.ZodString, z.ZodAny>;
}, z.core.$strip>], null>, z.core.$ZodFunctionOut>>;
}, z.core.$strip>>;
}, z.core.$strip>>>>>;
telemetry: z.ZodOptional<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
externalUrls: z.ZodOptional<z.ZodPrefault<z.ZodObject<{
dashboardUrl: z.ZodPrefault<z.ZodString>;
registryUrl: z.ZodPrefault<z.ZodString>;
proxyUrl: z.ZodPrefault<z.ZodString>;
apiBaseUrl: z.ZodPrefault<z.ZodString>;
}, z.core.$strip>>>;
}, z.core.$strip>;
}, z.core.$strip>], null>, z.core.$ZodFunctionOut>>;
onDestroy: z.ZodOptional<z.ZodFunction<z.ZodTuple<readonly [], null>, z.core.$ZodFunctionOut>>;
}, z.core.$strip>;
export declare const apiReferencePluginSchema: z.ZodFunction<z.ZodTuple<readonly [], null>, z.ZodObject<{
name: z.ZodString;
extensions: z.ZodArray<z.ZodObject<{
name: z.ZodString;
component: z.ZodUnknown;
renderer: z.ZodOptional<z.ZodUnknown>;
}, z.core.$strip>>;
views: z.ZodOptional<z.ZodObject<{
'content.end': z.ZodOptional<z.ZodArray<z.ZodObject<{
component: z.ZodUnknown;
renderer: z.ZodOptional<z.ZodUnknown>;
props: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
}, z.core.$strip>>>;
}, z.core.$strip>>;
hooks: z.ZodOptional<z.ZodObject<{
onInit: z.ZodOptional<z.ZodFunction<z.ZodTuple<readonly [z.ZodObject<{
config: z.ZodObject<{
title: z.ZodOptional<z.ZodOptional<z.ZodString>>;
slug: z.ZodOptional<z.ZodOptional<z.ZodString>>;
authentication: z.ZodOptional<z.ZodOptional<z.ZodAny>>;
baseServerURL: z.ZodOptional<z.ZodOptional<z.ZodString>>;
hideClientButton: z.ZodOptional<z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>>;
proxyUrl: z.ZodOptional<z.ZodOptional<z.ZodString>>;
oauth2RedirectUri: z.ZodOptional<z.ZodOptional<z.ZodString>>;
searchHotKey: z.ZodOptional<z.ZodOptional<z.ZodEnum<{
a: "a";
b: "b";
c: "c";
d: "d";
e: "e";
f: "f";
g: "g";
h: "h";
i: "i";
j: "j";
k: "k";
l: "l";
m: "m";
n: "n";
o: "o";
p: "p";
q: "q";
r: "r";
s: "s";
t: "t";
u: "u";
v: "v";
w: "w";
x: "x";
y: "y";
z: "z";
}>>>;
servers: z.ZodOptional<z.ZodOptional<z.ZodArray<z.ZodAny>>>;
showSidebar: z.ZodOptional<z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>>;
showDeveloperTools: z.ZodOptional<z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodEnum<{
localhost: "localhost";
always: "always";
never: "never";
}>>>>>;
showToolbar: z.ZodOptional<z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodEnum<{
localhost: "localhost";
always: "always";
never: "never";
}>>>>>;
operationTitleSource: z.ZodOptional<z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodEnum<{
summary: "summary";
path: "path";
}>>>>>;
theme: z.ZodOptional<z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodEnum<{
default: "default";
alternate: "alternate";
moon: "moon";
purple: "purple";
solarized: "solarized";
bluePlanet: "bluePlanet";
deepSpace: "deepSpace";
saturn: "saturn";
kepler: "kepler";
elysiajs: "elysiajs";
fastify: "fastify";
mars: "mars";
laserwave: "laserwave";
none: "none";
}>>>>>;
_integration: z.ZodOptional<z.ZodOptional<z.ZodNullable<z.ZodEnum<{
elysiajs: "elysiajs";
fastify: "fastify";
adonisjs: "adonisjs";
astro: "astro";
docusaurus: "docusaurus";
dotnet: "dotnet";
express: "express";
fastapi: "fastapi";
go: "go";
hono: "hono";
html: "html";
laravel: "laravel";
litestar: "litestar";
nestjs: "nestjs";
nextjs: "nextjs";
nitro: "nitro";
nuxt: "nuxt";
platformatic: "platformatic";
react: "react";
rust: "rust";
svelte: "svelte";
vue: "vue";
}>>>>;
onRequestSent: z.ZodOptional<z.ZodOptional<z.ZodFunction<z.ZodTuple<readonly [z.ZodString], null>, z.ZodVoid>>>;
persistAuth: z.ZodOptional<z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>>;
plugins: z.ZodOptional<z.ZodOptional<z.ZodArray<z.ZodFunction<z.ZodTuple<readonly [], null>, z.ZodObject<{
name: z.ZodString;
views: z.ZodOptional<z.ZodObject<{
'request.section': z.ZodOptional<z.ZodArray<z.ZodObject<{
title: z.ZodOptional<z.ZodString>;
component: z.ZodUnknown;
props: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
}, z.core.$strip>>>;
'response.section': z.ZodOptional<z.ZodArray<z.ZodObject<{
title: z.ZodOptional<z.ZodString>;
component: z.ZodUnknown;
props: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
}, z.core.$strip>>>;
}, z.core.$strip>>;
hooks: z.ZodOptional<z.ZodObject<{
onBeforeRequest: z.ZodOptional<z.ZodFunction<z.ZodTuple<readonly [z.ZodObject<{
request: z.ZodAny;
}, z.core.$strip>], null>, z.core.$ZodFunctionOut>>;
onResponseReceived: z.ZodOptional<z.ZodFunction<z.ZodTuple<readonly [z.ZodObject<{
response: z.ZodCustom<Response, Response>;
operation: z.ZodRecord<z.ZodString, z.ZodAny>;
}, z.core.$strip>], null>, z.core.$ZodFunctionOut>>;
}, z.core.$strip>>;
}, z.core.$strip>>>>>;
telemetry: z.ZodOptional<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
externalUrls: z.ZodOptional<z.ZodPrefault<z.ZodObject<{
dashboardUrl: z.ZodPrefault<z.ZodString>;
registryUrl: z.ZodPrefault<z.ZodString>;
proxyUrl: z.ZodPrefault<z.ZodString>;
apiBaseUrl: z.ZodPrefault<z.ZodString>;
}, z.core.$strip>>>;
}, z.core.$strip>;
}, z.core.$strip>], null>, z.core.$ZodFunctionOut>>;
onConfigChange: z.ZodOptional<z.ZodFunction<z.ZodTuple<readonly [z.ZodObject<{
config: z.ZodObject<{
title: z.ZodOptional<z.ZodOptional<z.ZodString>>;
slug: z.ZodOptional<z.ZodOptional<z.ZodString>>;
authentication: z.ZodOptional<z.ZodOptional<z.ZodAny>>;
baseServerURL: z.ZodOptional<z.ZodOptional<z.ZodString>>;
hideClientButton: z.ZodOptional<z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>>;
proxyUrl: z.ZodOptional<z.ZodOptional<z.ZodString>>;
oauth2RedirectUri: z.ZodOptional<z.ZodOptional<z.ZodString>>;
searchHotKey: z.ZodOptional<z.ZodOptional<z.ZodEnum<{
a: "a";
b: "b";
c: "c";
d: "d";
e: "e";
f: "f";
g: "g";
h: "h";
i: "i";
j: "j";
k: "k";
l: "l";
m: "m";
n: "n";
o: "o";
p: "p";
q: "q";
r: "r";
s: "s";
t: "t";
u: "u";
v: "v";
w: "w";
x: "x";
y: "y";
z: "z";
}>>>;
servers: z.ZodOptional<z.ZodOptional<z.ZodArray<z.ZodAny>>>;
showSidebar: z.ZodOptional<z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>>;
showDeveloperTools: z.ZodOptional<z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodEnum<{
localhost: "localhost";
always: "always";
never: "never";
}>>>>>;
showToolbar: z.ZodOptional<z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodEnum<{
localhost: "localhost";
always: "always";
never: "never";
}>>>>>;
operationTitleSource: z.ZodOptional<z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodEnum<{
summary: "summary";
path: "path";
}>>>>>;
theme: z.ZodOptional<z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodEnum<{
default: "default";
alternate: "alternate";
moon: "moon";
purple: "purple";
solarized: "solarized";
bluePlanet: "bluePlanet";
deepSpace: "deepSpace";
saturn: "saturn";
kepler: "kepler";
elysiajs: "elysiajs";
fastify: "fastify";
mars: "mars";
laserwave: "laserwave";
none: "none";
}>>>>>;
_integration: z.ZodOptional<z.ZodOptional<z.ZodNullable<z.ZodEnum<{
elysiajs: "elysiajs";
fastify: "fastify";
adonisjs: "adonisjs";
astro: "astro";
docusaurus: "docusaurus";
dotnet: "dotnet";
express: "express";
fastapi: "fastapi";
go: "go";
hono: "hono";
html: "html";
laravel: "laravel";
litestar: "litestar";
nestjs: "nestjs";
nextjs: "nextjs";
nitro: "nitro";
nuxt: "nuxt";
platformatic: "platformatic";
react: "react";
rust: "rust";
svelte: "svelte";
vue: "vue";
}>>>>;
onRequestSent: z.ZodOptional<z.ZodOptional<z.ZodFunction<z.ZodTuple<readonly [z.ZodString], null>, z.ZodVoid>>>;
persistAuth: z.ZodOptional<z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>>;
plugins: z.ZodOptional<z.ZodOptional<z.ZodArray<z.ZodFunction<z.ZodTuple<readonly [], null>, z.ZodObject<{
name: z.ZodString;
views: z.ZodOptional<z.ZodObject<{
'request.section': z.ZodOptional<z.ZodArray<z.ZodObject<{
title: z.ZodOptional<z.ZodString>;
component: z.ZodUnknown;
props: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
}, z.core.$strip>>>;
'response.section': z.ZodOptional<z.ZodArray<z.ZodObject<{
title: z.ZodOptional<z.ZodString>;
component: z.ZodUnknown;
props: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
}, z.core.$strip>>>;
}, z.core.$strip>>;
hooks: z.ZodOptional<z.ZodObject<{
onBeforeRequest: z.ZodOptional<z.ZodFunction<z.ZodTuple<readonly [z.ZodObject<{
request: z.ZodAny;
}, z.core.$strip>], null>, z.core.$ZodFunctionOut>>;
onResponseReceived: z.ZodOptional<z.ZodFunction<z.ZodTuple<readonly [z.ZodObject<{
response: z.ZodCustom<Response, Response>;
operation: z.ZodRecord<z.ZodString, z.ZodAny>;
}, z.core.$strip>], null>, z.core.$ZodFunctionOut>>;
}, z.core.$strip>>;
}, z.core.$strip>>>>>;
telemetry: z.ZodOptional<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
externalUrls: z.ZodOptional<z.ZodPrefault<z.ZodObject<{
dashboardUrl: z.ZodPrefault<z.ZodString>;
registryUrl: z.ZodPrefault<z.ZodString>;
proxyUrl: z.ZodPrefault<z.ZodString>;
apiBaseUrl: z.ZodPrefault<z.ZodString>;
}, z.core.$strip>>>;
}, z.core.$strip>;
}, z.core.$strip>], null>, z.core.$ZodFunctionOut>>;
onDestroy: z.ZodOptional<z.ZodFunction<z.ZodTuple<readonly [], null>, z.core.$ZodFunctionOut>>;
}, z.core.$strip>>;
apiClientPlugins: z.ZodOptional<z.ZodArray<z.ZodAny>>;
}, z.core.$strip>>;
export type SpecificationExtension = z.infer<typeof openApiExtensionSchema>;
export type ViewComponent = z.infer<typeof viewComponentSchema>;
export type LifecycleHooks = z.infer<typeof lifecycleHooksSchema>;
export type ApiReferencePlugin = z.infer<typeof apiReferencePluginSchema>;
export {};
//# sourceMappingURL=api-reference-plugin.d.ts.map