Class DocumentClient

Sub-client for document EP API endpoints.

Hierarchy (View Summary)

BaseEPClient
- DocumentClient

Constructors

constructor

new DocumentClient(
config?: EPClientConfig,
shared?: EPSharedResources,
): DocumentClient
Parameters
- config: EPClientConfig = {}
- Optionalshared: EPSharedResources
Returns DocumentClient
Overrides BaseEPClient.constructor
- Defined in clients/ep/documentClient.ts:36

Properties

`Protected` `Readonly`baseURL

baseURL: string

European Parliament API base URL.

`Protected` `Readonly`cache

cache: LRUCache<string, Record<string, unknown>>

LRU cache for API responses.

`Protected` `Readonly`enableRetry

enableRetry: boolean

Enable automatic retry on transient failures.

`Protected` `Readonly`maxResponseBytes

maxResponseBytes: number

Maximum allowed response body size in bytes.

`Protected` `Readonly`maxRetries

maxRetries: number

Maximum number of retry attempts.

`Protected` `Readonly`rateLimiter

rateLimiter: RateLimiter

Token bucket rate limiter.

`Protected` `Readonly`timeoutMs

timeoutMs: number

Request timeout in milliseconds.

Methods

`Private`buildDocumentSearchParams

buildDocumentSearchParams(
    params: {
        dateFrom?: string;
        documentType?: string;
        limit?: number;
        offset?: number;
    },
): Record<string, unknown>
Private
Builds EP API parameters for document search.
Parameters
- params: { dateFrom?: string; documentType?: string; limit?: number; offset?: number }
Returns Record<string, unknown>
- Defined in clients/ep/documentClient.ts:52

clearCache

clearCache(): void
Clears all entries from the LRU cache.

Returns void
Inherited from BaseEPClient.clearCache
- Defined in clients/ep/baseClient.ts:556

`Private`filterDocuments

filterDocuments(
documents: LegislativeDocument[],
params: { committee?: string; dateTo?: string; keyword?: string },
): LegislativeDocument[]
Private
Applies client-side keyword, committee, and date-range filters to documents.
Parameters
- documents: LegislativeDocument[]
- params: { committee?: string; dateTo?: string; keyword?: string }
Returns LegislativeDocument[]
- Defined in clients/ep/documentClient.ts:81

`Protected`get

get<T extends Record<string, unknown>>(
endpoint: string,
params?: Record<string, unknown>,
): Promise<T>
Protected
Executes a cached, rate-limited GET request to the EP API.
Type Parameters
- T extends Record<string, unknown>
  Expected response type (extends Record<string, unknown>)
Parameters
- endpoint: string
  API endpoint path (relative to baseURL)
- Optionalparams: Record<string, unknown>
  Optional query parameters
Returns Promise<T>
Promise resolving to the typed API response

Throws
On HTTP errors, network failures, or parse failures
Inherited from BaseEPClient.get
- Defined in clients/ep/baseClient.ts:496

getCacheStats

getCacheStats(): {
    hitRate: number;
    hits: number;
    maxSize: number;
    misses: number;
    size: number;
}
Returns cache statistics for monitoring and debugging.

Returns { hitRate: number; hits: number; maxSize: number; misses: number; size: number }
{ size, maxSize, hitRate, hits, misses }
Inherited from BaseEPClient.getCacheStats
- Defined in clients/ep/baseClient.ts:565

getCommitteeDocumentById

getCommitteeDocumentById(docId: string): Promise<LegislativeDocument>
Returns a single committee document by ID. EP API Endpoint: GET /committee-documents/{doc-id}
Parameters
- docId: string
Returns Promise<LegislativeDocument>
- Defined in clients/ep/documentClient.ts:331

getCommitteeDocuments

getCommitteeDocuments(
params?: { limit?: number; offset?: number; year?: number },
): Promise<PaginatedResponse<LegislativeDocument>>
Returns committee documents. EP API Endpoint: GET /committee-documents
Parameters
- params: { limit?: number; offset?: number; year?: number } = {}
Returns Promise<PaginatedResponse<LegislativeDocument>>
- Defined in clients/ep/documentClient.ts:201

getDocumentById

getDocumentById(docId: string): Promise<LegislativeDocument>
Returns a single document by ID. EP API Endpoint: GET /documents/{doc-id}
Parameters
- docId: string
Returns Promise<LegislativeDocument>
- Defined in clients/ep/documentClient.ts:292

getExternalDocumentById

getExternalDocumentById(docId: string): Promise<LegislativeDocument>
Returns a single external document by ID. EP API Endpoint: GET /external-documents/{doc-id}
Parameters
- docId: string
Returns Promise<LegislativeDocument>
- Defined in clients/ep/documentClient.ts:344

getExternalDocuments

getExternalDocuments(
params?: { limit?: number; offset?: number; year?: number },
): Promise<PaginatedResponse<LegislativeDocument>>
Returns all External Documents. EP API Endpoint: GET /external-documents
Parameters
- params: { limit?: number; offset?: number; year?: number } = {}
Returns Promise<PaginatedResponse<LegislativeDocument>>
- Defined in clients/ep/documentClient.ts:268

getPlenaryDocumentById

getPlenaryDocumentById(docId: string): Promise<LegislativeDocument>
Returns a single plenary document by ID. EP API Endpoint: GET /plenary-documents/{doc-id}
Parameters
- docId: string
Returns Promise<LegislativeDocument>
- Defined in clients/ep/documentClient.ts:305

getPlenaryDocuments

getPlenaryDocuments(
params?: { limit?: number; offset?: number; year?: number },
): Promise<PaginatedResponse<LegislativeDocument>>
Returns plenary documents. EP API Endpoint: GET /plenary-documents
Parameters
- params: { limit?: number; offset?: number; year?: number } = {}
Returns Promise<PaginatedResponse<LegislativeDocument>>
- Defined in clients/ep/documentClient.ts:177

getPlenarySessionDocumentById

getPlenarySessionDocumentById(docId: string): Promise<LegislativeDocument>
Returns a single plenary session document by ID. EP API Endpoint: GET /plenary-session-documents/{doc-id}
Parameters
- docId: string
Returns Promise<LegislativeDocument>
- Defined in clients/ep/documentClient.ts:318

getPlenarySessionDocumentItems

getPlenarySessionDocumentItems(
params?: { limit?: number; offset?: number },
): Promise<PaginatedResponse<LegislativeDocument>>
Returns all Plenary Session Document Items. EP API Endpoint: GET /plenary-session-documents-items
Parameters
- params: { limit?: number; offset?: number } = {}
Returns Promise<PaginatedResponse<LegislativeDocument>>
- Defined in clients/ep/documentClient.ts:247

getPlenarySessionDocuments

getPlenarySessionDocuments(
params?: { limit?: number; offset?: number },
): Promise<PaginatedResponse<LegislativeDocument>>
Returns plenary session documents. EP API Endpoint: GET /plenary-session-documents
Parameters
- params: { limit?: number; offset?: number } = {}
Returns Promise<PaginatedResponse<LegislativeDocument>>
- Defined in clients/ep/documentClient.ts:225

searchDocuments

searchDocuments(
    params: {
        keyword: string;
        committee?: string;
        dateFrom?: string;
        dateTo?: string;
        documentType?: string;
        limit?: number;
        offset?: number;
    },
): Promise<PaginatedResponse<LegislativeDocument>>
Searches legislative documents by keyword, type, date, and committee.

EP API Endpoint: GET /documents
Parameters
- params: {
      keyword: string;
      committee?: string;
      dateFrom?: string;
      dateTo?: string;
      documentType?: string;
      limit?: number;
      offset?: number;
  }
  keyword, documentType, dateFrom, dateTo, committee, limit, offset
Returns Promise<PaginatedResponse<LegislativeDocument>>
Paginated legislative documents list

Security
Audit logged per GDPR Article 30
- Defined in clients/ep/documentClient.ts:119

`Private`transformDocument

transformDocument(apiData: Record<string, unknown>): LegislativeDocument
Parameters
- apiData: Record<string, unknown>
Returns LegislativeDocument
- Defined in clients/ep/documentClient.ts:42

Class DocumentClient

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns DocumentClient

Properties

Protected ReadonlybaseURL

Protected Readonlycache

Protected ReadonlyenableRetry

Protected ReadonlymaxResponseBytes

Protected ReadonlymaxRetries

Protected ReadonlyrateLimiter

Protected ReadonlytimeoutMs

Methods

PrivatebuildDocumentSearchParams

Parameters

Returns Record<string, unknown>

clearCache

Returns void

PrivatefilterDocuments

Parameters

Returns LegislativeDocument[]

Protectedget

Type Parameters

Parameters

Returns Promise<T>

Throws

getCacheStats

Returns { hitRate: number; hits: number; maxSize: number; misses: number; size: number }

getCommitteeDocumentById

Parameters

Returns Promise<LegislativeDocument>

getCommitteeDocuments

Parameters

Returns Promise<PaginatedResponse<LegislativeDocument>>

getDocumentById

Parameters

Returns Promise<LegislativeDocument>

getExternalDocumentById

Parameters

Returns Promise<LegislativeDocument>

getExternalDocuments

Parameters

Returns Promise<PaginatedResponse<LegislativeDocument>>

getPlenaryDocumentById

Parameters

Returns Promise<LegislativeDocument>

getPlenaryDocuments

Parameters

Returns Promise<PaginatedResponse<LegislativeDocument>>

getPlenarySessionDocumentById

Parameters

Returns Promise<LegislativeDocument>

getPlenarySessionDocumentItems

Parameters

Returns Promise<PaginatedResponse<LegislativeDocument>>

getPlenarySessionDocuments

Parameters

Returns Promise<PaginatedResponse<LegislativeDocument>>

searchDocuments

Parameters

Returns Promise<PaginatedResponse<LegislativeDocument>>

Security

PrivatetransformDocument

Parameters

Returns LegislativeDocument

Settings

On This Page

`Protected` `Readonly`baseURL

`Protected` `Readonly`cache

`Protected` `Readonly`enableRetry

`Protected` `Readonly`maxResponseBytes

`Protected` `Readonly`maxRetries

`Protected` `Readonly`rateLimiter

`Protected` `Readonly`timeoutMs

`Private`buildDocumentSearchParams

`Private`filterDocuments

`Protected`get

`Private`transformDocument