CLI dan deployment konfigurasi
Artefak CLI/config versi 0.3.1 yang dipublikasikan menerapkan kontrak konfigurasi/backend 0.3.0 dan menolak kunci yang tidak dikenal baik secara lokal maupun di backend.
CLI membuat, memvalidasi, melakukan deployment, mempromosikan, dan melakukan rollback versi konfigurasi ChattyBox yang immutable. Setiap token deployment dibatasi untuk tepat satu project yang sudah ada dan environment yang dipilih. Perlakukan satu file konfigurasi dan satu token khusus project sebagai satu project ChattyBox yang dikelola.
Status Rilis dan Runtime
Registry publik menyediakan paket CLI dan config yang dipublikasikan @openstaticfish/chattybox-cli@0.3.1 dan @openstaticfish/chattybox-config@0.3.1; keduanya menerapkan kontrak konfigurasi/backend 0.3.0 dan menolak kunci yang tidak dikenal secara lokal maupun di backend. SDK JavaScript @openstaticfish/chattybox@0.1.4 adalah paket terpisah, bukan bagian dari kontrak config. Versi paket dan schemaVersion: "1" adalah sistem versi yang berbeda. status menampilkan versi environment, sedangkan runtimeConfigVersionId adalah konfigurasi terakhir yang diterapkan ke runtime bersama dan dapat berbeda. mode yang dihilangkan memilih crawl tanpa mengubah maxDepth: 0 yang eksplisit. CLI adalah program ESM Node.js 20+; bunx mengikuti shebang Node secara default, atau pilih Bun secara eksplisit dengan bunx --bun @openstaticfish/chattybox-cli ....
Konfigurasi awal dan perintah dasar di bawah tersedia dalam CLI yang dipublikasikan. Validator paket juga mencakup project, penemuan dan penjadwalan, kontrol locale yang diperluas, widget.icon, dan widget.showBranding. CLI bukan alat browser. CI konsumen paket yang dipublikasikan mencakup Node 20, 22, dan 24 di Linux, bukan matriks kompatibilitas semua OS atau browser. Pin versi paket yang telah diuji untuk otomatisasi production; contoh tanpa versi memakai paket yang terinstal, di-cache, atau dari registry, bukan kode sumber repositori ini.
Cakupan konfigurasi sebagai kode
Konfigurasi mengatur nama dan deskripsi project, persona dan fallback asisten, penemuan dan refresh situs, locale, serta tampilan widget ter-host. Deployment preview atau production menerapkan nilai tersebut dan mengantrekan refresh corpus di tempat. Dengan Config-as-code lock, pengaturan yang dikelola konfigurasi diubah melalui deployment berversi, kecuali preferensi branding yang tunduk pada hak paket.
Project awal tetap dibuat sekali melalui dashboard. Kunci widget publik dan pembatasan origin opsional, siklus hidup token deployment, analitik, percakapan, kesenjangan konten, tindakan destruktif, dan file ikon yang diunggah bukan field konfigurasi. Gunakan URL atau emoji untuk ikon kustom deklaratif. Konfigurasi tidak berisi ID project: token deployment rahasia menentukan project penerima.
Kunci widget publik untuk chat dan konfigurasi widget boleh digunakan dalam kode browser. Kunci tanpa pembatasan bekerja lintas origin, sedangkan kunci yang disiapkan untuk situs dapat sudah dibatasi. Pembatasan origin yang tepat adalah perlindungan tambahan opsional, bukan autentikasi pengunjung. Sebaliknya, token deployment untuk deploy/promote/rollback/status bersifat rahasia dan hanya disimpan secara lokal atau di secret CI.
Membuat konfigurasi
bunx @openstaticfish/chattybox-cli init
Perintah ini membuat chattybox.config.json:
{
"schemaVersion": "1",
"assistant": {
"name": "Support"
},
"knowledge": {
"sources": [
{
"type": "website",
"url": "https://example.com"
}
]
},
"widget": {
"enabled": true
}
}
Gunakan path khusus jika konfigurasi berada dalam subdirektori:
bunx @openstaticfish/chattybox-cli init config/chattybox.config.json
Memvalidasi secara lokal atau di CI
bunx @openstaticfish/chattybox-cli validate
bunx @openstaticfish/chattybox-cli validate config/chattybox.config.json
Validasi lokal dan validasi backend menggunakan aturan konfigurasi yang sama serta menolak field yang tidak dikenal di setiap tingkat objek. Validasi hanya membaca JSON; tidak memuat TypeScript, JSONC, YAML, atau skema remote, tidak melakukan request jaringan, memeriksa token maupun entitlement plan, atau menerapkan default. knowledge boleh dihilangkan saat validasi lokal atau di environment development, tetapi jika disertakan harus berisi tepat satu sumber situs web. preview dan production mewajibkan sumber tersebut. Jika widget disertakan, widget.enabled wajib ada. Validasi lokal yang berhasil tidak menjamin deployment.
Membuat token deployment
Buka Pengaturan chatbot → Konfigurasi pengembang dan buat token untuk environment yang dapat diubah oleh alur kerja Anda. Segera salin seluruh nilai token dalam teks biasa; ChattyBox menyimpan hash dan metadata identifikasi serta siklus hidup yang terbatas, tetapi tidak dapat menampilkan nilai lengkapnya lagi.
Formulir secara default hanya memilih development dan tidak menetapkan masa kedaluwarsa. Pilih preview atau production secara eksplisit bila diperlukan.
Dasbor menawarkan pilihan tanpa kedaluwarsa atau 7, 30, 90, atau 365 hari. API pembuatan terautentikasi menerima bilangan bulat dari 1 hingga 365 hari; jika jumlah hari dihilangkan, token tidak kedaluwarsa. Satu project dapat memiliki paling banyak 20 token aktif yang belum kedaluwarsa. Untuk merotasi token, buat token pengganti, perbarui CI, lalu cabut token lama. CLI tidak menyediakan perintah login, pembuatan token, daftar token, atau pencabutan token.
Atur token dan URL API widget. Di Pasang → Instalasi situs web, gunakan nilai data-api-url dari snippet jika tersedia; jika tidak, gunakan URL deployment HTTP actions dari konfigurasi deployment Anda. Alur instalasi mungkin mengharuskan setup diselesaikan terlebih dahulu:
export CHATTYBOX_DEPLOY_TOKEN='cb_cfg_v1_...'
export CHATTYBOX_API_URL='https://your-deployment.convex.site/chat'
Jangan pernah commit token atau menyertakannya dalam kode browser. Simpan token di secret store terenkripsi milik penyedia CI Anda. Token deployment diautentikasi dengan Authorization: Bearer ...; kunci widget publik tidak dapat menggantikannya. Route manajemen tidak menggunakan pembatasan origin widget, tidak memerlukan header Origin, dan tidak menyediakan akses CORS browser. Token ini tidak terikat pada origin: siapa pun yang memilikinya dapat memanggil API dari server.
Gunakan URL root deployment HTTP actions atau URL widget yang berakhiran /chat, bukan URL klien .convex.cloud atau endpoint /v1/config/deployments lengkap. CLI menghapus garis miring penutup dan /chat terakhir sebelum menambahkan route manajemen. HTTPS wajib digunakan kecuali untuk localhost, 127.0.0.1, atau [::1]; kredensial, query string, dan fragment pada URL API ditolak. Verifikasi tujuan sebelum memberikan secret.
Token yang tidak ada, salah format, kedaluwarsa, dicabut, tidak berlaku untuk environment, atau tidak valid karena alasan lain menghasilkan HTTP 401 INVALID_TOKEN. Token juga berhenti berfungsi jika project atau pemiliknya hilang atau sedang dihapus.
Setelah memverifikasi alur deployment, Anda dapat mengaktifkan Config-as-code lock di bagian pengaturan yang sama. Lock ini tidak dapat dibatalkan melalui dashboard, CLI, atau API publik saat ini; tidak ada operasi unlock yang didukung. Mengaktifkannya tidak membuat token atau men-deploy versi. Uji alur token terlebih dahulu.
Lock memblokir penulisan dashboard pada pengaturan proyek/widget yang dikelola config, unggahan ikon, dan operasi corpus manual seperti scraping, menghapus halaman, membersihkan konten, serta membangun ulang embedding. Pekerjaan terjadwal dan penghapusan proyek tetap berjalan. Pembuatan/pencabutan token, pengelolaan kunci publik, dan pembacaan operasional tetap tersedia. Branding adalah pengecualian: kontrol branding dashboard tetap dapat diubah pada project terkunci sesuai entitlement plan. Menyembunyikan atribusi memerlukan Starter atau lebih tinggi; jika widget.showBranding dihilangkan, preferensi saat ini dipertahankan (atau menjadi true jika belum ada), dan runtime paket Free tetap menampilkan branding.
Deploy konfigurasi
Deployment membuat versi immutable dan mempromosikannya ke environment yang dipilih:
bunx @openstaticfish/chattybox-cli deploy --environment preview
bunx @openstaticfish/chattybox-cli deploy --environment production
development hanya mencatat versi/pointer (applied: false, indexingStatus: "not_required"). preview dan production menimpa pengaturan runtime project yang sama dan memakai corpus serta kunci widget publik yang sama; promosi runtime terbaru yang berlaku, sekalipun pointer environment lain masih menunjuk ke versi lama. Token dengan scope preview karena itu dapat mengubah project yang melayani traffic production. Gunakan project, token, dan kunci terpisah untuk isolasi yang sebenarnya. Keduanya menerapkan konfigurasi secara atomik dan mengantrekan job scraping (applied: true, indexingStatus: "pending"), tetapi tidak menunggu scraping atau embedding selesai. Corpus bukan snapshot berversi dan refresh yang gagal tidak membatalkan konfigurasi yang telah diterapkan.
Refresh memperbarui halaman di tempat dan meminta embedding jika konten berubah; URL lama tidak otomatis dihapus hanya karena sumber atau filter baru tidak menyertakannya. Pembaruan parsial dapat tertinggal jika pekerjaan gagal. Job mencatat ID versi konfigurasi tetapi juga membaca pengaturan scraping yang dapat berubah; hindari deployment yang saling tumpang tindih jika konsistensi indeks penting.
Deploy konfigurasi lengkap yang diinginkan, bukan patch. Promosi runtime dapat menghapus atau mereset nilai config-owned yang dihilangkan. Jika objek widget dihilangkan, widget akan diaktifkan. Jika objek widget disertakan, nilai enabled yang wajib di dalamnya tetap berlaku; override teks, tema, dan posisi widget yang dihilangkan dihapus secara terpisah agar default runtime digunakan. Saat dipromosikan ke runtime, file ikon yang sebelumnya diunggah akan dihapus, baik konfigurasi menyertakan ikon pengganti deklaratif maupun tidak. Ikon default hanya dipilih jika widget.icon dihilangkan; ikon default tidak dipilih pada setiap promosi. Refresh otomatis daily dan showBranding: false memerlukan Starter atau lebih tinggi; entitlement diperiksa saat promosi preview/production, termasuk rollback, bukan saat validasi lokal atau pencatatan development.
Jika dihilangkan, deskripsi project dan override prompt/profil/fallback asisten dibersihkan; runtime kembali ke locale otomatis, default en, dan override locale yang diizinkan. Mode sumber default adalah crawl, filter yang dihilangkan dibersihkan, dan refresh otomatis default-nya nonaktif. Pengaturan khusus mode hanya diterapkan pada mode yang cocok. widget.showBranding merupakan pengecualian: preferensi yang tersimpan dipertahankan, atau true jika belum ada; nilai eksplisit menimpanya pada promosi runtime berikutnya. Free menerima refresh otomatis mingguan atau bulanan. Versi yang sebelumnya valid dapat gagal dipromosikan setelah perubahan paket.
Jika mode adalah sitemap dan sitemapUrl tidak diberikan, sistem lebih dahulu menggunakan sitemap yang terdeteksi. Setelah itu sistem mencoba /sitemap.xml dan /sitemap_index.xml; jika keduanya tidak menghasilkan URL, sistem menggunakan URL situs yang tersimpan.
Versi konfigurasi immutable mempertahankan nilai maxPages yang diminta, tetapi promosi runtime membatasi konfigurasi scraping operasional hingga 100.000. Jika maxPages dihilangkan, nilai default permintaan mengikuti kuota halaman akun yang termasuk dalam paket: Free 10, Starter 150, Pro 5.000, dan Business 25.000. Untuk setiap proses, batas pemilihan adalah nilai yang lebih kecil antara batas yang diminta dan nilai yang lebih besar antara kapasitas penyedia atau jumlah halaman yang sudah ada di project. Karena itu, halaman yang sudah ada tetap dapat diperbarui meskipun kapasitas penyedia lebih rendah. Penerimaan halaman baru diperiksa secara terpisah terhadap kuota halaman seluruh akun pemilik. Penemuan sitemap dapat mengambil dokumen sitemap dan mencantumkan URL sebelum pemilihan; batas kapasitas bukan batas privasi maupun batas request keluar. Nilai ini bukan jaminan bahwa semua halaman yang diminta akan diindeks.
Nilai tersebut tidak menambah kuota bersama pemilik atau hak paket; scraping memeriksa ulang kuota halaman/PAYG dan batas refresh bulanan. Promosi menentukan paket dari data project/workspace yang di-cache server, bukan permintaan langsung ke penyedia penagihan. Saat mendiagnosis perubahan paket atau PAYG yang baru, periksa sinkronisasi penagihan dan kuota scraping aktual secara terpisah.
Gunakan --json dalam otomatisasi untuk menerima hasil API, termasuk version._id, pointer environment, applied, indexingStatus, dan ID job scraping. Simpan version._id dari output deploy/promote/rollback atau activeVersion._id dari output status; nomor versi yang terlihat tidak dapat digunakan sebagai --version.
Status, promosi, dan rollback
bunx @openstaticfish/chattybox-cli status --environment production
bunx @openstaticfish/chattybox-cli promote \
--version '<config-version-id>' \
--environment production
bunx @openstaticfish/chattybox-cli rollback \
--version '<known-good-config-version-id>' \
--environment production
--version menggunakan ID versi konfigurasi opak dari output deploy/promote/rollback (version._id) atau output status (activeVersion._id), bukan nomor yang terlihat. Rollback memakai operasi backend yang sama dengan promote, tidak harus menargetkan versi yang lebih lama, dan menimpa pointer serta metadata promosi environment terpilih; tidak ada riwayat promosi append-only. Rollback preview atau production menerapkan kembali konfigurasi dengan entitlement saat ini dan mengantrekan refresh baru, bukan memulihkan corpus historis. status mengembalikan pointer environment yang dipilih dan ringkasan versi, bukan konfigurasi runtime efektif atau progres scraping/embedding.
Rollback tidak memilih versi sebelumnya secara otomatis. Deployment berulang membuat versi baru bahkan untuk konfigurasi identik; promosi berulang dapat mengantrekan job baru. Untuk label yang belum pernah di-deploy, status menampilkan Environment version: none serta environment: null dan activeVersion: null. Pemanggilan status yang berhasil juga memperbarui lastUsedAt token dan memakai kapasitas batas laju manajemen. Jika konfigurasi tidak dikunci, edit dashboard sesudahnya dapat mengubah field runtime tanpa mengubah ID konfigurasi terakhir yang diterapkan.
Perintah, opsi, dan kesalahan
init [path] membuat direktori induk dan tidak menimpa file yang ada; validate [path] membaca JSON tanpa akses jarak jauh. Keduanya default ke chattybox.config.json. deploy memerlukan --environment dan menerima --config <path>; promote dan rollback memerlukan --environment dan --version <opaque-id>, sedangkan status memerlukan --environment. Tiga perintah terakhir tidak membaca konfigurasi lokal. Gunakan chattybox --help untuk bantuan tingkat atas; --version atau -v di tingkat atas menampilkan versi CLI, bukan ID versi promosi.
Keempat perintah manajemen menerima --token, --api-url, dan --json. Flag eksplisit mengungguli CHATTYBOX_DEPLOY_TOKEN dan CHATTYBOX_API_URL; utamakan variabel environment rahasia daripada token dalam riwayat shell atau argumen proses. Flag bernilai menerima --flag value atau --flag=value, sedangkan --json adalah switch tanpa nilai. Tidak ada environment default. Opsi yang tidak dikenal, duplikat, kosong, atau tidak berlaku untuk perintah ditolak; perintah lokal hanya menerima satu path posisional tanpa flag atau argumen tambahan.
Tidak ada flag --dry-run, --wait, --force, --project, pesan, atau optimistic concurrency. API HTTP mendukung field expected-version, tetapi CLI tidak mengirimkannya. Jalankan deployment CI ke project yang sama secara berurutan. Perintah yang berhasil keluar dengan kode 0; kegagalan file, JSON, validasi, argumen, transport, pembacaan respons, atau HTTP keluar dengan kode 1 dan pesan di stderr. --json hanya memformat hasil yang berhasil, bukan error. CLI tidak melakukan retry atau polling otomatis dan tidak mengonfigurasi timeout request; setelah kegagalan transport, periksa status sebelum mencoba lagi karena server mungkin sudah menyimpan deployment.
Route manajemen berbagi batas 20 request per menit per token; respons 429 menggunakan format batas laju bersama dan header Retry-After. Error dapat mencakup 401 INVALID_TOKEN, 404 NOT_FOUND, 409 CONFIG_CONFLICT, 413 BODY_TOO_LARGE, 422 INVALID_CONFIG, atau 500 INTERNAL_ERROR. Batas isi request adalah 262.144 byte; ID bertipe yang salah format menghasilkan 422, tidak selalu 404.
Workflow CI/CD
Tambahkan CHATTYBOX_DEPLOY_TOKEN sebagai secret terenkripsi yang dicakup untuk production di penyedia CI Anda. Tambahkan CHATTYBOX_API_URL sebagai secret atau variabel menggunakan URL deployment HTTP actions atau URL API widget dari Pasang → Instalasi situs web, jika tersedia. Jalankan validasi pada pull request, tetapi batasi deployment production ke branch default yang dilindungi atau environment deployment yang disetujui.
GitHub Actions
name: Deploy ChattyBox configuration
on:
pull_request:
push:
branches: [main]
jobs:
validate:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: oven-sh/setup-bun@v2
- uses: actions/setup-node@v6
with:
node-version: 24
- run: bunx @openstaticfish/chattybox-cli validate
deploy:
if: github.event_name == 'push'
needs: validate
runs-on: ubuntu-latest
environment: production
steps:
- uses: actions/checkout@v4
- uses: oven-sh/setup-bun@v2
- uses: actions/setup-node@v6
with:
node-version: 24
- name: Validate and deploy
env:
CHATTYBOX_DEPLOY_TOKEN: ${{ secrets.CHATTYBOX_DEPLOY_TOKEN }}
CHATTYBOX_API_URL: ${{ vars.CHATTYBOX_API_URL }}
run: |
bunx @openstaticfish/chattybox-cli validate
bunx @openstaticfish/chattybox-cli deploy --environment production --json
Gunakan secret production yang dicakup oleh environment dan wajibkan persetujuan deployment jika repositori Anda mendukungnya. CLI mencatat variabel commit dan branch CI umum bersama versi immutable.
GitLab CI/CD
Simpan kedua nilai di Settings → CI/CD → Variables. Lindungi token deployment, mask token tersebut, dan cakup ke environment production.
image: oven/bun:1
validate_chattybox:
stage: test
rules:
- if: '$CI_PIPELINE_SOURCE == "merge_request_event"'
script:
- bunx --bun @openstaticfish/chattybox-cli validate
deploy_chattybox:
stage: deploy
environment: production
rules:
- if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'
script:
- bunx --bun @openstaticfish/chattybox-cli validate
- bunx --bun @openstaticfish/chattybox-cli deploy --environment production --json
GitLab secara otomatis mengekspos CHATTYBOX_DEPLOY_TOKEN dan CHATTYBOX_API_URL ke job menggunakan nama variabelnya. Gunakan branch default yang dilindungi agar variabel yang dilindungi tidak tersedia untuk branch yang tidak tepercaya.
Contoh container Bun menggunakan --bun agar tidak bergantung pada instalasi Node terpisah; verifikasi versi Bun/image yang di-pin di CI.
Bitbucket Pipelines
Tambahkan kedua nilai sebagai variabel deployment di Repository settings → Pipelines → Deployments → Production. Tandai token deployment sebagai secured.
image: oven/bun:1
pipelines:
pull-requests:
'**':
- step:
name: Validate ChattyBox configuration
script:
- bunx --bun @openstaticfish/chattybox-cli validate
branches:
main:
- step:
name: Deploy ChattyBox configuration
deployment: Production
script:
- bunx --bun @openstaticfish/chattybox-cli validate
- bunx --bun @openstaticfish/chattybox-cli deploy --environment production --json
Ganti main jika branch default Anda memiliki nama lain. Bitbucket hanya menyuntikkan variabel deployment ke langkah yang terkait dengan environment deployment tersebut. CLI tidak memiliki pemetaan metadata khusus BITBUCKET_*; CLI menggunakan Git lokal untuk commit dan branch, yang mungkin tidak memiliki nama branch dalam detached checkout.
Bagian konfigurasi
| Bagian | Tujuan |
|---|---|
schemaVersion | Memilih kontrak konfigurasi publik. Versi 1 saat ini didukung. |
project | Metadata project opsional seperti deskripsi dashboard. |
assistant | Memberi nama asisten dan menentukan persona bawaan atau prompt sistem khusus serta teks fallback. |
knowledge.sources | Memilih penemuan beranda, sitemap, URL manual, atau crawl beserta batas, filter, dan jadwal refresh. |
runtime | Mengontrol locale otomatis/tetap, locale default, dan override locale tingkat halaman. |
widget | Mengontrol enablement, posisi, teks, warna, dan presentasi ikon widget ter-host. |
Persona dan penemuan sumber
Contoh ini adalah satu entri dalam knowledge.sources, bukan konfigurasi lengkap. Contoh ini memerlukan paket CLI/config 0.3.1 yang dipublikasikan dan kontrak backend 0.3.0 yang sesuai. Refresh harian memerlukan Starter atau lebih tinggi; maxPages: 500 adalah permintaan yang tetap dibatasi kapasitas tersedia, bukan jaminan pengindeksan.
{
"type": "website",
"url": "https://docs.example.com",
"mode": "sitemap",
"sitemapUrl": "https://docs.example.com/docs-sitemap.xml",
"include": ["/docs/"],
"exclude": ["/private/"],
"maxPages": 500,
"autoRescrape": true,
"rescrapeInterval": "daily"
}
Atur promptProfile ke default, support, sales, atau sarcastic untuk instruksi persona yang dipelihara. Untuk persona khusus, gunakan custom dan berikan systemPrompt. Jika profil bawaan dan systemPrompt sama-sama diberikan, prompt eksplisit yang berlaku.
Mode homepage hanya memilih url untuk refresh tanpa menghapus halaman lama; sitemap menggunakan sitemapUrl dan sitemap eksplisit tanpa URL menggagalkan job; manual mengindeks daftar manualUrls yang tidak kosong; crawl mencoba sitemap konvensional lalu mengikuti tautan dari url hingga maxDepth (default 3). include dan exclude mencocokkan substring URL dengan memperhatikan huruf besar-kecil, bukan glob atau regex. Kecocokan exclude mengalahkan include; daftar kosong tidak memfilter. Filter juga berlaku untuk homepage dan URL manual.
maxPages harus bilangan bulat positif dan tetap tunduk pada batas runtime serta kapasitas di atas. maxDepth harus bilangan bulat 0–20 dan mengatur fallback crawl tautan, bukan enumerasi sitemap. autoRescrape: true memerlukan rescrapeInterval: "daily", "weekly", atau "monthly"; interval saja tidak mengaktifkan jadwal. Bulanan berarti 30 hari dan scheduler dapat berjalan setelah waktu jatuh tempo.
Validasi locale dan widget
Locale yang didukung adalah en, de, fr, es, it, nl, pl, pt, sv, fi, et, cs, cy, dan id. localeMode adalah auto atau fixed; fixed memerlukan defaultLocale. allowLocaleOverride dapat diatur secara terpisah. Singkatan runtime.locale memilih mode fixed dan menonaktifkan override; validasi lokal menolak kombinasinya dengan localeMode, defaultLocale, atau allowLocaleOverride: true.
Posisi widget adalah bottom-right, bottom-left, top-right, atau top-left. Ketiga warna tema menggunakan #RRGGBB. Ikon memakai default, emoji dengan string emoji yang tidak kosong, atau url HTTP(S), dengan ukuran opsional small, medium, atau large. Validasi tidak mengambil URL ikon, memeriksa MIME gambar, atau mewajibkan tepat satu emoji; validasi URL sumber dan ikon memeriksa sintaks/protokol, bukan keterjangkauan atau izin crawl. Deskripsi opsional, prompt/fallback asisten, judul widget, dan teks sambutan harus tidak kosong jika diberikan; hilangkan untuk membersihkan override.
Helper konfigurasi bertipe
Instal paket konfigurasi saat membangun tooling TypeScript terpisah di sekitar skema:
bun add -d @openstaticfish/chattybox-config
import { defineConfig } from '@openstaticfish/chattybox-config';
const config = defineConfig({
schemaVersion: '1',
assistant: { name: 'Support' },
knowledge: {
sources: [{ type: 'website', url: 'https://docs.example.com' }],
},
widget: { enabled: true },
});
CLI itu sendiri membaca file JSON. defineConfig() ditujukan untuk aplikasi bertipe atau tooling build; fungsi ini tidak membuat file TypeScript dapat langsung dimuat oleh CLI. defineConfig(config) dan validateConfig(config) memvalidasi secara sinkron, melempar Error biasa pada kegagalan pertama, dan mengembalikan objek yang sama tanpa menyalin, membekukan, mengonversi, atau menyisipkan default. Paket mengekspor tipe TypeScript dan fungsi tersebut, bukan dokumen JSON Schema atau URL $schema.
Untuk integrasi produksi yang berfungsi saat ini, gunakan widget yang dihosting atau bangun antarmuka khusus dengan SDK JavaScript.