Getting Started

インストール

npm

bun add @capgo/capacitor-updater
bunx cap sync

yarn

yarn add @capgo/capacitor-updater
bunx cap sync

pnpm

pnpm add @capgo/capacitor-updater
bunx cap sync

bun

bun add @capgo/capacitor-updater
bunx cap sync

Quick Start

Capgoの主なユーザー向けの Quickstartガイド CapgoのプラグインのインストールとCapgoのクラウド統合をカバーしています。

このガイドは、Capgoのプラグインの技術的な詳細についての理解や、自社ホストの更新の実装を目的とした高度なユーザー向けのものです。

概要

Capacitor アップデーター プラグインは、Capacitor アプリケーション向けのオーバー・ザ・エア (OTA) アップデートを有効にします。これにより、App Storeのレビューを経ることなく、アプリにアップデートをプッシュできます。

しくみ

1. バンドルダウンロード: プラグインは、ZIPファイルに含まれるWebアセットを含むアップデートバンドルをダウンロードします。
2. エクストラクト: バンドルは、デバイスのストレージにエクストラクトされます。
3. ホットリロード: アプリは、新しいバンドルに切り替わり、再起動を必要とせずにアップデートされます。
4. フォールバック: アップデートが失敗した場合、 アプリは前の正常に動作していたバージョンに戻ります。

Usage Modes

1. Auto-Update Mode (推奨)

自動更新管理とともにプラグインを使用する最も簡単な方法:

import { CapacitorUpdater } from '@capgo/capacitor-updater';

// Plugin handles everything automatically
// Configure in capacitor.config.ts

あなたの capacitor.config.ts:

{
  plugins: {
    CapacitorUpdater: {
      autoUpdate: 'atBackground',
      updateUrl: 'https://your-update-server.com/api/updates'
    }
  }
}

2. Manual Mode

アップデートプロセスに対する高度な制御を必要とする場合:

import { CapacitorUpdater } from '@capgo/capacitor-updater';

// Download an update
const bundle = await CapacitorUpdater.download({
  url: 'https://your-server.com/updates/v1.0.1.zip',
  version: '1.0.1'
});

// Set the bundle (will be used on next app start)
await CapacitorUpdater.set({
  id: bundle.id
});

// Or reload immediately
await CapacitorUpdater.reload();

プラットフォーム設定

iOS

プラグインはデフォルトで動作します。追加の設定は必要ありません。

Android

プラグインはデフォルトで動作します。追加の設定は必要ありません。

基本APIの使用

アップデートをダウンロード

import { CapacitorUpdater } from '@capgo/capacitor-updater';

const bundle = await CapacitorUpdater.download({
  url: 'https://example.com/update.zip',
  version: '1.0.1'
});

console.log('Downloaded bundle:', bundle.id);

アクティブバンドルを設定

// Set bundle to be used on next app start
await CapacitorUpdater.set({
  id: bundle.id
});

新しいバンドルでリロード

// Reload app immediately with new bundle
await CapacitorUpdater.reload();

バンドルの一覧

const { bundles } = await CapacitorUpdater.list();
console.log('Available bundles:', bundles);

バンドルを削除

await CapacitorUpdater.delete({
  id: 'bundle-id'
});

現在のバンドルを取得

const { bundle } = await CapacitorUpdater.current();
console.log('Current bundle:', bundle.version);

イベントリスナー

更新イベントをリスンする:

import { CapacitorUpdater } from '@capgo/capacitor-updater';

// Listen for download progress
CapacitorUpdater.addListener('download', (info) => {
  console.log('Download progress:', info.percent);
});

// Listen for download completion
CapacitorUpdater.addListener('downloadComplete', (bundle) => {
  console.log('Download complete:', bundle.version);
});

// Listen for update failures
CapacitorUpdater.addListener('updateFailed', (error) => {
  console.error('Update failed:', error);
});

// Listen for successful updates
CapacitorUpdater.addListener('updateAvailable', (info) => {
  console.log('Update available:', info.version);
});

設定オプション

コピー capacitor.config.ts:

{
  plugins: {
    CapacitorUpdater: {
      // Auto-update settings
      autoUpdate: 'atBackground',
      updateUrl: 'https://api.example.com/updates',

      // Update behavior
      resetWhenUpdate: true,

      // Version settings
      version: '1.0.0',

      // Security
      allowModifyUrl: false,

      // Stats collection
      statsUrl: 'https://api.example.com/stats',

      // Channel (for Capgo cloud)
      defaultChannel: 'production'
    }
  }
}

統合パターン

Capgo Cloudとともに

始めるには最も簡単な方法:

// Install the Capgo CLI
bun add -g @capgo/cli

// Login to Capgo
npx @capgo/cli login

// Upload your first bundle
npx @capgo/cli bundle upload

// The plugin auto-updates from Capgo cloud

「 main Quickstartガイド」 詳細については

自社ホストの更新

Host your own update server:

// Configure your update endpoint
{
  plugins: {
    CapacitorUpdater: {
      autoUpdate: 'atBackground',
      updateUrl: 'https://your-server.com/api/check-update'
    }
  }
}

Your server should return:

{
  "version": "1.0.1",
  "url": "https://your-server.com/updates/1.0.1.zip"
}

See Self-Hosted Mode for complete details.

Manual Update Flow

Complete control over updates:

import { CapacitorUpdater } from '@capgo/capacitor-updater';

async function checkAndUpdate() {
  // Check for updates from your server
  const response = await fetch('https://api.example.com/check-update');
  const { version, url } = await response.json();

  // Download the update
  const bundle = await CapacitorUpdater.download({
    url,
    version
  });

  // Notify bundle is ready
  await CapacitorUpdater.notifyAppReady();

  // Set as next version
  await CapacitorUpdater.set({ id: bundle.id });

  // Reload when ready
  await CapacitorUpdater.reload();
}

Best Practices

• 常にアプリが正常に読み込まれた場合に呼び出す notifyAppReady() アプリが正常に読み込まれたときに呼び出す
• テスト更新を徹底して、生産環境にプッシュする前に
• ネットワークエラーの際に適切なエラーハンドリングを実装する
• バージョン番号を一貫して使用する
• ダウンロードが速くなるように、バンドルサイズを小さく保つ
• 更新の成功率を監視する

次のステップ

• プラグイン API リファレンス API ドキュメントを完了する
• プラグイン設定 - 全ての構成オプション
• イベント - 利用可能な更新イベント
• 自主ホストモード - 自分で更新サーバーを実行
• ローカル開発 - ローカルで更新をテスト
• デバッグ - トラブルシューティングガイド

サポート

• Known Issues - 共通問題と解決策
• GitHub Discussions - コミュニティサポート
• Discord -リアルタイムチャット

Getting Startedから続けて

Capacitorを使用している場合 Getting Started nativeプラグインの作業を計画するには、__CAPGO_KEEP_0__と__CAPGO_KEEP_1__を接続する Using @capgo/capacitor-updater native機能のための@capgo/capacitor-updaterの使用 Capgo プラグインディレクトリ Capgo プラグインのための製品ワークフロー Capacitor プラグインのCapgo Capacitor プラグインのCapgoの実装詳細 プラグインの追加または更新 __CAPGO_KEEP_0__ プラグインの追加または更新の実装詳細 Ionic Enterprise プラグインの代替 Ionic Enterprise プラグインの代替の製品ワークフロー