Yapılandırma

Her Kazzle uygulamasının proje kökünde bir kazzle.config.ts dosyası vardır. Dosya bir uygulama tanımını dışa aktarır: Kazzle’nin yayınlanan uygulamalar ve yerleşik bağlayıcılar için kullandığı aynı sözleşme.

Hızlı başlangıç

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 tanımı doğrular ve TypeScript otomatik tamamlamayı sağlar. Desteklenmeyen veya yanlış yazılan alanlar yoksayılmak yerine doğrulama başarısız olur.

Tanım alanları

Alan	Tür	Gerekli	Açıklama
`schemaVersion`	`1`	evet	Tanım sözleşmesinin sürümü.
`name`	`string`	evet	Katalog ve detay sayfasında görünen ad.
`subtitle`	`string`	evet	Tek satırlık katalog açıklaması.
`description`	`{ type: 'markdown', path: string }`	evet	Uygulamayla birlikte gelen Markdown, genellikle `README.md`.
`version`	`string`	hayır	Yüklü uygulamayla gösterilen yayıncı sürümü.
`icon`	`string`	hayır	Uygulama köküne göre ikon yolu.
`accentColor`	hex renk	hayır	Marka vurgu rengi.
`maxInstallations`	`number \| null`	evet	Alan başına maksimum kurulum; `null` herhangi bir sayıya izin verir.
`setup`	setup nesnesi	evet	Kurulumun nasıl yapılandırıldığı.
`launch`	launch nesnesi	evet	Kurulumdan sonra neyin açıldığı.
`components`	component[]	evet	YZ ve işlem bileşenleri.
`tools`	tool kaynağı[]	evet	Çağrılabilir YZ araçlarına derlenen kaynaklar.
`skills`	skill[]	evet	İlgili olduğunda yüklenen talimatlar.
`kazzleAuth`	`'optional' \| 'required'`	hayır	Başlatma yüzeyinin Kazzle kimliği gerektirip gerektirmediği.
`webhookUrl`	URL	hayır	Kurulum yaşam döngüsü webhook’larını alır.
`appLogin`	`boolean`	hayır	Uygulamanın kendi son kullanıcı girişini etkinleştirir.

Kurulum

Bir uygulama tam olarak bir kurulum akışı seçer.

setup: { type: 'none' }

Kurulumun harici yetkilendirmeye ihtiyaç duymadığında none kullanın.

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: [],
}

OAuth 1.0a veya OAuth 2.0 için oauth kullanın. OAuth istemci kimlik bilgileri uygulama yayınlandığında özel olarak yapılandırılır; tanımda asla görünmezler.

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

Form alanları text, password, url, hostname, email ve select destekler. labelField birden fazla kurulumu ayırt etmek için gizli olmayan bir alana başvurabilir.

Başlatma

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

Bir bileşen hedefi aynı tanımda bir bileşeni adlandırmalıdır. URL hedefleri embedded veya external seçeneğini açıkça seçer.

Bileşenler

Her bileşenin benzersiz bir name, ui veya process türünde bir type ve bir kaynak path vardır. Bir uygulamanın en fazla bir YZ bileşeni olabilir.

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

env bir bileşen için gizli dizi koleksiyonu ve ortamı seçebilir. İşlem bileşenleri ayrıca kalıcı veya tetiklenen yürütme ve adlandırılmış zamanlama veya webhook tetikleyicileri bildirebilir.

Araçlar ve beceriler

Araçlar ve beceriler bağımsızdır. Araçlar çağrılabilir işlemleri tanımlar; beceriler bunları ne zaman ve nasıl kullanacağını açıklar.

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.' } },
]

Bağlantı işlemleri çağrıldığında bir kurulum gerektirir. Kazzle’nin sistem uygulaması dönüştürücüsü tarafından yayılırlar; yayınlanan uygulamalar dosyalarda çağrılabilir araçlar tanımlar. Beceriler ayrı kalır ve yalnızca ilgili olduğunda yüklenebilir.

Başlarken

Oluşturma

Kullanıcılar ve veriler

Yayınlama

Kazzle kullanımı

Güvenlik

Referans

Yapılandırma

Yapılandırma

Hızlı başlangıç

Tanım alanları

Kurulum

Başlatma

Bileşenler

Araçlar ve beceriler

​Yapılandırma

​Hızlı başlangıç

​Tanım alanları

​Kurulum

​Başlatma

​Bileşenler

​Araçlar ve beceriler

Yapılandırma

Hızlı başlangıç

Tanım alanları

Kurulum

Başlatma

Bileşenler

Araçlar ve beceriler