Konfigurasi

Setiap aplikasi Kazzle memiliki kazzle.config.ts di akar proyek. File ini mengekspor satu definisi aplikasi: kontrak yang sama yang digunakan Kazzle untuk aplikasi yang dipublikasikan dan konektor bawaan.

Mulai cepat

import { defineApp } from '@kazzle/app';

export default defineApp({
  schemaVersion: 1,
  name: 'My App',
  subtitle: 'A short catalog description',
  description: { type: 'markdown', path: 'README.md' },
  maxInstallations: 1,
  setup: { type: 'none' },
  launch: { type: 'component', component: 'web' },
  components: [{ name: 'web', type: 'ui', path: '.' }],
  tools: [],
  skills: [],
});

defineApp memvalidasi definisi dan menyediakan penyelesaian otomatis TypeScript. Field yang tidak didukung atau salah eja akan gagal validasi alih-alih diabaikan.

Field definisi

Field	Tipe	Wajib	Deskripsi
`schemaVersion`	`1`	ya	Versi kontrak definisi.
`name`	`string`	ya	Nama tampilan di katalog dan halaman detail.
`subtitle`	`string`	ya	Deskripsi katalog satu baris.
`description`	`{ type: 'markdown', path: string }`	ya	Markdown yang disertakan dengan aplikasi, biasanya `README.md`.
`version`	`string`	tidak	Versi penerbit yang ditampilkan dengan aplikasi yang diinstal.
`icon`	`string`	tidak	Jalur ikon relatif terhadap akar aplikasi.
`accentColor`	warna hex	tidak	Warna aksen merek.
`maxInstallations`	`number \| null`	ya	Instalasi maksimal per space; `null` memungkinkan jumlah apa pun.
`setup`	objek setup	ya	Cara instalasi dikonfigurasi.
`launch`	objek launch	ya	Apa yang terbuka setelah instalasi.
`components`	component[]	ya	Komponen UI dan proses.
`tools`	sumber tool[]	ya	Sumber yang dikompilasi menjadi tool AI yang dapat dipanggil.
`skills`	skill[]	ya	Instruksi yang dimuat saat relevan.
`kazzleAuth`	`'optional' \| 'required'`	tidak	Apakah permukaan peluncuran memerlukan identitas Kazzle.
`webhookUrl`	URL	tidak	Menerima webhook siklus hidup instalasi.
`appLogin`	`boolean`	tidak	Mengaktifkan login pengguna akhir aplikasi sendiri.

Setup

Aplikasi memilih tepat satu alur setup.

setup: { type: 'none' }

Gunakan none ketika instalasi tidak memerlukan otorisasi eksternal.

setup: {
  type: 'oauth',
  version: '2.0',
  metadata: {
    type: 'endpoints',
    authorizationUrl: 'https://provider.example.com/oauth/authorize',
    tokenUrl: 'https://provider.example.com/oauth/token',
  },
  scopes: ['account.read'],
  pkce: 'required',
  authorizationParams: {},
  fields: [],
}

Gunakan oauth untuk OAuth 1.0a atau OAuth 2.0. Kredensial klien OAuth dikonfigurasi secara pribadi saat aplikasi dipublikasikan; mereka tidak pernah muncul dalam definisi.

setup: {
  type: 'form',
  labelField: 'accountUrl',
  fields: [
    { key: 'accountUrl', label: 'Account URL', kind: 'url', required: true, secret: false },
    { key: 'apiKey', label: 'API key', kind: 'password', required: true, secret: true },
  ],
}

Field form mendukung text, password, url, hostname, email, dan select. labelField dapat mereferensikan field non-rahasia untuk membedakan beberapa instalasi.

Launch

launch: { type: 'none' }
launch: { type: 'component', component: 'web' }
launch: { type: 'url', url: 'https://example.com', target: 'external' }

Target komponen harus menamai komponen dalam definisi yang sama. Target URL memilih embedded atau external secara eksplisit.

Komponen

Setiap komponen memiliki name unik, type berupa ui atau process, dan path sumber. Aplikasi dapat memiliki paling banyak satu komponen UI.

components: [{
  name: 'server',
  type: 'process',
  path: './server',
  runtime: {
    dev: { command: 'bun run dev' },
    prod: { command: 'bun run start', build: 'bun run build' },
  },
}]

env dapat memilih koleksi rahasia dan lingkungan untuk komponen. Komponen proses juga dapat mendeklarasikan eksekusi persisten atau dipicu dan pemicu jadwal atau webhook bernama.

Tools dan skills

Tools dan skills independen. Tools mendefinisikan operasi yang dapat dipanggil; skills menjelaskan kapan dan bagaimana menggunakannya.

tools: [
  { name: 'app-tools', type: 'file', path: './tools.ts' },
  {
    name: 'stripe',
    type: 'connection_actions',
    actions: ['customers.list', 'invoices.list'],
  },
],
skills: [
  { name: 'billing', source: { type: 'file', path: './skills/billing/SKILL.md' } },
  { name: 'review', source: { type: 'inline', instructions: 'Confirm before write actions.' } },
]

Tindakan koneksi memerlukan instalasi saat dipanggil. Mereka dipancarkan oleh konverter sistem-aplikasi Kazzle; aplikasi yang dipublikasikan mendefinisikan tool yang dapat dipanggil dalam file. Skills tetap terpisah dan hanya dapat dimuat saat relevan.

Memulai

Membangun

Pengguna dan data

Menerbitkan

Menggunakan Kazzle

Keamanan

Referensi

Konfigurasi

Konfigurasi

Mulai cepat

Field definisi

Setup

Launch

Komponen

Tools dan skills

​Konfigurasi

​Mulai cepat

​Field definisi

​Setup

​Launch

​Komponen

​Tools dan skills

Konfigurasi

Mulai cepat

Field definisi

Setup

Launch

Komponen

Tools dan skills