- There was an error during the uninstallation of the Stripe Sync Engine. Please try
- again. If the problem persists, contact support.
-
-
-
-
-
- )
- }
-
- if (installError) {
- return (
-
-
- There was an error during the installation of the Stripe Sync Engine. Please try
- reinstalling the integration. If the problem persists, contact support.
-
+ Last synced{' '}
+ {syncState.closed_at
+ ? formatRelative(new Date(syncState.closed_at), new Date())
+ : 'recently'}
+
+ >
+ )}
+
+
+
+
+ )}
diff --git a/apps/studio/components/interfaces/Integrations/templates/StripeSyncEngine/stripe-sync-status.ts b/apps/studio/components/interfaces/Integrations/templates/StripeSyncEngine/stripe-sync-status.ts
index 190f76ad643..d57ce7100b9 100644
--- a/apps/studio/components/interfaces/Integrations/templates/StripeSyncEngine/stripe-sync-status.ts
+++ b/apps/studio/components/interfaces/Integrations/templates/StripeSyncEngine/stripe-sync-status.ts
@@ -21,12 +21,26 @@ export type StripeInstallationStatus =
| 'uninstalled'
| 'uninstall_error'
+/**
+ * Parsed Stripe schema status including version and error message
+ */
+export interface ParsedStripeSchema {
+ /** The installation status */
+ status: StripeInstallationStatus
+
+ /** The version from the schema comment (e.g., 'v1.2.3') */
+ version?: string
+
+ /** Error message if status is install_error or uninstall_error */
+ errorMessage?: string
+}
+
/**
* Complete Stripe Sync status including schema, installation state, and sync state
*/
export interface StripeSyncStatusResult {
- /** The installation status */
- installationStatus: StripeInstallationStatus
+ /** The parsed schema with status, version and error */
+ parsedSchema: ParsedStripeSchema
/** Current sync run state (only available when installationStatus is installed) */
syncState: StripeSyncState | undefined
@@ -51,40 +65,72 @@ function isStripeSyncSchema(schema: Schema | undefined): boolean {
return !!schema?.comment?.startsWith(STRIPE_SCHEMA_COMMENT_PREFIX)
}
-function hasStatusSuffix(schema: Schema | undefined, suffix: string): boolean {
- return isStripeSyncSchema(schema) && !!schema?.comment?.endsWith(suffix)
-}
-
/**
* Parse the installation status from a stripe schema.
*
+ * Schema comment format: {PREFIX} {version} {SUFFIX}[ - {error message}]
+ * Example: "stripe_sync v1.2.3 installation:error - Could not apply migration"
+ *
* @param stripeSchema - The stripe schema from the database, if it exists
- * @returns The installation status
+ * @returns The parsed status including version and optional error message
*/
-export function parseStripeSchemaStatus(
- stripeSchema: Schema | undefined
-): StripeInstallationStatus {
- if (hasStatusSuffix(stripeSchema, UNINSTALLATION_ERROR_SUFFIX)) {
- return 'uninstall_error'
+export function parseStripeSchema(stripeSchema: Schema | undefined): ParsedStripeSchema {
+ if (!isStripeSyncSchema(stripeSchema)) {
+ return { status: 'uninstalled' }
}
- if (hasStatusSuffix(stripeSchema, INSTALLATION_ERROR_SUFFIX)) {
- return 'install_error'
+ const comment = stripeSchema!.comment!
+
+ // Remove prefix and leading space
+ const afterPrefix = comment.slice(STRIPE_SCHEMA_COMMENT_PREFIX.length).trimStart()
+
+ // Split at first space to get version and trailing segment
+ const firstSpaceIndex = afterPrefix.indexOf(' ')
+ if (firstSpaceIndex === -1) {
+ return { status: 'uninstalled' }
}
- if (hasStatusSuffix(stripeSchema, UNINSTALLATION_STARTED_SUFFIX)) {
- return 'uninstalling'
+ const version = afterPrefix.slice(0, firstSpaceIndex)
+ const trailing = afterPrefix.slice(firstSpaceIndex + 1)
+
+ // Helper to extract error message if present after ' - ' separator
+ const extractError = (afterSuffix: string): string | undefined => {
+ if (afterSuffix.startsWith(' - ')) {
+ return afterSuffix.slice(3) // Remove ' - ' (3 characters)
+ }
+ return afterSuffix
}
- if (hasStatusSuffix(stripeSchema, INSTALLATION_STARTED_SUFFIX)) {
- return 'installing'
+ // Check status in priority order
+ if (trailing.startsWith(UNINSTALLATION_ERROR_SUFFIX)) {
+ return {
+ status: 'uninstall_error',
+ version,
+ errorMessage: extractError(trailing.slice(UNINSTALLATION_ERROR_SUFFIX.length)),
+ }
}
- if (hasStatusSuffix(stripeSchema, INSTALLATION_INSTALLED_SUFFIX)) {
- return 'installed'
+ if (trailing.startsWith(INSTALLATION_ERROR_SUFFIX)) {
+ return {
+ status: 'install_error',
+ version,
+ errorMessage: extractError(trailing.slice(INSTALLATION_ERROR_SUFFIX.length)),
+ }
}
- return 'uninstalled'
+ if (trailing.startsWith(UNINSTALLATION_STARTED_SUFFIX)) {
+ return { status: 'uninstalling', version }
+ }
+
+ if (trailing.startsWith(INSTALLATION_STARTED_SUFFIX)) {
+ return { status: 'installing', version }
+ }
+
+ if (trailing.startsWith(INSTALLATION_INSTALLED_SUFFIX)) {
+ return { status: 'installed', version }
+ }
+
+ return { status: 'uninstalled' }
}
export function isInstalled(status: StripeInstallationStatus): boolean {
diff --git a/apps/studio/components/interfaces/Integrations/templates/StripeSyncEngine/useStripeSyncStatus.ts b/apps/studio/components/interfaces/Integrations/templates/StripeSyncEngine/useStripeSyncStatus.ts
index a28f8405984..4332391c25c 100644
--- a/apps/studio/components/interfaces/Integrations/templates/StripeSyncEngine/useStripeSyncStatus.ts
+++ b/apps/studio/components/interfaces/Integrations/templates/StripeSyncEngine/useStripeSyncStatus.ts
@@ -6,7 +6,7 @@ import {
findStripeSchema,
isInProgress,
isInstalled,
- parseStripeSchemaStatus,
+ parseStripeSchema,
type StripeSyncStatusResult,
} from '@/components/interfaces/Integrations/templates/StripeSyncEngine/stripe-sync-status'
@@ -30,10 +30,10 @@ export function useStripeSyncStatus({
// Find and parse stripe schema status
const stripeSchema = findStripeSchema(schemas)
- const installationStatus = parseStripeSchemaStatus(stripeSchema)
+ const parsedSchema = parseStripeSchema(stripeSchema)
- const installed = isInstalled(installationStatus)
- const inProgress = isInProgress(installationStatus)
+ const installed = isInstalled(parsedSchema.status)
+ const inProgress = isInProgress(parsedSchema.status)
// Poll schemas during install/uninstall operations
useEffect(() => {
@@ -58,7 +58,7 @@ export function useStripeSyncStatus({
)
return {
- installationStatus,
+ parsedSchema,
syncState: installed ? syncState : undefined,
isLoading: isSchemasLoading,
}
diff --git a/apps/studio/components/ui/AlertError.tsx b/apps/studio/components/ui/AlertError.tsx
index 0ec74d94487..b95b2ea77aa 100644
--- a/apps/studio/components/ui/AlertError.tsx
+++ b/apps/studio/components/ui/AlertError.tsx
@@ -1,11 +1,9 @@
import { SupportCategories } from '@supabase/shared-types/out/constants'
import { SupportLink } from 'components/interfaces/Support/SupportLink'
-import { PropsWithChildren, useEffect, useRef } from 'react'
-
-import { Admonition } from 'ui-patterns/admonition'
-
-import { Button } from 'ui'
import { useTrack } from 'lib/telemetry/track'
+import { PropsWithChildren, useEffect, useRef } from 'react'
+import { Button } from 'ui'
+import { Admonition } from 'ui-patterns/admonition'
export interface AlertErrorProps {
projectRef?: string
@@ -19,7 +17,7 @@ export interface AlertErrorProps {
additionalActions?: React.ReactNode
}
-const ContactSupportButton = ({
+export const ContactSupportButton = ({
projectRef,
subject,
error,
diff --git a/apps/studio/pages/project/[ref]/integrations/[id]/[pageId]/index.tsx b/apps/studio/pages/project/[ref]/integrations/[id]/[pageId]/index.tsx
index 22971a6f317..a67fda5142d 100644
--- a/apps/studio/pages/project/[ref]/integrations/[id]/[pageId]/index.tsx
+++ b/apps/studio/pages/project/[ref]/integrations/[id]/[pageId]/index.tsx
@@ -1,11 +1,11 @@
import { useFlag, useParams } from 'common'
-import { IS_PLATFORM } from 'lib/constants'
import { INTEGRATIONS } from 'components/interfaces/Integrations/Landing/Integrations.constants'
import { useInstalledIntegrations } from 'components/interfaces/Integrations/Landing/useInstalledIntegrations'
import { DefaultLayout } from 'components/layouts/DefaultLayout'
import IntegrationsLayout from 'components/layouts/Integrations/layout'
import { UnknownInterface } from 'components/ui/UnknownInterface'
import { useIsFeatureEnabled } from 'hooks/misc/useIsFeatureEnabled'
+import { IS_PLATFORM } from 'lib/constants'
import Link from 'next/link'
import { useRouter } from 'next/router'
import { useEffect, useMemo } from 'react'
From a2d0eafcc492fe606dee9c0940c8d57f74b88067 Mon Sep 17 00:00:00 2001
From: Bayu Darmawan <40495581+gorillaworkout@users.noreply.github.com>
Date: Mon, 2 Mar 2026 17:14:50 +0700
Subject: [PATCH 004/105] fix(docs): replace deprecated getSession with
getClaims in Refine tutorial (#43203)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
## What kind of change does this PR introduce?
Documentation update
## What is the current behavior?
The Refine tutorial uses `supabaseClient.auth.getSession()` in the
`authProvider.check` method to verify authentication. `getSession` is
deprecated and not recommended for auth verification.
## What is the new behavior?
Replaced `getSession()` with `getClaims()` which reads claims from the
locally cached JWT. This is the recommended approach as mentioned in the
issue.
## Files changed
- `apps/docs/content/guides/getting-started/tutorials/with-refine.mdx` —
Updated `check` method in the authProvider code example
-
`examples/user-management/refine-user-management/src/providers/auth-provider.ts`
— Updated the corresponding example code to match
Closes #42193
---------
Co-authored-by: gorillaworkout
Co-authored-by: Chris Chinchilla
---
.../getting-started/tutorials/with-refine.mdx | 539 +-----
.../refine-user-management/package-lock.json | 1494 ++++++++++-------
.../refine-user-management/package.json | 28 +-
.../refine-user-management/src/App.tsx | 73 +-
.../auth-provider.ts => authProvider.ts} | 11 +-
.../src/components/avatar.tsx | 2 +-
.../src/providers/supabase-client.ts | 17 -
.../src/utility/index.ts | 1 +
.../src/utility/supabaseClient.ts | 13 +
9 files changed, 981 insertions(+), 1197 deletions(-)
rename examples/user-management/refine-user-management/src/{providers/auth-provider.ts => authProvider.ts} (87%)
delete mode 100644 examples/user-management/refine-user-management/src/providers/supabase-client.ts
create mode 100644 examples/user-management/refine-user-management/src/utility/index.ts
create mode 100644 examples/user-management/refine-user-management/src/utility/supabaseClient.ts
diff --git a/apps/docs/content/guides/getting-started/tutorials/with-refine.mdx b/apps/docs/content/guides/getting-started/tutorials/with-refine.mdx
index 2f7b929dd28..553d0f02105 100644
--- a/apps/docs/content/guides/getting-started/tutorials/with-refine.mdx
+++ b/apps/docs/content/guides/getting-started/tutorials/with-refine.mdx
@@ -15,91 +15,60 @@ If you get stuck while working through this guide, refer to the [full example on
## About Refine
-[Refine](https://github.com/refinedev/refine) is a React-based framework used to rapidly build data-heavy applications like admin panels, dashboards, storefronts and any type of CRUD apps. It separates app concerns into individual layers, each backed by a React context and respective provider object. For example, the auth layer represents a context served by a specific set of [`authProvider`](https://refine.dev/docs/tutorial/understanding-authprovider/index/) methods that carry out authentication and authorization actions such as logging in, logging out, getting roles data, etc. Similarly, the data layer offers another level of abstraction that is equipped with [`dataProvider`](https://refine.dev/docs/tutorial/understanding-dataprovider/index/) methods to handle CRUD operations at appropriate backend API endpoints.
+[Refine](https://github.com/refinedev/refine) is a React-based framework used to rapidly build data-heavy applications like admin panels, dashboards, storefronts and any type of CRUD apps. It separates app concerns into individual layers, each backed by a React context and respective provider object. For example, the auth layer represents a context served by a specific set of [`authProvider`](https://refine.dev/docs/tutorial/understanding-authprovider/index/) methods that carry out authentication and authorization actions such as logging in, logging out, getting roles data, etc. Similarly, the data layer offers another level of abstraction equipped with [`dataProvider`](https://refine.dev/docs/tutorial/understanding-dataprovider/index/) methods to handle CRUD operations at appropriate backend API endpoints.
-Refine provides hassle-free integration with Supabase backend with its supplementary [`@refinedev/supabase`](https://github.com/refinedev/refine/tree/main/packages/supabase) package. It generates `authProvider` and `dataProvider` methods at project initialization, so we don't need to expend much effort to define them ourselves. We just need to choose Supabase as our backend service while creating the app with `create refine-app`.
-
-
-
-It is possible to customize the `authProvider` for Supabase and as we'll see below, it can be tweaked from `src/authProvider.ts` file. In contrast, the Supabase `dataProvider` is part of `node_modules` and therefore is not subject to modification.
-
-
+Refine provides hassle-free integration with a Supabase backend with its supplementary [`@refinedev/supabase`](https://github.com/refinedev/refine/tree/main/packages/supabase) package. It generates `authProvider` and `dataProvider` methods at project initialization, so you don't need to spend much effort defining them yourself, choose Supabase as the backend service while creating the app with `create refine-app`.
<$Partial path="project_setup.mdx" variables={{ "framework": "refine", "tab": "frameworks" }} />
## Building the app
-Let's start building the Refine app from scratch.
+Start building the Refine app from scratch.
### Initialize a Refine app
-We can use [create refine-app](https://refine.dev/docs/tutorial/getting-started/headless/create-project/#launch-the-refine-cli-setup) command to initialize
+Use [create refine-app](https://refine.dev/docs/tutorial/getting-started/headless/create-project/#launch-the-refine-cli-setup) command to initialize
an app. Run the following in the terminal:
```bash
npm create refine-app@latest -- --preset refine-supabase
```
-In the above command, we are using the `refine-supabase` preset which chooses the Supabase supplementary package for our app. We are not using any UI framework, so we'll have a headless UI with plain React and CSS styling.
+The command above uses the `refine-supabase` preset which chooses the Supabase supplementary package for the app. There's no UI framework, so the app has a headless UI with plain React and CSS styling.
The `refine-supabase` preset installs the `@refinedev/supabase` package which out-of-the-box includes the Supabase dependency: [supabase-js](https://github.com/supabase/supabase-js).
-We also need to install `@refinedev/react-hook-form` and `react-hook-form` packages that allow us to use [React Hook Form](https://react-hook-form.com) inside Refine apps. Run:
+Install the `@refinedev/react-hook-form` and `react-hook-form` packages that to use [React Hook Form](https://react-hook-form.com) inside Refine apps. Run:
```bash
npm install @refinedev/react-hook-form react-hook-form
```
-With the app initialized and packages installed, at this point before we begin discussing Refine concepts, let's try running the app:
-
-```bash
-cd app-name
-npm run dev
-```
-
-We should have a running instance of the app with a Welcome page at `http://localhost:5173`.
-
-Let's move ahead to understand the generated code now.
-
### Refine `supabaseClient`
-The `create refine-app` generated a Supabase client for us in the `src/utility/supabaseClient.ts` file. It has two constants: `SUPABASE_URL` and `SUPABASE_KEY`. We want to replace them as `supabaseUrl` and `supabasePublishableKey` respectively and assign them our own Supabase server's values.
+The `create refine-app` generated a Supabase client in the `src/utility/supabaseClient.ts` file. It has two constants: `SUPABASE_URL` and `SUPABASE_KEY`. Replace them as `supabaseUrl` and `supabasePublishableKey` respectively and assign them your Supabase server's values.
-We'll update it with environment variables managed by Vite:
+Update it with environment variables managed by Vite:
-<$CodeTabs>
+<$CodeSample
+path="/user-management/refine-user-management/src/utility/supabaseClient.ts"
+lines={[[1, -1]]}
+meta="name=src/utility/supabaseClient.ts"
+/>
-```ts name=src/utility/supabaseClient.ts
-import { createClient } from '@refinedev/supabase'
-
-const supabaseUrl = import.meta.env.VITE_SUPABASE_URL
-const supabasePublishableKey = import.meta.env.VITE_SUPABASE_PUBLISHABLE_KEY
-
-export const supabaseClient = createClient(supabaseUrl, supabasePublishableKey, {
- db: {
- schema: 'public',
- },
- auth: {
- persistSession: true,
- },
-})
-```
-
-$CodeTabs>
-
-And then, we want to save the environment variables in a `.env.local` file. All you need are the API URL and the key that you copied [earlier](#get-api-details).
+Save the environment variables in a `.env.local` file. All you need are the API URL and the key that you copied [earlier](#get-api-details).
```bash .env.local
VITE_SUPABASE_URL=YOUR_SUPABASE_URL
VITE_SUPABASE_PUBLISHABLE_KEY=YOUR_SUPABASE_PUBLISHABLE_KEY
```
-The `supabaseClient` will be used in fetch calls to Supabase endpoints from our app. As we'll see below, the client is instrumental in implementing authentication using Refine's auth provider methods and CRUD actions with appropriate data provider methods.
+The `supabaseClient` fetches calls to Supabase endpoints from the app. The client is instrumental in implementing authentication using Refine's auth provider methods and CRUD actions with appropriate data provider methods.
One optional step is to update the CSS file `src/App.css` to make the app look nice.
You can find the full contents of this file [here](https://raw.githubusercontent.com/supabase/supabase/master/examples/user-management/refine-user-management/src/App.css).
-In order for us to add login and user profile pages in this App, we have to tweak the `` component inside `App.tsx`.
+In order to add login and user profile pages in this App, tweak the `` component inside `App.tsx`.
### The `` component
@@ -151,13 +120,13 @@ export default App
$CodeTabs>
-We'd like to focus on the [``](https://refine.dev/docs/api-reference/core/components/refine-config/) component, which comes with several props passed to it. Notice the `dataProvider` prop. It uses a `dataProvider()` function with `supabaseClient` passed as argument to generate the data provider object. The `authProvider` object also uses `supabaseClient` in implementing its methods. You can look it up in `src/authProvider.ts` file.
+Focus on the [``](https://refine.dev/docs/api-reference/core/components/refine-config/) component, which comes with props passed to it. Notice the `dataProvider` prop. It uses a `dataProvider()` function with `supabaseClient` passed as argument to generate the data provider object. The `authProvider` object also uses `supabaseClient` in implementing its methods. You can look it up in `src/authProvider.ts` file.
## Customize `authProvider`
-If you examine the `authProvider` object you can notice that it has a `login` method that implements a OAuth and Email / Password strategy for authentication. We'll, however, remove them and use Magic Links to allow users sign in with their email without using passwords.
+If you examine the `authProvider` object you can notice that it has a `login` method that implements an OAuth and Email / Password strategy for authentication. This tutorial instead removes them and use Magic Links to allow users sign in with their email without using passwords.
-We want to use `supabaseClient` auth's `signInWithOtp` method inside `authProvider.login` method:
+Use `supabaseClient` auth's `signInWithOtp` method inside `authProvider.login` method:
```ts name=src/authProvider.ts
login: async ({ email }) => {
@@ -182,320 +151,63 @@ login: async ({ email }) => {
},
```
-We also want to remove `register`, `updatePassword`, `forgotPassword` and `getPermissions` properties, which are optional type members and also not necessary for our app. The final `authProvider` object looks like this:
+Remove `register`, `updatePassword`, `forgotPassword` and `getPermissions` properties, which are optional type members and also not necessary for the app. The final `authProvider` object looks like this:
-<$CodeTabs>
-
-```ts name=src/authProvider.ts
-import { AuthProvider } from '@refinedev/core'
-
-import { supabaseClient } from './utility'
-
-const authProvider: AuthProvider = {
- login: async ({ email }) => {
- try {
- const { error } = await supabaseClient.auth.signInWithOtp({ email })
-
- if (!error) {
- alert('Check your email for the login link!')
- return {
- success: true,
- }
- }
-
- throw error
- } catch (e: any) {
- alert(e.message)
- return {
- success: false,
- e,
- }
- }
- },
- logout: async () => {
- const { error } = await supabaseClient.auth.signOut()
-
- if (error) {
- return {
- success: false,
- error,
- }
- }
-
- return {
- success: true,
- redirectTo: '/',
- }
- },
- onError: async (error) => {
- console.error(error)
- return { error }
- },
- check: async () => {
- try {
- const { data } = await supabaseClient.auth.getSession()
- const { session } = data
-
- if (!session) {
- return {
- authenticated: false,
- error: {
- message: 'Check failed',
- name: 'Session not found',
- },
- logout: true,
- redirectTo: '/login',
- }
- }
- } catch (error: any) {
- return {
- authenticated: false,
- error: error || {
- message: 'Check failed',
- name: 'Not authenticated',
- },
- logout: true,
- redirectTo: '/login',
- }
- }
-
- return {
- authenticated: true,
- }
- },
- getIdentity: async () => {
- const { data } = await supabaseClient.auth.getUser()
-
- if (data?.user) {
- return {
- ...data.user,
- name: data.user.email,
- }
- }
-
- return null
- },
-}
-
-export default authProvider
-```
-
-$CodeTabs>
+<$CodeSample
+path="/user-management/refine-user-management/src/authProvider.ts"
+lines={[[1, -1]]}
+meta="name=src/authProvider.ts"
+/>
### Set up a login component
-We have chosen to use the headless Refine core package that comes with no supported UI framework. So, let's set up a plain React component to manage logins and sign ups.
+As the app uses the headless Refine core package that comes with no supported UI framework set up a plain React component to manage logins and sign ups.
Create and edit `src/components/auth.tsx`:
-<$CodeTabs>
+<$CodeSample
+path="/user-management/refine-user-management/src/components/auth.tsx"
+lines={[[1, -1]]}
+meta="name=src/components/auth.tsx"
+/>
-```ts name=src/components/auth.tsx
-import { useState } from 'react'
-import { useLogin } from '@refinedev/core'
-
-export default function Auth() {
- const [email, setEmail] = useState('')
- const { isPending, mutate: login } = useLogin()
-
- const handleLogin = async (event: { preventDefault: () => void }) => {
- event.preventDefault()
- login({ email })
- }
-
- return (
-
-
-
Supabase + Refine
-
Sign in via magic link with your email below
-
-
- setEmail(e.target.value)}
- />
-
-
-
-
-
-
-
- )
-}
-```
-
-$CodeTabs>
-
-Notice we are using the [`useLogin()`](https://refine.dev/docs/api-reference/core/hooks/authentication/useLogin/) Refine auth hook to grab the `mutate: login` method to use inside `handleLogin()` function and `isLoading` state for our form submission. The `useLogin()` hook conveniently offers us access to `authProvider.login` method for authenticating the user with OTP.
+The [`useLogin()`](https://refine.dev/docs/api-reference/core/hooks/authentication/useLogin/) Refine auth hook to grab the `mutate: login` method to use inside `handleLogin()` function and `isLoading` state for the form submission. The `useLogin()` hook conveniently offers access to `authProvider.login` method for authenticating the user with OTP.
### Account page
-After a user is signed in we can allow them to edit their profile details and manage their account.
+After a user is signed in, allow them to edit their profile details and manage their account.
-Let's create a new component for that in `src/components/account.tsx`.
+Create a new component for that in `src/components/account.tsx`.
-<$CodeTabs>
+<$CodeSample
+path="/user-management/refine-user-management/src/components/account.tsx"
+lines={[[1, 3], [8, 43], [69, -1]]}
+meta="name=src/components/account.tsx"
+/>
-```tsx name=src/components/account.tsx
-import { BaseKey, useGetIdentity, useLogout } from '@refinedev/core'
-import { useForm } from '@refinedev/react-hook-form'
-
-interface IUserIdentity {
- id?: BaseKey
- username: string
- name: string
-}
-
-export interface IProfile {
- id?: string
- username?: string
- website?: string
- avatar_url?: string
-}
-
-export default function Account() {
- const { data: userIdentity } = useGetIdentity()
-
- const { mutate: logOut } = useLogout()
-
- const {
- refineCore: { formLoading, query, onFinish },
- register,
- control,
- handleSubmit,
- } = useForm({
- refineCoreProps: {
- resource: 'profiles',
- action: 'edit',
- id: userIdentity?.id,
- redirect: false,
- onMutationError: (data) => alert(data?.message),
- },
- })
-
- return (
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- )
-}
-```
-
-$CodeTabs>
-
-Notice above that, we are using three Refine hooks, namely the [`useGetIdentity()`](https://refine.dev/docs/api-reference/core/hooks/authentication/useGetIdentity/), [`useLogOut()`](https://refine.dev/docs/api-reference/core/hooks/authentication/useLogout/) and [`useForm()`](https://refine.dev/docs/packages/documentation/react-hook-form/useForm/) hooks.
+This uses three Refine hooks, namely the [`useGetIdentity()`](https://refine.dev/docs/api-reference/core/hooks/authentication/useGetIdentity/), [`useLogOut()`](https://refine.dev/docs/api-reference/core/hooks/authentication/useLogout/) and [`useForm()`](https://refine.dev/docs/packages/documentation/react-hook-form/useForm/) hooks.
`useGetIdentity()` is a auth hook that gets the identity of the authenticated user. It grabs the current user by invoking the `authProvider.getIdentity` method under the hood.
`useLogOut()` is also an auth hook. It calls the `authProvider.logout` method to end the session.
-`useForm()`, in contrast, is a data hook that exposes a series of useful objects that serve the edit form. For example, we are grabbing the `onFinish` function to submit the form with the `handleSubmit` event handler. We are also using `formLoading` property to present state changes of the submitted form.
+`useForm()`, in contrast, is a data hook that exposes a series of useful objects that serve the edit form. For example, grabbing the `onFinish` function to submit the form with the `handleSubmit` event handler. It also uses `formLoading` property to present state changes of the submitted form.
-The `useForm()` hook is a higher-level hook built on top of Refine's `useForm()` core hook. It fully supports form state management, field validation and submission using React Hook Form. Behind the scenes, it invokes the `dataProvider.getOne` method to get the user profile data from our Supabase `/profiles` endpoint and also invokes `dataProvider.update` method when `onFinish()` is called.
+The `useForm()` hook is a higher-level hook built on top of Refine's `useForm()` core hook. It fully supports form state management, field validation and submission using React Hook Form. Behind the scenes, it invokes the `dataProvider.getOne` method to get the user profile data from the Supabase `/profiles` endpoint and also invokes `dataProvider.update` method when `onFinish()` is called.
### Launch!
-Now that we have all the components in place, let's define the routes for the pages in which they should be rendered.
+Now that you have all the components in place, define the routes for the pages in which they should be rendered.
Add the routes for `/login` with the `` component and the routes for `index` path with the `` component. So, the final `App.tsx`:
-<$CodeTabs>
+<$CodeSample
+path="/user-management/refine-user-management/src/App.tsx"
+lines={[[1, -1]]}
+meta="name=src/App.tsx"
+/>
-```tsx name=src/App.tsx
-import { Authenticated, Refine } from '@refinedev/core'
-import { RefineKbar, RefineKbarProvider } from '@refinedev/kbar'
-import routerProvider, {
- CatchAllNavigate,
- DocumentTitleHandler,
- UnsavedChangesNotifier,
-} from '@refinedev/react-router'
-import { dataProvider, liveProvider } from '@refinedev/supabase'
-import { BrowserRouter, Outlet, Route, Routes } from 'react-router'
-
-import './App.css'
-import authProvider from './authProvider'
-import { supabaseClient } from './utility'
-import Account from './components/account'
-import Auth from './components/auth'
-
-function App() {
- return (
-
-
-
-
- }
- >
-
-
- }
- >
- } />
-
- } />}>
- } />
-
-
-
-
-
-
-
-
- )
-}
-
-export default App
-```
-
-$CodeTabs>
-
-Let's test the App by running the server again:
+Test the App by running the server again:
```bash
npm run dev
@@ -511,153 +223,24 @@ Every Supabase project is configured with [Storage](/docs/guides/storage) for ma
### Create an upload widget
-Let's create an avatar for the user so that they can upload a profile photo. We can start by creating a new component:
+Create an avatar for the user so that they can upload a profile photo. Add a new component:
Create and edit `src/components/avatar.tsx`:
-<$CodeTabs>
-
-```tsx name=src/components/avatar.tsx
-import { useEffect, useState } from 'react'
-import { supabaseClient } from '../utility/supabaseClient'
-
-type TAvatarProps = {
- url?: string
- size: number
- onUpload: (filePath: string) => void
-}
-
-export default function Avatar({ url, size, onUpload }: TAvatarProps) {
- const [avatarUrl, setAvatarUrl] = useState('')
- const [uploading, setUploading] = useState(false)
-
- useEffect(() => {
- if (url) downloadImage(url)
- }, [url])
-
- async function downloadImage(path: string) {
- try {
- const { data, error } = await supabaseClient.storage.from('avatars').download(path)
- if (error) {
- throw error
- }
- const url = URL.createObjectURL(data)
- setAvatarUrl(url)
- } catch (error: any) {
- console.log('Error downloading image: ', error?.message)
- }
- }
-
- async function uploadAvatar(event: React.ChangeEvent) {
- try {
- setUploading(true)
-
- if (!event.target.files || event.target.files.length === 0) {
- throw new Error('You must select an image to upload.')
- }
-
- const file = event.target.files[0]
- const fileExt = file.name.split('.').pop()
- const fileName = `${Math.random()}.${fileExt}`
- const filePath = `${fileName}`
-
- const { error: uploadError } = await supabaseClient.storage
- .from('avatars')
- .upload(filePath, file)
-
- if (uploadError) {
- throw uploadError
- }
- onUpload(filePath)
- } catch (error: any) {
- alert(error.message)
- } finally {
- setUploading(false)
- }
- }
-
- return (
-
- {avatarUrl ? (
-
- ) : (
-
- )}
-
-
-
-
-
- )
-}
-```
-
-$CodeTabs>
+<$CodeSample
+path="/user-management/refine-user-management/src/components/avatar.tsx"
+lines={[[1, -1]]}
+meta="name=src/components/avatar.tsx"
+/>
### Add the new widget
-And then we can add the widget to the Account page at `src/components/account.tsx`:
+And then add the widget to the Account page at `src/components/account.tsx`:
-<$CodeTabs>
-
-```tsx name=src/components/account.tsx
-// Import the new components
-import { Controller } from 'react-hook-form'
-import Avatar from './avatar'
-
-// ...
-
-return (
-
- Maximum time the pipeline waits to collect additional changes before
- flushing a batch.
+ Maximum time pipeline waits to collect additional changes before flushing a
+ batch.
>
@@ -122,7 +126,7 @@ export const AdvancedSettings = ({
Number of parallel connections each table copy can use during initial sync.
- Higher values can copy large tables faster, but consume more database
+ More connections speed up large table copies, but use more database
connections.