create-tx5dr-plugin 1.7.12 → 2.0.0

package/dist/index.js

@@ -191,29 +191,36 @@ dist/
 function generateLocaleZh(config) {
     return JSON.stringify({
         pluginDescription: `${config.name} plugin`,
+        enabled: '启用自动发射控制',
+        enabledDesc: '允许此插件通过宿主发射协调器影响当前操作员的自动通联',
     }, null, 2) + '\n';
 }
 function generateLocaleEn(config) {
     return JSON.stringify({
         pluginDescription: `${config.name} plugin`,
+        enabled: 'Enable automatic transmit control',
+        enabledDesc: 'Allow this plugin to influence operator automation through the host coordinator',
     }, null, 2) + '\n';
 }
 // ===== Server-side plugin definition templates =====
 function generateTsUtilityPlugin(config) {
-    return `import type {
-  PluginDefinition,
-  PluginContext,
-  ParsedFT8Message,
-  SlotInfo,
+    return `import {
+  definePlugin,
+  type ParsedFT8Message,
+  type SlotInfo,
 } from '@tx5dr/plugin-api';
 import zhLocale from './locales/zh.json' with { type: 'json' };
 import enLocale from './locales/en.json' with { type: 'json' };
 
-export const plugin: PluginDefinition = {
+export const plugin = definePlugin({
+  apiVersion: 2,
   name: '${config.name}',
   version: '0.1.0',
   type: 'utility',
   description: 'pluginDescription',
+  // Add only the capabilities this plugin actually uses. The host omits all
+  // undeclared privileged APIs from both the TypeScript type and runtime context.
+  permissions: [],
 
   settings: {
     // Define your plugin settings here
@@ -227,18 +234,18 @@ export const plugin: PluginDefinition = {
   },
 
   hooks: {
-    onSlotStart(slotInfo: SlotInfo, messages: ParsedFT8Message[], ctx: PluginContext): void {
+    onSlotStart(slotInfo: SlotInfo, messages: ParsedFT8Message[], ctx): void {
       ctx.log.debug('Slot started', { slotId: slotInfo.id, messageCount: messages.length });
     },
 
-    onDecode(messages: ParsedFT8Message[], ctx: PluginContext): void {
+    onDecode(messages: ParsedFT8Message[], ctx): void {
       // Process decoded messages
       for (const msg of messages) {
         ctx.log.debug('Decoded message', { raw: msg.rawMessage, snr: msg.snr });
       }
     },
   },
-};
+});
 
 export const locales: Record<string, Record<string, string>> = {
   zh: zhLocale,
@@ -249,19 +256,20 @@ export default plugin;
 `;
 }
 function generateTsStrategyPlugin(config) {
-    return `import type {
-  PluginDefinition,
-  PluginContext,
-  StrategyRuntime,
-  StrategyRuntimeSnapshot,
-  StrategyRuntimeSlot,
-  StrategyRuntimeSlotContentUpdate,
-  StrategyRuntimeContext,
-  ParsedFT8Message,
-  StrategyDecision,
-  StrategyDecisionMeta,
-  FrameMessage,
-  SlotInfo,
+    return `import {
+  definePlugin,
+  type StrategyPluginContext,
+  type StrategyRuntime,
+  type StrategyRuntimeSnapshot,
+  type StrategyRuntimeSlot,
+  type StrategyRuntimeSlotContentUpdate,
+  type StrategyRuntimeContext,
+  type StrategyRuntimeCheckpoint,
+  type ParsedFT8Message,
+  type StrategyDecisionResult,
+  type StrategyDecisionMetaV2,
+  type FrameMessage,
+  type SlotInfo,
 } from '@tx5dr/plugin-api';
 import zhLocale from './locales/zh.json' with { type: 'json' };
 import enLocale from './locales/en.json' with { type: 'json' };
@@ -271,11 +279,32 @@ class PluginRuntime implements StrategyRuntime {
   private slots: Partial<Record<StrategyRuntimeSlot, string>> = {};
   private context: StrategyRuntimeContext = {};
 
-  constructor(private ctx: PluginContext) {}
+  constructor(private ctx: StrategyPluginContext) {}
+
+  checkpoint(): StrategyRuntimeCheckpoint {
+    return structuredClone({ state: this.state, slots: this.slots, context: this.context });
+  }
 
-  decide(messages: ParsedFT8Message[], meta?: StrategyDecisionMeta): StrategyDecision {
+  restore(checkpoint: StrategyRuntimeCheckpoint): void {
+    const saved = checkpoint as {
+      state: StrategyRuntimeSlot;
+      slots: Partial<Record<StrategyRuntimeSlot, string>>;
+      context: StrategyRuntimeContext;
+    };
+    this.state = saved.state;
+    this.slots = { ...saved.slots };
+    this.context = { ...saved.context };
+  }
+
+  decide(messages: ParsedFT8Message[], meta: StrategyDecisionMetaV2): StrategyDecisionResult {
+    if (meta.signal.aborted) {
+      throw meta.signal.reason ?? new Error('Strategy decision aborted');
+    }
     // Implement your QSO strategy logic here
-    return {};
+    return {
+      transmission: this.getTransmitText(),
+      snapshot: this.getSnapshot(),
+    };
   }
 
   getTransmitText(): string | null {
@@ -317,15 +346,16 @@ class PluginRuntime implements StrategyRuntime {
   }
 }
 
-export const plugin: PluginDefinition = {
+export const plugin = definePlugin({
+  apiVersion: 2,
   name: '${config.name}',
   version: '0.1.0',
   type: 'strategy',
   description: 'pluginDescription',
+  // Selecting a strategy is the explicit grant for declarative RF decisions.
+  // Add operator:transmit-control only to utility plugins that submit commands.
 
-  settings: {},
-
-  createStrategyRuntime(ctx: PluginContext): StrategyRuntime {
+  createStrategyRuntime(ctx: StrategyPluginContext): StrategyRuntime {
     return new PluginRuntime(ctx);
   },
 
@@ -334,7 +364,7 @@ export const plugin: PluginDefinition = {
       ctx.log.debug('Slot started', { slotId: slotInfo.id });
     },
   },
-};
+});
 
 export const locales: Record<string, Record<string, string>> = {
   zh: zhLocale,
@@ -345,20 +375,22 @@ export default plugin;
 `;
 }
 function generateTsUtilityPluginWithUI(config) {
-    return `import type {
-  PluginDefinition,
-  PluginContext,
-  ParsedFT8Message,
-  SlotInfo,
+    return `import {
+  definePlugin,
+  type ParsedFT8Message,
+  type SlotInfo,
 } from '@tx5dr/plugin-api';
 import zhLocale from './locales/zh.json' with { type: 'json' };
 import enLocale from './locales/en.json' with { type: 'json' };
 
-export const plugin: PluginDefinition = {
+export const plugin = definePlugin({
+  apiVersion: 2,
   name: '${config.name}',
   version: '0.1.0',
   type: 'utility',
   description: 'pluginDescription',
+  // Add only the capabilities this plugin actually uses.
+  permissions: [],
 
   settings: {
     // Define your plugin settings here
@@ -372,11 +404,12 @@ export const plugin: PluginDefinition = {
         entry: 'settings.html',
         title: 'settingsPage',
         accessScope: 'admin',
+        resourceBinding: 'none',
       },
     ],
   },
 
-  onLoad(ctx: PluginContext): void {
+  onLoad(ctx): void {
     ctx.ui.registerPageHandler({
       async onMessage(pageId, action, data) {
         if (action === 'getSettings') {
@@ -396,17 +429,17 @@ export const plugin: PluginDefinition = {
   },
 
   hooks: {
-    onSlotStart(slotInfo: SlotInfo, messages: ParsedFT8Message[], ctx: PluginContext): void {
+    onSlotStart(slotInfo: SlotInfo, messages: ParsedFT8Message[], ctx): void {
       ctx.log.debug('Slot started', { slotId: slotInfo.id, messageCount: messages.length });
     },
 
-    onDecode(messages: ParsedFT8Message[], ctx: PluginContext): void {
+    onDecode(messages: ParsedFT8Message[], ctx): void {
       for (const msg of messages) {
         ctx.log.debug('Decoded message', { raw: msg.rawMessage, snr: msg.snr });
       }
     },
   },
-};
+});
 
 export const locales: Record<string, Record<string, string>> = {
   zh: zhLocale,
@@ -417,12 +450,15 @@ export default plugin;
 `;
 }
 function generateJsUtilityPlugin(config) {
-    return `/** @type {import('@tx5dr/plugin-api').PluginDefinition} */
-export const plugin = {
+    return `import { definePlugin } from '@tx5dr/plugin-api';
+
+export const plugin = definePlugin({
+  apiVersion: 2,
   name: '${config.name}',
   version: '0.1.0',
   type: 'utility',
   description: 'pluginDescription',
+  permissions: [],
 
   settings: {
     // Define your plugin settings here
@@ -439,18 +475,21 @@ export const plugin = {
       }
     },
   },
-};
+});
 
 export default plugin;
 `;
 }
 function generateJsUtilityPluginWithUI(config) {
-    return `/** @type {import('@tx5dr/plugin-api').PluginDefinition} */
-export const plugin = {
+    return `import { definePlugin } from '@tx5dr/plugin-api';
+
+export const plugin = definePlugin({
+  apiVersion: 2,
   name: '${config.name}',
   version: '0.1.0',
   type: 'utility',
   description: 'pluginDescription',
+  permissions: [],
 
   settings: {},
 
@@ -462,6 +501,7 @@ export const plugin = {
         entry: 'settings.html',
         title: 'settingsPage',
         accessScope: 'admin',
+        resourceBinding: 'none',
       },
     ],
   },
@@ -495,7 +535,7 @@ export const plugin = {
       }
     },
   },
-};
+});
 
 export default plugin;
 `;

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "create-tx5dr-plugin",
-  "version": "1.7.12",
+  "version": "2.0.0",
   "type": "module",
   "description": "Scaffold a new TX-5DR plugin project",
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "https://github.com/boybook/tx-5dr.git",
+    "url": "https://github.com/boybook/tx-5dr",
     "directory": "packages/create-tx5dr-plugin"
   },
   "keywords": [