@metabase/client 0.0.0-stage → 0.1.0

package/dist/transform-CDurgE1D.d.ts

@@ -0,0 +1,443 @@
+import { o as Features } from "./features-CnFkUCj2.js";
+import { z } from "zod";
+//#region src/domain/transform.d.ts
+declare const TransformRunStatus: z.ZodEnum<{
+  timeout: "timeout";
+  failed: "failed";
+  started: "started";
+  succeeded: "succeeded";
+  canceled: "canceled";
+  canceling: "canceling";
+}>;
+type TransformRunStatus = z.infer<typeof TransformRunStatus>;
+/** Whether the server will report any further progress for a run in this status. */
+declare function isTransformRunTerminal(status: TransformRunStatus): boolean;
+/** Whether a terminal status means the run did not produce its target table. */
+declare function isTransformRunFailed(status: TransformRunStatus): boolean;
+declare const TransformRunMethod: z.ZodEnum<{
+  manual: "manual";
+  cron: "cron";
+}>;
+type TransformRunMethod = z.infer<typeof TransformRunMethod>;
+declare const TransformSourceTableEntry: z.ZodObject<{
+  alias: z.ZodString;
+  database_id: z.ZodNumber;
+  schema: z.ZodNullable<z.ZodString>;
+  table: z.ZodOptional<z.ZodString>;
+  table_id: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+}, z.core.$loose>;
+type TransformSourceTableEntry = z.infer<typeof TransformSourceTableEntry>;
+declare const TransformTarget: z.ZodDiscriminatedUnion<[z.ZodObject<{
+  type: z.ZodLiteral<"table">;
+  database: z.ZodOptional<z.ZodNumber>;
+  schema: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+  name: z.ZodString;
+}, z.core.$loose>, z.ZodObject<{
+  type: z.ZodLiteral<"table-incremental">;
+  database: z.ZodOptional<z.ZodNumber>;
+  schema: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+  name: z.ZodString;
+  "target-incremental-strategy": z.ZodDiscriminatedUnion<[z.ZodObject<{
+    type: z.ZodLiteral<"append">;
+  }, z.core.$loose>, z.ZodObject<{
+    type: z.ZodLiteral<"merge">;
+    "unique-key": z.ZodArray<z.ZodObject<{
+      name: z.ZodOptional<z.ZodString>;
+      "field-id": z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    }, z.core.$loose>>;
+  }, z.core.$loose>], "type">;
+}, z.core.$loose>], "type">;
+type TransformTarget = z.infer<typeof TransformTarget>;
+declare const TransformRun: 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>;
+}, z.core.$loose>;
+type TransformRun = z.infer<typeof TransformRun>;
+declare const TransformRunCompact: 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>;
+}, z.core.$strip>;
+type TransformRunCompact = z.infer<typeof TransformRunCompact>;
+declare const TransformRunResult: z.ZodObject<{
+  message: z.ZodString;
+  run_id: z.ZodNullable<z.ZodNumber>;
+  final: z.ZodNullable<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>;
+  }, z.core.$loose>>;
+  target_table_id: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+}, z.core.$strip>;
+type TransformRunResult = z.infer<typeof TransformRunResult>;
+/** Which transforms a DAG reprocess from a seed transform runs, besides the seed itself. */
+declare const TransformDagDirection: z.ZodEnum<{
+  upstream: "upstream";
+  downstream: "downstream";
+}>;
+type TransformDagDirection = z.infer<typeof TransformDagDirection>;
+declare const TransformDagRunResult: z.ZodObject<{
+  message: z.ZodString;
+  dag_run_id: z.ZodNullable<z.ZodNumber>;
+}, z.core.$strip>;
+type TransformDagRunResult = z.infer<typeof TransformDagRunResult>;
+declare const TransformDagTransform: z.ZodObject<{
+  id: z.ZodNumber;
+  name: z.ZodString;
+}, z.core.$strip>;
+type TransformDagTransform = z.infer<typeof TransformDagTransform>;
+declare const TransformRunSummaryType: z.ZodEnum<{
+  transform: "transform";
+  job: "job";
+  dag: "dag";
+}>;
+type TransformRunSummaryType = z.infer<typeof TransformRunSummaryType>;
+declare const TransformRunSummarySortColumn: z.ZodEnum<{
+  start_time: "start_time";
+  end_time: "end_time";
+}>;
+type TransformRunSummarySortColumn = z.infer<typeof TransformRunSummarySortColumn>;
+declare const TransformRunSummary: z.ZodObject<{
+  run_type: z.ZodEnum<{
+    transform: "transform";
+    job: "job";
+    dag: "dag";
+  }>;
+  id: z.ZodNumber;
+  entity_id: z.ZodNullable<z.ZodNumber>;
+  name: z.ZodNullable<z.ZodString>;
+  direction: z.ZodNullable<z.ZodEnum<{
+    upstream: "upstream";
+    downstream: "downstream";
+  }>>;
+  transform_count: z.ZodNullable<z.ZodNumber>;
+  run_method: z.ZodNullable<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>;
+}, z.core.$loose>;
+type TransformRunSummary = z.infer<typeof TransformRunSummary>;
+declare const TransformRunSummaryCompact: z.ZodObject<{
+  message: z.ZodNullable<z.ZodString>;
+  name: z.ZodNullable<z.ZodString>;
+  id: z.ZodNumber;
+  entity_id: z.ZodNullable<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.ZodNullable<z.ZodEnum<{
+    manual: "manual";
+    cron: "cron";
+  }>>;
+  run_type: z.ZodEnum<{
+    transform: "transform";
+    job: "job";
+    dag: "dag";
+  }>;
+}, z.core.$strip>;
+type TransformRunSummaryCompact = z.infer<typeof TransformRunSummaryCompact>;
+declare const Transform: z.ZodObject<{
+  id: z.ZodNumber;
+  name: z.ZodString;
+  description: z.ZodNullable<z.ZodString>;
+  source: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    type: z.ZodLiteral<"query">;
+    query: z.ZodUnknown;
+    "source-incremental-strategy": z.ZodOptional<z.ZodObject<{
+      type: z.ZodLiteral<"checkpoint">;
+      "checkpoint-filter-field-id": z.ZodOptional<z.ZodNumber>;
+    }, z.core.$loose>>;
+  }, z.core.$loose>, z.ZodObject<{
+    type: z.ZodLiteral<"python">;
+    body: z.ZodString;
+    "source-tables": z.ZodArray<z.ZodObject<{
+      alias: z.ZodString;
+      database_id: z.ZodNumber;
+      schema: z.ZodNullable<z.ZodString>;
+      table: z.ZodOptional<z.ZodString>;
+      table_id: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    }, z.core.$loose>>;
+    "source-database": z.ZodOptional<z.ZodNumber>;
+    "source-incremental-strategy": z.ZodOptional<z.ZodObject<{
+      type: z.ZodLiteral<"checkpoint">;
+      "checkpoint-filter-field-id": z.ZodOptional<z.ZodNumber>;
+    }, z.core.$loose>>;
+  }, z.core.$loose>], "type">;
+  target: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    type: z.ZodLiteral<"table">;
+    database: z.ZodOptional<z.ZodNumber>;
+    schema: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    name: z.ZodString;
+  }, z.core.$loose>, z.ZodObject<{
+    type: z.ZodLiteral<"table-incremental">;
+    database: z.ZodOptional<z.ZodNumber>;
+    schema: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    name: z.ZodString;
+    "target-incremental-strategy": z.ZodDiscriminatedUnion<[z.ZodObject<{
+      type: z.ZodLiteral<"append">;
+    }, z.core.$loose>, z.ZodObject<{
+      type: z.ZodLiteral<"merge">;
+      "unique-key": z.ZodArray<z.ZodObject<{
+        name: z.ZodOptional<z.ZodString>;
+        "field-id": z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+      }, z.core.$loose>>;
+    }, z.core.$loose>], "type">;
+  }, z.core.$loose>], "type">;
+  source_type: z.ZodEnum<{
+    native: "native";
+    python: "python";
+    mbql: "mbql";
+  }>;
+  source_database_id: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+  target_db_id: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+  entity_id: z.ZodNullable<z.ZodString>;
+  created_at: z.ZodString;
+  updated_at: z.ZodString;
+  creator_id: z.ZodNumber;
+  collection_id: z.ZodNullable<z.ZodNumber>;
+  run_trigger: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
+    none: "none";
+    "global-schedule": "global-schedule";
+  }>>>;
+  last_run: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+    id: z.ZodNumber;
+    transform_id: 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";
+    }>;
+    start_time: z.ZodString;
+    end_time: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    message: z.ZodNullable<z.ZodString>;
+    user_id: z.ZodNullable<z.ZodNumber>;
+  }, z.core.$loose>>>;
+  tag_ids: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
+  target_table_id: z.ZodNullable<z.ZodNumber>;
+}, z.core.$loose>;
+type Transform = z.infer<typeof Transform>;
+/** The shape `GET /api/transform/{id}` answers on a server with `features`, read as `Transform`. */
+declare function transformDetailSchema(features: Features): z.ZodType<Transform>;
+/** The shape every other transform endpoint answers on a server with `features`, read as `Transform`. */
+declare function transformRowSchema(features: Features): z.ZodType<Transform>;
+declare const TransformCompact: z.ZodObject<{
+  name: z.ZodString;
+  id: z.ZodNumber;
+  description: z.ZodNullable<z.ZodString>;
+  target_table_id: z.ZodNullable<z.ZodNumber>;
+  source_type: z.ZodEnum<{
+    native: "native";
+    python: "python";
+    mbql: "mbql";
+  }>;
+  target_db_id: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+  target: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    type: z.ZodLiteral<"table">;
+    database: z.ZodOptional<z.ZodNumber>;
+    schema: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    name: z.ZodString;
+  }, z.core.$strip>, z.ZodObject<{
+    type: z.ZodLiteral<"table-incremental">;
+    database: z.ZodOptional<z.ZodNumber>;
+    schema: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    name: z.ZodString;
+    "target-incremental-strategy": z.ZodDiscriminatedUnion<[z.ZodObject<{
+      type: z.ZodLiteral<"append">;
+    }, z.core.$loose>, z.ZodObject<{
+      type: z.ZodLiteral<"merge">;
+      "unique-key": z.ZodArray<z.ZodObject<{
+        name: z.ZodOptional<z.ZodString>;
+        "field-id": z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+      }, z.core.$loose>>;
+    }, z.core.$loose>], "type">;
+  }, z.core.$strip>], "type">;
+}, z.core.$strip>;
+type TransformCompact = z.infer<typeof TransformCompact>;
+declare const TransformCreateInput: z.ZodObject<{
+  name: z.ZodString;
+  description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+  source: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    type: z.ZodLiteral<"query">;
+    query: z.ZodUnknown;
+    "source-incremental-strategy": z.ZodOptional<z.ZodObject<{
+      type: z.ZodLiteral<"checkpoint">;
+      "checkpoint-filter-field-id": z.ZodOptional<z.ZodNumber>;
+    }, z.core.$loose>>;
+  }, z.core.$loose>, z.ZodObject<{
+    type: z.ZodLiteral<"python">;
+    body: z.ZodString;
+    "source-tables": z.ZodArray<z.ZodObject<{
+      alias: z.ZodString;
+      database_id: z.ZodNumber;
+      schema: z.ZodNullable<z.ZodString>;
+      table: z.ZodOptional<z.ZodString>;
+      table_id: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    }, z.core.$loose>>;
+    "source-database": z.ZodOptional<z.ZodNumber>;
+    "source-incremental-strategy": z.ZodOptional<z.ZodObject<{
+      type: z.ZodLiteral<"checkpoint">;
+      "checkpoint-filter-field-id": z.ZodOptional<z.ZodNumber>;
+    }, z.core.$loose>>;
+  }, z.core.$loose>], "type">;
+  target: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    type: z.ZodLiteral<"table">;
+    database: z.ZodOptional<z.ZodNumber>;
+    schema: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    name: z.ZodString;
+  }, z.core.$loose>, z.ZodObject<{
+    type: z.ZodLiteral<"table-incremental">;
+    database: z.ZodOptional<z.ZodNumber>;
+    schema: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    name: z.ZodString;
+    "target-incremental-strategy": z.ZodDiscriminatedUnion<[z.ZodObject<{
+      type: z.ZodLiteral<"append">;
+    }, z.core.$loose>, z.ZodObject<{
+      type: z.ZodLiteral<"merge">;
+      "unique-key": z.ZodArray<z.ZodObject<{
+        name: z.ZodOptional<z.ZodString>;
+        "field-id": z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+      }, z.core.$loose>>;
+    }, z.core.$loose>], "type">;
+  }, z.core.$loose>], "type">;
+  run_trigger: z.ZodOptional<z.ZodEnum<{
+    none: "none";
+    "global-schedule": "global-schedule";
+  }>>;
+  tag_ids: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
+  collection_id: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+  owner_user_id: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+  owner_email: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, z.core.$loose>;
+type TransformCreateInput = z.infer<typeof TransformCreateInput>;
+declare const TransformUpdateInput: z.ZodObject<{
+  name: z.ZodOptional<z.ZodString>;
+  description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+  source: z.ZodOptional<z.ZodDiscriminatedUnion<[z.ZodObject<{
+    type: z.ZodLiteral<"query">;
+    query: z.ZodUnknown;
+    "source-incremental-strategy": z.ZodOptional<z.ZodObject<{
+      type: z.ZodLiteral<"checkpoint">;
+      "checkpoint-filter-field-id": z.ZodOptional<z.ZodNumber>;
+    }, z.core.$loose>>;
+  }, z.core.$loose>, z.ZodObject<{
+    type: z.ZodLiteral<"python">;
+    body: z.ZodString;
+    "source-tables": z.ZodArray<z.ZodObject<{
+      alias: z.ZodString;
+      database_id: z.ZodNumber;
+      schema: z.ZodNullable<z.ZodString>;
+      table: z.ZodOptional<z.ZodString>;
+      table_id: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    }, z.core.$loose>>;
+    "source-database": z.ZodOptional<z.ZodNumber>;
+    "source-incremental-strategy": z.ZodOptional<z.ZodObject<{
+      type: z.ZodLiteral<"checkpoint">;
+      "checkpoint-filter-field-id": z.ZodOptional<z.ZodNumber>;
+    }, z.core.$loose>>;
+  }, z.core.$loose>], "type">>;
+  target: z.ZodOptional<z.ZodDiscriminatedUnion<[z.ZodObject<{
+    type: z.ZodLiteral<"table">;
+    database: z.ZodOptional<z.ZodNumber>;
+    schema: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    name: z.ZodString;
+  }, z.core.$loose>, z.ZodObject<{
+    type: z.ZodLiteral<"table-incremental">;
+    database: z.ZodOptional<z.ZodNumber>;
+    schema: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    name: z.ZodString;
+    "target-incremental-strategy": z.ZodDiscriminatedUnion<[z.ZodObject<{
+      type: z.ZodLiteral<"append">;
+    }, z.core.$loose>, z.ZodObject<{
+      type: z.ZodLiteral<"merge">;
+      "unique-key": z.ZodArray<z.ZodObject<{
+        name: z.ZodOptional<z.ZodString>;
+        "field-id": z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+      }, z.core.$loose>>;
+    }, z.core.$loose>], "type">;
+  }, z.core.$loose>], "type">>;
+  run_trigger: z.ZodOptional<z.ZodEnum<{
+    none: "none";
+    "global-schedule": "global-schedule";
+  }>>;
+  tag_ids: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
+  collection_id: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+  owner_user_id: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+  owner_email: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, z.core.$loose>;
+type TransformUpdateInput = z.infer<typeof TransformUpdateInput>;
+//#endregion
+export { transformRowSchema as S, TransformTarget as _, TransformDagRunResult as a, isTransformRunTerminal as b, TransformRunCompact as c, TransformRunStatus as d, TransformRunSummary as f, TransformSourceTableEntry as g, TransformRunSummaryType as h, TransformDagDirection as i, TransformRunMethod as l, TransformRunSummarySortColumn as m, TransformCompact as n, TransformDagTransform as o, TransformRunSummaryCompact as p, TransformCreateInput as r, TransformRun as s, Transform as t, TransformRunResult as u, TransformUpdateInput as v, transformDetailSchema as x, isTransformRunFailed as y };