@alva-ai/toolkit 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,402 @@
+interface AlvaClientConfig {
+    apiKey?: string;
+    baseUrl?: string;
+}
+interface UserProfile {
+    id: number;
+    username: string;
+    subscription_tier: 'free' | 'pro';
+    telegram_username: string | null;
+}
+interface FsReadParams {
+    path: string;
+    offset?: number;
+    size?: number;
+}
+interface FsWriteParams {
+    path: string;
+    data: string;
+    mkdir_parents?: boolean;
+}
+interface FsRawWriteParams {
+    path: string;
+    /** Raw file content: string, ArrayBuffer, Uint8Array, Blob, etc. */
+    body: BodyInit;
+    mkdir_parents?: boolean;
+}
+interface FsWriteResponse {
+    bytes_written: number;
+}
+interface FsStat {
+    name: string;
+    size: number;
+    mode: number;
+    mod_time: string;
+    is_dir: boolean;
+}
+interface FsReaddirParams {
+    path: string;
+    recursive?: boolean;
+}
+interface FsEntry {
+    name: string;
+    size: number;
+    is_dir: boolean;
+    mod_time?: string;
+    mode?: number;
+}
+interface FsReaddirResponse {
+    entries: FsEntry[];
+}
+interface FsMkdirParams {
+    path: string;
+}
+interface FsRemoveParams {
+    path: string;
+    recursive?: boolean;
+}
+interface FsRenameParams {
+    old_path: string;
+    new_path: string;
+}
+interface FsCopyParams {
+    src_path: string;
+    dst_path: string;
+}
+interface FsSymlinkParams {
+    target_path: string;
+    link_path: string;
+}
+interface FsReadlinkParams {
+    path: string;
+}
+interface FsChmodParams {
+    path: string;
+    mode: number;
+}
+interface FsGrantParams {
+    path: string;
+    subject: string;
+    permission: string;
+}
+interface FsRevokeParams {
+    path: string;
+    subject: string;
+    permission: string;
+}
+interface RunRequest {
+    code?: string;
+    entry_path?: string;
+    working_dir?: string;
+    args?: Record<string, unknown>;
+}
+interface RunResponse {
+    result: string;
+    logs: string;
+    stats: {
+        duration_ms: number;
+    };
+    status: 'completed' | 'failed';
+    error?: string;
+}
+interface CronjobCreateRequest {
+    path: string;
+    cron_expression: string;
+    name: string;
+    args?: Record<string, unknown>;
+    push_notify?: boolean;
+}
+interface Cronjob {
+    id: number;
+    name: string;
+    path: string;
+    cron_expression: string;
+    status: string;
+    args: Record<string, unknown>;
+    push_notify: boolean;
+    created_at: string;
+    updated_at: string;
+}
+interface CronjobListParams {
+    limit?: number;
+    cursor?: string;
+}
+interface CronjobListResponse {
+    cronjobs: Cronjob[];
+    next_cursor?: string;
+}
+interface CronjobUpdateRequest {
+    id: number;
+    name?: string;
+    cron_expression?: string;
+    args?: Record<string, unknown>;
+    push_notify?: boolean;
+}
+interface FeedReleaseRequest {
+    name: string;
+    version: string;
+    cronjob_id: number;
+    view_json?: Record<string, unknown>;
+    description?: string;
+}
+interface FeedReleaseResponse {
+    feed_id: number;
+    name: string;
+    feed_major: number;
+}
+interface PlaybookDraftRequest {
+    name: string;
+    display_name: string;
+    description?: string;
+    feeds: Array<{
+        feed_id: number;
+        feed_major?: number;
+    }>;
+    trading_symbols?: string[];
+}
+interface PlaybookDraftResponse {
+    playbook_id: number;
+    playbook_version_id: number;
+}
+interface PlaybookReleaseRequest {
+    name: string;
+    version: string;
+    feeds: Array<{
+        feed_id: number;
+        feed_major?: number;
+    }>;
+    changelog: string;
+}
+interface PlaybookReleaseResponse {
+    playbook_id: number;
+    version: string;
+    published_url: string;
+}
+interface CreateSecretRequest {
+    name: string;
+    value: string;
+}
+interface SecretMetadata {
+    name: string;
+    keyVersion: number;
+    createdAt: string;
+    updatedAt: string;
+    valueLength: number;
+    keyPrefix: string;
+}
+interface Secret {
+    name: string;
+    value: string;
+    createdAt: string;
+    updatedAt: string;
+}
+interface ModuleDoc {
+    name: string;
+    doc: string;
+}
+interface PartitionsResponse {
+    partitions: string[];
+}
+interface PartitionSummaryResponse {
+    summary: string;
+}
+interface CreateCommentRequest {
+    username: string;
+    name: string;
+    content: string;
+    parent_id?: number;
+}
+interface Comment {
+    id: number;
+    playbook_id: number;
+    content: string;
+    pin_at: number | null;
+    created_at: number;
+    updated_at: number;
+    creator?: {
+        id: string;
+        name: string;
+        avatar: string;
+    };
+    agent?: {
+        name: string;
+    };
+}
+interface RemixRequest {
+    child: {
+        username: string;
+        name: string;
+    };
+    parents: Array<{
+        username: string;
+        name: string;
+    }>;
+}
+interface ScreenshotParams {
+    url: string;
+    selector?: string;
+    xpath?: string;
+}
+
+declare class FsResource {
+    private client;
+    constructor(client: AlvaClient);
+    /** Returns `ArrayBuffer` for binary files, or parsed JSON for time-series virtual paths. */
+    read(params: FsReadParams): Promise<ArrayBuffer | unknown>;
+    /** Write file using JSON body (Mode 2). For text content. */
+    write(params: FsWriteParams): Promise<FsWriteResponse>;
+    /** Write file using raw body (Mode 1). Supports binary data. Path and options are query params. */
+    rawWrite(params: FsRawWriteParams): Promise<FsWriteResponse>;
+    stat(params: {
+        path: string;
+    }): Promise<FsStat>;
+    readdir(params: FsReaddirParams): Promise<FsReaddirResponse>;
+    mkdir(params: FsMkdirParams): Promise<void>;
+    remove(params: FsRemoveParams): Promise<void>;
+    rename(params: FsRenameParams): Promise<void>;
+    copy(params: FsCopyParams): Promise<void>;
+    symlink(params: FsSymlinkParams): Promise<void>;
+    readlink(params: FsReadlinkParams): Promise<{
+        target: string;
+    }>;
+    chmod(params: FsChmodParams): Promise<void>;
+    grant(params: FsGrantParams): Promise<void>;
+    revoke(params: FsRevokeParams): Promise<void>;
+}
+
+declare class RunResource {
+    private client;
+    constructor(client: AlvaClient);
+    execute(params: RunRequest): Promise<RunResponse>;
+}
+
+declare class DeployResource {
+    private client;
+    constructor(client: AlvaClient);
+    create(params: CronjobCreateRequest): Promise<Cronjob>;
+    list(params?: CronjobListParams): Promise<CronjobListResponse>;
+    get(params: {
+        id: number;
+    }): Promise<Cronjob>;
+    update(params: CronjobUpdateRequest): Promise<Cronjob>;
+    delete(params: {
+        id: number;
+    }): Promise<void>;
+    pause(params: {
+        id: number;
+    }): Promise<void>;
+    resume(params: {
+        id: number;
+    }): Promise<void>;
+}
+
+declare class ReleaseResource {
+    private client;
+    constructor(client: AlvaClient);
+    feed(params: FeedReleaseRequest): Promise<FeedReleaseResponse>;
+    playbookDraft(params: PlaybookDraftRequest): Promise<PlaybookDraftResponse>;
+    playbook(params: PlaybookReleaseRequest): Promise<PlaybookReleaseResponse>;
+}
+
+declare class SecretsResource {
+    private client;
+    constructor(client: AlvaClient);
+    create(params: CreateSecretRequest): Promise<void>;
+    list(): Promise<{
+        secrets: SecretMetadata[];
+    }>;
+    get(params: {
+        name: string;
+    }): Promise<Secret>;
+    update(params: {
+        name: string;
+        value: string;
+    }): Promise<void>;
+    delete(params: {
+        name: string;
+    }): Promise<void>;
+}
+
+declare class SdkDocsResource {
+    private client;
+    constructor(client: AlvaClient);
+    doc(params: {
+        name: string;
+    }): Promise<ModuleDoc>;
+    partitions(): Promise<PartitionsResponse>;
+    partitionSummary(params: {
+        partition: string;
+    }): Promise<PartitionSummaryResponse>;
+}
+
+declare class CommentsResource {
+    private client;
+    constructor(client: AlvaClient);
+    create(params: CreateCommentRequest): Promise<Comment>;
+    pin(params: {
+        comment_id: number;
+    }): Promise<Comment>;
+    unpin(params: {
+        comment_id: number;
+    }): Promise<Comment>;
+}
+
+declare class RemixResource {
+    private client;
+    constructor(client: AlvaClient);
+    save(params: RemixRequest): Promise<void>;
+}
+
+declare class ScreenshotResource {
+    private client;
+    constructor(client: AlvaClient);
+    capture(params: ScreenshotParams): Promise<ArrayBuffer>;
+}
+
+declare class UserResource {
+    private client;
+    constructor(client: AlvaClient);
+    me(): Promise<UserProfile>;
+}
+
+interface RequestOptions {
+    query?: Record<string, unknown>;
+    body?: unknown;
+    /** Send raw body with application/octet-stream content type (for binary writes). */
+    rawBody?: BodyInit;
+}
+declare class AlvaClient {
+    readonly baseUrl: string;
+    readonly apiKey?: string;
+    private _fs?;
+    private _run?;
+    private _deploy?;
+    private _release?;
+    private _secrets?;
+    private _sdk?;
+    private _comments?;
+    private _remix?;
+    private _screenshot?;
+    private _user?;
+    constructor(config: AlvaClientConfig);
+    get fs(): FsResource;
+    get run(): RunResource;
+    get deploy(): DeployResource;
+    get release(): ReleaseResource;
+    get secrets(): SecretsResource;
+    get sdk(): SdkDocsResource;
+    get comments(): CommentsResource;
+    get remix(): RemixResource;
+    get screenshot(): ScreenshotResource;
+    get user(): UserResource;
+    _requireAuth(): void;
+    _request(method: string, path: string, options?: RequestOptions): Promise<unknown>;
+}
+
+declare class AlvaError extends Error {
+    readonly code: string;
+    readonly status: number;
+    constructor(code: string, message: string, status: number);
+}
+
+export { AlvaClient, type AlvaClientConfig, AlvaError, type Comment, type CreateCommentRequest, type CreateSecretRequest, type Cronjob, type CronjobCreateRequest, type CronjobListParams, type CronjobListResponse, type CronjobUpdateRequest, type FeedReleaseRequest, type FeedReleaseResponse, type FsChmodParams, type FsCopyParams, type FsEntry, type FsGrantParams, type FsMkdirParams, type FsRawWriteParams, type FsReadParams, type FsReaddirParams, type FsReaddirResponse, type FsReadlinkParams, type FsRemoveParams, type FsRenameParams, type FsRevokeParams, type FsStat, type FsSymlinkParams, type FsWriteParams, type FsWriteResponse, type ModuleDoc, type PartitionSummaryResponse, type PartitionsResponse, type PlaybookDraftRequest, type PlaybookDraftResponse, type PlaybookReleaseRequest, type PlaybookReleaseResponse, type RemixRequest, type RunRequest, type RunResponse, type ScreenshotParams, type Secret, type SecretMetadata, type UserProfile };