@expo-harmony/config-plugins 55.0.10-harmony.1

package/README.md

@@ -0,0 +1,64 @@
+# @expo-harmony/config-plugins
+
+[**GitHub 仓库**](https://github.com/renbaoshuo/expo-harmony/tree/master/packages/config-plugins)
+
+为 Expo Config Plugins 提供 HarmonyOS 平台扩展，包括 `expo.harmony` 配置类型、Harmony Base Mods、原生工程文件与资源 Mod、路径解析及插件资源归属管理。
+
+## 安装
+
+```sh
+npm install @expo-harmony/config-plugins
+```
+
+## 配置类型
+
+在 `app.config.js` 中可使用 `defineExpoHarmonyConfig` 声明 HarmonyOS 配置：
+
+```js
+const { defineExpoHarmonyConfig } = require('@expo-harmony/config-plugins');
+
+module.exports = defineExpoHarmonyConfig({
+  name: 'Example',
+  slug: 'example',
+  platforms: ['ios', 'android', 'harmony'],
+  plugins: ['@expo-harmony/prebuild-config'],
+  harmony: {
+    bundleName: 'com.example.app',
+    versionCode: 1,
+  },
+});
+```
+
+## 编写 HarmonyOS 配置插件
+
+使用对应的 Mod 修改生成后的 HarmonyOS 原生配置。例如，向 `module.json5` 添加信息：
+
+```js
+const { withModuleJson } = require('@expo-harmony/config-plugins');
+
+module.exports = function withExampleMetadata(config) {
+  return withModuleJson(config, (mod) => {
+    const moduleConfig = mod.modResults.module || {};
+    const metadata = Array.isArray(moduleConfig.metadata)
+      ? moduleConfig.metadata
+      : [];
+
+    mod.modResults.module = {
+      ...moduleConfig,
+      metadata: [...metadata, { name: 'example.enabled', value: 'true' }],
+    };
+    return mod;
+  });
+};
+```
+
+包内提供 JSON、文本、资源、自动链接等 Harmony Mod。常用入口包括 `withModuleJson`、`withAppJson`、`withStrings`、`withColors`、`withMedia`、`withCMakeLists`、`withHarmonyDangerousMod` 等，可以在 export 中查看完整列表。
+
+`withHarmonyBaseMods` 负责注册所有 Harmony Base Mods，通常由 `@expo-harmony/prebuild-config` 调用，应用和第三方配置插件无需重复注册。`registerHarmonyConfigPlugin` 可声明插件拥有的资源或 Ability 字段，避免多个插件在生成阶段产生归属冲突。
+
+## Author
+
+**expo-harmony** © [Baoshuo](https://github.com/renbaoshuo), Released under the MIT License.<br>
+Authored and maintained by Baoshuo with help from [contributors](https://github.com/renbaoshuo/expo-harmony/contributors).
+
+> [Personal Website](https://baoshuo.ren) · [Blog](https://blog.baoshuo.ren) · GitHub [@renbaoshuo](https://github.com/renbaoshuo) · Twitter [@baoshuo](https://twitter.com/baoshuo)

package/build/index.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HarmonyPaths = exports.registerHarmonyConfigPlugin = exports.normalizeHarmonyConfigPlugins = exports.getHarmonyConfigPlugins = exports.withWorker = exports.withStrings = exports.withRootOhPackage = exports.withRootHvigor = exports.withReactNativeConfig = exports.withProjectBuildProfile = exports.withProfiles = exports.withNativeInputsStamp = exports.withModuleJson = exports.withMedia = exports.withIndexPage = exports.withHvigorConfig = exports.withHarmonyResources = exports.withHarmonyMod = exports.withHarmonyDangerousMod = exports.withHarmonyBaseMods = exports.withHarmonyAutolinking = exports.withEntryOhPackage = exports.withEntryHvigor = exports.withEntryBuildProfile = exports.withEntryAbility = exports.withCppPackageProvider = exports.withColors = exports.withCngManifest = exports.withCMakeLists = exports.withArkTSPackageProvider = exports.withAppJson = exports.recordManagedFile = exports.HARMONY_MOD_NAMES = exports.normalizeHarmonyConfig = exports.HarmonySdkVersions = exports.stableHarmonyJson = exports.atomicWrite = exports.HarmonyConfigPluginError = exports.defineExpoHarmonyConfig = void 0;
+var config_1 = require("./config");
+Object.defineProperty(exports, "defineExpoHarmonyConfig", { enumerable: true, get: function () { return config_1.defineExpoHarmonyConfig; } });
+var errors_1 = require("./errors");
+Object.defineProperty(exports, "HarmonyConfigPluginError", { enumerable: true, get: function () { return errors_1.HarmonyConfigPluginError; } });
+var files_1 = require("./files");
+Object.defineProperty(exports, "atomicWrite", { enumerable: true, get: function () { return files_1.atomicWrite; } });
+Object.defineProperty(exports, "stableHarmonyJson", { enumerable: true, get: function () { return files_1.stableJson; } });
+var normalizeConfig_1 = require("./normalizeConfig");
+Object.defineProperty(exports, "HarmonySdkVersions", { enumerable: true, get: function () { return normalizeConfig_1.HarmonySdkVersions; } });
+Object.defineProperty(exports, "normalizeHarmonyConfig", { enumerable: true, get: function () { return normalizeConfig_1.normalizeHarmonyConfig; } });
+var mods_1 = require("./mods");
+Object.defineProperty(exports, "HARMONY_MOD_NAMES", { enumerable: true, get: function () { return mods_1.HarmonyModNames; } });
+Object.defineProperty(exports, "recordManagedFile", { enumerable: true, get: function () { return mods_1.recordManagedFile; } });
+Object.defineProperty(exports, "withAppJson", { enumerable: true, get: function () { return mods_1.withAppJson; } });
+Object.defineProperty(exports, "withArkTSPackageProvider", { enumerable: true, get: function () { return mods_1.withArkTSPackageProvider; } });
+Object.defineProperty(exports, "withCMakeLists", { enumerable: true, get: function () { return mods_1.withCMakeLists; } });
+Object.defineProperty(exports, "withCngManifest", { enumerable: true, get: function () { return mods_1.withCngManifest; } });
+Object.defineProperty(exports, "withColors", { enumerable: true, get: function () { return mods_1.withColors; } });
+Object.defineProperty(exports, "withCppPackageProvider", { enumerable: true, get: function () { return mods_1.withCppPackageProvider; } });
+Object.defineProperty(exports, "withEntryAbility", { enumerable: true, get: function () { return mods_1.withEntryAbility; } });
+Object.defineProperty(exports, "withEntryBuildProfile", { enumerable: true, get: function () { return mods_1.withEntryBuildProfile; } });
+Object.defineProperty(exports, "withEntryHvigor", { enumerable: true, get: function () { return mods_1.withEntryHvigor; } });
+Object.defineProperty(exports, "withEntryOhPackage", { enumerable: true, get: function () { return mods_1.withEntryOhPackage; } });
+Object.defineProperty(exports, "withHarmonyAutolinking", { enumerable: true, get: function () { return mods_1.withHarmonyAutolinking; } });
+Object.defineProperty(exports, "withHarmonyBaseMods", { enumerable: true, get: function () { return mods_1.withHarmonyBaseMods; } });
+Object.defineProperty(exports, "withHarmonyDangerousMod", { enumerable: true, get: function () { return mods_1.withHarmonyDangerousMod; } });
+Object.defineProperty(exports, "withHarmonyMod", { enumerable: true, get: function () { return mods_1.withHarmonyMod; } });
+Object.defineProperty(exports, "withHarmonyResources", { enumerable: true, get: function () { return mods_1.withHarmonyResources; } });
+Object.defineProperty(exports, "withHvigorConfig", { enumerable: true, get: function () { return mods_1.withHvigorConfig; } });
+Object.defineProperty(exports, "withIndexPage", { enumerable: true, get: function () { return mods_1.withIndexPage; } });
+Object.defineProperty(exports, "withMedia", { enumerable: true, get: function () { return mods_1.withMedia; } });
+Object.defineProperty(exports, "withModuleJson", { enumerable: true, get: function () { return mods_1.withModuleJson; } });
+Object.defineProperty(exports, "withNativeInputsStamp", { enumerable: true, get: function () { return mods_1.withNativeInputsStamp; } });
+Object.defineProperty(exports, "withProfiles", { enumerable: true, get: function () { return mods_1.withProfiles; } });
+Object.defineProperty(exports, "withProjectBuildProfile", { enumerable: true, get: function () { return mods_1.withProjectBuildProfile; } });
+Object.defineProperty(exports, "withReactNativeConfig", { enumerable: true, get: function () { return mods_1.withReactNativeConfig; } });
+Object.defineProperty(exports, "withRootHvigor", { enumerable: true, get: function () { return mods_1.withRootHvigor; } });
+Object.defineProperty(exports, "withRootOhPackage", { enumerable: true, get: function () { return mods_1.withRootOhPackage; } });
+Object.defineProperty(exports, "withStrings", { enumerable: true, get: function () { return mods_1.withStrings; } });
+Object.defineProperty(exports, "withWorker", { enumerable: true, get: function () { return mods_1.withWorker; } });
+var ownership_1 = require("./ownership");
+Object.defineProperty(exports, "getHarmonyConfigPlugins", { enumerable: true, get: function () { return ownership_1.getHarmonyConfigPlugins; } });
+Object.defineProperty(exports, "normalizeHarmonyConfigPlugins", { enumerable: true, get: function () { return ownership_1.normalizeHarmonyConfigPlugins; } });
+Object.defineProperty(exports, "registerHarmonyConfigPlugin", { enumerable: true, get: function () { return ownership_1.registerHarmonyConfigPlugin; } });
+var paths_1 = require("./paths");
+Object.defineProperty(exports, "HarmonyPaths", { enumerable: true, get: function () { return paths_1.HarmonyPaths; } });

package/package.json

@@ -0,0 +1,62 @@
+{
+  "name": "@expo-harmony/config-plugins",
+  "version": "55.0.10-harmony.1",
+  "keywords": [
+    "react-native",
+    "expo",
+    "expo-harmony",
+    "harmonyos"
+  ],
+  "homepage": "https://github.com/renbaoshuo/expo-harmony/tree/master/packages/config-plugins#readme",
+  "bugs": "https://github.com/renbaoshuo/expo-harmony/issues",
+  "license": "MIT",
+  "author": "Baoshuo <i@baoshuo.ren>",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/renbaoshuo/expo-harmony.git",
+    "directory": "packages/config-plugins"
+  },
+  "main": "build/index.js",
+  "types": "build/index.d.ts",
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "prepare": "yarn build",
+    "typecheck": "tsc --noEmit -p tsconfig.json"
+  },
+  "exports": {
+    ".": {
+      "types": "./build/index.d.ts",
+      "require": "./build/index.js",
+      "default": "./build/index.js"
+    },
+    "./native-inputs": {
+      "types": "./build/nativeInputs.d.ts",
+      "require": "./build/nativeInputs.js",
+      "default": "./build/nativeInputs.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "dependencies": {
+    "@expo/config-plugins": "55.0.10",
+    "@expo/config-types": "^55.0.5",
+    "json5": "2.2.3"
+  },
+  "peerDependencies": {
+    "@expo/config": "55.0.17"
+  },
+  "peerDependenciesMeta": {
+    "@expo/config": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@types/node": "18.19.0",
+    "typescript": "^6.0.3"
+  },
+  "engines": {
+    "node": ">=20"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/src/config.ts

@@ -0,0 +1,79 @@
+import type { ExpoConfig } from '@expo/config-types';
+
+export type HarmonyPlatform = 'harmony';
+export type ExpoKnownPlatform = NonNullable<ExpoConfig['platforms']>[number];
+export type ExpoHarmonyPlatform = ExpoKnownPlatform | HarmonyPlatform;
+export type HarmonyDeviceType = 'phone' | 'tablet' | '2in1';
+export type HarmonyOrientation
+  = | 'default'
+    | 'portrait'
+    | 'landscape'
+    | 'portrait_inverted'
+    | 'landscape_inverted'
+    | 'auto_rotation';
+
+export interface HarmonyPermission {
+  name: string;
+  reason?: string;
+  usedScene?: { abilities?: string[]; when?: 'inuse' | 'always' };
+}
+
+export interface HarmonySkill {
+  entities?: string[];
+  actions?: string[];
+  uris?: Array<Record<string, string>>;
+}
+
+export interface HarmonyFontDefinition {
+  path: string;
+  weight?: number;
+  style?: 'normal' | 'italic';
+}
+
+export type HarmonyFont
+  = | string
+    | {
+      fontFamily: string;
+      fontDefinitions: HarmonyFontDefinition[];
+    };
+
+export interface HarmonyConfig {
+  bundleName: string;
+  moduleName?: string;
+  abilityName?: string;
+  productName?: string;
+  vendor?: string;
+  versionCode?: number;
+  versionName?: string;
+  targetApiVersion?: number;
+  /** Harmony SDK label written to build-profile.json5, e.g. 6.0.0(20). Its API must match targetApiVersion. */
+  targetSdkVersion?: number | string;
+  /** API number, or a full Harmony SDK label ending in the API number. */
+  compatibleSdkVersion?: number | string;
+  deviceTypes?: HarmonyDeviceType[];
+  permissions?: HarmonyPermission[];
+  skills?: HarmonySkill[];
+  /** URL schemes the app may inspect with Linking.canOpenURL. http, https, and expo.scheme are added automatically. */
+  querySchemes?: string[];
+  icon?: string;
+  label?: string;
+  backgroundColor?: string;
+  orientation?: HarmonyOrientation;
+  userInterfaceStyle?: 'light' | 'dark' | 'automatic';
+  jsEngine?: 'hermes';
+  abiFilters?: string[];
+  signingConfigFile?: string;
+  /** Fonts bundled when the `@expo-harmony/expo-font` config plugin is registered. */
+  fonts?: HarmonyFont[];
+}
+
+export type ExpoConfigWithHarmony = Omit<ExpoConfig, 'platforms'> & {
+  platforms?: ExpoHarmonyPlatform[];
+  harmony?: HarmonyConfig;
+};
+
+export function defineExpoHarmonyConfig<
+  T extends { expo: ExpoConfigWithHarmony } | ExpoConfigWithHarmony,
+>(config: T): T {
+  return config;
+}

package/src/errors.ts

@@ -0,0 +1,21 @@
+export interface HarmonyConfigPluginErrorOptions {
+  cause?: unknown;
+  file?: string;
+  operation?: string;
+}
+
+export class HarmonyConfigPluginError extends Error {
+  declare readonly code: string;
+  declare readonly operation: string;
+  declare readonly file?: string;
+
+  constructor(code: string, message: string, options: HarmonyConfigPluginErrorOptions = {}) {
+    super(message, options.cause === undefined ? undefined : { cause: options.cause });
+
+    this.name = 'HarmonyConfigPluginError';
+    this.code = code;
+    this.operation = options.operation || 'config-plugin';
+
+    if (options.file) this.file = options.file;
+  }
+}

package/src/files.ts

@@ -0,0 +1,79 @@
+import crypto from 'node:crypto';
+import fs from 'node:fs';
+import path from 'node:path';
+import JSON5 from 'json5';
+
+import { HarmonyConfigPluginError } from './errors';
+
+function sortValue(value: unknown): unknown {
+  if (Array.isArray(value)) return value.map(sortValue);
+  if (value && typeof value === 'object' && !Buffer.isBuffer(value)) {
+    const record = value as Record<string, unknown>;
+    const entries = Object.keys(record).sort().map(key => [key, sortValue(record[key])]);
+
+    return Object.fromEntries(entries);
+  }
+
+  return value;
+}
+
+export function stableJson(value: unknown): string {
+  return `${JSON.stringify(sortValue(value), null, 2)}\n`;
+}
+
+export async function readJson5<T>(file: string, fallback: T, modName: string): Promise<T> {
+  try {
+    const source = await fs.promises.readFile(file, 'utf8');
+
+    return JSON5.parse(source) as T;
+  } catch (cause) {
+    if ((cause as NodeJS.ErrnoException).code === 'ENOENT') return structuredClone(fallback);
+
+    throw new HarmonyConfigPluginError(
+      'ERR_HARMONY_JSON5_INVALID',
+      `Cannot parse ${file} for harmony.${modName}: ${(cause as Error).message}`,
+      { cause, file, operation: `harmony.${modName}.read` }
+    );
+  }
+}
+
+export async function readText(file: string, fallback = ''): Promise<string> {
+  try {
+    return await fs.promises.readFile(file, 'utf8');
+  } catch (cause) {
+    if ((cause as NodeJS.ErrnoException).code === 'ENOENT') return fallback;
+
+    throw new HarmonyConfigPluginError(
+      'ERR_HARMONY_TEXT_INVALID',
+      `Cannot read ${file}: ${(cause as Error).message}`,
+      { cause, file, operation: 'harmony.mod.read' }
+    );
+  }
+}
+
+export async function atomicWrite(file: string, content: string | Uint8Array): Promise<void> {
+  const directory = path.dirname(file);
+  const temporary = path.join(
+    directory,
+    `.${path.basename(file)}.${process.pid}.${crypto.randomBytes(6).toString('hex')}.tmp`
+  );
+
+  await fs.promises.mkdir(directory, { recursive: true });
+
+  try {
+    await fs.promises.writeFile(temporary, content);
+    await fs.promises.rename(temporary, file);
+  } finally {
+    await fs.promises.rm(temporary, { force: true }).catch(() => {});
+  }
+}
+
+export async function writeJson5(file: string, value: unknown): Promise<void> {
+  await atomicWrite(file, stableJson(value));
+}
+
+export async function sha256File(file: string): Promise<string> {
+  const data = Uint8Array.from(await fs.promises.readFile(file));
+
+  return crypto.createHash('sha256').update(data).digest('hex');
+}

package/src/index.ts

@@ -0,0 +1,71 @@
+export { defineExpoHarmonyConfig } from './config';
+export type {
+  ExpoConfigWithHarmony,
+  ExpoHarmonyPlatform,
+  ExpoKnownPlatform,
+  HarmonyConfig,
+  HarmonyDeviceType,
+  HarmonyFont,
+  HarmonyFontDefinition,
+  HarmonyOrientation,
+  HarmonyPermission,
+  HarmonyPlatform,
+  HarmonySkill,
+} from './config';
+export { HarmonyConfigPluginError } from './errors';
+export { atomicWrite, stableJson as stableHarmonyJson } from './files';
+export { HarmonySdkVersions, normalizeHarmonyConfig } from './normalizeConfig';
+export type { HarmonyExpoConfig, NormalizedHarmonyConfig } from './normalizeConfig';
+export {
+  HarmonyModNames as HARMONY_MOD_NAMES,
+  recordManagedFile,
+  withAppJson,
+  withArkTSPackageProvider,
+  withCMakeLists,
+  withCngManifest,
+  withColors,
+  withCppPackageProvider,
+  withEntryAbility,
+  withEntryBuildProfile,
+  withEntryHvigor,
+  withEntryOhPackage,
+  withHarmonyAutolinking,
+  withHarmonyBaseMods,
+  withHarmonyDangerousMod,
+  withHarmonyMod,
+  withHarmonyResources,
+  withHvigorConfig,
+  withIndexPage,
+  withMedia,
+  withModuleJson,
+  withNativeInputsStamp,
+  withProfiles,
+  withProjectBuildProfile,
+  withReactNativeConfig,
+  withRootHvigor,
+  withRootOhPackage,
+  withStrings,
+  withWorker,
+} from './mods';
+export type {
+  HarmonyJson,
+  HarmonyMediaDescriptor,
+  HarmonyMediaMap,
+  HarmonyModAction,
+  HarmonyModName,
+  HarmonyResourceMap,
+} from './mods';
+export {
+  getHarmonyConfigPlugins,
+  normalizeHarmonyConfigPlugins,
+  registerHarmonyConfigPlugin,
+} from './ownership';
+export type { HarmonyConfigPluginOwnership } from './ownership';
+export { HarmonyPaths } from './paths';
+export type {
+  HarmonyManagedPaths,
+  HarmonyPathsApi,
+  HarmonyProjectPathCandidates,
+  HarmonyProjectPaths,
+  HarmonyResourcePaths,
+} from './paths';