kokorobox-native 0.1.0

package/README.md

@@ -0,0 +1,12 @@
+# kokorobox-native
+
+Native Node.js APIs used by KokoroBox Desktop.
+
+The package currently exposes file/icon helpers, rule conversion, Windows elevation and SID
+queries, and Windows Firewall rule management. Platform-specific N-API binaries are selected at
+runtime.
+
+This project is derived from
+[`UruhaLushia/sparkle-native`](https://github.com/UruhaLushia/sparkle-native) and remains licensed
+under GPL-3.0-only. KokoroBox maintains its own package and release lifecycle so the bridge can
+evolve with product-specific APIs.

package/index.d.ts

@@ -0,0 +1,58 @@
+export interface FirewallRule {
+  name: string;
+  applicationPath: string;
+}
+
+export interface RuleConvertOptions {
+  inputTarget?: "mihomo" | "general" | "egern" | "sing-box";
+  inputFormat?:
+    | "yaml"
+    | "mrs"
+    | "text"
+    | "json"
+    | "srs"
+    | "domainset"
+    | "ruleset"
+    | "ipset";
+  inputBehavior?: "auto" | "domain" | "ip" | "classical";
+  outputTarget?: "mihomo" | "general" | "egern" | "sing-box";
+  outputFormat?:
+    | "mrs"
+    | "text"
+    | "yaml"
+    | "json"
+    | "srs"
+    | "domainset"
+    | "ruleset"
+    | "ipset";
+  outputBehavior?: "auto" | "domain" | "ip" | "classical";
+}
+
+export interface RuleOutputInfo {
+  behavior?: string;
+  format: string;
+  count: number;
+}
+
+export interface RuleSkippedItem {
+  rule: string;
+  reason: string;
+}
+
+export interface RuleStringResult {
+  kind: "rules";
+  outputs: Record<string, string>;
+  info: Record<string, RuleOutputInfo>;
+  skipped: RuleSkippedItem[];
+}
+
+export function fileToDataUrl(path: string): string;
+export function fileToStr(
+  path: string,
+  options?: RuleConvertOptions | null,
+): RuleStringResult;
+export function getAppName(path: string): string;
+export function getCurrentUserSid(): string;
+export function isRunningAsAdmin(): boolean;
+export function runElevated(command: string, args?: string[]): number;
+export function setupFirewallRules(rules: FirewallRule[]): void;

package/index.js

@@ -0,0 +1,88 @@
+// prettier-ignore
+/* eslint-disable */
+// @ts-nocheck
+
+import { existsSync } from 'node:fs'
+import { join } from "node:path";
+import { createRequire } from "node:module";
+
+const require = createRequire(import.meta.url);
+const __dirname = new URL(".", import.meta.url).pathname.replace(
+  /^\/([A-Za-z]:)/,
+  "$1",
+);
+
+const packageName = "kokorobox-native";
+const binaryName = "kokorobox-native";
+const loadErrors = [];
+
+function requireLocal(tuple) {
+  const filename = join(__dirname, `${binaryName}.${tuple}.node`);
+  if (!existsSync(filename)) return null;
+  try {
+    return require(filename);
+  } catch (err) {
+    loadErrors.push(err);
+    return null;
+  }
+}
+
+function requirePackage(tuple) {
+  try {
+    return require(`${packageName}-${tuple}`);
+  } catch (err) {
+    loadErrors.push(err);
+    return null;
+  }
+}
+
+function requireBinding(tuple) {
+  return requireLocal(tuple) || requirePackage(tuple);
+}
+
+function requireNative() {
+  if (process.env.NAPI_RS_NATIVE_LIBRARY_PATH) {
+    try {
+      return require(process.env.NAPI_RS_NATIVE_LIBRARY_PATH);
+    } catch (err) {
+      loadErrors.push(err);
+    }
+  }
+
+  if (process.platform === "win32") {
+    if (process.arch === "x64") return requireBinding("win32-x64-msvc");
+    if (process.arch === "arm64") return requireBinding("win32-arm64-msvc");
+    if (process.arch === "ia32") return requireBinding("win32-ia32-msvc");
+  } else if (process.platform === "darwin") {
+    if (process.arch === "x64") return requireBinding("darwin-x64");
+    if (process.arch === "arm64") return requireBinding("darwin-arm64");
+  } else if (process.platform === "linux") {
+    if (process.arch === "x64") return requireBinding("linux-x64-gnu");
+    if (process.arch === "arm64") return requireBinding("linux-arm64-gnu");
+    if (process.arch === "loong64") return requireBinding("linux-loong64-gnu");
+  }
+
+  loadErrors.push(
+    new Error(
+      `Unsupported OS or architecture: ${process.platform} ${process.arch}`,
+    ),
+  );
+  return null;
+}
+
+const nativeBinding = requireNative();
+
+if (!nativeBinding) {
+  const error = new Error("Failed to load kokorobox-native binding");
+  error.cause = loadErrors;
+  throw error;
+}
+
+export default nativeBinding;
+export const fileToDataUrl = nativeBinding.fileToDataUrl;
+export const fileToStr = nativeBinding.fileToStr;
+export const getAppName = nativeBinding.getAppName;
+export const getCurrentUserSid = nativeBinding.getCurrentUserSid;
+export const isRunningAsAdmin = nativeBinding.isRunningAsAdmin;
+export const runElevated = nativeBinding.runElevated;
+export const setupFirewallRules = nativeBinding.setupFirewallRules;

package/package.json

@@ -0,0 +1,61 @@
+{
+  "name": "kokorobox-native",
+  "version": "0.1.0",
+  "description": "KokoroBox native bridge",
+  "type": "module",
+  "main": "index.js",
+  "types": "index.d.ts",
+  "packageManager": "pnpm@11.3.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/amamiyakokoro/kokorobox-native.git"
+  },
+  "homepage": "https://github.com/amamiyakokoro/kokorobox-native",
+  "bugs": {
+    "url": "https://github.com/amamiyakokoro/kokorobox-native/issues"
+  },
+  "license": "GPL-3.0-only",
+  "files": [
+    "index.js",
+    "index.d.ts",
+    "README.md"
+  ],
+  "napi": {
+    "binaryName": "kokorobox-native",
+    "targets": [
+      "x86_64-pc-windows-msvc",
+      "i686-pc-windows-msvc",
+      "aarch64-pc-windows-msvc",
+      "x86_64-apple-darwin",
+      "aarch64-apple-darwin",
+      "x86_64-unknown-linux-gnu",
+      "aarch64-unknown-linux-gnu",
+      "loongarch64-unknown-linux-gnu"
+    ]
+  },
+  "scripts": {
+    "build": "napi build --platform --release --strip --no-js --dts napi.generated.d.ts",
+    "build:debug": "napi build --platform --no-js --dts napi.generated.d.ts",
+    "create-npm-dirs": "napi create-npm-dirs",
+    "artifacts": "napi artifacts"
+  },
+  "devDependencies": {
+    "@napi-rs/cli": "^3.8.6"
+  },
+  "engines": {
+    "node": ">=16"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "optionalDependencies": {
+    "kokorobox-native-win32-x64-msvc": "0.1.0",
+    "kokorobox-native-win32-ia32-msvc": "0.1.0",
+    "kokorobox-native-win32-arm64-msvc": "0.1.0",
+    "kokorobox-native-darwin-x64": "0.1.0",
+    "kokorobox-native-darwin-arm64": "0.1.0",
+    "kokorobox-native-linux-x64-gnu": "0.1.0",
+    "kokorobox-native-linux-arm64-gnu": "0.1.0",
+    "kokorobox-native-linux-loong64-gnu": "0.1.0"
+  }
+}