Skip to content

OpenAI's Codex Security CLI and TypeScript SDK for finding, validating, and fixing security vulnerabilities. npm: https://www.npmjs.com/package/@openai/codex-security

refactor(build): infer helper types instead of duplicating declarations (#1358)

mldangelo-oai2cc369e2b015
diff --git a/sdk/typescript/scripts/build-plugin.d.mts b/sdk/typescript/scripts/build-plugin.d.mts
deleted file mode 100644
index 360801fa8..000000000
--- a/sdk/typescript/scripts/build-plugin.d.mts
+++ /dev/null
@@ -1,9 +0,0 @@
-export interface BuildBundledPluginOptions {
- contractPath?: string;
- destination?: string;
- source?: string;
-}
-
-export function buildBundledPlugin(
- options?: BuildBundledPluginOptions,
-): Promise<string[]>;
diff --git a/sdk/typescript/scripts/build-plugin.mjs b/sdk/typescript/scripts/build-plugin.mjs
index 1bc0a21d1..4bc2cc1a0 100644
--- a/sdk/typescript/scripts/build-plugin.mjs
+++ b/sdk/typescript/scripts/build-plugin.mjs
@@ -48,6 +48,7 @@ async function destinationFiles(root, prefix = "") {
return files.sort();
}
+/** @returns {Promise<string[]>} */
export async function buildBundledPlugin({
contractPath = join(
repositoryRoot,
diff --git a/sdk/typescript/scripts/check-plugin-source.d.mts b/sdk/typescript/scripts/check-plugin-source.d.mts
deleted file mode 100644
index b65a0cd0b..000000000
--- a/sdk/typescript/scripts/check-plugin-source.d.mts
+++ /dev/null
@@ -1,3 +0,0 @@
-export function assertGeneratedPluginUntracked(options?: {
- packageRoot?: string;
-}): Promise<void>;
diff --git a/sdk/typescript/scripts/package-provenance.mjs b/sdk/typescript/scripts/package-provenance.mjs
index a226b93e5..d787280e7 100644
--- a/sdk/typescript/scripts/package-provenance.mjs
+++ b/sdk/typescript/scripts/package-provenance.mjs
@@ -1,5 +1,9 @@
const fullGitCommit = /^[0-9a-f]{40}$/u;
+/**
+ * @param {{ gitHead?: unknown }} packageJson
+ * @param {string | undefined} expectedGitHead
+ */
export function assertExpectedGitHead(packageJson, expectedGitHead) {
if (expectedGitHead === undefined) return;
diff --git a/sdk/typescript/scripts/package-public-content.mjs b/sdk/typescript/scripts/package-public-content.mjs
index 5c65ce6f4..2d8458b1e 100644
--- a/sdk/typescript/scripts/package-public-content.mjs
+++ b/sdk/typescript/scripts/package-public-content.mjs
@@ -5,6 +5,10 @@ export const MAX_EXPANDED_ASSET_BYTES = 32 * 1024 * 1024;
const internalMarker =
/(?:internal\.api\.openai\.org|gateway\.[a-z0-9.-]*internal|\.openai\.org|openai\.firewall\.socket\.dev|socket\x2dfirewall\x2dregistry|openai\.(?:enterprise\.)?slack\.com|app\.slack\.com\/client|(?:app\.notion\.com\/p|notion\.so)\/openai|linear\.app\/openai|(?:github\.com[:/]|api\.github\.com\/repos\/|raw\.githubusercontent\.com\/)openai\/openai(?:\.git)?(?:[^a-z0-9_-]|$)|LicenseRef\x2dProprietary|\/Users\/|\/home\/dev-user|flow\.apps\.openai\.org|(?:^|[^a-z0-9_-])go\/[a-z0-9_-]+)/iu;
+/**
+ * @param {Map<string, Buffer>} archiveFiles
+ * @param {Buffer} [archiveMetadata]
+ */
export function assertPublicPackageContents(
archiveFiles,
archiveMetadata = Buffer.alloc(0),
diff --git a/sdk/typescript/scripts/package-tar-listing.mjs b/sdk/typescript/scripts/package-tar-listing.mjs
index 1e9914873..d30d31782 100644
--- a/sdk/typescript/scripts/package-tar-listing.mjs
+++ b/sdk/typescript/scripts/package-tar-listing.mjs
@@ -1,3 +1,4 @@
+/** @param {string} listing */
export function regularTarListingLines(listing) {
const lines = listing.split(/\r?\n/u).filter(Boolean);
if (lines.some((line) => !line.startsWith("d") && !line.startsWith("-"))) {
diff --git a/sdk/typescript/scripts/smoke-published-package.mjs b/sdk/typescript/scripts/smoke-published-package.mjs
index 830483a3a..1f9fd9c03 100644
--- a/sdk/typescript/scripts/smoke-published-package.mjs
+++ b/sdk/typescript/scripts/smoke-published-package.mjs
@@ -21,6 +21,10 @@ function run(command, args, options) {
});
}
+/**
+ * @param {string} consumer
+ * @param {NodeJS.ProcessEnv} environment
+ */
export async function verifyInstalledPackage(consumer, environment) {
const installedRoot = join(
consumer,
diff --git a/sdk/typescript/tests-ts/build-plugin.test.ts b/sdk/typescript/tests-ts/build-plugin.test.ts
index 2f9d58dfc..86880407b 100644
--- a/sdk/typescript/tests-ts/build-plugin.test.ts
+++ b/sdk/typescript/tests-ts/build-plugin.test.ts
@@ -328,13 +328,6 @@ await writeFile(join(output, "unexpected.txt"), "undeclared output");\n`,
await writeFixture(source, "scripts/launch", "#!/bin/sh\nexit 0\n");
await chmod(join(source, "scripts", "launch"), 0o755);
await writeFixture(source, "schemas/scan.json", "{}\n");
- await writeFixture(
- source,
- "mcp-app/package.json",
- `${JSON.stringify({
- scripts: { build: "node scripts/build_mcp_app.mjs" },
- })}\n`,
- );
await writeFixture(
source,
"mcp-app/scripts/build_mcp_app.mjs",
diff --git a/sdk/typescript/tests-ts/package-provenance.test.ts b/sdk/typescript/tests-ts/package-provenance.test.ts
index 1f9e09924..c8f0eda10 100644
--- a/sdk/typescript/tests-ts/package-provenance.test.ts
+++ b/sdk/typescript/tests-ts/package-provenance.test.ts
@@ -1,15 +1,6 @@
import { describe, expect, test } from "bun:test";
-type PackageProvenance = {
- assertExpectedGitHead: (
- packageJson: { gitHead?: unknown },
- expectedGitHead: string | undefined,
- ) => void;
-};
-
-const { assertExpectedGitHead } = (await import(
- new URL("../scripts/package-provenance.mjs", import.meta.url).href
-)) as PackageProvenance;
+import { assertExpectedGitHead } from "../scripts/package-provenance.mjs";
const releaseCommit = "e94d6bef9797a192febfde89a26ec7f831bc09b2";
diff --git a/sdk/typescript/tests-ts/package-public-content.test.ts b/sdk/typescript/tests-ts/package-public-content.test.ts
index 1b534df2d..8100d34bc 100644
--- a/sdk/typescript/tests-ts/package-public-content.test.ts
+++ b/sdk/typescript/tests-ts/package-public-content.test.ts
@@ -1,14 +1,7 @@
import { brotliCompressSync, brotliDecompressSync } from "node:zlib";
import { describe, expect, test } from "bun:test";
-const { assertPublicPackageContents } = (await import(
- new URL("../scripts/package-public-content.mjs", import.meta.url).href
-)) as {
- assertPublicPackageContents: (
- files: Map<string, Buffer>,
- archiveMetadata?: Buffer,
- ) => void;
-};
+import { assertPublicPackageContents } from "../scripts/package-public-content.mjs";
// Synthetic alphanumeric text whose compressed bytes happen to contain " Go/w".
const cleanCompressedPayload = Buffer.from(
diff --git a/sdk/typescript/tests-ts/package-smoke-timeouts.test.ts b/sdk/typescript/tests-ts/package-smoke-timeouts.test.ts
index f6262ec40..5467fbda2 100644
--- a/sdk/typescript/tests-ts/package-smoke-timeouts.test.ts
+++ b/sdk/typescript/tests-ts/package-smoke-timeouts.test.ts
@@ -1,16 +1,6 @@
import { describe, expect, test } from "bun:test";
-type PackageSmokeTimeouts = {
- packageSmokeTimeouts: (platform?: NodeJS.Platform) => {
- commandTimeoutMs: number;
- installTimeoutMs: number;
- processTimeoutMs: number;
- };
-};
-
-const { packageSmokeTimeouts } = (await import(
- new URL("../scripts/package-smoke-timeouts.mjs", import.meta.url).href
-)) as PackageSmokeTimeouts;
+import { packageSmokeTimeouts } from "../scripts/package-smoke-timeouts.mjs";
describe("npm package smoke timeouts", () => {
test("preserves the command timeout on Linux and macOS", () => {
diff --git a/sdk/typescript/tests-ts/package-tar-listing.test.ts b/sdk/typescript/tests-ts/package-tar-listing.test.ts
index d2d117280..4c0e585e5 100644
--- a/sdk/typescript/tests-ts/package-tar-listing.test.ts
+++ b/sdk/typescript/tests-ts/package-tar-listing.test.ts
@@ -1,8 +1,6 @@
import { describe, expect, test } from "bun:test";
-const { regularTarListingLines } = (await import(
- new URL("../scripts/package-tar-listing.mjs", import.meta.url).href
-)) as { regularTarListingLines: (listing: string) => string[] };
+import { regularTarListingLines } from "../scripts/package-tar-listing.mjs";
describe("npm package tar listings", () => {
test("accepts regular entries with Unix or Windows line endings", () => {
diff --git a/sdk/typescript/tsconfig.json b/sdk/typescript/tsconfig.json
index 91254837d..80656d47d 100644
--- a/sdk/typescript/tsconfig.json
+++ b/sdk/typescript/tsconfig.json
@@ -15,7 +15,7 @@
"scripts/run-ci-tests.mts"
],
"compilerOptions": {
- "allowJs": false,
+ "allowJs": true,
"checkJs": false,
"incremental": true,
"isolatedModules": true,