バンドル

このプラグインのインストール手順とフルマークダウンガイドをコピーします。

バンドルは、Capgoのコアアップデートパッケージです。各バンドルには、Webアセット(HTML、CSS、JS)が含まれ、これらはアプリのコンテンツを構成します。バンドル管理ツールのAPIは、これらのアップデートパッケージを管理することを可能にし、リストや削除が可能です。

バンドルの理解

バンドルは、特定のバージョンのアプリのWebコンテンツを表し、以下の要素を含みます。

バンドル(バージョン): バージョン番号バンドルのバージョン
チェックサム: バンドルの完全性を確認するためのユニークなハッシュ
ストレージ情報: バンドルがどの位置でどのように保存されているかについての詳細
ネイティブ要件: ネイティブアプリの最小バージョン要件
メタデータ: 作成時間、所有権、トラッキング情報など

手動バンドル作成 (Without CLI)

ここでは、Capgo CLI を使用せずにバンドルを作成してアップロードする方法を説明します。

ステップ 1: アプリをビルドする

最初に、Web アセットをビルドしてください。

npm run build

ステップ 2: Capgo CLI が内部で使用する同等のパッケージを使用してバンドル ZIP を作成する

重要: Capgo CLI が内部で使用する JavaScript パッケージと完全に一致するように、同等のパッケージを使用してください。

必要なパッケージをインストールする

npm install adm-zip @tomasklaen/checksum

JavaScriptでZipバンドルを作成（CapgoとCLIと同じ）

以下の例では、 version APIが使用するバンドル（バージョン）名を指します。

const fs = require('node:fs');
const path = require('node:path');
const os = require('node:os');
const AdmZip = require('adm-zip');
const { checksum: getChecksum } = require('@tomasklaen/checksum');

// Exact same implementation as Capgo CLI
function zipFileUnix(filePath) {
  const zip = new AdmZip();
  zip.addLocalFolder(filePath);
  return zip.toBuffer();
}

async function zipFileWindows(filePath) {
  console.log('Zipping file windows mode');
  const zip = new AdmZip();

  const addToZip = (folderPath, zipPath) => {
    const items = fs.readdirSync(folderPath);

    for (const item of items) {
      const itemPath = path.join(folderPath, item);
      const stats = fs.statSync(itemPath);

      if (stats.isFile()) {
        const fileContent = fs.readFileSync(itemPath);
        zip.addFile(path.join(zipPath, item).split(path.sep).join('/'), fileContent);
      } else if (stats.isDirectory()) {
        addToZip(itemPath, path.join(zipPath, item));
      }
    }
  };

  addToZip(filePath, '');
  return zip.toBuffer();
}

// Main zipFile function (exact same logic as CLI)
async function zipFile(filePath) {
  if (os.platform() === 'win32') {
    return zipFileWindows(filePath);
  } else {
    return zipFileUnix(filePath);
  }
}

async function createBundle(inputPath, outputPath, version) {
  // Create zip using exact same method as Capgo CLI
  const zipped = await zipFile(inputPath);

  // Write to file
  fs.writeFileSync(outputPath, zipped);

  // Calculate checksum using exact same package as CLI
  const checksum = await getChecksum(zipped, 'sha256');

  return {
    filename: path.basename(outputPath),
    version: version,
    size: zipped.length,
    checksum: checksum
  };
}

// Usage
async function main() {
  try {
    const result = await createBundle('./dist', './my-app-1.2.3.zip', '1.2.3');
    console.log('Bundle info:', JSON.stringify(result, null, 2));
  } catch (error) {
    console.error('Error creating bundle:', error);
  }
}

main();

ステップ 3: CLIと同じパッケージを使用して SHA256 チェックサムを計算する

const fs = require('node:fs');
const { checksum: getChecksum } = require('@tomasklaen/checksum');

async function calculateChecksum(filePath) {
  const fileBuffer = fs.readFileSync(filePath);
  // Use exact same package and method as Capgo CLI
  const checksum = await getChecksum(fileBuffer, 'sha256');
  return checksum;
}

// Usage
async function main() {
  const checksum = await calculateChecksum('./my-app-1.2.3.zip');
  console.log('Checksum:', checksum);
}

main();

ステップ 4: バンドルを自分のストレージにアップロードする

任意のウェブアクセス可能なストレージにzipファイルをアップロードしてください：

# Example: Upload to your server via scp
scp my-app-1.2.3.zip user@your-server.com:/var/www/bundles/

# Example: Upload to S3 using AWS CLI
aws s3 cp my-app-1.2.3.zip s3://your-bucket/bundles/

# Example: Upload via curl to a custom endpoint
curl -X POST https://your-storage-api.com/upload \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -F "file=@my-app-1.2.3.zip"

重要: __CAPGO_KEEP_0__のバンドルは パブリックにアクセス可能 via HTTPS URL (no authentication required). Capgo’s servers need to download the bundle from this URL.

このURLから__CAPGO_KEEP_0__のサーバーがバンドルをダウンロードする必要があります。

https://your-storage.com/bundles/my-app-1.2.3.zip
https://github.com/username/repo/releases/download/v1.2.3/bundle.zip
https://cdn.jsdelivr.net/gh/username/repo@v1.2.3/dist.zip

Step 5: Register Bundle with Capgo API

ステップ 5: Capgo APIにバンドルを登録する

async function registerWithCapgo(appId, version, bundleUrl, checksum, apiKey) {
  const fetch = require('node-fetch');

  // Create bundle (version)
  const response = await fetch('https://api.capgo.app/bundle/', {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      'authorization': apiKey
    },
    body: JSON.stringify({
      app_id: appId,
      version: version,
      external_url: bundleUrl,
      checksum: checksum
    })
  });

  if (!response.ok) {
    throw new Error(`Failed to create bundle: ${response.statusText}`);
  }

  const data = await response.json();
  console.log('Bundle created:', data);

  return data;
}

API パラメータ

パラメータ	説明	必須
`app_id`	アプリケーション識別子	Yes
`version`	バンドル（バージョン）セマンティックバージョン (例：「1.2.3」)	Yes
`external_url`	公開アクセス可能 HTTPS URL から bundle をダウンロードできます (認証不要)	はい
`checksum`	zip ファイルの SHA256 チェックサム	はい

Bundle Structure Requirements

bundle zip は次の要件に従う必要があります:

Root Index File: 必須 index.html root レベルに
Capacitor Integration: 必ず呼び出す notifyAppReady() あなたのアプリ内で code
アセットパス：すべてのアセットのために相対パスを使用

有効なバンドル構造

bundle.zip
├── index.html
├── assets/
│   ├── app.js
│   └── styles.css
└── images/

完全なマニュアルワークフロー例

シンプルなNode.jsスクリプトで、Capgo:にzip、チェックサム、アップロード

const fs = require('node:fs');
const os = require('node:os');
const AdmZip = require('adm-zip');
const { checksum: getChecksum } = require('@tomasklaen/checksum');
const fetch = require('node-fetch');

async function deployToCapgo() {
  const APP_ID = 'com.example.app';
  const VERSION = '1.2.3';
  const BUNDLE_URL = 'https://your-storage.com/bundles/app-1.2.3.zip';
  const API_KEY = process.env.CAPGO_API_KEY;

  // 1. Create zip (same as Capgo CLI)
  const zip = new AdmZip();
  zip.addLocalFolder('./dist');
  const zipped = zip.toBuffer();

  // 2. Calculate checksum (same as Capgo CLI)
  const checksum = await getChecksum(zipped, 'sha256');
  console.log('Checksum:', checksum);

  // 3. Upload to your storage (replace with your upload logic)
  // fs.writeFileSync('./bundle.zip', zipped);
  // ... upload bundle.zip to your storage ...

  // 4. Register with Capgo API
  const response = await fetch('https://api.capgo.app/bundle/', {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      'authorization': API_KEY
    },
    body: JSON.stringify({
      app_id: APP_ID,
      version: VERSION,
      external_url: BUNDLE_URL,
      checksum: checksum
    })
  });

  if (!response.ok) {
    throw new Error(`Failed: ${response.statusText}`);
  }

  console.log('Bundle registered with Capgo!');
}

deployToCapgo().catch(console.error);

依存関係をインストール:

npm install adm-zip @tomasklaen/checksum node-fetch

チェックサム検証

JavaScriptチェックサム計算（Capgo CLIと同じ）

Capgo CLIが内部で使用する同じパッケージとメソッドを使用してください：

const fs = require('node:fs');
const { checksum: getChecksum } = require('@tomasklaen/checksum');

async function calculateChecksum(filePath) {
  const fileBuffer = fs.readFileSync(filePath);
  // Use exact same package and method as Capgo CLI
  const checksum = await getChecksum(fileBuffer, 'sha256');
  return checksum;
}

// Verify checksum matches
async function verifyChecksum(filePath, expectedChecksum) {
  const actualChecksum = await calculateChecksum(filePath);
  const isValid = actualChecksum === expectedChecksum;

  console.log(`File: ${filePath}`);
  console.log(`Expected: ${expectedChecksum}`);
  console.log(`Actual:   ${actualChecksum}`);
  console.log(`Valid:    ${isValid}`);

  return isValid;
}

// Usage
async function main() {
  const bundleChecksum = await calculateChecksum('./my-app-1.2.3.zip');
  console.log('SHA256 Checksum:', bundleChecksum);
}

main();

チェックサムの重要性

バンドルインテグリティバンドルが転送中に破損していないことを確認する：
API検証: Capgo はチェックサムを検証することでバンドルを受け入れる
プラグイン検証: モバイルプラグインはチェックサムを検証することでアップデートを適用する

ベストプラクティス

バンドル (バージョン) 管理: 使うシームレスバージョニング一貫して
ストレージオプティミゼーション: 使わないバンドルを定期的に削除する
バンドル (バージョン) 相容性: __CAPGO_KEEP_0__を適切に最小限のネイティブバージョン要件に設定する
: 重要なバンドル(バージョン)のバックアップ戦略: 重要なバンドル(バージョン)のバックアップを維持する

: エンドポイント

: GET

https://api.capgo.app/bundle/

: バンドル情報を取得する。1ページあたり50個のバンドルを返します。

: クエリパラメータ

app_id: 必須。アプリのID
page: オプション。ページネーション用のページ番号

__CAPGO_KEEP_0__

interface Bundle {
  app_id: string
  bucket_id: string | null
  checksum: string | null
  created_at: string | null
  deleted: boolean
  external_url: string | null
  id: number
  minUpdateVersion: string | null
  name: string
  native_packages: Json[] | null
  owner_org: string
  r2_path: string | null
  session_key: string | null
  storage_provider: string
  updated_at: string | null
  user_id: string | null
}

__CAPGO_KEEP_3__

# Get all bundles
curl -H "authorization: your-api-key" \
  "https://api.capgo.app/bundle/?app_id=app_123"

# Get next page
curl -H "authorization: your-api-key" \
  "https://api.capgo.app/bundle/?app_id=app_123&page=1"

__CAPGO_KEEP_7__

{
  "data": [
    {
      "id": 1,
      "app_id": "app_123",
      "name": "1.0.0",
      "checksum": "abc123...",
      "minUpdateVersion": "1.0.0",
      "storage_provider": "r2",
      "created_at": "2024-01-01T00:00:00Z",
      "updated_at": "2024-01-01T00:00:00Z",
      "deleted": false,
      "owner_org": "org_123",
      "user_id": "user_123"
    }
  ]
}

__CAPGO_KEEP_10__

https://api.capgo.app/bundle/

__CAPGO_KEEP_0__を1つまたはすべてのアプリケーションに削除します。使用に際しては注意が必要です。このアクションは取り消すことができません。

クエリパラメータ

__CAPGO_KEEP_2__を削除する場合:

interface BundleDelete {
  app_id: string
  version: string
}

__CAPGO_KEEP_4__

interface BundleDeleteAll {
  app_id: string
}

__CAPGO_KEEP_6__

# Delete specific bundle
curl -X DELETE \
  -H "authorization: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "app_id": "app_123",
    "version": "1.0.0"
  }' \
  https://api.capgo.app/bundle/

# Delete all bundles
curl -X DELETE \
  -H "authorization: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "app_id": "app_123"
  }' \
  https://api.capgo.app/bundle/

__CAPGO_KEEP_10__

{
  "status": "ok"
}

POST

https://api.capgo.app/bundle/

外部 URL を含む新しいバンドルを作成します。

リクエストボディ

interface CreateBundleBody {
  app_id: string
  version: string
  external_url: string // Must be publicly accessible HTTPS URL
  checksum: string
}

例のリクエスト

curl -X POST \
  -H "authorization: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "app_id": "com.example.app",
    "version": "1.2.3",
    "external_url": "https://your-storage.com/bundles/app-1.2.3.zip",
    "checksum": "a1b2c3d4e5f6789abcdef123456789abcdef123456789abcdef123456789abcd"
  }' \
  https://api.capgo.app/bundle/

成功応答

{
  "status": "ok"
}

POST (メタデータ)

https://api.capgo.app/bundle/metadata

リンクやコメント情報など、バンドルメタデータを更新します。

リクエストボディ

interface UpdateMetadataBody {
  app_id: string
  version_id: number // bundle (version) id
  link?: string
  comment?: string
}

例のリクエスト

curl -X POST \
  -H "authorization: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "app_id": "app_123",
    "version_id": 456,
    "link": "https://github.com/myorg/myapp/releases/tag/v1.0.0",
    "comment": "Fixed critical bug in authentication"
  }' \
  https://api.capgo.app/bundle/metadata

成功応答

{
  "status": "success"
}

PUT

https://api.capgo.app/bundle/

特定のチャンネルにバンドルを設定します。このリンクはバンドル（バージョン）を特定のチャンネルに分配するために使用されます。

リクエスト本体

interface SetChannelBody {
  app_id: string
  version_id: number // bundle (version) id
  channel_id: number
}

例のリクエスト

curl -X PUT \
  -H "authorization: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "app_id": "app_123",
    "version_id": 456,
    "channel_id": 789
  }' \
  https://api.capgo.app/bundle/

成功応答

{
  "status": "success",
  "message": "Bundle 1.0.0 set to channel production"
}

エラーハンドリング

一般的なエラーシナリオとその応答:

// Bundle not found
{
  "error": "Bundle not found",
  "status": "KO"
}

// Invalid bundle (version) format
{
  "error": "Invalid version format",
  "status": "KO"
}

// Storage error
{
  "error": "Failed to delete bundle from storage",
  "status": "KO"
}

// Permission denied
{
  "error": "Insufficient permissions to manage bundles",
  "status": "KO"
}

一般的な使用例

古いバンドル(バージョン)のクリーンアップ

// Delete outdated beta bundles (versions)
{
  "app_id": "app_123",
  "version": "1.0.0-beta.1"
}

アプリケーションリセット

// Remove all bundles to start fresh
{
  "app_id": "app_123"
}

ストレージの考慮事項

保持ポリシー:古いバンドルの保持期間を定義する
サイズ管理:バンドルのサイズとストレージ使用量を監視する
バックアップ戦略:重要なバンドル (バージョン) をバックアップすることを検討する
コスト最適化: 不要のバンドルを削除してストレージコストを最適化する

Keep going from Bundles

Capgoを使用している場合 Bundles ストレージとファイルの管理を計画するために、@__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-data-storage-sqlite @capgo/capacitor-data-storage-sqliteの実装詳細については@capgo/capacitor-data-storage-sqlite @capgo/capacitor-data-storage-sqliteを使用して @capgo/capacitor-data-storage-sqliteのネイティブ機能を使用して @capgo/capacitor-file @capgo/capacitor-fileの実装詳細については@capgo/capacitor-file, for the implementation detail in @capgo/capacitor-file, @capgo/capacitorファイルを使用 Capacitorのネイティブ機能のために@capgo/capacitorファイルを使用し、 @capgo/capacitorアップローダー Capacitorの実装詳細のために@capgo/capacitorアップローダーを使用します。

バンドル

バンドルの理解

手動バンドル作成 (Without CLI)

ステップ 1: アプリをビルドする

ステップ 2: Capgo CLI が内部で使用する同等のパッケージを使用してバンドル ZIP を作成する

必要なパッケージをインストールする

JavaScriptでZipバンドルを作成（CapgoとCLIと同じ）

ステップ 3: CLIと同じパッケージを使用して SHA256 チェックサムを計算する

ステップ 4: バンドルを自分のストレージにアップロードする

Step 5: Register Bundle with Capgo API

API パラメータ

Bundle Structure Requirements

有効なバンドル構造

完全なマニュアルワークフロー例

チェックサム検証

JavaScriptチェックサム計算（Capgo CLIと同じ）

チェックサムの重要性

ベスト プラクティス

: エンドポイント

: GET

: クエリパラメータ

__CAPGO_KEEP_0__

__CAPGO_KEEP_3__

__CAPGO_KEEP_7__

__CAPGO_KEEP_10__

クエリパラメータ

__CAPGO_KEEP_6__

__CAPGO_KEEP_10__

POST

リクエスト ボディ

例のリクエスト

成功応答

POST (メタデータ)

リクエストボディ

例のリクエスト

成功応答

PUT

リクエスト本体

例のリクエスト

成功応答

エラーハンドリング

一般的な使用例

ストレージの考慮事項

Keep going from Bundles

ベストプラクティス

リクエストボディ