@metabase/client 0.0.0-stage → 0.1.0

package/dist/transform-CXOT5kFe.d.ts

@@ -0,0 +1,638 @@
+import { i as SortDirection } from "./query-Xsin530u.js";
+import { f as RequestOptions, h as Transport } from "./transport-E0ZaPNWJ.js";
+import { t as ListResult } from "./list-BT_bBm9Z.js";
+import { n as Page, r as PaginateOptions } from "./paginate-DZWvWvbm.js";
+import { a as PollOptions } from "./poll-CIwnee7h.js";
+import { d as TransformRunStatus, h as TransformRunSummaryType, i as TransformDagDirection, l as TransformRunMethod, m as TransformRunSummarySortColumn } from "./transform-CDurgE1D.js";
+//#region src/resources/transform.d.ts
+interface TransformRunParams {
+  /** Poll the run to a terminal status. Without it the call returns once the run is queued. */
+  wait?: PollOptions | undefined;
+  /**
+   * After a successful run, additionally poll until the run's output table is registered and
+   * report its id. Implies waiting for the run itself.
+   */
+  syncTarget?: boolean | undefined;
+}
+interface TransformRunPageParams {
+  "transform-ids"?: number | undefined;
+}
+type TransformRunPageOptions = Omit<PaginateOptions, "query">;
+interface TransformRunSummaryPageParams {
+  /** Which kinds of root run to include; every kind when absent. */
+  types?: readonly TransformRunSummaryType[] | undefined;
+  statuses?: readonly TransformRunStatus[] | undefined;
+  "run-methods"?: readonly TransformRunMethod[] | undefined;
+  /** A date range in the query processor's date-parameter syntax, constraining `start_time`. */
+  "start-time"?: string | undefined;
+  "end-time"?: string | undefined;
+  /** Only runs that ran any of these transforms, as a member or standalone. */
+  "transform-ids"?: readonly number[] | undefined;
+  "sort-column"?: TransformRunSummarySortColumn | undefined;
+  "sort-direction"?: SortDirection | undefined;
+}
+interface TransformDagParams {
+  direction: TransformDagDirection;
+}
+declare function transformResource(transport: Transport): {
+  list: (options?: RequestOptions | undefined) => Promise<ListResult<{
+    [x: string]: unknown;
+    id: number;
+    name: string;
+    description: string | null;
+    source: {
+      [x: string]: unknown;
+      type: "query";
+      query: unknown;
+      "source-incremental-strategy"?: {
+        [x: string]: unknown;
+        type: "checkpoint";
+        "checkpoint-filter-field-id"?: number | undefined;
+      } | undefined;
+    } | {
+      [x: string]: unknown;
+      type: "python";
+      body: string;
+      "source-tables": {
+        [x: string]: unknown;
+        alias: string;
+        database_id: number;
+        schema: string | null;
+        table?: string | undefined;
+        table_id?: number | null | undefined;
+      }[];
+      "source-database"?: number | undefined;
+      "source-incremental-strategy"?: {
+        [x: string]: unknown;
+        type: "checkpoint";
+        "checkpoint-filter-field-id"?: number | undefined;
+      } | undefined;
+    };
+    target: {
+      [x: string]: unknown;
+      type: "table";
+      name: string;
+      database?: number | undefined;
+      schema?: string | null | undefined;
+    } | {
+      [x: string]: unknown;
+      type: "table-incremental";
+      name: string;
+      "target-incremental-strategy": {
+        [x: string]: unknown;
+        type: "append";
+      } | {
+        [x: string]: unknown;
+        type: "merge";
+        "unique-key": {
+          [x: string]: unknown;
+          name?: string | undefined;
+          "field-id"?: number | null | undefined;
+        }[];
+      };
+      database?: number | undefined;
+      schema?: string | null | undefined;
+    };
+    source_type: "native" | "python" | "mbql";
+    entity_id: string | null;
+    created_at: string;
+    updated_at: string;
+    creator_id: number;
+    collection_id: number | null;
+    target_table_id: number | null;
+    source_database_id?: number | null | undefined;
+    target_db_id?: number | null | undefined;
+    run_trigger?: "none" | "global-schedule" | null | undefined;
+    last_run?: {
+      [x: string]: unknown;
+      id: number;
+      transform_id: number;
+      run_method: "manual" | "cron";
+      status: "timeout" | "failed" | "started" | "succeeded" | "canceled" | "canceling";
+      start_time: string;
+      message: string | null;
+      user_id: number | null;
+      end_time?: string | null | undefined;
+    } | null | undefined;
+    tag_ids?: number[] | undefined;
+  }>>;
+  get: (id: number, options?: RequestOptions | undefined) => Promise<{
+    [x: string]: unknown;
+    id: number;
+    name: string;
+    description: string | null;
+    source: {
+      [x: string]: unknown;
+      type: "query";
+      query: unknown;
+      "source-incremental-strategy"?: {
+        [x: string]: unknown;
+        type: "checkpoint";
+        "checkpoint-filter-field-id"?: number | undefined;
+      } | undefined;
+    } | {
+      [x: string]: unknown;
+      type: "python";
+      body: string;
+      "source-tables": {
+        [x: string]: unknown;
+        alias: string;
+        database_id: number;
+        schema: string | null;
+        table?: string | undefined;
+        table_id?: number | null | undefined;
+      }[];
+      "source-database"?: number | undefined;
+      "source-incremental-strategy"?: {
+        [x: string]: unknown;
+        type: "checkpoint";
+        "checkpoint-filter-field-id"?: number | undefined;
+      } | undefined;
+    };
+    target: {
+      [x: string]: unknown;
+      type: "table";
+      name: string;
+      database?: number | undefined;
+      schema?: string | null | undefined;
+    } | {
+      [x: string]: unknown;
+      type: "table-incremental";
+      name: string;
+      "target-incremental-strategy": {
+        [x: string]: unknown;
+        type: "append";
+      } | {
+        [x: string]: unknown;
+        type: "merge";
+        "unique-key": {
+          [x: string]: unknown;
+          name?: string | undefined;
+          "field-id"?: number | null | undefined;
+        }[];
+      };
+      database?: number | undefined;
+      schema?: string | null | undefined;
+    };
+    source_type: "native" | "python" | "mbql";
+    entity_id: string | null;
+    created_at: string;
+    updated_at: string;
+    creator_id: number;
+    collection_id: number | null;
+    target_table_id: number | null;
+    source_database_id?: number | null | undefined;
+    target_db_id?: number | null | undefined;
+    run_trigger?: "none" | "global-schedule" | null | undefined;
+    last_run?: {
+      [x: string]: unknown;
+      id: number;
+      transform_id: number;
+      run_method: "manual" | "cron";
+      status: "timeout" | "failed" | "started" | "succeeded" | "canceled" | "canceling";
+      start_time: string;
+      message: string | null;
+      user_id: number | null;
+      end_time?: string | null | undefined;
+    } | null | undefined;
+    tag_ids?: number[] | undefined;
+  }>;
+  create: (params: {
+    [x: string]: unknown;
+    name: string;
+    source: {
+      [x: string]: unknown;
+      type: "query";
+      query: unknown;
+      "source-incremental-strategy"?: {
+        [x: string]: unknown;
+        type: "checkpoint";
+        "checkpoint-filter-field-id"?: number | undefined;
+      } | undefined;
+    } | {
+      [x: string]: unknown;
+      type: "python";
+      body: string;
+      "source-tables": {
+        [x: string]: unknown;
+        alias: string;
+        database_id: number;
+        schema: string | null;
+        table?: string | undefined;
+        table_id?: number | null | undefined;
+      }[];
+      "source-database"?: number | undefined;
+      "source-incremental-strategy"?: {
+        [x: string]: unknown;
+        type: "checkpoint";
+        "checkpoint-filter-field-id"?: number | undefined;
+      } | undefined;
+    };
+    target: {
+      [x: string]: unknown;
+      type: "table";
+      name: string;
+      database?: number | undefined;
+      schema?: string | null | undefined;
+    } | {
+      [x: string]: unknown;
+      type: "table-incremental";
+      name: string;
+      "target-incremental-strategy": {
+        [x: string]: unknown;
+        type: "append";
+      } | {
+        [x: string]: unknown;
+        type: "merge";
+        "unique-key": {
+          [x: string]: unknown;
+          name?: string | undefined;
+          "field-id"?: number | null | undefined;
+        }[];
+      };
+      database?: number | undefined;
+      schema?: string | null | undefined;
+    };
+    description?: string | null | undefined;
+    run_trigger?: "none" | "global-schedule" | undefined;
+    tag_ids?: number[] | undefined;
+    collection_id?: number | null | undefined;
+    owner_user_id?: number | null | undefined;
+    owner_email?: string | null | undefined;
+  }, options?: RequestOptions | undefined) => Promise<{
+    [x: string]: unknown;
+    id: number;
+    name: string;
+    description: string | null;
+    source: {
+      [x: string]: unknown;
+      type: "query";
+      query: unknown;
+      "source-incremental-strategy"?: {
+        [x: string]: unknown;
+        type: "checkpoint";
+        "checkpoint-filter-field-id"?: number | undefined;
+      } | undefined;
+    } | {
+      [x: string]: unknown;
+      type: "python";
+      body: string;
+      "source-tables": {
+        [x: string]: unknown;
+        alias: string;
+        database_id: number;
+        schema: string | null;
+        table?: string | undefined;
+        table_id?: number | null | undefined;
+      }[];
+      "source-database"?: number | undefined;
+      "source-incremental-strategy"?: {
+        [x: string]: unknown;
+        type: "checkpoint";
+        "checkpoint-filter-field-id"?: number | undefined;
+      } | undefined;
+    };
+    target: {
+      [x: string]: unknown;
+      type: "table";
+      name: string;
+      database?: number | undefined;
+      schema?: string | null | undefined;
+    } | {
+      [x: string]: unknown;
+      type: "table-incremental";
+      name: string;
+      "target-incremental-strategy": {
+        [x: string]: unknown;
+        type: "append";
+      } | {
+        [x: string]: unknown;
+        type: "merge";
+        "unique-key": {
+          [x: string]: unknown;
+          name?: string | undefined;
+          "field-id"?: number | null | undefined;
+        }[];
+      };
+      database?: number | undefined;
+      schema?: string | null | undefined;
+    };
+    source_type: "native" | "python" | "mbql";
+    entity_id: string | null;
+    created_at: string;
+    updated_at: string;
+    creator_id: number;
+    collection_id: number | null;
+    target_table_id: number | null;
+    source_database_id?: number | null | undefined;
+    target_db_id?: number | null | undefined;
+    run_trigger?: "none" | "global-schedule" | null | undefined;
+    last_run?: {
+      [x: string]: unknown;
+      id: number;
+      transform_id: number;
+      run_method: "manual" | "cron";
+      status: "timeout" | "failed" | "started" | "succeeded" | "canceled" | "canceling";
+      start_time: string;
+      message: string | null;
+      user_id: number | null;
+      end_time?: string | null | undefined;
+    } | null | undefined;
+    tag_ids?: number[] | undefined;
+  }>;
+  update: (id: number, params: {
+    [x: string]: unknown;
+    name?: string | undefined;
+    description?: string | null | undefined;
+    source?: {
+      [x: string]: unknown;
+      type: "query";
+      query: unknown;
+      "source-incremental-strategy"?: {
+        [x: string]: unknown;
+        type: "checkpoint";
+        "checkpoint-filter-field-id"?: number | undefined;
+      } | undefined;
+    } | {
+      [x: string]: unknown;
+      type: "python";
+      body: string;
+      "source-tables": {
+        [x: string]: unknown;
+        alias: string;
+        database_id: number;
+        schema: string | null;
+        table?: string | undefined;
+        table_id?: number | null | undefined;
+      }[];
+      "source-database"?: number | undefined;
+      "source-incremental-strategy"?: {
+        [x: string]: unknown;
+        type: "checkpoint";
+        "checkpoint-filter-field-id"?: number | undefined;
+      } | undefined;
+    } | undefined;
+    target?: {
+      [x: string]: unknown;
+      type: "table";
+      name: string;
+      database?: number | undefined;
+      schema?: string | null | undefined;
+    } | {
+      [x: string]: unknown;
+      type: "table-incremental";
+      name: string;
+      "target-incremental-strategy": {
+        [x: string]: unknown;
+        type: "append";
+      } | {
+        [x: string]: unknown;
+        type: "merge";
+        "unique-key": {
+          [x: string]: unknown;
+          name?: string | undefined;
+          "field-id"?: number | null | undefined;
+        }[];
+      };
+      database?: number | undefined;
+      schema?: string | null | undefined;
+    } | undefined;
+    run_trigger?: "none" | "global-schedule" | undefined;
+    tag_ids?: number[] | undefined;
+    collection_id?: number | null | undefined;
+    owner_user_id?: number | null | undefined;
+    owner_email?: string | null | undefined;
+  }, options?: RequestOptions | undefined) => Promise<{
+    [x: string]: unknown;
+    id: number;
+    name: string;
+    description: string | null;
+    source: {
+      [x: string]: unknown;
+      type: "query";
+      query: unknown;
+      "source-incremental-strategy"?: {
+        [x: string]: unknown;
+        type: "checkpoint";
+        "checkpoint-filter-field-id"?: number | undefined;
+      } | undefined;
+    } | {
+      [x: string]: unknown;
+      type: "python";
+      body: string;
+      "source-tables": {
+        [x: string]: unknown;
+        alias: string;
+        database_id: number;
+        schema: string | null;
+        table?: string | undefined;
+        table_id?: number | null | undefined;
+      }[];
+      "source-database"?: number | undefined;
+      "source-incremental-strategy"?: {
+        [x: string]: unknown;
+        type: "checkpoint";
+        "checkpoint-filter-field-id"?: number | undefined;
+      } | undefined;
+    };
+    target: {
+      [x: string]: unknown;
+      type: "table";
+      name: string;
+      database?: number | undefined;
+      schema?: string | null | undefined;
+    } | {
+      [x: string]: unknown;
+      type: "table-incremental";
+      name: string;
+      "target-incremental-strategy": {
+        [x: string]: unknown;
+        type: "append";
+      } | {
+        [x: string]: unknown;
+        type: "merge";
+        "unique-key": {
+          [x: string]: unknown;
+          name?: string | undefined;
+          "field-id"?: number | null | undefined;
+        }[];
+      };
+      database?: number | undefined;
+      schema?: string | null | undefined;
+    };
+    source_type: "native" | "python" | "mbql";
+    entity_id: string | null;
+    created_at: string;
+    updated_at: string;
+    creator_id: number;
+    collection_id: number | null;
+    target_table_id: number | null;
+    source_database_id?: number | null | undefined;
+    target_db_id?: number | null | undefined;
+    run_trigger?: "none" | "global-schedule" | null | undefined;
+    last_run?: {
+      [x: string]: unknown;
+      id: number;
+      transform_id: number;
+      run_method: "manual" | "cron";
+      status: "timeout" | "failed" | "started" | "succeeded" | "canceled" | "canceling";
+      start_time: string;
+      message: string | null;
+      user_id: number | null;
+      end_time?: string | null | undefined;
+    } | null | undefined;
+    tag_ids?: number[] | undefined;
+  }>;
+  delete: (id: number, options?: RequestOptions | undefined) => Promise<void>;
+  deleteTable: (id: number, options?: RequestOptions | undefined) => Promise<void>;
+  dependencies: (id: number, options?: RequestOptions | undefined) => Promise<ListResult<{
+    [x: string]: unknown;
+    id: number;
+    name: string;
+    description: string | null;
+    source: {
+      [x: string]: unknown;
+      type: "query";
+      query: unknown;
+      "source-incremental-strategy"?: {
+        [x: string]: unknown;
+        type: "checkpoint";
+        "checkpoint-filter-field-id"?: number | undefined;
+      } | undefined;
+    } | {
+      [x: string]: unknown;
+      type: "python";
+      body: string;
+      "source-tables": {
+        [x: string]: unknown;
+        alias: string;
+        database_id: number;
+        schema: string | null;
+        table?: string | undefined;
+        table_id?: number | null | undefined;
+      }[];
+      "source-database"?: number | undefined;
+      "source-incremental-strategy"?: {
+        [x: string]: unknown;
+        type: "checkpoint";
+        "checkpoint-filter-field-id"?: number | undefined;
+      } | undefined;
+    };
+    target: {
+      [x: string]: unknown;
+      type: "table";
+      name: string;
+      database?: number | undefined;
+      schema?: string | null | undefined;
+    } | {
+      [x: string]: unknown;
+      type: "table-incremental";
+      name: string;
+      "target-incremental-strategy": {
+        [x: string]: unknown;
+        type: "append";
+      } | {
+        [x: string]: unknown;
+        type: "merge";
+        "unique-key": {
+          [x: string]: unknown;
+          name?: string | undefined;
+          "field-id"?: number | null | undefined;
+        }[];
+      };
+      database?: number | undefined;
+      schema?: string | null | undefined;
+    };
+    source_type: "native" | "python" | "mbql";
+    entity_id: string | null;
+    created_at: string;
+    updated_at: string;
+    creator_id: number;
+    collection_id: number | null;
+    target_table_id: number | null;
+    source_database_id?: number | null | undefined;
+    target_db_id?: number | null | undefined;
+    run_trigger?: "none" | "global-schedule" | null | undefined;
+    last_run?: {
+      [x: string]: unknown;
+      id: number;
+      transform_id: number;
+      run_method: "manual" | "cron";
+      status: "timeout" | "failed" | "started" | "succeeded" | "canceled" | "canceling";
+      start_time: string;
+      message: string | null;
+      user_id: number | null;
+      end_time?: string | null | undefined;
+    } | null | undefined;
+    tag_ids?: number[] | undefined;
+  }>>;
+  cancel: (id: number, options?: RequestOptions | undefined) => Promise<void>;
+  getRun: (runId: number, options?: RequestOptions | undefined) => Promise<{
+    [x: string]: unknown;
+    id: number;
+    transform_id: number | null;
+    run_method: "manual" | "cron";
+    status: "timeout" | "failed" | "started" | "succeeded" | "canceled" | "canceling";
+    is_active: boolean | null;
+    start_time: string;
+    message: string | null;
+    user_id: number | null;
+    end_time?: string | null | undefined;
+  }>;
+  runPages: (params?: TransformRunPageParams | undefined, options?: TransformRunPageOptions | undefined) => AsyncIterable<Page<{
+    [x: string]: unknown;
+    id: number;
+    transform_id: number | null;
+    run_method: "manual" | "cron";
+    status: "timeout" | "failed" | "started" | "succeeded" | "canceled" | "canceling";
+    is_active: boolean | null;
+    start_time: string;
+    message: string | null;
+    user_id: number | null;
+    end_time?: string | null | undefined;
+  }>>;
+  runSummaryPages: (params?: TransformRunSummaryPageParams | undefined, options?: TransformRunPageOptions | undefined) => AsyncIterable<Page<{
+    [x: string]: unknown;
+    run_type: "transform" | "job" | "dag";
+    id: number;
+    entity_id: number | null;
+    name: string | null;
+    direction: "upstream" | "downstream" | null;
+    transform_count: number | null;
+    run_method: "manual" | "cron" | null;
+    status: "timeout" | "failed" | "started" | "succeeded" | "canceled" | "canceling";
+    is_active: boolean | null;
+    start_time: string;
+    message: string | null;
+    user_id: number | null;
+    end_time?: string | null | undefined;
+  }>>;
+  resetCheckpoint: (id: number, options?: RequestOptions | undefined) => Promise<void>;
+  runDag: (id: number, params: TransformDagParams, options?: RequestOptions | undefined) => Promise<{
+    message: string;
+    dag_run_id: number | null;
+  }>;
+  dagTransforms: (id: number, params: TransformDagParams, options?: RequestOptions | undefined) => Promise<ListResult<{
+    id: number;
+    name: string;
+  }>>;
+  run: (id: number, params?: TransformRunParams | undefined, options?: RequestOptions | undefined) => Promise<{
+    message: string;
+    run_id: number | null;
+    final: {
+      [x: string]: unknown;
+      id: number;
+      transform_id: number | null;
+      run_method: "manual" | "cron";
+      status: "timeout" | "failed" | "started" | "succeeded" | "canceled" | "canceling";
+      is_active: boolean | null;
+      start_time: string;
+      message: string | null;
+      user_id: number | null;
+      end_time?: string | null | undefined;
+    } | null;
+    target_table_id?: number | null | undefined;
+  }>;
+};
+//#endregion
+export { TransformRunSummaryPageParams as a, TransformRunParams as i, TransformRunPageOptions as n, transformResource as o, TransformRunPageParams as r, TransformDagParams as t };

package/dist/transform-dag-run-BgZwv1yx.d.ts

@@ -0,0 +1,49 @@
+import { z } from "zod";
+//#region src/domain/transform-dag-run.d.ts
+declare const TransformMemberRun: z.ZodObject<{
+  id: z.ZodNumber;
+  transform_id: z.ZodNullable<z.ZodNumber>;
+  run_method: z.ZodEnum<{
+    manual: "manual";
+    cron: "cron";
+  }>;
+  status: z.ZodEnum<{
+    timeout: "timeout";
+    failed: "failed";
+    started: "started";
+    succeeded: "succeeded";
+    canceled: "canceled";
+    canceling: "canceling";
+  }>;
+  is_active: z.ZodNullable<z.ZodBoolean>;
+  start_time: z.ZodString;
+  end_time: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+  message: z.ZodNullable<z.ZodString>;
+  user_id: z.ZodNullable<z.ZodNumber>;
+  job_run_id: z.ZodNullable<z.ZodNumber>;
+  dag_run_id: z.ZodNullable<z.ZodNumber>;
+}, z.core.$loose>;
+type TransformMemberRun = z.infer<typeof TransformMemberRun>;
+declare const TransformMemberRunCompact: z.ZodObject<{
+  message: z.ZodNullable<z.ZodString>;
+  id: z.ZodNumber;
+  status: z.ZodEnum<{
+    timeout: "timeout";
+    failed: "failed";
+    started: "started";
+    succeeded: "succeeded";
+    canceled: "canceled";
+    canceling: "canceling";
+  }>;
+  start_time: z.ZodString;
+  end_time: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+  run_method: z.ZodEnum<{
+    manual: "manual";
+    cron: "cron";
+  }>;
+  transform_id: z.ZodNullable<z.ZodNumber>;
+  dag_run_id: z.ZodNullable<z.ZodNumber>;
+}, z.core.$strip>;
+type TransformMemberRunCompact = z.infer<typeof TransformMemberRunCompact>;
+//#endregion
+export { TransformMemberRunCompact as n, TransformMemberRun as t };