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: simplify artifact export metadata transport (#1462)

mldangelo-oaiaadd2de1fc7a
diff --git a/sdk/typescript/src/artifact-export.ts b/sdk/typescript/src/artifact-export.ts
index 993c7b797..cb4b828b2 100644
--- a/sdk/typescript/src/artifact-export.ts
+++ b/sdk/typescript/src/artifact-export.ts
@@ -5,7 +5,6 @@ import { Writable as NodeWritable } from "node:stream";
import { pipeline } from "node:stream/promises";
import type { JsonObject } from "./config.js";
import { CodexSecurityError } from "./errors.js";
-import type { ThreatModel } from "./models.js";
import { relativePathIsOutside as isOutsidePath } from "./targets.js";
import {
bundledPluginRoot,
@@ -38,12 +37,6 @@ export interface ArtifactExportArguments {
includeMetadata?: boolean;
}
-interface ThreatModelDescription {
- threatModel: ThreatModel | null;
- provenance: JsonObject;
- path: string | null;
-}
-
export type ExportArtifactOptions = {
source:
| { directory: string; scanId?: never }
@@ -180,7 +173,7 @@ export async function readThreatModelPath(
["--scan-dir", directory, "--describe-threat-model"],
options,
);
- return (JSON.parse(result.stdout) as ThreatModelDescription).path;
+ return (JSON.parse(result.stdout) as ArtifactExportResult).path;
} catch {
options.signal?.throwIfAborted();
return null;
@@ -190,7 +183,7 @@ export async function readThreatModelPath(
export async function runArtifactExport(
arguments_: ArtifactExportArguments,
output?: ArtifactOutput,
-): Promise<Uint8Array | undefined> {
+): Promise<string | undefined> {
const artifact = arguments_.artifact ?? "findings";
resolveArtifactFormat(artifact, arguments_.format);
const result = await runArtifactHelper(
@@ -220,7 +213,7 @@ export async function runArtifactExport(
);
return (arguments_.output === "-" && output === undefined) ||
arguments_.includeMetadata
- ? Buffer.from(result.stdout)
+ ? result.stdout
: undefined;
}
@@ -394,9 +387,7 @@ export async function exportArtifact(
const description =
metadata === undefined
? null
- : (JSON.parse(
- Buffer.from(metadata).toString("utf8"),
- ) as ThreatModelDescription);
+ : (JSON.parse(metadata) as ArtifactExportResult);
return {
path: arguments_.output === "-" ? null : arguments_.output,
provenance: description?.provenance ?? null,
diff --git a/sdk/typescript/src/cli.ts b/sdk/typescript/src/cli.ts
index 057682919..3ffea9edb 100644
--- a/sdk/typescript/src/cli.ts
+++ b/sdk/typescript/src/cli.ts
@@ -1217,7 +1217,7 @@ interface CliDependencies {
exportFindings(
arguments_: ExportArguments,
output?: Writable,
- ): Promise<Uint8Array | undefined>;
+ ): Promise<string | Uint8Array | undefined>;
runCodex(
args: readonly string[],
output?: SkillCommandOutput,