@oniroproject/capacitor-openharmony 0.1.0

package/assets/native-template/entry/src/test/List.test.ets

@@ -0,0 +1,5 @@
+import localUnitTest from './LocalUnit.test';
+
+export default function testsuite() {
+  localUnitTest();
+}

package/assets/native-template/entry/src/test/LocalUnit.test.ets

@@ -0,0 +1,33 @@
+import { describe, beforeAll, beforeEach, afterEach, afterAll, it, expect } from '@ohos/hypium';
+
+export default function localUnitTest() {
+  describe('localUnitTest', () => {
+    // Defines a test suite. Two parameters are supported: test suite name and test suite function.
+    beforeAll(() => {
+      // Presets an action, which is performed only once before all test cases of the test suite start.
+      // This API supports only one parameter: preset action function.
+    });
+    beforeEach(() => {
+      // Presets an action, which is performed before each unit test case starts.
+      // The number of execution times is the same as the number of test cases defined by **it**.
+      // This API supports only one parameter: preset action function.
+    });
+    afterEach(() => {
+      // Presets a clear action, which is performed after each unit test case ends.
+      // The number of execution times is the same as the number of test cases defined by **it**.
+      // This API supports only one parameter: clear action function.
+    });
+    afterAll(() => {
+      // Presets a clear action, which is performed after all test cases of the test suite end.
+      // This API supports only one parameter: clear action function.
+    });
+    it('assertContain', 0, () => {
+      // Defines a test case. This API supports three parameters: test case name, filter parameter, and test case function.
+      let a = 'abc';
+      let b = 'b';
+      // Defines a variety of assertion methods, which are used to declare expected boolean conditions.
+      expect(a).assertContain(b);
+      expect(a).assertEqual(a);
+    });
+  });
+}

package/assets/native-template/hvigor/hvigor-config.json5

@@ -0,0 +1,8 @@
+{
+  "modelVersion": "5.1.0",
+  "dependencies": {},
+  "execution": {},
+  "logging": {},
+  "debugging": {},
+  "nodeOptions": {}
+}

package/assets/native-template/hvigorfile.ts

@@ -0,0 +1,6 @@
+import { appTasks } from '@ohos/hvigor-ohos-plugin';
+
+export default {
+  system: appTasks, /* Built-in plugin of Hvigor. It cannot be modified. */
+  plugins: []       /* Custom plugin to extend the functionality of Hvigor. */
+}

package/assets/native-template/oh-package.json5

@@ -0,0 +1,9 @@
+{
+  "modelVersion": "5.1.0",
+  "description": "Please describe the basic information.",
+  "dependencies": {},
+  "devDependencies": {
+    "@ohos/hypium": "1.0.24",
+    "@ohos/hamock": "1.0.0"
+  }
+}

package/dist/add.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.addOpenHarmony = addOpenHarmony;
+const fs_extra_1 = require("fs-extra");
+const path_1 = require("path");
+const common_1 = require("./common");
+async function addOpenHarmony(config) {
+    const projectRoot = process.env.CAPACITOR_ROOT_DIR || process.cwd();
+    const platformDir = (0, path_1.join)(projectRoot, 'openharmony');
+    if ((0, fs_extra_1.existsSync)(platformDir)) {
+        console.log('OpenHarmony platform already exists.');
+        return;
+    }
+    console.log('Adding OpenHarmony platform...');
+    const templateDir = (0, path_1.join)(__dirname, '../assets/native-template');
+    try {
+        await (0, fs_extra_1.copy)(templateDir, platformDir);
+        console.log('Template copied.');
+        if ((config === null || config === void 0 ? void 0 : config.appId) && (config === null || config === void 0 ? void 0 : config.appName)) {
+            await (0, common_1.updateAppJson5)(projectRoot, config.appId, config.appName);
+            console.log('App configuration updated.');
+        }
+    }
+    catch (e) {
+        console.error('Failed to add OpenHarmony platform:', e);
+    }
+}

package/dist/common.js

@@ -0,0 +1,58 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getCapacitorConfig = getCapacitorConfig;
+exports.updateAppJson5 = updateAppJson5;
+const path_1 = require("path");
+async function getCapacitorConfig() {
+    try {
+        const configPath = (0, path_1.join)(process.cwd(), 'capacitor.config.ts');
+        // Using dynamic import for ts config or require for json
+        // For simplicity in this environment, we might need a more robust config loader
+        // But let's assume standard capacitor CLI usage where config is available
+        // Actually, @capacitor/cli might not expose a simple config loader for plugins.
+        // We will implement a basic reader for now.
+        return require((0, path_1.join)(process.cwd(), 'capacitor.config.json'));
+    }
+    catch (e) {
+        try {
+            // Fallback for ts config - in a real plugin we'd use capacitor's config loader
+            // For this POC, we'll try to read capacitor.config.json if ts fails
+            // or just mock it if we are running in the demo app which has ts.
+            // NOTE: compiled CLI won't run TS directly.
+            // practical approach: expect capacitor.config.json or parse basic TS
+            console.warn('Could not read capacitor.config.json, manual config might be needed');
+            return null;
+        }
+        catch (e2) {
+            return null;
+        }
+    }
+}
+async function updateAppJson5(projectRoot, appId, appName) {
+    const appJsonPath = (0, path_1.join)(projectRoot, 'openharmony', 'AppScope', 'app.json5');
+    try {
+        // json5 is not strict json, so standard require/JSON.parse might fail if it has comments.
+        // However, native-template app.json5 is usually simple.
+        // We'll use fs-extra to read as text and replace regex for safety if we don't want a json5 parser dep.
+        const fs = require('fs-extra');
+        let content = await fs.readFile(appJsonPath, 'utf8');
+        // Simple regex replacement to preserve comments/formatting if possible
+        content = content.replace(/"bundleName":\s*".*?"/, `"bundleName": "${appId}"`);
+        content = content.replace(/"label":\s*".*?"/, `"label": "$string:app_name"`); // Usually points to resource
+        // Also need to update string resource for app_name
+        const stringResPath = (0, path_1.join)(projectRoot, 'openharmony', 'AppScope', 'resources', 'base', 'element', 'string.json');
+        const strings = await fs.readJson(stringResPath);
+        const appNameEntry = strings.string.find((e) => e.name === 'app_name');
+        if (appNameEntry) {
+            appNameEntry.value = appName;
+        }
+        else {
+            strings.string.push({ name: 'app_name', value: appName });
+        }
+        await fs.writeJson(stringResPath, strings, { spaces: 2 });
+        await fs.writeFile(appJsonPath, content);
+    }
+    catch (e) {
+        console.error('Error updating AppScope/app.json5', e);
+    }
+}

package/dist/index.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.add = add;
+exports.copy = copy;
+exports.update = update;
+exports.open = open;
+const add_1 = require("./add");
+const sync_1 = require("./sync");
+async function add(config) {
+    await (0, add_1.addOpenHarmony)(config);
+}
+async function copy(config) {
+    await (0, sync_1.sync)(config);
+}
+async function update(config) {
+    console.log('Update command not implemented yet (plugins)');
+}
+async function open(config) {
+    console.log('Open command not implemented yet (DevEco Studio)');
+}

package/dist/sync.js

@@ -0,0 +1,191 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sync = sync;
+const fs_extra_1 = require("fs-extra");
+const path_1 = require("path");
+async function sync(config) {
+    const projectRoot = process.env.CAPACITOR_ROOT_DIR || process.cwd();
+    const webDir = config.webDir || 'dist';
+    const src = (0, path_1.join)(projectRoot, webDir);
+    const dest = (0, path_1.join)(projectRoot, 'openharmony/entry/src/main/resources/rawfile/www');
+    console.log(`Syncing ${src} to ${dest}...`);
+    if (!(0, fs_extra_1.existsSync)(src)) {
+        console.error(`Web directory ${src} does not exist. Did you build your web app?`);
+        return;
+    }
+    try {
+        // Clean destination? Maybe not needed as copy overwrites
+        await (0, fs_extra_1.mkdirp)(dest);
+        await (0, fs_extra_1.copy)(src, dest);
+        console.log('Web assets synced.');
+        await updateAppName(projectRoot, config.appName);
+        await generatePluginRegistry(projectRoot);
+    }
+    catch (e) {
+        console.error('Sync failed:', e);
+    }
+}
+async function updateAppName(projectRoot, appName) {
+    const stringJsonPath = (0, path_1.join)(projectRoot, 'openharmony/entry/src/main/resources/base/element/string.json');
+    if (!(0, fs_extra_1.existsSync)(stringJsonPath)) {
+        console.warn(`string.json not found at ${stringJsonPath}. Skipping App Name sync.`);
+        return;
+    }
+    try {
+        const fs = require('fs-extra');
+        const content = await fs.readJson(stringJsonPath);
+        let updated = false;
+        if (content.string) {
+            const labelItem = content.string.find((item) => item.name === 'EntryAbility_label');
+            if (labelItem) {
+                labelItem.value = appName;
+                updated = true;
+            }
+        }
+        if (updated) {
+            await fs.writeJson(stringJsonPath, content, { spaces: 2 });
+            console.log(`Updated App Name to "${appName}" in string.json`);
+        }
+        else {
+            console.warn('EntryAbility_label not found in string.json');
+        }
+    }
+    catch (e) {
+        console.error('Failed to update App Name:', e);
+    }
+}
+async function generatePluginRegistry(projectRoot) {
+    var _a;
+    console.log('Generating PluginRegistry...');
+    const packageJsonPath = (0, path_1.join)(projectRoot, 'package.json');
+    if (!(0, fs_extra_1.existsSync)(packageJsonPath)) {
+        console.error(`package.json not found at ${packageJsonPath}`);
+        return;
+    }
+    const packageJson = await Promise.resolve(`${packageJsonPath}`).then(s => __importStar(require(s)));
+    const dependencies = { ...packageJson.dependencies, ...packageJson.devDependencies };
+    const plugins = [];
+    for (const depName of Object.keys(dependencies)) {
+        try {
+            const depPackagePath = (0, path_1.join)(projectRoot, 'node_modules', depName, 'package.json');
+            if (!(0, fs_extra_1.existsSync)(depPackagePath)) {
+                continue;
+            }
+            const depPackage = await Promise.resolve(`${depPackagePath}`).then(s => __importStar(require(s)));
+            if ((_a = depPackage.capacitor) === null || _a === void 0 ? void 0 : _a.openharmony) {
+                plugins.push({
+                    name: depName,
+                    ...depPackage.capacitor.openharmony
+                });
+            }
+        }
+        catch (e) {
+            // ignore
+        }
+    }
+    // Check for local plugins or special overrides
+    const registryPath = (0, path_1.join)(projectRoot, 'openharmony/entry/src/main/ets/capacitor/PluginRegistry.ets');
+    const pluginsPath = (0, path_1.join)(projectRoot, 'openharmony/entry/src/main/ets/capacitor/plugins');
+    // Ensure plugins directory exists
+    await (0, fs_extra_1.mkdirp)(pluginsPath);
+    const imports = [];
+    const registrations = [];
+    for (const p of plugins) {
+        if (p.src) {
+            // Copy the plugin source file
+            const pluginSrcAbsPath = (0, path_1.join)(projectRoot, 'node_modules', p.name, p.src);
+            const pluginDestPath = (0, path_1.join)(pluginsPath, p.src);
+            if ((0, fs_extra_1.existsSync)(pluginSrcAbsPath)) {
+                await (0, fs_extra_1.copy)(pluginSrcAbsPath, pluginDestPath);
+                console.log(`Copied ${p.name} source to ${pluginDestPath}`);
+                // Assume className is derived from filename if not provided, or we can parse it.
+                // For now, let's assume the class name is standard PascalCase of the plugin name + "Plugin"
+                // Or we can try to find the class export in the file content? 
+                // For MVP, let's stick to the convention: Filename "Device.ets" -> class "DevicePlugin"
+                // AND we also need to know the import path.
+                // Import path will be `./plugins/${filename_without_ext}`
+                const filename = p.src.replace('.ets', '');
+                const className = `${filename}Plugin`; // Convention
+                imports.push(`import { ${className} } from './plugins/${filename}';`);
+                registrations.push(`this.plugins.set('${filename}', new ${className}(this.bridge, this.context));`);
+            }
+            else {
+                console.warn(`Plugin source not found for ${p.name} at ${pluginSrcAbsPath}`);
+            }
+        }
+    }
+    const content = `import { CapacitorPlugin } from './CapacitorPlugin';
+import { CapacitorBridge } from './CapacitorBridge';
+import { PluginHeader, PluginMethod } from './BridgeInterfaces';
+import { common } from '@kit.AbilityKit';
+${imports.join('\n')}
+
+export class PluginRegistry {
+  private plugins: Map<string, CapacitorPlugin> = new Map();
+  private bridge: CapacitorBridge;
+  private context: common.UIAbilityContext;
+
+  constructor(bridge: CapacitorBridge, context: common.UIAbilityContext) {
+    this.bridge = bridge;
+    this.context = context;
+    this.registerPlugins();
+  }
+
+  private registerPlugins() {
+    ${registrations.join('\n    ')}
+  }
+
+  getPlugin(pluginId: string): CapacitorPlugin | undefined {
+    return this.plugins.get(pluginId);
+  }
+
+  getPluginHeaders(): PluginHeader[] {
+    let headers: PluginHeader[] = [];
+    this.plugins.forEach((plugin) => {
+      headers.push({
+        name: plugin.getPluginId(),
+        methods: plugin.getMethods().map((m): PluginMethod => {
+          return { name: m, rtype: 'promise' };
+        })
+      });
+    });
+    return headers;
+  }
+}
+`;
+    await (0, fs_extra_1.writeFile)(registryPath, content);
+    console.log('PluginRegistry.ets generated.');
+}

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@oniroproject/capacitor-openharmony",
+  "version": "0.1.0",
+  "description": "OpenHarmony platform adapter for Capacitor",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/eclipse-oniro4openharmony/capacitor-openharmony.git"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc",
+    "prepublishOnly": "npm run build",
+    "capacitor:add": "node -e \"require('./dist/index').add(JSON.parse(process.env.CAPACITOR_CONFIG))\"",
+    "capacitor:copy": "node -e \"require('./dist/index').copy(JSON.parse(process.env.CAPACITOR_CONFIG))\"",
+    "capacitor:update": "node -e \"require('./dist/index').update(JSON.parse(process.env.CAPACITOR_CONFIG))\"",
+    "capacitor:open": "node -e \"require('./dist/index').open(JSON.parse(process.env.CAPACITOR_CONFIG))\""
+  },
+  "keywords": [
+    "capacitor",
+    "openharmony",
+    "ionic"
+  ],
+  "author": "Ionic Team",
+  "license": "MIT",
+  "peerDependencies": {
+    "@capacitor/core": "^6.0.0"
+  },
+  "dependencies": {
+    "@capacitor/cli": "^6.0.0",
+    "commander": "^12.0.0",
+    "fs-extra": "^11.0.0",
+    "prompts": "^2.4.0"
+  },
+  "devDependencies": {
+    "@types/fs-extra": "^11.0.0",
+    "@types/node": "^20.0.0",
+    "@types/prompts": "^2.4.0",
+    "typescript": "^5.0.0"
+  },
+  "files": [
+    "dist/",
+    "assets/"
+  ],
+  "capacitor": {
+    "platform": "openharmony"
+  }
+}