metabase-cli 0.2.2

package/dist/index.d.ts

@@ -0,0 +1,408 @@
+interface Profile {
+    name: string;
+    domain: string;
+    auth: SessionAuth | ApiKeyAuth;
+    user?: CachedUser;
+    defaultDb?: number;
+}
+interface SessionAuth {
+    method: "session";
+    email: string;
+    password: string;
+    sessionToken?: string;
+}
+interface ApiKeyAuth {
+    method: "api-key";
+    apiKey: string;
+}
+interface CachedUser {
+    id: number;
+    email: string;
+    first_name: string;
+    last_name: string;
+    is_superuser: boolean;
+}
+interface Config {
+    activeProfile: string;
+    profiles: Record<string, Profile>;
+}
+interface SessionResponse {
+    id: string;
+}
+interface User {
+    id: number;
+    email: string;
+    first_name: string;
+    last_name: string;
+    is_superuser: boolean;
+    common_name: string;
+    locale: string | null;
+    is_active: boolean;
+    date_joined: string;
+    last_login: string;
+    [key: string]: unknown;
+}
+interface Database {
+    id: number;
+    name: string;
+    engine: string;
+    is_sample: boolean;
+    [key: string]: unknown;
+}
+interface Table {
+    id: number;
+    name: string;
+    display_name: string;
+    db_id: number;
+    schema: string;
+    [key: string]: unknown;
+}
+interface Field {
+    id: number;
+    name: string;
+    display_name: string;
+    table_id: number;
+    base_type: string;
+    semantic_type: string | null;
+    [key: string]: unknown;
+}
+interface Card {
+    id: number;
+    name: string;
+    description: string | null;
+    display: string;
+    collection_id: number | null;
+    creator_id: number;
+    dataset_query: DatasetQuery;
+    visualization_settings: Record<string, unknown>;
+    archived: boolean;
+    [key: string]: unknown;
+}
+interface Dashboard {
+    id: number;
+    name: string;
+    description: string | null;
+    collection_id: number | null;
+    creator_id: number;
+    dashcards: DashCard[];
+    parameters: Parameter[];
+    archived: boolean;
+    [key: string]: unknown;
+}
+interface DashCard {
+    id: number;
+    card_id: number | null;
+    card: Card | null;
+    row: number;
+    col: number;
+    size_x: number;
+    size_y: number;
+    parameter_mappings: unknown[];
+    visualization_settings: Record<string, unknown>;
+    [key: string]: unknown;
+}
+interface Parameter {
+    id: string;
+    name: string;
+    type: string;
+    slug: string;
+    default?: unknown;
+    [key: string]: unknown;
+}
+interface Collection {
+    id: number | "root";
+    name: string;
+    description: string | null;
+    parent_id: number | null;
+    archived: boolean;
+    [key: string]: unknown;
+}
+interface Snippet {
+    id: number;
+    name: string;
+    description: string | null;
+    content: string;
+    creator_id: number;
+    archived: boolean;
+    collection_id: number | null;
+    [key: string]: unknown;
+}
+interface DatasetQuery {
+    type: "native" | "query";
+    database: number;
+    native?: {
+        query: string;
+        "template-tags"?: Record<string, unknown>;
+    };
+    query?: Record<string, unknown>;
+}
+interface DatasetResponse {
+    data: {
+        rows: unknown[][];
+        cols: DatasetColumn[];
+        results_metadata?: {
+            columns: DatasetColumn[];
+        };
+        native_form?: {
+            query: string;
+        };
+        rows_truncated?: number;
+    };
+    row_count: number;
+    status: string;
+    [key: string]: unknown;
+}
+interface DatasetColumn {
+    name: string;
+    display_name: string;
+    base_type: string;
+    semantic_type?: string | null;
+    [key: string]: unknown;
+}
+interface SearchResult {
+    id: number;
+    name: string;
+    model: string;
+    description: string | null;
+    collection_id: number | null;
+    [key: string]: unknown;
+}
+interface PaginatedResponse<T> {
+    data: T[];
+    total: number;
+    limit: number;
+    offset: number;
+}
+type OutputFormat = "table" | "json" | "csv" | "tsv";
+
+declare class MetabaseClient {
+    private domain;
+    private sessionToken?;
+    private apiKey?;
+    private profile;
+    constructor(profile: Profile);
+    private getHeaders;
+    private request;
+    get<T>(path: string, params?: Record<string, string>): Promise<T>;
+    post<T>(path: string, body?: unknown): Promise<T>;
+    put<T>(path: string, body?: unknown): Promise<T>;
+    delete<T>(path: string): Promise<T>;
+    requestFormExport(path: string, fields: Record<string, string>): Promise<Response>;
+    requestRaw(method: string, path: string, body?: unknown): Promise<Response>;
+    login(): Promise<SessionResponse>;
+    logout(): Promise<void>;
+    ensureAuthenticated(): Promise<void>;
+    getProfile(): Profile;
+    getUserId(): number | null;
+}
+
+declare class SafetyGuard {
+    private client;
+    private unsafe;
+    constructor(client: MetabaseClient, unsafe?: boolean);
+    checkOwnership(entityType: string, entityId: number): Promise<{
+        owned: boolean;
+        creatorId: number;
+    }>;
+    guard<T>(entityType: string, entityId: number, action: string, fn: () => Promise<T>): Promise<T>;
+}
+
+declare function loadConfig(): Config;
+declare function saveConfig(config: Config): void;
+declare function getActiveProfile(): Profile | null;
+declare function setActiveProfile(name: string): void;
+declare function addProfile(profile: Profile): void;
+declare function removeProfile(name: string): void;
+declare function updateProfile(name: string, updates: Partial<Profile>): void;
+declare function listProfiles(): {
+    profiles: Profile[];
+    active: string;
+};
+
+declare class SessionApi {
+    private client;
+    constructor(client: MetabaseClient);
+    getCurrentUser(): Promise<User>;
+    getSessionProperties(): Promise<Record<string, unknown>>;
+}
+
+declare class DatasetApi {
+    private client;
+    constructor(client: MetabaseClient);
+    query(datasetQuery: DatasetQuery): Promise<DatasetResponse>;
+    queryNative(database: number, sql: string, templateTags?: Record<string, unknown>): Promise<DatasetResponse>;
+    export(datasetQuery: DatasetQuery, format: "csv" | "json" | "xlsx"): Promise<string>;
+    exportBinary(datasetQuery: DatasetQuery, format: "csv" | "json" | "xlsx"): Promise<Buffer>;
+}
+
+interface CreateCardParams {
+    name: string;
+    dataset_query: DatasetQuery;
+    display: string;
+    description?: string;
+    collection_id?: number;
+    visualization_settings?: Record<string, unknown>;
+    parameters?: unknown[];
+}
+interface UpdateCardParams {
+    name?: string;
+    description?: string;
+    parameters?: unknown[];
+    collection_id?: number;
+    dataset_query?: DatasetQuery;
+    display?: string;
+    visualization_settings?: Record<string, unknown>;
+    archived?: boolean;
+}
+declare class CardApi {
+    private client;
+    constructor(client: MetabaseClient);
+    list(params?: Record<string, string>): Promise<Card[]>;
+    get(id: number): Promise<Card>;
+    create(params: CreateCardParams): Promise<Card>;
+    update(id: number, params: UpdateCardParams): Promise<Card>;
+    delete(id: number): Promise<void>;
+    copy(id: number, overrides?: Partial<CreateCardParams>): Promise<Card>;
+    query(id: number, parameters?: unknown[]): Promise<DatasetResponse>;
+    queryExport(id: number, format: "csv" | "json" | "xlsx", parameters?: unknown[]): Promise<string>;
+    queryExportBinary(id: number, format: "csv" | "json" | "xlsx", parameters?: unknown[]): Promise<Buffer>;
+}
+
+interface CreateDashboardParams {
+    name: string;
+    description?: string;
+    collection_id?: number;
+    parameters?: unknown[];
+}
+interface UpdateDashboardParams {
+    name?: string;
+    description?: string;
+    collection_id?: number;
+    parameters?: unknown[];
+    dashcards?: unknown[];
+    archived?: boolean;
+}
+declare class DashboardApi {
+    private client;
+    constructor(client: MetabaseClient);
+    list(params?: Record<string, string>): Promise<Dashboard[]>;
+    get(id: number): Promise<Dashboard>;
+    create(params: CreateDashboardParams): Promise<Dashboard>;
+    update(id: number, params: UpdateDashboardParams): Promise<Dashboard>;
+    delete(id: number): Promise<void>;
+    copy(id: number, overrides?: Partial<CreateDashboardParams>): Promise<Dashboard>;
+}
+
+interface CreateCollectionParams {
+    name: string;
+    description?: string;
+    parent_id?: number;
+}
+interface UpdateCollectionParams {
+    name?: string;
+    description?: string;
+    parent_id?: number;
+    archived?: boolean;
+}
+interface CollectionItem {
+    id: number;
+    name: string;
+    model: string;
+    description: string | null;
+    [key: string]: unknown;
+}
+declare class CollectionApi {
+    private client;
+    constructor(client: MetabaseClient);
+    list(): Promise<Collection[]>;
+    tree(): Promise<Collection[]>;
+    get(id: number | "root"): Promise<Collection>;
+    items(id: number | "root", params?: Record<string, string>): Promise<{
+        data: CollectionItem[];
+        total: number;
+    }>;
+    create(params: CreateCollectionParams): Promise<Collection>;
+    update(id: number, params: UpdateCollectionParams): Promise<Collection>;
+}
+
+declare class DatabaseApi {
+    private client;
+    constructor(client: MetabaseClient);
+    list(): Promise<{
+        data: Database[];
+    }>;
+    get(id: number): Promise<Database>;
+    metadata(id: number): Promise<Database & {
+        tables: Table[];
+    }>;
+    schemas(id: number): Promise<string[]>;
+    tablesInSchema(id: number, schema: string): Promise<Table[]>;
+}
+
+declare class TableApi {
+    private client;
+    constructor(client: MetabaseClient);
+    get(id: number): Promise<Table>;
+    queryMetadata(id: number): Promise<Table & {
+        fields: Field[];
+    }>;
+    foreignKeys(id: number): Promise<unknown[]>;
+}
+
+declare class FieldApi {
+    private client;
+    constructor(client: MetabaseClient);
+    get(id: number): Promise<Field>;
+    values(id: number): Promise<{
+        values: unknown[][];
+    }>;
+}
+
+interface CreateSnippetParams {
+    name: string;
+    content: string;
+    description?: string;
+    collection_id?: number;
+}
+interface UpdateSnippetParams {
+    name?: string;
+    content?: string;
+    description?: string;
+    collection_id?: number;
+    archived?: boolean;
+}
+declare class SnippetApi {
+    private client;
+    constructor(client: MetabaseClient);
+    list(params?: Record<string, string>): Promise<Snippet[]>;
+    get(id: number): Promise<Snippet>;
+    create(params: CreateSnippetParams): Promise<Snippet>;
+    update(id: number, params: UpdateSnippetParams): Promise<Snippet>;
+}
+
+declare class SearchApi {
+    private client;
+    constructor(client: MetabaseClient);
+    search(query: string, params?: {
+        models?: string[];
+        limit?: number;
+        offset?: number;
+    }): Promise<PaginatedResponse<SearchResult>>;
+}
+
+declare class UserApi {
+    private client;
+    constructor(client: MetabaseClient);
+    list(params?: Record<string, string>): Promise<PaginatedResponse<User>>;
+    get(id: number): Promise<User>;
+    current(): Promise<User>;
+}
+
+declare function formatDatasetResponse(dataset: DatasetResponse, format?: OutputFormat, columns?: string[]): string;
+declare function formatJson(data: unknown): string;
+declare function formatEntityTable(items: Record<string, unknown>[], columns: {
+    key: string;
+    header: string;
+}[]): string;
+
+export { type ApiKeyAuth, type CachedUser, type Card, CardApi, type Collection, CollectionApi, type Config, type DashCard, type Dashboard, DashboardApi, type Database, DatabaseApi, DatasetApi, type DatasetColumn, type DatasetQuery, type DatasetResponse, type Field, FieldApi, MetabaseClient, type OutputFormat, type PaginatedResponse, type Parameter, type Profile, SafetyGuard, SearchApi, type SearchResult, SessionApi, type SessionAuth, type SessionResponse, type Snippet, SnippetApi, type Table, TableApi, type User, UserApi, addProfile, formatDatasetResponse, formatEntityTable, formatJson, getActiveProfile, listProfiles, loadConfig, removeProfile, saveConfig, setActiveProfile, updateProfile };