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

Каждое приложение 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[]	да	Компоненты пользовательского интерфейса и процесса.
`tools`	tool source[]	да	Источники, которые компилируются в вызываемые инструменты ИИ.
`skills`	skill[]	да	Инструкции, загружаемые при необходимости.
`kazzleAuth`	`'optional' \| 'required'`	нет	Требует ли поверхность запуска идентификацию Kazzle.
`webhookUrl`	URL	нет	Получает вебхуки жизненного цикла установки.
`appLogin`	`boolean`	нет	Включает собственный вход конечного пользователя приложения.

Setup

Приложение выбирает ровно один поток настройки.

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

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

Целевой компонент должен назвать компонент в том же определении. Целевые URL явно выбирают embedded или external.

Components

Каждый компонент имеет уникальное name, type из ui или process и исходный path. Приложение может иметь максимум один компонент пользовательского интерфейса.

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

env может выбрать коллекцию секретов и окружение для компонента. Компоненты процесса также могут объявлять постоянное или триггерное выполнение и именованные триггеры расписания или вебхука.

Tools и skills

Tools и skills независимы. Tools определяют вызываемые операции; skills объясняют, когда и как их использовать.

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; опубликованные приложения определяют вызываемые инструменты в файлах. Skills остаются отдельными и могут быть загружены только при необходимости.

Начало работы

Создание

Пользователи и данные

Публикация

Использование Kazzle

Безопасность

Справочник

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

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

Быстрый старт

Поля определения

Setup

Launch

Components

Tools и skills

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

​Быстрый старт

​Поля определения

​Setup

​Launch

​Components

​Tools и skills

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

Быстрый старт

Поля определения

Setup

Launch

Components

Tools и skills