@ory/elements-react 1.0.0-next.4 → 1.0.0-next.40
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +525 -0
- package/DEVELOPMENT.md +94 -0
- package/LICENSE +201 -0
- package/README.md +112 -33
- package/babel.config.js +10 -0
- package/dist/client/config.d.mts +21 -0
- package/dist/client/config.d.ts +21 -0
- package/dist/client/config.js +77 -0
- package/dist/client/config.js.map +1 -0
- package/dist/client/config.mjs +51 -0
- package/dist/client/config.mjs.map +1 -0
- package/dist/client/frontendClient.d.mts +10 -0
- package/dist/client/frontendClient.d.ts +10 -0
- package/dist/client/frontendClient.js +75 -0
- package/dist/client/frontendClient.js.map +1 -0
- package/dist/client/frontendClient.mjs +54 -0
- package/dist/client/frontendClient.mjs.map +1 -0
- package/dist/client/index.d.mts +5 -0
- package/dist/client/index.d.ts +5 -0
- package/dist/client/index.js +33 -0
- package/dist/client/index.js.map +1 -0
- package/dist/client/index.mjs +10 -0
- package/dist/client/index.mjs.map +1 -0
- package/dist/client/session-provider.d.mts +62 -0
- package/dist/client/session-provider.d.ts +62 -0
- package/dist/client/session-provider.js +96 -0
- package/dist/client/session-provider.js.map +1 -0
- package/dist/client/session-provider.mjs +71 -0
- package/dist/client/session-provider.mjs.map +1 -0
- package/dist/client/useSession.d.mts +32 -0
- package/dist/client/useSession.d.ts +32 -0
- package/dist/client/useSession.js +37 -0
- package/dist/client/useSession.js.map +1 -0
- package/dist/client/useSession.mjs +13 -0
- package/dist/client/useSession.mjs.map +1 -0
- package/dist/index.d.mts +478 -1633
- package/dist/index.d.ts +478 -1633
- package/dist/index.js +2845 -5733
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +2842 -5704
- package/dist/index.mjs.map +1 -1
- package/dist/theme/default/index.css +999 -286
- package/dist/theme/default/index.css.map +1 -1
- package/dist/theme/default/index.d.mts +57 -144
- package/dist/theme/default/index.d.ts +57 -144
- package/dist/theme/default/index.js +4415 -9303
- package/dist/theme/default/index.js.map +1 -1
- package/dist/theme/default/index.mjs +5565 -10414
- package/dist/theme/default/index.mjs.map +1 -1
- package/dist/theme/default/tailwind/defaults.d.mts +737 -0
- package/dist/theme/default/tailwind/defaults.d.ts +737 -0
- package/dist/theme/default/tailwind/defaults.js +219 -0
- package/dist/theme/default/tailwind/defaults.js.map +1 -0
- package/dist/theme/default/tailwind/defaults.mjs +196 -0
- package/dist/theme/default/tailwind/defaults.mjs.map +1 -0
- package/package.json +36 -10
- package/tailwind/defaults.ts +34 -0
- package/tailwind/generated/README.md +2 -0
- package/tailwind/generated/default-variables.css +216 -0
- package/tailwind/generated/variables-processed.json +161 -0
- package/tsconfig.json +14 -3
- package/tsconfig.runtime.json +4 -0
- package/.eslintrc.js +0 -61
- package/postcss.config.ts +0 -6
- package/tailwind.config.ts +0 -51
- package/test-results/.last-run.json +0 -4
- package/variables-processed.json +0 -193
package/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
<p align="center">
|
|
2
2
|
<a href="https://ory.sh">
|
|
3
|
-
<img src="https://raw.githubusercontent.com/ory/meta/
|
|
3
|
+
<img src="https://raw.githubusercontent.com/ory/meta/refs/heads/master/static/logos/logo-ory.svg" height="72" />
|
|
4
4
|
</a>
|
|
5
5
|
</p>
|
|
6
6
|
|
|
@@ -33,7 +33,7 @@ Visit https://ory.sh/docs to see the full Ory documentation.
|
|
|
33
33
|
|
|
34
34
|
- React `>= 18`
|
|
35
35
|
- Node.js `>= 18`
|
|
36
|
-
- **`@ory/client-fetch`**
|
|
36
|
+
- **`@ory/client-fetch`**
|
|
37
37
|
|
|
38
38
|
**Installation**
|
|
39
39
|
|
|
@@ -49,15 +49,16 @@ user authentication flows based on the data.
|
|
|
49
49
|
To feed Ory Elements with flow data you need to use Ory client.
|
|
50
50
|
|
|
51
51
|
```ts
|
|
52
|
-
import { frontendClient } from "@ory/client-fetch"
|
|
53
|
-
|
|
54
52
|
export function serverClientFrontend() {
|
|
55
53
|
// For testing purposes we're using Ory tunnel
|
|
56
|
-
|
|
54
|
+
|
|
55
|
+
const config = new Configuration({
|
|
57
56
|
headers: {
|
|
58
57
|
Accept: "application/json",
|
|
59
58
|
},
|
|
59
|
+
basePath: "http://localhost:4000",
|
|
60
60
|
})
|
|
61
|
+
return new FrontendApi(config)
|
|
61
62
|
}
|
|
62
63
|
```
|
|
63
64
|
|
|
@@ -92,42 +93,93 @@ export function init(params: QueryParams, flowType: FlowType) {
|
|
|
92
93
|
|
|
93
94
|
To access & render the flow, on your flow page, you can use the `flow` query
|
|
94
95
|
parameter, that is included in the redirect. Use it to call the
|
|
95
|
-
[`
|
|
96
|
+
[`getRegistrationFlowRaw()`](https://www.ory.sh/docs/reference/api#tag/frontend/operation/getRegistrationFlow)
|
|
96
97
|
API.
|
|
97
98
|
|
|
98
99
|
**Full Example**:
|
|
99
100
|
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
101
|
+
```ts
|
|
102
|
+
import {
|
|
103
|
+
Configuration,
|
|
104
|
+
FlowType,
|
|
105
|
+
FrontendApi,
|
|
106
|
+
handleFlowError,
|
|
107
|
+
RegistrationFlow,
|
|
108
|
+
} from "@ory/client-fetch"
|
|
109
|
+
import { redirect, RedirectType } from "next/navigation"
|
|
110
|
+
|
|
111
|
+
type QueryParams = {
|
|
112
|
+
flow?: string
|
|
113
|
+
}
|
|
114
|
+
export function serverClientFrontend() {
|
|
115
|
+
// For testing purposes we're using Ory tunnel
|
|
116
|
+
|
|
117
|
+
const config = new Configuration({
|
|
118
|
+
headers: {
|
|
119
|
+
Accept: "application/json",
|
|
120
|
+
},
|
|
121
|
+
basePath: "http://localhost:4000",
|
|
122
|
+
})
|
|
123
|
+
return new FrontendApi(config)
|
|
124
|
+
}
|
|
105
125
|
|
|
106
|
-
|
|
126
|
+
export function init(params: QueryParams, flowType: FlowType) {
|
|
127
|
+
// 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.
|
|
128
|
+
return redirect(
|
|
129
|
+
"http://localhost:4000" +
|
|
130
|
+
"/self-service/" +
|
|
131
|
+
flowType.toString() +
|
|
132
|
+
"/browser?" +
|
|
133
|
+
new URLSearchParams(params).toString(),
|
|
134
|
+
RedirectType.replace,
|
|
135
|
+
)
|
|
136
|
+
}
|
|
137
|
+
|
|
138
|
+
export async function getOrCreateRegistrationFlow(params: {
|
|
139
|
+
flow?: string
|
|
140
|
+
}): Promise<RegistrationFlow> {
|
|
141
|
+
const onRestartFlow = () => init(params, FlowType.Registration)
|
|
142
|
+
|
|
143
|
+
// If flow ID doesn't exist in params simply trigger the init function.
|
|
107
144
|
if (!params.flow) {
|
|
108
|
-
return onRestartFlow()
|
|
145
|
+
return onRestartFlow()
|
|
109
146
|
}
|
|
110
147
|
|
|
111
148
|
return await serverClientFrontend()
|
|
112
|
-
//
|
|
113
|
-
.getRegistrationFlowRaw({ id: flow })
|
|
114
|
-
.then(res => res.value())
|
|
149
|
+
// Pass in the flow ID
|
|
150
|
+
.getRegistrationFlowRaw({ id: params.flow })
|
|
151
|
+
.then((res) => res.value())
|
|
115
152
|
.catch(
|
|
116
|
-
//
|
|
153
|
+
// @ory/client-fetch predefines the handleFlowError function to simplify error handling.
|
|
117
154
|
// You can define what should happen in each of these callbacks
|
|
118
155
|
handleFlowError({
|
|
156
|
+
// Validation errors happen if the user's provided input failed a validation rule (e.g. not an email, etc.)
|
|
119
157
|
onValidationError,
|
|
158
|
+
// Flows can sometimes encounter unrecoverable errors, in that case we need to start a new flow to protect the user.
|
|
159
|
+
// In most cases, it is enough to initialize a new flow.
|
|
120
160
|
onRestartFlow,
|
|
161
|
+
// Sometimes a flow requires a redirect to a different URL/context. For example during OIDC flows.
|
|
162
|
+
// In that case, you can handle the redirect here, for example using your framework's preferred method for redirects.
|
|
121
163
|
onRedirect,
|
|
122
|
-
})
|
|
123
|
-
)
|
|
124
|
-
|
|
125
|
-
|
|
164
|
+
}),
|
|
165
|
+
)
|
|
166
|
+
}
|
|
167
|
+
|
|
168
|
+
function onValidationError(flow: RegistrationFlow) {
|
|
169
|
+
// handle validation error
|
|
170
|
+
}
|
|
171
|
+
|
|
172
|
+
function onRedirect(url: string, external: boolean) {
|
|
173
|
+
// handle the redirect
|
|
174
|
+
}
|
|
175
|
+
```
|
|
126
176
|
|
|
127
177
|
As soon as we have our flow data we can render the `<Registration/>` component
|
|
128
178
|
from `@ory/elements-react` package.
|
|
129
179
|
|
|
130
180
|
```tsx
|
|
181
|
+
import { Registration } from "@ory/elements-react/theme"
|
|
182
|
+
|
|
131
183
|
export default async function RegistrationPage({ searchParams }: PageProps) {
|
|
132
184
|
const flow = await getOrCreateRegistrationFlow(searchParams)
|
|
133
185
|
|
|
@@ -135,13 +187,7 @@ export default async function RegistrationPage({ searchParams }: PageProps) {
|
|
|
135
187
|
return <div>Flow not found</div>
|
|
136
188
|
}
|
|
137
189
|
|
|
138
|
-
return
|
|
139
|
-
<Registration
|
|
140
|
-
flow={flow}
|
|
141
|
-
config={oryConfiguration}
|
|
142
|
-
components={ComponentOverrides}
|
|
143
|
-
/>
|
|
144
|
-
)
|
|
190
|
+
return <Registration flow={flow} config={oryConfiguration} />
|
|
145
191
|
}
|
|
146
192
|
```
|
|
147
193
|
|
|
@@ -165,11 +211,44 @@ Most styling can be overwritten, by providing your own custom CSS variables:
|
|
|
165
211
|
}
|
|
166
212
|
```
|
|
167
213
|
|
|
168
|
-
|
|
214
|
+
### Component overrides
|
|
169
215
|
|
|
170
|
-
|
|
171
|
-
|
|
216
|
+
Many components in Ory Elements can be overriden with your own implementation.
|
|
217
|
+
Ory Elements also provides useful hooks that be used inside of your custom
|
|
218
|
+
components to get access to the library configuration, or the current flow.
|
|
172
219
|
|
|
220
|
+
**Example:**
|
|
221
|
+
|
|
222
|
+
```tsx
|
|
223
|
+
import { Registration } from "@ory/elements-react/theme"
|
|
224
|
+
|
|
225
|
+
function CustomCardHeader() {
|
|
226
|
+
const { flowType } = useOryFlow()
|
|
227
|
+
|
|
228
|
+
return <div>My Custom {flowType} Card header</div>
|
|
229
|
+
}
|
|
230
|
+
|
|
231
|
+
export default async function RegistrationPage({ searchParams }: PageProps) {
|
|
232
|
+
const flow = await getOrCreateRegistrationFlow(searchParams)
|
|
233
|
+
|
|
234
|
+
if (!flow) {
|
|
235
|
+
return <div>Flow not found</div>
|
|
236
|
+
}
|
|
237
|
+
|
|
238
|
+
return (
|
|
239
|
+
<Registration
|
|
240
|
+
flow={flow}
|
|
241
|
+
config={oryConfiguration}
|
|
242
|
+
components={{
|
|
243
|
+
Card: {
|
|
244
|
+
CardHeader: CustomCardHeader,
|
|
245
|
+
},
|
|
246
|
+
}}
|
|
247
|
+
/>
|
|
248
|
+
)
|
|
249
|
+
}
|
|
173
250
|
```
|
|
174
|
-
|
|
175
|
-
|
|
251
|
+
|
|
252
|
+
## Development
|
|
253
|
+
|
|
254
|
+
See [DEVELOPMENT.md](./DEVELOPMENT.md).
|
package/babel.config.js
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This function returns the base URL of the Ory SDK as set by environment variables `NEXT_PUBLIC_ORY_SDK_URL` or `ORY_SDK_URL`.
|
|
3
|
+
*/
|
|
4
|
+
declare function orySdkUrl(): string;
|
|
5
|
+
/**
|
|
6
|
+
* This function returns whether the current environment is a production environment.
|
|
7
|
+
*/
|
|
8
|
+
declare function isProduction(): boolean;
|
|
9
|
+
/**
|
|
10
|
+
* This function returns the Ory SDK URL. If the environment is not production, it tries to guess the SDK URL based on the environment variables, assuming
|
|
11
|
+
* that Ory APIs are proxied through the same domain as the application.
|
|
12
|
+
*
|
|
13
|
+
* Currently, this is only tested for Vercel deployments.
|
|
14
|
+
*
|
|
15
|
+
* @param options - Options for guessing the SDK URL.
|
|
16
|
+
*/
|
|
17
|
+
declare function guessPotentiallyProxiedOrySdkUrl(options?: {
|
|
18
|
+
knownProxiedUrl?: string;
|
|
19
|
+
}): string;
|
|
20
|
+
|
|
21
|
+
export { guessPotentiallyProxiedOrySdkUrl, isProduction, orySdkUrl };
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This function returns the base URL of the Ory SDK as set by environment variables `NEXT_PUBLIC_ORY_SDK_URL` or `ORY_SDK_URL`.
|
|
3
|
+
*/
|
|
4
|
+
declare function orySdkUrl(): string;
|
|
5
|
+
/**
|
|
6
|
+
* This function returns whether the current environment is a production environment.
|
|
7
|
+
*/
|
|
8
|
+
declare function isProduction(): boolean;
|
|
9
|
+
/**
|
|
10
|
+
* This function returns the Ory SDK URL. If the environment is not production, it tries to guess the SDK URL based on the environment variables, assuming
|
|
11
|
+
* that Ory APIs are proxied through the same domain as the application.
|
|
12
|
+
*
|
|
13
|
+
* Currently, this is only tested for Vercel deployments.
|
|
14
|
+
*
|
|
15
|
+
* @param options - Options for guessing the SDK URL.
|
|
16
|
+
*/
|
|
17
|
+
declare function guessPotentiallyProxiedOrySdkUrl(options?: {
|
|
18
|
+
knownProxiedUrl?: string;
|
|
19
|
+
}): string;
|
|
20
|
+
|
|
21
|
+
export { guessPotentiallyProxiedOrySdkUrl, isProduction, orySdkUrl };
|
|
@@ -0,0 +1,77 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __defProp = Object.defineProperty;
|
|
3
|
+
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
|
|
4
|
+
var __getOwnPropNames = Object.getOwnPropertyNames;
|
|
5
|
+
var __hasOwnProp = Object.prototype.hasOwnProperty;
|
|
6
|
+
var __export = (target, all) => {
|
|
7
|
+
for (var name in all)
|
|
8
|
+
__defProp(target, name, { get: all[name], enumerable: true });
|
|
9
|
+
};
|
|
10
|
+
var __copyProps = (to, from, except, desc) => {
|
|
11
|
+
if (from && typeof from === "object" || typeof from === "function") {
|
|
12
|
+
for (let key of __getOwnPropNames(from))
|
|
13
|
+
if (!__hasOwnProp.call(to, key) && key !== except)
|
|
14
|
+
__defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
|
|
15
|
+
}
|
|
16
|
+
return to;
|
|
17
|
+
};
|
|
18
|
+
var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
|
|
19
|
+
var config_exports = {};
|
|
20
|
+
__export(config_exports, {
|
|
21
|
+
guessPotentiallyProxiedOrySdkUrl: () => guessPotentiallyProxiedOrySdkUrl,
|
|
22
|
+
isProduction: () => isProduction,
|
|
23
|
+
orySdkUrl: () => orySdkUrl
|
|
24
|
+
});
|
|
25
|
+
module.exports = __toCommonJS(config_exports);
|
|
26
|
+
function orySdkUrl() {
|
|
27
|
+
let baseUrl;
|
|
28
|
+
if (process.env.NEXT_PUBLIC_ORY_SDK_URL) {
|
|
29
|
+
baseUrl = process.env.NEXT_PUBLIC_ORY_SDK_URL;
|
|
30
|
+
}
|
|
31
|
+
if (process.env.ORY_SDK_URL) {
|
|
32
|
+
baseUrl = process.env._ORY_SDK_URL;
|
|
33
|
+
}
|
|
34
|
+
if (!baseUrl) {
|
|
35
|
+
throw new Error(
|
|
36
|
+
"You need to set environment variable `NEXT_PUBLIC_ORY_SDK_URL` or if you don't use Next.js `ORY_SDK_URL` to your Ory Network SDK URL."
|
|
37
|
+
);
|
|
38
|
+
}
|
|
39
|
+
return baseUrl.replace(/\/$/, "");
|
|
40
|
+
}
|
|
41
|
+
function isProduction() {
|
|
42
|
+
var _a, _b;
|
|
43
|
+
return ["production", "prod"].indexOf(
|
|
44
|
+
(_b = (_a = process.env.VERCEL_ENV) != null ? _a : process.env.NODE_ENV) != null ? _b : ""
|
|
45
|
+
) > -1;
|
|
46
|
+
}
|
|
47
|
+
function guessPotentiallyProxiedOrySdkUrl(options) {
|
|
48
|
+
if (isProduction()) {
|
|
49
|
+
return orySdkUrl();
|
|
50
|
+
}
|
|
51
|
+
if (process.env.VERCEL_ENV) {
|
|
52
|
+
if (!isProduction() && process.env.VERCEL_URL) {
|
|
53
|
+
return `https://${process.env.VERCEL_URL}`.replace(/\/$/, "");
|
|
54
|
+
}
|
|
55
|
+
if (process.env.__NEXT_PRIVATE_ORIGIN) {
|
|
56
|
+
return process.env.__NEXT_PRIVATE_ORIGIN.replace(/\/$/, "");
|
|
57
|
+
}
|
|
58
|
+
}
|
|
59
|
+
if (typeof window !== "undefined") {
|
|
60
|
+
return window.location.origin;
|
|
61
|
+
}
|
|
62
|
+
if (options == null ? void 0 : options.knownProxiedUrl) {
|
|
63
|
+
return options.knownProxiedUrl;
|
|
64
|
+
}
|
|
65
|
+
const final = orySdkUrl();
|
|
66
|
+
console.warn(
|
|
67
|
+
`Unable to determine a suitable SDK URL for setting up the Next.js integration of Ory Elements. Will proceed using default Ory SDK URL "${final}". This is likely not what you want for local development and your authentication and login may not work.`
|
|
68
|
+
);
|
|
69
|
+
return final;
|
|
70
|
+
}
|
|
71
|
+
// Annotate the CommonJS export names for ESM import in node:
|
|
72
|
+
0 && (module.exports = {
|
|
73
|
+
guessPotentiallyProxiedOrySdkUrl,
|
|
74
|
+
isProduction,
|
|
75
|
+
orySdkUrl
|
|
76
|
+
});
|
|
77
|
+
//# sourceMappingURL=config.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../../src/client/config.ts"],"sourcesContent":["// Copyright © 2024 Ory Corp\n// SPDX-License-Identifier: Apache-2.0\n\n/**\n * This function returns the base URL of the Ory SDK as set by environment variables `NEXT_PUBLIC_ORY_SDK_URL` or `ORY_SDK_URL`.\n */\nexport function orySdkUrl() {\n let baseUrl\n\n if (process.env.NEXT_PUBLIC_ORY_SDK_URL) {\n baseUrl = process.env.NEXT_PUBLIC_ORY_SDK_URL\n }\n\n if (process.env.ORY_SDK_URL) {\n baseUrl = process.env._ORY_SDK_URL\n }\n\n if (!baseUrl) {\n throw new Error(\n \"You need to set environment variable `NEXT_PUBLIC_ORY_SDK_URL` or if you don't use Next.js `ORY_SDK_URL` to your Ory Network SDK URL.\",\n )\n }\n\n return baseUrl.replace(/\\/$/, \"\")\n}\n\n/**\n * This function returns whether the current environment is a production environment.\n */\nexport function isProduction() {\n return (\n [\"production\", \"prod\"].indexOf(\n process.env.VERCEL_ENV ?? process.env.NODE_ENV ?? \"\",\n ) > -1\n )\n}\n\n/**\n * This function returns the Ory SDK URL. If the environment is not production, it tries to guess the SDK URL based on the environment variables, assuming\n * that Ory APIs are proxied through the same domain as the application.\n *\n * Currently, this is only tested for Vercel deployments.\n *\n * @param options - Options for guessing the SDK URL.\n */\nexport function guessPotentiallyProxiedOrySdkUrl(options?: {\n knownProxiedUrl?: string\n}) {\n if (isProduction()) {\n // In production, we use the production custom domain\n return orySdkUrl()\n }\n\n if (process.env.VERCEL_ENV) {\n // We are in vercel\n\n // The domain name of the generated deployment URL. Example: *.vercel.app. The value does not include the protocol scheme https://.\n //\n // This is only available for preview deployments on Vercel.\n if (!isProduction() && process.env.VERCEL_URL) {\n return `https://${process.env.VERCEL_URL}`.replace(/\\/$/, \"\")\n }\n\n // This is sometimes set by the render server.\n if (process.env.__NEXT_PRIVATE_ORIGIN) {\n return process.env.__NEXT_PRIVATE_ORIGIN.replace(/\\/$/, \"\")\n }\n }\n\n // Unable to figure out the SDK URL. Either because we are not using Vercel or because we are on a local machine.\n // Let's try to use the window location.\n if (typeof window !== \"undefined\") {\n return window.location.origin\n }\n\n if (options?.knownProxiedUrl) {\n return options.knownProxiedUrl\n }\n\n // We tried everything. Let's use the SDK URL.\n const final = orySdkUrl()\n console.warn(\n `Unable to determine a suitable SDK URL for setting up the Next.js integration of Ory Elements. Will proceed using default Ory SDK URL \"${final}\". This is likely not what you want for local development and your authentication and login may not work.`,\n )\n\n return final\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAMO,SAAS,YAAY;AAC1B,MAAI;AAEJ,MAAI,QAAQ,IAAI,yBAAyB;AACvC,cAAU,QAAQ,IAAI;AAAA,EACxB;AAEA,MAAI,QAAQ,IAAI,aAAa;AAC3B,cAAU,QAAQ,IAAI;AAAA,EACxB;AAEA,MAAI,CAAC,SAAS;AACZ,UAAM,IAAI;AAAA,MACR;AAAA,IACF;AAAA,EACF;AAEA,SAAO,QAAQ,QAAQ,OAAO,EAAE;AAClC;AAKO,SAAS,eAAe;AA7B/B;AA8BE,SACE,CAAC,cAAc,MAAM,EAAE;AAAA,KACrB,mBAAQ,IAAI,eAAZ,YAA0B,QAAQ,IAAI,aAAtC,YAAkD;AAAA,EACpD,IAAI;AAER;AAUO,SAAS,iCAAiC,SAE9C;AACD,MAAI,aAAa,GAAG;AAElB,WAAO,UAAU;AAAA,EACnB;AAEA,MAAI,QAAQ,IAAI,YAAY;AAM1B,QAAI,CAAC,aAAa,KAAK,QAAQ,IAAI,YAAY;AAC7C,aAAO,WAAW,QAAQ,IAAI,UAAU,GAAG,QAAQ,OAAO,EAAE;AAAA,IAC9D;AAGA,QAAI,QAAQ,IAAI,uBAAuB;AACrC,aAAO,QAAQ,IAAI,sBAAsB,QAAQ,OAAO,EAAE;AAAA,IAC5D;AAAA,EACF;AAIA,MAAI,OAAO,WAAW,aAAa;AACjC,WAAO,OAAO,SAAS;AAAA,EACzB;AAEA,MAAI,mCAAS,iBAAiB;AAC5B,WAAO,QAAQ;AAAA,EACjB;AAGA,QAAM,QAAQ,UAAU;AACxB,UAAQ;AAAA,IACN,0IAA0I,KAAK;AAAA,EACjJ;AAEA,SAAO;AACT;","names":[]}
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
function orySdkUrl() {
|
|
2
|
+
let baseUrl;
|
|
3
|
+
if (process.env.NEXT_PUBLIC_ORY_SDK_URL) {
|
|
4
|
+
baseUrl = process.env.NEXT_PUBLIC_ORY_SDK_URL;
|
|
5
|
+
}
|
|
6
|
+
if (process.env.ORY_SDK_URL) {
|
|
7
|
+
baseUrl = process.env._ORY_SDK_URL;
|
|
8
|
+
}
|
|
9
|
+
if (!baseUrl) {
|
|
10
|
+
throw new Error(
|
|
11
|
+
"You need to set environment variable `NEXT_PUBLIC_ORY_SDK_URL` or if you don't use Next.js `ORY_SDK_URL` to your Ory Network SDK URL."
|
|
12
|
+
);
|
|
13
|
+
}
|
|
14
|
+
return baseUrl.replace(/\/$/, "");
|
|
15
|
+
}
|
|
16
|
+
function isProduction() {
|
|
17
|
+
var _a, _b;
|
|
18
|
+
return ["production", "prod"].indexOf(
|
|
19
|
+
(_b = (_a = process.env.VERCEL_ENV) != null ? _a : process.env.NODE_ENV) != null ? _b : ""
|
|
20
|
+
) > -1;
|
|
21
|
+
}
|
|
22
|
+
function guessPotentiallyProxiedOrySdkUrl(options) {
|
|
23
|
+
if (isProduction()) {
|
|
24
|
+
return orySdkUrl();
|
|
25
|
+
}
|
|
26
|
+
if (process.env.VERCEL_ENV) {
|
|
27
|
+
if (!isProduction() && process.env.VERCEL_URL) {
|
|
28
|
+
return `https://${process.env.VERCEL_URL}`.replace(/\/$/, "");
|
|
29
|
+
}
|
|
30
|
+
if (process.env.__NEXT_PRIVATE_ORIGIN) {
|
|
31
|
+
return process.env.__NEXT_PRIVATE_ORIGIN.replace(/\/$/, "");
|
|
32
|
+
}
|
|
33
|
+
}
|
|
34
|
+
if (typeof window !== "undefined") {
|
|
35
|
+
return window.location.origin;
|
|
36
|
+
}
|
|
37
|
+
if (options == null ? void 0 : options.knownProxiedUrl) {
|
|
38
|
+
return options.knownProxiedUrl;
|
|
39
|
+
}
|
|
40
|
+
const final = orySdkUrl();
|
|
41
|
+
console.warn(
|
|
42
|
+
`Unable to determine a suitable SDK URL for setting up the Next.js integration of Ory Elements. Will proceed using default Ory SDK URL "${final}". This is likely not what you want for local development and your authentication and login may not work.`
|
|
43
|
+
);
|
|
44
|
+
return final;
|
|
45
|
+
}
|
|
46
|
+
export {
|
|
47
|
+
guessPotentiallyProxiedOrySdkUrl,
|
|
48
|
+
isProduction,
|
|
49
|
+
orySdkUrl
|
|
50
|
+
};
|
|
51
|
+
//# sourceMappingURL=config.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../../src/client/config.ts"],"sourcesContent":["// Copyright © 2024 Ory Corp\n// SPDX-License-Identifier: Apache-2.0\n\n/**\n * This function returns the base URL of the Ory SDK as set by environment variables `NEXT_PUBLIC_ORY_SDK_URL` or `ORY_SDK_URL`.\n */\nexport function orySdkUrl() {\n let baseUrl\n\n if (process.env.NEXT_PUBLIC_ORY_SDK_URL) {\n baseUrl = process.env.NEXT_PUBLIC_ORY_SDK_URL\n }\n\n if (process.env.ORY_SDK_URL) {\n baseUrl = process.env._ORY_SDK_URL\n }\n\n if (!baseUrl) {\n throw new Error(\n \"You need to set environment variable `NEXT_PUBLIC_ORY_SDK_URL` or if you don't use Next.js `ORY_SDK_URL` to your Ory Network SDK URL.\",\n )\n }\n\n return baseUrl.replace(/\\/$/, \"\")\n}\n\n/**\n * This function returns whether the current environment is a production environment.\n */\nexport function isProduction() {\n return (\n [\"production\", \"prod\"].indexOf(\n process.env.VERCEL_ENV ?? process.env.NODE_ENV ?? \"\",\n ) > -1\n )\n}\n\n/**\n * This function returns the Ory SDK URL. If the environment is not production, it tries to guess the SDK URL based on the environment variables, assuming\n * that Ory APIs are proxied through the same domain as the application.\n *\n * Currently, this is only tested for Vercel deployments.\n *\n * @param options - Options for guessing the SDK URL.\n */\nexport function guessPotentiallyProxiedOrySdkUrl(options?: {\n knownProxiedUrl?: string\n}) {\n if (isProduction()) {\n // In production, we use the production custom domain\n return orySdkUrl()\n }\n\n if (process.env.VERCEL_ENV) {\n // We are in vercel\n\n // The domain name of the generated deployment URL. Example: *.vercel.app. The value does not include the protocol scheme https://.\n //\n // This is only available for preview deployments on Vercel.\n if (!isProduction() && process.env.VERCEL_URL) {\n return `https://${process.env.VERCEL_URL}`.replace(/\\/$/, \"\")\n }\n\n // This is sometimes set by the render server.\n if (process.env.__NEXT_PRIVATE_ORIGIN) {\n return process.env.__NEXT_PRIVATE_ORIGIN.replace(/\\/$/, \"\")\n }\n }\n\n // Unable to figure out the SDK URL. Either because we are not using Vercel or because we are on a local machine.\n // Let's try to use the window location.\n if (typeof window !== \"undefined\") {\n return window.location.origin\n }\n\n if (options?.knownProxiedUrl) {\n return options.knownProxiedUrl\n }\n\n // We tried everything. Let's use the SDK URL.\n const final = orySdkUrl()\n console.warn(\n `Unable to determine a suitable SDK URL for setting up the Next.js integration of Ory Elements. Will proceed using default Ory SDK URL \"${final}\". This is likely not what you want for local development and your authentication and login may not work.`,\n )\n\n return final\n}\n"],"mappings":"AAMO,SAAS,YAAY;AAC1B,MAAI;AAEJ,MAAI,QAAQ,IAAI,yBAAyB;AACvC,cAAU,QAAQ,IAAI;AAAA,EACxB;AAEA,MAAI,QAAQ,IAAI,aAAa;AAC3B,cAAU,QAAQ,IAAI;AAAA,EACxB;AAEA,MAAI,CAAC,SAAS;AACZ,UAAM,IAAI;AAAA,MACR;AAAA,IACF;AAAA,EACF;AAEA,SAAO,QAAQ,QAAQ,OAAO,EAAE;AAClC;AAKO,SAAS,eAAe;AA7B/B;AA8BE,SACE,CAAC,cAAc,MAAM,EAAE;AAAA,KACrB,mBAAQ,IAAI,eAAZ,YAA0B,QAAQ,IAAI,aAAtC,YAAkD;AAAA,EACpD,IAAI;AAER;AAUO,SAAS,iCAAiC,SAE9C;AACD,MAAI,aAAa,GAAG;AAElB,WAAO,UAAU;AAAA,EACnB;AAEA,MAAI,QAAQ,IAAI,YAAY;AAM1B,QAAI,CAAC,aAAa,KAAK,QAAQ,IAAI,YAAY;AAC7C,aAAO,WAAW,QAAQ,IAAI,UAAU,GAAG,QAAQ,OAAO,EAAE;AAAA,IAC9D;AAGA,QAAI,QAAQ,IAAI,uBAAuB;AACrC,aAAO,QAAQ,IAAI,sBAAsB,QAAQ,OAAO,EAAE;AAAA,IAC5D;AAAA,EACF;AAIA,MAAI,OAAO,WAAW,aAAa;AACjC,WAAO,OAAO,SAAS;AAAA,EACzB;AAEA,MAAI,mCAAS,iBAAiB;AAC5B,WAAO,QAAQ;AAAA,EACjB;AAGA,QAAM,QAAQ,UAAU;AACxB,UAAQ;AAAA,IACN,0IAA0I,KAAK;AAAA,EACjJ;AAEA,SAAO;AACT;","names":[]}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import { ConfigurationParameters, FrontendApi, OAuth2Api } from '@ory/client-fetch';
|
|
2
|
+
|
|
3
|
+
declare function frontendClient({ forceBaseUrl, ...opts }?: Partial<ConfigurationParameters & {
|
|
4
|
+
forceBaseUrl?: string;
|
|
5
|
+
}>): FrontendApi;
|
|
6
|
+
declare function oauth2Client({ forceBaseUrl, ...opts }?: Partial<ConfigurationParameters & {
|
|
7
|
+
forceBaseUrl?: string;
|
|
8
|
+
}>): OAuth2Api;
|
|
9
|
+
|
|
10
|
+
export { frontendClient, oauth2Client };
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import { ConfigurationParameters, FrontendApi, OAuth2Api } from '@ory/client-fetch';
|
|
2
|
+
|
|
3
|
+
declare function frontendClient({ forceBaseUrl, ...opts }?: Partial<ConfigurationParameters & {
|
|
4
|
+
forceBaseUrl?: string;
|
|
5
|
+
}>): FrontendApi;
|
|
6
|
+
declare function oauth2Client({ forceBaseUrl, ...opts }?: Partial<ConfigurationParameters & {
|
|
7
|
+
forceBaseUrl?: string;
|
|
8
|
+
}>): OAuth2Api;
|
|
9
|
+
|
|
10
|
+
export { frontendClient, oauth2Client };
|