Bundles

Bundles sind die zentralen Update-Pakete in Capgo. Jeder Bundle enthält die Web-Assets (HTML, CSS, JS), die den Inhalt deiner App ausmachen. Die Bundles API ermöglicht es dir, diese Update-Pakete zu verwalten, einschließlich Auflisten und Löschen.

Bundles verstehen

Ein Bundle stellt eine bestimmte Version des Web-Contents deiner App dar und enthält:

• Bundle (Version): Semantische Versionsnummer für das Bundle
• Checksumme: Eindeutiger Hash zur Überprüfung der Bundle-Integrität
• Speicherinfo: Details dazu, wo und wie das Bundle gespeichert wird
• Native Anforderungen: Erforderliche Mindestversion der nativen App
• Metadaten: Erstellungszeitpunkt, Eigentümer und weitere Tracking-Infos

Manuelle Bundle-Erstellung (ohne CLI)

So erstellst und lädst du Bundles manuell hoch, ohne Capgo CLI zu verwenden:

Schritt 1: App bauen

Baue zuerst die Web-Assets deiner App:

npm run build

Schritt 2: Bundle-Zip mit denselben Paketen wie Capgo CLI erstellen

Wichtig: Verwende exakt dieselben JavaScript-Pakete, die Capgo CLI intern nutzt, um die Kompatibilität sicherzustellen.

Erforderliche Pakete installieren

npm install adm-zip @tomasklaen/checksum

Zip-Bundle mit JavaScript erstellen (wie Capgo CLI)

Hinweis: In den folgenden Beispielen version bezieht sich auf den Bundle-Namen (Version), der von API verwendet wird.

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();

Schritt 3: SHA256-Checksumme mit demselben Package wie CLI berechnen

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();

Schritt 4: Bundle in deinen Storage hochladen

Lade deine Zip-Datei in einen beliebigen web-erreichbaren Storage hoch:

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

Wichtig: Ihr Bundle muss öffentlich zugänglich über eine HTTPS-URL sein (keine Authentifizierung erforderlich). Die Server von Capgo müssen das Bundle von dieser URL herunterladen.

Beispiele für gültige öffentliche URLs:

• 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

Schritt 5: Bundle bei Capgo API registrieren

Registrieren Sie das externe Bundle bei Capgo mit direkten API-Aufrufen:

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 Parameter

Parameter	Beschreibung	Erforderlich
app_id	Ihre App-Kennung	Ja
version	Bundle (Version) semantische Version (z. B. „1.2.3“)	Ja
external_url	Öffentlich zugänglich HTTPS URL where bundle can be downloaded (no auth required)	Ja
checksum	SHA256-Prüfsumme der Zip-Datei	Ja

Anforderungen an die Bundle-Struktur

Ihr Bundle-Zip muss diese Anforderungen erfüllen:

1. Index-Datei in der Wurzel: Pflichtfeld index.html auf der Wurzelebene
2. Capacitor-Integration: Must call notifyAppReady() in Ihrer App code
3. Asset-Pfade: Verwenden Sie relative Pfade für alle Assets

Gültige Bundle-Struktur

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

Vollständiges Beispiel für den manuellen Workflow

Einfaches Node.js-Skript zum Zippen, Erstellen einer Prüfsumme und Hochladen zu Capgo:

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);

Abhängigkeiten installieren:

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

Prüfsummen-Verifizierung

JavaScript-Prüfsummenberechnung (wie bei Capgo CLI)

Verwenden Sie exakt dasselbe Paket und dieselbe Methode, die Capgo CLI intern einsetzt:

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();

Bedeutung der Prüfsumme

• Bundle-Integrität: Stellt sicher, dass das Bundle während der Übertragung nicht beschädigt wurde
• API-Verifizierung: Capgo verifiziert Prüfsummen, bevor Bundles akzeptiert werden
• Plugin-Verifizierung: Das Mobile-Plugin prüft die Checksummen, bevor Updates angewendet werden

Best Practices

1. Bundle- und Versions-Management: Nutze Semantic Versioning konsequent
2. Speicheroptimierung: Ungenutzte Bundles regelmäßig entfernen
3. Bundle- und Versions-Kompatibilität: Passende minimale Native-Versionen festlegen
4. Backup-Strategie: Backups kritischer Bundles (Versionen) pflegen

Endpoints

GET

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

Bundle-Informationen abrufen. Ohne Filter werden 50 Bundles pro Seite zurückgegeben. Mit version oder idwird dasselbe JSON-Array-Format mit null oder einem Bundle zurückgegeben.

Query-Parameter

• app_id: Erforderlich. Die ID deiner App
• page: Optional. Seitennummer für die Paginierung (wird ignoriert, wenn version oder id gesetzt ist)
• version: Optional. Exakter Bundle-Versionsname (app_versions.name, zum Beispiel 1.2.3). Gibt ein JSON-Array mit null oder einem Element zurück.
• id: Optional. Numerische Bundle-ID (app_versions.id). Gibt ein JSON-Array mit null oder einem Element zurück.

Verwenden Sie denselben authorization Header und dasselbe API Key-App-Scoping wie bei der paginierten Liste. Werte, die die Query-Schema-Validierung nicht bestehen, lösen einen invalid_query Fehler aus.

Prüfen, ob eine Version existiert (CI)

Verwenden Sie dies vor dem Upload oder der Channel-Zuweisung, wenn Sie einen HTTP-Check anstelle von CLI benötigen:

curl -H "authorization: YOUR_API_KEY" \
  "https://api.capgo.app/bundle/?app_id=com.example.app&version=1.2.3"

Ein nicht leeres JSON-Array bedeutet, dass diese Version für die App bereits existiert. Ein leeres Array bedeutet, dass sie nicht existiert.

Für Upload-Workflows sorgt das Flag Capgo CLI bundle upload --version-exists-ok bereits für einen erfolgreichen Exit, wenn die Zielversion existiert. Das deckt viele CI-Jobs ab, ohne diesen Endpoint aufrufen zu müssen.

Response-Typ

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
}

Beispiel-Request

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

# Look up one bundle by version name
curl -H "authorization: your-api-key" \
  "https://api.capgo.app/bundle/?app_id=app_123&version=1.0.0"

# Look up one bundle by id
curl -H "authorization: your-api-key" \
  "https://api.capgo.app/bundle/?app_id=app_123&id=456"

Beispielantwort

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

LÖSCHEN

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

Löscht ein oder alle Bundles einer App. Mit Vorsicht verwenden, da diese Aktion nicht rückgängig gemacht werden kann.

Query-Parameter

Zum Löschen eines bestimmten Bundles:

interface BundleDelete {
  app_id: string
  version: string
}

Zum Löschen aller Bundles:

interface BundleDeleteAll {
  app_id: string
}

Beispiel-Requests

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

Erfolgreiche Antwort

{
  "status": "ok"
}

POST

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

Neues Bundle mit externer URL erstellen.

Request-Body

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

Beispiel-Request

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/

Erfolgreiche Antwort

{
  "status": "ok"
}

POST (Metadaten)

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

Bundle-Metadaten wie Link- und Kommentarinformationen aktualisieren.

Request-Body

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

Beispiel-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

Erfolgreiche Antwort

{
  "status": "success"
}

PUT

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

Einem bestimmten Channel ein Bundle zuweisen. Dies verknüpft ein Bundle (Version) mit einem Channel für die Auslieferung.

Request-Body

interface SetChannelBody {
  app_id: string
  version_id: number // bundle (version) id
  channel_id: number
  target?: "auto" | "stable" | "rollout" // default: auto
}

target Steuert, wo das Bundle verknüpft wird, wenn für den Channel ein progressives Rollout konfiguriert ist:

• auto — Rollout-Ziel, wenn ein progressives Rollout konfiguriert ist; andernfalls stable (Standard).
• rollout — Setzt immer das Rollout-Ziel; das stable Fallback bleibt unverändert.
• stable — Ersetzt das stable Fallback (Escape Hatch).

Beispiel-Request

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/

Erfolgreiche Antwort

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

Fehlerbehandlung

Alle Fehler verwenden das Standardfehlerformat, das in der API Übersicht.

Häufige Fehlerszenarien und deren Antworten:

// app_id is not a reverse-domain identifier
{
  "error": "invalid_app_id",
  "message": "App ID must be a reverse domain string",
  "moreInfo": { "app_id": "my app" }
}

// Deleting a bundle without access to the app
{
  "error": "cannot_delete_bundle",
  "message": "You can't access this app",
  "moreInfo": { "app_id": "com.example.app" }
}

// Deleting a bundle that a channel still uses
{
  "error": "cannot_delete_linked_version",
  "message": "Cannot delete a bundle linked to a channel",
  "moreInfo": { "app_id": "com.example.app", "version": "1.0.0" }
}

// Creating a bundle whose version is not valid semver
{
  "error": "invalid_version_format",
  "message": "Version must be valid semver format (e.g., 1.0.0, 1.0.0-alpha.1)",
  "moreInfo": { "version": "v1" }
}

// Setting a channel to a bundle that does not exist
{
  "error": "cannot_find_version",
  "message": "Cannot find version",
  "moreInfo": {}
}

Häufige Anwendungsfälle

1. Alte Bundles (Versionen) bereinigen

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

2. App-Reset

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

Hinweise zum Speicher

1. Aufbewahrungsrichtlinie: Aufbewahrungsdauer alter Bundles festlegen
2. Größenverwaltung: Bundle-Größen und Speichernutzung überwachen
3. Backup-Strategie: Backup kritischer Bundles (Versionen) erwägen
4. Kostenoptimierung: Unnötige Bundles entfernen, um Speicherkosten zu optimieren

Weiter mit Bundles

Wenn du es nutzt Bundles um Speicher- und Dateiverwaltung zu planen, verbinde es mit @capgo/capacitor-data-storage-sqlite für die Implementierungsdetails in @capgo/capacitor-data-storage-sqlite, Mit @capgo/capacitor-data-storage-sqlite für die native Funktionalität in „@capgo/capacitor-data-storage-sqlite verwenden“, @capgo/capacitor-file für das Implementierungsdetail in @capgo/capacitor-file, @capgo/capacitor-file verwenden für die native Funktion in „@capgo/capacitor-file verwenden“ und @capgo/capacitor-uploader für das Implementierungsdetail in @capgo/capacitor-uploader.