Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add myaccount apis #1158

Closed
wants to merge 16 commits into from
Closed
Show file tree
Hide file tree
Changes from 6 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .bacon.yml
Original file line number Diff line number Diff line change
Expand Up @@ -83,11 +83,11 @@ test_suites:
script_name: e2e-express-embedded-sign-in-widget
criteria: MERGE
queue_name: small
- name: e2e-react-oie
- name: e2e-react-embedded-auth-with-sdk
script_path: ../okta-auth-js/scripts
sort_order: '12'
timeout: '20'
script_name: e2e-react-oie
script_name: e2e-react-embedded-auth-with-sdk
criteria: MERGE
queue_name: small
# Sauce labs tests are flaky due to the free account we are currently using
Expand Down
3 changes: 2 additions & 1 deletion .eslintrc.js
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,8 @@ module.exports = {
// features that are not supported before v12 are transformed in babel.cjs.js for commonjs output
version: '>=12.0.0'
}],
'import/no-commonjs': 'error'
'import/no-commonjs': 'error',
"jsdoc/check-tag-names": 0
},
settings: {
// https://github.com/import-js/eslint-plugin-import#typescript
Expand Down
1 change: 1 addition & 0 deletions .husky/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
_
4 changes: 4 additions & 0 deletions .husky/pre-commit
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
#!/bin/sh
. "$(dirname "$0")/_/husky.sh"

npx lint-staged
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why are we adding this with this PR? Is this required for myaccount? I'd prefer to have a separate conversation about pre-commit hooks and handle it in a separate PR. Also why npx instead of yarn?

Copy link
Contributor Author

@shuowu shuowu Jun 16, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I feel we will want to take doc/code consistency as the first priority. In this PR, docs for myaccount is generated from code/types, and it's easy to miss to run doc update script when code changes happen. This pre-commit hook here is a solution to keep things in sync.

I understand it may affect a bit devex, but here I would prefer to take consistency over devex.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could this be done as a pre-push step instead of pre-commit? When rebasing we do a lot of commits, but there is only one push at the end.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

pre-push cannot just handle staged files, this lint staged won't run scripts when no file matches the regex.

6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -869,6 +869,7 @@ This is accomplished by selecting a single tab to handle the network requests to
* [session.get](#sessionget)
* [session.refresh](#sessionrefresh)
* [idx](#idx)
* [myaccount](#myaccount)
* [token](#token)
* [token.getWithoutPrompt](#tokengetwithoutpromptoptions)
* [token.getWithPopup](#tokengetwithpopupoptions)
Expand Down Expand Up @@ -1260,6 +1261,11 @@ authClient.session.refresh()

See detail in [IDX README](docs/idx.md)

### `myaccount`

See detail in [MyAccount API README](docs/myaccount/README.md)


### `token`

#### Authorize options
Expand Down
1 change: 1 addition & 0 deletions docs/.gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
myaccount/**/* linguist-generated=true
136 changes: 136 additions & 0 deletions docs/myaccount/README.md

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

69 changes: 69 additions & 0 deletions docs/myaccount/classes/types.BaseTransaction.md

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading