react-native-webrtc-kaleidoscope 0.0.0 → 0.0.1

package/NOTICE.md

@@ -0,0 +1,35 @@
+# Notices and Attributions
+
+react-native-webrtc-kaleidoscope ships under the MIT license (see [LICENSE](./LICENSE)). This document tracks third-party sources, standards, and trademarks referenced by the library and the effects it ships.
+
+## Runtime peer dependency
+
+- **react-native-webrtc** — MIT license. <https://github.com/react-native-webrtc/react-native-webrtc>. The `track._setVideoEffects(...)` JS surface, the Android `ProcessorProvider` registry, and the iOS `RTCVideoFrameProcessor` protocol all originate upstream. This package is a consumer of, not a fork of, that codebase.
+
+## Native segmentation backends (used by the `blur` effect)
+
+- **Apple Vision** (iOS) — system framework. `VNGeneratePersonSegmentationRequest`. Subject to the Apple SDK License Agreement.
+- **MLKit Selfie Segmentation** (Android) — Apache License 2.0. Distributed by Google as a managed AAR. <https://developers.google.com/ml-kit/vision/selfie-segmentation>.
+- **MediaPipe Selfie Segmentation** (web) — Apache License 2.0. Loaded as an `optionalDependency` so native consumers do not bundle the WASM payload. <https://github.com/google-ai-edge/mediapipe>.
+
+## Algorithmic and architectural references
+
+- **mrousavy/FaceBlurApp** — segmentation + GPU composite at 60–120 FPS. Different plumbing (camera-preview pipeline, not a WebRTC track), but the algorithmic shape of "mask + blurred copy + composite" is the same.
+- **Volcomix/virtual-background** — TFLite WASM reference for the web blur composite.
+
+## Trademarks
+
+- "Apple", "Vision", "Core Image", and related Apple marks are trademarks of Apple Inc. Used here as nominative references only.
+- "Google", "MLKit", and "MediaPipe" are trademarks of Google LLC. Used here as nominative references only.
+- "WebRTC" is a project of the W3C and IETF.
+
+This package is not affiliated with, endorsed by, or certified by Apple, Google, the W3C, or the `react-native-webrtc` project.
+
+## Forward-looking discipline
+
+Effects added after v0.1 that depend on new third-party code or registered marks must:
+
+1. Cite the source (with a stable URL and version) in the effect's source code.
+2. Add an attribution section to this document.
+3. Disclaim affiliation, endorsement, or certification where appropriate.
+4. Treat trademarked names as **nominative references** only.

package/README.md

@@ -1,7 +1,69 @@
 # react-native-webrtc-kaleidoscope
 
-Live video effects (mirror, blur, more) for `react-native-webrtc`, packaged as a managed-Expo-friendly Expo Module.
+> Live video effects for `react-native-webrtc`, packaged as a managed-Expo-friendly Expo Module. v0.1 ships **mirror** and **blur** on iOS, Android, and web.
 
-**This is a placeholder.** The package name is reserved while active development is in progress. The first usable release will be `v0.1` shipping the `mirror` and `blur` effects on iOS, Android, and web.
+## Status
 
-Source: <https://github.com/simiancraft/react-native-webrtc-kaleidoscope>
+Pre-1.0. Active development. The bootstrap-and-ship plan in [`bootstrap-and-ship-v0-1.md`](./bootstrap-and-ship-v0-1.md) (root, while it exists) is the source of truth for v0.1.
+
+The first usable release will be `v0.1.0`, shipping `mirror` and `blur` on all three platforms. Until then, the package is published as `0.1.0-alpha.x` for name reservation and integration testing.
+
+## Install
+
+```sh
+bun add react-native-webrtc react-native-webrtc-kaleidoscope
+```
+
+`react-native-webrtc` is a peer dependency. Install it explicitly.
+
+## Configure
+
+Add the config plugin to `app.config.ts`:
+
+```ts
+export default {
+  expo: {
+    plugins: ['react-native-webrtc', 'react-native-webrtc-kaleidoscope'],
+  },
+};
+```
+
+Then rebuild native code:
+
+```sh
+bunx expo prebuild
+```
+
+## Use
+
+```ts
+import { mediaDevices } from 'react-native-webrtc';
+import { applyVideoEffects } from 'react-native-webrtc-kaleidoscope';
+
+const stream = await mediaDevices.getUserMedia({ video: true });
+const [track] = stream.getVideoTracks();
+
+applyVideoEffects(track, ['blur']);   // background blur
+applyVideoEffects(track, ['mirror']); // horizontal flip
+applyVideoEffects(track, []);          // clear all effects
+```
+
+Effects chain in array order.
+
+## Platform support
+
+| Platform | Mirror | Blur | Backend |
+|---|---|---|---|
+| iOS ≥ 15 | ✓ | ✓ | Apple Vision + Core Image |
+| Android ≥ API 24 | ✓ | ✓ | MLKit Selfie Segmentation + RenderScript / RenderEffect |
+| Chrome / Edge | ✓ | ✓ | MediaStreamTrackProcessor + MediaPipe Selfie Segmentation (WASM) |
+| Safari | ✓ | ⚠ | No Insertable Streams; throws a typed error |
+| Firefox | ✓ | ⚠ | Same; capability-check before calling |
+
+## Reference
+
+- [CONTRIBUTING.md](./CONTRIBUTING.md) — setup, scripts, commit conventions
+- [AGENTS.md](./AGENTS.md) — agent / contributor orientation
+- [SECURITY.md](./SECURITY.md) — security policy and reporting
+- [NOTICE.md](./NOTICE.md) — third-party attributions
+- Sibling projects: [chromonym](https://github.com/simiancraft/chromonym), [unitforge](https://github.com/simiancraft/unitforge) — same OSS-hygiene template

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "react-native-webrtc-kaleidoscope",
-  "version": "0.0.0",
-  "description": "Live video effects (mirror, blur, more) for react-native-webrtc, packaged as a managed-Expo-friendly Expo Module. Placeholder; active development in progress.",
+  "version": "0.0.1",
+  "description": "Live video effects (mirror, blur, more) for react-native-webrtc, packaged as a managed-Expo-friendly Expo Module. v0.1: mirror + blur on iOS, Android, and web.",
   "keywords": [
     "react-native",
     "react-native-webrtc",
@@ -26,11 +26,77 @@
   "bugs": {
     "url": "https://github.com/simiancraft/react-native-webrtc-kaleidoscope/issues"
   },
+  "type": "module",
+  "sideEffects": false,
+  "main": "./src/index.ts",
+  "module": "./dist/index.js",
+  "react-native": "./src/index.ts",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "react-native": "./src/index.ts",
+      "browser": "./dist/index.web.js",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    },
+    "./app.plugin.js": "./app.plugin.js",
+    "./expo-module.config.json": "./expo-module.config.json",
+    "./package.json": "./package.json"
+  },
   "files": [
     "README.md",
-    "LICENSE"
+    "LICENSE",
+    "NOTICE.md"
   ],
+  "scripts": {
+    "clean": "rm -rf dist plugin/build",
+    "build": "bun run clean && tsgo && tsc -p plugin/",
+    "typecheck": "tsgo --noEmit",
+    "lint": "biome check",
+    "lint:fix": "biome check --write",
+    "format": "biome format --write .",
+    "test": "bun test",
+    "check:package": "publint && attw --pack --profile esm-only",
+    "check:knip": "knip",
+    "demo": "cd demo && bun run start",
+    "demo:ios": "cd demo && bun run ios",
+    "demo:android": "cd demo && bun run android",
+    "demo:web": "cd demo && bun run web"
+  },
+  "peerDependencies": {
+    "expo": ">=51.0.0",
+    "react": ">=18.2.0",
+    "react-native": ">=0.74.0",
+    "react-native-webrtc": ">=124.0.0"
+  },
+  "optionalDependencies": {
+    "@mediapipe/selfie_segmentation": "^0.1.1675465747"
+  },
+  "devDependencies": {
+    "@arethetypeswrong/cli": "^0.18.2",
+    "@biomejs/biome": "^2.4.13",
+    "@expo/config-plugins": "^9.0.0",
+    "@semantic-release/changelog": "^6.0.3",
+    "@semantic-release/git": "^10.0.1",
+    "@semantic-release/npm": "^13.1.5",
+    "@types/bun": "^1.3.12",
+    "@types/react": "^18.3.12",
+    "@typescript/native-preview": "7.0.0-dev.20260417.1",
+    "expo": "^51.0.0",
+    "expo-modules-core": "^1.12.0",
+    "knip": "^6.5.0",
+    "publint": "^0.3.18",
+    "react": "18.3.1",
+    "react-native": "0.74.5",
+    "react-native-webrtc": "^124.0.7",
+    "semantic-release": "^25.0.3",
+    "typescript": "^5.6.0"
+  },
   "publishConfig": {
     "access": "public"
+  },
+  "engines": {
+    "node": ">=20"
   }
 }