Files
openclaw/scripts/lib/extension-package-boundary.ts
Peter Steinberger 7c1484d637 refactor: extract media generation core package
Extract pure media generation catalog/model-ref/normalization helpers into a private workspace package and wire the package through build, watch, SDK alias, and plugin boundary d.ts paths.

Verification:
- node scripts/run-vitest.mjs test/scripts/crabbox-wrapper.test.ts packages/media-generation-core/src src/media-generation/runtime-shared.test.ts src/plugins/sdk-alias.test.ts src/infra/watch-node.test.ts src/plugins/registry.provider-like.test.ts src/agents/model-ref-shared.test.ts extensions/codex-supervisor/src/plugin-tools.test.ts extensions/codex-supervisor/src/supervisor.test.ts src/wizard/setup.official-plugins.test.ts src/infra/net/http-connect-tunnel.test.ts
- node scripts/prepare-extension-package-boundary-artifacts.mjs --mode=all
- node scripts/run-vitest.mjs src/plugins/contracts/extension-package-project-boundaries.test.ts src/plugins/sdk-alias.test.ts
- pnpm protocol:check
- pnpm check:changed
- .agents/skills/autoreview/scripts/autoreview --mode branch --base origin/main
- GitHub CI 26676608512
2026-05-30 08:17:43 +02:00

210 lines
8.8 KiB
TypeScript

import { existsSync, readFileSync, readdirSync } from "node:fs";
import { join, posix, resolve } from "node:path";
import { privateLocalOnlyPluginSdkEntrypoints } from "./plugin-sdk-entries.mjs";
export const EXTENSION_PACKAGE_BOUNDARY_INCLUDE = ["./*.ts", "./src/**/*.ts"] as const;
export const EXTENSION_PACKAGE_BOUNDARY_EXCLUDE = [
"./**/*.test.ts",
"./dist/**",
"./node_modules/**",
"./src/test-support/**",
"./src/**/*test-helpers.ts",
"./src/**/*test-harness.ts",
"./src/**/*test-support.ts",
] as const;
const privateLocalOnlyPluginSdkPackageDtsPaths = Object.fromEntries(
privateLocalOnlyPluginSdkEntrypoints.map((entrypoint) => [
`openclaw/plugin-sdk/${entrypoint}`,
[`../packages/plugin-sdk/dist/src/plugin-sdk/${entrypoint}.d.ts`],
]),
) as Record<string, readonly string[]>;
export const EXTENSION_PACKAGE_BOUNDARY_BASE_PATHS = {
"openclaw/extension-api": ["../src/extensionAPI.ts"],
"openclaw/plugin-sdk": ["../dist/plugin-sdk/index.d.ts"],
"openclaw/plugin-sdk/*": ["../dist/plugin-sdk/*.d.ts"],
...privateLocalOnlyPluginSdkPackageDtsPaths,
"openclaw/plugin-sdk/account-id": ["../dist/plugin-sdk/account-id.d.ts"],
"openclaw/plugin-sdk/channel-entry-contract": ["../dist/plugin-sdk/channel-entry-contract.d.ts"],
"openclaw/plugin-sdk/browser-maintenance": [
"../packages/plugin-sdk/dist/extensions/browser/browser-maintenance.d.ts",
],
"openclaw/plugin-sdk/channel-secret-basic-runtime": [
"../dist/plugin-sdk/channel-secret-basic-runtime.d.ts",
],
"openclaw/plugin-sdk/channel-secret-runtime": ["../dist/plugin-sdk/channel-secret-runtime.d.ts"],
"openclaw/plugin-sdk/channel-secret-tts-runtime": [
"../dist/plugin-sdk/channel-secret-tts-runtime.d.ts",
],
"openclaw/plugin-sdk/channel-streaming": ["../dist/plugin-sdk/channel-streaming.d.ts"],
"openclaw/plugin-sdk/error-runtime": ["../dist/plugin-sdk/error-runtime.d.ts"],
"openclaw/plugin-sdk/provider-catalog-shared": [
"../dist/plugin-sdk/provider-catalog-shared.d.ts",
],
"openclaw/plugin-sdk/provider-entry": ["../dist/plugin-sdk/provider-entry.d.ts"],
"openclaw/plugin-sdk/secret-ref-runtime": ["../dist/plugin-sdk/secret-ref-runtime.d.ts"],
"openclaw/plugin-sdk/ssrf-runtime": ["../dist/plugin-sdk/ssrf-runtime.d.ts"],
"@openclaw/qa-channel/api.js": ["../dist/plugin-sdk/extensions/qa-channel/api.d.ts"],
"@openclaw/discord/api.js": ["../dist/plugin-sdk/extensions/discord/api.d.ts"],
"@openclaw/slack/api.js": ["../dist/plugin-sdk/extensions/slack/api.d.ts"],
"@openclaw/whatsapp/api.js": ["../dist/plugin-sdk/extensions/whatsapp/api.d.ts"],
"@openclaw/llm-core": ["../dist/plugin-sdk/packages/llm-core/src/index.d.ts"],
"@openclaw/llm-core/diagnostics": [
"../dist/plugin-sdk/packages/llm-core/src/utils/diagnostics.d.ts",
],
"@openclaw/llm-core/event-stream": [
"../dist/plugin-sdk/packages/llm-core/src/utils/event-stream.d.ts",
],
"@openclaw/llm-core/types": ["../dist/plugin-sdk/packages/llm-core/src/types.d.ts"],
"@openclaw/llm-core/validation": ["../dist/plugin-sdk/packages/llm-core/src/validation.d.ts"],
"@openclaw/llm-core/*": ["../dist/plugin-sdk/packages/llm-core/src/*.d.ts"],
"@openclaw/media-generation-core": [
"../dist/plugin-sdk/packages/media-generation-core/src/index.d.ts",
],
"@openclaw/media-generation-core/capability-model-ref": [
"../dist/plugin-sdk/packages/media-generation-core/src/capability-model-ref.d.ts",
],
"@openclaw/media-generation-core/catalog": [
"../dist/plugin-sdk/packages/media-generation-core/src/catalog.d.ts",
],
"@openclaw/media-generation-core/model-ref": [
"../dist/plugin-sdk/packages/media-generation-core/src/model-ref.d.ts",
],
"@openclaw/media-generation-core/normalization": [
"../dist/plugin-sdk/packages/media-generation-core/src/normalization.d.ts",
],
"@openclaw/media-generation-core/*": [
"../dist/plugin-sdk/packages/media-generation-core/src/*.d.ts",
],
"@openclaw/*.js": ["../packages/plugin-sdk/dist/extensions/*.d.ts", "../extensions/*"],
"@openclaw/*": ["../packages/plugin-sdk/dist/extensions/*", "../extensions/*"],
"openclaw/plugin-sdk/qa-channel": ["../dist/plugin-sdk/src/plugin-sdk/qa-channel.d.ts"],
"openclaw/plugin-sdk/qa-channel-protocol": [
"../dist/plugin-sdk/src/plugin-sdk/qa-channel-protocol.d.ts",
],
"openclaw/plugin-sdk/qa-runtime": ["../dist/plugin-sdk/src/plugin-sdk/qa-runtime.d.ts"],
"@openclaw/plugin-sdk/*": ["../dist/plugin-sdk/*.d.ts"],
} as const;
function prefixExtensionPackageBoundaryPaths(
paths: Record<string, readonly string[]>,
prefix: string,
): Record<string, readonly string[]> {
return Object.fromEntries(
Object.entries(paths).map(([key, values]) => [
key,
values.map((value) => posix.join(prefix, value)),
]),
);
}
export const EXTENSION_PACKAGE_BOUNDARY_XAI_PATHS = {
...prefixExtensionPackageBoundaryPaths(
(({
"openclaw/plugin-sdk/channel-secret-basic-runtime": _omitBasic,
"openclaw/plugin-sdk/channel-secret-tts-runtime": _omitTts,
"@openclaw/discord/api.js": _omitDiscord,
"@openclaw/slack/api.js": _omitSlack,
"@openclaw/whatsapp/api.js": _omitWhatsApp,
...rest
}) => rest)(EXTENSION_PACKAGE_BOUNDARY_BASE_PATHS),
"../",
),
"openclaw/plugin-sdk/channel-entry-contract": [
"../../dist/plugin-sdk/channel-entry-contract.d.ts",
],
"openclaw/plugin-sdk/browser-maintenance": [
"../../dist/plugin-sdk/src/plugin-sdk/browser-maintenance.d.ts",
],
"openclaw/plugin-sdk/cli-runtime": ["../../dist/plugin-sdk/cli-runtime.d.ts"],
"openclaw/plugin-sdk/provider-catalog-shared": [
"../../dist/plugin-sdk/provider-catalog-shared.d.ts",
],
"openclaw/plugin-sdk/provider-env-vars": ["../../dist/plugin-sdk/provider-env-vars.d.ts"],
"openclaw/plugin-sdk/provider-entry": ["../../dist/plugin-sdk/provider-entry.d.ts"],
"openclaw/plugin-sdk/provider-web-search-contract": [
"../../dist/plugin-sdk/provider-web-search-contract.d.ts",
],
"@openclaw/qa-channel/api.js": ["../../dist/plugin-sdk/extensions/qa-channel/api.d.ts"],
"@openclaw/*.js": ["../../packages/plugin-sdk/dist/extensions/*.d.ts", "../*"],
"@openclaw/*": ["../*"],
"@openclaw/plugin-sdk/*": ["../../dist/plugin-sdk/*.d.ts"],
"@openclaw/anthropic-vertex/api.js": ["./.boundary-stubs/anthropic-vertex-api.d.ts"],
"@openclaw/ollama/api.js": ["./.boundary-stubs/ollama-api.d.ts"],
"@openclaw/ollama/runtime-api.js": ["./.boundary-stubs/ollama-runtime-api.d.ts"],
"@openclaw/speech-core/runtime-api.js": ["./.boundary-stubs/speech-core-runtime-api.d.ts"],
} as const;
type ExtensionPackageBoundaryTsConfigJson = {
extends?: unknown;
compilerOptions?: {
rootDir?: unknown;
paths?: unknown;
};
include?: unknown;
exclude?: unknown;
};
type ExtensionPackageBoundaryPackageJson = {
devDependencies?: Record<string, string>;
};
// oxlint-disable-next-line typescript/no-unnecessary-type-parameters -- Boundary helper lets callers ascribe JSON file shape.
function readJsonFile<T>(filePath: string): T {
return JSON.parse(readFileSync(filePath, "utf8")) as T;
}
function collectBundledExtensionIds(rootDir = resolve(".")): string[] {
return readdirSync(join(rootDir, "extensions"), { withFileTypes: true })
.filter((entry) => entry.isDirectory())
.map((entry) => entry.name)
.toSorted();
}
function resolveExtensionTsconfigPath(extensionId: string, rootDir = resolve(".")): string {
return join(rootDir, "extensions", extensionId, "tsconfig.json");
}
function resolveExtensionPackageJsonPath(extensionId: string, rootDir = resolve(".")): string {
return join(rootDir, "extensions", extensionId, "package.json");
}
export function readExtensionPackageBoundaryTsconfig(
extensionId: string,
rootDir = resolve("."),
): ExtensionPackageBoundaryTsConfigJson {
return readJsonFile<ExtensionPackageBoundaryTsConfigJson>(
resolveExtensionTsconfigPath(extensionId, rootDir),
);
}
export function readExtensionPackageBoundaryPackageJson(
extensionId: string,
rootDir = resolve("."),
): ExtensionPackageBoundaryPackageJson {
return readJsonFile<ExtensionPackageBoundaryPackageJson>(
resolveExtensionPackageJsonPath(extensionId, rootDir),
);
}
export function isOptInExtensionPackageBoundaryTsconfig(
tsconfig: ExtensionPackageBoundaryTsConfigJson,
): boolean {
return tsconfig.extends === "../tsconfig.package-boundary.base.json";
}
export function collectExtensionsWithTsconfig(rootDir = resolve(".")): string[] {
return collectBundledExtensionIds(rootDir).filter((extensionId) =>
existsSync(resolveExtensionTsconfigPath(extensionId, rootDir)),
);
}
export function collectOptInExtensionPackageBoundaries(rootDir = resolve(".")): string[] {
return collectExtensionsWithTsconfig(rootDir).filter((extensionId) =>
isOptInExtensionPackageBoundaryTsconfig(
readExtensionPackageBoundaryTsconfig(extensionId, rootDir),
),
);
}