tangram-core 0.2.0__cp313-cp313-win_amd64.whl

tangram_core/App.vue

@@ -0,0 +1,335 @@
+<template>
+  <!-- NOTE: copied largely from v0.1. -->
+  <div v-if="apiState === 'loading'" class="loading-container">
+    <div>initialising tangram…</div>
+    <div v-if="loadingMessage" class="loading-detail">{{ loadingMessage }}</div>
+  </div>
+  <div v-else-if="apiState === 'error'">
+    error: could not connect to the tangram backend.
+  </div>
+  <div v-else-if="apiState === 'ready' && tangramApi" class="main-container">
+    <div class="navbar" role="navigation">
+      <div class="navbar-brand">
+        <img src="/favicon.png" alt="tangram" class="navbar-logo" />
+        <span class="navbar-title">tangram</span>
+      </div>
+
+      <div class="navbar-spacer"></div>
+
+      <component
+        :is="widget.id"
+        v-for="widget in tangramApi.ui.widgets.TopBar"
+        :key="widget.id"
+      />
+    </div>
+
+    <div
+      id="sidebar"
+      class="sidebar"
+      :class="{
+        collapsed: !tangramApi.state.activeEntity || tangramApi.ui.isSidebarCollapsed
+      }"
+    >
+      <div class="sidebar-tabs">
+        <ul role="tablist">
+          <li>
+            <a role="tab" @click="tangramApi.ui.toggleSidebar()">
+              <span class="fa fa-plane"></span>
+            </a>
+          </li>
+        </ul>
+      </div>
+      <div class="sidebar-content">
+        <component
+          :is="widget.id"
+          v-for="widget in tangramApi.ui.widgets.SideBar"
+          :key="widget.id"
+        />
+      </div>
+    </div>
+
+    <div ref="mapContainer" class="map-container">
+      <component
+        :is="widget.id"
+        v-for="widget in tangramApi.ui.widgets.MapOverlay"
+        :key="widget.id"
+      />
+    </div>
+  </div>
+</template>
+
+<script setup lang="ts">
+import { onMounted, onUnmounted, getCurrentInstance, ref, watch } from "vue";
+import maplibregl from "maplibre-gl";
+import { TangramApi } from "./api";
+import { loadPlugins } from "./plugin";
+import { layers, namedFlavor } from "@protomaps/basemaps";
+import * as pmtiles from "pmtiles";
+
+type ApiState = "loading" | "ready" | "error";
+
+const app = getCurrentInstance()!.appContext.app;
+const apiState = ref<ApiState>("loading");
+const loadingMessage = ref<string>("");
+const tangramApi = ref<TangramApi | null>(null);
+const mapContainer = ref<HTMLElement | null>(null);
+let mapInstance: maplibregl.Map | undefined = undefined;
+
+onMounted(async () => {
+  try {
+    const api = await TangramApi.create(app);
+    app.provide("tangramApi", api);
+    await loadPlugins(api, progress => {
+      if (progress.stage === "manifest") {
+        loadingMessage.value = "fetching plugin manifest";
+      } else if (progress.stage === "plugin" && progress.pluginName) {
+        loadingMessage.value = `loading plugin: ${progress.pluginName}`;
+      } else if (progress.stage === "done") {
+        loadingMessage.value = "starting user interface";
+      }
+    });
+    tangramApi.value = api;
+    apiState.value = "ready";
+  } catch (e) {
+    console.error("failed to initialise tangram api:", e);
+    apiState.value = "error";
+  }
+});
+
+watch(
+  () => tangramApi.value?.state.activeEntity,
+  newEntity => {
+    if (newEntity) {
+      tangramApi.value?.ui.openSidebar();
+    }
+  }
+);
+
+watch(mapContainer, newEl => {
+  if (newEl && tangramApi.value && !mapInstance) {
+    const mapConfig = tangramApi.value.config.map;
+
+    const protocol = new pmtiles.Protocol();
+    maplibregl.addProtocol("pmtiles", protocol.tile);
+
+    if (typeof mapConfig.style === "object") {
+      // If the style is an object, we need to ensure it has the correct structure
+      // First we need to remove all None/null values from the style object
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      const removeNulls = (obj: any): any => {
+        if (Array.isArray(obj)) {
+          return obj.map(removeNulls);
+        }
+        if (typeof obj === "string") {
+          // This is a special case if we don't want to hardcode the root URL
+          // of the application in the style JSON, we can use #ROOT# as a placeholder
+          if (obj.includes("#ROOT#")) {
+            const rootUrl =
+              window.location.origin +
+              window.location.pathname.replace(/\/[^\/]*$/, "/");
+            return obj.replace(/#ROOT#/g, rootUrl);
+          }
+          return obj;
+        }
+        if (obj !== null && typeof obj === "object") {
+          return Object.entries(obj).reduce((acc, [key, value]) => {
+            if (value !== null && value !== undefined) {
+              acc[key] = removeNulls(value);
+            }
+            return acc;
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+          }, {} as any);
+        }
+        return obj;
+      };
+
+      const styleObject = removeNulls(mapConfig.style);
+
+      if (!styleObject.layers) {
+        styleObject.layers = layers("protomaps", namedFlavor("light"), {
+          lang: mapConfig.lang
+        });
+      }
+      mapConfig.style = styleObject;
+    }
+
+    // @ts-expect-error TS2589: Type instantiation is excessively deep and possibly infinite
+    mapInstance = new maplibregl.Map({
+      container: newEl,
+      style: mapConfig.style,
+      center: [mapConfig.center_lon, mapConfig.center_lat],
+      zoom: mapConfig.zoom,
+      pitch: mapConfig.pitch,
+      bearing: mapConfig.bearing,
+      attributionControl: false
+    });
+
+    tangramApi.value.map.initialize(mapInstance);
+  }
+});
+
+onUnmounted(() => {
+  tangramApi.value?.map.dispose();
+  if (mapInstance) {
+    mapInstance.remove();
+    mapInstance = undefined;
+  }
+});
+</script>
+
+<style>
+#app {
+  height: 100%;
+}
+
+/* styles from v0.1 App.vue */
+html {
+  width: 100%;
+  height: 100%;
+}
+
+body {
+  font-family: "B612", sans-serif;
+  width: 100%;
+  height: 100%;
+  margin: 0;
+  padding: 0;
+}
+
+.main-container {
+  height: 100%;
+  width: 100%;
+  display: flex;
+  flex-direction: column;
+}
+
+.navbar {
+  min-height: 50px;
+  background: white;
+  z-index: 500;
+  width: 100%;
+  box-sizing: border-box;
+  padding: 0.5rem 1rem;
+  display: flex;
+  flex-wrap: wrap;
+  align-items: center;
+  gap: 1.5rem;
+  border-bottom: 1px solid #e7e7e7;
+}
+
+.navbar-brand {
+  display: flex;
+  align-items: center;
+}
+
+.navbar-logo {
+  height: 24px;
+  margin-right: 5px;
+}
+
+.navbar-title {
+  padding-top: 0.3125rem;
+  padding-bottom: 0.3125rem;
+  font-size: 1.25rem;
+  margin-bottom: 0;
+  color: black;
+}
+
+.navbar-spacer {
+  margin-left: auto;
+}
+
+.sidebar {
+  position: absolute;
+  bottom: 15px;
+  left: 15px;
+  width: 21rem;
+  height: calc(100% - 95px);
+  transform: translate(2.5%, 0%);
+  overflow: hidden;
+  z-index: 1000;
+  box-shadow: 0 1px 5px rgba(0, 0, 0, 0.65);
+  border-radius: 4px;
+  display: flex;
+}
+
+.sidebar.collapsed {
+  width: 40px;
+  height: 40px;
+}
+
+.sidebar-tabs,
+.sidebar-tabs > ul {
+  width: 40px;
+  margin: 0;
+  padding: 0;
+  list-style-type: none;
+  border-right: 1px solid #ddd;
+}
+
+.sidebar-tabs > li,
+.sidebar-tabs > ul > li {
+  width: 40px;
+  height: 40px;
+  color: #333;
+  font-size: 12pt;
+  font-family: "B612", monospace;
+  overflow: hidden;
+  transition: all 80ms;
+}
+
+.sidebar-tabs > li > a,
+.sidebar-tabs > ul > li > a {
+  display: block;
+  width: 40px;
+  height: 100%;
+  line-height: 40px;
+  color: inherit;
+  text-decoration: none;
+  text-align: center;
+  cursor: pointer;
+}
+
+.sidebar-content {
+  flex: 1;
+  background-color: rgba(255, 255, 255, 1);
+  overflow-x: hidden;
+  overflow-y: auto;
+  padding: 5px;
+  display: flex;
+  flex-direction: column;
+}
+
+.sidebar.collapsed > .sidebar-content {
+  overflow-y: hidden;
+}
+
+.control-container {
+  position: absolute;
+  right: 55px;
+  bottom: 90px;
+}
+
+.map-container {
+  flex: 1;
+  flex-grow: 1;
+}
+
+.control-attribution {
+  display: none !important;
+}
+
+.top,
+.bottom {
+  z-index: 400;
+}
+
+.loading-container {
+  padding: 1.5rem;
+}
+
+.loading-detail {
+  margin-top: 0.5rem;
+  color: #555;
+}
+</style>

tangram_core/__init__.py

@@ -0,0 +1,5 @@
+from .backend import BackendState, InjectBackendState
+from .config import Config
+from .plugin import Plugin
+
+__all__ = ["BackendState", "Config", "InjectBackendState", "Plugin"]

tangram_core/__main__.py

@@ -0,0 +1,141 @@
+import asyncio
+import logging
+import os
+from importlib.abc import Traversable
+from pathlib import Path
+from typing import Annotated
+
+import platformdirs
+import typer
+from rich.console import Console
+from rich.table import Table
+
+from .backend import get_log_config_dict, resolve_frontend, start_tasks
+from .config import Config
+from .plugin import load_plugin, scan_plugins
+
+app = typer.Typer(no_args_is_help=True, pretty_exceptions_enable=False)
+logger = logging.getLogger(__name__)
+stderr = Console(stderr=True)
+
+
+def default_config_file() -> Path:
+    if (xdg_config := os.environ.get("XDG_CONFIG_HOME")) is not None:
+        config_dir = Path(xdg_config) / "tangram"
+    else:
+        config_dir = Path(platformdirs.user_config_dir(appname="tangram"))
+    if not config_dir.exists():
+        config_dir.mkdir(parents=True, exist_ok=True)
+
+    return Path(config_dir) / "tangram.toml"
+
+
+@app.command()
+def serve(
+    config: Annotated[
+        Path,
+        typer.Option(
+            help="Path to the tangram.toml config file.",
+            envvar="TANGRAM_CONFIG",
+            default_factory=default_config_file,
+        ),
+    ],
+) -> None:
+    """Serves the core tangram frontend and backend services."""
+    if not config.is_file():
+        logger.error(f"config file not found: {config}")
+        raise typer.Exit()
+
+    cfg = Config.from_file(config)
+    logging.config.dictConfig(get_log_config_dict(cfg))
+
+    try:
+        asyncio.run(start_tasks(cfg))
+    except KeyboardInterrupt:
+        logger.info("shutting down services.")
+
+
+@app.command(name="list-plugins")
+def list_plugins(
+    config_path: Annotated[
+        Path | None,
+        typer.Option("--config", help="Path to the tangram.toml config file."),
+    ] = None,
+    all_plugins: Annotated[
+        bool, typer.Option("--all", help="Load all discovered plugins.")
+    ] = False,
+) -> None:
+    """Lists discovered plugins and their components."""
+    table = Table()
+    table.add_column("plugin")
+    table.add_column("status")
+    table.add_column("frontend")
+    table.add_column("routers")
+    table.add_column("services")
+
+    enabled_plugins: list[str] | None = None
+    if config_path and config_path.is_file():
+        config = Config.from_file(config_path)
+        enabled_plugins = config.core.plugins
+
+    for entry_point in scan_plugins():
+        plugin_name = entry_point.name
+        load_this_plugin = all_plugins or (
+            enabled_plugins is not None and plugin_name in enabled_plugins
+        )
+
+        if not load_this_plugin:
+            table.add_row(plugin_name, "available", "?", "?", "?")
+            continue
+
+        if (p := load_plugin(entry_point)) is None:
+            status_str = "[red]load failed[/red]"
+            table.add_row(plugin_name, status_str, "!", "!", "!")
+            continue
+        name, plugin = p
+        status = (
+            "enabled"
+            if enabled_plugins and plugin_name in enabled_plugins
+            else "loaded"
+        )
+        frontend_str = ""
+        if plugin_path := plugin.frontend_path:
+            if resolved_path := resolve_frontend(path=name, dist_name=plugin_name):
+                size_kb = get_path_size(resolved_path) / 1024
+                frontend_str = f"{size_kb:.1f} B"
+            else:
+                frontend_str = f"[yellow]({plugin_path} not found)[/yellow]"
+
+        status_str = f"[green]{status}[/green]"
+        router_prefixes = [func.prefix for func in plugin.routers]
+        service_names = [func.__name__ for _, func in plugin.services]
+
+        table.add_row(
+            plugin_name,
+            status_str,
+            frontend_str,
+            "\n".join(router_prefixes),
+            "\n".join(service_names),
+        )
+
+    stderr.print(table)
+
+
+def get_path_size(path: Path | Traversable) -> int:
+    total_size = 0
+    for item in path.iterdir():
+        if item.is_file():
+            with item.open("rb") as f:
+                total_size += len(f.read())
+        elif item.is_dir():
+            total_size += get_path_size(item)
+    return total_size
+
+
+@app.command()
+def develop() -> None:
+    raise SystemExit
+
+
+if __name__ == "__main__":
+    app()

tangram_core/_core.pyi

@@ -0,0 +1,38 @@
+# This file is automatically generated by pyo3_stub_gen
+# ruff: noqa: E501, F401
+
+import builtins
+import typing
+
+@typing.final
+class ChannelConfig:
+    @property
+    def host(self) -> builtins.str: ...
+    @host.setter
+    def host(self, value: builtins.str) -> None: ...
+    @property
+    def port(self) -> builtins.int: ...
+    @port.setter
+    def port(self, value: builtins.int) -> None: ...
+    @property
+    def redis_url(self) -> builtins.str: ...
+    @redis_url.setter
+    def redis_url(self, value: builtins.str) -> None: ...
+    @property
+    def jwt_secret(self) -> builtins.str: ...
+    @jwt_secret.setter
+    def jwt_secret(self, value: builtins.str) -> None: ...
+    @property
+    def jwt_expiration_secs(self) -> builtins.int: ...
+    @jwt_expiration_secs.setter
+    def jwt_expiration_secs(self, value: builtins.int) -> None: ...
+    @property
+    def id_length(self) -> builtins.int: ...
+    @id_length.setter
+    def id_length(self, value: builtins.int) -> None: ...
+    def __new__(cls, host: builtins.str, port: builtins.int, redis_url: builtins.str, jwt_secret: builtins.str, jwt_expiration_secs: builtins.int, id_length: builtins.int) -> ChannelConfig: ...
+
+def init_tracing_stderr(filter_str: builtins.str) -> None: ...
+
+def run(config: ChannelConfig) -> typing.Any: ...
+