@sanseng/liveavatar-js-sdk-skywalking 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 sanseng
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,42 @@
+# LiveAvatar SkyWalking Plugin
+
+`@sanseng/liveavatar-js-sdk-skywalking` connects LiveAvatar client diagnostics to SkyWalking. It bundles SkyWalking js-sdk `1.1.27`, so applications do not need to add a script tag or directly call `window.ClientMonitor.register(...)`.
+
+## What it solves
+
+- Reports LiveAvatar A/V Sync alert lifecycles with compact, causally ordered diagnostic evidence for investigation in SkyWalking.
+- Reports qualifying SDK Operational Log errors without uploading the original error message, stack, token, or business payload.
+- Adds observability through the public LiveAvatar Plugin API v1, without subscribing to legacy SDK events or using SDK internals.
+- Bundles and registers a browser SkyWalking client when one has not already been supplied by the application.
+
+## Quick start
+
+```sh
+npm install @sanseng/liveavatar-js-sdk @sanseng/liveavatar-js-sdk-skywalking
+```
+
+```ts
+import { createClient } from "@sanseng/liveavatar-js-sdk";
+import { createSkyWalkingPlugin } from "@sanseng/liveavatar-js-sdk-skywalking";
+
+const client = createClient({
+  debug: { avSync: { enabled: true } },
+  plugins: [
+    createSkyWalkingPlugin({
+      isOverseas: false,
+      serviceVersion: "web_1.0.0",
+      jsErrors: true,
+      apiErrors: true,
+      resourceErrors: true,
+      autoTracePerf: true,
+    }),
+  ],
+  connectConfig: {
+    // Your normal LiveAvatar connection configuration.
+  },
+});
+```
+
+The plugin registers SkyWalking during client setup. Its service is always `yy-tx::liveavatar-js-sdk`; it cannot be configured. If `window.ClientMonitor` already exists, the plugin treats it as externally registered and never overwrites or registers it. The bundled client registers only once per page; later differing configurations are ignored with a console warning.
+
+The package requires `@sanseng/liveavatar-js-sdk` `^2.2.0`.