@tobi-or-not/docpress 0.7.0 → 0.7.2

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.
@@ -1,69 +1,36 @@
1
1
  import { z } from 'zod';
2
+ /**
3
+ * Schema for the DocPress configuration file
4
+ * Defines the structure and validation rules for the configuration
5
+ */
2
6
  export declare const configSchema: z.ZodObject<{
3
- usernames: z.ZodArray<z.ZodString, "many">;
7
+ usernames: z.ZodArray<z.ZodString>;
4
8
  branch: z.ZodDefault<z.ZodString>;
5
- gitProvider: z.ZodDefault<z.ZodEnum<["github"]>>;
6
- reposFilter: z.ZodArray<z.ZodString, "many">;
7
- extraHeaderPages: z.ZodArray<z.ZodString, "many">;
8
- extraPublicContent: z.ZodArray<z.ZodString, "many">;
9
- extraTheme: z.ZodArray<z.ZodString, "many">;
9
+ gitProvider: z.ZodDefault<z.ZodEnum<{
10
+ github: "github";
11
+ }>>;
12
+ reposFilter: z.ZodArray<z.ZodString>;
13
+ extraHeaderPages: z.ZodArray<z.ZodString>;
14
+ extraPublicContent: z.ZodArray<z.ZodString>;
15
+ extraTheme: z.ZodArray<z.ZodString>;
10
16
  forks: z.ZodDefault<z.ZodBoolean>;
11
17
  vitepressConfig: z.ZodAny;
12
18
  websiteTitle: z.ZodString;
13
19
  websiteTagline: z.ZodString;
14
- }, "strip", z.ZodTypeAny, {
15
- usernames: string[];
16
- branch: string;
17
- gitProvider: "github";
18
- reposFilter: string[];
19
- extraHeaderPages: string[];
20
- extraPublicContent: string[];
21
- extraTheme: string[];
22
- forks: boolean;
23
- websiteTitle: string;
24
- websiteTagline: string;
25
- vitepressConfig?: any;
26
- }, {
27
- usernames: string[];
28
- reposFilter: string[];
29
- extraHeaderPages: string[];
30
- extraPublicContent: string[];
31
- extraTheme: string[];
32
- websiteTitle: string;
33
- websiteTagline: string;
34
- branch?: string | undefined;
35
- gitProvider?: "github" | undefined;
36
- forks?: boolean | undefined;
37
- vitepressConfig?: any;
38
- }>;
39
- export type Config = Zod.infer<typeof configSchema>;
40
- export declare function applyGlobalOptsTransform(data: Cli): {
41
- token: string | undefined;
42
- usernames: string[];
43
- branch?: string | undefined;
44
- gitProvider?: "github" | undefined;
45
- reposFilter?: string[] | undefined;
46
- extraHeaderPages?: string[] | undefined;
47
- extraPublicContent?: string[] | undefined;
48
- extraTheme?: string[] | undefined;
49
- forks?: boolean | undefined;
50
- vitepressConfig?: any;
51
- websiteTitle?: string | undefined;
52
- websiteTagline?: string | undefined;
53
- };
54
- export declare const baseCliSchema: z.ZodObject<z.objectUtil.extendShape<{
55
- usernames: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
20
+ }, z.core.$strip>;
21
+ export type Config = z.infer<typeof configSchema>;
22
+ /**
23
+ * Base CLI schema for parsing command line arguments
24
+ * All fields are optional in this schema
25
+ */
26
+ export declare const baseCliSchema: z.ZodObject<{
56
27
  branch: z.ZodOptional<z.ZodDefault<z.ZodString>>;
57
- gitProvider: z.ZodOptional<z.ZodDefault<z.ZodEnum<["github"]>>>;
58
- reposFilter: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
59
- extraHeaderPages: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
60
- extraPublicContent: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
61
- extraTheme: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
28
+ gitProvider: z.ZodOptional<z.ZodDefault<z.ZodEnum<{
29
+ github: "github";
30
+ }>>>;
62
31
  forks: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
63
- vitepressConfig: z.ZodOptional<z.ZodAny>;
64
32
  websiteTitle: z.ZodOptional<z.ZodString>;
65
33
  websiteTagline: z.ZodOptional<z.ZodString>;
66
- }, {
67
34
  config: z.ZodOptional<z.ZodString>;
68
35
  token: z.ZodOptional<z.ZodString>;
69
36
  usernames: z.ZodOptional<z.ZodString>;
@@ -72,155 +39,62 @@ export declare const baseCliSchema: z.ZodObject<z.objectUtil.extendShape<{
72
39
  extraPublicContent: z.ZodOptional<z.ZodString>;
73
40
  extraTheme: z.ZodOptional<z.ZodString>;
74
41
  vitepressConfig: z.ZodOptional<z.ZodString>;
75
- }>, "strip", z.ZodTypeAny, {
76
- usernames?: string | undefined;
77
- branch?: string | undefined;
78
- gitProvider?: "github" | undefined;
79
- reposFilter?: string | undefined;
80
- extraHeaderPages?: string | undefined;
81
- extraPublicContent?: string | undefined;
82
- extraTheme?: string | undefined;
83
- forks?: boolean | undefined;
84
- vitepressConfig?: string | undefined;
85
- websiteTitle?: string | undefined;
86
- websiteTagline?: string | undefined;
87
- config?: string | undefined;
88
- token?: string | undefined;
89
- }, {
90
- usernames?: string | undefined;
91
- branch?: string | undefined;
92
- gitProvider?: "github" | undefined;
93
- reposFilter?: string | undefined;
94
- extraHeaderPages?: string | undefined;
95
- extraPublicContent?: string | undefined;
96
- extraTheme?: string | undefined;
97
- forks?: boolean | undefined;
98
- vitepressConfig?: string | undefined;
99
- websiteTitle?: string | undefined;
100
- websiteTagline?: string | undefined;
101
- config?: string | undefined;
102
- token?: string | undefined;
103
- }>;
42
+ }, z.core.$strip>;
104
43
  export type RawCli = z.infer<typeof baseCliSchema>;
105
- export declare const cliSchema: z.ZodObject<z.objectUtil.extendShape<{
106
- usernames: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
44
+ /**
45
+ * CLI schema with transformations applied to handle string-to-array conversions
46
+ */
47
+ export declare const cliSchema: z.ZodObject<{
107
48
  branch: z.ZodOptional<z.ZodDefault<z.ZodString>>;
108
- gitProvider: z.ZodOptional<z.ZodDefault<z.ZodEnum<["github"]>>>;
109
- reposFilter: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
110
- extraHeaderPages: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
111
- extraPublicContent: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
112
- extraTheme: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
49
+ gitProvider: z.ZodOptional<z.ZodDefault<z.ZodEnum<{
50
+ github: "github";
51
+ }>>>;
113
52
  forks: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
114
- vitepressConfig: z.ZodOptional<z.ZodAny>;
115
53
  websiteTitle: z.ZodOptional<z.ZodString>;
116
54
  websiteTagline: z.ZodOptional<z.ZodString>;
117
- }, {
118
55
  config: z.ZodOptional<z.ZodString>;
119
56
  token: z.ZodOptional<z.ZodString>;
120
- usernames: z.ZodOptional<z.ZodEffects<z.ZodString, string[], string>>;
121
- reposFilter: z.ZodOptional<z.ZodEffects<z.ZodString, string[], string>>;
122
- extraHeaderPages: z.ZodOptional<z.ZodEffects<z.ZodString, string[], string>>;
123
- extraPublicContent: z.ZodOptional<z.ZodEffects<z.ZodString, string[], string>>;
124
- extraTheme: z.ZodOptional<z.ZodEffects<z.ZodString, string[], string>>;
57
+ usernames: z.ZodOptional<z.ZodPipe<z.ZodString, z.ZodTransform<string[], string>>>;
58
+ reposFilter: z.ZodOptional<z.ZodPipe<z.ZodString, z.ZodTransform<string[], string>>>;
59
+ extraHeaderPages: z.ZodOptional<z.ZodPipe<z.ZodString, z.ZodTransform<string[], string>>>;
60
+ extraPublicContent: z.ZodOptional<z.ZodPipe<z.ZodString, z.ZodTransform<string[], string>>>;
61
+ extraTheme: z.ZodOptional<z.ZodPipe<z.ZodString, z.ZodTransform<string[], string>>>;
125
62
  vitepressConfig: z.ZodOptional<z.ZodString>;
126
- }>, "strip", z.ZodTypeAny, {
127
- usernames?: string[] | undefined;
128
- branch?: string | undefined;
129
- gitProvider?: "github" | undefined;
130
- reposFilter?: string[] | undefined;
131
- extraHeaderPages?: string[] | undefined;
132
- extraPublicContent?: string[] | undefined;
133
- extraTheme?: string[] | undefined;
134
- forks?: boolean | undefined;
135
- vitepressConfig?: string | undefined;
136
- websiteTitle?: string | undefined;
137
- websiteTagline?: string | undefined;
138
- config?: string | undefined;
139
- token?: string | undefined;
140
- }, {
141
- usernames?: string | undefined;
142
- branch?: string | undefined;
143
- gitProvider?: "github" | undefined;
144
- reposFilter?: string | undefined;
145
- extraHeaderPages?: string | undefined;
146
- extraPublicContent?: string | undefined;
147
- extraTheme?: string | undefined;
148
- forks?: boolean | undefined;
149
- vitepressConfig?: string | undefined;
150
- websiteTitle?: string | undefined;
151
- websiteTagline?: string | undefined;
152
- config?: string | undefined;
153
- token?: string | undefined;
154
- }>;
155
- export type Cli = Zod.infer<typeof cliSchema>;
156
- export declare const globalOptsSchema: z.ZodEffects<z.ZodObject<{
63
+ }, z.core.$strip>;
64
+ export type Cli = z.infer<typeof cliSchema>;
65
+ /**
66
+ * Schema for global options that combines CLI arguments and configuration files
67
+ * Applies transformations to merge different config sources and validate the result
68
+ */
69
+ export declare const globalOptsSchema: z.ZodPipe<z.ZodObject<{
157
70
  branch: z.ZodOptional<z.ZodOptional<z.ZodDefault<z.ZodString>>>;
158
- gitProvider: z.ZodOptional<z.ZodOptional<z.ZodDefault<z.ZodEnum<["github"]>>>>;
71
+ gitProvider: z.ZodOptional<z.ZodOptional<z.ZodDefault<z.ZodEnum<{
72
+ github: "github";
73
+ }>>>>;
159
74
  forks: z.ZodOptional<z.ZodOptional<z.ZodDefault<z.ZodBoolean>>>;
160
75
  websiteTitle: z.ZodOptional<z.ZodOptional<z.ZodString>>;
161
76
  websiteTagline: z.ZodOptional<z.ZodOptional<z.ZodString>>;
162
77
  config: z.ZodOptional<z.ZodOptional<z.ZodString>>;
163
78
  token: z.ZodOptional<z.ZodOptional<z.ZodString>>;
164
- usernames: z.ZodOptional<z.ZodOptional<z.ZodEffects<z.ZodString, string[], string>>>;
165
- reposFilter: z.ZodOptional<z.ZodOptional<z.ZodEffects<z.ZodString, string[], string>>>;
166
- extraHeaderPages: z.ZodOptional<z.ZodOptional<z.ZodEffects<z.ZodString, string[], string>>>;
167
- extraPublicContent: z.ZodOptional<z.ZodOptional<z.ZodEffects<z.ZodString, string[], string>>>;
168
- extraTheme: z.ZodOptional<z.ZodOptional<z.ZodEffects<z.ZodString, string[], string>>>;
79
+ usernames: z.ZodOptional<z.ZodOptional<z.ZodPipe<z.ZodString, z.ZodTransform<string[], string>>>>;
80
+ reposFilter: z.ZodOptional<z.ZodOptional<z.ZodPipe<z.ZodString, z.ZodTransform<string[], string>>>>;
81
+ extraHeaderPages: z.ZodOptional<z.ZodOptional<z.ZodPipe<z.ZodString, z.ZodTransform<string[], string>>>>;
82
+ extraPublicContent: z.ZodOptional<z.ZodOptional<z.ZodPipe<z.ZodString, z.ZodTransform<string[], string>>>>;
83
+ extraTheme: z.ZodOptional<z.ZodOptional<z.ZodPipe<z.ZodString, z.ZodTransform<string[], string>>>>;
169
84
  vitepressConfig: z.ZodOptional<z.ZodOptional<z.ZodString>>;
170
- }, "strip", z.ZodTypeAny, {
171
- usernames?: string[] | undefined;
172
- branch?: string | undefined;
173
- gitProvider?: "github" | undefined;
174
- reposFilter?: string[] | undefined;
175
- extraHeaderPages?: string[] | undefined;
176
- extraPublicContent?: string[] | undefined;
177
- extraTheme?: string[] | undefined;
178
- forks?: boolean | undefined;
179
- vitepressConfig?: string | undefined;
180
- websiteTitle?: string | undefined;
181
- websiteTagline?: string | undefined;
182
- config?: string | undefined;
183
- token?: string | undefined;
184
- }, {
185
- usernames?: string | undefined;
85
+ }, z.core.$strip>, z.ZodTransform<any, {
186
86
  branch?: string | undefined;
187
87
  gitProvider?: "github" | undefined;
188
- reposFilter?: string | undefined;
189
- extraHeaderPages?: string | undefined;
190
- extraPublicContent?: string | undefined;
191
- extraTheme?: string | undefined;
192
88
  forks?: boolean | undefined;
193
- vitepressConfig?: string | undefined;
194
89
  websiteTitle?: string | undefined;
195
90
  websiteTagline?: string | undefined;
196
91
  config?: string | undefined;
197
92
  token?: string | undefined;
198
- }>, {
199
- token: string | undefined;
200
- usernames: string[];
201
- branch?: string | undefined;
202
- gitProvider?: "github" | undefined;
93
+ usernames?: string[] | undefined;
203
94
  reposFilter?: string[] | undefined;
204
95
  extraHeaderPages?: string[] | undefined;
205
96
  extraPublicContent?: string[] | undefined;
206
97
  extraTheme?: string[] | undefined;
207
- forks?: boolean | undefined;
208
- vitepressConfig?: any;
209
- websiteTitle?: string | undefined;
210
- websiteTagline?: string | undefined;
211
- }, {
212
- usernames?: string | undefined;
213
- branch?: string | undefined;
214
- gitProvider?: "github" | undefined;
215
- reposFilter?: string | undefined;
216
- extraHeaderPages?: string | undefined;
217
- extraPublicContent?: string | undefined;
218
- extraTheme?: string | undefined;
219
- forks?: boolean | undefined;
220
98
  vitepressConfig?: string | undefined;
221
- websiteTitle?: string | undefined;
222
- websiteTagline?: string | undefined;
223
- config?: string | undefined;
224
- token?: string | undefined;
225
- }>;
226
- export type GlobalOpts = Required<Pick<Zod.infer<typeof globalOptsSchema>, 'branch' | 'gitProvider'>> & Omit<Zod.infer<typeof globalOptsSchema>, 'branch' | 'gitProvider'>;
99
+ }>>;
100
+ export type GlobalOpts = Required<Pick<z.infer<typeof globalOptsSchema>, 'branch' | 'gitProvider'>> & Omit<z.infer<typeof globalOptsSchema>, 'branch' | 'gitProvider'>;
@@ -1,66 +1,22 @@
1
- export declare const prepareOptsSchema: import("zod").ZodEffects<import("zod").ZodObject<Pick<import("zod").objectUtil.extendShape<{
2
- usernames: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString, "many">>;
3
- branch: import("zod").ZodOptional<import("zod").ZodDefault<import("zod").ZodString>>;
4
- gitProvider: import("zod").ZodOptional<import("zod").ZodDefault<import("zod").ZodEnum<["github"]>>>;
5
- reposFilter: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString, "many">>;
6
- extraHeaderPages: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString, "many">>;
7
- extraPublicContent: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString, "many">>;
8
- extraTheme: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString, "many">>;
9
- forks: import("zod").ZodOptional<import("zod").ZodDefault<import("zod").ZodBoolean>>;
10
- vitepressConfig: import("zod").ZodOptional<import("zod").ZodAny>;
11
- websiteTitle: import("zod").ZodOptional<import("zod").ZodString>;
12
- websiteTagline: import("zod").ZodOptional<import("zod").ZodString>;
13
- }, {
1
+ import type { GlobalOpts } from './global.js';
2
+ /**
3
+ * Schema for prepare command options
4
+ * Includes options related to documentation preparation and customization
5
+ */
6
+ export declare const prepareOptsSchema: import("zod").ZodObject<{
7
+ usernames: import("zod").ZodOptional<import("zod").ZodPipe<import("zod").ZodString, import("zod").ZodTransform<string[], string>>>;
8
+ gitProvider: import("zod").ZodOptional<import("zod").ZodDefault<import("zod").ZodEnum<{
9
+ github: "github";
10
+ }>>>;
11
+ reposFilter: import("zod").ZodOptional<import("zod").ZodPipe<import("zod").ZodString, import("zod").ZodTransform<string[], string>>>;
12
+ extraHeaderPages: import("zod").ZodOptional<import("zod").ZodPipe<import("zod").ZodString, import("zod").ZodTransform<string[], string>>>;
13
+ extraPublicContent: import("zod").ZodOptional<import("zod").ZodPipe<import("zod").ZodString, import("zod").ZodTransform<string[], string>>>;
14
+ extraTheme: import("zod").ZodOptional<import("zod").ZodPipe<import("zod").ZodString, import("zod").ZodTransform<string[], string>>>;
15
+ vitepressConfig: import("zod").ZodOptional<import("zod").ZodString>;
14
16
  config: import("zod").ZodOptional<import("zod").ZodString>;
15
17
  token: import("zod").ZodOptional<import("zod").ZodString>;
16
- usernames: import("zod").ZodOptional<import("zod").ZodEffects<import("zod").ZodString, string[], string>>;
17
- reposFilter: import("zod").ZodOptional<import("zod").ZodEffects<import("zod").ZodString, string[], string>>;
18
- extraHeaderPages: import("zod").ZodOptional<import("zod").ZodEffects<import("zod").ZodString, string[], string>>;
19
- extraPublicContent: import("zod").ZodOptional<import("zod").ZodEffects<import("zod").ZodString, string[], string>>;
20
- extraTheme: import("zod").ZodOptional<import("zod").ZodEffects<import("zod").ZodString, string[], string>>;
21
- vitepressConfig: import("zod").ZodOptional<import("zod").ZodString>;
22
- }>, "usernames" | "gitProvider" | "reposFilter" | "extraHeaderPages" | "extraPublicContent" | "extraTheme" | "vitepressConfig" | "config" | "token">, "strip", import("zod").ZodTypeAny, {
23
- usernames?: string[] | undefined;
24
- gitProvider?: "github" | undefined;
25
- reposFilter?: string[] | undefined;
26
- extraHeaderPages?: string[] | undefined;
27
- extraPublicContent?: string[] | undefined;
28
- extraTheme?: string[] | undefined;
29
- vitepressConfig?: string | undefined;
30
- config?: string | undefined;
31
- token?: string | undefined;
32
- }, {
33
- usernames?: string | undefined;
34
- gitProvider?: "github" | undefined;
35
- reposFilter?: string | undefined;
36
- extraHeaderPages?: string | undefined;
37
- extraPublicContent?: string | undefined;
38
- extraTheme?: string | undefined;
39
- vitepressConfig?: string | undefined;
40
- config?: string | undefined;
41
- token?: string | undefined;
42
- }>, {
43
- token: string | undefined;
44
- usernames: string[];
45
- branch?: string | undefined;
46
- gitProvider?: "github" | undefined;
47
- reposFilter?: string[] | undefined;
48
- extraHeaderPages?: string[] | undefined;
49
- extraPublicContent?: string[] | undefined;
50
- extraTheme?: string[] | undefined;
51
- forks?: boolean | undefined;
52
- vitepressConfig?: any;
53
- websiteTitle?: string | undefined;
54
- websiteTagline?: string | undefined;
55
- }, {
56
- usernames?: string | undefined;
57
- gitProvider?: "github" | undefined;
58
- reposFilter?: string | undefined;
59
- extraHeaderPages?: string | undefined;
60
- extraPublicContent?: string | undefined;
61
- extraTheme?: string | undefined;
62
- vitepressConfig?: string | undefined;
63
- config?: string | undefined;
64
- token?: string | undefined;
65
- }>;
66
- export type PrepareOpts = Zod.infer<typeof prepareOptsSchema>;
18
+ }, import("zod/v4/core").$strip>;
19
+ /**
20
+ * Type for prepare options
21
+ */
22
+ export type PrepareOpts = GlobalOpts;