deploy: 65246fe

d1snin · Sep 21, 2024 · 7647178 · 7647178
1 parent 136a673
commit 7647178
Show file tree

Hide file tree

Showing 117 changed files with 4,030 additions and 596 deletions.
diff --git a/images/anchor-copy-button.svg b/images/anchor-copy-button.svg
diff --git a/images/arrow_down.svg b/images/arrow_down.svg
diff --git a/images/burger.svg b/images/burger.svg
diff --git a/images/copy-icon.svg b/images/copy-icon.svg
diff --git a/images/copy-successful-icon.svg b/images/copy-successful-icon.svg
diff --git a/images/footer-go-to-link.svg b/images/footer-go-to-link.svg
diff --git a/images/go-to-top-icon.svg b/images/go-to-top-icon.svg
diff --git a/images/homepage.svg b/images/homepage.svg
diff --git a/images/logo-icon.svg b/images/logo-icon.svg
diff --git a/images/nav-icons/abstract-class-kotlin.svg b/images/nav-icons/abstract-class-kotlin.svg
diff --git a/images/nav-icons/annotation-kotlin.svg b/images/nav-icons/annotation-kotlin.svg
diff --git a/images/nav-icons/class-kotlin.svg b/images/nav-icons/class-kotlin.svg
diff --git a/images/nav-icons/enum-kotlin.svg b/images/nav-icons/enum-kotlin.svg
diff --git a/images/nav-icons/field-value.svg b/images/nav-icons/field-value.svg
diff --git a/images/nav-icons/field-variable.svg b/images/nav-icons/field-variable.svg
diff --git a/images/nav-icons/interface-kotlin.svg b/images/nav-icons/interface-kotlin.svg
diff --git a/images/nav-icons/object.svg b/images/nav-icons/object.svg
diff --git a/images/nav-icons/typealias-kotlin.svg b/images/nav-icons/typealias-kotlin.svg
diff --git a/images/theme-toggle.svg b/images/theme-toggle.svg
diff --git a/index.html b/index.html
@@ -44,7 +44,7 @@
                     </a>
             </div>
             <div class="library-version">
-1.1.1            </div>
+2.0.0            </div>
         </div>
     </div>
     <div class="navigation-controls">
@@ -63,31 +63,31 @@
     <div class="cover ">
       <p class="paragraph"><a href="https://github.com/d1snin/ktor-ws-events/actions/workflows/e2e-test.yml"><img alt="" src="https://github.com/d1snin/ktor-ws-events/actions/workflows/e2e-test.yml/badge.svg"></a> <a href="https://maven.d1s.dev/#/releases/dev/d1s/ktor-ws-events"></a></p>
       <p class="paragraph">Event streaming extensions for Ktor over WebSocket protocol. Support is provided for both client and server.</p>
-      <h3 class=""> Installation</h3>
+      <h3 class="">Installation</h3>
       <div class="sample-container">
         <pre><code class="block lang-kotlin" theme="idea">repositories {<br>    maven(url = &quot;https://maven.d1s.dev/releases&quot;)<br>}<br><br>dependencies {<br>    val ktorWsEventsVersion: String by project<br><br>    // server side<br>    implementation(&quot;dev.d1s.ktor-ws-events:ktor-ws-events-server:$ktorWsEventsVersion&quot;)<br><br>    // client side<br>    implementation(&quot;dev.d1s.ktor-ws-events:ktor-ws-events-client:$ktorWsEventsVersion&quot;)<br>}</code></pre>
 <span class="top-right-position"><span class="copy-icon"></span>
           <div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div>
         </span></div>
-      <h3 class=""> Example usage on the server side</h3>
+      <h3 class="">Example usage on the server side</h3>
       <div class="sample-container">
         <pre><code class="block lang-kotlin" theme="idea">val eventChannel = WebSocketEventChannel()<br><br>fun Application.configureWebSocketEvents() {<br>    install(WebSocketEvents) {<br>        channel = eventChannel<br>    }<br><br>    routing {<br>        webSocketEvents()<br>    }<br>}<br><br>fun handleServerFailure(failure: ServerFailure) {<br>    val reference = ref(&quot;server_failure&quot;)<br>    val event = event(reference) {<br>        failure<br>    }<br><br>    eventChannel.send(event)<br>}</code></pre>
 <span class="top-right-position"><span class="copy-icon"></span>
           <div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div>
         </span></div>
-      <h3 class=""> Example usage on the client side</h3>
+      <h3 class="">Example usage on the client side</h3>
       <div class="sample-container">
         <pre><code class="block lang-kotlin" theme="idea">fun HttClient.configureWebSocketEvents() {<br>    install(WebSockets) {<br>        contentConverter = KotlinxWebsocketSerializationConverter(Json)<br>    }<br>    <br>    install(WebSocketEvents) {<br>        host = &quot;example.com&quot;<br>        port = 9090<br>    }<br>}<br><br>fun HttpClient.listenToServerFailures() {<br>    val reference = ref(&quot;server_failure&quot;)<br><br>    webSocketEvents(reference) {<br>        val event = receiveWebSocketEvent&lt;ServerFailure&gt;()<br>        val failure = event.data<br><br>        notifyTeam(failure)<br>    }<br>}</code></pre>
 <span class="top-right-position"><span class="copy-icon"></span>
           <div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div>
         </span></div>
-      <h3 class=""> How to contribute</h3>
+      <h3 class="">How to contribute</h3>
       <p class="paragraph">See <a href="https://github.com/d1snin/ktor-ws-events/blob/main/CONTRIBUTING.md">CONTRIBUTING.md</a></p>
-      <h3 class=""> Code of Conduct</h3>
+      <h3 class="">Code of Conduct</h3>
       <p class="paragraph">See <a href="https://github.com/d1snin/ktor-ws-events/blob/main/CODE_OF_CONDUCT.md">CODE_OF_CONDUCT.md</a></p>
-      <h3 class=""> License</h3>
+      <h3 class="">License</h3>
       <div class="sample-container">
-        <pre><code class="block lang-text" theme="idea">   Copyright 2022-2023 Mikhail Titov<br><br>   Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);<br>   you may not use this file except in compliance with the License.<br>   You may obtain a copy of the License at<br><br>       https://www.apache.org/licenses/LICENSE-2.0<br><br>   Unless required by applicable law or agreed to in writing, software<br>   distributed under the License is distributed on an &quot;AS IS&quot; BASIS,<br>   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<br>   See the License for the specific language governing permissions and<br>   limitations under the License.</code></pre>
+        <pre><code class="block lang-text" theme="idea">   Copyright 2022-2024 Mikhail Titov<br><br>   Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);<br>   you may not use this file except in compliance with the License.<br>   You may obtain a copy of the License at<br><br>       https://www.apache.org/licenses/LICENSE-2.0<br><br>   Unless required by applicable law or agreed to in writing, software<br>   distributed under the License is distributed on an &quot;AS IS&quot; BASIS,<br>   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<br>   See the License for the specific language governing permissions and<br>   limitations under the License.</code></pre>
 <span class="top-right-position"><span class="copy-icon"></span>
           <div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div>
         </span></div>

diff --git a/...-client/dev.d1s.ktor.events.client/-client-web-socket-event/-client-web-socket-event.html b/...-client/dev.d1s.ktor.events.client/-client-web-socket-event/-client-web-socket-event.html
@@ -41,7 +41,7 @@
 <a class="library-name--link" href="../../../index.html">
                             ktor-ws-events
                     </a>            </div>
-            <div class="library-version">1.1.1
+            <div class="library-version">2.0.0
             </div>
         </div>
         <div class="filter-section" id="filter-section">
@@ -58,12 +58,12 @@
                 <div class="sidebar--inner" id="sideMenu"></div>
             </div>
             <div id="main">
-<div class="main-content" data-page-type="member" id="content" pageids="ktor-ws-events-client::dev.d1s.ktor.events.client/ClientWebSocketEvent/ClientWebSocketEvent/#dev.d1s.ktor.events.commons.EventReference#TypeParam(bounds=[kotlin.Any?])/PointingToDeclaration//1587441814">
+<div class="main-content" data-page-type="member" id="content" pageids="ktor-ws-events-client::dev.d1s.ktor.events.client/ClientWebSocketEvent/ClientWebSocketEvent/#kotlin.String#dev.d1s.ktor.events.commons.EventReference#kotlin.Long#TypeParam(bounds=[kotlin.Any?])/PointingToDeclaration//1587441814">
   <div class="breadcrumbs"><a href="../../index.html">ktor-ws-events-client</a><span class="delimiter">/</span><a href="../index.html">dev.d1s.ktor.events.client</a><span class="delimiter">/</span><a href="index.html">ClientWebSocketEvent</a><span class="delimiter">/</span><span class="current">ClientWebSocketEvent</span></div>
   <div class="cover ">
     <h1 class="cover"><span>Client</span><wbr><span>Web</span><wbr><span>Socket</span><wbr><span><span>Event</span></span></h1>
   </div>
-  <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":ktor-ws-events-client:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">constructor</span><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">reference<span class="token operator">: </span><a href="../../../ktor-ws-events-commons/dev.d1s.ktor.events.commons/-event-reference/index.html">EventReference</a><span class="token punctuation">, </span></span><span class="parameter ">data<span class="token operator">: </span><a href="index.html">T</a></span></span><span class="token punctuation">)</span></div></div></div>
+  <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":ktor-ws-events-client:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">constructor</span><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">id<span class="token operator">: </span><a href="../../../ktor-ws-events-commons/dev.d1s.ktor.events.commons/-identifier/index.html">Identifier</a><span class="token punctuation">, </span></span><span class="parameter ">reference<span class="token operator">: </span><a href="../../../ktor-ws-events-commons/dev.d1s.ktor.events.commons/-event-reference/index.html">EventReference</a><span class="token punctuation">, </span></span><span class="parameter ">initiated<span class="token operator">: </span><a href="../../../ktor-ws-events-commons/dev.d1s.ktor.events.commons/-unix-time/index.html">UnixTime</a><span class="token punctuation">, </span></span><span class="parameter ">data<span class="token operator">: </span><a href="index.html">T</a></span></span><span class="token punctuation">)</span></div></div></div>
 </div>
       <div class="footer">
         <span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>Copyright (c) 2022-2023 Mikhail Titov</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>

diff --git a/ktor-ws-events-client/dev.d1s.ktor.events.client/-client-web-socket-event/data.html b/ktor-ws-events-client/dev.d1s.ktor.events.client/-client-web-socket-event/data.html
@@ -41,7 +41,7 @@
 <a class="library-name--link" href="../../../index.html">
                             ktor-ws-events
                     </a>            </div>
-            <div class="library-version">1.1.1
+            <div class="library-version">2.0.0
             </div>
         </div>
         <div class="filter-section" id="filter-section">
@@ -63,7 +63,7 @@
   <div class="cover ">
     <h1 class="cover"><span><span>data</span></span></h1>
   </div>
-  <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":ktor-ws-events-client:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><a href="data.html">data</a><span class="token operator">: </span><a href="index.html">T</a></div></div></div>
+  <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":ktor-ws-events-client:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">val </span><a href="data.html">data</a><span class="token operator">: </span><a href="index.html">T</a></div></div></div>
 </div>
       <div class="footer">
         <span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>Copyright (c) 2022-2023 Mikhail Titov</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>