@mintlify/validation 0.1.43 → 0.1.45

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (60) hide show
  1. package/LICENSE +21 -21
  2. package/README.md +55 -55
  3. package/dist/index.d.ts +7 -11
  4. package/dist/index.js +1 -1
  5. package/dist/mint-config/common.d.ts +6 -6
  6. package/dist/mint-config/flattenUnionErrorMessages.d.ts +7 -7
  7. package/dist/mint-config/hexadecimalPattern.d.ts +1 -1
  8. package/dist/mint-config/schemas/analytics.d.ts +275 -171
  9. package/dist/mint-config/schemas/anchorColors.d.ts +28 -14
  10. package/dist/mint-config/schemas/anchors.d.ts +108 -46
  11. package/dist/mint-config/schemas/apiReference.d.ts +77 -0
  12. package/dist/mint-config/schemas/basics.d.ts +80 -0
  13. package/dist/mint-config/schemas/colors.d.ts +62 -61
  14. package/dist/mint-config/schemas/config.d.ts +814 -822
  15. package/dist/mint-config/schemas/favicon.d.ts +2 -2
  16. package/dist/mint-config/schemas/integrations.d.ts +38 -0
  17. package/dist/mint-config/schemas/name.d.ts +2 -2
  18. package/dist/mint-config/schemas/navigation.d.ts +3 -3
  19. package/dist/mint-config/schemas/tabs.d.ts +31 -11
  20. package/dist/mint-config/schemas/versions.d.ts +24 -11
  21. package/dist/mint-config/types/analytics.d.ts +3 -3
  22. package/dist/mint-config/types/anchors.d.ts +4 -4
  23. package/dist/mint-config/types/colors.d.ts +3 -3
  24. package/dist/mint-config/types/config.d.ts +55 -3
  25. package/dist/mint-config/types/enums.d.ts +4 -0
  26. package/dist/mint-config/types/index.d.ts +12 -0
  27. package/dist/mint-config/types/navigation.d.ts +13 -6
  28. package/dist/mint-config/types/versions.d.ts +3 -3
  29. package/dist/mint-config/validateAnchorsWarnings.d.ts +4 -4
  30. package/dist/mint-config/validateVersionsInNavigation.d.ts +5 -5
  31. package/dist/openapi/convertOpenApi.d.ts +18 -18
  32. package/dist/openapi/convertParameters.d.ts +9 -9
  33. package/dist/openapi/convertSchema.d.ts +11 -11
  34. package/dist/openapi/convertSecurity.d.ts +14 -14
  35. package/dist/openapi/convertServers.d.ts +8 -8
  36. package/dist/openapi/types/endpoint.d.ts +128 -128
  37. package/package.json +75 -75
  38. package/dist/schemas/analytics.d.ts +0 -171
  39. package/dist/schemas/anchorColors.d.ts +0 -14
  40. package/dist/schemas/anchors.d.ts +0 -46
  41. package/dist/schemas/colors.d.ts +0 -61
  42. package/dist/schemas/config.d.ts +0 -799
  43. package/dist/schemas/favicon.d.ts +0 -2
  44. package/dist/schemas/name.d.ts +0 -2
  45. package/dist/schemas/navigation.d.ts +0 -3
  46. package/dist/schemas/tabs.d.ts +0 -11
  47. package/dist/schemas/versions.d.ts +0 -11
  48. package/dist/types/analytics.d.ts +0 -3
  49. package/dist/types/anchors.d.ts +0 -3
  50. package/dist/types/colors.d.ts +0 -3
  51. package/dist/types/config.d.ts +0 -3
  52. package/dist/types/endpoint.d.ts +0 -125
  53. package/dist/types/navigation.d.ts +0 -6
  54. package/dist/types/versions.d.ts +0 -3
  55. package/dist/utils/common.d.ts +0 -6
  56. package/dist/utils/convertOpenApi.d.ts +0 -43
  57. package/dist/utils/flattenUnionErrorMessages.d.ts +0 -7
  58. package/dist/utils/hexadecimalPattern.d.ts +0 -1
  59. package/dist/utils/validateAnchorsWarnings.d.ts +0 -4
  60. package/dist/utils/validateVersionsInNavigation.d.ts +0 -5
@@ -1,46 +1,108 @@
1
- import { z } from 'zod';
2
- export declare const anchorsSchema: z.ZodArray<z.ZodObject<{
3
- name: z.ZodString;
4
- url: z.ZodString;
5
- icon: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
6
- iconType: z.ZodOptional<z.ZodEnum<["brands", "duotone", "light", "sharp-solid", "solid", "thin"]>>;
7
- color: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodObject<{
8
- from: z.ZodString;
9
- via: z.ZodOptional<z.ZodString>;
10
- to: z.ZodString;
11
- }, "strict", z.ZodTypeAny, {
12
- from: string;
13
- to: string;
14
- via?: string | undefined;
15
- }, {
16
- from: string;
17
- to: string;
18
- via?: string | undefined;
19
- }>]>>;
20
- isDefaultHidden: z.ZodOptional<z.ZodBoolean>;
21
- version: z.ZodOptional<z.ZodString>;
22
- }, "strip", z.ZodTypeAny, {
23
- name: string;
24
- url: string;
25
- icon?: string | undefined;
26
- iconType?: "light" | "brands" | "duotone" | "sharp-solid" | "solid" | "thin" | undefined;
27
- color?: string | {
28
- from: string;
29
- to: string;
30
- via?: string | undefined;
31
- } | undefined;
32
- isDefaultHidden?: boolean | undefined;
33
- version?: string | undefined;
34
- }, {
35
- name: string;
36
- url: string;
37
- icon?: string | undefined;
38
- iconType?: "light" | "brands" | "duotone" | "sharp-solid" | "solid" | "thin" | undefined;
39
- color?: string | {
40
- from: string;
41
- to: string;
42
- via?: string | undefined;
43
- } | undefined;
44
- isDefaultHidden?: boolean | undefined;
45
- version?: string | undefined;
46
- }>, "many">;
1
+ import { z } from 'zod';
2
+ declare const anchorSchema: z.ZodObject<{
3
+ name: z.ZodString;
4
+ url: z.ZodString;
5
+ icon: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
6
+ iconType: z.ZodOptional<z.ZodEnum<["brands", "duotone", "light", "sharp-solid", "solid", "thin"]>>;
7
+ color: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodObject<{
8
+ from: z.ZodString;
9
+ via: z.ZodOptional<z.ZodString>;
10
+ to: z.ZodString;
11
+ }, "strict", z.ZodTypeAny, {
12
+ from: string;
13
+ to: string;
14
+ via?: string | undefined;
15
+ }, {
16
+ from: string;
17
+ to: string;
18
+ via?: string | undefined;
19
+ }>]>>;
20
+ isDefaultHidden: z.ZodOptional<z.ZodBoolean>;
21
+ version: z.ZodOptional<z.ZodString>;
22
+ }, "strip", z.ZodTypeAny, {
23
+ name: string;
24
+ url: string;
25
+ icon?: string | undefined;
26
+ iconType?: "light" | "brands" | "duotone" | "sharp-solid" | "solid" | "thin" | undefined;
27
+ color?: string | {
28
+ from: string;
29
+ to: string;
30
+ via?: string | undefined;
31
+ } | undefined;
32
+ isDefaultHidden?: boolean | undefined;
33
+ version?: string | undefined;
34
+ }, {
35
+ name: string;
36
+ url: string;
37
+ icon?: string | undefined;
38
+ iconType?: "light" | "brands" | "duotone" | "sharp-solid" | "solid" | "thin" | undefined;
39
+ color?: string | {
40
+ from: string;
41
+ to: string;
42
+ via?: string | undefined;
43
+ } | undefined;
44
+ isDefaultHidden?: boolean | undefined;
45
+ version?: string | undefined;
46
+ }>;
47
+ export declare const anchorsSchema: z.ZodArray<z.ZodObject<{
48
+ name: z.ZodString;
49
+ url: z.ZodString;
50
+ icon: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
51
+ iconType: z.ZodOptional<z.ZodEnum<["brands", "duotone", "light", "sharp-solid", "solid", "thin"]>>;
52
+ color: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodObject<{
53
+ from: z.ZodString;
54
+ via: z.ZodOptional<z.ZodString>;
55
+ to: z.ZodString;
56
+ }, "strict", z.ZodTypeAny, {
57
+ from: string;
58
+ to: string;
59
+ via?: string | undefined;
60
+ }, {
61
+ from: string;
62
+ to: string;
63
+ via?: string | undefined;
64
+ }>]>>;
65
+ isDefaultHidden: z.ZodOptional<z.ZodBoolean>;
66
+ version: z.ZodOptional<z.ZodString>;
67
+ }, "strip", z.ZodTypeAny, {
68
+ name: string;
69
+ url: string;
70
+ icon?: string | undefined;
71
+ iconType?: "light" | "brands" | "duotone" | "sharp-solid" | "solid" | "thin" | undefined;
72
+ color?: string | {
73
+ from: string;
74
+ to: string;
75
+ via?: string | undefined;
76
+ } | undefined;
77
+ isDefaultHidden?: boolean | undefined;
78
+ version?: string | undefined;
79
+ }, {
80
+ name: string;
81
+ url: string;
82
+ icon?: string | undefined;
83
+ iconType?: "light" | "brands" | "duotone" | "sharp-solid" | "solid" | "thin" | undefined;
84
+ color?: string | {
85
+ from: string;
86
+ to: string;
87
+ via?: string | undefined;
88
+ } | undefined;
89
+ isDefaultHidden?: boolean | undefined;
90
+ version?: string | undefined;
91
+ }>, "many">;
92
+ export declare const topAnchorSchema: z.ZodObject<{
93
+ name: z.ZodString;
94
+ icon: z.ZodOptional<z.ZodString>;
95
+ iconType: z.ZodOptional<z.ZodEnum<["brands", "duotone", "light", "sharp-solid", "solid", "thin"]>>;
96
+ }, "strict", z.ZodTypeAny, {
97
+ name: string;
98
+ icon?: string | undefined;
99
+ iconType?: "light" | "brands" | "duotone" | "sharp-solid" | "solid" | "thin" | undefined;
100
+ }, {
101
+ name: string;
102
+ icon?: string | undefined;
103
+ iconType?: "light" | "brands" | "duotone" | "sharp-solid" | "solid" | "thin" | undefined;
104
+ }>;
105
+ export type AnchorType = z.infer<typeof anchorSchema>;
106
+ export type AnchorsType = z.infer<typeof anchorsSchema>;
107
+ export type TopAnchorType = z.infer<typeof topAnchorSchema>;
108
+ export {};
@@ -0,0 +1,77 @@
1
+ import { z } from 'zod';
2
+ export declare const openApiSchema: z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>;
3
+ export type OpenApiType = z.infer<typeof openApiSchema>;
4
+ export declare const apiSchema: z.ZodObject<{
5
+ baseUrl: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>>;
6
+ auth: z.ZodOptional<z.ZodObject<{
7
+ method: z.ZodOptional<z.ZodEnum<["bearer", "basic", "key"]>>;
8
+ name: z.ZodOptional<z.ZodString>;
9
+ inputPrefix: z.ZodOptional<z.ZodString>;
10
+ }, "strict", z.ZodTypeAny, {
11
+ method?: "bearer" | "basic" | "key" | undefined;
12
+ name?: string | undefined;
13
+ inputPrefix?: string | undefined;
14
+ }, {
15
+ method?: "bearer" | "basic" | "key" | undefined;
16
+ name?: string | undefined;
17
+ inputPrefix?: string | undefined;
18
+ }>>;
19
+ playground: z.ZodOptional<z.ZodObject<{
20
+ mode: z.ZodDefault<z.ZodOptional<z.ZodEnum<["show", "simple", "hide"]>>>;
21
+ }, "strip", z.ZodTypeAny, {
22
+ mode: "show" | "simple" | "hide";
23
+ }, {
24
+ mode?: "show" | "simple" | "hide" | undefined;
25
+ }>>;
26
+ request: z.ZodOptional<z.ZodObject<{
27
+ example: z.ZodOptional<z.ZodObject<{
28
+ showOptionalParams: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
29
+ }, "strip", z.ZodTypeAny, {
30
+ showOptionalParams: boolean;
31
+ }, {
32
+ showOptionalParams?: boolean | undefined;
33
+ }>>;
34
+ }, "strip", z.ZodTypeAny, {
35
+ example?: {
36
+ showOptionalParams: boolean;
37
+ } | undefined;
38
+ }, {
39
+ example?: {
40
+ showOptionalParams?: boolean | undefined;
41
+ } | undefined;
42
+ }>>;
43
+ maintainOrder: z.ZodOptional<z.ZodBoolean>;
44
+ }, "strict", z.ZodTypeAny, {
45
+ baseUrl?: string | string[] | undefined;
46
+ auth?: {
47
+ method?: "bearer" | "basic" | "key" | undefined;
48
+ name?: string | undefined;
49
+ inputPrefix?: string | undefined;
50
+ } | undefined;
51
+ playground?: {
52
+ mode: "show" | "simple" | "hide";
53
+ } | undefined;
54
+ request?: {
55
+ example?: {
56
+ showOptionalParams: boolean;
57
+ } | undefined;
58
+ } | undefined;
59
+ maintainOrder?: boolean | undefined;
60
+ }, {
61
+ baseUrl?: string | string[] | undefined;
62
+ auth?: {
63
+ method?: "bearer" | "basic" | "key" | undefined;
64
+ name?: string | undefined;
65
+ inputPrefix?: string | undefined;
66
+ } | undefined;
67
+ playground?: {
68
+ mode?: "show" | "simple" | "hide" | undefined;
69
+ } | undefined;
70
+ request?: {
71
+ example?: {
72
+ showOptionalParams?: boolean | undefined;
73
+ } | undefined;
74
+ } | undefined;
75
+ maintainOrder?: boolean | undefined;
76
+ }>;
77
+ export type ApiConfigType = z.infer<typeof apiSchema>;
@@ -0,0 +1,80 @@
1
+ import { z } from 'zod';
2
+ import { NavbarLinkType } from '../types/enums';
3
+ export declare const nameSchema: z.ZodString;
4
+ export declare const logoSchema: z.ZodUnion<[z.ZodString, z.ZodObject<{
5
+ light: z.ZodString;
6
+ dark: z.ZodString;
7
+ href: z.ZodOptional<z.ZodString>;
8
+ }, "strip", z.ZodTypeAny, {
9
+ light: string;
10
+ dark: string;
11
+ href?: string | undefined;
12
+ }, {
13
+ light: string;
14
+ dark: string;
15
+ href?: string | undefined;
16
+ }>]>;
17
+ export declare const modeToggleSchema: z.ZodObject<{
18
+ default: z.ZodOptional<z.ZodEnum<["light", "dark"]>>;
19
+ isHidden: z.ZodOptional<z.ZodBoolean>;
20
+ }, "strip", z.ZodTypeAny, {
21
+ default?: "light" | "dark" | undefined;
22
+ isHidden?: boolean | undefined;
23
+ }, {
24
+ default?: "light" | "dark" | undefined;
25
+ isHidden?: boolean | undefined;
26
+ }>;
27
+ export declare const isWhiteLabeledSchema: z.ZodBoolean;
28
+ export declare const metadataSchema: z.ZodRecord<z.ZodString, z.ZodString>;
29
+ export declare const footerSocialsSchema: z.ZodUnion<[z.ZodArray<z.ZodObject<{
30
+ type: z.ZodString;
31
+ url: z.ZodString;
32
+ }, "strip", z.ZodTypeAny, {
33
+ type: string;
34
+ url: string;
35
+ }, {
36
+ type: string;
37
+ url: string;
38
+ }>, "many">, z.ZodRecord<z.ZodString, z.ZodString>]>;
39
+ export declare const feedbackSchema: z.ZodObject<{
40
+ suggestEdit: z.ZodOptional<z.ZodBoolean>;
41
+ raiseIssue: z.ZodOptional<z.ZodBoolean>;
42
+ }, "strip", z.ZodTypeAny, {
43
+ suggestEdit?: boolean | undefined;
44
+ raiseIssue?: boolean | undefined;
45
+ }, {
46
+ suggestEdit?: boolean | undefined;
47
+ raiseIssue?: boolean | undefined;
48
+ }>;
49
+ export declare const createCtaButtonSchema: (ctaButtonName: string) => z.ZodUnion<[z.ZodObject<{
50
+ type: z.ZodOptional<z.ZodLiteral<"link">>;
51
+ name: z.ZodString;
52
+ url: z.ZodString;
53
+ }, "strict", z.ZodTypeAny, {
54
+ name: string;
55
+ url: string;
56
+ type?: "link" | undefined;
57
+ }, {
58
+ name: string;
59
+ url: string;
60
+ type?: "link" | undefined;
61
+ }>, z.ZodObject<{
62
+ type: z.ZodLiteral<"github">;
63
+ url: z.ZodString;
64
+ }, "strict", z.ZodTypeAny, {
65
+ type: "github";
66
+ url: string;
67
+ }, {
68
+ type: "github";
69
+ url: string;
70
+ }>]>;
71
+ export type LogoType = z.infer<typeof logoSchema>;
72
+ export type FeedbackType = z.infer<typeof feedbackSchema>;
73
+ export type FooterSocialsType = z.infer<typeof footerSocialsSchema>;
74
+ export type NavbarLink = {
75
+ url: string;
76
+ type?: NavbarLinkType;
77
+ name?: string;
78
+ };
79
+ export declare const iconTypes: readonly ["brands", "duotone", "light", "regular", "sharp-solid", "solid", "thin"];
80
+ export type IconType = (typeof iconTypes)[number];
@@ -1,61 +1,62 @@
1
- import { z } from 'zod';
2
- export declare const colorsSchema: z.ZodObject<{
3
- primary: z.ZodString;
4
- light: z.ZodOptional<z.ZodString>;
5
- dark: z.ZodOptional<z.ZodString>;
6
- background: z.ZodOptional<z.ZodObject<{
7
- light: z.ZodOptional<z.ZodString>;
8
- dark: z.ZodOptional<z.ZodString>;
9
- }, "strip", z.ZodTypeAny, {
10
- light?: string | undefined;
11
- dark?: string | undefined;
12
- }, {
13
- light?: string | undefined;
14
- dark?: string | undefined;
15
- }>>;
16
- anchors: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodObject<{
17
- from: z.ZodString;
18
- via: z.ZodOptional<z.ZodString>;
19
- to: z.ZodString;
20
- }, "strict", z.ZodTypeAny, {
21
- from: string;
22
- to: string;
23
- via?: string | undefined;
24
- }, {
25
- from: string;
26
- to: string;
27
- via?: string | undefined;
28
- }>]>>;
29
- ultraLight: z.ZodOptional<z.ZodAny>;
30
- ultraDark: z.ZodOptional<z.ZodAny>;
31
- }, "strict", z.ZodTypeAny, {
32
- primary: string;
33
- light?: string | undefined;
34
- dark?: string | undefined;
35
- background?: {
36
- light?: string | undefined;
37
- dark?: string | undefined;
38
- } | undefined;
39
- anchors?: string | {
40
- from: string;
41
- to: string;
42
- via?: string | undefined;
43
- } | undefined;
44
- ultraLight?: any;
45
- ultraDark?: any;
46
- }, {
47
- primary: string;
48
- light?: string | undefined;
49
- dark?: string | undefined;
50
- background?: {
51
- light?: string | undefined;
52
- dark?: string | undefined;
53
- } | undefined;
54
- anchors?: string | {
55
- from: string;
56
- to: string;
57
- via?: string | undefined;
58
- } | undefined;
59
- ultraLight?: any;
60
- ultraDark?: any;
61
- }>;
1
+ import { z } from 'zod';
2
+ export declare const colorsSchema: z.ZodObject<{
3
+ primary: z.ZodString;
4
+ light: z.ZodOptional<z.ZodString>;
5
+ dark: z.ZodOptional<z.ZodString>;
6
+ background: z.ZodOptional<z.ZodObject<{
7
+ light: z.ZodOptional<z.ZodString>;
8
+ dark: z.ZodOptional<z.ZodString>;
9
+ }, "strip", z.ZodTypeAny, {
10
+ light?: string | undefined;
11
+ dark?: string | undefined;
12
+ }, {
13
+ light?: string | undefined;
14
+ dark?: string | undefined;
15
+ }>>;
16
+ anchors: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodObject<{
17
+ from: z.ZodString;
18
+ via: z.ZodOptional<z.ZodString>;
19
+ to: z.ZodString;
20
+ }, "strict", z.ZodTypeAny, {
21
+ from: string;
22
+ to: string;
23
+ via?: string | undefined;
24
+ }, {
25
+ from: string;
26
+ to: string;
27
+ via?: string | undefined;
28
+ }>]>>;
29
+ ultraLight: z.ZodOptional<z.ZodAny>;
30
+ ultraDark: z.ZodOptional<z.ZodAny>;
31
+ }, "strict", z.ZodTypeAny, {
32
+ primary: string;
33
+ light?: string | undefined;
34
+ dark?: string | undefined;
35
+ background?: {
36
+ light?: string | undefined;
37
+ dark?: string | undefined;
38
+ } | undefined;
39
+ anchors?: string | {
40
+ from: string;
41
+ to: string;
42
+ via?: string | undefined;
43
+ } | undefined;
44
+ ultraLight?: any;
45
+ ultraDark?: any;
46
+ }, {
47
+ primary: string;
48
+ light?: string | undefined;
49
+ dark?: string | undefined;
50
+ background?: {
51
+ light?: string | undefined;
52
+ dark?: string | undefined;
53
+ } | undefined;
54
+ anchors?: string | {
55
+ from: string;
56
+ to: string;
57
+ via?: string | undefined;
58
+ } | undefined;
59
+ ultraLight?: any;
60
+ ultraDark?: any;
61
+ }>;
62
+ export type ColorsType = z.infer<typeof colorsSchema>;