Updating documentation [85ab3a5]

ChlodAlejandro · Jul 11, 2023 · c4d39b6 · c4d39b6
1 parent cca2d36
commit c4d39b6
Show file tree

Hide file tree

Showing 134 changed files with 39,678 additions and 138 deletions.
diff --git a/assets/highlight.css b/assets/highlight.css
@@ -19,6 +19,8 @@
     --dark-hl-8: #C8C8C8;
     --light-hl-9: #0070C1;
     --dark-hl-9: #4FC1FF;
+    --light-hl-10: #267F99;
+    --dark-hl-10: #4EC9B0;
     --light-code-background: #FFFFFF;
     --dark-code-background: #1E1E1E;
 }
@@ -34,6 +36,7 @@
     --hl-7: var(--light-hl-7);
     --hl-8: var(--light-hl-8);
     --hl-9: var(--light-hl-9);
+    --hl-10: var(--light-hl-10);
     --code-background: var(--light-code-background);
 } }
 
@@ -48,6 +51,7 @@
     --hl-7: var(--dark-hl-7);
     --hl-8: var(--dark-hl-8);
     --hl-9: var(--dark-hl-9);
+    --hl-10: var(--dark-hl-10);
     --code-background: var(--dark-code-background);
 } }
 
@@ -62,6 +66,7 @@
     --hl-7: var(--light-hl-7);
     --hl-8: var(--light-hl-8);
     --hl-9: var(--light-hl-9);
+    --hl-10: var(--light-hl-10);
     --code-background: var(--light-code-background);
 }
 
@@ -76,6 +81,7 @@
     --hl-7: var(--dark-hl-7);
     --hl-8: var(--dark-hl-8);
     --hl-9: var(--dark-hl-9);
+    --hl-10: var(--dark-hl-10);
     --code-background: var(--dark-code-background);
 }
 
@@ -89,4 +95,5 @@
 .hl-7 { color: var(--hl-7); }
 .hl-8 { color: var(--hl-8); }
 .hl-9 { color: var(--hl-9); }
+.hl-10 { color: var(--hl-10); }
 pre, code { background: var(--code-background); }
diff --git a/assets/search.js b/assets/search.js
diff --git a/classes/Deputy.html b/classes/Deputy.html
diff --git a/classes/_internal_.AttributionNotice.html b/classes/_internal_.AttributionNotice.html
diff --git a/classes/_internal_.AttributionNoticeRow.html b/classes/_internal_.AttributionNoticeRow.html
diff --git a/classes/_internal_.BackwardsCopyTemplate.html b/classes/_internal_.BackwardsCopyTemplate.html
diff --git a/classes/_internal_.BackwardsCopyTemplateRow.html b/classes/_internal_.BackwardsCopyTemplateRow.html
diff --git a/classes/_internal_.CTEParsoidDocument.html b/classes/_internal_.CTEParsoidDocument.html
diff --git a/classes/_internal_.CTEParsoidTransclusionTemplateNode.html b/classes/_internal_.CTEParsoidTransclusionTemplateNode.html
diff --git a/classes/_internal_.ConfigurationBase.html b/classes/_internal_.ConfigurationBase.html
diff --git a/classes/_internal_.ContributionSurveyRevision.html b/classes/_internal_.ContributionSurveyRevision.html
diff --git a/classes/_internal_.ContributionSurveyRow.html b/classes/_internal_.ContributionSurveyRow.html
diff --git a/classes/_internal_.ContributionSurveyRowParser.html b/classes/_internal_.ContributionSurveyRowParser.html
diff --git a/classes/_internal_.ContributionSurveySection.html b/classes/_internal_.ContributionSurveySection.html
diff --git a/classes/_internal_.CopiedTemplate.html b/classes/_internal_.CopiedTemplate.html
diff --git a/classes/_internal_.CopiedTemplateEditor.html b/classes/_internal_.CopiedTemplateEditor.html
diff --git a/classes/_internal_.CopiedTemplateRow.html b/classes/_internal_.CopiedTemplateRow.html
diff --git a/classes/_internal_.CopyrightProblemsListing.html b/classes/_internal_.CopyrightProblemsListing.html
diff --git a/classes/_internal_.CopyrightProblemsPage.html b/classes/_internal_.CopyrightProblemsPage.html
diff --git a/classes/_internal_.CopyrightProblemsSession.html b/classes/_internal_.CopyrightProblemsSession.html
diff --git a/classes/_internal_.DeputyCCIStatusDropdown.html b/classes/_internal_.DeputyCCIStatusDropdown.html
diff --git a/classes/_internal_.DeputyCase.html b/classes/_internal_.DeputyCase.html
diff --git a/classes/_internal_.DeputyCasePage.html b/classes/_internal_.DeputyCasePage.html
diff --git a/classes/_internal_.DeputyCasePageWikitext.html b/classes/_internal_.DeputyCasePageWikitext.html
diff --git a/classes/_internal_.DeputyCommunications.html b/classes/_internal_.DeputyCommunications.html
diff --git a/classes/_internal_.DeputyContributionSurveyRevision.html b/classes/_internal_.DeputyContributionSurveyRevision.html
diff --git a/classes/_internal_.DeputyContributionSurveyRow.html b/classes/_internal_.DeputyContributionSurveyRow.html
diff --git a/classes/_internal_.DeputyContributionSurveySection.html b/classes/_internal_.DeputyContributionSurveySection.html
diff --git a/classes/_internal_.DeputyDispatch.html b/classes/_internal_.DeputyDispatch.html
diff --git a/classes/_internal_.DeputyFinishedContributionSurveyRow.html b/classes/_internal_.DeputyFinishedContributionSurveyRow.html
diff --git a/classes/_internal_.DeputyModule.html b/classes/_internal_.DeputyModule.html
diff --git a/classes/_internal_.DeputyPageSession.html b/classes/_internal_.DeputyPageSession.html
diff --git a/classes/_internal_.DeputyPageToolbar.html b/classes/_internal_.DeputyPageToolbar.html
diff --git a/classes/_internal_.DeputyPreferences.html b/classes/_internal_.DeputyPreferences.html
diff --git a/classes/_internal_.DeputyRootSession.html b/classes/_internal_.DeputyRootSession.html
diff --git a/classes/_internal_.DeputySession.html b/classes/_internal_.DeputySession.html
diff --git a/classes/_internal_.DeputyStorage.html b/classes/_internal_.DeputyStorage.html
diff --git a/classes/_internal_.InfringementAssistant.html b/classes/_internal_.InfringementAssistant.html
diff --git a/classes/_internal_.MergedFromTemplate.html b/classes/_internal_.MergedFromTemplate.html
diff --git a/classes/_internal_.MergedToTemplate.html b/classes/_internal_.MergedToTemplate.html
diff --git a/classes/_internal_.Requester.html b/classes/_internal_.Requester.html
diff --git a/classes/_internal_.RowedAttributionNotice.html b/classes/_internal_.RowedAttributionNotice.html
diff --git a/classes/_internal_.Setting.html b/classes/_internal_.Setting.html
diff --git a/classes/_internal_.SplitArticleTemplate.html b/classes/_internal_.SplitArticleTemplate.html
diff --git a/classes/_internal_.SplitArticleTemplateRow.html b/classes/_internal_.SplitArticleTemplateRow.html
diff --git a/classes/_internal_.TranslatedPageTemplate.html b/classes/_internal_.TranslatedPageTemplate.html
diff --git a/classes/_internal_.UserConfiguration.html b/classes/_internal_.UserConfiguration.html
diff --git a/classes/_internal_.WikiConfiguration.html b/classes/_internal_.WikiConfiguration.html
diff --git a/enums/_internal_.CompletionAction.html b/enums/_internal_.CompletionAction.html
diff --git a/enums/_internal_.ContributionSurveyRowSigningBehavior.html b/enums/_internal_.ContributionSurveyRowSigningBehavior.html
diff --git a/enums/_internal_.ContributionSurveyRowSort.html b/enums/_internal_.ContributionSurveyRowSort.html
diff --git a/enums/_internal_.ContributionSurveyRowStatus.html b/enums/_internal_.ContributionSurveyRowStatus.html
diff --git a/enums/_internal_.DeputyContributionSurveyRowState.html b/enums/_internal_.DeputyContributionSurveyRowState.html
diff --git a/enums/_internal_.PortletNameView.html b/enums/_internal_.PortletNameView.html
diff --git a/enums/_internal_.TripleCompletionAction.html b/enums/_internal_.TripleCompletionAction.html
diff --git a/...ns/_internal_.__home_runner_work_deputy_deputy_project_src_util_blockExit_.blockExit.html b/...ns/_internal_.__home_runner_work_deputy_deputy_project_src_util_blockExit_.blockExit.html
diff --git a/.../_internal_.__home_runner_work_deputy_deputy_project_src_util_blockExit_.unblockExit.html b/.../_internal_.__home_runner_work_deputy_deputy_project_src_util_blockExit_.unblockExit.html
diff --git a/index.html b/index.html
@@ -31,10 +31,6 @@ <h2>deputy</h2></div>
 choice (<a href="https://en.wikipedia.org/wiki/Special:MyPage/common.js">common.js</a>) with the following:</p>
 <pre><code class="language-js"><span class="hl-3">mw</span><span class="hl-1">.</span><span class="hl-3">loader</span><span class="hl-1">.</span><span class="hl-0">load</span><span class="hl-1">( </span><span class="hl-2">&quot;http://localhost:45000/Deputy.js&quot;</span><span class="hl-1"> );</span><br/><span class="hl-3">mw</span><span class="hl-1">.</span><span class="hl-0">hook</span><span class="hl-1">( </span><span class="hl-2">&#39;deputy.preload&#39;</span><span class="hl-1"> ).</span><span class="hl-0">add</span><span class="hl-1">( </span><span class="hl-4">function</span><span class="hl-1"> () {</span><br/><span class="hl-1">    </span><span class="hl-5">// Replace resource root to load local development assets</span><br/><span class="hl-1">    </span><span class="hl-3">window</span><span class="hl-1">.</span><span class="hl-3">deputy</span><span class="hl-1">.</span><span class="hl-3">resourceRoot</span><span class="hl-1"> = { </span><span class="hl-3">type:</span><span class="hl-1"> </span><span class="hl-2">&quot;url&quot;</span><span class="hl-1">, </span><span class="hl-3">url:</span><span class="hl-1"> </span><span class="hl-4">new</span><span class="hl-1"> </span><span class="hl-0">URL</span><span class="hl-1">( </span><span class="hl-2">&quot;http://localhost:45000/&quot;</span><span class="hl-1"> ) };</span><br/><span class="hl-1">    </span><span class="hl-3">window</span><span class="hl-1">.</span><span class="hl-3">deputy</span><span class="hl-1">.</span><span class="hl-0">getWikiConfig</span><span class="hl-1">().</span><span class="hl-0">then</span><span class="hl-1">( </span><span class="hl-4">function</span><span class="hl-1"> (</span><span class="hl-3">wikiConfig</span><span class="hl-1">) {</span><br/><span class="hl-1">        </span><span class="hl-5">// Used to test in a sandbox environment than on the actual CCI pagespace.</span><br/><span class="hl-1">        </span><span class="hl-5">// Feel free to change the values to fit your sandbox.</span><br/><span class="hl-1">        </span><span class="hl-3">wikiConfig</span><span class="hl-1">.</span><span class="hl-3">cci</span><span class="hl-1">.</span><span class="hl-3">rootPage</span><span class="hl-1">.</span><span class="hl-0">set</span><span class="hl-1">(</span><span class="hl-4">new</span><span class="hl-1"> </span><span class="hl-3">mw</span><span class="hl-1">.</span><span class="hl-0">Title</span><span class="hl-1">( </span><span class="hl-2">&#39;User:Chlod/Scripts/Deputy/tests&#39;</span><span class="hl-1"> ));</span><br/><span class="hl-1">        </span><span class="hl-3">wikiConfig</span><span class="hl-1">.</span><span class="hl-3">ia</span><span class="hl-1">.</span><span class="hl-3">rootPage</span><span class="hl-1">.</span><span class="hl-0">set</span><span class="hl-1">(</span><span class="hl-4">new</span><span class="hl-1"> </span><span class="hl-3">mw</span><span class="hl-1">.</span><span class="hl-0">Title</span><span class="hl-1">(</span><span class="hl-2">&quot;User:Chlod/Scripts/Deputy/tests/Problems&quot;</span><span class="hl-1">));</span><br/><span class="hl-1">    } );</span><br/><span class="hl-1">} );</span>
 </code><button>Copy</button></pre>
-<p>This project uses TypeScript, but some parts of the tool are weakly-typed. This is due to a lack of types and unorthodox
-JavaScript patterns on the part of reliant libraries, namely <a href="https://www.mediawiki.org/wiki/OOUI">OOUI</a>, which makes it
-difficult to enforce types. Tread carefully when modifying files that extend off of OOUI widgets or similar, as the use
-of many <code>any</code> types may prevent you from knowing when something might break.</p>
 <a id="md:testing" class="tsd-anchor"></a><h2><a href="#md:testing">Testing</a></h2><a id="md:live-testing" class="tsd-anchor"></a><h3><a href="#md:live-testing">Live testing</a></h3><p>Bleeding edge builds of Deputy are always provided through <a href="https://github.com/ChlodAlejandro/deputy/actions">GitHub Actions</a>. You may experiment with these versions of Deputy, but keep in mind that they are <strong>extremely unstable</strong>
 and significant bugs may be found. Nevertheless,
 please <a href="https://github.com/ChlodAlejandro/deputy/issues">report bugs found</a> so that they may be actioned on.</p>
@@ -95,6 +91,7 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
 <div class="site-menu">
 <nav class="tsd-navigation"><a href="modules.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-4"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill="var(--color-text)"></path></g></svg><span>deputy</span></a>
 <ul class="tsd-small-nested-navigation">
+<li><a href="modules/_internal_.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>&lt;internal&gt;</span></a></li>
 <li><a href="classes/Deputy.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-128"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)"></path></g></svg><span>Deputy</span></a></li></ul></nav></div></div></div>
 <div class="tsd-generator">
 <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>