WeSDK Documentation (v2.0.0-dev)

Welcome to the documentation for the revamped Luffa JavaScript SDK.

This SDK is designed for H5 applications running inside Luffa mini program web-view containers (with compatibility for WeChat-like bridge environments), while still providing predictable behavior when no bridge is available.

What Is New in v2

Compared to the legacy SDK, v2 adds:

• Promise-first APIs with optional callback interop
• Runtime and capability introspection (getRuntimeInfo, getCapabilities, isApiSupported)
• Structured, inspectable SDK errors
• Response normalization (errMsg, __method, __status)
• Configurable bridge detection and readiness timeout
• Diagnostics hooks for observability
• TypeScript declarations for the full public API
• npm entry points for ESM and CommonJS

Recommended Reading Order

1. Getting Started
2. Core Concepts
3. Configuration
4. API sections:
   • Runtime and Capabilities
   • Navigation
   • Communication
   • Storage
   • Media
   • Location
   • Device and File
   • Plugin and Generic Invoke
5. Migration v1 to v2
6. Troubleshooting
7. Error Reference
8. FAQ

Who This Documentation Is For

• New developers integrating Luffa SDK for the first time
• Teams migrating from legacy callback-only WeSDK
• Developers building robust production flows with fallback behavior and diagnostics

SDK Distribution

The package exposes:

• Browser build: ./browser -> WeSDK.js
• ESM entry: index.mjs
• CJS entry: index.cjs
• Type definitions: index.d.ts

See Getting Started for usage examples.