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

package/dist/esm/lib/ai/fusion-ai.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fusion-ai.js","sourceRoot":"","sources":["../../../../src/lib/ai/fusion-ai.ts"],"names":[],"mappings":"AAwBA,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,EAAkD,EAAE,EAAE,CAAC,EAAE,CAAC"}

package/dist/esm/lib/ai/index.js

@@ -1,2 +1,2 @@
-export { configureFusionAI } from '../fusion-ai.js';
+export { configureFusionAI } from './fusion-ai.js';
 //# sourceMappingURL=index.js.map

package/dist/esm/lib/ai/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/lib/ai/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAuB,MAAM,iBAAiB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/lib/ai/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAuB,MAAM,gBAAgB,CAAC"}

package/dist/esm/version.js

@@ -1,3 +1,3 @@
 // Generated by genversion.
-export const version = '13.0.0-cli-search-index.1';
+export const version = '13.0.0-cli-search-index.3';
 //# sourceMappingURL=version.js.map

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

@@ -6,6 +6,7 @@
  * Features:
  * - Interactive chat with AI models
  * - Document embedding and chunking utilities
+ * - Vector store search for validating embeddings
  * - Configure ai clients
  * - Test model connections
  * - Manage API keys and settings
@@ -16,12 +17,14 @@
  * Subcommands:
  *   chat        Interactive chat with AI models
  *   embeddings  Document embedding utilities for ai processing
+ *   search      Search the vector store to validate embeddings
  *
  * Examples:
  *   $ ffc ai chat
  *   $ ffc ai chat --model gpt-4 --api-key sk-...
  *   $ ffc ai embeddings --dry-run ./src
  *   $ ffc ai embeddings --chunk-size 1000 ./docs/readme.md
+ *   $ ffc ai search "how to use the framework"
  */
 export declare const command: import("commander").Command;
 export default command;

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

@@ -0,0 +1,48 @@
+/**
+ * CLI command: `ai search`
+ *
+ * Search the vector store to validate embeddings and retrieve relevant documents.
+ *
+ * Features:
+ * - Semantic search using vector embeddings
+ * - Configurable result limits
+ * - Filter support for metadata-based filtering
+ * - JSON output option for programmatic use
+ * - Detailed result display with scores and metadata
+ *
+ * Usage:
+ *   $ ffc ai search <query> [options]
+ *
+ * Options:
+ *   --limit <number>                    Maximum number of results to return (default: 10)
+ *   --filter <expression>               OData filter expression for metadata filtering
+ *   --json                              Output results as JSON
+ *   --raw                               Output raw metadata without normalization
+ *   --verbose                           Enable verbose output
+ *   --openai-api-key <key>              API key for Azure OpenAI
+ *   --openai-api-version <version>      API version (default: 2024-02-15-preview)
+ *   --openai-instance <name>            Azure OpenAI instance name
+ *   --openai-embedding-deployment <name> Azure OpenAI embedding deployment name
+ *   --azure-search-endpoint <url>       Azure Search endpoint URL
+ *   --azure-search-api-key <key>        Azure Search API key
+ *   --azure-search-index-name <name>    Azure Search index name
+ *
+ * Environment Variables:
+ *   AZURE_OPENAI_API_KEY                    API key for Azure OpenAI
+ *   AZURE_OPENAI_API_VERSION                API version
+ *   AZURE_OPENAI_INSTANCE_NAME              Instance name
+ *   AZURE_OPENAI_EMBEDDING_DEPLOYMENT_NAME  Embedding deployment name
+ *   AZURE_SEARCH_ENDPOINT                   Azure Search endpoint
+ *   AZURE_SEARCH_API_KEY                    Azure Search API key
+ *   AZURE_SEARCH_INDEX_NAME                 Azure Search index name
+ *
+ * Examples:
+ *   $ ffc ai search "how to use the framework"
+ *   $ ffc ai search "authentication" --limit 5
+ *   $ ffc ai search "typescript" --filter "metadata/source eq 'src/index.ts'"
+ *   $ ffc ai search "documentation" --json
+ *   $ ffc ai search "documentation" --json --raw
+ *   $ ffc ai search "API reference" --verbose
+ */
+export declare const command: import("commander").Command;
+export default command;

package/dist/types/cli/commands/ai/utils/generate-cunk-id.d.ts

@@ -1 +1,8 @@
+/**
+ * Generates a unique identifier for a document chunk based on file path
+ * Creates a deterministic, URL-safe hash from the file path for validation and checks
+ * @param filePath - The file path to generate an ID from
+ * @param chunkIndex - Optional chunk index to append for multi-chunk documents
+ * @returns A base64-encoded hash of the file path, optionally suffixed with chunk index
+ */
 export declare const generateChunkId: (filePath: string, chunkIndex?: number) => string;

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

@@ -0,0 +1,21 @@
+import type { ChangedFile, GitDiffOptions } from './types.js';
+/**
+ * Get list of changed files using git diff with status
+ * @param options - Git diff configuration options
+ * @returns Array of changed files with their status
+ */
+export declare const getChangedFiles: (options: GitDiffOptions) => Promise<ChangedFile[]>;
+/**
+ * Determine the git status of a file, including handling renames
+ * Returns an array of ChangedFile objects - if the file was renamed, returns both old and new paths
+ * @param filePath - Absolute file path to check
+ * @returns Promise resolving to array of changed files (1 or 2 items if renamed)
+ */
+export declare const getFileStatus: (filePath: string) => Promise<ChangedFile[]>;
+/**
+ * Check if a file path matches any of the changed files
+ * @param filePath - File path to check
+ * @param changedFiles - Array of changed file objects
+ * @returns True if file has changed
+ */
+export declare const isFileChanged: (filePath: string, changedFiles: ChangedFile[]) => boolean;

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

@@ -0,0 +1,17 @@
+import { type SimpleGit } from 'simple-git';
+/**
+ * Resolve the project root (git repository root) for a given file path
+ * @param filePath - File path to resolve from
+ * @returns Project root path or undefined if not in a git repository
+ */
+export declare const resolveProjectRoot: (filePath: string) => string | undefined;
+/**
+ * Get or create a SimpleGit instance for a given file path
+ * Uses caching to avoid creating multiple instances for the same repository
+ * @param filePath - File path to get git instance for
+ * @returns Git instance and repository path, or undefined if not in a git repository
+ */
+export declare const getGit: (filePath: string) => {
+    git: SimpleGit | undefined;
+    gitRepoPath: string;
+} | undefined;

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

@@ -0,0 +1,5 @@
+export type { GitMetadata, GitDiffOptions, FileChangeStatus, ChangedFile, } from './types.js';
+export { resolveProjectRoot, getGit } from './git-client.js';
+export { extractGitMetadata } from './metadata.js';
+export { getChangedFiles, getFileStatus, isFileChanged } from './file-changes.js';
+export { getGitStatus } from './status.js';

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

@@ -0,0 +1,7 @@
+import type { GitMetadata } from './types.js';
+/**
+ * Extract git metadata for a file
+ * @param filePath - Absolute file path
+ * @returns Git metadata or undefined if not in a git repository
+ */
+export declare const extractGitMetadata: (filePath: string) => Promise<GitMetadata | undefined>;

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

@@ -0,0 +1,12 @@
+/**
+ * Get git status information for debugging
+ * @param cwd - Working directory
+ * @returns Git status information
+ */
+export declare const getGitStatus: (cwd?: string) => Promise<{
+    branch: string;
+    commit: string;
+    hasChanges: boolean;
+    stagedFiles: number;
+    unstagedFiles: number;
+}>;

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

@@ -0,0 +1,33 @@
+/**
+ * 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

@@ -0,0 +1,2 @@
+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

@@ -0,0 +1,21 @@
+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

@@ -0,0 +1,11 @@
+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,6 +1,10 @@
-import { type IAIProvider } from '@equinor/fusion-framework-module-ai';
-import { type FusionFramework } from '../../../../bin/framework.node.js';
+import { type AIModule } from '@equinor/fusion-framework-module-ai';
 import type { AiOptions } from '../../../options/ai.js';
-export declare const setupFramework: (options: AiOptions) => Promise<FusionFramework & {
-    ai: IAIProvider;
-}>;
+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

@@ -0,0 +1,5 @@
+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

@@ -0,0 +1,28 @@
+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

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

package/dist/types/cli/commands/ai/utils/{parse-ts-doc.d.ts → ts-doc/parser.d.ts}

@@ -1,15 +1,5 @@
-import type { VectorStoreDocument, VectorStoreDocumentMetadata } from '@equinor/fusion-framework-module-ai/lib';
-import type { SourceFile } from './types.js';
-export type TypescriptMetadata = VectorStoreDocumentMetadata<{
-    type: 'tsdoc';
-    ts_kind: string;
-    ts_name: string;
-}>;
-export type TypescriptDocument = VectorStoreDocument<TypescriptMetadata>;
-export interface ParseTsDocOptions {
-    /** The project root path for generating relative paths */
-    projectRoot?: string;
-}
+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.

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

@@ -0,0 +1,20 @@
+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,5 +1,7 @@
+export type FileStatus = 'new' | 'modified' | 'removed';
 export type SourceFile = {
     path: string;
     projectRoot?: string;
     relativePath?: string;
+    status: FileStatus;
 };

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

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

package/dist/types/version.d.ts

@@ -1 +1 @@
-export declare const version = "13.0.0-cli-search-index.1";
+export declare const version = "13.0.0-cli-search-index.3";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@equinor/fusion-framework-cli",
-  "version": "13.0.0-cli-search-index.1",
+  "version": "13.0.0-cli-search-index.3",
   "keywords": [
     "Fusion",
     "Fusion Framework",
@@ -130,8 +130,8 @@
     "zod": "^4.1.8",
     "@equinor/fusion-framework-dev-portal": "1.2.6-cli-search-index.0",
     "@equinor/fusion-framework-dev-server": "1.1.13-cli-search-index.0",
-    "@equinor/fusion-imports": "1.1.7-cli-search-index.0",
-    "@equinor/fusion-framework-module-msal-node": "2.0.1-cli-search-index.0"
+    "@equinor/fusion-framework-module-msal-node": "2.0.1-cli-search-index.0",
+    "@equinor/fusion-imports": "1.1.7-cli-search-index.0"
   },
   "devDependencies": {
     "@rollup/plugin-commonjs": "^29.0.0",
@@ -154,11 +154,11 @@
     "type-fest": "^5.0.0",
     "typescript": "^5.8.2",
     "vitest": "^3.2.4",
+    "@equinor/fusion-framework-module-app": "7.1.1-cli-search-index.0",
+    "@equinor/fusion-framework-module-http": "7.0.6-cli-search-index.0",
     "@equinor/fusion-framework-module": "5.0.6-cli-search-index.0",
-    "@equinor/fusion-framework-module-ai": "1.1.0-cli-search-index.0",
     "@equinor/fusion-framework-module-service-discovery": "9.0.5-cli-search-index.0",
-    "@equinor/fusion-framework-module-app": "7.1.1-cli-search-index.0",
-    "@equinor/fusion-framework-module-http": "7.0.6-cli-search-index.0"
+    "@equinor/fusion-framework-module-ai": "1.1.0-cli-search-index.0"
   },
   "peerDependenciesMeta": {
     "typescript": {

package/dist/esm/lib/fusion-ai.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"fusion-ai.js","sourceRoot":"","sources":["../../../src/lib/fusion-ai.ts"],"names":[],"mappings":"AAwBA,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,EAAkD,EAAE,EAAE,CAAC,EAAE,CAAC"}

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

@@ -1,49 +0,0 @@
-import { type SimpleGit } from 'simple-git';
-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;
-}
-export declare const resolveProjectRoot: (filePath: string) => string | undefined;
-export declare const getGit: (filePath: string) => {
-    git: SimpleGit | undefined;
-    gitRepoPath: string;
-} | undefined;
-export declare const extractGitMetadata: (filePath: string) => Promise<GitMetadata | undefined>;
-/**
- * Get list of changed files using git diff
- * @param options - Git diff configuration options
- * @returns Array of changed file paths
- */
-export declare const getChangedFiles: (options: GitDiffOptions) => Promise<string[]>;
-/**
- * Check if a file path matches any of the changed files
- * @param filePath - File path to check
- * @param changedFiles - Array of changed file paths
- * @returns True if file has changed
- */
-export declare const isFileChanged: (filePath: string, changedFiles: string[]) => boolean;
-/**
- * Get git status information for debugging
- * @param cwd - Working directory
- * @returns Git status information
- */
-export declare const getGitStatus: (cwd?: string) => Promise<{
-    branch: string;
-    commit: string;
-    hasChanges: boolean;
-    stagedFiles: number;
-    unstagedFiles: number;
-}>;

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

@@ -1,9 +0,0 @@
-import type { VectorStoreDocument, VectorStoreDocumentMetadata } from '@equinor/fusion-framework-module-ai/lib';
-import type { SourceFile } from './types.js';
-export type MarkdownMetadata<T extends Record<string, unknown> = Record<string, unknown>> = VectorStoreDocumentMetadata<T & {
-    type: 'markdown';
-}>;
-export type MarkdownDocument<T extends Record<string, unknown> = Record<string, unknown>> = VectorStoreDocument<MarkdownMetadata<T>>;
-export declare const isMarkdownFile: (filePath: string) => boolean;
-export declare const parseMarkdown: <T extends Record<string, unknown> = Record<string, unknown>>(content: string, source: string) => Promise<MarkdownDocument<T>[]>;
-export declare const parseMarkdownFile: <T extends Record<string, unknown> = Record<string, unknown>>(file: SourceFile) => Promise<MarkdownDocument<T>[]>;