Skip to content

Commit 80df22f

Browse files
Release 2.0.5
1 parent 6ea1e01 commit 80df22f

Some content is hidden

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

44 files changed

+4194
-928
lines changed

.fern/metadata.json

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
{
2+
"cliVersion": "1.1.0",
3+
"generatorName": "fernapi/fern-typescript-sdk",
4+
"generatorVersion": "3.29.2",
5+
"generatorConfig": {
6+
"namespaceExport": "BrowserUse",
7+
"packageJson": {
8+
"description": "The official TypeScript library for the Browser Use API",
9+
"author": {
10+
"name": "Browser Use",
11+
"url": "https://browser-use.com",
12+
"email": "[email protected]"
13+
},
14+
"scripts": {
15+
"tsn": "ts-node -r tsconfig-paths/register"
16+
}
17+
},
18+
"extraDependencies": {
19+
"fast-json-stable-stringify": "^2.1.0"
20+
},
21+
"extraDevDependencies": {
22+
"@dotenvx/dotenvx": "^1.49.0",
23+
"react": "^19.1.1",
24+
"react-dom": "^19.1.1",
25+
"tsconfig-paths": "^4.2.0",
26+
"ts-node": "^10.5.0",
27+
"zod": "^4"
28+
},
29+
"extraPeerDependencies": {
30+
"react": "^18 || ^19",
31+
"zod": "^4"
32+
}
33+
}
34+
}

.github/workflows/ci.yml

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ jobs:
1111
uses: actions/checkout@v4
1212

1313
- name: Set up node
14-
uses: actions/setup-node@v3
14+
uses: actions/setup-node@v4
1515

1616
- name: Install pnpm
1717
uses: pnpm/action-setup@v4
@@ -30,7 +30,7 @@ jobs:
3030
uses: actions/checkout@v4
3131

3232
- name: Set up node
33-
uses: actions/setup-node@v3
33+
uses: actions/setup-node@v4
3434

3535
- name: Install pnpm
3636
uses: pnpm/action-setup@v4
@@ -50,7 +50,7 @@ jobs:
5050
uses: actions/checkout@v4
5151

5252
- name: Set up node
53-
uses: actions/setup-node@v3
53+
uses: actions/setup-node@v4
5454

5555
- name: Install pnpm
5656
uses: pnpm/action-setup@v4
@@ -64,12 +64,15 @@ jobs:
6464
- name: Publish to npm
6565
run: |
6666
npm config set //registry.npmjs.org/:_authToken ${NPM_TOKEN}
67+
publish() { # use latest npm to ensure OIDC support
68+
npx -y npm@latest publish "$@"
69+
}
6770
if [[ ${GITHUB_REF} == *alpha* ]]; then
68-
npm publish --access public --tag alpha
71+
publish --access public --tag alpha
6972
elif [[ ${GITHUB_REF} == *beta* ]]; then
70-
npm publish --access public --tag beta
73+
publish --access public --tag beta
7174
else
72-
npm publish --access public
75+
publish --access public
7376
fi
7477
env:
7578
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

.npmignore

Lines changed: 0 additions & 10 deletions
This file was deleted.

CONTRIBUTING.md

Lines changed: 133 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
1+
# Contributing
2+
3+
Thanks for your interest in contributing to this SDK! This document provides guidelines for contributing to the project.
4+
5+
## Getting Started
6+
7+
### Prerequisites
8+
9+
- Node.js 20 or higher
10+
- pnpm package manager
11+
12+
### Installation
13+
14+
Install the project dependencies:
15+
16+
```bash
17+
pnpm install
18+
```
19+
20+
### Building
21+
22+
Build the project:
23+
24+
```bash
25+
pnpm build
26+
```
27+
28+
### Testing
29+
30+
Run the test suite:
31+
32+
```bash
33+
pnpm test
34+
```
35+
36+
Run specific test types:
37+
- `pnpm test:unit` - Run unit tests
38+
- `pnpm test:wire` - Run wire/integration tests
39+
40+
### Linting and Formatting
41+
42+
Check code style:
43+
44+
```bash
45+
pnpm run lint
46+
pnpm run format:check
47+
```
48+
49+
Fix code style issues:
50+
51+
```bash
52+
pnpm run lint:fix
53+
pnpm run format:fix
54+
```
55+
56+
Or use the combined check command:
57+
58+
```bash
59+
pnpm run check:fix
60+
```
61+
62+
## About Generated Code
63+
64+
**Important**: Most files in this SDK are automatically generated by [Fern](https://buildwithfern.com) from the API definition. Direct modifications to generated files will be overwritten the next time the SDK is generated.
65+
66+
### Generated Files
67+
68+
The following directories contain generated code:
69+
- `src/api/` - API client classes and types
70+
- `src/serialization/` - Serialization/deserialization logic
71+
- Most TypeScript files in `src/`
72+
73+
### How to Customize
74+
75+
If you need to customize the SDK, you have two options:
76+
77+
#### Option 1: Use `.fernignore`
78+
79+
For custom code that should persist across SDK regenerations:
80+
81+
1. Create a `.fernignore` file in the project root
82+
2. Add file patterns for files you want to preserve (similar to `.gitignore` syntax)
83+
3. Add your custom code to those files
84+
85+
Files listed in `.fernignore` will not be overwritten when the SDK is regenerated.
86+
87+
For more information, see the [Fern documentation on custom code](https://buildwithfern.com/learn/sdks/overview/custom-code).
88+
89+
#### Option 2: Contribute to the Generator
90+
91+
If you want to change how code is generated for all users of this SDK:
92+
93+
1. The TypeScript SDK generator lives in the [Fern repository](https://github.com/fern-api/fern)
94+
2. Generator code is located at `generators/typescript/sdk/`
95+
3. Follow the [Fern contributing guidelines](https://github.com/fern-api/fern/blob/main/CONTRIBUTING.md)
96+
4. Submit a pull request with your changes to the generator
97+
98+
This approach is best for:
99+
- Bug fixes in generated code
100+
- New features that would benefit all users
101+
- Improvements to code generation patterns
102+
103+
## Making Changes
104+
105+
### Workflow
106+
107+
1. Create a new branch for your changes
108+
2. Make your modifications
109+
3. Run tests to ensure nothing breaks: `pnpm test`
110+
4. Run linting and formatting: `pnpm run check:fix`
111+
5. Build the project: `pnpm build`
112+
6. Commit your changes with a clear commit message
113+
7. Push your branch and create a pull request
114+
115+
### Commit Messages
116+
117+
Write clear, descriptive commit messages that explain what changed and why.
118+
119+
### Code Style
120+
121+
This project uses automated code formatting and linting. Run `pnpm run check:fix` before committing to ensure your code meets the project's style guidelines.
122+
123+
## Questions or Issues?
124+
125+
If you have questions or run into issues:
126+
127+
1. Check the [Fern documentation](https://buildwithfern.com)
128+
2. Search existing [GitHub issues](https://github.com/fern-api/fern/issues)
129+
3. Open a new issue if your question hasn't been addressed
130+
131+
## License
132+
133+
By contributing to this project, you agree that your contributions will be licensed under the same license as the project.

biome.json

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,27 @@
11
{
2-
"$schema": "https://biomejs.dev/schemas/2.2.5/schema.json",
2+
"$schema": "https://biomejs.dev/schemas/2.3.1/schema.json",
33
"root": true,
44
"vcs": {
55
"enabled": false
66
},
77
"files": {
88
"ignoreUnknown": true,
99
"includes": [
10-
"./**",
11-
"!dist",
12-
"!lib",
13-
"!*.tsbuildinfo",
14-
"!_tmp_*",
15-
"!*.tmp",
16-
"!.tmp/",
17-
"!*.log",
18-
"!.DS_Store",
19-
"!Thumbs.db"
10+
"**",
11+
"!!dist",
12+
"!!**/dist",
13+
"!!lib",
14+
"!!**/lib",
15+
"!!_tmp_*",
16+
"!!**/_tmp_*",
17+
"!!*.tmp",
18+
"!!**/*.tmp",
19+
"!!.tmp/",
20+
"!!**/.tmp/",
21+
"!!*.log",
22+
"!!**/*.log",
23+
"!!**/.DS_Store",
24+
"!!**/Thumbs.db"
2025
]
2126
},
2227
"formatter": {

package.json

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,9 @@
3030
],
3131
"scripts": {
3232
"format": "biome format --write --skip-parse-errors --no-errors-on-unmatched --max-diagnostics=none",
33+
"format:check": "biome format --skip-parse-errors --no-errors-on-unmatched --max-diagnostics=none",
34+
"lint": "biome lint --skip-parse-errors --no-errors-on-unmatched --max-diagnostics=none",
35+
"lint:fix": "biome lint --fix --unsafe --skip-parse-errors --no-errors-on-unmatched --max-diagnostics=none",
3336
"check": "biome check --skip-parse-errors --no-errors-on-unmatched --max-diagnostics=none",
3437
"check:fix": "biome check --fix --unsafe --skip-parse-errors --no-errors-on-unmatched --max-diagnostics=none",
3538
"build": "pnpm build:cjs && pnpm build:esm",
@@ -53,8 +56,8 @@
5356
"vitest": "^3.2.4",
5457
"msw": "2.11.2",
5558
"@types/node": "^18.19.70",
56-
"@biomejs/biome": "2.2.5",
5759
"typescript": "~5.7.2",
60+
"@biomejs/biome": "2.3.1",
5861
"@dotenvx/dotenvx": "^1.49.0",
5962
"react": "^19.1.1",
6063
"react-dom": "^19.1.1",
@@ -68,7 +71,7 @@
6871
"path": false,
6972
"stream": false
7073
},
71-
"packageManager": "pnpm@10.14.0",
74+
"packageManager": "pnpm@10.20.0",
7275
"engines": {
7376
"node": ">=18.0.0"
7477
},

0 commit comments

Comments
 (0)