@powerlines/plugin-typedoc 0.10.28 → 0.10.29

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.
@@ -8,13 +8,11 @@ import { PreviewOptions, ResolvedPreviewOptions } from 'vite';
8
8
  import { EnvPaths } from '@stryke/env/get-env-paths';
9
9
  import { PackageJson } from '@stryke/types/package-json';
10
10
  import { Jiti } from 'jiti';
11
- import { ParserOptions, ParseResult } from 'oxc-parser';
12
11
  import { Range } from 'semver';
13
12
  import { UnpluginMessage, UnpluginContext, UnpluginBuildContext, TransformResult, ExternalIdResult, HookFilter, UnpluginOptions } from 'unplugin';
13
+ import { PathLike, StatSyncOptions, Stats, RmDirOptions, RmOptions, Mode, MakeDirectoryOptions as MakeDirectoryOptions$1, PathOrFileDescriptor, WriteFileOptions as WriteFileOptions$1 } from 'node:fs';
14
14
  import { TsConfigJson, CompilerOptions } from '@stryke/types/tsconfig';
15
15
  import ts from 'typescript';
16
- import { PrimitiveJsonValue } from '@stryke/json/types';
17
- import { PathLike, StatSyncOptions, Stats, RmDirOptions, RmOptions, Mode, MakeDirectoryOptions as MakeDirectoryOptions$1, PathOrFileDescriptor, WriteFileOptions as WriteFileOptions$1 } from 'node:fs';
18
16
  import { ArrayValues } from '@stryke/types/array';
19
17
  import { TypeDocOptions, Application, ProjectReflection } from 'typedoc';
20
18
 
@@ -154,87 +152,20 @@ interface BuildConfig {
154
152
  }
155
153
  type BuildResolvedConfig = Omit<BuildConfig, "override">;
156
154
 
157
- type ReflectionMode = "default" | "explicit" | "never";
158
- type RawReflectionMode = ReflectionMode | "" | boolean | string | string[] | undefined;
159
- /**
160
- * Defines the level of reflection to be used during the transpilation process.
161
- *
162
- * @remarks
163
- * The level determines how much extra data is captured in the byte code for each type. This can be one of the following values:
164
- * - `minimal` - Only the essential type information is captured.
165
- * - `normal` - Additional type information is captured, including some contextual data.
166
- * - `verbose` - All available type information is captured, including detailed contextual data.
167
- */
168
- type ReflectionLevel = "minimal" | "normal" | "verbose";
169
- interface DeepkitOptions {
170
- /**
171
- * Either true to activate reflection for all files compiled using this tsconfig,
172
- * or a list of globs/file paths relative to this tsconfig.json.
173
- * Globs/file paths can be prefixed with a ! to exclude them.
174
- */
175
- reflection?: RawReflectionMode;
176
- /**
177
- * Defines the level of reflection to be used during the transpilation process.
178
- *
179
- * @remarks
180
- * The level determines how much extra data is captured in the byte code for each type. This can be one of the following values:
181
- * - `minimal` - Only the essential type information is captured.
182
- * - `normal` - Additional type information is captured, including some contextual data.
183
- * - `verbose` - All available type information is captured, including detailed contextual data.
184
- */
185
- reflectionLevel?: ReflectionLevel;
186
- }
187
- type TSCompilerOptions = CompilerOptions & DeepkitOptions;
188
- /**
189
- * The TypeScript compiler configuration.
190
- *
191
- * @see https://www.typescriptlang.org/docs/handbook/tsconfig-json.html
192
- */
193
- interface TSConfig extends Omit<TsConfigJson, "reflection"> {
194
- /**
195
- * Either true to activate reflection for all files compiled using this tsconfig,
196
- * or a list of globs/file paths relative to this tsconfig.json.
197
- * Globs/file paths can be prefixed with a ! to exclude them.
198
- */
199
- reflection?: RawReflectionMode;
200
- /**
201
- * Defines the level of reflection to be used during the transpilation process.
202
- *
203
- * @remarks
204
- * The level determines how much extra data is captured in the byte code for each type. This can be one of the following values:
205
- * - `minimal` - Only the essential type information is captured.
206
- * - `normal` - Additional type information is captured, including some contextual data.
207
- * - `verbose` - All available type information is captured, including detailed contextual data.
208
- */
209
- reflectionLevel?: ReflectionLevel;
210
- /**
211
- * Instructs the TypeScript compiler how to compile `.ts` files.
212
- */
213
- compilerOptions?: TSCompilerOptions;
214
- }
215
- type ParsedTypeScriptConfig = ts.ParsedCommandLine & {
216
- originalTsconfigJson: TsConfigJson;
217
- tsconfigJson: TSConfig;
218
- tsconfigFilePath: string;
219
- };
220
-
221
155
  declare const __VFS_PATCH__ = "__VFS_PATCH__";
222
156
  declare const __VFS_REVERT__ = "__VFS_REVERT__";
223
157
  type OutputModeType = "fs" | "virtual";
224
- interface VirtualFile {
158
+ interface VirtualFileMetadata {
225
159
  /**
226
- * The unique identifier for the virtual file.
227
- *
228
- * @remarks
229
- * If no specific id is provided, it defaults to the file's {@link path}.
160
+ * The identifier for the file data.
230
161
  */
231
162
  id: string;
232
163
  /**
233
- * Additional metadata associated with the virtual file.
164
+ * The timestamp of the virtual file.
234
165
  */
235
- details: Record<string, PrimitiveJsonValue>;
166
+ timestamp: number;
236
167
  /**
237
- * The variant of the file.
168
+ * The type of the file.
238
169
  *
239
170
  * @remarks
240
171
  * This string represents the purpose/function of the file in the virtual file system. A potential list of variants includes:
@@ -242,52 +173,72 @@ interface VirtualFile {
242
173
  * - `entry`: Indicates that the file is an entry point for execution.
243
174
  * - `normal`: Indicates that the file is a standard file without any special role.
244
175
  */
245
- variant: string;
176
+ type: string;
246
177
  /**
247
178
  * The output mode of the file.
248
- *
249
- * @remarks
250
- * This indicates whether the file is intended to be written to the actual file system (`fs`) or kept in the virtual file system (`virtual`).
251
179
  */
252
- mode: OutputModeType;
253
- /**
254
- * A virtual (or actual) path to the file in the file system.
255
- */
256
- path: string;
180
+ mode: string;
257
181
  /**
258
- * The contents of the file.
182
+ * Additional metadata associated with the file.
259
183
  */
260
- code: string | NodeJS.ArrayBufferView;
184
+ properties: Record<string, string>;
261
185
  }
262
- interface VirtualFileMetadata {
186
+ interface VirtualFileData {
263
187
  /**
264
188
  * The identifier for the file data.
265
189
  */
266
- id: string;
190
+ id?: string;
267
191
  /**
268
- * The variant of the file.
192
+ * The contents of the virtual file.
193
+ */
194
+ code: string;
195
+ /**
196
+ * The type of the file.
197
+ *
198
+ * @remarks
199
+ * This string represents the purpose/function of the file in the virtual file system. A potential list of variants includes:
200
+ * - `builtin`: Indicates that the file is a built-in module provided by the system.
201
+ * - `entry`: Indicates that the file is an entry point for execution.
202
+ * - `chunk`: Indicates that the file is a code chunk, typically used in code-splitting scenarios.
203
+ * - `prebuilt-chunk`: Indicates that the file is a prebuilt code chunk.
204
+ * - `asset`: Indicates that the file is a static asset, such as an image or stylesheet.
205
+ * - `normal`: Indicates that the file is a standard file without any special role.
269
206
  */
270
- variant: string;
207
+ type?: string;
271
208
  /**
272
209
  * The output mode of the file.
273
210
  */
274
- mode: string;
211
+ mode?: string;
275
212
  /**
276
213
  * Additional metadata associated with the file.
277
214
  */
278
- properties: Record<string, string>;
215
+ properties?: Record<string, string>;
216
+ }
217
+ interface VirtualFile extends Required<VirtualFileData>, VirtualFileMetadata {
218
+ /**
219
+ * An additional name for the file.
220
+ */
221
+ path: string;
222
+ /**
223
+ * The timestamp of the virtual file.
224
+ */
225
+ timestamp: number;
279
226
  }
280
227
  interface ResolveFSOptions {
281
228
  mode?: OutputModeType;
282
229
  }
283
230
  type MakeDirectoryOptions = (Mode | MakeDirectoryOptions$1) & ResolveFSOptions;
284
231
  interface PowerlinesWriteFileOptions extends ResolveFSOptions {
232
+ /**
233
+ * Should the file skip formatting before being written?
234
+ *
235
+ * @defaultValue false
236
+ */
285
237
  skipFormat?: boolean;
286
238
  }
287
239
  type NodeWriteFileOptions = WriteFileOptions$1;
288
240
  type WriteFileOptions = NodeWriteFileOptions | PowerlinesWriteFileOptions;
289
- type PowerLinesWriteFileData = Partial<Omit<VirtualFile, "path" | "mode" | "code">> & Pick<VirtualFile, "code">;
290
- type WriteFileData = string | NodeJS.ArrayBufferView | PowerLinesWriteFileData;
241
+ type WriteFileData = string | NodeJS.ArrayBufferView | VirtualFileData;
291
242
  interface ResolvePathOptions extends ResolveFSOptions {
292
243
  /**
293
244
  * Should the resolved path include the file extension?
@@ -302,7 +253,7 @@ interface ResolvePathOptions extends ResolveFSOptions {
302
253
  /**
303
254
  * The type of the path to resolve.
304
255
  */
305
- type?: "file" | "directory";
256
+ pathType?: "file" | "directory";
306
257
  }
307
258
  interface VirtualFileSystemInterface {
308
259
  /**
@@ -591,6 +542,70 @@ interface VirtualFileSystemInterface {
591
542
  dispose: () => Promise<void>;
592
543
  }
593
544
 
545
+ type ReflectionMode = "default" | "explicit" | "never";
546
+ type RawReflectionMode = ReflectionMode | "" | boolean | string | string[] | undefined;
547
+ /**
548
+ * Defines the level of reflection to be used during the transpilation process.
549
+ *
550
+ * @remarks
551
+ * The level determines how much extra data is captured in the byte code for each type. This can be one of the following values:
552
+ * - `minimal` - Only the essential type information is captured.
553
+ * - `normal` - Additional type information is captured, including some contextual data.
554
+ * - `verbose` - All available type information is captured, including detailed contextual data.
555
+ */
556
+ type ReflectionLevel = "minimal" | "normal" | "verbose";
557
+ interface DeepkitOptions {
558
+ /**
559
+ * Either true to activate reflection for all files compiled using this tsconfig,
560
+ * or a list of globs/file paths relative to this tsconfig.json.
561
+ * Globs/file paths can be prefixed with a ! to exclude them.
562
+ */
563
+ reflection?: RawReflectionMode;
564
+ /**
565
+ * Defines the level of reflection to be used during the transpilation process.
566
+ *
567
+ * @remarks
568
+ * The level determines how much extra data is captured in the byte code for each type. This can be one of the following values:
569
+ * - `minimal` - Only the essential type information is captured.
570
+ * - `normal` - Additional type information is captured, including some contextual data.
571
+ * - `verbose` - All available type information is captured, including detailed contextual data.
572
+ */
573
+ reflectionLevel?: ReflectionLevel;
574
+ }
575
+ type TSCompilerOptions = CompilerOptions & DeepkitOptions;
576
+ /**
577
+ * The TypeScript compiler configuration.
578
+ *
579
+ * @see https://www.typescriptlang.org/docs/handbook/tsconfig-json.html
580
+ */
581
+ interface TSConfig extends Omit<TsConfigJson, "reflection"> {
582
+ /**
583
+ * Either true to activate reflection for all files compiled using this tsconfig,
584
+ * or a list of globs/file paths relative to this tsconfig.json.
585
+ * Globs/file paths can be prefixed with a ! to exclude them.
586
+ */
587
+ reflection?: RawReflectionMode;
588
+ /**
589
+ * Defines the level of reflection to be used during the transpilation process.
590
+ *
591
+ * @remarks
592
+ * The level determines how much extra data is captured in the byte code for each type. This can be one of the following values:
593
+ * - `minimal` - Only the essential type information is captured.
594
+ * - `normal` - Additional type information is captured, including some contextual data.
595
+ * - `verbose` - All available type information is captured, including detailed contextual data.
596
+ */
597
+ reflectionLevel?: ReflectionLevel;
598
+ /**
599
+ * Instructs the TypeScript compiler how to compile `.ts` files.
600
+ */
601
+ compilerOptions?: TSCompilerOptions;
602
+ }
603
+ type ParsedTypeScriptConfig = ts.ParsedCommandLine & {
604
+ originalTsconfigJson: TsConfigJson;
605
+ tsconfigJson: TSConfig;
606
+ tsconfigFilePath: string;
607
+ };
608
+
594
609
  type LogFn = (type: LogLevelLabel, ...args: string[]) => void;
595
610
  /**
596
611
  * The {@link StormWorkspaceConfig | configuration} object for an entire Powerlines workspace
@@ -1138,7 +1153,7 @@ interface UnresolvedContext<TResolvedConfig extends ResolvedConfig = ResolvedCon
1138
1153
  * @param path - An optional path to write the builtin file to
1139
1154
  * @param options - Options for writing the file
1140
1155
  */
1141
- writeBuiltin: (code: string, id: string, path?: string, options?: PowerlinesWriteFileOptions) => Promise<void>;
1156
+ emitBuiltin: (code: string, id: string, path?: string, options?: PowerlinesWriteFileOptions) => Promise<void>;
1142
1157
  /**
1143
1158
  * Resolves a entry virtual file and writes it to the VFS if it does not already exist
1144
1159
  *
@@ -1146,11 +1161,7 @@ interface UnresolvedContext<TResolvedConfig extends ResolvedConfig = ResolvedCon
1146
1161
  * @param path - An optional path to write the entry file to
1147
1162
  * @param options - Options for writing the file
1148
1163
  */
1149
- writeEntry: (code: string, path: string, options?: PowerlinesWriteFileOptions) => Promise<void>;
1150
- /**
1151
- * Parses the source code and returns a {@link ParseResult} object.
1152
- */
1153
- parse: (code: string, id: string, options?: ParserOptions | null) => Promise<ParseResult>;
1164
+ emitEntry: (code: string, path: string, options?: PowerlinesWriteFileOptions) => Promise<void>;
1154
1165
  /**
1155
1166
  * A function to update the context fields using a new user configuration options
1156
1167
  */
@@ -1372,6 +1383,12 @@ type PluginHooks<TContext extends PluginContext = PluginContext> = {
1372
1383
  resolveId: PluginHook<(this: BuildPluginContext<TContext["config"]> & TContext, id: string, importer: string | undefined, options: {
1373
1384
  isEntry: boolean;
1374
1385
  }) => MaybePromise<string | ExternalIdResult | null | undefined>, "id">;
1386
+ /**
1387
+ * An API object that can be used for inter-plugin communication.
1388
+ *
1389
+ * @see https://rollupjs.org/plugin-development/#direct-plugin-communication
1390
+ */
1391
+ api?: Record<string, any>;
1375
1392
  };
1376
1393
  type PluginBuildPlugins<TContext extends PluginContext = PluginContext> = {
1377
1394
  [TBuildVariant in UnpluginBuildVariant]?: BuildPlugin<TContext, TBuildVariant>;
@@ -8,13 +8,11 @@ import { PreviewOptions, ResolvedPreviewOptions } from 'vite';
8
8
  import { EnvPaths } from '@stryke/env/get-env-paths';
9
9
  import { PackageJson } from '@stryke/types/package-json';
10
10
  import { Jiti } from 'jiti';
11
- import { ParserOptions, ParseResult } from 'oxc-parser';
12
11
  import { Range } from 'semver';
13
12
  import { UnpluginMessage, UnpluginContext, UnpluginBuildContext, TransformResult, ExternalIdResult, HookFilter, UnpluginOptions } from 'unplugin';
13
+ import { PathLike, StatSyncOptions, Stats, RmDirOptions, RmOptions, Mode, MakeDirectoryOptions as MakeDirectoryOptions$1, PathOrFileDescriptor, WriteFileOptions as WriteFileOptions$1 } from 'node:fs';
14
14
  import { TsConfigJson, CompilerOptions } from '@stryke/types/tsconfig';
15
15
  import ts from 'typescript';
16
- import { PrimitiveJsonValue } from '@stryke/json/types';
17
- import { PathLike, StatSyncOptions, Stats, RmDirOptions, RmOptions, Mode, MakeDirectoryOptions as MakeDirectoryOptions$1, PathOrFileDescriptor, WriteFileOptions as WriteFileOptions$1 } from 'node:fs';
18
16
  import { ArrayValues } from '@stryke/types/array';
19
17
  import { TypeDocOptions, Application, ProjectReflection } from 'typedoc';
20
18
 
@@ -154,87 +152,20 @@ interface BuildConfig {
154
152
  }
155
153
  type BuildResolvedConfig = Omit<BuildConfig, "override">;
156
154
 
157
- type ReflectionMode = "default" | "explicit" | "never";
158
- type RawReflectionMode = ReflectionMode | "" | boolean | string | string[] | undefined;
159
- /**
160
- * Defines the level of reflection to be used during the transpilation process.
161
- *
162
- * @remarks
163
- * The level determines how much extra data is captured in the byte code for each type. This can be one of the following values:
164
- * - `minimal` - Only the essential type information is captured.
165
- * - `normal` - Additional type information is captured, including some contextual data.
166
- * - `verbose` - All available type information is captured, including detailed contextual data.
167
- */
168
- type ReflectionLevel = "minimal" | "normal" | "verbose";
169
- interface DeepkitOptions {
170
- /**
171
- * Either true to activate reflection for all files compiled using this tsconfig,
172
- * or a list of globs/file paths relative to this tsconfig.json.
173
- * Globs/file paths can be prefixed with a ! to exclude them.
174
- */
175
- reflection?: RawReflectionMode;
176
- /**
177
- * Defines the level of reflection to be used during the transpilation process.
178
- *
179
- * @remarks
180
- * The level determines how much extra data is captured in the byte code for each type. This can be one of the following values:
181
- * - `minimal` - Only the essential type information is captured.
182
- * - `normal` - Additional type information is captured, including some contextual data.
183
- * - `verbose` - All available type information is captured, including detailed contextual data.
184
- */
185
- reflectionLevel?: ReflectionLevel;
186
- }
187
- type TSCompilerOptions = CompilerOptions & DeepkitOptions;
188
- /**
189
- * The TypeScript compiler configuration.
190
- *
191
- * @see https://www.typescriptlang.org/docs/handbook/tsconfig-json.html
192
- */
193
- interface TSConfig extends Omit<TsConfigJson, "reflection"> {
194
- /**
195
- * Either true to activate reflection for all files compiled using this tsconfig,
196
- * or a list of globs/file paths relative to this tsconfig.json.
197
- * Globs/file paths can be prefixed with a ! to exclude them.
198
- */
199
- reflection?: RawReflectionMode;
200
- /**
201
- * Defines the level of reflection to be used during the transpilation process.
202
- *
203
- * @remarks
204
- * The level determines how much extra data is captured in the byte code for each type. This can be one of the following values:
205
- * - `minimal` - Only the essential type information is captured.
206
- * - `normal` - Additional type information is captured, including some contextual data.
207
- * - `verbose` - All available type information is captured, including detailed contextual data.
208
- */
209
- reflectionLevel?: ReflectionLevel;
210
- /**
211
- * Instructs the TypeScript compiler how to compile `.ts` files.
212
- */
213
- compilerOptions?: TSCompilerOptions;
214
- }
215
- type ParsedTypeScriptConfig = ts.ParsedCommandLine & {
216
- originalTsconfigJson: TsConfigJson;
217
- tsconfigJson: TSConfig;
218
- tsconfigFilePath: string;
219
- };
220
-
221
155
  declare const __VFS_PATCH__ = "__VFS_PATCH__";
222
156
  declare const __VFS_REVERT__ = "__VFS_REVERT__";
223
157
  type OutputModeType = "fs" | "virtual";
224
- interface VirtualFile {
158
+ interface VirtualFileMetadata {
225
159
  /**
226
- * The unique identifier for the virtual file.
227
- *
228
- * @remarks
229
- * If no specific id is provided, it defaults to the file's {@link path}.
160
+ * The identifier for the file data.
230
161
  */
231
162
  id: string;
232
163
  /**
233
- * Additional metadata associated with the virtual file.
164
+ * The timestamp of the virtual file.
234
165
  */
235
- details: Record<string, PrimitiveJsonValue>;
166
+ timestamp: number;
236
167
  /**
237
- * The variant of the file.
168
+ * The type of the file.
238
169
  *
239
170
  * @remarks
240
171
  * This string represents the purpose/function of the file in the virtual file system. A potential list of variants includes:
@@ -242,52 +173,72 @@ interface VirtualFile {
242
173
  * - `entry`: Indicates that the file is an entry point for execution.
243
174
  * - `normal`: Indicates that the file is a standard file without any special role.
244
175
  */
245
- variant: string;
176
+ type: string;
246
177
  /**
247
178
  * The output mode of the file.
248
- *
249
- * @remarks
250
- * This indicates whether the file is intended to be written to the actual file system (`fs`) or kept in the virtual file system (`virtual`).
251
179
  */
252
- mode: OutputModeType;
253
- /**
254
- * A virtual (or actual) path to the file in the file system.
255
- */
256
- path: string;
180
+ mode: string;
257
181
  /**
258
- * The contents of the file.
182
+ * Additional metadata associated with the file.
259
183
  */
260
- code: string | NodeJS.ArrayBufferView;
184
+ properties: Record<string, string>;
261
185
  }
262
- interface VirtualFileMetadata {
186
+ interface VirtualFileData {
263
187
  /**
264
188
  * The identifier for the file data.
265
189
  */
266
- id: string;
190
+ id?: string;
267
191
  /**
268
- * The variant of the file.
192
+ * The contents of the virtual file.
193
+ */
194
+ code: string;
195
+ /**
196
+ * The type of the file.
197
+ *
198
+ * @remarks
199
+ * This string represents the purpose/function of the file in the virtual file system. A potential list of variants includes:
200
+ * - `builtin`: Indicates that the file is a built-in module provided by the system.
201
+ * - `entry`: Indicates that the file is an entry point for execution.
202
+ * - `chunk`: Indicates that the file is a code chunk, typically used in code-splitting scenarios.
203
+ * - `prebuilt-chunk`: Indicates that the file is a prebuilt code chunk.
204
+ * - `asset`: Indicates that the file is a static asset, such as an image or stylesheet.
205
+ * - `normal`: Indicates that the file is a standard file without any special role.
269
206
  */
270
- variant: string;
207
+ type?: string;
271
208
  /**
272
209
  * The output mode of the file.
273
210
  */
274
- mode: string;
211
+ mode?: string;
275
212
  /**
276
213
  * Additional metadata associated with the file.
277
214
  */
278
- properties: Record<string, string>;
215
+ properties?: Record<string, string>;
216
+ }
217
+ interface VirtualFile extends Required<VirtualFileData>, VirtualFileMetadata {
218
+ /**
219
+ * An additional name for the file.
220
+ */
221
+ path: string;
222
+ /**
223
+ * The timestamp of the virtual file.
224
+ */
225
+ timestamp: number;
279
226
  }
280
227
  interface ResolveFSOptions {
281
228
  mode?: OutputModeType;
282
229
  }
283
230
  type MakeDirectoryOptions = (Mode | MakeDirectoryOptions$1) & ResolveFSOptions;
284
231
  interface PowerlinesWriteFileOptions extends ResolveFSOptions {
232
+ /**
233
+ * Should the file skip formatting before being written?
234
+ *
235
+ * @defaultValue false
236
+ */
285
237
  skipFormat?: boolean;
286
238
  }
287
239
  type NodeWriteFileOptions = WriteFileOptions$1;
288
240
  type WriteFileOptions = NodeWriteFileOptions | PowerlinesWriteFileOptions;
289
- type PowerLinesWriteFileData = Partial<Omit<VirtualFile, "path" | "mode" | "code">> & Pick<VirtualFile, "code">;
290
- type WriteFileData = string | NodeJS.ArrayBufferView | PowerLinesWriteFileData;
241
+ type WriteFileData = string | NodeJS.ArrayBufferView | VirtualFileData;
291
242
  interface ResolvePathOptions extends ResolveFSOptions {
292
243
  /**
293
244
  * Should the resolved path include the file extension?
@@ -302,7 +253,7 @@ interface ResolvePathOptions extends ResolveFSOptions {
302
253
  /**
303
254
  * The type of the path to resolve.
304
255
  */
305
- type?: "file" | "directory";
256
+ pathType?: "file" | "directory";
306
257
  }
307
258
  interface VirtualFileSystemInterface {
308
259
  /**
@@ -591,6 +542,70 @@ interface VirtualFileSystemInterface {
591
542
  dispose: () => Promise<void>;
592
543
  }
593
544
 
545
+ type ReflectionMode = "default" | "explicit" | "never";
546
+ type RawReflectionMode = ReflectionMode | "" | boolean | string | string[] | undefined;
547
+ /**
548
+ * Defines the level of reflection to be used during the transpilation process.
549
+ *
550
+ * @remarks
551
+ * The level determines how much extra data is captured in the byte code for each type. This can be one of the following values:
552
+ * - `minimal` - Only the essential type information is captured.
553
+ * - `normal` - Additional type information is captured, including some contextual data.
554
+ * - `verbose` - All available type information is captured, including detailed contextual data.
555
+ */
556
+ type ReflectionLevel = "minimal" | "normal" | "verbose";
557
+ interface DeepkitOptions {
558
+ /**
559
+ * Either true to activate reflection for all files compiled using this tsconfig,
560
+ * or a list of globs/file paths relative to this tsconfig.json.
561
+ * Globs/file paths can be prefixed with a ! to exclude them.
562
+ */
563
+ reflection?: RawReflectionMode;
564
+ /**
565
+ * Defines the level of reflection to be used during the transpilation process.
566
+ *
567
+ * @remarks
568
+ * The level determines how much extra data is captured in the byte code for each type. This can be one of the following values:
569
+ * - `minimal` - Only the essential type information is captured.
570
+ * - `normal` - Additional type information is captured, including some contextual data.
571
+ * - `verbose` - All available type information is captured, including detailed contextual data.
572
+ */
573
+ reflectionLevel?: ReflectionLevel;
574
+ }
575
+ type TSCompilerOptions = CompilerOptions & DeepkitOptions;
576
+ /**
577
+ * The TypeScript compiler configuration.
578
+ *
579
+ * @see https://www.typescriptlang.org/docs/handbook/tsconfig-json.html
580
+ */
581
+ interface TSConfig extends Omit<TsConfigJson, "reflection"> {
582
+ /**
583
+ * Either true to activate reflection for all files compiled using this tsconfig,
584
+ * or a list of globs/file paths relative to this tsconfig.json.
585
+ * Globs/file paths can be prefixed with a ! to exclude them.
586
+ */
587
+ reflection?: RawReflectionMode;
588
+ /**
589
+ * Defines the level of reflection to be used during the transpilation process.
590
+ *
591
+ * @remarks
592
+ * The level determines how much extra data is captured in the byte code for each type. This can be one of the following values:
593
+ * - `minimal` - Only the essential type information is captured.
594
+ * - `normal` - Additional type information is captured, including some contextual data.
595
+ * - `verbose` - All available type information is captured, including detailed contextual data.
596
+ */
597
+ reflectionLevel?: ReflectionLevel;
598
+ /**
599
+ * Instructs the TypeScript compiler how to compile `.ts` files.
600
+ */
601
+ compilerOptions?: TSCompilerOptions;
602
+ }
603
+ type ParsedTypeScriptConfig = ts.ParsedCommandLine & {
604
+ originalTsconfigJson: TsConfigJson;
605
+ tsconfigJson: TSConfig;
606
+ tsconfigFilePath: string;
607
+ };
608
+
594
609
  type LogFn = (type: LogLevelLabel, ...args: string[]) => void;
595
610
  /**
596
611
  * The {@link StormWorkspaceConfig | configuration} object for an entire Powerlines workspace
@@ -1138,7 +1153,7 @@ interface UnresolvedContext<TResolvedConfig extends ResolvedConfig = ResolvedCon
1138
1153
  * @param path - An optional path to write the builtin file to
1139
1154
  * @param options - Options for writing the file
1140
1155
  */
1141
- writeBuiltin: (code: string, id: string, path?: string, options?: PowerlinesWriteFileOptions) => Promise<void>;
1156
+ emitBuiltin: (code: string, id: string, path?: string, options?: PowerlinesWriteFileOptions) => Promise<void>;
1142
1157
  /**
1143
1158
  * Resolves a entry virtual file and writes it to the VFS if it does not already exist
1144
1159
  *
@@ -1146,11 +1161,7 @@ interface UnresolvedContext<TResolvedConfig extends ResolvedConfig = ResolvedCon
1146
1161
  * @param path - An optional path to write the entry file to
1147
1162
  * @param options - Options for writing the file
1148
1163
  */
1149
- writeEntry: (code: string, path: string, options?: PowerlinesWriteFileOptions) => Promise<void>;
1150
- /**
1151
- * Parses the source code and returns a {@link ParseResult} object.
1152
- */
1153
- parse: (code: string, id: string, options?: ParserOptions | null) => Promise<ParseResult>;
1164
+ emitEntry: (code: string, path: string, options?: PowerlinesWriteFileOptions) => Promise<void>;
1154
1165
  /**
1155
1166
  * A function to update the context fields using a new user configuration options
1156
1167
  */
@@ -1372,6 +1383,12 @@ type PluginHooks<TContext extends PluginContext = PluginContext> = {
1372
1383
  resolveId: PluginHook<(this: BuildPluginContext<TContext["config"]> & TContext, id: string, importer: string | undefined, options: {
1373
1384
  isEntry: boolean;
1374
1385
  }) => MaybePromise<string | ExternalIdResult | null | undefined>, "id">;
1386
+ /**
1387
+ * An API object that can be used for inter-plugin communication.
1388
+ *
1389
+ * @see https://rollupjs.org/plugin-development/#direct-plugin-communication
1390
+ */
1391
+ api?: Record<string, any>;
1375
1392
  };
1376
1393
  type PluginBuildPlugins<TContext extends PluginContext = PluginContext> = {
1377
1394
  [TBuildVariant in UnpluginBuildVariant]?: BuildPlugin<TContext, TBuildVariant>;
package/dist/index.d.cts CHANGED
@@ -1,5 +1,5 @@
1
- import { T as TypeDocPluginOptions, P as Plugin, a as TypeDocPluginContext } from './index-BnEU-mki.cjs';
2
- export { G as GenerateDocsOptions, c as TypeDocPluginResolvedConfig, b as TypeDocPluginUserConfig, _ as __ΩGenerateDocsOptions, g as __ΩTypeDocPluginContext, d as __ΩTypeDocPluginOptions, f as __ΩTypeDocPluginResolvedConfig, e as __ΩTypeDocPluginUserConfig } from './index-BnEU-mki.cjs';
1
+ import { T as TypeDocPluginOptions, P as Plugin, a as TypeDocPluginContext } from './index-_2qlRtCD.cjs';
2
+ export { G as GenerateDocsOptions, c as TypeDocPluginResolvedConfig, b as TypeDocPluginUserConfig, _ as __ΩGenerateDocsOptions, g as __ΩTypeDocPluginContext, d as __ΩTypeDocPluginOptions, f as __ΩTypeDocPluginResolvedConfig, e as __ΩTypeDocPluginUserConfig } from './index-_2qlRtCD.cjs';
3
3
  import '@storm-software/build-tools/types';
4
4
  import '@storm-software/config-tools/types';
5
5
  import '@storm-software/config/types';
@@ -10,13 +10,11 @@ import 'vite';
10
10
  import '@stryke/env/get-env-paths';
11
11
  import '@stryke/types/package-json';
12
12
  import 'jiti';
13
- import 'oxc-parser';
14
13
  import 'semver';
15
14
  import 'unplugin';
15
+ import 'node:fs';
16
16
  import '@stryke/types/tsconfig';
17
17
  import 'typescript';
18
- import '@stryke/json/types';
19
- import 'node:fs';
20
18
  import '@stryke/types/array';
21
19
  import 'typedoc';
22
20
 
package/dist/index.d.ts CHANGED
@@ -1,5 +1,5 @@
1
- import { T as TypeDocPluginOptions, P as Plugin, a as TypeDocPluginContext } from './index-BnEU-mki.js';
2
- export { G as GenerateDocsOptions, c as TypeDocPluginResolvedConfig, b as TypeDocPluginUserConfig, _ as __ΩGenerateDocsOptions, g as __ΩTypeDocPluginContext, d as __ΩTypeDocPluginOptions, f as __ΩTypeDocPluginResolvedConfig, e as __ΩTypeDocPluginUserConfig } from './index-BnEU-mki.js';
1
+ import { T as TypeDocPluginOptions, P as Plugin, a as TypeDocPluginContext } from './index-_2qlRtCD.js';
2
+ export { G as GenerateDocsOptions, c as TypeDocPluginResolvedConfig, b as TypeDocPluginUserConfig, _ as __ΩGenerateDocsOptions, g as __ΩTypeDocPluginContext, d as __ΩTypeDocPluginOptions, f as __ΩTypeDocPluginResolvedConfig, e as __ΩTypeDocPluginUserConfig } from './index-_2qlRtCD.js';
3
3
  import '@storm-software/build-tools/types';
4
4
  import '@storm-software/config-tools/types';
5
5
  import '@storm-software/config/types';
@@ -10,13 +10,11 @@ import 'vite';
10
10
  import '@stryke/env/get-env-paths';
11
11
  import '@stryke/types/package-json';
12
12
  import 'jiti';
13
- import 'oxc-parser';
14
13
  import 'semver';
15
14
  import 'unplugin';
15
+ import 'node:fs';
16
16
  import '@stryke/types/tsconfig';
17
17
  import 'typescript';
18
- import '@stryke/json/types';
19
- import 'node:fs';
20
18
  import '@stryke/types/array';
21
19
  import 'typedoc';
22
20
 
@@ -1,4 +1,4 @@
1
- export { G as GenerateDocsOptions, a as TypeDocPluginContext, T as TypeDocPluginOptions, c as TypeDocPluginResolvedConfig, b as TypeDocPluginUserConfig, _ as __ΩGenerateDocsOptions, g as __ΩTypeDocPluginContext, d as __ΩTypeDocPluginOptions, f as __ΩTypeDocPluginResolvedConfig, e as __ΩTypeDocPluginUserConfig } from '../index-BnEU-mki.cjs';
1
+ export { G as GenerateDocsOptions, a as TypeDocPluginContext, T as TypeDocPluginOptions, c as TypeDocPluginResolvedConfig, b as TypeDocPluginUserConfig, _ as __ΩGenerateDocsOptions, g as __ΩTypeDocPluginContext, d as __ΩTypeDocPluginOptions, f as __ΩTypeDocPluginResolvedConfig, e as __ΩTypeDocPluginUserConfig } from '../index-_2qlRtCD.cjs';
2
2
  import '@storm-software/build-tools/types';
3
3
  import '@storm-software/config-tools/types';
4
4
  import '@storm-software/config/types';
@@ -9,12 +9,10 @@ import 'vite';
9
9
  import '@stryke/env/get-env-paths';
10
10
  import '@stryke/types/package-json';
11
11
  import 'jiti';
12
- import 'oxc-parser';
13
12
  import 'semver';
14
13
  import 'unplugin';
14
+ import 'node:fs';
15
15
  import '@stryke/types/tsconfig';
16
16
  import 'typescript';
17
- import '@stryke/json/types';
18
- import 'node:fs';
19
17
  import '@stryke/types/array';
20
18
  import 'typedoc';
@@ -1,4 +1,4 @@
1
- export { G as GenerateDocsOptions, a as TypeDocPluginContext, T as TypeDocPluginOptions, c as TypeDocPluginResolvedConfig, b as TypeDocPluginUserConfig, _ as __ΩGenerateDocsOptions, g as __ΩTypeDocPluginContext, d as __ΩTypeDocPluginOptions, f as __ΩTypeDocPluginResolvedConfig, e as __ΩTypeDocPluginUserConfig } from '../index-BnEU-mki.js';
1
+ export { G as GenerateDocsOptions, a as TypeDocPluginContext, T as TypeDocPluginOptions, c as TypeDocPluginResolvedConfig, b as TypeDocPluginUserConfig, _ as __ΩGenerateDocsOptions, g as __ΩTypeDocPluginContext, d as __ΩTypeDocPluginOptions, f as __ΩTypeDocPluginResolvedConfig, e as __ΩTypeDocPluginUserConfig } from '../index-_2qlRtCD.js';
2
2
  import '@storm-software/build-tools/types';
3
3
  import '@storm-software/config-tools/types';
4
4
  import '@storm-software/config/types';
@@ -9,12 +9,10 @@ import 'vite';
9
9
  import '@stryke/env/get-env-paths';
10
10
  import '@stryke/types/package-json';
11
11
  import 'jiti';
12
- import 'oxc-parser';
13
12
  import 'semver';
14
13
  import 'unplugin';
14
+ import 'node:fs';
15
15
  import '@stryke/types/tsconfig';
16
16
  import 'typescript';
17
- import '@stryke/json/types';
18
- import 'node:fs';
19
17
  import '@stryke/types/array';
20
18
  import 'typedoc';
@@ -1,4 +1,4 @@
1
- export { G as GenerateDocsOptions, a as TypeDocPluginContext, T as TypeDocPluginOptions, c as TypeDocPluginResolvedConfig, b as TypeDocPluginUserConfig, _ as __ΩGenerateDocsOptions, g as __ΩTypeDocPluginContext, d as __ΩTypeDocPluginOptions, f as __ΩTypeDocPluginResolvedConfig, e as __ΩTypeDocPluginUserConfig } from '../index-BnEU-mki.cjs';
1
+ export { G as GenerateDocsOptions, a as TypeDocPluginContext, T as TypeDocPluginOptions, c as TypeDocPluginResolvedConfig, b as TypeDocPluginUserConfig, _ as __ΩGenerateDocsOptions, g as __ΩTypeDocPluginContext, d as __ΩTypeDocPluginOptions, f as __ΩTypeDocPluginResolvedConfig, e as __ΩTypeDocPluginUserConfig } from '../index-_2qlRtCD.cjs';
2
2
  import 'typedoc';
3
3
  import '@storm-software/build-tools/types';
4
4
  import '@storm-software/config-tools/types';
@@ -10,11 +10,9 @@ import 'vite';
10
10
  import '@stryke/env/get-env-paths';
11
11
  import '@stryke/types/package-json';
12
12
  import 'jiti';
13
- import 'oxc-parser';
14
13
  import 'semver';
15
14
  import 'unplugin';
15
+ import 'node:fs';
16
16
  import '@stryke/types/tsconfig';
17
17
  import 'typescript';
18
- import '@stryke/json/types';
19
- import 'node:fs';
20
18
  import '@stryke/types/array';
@@ -1,4 +1,4 @@
1
- export { G as GenerateDocsOptions, a as TypeDocPluginContext, T as TypeDocPluginOptions, c as TypeDocPluginResolvedConfig, b as TypeDocPluginUserConfig, _ as __ΩGenerateDocsOptions, g as __ΩTypeDocPluginContext, d as __ΩTypeDocPluginOptions, f as __ΩTypeDocPluginResolvedConfig, e as __ΩTypeDocPluginUserConfig } from '../index-BnEU-mki.js';
1
+ export { G as GenerateDocsOptions, a as TypeDocPluginContext, T as TypeDocPluginOptions, c as TypeDocPluginResolvedConfig, b as TypeDocPluginUserConfig, _ as __ΩGenerateDocsOptions, g as __ΩTypeDocPluginContext, d as __ΩTypeDocPluginOptions, f as __ΩTypeDocPluginResolvedConfig, e as __ΩTypeDocPluginUserConfig } from '../index-_2qlRtCD.js';
2
2
  import 'typedoc';
3
3
  import '@storm-software/build-tools/types';
4
4
  import '@storm-software/config-tools/types';
@@ -10,11 +10,9 @@ import 'vite';
10
10
  import '@stryke/env/get-env-paths';
11
11
  import '@stryke/types/package-json';
12
12
  import 'jiti';
13
- import 'oxc-parser';
14
13
  import 'semver';
15
14
  import 'unplugin';
15
+ import 'node:fs';
16
16
  import '@stryke/types/tsconfig';
17
17
  import 'typescript';
18
- import '@stryke/json/types';
19
- import 'node:fs';
20
18
  import '@stryke/types/array';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@powerlines/plugin-typedoc",
3
- "version": "0.10.28",
3
+ "version": "0.10.29",
4
4
  "type": "module",
5
5
  "description": "A package containing a Powerlines plugin for running TypeDoc on the codebase.",
6
6
  "repository": {
@@ -88,19 +88,19 @@
88
88
  "files": ["dist/**/*"],
89
89
  "keywords": ["powerlines", "storm-software", "powerlines-plugin"],
90
90
  "dependencies": {
91
- "@storm-software/config-tools": "^1.188.42",
91
+ "@storm-software/config-tools": "^1.188.47",
92
92
  "@stryke/fs": "^0.32.13",
93
93
  "@stryke/path": "^0.19.2",
94
- "powerlines": "^0.23.3",
94
+ "powerlines": "^0.23.4",
95
95
  "typedoc": "0.25.12",
96
96
  "typedoc-plugin-markdown": "4.0.0-next.20"
97
97
  },
98
98
  "devDependencies": {
99
- "@powerlines/nx": "^0.10.20",
100
- "@storm-software/tsup": "^0.2.40",
99
+ "@powerlines/nx": "^0.10.21",
100
+ "@storm-software/tsup": "^0.2.45",
101
101
  "@types/node": "^24.10.1",
102
102
  "tsup": "8.4.0"
103
103
  },
104
104
  "publishConfig": { "access": "public" },
105
- "gitHead": "6e43200541ace2946694195c092642e7ac2f3098"
105
+ "gitHead": "3075c08893a66a4e8d359e37f8d0344b0a80322b"
106
106
  }