Applicability docs

[KetanReddy]

Release Notes

• Update applicability docs to reflect desired patterns and behaviors
• Fix flaky react reference asset test
• Fix misc vitest issues when running outside of bazel (cjs environment, excluded directories)

Change Type (required)

Indicate the type of change your pull request is:

• patch
• minor
• major

Does your PR have any documentation updates?

• Updated docs
• No Update needed
• Unable to update docs

Version

Published prerelease version: 0.10.0-next.7

Changelog

Release Notes

Applicability docs (#544)

• Update applicability docs to reflect desired patterns and behaviors
• Fix flaky react reference asset test
• Fix misc vitest issues when running outside of bazel (cjs environment, excluded directories)

Change Type (required)

Indicate the type of change your pull request is:

• patch
• minor
• major

Does your PR have any documentation updates?

• Updated docs
• No Update needed
• Unable to update docs

Remove unneeded dependency on pubsub-js (#547)

Remove dead dependencies

Change Type (required)

Indicate the type of change your pull request is:

• patch
• minor
• major

Does your PR have any documentation updates?

• Updated docs
• No Update needed
• Unable to update docs

Minor Docs Fixes (#538)

• Fix search on next subdomain searching against and redirecting to latest
• Update page description on the landing page

Change Type (required)

Indicate the type of change your pull request is:

• patch
• minor
• major

Does your PR have any documentation updates?

• Updated docs
• No Update needed
• Unable to update docs

More Doc Fixes (#532)

• Fix links for latest and next pages
• Add package manager tabs for js install instructions
• Fix version selector breaking on main page

Change Type (required)

Indicate the type of change your pull request is:

• patch
• minor
• major

Does your PR have any documentation updates?

• Updated docs
• No Update needed
• Unable to update docs

Fix docs build visibility (#531)

Fix visibility of docs build

ios: enhance tapable logger to handle variadic args from the JS log (#524)

Prefixing message with the format [Player] [\(logLevel)]: moved out of the Tapable logger and moved to PrintLoggerPlugin. Any consumers using their own LoggerPlugin will need to append the logLevel if they want to print it

Before

public class CustomLoggingPlugin: NativePlugin {
    
    public let pluginName = "CustomLoggingPlugin"

    public func apply<P>(player: P) where P: HeadlessPlayer {
        guard let player = player as? SwiftUIPlayer else { return }
        player.logger.logLevel = .trace
        player.logger.hooks.trace.tap(name: pluginName, { print("Custom message")\(($0))" ) })
        ...
    }

After

public class CustomLoggingPlugin: NativePlugin {
    
    public let pluginName = "CustomLoggingPlugin"

    public func apply<P>(player: P) where P: HeadlessPlayer {
        guard let player = player as? SwiftUIPlayer else { return }
        player.logger.logLevel = .trace
        let prefixedMessage = "[Player] [trace]: "
        player.logger.hooks.trace.tap(name: pluginName, { print("\(prefixedMessage) Custom message \(($0))" ) })
        ...
    }

Breaking Changes

Any usage of the player.logger.hooks taps will have breaking changes in the callback because the calls have been changed to provide a [Any] type instead of String so it can be returned in the form of messages instead of a single message. Unless nothing is done in the callback to access the value but just to print it, there should be breaking changes

Example:

// this should be no breaking change
player.logger.hooks.trace.tap(name: "log", { print("\(($0))" ) })

// if `values` should be accessed in anyway, i.e want the first value, or want to seperate the values
 player.logger.hooks.debug.tap(name: "log") { values in
            // values is of type [Any], if you want to print only the first value
            print("\((message as? [String])?.first))" )
        }

---

🚀 Enhancement

• ios: enhance tapable logger to handle variadic args from the JS log #524 (@nancywu1)

🐛 Bug Fix

• Applicability docs #544 (@KetanReddy @nancywu1)
• iOS: Expose builldBeacon and cancelBeacon hooks inside of BaseBeaconPlugin and make BeaconPlugin open class #536 (@sakuntala-motukuri)
• Remove unneeded dependency on pubsub-js #547 (@KetanReddy)
• remove unneeded HTML report generation steps from build #545 (@nancywu1)
• Fix parsing of Bindings with Escaped Numbers #533 (@KetanReddy)
• Update getting-started.mdx #534 (@aarora-pm)
• More Doc Fixes #532 (@KetanReddy)
• Fix docs build visibility #531 (@KetanReddy)
• Fix CJS support for React Player #525 (@KetanReddy)
• iOS: Expand AnyType to handle deeply nested AnyType for beacon encoding #519 (@hborawski)
• Updating Main Page Content #508 (@KetanReddy @adierkens)

🏠 Internal

• Fix circleci badge in README #480 (@adierkens @KetanReddy)

📝 Documentation

• Minor Docs Fixes #538 (@KetanReddy)
• fix exports in docs #511 (@spentacular @KetanReddy)
• Docs refresh with Astro #506 (@adierkens @KetanReddy)

Authors: 7

• @aarora-pm
• @nancywu1
• Adam Dierkens (@adierkens)
• Harris Borawski (@hborawski)
• Ketan Reddy (@KetanReddy)
• Niharika Motukuri (@sakuntala-motukuri)
• Spencer Hamm (@spentacular)

[codecov]

Codecov Report

Attention: Patch coverage is 0% with 8 lines in your changes missing coverage. Please review.

Project coverage is 89.54%. Comparing base (fb57765) to head (1172c55).
Report is 25 commits behind head on main.

Files with missing lines	Patch %	Lines
vitest.config.mts	0.00%	8 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #544      +/-   ##
==========================================
- Coverage   89.57%   89.54%   -0.04%     
==========================================
  Files         331      331              
  Lines       19718    19725       +7     
  Branches     1949     1949              
==========================================
  Hits        17663    17663              
- Misses       2041     2048       +7     
  Partials       14       14              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

---

🚨 Try these New Features:

• Flaky Tests Detection - Detect and resolve failed and flaky tests
• JS Bundle Analysis - Avoid shipping oversized bundles