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: refactor custom framework utils to reuse them #933

Merged

Conversation

deepjyoti30-st
Copy link
Contributor

@deepjyoti30-st deepjyoti30-st commented Oct 2, 2024

Summary of change

This PR adds support for exposing re-usable util functions that can be used for custom frameworks to minimize the code required to set them up.

Related issues

Test Plan

  • All the customFramework related test should pass

Documentation changes

(If relevant, please create a PR in our docs repo, or create a checklist here highlighting the necessary changes)

Checklist for important updates

  • Changelog has been updated
  • coreDriverInterfaceSupported.json file has been updated (if needed)
    • Along with the associated array in lib/ts/version.ts
  • frontendDriverInterfaceSupported.json file has been updated (if needed)
  • Changes to the version if needed
    • In package.json
    • In package-lock.json
    • In lib/ts/version.ts
  • Had run npm run build-pretty
  • Had installed and ran the pre-commit hook
  • If new thirdparty provider is added,
    • update switch statement in recipe/thirdparty/providers/configUtils.ts file, createProvider function.
    • add an icon on the user management dashboard.
  • Issue this PR against the latest non released version branch.
    • To know which one it is, run find the latest released tag (git tag) in the format vX.Y.Z, and then find the latest branch (git branch --all) whose X.Y is greater than the latest released tag.
    • If no such branch exists, then create one from the latest released branch.
  • If have added a new web framework, update the add-ts-no-check.js file to include that
  • If added a new recipe / api interface, then make sure that the implementation of it uses NON arrow functions only (like someFunc: function () {..}).
  • If added a new recipe, then make sure to expose it inside the recipe folder present in the root of this repo. We also need to expose its types.
  • If added a new entry point, then make sure that it is importable by adding it to the exports in package.json

Remaining TODOs for this PR

Copy link

cloudflare-workers-and-pages bot commented Oct 2, 2024

Deploying supertokens-node-pr-check-for-edge-function-compat with  Cloudflare Pages  Cloudflare Pages

Latest commit: 31003c7
Status: ✅  Deploy successful!
Preview URL: https://6532a5ce.supertokens-node-b95.pages.dev

View logs

lib/ts/customFramework.ts Show resolved Hide resolved
lib/ts/version.ts Outdated Show resolved Hide resolved
package.json Outdated Show resolved Hide resolved
lib/ts/customFramework.ts Outdated Show resolved Hide resolved
lib/ts/customFramework.ts Outdated Show resolved Hide resolved
@deepjyoti30-st deepjyoti30-st force-pushed the feat/refactor-custom-framework-utils-to-reuse-them branch from abea857 to 2d18d33 Compare October 4, 2024 07:36
@deepjyoti30-st deepjyoti30-st changed the base branch from 20.1 to 21.0 October 4, 2024 07:36
CHANGELOG.md Show resolved Hide resolved
@deepjyoti30-st
Copy link
Contributor Author

Manual testing of the above points with the newer branch (besides the automated ones that I have already added):

https://jam.dev/c/d2276852-893c-4213-bafd-3200b914dbc8

@deepjyoti30-st deepjyoti30-st force-pushed the feat/refactor-custom-framework-utils-to-reuse-them branch from c4868b8 to 75c4e28 Compare October 7, 2024 08:06
test/nextjs.test.js Show resolved Hide resolved
@rishabhpoddar rishabhpoddar merged commit 0e21e6d into 21.0 Oct 7, 2024
6 of 19 checks passed
@rishabhpoddar rishabhpoddar deleted the feat/refactor-custom-framework-utils-to-reuse-them branch October 7, 2024 11:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants