@mintlify/validation
Advanced tools
Comparing version 0.1.246 to 0.1.247
import { z } from 'zod'; | ||
import { lindenConfigSchema } from './themes/linden.js'; | ||
import { mapleConfigSchema } from './themes/maple.js'; | ||
import { mintConfigSchema } from './themes/mint.js'; | ||
import { prismConfigSchema } from './themes/prism.js'; | ||
import { quillConfigSchema } from './themes/quill.js'; | ||
import { venusConfigSchema } from './themes/venus.js'; | ||
import { palmConfigSchema } from './themes/palm.js'; | ||
import { willowConfigSchema } from './themes/willow.js'; | ||
export const docsConfigSchema = z.discriminatedUnion('theme', [ | ||
mintConfigSchema, | ||
prismConfigSchema, | ||
quillConfigSchema, | ||
venusConfigSchema, | ||
mapleConfigSchema, | ||
palmConfigSchema, | ||
willowConfigSchema, | ||
lindenConfigSchema, | ||
]); |
@@ -5,7 +5,7 @@ import { z } from 'zod'; | ||
playground: z.ZodOptional<z.ZodObject<{ | ||
display: z.ZodDefault<z.ZodOptional<z.ZodEnum<["interactive", "simple", "none"]>>>; | ||
proxy: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>; | ||
display: z.ZodOptional<z.ZodEnum<["interactive", "simple", "none"]>>; | ||
proxy: z.ZodOptional<z.ZodBoolean>; | ||
}, "strip", z.ZodTypeAny, { | ||
display: "simple" | "none" | "interactive"; | ||
proxy: boolean; | ||
display?: "simple" | "none" | "interactive" | undefined; | ||
proxy?: boolean | undefined; | ||
}, { | ||
@@ -24,9 +24,9 @@ display?: "simple" | "none" | "interactive" | undefined; | ||
auth: z.ZodOptional<z.ZodEnum<["bearer", "basic", "key", "cobo"]>>; | ||
base: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>>; | ||
server: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>>; | ||
}, "strip", z.ZodTypeAny, { | ||
auth?: "key" | "bearer" | "basic" | "cobo" | undefined; | ||
base?: string | string[] | undefined; | ||
server?: string | string[] | undefined; | ||
}, { | ||
auth?: "key" | "bearer" | "basic" | "cobo" | undefined; | ||
base?: string | string[] | undefined; | ||
server?: string | string[] | undefined; | ||
}>>; | ||
@@ -36,4 +36,4 @@ }, "strip", z.ZodTypeAny, { | ||
playground?: { | ||
display: "simple" | "none" | "interactive"; | ||
proxy: boolean; | ||
display?: "simple" | "none" | "interactive" | undefined; | ||
proxy?: boolean | undefined; | ||
} | undefined; | ||
@@ -45,3 +45,3 @@ examples?: { | ||
auth?: "key" | "bearer" | "basic" | "cobo" | undefined; | ||
base?: string | string[] | undefined; | ||
server?: string | string[] | undefined; | ||
} | undefined; | ||
@@ -59,4 +59,4 @@ }, { | ||
auth?: "key" | "bearer" | "basic" | "cobo" | undefined; | ||
base?: string | string[] | undefined; | ||
server?: string | string[] | undefined; | ||
} | undefined; | ||
}>; |
@@ -11,9 +11,7 @@ import { z } from 'zod'; | ||
.optional() | ||
.default('interactive') | ||
.describe('The display mode of the API playground'), | ||
.describe('The display mode of the API playground. Defaults to `interactive`.'), | ||
proxy: z | ||
.boolean() | ||
.optional() | ||
.default(false) | ||
.describe('Whether to pass API requests through a proxy server'), | ||
.describe('Whether to pass API requests through a proxy server. Defaults to `false`.'), | ||
}) | ||
@@ -37,3 +35,3 @@ .optional() | ||
.describe('Authentication method for the API'), | ||
base: z | ||
server: z | ||
.union([z.string().url(), z.array(z.string().url())]) | ||
@@ -40,0 +38,0 @@ .optional() |
import { z } from 'zod'; | ||
export declare const appearanceSchema: z.ZodObject<{ | ||
default: z.ZodDefault<z.ZodEnum<["system", "light", "dark"]>>; | ||
strict: z.ZodDefault<z.ZodBoolean>; | ||
default: z.ZodOptional<z.ZodEnum<["system", "light", "dark"]>>; | ||
strict: z.ZodOptional<z.ZodBoolean>; | ||
}, "strip", z.ZodTypeAny, { | ||
strict: boolean; | ||
default: "light" | "dark" | "system"; | ||
default?: "light" | "dark" | "system" | undefined; | ||
strict?: boolean | undefined; | ||
}, { | ||
@@ -9,0 +9,0 @@ default?: "light" | "dark" | "system" | undefined; |
@@ -6,6 +6,9 @@ import { z } from 'zod'; | ||
.enum(['system', 'light', 'dark']) | ||
.default('system') | ||
.describe('The default light/dark mode'), | ||
strict: z.boolean().default(false).describe('Whether to hide the light / dark mode toggle'), | ||
.optional() | ||
.describe('The default light/dark mode. Defaults to system'), | ||
strict: z | ||
.boolean() | ||
.optional() | ||
.describe('Whether to hide the light / dark mode toggle. Defaults to `false`.'), | ||
}) | ||
.describe('Light / dark mode toggle settings'); |
import { z } from 'zod'; | ||
export declare const iconsSchema: z.ZodObject<{ | ||
library: z.ZodDefault<z.ZodEnum<["fontawesome"]>>; | ||
library: z.ZodEnum<["fontawesome"]>; | ||
}, "strip", z.ZodTypeAny, { | ||
library: "fontawesome"; | ||
}, { | ||
library?: "fontawesome" | undefined; | ||
library: "fontawesome"; | ||
}>; |
import { z } from 'zod'; | ||
export const iconsSchema = z | ||
.object({ | ||
library: z.enum(['fontawesome']).default('fontawesome').describe('The icon library to be used'), | ||
library: z | ||
.enum(['fontawesome']) | ||
.describe('The icon library to be used. Defaults to `fontawesome`.'), | ||
}) | ||
.describe('Icon library settings'); |
export * from './font.js'; | ||
export * from './navigation/index.js'; | ||
export * from './navigation/anchors.js'; | ||
export * from './navigation/global.js'; | ||
export * from './navigation/groups.js'; | ||
export * from './navigation/languages.js'; | ||
export * from './navigation/pages.js'; | ||
export * from './navigation/tabs.js'; | ||
export * from './navigation/version.js'; | ||
export * from './reusable/index.js'; |
export * from './font.js'; | ||
export * from './navigation/index.js'; | ||
export * from './navigation/anchors.js'; | ||
export * from './navigation/global.js'; | ||
export * from './navigation/groups.js'; | ||
export * from './navigation/languages.js'; | ||
export * from './navigation/pages.js'; | ||
export * from './navigation/tabs.js'; | ||
export * from './navigation/version.js'; | ||
export * from './reusable/index.js'; |
import { z } from 'zod'; | ||
export declare const anchorSchema: z.ZodType; | ||
export declare const nonRecursiveAnchorSchema: z.ZodIntersection<z.ZodObject<{ | ||
@@ -26,2 +25,3 @@ anchor: z.ZodString; | ||
hidden: z.ZodOptional<z.ZodBoolean>; | ||
openapi: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">]>>; | ||
}, "strip", z.ZodTypeAny, { | ||
@@ -38,2 +38,3 @@ anchor: string; | ||
hidden?: boolean | undefined; | ||
openapi?: string | string[] | undefined; | ||
}, { | ||
@@ -50,2 +51,3 @@ anchor: string; | ||
hidden?: boolean | undefined; | ||
openapi?: string | string[] | undefined; | ||
}>, z.ZodObject<{ | ||
@@ -58,4 +60,225 @@ href: z.ZodString; | ||
}>>; | ||
export declare const anchorsSchema: z.ZodArray<z.ZodType<any, z.ZodTypeDef, any>, "many">; | ||
export declare const anchorSchema: z.ZodIntersection<z.ZodObject<{ | ||
anchor: z.ZodString; | ||
icon: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodObject<{ | ||
style: z.ZodOptional<z.ZodEnum<["brands", "duotone", "light", "regular", "sharp-duotone-solid", "sharp-light", "sharp-regular", "sharp-solid", "sharp-thin", "solid", "thin"]>>; | ||
name: z.ZodEffects<z.ZodString, string, string>; | ||
}, "strip", z.ZodTypeAny, { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
}, { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
}>]>>; | ||
color: z.ZodOptional<z.ZodObject<{ | ||
light: z.ZodOptional<z.ZodString>; | ||
dark: z.ZodOptional<z.ZodString>; | ||
}, "strict", z.ZodTypeAny, { | ||
light?: string | undefined; | ||
dark?: string | undefined; | ||
}, { | ||
light?: string | undefined; | ||
dark?: string | undefined; | ||
}>>; | ||
hidden: z.ZodOptional<z.ZodBoolean>; | ||
openapi: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">]>>; | ||
}, "strip", z.ZodTypeAny, { | ||
anchor: string; | ||
icon?: string | { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
} | undefined; | ||
color?: { | ||
light?: string | undefined; | ||
dark?: string | undefined; | ||
} | undefined; | ||
hidden?: boolean | undefined; | ||
openapi?: string | string[] | undefined; | ||
}, { | ||
anchor: string; | ||
icon?: string | { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
} | undefined; | ||
color?: { | ||
light?: string | undefined; | ||
dark?: string | undefined; | ||
} | undefined; | ||
hidden?: boolean | undefined; | ||
openapi?: string | string[] | undefined; | ||
}>, z.ZodUnion<[z.ZodObject<{ | ||
href: z.ZodString; | ||
}, "strip", z.ZodTypeAny, { | ||
href: string; | ||
}, { | ||
href: string; | ||
}>, z.ZodType<any, z.ZodTypeDef, any>, z.ZodType<any, z.ZodTypeDef, any>, ...z.ZodType<any, z.ZodTypeDef, any>[]]>>; | ||
export declare const decoratedAnchorSchema: z.ZodIntersection<z.ZodObject<{ | ||
anchor: z.ZodString; | ||
icon: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodObject<{ | ||
style: z.ZodOptional<z.ZodEnum<["brands", "duotone", "light", "regular", "sharp-duotone-solid", "sharp-light", "sharp-regular", "sharp-solid", "sharp-thin", "solid", "thin"]>>; | ||
name: z.ZodEffects<z.ZodString, string, string>; | ||
}, "strip", z.ZodTypeAny, { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
}, { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
}>]>>; | ||
color: z.ZodOptional<z.ZodObject<{ | ||
light: z.ZodOptional<z.ZodString>; | ||
dark: z.ZodOptional<z.ZodString>; | ||
}, "strict", z.ZodTypeAny, { | ||
light?: string | undefined; | ||
dark?: string | undefined; | ||
}, { | ||
light?: string | undefined; | ||
dark?: string | undefined; | ||
}>>; | ||
hidden: z.ZodOptional<z.ZodBoolean>; | ||
openapi: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">]>>; | ||
}, "strip", z.ZodTypeAny, { | ||
anchor: string; | ||
icon?: string | { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
} | undefined; | ||
color?: { | ||
light?: string | undefined; | ||
dark?: string | undefined; | ||
} | undefined; | ||
hidden?: boolean | undefined; | ||
openapi?: string | string[] | undefined; | ||
}, { | ||
anchor: string; | ||
icon?: string | { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
} | undefined; | ||
color?: { | ||
light?: string | undefined; | ||
dark?: string | undefined; | ||
} | undefined; | ||
hidden?: boolean | undefined; | ||
openapi?: string | string[] | undefined; | ||
}>, z.ZodUnion<[z.ZodObject<{ | ||
href: z.ZodString; | ||
}, "strip", z.ZodTypeAny, { | ||
href: string; | ||
}, { | ||
href: string; | ||
}>, z.ZodType<any, z.ZodTypeDef, any>, z.ZodType<any, z.ZodTypeDef, any>, ...z.ZodType<any, z.ZodTypeDef, any>[]]>>; | ||
export declare const anchorsSchema: z.ZodArray<z.ZodIntersection<z.ZodObject<{ | ||
anchor: z.ZodString; | ||
icon: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodObject<{ | ||
style: z.ZodOptional<z.ZodEnum<["brands", "duotone", "light", "regular", "sharp-duotone-solid", "sharp-light", "sharp-regular", "sharp-solid", "sharp-thin", "solid", "thin"]>>; | ||
name: z.ZodEffects<z.ZodString, string, string>; | ||
}, "strip", z.ZodTypeAny, { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
}, { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
}>]>>; | ||
color: z.ZodOptional<z.ZodObject<{ | ||
light: z.ZodOptional<z.ZodString>; | ||
dark: z.ZodOptional<z.ZodString>; | ||
}, "strict", z.ZodTypeAny, { | ||
light?: string | undefined; | ||
dark?: string | undefined; | ||
}, { | ||
light?: string | undefined; | ||
dark?: string | undefined; | ||
}>>; | ||
hidden: z.ZodOptional<z.ZodBoolean>; | ||
openapi: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">]>>; | ||
}, "strip", z.ZodTypeAny, { | ||
anchor: string; | ||
icon?: string | { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
} | undefined; | ||
color?: { | ||
light?: string | undefined; | ||
dark?: string | undefined; | ||
} | undefined; | ||
hidden?: boolean | undefined; | ||
openapi?: string | string[] | undefined; | ||
}, { | ||
anchor: string; | ||
icon?: string | { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
} | undefined; | ||
color?: { | ||
light?: string | undefined; | ||
dark?: string | undefined; | ||
} | undefined; | ||
hidden?: boolean | undefined; | ||
openapi?: string | string[] | undefined; | ||
}>, z.ZodUnion<[z.ZodObject<{ | ||
href: z.ZodString; | ||
}, "strip", z.ZodTypeAny, { | ||
href: string; | ||
}, { | ||
href: string; | ||
}>, z.ZodType<any, z.ZodTypeDef, any>, z.ZodType<any, z.ZodTypeDef, any>, ...z.ZodType<any, z.ZodTypeDef, any>[]]>>, "many">; | ||
export declare const decoratedAnchorsSchema: z.ZodArray<z.ZodIntersection<z.ZodObject<{ | ||
anchor: z.ZodString; | ||
icon: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodObject<{ | ||
style: z.ZodOptional<z.ZodEnum<["brands", "duotone", "light", "regular", "sharp-duotone-solid", "sharp-light", "sharp-regular", "sharp-solid", "sharp-thin", "solid", "thin"]>>; | ||
name: z.ZodEffects<z.ZodString, string, string>; | ||
}, "strip", z.ZodTypeAny, { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
}, { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
}>]>>; | ||
color: z.ZodOptional<z.ZodObject<{ | ||
light: z.ZodOptional<z.ZodString>; | ||
dark: z.ZodOptional<z.ZodString>; | ||
}, "strict", z.ZodTypeAny, { | ||
light?: string | undefined; | ||
dark?: string | undefined; | ||
}, { | ||
light?: string | undefined; | ||
dark?: string | undefined; | ||
}>>; | ||
hidden: z.ZodOptional<z.ZodBoolean>; | ||
openapi: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">]>>; | ||
}, "strip", z.ZodTypeAny, { | ||
anchor: string; | ||
icon?: string | { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
} | undefined; | ||
color?: { | ||
light?: string | undefined; | ||
dark?: string | undefined; | ||
} | undefined; | ||
hidden?: boolean | undefined; | ||
openapi?: string | string[] | undefined; | ||
}, { | ||
anchor: string; | ||
icon?: string | { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
} | undefined; | ||
color?: { | ||
light?: string | undefined; | ||
dark?: string | undefined; | ||
} | undefined; | ||
hidden?: boolean | undefined; | ||
openapi?: string | string[] | undefined; | ||
}>, z.ZodUnion<[z.ZodObject<{ | ||
href: z.ZodString; | ||
}, "strip", z.ZodTypeAny, { | ||
href: string; | ||
}, { | ||
href: string; | ||
}>, z.ZodType<any, z.ZodTypeDef, any>, z.ZodType<any, z.ZodTypeDef, any>, ...z.ZodType<any, z.ZodTypeDef, any>[]]>>, "many">; | ||
export type AnchorsConfig = z.infer<typeof anchorsSchema>; | ||
export type AnchorConfig = z.infer<typeof anchorSchema>; | ||
export type DecoratedAnchorsConfig = z.infer<typeof decoratedAnchorsSchema>; | ||
export type DecoratedAnchorConfig = z.infer<typeof decoratedAnchorSchema>; |
@@ -7,8 +7,3 @@ import { z } from 'zod'; | ||
import { openApiSchema } from '../reusable/openapi.js'; | ||
import { dropdownsSchema } from './dropdown.js'; | ||
import { groupsSchema } from './groups.js'; | ||
import { languagesSchema } from './languages.js'; | ||
import { pagesSchema } from './pages.js'; | ||
import { tabsSchema } from './tabs.js'; | ||
import { versionsSchema } from './version.js'; | ||
import { getDivisionSchemasExcluding, registerDivisionSchema } from './divisionSchemas.js'; | ||
const baseAnchorSchema = z.object({ | ||
@@ -19,14 +14,13 @@ anchor: z.string().nonempty().describe('The name of the anchor'), | ||
hidden: hiddenSchema.optional(), | ||
openapi: openApiSchema.optional(), | ||
}); | ||
export const anchorSchema = baseAnchorSchema.and(z.union([ | ||
z.object({ openapi: openApiSchema }), | ||
z.object({ href: hrefSchema }), | ||
z.lazy(() => z.object({ languages: languagesSchema })), | ||
z.lazy(() => z.object({ versions: versionsSchema })), | ||
z.lazy(() => z.object({ dropdowns: dropdownsSchema })), | ||
z.lazy(() => z.object({ tabs: tabsSchema })), | ||
z.lazy(() => z.object({ groups: groupsSchema })), | ||
z.lazy(() => z.object({ pages: pagesSchema })), | ||
])); | ||
const createAnchorSchema = (type) => baseAnchorSchema.and(z.union([z.object({ href: hrefSchema }), ...getDivisionSchemasExcluding('anchors', type)])); | ||
export const nonRecursiveAnchorSchema = baseAnchorSchema.and(z.object({ href: hrefSchema })); | ||
export const anchorSchema = createAnchorSchema('default'); | ||
export const decoratedAnchorSchema = createAnchorSchema('decorated'); | ||
export const anchorsSchema = z.array(anchorSchema).describe('Organizing by anchors'); | ||
export const decoratedAnchorsSchema = z | ||
.array(decoratedAnchorSchema) | ||
.describe('Organizing by anchors'); | ||
registerDivisionSchema('anchors', anchorsSchema, 'default'); | ||
registerDivisionSchema('anchors', decoratedAnchorsSchema, 'decorated'); |
import { z } from 'zod'; | ||
export declare const dropdownSchema: z.ZodType; | ||
export declare const nonRecursiveDropdownSchema: z.ZodIntersection<z.ZodObject<{ | ||
@@ -16,2 +15,3 @@ dropdown: z.ZodString; | ||
hidden: z.ZodOptional<z.ZodBoolean>; | ||
openapi: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">]>>; | ||
}, "strip", z.ZodTypeAny, { | ||
@@ -24,2 +24,3 @@ dropdown: string; | ||
hidden?: boolean | undefined; | ||
openapi?: string | string[] | undefined; | ||
}, { | ||
@@ -32,2 +33,3 @@ dropdown: string; | ||
hidden?: boolean | undefined; | ||
openapi?: string | string[] | undefined; | ||
}>, z.ZodObject<{ | ||
@@ -40,2 +42,153 @@ href: z.ZodString; | ||
}>>; | ||
export declare const dropdownsSchema: z.ZodArray<z.ZodType<any, z.ZodTypeDef, any>, "many">; | ||
export declare const dropdownSchema: z.ZodIntersection<z.ZodObject<{ | ||
dropdown: z.ZodString; | ||
icon: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodObject<{ | ||
style: z.ZodOptional<z.ZodEnum<["brands", "duotone", "light", "regular", "sharp-duotone-solid", "sharp-light", "sharp-regular", "sharp-solid", "sharp-thin", "solid", "thin"]>>; | ||
name: z.ZodEffects<z.ZodString, string, string>; | ||
}, "strip", z.ZodTypeAny, { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
}, { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
}>]>>; | ||
hidden: z.ZodOptional<z.ZodBoolean>; | ||
openapi: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">]>>; | ||
}, "strip", z.ZodTypeAny, { | ||
dropdown: string; | ||
icon?: string | { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
} | undefined; | ||
hidden?: boolean | undefined; | ||
openapi?: string | string[] | undefined; | ||
}, { | ||
dropdown: string; | ||
icon?: string | { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
} | undefined; | ||
hidden?: boolean | undefined; | ||
openapi?: string | string[] | undefined; | ||
}>, z.ZodUnion<[z.ZodObject<{ | ||
href: z.ZodString; | ||
}, "strip", z.ZodTypeAny, { | ||
href: string; | ||
}, { | ||
href: string; | ||
}>, z.ZodType<any, z.ZodTypeDef, any>, z.ZodType<any, z.ZodTypeDef, any>, ...z.ZodType<any, z.ZodTypeDef, any>[]]>>; | ||
export declare const decoratedDropdownSchema: z.ZodIntersection<z.ZodObject<{ | ||
dropdown: z.ZodString; | ||
icon: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodObject<{ | ||
style: z.ZodOptional<z.ZodEnum<["brands", "duotone", "light", "regular", "sharp-duotone-solid", "sharp-light", "sharp-regular", "sharp-solid", "sharp-thin", "solid", "thin"]>>; | ||
name: z.ZodEffects<z.ZodString, string, string>; | ||
}, "strip", z.ZodTypeAny, { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
}, { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
}>]>>; | ||
hidden: z.ZodOptional<z.ZodBoolean>; | ||
openapi: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">]>>; | ||
}, "strip", z.ZodTypeAny, { | ||
dropdown: string; | ||
icon?: string | { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
} | undefined; | ||
hidden?: boolean | undefined; | ||
openapi?: string | string[] | undefined; | ||
}, { | ||
dropdown: string; | ||
icon?: string | { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
} | undefined; | ||
hidden?: boolean | undefined; | ||
openapi?: string | string[] | undefined; | ||
}>, z.ZodUnion<[z.ZodObject<{ | ||
href: z.ZodString; | ||
}, "strip", z.ZodTypeAny, { | ||
href: string; | ||
}, { | ||
href: string; | ||
}>, z.ZodType<any, z.ZodTypeDef, any>, z.ZodType<any, z.ZodTypeDef, any>, ...z.ZodType<any, z.ZodTypeDef, any>[]]>>; | ||
export declare const dropdownsSchema: z.ZodArray<z.ZodIntersection<z.ZodObject<{ | ||
dropdown: z.ZodString; | ||
icon: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodObject<{ | ||
style: z.ZodOptional<z.ZodEnum<["brands", "duotone", "light", "regular", "sharp-duotone-solid", "sharp-light", "sharp-regular", "sharp-solid", "sharp-thin", "solid", "thin"]>>; | ||
name: z.ZodEffects<z.ZodString, string, string>; | ||
}, "strip", z.ZodTypeAny, { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
}, { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
}>]>>; | ||
hidden: z.ZodOptional<z.ZodBoolean>; | ||
openapi: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">]>>; | ||
}, "strip", z.ZodTypeAny, { | ||
dropdown: string; | ||
icon?: string | { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
} | undefined; | ||
hidden?: boolean | undefined; | ||
openapi?: string | string[] | undefined; | ||
}, { | ||
dropdown: string; | ||
icon?: string | { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
} | undefined; | ||
hidden?: boolean | undefined; | ||
openapi?: string | string[] | undefined; | ||
}>, z.ZodUnion<[z.ZodObject<{ | ||
href: z.ZodString; | ||
}, "strip", z.ZodTypeAny, { | ||
href: string; | ||
}, { | ||
href: string; | ||
}>, z.ZodType<any, z.ZodTypeDef, any>, z.ZodType<any, z.ZodTypeDef, any>, ...z.ZodType<any, z.ZodTypeDef, any>[]]>>, "many">; | ||
export declare const decoratedDropdownsSchema: z.ZodArray<z.ZodIntersection<z.ZodObject<{ | ||
dropdown: z.ZodString; | ||
icon: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodObject<{ | ||
style: z.ZodOptional<z.ZodEnum<["brands", "duotone", "light", "regular", "sharp-duotone-solid", "sharp-light", "sharp-regular", "sharp-solid", "sharp-thin", "solid", "thin"]>>; | ||
name: z.ZodEffects<z.ZodString, string, string>; | ||
}, "strip", z.ZodTypeAny, { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
}, { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
}>]>>; | ||
hidden: z.ZodOptional<z.ZodBoolean>; | ||
openapi: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">]>>; | ||
}, "strip", z.ZodTypeAny, { | ||
dropdown: string; | ||
icon?: string | { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
} | undefined; | ||
hidden?: boolean | undefined; | ||
openapi?: string | string[] | undefined; | ||
}, { | ||
dropdown: string; | ||
icon?: string | { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
} | undefined; | ||
hidden?: boolean | undefined; | ||
openapi?: string | string[] | undefined; | ||
}>, z.ZodUnion<[z.ZodObject<{ | ||
href: z.ZodString; | ||
}, "strip", z.ZodTypeAny, { | ||
href: string; | ||
}, { | ||
href: string; | ||
}>, z.ZodType<any, z.ZodTypeDef, any>, z.ZodType<any, z.ZodTypeDef, any>, ...z.ZodType<any, z.ZodTypeDef, any>[]]>>, "many">; | ||
export type DropdownsConfig = z.infer<typeof dropdownsSchema>; | ||
export type DropdownConfig = z.infer<typeof dropdownSchema>; | ||
export type DecoratedDropdownsConfig = z.infer<typeof decoratedDropdownsSchema>; | ||
export type DecoratedDropdownConfig = z.infer<typeof decoratedDropdownSchema>; |
@@ -6,8 +6,3 @@ import { z } from 'zod'; | ||
import { openApiSchema } from '../reusable/openapi.js'; | ||
import { anchorsSchema } from './anchors.js'; | ||
import { groupsSchema } from './groups.js'; | ||
import { languagesSchema } from './languages.js'; | ||
import { pagesSchema } from './pages.js'; | ||
import { tabsSchema } from './tabs.js'; | ||
import { versionsSchema } from './version.js'; | ||
import { getDivisionSchemasExcluding, registerDivisionSchema } from './divisionSchemas.js'; | ||
const baseDropdownSchema = z.object({ | ||
@@ -17,14 +12,13 @@ dropdown: z.string().nonempty().describe('The name of the dropdown'), | ||
hidden: hiddenSchema.optional(), | ||
openapi: openApiSchema.optional(), | ||
}); | ||
export const dropdownSchema = baseDropdownSchema.and(z.union([ | ||
z.object({ openapi: openApiSchema }), | ||
z.object({ href: hrefSchema }), | ||
z.lazy(() => z.object({ languages: languagesSchema })), | ||
z.lazy(() => z.object({ versions: versionsSchema })), | ||
z.lazy(() => z.object({ tabs: tabsSchema })), | ||
z.lazy(() => z.object({ anchors: anchorsSchema })), | ||
z.lazy(() => z.object({ groups: groupsSchema })), | ||
z.lazy(() => z.object({ pages: pagesSchema })), | ||
])); | ||
const createDropdownSchema = (type) => baseDropdownSchema.and(z.union([z.object({ href: hrefSchema }), ...getDivisionSchemasExcluding('dropdowns', type)])); | ||
export const nonRecursiveDropdownSchema = baseDropdownSchema.and(z.object({ href: hrefSchema })); | ||
export const dropdownSchema = createDropdownSchema('default'); | ||
export const decoratedDropdownSchema = createDropdownSchema('decorated'); | ||
export const dropdownsSchema = z.array(dropdownSchema).describe('Organizing by dropdowns'); | ||
export const decoratedDropdownsSchema = z | ||
.array(decoratedDropdownSchema) | ||
.describe('Organizing by dropdowns'); | ||
registerDivisionSchema('dropdowns', dropdownsSchema, 'default'); | ||
registerDivisionSchema('dropdowns', decoratedDropdownsSchema, 'decorated'); |
@@ -6,8 +6,11 @@ import { z } from 'zod'; | ||
hidden: z.ZodOptional<z.ZodBoolean>; | ||
openapi: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">]>>; | ||
}, "strip", z.ZodTypeAny, { | ||
language: "en" | "cn" | "es" | "fr" | "jp" | "pt" | "pt-BR" | "de"; | ||
hidden?: boolean | undefined; | ||
openapi?: string | string[] | undefined; | ||
}, { | ||
language: "en" | "cn" | "es" | "fr" | "jp" | "pt" | "pt-BR" | "de"; | ||
hidden?: boolean | undefined; | ||
openapi?: string | string[] | undefined; | ||
}>, z.ZodObject<{ | ||
@@ -23,8 +26,11 @@ href: z.ZodString; | ||
hidden: z.ZodOptional<z.ZodBoolean>; | ||
openapi: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">]>>; | ||
}, "strip", z.ZodTypeAny, { | ||
version: string; | ||
hidden?: boolean | undefined; | ||
openapi?: string | string[] | undefined; | ||
}, { | ||
version: string; | ||
hidden?: boolean | undefined; | ||
openapi?: string | string[] | undefined; | ||
}>, z.ZodObject<{ | ||
@@ -50,2 +56,3 @@ href: z.ZodString; | ||
hidden: z.ZodOptional<z.ZodBoolean>; | ||
openapi: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">]>>; | ||
}, "strip", z.ZodTypeAny, { | ||
@@ -58,2 +65,3 @@ tab: string; | ||
hidden?: boolean | undefined; | ||
openapi?: string | string[] | undefined; | ||
}, { | ||
@@ -66,2 +74,3 @@ tab: string; | ||
hidden?: boolean | undefined; | ||
openapi?: string | string[] | undefined; | ||
}>, z.ZodObject<{ | ||
@@ -87,2 +96,3 @@ href: z.ZodString; | ||
hidden: z.ZodOptional<z.ZodBoolean>; | ||
openapi: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">]>>; | ||
}, "strip", z.ZodTypeAny, { | ||
@@ -95,2 +105,3 @@ dropdown: string; | ||
hidden?: boolean | undefined; | ||
openapi?: string | string[] | undefined; | ||
}, { | ||
@@ -103,2 +114,3 @@ dropdown: string; | ||
hidden?: boolean | undefined; | ||
openapi?: string | string[] | undefined; | ||
}>, z.ZodObject<{ | ||
@@ -134,2 +146,3 @@ href: z.ZodString; | ||
hidden: z.ZodOptional<z.ZodBoolean>; | ||
openapi: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">]>>; | ||
}, "strip", z.ZodTypeAny, { | ||
@@ -146,2 +159,3 @@ anchor: string; | ||
hidden?: boolean | undefined; | ||
openapi?: string | string[] | undefined; | ||
}, { | ||
@@ -158,2 +172,3 @@ anchor: string; | ||
hidden?: boolean | undefined; | ||
openapi?: string | string[] | undefined; | ||
}>, z.ZodObject<{ | ||
@@ -170,2 +185,3 @@ href: z.ZodString; | ||
hidden?: boolean | undefined; | ||
openapi?: string | string[] | undefined; | ||
} & { | ||
@@ -177,2 +193,3 @@ href: string; | ||
hidden?: boolean | undefined; | ||
openapi?: string | string[] | undefined; | ||
} & { | ||
@@ -188,2 +205,3 @@ href: string; | ||
hidden?: boolean | undefined; | ||
openapi?: string | string[] | undefined; | ||
} & { | ||
@@ -199,2 +217,3 @@ href: string; | ||
hidden?: boolean | undefined; | ||
openapi?: string | string[] | undefined; | ||
} & { | ||
@@ -214,2 +233,3 @@ href: string; | ||
hidden?: boolean | undefined; | ||
openapi?: string | string[] | undefined; | ||
} & { | ||
@@ -222,2 +242,3 @@ href: string; | ||
hidden?: boolean | undefined; | ||
openapi?: string | string[] | undefined; | ||
} & { | ||
@@ -229,2 +250,3 @@ href: string; | ||
hidden?: boolean | undefined; | ||
openapi?: string | string[] | undefined; | ||
} & { | ||
@@ -240,2 +262,3 @@ href: string; | ||
hidden?: boolean | undefined; | ||
openapi?: string | string[] | undefined; | ||
} & { | ||
@@ -251,2 +274,3 @@ href: string; | ||
hidden?: boolean | undefined; | ||
openapi?: string | string[] | undefined; | ||
} & { | ||
@@ -266,2 +290,3 @@ href: string; | ||
hidden?: boolean | undefined; | ||
openapi?: string | string[] | undefined; | ||
} & { | ||
@@ -268,0 +293,0 @@ href: string; |
@@ -15,3 +15,87 @@ import { z } from 'zod'; | ||
hidden: z.ZodOptional<z.ZodBoolean>; | ||
root: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>; | ||
root: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>> | z.ZodOptional<z.ZodObject<{ | ||
href: z.ZodString; | ||
title: z.ZodString; | ||
sidebarTitle: z.ZodOptional<z.ZodString>; | ||
description: z.ZodOptional<z.ZodString>; | ||
api: z.ZodOptional<z.ZodString>; | ||
openapi: z.ZodOptional<z.ZodString>; | ||
contentType: z.ZodOptional<z.ZodString>; | ||
authMethod: z.ZodOptional<z.ZodString>; | ||
auth: z.ZodOptional<z.ZodString>; | ||
version: z.ZodOptional<z.ZodString>; | ||
mode: z.ZodOptional<z.ZodString>; | ||
hideFooterPagination: z.ZodOptional<z.ZodBoolean>; | ||
authors: z.ZodOptional<z.ZodUnknown>; | ||
lastUpdatedDate: z.ZodOptional<z.ZodString>; | ||
createdDate: z.ZodOptional<z.ZodString>; | ||
'openapi-schema': z.ZodOptional<z.ZodString>; | ||
icon: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodObject<{ | ||
style: z.ZodOptional<z.ZodEnum<["brands", "duotone", "light", "regular", "sharp-duotone-solid", "sharp-light", "sharp-regular", "sharp-solid", "sharp-thin", "solid", "thin"]>>; | ||
name: z.ZodEffects<z.ZodString, string, string>; | ||
}, "strip", z.ZodTypeAny, { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
}, { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
}>]>>; | ||
tag: z.ZodOptional<z.ZodString>; | ||
url: z.ZodOptional<z.ZodString>; | ||
hideApiMarker: z.ZodOptional<z.ZodBoolean>; | ||
noindex: z.ZodOptional<z.ZodBoolean>; | ||
isPublic: z.ZodOptional<z.ZodBoolean>; | ||
}, "strip", z.ZodTypeAny, { | ||
href: string; | ||
title: string; | ||
sidebarTitle?: string | undefined; | ||
description?: string | undefined; | ||
api?: string | undefined; | ||
openapi?: string | undefined; | ||
contentType?: string | undefined; | ||
authMethod?: string | undefined; | ||
auth?: string | undefined; | ||
version?: string | undefined; | ||
mode?: string | undefined; | ||
hideFooterPagination?: boolean | undefined; | ||
authors?: unknown; | ||
lastUpdatedDate?: string | undefined; | ||
createdDate?: string | undefined; | ||
'openapi-schema'?: string | undefined; | ||
icon?: string | { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
} | undefined; | ||
tag?: string | undefined; | ||
url?: string | undefined; | ||
hideApiMarker?: boolean | undefined; | ||
noindex?: boolean | undefined; | ||
isPublic?: boolean | undefined; | ||
}, { | ||
href: string; | ||
title: string; | ||
sidebarTitle?: string | undefined; | ||
description?: string | undefined; | ||
api?: string | undefined; | ||
openapi?: string | undefined; | ||
contentType?: string | undefined; | ||
authMethod?: string | undefined; | ||
auth?: string | undefined; | ||
version?: string | undefined; | ||
mode?: string | undefined; | ||
hideFooterPagination?: boolean | undefined; | ||
authors?: unknown; | ||
lastUpdatedDate?: string | undefined; | ||
createdDate?: string | undefined; | ||
'openapi-schema'?: string | undefined; | ||
icon?: string | { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
} | undefined; | ||
tag?: string | undefined; | ||
url?: string | undefined; | ||
hideApiMarker?: boolean | undefined; | ||
noindex?: boolean | undefined; | ||
isPublic?: boolean | undefined; | ||
}>>; | ||
}, "strip", z.ZodTypeAny, { | ||
@@ -24,3 +108,29 @@ group: string; | ||
hidden?: boolean | undefined; | ||
root?: string | undefined; | ||
root?: string | { | ||
href: string; | ||
title: string; | ||
sidebarTitle?: string | undefined; | ||
description?: string | undefined; | ||
api?: string | undefined; | ||
openapi?: string | undefined; | ||
contentType?: string | undefined; | ||
authMethod?: string | undefined; | ||
auth?: string | undefined; | ||
version?: string | undefined; | ||
mode?: string | undefined; | ||
hideFooterPagination?: boolean | undefined; | ||
authors?: unknown; | ||
lastUpdatedDate?: string | undefined; | ||
createdDate?: string | undefined; | ||
'openapi-schema'?: string | undefined; | ||
icon?: string | { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
} | undefined; | ||
tag?: string | undefined; | ||
url?: string | undefined; | ||
hideApiMarker?: boolean | undefined; | ||
noindex?: boolean | undefined; | ||
isPublic?: boolean | undefined; | ||
} | undefined; | ||
}, { | ||
@@ -33,3 +143,29 @@ group: string; | ||
hidden?: boolean | undefined; | ||
root?: string | undefined; | ||
root?: string | { | ||
href: string; | ||
title: string; | ||
sidebarTitle?: string | undefined; | ||
description?: string | undefined; | ||
api?: string | undefined; | ||
openapi?: string | undefined; | ||
contentType?: string | undefined; | ||
authMethod?: string | undefined; | ||
auth?: string | undefined; | ||
version?: string | undefined; | ||
mode?: string | undefined; | ||
hideFooterPagination?: boolean | undefined; | ||
authors?: unknown; | ||
lastUpdatedDate?: string | undefined; | ||
createdDate?: string | undefined; | ||
'openapi-schema'?: string | undefined; | ||
icon?: string | { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
} | undefined; | ||
tag?: string | undefined; | ||
url?: string | undefined; | ||
hideApiMarker?: boolean | undefined; | ||
noindex?: boolean | undefined; | ||
isPublic?: boolean | undefined; | ||
} | undefined; | ||
}>, z.ZodUnion<[z.ZodObject<{ | ||
@@ -48,2 +184,181 @@ openapi: z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">]>; | ||
}>>]>>; | ||
export declare const decoratedGroupSchema: z.ZodIntersection<z.ZodObject<{ | ||
group: z.ZodString; | ||
icon: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodObject<{ | ||
style: z.ZodOptional<z.ZodEnum<["brands", "duotone", "light", "regular", "sharp-duotone-solid", "sharp-light", "sharp-regular", "sharp-solid", "sharp-thin", "solid", "thin"]>>; | ||
name: z.ZodEffects<z.ZodString, string, string>; | ||
}, "strip", z.ZodTypeAny, { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
}, { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
}>]>>; | ||
hidden: z.ZodOptional<z.ZodBoolean>; | ||
root: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>> | z.ZodOptional<z.ZodObject<{ | ||
href: z.ZodString; | ||
title: z.ZodString; | ||
sidebarTitle: z.ZodOptional<z.ZodString>; | ||
description: z.ZodOptional<z.ZodString>; | ||
api: z.ZodOptional<z.ZodString>; | ||
openapi: z.ZodOptional<z.ZodString>; | ||
contentType: z.ZodOptional<z.ZodString>; | ||
authMethod: z.ZodOptional<z.ZodString>; | ||
auth: z.ZodOptional<z.ZodString>; | ||
version: z.ZodOptional<z.ZodString>; | ||
mode: z.ZodOptional<z.ZodString>; | ||
hideFooterPagination: z.ZodOptional<z.ZodBoolean>; | ||
authors: z.ZodOptional<z.ZodUnknown>; | ||
lastUpdatedDate: z.ZodOptional<z.ZodString>; | ||
createdDate: z.ZodOptional<z.ZodString>; | ||
'openapi-schema': z.ZodOptional<z.ZodString>; | ||
icon: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodObject<{ | ||
style: z.ZodOptional<z.ZodEnum<["brands", "duotone", "light", "regular", "sharp-duotone-solid", "sharp-light", "sharp-regular", "sharp-solid", "sharp-thin", "solid", "thin"]>>; | ||
name: z.ZodEffects<z.ZodString, string, string>; | ||
}, "strip", z.ZodTypeAny, { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
}, { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
}>]>>; | ||
tag: z.ZodOptional<z.ZodString>; | ||
url: z.ZodOptional<z.ZodString>; | ||
hideApiMarker: z.ZodOptional<z.ZodBoolean>; | ||
noindex: z.ZodOptional<z.ZodBoolean>; | ||
isPublic: z.ZodOptional<z.ZodBoolean>; | ||
}, "strip", z.ZodTypeAny, { | ||
href: string; | ||
title: string; | ||
sidebarTitle?: string | undefined; | ||
description?: string | undefined; | ||
api?: string | undefined; | ||
openapi?: string | undefined; | ||
contentType?: string | undefined; | ||
authMethod?: string | undefined; | ||
auth?: string | undefined; | ||
version?: string | undefined; | ||
mode?: string | undefined; | ||
hideFooterPagination?: boolean | undefined; | ||
authors?: unknown; | ||
lastUpdatedDate?: string | undefined; | ||
createdDate?: string | undefined; | ||
'openapi-schema'?: string | undefined; | ||
icon?: string | { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
} | undefined; | ||
tag?: string | undefined; | ||
url?: string | undefined; | ||
hideApiMarker?: boolean | undefined; | ||
noindex?: boolean | undefined; | ||
isPublic?: boolean | undefined; | ||
}, { | ||
href: string; | ||
title: string; | ||
sidebarTitle?: string | undefined; | ||
description?: string | undefined; | ||
api?: string | undefined; | ||
openapi?: string | undefined; | ||
contentType?: string | undefined; | ||
authMethod?: string | undefined; | ||
auth?: string | undefined; | ||
version?: string | undefined; | ||
mode?: string | undefined; | ||
hideFooterPagination?: boolean | undefined; | ||
authors?: unknown; | ||
lastUpdatedDate?: string | undefined; | ||
createdDate?: string | undefined; | ||
'openapi-schema'?: string | undefined; | ||
icon?: string | { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
} | undefined; | ||
tag?: string | undefined; | ||
url?: string | undefined; | ||
hideApiMarker?: boolean | undefined; | ||
noindex?: boolean | undefined; | ||
isPublic?: boolean | undefined; | ||
}>>; | ||
}, "strip", z.ZodTypeAny, { | ||
group: string; | ||
icon?: string | { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
} | undefined; | ||
hidden?: boolean | undefined; | ||
root?: string | { | ||
href: string; | ||
title: string; | ||
sidebarTitle?: string | undefined; | ||
description?: string | undefined; | ||
api?: string | undefined; | ||
openapi?: string | undefined; | ||
contentType?: string | undefined; | ||
authMethod?: string | undefined; | ||
auth?: string | undefined; | ||
version?: string | undefined; | ||
mode?: string | undefined; | ||
hideFooterPagination?: boolean | undefined; | ||
authors?: unknown; | ||
lastUpdatedDate?: string | undefined; | ||
createdDate?: string | undefined; | ||
'openapi-schema'?: string | undefined; | ||
icon?: string | { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
} | undefined; | ||
tag?: string | undefined; | ||
url?: string | undefined; | ||
hideApiMarker?: boolean | undefined; | ||
noindex?: boolean | undefined; | ||
isPublic?: boolean | undefined; | ||
} | undefined; | ||
}, { | ||
group: string; | ||
icon?: string | { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
} | undefined; | ||
hidden?: boolean | undefined; | ||
root?: string | { | ||
href: string; | ||
title: string; | ||
sidebarTitle?: string | undefined; | ||
description?: string | undefined; | ||
api?: string | undefined; | ||
openapi?: string | undefined; | ||
contentType?: string | undefined; | ||
authMethod?: string | undefined; | ||
auth?: string | undefined; | ||
version?: string | undefined; | ||
mode?: string | undefined; | ||
hideFooterPagination?: boolean | undefined; | ||
authors?: unknown; | ||
lastUpdatedDate?: string | undefined; | ||
createdDate?: string | undefined; | ||
'openapi-schema'?: string | undefined; | ||
icon?: string | { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
} | undefined; | ||
tag?: string | undefined; | ||
url?: string | undefined; | ||
hideApiMarker?: boolean | undefined; | ||
noindex?: boolean | undefined; | ||
isPublic?: boolean | undefined; | ||
} | undefined; | ||
}>, z.ZodUnion<[z.ZodObject<{ | ||
openapi: z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">]>; | ||
}, "strip", z.ZodTypeAny, { | ||
openapi: (string | string[]) & (string | string[] | undefined); | ||
}, { | ||
openapi: (string | string[]) & (string | string[] | undefined); | ||
}>, z.ZodLazy<z.ZodObject<{ | ||
pages: z.ZodArray<z.ZodType<any, z.ZodTypeDef, any>, "many">; | ||
}, "strip", z.ZodTypeAny, { | ||
pages: any[]; | ||
}, { | ||
pages: any[]; | ||
}>>]>>; | ||
export declare const groupsSchema: z.ZodArray<z.ZodIntersection<z.ZodObject<{ | ||
@@ -62,3 +377,87 @@ group: z.ZodString; | ||
hidden: z.ZodOptional<z.ZodBoolean>; | ||
root: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>; | ||
root: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>> | z.ZodOptional<z.ZodObject<{ | ||
href: z.ZodString; | ||
title: z.ZodString; | ||
sidebarTitle: z.ZodOptional<z.ZodString>; | ||
description: z.ZodOptional<z.ZodString>; | ||
api: z.ZodOptional<z.ZodString>; | ||
openapi: z.ZodOptional<z.ZodString>; | ||
contentType: z.ZodOptional<z.ZodString>; | ||
authMethod: z.ZodOptional<z.ZodString>; | ||
auth: z.ZodOptional<z.ZodString>; | ||
version: z.ZodOptional<z.ZodString>; | ||
mode: z.ZodOptional<z.ZodString>; | ||
hideFooterPagination: z.ZodOptional<z.ZodBoolean>; | ||
authors: z.ZodOptional<z.ZodUnknown>; | ||
lastUpdatedDate: z.ZodOptional<z.ZodString>; | ||
createdDate: z.ZodOptional<z.ZodString>; | ||
'openapi-schema': z.ZodOptional<z.ZodString>; | ||
icon: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodObject<{ | ||
style: z.ZodOptional<z.ZodEnum<["brands", "duotone", "light", "regular", "sharp-duotone-solid", "sharp-light", "sharp-regular", "sharp-solid", "sharp-thin", "solid", "thin"]>>; | ||
name: z.ZodEffects<z.ZodString, string, string>; | ||
}, "strip", z.ZodTypeAny, { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
}, { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
}>]>>; | ||
tag: z.ZodOptional<z.ZodString>; | ||
url: z.ZodOptional<z.ZodString>; | ||
hideApiMarker: z.ZodOptional<z.ZodBoolean>; | ||
noindex: z.ZodOptional<z.ZodBoolean>; | ||
isPublic: z.ZodOptional<z.ZodBoolean>; | ||
}, "strip", z.ZodTypeAny, { | ||
href: string; | ||
title: string; | ||
sidebarTitle?: string | undefined; | ||
description?: string | undefined; | ||
api?: string | undefined; | ||
openapi?: string | undefined; | ||
contentType?: string | undefined; | ||
authMethod?: string | undefined; | ||
auth?: string | undefined; | ||
version?: string | undefined; | ||
mode?: string | undefined; | ||
hideFooterPagination?: boolean | undefined; | ||
authors?: unknown; | ||
lastUpdatedDate?: string | undefined; | ||
createdDate?: string | undefined; | ||
'openapi-schema'?: string | undefined; | ||
icon?: string | { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
} | undefined; | ||
tag?: string | undefined; | ||
url?: string | undefined; | ||
hideApiMarker?: boolean | undefined; | ||
noindex?: boolean | undefined; | ||
isPublic?: boolean | undefined; | ||
}, { | ||
href: string; | ||
title: string; | ||
sidebarTitle?: string | undefined; | ||
description?: string | undefined; | ||
api?: string | undefined; | ||
openapi?: string | undefined; | ||
contentType?: string | undefined; | ||
authMethod?: string | undefined; | ||
auth?: string | undefined; | ||
version?: string | undefined; | ||
mode?: string | undefined; | ||
hideFooterPagination?: boolean | undefined; | ||
authors?: unknown; | ||
lastUpdatedDate?: string | undefined; | ||
createdDate?: string | undefined; | ||
'openapi-schema'?: string | undefined; | ||
icon?: string | { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
} | undefined; | ||
tag?: string | undefined; | ||
url?: string | undefined; | ||
hideApiMarker?: boolean | undefined; | ||
noindex?: boolean | undefined; | ||
isPublic?: boolean | undefined; | ||
}>>; | ||
}, "strip", z.ZodTypeAny, { | ||
@@ -71,3 +470,29 @@ group: string; | ||
hidden?: boolean | undefined; | ||
root?: string | undefined; | ||
root?: string | { | ||
href: string; | ||
title: string; | ||
sidebarTitle?: string | undefined; | ||
description?: string | undefined; | ||
api?: string | undefined; | ||
openapi?: string | undefined; | ||
contentType?: string | undefined; | ||
authMethod?: string | undefined; | ||
auth?: string | undefined; | ||
version?: string | undefined; | ||
mode?: string | undefined; | ||
hideFooterPagination?: boolean | undefined; | ||
authors?: unknown; | ||
lastUpdatedDate?: string | undefined; | ||
createdDate?: string | undefined; | ||
'openapi-schema'?: string | undefined; | ||
icon?: string | { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
} | undefined; | ||
tag?: string | undefined; | ||
url?: string | undefined; | ||
hideApiMarker?: boolean | undefined; | ||
noindex?: boolean | undefined; | ||
isPublic?: boolean | undefined; | ||
} | undefined; | ||
}, { | ||
@@ -80,3 +505,29 @@ group: string; | ||
hidden?: boolean | undefined; | ||
root?: string | undefined; | ||
root?: string | { | ||
href: string; | ||
title: string; | ||
sidebarTitle?: string | undefined; | ||
description?: string | undefined; | ||
api?: string | undefined; | ||
openapi?: string | undefined; | ||
contentType?: string | undefined; | ||
authMethod?: string | undefined; | ||
auth?: string | undefined; | ||
version?: string | undefined; | ||
mode?: string | undefined; | ||
hideFooterPagination?: boolean | undefined; | ||
authors?: unknown; | ||
lastUpdatedDate?: string | undefined; | ||
createdDate?: string | undefined; | ||
'openapi-schema'?: string | undefined; | ||
icon?: string | { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
} | undefined; | ||
tag?: string | undefined; | ||
url?: string | undefined; | ||
hideApiMarker?: boolean | undefined; | ||
noindex?: boolean | undefined; | ||
isPublic?: boolean | undefined; | ||
} | undefined; | ||
}>, z.ZodUnion<[z.ZodObject<{ | ||
@@ -95,3 +546,184 @@ openapi: z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">]>; | ||
}>>]>>, "many">; | ||
export declare const decoratedGroupsSchema: z.ZodArray<z.ZodIntersection<z.ZodObject<{ | ||
group: z.ZodString; | ||
icon: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodObject<{ | ||
style: z.ZodOptional<z.ZodEnum<["brands", "duotone", "light", "regular", "sharp-duotone-solid", "sharp-light", "sharp-regular", "sharp-solid", "sharp-thin", "solid", "thin"]>>; | ||
name: z.ZodEffects<z.ZodString, string, string>; | ||
}, "strip", z.ZodTypeAny, { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
}, { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
}>]>>; | ||
hidden: z.ZodOptional<z.ZodBoolean>; | ||
root: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>> | z.ZodOptional<z.ZodObject<{ | ||
href: z.ZodString; | ||
title: z.ZodString; | ||
sidebarTitle: z.ZodOptional<z.ZodString>; | ||
description: z.ZodOptional<z.ZodString>; | ||
api: z.ZodOptional<z.ZodString>; | ||
openapi: z.ZodOptional<z.ZodString>; | ||
contentType: z.ZodOptional<z.ZodString>; | ||
authMethod: z.ZodOptional<z.ZodString>; | ||
auth: z.ZodOptional<z.ZodString>; | ||
version: z.ZodOptional<z.ZodString>; | ||
mode: z.ZodOptional<z.ZodString>; | ||
hideFooterPagination: z.ZodOptional<z.ZodBoolean>; | ||
authors: z.ZodOptional<z.ZodUnknown>; | ||
lastUpdatedDate: z.ZodOptional<z.ZodString>; | ||
createdDate: z.ZodOptional<z.ZodString>; | ||
'openapi-schema': z.ZodOptional<z.ZodString>; | ||
icon: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodObject<{ | ||
style: z.ZodOptional<z.ZodEnum<["brands", "duotone", "light", "regular", "sharp-duotone-solid", "sharp-light", "sharp-regular", "sharp-solid", "sharp-thin", "solid", "thin"]>>; | ||
name: z.ZodEffects<z.ZodString, string, string>; | ||
}, "strip", z.ZodTypeAny, { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
}, { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
}>]>>; | ||
tag: z.ZodOptional<z.ZodString>; | ||
url: z.ZodOptional<z.ZodString>; | ||
hideApiMarker: z.ZodOptional<z.ZodBoolean>; | ||
noindex: z.ZodOptional<z.ZodBoolean>; | ||
isPublic: z.ZodOptional<z.ZodBoolean>; | ||
}, "strip", z.ZodTypeAny, { | ||
href: string; | ||
title: string; | ||
sidebarTitle?: string | undefined; | ||
description?: string | undefined; | ||
api?: string | undefined; | ||
openapi?: string | undefined; | ||
contentType?: string | undefined; | ||
authMethod?: string | undefined; | ||
auth?: string | undefined; | ||
version?: string | undefined; | ||
mode?: string | undefined; | ||
hideFooterPagination?: boolean | undefined; | ||
authors?: unknown; | ||
lastUpdatedDate?: string | undefined; | ||
createdDate?: string | undefined; | ||
'openapi-schema'?: string | undefined; | ||
icon?: string | { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
} | undefined; | ||
tag?: string | undefined; | ||
url?: string | undefined; | ||
hideApiMarker?: boolean | undefined; | ||
noindex?: boolean | undefined; | ||
isPublic?: boolean | undefined; | ||
}, { | ||
href: string; | ||
title: string; | ||
sidebarTitle?: string | undefined; | ||
description?: string | undefined; | ||
api?: string | undefined; | ||
openapi?: string | undefined; | ||
contentType?: string | undefined; | ||
authMethod?: string | undefined; | ||
auth?: string | undefined; | ||
version?: string | undefined; | ||
mode?: string | undefined; | ||
hideFooterPagination?: boolean | undefined; | ||
authors?: unknown; | ||
lastUpdatedDate?: string | undefined; | ||
createdDate?: string | undefined; | ||
'openapi-schema'?: string | undefined; | ||
icon?: string | { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
} | undefined; | ||
tag?: string | undefined; | ||
url?: string | undefined; | ||
hideApiMarker?: boolean | undefined; | ||
noindex?: boolean | undefined; | ||
isPublic?: boolean | undefined; | ||
}>>; | ||
}, "strip", z.ZodTypeAny, { | ||
group: string; | ||
icon?: string | { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
} | undefined; | ||
hidden?: boolean | undefined; | ||
root?: string | { | ||
href: string; | ||
title: string; | ||
sidebarTitle?: string | undefined; | ||
description?: string | undefined; | ||
api?: string | undefined; | ||
openapi?: string | undefined; | ||
contentType?: string | undefined; | ||
authMethod?: string | undefined; | ||
auth?: string | undefined; | ||
version?: string | undefined; | ||
mode?: string | undefined; | ||
hideFooterPagination?: boolean | undefined; | ||
authors?: unknown; | ||
lastUpdatedDate?: string | undefined; | ||
createdDate?: string | undefined; | ||
'openapi-schema'?: string | undefined; | ||
icon?: string | { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
} | undefined; | ||
tag?: string | undefined; | ||
url?: string | undefined; | ||
hideApiMarker?: boolean | undefined; | ||
noindex?: boolean | undefined; | ||
isPublic?: boolean | undefined; | ||
} | undefined; | ||
}, { | ||
group: string; | ||
icon?: string | { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
} | undefined; | ||
hidden?: boolean | undefined; | ||
root?: string | { | ||
href: string; | ||
title: string; | ||
sidebarTitle?: string | undefined; | ||
description?: string | undefined; | ||
api?: string | undefined; | ||
openapi?: string | undefined; | ||
contentType?: string | undefined; | ||
authMethod?: string | undefined; | ||
auth?: string | undefined; | ||
version?: string | undefined; | ||
mode?: string | undefined; | ||
hideFooterPagination?: boolean | undefined; | ||
authors?: unknown; | ||
lastUpdatedDate?: string | undefined; | ||
createdDate?: string | undefined; | ||
'openapi-schema'?: string | undefined; | ||
icon?: string | { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
} | undefined; | ||
tag?: string | undefined; | ||
url?: string | undefined; | ||
hideApiMarker?: boolean | undefined; | ||
noindex?: boolean | undefined; | ||
isPublic?: boolean | undefined; | ||
} | undefined; | ||
}>, z.ZodUnion<[z.ZodObject<{ | ||
openapi: z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">]>; | ||
}, "strip", z.ZodTypeAny, { | ||
openapi: (string | string[]) & (string | string[] | undefined); | ||
}, { | ||
openapi: (string | string[]) & (string | string[] | undefined); | ||
}>, z.ZodLazy<z.ZodObject<{ | ||
pages: z.ZodArray<z.ZodType<any, z.ZodTypeDef, any>, "many">; | ||
}, "strip", z.ZodTypeAny, { | ||
pages: any[]; | ||
}, { | ||
pages: any[]; | ||
}>>]>>, "many">; | ||
export type GroupConfig = z.infer<typeof groupSchema>; | ||
export type GroupsConfig = z.infer<typeof groupsSchema>; | ||
export type DecoratedGroupConfig = z.infer<typeof decoratedGroupSchema>; | ||
export type DecoratedGroupsConfig = z.infer<typeof decoratedGroupsSchema>; |
@@ -5,13 +5,21 @@ import { z } from 'zod'; | ||
import { openApiSchema } from '../reusable/openapi.js'; | ||
import { pageSchema } from '../reusable/page.js'; | ||
import { pagesSchema } from './pages.js'; | ||
export const groupSchema = z | ||
.object({ | ||
import { pageSchema, decoratedPageSchema } from '../reusable/page.js'; | ||
import { decoratedPagesSchema, pagesSchema } from './pages.js'; | ||
const baseGroupSchema = (type) => z.object({ | ||
group: z.string().nonempty().describe('The name of the group'), | ||
icon: iconSchema.optional(), | ||
hidden: hiddenSchema.optional(), | ||
root: pageSchema.optional(), | ||
}) | ||
.and(z.union([z.object({ openapi: openApiSchema }), z.lazy(() => z.object({ pages: pagesSchema }))])) | ||
root: type === 'decorated' ? decoratedPageSchema.optional() : pageSchema.optional(), | ||
}); | ||
const createGroupSchema = (type) => baseGroupSchema(type) | ||
.and(z.union([ | ||
z.object({ openapi: openApiSchema }), | ||
z.lazy(() => z.object({ | ||
pages: type === 'decorated' ? decoratedPagesSchema : pagesSchema, | ||
})), | ||
])) | ||
.describe('Organizing by groups'); | ||
export const groupSchema = createGroupSchema('default'); | ||
export const decoratedGroupSchema = createGroupSchema('decorated'); | ||
export const groupsSchema = z.array(groupSchema); | ||
export const decoratedGroupsSchema = z.array(decoratedGroupSchema); |
import { z } from 'zod'; | ||
import { anchorsSchema } from './anchors.js'; | ||
import { dropdownsSchema } from './dropdown.js'; | ||
import { anchorsSchema, decoratedAnchorsSchema } from './anchors.js'; | ||
import { decoratedDropdownsSchema, dropdownsSchema } from './dropdown.js'; | ||
import { globalSchema } from './global.js'; | ||
import { groupsSchema } from './groups.js'; | ||
import { languagesSchema } from './languages.js'; | ||
import { pagesSchema } from './pages.js'; | ||
import { tabsSchema } from './tabs.js'; | ||
import { versionsSchema } from './version.js'; | ||
export const navigationSchema = z | ||
.union([ | ||
z.object({ languages: languagesSchema }), | ||
z.object({ versions: versionsSchema }), | ||
z.object({ tabs: tabsSchema }), | ||
z.object({ dropdowns: dropdownsSchema }), | ||
z.object({ anchors: anchorsSchema }), | ||
z.object({ groups: groupsSchema }), | ||
z.object({ pages: pagesSchema }), | ||
]) | ||
.and(z.object({ global: globalSchema.optional() })) | ||
import { decoratedGroupsSchema, groupsSchema } from './groups.js'; | ||
import { decoratedLanguagesSchema, languagesSchema } from './languages.js'; | ||
import { decoratedPagesSchema, pagesSchema } from './pages.js'; | ||
import { decoratedTabsSchema, tabsSchema } from './tabs.js'; | ||
import { decoratedVersionsSchema, versionsSchema } from './version.js'; | ||
const baseNavigationSchema = z.object({ global: globalSchema.optional() }); | ||
const createNavigationSchema = (type) => baseNavigationSchema | ||
.and(z.union([ | ||
z.object({ languages: type === 'default' ? languagesSchema : decoratedLanguagesSchema }), | ||
z.object({ versions: type === 'default' ? versionsSchema : decoratedVersionsSchema }), | ||
z.object({ tabs: type === 'default' ? tabsSchema : decoratedTabsSchema }), | ||
z.object({ dropdowns: type === 'default' ? dropdownsSchema : decoratedDropdownsSchema }), | ||
z.object({ anchors: type === 'default' ? anchorsSchema : decoratedAnchorsSchema }), | ||
z.object({ groups: type === 'default' ? groupsSchema : decoratedGroupsSchema }), | ||
z.object({ pages: type === 'default' ? pagesSchema : decoratedPagesSchema }), | ||
])) | ||
.describe('The navigation structure of the content'); | ||
export const navigationSchema = createNavigationSchema('default'); | ||
export const decoratedNavigationSchema = createNavigationSchema('decorated'); |
import { z } from 'zod'; | ||
export declare const languageSchema: z.ZodIntersection<z.ZodObject<{ | ||
export declare const nonRecursiveLanguageSchema: z.ZodIntersection<z.ZodObject<{ | ||
language: z.ZodEnum<["en", "cn", "es", "fr", "jp", "pt", "pt-BR", "de"]>; | ||
hidden: z.ZodOptional<z.ZodBoolean>; | ||
openapi: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">]>>; | ||
}, "strip", z.ZodTypeAny, { | ||
language: "en" | "cn" | "es" | "fr" | "jp" | "pt" | "pt-BR" | "de"; | ||
hidden?: boolean | undefined; | ||
openapi?: string | string[] | undefined; | ||
}, { | ||
language: "en" | "cn" | "es" | "fr" | "jp" | "pt" | "pt-BR" | "de"; | ||
hidden?: boolean | undefined; | ||
}>, z.ZodUnion<[z.ZodObject<{ | ||
openapi: z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">]>; | ||
}, "strip", z.ZodTypeAny, { | ||
openapi: (string | string[]) & (string | string[] | undefined); | ||
}, { | ||
openapi: (string | string[]) & (string | string[] | undefined); | ||
openapi?: string | string[] | undefined; | ||
}>, z.ZodObject<{ | ||
@@ -23,115 +20,35 @@ href: z.ZodString; | ||
href: string; | ||
}>, z.ZodLazy<z.ZodObject<{ | ||
versions: z.ZodArray<z.ZodType<any, z.ZodTypeDef, any>, "many">; | ||
}>>; | ||
export declare const languageSchema: z.ZodIntersection<z.ZodObject<{ | ||
language: z.ZodEnum<["en", "cn", "es", "fr", "jp", "pt", "pt-BR", "de"]>; | ||
hidden: z.ZodOptional<z.ZodBoolean>; | ||
openapi: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">]>>; | ||
}, "strip", z.ZodTypeAny, { | ||
versions: any[]; | ||
language: "en" | "cn" | "es" | "fr" | "jp" | "pt" | "pt-BR" | "de"; | ||
hidden?: boolean | undefined; | ||
openapi?: string | string[] | undefined; | ||
}, { | ||
versions: any[]; | ||
}>>, z.ZodLazy<z.ZodObject<{ | ||
tabs: z.ZodArray<z.ZodType<any, z.ZodTypeDef, any>, "many">; | ||
language: "en" | "cn" | "es" | "fr" | "jp" | "pt" | "pt-BR" | "de"; | ||
hidden?: boolean | undefined; | ||
openapi?: string | string[] | undefined; | ||
}>, z.ZodUnion<[z.ZodObject<{ | ||
href: z.ZodString; | ||
}, "strip", z.ZodTypeAny, { | ||
tabs: any[]; | ||
href: string; | ||
}, { | ||
tabs: any[]; | ||
}>>, z.ZodLazy<z.ZodObject<{ | ||
dropdowns: z.ZodArray<z.ZodType<any, z.ZodTypeDef, any>, "many">; | ||
}, "strip", z.ZodTypeAny, { | ||
dropdowns: any[]; | ||
}, { | ||
dropdowns: any[]; | ||
}>>, z.ZodLazy<z.ZodObject<{ | ||
anchors: z.ZodArray<z.ZodType<any, z.ZodTypeDef, any>, "many">; | ||
}, "strip", z.ZodTypeAny, { | ||
anchors: any[]; | ||
}, { | ||
anchors: any[]; | ||
}>>, z.ZodLazy<z.ZodObject<{ | ||
groups: z.ZodArray<z.ZodIntersection<z.ZodObject<{ | ||
group: z.ZodString; | ||
icon: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodObject<{ | ||
style: z.ZodOptional<z.ZodEnum<["brands", "duotone", "light", "regular", "sharp-duotone-solid", "sharp-light", "sharp-regular", "sharp-solid", "sharp-thin", "solid", "thin"]>>; | ||
name: z.ZodEffects<z.ZodString, string, string>; | ||
}, "strip", z.ZodTypeAny, { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
}, { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
}>]>>; | ||
hidden: z.ZodOptional<z.ZodBoolean>; | ||
root: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>; | ||
}, "strip", z.ZodTypeAny, { | ||
group: string; | ||
icon?: string | { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
} | undefined; | ||
hidden?: boolean | undefined; | ||
root?: string | undefined; | ||
}, { | ||
group: string; | ||
icon?: string | { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
} | undefined; | ||
hidden?: boolean | undefined; | ||
root?: string | undefined; | ||
}>, z.ZodUnion<[z.ZodObject<{ | ||
openapi: z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">]>; | ||
}, "strip", z.ZodTypeAny, { | ||
openapi: (string | string[]) & (string | string[] | undefined); | ||
}, { | ||
openapi: (string | string[]) & (string | string[] | undefined); | ||
}>, z.ZodLazy<z.ZodObject<{ | ||
pages: z.ZodArray<z.ZodType<any, z.ZodTypeDef, any>, "many">; | ||
}, "strip", z.ZodTypeAny, { | ||
pages: any[]; | ||
}, { | ||
pages: any[]; | ||
}>>]>>, "many">; | ||
}, "strip", z.ZodTypeAny, { | ||
groups: ({ | ||
group: string; | ||
icon?: string | { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
} | undefined; | ||
hidden?: boolean | undefined; | ||
root?: string | undefined; | ||
} & ({ | ||
openapi: (string | string[]) & (string | string[] | undefined); | ||
} | { | ||
pages: any[]; | ||
}))[]; | ||
}, { | ||
groups: ({ | ||
group: string; | ||
icon?: string | { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
} | undefined; | ||
hidden?: boolean | undefined; | ||
root?: string | undefined; | ||
} & ({ | ||
openapi: (string | string[]) & (string | string[] | undefined); | ||
} | { | ||
pages: any[]; | ||
}))[]; | ||
}>>, z.ZodLazy<z.ZodObject<{ | ||
pages: z.ZodArray<z.ZodType<any, z.ZodTypeDef, any>, "many">; | ||
}, "strip", z.ZodTypeAny, { | ||
pages: any[]; | ||
}, { | ||
pages: any[]; | ||
}>>]>>; | ||
export declare const nonRecursiveLanguageSchema: z.ZodIntersection<z.ZodObject<{ | ||
href: string; | ||
}>, z.ZodType<any, z.ZodTypeDef, any>, z.ZodType<any, z.ZodTypeDef, any>, ...z.ZodType<any, z.ZodTypeDef, any>[]]>>; | ||
export declare const decoratedLanguageSchema: z.ZodIntersection<z.ZodObject<{ | ||
language: z.ZodEnum<["en", "cn", "es", "fr", "jp", "pt", "pt-BR", "de"]>; | ||
hidden: z.ZodOptional<z.ZodBoolean>; | ||
openapi: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">]>>; | ||
}, "strip", z.ZodTypeAny, { | ||
language: "en" | "cn" | "es" | "fr" | "jp" | "pt" | "pt-BR" | "de"; | ||
hidden?: boolean | undefined; | ||
openapi?: string | string[] | undefined; | ||
}, { | ||
language: "en" | "cn" | "es" | "fr" | "jp" | "pt" | "pt-BR" | "de"; | ||
hidden?: boolean | undefined; | ||
}>, z.ZodObject<{ | ||
openapi?: string | string[] | undefined; | ||
}>, z.ZodUnion<[z.ZodObject<{ | ||
href: z.ZodString; | ||
@@ -142,19 +59,16 @@ }, "strip", z.ZodTypeAny, { | ||
href: string; | ||
}>>; | ||
}>, z.ZodType<any, z.ZodTypeDef, any>, z.ZodType<any, z.ZodTypeDef, any>, ...z.ZodType<any, z.ZodTypeDef, any>[]]>>; | ||
export declare const languagesSchema: z.ZodArray<z.ZodIntersection<z.ZodObject<{ | ||
language: z.ZodEnum<["en", "cn", "es", "fr", "jp", "pt", "pt-BR", "de"]>; | ||
hidden: z.ZodOptional<z.ZodBoolean>; | ||
openapi: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">]>>; | ||
}, "strip", z.ZodTypeAny, { | ||
language: "en" | "cn" | "es" | "fr" | "jp" | "pt" | "pt-BR" | "de"; | ||
hidden?: boolean | undefined; | ||
openapi?: string | string[] | undefined; | ||
}, { | ||
language: "en" | "cn" | "es" | "fr" | "jp" | "pt" | "pt-BR" | "de"; | ||
hidden?: boolean | undefined; | ||
openapi?: string | string[] | undefined; | ||
}>, z.ZodUnion<[z.ZodObject<{ | ||
openapi: z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">]>; | ||
}, "strip", z.ZodTypeAny, { | ||
openapi: (string | string[]) & (string | string[] | undefined); | ||
}, { | ||
openapi: (string | string[]) & (string | string[] | undefined); | ||
}>, z.ZodObject<{ | ||
href: z.ZodString; | ||
@@ -165,106 +79,25 @@ }, "strip", z.ZodTypeAny, { | ||
href: string; | ||
}>, z.ZodLazy<z.ZodObject<{ | ||
versions: z.ZodArray<z.ZodType<any, z.ZodTypeDef, any>, "many">; | ||
}>, z.ZodType<any, z.ZodTypeDef, any>, z.ZodType<any, z.ZodTypeDef, any>, ...z.ZodType<any, z.ZodTypeDef, any>[]]>>, "many">; | ||
export declare const decoratedLanguagesSchema: z.ZodArray<z.ZodIntersection<z.ZodObject<{ | ||
language: z.ZodEnum<["en", "cn", "es", "fr", "jp", "pt", "pt-BR", "de"]>; | ||
hidden: z.ZodOptional<z.ZodBoolean>; | ||
openapi: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">]>>; | ||
}, "strip", z.ZodTypeAny, { | ||
versions: any[]; | ||
language: "en" | "cn" | "es" | "fr" | "jp" | "pt" | "pt-BR" | "de"; | ||
hidden?: boolean | undefined; | ||
openapi?: string | string[] | undefined; | ||
}, { | ||
versions: any[]; | ||
}>>, z.ZodLazy<z.ZodObject<{ | ||
tabs: z.ZodArray<z.ZodType<any, z.ZodTypeDef, any>, "many">; | ||
language: "en" | "cn" | "es" | "fr" | "jp" | "pt" | "pt-BR" | "de"; | ||
hidden?: boolean | undefined; | ||
openapi?: string | string[] | undefined; | ||
}>, z.ZodUnion<[z.ZodObject<{ | ||
href: z.ZodString; | ||
}, "strip", z.ZodTypeAny, { | ||
tabs: any[]; | ||
href: string; | ||
}, { | ||
tabs: any[]; | ||
}>>, z.ZodLazy<z.ZodObject<{ | ||
dropdowns: z.ZodArray<z.ZodType<any, z.ZodTypeDef, any>, "many">; | ||
}, "strip", z.ZodTypeAny, { | ||
dropdowns: any[]; | ||
}, { | ||
dropdowns: any[]; | ||
}>>, z.ZodLazy<z.ZodObject<{ | ||
anchors: z.ZodArray<z.ZodType<any, z.ZodTypeDef, any>, "many">; | ||
}, "strip", z.ZodTypeAny, { | ||
anchors: any[]; | ||
}, { | ||
anchors: any[]; | ||
}>>, z.ZodLazy<z.ZodObject<{ | ||
groups: z.ZodArray<z.ZodIntersection<z.ZodObject<{ | ||
group: z.ZodString; | ||
icon: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodObject<{ | ||
style: z.ZodOptional<z.ZodEnum<["brands", "duotone", "light", "regular", "sharp-duotone-solid", "sharp-light", "sharp-regular", "sharp-solid", "sharp-thin", "solid", "thin"]>>; | ||
name: z.ZodEffects<z.ZodString, string, string>; | ||
}, "strip", z.ZodTypeAny, { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
}, { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
}>]>>; | ||
hidden: z.ZodOptional<z.ZodBoolean>; | ||
root: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>; | ||
}, "strip", z.ZodTypeAny, { | ||
group: string; | ||
icon?: string | { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
} | undefined; | ||
hidden?: boolean | undefined; | ||
root?: string | undefined; | ||
}, { | ||
group: string; | ||
icon?: string | { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
} | undefined; | ||
hidden?: boolean | undefined; | ||
root?: string | undefined; | ||
}>, z.ZodUnion<[z.ZodObject<{ | ||
openapi: z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">]>; | ||
}, "strip", z.ZodTypeAny, { | ||
openapi: (string | string[]) & (string | string[] | undefined); | ||
}, { | ||
openapi: (string | string[]) & (string | string[] | undefined); | ||
}>, z.ZodLazy<z.ZodObject<{ | ||
pages: z.ZodArray<z.ZodType<any, z.ZodTypeDef, any>, "many">; | ||
}, "strip", z.ZodTypeAny, { | ||
pages: any[]; | ||
}, { | ||
pages: any[]; | ||
}>>]>>, "many">; | ||
}, "strip", z.ZodTypeAny, { | ||
groups: ({ | ||
group: string; | ||
icon?: string | { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
} | undefined; | ||
hidden?: boolean | undefined; | ||
root?: string | undefined; | ||
} & ({ | ||
openapi: (string | string[]) & (string | string[] | undefined); | ||
} | { | ||
pages: any[]; | ||
}))[]; | ||
}, { | ||
groups: ({ | ||
group: string; | ||
icon?: string | { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
} | undefined; | ||
hidden?: boolean | undefined; | ||
root?: string | undefined; | ||
} & ({ | ||
openapi: (string | string[]) & (string | string[] | undefined); | ||
} | { | ||
pages: any[]; | ||
}))[]; | ||
}>>, z.ZodLazy<z.ZodObject<{ | ||
pages: z.ZodArray<z.ZodType<any, z.ZodTypeDef, any>, "many">; | ||
}, "strip", z.ZodTypeAny, { | ||
pages: any[]; | ||
}, { | ||
pages: any[]; | ||
}>>]>>, "many">; | ||
href: string; | ||
}>, z.ZodType<any, z.ZodTypeDef, any>, z.ZodType<any, z.ZodTypeDef, any>, ...z.ZodType<any, z.ZodTypeDef, any>[]]>>, "many">; | ||
export type LanguagesConfig = z.infer<typeof languagesSchema>; | ||
export type LanguageConfig = z.infer<typeof languageSchema>; | ||
export type DecoratedLanguagesConfig = z.infer<typeof decoratedLanguagesSchema>; | ||
export type DecoratedLanguageConfig = z.infer<typeof decoratedLanguageSchema>; |
@@ -5,8 +5,3 @@ import { z } from 'zod'; | ||
import { openApiSchema } from '../reusable/openapi.js'; | ||
import { anchorsSchema } from './anchors.js'; | ||
import { dropdownsSchema } from './dropdown.js'; | ||
import { groupsSchema } from './groups.js'; | ||
import { pagesSchema } from './pages.js'; | ||
import { tabsSchema } from './tabs.js'; | ||
import { versionsSchema } from './version.js'; | ||
import { getDivisionSchemasExcluding, registerDivisionSchema } from './divisionSchemas.js'; | ||
const baseLanguageSchema = z.object({ | ||
@@ -17,16 +12,8 @@ language: z | ||
hidden: hiddenSchema.optional(), | ||
openapi: openApiSchema.optional(), | ||
}); | ||
export const languageSchema = baseLanguageSchema | ||
.and(z.union([ | ||
z.object({ openapi: openApiSchema }), | ||
z.object({ href: hrefSchema }), | ||
z.lazy(() => z.object({ versions: versionsSchema })), | ||
z.lazy(() => z.object({ tabs: tabsSchema })), | ||
z.lazy(() => z.object({ dropdowns: dropdownsSchema })), | ||
z.lazy(() => z.object({ anchors: anchorsSchema })), | ||
z.lazy(() => z.object({ groups: groupsSchema })), | ||
z.lazy(() => z.object({ pages: pagesSchema })), | ||
])) | ||
.describe('Organizing by languages'); | ||
const createLanguageSchema = (type) => baseLanguageSchema.and(z.union([z.object({ href: hrefSchema }), ...getDivisionSchemasExcluding('languages', type)])); | ||
export const nonRecursiveLanguageSchema = baseLanguageSchema.and(z.object({ href: hrefSchema })); | ||
export const languageSchema = createLanguageSchema('default'); | ||
export const decoratedLanguageSchema = createLanguageSchema('decorated'); | ||
export const languagesSchema = z | ||
@@ -36,1 +23,6 @@ .array(languageSchema) | ||
.describe('Organizing by languages'); | ||
export const decoratedLanguagesSchema = z | ||
.array(decoratedLanguageSchema) | ||
.describe('Organizing by languages'); | ||
registerDivisionSchema('languages', languagesSchema, 'default'); | ||
registerDivisionSchema('languages', decoratedLanguagesSchema, 'decorated'); |
import { z } from 'zod'; | ||
import { pageSchema } from '../reusable/page.js'; | ||
export declare const pagesSchema: z.ZodArray<z.ZodType<any, z.ZodTypeDef, any>, "many">; | ||
export declare const decoratedPagesSchema: z.ZodArray<z.ZodType<any, z.ZodTypeDef, any>, "many">; | ||
export type PageConfig = z.infer<typeof pageSchema>; | ||
export type PagesConfig = z.infer<typeof pagesSchema>; | ||
export type DecoratedPagesConfig = z.infer<typeof decoratedPagesSchema>; |
import { z } from 'zod'; | ||
import { pageSchema } from '../reusable/page.js'; | ||
import { groupSchema } from './groups.js'; | ||
import { decoratedPageSchema, pageSchema } from '../reusable/page.js'; | ||
import { decoratedGroupSchema, groupSchema } from './groups.js'; | ||
const pageOrGroupSchema = z.lazy(() => z.union([pageSchema, groupSchema])); | ||
const decoratedPageOrGroupSchema = z.lazy(() => z.union([decoratedPageSchema, decoratedGroupSchema])); | ||
export const pagesSchema = z.array(pageOrGroupSchema).describe('An array of page paths or groups'); | ||
export const decoratedPagesSchema = z | ||
.array(decoratedPageOrGroupSchema) | ||
.describe('An array of page metadata or groups'); |
import { z } from 'zod'; | ||
export declare const tabSchema: z.ZodType; | ||
export declare const nonRecursiveTabSchema: z.ZodIntersection<z.ZodObject<{ | ||
@@ -16,2 +15,3 @@ tab: z.ZodString; | ||
hidden: z.ZodOptional<z.ZodBoolean>; | ||
openapi: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">]>>; | ||
}, "strip", z.ZodTypeAny, { | ||
@@ -24,2 +24,3 @@ tab: string; | ||
hidden?: boolean | undefined; | ||
openapi?: string | string[] | undefined; | ||
}, { | ||
@@ -32,2 +33,3 @@ tab: string; | ||
hidden?: boolean | undefined; | ||
openapi?: string | string[] | undefined; | ||
}>, z.ZodObject<{ | ||
@@ -40,4 +42,153 @@ href: z.ZodString; | ||
}>>; | ||
export declare const tabsSchema: z.ZodArray<z.ZodType<any, z.ZodTypeDef, any>, "many">; | ||
export declare const tabSchema: z.ZodIntersection<z.ZodObject<{ | ||
tab: z.ZodString; | ||
icon: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodObject<{ | ||
style: z.ZodOptional<z.ZodEnum<["brands", "duotone", "light", "regular", "sharp-duotone-solid", "sharp-light", "sharp-regular", "sharp-solid", "sharp-thin", "solid", "thin"]>>; | ||
name: z.ZodEffects<z.ZodString, string, string>; | ||
}, "strip", z.ZodTypeAny, { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
}, { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
}>]>>; | ||
hidden: z.ZodOptional<z.ZodBoolean>; | ||
openapi: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">]>>; | ||
}, "strip", z.ZodTypeAny, { | ||
tab: string; | ||
icon?: string | { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
} | undefined; | ||
hidden?: boolean | undefined; | ||
openapi?: string | string[] | undefined; | ||
}, { | ||
tab: string; | ||
icon?: string | { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
} | undefined; | ||
hidden?: boolean | undefined; | ||
openapi?: string | string[] | undefined; | ||
}>, z.ZodUnion<[z.ZodObject<{ | ||
href: z.ZodString; | ||
}, "strip", z.ZodTypeAny, { | ||
href: string; | ||
}, { | ||
href: string; | ||
}>, z.ZodType<any, z.ZodTypeDef, any>, z.ZodType<any, z.ZodTypeDef, any>, ...z.ZodType<any, z.ZodTypeDef, any>[]]>>; | ||
export declare const decoratedTabSchema: z.ZodIntersection<z.ZodObject<{ | ||
tab: z.ZodString; | ||
icon: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodObject<{ | ||
style: z.ZodOptional<z.ZodEnum<["brands", "duotone", "light", "regular", "sharp-duotone-solid", "sharp-light", "sharp-regular", "sharp-solid", "sharp-thin", "solid", "thin"]>>; | ||
name: z.ZodEffects<z.ZodString, string, string>; | ||
}, "strip", z.ZodTypeAny, { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
}, { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
}>]>>; | ||
hidden: z.ZodOptional<z.ZodBoolean>; | ||
openapi: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">]>>; | ||
}, "strip", z.ZodTypeAny, { | ||
tab: string; | ||
icon?: string | { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
} | undefined; | ||
hidden?: boolean | undefined; | ||
openapi?: string | string[] | undefined; | ||
}, { | ||
tab: string; | ||
icon?: string | { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
} | undefined; | ||
hidden?: boolean | undefined; | ||
openapi?: string | string[] | undefined; | ||
}>, z.ZodUnion<[z.ZodObject<{ | ||
href: z.ZodString; | ||
}, "strip", z.ZodTypeAny, { | ||
href: string; | ||
}, { | ||
href: string; | ||
}>, z.ZodType<any, z.ZodTypeDef, any>, z.ZodType<any, z.ZodTypeDef, any>, ...z.ZodType<any, z.ZodTypeDef, any>[]]>>; | ||
export declare const tabsSchema: z.ZodArray<z.ZodIntersection<z.ZodObject<{ | ||
tab: z.ZodString; | ||
icon: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodObject<{ | ||
style: z.ZodOptional<z.ZodEnum<["brands", "duotone", "light", "regular", "sharp-duotone-solid", "sharp-light", "sharp-regular", "sharp-solid", "sharp-thin", "solid", "thin"]>>; | ||
name: z.ZodEffects<z.ZodString, string, string>; | ||
}, "strip", z.ZodTypeAny, { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
}, { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
}>]>>; | ||
hidden: z.ZodOptional<z.ZodBoolean>; | ||
openapi: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">]>>; | ||
}, "strip", z.ZodTypeAny, { | ||
tab: string; | ||
icon?: string | { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
} | undefined; | ||
hidden?: boolean | undefined; | ||
openapi?: string | string[] | undefined; | ||
}, { | ||
tab: string; | ||
icon?: string | { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
} | undefined; | ||
hidden?: boolean | undefined; | ||
openapi?: string | string[] | undefined; | ||
}>, z.ZodUnion<[z.ZodObject<{ | ||
href: z.ZodString; | ||
}, "strip", z.ZodTypeAny, { | ||
href: string; | ||
}, { | ||
href: string; | ||
}>, z.ZodType<any, z.ZodTypeDef, any>, z.ZodType<any, z.ZodTypeDef, any>, ...z.ZodType<any, z.ZodTypeDef, any>[]]>>, "many">; | ||
export declare const decoratedTabsSchema: z.ZodArray<z.ZodIntersection<z.ZodObject<{ | ||
tab: z.ZodString; | ||
icon: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodObject<{ | ||
style: z.ZodOptional<z.ZodEnum<["brands", "duotone", "light", "regular", "sharp-duotone-solid", "sharp-light", "sharp-regular", "sharp-solid", "sharp-thin", "solid", "thin"]>>; | ||
name: z.ZodEffects<z.ZodString, string, string>; | ||
}, "strip", z.ZodTypeAny, { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
}, { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
}>]>>; | ||
hidden: z.ZodOptional<z.ZodBoolean>; | ||
openapi: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">]>>; | ||
}, "strip", z.ZodTypeAny, { | ||
tab: string; | ||
icon?: string | { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
} | undefined; | ||
hidden?: boolean | undefined; | ||
openapi?: string | string[] | undefined; | ||
}, { | ||
tab: string; | ||
icon?: string | { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
} | undefined; | ||
hidden?: boolean | undefined; | ||
openapi?: string | string[] | undefined; | ||
}>, z.ZodUnion<[z.ZodObject<{ | ||
href: z.ZodString; | ||
}, "strip", z.ZodTypeAny, { | ||
href: string; | ||
}, { | ||
href: string; | ||
}>, z.ZodType<any, z.ZodTypeDef, any>, z.ZodType<any, z.ZodTypeDef, any>, ...z.ZodType<any, z.ZodTypeDef, any>[]]>>, "many">; | ||
export type TabsConfig = z.infer<typeof tabsSchema>; | ||
export type TabConfig = z.infer<typeof tabSchema>; | ||
export type DecoratedTabsConfig = z.infer<typeof decoratedTabsSchema>; | ||
export type DecoratedTabConfig = z.infer<typeof decoratedTabSchema>; |
@@ -6,8 +6,3 @@ import { z } from 'zod'; | ||
import { openApiSchema } from '../reusable/openapi.js'; | ||
import { anchorsSchema } from './anchors.js'; | ||
import { dropdownsSchema } from './dropdown.js'; | ||
import { groupsSchema } from './groups.js'; | ||
import { languagesSchema } from './languages.js'; | ||
import { pagesSchema } from './pages.js'; | ||
import { versionsSchema } from './version.js'; | ||
import { getDivisionSchemasExcluding, registerDivisionSchema } from './divisionSchemas.js'; | ||
const baseTabSchema = z.object({ | ||
@@ -17,14 +12,11 @@ tab: z.string().nonempty().describe('The name of the tab'), | ||
hidden: hiddenSchema.optional(), | ||
openapi: openApiSchema.optional(), | ||
}); | ||
export const tabSchema = baseTabSchema.and(z.union([ | ||
z.object({ openapi: openApiSchema }), | ||
z.object({ href: hrefSchema }), | ||
z.lazy(() => z.object({ languages: languagesSchema })), | ||
z.lazy(() => z.object({ versions: versionsSchema })), | ||
z.lazy(() => z.object({ dropdowns: dropdownsSchema })), | ||
z.lazy(() => z.object({ anchors: anchorsSchema })), | ||
z.lazy(() => z.object({ groups: groupsSchema })), | ||
z.lazy(() => z.object({ pages: pagesSchema })), | ||
])); | ||
const createTabSchema = (type) => baseTabSchema.and(z.union([z.object({ href: hrefSchema }), ...getDivisionSchemasExcluding('tabs', type)])); | ||
export const nonRecursiveTabSchema = baseTabSchema.and(z.object({ href: hrefSchema })); | ||
export const tabSchema = createTabSchema('default'); | ||
export const decoratedTabSchema = createTabSchema('decorated'); | ||
export const tabsSchema = z.array(tabSchema).describe('Organizing by tabs'); | ||
export const decoratedTabsSchema = z.array(decoratedTabSchema).describe('Organizing by tabs'); | ||
registerDivisionSchema('tabs', tabsSchema, 'default'); | ||
registerDivisionSchema('tabs', decoratedTabsSchema, 'decorated'); |
import { z } from 'zod'; | ||
export declare const versionSchema: z.ZodType; | ||
export declare const nonRecursiveVersionSchema: z.ZodIntersection<z.ZodObject<{ | ||
version: z.ZodString; | ||
hidden: z.ZodOptional<z.ZodBoolean>; | ||
openapi: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">]>>; | ||
}, "strip", z.ZodTypeAny, { | ||
version: string; | ||
hidden?: boolean | undefined; | ||
openapi?: string | string[] | undefined; | ||
}, { | ||
version: string; | ||
hidden?: boolean | undefined; | ||
openapi?: string | string[] | undefined; | ||
}>, z.ZodObject<{ | ||
@@ -19,4 +21,81 @@ href: z.ZodString; | ||
}>>; | ||
export declare const versionsSchema: z.ZodArray<z.ZodType<any, z.ZodTypeDef, any>, "many">; | ||
export declare const versionSchema: z.ZodIntersection<z.ZodObject<{ | ||
version: z.ZodString; | ||
hidden: z.ZodOptional<z.ZodBoolean>; | ||
openapi: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">]>>; | ||
}, "strip", z.ZodTypeAny, { | ||
version: string; | ||
hidden?: boolean | undefined; | ||
openapi?: string | string[] | undefined; | ||
}, { | ||
version: string; | ||
hidden?: boolean | undefined; | ||
openapi?: string | string[] | undefined; | ||
}>, z.ZodUnion<[z.ZodObject<{ | ||
href: z.ZodString; | ||
}, "strip", z.ZodTypeAny, { | ||
href: string; | ||
}, { | ||
href: string; | ||
}>, z.ZodType<any, z.ZodTypeDef, any>, z.ZodType<any, z.ZodTypeDef, any>, ...z.ZodType<any, z.ZodTypeDef, any>[]]>>; | ||
export declare const decoratedVersionSchema: z.ZodIntersection<z.ZodObject<{ | ||
version: z.ZodString; | ||
hidden: z.ZodOptional<z.ZodBoolean>; | ||
openapi: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">]>>; | ||
}, "strip", z.ZodTypeAny, { | ||
version: string; | ||
hidden?: boolean | undefined; | ||
openapi?: string | string[] | undefined; | ||
}, { | ||
version: string; | ||
hidden?: boolean | undefined; | ||
openapi?: string | string[] | undefined; | ||
}>, z.ZodUnion<[z.ZodObject<{ | ||
href: z.ZodString; | ||
}, "strip", z.ZodTypeAny, { | ||
href: string; | ||
}, { | ||
href: string; | ||
}>, z.ZodType<any, z.ZodTypeDef, any>, z.ZodType<any, z.ZodTypeDef, any>, ...z.ZodType<any, z.ZodTypeDef, any>[]]>>; | ||
export declare const versionsSchema: z.ZodArray<z.ZodIntersection<z.ZodObject<{ | ||
version: z.ZodString; | ||
hidden: z.ZodOptional<z.ZodBoolean>; | ||
openapi: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">]>>; | ||
}, "strip", z.ZodTypeAny, { | ||
version: string; | ||
hidden?: boolean | undefined; | ||
openapi?: string | string[] | undefined; | ||
}, { | ||
version: string; | ||
hidden?: boolean | undefined; | ||
openapi?: string | string[] | undefined; | ||
}>, z.ZodUnion<[z.ZodObject<{ | ||
href: z.ZodString; | ||
}, "strip", z.ZodTypeAny, { | ||
href: string; | ||
}, { | ||
href: string; | ||
}>, z.ZodType<any, z.ZodTypeDef, any>, z.ZodType<any, z.ZodTypeDef, any>, ...z.ZodType<any, z.ZodTypeDef, any>[]]>>, "many">; | ||
export declare const decoratedVersionsSchema: z.ZodArray<z.ZodIntersection<z.ZodObject<{ | ||
version: z.ZodString; | ||
hidden: z.ZodOptional<z.ZodBoolean>; | ||
openapi: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">]>>; | ||
}, "strip", z.ZodTypeAny, { | ||
version: string; | ||
hidden?: boolean | undefined; | ||
openapi?: string | string[] | undefined; | ||
}, { | ||
version: string; | ||
hidden?: boolean | undefined; | ||
openapi?: string | string[] | undefined; | ||
}>, z.ZodUnion<[z.ZodObject<{ | ||
href: z.ZodString; | ||
}, "strip", z.ZodTypeAny, { | ||
href: string; | ||
}, { | ||
href: string; | ||
}>, z.ZodType<any, z.ZodTypeDef, any>, z.ZodType<any, z.ZodTypeDef, any>, ...z.ZodType<any, z.ZodTypeDef, any>[]]>>, "many">; | ||
export type VersionsConfig = z.infer<typeof versionsSchema>; | ||
export type VersionConfig = z.infer<typeof versionSchema>; | ||
export type DecoratedVersionsConfig = z.infer<typeof decoratedVersionsSchema>; | ||
export type DecoratedVersionConfig = z.infer<typeof decoratedVersionSchema>; |
@@ -5,23 +5,17 @@ import { z } from 'zod'; | ||
import { openApiSchema } from '../reusable/openapi.js'; | ||
import { anchorsSchema } from './anchors.js'; | ||
import { dropdownsSchema } from './dropdown.js'; | ||
import { groupsSchema } from './groups.js'; | ||
import { languagesSchema } from './languages.js'; | ||
import { pagesSchema } from './pages.js'; | ||
import { tabsSchema } from './tabs.js'; | ||
import { getDivisionSchemasExcluding, registerDivisionSchema } from './divisionSchemas.js'; | ||
const baseVersionSchema = z.object({ | ||
version: z.string().nonempty().describe('The name of the version'), | ||
hidden: hiddenSchema.optional(), | ||
openapi: openApiSchema.optional(), | ||
}); | ||
export const versionSchema = baseVersionSchema.and(z.union([ | ||
z.object({ openapi: openApiSchema }), | ||
z.object({ href: hrefSchema }), | ||
z.lazy(() => z.object({ languages: languagesSchema })), | ||
z.lazy(() => z.object({ tabs: tabsSchema })), | ||
z.lazy(() => z.object({ dropdowns: dropdownsSchema })), | ||
z.lazy(() => z.object({ anchors: anchorsSchema })), | ||
z.lazy(() => z.object({ groups: groupsSchema })), | ||
z.lazy(() => z.object({ pages: pagesSchema })), | ||
])); | ||
const createVersionSchema = (type) => baseVersionSchema.and(z.union([z.object({ href: hrefSchema }), ...getDivisionSchemasExcluding('versions', type)])); | ||
export const nonRecursiveVersionSchema = baseVersionSchema.and(z.object({ href: hrefSchema })); | ||
export const versionSchema = createVersionSchema('default'); | ||
export const decoratedVersionSchema = createVersionSchema('decorated'); | ||
export const versionsSchema = z.array(versionSchema).describe('Organizing by versions'); | ||
export const decoratedVersionsSchema = z | ||
.array(decoratedVersionSchema) | ||
.describe('Organizing by versions'); | ||
registerDivisionSchema('versions', versionsSchema, 'default'); | ||
registerDivisionSchema('versions', decoratedVersionsSchema, 'decorated'); |
import { z } from 'zod'; | ||
export declare const pageSchema: z.ZodEffects<z.ZodString, string, string>; | ||
export declare const decoratedPageSchema: z.ZodObject<{ | ||
href: z.ZodString; | ||
title: z.ZodString; | ||
sidebarTitle: z.ZodOptional<z.ZodString>; | ||
description: z.ZodOptional<z.ZodString>; | ||
api: z.ZodOptional<z.ZodString>; | ||
openapi: z.ZodOptional<z.ZodString>; | ||
contentType: z.ZodOptional<z.ZodString>; | ||
authMethod: z.ZodOptional<z.ZodString>; | ||
auth: z.ZodOptional<z.ZodString>; | ||
version: z.ZodOptional<z.ZodString>; | ||
mode: z.ZodOptional<z.ZodString>; | ||
hideFooterPagination: z.ZodOptional<z.ZodBoolean>; | ||
authors: z.ZodOptional<z.ZodUnknown>; | ||
lastUpdatedDate: z.ZodOptional<z.ZodString>; | ||
createdDate: z.ZodOptional<z.ZodString>; | ||
'openapi-schema': z.ZodOptional<z.ZodString>; | ||
icon: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodObject<{ | ||
style: z.ZodOptional<z.ZodEnum<["brands", "duotone", "light", "regular", "sharp-duotone-solid", "sharp-light", "sharp-regular", "sharp-solid", "sharp-thin", "solid", "thin"]>>; | ||
name: z.ZodEffects<z.ZodString, string, string>; | ||
}, "strip", z.ZodTypeAny, { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
}, { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
}>]>>; | ||
tag: z.ZodOptional<z.ZodString>; | ||
url: z.ZodOptional<z.ZodString>; | ||
hideApiMarker: z.ZodOptional<z.ZodBoolean>; | ||
noindex: z.ZodOptional<z.ZodBoolean>; | ||
isPublic: z.ZodOptional<z.ZodBoolean>; | ||
}, "strip", z.ZodTypeAny, { | ||
href: string; | ||
title: string; | ||
sidebarTitle?: string | undefined; | ||
description?: string | undefined; | ||
api?: string | undefined; | ||
openapi?: string | undefined; | ||
contentType?: string | undefined; | ||
authMethod?: string | undefined; | ||
auth?: string | undefined; | ||
version?: string | undefined; | ||
mode?: string | undefined; | ||
hideFooterPagination?: boolean | undefined; | ||
authors?: unknown; | ||
lastUpdatedDate?: string | undefined; | ||
createdDate?: string | undefined; | ||
'openapi-schema'?: string | undefined; | ||
icon?: string | { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
} | undefined; | ||
tag?: string | undefined; | ||
url?: string | undefined; | ||
hideApiMarker?: boolean | undefined; | ||
noindex?: boolean | undefined; | ||
isPublic?: boolean | undefined; | ||
}, { | ||
href: string; | ||
title: string; | ||
sidebarTitle?: string | undefined; | ||
description?: string | undefined; | ||
api?: string | undefined; | ||
openapi?: string | undefined; | ||
contentType?: string | undefined; | ||
authMethod?: string | undefined; | ||
auth?: string | undefined; | ||
version?: string | undefined; | ||
mode?: string | undefined; | ||
hideFooterPagination?: boolean | undefined; | ||
authors?: unknown; | ||
lastUpdatedDate?: string | undefined; | ||
createdDate?: string | undefined; | ||
'openapi-schema'?: string | undefined; | ||
icon?: string | { | ||
name: string; | ||
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined; | ||
} | undefined; | ||
tag?: string | undefined; | ||
url?: string | undefined; | ||
hideApiMarker?: boolean | undefined; | ||
noindex?: boolean | undefined; | ||
isPublic?: boolean | undefined; | ||
}>; | ||
export type DecoratedPageConfig = z.infer<typeof decoratedPageSchema>; |
import { z } from 'zod'; | ||
import { normalizeRelativePath } from '../../../../transforms/normalizeRelativePath.js'; | ||
import { iconSchema } from './icon.js'; | ||
export const pageSchema = z | ||
@@ -8,1 +9,27 @@ .string() | ||
.describe('A page in the navigation. Referenced by the path to the page. Example: path/to/page'); | ||
export const decoratedPageSchema = z | ||
.object({ | ||
href: z.string(), | ||
title: z.string(), | ||
sidebarTitle: z.string().optional(), | ||
description: z.string().optional(), | ||
api: z.string().optional(), | ||
openapi: z.string().optional(), | ||
contentType: z.string().optional(), | ||
authMethod: z.string().optional(), | ||
auth: z.string().optional(), | ||
version: z.string().optional(), | ||
mode: z.string().optional(), | ||
hideFooterPagination: z.boolean().optional(), | ||
authors: z.unknown().optional(), | ||
lastUpdatedDate: z.string().optional(), | ||
createdDate: z.string().optional(), | ||
'openapi-schema': z.string().optional(), | ||
icon: iconSchema.optional(), | ||
tag: z.string().optional(), | ||
url: z.string().optional(), | ||
hideApiMarker: z.boolean().optional(), | ||
noindex: z.boolean().optional(), | ||
isPublic: z.boolean().optional(), | ||
}) | ||
.describe('page metadata tags in the navigation'); |
@@ -5,6 +5,6 @@ import { z } from 'zod'; | ||
metatags: z.ZodOptional<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>>; | ||
indexing: z.ZodDefault<z.ZodOptional<z.ZodEnum<["navigable", "all"]>>>; | ||
indexing: z.ZodOptional<z.ZodEnum<["navigable", "all"]>>; | ||
}, "strip", z.ZodTypeAny, { | ||
indexing: "all" | "navigable"; | ||
metatags?: Record<string, string> | undefined; | ||
indexing?: "all" | "navigable" | undefined; | ||
}, { | ||
@@ -11,0 +11,0 @@ metatags?: Record<string, string> | undefined; |
@@ -12,5 +12,4 @@ import { z } from 'zod'; | ||
.optional() | ||
.default('navigable') | ||
.describe('Specify which pages to be indexed by search engines. Setting "navigable" indexes pages that are set in navigation, "all" indexes all pages'), | ||
.describe('Specify which pages to be indexed by search engines. Setting `navigable` indexes pages that are set in navigation, `all` indexes all pages. Defaults to `navigable`.'), | ||
}) | ||
.describe('SEO indexing configurations'); |
import { z } from 'zod'; | ||
export declare const stylingSchema: z.ZodObject<{ | ||
rounded: z.ZodDefault<z.ZodOptional<z.ZodEnum<["regular", "sharp"]>>>; | ||
eyebrows: z.ZodDefault<z.ZodOptional<z.ZodEnum<["section", "breadcrumbs"]>>>; | ||
codeblocks: z.ZodDefault<z.ZodOptional<z.ZodEnum<["system", "dark"]>>>; | ||
rounded: z.ZodOptional<z.ZodEnum<["regular", "sharp"]>>; | ||
eyebrows: z.ZodOptional<z.ZodEnum<["section", "breadcrumbs"]>>; | ||
codeblocks: z.ZodOptional<z.ZodEnum<["system", "dark"]>>; | ||
}, "strip", z.ZodTypeAny, { | ||
rounded: "regular" | "sharp"; | ||
eyebrows: "section" | "breadcrumbs"; | ||
codeblocks: "dark" | "system"; | ||
rounded?: "regular" | "sharp" | undefined; | ||
eyebrows?: "section" | "breadcrumbs" | undefined; | ||
codeblocks?: "dark" | "system" | undefined; | ||
}, { | ||
@@ -11,0 +11,0 @@ rounded?: "regular" | "sharp" | undefined; |
@@ -7,15 +7,12 @@ import { z } from 'zod'; | ||
.optional() | ||
.default('regular') | ||
.describe('Whether corners are rounded or sharp'), | ||
.describe('Whether corners are rounded or sharp. Defaults to `regular`.'), | ||
eyebrows: z | ||
.enum(['section', 'breadcrumbs']) | ||
.optional() | ||
.default('section') | ||
.describe('The eyebrows style of the content'), | ||
.describe('The eyebrows style of the content. Defaults to `section`.'), | ||
codeblocks: z | ||
.enum(['system', 'dark']) | ||
.optional() | ||
.default('system') | ||
.describe('The codeblock theme'), | ||
.describe('The codeblock theme. Defaults to `system`.'), | ||
}) | ||
.describe('Styling configurations'); |
import { ConfigType } from '@mintlify/models'; | ||
import { z } from 'zod'; | ||
import { docsConfigSchema } from '../schemas/v2/index.js'; | ||
type ConfigV2Type = z.infer<typeof docsConfigSchema>; | ||
export declare function upgradeToDocsConfig(config: ConfigType): ConfigV2Type; | ||
export {}; | ||
import { DocsConfig } from '../schemas/v2/index.js'; | ||
export declare function upgradeToDocsConfig(config: ConfigType): DocsConfig; |
@@ -15,2 +15,5 @@ var __rest = (this && this.__rest) || function (s, e) { | ||
function updateRounded(config) { | ||
if (config.rounded == undefined) { | ||
return undefined; | ||
} | ||
return config.rounded === 'sharp' ? 'sharp' : 'regular'; | ||
@@ -20,7 +23,13 @@ } | ||
var _a; | ||
return ((_a = config.eyebrow) === null || _a === void 0 ? void 0 : _a.display) === 'section' ? 'section' : 'breadcrumbs'; | ||
if (((_a = config.eyebrow) === null || _a === void 0 ? void 0 : _a.display) == undefined) { | ||
return undefined; | ||
} | ||
return config.eyebrow.display === 'breadcrumbs' ? 'breadcrumbs' : 'section'; | ||
} | ||
function updateCodeblocks(config) { | ||
var _a; | ||
return ((_a = config.codeBlock) === null || _a === void 0 ? void 0 : _a.mode) === 'dark' ? 'dark' : 'system'; | ||
if (((_a = config.codeBlock) === null || _a === void 0 ? void 0 : _a.mode) == undefined) { | ||
return undefined; | ||
} | ||
return config.codeBlock.mode === 'dark' ? 'dark' : 'system'; | ||
} | ||
@@ -38,4 +47,5 @@ function updateApiPlayground(config) { | ||
case 'hide': | ||
return 'none'; | ||
case undefined: | ||
return 'none'; | ||
return undefined; | ||
default: | ||
@@ -45,3 +55,3 @@ return oldMode; | ||
})(); | ||
const proxy = disableProxy !== undefined ? !disableProxy : undefined; | ||
const proxy = disableProxy == undefined ? undefined : !disableProxy; | ||
return { display, proxy }; | ||
@@ -100,2 +110,3 @@ } | ||
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v, _w, _x, _y, _z; | ||
const theme = 'mint'; | ||
const fonts = updateFont(config); | ||
@@ -106,7 +117,7 @@ const playground = updateApiPlayground(config); | ||
const codeblocks = updateCodeblocks(config); | ||
const v2Config = Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign({ $schema: 'https://mintlify.com/docs.json', theme: 'mint', name: config.name, colors: { | ||
const v2Config = Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign({ $schema: 'https://mintlify.com/docs.json', theme, name: config.name, colors: { | ||
primary: config.colors.primary, | ||
light: config.colors.light, | ||
dark: config.colors.dark, | ||
}, favicon: config.favicon, navigation: updateNavigationToDocsConfig(config) }, (config.rounded || config.eyebrow || config.codeBlock | ||
}, favicon: config.favicon, navigation: updateNavigationToDocsConfig(config) }, (rounded || eyebrows || codeblocks | ||
? { | ||
@@ -126,4 +137,10 @@ styling: { | ||
api: Object.assign(Object.assign(Object.assign(Object.assign({}, (config.openapi ? { openapi: config.openapi } : {})), (playground | ||
? Object.assign({ display: playground.display }, (playground.proxy !== undefined ? { proxy: playground.proxy } : {})) : {})), (((_j = (_h = (_g = config.api) === null || _g === void 0 ? void 0 : _g.request) === null || _h === void 0 ? void 0 : _h.example) === null || _j === void 0 ? void 0 : _j.languages) | ||
? { | ||
playground: { | ||
display: playground.display, | ||
proxy: playground.proxy, | ||
}, | ||
} | ||
: {})), (((_j = (_h = (_g = config.api) === null || _g === void 0 ? void 0 : _g.request) === null || _h === void 0 ? void 0 : _h.example) === null || _j === void 0 ? void 0 : _j.languages) | ||
? { | ||
examples: { | ||
@@ -136,3 +153,3 @@ languages: config.api.request.example.languages, | ||
mdx: { | ||
base: config.api.baseUrl, | ||
server: config.api.baseUrl, | ||
auth: (_o = config.api.auth) === null || _o === void 0 ? void 0 : _o.method, | ||
@@ -143,7 +160,7 @@ }, | ||
} | ||
: {})), (config.modeToggle | ||
: {})), (((_p = config.modeToggle) === null || _p === void 0 ? void 0 : _p.default) || ((_q = config.modeToggle) === null || _q === void 0 ? void 0 : _q.isHidden) != undefined | ||
? { | ||
appearance: { | ||
default: (_p = config.modeToggle.default) !== null && _p !== void 0 ? _p : 'system', | ||
strict: (_q = config.modeToggle.isHidden) !== null && _q !== void 0 ? _q : false, | ||
default: config.modeToggle.default, | ||
strict: config.modeToggle.isHidden, | ||
}, | ||
@@ -150,0 +167,0 @@ } |
{ | ||
"name": "@mintlify/validation", | ||
"version": "0.1.246", | ||
"version": "0.1.247", | ||
"description": "Validates mint.json files", | ||
@@ -63,3 +63,3 @@ "author": "Mintlify, Inc.", | ||
}, | ||
"gitHead": "f388f10c9db0918455427ac848c837e1350403e9" | ||
"gitHead": "bd19fb72fa53b9e30342b2b9a76e3065d549dbe8" | ||
} |
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is not supported yet
1536959
183
35311