Skip to content

Commit

Permalink
GitHub Actions build 1275, branch main
Browse files Browse the repository at this point in the history
  • Loading branch information
@actions-user
actions-user committed Oct 8, 2024
1 parent f9dd5be commit 9729a28
Show file tree
Hide file tree
Showing 185 changed files with 1,088 additions and 201 deletions.
6 changes: 3 additions & 3 deletions versions/main/docs/auth/providers/refreshing.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -842,20 +842,20 @@
</span></code></pre></pre>
<p>Note that the expiry values are set to 0, which forces the application to make a refresh call the first time you start it.
This is done to prevent having to calculate the initial expiry timestamp manually.</p>
<pre><div data-dynamic-component="CodeBlock" data-component-props="{&quot;lang&quot;:&quot;ts&quot;,&quot;langMeta&quot;:[&quot;twoslash&quot;],&quot;text&quot;:&quot;// @module: esnext\n// @target: ES2017\n// @lib: es5\n// silence TS complaining about fs not existing - TODO: might want to import node types somehow\n// @errors: 2307\n// ---cut---\nimport { RefreshingAuthProvider } from &#x27;@twurple/auth&#x27;;\nimport { promises as fs } from &#x27;fs&#x27;;\n\nconst clientId = &#x27;YOUR_CLIENT_ID&#x27;;\nconst clientSecret = &#x27;YOUR_CLIENT_SECRET&#x27;;\nconst tokenData = JSON.parse(await fs.readFile(&#x27;./tokens.125328655.json&#x27;, &#x27;UTF-8&#x27;));\nconst authProvider = new RefreshingAuthProvider(\n\t{\n\t\tclientId,\n\t\tclientSecret\n\t}\n);\n\nauthProvider.onRefresh(async (userId, newTokenData) =&gt; await fs.writeFile(`./tokens.${userId}.json`, JSON.stringify(newTokenData, null, 4), &#x27;UTF-8&#x27;));\n\nawait authProvider.addUserForToken(tokenData);&quot;}"><pre style="display:block;overflow-x:auto;padding:0.5em;background:#2b2b2b;color:#bababa"><code class="language-ts" style="white-space:pre-wrap"><span><span style="color:#cb7832">import</span><span> { RefreshingAuthProvider } </span><span style="color:#cb7832">from</span><span> </span><span style="color:#6a8759">&#x27;@twurple/auth&#x27;</span><span>;
<pre><div data-dynamic-component="CodeBlock" data-component-props="{&quot;lang&quot;:&quot;ts&quot;,&quot;langMeta&quot;:[&quot;twoslash&quot;],&quot;text&quot;:&quot;// @module: esnext\n// @target: ES2017\n// @lib: es5\n// silence TS complaining about fs not existing - TODO: might want to import node types somehow\n// @errors: 2307\n// ---cut---\nimport { RefreshingAuthProvider } from &#x27;@twurple/auth&#x27;;\nimport { promises as fs } from &#x27;fs&#x27;;\n\nconst clientId = &#x27;YOUR_CLIENT_ID&#x27;;\nconst clientSecret = &#x27;YOUR_CLIENT_SECRET&#x27;;\nconst tokenData = JSON.parse(await fs.readFile(&#x27;./tokens.125328655.json&#x27;, &#x27;utf-8&#x27;));\nconst authProvider = new RefreshingAuthProvider(\n\t{\n\t\tclientId,\n\t\tclientSecret\n\t}\n);\n\nauthProvider.onRefresh(async (userId, newTokenData) =&gt; await fs.writeFile(`./tokens.${userId}.json`, JSON.stringify(newTokenData, null, 4), &#x27;utf-8&#x27;));\n\nawait authProvider.addUserForToken(tokenData);&quot;}"><pre style="display:block;overflow-x:auto;padding:0.5em;background:#2b2b2b;color:#bababa"><code class="language-ts" style="white-space:pre-wrap"><span><span style="color:#cb7832">import</span><span> { RefreshingAuthProvider } </span><span style="color:#cb7832">from</span><span> </span><span style="color:#6a8759">&#x27;@twurple/auth&#x27;</span><span>;
</span></span><span><span></span><span style="color:#cb7832">import</span><span> { promises </span><span style="color:#cb7832">as</span><span> fs } </span><span style="color:#cb7832">from</span><span> </span><span style="color:#6a8759">&#x27;fs&#x27;</span><span>;
</span></span><span>
</span><span><span></span><span style="color:#cb7832">const</span><span> clientId = </span><span style="color:#6a8759">&#x27;YOUR_CLIENT_ID&#x27;</span><span>;
</span></span><span><span></span><span style="color:#cb7832">const</span><span> clientSecret = </span><span style="color:#6a8759">&#x27;YOUR_CLIENT_SECRET&#x27;</span><span>;
</span></span><span><span></span><span style="color:#cb7832">const</span><span> tokenData = </span><span style="color:#e0c46c">JSON</span><span>.parse(</span><span style="color:#cb7832">await</span><span> fs.readFile(</span><span style="color:#6a8759">&#x27;./tokens.125328655.json&#x27;</span><span>, </span><span style="color:#6a8759">&#x27;UTF-8&#x27;</span><span>));
</span></span><span><span></span><span style="color:#cb7832">const</span><span> tokenData = </span><span style="color:#e0c46c">JSON</span><span>.parse(</span><span style="color:#cb7832">await</span><span> fs.readFile(</span><span style="color:#6a8759">&#x27;./tokens.125328655.json&#x27;</span><span>, </span><span style="color:#6a8759">&#x27;utf-8&#x27;</span><span>));
</span></span><span><span></span><span style="color:#cb7832">const</span><span> authProvider = </span><span style="color:#cb7832">new</span><span> RefreshingAuthProvider(
</span></span><span> {
</span><span> clientId,
</span><span> clientSecret
</span><span> }
</span><span>);
</span><span>
</span><span><span>authProvider.onRefresh(</span><span style="color:#cb7832">async</span><span> (userId, newTokenData) =&gt; </span><span style="color:#cb7832">await</span><span> fs.writeFile(</span><span style="color:#6a8759">`./tokens.</span><span style="color:#e0c46c">${userId}</span><span style="color:#6a8759">.json`</span><span>, </span><span style="color:#e0c46c">JSON</span><span>.stringify(newTokenData, </span><span style="color:#6896ba">null</span><span>, </span><span style="color:#6896ba">4</span><span>), </span><span style="color:#6a8759">&#x27;UTF-8&#x27;</span><span>));
</span><span><span>authProvider.onRefresh(</span><span style="color:#cb7832">async</span><span> (userId, newTokenData) =&gt; </span><span style="color:#cb7832">await</span><span> fs.writeFile(</span><span style="color:#6a8759">`./tokens.</span><span style="color:#e0c46c">${userId}</span><span style="color:#6a8759">.json`</span><span>, </span><span style="color:#e0c46c">JSON</span><span>.stringify(newTokenData, </span><span style="color:#6896ba">null</span><span>, </span><span style="color:#6896ba">4</span><span>), </span><span style="color:#6a8759">&#x27;utf-8&#x27;</span><span>));
</span></span><span>
</span><span><span></span><span style="color:#cb7832">await</span><span> authProvider.addUserForToken(tokenData);</span></span></code></pre></div></pre>
<p>If you already know the ID of the user you&#x27;re adding, you can save a few internal requests by doing:</p>
Expand Down
8 changes: 4 additions & 4 deletions versions/main/docs/examples/chat/basic-bot.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -947,15 +947,15 @@ <h2>7. Persisting the refreshed token data</h2>
</span></span><span><span></span><span style="color:#cb7832">import</span><span> { promises </span><span style="color:#cb7832">as</span><span> fs } </span><span style="color:#cb7832">from</span><span> </span><span style="color:#6a8759">&#x27;fs&#x27;</span><span>;
</span></span><span>
</span><span><span></span><span style="color:#7f7f7f">// replace the constructor lines</span><span>
</span></span><span><span></span><span style="color:#cb7832">const</span><span> tokenData = </span><span style="color:#e0c46c">JSON</span><span>.parse(</span><span style="color:#cb7832">await</span><span> fs.readFile(</span><span style="color:#6a8759">&#x27;./tokens.125328655.json&#x27;</span><span>, </span><span style="color:#6a8759">&#x27;UTF-8&#x27;</span><span>));
</span></span><span><span></span><span style="color:#cb7832">const</span><span> tokenData = </span><span style="color:#e0c46c">JSON</span><span>.parse(</span><span style="color:#cb7832">await</span><span> fs.readFile(</span><span style="color:#6a8759">&#x27;./tokens.125328655.json&#x27;</span><span>, </span><span style="color:#6a8759">&#x27;utf-8&#x27;</span><span>));
</span></span><span><span></span><span style="color:#cb7832">const</span><span> authProvider = </span><span style="color:#cb7832">new</span><span> RefreshingAuthProvider(
</span></span><span> {
</span><span> clientId,
</span><span> clientSecret
</span><span> }
</span><span>);
</span><span>
</span><span><span>authProvider.onRefresh(</span><span style="color:#cb7832">async</span><span> (userId, newTokenData) =&gt; </span><span style="color:#cb7832">await</span><span> fs.writeFile(</span><span style="color:#6a8759">`./tokens.</span><span style="color:#e0c46c">${userId}</span><span style="color:#6a8759">.json`</span><span>, </span><span style="color:#e0c46c">JSON</span><span>.stringify(newTokenData, </span><span style="color:#6896ba">null</span><span>, </span><span style="color:#6896ba">4</span><span>), </span><span style="color:#6a8759">&#x27;UTF-8&#x27;</span><span>));
</span><span><span>authProvider.onRefresh(</span><span style="color:#cb7832">async</span><span> (userId, newTokenData) =&gt; </span><span style="color:#cb7832">await</span><span> fs.writeFile(</span><span style="color:#6a8759">`./tokens.</span><span style="color:#e0c46c">${userId}</span><span style="color:#6a8759">.json`</span><span>, </span><span style="color:#e0c46c">JSON</span><span>.stringify(newTokenData, </span><span style="color:#6896ba">null</span><span>, </span><span style="color:#6896ba">4</span><span>), </span><span style="color:#6a8759">&#x27;utf-8&#x27;</span><span>));
</span></span><span>
</span><span><span></span><span style="color:#cb7832">await</span><span> authProvider.addUserForToken(tokenData, [</span><span style="color:#6a8759">&#x27;chat&#x27;</span><span>]);</span></span></code></pre></pre>
<h2>8. ???</h2>
Expand All @@ -969,15 +969,15 @@ <h2>9. Profit!</h2>
</span></span><span>
</span><span><span></span><span style="color:#cb7832">const</span><span> clientId = </span><span style="color:#6a8759">&#x27;uo6dggojyb8d6soh92zknwmi5ej1q2&#x27;</span><span>;
</span></span><span><span></span><span style="color:#cb7832">const</span><span> clientSecret = </span><span style="color:#6a8759">&#x27;nyo51xcdrerl8z9m56w9w6wg&#x27;</span><span>;
</span></span><span><span></span><span style="color:#cb7832">const</span><span> tokenData = </span><span style="color:#e0c46c">JSON</span><span>.parse(</span><span style="color:#cb7832">await</span><span> fs.readFile(</span><span style="color:#6a8759">&#x27;./tokens.125328655.json&#x27;</span><span>, </span><span style="color:#6a8759">&#x27;UTF-8&#x27;</span><span>));
</span></span><span><span></span><span style="color:#cb7832">const</span><span> tokenData = </span><span style="color:#e0c46c">JSON</span><span>.parse(</span><span style="color:#cb7832">await</span><span> fs.readFile(</span><span style="color:#6a8759">&#x27;./tokens.125328655.json&#x27;</span><span>, </span><span style="color:#6a8759">&#x27;utf-8&#x27;</span><span>));
</span></span><span><span></span><span style="color:#cb7832">const</span><span> authProvider = </span><span style="color:#cb7832">new</span><span> RefreshingAuthProvider(
</span></span><span> {
</span><span> clientId,
</span><span> clientSecret
</span><span> }
</span><span>);
</span><span>
</span><span><span>authProvider.onRefresh(</span><span style="color:#cb7832">async</span><span> (userId, newTokenData) =&gt; </span><span style="color:#cb7832">await</span><span> fs.writeFile(</span><span style="color:#6a8759">`./tokens.</span><span style="color:#e0c46c">${userId}</span><span style="color:#6a8759">.json`</span><span>, </span><span style="color:#e0c46c">JSON</span><span>.stringify(newTokenData, </span><span style="color:#6896ba">null</span><span>, </span><span style="color:#6896ba">4</span><span>), </span><span style="color:#6a8759">&#x27;UTF-8&#x27;</span><span>));
</span><span><span>authProvider.onRefresh(</span><span style="color:#cb7832">async</span><span> (userId, newTokenData) =&gt; </span><span style="color:#cb7832">await</span><span> fs.writeFile(</span><span style="color:#6a8759">`./tokens.</span><span style="color:#e0c46c">${userId}</span><span style="color:#6a8759">.json`</span><span>, </span><span style="color:#e0c46c">JSON</span><span>.stringify(newTokenData, </span><span style="color:#6896ba">null</span><span>, </span><span style="color:#6896ba">4</span><span>), </span><span style="color:#6a8759">&#x27;utf-8&#x27;</span><span>));
</span></span><span>
</span><span><span></span><span style="color:#cb7832">await</span><span> authProvider.addUserForToken(tokenData, [</span><span style="color:#6a8759">&#x27;chat&#x27;</span><span>]);
</span></span><span>
Expand Down
4 changes: 2 additions & 2 deletions versions/main/docs/migration/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -909,9 +909,9 @@ <h2>Change event listener options in <a class="jss22" href="/versions/main/refer
<pre><pre style="display:block;overflow-x:auto;padding:0.5em;background:#2b2b2b;color:#bababa"><code class="language-ts" style="white-space:pre-wrap"><span><span style="color:#cb7832">const</span><span> authProvider = </span><span style="color:#cb7832">new</span><span> RefreshingAuthProvider({
</span></span><span> clientId,
</span><span> clientSecret,
</span><span class="jss31"><span> </span><span class="hljs-attr">onRefresh</span><span>: </span><span style="color:#cb7832">async</span><span> (userId, newTokenData) =&gt; </span><span style="color:#cb7832">await</span><span> fs.writeFile(</span><span style="color:#6a8759">`./tokens.</span><span style="color:#e0c46c">${userId}</span><span style="color:#6a8759">.json`</span><span>, </span><span style="color:#e0c46c">JSON</span><span>.stringify(newTokenData, </span><span style="color:#6896ba">null</span><span>, </span><span style="color:#6896ba">4</span><span>), </span><span style="color:#6a8759">&#x27;UTF-8&#x27;</span><span>),
</span><span class="jss31"><span> </span><span class="hljs-attr">onRefresh</span><span>: </span><span style="color:#cb7832">async</span><span> (userId, newTokenData) =&gt; </span><span style="color:#cb7832">await</span><span> fs.writeFile(</span><span style="color:#6a8759">`./tokens.</span><span style="color:#e0c46c">${userId}</span><span style="color:#6a8759">.json`</span><span>, </span><span style="color:#e0c46c">JSON</span><span>.stringify(newTokenData, </span><span style="color:#6896ba">null</span><span>, </span><span style="color:#6896ba">4</span><span>), </span><span style="color:#6a8759">&#x27;utf-8&#x27;</span><span>),
</span></span><span>});
</span><span class="jss30"><span>authProvider.onRefresh(</span><span style="color:#cb7832">async</span><span> (userId, newTokenData) =&gt; </span><span style="color:#cb7832">await</span><span> fs.writeFile(</span><span style="color:#6a8759">`./tokens.</span><span style="color:#e0c46c">${userId}</span><span style="color:#6a8759">.json`</span><span>, </span><span style="color:#e0c46c">JSON</span><span>.stringify(newTokenData, </span><span style="color:#6896ba">null</span><span>, </span><span style="color:#6896ba">4</span><span>), </span><span style="color:#6a8759">&#x27;UTF-8&#x27;</span><span>));</span></span></code></pre></pre>
</span><span class="jss30"><span>authProvider.onRefresh(</span><span style="color:#cb7832">async</span><span> (userId, newTokenData) =&gt; </span><span style="color:#cb7832">await</span><span> fs.writeFile(</span><span style="color:#6a8759">`./tokens.</span><span style="color:#e0c46c">${userId}</span><span style="color:#6a8759">.json`</span><span>, </span><span style="color:#e0c46c">JSON</span><span>.stringify(newTokenData, </span><span style="color:#6896ba">null</span><span>, </span><span style="color:#6896ba">4</span><span>), </span><span style="color:#6a8759">&#x27;utf-8&#x27;</span><span>));</span></span></code></pre></pre>
<h2>Update emote &amp; cheermote parsing</h2>
<p>The methods <code>parseEmotes</code> and <code>parseEmotesAndBits</code> were removed from the <a class="jss22" href="/versions/main/reference/chat/classes/ChatMessage.html">ChatMessage</a> class.
The function <a class="jss22" href="/versions/main/reference/chat/functions/parseChatMessage.html">parseChatMessage</a> replaces both of these.</p>
Expand Down
Loading

0 comments on commit 9729a28

Please sign in to comment.