feat(core): expose graph json type (#27496)

Closes #3283 ## Current Behavior See #3283 ## Expected Behavior See #3283 ## Related Issue(s) #3283 Fixes # - expose graph json type --------- Co-authored-by: @NgDaddy Paweł Twardziak <contact@ngdaddy.com> Co-authored-by: FrozenPandaz <jasonjean1993@gmail.com> (cherry picked from commit 2c0a50c)
nrwl · Aug 24, 2024 · f81b906 · f81b906
1 parent be620eb
commit f81b906
Show file tree

Hide file tree

Showing 5 changed files with 54 additions and 3 deletions.
diff --git a/docs/generated/devkit/GraphJson.md b/docs/generated/devkit/GraphJson.md
@@ -0,0 +1,35 @@
+# Interface: GraphJson
+
+The data type that `nx graph --file graph.json` or `nx build --graph graph.json` contains
+
+## Table of contents
+
+### Properties
+
+- [graph](../../devkit/documents/GraphJson#graph): ProjectGraph
+- [taskPlans](../../devkit/documents/GraphJson#taskplans): Record<string, string[]>
+- [tasks](../../devkit/documents/GraphJson#tasks): TaskGraph
+
+## Properties
+
+### graph
+
+• **graph**: [`ProjectGraph`](../../devkit/documents/ProjectGraph)
+
+The project graph
+
+---
+
+### taskPlans
+
+• `Optional` **taskPlans**: `Record`\<`string`, `string`[]\>
+
+The plans for hashing a task in the task graph
+
+---
+
+### tasks
+
+• `Optional` **tasks**: [`TaskGraph`](../../devkit/documents/TaskGraph)
+
+A graph of tasks populated with `nx build --graph`
diff --git a/docs/generated/devkit/README.md b/docs/generated/devkit/README.md
@@ -35,6 +35,7 @@ It only uses language primitives and immutable objects
 - [FileData](../../devkit/documents/FileData)
 - [FileMap](../../devkit/documents/FileMap)
 - [GeneratorsJson](../../devkit/documents/GeneratorsJson)
+- [GraphJson](../../devkit/documents/GraphJson)
 - [Hash](../../devkit/documents/Hash)
 - [HasherContext](../../devkit/documents/HasherContext)
 - [ImplicitJsonSubsetDependency](../../devkit/documents/ImplicitJsonSubsetDependency)

diff --git a/docs/generated/packages/devkit/documents/nx_devkit.md b/docs/generated/packages/devkit/documents/nx_devkit.md
@@ -35,6 +35,7 @@ It only uses language primitives and immutable objects
 - [FileData](../../devkit/documents/FileData)
 - [FileMap](../../devkit/documents/FileMap)
 - [GeneratorsJson](../../devkit/documents/GeneratorsJson)
+- [GraphJson](../../devkit/documents/GraphJson)
 - [Hash](../../devkit/documents/Hash)
 - [HasherContext](../../devkit/documents/HasherContext)
 - [ImplicitJsonSubsetDependency](../../devkit/documents/ImplicitJsonSubsetDependency)

diff --git a/packages/nx/src/command-line/graph/graph.ts b/packages/nx/src/command-line/graph/graph.ts
@@ -1155,9 +1155,21 @@ function expandInputs(
   };
 }
 
-interface GraphJsonResponse {
+/**
+ * The data type that `nx graph --file graph.json` or `nx build --graph graph.json` contains
+ */
+export interface GraphJson {
+  /**
+   * A graph of tasks populated with `nx build --graph`
+   */
   tasks?: TaskGraph;
+  /**
+   * The plans for hashing a task in the task graph
+   */
   taskPlans?: Record<string, string[]>;
+  /**
+   * The project graph
+   */
   graph: ProjectGraph;
 }
 
@@ -1166,8 +1178,8 @@ async function createJsonOutput(
   rawGraph: ProjectGraph,
   projects: string[],
   targets?: string[]
-): Promise<GraphJsonResponse> {
-  const response: GraphJsonResponse = {
+): Promise<GraphJson> {
+  const response: GraphJson = {
     graph: prunedGraph,
   };
 

diff --git a/packages/nx/src/devkit-exports.ts b/packages/nx/src/devkit-exports.ts
@@ -159,6 +159,8 @@ export type {
   ProjectGraphProcessorContext,
 } from './config/project-graph';
 
+export type { GraphJson } from './command-line/graph/graph';
+
 /**
  * @category Project Graph
  */