Skip to content

Commit 239f72d

Browse files
committed
## Typescript SDK Changes Detected:
* `speakeasy.artifacts.getNamespaces()`: `response.items.[].latestRevisionMetadata.relativeDiff` **Added** * `speakeasy.artifacts.getRevisions()`: `response.items.[].contentsMetadata.relativeDiff` **Added**
1 parent 483a5fb commit 239f72d

File tree

130 files changed

+1225
-247
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

130 files changed

+1225
-247
lines changed

.gitignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
/examples/node_modules
2+
.env
3+
.env.local
4+
.env.*.local
15
.DS_Store
26
**/.speakeasy/temp/
37
**/.speakeasy/logs/

.speakeasy/gen.lock

Lines changed: 19 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,32 @@
11
lockVersion: 2.0.0
22
id: 89968bf0-a755-4d50-9acb-d47410010f05
33
management:
4-
docChecksum: 17226457b23fc2563102eb22d263bc30
4+
docChecksum: 9fe547b1abb3170dfb491aa3c76e07b2
55
docVersion: 0.4.0
6-
speakeasyVersion: 1.561.0
7-
generationVersion: 2.628.0
8-
releaseVersion: 5.0.0-rc.4
9-
configChecksum: f3d6e491d6a8639407af1874416c9ae0
6+
speakeasyVersion: 1.636.0
7+
generationVersion: 2.723.2
8+
releaseVersion: 5.0.0-rc.5
9+
configChecksum: f386950da7798cec800ec5301b68a2e3
1010
repoURL: https://github.com/speakeasy-api/speakeasy-client-sdk-typescript.git
1111
repoSubDirectory: .
1212
installationURL: https://github.com/speakeasy-api/speakeasy-client-sdk-typescript
1313
published: true
1414
features:
1515
typescript:
1616
additionalDependencies: 0.1.0
17-
constsAndDefaults: 0.1.11
18-
core: 3.21.11
17+
constsAndDefaults: 0.1.12
18+
core: 3.21.26
1919
deepObjectParams: 0.1.0
2020
defaultEnabledRetries: 0.1.0
2121
deprecations: 2.81.1
2222
downloadStreams: 0.1.1
2323
enumUnions: 0.1.0
2424
envVarSecurityUsage: 0.1.2
25-
globalSecurity: 2.82.13
25+
globalSecurity: 2.82.14
2626
globalSecurityCallbacks: 0.1.0
2727
globalServerURLs: 2.82.5
2828
globals: 2.82.2
29-
mcpServer: 0.9.2
29+
mcpServer: 0.9.3
3030
nameOverrides: 2.81.2
3131
nullables: 0.1.1
3232
openEnums: 0.1.1
@@ -179,6 +179,7 @@ generatedFiles:
179179
- docs/sdk/models/shared/publishingtoken.md
180180
- docs/sdk/models/shared/pullrequestmetadata.md
181181
- docs/sdk/models/shared/relationship.md
182+
- docs/sdk/models/shared/relativediff.md
182183
- docs/sdk/models/shared/remotedocument.md
183184
- docs/sdk/models/shared/remotesource.md
184185
- docs/sdk/models/shared/remotesourcesubscriptionsettings.md
@@ -226,11 +227,14 @@ generatedFiles:
226227
- docs/sdks/reports/README.md
227228
- docs/sdks/schemastore/README.md
228229
- docs/sdks/shorturls/README.md
229-
- docs/sdks/speakeasy/README.md
230230
- docs/sdks/subscriptions/README.md
231231
- docs/sdks/suggest/README.md
232232
- docs/sdks/workspaces/README.md
233233
- eslint.config.mjs
234+
- examples/.env.template
235+
- examples/README.md
236+
- examples/artifactsCreateRemoteSource.example.ts
237+
- examples/package.json
234238
- jsr.json
235239
- package.json
236240
- src/core.ts
@@ -605,6 +609,7 @@ generatedFiles:
605609
- src/sdk/models/shared/preflightrequest.ts
606610
- src/sdk/models/shared/preflighttoken.ts
607611
- src/sdk/models/shared/publishingtoken.ts
612+
- src/sdk/models/shared/relativediff.ts
608613
- src/sdk/models/shared/remotedocument.ts
609614
- src/sdk/models/shared/remotesource.ts
610615
- src/sdk/models/shared/remotesourcesubscriptionsettings.ts
@@ -1335,3 +1340,7 @@ examples:
13351340
application/json: {"message": "<value>", "status_code": 436496}
13361341
examplesVersion: 1.0.2
13371342
generatedTests: {}
1343+
releaseNotes: |
1344+
## Typescript SDK Changes Detected:
1345+
* `speakeasy.artifacts.getNamespaces()`: `response.items.[].latestRevisionMetadata.relativeDiff` **Added**
1346+
* `speakeasy.artifacts.getRevisions()`: `response.items.[].contentsMetadata.relativeDiff` **Added**

.speakeasy/workflow.lock

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,30 @@
1-
speakeasyVersion: 1.561.0
1+
speakeasyVersion: 1.636.0
22
sources:
33
my-source:
4-
sourceNamespace: my-source
5-
sourceRevisionDigest: sha256:2e5dc78239617b9501f2028df534aa4601c61396c89a582390d75a797fc228cc
6-
sourceBlobDigest: sha256:0442ef7698d8979dd825b3eab0ab868ac86580f4cffcd3e0dff7afdd6191e6d9
4+
sourceNamespace: ts-client-source
5+
sourceRevisionDigest: sha256:802dc7b246c02d418741629981a8b0d57f6993d67f0d2cf26bc3654db30ba01a
6+
sourceBlobDigest: sha256:ec4ec370491ceb2ff1df4ba4a12bb743c761566998c5dd22e1d8730a8654d7e3
77
tags:
88
- latest
9-
- speakeasy-sdk-regen-1746577270
9+
- speakeasy-sdk-regen-1753835013
1010
- 0.4.0
1111
targets:
1212
speakeasy-client-sdk-typescript:
1313
source: my-source
14-
sourceNamespace: my-source
15-
sourceRevisionDigest: sha256:2e5dc78239617b9501f2028df534aa4601c61396c89a582390d75a797fc228cc
16-
sourceBlobDigest: sha256:0442ef7698d8979dd825b3eab0ab868ac86580f4cffcd3e0dff7afdd6191e6d9
14+
sourceNamespace: ts-client-source
15+
sourceRevisionDigest: sha256:802dc7b246c02d418741629981a8b0d57f6993d67f0d2cf26bc3654db30ba01a
16+
sourceBlobDigest: sha256:ec4ec370491ceb2ff1df4ba4a12bb743c761566998c5dd22e1d8730a8654d7e3
1717
codeSamplesNamespace: my-source-typescript-code-samples
18-
codeSamplesRevisionDigest: sha256:65717f579dccb319b073cb22e553e23bd3419cf420967387c00d148c041f5dc1
18+
codeSamplesRevisionDigest: sha256:45183a9500c3d20e52ad7fb69cba2ff792e1b68bcb584cd48829aead5309a960
1919
workflow:
2020
workflowVersion: 1.0.0
2121
speakeasyVersion: latest
2222
sources:
2323
my-source:
2424
inputs:
25-
- location: https://speakeasy.com/openapi.yaml
25+
- location: https://spec.speakeasy.com/speakeasy-self/speakeasy-self/speakeasy-api
2626
registry:
27-
location: registry.speakeasyapi.dev/speakeasy-self/speakeasy-self/my-source
27+
location: registry.speakeasyapi.dev/speakeasy-self/speakeasy-self/ts-client-source
2828
targets:
2929
speakeasy-client-sdk-typescript:
3030
target: typescript

README.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -73,12 +73,9 @@ bun add @tanstack/react-query react react-dom
7373
### Yarn
7474

7575
```bash
76-
yarn add @speakeasy-api/speakeasy-client-sdk-typescript zod
76+
yarn add @speakeasy-api/speakeasy-client-sdk-typescript
7777
# Install optional peer dependencies if you plan to use React hooks
7878
yarn add @tanstack/react-query react react-dom
79-
80-
# Note that Yarn does not install peer dependencies automatically. You will need
81-
# to install zod as shown above.
8279
```
8380

8481

@@ -287,7 +284,6 @@ run();
287284

288285
* [create](docs/sdks/shorturls/README.md#create) - Shorten a URL.
289286

290-
291287
### [subscriptions](docs/sdks/subscriptions/README.md)
292288

293289
* [activateSubscriptionNamespace](docs/sdks/subscriptions/README.md#activatesubscriptionnamespace) - Activate an ignored namespace for a subscription
@@ -379,7 +375,7 @@ run();
379375
### Error Classes
380376
**Primary errors:**
381377
* [`SpeakeasyError`](./src/sdk/models/errors/speakeasyerror.ts): The base class for HTTP error responses.
382-
* [`ErrorT`](docs/sdk/models/errors/errort.md): The `Status` type defines a logical error model. *
378+
* [`ErrorT`](./src/sdk/models/errors/errort.ts): The `Status` type defines a logical error model. *
383379

384380
<details><summary>Less common errors (6)</summary>
385381

@@ -503,7 +499,7 @@ httpClient.addHook("requestError", (error, request) => {
503499
console.groupEnd();
504500
});
505501

506-
const sdk = new Speakeasy({ httpClient });
502+
const sdk = new Speakeasy({ httpClient: httpClient });
507503
```
508504
<!-- End Custom HTTP Client [http-client] -->
509505

RELEASES.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1706,4 +1706,14 @@ Based on:
17061706
### Generated
17071707
- [typescript v5.0.0-rc.4] .
17081708
### Releases
1709-
- [NPM v5.0.0-rc.4] https://www.npmjs.com/package/@speakeasy-api/speakeasy-client-sdk-typescript/v/5.0.0-rc.4 - .
1709+
- [NPM v5.0.0-rc.4] https://www.npmjs.com/package/@speakeasy-api/speakeasy-client-sdk-typescript/v/5.0.0-rc.4 - .
1710+
1711+
## 2025-10-08 00:19:58
1712+
### Changes
1713+
Based on:
1714+
- OpenAPI Doc
1715+
- Speakeasy CLI 1.636.0 (2.723.2) https://github.com/speakeasy-api/speakeasy
1716+
### Generated
1717+
- [typescript v5.0.0-rc.5] .
1718+
### Releases
1719+
- [NPM v5.0.0-rc.5] https://www.npmjs.com/package/@speakeasy-api/speakeasy-client-sdk-typescript/v/5.0.0-rc.5 - .

RUNTIMES.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
This SDK is intended to be used in JavaScript runtimes that support ECMAScript 2020 or newer. The SDK uses the following features:
44

5-
* [Web Fetch API][web-fetch]
6-
* [Web Streams API][web-streams] and in particular `ReadableStream`
7-
* [Async iterables][async-iter] using `Symbol.asyncIterator`
5+
- [Web Fetch API][web-fetch]
6+
- [Web Streams API][web-streams] and in particular `ReadableStream`
7+
- [Async iterables][async-iter] using `Symbol.asyncIterator`
88

99
[web-fetch]: https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API
1010
[web-streams]: https://developer.mozilla.org/en-US/docs/Web/API/Streams_API
@@ -25,7 +25,7 @@ Runtime environments that are explicitly supported are:
2525

2626
The following `tsconfig.json` options are recommended for projects using this
2727
SDK in order to get static type support for features like async iterables,
28-
streams and `fetch`-related APIs ([`for await...of`][for-await-of],
28+
streams and `fetch`-related APIs ([`for await...of`][for-await-of],
2929
[`AbortSignal`][abort-signal], [`Request`][request], [`Response`][response] and
3030
so on):
3131

@@ -38,11 +38,11 @@ so on):
3838
{
3939
"compilerOptions": {
4040
"target": "es2020", // or higher
41-
"lib": ["es2020", "dom", "dom.iterable"],
41+
"lib": ["es2020", "dom", "dom.iterable"]
4242
}
4343
}
4444
```
4545

4646
While `target` can be set to older ECMAScript versions, it may result in extra,
4747
unnecessary compatibility code being generated if you are not targeting old
48-
runtimes.
48+
runtimes.

docs/sdk/models/operations/createworkspacetokenrequest.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,16 @@
55
```typescript
66
import { CreateWorkspaceTokenRequest } from "@speakeasy-api/speakeasy-client-sdk-typescript/sdk/models/operations";
77

8-
let value: CreateWorkspaceTokenRequest = {};
8+
let value: CreateWorkspaceTokenRequest = {
9+
workspaceToken: {
10+
alg: "<value>",
11+
createdAt: new Date("2023-10-18T04:12:26.286Z"),
12+
id: "<id>",
13+
key: "<key>",
14+
name: "<value>",
15+
workspaceId: "<id>",
16+
},
17+
};
918
```
1019

1120
## Fields

docs/sdk/models/operations/postworkspaceeventsrequest.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,21 @@
55
```typescript
66
import { PostWorkspaceEventsRequest } from "@speakeasy-api/speakeasy-client-sdk-typescript/sdk/models/operations";
77

8-
let value: PostWorkspaceEventsRequest = {};
8+
let value: PostWorkspaceEventsRequest = {
9+
requestBody: [
10+
{
11+
createdAt: new Date("2024-04-27T01:44:18.572Z"),
12+
executionId: "<id>",
13+
id: "<id>",
14+
interactionType: "TOMBSTONE",
15+
localStartedAt: new Date("2024-11-09T15:10:21.242Z"),
16+
speakeasyApiKeyName: "<value>",
17+
speakeasyVersion: "<value>",
18+
success: false,
19+
workspaceId: "<id>",
20+
},
21+
],
22+
};
923
```
1024

1125
## Fields

docs/sdk/models/operations/suggestrequest.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,29 @@ import { SuggestRequest } from "@speakeasy-api/speakeasy-client-sdk-typescript/s
77

88
let value: SuggestRequest = {
99
xSessionId: "<id>",
10+
suggestRequestBody: {
11+
diagnostics: [
12+
{
13+
message: "<value>",
14+
path: [
15+
"/lib",
16+
"/usr/X11R6",
17+
],
18+
type: "<value>",
19+
},
20+
],
21+
oasSummary: {
22+
info: {
23+
description: "yowza huge mutate anguished wring",
24+
license: {},
25+
summary: "<value>",
26+
title: "<value>",
27+
version: "<value>",
28+
},
29+
operations: [],
30+
},
31+
suggestionType: "method-names",
32+
},
1033
};
1134
```
1235

docs/sdk/models/operations/updateworkspacedetailsrequest.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,17 @@
55
```typescript
66
import { UpdateWorkspaceDetailsRequest } from "@speakeasy-api/speakeasy-client-sdk-typescript/sdk/models/operations";
77

8-
let value: UpdateWorkspaceDetailsRequest = {};
8+
let value: UpdateWorkspaceDetailsRequest = {
9+
workspace: {
10+
createdAt: new Date("2023-11-16T00:00:08.537Z"),
11+
id: "<id>",
12+
name: "<value>",
13+
organizationId: "<id>",
14+
slug: "<value>",
15+
updatedAt: new Date("2024-06-14T01:29:49.528Z"),
16+
verified: true,
17+
},
18+
};
919
```
1020

1121
## Fields

0 commit comments

Comments
 (0)