Skip to content

Commit ac32500

Browse files
speakeasybotsrenatus
authored andcommitted
ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.361.1
1 parent 424fbad commit ac32500

Some content is hidden

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

72 files changed

+2116
-1027
lines changed

.speakeasy/gen.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,11 @@ generation:
1212
auth:
1313
oAuth2ClientCredentialsEnabled: false
1414
typescript:
15-
version: 1.3.0
15+
version: 1.4.0
1616
additionalDependencies:
1717
dependencies: {}
1818
devDependencies:
19-
"@types/node": ^20.14.9
19+
'@types/node': ^20.14.9
2020
eslint-plugin-markdown: ^4.0.1
2121
prettier: 3.2.5
2222
testcontainers: ^10.10.1
@@ -54,7 +54,7 @@ typescript:
5454
methodArguments: require-security-and-request
5555
moduleFormat: dual
5656
outputModelSuffix: output
57-
packageName: "@styra/opa"
57+
packageName: '@styra/opa'
5858
responseFormat: envelope-http
5959
templateVersion: v2
6060
useIndexModules: true

.speakeasy/workflow.lock

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
1-
speakeasyVersion: 1.334.0
1+
speakeasyVersion: 1.361.1
22
sources:
33
openapi:
44
sourceNamespace: openapi
5-
sourceRevisionDigest: sha256:93669fe964484357296c2154d1c86aef99d8ca473969ee8d70e6710ed0d80ddb
6-
sourceBlobDigest: sha256:bff74eb96d1677dce36fd84c18da761c1a7739ec423eb3eb1bab869e5bf48321
5+
sourceRevisionDigest: sha256:041a9c6f5a9a2ad11fb0ecb4c958ee21331d4c1df411241715405a481a0842f4
6+
sourceBlobDigest: sha256:1278b402479d50883b21bc284419cdd247db61f17087a97dd47531b54f0c326c
77
tags:
88
- latest
9-
- main
9+
- dependabot-npm_and_yarn-multi-875484771a
1010
targets:
1111
first-target:
1212
source: openapi
1313
sourceNamespace: openapi
14-
sourceRevisionDigest: sha256:93669fe964484357296c2154d1c86aef99d8ca473969ee8d70e6710ed0d80ddb
15-
sourceBlobDigest: sha256:bff74eb96d1677dce36fd84c18da761c1a7739ec423eb3eb1bab869e5bf48321
14+
sourceRevisionDigest: sha256:041a9c6f5a9a2ad11fb0ecb4c958ee21331d4c1df411241715405a481a0842f4
15+
sourceBlobDigest: sha256:1278b402479d50883b21bc284419cdd247db61f17087a97dd47531b54f0c326c
1616
outLocation: packages/opa
1717
workflow:
1818
workflowVersion: 1.0.0

package-lock.json

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

packages/opa/.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
/funcs
2+
/core.*
13
/esm
24
/dist
35
/.tshy

packages/opa/.speakeasy/gen.lock

Lines changed: 26 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,51 +1,66 @@
11
lockVersion: 2.0.0
22
id: 078615ff-ff96-44f8-8aca-2f4d3e687bf0
33
management:
4-
docChecksum: 965922378d3f89a95cf055454ae72ad7
4+
docChecksum: 553ed43ff98c81b3e770c34850f0b5f5
55
docVersion: 0.2.0
6-
speakeasyVersion: 1.334.0
7-
generationVersion: 2.369.0
8-
releaseVersion: 1.3.0
9-
configChecksum: 25eea4d12bca4a64556ebe5572cdafb3
6+
speakeasyVersion: 1.361.1
7+
generationVersion: 2.393.4
8+
releaseVersion: 1.4.0
9+
configChecksum: 931fe09dabde06c0b0a9d81cf9c8e1da
1010
repoURL: https://github.com/StyraInc/opa-typescript.git
1111
repoSubDirectory: packages/opa
1212
installationURL: https://gitpkg.now.sh/StyraInc/opa-typescript/packages/opa
1313
features:
1414
typescript:
1515
additionalDependencies: 0.1.0
16-
constsAndDefaults: 0.1.5
17-
core: 3.11.6
16+
constsAndDefaults: 0.1.7
17+
core: 3.13.1
1818
defaultEnabledRetries: 0.1.0
19+
envVarSecurityUsage: 0.1.1
1920
examples: 2.81.4
2021
flattening: 2.81.1
22+
globalSecurity: 2.82.11
2123
globalSecurityCallbacks: 0.1.0
24+
globalSecurityFlattening: 0.1.0
2225
globalServerURLs: 2.82.4
2326
responseFormat: 0.2.3
2427
retries: 2.83.0
2528
sdkHooks: 0.1.0
26-
unions: 2.85.5
29+
unions: 2.85.7
2730
generatedFiles:
31+
- src/funcs/executeDefaultPolicyWithInput.ts
32+
- src/funcs/executePolicy.ts
33+
- src/funcs/executePolicyWithInput.ts
34+
- src/funcs/executeBatchPolicyWithInput.ts
35+
- src/funcs/health.ts
2836
- src/sdk/sdk.ts
2937
- .eslintrc.cjs
3038
- RUNTIMES.md
3139
- jsr.json
3240
- package.json
41+
- src/core.ts
3342
- src/lib/base64.ts
3443
- src/lib/config.ts
44+
- src/lib/dlv.ts
3545
- src/lib/encodings.ts
3646
- src/lib/http.ts
3747
- src/lib/is-plain-object.ts
48+
- src/lib/logger.ts
49+
- src/lib/matchers.ts
3850
- src/lib/primitives.ts
3951
- src/lib/retries.ts
4052
- src/lib/schemas.ts
4153
- src/lib/sdks.ts
4254
- src/lib/security.ts
4355
- src/lib/url.ts
4456
- src/sdk/index.ts
57+
- src/sdk/models/errors/httpclienterrors.ts
4558
- src/sdk/models/errors/sdkerror.ts
4659
- src/sdk/models/errors/sdkvalidationerror.ts
4760
- src/types/blobs.ts
61+
- src/types/constdatetime.ts
4862
- src/types/enums.ts
63+
- src/types/fp.ts
4964
- src/types/index.ts
5065
- src/types/operations.ts
5166
- src/types/rfcdate.ts
@@ -66,6 +81,7 @@ generatedFiles:
6681
- src/sdk/models/components/batchmixedresults.ts
6782
- src/sdk/models/components/batchsuccessfulpolicyevaluation.ts
6883
- src/sdk/models/components/healthyserver.ts
84+
- src/sdk/models/components/security.ts
6985
- src/sdk/models/errors/clienterror.ts
7086
- src/sdk/models/errors/servererror.ts
7187
- src/sdk/models/errors/batchservererror.ts
@@ -102,6 +118,7 @@ generatedFiles:
102118
- docs/sdk/models/components/batchmixedresults.md
103119
- docs/sdk/models/components/batchsuccessfulpolicyevaluation.md
104120
- docs/sdk/models/components/healthyserver.md
121+
- docs/sdk/models/components/security.md
105122
- docs/sdk/models/errors/location.md
106123
- docs/sdk/models/errors/errors.md
107124
- docs/sdk/models/errors/clienterror.md
@@ -117,3 +134,4 @@ generatedFiles:
117134
- src/hooks/hooks.ts
118135
- src/hooks/types.ts
119136
- src/hooks/index.ts
137+
- CONTRIBUTING.md

packages/opa/CONTRIBUTING.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Contributing to This Repository
2+
3+
Thank you for your interest in contributing to this repository. Please note that this repository contains generated code. As such, we do not accept direct changes or pull requests. Instead, we encourage you to follow the guidelines below to report issues and suggest improvements.
4+
5+
## How to Report Issues
6+
7+
If you encounter any bugs or have suggestions for improvements, please open an issue on GitHub. When reporting an issue, please provide as much detail as possible to help us reproduce the problem. This includes:
8+
9+
- A clear and descriptive title
10+
- Steps to reproduce the issue
11+
- Expected and actual behavior
12+
- Any relevant logs, screenshots, or error messages
13+
- Information about your environment (e.g., operating system, software versions)
14+
- For example can be collected using the `npx envinfo` command from your terminal if you have Node.js installed
15+
16+
## Issue Triage and Upstream Fixes
17+
18+
We will review and triage issues as quickly as possible. Our goal is to address bugs and incorporate improvements in the upstream source code. Fixes will be included in the next generation of the generated code.
19+
20+
## Contact
21+
22+
If you have any questions or need further assistance, please feel free to reach out by opening an issue.
23+
24+
Thank you for your understanding and cooperation!
25+
26+
The Maintainers

packages/opa/README.md

Lines changed: 58 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -301,28 +301,22 @@ Some of the endpoints in this SDK support retries. If you use the SDK without a
301301
To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:
302302
```typescript
303303
import { OpaApiClient } from "@styra/opa";
304-
import { GzipAcceptEncoding } from "@styra/opa/sdk/models/components";
305304

306305
const opaApiClient = new OpaApiClient();
307306

308307
async function run() {
309-
const result = await opaApiClient.executeDefaultPolicyWithInput(
310-
8203.11,
311-
false,
312-
GzipAcceptEncoding.Gzip,
313-
{
314-
retries: {
315-
strategy: "backoff",
316-
backoff: {
317-
initialInterval: 1,
318-
maxInterval: 50,
319-
exponent: 1.1,
320-
maxElapsedTime: 100,
321-
},
322-
retryConnectionErrors: false,
308+
const result = await opaApiClient.executeDefaultPolicyWithInput(8203.11, {
309+
retries: {
310+
strategy: "backoff",
311+
backoff: {
312+
initialInterval: 1,
313+
maxInterval: 50,
314+
exponent: 1.1,
315+
maxElapsedTime: 100,
323316
},
324-
}
325-
);
317+
retryConnectionErrors: false,
318+
},
319+
});
326320

327321
// Handle the result
328322
console.log(result);
@@ -335,7 +329,6 @@ run();
335329
If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:
336330
```typescript
337331
import { OpaApiClient } from "@styra/opa";
338-
import { GzipAcceptEncoding } from "@styra/opa/sdk/models/components";
339332

340333
const opaApiClient = new OpaApiClient({
341334
retryConfig: {
@@ -351,11 +344,7 @@ const opaApiClient = new OpaApiClient({
351344
});
352345

353346
async function run() {
354-
const result = await opaApiClient.executeDefaultPolicyWithInput(
355-
8203.11,
356-
false,
357-
GzipAcceptEncoding.Gzip
358-
);
347+
const result = await opaApiClient.executeDefaultPolicyWithInput(8203.11);
359348

360349
// Handle the result
361350
console.log(result);
@@ -366,6 +355,52 @@ run();
366355
```
367356
<!-- End Retries [retries] -->
368357

358+
<!-- Start Authentication [security] -->
359+
## Authentication
360+
361+
### Per-Client Security Schemes
362+
363+
This SDK supports the following security scheme globally:
364+
365+
| Name | Type | Scheme |
366+
| ------------ | ------------ | ------------ |
367+
| `bearerAuth` | http | HTTP Bearer |
368+
369+
To authenticate with the API the `bearerAuth` parameter must be set when initializing the SDK client instance. For example:
370+
```typescript
371+
import { OpaApiClient } from "@styra/opa";
372+
373+
const opaApiClient = new OpaApiClient({
374+
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
375+
});
376+
377+
async function run() {
378+
const result = await opaApiClient.executeDefaultPolicyWithInput(8203.11);
379+
380+
// Handle the result
381+
console.log(result);
382+
}
383+
384+
run();
385+
386+
```
387+
<!-- End Authentication [security] -->
388+
389+
<!-- Start Debugging [debug] -->
390+
## Debugging
391+
392+
To log HTTP requests and responses, you can pass a logger that matches `console`'s interface as an SDK option.
393+
394+
> [!WARNING]
395+
> Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.
396+
397+
```typescript
398+
import { OpaApiClient } from "@styra/opa";
399+
400+
const sdk = new OpaApiClient({ debugLogger: console });
401+
```
402+
<!-- End Debugging [debug] -->
403+
369404
<!-- Placeholder for Future Speakeasy SDK Sections -->
370405

371406
## Community

packages/opa/RELEASES.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -397,4 +397,12 @@ Based on:
397397
- OpenAPI Doc
398398
- Speakeasy CLI 1.334.0 (2.369.0) https://github.com/speakeasy-api/speakeasy
399399
### Generated
400-
- [typescript v1.3.0] packages/opa
400+
- [typescript v1.3.0] packages/opa
401+
402+
## 2024-08-12 08:27:31
403+
### Changes
404+
Based on:
405+
- OpenAPI Doc
406+
- Speakeasy CLI 1.361.1 (2.393.4) https://github.com/speakeasy-api/speakeasy
407+
### Generated
408+
- [typescript v1.4.0] packages/opa

packages/opa/USAGE.md

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,11 @@
11
<!-- Start SDK Example Usage [usage] -->
22
```typescript
33
import { OpaApiClient } from "@styra/opa";
4-
import { GzipAcceptEncoding } from "@styra/opa/sdk/models/components";
54

65
const opaApiClient = new OpaApiClient();
76

87
async function run() {
9-
const result = await opaApiClient.executeDefaultPolicyWithInput(
10-
8203.11,
11-
false,
12-
GzipAcceptEncoding.Gzip
13-
);
8+
const result = await opaApiClient.executeDefaultPolicyWithInput(8203.11);
149

1510
// Handle the result
1611
console.log(result);
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Security
2+
3+
4+
## Fields
5+
6+
| Field | Type | Required | Description |
7+
| ------------------ | ------------------ | ------------------ | ------------------ |
8+
| `bearerAuth` | *string* | :heavy_minus_sign: | N/A |

packages/opa/docs/sdks/opaapiclient/README.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,11 @@ Execute the default decision given an input
2121

2222
```typescript
2323
import { OpaApiClient } from "@styra/opa";
24-
import { GzipAcceptEncoding } from "@styra/opa/sdk/models/components";
2524

2625
const opaApiClient = new OpaApiClient();
2726

2827
async function run() {
29-
const result = await opaApiClient.executeDefaultPolicyWithInput(8203.11, false, GzipAcceptEncoding.Gzip);
28+
const result = await opaApiClient.executeDefaultPolicyWithInput(8203.11);
3029

3130
// Handle the result
3231
console.log(result)
@@ -210,9 +209,7 @@ import { OpaApiClient } from "@styra/opa";
210209
const opaApiClient = new OpaApiClient();
211210

212211
async function run() {
213-
const result = await opaApiClient.health(false, false, [
214-
"<value>",
215-
]);
212+
const result = await opaApiClient.health();
216213

217214
// Handle the result
218215
console.log(result)

packages/opa/jsr.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
{
44
"name": "@styra/opa",
5-
"version": "1.3.0",
5+
"version": "1.4.0",
66
"exports": {
77
".": "./src/index.ts",
88
"./sdk/models/errors": "./src/sdk/models/errors/index.ts",

packages/opa/package.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@styra/opa",
3-
"version": "1.3.0",
3+
"version": "1.4.0",
44
"author": "Styra",
55
"license": "Apache-2.0",
66
"publishConfig": {
@@ -53,9 +53,9 @@
5353
"testcontainers": "^10.10.1",
5454
"tshy": "^1.16.2",
5555
"tsx": "^4.16.2",
56-
"typedoc": "^0.25.13",
57-
"typedoc-plugin-extras": "^3.0.0",
58-
"typedoc-plugin-replace-text": "^3.3.0",
56+
"typedoc": "^0.26.5",
57+
"typedoc-plugin-extras": "^3.1.0",
58+
"typedoc-plugin-replace-text": "^4.0.0",
5959
"typescript": "^5.4.5",
6060
"zod": "^3.23.4"
6161
},

0 commit comments

Comments
 (0)