@nikovirtala/projen-constructs 0.2.0 → 0.2.1

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 (59) hide show
  1. package/.jsii +1405 -66
  2. package/docs/api/.nojekyll +1 -0
  3. package/docs/api/assets/hierarchy.js +1 -0
  4. package/docs/api/assets/highlight.css +99 -0
  5. package/docs/api/assets/icons.js +18 -0
  6. package/docs/api/assets/icons.svg +1 -0
  7. package/docs/api/assets/main.js +60 -0
  8. package/docs/api/assets/navigation.js +1 -0
  9. package/docs/api/assets/search.js +1 -0
  10. package/docs/api/assets/style.css +1633 -0
  11. package/docs/api/classes/AwsCdkConstructLibraryProject.html +308 -0
  12. package/docs/api/classes/AwsCdkTypeScriptAppProject.html +306 -0
  13. package/docs/api/classes/JsiiProject.html +294 -0
  14. package/docs/api/classes/ProjectGenerator.html +38 -0
  15. package/docs/api/classes/TypeDoc.html +37 -0
  16. package/docs/api/classes/TypeScriptProject.html +294 -0
  17. package/docs/api/classes/Vitest.html +38 -0
  18. package/docs/api/enums/CommentStyle.html +11 -0
  19. package/docs/api/enums/CoverageProvider.html +7 -0
  20. package/docs/api/enums/CoverageReporter.html +11 -0
  21. package/docs/api/enums/EntryPointStrategy.html +11 -0
  22. package/docs/api/enums/Environment.html +12 -0
  23. package/docs/api/enums/LogLevel.html +13 -0
  24. package/docs/api/enums/Pool.html +17 -0
  25. package/docs/api/enums/ProjectType.html +47 -0
  26. package/docs/api/enums/Visibility.html +9 -0
  27. package/docs/api/functions/applyDefaults.html +1 -0
  28. package/docs/api/functions/toJson_TypeDocConfiguration.html +2 -0
  29. package/docs/api/hierarchy.html +1 -0
  30. package/docs/api/index.html +86 -0
  31. package/docs/api/interfaces/AwsCdkConstructLibraryProjectOptions.html +1075 -0
  32. package/docs/api/interfaces/AwsCdkTypeScriptAppProjectOptions.html +1026 -0
  33. package/docs/api/interfaces/Component.html +13 -0
  34. package/docs/api/interfaces/ComponentOptions.html +8 -0
  35. package/docs/api/interfaces/JsiiProjectOptions.html +1003 -0
  36. package/docs/api/interfaces/ProjectGeneratorOptions.html +49 -0
  37. package/docs/api/interfaces/TypeDocConfiguration.html +141 -0
  38. package/docs/api/interfaces/TypeDocOptions.html +9 -0
  39. package/docs/api/interfaces/TypeScriptProjectOptions.html +899 -0
  40. package/docs/api/interfaces/ValidationOptions.html +9 -0
  41. package/docs/api/interfaces/VitestConfigOptions.html +111 -0
  42. package/docs/api/interfaces/VitestOptions.html +13 -0
  43. package/docs/api/modules.html +1 -0
  44. package/docs/api/variables/defaultOptions.html +1 -0
  45. package/docs/api/variables/defaults.html +1 -0
  46. package/docs/api/variables/projectDefaultOptions.html +1 -0
  47. package/lib/components/typedoc.js +5 -1
  48. package/lib/components/vitest.js +1 -1
  49. package/lib/index.d.ts +1 -0
  50. package/lib/index.js +2 -1
  51. package/lib/project-generator.js +1 -1
  52. package/lib/projects/awscdk-construct-library.generated.js +1 -1
  53. package/lib/projects/awscdk-typescript-app.generated.js +1 -1
  54. package/lib/projects/jsii-options.generated.d.ts +11 -1
  55. package/lib/projects/jsii-options.generated.js +1 -1
  56. package/lib/projects/jsii.generated.js +5 -4
  57. package/lib/projects/typescript.generated.js +1 -1
  58. package/package.json +3 -1
  59. package/typedoc.jsonc +10 -0
package/.jsii CHANGED
@@ -10373,6 +10373,52 @@
10373
10373
  ],
10374
10374
  "symbolId": "src/projects/awscdk-typescript-app-options.generated:AwsCdkTypeScriptAppProjectOptions"
10375
10375
  },
10376
+ "@nikovirtala/projen-constructs.CommentStyle": {
10377
+ "assembly": "@nikovirtala/projen-constructs",
10378
+ "docs": {
10379
+ "see": "https://typedoc.org/documents/Options.Comments.html#commentstyle",
10380
+ "stability": "stable",
10381
+ "summary": "Specifies the documentation mode TypeDoc should use."
10382
+ },
10383
+ "fqn": "@nikovirtala/projen-constructs.CommentStyle",
10384
+ "kind": "enum",
10385
+ "locationInModule": {
10386
+ "filename": "src/components/typedoc-config.ts",
10387
+ "line": 454
10388
+ },
10389
+ "members": [
10390
+ {
10391
+ "docs": {
10392
+ "stability": "stable",
10393
+ "summary": "Parse JSDoc style comments only."
10394
+ },
10395
+ "name": "JSDOC"
10396
+ },
10397
+ {
10398
+ "docs": {
10399
+ "stability": "stable",
10400
+ "summary": "Parse block comments."
10401
+ },
10402
+ "name": "BLOCK"
10403
+ },
10404
+ {
10405
+ "docs": {
10406
+ "stability": "stable",
10407
+ "summary": "Parse line comments (//)."
10408
+ },
10409
+ "name": "LINE"
10410
+ },
10411
+ {
10412
+ "docs": {
10413
+ "stability": "stable",
10414
+ "summary": "Parse all comment styles."
10415
+ },
10416
+ "name": "ALL"
10417
+ }
10418
+ ],
10419
+ "name": "CommentStyle",
10420
+ "symbolId": "src/components/typedoc-config:CommentStyle"
10421
+ },
10376
10422
  "@nikovirtala/projen-constructs.Component": {
10377
10423
  "assembly": "@nikovirtala/projen-constructs",
10378
10424
  "datatype": true,
@@ -10590,6 +10636,52 @@
10590
10636
  "name": "CoverageReporter",
10591
10637
  "symbolId": "src/components/vitest:CoverageReporter"
10592
10638
  },
10639
+ "@nikovirtala/projen-constructs.EntryPointStrategy": {
10640
+ "assembly": "@nikovirtala/projen-constructs",
10641
+ "docs": {
10642
+ "see": "https://typedoc.org/documents/Options.Input.html#entrypointstrategy",
10643
+ "stability": "stable",
10644
+ "summary": "Specifies the strategy to be used to convert entry points into documentation."
10645
+ },
10646
+ "fqn": "@nikovirtala/projen-constructs.EntryPointStrategy",
10647
+ "kind": "enum",
10648
+ "locationInModule": {
10649
+ "filename": "src/components/typedoc-config.ts",
10650
+ "line": 402
10651
+ },
10652
+ "members": [
10653
+ {
10654
+ "docs": {
10655
+ "stability": "stable",
10656
+ "summary": "Expects all entry points to be contained within a single package."
10657
+ },
10658
+ "name": "RESOLVE"
10659
+ },
10660
+ {
10661
+ "docs": {
10662
+ "stability": "stable",
10663
+ "summary": "Expects all entry points to be top-level directories."
10664
+ },
10665
+ "name": "EXPAND"
10666
+ },
10667
+ {
10668
+ "docs": {
10669
+ "stability": "stable",
10670
+ "summary": "Expects all entry points to be individual files."
10671
+ },
10672
+ "name": "PACKAGES"
10673
+ },
10674
+ {
10675
+ "docs": {
10676
+ "stability": "stable",
10677
+ "summary": "Merges multiple projects into a single documentation site."
10678
+ },
10679
+ "name": "MERGE"
10680
+ }
10681
+ ],
10682
+ "name": "EntryPointStrategy",
10683
+ "symbolId": "src/components/typedoc-config:EntryPointStrategy"
10684
+ },
10593
10685
  "@nikovirtala/projen-constructs.Environment": {
10594
10686
  "assembly": "@nikovirtala/projen-constructs",
10595
10687
  "docs": {
@@ -10652,7 +10744,7 @@
10652
10744
  },
10653
10745
  "locationInModule": {
10654
10746
  "filename": "src/projects/jsii.generated.ts",
10655
- "line": 20
10747
+ "line": 21
10656
10748
  },
10657
10749
  "parameters": [
10658
10750
  {
@@ -10669,7 +10761,7 @@
10669
10761
  "kind": "class",
10670
10762
  "locationInModule": {
10671
10763
  "filename": "src/projects/jsii.generated.ts",
10672
- "line": 16
10764
+ "line": 17
10673
10765
  },
10674
10766
  "name": "JsiiProject",
10675
10767
  "symbolId": "src/projects/jsii.generated:JsiiProject"
@@ -13291,6 +13383,42 @@
13291
13383
  "primitive": "string"
13292
13384
  }
13293
13385
  },
13386
+ {
13387
+ "abstract": true,
13388
+ "docs": {
13389
+ "default": "true",
13390
+ "stability": "stable",
13391
+ "summary": "Enable TypeDoc component."
13392
+ },
13393
+ "immutable": true,
13394
+ "locationInModule": {
13395
+ "filename": "src/projects/jsii-options.generated.ts",
13396
+ "line": 1067
13397
+ },
13398
+ "name": "typeDoc",
13399
+ "optional": true,
13400
+ "type": {
13401
+ "primitive": "boolean"
13402
+ }
13403
+ },
13404
+ {
13405
+ "abstract": true,
13406
+ "docs": {
13407
+ "default": "- default TypeDoc configuration",
13408
+ "stability": "stable",
13409
+ "summary": "TypeDoc configuration."
13410
+ },
13411
+ "immutable": true,
13412
+ "locationInModule": {
13413
+ "filename": "src/projects/jsii-options.generated.ts",
13414
+ "line": 1072
13415
+ },
13416
+ "name": "typeDocOptions",
13417
+ "optional": true,
13418
+ "type": {
13419
+ "fqn": "@nikovirtala/projen-constructs.TypeDocOptions"
13420
+ }
13421
+ },
13294
13422
  {
13295
13423
  "abstract": true,
13296
13424
  "docs": {
@@ -13554,6 +13682,59 @@
13554
13682
  ],
13555
13683
  "symbolId": "src/projects/jsii-options.generated:JsiiProjectOptions"
13556
13684
  },
13685
+ "@nikovirtala/projen-constructs.LogLevel": {
13686
+ "assembly": "@nikovirtala/projen-constructs",
13687
+ "docs": {
13688
+ "see": "https://typedoc.org/documents/Options.Other.html#loglevel",
13689
+ "stability": "stable",
13690
+ "summary": "Specifies the logger that should be used."
13691
+ },
13692
+ "fqn": "@nikovirtala/projen-constructs.LogLevel",
13693
+ "kind": "enum",
13694
+ "locationInModule": {
13695
+ "filename": "src/components/typedoc-config.ts",
13696
+ "line": 426
13697
+ },
13698
+ "members": [
13699
+ {
13700
+ "docs": {
13701
+ "stability": "stable",
13702
+ "summary": "Log all messages including verbose debug information."
13703
+ },
13704
+ "name": "VERBOSE"
13705
+ },
13706
+ {
13707
+ "docs": {
13708
+ "stability": "stable",
13709
+ "summary": "Log informational messages and above."
13710
+ },
13711
+ "name": "INFO"
13712
+ },
13713
+ {
13714
+ "docs": {
13715
+ "stability": "stable",
13716
+ "summary": "Log warnings and errors only."
13717
+ },
13718
+ "name": "WARN"
13719
+ },
13720
+ {
13721
+ "docs": {
13722
+ "stability": "stable",
13723
+ "summary": "Log errors only."
13724
+ },
13725
+ "name": "ERROR"
13726
+ },
13727
+ {
13728
+ "docs": {
13729
+ "stability": "stable",
13730
+ "summary": "Disable all logging."
13731
+ },
13732
+ "name": "NONE"
13733
+ }
13734
+ ],
13735
+ "name": "LogLevel",
13736
+ "symbolId": "src/components/typedoc-config:LogLevel"
13737
+ },
13557
13738
  "@nikovirtala/projen-constructs.Pool": {
13558
13739
  "assembly": "@nikovirtala/projen-constructs",
13559
13740
  "docs": {
@@ -13955,71 +14136,135 @@
13955
14136
  "name": "ProjectType",
13956
14137
  "symbolId": "src/project-type:ProjectType"
13957
14138
  },
13958
- "@nikovirtala/projen-constructs.TypeScriptProject": {
14139
+ "@nikovirtala/projen-constructs.TypeDoc": {
13959
14140
  "assembly": "@nikovirtala/projen-constructs",
13960
- "base": "projen.typescript.TypeScriptProject",
14141
+ "base": "projen.Component",
13961
14142
  "docs": {
13962
- "remarks": "Extends Projen's base class with opinionated defaults and automatic component setup.",
13963
14143
  "stability": "stable",
13964
- "summary": "TypeScriptProject with standard configuration and component integration."
14144
+ "summary": "TypeDoc component for projen projects."
13965
14145
  },
13966
- "fqn": "@nikovirtala/projen-constructs.TypeScriptProject",
14146
+ "fqn": "@nikovirtala/projen-constructs.TypeDoc",
13967
14147
  "initializer": {
13968
14148
  "docs": {
13969
14149
  "stability": "stable"
13970
14150
  },
13971
14151
  "locationInModule": {
13972
- "filename": "src/projects/typescript.generated.ts",
13973
- "line": 20
14152
+ "filename": "src/components/typedoc.ts",
14153
+ "line": 57
13974
14154
  },
13975
14155
  "parameters": [
13976
14156
  {
13977
- "docs": {
13978
- "summary": "- Project configuration."
13979
- },
14157
+ "name": "project",
14158
+ "type": {
14159
+ "fqn": "projen.javascript.NodeProject"
14160
+ }
14161
+ },
14162
+ {
13980
14163
  "name": "options",
14164
+ "optional": true,
13981
14165
  "type": {
13982
- "fqn": "@nikovirtala/projen-constructs.TypeScriptProjectOptions"
14166
+ "fqn": "@nikovirtala/projen-constructs.TypeDocOptions"
13983
14167
  }
13984
14168
  }
13985
14169
  ]
13986
14170
  },
13987
14171
  "kind": "class",
13988
14172
  "locationInModule": {
13989
- "filename": "src/projects/typescript.generated.ts",
13990
- "line": 16
14173
+ "filename": "src/components/typedoc.ts",
14174
+ "line": 39
13991
14175
  },
13992
- "name": "TypeScriptProject",
13993
- "symbolId": "src/projects/typescript.generated:TypeScriptProject"
14176
+ "methods": [
14177
+ {
14178
+ "docs": {
14179
+ "stability": "stable"
14180
+ },
14181
+ "locationInModule": {
14182
+ "filename": "src/components/typedoc.ts",
14183
+ "line": 40
14184
+ },
14185
+ "name": "of",
14186
+ "parameters": [
14187
+ {
14188
+ "name": "project",
14189
+ "type": {
14190
+ "fqn": "projen.Project"
14191
+ }
14192
+ }
14193
+ ],
14194
+ "returns": {
14195
+ "optional": true,
14196
+ "type": {
14197
+ "fqn": "@nikovirtala/projen-constructs.TypeDoc"
14198
+ }
14199
+ },
14200
+ "static": true
14201
+ }
14202
+ ],
14203
+ "name": "TypeDoc",
14204
+ "properties": [
14205
+ {
14206
+ "docs": {
14207
+ "stability": "stable",
14208
+ "summary": "TypeDoc configuration file."
14209
+ },
14210
+ "immutable": true,
14211
+ "locationInModule": {
14212
+ "filename": "src/components/typedoc.ts",
14213
+ "line": 55
14214
+ },
14215
+ "name": "file",
14216
+ "type": {
14217
+ "fqn": "projen.JsonFile"
14218
+ }
14219
+ },
14220
+ {
14221
+ "docs": {
14222
+ "stability": "stable",
14223
+ "summary": "TypeDoc task."
14224
+ },
14225
+ "immutable": true,
14226
+ "locationInModule": {
14227
+ "filename": "src/components/typedoc.ts",
14228
+ "line": 50
14229
+ },
14230
+ "name": "task",
14231
+ "type": {
14232
+ "fqn": "projen.Task"
14233
+ }
14234
+ }
14235
+ ],
14236
+ "symbolId": "src/components/typedoc:TypeDoc"
13994
14237
  },
13995
- "@nikovirtala/projen-constructs.TypeScriptProjectOptions": {
14238
+ "@nikovirtala/projen-constructs.TypeDocConfiguration": {
13996
14239
  "assembly": "@nikovirtala/projen-constructs",
13997
14240
  "datatype": true,
13998
14241
  "docs": {
14242
+ "see": "https://typedoc.org/options/",
13999
14243
  "stability": "stable",
14000
- "summary": "TypeScriptProjectOptions."
14244
+ "summary": "TypeDoc configuration."
14001
14245
  },
14002
- "fqn": "@nikovirtala/projen-constructs.TypeScriptProjectOptions",
14246
+ "fqn": "@nikovirtala/projen-constructs.TypeDocConfiguration",
14003
14247
  "kind": "interface",
14004
14248
  "locationInModule": {
14005
- "filename": "src/projects/typescript-options.generated.ts",
14006
- "line": 8
14249
+ "filename": "src/components/typedoc-config.ts",
14250
+ "line": 6
14007
14251
  },
14008
- "name": "TypeScriptProjectOptions",
14252
+ "name": "TypeDocConfiguration",
14009
14253
  "properties": [
14010
14254
  {
14011
14255
  "abstract": true,
14012
14256
  "docs": {
14013
- "default": "\"main\"",
14014
- "stability": "experimental",
14015
- "summary": "The name of the main release branch."
14257
+ "see": "https://typedoc.org/documents/Options.Output.html#basepath",
14258
+ "stability": "stable",
14259
+ "summary": "Specify the base path for all urls."
14016
14260
  },
14017
14261
  "immutable": true,
14018
14262
  "locationInModule": {
14019
- "filename": "src/projects/typescript-options.generated.ts",
14020
- "line": 312
14263
+ "filename": "src/components/typedoc-config.ts",
14264
+ "line": 82
14021
14265
  },
14022
- "name": "defaultReleaseBranch",
14266
+ "name": "basePath",
14267
+ "optional": true,
14023
14268
  "type": {
14024
14269
  "primitive": "string"
14025
14270
  }
@@ -14027,37 +14272,34 @@
14027
14272
  {
14028
14273
  "abstract": true,
14029
14274
  "docs": {
14030
- "custom": {
14031
- "featured": "true"
14032
- },
14033
- "default": "$BASEDIR",
14034
- "stability": "experimental",
14035
- "summary": "This is the name of your project."
14275
+ "see": "https://typedoc.org/documents/Options.Output.html#cachebust",
14276
+ "stability": "stable",
14277
+ "summary": "Include the generation time in links to prevent browsers from using a cached version."
14036
14278
  },
14037
14279
  "immutable": true,
14038
14280
  "locationInModule": {
14039
- "filename": "src/projects/typescript-options.generated.ts",
14040
- "line": 951
14281
+ "filename": "src/components/typedoc-config.ts",
14282
+ "line": 264
14041
14283
  },
14042
- "name": "name",
14284
+ "name": "cacheBust",
14285
+ "optional": true,
14043
14286
  "type": {
14044
- "primitive": "string"
14287
+ "primitive": "boolean"
14045
14288
  }
14046
14289
  },
14047
14290
  {
14048
14291
  "abstract": true,
14049
14292
  "docs": {
14050
- "default": "true",
14051
- "remarks": "This is normally only allowed for libraries. For apps, there's no meaning\nfor specifying these.",
14052
- "stability": "experimental",
14053
- "summary": "Allow the project to include `peerDependencies` and `bundledDependencies`."
14293
+ "see": "https://typedoc.org/documents/Options.Organization.html#categorizebygroup",
14294
+ "stability": "stable",
14295
+ "summary": "Specify the categories that will be used to group reflections."
14054
14296
  },
14055
14297
  "immutable": true,
14056
14298
  "locationInModule": {
14057
- "filename": "src/projects/typescript-options.generated.ts",
14058
- "line": 789
14299
+ "filename": "src/components/typedoc-config.ts",
14300
+ "line": 180
14059
14301
  },
14060
- "name": "allowLibraryDependencies",
14302
+ "name": "categorizeByGroup",
14061
14303
  "optional": true,
14062
14304
  "type": {
14063
14305
  "primitive": "boolean"
@@ -14066,46 +14308,1034 @@
14066
14308
  {
14067
14309
  "abstract": true,
14068
14310
  "docs": {
14069
- "default": "\"dist\"",
14070
- "stability": "experimental",
14071
- "summary": "A directory which will contain build artifacts."
14311
+ "see": "https://typedoc.org/documents/Options.Output.html#cleanoutputdir",
14312
+ "stability": "stable",
14313
+ "summary": "Prevent TypeDoc from cleaning the output directory specified with --out."
14072
14314
  },
14073
14315
  "immutable": true,
14074
14316
  "locationInModule": {
14075
- "filename": "src/projects/typescript-options.generated.ts",
14076
- "line": 306
14317
+ "filename": "src/components/typedoc-config.ts",
14318
+ "line": 96
14077
14319
  },
14078
- "name": "artifactsDirectory",
14320
+ "name": "cleanOutputDir",
14079
14321
  "optional": true,
14080
14322
  "type": {
14081
- "primitive": "string"
14323
+ "primitive": "boolean"
14082
14324
  }
14083
14325
  },
14084
14326
  {
14085
14327
  "abstract": true,
14086
14328
  "docs": {
14087
- "default": "false",
14088
- "remarks": "When enabled, creates an \"audit\" task that checks for known security vulnerabilities\nin dependencies. By default, runs during every build and checks for \"high\" severity\nvulnerabilities or above in all dependencies (including dev dependencies).",
14089
- "stability": "experimental",
14090
- "summary": "Run security audit on dependencies."
14329
+ "see": "https://typedoc.org/documents/Options.Comments.html#commentstyle",
14330
+ "stability": "stable",
14331
+ "summary": "Specify the documentation mode TypeDoc should use."
14091
14332
  },
14092
14333
  "immutable": true,
14093
14334
  "locationInModule": {
14094
- "filename": "src/projects/typescript-options.generated.ts",
14095
- "line": 300
14335
+ "filename": "src/components/typedoc-config.ts",
14336
+ "line": 152
14096
14337
  },
14097
- "name": "auditDeps",
14338
+ "name": "commentStyle",
14098
14339
  "optional": true,
14099
14340
  "type": {
14100
- "primitive": "boolean"
14341
+ "fqn": "@nikovirtala/projen-constructs.CommentStyle"
14101
14342
  }
14102
14343
  },
14103
14344
  {
14104
14345
  "abstract": true,
14105
14346
  "docs": {
14106
- "default": "- default options",
14107
- "stability": "experimental",
14108
- "summary": "Security audit options."
14347
+ "see": "https://typedoc.org/documents/Options.Organization.html#defaultcategory",
14348
+ "stability": "stable",
14349
+ "summary": "Specify the default category for reflections without a category."
14350
+ },
14351
+ "immutable": true,
14352
+ "locationInModule": {
14353
+ "filename": "src/components/typedoc-config.ts",
14354
+ "line": 166
14355
+ },
14356
+ "name": "defaultCategory",
14357
+ "optional": true,
14358
+ "type": {
14359
+ "primitive": "string"
14360
+ }
14361
+ },
14362
+ {
14363
+ "abstract": true,
14364
+ "docs": {
14365
+ "see": "https://typedoc.org/documents/Options.Organization.html#defaultgroup",
14366
+ "stability": "stable",
14367
+ "summary": "Specify the default group for reflections without a group."
14368
+ },
14369
+ "immutable": true,
14370
+ "locationInModule": {
14371
+ "filename": "src/components/typedoc-config.ts",
14372
+ "line": 173
14373
+ },
14374
+ "name": "defaultGroup",
14375
+ "optional": true,
14376
+ "type": {
14377
+ "primitive": "string"
14378
+ }
14379
+ },
14380
+ {
14381
+ "abstract": true,
14382
+ "docs": {
14383
+ "see": "https://typedoc.org/documents/Options.Comments.html#defaultvisibility",
14384
+ "stability": "stable",
14385
+ "summary": "Specify the default visibility for members without a visibility tag."
14386
+ },
14387
+ "immutable": true,
14388
+ "locationInModule": {
14389
+ "filename": "src/components/typedoc-config.ts",
14390
+ "line": 159
14391
+ },
14392
+ "name": "defaultVisibility",
14393
+ "optional": true,
14394
+ "type": {
14395
+ "fqn": "@nikovirtala/projen-constructs.Visibility"
14396
+ }
14397
+ },
14398
+ {
14399
+ "abstract": true,
14400
+ "docs": {
14401
+ "see": "https://typedoc.org/documents/Options.Comments.html#disablegit",
14402
+ "stability": "stable",
14403
+ "summary": "Disables setting the source of reflections when documenting projects within a Git repository."
14404
+ },
14405
+ "immutable": true,
14406
+ "locationInModule": {
14407
+ "filename": "src/components/typedoc-config.ts",
14408
+ "line": 243
14409
+ },
14410
+ "name": "disableGit",
14411
+ "optional": true,
14412
+ "type": {
14413
+ "primitive": "boolean"
14414
+ }
14415
+ },
14416
+ {
14417
+ "abstract": true,
14418
+ "docs": {
14419
+ "see": "https://typedoc.org/documents/Options.Comments.html#disablesources",
14420
+ "stability": "stable",
14421
+ "summary": "Disables automatically linking to source code."
14422
+ },
14423
+ "immutable": true,
14424
+ "locationInModule": {
14425
+ "filename": "src/components/typedoc-config.ts",
14426
+ "line": 236
14427
+ },
14428
+ "name": "disableSources",
14429
+ "optional": true,
14430
+ "type": {
14431
+ "primitive": "boolean"
14432
+ }
14433
+ },
14434
+ {
14435
+ "abstract": true,
14436
+ "docs": {
14437
+ "see": "https://typedoc.org/documents/Options.Input.html#entrypoints",
14438
+ "stability": "stable",
14439
+ "summary": "Specifies the entry points to be documented by TypeDoc."
14440
+ },
14441
+ "immutable": true,
14442
+ "locationInModule": {
14443
+ "filename": "src/components/typedoc-config.ts",
14444
+ "line": 12
14445
+ },
14446
+ "name": "entryPoints",
14447
+ "optional": true,
14448
+ "type": {
14449
+ "collection": {
14450
+ "elementtype": {
14451
+ "primitive": "string"
14452
+ },
14453
+ "kind": "array"
14454
+ }
14455
+ }
14456
+ },
14457
+ {
14458
+ "abstract": true,
14459
+ "docs": {
14460
+ "see": "https://typedoc.org/documents/Options.Input.html#entrypointstrategy",
14461
+ "stability": "stable",
14462
+ "summary": "Specifies the strategy to be used to convert entry points into documentation."
14463
+ },
14464
+ "immutable": true,
14465
+ "locationInModule": {
14466
+ "filename": "src/components/typedoc-config.ts",
14467
+ "line": 19
14468
+ },
14469
+ "name": "entryPointStrategy",
14470
+ "optional": true,
14471
+ "type": {
14472
+ "fqn": "@nikovirtala/projen-constructs.EntryPointStrategy"
14473
+ }
14474
+ },
14475
+ {
14476
+ "abstract": true,
14477
+ "docs": {
14478
+ "see": "https://typedoc.org/documents/Options.Input.html#exclude",
14479
+ "stability": "stable",
14480
+ "summary": "Define patterns to be excluded when expanding directories."
14481
+ },
14482
+ "immutable": true,
14483
+ "locationInModule": {
14484
+ "filename": "src/components/typedoc-config.ts",
14485
+ "line": 26
14486
+ },
14487
+ "name": "exclude",
14488
+ "optional": true,
14489
+ "type": {
14490
+ "collection": {
14491
+ "elementtype": {
14492
+ "primitive": "string"
14493
+ },
14494
+ "kind": "array"
14495
+ }
14496
+ }
14497
+ },
14498
+ {
14499
+ "abstract": true,
14500
+ "docs": {
14501
+ "see": "https://typedoc.org/documents/Options.Input.html#excludeexternals",
14502
+ "stability": "stable",
14503
+ "summary": "Prevent externally resolved symbols from being documented."
14504
+ },
14505
+ "immutable": true,
14506
+ "locationInModule": {
14507
+ "filename": "src/components/typedoc-config.ts",
14508
+ "line": 33
14509
+ },
14510
+ "name": "excludeExternals",
14511
+ "optional": true,
14512
+ "type": {
14513
+ "primitive": "boolean"
14514
+ }
14515
+ },
14516
+ {
14517
+ "abstract": true,
14518
+ "docs": {
14519
+ "see": "https://typedoc.org/documents/Options.Input.html#excludeinternal",
14520
+ "stability": "stable",
14521
+ "summary": "Prevent symbols that are not exported from being documented."
14522
+ },
14523
+ "immutable": true,
14524
+ "locationInModule": {
14525
+ "filename": "src/components/typedoc-config.ts",
14526
+ "line": 54
14527
+ },
14528
+ "name": "excludeInternal",
14529
+ "optional": true,
14530
+ "type": {
14531
+ "primitive": "boolean"
14532
+ }
14533
+ },
14534
+ {
14535
+ "abstract": true,
14536
+ "docs": {
14537
+ "see": "https://typedoc.org/documents/Options.Input.html#excludeprivate",
14538
+ "stability": "stable",
14539
+ "summary": "Prevent private members from being included in the generated documentation."
14540
+ },
14541
+ "immutable": true,
14542
+ "locationInModule": {
14543
+ "filename": "src/components/typedoc-config.ts",
14544
+ "line": 40
14545
+ },
14546
+ "name": "excludePrivate",
14547
+ "optional": true,
14548
+ "type": {
14549
+ "primitive": "boolean"
14550
+ }
14551
+ },
14552
+ {
14553
+ "abstract": true,
14554
+ "docs": {
14555
+ "see": "https://typedoc.org/documents/Options.Input.html#excludeprotected",
14556
+ "stability": "stable",
14557
+ "summary": "Prevent protected members from being included in the generated documentation."
14558
+ },
14559
+ "immutable": true,
14560
+ "locationInModule": {
14561
+ "filename": "src/components/typedoc-config.ts",
14562
+ "line": 47
14563
+ },
14564
+ "name": "excludeProtected",
14565
+ "optional": true,
14566
+ "type": {
14567
+ "primitive": "boolean"
14568
+ }
14569
+ },
14570
+ {
14571
+ "abstract": true,
14572
+ "docs": {
14573
+ "see": "https://typedoc.org/documents/Options.Input.html#externalpattern",
14574
+ "stability": "stable",
14575
+ "summary": "Define patterns for files that should be considered external."
14576
+ },
14577
+ "immutable": true,
14578
+ "locationInModule": {
14579
+ "filename": "src/components/typedoc-config.ts",
14580
+ "line": 320
14581
+ },
14582
+ "name": "externalPattern",
14583
+ "optional": true,
14584
+ "type": {
14585
+ "collection": {
14586
+ "elementtype": {
14587
+ "primitive": "string"
14588
+ },
14589
+ "kind": "array"
14590
+ }
14591
+ }
14592
+ },
14593
+ {
14594
+ "abstract": true,
14595
+ "docs": {
14596
+ "see": "https://typedoc.org/documents/Options.Comments.html#externalsymbollinkmappings",
14597
+ "stability": "stable",
14598
+ "summary": "Define custom mappings for symbols in external packages."
14599
+ },
14600
+ "immutable": true,
14601
+ "locationInModule": {
14602
+ "filename": "src/components/typedoc-config.ts",
14603
+ "line": 327
14604
+ },
14605
+ "name": "externalSymbolLinkMappings",
14606
+ "optional": true,
14607
+ "type": {
14608
+ "collection": {
14609
+ "elementtype": {
14610
+ "collection": {
14611
+ "elementtype": {
14612
+ "primitive": "string"
14613
+ },
14614
+ "kind": "map"
14615
+ }
14616
+ },
14617
+ "kind": "map"
14618
+ }
14619
+ }
14620
+ },
14621
+ {
14622
+ "abstract": true,
14623
+ "docs": {
14624
+ "see": "https://typedoc.org/documents/Options.Comments.html#gitremote",
14625
+ "stability": "stable",
14626
+ "summary": "Specify the git remote that should be used to link to source files."
14627
+ },
14628
+ "immutable": true,
14629
+ "locationInModule": {
14630
+ "filename": "src/components/typedoc-config.ts",
14631
+ "line": 222
14632
+ },
14633
+ "name": "gitRemote",
14634
+ "optional": true,
14635
+ "type": {
14636
+ "primitive": "string"
14637
+ }
14638
+ },
14639
+ {
14640
+ "abstract": true,
14641
+ "docs": {
14642
+ "see": "https://typedoc.org/documents/Options.Comments.html#gitrevision",
14643
+ "stability": "stable",
14644
+ "summary": "Specify the git revision that should be used to link to source files."
14645
+ },
14646
+ "immutable": true,
14647
+ "locationInModule": {
14648
+ "filename": "src/components/typedoc-config.ts",
14649
+ "line": 215
14650
+ },
14651
+ "name": "gitRevision",
14652
+ "optional": true,
14653
+ "type": {
14654
+ "primitive": "string"
14655
+ }
14656
+ },
14657
+ {
14658
+ "abstract": true,
14659
+ "docs": {
14660
+ "see": "https://typedoc.org/documents/Options.Output.html#hidegenerator",
14661
+ "stability": "stable",
14662
+ "summary": "Do not print the TypeDoc link at the end of the page."
14663
+ },
14664
+ "immutable": true,
14665
+ "locationInModule": {
14666
+ "filename": "src/components/typedoc-config.ts",
14667
+ "line": 250
14668
+ },
14669
+ "name": "hideGenerator",
14670
+ "optional": true,
14671
+ "type": {
14672
+ "primitive": "boolean"
14673
+ }
14674
+ },
14675
+ {
14676
+ "abstract": true,
14677
+ "docs": {
14678
+ "see": "https://typedoc.org/documents/Options.Output.html#hideparametertypesintitle",
14679
+ "stability": "stable",
14680
+ "summary": "Hide parameter types in the signature."
14681
+ },
14682
+ "immutable": true,
14683
+ "locationInModule": {
14684
+ "filename": "src/components/typedoc-config.ts",
14685
+ "line": 257
14686
+ },
14687
+ "name": "hideParameterTypesInTitle",
14688
+ "optional": true,
14689
+ "type": {
14690
+ "primitive": "boolean"
14691
+ }
14692
+ },
14693
+ {
14694
+ "abstract": true,
14695
+ "docs": {
14696
+ "see": "https://typedoc.org/documents/Options.Output.html#includes",
14697
+ "stability": "stable",
14698
+ "summary": "Specify the location to look for included documents."
14699
+ },
14700
+ "immutable": true,
14701
+ "locationInModule": {
14702
+ "filename": "src/components/typedoc-config.ts",
14703
+ "line": 103
14704
+ },
14705
+ "name": "includes",
14706
+ "optional": true,
14707
+ "type": {
14708
+ "primitive": "string"
14709
+ }
14710
+ },
14711
+ {
14712
+ "abstract": true,
14713
+ "docs": {
14714
+ "see": "https://typedoc.org/documents/Options.Validation.html#intentionallynotexported",
14715
+ "stability": "stable",
14716
+ "summary": "A list of types that should not produce warnings when not being exported."
14717
+ },
14718
+ "immutable": true,
14719
+ "locationInModule": {
14720
+ "filename": "src/components/typedoc-config.ts",
14721
+ "line": 313
14722
+ },
14723
+ "name": "intentionallyNotExported",
14724
+ "optional": true,
14725
+ "type": {
14726
+ "collection": {
14727
+ "elementtype": {
14728
+ "primitive": "string"
14729
+ },
14730
+ "kind": "array"
14731
+ }
14732
+ }
14733
+ },
14734
+ {
14735
+ "abstract": true,
14736
+ "docs": {
14737
+ "see": "https://typedoc.org/documents/Options.Output.html#json",
14738
+ "stability": "stable",
14739
+ "summary": "Specify the location the documentation should be written to."
14740
+ },
14741
+ "immutable": true,
14742
+ "locationInModule": {
14743
+ "filename": "src/components/typedoc-config.ts",
14744
+ "line": 68
14745
+ },
14746
+ "name": "json",
14747
+ "optional": true,
14748
+ "type": {
14749
+ "primitive": "string"
14750
+ }
14751
+ },
14752
+ {
14753
+ "abstract": true,
14754
+ "docs": {
14755
+ "see": "https://typedoc.org/documents/Options.Other.html#loglevel",
14756
+ "stability": "stable",
14757
+ "summary": "Specify the logger that should be used."
14758
+ },
14759
+ "immutable": true,
14760
+ "locationInModule": {
14761
+ "filename": "src/components/typedoc-config.ts",
14762
+ "line": 131
14763
+ },
14764
+ "name": "logLevel",
14765
+ "optional": true,
14766
+ "type": {
14767
+ "fqn": "@nikovirtala/projen-constructs.LogLevel"
14768
+ }
14769
+ },
14770
+ {
14771
+ "abstract": true,
14772
+ "docs": {
14773
+ "see": "https://typedoc.org/documents/Options.Output.html#media",
14774
+ "stability": "stable",
14775
+ "summary": "Specify the location with media files that should be copied to the output directory."
14776
+ },
14777
+ "immutable": true,
14778
+ "locationInModule": {
14779
+ "filename": "src/components/typedoc-config.ts",
14780
+ "line": 110
14781
+ },
14782
+ "name": "media",
14783
+ "optional": true,
14784
+ "type": {
14785
+ "primitive": "string"
14786
+ }
14787
+ },
14788
+ {
14789
+ "abstract": true,
14790
+ "docs": {
14791
+ "see": "https://typedoc.org/documents/Options.Output.html#name",
14792
+ "stability": "stable",
14793
+ "summary": "Set the name of the project that will be used in the header of the template."
14794
+ },
14795
+ "immutable": true,
14796
+ "locationInModule": {
14797
+ "filename": "src/components/typedoc-config.ts",
14798
+ "line": 89
14799
+ },
14800
+ "name": "name",
14801
+ "optional": true,
14802
+ "type": {
14803
+ "primitive": "string"
14804
+ }
14805
+ },
14806
+ {
14807
+ "abstract": true,
14808
+ "docs": {
14809
+ "see": "https://typedoc.org/documents/Options.Output.html#out",
14810
+ "stability": "stable",
14811
+ "summary": "Specifies the output directory the documentation should be written to."
14812
+ },
14813
+ "immutable": true,
14814
+ "locationInModule": {
14815
+ "filename": "src/components/typedoc-config.ts",
14816
+ "line": 61
14817
+ },
14818
+ "name": "out",
14819
+ "optional": true,
14820
+ "type": {
14821
+ "primitive": "string"
14822
+ }
14823
+ },
14824
+ {
14825
+ "abstract": true,
14826
+ "docs": {
14827
+ "see": "https://typedoc.org/documents/Options.Input.html#packagejson",
14828
+ "stability": "stable",
14829
+ "summary": "Specify the package.json file that should be used to determine the package name."
14830
+ },
14831
+ "immutable": true,
14832
+ "locationInModule": {
14833
+ "filename": "src/components/typedoc-config.ts",
14834
+ "line": 208
14835
+ },
14836
+ "name": "packageJson",
14837
+ "optional": true,
14838
+ "type": {
14839
+ "primitive": "string"
14840
+ }
14841
+ },
14842
+ {
14843
+ "abstract": true,
14844
+ "docs": {
14845
+ "see": "https://typedoc.org/documents/Options.Input.html#readme",
14846
+ "stability": "stable",
14847
+ "summary": "Specify the readme file that should be displayed on the index page."
14848
+ },
14849
+ "immutable": true,
14850
+ "locationInModule": {
14851
+ "filename": "src/components/typedoc-config.ts",
14852
+ "line": 201
14853
+ },
14854
+ "name": "readme",
14855
+ "optional": true,
14856
+ "type": {
14857
+ "primitive": "string"
14858
+ }
14859
+ },
14860
+ {
14861
+ "abstract": true,
14862
+ "docs": {
14863
+ "see": "https://typedoc.org/documents/Options.Validation.html#requiredtobedocumented",
14864
+ "stability": "stable",
14865
+ "summary": "Specify the type of reflections that must be documented."
14866
+ },
14867
+ "immutable": true,
14868
+ "locationInModule": {
14869
+ "filename": "src/components/typedoc-config.ts",
14870
+ "line": 292
14871
+ },
14872
+ "name": "requiredToBeDocumented",
14873
+ "optional": true,
14874
+ "type": {
14875
+ "collection": {
14876
+ "elementtype": {
14877
+ "primitive": "string"
14878
+ },
14879
+ "kind": "array"
14880
+ }
14881
+ }
14882
+ },
14883
+ {
14884
+ "abstract": true,
14885
+ "docs": {
14886
+ "see": "https://typedoc.org/documents/Options.Organization.html#searchcategoryboosts",
14887
+ "stability": "stable",
14888
+ "summary": "Specify the search category boosts."
14889
+ },
14890
+ "immutable": true,
14891
+ "locationInModule": {
14892
+ "filename": "src/components/typedoc-config.ts",
14893
+ "line": 194
14894
+ },
14895
+ "name": "searchCategoryBoosts",
14896
+ "optional": true,
14897
+ "type": {
14898
+ "collection": {
14899
+ "elementtype": {
14900
+ "primitive": "number"
14901
+ },
14902
+ "kind": "map"
14903
+ }
14904
+ }
14905
+ },
14906
+ {
14907
+ "abstract": true,
14908
+ "docs": {
14909
+ "see": "https://typedoc.org/documents/Options.Organization.html#searchgroupboosts",
14910
+ "stability": "stable",
14911
+ "summary": "Specify the search group boosts."
14912
+ },
14913
+ "immutable": true,
14914
+ "locationInModule": {
14915
+ "filename": "src/components/typedoc-config.ts",
14916
+ "line": 187
14917
+ },
14918
+ "name": "searchGroupBoosts",
14919
+ "optional": true,
14920
+ "type": {
14921
+ "collection": {
14922
+ "elementtype": {
14923
+ "primitive": "number"
14924
+ },
14925
+ "kind": "map"
14926
+ }
14927
+ }
14928
+ },
14929
+ {
14930
+ "abstract": true,
14931
+ "docs": {
14932
+ "see": "https://typedoc.org/documents/Options.Output.html#searchincomments",
14933
+ "stability": "stable",
14934
+ "summary": "If set, the search index will also include comments."
14935
+ },
14936
+ "immutable": true,
14937
+ "locationInModule": {
14938
+ "filename": "src/components/typedoc-config.ts",
14939
+ "line": 271
14940
+ },
14941
+ "name": "searchInComments",
14942
+ "optional": true,
14943
+ "type": {
14944
+ "primitive": "boolean"
14945
+ }
14946
+ },
14947
+ {
14948
+ "abstract": true,
14949
+ "docs": {
14950
+ "see": "https://typedoc.org/documents/Options.Output.html#searchindocuments",
14951
+ "stability": "stable",
14952
+ "summary": "If set, the search index will also include documents."
14953
+ },
14954
+ "immutable": true,
14955
+ "locationInModule": {
14956
+ "filename": "src/components/typedoc-config.ts",
14957
+ "line": 278
14958
+ },
14959
+ "name": "searchInDocuments",
14960
+ "optional": true,
14961
+ "type": {
14962
+ "primitive": "boolean"
14963
+ }
14964
+ },
14965
+ {
14966
+ "abstract": true,
14967
+ "docs": {
14968
+ "see": "https://typedoc.org/documents/Options.Organization.html#sort",
14969
+ "stability": "stable",
14970
+ "summary": "Specify the sort strategy for documented values."
14971
+ },
14972
+ "immutable": true,
14973
+ "locationInModule": {
14974
+ "filename": "src/components/typedoc-config.ts",
14975
+ "line": 138
14976
+ },
14977
+ "name": "sort",
14978
+ "optional": true,
14979
+ "type": {
14980
+ "collection": {
14981
+ "elementtype": {
14982
+ "primitive": "string"
14983
+ },
14984
+ "kind": "array"
14985
+ }
14986
+ }
14987
+ },
14988
+ {
14989
+ "abstract": true,
14990
+ "docs": {
14991
+ "see": "https://typedoc.org/documents/Options.Organization.html#sortentrypoints",
14992
+ "stability": "stable",
14993
+ "summary": "Specify the sort strategy for static and instance members."
14994
+ },
14995
+ "immutable": true,
14996
+ "locationInModule": {
14997
+ "filename": "src/components/typedoc-config.ts",
14998
+ "line": 145
14999
+ },
15000
+ "name": "sortEntryPoints",
15001
+ "optional": true,
15002
+ "type": {
15003
+ "primitive": "boolean"
15004
+ }
15005
+ },
15006
+ {
15007
+ "abstract": true,
15008
+ "docs": {
15009
+ "see": "https://typedoc.org/documents/Options.Input.html#sourcelinktemplate",
15010
+ "stability": "stable",
15011
+ "summary": "Specify a link template to be used when generating source urls."
15012
+ },
15013
+ "immutable": true,
15014
+ "locationInModule": {
15015
+ "filename": "src/components/typedoc-config.ts",
15016
+ "line": 229
15017
+ },
15018
+ "name": "sourceLinkTemplate",
15019
+ "optional": true,
15020
+ "type": {
15021
+ "primitive": "string"
15022
+ }
15023
+ },
15024
+ {
15025
+ "abstract": true,
15026
+ "docs": {
15027
+ "see": "https://typedoc.org/documents/Options.Output.html#theme",
15028
+ "stability": "stable",
15029
+ "summary": "Specify a theme name to use."
15030
+ },
15031
+ "immutable": true,
15032
+ "locationInModule": {
15033
+ "filename": "src/components/typedoc-config.ts",
15034
+ "line": 75
15035
+ },
15036
+ "name": "theme",
15037
+ "optional": true,
15038
+ "type": {
15039
+ "primitive": "string"
15040
+ }
15041
+ },
15042
+ {
15043
+ "abstract": true,
15044
+ "docs": {
15045
+ "see": "https://typedoc.org/documents/Options.Validation.html#treatvalidationwarningsaserrors",
15046
+ "stability": "stable",
15047
+ "summary": "If set, validation warnings will be treated as errors."
15048
+ },
15049
+ "immutable": true,
15050
+ "locationInModule": {
15051
+ "filename": "src/components/typedoc-config.ts",
15052
+ "line": 306
15053
+ },
15054
+ "name": "treatValidationWarningsAsErrors",
15055
+ "optional": true,
15056
+ "type": {
15057
+ "primitive": "boolean"
15058
+ }
15059
+ },
15060
+ {
15061
+ "abstract": true,
15062
+ "docs": {
15063
+ "see": "https://typedoc.org/documents/Options.Validation.html#treatwarningsaserrors",
15064
+ "stability": "stable",
15065
+ "summary": "If set, warnings will be treated as errors."
15066
+ },
15067
+ "immutable": true,
15068
+ "locationInModule": {
15069
+ "filename": "src/components/typedoc-config.ts",
15070
+ "line": 299
15071
+ },
15072
+ "name": "treatWarningsAsErrors",
15073
+ "optional": true,
15074
+ "type": {
15075
+ "primitive": "boolean"
15076
+ }
15077
+ },
15078
+ {
15079
+ "abstract": true,
15080
+ "docs": {
15081
+ "see": "https://typedoc.org/documents/Options.Input.html#tsbuildinfo",
15082
+ "stability": "stable",
15083
+ "summary": "Specify the location and filename a .tsbuildinfo file should be written to."
15084
+ },
15085
+ "immutable": true,
15086
+ "locationInModule": {
15087
+ "filename": "src/components/typedoc-config.ts",
15088
+ "line": 117
15089
+ },
15090
+ "name": "tsBuildInfo",
15091
+ "optional": true,
15092
+ "type": {
15093
+ "primitive": "string"
15094
+ }
15095
+ },
15096
+ {
15097
+ "abstract": true,
15098
+ "docs": {
15099
+ "see": "https://typedoc.org/documents/Options.Input.html#tsconfig",
15100
+ "stability": "stable",
15101
+ "summary": "Specify a TypeScript config file that should be used to load TypeScript configuration."
15102
+ },
15103
+ "immutable": true,
15104
+ "locationInModule": {
15105
+ "filename": "src/components/typedoc-config.ts",
15106
+ "line": 124
15107
+ },
15108
+ "name": "tsconfig",
15109
+ "optional": true,
15110
+ "type": {
15111
+ "primitive": "string"
15112
+ }
15113
+ },
15114
+ {
15115
+ "abstract": true,
15116
+ "docs": {
15117
+ "see": "https://typedoc.org/documents/Options.Validation.html",
15118
+ "stability": "stable",
15119
+ "summary": "Specify validation options."
15120
+ },
15121
+ "immutable": true,
15122
+ "locationInModule": {
15123
+ "filename": "src/components/typedoc-config.ts",
15124
+ "line": 285
15125
+ },
15126
+ "name": "validation",
15127
+ "optional": true,
15128
+ "type": {
15129
+ "fqn": "@nikovirtala/projen-constructs.ValidationOptions"
15130
+ }
15131
+ }
15132
+ ],
15133
+ "symbolId": "src/components/typedoc-config:TypeDocConfiguration"
15134
+ },
15135
+ "@nikovirtala/projen-constructs.TypeDocOptions": {
15136
+ "assembly": "@nikovirtala/projen-constructs",
15137
+ "datatype": true,
15138
+ "docs": {
15139
+ "stability": "stable"
15140
+ },
15141
+ "fqn": "@nikovirtala/projen-constructs.TypeDocOptions",
15142
+ "kind": "interface",
15143
+ "locationInModule": {
15144
+ "filename": "src/components/typedoc.ts",
15145
+ "line": 20
15146
+ },
15147
+ "name": "TypeDocOptions",
15148
+ "properties": [
15149
+ {
15150
+ "abstract": true,
15151
+ "docs": {
15152
+ "remarks": "This configuration will be merged with the default configuration",
15153
+ "stability": "stable",
15154
+ "summary": "Full TypeDoc configuration."
15155
+ },
15156
+ "immutable": true,
15157
+ "locationInModule": {
15158
+ "filename": "src/components/typedoc.ts",
15159
+ "line": 33
15160
+ },
15161
+ "name": "typeDocConfig",
15162
+ "optional": true,
15163
+ "type": {
15164
+ "fqn": "@nikovirtala/projen-constructs.TypeDocConfiguration"
15165
+ }
15166
+ },
15167
+ {
15168
+ "abstract": true,
15169
+ "docs": {
15170
+ "default": "\"^0.28\"",
15171
+ "stability": "stable",
15172
+ "summary": "Version of TypeDoc to use."
15173
+ },
15174
+ "immutable": true,
15175
+ "locationInModule": {
15176
+ "filename": "src/components/typedoc.ts",
15177
+ "line": 26
15178
+ },
15179
+ "name": "version",
15180
+ "optional": true,
15181
+ "type": {
15182
+ "primitive": "string"
15183
+ }
15184
+ }
15185
+ ],
15186
+ "symbolId": "src/components/typedoc:TypeDocOptions"
15187
+ },
15188
+ "@nikovirtala/projen-constructs.TypeScriptProject": {
15189
+ "assembly": "@nikovirtala/projen-constructs",
15190
+ "base": "projen.typescript.TypeScriptProject",
15191
+ "docs": {
15192
+ "remarks": "Extends Projen's base class with opinionated defaults and automatic component setup.",
15193
+ "stability": "stable",
15194
+ "summary": "TypeScriptProject with standard configuration and component integration."
15195
+ },
15196
+ "fqn": "@nikovirtala/projen-constructs.TypeScriptProject",
15197
+ "initializer": {
15198
+ "docs": {
15199
+ "stability": "stable"
15200
+ },
15201
+ "locationInModule": {
15202
+ "filename": "src/projects/typescript.generated.ts",
15203
+ "line": 20
15204
+ },
15205
+ "parameters": [
15206
+ {
15207
+ "docs": {
15208
+ "summary": "- Project configuration."
15209
+ },
15210
+ "name": "options",
15211
+ "type": {
15212
+ "fqn": "@nikovirtala/projen-constructs.TypeScriptProjectOptions"
15213
+ }
15214
+ }
15215
+ ]
15216
+ },
15217
+ "kind": "class",
15218
+ "locationInModule": {
15219
+ "filename": "src/projects/typescript.generated.ts",
15220
+ "line": 16
15221
+ },
15222
+ "name": "TypeScriptProject",
15223
+ "symbolId": "src/projects/typescript.generated:TypeScriptProject"
15224
+ },
15225
+ "@nikovirtala/projen-constructs.TypeScriptProjectOptions": {
15226
+ "assembly": "@nikovirtala/projen-constructs",
15227
+ "datatype": true,
15228
+ "docs": {
15229
+ "stability": "stable",
15230
+ "summary": "TypeScriptProjectOptions."
15231
+ },
15232
+ "fqn": "@nikovirtala/projen-constructs.TypeScriptProjectOptions",
15233
+ "kind": "interface",
15234
+ "locationInModule": {
15235
+ "filename": "src/projects/typescript-options.generated.ts",
15236
+ "line": 8
15237
+ },
15238
+ "name": "TypeScriptProjectOptions",
15239
+ "properties": [
15240
+ {
15241
+ "abstract": true,
15242
+ "docs": {
15243
+ "default": "\"main\"",
15244
+ "stability": "experimental",
15245
+ "summary": "The name of the main release branch."
15246
+ },
15247
+ "immutable": true,
15248
+ "locationInModule": {
15249
+ "filename": "src/projects/typescript-options.generated.ts",
15250
+ "line": 312
15251
+ },
15252
+ "name": "defaultReleaseBranch",
15253
+ "type": {
15254
+ "primitive": "string"
15255
+ }
15256
+ },
15257
+ {
15258
+ "abstract": true,
15259
+ "docs": {
15260
+ "custom": {
15261
+ "featured": "true"
15262
+ },
15263
+ "default": "$BASEDIR",
15264
+ "stability": "experimental",
15265
+ "summary": "This is the name of your project."
15266
+ },
15267
+ "immutable": true,
15268
+ "locationInModule": {
15269
+ "filename": "src/projects/typescript-options.generated.ts",
15270
+ "line": 951
15271
+ },
15272
+ "name": "name",
15273
+ "type": {
15274
+ "primitive": "string"
15275
+ }
15276
+ },
15277
+ {
15278
+ "abstract": true,
15279
+ "docs": {
15280
+ "default": "true",
15281
+ "remarks": "This is normally only allowed for libraries. For apps, there's no meaning\nfor specifying these.",
15282
+ "stability": "experimental",
15283
+ "summary": "Allow the project to include `peerDependencies` and `bundledDependencies`."
15284
+ },
15285
+ "immutable": true,
15286
+ "locationInModule": {
15287
+ "filename": "src/projects/typescript-options.generated.ts",
15288
+ "line": 789
15289
+ },
15290
+ "name": "allowLibraryDependencies",
15291
+ "optional": true,
15292
+ "type": {
15293
+ "primitive": "boolean"
15294
+ }
15295
+ },
15296
+ {
15297
+ "abstract": true,
15298
+ "docs": {
15299
+ "default": "\"dist\"",
15300
+ "stability": "experimental",
15301
+ "summary": "A directory which will contain build artifacts."
15302
+ },
15303
+ "immutable": true,
15304
+ "locationInModule": {
15305
+ "filename": "src/projects/typescript-options.generated.ts",
15306
+ "line": 306
15307
+ },
15308
+ "name": "artifactsDirectory",
15309
+ "optional": true,
15310
+ "type": {
15311
+ "primitive": "string"
15312
+ }
15313
+ },
15314
+ {
15315
+ "abstract": true,
15316
+ "docs": {
15317
+ "default": "false",
15318
+ "remarks": "When enabled, creates an \"audit\" task that checks for known security vulnerabilities\nin dependencies. By default, runs during every build and checks for \"high\" severity\nvulnerabilities or above in all dependencies (including dev dependencies).",
15319
+ "stability": "experimental",
15320
+ "summary": "Run security audit on dependencies."
15321
+ },
15322
+ "immutable": true,
15323
+ "locationInModule": {
15324
+ "filename": "src/projects/typescript-options.generated.ts",
15325
+ "line": 300
15326
+ },
15327
+ "name": "auditDeps",
15328
+ "optional": true,
15329
+ "type": {
15330
+ "primitive": "boolean"
15331
+ }
15332
+ },
15333
+ {
15334
+ "abstract": true,
15335
+ "docs": {
15336
+ "default": "- default options",
15337
+ "stability": "experimental",
15338
+ "summary": "Security audit options."
14109
15339
  },
14110
15340
  "immutable": true,
14111
15341
  "locationInModule": {
@@ -16614,6 +17844,115 @@
16614
17844
  ],
16615
17845
  "symbolId": "src/projects/typescript-options.generated:TypeScriptProjectOptions"
16616
17846
  },
17847
+ "@nikovirtala/projen-constructs.ValidationOptions": {
17848
+ "assembly": "@nikovirtala/projen-constructs",
17849
+ "datatype": true,
17850
+ "docs": {
17851
+ "see": "https://typedoc.org/documents/Options.Validation.html",
17852
+ "stability": "stable",
17853
+ "summary": "Validation options."
17854
+ },
17855
+ "fqn": "@nikovirtala/projen-constructs.ValidationOptions",
17856
+ "kind": "interface",
17857
+ "locationInModule": {
17858
+ "filename": "src/components/typedoc-config.ts",
17859
+ "line": 498
17860
+ },
17861
+ "name": "ValidationOptions",
17862
+ "properties": [
17863
+ {
17864
+ "abstract": true,
17865
+ "docs": {
17866
+ "stability": "stable",
17867
+ "summary": "If set, TypeDoc will produce warnings about \\@link tags which will produce broken links."
17868
+ },
17869
+ "immutable": true,
17870
+ "locationInModule": {
17871
+ "filename": "src/components/typedoc-config.ts",
17872
+ "line": 510
17873
+ },
17874
+ "name": "invalidLink",
17875
+ "optional": true,
17876
+ "type": {
17877
+ "primitive": "boolean"
17878
+ }
17879
+ },
17880
+ {
17881
+ "abstract": true,
17882
+ "docs": {
17883
+ "stability": "stable",
17884
+ "summary": "If set, TypeDoc will produce warnings when an exported symbol is not documented."
17885
+ },
17886
+ "immutable": true,
17887
+ "locationInModule": {
17888
+ "filename": "src/components/typedoc-config.ts",
17889
+ "line": 506
17890
+ },
17891
+ "name": "notDocumented",
17892
+ "optional": true,
17893
+ "type": {
17894
+ "primitive": "boolean"
17895
+ }
17896
+ },
17897
+ {
17898
+ "abstract": true,
17899
+ "docs": {
17900
+ "stability": "stable",
17901
+ "summary": "If set, TypeDoc will produce warnings when a symbol is referenced by the documentation."
17902
+ },
17903
+ "immutable": true,
17904
+ "locationInModule": {
17905
+ "filename": "src/components/typedoc-config.ts",
17906
+ "line": 502
17907
+ },
17908
+ "name": "notExported",
17909
+ "optional": true,
17910
+ "type": {
17911
+ "primitive": "boolean"
17912
+ }
17913
+ }
17914
+ ],
17915
+ "symbolId": "src/components/typedoc-config:ValidationOptions"
17916
+ },
17917
+ "@nikovirtala/projen-constructs.Visibility": {
17918
+ "assembly": "@nikovirtala/projen-constructs",
17919
+ "docs": {
17920
+ "see": "https://typedoc.org/documents/Options.Comments.html#defaultvisibility",
17921
+ "stability": "stable",
17922
+ "summary": "Specifies the default visibility for members without a visibility tag."
17923
+ },
17924
+ "fqn": "@nikovirtala/projen-constructs.Visibility",
17925
+ "kind": "enum",
17926
+ "locationInModule": {
17927
+ "filename": "src/components/typedoc-config.ts",
17928
+ "line": 478
17929
+ },
17930
+ "members": [
17931
+ {
17932
+ "docs": {
17933
+ "stability": "stable",
17934
+ "summary": "Public visibility - accessible from anywhere."
17935
+ },
17936
+ "name": "PUBLIC"
17937
+ },
17938
+ {
17939
+ "docs": {
17940
+ "stability": "stable",
17941
+ "summary": "Protected visibility - accessible from class and subclasses."
17942
+ },
17943
+ "name": "PROTECTED"
17944
+ },
17945
+ {
17946
+ "docs": {
17947
+ "stability": "stable",
17948
+ "summary": "Private visibility - accessible only within the class."
17949
+ },
17950
+ "name": "PRIVATE"
17951
+ }
17952
+ ],
17953
+ "name": "Visibility",
17954
+ "symbolId": "src/components/typedoc-config:Visibility"
17955
+ },
16617
17956
  "@nikovirtala/projen-constructs.Vitest": {
16618
17957
  "assembly": "@nikovirtala/projen-constructs",
16619
17958
  "base": "projen.Component",
@@ -17247,6 +18586,6 @@
17247
18586
  "symbolId": "src/components/vitest:VitestOptions"
17248
18587
  }
17249
18588
  },
17250
- "version": "0.2.0",
17251
- "fingerprint": "xuX563zrmTKL1EVuZhYRywKnsCFqGf4m29DJkKiXN64="
18589
+ "version": "0.2.1",
18590
+ "fingerprint": "MmJoALhvzUbdxIS5uwcMqwuIdmw3FXeDKbXv6f4v3ao="
17252
18591
  }