Compare commits
17
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
188eb4c949 | ||
|
|
758f04d2a1 | ||
|
|
6632174b22 | ||
|
|
8af0b99294 | ||
|
|
f3e30cecc5 | ||
|
|
b47835b4b2 | ||
|
|
40aa245468 | ||
|
|
ef1a0cfa9f | ||
|
|
2874d468d9 | ||
|
|
6c2c58a6cf | ||
|
|
5055d2c110 | ||
|
|
44bacbaffd | ||
|
|
7354b414e7 | ||
|
|
196380c0af | ||
|
|
06e919639d | ||
|
|
f948f2aaab | ||
|
|
a5125dba7b |
No files matched your search
@@ -87,3 +87,6 @@ packages/*/dist/
|
||||
|
||||
# proprietary extracted services
|
||||
packages/wwv-data-engine/
|
||||
|
||||
# IDE workspace files
|
||||
*.code-workspace
|
||||
@@ -104,10 +104,10 @@ Visibility Toggle → DataBusSubscriber subscribes to layer via WsClient
|
||||
Four plugin architectures exist (All-Bundle Model):
|
||||
1. **Data Engine Seeder** — Standalone Fastify container with SQLite microservice or unified seeders (e.g., `iranwarlive-backend`).
|
||||
2. **Dynamic CDN Loaded (Bundle)** — Externally developed plugins dynamically imported at runtime via ES module CDNs (e.g., `unpkg.com` version-pinned URLs).
|
||||
3. **Static Compiled (Bundle)** — Static GeoJSON data wrapped into JS bundles via `wwvStaticCompiler` during build/sync (previously `StaticDataPlugin`).
|
||||
4. **Active Proxied (Bundle)** — Next.js API routes bundled to provide frontend interactions (previously `DeclarativePlugin`).
|
||||
3. **WWV CLI Unpacked (Dev)** — Developed externally using `@worldwideview/cli dev`, which spins up a local Vite server and hot-reloads via WebSocket injection directly into the running platform.
|
||||
4. **Marketplace Package (.wwvpkg)** — Built via `@worldwideview/cli publish` and distributed through the WorldWideView Marketplace.
|
||||
|
||||
All plugins are now dynamically imported at runtime as ES module bundles via `loadPluginFromManifest` utilizing `import(/* webpackIgnore: true */ entry)`. The legacy `StaticDataPlugin` and `DeclarativePlugin` runtimes are fully deprecated.
|
||||
All plugins are now dynamically imported at runtime as ES module bundles via `loadPluginFromManifest` utilizing `import(/* webpackIgnore: true */ entry)`. The plugin passport is defined in `wwv-manifest.json` which governs its trust tier (`developer`, `unverified`, `verified`, `built-in`) and capabilities.
|
||||
|
||||
Plugin types are re-exported from SDK through `src/core/plugins/PluginTypes.ts` and `PluginManifest.ts` — **source of truth is always `@worldwideview/wwv-plugin-sdk`**.
|
||||
|
||||
|
||||
@@ -1,54 +1,32 @@
|
||||
<div align="center">
|
||||
|
||||
<!-- Generated: 2026-04-19 02:20:00 UTC -->
|
||||
# WorldWideView 🌍
|
||||
<!-- Generated: 2026-04-23 06:11:00 UTC -->
|
||||
# WorldWideView
|
||||
|
||||
**The Open-Source, Plugin-Driven Geospatial Intelligence Engine**
|
||||
|
||||
[](LICENSE)
|
||||
[](CONTRIBUTING.md)
|
||||
|
||||
*A modular situational awareness platform designed to ingest live data streams and render them as interactive, cinematic layers on a high-fidelity CesiumJS 3D globe.*
|
||||
|
||||
<!-- 📸 Replace with a high-res GIF or screenshot of the platform running with multiple layers enabled -->
|
||||

|
||||
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
WorldWideView is a real-time geospatial engine visualizing live global data on an interactive 3D globe. Utilizing a dynamic "All-Bundle" plugin architecture, independent data sources—like live aircraft, satellites, or OSINT news clusters—are ingested and rendered decoupled from the core 3D viewer.
|
||||
WorldWideView is a real-time geospatial engine visualizing live global data on an interactive 3D globe. Utilizing a dynamic "All-Bundle" plugin architecture, independent data sources—like live aircraft, maritime vessels, or conflict events—are ingested and rendered decoupled from the core 3D viewer.
|
||||
|
||||
---
|
||||
## Core Technologies
|
||||
|
||||
## 🛠 Prerequisites
|
||||
- **Frontend:** Next.js 16 (App Router), React 19, TypeScript 5
|
||||
- **3D Engine:** CesiumJS + Resium (Google Photorealistic 3D Tiles)
|
||||
- **State Management:** Zustand
|
||||
- **Event Bus:** Custom typed `DataBus` for high-frequency WebSocket updates
|
||||
- **Database:** SQLite via Prisma (local), PostgreSQL (cloud)
|
||||
- **Deployment:** Docker multi-stage build, Coolify
|
||||
|
||||
Before starting, ensure you have the required tools installed based on how you want to use WorldWideView:
|
||||
- **For Self-Hosting:** You only need Docker.
|
||||
- **For Local Development/Contributing:** You need Node.js and `pnpm`.
|
||||
## Quick Start (Self-Hosting)
|
||||
|
||||
### Installing Docker (For Self-Hosting)
|
||||
- **Windows / Mac:** Download and install [Docker Desktop](https://www.docker.com/products/docker-desktop/). *(Windows users: Ensure WSL 2 integration is enabled in Settings > Resources > WSL Integration).*
|
||||
- **Linux (Ubuntu/Debian):**
|
||||
```bash
|
||||
curl -fsSL https://get.docker.com -o get-docker.sh
|
||||
sudo sh get-docker.sh
|
||||
```
|
||||
|
||||
### Installing pnpm (For Developers)
|
||||
If you want to contribute to the code, you'll need the `pnpm` package manager:
|
||||
- **Windows (PowerShell):** `iwr https://get.pnpm.io/install.ps1 -useb | iex`
|
||||
- **Mac / Linux:** `curl -fsSL https://get.pnpm.io/install.sh | sh -`
|
||||
- **Or via npm:** `npm install -g pnpm`
|
||||
|
||||
---
|
||||
|
||||
## 🐋 Self-Hosting & Production Deployment (Docker)
|
||||
|
||||
WorldWideView uses a multi-stage Dockerfile designed for standalone output, natively supporting deployment via Coolify or standard Docker Compose.
|
||||
|
||||
### Instant Self-Hosting (Recommended)
|
||||
Get the platform running on your own server instantly using our automated Docker Compose deployment scripts:
|
||||
WorldWideView uses a multi-stage Dockerfile designed for standalone output. To deploy instantly on your own server:
|
||||
|
||||
**Mac/Linux:**
|
||||
```bash
|
||||
@@ -62,158 +40,50 @@ mkdir worldwideview; cd worldwideview
|
||||
Invoke-WebRequest -Uri https://raw.githubusercontent.com/silvertakana/worldwideview/main/setup.ps1 -UseBasicParsing | Invoke-Expression
|
||||
```
|
||||
|
||||
### Manual Docker Deployment
|
||||
If you prefer to deploy manually:
|
||||
```bash
|
||||
# Start the core app, Redis cache, and Data Engine microservice in production mode
|
||||
docker compose up -d
|
||||
```
|
||||
> [!NOTE]
|
||||
> Ensure you mount the `/app/data` volume to persist the SQLite database across container restarts.
|
||||
|
||||
**Persistent Storage Requirements:**
|
||||
When deploying to production, ensure you mount the following volumes to prevent data loss:
|
||||
- Mount `/app/data` to persist the core SQLite database.
|
||||
- Mount `/app/packages/wwv-data-engine/data` to persist the custom plugin microservices SQLite layer.
|
||||
- Mount `/data` to persist the standalone Redis container.
|
||||
## Quick Start (Local Development)
|
||||
|
||||
---
|
||||
To run the source code locally for contributing or developing:
|
||||
|
||||
## 🚀 Installation & Setup (Local Development)
|
||||
|
||||
Get the source code running locally for contributing or modifying the core platform.
|
||||
|
||||
### Quick Start Scripts
|
||||
**Mac/Linux:**
|
||||
```bash
|
||||
git clone https://github.com/silvertakana/worldwideview.git
|
||||
cd worldwideview
|
||||
bash local-dev.sh
|
||||
```
|
||||
|
||||
**Windows (PowerShell):**
|
||||
```powershell
|
||||
git clone https://github.com/silvertakana/worldwideview.git
|
||||
cd worldwideview
|
||||
.\local-dev.ps1
|
||||
```
|
||||
|
||||
### Manual Setup
|
||||
```bash
|
||||
git clone https://github.com/silvertakana/worldwideview.git
|
||||
cd worldwideview
|
||||
pnpm install
|
||||
pnpm run setup # generates .env.local with AUTH_SECRET
|
||||
pnpm run dev:all # boots the UI, cache layers, and the marketplace engine
|
||||
pnpm run dev:all # boots the UI, cache layers, and the data engine
|
||||
```
|
||||
Visit `http://localhost:3000` to see the live globe.
|
||||
|
||||
---
|
||||
## Plugin Ecosystem
|
||||
|
||||
## ⚡ Plugin Development Quick Start
|
||||
WorldWideView operates on an open-core philosophy. The platform itself is data-agnostic; all data sources are dynamically imported as plugins at runtime.
|
||||
|
||||
WorldWideView’s architecture means **everything is a plugin**. The core engine is completely data-agnostic. You can build your own WorldWideView plugins using the officially supported CLI toolchain.
|
||||
- **[Plugin Quickstart Guide](docs/plugin-quickstart.md)**: Learn how to scaffold and link your first plugin using the `@worldwideview/cli`.
|
||||
- **[Advanced Plugin Guide](docs/plugin-advanced.md)**: Deep dive into microservice data seeders, WebSockets, complex 3D rendering, and Marketplace publishing.
|
||||
|
||||
### 1. Scaffold your plugin
|
||||
The plugin folder is pure code. It contains no Docker boilerplate.
|
||||
```bash
|
||||
npx @worldwideview/create-plugin my-layer
|
||||
cd my-layer
|
||||
npm install
|
||||
```
|
||||
## Repository Ecosystem
|
||||
|
||||
### 2. Sideload the plugin into your platform
|
||||
The CLI acts as a bridge, injecting your compiled plugin directly into your running WorldWideView instance.
|
||||
WorldWideView is distributed across several specialized repositories:
|
||||
|
||||
**If you are running the platform via Docker:**
|
||||
Ensure your Docker Compose file has a volume mount exposing the plugin directory:
|
||||
`volumes: [ "./my-local-plugins:/app/public/plugins-local" ]`
|
||||
And set the environment variable: `WWV_PLUGIN_DEV=true`
|
||||
1. **`worldwideview`** (This Repo): Main frontend, CesiumJS rendering engine, and core plugin framework.
|
||||
2. **`wwv-data-engine`**: Open-source community data backend for polling public APIs.
|
||||
3. **`worldwideview-plugins`**: First-party maintained plugins.
|
||||
4. **`worldwideview-marketplace`**: The web application driving the plugin directory.
|
||||
5. **`worldwideview-web`**: Marketing and landing site.
|
||||
|
||||
Then, tell the CLI where that exposed folder is:
|
||||
```bash
|
||||
# Save the path so you only have to type it once
|
||||
npx wwv config set wwv-path /absolute/path/to/my-local-plugins
|
||||
## Documentation Index
|
||||
|
||||
# Start the dev server and link the plugin!
|
||||
npm run link
|
||||
```
|
||||
Explore our comprehensive documentation suite for detailed engineering insights:
|
||||
|
||||
**If you cloned the platform repository (`pnpm dev`):**
|
||||
```bash
|
||||
npx wwv config set wwv-path ../worldwideview
|
||||
npm run link
|
||||
```
|
||||
|
||||
The CLI will start Vite in watch mode. Every time you save a file, it compiles in milliseconds and pushes the update directly into your WorldWideView instance. Refresh your browser to see changes!
|
||||
|
||||
### 3. Validate & Publish
|
||||
If you are building a simple, static data layer and don't need local testing:
|
||||
```bash
|
||||
npm run validate
|
||||
npm run build
|
||||
npm publish
|
||||
```
|
||||
|
||||
📖 **[Read the Full Plugin Guide](docs/PLUGIN_GUIDE.md)** for a deep dive into hooking up websockets or static datasets.
|
||||
|
||||
---
|
||||
|
||||
## 🧠 Core Architecture & Philosophies
|
||||
|
||||
- **Open-Core Data Engine**: The real-time backend data pipeline operates on a public/private split-routing model. Community seeders (like ISS tracking) live in the open-source `wwv-data-engine`, while proprietary sources seamlessly interleave via our internal cloud endpoints.
|
||||
- **Dynamic, Decentralized Plugins**: The plugin ecosystem uses a decentralized architecture fetching ES module CDN bundles (e.g., from unpkg) at runtime. The core engine is a lightweight shell that loads data providers dynamically via the marketplace.
|
||||
- **High-Performance Rendering**: Engineered for scale using raw Cesium primitives to smoothly handle upwards of 100,000+ objects simultaneously without GPU stalls.
|
||||
- **Cinematic Situational Awareness**: Implements horizon culling, smooth camera tracking, orientation-locked billboarding, and stack spiderification for dense locations.
|
||||
|
||||
---
|
||||
|
||||
## 🏛 Repository Ecosystem
|
||||
|
||||
WorldWideView follows an **Open-Core** philosophy distributed across several independent, specialized repositories:
|
||||
|
||||
1. **[worldwideview](https://github.com/silvertakana/worldwideview)** *(This Repo)*
|
||||
The main Next.js frontend, CesiumJS rendering engine, and core plugin loading framework.
|
||||
2. **[wwv-data-engine](https://github.com/silvertakana/wwv-data-engine)**
|
||||
The open-source community data backend. It polls public APIs (like ISS tracking or USGS earthquakes) and streams them to the frontend via WebSocket.
|
||||
*(Note: The official production deployment uses a proprietary internal fork of this engine that includes additional restricted seeders like aviation and maritime).*
|
||||
3. **[worldwideview-plugins](https://github.com/silvertakana/worldwideview-plugins)**
|
||||
Our first-party maintained plugins (borders, nuclear sites, military bases, etc.) developed directly by the core team.
|
||||
4. **[worldwideview-marketplace](https://github.com/silvertakana/worldwideview-marketplace)**
|
||||
The web application driving the plugin directory and community submissions.
|
||||
5. **[worldwideview-web](https://github.com/silvertakana/worldwideview-web)**
|
||||
The marketing, documentation, and landing site.
|
||||
|
||||
---
|
||||
|
||||
## 🏗 Development & Code Map
|
||||
|
||||
### Key Entry Points
|
||||
- UI Loader: `src/components/layout/AppShell.tsx`
|
||||
- Dynamic Plugin Ingestion: `src/core/plugins/loadPluginFromManifest.ts`
|
||||
- Global WebSocket Event Loop: `src/core/data/DataBus.ts`
|
||||
- Environment Config: `.env.local` alongside `src/core/edition.ts`
|
||||
|
||||
---
|
||||
|
||||
## 📚 Documentation Index
|
||||
|
||||
- **[Setup & Installation Guide](docs/SETUP.md)**: Detailed environment and local development setup.
|
||||
- **[Architecture (Engineering Depth)](docs/ARCHITECTURE.md)**: Deep dive into the Cesium rendering pipeline, event data bus, and performance optimizations.
|
||||
- **[Contributions Guide](CONTRIBUTING.md)**: How to help out, coding standards, and commit conventions.
|
||||
- **[User Guide](docs/USER_GUIDE.md)**: Application features and navigation tips.
|
||||
|
||||
### Internal Engineering Docs
|
||||
- **[Build System](docs/build-system.md)**: Find compile targets for UI bundles and internal `wwvStaticCompiler` plugin bundling.
|
||||
- **[Testing Overview](docs/testing.md)**: Understanding Vitest strategies and isolated typing execution targets.
|
||||
- **[Development Patterns](docs/development.md)**: View standard hook approaches, Zustand architecture rules, and snippet targets.
|
||||
- **[Deployment Workflows](docs/deployment.md)**: Detailed insights on Next.js standalone execution and persistent database volume arrays.
|
||||
- **[Source File Catalog](docs/files.md)**: High-level mappings of core ingestion controllers to rendering context interfaces.
|
||||
|
||||
---
|
||||
|
||||
## 🤝 Contributing & Community
|
||||
|
||||
We are actively looking for contributors to help build new data plugins and optimize the core 3D engine!
|
||||
- Found a bug or have an idea? Search the [Issue Tracker](https://github.com/silvertakana/worldwideview/issues) and submit a report.
|
||||
- Want to build something? Check out our **[Pinned Plugin Wishlist](https://github.com/silvertakana/worldwideview/issues)** for great first issues!
|
||||
- **[Project Overview](docs/project-overview.md)**: High-level value proposition and technology stack.
|
||||
- **[Architecture](docs/architecture.md)**: DataBus event stream and Zustand state management.
|
||||
- **[Build System](docs/build-system.md)**: Monorepo structure, Next.js standalone output, and Docker builds.
|
||||
- **[Development](docs/development.md)**: Coding conventions and common implementation patterns.
|
||||
- **[Testing](docs/testing.md)**: Vitest setup and coverage targets.
|
||||
- **[Deployment](docs/deployment.md)**: Coolify integration and persistent volumes.
|
||||
- **[Files Catalog](docs/files.md)**: Comprehensive mapping of core source files.
|
||||
|
||||
> [!IMPORTANT]
|
||||
> **Fair-Use Notice:** This application may contain copyrighted material the use of which has not always been specifically authorized by the copyright owner. Such material is made available for educational purposes, situational awareness, and to advance understanding of global events under "fair use" (Section 107 of the US Copyright Law).
|
||||
@@ -0,0 +1,7 @@
|
||||
# This file lists tools managed by Aftman, a cross-platform toolchain manager.
|
||||
# For more information, see https://github.com/LPGhatguy/aftman
|
||||
|
||||
# To add a new tool, add an entry to this table.
|
||||
[tools]
|
||||
rojo = "rojo-rbx/[email protected]"
|
||||
# rojo = "rojo-rbx/[email protected]"
|
||||
@@ -1,91 +0,0 @@
|
||||
# API Reference
|
||||
|
||||
This document provides a technical reference for the core internal services of WorldWideView. These services are designed to be used by plugins and core components for communication and data management.
|
||||
|
||||
## `DataBus`
|
||||
|
||||
The `DataBus` is a central event emitter used for decoupled, typed communication between different parts of the application.
|
||||
|
||||
- **Import**: `import { dataBus } from "@/core/data/DataBus";`
|
||||
- **Source**: `src/core/data/DataBus.ts`
|
||||
|
||||
### Methods
|
||||
|
||||
#### `on<K>(event: K, handler: Handler): () => void`
|
||||
Subscribes to an event. Returns an unsubscribe function.
|
||||
- **event**: The event name (keys of `DataBusEvents`).
|
||||
- **handler**: A callback function receiving the event data.
|
||||
|
||||
#### `off<K>(event: K, handler: Handler): void`
|
||||
Unsubscribes from an event.
|
||||
- **event**: The event name.
|
||||
- **handler**: The handler function to remove.
|
||||
|
||||
#### `emit<K>(event: K, data: T): void`
|
||||
Broadcasts an event to all subscribers.
|
||||
- **event**: The event name.
|
||||
- **data**: The payload for the event.
|
||||
|
||||
#### `removeAllListeners(event?: string): void`
|
||||
Removes all listeners for a specific event, or all listeners if no event is provided.
|
||||
|
||||
---
|
||||
|
||||
## `PluginRegistry`
|
||||
|
||||
The `PluginRegistry` manages the registration and discovery of all `WorldPlugin` implementations.
|
||||
|
||||
- **Import**: `import { pluginRegistry } from "@/core/plugins/PluginRegistry";`
|
||||
- **Source**: `src/core/plugins/PluginRegistry.ts`
|
||||
|
||||
### Methods
|
||||
|
||||
#### `register(plugin: WorldPlugin): void`
|
||||
Adds a new plugin to the registry. Throws a warning if the plugin ID is already registered.
|
||||
|
||||
#### `get(pluginId: string): WorldPlugin | undefined`
|
||||
Retrieves a plugin by its unique ID.
|
||||
|
||||
#### `getAll(): WorldPlugin[]`
|
||||
Returns an array of all registered plugins.
|
||||
|
||||
#### `getByCategory(category: string): WorldPlugin[]`
|
||||
Returns all plugins belonging to a specific category.
|
||||
|
||||
#### `has(pluginId: string): boolean`
|
||||
Checks if a plugin with the given ID is registered.
|
||||
|
||||
#### `unregister(pluginId: string): void`
|
||||
Removes a plugin from the registry.
|
||||
|
||||
---
|
||||
|
||||
## `CacheLayer`
|
||||
|
||||
The `CacheLayer` provides a two-tier caching mechanism for geographical entities.
|
||||
|
||||
- **Import**: `import { cacheLayer } from "@/core/data/CacheLayer";`
|
||||
- **Source**: `src/core/data/CacheLayer.ts`
|
||||
|
||||
### Methods
|
||||
|
||||
#### `init(): Promise<void>`
|
||||
Initializes the IndexedDB store. Must be called before persistent storage operations.
|
||||
|
||||
#### `set(pluginId: string, entities: GeoEntity[], ttlMs?: number): void`
|
||||
Caches entities for a plugin.
|
||||
- **pluginId**: Unique identifier for the data source.
|
||||
- **entities**: Array of `GeoEntity` objects.
|
||||
- **ttlMs**: Time-to-live in milliseconds (default: 30,000).
|
||||
|
||||
#### `get(pluginId: string): GeoEntity[] | null`
|
||||
Retrieves entities from the L1 (Memory) cache. Returns `null` if expired or missing.
|
||||
|
||||
#### `getFromPersistent(pluginId: string): Promise<GeoEntity[] | null>`
|
||||
Retrieves entities from the L2 (IndexedDB) cache. This method also populates the L1 cache on success.
|
||||
|
||||
#### `invalidate(pluginId: string): void`
|
||||
Removes entries for a plugin from both L1 and L2 caches.
|
||||
|
||||
#### `clear(): void`
|
||||
Purges all data from both cache tiers.
|
||||
+25
-17
@@ -1,25 +1,33 @@
|
||||
<!-- Generated: 2026-04-19 15:23:00 UTC -->
|
||||
# System Architecture
|
||||
<!-- Generated: 2026-04-23 06:11:00 UTC -->
|
||||
# Architecture
|
||||
|
||||
WorldWideView operates on a decoupled Core-and-Plugin architecture. The central platform provides the 3D globe, HUD, timeline, and rendering optimizations, while separate intelligence domains are entirely handled by external plugin packages that are bundled and ingested at runtime.
|
||||
## Overview
|
||||
WorldWideView operates on a decoupled, plugin-based architecture designed for real-time visualization of geospatial data. The system is split between a Next.js 16 frontend that handles UI and CesiumJS 3D rendering, and a network of plugin data seeders that stream live updates via WebSockets.
|
||||
|
||||
The underlying data backbone uses a WebSocket Firehose, streaming continuous high-frequency metrics from standalone data engine microservices perfectly isolated from the visualization layer.
|
||||
The core design philosophy is the "All-Bundle Model," where plugins are dynamically imported at runtime as ES module bundles (`Dynamic CDN Loaded`). The frontend maintains a modular state architecture using Zustand, routing high-frequency data updates through a custom `DataBus` singleton to avoid React render cycle bottlenecks.
|
||||
|
||||
## Component Map
|
||||
- **UI Platform:** `src/components/layout/AppShell.tsx`
|
||||
- **3D Visualizer:** `src/core/globe/GlobeView.tsx`
|
||||
- **State Store:** `src/core/state/globeSlice.ts` and peers.
|
||||
- **Event Bus:** `src/core/data/DataBus.ts`
|
||||
- **Microservice Connectors:** `packages/wwv-plugin-sdk/src/PluginManifest.ts`
|
||||
- **Frontend App Shell:** Next.js App Router providing layout and base API routes (in `src/app/`).
|
||||
- **Globe Rendering Engine:** CesiumJS wrapped in Resium, responsible for 3D primitive and model rendering (in `src/core/globe/`).
|
||||
- **State Management:** Zustand slice-based architecture (in `src/core/state/`).
|
||||
- **Data Pipeline:** Custom event bus (`DataBus`) and WebSocket clients (`DataBusSubscriber`) routing live data to state (in `src/core/data/`).
|
||||
- **Plugin System:** Registration, lifecycle management, and ES module loaders (in `src/core/plugins/`).
|
||||
- **Database Layer:** Prisma ORM connecting to local SQLite or cloud PostgreSQL (in `prisma/`).
|
||||
|
||||
## Key Files
|
||||
- `src/core/globe/GlobeView.tsx` (lines 60-150): The central CesiumJS ingestion point and scene orchestrator.
|
||||
- `src/core/globe/EntityRenderer.tsx` (lines 45-120): High-performance batched Primitive mapping for geometric entities.
|
||||
- `src/core/plugins/PluginManager.ts` (lines 20-100): Validates and bootstraps compiled ES Modules from CDN/local sources.
|
||||
- `src/core/plugins/PluginManager.ts` - The PluginManager class. Core registry that instantiates plugins, calls `initialize()`, and handles lifecycle events.
|
||||
- `src/core/plugins/loaders/InstalledPluginsLoader.ts` - Dynamically fetches and imports `import(/* webpackIgnore: true */ ...)` marketplace plugins into the environment.
|
||||
- `src/core/data/DataBus.ts` - Custom typed event bus singleton that routes high-frequency data around the application.
|
||||
- `src/core/globe/GlobeView.tsx` - The main Cesium viewer container, handling imagery layers, cameras, and primitive collections.
|
||||
- `src/core/state/store.ts` - The main Zustand store registry linking the nine state slices (globe, layers, timeline, ui, filter, data, config, favorites, geojson).
|
||||
|
||||
## Data Flow
|
||||
The real-time data flow triggers globally via WebSockets:
|
||||
1. `src/lib/WsClient.ts` captures the socket frame from `dataengine.worldwideview.dev`.
|
||||
2. Emits payload through `src/core/data/DataBus.ts` (lines 30-50).
|
||||
3. The `DataBusSubscriber.tsx` hook catches the event, sanitizing and merging the data into `src/core/state/dataSlice.ts`.
|
||||
4. `EntityRenderer` automatically reacts to State changes, triggering low-level Cesium Primitive re-draws against the GPU.
|
||||
Real-time data follows a strict unidirectional stream optimized for sub-second updates:
|
||||
|
||||
1. **Engine Push:** A remote data engine pushes state over WebSocket (`/stream`) from either local seeders (`ws://localhost:5001/stream`) or the cloud fallback (`wss://dataengine.worldwideview.dev/stream`).
|
||||
2. **WebSocket Client Router:** `WsClient.handleMessage()` receives the payload and pipes it to the event bus.
|
||||
3. **DataBus Emission:** The bus fires `DataBus.emit("websocketData", WsStreamPayload)`.
|
||||
4. **State Hydration:** The `DataBusSubscriber` component listens to the bus and calls `_hydrateSnapshot()` to update the Zustand store's `entitiesByPlugin` cache.
|
||||
5. **Memoized Selection:** `GlobeView` selects the visible entities from the store.
|
||||
6. **Primitive Rendering:** The `EntityRenderer` translates store entities into Cesium `PointPrimitiveCollection` and `BillboardCollection` arrays for GPU rendering.
|
||||
7. **Animation & LOD:** `AnimationLoop` handles horizon culling and hover effects, while `useModelRendering` promotes close-range entities to 3D glTF models.
|
||||
@@ -1,452 +0,0 @@
|
||||
# WorldWideView Plugin Guide
|
||||
|
||||
Build custom data layer plugins for the WorldWideView 3D globe platform. This guide covers the full plugin lifecycle, available APIs, and step-by-step instructions for creating your own plugin.
|
||||
|
||||
## Architecture Overview
|
||||
|
||||
```
|
||||
┌─────────────────────────────────────────────────┐
|
||||
│ UI Layer │
|
||||
│ LayerPanel ─ InfoCard ─ Timeline ─ ConfigPanel │
|
||||
└────────────────────┬────────────────────────────┘
|
||||
│ Zustand Store
|
||||
┌────────────────────┴────────────────────────────┐
|
||||
│ Plugin Manager │
|
||||
│ register → initialize → enable/disable → poll │
|
||||
│ ┌────────┴────────┐ │
|
||||
│ PluginRegistry PollingManager │
|
||||
│ │ │ │
|
||||
│ DataBus (events) CacheLayer (2-tier) │
|
||||
└────────────────────┬────────────────────────────┘
|
||||
│
|
||||
┌────────────────────┴────────────────────────────┐
|
||||
│ Your Plugin (WorldPlugin) │
|
||||
│ fetch() → GeoEntity[] → renderEntity() → Globe │
|
||||
└─────────────────────────────────────────────────┘
|
||||
```
|
||||
|
||||
### Plugin Lifecycle
|
||||
|
||||
1. **Instantiation**: Your class is instantiated and passed to `pluginRegistry.register()`.
|
||||
2. **Registration**: The `PluginManager` discovers the plugin in the registry during the boot sequence.
|
||||
3. **Initialization**: `initialize(ctx)` is called. This is where you should set up your domain-specific API clients or static data.
|
||||
4. **Enabled State**: When a user toggles the layer in the UI, the `PluginManager` starts the polling cycle.
|
||||
5. **Fetch/Render Cycle**: `fetch()` is called periodically; `renderEntity()` is called for result.
|
||||
6. **Destruction**: `destroy()` is called if the plugin is unregistered or the application is unmounted.
|
||||
|
||||
### Data Flow
|
||||
|
||||
```mermaid
|
||||
sequenceDiagram
|
||||
participant PM as PluginManager
|
||||
participant P as YourPlugin
|
||||
participant DB as DataBus
|
||||
|
||||
PM->>P: initialize(ctx)
|
||||
Note over PM, P: User toggles layer ON
|
||||
loop Every getPollingInterval()
|
||||
PM->>P: fetch(timeRange)
|
||||
P-->>PM: GeoEntity[]
|
||||
PM->>DB: emit("dataUpdated")
|
||||
end
|
||||
Note over PM, P: User toggles layer OFF
|
||||
PM->>PM: Stop Polling
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Quick Start: Minimal Plugin
|
||||
|
||||
```typescript
|
||||
// src/plugins/earthquakes/index.ts
|
||||
import { Activity } from "lucide-react";
|
||||
import type {
|
||||
WorldPlugin, GeoEntity, TimeRange, PluginContext,
|
||||
LayerConfig, CesiumEntityOptions,
|
||||
} from "@/core/plugins/PluginTypes";
|
||||
|
||||
export class EarthquakePlugin implements WorldPlugin {
|
||||
id = "earthquake";
|
||||
name = "Earthquakes";
|
||||
description = "Recent seismic activity from USGS";
|
||||
icon = Activity;
|
||||
category = "natural-disaster" as const;
|
||||
version = "1.0.0";
|
||||
|
||||
private context: PluginContext | null = null;
|
||||
|
||||
async initialize(ctx: PluginContext): Promise<void> {
|
||||
this.context = ctx;
|
||||
}
|
||||
|
||||
destroy(): void {
|
||||
this.context = null;
|
||||
}
|
||||
|
||||
async fetch(_timeRange: TimeRange): Promise<GeoEntity[]> {
|
||||
const res = await fetch("/api/earthquake");
|
||||
if (!res.ok) return [];
|
||||
const data = await res.json();
|
||||
return data.features.map((f: any): GeoEntity => ({
|
||||
id: `earthquake-${f.id}`,
|
||||
pluginId: "earthquake",
|
||||
latitude: f.geometry.coordinates[1],
|
||||
longitude: f.geometry.coordinates[0],
|
||||
altitude: 0,
|
||||
timestamp: new Date(f.properties.time),
|
||||
label: `M${f.properties.mag}`,
|
||||
properties: {
|
||||
magnitude: f.properties.mag,
|
||||
depth: f.geometry.coordinates[2],
|
||||
place: f.properties.place,
|
||||
},
|
||||
}));
|
||||
}
|
||||
|
||||
getPollingInterval(): number {
|
||||
return 120000; // 2 minutes
|
||||
}
|
||||
|
||||
getLayerConfig(): LayerConfig {
|
||||
return {
|
||||
color: "#ef4444",
|
||||
clusterEnabled: true,
|
||||
clusterDistance: 40,
|
||||
};
|
||||
}
|
||||
|
||||
renderEntity(entity: GeoEntity): CesiumEntityOptions {
|
||||
const mag = (entity.properties.magnitude as number) || 0;
|
||||
return {
|
||||
type: "point",
|
||||
color: mag >= 5 ? "#dc2626" : mag >= 3 ? "#f97316" : "#fbbf24",
|
||||
size: Math.max(4, mag * 2),
|
||||
outlineColor: "#000000",
|
||||
outlineWidth: 1,
|
||||
};
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Register Your Plugin
|
||||
|
||||
In your app's initialization code (e.g. the root layout component):
|
||||
|
||||
```typescript
|
||||
import { pluginRegistry } from "@/core/plugins/PluginRegistry";
|
||||
import { EarthquakePlugin } from "@/plugins/earthquakes";
|
||||
|
||||
pluginRegistry.register(new EarthquakePlugin());
|
||||
```
|
||||
|
||||
That's it. The plugin will appear in the Layer Panel and can be toggled on/off.
|
||||
|
||||
---
|
||||
|
||||
## WorldPlugin Interface Reference
|
||||
|
||||
### Required Properties
|
||||
|
||||
| Property | Type | Description |
|
||||
|---|---|---|
|
||||
| `id` | `string` | Unique identifier (e.g. `"aviation"`, `"earthquake"`) |
|
||||
| `name` | `string` | Display name shown in the Layer Panel |
|
||||
| `description` | `string` | Short description shown below the name |
|
||||
| `icon` | `string \| ComponentType` | Lucide icon component or emoji string |
|
||||
| `category` | `PluginCategory` | Grouping in the Layer Panel |
|
||||
| `version` | `string` | Semver version string |
|
||||
|
||||
**Available categories:** `aviation`, `maritime`, `conflict`, `natural-disaster`, `infrastructure`, `cyber`, `economic`, `custom`
|
||||
|
||||
### Required Methods
|
||||
|
||||
#### `initialize(ctx: PluginContext): Promise<void>`
|
||||
|
||||
Called once when the plugin is registered. Store the context for later use.
|
||||
|
||||
```typescript
|
||||
interface PluginContext {
|
||||
apiBaseUrl: string; // Base URL for API calls
|
||||
timeRange: TimeRange; // Current time window
|
||||
onDataUpdate: (entities: GeoEntity[]) => void; // Push data updates
|
||||
onError: (error: Error) => void; // Report errors
|
||||
}
|
||||
```
|
||||
|
||||
#### `destroy(): void`
|
||||
|
||||
Cleanup when the plugin is unregistered. Release any resources.
|
||||
|
||||
#### `fetch(timeRange: TimeRange): Promise<GeoEntity[]>`
|
||||
|
||||
Called by the polling system at your declared interval. Return an array of `GeoEntity` objects representing your data points.
|
||||
|
||||
#### `getPollingInterval(): number`
|
||||
|
||||
Return the polling interval in milliseconds. This determines how often `fetch()` is called.
|
||||
|
||||
#### `getLayerConfig(): LayerConfig`
|
||||
|
||||
Return the default layer configuration. These values are used to initialize the UI and the renderer:
|
||||
|
||||
```typescript
|
||||
interface LayerConfig {
|
||||
color: string; // Default CSS color for primary visualization
|
||||
iconUrl?: string; // Default icon for billboards (if applicable)
|
||||
clusterEnabled: boolean; // Enable spatial clustering at high zoom levels
|
||||
clusterDistance: number; // Cluster radius in pixels (suggested: 40)
|
||||
minZoomLevel?: number; // Hide entities when camera is too far (meters)
|
||||
maxEntities?: number; // Limit for performance safety
|
||||
showLabelsByDefault?: boolean; // If true, labels show without hover
|
||||
}
|
||||
```
|
||||
|
||||
#### `renderEntity(entity: GeoEntity): CesiumEntityOptions`
|
||||
|
||||
Called for each entity to determine how it appears on the globe:
|
||||
|
||||
```typescript
|
||||
interface CesiumEntityOptions {
|
||||
type: "billboard" | "point" | "polyline" | "polygon" | "label";
|
||||
color?: string; // CSS color string
|
||||
size?: number; // Pixel size (for points)
|
||||
iconUrl?: string; // Image URL (for billboards)
|
||||
rotation?: number; // Degrees, applied to billboards
|
||||
outlineColor?: string; // CSS color for point outlines
|
||||
outlineWidth?: number; // Outline width in pixels
|
||||
labelText?: string; // Text label above the entity
|
||||
labelFont?: string; // CSS font string for labels
|
||||
}
|
||||
```
|
||||
|
||||
### Optional Methods
|
||||
|
||||
#### `getSelectionBehavior(entity: GeoEntity): SelectionBehavior | null`
|
||||
|
||||
Return trail rendering and camera behavior when an entity is selected. Return `null` for default behavior.
|
||||
|
||||
```typescript
|
||||
interface SelectionBehavior {
|
||||
showTrail?: boolean; // Render a trail polyline
|
||||
trailDurationSec?: number; // Trail length in seconds (default: 60)
|
||||
trailStepSec?: number; // Trail point spacing (default: 5)
|
||||
trailColor?: string; // CSS color (default: '#00fff7')
|
||||
flyToOffsetMultiplier?: number; // Camera offset multiplier (default: 3)
|
||||
flyToBaseDistance?: number; // Base camera distance in meters (default: 30000)
|
||||
}
|
||||
```
|
||||
|
||||
**Example:** Show trails only for airborne entities:
|
||||
```typescript
|
||||
getSelectionBehavior(entity: GeoEntity): SelectionBehavior | null {
|
||||
if (entity.properties.on_ground) return null;
|
||||
return { showTrail: true, trailColor: "#00fff7" };
|
||||
}
|
||||
```
|
||||
|
||||
#### `getServerConfig(): ServerPluginConfig`
|
||||
|
||||
Declare your plugin's server-side data layer requirements:
|
||||
|
||||
```typescript
|
||||
interface ServerPluginConfig {
|
||||
apiBasePath: string; // e.g. "/api/aviation"
|
||||
pollingIntervalMs: number; // Server-side polling interval
|
||||
requiresAuth?: boolean; // OAuth/API key needed
|
||||
historyEnabled?: boolean; // Supports timeline playback
|
||||
availabilityEnabled?: boolean; // Reports time ranges
|
||||
}
|
||||
```
|
||||
|
||||
> **Note:** The current server infrastructure (API routes, background polling) is set up per-plugin in `src/app/api/<pluginId>/` and `src/lib/`. See [Server-Side Data Layer](#server-side-data-layer) for the pattern.
|
||||
|
||||
#### `getSidebarComponent(): ComponentType`
|
||||
|
||||
Return a React component to render in the sidebar when this plugin's layer is active.
|
||||
|
||||
#### `getDetailComponent(): ComponentType<{ entity: GeoEntity }>`
|
||||
|
||||
Return a React component to render in the detail panel when an entity from this plugin is selected.
|
||||
|
||||
---
|
||||
|
||||
## GeoEntity
|
||||
|
||||
The universal data model for all plugin entities:
|
||||
|
||||
```typescript
|
||||
interface GeoEntity {
|
||||
id: string; // Unique ID (prefix with pluginId)
|
||||
pluginId: string; // Must match your plugin's `id`
|
||||
latitude: number; // WGS84 latitude
|
||||
longitude: number; // WGS84 longitude
|
||||
altitude?: number; // Meters above sea level
|
||||
heading?: number; // Degrees (0 = North, 90 = East)
|
||||
speed?: number; // Meters per second
|
||||
timestamp: Date; // When this data was captured
|
||||
label?: string; // Short display label
|
||||
properties: Record<string, unknown>; // Plugin-specific data
|
||||
}
|
||||
```
|
||||
|
||||
**Conventions:**
|
||||
- **`id`** — Prefix with your plugin ID to avoid collisions: `"earthquake-us7000abc"`
|
||||
- **`heading` + `speed`** — If both are set, the renderer will extrapolate movement between polls (smooth animation)
|
||||
- **`properties`** — Use for domain-specific data (e.g. magnitude, vessel type, altitude). These are accessible in info cards and detail panels
|
||||
|
||||
---
|
||||
|
||||
## Core Services
|
||||
|
||||
### DataBus — Event Communication
|
||||
|
||||
Subscribe to cross-plugin events:
|
||||
|
||||
```typescript
|
||||
import { dataBus } from "@/core/data/DataBus";
|
||||
|
||||
// Available events
|
||||
dataBus.on("dataUpdated", ({ pluginId, entities }) => { ... });
|
||||
dataBus.on("entitySelected", ({ entity }) => { ... });
|
||||
dataBus.on("layerToggled", ({ pluginId, enabled }) => { ... });
|
||||
dataBus.on("timeRangeChanged", ({ timeRange }) => { ... });
|
||||
dataBus.on("cameraPreset", ({ presetId }) => { ... });
|
||||
```
|
||||
|
||||
### CacheLayer — Two-Tier Caching
|
||||
|
||||
The PluginManager automatically caches your `fetch()` results in:
|
||||
1. **Memory** — instant recall within the same session
|
||||
2. **IndexedDB** — survives page refreshes
|
||||
|
||||
You don't need to interact with the cache directly — it's managed by the PluginManager.
|
||||
|
||||
### PollingManager — Automatic Polling
|
||||
|
||||
Your `getPollingInterval()` return value is used to set up automatic polling. Features:
|
||||
- **Exponential backoff** on errors (up to 60s max)
|
||||
- **Pause/resume** support
|
||||
- **Dynamic interval updates** — users can adjust intervals in the Config Panel
|
||||
|
||||
---
|
||||
|
||||
## Server-Side Data Layer
|
||||
|
||||
For plugins that need server-side processing (API proxying, database persistence, authentication), follow this pattern:
|
||||
|
||||
### 1. Create an API Route
|
||||
|
||||
```
|
||||
src/app/api/<your-plugin>/route.ts
|
||||
```
|
||||
|
||||
```typescript
|
||||
import { NextResponse } from "next/server";
|
||||
|
||||
export async function GET() {
|
||||
// Fetch from your data source
|
||||
const res = await fetch("https://api.example.com/data", {
|
||||
headers: { "Authorization": `Bearer ${process.env.YOUR_API_KEY}` },
|
||||
cache: "no-store",
|
||||
});
|
||||
|
||||
if (!res.ok) {
|
||||
return NextResponse.json({ error: res.statusText }, { status: res.status });
|
||||
}
|
||||
|
||||
const data = await res.json();
|
||||
return NextResponse.json(data);
|
||||
}
|
||||
```
|
||||
|
||||
### 2. Optional: Background Polling
|
||||
|
||||
For APIs with rate limits, create a server-side polling module:
|
||||
|
||||
```
|
||||
src/lib/<your-plugin>-polling.ts
|
||||
```
|
||||
|
||||
Register it in `src/instrumentation.ts`:
|
||||
|
||||
```typescript
|
||||
export async function register() {
|
||||
if (process.env.NEXT_RUNTIME === "nodejs") {
|
||||
const { startYourPluginPolling } = await import("./lib/your-plugin-polling");
|
||||
startYourPluginPolling();
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 3. Optional: History Endpoint
|
||||
|
||||
For timeline/playback support, add a history route:
|
||||
|
||||
```
|
||||
src/app/api/<your-plugin>/history/route.ts
|
||||
```
|
||||
|
||||
Accept a `?time=<ms>` parameter and return the closest historical records.
|
||||
|
||||
### 4. Declare in Plugin
|
||||
|
||||
Use `getServerConfig()` to document your server-side setup:
|
||||
|
||||
```typescript
|
||||
getServerConfig(): ServerPluginConfig {
|
||||
return {
|
||||
apiBasePath: "/api/earthquake",
|
||||
pollingIntervalMs: 120000,
|
||||
historyEnabled: false,
|
||||
};
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Rendering Details
|
||||
|
||||
### Billboard vs Point
|
||||
|
||||
| Feature | `billboard` | `point` |
|
||||
|---|---|---|
|
||||
| Custom image | Yes via `iconUrl` | No |
|
||||
| Rotation | Yes via `rotation` | No |
|
||||
| Performance | Good (GPU batched) | Best (single draw call) |
|
||||
| Outline | No | Yes via `outlineColor/Width` |
|
||||
|
||||
**Use billboards** for entities with custom icons and rotation (aircraft, vehicles).
|
||||
**Use points** for simpler markers (fires, earthquakes, vessels).
|
||||
|
||||
### Labels
|
||||
|
||||
Labels are automatically hidden at long distances and shown within 500km or on hover/selection. Configure via `labelText` and `labelFont` in your `renderEntity()` return.
|
||||
|
||||
### Position Extrapolation
|
||||
|
||||
If your `GeoEntity` has both `heading` and `speed` set, the globe renderer will automatically extrapolate smooth movement between polling intervals (up to 5 minutes). This creates fluid animation without increasing your API call frequency.
|
||||
|
||||
---
|
||||
|
||||
## Existing Plugin Examples
|
||||
|
||||
| Plugin | Category | Data Source | Rendering | Selection |
|
||||
|---|---|---|---|---|
|
||||
| [Aviation](../src/plugins/aviation/index.ts) | `aviation` | OpenSky Network (live + Supabase fallback) | Billboards with altitude-based coloring | Trail polyline for airborne entities |
|
||||
| [Maritime](../src/plugins/maritime/index.ts) | `maritime` | AIS feeds (with demo fallback) | Points with vessel-type coloring | Default |
|
||||
| [Wildfire](../src/plugins/wildfire/index.ts) | `natural-disaster` | NASA FIRMS (VIIRS) | Points with FRP-based sizing/coloring | Default |
|
||||
|
||||
---
|
||||
|
||||
## Checklist: Publishing a Plugin
|
||||
|
||||
- [ ] Implements all required `WorldPlugin` methods
|
||||
- [ ] `id` is unique and lowercase (no spaces)
|
||||
- [ ] All `GeoEntity.id` values are prefixed with your plugin ID
|
||||
- [ ] `GeoEntity.pluginId` matches your plugin's `id`
|
||||
- [ ] `renderEntity()` returns valid `CesiumEntityOptions`
|
||||
- [ ] API route created (if needed) at `src/app/api/<id>/`
|
||||
- [ ] Plugin registered in the app initialization code
|
||||
- [ ] Tested: toggle on/off in Layer Panel
|
||||
- [ ] Tested: entity hover and click selection
|
||||
- [ ] Tested: info card displays your `properties` correctly
|
||||
@@ -1,75 +0,0 @@
|
||||
# Setup & Installation
|
||||
|
||||
Follow these steps to set up your development environment and get WorldWideView running locally.
|
||||
|
||||
## Requirements
|
||||
|
||||
- **Node.js**: v18.17 or higher (tested on v20+)
|
||||
- **pnpm**: v8 or higher (`npm install -g pnpm`)
|
||||
- **Browser**: Chrome, Firefox, or Edge (CesiumJS requires WebGL support)
|
||||
|
||||
## Environment Setup
|
||||
|
||||
Run the setup script to auto-generate `.env.local` with a secure `AUTH_SECRET`:
|
||||
|
||||
```bash
|
||||
pnpm run setup
|
||||
```
|
||||
|
||||
This copies `.env.example` → `.env.local` and fills in `AUTH_SECRET` automatically. You can then optionally add API keys for enhanced features (Cesium Ion, Bing Maps, OpenSky, etc.).
|
||||
|
||||
> [!NOTE]
|
||||
> `AUTH_SECRET` must remain stable across restarts. The setup script generates it once and writes it to `.env.local`. Never commit `.env.local` to git.
|
||||
|
||||
## Running Locally
|
||||
|
||||
1. **Install Dependencies**:
|
||||
```bash
|
||||
pnpm install
|
||||
```
|
||||
|
||||
2. **Generate environment file** (first time only):
|
||||
```bash
|
||||
pnpm run setup
|
||||
```
|
||||
|
||||
3. **Start Dev Server**:
|
||||
```bash
|
||||
pnpm run dev:all
|
||||
```
|
||||
|
||||
4. **Open Browser**:
|
||||
Navigate to [http://localhost:3000](http://localhost:3000).
|
||||
|
||||
## Folder Structure Explanation
|
||||
|
||||
Understanding the project layout:
|
||||
|
||||
```text
|
||||
worldwideview/
|
||||
├── docs/ # Project documentation
|
||||
├── packages/ # Plugin packages (pnpm workspaces)
|
||||
├── public/ # Static assets (GeoJSON data files, Cesium dependencies)
|
||||
├── scripts/ # Build and utility scripts (e.g., copy-cesium.mjs)
|
||||
└── src/
|
||||
├── app/ # Next.js App Router (Layouts, Pages, API Routes)
|
||||
├── components/ # React UI components (HUD, LayersPanel, Panels)
|
||||
├── core/ # Core engine logic
|
||||
│ ├── data/ # Data management (DataBus, Polling, Cache)
|
||||
│ ├── globe/ # Cesium-specific hooks and view logic
|
||||
│ └── plugins/ # Plugin system base and registry
|
||||
├── lib/ # Utility libraries and server-side logic
|
||||
└── plugins/ # Built-in plugins (Aviation, Maritime, etc.)
|
||||
```
|
||||
|
||||
## Verification
|
||||
|
||||
To verify your setup:
|
||||
1. Ensure the globe loads without errors in the console.
|
||||
2. Check if the "Aviation" layer is visible in the Layers Panel.
|
||||
3. Verify that the HUD (top bar) displays live camera coordinates.
|
||||
|
||||
---
|
||||
|
||||
> [!TIP]
|
||||
> The database is created automatically on first run — no manual setup is required. If you need to reset it, delete `data/wwv.db` and restart the dev server.
|
||||
@@ -1,48 +0,0 @@
|
||||
# User Guide
|
||||
|
||||
Welcome to WorldWideView! This guide will help you navigate the 3D globe and interact with live data layers.
|
||||
|
||||
## Navigating the Globe
|
||||
|
||||
- **Rotate**: Left-click and drag.
|
||||
- **Zoom**: Use the mouse wheel or pinch on a trackpad.
|
||||
- **Tilt/Rotate Perspective**: Right-click and drag (or use Ctrl + Left-click).
|
||||
- **Fly to Location**: Double-click on an entity or use the search bar (if available).
|
||||
|
||||
## Application Panels
|
||||
|
||||
### Layers Panel
|
||||
Located on the left side of the screen, the Layers Panel allows you to toggle different data sources on and off.
|
||||
- **Search Layers**: Filter the available plugins.
|
||||
- **Toggle Visibility**: Enable or disable specific data layers like Aviation, Maritime, or Wildfires.
|
||||
- **Layer Configuration**: Some layers provide settings like clustering or color customization.
|
||||
|
||||
### HUD (Heads-Up Display)
|
||||
The HUD at the top provides real-time information about your current view:
|
||||
- **Camera Coordinates**: Latitude, Longitude, and Altitude.
|
||||
- **Pitch & Heading**: Current orientation of the camera.
|
||||
- **FPS Indicator**: Performance metrics.
|
||||
|
||||
### Timeline
|
||||
The timeline at the bottom allows you to track data over time.
|
||||
- **Current Time**: Displays the simulated time on the globe.
|
||||
- **Playback Controls**: If supported by the plugin, you can scrubbing through historical data.
|
||||
|
||||
## Interacting with Entities
|
||||
|
||||
- **Hover**: Hover over a marker (point or billboard) to see a quick label.
|
||||
- **Selection**: Click on an entity to open its **Info Card**.
|
||||
- **Info Card**: Displays detailed properties about the selected object (e.g., flight number, vessel type, fire intensity).
|
||||
- **Trails**: Some entities (like aircraft) show a historical trail when selected.
|
||||
|
||||
## Settings & Configuration
|
||||
|
||||
You can access global settings through the **Config Panel**. Here you can:
|
||||
- Adjust the **Polling Interval** for data updates.
|
||||
- Toggle **Night Mode** or change the **Imagery Base Map** (e.g., Satellite, Terrain, Street).
|
||||
- Manage **Cache Settings** to clear offline data.
|
||||
|
||||
---
|
||||
|
||||
> [!TIP]
|
||||
> Use the **[Keyboard Shortcuts]** (coming soon) for faster navigation and panel toggling.
|
||||
+25
-13
@@ -1,20 +1,32 @@
|
||||
<!-- Generated: 2026-04-19 15:23:00 UTC -->
|
||||
<!-- Generated: 2026-04-23 06:11:00 UTC -->
|
||||
# Build System
|
||||
|
||||
WorldWideView operates using a strict `pnpm` monorepo workspace to manage the core Next.js application alongside its surrounding plugin ecosystem.
|
||||
## Overview
|
||||
WorldWideView uses a pnpm monorepo workspace for managing both the main application and its associated SDK and plugin packages. The primary build system relies on Next.js 16 with custom Webpack optimizations, specifically designed to output a standalone trace for highly efficient Docker containerization.
|
||||
|
||||
The build relies heavily on Next.js standalone output tracing optimization, allowing minimal-footprint Docker images via Multi-stage resolution.
|
||||
|
||||
## Key Files
|
||||
- `pnpm-workspace.yaml`: Governs the inclusion of `packages/*` elements.
|
||||
- `next.config.ts` (lines 10-45): Implements `output: "standalone"` and strict Content-Security-Policy headers.
|
||||
- `Dockerfile` (lines 1-110): Executes the multi-stage Extractor Pattern (`deps` → `builder` → `runner`).
|
||||
The core build configuration resides in `package.json` and `next.config.ts`. A custom standalone tracer strips unnecessary CLI dependencies (`prisma`, `dotenv`) from the final build to prevent fatal container runtime crashes.
|
||||
|
||||
## Build Workflows
|
||||
- **Dependency Install:** `pnpm install` must be run from the root directory to respect strict workspace hoisting natively.
|
||||
- **Development Proxy:** `pnpm dev` triggers the frontend server locally with active HMR, while executing pre-build scripts like `copy-cesium.mjs`.
|
||||
- **Plugin Compilation:** Run `pnpm -r build` inside `packages/worldwideview-plugins/` to trigger Vite bundle execution mapped to `dist/frontend.mjs`.
|
||||
|
||||
### Standard Development
|
||||
- **Install Dependencies:** `pnpm install` (Installs all workspace packages defined in `pnpm-workspace.yaml`).
|
||||
- **Initial Setup:** `pnpm run setup` (Executes `scripts/setup.mjs` to generate a `.env.local` with a fresh `AUTH_SECRET`).
|
||||
- **Run Development Server (All):** `pnpm dev:all` (Concurrently starts the Next.js frontend and the local `wwv-data-engine` backends).
|
||||
|
||||
### Production Build
|
||||
- **Build Command:** `pnpm build` (Executes `next build --webpack`).
|
||||
- **Output:** Generates a `.next/standalone/` folder ready for execution.
|
||||
- **Static Assets:** `scripts/copy-cesium.mjs` is executed during `predev` and `build` to copy pre-compiled CesiumJS static assets into the `public/cesium/` directory, keeping them out of the output tracer.
|
||||
|
||||
## Platform Setup
|
||||
- **Cesium Resources:** Required assets (Workers, Assets, Widgets) are structurally bound into the `public/cesium/` folder during the pre-build pipeline initialized by `scripts/copy-cesium.mjs` (lines 10-38).
|
||||
- **SQLite Engine:** `prisma.config.ts` must export native javascript objects (free of dev CLI wrappers) for Next.js to trace correctly in the final standalone Node build.
|
||||
|
||||
- **Database Migrations:** Prisma schema is located at `prisma/schema.prisma`. During development, `pnpm dev` triggers a `predev` hook running `npx prisma migrate deploy` to ensure SQLite tables exist in `data/wwv.db`.
|
||||
- **Microservices:** Data engine seeders and standalone Fastify backend plugins (like `wwv-plugin-iranwarlive/backend`) are started via `pnpm start:backends` and managed locally inside `packages/*/backend`.
|
||||
- **Plugin Packages:** Internal plugin packages must be properly listed in `tsconfig.json` paths and `next.config.ts`'s `transpilePackages` array.
|
||||
|
||||
## Reference
|
||||
|
||||
- **Monorepo Config:** `pnpm-workspace.yaml` - defines package locations (`packages/*` and `packages/*/backend`).
|
||||
- **Next Config:** `next.config.ts` - controls the standalone output, `transpilePackages`, and restrictive security headers.
|
||||
- **Prisma Config:** `prisma.config.ts` - Native JavaScript object export used to bypass Next.js tracer issues with dynamic imports.
|
||||
- **Cesium Script:** `scripts/copy-cesium.mjs` - Handles static asset injection.
|
||||
@@ -1,344 +0,0 @@
|
||||
# Creating a WorldWideView Plugin
|
||||
|
||||
This guide walks you through building, publishing, and listing your own WorldWideView plugin from scratch.
|
||||
|
||||
---
|
||||
|
||||
## Overview
|
||||
|
||||
WorldWideView plugins display geospatial data on a 3D Cesium globe. Every plugin must implement the `WorldPlugin` interface from the **Plugin SDK** (`@worldwideview/wwv-plugin-sdk`).
|
||||
|
||||
There are **three plugin formats**:
|
||||
|
||||
| Format | Use Case | Example |
|
||||
|---|---|---|
|
||||
| **`static`** | GeoJSON file loaded at startup — no API calls at runtime | Military Bases, Nuclear Facilities, Embassies |
|
||||
| **`bundle`** | Full TypeScript class with custom logic, live API data, UI components | Aviation, Maritime, Wildfire |
|
||||
| **`declarative`** | JSON-only manifest that points to an external API — no code needed | *(Future)* |
|
||||
|
||||
---
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- Node.js ≥ 18
|
||||
- An NPM account (for publishing)
|
||||
- A running WorldWideView instance (local clone or Docker container)
|
||||
|
||||
---
|
||||
|
||||
## Step 1 — Scaffold Your Plugin
|
||||
|
||||
WorldWideView plugins are strictly decoupled from the core application. You do **not** build them inside the WorldWideView monorepo. Instead, use the official CLI tool:
|
||||
|
||||
```bash
|
||||
npx @worldwideview/create-plugin@latest my-data-layer
|
||||
cd my-data-layer
|
||||
npm install
|
||||
```
|
||||
|
||||
This will generate a ready-to-use template including your `package.json`, `plugin.json`, and Vite build configuration.
|
||||
|
||||
### Linking During Development
|
||||
|
||||
To see your plugin live on the globe while you develop:
|
||||
|
||||
1. Configure your CLI to point to your running WorldWideView instance:
|
||||
```bash
|
||||
npx wwv config set wwv-path C:\path\to\your\worldwideview
|
||||
```
|
||||
2. Link the plugin:
|
||||
```bash
|
||||
npm run link
|
||||
```
|
||||
3. Run the dev watcher to rebuild on save:
|
||||
```bash
|
||||
npm run dev
|
||||
```
|
||||
|
||||
*Note: If you are running WorldWideView via Docker, ensure `WWV_PLUGIN_DEV=true` is set in your environment variables and mount your plugin's `dist/` folder into the container's `/app/plugins-local/` directory.*
|
||||
|
||||
> [!IMPORTANT]
|
||||
> The `worldwideview` object block inside your `package.json` is strictly required for the CLI link command and if you intend to publish your plugin to the WorldWideView Marketplace. The marketplace uses this internal manifest to determine how to categorize and display your plugin automatically.
|
||||
> * `id`: The unique string identifier.
|
||||
|
||||
> [!IMPORTANT]
|
||||
> The SDK is declared as a **peer dependency**, not a direct dependency. The host application provides it at runtime.
|
||||
|
||||
---
|
||||
|
||||
## Step 2 — Write Your Plugin Code
|
||||
|
||||
Create `src/index.ts`. Here are examples for the two most common formats:
|
||||
|
||||
### Option A — Static GeoJSON Plugin (simplest)
|
||||
|
||||
For static plugins, the npm package is just metadata. The actual loading is handled by the `StaticDataPlugin` loader at runtime, driven by a manifest + GeoJSON file.
|
||||
|
||||
```typescript
|
||||
/**
|
||||
* @worldwideview/wwv-plugin-my-data
|
||||
*
|
||||
* Static GeoJSON plugin — my custom dataset.
|
||||
*
|
||||
* This package exists for npm registry metadata. The actual plugin logic
|
||||
* is handled by WorldWideView's StaticDataPlugin loader at runtime using
|
||||
* the manifest + GeoJSON data file served from the host application.
|
||||
*/
|
||||
export const PLUGIN_ID = "my-data" as const;
|
||||
```
|
||||
|
||||
For static plugins you also need:
|
||||
1. A **GeoJSON file** placed at `public/data/my_data.geojson` in the main app
|
||||
2. A **manifest entry** in the marketplace (see Step 4)
|
||||
|
||||
### Option B — Bundle Plugin (full control)
|
||||
|
||||
For bundle plugins, you write a class that implements the `WorldPlugin` interface:
|
||||
|
||||
```typescript
|
||||
import type {
|
||||
WorldPlugin,
|
||||
GeoEntity,
|
||||
TimeRange,
|
||||
PluginContext,
|
||||
LayerConfig,
|
||||
CesiumEntityOptions,
|
||||
} from "@worldwideview/wwv-plugin-sdk";
|
||||
|
||||
export class MyDataPlugin implements WorldPlugin {
|
||||
// ─── Required Metadata ──────────────────────────────
|
||||
id = "my-data";
|
||||
name = "My Data Layer";
|
||||
description = "Displays custom points on the globe.";
|
||||
icon = "MapPin"; // Lucide icon name (string)
|
||||
category = "custom" as const;
|
||||
version = "1.0.0";
|
||||
|
||||
// ─── Lifecycle ──────────────────────────────────────
|
||||
async initialize(ctx: PluginContext): Promise<void> {
|
||||
// Called once when the plugin is loaded.
|
||||
// Use ctx.apiBaseUrl, ctx.timeRange, ctx.onDataUpdate, etc.
|
||||
}
|
||||
|
||||
destroy(): void {
|
||||
// Called when the plugin is unloaded. Clean up timers, sockets, etc.
|
||||
}
|
||||
|
||||
// ─── Data ───────────────────────────────────────────
|
||||
async fetch(timeRange: TimeRange): Promise<GeoEntity[]> {
|
||||
// Fetch your data from an API and return GeoEntity objects.
|
||||
const res = await fetch("https://api.example.com/points");
|
||||
const data = await res.json();
|
||||
|
||||
return data.map((item: any) => ({
|
||||
id: String(item.id),
|
||||
pluginId: this.id,
|
||||
latitude: item.lat,
|
||||
longitude: item.lon,
|
||||
altitude: 0,
|
||||
timestamp: new Date(),
|
||||
label: item.name,
|
||||
properties: { type: item.type },
|
||||
}));
|
||||
}
|
||||
|
||||
getPollingInterval(): number {
|
||||
return 60_000; // Re-fetch every 60 seconds
|
||||
}
|
||||
|
||||
// ─── Rendering ──────────────────────────────────────
|
||||
getLayerConfig(): LayerConfig {
|
||||
return {
|
||||
color: "#3b82f6",
|
||||
clusterEnabled: true,
|
||||
clusterDistance: 40,
|
||||
maxEntities: 5000,
|
||||
};
|
||||
}
|
||||
|
||||
renderEntity(entity: GeoEntity): CesiumEntityOptions {
|
||||
return {
|
||||
type: "point",
|
||||
color: "#3b82f6",
|
||||
size: 8,
|
||||
};
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Step 3 — Publish to npm
|
||||
|
||||
```bash
|
||||
cd packages/wwv-plugin-my-data
|
||||
pnpm publish --access public
|
||||
```
|
||||
|
||||
> [!NOTE]
|
||||
> The marketplace pulls metadata (version, description, keywords, readme) directly from the npm registry. You do not need to duplicate this information anywhere else.
|
||||
|
||||
---
|
||||
|
||||
## Step 4 — Submit to the Marketplace
|
||||
|
||||
Once your package is published to npm, submit it for listing in the WorldWideView Marketplace:
|
||||
|
||||
1. Go to [marketplace.worldwideview.dev/submit](https://marketplace.worldwideview.dev/submit) (or open the Admin UI on a local marketplace instance)
|
||||
2. Enter your **npm package name** (e.g. `@worldwideview/wwv-plugin-my-data`)
|
||||
3. The marketplace automatically fetches your metadata from npm and reads the `"worldwideview"` block from your `package.json`
|
||||
4. Your plugin enters a **pending** state for review
|
||||
5. Once approved, it appears in the browse catalog
|
||||
|
||||
> [!IMPORTANT]
|
||||
> The `"worldwideview"` block in your `package.json` is required for submission. Make sure `id`, `icon`, `category`, and `format` are correctly set before publishing.
|
||||
|
||||
### For static format plugins
|
||||
|
||||
If your plugin uses `"format": "static"`, your **GeoJSON file** must be hosted and accessible at a public URL, or included in the `public/data/` folder of the host WorldWideView application. The `dataFile` path in your manifest should point to that URL.
|
||||
|
||||
If you are contributing a plugin for inclusion in the official WorldWideView release, place the GeoJSON at `public/data/<name>.geojson` and open a pull request.
|
||||
|
||||
---
|
||||
|
||||
## Step 5 — Test Locally
|
||||
|
||||
1. Start all WorldWideView services: `pnpm run dev:all` (in the monorepo root)
|
||||
2. (Wait for both the main app and marketplace to start)
|
||||
3. Open the marketplace at `http://localhost:3001/browse`
|
||||
4. Find your plugin and click **Install**
|
||||
5. Verify the data appears on the globe at `http://localhost:3000`
|
||||
|
||||
---
|
||||
|
||||
## SDK Interface Reference
|
||||
|
||||
The `WorldPlugin` interface requires these properties and methods:
|
||||
|
||||
### Required Properties
|
||||
|
||||
| Property | Type | Description |
|
||||
|---|---|---|
|
||||
| `id` | `string` | Unique plugin identifier (e.g., `"my-data"`) |
|
||||
| `name` | `string` | Display name shown in the sidebar |
|
||||
| `description` | `string` | Short description |
|
||||
| `icon` | `string \| ComponentType` | Lucide icon name or React component |
|
||||
| `category` | `PluginCategory` | One of: `aviation`, `maritime`, `conflict`, `natural-disaster`, `infrastructure`, `cyber`, `economic`, `custom` |
|
||||
| `version` | `string` | Semver version string |
|
||||
|
||||
### Required Methods
|
||||
|
||||
| Method | Returns | Description |
|
||||
|---|---|---|
|
||||
| `initialize(ctx)` | `Promise<void>` | Set up the plugin. Receives `PluginContext` with API URLs, time range, callbacks |
|
||||
| `destroy()` | `void` | Clean up resources (timers, sockets, etc.) |
|
||||
| `fetch(timeRange)` | `Promise<GeoEntity[]>` | Return the data to display on the globe |
|
||||
| `getPollingInterval()` | `number` | Milliseconds between `fetch()` calls |
|
||||
| `getLayerConfig()` | `LayerConfig` | Layer appearance (color, clustering, limits) |
|
||||
| `renderEntity(entity)` | `CesiumEntityOptions` | How each entity renders on the globe |
|
||||
|
||||
### Optional Methods
|
||||
|
||||
| Method | Returns | Description |
|
||||
|---|---|---|
|
||||
| `getSelectionBehavior(entity)` | `SelectionBehavior \| null` | Trail / fly-to on click |
|
||||
| `getServerConfig()` | `ServerPluginConfig` | Server-side API routing |
|
||||
| `getFilterDefinitions()` | `FilterDefinition[]` | Declarative filter UI |
|
||||
| `getSidebarComponent()` | `ComponentType` | Custom sidebar panel |
|
||||
| `getDetailComponent()` | `ComponentType<{ entity }>` | Custom detail panel |
|
||||
| `getSettingsComponent()` | `ComponentType<{ pluginId }>` | Custom settings panel |
|
||||
|
||||
### Key Types
|
||||
|
||||
```typescript
|
||||
interface GeoEntity {
|
||||
id: string;
|
||||
pluginId: string;
|
||||
latitude: number;
|
||||
longitude: number;
|
||||
altitude?: number;
|
||||
heading?: number;
|
||||
speed?: number;
|
||||
timestamp: Date;
|
||||
label?: string;
|
||||
properties: Record<string, unknown>;
|
||||
}
|
||||
|
||||
interface LayerConfig {
|
||||
color: string;
|
||||
iconUrl?: string;
|
||||
clusterEnabled: boolean;
|
||||
clusterDistance: number;
|
||||
minZoomLevel?: number;
|
||||
maxEntities?: number;
|
||||
}
|
||||
|
||||
interface CesiumEntityOptions {
|
||||
type: "billboard" | "point" | "polyline" | "polygon" | "label" | "model";
|
||||
color?: string;
|
||||
size?: number;
|
||||
iconUrl?: string;
|
||||
rotation?: number;
|
||||
modelUrl?: string;
|
||||
modelScale?: number;
|
||||
// ... more options
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Real Examples
|
||||
|
||||
### Borders Plugin (bundle format)
|
||||
|
||||
A minimal bundle plugin that implements the `WorldPlugin` interface directly:
|
||||
|
||||
- **Source**: `packages/wwv-plugin-borders/src/index.ts`
|
||||
- **npm**: `@worldwideview/wwv-plugin-borders`
|
||||
|
||||
### Military Bases Plugin (static format)
|
||||
|
||||
A static GeoJSON plugin where the npm package is just metadata:
|
||||
|
||||
- **Source**: `packages/wwv-plugin-military-bases/src/index.ts`
|
||||
- **GeoJSON**: `public/data/military_bases.geojson`
|
||||
- **npm**: `@worldwideview/wwv-plugin-military-bases`
|
||||
- **Manifest**: Defined in `worldwideview-marketplace/src/data/pluginManifests.ts`
|
||||
|
||||
---
|
||||
|
||||
## How It All Connects
|
||||
|
||||
```
|
||||
Developer writes plugin
|
||||
│
|
||||
▼
|
||||
Publish to npm ► npm registry (stores version, description, keywords, readme)
|
||||
│
|
||||
▼
|
||||
Submit npm package name to Marketplace
|
||||
│
|
||||
▼
|
||||
Marketplace fetches metadata from npm ← npm registry
|
||||
and reads the "worldwideview" block from package.json
|
||||
│
|
||||
▼
|
||||
Review → Plugin appears in browse catalog
|
||||
│
|
||||
▼
|
||||
User clicks "Install"
|
||||
│
|
||||
▼
|
||||
Marketplace sends manifest to WorldWideView instance
|
||||
│
|
||||
▼
|
||||
Plugin saved to database (Prisma) → loaded on next startup
|
||||
│
|
||||
▼
|
||||
loadPluginFromManifest() routes by format:
|
||||
static → StaticDataPlugin (GeoJSON loader)
|
||||
bundle → dynamic import()
|
||||
│
|
||||
▼
|
||||
Plugin renders on the 3D globe
|
||||
```
|
||||
+26
-10
@@ -1,18 +1,34 @@
|
||||
<!-- Generated: 2026-04-19 15:23:00 UTC -->
|
||||
<!-- Generated: 2026-04-23 06:11:00 UTC -->
|
||||
# Deployment
|
||||
|
||||
WorldWideView is container-first. The codebase relies entirely on Dockerizing the Next.js `output: "standalone"` artifact and its localized Prisma SQLite core to enable horizontal orchestration.
|
||||
|
||||
Deployments are coordinated directly via Coolify natively compiling the Docker configurations.
|
||||
## Overview
|
||||
WorldWideView utilizes a containerized deployment strategy based on Docker's multi-stage builds. To minimize the footprint of the Next.js runtime, it leverages the Next.js `standalone` output trace, effectively dropping unnecessary development dependencies and generating a highly optimized Node.js artifact.
|
||||
|
||||
## Package Types
|
||||
- **Next.js Core Bundle:** Built directly via `pnpm build`, extracting into `<root>/.next/standalone`.
|
||||
- **Plugin Microservices:** Hosted alongside the Next.js router natively using Fastify images (defined in `docker-compose.yml`), enabling real-time Python/Node scraping backends exclusively connected via docker network aliases.
|
||||
- **CDN ESM Bundles:** Independent frontend plugins run via Vite rollup configurations (`vite.config.ts`), generating `dist/frontend.mjs` payloads published to the public NPM registry.
|
||||
|
||||
### Main Application
|
||||
- **Build Output:** Located at `.next/standalone/`.
|
||||
- **Static Assets:** Cesium static workers are injected at build time via `scripts/copy-cesium.mjs`.
|
||||
|
||||
### Plugin Microservices
|
||||
- Standalone plugin backends (e.g., `wwv-plugin-iranwarlive/backend`) are isolated via individual `Dockerfile` configurations and orchestrated together in production using `docker-compose.yml`.
|
||||
|
||||
## Platform Deployment
|
||||
- **Dockerfile:** `Dockerfile` explicitly targets `node:22-alpine` instances to restrict vulnerability surface areas while mapping the necessary system volume at `/app/data` to capture the `wwv.db` SQLite instantiation safely out-of-container (lines 80-112).
|
||||
- **Environment Hydration:** Coolify directly passes the active environment headers `.env` values at runtime, utilizing `.env.local` natively for credentials like `AUTH_SECRET` and `DATABASE_URL`.
|
||||
|
||||
### Coolify Integration
|
||||
WorldWideView deploys optimally to Coolify using a Dockerfile builder.
|
||||
- **Environment Variables:** Must be explicitly mapped in the Coolify UI (e.g., `DATABASE_URL`, `AUTH_SECRET`).
|
||||
- **Persistent Storage:** SQLite requires a persistent volume mounted to `/app/data` to ensure the frontend registry (installed plugins, user configs) survives container rebuilds.
|
||||
- **Microservices Deployment:** The `wwv-data-engine-internal` and associated plugin seeders are deployed as separate Coolify services communicating over private internal networks.
|
||||
|
||||
### Docker Structure
|
||||
- **Dockerfile:** Found at the project root (`Dockerfile`). Uses an Extractor Pattern (`deps` → `builder` → `runner`). The `.git` and `node_modules` folders must be explicitly untracked to prevent cache overlap.
|
||||
- **Compose:** Local multi-container emulation is handled via `docker-compose.yml`.
|
||||
|
||||
## Reference
|
||||
The core production mapping operates cleanly off HTTP port `3000`. Refer to `next.config.ts` (lines 5-15) for strict caching strategies utilized globally across deployments.
|
||||
- **Standalone Config:** `next.config.ts` (sets `output: "standalone"`).
|
||||
- **Prisma Export:** `prisma.config.ts` ensures no CLI wrappers are invoked inside the standalone container, preventing fatal `MODULE_NOT_FOUND` runtime crashes.
|
||||
- **Docker Mounts:**
|
||||
- Main App: `/app/data` (SQLite DB)
|
||||
- Data Engine: `/app/packages/wwv-data-engine/data` (SQLite DB)
|
||||
- Cache: `/data` (Redis)
|
||||
+61
-14
@@ -1,26 +1,73 @@
|
||||
<!-- Generated: 2026-04-19 15:23:00 UTC -->
|
||||
<!-- Generated: 2026-04-23 06:11:00 UTC -->
|
||||
# Development
|
||||
|
||||
Development on WorldWideView leverages modern, rigid structural constraints to ensure cross-plugin consistency, extreme browser optimization, and a minimal global footprint.
|
||||
|
||||
New features are designed within isolated workspaces, using SDK structures rather than forcing logic into the core engine.
|
||||
## Overview
|
||||
Development on WorldWideView prioritizes modularity, high performance, and strict architectural boundaries between the UI and the 3D rendering context. We adhere to rigorous file size constraints and rely heavily on Vanilla CSS and Zustand slice-patterns to maintain clarity across the large ecosystem.
|
||||
|
||||
## Code Style
|
||||
- **TypeScript Strictness:** Strict types are enforced across all domains (`tsconfig.json` lines 4-20). Any use of `any` inside platform routers is forbidden.
|
||||
- **Styling constraints:** All CSS is strictly limited to Vanilla CSS via CSS Modules (`.module.css`). Tailwind is prohibited to prevent styling collisions natively with dynamically loaded elements from third-party plugins. (`src/app/globals.css`).
|
||||
|
||||
### File Size Limits
|
||||
- **Max 150 lines per file.** If a component or function grows beyond this, you must modularize it. Extract helper functions, split React components, and utilize custom hooks.
|
||||
|
||||
### Styling Conventions
|
||||
- **Vanilla CSS Only:** Do not use Tailwind CSS or CSS-in-JS.
|
||||
- **Global Styles:** Located at `src/app/globals.css`.
|
||||
- **Component Styles:** Use CSS Modules (`.module.css`) or co-locate `.css` files directly next to their components.
|
||||
- **HUD Animations:** Specialized interface animations are stored in `src/styles/hud-animations.css`.
|
||||
|
||||
### Import Aliases
|
||||
- Application core: `@/*` → `./src/*`
|
||||
- Plugin SDK: `@worldwideview/wwv-plugin-sdk` → `./packages/wwv-plugin-sdk/src`
|
||||
- Custom plugins use their respective names configured in `tsconfig.json`.
|
||||
|
||||
## Common Patterns
|
||||
- **Env Variable Injection:** Plugins read remote contexts generically instantiated via the SDK.
|
||||
|
||||
### Entity Rendering
|
||||
When translating raw plugin data into `CesiumEntityOptions` inside `renderEntity()`, follow these strict graphical rules:
|
||||
```typescript
|
||||
// From wwv-plugin-aviation/src/index.ts:60-70
|
||||
let engineBase = this.context?.env?.DATA_ENGINE_URL || "https://dataengine.worldwideview.dev";
|
||||
// Correct Point Pattern
|
||||
renderEntity(entity: GeoEntity): CesiumEntityOptions {
|
||||
return {
|
||||
type: "point",
|
||||
color: "#ff0000",
|
||||
size: 10,
|
||||
outlineColor: "#ffffff",
|
||||
outlineWidth: 2
|
||||
};
|
||||
}
|
||||
|
||||
// Correct Billboard Pattern
|
||||
renderEntity(entity: GeoEntity): CesiumEntityOptions {
|
||||
return {
|
||||
type: "billboard",
|
||||
color: "#ffffff",
|
||||
iconUrl: "/icons/aircraft.png",
|
||||
iconScale: 0.5
|
||||
};
|
||||
}
|
||||
```
|
||||
> [!WARNING]
|
||||
> **NEVER MIX PROPERTIES:** Do not apply `size`, `outlineWidth`, or `outlineColor` to a `billboard` entity. Mixing these parameters causes severe GPU clipping and rendering artifacts in Cesium.
|
||||
|
||||
### State Access
|
||||
Zustand is divided into slices. For performance, components must select exactly the properties they need to avoid over-rendering:
|
||||
```typescript
|
||||
// From src/components/panels/LayerPanel.tsx
|
||||
const activeLayers = useStore((state) => state.layers.active);
|
||||
const toggleLayer = useStore((state) => state.layers.toggle);
|
||||
```
|
||||
- **Zustand Slices:** The store is heavily splintered based on structural domain, keeping the hook listeners granular so mapping updates don't aggressively trigger `AppShell` root rerenders. (`src/core/state/globeSlice.ts`).
|
||||
|
||||
## Workflows
|
||||
- **Local Database Setup:** Run `pnpm db:reset` to nuke and redeploy the standard Prisma schema across `data/wwv.db`.
|
||||
- **Generating Plugins:** Use the global CLI `npx @worldwideview/create-plugin@latest <name>` to initialize a decoupled plugin outside of the monorepo.
|
||||
- **Linking Plugins:** Use `npm run link` in the plugin directory after setting `npx wwv config set wwv-path <path>`.
|
||||
|
||||
### Debugging & Temporary Scripts
|
||||
Whenever generating temporary debugging scripts, testing REST endpoints via `.mjs`, or dumping traces/JSON outputs, **save these exclusively inside `/local-scripts/`**.
|
||||
- *Reference:* The root directory is strictly for production configuration files.
|
||||
|
||||
### Scaffold a New Component
|
||||
1. Create a new directory under `src/components/{category}/MyComponent`.
|
||||
2. Add `MyComponent.tsx` and `MyComponent.module.css`.
|
||||
3. Export from a local `index.ts` if creating a composite view.
|
||||
|
||||
## Reference
|
||||
File size is constrained to a 150-line soft cap. Hooks and computational math helpers must be rigorously offloaded (e.g. `src/core/globe/hooks/useModelRendering.ts`).
|
||||
- **Core Abstractions:** See `packages/wwv-plugin-sdk/src/PluginTypes.ts` for interface expectations.
|
||||
- **State Slices:** Located in `src/core/state/` (e.g., `globeSlice.ts`, `dataSlice.ts`).
|
||||
+22
-14
@@ -1,25 +1,33 @@
|
||||
<!-- Generated: 2026-04-19 15:23:00 UTC -->
|
||||
<!-- Generated: 2026-04-23 06:11:00 UTC -->
|
||||
# Files Catalog
|
||||
|
||||
WorldWideView maps rigid structural directories to manage its layered microservice architecture, distinguishing tightly between UI layout routing, system memory, 3D visualization, and microservice ingestion mechanisms.
|
||||
## Overview
|
||||
WorldWideView is structured as a pnpm monorepo. The primary application resides in the root `src/` directory, while external dependencies, plugins, and the core Plugin SDK are abstracted into the `packages/` directory.
|
||||
|
||||
Every major component is siloed deeply to ensure the monolithic main engine remains perfectly isolated and agnostic to individual data sources.
|
||||
The system is highly modularized to separate React UI rendering from heavy CesiumJS 3D operations and high-frequency real-time WebSocket state management.
|
||||
|
||||
## Core Source Files
|
||||
- `src/app/` - The Next.js 16 core routing platform, housing layout constraints, `api/` backends, and full-screen auth portals.
|
||||
- `src/components/` - Segmented React JSX components handling overlay panels, timeline UI, and floating popups.
|
||||
- `src/core/plugins/` - Essential bridge scripts that validate manifested metadata parameters before dynamically allocating JS module environments to run external logic. (`PluginManager.ts`)
|
||||
- `src/app/` - The Next.js App Router entry points. Contains `layout.tsx` (the core React shell), `page.tsx` (the globe view), and `/api/` (server-side NextAuth and API handlers).
|
||||
- `src/core/plugins/PluginManager.ts` - Central orchestration unit for dynamic plugins. Handles loading, lifecycle (`initialize`, `destroy`), and manifest resolution.
|
||||
- `src/core/globe/GlobeView.tsx` - The primary CesiumJS container. It memoizes Zustand state to prevent heavy re-renders while injecting `EntityRenderer` primitives.
|
||||
- `src/core/data/DataBus.ts` - Singleton pub/sub event bus handling all high-velocity WebSocket stream events without triggering React re-renders.
|
||||
- `src/core/state/store.ts` - The primary Zustand state registry exporting all nine discrete slices (`globe`, `layers`, `timeline`, `ui`, `filter`, `data`, `config`, `favorites`, `geojson`).
|
||||
|
||||
## Platform Implementation
|
||||
- `src/core/globe/GlobeView.tsx` - Initializer mapping global config hooks to the main Cesium `Viewer`.
|
||||
- `src/core/globe/EntityRenderer.tsx` - Extremely hot processing loop extracting Zustand state variables directly to WebGL GPU hardware calls via Cesium Primitives.
|
||||
- `src/core/globe/StackManager.ts` - Spiderifier spatial engine dynamically resolving overlapping coordinate markers geometrically in 3D-space.
|
||||
- `src/core/plugins/loaders/InstalledPluginsLoader.ts` - Platform-specific loader that dynamically injects ES module CDNs via `import(/* webpackIgnore: true */)`.
|
||||
- `src/core/globe/hooks/useCameraActions.ts` - Abstraction connecting React UI logic to raw CesiumJS camera math (flyTo, lookAt).
|
||||
- `src/lib/edition.ts` - Platform edition configuration. Exposes runtime feature flags for `local`, `cloud`, and `demo` deployments.
|
||||
|
||||
## Build System
|
||||
- `Dockerfile` - Multi-stage container instructions targeting a 110MB production Alpine build footprint.
|
||||
- `next.config.ts` - NextJS 16 overrides forcing standalone rendering extraction and tight CSP headers.
|
||||
- `prisma/schema.prisma` - DB tables strictly configuring Prisma to bind exclusively towards locally-mounted SQLite structures.
|
||||
- `package.json` - Root monorepo configuration with `pnpm` workspace bindings.
|
||||
- `next.config.ts` - Next.js compiler settings, security headers, and standalone output configuration.
|
||||
- `docker-compose.yml` - Defines the orchestration of the frontend, Redis cache, and all local plugin microservice backends (`wwv-data-engine`).
|
||||
|
||||
## Configuration
|
||||
- `.agents/` - Complete repository workflow configuration (Antigravity Code). Contains AI `rules/`, `skills/`, and internal architectural `context/` for automatic coordination.
|
||||
- `public/cesium/` - Runtime engine bundles duplicated exclusively during pre-build tracking (copied from `node_modules`).
|
||||
- `prisma/schema.prisma` - Local SQLite and cloud PostgreSQL database schema for storing user settings and installed plugin manifests.
|
||||
- `scripts/copy-cesium.mjs` - Crucial build-time script that extracts and copies CesiumJS static web workers to `public/cesium/`.
|
||||
- `public/` - Static assets, plugin icons, and compiled Cesium workers.
|
||||
|
||||
## Reference
|
||||
- **Plugins Directory:** All plugins conform to the `@worldwideview/wwv-plugin-sdk` interface and are developed inside `packages/wwv-plugin-<name>/`.
|
||||
- **Microservices Directory:** Standalone Fastify backends are nested within `packages/wwv-plugin-<name>/backend/`.
|
||||
@@ -0,0 +1,328 @@
|
||||
<!-- Generated: 2026-04-23 20:29:00 UTC -->
|
||||
# End-to-End Tutorial: Building a Real-Time ISS Tracking Plugin
|
||||
|
||||
Welcome! This tutorial is designed for complete beginners. If you have never built a WorldWideView plugin before, you are in the right place.
|
||||
|
||||
By following these steps exactly, you will build a complete, real-time International Space Station (ISS) tracker from scratch. You will learn how to set up your environment, stream live data using a backend seeder, render it in 3D on the globe, and publish your work to the world.
|
||||
|
||||
Let's get started.
|
||||
|
||||
---
|
||||
|
||||
## Step 1: Setting up your Workspace
|
||||
|
||||
Before we write any code, we need to prepare your computer. We will install the required tools and download the two main repositories that make up the WorldWideView platform.
|
||||
|
||||
### 1.1 Install Prerequisites
|
||||
|
||||
Ensure you have the following installed on your machine:
|
||||
1. **Node.js**: Download and install [Node.js](https://nodejs.org/) (Version 18 or higher is required).
|
||||
2. **Git**: Download and install [Git](https://git-scm.com/).
|
||||
3. **pnpm**: This is the package manager we use. Open your terminal and run:
|
||||
```bash
|
||||
npm install -g pnpm
|
||||
```
|
||||
|
||||
### 1.2 Clone the Repositories
|
||||
|
||||
You need both the frontend application and the backend data engine. Open your terminal and navigate to the folder where you want to store your code (e.g., `C:\dev`).
|
||||
|
||||
Run these commands to download the code:
|
||||
```bash
|
||||
git clone https://github.com/silvertakana/worldwideview.git
|
||||
git clone https://github.com/silvertakana/wwv-data-engine.git
|
||||
```
|
||||
|
||||
### 1.3 Install Dependencies
|
||||
|
||||
Next, we need to install the libraries that these projects depend on.
|
||||
|
||||
First, install dependencies for the Data Engine:
|
||||
```bash
|
||||
cd wwv-data-engine
|
||||
pnpm install
|
||||
```
|
||||
|
||||
Second, install dependencies for the main WorldWideView application:
|
||||
```bash
|
||||
cd ../worldwideview
|
||||
pnpm install
|
||||
```
|
||||
|
||||
### 1.4 Setup Environment Variables
|
||||
|
||||
WorldWideView needs a few basic configuration keys to run.
|
||||
|
||||
While still in the `worldwideview` folder, run the automated setup script. This will generate a `.env.local` file with the necessary secrets:
|
||||
```bash
|
||||
pnpm run setup
|
||||
```
|
||||
|
||||
Your workspace is now ready!
|
||||
|
||||
---
|
||||
|
||||
## Step 2: Creating the Data Engine Seeder (Backend)
|
||||
|
||||
The ISS moves incredibly fast. If our frontend tries to ask for its location every second, it will lag. Instead, we use the **Bring Your Own Backend (BYOB)** pattern. We will write a "Seeder" script in the Data Engine that fetches the ISS location and instantly broadcasts it to the frontend via WebSockets.
|
||||
|
||||
### 2.1 Create the Seeder File
|
||||
|
||||
Navigate to your data engine repository and create a new file named `iss.ts` in the `src/seeders` folder:
|
||||
`c:\dev\wwv-data-engine\src\seeders\iss.ts`
|
||||
|
||||
### 2.2 Write the Polling Logic
|
||||
|
||||
Open `iss.ts` in your text editor and paste the following code. This script reaches out to the free WhereTheISS.at API every 5 seconds and saves the data to the engine's memory (Redis).
|
||||
|
||||
```typescript
|
||||
import { setLiveSnapshot } from '../core/redis';
|
||||
import axios from 'axios';
|
||||
|
||||
const WTIA_URL = 'https://api.wheretheiss.at/v1/satellites/25544';
|
||||
const POLLING_INTERVAL = 5000; // 5 seconds
|
||||
|
||||
async function pollISS() {
|
||||
try {
|
||||
// 1. Fetch data from the API
|
||||
const response = await axios.get(WTIA_URL);
|
||||
const data = response.data;
|
||||
|
||||
// 2. Format the data into a GeoEntity object
|
||||
const stateObj = {
|
||||
id: 25544,
|
||||
name: "International Space Station",
|
||||
latitude: data.latitude,
|
||||
longitude: data.longitude,
|
||||
altitude: data.altitude * 1000, // Convert kilometers to meters
|
||||
velocity: data.velocity,
|
||||
visibility: data.visibility,
|
||||
footprint: data.footprint
|
||||
};
|
||||
|
||||
// 3. Save to Redis under the 'iss' namespace for 60 seconds
|
||||
await setLiveSnapshot('iss', { "25544": stateObj }, 60);
|
||||
console.log(`[ISS] Poll OK: updated position to ${data.latitude}, ${data.longitude}`);
|
||||
|
||||
} catch (error) {
|
||||
console.error(`[ISS] Polling error:`, error.message);
|
||||
} finally {
|
||||
// 4. Repeat the process after 5 seconds
|
||||
setTimeout(pollISS, POLLING_INTERVAL);
|
||||
}
|
||||
}
|
||||
|
||||
// Start the loop
|
||||
pollISS();
|
||||
```
|
||||
|
||||
### 2.3 Register the Seeder
|
||||
|
||||
The engine needs to know your seeder exists. Open `c:\dev\wwv-data-engine\src\seeders\index.ts` and add this line at the bottom:
|
||||
|
||||
```typescript
|
||||
import './iss';
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Step 3: Testing the Data Engine
|
||||
|
||||
Before we build the frontend, let's prove that our backend is actually fetching the ISS data.
|
||||
|
||||
### 3.1 Start the Engine
|
||||
|
||||
In your terminal, navigate to the `wwv-data-engine` folder and start the backend:
|
||||
```bash
|
||||
pnpm dev:backends
|
||||
```
|
||||
You should see `[ISS] Poll OK: updated position` appearing in your console every 5 seconds. Leave this terminal running.
|
||||
|
||||
### 3.2 Write a Quick Test Script
|
||||
|
||||
Open a *new* terminal window. Let's write a tiny script to peek into the engine's memory. Create a file called `test_iss.mjs` in the `wwv-data-engine` folder:
|
||||
|
||||
```javascript
|
||||
// test_iss.mjs
|
||||
import Redis from 'ioredis';
|
||||
const redis = new Redis();
|
||||
|
||||
async function verify() {
|
||||
const data = await redis.get('data:iss:live');
|
||||
if (data) {
|
||||
console.log("Success! We found the ISS:", JSON.parse(data));
|
||||
} else {
|
||||
console.log("No data found yet.");
|
||||
}
|
||||
process.exit(0);
|
||||
}
|
||||
verify();
|
||||
```
|
||||
|
||||
Run the script:
|
||||
```bash
|
||||
node test_iss.mjs
|
||||
```
|
||||
If you see a large block of data containing coordinates and altitude, your backend is working perfectly!
|
||||
|
||||
---
|
||||
|
||||
## Step 4: Creating the WorldWideView Plugin (Frontend)
|
||||
|
||||
Now we will build the visual part of the plugin that connects to our backend stream and draws the ISS on the 3D globe.
|
||||
|
||||
### 4.1 Scaffold the Plugin
|
||||
|
||||
In your terminal, navigate back to your main `c:\dev` folder. We will use the official CLI tool to generate a blank plugin template. Run:
|
||||
|
||||
```bash
|
||||
npx @worldwideview/create-plugin@latest wwv-plugin-iss
|
||||
```
|
||||
When prompted, name the folder `wwv-plugin-iss`.
|
||||
|
||||
Move into your new plugin folder and install its dependencies:
|
||||
```bash
|
||||
cd wwv-plugin-iss
|
||||
npm install
|
||||
```
|
||||
|
||||
### 4.2 Write the Plugin Logic
|
||||
|
||||
Open `c:\dev\wwv-plugin-iss\src\index.ts` in your text editor. Replace everything in the file with this code:
|
||||
|
||||
```typescript
|
||||
import type { WorldPlugin, GeoEntity, PluginContext, LayerConfig, CesiumEntityOptions } from "@worldwideview/wwv-plugin-sdk";
|
||||
|
||||
export class IssPlugin implements WorldPlugin {
|
||||
// The ID MUST match the namespace we used in the backend ('iss')
|
||||
id = "iss";
|
||||
name = "ISS Live Tracker";
|
||||
description = "Real-time International Space Station tracking.";
|
||||
icon = "Satellite";
|
||||
category = "space" as const;
|
||||
version = "1.0.0";
|
||||
|
||||
async initialize(ctx: PluginContext): Promise<void> {
|
||||
console.log("ISS Plugin loaded!");
|
||||
}
|
||||
|
||||
destroy(): void { }
|
||||
|
||||
async fetch(): Promise<GeoEntity[]> {
|
||||
// We return an empty array because the WebSockets handle the data automatically.
|
||||
return [];
|
||||
}
|
||||
|
||||
getPollingInterval(): number {
|
||||
return 0; // Disabled: we use continuous WebSockets instead of polling.
|
||||
}
|
||||
|
||||
getLayerConfig(): LayerConfig {
|
||||
return {
|
||||
color: "#00ffcc",
|
||||
clusterEnabled: false
|
||||
};
|
||||
}
|
||||
|
||||
renderEntity(entity: GeoEntity): CesiumEntityOptions {
|
||||
// Level of Detail (LOD): Use a 2D billboard from far away,
|
||||
// and transition to a 3D model when zooming in close.
|
||||
return {
|
||||
type: "billboard",
|
||||
color: "#ffffff",
|
||||
iconUrl: "https://unpkg.com/wwv-plugin-iss/assets/iss-icon.png",
|
||||
iconScale: 0.8,
|
||||
modelUrl: "https://unpkg.com/wwv-plugin-iss/assets/ISS_stationary.glb",
|
||||
modelScale: 2.5,
|
||||
heading: entity.heading || 0,
|
||||
};
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Step 5: Connecting and Testing Everything
|
||||
|
||||
Now we will link your new plugin to your local WorldWideView application to see it in action.
|
||||
|
||||
### 5.1 Link the Plugin
|
||||
|
||||
In your `wwv-plugin-iss` terminal, tell the CLI where your main WorldWideView folder is:
|
||||
```bash
|
||||
npx wwv config set wwv-path C:\dev\worldwideview
|
||||
```
|
||||
|
||||
Now, link the plugin. This creates a shortcut so WorldWideView can see your code:
|
||||
```bash
|
||||
npm run link
|
||||
```
|
||||
|
||||
Start the plugin watcher. This will automatically update your plugin if you make any changes to the code:
|
||||
```bash
|
||||
npm run dev
|
||||
```
|
||||
Leave this terminal running.
|
||||
|
||||
### 5.2 Start WorldWideView
|
||||
|
||||
Open a third, final terminal window. Navigate to your main `worldwideview` folder and start the frontend application:
|
||||
```bash
|
||||
cd C:\dev\worldwideview
|
||||
pnpm dev
|
||||
```
|
||||
|
||||
### 5.3 View the ISS
|
||||
|
||||
1. Open your web browser and go to `http://localhost:3000`.
|
||||
2. Click the **Layers** icon on the left sidebar.
|
||||
3. Find **ISS Live Tracker** in the list and toggle it ON.
|
||||
4. The globe will instantly fly to the current location of the ISS, and you will see it moving in real-time!
|
||||
|
||||
> [!TIP]
|
||||
> **Troubleshooting missing points:**
|
||||
> - Ensure your Data Engine terminal (`pnpm dev:backends`) is still running.
|
||||
> - Press `F12` in your browser to open Developer Tools. Check the `Console` tab for any red errors.
|
||||
> - Ensure the `id` in your plugin (`"iss"`) exactly matches the name you used in the backend `setLiveSnapshot('iss', ...)`.
|
||||
|
||||
---
|
||||
|
||||
## Step 6: Publishing Your Plugin
|
||||
|
||||
You've built it, now share it with the world!
|
||||
|
||||
### 6.1 Update package.json
|
||||
|
||||
Open `c:\dev\wwv-plugin-iss\package.json`. You must add a `"worldwideview"` metadata block so the marketplace knows how to read your plugin. Ensure your file looks like this:
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "wwv-plugin-iss",
|
||||
"version": "1.0.0",
|
||||
"main": "dist/index.js",
|
||||
"worldwideview": {
|
||||
"id": "iss",
|
||||
"name": "ISS Live Tracker",
|
||||
"version": "1.0.0",
|
||||
"icon": "Satellite",
|
||||
"category": "space"
|
||||
},
|
||||
"scripts": { ... }
|
||||
}
|
||||
```
|
||||
|
||||
### 6.2 Publish to NPM
|
||||
|
||||
In your plugin terminal, log in to NPM and publish your package:
|
||||
```bash
|
||||
npm login
|
||||
npm publish --access public
|
||||
```
|
||||
|
||||
### 6.3 Submit to the Marketplace
|
||||
|
||||
1. Go to the official marketplace at `https://marketplace.worldwideview.dev/submit`.
|
||||
2. Type in your package name (`wwv-plugin-iss`) and click submit.
|
||||
3. The system will automatically verify your code. Once approved, any WorldWideView user on the planet can click "Install" to add your ISS tracker to their globe.
|
||||
|
||||
**Congratulations!** You have successfully navigated the entire stack, from API polling and WebSockets to 3D rendering and global publishing.
|
||||
@@ -0,0 +1,80 @@
|
||||
<!-- Generated: 2026-04-23 06:11:00 UTC -->
|
||||
# Advanced Plugin Guide
|
||||
|
||||
This guide covers complex architectures, real-time telemetry streaming, and the deployment lifecycle for WorldWideView plugins. If you haven't built a basic plugin yet, start with the **[Quickstart](plugin-quickstart.md)**.
|
||||
|
||||
## Architecture Paradigm: The All-Bundle Model
|
||||
|
||||
WorldWideView operates on a strict **Dynamic CDN Loaded (Bundle)** architecture.
|
||||
|
||||
> [!WARNING]
|
||||
> **Deprecation Notice:** The legacy `StaticDataPlugin` (GeoJSON loaders) and `DeclarativePlugin` runtimes are fully deprecated. All new plugins must be dynamically imported at runtime as ES module bundles via `import(/* webpackIgnore: true */ entry)`.
|
||||
|
||||
### How Plugins Load
|
||||
1. A user clicks "Install" in the **Marketplace**.
|
||||
2. The marketplace sends the plugin manifest (containing an ES Module CDN URL, like `unpkg.com`) to the WorldWideView database.
|
||||
3. At runtime, the `InstalledPluginsLoader` dynamically fetches the JavaScript bundle.
|
||||
4. The plugin is instantiated, and its `initialize(ctx)` method is invoked.
|
||||
|
||||
## Real-Time Data: Bring Your Own Backend (BYOB)
|
||||
|
||||
Relying on the frontend `fetch()` method is insufficient for high-frequency real-time tracking (like aviation or maritime). For continuous telemetry, you must build a **Data Engine Seeder** — a containerized backend microservice.
|
||||
|
||||
### Microservice Seeder Architecture
|
||||
Instead of the frontend fetching data, your backend container connects to an upstream source, normalizes the data, and publishes it to the central Redis stream managed by `wwv-data-engine`.
|
||||
|
||||
1. **Scaffold a Backend:** Use the CLI to generate a backend template.
|
||||
```bash
|
||||
npx @worldwideview/cli create-backend my-plugin-backend
|
||||
```
|
||||
2. **Containerize:** This generates a Fastify Node.js server with a `Dockerfile` and `docker-compose.yml`.
|
||||
3. **Publish to Redis:** Your backend polls the external API (e.g., ADS-B Exchange) and pushes snapshots to the WorldWideView Redis pipeline.
|
||||
4. **WebSocket Delivery:** The central `wwv-data-engine` immediately broadcasts these updates over WebSockets to all connected clients.
|
||||
|
||||
> [!TIP]
|
||||
> **Debugging WebSockets:** If your frontend isn't receiving data from your backend seeder:
|
||||
> 1. Check the `wwv-data-engine` logs to ensure your seeder is publishing to Redis successfully.
|
||||
> 2. Verify the frontend is connected to the correct WebSocket endpoint. Local instances default to `ws://localhost:5001/stream`, while unrecognized seeders fall back to the cloud at `wss://dataengine.worldwideview.dev/stream`.
|
||||
|
||||
## Advanced Cesium Rendering
|
||||
|
||||
When returning `CesiumEntityOptions` in `renderEntity(entity)`, you have direct access to the 3D engine's capabilities.
|
||||
|
||||
### 3D Models vs. Billboards (LOD Strategy)
|
||||
To maintain 60 FPS with tens of thousands of entities, use WorldWideView's Level of Detail (LOD) promotion system.
|
||||
- Render distant entities as simple `billboard` or `point` primitives.
|
||||
- When the camera gets close, the system's `useModelRendering` hook can promote the entity to a full 3D glTF model.
|
||||
|
||||
```typescript
|
||||
renderEntity(entity: GeoEntity): CesiumEntityOptions {
|
||||
return {
|
||||
type: "billboard", // Primary lightweight renderer
|
||||
color: "#ffffff",
|
||||
iconUrl: "https://unpkg.com/my-plugin/assets/icon.png",
|
||||
iconScale: 0.5,
|
||||
// Provide a 3D model URL. The engine will swap it in automatically at close range.
|
||||
modelUrl: "https://unpkg.com/my-plugin/assets/model.glb",
|
||||
modelScale: 1.0,
|
||||
heading: entity.heading,
|
||||
};
|
||||
}
|
||||
```
|
||||
|
||||
> [!CAUTION]
|
||||
> **GPU Clipping Bug:** NEVER mix `size`, `outlineWidth`, or `outlineColor` properties onto an entity of `type: "billboard"`. This will cause the WebGL compiler to panic and result in severe visual clipping artifacts.
|
||||
|
||||
## Publishing to the Marketplace
|
||||
|
||||
To distribute your plugin globally:
|
||||
|
||||
1. **Publish to NPM:**
|
||||
```bash
|
||||
npm publish --access public
|
||||
```
|
||||
2. **Submit:** Navigate to `https://marketplace.worldwideview.dev/submit`.
|
||||
3. **Register:** Enter your NPM package name. The marketplace automatically scrapes your `package.json` for the required `"worldwideview"` object block (containing your `id`, `icon`, and `category`).
|
||||
4. **Review:** Once approved, your plugin's ES Module bundle will be served via CDN to all WorldWideView instances worldwide.
|
||||
|
||||
### Debugging Marketplace Submissions
|
||||
- **"Invalid Manifest" Error:** Ensure you are using `@worldwideview/wwv-plugin-sdk` as a `peerDependency` (not a direct dependency) so the host application injects the context correctly.
|
||||
- **Icon Not Showing:** Icons must be valid Lucide icon strings (e.g., `"Plane"`, `"Anchor"`).
|
||||
@@ -0,0 +1,126 @@
|
||||
<!-- Generated: 2026-04-23 06:11:00 UTC -->
|
||||
# Quickstart: Creating Your First Plugin
|
||||
|
||||
Welcome to WorldWideView plugin development! This tutorial will guide you through creating your first custom data layer on the 3D globe.
|
||||
|
||||
By the end of this guide, you will have a working plugin that plots real-time data on the WorldWideView map.
|
||||
|
||||
## 1. Prerequisites
|
||||
|
||||
Before you start, ensure you have:
|
||||
- Node.js ≥ 18
|
||||
- `npm` or `pnpm` installed
|
||||
- A running instance of WorldWideView on your local machine (running at `http://localhost:3000`).
|
||||
|
||||
## 2. Scaffold Your Plugin
|
||||
|
||||
WorldWideView plugins are built as standard NPM packages. They are entirely decoupled from the core application, allowing you to develop and publish them independently.
|
||||
|
||||
To generate a new plugin template, use the official CLI:
|
||||
|
||||
```bash
|
||||
npx @worldwideview/create-plugin@latest my-first-plugin
|
||||
cd my-first-plugin
|
||||
npm install
|
||||
```
|
||||
|
||||
This creates a lightweight Vite-based project pre-configured with the `@worldwideview/wwv-plugin-sdk`.
|
||||
|
||||
## 3. Link Your Plugin to WorldWideView
|
||||
|
||||
To see your plugin live on the globe while you develop, you need to link it to your local WorldWideView instance.
|
||||
|
||||
First, tell the CLI where your WorldWideView repository is located:
|
||||
```bash
|
||||
npx wwv config set wwv-path C:\path\to\your\worldwideview
|
||||
```
|
||||
|
||||
Next, link the plugin. This creates a symlink so your local WorldWideView instance can dynamically load your code:
|
||||
```bash
|
||||
npm run link
|
||||
```
|
||||
|
||||
Finally, start the plugin watcher. This will automatically rebuild your plugin whenever you save a file:
|
||||
```bash
|
||||
npm run dev
|
||||
```
|
||||
|
||||
> [!TIP]
|
||||
> **Debugging Link Issues:** If your plugin doesn't appear in the WorldWideView "Installed Plugins" list after linking, check your `package.json`. The `"worldwideview"` object block is strictly required. Ensure `id`, `name`, and `version` are populated correctly.
|
||||
|
||||
## 4. Explore the Code
|
||||
|
||||
Open `src/index.ts` in your text editor. You'll see a class that implements the `WorldPlugin` interface:
|
||||
|
||||
```typescript
|
||||
import type { WorldPlugin, GeoEntity, PluginContext, LayerConfig, CesiumEntityOptions } from "@worldwideview/wwv-plugin-sdk";
|
||||
|
||||
export class MyFirstPlugin implements WorldPlugin {
|
||||
id = "my-first-plugin";
|
||||
name = "My First Data Layer";
|
||||
description = "A simple example plugin.";
|
||||
icon = "MapPin";
|
||||
category = "custom" as const;
|
||||
version = "1.0.0";
|
||||
|
||||
async initialize(ctx: PluginContext): Promise<void> {
|
||||
console.log("Plugin initialized!");
|
||||
}
|
||||
|
||||
destroy(): void { }
|
||||
|
||||
async fetch(timeRange: TimeRange): Promise<GeoEntity[]> {
|
||||
// Generate a single dummy point over Paris
|
||||
return [{
|
||||
id: "test-point-1",
|
||||
pluginId: this.id,
|
||||
latitude: 48.8566,
|
||||
longitude: 2.3522,
|
||||
timestamp: new Date(),
|
||||
properties: { name: "Hello World" },
|
||||
}];
|
||||
}
|
||||
|
||||
getPollingInterval(): number {
|
||||
return 60_000; // Fetch every 60 seconds
|
||||
}
|
||||
|
||||
getLayerConfig(): LayerConfig {
|
||||
return {
|
||||
color: "#ff0000",
|
||||
clusterEnabled: false,
|
||||
clusterDistance: 40,
|
||||
};
|
||||
}
|
||||
|
||||
renderEntity(entity: GeoEntity): CesiumEntityOptions {
|
||||
return {
|
||||
type: "point",
|
||||
color: "#ff0000",
|
||||
size: 15,
|
||||
outlineColor: "#ffffff",
|
||||
outlineWidth: 2
|
||||
};
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## 5. View Your Plugin
|
||||
|
||||
1. Ensure your WorldWideView main application is running (`pnpm dev` or `pnpm dev:all` in the main repo).
|
||||
2. Open your browser to `http://localhost:3000`.
|
||||
3. Open the **Layers** panel on the left sidebar.
|
||||
4. Locate "My First Data Layer" and toggle it on.
|
||||
5. The globe will fly to Paris, and you should see a red dot!
|
||||
|
||||
> [!WARNING]
|
||||
> **Debugging Missing Points:** If the layer is toggled on but you don't see the point:
|
||||
> 1. Check your browser's Developer Console (F12) for any `DataBus` errors.
|
||||
> 2. Ensure your `fetch()` method returns an array of `GeoEntity` objects with valid `latitude` and `longitude` properties.
|
||||
> 3. Verify that your `renderEntity()` function returns a valid type (`point`, `billboard`, etc.).
|
||||
|
||||
## Next Steps
|
||||
|
||||
Congratulations! You've successfully built and linked your first plugin.
|
||||
|
||||
For advanced features—like real-time WebSocket streaming, containerizing your own backend microservices, or publishing your plugin to the global Marketplace—proceed to the **[Advanced Plugin Guide](docs/plugin-advanced.md)**.
|
||||
+18
-11
@@ -1,21 +1,28 @@
|
||||
<!-- Generated: 2026-04-19 15:23:00 UTC -->
|
||||
<!-- Generated: 2026-04-23 06:11:00 UTC -->
|
||||
# Project Overview
|
||||
|
||||
WorldWideView is a real-time geospatial intelligence engine that visualizes live global data on an interactive 3D globe. It leverages a modern frontend stack to render high-density datasets (aircraft, maritime vessels, conflict events, environmental data) synchronously.
|
||||
WorldWideView is a real-time geospatial intelligence engine that visualizes live global data on an interactive 3D globe. It leverages a modern frontend stack to render high-density datasets synchronously, including aircraft, maritime vessels, conflict events, satellites, and environmental data.
|
||||
|
||||
The core value proposition is mapping diverse, decoupled intelligence streams onto a central geographic interface using a dynamically loaded plugin architecture. Data sources operate completely decoupled from the display platform, streaming observations via WebSockets for sub-second visual updates.
|
||||
The core value proposition of WorldWideView is mapping diverse, decoupled intelligence streams onto a central geographic interface using a dynamically loaded plugin architecture. Data sources operate completely decoupled from the display platform, streaming observations via WebSockets for sub-second visual updates. The ecosystem consists of multiple repositories, including the main app (`worldwideview`), the plugin marketplace (`worldwideview-marketplace`), and the WebSocket push server (`wwv-data-engine`).
|
||||
|
||||
## Key Files
|
||||
- `package.json` (lines 1-80) - Core dependencies and project metadata.
|
||||
- `src/app/layout.tsx` (lines 15-40) - Global application shell and React structure.
|
||||
- `src/core/plugins/PluginManager.ts` (lines 20-56) - Heart of the engine, registers and lifecycle-manages external intelligence views.
|
||||
- `package.json` (Lines 1-76) - Core dependencies and project metadata for the monorepo workspace.
|
||||
- `src/app/layout.tsx` - Global application shell and React structure.
|
||||
- `src/core/plugins/PluginManager.ts` - Heart of the engine, registers and lifecycle-manages external intelligence views.
|
||||
- `src/core/globe/GlobeView.tsx` - Main Cesium globe component rendering.
|
||||
|
||||
## Technology Stack
|
||||
- **Framework:** Next.js 16 (App Router) — `src/app/`
|
||||
- **3D Engine:** CesiumJS + Resium — `src/core/globe/GlobeView.tsx` (lines 40-90)
|
||||
- **State Management:** Zustand — `src/core/state/store.ts` (slice pattern)
|
||||
- **Database:** Prisma ORM w/ SQLite locally — `prisma/schema.prisma`
|
||||
- **Typing:** TypeScript 5 w/ Strict Mode — `tsconfig.json`
|
||||
- **Language:** TypeScript 5 (Strict Mode) — `tsconfig.json`
|
||||
- **3D Engine:** CesiumJS + Resium (Google Photorealistic 3D Tiles) — `src/core/globe/GlobeView.tsx`
|
||||
- **State Management:** Zustand — `src/core/state/` (slice-based store)
|
||||
- **Event Bus:** Custom typed `DataBus` — `src/core/data/DataBus.ts`
|
||||
- **Database:** SQLite via Prisma (local), PostgreSQL (cloud) — `prisma/schema.prisma`
|
||||
- **Styling:** Vanilla CSS (no Tailwind) — `src/app/globals.css`
|
||||
|
||||
## Platform Support
|
||||
Built as a highly portable Next.js container, it supports `local`, `cloud`, and `demo` editions via the `NEXT_PUBLIC_WWV_EDITION` flag declared in `.env.local` and evaluated at runtime in `src/core/edition.ts`.
|
||||
Built as a highly portable Next.js container, it supports multiple deployment profiles controlled by `NEXT_PUBLIC_WWV_EDITION` (default: `local`).
|
||||
- **Local (`local`)**: Self-hosted, full features, auth enabled.
|
||||
- **Cloud (`cloud`)**: Managed cloud instance, full features.
|
||||
- **Demo (`demo`)**: Public demo, auth disabled, optional admin via `WWV_DEMO_ADMIN_SECRET`.
|
||||
Feature flags are evaluated at runtime in `src/core/edition.ts`.
|
||||
+35
-18
@@ -1,25 +1,42 @@
|
||||
<!-- Generated: 2026-04-19 15:23:00 UTC -->
|
||||
<!-- Generated: 2026-04-23 06:11:00 UTC -->
|
||||
# Testing
|
||||
|
||||
WorldWideView maintains a robust Vitest testing infrastructure utilizing `jsdom` environments to mock browser globals and React Testing Library utilities for accurate integration flow testing.
|
||||
|
||||
The primary requirement is full test coverage over authentication routes, edge-case platform parsing, and API rate-limit security.
|
||||
## Overview
|
||||
WorldWideView utilizes Vitest alongside a `jsdom` environment and the React Testing Library to ensure high reliability across core application logic, server APIs, and plugin loaders. Test coverage is strategically focused on shared libraries, core state logic, and the plugin ecosystem mechanisms.
|
||||
|
||||
## Test Types
|
||||
- **Unit Logic:** Verifies math, utilities, and configuration mappings (e.g. `edition.test.ts`).
|
||||
- **Middleware Integration:** Evaluates Request/Response blocks (e.g. `rateLimit.test.ts`).
|
||||
- **Component Mocking:** Exercises the React ecosystem state behaviors (e.g. `DeclarativePlugin.test.ts`).
|
||||
|
||||
## Key Files
|
||||
- `vitest.config.ts` (lines 5-25): Defines the inclusion criteria spanning `src/lib/**`, `src/core/**`, and `src/plugins/**`.
|
||||
- `src/lib/rateLimit.test.ts` (lines 15-60): Demonstrates test encapsulation regarding the Upstash Redis fallbacks.
|
||||
- `src/core/edition.test.ts` (lines 10-30): Confirms valid feature flag evaluations across local/demo builds.
|
||||
### Unit Tests
|
||||
Focused on validating standalone functions and state slice reducers without mounting React components.
|
||||
- **Example:** Validating the runtime edition feature flags.
|
||||
- *File:* `src/core/edition.test.ts`
|
||||
- **Example:** Validating marketplace token exchanges and rate limiting logic.
|
||||
- *Files:* `src/lib/marketplaceToken.test.ts`, `src/lib/rateLimit.test.ts`
|
||||
|
||||
### Integration Tests
|
||||
Focused on ensuring module interaction, such as the event bus properly interacting with state, or plugin loaders successfully resolving manifests.
|
||||
- **Example:** Testing local database repositories.
|
||||
- *File:* `src/lib/repository.test.ts`
|
||||
- **Example:** Validating cross-origin resource sharing (CORS) handlers for data engine streaming.
|
||||
- *File:* `src/lib/cors.test.ts`
|
||||
- **Example:** Verifying demo-admin bypass secrets.
|
||||
- *File:* `src/lib/demoAdmin.test.ts`
|
||||
|
||||
## Running Tests
|
||||
Run tests natively within the root directory utilizing `pnpm`:
|
||||
```bash
|
||||
# Execute standard test suite runs over all watched directories
|
||||
pnpm test
|
||||
# OR
|
||||
vitest run
|
||||
```
|
||||
|
||||
Execute the following commands from the root `worldwideview` directory:
|
||||
|
||||
- **Run all tests once:**
|
||||
```bash
|
||||
pnpm test
|
||||
```
|
||||
*(Alias for `vitest run`)*
|
||||
|
||||
- **Run tests in watch mode (for active development):**
|
||||
```bash
|
||||
npx vitest
|
||||
```
|
||||
|
||||
## Reference
|
||||
- **Coverage Scope:** The Vitest configuration primarily targets tests located inside `src/lib/**`, `src/core/**`, and `src/plugins/**`.
|
||||
- **Environment:** The test environment is configured as `jsdom` via `vite.config.ts` or `vitest.config.ts`, ensuring that DOM-specific API calls function outside of a real browser.
|
||||
+2
-4
@@ -3,10 +3,8 @@ import type { NextConfig } from "next";
|
||||
const nextConfig: NextConfig = {
|
||||
output: "standalone",
|
||||
serverExternalPackages: ["better-sqlite3", "@prisma/adapter-better-sqlite3", "@prisma/client", "prisma"],
|
||||
transpilePackages: ["@worldwideview/wwv-plugin-sdk","resium",
|
||||
"react-player",
|
||||
"satellite.js"
|
||||
],
|
||||
transpilePackages: ["@worldwideview/wwv-plugin-sdk", "resium", "react-player", "satellite.js"],
|
||||
allowedDevOrigins: process.env.ALLOWED_DEV_ORIGIN ? [process.env.ALLOWED_DEV_ORIGIN] : undefined,
|
||||
experimental: {
|
||||
memoryBasedWorkersCount: true,
|
||||
cpus: 2,
|
||||
|
||||
+1
-1
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "worldwideview",
|
||||
"version": "1.19.0",
|
||||
"version": "1.20.0",
|
||||
"private": true,
|
||||
"scripts": {
|
||||
"setup": "node scripts/setup.mjs",
|
||||
|
||||
@@ -0,0 +1,2 @@
|
||||
#!/usr/bin/env node
|
||||
require('../dist/index.js');
|
||||
@@ -0,0 +1,24 @@
|
||||
{
|
||||
"name": "@worldwideview/cli",
|
||||
"version": "1.0.0",
|
||||
"bin": {
|
||||
"wwv": "./bin/wwv.js"
|
||||
},
|
||||
"scripts": {
|
||||
"build": "tsc",
|
||||
"test": "vitest run"
|
||||
},
|
||||
"dependencies": {
|
||||
"archiver": "^7.0.1",
|
||||
"commander": "^11.1.0",
|
||||
"vite": "^8.0.8",
|
||||
"ws": "^8.20.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@types/archiver": "^7.0.0",
|
||||
"@types/node": "^20.0.0",
|
||||
"@types/ws": "^8.18.1",
|
||||
"typescript": "^5.0.0",
|
||||
"vitest": "^1.0.0"
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,64 @@
|
||||
import fs from "fs";
|
||||
import path from "path";
|
||||
|
||||
export async function createPlugin(name: string, basePath: string = process.cwd()) {
|
||||
const targetDir = path.join(basePath, name);
|
||||
if (fs.existsSync(targetDir)) {
|
||||
throw new Error(`Directory ${name} already exists`);
|
||||
}
|
||||
|
||||
fs.mkdirSync(targetDir, { recursive: true });
|
||||
fs.mkdirSync(path.join(targetDir, "src"), { recursive: true });
|
||||
|
||||
const manifest = {
|
||||
manifest_version: 1,
|
||||
id: name,
|
||||
name: name,
|
||||
version: "1.0.0",
|
||||
description: "A WorldWideView plugin",
|
||||
type: "data-layer",
|
||||
category: "custom",
|
||||
icon: "Box",
|
||||
capabilities: ["data:own"],
|
||||
entry: "dist/frontend.mjs",
|
||||
dev_entry: "src/index.ts"
|
||||
};
|
||||
|
||||
fs.writeFileSync(
|
||||
path.join(targetDir, "wwv-manifest.json"),
|
||||
JSON.stringify(manifest, null, 2)
|
||||
);
|
||||
|
||||
const indexContent = `export default class MyPlugin {
|
||||
id = "${name}";
|
||||
name = "${name}";
|
||||
version = "1.0.0";
|
||||
category = "custom";
|
||||
icon = "Box";
|
||||
|
||||
async initialize(ctx) {
|
||||
console.log("Initialized", this.id);
|
||||
}
|
||||
|
||||
destroy() {}
|
||||
|
||||
async fetch(timeRange) {
|
||||
return [];
|
||||
}
|
||||
|
||||
getPollingInterval() {
|
||||
return 5000;
|
||||
}
|
||||
|
||||
getLayerConfig() {
|
||||
return { color: "#3b82f6", clusterEnabled: true, clusterDistance: 50 };
|
||||
}
|
||||
|
||||
renderEntity(entity) {
|
||||
return { type: "point", color: "#3b82f6", size: 6 };
|
||||
}
|
||||
}
|
||||
`;
|
||||
fs.writeFileSync(path.join(targetDir, "src", "index.ts"), indexContent);
|
||||
console.log(`Plugin ${name} scaffolded successfully in ./${name}`);
|
||||
}
|
||||
@@ -0,0 +1,61 @@
|
||||
import fs from "fs";
|
||||
import path from "path";
|
||||
import { createServer } from "vite";
|
||||
import { WebSocketServer } from "ws";
|
||||
|
||||
export async function startDevServer(targetUrl: string = "http://localhost:3000") {
|
||||
const cwd = process.cwd();
|
||||
const manifestPath = path.join(cwd, "wwv-manifest.json");
|
||||
|
||||
if (!fs.existsSync(manifestPath)) {
|
||||
throw new Error("No wwv-manifest.json found in current directory");
|
||||
}
|
||||
|
||||
const manifest = JSON.parse(fs.readFileSync(manifestPath, "utf-8"));
|
||||
const port = 24601;
|
||||
|
||||
// Start Vite Dev Server
|
||||
const vite = await createServer({
|
||||
root: cwd,
|
||||
server: { port, cors: true, hmr: false }, // We handle HMR via custom WS
|
||||
plugins: [{
|
||||
name: 'wwv-hmr',
|
||||
handleHotUpdate({ server }: any) {
|
||||
// When Vite detects file changes, broadcast to our custom WS
|
||||
wss.clients.forEach(client => {
|
||||
client.send(JSON.stringify({ type: "plugin:updated", pluginId: manifest.id }));
|
||||
});
|
||||
return []; // Prevent default Vite HMR
|
||||
}
|
||||
}]
|
||||
});
|
||||
|
||||
await vite.listen();
|
||||
|
||||
// Attach custom WebSocket server for WWV DevModeSubscriber
|
||||
const wss = new WebSocketServer({ server: vite.httpServer as any, path: "/__wwv_dev__" });
|
||||
|
||||
wss.on("connection", (ws) => {
|
||||
console.log(`[WWV CLI] Connected to WorldWideView instance`);
|
||||
ws.send(JSON.stringify({ type: "plugin:added", manifest }));
|
||||
});
|
||||
|
||||
// Notify WorldWideView via API
|
||||
try {
|
||||
await fetch(`${targetUrl}/api/dev/load-unpacked`, {
|
||||
method: "POST",
|
||||
headers: { "Content-Type": "application/json" },
|
||||
body: JSON.stringify({
|
||||
...manifest,
|
||||
entry: `http://localhost:${port}/${manifest.dev_entry || "src/index.ts"}`
|
||||
})
|
||||
});
|
||||
console.log(`[WWV CLI] Registered with WorldWideView at ${targetUrl}`);
|
||||
} catch (err: any) {
|
||||
console.error(`[WWV CLI] Failed to connect to ${targetUrl}: ${err.message}`);
|
||||
console.log(`Waiting for WorldWideView to connect via WebSocket...`);
|
||||
}
|
||||
|
||||
console.log(`\n🚀 Dev server running on http://localhost:${port}`);
|
||||
console.log(`Watching for file changes in ${cwd}...\n`);
|
||||
}
|
||||
@@ -0,0 +1,57 @@
|
||||
import fs from "fs";
|
||||
import path from "path";
|
||||
import { build } from "vite";
|
||||
import archiver from "archiver";
|
||||
|
||||
export async function packagePlugin() {
|
||||
const cwd = process.cwd();
|
||||
const manifestPath = path.join(cwd, "wwv-manifest.json");
|
||||
|
||||
if (!fs.existsSync(manifestPath)) {
|
||||
throw new Error("No wwv-manifest.json found in current directory");
|
||||
}
|
||||
|
||||
const manifest = JSON.parse(fs.readFileSync(manifestPath, "utf-8"));
|
||||
|
||||
console.log(`[WWV CLI] Building production bundle...`);
|
||||
await build({
|
||||
root: cwd,
|
||||
build: {
|
||||
lib: {
|
||||
entry: path.resolve(cwd, manifest.dev_entry || "src/index.ts"),
|
||||
name: 'WWVPlugin',
|
||||
formats: ['es'],
|
||||
fileName: () => 'frontend.mjs'
|
||||
},
|
||||
outDir: 'dist',
|
||||
emptyOutDir: true
|
||||
}
|
||||
});
|
||||
|
||||
const pkgName = `${manifest.id}-${manifest.version}.wwvpkg`;
|
||||
const outputPath = path.join(cwd, pkgName);
|
||||
|
||||
console.log(`[WWV CLI] Creating archive ${pkgName}...`);
|
||||
|
||||
await new Promise<void>((resolve, reject) => {
|
||||
const output = fs.createWriteStream(outputPath);
|
||||
const archive = archiver("zip", { zlib: { level: 9 } });
|
||||
|
||||
output.on("close", () => resolve());
|
||||
archive.on("error", (err) => reject(err));
|
||||
|
||||
archive.pipe(output);
|
||||
|
||||
archive.file(manifestPath, { name: "wwv-manifest.json" });
|
||||
archive.directory(path.join(cwd, "dist"), "dist");
|
||||
|
||||
if (fs.existsSync(path.join(cwd, "data"))) {
|
||||
archive.directory(path.join(cwd, "data"), "data");
|
||||
}
|
||||
|
||||
archive.finalize();
|
||||
});
|
||||
|
||||
console.log(`\n🎉 Success! Package created at ${outputPath}`);
|
||||
console.log(`You can use this file to sideload the plugin into your WWV instance.`);
|
||||
}
|
||||
@@ -0,0 +1,72 @@
|
||||
import fs from "fs";
|
||||
import path from "path";
|
||||
import { build } from "vite";
|
||||
import { execSync } from "child_process";
|
||||
|
||||
export async function publishToNpm() {
|
||||
const cwd = process.cwd();
|
||||
const manifestPath = path.join(cwd, "wwv-manifest.json");
|
||||
|
||||
if (!fs.existsSync(manifestPath)) {
|
||||
throw new Error("No wwv-manifest.json found in current directory");
|
||||
}
|
||||
|
||||
const manifest = JSON.parse(fs.readFileSync(manifestPath, "utf-8"));
|
||||
|
||||
console.log(`[WWV CLI] Compiling bundle for NPM...`);
|
||||
await build({
|
||||
root: cwd,
|
||||
build: {
|
||||
lib: {
|
||||
entry: path.resolve(cwd, manifest.dev_entry || "src/index.ts"),
|
||||
name: 'WWVPlugin',
|
||||
formats: ['es'],
|
||||
fileName: () => 'frontend.mjs'
|
||||
},
|
||||
outDir: 'dist',
|
||||
emptyOutDir: true
|
||||
}
|
||||
});
|
||||
|
||||
console.log(`[WWV CLI] Generating package.json...`);
|
||||
// Create a temporary package.json required for NPM publish
|
||||
const packageJsonPath = path.join(cwd, "package.json");
|
||||
const packageJson = {
|
||||
name: manifest.id, // e.g. @username/my-plugin
|
||||
version: manifest.version,
|
||||
description: manifest.description,
|
||||
main: "dist/frontend.mjs",
|
||||
type: "module",
|
||||
files: ["dist", "wwv-manifest.json", "data"],
|
||||
keywords: ["worldwideview", "plugin", manifest.category],
|
||||
author: manifest.author || ""
|
||||
};
|
||||
|
||||
fs.writeFileSync(packageJsonPath, JSON.stringify(packageJson, null, 2));
|
||||
|
||||
console.log(`[WWV CLI] Publishing to NPM...`);
|
||||
try {
|
||||
execSync(`npm publish --access public`, { stdio: "inherit", cwd });
|
||||
} catch (err) {
|
||||
console.error(`[WWV CLI] NPM publish failed. Please ensure you are logged in via 'npm login'.`);
|
||||
throw err;
|
||||
} finally {
|
||||
// Clean up the generated package.json so it doesn't clutter the dev's repo
|
||||
fs.unlinkSync(packageJsonPath);
|
||||
}
|
||||
|
||||
console.log(`[WWV CLI] Notifying WorldWideView Marketplace...`);
|
||||
try {
|
||||
const targetUrl = process.env.WWV_MARKETPLACE_URL || "https://marketplace.worldwideview.dev";
|
||||
await fetch(`${targetUrl}/api/webhooks/npm-publish`, {
|
||||
method: "POST",
|
||||
headers: { "Content-Type": "application/json" },
|
||||
body: JSON.stringify({ pluginId: manifest.id, version: manifest.version })
|
||||
});
|
||||
console.log(`[WWV CLI] Marketplace notified.`);
|
||||
} catch (err: any) {
|
||||
console.warn(`[WWV CLI] Could not notify marketplace: ${err.message}. It will be indexed on the next sweep.`);
|
||||
}
|
||||
|
||||
console.log(`\n🚀 Success! Version ${manifest.version} published globally to NPM.`);
|
||||
}
|
||||
@@ -0,0 +1,66 @@
|
||||
import { Command } from "commander";
|
||||
|
||||
import { createPlugin } from "./commands/create";
|
||||
|
||||
const program = new Command();
|
||||
|
||||
program
|
||||
.name("wwv")
|
||||
.description("WorldWideView Plugin CLI")
|
||||
.version("1.0.0");
|
||||
|
||||
program
|
||||
.command("create <name>")
|
||||
.description("Scaffold a new WorldWideView plugin")
|
||||
.action(async (name) => {
|
||||
try {
|
||||
await createPlugin(name);
|
||||
} catch (err: any) {
|
||||
console.error("Error:", err.message);
|
||||
process.exit(1);
|
||||
}
|
||||
});
|
||||
|
||||
import { startDevServer } from "./commands/dev";
|
||||
|
||||
program
|
||||
.command("dev")
|
||||
.description("Start the plugin development server with hot-reload")
|
||||
.option("-t, --target <url>", "Target WorldWideView URL", "http://localhost:3000")
|
||||
.action(async (options) => {
|
||||
try {
|
||||
await startDevServer(options.target);
|
||||
} catch (err: any) {
|
||||
console.error("Error:", err.message);
|
||||
process.exit(1);
|
||||
}
|
||||
});
|
||||
|
||||
import { packagePlugin } from "./commands/package";
|
||||
import { publishToNpm } from "./commands/publish";
|
||||
|
||||
program
|
||||
.command("package")
|
||||
.description("Build and package the plugin into a .wwvpkg file for sideloading")
|
||||
.action(async () => {
|
||||
try {
|
||||
await packagePlugin();
|
||||
} catch (err: any) {
|
||||
console.error("Error:", err.message);
|
||||
process.exit(1);
|
||||
}
|
||||
});
|
||||
|
||||
program
|
||||
.command("publish")
|
||||
.description("Publish the plugin to NPM and notify the WWV Marketplace")
|
||||
.action(async () => {
|
||||
try {
|
||||
await publishToNpm();
|
||||
} catch (err: any) {
|
||||
console.error("Error:", err.message);
|
||||
process.exit(1);
|
||||
}
|
||||
});
|
||||
|
||||
program.parse();
|
||||
@@ -0,0 +1,21 @@
|
||||
import { describe, it, expect, afterEach } from "vitest";
|
||||
import { createPlugin } from "../src/commands/create";
|
||||
import fs from "fs";
|
||||
import path from "path";
|
||||
|
||||
describe("create command", () => {
|
||||
const testDir = path.join(__dirname, "test-plugin");
|
||||
|
||||
afterEach(() => {
|
||||
if (fs.existsSync(testDir)) fs.rmSync(testDir, { recursive: true, force: true });
|
||||
});
|
||||
|
||||
it("should scaffold a new plugin folder with manifest and index.ts", async () => {
|
||||
await createPlugin("test-plugin", __dirname);
|
||||
expect(fs.existsSync(path.join(testDir, "wwv-manifest.json"))).toBe(true);
|
||||
expect(fs.existsSync(path.join(testDir, "src", "index.ts"))).toBe(true);
|
||||
|
||||
const manifest = JSON.parse(fs.readFileSync(path.join(testDir, "wwv-manifest.json"), "utf-8"));
|
||||
expect(manifest.id).toBe("test-plugin");
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,17 @@
|
||||
import { describe, it, expect, vi } from "vitest";
|
||||
import { startDevServer } from "../src/commands/dev";
|
||||
|
||||
// Mock vite and ws
|
||||
vi.mock("vite", () => ({
|
||||
createServer: vi.fn().mockResolvedValue({
|
||||
listen: vi.fn(),
|
||||
httpServer: { on: vi.fn() },
|
||||
ws: { on: vi.fn() }
|
||||
})
|
||||
}));
|
||||
|
||||
describe("dev command", () => {
|
||||
it("should export startDevServer function", () => {
|
||||
expect(typeof startDevServer).toBe("function");
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,11 @@
|
||||
import { describe, it, expect } from "vitest";
|
||||
import { execSync } from "child_process";
|
||||
import path from "path";
|
||||
|
||||
describe("wwv cli", () => {
|
||||
it("should print help information", () => {
|
||||
const binPath = path.resolve(__dirname, "../bin/wwv.js");
|
||||
const output = execSync(`node ${binPath} --help`).toString();
|
||||
expect(output).toContain("Usage: wwv [options]");
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,8 @@
|
||||
import { describe, it, expect } from "vitest";
|
||||
import { packagePlugin } from "../src/commands/package";
|
||||
|
||||
describe("package command", () => {
|
||||
it("should export packagePlugin function", () => {
|
||||
expect(typeof packagePlugin).toBe("function");
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,15 @@
|
||||
import { describe, it, expect, vi } from "vitest";
|
||||
import { publishToNpm } from "../src/commands/publish";
|
||||
|
||||
vi.mock("child_process", () => ({
|
||||
execSync: vi.fn()
|
||||
}));
|
||||
vi.mock("vite", () => ({
|
||||
build: vi.fn().mockResolvedValue({})
|
||||
}));
|
||||
|
||||
describe("publish command", () => {
|
||||
it("should export publishToNpm function", () => {
|
||||
expect(typeof publishToNpm).toBe("function");
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,14 @@
|
||||
{
|
||||
"compilerOptions": {
|
||||
"target": "ES2022",
|
||||
"module": "NodeNext",
|
||||
"outDir": "./dist",
|
||||
"rootDir": "./src",
|
||||
"strict": true,
|
||||
"esModuleInterop": true,
|
||||
"skipLibCheck": true,
|
||||
"moduleResolution": "NodeNext",
|
||||
"forceConsistentCasingInFileNames": true
|
||||
},
|
||||
"include": ["src/**/*"]
|
||||
}
|
||||
@@ -0,0 +1,8 @@
|
||||
import { defineConfig } from "vitest/config";
|
||||
|
||||
export default defineConfig({
|
||||
test: {
|
||||
environment: "node",
|
||||
globals: true
|
||||
}
|
||||
});
|
||||
@@ -6,7 +6,7 @@ import type { PluginCategory } from "./index";
|
||||
|
||||
export type PluginFormat = "declarative" | "static" | "bundle";
|
||||
export type PluginType = "data-layer" | "extension";
|
||||
export type TrustTier = "built-in" | "verified" | "unverified";
|
||||
export type TrustTier = "built-in" | "verified" | "unverified" | "developer";
|
||||
|
||||
export type PluginCapability =
|
||||
| "data:own"
|
||||
|
||||
Generated
+1057
-560
File diff suppressed because it is too large.
Load diff
@@ -12,13 +12,41 @@ if (!branchName) {
|
||||
}
|
||||
|
||||
const rootDir = process.cwd();
|
||||
const worktreeDirName = branchName.replace(/\//g, '-');
|
||||
const worktreePath = path.join(rootDir, '.worktrees', worktreeDirName);
|
||||
|
||||
// 2. Validate worktree exists
|
||||
// 2. Find worktree path dynamically
|
||||
let worktreePath = null;
|
||||
try {
|
||||
const output = execSync('git worktree list --porcelain', { encoding: 'utf8' });
|
||||
const blocks = output.trim().split(/\r?\n\r?\n/);
|
||||
|
||||
for (const block of blocks) {
|
||||
const lines = block.split(/\r?\n/);
|
||||
const wtPathLine = lines.find(l => l.startsWith('worktree '));
|
||||
const branchLine = lines.find(l => l.startsWith('branch '));
|
||||
|
||||
if (wtPathLine && branchLine) {
|
||||
const currentBranch = branchLine.substring('branch refs/heads/'.length);
|
||||
if (currentBranch === branchName) {
|
||||
worktreePath = wtPathLine.substring('worktree '.length);
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
} catch (err) {
|
||||
console.warn('\x1b[33mWarning: Failed to parse git worktree list.\x1b[0m');
|
||||
}
|
||||
|
||||
// Fallback to legacy behavior if not found via git
|
||||
if (!worktreePath) {
|
||||
const worktreeDirName = branchName.replace(/\//g, '-');
|
||||
worktreePath = path.join(rootDir, '.worktrees', worktreeDirName);
|
||||
}
|
||||
|
||||
// 3. Validate worktree exists
|
||||
if (!fs.existsSync(worktreePath)) {
|
||||
console.error(`\x1b[31mError: Worktree directory not found at ${worktreePath}\x1b[0m`);
|
||||
console.error(`Ensure you have created it using 'git worktree add .worktrees/${worktreeDirName} -b ${branchName}'`);
|
||||
console.error(`\x1b[31mError: Worktree directory not found for branch '${branchName}'\x1b[0m`);
|
||||
console.error(`Searched path: ${worktreePath}`);
|
||||
console.error(`Ensure you have created it using 'git worktree add <path> -b ${branchName}'`);
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
|
||||
@@ -11,6 +11,7 @@ import { getVerifiedPluginIds } from "@/lib/marketplace/registryClient";
|
||||
import { isDemo, isDemoAdmin } from "@/core/edition";
|
||||
import { auth } from "@/lib/auth";
|
||||
import { seedDefaultPlugins } from "@/lib/marketplace/seedDefaultPlugins";
|
||||
import * as Sentry from "@sentry/nextjs";
|
||||
|
||||
export async function OPTIONS(request: Request) {
|
||||
return handlePreflight(request);
|
||||
@@ -82,20 +83,36 @@ export async function GET(request: Request) {
|
||||
if (!m) return false;
|
||||
// Skip built-in plugins — already registered by AppShell
|
||||
if (m.trust === "built-in") return false;
|
||||
|
||||
// Skip stale/malformed records (e.g. old empty-config installs for built-ins)
|
||||
// If it lacks basic required fields, it's a legacy record and we drop it silently
|
||||
// to avoid log spam on every poll.
|
||||
if (!m.entry || !m.name || !m.version) return false;
|
||||
|
||||
// Skip bundle plugins whose entry is a bare module specifier
|
||||
// (e.g. "camera") — cannot be dynamically imported in the browser.
|
||||
// These are stale/malformed DB records from built-in plugins.
|
||||
if (
|
||||
m.format === "bundle" &&
|
||||
m.entry &&
|
||||
!m.entry.startsWith("/") &&
|
||||
!m.entry.startsWith("./") &&
|
||||
!m.entry.startsWith("http")
|
||||
) return false;
|
||||
// Skip records with no usable manifest (e.g. old empty-config installs)
|
||||
|
||||
// For anything that looks like a real manifest, validate it and log if it fails
|
||||
const validation = validateManifest(m);
|
||||
if (!validation.valid) {
|
||||
console.error(`[Marketplace API] Manifest validation failed for ${m.id}:`, validation.errors);
|
||||
const errorMessage = `Manifest validation failed for ${m.id}`;
|
||||
console.error(`[Marketplace API] ${errorMessage}:`, validation.errors);
|
||||
|
||||
// Capture in Sentry so we have visibility into malformed third-party plugins
|
||||
Sentry.captureMessage(errorMessage, {
|
||||
level: "error",
|
||||
extra: {
|
||||
pluginId: m.id,
|
||||
validationErrors: validation.errors,
|
||||
manifest: m
|
||||
}
|
||||
});
|
||||
}
|
||||
return validation.valid;
|
||||
})
|
||||
|
||||
@@ -2,7 +2,6 @@ import { NextResponse } from "next/server";
|
||||
import { validateMarketplaceAuth } from "@/lib/marketplace/auth";
|
||||
import { getInstalledPlugins } from "@/lib/marketplace/repository";
|
||||
import { handlePreflight, withCors } from "@/lib/marketplace/cors";
|
||||
import { BUILT_IN_PLUGIN_IDS } from "@/lib/marketplace/builtinPlugins";
|
||||
import { marketplaceApiLimiter } from "@/lib/rateLimiters";
|
||||
import { getClientIp } from "@/lib/rateLimit";
|
||||
import { isDemo, isDemoAdmin } from "@/core/edition";
|
||||
@@ -31,17 +30,7 @@ export async function GET(request: Request) {
|
||||
// Collect active DB plugins (exclude disabled ones)
|
||||
const activeDbPlugins = dbPlugins.filter((p: any) => p.enabled !== false);
|
||||
|
||||
// Add built-in plugins that aren't in the DB at all (default = installed)
|
||||
const builtInRecords = BUILT_IN_PLUGIN_IDS
|
||||
.filter((id) => !dbMap.has(id))
|
||||
.map((id) => ({
|
||||
pluginId: id,
|
||||
version: "built-in",
|
||||
config: "{}",
|
||||
installedAt: "",
|
||||
}));
|
||||
|
||||
const plugins = [...activeDbPlugins, ...builtInRecords];
|
||||
const plugins = activeDbPlugins;
|
||||
|
||||
let canManagePlugins = !isDemo;
|
||||
if (isDemo) {
|
||||
@@ -52,21 +41,13 @@ export async function GET(request: Request) {
|
||||
return withCors(NextResponse.json({ plugins, canManagePlugins }), request);
|
||||
} catch (err) {
|
||||
console.error("[marketplace/status] Error:", err);
|
||||
// Fallback: return built-in plugins when DB is unavailable
|
||||
const fallback = BUILT_IN_PLUGIN_IDS.map((id) => ({
|
||||
pluginId: id,
|
||||
version: "built-in",
|
||||
config: "{}",
|
||||
installedAt: "",
|
||||
}));
|
||||
|
||||
let canManagePlugins = !isDemo;
|
||||
if (isDemo) {
|
||||
const authError = await validateMarketplaceAuth(request);
|
||||
canManagePlugins = authError === null;
|
||||
}
|
||||
|
||||
return withCors(NextResponse.json({ plugins: fallback, canManagePlugins }), request);
|
||||
return withCors(NextResponse.json({ plugins: [], canManagePlugins }), request);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -2,7 +2,6 @@ import { NextResponse } from "next/server";
|
||||
import { validateMarketplaceAuth } from "@/lib/marketplace/auth";
|
||||
import { uninstallPlugin, disablePlugin } from "@/lib/marketplace/repository";
|
||||
import { handlePreflight, withCors } from "@/lib/marketplace/cors";
|
||||
import { BUILT_IN_PLUGIN_IDS } from "@/lib/marketplace/builtinPlugins";
|
||||
import { marketplaceApiLimiter } from "@/lib/rateLimiters";
|
||||
import { getClientIp } from "@/lib/rateLimit";
|
||||
import { isPluginInstallEnabled, isDemo, isDemoAdmin } from "@/core/edition";
|
||||
@@ -12,8 +11,6 @@ export async function OPTIONS(request: Request) {
|
||||
return handlePreflight(request);
|
||||
}
|
||||
|
||||
const builtInSet = new Set<string>(BUILT_IN_PLUGIN_IDS);
|
||||
|
||||
export async function POST(request: Request) {
|
||||
if (!isPluginInstallEnabled) {
|
||||
return withCors(
|
||||
@@ -41,15 +38,6 @@ export async function POST(request: Request) {
|
||||
);
|
||||
}
|
||||
|
||||
// Built-in plugins are disabled (not deleted)
|
||||
if (builtInSet.has(pluginId)) {
|
||||
await disablePlugin(pluginId);
|
||||
return withCors(
|
||||
NextResponse.json({ status: "disabled", pluginId }),
|
||||
request,
|
||||
);
|
||||
}
|
||||
|
||||
const deleted = await uninstallPlugin(pluginId);
|
||||
|
||||
if (deleted === 0) {
|
||||
|
||||
+29
-4
@@ -1250,6 +1250,31 @@ html, body {
|
||||
box-shadow: 0 4px 12px rgba(0, 0, 0, 0.4);
|
||||
}
|
||||
|
||||
body.is-resizing-sidebar .panel-toggle-btn,
|
||||
body.is-resizing-sidebar .sidebar {
|
||||
transition: none !important;
|
||||
}
|
||||
|
||||
/* Invisible pseudo-element to expand the effective touch/click trigger area */
|
||||
.panel-toggle-btn::after {
|
||||
content: "";
|
||||
position: absolute;
|
||||
top: -20px;
|
||||
bottom: -20px;
|
||||
left: -25px;
|
||||
right: -25px;
|
||||
z-index: -1;
|
||||
}
|
||||
|
||||
/* Extend inward trigger area so it's harder to miss when coming from the panel */
|
||||
.panel-toggle-btn--left::after {
|
||||
left: -60px;
|
||||
}
|
||||
|
||||
.panel-toggle-btn--right::after {
|
||||
right: -60px;
|
||||
}
|
||||
|
||||
.panel-toggle-btn:hover {
|
||||
background: var(--bg-glass-active);
|
||||
color: var(--text-primary);
|
||||
@@ -1272,8 +1297,8 @@ html, body {
|
||||
}
|
||||
|
||||
.panel-toggle-btn--left.panel-toggle-btn--open {
|
||||
/* Attach to the right edge of the left panel (width 280px + left padding 24px) */
|
||||
left: calc(280px + var(--space-lg));
|
||||
/* Attach to the right edge of the left panel */
|
||||
left: calc(var(--left-sidebar-width, 280px) + var(--space-lg));
|
||||
border-radius: 0 var(--radius-sm) var(--radius-sm) 0;
|
||||
border-left: none;
|
||||
/* Stay slightly hidden under the panel to look attached, poke out 24px */
|
||||
@@ -1300,8 +1325,8 @@ html, body {
|
||||
}
|
||||
|
||||
.panel-toggle-btn--right.panel-toggle-btn--open {
|
||||
/* Attach to the left edge of the right panel (width 320px + right padding 24px) */
|
||||
right: calc(320px + var(--space-lg) + var(--ad-strip-inset, 0px));
|
||||
/* Attach to the left edge of the right panel */
|
||||
right: calc(var(--right-sidebar-width, 320px) + var(--space-lg) + var(--ad-strip-inset, 0px));
|
||||
border-radius: var(--radius-sm) 0 0 var(--radius-sm);
|
||||
border-right: none;
|
||||
/* Stay slightly hidden under the panel to look attached, poke out 24px */
|
||||
|
||||
@@ -14,6 +14,9 @@ const BOTTOM_AD_SLOT = "6006554079";
|
||||
/** Width of the ad strip — must match the CSS value. */
|
||||
const AD_STRIP_WIDTH = 160;
|
||||
|
||||
/** Toggle to temporarily disable ads in the demo edition. */
|
||||
const ENABLE_ADS = false;
|
||||
|
||||
export function DemoAdStrip() {
|
||||
const [showMessage, setShowMessage] = useState(false);
|
||||
const [bannerDismissed, setBannerDismissed] = useState(false);
|
||||
@@ -42,7 +45,7 @@ export function DemoAdStrip() {
|
||||
// Set the --ad-strip-inset CSS variable on the page root
|
||||
// so fixed-position panels (header, timeline) stay within bounds.
|
||||
useEffect(() => {
|
||||
if (!isDemo) return;
|
||||
if (!isDemo || !ENABLE_ADS) return;
|
||||
const root = document.querySelector(".page-root") as HTMLElement | null;
|
||||
if (root) root.style.setProperty("--ad-strip-inset", `${AD_STRIP_WIDTH}px`);
|
||||
return () => {
|
||||
@@ -50,7 +53,7 @@ export function DemoAdStrip() {
|
||||
};
|
||||
}, []);
|
||||
|
||||
if (!isDemo) return null;
|
||||
if (!isDemo || !ENABLE_ADS) return null;
|
||||
|
||||
return (
|
||||
<aside
|
||||
|
||||
@@ -20,6 +20,7 @@ import { useBootSequence } from "@/core/hooks/useBootSequence";
|
||||
import { useIsMobile } from "@/core/hooks/useIsMobile";
|
||||
import { useMarketplaceSync } from "@/core/hooks/useMarketplaceSync";
|
||||
import { DataBusSubscriber } from "./DataBusSubscriber";
|
||||
import { DevModeSubscriber } from "./DevModeSubscriber";
|
||||
import { MobileHudBar } from "./MobileHudBar";
|
||||
import { MobileCameraStats } from "./MobileCameraStats";
|
||||
import dynamic from "next/dynamic";
|
||||
@@ -137,6 +138,7 @@ export function AppShell() {
|
||||
|
||||
<TimelineSync />
|
||||
<DataBusSubscriber />
|
||||
<DevModeSubscriber />
|
||||
|
||||
<Header />
|
||||
{isMobile && <MobileHudBar />}
|
||||
|
||||
@@ -60,10 +60,10 @@ export function Header() {
|
||||
return (
|
||||
<header className="header header--mobile glass-panel">
|
||||
<div className="header__brand">
|
||||
<div style={{ display: "flex", alignItems: "center", gap: "8px" }}>
|
||||
<a href="https://worldwideview.dev/" target="_blank" rel="noopener noreferrer" style={{ display: "flex", alignItems: "center", gap: "8px", textDecoration: "none", color: "inherit" }}>
|
||||
<img src="/logo/logo-icon.svg" alt="Logo" style={{ width: 20, height: 20, objectFit: "contain" }} />
|
||||
<div className="header__logo header__logo--compact">WWV</div>
|
||||
</div>
|
||||
</a>
|
||||
<span className="alpha-badge">ALPHA</span>
|
||||
{isDemoAdmin && <span className="alpha-badge" style={{ background: "var(--accent-orange, #f59e0b)" }}>ADMIN</span>}
|
||||
</div>
|
||||
@@ -87,7 +87,7 @@ export function Header() {
|
||||
return (
|
||||
<header className="header glass-panel">
|
||||
<div className="header__brand">
|
||||
<div>
|
||||
<a href="https://worldwideview.dev/" target="_blank" rel="noopener noreferrer" style={{ textDecoration: "none", color: "inherit", cursor: "pointer" }}>
|
||||
<div style={{ display: "flex", alignItems: "center", gap: "10px" }}>
|
||||
<img src="/logo/logo-icon.svg" alt="Logo" style={{ width: 22, height: 22, objectFit: "contain" }} />
|
||||
<div className="header__logo">WORLD WIDE VIEW</div>
|
||||
@@ -95,7 +95,7 @@ export function Header() {
|
||||
{isDemoAdmin && <span className="alpha-badge" style={{ background: "var(--accent-orange, #f59e0b)" }}>ADMIN</span>}
|
||||
</div>
|
||||
<div className="header__subtitle">Geospatial Intelligence</div>
|
||||
</div>
|
||||
</a>
|
||||
<div style={{ marginLeft: "var(--space-xl)" }}>
|
||||
<SearchBar />
|
||||
</div>
|
||||
|
||||
@@ -2,6 +2,7 @@ import { useStore } from "@/core/state/store";
|
||||
import { FilterSection } from "@/components/panels/FilterPanel";
|
||||
import { Info, Key, MessageSquare } from "lucide-react";
|
||||
import { useIsMobile } from "@/core/hooks/useIsMobile";
|
||||
import { useResizablePanel } from "@/core/hooks/useResizablePanel";
|
||||
|
||||
import { IntelTab } from "./IntelTab";
|
||||
import { CacheTab } from "./CacheTab";
|
||||
@@ -11,6 +12,7 @@ import { sectionHeaderStyle } from "./sharedStyles";
|
||||
|
||||
export function DataConfigPanel() {
|
||||
const isMobile = useIsMobile();
|
||||
const { width, startResizing } = useResizablePanel(320, 260, 800, 'right');
|
||||
const configPanelOpen = useStore((s) => s.configPanelOpen);
|
||||
const openMobilePanel = useStore((s) => s.openMobilePanel);
|
||||
const selectedEntity = useStore((s) => s.selectedEntity);
|
||||
@@ -22,8 +24,24 @@ export function DataConfigPanel() {
|
||||
return (
|
||||
<aside
|
||||
className={`sidebar sidebar--right glass-panel ${isMobile ? "sidebar--mobile" : ""} ${(isMobile ? openMobilePanel === "right" : configPanelOpen) ? "" : "sidebar--closed"}`}
|
||||
style={{ width: isMobile ? undefined : 320, padding: "var(--space-xl)", zIndex: 101, borderLeft: "var(--glass-border)" }}
|
||||
style={{ width: isMobile ? undefined : width, padding: "var(--space-xl)", zIndex: 101, borderLeft: "var(--glass-border)" }}
|
||||
>
|
||||
{/* Drag Handle */}
|
||||
{!isMobile && (
|
||||
<div
|
||||
onMouseDown={startResizing}
|
||||
style={{
|
||||
position: 'absolute',
|
||||
top: 0,
|
||||
left: -4,
|
||||
width: 8,
|
||||
height: '100%',
|
||||
cursor: 'col-resize',
|
||||
zIndex: 10,
|
||||
backgroundColor: 'transparent'
|
||||
}}
|
||||
/>
|
||||
)}
|
||||
<div className="sidebar__title" style={{ marginBottom: "var(--space-md)", color: "var(--text-primary)", fontSize: "14px", fontWeight: 600 }}>
|
||||
Data Configuration
|
||||
</div>
|
||||
|
||||
@@ -4,7 +4,6 @@ import { ShieldAlert } from "lucide-react";
|
||||
import { PluginIcon } from "@/components/common/PluginIcon";
|
||||
import { Tooltip } from "@/components/ui/Tooltip";
|
||||
import { pluginManager } from "@/core/plugins/PluginManager";
|
||||
import { BUILT_IN_PLUGIN_IDS } from "@/lib/marketplace/builtinPlugins";
|
||||
import type { WorldPlugin } from "@/core/plugins/PluginTypes";
|
||||
import "./LayerItem.css";
|
||||
|
||||
@@ -26,9 +25,6 @@ const CATEGORY_LABELS: Record<string, string> = {
|
||||
type TrustTier = "built-in" | "verified" | "unverified";
|
||||
|
||||
function getTrust(pluginId: string): TrustTier {
|
||||
if ((BUILT_IN_PLUGIN_IDS as readonly string[]).includes(pluginId)) {
|
||||
return "built-in";
|
||||
}
|
||||
const manifest = pluginManager.getManifest(pluginId);
|
||||
return manifest?.trust ?? "unverified";
|
||||
}
|
||||
|
||||
@@ -1,9 +1,11 @@
|
||||
"use client";
|
||||
|
||||
import { useState } from "react";
|
||||
import { Search } from "lucide-react";
|
||||
|
||||
import { useStore } from "@/core/state/store";
|
||||
import { useIsMobile } from "@/core/hooks/useIsMobile";
|
||||
import { useResizablePanel } from "@/core/hooks/useResizablePanel";
|
||||
import { pluginManager } from "@/core/plugins/PluginManager";
|
||||
import { ImageryPicker } from "./ImageryPicker";
|
||||
import { LayerItem } from "./LayerItem";
|
||||
@@ -17,6 +19,7 @@ import { trackEvent } from "@/lib/analytics";
|
||||
|
||||
export function LayerPanel() {
|
||||
const isMobile = useIsMobile();
|
||||
const { width, startResizing } = useResizablePanel(280, 260, 800, 'left');
|
||||
const leftSidebarOpen = useStore((s) => s.leftSidebarOpen);
|
||||
const openMobilePanel = useStore((s) => s.openMobilePanel);
|
||||
const layers = useStore((s) => s.layers);
|
||||
@@ -28,13 +31,23 @@ export function LayerPanel() {
|
||||
const setSelectedEntity = useStore((s) => s.setSelectedEntity);
|
||||
|
||||
const allPlugins = pluginManager.getAllPlugins();
|
||||
const [searchQuery, setSearchQuery] = useState("");
|
||||
|
||||
// Group by category
|
||||
const grouped: Record<string, typeof allPlugins> = {};
|
||||
const query = searchQuery.toLowerCase();
|
||||
|
||||
allPlugins.forEach((managed) => {
|
||||
const cat = managed.plugin.category;
|
||||
if (!grouped[cat]) grouped[cat] = [];
|
||||
grouped[cat].push(managed);
|
||||
if (
|
||||
!query ||
|
||||
managed.plugin.name.toLowerCase().includes(query) ||
|
||||
managed.plugin.description?.toLowerCase().includes(query) ||
|
||||
managed.plugin.id.toLowerCase().includes(query)
|
||||
) {
|
||||
const cat = managed.plugin.category;
|
||||
if (!grouped[cat]) grouped[cat] = [];
|
||||
grouped[cat].push(managed);
|
||||
}
|
||||
});
|
||||
|
||||
const categoryLabels: Record<string, string> = {
|
||||
@@ -87,7 +100,24 @@ export function LayerPanel() {
|
||||
return (
|
||||
<aside
|
||||
className={`sidebar sidebar--left glass-panel ${isMobile ? "sidebar--mobile" : ""} ${(isMobile ? openMobilePanel === "left" : leftSidebarOpen) ? "" : "sidebar--closed"}`}
|
||||
style={{ width: isMobile ? undefined : width }}
|
||||
>
|
||||
{/* Drag Handle */}
|
||||
{!isMobile && (
|
||||
<div
|
||||
onMouseDown={startResizing}
|
||||
style={{
|
||||
position: 'absolute',
|
||||
top: 0,
|
||||
right: -4,
|
||||
width: 8,
|
||||
height: '100%',
|
||||
cursor: 'col-resize',
|
||||
zIndex: 10,
|
||||
backgroundColor: 'transparent'
|
||||
}}
|
||||
/>
|
||||
)}
|
||||
<div className="sidebar__title">Data Sources</div>
|
||||
|
||||
<div
|
||||
@@ -130,6 +160,33 @@ export function LayerPanel() {
|
||||
|
||||
{activeTab === "layers" && (
|
||||
<div className="layers-tab-content">
|
||||
<div style={{ padding: "0 var(--space-md) var(--space-md) var(--space-md)" }}>
|
||||
<div style={{
|
||||
display: "flex",
|
||||
alignItems: "center",
|
||||
background: "var(--bg-layer-2)",
|
||||
border: "1px solid var(--border-subtle)",
|
||||
borderRadius: "var(--radius-sm)",
|
||||
padding: "0 var(--space-sm)",
|
||||
}}>
|
||||
<Search size={14} style={{ color: "var(--text-muted)", marginRight: 8 }} />
|
||||
<input
|
||||
type="text"
|
||||
placeholder="Search layers..."
|
||||
value={searchQuery}
|
||||
onChange={(e) => setSearchQuery(e.target.value)}
|
||||
style={{
|
||||
flex: 1,
|
||||
background: "transparent",
|
||||
border: "none",
|
||||
color: "var(--text-primary)",
|
||||
fontSize: "13px",
|
||||
padding: "var(--space-sm) 0",
|
||||
outline: "none"
|
||||
}}
|
||||
/>
|
||||
</div>
|
||||
</div>
|
||||
<div className="layers-tab-content__list">
|
||||
{Object.entries(grouped).map(([category, plugins]) => (
|
||||
<div key={category} style={{ marginBottom: "var(--space-lg)" }}>
|
||||
|
||||
@@ -67,7 +67,7 @@ class CacheLayer {
|
||||
}
|
||||
|
||||
async getFromPersistent(pluginId: string): Promise<GeoEntity[] | null> {
|
||||
if (!this.db) return null;
|
||||
if (!this.db || !pluginId) return null;
|
||||
return new Promise((resolve) => {
|
||||
const tx = this.db!.transaction(this.storeName, "readonly");
|
||||
const request = tx.objectStore(this.storeName).get(pluginId);
|
||||
|
||||
@@ -75,7 +75,7 @@ export default function GlobeView() {
|
||||
pluginManager.getAllPlugins().forEach((managed) => {
|
||||
const pluginId = managed.plugin.id;
|
||||
if (!layers[pluginId]?.enabled) return;
|
||||
if (managed.plugin.getLayerConfig().disableDefaultRendering) return;
|
||||
if (managed.plugin.getLayerConfig?.().disableDefaultRendering) return;
|
||||
const entities = entitiesByPlugin[pluginId];
|
||||
if (!Array.isArray(entities)) return;
|
||||
|
||||
|
||||
@@ -35,7 +35,7 @@ export function useViewerInitialization(sceneSettings: any) {
|
||||
sscc.zoomEventTypes = [CameraEventType.WHEEL, CameraEventType.PINCH];
|
||||
|
||||
if ("ontouchstart" in window || navigator.maxTouchPoints > 0) {
|
||||
(sscc as any)._zoomFactor = 15;
|
||||
(sscc as any)._zoomFactor = 5;
|
||||
(sscc as any)._translateFactor = 2;
|
||||
(sscc as any)._tiltFactor = 50;
|
||||
}
|
||||
|
||||
@@ -0,0 +1,50 @@
|
||||
import { useState, useRef, useEffect } from "react";
|
||||
|
||||
export function useResizablePanel(initialWidth: number, minWidth: number, maxWidth: number, direction: 'left' | 'right') {
|
||||
const [width, setWidth] = useState(initialWidth);
|
||||
const isResizing = useRef(false);
|
||||
|
||||
useEffect(() => {
|
||||
document.documentElement.style.setProperty(`--${direction}-sidebar-width`, `${initialWidth}px`);
|
||||
}, [initialWidth, direction]);
|
||||
|
||||
useEffect(() => {
|
||||
const handleMouseMove = (e: MouseEvent) => {
|
||||
if (!isResizing.current) return;
|
||||
|
||||
let newWidth = direction === 'left' ? e.clientX : window.innerWidth - e.clientX;
|
||||
|
||||
if (newWidth < minWidth) newWidth = minWidth;
|
||||
if (newWidth > maxWidth) newWidth = maxWidth;
|
||||
|
||||
setWidth(newWidth);
|
||||
document.documentElement.style.setProperty(`--${direction}-sidebar-width`, `${newWidth}px`);
|
||||
};
|
||||
|
||||
const handleMouseUp = () => {
|
||||
if (isResizing.current) {
|
||||
isResizing.current = false;
|
||||
document.body.style.cursor = 'default';
|
||||
document.body.style.userSelect = 'auto';
|
||||
document.body.classList.remove('is-resizing-sidebar');
|
||||
}
|
||||
};
|
||||
|
||||
document.addEventListener('mousemove', handleMouseMove);
|
||||
document.addEventListener('mouseup', handleMouseUp);
|
||||
return () => {
|
||||
document.removeEventListener('mousemove', handleMouseMove);
|
||||
document.removeEventListener('mouseup', handleMouseUp);
|
||||
};
|
||||
}, [direction, minWidth, maxWidth]);
|
||||
|
||||
const startResizing = (e: React.MouseEvent) => {
|
||||
e.preventDefault();
|
||||
isResizing.current = true;
|
||||
document.body.style.cursor = 'col-resize';
|
||||
document.body.style.userSelect = 'none';
|
||||
document.body.classList.add('is-resizing-sidebar');
|
||||
};
|
||||
|
||||
return { width, startResizing };
|
||||
}
|
||||
@@ -222,6 +222,47 @@ class PluginManager {
|
||||
return this.loadedManifests.get(pluginId);
|
||||
}
|
||||
|
||||
/**
|
||||
* Hot-reloads a plugin (destroys, cache-busts entry, re-registers).
|
||||
* Used exclusively during developer mode when files change on disk.
|
||||
*/
|
||||
async hotReload(pluginId: string): Promise<void> {
|
||||
const managed = this.plugins.get(pluginId);
|
||||
if (!managed) return;
|
||||
|
||||
const wasEnabled = managed.enabled;
|
||||
const manifest = this.loadedManifests.get(pluginId);
|
||||
if (!manifest) return;
|
||||
|
||||
// 1. Destroy old instance
|
||||
try { managed.plugin.destroy(); } catch {}
|
||||
pollingManager.stop(pluginId);
|
||||
this.plugins.delete(pluginId);
|
||||
|
||||
// 2. Cache-bust and re-import
|
||||
const bustEntry = `${manifest.entry}?t=${Date.now()}`;
|
||||
const newManifest = { ...manifest, entry: bustEntry };
|
||||
|
||||
// 3. Re-register
|
||||
try {
|
||||
const plugin = await loadPluginFromManifest(newManifest);
|
||||
if (manifest.id && plugin.id !== manifest.id) {
|
||||
plugin.id = manifest.id;
|
||||
}
|
||||
this.loadedManifests.set(manifest.id, newManifest);
|
||||
await this.registerPlugin(plugin);
|
||||
|
||||
// 4. Restore state
|
||||
if (wasEnabled) {
|
||||
await this.enablePlugin(pluginId);
|
||||
}
|
||||
|
||||
console.log(`[PluginManager] 🔄 Hot-reloaded "${pluginId}"`);
|
||||
} catch (err) {
|
||||
console.error(`[PluginManager] ❌ Failed to hot-reload "${pluginId}":`, err);
|
||||
}
|
||||
}
|
||||
|
||||
destroy(): void {
|
||||
pollingManager.stopAll();
|
||||
this.plugins.forEach((managed) => {
|
||||
|
||||
@@ -9,7 +9,7 @@ export interface ValidationResult {
|
||||
}
|
||||
|
||||
const VALID_TYPES = ["data-layer", "extension"] as const;
|
||||
const VALID_TRUSTS = ["built-in", "verified", "unverified"] as const;
|
||||
const VALID_TRUSTS = ["built-in", "verified", "unverified", "developer"] as const;
|
||||
|
||||
export function validateManifest(
|
||||
manifest: Partial<PluginManifest>,
|
||||
|
||||
@@ -82,11 +82,11 @@ export const createUISlice: StateCreator<AppStore, [], [], UISlice> = (set) => (
|
||||
}
|
||||
set((state) => ({
|
||||
selectedEntity: entity,
|
||||
rightSidebarOpen: entity !== null,
|
||||
configPanelOpen: entity !== null,
|
||||
rightSidebarOpen: entity !== null ? true : state.rightSidebarOpen,
|
||||
configPanelOpen: entity !== null ? true : state.configPanelOpen,
|
||||
openMobilePanel: entity !== null ? state.openMobilePanel : null,
|
||||
mobileRightPanelGlow: entity !== null,
|
||||
activeConfigTab: entity !== null ? "intel" : "filters"
|
||||
activeConfigTab: entity !== null ? "intel" : state.activeConfigTab
|
||||
}));
|
||||
},
|
||||
setHoveredEntity: (entity, screenPos) =>
|
||||
|
||||
@@ -1,6 +0,0 @@
|
||||
/**
|
||||
* Canonical list of built-in plugin IDs that ship with WorldWideView.
|
||||
* Used by the status endpoint to always report these as "installed"
|
||||
* even when they haven't been installed via the marketplace flow.
|
||||
*/
|
||||
export const BUILT_IN_PLUGIN_IDS = [] as const;
|
||||
Reference in new issue
Block a user