release: 2.3.0-rc.1 (#230)

* docs(api): updates to API spec

* chore(internal): remove redundant imports config

* chore(internal): move publish config

* chore: update @stainless-api/prism-cli to v5.15.0

* chore(internal): update comment in script

* docs(api): updates to API spec

* docs(api): updates to API spec

* codegen metadata

* codegen metadata

* feat(api): add web KG and web search

* release: 2.3.0-rc.1

---------

Co-authored-by: stainless-app[bot] <142633134+stainless-app[bot]@users.noreply.github.com>

Author: stainless-app[bot]

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "2.2.1"
+  ".": "2.3.0-rc.1"
 }

.stats.yml

@@ -1,4 +1,4 @@
-configured_endpoints: 32
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/writerai%2Fwriter-fab7a71148b6f413a4425ca9f2ce3d42557b65d35ab28c6f64daa7fce6d0ffe2.yml
-openapi_spec_hash: 0ead6944545bc40172176e15cc704633
-config_hash: c0c9f57ab19252f82cf765939edc61de
+configured_endpoints: 33
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/writerai%2Fwriter-0bbaae2a69204cb3ccf6dc4fbb0cef810a4e8c78f09ac639e253e84df0add53a.yml
+openapi_spec_hash: 0a9be554ca3af860e3831bd776e50f56
+config_hash: 7a38bab086b53b43d2a719cb4d883264

CHANGELOG.md

@@ -1,5 +1,28 @@
 # Changelog
 
+## 2.3.0-rc.1 (2025-08-12)
+
+Full Changelog: [v2.2.1...v2.3.0-rc.1](https://github.com/writer/writer-node/compare/v2.2.1...v2.3.0-rc.1)
+
+### Features
+
+* **api:** add web KG and web search ([aec5c23](https://github.com/writer/writer-node/commit/aec5c23cad2e5bac761f25bc494de4d22d74ed76))
+
+
+### Chores
+
+* **internal:** move publish config ([549fdb5](https://github.com/writer/writer-node/commit/549fdb505cd153213fd710af88e4f3661b058cc4))
+* **internal:** remove redundant imports config ([629582b](https://github.com/writer/writer-node/commit/629582b9916e249ff314002fe84ff43ee2eebe26))
+* **internal:** update comment in script ([0cbef20](https://github.com/writer/writer-node/commit/0cbef206554b08c09a77d1b935b3a7130f97bb98))
+* update @stainless-api/prism-cli to v5.15.0 ([4eb486f](https://github.com/writer/writer-node/commit/4eb486fddcf185c23e0e4d41d8e27fa65a284ef6))
+
+
+### Documentation
+
+* **api:** updates to API spec ([1bcdf1c](https://github.com/writer/writer-node/commit/1bcdf1ccce44d6e5ba0aaf41c7bde1fadf1b9cf1))
+* **api:** updates to API spec ([b7625d0](https://github.com/writer/writer-node/commit/b7625d0b3f0c4f1696a906106fd98c83b198b7c5))
+* **api:** updates to API spec ([bd08c45](https://github.com/writer/writer-node/commit/bd08c45f41c3bf89d0c5395b40742e68ece6902f))
+
 ## 2.2.1 (2025-07-16)
 
 Full Changelog: [v2.2.0...v2.2.1](https://github.com/writer/writer-node/compare/v2.2.0...v2.2.1)

MIGRATION.md

@@ -253,8 +253,8 @@ The `for await` syntax **is not affected**. This still works as-is:
 
 ```ts
 // Automatically fetches more pages as needed.
-for await (const graph of client.graphs.list()) {
-  console.log(graph);
+for await (const graphListResponse of client.graphs.list()) {
+  console.log(graphListResponse);
 }
 ```
 
@@ -276,10 +276,10 @@ Page classes for individual methods are now type aliases:
 
 ```ts
 // Before
-export class GraphsCursorPage extends CursorPage<Graph> {}
+export class GraphListResponsesCursorPage extends CursorPage<GraphListResponse> {}
 
 // After
-export type GraphsCursorPage = CursorPage<Graph>;
+export type GraphListResponsesCursorPage = CursorPage<GraphListResponse>;
 ```
 
 If you were importing these classes at runtime, you'll need to switch to importing the base class or only import them at the type-level.

README.md

@@ -283,22 +283,22 @@ List methods in the Writer API are paginated.
 You can use the `for await … of` syntax to iterate through items across all pages:
 
 ```ts
-async function fetchAllGraphs(params) {
-  const allGraphs = [];
+async function fetchAllGraphListResponses(params) {
+  const allGraphListResponses = [];
   // Automatically fetches more pages as needed.
-  for await (const graph of client.graphs.list()) {
-    allGraphs.push(graph);
+  for await (const graphListResponse of client.graphs.list()) {
+    allGraphListResponses.push(graphListResponse);
   }
-  return allGraphs;
+  return allGraphListResponses;
 }
 ```
 
 Alternatively, you can request a single page at a time:
 
 ```ts
 let page = await client.graphs.list();
-for (const graph of page.data) {
-  console.log(graph);
+for (const graphListResponse of page.data) {
+  console.log(graphListResponse);
 }
 
 // Convenience methods are provided for manually paginating:

api.md

@@ -103,16 +103,18 @@ Types:
 - <code><a href="./src/resources/graphs.ts">Question</a></code>
 - <code><a href="./src/resources/graphs.ts">QuestionResponseChunk</a></code>
 - <code><a href="./src/resources/graphs.ts">GraphCreateResponse</a></code>
+- <code><a href="./src/resources/graphs.ts">GraphRetrieveResponse</a></code>
 - <code><a href="./src/resources/graphs.ts">GraphUpdateResponse</a></code>
+- <code><a href="./src/resources/graphs.ts">GraphListResponse</a></code>
 - <code><a href="./src/resources/graphs.ts">GraphDeleteResponse</a></code>
 - <code><a href="./src/resources/graphs.ts">GraphRemoveFileFromGraphResponse</a></code>
 
 Methods:
 
 - <code title="post /v1/graphs">client.graphs.<a href="./src/resources/graphs.ts">create</a>({ ...params }) -> GraphCreateResponse</code>
-- <code title="get /v1/graphs/{graph_id}">client.graphs.<a href="./src/resources/graphs.ts">retrieve</a>(graphID) -> Graph</code>
+- <code title="get /v1/graphs/{graph_id}">client.graphs.<a href="./src/resources/graphs.ts">retrieve</a>(graphID) -> GraphRetrieveResponse</code>
 - <code title="put /v1/graphs/{graph_id}">client.graphs.<a href="./src/resources/graphs.ts">update</a>(graphID, { ...params }) -> GraphUpdateResponse</code>
-- <code title="get /v1/graphs">client.graphs.<a href="./src/resources/graphs.ts">list</a>({ ...params }) -> GraphsCursorPage</code>
+- <code title="get /v1/graphs">client.graphs.<a href="./src/resources/graphs.ts">list</a>({ ...params }) -> GraphListResponsesCursorPage</code>
 - <code title="delete /v1/graphs/{graph_id}">client.graphs.<a href="./src/resources/graphs.ts">delete</a>(graphID) -> GraphDeleteResponse</code>
 - <code title="post /v1/graphs/{graph_id}/file">client.graphs.<a href="./src/resources/graphs.ts">addFileToGraph</a>(graphID, { ...params }) -> File</code>
 - <code title="post /v1/graphs/question">client.graphs.<a href="./src/resources/graphs.ts">question</a>({ ...params }) -> Question</code>
@@ -142,12 +144,14 @@ Types:
 - <code><a href="./src/resources/tools/tools.ts">ToolAIDetectResponse</a></code>
 - <code><a href="./src/resources/tools/tools.ts">ToolContextAwareSplittingResponse</a></code>
 - <code><a href="./src/resources/tools/tools.ts">ToolParsePdfResponse</a></code>
+- <code><a href="./src/resources/tools/tools.ts">ToolWebSearchResponse</a></code>
 
 Methods:
 
 - <code title="post /v1/tools/ai-detect">client.tools.<a href="./src/resources/tools/tools.ts">aiDetect</a>({ ...params }) -> ToolAIDetectResponse</code>
 - <code title="post /v1/tools/context-aware-splitting">client.tools.<a href="./src/resources/tools/tools.ts">contextAwareSplitting</a>({ ...params }) -> ToolContextAwareSplittingResponse</code>
 - <code title="post /v1/tools/pdf-parser/{file_id}">client.tools.<a href="./src/resources/tools/tools.ts">parsePdf</a>(fileID, { ...params }) -> ToolParsePdfResponse</code>
+- <code title="post /v1/tools/web-search">client.tools.<a href="./src/resources/tools/tools.ts">webSearch</a>({ ...params }) -> ToolWebSearchResponse</code>
 
 ## Comprehend
 

bin/publish-npm

@@ -58,4 +58,4 @@ else
 fi
 
 # Publish with the appropriate tag
-yarn publish --access public --tag "$TAG"
+yarn publish --tag "$TAG"

package.json

@@ -1,6 +1,6 @@
 {
   "name": "writer-sdk",
-  "version": "2.2.1",
+  "version": "2.3.0-rc.1",
   "description": "The official TypeScript library for the Writer API",
   "author": "Writer <dev-feedback@writer.com>",
   "types": "dist/index.d.ts",
@@ -13,6 +13,9 @@
     "**/*"
   ],
   "private": false,
+  "publishConfig": {
+    "access": "public"
+  },
   "scripts": {
     "test": "./scripts/test",
     "build": "./scripts/build",
@@ -48,10 +51,6 @@
     "prettier-2": "npm:prettier@^2",
     "zod": "^3.23.8"
   },
-  "imports": {
-    "writer-sdk": ".",
-    "writer-sdk/*": "./src/*"
-  },
   "bin": {
     "writer-sdk": "bin/cli"
   },

scripts/mock

@@ -21,7 +21,7 @@ echo "==> Starting mock server with URL ${URL}"
 
 # Run prism mock on the given spec
 if [ "$1" == "--daemon" ]; then
-  npm exec --package=@stainless-api/prism-cli@5.8.5 -- prism mock "$URL" &> .prism.log &
+  npm exec --package=@stainless-api/prism-cli@5.15.0 -- prism mock "$URL" &> .prism.log &
 
   # Wait for server to come online
   echo -n "Waiting for server"
@@ -37,5 +37,5 @@ if [ "$1" == "--daemon" ]; then
 
   echo
 else
-  npm exec --package=@stainless-api/prism-cli@5.8.5 -- prism mock "$URL"
+  npm exec --package=@stainless-api/prism-cli@5.15.0 -- prism mock "$URL"
 fi

scripts/test

@@ -43,7 +43,7 @@ elif ! prism_is_running ; then
   echo -e "To run the server, pass in the path or url of your OpenAPI"
   echo -e "spec to the prism command:"
   echo
-  echo -e "  \$ ${YELLOW}npm exec --package=@stoplight/prism-cli@~5.3.2 -- prism mock path/to/your.openapi.yml${NC}"
+  echo -e "  \$ ${YELLOW}npm exec --package=@stainless-api/prism-cli@5.15.0 -- prism mock path/to/your.openapi.yml${NC}"
   echo
 
   exit 1