JavaScript / TypeScript SDK
JavaScript SDK는 Node.js 환경(서버·CLI·Electron·CI)에서 Deplite API를 사용하거나, 내 앱을 Agent로 실행할 때 사용할 수 있어요.
SDK 버전은 0.1.0이에요.
설치
설치 경로 정리 중이에요.
공개 설치 경로가 확정되면 안내할게요.
Node.js 20+ 환경에서 사용할 수 있어요.
어떤 모드로 시작할까
| 모드 | 언제 쓰나 | 시작 |
|---|---|---|
| External | 내 앱·서버·CI가 Deplite를 호출 | API 토큰 발급 → new Deplite({ apiToken }) |
| Embedded | 내 앱이 Deplite의 작업 노드 | 1회용 설치 코드 → Deplite.enroll(...) |
두 모드의 자세한 비교는 인증 모드를 참고해주세요.
External — Deplite 호출하기
JavaScript SDK에는 아직 이름 기반 실행 메소드가 없어요.
현재는 REST POST /v1/run/{agentName}/{workflowName}을 직접 호출해주세요.
요청 예시는 워크플로우 실행에서 확인할 수 있어요.
파일 API는 SDK에서 사용할 수 있어요.
import { Deplite } from '@deplite/sdk'
const deplite = new Deplite({ apiToken: process.env.DEPLITE_API_TOKEN! })
const file = await deplite.files.upload({
file: { path: './build/app.apk' },
})토큰은 발급 직후 1회만 노출되므로 별도로 안전하게 보관해주세요.
Embedded — 내 앱이 작업 노드 되기
대시보드에서 1회용 설치 코드를 발급한 뒤, 첫 실행에서 enroll하고 결과를 안전하게 보관해주세요.
이후 실행에서는 저장한 자격으로 Agent를 시작할 수 있어요.
import { Deplite, DepliteAgent } from '@deplite/sdk'
const enrollment = await Deplite.enroll({
installCode: process.env.INSTALL_CODE!,
name: 'kiosk-seoul-01',
})
await secureStore.save(enrollment)
const stored = await secureStore.load()
const agent = new DepliteAgent({
identity: stored.identity,
privateKey: stored.privateKey,
})
for await (const event of agent.events()) {
if (event.type === 'deploy') {
await runJob(event.payload)
await agent.jobs.reportResult({
jobId: event.payload.jobId,
result: { status: 'success', exitCode: 0 },
})
}
}enroll()이 반환하는 privateKey는 SDK가 저장하지 않으므로 암호화해 보관해주세요.
분실하면 다시 등록해야 해요.
관련 문서
최종 수정 일자: