@objectstack/core 1.0.4 → 1.0.6

package/dist/api-registry.d.ts

@@ -1,259 +0,0 @@
-import type { ApiRegistry as ApiRegistryType, ApiRegistryEntry, ApiRegistryEntryInput, ApiEndpointRegistration, ConflictResolutionStrategy, ApiDiscoveryQuery, ApiDiscoveryResponse } from '@objectstack/spec/api';
-import type { Logger } from '@objectstack/spec/contracts';
-/**
- * API Registry Service
- *
- * Central registry for managing API endpoints across different protocols.
- * Provides endpoint registration, discovery, and conflict resolution.
- *
- * **Features:**
- * - Multi-protocol support (REST, GraphQL, OData, WebSocket, etc.)
- * - Route conflict detection with configurable resolution strategies
- * - RBAC permission integration
- * - Dynamic schema linking with ObjectQL references
- * - Plugin API registration
- *
- * **Architecture Alignment:**
- * - Kubernetes: Service Discovery & API Server
- * - AWS API Gateway: Unified API Management
- * - Kong Gateway: Plugin-based API Management
- *
- * @example
- * ```typescript
- * const registry = new ApiRegistry(logger, 'priority');
- *
- * // Register an API
- * registry.registerApi({
- *   id: 'customer_api',
- *   name: 'Customer API',
- *   type: 'rest',
- *   version: 'v1',
- *   basePath: '/api/v1/customers',
- *   endpoints: [...]
- * });
- *
- * // Discover APIs
- * const apis = registry.findApis({ type: 'rest', status: 'active' });
- *
- * // Get registry snapshot
- * const snapshot = registry.getRegistry();
- * ```
- */
-export declare class ApiRegistry {
-    private apis;
-    private endpoints;
-    private routes;
-    private apisByType;
-    private apisByTag;
-    private apisByStatus;
-    private conflictResolution;
-    private logger;
-    private version;
-    private updatedAt;
-    constructor(logger: Logger, conflictResolution?: ConflictResolutionStrategy, version?: string);
-    /**
-     * Register an API with its endpoints
-     *
-     * @param api - API registry entry
-     * @throws Error if API already registered or route conflicts detected
-     */
-    registerApi(api: ApiRegistryEntryInput): void;
-    /**
-     * Unregister an API and all its endpoints
-     *
-     * @param apiId - API identifier
-     */
-    unregisterApi(apiId: string): void;
-    /**
-     * Register a single endpoint
-     *
-     * @param apiId - API identifier
-     * @param endpoint - Endpoint registration
-     * @throws Error if route conflict detected
-     */
-    private registerEndpoint;
-    /**
-     * Unregister a single endpoint
-     *
-     * @param apiId - API identifier
-     * @param endpointId - Endpoint identifier
-     */
-    private unregisterEndpoint;
-    /**
-     * Register a route with conflict detection
-     *
-     * @param apiId - API identifier
-     * @param endpoint - Endpoint registration
-     * @throws Error if route conflict detected (based on strategy)
-     */
-    private registerRoute;
-    /**
-     * Handle route conflict based on resolution strategy
-     *
-     * @param routeKey - Route key
-     * @param apiId - New API identifier
-     * @param endpoint - New endpoint
-     * @param existingRoute - Existing route registration
-     * @param newPriority - New endpoint priority
-     * @throws Error if strategy is 'error'
-     */
-    private handleRouteConflict;
-    /**
-     * Generate a unique route key for conflict detection
-     *
-     * NOTE: This implementation uses exact string matching for route conflict detection.
-     * It works well for static paths but has limitations with parameterized routes.
-     * For example, `/api/users/:id` and `/api/users/:userId` will NOT be detected as conflicts
-     * even though they are semantically identical parameterized patterns. Similarly,
-     * `/api/:resource/list` and `/api/:entity/list` would also not be detected as conflicting.
-     *
-     * For more advanced conflict detection (e.g., path-to-regexp pattern matching),
-     * consider integrating with your routing library's conflict detection mechanism.
-     *
-     * @param endpoint - Endpoint registration
-     * @returns Route key (e.g., "GET:/api/v1/customers/:id")
-     */
-    private getRouteKey;
-    /**
-     * Validate endpoint registration
-     *
-     * @param endpoint - Endpoint to validate
-     * @param apiId - API identifier (for error messages)
-     * @throws Error if endpoint is invalid
-     */
-    private validateEndpoint;
-    /**
-     * Get an API by ID
-     *
-     * @param apiId - API identifier
-     * @returns API registry entry or undefined
-     */
-    getApi(apiId: string): ApiRegistryEntry | undefined;
-    /**
-     * Get all registered APIs
-     *
-     * @returns Array of all APIs
-     */
-    getAllApis(): ApiRegistryEntry[];
-    /**
-     * Find APIs matching query criteria
-     *
-     * Performance optimized with auxiliary indices for O(1) lookups on type, tags, and status.
-     *
-     * @param query - Discovery query parameters
-     * @returns Matching APIs
-     */
-    findApis(query: ApiDiscoveryQuery): ApiDiscoveryResponse;
-    /**
-     * Get endpoint by API ID and endpoint ID
-     *
-     * @param apiId - API identifier
-     * @param endpointId - Endpoint identifier
-     * @returns Endpoint registration or undefined
-     */
-    getEndpoint(apiId: string, endpointId: string): ApiEndpointRegistration | undefined;
-    /**
-     * Find endpoint by route (method + path)
-     *
-     * @param method - HTTP method
-     * @param path - URL path
-     * @returns Endpoint registration or undefined
-     */
-    findEndpointByRoute(method: string, path: string): {
-        api: ApiRegistryEntry;
-        endpoint: ApiEndpointRegistration;
-    } | undefined;
-    /**
-     * Get complete registry snapshot
-     *
-     * @returns Current registry state
-     */
-    getRegistry(): ApiRegistryType;
-    /**
-     * Clear all registered APIs
-     *
-     * **⚠️ SAFETY WARNING:**
-     * This method clears all registered APIs and should be used with caution.
-     *
-     * **Usage Restrictions:**
-     * - In production environments (NODE_ENV=production), a `force: true` parameter is required
-     * - Primarily intended for testing and development hot-reload scenarios
-     *
-     * @param options - Clear options
-     * @param options.force - Force clear in production environment (default: false)
-     * @throws Error if called in production without force flag
-     *
-     * @example Safe usage in tests
-     * ```typescript
-     * beforeEach(() => {
-     *   registry.clear(); // OK in test environment
-     * });
-     * ```
-     *
-     * @example Usage in production (requires explicit force)
-     * ```typescript
-     * // In production, explicit force is required
-     * registry.clear({ force: true });
-     * ```
-     */
-    clear(options?: {
-        force?: boolean;
-    }): void;
-    /**
-     * Get registry statistics
-     *
-     * @returns Registry statistics
-     */
-    getStats(): {
-        totalApis: number;
-        totalEndpoints: number;
-        totalRoutes: number;
-        apisByType: Record<string, number>;
-        endpointsByApi: Record<string, number>;
-    };
-    /**
-     * Update auxiliary indices when an API is registered
-     *
-     * @param api - API entry to index
-     * @private
-     * @internal
-     */
-    private updateIndices;
-    /**
-     * Remove API from auxiliary indices when unregistered
-     *
-     * @param api - API entry to remove from indices
-     * @private
-     * @internal
-     */
-    private removeFromIndices;
-    /**
-     * Helper to ensure an index set exists and return it
-     *
-     * @param map - Index map
-     * @param key - Index key
-     * @returns The Set for this key (created if needed)
-     * @private
-     * @internal
-     */
-    private ensureIndexSet;
-    /**
-     * Helper to remove an ID from an index set and clean up empty sets
-     *
-     * @param map - Index map
-     * @param key - Index key
-     * @param id - API ID to remove
-     * @private
-     * @internal
-     */
-    private removeFromIndexSet;
-    /**
-     * Check if running in production environment
-     *
-     * @returns true if NODE_ENV is 'production'
-     * @private
-     * @internal
-     */
-    private isProductionEnvironment;
-}
-//# sourceMappingURL=api-registry.d.ts.map

package/dist/api-registry.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"api-registry.d.ts","sourceRoot":"","sources":["../src/api-registry.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,WAAW,IAAI,eAAe,EAC9B,gBAAgB,EAChB,qBAAqB,EACrB,uBAAuB,EACvB,0BAA0B,EAC1B,iBAAiB,EACjB,oBAAoB,EACrB,MAAM,uBAAuB,CAAC;AAE/B,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,6BAA6B,CAAC;AAG1D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AACH,qBAAa,WAAW;IACtB,OAAO,CAAC,IAAI,CAA4C;IACxD,OAAO,CAAC,SAAS,CAA8E;IAC/F,OAAO,CAAC,MAAM,CAAiF;IAG/F,OAAO,CAAC,UAAU,CAAuC;IACzD,OAAO,CAAC,SAAS,CAAuC;IACxD,OAAO,CAAC,YAAY,CAAuC;IAE3D,OAAO,CAAC,kBAAkB,CAA6B;IACvD,OAAO,CAAC,MAAM,CAAS;IACvB,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,SAAS,CAAS;gBAGxB,MAAM,EAAE,MAAM,EACd,kBAAkB,GAAE,0BAAoC,EACxD,OAAO,GAAE,MAAgB;IAQ3B;;;;;OAKG;IACH,WAAW,CAAC,GAAG,EAAE,qBAAqB,GAAG,IAAI;IAiC7C;;;;OAIG;IACH,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAqBlC;;;;;;OAMG;IACH,OAAO,CAAC,gBAAgB;IAiBxB;;;;;OAKG;IACH,OAAO,CAAC,kBAAkB;IAkB1B;;;;;;OAMG;IACH,OAAO,CAAC,aAAa;IAmBrB;;;;;;;;;OASG;IACH,OAAO,CAAC,mBAAmB;IA8E3B;;;;;;;;;;;;;;OAcG;IACH,OAAO,CAAC,WAAW;IAKnB;;;;;;OAMG;IACH,OAAO,CAAC,gBAAgB;IAUxB;;;;;OAKG;IACH,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,gBAAgB,GAAG,SAAS;IAInD;;;;OAIG;IACH,UAAU,IAAI,gBAAgB,EAAE;IAIhC;;;;;;;OAOG;IACH,QAAQ,CAAC,KAAK,EAAE,iBAAiB,GAAG,oBAAoB;IAsGxD;;;;;;OAMG;IACH,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,uBAAuB,GAAG,SAAS;IAKnF;;;;;;OAMG;IACH,mBAAmB,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG;QACjD,GAAG,EAAE,gBAAgB,CAAC;QACtB,QAAQ,EAAE,uBAAuB,CAAC;KACnC,GAAG,SAAS;IAkBb;;;;OAIG;IACH,WAAW,IAAI,eAAe;IAwC9B;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,KAAK,CAAC,OAAO,GAAE;QAAE,KAAK,CAAC,EAAE,OAAO,CAAA;KAAO,GAAG,IAAI;IA4B9C;;;;OAIG;IACH,QAAQ,IAAI;QACV,SAAS,EAAE,MAAM,CAAC;QAClB,cAAc,EAAE,MAAM,CAAC;QACvB,WAAW,EAAE,MAAM,CAAC;QACpB,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACnC,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;KACxC;IAsBD;;;;;;OAMG;IACH,OAAO,CAAC,aAAa;IAerB;;;;;;OAMG;IACH,OAAO,CAAC,iBAAiB;IAezB;;;;;;;;OAQG;IACH,OAAO,CAAC,cAAc;IAStB;;;;;;;;OAQG;IACH,OAAO,CAAC,kBAAkB;IAW1B;;;;;;OAMG;IACH,OAAO,CAAC,uBAAuB;CAGhC"}