バンドル

このプラグインのセットアッププロンプトをコピーして、インストール手順とフルマークダウンガイドを含む。

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

バンドルを理解する

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

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

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

Capgo CLIを使用せずに、手動でバンドルを作成してアップロードする方法についてはこちらです。

Step 1: アプリをビルドする

まず、アプリのウェブアセットをビルドしてください。

npm run build

Step 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：バンドルを自分のストレージにアップロードする

__CAPGO_KEEP_0__の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__のバンドルは、 HTTPS URL（認証なし）を介して publicにアクセス可能でなければなりません。Capgoのサーバーは、このURLからバンドルをダウンロードする必要があります。

バンドルのpublicなURLの例:

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

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

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`	アプリケーション識別子	はい
`version`	バンドル (バージョン) シーケンスバージョン (例： “1.2.3”)	はい
`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__を適切に最小限のネイティブバージョン要件に設定する
バックアップ戦略: __CAPGO_KEEP_0__の重要なバンドル(バージョン)のバックアップを維持する

エンドポイント

GET

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

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

クエリパラメータ

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

レスポンスタイプ

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
}

例のリクエスト

# 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"

例のレスポンス

{
  "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"
    }
  ]
}

削除

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

__CAPGO_KEEP_0__を1つまたはすべてのアプリケーションに削除します。使用に際しては、元に戻すことができないこのアクションに注意してください。

クエリパラメータ

特定の__CAPGO_KEEP_0__を削除する場合:

interface BundleDelete {
  app_id: string
  version: string
}

特定の__CAPGO_KEEP_0__を削除する場合:

interface BundleDeleteAll {
  app_id: string
}

削除の例

# 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/

削除の成功応答

{
  "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/

Success Response

{
  "status": "ok"
}

POST (Metadata)

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

linkとcomment情報の更新

Request Body

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

Example Request

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"
}

ストレージの考慮事項

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

続けてバンドル

あなたが「バンドル」を使用している場合 バンドル ストレージとファイルの管理を計画するために「バンドル」を接続する @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ファイルを使用 Capgoのネイティブ機能のために@capgo/capacitorファイルを使用し @capgo/capacitor アップローダー Capgoの実装詳細のために@capgo/capacitor アップローダーを使用し

バンドル

バンドルを理解する

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

Step 1: アプリをビルドする

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

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

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

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

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

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

API パラメータ

Bundle Structure Requirements

有効なバンドル構造

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

チェックサム検証

JavaScript チェックサム計算 (同様に Capgo CLI )

チェックサムの重要性

ベスト プラクティス

エンドポイント

GET

クエリパラメータ

レスポンスタイプ

例のリクエスト

例のレスポンス

削除

クエリ パラメータ

削除の例

削除の成功応答

POST

リクエストボディ

例のリクエスト

Success Response

POST (Metadata)

Request Body

Example Request

成功応答

PUT

リクエスト本体

例のリクエスト

成功応答

エラー処理

一般的な使用例

ストレージの考慮事項

続けてバンドル

ベストプラクティス

クエリパラメータ