From 2961bc9747238f7876b4b5a299ecc175566846db Mon Sep 17 00:00:00 2001 From: Jonas Hungershausen Date: Fri, 1 Nov 2024 12:56:20 +0100 Subject: [PATCH] chore: update README.md & development instructions --- packages/elements-react/.npmignore | 5 +- packages/elements-react/DEVELOPMENT.md | 83 ++++++++++ packages/elements-react/LICENSE | 201 +++++++++++++++++++++++++ packages/elements-react/README.md | 136 +++++++++++++---- 4 files changed, 395 insertions(+), 30 deletions(-) create mode 100644 packages/elements-react/DEVELOPMENT.md create mode 100644 packages/elements-react/LICENSE diff --git a/packages/elements-react/.npmignore b/packages/elements-react/.npmignore index ad3319e0d..7b50be7b4 100644 --- a/packages/elements-react/.npmignore +++ b/packages/elements-react/.npmignore @@ -6,4 +6,7 @@ playwright-ct.config.ts project.json tsup.config.ts tsconfig.test.json -!dist/ \ No newline at end of file +!dist/ +api-report/ +DEVELOPEMENT.md +jest.config.ts \ No newline at end of file diff --git a/packages/elements-react/DEVELOPMENT.md b/packages/elements-react/DEVELOPMENT.md new file mode 100644 index 000000000..933956e9a --- /dev/null +++ b/packages/elements-react/DEVELOPMENT.md @@ -0,0 +1,83 @@ +# Developing @ory/elements-react + +Ory Elements is built inside this monorepo and hooked up to the other packages +via nx and npm workspaces. + +To start a hot reloading development mode: + +```bash +npx nx dev @ory/elements-react +``` + +## API Extractor + +To make sure there are no unintended changes to the API contract, we use +[API Extractor](https://api-extractor.com/) to generate API reports, that are +checked into the repository. The CI of each PR includes a check that this API +report would not change after merging the PR. + +If the report would change, the CI fails. If that happens, you can re-generate +all reports by running + +```bash +npx nx api-extractor-refresh @ory/elements-react +``` + +Inspect the resulting changes carefully, and make sure it is in line with what +you expected. Add the changes to your PR. + +## Tests + +Unit tests use Jest and react-testing-library. To run the tests locally, +execute: + +```bash +npx nx build @ory/elements-react +``` + +## Stories + +Each flow has its own story in the `packages/elements-react-stories` package. To +run the storybook development environment, execute: + +```bash +npx nx storybook elements-react-stories +``` + +You can also build the Storybook using: + +```bash +npx nx build elements-react-stories +``` + +The stories use stub responses + +## Releasing + +@ory/elements-react is released using nx releases. + +The process is still manual, but will be replaced by a semi-automatic release +pipeline. + +To release a new version: + +```bash +# in the root of the repo +npx nx build @ory/elements-react + +# nx is configured to generate a new -next.X version, in nx.json +npx nx release version --verbose + +# make sure to replace .X with the version generated in the first step +npx nx release changelog 1.0.0-next.X --verbose + +npx nx release publish --tag=next --dry-run --verbose + +npx nx release publish --tag=next --verbose --otp= # otp is still required, if we have a bot for publishing this is not required anymore. + +# replace .X with the appropriate version +git push origin tag release/@ory/elements-react/1.0.0-next.X + +# push the pin commit to the branch +git push +``` diff --git a/packages/elements-react/LICENSE b/packages/elements-react/LICENSE new file mode 100644 index 000000000..261eeb9e9 --- /dev/null +++ b/packages/elements-react/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/packages/elements-react/README.md b/packages/elements-react/README.md index eaaba3135..e5e17145c 100644 --- a/packages/elements-react/README.md +++ b/packages/elements-react/README.md @@ -33,7 +33,7 @@ Visit https://ory.sh/docs to see the full Ory documentation. - React `>= 18` - Node.js `>= 18` -- **`@ory/client-fetch`** - fetch based version of ory client +- **`@ory/client-fetch`** **Installation** @@ -93,42 +93,93 @@ export function init(params: QueryParams, flowType: FlowType) { To access & render the flow, on your flow page, you can use the `flow` query parameter, that is included in the redirect. Use it to call the -[`getLoginFlow()`](https://www.ory.sh/docs/reference/api#tag/frontend/operation/getLoginFlow) +[`getRegistrationFlowRaw()`](https://www.ory.sh/docs/reference/api#tag/frontend/operation/getRegistrationFlow) API. **Full Example**: -````ts -export async function getOrCreateRegistrationFlow( - params: QueryParams -): Promise { - const onRestartFlow = () => init(params, FlowType.Registration); +```ts +import { + Configuration, + FlowType, + FrontendApi, + handleFlowError, + RegistrationFlow, +} from "@ory/client-fetch" +import { redirect, RedirectType } from "next/navigation" + +type QueryParams = { + flow?: string +} +export function serverClientFrontend() { + // For testing purposes we're using Ory tunnel + + const config = new Configuration({ + headers: { + Accept: "application/json", + }, + basePath: "http://localhost:4000", + }) + return new FrontendApi(config) +} - // If flow ID doesn't exist in params simply trigget the init function. +export function init(params: QueryParams, flowType: FlowType) { + // Take advantage of the fact, that Ory handles the flow creation for us and redirects the user to the default return to automatically if they're logged in already. + return redirect( + "http://localhost:4000" + + "/self-service/" + + flowType.toString() + + "/browser?" + + new URLSearchParams(params).toString(), + RedirectType.replace, + ) +} + +export async function getOrCreateRegistrationFlow(params: { + flow?: string +}): Promise { + const onRestartFlow = () => init(params, FlowType.Registration) + + // If flow ID doesn't exist in params simply trigger the init function. if (!params.flow) { - return onRestartFlow(); + return onRestartFlow() } return await serverClientFrontend() - // Passing the flow ID - .getRegistrationFlowRaw({ id: flow }) - .then(res => res.value()) + // Pass in the flow ID + .getRegistrationFlowRaw({ id: params.flow }) + .then((res) => res.value()) .catch( - // Ory Elements predefines the handleFlowError function to simplify error handling. + // @ory/client-fetch predefines the handleFlowError function to simplify error handling. // You can define what should happen in each of these callbacks handleFlowError({ + // Validation errors happen if the user's provided input failed a validation rule (e.g. not an email, etc.) onValidationError, + // Flows can sometimes encounter unrecoverable errors, in that case we need to start a new flow to protect the user. + // In most cases, it is enough to initialize a new flow. onRestartFlow, + // Sometimes a flow requires a redirect to a different URL/context. For example during OIDC flows. + // In that case, you can handle the redirect here, for example using your framework's preferred method for redirects. onRedirect, - }) - ); - ``` -```` + }), + ) +} + +function onValidationError(flow: RegistrationFlow) { + // handle validation error +} + +function onRedirect(url: string, external: boolean) { + // handle the redirect +} +``` As soon as we have our flow data we can render the `` component from `@ory/elements-react` package. ```tsx +import { Registration } from "@ory/elements-react/theme" + export default async function RegistrationPage({ searchParams }: PageProps) { const flow = await getOrCreateRegistrationFlow(searchParams) @@ -136,13 +187,7 @@ export default async function RegistrationPage({ searchParams }: PageProps) { return
Flow not found
} - return ( - - ) + return } ``` @@ -166,11 +211,44 @@ Most styling can be overwritten, by providing your own custom CSS variables: } ``` -## Package development +### Component overrides -To develop and use the package `npm link` is recommended. To run the package in -watch mode use +Many components in Ory Elements can be overriden with your own implementation. +Ory Elements also provides useful hooks that be used inside of your custom +components to get access to the library configuration, or the current flow. +**Example:** + +```tsx +import { Registration } from "@ory/elements-react/theme" + +function CustomCardHeader() { + const { flowType } = useOryFlow() + + return
My Custom {flowType} Card header
+} + +export default async function RegistrationPage({ searchParams }: PageProps) { + const flow = await getOrCreateRegistrationFlow(searchParams) + + if (!flow) { + return
Flow not found
+ } + + return ( + + ) +} ``` -npx nx run @ory/elements-react:dev -``` + +## Development + +See [DEVELOPMENT.md](./DEVELOPMENT.md).