pbi-enterprise-cli 0.1.0.dev0__py3-none-any.whl

pbi_cli/commands/connections.py

@@ -0,0 +1,153 @@
+"""pbi connections — named connection profiles (~/.pbi-cli/connections.json)."""
+
+from __future__ import annotations
+
+import json
+from pathlib import Path
+from typing import Any
+
+import click
+from rich.console import Console
+
+from pbi_cli.commands._shared import output_json_or_table
+
+console = Console()
+
+_CONFIG_PATH = Path.home() / ".pbi-cli" / "connections.json"
+
+
+def _load() -> dict[str, Any]:
+    if _CONFIG_PATH.exists():
+        return json.loads(_CONFIG_PATH.read_text(encoding="utf-8"))
+    return {"connections": [], "last": None}
+
+
+def _save(data: dict[str, Any]) -> None:
+    _CONFIG_PATH.parent.mkdir(parents=True, exist_ok=True)
+    _CONFIG_PATH.write_text(json.dumps(data, indent=2), encoding="utf-8")
+
+
+@click.group()
+def connections() -> None:
+    """Manage named Power BI connection profiles (~/.pbi-cli/connections.json)."""
+
+
+@connections.command("list")
+@click.pass_context
+def connections_list(ctx: click.Context) -> None:
+    """List all saved named connections."""
+    data = _load()
+    conns = data.get("connections", [])
+    if not conns:
+        console.print("[yellow]No saved connections.[/yellow]")
+        console.print("Use 'pbi connections add' to save one.")
+        return
+    # Mask secrets
+    display = []
+    for c in conns:
+        row = dict(c)
+        if row.get("client_secret"):
+            row["client_secret"] = "***"
+        display.append(row)
+    output_json_or_table(display, ctx, title="Saved Connections")
+    if data.get("last"):
+        console.print(f"\n[dim]Last used:[/dim] [cyan]{data['last']}[/cyan]")
+
+
+@connections.command("last")
+def connections_last() -> None:
+    """Show the most recently used connection name."""
+    data = _load()
+    last = data.get("last")
+    if last:
+        console.print(f"[cyan]Last connection:[/cyan] {last}")
+    else:
+        console.print("[yellow]No connection has been used yet.[/yellow]")
+
+
+@connections.command("add")
+@click.option("--name", required=True, help="Short alias for this connection.")
+@click.option(
+    "--type",
+    "conn_type",
+    required=True,
+    type=click.Choice(["desktop", "xmla"]),
+    help="Connection type.",
+)
+@click.option("--endpoint", default=None, help="XMLA endpoint URL.")
+@click.option("--catalog", default=None, help="Dataset / semantic model name.")
+@click.option(
+    "--auth",
+    default="device_flow",
+    type=click.Choice(["device_flow", "service_principal", "token"]),
+    help="Auth mode (XMLA only).",
+)
+@click.option("--client-id", default=None, help="AAD client ID (service_principal).")
+@click.option("--client-secret", default=None, help="AAD client secret (service_principal).")
+@click.option("--tenant-id", default=None, help="AAD tenant ID (service_principal).")
+@click.option("--port", default=None, type=int, help="Desktop local server port.")
+def connections_add(
+    name: str,
+    conn_type: str,
+    endpoint: str | None,
+    catalog: str | None,
+    auth: str,
+    client_id: str | None,
+    client_secret: str | None,
+    tenant_id: str | None,
+    port: int | None,
+) -> None:
+    """Save a named connection profile."""
+    data = _load()
+    # Remove existing with same name
+    data["connections"] = [c for c in data.get("connections", []) if c["name"] != name]
+    record: dict[str, Any] = {"name": name, "type": conn_type}
+    if conn_type == "xmla":
+        if not endpoint:
+            raise click.UsageError("--endpoint is required for xmla connections.")
+        record.update({"endpoint": endpoint, "catalog": catalog or "", "auth": auth})
+        if auth == "service_principal":
+            record.update(
+                {"client_id": client_id, "client_secret": client_secret, "tenant_id": tenant_id}
+            )
+    else:
+        if port:
+            record["port"] = port
+    data.setdefault("connections", []).append(record)
+    _save(data)
+    console.print(f"[green]Connection saved:[/green] '{name}' ({conn_type})")
+
+
+@connections.command("remove")
+@click.argument("name")
+def connections_remove(name: str) -> None:
+    """Remove a saved connection profile by name."""
+    data = _load()
+    before = len(data.get("connections", []))
+    data["connections"] = [c for c in data.get("connections", []) if c["name"] != name]
+    if len(data["connections"]) == before:
+        console.print(f"[yellow]Connection '{name}' not found.[/yellow]")
+        return
+    if data.get("last") == name:
+        data["last"] = None
+    _save(data)
+    console.print(f"[red]Removed[/red] connection '{name}'.")
+
+
+@connections.command("use")
+@click.argument("name")
+def connections_use(name: str) -> None:
+    """Set a connection as the active default and print its connect command."""
+    data = _load()
+    conn = next((c for c in data.get("connections", []) if c["name"] == name), None)
+    if not conn:
+        console.print(f"[red]Connection '{name}' not found.[/red]")
+        raise SystemExit(1)
+    data["last"] = name
+    _save(data)
+    console.print(f"[green]Active connection:[/green] {name}")
+    if conn["type"] == "xmla":
+        console.print(f"  pbi --backend xmla model info  # uses {conn.get('endpoint', '')}")
+    else:
+        port_flag = f" --port {conn['port']}" if conn.get("port") else ""
+        console.print(f"  pbi{port_flag} model info")

pbi_cli/commands/custom_visual.py

@@ -0,0 +1,325 @@
+"""pbi custom-visual — TypeScript custom visual SDK scaffolding, build, package, import."""
+
+from __future__ import annotations
+
+import json
+import shutil
+import subprocess
+from pathlib import Path
+
+import click
+from rich.console import Console
+
+console = Console()
+
+
+@click.group("custom-visual")
+def custom_visual() -> None:
+    """Scaffold, build, package, and import Power BI custom visuals (TypeScript SDK)."""
+
+
+@custom_visual.command("scaffold")
+@click.option("--name", required=True, help="Visual name (PascalCase, e.g. MyBarChart).")
+@click.option(
+    "--display", default=None, help="Display name shown in Power BI (defaults to --name)."
+)
+@click.option("--guid", default=None, help="Visual GUID (auto-generated if omitted).")
+@click.option(
+    "--output", default=".", type=click.Path(), help="Parent directory for the new project."
+)
+@click.option("--author", default="", help="Author name for package.json.")
+def custom_visual_scaffold(
+    name: str, display: str | None, guid: str | None, output: str, author: str
+) -> None:
+    """Create a new custom visual TypeScript project from the pbi-cli template.
+
+    \b
+    Produces the standard pbiviz project structure:
+      <name>/
+        package.json
+        pbiviz.json
+        tsconfig.json
+        src/
+          visual.ts
+          settings.ts
+        style/
+          visual.less
+        assets/
+          icon.png  (placeholder)
+        capabilities.json
+
+    \b
+    Example:
+      pbi custom-visual scaffold --name MyBarChart --author "Mudassir"
+    """
+    import uuid
+
+    display_name = display or name
+    visual_guid = guid or str(uuid.uuid4())
+    project_dir = Path(output) / name
+    if project_dir.exists():
+        console.print(f"[yellow]Directory already exists:[/yellow] {project_dir}")
+        raise SystemExit(1)
+
+    project_dir.mkdir(parents=True)
+    (project_dir / "src").mkdir()
+    (project_dir / "style").mkdir()
+    (project_dir / "assets").mkdir()
+
+    # pbiviz.json
+    (project_dir / "pbiviz.json").write_text(
+        json.dumps(
+            {
+                "visual": {
+                    "name": name,
+                    "displayName": display_name,
+                    "guid": visual_guid,
+                    "visualClassName": name,
+                    "version": "1.0.0",
+                    "description": f"{display_name} Power BI custom visual",
+                    "supportUrl": "",
+                    "gitHubUrl": "",
+                },
+                "apiVersion": "5.3.0",
+                "author": {"name": author, "email": ""},
+                "assets": {"icon": "assets/icon.png"},
+                "stringResources": [],
+                "capabilities": "capabilities.json",
+                "stringResourcesPath": "",
+                "externalJS": [],
+                "style": "style/visual.less",
+                "sources": ["src/visual.ts"],
+            },
+            indent=2,
+        ),
+        encoding="utf-8",
+    )
+
+    # package.json
+    (project_dir / "package.json").write_text(
+        json.dumps(
+            {
+                "name": name.lower(),
+                "version": "1.0.0",
+                "description": f"{display_name} custom visual",
+                "scripts": {
+                    "build": "tsc --noEmit",
+                    "package": "pbiviz package",
+                    "start": "pbiviz start",
+                },
+                "devDependencies": {
+                    "powerbi-visuals-tools": "^5.2.0",
+                    "typescript": "^5.0.0",
+                },
+            },
+            indent=2,
+        ),
+        encoding="utf-8",
+    )
+
+    # tsconfig.json
+    (project_dir / "tsconfig.json").write_text(
+        json.dumps(
+            {
+                "compilerOptions": {
+                    "target": "ES6",
+                    "module": "commonjs",
+                    "lib": ["es2015", "dom"],
+                    "strict": True,
+                    "outDir": ".tmp/build",
+                    "declaration": True,
+                    "sourceMap": True,
+                },
+                "include": ["src/**/*.ts"],
+                "exclude": ["node_modules"],
+            },
+            indent=2,
+        ),
+        encoding="utf-8",
+    )
+
+    # capabilities.json
+    (project_dir / "capabilities.json").write_text(
+        json.dumps(
+            {
+                "dataRoles": [{"name": "Values", "kind": "Measure", "displayName": "Values"}],
+                "dataViewMappings": [{"single": {"role": "Values"}}],
+                "objects": {},
+                "supportsHighlight": True,
+                "sorting": {"default": {}},
+            },
+            indent=2,
+        ),
+        encoding="utf-8",
+    )
+
+    # src/visual.ts
+    (project_dir / "src" / "visual.ts").write_text(
+        f"""\
+"use strict";
+
+import powerbi from "powerbi-visuals-api";
+import VisualConstructorOptions = powerbi.extensibility.visual.VisualConstructorOptions;
+import VisualUpdateOptions = powerbi.extensibility.visual.VisualUpdateOptions;
+import IVisual = powerbi.extensibility.visual.IVisual;
+
+export class {name} implements IVisual {{
+    private target: HTMLElement;
+
+    constructor(options: VisualConstructorOptions) {{
+        this.target = options.element;
+    }}
+
+    public update(options: VisualUpdateOptions): void {{
+        const dataView = options.dataViews?.[0];
+        if (!dataView?.single?.value) return;
+        this.target.innerHTML = `<p style="font-size:24px">${{dataView.single.value}}</p>`;
+    }}
+}}
+""",
+        encoding="utf-8",
+    )
+
+    # style/visual.less
+    (project_dir / "style" / "visual.less").write_text(
+        f"/** {display_name} styles */\n.visual-container {{\n  font-family: 'Segoe UI', sans-serif;\n}}\n",  # noqa: E501
+        encoding="utf-8",
+    )
+
+    # assets/icon.png placeholder (empty file)
+    (project_dir / "assets" / "icon.png").write_bytes(b"")
+
+    console.print(f"[green]Scaffolded:[/green] {project_dir}")
+    console.print(f"  GUID:    {visual_guid}")
+    console.print("  Version: 1.0.0")
+    console.print("\n[cyan]Next steps:[/cyan]")
+    console.print(f"  cd {project_dir}")
+    console.print("  npm install")
+    console.print("  pbi custom-visual build --path .")
+    console.print("  pbi custom-visual package --path .")
+
+
+@custom_visual.command("build")
+@click.option("--path", default=".", type=click.Path(exists=True), help="Visual project directory.")
+@click.option("--watch", is_flag=True, help="Watch for changes and rebuild automatically.")
+def custom_visual_build(path: str, watch: bool) -> None:
+    """Run tsc --noEmit to type-check the visual TypeScript source.
+
+    Requires Node.js and the devDependencies installed (npm install).
+
+    \b
+    Example:
+      pbi custom-visual build --path ./MyBarChart
+    """
+    cmd = ["npx", "tsc", "--noEmit"]
+    if watch:
+        cmd.append("--watch")
+    console.print(f"[cyan]Type-checking:[/cyan] {path}")
+    try:
+        result = subprocess.run(cmd, cwd=path)
+        if result.returncode == 0:
+            console.print("[green]Type check passed.[/green]")
+        else:
+            console.print("[red]Type errors found.[/red] Fix the issues above and re-run.")
+            raise SystemExit(result.returncode)
+    except FileNotFoundError:
+        console.print("[red]npx / Node.js not found.[/red] Install Node.js from https://nodejs.org")
+        raise SystemExit(1)
+
+
+@custom_visual.command("package")
+@click.option("--path", default=".", type=click.Path(exists=True), help="Visual project directory.")
+@click.option(
+    "--output", default=None, type=click.Path(), help="Output .pbiviz path (default: dist/)."
+)
+def custom_visual_package(path: str, output: str | None) -> None:
+    """Package the visual into a .pbiviz file ready for Power BI import.
+
+    Requires powerbi-visuals-tools (pbiviz) installed:  npm install -g powerbi-visuals-tools
+
+    \b
+    Example:
+      pbi custom-visual package --path ./MyBarChart
+    """
+    project = Path(path)
+    pbiviz_json = project / "pbiviz.json"
+    if not pbiviz_json.exists():
+        console.print("[red]pbiviz.json not found.[/red] Run 'pbi custom-visual scaffold' first.")
+        raise SystemExit(1)
+
+    meta = json.loads(pbiviz_json.read_text(encoding="utf-8"))
+    name = meta["visual"]["name"]
+    version = meta["visual"]["version"]
+
+    console.print(f"[cyan]Packaging:[/cyan] {name} v{version}")
+    try:
+        result = subprocess.run(["pbiviz", "package"], cwd=path)
+        if result.returncode == 0:
+            dist_file = project / "dist" / f"{name}.pbiviz"
+            if output and dist_file.exists():
+                shutil.copy(dist_file, output)
+                console.print(f"[green]Packaged →[/green] {output}")
+            else:
+                console.print(f"[green]Packaged →[/green] {dist_file}")
+        else:
+            console.print("[red]Packaging failed.[/red]")
+            raise SystemExit(result.returncode)
+    except FileNotFoundError:
+        console.print("[red]pbiviz not found.[/red] Run: npm install -g powerbi-visuals-tools")
+        raise SystemExit(1)
+
+
+@custom_visual.command("import")
+@click.option("--pbip", required=True, help="Path to the .pbip report project.")
+@click.option(
+    "--pbiviz",
+    required=True,
+    type=click.Path(exists=True),
+    help="Path to the .pbiviz package file.",
+)
+@click.pass_context
+def custom_visual_import(ctx: click.Context, pbip: str, pbiviz: str) -> None:
+    """Import a .pbiviz package into a .pbip report project.
+
+    Registers the custom visual in the report so it can be used on any page.
+
+    \b
+    Example:
+      pbi custom-visual import --pbip ./MyReport --pbiviz ./MyBarChart/dist/MyBarChart.pbiviz
+    """
+    from pbi_cli.commands._shared import dry_run_echo
+
+    if dry_run_echo(ctx, f"import custom visual '{pbiviz}' into '{pbip}'"):
+        return
+
+    pbiviz_path = Path(pbiviz)
+    if not pbiviz_path.suffix == ".pbiviz":
+        console.print("[red]File must have .pbiviz extension.[/red]")
+        raise SystemExit(1)
+
+    # Extract the pbiviz (it's a zip) to find the visual GUID
+    import zipfile
+
+    with zipfile.ZipFile(pbiviz_path) as z:
+        names = z.namelist()
+        pbiviz_json_name = next((n for n in names if n.endswith("pbiviz.json")), None)
+        if not pbiviz_json_name:
+            console.print("[red]Invalid .pbiviz file — pbiviz.json not found inside archive.[/red]")
+            raise SystemExit(1)
+        meta = json.loads(z.read(pbiviz_json_name).decode("utf-8"))
+
+    visual_name = meta.get("visual", {}).get("name", pbiviz_path.stem)
+    visual_guid = meta.get("visual", {}).get("guid", "unknown")
+    version = meta.get("visual", {}).get("version", "1.0.0")
+
+    # Copy pbiviz into report's custom visuals folder
+    report_path = Path(pbip)
+    cv_dir = report_path / "definition" / "customVisuals"
+    cv_dir.mkdir(parents=True, exist_ok=True)
+    dest = cv_dir / pbiviz_path.name
+    shutil.copy(pbiviz_path, dest)
+
+    console.print(f"[green]Custom visual imported:[/green] {visual_name} v{version}")
+    console.print(f"  GUID:   {visual_guid}")
+    console.print(f"  Stored: {dest}")
+    console.print("[dim]Reload the report in Power BI Desktop to use the visual.[/dim]")

pbi_cli/commands/database.py

@@ -0,0 +1,76 @@
+"""pbi database — TMDL export/import commands."""
+
+from __future__ import annotations
+
+import click
+from rich.console import Console
+
+from pbi_cli.commands._shared import dry_run_echo, get_backend
+
+console = Console()
+
+
+@click.group()
+def database() -> None:
+    """Export and import TMDL snapshots."""
+
+
+@database.command("export-tmdl")
+@click.argument("path")
+@click.pass_context
+def export_tmdl(ctx: click.Context, path: str) -> None:
+    """Export the current model as TMDL files to a directory."""
+    if dry_run_echo(ctx, f"export TMDL to {path}"):
+        return
+    backend = get_backend(ctx)
+    backend.tmdl_export(path)
+    console.print(f"[green]TMDL exported to:[/green] {path}")
+
+
+@database.command("import-tmdl")
+@click.argument("path")
+@click.pass_context
+def import_tmdl(ctx: click.Context, path: str) -> None:
+    """Import TMDL files from a directory into the connected model."""
+    if dry_run_echo(ctx, f"import TMDL from {path}"):
+        return
+    backend = get_backend(ctx)
+    backend.tmdl_import(path)
+    console.print(f"[green]TMDL imported from:[/green] {path}")
+
+
+@database.command("diff-tmdl")
+@click.argument("snapshot_path", type=click.Path(exists=True))
+@click.option("--output", default=None, type=click.Path(), help="Save diff report to a JSON file.")
+@click.pass_context
+def diff_tmdl(ctx: click.Context, snapshot_path: str, output: str | None) -> None:
+    """Compare the live model against a TMDL snapshot directory.
+
+    Reports added, removed, and changed objects (tables, measures, columns,
+    relationships) relative to the snapshot.
+
+    \b
+    Example:
+      pbi database diff-tmdl ./snapshots/2024-01-01/
+    """
+    import json as _json
+    from pathlib import Path
+
+    from pbi_cli.commands._shared import output_json_or_table
+
+    backend = get_backend(ctx)
+    diff = backend.model_diff(snapshot_path)
+
+    if output:
+        Path(output).write_text(_json.dumps(diff, indent=2, default=str), encoding="utf-8")
+        console.print(f"[green]Diff saved to:[/green] {output}")
+    else:
+        if not diff.get("has_changes"):
+            console.print("[green]No changes detected[/green] — model matches snapshot.")
+        else:
+            console.print(
+                f"[yellow]Changes detected:[/yellow] {len(diff.get('added', []))} added, "
+                f"{len(diff.get('removed', []))} removed, "
+                f"{len(diff.get('changed', []))} modified"
+            )
+            output_json_or_table(diff, ctx, title="TMDL Diff")