skrypt-ai 0.4.2 → 0.6.0

package/dist/template/content/docs/llms-full.md

@@ -0,0 +1,403 @@
+# Skrypt API
+
+> API documentation for Skrypt
+
+## getAuthConfig
+function getAuthConfig(): AuthConfig
+
+## getAuthConfigAsync
+async function getAuthConfigAsync(): Promise<AuthConfig>
+
+## saveAuthConfig
+async function saveAuthConfig(config: AuthConfig): Promise<void>
+
+## clearAuth
+async function clearAuth(): Promise<void>
+
+## getKeyStorageMethod
+async function getKeyStorageMethod(): Promise<'keychain' | 'file' | 'env' | 'none'>
+
+## checkPlan
+async function checkPlan(apiKey: string): Promise<PlanCheckResponse>
+
+## requirePro
+async function requirePro(commandName: string): Promise<boolean>
+
+## keychainAvailable
+async function keychainAvailable(): Promise<boolean>
+
+## keychainStore
+async function keychainStore(key: string): Promise<boolean>
+
+## keychainRetrieve
+async function keychainRetrieve(): Promise<string | null>
+
+## keychainDelete
+async function keychainDelete(): Promise<boolean>
+
+## getKeychainPlatformName
+function getKeychainPlatformName(): string
+
+## hasSeenNotice
+function hasSeenNotice(id: string): boolean
+
+## markNoticeSeen
+function markNoticeSeen(id: string): void
+
+## showSecurityNotice
+function showSecurityNotice(): void
+
+## autoFixExample
+async function autoFixExample(example: CodeExample, client: LLMClient, options: AutoFixOptions = {}): Promise<FixResult>
+
+## autoFixBatch
+async function autoFixBatch(examples: CodeExample[], client: LLMClient, options: AutoFixOptions = {}): Promise<Map<number, FixResult>>
+
+## createTypeScriptValidator
+function createTypeScriptValidator(): (code: string) => Promise<ValidationResult>
+
+## createPythonValidator
+function createPythonValidator(): (code: string) => Promise<ValidationResult>
+
+## findConfigFile
+function findConfigFile(dir: string): string | null
+
+## loadConfig
+function loadConfig(configPath?: string): Config
+
+## validateConfig
+function validateConfig(config: Config): string[]
+
+## checkApiKey
+function checkApiKey(provider: LLMProvider): { ok: boolean; envKey: string | null }
+
+## generateForElement
+async function generateForElement(element: APIElement, client: LLMClient, options: GenerationOptions, onProgress?: (progress: GenerationProgress) => void): Promise<GeneratedDoc>
+
+## generateForElements
+async function generateForElements(elements: APIElement[], client: LLMClient, options: GenerationOptions): Promise<GeneratedDoc[]>
+
+## formatAsMarkdown
+function formatAsMarkdown(docs: GeneratedDoc[], title: string): string
+
+## organizeByTopic
+function organizeByTopic(docs: GeneratedDoc[], config: TopicConfig = DEFAULT_TOPIC_CONFIG): Topic[]
+
+## detectCrossReferences
+function detectCrossReferences(docs: GeneratedDoc[]): CrossReference[]
+
+## getCrossRefsForElement
+function getCrossRefsForElement(elementName: string, allRefs: CrossReference[]): CrossReference[]
+
+## buildNavigation
+function buildNavigation(topics: Topic[]): NavigationItem[]
+
+## generateSidebarConfig
+function generateSidebarConfig(topics: Topic[]): object
+
+## mergeTopicConfig
+function mergeTopicConfig(userConfig: Partial<TopicConfig>, defaults: TopicConfig = DEFAULT_TOPIC_CONFIG): TopicConfig
+
+## writeLlmsTxt
+async function writeLlmsTxt(docs: GeneratedDoc[], outputDir: string, options: { projectName?: string; description?: string } = {}): Promise<void>
+
+## writeDocsToDirectory
+async function writeDocsToDirectory(results: FileGenerationResult[], outputDir: string, sourceDir: string): Promise<{ filesWritten: number; totalDocs: number }>
+
+## groupDocsByFile
+function groupDocsByFile(docs: GeneratedDoc[]): FileGenerationResult[]
+
+## writeDocsByTopic
+async function writeDocsByTopic(docs: GeneratedDoc[], outputDir: string): Promise<{ filesWritten: number; totalDocs: number; topics: Topic[] }>
+
+## postPRComment
+async function postPRComment(config: PRCommentConfig, issues: DocumentationIssue[]): Promise<CommentResult>
+
+## postInlineComments
+async function postInlineComments(config: PRCommentConfig, issues: DocumentationIssue[]): Promise<CommentResult[]>
+
+## analyzePRForDocs
+async function analyzePRForDocs(config: PRCommentConfig, _options: { checkExamples?: boolean } = {}): Promise<DocumentationIssue[]>
+
+## importConfluence
+function importConfluence(dir: string, name?: string): ImportResult
+
+## detectFormat
+function detectFormat(dir: string): ImportFormat
+
+## isGitHubUrl
+function isGitHubUrl(input: string): boolean
+
+## parseGitHubUrl
+function parseGitHubUrl(url: string): { owner: string; repo: string; path: string; ref: string }
+
+## importDocusaurus
+function importDocusaurus(dir: string, name?: string): ImportResult
+
+## importGitBook
+function importGitBook(dir: string, name?: string): ImportResult
+
+## importFromGitHub
+async function importFromGitHub(owner: string, repo: string, path: string, ref: string, options?: { format?: ImportFormat; name?: string }): Promise<ImportResult>
+
+## runImport
+function runImport(dir: string, format: ImportFormat, name?: string): ImportResult
+
+## importMarkdown
+function importMarkdown(dir: string, name?: string): ImportResult
+
+## importMintlify
+function importMintlify(dir: string, name?: string): ImportResult
+
+## importNotion
+function importNotion(dir: string, name?: string): ImportResult
+
+## importReadme
+function importReadme(dir: string, name?: string): ImportResult
+
+## transformMintlifyCallouts
+function transformMintlifyCallouts(content: string): string
+
+## transformDocusaurusAdmonitions
+function transformDocusaurusAdmonitions(content: string): string
+
+## transformGitBookHints
+function transformGitBookHints(content: string): string
+
+## transformReadmeCallouts
+function transformReadmeCallouts(content: string): string
+
+## transformNotionCallouts
+function transformNotionCallouts(content: string): string
+
+## transformConfluenceCallouts
+function transformConfluenceCallouts(content: string): string
+
+## transformMintlifyTabs
+function transformMintlifyTabs(content: string): string
+
+## transformDocusaurusTabs
+function transformDocusaurusTabs(content: string): string
+
+## transformGitBookTabs
+function transformGitBookTabs(content: string): string
+
+## transformReadmeCodeBlocks
+function transformReadmeCodeBlocks(content: string): string
+
+## transformGitBookSteps
+function transformGitBookSteps(content: string): string
+
+## transformGitBookExpandable
+function transformGitBookExpandable(content: string): string
+
+## transformGitBookContentRef
+function transformGitBookContentRef(content: string): string
+
+## transformGitBookEmbed
+function transformGitBookEmbed(content: string): string
+
+## transformNotionToggles
+function transformNotionToggles(content: string): string
+
+## transformConfluenceHtml
+function transformConfluenceHtml(content: string): string
+
+## stripDocusaurusImports
+function stripDocusaurusImports(content: string): string
+
+## normalizeFrontmatter
+function normalizeFrontmatter(content: string, defaults?: FrontmatterDefaults): string
+
+## rewriteImagePaths
+function rewriteImagePaths(content: string, mapping: Map<string, string>): string
+
+## stripNotionUUIDs
+function stripNotionUUIDs(filename: string): string
+
+## getSortWeight
+function getSortWeight(content: string): number
+
+## AnthropicClient
+class AnthropicClient implements LLMClient
+
+## constructor
+constructor(config: LLMClientConfig)
+
+## isConfigured
+isConfigured(): boolean
+
+## complete
+async complete(request: CompletionRequest): Promise<CompletionResponse>
+
+## createLLMClient
+function createLLMClient(config: {
+  provider: LLMProvider
+  model: string
+  baseUrl?: string
+  timeout?: number
+  maxRetries?: number
+}): LLMClient
+
+## generateDocumentation
+async function generateDocumentation(client: LLMClient, element: ElementContext, options?: { multiLanguage?: boolean }): Promise<GeneratedDocResult>
+
+## fixCodeSample
+async function fixCodeSample(client: LLMClient, code: string, error: string, context: string, iteration: number = 1): Promise<string>
+
+## OpenAICompatibleClient
+class OpenAICompatibleClient implements LLMClient
+
+## constructor
+constructor(config: LLMClientConfig)
+
+## isConfigured
+isConfigured(): boolean
+
+## complete
+async complete(request: CompletionRequest): Promise<CompletionResponse>
+
+## PluginManager
+class PluginManager
+
+## constructor
+constructor(sourcePath: string, outputPath: string, config: Record<string, unknown> = {})
+
+## loadPlugins
+async loadPlugins(configPath?: string): Promise<void>
+
+## register
+register(plugin: SkryptPlugin): void
+
+## runHook
+async runHook<T>(hook: keyof SkryptPlugin, ...args: unknown[]): Promise<T | undefined>
+
+## onInit
+async onInit(): Promise<void>
+
+## onBeforeScan
+async onBeforeScan(): Promise<void>
+
+## onAfterScan
+async onAfterScan<T>(elements: T[]): Promise<T[]>
+
+## onBeforeGenerate
+async onBeforeGenerate<T>(elements: T[]): Promise<T[]>
+
+## onAfterGenerate
+async onAfterGenerate<T>(docs: T[]): Promise<T[]>
+
+## onBeforeWrite
+async onBeforeWrite<T>(docs: T[]): Promise<T[]>
+
+## onAfterWrite
+async onAfterWrite(): Promise<void>
+
+## transformContent
+async transformContent(content: string, filePath: string): Promise<string>
+
+## definePlugin
+function definePlugin(plugin: SkryptPlugin): SkryptPlugin
+
+## classifyElement
+function classifyElement(element: APIElement): ContentClassification
+
+## classifyElements
+function classifyElements(elements: APIElement[]): Map<ContentType, APIElement[]>
+
+## getRecommendedStructure
+function getRecommendedStructure(elements: APIElement[]): {
+  sections: { name: string; type: ContentType; elements: APIElement[] }[]
+  stats: { api: number; guide: number; tutorial: number; overview: number }
+}
+
+## getPromptForContentType
+function getPromptForContentType(type: ContentType): string
+
+## GoScanner
+class GoScanner implements Scanner
+
+## canHandle
+canHandle(filePath: string): boolean
+
+## scanFile
+async scanFile(filePath: string): Promise<ScanResult>
+
+## scanDirectory
+async function scanDirectory(dir: string, options: ScanOptions = {}): Promise<ScanAllResult>
+
+## scanFile
+async function scanFile(filePath: string): Promise<ScanResult>
+
+## PythonScanner
+class PythonScanner implements Scanner
+
+## canHandle
+canHandle(filePath: string): boolean
+
+## scanFile
+async scanFile(filePath: string): Promise<ScanResult>
+
+## get_docstring
+def get_docstring(node: ast.AST) -> str | None
+
+## get_type_annotation
+def get_type_annotation(annotation: ast.AST | None) -> str | None
+
+## get_default_value
+def get_default_value(default: ast.AST | None) -> str | None
+
+## extract_parameters
+def extract_parameters(args: ast.arguments) -> list[dict[str, Any]]
+
+## build_signature
+def build_signature(name: str, args: ast.arguments, returns: ast.AST | None, is_async: bool) -> str
+
+## extract_function
+def extract_function(node: ast.FunctionDef | ast.AsyncFunctionDef, file_path: str, parent_class: str | None) -> dict[str, Any]
+
+## extract_class
+def extract_class(node: ast.ClassDef, file_path: str) -> list[dict[str, Any]]
+
+## scan_file
+def scan_file(file_path: str) -> dict[str, Any]
+
+## RustScanner
+class RustScanner implements Scanner
+
+## canHandle
+canHandle(filePath: string): boolean
+
+## scanFile
+async scanFile(filePath: string): Promise<ScanResult>
+
+## TypeScriptScanner
+class TypeScriptScanner implements Scanner
+
+## canHandle
+canHandle(filePath: string): boolean
+
+## scanFile
+async scanFile(filePath: string): Promise<ScanResult>
+
+## findMdxFiles
+function findMdxFiles(dir: string): string[]
+
+## slugify
+function slugify(str: string): string
+
+## parseFrontmatter
+function parseFrontmatter(content: string): { data: Record<string, unknown>; content: string }
+
+## validatePath
+function validatePath(input: string, mustExist = true): string
+
+## validateUrl
+function validateUrl(input: string): string
+
+## validateSlug
+function validateSlug(input: string): string
+
+## sanitizeForShell
+function sanitizeForShell(input: string): string
+