Skip to content

Commit 706baa5

Browse files
fern-api[bot]fern-supportRyan-Amirthanaditya-arolkar-swe
authored
🌿 Fern Regeneration -- March 12, 2026 (#325)
* SDK regeneration * update fernignore files to account for renames and new auth (#328) * update fernignore files to account for renames and new auth * fixed test CI --------- Co-authored-by: Ryan Amirthan Stephen <105958906+Ryan-Amirthan@users.noreply.github.com> Co-authored-by: Aditya Arolkar <aditya.arolkar@berkeley.edu> * Update sdkVersion to 3.3.5 * Bump version from 3.3.4 to 3.3.5 --------- Co-authored-by: fern-api[bot] <115122769+fern-api[bot]@users.noreply.github.com> Co-authored-by: Fern Support <126544928+fern-support@users.noreply.github.com> Co-authored-by: Ryan Amirthan Stephen <105958906+Ryan-Amirthan@users.noreply.github.com> Co-authored-by: Aditya Arolkar <aditya.arolkar@berkeley.edu>
1 parent a870bfe commit 706baa5

167 files changed

Lines changed: 8731 additions & 5352 deletions

File tree

Some content is hidden

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

.fern/metadata.json

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
{
2+
"cliVersion": "4.22.0",
3+
"generatorName": "fernapi/fern-typescript-node-sdk",
4+
"generatorVersion": "3.53.13",
5+
"generatorConfig": {
6+
"namespaceExport": "Webflow",
7+
"skipResponseValidation": true,
8+
"allowExtraFields": true,
9+
"inlineFileProperties": true,
10+
"inlinePathParameters": false,
11+
"enableInlineTypes": false,
12+
"noSerdeLayer": false,
13+
"omitUndefined": true,
14+
"useLegacyExports": true,
15+
"streamType": "wrapper",
16+
"fileResponseType": "stream",
17+
"formDataSupport": "Node16",
18+
"fetchSupport": "node-fetch",
19+
"packageManager": "yarn",
20+
"testFramework": "jest",
21+
"packageJson": {
22+
"dependencies": {
23+
"crypto-browserify": "^3.12.1"
24+
},
25+
"devDependencies": {
26+
"jest-fetch-mock": "^3.0.3"
27+
},
28+
"browser": {
29+
"crypto": false
30+
},
31+
"resolutions": {
32+
"pbkdf2": "^3.1.3",
33+
"@types/babel__traverse": "7.20.6"
34+
}
35+
}
36+
},
37+
"originGitCommit": "f0174d404a2635415e858ef151cf9202df3e3d02",
38+
"sdkVersion": "3.3.5"
39+
}

.github/workflows/ci.yml

Lines changed: 23 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,23 @@ name: ci
22

33
on: [push]
44

5+
concurrency:
6+
group: ${{ github.workflow }}-${{ github.ref }}
7+
cancel-in-progress: false
8+
59
jobs:
610
compile:
711
runs-on: ubuntu-latest
812

913
steps:
1014
- name: Checkout repo
11-
uses: actions/checkout@v4
15+
uses: actions/checkout@v6
1216

1317
- name: Set up node
14-
uses: actions/setup-node@v4
18+
uses: actions/setup-node@v6
1519

1620
- name: Install dependencies
17-
run: yarn install
21+
run: yarn install --frozen-lockfile
1822

1923
- name: Compile
2024
run: yarn build
@@ -24,13 +28,13 @@ jobs:
2428

2529
steps:
2630
- name: Checkout repo
27-
uses: actions/checkout@v4
31+
uses: actions/checkout@v6
2832

2933
- name: Set up node
30-
uses: actions/setup-node@v4
34+
uses: actions/setup-node@v6
3135

3236
- name: Install dependencies
33-
run: yarn install
37+
run: yarn install --frozen-lockfile
3438

3539
- name: Test
3640
run: yarn test
@@ -40,16 +44,17 @@ jobs:
4044
if: github.event_name == 'push' && contains(github.ref, 'refs/tags/')
4145
runs-on: ubuntu-latest
4246
permissions:
47+
contents: read # Required for checkout
4348
id-token: write # Required for OIDC
4449
steps:
4550
- name: Checkout repo
46-
uses: actions/checkout@v4
51+
uses: actions/checkout@v6
4752

4853
- name: Set up node
49-
uses: actions/setup-node@v4
54+
uses: actions/setup-node@v6
5055

5156
- name: Install dependencies
52-
run: yarn install
57+
run: yarn install --frozen-lockfile
5358

5459
- name: Build
5560
run: yarn build
@@ -64,5 +69,13 @@ jobs:
6469
elif [[ ${GITHUB_REF} == *beta* ]]; then
6570
publish --access public --tag beta
6671
else
67-
publish --access public
72+
PKG_NAME=$(node -p "require('./package.json').name")
73+
PKG_VERSION=$(node -p "require('./package.json').version")
74+
CURRENT_LATEST=$(npm view "${PKG_NAME}" dist-tags.latest 2>/dev/null || echo "0.0.0")
75+
if npx -y semver "${PKG_VERSION}" -r "<${CURRENT_LATEST}" > /dev/null 2>&1; then
76+
echo "Publishing ${PKG_VERSION} with --tag backport (current latest is ${CURRENT_LATEST})"
77+
publish --access public --tag backport
78+
else
79+
publish --access public
80+
fi
6881
fi

.npmignore

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,14 @@ tests
44
.gitignore
55
.github
66
.fernignore
7+
.fern
78
.prettierrc.yml
89
biome.json
910
tsconfig.json
1011
yarn.lock
11-
pnpm-lock.yaml
12+
pnpm-lock.yaml
13+
.mock
14+
dist
15+
scripts
16+
jest.config.*
17+
vitest.config.*

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+
- yarn package manager
11+
12+
### Installation
13+
14+
Install the project dependencies:
15+
16+
```bash
17+
yarn install
18+
```
19+
20+
### Building
21+
22+
Build the project:
23+
24+
```bash
25+
yarn build
26+
```
27+
28+
### Testing
29+
30+
Run the test suite:
31+
32+
```bash
33+
yarn test
34+
```
35+
36+
Run specific test types:
37+
- `yarn test:unit` - Run unit tests
38+
- `yarn test:wire` - Run wire/integration tests
39+
40+
### Linting and Formatting
41+
42+
Check code style:
43+
44+
```bash
45+
yarn run lint
46+
yarn run format:check
47+
```
48+
49+
Fix code style issues:
50+
51+
```bash
52+
yarn run lint:fix
53+
yarn run format:fix
54+
```
55+
56+
Or use the combined check command:
57+
58+
```bash
59+
yarn 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: `yarn test`
110+
4. Run linting and formatting: `yarn run check:fix`
111+
5. Build the project: `yarn 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 `yarn 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: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"$schema": "https://biomejs.dev/schemas/2.3.1/schema.json",
2+
"$schema": "https://biomejs.dev/schemas/2.4.3/schema.json",
33
"root": true,
44
"vcs": {
55
"enabled": false

jest.config.mjs

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,19 +8,23 @@ export default {
88
preset: "ts-jest",
99
testEnvironment: "node",
1010
moduleNameMapper: {
11-
"^(\.{1,2}/.*)\.js$": "$1",
11+
"^(\\.{1,2}/.*)\\.js$": "$1",
1212
},
1313
roots: ["<rootDir>/tests"],
1414
testPathIgnorePatterns: ["/tests/wire/"],
15-
setupFilesAfterEnv: [],
15+
setupFilesAfterEnv: ["<rootDir>/tests/setup.ts"],
1616
},
1717
{
1818
displayName: "wire",
1919
preset: "ts-jest",
2020
testEnvironment: "node",
2121
moduleNameMapper: {
22-
"^(\.{1,2}/.*)\.js$": "$1",
22+
"^(\\.{1,2}/.*)\\.js$": "$1",
2323
},
24+
transform: {
25+
"^.+\\.[jt]sx?$": ["ts-jest", { tsconfig: { allowJs: true } }],
26+
},
27+
transformIgnorePatterns: ["/node_modules/(?!(until-async|msw|@mswjs)/)"],
2428
roots: ["<rootDir>/tests/wire"],
2529
setupFilesAfterEnv: ["<rootDir>/tests/mock-server/setup.ts"],
2630
},

package.json

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
11
{
22
"name": "webflow-api",
3-
"version": "3.3.4",
3+
"version": "3.3.5",
44
"private": false,
5-
"repository": "github:webflow/js-webflow-api",
5+
"repository": {
6+
"type": "git",
7+
"url": "git+https://github.com/webflow/js-webflow-api.git"
8+
},
69
"license": "MIT",
710
"main": "./index.js",
811
"types": "./index.d.ts",
@@ -39,7 +42,7 @@
3942
"msw": "2.11.2",
4043
"@types/node": "^18.19.70",
4144
"typescript": "~5.7.2",
42-
"@biomejs/biome": "2.3.1",
45+
"@biomejs/biome": "2.4.3",
4346
"jest-fetch-mock": "^3.0.3"
4447
},
4548
"browser": {

0 commit comments

Comments
 (0)