@zitadel/cli 0.1.0-alpha.9 → 1.0.0-alpha.20

package/dist/commands/schemas/list.mjs

@@ -0,0 +1,146 @@
+import { t as BaseCommand } from "../../oclif-CanO3zdt.mjs";
+import { l as readZitadelSecret } from "../../project-CHhot85s.mjs";
+import { t as environmentSchema } from "../../environment-rjRVkJjW.mjs";
+import { cancel, isCancel, select, spinner } from "@clack/prompts";
+import { Flags } from "@oclif/core";
+import { createZitadelClient } from "@zitadel/api/client";
+import { consola as consola$1 } from "consola";
+//#region src/commands/schemas/list.ts
+/**
+* The `schemas list` topic command — inspect the revision history of a
+* user-schema, filtered by `objectType`.
+*
+* Non-interactive: prints one row per revision (newest first) as a JSON payload
+* or a plain-text table. Interactive: renders a `@clack/prompts` `select` menu
+* of the same rows; on selection, fetches the full schema body via
+* `getSchemaById` and pretty-prints it to stdout.
+*/
+var SchemasList = class SchemasList extends BaseCommand {
+	static description = "List revisions of a user-schema by objectType.";
+	static flags = {
+		"object-type": Flags.string({
+			char: "t",
+			required: true,
+			description: "Filter revisions by objectType (e.g. human-user)."
+		}),
+		environment: Flags.string({
+			char: "e",
+			description: "Target environment (default: development).",
+			options: [...environmentSchema.options]
+		})
+	};
+	async run() {
+		const { flags } = await this.parse(SchemasList);
+		await this.toMeta(flags);
+		const { cwd, source, nonInteractive } = this.meta;
+		const secret = await readZitadelSecret(cwd);
+		consola$1.info(`Project   ${secret.project_id}`);
+		consola$1.info(`Server    ${source}`);
+		const client = createZitadelClient({
+			baseUrl: source,
+			token: secret.project_secret
+		});
+		const objectType = flags["object-type"];
+		const revisions = [];
+		let pageToken;
+		do {
+			const page = await client.listSchemas({
+				project_id: secret.project_id,
+				object_type: objectType,
+				limit: 100,
+				page_token: pageToken
+			});
+			revisions.push(...page.schemas);
+			pageToken = page.next_page_token ?? void 0;
+		} while (pageToken);
+		const revisionRows = revisions.map((r) => ({
+			id: r.id,
+			created_at: r.metadata.created_at
+		}));
+		if (revisions.length === 0) {
+			const message = `No revisions found for objectType "${objectType}".`;
+			consola$1.warn(message);
+			return this.emit({
+				status: "ok",
+				data: {
+					object_type: objectType,
+					revisions: [],
+					count: 0
+				},
+				pretty: message
+			});
+		}
+		if (nonInteractive) return this.emit({
+			status: "ok",
+			data: {
+				object_type: objectType,
+				revisions: revisionRows,
+				count: revisions.length
+			},
+			pretty: renderTable(objectType, revisions)
+		});
+		const picked = await select({
+			message: `Revisions of objectType "${objectType}" (newest first)`,
+			options: revisions.map((r, idx) => ({
+				value: r.id,
+				label: `${r.metadata.created_at}   ${r.id}${idx === 0 ? "   (latest)" : ""}`
+			}))
+		});
+		if (isCancel(picked)) {
+			cancel("No revision selected.");
+			return this.emit({
+				status: "ok",
+				data: {
+					object_type: objectType,
+					revisions: revisionRows,
+					count: revisions.length
+				},
+				pretty: ""
+			});
+		}
+		const s = spinner();
+		s.start(`Loading ${String(picked)}…`);
+		const body = await fetchSchemaRevision(client, String(picked));
+		s.stop(`Loaded ${String(picked)}`);
+		const pretty = JSON.stringify(body, null, 2);
+		return this.emit({
+			status: "ok",
+			data: {
+				object_type: objectType,
+				revisions: revisionRows,
+				selected: {
+					id: picked,
+					body
+				},
+				count: revisions.length
+			},
+			pretty
+		});
+	}
+};
+/**
+* Fetch one schema revision body. The id is URL-encoded before it lands in
+* the path: server-allocated ids are opaque today (`sch_…`), but ids can be
+* full URLs when a schema carried an `$id` (the server-seeded defaults do),
+* and an unencoded URL would break the `/schemas/:id` path. Mirrors the
+* encoding the sync engine's schema syncer applies.
+*/
+async function fetchSchemaRevision(client, id) {
+	return (await client.getSchemaById(encodeURIComponent(id))).schema;
+}
+function renderTable(objectType, revisions) {
+	const header = `Revisions of objectType "${objectType}" (${revisions.length}, newest first)`;
+	const idCol = Math.max(2, ...revisions.map((r) => r.id.length));
+	const createdCol = Math.max(10, ...revisions.map((r) => r.metadata.created_at.length));
+	const rows = revisions.map((r) => `${r.metadata.created_at.padEnd(createdCol)}  ${r.id.padEnd(idCol)}`);
+	return [
+		header,
+		`${"created_at".padEnd(createdCol)}  ${"id".padEnd(idCol)}`,
+		`${"-".repeat(createdCol)}  ${"-".repeat(idCol)}`,
+		...rows
+	].join("\n");
+}
+//#endregion
+export { SchemasList as default, fetchSchemaRevision };
+
+//# sourceMappingURL=list.mjs.map

package/dist/commands/schemas/list.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"list.mjs","names":[],"sources":["../../../src/commands/schemas/list.ts"],"sourcesContent":["import { cancel, isCancel, select, spinner } from \"@clack/prompts\";\nimport { Flags } from \"@oclif/core\";\nimport { consola } from \"consola\";\n\nimport { createZitadelClient, type ZitadelClient } from \"@zitadel/api/client\";\nimport type {\n  GetSchemaById200,\n  ListSchemas200SchemasItem,\n} from \"@zitadel/api/generated/model\";\n\nimport { BaseCommand, type JsonEnvelope } from \"../../lib/oclif\";\nimport { environmentSchema } from \"../../lib/environment\";\nimport { readZitadelSecret } from \"../../lib/project\";\n\n/**\n * The `schemas list` topic command — inspect the revision history of a\n * user-schema, filtered by `objectType`.\n *\n * Non-interactive: prints one row per revision (newest first) as a JSON payload\n * or a plain-text table. Interactive: renders a `@clack/prompts` `select` menu\n * of the same rows; on selection, fetches the full schema body via\n * `getSchemaById` and pretty-prints it to stdout.\n */\nexport default class SchemasList extends BaseCommand {\n  static override description = \"List revisions of a user-schema by objectType.\";\n  static override flags = {\n    \"object-type\": Flags.string({\n      char: \"t\",\n      required: true,\n      description: \"Filter revisions by objectType (e.g. human-user).\",\n    }),\n    environment: Flags.string({\n      char: \"e\",\n      description: \"Target environment (default: development).\",\n      options: [...environmentSchema.options],\n    }),\n  };\n\n  async run(): Promise<JsonEnvelope> {\n    const { flags } = await this.parse(SchemasList);\n    await this.toMeta(flags);\n    const { cwd, source, nonInteractive } = this.meta;\n\n    const secret = await readZitadelSecret(cwd);\n    consola.info(`Project   ${secret.project_id}`);\n    consola.info(`Server    ${source}`);\n    const client = createZitadelClient({\n      baseUrl: source,\n      token: secret.project_secret,\n    });\n\n    const objectType = flags[\"object-type\"];\n    // The command shows the full revision history, so it drains the\n    // cursor-paginated list at the max page size.\n    const revisions: ListSchemas200SchemasItem[] = [];\n    let pageToken: string | undefined;\n    do {\n      const page = await client.listSchemas({\n        project_id: secret.project_id,\n        object_type: objectType,\n        limit: 100,\n        page_token: pageToken,\n      });\n      revisions.push(...page.schemas);\n      pageToken = page.next_page_token ?? undefined;\n    } while (pageToken);\n\n    // The envelope's row shape is a contract; project it explicitly so a field\n    // added to the API later cannot leak into stdout.\n    const revisionRows = revisions.map((r) => ({\n      id: r.id,\n      created_at: r.metadata.created_at,\n    }));\n\n    if (revisions.length === 0) {\n      const message = `No revisions found for objectType \"${objectType}\".`;\n      consola.warn(message);\n      return this.emit({\n        status: \"ok\",\n        data: { object_type: objectType, revisions: [], count: 0 },\n        pretty: message,\n      });\n    }\n\n    // Server orders newest-first; the interactive picker inherits that order.\n    if (nonInteractive) {\n      return this.emit({\n        status: \"ok\",\n        data: {\n          object_type: objectType,\n          revisions: revisionRows,\n          count: revisions.length,\n        },\n        pretty: renderTable(objectType, revisions),\n      });\n    }\n\n    const picked = await select({\n      message: `Revisions of objectType \"${objectType}\" (newest first)`,\n      options: revisions.map((r, idx) => ({\n        value: r.id,\n        label: `${r.metadata.created_at}   ${r.id}${idx === 0 ? \"   (latest)\" : \"\"}`,\n      })),\n    });\n    if (isCancel(picked)) {\n      cancel(\"No revision selected.\");\n      return this.emit({\n        status: \"ok\",\n        data: { object_type: objectType, revisions: revisionRows, count: revisions.length },\n        pretty: \"\",\n      });\n    }\n\n    const s = spinner();\n    s.start(`Loading ${String(picked)}…`);\n    const body = await fetchSchemaRevision(client, String(picked));\n    s.stop(`Loaded ${String(picked)}`);\n\n    const pretty = JSON.stringify(body, null, 2);\n\n    return this.emit({\n      status: \"ok\",\n      data: {\n        object_type: objectType,\n        revisions: revisionRows,\n        selected: { id: picked, body },\n        count: revisions.length,\n      },\n      pretty,\n    });\n  }\n}\n\n/**\n * Fetch one schema revision body. The id is URL-encoded before it lands in\n * the path: server-allocated ids are opaque today (`sch_…`), but ids can be\n * full URLs when a schema carried an `$id` (the server-seeded defaults do),\n * and an unencoded URL would break the `/schemas/:id` path. Mirrors the\n * encoding the sync engine's schema syncer applies.\n */\nexport async function fetchSchemaRevision(client: ZitadelClient, id: string): Promise<unknown> {\n  // Flat-by-id: authz resolves the project from RSI; no project_id query.\n  // The response is the `{id, schema, metadata}` envelope; the revision body\n  // callers want is the customer-authored document inside it.\n  const body = (await client.getSchemaById(encodeURIComponent(id))) as GetSchemaById200;\n  return body.schema;\n}\n\nfunction renderTable(\n  objectType: string,\n  revisions: ReadonlyArray<ListSchemas200SchemasItem>,\n): string {\n  const header = `Revisions of objectType \"${objectType}\" (${revisions.length}, newest first)`;\n  const idCol = Math.max(\"id\".length, ...revisions.map((r) => r.id.length));\n  const createdCol = Math.max(\n    \"created_at\".length,\n    ...revisions.map((r) => r.metadata.created_at.length),\n  );\n  const rows = revisions.map(\n    (r) => `${r.metadata.created_at.padEnd(createdCol)}  ${r.id.padEnd(idCol)}`,\n  );\n  return [\n    header,\n    `${\"created_at\".padEnd(createdCol)}  ${\"id\".padEnd(idCol)}`,\n    `${\"-\".repeat(createdCol)}  ${\"-\".repeat(idCol)}`,\n    ...rows,\n  ].join(\"\\n\");\n}\n"],"mappings":";;;;;;;;;;;;;;;;;AAuBA,IAAqB,cAArB,MAAqB,oBAAoB,YAAY;CACnD,OAAgB,cAAc;CAC9B,OAAgB,QAAQ;EACtB,eAAe,MAAM,OAAO;GAC1B,MAAM;GACN,UAAU;GACV,aAAa;GACd,CAAC;EACF,aAAa,MAAM,OAAO;GACxB,MAAM;GACN,aAAa;GACb,SAAS,CAAC,GAAG,kBAAkB,QAAQ;GACxC,CAAC;EACH;CAED,MAAM,MAA6B;EACjC,MAAM,EAAE,UAAU,MAAM,KAAK,MAAM,YAAY;AAC/C,QAAM,KAAK,OAAO,MAAM;EACxB,MAAM,EAAE,KAAK,QAAQ,mBAAmB,KAAK;EAE7C,MAAM,SAAS,MAAM,kBAAkB,IAAI;AAC3C,YAAQ,KAAK,aAAa,OAAO,aAAa;AAC9C,YAAQ,KAAK,aAAa,SAAS;EACnC,MAAM,SAAS,oBAAoB;GACjC,SAAS;GACT,OAAO,OAAO;GACf,CAAC;EAEF,MAAM,aAAa,MAAM;EAGzB,MAAM,YAAyC,EAAE;EACjD,IAAI;AACJ,KAAG;GACD,MAAM,OAAO,MAAM,OAAO,YAAY;IACpC,YAAY,OAAO;IACnB,aAAa;IACb,OAAO;IACP,YAAY;IACb,CAAC;AACF,aAAU,KAAK,GAAG,KAAK,QAAQ;AAC/B,eAAY,KAAK,mBAAmB,KAAA;WAC7B;EAIT,MAAM,eAAe,UAAU,KAAK,OAAO;GACzC,IAAI,EAAE;GACN,YAAY,EAAE,SAAS;GACxB,EAAE;AAEH,MAAI,UAAU,WAAW,GAAG;GAC1B,MAAM,UAAU,sCAAsC,WAAW;AACjE,aAAQ,KAAK,QAAQ;AACrB,UAAO,KAAK,KAAK;IACf,QAAQ;IACR,MAAM;KAAE,aAAa;KAAY,WAAW,EAAE;KAAE,OAAO;KAAG;IAC1D,QAAQ;IACT,CAAC;;AAIJ,MAAI,eACF,QAAO,KAAK,KAAK;GACf,QAAQ;GACR,MAAM;IACJ,aAAa;IACb,WAAW;IACX,OAAO,UAAU;IAClB;GACD,QAAQ,YAAY,YAAY,UAAU;GAC3C,CAAC;EAGJ,MAAM,SAAS,MAAM,OAAO;GAC1B,SAAS,4BAA4B,WAAW;GAChD,SAAS,UAAU,KAAK,GAAG,SAAS;IAClC,OAAO,EAAE;IACT,OAAO,GAAG,EAAE,SAAS,WAAW,KAAK,EAAE,KAAK,QAAQ,IAAI,gBAAgB;IACzE,EAAE;GACJ,CAAC;AACF,MAAI,SAAS,OAAO,EAAE;AACpB,UAAO,wBAAwB;AAC/B,UAAO,KAAK,KAAK;IACf,QAAQ;IACR,MAAM;KAAE,aAAa;KAAY,WAAW;KAAc,OAAO,UAAU;KAAQ;IACnF,QAAQ;IACT,CAAC;;EAGJ,MAAM,IAAI,SAAS;AACnB,IAAE,MAAM,WAAW,OAAO,OAAO,CAAC,GAAG;EACrC,MAAM,OAAO,MAAM,oBAAoB,QAAQ,OAAO,OAAO,CAAC;AAC9D,IAAE,KAAK,UAAU,OAAO,OAAO,GAAG;EAElC,MAAM,SAAS,KAAK,UAAU,MAAM,MAAM,EAAE;AAE5C,SAAO,KAAK,KAAK;GACf,QAAQ;GACR,MAAM;IACJ,aAAa;IACb,WAAW;IACX,UAAU;KAAE,IAAI;KAAQ;KAAM;IAC9B,OAAO,UAAU;IAClB;GACD;GACD,CAAC;;;;;;;;;;AAWN,eAAsB,oBAAoB,QAAuB,IAA8B;AAK7F,SAAO,MADa,OAAO,cAAc,mBAAmB,GAAG,CAAC,EACpD;;AAGd,SAAS,YACP,YACA,WACQ;CACR,MAAM,SAAS,4BAA4B,WAAW,KAAK,UAAU,OAAO;CAC5E,MAAM,QAAQ,KAAK,IAAI,GAAa,GAAG,UAAU,KAAK,MAAM,EAAE,GAAG,OAAO,CAAC;CACzE,MAAM,aAAa,KAAK,IACtB,IACA,GAAG,UAAU,KAAK,MAAM,EAAE,SAAS,WAAW,OAAO,CACtD;CACD,MAAM,OAAO,UAAU,KACpB,MAAM,GAAG,EAAE,SAAS,WAAW,OAAO,WAAW,CAAC,IAAI,EAAE,GAAG,OAAO,MAAM,GAC1E;AACD,QAAO;EACL;EACA,GAAG,aAAa,OAAO,WAAW,CAAC,IAAI,KAAK,OAAO,MAAM;EACzD,GAAG,IAAI,OAAO,WAAW,CAAC,IAAI,IAAI,OAAO,MAAM;EAC/C,GAAG;EACJ,CAAC,KAAK,KAAK"}