@swype-org/react-sdk 0.2.174 → 0.2.186

package/README.md

@@ -8,6 +8,42 @@ Published versions on npm are released as part of the **production** deploy work
 
 Pin a specific version in your app (for example `"@swype-org/react-sdk": "0.1.x"`) instead of relying on floating `latest` in production.
 
+## Browser globals
+
+The SDK automatically polyfills the `Buffer` global on import. The embedded
+smart-wallet provider used by the one-tap setup and signing flows references
+the Node `Buffer` global at runtime; without a polyfill, browser bundles fail
+with `An internal error was received. Details: Buffer is not defined`.
+
+The polyfill is a no-op if the host application already defines `Buffer`
+(e.g. via its own `vite-plugin-node-polyfills` or manual assignment), so it
+never overwrites a host-provided polyfill.
+
+### When the host needs its own polyfill
+
+ES module hoisting means the SDK polyfill only runs when the SDK module
+graph first loads. If the host application imports another Buffer-using
+library (for example `@solana/kit`, `@solana/spl-token`, `bs58`, or
+`tweetnacl`) **outside** of the SDK's import graph, that library's
+top-level code can run before the SDK polyfill and crash with
+`ReferenceError: Buffer is not defined`.
+
+In that case the host must polyfill `Buffer` itself, before any other
+import. The pattern is:
+
+```ts
+// src/polyfills.ts
+import { Buffer } from 'buffer';
+if (typeof globalThis.Buffer === 'undefined') {
+  globalThis.Buffer = Buffer;
+}
+
+// src/main.tsx — must be the FIRST import
+import './polyfills';
+import React from 'react';
+// ...
+```
+
 ## Local development
 
 To use the package from a git checkout without waiting for npm: