@dsz-examaware/plugin-demo 0.1.1

package/dist/renderer/main.d.ts

@@ -0,0 +1,2 @@
+import type { PluginRuntimeContext } from '@dsz-examaware/plugin-sdk';
+export default function setupRenderer(ctx: PluginRuntimeContext): Promise<void>;

package/env.d.ts

@@ -0,0 +1,7 @@
+/// <reference types="vite/client" />
+
+declare module '*.vue' {
+  import type { DefineComponent } from 'vue';
+  const component: DefineComponent<Record<string, unknown>, Record<string, unknown>, any>;
+  export default component;
+}

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@dsz-examaware/plugin-demo",
+  "version": "0.1.1",
+  "private": false,
+  "type": "module",
+  "main": "./dist/main/index.cjs",
+  "module": "./dist/renderer/index.mjs",
+  "types": "./dist/main/index.d.ts",
+  "examaware": {
+    "displayName": "ExamAware Demo Plugin",
+    "description": "A starter plugin showing main + renderer wiring with a settings page.",
+    "targets": {
+      "main": "./dist/main/index.cjs",
+      "renderer": "./dist/renderer/index.mjs"
+    },
+    "services": {
+      "provide": [
+        "hello.message"
+      ],
+      "inject": []
+    },
+    "settings": {
+      "namespace": "examaware-plugin-template",
+      "schema": "./schema.json"
+    }
+  },
+  "dependencies": {
+    "vue": "^3.5.26",
+    "@dsz-examaware/plugin-sdk": "^1.1.1"
+  },
+  "devDependencies": {
+    "@types/node": "^20.19.27",
+    "@vitejs/plugin-vue": "^5.2.4",
+    "npm-run-all2": "^7.0.2",
+    "run-p": "0.0.0",
+    "typescript": "~5.7.3",
+    "vite": "^6.4.1",
+    "vue-tsc": "^2.2.12"
+  },
+  "scripts": {
+    "dev": "run-p dev:renderer dev:main",
+    "dev:renderer": "vite build --watch --mode development --config vite.config.ts",
+    "dev:main": "vite build --watch --mode development --config vite.main.config.ts",
+    "build": "pnpm run build:renderer && pnpm run build:main && pnpm run build:types",
+    "build:renderer": "vite build --config vite.config.ts",
+    "build:main": "vite build --config vite.main.config.ts",
+    "build:types": "vue-tsc --declaration --emitDeclarationOnly --outDir dist",
+    "pack": "pnpm run build && pack-examaware-plugin",
+    "lint": "vue-tsc --noEmit"
+  }
+}

package/schema.json

@@ -0,0 +1,21 @@
+{
+  "type": "object",
+  "properties": {
+    "demo": {
+      "type": "object",
+      "properties": {
+        "clicks": {
+          "type": "integer",
+          "minimum": 0,
+          "default": 0,
+          "description": "Number of times the demo button was clicked."
+        },
+        "message": {
+          "type": "string",
+          "default": "Hello from ExamAware Demo Plugin",
+          "description": "Message shown in main-process heartbeat logs."
+        }
+      }
+    }
+  }
+}

package/src/main/index.ts

@@ -0,0 +1,54 @@
+import { defineExamAwarePlugin } from '@dsz-examaware/plugin-sdk';
+import type { HostedService } from '@dsz-examaware/plugin-sdk';
+
+interface HelloMessage {
+  text: string;
+  timestamp: number;
+}
+
+class HeartbeatService implements HostedService {
+  constructor(private readonly message: HelloMessage) {}
+
+  private interval?: ReturnType<typeof setInterval>;
+
+  async start() {
+    this.interval = setInterval(() => {
+      console.info('[examaware-plugin-template]', this.message.text, new Date().toISOString());
+    }, 10_000);
+  }
+
+  async stop() {
+    if (this.interval) clearInterval(this.interval);
+  }
+}
+
+export default defineExamAwarePlugin((builder) => {
+  builder.configureServices((context, services) => {
+    services.addSingleton('hello.message', () => ({
+      text: context.ctx.config?.message ?? 'Hello from ExamAware Demo Plugin1',
+      timestamp: Date.now()
+    }));
+
+    // Register both class and string tokens to avoid identity mismatches
+    services.addSingleton(HeartbeatService, (sp) => new HeartbeatService(sp.get('hello.message')));
+    services.tryAddSingleton('heartbeat.service', (sp) => sp.get(HeartbeatService));
+    context.ctx.logger.info(
+      '[examaware-plugin-template] registered HeartbeatService/heartbeat.service'
+    );
+  });
+
+  builder.exposeHostService('hello.message', { token: 'hello.message' });
+  builder.addHostedService('heartbeat.service');
+
+  builder.use(async ({ ctx }, next) => {
+    ctx.logger.info('Plugin boot sequence started');
+    await next();
+    ctx.logger.info('Plugin boot sequence completed');
+  });
+
+  builder.configure((host, app) => {
+    host.lifetime.onStarted(() => {
+      app.ctx.logger.info('Host lifetime onStarted hook invoked');
+    });
+  });
+});

package/src/renderer/components/PluginSettingsPage.vue

@@ -0,0 +1,9 @@
+<template>
+  <p>插件设置页面</p>
+</template>
+
+<script setup lang="ts">
+import type { PluginRuntimeContext } from '@dsz-examaware/plugin-sdk';
+
+const props = defineProps<{ ctx: PluginRuntimeContext }>();
+</script>

package/src/renderer/main.ts

@@ -0,0 +1,34 @@
+import { defineComponent, h } from 'vue';
+import type { PluginRuntimeContext } from '@dsz-examaware/plugin-sdk';
+import PluginSettingsPage from './components/PluginSettingsPage.vue';
+
+const SETTINGS_PAGE_ID = 'examaware-plugin-template-settings';
+
+export default async function setupRenderer(ctx: PluginRuntimeContext) {
+  if (ctx.app !== 'renderer') return;
+  const desktopApi = ctx.desktopApi as any;
+  const settingsUi = desktopApi?.ui?.settings;
+  if (!settingsUi) {
+    ctx.logger.warn('Desktop API does not expose settings UI in this build.');
+    return;
+  }
+
+  const SettingsEntry = defineComponent({
+    name: 'ExamAwarePluginSettingsEntry',
+    setup() {
+      return () => h(PluginSettingsPage, { ctx });
+    }
+  });
+
+  const handle = await settingsUi.registerPage({
+    id: SETTINGS_PAGE_ID,
+    label: 'Plugin Settings',
+    icon: 'extension',
+    order: 50,
+    component: () => Promise.resolve(SettingsEntry)
+  });
+
+  if (handle) {
+    ctx.effect(() => () => handle.dispose());
+  }
+}

package/tsconfig.json

@@ -0,0 +1,15 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "module": "ESNext",
+    "moduleResolution": "bundler",
+    "allowImportingTsExtensions": true,
+    "allowSyntheticDefaultImports": true,
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "types": ["node", "vite/client"]
+  },
+  "include": ["src/**/*.ts", "src/**/*.d.ts", "src/**/*.vue", "env.d.ts"],
+  "references": [{ "path": "./tsconfig.node.json" }]
+}

package/tsconfig.node.json

@@ -0,0 +1,10 @@
+{
+  "compilerOptions": {
+    "composite": true,
+    "module": "ESNext",
+    "moduleResolution": "Node",
+    "allowSyntheticDefaultImports": true,
+    "types": ["node"]
+  },
+  "include": ["vite.config.ts", "vite.main.config.ts"]
+}

package/vite.config.ts

@@ -0,0 +1,51 @@
+import { resolve } from 'node:path';
+import { defineConfig } from 'vite';
+import type { ResolvedConfig } from 'vite';
+import vue from '@vitejs/plugin-vue';
+
+const inlineAllDeps = () => ({
+  name: 'inline-all-deps',
+  configResolved(config: ResolvedConfig) {
+    if (!config?.build?.rollupOptions) return;
+    config.build.rollupOptions.external = undefined;
+  }
+});
+
+export default defineConfig(({ mode }) => {
+  const isProd = mode === 'production';
+
+  return {
+    define: {
+      __DEV__: !isProd,
+      'process.env.NODE_ENV': JSON.stringify(isProd ? 'production' : 'development'),
+      'process.env': JSON.stringify({ NODE_ENV: isProd ? 'production' : 'development' }),
+      process: JSON.stringify({ env: { NODE_ENV: isProd ? 'production' : 'development' } })
+    },
+    plugins: [vue(), inlineAllDeps()],
+    base: './',
+    build: {
+      emptyOutDir: false,
+      outDir: 'dist/renderer',
+      sourcemap: !isProd,
+      minify: isProd ? 'esbuild' : false,
+      cssCodeSplit: false,
+      target: 'esnext',
+      watch: isProd ? undefined : {},
+      lib: {
+        entry: resolve(__dirname, 'src/renderer/main.ts'),
+        fileName: () => 'index.mjs',
+        formats: ['es'],
+        name: 'ExamAwareRendererPlugin'
+      },
+      rollupOptions: {
+        output: {
+          format: 'es',
+          entryFileNames: 'index.mjs',
+          inlineDynamicImports: true,
+          chunkFileNames: 'chunks/[name].js',
+          assetFileNames: 'assets/[name][extname]'
+        }
+      }
+    }
+  };
+});

package/vite.main.config.ts

@@ -0,0 +1,37 @@
+import { builtinModules } from 'node:module';
+import { resolve } from 'node:path';
+import { defineConfig } from 'vite';
+
+const builtins = new Set<string>([
+  ...builtinModules,
+  ...builtinModules.map((mod) => `node:${mod}`)
+]);
+// Bundle plugin-sdk; only externalize Electron + Node builtins so the plugin is self-contained.
+const externalDeps = ['electron', 'electron/main', ...builtins];
+
+export default defineConfig(({ mode }) => {
+  const isProd = mode === 'production';
+
+  return {
+    build: {
+      lib: {
+        entry: resolve(__dirname, 'src/main/index.ts'),
+        fileName: () => 'index.cjs',
+        formats: ['cjs']
+      },
+      emptyOutDir: false,
+      outDir: 'dist/main',
+      target: 'node20',
+      sourcemap: !isProd,
+      minify: false,
+      rollupOptions: {
+        external: (source) =>
+          externalDeps.some((dep) => source === dep || source.startsWith(`${dep}/`)),
+        output: {
+          exports: 'default',
+          esModule: false
+        }
+      }
+    }
+  };
+});