promidas 2.0.0

package/dist/repository/index.d.ts

@@ -0,0 +1,122 @@
+/**
+ * Repository module - Type definitions and implementation class.
+ *
+ * This module provides type definitions for the in-memory repository pattern
+ * managing ProtoPedia prototype data with automatic TTL management.
+ *
+ * ## What This Module Exports
+ *
+ * - **Type definitions**: {@link ProtopediaInMemoryRepository}, {@link NormalizedPrototype}, etc.
+ * - **Implementation class**: {@link ProtopediaInMemoryRepositoryImpl} (for advanced use)
+ * - **Re-exported types**: Logger, LogLevel, StoreConfig for convenience
+ *
+ * ## Usage
+ *
+ * See [Getting Started Guide](https://f88.github.io/promidas/getting-started.html)
+ * for usage examples and API documentation.
+ *
+ * @module
+ * @see {@link ProtopediaInMemoryRepository} for the repository interface
+ * @see https://f88.github.io/promidas/ for complete documentation
+ */
+/**
+ * Core data type used by the repository.
+ *
+ * Re-exported from types module for convenience when using the repository standalone.
+ *
+ * @example
+ * ```typescript
+ * import type { NormalizedPrototype } from 'promidas/repository';
+ *
+ * const prototypes: NormalizedPrototype[] = await repository.getAllFromSnapshot();
+ * ```
+ */
+export type { NormalizedPrototype } from '../types/index.js';
+/**
+ * Logger types for custom logger configuration.
+ *
+ * Re-exported from logger module for convenience.
+ *
+ * @example
+ * ```typescript
+ * import type { Logger } from 'promidas/repository';
+ *
+ * const customLogger: Logger = {
+ *   debug: (msg) => console.debug(msg),
+ *   info: (msg) => console.info(msg),
+ *   warn: (msg) => console.warn(msg),
+ *   error: (msg) => console.error(msg),
+ * };
+ * ```
+ */
+export type { Logger, LogLevel } from '../logger/index.js';
+/**
+ * Statistics about the current in-memory snapshot.
+ *
+ * Provides metadata about the snapshot including size, creation time,
+ * expiration status, and TTL configuration.
+ *
+ * Re-exported from {@link PrototypeInMemoryStats} for convenience.
+ *
+ * @example
+ * ```typescript
+ * const stats = await repository.getStats();
+ * console.log(`Snapshot contains ${stats.size} prototypes`);
+ * console.log(`Expires: ${stats.expiresAt ? 'Yes' : 'Never'}`);
+ * ```
+ */
+export type { PrototypeInMemoryStats as ProtopediaInMemoryRepositoryStats } from '../store/index.js';
+/**
+ * Configuration options for the in-memory store.
+ *
+ * Re-exported from the store module for convenience.
+ *
+ * @example
+ * ```typescript
+ * import type { PrototypeInMemoryStoreConfig } from 'promidas/repository';
+ *
+ * const storeConfig: PrototypeInMemoryStoreConfig = {
+ *   ttlMs: 30 * 60 * 1000,
+ *   maxDataSizeBytes: 10 * 1024 * 1024,
+ *   logLevel: 'info'
+ * };
+ * ```
+ */
+export type { PrototypeInMemoryStoreConfig } from '../store/index.js';
+/**
+ * Type definitions for repository operations and results.
+ *
+ * Exports all type definitions used by the repository interface:
+ *
+ * - {@link ProtopediaInMemoryRepository} - Main repository interface
+ * - {@link ProtopediaInMemoryRepositoryConfig} - Repository configuration options
+ * - {@link RepositoryEvents} - Event types for snapshot operations (Issue #19)
+ * - {@link SnapshotOperationResult} - Result type for setup/refresh operations
+ * - {@link SnapshotOperationSuccess} - Success variant with metadata
+ * - {@link SnapshotOperationFailure} - Failure variant with error details
+ * - {@link PrototypeAnalysisResult} - Statistical analysis result type
+ */
+export type { ProtopediaInMemoryRepository, ProtopediaInMemoryRepositoryConfig, RepositoryEvents, PrototypeAnalysisResult, SnapshotOperationResult, SnapshotOperationSuccess, SnapshotOperationFailure, } from './types/index.js';
+/**
+ * Validation error thrown when invalid arguments are provided.
+ *
+ * This error is thrown by repository methods when arguments fail validation.
+ * It wraps internal validation errors to provide a consistent error interface.
+ *
+ * @see {@link ProtopediaInMemoryRepository.getPrototypeFromSnapshotByPrototypeId}
+ * @see {@link ProtopediaInMemoryRepository.getRandomSampleFromSnapshot}
+ */
+export { ValidationError } from './errors/validation-error.js';
+/**
+ * Implementation class for the in-memory repository.
+ *
+ * This is the concrete implementation of {@link ProtopediaInMemoryRepository}.
+ * Exported for testing purposes and type inspection.
+ *
+ * **Note**: For normal usage, import from `promidas` instead.
+ * See module documentation for usage examples.
+ *
+ * @see {@link ProtopediaInMemoryRepository} for the interface definition
+ */
+export { ProtopediaInMemoryRepositoryImpl } from './protopedia-in-memory-repository.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/repository/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../lib/repository/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AAEH;;;;;;;;;;;GAWG;AACH,YAAY,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAC;AAE7D;;;;;;;;;;;;;;;;GAgBG;AACH,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAE3D;;;;;;;;;;;;;;GAcG;AACH,YAAY,EAAE,sBAAsB,IAAI,iCAAiC,EAAE,MAAM,mBAAmB,CAAC;AAErG;;;;;;;;;;;;;;;GAeG;AACH,YAAY,EAAE,4BAA4B,EAAE,MAAM,mBAAmB,CAAC;AAEtE;;;;;;;;;;;;GAYG;AACH,YAAY,EACV,4BAA4B,EAC5B,kCAAkC,EAClC,gBAAgB,EAChB,uBAAuB,EACvB,uBAAuB,EACvB,wBAAwB,EACxB,wBAAwB,GACzB,MAAM,kBAAkB,CAAC;AAE1B;;;;;;;;GAQG;AACH,OAAO,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AAE/D;;;;;;;;;;GAUG;AACH,OAAO,EAAE,gCAAgC,EAAE,MAAM,sCAAsC,CAAC"}

package/dist/repository/index.js

@@ -0,0 +1,44 @@
+/**
+ * Repository module - Type definitions and implementation class.
+ *
+ * This module provides type definitions for the in-memory repository pattern
+ * managing ProtoPedia prototype data with automatic TTL management.
+ *
+ * ## What This Module Exports
+ *
+ * - **Type definitions**: {@link ProtopediaInMemoryRepository}, {@link NormalizedPrototype}, etc.
+ * - **Implementation class**: {@link ProtopediaInMemoryRepositoryImpl} (for advanced use)
+ * - **Re-exported types**: Logger, LogLevel, StoreConfig for convenience
+ *
+ * ## Usage
+ *
+ * See [Getting Started Guide](https://f88.github.io/promidas/getting-started.html)
+ * for usage examples and API documentation.
+ *
+ * @module
+ * @see {@link ProtopediaInMemoryRepository} for the repository interface
+ * @see https://f88.github.io/promidas/ for complete documentation
+ */
+/**
+ * Validation error thrown when invalid arguments are provided.
+ *
+ * This error is thrown by repository methods when arguments fail validation.
+ * It wraps internal validation errors to provide a consistent error interface.
+ *
+ * @see {@link ProtopediaInMemoryRepository.getPrototypeFromSnapshotByPrototypeId}
+ * @see {@link ProtopediaInMemoryRepository.getRandomSampleFromSnapshot}
+ */
+export { ValidationError } from './errors/validation-error.js';
+/**
+ * Implementation class for the in-memory repository.
+ *
+ * This is the concrete implementation of {@link ProtopediaInMemoryRepository}.
+ * Exported for testing purposes and type inspection.
+ *
+ * **Note**: For normal usage, import from `promidas` instead.
+ * See module documentation for usage examples.
+ *
+ * @see {@link ProtopediaInMemoryRepository} for the interface definition
+ */
+export { ProtopediaInMemoryRepositoryImpl } from './protopedia-in-memory-repository.js';
+//# sourceMappingURL=index.js.map

package/dist/repository/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../lib/repository/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AA6FH;;;;;;;;GAQG;AACH,OAAO,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AAE/D;;;;;;;;;;GAUG;AACH,OAAO,EAAE,gCAAgC,EAAE,MAAM,sCAAsC,CAAC"}