Конфігурація

Кожен додаток Kazzle має kazzle.config.ts у корені проекту. Файл експортує одне визначення додатка: той самий контракт, який Kazzle використовує для опублікованих додатків і вбудованих з’єднувачів.

Швидкий старт

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 перевіряє визначення та забезпечує автодоповнення TypeScript. Непідтримувані або неправильно написані поля не проходять перевірку замість того, щоб бути проігнорованими.

Поля визначення

Поле	Тип	Обов’язково	Опис
`schemaVersion`	`1`	так	Версія контракту визначення.
`name`	`string`	так	Назва для відображення в каталозі та на сторінці деталей.
`subtitle`	`string`	так	Однорядковий опис каталогу.
`description`	`{ type: 'markdown', path: string }`	так	Markdown, поставлений з додатком, зазвичай `README.md`.
`version`	`string`	ні	Версія видавця, показана з встановленим додатком.
`icon`	`string`	ні	Шлях до значка відносно кореня додатка.
`accentColor`	hex color	ні	Колір акценту бренду.
`maxInstallations`	`number \| null`	так	Максимум встановлень на простір; `null` дозволяє будь-яку кількість.
`setup`	setup object	так	Як налаштовується встановлення.
`launch`	launch object	так	Що відкривається після встановлення.
`components`	component[]	так	Компоненти UI та процесу.
`tools`	tool source[]	так	Джерела, які компілюються в викликаємі ШІ-інструменти.
`skills`	skill[]	так	Інструкції, завантажені коли релевантні.
`kazzleAuth`	`'optional' \| 'required'`	ні	Чи потребує поверхня запуску ідентичність Kazzle.
`webhookUrl`	URL	ні	Отримує вебхуки життєвого циклу встановлення.
`appLogin`	`boolean`	ні	Увімкнути власний вхід користувача додатка.

Налаштування

Додаток вибирає рівно один потік налаштування.

setup: { type: 'none' }

Використовуйте none, коли встановлення не потребує зовнішньої авторизації.

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 для OAuth 1.0a або OAuth 2.0. Облікові дані клієнта OAuth налаштовуються приватно при публікації додатка; вони ніколи не з’являються у визначенні.

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

Поля форми підтримують text, password, url, hostname, email та select. labelField може посилатися на незахищене поле для розрізнення кількох встановлень.

Запуск

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

Ціль компонента повинна назвати компонент у тому самому визначенні. Цілі URL явно вибирають embedded або external.

Компоненти

Кожен компонент має унікальну name, type з ui або process та джерело path. Додаток може мати максимум один компонент UI.

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

env може вибрати колекцію секретів та середовище для компонента. Компоненти процесу також можуть оголошувати постійне або активоване виконання та названі розклади або тригери вебхука.

Інструменти та навички

Інструменти та навички незалежні. Інструменти визначають викликаємі операції; навички пояснюють, коли та як їх використовувати.

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

Дії з’єднання потребують встановлення при виклику. Вони видаються конвертером системного додатка Kazzle; опубліковані додатки визначають викликаємі інструменти у файлах. Навички залишаються окремими та можуть завантажуватися лише коли релевантні.

Початок роботи

Створення

Користувачі та дані

Публікація

Використання Kazzle

Безпека

Довідник

Конфігурація

Конфігурація

Швидкий старт

Поля визначення

Налаштування

Запуск

Компоненти

Інструменти та навички

​Конфігурація

​Швидкий старт

​Поля визначення

​Налаштування

​Запуск

​Компоненти

​Інструменти та навички

Конфігурація

Швидкий старт

Поля визначення

Налаштування

Запуск

Компоненти

Інструменти та навички