Everframe

Everframe SDK

Everframe のレポート用 SDK、共有プロトコルと SDK コア、開発者向けツール、サンプルアプリケーションのオープンソースリポジトリです。

Everframe を使うと、問題を再現するために必要なコンテキストとともに、アプリケーション内から問題を報告できます。スクリーンショットと注釈、セッションの証拠、パンくずリスト、デバイスとアプリケーションのメタデータ、捕捉されたエラーなどを含められます。

SDK を選択

プラットフォーム	SDK	ドキュメント	例
Web およびフレームワークに依存しない JavaScript	@everframe/web	Web SDK	Vue, スマート TV
React	@everframe/react	React SDK	React Web
React Native、Apple TV、Android TV	@everframe/react-native	React Native SDK	React Native
Android、iOS、Web 向け Flutter	everframe_flutter	Flutter SDK	Android プローブ, iOS プローブ, Web プローブ
Android、iOS、Kotlin/JS 向け Kotlin Multiplatform	dev.everframe:kmp	KMP SDK	Android プローブ, iOS プローブ, ブラウザーキャンバスのプローブ
Android および Android TV	dev.everframe Maven modules	Android SDK	Compose, Views
iOS、iPadOS、tvOS	Everframe Swift package	Apple SDK	iOS, tvOS リプレイ
サーバーサイドの識別	@everframe/identity	識別ヘルパー	ランタイムごとのレシピはパッケージのドキュメントに記載されています

各 SDK の README は、インストール、設定、プライバシー管理、プラットフォームのサポート、現在の制限事項に関する正式なガイドです。

共有パッケージとツール

• @everframe/protocol は、すべての SDK で共有されるバージョン管理されたレポートエンベロープを定義し、ネイティブ実装で使用する生成済み JSON Schema を提供します。
• @everframe/sdk-core には、Web、React、React Native の各 SDK で共有される、プラットフォームに依存しない TypeScript のレポートランタイムとユーティリティが含まれています。
• Babel と SWC のプラグインは、最適化ビルドで React コンポーネント名を保持します。
• packages/sdk-android と packages/sdk-ios には、ネイティブ SDK のソース、プラットフォームテスト、公開用ツールが含まれています。

SDK の使用

アプリケーション用のパッケージをインストールし、プラットフォーム別のガイドに従ってください。たとえば、JavaScript プロジェクトの場合は次のとおりです。

pnpm add @everframe/web
# or
pnpm add @everframe/react
# or
pnpm add @everframe/react-native
# Flutter apps use pub.dev:
flutter pub add everframe_flutter

Android SDK は、Maven Central を通じて dev.everframe Maven モジュールとして配布されています。Apple のタグ付きリリースは、このリポジトリから Swift Package Manager を使用して利用できます。ドキュメントには、最新の座標、プロダクト、セットアップ手順が記載されています。

例

examples ディレクトリには、サポートされているプラットフォームと統合方式で実行できるホストが含まれています。

例	内容
react-web	React Web の統合と SSR/CSP のフィクスチャ
vue-web	Vue からのフレームワーク非依存 SDK 統合
smarttv-tester	ブラウザーでの Smart TV の動作
react-native	React Native ブリッジの統合
flutter-android-probe	Flutter Android のソースとプライバシープローブ
flutter-ios-probe	Flutter iOS のソースとプライバシープローブ
android-compose	Jetpack Compose を使用したネイティブ Android
android-views	Views システムを使用したネイティブ Android
ios-native	ネイティブ iOS の統合
tvos-replay	認証情報不要の tvOS リプレイとリモートフォーカスのスモークテスト

Everframe に接続する例では、生成され、Git の追跡対象外となっている設定から開発用認証情報を読み込みます。リポジトリに含まれているテンプレートを使って始めてください。

cp .env.example .env

実行する例で必要な値だけを入力してください。SDK キー、ID シークレット、生成されたプラットフォーム設定、本番データは決してコミットしないでください。

コントリビュート

JavaScript の開発には Node.js 22 と pnpm 9.15 が必要です。Android の開発には互換性のある JDK と Android SDK も必要で、Apple の開発には Xcode が必要です。

git clone https://github.com/scriptx-com/everframe.git
cd everframe
corepack enable
pnpm install --frozen-lockfile

CI で使用しているものと同じ JavaScript ワークスペースのチェックを実行してください。

pnpm test:boundary
pnpm check:boundary
pnpm build:packages
pnpm test:packages
pnpm typecheck:packages
pnpm build:examples
pnpm test:examples
pnpm typecheck:examples
pnpm check:publish

ネイティブのチェックは、各プラットフォームのプロジェクトから実行してください。

# Android
cd packages/sdk-android/android
./gradlew test assembleRelease

# Apple, from the repository root
EVERFRAME_DEV_INGEST_URL=http://127.0.0.1:9 \
  swift test --package-path packages/sdk-ios --no-parallel

コントリビュートとライセンスの規則については、CONTRIBUTING.md を参照してください。

リリース

JavaScript パッケージは npm で公開され、Flutter プラグインは pub.dev で公開されます。Android の成果物は Maven パッケージとして公開され、タグ付きの Apple リリースでは、Swift Package Manager の利用者向けに バイナリ XCFramework が提供されます。

Android と KMP の Maven 成果物は同じバージョンを使用し、Central Portal へのアップロードも 1 回で行います。SIGNING_KEY と SIGNING_PASSWORD を設定して pnpm build:mobile-maven-bundle を実行すると、署名済みバンドルをビルドして検証できます。 署名する前に未署名のバンドルを確認するには、 pnpm build:mobile-maven-bundle --prepare を使用します。この ZIP は Maven Central にアップロードできません。

ルートの Package.swift は、Apple SDK の利用者が使用するバイナリマニフェストです。ソースの開発とテストには packages/sdk-ios/Package.swift を使用します。

セキュリティ

脆弱性は、SECURITY.md に記載されている方法で非公開に報告してください。 リポジトリの公開前チェックでは、リリース前に許可された公開ファイルの範囲、SPDX メタデータ、 コミット済みのコンテンツ、Git の履歴を確認します。

ライセンス

ScriptX が所有するソースは、MIT ライセンスの下で利用できます。バンドルされた上流のファイルには、 それぞれの元のライセンスが適用されます。詳細は LICENSES と REUSE.toml を参照してください。