@resistdesign/voltra 3.0.0-alpha.3 → 3.0.0-alpha.30

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 (393) hide show
  1. package/README.md +330 -7
  2. package/api/DBX/DBXAsserts.d.ts +95 -0
  3. package/api/DBX/DBXRequest.d.ts +5 -0
  4. package/api/DBX/DBXRuntime.d.ts +5 -0
  5. package/api/DBX/DBXScenarioConfig.d.ts +9 -0
  6. package/api/DBX/DBXSeed.d.ts +124 -0
  7. package/api/DBX/DBXTypes.d.ts +176 -0
  8. package/api/DBX/index.d.ts +8 -0
  9. package/api/DataAccessControl.d.ts +220 -0
  10. package/api/Indexing/API.d.ts +224 -0
  11. package/api/Indexing/Cursor.d.ts +101 -0
  12. package/api/Indexing/Handler/Config.d.ts +39 -0
  13. package/api/Indexing/Handler.d.ts +166 -0
  14. package/api/Indexing/Trace.d.ts +54 -0
  15. package/api/Indexing/Types.d.ts +204 -0
  16. package/api/Indexing/ddb/AwsSdkV3Adapter.d.ts +8 -0
  17. package/api/Indexing/ddb/Types.d.ts +169 -0
  18. package/api/Indexing/docId.d.ts +27 -0
  19. package/api/Indexing/exact/ExactDdb.d.ts +58 -0
  20. package/api/Indexing/exact/ExactIndex.d.ts +90 -0
  21. package/api/Indexing/exact/ExactS3.d.ts +41 -0
  22. package/api/Indexing/fieldQualification.d.ts +12 -0
  23. package/api/Indexing/fulltext/FullTextDdbBackend.d.ts +210 -0
  24. package/api/Indexing/fulltext/FullTextMemoryBackend.d.ts +93 -0
  25. package/api/Indexing/fulltext/Schema.d.ts +164 -0
  26. package/api/Indexing/hashUniversal.d.ts +13 -0
  27. package/api/Indexing/index.d.ts +45 -0
  28. package/api/Indexing/lossy/LossyDdb.d.ts +43 -0
  29. package/api/Indexing/lossy/LossyIndex.d.ts +72 -0
  30. package/api/Indexing/lossy/LossyS3.d.ts +40 -0
  31. package/api/Indexing/rel/Cursor.d.ts +25 -0
  32. package/api/Indexing/rel/Handlers.d.ts +143 -0
  33. package/api/Indexing/rel/RelationalDdb.d.ts +169 -0
  34. package/api/Indexing/rel/RelationalInMemoryBackend.d.ts +38 -0
  35. package/api/Indexing/rel/Types.d.ts +69 -0
  36. package/api/Indexing/structured/Cursor.d.ts +26 -0
  37. package/api/Indexing/structured/Handlers.d.ts +128 -0
  38. package/api/Indexing/structured/SearchStructured.d.ts +44 -0
  39. package/api/Indexing/structured/StructuredDdb.d.ts +166 -0
  40. package/api/Indexing/structured/StructuredDdbBackend.d.ts +109 -0
  41. package/api/Indexing/structured/StructuredInMemoryBackend.d.ts +34 -0
  42. package/api/Indexing/structured/StructuredInMemoryIndex.d.ts +58 -0
  43. package/api/Indexing/structured/StructuredStringLike.d.ts +25 -0
  44. package/api/Indexing/structured/StructuredWriter.d.ts +61 -0
  45. package/api/Indexing/structured/Types.d.ts +126 -0
  46. package/api/Indexing/structured/index.d.ts +9 -0
  47. package/api/Indexing/tokenize.d.ts +31 -0
  48. package/api/ORM/DACUtils.d.ts +270 -0
  49. package/api/ORM/ListItemUtils.d.ts +40 -0
  50. package/api/ORM/ORMRouteMap.d.ts +55 -0
  51. package/api/ORM/TypeInfoORMService.d.ts +555 -0
  52. package/api/ORM/drivers/DynamoDBDataItemDBDriver/ConfigTypes.d.ts +229 -0
  53. package/api/ORM/drivers/DynamoDBDataItemDBDriver.d.ts +89 -0
  54. package/api/ORM/drivers/InMemoryDataItemDBDriver/ConfigTypes.d.ts +4 -0
  55. package/api/ORM/drivers/InMemoryDataItemDBDriver.d.ts +55 -0
  56. package/api/ORM/drivers/InMemoryFileItemDBDriver/ConfigTypes.d.ts +13 -0
  57. package/api/ORM/drivers/InMemoryFileItemDBDriver.d.ts +98 -0
  58. package/api/ORM/drivers/InMemoryItemRelationshipDBDriver.d.ts +16 -0
  59. package/api/ORM/drivers/IndexingRelationshipDriver.d.ts +123 -0
  60. package/api/ORM/drivers/S3FileItemDBDriver/ConfigTypes.d.ts +322 -0
  61. package/api/ORM/drivers/S3FileItemDBDriver/S3FileDriver.d.ts +118 -0
  62. package/{src/api → api}/ORM/drivers/S3FileItemDBDriver.d.ts +27 -0
  63. package/api/ORM/drivers/common/SupportedTypeInfoORMDBDrivers.d.ts +36 -0
  64. package/{src/api → api}/ORM/drivers/common/Types.d.ts +120 -0
  65. package/api/ORM/drivers/common/index.d.ts +12 -0
  66. package/api/ORM/drivers/index.d.ts +22 -0
  67. package/api/ORM/index.d.ts +33 -0
  68. package/api/ORM/indexing/criteriaToStructuredWhere.d.ts +17 -0
  69. package/api/Router/AWS.d.ts +80 -0
  70. package/api/Router/Auth.d.ts +14 -0
  71. package/api/Router/CORS.d.ts +66 -0
  72. package/api/Router/Types.d.ts +138 -0
  73. package/api/Router/index.d.ts +89 -0
  74. package/api/index.d.ts +72 -0
  75. package/api/index.js +8827 -0
  76. package/app/forms/Engine.d.ts +20 -0
  77. package/app/forms/UI.d.ts +73 -0
  78. package/app/forms/core/createAutoField.d.ts +35 -0
  79. package/app/forms/core/createFormRenderer.d.ts +24 -0
  80. package/app/forms/core/getFieldKind.d.ts +14 -0
  81. package/app/forms/core/index.d.ts +16 -0
  82. package/app/forms/core/mergeSuites.d.ts +22 -0
  83. package/app/forms/core/resolveSuite.d.ts +14 -0
  84. package/app/forms/core/types.d.ts +169 -0
  85. package/app/forms/index.d.ts +15 -0
  86. package/app/forms/types.d.ts +156 -0
  87. package/app/helpers/styled.d.ts +3 -0
  88. package/app/index.d.ts +102 -0
  89. package/app/index.js +560 -0
  90. package/{src/app → app}/utils/ApplicationState.d.ts +115 -0
  91. package/{src/app → app}/utils/ApplicationStateLoader.d.ts +40 -0
  92. package/app/utils/Controller.d.ts +10 -0
  93. package/app/utils/Debug.d.ts +14 -0
  94. package/app/utils/EasyLayout.d.ts +89 -0
  95. package/app/utils/History.d.ts +165 -0
  96. package/app/utils/Route.d.ts +158 -0
  97. package/app/utils/RouteHistory.d.ts +26 -0
  98. package/app/utils/Service.d.ts +45 -0
  99. package/app/utils/TypeInfoORMAPIUtils.d.ts +94 -0
  100. package/app/utils/TypeInfoORMClient.d.ts +103 -0
  101. package/app/utils/UniversalRouteAdapter.d.ts +73 -0
  102. package/app/utils/easy-layout/computeAreaBounds.d.ts +5 -0
  103. package/app/utils/easy-layout/computeTracks.d.ts +16 -0
  104. package/app/utils/easy-layout/index.d.ts +5 -0
  105. package/app/utils/easy-layout/parseTemplate.d.ts +12 -0
  106. package/app/utils/easy-layout/types.d.ts +52 -0
  107. package/app/utils/easy-layout/validateAreas.d.ts +5 -0
  108. package/app/utils/index.d.ts +39 -0
  109. package/{src/common/TypeParsing → build}/TypeMapping.d.ts +8 -0
  110. package/build/TypeParsing.d.ts +10 -0
  111. package/build/index.d.ts +15 -0
  112. package/build/index.js +569 -0
  113. package/chunk-ATO2455Q.js +258 -0
  114. package/chunk-FQMZMCXU.js +71 -0
  115. package/chunk-G5CLUK4Y.js +621 -0
  116. package/chunk-GYWRAW3Y.js +78 -0
  117. package/chunk-HVY7POTD.js +22 -0
  118. package/chunk-I2KLQ2HA.js +19 -0
  119. package/chunk-IWRHGGGH.js +10 -0
  120. package/chunk-LGM75I6P.js +353 -0
  121. package/chunk-MUCSL3UR.js +1 -0
  122. package/chunk-WELZGQDJ.js +456 -0
  123. package/common/CommandLine/collectRequiredEnvironmentVariables.d.ts +9 -0
  124. package/common/CommandLine/index.d.ts +6 -0
  125. package/common/HelperTypes.d.ts +9 -0
  126. package/common/IdGeneration/getSimpleId.d.ts +8 -0
  127. package/{src/common → common}/ItemRelationshipInfoTypes.d.ts +19 -1
  128. package/common/ItemRelationships/ItemRelationshipValidation.d.ts +21 -0
  129. package/common/ItemRelationships/index.d.ts +6 -0
  130. package/common/Logging/Utils.d.ts +19 -0
  131. package/common/Routing.d.ts +67 -0
  132. package/common/SearchTypes.d.ts +248 -0
  133. package/common/SearchUtils.d.ts +55 -0
  134. package/{src/common → common}/SearchValidation.d.ts +10 -0
  135. package/{src/common → common}/StringTransformers.d.ts +11 -0
  136. package/common/Testing/CLI.d.ts +6 -0
  137. package/common/Testing/CLI.js +432 -0
  138. package/{src/common → common}/Testing/Types.d.ts +103 -4
  139. package/{src/common → common}/Testing/Utils.d.ts +65 -1
  140. package/common/Testing/index.d.ts +8 -0
  141. package/common/TypeInfoDataItemUtils.d.ts +39 -0
  142. package/common/TypeInfoORM/Types.d.ts +342 -0
  143. package/common/TypeInfoORM/index.d.ts +11 -0
  144. package/common/TypeParsing/Constants.d.ts +4 -0
  145. package/{src/common → common}/TypeParsing/ParsingUtils/Constants.d.ts +3 -0
  146. package/{src/common → common}/TypeParsing/ParsingUtils/checkType.d.ts +6 -0
  147. package/{src/common → common}/TypeParsing/ParsingUtils/checkUnionType.d.ts +6 -0
  148. package/common/TypeParsing/ParsingUtils/extractCommentTags.d.ts +8 -0
  149. package/common/TypeParsing/ParsingUtils/extractLiteralValues.d.ts +12 -0
  150. package/common/TypeParsing/ParsingUtils/extractTypeDetails.d.ts +14 -0
  151. package/common/TypeParsing/ParsingUtils/getPrimaryFieldForTypeInfo.d.ts +18 -0
  152. package/common/TypeParsing/ParsingUtils/getTypeInfo.d.ts +9 -0
  153. package/{src/common → common}/TypeParsing/ParsingUtils/getTypeInfoField.d.ts +6 -0
  154. package/common/TypeParsing/ParsingUtils/getTypeInfoFromAliasType.d.ts +11 -0
  155. package/common/TypeParsing/ParsingUtils/getTypeInfoFromFieldFilter.d.ts +12 -0
  156. package/common/TypeParsing/ParsingUtils/getTypeInfoFromTypeAlias.d.ts +11 -0
  157. package/common/TypeParsing/ParsingUtils/getTypeKeyword.d.ts +9 -0
  158. package/common/TypeParsing/ParsingUtils/getUnionOrIntersectionTypeInfo.d.ts +11 -0
  159. package/common/TypeParsing/ParsingUtils/getUnionOrLiteralStringValues.d.ts +8 -0
  160. package/{src/common → common}/TypeParsing/TypeInfo.d.ts +61 -1
  161. package/{src/common → common}/TypeParsing/Utils.d.ts +26 -0
  162. package/{src/common → common}/TypeParsing/Validation.d.ts +105 -0
  163. package/common/TypeParsing/index.d.ts +8 -0
  164. package/common/index.d.ts +50 -0
  165. package/common/index.js +36 -0
  166. package/{src/iac → iac}/SimpleCFT.d.ts +46 -2
  167. package/iac/index.d.ts +40 -0
  168. package/iac/index.js +2 -0
  169. package/iac/packs/auth/user-management.d.ts +82 -0
  170. package/iac/packs/auth.d.ts +88 -0
  171. package/iac/packs/build/utils.d.ts +289 -0
  172. package/iac/packs/build.d.ts +92 -0
  173. package/iac/packs/cdn.d.ts +33 -0
  174. package/iac/packs/cloud-function.d.ts +67 -0
  175. package/{src/iac → iac}/packs/database.d.ts +4 -1
  176. package/{src/iac → iac}/packs/dns.d.ts +22 -1
  177. package/iac/packs/file-storage.d.ts +46 -0
  178. package/iac/packs/gateway.d.ts +79 -0
  179. package/iac/packs/index.d.ts +60 -0
  180. package/iac/packs/index.js +1370 -0
  181. package/iac/packs/repo.d.ts +28 -0
  182. package/iac/packs/ssl-certificate.d.ts +28 -0
  183. package/{src/iac → iac}/types/Constants.d.ts +15 -0
  184. package/iac/types/Renderers.d.ts +96 -0
  185. package/iac/types/Types.d.ts +131 -0
  186. package/iac/types/Utils.d.ts +9 -0
  187. package/{src/iac → iac}/utils/index.d.ts +56 -5
  188. package/iac/utils/patch-utils.d.ts +66 -0
  189. package/iac-packs/index.d.ts +6 -0
  190. package/native/forms/UI.d.ts +67 -0
  191. package/native/forms/createNativeFormRenderer.d.ts +21 -0
  192. package/native/forms/index.d.ts +9 -0
  193. package/native/forms/primitives/index.d.ts +38 -0
  194. package/native/forms/suite.d.ts +15 -0
  195. package/native/index.d.ts +19 -0
  196. package/native/index.js +717 -0
  197. package/native/testing/react-native.d.ts +28 -0
  198. package/native/utils/EasyLayout.d.ts +88 -0
  199. package/native/utils/History.d.ts +102 -0
  200. package/native/utils/Route.d.ts +83 -0
  201. package/native/utils/index.d.ts +9 -0
  202. package/package.json +76 -44
  203. package/web/forms/UI.d.ts +68 -0
  204. package/web/forms/createWebFormRenderer.d.ts +21 -0
  205. package/web/forms/index.d.ts +9 -0
  206. package/web/forms/primitives/index.d.ts +21 -0
  207. package/web/forms/suite.d.ts +15 -0
  208. package/web/index.d.ts +15 -0
  209. package/web/index.js +547 -0
  210. package/web/utils/EasyLayout.d.ts +47 -0
  211. package/web/utils/Route.d.ts +14 -0
  212. package/web/utils/index.d.ts +6 -0
  213. package/src/api/DataAccessControl.d.ts +0 -85
  214. package/src/api/DataAccessControl.js +0 -159
  215. package/src/api/ORM/DACUtils.d.ts +0 -60
  216. package/src/api/ORM/DACUtils.js +0 -197
  217. package/src/api/ORM/ListItemUtils.d.ts +0 -7
  218. package/src/api/ORM/ListItemUtils.js +0 -22
  219. package/src/api/ORM/ORMRouteMap.d.ts +0 -19
  220. package/src/api/ORM/ORMRouteMap.js +0 -82
  221. package/src/api/ORM/TypeInfoORMService.d.ts +0 -103
  222. package/src/api/ORM/TypeInfoORMService.js +0 -581
  223. package/src/api/ORM/drivers/DynamoDBDataItemDBDriver/ConfigTypes.d.ts +0 -63
  224. package/src/api/ORM/drivers/DynamoDBDataItemDBDriver/ConfigTypes.js +0 -2
  225. package/src/api/ORM/drivers/DynamoDBDataItemDBDriver.d.ts +0 -36
  226. package/src/api/ORM/drivers/DynamoDBDataItemDBDriver.js +0 -282
  227. package/src/api/ORM/drivers/S3FileItemDBDriver/ConfigTypes.d.ts +0 -90
  228. package/src/api/ORM/drivers/S3FileItemDBDriver/ConfigTypes.js +0 -2
  229. package/src/api/ORM/drivers/S3FileItemDBDriver/S3FileDriver.d.ts +0 -45
  230. package/src/api/ORM/drivers/S3FileItemDBDriver/S3FileDriver.js +0 -127
  231. package/src/api/ORM/drivers/S3FileItemDBDriver.js +0 -182
  232. package/src/api/ORM/drivers/common/SupportedTypeInfoORMDBDrivers.d.ts +0 -12
  233. package/src/api/ORM/drivers/common/SupportedTypeInfoORMDBDrivers.js +0 -20
  234. package/src/api/ORM/drivers/common/Types.js +0 -14
  235. package/src/api/ORM/drivers/common/index.d.ts +0 -2
  236. package/src/api/ORM/drivers/common/index.js +0 -18
  237. package/src/api/ORM/drivers/index.d.ts +0 -3
  238. package/src/api/ORM/drivers/index.js +0 -19
  239. package/src/api/ORM/index.d.ts +0 -4
  240. package/src/api/ORM/index.js +0 -43
  241. package/src/api/Router/AWS.d.ts +0 -26
  242. package/src/api/Router/AWS.js +0 -76
  243. package/src/api/Router/Auth.d.ts +0 -2
  244. package/src/api/Router/Auth.js +0 -9
  245. package/src/api/Router/CORS.d.ts +0 -6
  246. package/src/api/Router/CORS.js +0 -27
  247. package/src/api/Router/Types.d.ts +0 -71
  248. package/src/api/Router/Types.js +0 -2
  249. package/src/api/Router/index.d.ts +0 -18
  250. package/src/api/Router/index.js +0 -145
  251. package/src/api/index.d.ts +0 -3
  252. package/src/api/index.js +0 -39
  253. package/src/app/index.d.ts +0 -1
  254. package/src/app/index.js +0 -37
  255. package/src/app/utils/ApplicationState.js +0 -86
  256. package/src/app/utils/ApplicationStateLoader.js +0 -57
  257. package/src/app/utils/Controller.d.ts +0 -4
  258. package/src/app/utils/Controller.js +0 -47
  259. package/src/app/utils/Debug.d.ts +0 -4
  260. package/src/app/utils/Debug.js +0 -30
  261. package/src/app/utils/EasyLayout.d.ts +0 -49
  262. package/src/app/utils/EasyLayout.js +0 -122
  263. package/src/app/utils/Route.d.ts +0 -28
  264. package/src/app/utils/Route.js +0 -102
  265. package/src/app/utils/Service.d.ts +0 -12
  266. package/src/app/utils/Service.js +0 -34
  267. package/src/app/utils/TypeInfoORMAPIUtils.d.ts +0 -20
  268. package/src/app/utils/TypeInfoORMAPIUtils.js +0 -62
  269. package/src/app/utils/TypeInfoORMClient.d.ts +0 -24
  270. package/src/app/utils/TypeInfoORMClient.js +0 -69
  271. package/src/app/utils/index.d.ts +0 -8
  272. package/src/app/utils/index.js +0 -24
  273. package/src/common/CommandLine/collectRequiredEnvironmentVariables.d.ts +0 -1
  274. package/src/common/CommandLine/collectRequiredEnvironmentVariables.js +0 -16
  275. package/src/common/HelperTypes.d.ts +0 -3
  276. package/src/common/HelperTypes.js +0 -2
  277. package/src/common/IdGeneration/getSimpleId.d.ts +0 -4
  278. package/src/common/IdGeneration/getSimpleId.js +0 -16
  279. package/src/common/IdGeneration/index.js +0 -17
  280. package/src/common/ItemRelationshipInfoTypes.js +0 -20
  281. package/src/common/ItemRelationships/ItemRelationshipValidation.d.ts +0 -10
  282. package/src/common/ItemRelationships/ItemRelationshipValidation.js +0 -43
  283. package/src/common/ItemRelationships/index.d.ts +0 -1
  284. package/src/common/ItemRelationships/index.js +0 -17
  285. package/src/common/Logging/Utils.d.ts +0 -10
  286. package/src/common/Logging/Utils.js +0 -33
  287. package/src/common/Logging/index.js +0 -17
  288. package/src/common/Routing.d.ts +0 -25
  289. package/src/common/Routing.js +0 -102
  290. package/src/common/SearchTypes.d.ts +0 -98
  291. package/src/common/SearchTypes.js +0 -39
  292. package/src/common/SearchUtils.d.ts +0 -22
  293. package/src/common/SearchUtils.js +0 -134
  294. package/src/common/SearchValidation.js +0 -90
  295. package/src/common/Storyboarding/Types.d.ts +0 -25
  296. package/src/common/Storyboarding/Types.js +0 -2
  297. package/src/common/StringTransformers.js +0 -36
  298. package/src/common/Testing/CLI.d.ts +0 -2
  299. package/src/common/Testing/CLI.js +0 -56
  300. package/src/common/Testing/Types.js +0 -19
  301. package/src/common/Testing/Utils.js +0 -334
  302. package/src/common/Testing/index.d.ts +0 -2
  303. package/src/common/Testing/index.js +0 -18
  304. package/src/common/TypeInfoDataItemUtils.d.ts +0 -10
  305. package/src/common/TypeInfoDataItemUtils.js +0 -55
  306. package/src/common/TypeInfoORM/Types.d.ts +0 -76
  307. package/src/common/TypeInfoORM/Types.js +0 -55
  308. package/src/common/TypeInfoORM/index.d.ts +0 -1
  309. package/src/common/TypeInfoORM/index.js +0 -17
  310. package/src/common/TypeParsing/Constants.d.ts +0 -1
  311. package/src/common/TypeParsing/Constants.js +0 -4
  312. package/src/common/TypeParsing/ParsingUtils/Constants.js +0 -8
  313. package/src/common/TypeParsing/ParsingUtils/checkType.js +0 -46
  314. package/src/common/TypeParsing/ParsingUtils/checkUnionType.js +0 -15
  315. package/src/common/TypeParsing/ParsingUtils/extractCommentTags.d.ts +0 -2
  316. package/src/common/TypeParsing/ParsingUtils/extractCommentTags.js +0 -105
  317. package/src/common/TypeParsing/ParsingUtils/extractLiteralValues.d.ts +0 -6
  318. package/src/common/TypeParsing/ParsingUtils/extractLiteralValues.js +0 -42
  319. package/src/common/TypeParsing/ParsingUtils/extractTypeDetails.d.ts +0 -8
  320. package/src/common/TypeParsing/ParsingUtils/extractTypeDetails.js +0 -14
  321. package/src/common/TypeParsing/ParsingUtils/getPrimaryFieldForTypeInfo.d.ts +0 -5
  322. package/src/common/TypeParsing/ParsingUtils/getPrimaryFieldForTypeInfo.js +0 -27
  323. package/src/common/TypeParsing/ParsingUtils/getTypeInfo.d.ts +0 -3
  324. package/src/common/TypeParsing/ParsingUtils/getTypeInfo.js +0 -27
  325. package/src/common/TypeParsing/ParsingUtils/getTypeInfoField.js +0 -44
  326. package/src/common/TypeParsing/ParsingUtils/getTypeInfoFromAliasType.d.ts +0 -4
  327. package/src/common/TypeParsing/ParsingUtils/getTypeInfoFromAliasType.js +0 -28
  328. package/src/common/TypeParsing/ParsingUtils/getTypeInfoFromFieldFilter.d.ts +0 -4
  329. package/src/common/TypeParsing/ParsingUtils/getTypeInfoFromFieldFilter.js +0 -105
  330. package/src/common/TypeParsing/ParsingUtils/getTypeInfoFromTypeAlias.d.ts +0 -4
  331. package/src/common/TypeParsing/ParsingUtils/getTypeInfoFromTypeAlias.js +0 -20
  332. package/src/common/TypeParsing/ParsingUtils/getTypeKeyword.d.ts +0 -3
  333. package/src/common/TypeParsing/ParsingUtils/getTypeKeyword.js +0 -17
  334. package/src/common/TypeParsing/ParsingUtils/getUnionOrIntersectionTypeInfo.d.ts +0 -4
  335. package/src/common/TypeParsing/ParsingUtils/getUnionOrIntersectionTypeInfo.js +0 -49
  336. package/src/common/TypeParsing/ParsingUtils/getUnionOrLiteralStringValues.d.ts +0 -2
  337. package/src/common/TypeParsing/ParsingUtils/getUnionOrLiteralStringValues.js +0 -24
  338. package/src/common/TypeParsing/TypeInfo.js +0 -13
  339. package/src/common/TypeParsing/TypeMapping.js +0 -32
  340. package/src/common/TypeParsing/TypeParsing.d.ts +0 -5
  341. package/src/common/TypeParsing/TypeParsing.js +0 -39
  342. package/src/common/TypeParsing/Utils.js +0 -94
  343. package/src/common/TypeParsing/Validation.js +0 -340
  344. package/src/common/TypeParsing/index.d.ts +0 -5
  345. package/src/common/TypeParsing/index.js +0 -44
  346. package/src/common/index.d.ts +0 -11
  347. package/src/common/index.js +0 -47
  348. package/src/iac/SimpleCFT.js +0 -82
  349. package/src/iac/index.d.ts +0 -9
  350. package/src/iac/index.js +0 -48
  351. package/src/iac/packs/auth/user-management.d.ts +0 -14
  352. package/src/iac/packs/auth/user-management.js +0 -302
  353. package/src/iac/packs/auth.d.ts +0 -19
  354. package/src/iac/packs/auth.js +0 -47
  355. package/src/iac/packs/build/utils.d.ts +0 -100
  356. package/src/iac/packs/build/utils.js +0 -23
  357. package/src/iac/packs/build.d.ts +0 -29
  358. package/src/iac/packs/build.js +0 -217
  359. package/src/iac/packs/cdn.d.ts +0 -12
  360. package/src/iac/packs/cdn.js +0 -126
  361. package/src/iac/packs/cloud-function.d.ts +0 -17
  362. package/src/iac/packs/cloud-function.js +0 -69
  363. package/src/iac/packs/database.js +0 -27
  364. package/src/iac/packs/dns.js +0 -26
  365. package/src/iac/packs/file-storage.d.ts +0 -14
  366. package/src/iac/packs/file-storage.js +0 -71
  367. package/src/iac/packs/gateway.d.ts +0 -27
  368. package/src/iac/packs/gateway.js +0 -342
  369. package/src/iac/packs/index.d.ts +0 -11
  370. package/src/iac/packs/index.js +0 -27
  371. package/src/iac/packs/repo.d.ts +0 -10
  372. package/src/iac/packs/repo.js +0 -34
  373. package/src/iac/packs/ssl-certificate.d.ts +0 -10
  374. package/src/iac/packs/ssl-certificate.js +0 -36
  375. package/src/iac/types/CloudFormationResourceSpecification.d.ts +0 -2
  376. package/src/iac/types/Constants.js +0 -20
  377. package/src/iac/types/IaCTypes.js +0 -14
  378. package/src/iac/types/Renderers.d.ts +0 -12
  379. package/src/iac/types/Renderers.js +0 -112
  380. package/src/iac/types/Types.d.ts +0 -37
  381. package/src/iac/types/Types.js +0 -2
  382. package/src/iac/types/Utils.d.ts +0 -2
  383. package/src/iac/types/Utils.js +0 -60
  384. package/src/iac/types/generate.js +0 -31
  385. package/src/iac/utils/index.js +0 -105
  386. package/src/iac/utils/patch-utils.d.ts +0 -15
  387. package/src/iac/utils/patch-utils.js +0 -62
  388. package/src/index.d.ts +0 -178
  389. package/src/index.js +0 -214
  390. /package/{src/common → common}/IdGeneration/index.d.ts +0 -0
  391. /package/{src/common → common}/Logging/index.d.ts +0 -0
  392. /package/{src/iac → iac}/types/IaCTypes.d.ts +0 -0
  393. /package/{src/iac → iac}/types/generate.d.ts +0 -0
@@ -0,0 +1,9 @@
1
+ import { TypeNode } from "typescript";
2
+ import { TypeKeyword } from "../TypeInfo";
3
+ /**
4
+ * Resolve a TypeScript type node into a TypeInfo keyword.
5
+ *
6
+ * @param node - Type node to inspect.
7
+ * @returns TypeInfo keyword (string, number, boolean).
8
+ */
9
+ export declare const getTypeKeyword: (node: TypeNode) => TypeKeyword;
@@ -0,0 +1,11 @@
1
+ import { IntersectionTypeNode, UnionTypeNode } from "typescript";
2
+ import type { TypeMap } from "../../../build/TypeMapping";
3
+ import { TypeInfo } from "../TypeInfo";
4
+ /**
5
+ * Resolve TypeInfo for union or intersection types.
6
+ *
7
+ * @param unionType - Union or intersection type node to inspect.
8
+ * @param typeMap - Map of available type aliases.
9
+ * @returns Resolved TypeInfo or undefined when unsupported.
10
+ */
11
+ export declare const getUnionOrIntersectionTypeInfo: (unionType: UnionTypeNode | IntersectionTypeNode, typeMap: TypeMap) => TypeInfo | undefined;
@@ -0,0 +1,8 @@
1
+ import { Node } from "typescript";
2
+ /**
3
+ * Extract string literal values from a union or literal type node.
4
+ *
5
+ * @param node - Type node to inspect.
6
+ * @returns List of literal values as strings.
7
+ */
8
+ export declare const getUnionOrLiteralStringValues: (node?: Node) => string[];
@@ -1,10 +1,27 @@
1
+ /**
2
+ * TypeInfo definitions and tags used across parsing and validation.
3
+ */
1
4
  /**
2
5
  * A set of possible operations for a type or field value.
3
- * */
6
+ *
7
+ * @category TypeInfo
8
+ */
4
9
  export declare enum TypeOperation {
10
+ /**
11
+ * Create operation.
12
+ */
5
13
  CREATE = "CREATE",
14
+ /**
15
+ * Read operation.
16
+ */
6
17
  READ = "READ",
18
+ /**
19
+ * Update operation.
20
+ */
7
21
  UPDATE = "UPDATE",
22
+ /**
23
+ * Delete operation.
24
+ */
8
25
  DELETE = "DELETE"
9
26
  }
10
27
  /**
@@ -108,32 +125,75 @@ export type TypeKeyword = "string" | "number" | "boolean";
108
125
  * Information about a field in a type definition.
109
126
  */
110
127
  export type TypeInfoField = {
128
+ /**
129
+ * Scalar type keyword for the field.
130
+ */
111
131
  type: TypeKeyword;
132
+ /**
133
+ * Referenced TypeInfo type name, when relational.
134
+ */
112
135
  typeReference?: string;
136
+ /**
137
+ * Whether the field is an array.
138
+ */
113
139
  array: boolean;
140
+ /**
141
+ * Whether the field is read-only.
142
+ */
114
143
  readonly: boolean;
144
+ /**
145
+ * Whether the field is optional.
146
+ */
115
147
  optional: boolean;
148
+ /**
149
+ * Allowed literal values for the field.
150
+ */
116
151
  possibleValues?: LiteralValue[];
152
+ /**
153
+ * Optional field tags and constraints.
154
+ */
117
155
  tags?: SupportedFieldTags;
118
156
  };
119
157
  /**
120
158
  * Information about a type definition.
159
+ *
160
+ * @category TypeInfo
121
161
  */
122
162
  export type TypeInfo = {
163
+ /**
164
+ * Primary field name for the type.
165
+ */
123
166
  primaryField?: string;
167
+ /**
168
+ * Map of field names to field definitions.
169
+ */
124
170
  fields?: Record<string, TypeInfoField>;
171
+ /**
172
+ * Optional type-level tags.
173
+ */
125
174
  tags?: SupportedTags;
175
+ /**
176
+ * Field name groupings for union type definitions.
177
+ */
126
178
  unionFieldSets?: string[][];
127
179
  };
128
180
  /**
129
181
  * A map of type information maps.
182
+ *
183
+ * @category TypeInfo
130
184
  */
131
185
  export type TypeInfoMap = Record<string, TypeInfo>;
132
186
  /**
133
187
  * The necessary information to use a {@link TypeInfo} with the entire {@link TypeInfoMap} containing it.
134
188
  * */
135
189
  export type TypeInfoPack = {
190
+ /**
191
+ * Entry type name to resolve.
192
+ */
136
193
  entryTypeName: string;
194
+ /**
195
+ * Type info map containing the entry type.
196
+ */
137
197
  typeInfoMap: TypeInfoMap;
138
198
  };
139
199
  /**
@@ -1,21 +1,47 @@
1
+ /**
2
+ * Field-selection helpers for shaping TypeInfo data items.
3
+ */
1
4
  import { TypeInfo, TypeInfoDataItem } from "./TypeInfo";
2
5
  /**
3
6
  * Remove all fields, from a list of selected fields, that are not in the type info.
7
+ *
8
+ * @typeParam ItemType - Data item shape for field selection.
9
+ * @param typeInfo - Type info describing available fields.
10
+ * @param selectedFields - Fields to filter.
11
+ * @returns Filtered list of selected fields.
4
12
  * */
5
13
  export declare const removeNonexistentFieldsFromSelectedFields: <ItemType extends TypeInfoDataItem>(typeInfo?: TypeInfo, selectedFields?: (keyof ItemType)[]) => (keyof ItemType)[] | undefined;
6
14
  /**
7
15
  * Remove all fields, from a list of selected fields, that are a type reference.
16
+ *
17
+ * @typeParam ItemType - Data item shape for field selection.
18
+ * @param typeInfo - Type info describing available fields.
19
+ * @param selectedFields - Fields to filter.
20
+ * @returns Filtered list of selected fields.
8
21
  * */
9
22
  export declare const removeTypeReferenceFieldsFromSelectedFields: <ItemType>(typeInfo?: TypeInfo, selectedFields?: (keyof ItemType)[]) => (keyof ItemType)[] | undefined;
10
23
  /**
11
24
  * Remove all fields, from a data item, that are a type reference.
25
+ *
26
+ * @param typeInfo - Type info describing available fields.
27
+ * @param dataItem - Data item to filter.
28
+ * @returns Filtered data item.
12
29
  * */
13
30
  export declare const removeTypeReferenceFieldsFromDataItem: (typeInfo?: TypeInfo, dataItem?: Partial<TypeInfoDataItem>) => Partial<TypeInfoDataItem>;
14
31
  /**
15
32
  * Remove all fields, from a data item, that are not in the type info.
33
+ *
34
+ * @param typeInfo - Type info describing available fields.
35
+ * @param dataItem - Data item to filter.
36
+ * @returns Filtered data item.
16
37
  * */
17
38
  export declare const removeNonexistentFieldsFromDataItem: (typeInfo?: TypeInfo, dataItem?: Partial<TypeInfoDataItem>) => Partial<TypeInfoDataItem>;
18
39
  /**
19
40
  * Remove all fields, from a data item, that are not selected.
41
+ *
42
+ * @typeParam ItemType - Data item shape for field selection.
43
+ * @param dataItem - Data item to filter.
44
+ * @param selectedFields - Fields to include.
45
+ * @returns Filtered data item.
20
46
  * */
21
47
  export declare const removeUnselectedFieldsFromDataItem: <ItemType extends TypeInfoDataItem>(dataItem?: Partial<ItemType>, selectedFields?: (keyof ItemType)[]) => Partial<ItemType>;
@@ -1,7 +1,25 @@
1
+ /**
2
+ * @packageDocumentation
3
+ *
4
+ * Validation helpers for TypeInfo values, including relationship rules and
5
+ * custom type validators.
6
+ */
1
7
  import { TypeInfo, TypeInfoField, TypeInfoMap, TypeKeyword, TypeOperation } from "./TypeInfo";
8
+ /**
9
+ * Relationship validation behavior for TypeInfo checks.
10
+ */
2
11
  export declare enum RelationshipValidationType {
12
+ /**
13
+ * Include relationship values in validation.
14
+ */
3
15
  INCLUDE = "INCLUDE",
16
+ /**
17
+ * Exclude relationship values from validation.
18
+ */
4
19
  EXCLUDE = "EXCLUDE",
20
+ /**
21
+ * Disallow relationship values entirely.
22
+ */
5
23
  STRICT_EXCLUDE = "STRICT_EXCLUDE"
6
24
  }
7
25
  /**
@@ -22,13 +40,34 @@ export type ErrorMap = {
22
40
  * The validation results for type info fields.
23
41
  */
24
42
  export type TypeInfoValidationResults = {
43
+ /**
44
+ * Type name being validated.
45
+ */
25
46
  typeName: string | null;
47
+ /**
48
+ * Whether the validation passed.
49
+ */
26
50
  valid: boolean;
51
+ /**
52
+ * Primary error code when validation fails.
53
+ */
27
54
  error: string;
55
+ /**
56
+ * Field-level error mapping.
57
+ */
28
58
  errorMap: ErrorMap;
29
59
  };
60
+ /**
61
+ * Error code for custom type validation failures.
62
+ */
30
63
  export declare const INVALID_CUSTOM_TYPE = "INVALID_CUSTOM_TYPE";
64
+ /**
65
+ * Error codes for primitive type validation failures.
66
+ */
31
67
  export declare const PRIMITIVE_ERROR_MESSAGE_CONSTANTS: Record<TypeKeyword, string>;
68
+ /**
69
+ * Error codes for TypeInfo validation failures.
70
+ */
32
71
  export declare const ERROR_MESSAGE_CONSTANTS: {
33
72
  MISSING: string;
34
73
  INVALID_OPTION: string;
@@ -40,6 +79,9 @@ export declare const ERROR_MESSAGE_CONSTANTS: {
40
79
  INVALID_PATTERN: string;
41
80
  VALUE_DOES_NOT_MATCH_PATTERN: string;
42
81
  };
82
+ /**
83
+ * Error codes for denied type operations.
84
+ */
43
85
  export declare const DENIED_TYPE_OPERATIONS: Record<TypeOperation, string>;
44
86
  /**
45
87
  * Validates a value against a pattern.
@@ -48,10 +90,19 @@ export declare const DENIED_TYPE_OPERATIONS: Record<TypeOperation, string>;
48
90
  * `pattern` must be a string or not supplied.
49
91
  *
50
92
  * If either are not supplied, the result is valid.
93
+ *
94
+ * @param typeName - Type name for the validation context.
95
+ * @param value - Value to validate.
96
+ * @param pattern - Regex pattern to validate against.
97
+ * @returns Validation results for the pattern.
51
98
  * */
52
99
  export declare const validateValueMatchesPattern: (typeName: string, value?: any, pattern?: string) => TypeInfoValidationResults;
53
100
  /**
54
101
  * Gets the validity value.
102
+ *
103
+ * @param existing - Current validity value.
104
+ * @param pending - New validity value.
105
+ * @returns Updated validity value.
55
106
  */
56
107
  export declare const getValidityValue: (existing: boolean, pending: boolean) => boolean;
57
108
  /**
@@ -60,33 +111,87 @@ export declare const getValidityValue: (existing: boolean, pending: boolean) =>
60
111
  export declare const TYPE_KEYWORD_VALIDATORS: Record<TypeKeyword, (value: any) => boolean>;
61
112
  /**
62
113
  * Checks if a value has a value.
114
+ *
115
+ * @param value - Value to check.
116
+ * @returns Whether the value is present.
63
117
  */
64
118
  export declare const hasValue: (value: any) => boolean;
65
119
  /**
66
120
  * Validates a primitive value.
121
+ *
122
+ * @param value - Value to validate.
123
+ * @param type - Primitive type keyword.
124
+ * @returns Whether the value matches the type.
67
125
  */
68
126
  export declare const validateKeywordType: (value: any, type: string) => boolean;
69
127
  /**
70
128
  * Validates a custom type.
129
+ *
130
+ * @param value - Value to validate.
131
+ * @param customType - Custom type name.
132
+ * @param customValidators - Custom validators map.
133
+ * @returns Whether the value passes custom validation.
71
134
  */
72
135
  export declare const validateCustomType: (value: any, customType?: string, customValidators?: CustomTypeInfoFieldValidatorMap) => boolean;
73
136
  /**
74
137
  * Validates a type info field value.
138
+ *
139
+ * @param value - Value to validate.
140
+ * @param typeInfoField - Field metadata.
141
+ * @param typeInfoMap - Type info map for referenced types.
142
+ * @param ignoreArray - Whether to ignore array validation.
143
+ * @param strict - Whether to validate unknown fields and unions strictly.
144
+ * @param customValidators - Custom validators map.
145
+ * @param typeOperation - Operation being validated.
146
+ * @param relationshipValidationType - Relationship validation behavior.
147
+ * @param itemIsPartial - Whether the item is partial.
148
+ * @returns Validation results for the field.
75
149
  */
76
150
  export declare const validateTypeInfoFieldValue: (value: any, typeInfoField: TypeInfoField, typeInfoMap: TypeInfoMap, ignoreArray?: boolean, strict?: boolean, customValidators?: CustomTypeInfoFieldValidatorMap, typeOperation?: TypeOperation, relationshipValidationType?: RelationshipValidationType, itemIsPartial?: boolean) => TypeInfoValidationResults;
77
151
  /**
78
152
  * Validates an array of type info field values.
153
+ *
154
+ * @param values - Values to validate.
155
+ * @param typeInfoField - Field metadata.
156
+ * @param typeInfoMap - Type info map for referenced types.
157
+ * @param strict - Whether to validate unknown fields and unions strictly.
158
+ * @param customValidators - Custom validators map.
159
+ * @param typeOperation - Operation being validated.
160
+ * @param relationshipValidationType - Relationship validation behavior.
161
+ * @param itemIsPartial - Whether the item is partial.
162
+ * @returns Validation results for the array.
79
163
  */
80
164
  export declare const validateArrayOfTypeInfoFieldValues: (values: any[] | undefined, typeInfoField: TypeInfoField, typeInfoMap: TypeInfoMap, strict?: boolean, customValidators?: CustomTypeInfoFieldValidatorMap, typeOperation?: TypeOperation, relationshipValidationType?: RelationshipValidationType, itemIsPartial?: boolean) => TypeInfoValidationResults;
81
165
  /**
82
166
  * Validates a type info field operation.
167
+ *
168
+ * @param fieldName - Field name to validate.
169
+ * @param fieldOperation - Operation to validate.
170
+ * @param typeInfoField - Field metadata.
171
+ * @returns Validation results for the field operation.
83
172
  * */
84
173
  export declare const validateTypeInfoFieldOperationAllowed: (fieldName: string, fieldOperation?: TypeOperation, typeInfoField?: TypeInfoField) => TypeInfoValidationResults;
85
174
  /**
86
175
  * Validates a type info operation.
176
+ *
177
+ * @param typeName - Type name to validate.
178
+ * @param valueFields - Fields included in the operation.
179
+ * @param typeOperation - Operation to validate.
180
+ * @param typeInfo - Type info metadata.
181
+ * @returns Validation results for the type operation.
87
182
  * */
88
183
  export declare const validateTypeOperationAllowed: (typeName: string, valueFields: string[], typeOperation: TypeOperation, typeInfo: TypeInfo) => TypeInfoValidationResults;
89
184
  /**
90
185
  * Validates a type info value.
186
+ *
187
+ * @param value - Value to validate.
188
+ * @param typeInfoFullName - Fully qualified type name.
189
+ * @param typeInfoMap - Type info map for referenced types.
190
+ * @param strict - Whether to validate unknown fields and unions strictly.
191
+ * @param customValidators - Custom validators map.
192
+ * @param typeOperation - Operation being validated.
193
+ * @param relationshipValidationType - Relationship validation behavior.
194
+ * @param itemIsPartial - Whether the item is partial.
195
+ * @returns Validation results for the value.
91
196
  */
92
197
  export declare const validateTypeInfoValue: (value: any, typeInfoFullName: string, typeInfoMap: TypeInfoMap, strict?: boolean, customValidators?: CustomTypeInfoFieldValidatorMap, typeOperation?: TypeOperation, relationshipValidationType?: RelationshipValidationType, itemIsPartial?: boolean) => TypeInfoValidationResults;
@@ -0,0 +1,8 @@
1
+ /**
2
+ * @packageDocumentation
3
+ *
4
+ * Includes TypeInfo definitions, validation helpers, and AST mapping.
5
+ */
6
+ export * from "./Validation";
7
+ export * from "./TypeInfo";
8
+ export * from "./Constants";
@@ -0,0 +1,50 @@
1
+ /**
2
+ * @packageDocumentation
3
+ *
4
+ * Common module exports for shared utilities, types, and helpers used across
5
+ * app, API, and IaC layers.
6
+ *
7
+ * Import from the common subpath only:
8
+ * ```ts
9
+ * import {
10
+ * getPathString,
11
+ * getSimpleId,
12
+ * } from "@resistdesign/voltra/common";
13
+ *
14
+ * const path = getPathString(["users", 42], "/", true, false);
15
+ * const id = getSimpleId();
16
+ * ```
17
+ *
18
+ * See also: `@resistdesign/voltra/app`, `@resistdesign/voltra/api`, and
19
+ * `@resistdesign/voltra/iac`.
20
+ */
21
+ /**
22
+ * @category common
23
+ * @group Shared Types
24
+ */
25
+ export type * from "./HelperTypes";
26
+ /**
27
+ * @category common
28
+ * @group Command Line
29
+ */
30
+ export * from "./CommandLine";
31
+ /**
32
+ * @category common
33
+ * @group Type Parsing
34
+ */
35
+ export { TypeOperation, } from "./TypeParsing/TypeInfo";
36
+ /**
37
+ * @category common
38
+ * @group Type Parsing
39
+ */
40
+ export type { DeniedOperations, SupportedFieldTags, SupportedTags, TypeInfo, TypeInfoField, TypeInfoMap, } from "./TypeParsing/TypeInfo";
41
+ /**
42
+ * @category common
43
+ * @group Shared Types
44
+ */
45
+ export { TypeInfoORMServiceError, } from "./TypeInfoORM/Types";
46
+ /**
47
+ * @category common
48
+ * @group Type Parsing
49
+ */
50
+ export * from "./TypeParsing/Validation";
@@ -0,0 +1,36 @@
1
+ export { DENIED_TYPE_OPERATIONS, ERROR_MESSAGE_CONSTANTS, INVALID_CUSTOM_TYPE, PRIMITIVE_ERROR_MESSAGE_CONSTANTS, RelationshipValidationType, TYPE_KEYWORD_VALIDATORS, getValidityValue, hasValue, validateArrayOfTypeInfoFieldValues, validateCustomType, validateKeywordType, validateTypeInfoFieldOperationAllowed, validateTypeInfoFieldValue, validateTypeInfoValue, validateTypeOperationAllowed, validateValueMatchesPattern } from '../chunk-LGM75I6P.js';
2
+ export { TypeInfoORMServiceError } from '../chunk-HVY7POTD.js';
3
+ export { TypeOperation } from '../chunk-IWRHGGGH.js';
4
+ import '../chunk-GYWRAW3Y.js';
5
+ import '../chunk-I2KLQ2HA.js';
6
+
7
+ // src/common/CommandLine/collectRequiredEnvironmentVariables.ts
8
+ var collectRequiredEnvironmentVariables = (varNames) => {
9
+ const result = {};
10
+ const missingEnvVars = [];
11
+ for (const vN of varNames) {
12
+ const value = process.env[vN];
13
+ if (!value) {
14
+ missingEnvVars.push(vN);
15
+ } else {
16
+ result[vN] = value;
17
+ }
18
+ }
19
+ if (missingEnvVars.length > 0) {
20
+ throw new Error(
21
+ `
22
+ \u250C\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2510
23
+ \u2502 \u26A0 ENVIRONMENT CHECK FAILED \u2502
24
+ \u2514\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2518
25
+
26
+ Missing Required Environment Variables:
27
+
28
+ ${missingEnvVars.map((vN) => `- ${vN}`).join(`
29
+ `)}
30
+ `
31
+ );
32
+ }
33
+ return result;
34
+ };
35
+
36
+ export { collectRequiredEnvironmentVariables };
@@ -1,48 +1,92 @@
1
+ /**
2
+ * @packageDocumentation
3
+ *
4
+ * Fluent builder for CloudFormation templates. Use {@link SimpleCFT} to apply
5
+ * packs, patches, and parameters, then read the resulting `template` or render
6
+ * it as JSON/YAML.
7
+ */
1
8
  import { CloudFormationTemplate } from "./types/IaCTypes";
2
9
  import { ParameterGroup, ParameterInfo, ResourcePackApplier } from "./utils";
3
10
  /**
4
11
  * A function used to apply a modification to a SimpleCFT instance.
12
+ *
13
+ * @param simpleCFT - SimpleCFT instance to modify.
5
14
  * */
6
15
  export type SimpleCFTModification = (simpleCFT: SimpleCFT) => void;
7
16
  /**
8
17
  * The basis for your stack template.
9
18
  * Apply packs, patches, parameters and parameter groups.
10
19
  * Access the `template` property for the resulting CloudFormation template.
11
- * */
20
+ *
21
+ * Example:
22
+ * ```ts
23
+ * import { SimpleCFT } from "./SimpleCFT";
24
+ *
25
+ * const template = new SimpleCFT()
26
+ * .addParameter({
27
+ * Group: "App",
28
+ * ParameterId: "AppName",
29
+ * Label: "App Name",
30
+ * Parameter: { Type: "String", Default: "voltra" },
31
+ * })
32
+ * .patch({ Description: "My stack" });
33
+ *
34
+ * console.log(template.toString());
35
+ * ```
36
+ */
12
37
  export declare class SimpleCFT {
13
38
  template: CloudFormationTemplate;
39
+ /**
40
+ * Create a SimpleCFT template wrapper.
41
+ *
42
+ * @param template - Initial CloudFormation template.
43
+ */
14
44
  constructor(template?: CloudFormationTemplate);
15
45
  /**
16
46
  * Apply a pack with configuration to the stack template.
17
- * @see {@link IaC} for an example.
47
+ * @see `@resistdesign/voltra/iac` and `@resistdesign/voltra/iac/packs` for examples.
18
48
  * */
19
49
  applyPack: <ParamsType>(pack: ResourcePackApplier<ParamsType>, params: ParamsType) => this;
20
50
  /**
21
51
  * Apply a patch to the stack template.
52
+ *
53
+ * @param patch - Template patch to merge.
22
54
  * */
23
55
  patch: (patch: Partial<CloudFormationTemplate>) => this;
24
56
  /**
25
57
  * Add a stack parameter including its descriptive info and an optional parameter group.
58
+ *
59
+ * @param parameter - Parameter definition and metadata.
26
60
  * */
27
61
  addParameter: (parameter: ParameterInfo) => this;
28
62
  /**
29
63
  * Add a group of stack parameters including their descriptive info and an optional parameter group.
64
+ *
65
+ * @param group - Parameter group definition.
30
66
  * */
31
67
  addParameterGroup: ({ Label: Group, Parameters }: ParameterGroup) => this;
32
68
  /**
33
69
  * Use a modification to dynamically apply various changes at once.
70
+ *
71
+ * @param modification - Modification callback to apply.
34
72
  * */
35
73
  modify: (modification: SimpleCFTModification) => this;
36
74
  /**
37
75
  * Convert the stack template to a string.
76
+ *
77
+ * @returns JSON string representation of the template.
38
78
  * */
39
79
  toString: () => string;
40
80
  /**
41
81
  * Convert the stack template to a JSON object.
82
+ *
83
+ * @returns Template JSON object.
42
84
  * */
43
85
  toJSON: () => CloudFormationTemplate;
44
86
  /**
45
87
  * Convert the stack template to a YAML string.
88
+ *
89
+ * @returns YAML string representation of the template.
46
90
  * */
47
91
  toYAML: () => string;
48
92
  }
package/iac/index.d.ts ADDED
@@ -0,0 +1,40 @@
1
+ /**
2
+ * @packageDocumentation
3
+ *
4
+ * Infrastructure-as-code entrypoint.
5
+ *
6
+ * Import from the IaC subpath only:
7
+ * ```ts
8
+ * import { SimpleCFT } from "@resistdesign/voltra/iac";
9
+ * import { addDNS } from "@resistdesign/voltra/iac/packs";
10
+ * ```
11
+ *
12
+ * @example
13
+ * ```ts
14
+ * import { SimpleCFT } from "@resistdesign/voltra/iac";
15
+ * import { addDNS } from "@resistdesign/voltra/iac/packs";
16
+ *
17
+ * const cft = new SimpleCFT().applyPack(addDNS, {
18
+ * hostedZoneIdParameterName: "<YOUR_INFO_HERE>",
19
+ * domainNameParameterName: "<YOUR_INFO_HERE>",
20
+ * localUIDevelopmentDomainName: "<YOUR_INFO_HERE>",
21
+ * localUIDevelopmentIPAddress: "<YOUR_INFO_HERE>",
22
+ * });
23
+ *
24
+ * console.log(cft.template);
25
+ * ```
26
+ *
27
+ * Use flat exports for reusable resource packs and template helpers.
28
+ *
29
+ * See also: `@resistdesign/voltra/iac/packs` for direct pack imports.
30
+ */
31
+ /**
32
+ * @category iac
33
+ * @group Core
34
+ */
35
+ export * from "./SimpleCFT";
36
+ /**
37
+ * @category iac
38
+ * @group Utilities
39
+ */
40
+ export * from "./utils";
package/iac/index.js ADDED
@@ -0,0 +1,2 @@
1
+ export { DEFAULT_MERGE_STRATEGY, SimpleCFT, addParameter, addParameters, createResourcePack, getValuePathArray, getValuePathString, isConstructedFrom, mergeValues, patchTemplate } from '../chunk-ATO2455Q.js';
2
+ import '../chunk-I2KLQ2HA.js';
@@ -0,0 +1,82 @@
1
+ /**
2
+ * Configuration for adding Cognito user management resources.
3
+ */
4
+ type AddUserManagementConfigBase = {
5
+ /**
6
+ * Base id for Cognito resources.
7
+ */
8
+ id: string;
9
+ /**
10
+ * IAM role name for authenticated users.
11
+ */
12
+ authRoleName: string;
13
+ /**
14
+ * IAM role name for unauthenticated users.
15
+ */
16
+ unauthRoleName: string;
17
+ /**
18
+ * Alias target DNS name for the base domain record.
19
+ */
20
+ baseDomainRecordAliasTargetDNSName?: any;
21
+ /**
22
+ * API Gateway REST API id for authenticated access.
23
+ */
24
+ apiGatewayRESTAPIId?: any;
25
+ /**
26
+ * API Gateway stage name for authenticated access.
27
+ */
28
+ apiStageName?: any;
29
+ };
30
+ type AddUserManagementConfigWithDomain = AddUserManagementConfigBase & {
31
+ /**
32
+ * Enable a custom Cognito user pool domain and associated Route53 records.
33
+ *
34
+ * Defaults to `true`.
35
+ */
36
+ enableUserPoolDomain?: true;
37
+ /**
38
+ * Base domain name for the user pool.
39
+ */
40
+ domainName: any;
41
+ /**
42
+ * Hosted zone id for DNS records.
43
+ */
44
+ hostedZoneId: any;
45
+ /**
46
+ * SSL certificate ARN for the user pool domain.
47
+ */
48
+ sslCertificateArn: any;
49
+ /**
50
+ * OAuth callback URLs.
51
+ */
52
+ callbackUrls?: any[];
53
+ /**
54
+ * OAuth logout URLs.
55
+ */
56
+ logoutUrls?: any[];
57
+ };
58
+ type AddUserManagementConfigWithoutDomain = AddUserManagementConfigBase & {
59
+ /**
60
+ * Disable custom Cognito user pool domain resources.
61
+ */
62
+ enableUserPoolDomain: false;
63
+ domainName?: never;
64
+ hostedZoneId?: never;
65
+ sslCertificateArn?: never;
66
+ baseDomainRecordAliasTargetDNSName?: never;
67
+ callbackUrls?: never;
68
+ logoutUrls?: never;
69
+ };
70
+ /**
71
+ * Configuration for {@link addUserManagement}.
72
+ */
73
+ export type AddUserManagementConfig = AddUserManagementConfigWithDomain | AddUserManagementConfigWithoutDomain;
74
+ /**
75
+ * Add Cognito user management resources to a template.
76
+ *
77
+ * @param config - User management configuration.
78
+ * @returns CloudFormation template fragment.
79
+ * @group Resource Packs
80
+ */
81
+ export declare const addUserManagement: import("../..").ResourcePackApplier<AddUserManagementConfig>;
82
+ export {};