Tawk 860rywc83 new api for connections

[jaoaustero]

Issue

Outdated for new connections of API and code documentation

Solution

Add the new API for start, shutdown and autoStart. Update the documentation for how to use
the new API

Summary by CodeRabbit

• New Features

  • Introduced an autoStart option for the chat widget, allowing users to control whether the chat connection starts automatically.
  • Added start and shutdown methods to manually initiate or terminate the chat connection.

• Documentation

  • Updated API documentation to include details, usage examples, and code snippets for the new autoStart, start, and shutdown features.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The chat widget's API was enhanced by introducing an autoStart option, along with new start and shutdown methods. These allow explicit control over the initialization and termination of the Tawk socket connection. Corresponding documentation updates detail usage, configuration, and code examples for these new features.

Changes

File(s)	Change Summary
docs/api-reference.md	Added documentation for autoStart option, start, and shutdown methods with usage examples.
src/lib/index.js	Implemented autoStart property, passed it to script loader, and exposed start/shutdown methods.
src/utils/widget.js	Updated loadScript to accept autoStart parameter and set window.Tawk_API.autoStart accordingly.

Sequence Diagram(s)

sequenceDiagram
    participant App
    participant TawkMessenger
    participant WidgetScript

    App->>TawkMessenger: Initialize (autoStart: false)
    TawkMessenger->>WidgetScript: loadScript(autoStart: false)
    WidgetScript->>window.Tawk_API: Set autoStart = false

    App->>TawkMessenger: Call start()
    TawkMessenger->>window.Tawk_API: start()

    App->>TawkMessenger: Call shutdown()
    TawkMessenger->>window.Tawk_API: shutdown()

Loading

Poem

A hop, a skip, a widget’s new start,
With autoStart you play your part.
Call start to begin, or shutdown to rest,
Control your chat—at your request!
🐇✨

In code we leap, in docs we shine,
Widget magic, by design!

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

yarn install v1.22.22
[1/4] Resolving packages...
(node:28956) [DEP0169] DeprecationWarning: url.parse() behavior is not standardized and prone to errors that have security implications. Use the WHATWG URL API instead. CVEs are not issued for url.parse() vulnerabilities.
(Use node --trace-deprecation ... to show where the warning was created)
warning @vue/cli-plugin-eslint > webpack > watchpack > watchpack-chokidar2 > chokidar > fsevents@1.2.13: Upgrade to fsevents v2 to mitigate potential security issues
[2/4] Fetching packages...
error @achrinza/node-ipc@9.2.2: The engine "node" is incompatible with this module. Expected version "8 || 10 || 12 || 14 || 16 || 17". Got "24.1.0"
error Found incompatible module.
info Visit https://yarnpkg.com/en/docs/cli/install for documentation about this command.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 875931f and 9baf196.

📒 Files selected for processing (3)

• docs/api-reference.md (2 hunks)
• src/lib/index.js (3 hunks)
• src/utils/widget.js (2 hunks)

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.