Skip to content

Commit 36456f8

Browse files
chore: enhance pagination API with improved type safety (#1226)
Co-authored-by: fern-api[bot] <115122769+fern-api[bot]@users.noreply.github.com> Co-authored-by: Kunal Dawar <kunal.dawar@okta.com>
1 parent fd8a406 commit 36456f8

62 files changed

Lines changed: 695 additions & 819 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.

.fernignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,3 +47,4 @@ eslint.config.mjs
4747
.husky/
4848

4949
.prettierignore
50+
CONTRIBUTING.md

CONTRIBUTING.md

Lines changed: 138 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,138 @@
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+
38+
- `yarn test:unit` - Run unit tests
39+
- `yarn test:wire` - Run wire/integration tests
40+
41+
### Linting and Formatting
42+
43+
Check code style:
44+
45+
```bash
46+
yarn run lint
47+
yarn run format:check
48+
```
49+
50+
Fix code style issues:
51+
52+
```bash
53+
yarn run lint:fix
54+
yarn run format:fix
55+
```
56+
57+
Or use the combined check command:
58+
59+
```bash
60+
yarn run check:fix
61+
```
62+
63+
## About Generated Code
64+
65+
**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.
66+
67+
### Generated Files
68+
69+
The following directories contain generated code:
70+
71+
- `src/api/` - API client classes and types
72+
- `src/serialization/` - Serialization/deserialization logic
73+
- Most TypeScript files in `src/`
74+
75+
### How to Customize
76+
77+
If you need to customize the SDK, you have two options:
78+
79+
#### Option 1: Use `.fernignore`
80+
81+
For custom code that should persist across SDK regenerations:
82+
83+
1. Create a `.fernignore` file in the project root
84+
2. Add file patterns for files you want to preserve (similar to `.gitignore` syntax)
85+
3. Add your custom code to those files
86+
87+
Files listed in `.fernignore` will not be overwritten when the SDK is regenerated.
88+
89+
For more information, see the [Fern documentation on custom code](https://buildwithfern.com/learn/sdks/overview/custom-code).
90+
91+
#### Option 2: Contribute to the Generator
92+
93+
If you want to change how code is generated for all users of this SDK:
94+
95+
1. The TypeScript SDK generator lives in the [Fern repository](https://github.com/fern-api/fern)
96+
2. Generator code is located at `generators/typescript/sdk/`
97+
3. Follow the [Fern contributing guidelines](https://github.com/fern-api/fern/blob/main/CONTRIBUTING.md)
98+
4. Submit a pull request with your changes to the generator
99+
100+
This approach is best for:
101+
102+
- Bug fixes in generated code
103+
- New features that would benefit all users
104+
- Improvements to code generation patterns
105+
106+
## Making Changes
107+
108+
### Workflow
109+
110+
1. Create a new branch for your changes
111+
2. Make your modifications
112+
3. Run tests to ensure nothing breaks: `yarn test`
113+
4. Run linting and formatting: `yarn run check:fix`
114+
5. Build the project: `yarn build`
115+
6. Commit your changes with a clear commit message
116+
7. Push your branch and create a pull request
117+
118+
### Commit Messages
119+
120+
Write clear, descriptive commit messages that explain what changed and why.
121+
122+
### Code Style
123+
124+
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.
125+
126+
## Questions or Issues?
127+
128+
If you have questions or run into issues:
129+
130+
1. Check the [Auth0 documentation](https://auth0.com/docs)
131+
2. Search existing [GitHub issues](https://github.com/auth0/myaccount-js/issues)
132+
3. Open a new issue if your question hasn't been addressed
133+
134+
For questions about the Fern code generator itself, see the [Fern documentation](https://buildwithfern.com) or [Fern repository](https://github.com/fern-api/fern).
135+
136+
## License
137+
138+
By contributing to this project, you agree that your contributions will be licensed under the same license as the project.

0 commit comments

Comments
 (0)