@rockcarver/frodo-lib 4.10.0 → 4.11.0

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 (427) hide show
  1. package/dist/index.js +2 -2
  2. package/dist/index.mjs +2 -2
  3. package/package.json +6 -3
  4. package/types/api/AgentApi.d.ts +128 -0
  5. package/types/api/AgentApi.d.ts.map +1 -0
  6. package/types/api/AmConfigApi.d.ts +87 -0
  7. package/types/api/AmConfigApi.d.ts.map +1 -0
  8. package/types/api/ApiTypes.d.ts +59 -0
  9. package/types/api/ApiTypes.d.ts.map +1 -0
  10. package/types/api/AuthenticateApi.d.ts +38 -0
  11. package/types/api/AuthenticateApi.d.ts.map +1 -0
  12. package/types/api/AuthenticationSettingsApi.d.ts +31 -0
  13. package/types/api/AuthenticationSettingsApi.d.ts.map +1 -0
  14. package/types/api/BaseApi.d.ts +190 -0
  15. package/types/api/BaseApi.d.ts.map +1 -0
  16. package/types/api/CirclesOfTrustApi.d.ts +52 -0
  17. package/types/api/CirclesOfTrustApi.d.ts.map +1 -0
  18. package/types/api/IdmConfigApi.d.ts +69 -0
  19. package/types/api/IdmConfigApi.d.ts.map +1 -0
  20. package/types/api/IdmScriptApi.d.ts +17 -0
  21. package/types/api/IdmScriptApi.d.ts.map +1 -0
  22. package/types/api/IdmSystemApi.d.ts +111 -0
  23. package/types/api/IdmSystemApi.d.ts.map +1 -0
  24. package/types/api/InternalObjectApi.d.ts +103 -0
  25. package/types/api/InternalObjectApi.d.ts.map +1 -0
  26. package/types/api/ManagedObjectApi.d.ts +252 -0
  27. package/types/api/ManagedObjectApi.d.ts.map +1 -0
  28. package/types/api/ManagedSystemObjectApi.d.ts +150 -0
  29. package/types/api/ManagedSystemObjectApi.d.ts.map +1 -0
  30. package/types/api/NodeApi.d.ts +243 -0
  31. package/types/api/NodeApi.d.ts.map +1 -0
  32. package/types/api/OAuth2ClientApi.d.ts +78 -0
  33. package/types/api/OAuth2ClientApi.d.ts.map +1 -0
  34. package/types/api/OAuth2OIDCApi.d.ts +121 -0
  35. package/types/api/OAuth2OIDCApi.d.ts.map +1 -0
  36. package/types/api/OAuth2ProviderApi.d.ts +176 -0
  37. package/types/api/OAuth2ProviderApi.d.ts.map +1 -0
  38. package/types/api/OAuth2TrustedJwtIssuerApi.d.ts +54 -0
  39. package/types/api/OAuth2TrustedJwtIssuerApi.d.ts.map +1 -0
  40. package/types/api/PoliciesApi.d.ts +60 -0
  41. package/types/api/PoliciesApi.d.ts.map +1 -0
  42. package/types/api/PolicySetApi.d.ts +52 -0
  43. package/types/api/PolicySetApi.d.ts.map +1 -0
  44. package/types/api/RawConfigApi.d.ts +75 -0
  45. package/types/api/RawConfigApi.d.ts.map +1 -0
  46. package/types/api/RealmApi.d.ts +54 -0
  47. package/types/api/RealmApi.d.ts.map +1 -0
  48. package/types/api/ReconApi.d.ts +171 -0
  49. package/types/api/ReconApi.d.ts.map +1 -0
  50. package/types/api/ResourceTypesApi.d.ts +63 -0
  51. package/types/api/ResourceTypesApi.d.ts.map +1 -0
  52. package/types/api/Saml2Api.d.ts +112 -0
  53. package/types/api/Saml2Api.d.ts.map +1 -0
  54. package/types/api/ScriptApi.d.ts +94 -0
  55. package/types/api/ScriptApi.d.ts.map +1 -0
  56. package/types/api/ScriptTypeApi.d.ts +103 -0
  57. package/types/api/ScriptTypeApi.d.ts.map +1 -0
  58. package/types/api/SecretStoreApi.d.ts +185 -0
  59. package/types/api/SecretStoreApi.d.ts.map +1 -0
  60. package/types/api/ServerInfoApi.d.ts +26 -0
  61. package/types/api/ServerInfoApi.d.ts.map +1 -0
  62. package/types/api/ServiceApi.d.ts +102 -0
  63. package/types/api/ServiceApi.d.ts.map +1 -0
  64. package/types/api/SessionApi.d.ts +23 -0
  65. package/types/api/SessionApi.d.ts.map +1 -0
  66. package/types/api/SocialIdentityProvidersApi.d.ts +89 -0
  67. package/types/api/SocialIdentityProvidersApi.d.ts.map +1 -0
  68. package/types/api/TreeApi.d.ts +62 -0
  69. package/types/api/TreeApi.d.ts.map +1 -0
  70. package/types/api/UserApi.d.ts +159 -0
  71. package/types/api/UserApi.d.ts.map +1 -0
  72. package/types/api/classic/ServerApi.d.ts +78 -0
  73. package/types/api/classic/ServerApi.d.ts.map +1 -0
  74. package/types/api/classic/SiteApi.d.ts +39 -0
  75. package/types/api/classic/SiteApi.d.ts.map +1 -0
  76. package/types/api/cloud/AdminFederationProvidersApi.d.ts +71 -0
  77. package/types/api/cloud/AdminFederationProvidersApi.d.ts.map +1 -0
  78. package/types/api/cloud/EnvAIAgentApi.d.ts +9 -0
  79. package/types/api/cloud/EnvAIAgentApi.d.ts.map +1 -0
  80. package/types/api/cloud/EnvCSRsApi.d.ts +165 -0
  81. package/types/api/cloud/EnvCSRsApi.d.ts.map +1 -0
  82. package/types/api/cloud/EnvCertificatesApi.d.ts +74 -0
  83. package/types/api/cloud/EnvCertificatesApi.d.ts.map +1 -0
  84. package/types/api/cloud/EnvContentSecurityPolicyApi.d.ts +87 -0
  85. package/types/api/cloud/EnvContentSecurityPolicyApi.d.ts.map +1 -0
  86. package/types/api/cloud/EnvCookieDomainsApi.d.ts +26 -0
  87. package/types/api/cloud/EnvCookieDomainsApi.d.ts.map +1 -0
  88. package/types/api/cloud/EnvCustomDomainsApi.d.ts +37 -0
  89. package/types/api/cloud/EnvCustomDomainsApi.d.ts.map +1 -0
  90. package/types/api/cloud/EnvDirectConfigurationSessionApi.d.ts +43 -0
  91. package/types/api/cloud/EnvDirectConfigurationSessionApi.d.ts.map +1 -0
  92. package/types/api/cloud/EnvFederationEnforcementApi.d.ts +26 -0
  93. package/types/api/cloud/EnvFederationEnforcementApi.d.ts.map +1 -0
  94. package/types/api/cloud/EnvInfoApi.d.ts +22 -0
  95. package/types/api/cloud/EnvInfoApi.d.ts.map +1 -0
  96. package/types/api/cloud/EnvPromotionApi.d.ts +218 -0
  97. package/types/api/cloud/EnvPromotionApi.d.ts.map +1 -0
  98. package/types/api/cloud/EnvReleaseApi.d.ts +16 -0
  99. package/types/api/cloud/EnvReleaseApi.d.ts.map +1 -0
  100. package/types/api/cloud/EnvSSOCookieConfigApi.d.ts +35 -0
  101. package/types/api/cloud/EnvSSOCookieConfigApi.d.ts.map +1 -0
  102. package/types/api/cloud/EnvServiceAccountScopesApi.d.ts +17 -0
  103. package/types/api/cloud/EnvServiceAccountScopesApi.d.ts.map +1 -0
  104. package/types/api/cloud/EsvCountApi.d.ts +13 -0
  105. package/types/api/cloud/EsvCountApi.d.ts.map +1 -0
  106. package/types/api/cloud/FeatureApi.d.ts +16 -0
  107. package/types/api/cloud/FeatureApi.d.ts.map +1 -0
  108. package/types/api/cloud/IdmFeatureApi.d.ts +65 -0
  109. package/types/api/cloud/IdmFeatureApi.d.ts.map +1 -0
  110. package/types/api/cloud/LogApi.d.ts +108 -0
  111. package/types/api/cloud/LogApi.d.ts.map +1 -0
  112. package/types/api/cloud/SecretsApi.d.ts +163 -0
  113. package/types/api/cloud/SecretsApi.d.ts.map +1 -0
  114. package/types/api/cloud/StartupApi.d.ts +20 -0
  115. package/types/api/cloud/StartupApi.d.ts.map +1 -0
  116. package/types/api/cloud/TelemetryApi.d.ts +60 -0
  117. package/types/api/cloud/TelemetryApi.d.ts.map +1 -0
  118. package/types/api/cloud/VariablesApi.d.ts +86 -0
  119. package/types/api/cloud/VariablesApi.d.ts.map +1 -0
  120. package/types/api/cloud/WSFedApi.d.ts +495 -0
  121. package/types/api/cloud/WSFedApi.d.ts.map +1 -0
  122. package/types/api/cloud/iga/IgaCertificationTemplateApi.d.ts +227 -0
  123. package/types/api/cloud/iga/IgaCertificationTemplateApi.d.ts.map +1 -0
  124. package/types/api/cloud/iga/IgaEventApi.d.ts +111 -0
  125. package/types/api/cloud/iga/IgaEventApi.d.ts.map +1 -0
  126. package/types/api/cloud/iga/IgaGlossaryApi.d.ts +103 -0
  127. package/types/api/cloud/iga/IgaGlossaryApi.d.ts.map +1 -0
  128. package/types/api/cloud/iga/IgaRequestFormApi.d.ts +184 -0
  129. package/types/api/cloud/iga/IgaRequestFormApi.d.ts.map +1 -0
  130. package/types/api/cloud/iga/IgaRequestTypeApi.d.ts +124 -0
  131. package/types/api/cloud/iga/IgaRequestTypeApi.d.ts.map +1 -0
  132. package/types/api/cloud/iga/IgaWorkflowApi.d.ts +208 -0
  133. package/types/api/cloud/iga/IgaWorkflowApi.d.ts.map +1 -0
  134. package/types/ext/axios-curlirize/curlirize.d.ts +14 -0
  135. package/types/ext/axios-curlirize/curlirize.d.ts.map +1 -0
  136. package/types/ext/axios-curlirize/lib/CurlHelper.d.ts +12 -0
  137. package/types/ext/axios-curlirize/lib/CurlHelper.d.ts.map +1 -0
  138. package/types/index.d.ts +11 -0
  139. package/types/index.d.ts.map +1 -0
  140. package/types/lib/FrodoLib.d.ts +407 -0
  141. package/types/lib/FrodoLib.d.ts.map +1 -0
  142. package/types/lib/Help.d.ts +18 -0
  143. package/types/lib/Help.d.ts.map +1 -0
  144. package/types/mcp/CapabilityMetadata.d.ts +48 -0
  145. package/types/mcp/CapabilityMetadata.d.ts.map +1 -0
  146. package/types/mcp/CapabilityPolicy.d.ts +22 -0
  147. package/types/mcp/CapabilityPolicy.d.ts.map +1 -0
  148. package/types/mcp/CapabilityRegistry.d.ts +62 -0
  149. package/types/mcp/CapabilityRegistry.d.ts.map +1 -0
  150. package/types/mcp/CapabilityRouting.d.ts +9 -0
  151. package/types/mcp/CapabilityRouting.d.ts.map +1 -0
  152. package/types/mcp/CapabilityTypes.d.ts +371 -0
  153. package/types/mcp/CapabilityTypes.d.ts.map +1 -0
  154. package/types/mcp/DiscoveryHydration.d.ts +21 -0
  155. package/types/mcp/DiscoveryHydration.d.ts.map +1 -0
  156. package/types/mcp/DocsContext.d.ts +123 -0
  157. package/types/mcp/DocsContext.d.ts.map +1 -0
  158. package/types/mcp/McpService.d.ts +94 -0
  159. package/types/mcp/McpService.d.ts.map +1 -0
  160. package/types/mcp/ProfileRegistry.d.ts +63 -0
  161. package/types/mcp/ProfileRegistry.d.ts.map +1 -0
  162. package/types/mcp/SemanticIdentifiers.d.ts +17 -0
  163. package/types/mcp/SemanticIdentifiers.d.ts.map +1 -0
  164. package/types/mcp/SemanticObjectFamilies.d.ts +24 -0
  165. package/types/mcp/SemanticObjectFamilies.d.ts.map +1 -0
  166. package/types/mcp/ToolManifest.d.ts +231 -0
  167. package/types/mcp/ToolManifest.d.ts.map +1 -0
  168. package/types/mcp/ToolRuntime.d.ts +477 -0
  169. package/types/mcp/ToolRuntime.d.ts.map +1 -0
  170. package/types/mcp/index.d.ts +20 -0
  171. package/types/mcp/index.d.ts.map +1 -0
  172. package/types/ops/AdminOps.d.ts +85 -0
  173. package/types/ops/AdminOps.d.ts.map +1 -0
  174. package/types/ops/AgentOps.d.ts +938 -0
  175. package/types/ops/AgentOps.d.ts.map +1 -0
  176. package/types/ops/AmConfigOps.d.ts +96 -0
  177. package/types/ops/AmConfigOps.d.ts.map +1 -0
  178. package/types/ops/ApiFactoryOps.d.ts +77 -0
  179. package/types/ops/ApiFactoryOps.d.ts.map +1 -0
  180. package/types/ops/ApplicationOps.d.ts +334 -0
  181. package/types/ops/ApplicationOps.d.ts.map +1 -0
  182. package/types/ops/AuthenticateOps.d.ts +196 -0
  183. package/types/ops/AuthenticateOps.d.ts.map +1 -0
  184. package/types/ops/AuthenticationSettingsOps.d.ts +78 -0
  185. package/types/ops/AuthenticationSettingsOps.d.ts.map +1 -0
  186. package/types/ops/BrowserAuthenticateOps.d.ts +188 -0
  187. package/types/ops/BrowserAuthenticateOps.d.ts.map +1 -0
  188. package/types/ops/CallbackOps.d.ts +27 -0
  189. package/types/ops/CallbackOps.d.ts.map +1 -0
  190. package/types/ops/CallerTrustTierOps.d.ts +103 -0
  191. package/types/ops/CallerTrustTierOps.d.ts.map +1 -0
  192. package/types/ops/CirclesOfTrustOps.d.ts +203 -0
  193. package/types/ops/CirclesOfTrustOps.d.ts.map +1 -0
  194. package/types/ops/ConfigOps.d.ts +214 -0
  195. package/types/ops/ConfigOps.d.ts.map +1 -0
  196. package/types/ops/ConnectionProfileOps.d.ts +346 -0
  197. package/types/ops/ConnectionProfileOps.d.ts.map +1 -0
  198. package/types/ops/ConnectorOps.d.ts +269 -0
  199. package/types/ops/ConnectorOps.d.ts.map +1 -0
  200. package/types/ops/EmailTemplateOps.d.ts +160 -0
  201. package/types/ops/EmailTemplateOps.d.ts.map +1 -0
  202. package/types/ops/FrodoError.d.ts +40 -0
  203. package/types/ops/FrodoError.d.ts.map +1 -0
  204. package/types/ops/IdmConfigOps.d.ts +286 -0
  205. package/types/ops/IdmConfigOps.d.ts.map +1 -0
  206. package/types/ops/IdmCryptoOps.d.ts +68 -0
  207. package/types/ops/IdmCryptoOps.d.ts.map +1 -0
  208. package/types/ops/IdmScriptOps.d.ts +29 -0
  209. package/types/ops/IdmScriptOps.d.ts.map +1 -0
  210. package/types/ops/IdmSystemOps.d.ts +198 -0
  211. package/types/ops/IdmSystemOps.d.ts.map +1 -0
  212. package/types/ops/IdpOps.d.ts +234 -0
  213. package/types/ops/IdpOps.d.ts.map +1 -0
  214. package/types/ops/InfoOps.d.ts +28 -0
  215. package/types/ops/InfoOps.d.ts.map +1 -0
  216. package/types/ops/InternalRoleOps.d.ts +232 -0
  217. package/types/ops/InternalRoleOps.d.ts.map +1 -0
  218. package/types/ops/JoseOps.d.ts +87 -0
  219. package/types/ops/JoseOps.d.ts.map +1 -0
  220. package/types/ops/JourneyOps.d.ts +573 -0
  221. package/types/ops/JourneyOps.d.ts.map +1 -0
  222. package/types/ops/ManagedObjectOps.d.ts +393 -0
  223. package/types/ops/ManagedObjectOps.d.ts.map +1 -0
  224. package/types/ops/ManagedObjectSchemaOps.d.ts +757 -0
  225. package/types/ops/ManagedObjectSchemaOps.d.ts.map +1 -0
  226. package/types/ops/ManagedSystemObjectOps.d.ts +270 -0
  227. package/types/ops/ManagedSystemObjectOps.d.ts.map +1 -0
  228. package/types/ops/ManagedSystemObjectSchemaOps.d.ts +42 -0
  229. package/types/ops/ManagedSystemObjectSchemaOps.d.ts.map +1 -0
  230. package/types/ops/MappingOps.d.ts +332 -0
  231. package/types/ops/MappingOps.d.ts.map +1 -0
  232. package/types/ops/NodeOps.d.ts +627 -0
  233. package/types/ops/NodeOps.d.ts.map +1 -0
  234. package/types/ops/OAuth2ClientOps.d.ts +235 -0
  235. package/types/ops/OAuth2ClientOps.d.ts.map +1 -0
  236. package/types/ops/OAuth2OidcOps.d.ts +64 -0
  237. package/types/ops/OAuth2OidcOps.d.ts.map +1 -0
  238. package/types/ops/OAuth2ProviderOps.d.ts +57 -0
  239. package/types/ops/OAuth2ProviderOps.d.ts.map +1 -0
  240. package/types/ops/OAuth2TrustedJwtIssuerOps.d.ts +223 -0
  241. package/types/ops/OAuth2TrustedJwtIssuerOps.d.ts.map +1 -0
  242. package/types/ops/OpsTypes.d.ts +12 -0
  243. package/types/ops/OpsTypes.d.ts.map +1 -0
  244. package/types/ops/OrganizationOps.d.ts +34 -0
  245. package/types/ops/OrganizationOps.d.ts.map +1 -0
  246. package/types/ops/PolicyOps.d.ts +294 -0
  247. package/types/ops/PolicyOps.d.ts.map +1 -0
  248. package/types/ops/PolicySetOps.d.ts +195 -0
  249. package/types/ops/PolicySetOps.d.ts.map +1 -0
  250. package/types/ops/PrivilegeEscalationOps.d.ts +51 -0
  251. package/types/ops/PrivilegeEscalationOps.d.ts.map +1 -0
  252. package/types/ops/RawConfigOps.d.ts +67 -0
  253. package/types/ops/RawConfigOps.d.ts.map +1 -0
  254. package/types/ops/RealmOps.d.ts +196 -0
  255. package/types/ops/RealmOps.d.ts.map +1 -0
  256. package/types/ops/ReconOps.d.ts +57 -0
  257. package/types/ops/ReconOps.d.ts.map +1 -0
  258. package/types/ops/RequiredScopesOps.d.ts +69 -0
  259. package/types/ops/RequiredScopesOps.d.ts.map +1 -0
  260. package/types/ops/ResourceTypeOps.d.ts +219 -0
  261. package/types/ops/ResourceTypeOps.d.ts.map +1 -0
  262. package/types/ops/Saml2Ops.d.ts +261 -0
  263. package/types/ops/Saml2Ops.d.ts.map +1 -0
  264. package/types/ops/ScriptOps.d.ts +426 -0
  265. package/types/ops/ScriptOps.d.ts.map +1 -0
  266. package/types/ops/ScriptTypeOps.d.ts +124 -0
  267. package/types/ops/ScriptTypeOps.d.ts.map +1 -0
  268. package/types/ops/SecretStoreOps.d.ts +357 -0
  269. package/types/ops/SecretStoreOps.d.ts.map +1 -0
  270. package/types/ops/ServiceOps.d.ts +194 -0
  271. package/types/ops/ServiceOps.d.ts.map +1 -0
  272. package/types/ops/SessionOps.d.ts +22 -0
  273. package/types/ops/SessionOps.d.ts.map +1 -0
  274. package/types/ops/ThemeOps.d.ts +245 -0
  275. package/types/ops/ThemeOps.d.ts.map +1 -0
  276. package/types/ops/TokenCacheOps.d.ts +243 -0
  277. package/types/ops/TokenCacheOps.d.ts.map +1 -0
  278. package/types/ops/UserOps.d.ts +199 -0
  279. package/types/ops/UserOps.d.ts.map +1 -0
  280. package/types/ops/VersionUtils.d.ts +29 -0
  281. package/types/ops/VersionUtils.d.ts.map +1 -0
  282. package/types/ops/classic/ServerOps.d.ts +195 -0
  283. package/types/ops/classic/ServerOps.d.ts.map +1 -0
  284. package/types/ops/classic/SiteOps.d.ts +117 -0
  285. package/types/ops/classic/SiteOps.d.ts.map +1 -0
  286. package/types/ops/cloud/AdminFederationOps.d.ts +165 -0
  287. package/types/ops/cloud/AdminFederationOps.d.ts.map +1 -0
  288. package/types/ops/cloud/EnvAIAgentOps.d.ts +18 -0
  289. package/types/ops/cloud/EnvAIAgentOps.d.ts.map +1 -0
  290. package/types/ops/cloud/EnvCSRsOps.d.ts +86 -0
  291. package/types/ops/cloud/EnvCSRsOps.d.ts.map +1 -0
  292. package/types/ops/cloud/EnvCertificatesOps.d.ts +140 -0
  293. package/types/ops/cloud/EnvCertificatesOps.d.ts.map +1 -0
  294. package/types/ops/cloud/EnvContentSecurityPolicyOps.d.ts +101 -0
  295. package/types/ops/cloud/EnvContentSecurityPolicyOps.d.ts.map +1 -0
  296. package/types/ops/cloud/EnvCookieDomainsOps.d.ts +36 -0
  297. package/types/ops/cloud/EnvCookieDomainsOps.d.ts.map +1 -0
  298. package/types/ops/cloud/EnvCustomDomainsOps.d.ts +53 -0
  299. package/types/ops/cloud/EnvCustomDomainsOps.d.ts.map +1 -0
  300. package/types/ops/cloud/EnvDirectConfigurationSessionOps.d.ts +55 -0
  301. package/types/ops/cloud/EnvDirectConfigurationSessionOps.d.ts.map +1 -0
  302. package/types/ops/cloud/EnvFederationEnforcementOps.d.ts +58 -0
  303. package/types/ops/cloud/EnvFederationEnforcementOps.d.ts.map +1 -0
  304. package/types/ops/cloud/EnvPromotionOps.d.ts +175 -0
  305. package/types/ops/cloud/EnvPromotionOps.d.ts.map +1 -0
  306. package/types/ops/cloud/EnvReleaseOps.d.ts +19 -0
  307. package/types/ops/cloud/EnvReleaseOps.d.ts.map +1 -0
  308. package/types/ops/cloud/EnvSSOCookieConfigOps.d.ts +50 -0
  309. package/types/ops/cloud/EnvSSOCookieConfigOps.d.ts.map +1 -0
  310. package/types/ops/cloud/EnvServiceAccountScopesOps.d.ts +21 -0
  311. package/types/ops/cloud/EnvServiceAccountScopesOps.d.ts.map +1 -0
  312. package/types/ops/cloud/EsvCountOps.d.ts +15 -0
  313. package/types/ops/cloud/EsvCountOps.d.ts.map +1 -0
  314. package/types/ops/cloud/FeatureOps.d.ts +34 -0
  315. package/types/ops/cloud/FeatureOps.d.ts.map +1 -0
  316. package/types/ops/cloud/IdmFeatureOps.d.ts +78 -0
  317. package/types/ops/cloud/IdmFeatureOps.d.ts.map +1 -0
  318. package/types/ops/cloud/LogOps.d.ts +271 -0
  319. package/types/ops/cloud/LogOps.d.ts.map +1 -0
  320. package/types/ops/cloud/SecretsOps.d.ts +306 -0
  321. package/types/ops/cloud/SecretsOps.d.ts.map +1 -0
  322. package/types/ops/cloud/ServiceAccountOps.d.ts +86 -0
  323. package/types/ops/cloud/ServiceAccountOps.d.ts.map +1 -0
  324. package/types/ops/cloud/StartupOps.d.ts +62 -0
  325. package/types/ops/cloud/StartupOps.d.ts.map +1 -0
  326. package/types/ops/cloud/TelemetryOps.d.ts +109 -0
  327. package/types/ops/cloud/TelemetryOps.d.ts.map +1 -0
  328. package/types/ops/cloud/VariablesOps.d.ts +224 -0
  329. package/types/ops/cloud/VariablesOps.d.ts.map +1 -0
  330. package/types/ops/cloud/WSFedOps.d.ts +412 -0
  331. package/types/ops/cloud/WSFedOps.d.ts.map +1 -0
  332. package/types/ops/cloud/iga/IgaCertificationTemplateOps.d.ts +261 -0
  333. package/types/ops/cloud/iga/IgaCertificationTemplateOps.d.ts.map +1 -0
  334. package/types/ops/cloud/iga/IgaEventOps.d.ts +242 -0
  335. package/types/ops/cloud/iga/IgaEventOps.d.ts.map +1 -0
  336. package/types/ops/cloud/iga/IgaGlossaryOps.d.ts +241 -0
  337. package/types/ops/cloud/iga/IgaGlossaryOps.d.ts.map +1 -0
  338. package/types/ops/cloud/iga/IgaRequestFormOps.d.ts +259 -0
  339. package/types/ops/cloud/iga/IgaRequestFormOps.d.ts.map +1 -0
  340. package/types/ops/cloud/iga/IgaRequestTypeOps.d.ts +240 -0
  341. package/types/ops/cloud/iga/IgaRequestTypeOps.d.ts.map +1 -0
  342. package/types/ops/cloud/iga/IgaWorkflowOps.d.ts +334 -0
  343. package/types/ops/cloud/iga/IgaWorkflowOps.d.ts.map +1 -0
  344. package/types/ops/internal/RelationshipHelpers.d.ts +111 -0
  345. package/types/ops/internal/RelationshipHelpers.d.ts.map +1 -0
  346. package/types/shared/Constants.d.ts +100 -0
  347. package/types/shared/Constants.d.ts.map +1 -0
  348. package/types/shared/OperationType.d.ts +14 -0
  349. package/types/shared/OperationType.d.ts.map +1 -0
  350. package/types/shared/State.d.ts +355 -0
  351. package/types/shared/State.d.ts.map +1 -0
  352. package/types/shared/Version.d.ts +16 -0
  353. package/types/shared/Version.d.ts.map +1 -0
  354. package/types/test/mocks/ForgeRockApiMockEngine.d.ts +38 -0
  355. package/types/test/mocks/ForgeRockApiMockEngine.d.ts.map +1 -0
  356. package/types/test/setup/EmailTemplateSetup.d.ts +8 -0
  357. package/types/test/setup/EmailTemplateSetup.d.ts.map +1 -0
  358. package/types/test/setup/IgaCertificationTemplateSetup.d.ts +12 -0
  359. package/types/test/setup/IgaCertificationTemplateSetup.d.ts.map +1 -0
  360. package/types/test/setup/IgaEventSetup.d.ts +22 -0
  361. package/types/test/setup/IgaEventSetup.d.ts.map +1 -0
  362. package/types/test/setup/IgaGlossarySetup.d.ts +11 -0
  363. package/types/test/setup/IgaGlossarySetup.d.ts.map +1 -0
  364. package/types/test/setup/IgaRequestFormSetup.d.ts +42 -0
  365. package/types/test/setup/IgaRequestFormSetup.d.ts.map +1 -0
  366. package/types/test/setup/IgaRequestTypeSetup.d.ts +10 -0
  367. package/types/test/setup/IgaRequestTypeSetup.d.ts.map +1 -0
  368. package/types/test/setup/IgaWorkflowSetup.d.ts +32 -0
  369. package/types/test/setup/IgaWorkflowSetup.d.ts.map +1 -0
  370. package/types/test/setup/JourneySetup.d.ts +18 -0
  371. package/types/test/setup/JourneySetup.d.ts.map +1 -0
  372. package/types/test/setup/NodeSetup.d.ts +14 -0
  373. package/types/test/setup/NodeSetup.d.ts.map +1 -0
  374. package/types/test/setup/RawConfigSetup.d.ts +2 -0
  375. package/types/test/setup/RawConfigSetup.d.ts.map +1 -0
  376. package/types/test/setup/SecretSetup.d.ts +69 -0
  377. package/types/test/setup/SecretSetup.d.ts.map +1 -0
  378. package/types/test/setup/StartupSetup.d.ts +2 -0
  379. package/types/test/setup/StartupSetup.d.ts.map +1 -0
  380. package/types/test/setup/TelemetrySetup.d.ts +8 -0
  381. package/types/test/setup/TelemetrySetup.d.ts.map +1 -0
  382. package/types/test/setup/VariablesSetup.d.ts +27 -0
  383. package/types/test/setup/VariablesSetup.d.ts.map +1 -0
  384. package/types/test/utils/TestUtils.d.ts +15 -0
  385. package/types/test/utils/TestUtils.d.ts.map +1 -0
  386. package/types/utils/AsyncUtils.d.ts +14 -0
  387. package/types/utils/AsyncUtils.d.ts.map +1 -0
  388. package/types/utils/AutoSetupPolly.d.ts +25 -0
  389. package/types/utils/AutoSetupPolly.d.ts.map +1 -0
  390. package/types/utils/Base64Utils.d.ts +41 -0
  391. package/types/utils/Base64Utils.d.ts.map +1 -0
  392. package/types/utils/ColorTheme.d.ts +40 -0
  393. package/types/utils/ColorTheme.d.ts.map +1 -0
  394. package/types/utils/Console.d.ts +110 -0
  395. package/types/utils/Console.d.ts.map +1 -0
  396. package/types/utils/CryptoUtils.d.ts +35 -0
  397. package/types/utils/CryptoUtils.d.ts.map +1 -0
  398. package/types/utils/DataProtection.d.ts +24 -0
  399. package/types/utils/DataProtection.d.ts.map +1 -0
  400. package/types/utils/ExportImportUtils.d.ts +415 -0
  401. package/types/utils/ExportImportUtils.d.ts.map +1 -0
  402. package/types/utils/ForgeRockUtils.d.ts +122 -0
  403. package/types/utils/ForgeRockUtils.d.ts.map +1 -0
  404. package/types/utils/FrodoNodeHttpAdapter.d.ts +5 -0
  405. package/types/utils/FrodoNodeHttpAdapter.d.ts.map +1 -0
  406. package/types/utils/FrodoUtils.d.ts +15 -0
  407. package/types/utils/FrodoUtils.d.ts.map +1 -0
  408. package/types/utils/HelpUtils.d.ts +19 -0
  409. package/types/utils/HelpUtils.d.ts.map +1 -0
  410. package/types/utils/JsonUtils.d.ts +105 -0
  411. package/types/utils/JsonUtils.d.ts.map +1 -0
  412. package/types/utils/JwtUtils.d.ts +19 -0
  413. package/types/utils/JwtUtils.d.ts.map +1 -0
  414. package/types/utils/PkceUtils.d.ts +17 -0
  415. package/types/utils/PkceUtils.d.ts.map +1 -0
  416. package/types/utils/PollyUtils.d.ts +65 -0
  417. package/types/utils/PollyUtils.d.ts.map +1 -0
  418. package/types/utils/ScriptValidationUtils.d.ts +38 -0
  419. package/types/utils/ScriptValidationUtils.d.ts.map +1 -0
  420. package/types/utils/SemverUtils.d.ts +61 -0
  421. package/types/utils/SemverUtils.d.ts.map +1 -0
  422. package/types/utils/SetupPollyForFrodoLib.d.ts +7 -0
  423. package/types/utils/SetupPollyForFrodoLib.d.ts.map +1 -0
  424. package/types/utils/TerminalBackgroundDetection.d.ts +48 -0
  425. package/types/utils/TerminalBackgroundDetection.d.ts.map +1 -0
  426. package/types/utils/TerminalContrast.d.ts +44 -0
  427. package/types/utils/TerminalContrast.d.ts.map +1 -0
@@ -0,0 +1,407 @@
1
+ import { Admin } from '../ops/AdminOps';
2
+ import { Agent } from '../ops/AgentOps';
3
+ import { AmConfig } from '../ops/AmConfigOps';
4
+ import { ApiFactory } from '../ops/ApiFactoryOps';
5
+ import { Application } from '../ops/ApplicationOps';
6
+ import { Authenticate } from '../ops/AuthenticateOps';
7
+ import { AuthenticationSettings } from '../ops/AuthenticationSettingsOps';
8
+ import { CirclesOfTrust } from '../ops/CirclesOfTrustOps';
9
+ import { Server } from '../ops/classic/ServerOps';
10
+ import { Site } from '../ops/classic/SiteOps';
11
+ import { AdminFederation } from '../ops/cloud/AdminFederationOps';
12
+ import { EnvAIAgent } from '../ops/cloud/EnvAIAgentOps';
13
+ import { EnvCertificate } from '../ops/cloud/EnvCertificatesOps';
14
+ import { EnvContentSecurityPolicy } from '../ops/cloud/EnvContentSecurityPolicyOps';
15
+ import { EnvCookieDomains } from '../ops/cloud/EnvCookieDomainsOps';
16
+ import { EnvCSR } from '../ops/cloud/EnvCSRsOps';
17
+ import { EnvCustomDomains } from '../ops/cloud/EnvCustomDomainsOps';
18
+ import { EnvDirectConfigurationSession } from '../ops/cloud/EnvDirectConfigurationSessionOps';
19
+ import { EnvFederationEnforcement } from '../ops/cloud/EnvFederationEnforcementOps';
20
+ import { EnvPromotion } from '../ops/cloud/EnvPromotionOps';
21
+ import { EnvRelease } from '../ops/cloud/EnvReleaseOps';
22
+ import { EnvServiceAccountScopes } from '../ops/cloud/EnvServiceAccountScopesOps';
23
+ import { EnvSSOCookieConfig } from '../ops/cloud/EnvSSOCookieConfigOps';
24
+ import { EsvCount } from '../ops/cloud/EsvCountOps';
25
+ import { Feature } from '../ops/cloud/FeatureOps';
26
+ import { IdmFeature } from '../ops/cloud/IdmFeatureOps';
27
+ import { CertificationTemplate } from '../ops/cloud/iga/IgaCertificationTemplateOps';
28
+ import { IgaEvent } from '../ops/cloud/iga/IgaEventOps';
29
+ import { Glossary } from '../ops/cloud/iga/IgaGlossaryOps';
30
+ import { RequestForm } from '../ops/cloud/iga/IgaRequestFormOps';
31
+ import { RequestType } from '../ops/cloud/iga/IgaRequestTypeOps';
32
+ import { Workflow } from '../ops/cloud/iga/IgaWorkflowOps';
33
+ import { Log } from '../ops/cloud/LogOps';
34
+ import { Secret } from '../ops/cloud/SecretsOps';
35
+ import { ServiceAccount } from '../ops/cloud/ServiceAccountOps';
36
+ import { Startup } from '../ops/cloud/StartupOps';
37
+ import { Telemetry } from '../ops/cloud/TelemetryOps';
38
+ import { Variable } from '../ops/cloud/VariablesOps';
39
+ import { WSFed } from '../ops/cloud/WSFedOps';
40
+ import { Config } from '../ops/ConfigOps';
41
+ import { ConnectionProfile } from '../ops/ConnectionProfileOps';
42
+ import { Connector } from '../ops/ConnectorOps';
43
+ import { EmailTemplate } from '../ops/EmailTemplateOps';
44
+ import { IdmConfig } from '../ops/IdmConfigOps';
45
+ import { IdmCrypto } from '../ops/IdmCryptoOps';
46
+ import { IdmScript } from '../ops/IdmScriptOps';
47
+ import { IdmSystem } from '../ops/IdmSystemOps';
48
+ import { Idp } from '../ops/IdpOps';
49
+ import { Info } from '../ops/InfoOps';
50
+ import { InternalRole } from '../ops/InternalRoleOps';
51
+ import { Jose } from '../ops/JoseOps';
52
+ import { Journey } from '../ops/JourneyOps';
53
+ import { ManagedObject } from '../ops/ManagedObjectOps';
54
+ import { ManagedObjectSchemaOps as ManagedObjectSchemaNamespace } from '../ops/ManagedObjectSchemaOps';
55
+ import { ManagedSystemObject } from '../ops/ManagedSystemObjectOps';
56
+ import { ManagedSystemObjectSchemaOps as ManagedSystemObjectSchemaNamespace } from '../ops/ManagedSystemObjectSchemaOps';
57
+ import { Mapping } from '../ops/MappingOps';
58
+ import { Node } from '../ops/NodeOps';
59
+ import { OAuth2Client } from '../ops/OAuth2ClientOps';
60
+ import { OAuth2Oidc } from '../ops/OAuth2OidcOps';
61
+ import { OAuth2Provider } from '../ops/OAuth2ProviderOps';
62
+ import { OAuth2TrustedJwtIssuer } from '../ops/OAuth2TrustedJwtIssuerOps';
63
+ import { Organization } from '../ops/OrganizationOps';
64
+ import { Policy } from '../ops/PolicyOps';
65
+ import { PolicySet } from '../ops/PolicySetOps';
66
+ import { RawConfig } from '../ops/RawConfigOps';
67
+ import { Realm } from '../ops/RealmOps';
68
+ import { Recon } from '../ops/ReconOps';
69
+ import { ResourceType } from '../ops/ResourceTypeOps';
70
+ import { Saml2 } from '../ops/Saml2Ops';
71
+ import { Script } from '../ops/ScriptOps';
72
+ import { ScriptType } from '../ops/ScriptTypeOps';
73
+ import { SecretStore } from '../ops/SecretStoreOps';
74
+ import { Service } from '../ops/ServiceOps';
75
+ import { Session } from '../ops/SessionOps';
76
+ import { Theme } from '../ops/ThemeOps';
77
+ import { TokenCache } from '../ops/TokenCacheOps';
78
+ import { User } from '../ops/UserOps';
79
+ import { Version } from '../ops/VersionUtils';
80
+ import { Constants } from '../shared/Constants';
81
+ import { State, StateInterface } from '../shared/State';
82
+ import { Base64 } from '../utils/Base64Utils';
83
+ import { FrodoCrypto } from '../utils/CryptoUtils';
84
+ import { ExportImport } from '../utils/ExportImportUtils';
85
+ import { FRUtils } from '../utils/ForgeRockUtils';
86
+ import { FrodoUtils } from '../utils/FrodoUtils';
87
+ import { HelpUtils } from '../utils/HelpUtils';
88
+ import { Json } from '../utils/JsonUtils';
89
+ import { ScriptValidation } from '../utils/ScriptValidationUtils';
90
+ /**
91
+ * Frodo Library
92
+ */
93
+ export type Frodo = {
94
+ state: State;
95
+ admin: Admin;
96
+ agent: Agent;
97
+ am: {
98
+ config: AmConfig;
99
+ };
100
+ app: Application;
101
+ authn: {
102
+ journey: Journey;
103
+ node: Node;
104
+ settings: AuthenticationSettings;
105
+ };
106
+ authz: {
107
+ policy: Policy;
108
+ policySet: PolicySet;
109
+ resourceType: ResourceType;
110
+ };
111
+ cloud: EsvCount & {
112
+ adminFed: AdminFederation;
113
+ env: EnvAIAgent & EnvContentSecurityPolicy & EnvCookieDomains & EnvCustomDomains & EnvDirectConfigurationSession & EnvFederationEnforcement & EnvRelease & EnvServiceAccountScopes & EnvSSOCookieConfig & {
114
+ cert: EnvCertificate;
115
+ csr: EnvCSR;
116
+ promotion: EnvPromotion;
117
+ };
118
+ /**
119
+ * @deprecated since v2.0.4 use {@link frodo.cloud.getEsvCount | frodo.cloud.getEsvCount} instead
120
+ */
121
+ esvCount: EsvCount;
122
+ feature: Feature;
123
+ idmFeature: IdmFeature;
124
+ iga: {
125
+ certificationTemplate: CertificationTemplate;
126
+ event: IgaEvent;
127
+ glossary: Glossary;
128
+ requestForm: RequestForm;
129
+ requestType: RequestType;
130
+ workflow: Workflow;
131
+ };
132
+ log: Log;
133
+ secret: Secret;
134
+ serviceAccount: ServiceAccount;
135
+ startup: Startup;
136
+ telemetry: Telemetry;
137
+ variable: Variable;
138
+ wsfed: WSFed;
139
+ };
140
+ config: Config;
141
+ conn: ConnectionProfile;
142
+ cache: TokenCache;
143
+ email: {
144
+ template: EmailTemplate;
145
+ };
146
+ factory: ApiFactory;
147
+ idm: {
148
+ config: IdmConfig;
149
+ connector: Connector;
150
+ crypto: IdmCrypto;
151
+ managed: ManagedObject & {
152
+ schema: ManagedObjectSchemaNamespace;
153
+ };
154
+ managedSystem: ManagedSystemObject & {
155
+ schema: ManagedSystemObjectSchemaNamespace;
156
+ };
157
+ mapping: Mapping;
158
+ organization: Organization;
159
+ recon: Recon;
160
+ script: IdmScript;
161
+ system: IdmSystem;
162
+ };
163
+ info: Info;
164
+ login: Authenticate;
165
+ oauth2oidc: {
166
+ client: OAuth2Client;
167
+ endpoint: OAuth2Oidc;
168
+ external: Idp;
169
+ provider: OAuth2Provider;
170
+ issuer: OAuth2TrustedJwtIssuer;
171
+ };
172
+ rawConfig: RawConfig;
173
+ realm: Realm;
174
+ role: InternalRole;
175
+ saml2: {
176
+ circlesOfTrust: CirclesOfTrust;
177
+ entityProvider: Saml2;
178
+ };
179
+ script: Script;
180
+ scriptType: ScriptType;
181
+ server: Server;
182
+ secretStore: SecretStore;
183
+ service: Service;
184
+ session: Session;
185
+ site: Site;
186
+ theme: Theme;
187
+ user: User;
188
+ utils: FRUtils & FrodoUtils & HelpUtils & ScriptValidation & ExportImport & Base64 & {
189
+ constants: Constants;
190
+ crypto: FrodoCrypto;
191
+ jose: Jose;
192
+ json: Json;
193
+ version: Version;
194
+ };
195
+ /**
196
+ * Create a new frodo instance
197
+ * @param {StateInterface} config Initial state configuration to use with the new instance
198
+ * @returns {Frodo} frodo instance
199
+ */
200
+ createInstance(config: StateInterface): Frodo;
201
+ /**
202
+ * Factory helper to create a frodo instance ready for logging in with an admin user account
203
+ * @param {string} host host base URL, e.g. 'https://openam-my-tenant.forgeblocks.com/am'
204
+ * @param {string} username admin account username
205
+ * @param {string} password admin account password
206
+ * @param {string} realm (optional) override default realm
207
+ * @param {string} deploymentType (optional) override deployment type ('cloud', 'forgeops', or 'classic')
208
+ * @param {boolean} allowInsecureConnection (optional) allow insecure connection
209
+ * @param {boolean} debug (optional) enable debug output
210
+ * @param {boolean} curlirize (optional) enable output of all library REST calls as curl commands
211
+ * @returns {Frodo} frodo instance
212
+ */
213
+ createInstanceWithAdminAccount(host: string, username: string, password: string, realm?: string, deploymentType?: string, allowInsecureConnection?: boolean, debug?: boolean, curlirize?: boolean): Frodo;
214
+ /**
215
+ * Factory helper to create a frodo instance ready for logging in with a service account
216
+ * @param {string} host host base URL, e.g. 'https://openam-my-tenant.forgeblocks.com/am'
217
+ * @param {string} serviceAccountId service account uuid
218
+ * @param {string} serviceAccountJwkStr service account JWK as stringified JSON
219
+ * @param {string} realm (optional) override default realm
220
+ * @param {string} deploymentType (optional) override deployment type ('cloud', 'forgeops', or 'classic')
221
+ * @param {boolean} allowInsecureConnection (optional) allow insecure connection
222
+ * @param {boolean} debug (optional) enable debug output
223
+ * @param {boolean} curlirize (optional) enable output of all library REST calls as curl commands
224
+ * @returns {Frodo} frodo instance
225
+ */
226
+ createInstanceWithServiceAccount(host: string, serviceAccountId: string, serviceAccountJwkStr: string, realm?: string, deploymentType?: string, allowInsecureConnection?: boolean, debug?: boolean, curlirize?: boolean): Frodo;
227
+ /**
228
+ * Factory helper to create a frodo instance ready for logging in with Amster credentials
229
+ * @param {string} host host base URL, e.g. 'https://am.example.com:8443/am'
230
+ * @param {string} amsterPrivateKey the pem encoded private key used to authenticate with Amster
231
+ * @param {string} authenticationService (optional) the authentication service used to authenticate with Amster (default: 'amsterService')
232
+ * @param {string} realm (optional) override default realm
233
+ * @param {string} deploymentType (optional) override deployment type ('cloud', 'forgeops', or 'classic')
234
+ * @param {boolean} allowInsecureConnection (optional) allow insecure connection
235
+ * @param {boolean} debug (optional) enable debug output
236
+ * @param {boolean} curlirize (optional) enable output of all library REST calls as curl commands
237
+ * @returns {Frodo} frodo instance
238
+ */
239
+ createInstanceWithAmsterAccount(host: string, amsterPrivateKey: string, authenticationService?: string, realm?: string, deploymentType?: string, allowInsecureConnection?: boolean, debug?: boolean, curlirize?: boolean): Frodo;
240
+ /**
241
+ * Factory helper to create a frodo instance ready for a real interactive
242
+ * browser login. Unlike the other three factories, this one alone doesn't
243
+ * make the instance immediately usable — a real interactive round trip is
244
+ * required first (there is no unattended way to redo it, unlike every
245
+ * other auth mode's silent background re-login). Call
246
+ * `.login.getTokensInteractive(...)` on the returned instance before using
247
+ * it, supplying a `promptHandler` to present the login step.
248
+ * @param {string} host host base URL, e.g. 'https://openam-my-tenant.forgeblocks.com/am'
249
+ * @param {string} loginClientId (optional) OAuth2 client id — mandatory for forgeops/classic (no built-in default); cloud has one
250
+ * @param {string} loginScope (optional) override the default scope requested for the target deployment type
251
+ * @param {string} loginRedirectUri (optional) full, absolute redirect URI to use, for a client registered with an exact-match redirect URI (shared with the non-interactive synthetic flow's own redirect URI setting)
252
+ * @param {string} realm (optional) override default realm
253
+ * @param {string} deploymentType (optional) deployment type ('cloud', 'forgeops', or 'classic') — required for browser login, since there is no existing session to auto-detect it from
254
+ * @param {boolean} allowInsecureConnection (optional) allow insecure connection
255
+ * @param {boolean} debug (optional) enable debug output
256
+ * @param {boolean} curlirize (optional) enable output of all library REST calls as curl commands
257
+ * @returns {Frodo} frodo instance, not yet logged in
258
+ */
259
+ createInstanceWithBrowserLogin(host: string, loginClientId?: string, loginScope?: string, loginRedirectUri?: string, realm?: string, deploymentType?: string, allowInsecureConnection?: boolean, debug?: boolean, curlirize?: boolean): Frodo;
260
+ /**
261
+ * Factory helper to create a frodo instance ready to use an already-issued,
262
+ * externally-obtained OAuth2 access token (e.g. one an MCP server verified
263
+ * as an OAuth2 resource server). Like `createInstanceWithBrowserLogin`,
264
+ * this alone doesn't make the instance immediately usable — call
265
+ * `.login.applyAccessToken(token)` on the returned instance before using
266
+ * it. Never persists to the local token cache, regardless of the
267
+ * environment's default: this credential belongs to whoever presented the
268
+ * token, not to the operator running this process.
269
+ * @param {string} host host base URL, e.g. 'https://openam-my-tenant.forgeblocks.com/am'
270
+ * @param {string} realm (optional) override default realm
271
+ * @param {string} deploymentType deployment type ('cloud', 'forgeops', or 'classic') — required, since there is no existing session to auto-detect it from
272
+ * @param {boolean} allowInsecureConnection (optional) allow insecure connection
273
+ * @param {boolean} debug (optional) enable debug output
274
+ * @param {boolean} curlirize (optional) enable output of all library REST calls as curl commands
275
+ * @returns {Frodo} frodo instance, not yet ready to use
276
+ */
277
+ createInstanceWithAccessToken(host: string, realm?: string, deploymentType?: string, allowInsecureConnection?: boolean, debug?: boolean, curlirize?: boolean): Frodo;
278
+ };
279
+ /**
280
+ * Create a new frodo instance
281
+ * @param {StateInterface} config Initial state configuration to use with the new instance
282
+ * @returns {Frodo} frodo instance
283
+ */
284
+ declare const FrodoLib: (config?: StateInterface) => Frodo;
285
+ /**
286
+ * Default frodo instance
287
+ *
288
+ * @remarks
289
+ *
290
+ * If your application requires a single connection to a ForgeRock Identity Platform
291
+ * instance at a time, then this default instance is all you need:
292
+ *
293
+ * In order to use the default {@link Frodo | frodo} instance, you must populate its {@link State | state} with the
294
+ * minimum required information to login to your ForgeRock Identity Platform instance:
295
+ *
296
+ * ```javascript
297
+ * // configure the state before invoking any library functions that require credentials
298
+ * state.setHost('https://instance0/am');
299
+ * state.setUsername('admin');
300
+ * state.setPassword('p@ssw0rd!');
301
+ *
302
+ * // now the library can login
303
+ * frodo.login.getTokens();
304
+ *
305
+ * // and perform operations
306
+ * frodo.authn.journey.exportJourney('Login');
307
+ * ```
308
+ *
309
+ * If your application needs to connect to multiple ForgeRock Identity Platform instances
310
+ * simultaneously, then you will want to create additional frodo instances using any of
311
+ * the available factory methods accessible from the default instance:
312
+ *
313
+ * {@link frodo.createInstance}
314
+ * ```javascript
315
+ * // use factory method to create a new Frodo instance
316
+ * const instance1 = frodo.createInstance({
317
+ * host: 'https://instance1/am',
318
+ * username: 'admin',
319
+ * password: 'p@ssw0rd!',
320
+ * });
321
+ *
322
+ * // now the instance can login
323
+ * instance1.login.getTokens();
324
+ *
325
+ * // and perform operations
326
+ * instance1.authn.journey.exportJourney('Login');
327
+ * ```
328
+ *
329
+ * {@link frodo.createInstanceWithAdminAccount}
330
+ * ```javascript
331
+ * // use factory method to create a new Frodo instance ready to login with an admin user account
332
+ * const instance2 = frodo.createInstanceWithAdminAccount(
333
+ * 'https://instance2/am',
334
+ * 'admin',
335
+ * 'p@ssw0rd!'
336
+ * );
337
+ *
338
+ * // now the instance can login
339
+ * instance2.login.getTokens();
340
+ *
341
+ * // and perform operations
342
+ * instance2.authn.journey.exportJourney('Login');
343
+ * ```
344
+ *
345
+ * {@link frodo.createInstanceWithServiceAccount}
346
+ * ```javascript
347
+ * // use factory method to create a new Frodo instance ready to login with a service account
348
+ * const instance3 = frodo.createInstanceWithServiceAccount(
349
+ * 'https://instance3/am',
350
+ * 'serviceAccount',
351
+ * '{"k":"jwk"}'
352
+ * );
353
+ *
354
+ * // now the instance can login
355
+ * instance3.login.getTokens();
356
+ *
357
+ * // and perform operations
358
+ * instance3.authn.journey.exportJourney('Login');
359
+ * ```
360
+ *
361
+ * {@link frodo.createInstanceWithAmsterAccount}
362
+ * ```javascript
363
+ * // use factory method to create a new Frodo instance ready to login with Amster account
364
+ * const instance4 = frodo.createInstanceWithAmsterAccount(
365
+ * 'https://instance4/am',
366
+ * '-----BEGIN PRIVATE KEY-----\nMIIJQgIBADANBgkqhkiG9w0BAQEFAASCCSwwggkoAgEAAoICAQCVPUZaHCRHu9i3\n...',
367
+ * 'amsterService'
368
+ * );
369
+ *
370
+ * // now the instance can login
371
+ * instance4.login.getTokens();
372
+ *
373
+ * // and perform AM operations
374
+ * instance4.authn.journey.exportJourney('Login');
375
+ * ```
376
+ */
377
+ declare const frodo: Frodo;
378
+ /**
379
+ * Default state instance
380
+ *
381
+ * @remarks
382
+ *
383
+ * {@link Frodo} maintains a {@link State | state} for each instance. The state is where Frodo gets configuration
384
+ * information from like host to connecto to, username and password to use, whether to
385
+ * allow insecure connections or not, etc. As the library operates, it updates its state.
386
+ *
387
+ * The default frodo instance contains an empty state instance by default. In order to
388
+ * use the default frodo instance, you must populate its state with the minimum required
389
+ * information to login to your ForgeRock Identity Platform instance:
390
+ *
391
+ * ```javascript
392
+ * // configure the state before invoking any library functions that require credentials
393
+ * state.setHost('https://instance0/am');
394
+ * state.setUsername('admin');
395
+ * state.setPassword('p@ssw0rd!');
396
+ *
397
+ * // now the library can login
398
+ * frodo.login.getTokens();
399
+ *
400
+ * // and perform operations
401
+ * frodo.authn.journey.exportJourney('Login');
402
+ * ```
403
+ */
404
+ declare const state: State;
405
+ export { frodo, FrodoLib, state };
406
+ export default FrodoLib;
407
+ //# sourceMappingURL=FrodoLib.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"FrodoLib.d.ts","sourceRoot":"","sources":["../../src/lib/FrodoLib.ts"],"names":[],"mappings":"AACA,OAAiB,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAC;AAClD,OAAiB,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAC;AAClD,OAAoB,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAe,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAC1D,OAAuB,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACpE,OAAwB,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACvE,OAAkC,EAChC,sBAAsB,EACvB,MAAM,kCAAkC,CAAC;AAC1C,OAA0B,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAC7E,OAAkB,EAAE,MAAM,EAAE,MAAM,0BAA0B,CAAC;AAC7D,OAAgB,EAAE,IAAI,EAAE,MAAM,wBAAwB,CAAC;AACvD,OAA2B,EACzB,eAAe,EAChB,MAAM,iCAAiC,CAAC;AACzC,OAAsB,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAC;AACvE,OAA2B,EACzB,cAAc,EACf,MAAM,iCAAiC,CAAC;AACzC,OAA8B,EAC5B,wBAAwB,EACzB,MAAM,0CAA0C,CAAC;AAClD,OAA4B,EAC1B,gBAAgB,EACjB,MAAM,kCAAkC,CAAC;AAC1C,OAAmB,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAC;AAC7D,OAA4B,EAC1B,gBAAgB,EACjB,MAAM,kCAAkC,CAAC;AAC1C,OAAyC,EACvC,6BAA6B,EAC9B,MAAM,+CAA+C,CAAC;AACvD,OAAoC,EAClC,wBAAwB,EACzB,MAAM,0CAA0C,CAAC;AAClD,OAAwB,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AAC7E,OAAsB,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAC;AACvE,OAAmC,EACjC,uBAAuB,EACxB,MAAM,yCAAyC,CAAC;AACjD,OAA8B,EAC5B,kBAAkB,EACnB,MAAM,oCAAoC,CAAC;AAC5C,OAAoB,EAAE,QAAQ,EAAE,MAAM,0BAA0B,CAAC;AACjE,OAAmB,EAAE,OAAO,EAAE,MAAM,yBAAyB,CAAC;AAC9D,OAAsB,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAC;AACvE,OAAoC,EAClC,qBAAqB,EACtB,MAAM,8CAA8C,CAAC;AACtD,OAAoB,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AACrE,OAAuB,EAAE,QAAQ,EAAE,MAAM,iCAAiC,CAAC;AAC3E,OAA0B,EACxB,WAAW,EACZ,MAAM,oCAAoC,CAAC;AAC5C,OAA0B,EACxB,WAAW,EACZ,MAAM,oCAAoC,CAAC;AAC5C,OAAuB,EAAE,QAAQ,EAAE,MAAM,iCAAiC,CAAC;AAC3E,OAAe,EAAE,GAAG,EAAE,MAAM,qBAAqB,CAAC;AAClD,OAAmB,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAC;AAC7D,OAA0B,EACxB,cAAc,EACf,MAAM,gCAAgC,CAAC;AACxC,OAAmB,EAAE,OAAO,EAAE,MAAM,yBAAyB,CAAC;AAC9D,OAAqB,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AACpE,OAAqB,EAAE,QAAQ,EAAE,MAAM,2BAA2B,CAAC;AACnE,OAAiB,EAAE,KAAK,EAAE,MAAM,uBAAuB,CAAC;AACxD,OAAkB,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AACrD,OAA6B,EAC3B,iBAAiB,EAClB,MAAM,6BAA6B,CAAC;AACrC,OAAqB,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAC9D,OAAyB,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAC1E,OAAqB,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAC9D,OAAqB,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAC9D,OAAqB,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAC9D,OAAqB,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAC9D,OAAe,EAAE,GAAG,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAgB,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAC;AAC/C,OAAwB,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACvE,OAAgB,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAC;AAC/C,OAAmB,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAyB,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAC1E,OAA+B,EAC7B,sBAAsB,IAAI,4BAA4B,EACvD,MAAM,+BAA+B,CAAC;AACvC,OAA+B,EAC7B,mBAAmB,EACpB,MAAM,+BAA+B,CAAC;AACvC,OAAqC,EACnC,4BAA4B,IAAI,kCAAkC,EACnE,MAAM,qCAAqC,CAAC;AAC7C,OAAmB,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAgB,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAC;AAC/C,OAAwB,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACvE,OAAsB,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AACjE,OAA0B,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAC7E,OAAkC,EAChC,sBAAsB,EACvB,MAAM,kCAAkC,CAAC;AAC1C,OAAwB,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACvE,OAAkB,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AACrD,OAAqB,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAC9D,OAAqB,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAC9D,OAAiB,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAC;AAClD,OAAiB,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAC;AAClD,OAAwB,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACvE,OAAiB,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAC;AAClD,OAAkB,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AACrD,OAAsB,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AACjE,OAAuB,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACpE,OAAmB,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAmB,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAiB,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAC;AAClD,OAAsB,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AACjE,OAAgB,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAC;AAC/C,OAAqB,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAE5D,OAAsB,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAC/D,OAAkB,EAAE,KAAK,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AACnE,OAAoB,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAC3D,OAAoB,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAChE,OAA0B,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAC7E,OAAuB,EAAE,OAAO,EAAE,MAAM,yBAAyB,CAAC;AAClE,OAAuB,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjE,OAAsB,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC9D,OAAkB,EAAE,IAAI,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAA8B,EAC5B,gBAAgB,EACjB,MAAM,gCAAgC,CAAC;AAExC;;GAEG;AACH,MAAM,MAAM,KAAK,GAAG;IAClB,KAAK,EAAE,KAAK,CAAC;IACb,KAAK,EAAE,KAAK,CAAC;IACb,KAAK,EAAE,KAAK,CAAC;IAEb,EAAE,EAAE;QACF,MAAM,EAAE,QAAQ,CAAC;KAClB,CAAC;IAEF,GAAG,EAAE,WAAW,CAAC;IAEjB,KAAK,EAAE;QACL,OAAO,EAAE,OAAO,CAAC;QACjB,IAAI,EAAE,IAAI,CAAC;QACX,QAAQ,EAAE,sBAAsB,CAAC;KAClC,CAAC;IAEF,KAAK,EAAE;QACL,MAAM,EAAE,MAAM,CAAC;QACf,SAAS,EAAE,SAAS,CAAC;QACrB,YAAY,EAAE,YAAY,CAAC;KAC5B,CAAC;IAEF,KAAK,EAAE,QAAQ,GAAG;QAChB,QAAQ,EAAE,eAAe,CAAC;QAC1B,GAAG,EAAE,UAAU,GACb,wBAAwB,GACxB,gBAAgB,GAChB,gBAAgB,GAChB,6BAA6B,GAC7B,wBAAwB,GACxB,UAAU,GACV,uBAAuB,GACvB,kBAAkB,GAAG;YACnB,IAAI,EAAE,cAAc,CAAC;YACrB,GAAG,EAAE,MAAM,CAAC;YACZ,SAAS,EAAE,YAAY,CAAC;SACzB,CAAC;QACJ;;WAEG;QACH,QAAQ,EAAE,QAAQ,CAAC;QACnB,OAAO,EAAE,OAAO,CAAC;QACjB,UAAU,EAAE,UAAU,CAAC;QACvB,GAAG,EAAE;YACH,qBAAqB,EAAE,qBAAqB,CAAC;YAC7C,KAAK,EAAE,QAAQ,CAAC;YAChB,QAAQ,EAAE,QAAQ,CAAC;YACnB,WAAW,EAAE,WAAW,CAAC;YACzB,WAAW,EAAE,WAAW,CAAC;YACzB,QAAQ,EAAE,QAAQ,CAAC;SACpB,CAAC;QACF,GAAG,EAAE,GAAG,CAAC;QACT,MAAM,EAAE,MAAM,CAAC;QACf,cAAc,EAAE,cAAc,CAAC;QAC/B,OAAO,EAAE,OAAO,CAAC;QACjB,SAAS,EAAE,SAAS,CAAC;QACrB,QAAQ,EAAE,QAAQ,CAAC;QACnB,KAAK,EAAE,KAAK,CAAC;KACd,CAAC;IAEF,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,iBAAiB,CAAC;IACxB,KAAK,EAAE,UAAU,CAAC;IAElB,KAAK,EAAE;QACL,QAAQ,EAAE,aAAa,CAAC;KACzB,CAAC;IAEF,OAAO,EAAE,UAAU,CAAC;IAEpB,GAAG,EAAE;QACH,MAAM,EAAE,SAAS,CAAC;QAClB,SAAS,EAAE,SAAS,CAAC;QACrB,MAAM,EAAE,SAAS,CAAC;QAClB,OAAO,EAAE,aAAa,GAAG;YAAE,MAAM,EAAE,4BAA4B,CAAA;SAAE,CAAC;QAClE,aAAa,EAAE,mBAAmB,GAAG;YACnC,MAAM,EAAE,kCAAkC,CAAC;SAC5C,CAAC;QACF,OAAO,EAAE,OAAO,CAAC;QACjB,YAAY,EAAE,YAAY,CAAC;QAC3B,KAAK,EAAE,KAAK,CAAC;QACb,MAAM,EAAE,SAAS,CAAC;QAClB,MAAM,EAAE,SAAS,CAAC;KACnB,CAAC;IAEF,IAAI,EAAE,IAAI,CAAC;IACX,KAAK,EAAE,YAAY,CAAC;IAEpB,UAAU,EAAE;QACV,MAAM,EAAE,YAAY,CAAC;QACrB,QAAQ,EAAE,UAAU,CAAC;QACrB,QAAQ,EAAE,GAAG,CAAC;QACd,QAAQ,EAAE,cAAc,CAAC;QACzB,MAAM,EAAE,sBAAsB,CAAC;KAChC,CAAC;IAEF,SAAS,EAAE,SAAS,CAAC;IAErB,KAAK,EAAE,KAAK,CAAC;IAEb,IAAI,EAAE,YAAY,CAAC;IAEnB,KAAK,EAAE;QACL,cAAc,EAAE,cAAc,CAAC;QAC/B,cAAc,EAAE,KAAK,CAAC;KACvB,CAAC;IAEF,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,UAAU,CAAC;IACvB,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,WAAW,CAAC;IACzB,OAAO,EAAE,OAAO,CAAC;IACjB,OAAO,EAAE,OAAO,CAAC;IACjB,IAAI,EAAE,IAAI,CAAC;IAEX,KAAK,EAAE,KAAK,CAAC;IAEb,IAAI,EAAE,IAAI,CAAC;IAEX,KAAK,EAAE,OAAO,GACZ,UAAU,GACV,SAAS,GACT,gBAAgB,GAChB,YAAY,GACZ,MAAM,GAAG;QACP,SAAS,EAAE,SAAS,CAAC;QACrB,MAAM,EAAE,WAAW,CAAC;QACpB,IAAI,EAAE,IAAI,CAAC;QACX,IAAI,EAAE,IAAI,CAAC;QACX,OAAO,EAAE,OAAO,CAAC;KAClB,CAAC;IAEJ;;;;OAIG;IACH,cAAc,CAAC,MAAM,EAAE,cAAc,GAAG,KAAK,CAAC;IAE9C;;;;;;;;;;;OAWG;IACH,8BAA8B,CAC5B,IAAI,EAAE,MAAM,EACZ,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,EAChB,KAAK,CAAC,EAAE,MAAM,EACd,cAAc,CAAC,EAAE,MAAM,EACvB,uBAAuB,CAAC,EAAE,OAAO,EACjC,KAAK,CAAC,EAAE,OAAO,EACf,SAAS,CAAC,EAAE,OAAO,GAClB,KAAK,CAAC;IAET;;;;;;;;;;;OAWG;IACH,gCAAgC,CAC9B,IAAI,EAAE,MAAM,EACZ,gBAAgB,EAAE,MAAM,EACxB,oBAAoB,EAAE,MAAM,EAC5B,KAAK,CAAC,EAAE,MAAM,EACd,cAAc,CAAC,EAAE,MAAM,EACvB,uBAAuB,CAAC,EAAE,OAAO,EACjC,KAAK,CAAC,EAAE,OAAO,EACf,SAAS,CAAC,EAAE,OAAO,GAClB,KAAK,CAAC;IAET;;;;;;;;;;;OAWG;IACH,+BAA+B,CAC7B,IAAI,EAAE,MAAM,EACZ,gBAAgB,EAAE,MAAM,EACxB,qBAAqB,CAAC,EAAE,MAAM,EAC9B,KAAK,CAAC,EAAE,MAAM,EACd,cAAc,CAAC,EAAE,MAAM,EACvB,uBAAuB,CAAC,EAAE,OAAO,EACjC,KAAK,CAAC,EAAE,OAAO,EACf,SAAS,CAAC,EAAE,OAAO,GAClB,KAAK,CAAC;IAET;;;;;;;;;;;;;;;;;;OAkBG;IACH,8BAA8B,CAC5B,IAAI,EAAE,MAAM,EACZ,aAAa,CAAC,EAAE,MAAM,EACtB,UAAU,CAAC,EAAE,MAAM,EACnB,gBAAgB,CAAC,EAAE,MAAM,EACzB,KAAK,CAAC,EAAE,MAAM,EACd,cAAc,CAAC,EAAE,MAAM,EACvB,uBAAuB,CAAC,EAAE,OAAO,EACjC,KAAK,CAAC,EAAE,OAAO,EACf,SAAS,CAAC,EAAE,OAAO,GAClB,KAAK,CAAC;IAET;;;;;;;;;;;;;;;;OAgBG;IACH,6BAA6B,CAC3B,IAAI,EAAE,MAAM,EACZ,KAAK,CAAC,EAAE,MAAM,EACd,cAAc,CAAC,EAAE,MAAM,EACvB,uBAAuB,CAAC,EAAE,OAAO,EACjC,KAAK,CAAC,EAAE,OAAO,EACf,SAAS,CAAC,EAAE,OAAO,GAClB,KAAK,CAAC;CACV,CAAC;AAEF;;;;GAIG;AACH,QAAA,MAAM,QAAQ,GAAI,SAAQ,cAAmB,KAAG,KAkJ/C,CAAC;AAkIF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2FG;AACH,QAAA,MAAM,KAAK,OAAa,CAAC;AAEzB;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,QAAA,MAAM,KAAK,OAAc,CAAC;AAE1B,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC;AAElC,eAAe,QAAQ,CAAC"}
@@ -0,0 +1,18 @@
1
+ export interface MethodParam {
2
+ name: string;
3
+ type: string;
4
+ description: string;
5
+ /** Derived from the real TS signature (a `?` before the type), not JSDoc prose. */
6
+ required: boolean;
7
+ }
8
+ export interface MethodHelpDoc {
9
+ typeName: string;
10
+ methodName: string;
11
+ /** Full TypeScript signature without the trailing semicolon */
12
+ signature: string;
13
+ description: string;
14
+ params: MethodParam[];
15
+ returns: string;
16
+ }
17
+ export declare const helpMetadata: MethodHelpDoc[];
18
+ //# sourceMappingURL=Help.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"Help.d.ts","sourceRoot":"","sources":["../../src/lib/Help.ts"],"names":[],"mappings":"AAMA,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,mFAAmF;IACnF,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,aAAa;IAC5B,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,+DAA+D;IAC/D,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,WAAW,EAAE,CAAC;IACtB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,eAAO,MAAM,YAAY,EAAE,aAAa,EAy/QvC,CAAC"}
@@ -0,0 +1,48 @@
1
+ /**
2
+ * Static capability metadata map for the MCP capability registry.
3
+ *
4
+ * @remarks
5
+ * This map is the single source of truth for deployment affinity, identity surface,
6
+ * and object type routing knowledge that cannot be reliably inferred from method
7
+ * naming conventions alone.
8
+ *
9
+ * **Entry key semantics**
10
+ *
11
+ * Keys are matched against a capability's dot-path `id` (e.g. `"idm.managed.countManagedObjects"`)
12
+ * using a two-pass lookup in {@link resolveCapabilityMeta}:
13
+ *
14
+ * 1. **Exact match** — full id equals the key. Used for per-method overrides.
15
+ * 2. **Module prefix match** — the id starts with `<key>.`. Used to annotate all
16
+ * methods in a module at once. The longest matching prefix wins.
17
+ *
18
+ * Exact matches always take priority over prefix matches.
19
+ *
20
+ * **Adding entries**
21
+ *
22
+ * Only add entries when the inferred defaults (deploymentTypes: `['any']`, no surface)
23
+ * are wrong or incomplete. The registry merges this map with inferred values so you only
24
+ * need to specify the fields that differ from the defaults.
25
+ */
26
+ import { OperationCapabilityMeta } from './CapabilityTypes';
27
+ /**
28
+ * Static map of capability ID prefixes and exact IDs to explicit metadata overrides.
29
+ *
30
+ * For each entry:
31
+ * - Key is either a full capability id **or** a module path prefix (no trailing dot).
32
+ * - Value is a partial {@link OperationCapabilityMeta} — absent fields fall back to
33
+ * registry-inferred defaults.
34
+ */
35
+ export declare const CAPABILITY_META: Record<string, OperationCapabilityMeta>;
36
+ /**
37
+ * Resolves the most specific {@link OperationCapabilityMeta} entry for a capability id.
38
+ *
39
+ * @remarks
40
+ * Matching module-prefix metadata is composed from least to most specific,
41
+ * then exact operation metadata is applied last. This lets exact argument
42
+ * contracts inherit deployment and identity-surface metadata from their module.
43
+ *
44
+ * @param capabilityId Full dot-path capability id, e.g. `"idm.managed.countManagedObjects"`.
45
+ * @returns The matching metadata entry, or `undefined` if no entry covers this id.
46
+ */
47
+ export declare function resolveCapabilityMeta(capabilityId: string): OperationCapabilityMeta | undefined;
48
+ //# sourceMappingURL=CapabilityMetadata.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"CapabilityMetadata.d.ts","sourceRoot":"","sources":["../../src/mcp/CapabilityMetadata.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AAEH,OAAO,EAAqB,uBAAuB,EAAE,MAAM,mBAAmB,CAAC;AAK/E;;;;;;;GAOG;AACH,eAAO,MAAM,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,uBAAuB,CAmzGnE,CAAC;AAEF;;;;;;;;;;GAUG;AACH,wBAAgB,qBAAqB,CACnC,YAAY,EAAE,MAAM,GACnB,uBAAuB,GAAG,SAAS,CAoBrC"}
@@ -0,0 +1,22 @@
1
+ /**
2
+ * Defines baseline policy presets and filtering behavior for MCP capabilities.
3
+ *
4
+ * @remarks
5
+ * The intent of this module is to provide safe defaults that can be composed with
6
+ * CLI launch profiles and explicit allow/deny overrides without changing the
7
+ * descriptor model itself.
8
+ */
9
+ import { McpCapabilityDescriptor, McpCapabilityPolicy, McpCapabilityPolicyPresetName } from './CapabilityTypes';
10
+ /**
11
+ * Built-in policy presets representing common launch safety postures.
12
+ */
13
+ export declare const MCP_POLICY_PRESETS: Record<McpCapabilityPolicyPresetName, McpCapabilityPolicy>;
14
+ /**
15
+ * Applies capability exposure rules to a descriptor set.
16
+ *
17
+ * @param capabilities Candidate capabilities.
18
+ * @param policy Policy rules used to include or exclude capabilities.
19
+ * @returns Filtered capability set.
20
+ */
21
+ export declare function applyCapabilityPolicy(capabilities: McpCapabilityDescriptor[], policy: McpCapabilityPolicy): McpCapabilityDescriptor[];
22
+ //# sourceMappingURL=CapabilityPolicy.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"CapabilityPolicy.d.ts","sourceRoot":"","sources":["../../src/mcp/CapabilityPolicy.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EACL,uBAAuB,EACvB,mBAAmB,EACnB,6BAA6B,EAC9B,MAAM,mBAAmB,CAAC;AAE3B;;GAEG;AACH,eAAO,MAAM,kBAAkB,EAAE,MAAM,CACrC,6BAA6B,EAC7B,mBAAmB,CA6CpB,CAAC;AAEF;;;;;;GAMG;AACH,wBAAgB,qBAAqB,CACnC,YAAY,EAAE,uBAAuB,EAAE,EACvC,MAAM,EAAE,mBAAmB,GAC1B,uBAAuB,EAAE,CAoF3B"}
@@ -0,0 +1,62 @@
1
+ /**
2
+ * Builds MCP capability inventory records from a Frodo instance.
3
+ *
4
+ * @remarks
5
+ * This module is a transitional registry helper. It provides deterministic
6
+ * discovery and normalization so downstream MCP runtime code can consume a stable
7
+ * descriptor shape while the library evolves toward richer metadata-driven
8
+ * manifests.
9
+ */
10
+ import { Frodo } from '../lib/FrodoLib';
11
+ import { McpCapabilityDescriptor, McpCapabilityInventoryOptions, McpCapabilityOperationType, McpCapabilityRiskClass } from './CapabilityTypes';
12
+ /**
13
+ * Produces a normalized capability inventory by walking the provided Frodo
14
+ * instance and inferring operation metadata from method signatures and names.
15
+ *
16
+ * @param frodo Frodo instance to inspect.
17
+ * @param options Optional inventory filters.
18
+ * @returns Sorted capability descriptors ready for policy filtering.
19
+ */
20
+ export declare function buildCapabilityInventory(frodo: Frodo, options?: McpCapabilityInventoryOptions): McpCapabilityDescriptor[];
21
+ /**
22
+ * Infers a normalized operation type from a Frodo method name.
23
+ *
24
+ * @remarks
25
+ * Frodo follows a consistent naming convention where the *singular* form reads
26
+ * one object by id or name (`readJourney`) and the *plural* form reads all
27
+ * objects of that type (`readJourneys`). This function maps the plural form to
28
+ * the `list` operation type so policy filtering and tooling can reliably
29
+ * distinguish single-object reads from collection reads without requiring
30
+ * explicit per-method metadata.
31
+ *
32
+ * @param methodName Method name to classify.
33
+ * @returns Inferred operation type.
34
+ */
35
+ export declare function inferOperationType(methodName: string): McpCapabilityOperationType;
36
+ /**
37
+ * Infers an object type label from a method name and module path.
38
+ *
39
+ * @param methodName Method name to inspect.
40
+ * @param modulePath Path of containing modules.
41
+ * @param operationType Previously inferred operation type.
42
+ * @returns Inferred object type or fallback token.
43
+ */
44
+ export declare function inferObjectType(methodName: string, modulePath: string[], operationType: McpCapabilityOperationType): string;
45
+ /**
46
+ * Infers a baseline risk class from the operation and method name.
47
+ *
48
+ * @remarks
49
+ * The sensitive-keyword check runs before the operation-type branches, not
50
+ * after: a `create`/`update`/`export` on a secret, credential, or
51
+ * service-account is at least as sensitive as reading one, but until this
52
+ * ordering was fixed the operation-type branches returned first and the
53
+ * keyword check never ran, silently capping methods like
54
+ * `cloud.secret.createSecret` and `cloud.serviceAccount.createServiceAccount`
55
+ * at `'medium'` no matter what they were named.
56
+ *
57
+ * @param operationType Inferred operation type.
58
+ * @param methodName Method name used for keyword-based risk escalation.
59
+ * @returns Inferred risk class.
60
+ */
61
+ export declare function inferRiskClass(operationType: McpCapabilityOperationType, methodName: string): McpCapabilityRiskClass;
62
+ //# sourceMappingURL=CapabilityRegistry.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"CapabilityRegistry.d.ts","sourceRoot":"","sources":["../../src/mcp/CapabilityRegistry.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAC;AAGxC,OAAO,EAEL,uBAAuB,EACvB,6BAA6B,EAE7B,0BAA0B,EAE1B,sBAAsB,EAGvB,MAAM,mBAAmB,CAAC;AA+C3B;;;;;;;GAOG;AACH,wBAAgB,wBAAwB,CACtC,KAAK,EAAE,KAAK,EACZ,OAAO,GAAE,6BAAkC,GAC1C,uBAAuB,EAAE,CA+D3B;AA6PD;;;;;;;;;;;;;GAaG;AACH,wBAAgB,kBAAkB,CAChC,UAAU,EAAE,MAAM,GACjB,0BAA0B,CAa5B;AAED;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAC7B,UAAU,EAAE,MAAM,EAClB,UAAU,EAAE,MAAM,EAAE,EACpB,aAAa,EAAE,0BAA0B,GACxC,MAAM,CA+BR;AAyBD;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,cAAc,CAC5B,aAAa,EAAE,0BAA0B,EACzC,UAAU,EAAE,MAAM,GACjB,sBAAsB,CAaxB"}
@@ -0,0 +1,9 @@
1
+ import { McpCapabilityDescriptor, McpDeploymentType } from './CapabilityTypes';
2
+ export type McpCapabilityRoutingStatus = 'preferred' | 'compatible' | 'unknown' | 'incompatible';
3
+ export type McpCapabilityRouting = {
4
+ status: McpCapabilityRoutingStatus;
5
+ reason: string;
6
+ };
7
+ export declare function rankCapabilitiesForDeployment(capabilities: McpCapabilityDescriptor[], deploymentType?: McpDeploymentType, query?: string): McpCapabilityDescriptor[];
8
+ export declare function describeCapabilityRouting(capability: McpCapabilityDescriptor, deploymentType?: McpDeploymentType): McpCapabilityRouting;
9
+ //# sourceMappingURL=CapabilityRouting.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"CapabilityRouting.d.ts","sourceRoot":"","sources":["../../src/mcp/CapabilityRouting.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,uBAAuB,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AAE/E,MAAM,MAAM,0BAA0B,GACpC,WAAW,GAAG,YAAY,GAAG,SAAS,GAAG,cAAc,CAAC;AAE1D,MAAM,MAAM,oBAAoB,GAAG;IACjC,MAAM,EAAE,0BAA0B,CAAC;IACnC,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,wBAAgB,6BAA6B,CAC3C,YAAY,EAAE,uBAAuB,EAAE,EACvC,cAAc,CAAC,EAAE,iBAAiB,EAClC,KAAK,CAAC,EAAE,MAAM,GACb,uBAAuB,EAAE,CAkB3B;AAED,wBAAgB,yBAAyB,CACvC,UAAU,EAAE,uBAAuB,EACnC,cAAc,CAAC,EAAE,iBAAiB,GACjC,oBAAoB,CA8BtB"}