diff --git a/web/docs/client/.gitkeep b/web/docs/client/.gitkeep new file mode 100644 index 00000000000..e69de29bb2d diff --git a/web/docs/client/adj.mdx b/web/docs/client/adj.mdx deleted file mode 100644 index 682e8c1119d..00000000000 --- a/web/docs/client/adj.mdx +++ /dev/null @@ -1,226 +0,0 @@ ---- -id: adj -title: ".adj()" -slug: adj -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Finds all rows whose range value on the stated `column` is adjacent to -the specified `range`. - - - - - -```js -const { data, error } = await supabase - .from('countries') - .select('name, id, population_range_millions') - .adj('population_range_millions', [70, 185]) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -## Parameters - - - - - - - - - - - - - - - - - -## Examples - -### With `select()` - - - - - - - -```js -const { data, error } = await supabase - .from('countries') - .select('name, id, population_range_millions') - .adj('population_range_millions', [70, 185]) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `update()` - - - - - - - -```js -const { data, error } = await supabase - .from('countries') - .update({ name: 'Mordor' }) - .adj('population_range_millions', [70, 185]) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `delete()` - - - - - - - -```js -const { data, error } = await supabase - .from('countries') - .delete() - .adj('population_range_millions', [70, 185]) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `rpc()` - - - - - - - -```js -// Only valid if the Stored Procedure returns a table type. -const { data, error } = await supabase - .rpc('echo_all_countries') - .adj('population_range_millions', [70, 185]) -``` - - - - - -```py -# Not yet implemented -``` - - - - - \ No newline at end of file diff --git a/web/docs/client/auth-forgotpassword.mdx b/web/docs/client/auth-forgotpassword.mdx deleted file mode 100644 index 0df4ea284e3..00000000000 --- a/web/docs/client/auth-forgotpassword.mdx +++ /dev/null @@ -1,75 +0,0 @@ ---- -id: auth-forgotpassword -title: "auth.forgotPassword()" -slug: auth-forgotpassword ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - - - - - -```js -const { data, error } = supabase.auth.api.resetPasswordForEmail('user@email.com') -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -Sends a reset request to an email address. - -When the user clicks the reset link in the email they will be forwarded to: -`#access_token=x&refresh_token=y&expires_in=z&token_type=bearer&type=recovery` - -Your app must detect `type=recovery` in the fragment and display a password reset form to the user. - -You should then use the access_token in the url and new password to update the user as follows: - -```js -const { error, data } = await auth.api - .updateUser(access_token, { password : new_password }) -``` - - - -## Parameters - - - \ No newline at end of file diff --git a/web/docs/client/auth-onauthstatechange.mdx b/web/docs/client/auth-onauthstatechange.mdx deleted file mode 100644 index b1b251f8145..00000000000 --- a/web/docs/client/auth-onauthstatechange.mdx +++ /dev/null @@ -1,109 +0,0 @@ ---- -id: auth-onauthstatechange -title: "auth.onAuthStateChange()" -slug: auth-onauthstatechange -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Receive a notification every time an auth event happens. - - - - - -```js -supabase.auth.onAuthStateChange((event, session) => { - console.log(event, session) -}) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -## Parameters - - - - - - - - - - - - - - - - - -## Examples - -### Listen to auth changes - - - - - - - -```js -supabase.auth.onAuthStateChange((event, session) => { - console.log(event, session) -}) -``` - - - - - -```py -# Not yet implemented -``` - - - - - \ No newline at end of file diff --git a/web/docs/client/auth-password-reset.mdx b/web/docs/client/auth-password-reset.mdx deleted file mode 100644 index 60f876cb859..00000000000 --- a/web/docs/client/auth-password-reset.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: auth-password-reset -title: "auth.password-reset" -slug: auth-password-reset ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Sends a reset request to an email address. - - - -## Parameters - - - \ No newline at end of file diff --git a/web/docs/client/auth-session.mdx b/web/docs/client/auth-session.mdx deleted file mode 100644 index 8992d282160..00000000000 --- a/web/docs/client/auth-session.mdx +++ /dev/null @@ -1,81 +0,0 @@ ---- -id: auth-session -title: "auth.session()" -slug: auth-session -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Returns the session data, if there is an active session. - - - - - -```js -const session = supabase.auth.session() -``` - - - - - -```py -# Not yet implemented -``` - - - - - - - - - - - - - - - - - - - - - - -## Examples - -### Get the session data - - - - - - - -```js -const session = supabase.auth.session() -``` - - - - - -```py -# Not yet implemented -``` - - - - - \ No newline at end of file diff --git a/web/docs/client/auth-signin.mdx b/web/docs/client/auth-signin.mdx deleted file mode 100644 index fd7b6fa5253..00000000000 --- a/web/docs/client/auth-signin.mdx +++ /dev/null @@ -1,243 +0,0 @@ ---- -id: auth-signin -title: "auth.signIn()" -slug: auth-signin -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Log in an existing user, or login via a third-party provider. - - - - - -```js -const { user, error } = await supabase.auth.signIn({ - email: 'example@email.com', - password: 'example-password', -}) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -## Parameters - - - - - -## Notes - -- A user can sign up either via email or OAuth. -- If you provide `email` without a `password`, the user will be sent a magic link. -- The magic link's destination URL is determined by the SITE_URL config variable. To change this, you can go to Authentication -> Settings on [app.supabase.io](https://app.supabase.io) -- Specifying a `provider` will open the browser to the relevant login page. - - - - - - - - - - -## Examples - -### Sign in with email. - - - - - - - -```js -const { user, error } = await supabase.auth.signIn({ - email: 'example@email.com', - password: 'example-password', -}) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### Sign in with magic link. - -If no password is provided, the user will be sent a "magic link" to their email address, which they can click to open your application with a valid session. By default, a given user can only request a Magic Link once every 60 seconds. - - - - - -```js -const { user, error } = await supabase.auth.signIn({ - email: 'example@email.com' -}) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### Sign in using third-party providers. - -Supabase supports OAuth logins. - - - - - -```js -const { user, error } = await supabase.auth.signIn({ - // provider can be 'github', 'google', 'gitlab', or 'bitbucket' - provider: 'github' -}) -``` - - - - - -```py -# Not yet implemented -``` - - - - - \ No newline at end of file diff --git a/web/docs/client/auth-signout.mdx b/web/docs/client/auth-signout.mdx deleted file mode 100644 index d03fe848017..00000000000 --- a/web/docs/client/auth-signout.mdx +++ /dev/null @@ -1,81 +0,0 @@ ---- -id: auth-signout -title: "auth.signOut()" -slug: auth-signout -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Signs out the current user, if there is a logged in user. - - - - - -```js -const { error } = supabase.auth.signOut() -``` - - - - - -```py -# Not yet implemented -``` - - - - - - - - - - - - - - - - - - - - - - -## Examples - -### Sign out - - - - - - - -```js -const { error } = supabase.auth.signOut() -``` - - - - - -```py -# Not yet implemented -``` - - - - - \ No newline at end of file diff --git a/web/docs/client/auth-signup.mdx b/web/docs/client/auth-signup.mdx deleted file mode 100644 index 2bad085dd8f..00000000000 --- a/web/docs/client/auth-signup.mdx +++ /dev/null @@ -1,159 +0,0 @@ ---- -id: auth-signup -title: "auth.signUp()" -slug: auth-signup -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates a new user. - - - - - -```js -const { user, error } = await supabase.auth.signUp({ - email: 'example@email.com', - password: 'example-password', -}) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -## Parameters - - - - - -## Notes - -- By default, the user will need to verify their email address before logging in. If you would like to change this, you can disable email confirmations by going to Authentication -> Settings on [app.supabase.io](https://app.supabase.io) -- When the user confirms their email address, they will be redirected to localhost:3000 by default. To change this, you can go to Authentication -> Settings on [app.supabase.io](https://app.supabase.io) - - - - - - - - - - -## Examples - -### Sign up - - - - - - - -```js -const { user, error } = await supabase.auth.signUp({ - email: 'example@email.com', - password: 'example-password', -}) -``` - - - - - -```py -# Not yet implemented -``` - - - - - \ No newline at end of file diff --git a/web/docs/client/auth-update.mdx b/web/docs/client/auth-update.mdx deleted file mode 100644 index daef20bfccb..00000000000 --- a/web/docs/client/auth-update.mdx +++ /dev/null @@ -1,111 +0,0 @@ ---- -id: auth-update -title: "auth.update()" -slug: auth-update -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Updates user data, if there is a logged in user. - - - - - -```js -const { user, error } = await supabase.auth.update({ - data: { hello: 'world' } -}) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -## Parameters - - - - - -## Notes - -It's generally better to store user data in a table inside your public schema (i.e. `public.users`). -Use the `update()` method if you have data which rarely changes or is specific only to the logged in user. - - - - - - - - - - -## Examples - -### Update a user's metadata. - - - - - - - -```js -const { user, error } = await supabase.auth.update({ - data: { hello: 'world' } -}) -``` - - - - - -```py -# Not yet implemented -``` - - - - - \ No newline at end of file diff --git a/web/docs/client/auth-user.mdx b/web/docs/client/auth-user.mdx deleted file mode 100644 index 3858ffc50b5..00000000000 --- a/web/docs/client/auth-user.mdx +++ /dev/null @@ -1,81 +0,0 @@ ---- -id: auth-user -title: "auth.user()" -slug: auth-user -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Returns the user data, if there is a logged in user. - - - - - -```js -const user = supabase.auth.user() -``` - - - - - -```py -# Not yet implemented -``` - - - - - - - - - - - - - - - - - - - - - - -## Examples - -### Get the logged in user - - - - - - - -```js -const user = supabase.auth.user() -``` - - - - - -```py -# Not yet implemented -``` - - - - - \ No newline at end of file diff --git a/web/docs/client/cd.mdx b/web/docs/client/cd.mdx deleted file mode 100644 index b88be48a673..00000000000 --- a/web/docs/client/cd.mdx +++ /dev/null @@ -1,226 +0,0 @@ ---- -id: cd -title: ".cd()" -slug: cd -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Finds all rows whose json, array, or range value on the stated `column` is -contained by the specified `value`. - - - - - -```js -const { data, error } = await supabase - .from('countries') - .select('name, id, main_exports') - .cd('main_exports', ['cars', 'food', 'machine']) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -## Parameters - - - - - - - - - - - - - - - - - -## Examples - -### With `select()` - - - - - - - -```js -const { data, error } = await supabase - .from('countries') - .select('name, id, main_exports') - .cd('main_exports', ['cars', 'food', 'machine']) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `update()` - - - - - - - -```js -const { data, error } = await supabase - .from('countries') - .update({ name: 'Mordor' }) - .cd('main_exports', ['orks', 'surveillance', 'evil']) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `delete()` - - - - - - - -```js -const { data, error } = await supabase - .from('countries') - .delete() - .cd('main_exports', ['cars', 'food', 'machine']) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `rpc()` - - - - - - - -```js -// Only valid if the Stored Procedure returns a table type. -const { data, error } = await supabase - .rpc('echo_all_countries') - .cd('main_exports', ['cars', 'food', 'machine']) -``` - - - - - -```py -# Not yet implemented -``` - - - - - \ No newline at end of file diff --git a/web/docs/client/cs.mdx b/web/docs/client/cs.mdx deleted file mode 100644 index cd661bd3a05..00000000000 --- a/web/docs/client/cs.mdx +++ /dev/null @@ -1,226 +0,0 @@ ---- -id: cs -title: ".cs()" -slug: cs -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Finds all rows whose json, array, or range value on the stated `column` -contains the values specified in `value`. - - - - - -```js -const { data, error } = await supabase - .from('countries') - .select('name, id, main_exports') - .cs('main_exports', ['oil']) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -## Parameters - - - - - - - - - - - - - - - - - -## Examples - -### With `select()` - - - - - - - -```js -const { data, error } = await supabase - .from('countries') - .select('name, id, main_exports') - .cs('main_exports', ['oil']) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `update()` - - - - - - - -```js -const { data, error } = await supabase - .from('countries') - .update({ name: 'Mordor' }) - .cs('main_exports', ['oil']) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `delete()` - - - - - - - -```js -const { data, error } = await supabase - .from('countries') - .delete() - .cs('main_exports', ['oil']) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `rpc()` - - - - - - - -```js -// Only valid if the Stored Procedure returns a table type. -const { data, error } = await supabase - .rpc('echo_all_countries') - .cs('main_exports', ['oil']) -``` - - - - - -```py -# Not yet implemented -``` - - - - - \ No newline at end of file diff --git a/web/docs/client/delete.mdx b/web/docs/client/delete.mdx deleted file mode 100644 index 5d01cb569ec..00000000000 --- a/web/docs/client/delete.mdx +++ /dev/null @@ -1,158 +0,0 @@ ---- -id: delete -title: "Delete data: delete()" -slug: delete -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Performs a DELETE on the table. - - - - - -```js -const { data, error } = await supabase - .from('cities') - .delete() - .match({ id: 666 }) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -## Parameters - - - - - -## Notes - -- `delete()` should always be combined with [Filters](/docs/client/using-filters) to target the item(s) you wish to delete. - - - - - - - - - - -## Examples - -### Delete records - - - - - - - -```js -const { data, error } = await supabase - .from('cities') - .delete() - .match({ id: 666 }) -``` - - - - - -```py -# Not yet implemented -``` - - - - - \ No newline at end of file diff --git a/web/docs/client/eq.mdx b/web/docs/client/eq.mdx deleted file mode 100644 index 38c8675bdb9..00000000000 --- a/web/docs/client/eq.mdx +++ /dev/null @@ -1,226 +0,0 @@ ---- -id: eq -title: ".eq()" -slug: eq -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Finds all rows whose value on the stated `column` exactly matches the -specified `value`. - - - - - -```js -const { data, error } = await supabase - .from('cities') - .select('name, country_id') - .eq('name', 'The shire') -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -## Parameters - - - - - - - - - - - - - - - - - -## Examples - -### With `select()` - - - - - - - -```js -const { data, error } = await supabase - .from('cities') - .select('name, country_id') - .eq('name', 'The shire') -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `update()` - - - - - - - -```js -const { data, error } = await supabase - .from('cities') - .update({ name: 'Mordor' }) - .eq('name', 'San Francisco') -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `delete()` - - - - - - - -```js -const { data, error } = await supabase - .from('cities') - .delete() - .eq('name', 'Mordor') -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `rpc()` - - - - - - - -```js -// Only valid if the Stored Procedure returns a table type. -const { data, error } = await supabase - .rpc('echo_all_cities') - .eq('name', 'San Francisco') -``` - - - - - -```py -# Not yet implemented -``` - - - - - \ No newline at end of file diff --git a/web/docs/client/filter.mdx b/web/docs/client/filter.mdx deleted file mode 100644 index cd73faa1a5a..00000000000 --- a/web/docs/client/filter.mdx +++ /dev/null @@ -1,277 +0,0 @@ ---- -id: filter -title: ".filter()" -slug: filter -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Finds all rows whose `column` satisfies the filter. - - - - - -```js -const { data, error } = await supabase - .from('cities') - .select('name, country_id') - .filter('name', 'eq', 'Paris') -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -## Parameters - - - - - - - - - - - - - - - - - -## Examples - -### With `select()` - - - - - - - -```js -const { data, error } = await supabase - .from('cities') - .select('name, country_id') - .filter('name', 'eq', 'Paris') -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `update()` - - - - - - - -```js -const { data, error } = await supabase - .from('cities') - .update({ name: 'Mordor' }) - .filter('name', 'eq', 'Paris') -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `delete()` - - - - - - - -```js -const { data, error } = await supabase - .from('cities') - .delete() - .filter('name', 'eq', 'Paris') -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `rpc()` - - - - - - - -```js -// Only valid if the Stored Procedure returns a table type. -const { data, error } = await supabase - .rpc('echo_all_cities') - .filter('name', 'eq', 'Paris') -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### Filter embedded resources - - - - - - - -```js -const { data, error } = await supabase - .from('cities') - .select('name, countries ( name )') - .filter('countries.name', 'eq', 'France') -``` - - - - - -```py -# Not yet implemented -``` - - - - - \ No newline at end of file diff --git a/web/docs/client/fts.mdx b/web/docs/client/fts.mdx deleted file mode 100644 index 51db8fa532b..00000000000 --- a/web/docs/client/fts.mdx +++ /dev/null @@ -1,108 +0,0 @@ ---- -id: fts -title: ".fts()" -slug: fts -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Finds all rows whose tsvector value on the stated `column` matches -to_tsquery(`query`). - - - -## Parameters - - - \ No newline at end of file diff --git a/web/docs/client/generating-types.mdx b/web/docs/client/generating-types.mdx deleted file mode 100644 index cc012a97f37..00000000000 --- a/web/docs/client/generating-types.mdx +++ /dev/null @@ -1,81 +0,0 @@ ---- -id: generating-types -title: "Generating Types" -slug: generating-types -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Supabase will soon release native type generators that dump your database types for various languages. For now, we support TypeScript through a third-party tool. - -## Usage with TypeScript - -`supabase-js` ships with type definitions for usage with TypeScript and for convenient IntelliSense auto-complete and documentation in your editor. - -When using TypeScript, you can pass the type of database row as a type parameter to the `from` method to get better auto-completion support down the chain. -If you don't provide a type for the row you need to explicitly pass `from('tableName')`. - -```ts -type Message = { - id: number; - inserted_at: string; - message: string; - user_id: string; - channel_id: number; - author: { username: string }; -} - -const response = await supabase - .from('messages') // Message maps to the type of the row in your database. - .select('*, author:user_id(username)') - .match({ channel_id: 2 }) // Your IDE will be able to help with auto-completion. -response.data // Response data will be of type Array. - -// If you don't provide a type for the row you need to explicitly pass `from('tableName')`. -const response = await supabase - .from('messages') - .select('*, author:user_id(username)') - .match({ channel_id: 2 }) -response.data // Response data will be of type Array. -``` - -### Generate database types from Swagger OpenAPI specification - -Supabase generates a Swagger specification file for your database which can be used to generate your data types for usage with TypeScript. - -The Swagger specification for your Supabase project can be accessed as follows: - -```txt -https://your-project.supabase.co/rest/v1/?apikey=your-anon-key -``` - -Using the open source [swagger-to-ts](https://github.com/manifoldco/swagger-to-ts#%EF%B8%8F-reading-specs-from-remote-resource) tool you can generate your types and store them locally: - -```bash -npx @manifoldco/swagger-to-ts https://your-project.supabase.co/rest/v1/?apikey=your-anon-key --output types/supabase.ts -``` - -**Note:** Do note that your local types won't automatically stay in sync with your database, so make sure to regenerate your types after your make changes to your database. - -After you have generated your types, you can use them in your TypeScript projects: - -```ts -import { NextApiRequest, NextApiResponse } from "next"; -import { createClient } from "@supabase/supabase-js"; -import { definitions } from "../../types/supabase"; - -const supabase = createClient( - process.env.NEXT_PUBLIC_SUPABASE_URL, - process.env.SUPABASE_SECRET_KEY -); - -export default async (req: NextApiRequest, res: NextApiResponse) => { - const allOnlineUsers = await supabase - .from("users") - .select("*") - .eq("status", "ONLINE"); - res.status(200).json(allOnlineUsers); -}; -``` \ No newline at end of file diff --git a/web/docs/client/getsubscriptions.mdx b/web/docs/client/getsubscriptions.mdx deleted file mode 100644 index 5ce1b38e6eb..00000000000 --- a/web/docs/client/getsubscriptions.mdx +++ /dev/null @@ -1,81 +0,0 @@ ---- -id: getsubscriptions -title: "getSubscriptions()" -slug: getsubscriptions -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Returns an array of all your subscriptions. - - - - - -```js -const subscriptions = supabase.getSubscriptions() -``` - - - - - -```py -# Not yet implemented -``` - - - - - - - - - - - - - - - - - - - - - - -## Examples - -### Remove a subscription - - - - - - - -```js -const subscriptions = supabase.getSubscriptions() -``` - - - - - -```py -# Not yet implemented -``` - - - - - \ No newline at end of file diff --git a/web/docs/client/gt.mdx b/web/docs/client/gt.mdx deleted file mode 100644 index 8ebde784fa2..00000000000 --- a/web/docs/client/gt.mdx +++ /dev/null @@ -1,226 +0,0 @@ ---- -id: gt -title: ".gt()" -slug: gt -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Finds all rows whose value on the stated `column` is greater than the -specified `value`. - - - - - -```js -const { data, error } = await supabase - .from('cities') - .select('name, country_id') - .gt('country_id', 250) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -## Parameters - - -
    - -
  • -

    - - column - - - required - - - object - -

    -
    - -The column to filter on. - -
    - -
    • - - -
  • -

    - - value - - - required - - - object - -

    -
    - -The value to filter with. - -
    - -
    • - -
- - - - - - - - - - - - - - -## Examples - -### With `select()` - - - - - - - -```js -const { data, error } = await supabase - .from('cities') - .select('name, country_id') - .gt('country_id', 250) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `update()` - - - - - - - -```js -const { data, error } = await supabase - .from('cities') - .update({ name: 'Mordor' }) - .gt('country_id', 250) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `delete()` - - - - - - - -```js -const { data, error } = await supabase - .from('cities') - .delete() - .gt('country_id', 250) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `rpc()` - - - - - - - -```js -// Only valid if the Stored Procedure returns a table type. -const { data, error } = await supabase - .rpc('echo_all_cities') - .gt('country_id', 250) -``` - - - - - -```py -# Not yet implemented -``` - - - - - \ No newline at end of file diff --git a/web/docs/client/gte.mdx b/web/docs/client/gte.mdx deleted file mode 100644 index ddd3f9916bb..00000000000 --- a/web/docs/client/gte.mdx +++ /dev/null @@ -1,226 +0,0 @@ ---- -id: gte -title: ".gte()" -slug: gte -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Finds all rows whose value on the stated `column` is greater than or -equal to the specified `value`. - - - - - -```js -const { data, error } = await supabase - .from('cities') - .select('name, country_id') - .gte('country_id', 250) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -## Parameters - - -
    - -
  • -

    - - column - - - required - - - object - -

    -
    - -The column to filter on. - -
    - -
    • - - -
  • -

    - - value - - - required - - - object - -

    -
    - -The value to filter with. - -
    - -
    • - -
- - - - - - - - - - - - - - -## Examples - -### With `select()` - - - - - - - -```js -const { data, error } = await supabase - .from('cities') - .select('name, country_id') - .gte('country_id', 250) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `update()` - - - - - - - -```js -const { data, error } = await supabase - .from('cities') - .update({ name: 'Mordor' }) - .gte('country_id', 250) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `delete()` - - - - - - - -```js -const { data, error } = await supabase - .from('cities') - .delete() - .gte('country_id', 250) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `rpc()` - - - - - - - -```js -// Only valid if the Stored Procedure returns a table type. -const { data, error } = await supabase - .rpc('echo_all_cities') - .gte('country_id', 250) -``` - - - - - -```py -# Not yet implemented -``` - - - - - \ No newline at end of file diff --git a/web/docs/client/ilike.mdx b/web/docs/client/ilike.mdx deleted file mode 100644 index 9f3f0e0829e..00000000000 --- a/web/docs/client/ilike.mdx +++ /dev/null @@ -1,226 +0,0 @@ ---- -id: ilike -title: ".ilike()" -slug: ilike -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Finds all rows whose value in the stated `column` matches the supplied -`pattern` (case insensitive). - - - - - -```js -const { data, error } = await supabase - .from('cities') - .select('name, country_id') - .ilike('name', '%la%') -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -## Parameters - - -
    - -
  • -

    - - column - - - required - - - object - -

    -
    - -The column to filter on. - -
    - -
    • - - -
  • -

    - - pattern - - - required - - - string - -

    -
    - -The pattern to filter with. - -
    - -
    • - -
- - - - - - - - - - - - - - -## Examples - -### With `select()` - - - - - - - -```js -const { data, error } = await supabase - .from('cities') - .select('name, country_id') - .ilike('name', '%la%') -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `update()` - - - - - - - -```js -const { data, error } = await supabase - .from('cities') - .update({ name: 'Mordor' }) - .ilike('name', '%la%') -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `delete()` - - - - - - - -```js -const { data, error } = await supabase - .from('cities') - .delete() - .ilike('name', '%la%') -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `rpc()` - - - - - - - -```js -// Only valid if the Stored Procedure returns a table type. -const { data, error } = await supabase - .rpc('echo_all_cities') - .ilike('name', '%la%') -``` - - - - - -```py -# Not yet implemented -``` - - - - - \ No newline at end of file diff --git a/web/docs/client/in.mdx b/web/docs/client/in.mdx deleted file mode 100644 index 4111366841e..00000000000 --- a/web/docs/client/in.mdx +++ /dev/null @@ -1,226 +0,0 @@ ---- -id: in -title: ".in()" -slug: in -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Finds all rows whose value on the stated `column` is found on the -specified `values`. - - - - - -```js -const { data, error } = await supabase - .from('cities') - .select('name, country_id') - .in('name', ['Rio de Janeiro', 'San Francisco']) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -## Parameters - - -
    - -
  • -

    - - column - - - required - - - object - -

    -
    - -The column to filter on. - -
    - -
    • - - -
  • -

    - - values - - - required - - - object - -

    -
    - -The values to filter with. - -
    - -
    • - -
- - - - - - - - - - - - - - -## Examples - -### With `select()` - - - - - - - -```js -const { data, error } = await supabase - .from('cities') - .select('name, country_id') - .in('name', ['Rio de Janeiro', 'San Francisco']) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `update()` - - - - - - - -```js -const { data, error } = await supabase - .from('cities') - .update({ name: 'Mordor' }) - .in('name', ['Rio de Janeiro', 'San Francisco']) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `delete()` - - - - - - - -```js -const { data, error } = await supabase - .from('cities') - .delete() - .in('name', ['Rio de Janeiro', 'San Francisco']) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `rpc()` - - - - - - - -```js -// Only valid if the Stored Procedure returns a table type. -const { data, error } = await supabase - .rpc('echo_all_cities') - .in('name', ['Rio de Janeiro', 'San Francisco']) -``` - - - - - -```py -# Not yet implemented -``` - - - - - \ No newline at end of file diff --git a/web/docs/client/index.mdx b/web/docs/client/index.mdx deleted file mode 100644 index 123cec04ee6..00000000000 --- a/web/docs/client/index.mdx +++ /dev/null @@ -1,20 +0,0 @@ ---- -id: index -title: "Supabase Client" -slug: supabase-client -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - - -Our client library is modular. Each sub-library is a standalone implementation for a single external system. This is one of the ways we support existing tools. - - -| Repo | Official | Community | -|-----------------------|--------------------------------------------------|------------------| -| **`supabase-{lang}`**
Combines libraries and adds enrichments. | [`JavaScript`](https://github.com/supabase/supabase-js) | [`C#`](https://github.com/supabase/supabase-csharp), [`Python`](https://github.com/supabase/supabase-py), `Rust` | -| `postgrest-{lang}`
Client library to work with [PostgREST](https://github.com/postgrest/postgrest) | [`JavaScript`](https://github.com/supabase/postgrest-js) | [`C#`](https://github.com/supabase/postgrest-csharp), [`Python`](https://github.com/supabase/postgrest-py), [`Rust`](https://github.com/supabase/postgrest-rs) | -| `realtime-{lang}`
Client library to work with [Realtime](https://github.com/supabase/realtime) | [`JavaScript`](https://github.com/supabase/realtime-js) | `C#`, `Python`, `Rust` | -| `gotrue-{lang}`
Client library to work with [GoTrue](https://github.com/netlify/gotrue) | [`JavaScript`](https://github.com/supabase/gotrue-js) | `C#`, `Python`, `Rust` | \ No newline at end of file diff --git a/web/docs/client/initializing.mdx b/web/docs/client/initializing.mdx deleted file mode 100644 index 99a9f5974d2..00000000000 --- a/web/docs/client/initializing.mdx +++ /dev/null @@ -1,160 +0,0 @@ ---- -id: initializing -title: "Initializing" -slug: initializing -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -You can initialize a new Supabase client using the `createClient()` method. - - - - -## Parameters - - -
    - -
  • -

    - - supabaseUrl - - - required - - - string - -

    -
    - -The unique Supabase URL which is supplied when you create a new project in your project dashboard. - -
    - -
    • - - -
  • -

    - - supabaseKey - - - required - - - string - -

    -
    - -The unique Supabase Key which is supplied when you create a new project in your project dashboard. - -
    - -
    • - - -
  • -

    - - options - - - optional - - - SupabaseClientOptions - -

    -
    - -No description provided. - -
    - -
    • - -
- - - - - - - - - - - - - - -## Examples - -### createClient() - - - - - - - -```js -import { createClient } from '@supabase/supabase-js' - -// Create a single supabase client for interacting with your database -const supabase = createClient("https://xyzcompany.supabase.co", "public-anon-key") -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With additional parameters - - - - - - - -```js -import { createClient } from '@supabase/supabase-js' - -const options = { } -const supabase = createClient("https://xyzcompany.supabase.co", "public-anon-key", options) -``` - - - - - -```py -# Not yet implemented -``` - - - - - \ No newline at end of file diff --git a/web/docs/client/insert.mdx b/web/docs/client/insert.mdx deleted file mode 100644 index 76e2dc9a9b8..00000000000 --- a/web/docs/client/insert.mdx +++ /dev/null @@ -1,296 +0,0 @@ ---- -id: insert -title: "Create data: insert()" -slug: insert -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Performs an INSERT into the table. - - - - - -```js -const { data, error } = await supabase - .from('cities') - .insert([ - { name: 'The Shire', country_id: 554 } - ]) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -## Parameters - - -
    - -
  • -

    - - values - - - required - - - Partial | array - -

    -
    - -The values to insert. - -
    - -
    • - - -
  • -

    - - __namedParameters - - - required - - - object - -

    -
    - -No description provided. - -
    - -
      -
      Properties
      - -
    • -

      - - upsert - - - required - - - boolean - -

      -
      - -If `true`, performs an UPSERT. - -
      - -
      • - - -
    • -

      - - returning - - - required - - - minimal | representation - -

      -
      - -By default the new record is returned. Set this to 'minimal' if you don't need this value. - -
      - -
      • - - -
    • -

      - - onConflict - - - required - - - undefined | string - -

      -
      - -By specifying the `on_conflict` query parameter, you can make UPSERT work on a column(s) that has a UNIQUE constraint. - -
      - -
      • - - -
    • -

      - - count - - - required - - - null | exact | planned | estimated - -

      -
      - -No description provided. - -
      - -
      • - -
    - -
    • - -
- - - - - - - - - - - - - - -## Examples - -### Create a record - - - - - - - -```js -const { data, error } = await supabase - .from('cities') - .insert([ - { name: 'The Shire', country_id: 554 } - ]) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### Bulk create - - - - - - - -```js -const { data, error } = await supabase - .from('cities') - .insert([ - { name: 'The Shire', country_id: 554 }, - { name: 'Rohan', country_id: 555 }, - ]) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### Upsert - -For upsert, if set to true, primary key columns would need to be included -in the data parameter in order for an update to properly happen. Also, primary keys -used must be natural, not surrogate. There are however, -[workarounds](https://github.com/PostgREST/postgrest/issues/1118) -for surrogate primary keys. - - - - - - -```js -const { data, error } = await supabase - .from('cities') - .insert( - [ - { name: 'The Shire', country_id: 554 }, - { name: 'Rohan', country_id: 555 }, - { name: 'City by the Bay', country_id:840} - ], - { upsert: true }) -``` - - - - - -```py -# Not yet implemented -``` - - - - - \ No newline at end of file diff --git a/web/docs/client/installing.mdx b/web/docs/client/installing.mdx deleted file mode 100644 index ceac31b4cbe..00000000000 --- a/web/docs/client/installing.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -id: installing -title: "Installing" -slug: installing -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -All JavaScript libraries are built directly by the Supabase team. - -Other languages are built by the community and supported by Supabase. - -## JavaScript - -```bash -npm install @supabase/supabase-js -``` - -Find the source code on [GitHub](https://github.com/supabase/supabase-js). - -## Python - -```bash -# Not yet implemented \ No newline at end of file diff --git a/web/docs/client/is.mdx b/web/docs/client/is.mdx deleted file mode 100644 index 6c0160d1891..00000000000 --- a/web/docs/client/is.mdx +++ /dev/null @@ -1,226 +0,0 @@ ---- -id: is -title: ".is()" -slug: is -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -A check for exact equality (null, true, false), finds all rows whose -value on the stated `column` exactly match the specified `value`. - - - - - -```js -const { data, error } = await supabase - .from('cities') - .select('name, country_id') - .is('name', null) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -## Parameters - - -
    - -
  • -

    - - column - - - required - - - object - -

    -
    - -The column to filter on. - -
    - -
    • - - -
  • -

    - - value - - - required - - - boolean | null - -

    -
    - -The value to filter with. - -
    - -
    • - -
- - - - - - - - - - - - - - -## Examples - -### With `select()` - - - - - - - -```js -const { data, error } = await supabase - .from('cities') - .select('name, country_id') - .is('name', null) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `update()` - - - - - - - -```js -const { data, error } = await supabase - .from('cities') - .update({ name: 'Mordor' }) - .is('name', null) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `delete()` - - - - - - - -```js -const { data, error } = await supabase - .from('cities') - .delete() - .is('name', null) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `rpc()` - - - - - - - -```js -// Only valid if the Stored Procedure returns a table type. -const { data, error } = await supabase - .rpc('echo_all_cities') - .is('name', null) -``` - - - - - -```py -# Not yet implemented -``` - - - - - \ No newline at end of file diff --git a/web/docs/client/like.mdx b/web/docs/client/like.mdx deleted file mode 100644 index bb227bd8102..00000000000 --- a/web/docs/client/like.mdx +++ /dev/null @@ -1,226 +0,0 @@ ---- -id: like -title: ".like()" -slug: like -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Finds all rows whose value in the stated `column` matches the supplied -`pattern` (case sensitive). - - - - - -```js -const { data, error } = await supabase - .from('cities') - .select('name, country_id') - .like('name', '%la%') -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -## Parameters - - -
    - -
  • -

    - - column - - - required - - - object - -

    -
    - -The column to filter on. - -
    - -
    • - - -
  • -

    - - pattern - - - required - - - string - -

    -
    - -The pattern to filter with. - -
    - -
    • - -
- - - - - - - - - - - - - - -## Examples - -### With `select()` - - - - - - - -```js -const { data, error } = await supabase - .from('cities') - .select('name, country_id') - .like('name', '%la%') -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `update()` - - - - - - - -```js -const { data, error } = await supabase - .from('cities') - .update({ name: 'Mordor' }) - .like('name', '%la%') -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `delete()` - - - - - - - -```js -const { data, error } = await supabase - .from('cities') - .delete() - .like('name', '%la%') -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `rpc()` - - - - - - - -```js -// Only valid if the Stored Procedure returns a table type. -const { data, error } = await supabase - .rpc('echo_all_cities') - .like('name', '%la%') -``` - - - - - -```py -# Not yet implemented -``` - - - - - \ No newline at end of file diff --git a/web/docs/client/limit.mdx b/web/docs/client/limit.mdx deleted file mode 100644 index c0c865fb267..00000000000 --- a/web/docs/client/limit.mdx +++ /dev/null @@ -1,189 +0,0 @@ ---- -id: limit -title: "limit()" -slug: limit -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Limits the result with the specified `count`. - - - - - -```js -const { data, error } = await supabase - .from('cities') - .select('name, country_id') - .limit(1) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -## Parameters - - -
    - -
  • -

    - - count - - - required - - - number - -

    -
    - -The maximum no. of rows to limit to. - -
    - -
    • - - -
  • -

    - - __namedParameters - - - required - - - object - -

    -
    - -No description provided. - -
    - -
      -
      Properties
      - -
    • -

      - - foreignTable - - - required - - - undefined | string - -

      -
      - -The foreign table to use (for foreign columns). - -
      - -
      • - -
    - -
    • - -
- - - - - - - - - - - - - - -## Examples - -### With `select()` - - - - - - - -```js -const { data, error } = await supabase - .from('cities') - .select('name, country_id') - .limit(1) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With embedded resources - - - - - - - -```js -const { data, error } = await supabase - .from('cities') - .select('name, cities(name)') - .eq('name', 'United States') - .limit(1, 'cities') -``` - - - - - -```py -# Not yet implemented -``` - - - - - \ No newline at end of file diff --git a/web/docs/client/lt.mdx b/web/docs/client/lt.mdx deleted file mode 100644 index 1701b79698a..00000000000 --- a/web/docs/client/lt.mdx +++ /dev/null @@ -1,226 +0,0 @@ ---- -id: lt -title: ".lt()" -slug: lt -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Finds all rows whose value on the stated `column` is less than the -specified `value`. - - - - - -```js -const { data, error } = await supabase - .from('cities') - .select('name, country_id') - .lt('country_id', 250) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -## Parameters - - -
    - -
  • -

    - - column - - - required - - - object - -

    -
    - -The column to filter on. - -
    - -
    • - - -
  • -

    - - value - - - required - - - object - -

    -
    - -The value to filter with. - -
    - -
    • - -
- - - - - - - - - - - - - - -## Examples - -### With `select()` - - - - - - - -```js -const { data, error } = await supabase - .from('cities') - .select('name, country_id') - .lt('country_id', 250) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `update()` - - - - - - - -```js -const { data, error } = await supabase - .from('cities') - .update({ name: 'Mordor' }) - .lt('country_id', 250) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `delete()` - - - - - - - -```js -const { data, error } = await supabase - .from('cities') - .delete() - .lt('country_id', 250) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `rpc()` - - - - - - - -```js -// Only valid if the Stored Procedure returns a table type. -const { data, error } = await supabase - .rpc('echo_all_cities') - .lt('country_id', 250) -``` - - - - - -```py -# Not yet implemented -``` - - - - - \ No newline at end of file diff --git a/web/docs/client/lte.mdx b/web/docs/client/lte.mdx deleted file mode 100644 index d998d7a999d..00000000000 --- a/web/docs/client/lte.mdx +++ /dev/null @@ -1,226 +0,0 @@ ---- -id: lte -title: ".lte()" -slug: lte -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Finds all rows whose value on the stated `column` is less than or equal -to the specified `value`. - - - - - -```js -const { data, error } = await supabase - .from('cities') - .select('name, country_id') - .lte('country_id', 250) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -## Parameters - - -
    - -
  • -

    - - column - - - required - - - object - -

    -
    - -The column to filter on. - -
    - -
    • - - -
  • -

    - - value - - - required - - - object - -

    -
    - -The value to filter with. - -
    - -
    • - -
- - - - - - - - - - - - - - -## Examples - -### With `select()` - - - - - - - -```js -const { data, error } = await supabase - .from('cities') - .select('name, country_id') - .lte('country_id', 250) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `update()` - - - - - - - -```js -const { data, error } = await supabase - .from('cities') - .update({ name: 'Mordor' }) - .lte('country_id', 250) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `delete()` - - - - - - - -```js -const { data, error } = await supabase - .from('cities') - .delete() - .lte('country_id', 250) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `rpc()` - - - - - - - -```js -// Only valid if the Stored Procedure returns a table type. -const { data, error } = await supabase - .rpc('echo_all_cities') - .lte('country_id', 250) -``` - - - - - -```py -# Not yet implemented -``` - - - - - \ No newline at end of file diff --git a/web/docs/client/match.mdx b/web/docs/client/match.mdx deleted file mode 100644 index 05c232ea63e..00000000000 --- a/web/docs/client/match.mdx +++ /dev/null @@ -1,205 +0,0 @@ ---- -id: match -title: ".match()" -slug: match -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Finds all rows whose columns match the specified `query` object. - - - - - -```js -const { data, error } = await supabase - .from('cities') - .select('name, country_id') - .match({name: 'Beijing', country_id: 156}) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -## Parameters - - -
    - -
  • -

    - - query - - - required - - - object - -

    -
    - -The object to filter with, with column names as keys mapped - to their filter values. - -
    - -
    • - -
- - - - - - - - - - - - - - -## Examples - -### With `select()` - - - - - - - -```js -const { data, error } = await supabase - .from('cities') - .select('name, country_id') - .match({name: 'Beijing', country_id: 156}) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `update()` - - - - - - - -```js -const { data, error } = await supabase - .from('cities') - .update({ name: 'Mordor' }) - .match({name: 'Beijing', country_id: 156}) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `delete()` - - - - - - - -```js -const { data, error } = await supabase - .from('cities') - .delete() - .match({name: 'Beijing', country_id: 156}) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `rpc()` - - - - - - - -```js -// Only valid if the Stored Procedure returns a table type. -const { data, error } = await supabase - .rpc('echo_all_cities') - .match({name: 'Beijing', country_id: 156}) -``` - - - - - -```py -# Not yet implemented -``` - - - - - \ No newline at end of file diff --git a/web/docs/client/neq.mdx b/web/docs/client/neq.mdx deleted file mode 100644 index 3818838ebdd..00000000000 --- a/web/docs/client/neq.mdx +++ /dev/null @@ -1,226 +0,0 @@ ---- -id: neq -title: ".neq()" -slug: neq -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Finds all rows whose value on the stated `column` doesn't match the -specified `value`. - - - - - -```js -const { data, error } = await supabase - .from('cities') - .select('name, country_id') - .neq('name', 'The shire') -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -## Parameters - - -
    - -
  • -

    - - column - - - required - - - object - -

    -
    - -The column to filter on. - -
    - -
    • - - -
  • -

    - - value - - - required - - - object - -

    -
    - -The value to filter with. - -
    - -
    • - -
- - - - - - - - - - - - - - -## Examples - -### With `select()` - - - - - - - -```js -const { data, error } = await supabase - .from('cities') - .select('name, country_id') - .neq('name', 'The shire') -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `update()` - - - - - - - -```js -const { data, error } = await supabase - .from('cities') - .update({ name: 'Mordor' }) - .neq('name', 'San Francisco') -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `delete()` - - - - - - - -```js -const { data, error } = await supabase - .from('cities') - .delete() - .neq('name', 'Mordor') -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `rpc()` - - - - - - - -```js -// Only valid if the Stored Procedure returns a table type. -const { data, error } = await supabase - .rpc('echo_all_cities') - .neq('name', 'Lagos') -``` - - - - - -```py -# Not yet implemented -``` - - - - - \ No newline at end of file diff --git a/web/docs/client/not.mdx b/web/docs/client/not.mdx deleted file mode 100644 index a07edf1d392..00000000000 --- a/web/docs/client/not.mdx +++ /dev/null @@ -1,246 +0,0 @@ ---- -id: not -title: ".not()" -slug: not -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Finds all rows which doesn't satisfy the filter. - - - - - -```js -const { data, error } = await supabase - .from('cities') - .select('name, country_id') - .not('name', 'eq', 'Paris') -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -## Parameters - - -
    - -
  • -

    - - column - - - required - - - object - -

    -
    - -The column to filter on. - -
    - -
    • - - -
  • -

    - - operator - - - required - - - FilterOperator - -

    -
    - -The operator to filter with. - -
    - -
    • - - -
  • -

    - - value - - - required - - - any - -

    -
    - -The value to filter with. - -
    - -
    • - -
- - - - - - - - - - - - - - -## Examples - -### With `select()` - - - - - - - -```js -const { data, error } = await supabase - .from('cities') - .select('name, country_id') - .not('name', 'eq', 'Paris') -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `update()` - - - - - - - -```js -const { data, error } = await supabase - .from('cities') - .update({ name: 'Mordor' }) - .not('name', 'eq', 'Paris') -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `delete()` - - - - - - - -```js -const { data, error } = await supabase - .from('cities') - .delete() - .not('name', 'eq', 'Paris') -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `rpc()` - - - - - - - -```js -// Only valid if the Stored Procedure returns a table type. -const { data, error } = await supabase - .rpc('echo_all_cities) - .not('name', 'eq', 'Paris') -``` - - - - - -```py -# Not yet implemented -``` - - - - - \ No newline at end of file diff --git a/web/docs/client/nxl.mdx b/web/docs/client/nxl.mdx deleted file mode 100644 index 1787708f89f..00000000000 --- a/web/docs/client/nxl.mdx +++ /dev/null @@ -1,226 +0,0 @@ ---- -id: nxl -title: ".nxl()" -slug: nxl -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Finds all rows whose range value on the stated `column` does not extend -to the left of the specified `range`. - - - - - -```js -const { data, error } = await supabase - .from('countries') - .select('name, id, population_range_millions') - .nxl('population_range_millions', [150, 250]) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -## Parameters - - -
    - -
  • -

    - - column - - - required - - - object - -

    -
    - -The column to filter on. - -
    - -
    • - - -
  • -

    - - range - - - required - - - string - -

    -
    - -The range to filter with. - -
    - -
    • - -
- - - - - - - - - - - - - - -## Examples - -### With `select()` - - - - - - - -```js -const { data, error } = await supabase - .from('countries') - .select('name, id, population_range_millions') - .nxl('population_range_millions', [150, 250]) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `update()` - - - - - - - -```js -const { data, error } = await supabase - .from('countries') - .update({ name: 'Mordor' }) - .nxl('population_range_millions', [150, 250]) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `delete()` - - - - - - - -```js -const { data, error } = await supabase - .from('countries') - .delete() - .nxl('population_range_millions', [150, 250]) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `rpc()` - - - - - - - -```js -// Only valid if the Stored Procedure returns a table type. -const { data, error } = await supabase - .rpc('echo_all_countries') - .nxl('population_range_millions', [150, 250]) -``` - - - - - -```py -# Not yet implemented -``` - - - - - \ No newline at end of file diff --git a/web/docs/client/nxr.mdx b/web/docs/client/nxr.mdx deleted file mode 100644 index 6c57328e948..00000000000 --- a/web/docs/client/nxr.mdx +++ /dev/null @@ -1,226 +0,0 @@ ---- -id: nxr -title: ".nxr()" -slug: nxr -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Finds all rows whose range value on the stated `column` does not extend -to the right of the specified `range`. - - - - - -```js -const { data, error } = await supabase - .from('countries') - .select('name, id, population_range_millions') - .nxr('population_range_millions', [150, 250]) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -## Parameters - - -
    - -
  • -

    - - column - - - required - - - object - -

    -
    - -The column to filter on. - -
    - -
    • - - -
  • -

    - - range - - - required - - - string - -

    -
    - -The range to filter with. - -
    - -
    • - -
- - - - - - - - - - - - - - -## Examples - -### With `select()` - - - - - - - -```js -const { data, error } = await supabase - .from('countries') - .select('name, id, population_range_millions') - .nxr('population_range_millions', [150, 250]) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `update()` - - - - - - - -```js -const { data, error } = await supabase - .from('countries') - .update({ name: 'Mordor' }) - .nxr('population_range_millions', [150, 250]) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `delete()` - - - - - - - -```js -const { data, error } = await supabase - .from('countries') - .delete() - .nxr('population_range_millions', [150, 250]) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `rpc()` - - - - - - - -```js -// Only valid if the Stored Procedure returns a table type. -const { data, error } = await supabase - .rpc('echo_all_countries') - .nxr('population_range_millions', [150, 250]) -``` - - - - - -```py -# Not yet implemented -``` - - - - - \ No newline at end of file diff --git a/web/docs/client/on.mdx b/web/docs/client/on.mdx deleted file mode 100644 index 312ed154ffb..00000000000 --- a/web/docs/client/on.mdx +++ /dev/null @@ -1,293 +0,0 @@ ---- -id: on -title: "Subscribing: on()" -slug: on ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Subscribe to realtime changes in your databse. - - - - - -```js -const mySubscription = supabase - .from('*') - .on('*', payload => { - console.log('Change received!', payload) - }) - .subscribe() -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -## Parameters - - -
    - -
  • -

    - - event - - - required - - - INSERT | UPDATE | DELETE | * - -

    -
    - -The database event which you would like to receive updates for, or you can use the special wildcard `*` to listen to all changes. - -
    - -
    • - - -
  • -

    - - callback - - - required - - - object - -

    -
    - -A callback that will handle the payload that is sent whenever your database changes. - -
    - -
    • - -
- - -## Notes - -- If you want to receive the "previous" data for updates and deletes, you will need to set `REPLICA IDENTITY` to `FULL`, like this: `ALTER TABLE your_table REPLICA IDENTITY FULL;` - - - - - - - - - - -## Examples - -### Listen to all database changes - - - - - - - -```js -const mySubscription = supabase - .from('*') - .on('*', payload => { - console.log('Change received!', payload) - }) - .subscribe() -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### Listening to a specific table - - - - - - - -```js -const mySubscription = supabase - .from('countries') - .on('*', payload => { - console.log('Change received!', payload) - }) - .subscribe() -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### Listening to inserts - - - - - - - -```js -const mySubscription = supabase - .from('countries') - .on('INSERT', payload => { - console.log('Change received!', payload) - }) - .subscribe() -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### Listening to updates - - - - - - - -```js -const mySubscription = supabase - .from('countries') - .on('UPDATE', payload => { - console.log('Change received!', payload) - }) - .subscribe() -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### Listening to deletes - - - - - - - -```js -const mySubscription = supabase - .from('countries') - .on('DELETE', payload => { - console.log('Change received!', payload) - }) - .subscribe() -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### Listening to multiple events - -You can chain listeners if you want to listen to multiple events for each table. - - - - - -```js -const mySubscription = supabase - .from('countries') - .on('INSERT', handleRecordInserted) - .on('DELETE', handleRecordDeleted) - .subscribe() -``` - - - - - -```py -# Not yet implemented -``` - - - - - \ No newline at end of file diff --git a/web/docs/client/or.mdx b/web/docs/client/or.mdx deleted file mode 100644 index 8a9e3de7388..00000000000 --- a/web/docs/client/or.mdx +++ /dev/null @@ -1,142 +0,0 @@ ---- -id: or -title: ".or()" -slug: or -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Finds all rows satisfying at least one of the filters. - - - - - -```js -const { data, error } = await supabase - .from('cities') - .select('name, country_id') - .or('id.eq.20,id.eq.30') -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -## Parameters - - -
    - -
  • -

    - - filters - - - required - - - string - -

    -
    - -The filters to use, separated by commas. - -
    - -
    • - -
- - - - - - - - - - - - - - -## Examples - -### With `select()` - - - - - - - -```js -const { data, error } = await supabase - .from('cities') - .select('name, country_id') - .or('id.eq.20,id.eq.30') -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### User `or` with `and` - - - - - - - -```js -const { data, error } = await supabase - .from('cities') - .select('name, country_id') - .or('id.gt.20,and(name.eq.New Zealand,name.eq.France)') -``` - - - - - -```py -# Not yet implemented -``` - - - - - \ No newline at end of file diff --git a/web/docs/client/order.mdx b/web/docs/client/order.mdx deleted file mode 100644 index db1ed638a14..00000000000 --- a/web/docs/client/order.mdx +++ /dev/null @@ -1,231 +0,0 @@ ---- -id: order -title: "order()" -slug: order -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Orders the result with the specified `column`. - - - - - -```js -const { data, error } = await supabase - .from('cities') - .select('name', 'country_id') - .order('id', { ascending: false }) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -## Parameters - - -
    - -
  • -

    - - column - - - required - - - object - -

    -
    - -The column to order on. - -
    - -
    • - - -
  • -

    - - __namedParameters - - - required - - - object - -

    -
    - -No description provided. - -
    - -
      -
      Properties
      - -
    • -

      - - nullsFirst - - - required - - - boolean - -

      -
      - -If `true`, `null`s appear first. - -
      - -
      • - - -
    • -

      - - foreignTable - - - required - - - undefined | string - -

      -
      - -The foreign table to use (if `column` is a foreign column). - -
      - -
      • - - -
    • -

      - - ascending - - - required - - - boolean - -

      -
      - -If `true`, the result will be in ascending order. - -
      - -
      • - -
    - -
    • - -
- - - - - - - - - - - - - - -## Examples - -### With `select()` - - - - - - - -```js -const { data, error } = await supabase - .from('cities') - .select('name', 'country_id') - .order('id', { ascending: false }) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With embedded resources - - - - - - - -```js -const { data, error } = await supabase - .from('countries') - .select('name, cities(name)') - .eq('name', 'United States') - .order('cities.name') -``` - - - - - -```py -# Not yet implemented -``` - - - - - \ No newline at end of file diff --git a/web/docs/client/ov.mdx b/web/docs/client/ov.mdx deleted file mode 100644 index d948e295b7c..00000000000 --- a/web/docs/client/ov.mdx +++ /dev/null @@ -1,226 +0,0 @@ ---- -id: ov -title: ".ov()" -slug: ov -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Finds all rows whose array or range value on the stated `column` is -contained by the specified `value`. - - - - - -```js -const { data, error } = await supabase - .from('countries') - .select('name, id, main_exports') - .ova('main_exports', ['computers', 'minerals']) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -## Parameters - - -
    - -
  • -

    - - column - - - required - - - object - -

    -
    - -The column to filter on. - -
    - -
    • - - -
  • -

    - - value - - - required - - - string | array - -

    -
    - -The value to filter with. - -
    - -
    • - -
- - - - - - - - - - - - - - -## Examples - -### With `select()` - - - - - - - -```js -const { data, error } = await supabase - .from('countries') - .select('name, id, main_exports') - .ova('main_exports', ['computers', 'minerals']) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `update()` - - - - - - - -```js -let countries = await supabase - .from('countries') - .update({ name: 'Mordor' }) - .ova('main_exports', ['computers', 'minerals']) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `delete()` - - - - - - - -```js -const { data, error } = await supabase - .from('countries') - .delete() - .ova('main_exports', ['computers', 'minerals']) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `rpc()` - - - - - - - -```js -// Only valid if the Stored Procedure returns a table type. -const { data, error } = await supabase - .rpc('echo_all_countries') - .ova('main_exports', ['computers', 'minerals']) -``` - - - - - -```py -# Not yet implemented -``` - - - - - \ No newline at end of file diff --git a/web/docs/client/phfts.mdx b/web/docs/client/phfts.mdx deleted file mode 100644 index 7030f4e076c..00000000000 --- a/web/docs/client/phfts.mdx +++ /dev/null @@ -1,108 +0,0 @@ ---- -id: phfts -title: ".phfts()" -slug: phfts -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Finds all rows whose tsvector value on the stated `column` matches -phraseto_tsquery(`query`). - - - -## Parameters - - -
    - -
  • -

    - - column - - - required - - - object - -

    -
    - -The column to filter on. - -
    - -
    • - - -
  • -

    - - query - - - required - - - string - -

    -
    - -The Postgres tsquery string to filter with. - -
    - -
    • - - -
  • -

    - - __namedParameters - - - required - - - object - -

    -
    - -No description provided. - -
    - -
      -
      Properties
      - -
    • -

      - - config - - - required - - - undefined | string - -

      -
      - -The text search configuration to use. - -
      - -
      • - -
    - -
    • - -
\ No newline at end of file diff --git a/web/docs/client/plfts.mdx b/web/docs/client/plfts.mdx deleted file mode 100644 index a87e241600a..00000000000 --- a/web/docs/client/plfts.mdx +++ /dev/null @@ -1,108 +0,0 @@ ---- -id: plfts -title: ".plfts()" -slug: plfts -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Finds all rows whose tsvector value on the stated `column` matches -plainto_tsquery(`query`). - - - -## Parameters - - -
    - -
  • -

    - - column - - - required - - - object - -

    -
    - -The column to filter on. - -
    - -
    • - - -
  • -

    - - query - - - required - - - string - -

    -
    - -The Postgres tsquery string to filter with. - -
    - -
    • - - -
  • -

    - - __namedParameters - - - required - - - object - -

    -
    - -No description provided. - -
    - -
      -
      Properties
      - -
    • -

      - - config - - - required - - - undefined | string - -

      -
      - -The text search configuration to use. - -
      - -
      • - -
    - -
    • - -
\ No newline at end of file diff --git a/web/docs/client/range.mdx b/web/docs/client/range.mdx deleted file mode 100644 index b26261daa15..00000000000 --- a/web/docs/client/range.mdx +++ /dev/null @@ -1,178 +0,0 @@ ---- -id: range -title: "range()" -slug: range -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Limits the result to rows within the specified range, inclusive. - - - - - -```js -const { data, error } = await supabase - .from('cities') - .select('name, country_id') - .range(0,3) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -## Parameters - - -
    - -
  • -

    - - from - - - required - - - number - -

    -
    - -The starting index from which to limit the result, inclusive. - -
    - -
    • - - -
  • -

    - - to - - - required - - - number - -

    -
    - -The last index to which to limit the result, inclusive. - -
    - -
    • - - -
  • -

    - - __namedParameters - - - required - - - object - -

    -
    - -No description provided. - -
    - -
      -
      Properties
      - -
    • -

      - - foreignTable - - - required - - - undefined | string - -

      -
      - -The foreign table to use (for foreign columns). - -
      - -
      • - -
    - -
    • - -
- - - - - - - - - - - - - - -## Examples - -### With `select()` - - - - - - - -```js -const { data, error } = await supabase - .from('cities') - .select('name, country_id') - .range(0,3) -``` - - - - - -```py -# Not yet implemented -``` - - - - - \ No newline at end of file diff --git a/web/docs/client/removesubscription.mdx b/web/docs/client/removesubscription.mdx deleted file mode 100644 index 6055b7d4f09..00000000000 --- a/web/docs/client/removesubscription.mdx +++ /dev/null @@ -1,105 +0,0 @@ ---- -id: removesubscription -title: "removeSubscription()" -slug: removesubscription -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Removes an active subscription and returns the number of open connections. - - - - - -```js -supabase.removeSubscription(mySubscription) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -## Parameters - - -
    - -
  • -

    - - subscription - - - required - - - RealtimeSubscription - -

    -
    - -The subscription you want to remove. - -
    - -
    • - -
- - - - - - - - - - - - - - -## Examples - -### Remove a subscription - - - - - - - -```js -supabase.removeSubscription(mySubscription) -``` - - - - - -```py -# Not yet implemented -``` - - - - - \ No newline at end of file diff --git a/web/docs/client/reset-password-email.mdx b/web/docs/client/reset-password-email.mdx deleted file mode 100644 index 80cad31d8c7..00000000000 --- a/web/docs/client/reset-password-email.mdx +++ /dev/null @@ -1,119 +0,0 @@ ---- -id: reset-password-email -title: "Reset Password (Email)" -slug: reset-password-email -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Sends a reset request to an email address. - - - - - -```js -const { data, error } = supabase.auth.api.resetPasswordForEmail('user@email.com') -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -## Parameters - - -
    - -
  • -

    - - email - - - required - - - string - -

    -
    - -The email address of the user. - -
    - -
    • - -
- - -## Notes - -Sends a reset request to an email address. - -When the user clicks the reset link in the email they will be forwarded to: - -`#access_token=x&refresh_token=y&expires_in=z&token_type=bearer&type=recovery` - -Your app must detect `type=recovery` in the fragment and display a password reset form to the user. - -You should then use the access_token in the url and new password to update the user as follows: - -```js -const { error, data } = await auth.api - .updateUser(access_token, { password : new_password }) -``` - - - - - - - - - - -## Examples - -### Reset password - - - - - - - -```js -const { data, error } = supabase.auth.api.resetPasswordForEmail('user@email.com') -``` - - - - - -```py -# Not yet implemented -``` - - - - - \ No newline at end of file diff --git a/web/docs/client/rpc.mdx b/web/docs/client/rpc.mdx deleted file mode 100644 index b2892813d4e..00000000000 --- a/web/docs/client/rpc.mdx +++ /dev/null @@ -1,263 +0,0 @@ ---- -id: rpc -title: "Stored Procedures: rpc()" -slug: rpc -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -You can call stored procedures as a "Remote Procedure Call". - -That's a fancy way of saying that you can put some logic into your database then call it from anywhere. -It's especially useful when the logic rarely changes - like password resets and updates. - - - - - - -```js -const { data, error } = await supabase - .rpc('hello_world') -} -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -## Parameters - - -
    - -
  • -

    - - fn - - - required - - - string - -

    -
    - -The function name to call. - -
    - -
    • - - -
  • -

    - - params - - - optional - - - undefined | object - -

    -
    - -The parameters to pass to the function call. - -
    - -
    • - -
- - - - - - - - - - - - - - -## Examples - -### Call a stored procedure - -This is an example invoking a stored procedure. - - - - - -```js -const { data, error } = await supabase - .rpc('hello_world') -} -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With Parameters - - - - - - - -```js -const { data, error } = await supabase - .rpc('echo_city', { name: 'The Shire' }) -} -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### Bulk call - - - - - - - -```js -const { data, error } = await supabase - .rpc('echo_city', [ - { name: 'The Shire' }, - { name: 'Mordor' } - ]) -} -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With filters. - -Stored procedures that return tables can also be combined with -[Modifiers](/docs/client/using-modifiers) and -[Filters](/docs/client/using-filters). - - - - - - -```js -const { data, error } = await supabase - .rpc('echo_all_cities') - .eq('name', 'The Shire') -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With count option - -You can specify a count option to get the row count along with your data. -Allowed values for count option are `null`, `exact`, `planned` and `estimated`. - - - - - - -```js -const { data, error, count } = await postgrest - .from('cities') - .rpc('hello_world', { count: 'exact' }) -} -``` - - - - - -```py -# Not yet implemented -``` - - - - - \ No newline at end of file diff --git a/web/docs/client/select.mdx b/web/docs/client/select.mdx deleted file mode 100644 index 87e9632e763..00000000000 --- a/web/docs/client/select.mdx +++ /dev/null @@ -1,354 +0,0 @@ ---- -id: select -title: "Fetch data: select()" -slug: select -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Performs vertical filtering with SELECT. - - - - - -```js -const { data, error } = await supabase - .from('cities') - .select() -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -## Parameters - - -
    - -
  • -

    - - columns - - - required - - - string - -

    -
    - -The columns to retrieve, separated by commas. - -
    - -
    • - - -
  • -

    - - __namedParameters - - - required - - - object - -

    -
    - -No description provided. - -
    - -
      -
      Properties
      - -
    • -

      - - head - - - required - - - boolean - -

      -
      - -When set to true, select will void data. - -
      - -
      • - - -
    • -

      - - count - - - required - - - null | exact | planned | estimated - -

      -
      - -Count algorithm to use to count rows in a table. - -
      - -
      • - -
    - -
    • - -
- - -## Notes - -- `select()` can be combined with [Modifiers](/docs/client/using-modifiers) -- `select()` can be combined with [Filters](/docs/client/using-filters) - - - - - - - - - - -## Examples - -### Getting your data - - - - - - - -```js -const { data, error } = await supabase - .from('cities') - .select() -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### Selecting specific columns - -You can select specific fields from your tables. - - - - - -```js -const { data, error } = await supabase - .from('cities') - .select('name') -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### Query foreign tables - -If your database has relationships, you can query related tables too. - - - - - -```js -const { data, error } = await supabase - .from('countries') - .select(` - name, - cities ( - name - ) - `) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### Query the same foreign table multiple times - -Sometimes you will need to query the same foreign table twice. -In this case, you can use the name of the joined column to identify -which join you intend to use. For convenience, you can also give an -alias for each column. For example, if we had a shop of products, -and we wanted to get the supplier and the purchaser at the same time -(both in the users) table: - - - - - - -```js -const { data, error } = await supabase - .from('products') - .select(` - id, - supplier:supplier_id ( name ), - purchaser:purchaser_id ( name ) - `) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### Querying with count option - -You can get the number of rows by using the count option. -Allowed values for count option are `null`, `exact`, `planned` and `estimated`. - - - - - - -```js -const { data, error, count } = await postgrest - .from('cities') - .select('name', { count: 'exact' }) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### Quering JSON data - -If you have data inside of a JSONB column, you can apply select -and query filters to the data values. Postgres offers a -[number of operators](https://www.postgresql.org/docs/current/functions-json.html) -for querying JSON data. Also see -[PostgREST docs](http://postgrest.org/en/v7.0.0/api.html#json-columns) for more details. - - - - - - -```js -const { data, error } = await supabase - .from('users') - .select(` - id, name, - address->street - `) - .eq('address->postcode', 90210) -``` - - - - - -```py -# Not yet implemented -``` - - - - - \ No newline at end of file diff --git a/web/docs/client/single.mdx b/web/docs/client/single.mdx deleted file mode 100644 index 9d9495ea03d..00000000000 --- a/web/docs/client/single.mdx +++ /dev/null @@ -1,88 +0,0 @@ ---- -id: single -title: "single()" -slug: single -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Retrieves only one row from the result. Result must be one row (e.g. using -`limit`), otherwise this will result in an error. - - - - - -```js -const { data, error } = await supabase - .from('cities') - .select('name, country_id') - .single() -``` - - - - - -```py -# Not yet implemented -``` - - - - - - - - - - - - - - - - - - - - - - -## Examples - -### With `select()` - - - - - - - -```js -const { data, error } = await supabase - .from('cities') - .select('name, country_id') - .single() -``` - - - - - -```py -# Not yet implemented -``` - - - - - \ No newline at end of file diff --git a/web/docs/client/sl.mdx b/web/docs/client/sl.mdx deleted file mode 100644 index 509118b4ca6..00000000000 --- a/web/docs/client/sl.mdx +++ /dev/null @@ -1,226 +0,0 @@ ---- -id: sl -title: ".sl()" -slug: sl -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Finds all rows whose range value on the stated `column` is strictly to the -left of the specified `range`. - - - - - -```js -const { data, error } = await supabase - .from('countries') - .select('name, id, population_range_millions') - .sl('population_range_millions', [150, 250]) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -## Parameters - - -
    - -
  • -

    - - column - - - required - - - object - -

    -
    - -The column to filter on. - -
    - -
    • - - -
  • -

    - - range - - - required - - - string - -

    -
    - -The range to filter with. - -
    - -
    • - -
- - - - - - - - - - - - - - -## Examples - -### With `select()` - - - - - - - -```js -const { data, error } = await supabase - .from('countries') - .select('name, id, population_range_millions') - .sl('population_range_millions', [150, 250]) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `update()` - - - - - - - -```js -const { data, error } = await supabase - .from('countries') - .update({ name: 'Mordor' }) - .sl('population_range_millions', [150, 250]) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `delete()` - - - - - - - -```js -const { data, error } = await supabase - .from('countries') - .delete() - .sl('population_range_millions', [150, 250]) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `rpc()` - - - - - - - -```js -// Only valid if the Stored Procedure returns a table type. -const { data, error } = await supabase - .rpc('echo_all_countries') - .sl('population_range_millions', [150, 250]) -``` - - - - - -```py -# Not yet implemented -``` - - - - - \ No newline at end of file diff --git a/web/docs/client/sr.mdx b/web/docs/client/sr.mdx deleted file mode 100644 index c011fe77a94..00000000000 --- a/web/docs/client/sr.mdx +++ /dev/null @@ -1,226 +0,0 @@ ---- -id: sr -title: ".sr()" -slug: sr -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Finds all rows whose range value on the stated `column` is strictly to -the right of the specified `range`. - - - - - -```js -const { data, error } = await supabase - .from('countries') - .select('name, id, population_range_millions') - .sr('population_range_millions', [150, 250]) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -## Parameters - - -
    - -
  • -

    - - column - - - required - - - object - -

    -
    - -The column to filter on. - -
    - -
    • - - -
  • -

    - - range - - - required - - - string - -

    -
    - -The range to filter with. - -
    - -
    • - -
- - - - - - - - - - - - - - -## Examples - -### With `select()` - - - - - - - -```js -const { data, error } = await supabase - .from('countries') - .select('name, id, population_range_millions') - .sr('population_range_millions', [150, 250]) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `update()` - - - - - - - -```js -const { data, error } = await supabase - .from('countries') - .update({ name: 'Mordor' }) - .sr('population_range_millions', [150, 250]) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `delete()` - - - - - - - -```js -const { data, error } = await supabase - .from('countries') - .delete() - .sr('population_range_millions', [150, 250]) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `rpc()` - - - - - - - -```js -// Only valid if the Stored Procedure returns a table type. -const { data, error } = await supabase - .rpc('echo_all_countries') - .sr('population_range_millions', [150, 250]) -``` - - - - - -```py -# Not yet implemented -``` - - - - - \ No newline at end of file diff --git a/web/docs/client/subscribe.mdx b/web/docs/client/subscribe.mdx deleted file mode 100644 index 8f18f321842..00000000000 --- a/web/docs/client/subscribe.mdx +++ /dev/null @@ -1,344 +0,0 @@ ---- -id: subscribe -title: "on().subscribe()" -slug: subscribe -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Subscribe to realtime changes in your databse. - - - - - -```js -const mySubscription = supabase - .from('*') - .on('*', payload => { - console.log('Change received!', payload) - }) - .subscribe() -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -## Parameters - - -
    - -
  • -

    - - event - - - required - - - INSERT | UPDATE | DELETE | * - -

    -
    - -The database event which you would like to receive updates for, or you can use the special wildcard `*` to listen to all changes. - -
    - -
    • - - -
  • -

    - - callback - - - required - - - object - -

    -
    - -A callback that will handle the payload that is sent whenever your database changes. - -
    - -
    • - -
- - -## Notes - -- If you want to receive the "previous" data for updates and deletes, you will need to set `REPLICA IDENTITY` to `FULL`, like this: `ALTER TABLE your_table REPLICA IDENTITY FULL;` - - - - - - - - - - -## Examples - -### Listen to all database changes - - - - - - - -```js -const mySubscription = supabase - .from('*') - .on('*', payload => { - console.log('Change received!', payload) - }) - .subscribe() -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### Listening to a specific table - - - - - - - -```js -const mySubscription = supabase - .from('countries') - .on('*', payload => { - console.log('Change received!', payload) - }) - .subscribe() -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### Listening to inserts - - - - - - - -```js -const mySubscription = supabase - .from('countries') - .on('INSERT', payload => { - console.log('Change received!', payload) - }) - .subscribe() -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### Listening to updates - -By default Supabase will send only the updated record. If you want to receive the previous values as well you can -enable full replication for the table you are listening too: - -```sql -alter table "your_table" replica identity full; -``` - - - - - - -```js -const mySubscription = supabase - .from('countries') - .on('UPDATE', payload => { - console.log('Change received!', payload) - }) - .subscribe() -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### Listening to deletes - -By default Supabase not send deleted records. If you want to receive the deleted record you can -enable full replication for the table you are listening too: - -```sql -alter table "your_table" replica identity full; -``` - - - - - - -```js -const mySubscription = supabase - .from('countries') - .on('DELETE', payload => { - console.log('Change received!', payload) - }) - .subscribe() -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### Listening to multiple events - -You can chain listeners if you want to listen to multiple events for each table. - - - - - -```js -const mySubscription = supabase - .from('countries') - .on('INSERT', handleRecordInserted) - .on('DELETE', handleRecordDeleted) - .subscribe() -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### Listening to row level changes - -You can listen to individual rows using the format `{table}:{col}=eq.{val}` - where `{col}` is the column name, and `{val}` is the value which you want to match. - - - - - -```js -const mySubscription = supabase - .from('countries:id=eq.200') - .on('UPDATE', handleRecordUpdated) - .subscribe() -``` - - - - - -```py -# Not yet implemented -``` - - - - - \ No newline at end of file diff --git a/web/docs/client/update.mdx b/web/docs/client/update.mdx deleted file mode 100644 index 44b1bf55645..00000000000 --- a/web/docs/client/update.mdx +++ /dev/null @@ -1,219 +0,0 @@ ---- -id: update -title: "Modify data: update()" -slug: update -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Performs an UPDATE on the table. - - - - - -```js -const { data, error } = await supabase - .from('cities') - .update({ name: 'Middle Earth' }) - .match({ name: 'Auckland' }) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -## Parameters - - -
    - -
  • -

    - - values - - - required - - - Partial - -

    -
    - -The values to update. - -
    - -
    • - - -
  • -

    - - __namedParameters - - - required - - - object - -

    -
    - -No description provided. - -
    - -
      -
      Properties
      - -
    • -

      - - returning - - - required - - - minimal | representation - -

      -
      - -By default the updated record is returned. Set this to 'minimal' if you don't need this value. - -
      - -
      • - - -
    • -

      - - count - - - required - - - null | exact | planned | estimated - -

      -
      - -No description provided. - -
      - -
      • - -
    - -
    • - -
- - -## Notes - -- `update()` should always be combined with [Filters](/docs/client/using-filters) to target the item(s) you wish to update. - - - - - - - - - - -## Examples - -### Updating your data - - - - - - - -```js -const { data, error } = await supabase - .from('cities') - .update({ name: 'Middle Earth' }) - .match({ name: 'Auckland' }) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### Updating JSON data - -Postgres offers a -[number of operators](https://www.postgresql.org/docs/current/functions-json.html) -for working with JSON data. Right now it is only possible to update an entire JSON document, -but we are [working on ideas](https://github.com/PostgREST/postgrest/issues/465) for updating individual keys. - - - - - - -```js -const { data, error } = await supabase - .from('users') - .update(` - address: { - street: 'Melrose Place', - postcode: 90210 - } - `) - .eq('address->postcode', 90210) -``` - - - - - -```py -# Not yet implemented -``` - - - - - \ No newline at end of file diff --git a/web/docs/client/using-filters.mdx b/web/docs/client/using-filters.mdx deleted file mode 100644 index 0c5a9fed11f..00000000000 --- a/web/docs/client/using-filters.mdx +++ /dev/null @@ -1,13 +0,0 @@ ---- -id: using-filters -title: "Using Filters" -slug: using-filters -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Filters can be used on `select()`, `update()`, and `delete()` queries. - -If a Stored Procedure returns a table response, you can also apply filters. \ No newline at end of file diff --git a/web/docs/client/using-modifiers.mdx b/web/docs/client/using-modifiers.mdx deleted file mode 100644 index b3fd5411da8..00000000000 --- a/web/docs/client/using-modifiers.mdx +++ /dev/null @@ -1,13 +0,0 @@ ---- -id: using-modifiers -title: "Using Modifiers" -slug: using-modifiers -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Modifiers can be used on `select()` queries. - -If a Stored Procedure returns a table response, you can also apply modifiers to the `rpc()` function. \ No newline at end of file diff --git a/web/docs/client/wfts.mdx b/web/docs/client/wfts.mdx deleted file mode 100644 index 795d35414b4..00000000000 --- a/web/docs/client/wfts.mdx +++ /dev/null @@ -1,108 +0,0 @@ ---- -id: wfts -title: ".wfts()" -slug: wfts -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/supabase.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Finds all rows whose tsvector value on the stated `column` matches -websearch_to_tsquery(`query`). - - - -## Parameters - - -
    - -
  • -

    - - column - - - required - - - object - -

    -
    - -The column to filter on. - -
    - -
    • - - -
  • -

    - - query - - - required - - - string - -

    -
    - -The Postgres tsquery string to filter with. - -
    - -
    • - - -
  • -

    - - __namedParameters - - - required - - - object - -

    -
    - -No description provided. - -
    - -
      -
      Properties
      - -
    • -

      - - config - - - required - - - undefined | string - -

      -
      - -The text search configuration to use. - -
      - -
      • - -
    - -
    • - -
\ No newline at end of file diff --git a/web/docs/gotrue/client/.gitkeep b/web/docs/gotrue/client/.gitkeep new file mode 100644 index 00000000000..e69de29bb2d diff --git a/web/docs/gotrue/client/api-getuser.mdx b/web/docs/gotrue/client/api-getuser.mdx deleted file mode 100644 index e4b4686656e..00000000000 --- a/web/docs/gotrue/client/api-getuser.mdx +++ /dev/null @@ -1,85 +0,0 @@ ---- -id: api-getuser -title: "api.getUser" -slug: api-getuser -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/gotrue.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Gets the user details. - - - -## Parameters - - -
    - -
  • -

    - - jwt - - - required - - - string - -

    -
    - -A valid, logged-in JWT. - -
    - -
    • - -
- - - - - - - - - - - - - - -## Examples - -### Get the user details for a given user - - - - - - - -```js -const { error, data } = await auth.api - .getUser(access_token) - ``` - - - - - - -``` -Not yet implemented -``` - - - - - \ No newline at end of file diff --git a/web/docs/gotrue/client/api-inviteuserbyemail.mdx b/web/docs/gotrue/client/api-inviteuserbyemail.mdx deleted file mode 100644 index d57a5f20976..00000000000 --- a/web/docs/gotrue/client/api-inviteuserbyemail.mdx +++ /dev/null @@ -1,85 +0,0 @@ ---- -id: api-inviteuserbyemail -title: "api.inviteUserByEmail" -slug: api-inviteuserbyemail -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/gotrue.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Sends an invite link to an email address. - - - -## Parameters - - -
    - -
  • -

    - - email - - - required - - - string - -

    -
    - -The email address of the user. - -
    - -
    • - -
- - - - - - - - - - - - - - -## Examples - -### Send a user an invite link to sign up via email - - - - - - - -```js -const { error, data } = await auth.api - .inviteUserByEmail('example@email.com') - ``` - - - - - - -``` -Not yet implemented -``` - - - - - \ No newline at end of file diff --git a/web/docs/gotrue/client/api-refreshaccesstoken.mdx b/web/docs/gotrue/client/api-refreshaccesstoken.mdx deleted file mode 100644 index d1985a6672c..00000000000 --- a/web/docs/gotrue/client/api-refreshaccesstoken.mdx +++ /dev/null @@ -1,85 +0,0 @@ ---- -id: api-refreshaccesstoken -title: "api.refreshAccessToken" -slug: api-refreshaccesstoken -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/gotrue.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Generates a new JWT. - - - -## Parameters - - -
    - -
  • -

    - - refreshToken - - - required - - - string - -

    -
    - -A valid refresh token that was returned on login. - -
    - -
    • - -
- - - - - - - - - - - - - - -## Examples - -### Get a new access and refresh token using a valid refresh_token - - - - - - - -```js -const { error, data } = await auth.api - .refreshAccessToken(refresh_token) - ``` - - - - - - -``` -Not yet implemented -``` - - - - - \ No newline at end of file diff --git a/web/docs/gotrue/client/api-resetpasswordforemail.mdx b/web/docs/gotrue/client/api-resetpasswordforemail.mdx deleted file mode 100644 index 88152f334e6..00000000000 --- a/web/docs/gotrue/client/api-resetpasswordforemail.mdx +++ /dev/null @@ -1,99 +0,0 @@ ---- -id: api-resetpasswordforemail -title: "api.resetPasswordForEmail" -slug: api-resetpasswordforemail -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/gotrue.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Sends a reset request to an email address. - - - -## Parameters - - -
    - -
  • -

    - - email - - - required - - - string - -

    -
    - -The email address of the user. - -
    - -
    • - -
- - -## Notes - -Sends a reset request to an email address. - -When the user clicks the reset link in the email they will be forwarded to: - -`#access_token=x&refresh_token=y&expires_in=z&token_type=bearer&type=recovery` - -Your app must detect `type=recovery` in the fragment and display a password reset form to the user. - -You should then use the access_token in the url and new password to update the user as follows: - -```js -const { error, data } = await auth.api - .updateUser(access_token, { password : new_password }) -``` - - - - - - - - - - -## Examples - -### Send a user a password reset email - - - - - - - -```js -const { error, data } = await auth.api - .resetPasswordForEmail('example@email.com') - ``` - - - - - - -``` -Not yet implemented -``` - - - - - \ No newline at end of file diff --git a/web/docs/gotrue/client/api-sendmagiclinkemail.mdx b/web/docs/gotrue/client/api-sendmagiclinkemail.mdx deleted file mode 100644 index a831d58a465..00000000000 --- a/web/docs/gotrue/client/api-sendmagiclinkemail.mdx +++ /dev/null @@ -1,85 +0,0 @@ ---- -id: api-sendmagiclinkemail -title: "api.sendMagicLinkEmail" -slug: api-sendmagiclinkemail -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/gotrue.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Sends a magic login link to an email address. - - - -## Parameters - - -
    - -
  • -

    - - email - - - required - - - string - -

    -
    - -The email address of the user. - -
    - -
    • - -
- - - - - - - - - - - - - - -## Examples - -### Send user a passwordless login link via email - - - - - - - -```js -const { error, data } = await auth.api - .sendMagicLinkEmail('example@email.com') - ``` - - - - - - -``` -Not yet implemented -``` - - - - - \ No newline at end of file diff --git a/web/docs/gotrue/client/api-signinwithemail.mdx b/web/docs/gotrue/client/api-signinwithemail.mdx deleted file mode 100644 index 17e665d7930..00000000000 --- a/web/docs/gotrue/client/api-signinwithemail.mdx +++ /dev/null @@ -1,106 +0,0 @@ ---- -id: api-signinwithemail -title: "api.signInWithEmail" -slug: api-signinwithemail -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/gotrue.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Logs in an existing user using their email address. - - - -## Parameters - - -
    - -
  • -

    - - email - - - required - - - string - -

    -
    - -The email address of the user. - -
    - -
    • - - -
  • -

    - - password - - - required - - - string - -

    -
    - -The password of the user. - -
    - -
    • - -
- - - - - - - - - - - - - - -## Examples - -### Sign in a user with email - - - - - - - -```js -const { error, data } = await auth.api - .signInWithEmail('example@email.com', 'example-password') - ``` - - - - - - -``` -Not yet implemented -``` - - - - - \ No newline at end of file diff --git a/web/docs/gotrue/client/api-signout.mdx b/web/docs/gotrue/client/api-signout.mdx deleted file mode 100644 index dd56d6eb13e..00000000000 --- a/web/docs/gotrue/client/api-signout.mdx +++ /dev/null @@ -1,85 +0,0 @@ ---- -id: api-signout -title: "api.signOut" -slug: api-signout -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/gotrue.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Removes a logged-in session. - - - -## Parameters - - -
    - -
  • -

    - - jwt - - - required - - - string - -

    -
    - -A valid, logged-in JWT. - -
    - -
    • - -
- - - - - - - - - - - - - - -## Examples - -### Sign a user out - - - - - - - -```js -const { error, data } = await auth.api - .signOut(access_token) - ``` - - - - - - -``` -Not yet implemented -``` - - - - - \ No newline at end of file diff --git a/web/docs/gotrue/client/api-signupwithemail.mdx b/web/docs/gotrue/client/api-signupwithemail.mdx deleted file mode 100644 index 0244f30b025..00000000000 --- a/web/docs/gotrue/client/api-signupwithemail.mdx +++ /dev/null @@ -1,106 +0,0 @@ ---- -id: api-signupwithemail -title: "api.signUpWithEmail" -slug: api-signupwithemail -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/gotrue.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates a new user using their email address. - - - -## Parameters - - -
    - -
  • -

    - - email - - - required - - - string - -

    -
    - -The email address of the user. - -
    - -
    • - - -
  • -

    - - password - - - required - - - string - -

    -
    - -The password of the user. - -
    - -
    • - -
- - - - - - - - - - - - - - -## Examples - -### Sign up a new user with email - - - - - - - -```js -const { error, data } = await auth.api - .signUpWithEmail('example@email.com', 'example-password') -``` - - - - - - -``` -Not yet implemented -``` - - - - - \ No newline at end of file diff --git a/web/docs/gotrue/client/api-updateuser.mdx b/web/docs/gotrue/client/api-updateuser.mdx deleted file mode 100644 index 76dfc69590c..00000000000 --- a/web/docs/gotrue/client/api-updateuser.mdx +++ /dev/null @@ -1,106 +0,0 @@ ---- -id: api-updateuser -title: "api.updateUser" -slug: api-updateuser -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/gotrue.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Updates the user data. - - - -## Parameters - - -
    - -
  • -

    - - jwt - - - required - - - string - -

    -
    - -A valid, logged-in JWT. - -
    - -
    • - - -
  • -

    - - attributes - - - required - - - UserAttributes - -

    -
    - -The data you want to update. - -
    - -
    • - -
- - - - - - - - - - - - - - -## Examples - -### Update user info that Gotrue holds (also used for setting new passwords) - - - - - - - -```js -const { error, data } = await auth.api - .updateUser(access_token, { password : 'Why Shinji?' }) - ``` - - - - - - -``` -Not yet implemented -``` - - - - - \ No newline at end of file diff --git a/web/docs/gotrue/client/index.mdx b/web/docs/gotrue/client/index.mdx deleted file mode 100644 index 3bf784ce636..00000000000 --- a/web/docs/gotrue/client/index.mdx +++ /dev/null @@ -1,13 +0,0 @@ ---- -id: index -title: "GoTrue Client" -slug: gotrue-client -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/gotrue.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -GoTrue is an authentication server. - -Supabase provides client libraries to interact with the server \ No newline at end of file diff --git a/web/docs/gotrue/client/initializing.mdx b/web/docs/gotrue/client/initializing.mdx deleted file mode 100644 index ca47e85fa2a..00000000000 --- a/web/docs/gotrue/client/initializing.mdx +++ /dev/null @@ -1,276 +0,0 @@ ---- -id: initializing -title: "Initializing" -slug: initializing -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/gotrue.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Create a new client for use in the browser. - - - - - -```js -import { GoTrueClient } from '@supabase/gotrue-js' - -const auth = new GoTrueClient({ - url: "https://your-gotrue-url.com", - headers: { - apikey: - "", - Authorization: - "Bearer ", - }, -}) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -## Parameters - - -
    - -
  • -

    - - options - - - required - - - object - -

    -
    - -No description provided. - -
    - -
      -
      Properties
      - -
    • -

      - - autoRefreshToken - - - optional - - - undefined | false | true - -

      -
      - -Set to "true" if you want to automatically refresh the token before expiring. - -
      - -
      • - - -
    • -

      - - cookieOptions - - - optional - - - CookieOptions - -

      -
      - -No description provided. - -
      - -
      • - - -
    • -

      - - detectSessionInUrl - - - optional - - - undefined | false | true - -

      -
      - -Set to "true" if you want to automatically detects OAuth grants in the URL and signs in the user. - -
      - -
      • - - -
    • -

      - - headers - - - optional - - - undefined | reflection - -

      -
      - -Any additional headers to send to the GoTrue server. - -
      - -
      • - - -
    • -

      - - localStorage - - - optional - - - Storage - -

      -
      - -No description provided. - -
      - -
      • - - -
    • -

      - - persistSession - - - optional - - - undefined | false | true - -

      -
      - -Set to "true" if you want to automatically save the user session into local storage. - -
      - -
      • - - -
    • -

      - - url - - - optional - - - undefined | string - -

      -
      - -The URL of the GoTrue server. - -
      - -
      • - -
    - -
    • - -
- - - - - - - - - - - - - - -## Examples - -### Initialize a GoTrue client - - - - - - - -```js -import { GoTrueClient } from '@supabase/gotrue-js' - -const auth = new GoTrueClient({ - url: "https://your-gotrue-url.com", - headers: { - apikey: - "", - Authorization: - "Bearer ", - }, -}) -``` - - - - - -```py -# Not yet implemented -``` - - - - - \ No newline at end of file diff --git a/web/docs/gotrue/client/installing.mdx b/web/docs/gotrue/client/installing.mdx deleted file mode 100644 index 78ec85b00da..00000000000 --- a/web/docs/gotrue/client/installing.mdx +++ /dev/null @@ -1,25 +0,0 @@ ---- -id: installing -title: "Installing" -slug: installing -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/gotrue.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -All JavaScript libraries are built directly by the Supabase team. - -Other languages are built by the community and supported by Supabase. - -## JavaScript - -```bash -npm install @supabase/gotrue-js -``` - -## Python - -```bash -# Not yet implemented -``` \ No newline at end of file diff --git a/web/docs/gotrue/client/onauthstatechange.mdx b/web/docs/gotrue/client/onauthstatechange.mdx deleted file mode 100644 index 091f1c4855d..00000000000 --- a/web/docs/gotrue/client/onauthstatechange.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -id: onauthstatechange -title: "onAuthStateChange" -slug: onauthstatechange -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/gotrue.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; \ No newline at end of file diff --git a/web/docs/gotrue/client/session.mdx b/web/docs/gotrue/client/session.mdx deleted file mode 100644 index 66930bee8c1..00000000000 --- a/web/docs/gotrue/client/session.mdx +++ /dev/null @@ -1,60 +0,0 @@ ---- -id: session -title: "session" -slug: session -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/gotrue.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Returns the session data, if there is an active session. - - - - - - - - - - - - - - - - - - - -## Examples - -### Get user - - - - - - - -```js -const session = auth.session() -``` - - - - - - -``` -Not yet implemented -``` - - - - - \ No newline at end of file diff --git a/web/docs/gotrue/client/signin.mdx b/web/docs/gotrue/client/signin.mdx deleted file mode 100644 index cc8fbae067d..00000000000 --- a/web/docs/gotrue/client/signin.mdx +++ /dev/null @@ -1,190 +0,0 @@ ---- -id: signin -title: "signIn" -slug: signin -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/gotrue.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Log in an existing user, or login via a third-party provider. - - - - - -```js -// with email and password -const { user, error } = await auth.signIn({ - email: 'example@email.com', - password: 'example-password', -}) - -// send magic link (passwordless link) -const { user, error } = await auth.signIn({ - email: 'example@email.com', -}) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -## Parameters - - -
    - -
  • -

    - - credentials - - - required - - - object - -

    -
    - -The user login details. - -
    - -
      -
      Properties
      - -
    • -

      - - email - - - optional - - - undefined | string - -

      -
      - -The user's email address. - -
      - -
      • - - -
    • -

      - - password - - - optional - - - undefined | string - -

      -
      - -The user's password. - -
      - -
      • - - -
    • -

      - - provider - - - optional - - - Provider - -

      -
      - -One of the providers supported by GoTrue. - -
      - -
      • - -
    - -
    • - -
- - - - - - - - - - - - - - -## Examples - -### Sign in - - - - - - - -```js -// with email and password -const { user, error } = await auth.signIn({ - email: 'example@email.com', - password: 'example-password', -}) - -// send magic link (passwordless link) -const { user, error } = await auth.signIn({ - email: 'example@email.com', -}) -``` - - - - - -```py -# Not yet implemented -``` - - - - - \ No newline at end of file diff --git a/web/docs/gotrue/client/signout.mdx b/web/docs/gotrue/client/signout.mdx deleted file mode 100644 index 7fdef71a851..00000000000 --- a/web/docs/gotrue/client/signout.mdx +++ /dev/null @@ -1,60 +0,0 @@ ---- -id: signout -title: "signOut" -slug: signout -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/gotrue.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Signs out the current user, if there is a logged in user. - - - - - - - - - - - - - - - - - - - -## Examples - -### Sign out - - - - - - - -```js -const { error } = await auth.signOut() -``` - - - - - - -``` -Not yet implemented -``` - - - - - \ No newline at end of file diff --git a/web/docs/gotrue/client/signup.mdx b/web/docs/gotrue/client/signup.mdx deleted file mode 100644 index f09523a1f02..00000000000 --- a/web/docs/gotrue/client/signup.mdx +++ /dev/null @@ -1,135 +0,0 @@ ---- -id: signup -title: "signUp" -slug: signup -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/gotrue.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates a new user. - - - -## Parameters - - -
    - -
  • -

    - - credentials - - - required - - - object - -

    -
    - -The user login details. - -
    - -
      -
      Properties
      - -
    • -

      - - password - - - required - - - string - -

      -
      - -The user's password. - -
      - -
      • - - -
    • -

      - - email - - - required - - - string - -

      -
      - -The user's email address. - -
      - -
      • - -
    - -
    • - -
- - -## Notes - -- A user can sign up either via email or OAuth. -- If you provide `email`, `password` is also required -- If you provide `access_token`, `password` is also required - - - - - - - - - - -## Examples - -### Sign up - - - - - - - -```js -const { error, data } = await auth.signUp({ - email: 'example@email.com', - password: 'example-password', -}) -``` - - - - - -```py -# Not yet implemented -``` - - - - - \ No newline at end of file diff --git a/web/docs/gotrue/client/update.mdx b/web/docs/gotrue/client/update.mdx deleted file mode 100644 index 628ff5a9d82..00000000000 --- a/web/docs/gotrue/client/update.mdx +++ /dev/null @@ -1,109 +0,0 @@ ---- -id: update -title: "update" -slug: update -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/gotrue.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Updates user data, if there is a logged in user. - - - - - -```js -const { user, error } = await auth.update({ - data: { hello: 'world' } -}) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -## Parameters - - -
    - -
  • -

    - - attributes - - - required - - - UserAttributes - -

    -
    - -No description provided. - -
    - -
    • - -
- - - - - - - - - - - - - - -## Examples - -### Update a user's metadata. - - - - - - - -```js -const { user, error } = await auth.update({ - data: { hello: 'world' } -}) -``` - - - - - -```py -# Not yet implemented -``` - - - - - \ No newline at end of file diff --git a/web/docs/gotrue/client/user.mdx b/web/docs/gotrue/client/user.mdx deleted file mode 100644 index f8f9f7ad275..00000000000 --- a/web/docs/gotrue/client/user.mdx +++ /dev/null @@ -1,60 +0,0 @@ ---- -id: user -title: "user" -slug: user -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/gotrue.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Returns the user data, if there is a logged in user. - - - - - - - - - - - - - - - - - - - -## Examples - -### Get user - - - - - - - -```js -const user = auth.user() -``` - - - - - - -``` -Not yet implemented -``` - - - - - \ No newline at end of file diff --git a/web/docs/postgrest/client/.gitkeep b/web/docs/postgrest/client/.gitkeep new file mode 100644 index 00000000000..e69de29bb2d diff --git a/web/docs/postgrest/client/adj.mdx b/web/docs/postgrest/client/adj.mdx deleted file mode 100644 index 2b2872c0294..00000000000 --- a/web/docs/postgrest/client/adj.mdx +++ /dev/null @@ -1,226 +0,0 @@ ---- -id: adj -title: "adj" -slug: adj -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/postgrest.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Finds all rows whose range value on the stated `column` is adjacent to -the specified `range`. - - - - - -```js -const { data, error } = await postgrest - .from('countries') - .select('name, id, population_range_millions') - .adj('population_range_millions', [70, 185]) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -## Parameters - - -
    - -
  • -

    - - column - - - required - - - object - -

    -
    - -The column to filter on. - -
    - -
    • - - -
  • -

    - - range - - - required - - - string - -

    -
    - -The range to filter with. - -
    - -
    • - -
- - - - - - - - - - - - - - -## Examples - -### With `select()` - - - - - - - -```js -const { data, error } = await postgrest - .from('countries') - .select('name, id, population_range_millions') - .adj('population_range_millions', [70, 185]) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `update()` - - - - - - - -```js -const { data, error } = await postgrest - .from('countries') - .update({ name: 'Mordor' }) - .adj('population_range_millions', [70, 185]) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `delete()` - - - - - - - -```js -const { data, error } = await postgrest - .from('countries') - .delete() - .adj('population_range_millions', [70, 185]) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `rpc()` - - - - - - - -```js -// Only valid if the Stored Procedure returns a table type. -const { data, error } = await postgrest - .rpc('echo_all_countries') - .adj('population_range_millions', [70, 185]) -``` - - - - - -```py -# Not yet implemented -``` - - - - - \ No newline at end of file diff --git a/web/docs/postgrest/client/cd.mdx b/web/docs/postgrest/client/cd.mdx deleted file mode 100644 index 05b46ad53a4..00000000000 --- a/web/docs/postgrest/client/cd.mdx +++ /dev/null @@ -1,226 +0,0 @@ ---- -id: cd -title: "cd" -slug: cd -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/postgrest.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Finds all rows whose json, array, or range value on the stated `column` is -contained by the specified `value`. - - - - - -```js -const { data, error } = await postgrest - .from('countries') - .select('name, id, main_exports') - .cd('main_exports', ['cars', 'food', 'machine']) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -## Parameters - - -
    - -
  • -

    - - column - - - required - - - object - -

    -
    - -The column to filter on. - -
    - -
    • - - -
  • -

    - - value - - - required - - - string | array | object - -

    -
    - -The value to filter with. - -
    - -
    • - -
- - - - - - - - - - - - - - -## Examples - -### With `select()` - - - - - - - -```js -const { data, error } = await postgrest - .from('countries') - .select('name, id, main_exports') - .cd('main_exports', ['cars', 'food', 'machine']) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `update()` - - - - - - - -```js -const { data, error } = await postgrest - .from('countries') - .update({ name: 'Mordor' }) - .cd('main_exports', ['orks', 'surveillance', 'evil']) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `delete()` - - - - - - - -```js -const { data, error } = await postgrest - .from('countries') - .delete() - .cd('main_exports', ['cars', 'food', 'machine']) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `rpc()` - - - - - - - -```js -// Only valid if the Stored Procedure returns a table type. -const { data, error } = await postgrest - .rpc('echo_all_countries') - .cd('main_exports', ['cars', 'food', 'machine']) -``` - - - - - -```py -# Not yet implemented -``` - - - - - \ No newline at end of file diff --git a/web/docs/postgrest/client/cs.mdx b/web/docs/postgrest/client/cs.mdx deleted file mode 100644 index 7d15bc69164..00000000000 --- a/web/docs/postgrest/client/cs.mdx +++ /dev/null @@ -1,226 +0,0 @@ ---- -id: cs -title: "cs" -slug: cs -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/postgrest.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Finds all rows whose json, array, or range value on the stated `column` -contains the values specified in `value`. - - - - - -```js -const { data, error } = await postgrest - .from('countries') - .select('name, id, main_exports') - .cs('main_exports', ['oil']) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -## Parameters - - -
    - -
  • -

    - - column - - - required - - - object - -

    -
    - -The column to filter on. - -
    - -
    • - - -
  • -

    - - value - - - required - - - string | array | object - -

    -
    - -The value to filter with. - -
    - -
    • - -
- - - - - - - - - - - - - - -## Examples - -### With `select()` - - - - - - - -```js -const { data, error } = await postgrest - .from('countries') - .select('name, id, main_exports') - .cs('main_exports', ['oil']) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `update()` - - - - - - - -```js -const { data, error } = await postgrest - .from('countries') - .update({ name: 'Mordor' }) - .cs('main_exports', ['oil']) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `delete()` - - - - - - - -```js -const { data, error } = await postgrest - .from('countries') - .delete() - .cs('main_exports', ['oil']) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `rpc()` - - - - - - - -```js -// Only valid if the Stored Procedure returns a table type. -const { data, error } = await postgrest - .rpc('echo_all_countries') - .cs('main_exports', ['oil']) -``` - - - - - -```py -# Not yet implemented -``` - - - - - \ No newline at end of file diff --git a/web/docs/postgrest/client/delete.mdx b/web/docs/postgrest/client/delete.mdx deleted file mode 100644 index 6db4a9f9dc6..00000000000 --- a/web/docs/postgrest/client/delete.mdx +++ /dev/null @@ -1,157 +0,0 @@ ---- -id: delete -title: "delete" -slug: delete -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/postgrest.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Performs a DELETE on the table. - - - - - -```js -const { data, error } = await postgrest - .from('cities') - .delete() - .match({ id: 666 }) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -## Parameters - - -
    - -
  • -

    - - __namedParameters - - - required - - - object - -

    -
    - -No description provided. - -
    - -
      -
      Properties
      - -
    • -

      - - returning - - - required - - - minimal | representation - -

      -
      - -If `true`, return the deleted row(s) in the response. - -
      - -
      • - - -
    • -

      - - count - - - required - - - null | exact | planned | estimated - -

      -
      - -No description provided. - -
      - -
      • - -
    - -
    • - -
- - - - - - - - - - - - - - -## Examples - -### Delete records - - - - - - - -```js -const { data, error } = await postgrest - .from('cities') - .delete() - .match({ id: 666 }) -``` - - - - - -```py -# Not yet implemented -``` - - - - - \ No newline at end of file diff --git a/web/docs/postgrest/client/eq.mdx b/web/docs/postgrest/client/eq.mdx deleted file mode 100644 index fcba439531a..00000000000 --- a/web/docs/postgrest/client/eq.mdx +++ /dev/null @@ -1,226 +0,0 @@ ---- -id: eq -title: "eq" -slug: eq -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/postgrest.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Finds all rows whose value on the stated `column` exactly matches the -specified `value`. - - - - - -```js -const { data, error } = await postgrest - .from('cities') - .select('name, country_id') - .eq('name', 'The shire') -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -## Parameters - - -
    - -
  • -

    - - column - - - required - - - object - -

    -
    - -The column to filter on. - -
    - -
    • - - -
  • -

    - - value - - - required - - - object - -

    -
    - -The value to filter with. - -
    - -
    • - -
- - - - - - - - - - - - - - -## Examples - -### With `select()` - - - - - - - -```js -const { data, error } = await postgrest - .from('cities') - .select('name, country_id') - .eq('name', 'The shire') -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `update()` - - - - - - - -```js -const { data, error } = await postgrest - .from('cities') - .update({ name: 'Mordor' }) - .eq('name', 'San Francisco') -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `delete()` - - - - - - - -```js -const { data, error } = await postgrest - .from('cities') - .delete() - .eq('name', 'Mordor') -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `rpc()` - - - - - - - -```js -// Only valid if the Stored Procedure returns a table type. -const { data, error } = await postgrest - .rpc('echo_all_cities') - .eq('name', 'San Francisco') -``` - - - - - -```py -# Not yet implemented -``` - - - - - \ No newline at end of file diff --git a/web/docs/postgrest/client/filter.mdx b/web/docs/postgrest/client/filter.mdx deleted file mode 100644 index 18c8b3459c5..00000000000 --- a/web/docs/postgrest/client/filter.mdx +++ /dev/null @@ -1,277 +0,0 @@ ---- -id: filter -title: "filter" -slug: filter -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/postgrest.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Finds all rows whose `column` satisfies the filter. - - - - - -```js -const { data, error } = await postgrest - .from('cities') - .select('name, country_id') - .filter('name', 'eq', 'Paris') -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -## Parameters - - -
    - -
  • -

    - - column - - - required - - - object - -

    -
    - -The column to filter on. - -
    - -
    • - - -
  • -

    - - operator - - - required - - - FilterOperator - -

    -
    - -The operator to filter with. - -
    - -
    • - - -
  • -

    - - value - - - required - - - any - -

    -
    - -The value to filter with. - -
    - -
    • - -
- - - - - - - - - - - - - - -## Examples - -### With `select()` - - - - - - - -```js -const { data, error } = await postgrest - .from('cities') - .select('name, country_id') - .filter('name', 'eq', 'Paris') -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `update()` - - - - - - - -```js -const { data, error } = await postgrest - .from('cities') - .update({ name: 'Mordor' }) - .filter('name', 'eq', 'Paris') -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `delete()` - - - - - - - -```js -const { data, error } = await postgrest - .from('cities') - .delete() - .filter('name', 'eq', 'Paris') -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `rpc()` - - - - - - - -```js -// Only valid if the Stored Procedure returns a table type. -const { data, error } = await postgrest - .rpc('echo_all_cities') - .filter('name', 'eq', 'Paris') -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### Filter embedded resources - - - - - - - -```js -const { data, error } = await postgrest - .from('cities') - .select('name, countries ( name )') - .filter('countries.name', 'eq', 'France') -``` - - - - - -```py -# Not yet implemented -``` - - - - - \ No newline at end of file diff --git a/web/docs/postgrest/client/from.mdx b/web/docs/postgrest/client/from.mdx deleted file mode 100644 index 752cbff0a39..00000000000 --- a/web/docs/postgrest/client/from.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -id: from -title: "from" -slug: from -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/postgrest.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Perform a table operation. - - - -## Parameters - - -
    - -
  • -

    - - table - - - required - - - string - -

    -
    - -The table name to operate on. - -
    - -
    • - -
\ No newline at end of file diff --git a/web/docs/postgrest/client/fts.mdx b/web/docs/postgrest/client/fts.mdx deleted file mode 100644 index 9407418253f..00000000000 --- a/web/docs/postgrest/client/fts.mdx +++ /dev/null @@ -1,108 +0,0 @@ ---- -id: fts -title: "fts" -slug: fts -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/postgrest.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Finds all rows whose tsvector value on the stated `column` matches -to_tsquery(`query`). - - - -## Parameters - - -
    - -
  • -

    - - column - - - required - - - object - -

    -
    - -The column to filter on. - -
    - -
    • - - -
  • -

    - - query - - - required - - - string - -

    -
    - -The Postgres tsquery string to filter with. - -
    - -
    • - - -
  • -

    - - __namedParameters - - - required - - - object - -

    -
    - -No description provided. - -
    - -
      -
      Properties
      - -
    • -

      - - config - - - required - - - undefined | string - -

      -
      - -The text search configuration to use. - -
      - -
      • - -
    - -
    • - -
\ No newline at end of file diff --git a/web/docs/postgrest/client/gt.mdx b/web/docs/postgrest/client/gt.mdx deleted file mode 100644 index 2f3b4416631..00000000000 --- a/web/docs/postgrest/client/gt.mdx +++ /dev/null @@ -1,226 +0,0 @@ ---- -id: gt -title: "gt" -slug: gt -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/postgrest.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Finds all rows whose value on the stated `column` is greater than the -specified `value`. - - - - - -```js -const { data, error } = await postgrest - .from('cities') - .select('name, country_id') - .gt('country_id', 250) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -## Parameters - - -
    - -
  • -

    - - column - - - required - - - object - -

    -
    - -The column to filter on. - -
    - -
    • - - -
  • -

    - - value - - - required - - - object - -

    -
    - -The value to filter with. - -
    - -
    • - -
- - - - - - - - - - - - - - -## Examples - -### With `select()` - - - - - - - -```js -const { data, error } = await postgrest - .from('cities') - .select('name, country_id') - .gt('country_id', 250) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `update()` - - - - - - - -```js -const { data, error } = await postgrest - .from('cities') - .update({ name: 'Mordor' }) - .gt('country_id', 250) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `delete()` - - - - - - - -```js -const { data, error } = await postgrest - .from('cities') - .delete() - .gt('country_id', 250) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `rpc()` - - - - - - - -```js -// Only valid if the Stored Procedure returns a table type. -const { data, error } = await postgrest - .rpc('echo_all_cities') - .gt('country_id', 250) -``` - - - - - -```py -# Not yet implemented -``` - - - - - \ No newline at end of file diff --git a/web/docs/postgrest/client/gte.mdx b/web/docs/postgrest/client/gte.mdx deleted file mode 100644 index 6b95a0f147c..00000000000 --- a/web/docs/postgrest/client/gte.mdx +++ /dev/null @@ -1,226 +0,0 @@ ---- -id: gte -title: "gte" -slug: gte -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/postgrest.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Finds all rows whose value on the stated `column` is greater than or -equal to the specified `value`. - - - - - -```js -const { data, error } = await postgrest - .from('cities') - .select('name, country_id') - .gte('country_id', 250) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -## Parameters - - -
    - -
  • -

    - - column - - - required - - - object - -

    -
    - -The column to filter on. - -
    - -
    • - - -
  • -

    - - value - - - required - - - object - -

    -
    - -The value to filter with. - -
    - -
    • - -
- - - - - - - - - - - - - - -## Examples - -### With `select()` - - - - - - - -```js -const { data, error } = await postgrest - .from('cities') - .select('name, country_id') - .gte('country_id', 250) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `update()` - - - - - - - -```js -const { data, error } = await postgrest - .from('cities') - .update({ name: 'Mordor' }) - .gte('country_id', 250) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `delete()` - - - - - - - -```js -const { data, error } = await postgrest - .from('cities') - .delete() - .gte('country_id', 250) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `rpc()` - - - - - - - -```js -// Only valid if the Stored Procedure returns a table type. -const { data, error } = await postgrest - .rpc('echo_all_cities') - .gte('country_id', 250) -``` - - - - - -```py -# Not yet implemented -``` - - - - - \ No newline at end of file diff --git a/web/docs/postgrest/client/ilike.mdx b/web/docs/postgrest/client/ilike.mdx deleted file mode 100644 index 35d8d15a616..00000000000 --- a/web/docs/postgrest/client/ilike.mdx +++ /dev/null @@ -1,226 +0,0 @@ ---- -id: ilike -title: "ilike" -slug: ilike -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/postgrest.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Finds all rows whose value in the stated `column` matches the supplied -`pattern` (case insensitive). - - - - - -```js -const { data, error } = await postgrest - .from('cities') - .select('name, country_id') - .ilike('name', '%la%') -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -## Parameters - - -
    - -
  • -

    - - column - - - required - - - object - -

    -
    - -The column to filter on. - -
    - -
    • - - -
  • -

    - - pattern - - - required - - - string - -

    -
    - -The pattern to filter with. - -
    - -
    • - -
- - - - - - - - - - - - - - -## Examples - -### With `select()` - - - - - - - -```js -const { data, error } = await postgrest - .from('cities') - .select('name, country_id') - .ilike('name', '%la%') -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `update()` - - - - - - - -```js -const { data, error } = await postgrest - .from('cities') - .update({ name: 'Mordor' }) - .ilike('name', '%la%') -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `delete()` - - - - - - - -```js -const { data, error } = await postgrest - .from('cities') - .delete() - .ilike('name', '%la%') -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `rpc()` - - - - - - - -```js -// Only valid if the Stored Procedure returns a table type. -const { data, error } = await postgrest - .rpc('echo_all_cities') - .ilike('name', '%la%') -``` - - - - - -```py -# Not yet implemented -``` - - - - - \ No newline at end of file diff --git a/web/docs/postgrest/client/in.mdx b/web/docs/postgrest/client/in.mdx deleted file mode 100644 index 6290fda018e..00000000000 --- a/web/docs/postgrest/client/in.mdx +++ /dev/null @@ -1,226 +0,0 @@ ---- -id: in -title: "in" -slug: in -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/postgrest.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Finds all rows whose value on the stated `column` is found on the -specified `values`. - - - - - -```js -const { data, error } = await postgrest - .from('cities') - .select('name, country_id') - .in('name', ['Rio de Janeiro', 'San Francisco']) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -## Parameters - - -
    - -
  • -

    - - column - - - required - - - object - -

    -
    - -The column to filter on. - -
    - -
    • - - -
  • -

    - - values - - - required - - - object - -

    -
    - -The values to filter with. - -
    - -
    • - -
- - - - - - - - - - - - - - -## Examples - -### With `select()` - - - - - - - -```js -const { data, error } = await postgrest - .from('cities') - .select('name, country_id') - .in('name', ['Rio de Janeiro', 'San Francisco']) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `update()` - - - - - - - -```js -const { data, error } = await postgrest - .from('cities') - .update({ name: 'Mordor' }) - .in('name', ['Rio de Janeiro', 'San Francisco']) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `delete()` - - - - - - - -```js -const { data, error } = await postgrest - .from('cities') - .delete() - .in('name', ['Rio de Janeiro', 'San Francisco']) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `rpc()` - - - - - - - -```js -// Only valid if the Stored Procedure returns a table type. -const { data, error } = await postgrest - .rpc('echo_all_cities') - .in('name', ['Rio de Janeiro', 'San Francisco']) -``` - - - - - -```py -# Not yet implemented -``` - - - - - \ No newline at end of file diff --git a/web/docs/postgrest/client/index.mdx b/web/docs/postgrest/client/index.mdx deleted file mode 100644 index 45666cab351..00000000000 --- a/web/docs/postgrest/client/index.mdx +++ /dev/null @@ -1,13 +0,0 @@ ---- -id: index -title: "PostgREST Client" -slug: postgrest-client -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/postgrest.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -PostgREST is a standalone web server that turns your PostgreSQL database directly into a RESTful API. - -Supabase provides client libraries to interact with the PostgREST. \ No newline at end of file diff --git a/web/docs/postgrest/client/initializing.mdx b/web/docs/postgrest/client/initializing.mdx deleted file mode 100644 index 9bf3fa6d31b..00000000000 --- a/web/docs/postgrest/client/initializing.mdx +++ /dev/null @@ -1,107 +0,0 @@ ---- -id: initializing -title: "Initializing" -slug: initializing -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/postgrest.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates a PostgREST client. - - - -## Parameters - - -
    - -
  • -

    - - url - - - required - - - string - -

    -
    - -URL of the PostgREST endpoint. - -
    - -
    • - - -
  • -

    - - __namedParameters - - - required - - - object - -

    -
    - -No description provided. - -
    - -
      -
      Properties
      - -
    • -

      - - schema - - - required - - - undefined | string - -

      -
      - -Postgres schema to switch to. - -
      - -
      • - - -
    • -

      - - headers - - - required - - - object - -

      -
      - -Custom headers. - -
      - -
      • - -
    - -
    • - -
\ No newline at end of file diff --git a/web/docs/postgrest/client/insert.mdx b/web/docs/postgrest/client/insert.mdx deleted file mode 100644 index 6c122aaf4e2..00000000000 --- a/web/docs/postgrest/client/insert.mdx +++ /dev/null @@ -1,296 +0,0 @@ ---- -id: insert -title: "insert" -slug: insert -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/postgrest.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Performs an INSERT into the table. - - - - - -```js -const { data, error } = await postgrest - .from('cities') - .insert([ - { name: 'The Shire', country_id: 554 } - ]) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -## Parameters - - -
    - -
  • -

    - - values - - - required - - - Partial | array - -

    -
    - -The values to insert. - -
    - -
    • - - -
  • -

    - - __namedParameters - - - required - - - object - -

    -
    - -No description provided. - -
    - -
      -
      Properties
      - -
    • -

      - - upsert - - - required - - - boolean - -

      -
      - -If `true`, performs an UPSERT. - -
      - -
      • - - -
    • -

      - - returning - - - required - - - minimal | representation - -

      -
      - -By default the new record is returned. Set this to 'minimal' if you don't need this value. - -
      - -
      • - - -
    • -

      - - onConflict - - - required - - - undefined | string - -

      -
      - -By specifying the `on_conflict` query parameter, you can make UPSERT work on a column(s) that has a UNIQUE constraint. - -
      - -
      • - - -
    • -

      - - count - - - required - - - null | exact | planned | estimated - -

      -
      - -No description provided. - -
      - -
      • - -
    - -
    • - -
- - - - - - - - - - - - - - -## Examples - -### Create a record - - - - - - - -```js -const { data, error } = await postgrest - .from('cities') - .insert([ - { name: 'The Shire', country_id: 554 } - ]) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### Bulk create - - - - - - - -```js -const { data, error } = await postgrest - .from('cities') - .insert([ - { name: 'The Shire', country_id: 554 }, - { name: 'Rohan', country_id: 555 }, - ]) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### Upsert - -For upsert, if set to true, primary key columns would need to be included -in the data parameter in order for an update to properly happen. Also, primary keys -used must be natural, not surrogate. There are however, -[workarounds](https://github.com/PostgREST/postgrest/issues/1118) -for surrogate primary keys. - - - - - - -```js -const { data, error } = await postgrest - .from('cities') - .insert( - [ - { name: 'The Shire', country_id: 554 }, - { name: 'Rohan', country_id: 555 }, - { name: 'City by the Bay', country_id:840} - ], - { upsert: true }) -``` - - - - - -```py -# Not yet implemented -``` - - - - - \ No newline at end of file diff --git a/web/docs/postgrest/client/installing.mdx b/web/docs/postgrest/client/installing.mdx deleted file mode 100644 index c9603950d73..00000000000 --- a/web/docs/postgrest/client/installing.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -id: installing -title: "Installing" -slug: installing -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/postgrest.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -All JavaScript libraries are built directly by the Supabase team. - -Other languages are built by the community and supported by Supabase. - -## JavaScript - -```bash -npm install @supabase/postgrest-js -``` - -- [Source code](https://github.com/supabase/postgrest-js) - -## Python - -```bash -# Not yet implemented \ No newline at end of file diff --git a/web/docs/postgrest/client/is.mdx b/web/docs/postgrest/client/is.mdx deleted file mode 100644 index afb2170ca59..00000000000 --- a/web/docs/postgrest/client/is.mdx +++ /dev/null @@ -1,226 +0,0 @@ ---- -id: is -title: "is" -slug: is -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/postgrest.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -A check for exact equality (null, true, false), finds all rows whose -value on the stated `column` exactly match the specified `value`. - - - - - -```js -const { data, error } = await postgrest - .from('cities') - .select('name, country_id') - .is('name', null) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -## Parameters - - -
    - -
  • -

    - - column - - - required - - - object - -

    -
    - -The column to filter on. - -
    - -
    • - - -
  • -

    - - value - - - required - - - boolean | null - -

    -
    - -The value to filter with. - -
    - -
    • - -
- - - - - - - - - - - - - - -## Examples - -### With `select()` - - - - - - - -```js -const { data, error } = await postgrest - .from('cities') - .select('name, country_id') - .is('name', null) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `update()` - - - - - - - -```js -const { data, error } = await postgrest - .from('cities') - .update({ name: 'Mordor' }) - .is('name', null) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `delete()` - - - - - - - -```js -const { data, error } = await postgrest - .from('cities') - .delete() - .is('name', null) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `rpc()` - - - - - - - -```js -// Only valid if the Stored Procedure returns a table type. -const { data, error } = await postgrest - .rpc('echo_all_cities') - .is('name', null) -``` - - - - - -```py -# Not yet implemented -``` - - - - - \ No newline at end of file diff --git a/web/docs/postgrest/client/like.mdx b/web/docs/postgrest/client/like.mdx deleted file mode 100644 index ef8cb89ec41..00000000000 --- a/web/docs/postgrest/client/like.mdx +++ /dev/null @@ -1,226 +0,0 @@ ---- -id: like -title: "like" -slug: like -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/postgrest.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Finds all rows whose value in the stated `column` matches the supplied -`pattern` (case sensitive). - - - - - -```js -const { data, error } = await postgrest - .from('cities') - .select('name, country_id') - .like('name', '%la%') -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -## Parameters - - -
    - -
  • -

    - - column - - - required - - - object - -

    -
    - -The column to filter on. - -
    - -
    • - - -
  • -

    - - pattern - - - required - - - string - -

    -
    - -The pattern to filter with. - -
    - -
    • - -
- - - - - - - - - - - - - - -## Examples - -### With `select()` - - - - - - - -```js -const { data, error } = await postgrest - .from('cities') - .select('name, country_id') - .like('name', '%la%') -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `update()` - - - - - - - -```js -const { data, error } = await postgrest - .from('cities') - .update({ name: 'Mordor' }) - .like('name', '%la%') -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `delete()` - - - - - - - -```js -const { data, error } = await postgrest - .from('cities') - .delete() - .like('name', '%la%') -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `rpc()` - - - - - - - -```js -// Only valid if the Stored Procedure returns a table type. -const { data, error } = await postgrest - .rpc('echo_all_cities') - .like('name', '%la%') -``` - - - - - -```py -# Not yet implemented -``` - - - - - \ No newline at end of file diff --git a/web/docs/postgrest/client/lt.mdx b/web/docs/postgrest/client/lt.mdx deleted file mode 100644 index bf65c8a2f85..00000000000 --- a/web/docs/postgrest/client/lt.mdx +++ /dev/null @@ -1,226 +0,0 @@ ---- -id: lt -title: "lt" -slug: lt -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/postgrest.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Finds all rows whose value on the stated `column` is less than the -specified `value`. - - - - - -```js -const { data, error } = await postgrest - .from('cities') - .select('name, country_id') - .lt('country_id', 250) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -## Parameters - - -
    - -
  • -

    - - column - - - required - - - object - -

    -
    - -The column to filter on. - -
    - -
    • - - -
  • -

    - - value - - - required - - - object - -

    -
    - -The value to filter with. - -
    - -
    • - -
- - - - - - - - - - - - - - -## Examples - -### With `select()` - - - - - - - -```js -const { data, error } = await postgrest - .from('cities') - .select('name, country_id') - .lt('country_id', 250) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `update()` - - - - - - - -```js -const { data, error } = await postgrest - .from('cities') - .update({ name: 'Mordor' }) - .lt('country_id', 250) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `delete()` - - - - - - - -```js -const { data, error } = await postgrest - .from('cities') - .delete() - .lt('country_id', 250) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `rpc()` - - - - - - - -```js -// Only valid if the Stored Procedure returns a table type. -const { data, error } = await postgrest - .rpc('echo_all_cities') - .lt('country_id', 250) -``` - - - - - -```py -# Not yet implemented -``` - - - - - \ No newline at end of file diff --git a/web/docs/postgrest/client/lte.mdx b/web/docs/postgrest/client/lte.mdx deleted file mode 100644 index e151b1e63bb..00000000000 --- a/web/docs/postgrest/client/lte.mdx +++ /dev/null @@ -1,226 +0,0 @@ ---- -id: lte -title: "lte" -slug: lte -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/postgrest.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Finds all rows whose value on the stated `column` is less than or equal -to the specified `value`. - - - - - -```js -const { data, error } = await postgrest - .from('cities') - .select('name, country_id') - .lte('country_id', 250) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -## Parameters - - -
    - -
  • -

    - - column - - - required - - - object - -

    -
    - -The column to filter on. - -
    - -
    • - - -
  • -

    - - value - - - required - - - object - -

    -
    - -The value to filter with. - -
    - -
    • - -
- - - - - - - - - - - - - - -## Examples - -### With `select()` - - - - - - - -```js -const { data, error } = await postgrest - .from('cities') - .select('name, country_id') - .lte('country_id', 250) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `update()` - - - - - - - -```js -const { data, error } = await postgrest - .from('cities') - .update({ name: 'Mordor' }) - .lte('country_id', 250) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `delete()` - - - - - - - -```js -const { data, error } = await postgrest - .from('cities') - .delete() - .lte('country_id', 250) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `rpc()` - - - - - - - -```js -// Only valid if the Stored Procedure returns a table type. -const { data, error } = await postgrest - .rpc('echo_all_cities') - .lte('country_id', 250) -``` - - - - - -```py -# Not yet implemented -``` - - - - - \ No newline at end of file diff --git a/web/docs/postgrest/client/neq.mdx b/web/docs/postgrest/client/neq.mdx deleted file mode 100644 index 4aef70c4575..00000000000 --- a/web/docs/postgrest/client/neq.mdx +++ /dev/null @@ -1,226 +0,0 @@ ---- -id: neq -title: "neq" -slug: neq -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/postgrest.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Finds all rows whose value on the stated `column` doesn't match the -specified `value`. - - - - - -```js -const { data, error } = await postgrest - .from('cities') - .select('name, country_id') - .neq('name', 'The shire') -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -## Parameters - - -
    - -
  • -

    - - column - - - required - - - object - -

    -
    - -The column to filter on. - -
    - -
    • - - -
  • -

    - - value - - - required - - - object - -

    -
    - -The value to filter with. - -
    - -
    • - -
- - - - - - - - - - - - - - -## Examples - -### With `select()` - - - - - - - -```js -const { data, error } = await postgrest - .from('cities') - .select('name, country_id') - .neq('name', 'The shire') -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `update()` - - - - - - - -```js -const { data, error } = await postgrest - .from('cities') - .update({ name: 'Mordor' }) - .neq('name', 'San Francisco') -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `delete()` - - - - - - - -```js -const { data, error } = await postgrest - .from('cities') - .delete() - .neq('name', 'Mordor') -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `rpc()` - - - - - - - -```js -// Only valid if the Stored Procedure returns a table type. -const { data, error } = await postgrest - .rpc('echo_all_cities') - .neq('name', 'Lagos') -``` - - - - - -```py -# Not yet implemented -``` - - - - - \ No newline at end of file diff --git a/web/docs/postgrest/client/not.mdx b/web/docs/postgrest/client/not.mdx deleted file mode 100644 index 4823e6e38e8..00000000000 --- a/web/docs/postgrest/client/not.mdx +++ /dev/null @@ -1,246 +0,0 @@ ---- -id: not -title: "not" -slug: not -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/postgrest.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Finds all rows which doesn't satisfy the filter. - - - - - -```js -const { data, error } = await postgrest - .from('cities') - .select('name, country_id') - .not('name', 'eq', 'Paris') -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -## Parameters - - -
    - -
  • -

    - - column - - - required - - - object - -

    -
    - -The column to filter on. - -
    - -
    • - - -
  • -

    - - operator - - - required - - - FilterOperator - -

    -
    - -The operator to filter with. - -
    - -
    • - - -
  • -

    - - value - - - required - - - any - -

    -
    - -The value to filter with. - -
    - -
    • - -
- - - - - - - - - - - - - - -## Examples - -### With `select()` - - - - - - - -```js -const { data, error } = await postgrest - .from('cities') - .select('name, country_id') - .not('name', 'eq', 'Paris') -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `update()` - - - - - - - -```js -const { data, error } = await postgrest - .from('cities') - .update({ name: 'Mordor' }) - .not('name', 'eq', 'Paris') -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `delete()` - - - - - - - -```js -const { data, error } = await postgrest - .from('cities') - .delete() - .not('name', 'eq', 'Paris') -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `rpc()` - - - - - - - -```js -// Only valid if the Stored Procedure returns a table type. -const { data, error } = await postgrest - .rpc('echo_all_cities) - .not('name', 'eq', 'Paris') -``` - - - - - -```py -# Not yet implemented -``` - - - - - \ No newline at end of file diff --git a/web/docs/postgrest/client/nxl.mdx b/web/docs/postgrest/client/nxl.mdx deleted file mode 100644 index 08650d9abdf..00000000000 --- a/web/docs/postgrest/client/nxl.mdx +++ /dev/null @@ -1,226 +0,0 @@ ---- -id: nxl -title: "nxl" -slug: nxl -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/postgrest.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Finds all rows whose range value on the stated `column` does not extend -to the left of the specified `range`. - - - - - -```js -const { data, error } = await postgrest - .from('countries') - .select('name, id, population_range_millions') - .nxl('population_range_millions', [150, 250]) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -## Parameters - - -
    - -
  • -

    - - column - - - required - - - object - -

    -
    - -The column to filter on. - -
    - -
    • - - -
  • -

    - - range - - - required - - - string - -

    -
    - -The range to filter with. - -
    - -
    • - -
- - - - - - - - - - - - - - -## Examples - -### With `select()` - - - - - - - -```js -const { data, error } = await postgrest - .from('countries') - .select('name, id, population_range_millions') - .nxl('population_range_millions', [150, 250]) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `update()` - - - - - - - -```js -const { data, error } = await postgrest - .from('countries') - .update({ name: 'Mordor' }) - .nxl('population_range_millions', [150, 250]) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `delete()` - - - - - - - -```js -const { data, error } = await postgrest - .from('countries') - .delete() - .nxl('population_range_millions', [150, 250]) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `rpc()` - - - - - - - -```js -// Only valid if the Stored Procedure returns a table type. -const { data, error } = await postgrest - .rpc('echo_all_countries') - .nxl('population_range_millions', [150, 250]) -``` - - - - - -```py -# Not yet implemented -``` - - - - - \ No newline at end of file diff --git a/web/docs/postgrest/client/nxr.mdx b/web/docs/postgrest/client/nxr.mdx deleted file mode 100644 index 9931e6709d6..00000000000 --- a/web/docs/postgrest/client/nxr.mdx +++ /dev/null @@ -1,226 +0,0 @@ ---- -id: nxr -title: "nxr" -slug: nxr -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/postgrest.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Finds all rows whose range value on the stated `column` does not extend -to the right of the specified `range`. - - - - - -```js -const { data, error } = await postgrest - .from('countries') - .select('name, id, population_range_millions') - .nxr('population_range_millions', [150, 250]) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -## Parameters - - -
    - -
  • -

    - - column - - - required - - - object - -

    -
    - -The column to filter on. - -
    - -
    • - - -
  • -

    - - range - - - required - - - string - -

    -
    - -The range to filter with. - -
    - -
    • - -
- - - - - - - - - - - - - - -## Examples - -### With `select()` - - - - - - - -```js -const { data, error } = await postgrest - .from('countries') - .select('name, id, population_range_millions') - .nxr('population_range_millions', [150, 250]) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `update()` - - - - - - - -```js -const { data, error } = await postgrest - .from('countries') - .update({ name: 'Mordor' }) - .nxr('population_range_millions', [150, 250]) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `delete()` - - - - - - - -```js -const { data, error } = await postgrest - .from('countries') - .delete() - .nxr('population_range_millions', [150, 250]) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `rpc()` - - - - - - - -```js -// Only valid if the Stored Procedure returns a table type. -const { data, error } = await postgrest - .rpc('echo_all_countries') - .nxr('population_range_millions', [150, 250]) -``` - - - - - -```py -# Not yet implemented -``` - - - - - \ No newline at end of file diff --git a/web/docs/postgrest/client/ov.mdx b/web/docs/postgrest/client/ov.mdx deleted file mode 100644 index 93e36a2c264..00000000000 --- a/web/docs/postgrest/client/ov.mdx +++ /dev/null @@ -1,226 +0,0 @@ ---- -id: ov -title: "ov" -slug: ov -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/postgrest.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Finds all rows whose array or range value on the stated `column` is -contained by the specified `value`. - - - - - -```js -const { data, error } = await postgrest - .from('countries') - .select('name, id, main_exports') - .ova('main_exports', ['computers', 'minerals']) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -## Parameters - - -
    - -
  • -

    - - column - - - required - - - object - -

    -
    - -The column to filter on. - -
    - -
    • - - -
  • -

    - - value - - - required - - - string | array - -

    -
    - -The value to filter with. - -
    - -
    • - -
- - - - - - - - - - - - - - -## Examples - -### With `select()` - - - - - - - -```js -const { data, error } = await postgrest - .from('countries') - .select('name, id, main_exports') - .ova('main_exports', ['computers', 'minerals']) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `update()` - - - - - - - -```js -let countries = await postgrest - .from('countries') - .update({ name: 'Mordor' }) - .ova('main_exports', ['computers', 'minerals']) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `delete()` - - - - - - - -```js -const { data, error } = await postgrest - .from('countries') - .delete() - .ova('main_exports', ['computers', 'minerals']) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `rpc()` - - - - - - - -```js -// Only valid if the Stored Procedure returns a table type. -const { data, error } = await postgrest - .rpc('echo_all_countries') - .ova('main_exports', ['computers', 'minerals']) -``` - - - - - -```py -# Not yet implemented -``` - - - - - \ No newline at end of file diff --git a/web/docs/postgrest/client/phfts.mdx b/web/docs/postgrest/client/phfts.mdx deleted file mode 100644 index 98ccead621d..00000000000 --- a/web/docs/postgrest/client/phfts.mdx +++ /dev/null @@ -1,108 +0,0 @@ ---- -id: phfts -title: "phfts" -slug: phfts -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/postgrest.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Finds all rows whose tsvector value on the stated `column` matches -phraseto_tsquery(`query`). - - - -## Parameters - - -
    - -
  • -

    - - column - - - required - - - object - -

    -
    - -The column to filter on. - -
    - -
    • - - -
  • -

    - - query - - - required - - - string - -

    -
    - -The Postgres tsquery string to filter with. - -
    - -
    • - - -
  • -

    - - __namedParameters - - - required - - - object - -

    -
    - -No description provided. - -
    - -
      -
      Properties
      - -
    • -

      - - config - - - required - - - undefined | string - -

      -
      - -The text search configuration to use. - -
      - -
      • - -
    - -
    • - -
\ No newline at end of file diff --git a/web/docs/postgrest/client/plfts.mdx b/web/docs/postgrest/client/plfts.mdx deleted file mode 100644 index b7fc9aefd9d..00000000000 --- a/web/docs/postgrest/client/plfts.mdx +++ /dev/null @@ -1,108 +0,0 @@ ---- -id: plfts -title: "plfts" -slug: plfts -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/postgrest.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Finds all rows whose tsvector value on the stated `column` matches -plainto_tsquery(`query`). - - - -## Parameters - - -
    - -
  • -

    - - column - - - required - - - object - -

    -
    - -The column to filter on. - -
    - -
    • - - -
  • -

    - - query - - - required - - - string - -

    -
    - -The Postgres tsquery string to filter with. - -
    - -
    • - - -
  • -

    - - __namedParameters - - - required - - - object - -

    -
    - -No description provided. - -
    - -
      -
      Properties
      - -
    • -

      - - config - - - required - - - undefined | string - -

      -
      - -The text search configuration to use. - -
      - -
      • - -
    - -
    • - -
\ No newline at end of file diff --git a/web/docs/postgrest/client/rpc.mdx b/web/docs/postgrest/client/rpc.mdx deleted file mode 100644 index 7209540013c..00000000000 --- a/web/docs/postgrest/client/rpc.mdx +++ /dev/null @@ -1,263 +0,0 @@ ---- -id: rpc -title: "Stored Procedures: rpc()" -slug: rpc -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/postgrest.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -You can call stored procedures as a "Remote Procedure Call". - -That's a fancy way of saying that you can put some logic into your database then call it from anywhere. -It's especially useful when the logic rarely changes - like password resets and updates. - - - - - - -```js -const { data, error } = await postgrest - .rpc('hello_world') -} -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -## Parameters - - -
    - -
  • -

    - - fn - - - required - - - string - -

    -
    - -The function name to call. - -
    - -
    • - - -
  • -

    - - params - - - optional - - - undefined | object - -

    -
    - -The parameters to pass to the function call. - -
    - -
    • - -
- - - - - - - - - - - - - - -## Examples - -### Call a stored procedure - -This is an example invoking a stored procedure. - - - - - -```js -const { data, error } = await postgrest - .rpc('hello_world') -} -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With Parameters - - - - - - - -```js -const { data, error } = await postgrest - .rpc('echo_city', { name: 'The Shire' }) -} -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### Bulk call - - - - - - - -```js -const { data, error } = await postgrest - .rpc('echo_city', [ - { name: 'The Shire' }, - { name: 'Mordor' } - ]) -} -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With filters. - -Stored procedures that return tables can also be combined with -`modifiers` and -`filters`. - - - - - - -```js -const { data, error } = await postgrest - .rpc('echo_all_cities') - .eq('name', 'The Shire') -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With count option - -You can specify a count option to get the row count along with your data. -Allowed values for count option are `null`, `exact`, `planned` and `estimated`. - - - - - - -```js -const { data, error, count } = await postgrest - .from('cities') - .rpc('hello_world', { count: 'exact' }) -} -``` - - - - - -```py -# Not yet implemented -``` - - - - - \ No newline at end of file diff --git a/web/docs/postgrest/client/select.mdx b/web/docs/postgrest/client/select.mdx deleted file mode 100644 index 5080960f9cc..00000000000 --- a/web/docs/postgrest/client/select.mdx +++ /dev/null @@ -1,382 +0,0 @@ ---- -id: select -title: "select" -slug: select -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/postgrest.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Performs vertical filtering with SELECT. - - - - - -```js -const { data, error } = await postgrest - .from('cities') - .select() -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -## Parameters - - -
    - -
  • -

    - - columns - - - required - - - string - -

    -
    - -The columns to retrieve, separated by commas. - -
    - -
    • - - -
  • -

    - - __namedParameters - - - required - - - object - -

    -
    - -No description provided. - -
    - -
      -
      Properties
      - -
    • -

      - - head - - - required - - - boolean - -

      -
      - -When set to true, select will void data. - -
      - -
      • - - -
    • -

      - - count - - - required - - - null | exact | planned | estimated - -

      -
      - -Count algorithm to use to count rows in a table. - -
      - -
      • - -
    - -
    • - -
- - - - - - - - - - - - - - -## Examples - -### Getting your data - - - - - - - -```js -const { data, error } = await postgrest - .from('cities') - .select() -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### Selecting specific columns - -You can select specific fields from your tables. - - - - - -```js -const { data, error } = await postgrest - .from('cities') - .select('name') -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### Query foreign tables - -If your database has relationships, you can query related tables too. - - - - - -```js -const { data, error } = await postgrest - .from('countries') - .select(` - name, - cities ( - name - ) - `) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### Query the same foreign table multiple times - -Sometimes you will need to query the same foreign table twice. -In this case, you can use the name of the joined column to identify -which join you intend to use. For convenience, you can also give an -alias for each column. For example, if we had a shop of products, -and we wanted to get the supplier and the purchaser at the same time -(both in the users) table: - - - - - - -```js -const { data, error } = await postgrest - .from('products') - .select(` - id, - supplier:supplier_id ( name ), - purchaser:purchaser_id ( name ) - `) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### Selecting specific columns - -You can select specific fields from your tables. - - - - - -```js -const { data, error } = await postgrest - .from('cities') - .select('name') -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### Querying with count option - -You can get the number of rows by using the count option. -Allowed values for count option are `null`, `exact`, `planned` and `estimated`. - - - - - - -```js -const { data, error, count } = await postgrest - .from('cities') - .select('name', { count: 'exact' }) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### Quering JSON data - -If you have data inside of a JSONB column, you can apply select -and query filters to the data values. Postgres offers a -[number of operators](https://www.postgresql.org/docs/9.5/functions-json.html) -for querying JSON data. Also see -[PostgREST docs](http://postgrest.org/en/v7.0.0/api.html#json-columns) for more details. - - - - - - -```js -const { data, error } = await postgrest - .from('products') - .select(` - id, - supplier:supplier_id ( name ), - purchaser:purchaser_id ( name ) - `) -``` - - - - - -```py -# Not yet implemented -``` - - - - - \ No newline at end of file diff --git a/web/docs/postgrest/client/sl.mdx b/web/docs/postgrest/client/sl.mdx deleted file mode 100644 index 1360f00a028..00000000000 --- a/web/docs/postgrest/client/sl.mdx +++ /dev/null @@ -1,226 +0,0 @@ ---- -id: sl -title: "sl" -slug: sl -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/postgrest.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Finds all rows whose range value on the stated `column` is strictly to the -left of the specified `range`. - - - - - -```js -const { data, error } = await postgrest - .from('countries') - .select('name, id, population_range_millions') - .sl('population_range_millions', [150, 250]) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -## Parameters - - -
    - -
  • -

    - - column - - - required - - - object - -

    -
    - -The column to filter on. - -
    - -
    • - - -
  • -

    - - range - - - required - - - string - -

    -
    - -The range to filter with. - -
    - -
    • - -
- - - - - - - - - - - - - - -## Examples - -### With `select()` - - - - - - - -```js -const { data, error } = await postgrest - .from('countries') - .select('name, id, population_range_millions') - .sl('population_range_millions', [150, 250]) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `update()` - - - - - - - -```js -const { data, error } = await postgrest - .from('countries') - .update({ name: 'Mordor' }) - .sl('population_range_millions', [150, 250]) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `delete()` - - - - - - - -```js -const { data, error } = await postgrest - .from('countries') - .delete() - .sl('population_range_millions', [150, 250]) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `rpc()` - - - - - - - -```js -// Only valid if the Stored Procedure returns a table type. -const { data, error } = await postgrest - .rpc('echo_all_countries') - .sl('population_range_millions', [150, 250]) -``` - - - - - -```py -# Not yet implemented -``` - - - - - \ No newline at end of file diff --git a/web/docs/postgrest/client/sr.mdx b/web/docs/postgrest/client/sr.mdx deleted file mode 100644 index 33ba3c44ceb..00000000000 --- a/web/docs/postgrest/client/sr.mdx +++ /dev/null @@ -1,226 +0,0 @@ ---- -id: sr -title: "sr" -slug: sr -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/postgrest.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Finds all rows whose range value on the stated `column` is strictly to -the right of the specified `range`. - - - - - -```js -const { data, error } = await postgrest - .from('countries') - .select('name, id, population_range_millions') - .sr('population_range_millions', [150, 250]) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -## Parameters - - -
    - -
  • -

    - - column - - - required - - - object - -

    -
    - -The column to filter on. - -
    - -
    • - - -
  • -

    - - range - - - required - - - string - -

    -
    - -The range to filter with. - -
    - -
    • - -
- - - - - - - - - - - - - - -## Examples - -### With `select()` - - - - - - - -```js -const { data, error } = await postgrest - .from('countries') - .select('name, id, population_range_millions') - .sr('population_range_millions', [150, 250]) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `update()` - - - - - - - -```js -const { data, error } = await postgrest - .from('countries') - .update({ name: 'Mordor' }) - .sr('population_range_millions', [150, 250]) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `delete()` - - - - - - - -```js -const { data, error } = await postgrest - .from('countries') - .delete() - .sr('population_range_millions', [150, 250]) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -### With `rpc()` - - - - - - - -```js -// Only valid if the Stored Procedure returns a table type. -const { data, error } = await postgrest - .rpc('echo_all_countries') - .sr('population_range_millions', [150, 250]) -``` - - - - - -```py -# Not yet implemented -``` - - - - - \ No newline at end of file diff --git a/web/docs/postgrest/client/update.mdx b/web/docs/postgrest/client/update.mdx deleted file mode 100644 index 36bb20eea98..00000000000 --- a/web/docs/postgrest/client/update.mdx +++ /dev/null @@ -1,178 +0,0 @@ ---- -id: update -title: "update" -slug: update -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/postgrest.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Performs an UPDATE on the table. - - - - - -```js -const { data, error } = await postgrest - .from('cities') - .update({ name: 'Middle Earth' }) - .match({ name: 'Auckland' }) -``` - - - - - -```py -# Not yet implemented -``` - - - - - - -## Parameters - - -
    - -
  • -

    - - values - - - required - - - Partial - -

    -
    - -The values to update. - -
    - -
    • - - -
  • -

    - - __namedParameters - - - required - - - object - -

    -
    - -No description provided. - -
    - -
      -
      Properties
      - -
    • -

      - - returning - - - required - - - minimal | representation - -

      -
      - -By default the updated record is returned. Set this to 'minimal' if you don't need this value. - -
      - -
      • - - -
    • -

      - - count - - - required - - - null | exact | planned | estimated - -

      -
      - -No description provided. - -
      - -
      • - -
    - -
    • - -
- - - - - - - - - - - - - - -## Examples - -### Updating your data - - - - - - - -```js -const { data, error } = await postgrest - .from('cities') - .update({ name: 'Middle Earth' }) - .match({ name: 'Auckland' }) -``` - - - - - -```py -# Not yet implemented -``` - - - - - \ No newline at end of file diff --git a/web/docs/postgrest/client/wfts.mdx b/web/docs/postgrest/client/wfts.mdx deleted file mode 100644 index 9b4d0a8e601..00000000000 --- a/web/docs/postgrest/client/wfts.mdx +++ /dev/null @@ -1,108 +0,0 @@ ---- -id: wfts -title: "wfts" -slug: wfts -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/postgrest.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Finds all rows whose tsvector value on the stated `column` matches -websearch_to_tsquery(`query`). - - - -## Parameters - - -
    - -
  • -

    - - column - - - required - - - object - -

    -
    - -The column to filter on. - -
    - -
    • - - -
  • -

    - - query - - - required - - - string - -

    -
    - -The Postgres tsquery string to filter with. - -
    - -
    • - - -
  • -

    - - __namedParameters - - - required - - - object - -

    -
    - -No description provided. - -
    - -
      -
      Properties
      - -
    • -

      - - config - - - required - - - undefined | string - -

      -
      - -The text search configuration to use. - -
      - -
      • - -
    - -
    • - -
\ No newline at end of file diff --git a/web/docs/realtime/client/.gitkeep b/web/docs/realtime/client/.gitkeep new file mode 100644 index 00000000000..e69de29bb2d diff --git a/web/docs/realtime/client/connect.mdx b/web/docs/realtime/client/connect.mdx deleted file mode 100644 index 8ea96073f97..00000000000 --- a/web/docs/realtime/client/connect.mdx +++ /dev/null @@ -1,59 +0,0 @@ ---- -id: connect -title: "connect" -slug: connect -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/realtime.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Connects the socket. - - - - - - - - - - - - - - - - - - - -## Examples - -### Connect - - - - - - - -```js -realtime.connect() -``` - - - - - -```py -# Not yet implemented -``` - - - - - \ No newline at end of file diff --git a/web/docs/realtime/client/disconnect.mdx b/web/docs/realtime/client/disconnect.mdx deleted file mode 100644 index 3fdb5414595..00000000000 --- a/web/docs/realtime/client/disconnect.mdx +++ /dev/null @@ -1,104 +0,0 @@ ---- -id: disconnect -title: "disconnect" -slug: disconnect -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/realtime.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Disconnects the socket. - - - -## Parameters - - -
    - -
  • -

    - - code - - - optional - - - undefined | number - -

    -
    - -A numeric status code to send on disconnect. - -
    - -
    • - - -
  • -

    - - reason - - - optional - - - undefined | string - -

    -
    - -A custom reason for the disconnect. - -
    - -
    • - -
- - - - - - - - - - - - - - -## Examples - -### Connect - - - - - - - -```js -realtime.disconnect() -``` - - - - - -```py -# Not yet implemented -``` - - - - - \ No newline at end of file diff --git a/web/docs/realtime/client/index.mdx b/web/docs/realtime/client/index.mdx deleted file mode 100644 index 7656404fc41..00000000000 --- a/web/docs/realtime/client/index.mdx +++ /dev/null @@ -1,13 +0,0 @@ ---- -id: index -title: "Realtime Client" -slug: realtime-client -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/realtime.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Listens to changes in a PostgreSQL Database and via websockets. - -This is for usage with Supabase Realtime server. \ No newline at end of file diff --git a/web/docs/realtime/client/initializing.mdx b/web/docs/realtime/client/initializing.mdx deleted file mode 100644 index eb69ae1a052..00000000000 --- a/web/docs/realtime/client/initializing.mdx +++ /dev/null @@ -1,61 +0,0 @@ ---- -id: initializing -title: "Initializing" -slug: initializing -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/realtime.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Initializes the Socket - - - -## Parameters - - -
    - -
  • -

    - - endPoint - - - required - - - string - -

    -
    - -The string WebSocket endpoint, ie, "ws://example.com/socket", "wss://example.com", "/socket" (inherited host & protocol) - -
    - -
    • - - -
  • -

    - - options - - - optional - - - Options - -

    -
    - -No description provided. - -
    - -
    • - -
\ No newline at end of file diff --git a/web/docs/realtime/client/installing.mdx b/web/docs/realtime/client/installing.mdx deleted file mode 100644 index 5b1bfbe0d87..00000000000 --- a/web/docs/realtime/client/installing.mdx +++ /dev/null @@ -1,25 +0,0 @@ ---- -id: installing -title: "Installing" -slug: installing -custom_edit_url: https://github.com/supabase/supabase/edit/master/web/spec/realtime.yml ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -All JavaScript libraries are built directly by the Supabase team. - -Other languages are built by the community and supported by Supabase. - -## JavaScript - -```bash -npm install @supabase/realtime-js -``` - -## Python - -```bash -# Not yet implemented -``` \ No newline at end of file diff --git a/web/package.json b/web/package.json index 20c0b691037..6d7ebcbd132 100644 --- a/web/package.json +++ b/web/package.json @@ -4,9 +4,10 @@ "private": true, "scripts": { "start": "docusaurus start --port 3005", - "build": "docusaurus build", + "build": "npm run gen:all && docusaurus build", "swizzle": "docusaurus swizzle", "traction": "node traction.js", + "gen:all": "npm run gen:supabase && npm run gen:gotrue && npm run gen:postgrest && npm run gen:realtime", "gen:gotrue": "ts-node ReferenceGenerator.ts -o docs/gotrue/client spec/gotrue.yml", "gen:postgrest": "ts-node ReferenceGenerator.ts -o docs/postgrest/client spec/postgrest.yml", "gen:realtime": "ts-node ReferenceGenerator.ts -o docs/realtime/client spec/realtime.yml", diff --git a/web/spec/combined.json b/web/spec/combined.json index 17633c97881..e941c147f05 100644 --- a/web/spec/combined.json +++ b/web/spec/combined.json @@ -5807,7 +5807,7 @@ "originalName": "", "children": [ { - "id": 131, + "id": 153, "name": "\"GoTrueApi\"", "kind": 1, "kindString": "Module", @@ -5817,7 +5817,7 @@ "originalName": "/home/runner/work/gotrue-js/gotrue-js/src/GoTrueApi.ts", "children": [ { - "id": 132, + "id": 154, "name": "GoTrueApi", "kind": 128, "kindString": "Class", @@ -5826,7 +5826,7 @@ }, "children": [ { - "id": 139, + "id": 161, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -5835,7 +5835,7 @@ }, "signatures": [ { - "id": 140, + "id": 162, "name": "new GoTrueApi", "kind": 16384, "kindString": "Constructor signature", @@ -5844,7 +5844,7 @@ }, "parameters": [ { - "id": 141, + "id": 163, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", @@ -5855,7 +5855,7 @@ "type": { "type": "reflection", "declaration": { - "id": 142, + "id": 164, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -5864,7 +5864,7 @@ }, "children": [ { - "id": 148, + "id": 170, "name": "cookieOptions", "kind": 32, "kindString": "Variable", @@ -5887,14 +5887,14 @@ }, { "type": "reference", - "id": 66, + "id": 84, "name": "CookieOptions" } ] } }, { - "id": 144, + "id": 166, "name": "headers", "kind": 32, "kindString": "Variable", @@ -5911,7 +5911,7 @@ "type": { "type": "reflection", "declaration": { - "id": 145, + "id": 167, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -5920,7 +5920,7 @@ }, "indexSignature": [ { - "id": 146, + "id": 168, "name": "__index", "kind": 8192, "kindString": "Index signature", @@ -5929,7 +5929,7 @@ }, "parameters": [ { - "id": 147, + "id": 169, "name": "key", "kind": 32768, "kindString": "Parameter", @@ -5952,7 +5952,7 @@ } }, { - "id": 143, + "id": 165, "name": "url", "kind": 32, "kindString": "Variable", @@ -5978,9 +5978,9 @@ "title": "Variables", "kind": 32, "children": [ - 148, - 144, - 143 + 170, + 166, + 165 ] } ], @@ -5997,7 +5997,7 @@ ], "type": { "type": "reference", - "id": 132, + "id": 154, "name": "GoTrueApi" } } @@ -6011,7 +6011,7 @@ ] }, { - "id": 138, + "id": 160, "name": "cookieOptions", "kind": 1024, "kindString": "Property", @@ -6028,12 +6028,12 @@ ], "type": { "type": "reference", - "id": 66, + "id": 84, "name": "CookieOptions" } }, { - "id": 134, + "id": 156, "name": "headers", "kind": 1024, "kindString": "Property", @@ -6051,7 +6051,7 @@ "type": { "type": "reflection", "declaration": { - "id": 135, + "id": 157, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -6060,7 +6060,7 @@ }, "indexSignature": [ { - "id": 136, + "id": 158, "name": "__index", "kind": 8192, "kindString": "Index signature", @@ -6069,7 +6069,7 @@ }, "parameters": [ { - "id": 137, + "id": 159, "name": "key", "kind": 32768, "kindString": "Parameter", @@ -6099,7 +6099,7 @@ } }, { - "id": 133, + "id": 155, "name": "url", "kind": 1024, "kindString": "Property", @@ -6120,7 +6120,68 @@ } }, { - "id": 189, + "id": 206, + "name": "_createRequestHeaders", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPrivate": true, + "isExported": true + }, + "signatures": [ + { + "id": 207, + "name": "_createRequestHeaders", + "kind": 4096, + "kindString": "Call signature", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "Create a temporary object with all configured headers and\nadds the Authorization token to be used on request methods" + }, + "parameters": [ + { + "id": 208, + "name": "jwt", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "comment": { + "text": "A valid, logged-in JWT.\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 209, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + "isExported": true + } + } + } + } + ], + "sources": [ + { + "fileName": "GoTrueApi.ts", + "line": 111, + "character": 31 + } + ] + }, + { + "id": 215, "name": "getUrlForProvider", "kind": 2048, "kindString": "Method", @@ -6129,7 +6190,7 @@ }, "signatures": [ { - "id": 190, + "id": 216, "name": "getUrlForProvider", "kind": 4096, "kindString": "Call signature", @@ -6141,7 +6202,7 @@ }, "parameters": [ { - "id": 191, + "id": 217, "name": "provider", "kind": 32768, "kindString": "Parameter", @@ -6153,7 +6214,7 @@ }, "type": { "type": "reference", - "id": 72, + "id": 94, "name": "Provider" } } @@ -6167,13 +6228,13 @@ "sources": [ { "fileName": "GoTrueApi.ts", - "line": 125, + "line": 138, "character": 19 } ] }, { - "id": 192, + "id": 218, "name": "getUser", "kind": 2048, "kindString": "Method", @@ -6182,7 +6243,7 @@ }, "signatures": [ { - "id": 193, + "id": 219, "name": "getUser", "kind": 4096, "kindString": "Call signature", @@ -6194,7 +6255,7 @@ }, "parameters": [ { - "id": 194, + "id": 220, "name": "jwt", "kind": 32768, "kindString": "Parameter", @@ -6210,6 +6271,353 @@ } } ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reflection", + "declaration": { + "id": 221, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + "isExported": true + }, + "children": [ + { + "id": 223, + "name": "data", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "GoTrueApi.ts", + "line": 148, + "character": 38 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 51, + "name": "User" + }, + { + "type": "intrinsic", + "name": "null" + } + ] + } + }, + { + "id": 224, + "name": "error", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "GoTrueApi.ts", + "line": 148, + "character": 58 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "name": "Error" + }, + { + "type": "intrinsic", + "name": "null" + } + ] + } + }, + { + "id": 222, + "name": "user", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "GoTrueApi.ts", + "line": 148, + "character": 19 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 51, + "name": "User" + }, + { + "type": "intrinsic", + "name": "null" + } + ] + } + } + ], + "groups": [ + { + "title": "Variables", + "kind": 32, + "children": [ + 223, + 224, + 222 + ] + } + ], + "sources": [ + { + "fileName": "GoTrueApi.ts", + "line": 148, + "character": 13 + } + ] + } + } + ], + "name": "Promise" + } + } + ], + "sources": [ + { + "fileName": "GoTrueApi.ts", + "line": 146, + "character": 15 + } + ] + }, + { + "id": 243, + "name": "getUserByCookie", + "kind": 2048, + "kindString": "Method", + "flags": { + "isExported": true + }, + "signatures": [ + { + "id": 244, + "name": "getUserByCookie", + "kind": 4096, + "kindString": "Call signature", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "Get user by reading the cookie from the request.\nWorks for Next.js & Express (requires cookie-parser middleware)." + }, + "parameters": [ + { + "id": 245, + "name": "req", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reflection", + "declaration": { + "id": 246, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + "isExported": true + }, + "children": [ + { + "id": 248, + "name": "data", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "GoTrueApi.ts", + "line": 227, + "character": 38 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 51, + "name": "User" + }, + { + "type": "intrinsic", + "name": "null" + } + ] + } + }, + { + "id": 249, + "name": "error", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "GoTrueApi.ts", + "line": 227, + "character": 58 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "name": "Error" + }, + { + "type": "intrinsic", + "name": "null" + } + ] + } + }, + { + "id": 247, + "name": "user", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "GoTrueApi.ts", + "line": 227, + "character": 19 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 51, + "name": "User" + }, + { + "type": "intrinsic", + "name": "null" + } + ] + } + } + ], + "groups": [ + { + "title": "Variables", + "kind": 32, + "children": [ + 248, + 249, + 247 + ] + } + ], + "sources": [ + { + "fileName": "GoTrueApi.ts", + "line": 227, + "character": 13 + } + ] + } + } + ], + "name": "Promise" + } + } + ], + "sources": [ + { + "fileName": "GoTrueApi.ts", + "line": 225, + "character": 23 + } + ] + }, + { + "id": 192, + "name": "inviteUserByEmail", + "kind": 2048, + "kindString": "Method", + "flags": { + "isExported": true + }, + "signatures": [ + { + "id": 193, + "name": "inviteUserByEmail", + "kind": 4096, + "kindString": "Call signature", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "Sends an invite link to an email address." + }, + "parameters": [ + { + "id": 194, + "name": "email", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "comment": { + "text": "The email address of the user.\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], "type": { "type": "reference", "typeArguments": [ @@ -6224,355 +6632,8 @@ "isExported": true }, "children": [ - { - "id": 197, - "name": "data", - "kind": 32, - "kindString": "Variable", - "flags": { - "isExported": true - }, - "sources": [ - { - "fileName": "GoTrueApi.ts", - "line": 135, - "character": 38 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 33, - "name": "User" - }, - { - "type": "intrinsic", - "name": "null" - } - ] - } - }, - { - "id": 198, - "name": "error", - "kind": 32, - "kindString": "Variable", - "flags": { - "isExported": true - }, - "sources": [ - { - "fileName": "GoTrueApi.ts", - "line": 135, - "character": 58 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "name": "Error" - }, - { - "type": "intrinsic", - "name": "null" - } - ] - } - }, { "id": 196, - "name": "user", - "kind": 32, - "kindString": "Variable", - "flags": { - "isExported": true - }, - "sources": [ - { - "fileName": "GoTrueApi.ts", - "line": 135, - "character": 19 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 33, - "name": "User" - }, - { - "type": "intrinsic", - "name": "null" - } - ] - } - } - ], - "groups": [ - { - "title": "Variables", - "kind": 32, - "children": [ - 197, - 198, - 196 - ] - } - ], - "sources": [ - { - "fileName": "GoTrueApi.ts", - "line": 135, - "character": 13 - } - ] - } - } - ], - "name": "Promise" - } - } - ], - "sources": [ - { - "fileName": "GoTrueApi.ts", - "line": 133, - "character": 15 - } - ] - }, - { - "id": 217, - "name": "getUserByCookie", - "kind": 2048, - "kindString": "Method", - "flags": { - "isExported": true - }, - "signatures": [ - { - "id": 218, - "name": "getUserByCookie", - "kind": 4096, - "kindString": "Call signature", - "flags": { - "isExported": true - }, - "comment": { - "shortText": "Get user by reading the cookie from the request.\nWorks for Next.js & Express (requires cookie-parser middleware)." - }, - "parameters": [ - { - "id": 219, - "name": "req", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isExported": true - }, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 220, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": { - "isExported": true - }, - "children": [ - { - "id": 222, - "name": "data", - "kind": 32, - "kindString": "Variable", - "flags": { - "isExported": true - }, - "sources": [ - { - "fileName": "GoTrueApi.ts", - "line": 217, - "character": 38 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 33, - "name": "User" - }, - { - "type": "intrinsic", - "name": "null" - } - ] - } - }, - { - "id": 223, - "name": "error", - "kind": 32, - "kindString": "Variable", - "flags": { - "isExported": true - }, - "sources": [ - { - "fileName": "GoTrueApi.ts", - "line": 217, - "character": 58 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "name": "Error" - }, - { - "type": "intrinsic", - "name": "null" - } - ] - } - }, - { - "id": 221, - "name": "user", - "kind": 32, - "kindString": "Variable", - "flags": { - "isExported": true - }, - "sources": [ - { - "fileName": "GoTrueApi.ts", - "line": 217, - "character": 19 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 33, - "name": "User" - }, - { - "type": "intrinsic", - "name": "null" - } - ] - } - } - ], - "groups": [ - { - "title": "Variables", - "kind": 32, - "children": [ - 222, - 223, - 221 - ] - } - ], - "sources": [ - { - "fileName": "GoTrueApi.ts", - "line": 217, - "character": 13 - } - ] - } - } - ], - "name": "Promise" - } - } - ], - "sources": [ - { - "fileName": "GoTrueApi.ts", - "line": 215, - "character": 23 - } - ] - }, - { - "id": 170, - "name": "inviteUserByEmail", - "kind": 2048, - "kindString": "Method", - "flags": { - "isExported": true - }, - "signatures": [ - { - "id": 171, - "name": "inviteUserByEmail", - "kind": 4096, - "kindString": "Call signature", - "flags": { - "isExported": true - }, - "comment": { - "shortText": "Sends an invite link to an email address." - }, - "parameters": [ - { - "id": 172, - "name": "email", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isExported": true - }, - "comment": { - "text": "The email address of the user.\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 173, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": { - "isExported": true - }, - "children": [ - { - "id": 174, "name": "data", "kind": 32, "kindString": "Variable", @@ -6592,7 +6653,7 @@ { "type": "reflection", "declaration": { - "id": 175, + "id": 197, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -6616,7 +6677,7 @@ } }, { - "id": 176, + "id": 198, "name": "error", "kind": 32, "kindString": "Variable", @@ -6650,8 +6711,8 @@ "title": "Variables", "kind": 32, "children": [ - 174, - 176 + 196, + 198 ] } ], @@ -6678,7 +6739,7 @@ ] }, { - "id": 207, + "id": 233, "name": "refreshAccessToken", "kind": 2048, "kindString": "Method", @@ -6687,7 +6748,7 @@ }, "signatures": [ { - "id": 208, + "id": 234, "name": "refreshAccessToken", "kind": 4096, "kindString": "Call signature", @@ -6699,7 +6760,7 @@ }, "parameters": [ { - "id": 209, + "id": 235, "name": "refreshToken", "kind": 32768, "kindString": "Parameter", @@ -6721,7 +6782,7 @@ { "type": "reflection", "declaration": { - "id": 210, + "id": 236, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -6730,7 +6791,7 @@ }, "children": [ { - "id": 211, + "id": 237, "name": "data", "kind": 32, "kindString": "Variable", @@ -6740,7 +6801,7 @@ "sources": [ { "fileName": "GoTrueApi.ts", - "line": 171, + "line": 182, "character": 19 } ], @@ -6749,7 +6810,7 @@ "types": [ { "type": "reference", - "id": 27, + "id": 45, "name": "Session" }, { @@ -6760,7 +6821,7 @@ } }, { - "id": 212, + "id": 238, "name": "error", "kind": 32, "kindString": "Variable", @@ -6770,7 +6831,7 @@ "sources": [ { "fileName": "GoTrueApi.ts", - "line": 171, + "line": 182, "character": 42 } ], @@ -6794,15 +6855,15 @@ "title": "Variables", "kind": 32, "children": [ - 211, - 212 + 237, + 238 ] } ], "sources": [ { "fileName": "GoTrueApi.ts", - "line": 171, + "line": 182, "character": 13 } ] @@ -6816,13 +6877,13 @@ "sources": [ { "fileName": "GoTrueApi.ts", - "line": 169, + "line": 180, "character": 26 } ] }, { - "id": 177, + "id": 199, "name": "resetPasswordForEmail", "kind": 2048, "kindString": "Method", @@ -6831,7 +6892,7 @@ }, "signatures": [ { - "id": 178, + "id": 200, "name": "resetPasswordForEmail", "kind": 4096, "kindString": "Call signature", @@ -6843,7 +6904,7 @@ }, "parameters": [ { - "id": 179, + "id": 201, "name": "email", "kind": 32768, "kindString": "Parameter", @@ -6865,7 +6926,7 @@ { "type": "reflection", "declaration": { - "id": 180, + "id": 202, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -6874,7 +6935,7 @@ }, "children": [ { - "id": 181, + "id": 203, "name": "data", "kind": 32, "kindString": "Variable", @@ -6894,7 +6955,7 @@ { "type": "reflection", "declaration": { - "id": 182, + "id": 204, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -6918,7 +6979,7 @@ } }, { - "id": 183, + "id": 205, "name": "error", "kind": 32, "kindString": "Variable", @@ -6952,8 +7013,8 @@ "title": "Variables", "kind": 32, "children": [ - 181, - 183 + 203, + 205 ] } ], @@ -6980,7 +7041,7 @@ ] }, { - "id": 163, + "id": 185, "name": "sendMagicLinkEmail", "kind": 2048, "kindString": "Method", @@ -6989,7 +7050,7 @@ }, "signatures": [ { - "id": 164, + "id": 186, "name": "sendMagicLinkEmail", "kind": 4096, "kindString": "Call signature", @@ -7001,7 +7062,7 @@ }, "parameters": [ { - "id": 165, + "id": 187, "name": "email", "kind": 32768, "kindString": "Parameter", @@ -7023,7 +7084,7 @@ { "type": "reflection", "declaration": { - "id": 166, + "id": 188, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -7032,7 +7093,7 @@ }, "children": [ { - "id": 167, + "id": 189, "name": "data", "kind": 32, "kindString": "Variable", @@ -7052,7 +7113,7 @@ { "type": "reflection", "declaration": { - "id": 168, + "id": 190, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -7076,7 +7137,7 @@ } }, { - "id": 169, + "id": 191, "name": "error", "kind": 32, "kindString": "Variable", @@ -7110,8 +7171,8 @@ "title": "Variables", "kind": 32, "children": [ - 167, - 169 + 189, + 191 ] } ], @@ -7138,7 +7199,7 @@ ] }, { - "id": 213, + "id": 239, "name": "setAuthCookie", "kind": 2048, "kindString": "Method", @@ -7147,7 +7208,7 @@ }, "signatures": [ { - "id": 214, + "id": 240, "name": "setAuthCookie", "kind": 4096, "kindString": "Call signature", @@ -7159,7 +7220,7 @@ }, "parameters": [ { - "id": 215, + "id": 241, "name": "req", "kind": 32768, "kindString": "Parameter", @@ -7172,7 +7233,7 @@ } }, { - "id": 216, + "id": 242, "name": "res", "kind": 32768, "kindString": "Parameter", @@ -7194,13 +7255,13 @@ "sources": [ { "fileName": "GoTrueApi.ts", - "line": 188, + "line": 199, "character": 15 } ] }, { - "id": 156, + "id": 178, "name": "signInWithEmail", "kind": 2048, "kindString": "Method", @@ -7209,7 +7270,7 @@ }, "signatures": [ { - "id": 157, + "id": 179, "name": "signInWithEmail", "kind": 4096, "kindString": "Call signature", @@ -7221,7 +7282,7 @@ }, "parameters": [ { - "id": 158, + "id": 180, "name": "email", "kind": 32768, "kindString": "Parameter", @@ -7237,7 +7298,7 @@ } }, { - "id": 159, + "id": 181, "name": "password", "kind": 32768, "kindString": "Parameter", @@ -7259,7 +7320,7 @@ { "type": "reflection", "declaration": { - "id": 160, + "id": 182, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -7268,7 +7329,7 @@ }, "children": [ { - "id": 161, + "id": 183, "name": "data", "kind": 32, "kindString": "Variable", @@ -7287,7 +7348,7 @@ "types": [ { "type": "reference", - "id": 27, + "id": 45, "name": "Session" }, { @@ -7298,7 +7359,7 @@ } }, { - "id": 162, + "id": 184, "name": "error", "kind": 32, "kindString": "Variable", @@ -7332,8 +7393,8 @@ "title": "Variables", "kind": 32, "children": [ - 161, - 162 + 183, + 184 ] } ], @@ -7360,7 +7421,7 @@ ] }, { - "id": 184, + "id": 210, "name": "signOut", "kind": 2048, "kindString": "Method", @@ -7369,7 +7430,7 @@ }, "signatures": [ { - "id": 185, + "id": 211, "name": "signOut", "kind": 4096, "kindString": "Call signature", @@ -7381,7 +7442,7 @@ }, "parameters": [ { - "id": 186, + "id": 212, "name": "jwt", "kind": 32768, "kindString": "Parameter", @@ -7403,7 +7464,7 @@ { "type": "reflection", "declaration": { - "id": 187, + "id": 213, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -7412,7 +7473,7 @@ }, "children": [ { - "id": 188, + "id": 214, "name": "error", "kind": 32, "kindString": "Variable", @@ -7422,7 +7483,7 @@ "sources": [ { "fileName": "GoTrueApi.ts", - "line": 110, + "line": 121, "character": 45 } ], @@ -7446,14 +7507,14 @@ "title": "Variables", "kind": 32, "children": [ - 188 + 214 ] } ], "sources": [ { "fileName": "GoTrueApi.ts", - "line": 110, + "line": 121, "character": 38 } ] @@ -7467,13 +7528,13 @@ "sources": [ { "fileName": "GoTrueApi.ts", - "line": 110, + "line": 121, "character": 15 } ] }, { - "id": 149, + "id": 171, "name": "signUpWithEmail", "kind": 2048, "kindString": "Method", @@ -7482,7 +7543,7 @@ }, "signatures": [ { - "id": 150, + "id": 172, "name": "signUpWithEmail", "kind": 4096, "kindString": "Call signature", @@ -7494,7 +7555,7 @@ }, "parameters": [ { - "id": 151, + "id": 173, "name": "email", "kind": 32768, "kindString": "Parameter", @@ -7510,7 +7571,7 @@ } }, { - "id": 152, + "id": 174, "name": "password", "kind": 32768, "kindString": "Parameter", @@ -7532,7 +7593,7 @@ { "type": "reflection", "declaration": { - "id": 153, + "id": 175, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -7541,7 +7602,7 @@ }, "children": [ { - "id": 154, + "id": 176, "name": "data", "kind": 32, "kindString": "Variable", @@ -7560,7 +7621,7 @@ "types": [ { "type": "reference", - "id": 27, + "id": 45, "name": "Session" }, { @@ -7571,7 +7632,7 @@ } }, { - "id": 155, + "id": 177, "name": "error", "kind": 32, "kindString": "Variable", @@ -7605,8 +7666,8 @@ "title": "Variables", "kind": 32, "children": [ - 154, - 155 + 176, + 177 ] } ], @@ -7633,7 +7694,7 @@ ] }, { - "id": 199, + "id": 225, "name": "updateUser", "kind": 2048, "kindString": "Method", @@ -7642,7 +7703,7 @@ }, "signatures": [ { - "id": 200, + "id": 226, "name": "updateUser", "kind": 4096, "kindString": "Call signature", @@ -7654,7 +7715,7 @@ }, "parameters": [ { - "id": 201, + "id": 227, "name": "jwt", "kind": 32768, "kindString": "Parameter", @@ -7670,7 +7731,7 @@ } }, { - "id": 202, + "id": 228, "name": "attributes", "kind": 32768, "kindString": "Parameter", @@ -7682,7 +7743,7 @@ }, "type": { "type": "reference", - "id": 51, + "id": 69, "name": "UserAttributes" } } @@ -7693,7 +7754,7 @@ { "type": "reflection", "declaration": { - "id": 203, + "id": 229, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -7702,7 +7763,7 @@ }, "children": [ { - "id": 205, + "id": 231, "name": "data", "kind": 32, "kindString": "Variable", @@ -7712,7 +7773,7 @@ "sources": [ { "fileName": "GoTrueApi.ts", - "line": 154, + "line": 165, "character": 38 } ], @@ -7721,7 +7782,7 @@ "types": [ { "type": "reference", - "id": 33, + "id": 51, "name": "User" }, { @@ -7732,7 +7793,7 @@ } }, { - "id": 206, + "id": 232, "name": "error", "kind": 32, "kindString": "Variable", @@ -7742,7 +7803,7 @@ "sources": [ { "fileName": "GoTrueApi.ts", - "line": 154, + "line": 165, "character": 58 } ], @@ -7761,7 +7822,7 @@ } }, { - "id": 204, + "id": 230, "name": "user", "kind": 32, "kindString": "Variable", @@ -7771,7 +7832,7 @@ "sources": [ { "fileName": "GoTrueApi.ts", - "line": 154, + "line": 165, "character": 19 } ], @@ -7780,7 +7841,7 @@ "types": [ { "type": "reference", - "id": 33, + "id": 51, "name": "User" }, { @@ -7796,16 +7857,16 @@ "title": "Variables", "kind": 32, "children": [ - 205, - 206, - 204 + 231, + 232, + 230 ] } ], "sources": [ { "fileName": "GoTrueApi.ts", - "line": 154, + "line": 165, "character": 13 } ] @@ -7819,7 +7880,7 @@ "sources": [ { "fileName": "GoTrueApi.ts", - "line": 151, + "line": 162, "character": 18 } ] @@ -7830,34 +7891,35 @@ "title": "Constructors", "kind": 512, "children": [ - 139 + 161 ] }, { "title": "Properties", "kind": 1024, "children": [ - 138, - 134, - 133 + 160, + 156, + 155 ] }, { "title": "Methods", "kind": 2048, "children": [ - 189, + 206, + 215, + 218, + 243, 192, - 217, - 170, - 207, - 177, - 163, - 213, - 156, - 184, - 149, - 199 + 233, + 199, + 185, + 239, + 178, + 210, + 171, + 225 ] } ], @@ -7875,7 +7937,7 @@ "title": "Classes", "kind": 128, "children": [ - 132 + 154 ] } ], @@ -7888,7 +7950,7 @@ ] }, { - "id": 256, + "id": 285, "name": "\"GoTrueClient\"", "kind": 1, "kindString": "Module", @@ -7898,7 +7960,7 @@ "originalName": "/home/runner/work/gotrue-js/gotrue-js/src/GoTrueClient.ts", "children": [ { - "id": 257, + "id": 286, "name": "GoTrueClient", "kind": 128, "kindString": "Class", @@ -7907,7 +7969,7 @@ }, "children": [ { - "id": 265, + "id": 294, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -7919,7 +7981,7 @@ }, "signatures": [ { - "id": 266, + "id": 295, "name": "new GoTrueClient", "kind": 16384, "kindString": "Constructor signature", @@ -7931,7 +7993,7 @@ }, "parameters": [ { - "id": 267, + "id": 296, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -7941,7 +8003,7 @@ "type": { "type": "reflection", "declaration": { - "id": 268, + "id": 297, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -7950,7 +8012,7 @@ }, "children": [ { - "id": 275, + "id": 304, "name": "autoRefreshToken", "kind": 32, "kindString": "Variable", @@ -7964,7 +8026,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 54, + "line": 58, "character": 20 } ], @@ -7987,7 +8049,7 @@ } }, { - "id": 278, + "id": 307, "name": "cookieOptions", "kind": 32, "kindString": "Variable", @@ -7998,18 +8060,18 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 57, + "line": 61, "character": 17 } ], "type": { "type": "reference", - "id": 66, + "id": 84, "name": "CookieOptions" } }, { - "id": 274, + "id": 303, "name": "detectSessionInUrl", "kind": 32, "kindString": "Variable", @@ -8023,7 +8085,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 53, + "line": 57, "character": 22 } ], @@ -8046,7 +8108,7 @@ } }, { - "id": 270, + "id": 299, "name": "headers", "kind": 32, "kindString": "Variable", @@ -8060,7 +8122,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 52, + "line": 56, "character": 11 } ], @@ -8074,7 +8136,7 @@ { "type": "reflection", "declaration": { - "id": 271, + "id": 300, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -8083,7 +8145,7 @@ }, "indexSignature": [ { - "id": 272, + "id": 301, "name": "__index", "kind": 8192, "kindString": "Index signature", @@ -8092,7 +8154,7 @@ }, "parameters": [ { - "id": 273, + "id": 302, "name": "key", "kind": 32768, "kindString": "Parameter", @@ -8117,7 +8179,7 @@ } }, { - "id": 277, + "id": 306, "name": "localStorage", "kind": 32, "kindString": "Variable", @@ -8131,7 +8193,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 56, + "line": 60, "character": 16 } ], @@ -8141,7 +8203,7 @@ } }, { - "id": 276, + "id": 305, "name": "persistSession", "kind": 32, "kindString": "Variable", @@ -8155,7 +8217,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 55, + "line": 59, "character": 18 } ], @@ -8178,7 +8240,7 @@ } }, { - "id": 269, + "id": 298, "name": "url", "kind": 32, "kindString": "Variable", @@ -8192,7 +8254,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 51, + "line": 55, "character": 7 } ], @@ -8216,20 +8278,20 @@ "title": "Variables", "kind": 32, "children": [ - 275, - 278, - 274, - 270, - 277, - 276, - 269 + 304, + 307, + 303, + 299, + 306, + 305, + 298 ] } ], "sources": [ { "fileName": "GoTrueClient.ts", - "line": 50, + "line": 54, "character": 22 } ] @@ -8239,7 +8301,7 @@ ], "type": { "type": "reference", - "id": 257, + "id": 286, "name": "GoTrueClient" } } @@ -8247,13 +8309,13 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 39, + "line": 43, "character": 70 } ] }, { - "id": 258, + "id": 287, "name": "api", "kind": 1024, "kindString": "Property", @@ -8266,18 +8328,18 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 27, + "line": 31, "character": 5 } ], "type": { "type": "reference", - "id": 132, + "id": 154, "name": "GoTrueApi" } }, { - "id": 261, + "id": 290, "name": "autoRefreshToken", "kind": 1024, "kindString": "Property", @@ -8288,7 +8350,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 36, + "line": 40, "character": 28 } ], @@ -8298,7 +8360,7 @@ } }, { - "id": 260, + "id": 289, "name": "currentSession", "kind": 1024, "kindString": "Property", @@ -8312,7 +8374,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 35, + "line": 39, "character": 26 } ], @@ -8321,7 +8383,7 @@ "types": [ { "type": "reference", - "id": 27, + "id": 45, "name": "Session" }, { @@ -8332,7 +8394,7 @@ } }, { - "id": 259, + "id": 288, "name": "currentUser", "kind": 1024, "kindString": "Property", @@ -8346,7 +8408,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 31, + "line": 35, "character": 23 } ], @@ -8355,7 +8417,7 @@ "types": [ { "type": "reference", - "id": 33, + "id": 51, "name": "User" }, { @@ -8366,7 +8428,7 @@ } }, { - "id": 263, + "id": 292, "name": "localStorage", "kind": 1024, "kindString": "Property", @@ -8377,7 +8439,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 38, + "line": 42, "character": 24 } ], @@ -8387,7 +8449,7 @@ } }, { - "id": 262, + "id": 291, "name": "persistSession", "kind": 1024, "kindString": "Property", @@ -8398,7 +8460,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 37, + "line": 41, "character": 26 } ], @@ -8408,7 +8470,7 @@ } }, { - "id": 264, + "id": 293, "name": "stateChangeEmitters", "kind": 1024, "kindString": "Property", @@ -8419,7 +8481,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 39, + "line": 43, "character": 31 } ], @@ -8432,7 +8494,7 @@ }, { "type": "reference", - "id": 56, + "id": 74, "name": "Subscription" } ], @@ -8441,7 +8503,7 @@ "defaultValue": "new Map()" }, { - "id": 377, + "id": 406, "name": "_callRefreshToken", "kind": 2048, "kindString": "Method", @@ -8451,7 +8513,7 @@ }, "signatures": [ { - "id": 378, + "id": 407, "name": "_callRefreshToken", "kind": 4096, "kindString": "Call signature", @@ -8460,7 +8522,7 @@ }, "parameters": [ { - "id": 379, + "id": 408, "name": "refresh_token", "kind": 32768, "kindString": "Parameter", @@ -8492,7 +8554,7 @@ { "type": "reflection", "declaration": { - "id": 380, + "id": 409, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -8501,7 +8563,7 @@ }, "children": [ { - "id": 381, + "id": 410, "name": "data", "kind": 32, "kindString": "Variable", @@ -8511,18 +8573,18 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 402, - "character": 21 + "line": 411, + "character": 19 } ], "type": { "type": "reference", - "id": 27, + "id": 45, "name": "Session" } }, { - "id": 382, + "id": 411, "name": "error", "kind": 32, "kindString": "Variable", @@ -8532,8 +8594,8 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 402, - "character": 28 + "line": 411, + "character": 26 } ], "type": { @@ -8548,8 +8610,8 @@ "title": "Variables", "kind": 32, "children": [ - 381, - 382 + 410, + 411 ] } ] @@ -8558,7 +8620,7 @@ { "type": "reflection", "declaration": { - "id": 383, + "id": 412, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -8567,7 +8629,7 @@ }, "children": [ { - "id": 384, + "id": 413, "name": "data", "kind": 32, "kindString": "Variable", @@ -8577,7 +8639,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 407, + "line": 413, "character": 19 } ], @@ -8588,7 +8650,7 @@ "defaultValue": "null" }, { - "id": 385, + "id": 414, "name": "error", "kind": 32, "kindString": "Variable", @@ -8598,7 +8660,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 407, + "line": 413, "character": 32 } ], @@ -8613,8 +8675,8 @@ "title": "Variables", "kind": 32, "children": [ - 384, - 385 + 413, + 414 ] } ] @@ -8630,13 +8692,13 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 381, + "line": 388, "character": 33 } ] }, { - "id": 341, + "id": 370, "name": "_handleEmailSignIn", "kind": 2048, "kindString": "Method", @@ -8646,7 +8708,7 @@ }, "signatures": [ { - "id": 342, + "id": 371, "name": "_handleEmailSignIn", "kind": 4096, "kindString": "Call signature", @@ -8655,7 +8717,7 @@ }, "parameters": [ { - "id": 343, + "id": 372, "name": "email", "kind": 32768, "kindString": "Parameter", @@ -8668,7 +8730,7 @@ } }, { - "id": 344, + "id": 373, "name": "password", "kind": 32768, "kindString": "Parameter", @@ -8690,7 +8752,7 @@ { "type": "reflection", "declaration": { - "id": 345, + "id": 374, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -8699,7 +8761,7 @@ }, "children": [ { - "id": 346, + "id": 375, "name": "data", "kind": 32, "kindString": "Variable", @@ -8709,18 +8771,18 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 295, + "line": 302, "character": 19 } ], "type": { "type": "reference", - "id": 27, + "id": 45, "name": "Session" } }, { - "id": 348, + "id": 377, "name": "error", "kind": 32, "kindString": "Variable", @@ -8730,7 +8792,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 295, + "line": 302, "character": 43 } ], @@ -8741,7 +8803,7 @@ "defaultValue": "null" }, { - "id": 347, + "id": 376, "name": "user", "kind": 32, "kindString": "Variable", @@ -8751,13 +8813,13 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 295, + "line": 302, "character": 25 } ], "type": { "type": "reference", - "id": 33, + "id": 51, "name": "User" }, "defaultValue": "data.user" @@ -8768,9 +8830,9 @@ "title": "Variables", "kind": 32, "children": [ - 346, - 348, - 347 + 375, + 377, + 376 ] } ] @@ -8779,7 +8841,7 @@ { "type": "reflection", "declaration": { - "id": 349, + "id": 378, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -8788,7 +8850,7 @@ }, "children": [ { - "id": 350, + "id": 379, "name": "data", "kind": 32, "kindString": "Variable", @@ -8798,7 +8860,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 297, + "line": 304, "character": 19 } ], @@ -8809,7 +8871,7 @@ "defaultValue": "null" }, { - "id": 352, + "id": 381, "name": "error", "kind": 32, "kindString": "Variable", @@ -8819,7 +8881,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 297, + "line": 304, "character": 44 } ], @@ -8829,7 +8891,7 @@ } }, { - "id": 351, + "id": 380, "name": "user", "kind": 32, "kindString": "Variable", @@ -8839,7 +8901,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 297, + "line": 304, "character": 31 } ], @@ -8855,9 +8917,9 @@ "title": "Variables", "kind": 32, "children": [ - 350, - 352, - 351 + 379, + 381, + 380 ] } ] @@ -8873,13 +8935,13 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 285, + "line": 292, "character": 34 } ] }, { - "id": 353, + "id": 382, "name": "_handleProviderSignIn", "kind": 2048, "kindString": "Method", @@ -8889,7 +8951,7 @@ }, "signatures": [ { - "id": 354, + "id": 383, "name": "_handleProviderSignIn", "kind": 4096, "kindString": "Call signature", @@ -8898,7 +8960,7 @@ }, "parameters": [ { - "id": 355, + "id": 384, "name": "provider", "kind": 32768, "kindString": "Parameter", @@ -8907,7 +8969,7 @@ }, "type": { "type": "reference", - "id": 72, + "id": 94, "name": "Provider" } } @@ -8918,7 +8980,7 @@ { "type": "reflection", "declaration": { - "id": 356, + "id": 385, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -8927,7 +8989,7 @@ }, "children": [ { - "id": 359, + "id": 388, "name": "data", "kind": 32, "kindString": "Variable", @@ -8937,7 +8999,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 309, + "line": 316, "character": 34 } ], @@ -8948,7 +9010,7 @@ "defaultValue": "null" }, { - "id": 361, + "id": 390, "name": "error", "kind": 32, "kindString": "Variable", @@ -8958,7 +9020,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 309, + "line": 316, "character": 59 } ], @@ -8969,7 +9031,7 @@ "defaultValue": "null" }, { - "id": 357, + "id": 386, "name": "provider", "kind": 32, "kindString": "Variable", @@ -8979,18 +9041,18 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 309, + "line": 316, "character": 23 } ], "type": { "type": "reference", - "id": 72, + "id": 94, "name": "Provider" } }, { - "id": 358, + "id": 387, "name": "url", "kind": 32, "kindString": "Variable", @@ -9000,7 +9062,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 309, + "line": 316, "character": 28 } ], @@ -9010,7 +9072,7 @@ } }, { - "id": 360, + "id": 389, "name": "user", "kind": 32, "kindString": "Variable", @@ -9020,7 +9082,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 309, + "line": 316, "character": 46 } ], @@ -9036,11 +9098,11 @@ "title": "Variables", "kind": 32, "children": [ - 359, - 361, - 357, - 358, - 360 + 388, + 390, + 386, + 387, + 389 ] } ] @@ -9049,7 +9111,7 @@ { "type": "reflection", "declaration": { - "id": 362, + "id": 391, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -9058,7 +9120,7 @@ }, "children": [ { - "id": 363, + "id": 392, "name": "data", "kind": 32, "kindString": "Variable", @@ -9068,8 +9130,8 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 313, - "character": 24 + "line": 320, + "character": 19 } ], "type": { @@ -9079,7 +9141,7 @@ "defaultValue": "null" }, { - "id": 365, + "id": 394, "name": "error", "kind": 32, "kindString": "Variable", @@ -9089,8 +9151,8 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 313, - "character": 49 + "line": 320, + "character": 44 } ], "type": { @@ -9099,7 +9161,7 @@ } }, { - "id": 364, + "id": 393, "name": "user", "kind": 32, "kindString": "Variable", @@ -9109,8 +9171,8 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 313, - "character": 36 + "line": 320, + "character": 31 } ], "type": { @@ -9125,9 +9187,9 @@ "title": "Variables", "kind": 32, "children": [ - 363, - 365, - 364 + 392, + 394, + 393 ] } ] @@ -9140,13 +9202,13 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 301, + "line": 308, "character": 31 } ] }, { - "id": 386, + "id": 415, "name": "_notifyAllSubscribers", "kind": 2048, "kindString": "Method", @@ -9156,7 +9218,7 @@ }, "signatures": [ { - "id": 387, + "id": 416, "name": "_notifyAllSubscribers", "kind": 4096, "kindString": "Call signature", @@ -9165,7 +9227,7 @@ }, "parameters": [ { - "id": 388, + "id": 417, "name": "event", "kind": 32768, "kindString": "Parameter", @@ -9174,7 +9236,7 @@ }, "type": { "type": "reference", - "id": 73, + "id": 95, "name": "AuthChangeEvent" } } @@ -9188,13 +9250,13 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 411, + "line": 417, "character": 31 } ] }, { - "id": 369, + "id": 398, "name": "_persistSession", "kind": 2048, "kindString": "Method", @@ -9204,7 +9266,7 @@ }, "signatures": [ { - "id": 370, + "id": 399, "name": "_persistSession", "kind": 4096, "kindString": "Call signature", @@ -9213,7 +9275,7 @@ }, "parameters": [ { - "id": 371, + "id": 400, "name": "currentSession", "kind": 32768, "kindString": "Parameter", @@ -9222,12 +9284,12 @@ }, "type": { "type": "reference", - "id": 27, + "id": 45, "name": "Session" } }, { - "id": 372, + "id": 401, "name": "secondsToExpiry", "kind": 32768, "kindString": "Parameter", @@ -9249,13 +9311,13 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 331, + "line": 338, "character": 25 } ] }, { - "id": 375, + "id": 404, "name": "_recoverSession", "kind": 2048, "kindString": "Method", @@ -9265,7 +9327,7 @@ }, "signatures": [ { - "id": 376, + "id": 405, "name": "_recoverSession", "kind": 4096, "kindString": "Call signature", @@ -9276,8 +9338,17 @@ "type": "reference", "typeArguments": [ { - "type": "intrinsic", - "name": "null" + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "intrinsic", + "name": "null" + } + ] } ], "name": "Promise" @@ -9287,13 +9358,13 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 344, + "line": 351, "character": 31 } ] }, { - "id": 373, + "id": 402, "name": "_removeSession", "kind": 2048, "kindString": "Method", @@ -9303,7 +9374,7 @@ }, "signatures": [ { - "id": 374, + "id": 403, "name": "_removeSession", "kind": 4096, "kindString": "Call signature", @@ -9325,13 +9396,13 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 338, + "line": 345, "character": 30 } ] }, { - "id": 366, + "id": 395, "name": "_saveSession", "kind": 2048, "kindString": "Method", @@ -9341,7 +9412,7 @@ }, "signatures": [ { - "id": 367, + "id": 396, "name": "_saveSession", "kind": 4096, "kindString": "Call signature", @@ -9350,7 +9421,7 @@ }, "parameters": [ { - "id": 368, + "id": 397, "name": "session", "kind": 32768, "kindString": "Parameter", @@ -9359,7 +9430,7 @@ }, "type": { "type": "reference", - "id": 27, + "id": 45, "name": "Session" } } @@ -9373,13 +9444,13 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 317, + "line": 324, "character": 22 } ] }, { - "id": 319, + "id": 348, "name": "getSessionFromUrl", "kind": 2048, "kindString": "Method", @@ -9388,7 +9459,7 @@ }, "signatures": [ { - "id": 320, + "id": 349, "name": "getSessionFromUrl", "kind": 4096, "kindString": "Call signature", @@ -9400,7 +9471,7 @@ }, "parameters": [ { - "id": 321, + "id": 350, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -9418,7 +9489,7 @@ { "type": "reflection", "declaration": { - "id": 322, + "id": 351, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -9427,7 +9498,7 @@ }, "children": [ { - "id": 323, + "id": 352, "name": "storeSession", "kind": 32, "kindString": "Variable", @@ -9441,7 +9512,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 205, + "line": 212, "character": 16 } ], @@ -9469,7 +9540,7 @@ "title": "Variables", "kind": 32, "children": [ - 323 + 352 ] } ] @@ -9485,7 +9556,7 @@ { "type": "reflection", "declaration": { - "id": 324, + "id": 353, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -9494,7 +9565,7 @@ }, "children": [ { - "id": 325, + "id": 354, "name": "data", "kind": 32, "kindString": "Variable", @@ -9504,7 +9575,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 206, + "line": 213, "character": 20 } ], @@ -9513,7 +9584,7 @@ "types": [ { "type": "reference", - "id": 27, + "id": 45, "name": "Session" }, { @@ -9524,7 +9595,7 @@ } }, { - "id": 326, + "id": 355, "name": "error", "kind": 32, "kindString": "Variable", @@ -9534,7 +9605,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 206, + "line": 213, "character": 43 } ], @@ -9558,15 +9629,15 @@ "title": "Variables", "kind": 32, "children": [ - 325, - 326 + 354, + 355 ] } ], "sources": [ { "fileName": "GoTrueClient.ts", - "line": 206, + "line": 213, "character": 14 } ] @@ -9580,13 +9651,13 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 204, + "line": 211, "character": 25 } ] }, { - "id": 331, + "id": 360, "name": "onAuthStateChange", "kind": 2048, "kindString": "Method", @@ -9595,7 +9666,7 @@ }, "signatures": [ { - "id": 332, + "id": 361, "name": "onAuthStateChange", "kind": 4096, "kindString": "Call signature", @@ -9608,7 +9679,7 @@ }, "parameters": [ { - "id": 333, + "id": 362, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -9618,7 +9689,7 @@ "type": { "type": "reflection", "declaration": { - "id": 334, + "id": 363, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -9627,7 +9698,7 @@ }, "signatures": [ { - "id": 335, + "id": 364, "name": "__call", "kind": 4096, "kindString": "Call signature", @@ -9636,7 +9707,7 @@ }, "parameters": [ { - "id": 336, + "id": 365, "name": "event", "kind": 32768, "kindString": "Parameter", @@ -9645,12 +9716,12 @@ }, "type": { "type": "reference", - "id": 73, + "id": 95, "name": "AuthChangeEvent" } }, { - "id": 337, + "id": 366, "name": "session", "kind": 32768, "kindString": "Parameter", @@ -9662,7 +9733,7 @@ "types": [ { "type": "reference", - "id": 27, + "id": 45, "name": "Session" }, { @@ -9682,7 +9753,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 266, + "line": 273, "character": 13 } ] @@ -9693,7 +9764,7 @@ "type": { "type": "reflection", "declaration": { - "id": 338, + "id": 367, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -9702,7 +9773,7 @@ }, "children": [ { - "id": 339, + "id": 368, "name": "data", "kind": 32, "kindString": "Variable", @@ -9712,7 +9783,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 267, + "line": 274, "character": 11 } ], @@ -9721,7 +9792,7 @@ "types": [ { "type": "reference", - "id": 56, + "id": 74, "name": "Subscription" }, { @@ -9732,7 +9803,7 @@ } }, { - "id": 340, + "id": 369, "name": "error", "kind": 32, "kindString": "Variable", @@ -9742,7 +9813,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 267, + "line": 274, "character": 39 } ], @@ -9766,15 +9837,15 @@ "title": "Variables", "kind": 32, "children": [ - 339, - 340 + 368, + 369 ] } ], "sources": [ { "fileName": "GoTrueClient.ts", - "line": 267, + "line": 274, "character": 4 } ] @@ -9785,13 +9856,13 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 265, + "line": 272, "character": 19 } ] }, { - "id": 306, + "id": 335, "name": "refreshSession", "kind": 2048, "kindString": "Method", @@ -9800,7 +9871,7 @@ }, "signatures": [ { - "id": 307, + "id": 336, "name": "refreshSession", "kind": 4096, "kindString": "Call signature", @@ -9816,7 +9887,7 @@ { "type": "reflection", "declaration": { - "id": 308, + "id": 337, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -9825,7 +9896,7 @@ }, "children": [ { - "id": 309, + "id": 338, "name": "data", "kind": 32, "kindString": "Variable", @@ -9835,7 +9906,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 160, + "line": 164, "character": 8 } ], @@ -9844,7 +9915,7 @@ "types": [ { "type": "reference", - "id": 27, + "id": 45, "name": "Session" }, { @@ -9855,7 +9926,7 @@ } }, { - "id": 311, + "id": 340, "name": "error", "kind": 32, "kindString": "Variable", @@ -9865,7 +9936,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 162, + "line": 166, "character": 9 } ], @@ -9884,7 +9955,7 @@ } }, { - "id": 310, + "id": 339, "name": "user", "kind": 32, "kindString": "Variable", @@ -9894,7 +9965,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 161, + "line": 165, "character": 8 } ], @@ -9903,7 +9974,7 @@ "types": [ { "type": "reference", - "id": 33, + "id": 51, "name": "User" }, { @@ -9919,16 +9990,16 @@ "title": "Variables", "kind": 32, "children": [ - 309, - 311, - 310 + 338, + 340, + 339 ] } ], "sources": [ { "fileName": "GoTrueClient.ts", - "line": 159, + "line": 163, "character": 34 } ] @@ -9942,13 +10013,13 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 159, + "line": 163, "character": 22 } ] }, { - "id": 304, + "id": 333, "name": "session", "kind": 2048, "kindString": "Method", @@ -9957,7 +10028,7 @@ }, "signatures": [ { - "id": 305, + "id": 334, "name": "session", "kind": 4096, "kindString": "Call signature", @@ -9972,7 +10043,7 @@ "types": [ { "type": "reference", - "id": 27, + "id": 45, "name": "Session" }, { @@ -9986,13 +10057,13 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 152, + "line": 156, "character": 9 } ] }, { - "id": 289, + "id": 318, "name": "signIn", "kind": 2048, "kindString": "Method", @@ -10001,7 +10072,7 @@ }, "signatures": [ { - "id": 290, + "id": 319, "name": "signIn", "kind": 4096, "kindString": "Call signature", @@ -10013,20 +10084,18 @@ }, "parameters": [ { - "id": 291, - "name": "credentials", + "id": 320, + "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, - "comment": { - "text": "The user login details." - }, + "originalName": "__0", "type": { "type": "reflection", "declaration": { - "id": 292, + "id": 321, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -10035,13 +10104,12 @@ }, "children": [ { - "id": 293, + "id": 322, "name": "email", "kind": 32, "kindString": "Variable", "flags": { - "isExported": true, - "isOptional": true + "isExported": true }, "comment": { "text": "The user's email address." @@ -10049,7 +10117,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 117, + "line": 121, "character": 9 } ], @@ -10068,13 +10136,12 @@ } }, { - "id": 294, + "id": 323, "name": "password", "kind": 32, "kindString": "Variable", "flags": { - "isExported": true, - "isOptional": true + "isExported": true }, "comment": { "text": "The user's password." @@ -10082,7 +10149,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 118, + "line": 122, "character": 12 } ], @@ -10101,13 +10168,12 @@ } }, { - "id": 295, + "id": 324, "name": "provider", "kind": 32, "kindString": "Variable", "flags": { - "isExported": true, - "isOptional": true + "isExported": true }, "comment": { "text": "One of the providers supported by GoTrue.\n" @@ -10115,14 +10181,42 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 119, + "line": 123, "character": 12 } ], "type": { - "type": "reference", - "id": 72, - "name": "Provider" + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "stringLiteral", + "value": "azure" + }, + { + "type": "stringLiteral", + "value": "bitbucket" + }, + { + "type": "stringLiteral", + "value": "facebook" + }, + { + "type": "stringLiteral", + "value": "github" + }, + { + "type": "stringLiteral", + "value": "gitlab" + }, + { + "type": "stringLiteral", + "value": "google" + } + ] } } ], @@ -10131,17 +10225,17 @@ "title": "Variables", "kind": 32, "children": [ - 293, - 294, - 295 + 322, + 323, + 324 ] } ], "sources": [ { "fileName": "GoTrueClient.ts", - "line": 116, - "character": 27 + "line": 120, + "character": 15 } ] } @@ -10154,7 +10248,7 @@ { "type": "reflection", "declaration": { - "id": 296, + "id": 325, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -10163,7 +10257,7 @@ }, "children": [ { - "id": 297, + "id": 326, "name": "data", "kind": 32, "kindString": "Variable", @@ -10173,7 +10267,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 121, + "line": 125, "character": 8 } ], @@ -10182,7 +10276,7 @@ "types": [ { "type": "reference", - "id": 27, + "id": 45, "name": "Session" }, { @@ -10193,7 +10287,7 @@ } }, { - "id": 301, + "id": 330, "name": "error", "kind": 32, "kindString": "Variable", @@ -10203,7 +10297,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 125, + "line": 129, "character": 9 } ], @@ -10222,7 +10316,7 @@ } }, { - "id": 299, + "id": 328, "name": "provider", "kind": 32, "kindString": "Variable", @@ -10233,18 +10327,18 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 123, + "line": 127, "character": 12 } ], "type": { "type": "reference", - "id": 72, + "id": 94, "name": "Provider" } }, { - "id": 300, + "id": 329, "name": "url", "kind": 32, "kindString": "Variable", @@ -10255,7 +10349,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 124, + "line": 128, "character": 7 } ], @@ -10274,7 +10368,7 @@ } }, { - "id": 298, + "id": 327, "name": "user", "kind": 32, "kindString": "Variable", @@ -10284,7 +10378,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 122, + "line": 126, "character": 8 } ], @@ -10293,7 +10387,7 @@ "types": [ { "type": "reference", - "id": 33, + "id": 51, "name": "User" }, { @@ -10309,19 +10403,19 @@ "title": "Variables", "kind": 32, "children": [ - 297, - 301, - 299, - 300, - 298 + 326, + 330, + 328, + 329, + 327 ] } ], "sources": [ { "fileName": "GoTrueClient.ts", - "line": 120, - "character": 14 + "line": 124, + "character": 31 } ] } @@ -10334,13 +10428,13 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 116, + "line": 120, "character": 14 } ] }, { - "id": 327, + "id": 356, "name": "signOut", "kind": 2048, "kindString": "Method", @@ -10349,7 +10443,7 @@ }, "signatures": [ { - "id": 328, + "id": 357, "name": "signOut", "kind": 4096, "kindString": "Call signature", @@ -10365,7 +10459,7 @@ { "type": "reflection", "declaration": { - "id": 329, + "id": 358, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -10374,7 +10468,7 @@ }, "children": [ { - "id": 330, + "id": 359, "name": "error", "kind": 32, "kindString": "Variable", @@ -10384,7 +10478,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 251, + "line": 258, "character": 34 } ], @@ -10408,14 +10502,14 @@ "title": "Variables", "kind": 32, "children": [ - 330 + 359 ] } ], "sources": [ { "fileName": "GoTrueClient.ts", - "line": 251, + "line": 258, "character": 27 } ] @@ -10429,13 +10523,13 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 251, + "line": 258, "character": 15 } ] }, { - "id": 279, + "id": 308, "name": "signUp", "kind": 2048, "kindString": "Method", @@ -10444,7 +10538,7 @@ }, "signatures": [ { - "id": 280, + "id": 309, "name": "signUp", "kind": 4096, "kindString": "Call signature", @@ -10456,20 +10550,18 @@ }, "parameters": [ { - "id": 281, - "name": "credentials", + "id": 310, + "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, - "comment": { - "text": "The user login details." - }, + "originalName": "__0", "type": { "type": "reflection", "declaration": { - "id": 282, + "id": 311, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -10478,7 +10570,7 @@ }, "children": [ { - "id": 283, + "id": 312, "name": "email", "kind": 32, "kindString": "Variable", @@ -10491,17 +10583,26 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 89, + "line": 93, "character": 9 } ], "type": { - "type": "intrinsic", - "name": "string" + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "intrinsic", + "name": "string" + } + ] } }, { - "id": 284, + "id": 313, "name": "password", "kind": 32, "kindString": "Variable", @@ -10514,13 +10615,22 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 90, + "line": 94, "character": 12 } ], "type": { - "type": "intrinsic", - "name": "string" + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "intrinsic", + "name": "string" + } + ] } } ], @@ -10529,16 +10639,16 @@ "title": "Variables", "kind": 32, "children": [ - 283, - 284 + 312, + 313 ] } ], "sources": [ { "fileName": "GoTrueClient.ts", - "line": 88, - "character": 27 + "line": 92, + "character": 15 } ] } @@ -10551,7 +10661,7 @@ { "type": "reflection", "declaration": { - "id": 285, + "id": 314, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -10560,7 +10670,7 @@ }, "children": [ { - "id": 286, + "id": 315, "name": "data", "kind": 32, "kindString": "Variable", @@ -10570,8 +10680,8 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 91, - "character": 20 + "line": 95, + "character": 37 } ], "type": { @@ -10579,7 +10689,7 @@ "types": [ { "type": "reference", - "id": 27, + "id": 45, "name": "Session" }, { @@ -10590,7 +10700,7 @@ } }, { - "id": 288, + "id": 317, "name": "error", "kind": 32, "kindString": "Variable", @@ -10600,8 +10710,8 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 91, - "character": 62 + "line": 95, + "character": 79 } ], "type": { @@ -10619,7 +10729,7 @@ } }, { - "id": 287, + "id": 316, "name": "user", "kind": 32, "kindString": "Variable", @@ -10629,8 +10739,8 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 91, - "character": 42 + "line": 95, + "character": 59 } ], "type": { @@ -10638,7 +10748,7 @@ "types": [ { "type": "reference", - "id": 33, + "id": 51, "name": "User" }, { @@ -10654,17 +10764,17 @@ "title": "Variables", "kind": 32, "children": [ - 286, - 288, - 287 + 315, + 317, + 316 ] } ], "sources": [ { "fileName": "GoTrueClient.ts", - "line": 91, - "character": 14 + "line": 95, + "character": 31 } ] } @@ -10677,13 +10787,13 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 88, + "line": 92, "character": 14 } ] }, { - "id": 312, + "id": 341, "name": "update", "kind": 2048, "kindString": "Method", @@ -10692,7 +10802,7 @@ }, "signatures": [ { - "id": 313, + "id": 342, "name": "update", "kind": 4096, "kindString": "Call signature", @@ -10704,7 +10814,7 @@ }, "parameters": [ { - "id": 314, + "id": 343, "name": "attributes", "kind": 32768, "kindString": "Parameter", @@ -10713,7 +10823,7 @@ }, "type": { "type": "reference", - "id": 51, + "id": 69, "name": "UserAttributes" } } @@ -10724,7 +10834,7 @@ { "type": "reflection", "declaration": { - "id": 315, + "id": 344, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -10733,7 +10843,7 @@ }, "children": [ { - "id": 316, + "id": 345, "name": "data", "kind": 32, "kindString": "Variable", @@ -10743,7 +10853,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 184, + "line": 188, "character": 19 } ], @@ -10752,7 +10862,7 @@ "types": [ { "type": "reference", - "id": 33, + "id": 51, "name": "User" }, { @@ -10763,7 +10873,7 @@ } }, { - "id": 318, + "id": 347, "name": "error", "kind": 32, "kindString": "Variable", @@ -10773,7 +10883,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 184, + "line": 188, "character": 58 } ], @@ -10792,7 +10902,7 @@ } }, { - "id": 317, + "id": 346, "name": "user", "kind": 32, "kindString": "Variable", @@ -10802,7 +10912,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 184, + "line": 188, "character": 38 } ], @@ -10811,7 +10921,7 @@ "types": [ { "type": "reference", - "id": 33, + "id": 51, "name": "User" }, { @@ -10827,16 +10937,16 @@ "title": "Variables", "kind": 32, "children": [ - 316, - 318, - 317 + 345, + 347, + 346 ] } ], "sources": [ { "fileName": "GoTrueClient.ts", - "line": 184, + "line": 188, "character": 13 } ] @@ -10850,13 +10960,13 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 182, + "line": 186, "character": 14 } ] }, { - "id": 302, + "id": 331, "name": "user", "kind": 2048, "kindString": "Method", @@ -10865,7 +10975,7 @@ }, "signatures": [ { - "id": 303, + "id": 332, "name": "user", "kind": 4096, "kindString": "Call signature", @@ -10880,7 +10990,7 @@ "types": [ { "type": "reference", - "id": 33, + "id": 51, "name": "User" }, { @@ -10894,7 +11004,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 145, + "line": 149, "character": 6 } ] @@ -10905,56 +11015,56 @@ "title": "Constructors", "kind": 512, "children": [ - 265 + 294 ] }, { "title": "Properties", "kind": 1024, "children": [ - 258, - 261, - 260, - 259, - 263, - 262, - 264 + 287, + 290, + 289, + 288, + 292, + 291, + 293 ] }, { "title": "Methods", "kind": 2048, "children": [ - 377, + 406, + 370, + 382, + 415, + 398, + 404, + 402, + 395, + 348, + 360, + 335, + 333, + 318, + 356, + 308, 341, - 353, - 386, - 369, - 375, - 373, - 366, - 319, - 331, - 306, - 304, - 289, - 327, - 279, - 312, - 302 + 331 ] } ], "sources": [ { "fileName": "GoTrueClient.ts", - "line": 22, + "line": 26, "character": 33 } ] }, { - "id": 389, + "id": 418, "name": "DEFAULT_OPTIONS", "kind": 2097152, "kindString": "Object literal", @@ -10963,7 +11073,7 @@ }, "children": [ { - "id": 391, + "id": 420, "name": "autoRefreshToken", "kind": 32, "kindString": "Variable", @@ -10971,7 +11081,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 16, + "line": 20, "character": 18 } ], @@ -10982,7 +11092,7 @@ "defaultValue": "true" }, { - "id": 394, + "id": 423, "name": "detectSessionInUrl", "kind": 32, "kindString": "Variable", @@ -10990,7 +11100,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 19, + "line": 23, "character": 20 } ], @@ -11001,7 +11111,7 @@ "defaultValue": "true" }, { - "id": 395, + "id": 424, "name": "headers", "kind": 32, "kindString": "Variable", @@ -11009,14 +11119,14 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 20, + "line": 24, "character": 9 } ], "type": { "type": "reflection", "declaration": { - "id": 396, + "id": 425, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -11026,7 +11136,7 @@ "defaultValue": "DEFAULT_HEADERS" }, { - "id": 393, + "id": 422, "name": "localStorage", "kind": 32, "kindString": "Variable", @@ -11034,7 +11144,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 18, + "line": 22, "character": 14 } ], @@ -11045,7 +11155,7 @@ "defaultValue": "globalThis.localStorage" }, { - "id": 392, + "id": 421, "name": "persistSession", "kind": 32, "kindString": "Variable", @@ -11053,7 +11163,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 17, + "line": 21, "character": 16 } ], @@ -11064,7 +11174,7 @@ "defaultValue": "true" }, { - "id": 390, + "id": 419, "name": "url", "kind": 32, "kindString": "Variable", @@ -11072,7 +11182,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 15, + "line": 19, "character": 5 } ], @@ -11088,19 +11198,19 @@ "title": "Variables", "kind": 32, "children": [ - 391, - 394, - 395, - 393, - 392, - 390 + 420, + 423, + 424, + 422, + 421, + 419 ] } ], "sources": [ { "fileName": "GoTrueClient.ts", - "line": 14, + "line": 18, "character": 21 } ], @@ -11115,14 +11225,14 @@ "title": "Classes", "kind": 128, "children": [ - 257 + 286 ] }, { "title": "Object literals", "kind": 2097152, "children": [ - 389 + 418 ] } ], @@ -11135,7 +11245,7 @@ ] }, { - "id": 397, + "id": 426, "name": "\"index\"", "kind": 1, "kindString": "Module", @@ -11145,74 +11255,84 @@ "originalName": "/home/runner/work/gotrue-js/gotrue-js/src/index.ts", "children": [ { - "id": 399, + "id": 428, "name": "AuthChangeEvent", "kind": 16777216, "kindString": "Reference", "flags": { "isExported": true }, - "target": 73 + "target": 95 }, { - "id": 404, + "id": 433, "name": "CookieOptions", "kind": 16777216, "kindString": "Reference", "flags": { "isExported": true }, - "target": 66 + "target": 84 }, { - "id": 398, + "id": 427, "name": "Provider", "kind": 16777216, "kindString": "Reference", "flags": { "isExported": true }, - "target": 72 + "target": 94 }, { - "id": 400, + "id": 429, "name": "Session", "kind": 16777216, "kindString": "Reference", "flags": { "isExported": true }, - "target": 27 + "target": 45 }, { - "id": 403, + "id": 432, "name": "Subscription", "kind": 16777216, "kindString": "Reference", "flags": { "isExported": true }, - "target": 56 + "target": 74 }, { - "id": 401, + "id": 430, "name": "User", "kind": 16777216, "kindString": "Reference", "flags": { "isExported": true }, - "target": 33 + "target": 51 }, { - "id": 402, + "id": 431, "name": "UserAttributes", "kind": 16777216, "kindString": "Reference", "flags": { "isExported": true }, - "target": 51 + "target": 69 + }, + { + "id": 434, + "name": "UserCredentials", + "kind": 16777216, + "kindString": "Reference", + "flags": { + "isExported": true + }, + "target": 90 } ], "groups": [ @@ -11220,13 +11340,14 @@ "title": "References", "kind": 16777216, "children": [ - 399, - 404, - 398, - 400, - 403, - 401, - 402 + 428, + 433, + 427, + 429, + 432, + 430, + 431, + 434 ] } ], @@ -11239,7 +11360,7 @@ ] }, { - "id": 74, + "id": 96, "name": "\"lib/constants\"", "kind": 1, "kindString": "Module", @@ -11249,7 +11370,7 @@ "originalName": "/home/runner/work/gotrue-js/gotrue-js/src/lib/constants.ts", "children": [ { - "id": 76, + "id": 98, "name": "AUDIENCE", "kind": 32, "kindString": "Variable", @@ -11265,13 +11386,13 @@ } ], "type": { - "type": "intrinsic", - "name": "string" + "type": "stringLiteral", + "value": "" }, - "defaultValue": "process?.env?.AUDIENCE || ''" + "defaultValue": "\"\"" }, { - "id": 77, + "id": 99, "name": "DEFAULT_HEADERS", "kind": 32, "kindString": "Variable", @@ -11289,7 +11410,7 @@ "type": { "type": "reflection", "declaration": { - "id": 78, + "id": 100, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -11300,7 +11421,7 @@ } }, { - "id": 79, + "id": 101, "name": "EXPIRY_MARGIN", "kind": 32, "kindString": "Variable", @@ -11316,22 +11437,13 @@ } ], "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "number" - } - ] + "type": "intrinsic", + "name": "number" }, - "defaultValue": "process?.env?.EXPIRY_MARGIN || 60 * 1000" + "defaultValue": "60 * 1000" }, { - "id": 75, + "id": 97, "name": "GOTRUE_URL", "kind": 32, "kindString": "Variable", @@ -11347,13 +11459,13 @@ } ], "type": { - "type": "intrinsic", - "name": "string" + "type": "stringLiteral", + "value": "http://localhost:9999" }, - "defaultValue": "process?.env?.GOTRUE_URL || 'http://localhost:9999'" + "defaultValue": "\"http://localhost:9999\"" }, { - "id": 80, + "id": 102, "name": "STORAGE_KEY", "kind": 32, "kindString": "Variable", @@ -11369,13 +11481,13 @@ } ], "type": { - "type": "intrinsic", - "name": "string" + "type": "stringLiteral", + "value": "supabase.auth.token" }, - "defaultValue": "process?.env?.STORAGE_KEY || 'supabase.auth.token'" + "defaultValue": "\"supabase.auth.token\"" }, { - "id": 81, + "id": 103, "name": "COOKIE_OPTIONS", "kind": 2097152, "kindString": "Object literal", @@ -11385,7 +11497,7 @@ }, "children": [ { - "id": 84, + "id": 106, "name": "domain", "kind": 32, "kindString": "Variable", @@ -11406,7 +11518,7 @@ "defaultValue": "\"\"" }, { - "id": 83, + "id": 105, "name": "lifetime", "kind": 32, "kindString": "Variable", @@ -11427,7 +11539,7 @@ "defaultValue": "60 * 60 * 8" }, { - "id": 82, + "id": 104, "name": "name", "kind": 32, "kindString": "Variable", @@ -11448,7 +11560,7 @@ "defaultValue": "\"sb:token\"" }, { - "id": 85, + "id": 107, "name": "path", "kind": 32, "kindString": "Variable", @@ -11469,7 +11581,7 @@ "defaultValue": "\"/\"" }, { - "id": 86, + "id": 108, "name": "sameSite", "kind": 32, "kindString": "Variable", @@ -11495,11 +11607,11 @@ "title": "Variables", "kind": 32, "children": [ - 84, - 83, - 82, - 85, - 86 + 106, + 105, + 104, + 107, + 108 ] } ], @@ -11521,18 +11633,18 @@ "title": "Variables", "kind": 32, "children": [ - 76, - 77, - 79, - 75, - 80 + 98, + 99, + 101, + 97, + 102 ] }, { "title": "Object literals", "kind": 2097152, "children": [ - 81 + 103 ] } ], @@ -11545,7 +11657,7 @@ ] }, { - "id": 87, + "id": 109, "name": "\"lib/cookies\"", "kind": 1, "kindString": "Module", @@ -11555,7 +11667,7 @@ "originalName": "/home/runner/work/gotrue-js/gotrue-js/src/lib/cookies.ts", "children": [ { - "id": 88, + "id": 110, "name": "Cookie", "kind": 4194304, "kindString": "Type alias", @@ -11570,14 +11682,14 @@ "type": { "type": "reflection", "declaration": { - "id": 89, + "id": 111, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 93, + "id": 115, "name": "domain", "kind": 32, "kindString": "Variable", @@ -11606,7 +11718,7 @@ } }, { - "id": 92, + "id": 114, "name": "maxAge", "kind": 32, "kindString": "Variable", @@ -11624,7 +11736,7 @@ } }, { - "id": 90, + "id": 112, "name": "name", "kind": 32, "kindString": "Variable", @@ -11642,7 +11754,7 @@ } }, { - "id": 94, + "id": 116, "name": "path", "kind": 32, "kindString": "Variable", @@ -11671,7 +11783,7 @@ } }, { - "id": 95, + "id": 117, "name": "sameSite", "kind": 32, "kindString": "Variable", @@ -11700,7 +11812,7 @@ } }, { - "id": 91, + "id": 113, "name": "value", "kind": 32, "kindString": "Variable", @@ -11723,12 +11835,12 @@ "title": "Variables", "kind": 32, "children": [ - 93, - 92, - 90, - 94, - 95, - 91 + 115, + 114, + 112, + 116, + 117, + 113 ] } ], @@ -11743,7 +11855,7 @@ } }, { - "id": 126, + "id": 148, "name": "deleteCookie", "kind": 64, "kindString": "Function", @@ -11752,7 +11864,7 @@ }, "signatures": [ { - "id": 127, + "id": 149, "name": "deleteCookie", "kind": 4096, "kindString": "Call signature", @@ -11761,7 +11873,7 @@ }, "parameters": [ { - "id": 128, + "id": 150, "name": "req", "kind": 32768, "kindString": "Parameter", @@ -11774,7 +11886,7 @@ } }, { - "id": 129, + "id": 151, "name": "res", "kind": 32768, "kindString": "Parameter", @@ -11787,7 +11899,7 @@ } }, { - "id": 130, + "id": 152, "name": "name", "kind": 32768, "kindString": "Parameter", @@ -11815,14 +11927,14 @@ ] }, { - "id": 109, + "id": 131, "name": "isSecureEnvironment", "kind": 64, "kindString": "Function", "flags": {}, "signatures": [ { - "id": 110, + "id": 132, "name": "isSecureEnvironment", "kind": 4096, "kindString": "Call signature", @@ -11832,7 +11944,7 @@ }, "parameters": [ { - "id": 111, + "id": 133, "name": "req", "kind": 32768, "kindString": "Parameter", @@ -11858,14 +11970,14 @@ ] }, { - "id": 96, + "id": 118, "name": "serialize", "kind": 64, "kindString": "Function", "flags": {}, "signatures": [ { - "id": 97, + "id": 119, "name": "serialize", "kind": 4096, "kindString": "Call signature", @@ -11875,7 +11987,7 @@ }, "parameters": [ { - "id": 98, + "id": 120, "name": "name", "kind": 32768, "kindString": "Parameter", @@ -11886,7 +11998,7 @@ } }, { - "id": 99, + "id": 121, "name": "val", "kind": 32768, "kindString": "Parameter", @@ -11897,7 +12009,7 @@ } }, { - "id": 100, + "id": 122, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -11905,14 +12017,14 @@ "type": { "type": "reflection", "declaration": { - "id": 101, + "id": 123, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 103, + "id": 125, "name": "domain", "kind": 32, "kindString": "Variable", @@ -11930,7 +12042,7 @@ } }, { - "id": 105, + "id": 127, "name": "expires", "kind": 32, "kindString": "Variable", @@ -11948,7 +12060,7 @@ } }, { - "id": 106, + "id": 128, "name": "httpOnly", "kind": 32, "kindString": "Variable", @@ -11966,7 +12078,7 @@ } }, { - "id": 102, + "id": 124, "name": "maxAge", "kind": 32, "kindString": "Variable", @@ -11984,7 +12096,7 @@ } }, { - "id": 104, + "id": 126, "name": "path", "kind": 32, "kindString": "Variable", @@ -12002,7 +12114,7 @@ } }, { - "id": 108, + "id": 130, "name": "sameSite", "kind": 32, "kindString": "Variable", @@ -12020,7 +12132,7 @@ } }, { - "id": 107, + "id": 129, "name": "secure", "kind": 32, "kindString": "Variable", @@ -12043,13 +12155,13 @@ "title": "Variables", "kind": 32, "children": [ - 103, - 105, - 106, - 102, - 104, - 108, - 107 + 125, + 127, + 128, + 124, + 126, + 130, + 129 ] } ], @@ -12079,14 +12191,14 @@ ] }, { - "id": 112, + "id": 134, "name": "serializeCookie", "kind": 64, "kindString": "Function", "flags": {}, "signatures": [ { - "id": 113, + "id": 135, "name": "serializeCookie", "kind": 4096, "kindString": "Call signature", @@ -12096,19 +12208,19 @@ }, "parameters": [ { - "id": 114, + "id": 136, "name": "cookie", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 88, + "id": 110, "name": "Cookie" } }, { - "id": 115, + "id": 137, "name": "secure", "kind": 32768, "kindString": "Parameter", @@ -12134,7 +12246,7 @@ ] }, { - "id": 121, + "id": 143, "name": "setCookie", "kind": 64, "kindString": "Function", @@ -12143,7 +12255,7 @@ }, "signatures": [ { - "id": 122, + "id": 144, "name": "setCookie", "kind": 4096, "kindString": "Call signature", @@ -12155,7 +12267,7 @@ }, "parameters": [ { - "id": 123, + "id": 145, "name": "req", "kind": 32768, "kindString": "Parameter", @@ -12168,7 +12280,7 @@ } }, { - "id": 124, + "id": 146, "name": "res", "kind": 32768, "kindString": "Parameter", @@ -12181,7 +12293,7 @@ } }, { - "id": 125, + "id": 147, "name": "cookie", "kind": 32768, "kindString": "Parameter", @@ -12190,7 +12302,7 @@ }, "type": { "type": "reference", - "id": 88, + "id": 110, "name": "Cookie" } } @@ -12210,7 +12322,7 @@ ] }, { - "id": 116, + "id": 138, "name": "setCookies", "kind": 64, "kindString": "Function", @@ -12219,7 +12331,7 @@ }, "signatures": [ { - "id": 117, + "id": 139, "name": "setCookies", "kind": 4096, "kindString": "Call signature", @@ -12231,7 +12343,7 @@ }, "parameters": [ { - "id": 118, + "id": 140, "name": "req", "kind": 32768, "kindString": "Parameter", @@ -12244,7 +12356,7 @@ } }, { - "id": 119, + "id": 141, "name": "res", "kind": 32768, "kindString": "Parameter", @@ -12257,7 +12369,7 @@ } }, { - "id": 120, + "id": 142, "name": "cookies", "kind": 32768, "kindString": "Parameter", @@ -12269,7 +12381,7 @@ "typeArguments": [ { "type": "reference", - "id": 88, + "id": 110, "name": "Cookie" } ], @@ -12297,19 +12409,19 @@ "title": "Type aliases", "kind": 4194304, "children": [ - 88 + 110 ] }, { "title": "Functions", "kind": 64, "children": [ - 126, - 109, - 96, - 112, - 121, - 116 + 148, + 131, + 118, + 134, + 143, + 138 ] } ], @@ -12462,75 +12574,41 @@ ] }, { - "id": 12, - "name": "get", - "kind": 64, - "kindString": "Function", + "id": 8, + "name": "RequestMethodType", + "kind": 4194304, + "kindString": "Type alias", "flags": { "isExported": true }, - "signatures": [ - { - "id": 13, - "name": "get", - "kind": 4096, - "kindString": "Call signature", - "flags": { - "isExported": true - }, - "parameters": [ - { - "id": 14, - "name": "url", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isExported": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 15, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isExported": true, - "isOptional": true - }, - "type": { - "type": "reference", - "id": 2, - "name": "FetchOptions" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "Promise" - } - } - ], "sources": [ { "fileName": "lib/fetch.ts", - "line": 22, - "character": 25 + "line": 10, + "character": 29 } - ] + ], + "type": { + "type": "union", + "types": [ + { + "type": "stringLiteral", + "value": "GET" + }, + { + "type": "stringLiteral", + "value": "POST" + }, + { + "type": "stringLiteral", + "value": "PUT" + } + ] + } }, { - "id": 8, - "name": "handleError", + "id": 9, + "name": "_getErrorMessage", "kind": 64, "kindString": "Function", "flags": { @@ -12538,26 +12616,15 @@ }, "signatures": [ { - "id": 9, - "name": "handleError", + "id": 10, + "name": "_getErrorMessage", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ - { - "id": 10, - "name": "error", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - }, { "id": 11, - "name": "reject", + "name": "msg", "kind": 32768, "kindString": "Parameter", "flags": {}, @@ -12569,69 +12636,52 @@ ], "type": { "type": "intrinsic", - "name": "any" + "name": "string" } } ], "sources": [ { "fileName": "lib/fetch.ts", - "line": 10, - "character": 17 + "line": 12, + "character": 22 } ] }, { "id": 16, - "name": "post", + "name": "_getRequestParams", "kind": 64, "kindString": "Function", "flags": { - "isExported": true + "isConst": true }, "signatures": [ { "id": 17, - "name": "post", + "name": "_getRequestParams", "kind": 4096, "kindString": "Call signature", - "flags": { - "isExported": true - }, + "flags": {}, "parameters": [ { "id": 18, - "name": "url", + "name": "method", "kind": 32768, "kindString": "Parameter", - "flags": { - "isExported": true - }, + "flags": {}, "type": { - "type": "intrinsic", - "name": "string" + "type": "reference", + "id": 8, + "name": "RequestMethodType" } }, { "id": 19, - "name": "body", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isExported": true - }, - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 20, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { - "isExported": true, "isOptional": true }, "type": { @@ -12639,6 +12689,148 @@ "id": 2, "name": "FetchOptions" } + }, + { + "id": 20, + "name": "body", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "intrinsic", + "name": "object" + } + ] + } + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 21, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "indexSignature": [ + { + "id": 22, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 23, + "name": "k", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ] + } + } + } + ], + "sources": [ + { + "fileName": "lib/fetch.ts", + "line": 24, + "character": 23 + } + ] + }, + { + "id": 24, + "name": "_handleRequest", + "kind": 64, + "kindString": "Function", + "flags": {}, + "signatures": [ + { + "id": 25, + "name": "_handleRequest", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 26, + "name": "method", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 8, + "name": "RequestMethodType" + } + }, + { + "id": 27, + "name": "url", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 28, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "id": 2, + "name": "FetchOptions" + } + }, + { + "id": 29, + "name": "body", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "intrinsic", + "name": "object" + } + ] + } } ], "type": { @@ -12657,13 +12849,13 @@ { "fileName": "lib/fetch.ts", "line": 37, - "character": 26 + "character": 29 } ] }, { - "id": 21, - "name": "put", + "id": 30, + "name": "get", "kind": 64, "kindString": "Function", "flags": { @@ -12671,8 +12863,8 @@ }, "signatures": [ { - "id": 22, - "name": "put", + "id": 31, + "name": "get", "kind": 4096, "kindString": "Call signature", "flags": { @@ -12680,7 +12872,7 @@ }, "parameters": [ { - "id": 23, + "id": 32, "name": "url", "kind": 32768, "kindString": "Parameter", @@ -12693,20 +12885,7 @@ } }, { - "id": 24, - "name": "body", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isExported": true - }, - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 25, + "id": 33, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -12736,7 +12915,220 @@ "sources": [ { "fileName": "lib/fetch.ts", - "line": 53, + "line": 55, + "character": 25 + } + ] + }, + { + "id": 12, + "name": "handleError", + "kind": 64, + "kindString": "Function", + "flags": { + "isConst": true + }, + "signatures": [ + { + "id": 13, + "name": "handleError", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 14, + "name": "error", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 15, + "name": "reject", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "sources": [ + { + "fileName": "lib/fetch.ts", + "line": 15, + "character": 17 + } + ] + }, + { + "id": 34, + "name": "post", + "kind": 64, + "kindString": "Function", + "flags": { + "isExported": true + }, + "signatures": [ + { + "id": 35, + "name": "post", + "kind": 4096, + "kindString": "Call signature", + "flags": { + "isExported": true + }, + "parameters": [ + { + "id": 36, + "name": "url", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 37, + "name": "body", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "type": { + "type": "intrinsic", + "name": "object" + } + }, + { + "id": 38, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true, + "isOptional": true + }, + "type": { + "type": "reference", + "id": 2, + "name": "FetchOptions" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "any" + } + ], + "name": "Promise" + } + } + ], + "sources": [ + { + "fileName": "lib/fetch.ts", + "line": 59, + "character": 26 + } + ] + }, + { + "id": 39, + "name": "put", + "kind": 64, + "kindString": "Function", + "flags": { + "isExported": true + }, + "signatures": [ + { + "id": 40, + "name": "put", + "kind": 4096, + "kindString": "Call signature", + "flags": { + "isExported": true + }, + "parameters": [ + { + "id": 41, + "name": "url", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 42, + "name": "body", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "type": { + "type": "intrinsic", + "name": "object" + } + }, + { + "id": 43, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true, + "isOptional": true + }, + "type": { + "type": "reference", + "id": 2, + "name": "FetchOptions" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "any" + } + ], + "name": "Promise" + } + } + ], + "sources": [ + { + "fileName": "lib/fetch.ts", + "line": 63, "character": 25 } ] @@ -12750,14 +13142,24 @@ 2 ] }, + { + "title": "Type aliases", + "kind": 4194304, + "children": [ + 8 + ] + }, { "title": "Functions", "kind": 64, "children": [ - 12, - 8, + 9, 16, - 21 + 24, + 30, + 12, + 34, + 39 ] } ], @@ -12770,7 +13172,7 @@ ] }, { - "id": 224, + "id": 250, "name": "\"lib/helpers\"", "kind": 1, "kindString": "Module", @@ -12780,7 +13182,7 @@ "originalName": "/home/runner/work/gotrue-js/gotrue-js/src/lib/helpers.ts", "children": [ { - "id": 225, + "id": 251, "name": "LocalStorage", "kind": 128, "kindString": "Class", @@ -12789,7 +13191,7 @@ }, "indexSignature": [ { - "id": 227, + "id": 253, "name": "__index", "kind": 8192, "kindString": "Index signature", @@ -12798,7 +13200,7 @@ }, "parameters": [ { - "id": 228, + "id": 254, "name": "name", "kind": 32768, "kindString": "Parameter", @@ -12819,7 +13221,7 @@ ], "children": [ { - "id": 230, + "id": 256, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -12828,7 +13230,7 @@ }, "signatures": [ { - "id": 231, + "id": 257, "name": "new LocalStorage", "kind": 16384, "kindString": "Constructor signature", @@ -12837,7 +13239,7 @@ }, "parameters": [ { - "id": 232, + "id": 258, "name": "localStorage", "kind": 32768, "kindString": "Parameter", @@ -12852,7 +13254,7 @@ ], "type": { "type": "reference", - "id": 225, + "id": 251, "name": "LocalStorage" } } @@ -12866,7 +13268,7 @@ ] }, { - "id": 229, + "id": 255, "name": "length", "kind": 1024, "kindString": "Property", @@ -12886,7 +13288,7 @@ } }, { - "id": 226, + "id": 252, "name": "localStorage", "kind": 1024, "kindString": "Property", @@ -12906,7 +13308,7 @@ } }, { - "id": 233, + "id": 259, "name": "clear", "kind": 2048, "kindString": "Method", @@ -12915,7 +13317,7 @@ }, "signatures": [ { - "id": 234, + "id": 260, "name": "clear", "kind": 4096, "kindString": "Call signature", @@ -12937,7 +13339,7 @@ ] }, { - "id": 242, + "id": 268, "name": "getItem", "kind": 2048, "kindString": "Method", @@ -12946,7 +13348,7 @@ }, "signatures": [ { - "id": 243, + "id": 269, "name": "getItem", "kind": 4096, "kindString": "Call signature", @@ -12955,7 +13357,7 @@ }, "parameters": [ { - "id": 244, + "id": 270, "name": "key", "kind": 32768, "kindString": "Parameter", @@ -12992,7 +13394,7 @@ ] }, { - "id": 235, + "id": 261, "name": "key", "kind": 2048, "kindString": "Method", @@ -13001,7 +13403,7 @@ }, "signatures": [ { - "id": 236, + "id": 262, "name": "key", "kind": 4096, "kindString": "Call signature", @@ -13010,7 +13412,7 @@ }, "parameters": [ { - "id": 237, + "id": 263, "name": "index", "kind": 32768, "kindString": "Parameter", @@ -13047,7 +13449,7 @@ ] }, { - "id": 245, + "id": 271, "name": "removeItem", "kind": 2048, "kindString": "Method", @@ -13056,7 +13458,7 @@ }, "signatures": [ { - "id": 246, + "id": 272, "name": "removeItem", "kind": 4096, "kindString": "Call signature", @@ -13065,7 +13467,7 @@ }, "parameters": [ { - "id": 247, + "id": 273, "name": "key", "kind": 32768, "kindString": "Parameter", @@ -13093,7 +13495,7 @@ ] }, { - "id": 238, + "id": 264, "name": "setItem", "kind": 2048, "kindString": "Method", @@ -13102,7 +13504,7 @@ }, "signatures": [ { - "id": 239, + "id": 265, "name": "setItem", "kind": 4096, "kindString": "Call signature", @@ -13111,7 +13513,7 @@ }, "parameters": [ { - "id": 240, + "id": 266, "name": "key", "kind": 32768, "kindString": "Parameter", @@ -13124,7 +13526,7 @@ } }, { - "id": 241, + "id": 267, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -13157,26 +13559,26 @@ "title": "Constructors", "kind": 512, "children": [ - 230 + 256 ] }, { "title": "Properties", "kind": 1024, "children": [ - 229, - 226 + 255, + 252 ] }, { "title": "Methods", "kind": 2048, "children": [ - 233, - 242, - 235, - 245, - 238 + 259, + 268, + 261, + 271, + 264 ] } ], @@ -13195,7 +13597,7 @@ ] }, { - "id": 252, + "id": 278, "name": "getParameterByName", "kind": 64, "kindString": "Function", @@ -13204,7 +13606,7 @@ }, "signatures": [ { - "id": 253, + "id": 279, "name": "getParameterByName", "kind": 4096, "kindString": "Call signature", @@ -13213,7 +13615,7 @@ }, "parameters": [ { - "id": 254, + "id": 280, "name": "name", "kind": 32768, "kindString": "Parameter", @@ -13226,7 +13628,7 @@ } }, { - "id": 255, + "id": 281, "name": "url", "kind": 32768, "kindString": "Parameter", @@ -13273,7 +13675,7 @@ ] }, { - "id": 250, + "id": 276, "name": "isBrowser", "kind": 64, "kindString": "Function", @@ -13283,7 +13685,7 @@ }, "signatures": [ { - "id": 251, + "id": 277, "name": "isBrowser", "kind": 4096, "kindString": "Call signature", @@ -13305,7 +13707,7 @@ ] }, { - "id": 248, + "id": 274, "name": "uuid", "kind": 64, "kindString": "Function", @@ -13314,7 +13716,7 @@ }, "signatures": [ { - "id": 249, + "id": 275, "name": "uuid", "kind": 4096, "kindString": "Call signature", @@ -13341,16 +13743,16 @@ "title": "Classes", "kind": 128, "children": [ - 225 + 251 ] }, { "title": "Functions", "kind": 64, "children": [ - 252, - 250, - 248 + 278, + 276, + 274 ] } ], @@ -13363,7 +13765,69 @@ ] }, { - "id": 26, + "id": 282, + "name": "\"lib/polyfills\"", + "kind": 1, + "kindString": "Module", + "flags": { + "isExported": true + }, + "originalName": "/home/runner/work/gotrue-js/gotrue-js/src/lib/polyfills.ts", + "children": [ + { + "id": 283, + "name": "polyfillGlobalThis", + "kind": 64, + "kindString": "Function", + "flags": { + "isExported": true + }, + "signatures": [ + { + "id": 284, + "name": "polyfillGlobalThis", + "kind": 4096, + "kindString": "Call signature", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "https://mathiasbynens.be/notes/globalthis" + }, + "type": { + "type": "intrinsic", + "name": "void" + } + } + ], + "sources": [ + { + "fileName": "lib/polyfills.ts", + "line": 6, + "character": 34 + } + ] + } + ], + "groups": [ + { + "title": "Functions", + "kind": 64, + "children": [ + 283 + ] + } + ], + "sources": [ + { + "fileName": "lib/polyfills.ts", + "line": 1, + "character": 0 + } + ] + }, + { + "id": 44, "name": "\"lib/types\"", "kind": 1, "kindString": "Module", @@ -13373,7 +13837,7 @@ "originalName": "/home/runner/work/gotrue-js/gotrue-js/src/lib/types.ts", "children": [ { - "id": 66, + "id": 84, "name": "CookieOptions", "kind": 256, "kindString": "Interface", @@ -13382,7 +13846,7 @@ }, "children": [ { - "id": 69, + "id": 87, "name": "domain", "kind": 1024, "kindString": "Property", @@ -13412,7 +13876,7 @@ } }, { - "id": 68, + "id": 86, "name": "lifetime", "kind": 1024, "kindString": "Property", @@ -13442,7 +13906,7 @@ } }, { - "id": 67, + "id": 85, "name": "name", "kind": 1024, "kindString": "Property", @@ -13472,7 +13936,7 @@ } }, { - "id": 70, + "id": 88, "name": "path", "kind": 1024, "kindString": "Property", @@ -13502,7 +13966,7 @@ } }, { - "id": 71, + "id": 89, "name": "sameSite", "kind": 1024, "kindString": "Property", @@ -13537,11 +14001,11 @@ "title": "Properties", "kind": 1024, "children": [ - 69, - 68, - 67, - 70, - 71 + 87, + 86, + 85, + 88, + 89 ] } ], @@ -13554,7 +14018,7 @@ ] }, { - "id": 27, + "id": 45, "name": "Session", "kind": 256, "kindString": "Interface", @@ -13563,7 +14027,7 @@ }, "children": [ { - "id": 28, + "id": 46, "name": "access_token", "kind": 1024, "kindString": "Property", @@ -13583,7 +14047,7 @@ } }, { - "id": 29, + "id": 47, "name": "expires_in", "kind": 1024, "kindString": "Property", @@ -13603,7 +14067,7 @@ } }, { - "id": 30, + "id": 48, "name": "refresh_token", "kind": 1024, "kindString": "Property", @@ -13623,7 +14087,7 @@ } }, { - "id": 31, + "id": 49, "name": "token_type", "kind": 1024, "kindString": "Property", @@ -13643,7 +14107,7 @@ } }, { - "id": 32, + "id": 50, "name": "user", "kind": 1024, "kindString": "Property", @@ -13659,7 +14123,7 @@ ], "type": { "type": "reference", - "id": 33, + "id": 51, "name": "User" } } @@ -13669,11 +14133,11 @@ "title": "Properties", "kind": 1024, "children": [ - 28, - 29, - 30, - 31, - 32 + 46, + 47, + 48, + 49, + 50 ] } ], @@ -13686,7 +14150,7 @@ ] }, { - "id": 56, + "id": 74, "name": "Subscription", "kind": 256, "kindString": "Interface", @@ -13695,7 +14159,7 @@ }, "children": [ { - "id": 58, + "id": 76, "name": "callback", "kind": 1024, "kindString": "Property", @@ -13715,7 +14179,7 @@ "type": { "type": "reflection", "declaration": { - "id": 59, + "id": 77, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -13724,7 +14188,7 @@ }, "signatures": [ { - "id": 60, + "id": 78, "name": "__call", "kind": 4096, "kindString": "Call signature", @@ -13733,7 +14197,7 @@ }, "parameters": [ { - "id": 61, + "id": 79, "name": "event", "kind": 32768, "kindString": "Parameter", @@ -13742,12 +14206,12 @@ }, "type": { "type": "reference", - "id": 73, + "id": 95, "name": "AuthChangeEvent" } }, { - "id": 62, + "id": 80, "name": "session", "kind": 32768, "kindString": "Parameter", @@ -13759,7 +14223,7 @@ "types": [ { "type": "reference", - "id": 27, + "id": 45, "name": "Session" }, { @@ -13787,7 +14251,7 @@ } }, { - "id": 57, + "id": 75, "name": "id", "kind": 1024, "kindString": "Property", @@ -13810,7 +14274,7 @@ } }, { - "id": 63, + "id": 81, "name": "unsubscribe", "kind": 1024, "kindString": "Property", @@ -13830,7 +14294,7 @@ "type": { "type": "reflection", "declaration": { - "id": 64, + "id": 82, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -13839,7 +14303,7 @@ }, "signatures": [ { - "id": 65, + "id": 83, "name": "__call", "kind": 4096, "kindString": "Call signature", @@ -13868,9 +14332,9 @@ "title": "Properties", "kind": 1024, "children": [ - 58, - 57, - 63 + 76, + 75, + 81 ] } ], @@ -13883,7 +14347,7 @@ ] }, { - "id": 33, + "id": 51, "name": "User", "kind": 256, "kindString": "Interface", @@ -13892,7 +14356,7 @@ }, "children": [ { - "id": 35, + "id": 53, "name": "app_metadata", "kind": 1024, "kindString": "Property", @@ -13909,7 +14373,7 @@ "type": { "type": "reflection", "declaration": { - "id": 36, + "id": 54, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -13918,7 +14382,7 @@ }, "indexSignature": [ { - "id": 38, + "id": 56, "name": "__index", "kind": 8192, "kindString": "Index signature", @@ -13927,7 +14391,7 @@ }, "parameters": [ { - "id": 39, + "id": 57, "name": "key", "kind": 32768, "kindString": "Parameter", @@ -13948,7 +14412,7 @@ ], "children": [ { - "id": 37, + "id": 55, "name": "provider", "kind": 32, "kindString": "Variable", @@ -13983,7 +14447,7 @@ "title": "Variables", "kind": 32, "children": [ - 37 + 55 ] } ], @@ -13998,7 +14462,7 @@ } }, { - "id": 44, + "id": 62, "name": "aud", "kind": 1024, "kindString": "Property", @@ -14018,7 +14482,7 @@ } }, { - "id": 47, + "id": 65, "name": "confirmed_at", "kind": 1024, "kindString": "Property", @@ -14048,7 +14512,7 @@ } }, { - "id": 46, + "id": 64, "name": "created_at", "kind": 1024, "kindString": "Property", @@ -14068,7 +14532,7 @@ } }, { - "id": 45, + "id": 63, "name": "email", "kind": 1024, "kindString": "Property", @@ -14098,7 +14562,7 @@ } }, { - "id": 34, + "id": 52, "name": "id", "kind": 1024, "kindString": "Property", @@ -14118,7 +14582,7 @@ } }, { - "id": 48, + "id": 66, "name": "last_sign_in_at", "kind": 1024, "kindString": "Property", @@ -14148,7 +14612,7 @@ } }, { - "id": 49, + "id": 67, "name": "role", "kind": 1024, "kindString": "Property", @@ -14178,7 +14642,7 @@ } }, { - "id": 50, + "id": 68, "name": "updated_at", "kind": 1024, "kindString": "Property", @@ -14208,7 +14672,7 @@ } }, { - "id": 40, + "id": 58, "name": "user_metadata", "kind": 1024, "kindString": "Property", @@ -14225,7 +14689,7 @@ "type": { "type": "reflection", "declaration": { - "id": 41, + "id": 59, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -14234,7 +14698,7 @@ }, "indexSignature": [ { - "id": 42, + "id": 60, "name": "__index", "kind": 8192, "kindString": "Index signature", @@ -14243,7 +14707,7 @@ }, "parameters": [ { - "id": 43, + "id": 61, "name": "key", "kind": 32768, "kindString": "Parameter", @@ -14278,16 +14742,16 @@ "title": "Properties", "kind": 1024, "children": [ - 35, - 44, - 47, - 46, - 45, - 34, - 48, - 49, - 50, - 40 + 53, + 62, + 65, + 64, + 63, + 52, + 66, + 67, + 68, + 58 ] } ], @@ -14300,7 +14764,7 @@ ] }, { - "id": 51, + "id": 69, "name": "UserAttributes", "kind": 256, "kindString": "Interface", @@ -14309,7 +14773,7 @@ }, "children": [ { - "id": 55, + "id": 73, "name": "data", "kind": 1024, "kindString": "Property", @@ -14342,7 +14806,7 @@ } }, { - "id": 52, + "id": 70, "name": "email", "kind": 1024, "kindString": "Property", @@ -14375,7 +14839,7 @@ } }, { - "id": 54, + "id": 72, "name": "email_change_token", "kind": 1024, "kindString": "Property", @@ -14408,7 +14872,7 @@ } }, { - "id": 53, + "id": 71, "name": "password", "kind": 1024, "kindString": "Property", @@ -14446,10 +14910,10 @@ "title": "Properties", "kind": 1024, "children": [ - 55, - 52, - 54, - 53 + 73, + 70, + 72, + 71 ] } ], @@ -14462,7 +14926,118 @@ ] }, { - "id": 73, + "id": 90, + "name": "UserCredentials", + "kind": 256, + "kindString": "Interface", + "flags": { + "isExported": true + }, + "children": [ + { + "id": 91, + "name": "email", + "kind": 1024, + "kindString": "Property", + "flags": { + "isExported": true, + "isOptional": true + }, + "sources": [ + { + "fileName": "lib/types.ts", + "line": 78, + "character": 7 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + }, + { + "id": 92, + "name": "password", + "kind": 1024, + "kindString": "Property", + "flags": { + "isExported": true, + "isOptional": true + }, + "sources": [ + { + "fileName": "lib/types.ts", + "line": 79, + "character": 10 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + }, + { + "id": 93, + "name": "provider", + "kind": 1024, + "kindString": "Property", + "flags": { + "isExported": true, + "isOptional": true + }, + "sources": [ + { + "fileName": "lib/types.ts", + "line": 81, + "character": 10 + } + ], + "type": { + "type": "reference", + "id": 94, + "name": "Provider" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 91, + 92, + 93 + ] + } + ], + "sources": [ + { + "fileName": "lib/types.ts", + "line": 77, + "character": 32 + } + ] + }, + { + "id": 95, "name": "AuthChangeEvent", "kind": 4194304, "kindString": "Type alias", @@ -14499,7 +15074,7 @@ } }, { - "id": 72, + "id": 94, "name": "Provider", "kind": 4194304, "kindString": "Type alias", @@ -14516,10 +15091,18 @@ "type": { "type": "union", "types": [ + { + "type": "stringLiteral", + "value": "azure" + }, { "type": "stringLiteral", "value": "bitbucket" }, + { + "type": "stringLiteral", + "value": "facebook" + }, { "type": "stringLiteral", "value": "github" @@ -14541,19 +15124,20 @@ "title": "Interfaces", "kind": 256, "children": [ - 66, - 27, - 56, - 33, - 51 + 84, + 45, + 74, + 51, + 69, + 90 ] }, { "title": "Type aliases", "kind": 4194304, "children": [ - 73, - 72 + 95, + 94 ] } ], @@ -14571,14 +15155,15 @@ "title": "Modules", "kind": 1, "children": [ - 131, - 256, - 397, - 74, - 87, + 153, + 285, + 426, + 96, + 109, 1, - 224, - 26 + 250, + 282, + 44 ] } ] @@ -20510,7 +21095,7 @@ "sources": [ { "fileName": "lib/PostgrestQueryBuilder.ts", - "line": 106, + "line": 107, "character": 11 } ], @@ -20551,7 +21136,7 @@ "sources": [ { "fileName": "lib/PostgrestQueryBuilder.ts", - "line": 105, + "line": 106, "character": 15 } ], @@ -20584,7 +21169,7 @@ "sources": [ { "fileName": "lib/PostgrestQueryBuilder.ts", - "line": 103, + "line": 104, "character": 23 } ] @@ -20609,7 +21194,7 @@ "sources": [ { "fileName": "lib/PostgrestQueryBuilder.ts", - "line": 102, + "line": 103, "character": 8 } ] diff --git a/web/spec/gotrue.json b/web/spec/gotrue.json index 01a784d683e..2f7e85e60cf 100644 --- a/web/spec/gotrue.json +++ b/web/spec/gotrue.json @@ -6,7 +6,7 @@ "originalName": "", "children": [ { - "id": 131, + "id": 153, "name": "\"GoTrueApi\"", "kind": 1, "kindString": "Module", @@ -16,7 +16,7 @@ "originalName": "/home/runner/work/gotrue-js/gotrue-js/src/GoTrueApi.ts", "children": [ { - "id": 132, + "id": 154, "name": "GoTrueApi", "kind": 128, "kindString": "Class", @@ -25,7 +25,7 @@ }, "children": [ { - "id": 139, + "id": 161, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -34,7 +34,7 @@ }, "signatures": [ { - "id": 140, + "id": 162, "name": "new GoTrueApi", "kind": 16384, "kindString": "Constructor signature", @@ -43,7 +43,7 @@ }, "parameters": [ { - "id": 141, + "id": 163, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", @@ -54,7 +54,7 @@ "type": { "type": "reflection", "declaration": { - "id": 142, + "id": 164, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -63,7 +63,7 @@ }, "children": [ { - "id": 148, + "id": 170, "name": "cookieOptions", "kind": 32, "kindString": "Variable", @@ -86,14 +86,14 @@ }, { "type": "reference", - "id": 66, + "id": 84, "name": "CookieOptions" } ] } }, { - "id": 144, + "id": 166, "name": "headers", "kind": 32, "kindString": "Variable", @@ -110,7 +110,7 @@ "type": { "type": "reflection", "declaration": { - "id": 145, + "id": 167, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -119,7 +119,7 @@ }, "indexSignature": [ { - "id": 146, + "id": 168, "name": "__index", "kind": 8192, "kindString": "Index signature", @@ -128,7 +128,7 @@ }, "parameters": [ { - "id": 147, + "id": 169, "name": "key", "kind": 32768, "kindString": "Parameter", @@ -151,7 +151,7 @@ } }, { - "id": 143, + "id": 165, "name": "url", "kind": 32, "kindString": "Variable", @@ -177,9 +177,9 @@ "title": "Variables", "kind": 32, "children": [ - 148, - 144, - 143 + 170, + 166, + 165 ] } ], @@ -196,7 +196,7 @@ ], "type": { "type": "reference", - "id": 132, + "id": 154, "name": "GoTrueApi" } } @@ -210,7 +210,7 @@ ] }, { - "id": 138, + "id": 160, "name": "cookieOptions", "kind": 1024, "kindString": "Property", @@ -227,12 +227,12 @@ ], "type": { "type": "reference", - "id": 66, + "id": 84, "name": "CookieOptions" } }, { - "id": 134, + "id": 156, "name": "headers", "kind": 1024, "kindString": "Property", @@ -250,7 +250,7 @@ "type": { "type": "reflection", "declaration": { - "id": 135, + "id": 157, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -259,7 +259,7 @@ }, "indexSignature": [ { - "id": 136, + "id": 158, "name": "__index", "kind": 8192, "kindString": "Index signature", @@ -268,7 +268,7 @@ }, "parameters": [ { - "id": 137, + "id": 159, "name": "key", "kind": 32768, "kindString": "Parameter", @@ -298,7 +298,7 @@ } }, { - "id": 133, + "id": 155, "name": "url", "kind": 1024, "kindString": "Property", @@ -319,7 +319,68 @@ } }, { - "id": 189, + "id": 206, + "name": "_createRequestHeaders", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPrivate": true, + "isExported": true + }, + "signatures": [ + { + "id": 207, + "name": "_createRequestHeaders", + "kind": 4096, + "kindString": "Call signature", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "Create a temporary object with all configured headers and\nadds the Authorization token to be used on request methods" + }, + "parameters": [ + { + "id": 208, + "name": "jwt", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "comment": { + "text": "A valid, logged-in JWT.\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 209, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + "isExported": true + } + } + } + } + ], + "sources": [ + { + "fileName": "GoTrueApi.ts", + "line": 111, + "character": 31 + } + ] + }, + { + "id": 215, "name": "getUrlForProvider", "kind": 2048, "kindString": "Method", @@ -328,7 +389,7 @@ }, "signatures": [ { - "id": 190, + "id": 216, "name": "getUrlForProvider", "kind": 4096, "kindString": "Call signature", @@ -340,7 +401,7 @@ }, "parameters": [ { - "id": 191, + "id": 217, "name": "provider", "kind": 32768, "kindString": "Parameter", @@ -352,7 +413,7 @@ }, "type": { "type": "reference", - "id": 72, + "id": 94, "name": "Provider" } } @@ -366,13 +427,13 @@ "sources": [ { "fileName": "GoTrueApi.ts", - "line": 125, + "line": 138, "character": 19 } ] }, { - "id": 192, + "id": 218, "name": "getUser", "kind": 2048, "kindString": "Method", @@ -381,7 +442,7 @@ }, "signatures": [ { - "id": 193, + "id": 219, "name": "getUser", "kind": 4096, "kindString": "Call signature", @@ -393,7 +454,7 @@ }, "parameters": [ { - "id": 194, + "id": 220, "name": "jwt", "kind": 32768, "kindString": "Parameter", @@ -409,6 +470,353 @@ } } ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reflection", + "declaration": { + "id": 221, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + "isExported": true + }, + "children": [ + { + "id": 223, + "name": "data", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "GoTrueApi.ts", + "line": 148, + "character": 38 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 51, + "name": "User" + }, + { + "type": "intrinsic", + "name": "null" + } + ] + } + }, + { + "id": 224, + "name": "error", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "GoTrueApi.ts", + "line": 148, + "character": 58 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "name": "Error" + }, + { + "type": "intrinsic", + "name": "null" + } + ] + } + }, + { + "id": 222, + "name": "user", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "GoTrueApi.ts", + "line": 148, + "character": 19 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 51, + "name": "User" + }, + { + "type": "intrinsic", + "name": "null" + } + ] + } + } + ], + "groups": [ + { + "title": "Variables", + "kind": 32, + "children": [ + 223, + 224, + 222 + ] + } + ], + "sources": [ + { + "fileName": "GoTrueApi.ts", + "line": 148, + "character": 13 + } + ] + } + } + ], + "name": "Promise" + } + } + ], + "sources": [ + { + "fileName": "GoTrueApi.ts", + "line": 146, + "character": 15 + } + ] + }, + { + "id": 243, + "name": "getUserByCookie", + "kind": 2048, + "kindString": "Method", + "flags": { + "isExported": true + }, + "signatures": [ + { + "id": 244, + "name": "getUserByCookie", + "kind": 4096, + "kindString": "Call signature", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "Get user by reading the cookie from the request.\nWorks for Next.js & Express (requires cookie-parser middleware)." + }, + "parameters": [ + { + "id": 245, + "name": "req", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reflection", + "declaration": { + "id": 246, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + "isExported": true + }, + "children": [ + { + "id": 248, + "name": "data", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "GoTrueApi.ts", + "line": 227, + "character": 38 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 51, + "name": "User" + }, + { + "type": "intrinsic", + "name": "null" + } + ] + } + }, + { + "id": 249, + "name": "error", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "GoTrueApi.ts", + "line": 227, + "character": 58 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "name": "Error" + }, + { + "type": "intrinsic", + "name": "null" + } + ] + } + }, + { + "id": 247, + "name": "user", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "GoTrueApi.ts", + "line": 227, + "character": 19 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 51, + "name": "User" + }, + { + "type": "intrinsic", + "name": "null" + } + ] + } + } + ], + "groups": [ + { + "title": "Variables", + "kind": 32, + "children": [ + 248, + 249, + 247 + ] + } + ], + "sources": [ + { + "fileName": "GoTrueApi.ts", + "line": 227, + "character": 13 + } + ] + } + } + ], + "name": "Promise" + } + } + ], + "sources": [ + { + "fileName": "GoTrueApi.ts", + "line": 225, + "character": 23 + } + ] + }, + { + "id": 192, + "name": "inviteUserByEmail", + "kind": 2048, + "kindString": "Method", + "flags": { + "isExported": true + }, + "signatures": [ + { + "id": 193, + "name": "inviteUserByEmail", + "kind": 4096, + "kindString": "Call signature", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "Sends an invite link to an email address." + }, + "parameters": [ + { + "id": 194, + "name": "email", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "comment": { + "text": "The email address of the user.\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], "type": { "type": "reference", "typeArguments": [ @@ -423,355 +831,8 @@ "isExported": true }, "children": [ - { - "id": 197, - "name": "data", - "kind": 32, - "kindString": "Variable", - "flags": { - "isExported": true - }, - "sources": [ - { - "fileName": "GoTrueApi.ts", - "line": 135, - "character": 38 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 33, - "name": "User" - }, - { - "type": "intrinsic", - "name": "null" - } - ] - } - }, - { - "id": 198, - "name": "error", - "kind": 32, - "kindString": "Variable", - "flags": { - "isExported": true - }, - "sources": [ - { - "fileName": "GoTrueApi.ts", - "line": 135, - "character": 58 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "name": "Error" - }, - { - "type": "intrinsic", - "name": "null" - } - ] - } - }, { "id": 196, - "name": "user", - "kind": 32, - "kindString": "Variable", - "flags": { - "isExported": true - }, - "sources": [ - { - "fileName": "GoTrueApi.ts", - "line": 135, - "character": 19 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 33, - "name": "User" - }, - { - "type": "intrinsic", - "name": "null" - } - ] - } - } - ], - "groups": [ - { - "title": "Variables", - "kind": 32, - "children": [ - 197, - 198, - 196 - ] - } - ], - "sources": [ - { - "fileName": "GoTrueApi.ts", - "line": 135, - "character": 13 - } - ] - } - } - ], - "name": "Promise" - } - } - ], - "sources": [ - { - "fileName": "GoTrueApi.ts", - "line": 133, - "character": 15 - } - ] - }, - { - "id": 217, - "name": "getUserByCookie", - "kind": 2048, - "kindString": "Method", - "flags": { - "isExported": true - }, - "signatures": [ - { - "id": 218, - "name": "getUserByCookie", - "kind": 4096, - "kindString": "Call signature", - "flags": { - "isExported": true - }, - "comment": { - "shortText": "Get user by reading the cookie from the request.\nWorks for Next.js & Express (requires cookie-parser middleware)." - }, - "parameters": [ - { - "id": 219, - "name": "req", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isExported": true - }, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 220, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": { - "isExported": true - }, - "children": [ - { - "id": 222, - "name": "data", - "kind": 32, - "kindString": "Variable", - "flags": { - "isExported": true - }, - "sources": [ - { - "fileName": "GoTrueApi.ts", - "line": 217, - "character": 38 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 33, - "name": "User" - }, - { - "type": "intrinsic", - "name": "null" - } - ] - } - }, - { - "id": 223, - "name": "error", - "kind": 32, - "kindString": "Variable", - "flags": { - "isExported": true - }, - "sources": [ - { - "fileName": "GoTrueApi.ts", - "line": 217, - "character": 58 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "name": "Error" - }, - { - "type": "intrinsic", - "name": "null" - } - ] - } - }, - { - "id": 221, - "name": "user", - "kind": 32, - "kindString": "Variable", - "flags": { - "isExported": true - }, - "sources": [ - { - "fileName": "GoTrueApi.ts", - "line": 217, - "character": 19 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 33, - "name": "User" - }, - { - "type": "intrinsic", - "name": "null" - } - ] - } - } - ], - "groups": [ - { - "title": "Variables", - "kind": 32, - "children": [ - 222, - 223, - 221 - ] - } - ], - "sources": [ - { - "fileName": "GoTrueApi.ts", - "line": 217, - "character": 13 - } - ] - } - } - ], - "name": "Promise" - } - } - ], - "sources": [ - { - "fileName": "GoTrueApi.ts", - "line": 215, - "character": 23 - } - ] - }, - { - "id": 170, - "name": "inviteUserByEmail", - "kind": 2048, - "kindString": "Method", - "flags": { - "isExported": true - }, - "signatures": [ - { - "id": 171, - "name": "inviteUserByEmail", - "kind": 4096, - "kindString": "Call signature", - "flags": { - "isExported": true - }, - "comment": { - "shortText": "Sends an invite link to an email address." - }, - "parameters": [ - { - "id": 172, - "name": "email", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isExported": true - }, - "comment": { - "text": "The email address of the user.\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 173, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": { - "isExported": true - }, - "children": [ - { - "id": 174, "name": "data", "kind": 32, "kindString": "Variable", @@ -791,7 +852,7 @@ { "type": "reflection", "declaration": { - "id": 175, + "id": 197, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -815,7 +876,7 @@ } }, { - "id": 176, + "id": 198, "name": "error", "kind": 32, "kindString": "Variable", @@ -849,8 +910,8 @@ "title": "Variables", "kind": 32, "children": [ - 174, - 176 + 196, + 198 ] } ], @@ -877,7 +938,7 @@ ] }, { - "id": 207, + "id": 233, "name": "refreshAccessToken", "kind": 2048, "kindString": "Method", @@ -886,7 +947,7 @@ }, "signatures": [ { - "id": 208, + "id": 234, "name": "refreshAccessToken", "kind": 4096, "kindString": "Call signature", @@ -898,7 +959,7 @@ }, "parameters": [ { - "id": 209, + "id": 235, "name": "refreshToken", "kind": 32768, "kindString": "Parameter", @@ -920,7 +981,7 @@ { "type": "reflection", "declaration": { - "id": 210, + "id": 236, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -929,7 +990,7 @@ }, "children": [ { - "id": 211, + "id": 237, "name": "data", "kind": 32, "kindString": "Variable", @@ -939,7 +1000,7 @@ "sources": [ { "fileName": "GoTrueApi.ts", - "line": 171, + "line": 182, "character": 19 } ], @@ -948,7 +1009,7 @@ "types": [ { "type": "reference", - "id": 27, + "id": 45, "name": "Session" }, { @@ -959,7 +1020,7 @@ } }, { - "id": 212, + "id": 238, "name": "error", "kind": 32, "kindString": "Variable", @@ -969,7 +1030,7 @@ "sources": [ { "fileName": "GoTrueApi.ts", - "line": 171, + "line": 182, "character": 42 } ], @@ -993,15 +1054,15 @@ "title": "Variables", "kind": 32, "children": [ - 211, - 212 + 237, + 238 ] } ], "sources": [ { "fileName": "GoTrueApi.ts", - "line": 171, + "line": 182, "character": 13 } ] @@ -1015,13 +1076,13 @@ "sources": [ { "fileName": "GoTrueApi.ts", - "line": 169, + "line": 180, "character": 26 } ] }, { - "id": 177, + "id": 199, "name": "resetPasswordForEmail", "kind": 2048, "kindString": "Method", @@ -1030,7 +1091,7 @@ }, "signatures": [ { - "id": 178, + "id": 200, "name": "resetPasswordForEmail", "kind": 4096, "kindString": "Call signature", @@ -1042,7 +1103,7 @@ }, "parameters": [ { - "id": 179, + "id": 201, "name": "email", "kind": 32768, "kindString": "Parameter", @@ -1064,7 +1125,7 @@ { "type": "reflection", "declaration": { - "id": 180, + "id": 202, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -1073,7 +1134,7 @@ }, "children": [ { - "id": 181, + "id": 203, "name": "data", "kind": 32, "kindString": "Variable", @@ -1093,7 +1154,7 @@ { "type": "reflection", "declaration": { - "id": 182, + "id": 204, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -1117,7 +1178,7 @@ } }, { - "id": 183, + "id": 205, "name": "error", "kind": 32, "kindString": "Variable", @@ -1151,8 +1212,8 @@ "title": "Variables", "kind": 32, "children": [ - 181, - 183 + 203, + 205 ] } ], @@ -1179,7 +1240,7 @@ ] }, { - "id": 163, + "id": 185, "name": "sendMagicLinkEmail", "kind": 2048, "kindString": "Method", @@ -1188,7 +1249,7 @@ }, "signatures": [ { - "id": 164, + "id": 186, "name": "sendMagicLinkEmail", "kind": 4096, "kindString": "Call signature", @@ -1200,7 +1261,7 @@ }, "parameters": [ { - "id": 165, + "id": 187, "name": "email", "kind": 32768, "kindString": "Parameter", @@ -1222,7 +1283,7 @@ { "type": "reflection", "declaration": { - "id": 166, + "id": 188, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -1231,7 +1292,7 @@ }, "children": [ { - "id": 167, + "id": 189, "name": "data", "kind": 32, "kindString": "Variable", @@ -1251,7 +1312,7 @@ { "type": "reflection", "declaration": { - "id": 168, + "id": 190, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -1275,7 +1336,7 @@ } }, { - "id": 169, + "id": 191, "name": "error", "kind": 32, "kindString": "Variable", @@ -1309,8 +1370,8 @@ "title": "Variables", "kind": 32, "children": [ - 167, - 169 + 189, + 191 ] } ], @@ -1337,7 +1398,7 @@ ] }, { - "id": 213, + "id": 239, "name": "setAuthCookie", "kind": 2048, "kindString": "Method", @@ -1346,7 +1407,7 @@ }, "signatures": [ { - "id": 214, + "id": 240, "name": "setAuthCookie", "kind": 4096, "kindString": "Call signature", @@ -1358,7 +1419,7 @@ }, "parameters": [ { - "id": 215, + "id": 241, "name": "req", "kind": 32768, "kindString": "Parameter", @@ -1371,7 +1432,7 @@ } }, { - "id": 216, + "id": 242, "name": "res", "kind": 32768, "kindString": "Parameter", @@ -1393,13 +1454,13 @@ "sources": [ { "fileName": "GoTrueApi.ts", - "line": 188, + "line": 199, "character": 15 } ] }, { - "id": 156, + "id": 178, "name": "signInWithEmail", "kind": 2048, "kindString": "Method", @@ -1408,7 +1469,7 @@ }, "signatures": [ { - "id": 157, + "id": 179, "name": "signInWithEmail", "kind": 4096, "kindString": "Call signature", @@ -1420,7 +1481,7 @@ }, "parameters": [ { - "id": 158, + "id": 180, "name": "email", "kind": 32768, "kindString": "Parameter", @@ -1436,7 +1497,7 @@ } }, { - "id": 159, + "id": 181, "name": "password", "kind": 32768, "kindString": "Parameter", @@ -1458,7 +1519,7 @@ { "type": "reflection", "declaration": { - "id": 160, + "id": 182, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -1467,7 +1528,7 @@ }, "children": [ { - "id": 161, + "id": 183, "name": "data", "kind": 32, "kindString": "Variable", @@ -1486,7 +1547,7 @@ "types": [ { "type": "reference", - "id": 27, + "id": 45, "name": "Session" }, { @@ -1497,7 +1558,7 @@ } }, { - "id": 162, + "id": 184, "name": "error", "kind": 32, "kindString": "Variable", @@ -1531,8 +1592,8 @@ "title": "Variables", "kind": 32, "children": [ - 161, - 162 + 183, + 184 ] } ], @@ -1559,7 +1620,7 @@ ] }, { - "id": 184, + "id": 210, "name": "signOut", "kind": 2048, "kindString": "Method", @@ -1568,7 +1629,7 @@ }, "signatures": [ { - "id": 185, + "id": 211, "name": "signOut", "kind": 4096, "kindString": "Call signature", @@ -1580,7 +1641,7 @@ }, "parameters": [ { - "id": 186, + "id": 212, "name": "jwt", "kind": 32768, "kindString": "Parameter", @@ -1602,7 +1663,7 @@ { "type": "reflection", "declaration": { - "id": 187, + "id": 213, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -1611,7 +1672,7 @@ }, "children": [ { - "id": 188, + "id": 214, "name": "error", "kind": 32, "kindString": "Variable", @@ -1621,7 +1682,7 @@ "sources": [ { "fileName": "GoTrueApi.ts", - "line": 110, + "line": 121, "character": 45 } ], @@ -1645,14 +1706,14 @@ "title": "Variables", "kind": 32, "children": [ - 188 + 214 ] } ], "sources": [ { "fileName": "GoTrueApi.ts", - "line": 110, + "line": 121, "character": 38 } ] @@ -1666,13 +1727,13 @@ "sources": [ { "fileName": "GoTrueApi.ts", - "line": 110, + "line": 121, "character": 15 } ] }, { - "id": 149, + "id": 171, "name": "signUpWithEmail", "kind": 2048, "kindString": "Method", @@ -1681,7 +1742,7 @@ }, "signatures": [ { - "id": 150, + "id": 172, "name": "signUpWithEmail", "kind": 4096, "kindString": "Call signature", @@ -1693,7 +1754,7 @@ }, "parameters": [ { - "id": 151, + "id": 173, "name": "email", "kind": 32768, "kindString": "Parameter", @@ -1709,7 +1770,7 @@ } }, { - "id": 152, + "id": 174, "name": "password", "kind": 32768, "kindString": "Parameter", @@ -1731,7 +1792,7 @@ { "type": "reflection", "declaration": { - "id": 153, + "id": 175, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -1740,7 +1801,7 @@ }, "children": [ { - "id": 154, + "id": 176, "name": "data", "kind": 32, "kindString": "Variable", @@ -1759,7 +1820,7 @@ "types": [ { "type": "reference", - "id": 27, + "id": 45, "name": "Session" }, { @@ -1770,7 +1831,7 @@ } }, { - "id": 155, + "id": 177, "name": "error", "kind": 32, "kindString": "Variable", @@ -1804,8 +1865,8 @@ "title": "Variables", "kind": 32, "children": [ - 154, - 155 + 176, + 177 ] } ], @@ -1832,7 +1893,7 @@ ] }, { - "id": 199, + "id": 225, "name": "updateUser", "kind": 2048, "kindString": "Method", @@ -1841,7 +1902,7 @@ }, "signatures": [ { - "id": 200, + "id": 226, "name": "updateUser", "kind": 4096, "kindString": "Call signature", @@ -1853,7 +1914,7 @@ }, "parameters": [ { - "id": 201, + "id": 227, "name": "jwt", "kind": 32768, "kindString": "Parameter", @@ -1869,7 +1930,7 @@ } }, { - "id": 202, + "id": 228, "name": "attributes", "kind": 32768, "kindString": "Parameter", @@ -1881,7 +1942,7 @@ }, "type": { "type": "reference", - "id": 51, + "id": 69, "name": "UserAttributes" } } @@ -1892,7 +1953,7 @@ { "type": "reflection", "declaration": { - "id": 203, + "id": 229, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -1901,7 +1962,7 @@ }, "children": [ { - "id": 205, + "id": 231, "name": "data", "kind": 32, "kindString": "Variable", @@ -1911,7 +1972,7 @@ "sources": [ { "fileName": "GoTrueApi.ts", - "line": 154, + "line": 165, "character": 38 } ], @@ -1920,7 +1981,7 @@ "types": [ { "type": "reference", - "id": 33, + "id": 51, "name": "User" }, { @@ -1931,7 +1992,7 @@ } }, { - "id": 206, + "id": 232, "name": "error", "kind": 32, "kindString": "Variable", @@ -1941,7 +2002,7 @@ "sources": [ { "fileName": "GoTrueApi.ts", - "line": 154, + "line": 165, "character": 58 } ], @@ -1960,7 +2021,7 @@ } }, { - "id": 204, + "id": 230, "name": "user", "kind": 32, "kindString": "Variable", @@ -1970,7 +2031,7 @@ "sources": [ { "fileName": "GoTrueApi.ts", - "line": 154, + "line": 165, "character": 19 } ], @@ -1979,7 +2040,7 @@ "types": [ { "type": "reference", - "id": 33, + "id": 51, "name": "User" }, { @@ -1995,16 +2056,16 @@ "title": "Variables", "kind": 32, "children": [ - 205, - 206, - 204 + 231, + 232, + 230 ] } ], "sources": [ { "fileName": "GoTrueApi.ts", - "line": 154, + "line": 165, "character": 13 } ] @@ -2018,7 +2079,7 @@ "sources": [ { "fileName": "GoTrueApi.ts", - "line": 151, + "line": 162, "character": 18 } ] @@ -2029,34 +2090,35 @@ "title": "Constructors", "kind": 512, "children": [ - 139 + 161 ] }, { "title": "Properties", "kind": 1024, "children": [ - 138, - 134, - 133 + 160, + 156, + 155 ] }, { "title": "Methods", "kind": 2048, "children": [ - 189, + 206, + 215, + 218, + 243, 192, - 217, - 170, - 207, - 177, - 163, - 213, - 156, - 184, - 149, - 199 + 233, + 199, + 185, + 239, + 178, + 210, + 171, + 225 ] } ], @@ -2074,7 +2136,7 @@ "title": "Classes", "kind": 128, "children": [ - 132 + 154 ] } ], @@ -2087,7 +2149,7 @@ ] }, { - "id": 256, + "id": 285, "name": "\"GoTrueClient\"", "kind": 1, "kindString": "Module", @@ -2097,7 +2159,7 @@ "originalName": "/home/runner/work/gotrue-js/gotrue-js/src/GoTrueClient.ts", "children": [ { - "id": 257, + "id": 286, "name": "GoTrueClient", "kind": 128, "kindString": "Class", @@ -2106,7 +2168,7 @@ }, "children": [ { - "id": 265, + "id": 294, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -2118,7 +2180,7 @@ }, "signatures": [ { - "id": 266, + "id": 295, "name": "new GoTrueClient", "kind": 16384, "kindString": "Constructor signature", @@ -2130,7 +2192,7 @@ }, "parameters": [ { - "id": 267, + "id": 296, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -2140,7 +2202,7 @@ "type": { "type": "reflection", "declaration": { - "id": 268, + "id": 297, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -2149,7 +2211,7 @@ }, "children": [ { - "id": 275, + "id": 304, "name": "autoRefreshToken", "kind": 32, "kindString": "Variable", @@ -2163,7 +2225,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 54, + "line": 58, "character": 20 } ], @@ -2186,7 +2248,7 @@ } }, { - "id": 278, + "id": 307, "name": "cookieOptions", "kind": 32, "kindString": "Variable", @@ -2197,18 +2259,18 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 57, + "line": 61, "character": 17 } ], "type": { "type": "reference", - "id": 66, + "id": 84, "name": "CookieOptions" } }, { - "id": 274, + "id": 303, "name": "detectSessionInUrl", "kind": 32, "kindString": "Variable", @@ -2222,7 +2284,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 53, + "line": 57, "character": 22 } ], @@ -2245,7 +2307,7 @@ } }, { - "id": 270, + "id": 299, "name": "headers", "kind": 32, "kindString": "Variable", @@ -2259,7 +2321,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 52, + "line": 56, "character": 11 } ], @@ -2273,7 +2335,7 @@ { "type": "reflection", "declaration": { - "id": 271, + "id": 300, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -2282,7 +2344,7 @@ }, "indexSignature": [ { - "id": 272, + "id": 301, "name": "__index", "kind": 8192, "kindString": "Index signature", @@ -2291,7 +2353,7 @@ }, "parameters": [ { - "id": 273, + "id": 302, "name": "key", "kind": 32768, "kindString": "Parameter", @@ -2316,7 +2378,7 @@ } }, { - "id": 277, + "id": 306, "name": "localStorage", "kind": 32, "kindString": "Variable", @@ -2330,7 +2392,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 56, + "line": 60, "character": 16 } ], @@ -2340,7 +2402,7 @@ } }, { - "id": 276, + "id": 305, "name": "persistSession", "kind": 32, "kindString": "Variable", @@ -2354,7 +2416,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 55, + "line": 59, "character": 18 } ], @@ -2377,7 +2439,7 @@ } }, { - "id": 269, + "id": 298, "name": "url", "kind": 32, "kindString": "Variable", @@ -2391,7 +2453,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 51, + "line": 55, "character": 7 } ], @@ -2415,20 +2477,20 @@ "title": "Variables", "kind": 32, "children": [ - 275, - 278, - 274, - 270, - 277, - 276, - 269 + 304, + 307, + 303, + 299, + 306, + 305, + 298 ] } ], "sources": [ { "fileName": "GoTrueClient.ts", - "line": 50, + "line": 54, "character": 22 } ] @@ -2438,7 +2500,7 @@ ], "type": { "type": "reference", - "id": 257, + "id": 286, "name": "GoTrueClient" } } @@ -2446,13 +2508,13 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 39, + "line": 43, "character": 70 } ] }, { - "id": 258, + "id": 287, "name": "api", "kind": 1024, "kindString": "Property", @@ -2465,18 +2527,18 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 27, + "line": 31, "character": 5 } ], "type": { "type": "reference", - "id": 132, + "id": 154, "name": "GoTrueApi" } }, { - "id": 261, + "id": 290, "name": "autoRefreshToken", "kind": 1024, "kindString": "Property", @@ -2487,7 +2549,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 36, + "line": 40, "character": 28 } ], @@ -2497,7 +2559,7 @@ } }, { - "id": 260, + "id": 289, "name": "currentSession", "kind": 1024, "kindString": "Property", @@ -2511,7 +2573,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 35, + "line": 39, "character": 26 } ], @@ -2520,7 +2582,7 @@ "types": [ { "type": "reference", - "id": 27, + "id": 45, "name": "Session" }, { @@ -2531,7 +2593,7 @@ } }, { - "id": 259, + "id": 288, "name": "currentUser", "kind": 1024, "kindString": "Property", @@ -2545,7 +2607,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 31, + "line": 35, "character": 23 } ], @@ -2554,7 +2616,7 @@ "types": [ { "type": "reference", - "id": 33, + "id": 51, "name": "User" }, { @@ -2565,7 +2627,7 @@ } }, { - "id": 263, + "id": 292, "name": "localStorage", "kind": 1024, "kindString": "Property", @@ -2576,7 +2638,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 38, + "line": 42, "character": 24 } ], @@ -2586,7 +2648,7 @@ } }, { - "id": 262, + "id": 291, "name": "persistSession", "kind": 1024, "kindString": "Property", @@ -2597,7 +2659,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 37, + "line": 41, "character": 26 } ], @@ -2607,7 +2669,7 @@ } }, { - "id": 264, + "id": 293, "name": "stateChangeEmitters", "kind": 1024, "kindString": "Property", @@ -2618,7 +2680,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 39, + "line": 43, "character": 31 } ], @@ -2631,7 +2693,7 @@ }, { "type": "reference", - "id": 56, + "id": 74, "name": "Subscription" } ], @@ -2640,7 +2702,7 @@ "defaultValue": "new Map()" }, { - "id": 377, + "id": 406, "name": "_callRefreshToken", "kind": 2048, "kindString": "Method", @@ -2650,7 +2712,7 @@ }, "signatures": [ { - "id": 378, + "id": 407, "name": "_callRefreshToken", "kind": 4096, "kindString": "Call signature", @@ -2659,7 +2721,7 @@ }, "parameters": [ { - "id": 379, + "id": 408, "name": "refresh_token", "kind": 32768, "kindString": "Parameter", @@ -2691,7 +2753,7 @@ { "type": "reflection", "declaration": { - "id": 380, + "id": 409, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -2700,7 +2762,7 @@ }, "children": [ { - "id": 381, + "id": 410, "name": "data", "kind": 32, "kindString": "Variable", @@ -2710,18 +2772,18 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 402, - "character": 21 + "line": 411, + "character": 19 } ], "type": { "type": "reference", - "id": 27, + "id": 45, "name": "Session" } }, { - "id": 382, + "id": 411, "name": "error", "kind": 32, "kindString": "Variable", @@ -2731,8 +2793,8 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 402, - "character": 28 + "line": 411, + "character": 26 } ], "type": { @@ -2747,8 +2809,8 @@ "title": "Variables", "kind": 32, "children": [ - 381, - 382 + 410, + 411 ] } ] @@ -2757,7 +2819,7 @@ { "type": "reflection", "declaration": { - "id": 383, + "id": 412, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -2766,7 +2828,7 @@ }, "children": [ { - "id": 384, + "id": 413, "name": "data", "kind": 32, "kindString": "Variable", @@ -2776,7 +2838,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 407, + "line": 413, "character": 19 } ], @@ -2787,7 +2849,7 @@ "defaultValue": "null" }, { - "id": 385, + "id": 414, "name": "error", "kind": 32, "kindString": "Variable", @@ -2797,7 +2859,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 407, + "line": 413, "character": 32 } ], @@ -2812,8 +2874,8 @@ "title": "Variables", "kind": 32, "children": [ - 384, - 385 + 413, + 414 ] } ] @@ -2829,13 +2891,13 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 381, + "line": 388, "character": 33 } ] }, { - "id": 341, + "id": 370, "name": "_handleEmailSignIn", "kind": 2048, "kindString": "Method", @@ -2845,7 +2907,7 @@ }, "signatures": [ { - "id": 342, + "id": 371, "name": "_handleEmailSignIn", "kind": 4096, "kindString": "Call signature", @@ -2854,7 +2916,7 @@ }, "parameters": [ { - "id": 343, + "id": 372, "name": "email", "kind": 32768, "kindString": "Parameter", @@ -2867,7 +2929,7 @@ } }, { - "id": 344, + "id": 373, "name": "password", "kind": 32768, "kindString": "Parameter", @@ -2889,7 +2951,7 @@ { "type": "reflection", "declaration": { - "id": 345, + "id": 374, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -2898,7 +2960,7 @@ }, "children": [ { - "id": 346, + "id": 375, "name": "data", "kind": 32, "kindString": "Variable", @@ -2908,18 +2970,18 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 295, + "line": 302, "character": 19 } ], "type": { "type": "reference", - "id": 27, + "id": 45, "name": "Session" } }, { - "id": 348, + "id": 377, "name": "error", "kind": 32, "kindString": "Variable", @@ -2929,7 +2991,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 295, + "line": 302, "character": 43 } ], @@ -2940,7 +3002,7 @@ "defaultValue": "null" }, { - "id": 347, + "id": 376, "name": "user", "kind": 32, "kindString": "Variable", @@ -2950,13 +3012,13 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 295, + "line": 302, "character": 25 } ], "type": { "type": "reference", - "id": 33, + "id": 51, "name": "User" }, "defaultValue": "data.user" @@ -2967,9 +3029,9 @@ "title": "Variables", "kind": 32, "children": [ - 346, - 348, - 347 + 375, + 377, + 376 ] } ] @@ -2978,7 +3040,7 @@ { "type": "reflection", "declaration": { - "id": 349, + "id": 378, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -2987,7 +3049,7 @@ }, "children": [ { - "id": 350, + "id": 379, "name": "data", "kind": 32, "kindString": "Variable", @@ -2997,7 +3059,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 297, + "line": 304, "character": 19 } ], @@ -3008,7 +3070,7 @@ "defaultValue": "null" }, { - "id": 352, + "id": 381, "name": "error", "kind": 32, "kindString": "Variable", @@ -3018,7 +3080,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 297, + "line": 304, "character": 44 } ], @@ -3028,7 +3090,7 @@ } }, { - "id": 351, + "id": 380, "name": "user", "kind": 32, "kindString": "Variable", @@ -3038,7 +3100,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 297, + "line": 304, "character": 31 } ], @@ -3054,9 +3116,9 @@ "title": "Variables", "kind": 32, "children": [ - 350, - 352, - 351 + 379, + 381, + 380 ] } ] @@ -3072,13 +3134,13 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 285, + "line": 292, "character": 34 } ] }, { - "id": 353, + "id": 382, "name": "_handleProviderSignIn", "kind": 2048, "kindString": "Method", @@ -3088,7 +3150,7 @@ }, "signatures": [ { - "id": 354, + "id": 383, "name": "_handleProviderSignIn", "kind": 4096, "kindString": "Call signature", @@ -3097,7 +3159,7 @@ }, "parameters": [ { - "id": 355, + "id": 384, "name": "provider", "kind": 32768, "kindString": "Parameter", @@ -3106,7 +3168,7 @@ }, "type": { "type": "reference", - "id": 72, + "id": 94, "name": "Provider" } } @@ -3117,7 +3179,7 @@ { "type": "reflection", "declaration": { - "id": 356, + "id": 385, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -3126,7 +3188,7 @@ }, "children": [ { - "id": 359, + "id": 388, "name": "data", "kind": 32, "kindString": "Variable", @@ -3136,7 +3198,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 309, + "line": 316, "character": 34 } ], @@ -3147,7 +3209,7 @@ "defaultValue": "null" }, { - "id": 361, + "id": 390, "name": "error", "kind": 32, "kindString": "Variable", @@ -3157,7 +3219,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 309, + "line": 316, "character": 59 } ], @@ -3168,7 +3230,7 @@ "defaultValue": "null" }, { - "id": 357, + "id": 386, "name": "provider", "kind": 32, "kindString": "Variable", @@ -3178,18 +3240,18 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 309, + "line": 316, "character": 23 } ], "type": { "type": "reference", - "id": 72, + "id": 94, "name": "Provider" } }, { - "id": 358, + "id": 387, "name": "url", "kind": 32, "kindString": "Variable", @@ -3199,7 +3261,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 309, + "line": 316, "character": 28 } ], @@ -3209,7 +3271,7 @@ } }, { - "id": 360, + "id": 389, "name": "user", "kind": 32, "kindString": "Variable", @@ -3219,7 +3281,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 309, + "line": 316, "character": 46 } ], @@ -3235,11 +3297,11 @@ "title": "Variables", "kind": 32, "children": [ - 359, - 361, - 357, - 358, - 360 + 388, + 390, + 386, + 387, + 389 ] } ] @@ -3248,7 +3310,7 @@ { "type": "reflection", "declaration": { - "id": 362, + "id": 391, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -3257,7 +3319,7 @@ }, "children": [ { - "id": 363, + "id": 392, "name": "data", "kind": 32, "kindString": "Variable", @@ -3267,8 +3329,8 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 313, - "character": 24 + "line": 320, + "character": 19 } ], "type": { @@ -3278,7 +3340,7 @@ "defaultValue": "null" }, { - "id": 365, + "id": 394, "name": "error", "kind": 32, "kindString": "Variable", @@ -3288,8 +3350,8 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 313, - "character": 49 + "line": 320, + "character": 44 } ], "type": { @@ -3298,7 +3360,7 @@ } }, { - "id": 364, + "id": 393, "name": "user", "kind": 32, "kindString": "Variable", @@ -3308,8 +3370,8 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 313, - "character": 36 + "line": 320, + "character": 31 } ], "type": { @@ -3324,9 +3386,9 @@ "title": "Variables", "kind": 32, "children": [ - 363, - 365, - 364 + 392, + 394, + 393 ] } ] @@ -3339,13 +3401,13 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 301, + "line": 308, "character": 31 } ] }, { - "id": 386, + "id": 415, "name": "_notifyAllSubscribers", "kind": 2048, "kindString": "Method", @@ -3355,7 +3417,7 @@ }, "signatures": [ { - "id": 387, + "id": 416, "name": "_notifyAllSubscribers", "kind": 4096, "kindString": "Call signature", @@ -3364,7 +3426,7 @@ }, "parameters": [ { - "id": 388, + "id": 417, "name": "event", "kind": 32768, "kindString": "Parameter", @@ -3373,7 +3435,7 @@ }, "type": { "type": "reference", - "id": 73, + "id": 95, "name": "AuthChangeEvent" } } @@ -3387,13 +3449,13 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 411, + "line": 417, "character": 31 } ] }, { - "id": 369, + "id": 398, "name": "_persistSession", "kind": 2048, "kindString": "Method", @@ -3403,7 +3465,7 @@ }, "signatures": [ { - "id": 370, + "id": 399, "name": "_persistSession", "kind": 4096, "kindString": "Call signature", @@ -3412,7 +3474,7 @@ }, "parameters": [ { - "id": 371, + "id": 400, "name": "currentSession", "kind": 32768, "kindString": "Parameter", @@ -3421,12 +3483,12 @@ }, "type": { "type": "reference", - "id": 27, + "id": 45, "name": "Session" } }, { - "id": 372, + "id": 401, "name": "secondsToExpiry", "kind": 32768, "kindString": "Parameter", @@ -3448,13 +3510,13 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 331, + "line": 338, "character": 25 } ] }, { - "id": 375, + "id": 404, "name": "_recoverSession", "kind": 2048, "kindString": "Method", @@ -3464,7 +3526,7 @@ }, "signatures": [ { - "id": 376, + "id": 405, "name": "_recoverSession", "kind": 4096, "kindString": "Call signature", @@ -3475,8 +3537,17 @@ "type": "reference", "typeArguments": [ { - "type": "intrinsic", - "name": "null" + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "intrinsic", + "name": "null" + } + ] } ], "name": "Promise" @@ -3486,13 +3557,13 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 344, + "line": 351, "character": 31 } ] }, { - "id": 373, + "id": 402, "name": "_removeSession", "kind": 2048, "kindString": "Method", @@ -3502,7 +3573,7 @@ }, "signatures": [ { - "id": 374, + "id": 403, "name": "_removeSession", "kind": 4096, "kindString": "Call signature", @@ -3524,13 +3595,13 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 338, + "line": 345, "character": 30 } ] }, { - "id": 366, + "id": 395, "name": "_saveSession", "kind": 2048, "kindString": "Method", @@ -3540,7 +3611,7 @@ }, "signatures": [ { - "id": 367, + "id": 396, "name": "_saveSession", "kind": 4096, "kindString": "Call signature", @@ -3549,7 +3620,7 @@ }, "parameters": [ { - "id": 368, + "id": 397, "name": "session", "kind": 32768, "kindString": "Parameter", @@ -3558,7 +3629,7 @@ }, "type": { "type": "reference", - "id": 27, + "id": 45, "name": "Session" } } @@ -3572,13 +3643,13 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 317, + "line": 324, "character": 22 } ] }, { - "id": 319, + "id": 348, "name": "getSessionFromUrl", "kind": 2048, "kindString": "Method", @@ -3587,7 +3658,7 @@ }, "signatures": [ { - "id": 320, + "id": 349, "name": "getSessionFromUrl", "kind": 4096, "kindString": "Call signature", @@ -3599,7 +3670,7 @@ }, "parameters": [ { - "id": 321, + "id": 350, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -3617,7 +3688,7 @@ { "type": "reflection", "declaration": { - "id": 322, + "id": 351, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -3626,7 +3697,7 @@ }, "children": [ { - "id": 323, + "id": 352, "name": "storeSession", "kind": 32, "kindString": "Variable", @@ -3640,7 +3711,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 205, + "line": 212, "character": 16 } ], @@ -3668,7 +3739,7 @@ "title": "Variables", "kind": 32, "children": [ - 323 + 352 ] } ] @@ -3684,7 +3755,7 @@ { "type": "reflection", "declaration": { - "id": 324, + "id": 353, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -3693,7 +3764,7 @@ }, "children": [ { - "id": 325, + "id": 354, "name": "data", "kind": 32, "kindString": "Variable", @@ -3703,7 +3774,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 206, + "line": 213, "character": 20 } ], @@ -3712,7 +3783,7 @@ "types": [ { "type": "reference", - "id": 27, + "id": 45, "name": "Session" }, { @@ -3723,7 +3794,7 @@ } }, { - "id": 326, + "id": 355, "name": "error", "kind": 32, "kindString": "Variable", @@ -3733,7 +3804,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 206, + "line": 213, "character": 43 } ], @@ -3757,15 +3828,15 @@ "title": "Variables", "kind": 32, "children": [ - 325, - 326 + 354, + 355 ] } ], "sources": [ { "fileName": "GoTrueClient.ts", - "line": 206, + "line": 213, "character": 14 } ] @@ -3779,13 +3850,13 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 204, + "line": 211, "character": 25 } ] }, { - "id": 331, + "id": 360, "name": "onAuthStateChange", "kind": 2048, "kindString": "Method", @@ -3794,7 +3865,7 @@ }, "signatures": [ { - "id": 332, + "id": 361, "name": "onAuthStateChange", "kind": 4096, "kindString": "Call signature", @@ -3807,7 +3878,7 @@ }, "parameters": [ { - "id": 333, + "id": 362, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -3817,7 +3888,7 @@ "type": { "type": "reflection", "declaration": { - "id": 334, + "id": 363, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -3826,7 +3897,7 @@ }, "signatures": [ { - "id": 335, + "id": 364, "name": "__call", "kind": 4096, "kindString": "Call signature", @@ -3835,7 +3906,7 @@ }, "parameters": [ { - "id": 336, + "id": 365, "name": "event", "kind": 32768, "kindString": "Parameter", @@ -3844,12 +3915,12 @@ }, "type": { "type": "reference", - "id": 73, + "id": 95, "name": "AuthChangeEvent" } }, { - "id": 337, + "id": 366, "name": "session", "kind": 32768, "kindString": "Parameter", @@ -3861,7 +3932,7 @@ "types": [ { "type": "reference", - "id": 27, + "id": 45, "name": "Session" }, { @@ -3881,7 +3952,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 266, + "line": 273, "character": 13 } ] @@ -3892,7 +3963,7 @@ "type": { "type": "reflection", "declaration": { - "id": 338, + "id": 367, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -3901,7 +3972,7 @@ }, "children": [ { - "id": 339, + "id": 368, "name": "data", "kind": 32, "kindString": "Variable", @@ -3911,7 +3982,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 267, + "line": 274, "character": 11 } ], @@ -3920,7 +3991,7 @@ "types": [ { "type": "reference", - "id": 56, + "id": 74, "name": "Subscription" }, { @@ -3931,7 +4002,7 @@ } }, { - "id": 340, + "id": 369, "name": "error", "kind": 32, "kindString": "Variable", @@ -3941,7 +4012,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 267, + "line": 274, "character": 39 } ], @@ -3965,15 +4036,15 @@ "title": "Variables", "kind": 32, "children": [ - 339, - 340 + 368, + 369 ] } ], "sources": [ { "fileName": "GoTrueClient.ts", - "line": 267, + "line": 274, "character": 4 } ] @@ -3984,13 +4055,13 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 265, + "line": 272, "character": 19 } ] }, { - "id": 306, + "id": 335, "name": "refreshSession", "kind": 2048, "kindString": "Method", @@ -3999,7 +4070,7 @@ }, "signatures": [ { - "id": 307, + "id": 336, "name": "refreshSession", "kind": 4096, "kindString": "Call signature", @@ -4015,7 +4086,7 @@ { "type": "reflection", "declaration": { - "id": 308, + "id": 337, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -4024,7 +4095,7 @@ }, "children": [ { - "id": 309, + "id": 338, "name": "data", "kind": 32, "kindString": "Variable", @@ -4034,7 +4105,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 160, + "line": 164, "character": 8 } ], @@ -4043,7 +4114,7 @@ "types": [ { "type": "reference", - "id": 27, + "id": 45, "name": "Session" }, { @@ -4054,7 +4125,7 @@ } }, { - "id": 311, + "id": 340, "name": "error", "kind": 32, "kindString": "Variable", @@ -4064,7 +4135,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 162, + "line": 166, "character": 9 } ], @@ -4083,7 +4154,7 @@ } }, { - "id": 310, + "id": 339, "name": "user", "kind": 32, "kindString": "Variable", @@ -4093,7 +4164,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 161, + "line": 165, "character": 8 } ], @@ -4102,7 +4173,7 @@ "types": [ { "type": "reference", - "id": 33, + "id": 51, "name": "User" }, { @@ -4118,16 +4189,16 @@ "title": "Variables", "kind": 32, "children": [ - 309, - 311, - 310 + 338, + 340, + 339 ] } ], "sources": [ { "fileName": "GoTrueClient.ts", - "line": 159, + "line": 163, "character": 34 } ] @@ -4141,13 +4212,13 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 159, + "line": 163, "character": 22 } ] }, { - "id": 304, + "id": 333, "name": "session", "kind": 2048, "kindString": "Method", @@ -4156,7 +4227,7 @@ }, "signatures": [ { - "id": 305, + "id": 334, "name": "session", "kind": 4096, "kindString": "Call signature", @@ -4171,7 +4242,7 @@ "types": [ { "type": "reference", - "id": 27, + "id": 45, "name": "Session" }, { @@ -4185,13 +4256,13 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 152, + "line": 156, "character": 9 } ] }, { - "id": 289, + "id": 318, "name": "signIn", "kind": 2048, "kindString": "Method", @@ -4200,7 +4271,7 @@ }, "signatures": [ { - "id": 290, + "id": 319, "name": "signIn", "kind": 4096, "kindString": "Call signature", @@ -4212,20 +4283,18 @@ }, "parameters": [ { - "id": 291, - "name": "credentials", + "id": 320, + "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, - "comment": { - "text": "The user login details." - }, + "originalName": "__0", "type": { "type": "reflection", "declaration": { - "id": 292, + "id": 321, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -4234,13 +4303,12 @@ }, "children": [ { - "id": 293, + "id": 322, "name": "email", "kind": 32, "kindString": "Variable", "flags": { - "isExported": true, - "isOptional": true + "isExported": true }, "comment": { "text": "The user's email address." @@ -4248,7 +4316,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 117, + "line": 121, "character": 9 } ], @@ -4267,13 +4335,12 @@ } }, { - "id": 294, + "id": 323, "name": "password", "kind": 32, "kindString": "Variable", "flags": { - "isExported": true, - "isOptional": true + "isExported": true }, "comment": { "text": "The user's password." @@ -4281,7 +4348,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 118, + "line": 122, "character": 12 } ], @@ -4300,13 +4367,12 @@ } }, { - "id": 295, + "id": 324, "name": "provider", "kind": 32, "kindString": "Variable", "flags": { - "isExported": true, - "isOptional": true + "isExported": true }, "comment": { "text": "One of the providers supported by GoTrue.\n" @@ -4314,14 +4380,42 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 119, + "line": 123, "character": 12 } ], "type": { - "type": "reference", - "id": 72, - "name": "Provider" + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "stringLiteral", + "value": "azure" + }, + { + "type": "stringLiteral", + "value": "bitbucket" + }, + { + "type": "stringLiteral", + "value": "facebook" + }, + { + "type": "stringLiteral", + "value": "github" + }, + { + "type": "stringLiteral", + "value": "gitlab" + }, + { + "type": "stringLiteral", + "value": "google" + } + ] } } ], @@ -4330,17 +4424,17 @@ "title": "Variables", "kind": 32, "children": [ - 293, - 294, - 295 + 322, + 323, + 324 ] } ], "sources": [ { "fileName": "GoTrueClient.ts", - "line": 116, - "character": 27 + "line": 120, + "character": 15 } ] } @@ -4353,7 +4447,7 @@ { "type": "reflection", "declaration": { - "id": 296, + "id": 325, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -4362,7 +4456,7 @@ }, "children": [ { - "id": 297, + "id": 326, "name": "data", "kind": 32, "kindString": "Variable", @@ -4372,7 +4466,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 121, + "line": 125, "character": 8 } ], @@ -4381,7 +4475,7 @@ "types": [ { "type": "reference", - "id": 27, + "id": 45, "name": "Session" }, { @@ -4392,7 +4486,7 @@ } }, { - "id": 301, + "id": 330, "name": "error", "kind": 32, "kindString": "Variable", @@ -4402,7 +4496,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 125, + "line": 129, "character": 9 } ], @@ -4421,7 +4515,7 @@ } }, { - "id": 299, + "id": 328, "name": "provider", "kind": 32, "kindString": "Variable", @@ -4432,18 +4526,18 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 123, + "line": 127, "character": 12 } ], "type": { "type": "reference", - "id": 72, + "id": 94, "name": "Provider" } }, { - "id": 300, + "id": 329, "name": "url", "kind": 32, "kindString": "Variable", @@ -4454,7 +4548,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 124, + "line": 128, "character": 7 } ], @@ -4473,7 +4567,7 @@ } }, { - "id": 298, + "id": 327, "name": "user", "kind": 32, "kindString": "Variable", @@ -4483,7 +4577,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 122, + "line": 126, "character": 8 } ], @@ -4492,7 +4586,7 @@ "types": [ { "type": "reference", - "id": 33, + "id": 51, "name": "User" }, { @@ -4508,19 +4602,19 @@ "title": "Variables", "kind": 32, "children": [ - 297, - 301, - 299, - 300, - 298 + 326, + 330, + 328, + 329, + 327 ] } ], "sources": [ { "fileName": "GoTrueClient.ts", - "line": 120, - "character": 14 + "line": 124, + "character": 31 } ] } @@ -4533,13 +4627,13 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 116, + "line": 120, "character": 14 } ] }, { - "id": 327, + "id": 356, "name": "signOut", "kind": 2048, "kindString": "Method", @@ -4548,7 +4642,7 @@ }, "signatures": [ { - "id": 328, + "id": 357, "name": "signOut", "kind": 4096, "kindString": "Call signature", @@ -4564,7 +4658,7 @@ { "type": "reflection", "declaration": { - "id": 329, + "id": 358, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -4573,7 +4667,7 @@ }, "children": [ { - "id": 330, + "id": 359, "name": "error", "kind": 32, "kindString": "Variable", @@ -4583,7 +4677,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 251, + "line": 258, "character": 34 } ], @@ -4607,14 +4701,14 @@ "title": "Variables", "kind": 32, "children": [ - 330 + 359 ] } ], "sources": [ { "fileName": "GoTrueClient.ts", - "line": 251, + "line": 258, "character": 27 } ] @@ -4628,13 +4722,13 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 251, + "line": 258, "character": 15 } ] }, { - "id": 279, + "id": 308, "name": "signUp", "kind": 2048, "kindString": "Method", @@ -4643,7 +4737,7 @@ }, "signatures": [ { - "id": 280, + "id": 309, "name": "signUp", "kind": 4096, "kindString": "Call signature", @@ -4655,20 +4749,18 @@ }, "parameters": [ { - "id": 281, - "name": "credentials", + "id": 310, + "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": { "isExported": true }, - "comment": { - "text": "The user login details." - }, + "originalName": "__0", "type": { "type": "reflection", "declaration": { - "id": 282, + "id": 311, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -4677,7 +4769,7 @@ }, "children": [ { - "id": 283, + "id": 312, "name": "email", "kind": 32, "kindString": "Variable", @@ -4690,17 +4782,26 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 89, + "line": 93, "character": 9 } ], "type": { - "type": "intrinsic", - "name": "string" + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "intrinsic", + "name": "string" + } + ] } }, { - "id": 284, + "id": 313, "name": "password", "kind": 32, "kindString": "Variable", @@ -4713,13 +4814,22 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 90, + "line": 94, "character": 12 } ], "type": { - "type": "intrinsic", - "name": "string" + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "intrinsic", + "name": "string" + } + ] } } ], @@ -4728,16 +4838,16 @@ "title": "Variables", "kind": 32, "children": [ - 283, - 284 + 312, + 313 ] } ], "sources": [ { "fileName": "GoTrueClient.ts", - "line": 88, - "character": 27 + "line": 92, + "character": 15 } ] } @@ -4750,7 +4860,7 @@ { "type": "reflection", "declaration": { - "id": 285, + "id": 314, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -4759,7 +4869,7 @@ }, "children": [ { - "id": 286, + "id": 315, "name": "data", "kind": 32, "kindString": "Variable", @@ -4769,8 +4879,8 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 91, - "character": 20 + "line": 95, + "character": 37 } ], "type": { @@ -4778,7 +4888,7 @@ "types": [ { "type": "reference", - "id": 27, + "id": 45, "name": "Session" }, { @@ -4789,7 +4899,7 @@ } }, { - "id": 288, + "id": 317, "name": "error", "kind": 32, "kindString": "Variable", @@ -4799,8 +4909,8 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 91, - "character": 62 + "line": 95, + "character": 79 } ], "type": { @@ -4818,7 +4928,7 @@ } }, { - "id": 287, + "id": 316, "name": "user", "kind": 32, "kindString": "Variable", @@ -4828,8 +4938,8 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 91, - "character": 42 + "line": 95, + "character": 59 } ], "type": { @@ -4837,7 +4947,7 @@ "types": [ { "type": "reference", - "id": 33, + "id": 51, "name": "User" }, { @@ -4853,17 +4963,17 @@ "title": "Variables", "kind": 32, "children": [ - 286, - 288, - 287 + 315, + 317, + 316 ] } ], "sources": [ { "fileName": "GoTrueClient.ts", - "line": 91, - "character": 14 + "line": 95, + "character": 31 } ] } @@ -4876,13 +4986,13 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 88, + "line": 92, "character": 14 } ] }, { - "id": 312, + "id": 341, "name": "update", "kind": 2048, "kindString": "Method", @@ -4891,7 +5001,7 @@ }, "signatures": [ { - "id": 313, + "id": 342, "name": "update", "kind": 4096, "kindString": "Call signature", @@ -4903,7 +5013,7 @@ }, "parameters": [ { - "id": 314, + "id": 343, "name": "attributes", "kind": 32768, "kindString": "Parameter", @@ -4912,7 +5022,7 @@ }, "type": { "type": "reference", - "id": 51, + "id": 69, "name": "UserAttributes" } } @@ -4923,7 +5033,7 @@ { "type": "reflection", "declaration": { - "id": 315, + "id": 344, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -4932,7 +5042,7 @@ }, "children": [ { - "id": 316, + "id": 345, "name": "data", "kind": 32, "kindString": "Variable", @@ -4942,7 +5052,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 184, + "line": 188, "character": 19 } ], @@ -4951,7 +5061,7 @@ "types": [ { "type": "reference", - "id": 33, + "id": 51, "name": "User" }, { @@ -4962,7 +5072,7 @@ } }, { - "id": 318, + "id": 347, "name": "error", "kind": 32, "kindString": "Variable", @@ -4972,7 +5082,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 184, + "line": 188, "character": 58 } ], @@ -4991,7 +5101,7 @@ } }, { - "id": 317, + "id": 346, "name": "user", "kind": 32, "kindString": "Variable", @@ -5001,7 +5111,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 184, + "line": 188, "character": 38 } ], @@ -5010,7 +5120,7 @@ "types": [ { "type": "reference", - "id": 33, + "id": 51, "name": "User" }, { @@ -5026,16 +5136,16 @@ "title": "Variables", "kind": 32, "children": [ - 316, - 318, - 317 + 345, + 347, + 346 ] } ], "sources": [ { "fileName": "GoTrueClient.ts", - "line": 184, + "line": 188, "character": 13 } ] @@ -5049,13 +5159,13 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 182, + "line": 186, "character": 14 } ] }, { - "id": 302, + "id": 331, "name": "user", "kind": 2048, "kindString": "Method", @@ -5064,7 +5174,7 @@ }, "signatures": [ { - "id": 303, + "id": 332, "name": "user", "kind": 4096, "kindString": "Call signature", @@ -5079,7 +5189,7 @@ "types": [ { "type": "reference", - "id": 33, + "id": 51, "name": "User" }, { @@ -5093,7 +5203,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 145, + "line": 149, "character": 6 } ] @@ -5104,56 +5214,56 @@ "title": "Constructors", "kind": 512, "children": [ - 265 + 294 ] }, { "title": "Properties", "kind": 1024, "children": [ - 258, - 261, - 260, - 259, - 263, - 262, - 264 + 287, + 290, + 289, + 288, + 292, + 291, + 293 ] }, { "title": "Methods", "kind": 2048, "children": [ - 377, + 406, + 370, + 382, + 415, + 398, + 404, + 402, + 395, + 348, + 360, + 335, + 333, + 318, + 356, + 308, 341, - 353, - 386, - 369, - 375, - 373, - 366, - 319, - 331, - 306, - 304, - 289, - 327, - 279, - 312, - 302 + 331 ] } ], "sources": [ { "fileName": "GoTrueClient.ts", - "line": 22, + "line": 26, "character": 33 } ] }, { - "id": 389, + "id": 418, "name": "DEFAULT_OPTIONS", "kind": 2097152, "kindString": "Object literal", @@ -5162,7 +5272,7 @@ }, "children": [ { - "id": 391, + "id": 420, "name": "autoRefreshToken", "kind": 32, "kindString": "Variable", @@ -5170,7 +5280,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 16, + "line": 20, "character": 18 } ], @@ -5181,7 +5291,7 @@ "defaultValue": "true" }, { - "id": 394, + "id": 423, "name": "detectSessionInUrl", "kind": 32, "kindString": "Variable", @@ -5189,7 +5299,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 19, + "line": 23, "character": 20 } ], @@ -5200,7 +5310,7 @@ "defaultValue": "true" }, { - "id": 395, + "id": 424, "name": "headers", "kind": 32, "kindString": "Variable", @@ -5208,14 +5318,14 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 20, + "line": 24, "character": 9 } ], "type": { "type": "reflection", "declaration": { - "id": 396, + "id": 425, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -5225,7 +5335,7 @@ "defaultValue": "DEFAULT_HEADERS" }, { - "id": 393, + "id": 422, "name": "localStorage", "kind": 32, "kindString": "Variable", @@ -5233,7 +5343,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 18, + "line": 22, "character": 14 } ], @@ -5244,7 +5354,7 @@ "defaultValue": "globalThis.localStorage" }, { - "id": 392, + "id": 421, "name": "persistSession", "kind": 32, "kindString": "Variable", @@ -5252,7 +5362,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 17, + "line": 21, "character": 16 } ], @@ -5263,7 +5373,7 @@ "defaultValue": "true" }, { - "id": 390, + "id": 419, "name": "url", "kind": 32, "kindString": "Variable", @@ -5271,7 +5381,7 @@ "sources": [ { "fileName": "GoTrueClient.ts", - "line": 15, + "line": 19, "character": 5 } ], @@ -5287,19 +5397,19 @@ "title": "Variables", "kind": 32, "children": [ - 391, - 394, - 395, - 393, - 392, - 390 + 420, + 423, + 424, + 422, + 421, + 419 ] } ], "sources": [ { "fileName": "GoTrueClient.ts", - "line": 14, + "line": 18, "character": 21 } ], @@ -5314,14 +5424,14 @@ "title": "Classes", "kind": 128, "children": [ - 257 + 286 ] }, { "title": "Object literals", "kind": 2097152, "children": [ - 389 + 418 ] } ], @@ -5334,7 +5444,7 @@ ] }, { - "id": 397, + "id": 426, "name": "\"index\"", "kind": 1, "kindString": "Module", @@ -5344,74 +5454,84 @@ "originalName": "/home/runner/work/gotrue-js/gotrue-js/src/index.ts", "children": [ { - "id": 399, + "id": 428, "name": "AuthChangeEvent", "kind": 16777216, "kindString": "Reference", "flags": { "isExported": true }, - "target": 73 + "target": 95 }, { - "id": 404, + "id": 433, "name": "CookieOptions", "kind": 16777216, "kindString": "Reference", "flags": { "isExported": true }, - "target": 66 + "target": 84 }, { - "id": 398, + "id": 427, "name": "Provider", "kind": 16777216, "kindString": "Reference", "flags": { "isExported": true }, - "target": 72 + "target": 94 }, { - "id": 400, + "id": 429, "name": "Session", "kind": 16777216, "kindString": "Reference", "flags": { "isExported": true }, - "target": 27 + "target": 45 }, { - "id": 403, + "id": 432, "name": "Subscription", "kind": 16777216, "kindString": "Reference", "flags": { "isExported": true }, - "target": 56 + "target": 74 }, { - "id": 401, + "id": 430, "name": "User", "kind": 16777216, "kindString": "Reference", "flags": { "isExported": true }, - "target": 33 + "target": 51 }, { - "id": 402, + "id": 431, "name": "UserAttributes", "kind": 16777216, "kindString": "Reference", "flags": { "isExported": true }, - "target": 51 + "target": 69 + }, + { + "id": 434, + "name": "UserCredentials", + "kind": 16777216, + "kindString": "Reference", + "flags": { + "isExported": true + }, + "target": 90 } ], "groups": [ @@ -5419,13 +5539,14 @@ "title": "References", "kind": 16777216, "children": [ - 399, - 404, - 398, - 400, - 403, - 401, - 402 + 428, + 433, + 427, + 429, + 432, + 430, + 431, + 434 ] } ], @@ -5438,7 +5559,7 @@ ] }, { - "id": 74, + "id": 96, "name": "\"lib/constants\"", "kind": 1, "kindString": "Module", @@ -5448,7 +5569,7 @@ "originalName": "/home/runner/work/gotrue-js/gotrue-js/src/lib/constants.ts", "children": [ { - "id": 76, + "id": 98, "name": "AUDIENCE", "kind": 32, "kindString": "Variable", @@ -5464,13 +5585,13 @@ } ], "type": { - "type": "intrinsic", - "name": "string" + "type": "stringLiteral", + "value": "" }, - "defaultValue": "process?.env?.AUDIENCE || ''" + "defaultValue": "\"\"" }, { - "id": 77, + "id": 99, "name": "DEFAULT_HEADERS", "kind": 32, "kindString": "Variable", @@ -5488,7 +5609,7 @@ "type": { "type": "reflection", "declaration": { - "id": 78, + "id": 100, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -5499,7 +5620,7 @@ } }, { - "id": 79, + "id": 101, "name": "EXPIRY_MARGIN", "kind": 32, "kindString": "Variable", @@ -5515,22 +5636,13 @@ } ], "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "number" - } - ] + "type": "intrinsic", + "name": "number" }, - "defaultValue": "process?.env?.EXPIRY_MARGIN || 60 * 1000" + "defaultValue": "60 * 1000" }, { - "id": 75, + "id": 97, "name": "GOTRUE_URL", "kind": 32, "kindString": "Variable", @@ -5546,13 +5658,13 @@ } ], "type": { - "type": "intrinsic", - "name": "string" + "type": "stringLiteral", + "value": "http://localhost:9999" }, - "defaultValue": "process?.env?.GOTRUE_URL || 'http://localhost:9999'" + "defaultValue": "\"http://localhost:9999\"" }, { - "id": 80, + "id": 102, "name": "STORAGE_KEY", "kind": 32, "kindString": "Variable", @@ -5568,13 +5680,13 @@ } ], "type": { - "type": "intrinsic", - "name": "string" + "type": "stringLiteral", + "value": "supabase.auth.token" }, - "defaultValue": "process?.env?.STORAGE_KEY || 'supabase.auth.token'" + "defaultValue": "\"supabase.auth.token\"" }, { - "id": 81, + "id": 103, "name": "COOKIE_OPTIONS", "kind": 2097152, "kindString": "Object literal", @@ -5584,7 +5696,7 @@ }, "children": [ { - "id": 84, + "id": 106, "name": "domain", "kind": 32, "kindString": "Variable", @@ -5605,7 +5717,7 @@ "defaultValue": "\"\"" }, { - "id": 83, + "id": 105, "name": "lifetime", "kind": 32, "kindString": "Variable", @@ -5626,7 +5738,7 @@ "defaultValue": "60 * 60 * 8" }, { - "id": 82, + "id": 104, "name": "name", "kind": 32, "kindString": "Variable", @@ -5647,7 +5759,7 @@ "defaultValue": "\"sb:token\"" }, { - "id": 85, + "id": 107, "name": "path", "kind": 32, "kindString": "Variable", @@ -5668,7 +5780,7 @@ "defaultValue": "\"/\"" }, { - "id": 86, + "id": 108, "name": "sameSite", "kind": 32, "kindString": "Variable", @@ -5694,11 +5806,11 @@ "title": "Variables", "kind": 32, "children": [ - 84, - 83, - 82, - 85, - 86 + 106, + 105, + 104, + 107, + 108 ] } ], @@ -5720,18 +5832,18 @@ "title": "Variables", "kind": 32, "children": [ - 76, - 77, - 79, - 75, - 80 + 98, + 99, + 101, + 97, + 102 ] }, { "title": "Object literals", "kind": 2097152, "children": [ - 81 + 103 ] } ], @@ -5744,7 +5856,7 @@ ] }, { - "id": 87, + "id": 109, "name": "\"lib/cookies\"", "kind": 1, "kindString": "Module", @@ -5754,7 +5866,7 @@ "originalName": "/home/runner/work/gotrue-js/gotrue-js/src/lib/cookies.ts", "children": [ { - "id": 88, + "id": 110, "name": "Cookie", "kind": 4194304, "kindString": "Type alias", @@ -5769,14 +5881,14 @@ "type": { "type": "reflection", "declaration": { - "id": 89, + "id": 111, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 93, + "id": 115, "name": "domain", "kind": 32, "kindString": "Variable", @@ -5805,7 +5917,7 @@ } }, { - "id": 92, + "id": 114, "name": "maxAge", "kind": 32, "kindString": "Variable", @@ -5823,7 +5935,7 @@ } }, { - "id": 90, + "id": 112, "name": "name", "kind": 32, "kindString": "Variable", @@ -5841,7 +5953,7 @@ } }, { - "id": 94, + "id": 116, "name": "path", "kind": 32, "kindString": "Variable", @@ -5870,7 +5982,7 @@ } }, { - "id": 95, + "id": 117, "name": "sameSite", "kind": 32, "kindString": "Variable", @@ -5899,7 +6011,7 @@ } }, { - "id": 91, + "id": 113, "name": "value", "kind": 32, "kindString": "Variable", @@ -5922,12 +6034,12 @@ "title": "Variables", "kind": 32, "children": [ - 93, - 92, - 90, - 94, - 95, - 91 + 115, + 114, + 112, + 116, + 117, + 113 ] } ], @@ -5942,7 +6054,7 @@ } }, { - "id": 126, + "id": 148, "name": "deleteCookie", "kind": 64, "kindString": "Function", @@ -5951,7 +6063,7 @@ }, "signatures": [ { - "id": 127, + "id": 149, "name": "deleteCookie", "kind": 4096, "kindString": "Call signature", @@ -5960,7 +6072,7 @@ }, "parameters": [ { - "id": 128, + "id": 150, "name": "req", "kind": 32768, "kindString": "Parameter", @@ -5973,7 +6085,7 @@ } }, { - "id": 129, + "id": 151, "name": "res", "kind": 32768, "kindString": "Parameter", @@ -5986,7 +6098,7 @@ } }, { - "id": 130, + "id": 152, "name": "name", "kind": 32768, "kindString": "Parameter", @@ -6014,14 +6126,14 @@ ] }, { - "id": 109, + "id": 131, "name": "isSecureEnvironment", "kind": 64, "kindString": "Function", "flags": {}, "signatures": [ { - "id": 110, + "id": 132, "name": "isSecureEnvironment", "kind": 4096, "kindString": "Call signature", @@ -6031,7 +6143,7 @@ }, "parameters": [ { - "id": 111, + "id": 133, "name": "req", "kind": 32768, "kindString": "Parameter", @@ -6057,14 +6169,14 @@ ] }, { - "id": 96, + "id": 118, "name": "serialize", "kind": 64, "kindString": "Function", "flags": {}, "signatures": [ { - "id": 97, + "id": 119, "name": "serialize", "kind": 4096, "kindString": "Call signature", @@ -6074,7 +6186,7 @@ }, "parameters": [ { - "id": 98, + "id": 120, "name": "name", "kind": 32768, "kindString": "Parameter", @@ -6085,7 +6197,7 @@ } }, { - "id": 99, + "id": 121, "name": "val", "kind": 32768, "kindString": "Parameter", @@ -6096,7 +6208,7 @@ } }, { - "id": 100, + "id": 122, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -6104,14 +6216,14 @@ "type": { "type": "reflection", "declaration": { - "id": 101, + "id": 123, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 103, + "id": 125, "name": "domain", "kind": 32, "kindString": "Variable", @@ -6129,7 +6241,7 @@ } }, { - "id": 105, + "id": 127, "name": "expires", "kind": 32, "kindString": "Variable", @@ -6147,7 +6259,7 @@ } }, { - "id": 106, + "id": 128, "name": "httpOnly", "kind": 32, "kindString": "Variable", @@ -6165,7 +6277,7 @@ } }, { - "id": 102, + "id": 124, "name": "maxAge", "kind": 32, "kindString": "Variable", @@ -6183,7 +6295,7 @@ } }, { - "id": 104, + "id": 126, "name": "path", "kind": 32, "kindString": "Variable", @@ -6201,7 +6313,7 @@ } }, { - "id": 108, + "id": 130, "name": "sameSite", "kind": 32, "kindString": "Variable", @@ -6219,7 +6331,7 @@ } }, { - "id": 107, + "id": 129, "name": "secure", "kind": 32, "kindString": "Variable", @@ -6242,13 +6354,13 @@ "title": "Variables", "kind": 32, "children": [ - 103, - 105, - 106, - 102, - 104, - 108, - 107 + 125, + 127, + 128, + 124, + 126, + 130, + 129 ] } ], @@ -6278,14 +6390,14 @@ ] }, { - "id": 112, + "id": 134, "name": "serializeCookie", "kind": 64, "kindString": "Function", "flags": {}, "signatures": [ { - "id": 113, + "id": 135, "name": "serializeCookie", "kind": 4096, "kindString": "Call signature", @@ -6295,19 +6407,19 @@ }, "parameters": [ { - "id": 114, + "id": 136, "name": "cookie", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 88, + "id": 110, "name": "Cookie" } }, { - "id": 115, + "id": 137, "name": "secure", "kind": 32768, "kindString": "Parameter", @@ -6333,7 +6445,7 @@ ] }, { - "id": 121, + "id": 143, "name": "setCookie", "kind": 64, "kindString": "Function", @@ -6342,7 +6454,7 @@ }, "signatures": [ { - "id": 122, + "id": 144, "name": "setCookie", "kind": 4096, "kindString": "Call signature", @@ -6354,7 +6466,7 @@ }, "parameters": [ { - "id": 123, + "id": 145, "name": "req", "kind": 32768, "kindString": "Parameter", @@ -6367,7 +6479,7 @@ } }, { - "id": 124, + "id": 146, "name": "res", "kind": 32768, "kindString": "Parameter", @@ -6380,7 +6492,7 @@ } }, { - "id": 125, + "id": 147, "name": "cookie", "kind": 32768, "kindString": "Parameter", @@ -6389,7 +6501,7 @@ }, "type": { "type": "reference", - "id": 88, + "id": 110, "name": "Cookie" } } @@ -6409,7 +6521,7 @@ ] }, { - "id": 116, + "id": 138, "name": "setCookies", "kind": 64, "kindString": "Function", @@ -6418,7 +6530,7 @@ }, "signatures": [ { - "id": 117, + "id": 139, "name": "setCookies", "kind": 4096, "kindString": "Call signature", @@ -6430,7 +6542,7 @@ }, "parameters": [ { - "id": 118, + "id": 140, "name": "req", "kind": 32768, "kindString": "Parameter", @@ -6443,7 +6555,7 @@ } }, { - "id": 119, + "id": 141, "name": "res", "kind": 32768, "kindString": "Parameter", @@ -6456,7 +6568,7 @@ } }, { - "id": 120, + "id": 142, "name": "cookies", "kind": 32768, "kindString": "Parameter", @@ -6468,7 +6580,7 @@ "typeArguments": [ { "type": "reference", - "id": 88, + "id": 110, "name": "Cookie" } ], @@ -6496,19 +6608,19 @@ "title": "Type aliases", "kind": 4194304, "children": [ - 88 + 110 ] }, { "title": "Functions", "kind": 64, "children": [ - 126, - 109, - 96, - 112, - 121, - 116 + 148, + 131, + 118, + 134, + 143, + 138 ] } ], @@ -6661,75 +6773,41 @@ ] }, { - "id": 12, - "name": "get", - "kind": 64, - "kindString": "Function", + "id": 8, + "name": "RequestMethodType", + "kind": 4194304, + "kindString": "Type alias", "flags": { "isExported": true }, - "signatures": [ - { - "id": 13, - "name": "get", - "kind": 4096, - "kindString": "Call signature", - "flags": { - "isExported": true - }, - "parameters": [ - { - "id": 14, - "name": "url", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isExported": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 15, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isExported": true, - "isOptional": true - }, - "type": { - "type": "reference", - "id": 2, - "name": "FetchOptions" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "Promise" - } - } - ], "sources": [ { "fileName": "lib/fetch.ts", - "line": 22, - "character": 25 + "line": 10, + "character": 29 } - ] + ], + "type": { + "type": "union", + "types": [ + { + "type": "stringLiteral", + "value": "GET" + }, + { + "type": "stringLiteral", + "value": "POST" + }, + { + "type": "stringLiteral", + "value": "PUT" + } + ] + } }, { - "id": 8, - "name": "handleError", + "id": 9, + "name": "_getErrorMessage", "kind": 64, "kindString": "Function", "flags": { @@ -6737,26 +6815,15 @@ }, "signatures": [ { - "id": 9, - "name": "handleError", + "id": 10, + "name": "_getErrorMessage", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ - { - "id": 10, - "name": "error", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - }, { "id": 11, - "name": "reject", + "name": "msg", "kind": 32768, "kindString": "Parameter", "flags": {}, @@ -6768,69 +6835,52 @@ ], "type": { "type": "intrinsic", - "name": "any" + "name": "string" } } ], "sources": [ { "fileName": "lib/fetch.ts", - "line": 10, - "character": 17 + "line": 12, + "character": 22 } ] }, { "id": 16, - "name": "post", + "name": "_getRequestParams", "kind": 64, "kindString": "Function", "flags": { - "isExported": true + "isConst": true }, "signatures": [ { "id": 17, - "name": "post", + "name": "_getRequestParams", "kind": 4096, "kindString": "Call signature", - "flags": { - "isExported": true - }, + "flags": {}, "parameters": [ { "id": 18, - "name": "url", + "name": "method", "kind": 32768, "kindString": "Parameter", - "flags": { - "isExported": true - }, + "flags": {}, "type": { - "type": "intrinsic", - "name": "string" + "type": "reference", + "id": 8, + "name": "RequestMethodType" } }, { "id": 19, - "name": "body", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isExported": true - }, - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 20, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { - "isExported": true, "isOptional": true }, "type": { @@ -6838,6 +6888,148 @@ "id": 2, "name": "FetchOptions" } + }, + { + "id": 20, + "name": "body", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "intrinsic", + "name": "object" + } + ] + } + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 21, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "indexSignature": [ + { + "id": 22, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 23, + "name": "k", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ] + } + } + } + ], + "sources": [ + { + "fileName": "lib/fetch.ts", + "line": 24, + "character": 23 + } + ] + }, + { + "id": 24, + "name": "_handleRequest", + "kind": 64, + "kindString": "Function", + "flags": {}, + "signatures": [ + { + "id": 25, + "name": "_handleRequest", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 26, + "name": "method", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 8, + "name": "RequestMethodType" + } + }, + { + "id": 27, + "name": "url", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 28, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "id": 2, + "name": "FetchOptions" + } + }, + { + "id": 29, + "name": "body", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "intrinsic", + "name": "object" + } + ] + } } ], "type": { @@ -6856,13 +7048,13 @@ { "fileName": "lib/fetch.ts", "line": 37, - "character": 26 + "character": 29 } ] }, { - "id": 21, - "name": "put", + "id": 30, + "name": "get", "kind": 64, "kindString": "Function", "flags": { @@ -6870,8 +7062,8 @@ }, "signatures": [ { - "id": 22, - "name": "put", + "id": 31, + "name": "get", "kind": 4096, "kindString": "Call signature", "flags": { @@ -6879,7 +7071,7 @@ }, "parameters": [ { - "id": 23, + "id": 32, "name": "url", "kind": 32768, "kindString": "Parameter", @@ -6892,20 +7084,7 @@ } }, { - "id": 24, - "name": "body", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isExported": true - }, - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 25, + "id": 33, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -6935,7 +7114,220 @@ "sources": [ { "fileName": "lib/fetch.ts", - "line": 53, + "line": 55, + "character": 25 + } + ] + }, + { + "id": 12, + "name": "handleError", + "kind": 64, + "kindString": "Function", + "flags": { + "isConst": true + }, + "signatures": [ + { + "id": 13, + "name": "handleError", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 14, + "name": "error", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 15, + "name": "reject", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "sources": [ + { + "fileName": "lib/fetch.ts", + "line": 15, + "character": 17 + } + ] + }, + { + "id": 34, + "name": "post", + "kind": 64, + "kindString": "Function", + "flags": { + "isExported": true + }, + "signatures": [ + { + "id": 35, + "name": "post", + "kind": 4096, + "kindString": "Call signature", + "flags": { + "isExported": true + }, + "parameters": [ + { + "id": 36, + "name": "url", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 37, + "name": "body", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "type": { + "type": "intrinsic", + "name": "object" + } + }, + { + "id": 38, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true, + "isOptional": true + }, + "type": { + "type": "reference", + "id": 2, + "name": "FetchOptions" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "any" + } + ], + "name": "Promise" + } + } + ], + "sources": [ + { + "fileName": "lib/fetch.ts", + "line": 59, + "character": 26 + } + ] + }, + { + "id": 39, + "name": "put", + "kind": 64, + "kindString": "Function", + "flags": { + "isExported": true + }, + "signatures": [ + { + "id": 40, + "name": "put", + "kind": 4096, + "kindString": "Call signature", + "flags": { + "isExported": true + }, + "parameters": [ + { + "id": 41, + "name": "url", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 42, + "name": "body", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "type": { + "type": "intrinsic", + "name": "object" + } + }, + { + "id": 43, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true, + "isOptional": true + }, + "type": { + "type": "reference", + "id": 2, + "name": "FetchOptions" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "any" + } + ], + "name": "Promise" + } + } + ], + "sources": [ + { + "fileName": "lib/fetch.ts", + "line": 63, "character": 25 } ] @@ -6949,14 +7341,24 @@ 2 ] }, + { + "title": "Type aliases", + "kind": 4194304, + "children": [ + 8 + ] + }, { "title": "Functions", "kind": 64, "children": [ - 12, - 8, + 9, 16, - 21 + 24, + 30, + 12, + 34, + 39 ] } ], @@ -6969,7 +7371,7 @@ ] }, { - "id": 224, + "id": 250, "name": "\"lib/helpers\"", "kind": 1, "kindString": "Module", @@ -6979,7 +7381,7 @@ "originalName": "/home/runner/work/gotrue-js/gotrue-js/src/lib/helpers.ts", "children": [ { - "id": 225, + "id": 251, "name": "LocalStorage", "kind": 128, "kindString": "Class", @@ -6988,7 +7390,7 @@ }, "indexSignature": [ { - "id": 227, + "id": 253, "name": "__index", "kind": 8192, "kindString": "Index signature", @@ -6997,7 +7399,7 @@ }, "parameters": [ { - "id": 228, + "id": 254, "name": "name", "kind": 32768, "kindString": "Parameter", @@ -7018,7 +7420,7 @@ ], "children": [ { - "id": 230, + "id": 256, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -7027,7 +7429,7 @@ }, "signatures": [ { - "id": 231, + "id": 257, "name": "new LocalStorage", "kind": 16384, "kindString": "Constructor signature", @@ -7036,7 +7438,7 @@ }, "parameters": [ { - "id": 232, + "id": 258, "name": "localStorage", "kind": 32768, "kindString": "Parameter", @@ -7051,7 +7453,7 @@ ], "type": { "type": "reference", - "id": 225, + "id": 251, "name": "LocalStorage" } } @@ -7065,7 +7467,7 @@ ] }, { - "id": 229, + "id": 255, "name": "length", "kind": 1024, "kindString": "Property", @@ -7085,7 +7487,7 @@ } }, { - "id": 226, + "id": 252, "name": "localStorage", "kind": 1024, "kindString": "Property", @@ -7105,7 +7507,7 @@ } }, { - "id": 233, + "id": 259, "name": "clear", "kind": 2048, "kindString": "Method", @@ -7114,7 +7516,7 @@ }, "signatures": [ { - "id": 234, + "id": 260, "name": "clear", "kind": 4096, "kindString": "Call signature", @@ -7136,7 +7538,7 @@ ] }, { - "id": 242, + "id": 268, "name": "getItem", "kind": 2048, "kindString": "Method", @@ -7145,7 +7547,7 @@ }, "signatures": [ { - "id": 243, + "id": 269, "name": "getItem", "kind": 4096, "kindString": "Call signature", @@ -7154,7 +7556,7 @@ }, "parameters": [ { - "id": 244, + "id": 270, "name": "key", "kind": 32768, "kindString": "Parameter", @@ -7191,7 +7593,7 @@ ] }, { - "id": 235, + "id": 261, "name": "key", "kind": 2048, "kindString": "Method", @@ -7200,7 +7602,7 @@ }, "signatures": [ { - "id": 236, + "id": 262, "name": "key", "kind": 4096, "kindString": "Call signature", @@ -7209,7 +7611,7 @@ }, "parameters": [ { - "id": 237, + "id": 263, "name": "index", "kind": 32768, "kindString": "Parameter", @@ -7246,7 +7648,7 @@ ] }, { - "id": 245, + "id": 271, "name": "removeItem", "kind": 2048, "kindString": "Method", @@ -7255,7 +7657,7 @@ }, "signatures": [ { - "id": 246, + "id": 272, "name": "removeItem", "kind": 4096, "kindString": "Call signature", @@ -7264,7 +7666,7 @@ }, "parameters": [ { - "id": 247, + "id": 273, "name": "key", "kind": 32768, "kindString": "Parameter", @@ -7292,7 +7694,7 @@ ] }, { - "id": 238, + "id": 264, "name": "setItem", "kind": 2048, "kindString": "Method", @@ -7301,7 +7703,7 @@ }, "signatures": [ { - "id": 239, + "id": 265, "name": "setItem", "kind": 4096, "kindString": "Call signature", @@ -7310,7 +7712,7 @@ }, "parameters": [ { - "id": 240, + "id": 266, "name": "key", "kind": 32768, "kindString": "Parameter", @@ -7323,7 +7725,7 @@ } }, { - "id": 241, + "id": 267, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -7356,26 +7758,26 @@ "title": "Constructors", "kind": 512, "children": [ - 230 + 256 ] }, { "title": "Properties", "kind": 1024, "children": [ - 229, - 226 + 255, + 252 ] }, { "title": "Methods", "kind": 2048, "children": [ - 233, - 242, - 235, - 245, - 238 + 259, + 268, + 261, + 271, + 264 ] } ], @@ -7394,7 +7796,7 @@ ] }, { - "id": 252, + "id": 278, "name": "getParameterByName", "kind": 64, "kindString": "Function", @@ -7403,7 +7805,7 @@ }, "signatures": [ { - "id": 253, + "id": 279, "name": "getParameterByName", "kind": 4096, "kindString": "Call signature", @@ -7412,7 +7814,7 @@ }, "parameters": [ { - "id": 254, + "id": 280, "name": "name", "kind": 32768, "kindString": "Parameter", @@ -7425,7 +7827,7 @@ } }, { - "id": 255, + "id": 281, "name": "url", "kind": 32768, "kindString": "Parameter", @@ -7472,7 +7874,7 @@ ] }, { - "id": 250, + "id": 276, "name": "isBrowser", "kind": 64, "kindString": "Function", @@ -7482,7 +7884,7 @@ }, "signatures": [ { - "id": 251, + "id": 277, "name": "isBrowser", "kind": 4096, "kindString": "Call signature", @@ -7504,7 +7906,7 @@ ] }, { - "id": 248, + "id": 274, "name": "uuid", "kind": 64, "kindString": "Function", @@ -7513,7 +7915,7 @@ }, "signatures": [ { - "id": 249, + "id": 275, "name": "uuid", "kind": 4096, "kindString": "Call signature", @@ -7540,16 +7942,16 @@ "title": "Classes", "kind": 128, "children": [ - 225 + 251 ] }, { "title": "Functions", "kind": 64, "children": [ - 252, - 250, - 248 + 278, + 276, + 274 ] } ], @@ -7562,7 +7964,69 @@ ] }, { - "id": 26, + "id": 282, + "name": "\"lib/polyfills\"", + "kind": 1, + "kindString": "Module", + "flags": { + "isExported": true + }, + "originalName": "/home/runner/work/gotrue-js/gotrue-js/src/lib/polyfills.ts", + "children": [ + { + "id": 283, + "name": "polyfillGlobalThis", + "kind": 64, + "kindString": "Function", + "flags": { + "isExported": true + }, + "signatures": [ + { + "id": 284, + "name": "polyfillGlobalThis", + "kind": 4096, + "kindString": "Call signature", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "https://mathiasbynens.be/notes/globalthis" + }, + "type": { + "type": "intrinsic", + "name": "void" + } + } + ], + "sources": [ + { + "fileName": "lib/polyfills.ts", + "line": 6, + "character": 34 + } + ] + } + ], + "groups": [ + { + "title": "Functions", + "kind": 64, + "children": [ + 283 + ] + } + ], + "sources": [ + { + "fileName": "lib/polyfills.ts", + "line": 1, + "character": 0 + } + ] + }, + { + "id": 44, "name": "\"lib/types\"", "kind": 1, "kindString": "Module", @@ -7572,7 +8036,7 @@ "originalName": "/home/runner/work/gotrue-js/gotrue-js/src/lib/types.ts", "children": [ { - "id": 66, + "id": 84, "name": "CookieOptions", "kind": 256, "kindString": "Interface", @@ -7581,7 +8045,7 @@ }, "children": [ { - "id": 69, + "id": 87, "name": "domain", "kind": 1024, "kindString": "Property", @@ -7611,7 +8075,7 @@ } }, { - "id": 68, + "id": 86, "name": "lifetime", "kind": 1024, "kindString": "Property", @@ -7641,7 +8105,7 @@ } }, { - "id": 67, + "id": 85, "name": "name", "kind": 1024, "kindString": "Property", @@ -7671,7 +8135,7 @@ } }, { - "id": 70, + "id": 88, "name": "path", "kind": 1024, "kindString": "Property", @@ -7701,7 +8165,7 @@ } }, { - "id": 71, + "id": 89, "name": "sameSite", "kind": 1024, "kindString": "Property", @@ -7736,11 +8200,11 @@ "title": "Properties", "kind": 1024, "children": [ - 69, - 68, - 67, - 70, - 71 + 87, + 86, + 85, + 88, + 89 ] } ], @@ -7753,7 +8217,7 @@ ] }, { - "id": 27, + "id": 45, "name": "Session", "kind": 256, "kindString": "Interface", @@ -7762,7 +8226,7 @@ }, "children": [ { - "id": 28, + "id": 46, "name": "access_token", "kind": 1024, "kindString": "Property", @@ -7782,7 +8246,7 @@ } }, { - "id": 29, + "id": 47, "name": "expires_in", "kind": 1024, "kindString": "Property", @@ -7802,7 +8266,7 @@ } }, { - "id": 30, + "id": 48, "name": "refresh_token", "kind": 1024, "kindString": "Property", @@ -7822,7 +8286,7 @@ } }, { - "id": 31, + "id": 49, "name": "token_type", "kind": 1024, "kindString": "Property", @@ -7842,7 +8306,7 @@ } }, { - "id": 32, + "id": 50, "name": "user", "kind": 1024, "kindString": "Property", @@ -7858,7 +8322,7 @@ ], "type": { "type": "reference", - "id": 33, + "id": 51, "name": "User" } } @@ -7868,11 +8332,11 @@ "title": "Properties", "kind": 1024, "children": [ - 28, - 29, - 30, - 31, - 32 + 46, + 47, + 48, + 49, + 50 ] } ], @@ -7885,7 +8349,7 @@ ] }, { - "id": 56, + "id": 74, "name": "Subscription", "kind": 256, "kindString": "Interface", @@ -7894,7 +8358,7 @@ }, "children": [ { - "id": 58, + "id": 76, "name": "callback", "kind": 1024, "kindString": "Property", @@ -7914,7 +8378,7 @@ "type": { "type": "reflection", "declaration": { - "id": 59, + "id": 77, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -7923,7 +8387,7 @@ }, "signatures": [ { - "id": 60, + "id": 78, "name": "__call", "kind": 4096, "kindString": "Call signature", @@ -7932,7 +8396,7 @@ }, "parameters": [ { - "id": 61, + "id": 79, "name": "event", "kind": 32768, "kindString": "Parameter", @@ -7941,12 +8405,12 @@ }, "type": { "type": "reference", - "id": 73, + "id": 95, "name": "AuthChangeEvent" } }, { - "id": 62, + "id": 80, "name": "session", "kind": 32768, "kindString": "Parameter", @@ -7958,7 +8422,7 @@ "types": [ { "type": "reference", - "id": 27, + "id": 45, "name": "Session" }, { @@ -7986,7 +8450,7 @@ } }, { - "id": 57, + "id": 75, "name": "id", "kind": 1024, "kindString": "Property", @@ -8009,7 +8473,7 @@ } }, { - "id": 63, + "id": 81, "name": "unsubscribe", "kind": 1024, "kindString": "Property", @@ -8029,7 +8493,7 @@ "type": { "type": "reflection", "declaration": { - "id": 64, + "id": 82, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -8038,7 +8502,7 @@ }, "signatures": [ { - "id": 65, + "id": 83, "name": "__call", "kind": 4096, "kindString": "Call signature", @@ -8067,9 +8531,9 @@ "title": "Properties", "kind": 1024, "children": [ - 58, - 57, - 63 + 76, + 75, + 81 ] } ], @@ -8082,7 +8546,7 @@ ] }, { - "id": 33, + "id": 51, "name": "User", "kind": 256, "kindString": "Interface", @@ -8091,7 +8555,7 @@ }, "children": [ { - "id": 35, + "id": 53, "name": "app_metadata", "kind": 1024, "kindString": "Property", @@ -8108,7 +8572,7 @@ "type": { "type": "reflection", "declaration": { - "id": 36, + "id": 54, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -8117,7 +8581,7 @@ }, "indexSignature": [ { - "id": 38, + "id": 56, "name": "__index", "kind": 8192, "kindString": "Index signature", @@ -8126,7 +8590,7 @@ }, "parameters": [ { - "id": 39, + "id": 57, "name": "key", "kind": 32768, "kindString": "Parameter", @@ -8147,7 +8611,7 @@ ], "children": [ { - "id": 37, + "id": 55, "name": "provider", "kind": 32, "kindString": "Variable", @@ -8182,7 +8646,7 @@ "title": "Variables", "kind": 32, "children": [ - 37 + 55 ] } ], @@ -8197,7 +8661,7 @@ } }, { - "id": 44, + "id": 62, "name": "aud", "kind": 1024, "kindString": "Property", @@ -8217,7 +8681,7 @@ } }, { - "id": 47, + "id": 65, "name": "confirmed_at", "kind": 1024, "kindString": "Property", @@ -8247,7 +8711,7 @@ } }, { - "id": 46, + "id": 64, "name": "created_at", "kind": 1024, "kindString": "Property", @@ -8267,7 +8731,7 @@ } }, { - "id": 45, + "id": 63, "name": "email", "kind": 1024, "kindString": "Property", @@ -8297,7 +8761,7 @@ } }, { - "id": 34, + "id": 52, "name": "id", "kind": 1024, "kindString": "Property", @@ -8317,7 +8781,7 @@ } }, { - "id": 48, + "id": 66, "name": "last_sign_in_at", "kind": 1024, "kindString": "Property", @@ -8347,7 +8811,7 @@ } }, { - "id": 49, + "id": 67, "name": "role", "kind": 1024, "kindString": "Property", @@ -8377,7 +8841,7 @@ } }, { - "id": 50, + "id": 68, "name": "updated_at", "kind": 1024, "kindString": "Property", @@ -8407,7 +8871,7 @@ } }, { - "id": 40, + "id": 58, "name": "user_metadata", "kind": 1024, "kindString": "Property", @@ -8424,7 +8888,7 @@ "type": { "type": "reflection", "declaration": { - "id": 41, + "id": 59, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -8433,7 +8897,7 @@ }, "indexSignature": [ { - "id": 42, + "id": 60, "name": "__index", "kind": 8192, "kindString": "Index signature", @@ -8442,7 +8906,7 @@ }, "parameters": [ { - "id": 43, + "id": 61, "name": "key", "kind": 32768, "kindString": "Parameter", @@ -8477,16 +8941,16 @@ "title": "Properties", "kind": 1024, "children": [ - 35, - 44, - 47, - 46, - 45, - 34, - 48, - 49, - 50, - 40 + 53, + 62, + 65, + 64, + 63, + 52, + 66, + 67, + 68, + 58 ] } ], @@ -8499,7 +8963,7 @@ ] }, { - "id": 51, + "id": 69, "name": "UserAttributes", "kind": 256, "kindString": "Interface", @@ -8508,7 +8972,7 @@ }, "children": [ { - "id": 55, + "id": 73, "name": "data", "kind": 1024, "kindString": "Property", @@ -8541,7 +9005,7 @@ } }, { - "id": 52, + "id": 70, "name": "email", "kind": 1024, "kindString": "Property", @@ -8574,7 +9038,7 @@ } }, { - "id": 54, + "id": 72, "name": "email_change_token", "kind": 1024, "kindString": "Property", @@ -8607,7 +9071,7 @@ } }, { - "id": 53, + "id": 71, "name": "password", "kind": 1024, "kindString": "Property", @@ -8645,10 +9109,10 @@ "title": "Properties", "kind": 1024, "children": [ - 55, - 52, - 54, - 53 + 73, + 70, + 72, + 71 ] } ], @@ -8661,7 +9125,118 @@ ] }, { - "id": 73, + "id": 90, + "name": "UserCredentials", + "kind": 256, + "kindString": "Interface", + "flags": { + "isExported": true + }, + "children": [ + { + "id": 91, + "name": "email", + "kind": 1024, + "kindString": "Property", + "flags": { + "isExported": true, + "isOptional": true + }, + "sources": [ + { + "fileName": "lib/types.ts", + "line": 78, + "character": 7 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + }, + { + "id": 92, + "name": "password", + "kind": 1024, + "kindString": "Property", + "flags": { + "isExported": true, + "isOptional": true + }, + "sources": [ + { + "fileName": "lib/types.ts", + "line": 79, + "character": 10 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + }, + { + "id": 93, + "name": "provider", + "kind": 1024, + "kindString": "Property", + "flags": { + "isExported": true, + "isOptional": true + }, + "sources": [ + { + "fileName": "lib/types.ts", + "line": 81, + "character": 10 + } + ], + "type": { + "type": "reference", + "id": 94, + "name": "Provider" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 91, + 92, + 93 + ] + } + ], + "sources": [ + { + "fileName": "lib/types.ts", + "line": 77, + "character": 32 + } + ] + }, + { + "id": 95, "name": "AuthChangeEvent", "kind": 4194304, "kindString": "Type alias", @@ -8698,7 +9273,7 @@ } }, { - "id": 72, + "id": 94, "name": "Provider", "kind": 4194304, "kindString": "Type alias", @@ -8715,10 +9290,18 @@ "type": { "type": "union", "types": [ + { + "type": "stringLiteral", + "value": "azure" + }, { "type": "stringLiteral", "value": "bitbucket" }, + { + "type": "stringLiteral", + "value": "facebook" + }, { "type": "stringLiteral", "value": "github" @@ -8740,19 +9323,20 @@ "title": "Interfaces", "kind": 256, "children": [ - 66, - 27, - 56, - 33, - 51 + 84, + 45, + 74, + 51, + 69, + 90 ] }, { "title": "Type aliases", "kind": 4194304, "children": [ - 73, - 72 + 95, + 94 ] } ], @@ -8770,14 +9354,15 @@ "title": "Modules", "kind": 1, "children": [ - 131, - 256, - 397, - 74, - 87, + 153, + 285, + 426, + 96, + 109, 1, - 224, - 26 + 250, + 282, + 44 ] } ] diff --git a/web/spec/postgrest.json b/web/spec/postgrest.json index 36b205719a1..df1acf05279 100644 --- a/web/spec/postgrest.json +++ b/web/spec/postgrest.json @@ -5925,7 +5925,7 @@ "sources": [ { "fileName": "lib/PostgrestQueryBuilder.ts", - "line": 106, + "line": 107, "character": 11 } ], @@ -5966,7 +5966,7 @@ "sources": [ { "fileName": "lib/PostgrestQueryBuilder.ts", - "line": 105, + "line": 106, "character": 15 } ], @@ -5999,7 +5999,7 @@ "sources": [ { "fileName": "lib/PostgrestQueryBuilder.ts", - "line": 103, + "line": 104, "character": 23 } ] @@ -6024,7 +6024,7 @@ "sources": [ { "fileName": "lib/PostgrestQueryBuilder.ts", - "line": 102, + "line": 103, "character": 8 } ]