@equinor/fusion-framework-cli 13.0.0-cli-search-index.4 → 13.0.0

package/dist/types/cli/commands/ai/utils/git/types.d.ts

@@ -1,33 +0,0 @@
-/**
- * Git metadata extracted from repository
- */
-export type GitMetadata = Partial<{
-    git_remote_url: string;
-    git_commit_hash: string;
-    git_commit_date: string;
-    git_link: string;
-}>;
-/**
- * Git diff options for filtering changed files
- */
-export interface GitDiffOptions {
-    /** Enable diff-based file filtering */
-    diff: boolean;
-    /** Git reference to compare against (default: HEAD~1) */
-    baseRef?: string;
-    /** Working directory for git operations */
-    cwd?: string;
-}
-/**
- * File change status
- */
-export type FileChangeStatus = 'new' | 'modified' | 'removed';
-/**
- * Changed file information
- */
-export interface ChangedFile {
-    /** Absolute file path */
-    filepath: string;
-    /** Change status: new, modified, or removed */
-    status: FileChangeStatus;
-}

package/dist/types/cli/commands/ai/utils/markdown/index.d.ts

@@ -1,2 +0,0 @@
-export type { MarkdownMetadata, MarkdownDocument } from './types.js';
-export { isMarkdownFile, parseMarkdown, parseMarkdownFile } from './parser.js';

package/dist/types/cli/commands/ai/utils/markdown/parser.d.ts

@@ -1,21 +0,0 @@
-import type { SourceFile } from '../types.js';
-import type { MarkdownDocument } from './types.js';
-/**
- * Check if a file is a markdown file
- * @param filePath - File path to check
- * @returns True if file has .md extension
- */
-export declare const isMarkdownFile: (filePath: string) => boolean;
-/**
- * Parse markdown content into document chunks
- * @param content - Markdown content string
- * @param source - Source file path
- * @returns Array of markdown documents
- */
-export declare const parseMarkdown: <T extends Record<string, unknown> = Record<string, unknown>>(content: string, source: string) => Promise<MarkdownDocument<T>[]>;
-/**
- * Parse a markdown file into document chunks
- * @param file - Source file object
- * @returns Array of markdown documents with root path metadata
- */
-export declare const parseMarkdownFile: <T extends Record<string, unknown> = Record<string, unknown>>(file: SourceFile) => Promise<MarkdownDocument<T>[]>;

package/dist/types/cli/commands/ai/utils/markdown/types.d.ts

@@ -1,11 +0,0 @@
-import type { VectorStoreDocument, VectorStoreDocumentMetadata } from '@equinor/fusion-framework-module-ai/lib';
-/**
- * Markdown document metadata
- */
-export type MarkdownMetadata<T extends Record<string, unknown> = Record<string, unknown>> = VectorStoreDocumentMetadata<T & {
-    type: 'markdown';
-}>;
-/**
- * Markdown document
- */
-export type MarkdownDocument<T extends Record<string, unknown> = Record<string, unknown>> = VectorStoreDocument<MarkdownMetadata<T>>;

package/dist/types/cli/commands/ai/utils/setup-framework.d.ts

@@ -1,10 +0,0 @@
-import { type AIModule } from '@equinor/fusion-framework-module-ai';
-import type { AiOptions } from '../../../options/ai.js';
-import { type ModulesInstance } from '@equinor/fusion-framework-module';
-/**
- * Initializes and configures the Fusion Framework with AI module capabilities
- * @param options - AI configuration options including API keys, deployments, and vector store settings
- * @returns Promise resolving to an initialized framework instance with AI module
- * @throws {Error} If embedding deployment is required but not provided when configuring vector store
- */
-export declare const setupFramework: (options: AiOptions) => Promise<ModulesInstance<[AIModule]>>;

package/dist/types/cli/commands/ai/utils/ts-doc/constants.d.ts

@@ -1,5 +0,0 @@
-import { SyntaxKind } from 'ts-morph';
-/**
- * Supported TSDoc node kinds for top-level processing
- */
-export declare const nodeKinds: SyntaxKind[];

package/dist/types/cli/commands/ai/utils/ts-doc/extractors.d.ts

@@ -1,28 +0,0 @@
-import { type SourceFile as ProjectSourceFile, Node, type ClassDeclaration } from 'ts-morph';
-import type { TypescriptDocument, ParseTsDocOptions } from './types.js';
-/**
- * Extracts a TSDoc document from a class node, including TSDoc, constructor, and public member signatures.
- * @param classNode - The ClassDeclaration node to process.
- * @param sourceFile - The source file containing the node.
- * @param options - Optional parsing configuration.
- * @returns A TypeScript document with TSDoc and class interface, or null if no TSDoc is found.
- */
-export declare const extractDocumentFromClassNode: (classNode: ClassDeclaration, sourceFile: ProjectSourceFile, _options?: ParseTsDocOptions) => TypescriptDocument | null;
-/**
- * Extracts a TSDoc document from a single node.
- * @param node - The TypeScript node to process.
- * @param sourceFile - The source file containing the node.
- * @param options - Optional parsing configuration.
- * @param nodeOptions - Optional node-specific configuration (e.g., skipKindCheck for VariableStatement).
- * @returns A TypeScript document with TSDoc metadata, or null if no TSDoc is found.
- */
-export declare const extractDocumentFromNode: (node: Node, sourceFile: ProjectSourceFile, options?: ParseTsDocOptions, nodeOptions?: {
-    skipKindCheck?: boolean;
-}) => TypescriptDocument | null;
-/**
- * Processes a TypeScript source file to extract TSDoc documents.
- * @param sourceFile - The source file to process.
- * @param options - Optional parsing configuration.
- * @returns An array of TypeScript documents with TSDoc metadata.
- */
-export declare const processSourceFile: (sourceFile: ProjectSourceFile, options?: ParseTsDocOptions) => TypescriptDocument[];

package/dist/types/cli/commands/ai/utils/ts-doc/index.d.ts

@@ -1,2 +0,0 @@
-export type { TypescriptMetadata, TypescriptDocument, ParseTsDocOptions } from './types.js';
-export { isTypescriptFile, parseTsDocSync, parseTsDocFromFileSync } from './parser.js';

package/dist/types/cli/commands/ai/utils/ts-doc/parser.d.ts

@@ -1,23 +0,0 @@
-import type { SourceFile } from '../types.js';
-import type { TypescriptDocument, ParseTsDocOptions } from './types.js';
-/**
- * Checks if a file is a TypeScript or TSX file based on its extension.
- * @param filePath - The path to the file.
- * @returns True if the file ends with .ts or .tsx, false otherwise.
- */
-export declare const isTypescriptFile: (filePath: string) => boolean;
-/**
- * Parses TSDoc from a string of TypeScript code.
- * @param content - The TypeScript code content.
- * @param options - Optional parsing configuration.
- * @returns An array of TypeScript documents with TSDoc metadata.
- */
-export declare const parseTsDocSync: (content: string, options?: ParseTsDocOptions) => TypescriptDocument[];
-/**
- * Parses TSDoc from a TypeScript file by path.
- * @param file - The source file object.
- * @param options - Optional parsing configuration.
- * @returns An array of TypeScript documents with TSDoc metadata.
- * @throws If the file is not a TypeScript file.
- */
-export declare const parseTsDocFromFileSync: (file: SourceFile, options?: ParseTsDocOptions) => TypescriptDocument[];

package/dist/types/cli/commands/ai/utils/ts-doc/types.d.ts

@@ -1,20 +0,0 @@
-import type { VectorStoreDocument, VectorStoreDocumentMetadata } from '@equinor/fusion-framework-module-ai/lib';
-/**
- * TypeScript document metadata
- */
-export type TypescriptMetadata = VectorStoreDocumentMetadata<{
-    type: 'tsdoc';
-    ts_kind: string;
-    ts_name: string;
-}>;
-/**
- * TypeScript document with TSDoc metadata
- */
-export type TypescriptDocument = VectorStoreDocument<TypescriptMetadata>;
-/**
- * Options for parsing TypeScript documents
- */
-export interface ParseTsDocOptions {
-    /** The project root path for generating relative paths */
-    projectRoot?: string;
-}

package/dist/types/cli/commands/ai/utils/types.d.ts

@@ -1,7 +0,0 @@
-export type FileStatus = 'new' | 'modified' | 'removed';
-export type SourceFile = {
-    path: string;
-    projectRoot?: string;
-    relativePath?: string;
-    status: FileStatus;
-};

package/dist/types/cli/commands/create/_helpers/start-dev-server.d.ts

@@ -1,17 +0,0 @@
-import type { ConsoleLogger } from '@equinor/fusion-framework-cli/bin';
-/**
- * Prompts the user to start the development server after project creation.
- *
- * Offers the user the option to immediately start the development server
- * using their selected package manager. The server runs in the foreground
- * and can be stopped with Ctrl+C. When persistent mode is enabled, the server
- * will run indefinitely until manually terminated by the user.
- *
- * @param targetDir - Absolute path to the project directory where dev server should start
- * @param packageManager - Package manager command to use (e.g., 'pnpm', 'npm')
- * @param logger - Console logger for displaying prompts and server status
- * @param persistent - If true, runs the dev server indefinitely without timeout (default: false)
- * @returns Promise resolving to true if dev server was started, false if user skipped
- */
-export declare function startDevServer(targetDir: string, packageManager: string, logger: ConsoleLogger, persistent?: boolean): Promise<boolean>;
-export default startDevServer;

package/dist/types/cli/options/ai.d.ts

@@ -1,105 +0,0 @@
-import { type Command } from 'commander';
-/**
- * Interface representing the AI-related options available in CLI commands.
- * This interface defines the structure of options that can be passed to AI commands.
- */
-export interface AiOptions {
-    /** Azure OpenAI API key for authentication */
-    openaiApiKey: string;
-    /** Azure OpenAI API version */
-    openaiApiVersion: string;
-    /** Azure OpenAI instance name */
-    openaiInstance: string;
-    /** Azure OpenAI chat deployment name (optional) */
-    openaiChatDeployment?: string;
-    /** Azure OpenAI embedding deployment name (optional) */
-    openaiEmbeddingDeployment?: string;
-    /** Azure Search endpoint URL (optional) */
-    azureSearchEndpoint?: string;
-    /** Azure Search API key (optional) */
-    azureSearchApiKey?: string;
-    /** Azure Search index name (optional) */
-    azureSearchIndexName?: string;
-}
-/**
- * Option for specifying the Azure OpenAI API key.
- * Required for authentication with Azure OpenAI services.
- */
-export declare const apiKeyOption: import("commander").Option;
-/**
- * Option for specifying the Azure OpenAI API version.
- * Defaults to the latest stable version if not provided.
- */
-export declare const apiVersionOption: import("commander").Option;
-/**
- * Option for specifying the Azure OpenAI instance name.
- * Required for Azure OpenAI service endpoint construction.
- */
-export declare const apiInstanceOption: import("commander").Option;
-/**
- * Option for specifying the Azure OpenAI deployment name for chat models.
- * Required for chat completions API calls.
- */
-export declare const chatDeploymentOption: import("commander").Option;
-/**
- * Option for specifying the Azure OpenAI deployment name for embedding models.
- * Required for embeddings API calls.
- */
-export declare const embeddingDeploymentOption: import("commander").Option;
-/**
- * Option for specifying the Azure Search endpoint URL.
- * Required for Azure Cognitive Search operations.
- */
-export declare const azureSearchEndpointOption: import("commander").Option;
-/**
- * Option for specifying the Azure Search API key.
- * Required for authentication with Azure Cognitive Search.
- */
-export declare const azureSearchApiKeyOption: import("commander").Option;
-/**
- * Option for specifying the Azure Search index name.
- * Required for search operations on a specific index.
- */
-export declare const azureSearchIndexNameOption: import("commander").Option;
-/**
- * Enhances a given command with AI-related options.
- *
- * This function adds the following options to the provided command:
- * - `openaiApiKey`: Azure OpenAI API key
- * - `openaiApiVersion`: Azure OpenAI API version
- * - `openaiInstance`: Azure OpenAI instance name
- * - `openaiChatDeployment`: Chat model deployment name
- * - `openaiEmbeddingDeployment`: Embedding model deployment name (if includeEmbedding is true)
- * - `azureSearchEndpoint`: Azure Search endpoint URL (if includeSearch is true)
- * - `azureSearchApiKey`: Azure Search API key (if includeSearch is true)
- * - `azureSearchIndexName`: Azure Search index name (if includeSearch is true)
- *
- * @param command - The command to which AI options will be added
- * @param args - Optional configuration for which options to include
- * @param args.includeEmbedding - Whether to include embedding deployment option
- * @param args.includeChat - Whether to include chat deployment option (defaults to true)
- * @param args.includeSearch - Whether to include Azure Search options (defaults to false)
- * @returns The enhanced command with AI options
- *
- * @example
- * ```ts
- * import { createCommand } from 'commander';
- * import { withAiOptions } from './path/to/this/file';
- *
- * const command = withAiOptions(
- *   createCommand('ai-chat')
- *     .description('Chat with AI models')
- *     .action((options) => {
- *       console.log('API Key:', options.openaiApiKey);
- *       console.log('Instance:', options.openaiInstance);
- *       console.log('Chat Deployment:', options.openaiChatDeployment);
- *     })
- * );
- * ```
- */
-export declare const withAiOptions: (command: Command, args?: Partial<{
-    includeEmbedding: boolean;
-    includeChat: boolean;
-    includeSearch: boolean;
-}>) => Command;
-export default withAiOptions;

package/dist/types/lib/ai/fusion-ai.d.ts

@@ -1,20 +0,0 @@
-import type { VectorStoreDocument } from '@equinor/fusion-framework-module-ai/lib';
-/**
- * Configuration interface for Fusion AI operations
- */
-export interface FusionAIConfig {
-    patterns?: string[];
-    /** Metadata processing configuration */
-    metadata?: {
-        /** Custom metadata processors to transform metadata before embedding */
-        attributeProcessor?: (metadata: Record<string, any>, document: VectorStoreDocument) => Record<string, any>;
-    };
-    /** Embedding generation configuration */
-    embedding?: {
-        /** Size of text chunks for embedding */
-        chunkSize?: number;
-        /** Overlap between chunks */
-        chunkOverlap?: number;
-    };
-}
-export declare const configureFusionAI: (fn: () => Promise<FusionAIConfig> | FusionAIConfig) => () => Promise<FusionAIConfig> | FusionAIConfig;

package/dist/types/lib/ai/index.d.ts

@@ -1 +0,0 @@
-export { configureFusionAI, type FusionAIConfig } from './fusion-ai.js';