@tak-ps/cloudtak 12.104.1 → 12.104.2

package/README.md

@@ -29,6 +29,17 @@ With the server running locally on port 5001, run the following
 npm run typegen
 ```
 
+### Generate Plugin API docs
+
+Generate TypeDoc output for the exported plugin API in `plugin.ts` with:
+
+```
+npm run doc
+```
+
+The generated HTML documentation is written to `dist/typedoc/`.
+On tagged releases, the release workflow also deploys this output to GitHub Pages.
+
 ### Customize configuration
 
 See [Configuration Reference](https://cli.vuejs.org/config/).

package/dist/types/plugin.d.ts

@@ -2,13 +2,33 @@ import type { App } from 'vue';
 import type { Component } from 'vue';
 import type { Router, RouteRecordRaw } from 'vue-router';
 import type { Pinia } from 'pinia';
-import { type PaneConfig } from './src/stores/float.ts';
 import type { MenuItemConfig } from './src/stores/modules/menu.ts';
 import { type DBFeature } from './src/base/database.ts';
 import { type Observable } from 'rxjs';
 import mapgl from 'maplibre-gl';
 export type { MenuItemConfig };
 export type { DBFeature };
+/**
+ * Configuration stored with a floating pane created by the plugin API
+ */
+export type FloatingPaneConfig = Record<string, unknown> & {
+    _component: Component;
+    _actions?: Component;
+    _props: Record<string, unknown>;
+};
+/**
+ * Public representation of a floating pane managed through the plugin API
+ */
+export interface FloatingPane {
+    uid: string;
+    name?: string;
+    component: Component;
+    config: FloatingPaneConfig;
+    height: number;
+    width: number;
+    x: number;
+    y: number;
+}
 export interface PluginInstance {
     /**
      * Called after `install` if the server has the plugin enabled by default
@@ -141,7 +161,7 @@ export declare class PluginAPI {
             width?: number;
             x?: number;
             y?: number;
-        }) => import("./src/stores/float.ts").Pane<PaneConfig>;
+        }) => FloatingPane;
         /**
          * Remove a floating pane
          * @param uid The unique identifier of the pane to remove

package/dist/types/src/components/CloudTAK/Menu/Mission/MissionLayerCreate.vue.d.ts

@@ -3,11 +3,11 @@ type __VLS_Props = {
     subscription: Subscription;
 };
 declare const __VLS_export: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
-    layer: (...args: any[]) => void;
     cancel: (...args: any[]) => void;
+    layer: (...args: any[]) => void;
 }, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{
-    onLayer?: ((...args: any[]) => any) | undefined;
     onCancel?: ((...args: any[]) => any) | undefined;
+    onLayer?: ((...args: any[]) => any) | undefined;
 }>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
 declare const _default: typeof __VLS_export;
 export default _default;

package/dist/types/src/components/CloudTAK/Menu/Mission/MissionLayerEdit.vue.d.ts

@@ -5,11 +5,11 @@ type __VLS_Props = {
     layer: MissionLayer;
 };
 declare const __VLS_export: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
-    layer: (...args: any[]) => void;
     cancel: (...args: any[]) => void;
+    layer: (...args: any[]) => void;
 }, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{
-    onLayer?: ((...args: any[]) => any) | undefined;
     onCancel?: ((...args: any[]) => any) | undefined;
+    onLayer?: ((...args: any[]) => any) | undefined;
 }>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
 declare const _default: typeof __VLS_export;
 export default _default;

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@tak-ps/cloudtak",
     "type": "module",
-    "version": "12.104.1",
+    "version": "12.104.2",
     "types": "dist/types/plugin.d.ts",
     "files": [
         "dist/types"
@@ -19,6 +19,7 @@
         "typegen": "openapi-typescript http://localhost:5001/api/swagger --output src/derived-types.d.ts",
         "check": "vue-tsc",
         "build:types": "vue-tsc -p tsconfig.build.json",
+        "doc": "typedoc --options typedoc.json",
         "build": "vite build",
         "lint": "eslint --config eslint.config.js ./src/ ./public/ ./plugins/",
         "test": "exit 0"
@@ -99,6 +100,7 @@
         "jsdom": "^28.0.0",
         "openapi-typescript": "^7.0.0",
         "sass-embedded": "^1.86.0",
+        "typedoc": "^0.28.1",
         "typescript": "^5.7.0",
         "typescript-eslint": "^8.20.0",
         "vite": "8.0.0",