कॉन्फ़िगरेशन

प्रत्येक 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`	हाँ	प्रति Space में अधिकतम स्थापन; `null` किसी भी संख्या की अनुमति देता है।
`setup`	setup object	हाँ	स्थापन कैसे कॉन्फ़िगर किया जाता है।
`launch`	launch object	हाँ	स्थापन के बाद क्या खुलता है।
`components`	component[]	हाँ	UI और प्रक्रिया घटक।
`tools`	tool source[]	हाँ	स्रोत जो कॉल करने योग्य AI उपकरणों में संकलित होते हैं।
`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 1.0a या OAuth 2.0 के लिए oauth का उपयोग करें। 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, ui या process का type, और एक स्रोत 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

शुरुआत करें

बनाएं

उपयोगकर्ता और डेटा

प्रकाशित करें

Kazzle का उपयोग

सुरक्षा

संदर्भ

कॉन्फ़िगरेशन

कॉन्फ़िगरेशन

त्वरित शुरुआत

परिभाषा फ़ील्ड

सेटअप

लॉन्च

घटक

उपकरण और कौशल

​कॉन्फ़िगरेशन

​त्वरित शुरुआत

​परिभाषा फ़ील्ड

​सेटअप

​लॉन्च

​घटक

​उपकरण और कौशल

कॉन्फ़िगरेशन

त्वरित शुरुआत

परिभाषा फ़ील्ड

सेटअप

लॉन्च

घटक

उपकरण और कौशल