bluera-knowledge 0.14.0 → 0.14.1

package/src/types/store-definition.test.ts

@@ -1,492 +0,0 @@
-import { describe, it, expect } from 'vitest';
-import {
-  FileStoreDefinitionSchema,
-  RepoStoreDefinitionSchema,
-  WebStoreDefinitionSchema,
-  StoreDefinitionSchema,
-  StoreDefinitionsConfigSchema,
-  isFileStoreDefinition,
-  isRepoStoreDefinition,
-  isWebStoreDefinition,
-} from './store-definition.js';
-
-describe('Store Definition Types', () => {
-  describe('FileStoreDefinitionSchema', () => {
-    it('validates a valid file store definition', () => {
-      const valid = {
-        type: 'file',
-        name: 'my-docs',
-        path: './docs',
-      };
-      const result = FileStoreDefinitionSchema.safeParse(valid);
-      expect(result.success).toBe(true);
-      if (result.success) {
-        expect(result.data.type).toBe('file');
-        expect(result.data.name).toBe('my-docs');
-        expect(result.data.path).toBe('./docs');
-      }
-    });
-
-    it('validates file store with optional fields', () => {
-      const valid = {
-        type: 'file',
-        name: 'my-docs',
-        path: './docs',
-        description: 'Local documentation',
-        tags: ['docs', 'reference'],
-      };
-      const result = FileStoreDefinitionSchema.safeParse(valid);
-      expect(result.success).toBe(true);
-      if (result.success) {
-        expect(result.data.description).toBe('Local documentation');
-        expect(result.data.tags).toEqual(['docs', 'reference']);
-      }
-    });
-
-    it('accepts absolute paths', () => {
-      const valid = {
-        type: 'file',
-        name: 'absolute-docs',
-        path: '/home/user/docs',
-      };
-      const result = FileStoreDefinitionSchema.safeParse(valid);
-      expect(result.success).toBe(true);
-    });
-
-    it('rejects missing name', () => {
-      const invalid = {
-        type: 'file',
-        path: './docs',
-      };
-      const result = FileStoreDefinitionSchema.safeParse(invalid);
-      expect(result.success).toBe(false);
-    });
-
-    it('rejects missing path', () => {
-      const invalid = {
-        type: 'file',
-        name: 'my-docs',
-      };
-      const result = FileStoreDefinitionSchema.safeParse(invalid);
-      expect(result.success).toBe(false);
-    });
-
-    it('rejects empty name', () => {
-      const invalid = {
-        type: 'file',
-        name: '',
-        path: './docs',
-      };
-      const result = FileStoreDefinitionSchema.safeParse(invalid);
-      expect(result.success).toBe(false);
-    });
-
-    it('rejects empty path', () => {
-      const invalid = {
-        type: 'file',
-        name: 'my-docs',
-        path: '',
-      };
-      const result = FileStoreDefinitionSchema.safeParse(invalid);
-      expect(result.success).toBe(false);
-    });
-  });
-
-  describe('RepoStoreDefinitionSchema', () => {
-    it('validates a valid repo store definition', () => {
-      const valid = {
-        type: 'repo',
-        name: 'react',
-        url: 'https://github.com/facebook/react',
-      };
-      const result = RepoStoreDefinitionSchema.safeParse(valid);
-      expect(result.success).toBe(true);
-      if (result.success) {
-        expect(result.data.type).toBe('repo');
-        expect(result.data.name).toBe('react');
-        expect(result.data.url).toBe('https://github.com/facebook/react');
-      }
-    });
-
-    it('validates repo store with optional branch', () => {
-      const valid = {
-        type: 'repo',
-        name: 'react',
-        url: 'https://github.com/facebook/react',
-        branch: 'main',
-      };
-      const result = RepoStoreDefinitionSchema.safeParse(valid);
-      expect(result.success).toBe(true);
-      if (result.success) {
-        expect(result.data.branch).toBe('main');
-      }
-    });
-
-    it('validates repo store with optional depth', () => {
-      const valid = {
-        type: 'repo',
-        name: 'react',
-        url: 'https://github.com/facebook/react',
-        depth: 1,
-      };
-      const result = RepoStoreDefinitionSchema.safeParse(valid);
-      expect(result.success).toBe(true);
-      if (result.success) {
-        expect(result.data.depth).toBe(1);
-      }
-    });
-
-    it('validates repo store with all optional fields', () => {
-      const valid = {
-        type: 'repo',
-        name: 'react',
-        url: 'https://github.com/facebook/react',
-        branch: 'develop',
-        depth: 2,
-        description: 'React library source',
-        tags: ['frontend', 'ui'],
-      };
-      const result = RepoStoreDefinitionSchema.safeParse(valid);
-      expect(result.success).toBe(true);
-    });
-
-    it('rejects invalid URL', () => {
-      const invalid = {
-        type: 'repo',
-        name: 'react',
-        url: 'not-a-valid-url',
-      };
-      const result = RepoStoreDefinitionSchema.safeParse(invalid);
-      expect(result.success).toBe(false);
-    });
-
-    it('rejects missing URL', () => {
-      const invalid = {
-        type: 'repo',
-        name: 'react',
-      };
-      const result = RepoStoreDefinitionSchema.safeParse(invalid);
-      expect(result.success).toBe(false);
-    });
-
-    it('rejects negative depth', () => {
-      const invalid = {
-        type: 'repo',
-        name: 'react',
-        url: 'https://github.com/facebook/react',
-        depth: -1,
-      };
-      const result = RepoStoreDefinitionSchema.safeParse(invalid);
-      expect(result.success).toBe(false);
-    });
-
-    it('rejects zero depth', () => {
-      const invalid = {
-        type: 'repo',
-        name: 'react',
-        url: 'https://github.com/facebook/react',
-        depth: 0,
-      };
-      const result = RepoStoreDefinitionSchema.safeParse(invalid);
-      expect(result.success).toBe(false);
-    });
-  });
-
-  describe('WebStoreDefinitionSchema', () => {
-    it('validates a valid web store definition with default depth', () => {
-      const valid = {
-        type: 'web',
-        name: 'docs',
-        url: 'https://example.com/docs',
-      };
-      const result = WebStoreDefinitionSchema.safeParse(valid);
-      expect(result.success).toBe(true);
-      if (result.success) {
-        expect(result.data.type).toBe('web');
-        expect(result.data.name).toBe('docs');
-        expect(result.data.url).toBe('https://example.com/docs');
-        expect(result.data.depth).toBe(1); // default
-      }
-    });
-
-    it('validates web store with custom depth', () => {
-      const valid = {
-        type: 'web',
-        name: 'docs',
-        url: 'https://example.com/docs',
-        depth: 3,
-      };
-      const result = WebStoreDefinitionSchema.safeParse(valid);
-      expect(result.success).toBe(true);
-      if (result.success) {
-        expect(result.data.depth).toBe(3);
-      }
-    });
-
-    it('validates web store with maxPages', () => {
-      const valid = {
-        type: 'web',
-        name: 'docs',
-        url: 'https://example.com/docs',
-        maxPages: 100,
-      };
-      const result = WebStoreDefinitionSchema.safeParse(valid);
-      expect(result.success).toBe(true);
-      if (result.success) {
-        expect(result.data.maxPages).toBe(100);
-      }
-    });
-
-    it('validates web store with crawl instructions', () => {
-      const valid = {
-        type: 'web',
-        name: 'docs',
-        url: 'https://example.com/docs',
-        crawlInstructions: 'Focus on API reference pages',
-      };
-      const result = WebStoreDefinitionSchema.safeParse(valid);
-      expect(result.success).toBe(true);
-      if (result.success) {
-        expect(result.data.crawlInstructions).toBe('Focus on API reference pages');
-      }
-    });
-
-    it('validates web store with extract instructions', () => {
-      const valid = {
-        type: 'web',
-        name: 'docs',
-        url: 'https://example.com/docs',
-        extractInstructions: 'Extract code examples and signatures',
-      };
-      const result = WebStoreDefinitionSchema.safeParse(valid);
-      expect(result.success).toBe(true);
-      if (result.success) {
-        expect(result.data.extractInstructions).toBe('Extract code examples and signatures');
-      }
-    });
-
-    it('validates web store with all optional fields', () => {
-      const valid = {
-        type: 'web',
-        name: 'typescript-docs',
-        url: 'https://www.typescriptlang.org/docs/',
-        depth: 2,
-        maxPages: 100,
-        crawlInstructions: 'Focus on handbook pages',
-        extractInstructions: 'Extract code examples',
-        description: 'TypeScript documentation',
-        tags: ['docs', 'typescript'],
-      };
-      const result = WebStoreDefinitionSchema.safeParse(valid);
-      expect(result.success).toBe(true);
-    });
-
-    it('allows depth of 0 for single page', () => {
-      const valid = {
-        type: 'web',
-        name: 'single-page',
-        url: 'https://example.com/page',
-        depth: 0,
-      };
-      const result = WebStoreDefinitionSchema.safeParse(valid);
-      expect(result.success).toBe(true);
-    });
-
-    it('rejects invalid URL', () => {
-      const invalid = {
-        type: 'web',
-        name: 'docs',
-        url: 'not-a-valid-url',
-      };
-      const result = WebStoreDefinitionSchema.safeParse(invalid);
-      expect(result.success).toBe(false);
-    });
-
-    it('rejects negative depth', () => {
-      const invalid = {
-        type: 'web',
-        name: 'docs',
-        url: 'https://example.com/docs',
-        depth: -1,
-      };
-      const result = WebStoreDefinitionSchema.safeParse(invalid);
-      expect(result.success).toBe(false);
-    });
-
-    it('rejects negative maxPages', () => {
-      const invalid = {
-        type: 'web',
-        name: 'docs',
-        url: 'https://example.com/docs',
-        maxPages: -1,
-      };
-      const result = WebStoreDefinitionSchema.safeParse(invalid);
-      expect(result.success).toBe(false);
-    });
-
-    it('rejects zero maxPages', () => {
-      const invalid = {
-        type: 'web',
-        name: 'docs',
-        url: 'https://example.com/docs',
-        maxPages: 0,
-      };
-      const result = WebStoreDefinitionSchema.safeParse(invalid);
-      expect(result.success).toBe(false);
-    });
-  });
-
-  describe('StoreDefinitionSchema (discriminated union)', () => {
-    it('parses file store definition', () => {
-      const def = { type: 'file', name: 'docs', path: './docs' };
-      const result = StoreDefinitionSchema.safeParse(def);
-      expect(result.success).toBe(true);
-      if (result.success) {
-        expect(result.data.type).toBe('file');
-      }
-    });
-
-    it('parses repo store definition', () => {
-      const def = { type: 'repo', name: 'lib', url: 'https://github.com/org/lib' };
-      const result = StoreDefinitionSchema.safeParse(def);
-      expect(result.success).toBe(true);
-      if (result.success) {
-        expect(result.data.type).toBe('repo');
-      }
-    });
-
-    it('parses web store definition', () => {
-      const def = { type: 'web', name: 'docs', url: 'https://docs.example.com' };
-      const result = StoreDefinitionSchema.safeParse(def);
-      expect(result.success).toBe(true);
-      if (result.success) {
-        expect(result.data.type).toBe('web');
-      }
-    });
-
-    it('rejects unknown type', () => {
-      const def = { type: 'unknown', name: 'test' };
-      const result = StoreDefinitionSchema.safeParse(def);
-      expect(result.success).toBe(false);
-    });
-
-    it('rejects missing type', () => {
-      const def = { name: 'test', path: './test' };
-      const result = StoreDefinitionSchema.safeParse(def);
-      expect(result.success).toBe(false);
-    });
-  });
-
-  describe('StoreDefinitionsConfigSchema', () => {
-    it('validates empty config', () => {
-      const config = { version: 1, stores: [] };
-      const result = StoreDefinitionsConfigSchema.safeParse(config);
-      expect(result.success).toBe(true);
-    });
-
-    it('validates config with multiple stores', () => {
-      const config = {
-        version: 1,
-        stores: [
-          { type: 'file', name: 'docs', path: './docs' },
-          { type: 'repo', name: 'react', url: 'https://github.com/facebook/react' },
-          { type: 'web', name: 'api-docs', url: 'https://api.example.com/docs' },
-        ],
-      };
-      const result = StoreDefinitionsConfigSchema.safeParse(config);
-      expect(result.success).toBe(true);
-      if (result.success) {
-        expect(result.data.stores).toHaveLength(3);
-      }
-    });
-
-    it('rejects missing version', () => {
-      const config = { stores: [] };
-      const result = StoreDefinitionsConfigSchema.safeParse(config);
-      expect(result.success).toBe(false);
-    });
-
-    it('rejects wrong version', () => {
-      const config = { version: 2, stores: [] };
-      const result = StoreDefinitionsConfigSchema.safeParse(config);
-      expect(result.success).toBe(false);
-    });
-
-    it('rejects missing stores array', () => {
-      const config = { version: 1 };
-      const result = StoreDefinitionsConfigSchema.safeParse(config);
-      expect(result.success).toBe(false);
-    });
-
-    it('rejects invalid store in array', () => {
-      const config = {
-        version: 1,
-        stores: [
-          { type: 'file', name: 'docs', path: './docs' },
-          { type: 'invalid', name: 'bad' },
-        ],
-      };
-      const result = StoreDefinitionsConfigSchema.safeParse(config);
-      expect(result.success).toBe(false);
-    });
-  });
-
-  describe('Type guard functions', () => {
-    describe('isFileStoreDefinition', () => {
-      it('returns true for file store definition', () => {
-        const def = StoreDefinitionSchema.parse({ type: 'file', name: 'docs', path: './docs' });
-        expect(isFileStoreDefinition(def)).toBe(true);
-      });
-
-      it('returns false for repo store definition', () => {
-        const def = StoreDefinitionSchema.parse({
-          type: 'repo',
-          name: 'lib',
-          url: 'https://github.com/org/lib',
-        });
-        expect(isFileStoreDefinition(def)).toBe(false);
-      });
-
-      it('returns false for web store definition', () => {
-        const def = StoreDefinitionSchema.parse({
-          type: 'web',
-          name: 'docs',
-          url: 'https://docs.example.com',
-        });
-        expect(isFileStoreDefinition(def)).toBe(false);
-      });
-    });
-
-    describe('isRepoStoreDefinition', () => {
-      it('returns true for repo store definition', () => {
-        const def = StoreDefinitionSchema.parse({
-          type: 'repo',
-          name: 'lib',
-          url: 'https://github.com/org/lib',
-        });
-        expect(isRepoStoreDefinition(def)).toBe(true);
-      });
-
-      it('returns false for file store definition', () => {
-        const def = StoreDefinitionSchema.parse({ type: 'file', name: 'docs', path: './docs' });
-        expect(isRepoStoreDefinition(def)).toBe(false);
-      });
-    });
-
-    describe('isWebStoreDefinition', () => {
-      it('returns true for web store definition', () => {
-        const def = StoreDefinitionSchema.parse({
-          type: 'web',
-          name: 'docs',
-          url: 'https://docs.example.com',
-        });
-        expect(isWebStoreDefinition(def)).toBe(true);
-      });
-
-      it('returns false for file store definition', () => {
-        const def = StoreDefinitionSchema.parse({ type: 'file', name: 'docs', path: './docs' });
-        expect(isWebStoreDefinition(def)).toBe(false);
-      });
-    });
-  });
-});

package/src/types/store-definition.ts

@@ -1,129 +0,0 @@
-import { z } from 'zod';
-
-/**
- * Store definition schemas for git-committable configuration.
- *
- * Store definitions capture the essential information needed to recreate
- * a store, without the runtime data (vector embeddings, cloned repos).
- * This allows teams to share store configurations via version control.
- */
-
-// ============================================================================
-// Base Schema
-// ============================================================================
-
-/**
- * Base fields common to all store definitions
- */
-const BaseStoreDefinitionSchema = z.object({
-  name: z.string().min(1, 'Store name is required'),
-  description: z.string().optional(),
-  tags: z.array(z.string()).optional(),
-});
-
-// ============================================================================
-// File Store Definition
-// ============================================================================
-
-/**
- * File store definition - references a local directory.
- * Path can be relative (resolved against project root) or absolute.
- */
-export const FileStoreDefinitionSchema = BaseStoreDefinitionSchema.extend({
-  type: z.literal('file'),
-  path: z.string().min(1, 'Path is required for file stores'),
-});
-
-export type FileStoreDefinition = z.infer<typeof FileStoreDefinitionSchema>;
-
-// ============================================================================
-// Repo Store Definition
-// ============================================================================
-
-/**
- * Repo store definition - references a git repository.
- * The repo will be cloned on sync.
- */
-export const RepoStoreDefinitionSchema = BaseStoreDefinitionSchema.extend({
-  type: z.literal('repo'),
-  url: z.url('Valid URL is required for repo stores'),
-  branch: z.string().optional(),
-  depth: z.number().int().positive('Depth must be a positive integer').optional(),
-});
-
-export type RepoStoreDefinition = z.infer<typeof RepoStoreDefinitionSchema>;
-
-// ============================================================================
-// Web Store Definition
-// ============================================================================
-
-/**
- * Web store definition - references a website to crawl.
- * Supports intelligent crawling with natural language instructions.
- */
-export const WebStoreDefinitionSchema = BaseStoreDefinitionSchema.extend({
-  type: z.literal('web'),
-  url: z.url('Valid URL is required for web stores'),
-  depth: z.number().int().min(0, 'Depth must be non-negative').default(1),
-  maxPages: z.number().int().positive('maxPages must be a positive integer').optional(),
-  crawlInstructions: z.string().optional(),
-  extractInstructions: z.string().optional(),
-});
-
-export type WebStoreDefinition = z.infer<typeof WebStoreDefinitionSchema>;
-
-// ============================================================================
-// Union Type
-// ============================================================================
-
-/**
- * Discriminated union of all store definition types.
- * Use the `type` field to narrow the type.
- */
-export const StoreDefinitionSchema = z.discriminatedUnion('type', [
-  FileStoreDefinitionSchema,
-  RepoStoreDefinitionSchema,
-  WebStoreDefinitionSchema,
-]);
-
-export type StoreDefinition = z.infer<typeof StoreDefinitionSchema>;
-
-// ============================================================================
-// Config Schema
-// ============================================================================
-
-/**
- * Root configuration schema for store definitions.
- * Version field enables future schema migrations.
- */
-export const StoreDefinitionsConfigSchema = z.object({
-  version: z.literal(1),
-  stores: z.array(StoreDefinitionSchema),
-});
-
-export type StoreDefinitionsConfig = z.infer<typeof StoreDefinitionsConfigSchema>;
-
-// ============================================================================
-// Type Guards
-// ============================================================================
-
-export function isFileStoreDefinition(def: StoreDefinition): def is FileStoreDefinition {
-  return def.type === 'file';
-}
-
-export function isRepoStoreDefinition(def: StoreDefinition): def is RepoStoreDefinition {
-  return def.type === 'repo';
-}
-
-export function isWebStoreDefinition(def: StoreDefinition): def is WebStoreDefinition {
-  return def.type === 'web';
-}
-
-// ============================================================================
-// Default Config
-// ============================================================================
-
-export const DEFAULT_STORE_DEFINITIONS_CONFIG: StoreDefinitionsConfig = {
-  version: 1,
-  stores: [],
-};

package/src/types/store.test.ts

@@ -1,69 +0,0 @@
-import { describe, it, expect } from 'vitest';
-import { isFileStore, isRepoStore, isWebStore } from './store.js';
-import type { Store, FileStore, RepoStore, WebStore } from './store.js';
-import { createStoreId } from './brands.js';
-
-describe('Store types', () => {
-  const fileStore: FileStore = {
-    type: 'file',
-    id: createStoreId('file-store'),
-    name: 'My Files',
-    path: '/path/to/files',
-    description: 'Test file store',
-    createdAt: new Date(),
-    updatedAt: new Date(),
-  };
-
-  const repoStore: RepoStore = {
-    type: 'repo',
-    id: createStoreId('repo-store'),
-    name: 'My Repo',
-    path: '/path/to/repo',
-    branch: 'main',
-    createdAt: new Date(),
-    updatedAt: new Date(),
-  };
-
-  const webStore: WebStore = {
-    type: 'web',
-    id: createStoreId('web-store'),
-    name: 'Docs Site',
-    url: 'https://docs.example.com',
-    depth: 2,
-    createdAt: new Date(),
-    updatedAt: new Date(),
-  };
-
-  describe('isFileStore', () => {
-    it('returns true for file stores', () => {
-      expect(isFileStore(fileStore)).toBe(true);
-    });
-
-    it('returns false for other store types', () => {
-      expect(isFileStore(repoStore)).toBe(false);
-      expect(isFileStore(webStore)).toBe(false);
-    });
-  });
-
-  describe('isRepoStore', () => {
-    it('returns true for repo stores', () => {
-      expect(isRepoStore(repoStore)).toBe(true);
-    });
-
-    it('returns false for other store types', () => {
-      expect(isRepoStore(fileStore)).toBe(false);
-      expect(isRepoStore(webStore)).toBe(false);
-    });
-  });
-
-  describe('isWebStore', () => {
-    it('returns true for web stores', () => {
-      expect(isWebStore(webStore)).toBe(true);
-    });
-
-    it('returns false for other store types', () => {
-      expect(isWebStore(fileStore)).toBe(false);
-      expect(isWebStore(repoStore)).toBe(false);
-    });
-  });
-});