flexorch-sdk 0.1.0

package/dist/index.d.cts

@@ -0,0 +1,279 @@
+type FetchFn = (input: string, init?: RequestInit) => Promise<Response>;
+declare class Transport {
+    private baseUrl;
+    private defaultHeaders;
+    private timeout;
+    private maxRetries;
+    private fetchFn;
+    constructor(apiKey: string, baseUrl: string, timeout: number, maxRetries: number, fetchFn?: FetchFn);
+    private url;
+    private doRequest;
+    getBytes(path: string, params?: Record<string, string>): Promise<Uint8Array>;
+    get(path: string, params?: Record<string, string>): Promise<unknown>;
+    post(path: string, json?: unknown): Promise<unknown>;
+    postForm(path: string, form: FormData): Promise<unknown>;
+    delete(path: string): Promise<unknown>;
+}
+
+type ExportFormat = "json" | "jsonl" | "csv" | "parquet" | "md" | "xml" | "xlsx" | "rag";
+declare class Dataset {
+    readonly id: string;
+    readonly name: string;
+    readonly slug: string;
+    readonly status: string;
+    readonly rowCount: number;
+    readonly createdAt: string;
+    readonly availableFormats: string[];
+    private readonly _transport;
+    constructor(data: {
+        id: string;
+        name: string;
+        slug: string;
+        status: string;
+        rowCount: number;
+        createdAt: string;
+        availableFormats: string[];
+        _transport: Transport;
+    });
+    static fromDict(data: Record<string, unknown>, transport: Transport): Dataset;
+    export(format: ExportFormat): Promise<Uint8Array>;
+    exportToS3(connectorId: string, format: ExportFormat, prefix?: string): Promise<{
+        s3Key: string;
+        sizeBytes: number;
+    }>;
+    index(): Promise<{
+        status: string;
+        message: string;
+    }>;
+    indexStatus(): Promise<{
+        status: string;
+        chunksIndexed: number;
+        totalChunks: number;
+    }>;
+    toString(): string;
+}
+
+declare class Job {
+    readonly id: string;
+    readonly status: string;
+    readonly qualityGrade: string | null;
+    readonly qualityScore: number | null;
+    readonly documentId: string | null;
+    readonly hasDataset: boolean;
+    readonly failureReason: string | null;
+    private readonly _transport;
+    constructor(data: {
+        id: string;
+        status: string;
+        qualityGrade: string | null;
+        qualityScore: number | null;
+        documentId: string | null;
+        hasDataset: boolean;
+        failureReason: string | null;
+        _transport: Transport;
+    });
+    static fromDict(data: Record<string, unknown>, transport: Transport): Job;
+    wait(opts?: {
+        timeout?: number;
+        pollInterval?: number;
+    }): Promise<Job>;
+    dataset(): Promise<Dataset | null>;
+    toString(): string;
+}
+
+declare class SearchResult {
+    readonly chunkId: string;
+    readonly text: string;
+    readonly score: number;
+    readonly datasetId: string;
+    readonly chunkIndex: number;
+    readonly tokenCount: number;
+    readonly metadata: Record<string, unknown>;
+    constructor(data: {
+        chunkId: string;
+        text: string;
+        score: number;
+        datasetId: string;
+        chunkIndex: number;
+        tokenCount: number;
+        metadata: Record<string, unknown>;
+    });
+    static fromDict(data: Record<string, unknown>): SearchResult;
+    toString(): string;
+}
+interface SearchFilters {
+    documentType?: string;
+    language?: string;
+    piiMasked?: boolean;
+    qualityGrade?: string;
+}
+
+declare class JobsResource {
+    private readonly _t;
+    constructor(_t: Transport);
+    get(jobId: string): Promise<Job>;
+    list(opts?: {
+        page?: number;
+        pageSize?: number;
+    }): Promise<Job[]>;
+}
+
+declare class DatasetsResource {
+    private readonly _t;
+    constructor(_t: Transport);
+    get(datasetId: string): Promise<Dataset>;
+    list(opts?: {
+        page?: number;
+        pageSize?: number;
+    }): Promise<Dataset[]>;
+}
+
+interface UsageSnapshot {
+    plan: string;
+    creditsUsed: number;
+    creditsLimit: number;
+    creditsRemaining: number;
+    resetAt: string;
+    periodStart: string;
+    periodEnd: string;
+}
+declare class UsageResource {
+    private readonly _t;
+    constructor(_t: Transport);
+    current(): Promise<UsageSnapshot>;
+}
+
+type WebhookEvent = "dataset.ready" | "job.completed" | "job.failed";
+interface Webhook {
+    id: string;
+    url: string;
+    events: WebhookEvent[];
+    active: boolean;
+    createdAt: string;
+}
+declare class WebhooksResource {
+    private readonly _t;
+    constructor(_t: Transport);
+    register(url: string, events: WebhookEvent[]): Promise<Webhook>;
+    list(): Promise<Webhook[]>;
+    delete(webhookId: string): Promise<void>;
+}
+
+declare class Connector {
+    readonly id: string;
+    readonly name: string;
+    readonly type: string;
+    readonly active: boolean;
+    readonly lastTestedAt: string | null;
+    readonly lastUsedAt: string | null;
+    readonly createdAt: string;
+    constructor(data: {
+        id: string;
+        name: string;
+        type: string;
+        active: boolean;
+        lastTestedAt: string | null;
+        lastUsedAt: string | null;
+        createdAt: string;
+    });
+    static fromDict(data: Record<string, unknown>): Connector;
+    toString(): string;
+}
+interface ConnectorTestResult {
+    success: boolean;
+    latencyMs: number | null;
+    message: string;
+}
+type ConnectorType = "s3" | "gcs" | "azure_blob";
+interface S3ConnectorConfig {
+    bucket: string;
+    region: string;
+    accessKeyId: string;
+    secretAccessKey: string;
+    prefix?: string;
+}
+
+declare class ConnectorsResource {
+    private readonly _t;
+    constructor(_t: Transport);
+    create(name: string, type: ConnectorType, config: Record<string, string>): Promise<Connector>;
+    list(): Promise<Connector[]>;
+    get(connectorId: string): Promise<Connector>;
+    delete(connectorId: string): Promise<void>;
+    test(connectorId: string): Promise<ConnectorTestResult>;
+}
+
+interface FlexOrchClientOptions {
+    apiKey?: string;
+    baseUrl?: string;
+    timeout?: number;
+    maxRetries?: number;
+    /** @internal — override fetch for testing */
+    _fetch?: FetchFn;
+}
+declare class FlexOrchClient {
+    readonly jobs: JobsResource;
+    readonly datasets: DatasetsResource;
+    readonly usage: UsageResource;
+    readonly webhooks: WebhooksResource;
+    readonly connectors: ConnectorsResource;
+    private readonly _transport;
+    constructor(apiKeyOrOptions?: string | FlexOrchClientOptions);
+    process(filePath: string, opts?: {
+        locale?: string;
+        pipelineConfig?: Record<string, unknown>;
+    }): Promise<Job>;
+    processMany(filePaths: string[], opts?: {
+        locale?: string;
+    }): Promise<Job[]>;
+    processFromS3(connectorId: string, keys: string[], opts?: {
+        locale?: string;
+        pipelineConfig?: Record<string, unknown>;
+    }): Promise<Job[]>;
+    search(query: string, opts?: {
+        topK?: number;
+        filters?: SearchFilters;
+    }): Promise<SearchResult[]>;
+    toString(): string;
+}
+
+declare class FlexOrchError extends Error {
+    readonly statusCode: number | undefined;
+    readonly errorCode: string | undefined;
+    constructor(message: string, statusCode?: number, errorCode?: string);
+}
+declare class AuthError extends FlexOrchError {
+    constructor(message: string, statusCode?: number, errorCode?: string);
+}
+declare class QuotaError extends FlexOrchError {
+    readonly remainingCredits: number | undefined;
+    readonly resetAt: string | undefined;
+    constructor(message: string, statusCode?: number, errorCode?: string, remainingCredits?: number, resetAt?: string);
+}
+declare class RateLimitError extends FlexOrchError {
+    readonly retryAfter: number;
+    constructor(message: string, retryAfter?: number);
+}
+declare class NotFoundError extends FlexOrchError {
+    constructor(message: string, errorCode?: string);
+}
+declare class ValidationError extends FlexOrchError {
+    constructor(message: string, errorCode?: string);
+}
+declare class ServerError extends FlexOrchError {
+    constructor(message: string, statusCode?: number, errorCode?: string);
+}
+declare class JobFailedError extends FlexOrchError {
+    readonly jobId: string;
+    readonly failureReason: string;
+    constructor(jobId: string, failureReason: string);
+}
+declare class JobTimeoutError extends FlexOrchError {
+    readonly jobId: string;
+    readonly timeout: number;
+    constructor(jobId: string, timeout: number);
+}
+
+declare const version = "0.1.0";
+
+export { AuthError, Connector, type ConnectorTestResult, type ConnectorType, Dataset, type ExportFormat, FlexOrchClient, type FlexOrchClientOptions, FlexOrchError, Job, JobFailedError, JobTimeoutError, NotFoundError, QuotaError, RateLimitError, type S3ConnectorConfig, type SearchFilters, SearchResult, ServerError, type UsageSnapshot, ValidationError, type Webhook, type WebhookEvent, version };

package/dist/index.d.ts

@@ -0,0 +1,279 @@
+type FetchFn = (input: string, init?: RequestInit) => Promise<Response>;
+declare class Transport {
+    private baseUrl;
+    private defaultHeaders;
+    private timeout;
+    private maxRetries;
+    private fetchFn;
+    constructor(apiKey: string, baseUrl: string, timeout: number, maxRetries: number, fetchFn?: FetchFn);
+    private url;
+    private doRequest;
+    getBytes(path: string, params?: Record<string, string>): Promise<Uint8Array>;
+    get(path: string, params?: Record<string, string>): Promise<unknown>;
+    post(path: string, json?: unknown): Promise<unknown>;
+    postForm(path: string, form: FormData): Promise<unknown>;
+    delete(path: string): Promise<unknown>;
+}
+
+type ExportFormat = "json" | "jsonl" | "csv" | "parquet" | "md" | "xml" | "xlsx" | "rag";
+declare class Dataset {
+    readonly id: string;
+    readonly name: string;
+    readonly slug: string;
+    readonly status: string;
+    readonly rowCount: number;
+    readonly createdAt: string;
+    readonly availableFormats: string[];
+    private readonly _transport;
+    constructor(data: {
+        id: string;
+        name: string;
+        slug: string;
+        status: string;
+        rowCount: number;
+        createdAt: string;
+        availableFormats: string[];
+        _transport: Transport;
+    });
+    static fromDict(data: Record<string, unknown>, transport: Transport): Dataset;
+    export(format: ExportFormat): Promise<Uint8Array>;
+    exportToS3(connectorId: string, format: ExportFormat, prefix?: string): Promise<{
+        s3Key: string;
+        sizeBytes: number;
+    }>;
+    index(): Promise<{
+        status: string;
+        message: string;
+    }>;
+    indexStatus(): Promise<{
+        status: string;
+        chunksIndexed: number;
+        totalChunks: number;
+    }>;
+    toString(): string;
+}
+
+declare class Job {
+    readonly id: string;
+    readonly status: string;
+    readonly qualityGrade: string | null;
+    readonly qualityScore: number | null;
+    readonly documentId: string | null;
+    readonly hasDataset: boolean;
+    readonly failureReason: string | null;
+    private readonly _transport;
+    constructor(data: {
+        id: string;
+        status: string;
+        qualityGrade: string | null;
+        qualityScore: number | null;
+        documentId: string | null;
+        hasDataset: boolean;
+        failureReason: string | null;
+        _transport: Transport;
+    });
+    static fromDict(data: Record<string, unknown>, transport: Transport): Job;
+    wait(opts?: {
+        timeout?: number;
+        pollInterval?: number;
+    }): Promise<Job>;
+    dataset(): Promise<Dataset | null>;
+    toString(): string;
+}
+
+declare class SearchResult {
+    readonly chunkId: string;
+    readonly text: string;
+    readonly score: number;
+    readonly datasetId: string;
+    readonly chunkIndex: number;
+    readonly tokenCount: number;
+    readonly metadata: Record<string, unknown>;
+    constructor(data: {
+        chunkId: string;
+        text: string;
+        score: number;
+        datasetId: string;
+        chunkIndex: number;
+        tokenCount: number;
+        metadata: Record<string, unknown>;
+    });
+    static fromDict(data: Record<string, unknown>): SearchResult;
+    toString(): string;
+}
+interface SearchFilters {
+    documentType?: string;
+    language?: string;
+    piiMasked?: boolean;
+    qualityGrade?: string;
+}
+
+declare class JobsResource {
+    private readonly _t;
+    constructor(_t: Transport);
+    get(jobId: string): Promise<Job>;
+    list(opts?: {
+        page?: number;
+        pageSize?: number;
+    }): Promise<Job[]>;
+}
+
+declare class DatasetsResource {
+    private readonly _t;
+    constructor(_t: Transport);
+    get(datasetId: string): Promise<Dataset>;
+    list(opts?: {
+        page?: number;
+        pageSize?: number;
+    }): Promise<Dataset[]>;
+}
+
+interface UsageSnapshot {
+    plan: string;
+    creditsUsed: number;
+    creditsLimit: number;
+    creditsRemaining: number;
+    resetAt: string;
+    periodStart: string;
+    periodEnd: string;
+}
+declare class UsageResource {
+    private readonly _t;
+    constructor(_t: Transport);
+    current(): Promise<UsageSnapshot>;
+}
+
+type WebhookEvent = "dataset.ready" | "job.completed" | "job.failed";
+interface Webhook {
+    id: string;
+    url: string;
+    events: WebhookEvent[];
+    active: boolean;
+    createdAt: string;
+}
+declare class WebhooksResource {
+    private readonly _t;
+    constructor(_t: Transport);
+    register(url: string, events: WebhookEvent[]): Promise<Webhook>;
+    list(): Promise<Webhook[]>;
+    delete(webhookId: string): Promise<void>;
+}
+
+declare class Connector {
+    readonly id: string;
+    readonly name: string;
+    readonly type: string;
+    readonly active: boolean;
+    readonly lastTestedAt: string | null;
+    readonly lastUsedAt: string | null;
+    readonly createdAt: string;
+    constructor(data: {
+        id: string;
+        name: string;
+        type: string;
+        active: boolean;
+        lastTestedAt: string | null;
+        lastUsedAt: string | null;
+        createdAt: string;
+    });
+    static fromDict(data: Record<string, unknown>): Connector;
+    toString(): string;
+}
+interface ConnectorTestResult {
+    success: boolean;
+    latencyMs: number | null;
+    message: string;
+}
+type ConnectorType = "s3" | "gcs" | "azure_blob";
+interface S3ConnectorConfig {
+    bucket: string;
+    region: string;
+    accessKeyId: string;
+    secretAccessKey: string;
+    prefix?: string;
+}
+
+declare class ConnectorsResource {
+    private readonly _t;
+    constructor(_t: Transport);
+    create(name: string, type: ConnectorType, config: Record<string, string>): Promise<Connector>;
+    list(): Promise<Connector[]>;
+    get(connectorId: string): Promise<Connector>;
+    delete(connectorId: string): Promise<void>;
+    test(connectorId: string): Promise<ConnectorTestResult>;
+}
+
+interface FlexOrchClientOptions {
+    apiKey?: string;
+    baseUrl?: string;
+    timeout?: number;
+    maxRetries?: number;
+    /** @internal — override fetch for testing */
+    _fetch?: FetchFn;
+}
+declare class FlexOrchClient {
+    readonly jobs: JobsResource;
+    readonly datasets: DatasetsResource;
+    readonly usage: UsageResource;
+    readonly webhooks: WebhooksResource;
+    readonly connectors: ConnectorsResource;
+    private readonly _transport;
+    constructor(apiKeyOrOptions?: string | FlexOrchClientOptions);
+    process(filePath: string, opts?: {
+        locale?: string;
+        pipelineConfig?: Record<string, unknown>;
+    }): Promise<Job>;
+    processMany(filePaths: string[], opts?: {
+        locale?: string;
+    }): Promise<Job[]>;
+    processFromS3(connectorId: string, keys: string[], opts?: {
+        locale?: string;
+        pipelineConfig?: Record<string, unknown>;
+    }): Promise<Job[]>;
+    search(query: string, opts?: {
+        topK?: number;
+        filters?: SearchFilters;
+    }): Promise<SearchResult[]>;
+    toString(): string;
+}
+
+declare class FlexOrchError extends Error {
+    readonly statusCode: number | undefined;
+    readonly errorCode: string | undefined;
+    constructor(message: string, statusCode?: number, errorCode?: string);
+}
+declare class AuthError extends FlexOrchError {
+    constructor(message: string, statusCode?: number, errorCode?: string);
+}
+declare class QuotaError extends FlexOrchError {
+    readonly remainingCredits: number | undefined;
+    readonly resetAt: string | undefined;
+    constructor(message: string, statusCode?: number, errorCode?: string, remainingCredits?: number, resetAt?: string);
+}
+declare class RateLimitError extends FlexOrchError {
+    readonly retryAfter: number;
+    constructor(message: string, retryAfter?: number);
+}
+declare class NotFoundError extends FlexOrchError {
+    constructor(message: string, errorCode?: string);
+}
+declare class ValidationError extends FlexOrchError {
+    constructor(message: string, errorCode?: string);
+}
+declare class ServerError extends FlexOrchError {
+    constructor(message: string, statusCode?: number, errorCode?: string);
+}
+declare class JobFailedError extends FlexOrchError {
+    readonly jobId: string;
+    readonly failureReason: string;
+    constructor(jobId: string, failureReason: string);
+}
+declare class JobTimeoutError extends FlexOrchError {
+    readonly jobId: string;
+    readonly timeout: number;
+    constructor(jobId: string, timeout: number);
+}
+
+declare const version = "0.1.0";
+
+export { AuthError, Connector, type ConnectorTestResult, type ConnectorType, Dataset, type ExportFormat, FlexOrchClient, type FlexOrchClientOptions, FlexOrchError, Job, JobFailedError, JobTimeoutError, NotFoundError, QuotaError, RateLimitError, type S3ConnectorConfig, type SearchFilters, SearchResult, ServerError, type UsageSnapshot, ValidationError, type Webhook, type WebhookEvent, version };