somark-js 0.1.0

package/dist/index.d.cts

@@ -0,0 +1,258 @@
+interface HttpClientOptions {
+    apiKey: string | undefined;
+    baseUrl: string;
+    timeout: number;
+    maxRetries: number;
+}
+declare class HttpClient {
+    private apiKey;
+    private baseUrl;
+    private timeoutMs;
+    private maxRetries;
+    constructor(opts: HttpClientOptions);
+    getApiKey(): string | undefined;
+    private buildFormData;
+    post(path: string, data?: Record<string, string | string[] | undefined>, file?: {
+        name: string;
+        buffer: Buffer;
+        mimeType: string;
+    }): Promise<Record<string, unknown>>;
+}
+
+type SoMarkWarning = string;
+
+interface ExtractConfig {
+    enableTextCrossPage?: boolean;
+    enableTableCrossPage?: boolean;
+    enableTitleLevelRecognition?: boolean;
+    enableInlineImage?: boolean;
+    enableTableImage?: boolean;
+    enableImageUnderstanding?: boolean;
+    keepHeaderFooter?: boolean;
+}
+interface ElementFormats {
+    image?: 'url' | 'base64' | 'file' | 'none';
+    formula?: 'latex' | 'mathml' | 'ascii';
+    table?: 'markdown' | 'html' | 'image';
+    cs?: 'image';
+}
+interface SoMarkResponseData {
+    ok: boolean;
+    code: number;
+    message: string;
+    warnings?: SoMarkWarning[];
+}
+interface ParseResponseData extends SoMarkResponseData {
+    taskId: string;
+    pages: number;
+    fileType: string;
+    imgs: string[];
+    md?: string;
+    jsonOutput?: Record<string, unknown>;
+    zipUrl?: string;
+    sourceFileName?: string;
+}
+declare class ParseResponse implements ParseResponseData {
+    ok: boolean;
+    code: number;
+    message: string;
+    warnings: SoMarkWarning[];
+    taskId: string;
+    pages: number;
+    fileType: string;
+    imgs: string[];
+    md?: string;
+    jsonOutput?: Record<string, unknown>;
+    zipUrl?: string;
+    sourceFileName?: string;
+    constructor(data: ParseResponseData);
+    save(targetPath: string, format?: string | string[]): Promise<void>;
+    contentForFormat(format: string): string;
+    private saveFormat;
+    toJSON(): ParseResponseData;
+    static fromApi(data: Record<string, unknown>): ParseResponse;
+}
+interface UsageData extends SoMarkResponseData {
+    remainingPaidPages: number;
+    remainingFreePagesToday: number;
+    remainingFreePagesThisMonth: number;
+    dashboardUrl: string;
+}
+declare class Usage implements UsageData {
+    ok: boolean;
+    code: number;
+    message: string;
+    warnings: SoMarkWarning[];
+    remainingPaidPages: number;
+    remainingFreePagesToday: number;
+    remainingFreePagesThisMonth: number;
+    dashboardUrl: string;
+    constructor(data: UsageData);
+    toJSON(): UsageData;
+    static fromApi(data: Record<string, unknown>): Usage;
+}
+interface ToImagesResult {
+    ok: boolean;
+    files: string[];
+    error?: string;
+}
+type TaskStatus = 'queuing' | 'processing' | 'success' | 'failed';
+type TaskRefreshHandler = (taskId: string) => Promise<Record<string, unknown>>;
+declare class Task {
+    id: string;
+    completed: boolean;
+    status: TaskStatus;
+    recordId?: number;
+    fileName?: string;
+    pages?: number;
+    warnings: string[];
+    private refreshHandler?;
+    private _result?;
+    constructor(taskId: string, refreshHandler?: TaskRefreshHandler, warnings?: string[]);
+    refresh(): Promise<void>;
+    private applyApi;
+    wait(opts?: {
+        pollInterval?: number;
+        timeout?: number;
+    }): Promise<ParseResponse>;
+    result(): ParseResponse;
+}
+
+interface ParseOptions {
+    file: string | string[];
+    formats?: string[];
+    elementFormats?: ElementFormats;
+    extractConfig?: ExtractConfig;
+    fileList?: boolean;
+}
+declare class DocumentParser {
+    private _http;
+    constructor(http: HttpClient);
+    private checkApiKey;
+    private pollTask;
+    task(taskId: string): Task;
+    private parseOne;
+    parse(opts: ParseOptions & {
+        file: string;
+        fileList?: false;
+    }): Promise<ParseResponse>;
+    parse(opts: ParseOptions & {
+        file: string[];
+    }): Promise<ParseResponse[]>;
+    parse(opts: ParseOptions & {
+        fileList: true;
+    }): Promise<ParseResponse[]>;
+    private createOne;
+    create(opts: ParseOptions & {
+        file: string;
+        fileList?: false;
+    }): Promise<Task>;
+    create(opts: ParseOptions & {
+        file: string[];
+    }): Promise<Task[]>;
+    create(opts: ParseOptions & {
+        fileList: true;
+    }): Promise<Task[]>;
+}
+
+declare class UsageClient {
+    private _http;
+    constructor(http: HttpClient);
+    get(): Promise<Usage>;
+}
+
+interface ToImagesOptions {
+    file: string;
+    out?: string;
+    filenameFormat?: string;
+    dpi?: number;
+}
+declare class PDFProcessor {
+    toImages(opts: ToImagesOptions): Promise<ToImagesResult>;
+}
+
+interface PreviewServerHandle {
+    url: string;
+    fileUrl: string;
+    host: string;
+    port: number;
+    stop(): Promise<void>;
+}
+interface PreviewOptions {
+    file?: string;
+    host?: string;
+    port?: number;
+    openBrowser?: boolean;
+}
+declare class SoMarkDownPreview {
+    start(opts?: PreviewOptions): Promise<PreviewServerHandle>;
+}
+
+interface SoMarkOptions {
+    apiKey?: string;
+    baseUrl?: string;
+    timeout?: number;
+    maxRetries?: number;
+}
+declare class SoMark {
+    parser: DocumentParser;
+    usage: UsageClient;
+    pdf: PDFProcessor;
+    preview: SoMarkDownPreview;
+    private _http;
+    constructor(opts?: SoMarkOptions);
+    toString(): string;
+}
+
+declare class SoMarkDown {
+    private readonly renderer;
+    constructor(...args: unknown[]);
+    render(markdown: string, ...args: unknown[]): string;
+}
+
+declare class SoMarkError extends Error {
+    code: number;
+    constructor(message?: string, code?: number);
+}
+declare class AuthenticationError extends SoMarkError {
+    constructor(message?: string, code?: number);
+}
+declare class InsufficientBalanceError extends SoMarkError {
+    constructor(message?: string, code?: number);
+}
+declare class RateLimitError extends SoMarkError {
+    constructor(message?: string, code?: number);
+}
+declare class UnsupportedFileError extends SoMarkError {
+    constructor(message?: string, code?: number);
+}
+declare class FileTooLargeError extends SoMarkError {
+    constructor(message?: string, code?: number);
+}
+declare class ParseTimeoutError extends SoMarkError {
+    constructor(message?: string, code?: number);
+}
+declare class ParseFailedError extends SoMarkError {
+    constructor(message?: string, code?: number);
+}
+declare class InvalidParamError extends SoMarkError {
+    constructor(message?: string, code?: number);
+}
+declare class APIError extends SoMarkError {
+    constructor(message?: string, code?: number);
+}
+declare class ConnectionError extends SoMarkError {
+    constructor(message?: string, code?: number);
+}
+declare class RequestTimeoutError extends SoMarkError {
+    constructor(message?: string, code?: number);
+}
+
+interface ResolvedConfig {
+    apiKey: string | undefined;
+    baseUrl: string;
+    timeout: number;
+    maxRetries: number;
+}
+
+export { APIError, AuthenticationError, ConnectionError, DocumentParser, type ElementFormats, type ExtractConfig, FileTooLargeError, InsufficientBalanceError, InvalidParamError, PDFProcessor, ParseFailedError, type ParseOptions, ParseResponse, type ParseResponseData, ParseTimeoutError, type PreviewOptions, type PreviewServerHandle, RateLimitError, RequestTimeoutError, type ResolvedConfig, SoMark, SoMarkDown, SoMarkDownPreview, SoMarkError, type SoMarkOptions, type SoMarkResponseData, type SoMarkWarning, Task, type TaskStatus, type ToImagesOptions, type ToImagesResult, UnsupportedFileError, Usage, UsageClient, type UsageData };

package/dist/index.d.ts

@@ -0,0 +1,258 @@
+interface HttpClientOptions {
+    apiKey: string | undefined;
+    baseUrl: string;
+    timeout: number;
+    maxRetries: number;
+}
+declare class HttpClient {
+    private apiKey;
+    private baseUrl;
+    private timeoutMs;
+    private maxRetries;
+    constructor(opts: HttpClientOptions);
+    getApiKey(): string | undefined;
+    private buildFormData;
+    post(path: string, data?: Record<string, string | string[] | undefined>, file?: {
+        name: string;
+        buffer: Buffer;
+        mimeType: string;
+    }): Promise<Record<string, unknown>>;
+}
+
+type SoMarkWarning = string;
+
+interface ExtractConfig {
+    enableTextCrossPage?: boolean;
+    enableTableCrossPage?: boolean;
+    enableTitleLevelRecognition?: boolean;
+    enableInlineImage?: boolean;
+    enableTableImage?: boolean;
+    enableImageUnderstanding?: boolean;
+    keepHeaderFooter?: boolean;
+}
+interface ElementFormats {
+    image?: 'url' | 'base64' | 'file' | 'none';
+    formula?: 'latex' | 'mathml' | 'ascii';
+    table?: 'markdown' | 'html' | 'image';
+    cs?: 'image';
+}
+interface SoMarkResponseData {
+    ok: boolean;
+    code: number;
+    message: string;
+    warnings?: SoMarkWarning[];
+}
+interface ParseResponseData extends SoMarkResponseData {
+    taskId: string;
+    pages: number;
+    fileType: string;
+    imgs: string[];
+    md?: string;
+    jsonOutput?: Record<string, unknown>;
+    zipUrl?: string;
+    sourceFileName?: string;
+}
+declare class ParseResponse implements ParseResponseData {
+    ok: boolean;
+    code: number;
+    message: string;
+    warnings: SoMarkWarning[];
+    taskId: string;
+    pages: number;
+    fileType: string;
+    imgs: string[];
+    md?: string;
+    jsonOutput?: Record<string, unknown>;
+    zipUrl?: string;
+    sourceFileName?: string;
+    constructor(data: ParseResponseData);
+    save(targetPath: string, format?: string | string[]): Promise<void>;
+    contentForFormat(format: string): string;
+    private saveFormat;
+    toJSON(): ParseResponseData;
+    static fromApi(data: Record<string, unknown>): ParseResponse;
+}
+interface UsageData extends SoMarkResponseData {
+    remainingPaidPages: number;
+    remainingFreePagesToday: number;
+    remainingFreePagesThisMonth: number;
+    dashboardUrl: string;
+}
+declare class Usage implements UsageData {
+    ok: boolean;
+    code: number;
+    message: string;
+    warnings: SoMarkWarning[];
+    remainingPaidPages: number;
+    remainingFreePagesToday: number;
+    remainingFreePagesThisMonth: number;
+    dashboardUrl: string;
+    constructor(data: UsageData);
+    toJSON(): UsageData;
+    static fromApi(data: Record<string, unknown>): Usage;
+}
+interface ToImagesResult {
+    ok: boolean;
+    files: string[];
+    error?: string;
+}
+type TaskStatus = 'queuing' | 'processing' | 'success' | 'failed';
+type TaskRefreshHandler = (taskId: string) => Promise<Record<string, unknown>>;
+declare class Task {
+    id: string;
+    completed: boolean;
+    status: TaskStatus;
+    recordId?: number;
+    fileName?: string;
+    pages?: number;
+    warnings: string[];
+    private refreshHandler?;
+    private _result?;
+    constructor(taskId: string, refreshHandler?: TaskRefreshHandler, warnings?: string[]);
+    refresh(): Promise<void>;
+    private applyApi;
+    wait(opts?: {
+        pollInterval?: number;
+        timeout?: number;
+    }): Promise<ParseResponse>;
+    result(): ParseResponse;
+}
+
+interface ParseOptions {
+    file: string | string[];
+    formats?: string[];
+    elementFormats?: ElementFormats;
+    extractConfig?: ExtractConfig;
+    fileList?: boolean;
+}
+declare class DocumentParser {
+    private _http;
+    constructor(http: HttpClient);
+    private checkApiKey;
+    private pollTask;
+    task(taskId: string): Task;
+    private parseOne;
+    parse(opts: ParseOptions & {
+        file: string;
+        fileList?: false;
+    }): Promise<ParseResponse>;
+    parse(opts: ParseOptions & {
+        file: string[];
+    }): Promise<ParseResponse[]>;
+    parse(opts: ParseOptions & {
+        fileList: true;
+    }): Promise<ParseResponse[]>;
+    private createOne;
+    create(opts: ParseOptions & {
+        file: string;
+        fileList?: false;
+    }): Promise<Task>;
+    create(opts: ParseOptions & {
+        file: string[];
+    }): Promise<Task[]>;
+    create(opts: ParseOptions & {
+        fileList: true;
+    }): Promise<Task[]>;
+}
+
+declare class UsageClient {
+    private _http;
+    constructor(http: HttpClient);
+    get(): Promise<Usage>;
+}
+
+interface ToImagesOptions {
+    file: string;
+    out?: string;
+    filenameFormat?: string;
+    dpi?: number;
+}
+declare class PDFProcessor {
+    toImages(opts: ToImagesOptions): Promise<ToImagesResult>;
+}
+
+interface PreviewServerHandle {
+    url: string;
+    fileUrl: string;
+    host: string;
+    port: number;
+    stop(): Promise<void>;
+}
+interface PreviewOptions {
+    file?: string;
+    host?: string;
+    port?: number;
+    openBrowser?: boolean;
+}
+declare class SoMarkDownPreview {
+    start(opts?: PreviewOptions): Promise<PreviewServerHandle>;
+}
+
+interface SoMarkOptions {
+    apiKey?: string;
+    baseUrl?: string;
+    timeout?: number;
+    maxRetries?: number;
+}
+declare class SoMark {
+    parser: DocumentParser;
+    usage: UsageClient;
+    pdf: PDFProcessor;
+    preview: SoMarkDownPreview;
+    private _http;
+    constructor(opts?: SoMarkOptions);
+    toString(): string;
+}
+
+declare class SoMarkDown {
+    private readonly renderer;
+    constructor(...args: unknown[]);
+    render(markdown: string, ...args: unknown[]): string;
+}
+
+declare class SoMarkError extends Error {
+    code: number;
+    constructor(message?: string, code?: number);
+}
+declare class AuthenticationError extends SoMarkError {
+    constructor(message?: string, code?: number);
+}
+declare class InsufficientBalanceError extends SoMarkError {
+    constructor(message?: string, code?: number);
+}
+declare class RateLimitError extends SoMarkError {
+    constructor(message?: string, code?: number);
+}
+declare class UnsupportedFileError extends SoMarkError {
+    constructor(message?: string, code?: number);
+}
+declare class FileTooLargeError extends SoMarkError {
+    constructor(message?: string, code?: number);
+}
+declare class ParseTimeoutError extends SoMarkError {
+    constructor(message?: string, code?: number);
+}
+declare class ParseFailedError extends SoMarkError {
+    constructor(message?: string, code?: number);
+}
+declare class InvalidParamError extends SoMarkError {
+    constructor(message?: string, code?: number);
+}
+declare class APIError extends SoMarkError {
+    constructor(message?: string, code?: number);
+}
+declare class ConnectionError extends SoMarkError {
+    constructor(message?: string, code?: number);
+}
+declare class RequestTimeoutError extends SoMarkError {
+    constructor(message?: string, code?: number);
+}
+
+interface ResolvedConfig {
+    apiKey: string | undefined;
+    baseUrl: string;
+    timeout: number;
+    maxRetries: number;
+}
+
+export { APIError, AuthenticationError, ConnectionError, DocumentParser, type ElementFormats, type ExtractConfig, FileTooLargeError, InsufficientBalanceError, InvalidParamError, PDFProcessor, ParseFailedError, type ParseOptions, ParseResponse, type ParseResponseData, ParseTimeoutError, type PreviewOptions, type PreviewServerHandle, RateLimitError, RequestTimeoutError, type ResolvedConfig, SoMark, SoMarkDown, SoMarkDownPreview, SoMarkError, type SoMarkOptions, type SoMarkResponseData, type SoMarkWarning, Task, type TaskStatus, type ToImagesOptions, type ToImagesResult, UnsupportedFileError, Usage, UsageClient, type UsageData };