Class ComponentRegistryAPIServer

Base class for the Component Registry API Server. This class provides a complete implementation of the Component Registry API v1 specification.

To customize the server behavior, extend this class and override the appropriate methods. Common customization points include:

Authentication: Override checkAPIKey() to implement custom authentication
Component filtering: Override getComponentFilter() to customize which components are served
Response formatting: Override the route handler methods to customize response formats

Example

class MyCustomRegistryServer extends ComponentRegistryAPIServer {
  protected async checkAPIKey(req: Request): Promise<boolean> {
    const apiKey = req.headers['x-api-key'];
    return await myCustomAuthProvider.validateKey(apiKey);
  }
}

Constructors

constructor

new ComponentRegistryAPIServer(
options?: ComponentRegistryServerOptions,
): ComponentRegistryAPIServer
Parameters
- options: ComponentRegistryServerOptions = {}
Returns ComponentRegistryAPIServer
- Defined in Server.ts:61

Properties

`Protected`app

app: Application = null

`Protected`dataSources

dataSources: DataSourceInfo[] = []

`Protected`feedbackHandler

feedbackHandler: FeedbackHandler = ...

Default feedback handler implementation. Simply logs feedback and returns success. Override by calling setFeedbackHandler() with a custom implementation.

`Protected`metadata

metadata: Metadata

`Protected`options

options: ComponentRegistryServerOptions

`Protected`pool

pool: ConnectionPool = null

`Protected`readOnlyPool

readOnlyPool: ConnectionPool = null

`Protected`registry

registry: MJComponentRegistryEntity = null

`Protected`router

router: Router = null

Accessors

Provider

get Provider(): IMetadataProvider
Optional metadata provider override. Server bootstrap is process-wide so this typically uses the global default; callers may set instance.Provider = providerToUse for tests or multi-tenant overrides.

Returns IMetadataProvider
- Defined in Server.ts:54
set Provider(value: IMetadataProvider): void
Parameters
- value: IMetadataProvider
Returns void
- Defined in Server.ts:57

Methods

`Protected`authMiddleware

authMiddleware(req: Request, res: Response, next: NextFunction): Promise<void>
Protected
Authentication middleware that calls the checkAPIKey method. This middleware is automatically applied to /api/v1/components routes when requireAuth is true.
Parameters
- req: Request
- res: Response
- next: NextFunction
Returns Promise<void>
- Defined in Server.ts:273

`Protected`checkAPIKey

checkAPIKey(req: Request): Promise<boolean>
Protected
Check if the API key in the request is valid. By default, this method always returns true (no authentication).

Override this method to implement custom authentication logic. Common patterns include:
- Checking Bearer tokens in Authorization header
- Validating API keys in custom headers
- Verifying JWT tokens
- Checking against a database of valid keys
Parameters
- req: Request
  The Express request object
Returns Promise<boolean>
Promise - True if the request is authenticated, false otherwise
Example
```
protected async checkAPIKey(req: Request): Promise<boolean> {
  const apiKey = req.headers['x-api-key'] as string;
  if (!apiKey) return false;
  
  // Check against database, cache, or external service
  return await this.validateKeyInDatabase(apiKey);
}
```
- Defined in Server.ts:315

`Protected`generateSpecificationHash

generateSpecificationHash(specification: string): string
Generate SHA-256 hash of component specification
Parameters
- specification: string
  The component specification JSON string
Returns string
SHA-256 hash as hex string
- Defined in Server.ts:539

`Protected`getComponent

getComponent(req: Request, res: Response): Promise<void>
Protected
Handler for GET /api/v1/components/:namespace/:name Get a specific component by namespace and name. Optionally specify a version with ?version=x.x.x query parameter. Optionally specify a hash with ?hash=abc123 to enable caching (returns 304 if unchanged).
Parameters
- req: Request
- res: Response
Returns Promise<void>
- Defined in Server.ts:552

`Protected`getComponentFilter

getComponentFilter(): string
Protected
Get the base filter for component queries. By default, this returns components where SourceRegistryID IS NULL (local components only).

Override this method to customize which components are served by the registry.

Returns string
The SQL filter string to apply to all component queries
Example
```
protected getComponentFilter(): string {
  // Include both local and specific external registry components
  return "(SourceRegistryID IS NULL OR SourceRegistryID = 'abc-123')";
}
```
- Defined in Server.ts:375

`Protected`getHealth

getHealth(req: Request, res: Response): Promise<void>
Protected
Handler for GET /api/v1/health Returns the health status of the registry server.
Parameters
- req: Request
- res: Response
Returns Promise<void>
- Defined in Server.ts:402

`Protected`getLatestVersions

getLatestVersions(components: MJComponentEntity[]): MJComponentEntity[]
Protected
Helper method to get the latest version of each component from a list. Components are grouped by namespace/name and the highest version is selected.
Parameters
- components: MJComponentEntity[]
  Array of components potentially containing multiple versions
Returns MJComponentEntity[]
Array of components with only the latest version of each
- Defined in Server.ts:627

`Protected`getRegistryInfo

getRegistryInfo(req: Request, res: Response): Promise<void>
Protected
Handler for GET /api/v1/registry Returns basic information about the registry.
Parameters
- req: Request
- res: Response
Returns Promise<void>
- Defined in Server.ts:386

getRouter

getRouter(): Router
Get the Express Router for mounting on an existing app. Only available in 'router' mode.

Returns Router
The Express Router with all registry routes configured

Throws
Error if called in standalone mode
- Defined in Server.ts:89

initialize

initialize(): Promise<void>
Initialize the server, including database connection, middleware, and routes. This method should be called before starting the server.

Returns Promise<void>
Promise that resolves when initialization is complete

Throws
Error if database connection fails or registry cannot be loaded
- Defined in Server.ts:106

`Protected`listComponents

listComponents(req: Request, res: Response): Promise<void>
Protected
Handler for GET /api/v1/components Lists all published components in the registry, showing only the latest version of each.
Parameters
- req: Request
- res: Response
Returns Promise<void>
- Defined in Server.ts:434

`Protected`loadRegistry

loadRegistry(): Promise<void>
Protected
Load the registry metadata from the database. This is called automatically if a registryId is provided in the configuration.

Returns Promise<void>
- Defined in Server.ts:211

`Protected`searchComponents

searchComponents(req: Request, res: Response): Promise<void>
Protected
Handler for GET /api/v1/components/search Search for components by query string and optional type filter.
Parameters
- req: Request
- res: Response
Returns Promise<void>
- Defined in Server.ts:481

setFeedbackHandler

setFeedbackHandler(handler: FeedbackHandler): void
Set a custom feedback handler. This allows external code (e.g., Skip) to override feedback handling logic.
Parameters
- handler: FeedbackHandler
  Custom feedback handler implementation
Returns void
Example
```
const server = new ComponentRegistryAPIServer();
server.setFeedbackHandler({
  async submitFeedback(params, context) {
    // Custom logic here
    return { success: true, feedbackID: '...' };
  }
});
```
- Defined in Server.ts:680

`Protected`setupDatabase

setupDatabase(): Promise<void>
Protected
Set up the database connection using MemberJunction's SQL Server provider. Follows the same pattern as MJServer for consistency.

Returns Promise<void>
- Defined in Server.ts:155

`Protected`setupMiddleware

setupMiddleware(): void
Protected
Set up Express middleware. Override this method to add custom middleware or modify the middleware stack.

Returns void
- Defined in Server.ts:233

`Protected`setupRoutes

setupRoutes(): void
Protected
Set up the API routes. Override this method to add custom routes or modify existing ones.

Returns void
- Defined in Server.ts:328

start

start(): Promise<void>
Start the Express server on the configured port. Must be called after initialize().

Returns Promise<void>
Promise that resolves when the server is listening
- Defined in Server.ts:128

`Protected`submitFeedback

submitFeedback(req: Request, res: Response): Promise<void>
Protected
Handler for POST /api/v1/feedback Submit feedback for a component.
Parameters
- req: Request
- res: Response
Returns Promise<void>
- Defined in Server.ts:691

Class ComponentRegistryAPIServer

Example

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ComponentRegistryAPIServer

Properties

Protectedapp

ProtecteddataSources

ProtectedfeedbackHandler

Protectedmetadata

Protectedoptions

Protectedpool

ProtectedreadOnlyPool

Protectedregistry

Protectedrouter

Accessors

Provider

Returns IMetadataProvider

Parameters

Returns void

Methods

ProtectedauthMiddleware

Parameters

Returns Promise<void>

ProtectedcheckAPIKey

Parameters

Returns Promise<boolean>

Example

ProtectedgenerateSpecificationHash

Parameters

Returns string

ProtectedgetComponent

Parameters

Returns Promise<void>

ProtectedgetComponentFilter

Returns string

Example

ProtectedgetHealth

Parameters

Returns Promise<void>

ProtectedgetLatestVersions

Parameters

Returns MJComponentEntity[]

ProtectedgetRegistryInfo

Parameters

Returns Promise<void>

getRouter

Returns Router

Throws

initialize

Returns Promise<void>

Throws

ProtectedlistComponents

Parameters

Returns Promise<void>

ProtectedloadRegistry

Returns Promise<void>

ProtectedsearchComponents

Parameters

Returns Promise<void>

setFeedbackHandler

Parameters

Returns void

Example

ProtectedsetupDatabase

Returns Promise<void>

ProtectedsetupMiddleware

Returns void

ProtectedsetupRoutes

Returns void

start

Returns Promise<void>

ProtectedsubmitFeedback

Parameters

`Protected`app

`Protected`dataSources

`Protected`feedbackHandler

`Protected`metadata

`Protected`options

`Protected`pool

`Protected`readOnlyPool

`Protected`registry

`Protected`router

`Protected`authMiddleware

`Protected`checkAPIKey

`Protected`generateSpecificationHash

`Protected`getComponent

`Protected`getComponentFilter

`Protected`getHealth

`Protected`getLatestVersions

`Protected`getRegistryInfo

`Protected`listComponents

`Protected`loadRegistry

`Protected`searchComponents

`Protected`setupDatabase

`Protected`setupMiddleware

`Protected`setupRoutes

`Protected`submitFeedback