번들

이 플러그인의 설치 단계와 전체 마크다운 가이드를 포함한 설정 지시를 복사하세요.

Capgo의 각 번들에는 웹 자산 (HTML, CSS, JS) 이 포함되어 있습니다. 이 자산은 앱의 콘텐츠를 구성합니다. 번들 관리를 위한 Bundles API를 사용하여 업데이트 패키지를 관리할 수 있습니다. 이에는 목록 및 삭제가 포함됩니다.

번들을 이해하는 방법

번들은 앱의 웹 콘텐츠의 특정 버전을 나타내며 다음을 포함합니다:

번들 (버전): 번들의 세미콜론 버전 번호
: 번들의 체크섬: 번들의 체크섬을 확인하기 위한 고유한 해시
저장 정보: __CAPGO_KEEP_0__에 대한 세부 정보
네이티브 요구 사항: 최소 네이티브 앱 버전 요구 사항
메타 데이터: 생성 시간, 소유권 및 기타 추적 정보

수동 번들 생성 (Without CLI)

수동으로 번들을 생성하고 업로드하는 방법입니다. Capgo 없이 CLI을 사용하지 않고

Step 1: 앱 빌드

먼저 웹 자산을 빌드하세요:

npm run build

2 단계: Capgo CLI과 동일한 패키지를 사용하여 번들 ZIP 만들기

중요: Capgo CLI 내부에서 사용하는 정확한 자바스크립트 패키지를 사용하여 호환성을 보장하세요.

필수 패키지 설치

npm install adm-zip @tomasklaen/checksum

자바스크립트와 동일한 Capgo CLI을 사용하여 ZIP 번들 만들기

주의: 아래 예시에서 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__를 빌드해야 합니다. 공개적으로 접근할 수 있는 HTTPS URL (인증이 필요하지 않습니다.) 이 URL에서 Capgo의 서버가 번들을 다운로드해야 합니다.

예시: 공개 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 매개변수

매개변수	설명	__CAPGO_KEEP_0__
`app_id`	앱 식별자	네
`version`	버nd르 (버전) 의미론적 버전 (예: "1.2.3")	네
`external_url`	공개적으로 접근 가능 HTTPS URL에서 버nd르 다운로드할 수 있는 URL (인증 필요 없음)	네
`checksum`	zip 파일의 SHA256 체크섬	네

버nd르 구조 요구 사항

Your bundle zip must follow these requirements:

Root Index File: Must have index.html at the root level
Capacitor Integration: Must call notifyAppReady() in your app code
Asset Paths: Use relative paths for all assets

Bundle Structure

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

완전한 수동 워크플로 예시

Capgo으로 zip, 체크섬, 업로드하는 간단한 Node.js 스크립트

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

체크섬 검증

Capgo CLI이 내부적으로 사용하는 정확한 패키지와 방법을 사용하십시오: Capgo CLI

Use the exact same package and method that Capgo CLI uses internally:

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/

번들을 50개씩 반환합니다.

Query Parameters

app_id: 필요. 앱 ID
page: 선택. 페이징을 위한 페이지 번호

Response Type

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

DELETE

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

앱의 모든 또는 특정 배포본을 삭제합니다. 주의: 이 작업은 취소할 수 없습니다.

쿼리 매개변수

특정 배포본 삭제를 위한: __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/

성공 응답

{
  "status": "ok"
}

POST (메타데이터)

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

링크 및 댓글 정보와 같은 번들 메타데이터 업데이트

요청 본문

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

__CAPGO_KEEP_1__

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

__CAPGO_KEEP_4__

{
  "status": "success"
}

__CAPGO_KEEP_5__

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

__CAPGO_KEEP_7__

__CAPGO_KEEP_8__

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

저장소 고려 사항

보존 정책: 오래된 번들을 얼마나 유지할 것인지 정의합니다.
크기 관리: 저장 용량과 스토리지 사용량을 모니터링하세요
백업 전략: 중요한 버전의 백업을 고려하세요
비용 최적화: 저장 비용을 최적화하기 위해 불필요한 버전을 삭제하세요