law4devs 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,289 @@
+declare const DEFAULT_BASE_URL = "https://api.law4devs.eu/api/v1";
+interface HTTPClientOptions {
+    baseUrl?: string;
+    apiKey?: string;
+    timeout?: number;
+    maxRetries?: number;
+}
+declare class HTTPClient {
+    readonly baseUrl: string;
+    readonly timeout: number;
+    readonly maxRetries: number;
+    readonly _headers: Record<string, string>;
+    constructor(options?: HTTPClientOptions);
+    get<T = unknown>(path: string, params?: Record<string, string | number | undefined>): Promise<T>;
+}
+
+interface PageMeta {
+    apiVersion: string;
+    total: number;
+    page: number;
+    perPage: number;
+    pages: number;
+}
+interface PageLinks {
+    next: string | null;
+    prev: string | null;
+}
+interface Page<T> {
+    data: T[];
+    meta: PageMeta;
+    links: PageLinks;
+}
+
+declare abstract class BaseResource {
+    protected readonly _http: HTTPClient;
+    constructor(_http: HTTPClient);
+    protected parsePage<T>(raw: Record<string, unknown>, fromDict: (d: Record<string, unknown>) => T): Page<T>;
+    protected pageParams(page?: number, perPage?: number): Record<string, number | undefined>;
+    protected _iterPages<T>(listFn: (opts: {
+        page: number;
+        perPage: number;
+    }) => Promise<Page<T>>, perPage?: number): AsyncGenerator<T>;
+}
+
+interface Framework {
+    id: number;
+    slug: string;
+    name: string;
+    shortName: string;
+    celexNumber: string;
+    description: string | null;
+    isActive: boolean;
+    status: string;
+    expectedArticles: number;
+    expectedRecitals: number;
+    lastSyncedAt: string | null;
+    createdAt: string;
+    articleCount: number;
+    recitalCount: number;
+}
+interface FrameworkDetail extends Framework {
+    eurLexUrl: string;
+    requirementCount: number;
+    annexCount: number;
+    tagCount: number;
+    coverage: Record<string, unknown> | null;
+}
+
+declare class FrameworksResource extends BaseResource {
+    list(opts?: {
+        page?: number;
+        perPage?: number;
+    }): Promise<Page<Framework>>;
+    get(slug: string): Promise<FrameworkDetail>;
+    iter(opts?: {
+        perPage?: number;
+    }): AsyncGenerator<Framework>;
+}
+
+interface Tag {
+    id: number;
+    slug: string;
+    name: string;
+    description: string | null;
+    keywords: string[];
+    color: string | null;
+    createdAt: string;
+}
+
+interface ArticleParagraph {
+    paragraphRef: string;
+    content: string;
+    position: number;
+}
+interface ArticleSummary {
+    id: number;
+    frameworkSlug: string;
+    articleNumber: number;
+    title: string;
+    position: number;
+    paragraphCount: number;
+    tags: Tag[];
+}
+interface Article extends ArticleSummary {
+    content: string;
+    paragraphs: ArticleParagraph[];
+}
+
+declare class ArticlesResource extends BaseResource {
+    list(frameworkSlug: string, opts?: {
+        page?: number;
+        perPage?: number;
+    }): Promise<Page<ArticleSummary>>;
+    get(frameworkSlug: string, articleNumber: number | string): Promise<Article>;
+    related(frameworkSlug: string, articleNumber: number | string, opts?: {
+        page?: number;
+        perPage?: number;
+    }): Promise<Page<ArticleSummary>>;
+    iter(frameworkSlug: string, opts?: {
+        perPage?: number;
+    }): AsyncGenerator<ArticleSummary>;
+}
+
+interface Recital {
+    id: number;
+    frameworkSlug: string;
+    recitalNumber: number;
+    content: string;
+    position: number;
+}
+
+declare class RecitalsResource extends BaseResource {
+    list(frameworkSlug: string, opts?: {
+        page?: number;
+        perPage?: number;
+    }): Promise<Page<Recital>>;
+    get(frameworkSlug: string, recitalNumber: number | string): Promise<Recital>;
+    iter(frameworkSlug: string, opts?: {
+        perPage?: number;
+    }): AsyncGenerator<Recital>;
+}
+
+interface Requirement {
+    id: number;
+    frameworkSlug: string;
+    articleNumber: number | null;
+    paragraphRef: string | null;
+    paragraphContent: string | null;
+    requirementText: string;
+    requirementType: string;
+    complianceDeadline: string | null;
+    linkedArticleNumbers: number[];
+    stakeholderRoles: string[];
+    tags: Tag[];
+    createdAt: string;
+}
+
+declare class RequirementsResource extends BaseResource {
+    list(opts?: {
+        page?: number;
+        perPage?: number;
+        frameworkSlug?: string;
+    }): Promise<Page<Requirement>>;
+    iter(opts?: {
+        perPage?: number;
+        frameworkSlug?: string;
+    }): AsyncGenerator<Requirement>;
+}
+
+declare class TagsResource extends BaseResource {
+    list(opts?: {
+        page?: number;
+        perPage?: number;
+    }): Promise<Page<Tag>>;
+    get(slug: string): Promise<Tag>;
+    iter(opts?: {
+        perPage?: number;
+    }): AsyncGenerator<Tag>;
+}
+
+interface ComplianceDeadline {
+    id: number;
+    frameworkSlug: string;
+    articleNumber: string | null;
+    paragraphRef: string | null;
+    deadlineDate: string;
+    deadlineType: string;
+    description: string | null;
+}
+
+declare class ComplianceResource extends BaseResource {
+    deadlines(opts?: {
+        page?: number;
+        perPage?: number;
+        frameworkSlug?: string;
+    }): Promise<Page<ComplianceDeadline>>;
+    iterDeadlines(opts?: {
+        perPage?: number;
+        frameworkSlug?: string;
+    }): AsyncGenerator<ComplianceDeadline>;
+}
+
+interface AnnexSummary {
+    id: number;
+    frameworkSlug: string;
+    annexNumber: string;
+    title: string;
+}
+interface Annex extends AnnexSummary {
+    content: string;
+}
+
+declare class AnnexesResource extends BaseResource {
+    list(frameworkSlug: string, opts?: {
+        page?: number;
+        perPage?: number;
+    }): Promise<Page<AnnexSummary>>;
+    get(frameworkSlug: string, annexNumber: string): Promise<Annex>;
+    iter(frameworkSlug: string, opts?: {
+        perPage?: number;
+    }): AsyncGenerator<AnnexSummary>;
+}
+
+interface SearchResult {
+    type: string;
+    frameworkSlug: string;
+    frameworkName: string;
+    articleNumber: string | null;
+    recitalNumber: string | null;
+    paragraphRef: string | null;
+    title: string | null;
+    requirementType: string | null;
+    matchContext: string;
+    url: string;
+}
+
+declare class SearchResource extends BaseResource {
+    query(q: string, opts?: {
+        framework?: string;
+        resultType?: string;
+        page?: number;
+        perPage?: number;
+    }): Promise<Page<SearchResult>>;
+    iter(q: string, opts?: {
+        perPage?: number;
+        framework?: string;
+        resultType?: string;
+    }): AsyncGenerator<SearchResult>;
+}
+
+interface Law4DevsClientOptions {
+    baseUrl?: string;
+    apiKey?: string;
+    timeout?: number;
+    maxRetries?: number;
+}
+declare class Law4DevsClient {
+    readonly _http: HTTPClient;
+    readonly frameworks: FrameworksResource;
+    readonly articles: ArticlesResource;
+    readonly recitals: RecitalsResource;
+    readonly requirements: RequirementsResource;
+    readonly tags: TagsResource;
+    readonly compliance: ComplianceResource;
+    readonly annexes: AnnexesResource;
+    readonly search: SearchResource;
+    constructor(options?: Law4DevsClientOptions);
+}
+
+declare class Law4DevsError extends Error {
+    readonly statusCode?: number | undefined;
+    constructor(message: string, statusCode?: number | undefined);
+}
+declare class NotFoundError extends Law4DevsError {
+    constructor(msg: string, sc?: number);
+}
+declare class ValidationError extends Law4DevsError {
+    constructor(msg: string, sc?: number);
+}
+declare class RateLimitError extends Law4DevsError {
+    constructor(msg: string, sc?: number);
+}
+declare class ServerError extends Law4DevsError {
+    constructor(msg: string, sc?: number);
+}
+
+declare const VERSION = "0.1.0";
+
+export { type Annex, type AnnexSummary, AnnexesResource, type Article, type ArticleParagraph, type ArticleSummary, ArticlesResource, type ComplianceDeadline, ComplianceResource, DEFAULT_BASE_URL, type Framework, type FrameworkDetail, FrameworksResource, HTTPClient, type HTTPClientOptions, Law4DevsClient, type Law4DevsClientOptions, Law4DevsError, NotFoundError, type Page, type PageLinks, type PageMeta, RateLimitError, type Recital, RecitalsResource, type Requirement, RequirementsResource, SearchResource, type SearchResult, ServerError, type Tag, TagsResource, VERSION, ValidationError };