mirror of
https://github.com/unraid/api.git
synced 2026-01-01 14:10:10 -06:00
- **New Features** - Created a dynamic plugin system for the API to enable community augmentation of GraphQL, CLI, and Cron functionalities capabilities. - Included an example plugin under `packages/unraid-api-plugin-health` that adds a new graphql query for API health checks. - Added `rc.unraid-api` commands for backing up, restoring, and installing production dependencies, streamlining maintenance and deployment. - Improved dependency vendoring by bundling a versioned pnpm store (instead of `node_modules`). Versioning will allow users to add plugins to a specific api release without requiring an internet connection on subsequent reboots. - **Chores** - Upgraded build workflows and versioning processes to ensure more reliable artifact handling and production packaging.
119 lines
3.4 KiB
TypeScript
119 lines
3.4 KiB
TypeScript
import { readFile, writeFile, mkdir, rename } from "fs/promises";
|
|
import { $ } from "zx";
|
|
import { escape as escapeHtml } from "html-sloppy-escaper";
|
|
import { dirname, join } from "node:path";
|
|
import { getTxzName, pluginName, startingDir } from "./utils/consts";
|
|
import { getAssetUrl, getPluginUrl } from "./utils/bucket-urls";
|
|
import { getMainTxzUrl } from "./utils/bucket-urls";
|
|
import {
|
|
deployDir,
|
|
getDeployPluginPath,
|
|
getRootPluginPath,
|
|
} from "./utils/paths";
|
|
import { PluginEnv, setupPluginEnv } from "./cli/setup-plugin-environment";
|
|
import { cleanupPluginFiles } from "./utils/cleanup";
|
|
import { bundlePnpmStore, getPnpmBundleName } from "./build-pnpm-store";
|
|
|
|
/**
|
|
* Check if git is available
|
|
*/
|
|
const checkGit = async () => {
|
|
try {
|
|
await $`git log -1 --pretty=%B`;
|
|
} catch (err) {
|
|
console.error(`Error: git not available: ${err}`);
|
|
throw new Error(`Git not available: ${err}`);
|
|
}
|
|
};
|
|
|
|
const moveTxzFile = async (txzPath: string, pluginVersion: string) => {
|
|
const txzName = getTxzName(pluginVersion);
|
|
await rename(txzPath, join(deployDir, txzName));
|
|
};
|
|
|
|
function updateEntityValue(
|
|
xmlString: string,
|
|
entityName: string,
|
|
newValue: string
|
|
) {
|
|
console.log("Updating entity:", entityName, "with value:", newValue);
|
|
const regex = new RegExp(`<!ENTITY ${entityName} "[^"]*">`);
|
|
if (regex.test(xmlString)) {
|
|
return xmlString.replace(regex, `<!ENTITY ${entityName} "${newValue}">`);
|
|
}
|
|
throw new Error(`Entity ${entityName} not found in XML`);
|
|
}
|
|
|
|
const buildPlugin = async ({
|
|
pluginVersion,
|
|
baseUrl,
|
|
tag,
|
|
txzSha256,
|
|
releaseNotes,
|
|
}: PluginEnv) => {
|
|
// Update plg file
|
|
let plgContent = await readFile(getRootPluginPath({ startingDir }), "utf8");
|
|
|
|
// Update entity values
|
|
const entities: Record<string, string> = {
|
|
name: pluginName,
|
|
version: pluginVersion,
|
|
pluginURL: getPluginUrl({ baseUrl, tag }),
|
|
MAIN_TXZ: getMainTxzUrl({ baseUrl, pluginVersion, tag }),
|
|
TXZ_SHA256: txzSha256,
|
|
VENDOR_STORE_URL: getAssetUrl({ baseUrl, tag }, getPnpmBundleName()),
|
|
VENDOR_STORE_FILENAME: getPnpmBundleName(),
|
|
...(tag ? { TAG: tag } : {}),
|
|
};
|
|
|
|
console.log("Entities:", entities);
|
|
// Iterate over entities and update them
|
|
Object.entries(entities).forEach(([key, value]) => {
|
|
if (!value) {
|
|
throw new Error(
|
|
`Entity ${key} not set in entities: ${JSON.stringify(entities)}`
|
|
);
|
|
}
|
|
plgContent = updateEntityValue(plgContent, key, value);
|
|
});
|
|
|
|
if (releaseNotes) {
|
|
// Update the CHANGES section with release notes
|
|
plgContent = plgContent.replace(
|
|
/<CHANGES>.*?<\/CHANGES>/s,
|
|
`<CHANGES>\n${escapeHtml(releaseNotes)}\n</CHANGES>`
|
|
);
|
|
}
|
|
|
|
await mkdir(dirname(getDeployPluginPath({ startingDir })), {
|
|
recursive: true,
|
|
});
|
|
console.log("Writing plg file to:", getDeployPluginPath({ startingDir }));
|
|
await writeFile(getDeployPluginPath({ startingDir }), plgContent);
|
|
};
|
|
|
|
/**
|
|
* Main build script
|
|
*/
|
|
|
|
const main = async () => {
|
|
try {
|
|
const validatedEnv = await setupPluginEnv(process.argv);
|
|
if (validatedEnv.tag === "LOCAL_PLUGIN_BUILD") {
|
|
console.log("Skipping git check for LOCAL_PLUGIN_BUILD");
|
|
} else {
|
|
await checkGit();
|
|
}
|
|
await cleanupPluginFiles();
|
|
|
|
await buildPlugin(validatedEnv);
|
|
await moveTxzFile(validatedEnv.txzPath, validatedEnv.pluginVersion);
|
|
await bundlePnpmStore();
|
|
} catch (error) {
|
|
console.error(error);
|
|
process.exit(1);
|
|
}
|
|
};
|
|
|
|
await main();
|