readme, typedoc, github pages

.github/README.md

@@ -1,19 +1,19 @@
 <!-- README.md for GitHub; the one for NPM is ../README.md. -->
 
-# Frodo Library 2.x :new: - @rockcarver/frodo-lib
+# Frodo Library 2.x - @rockcarver/frodo-lib
 
 ForgeROck DO library, frodo-lib, a hybrid (ESM and CJS) library to manage ForgeRock Identity Cloud tenants, ForgeOps deployments, and classic deployments.
 
 Frodo-lib powers [frodo-cli](https://github.com/rockcarver/frodo-cli), the command line tool to manage ForgeRock deployments.
 
 ## Quick Nav
 
-- :new: [New in 2.x](#new-in-2x)
+- [New in 2.x](#new-in-2x)
 - [Features](#features)
 - [Limitations](#limitations)
 - [Installing](#installing)
-- :new: [Using the library](#using-the-library)
-- :new: [Library API docs](#library-api-docs)
+- [Using the library](#using-the-library)
+- [Library API docs](#library-api-docs)
 - [Request features or report issues](#feature-requests)
 - [Contributing](#contributing)
 - [Maintaining](#maintaining)
@@ -215,16 +215,16 @@ defaultAdminLogin();
 Check out all the examples in `/path/to/frodo-lib/examples`.
 
 ## Library API docs
-[Latest library API docs](https://github.com/rockcarver/frodo-lib/docs/ts-doc/index.html)
+[Latest library API docs](https://rockcarver.github.io/frodo-lib/)
 
 ## Feature requests
 
 Please use the repository's [issues](https://github.com/rockcarver/frodo-lib/issues) to request new features/enhancements or report bugs/issues.
 
 ## Contributing
 
-If you would like to contribute to frodo, please refer to the [contributing instructions](../CONTRIBUTE.md).
+If you would like to contribute to frodo, please refer to the [contributing instructions](https://github.com/rockcarver/frodo-lib/CONTRIBUTE.md).
 
 ## Maintaining
 
-If you are a maintainer of this repository, please refer to the [pipeline and release process instructions](../PIPELINE.md).
+If you are a maintainer of this repository, please refer to the [pipeline and release process instructions](https://github.com/rockcarver/frodo-lib/PIPELINE.md).

docs/functions/FrodoLib.html

@@ -26,7 +26,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
 <h5><span class="tsd-kind-parameter">config</span>: <a href="../interfaces/Reference.StateInterface.html" class="tsd-signature-type tsd-kind-interface">StateInterface</a><span class="tsd-signature-symbol"> = {}</span></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <a href="../types/Frodo.html" class="tsd-signature-type tsd-kind-type-alias">Frodo</a></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/vscheuber/frodo-lib/blob/6988e84/src/lib/FrodoLib.ts#L122">lib/FrodoLib.ts:122</a></li></ul></aside></li></ul></section></div>
+<li>Defined in <a href="https://github.com/vscheuber/frodo-lib/blob/577437f/src/lib/FrodoLib.ts#L122">lib/FrodoLib.ts:122</a></li></ul></aside></li></ul></section></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

docs/functions/createInstanceWithAdminAccount.html

@@ -68,7 +68,7 @@ <h4 class="tsd-returns-title">Returns <a href="../types/Frodo.html" class="tsd-s
 
 <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/vscheuber/frodo-lib/blob/6988e84/src/lib/Frodo.ts#L62">lib/Frodo.ts:62</a></li></ul></aside></li></ul></section></div>
+<li>Defined in <a href="https://github.com/vscheuber/frodo-lib/blob/577437f/src/lib/Frodo.ts#L62">lib/Frodo.ts:62</a></li></ul></aside></li></ul></section></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

docs/functions/createInstanceWithServiceAccount.html

@@ -68,7 +68,7 @@ <h4 class="tsd-returns-title">Returns <a href="../types/Frodo.html" class="tsd-s
 
 <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/vscheuber/frodo-lib/blob/6988e84/src/lib/Frodo.ts#L26">lib/Frodo.ts:26</a></li></ul></aside></li></ul></section></div>
+<li>Defined in <a href="https://github.com/vscheuber/frodo-lib/blob/577437f/src/lib/Frodo.ts#L26">lib/Frodo.ts:26</a></li></ul></aside></li></ul></section></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

docs/index.html

@@ -14,15 +14,15 @@
 <h2>Frodo Library - v2.0.0-13</h2></div>
 <div class="tsd-panel tsd-typography"><!-- README.md for GitHub; the one for NPM is ../README.md. -->
 
-<a id="md:frodo-library-2x-new---rockcarverfrodo-lib" class="tsd-anchor"></a><h1><a href="#md:frodo-library-2x-new---rockcarverfrodo-lib">Frodo Library 2.x :new: - @rockcarver/frodo-lib</a></h1><p>ForgeROck DO library, frodo-lib, a hybrid (ESM and CJS) library to manage ForgeRock Identity Cloud tenants, ForgeOps deployments, and classic deployments.</p>
+<a id="md:frodo-library-2x---rockcarverfrodo-lib" class="tsd-anchor"></a><h1><a href="#md:frodo-library-2x---rockcarverfrodo-lib">Frodo Library 2.x - @rockcarver/frodo-lib</a></h1><p>ForgeROck DO library, frodo-lib, a hybrid (ESM and CJS) library to manage ForgeRock Identity Cloud tenants, ForgeOps deployments, and classic deployments.</p>
 <p>Frodo-lib powers <a href="https://github.com/rockcarver/frodo-cli">frodo-cli</a>, the command line tool to manage ForgeRock deployments.</p>
 <a id="md:quick-nav" class="tsd-anchor"></a><h2><a href="#md:quick-nav">Quick Nav</a></h2><ul>
-<li>:new: <a href="#new-in-2x">New in 2.x</a></li>
+<li><a href="#new-in-2x">New in 2.x</a></li>
 <li><a href="#features">Features</a></li>
 <li><a href="#limitations">Limitations</a></li>
 <li><a href="#installing">Installing</a></li>
-<li>:new: <a href="#using-the-library">Using the library</a></li>
-<li>:new: <a href="#library-api-docs">Library API docs</a></li>
+<li><a href="#using-the-library">Using the library</a></li>
+<li><a href="#library-api-docs">Library API docs</a></li>
 <li><a href="#feature-requests">Request features or report issues</a></li>
 <li><a href="#contributing">Contributing</a></li>
 <li><a href="#maintaining">Maintaining</a></li>
@@ -111,10 +111,10 @@ <h2>Frodo Library - v2.0.0-13</h2></div>
 <pre><code class="language-javascript"><span class="hl-5">// destructure default instance for easier use of library functions</span><br/><span class="hl-3">const</span><span class="hl-1"> { </span><span class="hl-7">getTokens</span><span class="hl-1"> } = </span><span class="hl-6">frodo</span><span class="hl-1">.</span><span class="hl-6">login</span><span class="hl-1">;</span><br/><span class="hl-3">const</span><span class="hl-1"> { </span><span class="hl-7">getInfo</span><span class="hl-1"> } = </span><span class="hl-6">frodo</span><span class="hl-1">.</span><span class="hl-6">info</span><span class="hl-1">;</span><br/><br/><span class="hl-3">async</span><span class="hl-1"> </span><span class="hl-3">function</span><span class="hl-1"> </span><span class="hl-0">defaultAdminLogin</span><span class="hl-1">() {</span><br/><span class="hl-1">  </span><span class="hl-5">// this has to be the base URL of your AM service, not just the host hame</span><br/><span class="hl-1">  </span><span class="hl-6">state</span><span class="hl-1">.</span><span class="hl-0">setHost</span><span class="hl-1">(</span><span class="hl-6">host0</span><span class="hl-1">);</span><br/><span class="hl-1">  </span><span class="hl-5">// username of an admin user</span><br/><span class="hl-1">  </span><span class="hl-6">state</span><span class="hl-1">.</span><span class="hl-0">setUsername</span><span class="hl-1">(</span><span class="hl-6">user0</span><span class="hl-1">);</span><br/><span class="hl-1">  </span><span class="hl-5">// password of the admin user</span><br/><span class="hl-1">  </span><span class="hl-6">state</span><span class="hl-1">.</span><span class="hl-0">setPassword</span><span class="hl-1">(</span><span class="hl-6">pass0</span><span class="hl-1">);</span><br/><br/><span class="hl-1">  </span><span class="hl-5">// login and obtain tokens</span><br/><span class="hl-1">  </span><span class="hl-4">if</span><span class="hl-1"> (</span><span class="hl-4">await</span><span class="hl-1"> </span><span class="hl-0">getTokens</span><span class="hl-1">()) {</span><br/><span class="hl-1">    </span><span class="hl-5">// obtain and print information about the instance you are connected to</span><br/><span class="hl-1">    </span><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-7">info</span><span class="hl-1"> = </span><span class="hl-4">await</span><span class="hl-1"> </span><span class="hl-0">getInfo</span><span class="hl-1">();</span><br/><span class="hl-1">    </span><span class="hl-6">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-2">`defaultAdminLogin: Logged in to: </span><span class="hl-3">${</span><span class="hl-6">info</span><span class="hl-8">.</span><span class="hl-6">host</span><span class="hl-3">}</span><span class="hl-2">`</span><span class="hl-1">);</span><br/><span class="hl-1">    </span><span class="hl-6">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-2">`defaultAdminLogin: Logged in as: </span><span class="hl-3">${</span><span class="hl-6">info</span><span class="hl-8">.</span><span class="hl-6">authenticatedSubject</span><span class="hl-3">}</span><span class="hl-2">`</span><span class="hl-1">);</span><br/><span class="hl-1">    </span><span class="hl-6">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-2">`defaultAdminLogin: Using bearer token: </span><span class="hl-9">\n</span><span class="hl-3">${</span><span class="hl-6">info</span><span class="hl-8">.</span><span class="hl-6">bearerToken</span><span class="hl-3">}</span><span class="hl-2">`</span><span class="hl-1">);</span><br/><span class="hl-1">  } </span><span class="hl-4">else</span><span class="hl-1"> {</span><br/><span class="hl-1">    </span><span class="hl-6">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-2">&#39;error getting tokens&#39;</span><span class="hl-1">);</span><br/><span class="hl-1">  }</span><br/><span class="hl-1">}</span><br/><span class="hl-0">defaultAdminLogin</span><span class="hl-1">();</span>
 </code><button>Copy</button></pre>
 <p>Check out all the examples in <code>/path/to/frodo-lib/examples</code>.</p>
-<a id="md:library-api-docs" class="tsd-anchor"></a><h2><a href="#md:library-api-docs">Library API docs</a></h2><p><a href="https://github.com/rockcarver/frodo-lib/docs/ts-doc/index.html">Latest library API docs</a></p>
+<a id="md:library-api-docs" class="tsd-anchor"></a><h2><a href="#md:library-api-docs">Library API docs</a></h2><p><a href="https://rockcarver.github.io/frodo-lib/">Latest library API docs</a></p>
 <a id="md:feature-requests" class="tsd-anchor"></a><h2><a href="#md:feature-requests">Feature requests</a></h2><p>Please use the repository&#39;s <a href="https://github.com/rockcarver/frodo-lib/issues">issues</a> to request new features/enhancements or report bugs/issues.</p>
-<a id="md:contributing" class="tsd-anchor"></a><h2><a href="#md:contributing">Contributing</a></h2><p>If you would like to contribute to frodo, please refer to the <a href="../CONTRIBUTE.md">contributing instructions</a>.</p>
-<a id="md:maintaining" class="tsd-anchor"></a><h2><a href="#md:maintaining">Maintaining</a></h2><p>If you are a maintainer of this repository, please refer to the <a href="../PIPELINE.md">pipeline and release process instructions</a>.</p>
+<a id="md:contributing" class="tsd-anchor"></a><h2><a href="#md:contributing">Contributing</a></h2><p>If you would like to contribute to frodo, please refer to the <a href="https://github.com/rockcarver/frodo-lib/CONTRIBUTE.md">contributing instructions</a>.</p>
+<a id="md:maintaining" class="tsd-anchor"></a><h2><a href="#md:maintaining">Maintaining</a></h2><p>If you are a maintainer of this repository, please refer to the <a href="https://github.com/rockcarver/frodo-lib/PIPELINE.md">pipeline and release process instructions</a>.</p>
 </div></div>
 <div class="col-sidebar">
 <div class="page-menu">
@@ -136,7 +136,7 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
 <ul>
 <li>
 <ul>
-<li><a href="#md:frodo-library-2x-new---rockcarverfrodo-lib"><span>Frodo <wbr/>Library 2.x :new: -<wbr/> @rockcarver/frodo-<wbr/>lib</span></a></li>
+<li><a href="#md:frodo-library-2x---rockcarverfrodo-lib"><span>Frodo <wbr/>Library 2.x -<wbr/> @rockcarver/frodo-<wbr/>lib</span></a></li>
 <li>
 <ul>
 <li><a href="#md:quick-nav"><span>Quick <wbr/>Nav</span></a></li>

docs/interfaces/Reference.AdminFederationExportInterface.html

@@ -21,7 +21,7 @@ <h4>Hierarchy</h4>
 <ul class="tsd-hierarchy">
 <li><span class="target">AdminFederationExportInterface</span></li></ul></section><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/vscheuber/frodo-lib/blob/6988e84/src/ops/cloud/AdminFederationOps.ts#L193">ops/cloud/AdminFederationOps.ts:193</a></li></ul></aside>
+<li>Defined in <a href="https://github.com/vscheuber/frodo-lib/blob/577437f/src/ops/cloud/AdminFederationOps.ts#L193">ops/cloud/AdminFederationOps.ts:193</a></li></ul></aside>
 <section class="tsd-panel-group tsd-index-group">
 <section class="tsd-panel tsd-index-panel">
 <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -39,17 +39,17 @@ <h2>Properties</h2>
 <h3 class="tsd-anchor-link"><span>config</span><a href="#config" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round" id="icon-anchor"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></g></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-property">config</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><a href="../types/Reference.AdminFederationConfigSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">AdminFederationConfigSkeleton</a><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/vscheuber/frodo-lib/blob/6988e84/src/ops/cloud/AdminFederationOps.ts#L195">ops/cloud/AdminFederationOps.ts:195</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/vscheuber/frodo-lib/blob/577437f/src/ops/cloud/AdminFederationOps.ts#L195">ops/cloud/AdminFederationOps.ts:195</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="idp" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>idp</span><a href="#idp" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-property">idp</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><a href="../types/Reference.SocialIdpSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">SocialIdpSkeleton</a><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/vscheuber/frodo-lib/blob/6988e84/src/ops/cloud/AdminFederationOps.ts#L196">ops/cloud/AdminFederationOps.ts:196</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/vscheuber/frodo-lib/blob/577437f/src/ops/cloud/AdminFederationOps.ts#L196">ops/cloud/AdminFederationOps.ts:196</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="meta" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>meta</span><a href="#meta" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-property">meta</span><span class="tsd-signature-symbol">?:</span> <a href="Reference.ExportMetaData.html" class="tsd-signature-type tsd-kind-interface">ExportMetaData</a></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/vscheuber/frodo-lib/blob/6988e84/src/ops/cloud/AdminFederationOps.ts#L194">ops/cloud/AdminFederationOps.ts:194</a></li></ul></aside></section></section></div>
+<li>Defined in <a href="https://github.com/vscheuber/frodo-lib/blob/577437f/src/ops/cloud/AdminFederationOps.ts#L194">ops/cloud/AdminFederationOps.ts:194</a></li></ul></aside></section></section></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

docs/interfaces/Reference.AgentExportInterface.html

@@ -21,7 +21,7 @@ <h4>Hierarchy</h4>
 <ul class="tsd-hierarchy">
 <li><span class="target">AgentExportInterface</span></li></ul></section><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/vscheuber/frodo-lib/blob/6988e84/src/ops/OpsTypes.ts#L71">ops/OpsTypes.ts:71</a></li></ul></aside>
+<li>Defined in <a href="https://github.com/vscheuber/frodo-lib/blob/577437f/src/ops/OpsTypes.ts#L71">ops/OpsTypes.ts:71</a></li></ul></aside>
 <section class="tsd-panel-group tsd-index-group">
 <section class="tsd-panel tsd-index-panel">
 <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -38,12 +38,12 @@ <h2>Properties</h2>
 <h3 class="tsd-anchor-link"><span>agents</span><a href="#agents" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round" id="icon-anchor"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></g></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-property">agents</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><a href="../types/Reference.AgentSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">AgentSkeleton</a><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/vscheuber/frodo-lib/blob/6988e84/src/ops/OpsTypes.ts#L73">ops/OpsTypes.ts:73</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/vscheuber/frodo-lib/blob/577437f/src/ops/OpsTypes.ts#L73">ops/OpsTypes.ts:73</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="meta" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>meta</span><a href="#meta" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-property">meta</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><a href="Reference.ExportMetaData.html" class="tsd-signature-type tsd-kind-interface">ExportMetaData</a><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/vscheuber/frodo-lib/blob/6988e84/src/ops/OpsTypes.ts#L72">ops/OpsTypes.ts:72</a></li></ul></aside></section></section></div>
+<li>Defined in <a href="https://github.com/vscheuber/frodo-lib/blob/577437f/src/ops/OpsTypes.ts#L72">ops/OpsTypes.ts:72</a></li></ul></aside></section></section></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">