@metabase/cli 0.1.0 → 0.1.2

package/dist/{table-Cfk7oSvw.mjs → table-B-PYcgGb.mjs}

@@ -1,4 +1,4 @@
-import { Field } from "./field-C8IVs6rp.mjs";
+import { Field, FieldCompact } from "./field-B3gvaqpK.mjs";
 import { z } from "zod";
 
 //#region src/domain/table.ts
@@ -12,14 +12,16 @@ const TableEntityType = z.enum([
 	"entity/EventTable"
 ]);
 const TableVisibilityType = z.enum([
-	"details-only",
 	"hidden",
-	"normal",
-	"retired",
-	"sensitive",
 	"technical",
 	"cruft"
 ]);
+const TableFieldOrder = z.enum([
+	"alphabetical",
+	"custom",
+	"database",
+	"smart"
+]);
 const Table = z.object({
 	id: z.number().int(),
 	name: z.string(),
@@ -28,10 +30,11 @@ const Table = z.object({
 	db_id: z.number().int(),
 	schema: z.string().nullable(),
 	entity_type: TableEntityType.nullable(),
-	visibility_type: TableVisibilityType.nullable(),
-	active: z.boolean(),
+	visibility_type: TableVisibilityType.nullable().optional(),
+	active: z.boolean().optional(),
 	fields: z.array(Field).optional()
 }).loose();
+const TableQueryMetadata = Table.extend({ fields: z.array(Field) });
 const TableCompact = Table.pick({
 	id: true,
 	name: true,
@@ -40,7 +43,7 @@ const TableCompact = Table.pick({
 	db_id: true,
 	schema: true,
 	entity_type: true
-}).strip();
+}).strip().extend({ fields: z.array(FieldCompact).optional() });
 const tableView = {
 	compactPick: TableCompact,
 	tableColumns: [
@@ -70,6 +73,16 @@ const tableView = {
 		}
 	]
 };
+const TableUpdateInput = z.object({
+	display_name: z.string().min(1).optional(),
+	entity_type: TableEntityType.nullable().optional(),
+	visibility_type: TableVisibilityType.nullable().optional(),
+	description: z.string().nullable().optional(),
+	caveats: z.string().nullable().optional(),
+	points_of_interest: z.string().nullable().optional(),
+	show_in_getting_started: z.boolean().optional(),
+	field_order: TableFieldOrder.optional()
+}).loose();
 
 //#endregion
-export { Table, TableCompact, tableView };
+export { Table, TableCompact, TableQueryMetadata, TableUpdateInput, tableView };

package/dist/table-Cdr5bKp1.mjs

@@ -0,0 +1,19 @@
+import { defineCommand } from "citty";
+
+//#region src/commands/table/index.ts
+var table_default = defineCommand({
+	meta: {
+		name: "table",
+		description: "Inspect Metabase tables"
+	},
+	subCommands: {
+		list: () => import("./list-CP5RNjO6.mjs").then((m) => m.default),
+		get: () => import("./get-D2m4jhwT.mjs").then((m) => m.default),
+		metadata: () => import("./metadata-BTJAFVvZ.mjs").then((m) => m.default),
+		fields: () => import("./fields-7ByLsxLg.mjs").then((m) => m.default),
+		update: () => import("./update-Cp1789qq.mjs").then((m) => m.default)
+	}
+});
+
+//#endregion
+export { table_default as default };

package/dist/transform-CeZusR_w.mjs

@@ -0,0 +1,24 @@
+import { defineCommand } from "citty";
+
+//#region src/commands/transform/index.ts
+var transform_default = defineCommand({
+	meta: {
+		name: "transform",
+		description: "Manage Metabase transforms"
+	},
+	subCommands: {
+		list: () => import("./list-iFVEdi2J.mjs").then((mod) => mod.default),
+		get: () => import("./get-gOT_RarI.mjs").then((mod) => mod.default),
+		create: () => import("./create-BUCLNqiN.mjs").then((mod) => mod.default),
+		update: () => import("./update-B5_pp6Jj.mjs").then((mod) => mod.default),
+		delete: () => import("./delete-CVYII8mq.mjs").then((mod) => mod.default),
+		"delete-table": () => import("./delete-table-ZiR9-ndv.mjs").then((mod) => mod.default),
+		run: () => import("./run-DxVzhcF3.mjs").then((mod) => mod.default),
+		cancel: () => import("./cancel-CgLZcItQ.mjs").then((mod) => mod.default),
+		"get-run": () => import("./get-run-D59Yqaoh.mjs").then((mod) => mod.default),
+		runs: () => import("./runs-BOHk1XnM.mjs").then((mod) => mod.default)
+	}
+});
+
+//#endregion
+export { transform_default as default };

package/dist/{transform-B5uRpg1G.mjs → transform-IEX4Mx3X.mjs}

@@ -38,6 +38,7 @@ const TransformTableIncrementalTarget = z.object({
 	name: z.string()
 }).loose();
 const TransformTarget = z.discriminatedUnion("type", [TransformTableTarget, TransformTableIncrementalTarget]);
+const TransformTargetCompact = z.discriminatedUnion("type", [TransformTableTarget.strip(), TransformTableIncrementalTarget.strip()]);
 const TransformLastRun = z.object({
 	id: z.number().int(),
 	transform_id: z.number().int(),
@@ -59,6 +60,48 @@ const TransformRun = z.object({
 	message: z.string().nullable(),
 	user_id: z.number().int().nullable()
 }).loose();
+const TransformRunCompact = TransformRun.pick({
+	id: true,
+	transform_id: true,
+	status: true,
+	run_method: true,
+	start_time: true,
+	end_time: true,
+	message: true
+}).strip();
+const transformRunView = {
+	compactPick: TransformRunCompact,
+	tableColumns: [
+		{
+			key: "id",
+			label: "Run ID"
+		},
+		{
+			key: "transform_id",
+			label: "Transform"
+		},
+		{
+			key: "status",
+			label: "Status"
+		},
+		{
+			key: "run_method",
+			label: "Method"
+		},
+		{
+			key: "start_time",
+			label: "Started"
+		},
+		{
+			key: "end_time",
+			label: "Ended"
+		},
+		{
+			key: "message",
+			label: "Message"
+		}
+	]
+};
 const Transform = z.object({
 	id: z.number().int(),
 	name: z.string(),
@@ -84,7 +127,7 @@ const TransformCompact = Transform.pick({
 	description: true,
 	source_type: true,
 	target_db_id: true
-}).strip();
+}).strip().extend({ target: TransformTargetCompact });
 const transformView = {
 	compactPick: TransformCompact,
 	tableColumns: [
@@ -100,6 +143,11 @@ const transformView = {
 			key: "source_type",
 			label: "Source"
 		},
+		{
+			key: "target",
+			label: "Target",
+			format: (value) => formatTarget(value)
+		},
 		{
 			key: "target_db_id",
 			label: "Target DB"
@@ -110,6 +158,12 @@ const transformView = {
 		}
 	]
 };
+function formatTarget(value) {
+	const parsed = TransformTarget.safeParse(value);
+	if (!parsed.success) return "";
+	const { schema, name } = parsed.data;
+	return schema ? `${schema}.${name}` : name;
+}
 const TransformCreateInput = z.object({
 	name: z.string().min(1),
 	description: z.string().nullable().optional(),
@@ -134,4 +188,4 @@ const TransformUpdateInput = z.object({
 }).loose();
 
 //#endregion
-export { Transform, TransformCompact, TransformCreateInput, TransformRun, TransformUpdateInput, transformView };
+export { Transform, TransformCompact, TransformCreateInput, TransformRun, TransformRunCompact, TransformUpdateInput, transformRunView, transformView };

package/dist/transform-job-BOn9-CGa.mjs

@@ -0,0 +1,19 @@
+import { defineCommand } from "citty";
+
+//#region src/commands/transform-job/index.ts
+var transform_job_default = defineCommand({
+	meta: {
+		name: "transform-job",
+		description: "Manage Metabase transform jobs"
+	},
+	subCommands: {
+		list: () => import("./list-Cy0VhXQs.mjs").then((mod) => mod.default),
+		get: () => import("./get-DKy3DAJX.mjs").then((mod) => mod.default),
+		create: () => import("./create-bqc_rmix.mjs").then((mod) => mod.default),
+		update: () => import("./update-Masp5WeT.mjs").then((mod) => mod.default),
+		delete: () => import("./delete-DeZQ1r9w.mjs").then((mod) => mod.default)
+	}
+});
+
+//#endregion
+export { transform_job_default as default };

package/dist/{transform-job-C7QXWTVE.mjs → transform-job-Csr86muI.mjs}

@@ -27,6 +27,7 @@ const TransformJob = z.object({
 	description: z.string().nullable(),
 	schedule: z.string(),
 	ui_display_type: JobUiDisplayType,
+	active: z.boolean(),
 	entity_id: z.string().nullable(),
 	created_at: z.string(),
 	updated_at: z.string(),
@@ -41,6 +42,7 @@ const TransformJobCompact = TransformJob.pick({
 	description: true,
 	schedule: true,
 	ui_display_type: true,
+	active: true,
 	built_in_type: true
 }).strip();
 const transformJobView = {
@@ -62,6 +64,10 @@ const transformJobView = {
 			key: "ui_display_type",
 			label: "Display"
 		},
+		{
+			key: "active",
+			label: "Active"
+		},
 		{
 			key: "built_in_type",
 			label: "Built-in"
@@ -84,6 +90,7 @@ const TransformJobUpdateInput = z.object({
 	description: z.string().min(1).nullable().optional(),
 	schedule: z.string().min(1).optional(),
 	ui_display_type: JobUiDisplayType.optional(),
+	active: z.boolean().optional(),
 	tag_ids: z.array(z.number().int().positive()).optional()
 }).loose();
 

package/dist/translate-B__zbDKm.mjs

@@ -0,0 +1,111 @@
+import "./package-DV6Asqim.mjs";
+import "./command-augment-D9pI9Vbh.mjs";
+import { renderItem } from "./render-DXv-D6fU.mjs";
+import { ConfigError } from "./predicates-DiIiS3k7.mjs";
+import "./input-ikCiip6x.mjs";
+import { connectionFlags, defineMetabaseCommand, outputFlags, parseCsv, profileFlag } from "./runtime-cwBS8wwK.mjs";
+import { readBody } from "./body-rDrR-C1c.mjs";
+import { bodyInputFlags } from "./body-flags-BK7J6Daz.mjs";
+import { requireBothOrNeither } from "./flag-pair-DtR1AiBQ.mjs";
+import { z } from "zod";
+
+//#region src/domain/eid-translation.ts
+const EID_MODELS = [
+	"action",
+	"card",
+	"collection",
+	"dashboard",
+	"dashboard-card",
+	"dashboard-tab",
+	"dataset",
+	"dimension",
+	"document",
+	"measure",
+	"metric",
+	"permissions-group",
+	"pulse",
+	"pulse-card",
+	"pulse-channel",
+	"segment",
+	"snippet",
+	"timeline",
+	"transform",
+	"user"
+];
+const EidModel = z.enum(EID_MODELS);
+const EidTranslateInput = z.object({ entity_ids: z.partialRecord(EidModel, z.array(z.string().min(1)).min(1)) }).loose();
+const EidTranslateEntry = z.object({
+	status: z.string(),
+	type: EidModel,
+	id: z.number().int().optional()
+}).loose();
+const EidTranslateResult = z.object({ entity_ids: z.record(z.string(), EidTranslateEntry) }).loose();
+const EidTranslateResultCompact = EidTranslateResult.pick({ entity_ids: true }).strip();
+const eidTranslateView = {
+	compactPick: EidTranslateResultCompact,
+	tableColumns: [{
+		key: "entity_ids",
+		label: "Translated"
+	}]
+};
+
+//#endregion
+//#region src/commands/eid/translate.ts
+var translate_default = defineMetabaseCommand({
+	meta: {
+		name: "translate",
+		description: "Translate entity ids (EIDs) to numeric ids"
+	},
+	args: {
+		...outputFlags,
+		...profileFlag,
+		...connectionFlags,
+		...bodyInputFlags,
+		model: {
+			type: "string",
+			description: `Entity model for shortcut form: ${EID_MODELS.join(" | ")}`
+		},
+		eids: {
+			type: "string",
+			description: "Comma-separated EIDs (used with --model as a shortcut)"
+		}
+	},
+	outputSchema: EidTranslateResult,
+	examples: [
+		"metabase eid translate --model card --eids abc123XYZ,def456ABC",
+		"metabase eid translate --file translate.json",
+		"metabase eid translate --body '{\"entity_ids\":{\"card\":[\"abc123XYZ\"]}}'"
+	],
+	async run({ args, ctx, getClient }) {
+		const pair = requireBothOrNeither({
+			name: "--model",
+			value: args.model
+		}, {
+			name: "--eids",
+			value: args.eids
+		});
+		const body = pair ? EidTranslateInput.parse({ entity_ids: { [parseModel(pair.first)]: parseEids(pair.second) } }) : await readBody({
+			flag: args.body,
+			file: args.file
+		}, EidTranslateInput);
+		const client = await getClient();
+		const result = await client.requestParsed(EidTranslateResult, "/api/eid-translation/translate", {
+			method: "POST",
+			body
+		});
+		renderItem(result, eidTranslateView, ctx);
+	}
+});
+function parseModel(raw) {
+	const result = EidModel.safeParse(raw);
+	if (!result.success) throw new ConfigError(`invalid --model: "${raw}" (expected one of: ${EID_MODELS.join(", ")})`);
+	return result.data;
+}
+function parseEids(raw) {
+	const parts = parseCsv(raw);
+	if (parts.length === 0) throw new ConfigError("--eids must contain at least one EID");
+	return parts;
+}
+
+//#endregion
+export { translate_default as default };

package/dist/tree-Mh0uQ_Wy.mjs

@@ -0,0 +1,32 @@
+import "./package-DV6Asqim.mjs";
+import "./command-augment-D9pI9Vbh.mjs";
+import { writeJson } from "./render-DXv-D6fU.mjs";
+import { ConfigError } from "./predicates-DiIiS3k7.mjs";
+import { connectionFlags, defineMetabaseCommand, outputFlags, profileFlag } from "./runtime-cwBS8wwK.mjs";
+import { CollectionTreeNode } from "./collection-B3sPXRLs.mjs";
+import { z } from "zod";
+
+//#region src/commands/collection/tree.ts
+const CollectionTreeResponse = z.array(CollectionTreeNode);
+var tree_default = defineMetabaseCommand({
+	meta: {
+		name: "tree",
+		description: "Fetch the collection hierarchy as a nested tree (JSON only)"
+	},
+	args: {
+		...outputFlags,
+		...profileFlag,
+		...connectionFlags
+	},
+	outputSchema: CollectionTreeResponse,
+	examples: ["metabase collection tree", "metabase collection tree --json"],
+	async run({ ctx, getClient }) {
+		if (ctx.format === "text") throw new ConfigError("collection tree output is JSON-only; --format text is not supported");
+		const client = await getClient();
+		const tree = await client.requestParsed(CollectionTreeResponse, "/api/collection/tree");
+		writeJson(tree);
+	}
+});
+
+//#endregion
+export { tree_default as default };

package/dist/update-1Di9hbPo.mjs

@@ -0,0 +1,56 @@
+import "./package-DV6Asqim.mjs";
+import "./command-augment-D9pI9Vbh.mjs";
+import { renderItem } from "./render-DXv-D6fU.mjs";
+import "./predicates-DiIiS3k7.mjs";
+import "./input-ikCiip6x.mjs";
+import { connectionFlags, defineMetabaseCommand, outputFlags, profileFlag } from "./runtime-cwBS8wwK.mjs";
+import { readBody } from "./body-rDrR-C1c.mjs";
+import { bodyInputFlags } from "./body-flags-BK7J6Daz.mjs";
+import { parseId } from "./parse-id-B38zTlYs.mjs";
+import "./validate-DCYx6jdL.mjs";
+import { MEASURE_DEFINITION_LABELS, preflightMbql5Query, skipValidateFlag } from "./validate-query-B07oGG4K.mjs";
+import { Measure, MeasureUpdateInput, measureView } from "./measure-BEQfnLdN.mjs";
+
+//#region src/commands/measure/update.ts
+var update_default = defineMetabaseCommand({
+	meta: {
+		name: "update",
+		description: "Update a measure by id; body must include revision_message (audit-logged with the change). If definition is MBQL 5 (lib/type: mbql/query) it is pre-flight-validated against the same schema as `metabase query` (see `metabase query --print-schema`)"
+	},
+	args: {
+		...outputFlags,
+		...profileFlag,
+		...connectionFlags,
+		...bodyInputFlags,
+		...skipValidateFlag,
+		id: {
+			type: "positional",
+			description: "Measure id",
+			required: true
+		}
+	},
+	outputSchema: Measure,
+	examples: [
+		"cat patch.json | metabase measure update 1",
+		"metabase measure update 1 --file patch.json",
+		"metabase measure update 1 --body '{\"name\":\"renamed\",\"revision_message\":\"rename\"}'",
+		"metabase measure update 1 --file patch.json --skip-validate"
+	],
+	async run({ args, ctx, getClient }) {
+		const id = parseId(args.id);
+		const body = await readBody({
+			flag: args.body,
+			file: args.file
+		}, MeasureUpdateInput);
+		preflightMbql5Query(body.definition, MEASURE_DEFINITION_LABELS, { skip: args["skip-validate"] === true });
+		const client = await getClient();
+		const updated = await client.requestParsed(Measure, `/api/measure/${id}`, {
+			method: "PUT",
+			body
+		});
+		renderItem(updated, measureView, ctx);
+	}
+});
+
+//#endregion
+export { update_default as default };

package/dist/update-B5_pp6Jj.mjs

@@ -0,0 +1,56 @@
+import "./package-DV6Asqim.mjs";
+import "./command-augment-D9pI9Vbh.mjs";
+import { renderItem } from "./render-DXv-D6fU.mjs";
+import "./predicates-DiIiS3k7.mjs";
+import "./input-ikCiip6x.mjs";
+import { connectionFlags, defineMetabaseCommand, outputFlags, profileFlag } from "./runtime-cwBS8wwK.mjs";
+import { readBody } from "./body-rDrR-C1c.mjs";
+import { bodyInputFlags } from "./body-flags-BK7J6Daz.mjs";
+import { parseId } from "./parse-id-B38zTlYs.mjs";
+import "./validate-DCYx6jdL.mjs";
+import { TRANSFORM_SOURCE_QUERY_LABELS, preflightMbql5Query, skipValidateFlag } from "./validate-query-B07oGG4K.mjs";
+import { Transform, TransformUpdateInput, transformView } from "./transform-IEX4Mx3X.mjs";
+
+//#region src/commands/transform/update.ts
+var update_default = defineMetabaseCommand({
+	meta: {
+		name: "update",
+		description: "Update a transform by id; if source is provided with type `query` and source.query is MBQL 5 (lib/type: mbql/query) it is pre-flight-validated against the same schema as `metabase query` (see `metabase query --print-schema`)"
+	},
+	args: {
+		...outputFlags,
+		...profileFlag,
+		...connectionFlags,
+		...bodyInputFlags,
+		id: {
+			type: "positional",
+			description: "Transform id",
+			required: true
+		},
+		...skipValidateFlag
+	},
+	outputSchema: Transform,
+	examples: [
+		"cat patch.json | metabase transform update 1",
+		"metabase transform update 1 --file patch.json",
+		"metabase transform update 1 --body '{\"name\":\"renamed\"}'",
+		"metabase transform update 1 --file patch.json --skip-validate"
+	],
+	async run({ args, ctx, getClient }) {
+		const id = parseId(args.id);
+		const body = await readBody({
+			flag: args.body,
+			file: args.file
+		}, TransformUpdateInput);
+		if (body.source !== void 0 && body.source.type === "query") preflightMbql5Query(body.source.query, TRANSFORM_SOURCE_QUERY_LABELS, { skip: args["skip-validate"] === true });
+		const client = await getClient();
+		const updated = await client.requestParsed(Transform, `/api/transform/${id}`, {
+			method: "PUT",
+			body
+		});
+		renderItem(updated, transformView, ctx);
+	}
+});
+
+//#endregion
+export { update_default as default };

package/dist/update-B9DBMo30.mjs

@@ -0,0 +1,52 @@
+import "./package-DV6Asqim.mjs";
+import "./command-augment-D9pI9Vbh.mjs";
+import { renderItem } from "./render-DXv-D6fU.mjs";
+import "./predicates-DiIiS3k7.mjs";
+import "./input-ikCiip6x.mjs";
+import { connectionFlags, defineMetabaseCommand, outputFlags, profileFlag } from "./runtime-cwBS8wwK.mjs";
+import { readBody } from "./body-rDrR-C1c.mjs";
+import { bodyInputFlags } from "./body-flags-BK7J6Daz.mjs";
+import { parseId } from "./parse-id-B38zTlYs.mjs";
+import { Snippet, SnippetUpdateInput, snippetView } from "./snippet-Dw0Sjzkr.mjs";
+
+//#region src/commands/snippet/update.ts
+var update_default = defineMetabaseCommand({
+	meta: {
+		name: "update",
+		description: "Update a native query snippet by id"
+	},
+	args: {
+		...outputFlags,
+		...profileFlag,
+		...connectionFlags,
+		...bodyInputFlags,
+		id: {
+			type: "positional",
+			description: "Snippet id",
+			required: true
+		}
+	},
+	outputSchema: Snippet,
+	examples: [
+		"cat patch.json | metabase snippet update 1",
+		"metabase snippet update 1 --file patch.json",
+		"metabase snippet update 1 --body '{\"name\":\"renamed\"}'",
+		"metabase snippet update 1 --body '{\"archived\":true}'"
+	],
+	async run({ args, ctx, getClient }) {
+		const id = parseId(args.id);
+		const body = await readBody({
+			flag: args.body,
+			file: args.file
+		}, SnippetUpdateInput);
+		const client = await getClient();
+		const updated = await client.requestParsed(Snippet, `/api/native-query-snippet/${id}`, {
+			method: "PUT",
+			body
+		});
+		renderItem(updated, snippetView, ctx);
+	}
+});
+
+//#endregion
+export { update_default as default };

package/dist/update-BfBsM_y1.mjs

@@ -0,0 +1,56 @@
+import "./package-DV6Asqim.mjs";
+import "./command-augment-D9pI9Vbh.mjs";
+import { renderItem } from "./render-DXv-D6fU.mjs";
+import "./predicates-DiIiS3k7.mjs";
+import "./input-ikCiip6x.mjs";
+import { connectionFlags, defineMetabaseCommand, outputFlags, profileFlag } from "./runtime-cwBS8wwK.mjs";
+import { readBody } from "./body-rDrR-C1c.mjs";
+import { bodyInputFlags } from "./body-flags-BK7J6Daz.mjs";
+import { parseId } from "./parse-id-B38zTlYs.mjs";
+import "./validate-DCYx6jdL.mjs";
+import { SEGMENT_DEFINITION_LABELS, preflightMbql5Query, skipValidateFlag } from "./validate-query-B07oGG4K.mjs";
+import { Segment, SegmentUpdateInput, segmentView } from "./segment-BMrUBz94.mjs";
+
+//#region src/commands/segment/update.ts
+var update_default = defineMetabaseCommand({
+	meta: {
+		name: "update",
+		description: "Update a segment by id; body must include revision_message (audit-logged with the change). If definition is MBQL 5 (lib/type: mbql/query) it is pre-flight-validated against the same schema as `metabase query` (see `metabase query --print-schema`)"
+	},
+	args: {
+		...outputFlags,
+		...profileFlag,
+		...connectionFlags,
+		...bodyInputFlags,
+		...skipValidateFlag,
+		id: {
+			type: "positional",
+			description: "Segment id",
+			required: true
+		}
+	},
+	outputSchema: Segment,
+	examples: [
+		"cat patch.json | metabase segment update 1",
+		"metabase segment update 1 --file patch.json",
+		"metabase segment update 1 --body '{\"name\":\"renamed\",\"revision_message\":\"rename\"}'",
+		"metabase segment update 1 --file patch.json --skip-validate"
+	],
+	async run({ args, ctx, getClient }) {
+		const id = parseId(args.id);
+		const body = await readBody({
+			flag: args.body,
+			file: args.file
+		}, SegmentUpdateInput);
+		preflightMbql5Query(body.definition, SEGMENT_DEFINITION_LABELS, { skip: args["skip-validate"] === true });
+		const client = await getClient();
+		const updated = await client.requestParsed(Segment, `/api/segment/${id}`, {
+			method: "PUT",
+			body
+		});
+		renderItem(updated, segmentView, ctx);
+	}
+});
+
+//#endregion
+export { update_default as default };